Protocol-A.texi 295 KB
Newer Older
David Byers's avatar
David Byers committed
1
\input texinfo                         @c -*-texinfo-*-
David Byers's avatar
David Byers committed
2 3
@c
@c FIXME: Explain how the garb works with nice and keep-commented
Per Cederqvist's avatar
Per Cederqvist committed
4
@c FIXME: Make all types clickable in HTML (and info?)
5 6 7 8
@c FIXME: Move history to appendices
@c FIXME: Move predefined aux-items to separate chapter
@c FIXME: Move misc-infos to chapter?
@c FIXME: Check for too much text before @menu.
9
@c FIXME: error-reply defined twice (conflicting).
David Byers's avatar
David Byers committed
10
@c
11
@c $Id: Protocol-A.texi,v 1.126 2001/05/01 11:47:28 ceder Exp $
David Byers's avatar
David Byers committed
12 13 14 15
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
16 17 18 19 20
@c @afourpaper

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

22 23 24


@c
25
@c Define a few strings that contains characters from ISO Latin-1.
26
@c
27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44

@iftex

@set IAM Inl@"a{}gg @}t mig
@set Pell P@"ar Emanuelsson
@set Kent Kent Eng@-str@"om@penalty-10000
@set presconf 27HPresentation (av nya) m@"oten

@end iftex
@ifnottex

@set IAM Inlägg @}t mig
@set Pell Pär Emanuelsson
@set Kent Kent Engström
@set presconf 27HPresentation (av nya) möten

@end ifnottex

45 46 47 48 49 50


@c
@c Index setup
@c

51 52 53 54 55 56 57
@c Index for asynchronous messages.
@defcodeindex am

@c Merge all indices.
@syncodeindex am fn
@syncodeindex tp fn

58 59 60 61 62 63


@c
@c Special markup for Protocol-A.texi
@c

64
@c @req{login} is used for protocol requests.
65

66 67 68 69
@macro req {n}
@code{\n\}
@end macro

70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112
@c @reqlink{login} is used for protocol requests, that shuld be linked.

@ifhtml
@macro reqlink {n}
@code{@ref{\n\}}
@end macro
@end ifhtml

@ifnothtml
@macro reqlink {n}
@code{\n\} (@pxref{\n\})
@end macro
@end ifnothtml

@c @reqdlink{login}...@linkhere{} is used for protocol requests, that
@c shuld be linked, where the link should occur a few words after the
@c request itself.

@ifhtml

@c HTML version: make the word a link.
@macro reqdlink {n}
@code{@ref{\n\}}@c
@unmacro linkhere
@macro linkhere
@end macro
@end macro

@end ifhtml

@ifnothtml
@ifnottex

@c Info version: create linkhere as a macro that contains a reference.

@macro reqdlink {n}
@code{\n\}@c
@unmacro linkhere
@macro linkhere
(@pxref{\n\})
@end macro
@end macro
@end ifnottex
113

114 115
@iftex

116
@c TeX version: this produces output similar to the Info version.
117

118 119 120 121 122 123
@tex
    \gdef\reqdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
124 125 126
@end iftex
@end ifnothtml

127 128 129 130 131 132 133 134 135 136
@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

137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193
@c @asynclink{async-login} is used for async names, that shuld be linked.

@ifhtml
@macro asynclink {n}
@code{@ref{\n\}}
@end macro
@end ifhtml

@ifnothtml
@macro asynclink {n}
@code{\n\} (@pxref{\n\})
@end macro
@end ifnothtml

@c @asyncdlink{async-login}...@linkhere{} is used for async messages,
@c that shuld be linked, where the link should occur a few words after
@c the async name itself.

@ifhtml

@c HTML version: make the word a link.
@macro asyncdlink {n}
@code{@ref{\n\}}@c
@unmacro linkhere
@macro linkhere
@end macro
@end macro

@end ifhtml

@ifnothtml
@ifnottex

@c Info version: create linkhere as a macro that contains a reference.

@macro asyncdlink {n}
@code{\n\}@c
@unmacro linkhere
@macro linkhere
(@pxref{\n\})
@end macro
@end macro
@end ifnottex

@iftex

@c TeX version: this produces output similar to the Info version.

@tex
    \gdef\asyncdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
@end iftex
@end ifnothtml

194 195 196 197 198
@c @type{Conference} is used for LysKOM types.
@macro type {n}
@code{\n\}
@end macro

199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
@c @lt{Conference} is used for linked types.  The link is only present
@c when it is unobtrusive.  It should only be used inside
@c @example...@end example.

