Protocol-A.texi 276 KB
Newer Older
David Byers's avatar
David Byers committed
1
\input texinfo                         @c -*-texinfo-*-
David Byers's avatar
David Byers committed
2 3 4
@c
@c FIXME: Explain how the garb works with nice and keep-commented
@c
David Byers's avatar
Server:  
David Byers committed
5
@c $Id: Protocol-A.texi,v 1.82 1999/07/02 00:12:55 byers Exp $
David Byers's avatar
David Byers committed
6 7 8 9 10 11 12
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
@c %**end of header
@iftex
@parindent 0pt
13
@font@tensltt=cmsltt10
14 15 16 17 18
@begin tex
\global\def\rett#1{{\let\t\sltt\tt #1}}
\global\def\sltt#1{{\fam\ttfam\tensltt\let\t\rett #1}}
\global\let\t\sltt
@end tex
David Byers's avatar
David Byers committed
19 20 21
@end iftex

@ifinfo
22 23
This is specification 10.0 of LysKOM Protocol A.  It specifies version
10 of the protocol.
David Byers's avatar
David Byers committed
24

David Byers's avatar
David Byers committed
25
Copyright @copyright{} 1995-1999 Lysator ACS.
David Byers's avatar
David Byers committed
26 27 28 29 30 31

Permission is granted to make and distribute verbatim copies of this
specification provided the copyright notice and this permission notice
are preserved on all copies.
@end ifinfo

32 33 34 35 36
@dircategory LysKOM
@direntry
* Protocol A: (protocol-a).             The LysKOM Protocol A specification.
@end direntry

David Byers's avatar
David Byers committed
37 38 39 40
@titlepage
@sp 10
@title{LysKOM Protocol A}
@sp 2
41
@subtitle{Protocol version 10}
David Byers's avatar
David Byers committed
42 43 44 45 46
@sp 2
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
David Byers's avatar
David Byers committed
47
Copyright @copyright{} 1995-1999 Lysator ACS
David Byers's avatar
David Byers committed
48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63

Permission is granted to make and distribute verbatim copies of this document
provided the copyright notice and this permission notice are preserved on all
copies.

Modified versions of this document may be redistributed with the added
condition that all modifications not cleared with the LysKOM development group
are clearly marked and that the entire modified work be redistributed under the
same conditions as the original.

Permission is granted to copy and distribute translations of this manual into
another language under the same conditions as for modified versions.

@end titlepage

@ifinfo
64
@node Top
65
@top LysKOM Protocol A
66 67

This document specifies version 10 of LysKOM Protocol A.
68
This is revision 10.0 of the specification.
David Byers's avatar
David Byers committed
69 70

@menu
71 72 73 74 75 76 77 78 79 80 81 82
* Overview::                    
* Introduction::                
* Data Types::                  
* Protocol Requests::           
* Asynchronous Messages::       
* Error Codes::                 
* LysKOM Content Types::        
* The User Area::               
* Writing Clients::             
* Importing and Exporting E-Mail::  
* Type Index::                  
* Request Index::               
David Byers's avatar
David Byers committed
83 84 85
@end menu
@end ifinfo

86
@node Overview
David Byers's avatar
David Byers committed
87 88 89
@chapter Overview

LysKOM is a conferencing system@footnote{Or in modern terms, enabling
90 91 92 93 94 95
technology for Computer-Supported Cooperative Work (CSCW).}. Similar
systems were QZ-KOM and PortaCOM@footnote{Also known as ``PottaKOM'' and
``BortaKOM.''}. The LysKOM system is copyrighted by Lysator Academic
Computing Society and distributed under conditions of the GNU Public
License. LysKOM and its documentation is provided ``as is'' without
warranty of any kind.
David Byers's avatar
David Byers committed
96

97 98 99
This document specifies version 10.0 of protocol A used between a LysKOM
client and a LysKOM server. Anything described here as ``unspecified''
is liable to change in future protocol versions.
David Byers's avatar
David Byers committed
100 101

This specification is the work of several people. The main contributors have
102
been
David Byers's avatar
David Byers committed
103 104
Per Cederqvist @email{ceder@@lysator.liu.se}, 
David Byers @email{byers@@lysator.liu.se},
David Byers's avatar
David Byers committed
105 106 107 108 109 110
@ifinfo
Pr
@end ifinfo
@iftex
P@"ar
@end iftex
David Byers's avatar
David Byers committed
111 112 113 114
Emanuelsson @email{pell@@lysator.liu.se},
Thomas Bellman @email{bellman@@lysator.liu.se}, 
Lars Aronsson @email{aronsson@@lysator.liu.se},
Linus Tolke @email{linus@@lysator.liu.se} and
David Byers's avatar
David Byers committed
115 116 117 118 119 120
@ifinfo
Kent Engstrm
@end ifinfo
@iftex
Kent Eng@-str@"om@penalty-10000
@end iftex
David Byers's avatar
David Byers committed
121
@email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
122

David Byers's avatar
David Byers committed
123 124
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
125

126 127 128 129
@menu
* Document Revision History::   
* Protocol Version History::    
* Notation::                    
David Byers's avatar
David Byers committed
130 131
@end menu

132
@node Document Revision History
David Byers's avatar
David Byers committed
133 134 135
@section Document Revision History

@table @asis
136

David Byers's avatar
Server:  
David Byers committed
137 138 139 140
@item 10.0: 1999-06-31
Call @code{sub-comment} was incorrectly marked obsolete. This has been
corrected.

141
@item 10.0: 1999-06-27
142 143 144 145
The specification was translated to English and converted to Texinfo by
David Byers.  Protocol version 10.  Distributed with lyskomd 2.0.0.

@item 9.0: 1996-08-04
146
Protocol version 9.  Distributed with lyskomd 1.9.0.
147

