Protocol-A.texi 283 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
5
@c $Id: Protocol-A.texi,v 1.105 2001/04/13 10:28:29 ceder 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
Per Cederqvist's avatar
Per Cederqvist committed
22
This is revision 10.3 of the LysKOM Protocol A specification.  It
Per Cederqvist's avatar
Per Cederqvist committed
23
specifies version 10 of the protocol.
David Byers's avatar
David Byers committed
24

Per Cederqvist's avatar
Per Cederqvist committed
25
Copyright @copyright{} 1995-2000 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
Per Cederqvist's avatar
Per Cederqvist committed
47
Copyright @copyright{} 1995-2000 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.
Per Cederqvist's avatar
Per Cederqvist committed
68
This is revision 10.3 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
This document specifies version 10 of protocol A used between a LysKOM
98 99
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
Pär
@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 Engström
@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

Per Cederqvist's avatar
Per Cederqvist committed
137 138 139 140 141 142 143 144
@item 10.3: 2000-09-09
Several aux-items can be set on letterboxes and not only conferences.  A
few can now be set on the server.  The @code{allowed-content-type} and
@code{recommended-conf} aux-items were added.  The
@code{mx-allow-filter} and @code{mx-reject-forward} aux-items are marked
obsolete.  Text regarding mail import was improved, based on actual
experience in writing an email importer.  Reserved a range of aux-items
for komimportmail.  Several minor corrections and clarifications made.
145
Distributed with lyskomd 2.0.4.
Per Cederqvist's avatar
Per Cederqvist committed
146

Per Cederqvist's avatar
Per Cederqvist committed
147 148 149 150
@item 10.2: 1999-07-23
Some typos and other minor errors were fixed.  Distributed with lyskomd
2.0.2.

151
@item 10.1: 1999-07-12
David Byers's avatar
Server:  
David Byers committed
152
Call @code{sub-comment} was incorrectly marked obsolete. This has been
153 154 155 156 157
corrected. Regexps are case sensitive.  The Info-Type enumeration was
introduced in the description of the protocol.  (Previous versions of
the protocol had broken definitions of add-recipient,
async-new-recipient and async-sub-recipient.)  Distributed with lyskomd
2.0.1.
David Byers's avatar
Server:  
David Byers committed
158

159
@item 10.0: 1999-06-27
160 161
The specification was translated to English and converted to Texinfo by
David Byers.  Protocol version 10.  Distributed with lyskomd 2.0.0.
162 163 164
Note: this revision incorrectly marked the @code{sub-comment} call as
obsolete, and stated that regexp lookup was case insensitive.  Both
statements were wrong, and has since been fixed.
165 166

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

David Byers's avatar
David Byers committed
169
@item 8.0: 1995-11-10
170
Protocol version 8.  Distributed with lyskomd 1.8.0.
David Byers's avatar
David Byers committed
171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194

@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

195
@node Protocol Version History
196 197 198
@section Protocol Version History

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

200
@table @asis
201 202 203 204 205 206

@item Error codes

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

207
@item New Server Calls
208 209 210

These new calls have status Recommended.

211 212 213 214 215 216 217 218 219 220 221 222 223
@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
224 225 226 227
@item 98=query-read-texts
@item 99=get-membership
@item 100=add-member
@item 101=get-members
228 229 230
@item 102=set-membership-type
@item 103=local-to-global
@item 104=map-created-texts
231 232 233 234 235 236 237
@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
238
@item 105=set-keep-commented
239 240
@end itemize

241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262
@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.

263
@itemize @bullet
264 265 266 267 268
@item 58=get-last-text
@item 77=set-last-read
@item 78=get-uconf-stat
@end itemize

269
The following calls have changed status from Recommended or
270 271 272 273 274 275 276 277 278
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
279
@item 36=get-info-old
280
@item 46=get-membership-old
281
@item 47=get-created-texts
282
@item 48=get-members-old
283 284
@item 50=get-conf-stat-old
@item 59=create-anonymous-text-old
285 286
@end itemize

287
@item New and Modified Structures
288
@itemize @bullet
289
@item Aux-Item
290
@item Aux-Item-Input
291 292
@item Conference
@item Info
293 294 295
@item Member
@item Membership
@item Membership-Type
296 297
@item Misc-Info
@item Text-Stat
298 299
@end itemize