@ifhtml
@macro lt {n}
@ref{\n\}@c
@end macro
@end ifhtml

@ifnothtml
@macro lt {n}
\n\@c
@end macro
@end ifnothtml

215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252
@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

253 254 255 256 257 258 259
@c @reqexample is used immediately before Protocol-A example
@c fragments.
@macro reqexample
@need 2000
@i{Example:}
@end macro

260 261
@c %**end of header

David Byers's avatar
David Byers committed
262
@ifinfo
263 264 265
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
266

Per Cederqvist's avatar
Per Cederqvist committed
267
Copyright @copyright{} 1995-2000 Lysator ACS.
David Byers's avatar
David Byers committed
268 269 270 271

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.
272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287

@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
288 289
@end ifinfo

290 291 292 293
@c FIXME: What does this do?
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
294
@tex
295 296 297 298 299
\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
300

David Byers's avatar
David Byers committed
301 302
@titlepage
@title{LysKOM Protocol A}
303 304 305
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
306 307 308 309
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
Per Cederqvist's avatar
Per Cederqvist committed
310
Copyright @copyright{} 1995-2000 Lysator ACS
David Byers's avatar
David Byers committed
311 312 313 314 315 316 317 318 319 320 321 322 323 324

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
325 326 327
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
328

329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
@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
347
@node Top
348
@top LysKOM Protocol A
349

350 351 352 353 354 355 356
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
357 358

@menu
359 360 361 362 363 364 365 366 367 368
* Overview::                    
* Introduction::                
* Data Types::                  
* Protocol Requests::           
* Asynchronous Messages::       
* Error Codes::                 
* LysKOM Content Types::        
* The User Area::               
* Writing Clients::             
* Importing and Exporting E-Mail::  
369
* Index::                       
David Byers's avatar
David Byers committed
370 371
@end menu

372
@node Overview
David Byers's avatar
David Byers committed
373 374
@chapter Overview

375 376 377 378 379
@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.

380 381
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/}.
382 383
@end iftex