David Byers's avatar
David Byers committed
148
@item 8.0: 1995-11-10
149
Protocol version 8.  Distributed with lyskomd 1.8.0.
David Byers's avatar
David Byers committed
150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173

@item 7.1: 1995-01-08.
Protocol and document revision history were added by Per Cederqvist. Outline
mode was used to make the document more manageable. This version was
distributed with lyskomd 1.7.1.

@item 7.0: 1994-12-31.
The first specification with a version number. All calls that had been added
since 1991-06-25 were documented. Pell and Per Cederqvist did the deed. This
version was distributed with lyskomd 1.7.0.

@item 1993-05-19.
Linus Tolke wrote comments for some calls that were without comments.

@item 1992-07-06.
Linus Tolke converted the document to ISO 8859-1.

@item 1991-08-12.
Per Cederqvist started using version control for documentation.

@item 1991-06-25.
Lars Aronsson documented the protocol that was in use at the time.
@end table

174
@node Protocol Version History
175 176 177
@section Protocol Version History

@subsection Protocol version 10 (first implemented in lyskomd 2.0.0)
David Byers's avatar
David Byers committed
178

179
@table @asis
180 181 182 183 184 185

@item Error codes

The error codes are now documented.  Several error codes were changed to
more sane values while documenting the new behaviour.

186
@item New Server Calls
187 188 189

These new calls have status Recommended.

190 191 192 193 194 195 196 197 198 199 200 201 202
@itemize @bullet
@item 85=get-collate-table
@item 86=create-text
@item 87=create-anonymous-text
@item 88=create-conf
@item 89=create-person
@item 90=get-text-stat
@item 91=get-conf-stat
@item 92=modify-text-info
@item 93=modify-conf-info
@item 94=get-info
@item 95=modify-system-info
@item 96=query-predefined-aux-items
203 204 205 206
@item 98=query-read-texts
@item 99=get-membership
@item 100=add-member
@item 101=get-members
207 208 209
@item 102=set-membership-type
@item 103=local-to-global
@item 104=map-created-texts
210 211 212 213 214 215 216
@item 106=set-pers-flags
@end itemize

These new calls have status Experimental.

@itemize @bullet
@item 97=set-expire
David Byers's avatar
David Byers committed
217
@item 105=set-keep-commented
218 219
@end itemize

220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241
@item Name changes

@multitable {59=create-anonymous-text} {59=create-anonymous-text-old}
@item Old name                 @tab New name
@item 5=create-person          @tab 5=create-person-old
@item 9=query-read-texts       @tab 9=query-read-texts-old
@item 10=create-conf           @tab 10=create-conf-old
@item 13=get-conf-stat-old     @tab 13=get-conf-stat-older
@item 14=add-member            @tab 14=add-member-old
@item 26=get-text-stat         @tab 26=get-text-stat-old
@item 28=create-text           @tab 28=create-text-old
@item 36=get-info              @tab 36=get-info-old
@item 46=get-membership        @tab 46=get-membership-old
@item 48=get-members           @tab 48=get-members-old
@item 50=get-conf-stat         @tab 50=get-conf-stat-old
@item 59=create-anonymous-text @tab 59=create-anonymous-text-old
@end multitable

@item Status change

The following calls have change status from Experimental to Recommended.

242
@itemize @bullet
243 244 245 246 247 248 249 250 251 252 253 254 255 256 257
@item 58=get-last-text
@item 77=set-last-read
@item 78=get-uconf-stat
@end itemize

The following calls are have changed status from Recommended or
Experimental to Obsolete.

@itemize @bullet
@item 5=create-person-old
@item 9=query-read-texts-old
@item 10=create-conf-old
@item 14=add-member-old
@item 26=get-text-stat-old
@item 28=create-text-old
258
@item 36=get-info-old
259
@item 46=get-membership-old
260
@item 47=get-created-texts
261
@item 48=get-members-old
262 263
@item 50=get-conf-stat-old
@item 59=create-anonymous-text-old
264 265
@end itemize

266
@item New and Modified Structures
267
@itemize @bullet
268
@item Aux-Item
269
@item Aux-Item-Input
270 271
@item Conference
@item Info
272 273 274
@item Member
@item Membership
@item Membership-Type
275 276
@item Misc-Info
@item Text-Stat
277 278
@end itemize

279 280 281 282 283 284
@item Renamed Asynchronous Messages
A @samp{async-} prefix has been added to the name of all asynchronous
messages.  In addition, 0=new-text has been renamed to
0=async-new-text-old, and it is now considered obsolete.  Clients should
use 80=accept-async to listen to 15=async-new-text instead.

285 286
@item New Asynchronous Messages
@itemize @bullet
287 288 289 290 291
@item 14=async-deleted-text
@item 15=async-new-text
@item 16=async-new-recipient
@item 17=async-sub-recipient
@item 18=async-new-membership
292
@end itemize
293 294 295 296 297 298 299 300 301 302 303 304 305

@item Notes
@itemize @bullet
@item Since protocol version 9 setting a priority of zero in a
conference was supposed to indicate passive membership in a conference. 
It was largely up to the client to implement this. True passive
memberships have been introduced in this protocol version through the
Membership-type extension to Membership type. In order to maintain
compatibility with clients that interpret priority 0 as passive
membership, the old calls @pxref{add-member-old} and
@pxref{get-membership-old} perform magic, translating between priorities 
and membership types. The magic is documented with each call.
@end itemize
306 307
@end table

308

309
@subsection Protocol version 9 (first implemented in lyskomd 1.9.0)
310 311

