Protocol-A.texi 287 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.110 2001/04/18 08:22:11 ceder Exp $
David Byers's avatar
David Byers committed
6 7 8 9
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
10
@c @afourpaper
David Byers's avatar
David Byers committed
11
@c %**end of header
12 13 14 15

@set PROTOEDITION 10.4
@set PROTOVER 10
@set VERSION 1.0.4
David Byers's avatar
David Byers committed
16

17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
@c @req{login} is used for protocol requests.
@macro req {n}
@code{\n\}
@end macro

@c @aux{mx-allow-filter} is used for aux-item names.
@macro aux {n}
@code{\n\}
@end macro

@c @async{async-login} is used for async names.
@macro async {n}
@code{\n\}
@end macro

@c @type{Conference} is used for LysKOM types.
@macro type {n}
@code{\n\}
@end macro

@c @priv{wheel} is used for privilege bits.
@macro priv {n}
@code{\n\}
@end macro

@c @conftype{rd-prot} is used for conference type bits.
@macro conftype {n}
@code{\n\}
@end macro

@c @misc{bcc-recpt} is used for misc-info names.
@macro misc {n}
@code{\n\}
@end macro

@c @rarg{passwd} is used to reference arguments of requests.  This is
@c *only* used in the nodes that defines the requests.
@macro rarg {n}
@code{\n\}
@end macro

@c @aarg{text-no} is used to reference arguments of asynchronous
@c messages.  This is *only* used in the nodes that defines the
@c relevant asynchronous message.
@macro aarg {n}
@code{\n\}
@end macro

@c @errorcode{no-such-text} is used to mark error codes.
@macro errorcode {n}
@code{\n\}
@end macro

@c @field{ident-user} is used to mark fields of struct types.
@macro field {n}
@code{\n\}
@end macro

David Byers's avatar
David Byers committed
75
@ifinfo
76 77 78
This is the LysKOM Protocol A specification, edition
@value{PROTOEDITION}.  It specifies version @value{PROTOVER} of the
protocol.  It corresponds to version @value{VERSION} of lyskomd.
David Byers's avatar
David Byers committed
79

Per Cederqvist's avatar
Per Cederqvist committed
80
Copyright @copyright{} 1995-2000 Lysator ACS.
David Byers's avatar
David Byers committed
81 82 83 84

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.
85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100

@ignore
Permission is granted to process this file through TeX
and print the results, provided the printed document
carries a copying permission notice identical to this
one except for the removal of this paragraph (this
paragraph not being relevant to the printed manual).
@end ignore

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.
David Byers's avatar
David Byers committed
101 102
@end ifinfo

103 104 105 106 107 108 109 110 111 112
@c FIXME: What does this do?
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
@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
@end iftex
113

David Byers's avatar
David Byers committed
114 115
@titlepage
@title{LysKOM Protocol A}
116 117 118
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
119 120 121 122
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
Per Cederqvist's avatar
Per Cederqvist committed
123
Copyright @copyright{} 1995-2000 Lysator ACS
David Byers's avatar
David Byers committed
124 125 126 127 128 129 130 131 132 133 134 135 136 137

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
138 139 140
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
141

142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159
@dircategory LysKOM
@direntry
* Protocol A: (protocol-a).             The LysKOM Protocol A specification.
@end direntry

@ifhtml
@html
<a href="http://www.lysator.liu.se/" ><img
src="http://www.lysator.liu.se/icons/lyslogo.gif" alt="Lysator"
width=40 border=0 height=40 align=left ></a>

<a href="http://www.lysator.liu.se/lyskom/" ><img
src="http://www.lysator.liu.se/icons/lyskom.gif" alt="LysKOM" width=40
border=0 height=40 align=left ></a>
<br clear=all>
@end html
@end ifhtml
@ifnottex
160
@node Top
161
@top LysKOM Protocol A
162

