Protocol-A.texi 298 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
@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.
8
@c FIXME: error-reply defined twice (conflicting).
9 10
@c FIXME: add link to Name Expansion from relevant reqs.
@c FIXME: Name Expansion collate table info is outdated.
11 12
@c FIXME: Overview -> Preface
@c FIXME: Move syntax from overview to somewhere else
13
@c FIXME: sentence-end-double-space!
14
@c FIXME: "Foo bar (bar baz.)" or "Foo bar (bar baz)."?
David Byers's avatar
David Byers committed
15
@c
16
@c $Id: Protocol-A.texi,v 1.135 2001/05/01 20:30:10 ceder Exp $
David Byers's avatar
David Byers committed
17 18 19 20
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
21 22 23 24 25
@c @afourpaper

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

27 28 29


@c
30
@c Define a few strings that contains characters from ISO Latin-1.
31
@c
32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

@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

50 51 52 53 54 55


@c
@c Index setup
@c

56 57 58 59 60 61 62
@c Index for asynchronous messages.
@defcodeindex am

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

63 64 65 66 67 68


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

69
@c @req{login} is used for protocol requests.
70

71 72 73 74
@macro req {n}
@code{\n\}
@end macro

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 113 114 115 116 117
@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
118

119 120
@iftex

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

123 124 125 126 127 128
@tex
    \gdef\reqdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
129 130 131
@end iftex
@end ifnothtml

132 133 134 135 136 137 138 139 140 141
@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

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 194 195 196 197 198
@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

199 200 201 202 203
@c @type{Conference} is used for LysKOM types.
@macro type {n}
@code{\n\}
@end macro

204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219
@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

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 253 254 255 256 257
@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

258 259 260 261 262 263 264
@c @reqexample is used immediately before Protocol-A example
@c fragments.
@macro reqexample
@need 2000
@i{Example:}
@end macro

265 266
@c %**end of header

David Byers's avatar
David Byers committed
267
@ifinfo
268 269 270
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
271

Per Cederqvist's avatar
Per Cederqvist committed
272
Copyright @copyright{} 1995-2000 Lysator ACS.
David Byers's avatar
David Byers committed
273 274 275 276

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.
277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292

@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
293 294
@end ifinfo

295 296 297 298
@c FIXME: What does this do?
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
299
@tex
300 301 302 303 304
\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
305

David Byers's avatar
David Byers committed
306 307
@titlepage
@title{LysKOM Protocol A}
308 309 310
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
311 312 313 314
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
Per Cederqvist's avatar
Per Cederqvist committed
315
Copyright @copyright{} 1995-2000 Lysator ACS
David Byers's avatar
David Byers committed
316 317 318 319 320 321 322 323 324 325 326 327 328 329

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
330 331 332
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
333

334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351
@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
352
@node Top
353
@top LysKOM Protocol A
354

355 356 357 358 359 360 361
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
362 363

@menu
364
* Preface::                     
365
* Introduction::                
366 367
* Fundamentals::                
* LysKOM Data Types::           
368 369 370
* Protocol Requests::           
* Asynchronous Messages::       
* Error Codes::                 
371
* Aux-Item Types::              
372
* Name Expansion::              
373 374 375 376
* LysKOM Content Types::        
* The User Area::               
* Writing Clients::             
* Importing and Exporting E-Mail::  
377
* Future changes::              
378 379
* Protocol Version History::    
* Document Edition History::    
380
* Index::                       
David Byers's avatar
David Byers committed
381 382
@end menu

383 384
@node Preface
@chapter Preface
David Byers's avatar
David Byers committed
385

386 387 388 389 390
@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.

391 392
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/}.
393 394
@end iftex