@table @asis
312 313 314 315 316 317
@item New functionality
@itemize @bullet
@item The server shall now reply with error @code{not-implemented} when
a client attempts to use an unimplemented call.  This feature requires
that the client uses newline as call terminator.
@end itemize
Per Cederqvist's avatar
Per Cederqvist committed
318
@item Added Commands
319
@itemize @bullet
320 321 322 323 324 325
@item 79=set-info: Can change server information.
@item 80=accept-async: Can select asynchronous messages to receive.
@item 81=query-async: Can query which messages are being send.
@item 82=user-active
@item 83=who-is-on-dynamic
@item 84=get-static-session-info
326
@end itemize
327 328 329 330 331 332 333
@item Changed names
@itemize @bullet
@item @code{change-conference} was previously called @code{pepsi}.  The
name was changed, but not the functionality.
@end itemize
@item Status change
@itemize @bullet
David Byers's avatar
David Byers committed
334 335
@item 63=@code{who-is-on-ident} is now considered obsolete.
@item 64=@code{get-session-info-ident} is now considered obsolete.
336
@end itemize
337 338
@end table

339
@subsection Protocol version 8 (first implemented in lyskomd 1.8.0)
David Byers's avatar
David Byers committed
340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374

@table @asis 
@item Added Functionality
@itemize @bullet
@item
30=add-recipient: Can change recpt to cc_recpt and vice versa.
@item
21=set-conf-type: Accepts Conf-Type and Extended-Conf-Type.
@item
10=create-conf: Accepts Conf-Type and Extended-Conf-Type.
@end itemize

@item New Commands
@itemize @bullet
@item
77=set-last-read
@item
78=get-uconf-stat
@end itemize
@end table

@subsection Protocol version 7 (first implemented in lyskomd 1.7.0)

@table @asis
@item Added Functionality
@itemize @bullet
@item
53=send-message: Recipient can be a conference or a person.
@end itemize

@item New Commands
@itemize @bullet
@item
74=re-z-lookup
@item
375
75=get-version-info
David Byers's avatar
David Byers committed
376
@item
377
76=lookup-z-name
David Byers's avatar
David Byers committed
378 379 380 381 382
@end itemize

@item Other
@itemize @bullet
@item
Per Cederqvist's avatar
Per Cederqvist committed
383
The asynchronous message 1=i-am-off has been removed
David Byers's avatar
David Byers committed
384 385 386 387 388 389 390 391 392
@end itemize
@end table

@subsection Protocol Version 6 (first implemented in lyskomd 1.4.0)

@table @asis
@item New Calls
@itemize @bullet
@item
393
67=lookup-person
David Byers's avatar
David Byers committed
394
@item
395
68=lookup-conf
David Byers's avatar
David Byers committed
396
@item
397
69=set-client-version
David Byers's avatar
David Byers committed
398
@item
399
70=get-client-name
David Byers's avatar
David Byers committed
400
@item
401
71=get-client-version
David Byers's avatar
David Byers committed
402
@item
403
72=mark-text
David Byers's avatar
David Byers committed
404
@item
405
73=unmark-text
David Byers's avatar
David Byers committed
406 407 408 409 410 411 412 413 414 415
@end itemize
@end table


@subsection Protocol Version 5 (first implemented in lyskomd 1.3.0)

@table @asis
@item New Calls
@itemize @bullet
@item
416
65=re-lookup-person
David Byers's avatar
David Byers committed
417
@item
418
66=re-lookup-conf
David Byers's avatar
David Byers committed
419 420 421 422 423 424 425 426 427 428 429
@end itemize
@end table

@subsection Protocol Version 4 (first implemented in lyskomd 1.1.1)

@table @asis
@item New Calls
@itemize @bullet
@item
62=login
@item
430
63=who-is-on-ident
David Byers's avatar
David Byers committed
431
@item
432
64=get-session-info-ident
David Byers's avatar
David Byers committed
433 434 435 436 437 438 439 440 441
@end itemize
@end table

@subsection Protocol Version 3 (first implemented in lyskomd 1.1.0)

@table @asis
@item New Calls
@itemize @bullet
@item
442
61=find-previous-text-no
David Byers's avatar
David Byers committed
443
@item
444
60=find-next-text-no
David Byers's avatar
David Byers committed
445
@item
446
59=create-anonymous-text
David Byers's avatar
David Byers committed
447
@item
448
58=get-last-text
David Byers's avatar
David Byers committed
449 450 451 452 453 454 455 456 457
@end itemize
@end table

@subsection Protocol Version 2 (first implemented in lyskomd 0.30.0)

@table @asis
@item New Calls
@itemize @bullet
@item
458
57=set-user-area
David Byers's avatar
David Byers committed
459 460 461 462 463 464 465 466 467 468 469
@end itemize
@end table

@subsection Protocol Version 1 (first implemented in lyskomd 0.29.2)

@table @asis
@item New Calls
All calls from 0--56.
@end table


470
@node Notation
David Byers's avatar
David Byers committed
471 472
@section Notation

473
This specification uses a BNF-like grammar to describe the protocol and
474
its data elements.
David Byers's avatar
David Byers committed
475

476
Data fields have been given names that start with a lower-case letter.
477 478 479 480 481 482 483 484 485 486 487

Fundamental data types have names in all-caps (such as @code{INT32} and
@code{ARRAY}).

Derived data types have names that start with an upper-case letter. (If
the type contains more than one word, all words start with an upper-case
letter, like this: @code{Text-Stat}.)  The operator @code{::=} defines
the name to its left.

Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
488 489 490
terminates statements in the grammar. In some specifications there are
literal strings. There is to be no whitespace before or after literal
strings unless there is whitespace in the literal itself.
David Byers's avatar
David Byers committed
491 492


493
@node Introduction
David Byers's avatar
David Byers committed
494 495 496 497 498 499
@chapter Introduction

This chapter introduces the concepts used in LysKOM, such as articles,
conferences and sessions. 

@menu
500 501 502 503 504 505 506
* Articles::                    
* Conferences::                 
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
* Client-Server Dialog::        
David Byers's avatar
David Byers committed
507 508 509
@end menu