163 164 165 166 167 168 169
This document specifies version @value{PROTOVER} of LysKOM Protocol A.
This is edition @value{PROTOEDITION} of the specification.  It
corresponds to version @value{VERSION} of lyskomd.

The most up-to-date version if this document can always be found at 
@uref{http://www.lysator.liu.se/lyskom/protocol/}.
@end ifnottex
David Byers's avatar
David Byers committed
170 171

@menu
172 173 174 175 176 177 178 179 180 181 182 183
* 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
184 185
@end menu

186
@node Overview
David Byers's avatar
David Byers committed
187 188
@chapter Overview

189 190 191 192 193
@iftex
This document specifies version @value{PROTOVER} of LysKOM Protocol A.
This is edition @value{PROTOEDITION} of the specification.  It
corresponds to version @value{VERSION} of lyskomd.

194 195
The most up-to-date version if this document can always be found on
the web at @uref{http://www.lysator.liu.se/lyskom/protocol/}.
196 197
@end iftex

David Byers's avatar
David Byers committed
198
LysKOM is a conferencing system@footnote{Or in modern terms, enabling
199 200 201 202 203 204
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
205

206 207
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
208 209

This specification is the work of several people. The main contributors have
210
been
David Byers's avatar
David Byers committed
211 212
Per Cederqvist @email{ceder@@lysator.liu.se}, 
David Byers @email{byers@@lysator.liu.se},
David Byers's avatar
David Byers committed
213 214 215 216 217 218
@ifinfo
Pär
@end ifinfo
@iftex
P@"ar
@end iftex
David Byers's avatar
David Byers committed
219 220 221 222
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
223 224 225 226 227 228
@ifinfo
Kent Engström
@end ifinfo
@iftex
Kent Eng@-str@"om@penalty-10000
@end iftex
David Byers's avatar
David Byers committed
229
@email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
230

David Byers's avatar
David Byers committed
231 232
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
233

234
@menu
235
* Document Edition History::   
236 237
* Protocol Version History::    
* Notation::                    
David Byers's avatar
David Byers committed
238 239
@end menu

240 241
@node Document Edition History
@section Document Edition History
David Byers's avatar
David Byers committed
242 243

@table @asis
244

245
@item 10.4: 2001-04-07
246
Editorial changes needed to publish an online version on the web at
247 248
@uref{http://www.lysator.liu.se/lyskom/protocol/}.

Per Cederqvist's avatar
Per Cederqvist committed
249 250
@item 10.3: 2000-09-09
Several aux-items can be set on letterboxes and not only conferences.  A
251 252 253
few can now be set on the server.  The @aux{allowed-content-type} and
@aux{recommended-conf} aux-items were added.  The
@aux{mx-allow-filter} and @aux{mx-reject-forward} aux-items are marked
Per Cederqvist's avatar
Per Cederqvist committed
254 255 256
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.
257
Distributed with lyskomd 2.0.4.
Per Cederqvist's avatar
Per Cederqvist committed
258

Per Cederqvist's avatar
Per Cederqvist committed
259 260 261 262
@item 10.2: 1999-07-23
Some typos and other minor errors were fixed.  Distributed with lyskomd
2.0.2.

263
@item 10.1: 1999-07-12
264
Call @req{sub-comment} was incorrectly marked obsolete. This has been
265 266 267 268 269
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
270

271
@item 10.0: 1999-06-27
272 273
The specification was translated to English and converted to Texinfo by
David Byers.  Protocol version 10.  Distributed with lyskomd 2.0.0.
274
Note: this edition incorrectly marked the @req{sub-comment} call as
275 276
obsolete, and stated that regexp lookup was case insensitive.  Both
statements were wrong, and has since been fixed.
277 278

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

David Byers's avatar
David Byers committed
281
@item 8.0: 1995-11-10
282
Protocol version 8.  Distributed with lyskomd 1.8.0.
David Byers's avatar
David Byers committed
283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306

@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

307
@node Protocol Version History
308 309 310
@section Protocol Version History

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

312
@table @asis
313 314 315 316 317 318

@item Error codes

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

319
@item New Server Calls
320 321 322

These new calls have status Recommended.

323 324 325 326 327 328 329 330 331 332 333 334 335
@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
336 337 338 339
@item 98=query-read-texts
@item 99=get-membership
@item 100=add-member
@item 101=get-members
340 341 342
@item 102=set-membership-type
@item 103=local-to-global
@item 104=map-created-texts
343 344 345 346 347 348 349
@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
350
@item 105=set-keep-commented
351 352
@end itemize

353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374
@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.

375
@itemize @bullet
376 377 378 379 380
@item 58=get-last-text
@item 77=set-last-read
@item 78=get-uconf-stat
@end itemize

381
The following calls have changed status from Recommended or
382 383 384 385 386 387 388 389 390
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
391
@item 36=get-info-old
392
@item 46=get-membership-old
393
@item 47=get-created-texts
394
@item 48=get-members-old
395 396
@item 50=get-conf-stat-old
@item 59=create-anonymous-text-old
397 398
@end itemize

399
@item New and Modified Structures
400
@itemize @bullet
401
@item Aux-Item
402
@item Aux-Item-Input
403 404
@item Conference
@item Info
405 406 407
@item Member
@item Membership
@item Membership-Type
408 409
@item Misc-Info
@item Text-Stat
410 411
@end itemize

412 413 414 415 416 417
@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.

418 419
@item New Asynchronous Messages
@itemize @bullet
420 421 422 423 424
@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
425
@end itemize
426 427 428

@item Notes
@itemize @bullet
429
@item Since protocol version 9 setting a priority of zero for a
430 431 432
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
433
Membership-type extension to the Membership type. In order to maintain
434 435 436 437 438
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
439 440
@end table

441

442
@subsection Protocol version 9 (first implemented in lyskomd 1.9.0)
443 444

@table @asis
445 446
@item New functionality
@itemize @bullet
447
@item The server shall now reply with error @errorcode{not-implemented} when
448 449 450
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
451
@item Added Commands
452
@itemize @bullet
453 454 455 456 457 458
@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
459
@end itemize
460 461
@item Changed names
@itemize @bullet
462
@item @req{change-conference} was previously called @code{pepsi}.  The
463 464 465 466
name was changed, but not the functionality.
@end itemize
@item Status change
@itemize @bullet
467 468
@item 63=@req{who-is-on-ident} is now considered obsolete.
@item 64=@req{get-session-info-ident} is now considered obsolete.
469
@end itemize
470 471
@end table

472
@subsection Protocol version 8 (first implemented in lyskomd 1.8.0)
David Byers's avatar
David Byers committed
473

474
@table @asis
David Byers's avatar
David Byers committed
475 476 477
@item Added Functionality
@itemize @bullet
@item
478
30=add-recipient: Can change @misc{recpt} to @misc{cc-recpt} and vice versa.
David Byers's avatar
David Byers committed
479
@item
480
21=set-conf-type: Accepts @type{Conf-Type} and @type{Extended-Conf-Type}.
David Byers's avatar
David Byers committed
481
@item
482
10=create-conf: Accepts @type{Conf-Type} and @type{Extended-Conf-Type}.
David Byers's avatar
David Byers committed
483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507
@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
508
75=get-version-info
David Byers's avatar
David Byers committed
509
@item
510
76=lookup-z-name
David Byers's avatar
David Byers committed
511 512 513 514 515
@end itemize

@item Other
@itemize @bullet
@item
Per Cederqvist's avatar
Per Cederqvist committed
516
The asynchronous message 1=i-am-off has been removed
David Byers's avatar
David Byers committed
517 518 519 520 521 522 523 524 525
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
526
67=lookup-person
David Byers's avatar
David Byers committed
527
@item
528
68=lookup-conf
David Byers's avatar
David Byers committed
529
@item
530
69=set-client-version
David Byers's avatar
David Byers committed
531
@item
532
70=get-client-name
David Byers's avatar
David Byers committed
533
@item
534
71=get-client-version
David Byers's avatar
David Byers committed
535
@item
536
72=mark-text
David Byers's avatar
David Byers committed
537
@item
538
73=unmark-text
David Byers's avatar
David Byers committed
539 540 541 542 543 544 545 546 547 548
@end itemize
@end table


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

@table @asis
@item New Calls
@itemize @bullet
@item
549
65=re-lookup-person
David Byers's avatar
David Byers committed
550
@item
551
66=re-lookup-conf
David Byers's avatar
David Byers committed
552 553 554 555 556 557 558 559 560 561 562
@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
563
63=who-is-on-ident
David Byers's avatar
David Byers committed
564
@item
565
64=get-session-info-ident
David Byers's avatar
David Byers committed
566 567 568 569 570 571 572 573 574
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
575
61=find-previous-text-no
David Byers's avatar
David Byers committed
576
@item
577
60=find-next-text-no
David Byers's avatar
David Byers committed
578
@item
579
59=create-anonymous-text
David Byers's avatar
David Byers committed
580
@item
581
58=get-last-text
David Byers's avatar
David Byers committed
582 583 584 585 586 587 588 589 590
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
591
57=set-user-area
David Byers's avatar
David Byers committed
592 593 594 595 596 597 598 599 600 601 602
@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


603
@node Notation
David Byers's avatar
David Byers committed
604 605
@section Notation

606
This specification uses a BNF-like grammar to describe the protocol and
607
its data elements.
David Byers's avatar
David Byers committed
608

609
Data fields have been given names that start with a lower-case letter.
610

611 612
Fundamental data types have names in all-caps (such as @type{INT32} and
@type{ARRAY}).
613 614 615

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
616
letter, like this: @type{Text-Stat}.)  The operator @code{::=} defines
617 618 619 620
the name to its left.

Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
621 622 623
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
624 625


626
@node Introduction
David Byers's avatar
David Byers committed
627 628 629 630 631 632
@chapter Introduction

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

@menu
633 634 635 636 637 638 639
* Articles::                    
* Conferences::                 
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
* Client-Server Dialog::        
David Byers's avatar
David Byers committed
640 641 642
@end menu


643
@node Articles
David Byers's avatar
David Byers committed
644 645
@section Articles

646
An article is represented as a value of the type @type{Text-Stat} and a
David Byers's avatar
David Byers committed
647
string containing the article contents. An article will usually have one
648 649
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
650
@field{nice} value of each of its recipients and it is not marked by any
651
user.
David Byers's avatar
David Byers committed
652

653 654 655 656 657
Currently there is an array of @type{Misc-Info} included in the
@type{Text-Stat}. This array contains information about recipients,
senders, comments and footnotes. In the future the information
contained in the @type{Misc-Info} array will be integrated into the
@type{Text-Stat}.
David Byers's avatar
David Byers committed
658 659 660

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

668
Occasionally it is necessary to map between local and global numbers.
669
The server call @req{local-to-global} does this.
David Byers's avatar
David Byers committed
670 671 672



673
@node Conferences
David Byers's avatar
David Byers committed
674 675
@section Conferences

676
Conferences hold articles. They are represented in the protocol as a
677 678 679
data type called @type{Conference}. Each conference has a
@dfn{creator}, the person who created the conference, and a
@dfn{supervisor}, a conference whose members can modify the conference.
David Byers's avatar
David Byers committed
680
If the supervisor is a person, the members of that person's mailbox
681
are supervisors, which in most cases is only that person. We have also
682
introduced a type called @type{UConference} (pronounced micro-conf-stat)
683
which holds a subset of the information contained in the full
684
@type{Conference} type. Use the @type{UConference} type whenever
685
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
686

687 688 689 690
Each conference has a type, which is essentially a collection of
boolean flags. Currently the flags @conftype{rd-prot},
@conftype{letterbox}, @conftype{secret}, @conftype{original},
@conftype{allow-anonymous} and @conftype{forbid-secret} are defined.
David Byers's avatar
David Byers committed
691

692
@table @conftype
David Byers's avatar
David Byers committed
693 694 695 696 697
@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
698 699 700 701
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
702
@item letterbox
703
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
704
are sent to the mailbox and the name of the mailbox is synchronized
705 706
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
707 708
@item secret
Conferences of this type are secret. The server will not divulge any
709
information about the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
710
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
711 712
that person cannot log in using the person name, but must specify a
person number instead.
713 714 715
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
716 717 718
@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
719 720 721 722
@end table



723 724 725 726
@menu
* Persons and Sessions::        
@end menu

727
@node Persons and Sessions
David Byers's avatar
David Byers committed
728 729 730
@subsection Persons and Sessions

Persons are represented in the protocol by values of the type
731
@type{Person}. Associated with persons are statistics, a set of personal
732 733
flags and a set of privileges (@pxref{Security}.) Persons are also
associated with a conference that has the same number as the person and
734
the @conftype{letterbox} bit set.
David Byers's avatar
David Byers committed
735 736

Connections to the server are represented as values of the type
737 738
@type{Static-Session-Info}, @type{Session-Info-Ident} or
@type{Session-Info}. Sessions have session number that are unique for
739 740 741 742
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
743 744


745
@node The Misc-Info List
David Byers's avatar
David Byers committed
746 747
@section The Misc-Info List

748
The @type{Misc-Info} list contains tagged data. The fields are sent in
749
groups pertaining to a particular type of information: information about
750 751
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
752 753 754
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
755

756
@subsection Recipient
David Byers's avatar
David Byers committed
757

758
@table @misc
David Byers's avatar
David Byers committed
759
@item recpt
760 761
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
762
@item loc-no
763 764
Always present within a recipient group. It contains the local text
number of the article in the conference specified by the preceding
765
@misc{recpt} field.
David Byers's avatar
David Byers committed
766
@item rec-time
767 768 769
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
770
@item sent-by
771 772 773
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
774
@item sent-at
775 776
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
777 778 779
@end table


780
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
781

782 783 784 785
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
786
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
787

788
@table @misc
David Byers's avatar
David Byers committed
789
@item cc-recpt
790 791
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
792
@item loc-no
793 794
Always present in a CC recipient group. It contains the local text
number of the article in the conference specified by the most recent
795
@misc{cc-recpt} field.
David Byers's avatar
David Byers committed
796
@item rec-time
797
Present after the CC recipient has read the article. It contains the
798 799
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
800 801 802
@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
803
person who added the CC recipient.
David Byers's avatar
David Byers committed
804 805 806 807 808 809
@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


810 811 812 813 814
@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
815
allowed to fetch both the text status of the involved text and the
816
conference status of the involved conference.  (That is, as long as the
817
conference isn't secret everybody is allowed to see the carbon-copy
818 819
recipient group.)

820 821 822 823 824
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.
825 826

This type of group was introduced in protocol version 10.  When
827 828 829
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.
830

831
@table @misc
832 833 834 835 836 837
@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
838
@misc{bcc-recpt} field.
839 840 841 842 843 844 845 846 847 848 849 850 851 852
@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


853
@subsection Comment To
David Byers's avatar
David Byers committed
854

855
@table @misc
David Byers's avatar
David Byers committed
856 857 858 859 860 861 862 863
@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
864
been created. It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
865 866 867
@end table


868
@subsection Footnote To
David Byers's avatar
David Byers committed
869

870
@table @misc
871
@item footn-to
David Byers's avatar
David Byers committed
872 873 874
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
875
been created. It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
876 877 878
@end table


879
@subsection Comment in
David Byers's avatar
David Byers committed
880

881
@table @misc
David Byers's avatar
David Byers committed
882 883 884 885 886 887
@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


888
@subsection Footnote in
David Byers's avatar
David Byers committed
889

890
@table @misc
891
@item footn-in
David Byers's avatar
David Byers committed
892 893 894 895 896
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


897
@node The Aux-Item List
898
@section The Aux-Item List
899 900 901 902 903

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

@menu
904 905 906 907 908
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
909 910
@end menu

911
@node About Aux-Items
912
@subsection About Aux-Items
913 914 915 916

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
917
out a case where setting an aux-item on the mailbox wasn't as good as
918 919 920 921 922 923 924 925 926
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.
927
Items are numbered from one and up within each item list. Once assigned,
928 929 930 931
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.

932
The tag field identifies the type of aux item. It is used by the server
933 934 935 936 937 938 939 940 941 942
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.)



943
@node Predefined Aux-Item Types
944
@subsection Predefined Aux-Item Types
945

David Byers's avatar
David Byers committed
946 947 948
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.
949

David Byers's avatar
David Byers committed
950 951 952
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,
953
flags, who can create them, to what objects they can be attached and
David Byers's avatar
David Byers committed
954 955
so forth. The server may also silently enforce specific values for any
field of an item, regardless of what the client requests.
956

957
All items with tags in the range 1-9999 and 30000 and up are considered
958 959
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
960
return an error (illegal-aux-item.)
961

962 963
Some of the aux-items below (mostly the ones that begin with "mx-") are
used by mail importers. For information about supplementary aux-items
964
introduced by @command{komimportmail}, see @ref{komimportmail Aux-Item Types}.
965 966 967

@table @samp
@item content-type [1] (text)
968
Specifies the content type of a text. Data is a valid MIME type or one
969 970 971 972 973 974 975 976 977 978 979
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
980 981
An item of this type will never be inherited, can always be deleted, is
never anonymous and is never secret.
982 983


984
@item cross-reference [3] (text, conference, letterbox)
David Byers's avatar
David Byers committed
985
Data is a cross-reference to something else. The contents consist of a
986 987
letter, a number, and optionally a space and a descriptive text. The
letter must be one
David Byers's avatar
David Byers committed
988 989 990 991 992
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
993 994
description that reads "Check this out!", and "T17" is a cross reference
without a description.
995

David Byers's avatar
David Byers committed
996 997
The inherit bit is automatically cleared and the item can always be
deleted. 
998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030


@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
1031 1032 1033
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.
1034 1035

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


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

David Byers's avatar
David Byers committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051
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.
1052 1053

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

David Byers's avatar
David Byers committed
1058

1059
@item x-face [9] (conference, letterbox, server)
1060 1061 1062 1063

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
1064
a mailbox, the person attached to the mailbox. The hide-creator and
1065 1066 1067
secret bits are cleared automatically. 


1068
@item alternate-name [10] (text, conference, letterbox)
1069 1070

Data is a string that the client may use as an alternate to the name of
David Byers's avatar
David Byers committed
1071 1072 1073
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.
1074 1075 1076 1077 1078 1079 1080

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
1081
equivalent of what "pgp -sba" in PGP 2.6.2 generates.
1082 1083 1084 1085 1086 1087 1088 1089

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
1090 1091 1092
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.
1093 1094 1095 1096

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
1097

1098 1099
@item e-mail-address [13] (conference, letterbox, server)

David Byers's avatar
David Byers committed
1100 1101
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
1102 1103 1104
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
1105 1106 1107
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.
1108 1109

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

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

1115 1116 1117 1118

@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
1119 1120
server). Creating an item of this type automatically causes creation of
a faq-for-conf item.
David Byers's avatar
David Byers committed
1121 1122 1123 1124

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

1125 1126 1127 1128 1129 1130 1131 1132 1133 1134

@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
1135
in the @req{set-client-version} call.  The server may enforce this
1136
restriction.
1137

1138
@item mx-author [16] (text)