300 301 302 303 304 305
@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.

306 307
@item New Asynchronous Messages
@itemize @bullet
308 309 310 311 312
@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
313
@end itemize
314 315 316

@item Notes
@itemize @bullet
317
@item Since protocol version 9 setting a priority of zero for a
318 319 320
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
321
Membership-type extension to the Membership type. In order to maintain
322 323 324 325 326
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
327 328
@end table

329

330
@subsection Protocol version 9 (first implemented in lyskomd 1.9.0)
331 332

@table @asis
333 334 335 336 337 338
@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
339
@item Added Commands
340
@itemize @bullet
341 342 343 344 345 346
@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
347
@end itemize
348 349 350 351 352 353 354
@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
355 356
@item 63=@code{who-is-on-ident} is now considered obsolete.
@item 64=@code{get-session-info-ident} is now considered obsolete.
357
@end itemize
358 359
@end table

360
@subsection Protocol version 8 (first implemented in lyskomd 1.8.0)
David Byers's avatar
David Byers committed
361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395

@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
396
75=get-version-info
David Byers's avatar
David Byers committed
397
@item
398
76=lookup-z-name
David Byers's avatar
David Byers committed
399 400 401 402 403
@end itemize

@item Other
@itemize @bullet
@item
Per Cederqvist's avatar
Per Cederqvist committed
404
The asynchronous message 1=i-am-off has been removed
David Byers's avatar
David Byers committed
405 406 407 408 409 410 411 412 413
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
414
67=lookup-person
David Byers's avatar
David Byers committed
415
@item
416
68=lookup-conf
David Byers's avatar
David Byers committed
417
@item
418
69=set-client-version
David Byers's avatar
David Byers committed
419
@item
420
70=get-client-name
David Byers's avatar
David Byers committed
421
@item
422
71=get-client-version
David Byers's avatar
David Byers committed
423
@item
424
72=mark-text
David Byers's avatar
David Byers committed
425
@item
426
73=unmark-text
David Byers's avatar
David Byers committed
427 428 429 430 431 432 433 434 435 436
@end itemize
@end table


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

@table @asis
@item New Calls
@itemize @bullet
@item
437
65=re-lookup-person
David Byers's avatar
David Byers committed
438
@item
439
66=re-lookup-conf
David Byers's avatar
David Byers committed
440 441 442 443 444 445 446 447 448 449 450
@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
451
63=who-is-on-ident
David Byers's avatar
David Byers committed
452
@item
453
64=get-session-info-ident
David Byers's avatar
David Byers committed
454 455 456 457 458 459 460 461 462
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
463
61=find-previous-text-no
David Byers's avatar
David Byers committed
464
@item
465
60=find-next-text-no
David Byers's avatar
David Byers committed
466
@item
467
59=create-anonymous-text
David Byers's avatar
David Byers committed
468
@item
469
58=get-last-text
David Byers's avatar
David Byers committed
470 471 472 473 474 475 476 477 478
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
479
57=set-user-area
David Byers's avatar
David Byers committed
480 481 482 483 484 485 486 487 488 489 490
@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


491
@node Notation
David Byers's avatar
David Byers committed
492 493
@section Notation

494
This specification uses a BNF-like grammar to describe the protocol and
495
its data elements.
David Byers's avatar
David Byers committed
496

497
Data fields have been given names that start with a lower-case letter.
498 499 500 501 502 503 504 505 506 507 508

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)
509 510 511
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
512 513


514
@node Introduction
David Byers's avatar
David Byers committed
515 516 517 518 519 520
@chapter Introduction

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

@menu
521 522 523 524 525 526 527
* Articles::                    
* Conferences::                 
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
* Client-Server Dialog::        
David Byers's avatar
David Byers committed
528 529 530
@end menu


531
@node Articles
David Byers's avatar
David Byers committed
532 533 534 535
@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
536 537 538 539
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
540

541 542 543 544 545
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
546 547 548

Every article has at least one number, the global article number. Global
numbers are assigned in ascending order to new articles, and are never
549
reused. If an article has recipients it will also have a local number
Per Cederqvist's avatar
Per Cederqvist committed
550
for each recipient. Local numbers are used in some data structures to
551
provide more compact storage and to provide an ordering of articles for
552 553 554
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
555