510
@node Articles
David Byers's avatar
David Byers committed
511 512 513 514
@section Articles

An article is represented as a value of the type @code{Text-Stat} and a
string containing the article contents. An article will usually have one
515 516 517 518
or more recipients and may be a comment or footnote to other articles.
Each article is kept in the database until it is older than the
@code{nice} value of each of its recipients and it is not marked by any
user.
David Byers's avatar
David Byers committed
519

520 521 522 523 524
Currently there is a structure called a @code{Misc-Info-List} associated
with the @code{Text-Stat}. This list contains information about
recipients, senders, comments and footnotes. In the future the
information contained in the @code{Misc-Info-List} will be integrated
into the @code{Text-Stat}.
David Byers's avatar
David Byers committed
525 526 527

Every article has at least one number, the global article number. Global
numbers are assigned in ascending order to new articles, and are never
528
reused. If an article has recipients it will also have a local number
Per Cederqvist's avatar
Per Cederqvist committed
529
for each recipient. Local numbers are used in some data structures to
530
provide more compact storage and to provide an ordering of articles for
531 532 533
a particular recipient. Local numbers are assigned in ascending order
and are never reused for a particular recipient, though different
recipients will have articles with the same local numbers.
David Byers's avatar
David Byers committed
534

535
Occasionally it is necessary to map between local and global numbers.
536
The server call @code{local-to-global} does this.
David Byers's avatar
David Byers committed
537 538 539



540
@node Conferences
David Byers's avatar
David Byers committed
541 542
@section Conferences

543 544 545 546
Conferences hold articles. They are represented in the protocol as a
data type called @code{Conference}. Each conference has a
@emph{creator}, the person who created the conference, and a
@emph{supervisor}, a conference whose members can modify the conference.
David Byers's avatar
David Byers committed
547
If the supervisor is a person, the members of that person's mailbox
548 549 550 551 552
are supervisors, which in most cases is only that person. We have also
introduced a type called @code{UConference} (pronounced micro-conf-stat)
which holds a subset of the information contained in the full
@code{Conference} type. Use the @code{UConference} type whenever
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
553 554

Each conference has a type, which is essentially a collection of boolean
Per Cederqvist's avatar
Per Cederqvist committed
555
flags. Currently the flags @code{rd-prot}, @code{letterbox},
556
@code{secret}, @code{original} and @code{allow-anonymous} are defined.
David Byers's avatar
David Byers committed
557 558 559 560 561 562 563

@table @code
@item rd-prot
The conference is protected from reading by non-members. Persons become
members by having one of the existing members or supervisors add him or
her to the conference. This restriction is enforced by the server.
@item original
564 565 566 567
Conferences of this type are intended for original articles only.
Comments are to be redirected to the super-conference instead. This
restriction is currently not enforced by the server; clients must
implement this functionality.
David Byers's avatar
David Byers committed
568
@item letterbox
569
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
570
are sent to the mailbox and the name of the mailbox is synchronized
571 572
with the person name. It is currently not possible to explicitly set or
clear this flag on a conference.
David Byers's avatar
David Byers committed
573 574 575
@item secret
Conferences of this type are secret. The server will not divulge any
information of the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
576
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
577 578
that person cannot log in using the person name, but must specify a
person number instead.
579 580 581
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
582 583 584
@item forbid-secret
Conferences of this type do not allow secret members. If a conference is 
changed to this type, preexisting secret members remain secret.
David Byers's avatar
David Byers committed
585 586 587 588
@end table



589 590 591 592
@menu
* Persons and Sessions::        
@end menu

593
@node Persons and Sessions
David Byers's avatar
David Byers committed
594 595 596
@subsection Persons and Sessions

Persons are represented in the protocol by values of the type
597 598 599 600
@code{Person}. Associated with persons are statistics, a set of personal
flags and a set of privileges (@pxref{Security}.) Persons are also
associated with a conference that has the same number as the person and
the @code{letterbox} bit set.
David Byers's avatar
David Byers committed
601 602

Connections to the server are represented as values of the type
603 604 605 606 607 608
@code{Static-Session-Info}, @code{Session-Info-Ident} or
@code{Session-Info}. Sessions have session number that are unique for
each session in the lifetime of the server execution. A single user can
have several sessions running at once. The session is not released until
the network connection is closed; a user can log in and out repeatedly
in a single session.
David Byers's avatar
David Byers committed
609 610


611
@node The Misc-Info List
David Byers's avatar
David Byers committed
612 613
@section The Misc-Info List

614 615
The @code{Misc-Info} list contains tagged data. The fields are sent in
groups pertaining to a particular type of information: information about
616 617
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
618 619 620
and footnote in. The information groups may be sent in any order and
there may be any number of groups. Within each group the elements are
always sent in the order listed below.
David Byers's avatar
David Byers committed
621

622
@subsection Recipient
David Byers's avatar
David Byers committed
623 624 625

@table @code
@item recpt
626 627
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
628
@item loc-no
629 630 631
Always present within a recipient group. It contains the local text
number of the article in the conference specified by the preceding
@code{recpt} field.
David Byers's avatar
David Byers committed
632
@item rec-time
633 634 635
If the recipient is a person, this element is added by the server when
the recipient marks the article as read. It contains the time when the
text was read.
David Byers's avatar
David Byers committed
636
@item sent-by
637 638 639
Present when the recipient was added by a person other than the author
(after the article was created.) It contains the person number of the
person who added the recipient.
David Byers's avatar
David Byers committed
640
@item sent-at
641 642
Present when the recipient was added after the article was created. It
contains the time when the recipient was added.
David Byers's avatar
David Byers committed
643 644 645
@end table


646
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
647