David Byers's avatar
David Byers committed
384
LysKOM is a conferencing system@footnote{Or in modern terms, enabling
385 386 387 388 389 390
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
391

392 393
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
394 395

This specification is the work of several people. The main contributors have
396
been
David Byers's avatar
David Byers committed
397 398
Per Cederqvist @email{ceder@@lysator.liu.se}, 
David Byers @email{byers@@lysator.liu.se},
399
@value{Pell} @email{pell@@lysator.liu.se},
David Byers's avatar
David Byers committed
400 401 402
Thomas Bellman @email{bellman@@lysator.liu.se}, 
Lars Aronsson @email{aronsson@@lysator.liu.se},
Linus Tolke @email{linus@@lysator.liu.se} and
403
@value{Kent} @email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
404

David Byers's avatar
David Byers committed
405 406
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
407

408
@menu
409
* Document Edition History::    
410 411
* Protocol Version History::    
* Notation::                    
David Byers's avatar
David Byers committed
412 413
@end menu

414 415
@node Document Edition History
@section Document Edition History
David Byers's avatar
David Byers committed
416 417

@table @asis
418

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

Per Cederqvist's avatar
Per Cederqvist committed
423 424
@item 10.3: 2000-09-09
Several aux-items can be set on letterboxes and not only conferences.  A
425 426 427
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
428 429 430
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.
431
Distributed with lyskomd 2.0.4.
Per Cederqvist's avatar
Per Cederqvist committed
432

Per Cederqvist's avatar
Per Cederqvist committed
433 434 435 436
@item 10.2: 1999-07-23
Some typos and other minor errors were fixed.  Distributed with lyskomd
2.0.2.

437
@item 10.1: 1999-07-12
438
Call @req{sub-comment} was incorrectly marked obsolete. This has been
439 440
corrected. Regexps are case sensitive.  The Info-Type enumeration was
introduced in the description of the protocol.  (Previous versions of
441 442 443
the protocol had broken definitions of @req{add-recipient},
@async{async-new-recipient} and @async{async-sub-recipient}.)  Distributed
with lyskomd 2.0.1.
David Byers's avatar
Server:  
David Byers committed
444

445
@item 10.0: 1999-06-27
446 447
The specification was translated to English and converted to Texinfo by
David Byers.  Protocol version 10.  Distributed with lyskomd 2.0.0.
448
Note: this edition incorrectly marked the @req{sub-comment} call as
449 450
obsolete, and stated that regexp lookup was case insensitive.  Both
statements were wrong, and has since been fixed.
451 452

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

David Byers's avatar
David Byers committed
455
@item 8.0: 1995-11-10
456
Protocol version 8.  Distributed with lyskomd 1.8.0.
David Byers's avatar
David Byers committed
457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480

@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

481
@node Protocol Version History
482 483 484
@section Protocol Version History

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

486
@table @asis
487 488 489 490 491 492

@item Error codes

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

493
@item New Server Calls
494 495 496

These new calls have status Recommended.

497 498 499 500 501 502 503 504 505 506 507 508 509
@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
510 511 512 513
@item 98=query-read-texts
@item 99=get-membership
@item 100=add-member
@item 101=get-members
514 515 516
@item 102=set-membership-type
@item 103=local-to-global
@item 104=map-created-texts
517 518 519 520 521 522 523
@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
524
@item 105=set-keep-commented
525 526
@end itemize

527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548
@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.

549
@itemize @bullet
550 551 552 553 554
@item 58=get-last-text
@item 77=set-last-read
@item 78=get-uconf-stat
@end itemize

555
The following calls have changed status from Recommended or
556 557 558 559 560 561 562 563 564
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
565
@item 36=get-info-old
566
@item 46=get-membership-old
567
@item 47=get-created-texts
568
@item 48=get-members-old
569 570
@item 50=get-conf-stat-old
@item 59=create-anonymous-text-old
571 572
@end itemize

573
@item New and Modified Structures
574
@itemize @bullet
575
@item Aux-Item
576
@item Aux-Item-Input
577 578
@item Conference
@item Info
579 580 581
@item Member
@item Membership
@item Membership-Type
582 583
@item Misc-Info
@item Text-Stat
584 585
@end itemize

586 587 588 589 590 591
@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.

592 593
@item New Asynchronous Messages
@itemize @bullet
594 595 596 597 598
@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
599
@end itemize
600 601 602

@item Notes
@itemize @bullet
603
@item Since protocol version 9 setting a priority of zero for a
604 605 606
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
607
Membership-type extension to the Membership type. In order to maintain
608
compatibility with clients that interpret priority 0 as passive
609 610
membership, the old calls @reqlink{add-member-old} and
@reqlink{get-membership-old} perform magic, translating between priorities 
611 612
and membership types. The magic is documented with each call.
@end itemize
613 614
@end table

615

616
@subsection Protocol version 9 (first implemented in lyskomd 1.9.0)
617 618

@table @asis
619 620
@item New functionality
@itemize @bullet
621
@item The server shall now reply with error @errorcode{not-implemented} when
622 623 624
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
625
@item Added Commands
626
@itemize @bullet
627 628 629 630 631 632
@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
633
@end itemize
634 635
@item Changed names
@itemize @bullet
636
@item @req{change-conference} was previously called @code{pepsi}.  The
637 638 639 640
name was changed, but not the functionality.
@end itemize
@item Status change
@itemize @bullet
641 642
@item 63=@req{who-is-on-ident} is now considered obsolete.
@item 64=@req{get-session-info-ident} is now considered obsolete.
643
@end itemize
644 645
@end table

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

648
@table @asis
David Byers's avatar
David Byers committed
649 650 651
@item Added Functionality
@itemize @bullet
@item
652
30=add-recipient: Can change @misc{recpt} to @misc{cc-recpt} and vice versa.
David Byers's avatar
David Byers committed
653
@item
654
21=set-conf-type: Accepts @type{Conf-Type} and @type{Extended-Conf-Type}.
David Byers's avatar
David Byers committed
655
@item
656
10=create-conf: Accepts @type{Conf-Type} and @type{Extended-Conf-Type}.
David Byers's avatar
David Byers committed
657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681
@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
682
75=get-version-info
David Byers's avatar
David Byers committed
683
@item
684
76=lookup-z-name
David Byers's avatar
David Byers committed
685 686 687 688 689
@end itemize

@item Other
@itemize @bullet
@item
Per Cederqvist's avatar
Per Cederqvist committed
690
The asynchronous message 1=i-am-off has been removed
David Byers's avatar
David Byers committed
691 692 693 694 695 696 697 698 699
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
700
67=lookup-person
David Byers's avatar
David Byers committed
701
@item
702
68=lookup-conf
David Byers's avatar
David Byers committed
703
@item
704
69=set-client-version
David Byers's avatar
David Byers committed
705
@item
706
70=get-client-name
David Byers's avatar
David Byers committed
707
@item
708
71=get-client-version
David Byers's avatar
David Byers committed
709
@item
710
72=mark-text
David Byers's avatar
David Byers committed
711
@item
712
73=unmark-text
David Byers's avatar
David Byers committed
713 714 715 716 717 718 719 720 721 722
@end itemize
@end table


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

@table @asis
@item New Calls
@itemize @bullet
@item
723
65=re-lookup-person
David Byers's avatar
David Byers committed
724
@item
725
66=re-lookup-conf
David Byers's avatar
David Byers committed
726 727 728 729 730 731 732 733 734 735 736
@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
737
63=who-is-on-ident
David Byers's avatar
David Byers committed
738
@item
739
64=get-session-info-ident
David Byers's avatar
David Byers committed
740 741 742 743 744 745 746 747 748
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
749
61=find-previous-text-no
David Byers's avatar
David Byers committed
750
@item
751
60=find-next-text-no
David Byers's avatar
David Byers committed
752
@item
753
59=create-anonymous-text
David Byers's avatar
David Byers committed
754
@item
755
58=get-last-text
David Byers's avatar
David Byers committed
756 757 758 759 760 761 762 763 764
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
765
57=set-user-area
David Byers's avatar
David Byers committed
766 767 768 769 770 771 772 773 774 775 776
@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


777
@node Notation
David Byers's avatar
David Byers committed
778 779
@section Notation

780
This specification uses a BNF-like grammar to describe the protocol and
781
its data elements.
David Byers's avatar
David Byers committed
782

783
Data fields have been given names that start with a lower-case letter.
784

785 786
Fundamental data types have names in all-caps (such as @type{INT32} and
@type{ARRAY}).
787 788 789

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
790
letter, like this: @type{Text-Stat}.)  The operator @code{::=} defines
791 792 793 794
the name to its left.

Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
795 796 797
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
798 799