David Byers's avatar
David Byers committed
395
LysKOM is a conferencing system@footnote{Or in modern terms, enabling
396 397 398 399 400 401
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
402

403 404
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
405 406

This specification is the work of several people. The main contributors have
407
been
David Byers's avatar
David Byers committed
408 409
Per Cederqvist @email{ceder@@lysator.liu.se}, 
David Byers @email{byers@@lysator.liu.se},
410
@value{Pell} @email{pell@@lysator.liu.se},
David Byers's avatar
David Byers committed
411 412 413
Thomas Bellman @email{bellman@@lysator.liu.se}, 
Lars Aronsson @email{aronsson@@lysator.liu.se},
Linus Tolke @email{linus@@lysator.liu.se} and
414
@value{Kent} @email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
415

David Byers's avatar
David Byers committed
416 417
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
418

419
@node Introduction
David Byers's avatar
David Byers committed
420 421 422 423 424 425
@chapter Introduction

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

@menu
426 427
* Articles::                    
* Conferences::                 
428
* Persons and Sessions::        
429 430 431 432
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
David Byers's avatar
David Byers committed
433 434 435
@end menu


436
@node Articles
David Byers's avatar
David Byers committed
437 438
@section Articles

439
An article is represented as a value of the type @type{Text-Stat} and a
David Byers's avatar
David Byers committed
440
string containing the article contents. An article will usually have one
441 442
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
443
@field{nice} value of each of its recipients and it is not marked by any
444
user.
David Byers's avatar
David Byers committed
445

446 447
There is an array of @type{Misc-Info} included in the
@type{Text-Stat}.  This array contains information about recipients,
448
senders, comments and footnotes.
David Byers's avatar
David Byers committed
449

450 451 452 453 454 455 456 457 458 459 460
Each article is identified by a number, the global@footnote{The number
is not truly global; it is local to a specific LysKOM server.}
article number (the @type{Text-No}).  Global numbers are assigned in
ascending order to new articles, and are never reused.  If an article
has recipients it will also have a local number for each recipient
(the @type{Local-Text-No}).  Local numbers are used in some data
structures to provide more compact storage and to provide an ordering
of articles for 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
461

462
Occasionally it is necessary to map between local and global numbers.
463
The server call @reqdlink{local-to-global} does this@linkhere{}.
David Byers's avatar
David Byers committed
464 465 466



467
@node Conferences
David Byers's avatar
David Byers committed
468 469
@section Conferences

470
Conferences hold articles. They are represented in the protocol as a
471 472 473
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
474
If the supervisor is a person, the members of that person's mailbox
475
are supervisors, which in most cases is only that person. We have also
476
introduced a type called @type{UConference} (pronounced micro-conf-stat)
477
which holds a subset of the information contained in the full
478
@type{Conference} type. Use the @type{UConference} type whenever
479
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
480

481 482 483 484
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
485

486
@table @conftype
David Byers's avatar
David Byers committed
487 488 489 490 491
@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
492 493 494 495
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
496
@item letterbox
497
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
498
are sent to the mailbox and the name of the mailbox is synchronized
499 500
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
501 502
@item secret
Conferences of this type are secret. The server will not divulge any
503
information about the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
504
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
505 506
that person cannot log in using the person name, but must specify a
person number instead.
507 508 509
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
510 511 512
@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
513 514 515 516
@end table



517
@node Persons and Sessions
518
@section Persons and Sessions
David Byers's avatar
David Byers committed
519 520

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

Connections to the server are represented as values of the type
527 528
@type{Static-Session-Info}, @type{Session-Info-Ident} or
@type{Session-Info}. Sessions have session number that are unique for
529 530 531 532
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
533 534


535
@node The Misc-Info List
David Byers's avatar
David Byers committed
536 537
@section The Misc-Info List

538
The @type{Misc-Info} list contains tagged data. The fields are sent in
539
groups pertaining to a particular type of information: information about
540 541
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
542 543 544
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
545

546
@subsection Recipient
David Byers's avatar
David Byers committed
547

548
@table @misc
David Byers's avatar
David Byers committed
549
@item recpt
550 551
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
552
@item loc-no
553 554
Always present within a recipient group. It contains the local text
number of the article in the conference specified by the preceding
555
@misc{recpt} field.
David Byers's avatar
David Byers committed
556
@item rec-time
557 558 559
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
560
@item sent-by
561 562 563
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
564
@item sent-at
565 566
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
567 568 569
@end table


570
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
571

572 573 574 575
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
576
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
577

578
@table @misc
David Byers's avatar
David Byers committed
579
@item cc-recpt
580 581
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
582
@item loc-no
583 584
Always present in a CC recipient group. It contains the local text
number of the article in the conference specified by the most recent
585
@misc{cc-recpt} field.
David Byers's avatar
David Byers committed
586
@item rec-time
587
Present after the CC recipient has read the article. It contains the
588 589
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
590 591 592
@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
593
person who added the CC recipient.
David Byers's avatar
David Byers committed
594 595 596 597 598 599
@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


600 601 602 603 604
@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
605
allowed to fetch both the text status of the involved text and the
606
conference status of the involved conference.  (That is, as long as the
607
conference isn't secret everybody is allowed to see the carbon-copy
608 609
recipient group.)

610 611 612 613 614
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.
615 616

This type of group was introduced in protocol version 10.  When
617
old-style calls such as @reqlink{get-text-stat-old}
618
are used this will be converted to a CC recipient group by the server
619 620 621
for the benefit of clients that don't understand this group.  (This
conversion will of course only be performed when the user is allowed
to se the blank carbon copy.)
622