556
Occasionally it is necessary to map between local and global numbers.
557
The server call @code{local-to-global} does this.
David Byers's avatar
David Byers committed
558 559 560



561
@node Conferences
David Byers's avatar
David Byers committed
562 563
@section Conferences

564 565 566 567
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
568
If the supervisor is a person, the members of that person's mailbox
569 570 571 572 573
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
574 575

Each conference has a type, which is essentially a collection of boolean
Per Cederqvist's avatar
Per Cederqvist committed
576
flags. Currently the flags @code{rd-prot}, @code{letterbox},
577 578
@code{secret}, @code{original},  @code{allow-anonymous} and 
@code{forbid-secret} are defined.
David Byers's avatar
David Byers committed
579 580 581 582 583 584 585

@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
586 587 588 589
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
590
@item letterbox
591
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
592
are sent to the mailbox and the name of the mailbox is synchronized
593 594
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
595 596
@item secret
Conferences of this type are secret. The server will not divulge any
597
information about the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
598
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
599 600
that person cannot log in using the person name, but must specify a
person number instead.
601 602 603
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
604 605 606
@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
607 608 609 610
@end table



611 612 613 614
@menu
* Persons and Sessions::        
@end menu

615
@node Persons and Sessions
David Byers's avatar
David Byers committed
616 617 618
@subsection Persons and Sessions

Persons are represented in the protocol by values of the type
619 620 621 622
@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
623 624

Connections to the server are represented as values of the type
625 626 627 628 629 630
@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
631 632


633
@node The Misc-Info List
David Byers's avatar
David Byers committed
634 635
@section The Misc-Info List

636 637
The @code{Misc-Info} list contains tagged data. The fields are sent in
groups pertaining to a particular type of information: information about
638 639
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
640 641 642
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
643

644
@subsection Recipient
David Byers's avatar
David Byers committed
645 646 647

@table @code
@item recpt
648 649
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
650
@item loc-no
651 652 653
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
654
@item rec-time
655 656 657
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
658
@item sent-by
659 660 661
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
662
@item sent-at
663 664
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
665 666 667
@end table


668
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
669

670 671 672 673
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
674
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
675 676 677

@table @code
@item cc-recpt
678 679
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
680
@item loc-no
681 682 683
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
684
@item rec-time
685
Present after the CC recipient has read the article. It contains the
686 687
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
688 689 690
@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
691
person who added the CC recipient.
David Byers's avatar
David Byers committed
692 693 694 695 696 697
@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


698 699 700 701 702
@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
703
allowed to fetch both the text status of the involved text and the
704
conference status of the involved conference.  (That is, as long as the
705
conference isn't secret everybody is allowed to see the carbon-copy
706 707
recipient group.)

708 709 710 711 712
A BCC recipient group is basically only visible to members and
supervisors of the recipient.  Persons that have the right to become a
member of the recipient can also see it, as can the author of the text
(unless the recipient is secret to him).  This is enforced by the
server.
713 714

This type of group was introduced in protocol version 10.  When
715 716 717
old-style calls such as get-text-stat-old (@pxref{get-text-stat-old})
are used this will be converted to a CC recipient group by the server
for the benefit of clients that don't understand this group.
718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740

@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


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

@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
752
been created. It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
753 754 755
@end table


756
@subsection Footnote To
David Byers's avatar
David Byers committed
757 758

@table @code
759
@item footn-to
David Byers's avatar
David Byers committed
760 761 762
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
763
been created. It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
764 765 766
@end table


767
@subsection Comment in
David Byers's avatar
David Byers committed
768 769 770 771 772 773 774 775

@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


776
@subsection Footnote in
David Byers's avatar
David Byers committed
777 778

@table @code
779
@item footn-in
David Byers's avatar
David Byers committed
780 781 782 783 784
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


785
@node The Aux-Item List
786
@section The Aux-Item List
787 788 789 790 791

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

@menu
792 793 794 795 796
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
797 798
@end menu

799
@node About Aux-Items
800
@subsection About Aux-Items
801 802 803 804

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
805
out a case where setting an aux-item on the mailbox wasn't as good as
806 807 808 809 810 811 812 813 814
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.
815
Items are numbered from one and up within each item list. Once assigned,
816 817 818 819
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.