648 649 650 651
The carbon-copy recipient group is identical to the recipient group
above. The difference is how new comments to an article with a recipient
or carbon-copy recipient are treated. A comment to an article is sent to
all recipients, but not to carbon-copy recipients of the original
Per Cederqvist's avatar
Per Cederqvist committed
652
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
653 654 655

@table @code
@item cc-recpt
656 657
Starts a carbon-copy recipient group. It contains the conference number
of a carbon-copy recipient of the article.
David Byers's avatar
David Byers committed
658
@item loc-no
659 660 661
Always present in a CC recipient group. It contains the local text
number of the article in the conference specified by the most recent
@code{cc-recpt} field.
David Byers's avatar
David Byers committed
662
@item rec-time
663
Present after the CC recipient has read the article. It contains the
664 665
time when the article was read. Since only persons can read articles
this will only be seen if the CC recipient is a person.
David Byers's avatar
David Byers committed
666 667 668
@item sent-by
Present when a CC recipient was added by a person other than the author
after the article had been created. It contains the person number of the
669
person who added the CC recipient.
David Byers's avatar
David Byers committed
670 671 672 673 674 675
@item sent-at
Present when a CC recipient was added after the article had been
created. It is the time when the CC recipient was added.
@end table


676 677 678 679 680 681 682 683 684 685 686 687 688 689
@subsection Blank Carbon Copy (BCC) Recipient

The blank carbon-copy recipient group is identical to the carbon-copy
recipient group above. The difference is the visibility of the
information. A carbon-copy recipient group is visible to anyone that is
allowed to fetch both the text status of the involed text and the
conference status of the involved conference.  (That is, as long as the
conference isn't secret everybody is allowed to se the carbon-copy
recipient group.)

A BCC recipient group is only visible to members and supervisors of the
recipient.  This is enforced by the server.

This type of group was introduced in protocol version 10.  When
690
old-style calls such as @xref{get-text-stat-old} are used this
691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715
will be converted to a CC recipient group by the server for the benefit
of clients that don't understand this group.

@table @code
@item bcc-recpt
Starts a blank carbon-copy recipient group. It contains the conference
number of a blank carbon-copy recipient of the article.
@item loc-no
Always present in a BCC recipient group. It contains the local text
number of the article in the conference specified by the most recent
@code{bcc-recpt} field.
@item rec-time
Present after the BCC recipient has read the article. It contains the
time when the article was read. Since only persons can read articles
this will only be seen if the BCC recipient is a person.
@item sent-by
Present when a BCC recipient was added by a person other than the author
after the article had been created. It contains the person number of the
person who added the BCC recipient.
@item sent-at
Present when a BCC recipient was added after the article had been
created. It is the time when the BCC recipient was added.
@end table


716
@subsection Comment To
David Byers's avatar
David Byers committed
717 718 719 720 721 722 723 724 725 726 727 728 729 730

@table @code
@item comm-to
Always present when the article is a comment to another article.
@item sent-by
Present when the article was added as a comment by a person other than
the author, after the article had been created. It contains the person
number of the person who added the article as a comment.
@item sent-at
Present when the article was added as a comment after the article had
been created. It contains the time when is was added as a comment.
@end table


731
@subsection Footnote To
David Byers's avatar
David Byers committed
732 733

@table @code
734
@item footn-to
David Byers's avatar
David Byers committed
735 736 737 738 739 740 741
Always present when the article is a footnote to another article.
@item sent-at
Present when the article was added as a footnote after the article had
been created. It contains the time when is was added as a footnote.
@end table


742
@subsection Comment in
David Byers's avatar
David Byers committed
743 744 745 746 747 748 749 750

@table @code
@item comm-in
Present when there are comments to this article. It contains the article
number which is a comment to this article.
@end table


751
@subsection Footnote in
David Byers's avatar
David Byers committed
752 753

@table @code
754
@item footn-in
David Byers's avatar
David Byers committed
755 756 757 758 759
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


760
@node The Aux-Item List
761
@section The Aux-Item List
762 763 764 765 766

The aux-item list is used as a generic extension mechanism in the LysKOM
server and in protocol A. 

@menu
767 768 769 770 771
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
772 773
@end menu

774
@node About Aux-Items
775
@subsection About Aux-Items
776 777 778 779

Aux-items were introduced in protocol version 10 as a mechanism for
extending the conference, text and server information structures without
changing the protocol. Persons were excluded since nobody could figure
David Byers's avatar
David Byers committed
780
out a case where setting an aux-item on the mailbox wasn't as good as
781 782 783 784 785 786 787 788 789
setting it on the person (another reason was that I was fed up writing
aux-item code by the time they were working on texts and conferences.)

The exact structure of an aux item is specified elsewhere (@pxref{LysKOM
Data Types}). The important fields here are the aux-no, tag and data
fields.

The aux-no field is used to identify an item. The aux-no together with a
text or conference number uniquely identifies a particular aux item.
790
Items are numbered from one and up within each item list. Once assigned,
791 792 793 794
the aux-no for an item is never changed. New items are guaranteed to
be assigned numbers that have never been used before within a particular
list.

795
The tag field identifies the type of aux item. It is used by the server
796 797 798 799 800 801 802 803 804 805
and by clients to figure out how to interpret the data field, and by the
server to decide if the item needs special treatment.

The data field is a simple string. The meaning of the string is
determined by the tag field, but since it is a string, clients that have
no understanding of the contents can successfully parse the item anyway
(in contrast to items in the misc-info list.)



806
@node Predefined Aux-Item Types
807
@subsection Predefined Aux-Item Types
808

David Byers's avatar
David Byers committed
809 810 811
Predefined Aux-Item types are part of Protocol A, and clients should
support all of them. As with other parts of the protocol, changes to
these definitions will be made backwards-compatible, if possible.
812