623
@table @misc
624 625 626 627 628 629
@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
630
@misc{bcc-recpt} field.
631 632 633 634 635 636 637 638 639 640 641 642 643 644
@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


645
@subsection Comment To
David Byers's avatar
David Byers committed
646

647
@table @misc
David Byers's avatar
David Byers committed
648 649 650 651 652 653 654 655
@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
656
been created. It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
657 658 659
@end table


660
@subsection Footnote To
David Byers's avatar
David Byers committed
661

662
@table @misc
663
@item footn-to
David Byers's avatar
David Byers committed
664 665 666
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
667
been created. It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
668 669 670
@end table


671
@subsection Comment in
David Byers's avatar
David Byers committed
672

673
@table @misc
David Byers's avatar
David Byers committed
674 675 676 677 678 679
@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


680
@subsection Footnote in
David Byers's avatar
David Byers committed
681

682
@table @misc
683
@item footn-in
David Byers's avatar
David Byers committed
684 685 686 687 688
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


689
@node The Aux-Item List
690
@section The Aux-Item List
691 692 693 694 695

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

@menu
696 697 698 699 700
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
701 702
@end menu

703
@node About Aux-Items
704
@subsection About Aux-Items
705 706 707 708

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
709
out a case where setting an aux-item on the mailbox wasn't as good as
710 711 712
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.)

713 714 715
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.
716

717 718 719 720 721 722
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.
723

724 725 726 727
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.
728

729 730 731 732
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.)
733 734 735



736
@node Predefined Aux-Item Types
737
@subsection Predefined Aux-Item Types
738

David Byers's avatar
David Byers committed
739 740 741
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.
742

David Byers's avatar
David Byers committed
743 744 745
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,
746
flags, who can create them, to what objects they can be attached and
David Byers's avatar
David Byers committed
747 748
so forth. The server may also silently enforce specific values for any
field of an item, regardless of what the client requests.
749

750
All items with tags in the range 1-9999 and 30000 and up are considered
751 752
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
753
return an error (illegal-aux-item.)
754 755


756 757
@node Client-Specific Aux-Item Types
@subsection Client-Specific Aux-Item Types
758

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

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

769 770 771 772 773
Currently, the following ranges are assigned to clients:
@itemize @bullet
@item 10000-10099: The Elisp Client
@item 10100-10199: komimportmail
@end itemize
774

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

778 779 780
@menu
* komimportmail Aux-Item Types::  
@end menu
781

782 783
@node komimportmail Aux-Item Types
@subsubsection komimportmail Aux-Item Types
784

785 786 787
During the design and implementation of the @command{komimportmail} mail
importer, some new aux-items were defined to solve specific problems.
These aux-items are documented here:
788

789
@table @samp
790

791
@item mx-mime-belongs-to [10100] (text)
792

793 794 795 796 797
Data is a decimal text number that this text is an attachment to.  Most
likely, the current text is also a comment (or perhaps a footnote) to
the text mentioned in the aux-item. A client can use this aux-item to
alter the display format of the text (stating that this is an
attachment, not a normal comment).
798 799


800
@item mx-mime-part-in [10101] (text)
801

802 803 804 805
Data is a decimal text number of a text that is an attachment to the
current one. In other words: this is the converse of mx-mime-belongs-to.
A client can use this aux-item to know which comments to mark as
attachments; the remaining comments are assumed to be normal.
806

807
@item mx-mime-misc [10102] (text)
808