820
The tag field identifies the type of aux item. It is used by the server
821 822 823 824 825 826 827 828 829 830
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.)



831
@node Predefined Aux-Item Types
832
@subsection Predefined Aux-Item Types
833

David Byers's avatar
David Byers committed
834 835 836
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.
837

David Byers's avatar
David Byers committed
838 839 840
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,
841
flags, who can create them, to what objects they can be attached and
David Byers's avatar
David Byers committed
842 843
so forth. The server may also silently enforce specific values for any
field of an item, regardless of what the client requests.
844

845
All items with tags in the range 1-9999 and 30000 and up are considered
846 847
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
848
return an error (illegal-aux-item.)
849

850 851 852
Some of the aux-items below (mostly the ones that begin with "mx-") are
used by mail importers. For information about supplementary aux-items
introduced by @code{komimportmail}, see @ref{komimportmail Aux-Item Types}.
853 854 855

@table @samp
@item content-type [1] (text)
856
Specifies the content type of a text. Data is a valid MIME type or one
857 858 859 860 861 862 863 864 865 866 867
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
868 869
An item of this type will never be inherited, can always be deleted, is
never anonymous and is never secret.
870 871


872
@item cross-reference [3] (text, conference, letterbox)
David Byers's avatar
David Byers committed
873
Data is a cross-reference to something else. The contents consist of a
874 875
letter, a number, and optionally a space and a descriptive text. The
letter must be one
David Byers's avatar
David Byers committed
876 877 878 879 880
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
881 882
description that reads "Check this out!", and "T17" is a cross reference
without a description.
883

David Byers's avatar
David Byers committed
884 885
The inherit bit is automatically cleared and the item can always be
deleted. 
886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918


@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
919 920 921
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.
922 923

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


927
@item redirect [8] (conference, letterbox)
David Byers's avatar
David Byers committed
928

David Byers's avatar
David Byers committed
929 930 931 932 933 934 935 936 937 938 939
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.
940 941

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

David Byers's avatar
David Byers committed
946

947
@item x-face [9] (conference, letterbox, server)
948 949 950 951

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
952
a mailbox, the person attached to the mailbox. The hide-creator and
953 954 955
secret bits are cleared automatically. 


956
@item alternate-name [10] (text, conference, letterbox)
957 958

Data is a string that the client may use as an alternate to the name of
David Byers's avatar
David Byers committed
959 960 961
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.
962 963 964 965 966 967 968

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
969
equivalent of what "pgp -sba" in PGP 2.6.2 generates.
970 971 972 973 974 975 976 977

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
978 979 980
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.
981 982 983 984

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
985

986 987
@item e-mail-address [13] (conference, letterbox, server)

David Byers's avatar
David Byers committed
988 989
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
990 991 992
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
993 994 995
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.
996 997

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

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

1003 1004 1005 1006

@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
1007 1008
server). Creating an item of this type automatically causes creation of
a faq-for-conf item.
David Byers's avatar
David Byers committed
1009 1010 1011 1012

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

1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024

@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.
1025

1026
@item mx-author [16] (text)
1027

1028
Data is a string containing the name of the author of an imported
1029 1030 1031 1032 1033 1034
e-mail, extracted from the @code{From} header.  This aux-item may be
missing, if the mail address in the @code{From} header consists of just
the @code{addr-spec} (see the next aux-item).

Clients should display this instead of the actual author of the text
(which will be an importer ID) even if an mx-from aux-item is not present.
1035

1036 1037
Sample contents: @code{Joe Q. Public} which may come from a @code{From}
header containing @code{"Joe Q. Public" <john.q.public@@example.com>}.
1038

1039
@item mx-from [17] (text)
1040

1041 1042
Data is the proper e-mail address (called @code{addr-spec} in the mail
standards) extracted from the @code{From} header of an imported
1043 1044 1045 1046 1047 1048
e-mail. 

Clients should display this address together with the mx-author,
preferably inside angles. If mx-author is not present, this address
should be shown anyway. It can also be used by clients to construct an
address for personal (e-mail) replies to an imported message.
1049

1050 1051 1052
Sample contents: @code{john.q.public@@example.com} which may come from a
@code{From} header containing @code{john.q.public@@example.com} or
something like @code{"Joe Q. Public" <john.q.public@@example.com>}.
1053