David Byers's avatar
David Byers committed
813 814 815 816 817 818
Creation and deletion of items with a predefined type can cause
arbitrarily complex and wonderous behavior in the server. Furthermore,
the server may place constraints on the items with regard to content,
flags, who can create them, to what objects they can be attached to and
so forth. The server may also silently enforce specific values for any
field of an item, regardless of what the client requests.
819

820
All items with tags in the range 1-9999 and 30000 and up are considered
821 822
predefined. If a client attempts to create an item with a tag in this
range, but the server has no idea what that tag means, the server will
David Byers's avatar
David Byers committed
823
return an error (illegal-aux-item.)
824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840



@table @samp
@item content-type [1] (text)
Specifies the content type of a text. Data is a valid MIME type of one
of the special LysKOM types (@pxref{LysKOM Content Types}.)

This item may only be set by the author of a text. The inherit, secret
and hide-owner bits are cleared. Only one content-type item can be
created per creator.


@item fast-reply [2] (text)
Data is a string that constitutes a brief comment to the text. This
comment should be displayed immediately after the text body. 

David Byers's avatar
David Byers committed
841 842
An item of this type will never be inherited, can always be deleted, is
never anonymous and is never secret.
843 844 845


@item cross-reference [3] (text, conference)
David Byers's avatar
David Byers committed
846 847 848 849 850 851 852 853
Data is a cross-reference to something else. The contents consist of a
letter, a number, a space and a descriptive text. The letter must be one
of T, C or P. T specifies that the cross-reference points to a text; C
that it points to a conference; and P that it points to a person. The
number is the id of the target of the cross reference. The descriptive
text is simly that, a text that describes the cross-reference. For
example, "T15 Check this out!" is a cross reference to text 15 with a
description that reads "Check this out!".
854

David Byers's avatar
David Byers committed
855 856
The inherit bit is automatically cleared and the item can always be
deleted. 
857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889


@item no-comments [4] (text)
When this item is set, the author requests that nobody comments the
text. This is advisory only; it is still possible to write comments, but
clients should advise the user that this is contrary to the author's
wishes. Data should be empty.

This item may only be set by the author. The secret, hide-creator and
inherit bits are automatically cleared.


@item personal-comment [5] (text)
When this item is set, the author requests only personal comments. This
is advisory only; it is still possible to create regular comments, but
clients should advise the user that the author prefers a personal
comment. Data should be empty.

This item may only be set by the author. The secret, hide-creator and
inherit bits are automatically cleared.


@item request-confirmation [6] (text)
The author requests that everyone who reads the text confirms having
done so by creating read-confirmation items on the text. Clients should
ask users if they wish to confirm having read the text when it is
displayed. Data should be empty.

The hide-creator, secret and inherit bits are automatically cleared.


@item read-confirm [7] (text)
This item can be taken as confirmation that the item creator has read
890 891 892
the text to which the item is attached. Clients should never ever create
this item without an explicit confirmation from the user that the text
has indeed been read.
893 894

The hide-creator, secret and inherit bits are automatically cleared.
David Byers's avatar
David Byers committed
895
Once created an item of this type cannot be deleted.
896 897 898


@item redirect [8] (conference)
David Byers's avatar
David Byers committed
899

David Byers's avatar
David Byers committed
900 901 902 903 904 905 906 907 908 909 910
This item indicates that texts should not be sent to the conference,
but be directed to some other target instead. Clients should notify
users that attempt to send texts to the conference of the redirect and
offer to send the text to the target of the redirect instead. A typical
use of this item would be a user that does not read LysKOM very often
and would like to advise other users to send e-mail instead.

Data is PROTOCOL:ADDRESS where PROTOCOL is either "E-mail" or "LysKOM",
and ADDRESS is either an e-mail address or a LysKOM conference. 
Hopefully we'll be able to replace this with a forwarding mechanism
later.
911 912

This item can only be set by the conference supervisor or in the case of
David Byers's avatar
David Byers committed
913
a mailbox, the person attached to the mailbox. The hide-creator and
914 915 916
secret bits are cleared automatically. Only one redirect can be
specified.

David Byers's avatar
David Byers committed
917

918 919 920 921 922
@item x-face [9] (conference)

Data is the face of the person in compface format. Cool, innit?

This item can only be set by the conference supervisor or in the case of
David Byers's avatar
David Byers committed
923
a mailbox, the person attached to the mailbox. The hide-creator and
924 925 926
secret bits are cleared automatically. 


927
@item alternate-name [10] (text, conference)
928 929

Data is a string that the client may use as an alternate to the name of
David Byers's avatar
David Byers committed
930 931 932
a conference or the subject of a text. Note that the server does not
match against this name when performing name lookups. Clients should
only display alternate names created by the user currently logged on.
933 934 935 936 937 938 939

The inherit flag is automatically cleared.


@item pgp-signature [11] (text)

Data is a PGP signature of the text. The signature should be the
David Byers's avatar
David Byers committed
940
equivalent of what "pgp -sba" in PGP 2.6.2 generates.
941 942 943 944 945 946 947 948

The secret, hide-creator and inherit bits are automatically cleared.
Signatures cannot be deleted once they have been created.


@item pgp-public-key [12] (letterbox)

Data is the public key of the person. It is desirable that the public
David Byers's avatar
David Byers committed
949 950 951
key contains a userid of the format "LysKOM <p@var{n}@@@var{server}>+",
where @var{n} is the number of the person in the LysKOM server specified
in @var{server}. This rule is currently not enforced.
952 953 954 955

This item can only be set by the person himself. The hide-creator,
secret and inherit bits are automatically cleared.

David Byers's avatar
David Byers committed
956

957 958
@item e-mail-address [13] (conference, letterbox, server)

David Byers's avatar
David Byers committed
959 960
Data is an RFC 822-style email address. When set on a mailbox, it
should be the email address of the person. If the person has multiple
961 962 963
email addresses he may set serveral e-mail-address aux-items.