809 810 811
Data is a string that contains all of the MIME headers for the current
text. It is set by the importer. The fields are concatenated with
"\n".
812

813
Clients are encouraged to provide a command to display this.
814

815
@item mx-envelope-sender [10103] (text)
816

817 818
Data is the envelope sender of an imported text. The mail server is
supposed to pass this information to the importer, for inclusion here.
David Byers's avatar
David Byers committed
819

820
@item mx-mime-file-name [10104] (text)
David Byers's avatar
David Byers committed
821

822 823 824
Data is the file name of an attachment. Most likely, the importer gets
this information from a @code{name} parameter on a @code{Content-Type}
MIME header line.
825

826 827
Clients are encouraged to use this file name as the default file name
when the user chooses to save the text.
828

829
@end table
David Byers's avatar
David Byers committed
830

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

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



839 840
@node Defining New Aux-Item Types
@subsection Defining New Aux-Item Types
841

842 843 844 845
If you want a new predefined item type, just document what it does, what
the data format looks like and what the server is to do with the item
and send this to the LysKOM development group. We'll assign a number to
your item and put the documentation in this document. 
846

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

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

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





865 866
@node Security
@section Security
867

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

875 876 877 878 879 880 881 882 883 884 885 886 887 888 889
@table @priv
@item wheel
@emph{Normally not assigned}
@table @asis
@item Level 0
Person may always log in, even when LysKOM is crowded.
@item Level 6
Person may set Priv-Bits for all persons.
@item Level 7
Person may set password for all persons.
@item Level 8
Person acts as supervisor for everything.
@item Level 10
Person can read all articles.
@end table
David Byers's avatar
David Byers committed
890

891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912
@item admin
@emph{Normally not assigned}
@table @asis
@item Level 1
Shut down the server@*
Set motd-of-kom@*
Read last-login
@item Level 2
Read status of secret conferences and persons@*
Read the protected parts of person and conference statuses@*
Read the entire text status, even when there are secret recipients
@item Level 3
Change everybody's names
@item Level 4
Add/remove members@*
Add/remove recipients to articles
@item Level 5
Set super-conference@*
Remove articles
@item Level 6
Set administrator
@end table
913

914 915 916 917 918 919
@item statistic
@emph{Normally not assigned}
@table @asis
@item Level 2
Read the statistics portions of persons, even if protected
@end table
920

921 922 923 924 925 926
@item create-conf
@emph{Normally assigned}
@table @asis
@item Level 0
Create conferences
@end table
927

928 929 930 931 932 933
@item create-pers
@emph{Normally assigned}
@table @asis
@item Level 0
Create persons
@end table
934

935
@end table
David Byers's avatar
David Byers committed
936

937

938 939
@node Membership and Reading
@section Membership and Reading
940

941 942 943 944
Persons' memberships in conferences are represented in the protocol as
arrays of @type{Membership}-typed values. This structure contains
information about how and when the membership was created and which
texts have been read in the conference.
David Byers's avatar
David Byers committed
945

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

960 961 962 963 964
The membership record indicates which texts have been read through the
@field{last-text-read} and @field{read-texts} fields. All texts with local 
numbers up to @field{last-text-read} have been read. In addition, all
texts with local numbers contained in the @field{read-texts} array have
been read.
965

966 967 968
Finding out which articles a person has read in a particular conference
requires a few calls. Normally, a client will retrieve a batch of
perhaps 50 articles at a time. The outline of the process is as follows:
969

970 971 972 973 974 975 976 977
@enumerate
@item Fetch the membership to get the @field{last-text-read}
@item Use @reqlink{local-to-global} to translate a number of local
numbers to global numbers.
@item Remove the global numbers corresponding to local numbers contained 
in @field{read-texts} from the result.
@item Get and translate more texts as needed.
@end enumerate
978

979 980 981 982 983
The process is complicated because of the translation between local
and global text numbers. If the server does not implement the
@reqdlink{local-to-global} call@linkhere{}, it is possible to use the less
efficient but perfectly serviceable @reqdlink{get-map} call
instead@linkhere{}.
984

985

986 987
@node Fundamentals
@chapter Fundamentals of Protocol A
988

989 990 991 992
The data types in protocol A come in two flavors. The first (vanilla)
are the simple data types from which the LysKOM (chocolate) data types
are built. Simple data types include things like integers and strings
while complex data types include things such as conferences and people.
993

