Protocol-A.texi 298 KB
 David Byers committed Jan 13, 1996 1 \input texinfo @c -*-texinfo-*-  David Byers committed Jan 07, 1999 2 3 @c @c FIXME: Explain how the garb works with nice and keep-commented  Per Cederqvist committed Apr 19, 2001 4 @c FIXME: Make all types clickable in HTML (and info?)  Per Cederqvist committed May 01, 2001 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.  Per Cederqvist committed May 01, 2001 8 @c FIXME: error-reply defined twice (conflicting).  Per Cederqvist committed May 01, 2001 9 10 @c FIXME: add link to Name Expansion from relevant reqs. @c FIXME: Name Expansion collate table info is outdated.  Per Cederqvist committed May 01, 2001 11 12 @c FIXME: Overview -> Preface @c FIXME: Move syntax from overview to somewhere else  Per Cederqvist committed May 01, 2001 13 @c FIXME: sentence-end-double-space!  Per Cederqvist committed May 01, 2001 14 @c FIXME: "Foo bar (bar baz.)" or "Foo bar (bar baz)."?  David Byers committed Jan 07, 1999 15 @c  Per Cederqvist committed May 01, 2001 16 @c $Id: Protocol-A.texi,v 1.135 2001/05/01 20:30:10 ceder Exp$  David Byers committed Jan 13, 1996 17 18 19 20 @c %**start of header @setfilename protocol-a.info @settitle LysKOM Protocol A @setchapternewpage odd  Per Cederqvist committed Apr 16, 2001 21 22 23 24 25 @c @afourpaper @set PROTOEDITION 10.4 @set PROTOVER 10 @set VERSION 1.0.4  David Byers committed Jan 13, 1996 26   Per Cederqvist committed May 01, 2001 27 28 29  @c  Per Cederqvist committed May 01, 2001 30 @c Define a few strings that contains characters from ISO Latin-1.  Per Cederqvist committed May 01, 2001 31 @c  Per Cederqvist committed May 01, 2001 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  Per Cederqvist committed May 01, 2001 50 51 52 53 54 55  @c @c Index setup @c  Per Cederqvist committed Apr 30, 2001 56 57 58 59 60 61 62 @c Index for asynchronous messages. @defcodeindex am @c Merge all indices. @syncodeindex am fn @syncodeindex tp fn  Per Cederqvist committed May 01, 2001 63 64 65 66 67 68  @c @c Special markup for Protocol-A.texi @c  Per Cederqvist committed Apr 16, 2001 69 @c @req{login} is used for protocol requests.  Per Cederqvist committed Apr 28, 2001 70   Per Cederqvist committed Apr 16, 2001 71 72 73 74 @macro req {n} @code{\n\} @end macro  Per Cederqvist committed Apr 28, 2001 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  Per Cederqvist committed Apr 29, 2001 118   Per Cederqvist committed Apr 28, 2001 119 120 @iftex  Per Cederqvist committed Apr 29, 2001 121 @c TeX version: this produces output similar to the Info version.  Per Cederqvist committed Apr 28, 2001 122   Per Cederqvist committed Apr 29, 2001 123 124 125 126 127 128 @tex \gdef\reqdlink#1{% \code{#1}% \gdef\linkhere{ (\pxref{#1})}% } @end tex  Per Cederqvist committed Apr 28, 2001 129 130 131 @end iftex @end ifnothtml  Per Cederqvist committed Apr 16, 2001 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  Per Cederqvist committed Apr 30, 2001 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  Per Cederqvist committed Apr 16, 2001 199 200 201 202 203 @c @type{Conference} is used for LysKOM types. @macro type {n} @code{\n\} @end macro  Per Cederqvist committed May 01, 2001 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  Per Cederqvist committed Apr 16, 2001 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  Per Cederqvist committed Apr 30, 2001 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  Per Cederqvist committed May 01, 2001 265 266 @c %**end of header  David Byers committed Jan 13, 1996 267 @ifinfo  Per Cederqvist committed Apr 16, 2001 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 committed Jan 13, 1996 271   Per Cederqvist committed Sep 05, 2000 272 Copyright @copyright{} 1995-2000 Lysator ACS.  David Byers committed Jan 13, 1996 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.  Per Cederqvist committed Apr 16, 2001 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 committed Jan 13, 1996 293 294 @end ifinfo  Per Cederqvist committed Apr 16, 2001 295 296 297 298 @c FIXME: What does this do? @iftex @parindent 0pt @font@tensltt=cmsltt10  Per Cederqvist committed Apr 29, 2001 299 @tex  Per Cederqvist committed Apr 16, 2001 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  Per Cederqvist committed Aug 02, 1998 305   David Byers committed Jan 13, 1996 306 307 @titlepage @title{LysKOM Protocol A}  Per Cederqvist committed Apr 16, 2001 308 309 310 @subtitle{Protocol version @value{PROTOVER}} @subtitle{Edition @value{PROTOEDITION}} @subtitle{(lyskomd @value{VERSION})}  David Byers committed Jan 13, 1996 311 312 313 314 @author by the LysKOM Developers @page @vskip 0pt plus 1filll  Per Cederqvist committed Sep 05, 2000 315 Copyright @copyright{} 1995-2000 Lysator ACS  David Byers committed Jan 13, 1996 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  Per Cederqvist committed Apr 16, 2001 330 331 332 @ifnothtml @contents @end ifnothtml  David Byers committed Jan 13, 1996 333   Per Cederqvist committed Apr 16, 2001 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