1054
@item mx-reply-to [18] (text)
1055

1056 1057 1058 1059
Data is the proper e-mail address (called @code{addr-spec} in the mail
standards) extracted from the @code{Reply-To} header of an imported
e-mail. Clients should use this for constructing replies to imported
messages.
1060

1061
@item mx-to [19] (text)
1062

1063 1064 1065 1066
Data is a single e-mail address from an email @code{To} header.
Multiple @code{mx-to} items may be present when multiple recipients are
specified in the header. Clients should display these items along
with the normal LysKOM recipient headers.
1067

1068 1069 1070
Sample contents: @code{john.q.public@@example.com} and
@code{"Joe Q. Public" <john.q.public@@example.com>} are both valid.

1071
@item mx-cc [20] (text)
1072

1073 1074
Same as @code{mx-to}, but applies to the @code{CC} header rather than
the @code{To} header.
1075

1076
@item mx-date [21] (text)
1077

1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091
Data is the date and time from the @code{Date} header of an imported
email. 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.

Clients should display this information as the date and time a text was
written, since the imported text will have been created at a later
time. The date and time when the mesage was imported would then be
displayed elsewhere or not at all.
1092

1093 1094
@item mx-message-id [22] (text)

1095 1096 1097
Data is the @code{Message-ID} header of an imported e-mail, with
whitespace and comments removed. The Message-ID should contain the
surrounding angles.
1098 1099 1100

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

1101 1102 1103
Data is a string containing one item of the same form as the
mx-message-id item described above. This is the Message-ID of
another mail the current text is a comment to.
1104

1105 1106 1107 1108 1109 1110 1111
Hopefully, this information comes from the @code{In-Reply-To} header
of the imported e-mail, but it could also have been picked from the end
of the @code{References} header line.

If the text really comments more than one other text directly, 
it is allowed to attach more than one @code{mx-in-reply-to} items to
it.
1112 1113 1114

@item mx-misc [24] (text)

1115 1116 1117 1118 1119
Data is a string that contains all of the headers of an imported email,
including @code{Subject}, and including those that are redundantly
stored in other aux-items. The headers are concatenated with "\n". In
other words, this item contains all headers of an imported e-mail as
they appear in the message.
1120

1121
Clients are encouraged to provide a command to display this information.
1122

1123
@item mx-allow-filter [25] (conference, letterbox)
1124

1125 1126 1127
This aux-item has been declared obsolete. It was intended to supply
the importer with information on how to filter incoming messages
based on regular expressions matching header lines.
1128

1129
@item mx-reject-forward [26] (conference, letterbox)
1130

1131 1132 1133
This aux-item has been declared obsolete. It was intended 
to supplement mx-allow-filter by telling where rejected mails should
be sent.
1134

David Byers's avatar
David Byers committed
1135 1136 1137 1138 1139 1140 1141 1142 1143 1144
@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.
1145

David Byers's avatar
David Byers committed
1146 1147 1148 1149 1150 1151 1152 1153
@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.

1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174
@item recommended-conf [29] (server)

Data is a decimal number specifying a conference that new members should
automatically be added to, optionally followed by a space and a
recommended priority, optionally followed by a space and a membership
type.  In the future, additional data may be defined; clients should
be prepared to accept and ignore a space and any trailing data that may
follow the membership type.

A few examples might clarify what the data may look like:
@table @code
@item 1
Conference number 1.
@item 2 32
Conference number 2, with priority 32.
@item 3 250 11100000
Conference number 3, with priority 250.  The membership should be
secret, passive and have the invitation bit set.
@item 4 253 01000000 garbage
Conference number 4, with priority 253.  The membership should be
passive.  The client should ignore the trailing garbage.  Note that
1175
clients are not allowed to create aux-items of this format, but the
1176 1177 1178 1179 1180 1181
should be prepared to hande them correctly.
@end table

This is a recommendation only; it is up to the client that creates a new
person to also add him to the conferences that are specified via
@code{recommended-conf}.
1182

1183
@item allowed-content-type [30] (conference, letterbox, server)
1184 1185 1186 1187

Data is a non-negative decimal priority number, followed by a space,
followed by a LysKOM content type glob pattern.  Clients should send
texts to a conference only if the content-type matches any of the
Per Cederqvist's avatar