994 995 996 997 998
@menu
* Notation::                    
* Simple Data Types::           
* Client-Server Dialog::        
@end menu
999

1000 1001
@node Notation
@section Notation
1002

1003 1004
This specification uses a BNF-like grammar to describe the protocol and
its data elements.
1005

1006
Data fields have been given names that start with a lower-case letter.
1007

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

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

1016 1017 1018 1019 1020
Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
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.
1021 1022


1023 1024
@node Simple Data Types
@section Simple Data Types
1025

1026 1027 1028 1029 1030
@anchor{INT32}
@anchor{INT16}
@anchor{INT8}
@anchor{BOOL}
@subsection Integers
1031

1032 1033 1034 1035 1036 1037 1038
@tindex INT32
@tindex INT16
@tindex INT8
@tindex BOOL
@type{INT32}, @type{INT16}, @type{INT8} and @type{BOOL} are non-negative
integers which must fit in 32, 16, 8 and 1 bits, respectively. They are
transmitted to the server in ASCII-encoded decimal notation.
1039

1040

1041 1042
@anchor{HOLLERITH}
@subsection Strings
1043

1044 1045 1046 1047 1048 1049
@tindex HOLLERITH
@type{HOLLERITH} denotes character strings of arbitrary length. They are
transmitted as @code{@var{n}H@var{text}} where @var{text} is the string and
@var{n} is the number of characters in @var{text} in decimal
notation. All byte values are allowed in the string itself, including
nulls.
1050

1051
Long live FORTRAN!
1052

1053 1054


1055 1056
@anchor{BITSTRING}
@subsection Bit Strings
1057

1058 1059 1060
@tindex BITSTRING
@type{BITSTRING} is a string of bits, commonly used for a set of
boolean-valued flags. Bit strings are denoted as
1061

1062 1063 1064
@example
        BITSTRING ( name-1; name-2; name-3; @dots{} )
@end example
1065

1066 1067
in this specification. They are transmitted as a sequence of ASCII ones
and zeroes in the order the fields are listed.
1068

1069
For instance, given the specification
1070

1071 1072 1073 1074 1075 1076 1077 1078
@example
        shape-of-world ::= BITSTRING (
                is-flat;
                is-round;
                is-2d;
                is-3d;
        )
@end example
1079

1080 1081
most peoples idea of @code{shape-of-world} would be sent as @code{0101}
(round and three-dimensional.)
1082 1083


1084 1085
@anchor{ENUMERATION}
@subsection Enumerations
1086

1087 1088 1089 1090 1091 1092
@tindex ENUMERATION
@type{ENUMERATION} is an integer constant. It is transmitted as an INT32, 
but only fixed values are permitted. Clients should be prepared to
receive numbers outside the enumeration and either handle this
gracefully as an error or use a reasonable default value in place of an
invalid enumeration value.
1093

1094
An enumeration is specified as 
1095

1096 1097 1098 1099 1100 1101 1102 1103
@example
        ENUMERATION ( 
                name-1=value-1;
                name-2=value-2;
                name-3=value-3;
                @dots{}
        )
@end example
David Byers's avatar
David Byers committed
1104

1105 1106 1107
This specification states that name-1 is represented by the integer
value-1, name-2 is represented by value-2 and name-3 is represented by
value-3. 
David Byers's avatar
David Byers committed
1108

1109
An enumeration can also be inherited from a SELECTION datatype:
1110

1111 1112 1113
@example
        Info-type ::= ENUMERATION-OF(Misc-Info)
@end example
David Byers's avatar
David Byers committed
1114

1115 1116
This means that Info-type is an enumeration, that contains the same keys
and values as the SELECTION Misc-Info.
David Byers's avatar
David Byers committed
1117

1118 1119 1120
For example, in the following specification, the constant guwal will be
transmitted as the integer 2, ciokwe as the integer 3, and hopi as the
integer 5.
1121

1122 1123 1124 1125 1126 1127 1128 1129
@example
      language ::= ENUMERATION ( hakka      = 1;
                                 guwal      = 2;
                                 ciokwe     = 3;
                                 yoruba     = 4;
                                 hopi       = 5;
                )
@end example
1130 1131