800
@node Introduction
David Byers's avatar
David Byers committed
801 802 803 804 805 806
@chapter Introduction

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

@menu
807 808 809 810 811 812 813
* Articles::                    
* Conferences::                 
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
* Client-Server Dialog::        
David Byers's avatar
David Byers committed
814 815 816
@end menu


817
@node Articles
David Byers's avatar
David Byers committed
818 819
@section Articles

820
An article is represented as a value of the type @type{Text-Stat} and a
David Byers's avatar
David Byers committed
821
string containing the article contents. An article will usually have one
822 823
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
824
@field{nice} value of each of its recipients and it is not marked by any
825
user.
David Byers's avatar
David Byers committed
826

827 828 829 830 831
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
832 833 834

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

842
Occasionally it is necessary to map between local and global numbers.
843
The server call @reqlink{local-to-global} does this.
David Byers's avatar
David Byers committed
844 845 846



847
@node Conferences
David Byers's avatar
David Byers committed
848 849
@section Conferences

850
Conferences hold articles. They are represented in the protocol as a
851 852 853
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
854
If the supervisor is a person, the members of that person's mailbox
855
are supervisors, which in most cases is only that person. We have also
856
introduced a type called @type{UConference} (pronounced micro-conf-stat)
857
which holds a subset of the information contained in the full
858
@type{Conference} type. Use the @type{UConference} type whenever
859
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
860

861 862 863 864
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
865

866
@table @conftype
David Byers's avatar
David Byers committed
867 868 869 870 871
@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
872 873 874 875
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
876
@item letterbox
877
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
878
are sent to the mailbox and the name of the mailbox is synchronized
879 880
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
881 882
@item secret
Conferences of this type are secret. The server will not divulge any
883
information about the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
884
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
885 886
that person cannot log in using the person name, but must specify a
person number instead.
887 888 889
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
890 891 892
@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
893 894 895 896
@end table



897 898 899 900
@menu
* Persons and Sessions::        
@end menu

901
@node Persons and Sessions
David Byers's avatar
David Byers committed
902 903 904
@subsection Persons and Sessions

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

Connections to the server are represented as values of the type
911 912
@type{Static-Session-Info}, @type{Session-Info-Ident} or
@type{Session-Info}. Sessions have session number that are unique for
913 914 915 916
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
917 918


919
@node The Misc-Info List
David Byers's avatar
David Byers committed
920 921
@section The Misc-Info List

922
The @type{Misc-Info} list contains tagged data. The fields are sent in
923
groups pertaining to a particular type of information: information about
924 925
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
926 927 928
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
929

930
@subsection Recipient
David Byers's avatar
David Byers committed
931

932
@table @misc
David Byers's avatar
David Byers committed
933
@item recpt
934 935
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
936
@item loc-no
937 938
Always present within a recipient group. It contains the local text
number of the article in the conference specified by the preceding
939
@misc{recpt} field.
David Byers's avatar
David Byers committed
940
@item rec-time
941 942 943
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
944
@item sent-by
945 946 947
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
948
@item sent-at
949 950
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
951 952 953
@end table