The meaning of this aux-item when set on a conference that isn't a
David Byers's avatar
David Byers committed
964 965 966
mailbox is vague. For a conference that is used as to import a mailing
list this should be the email address of the list. For other conferences 
we haven't really defined a sensible use.
967 968

When this aux-item is set on the server it shold contain the email
969
address of the administrator (or administrators.)
970

David Byers's avatar
David Byers committed
971 972 973
This aux-item can only be set by the supervisor of a conference or the
server administrator. The creator cannot be hidden.

974 975 976 977

@item faq-text [14] (conference, server)

Data is a decimal text number, which is a FAQ for the conference (or
David Byers's avatar
David Byers committed
978 979
server). Creating an item of this type automatically causes creation of
a faq-for-conf item.
David Byers's avatar
David Byers committed
980 981 982 983

This item can only be set by the supervisor or server administrator. The 
hide-creator, secret, and inherit bits are automatically cleared.

984 985 986 987 988 989 990 991 992 993 994 995

@item creating-software [15] (text)

Data is the name and version number of the client that created the
text.  This aux-item can only be set by the author of the text.  Once
set, it cannot be removed or changed.  A typical value would be
@samp{elisp-client 0.47.3}.  Setting the creating-software aux-item is
optional.

The data should be the client name, a space, and the client version used
in the @code{set-client-version} call.  The server may enforce this
restriction.
996

997
@item mx-author [16] (text)
998

999 1000 1001
Data is a string containing the name of the author of an imported
e-mail. Clients should display this instead of the actual author of the
text, which will be an importer ID.
1002 1003


1004
@item mx-from [17] (text)
1005

1006 1007 1008
Data is the e-mail address extracted from the @code{From} header of an
imported e-mail. This field can be used by clients to construct an
address for personal (e-mail) replies to an imported message.
1009 1010


1011
@item mx-reply-to [18] (text)
1012

1013 1014 1015
Data is the e-mail address extracted from the @code{Reply-To} header of
an imported e-mail. Clients should use this for constructing replies to
imported messages.
1016 1017


1018
@item mx-to [19] (text)
1019

1020 1021 1022 1023
Data is a single e-mail address, and must be valid as the contents of an
e-mail @code{To} header. Multiple @code{mx-o} items may be present. For
imported messages, these items contain the @code{To} header of the
messages.
1024

1025 1026 1027
On messages created by a LysKOM person, the @code{mx-to} items are used
by the exporter to determine that the message is to be exported and
where to send it.
1028

1029
@item mx-cc [20] (text)
1030

1031 1032
Same as @code{mx-to}, but applies to the @code{CC} header rather than
the @code{To} header.
1033

1034

1035
@item mx-date [21] (text)
1036

1037 1038 1039 1040 1041 1042 1043 1044 1045
Data is the send data of an imported e-mail. Its format is "YYYY-MM-DD
hh:mm:ss TZ". YYYY is the year the message was sent, MM is the month, DD 
is the day, hh is the hour, mm is the minute and ss is the second. This
date and time are given in the timezone where the message was sent. TZ
is the timezone the date is valid for. It must be of the form "+hhmm" or 
"-hhmm", where hh is the number of hours offset from UTC and mm is the
number of minutes offset. Symbolic timezones are not permitted. The
timezone specification is recommended but optional, since it is not
always available.
1046

1047 1048
Clients should display this date as the date a text was written since
the imported text will have been created at a later date. 
1049 1050


1051 1052 1053
@item mx-message-id [22] (text)

Data is the @code{Message-ID} header of an imported e-mail. This is used 
David Byers's avatar
David Byers committed
1054
by e-mail importers. LysKOM exporters should set the message ID to
David Byers's avatar
David Byers committed
1055 1056
@code{<LysKOM%@var{text-no}@@@var{server}}, where @var{text-no} is the text
number and @var{server} is the name of the server. 
1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074


@item mx-in-reply-to [23] (text)

Data is a string containing one item from the @code{In-Reply-To} header
of an imported e-mail. If the @code{In-Reply-To} header contains several 
items, there will be several @code{mx-in-reply-to} items.


@item mx-misc [24] (text)

Data is a string that contains all of the headers, including
@code{Subject}, and including whose that are redundantly stored in other
aux-items. It is set by the importer. The fields are concatenated with
"\n". In other words, this item contains all headers of an imported
e-mail as they appear in the message.

@item mx-allow-filter [25] (conference)
1075 1076

Data is a regexp string which allows a sender (a field in the
1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088
email-header) to import the message. If none is present, the text is
imported. Several filters can exist, however, it is enough if one
positive filter matches (OR) and none negative dissallows (AND)
import. The order is of no importance. Can be set by an organizer of the
conference.

The regexp is case insensitive, and use a glob-pat style, it allows
[^]?*+(|) as constructs. Note that "." is literal. The importer is
required to check these when adding recipient of an imported text and
comply. Example of usage: (positive filter) "From:*.liu.se*",
"From:*jsk*". "From:*(jonas|jonka|jsk)*" Tests are not made on the
text-body.
1089 1090

However, if the string starts with a "!" the email will be rejected if
1091
the there is a match (negative filter), even if one of the filter allowed it.  Example:
1092 1093
"!From:*aol*", "!Subject:*money*". 

1094
@item mx-reject-forward [26] (conference)
1095

1096 1097
Data is a string with either an email name on the same format as
aux-info rediret [8]. The mail is forwarded to this address if it was
1098
rejected by "mx-import-filter".
1099

David Byers's avatar
David Byers committed
1100 1101 1102 1103 1104 1105 1106 1107 1108 1109
@item notify-comments [27] (letterbox)

Data is a decimal text number that the user is interested in. Clients
should monitor this text for unread comments and present these to the
user in some convenient manner. This is typically used by users that
want to read comments to some text of theirs as soon as they arrive,
rather than in the normal reading order.