@end html @end ifhtml @ifnottex  Per Cederqvist committed May 23, 1999 352 @node Top  Per Cederqvist committed Apr 05, 1999 353 @top LysKOM Protocol A  Per Cederqvist committed Apr 04, 1999 354   Per Cederqvist committed Apr 16, 2001 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 committed Jan 13, 1996 362 363  @menu  Per Cederqvist committed May 01, 2001 364 * Preface::  Per Cederqvist committed Apr 04, 1999 365 * Introduction::  Per Cederqvist committed May 01, 2001 366 367 * Fundamentals:: * LysKOM Data Types::  Per Cederqvist committed Apr 04, 1999 368 369 370 * Protocol Requests:: * Asynchronous Messages:: * Error Codes::  Per Cederqvist committed May 01, 2001 371 * Aux-Item Types::  Per Cederqvist committed May 01, 2001 372 * Name Expansion::  Per Cederqvist committed Apr 04, 1999 373 374 375 376 * LysKOM Content Types:: * The User Area:: * Writing Clients:: * Importing and Exporting E-Mail::  Per Cederqvist committed May 01, 2001 377 * Future changes::  Per Cederqvist committed May 01, 2001 378 379 * Protocol Version History:: * Document Edition History::  Per Cederqvist committed Apr 30, 2001 380 * Index::  David Byers committed Jan 13, 1996 381 382 @end menu  Per Cederqvist committed May 01, 2001 383 384 @node Preface @chapter Preface  David Byers committed Jan 13, 1996 385   Per Cederqvist committed Apr 16, 2001 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.  Per Cederqvist committed Apr 16, 2001 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/}.  Per Cederqvist committed Apr 16, 2001 393 394 @end iftex  David Byers committed Jan 13, 1996 395 LysKOM is a conferencing system@footnote{Or in modern terms, enabling  David Byers committed Sep 13, 1997 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 committed Jan 13, 1996 402   Per Cederqvist committed Apr 16, 2001 403 404 Anything described here as unspecified'' is liable to change in future protocol versions.  David Byers committed Jan 13, 1996 405 406  This specification is the work of several people. The main contributors have  David Byers committed Sep 13, 1997 407 been  David Byers committed May 23, 1999 408 409 Per Cederqvist @email{ceder@@lysator.liu.se}, David Byers @email{byers@@lysator.liu.se},  Per Cederqvist committed May 01, 2001 410 @value{Pell} @email{pell@@lysator.liu.se},  David Byers committed May 23, 1999 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  Per Cederqvist committed May 01, 2001 414 @value{Kent} @email{kent@@lysator.liu.se}.  David Byers committed Jan 13, 1996 415   David Byers committed May 23, 1999 416 417 The LysKOM developers can be reached by email to @email{lyskom@@lysator.liu.se}.  David Byers committed Jan 13, 1996 418   Per Cederqvist committed May 23, 1999 419 @node Introduction  David Byers committed Jan 13, 1996 420 421 422 423 424 425 @chapter Introduction This chapter introduces the concepts used in LysKOM, such as articles, conferences and sessions. @menu  Per Cederqvist committed Apr 04, 1999 426 427 * Articles:: * Conferences::  Per Cederqvist committed May 01, 2001 428 * Persons and Sessions::  Per Cederqvist committed Apr 04, 1999 429 430 431 432 * The Misc-Info List:: * The Aux-Item List:: * Security:: * Membership and Reading::  David Byers committed Jan 13, 1996 433 434 435 @end menu  Per Cederqvist committed May 23, 1999 436 @node Articles  David Byers committed Jan 13, 1996 437 438 @section Articles  Per Cederqvist committed Apr 16, 2001 439 An article is represented as a value of the type @type{Text-Stat} and a  David Byers committed Jan 13, 1996 440 string containing the article contents. An article will usually have one  David Byers committed Sep 13, 1997 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  Per Cederqvist committed Apr 16, 2001 443 @field{nice} value of each of its recipients and it is not marked by any  David Byers committed Sep 13, 1997 444 user.  David Byers committed Jan 13, 1996 445   Per Cederqvist committed May 01, 2001 446 447 There is an array of @type{Misc-Info} included in the @type{Text-Stat}. This array contains information about recipients,  Per Cederqvist committed May 01, 2001 448 senders, comments and footnotes.  David Byers committed Jan 13, 1996 449   Per Cederqvist committed May 01, 2001 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 committed Jan 13, 1996 461   David Byers committed Sep 13, 1997 462 Occasionally it is necessary to map between local and global numbers.  Per Cederqvist committed May 01, 2001 463 The server call @reqdlink{local-to-global} does this@linkhere{}.  David Byers committed Jan 13, 1996 464 465 466   Per Cederqvist committed May 23, 1999 467 @node Conferences  David Byers committed Jan 13, 1996 468 469 @section Conferences  David Byers committed Sep 13, 1997 470 Conferences hold articles. They are represented in the protocol as a  Per Cederqvist committed Apr 16, 2001 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 committed Dec 26, 1998 474 If the supervisor is a person, the members of that person's mailbox  David Byers committed Sep 13, 1997 475 are supervisors, which in most cases is only that person. We have also  Per Cederqvist committed Apr 16, 2001 476 introduced a type called @type{UConference} (pronounced micro-conf-stat)  David Byers committed Sep 13, 1997 477 which holds a subset of the information contained in the full  Per Cederqvist committed Apr 16, 2001 478 @type{Conference} type. Use the @type{UConference} type whenever  David Byers committed Sep 13, 1997 479 possible since it places a much smaller load on the LysKOM server.  David Byers committed Jan 13, 1996 480   Per Cederqvist committed Apr 16, 2001 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 committed Jan 13, 1996 485   Per Cederqvist committed Apr 16, 2001 486 @table @conftype  David Byers committed Jan 13, 1996 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  David Byers committed Sep 13, 1997 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 committed Jan 13, 1996 496 @item letterbox  David Byers committed Sep 13, 1997 497 Conferences of this type are connected to persons. Letters to a person  David Byers committed Dec 26, 1998 498 are sent to the mailbox and the name of the mailbox is synchronized  David Byers committed Sep 13, 1997 499 500 with the person name. It is currently not possible to explicitly set or clear this flag on a conference.  David Byers committed Jan 13, 1996 501 502 @item secret Conferences of this type are secret. The server will not divulge any  Kent Engström committed Jul 07, 1999 503 information about the existence of the conference to persons who are not  David Byers committed Dec 26, 1998 504 members or supervisors of the conference. If a mailbox is made secret,  David Byers committed Jan 13, 1996 505 506 that person cannot log in using the person name, but must specify a person number instead.  David Byers committed Sep 13, 1997 507 508 509 @item allow-anonymous Conferences of this type accept anonymous articles. Other conferences will reject anonymous articles.  David Byers committed Dec 26, 1998 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 committed Jan 13, 1996 513 514 515 516 @end table  Per Cederqvist committed May 23, 1999 517 @node Persons and Sessions  Per Cederqvist committed May 01, 2001 518 @section Persons and Sessions  David Byers committed Jan 13, 1996 519 520  Persons are represented in the protocol by values of the type  Per Cederqvist committed Apr 16, 2001 521 @type{Person}. Associated with persons are statistics, a set of personal  Per Cederqvist committed Apr 28, 2001 522 flags and a set of privileges (@pxref{Security}). Persons are also  David Byers committed Sep 13, 1997 523 associated with a conference that has the same number as the person and  Per Cederqvist committed Apr 16, 2001 524 the @conftype{letterbox} bit set.  David Byers committed Jan 13, 1996 525 526  Connections to the server are represented as values of the type  Per Cederqvist committed Apr 16, 2001 527 528 @type{Static-Session-Info}, @type{Session-Info-Ident} or @type{Session-Info}. Sessions have session number that are unique for  David Byers committed Sep 13, 1997 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 committed Jan 13, 1996 533 534   Per Cederqvist committed May 23, 1999 535 @node The Misc-Info List  David Byers committed Jan 13, 1996 536 537 @section The Misc-Info List  Per Cederqvist committed Apr 16, 2001 538 The @type{Misc-Info} list contains tagged data. The fields are sent in  David Byers committed Sep 13, 1997 539 groups pertaining to a particular type of information: information about  Per Cederqvist committed Oct 06, 1998 540 541 recipient; carbon copy recipient; blank carbon copy recipient; comment to; footnote to; comment in  David Byers committed Sep 13, 1997 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 committed Jan 13, 1996 545   David Byers committed Jun 14, 1996 546 @subsection Recipient  David Byers committed Jan 13, 1996 547   Per Cederqvist committed Apr 16, 2001 548 @table @misc  David Byers committed Jan 13, 1996 549 @item recpt  David Byers committed Sep 13, 1997 550 551 Starts a recipient group. It contains the conference number of a recipient of the article.  David Byers committed Jan 13, 1996 552 @item loc-no  David Byers committed Sep 13, 1997 553 554 Always present within a recipient group. It contains the local text number of the article in the conference specified by the preceding  Per Cederqvist committed Apr 16, 2001 555 @misc{recpt} field.  David Byers committed Jan 13, 1996 556 @item rec-time  David Byers committed Sep 13, 1997 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 committed Jan 13, 1996 560 @item sent-by  David Byers committed Sep 13, 1997 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 committed Jan 13, 1996 564 @item sent-at  David Byers committed Sep 13, 1997 565 566 Present when the recipient was added after the article was created. It contains the time when the recipient was added.  David Byers committed Jan 13, 1996 567 568 569 @end table  David Byers committed Jun 14, 1996 570 @subsection Carbon Copy (CC) Recipient  David Byers committed Jan 13, 1996 571   David Byers committed Sep 13, 1997 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 committed Jul 07, 1998 576 article. This difference is enforced by the clients.  David Byers committed Jan 13, 1996 577   Per Cederqvist committed Apr 16, 2001 578 @table @misc  David Byers committed Jan 13, 1996 579 @item cc-recpt  David Byers committed Sep 13, 1997 580 581 Starts a carbon-copy recipient group. It contains the conference number of a carbon-copy recipient of the article.  David Byers committed Jan 13, 1996 582 @item loc-no  David Byers committed Sep 13, 1997 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  Per Cederqvist committed Apr 16, 2001 585 @misc{cc-recpt} field.  David Byers committed Jan 13, 1996 586 @item rec-time  David Byers committed Sep 13, 1997 587 Present after the CC recipient has read the article. It contains the  Per Cederqvist committed Oct 06, 1998 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 committed Jan 13, 1996 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  Per Cederqvist committed Oct 06, 1998 593 person who added the CC recipient.  David Byers committed Jan 13, 1996 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  Per Cederqvist committed Oct 06, 1998 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  Kent Engström committed Jul 07, 1999 605 allowed to fetch both the text status of the involved text and the  Per Cederqvist committed Oct 06, 1998 606 conference status of the involved conference. (That is, as long as the  Kent Engström committed Jul 07, 1999 607 conference isn't secret everybody is allowed to see the carbon-copy  Per Cederqvist committed Oct 06, 1998 608 609 recipient group.)  Per Cederqvist committed Sep 06, 2000 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.  Per Cederqvist committed Oct 06, 1998 615 616  This type of group was introduced in protocol version 10. When  Per Cederqvist committed Apr 28, 2001 617 old-style calls such as @reqlink{get-text-stat-old}  Kent Engström committed Jul 07, 1999 618 are used this will be converted to a CC recipient group by the server  Per Cederqvist committed May 01, 2001 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.)  Per Cederqvist committed Oct 06, 1998 622   Per Cederqvist committed Apr 16, 2001 623 @table @misc  Per Cederqvist committed Oct 06, 1998 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  Per Cederqvist committed Apr 16, 2001 630 @misc{bcc-recpt} field.  Per Cederqvist committed Oct 06, 1998 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  David Byers committed Jun 14, 1996 645 @subsection Comment To  David Byers committed Jan 13, 1996 646   Per Cederqvist committed Apr 16, 2001 647 @table @misc  David Byers committed Jan 13, 1996 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  Kent Engström committed Jul 07, 1999 656 been created. It contains the time when it was added as a comment.  David Byers committed Jan 13, 1996 657 658 659 @end table  David Byers committed Jun 14, 1996 660 @subsection Footnote To  David Byers committed Jan 13, 1996 661   Per Cederqvist committed Apr 16, 2001 662 @table @misc  David Byers committed Sep 13, 1997 663 @item footn-to  David Byers committed Jan 13, 1996 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  Kent Engström committed Jul 07, 1999 667 been created. It contains the time when it was added as a footnote.  David Byers committed Jan 13, 1996 668 669 670 @end table  David Byers committed Jun 14, 1996 671 @subsection Comment in  David Byers committed Jan 13, 1996 672   Per Cederqvist committed Apr 16, 2001 673 @table @misc  David Byers committed Jan 13, 1996 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  David Byers committed Jun 14, 1996 680 @subsection Footnote in  David Byers committed Jan 13, 1996 681   Per Cederqvist committed Apr 16, 2001 682 @table @misc  David Byers committed Sep 13, 1997 683 @item footn-in  David Byers committed Jan 13, 1996 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  Per Cederqvist committed May 23, 1999 689 @node The Aux-Item List  Per Cederqvist committed Apr 04, 1999 690 @section The Aux-Item List  David Byers committed Sep 13, 1997 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  Per Cederqvist committed Apr 04, 1999 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::  David Byers committed Sep 13, 1997 701 702 @end menu  Per Cederqvist committed May 23, 1999 703 @node About Aux-Items  Per Cederqvist committed Apr 04, 1999 704 @subsection About Aux-Items  David Byers committed Sep 13, 1997 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 committed Dec 26, 1998 709 out a case where setting an aux-item on the mailbox wasn't as good as  David Byers committed Sep 13, 1997 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.)  Per Cederqvist committed Apr 28, 2001 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.  David Byers committed Sep 13, 1997 716   Per Cederqvist committed Apr 28, 2001 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.  David Byers committed Sep 13, 1997 723   Per Cederqvist committed Apr 28, 2001 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.  David Byers committed Sep 13, 1997 728   Per Cederqvist committed Apr 28, 2001 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.)  David Byers committed Sep 13, 1997 733 734 735   Per Cederqvist committed May 23, 1999 736 @node Predefined Aux-Item Types  Per Cederqvist committed Apr 04, 1999 737 @subsection Predefined Aux-Item Types  David Byers committed Sep 13, 1997 738   David Byers committed May 12, 1999 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.  David Byers committed Sep 13, 1997 742   David Byers committed May 12, 1999 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,  Kent Engström committed Jul 07, 1999 746 flags, who can create them, to what objects they can be attached and  David Byers committed May 12, 1999 747 748 so forth. The server may also silently enforce specific values for any field of an item, regardless of what the client requests.  David Byers committed Sep 13, 1997 749   Per Cederqvist committed Aug 08, 1998 750 All items with tags in the range 1-9999 and 30000 and up are considered  David Byers committed Sep 13, 1997 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 committed May 12, 1999 753 return an error (illegal-aux-item.)  David Byers committed Sep 13, 1997 754 755   Per Cederqvist committed May 01, 2001 756 757 @node Client-Specific Aux-Item Types @subsection Client-Specific Aux-Item Types  David Byers committed Sep 13, 1997 758   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 763   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 768   Per Cederqvist committed May 01, 2001 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  David Byers committed Sep 13, 1997 774   Per Cederqvist committed May 01, 2001 775 776 If you want a range of numbers, send e-mail to the LysKOM development group.  David Byers committed Sep 13, 1997 777   Per Cederqvist committed May 01, 2001 778 779 780 @menu * komimportmail Aux-Item Types:: @end menu  David Byers committed Sep 13, 1997 781   Per Cederqvist committed May 01, 2001 782 783 @node komimportmail Aux-Item Types @subsubsection komimportmail Aux-Item Types  David Byers committed Sep 13, 1997 784   Per Cederqvist committed May 01, 2001 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:  David Byers committed Sep 13, 1997 788   Per Cederqvist committed May 01, 2001 789 @table @samp  David Byers committed Sep 13, 1997 790   Per Cederqvist committed May 01, 2001 791 @item mx-mime-belongs-to [10100] (text)  David Byers committed Sep 13, 1997 792   Per Cederqvist committed May 01, 2001 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).  David Byers committed Sep 13, 1997 798 799   Per Cederqvist committed May 01, 2001 800 @item mx-mime-part-in [10101] (text)  David Byers committed Sep 13, 1997 801   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 806   Per Cederqvist committed May 01, 2001 807 @item mx-mime-misc [10102] (text)  David Byers committed Sep 13, 1997 808   Per Cederqvist committed May 01, 2001 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".  David Byers committed Sep 13, 1997 812   Per Cederqvist committed May 01, 2001 813 Clients are encouraged to provide a command to display this.  David Byers committed Sep 13, 1997 814   Per Cederqvist committed May 01, 2001 815 @item mx-envelope-sender [10103] (text)  David Byers committed Sep 13, 1997 816   Per Cederqvist committed May 01, 2001 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 committed Dec 29, 1998 819   Per Cederqvist committed May 01, 2001 820 @item mx-mime-file-name [10104] (text)  David Byers committed Dec 26, 1998 821   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 825   Per Cederqvist committed May 01, 2001 826 827 Clients are encouraged to use this file name as the default file name when the user chooses to save the text.  David Byers committed Sep 13, 1997 828   Per Cederqvist committed May 01, 2001 829 @end table  David Byers committed Dec 29, 1998 830   Per Cederqvist committed May 01, 2001 831 832 @node Experimental Aux-Item Types @subsection Experimental Aux-Item Types  David Byers committed Sep 13, 1997 833   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 836 837 838   Per Cederqvist committed May 01, 2001 839 840 @node Defining New Aux-Item Types @subsection Defining New Aux-Item Types  David Byers committed Sep 13, 1997 841   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 846   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 851   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 856   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 860 861 862 863 864   Per Cederqvist committed May 01, 2001 865 866 @node Security @section Security  David Byers committed Sep 13, 1997 867   Per Cederqvist committed May 01, 2001 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.  David Byers committed Sep 13, 1997 874   Per Cederqvist committed May 01, 2001 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 committed Dec 26, 1998 890   Per Cederqvist committed May 01, 2001 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  Per Cederqvist committed Aug 16, 1998 913   Per Cederqvist committed May 01, 2001 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  Per Cederqvist committed Aug 16, 1998 920   Per Cederqvist committed May 01, 2001 921 922 923 924 925 926 @item create-conf @emph{Normally assigned} @table @asis @item Level 0 Create conferences @end table  Per Cederqvist committed Aug 16, 1998 927   Per Cederqvist committed May 01, 2001 928 929 930 931 932 933 @item create-pers @emph{Normally assigned} @table @asis @item Level 0 Create persons @end table  Per Cederqvist committed Aug 16, 1998 934   Per Cederqvist committed May 01, 2001 935 @end table  David Byers committed Dec 26, 1998 936   Per Cederqvist committed Aug 16, 1998 937   Per Cederqvist committed May 01, 2001 938 939 @node Membership and Reading @section Membership and Reading  Per Cederqvist committed Aug 16, 1998 940   Per Cederqvist committed May 01, 2001 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 committed Dec 26, 1998 945   Per Cederqvist committed May 01, 2001 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 committed Dec 26, 1998 959   Per Cederqvist committed May 01, 2001 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.  Per Cederqvist committed Aug 16, 1998 965   Per Cederqvist committed May 01, 2001 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:  Per Cederqvist committed Aug 16, 1998 969   Per Cederqvist committed May 01, 2001 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  Per Cederqvist committed Aug 16, 1998 978   Per Cederqvist committed May 01, 2001 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{}.  David Byers committed Sep 13, 1997 984   Jonas S Karlsson committed Oct 11, 1998 985   Per Cederqvist committed May 01, 2001 986 987 @node Fundamentals @chapter Fundamentals of Protocol A  Kent Engström committed Oct 20, 1999 988   Per Cederqvist committed May 01, 2001 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.  Jonas S Karlsson committed Oct 11, 1998 993   Per Cederqvist committed May 01, 2001 994 995 996 997 998 @menu * Notation:: * Simple Data Types:: * Client-Server Dialog:: @end menu  Jonas S Karlsson committed Oct 11, 1998 999   Per Cederqvist committed May 01, 2001 1000 @node Notation