954
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
955

956 957 958 959
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
960
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
961

962
@table @misc
David Byers's avatar
David Byers committed
963
@item cc-recpt
964 965
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
966
@item loc-no
967 968
Always present in a CC recipient group. It contains the local text
number of the article in the conference specified by the most recent
969
@misc{cc-recpt} field.
David Byers's avatar
David Byers committed
970
@item rec-time
971
Present after the CC recipient has read the article. It contains the
972 973
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
974 975 976
@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
977
person who added the CC recipient.
David Byers's avatar
David Byers committed
978 979 980 981 982 983
@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


984 985 986 987 988
@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
989
allowed to fetch both the text status of the involved text and the
990
conference status of the involved conference.  (That is, as long as the
991
conference isn't secret everybody is allowed to see the carbon-copy
992 993
recipient group.)

994 995 996 997 998
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.
999 1000

This type of group was introduced in protocol version 10.  When
1001
old-style calls such as @reqlink{get-text-stat-old}
1002 1003
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.
1004

1005
@table @misc
1006 1007 1008 1009 1010 1011
@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
1012
@misc{bcc-recpt} field.
1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026
@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


1027
@subsection Comment To
David Byers's avatar
David Byers committed
1028

1029
@table @misc
David Byers's avatar
David Byers committed
1030 1031 1032 1033 1034 1035 1036 1037
@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
1038
been created. It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
1039 1040 1041
@end table


1042
@subsection Footnote To
David Byers's avatar
David Byers committed
1043

1044
@table @misc
1045
@item footn-to
David Byers's avatar
David Byers committed
1046 1047 1048
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
1049
been created. It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
1050 1051 1052
@end table


1053
@subsection Comment in
David Byers's avatar
David Byers committed
1054

1055
@table @misc
David Byers's avatar
David Byers committed
1056 1057 1058 1059 1060 1061
@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


1062
@subsection Footnote in
David Byers's avatar
David Byers committed
1063

1064
@table @misc
1065
@item footn-in
David Byers's avatar
David Byers committed
1066 1067 1068 1069 1070
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


1071
@node The Aux-Item List
1072
@section The Aux-Item List
1073 1074 1075 1076 1077

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

@menu
1078 1079 1080 1081 1082
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
1083 1084
@end menu

1085
@node About Aux-Items
1086
@subsection About Aux-Items
1087 1088 1089 1090

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
1091
out a case where setting an aux-item on the mailbox wasn't as good as
1092 1093 1094
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.)

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

1099 1100 1101 1102 1103 1104
The @field{aux-no} field is used to identify an item. The
@field{aux-no} together with a text or conference number uniquely
identifies a particular aux item.  Items are numbered from one and up
within each item list. Once assigned, the @field{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.
1105

1106 1107 1108 1109
The @field{tag} field identifies the type of aux item. It is used by
the server and by clients to figure out how to interpret the data
field, and by the server to decide if the item needs special
treatment.
1110

1111 1112 1113 1114
The @field{data} field is a simple string. The meaning of the string
is determined by the @field{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.)
1115 1116 1117



1118
@node Predefined Aux-Item Types
1119
@subsection Predefined Aux-Item Types
1120

David Byers's avatar
David Byers committed
1121 1122 1123
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.
1124

David Byers's avatar
David Byers committed
1125 1126 1127
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,
1128
flags, who can create them, to what objects they can be attached and
David Byers's avatar
David Byers committed
1129 1130
so forth. The server may also silently enforce specific values for any
field of an item, regardless of what the client requests.
1131

1132
All items with tags in the range 1-9999 and 30000 and up are considered
1133 1134
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
1135
return an error (illegal-aux-item.)
1136

1137 1138
Some of the aux-items below (mostly the ones that begin with "mx-") are
used by mail importers. For information about supplementary aux-items
1139
introduced by @command{komimportmail}, see @ref{komimportmail Aux-Item Types}.
1140 1141 1142

@table @samp
@item content-type [1] (text)
1143
Specifies the content type of a text. Data is a valid MIME type or one
1144
of the special LysKOM types (@pxref{LysKOM Content Types}).
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154

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
1155 1156
An item of this type will never be inherited, can always be deleted, is
never anonymous and is never secret.
1157 1158


1159
@item cross-reference [3] (text, conference, letterbox)
David Byers's avatar
David Byers committed
1160
Data is a cross-reference to something else. The contents consist of a
1161 1162
letter, a number, and optionally a space and a descriptive text. The
letter must be one
David Byers's avatar
David Byers committed
1163 1164 1165 1166 1167
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