This item can only be set by the owner of the letterbox. No flags are
forced or cleared.
1110

David Byers's avatar
David Byers committed
1111 1112 1113 1114 1115 1116 1117 1118
@item faq-for-conf [28] (text)

Data is a decimal number specifying the conference a certain text is a
FAQ for. The special number zero denotes that the text is a FAQ for the
entire system. Items of this kind can only be created by the LysKOM
server itself. Texts with this item are protected from garbage
collection.

1119

David Byers's avatar
David Byers committed
1120 1121
@end table

1122

1123
@node Client-Specific Aux-Item Types
1124
@subsection Client-Specific Aux-Item Types
1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144

Client-specific items do not cause the server to perform any magic. All
the flags (except the delete flag) are left untouched, the data is not
validated in any way, and anyone can create any item. If you need more
server support than this, your item should be on the predefined list.

All tags in the range 10000-19999 are reserved for clients. Blocks of
100 numbers at a time can be assigned to specific clients. A client
should never create items with tags in a range assigned to another
client or in an unassigned range. Assigned ranges will never change.

Currently, the following ranges are assigned to clients:
@itemize @bullet
@item 10000-10099: The Elisp Client
@end itemize

If you want a range of numbers, send e-mail to the LysKOM development
group.


1145
@node Experimental Aux-Item Types
1146
@subsection Experimental Aux-Item Types
1147 1148 1149 1150 1151 1152

Experimental numbers are free for all. Use 'em any way you want. All
numbers in the range 20000-29999 are for experimental use. 



1153
@node Defining New Aux-Item Types
1154
@subsection Defining New Aux-Item Types
1155

1156
If you want a new predefined item type, just document what it does, what
1157 1158
the data format looks like and what the server is to do with the item
and send this to the LysKOM development group. We'll assign a number to
1159
your item and put the documentation in this document. 
1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178

If you're not sure what you want the data to look like yet, make a note
in your documentation that the data format might change. Once you have a
data format you're happy with, update the documentation so others may
use your item.

If you need serious magic in the server (more than can be specified with
the lyskomd configuration file), you'll probably have to write the code
yourself, or hope that the development group thinks your idea is so cool
we do the job for you.

The idea is not to reject any type of item, unless there's already an
item type that does the job just as well. Adding item types should be a
much less painful process than adding new calls.





1179
@node Security
1180
@section Security
David Byers's avatar
David Byers committed
1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252

Security in LysKOM is based on two components. Each person has a set of
privileges and each session has a security level. Rights in the system
require both the sufficient privileges and a sufficient security
level. The privileges currently available are wheel, admin, statistic,
create-conf, create-pers and change-name. Security levels range from 0
to 255.


@table @code
@item wheel
@emph{Normally not assigned}
@table @asis
@item Level 0
Person may always log in, even when LysKOM is crowded.
@item Level 6
Person may set Priv-Bits for all persons.
@item Level 7
Person may set password for all persons.
@item Level 8
Person acts as supervisor for everything.
@item Level 10
Person can read all articles.
@end table

@item admin
@emph{Normally not assigned}
@table @asis
@item Level 1
Shut down the server@*
Set motd_of_kom@*
Read last_login
@item Level 2
Read status of secret conferences and persons@*
Read the protected parts of person and conference statuses@*
Read the entire text status, even when there are secret recipients
@item Level 3
Change everybody's names
@item Level 4
Add/remove members@*
Add/remove recipients to articles
@item Level 5
Set super-conference@*
Remove articles
@item Level 6
Set administrator
@end table

@item statistic
@emph{Normally not assigned}
@table @asis
@item Level 2
Read the statistics portions of persons, even if protected
@end table

@item create_conf
@emph{Normally assigned}
@table @asis
@item Level 0
Create conferences
@end table

@item create_pers
@emph{Normally assigned}
@table @asis
@item Level 0
Create persons
@end table

@end table


1253
@node Membership and Reading
David Byers's avatar
David Byers committed
1254 1255
@section Membership and Reading

1256
Persons' memberships in conferences are represented in the protocol as
1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279
arrays of @code{Membership}-typed values. This structure contains
information about how and when the membership was created and which
texts have been read in the conference.

There are two kinds of memberships. An active membership indicates that
the person is actively participating in the conference, wants to know if 
there are unread texts and wants to receive messages send to the
conference. A passive membership is similar to no membership at all. The 
person is still a member but will not receive messages sent to the
conference and will not be notified when there are new texts. From the
user's perspective, passive membership should be like no membership at
all, but the server still remembers what the user has read in the
conference while he or she was an active member. Since protocol version
10 a bit in the membership type field of the membership structure
indicates the type of membership. Previously the server did not support
passive memberships, but there was a convention that clients should
treat the priority level zero as a passive membership.

The membership record indicates which texts have been read through the
@code{last-text-read} and @code{read-texts} fields. All texts with local 
numbers up to @code{last-text-read} have been read. In addition, all
texts with local numbers contained in the @code{read-texts} array have
been read.
David Byers's avatar
David Byers committed
1280 1281

Finding out which articles a person has read in a particular conference
1282 1283
requires a few calls. Normally, a client will retrieve a batch of
perhaps 50 articles at a time. The outline of the process is as follows:
David Byers's avatar
David Byers committed
1284 1285 1286

@enumerate
@item Fetch the membership to get the @code{last-text-read}
1287 1288 1289 1290
@item Use @pxref{local-to-global} to translate a number of local numbers 
to global numbers. 
@item Remove the global numbers corresponding to local numbers contained 
in @code{read-texts} from the result
David Byers's avatar
David Byers committed
1291 1292 1293
@item Get and translate more texts as needed.
@end enumerate

1294
The process is complicated because of the translation between local and
1295
global text numbers. If the server does not implement the
1296 1297