Protocol-A.texi 384 KB
Newer Older
 David Byers committed Jan 13, 1996 1 \input texinfo @c -*-texinfo-*-  David Byers committed Jan 07, 1999 2 @c  Per Cederqvist committed Nov 08, 2001 3 @c FIXME (bug 194): Explain how the garb works with nice and keep-commented  David Byers committed Jan 07, 1999 4 @c  David Byers committed Jan 13, 1996 5 6 7 8 @c %**start of header @setfilename protocol-a.info @settitle LysKOM Protocol A @setchapternewpage odd  Per Cederqvist committed Apr 16, 2001 9 10 @c @afourpaper  Per Cederqvist committed Aug 23, 2003 11 12 13 @set PROTOEDITION 11.0 @set PROTOVER 11 @set VERSION 2.1.0  David Byers committed Jan 13, 1996 14   Per Cederqvist committed May 01, 2001 15 16   Per Cederqvist committed May 13, 2001 17 18 19 20 21 22 23 24 @c @holl{l, s} is used to construct Hollerith strings. The main @c reason to use this macro is to help the spell checker. @macro holl {l, s} \l\H\s\ @end macro  Per Cederqvist committed May 01, 2001 25 @c  Per Cederqvist committed May 01, 2001 26 @c Define a few strings that contains characters from ISO Latin-1.  Per Cederqvist committed May 01, 2001 27 @c  Per Cederqvist committed May 01, 2001 28 29 30  @iftex  Per Cederqvist committed May 13, 2001 31 @c ispell-ignore  Per Cederqvist committed Aug 16, 2002 32 @set IAM Inl@"agg @}t mig  Per Cederqvist committed May 01, 2001 33 34 @set Pell P@"ar Emanuelsson @set Kent Kent Eng@-str@"om@penalty-10000  Per Cederqvist committed May 13, 2001 35 36 @set presconf @holl{27,Presentation (av nya) m@"oten} @c ispell-end-ignore  Per Cederqvist committed May 01, 2001 37 38 39 40  @end iftex @ifnottex  Per Cederqvist committed May 13, 2001 41 @c ispell-ignore  Per Cederqvist committed May 01, 2001 42 43 44 @set IAM Inlägg @}t mig @set Pell Pär Emanuelsson @set Kent Kent Engström  Per Cederqvist committed May 13, 2001 45 46 @set presconf @holl{27,Presentation (av nya) möten} @c ispell-end-ignore  Per Cederqvist committed May 01, 2001 47 48 49  @end ifnottex  Per Cederqvist committed May 01, 2001 50 51 52 53 @c @c Index setup @c  Per Cederqvist committed Apr 30, 2001 54 55 56 57 58 59 @c Index for asynchronous messages. @defcodeindex am @c Merge all indices. @syncodeindex am fn @syncodeindex tp fn  Per Cederqvist committed Dec 30, 2001 60 @syncodeindex cp fn  Per Cederqvist committed Apr 30, 2001 61   Per Cederqvist committed May 01, 2001 62 63 64  @c  Per Cederqvist committed May 13, 2001 65 @c Special markup for this document.  Per Cederqvist committed May 01, 2001 66 67 @c  Per Cederqvist committed May 13, 2001 68 69 70 71 72 @c Indicate something that shouldn't be spell-checked @macro badspell{s} \s\ @end macro  Per Cederqvist committed Apr 16, 2001 73 @c @req{login} is used for protocol requests.  Per Cederqvist committed Apr 28, 2001 74   Per Cederqvist committed Apr 16, 2001 75 76 77 78 @macro req {n} @code{\n\} @end macro  Per Cederqvist committed May 13, 2001 79 @c @reqlink{login} is used for protocol requests, that should be linked.  Per Cederqvist committed Apr 28, 2001 80 81 82 83 84 85 86 87 88 89 90 91 92 93  @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  Per Cederqvist committed May 13, 2001 94 @c should be linked, where the link should occur a few words after the  Per Cederqvist committed Apr 28, 2001 95 96 97 98 99 100 @c request itself. @ifhtml @c HTML version: make the word a link. @macro reqdlink {n}  Per Cederqvist committed May 20, 2001 101 @code{@ref{\n\}}  Per Cederqvist committed Apr 28, 2001 102 103 104 105 106 107 108 109 110 111 @unmacro linkhere @macro linkhere @end macro @end macro @end ifhtml @ifnothtml @ifnottex  Per Cederqvist committed May 13, 2001 112 @c Info version: create @linkhere as a macro that contains a reference.  Per Cederqvist committed Apr 28, 2001 113 114  @macro reqdlink {n}  Per Cederqvist committed May 20, 2001 115 @code{\n\}  Per Cederqvist committed Apr 28, 2001 116 117 118 119 120 121 @unmacro linkhere @macro linkhere (@pxref{\n\}) @end macro @end macro @end ifnottex  Per Cederqvist committed Apr 29, 2001 122   Per Cederqvist committed Apr 28, 2001 123 124 @iftex  Per Cederqvist committed Apr 29, 2001 125 @c TeX version: this produces output similar to the Info version.  Per Cederqvist committed Apr 28, 2001 126   Per Cederqvist committed May 13, 2001 127 @c ispell-ignore  Per Cederqvist committed Apr 29, 2001 128 129 130 131 132 133 @tex \gdef\reqdlink#1{% \code{#1}% \gdef\linkhere{ (\pxref{#1})}% } @end tex  Per Cederqvist committed May 13, 2001 134 @c ispell-end-ignore  Per Cederqvist committed Apr 28, 2001 135 136 137 @end iftex @end ifnothtml  Per Cederqvist committed Apr 16, 2001 138 139 140 141 142 143 144 145 146 147 @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 May 13, 2001 148 @c @asynclink{async-login} is used for async names, that should be linked.  Per Cederqvist committed Apr 30, 2001 149 150 151 152 153 154 155 156 157 158 159 160 161 162  @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,  Per Cederqvist committed May 13, 2001 163 @c that should be linked, where the link should occur a few words after  Per Cederqvist committed Apr 30, 2001 164 165 166 167 168 169 @c the async name itself. @ifhtml @c HTML version: make the word a link. @macro asyncdlink {n}  Per Cederqvist committed May 20, 2001 170 @code{@ref{\n\}}  Per Cederqvist committed Apr 30, 2001 171 172 173 174 175 176 177 178 179 180 @unmacro linkhere @macro linkhere @end macro @end macro @end ifhtml @ifnothtml @ifnottex  Per Cederqvist committed May 13, 2001 181 @c Info version: create @linkhere as a macro that contains a reference.  Per Cederqvist committed Apr 30, 2001 182 183  @macro asyncdlink {n}  Per Cederqvist committed May 20, 2001 184 @code{\n\}  Per Cederqvist committed Apr 30, 2001 185 186 187 188 189 190 191 192 193 194 195 @unmacro linkhere @macro linkhere (@pxref{\n\}) @end macro @end macro @end ifnottex @iftex @c TeX version: this produces output similar to the Info version.  Per Cederqvist committed May 13, 2001 196 @c ispell-ignore  Per Cederqvist committed Apr 30, 2001 197 198 199 200 201 202 @tex \gdef\asyncdlink#1{% \code{#1}% \gdef\linkhere{ (\pxref{#1})}% } @end tex  Per Cederqvist committed May 13, 2001 203 @c ispell-end-ignore  Per Cederqvist committed Apr 30, 2001 204 205 206 @end iftex @end ifnothtml  Per Cederqvist committed Apr 16, 2001 207 208 209 210 211 @c @type{Conference} is used for LysKOM types. @macro type {n} @code{\n\} @end macro  Per Cederqvist committed May 01, 2001 212 213 214 215 216 217 @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}  Per Cederqvist committed May 20, 2001 218 @ref{\n\}  Per Cederqvist committed May 01, 2001 219 220 221 222 223 @end macro @end ifhtml @ifnothtml @macro lt {n}  Per Cederqvist committed May 20, 2001 224 \n\  Per Cederqvist committed May 01, 2001 225 226 227 @end macro @end ifnothtml  Per Cederqvist committed Apr 16, 2001 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 258 259 260 261 262 263 264 265 @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 266 267 268 269 270 271 272 @c @reqexample is used immediately before Protocol-A example @c fragments. @macro reqexample @need 2000 @i{Example:} @end macro  Per Cederqvist committed May 20, 2001 273 274 275 276 277 278 279 280 281 @c @c Define strings that can be encoded as macros instead of with @set. @c @macro daemon @badspell{d@ae{}mon} @end macro  Per Cederqvist committed May 01, 2001 282 283 @c %**end of header  Per Cederqvist committed Aug 10, 2002 284 @copying  Per Cederqvist committed Apr 16, 2001 285 286 287 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 288   Per Cederqvist committed Aug 23, 2003 289 Copyright @copyright{} 1995-2003 Lysator ACS.  David Byers committed Jan 13, 1996 290   Per Cederqvist committed Aug 10, 2002 291 @quotation  David Byers committed Jan 13, 1996 292 293 294 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 295   Per Cederqvist committed Nov 25, 2002 296 297 298 299 300 @c Permission is granted to process this file through TeX @c and print the results, provided the printed document @c carries a copying permission notice identical to this @c one except for the removal of this paragraph (this @c paragraph not being relevant to the printed manual).  Per Cederqvist committed Apr 16, 2001 301 302 303 304 305 306 307 308  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.  Per Cederqvist committed Aug 10, 2002 309 310 @end quotation @end copying  David Byers committed Jan 13, 1996 311   Per Cederqvist committed May 13, 2001 312 @c ispell-ignore  Per Cederqvist committed Apr 16, 2001 313 @iftex  Per Cederqvist committed Aug 06, 2003 314 315 @c @c Don't indent the first line of paragraphs.  Per Cederqvist committed Apr 16, 2001 316 @parindent 0pt  Per Cederqvist committed Aug 06, 2003 317 318 319 320 321 322 323 324 325 326 327 @c @c Define @t{} so that it switches from slanted to regular to slanted @c typewriter text as usages are nested. For example: @c @c @t{A @t{B @t{C} D} E} @c @c will set A, C and E slanted and B and D as regular typewriter text. @c This makes @t sort of the typewriter equivalent of LaTeX \em @c (emphasis is italic, emphasized emphasis is roman). @c @c Helpers:  Per Cederqvist committed Aug 13, 2003 328 329 330 @c \tensltt: switch to the cmsltt10 font (Computer Modern, @c Slanted, Typewriter, 10pt). @c \rett: switch to typewriter text and define  Per Cederqvist committed Aug 06, 2003 331 332 333 334 335 336 @c \t as an alias for \sltt. @c \sltt: switch to slanted typewriter text and defines @c \t as an alias for \rett. @c @c Finally \t is defined as an alias for \sltt. @c  Per Cederqvist committed Apr 29, 2001 337 @tex  Per Cederqvist committed Aug 13, 2003 338 \global\font\tensltt=cmsltt10  Per Cederqvist committed Apr 16, 2001 339 340 341 342 343 \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 May 13, 2001 344 @c ispell-end-ignore  Per Cederqvist committed Aug 02, 1998 345   David Byers committed Jan 13, 1996 346 347 @titlepage @title{LysKOM Protocol A}  Per Cederqvist committed Apr 16, 2001 348 349 350 @subtitle{Protocol version @value{PROTOVER}} @subtitle{Edition @value{PROTOEDITION}} @subtitle{(lyskomd @value{VERSION})}  David Byers committed Jan 13, 1996 351 352 353 @author by the LysKOM Developers @page  Per Cederqvist committed May 13, 2001 354 @c ispell-ignore  David Byers committed Jan 13, 1996 355 @vskip 0pt plus 1filll  Per Cederqvist committed May 13, 2001 356 @c ispell-end-ignore  Per Cederqvist committed Aug 10, 2002 357 @insertcopying  David Byers committed Jan 13, 1996 358 359  @end titlepage  Per Cederqvist committed Apr 16, 2001 360 361 362 @ifnothtml @contents @end ifnothtml  David Byers committed Jan 13, 1996 363   Per Cederqvist committed Apr 16, 2001 364 365 366 367 368 @dircategory LysKOM @direntry * Protocol A: (protocol-a). The LysKOM Protocol A specification. @end direntry  Per Cederqvist committed May 13, 2001 369 @c ispell-ignore  Per Cederqvist committed Apr 16, 2001 370 371 372 373 374 375 376 377 378 379 380 381 @ifhtml @html
@end html @end ifhtml  Per Cederqvist committed May 13, 2001 382 @c ispell-end-ignore  Per Cederqvist committed May 22, 2001 383   Per Cederqvist committed May 23, 1999 384 @node Top  Per Cederqvist committed Apr 05, 1999 385 @top LysKOM Protocol A  Per Cederqvist committed Apr 04, 1999 386   Per Cederqvist committed Apr 16, 2001 387 388 389 390 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 May 05, 2001 391 The most up-to-date version if this document can always be found at  Per Cederqvist committed Apr 16, 2001 392 @uref{http://www.lysator.liu.se/lyskom/protocol/}.  David Byers committed Jan 13, 1996 393 394  @menu  Per Cederqvist committed Aug 10, 2002 395 * About this document:: Copyright information.  Per Cederqvist committed May 16, 2001 396 397 398 399 * Preface:: What is LysKOM? Who wrote this document? * Concepts:: Articles, conferences, aux-items, @dots{} * Fundamentals:: The building blocks of Protocol A. * LysKOM Data Types:: Domain-specific data types used in Protocol A.  Per Cederqvist committed May 20, 2001 400 * Protocol Requests:: Each request explained in depth.  Per Cederqvist committed May 16, 2001 401 402 403 404 405 406 * Asynchronous Messages:: Unsolicited information from the server. * Error Codes:: All error codes with explanations. * Aux-Item Types:: All predefined aux-item types. * Name Expansion:: Looking up the name of a conference or person. * LysKOM Content Types:: Predefined content types for articles. * The User Area:: Store client-specific settings in the server.  Per Cederqvist committed Aug 06, 2002 407 * Membership visibility:: How the security features interacts.  Per Cederqvist committed Jul 24, 2003 408 * Measured Properties:: Load average, number of processed requests...  Per Cederqvist committed May 16, 2001 409 410 * Writing Clients:: A few tips for client writers. * Importing and Exporting E-Mail:: A few thoughts on e-mail integration.  Per Cederqvist committed Nov 01, 2002 411 * Some Client-specific Aux-Item Types:: Informative info about more aux-items.  Per Cederqvist committed May 16, 2001 412 413 414 415 * Future changes:: The protocol is not yet perfect. * Protocol Version History:: The protocol was even less perfect before. * Document Edition History:: Changes in this document. * Index:: Index of protocol elements.  David Byers committed Jan 13, 1996 416 417 @end menu  Per Cederqvist committed Aug 10, 2002 418 419 420 421 422 423 424 425 @ifnottex @node About this document @chapter About this document @insertcopying @end ifnottex  Per Cederqvist committed May 22, 2001 426 @ifnottex  Per Cederqvist committed May 01, 2001 427 428 @node Preface @chapter Preface  Per Cederqvist committed May 22, 2001 429 @end ifnottex  Per Cederqvist committed Apr 16, 2001 430   David Byers committed Jan 13, 1996 431 LysKOM is a conferencing system@footnote{Or in modern terms, enabling  Per Cederqvist committed May 05, 2001 432 technology for Computer-Supported Cooperative Work (CSCW).}. Similar  David Byers committed Sep 13, 1997 433 systems were QZ-KOM and PortaCOM@footnote{Also known as PottaKOM'' and  Per Cederqvist committed May 05, 2001 434 BortaKOM.''}. The LysKOM system is copyrighted by Lysator Academic  David Byers committed Sep 13, 1997 435 Computing Society and distributed under conditions of the GNU Public  Per Cederqvist committed May 05, 2001 436 License. LysKOM and its documentation is provided as is'' without  David Byers committed Sep 13, 1997 437 warranty of any kind.  David Byers committed Jan 13, 1996 438   Per Cederqvist committed Apr 16, 2001 439 440 Anything described here as unspecified'' is liable to change in future protocol versions.  David Byers committed Jan 13, 1996 441   Per Cederqvist committed May 05, 2001 442 This specification is the work of several people. The main contributors have  David Byers committed Sep 13, 1997 443 been  Per Cederqvist committed May 05, 2001 444 Per Cederqvist @email{ceder@@lysator.liu.se},  David Byers committed May 23, 1999 445 David Byers @email{byers@@lysator.liu.se},  Per Cederqvist committed May 01, 2001 446 @value{Pell} @email{pell@@lysator.liu.se},  Per Cederqvist committed May 05, 2001 447 Thomas Bellman @email{bellman@@lysator.liu.se},  David Byers committed May 23, 1999 448 449 Lars Aronsson @email{aronsson@@lysator.liu.se}, Linus Tolke @email{linus@@lysator.liu.se} and  Per Cederqvist committed May 01, 2001 450 @value{Kent} @email{kent@@lysator.liu.se}.  David Byers committed Jan 13, 1996 451   David Byers committed May 23, 1999 452 The LysKOM developers can be reached by email to  Per Cederqvist committed Jul 22, 2002 453 454 @email{lyskom@@lysator.liu.se}. If you find any errors in this document, please report them at  Per Cederqvist committed Aug 01, 2002 455 456 @uref{http://bugzilla.lysator.liu.se/}. Use @samp{lyskomd} as the product, and @samp{documentation} as component.  David Byers committed Jan 13, 1996 457   Per Cederqvist committed May 01, 2001 458 459 @node Concepts @chapter Concepts used in LysKOM  David Byers committed Jan 13, 1996 460 461  This chapter introduces the concepts used in LysKOM, such as articles,  Per Cederqvist committed May 05, 2001 462 conferences and sessions.  David Byers committed Jan 13, 1996 463 464  @menu  Per Cederqvist committed May 16, 2001 465 466 467 468 469 470 471 472 473 474 * Articles:: Reading and writing articles is what LysKOM is about. * Conferences:: Articles are organized in conferences. * Persons and Sessions:: Persons log on to the LysKOM system. * The Misc-Info List:: How articles are organized in comment chains and in conferences. * The Aux-Item List:: A generic extension mechanism. * Security:: Some persons have more privileges than others. * Membership and Reading:: You don't have to read anything twice.  David Byers committed Jan 13, 1996 475 476 477 @end menu  Per Cederqvist committed May 23, 1999 478 @node Articles  David Byers committed Jan 13, 1996 479 480 @section Articles  Per Cederqvist committed Apr 16, 2001 481 An article is represented as a value of the type @type{Text-Stat} and a  Per Cederqvist committed May 05, 2001 482 string containing the article contents. An article will usually have one  David Byers committed Sep 13, 1997 483 484 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 485 @field{nice} value of each of its recipients and it is not marked by any  David Byers committed Sep 13, 1997 486 user.  David Byers committed Jan 13, 1996 487   Per Cederqvist committed May 01, 2001 488 489 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 490 senders, comments and footnotes.  David Byers committed Jan 13, 1996 491   Per Cederqvist committed May 01, 2001 492 493 494 495 496 497 498 499 500 501 502 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 503   David Byers committed Sep 13, 1997 504 Occasionally it is necessary to map between local and global numbers.  Per Cederqvist committed May 01, 2001 505 The server call @reqdlink{local-to-global} does this@linkhere{}.  David Byers committed Jan 13, 1996 506 507 508   Per Cederqvist committed May 23, 1999 509 @node Conferences  David Byers committed Jan 13, 1996 510 511 @section Conferences  Per Cederqvist committed May 05, 2001 512 513 Conferences hold articles. They are represented in the protocol as a data type called @type{Conference}. Each conference has a  Per Cederqvist committed Apr 16, 2001 514 515 @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 516 If the supervisor is a person, the members of that person's mailbox  Per Cederqvist committed Dec 30, 2001 517 518 519 520 521 522 523 524 525 526 527 528 are supervisors, which in most cases is only that person. Persons are a special case: in addition to those who are supervisors for a certain person because of the @field{supervisor} field, the person is always a supervisor of himself. There is one exception to this special case: the person cannot use @reqlink{set-supervisor} to change who is his supervisor. We have also introduced a type called @type{UConference} (pronounced micro-conf-stat) which holds a subset of the information contained in the full @type{Conference} type. Use the @type{UConference} type whenever possible since it places a much smaller load on the LysKOM server.  David Byers committed Jan 13, 1996 529   Per Cederqvist committed Apr 16, 2001 530 Each conference has a type, which is essentially a collection of  Per Cederqvist committed May 05, 2001 531 boolean flags. Currently the flags @conftype{rd-prot},  Per Cederqvist committed Apr 16, 2001 532 533 @conftype{letterbox}, @conftype{secret}, @conftype{original}, @conftype{allow-anonymous} and @conftype{forbid-secret} are defined.  David Byers committed Jan 13, 1996 534   Per Cederqvist committed Apr 16, 2001 535 @table @conftype  David Byers committed Jan 13, 1996 536 @item rd-prot  Per Cederqvist committed May 05, 2001 537 The conference is protected from reading by non-members. Persons become  David Byers committed Jan 13, 1996 538 members by having one of the existing members or supervisors add him or  Per Cederqvist committed May 05, 2001 539 her to the conference. This restriction is enforced by the server.  David Byers committed Jan 13, 1996 540 @item original  David Byers committed Sep 13, 1997 541 Conferences of this type are intended for original articles only.  Per Cederqvist committed Dec 21, 2001 542 543 544 545 Comments are to be redirected to the @field{super-conf} instead. This restriction is not enforced by the server; clients must implement this functionality. (@xref{Recipients of comments}, for a summary of how a client should select the recipients of a comment.)  David Byers committed Jan 13, 1996 546 @item letterbox  Per Cederqvist committed May 05, 2001 547 Conferences of this type are connected to persons. Letters to a person  David Byers committed Dec 26, 1998 548 are sent to the mailbox and the name of the mailbox is synchronized  Per Cederqvist committed May 05, 2001 549 with the person name. It is currently not possible to explicitly set or  David Byers committed Sep 13, 1997 550 clear this flag on a conference.  David Byers committed Jan 13, 1996 551 @item secret  Per Cederqvist committed May 05, 2001 552 Conferences of this type are secret. The server will not divulge any  Kent Engström committed Jul 07, 1999 553 information about the existence of the conference to persons who are not  Per Cederqvist committed May 05, 2001 554 members or supervisors of the conference. If a mailbox is made secret,  David Byers committed Jan 13, 1996 555 556 that person cannot log in using the person name, but must specify a person number instead.  David Byers committed Sep 13, 1997 557 @item allow-anonymous  Per Cederqvist committed May 05, 2001 558 Conferences of this type accept anonymous articles. Other conferences  David Byers committed Sep 13, 1997 559 will reject anonymous articles.  David Byers committed Dec 26, 1998 560 @item forbid-secret  Per Cederqvist committed May 05, 2001 561 Conferences of this type do not allow secret members. If a conference is  David Byers committed Dec 26, 1998 562 changed to this type, preexisting secret members remain secret.  David Byers committed Jan 13, 1996 563 564 565 566 @end table  Per Cederqvist committed May 23, 1999 567 @node Persons and Sessions  Per Cederqvist committed May 01, 2001 568 @section Persons and Sessions  David Byers committed Jan 13, 1996 569 570  Persons are represented in the protocol by values of the type  Per Cederqvist committed May 05, 2001 571 572 @type{Person}. Associated with persons are statistics, a set of personal flags and a set of privileges (@pxref{Security}). Persons are also  David Byers committed Sep 13, 1997 573 associated with a conference that has the same number as the person and  Per Cederqvist committed Apr 16, 2001 574 the @conftype{letterbox} bit set.  David Byers committed Jan 13, 1996 575 576  Connections to the server are represented as values of the type  Per Cederqvist committed Apr 16, 2001 577 @type{Static-Session-Info}, @type{Session-Info-Ident} or  Per Cederqvist committed May 05, 2001 578 579 580 @type{Session-Info}. Sessions have session number that are unique for each session in the lifetime of the server execution. A single user can have several sessions running at once. The session is not released until  David Byers committed Sep 13, 1997 581 582 the network connection is closed; a user can log in and out repeatedly in a single session.  David Byers committed Jan 13, 1996 583 584   Per Cederqvist committed May 23, 1999 585 @node The Misc-Info List  David Byers committed Jan 13, 1996 586 587 @section The Misc-Info List  Per Cederqvist committed May 05, 2001 588 The @type{Misc-Info} list contains tagged data. The fields are sent in  David Byers committed Sep 13, 1997 589 groups pertaining to a particular type of information: information about  Per Cederqvist committed Oct 06, 1998 590 591 recipient; carbon copy recipient; blank carbon copy recipient; comment to; footnote to; comment in  Per Cederqvist committed May 05, 2001 592 593 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  David Byers committed Sep 13, 1997 594 always sent in the order listed below.  David Byers committed Jan 13, 1996 595   David Byers committed Jun 14, 1996 596 @subsection Recipient  David Byers committed Jan 13, 1996 597   Per Cederqvist committed Apr 16, 2001 598 @table @misc  David Byers committed Jan 13, 1996 599 @item recpt  Per Cederqvist committed May 05, 2001 600 Starts a recipient group. It contains the conference number of a  David Byers committed Sep 13, 1997 601 recipient of the article.  David Byers committed Jan 13, 1996 602 @item loc-no  Per Cederqvist committed May 05, 2001 603 Always present within a recipient group. It contains the local text  David Byers committed Sep 13, 1997 604 number of the article in the conference specified by the preceding  Per Cederqvist committed Apr 16, 2001 605 @misc{recpt} field.  David Byers committed Jan 13, 1996 606 @item rec-time  David Byers committed Sep 13, 1997 607 If the recipient is a person, this element is added by the server when  Per Cederqvist committed May 05, 2001 608 the recipient marks the article as read. It contains the time when the  David Byers committed Sep 13, 1997 609 text was read.  David Byers committed Jan 13, 1996 610 @item sent-by  David Byers committed Sep 13, 1997 611 612 613 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 614 @item sent-at  Per Cederqvist committed May 05, 2001 615 Present when the recipient was added after the article was created. It  David Byers committed Sep 13, 1997 616 contains the time when the recipient was added.  David Byers committed Jan 13, 1996 617 618 619 @end table  David Byers committed Jun 14, 1996 620 @subsection Carbon Copy (CC) Recipient  David Byers committed Jan 13, 1996 621   David Byers committed Sep 13, 1997 622 The carbon-copy recipient group is identical to the recipient group  Per Cederqvist committed May 05, 2001 623 624 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  David Byers committed Sep 13, 1997 625 all recipients, but not to carbon-copy recipients of the original  Per Cederqvist committed May 05, 2001 626 article. This difference is enforced by the clients.  David Byers committed Jan 13, 1996 627   Per Cederqvist committed Apr 16, 2001 628 @table @misc  David Byers committed Jan 13, 1996 629 @item cc-recpt  Per Cederqvist committed May 05, 2001 630 Starts a carbon-copy recipient group. It contains the conference number  David Byers committed Sep 13, 1997 631 of a carbon-copy recipient of the article.  David Byers committed Jan 13, 1996 632 @item loc-no  Per Cederqvist committed May 05, 2001 633 Always present in a CC recipient group. It contains the local text  David Byers committed Sep 13, 1997 634 number of the article in the conference specified by the most recent  Per Cederqvist committed Apr 16, 2001 635 @misc{cc-recpt} field.  David Byers committed Jan 13, 1996 636 @item rec-time  Per Cederqvist committed May 05, 2001 637 638 Present after the CC recipient has read the article. It contains the time when the article was read. Since only persons can read articles  Per Cederqvist committed Oct 06, 1998 639 this will only be seen if the CC recipient is a person.  David Byers committed Jan 13, 1996 640 641 @item sent-by Present when a CC recipient was added by a person other than the author  Per Cederqvist committed May 05, 2001 642 after the article had been created. It contains the person number of the  Per Cederqvist committed Oct 06, 1998 643 person who added the CC recipient.  David Byers committed Jan 13, 1996 644 645 @item sent-at Present when a CC recipient was added after the article had been  Per Cederqvist committed May 05, 2001 646 created. It is the time when the CC recipient was added.  David Byers committed Jan 13, 1996 647 648 649 @end table  Per Cederqvist committed Oct 06, 1998 650 651 652 @subsection Blank Carbon Copy (BCC) Recipient The blank carbon-copy recipient group is identical to the carbon-copy  Per Cederqvist committed May 05, 2001 653 654 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 655 allowed to fetch both the text status of the involved text and the  Per Cederqvist committed Oct 06, 1998 656 conference status of the involved conference. (That is, as long as the  Kent Engström committed Jul 07, 1999 657 conference isn't secret everybody is allowed to see the carbon-copy  Per Cederqvist committed Oct 06, 1998 658 659 recipient group.)  Per Cederqvist committed Sep 06, 2000 660 661 662 663 664 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 665 666  This type of group was introduced in protocol version 10. When  Per Cederqvist committed Apr 28, 2001 667 old-style calls such as @reqlink{get-text-stat-old}  Kent Engström committed Jul 07, 1999 668 are used this will be converted to a CC recipient group by the server  Per Cederqvist committed May 01, 2001 669 670 671 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 672   Per Cederqvist committed Apr 16, 2001 673 @table @misc  Per Cederqvist committed Oct 06, 1998 674 @item bcc-recpt  Per Cederqvist committed May 05, 2001 675 Starts a blank carbon-copy recipient group. It contains the conference  Per Cederqvist committed Oct 06, 1998 676 677 number of a blank carbon-copy recipient of the article. @item loc-no  Per Cederqvist committed May 05, 2001 678 Always present in a BCC recipient group. It contains the local text  Per Cederqvist committed Oct 06, 1998 679 number of the article in the conference specified by the most recent  Per Cederqvist committed Apr 16, 2001 680 @misc{bcc-recpt} field.  Per Cederqvist committed Oct 06, 1998 681 @item rec-time  Per Cederqvist committed May 05, 2001 682 683 Present after the BCC recipient has read the article. It contains the time when the article was read. Since only persons can read articles  Per Cederqvist committed Oct 06, 1998 684 685 686 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  Per Cederqvist committed May 05, 2001 687 after the article had been created. It contains the person number of the  Per Cederqvist committed Oct 06, 1998 688 689 690 person who added the BCC recipient. @item sent-at Present when a BCC recipient was added after the article had been  Per Cederqvist committed May 05, 2001 691 created. It is the time when the BCC recipient was added.  Per Cederqvist committed Oct 06, 1998 692 693 694 @end table  David Byers committed Jun 14, 1996 695 @subsection Comment To  David Byers committed Jan 13, 1996 696   Per Cederqvist committed Apr 16, 2001 697 @table @misc  David Byers committed Jan 13, 1996 698 699 700 701 @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  Per Cederqvist committed May 05, 2001 702 the author, after the article had been created. It contains the person  David Byers committed Jan 13, 1996 703 704 705 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  Per Cederqvist committed May 05, 2001 706 been created. It contains the time when it was added as a comment.  David Byers committed Jan 13, 1996 707 708 709 @end table  David Byers committed Jun 14, 1996 710 @subsection Footnote To  David Byers committed Jan 13, 1996 711   Per Cederqvist committed Apr 16, 2001 712 @table @misc  David Byers committed Sep 13, 1997 713 @item footn-to  David Byers committed Jan 13, 1996 714 715 716 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  Per Cederqvist committed May 05, 2001 717 been created. It contains the time when it was added as a footnote.  David Byers committed Jan 13, 1996 718 719 720 @end table  David Byers committed Jun 14, 1996 721 @subsection Comment in  David Byers committed Jan 13, 1996 722   Per Cederqvist committed Apr 16, 2001 723 @table @misc  David Byers committed Jan 13, 1996 724 @item comm-in  Per Cederqvist committed May 05, 2001 725 Present when there are comments to this article. It contains the article  David Byers committed Jan 13, 1996 726 727 728 729 number which is a comment to this article. @end table  David Byers committed Jun 14, 1996 730 @subsection Footnote in  David Byers committed Jan 13, 1996 731   Per Cederqvist committed Apr 16, 2001 732 @table @misc  David Byers committed Sep 13, 1997 733 @item footn-in  Per Cederqvist committed May 05, 2001 734 Present when there are footnotes to this article. It contains the  David Byers committed Jan 13, 1996 735 736 737 738 article number which is a footnote to this article. @end table  Per Cederqvist committed May 23, 1999 739 @node The Aux-Item List  Per Cederqvist committed Apr 04, 1999 740 @section The Aux-Item List  David Byers committed Sep 13, 1997 741 742  The aux-item list is used as a generic extension mechanism in the LysKOM  Per Cederqvist committed May 05, 2001 743 server and in protocol A.  David Byers committed Sep 13, 1997 744 745  @menu  Per Cederqvist committed May 16, 2001 746 * About Aux-Items:: An introduction to aux-items.  Per Cederqvist committed Aug 19, 2003 747 * Aux-Item Inheritance:: Comments can inherit aux items.  Per Cederqvist committed May 16, 2001 748 749 750 751 752 753 * Predefined Aux-Item Types:: Predefined aux-items are part of the protocol. * Client-Specific Aux-Item Types:: Clients can allocate aux-items for their private use. * Experimental Aux-Item Types:: A block of aux-items are reserved for experimental use. * Defining New Aux-Item Types:: Creating new aux-item types is easy.  David Byers committed Sep 13, 1997 754 755 @end menu  Per Cederqvist committed May 23, 1999 756 @node About Aux-Items  Per Cederqvist committed Apr 04, 1999 757 @subsection About Aux-Items  David Byers committed Sep 13, 1997 758 759 760  Aux-items were introduced in protocol version 10 as a mechanism for extending the conference, text and server information structures without  Per Cederqvist committed Aug 19, 2003 761 762 changing the protocol. (There is no need for aux-items on persons -- just add an aux-item to the corresponding mailbox.)  David Byers committed Sep 13, 1997 763   Per Cederqvist committed Apr 28, 2001 764 The exact structure of an aux item is specified elsewhere  Per Cederqvist committed May 05, 2001 765 (@pxref{Auxiliary Information}). The important fields here are the  Per Cederqvist committed Apr 28, 2001 766 @field{aux-no}, @field{tag} and @field{data} fields.  David Byers committed Sep 13, 1997 767   Per Cederqvist committed May 05, 2001 768 The @field{aux-no} field is used to identify an item. The  Per Cederqvist committed Apr 28, 2001 769 770 @field{aux-no} together with a text or conference number uniquely identifies a particular aux item. Items are numbered from one and up  Per Cederqvist committed May 05, 2001 771 772 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  Per Cederqvist committed Apr 28, 2001 773 have never been used before within a particular list.  David Byers committed Sep 13, 1997 774   Per Cederqvist committed May 05, 2001 775 The @field{tag} field identifies the type of aux item. It is used by  Per Cederqvist committed Apr 28, 2001 776 777 778 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 779   Per Cederqvist committed May 05, 2001 780 The @field{data} field is a simple string. The meaning of the string  Per Cederqvist committed Apr 28, 2001 781 782 783 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 784 785 786   Per Cederqvist committed Aug 19, 2003 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 @node Aux-Item Inheritance @subsection Aux-Item Inheritance An aux item that is placed on a text can be inherited. This means that if a comment or footnote to the text is created, an almost identical item will be created on the new text. The @field{tag}, @field{creator}, @field{flags} and @field{data} field will be inherited unchanged. The @field{aux-no} might be given a different value. A non-zero @field{inherit-limit} field will be decremented. The @field{created-at} timestamp will be set to the time when the new comment or footnote is created. Inheritance only happens at text creation time. If a comment or footnote link is added later with @reqlink{add-comment} or @reqlink{add-footnote}, no items will be inherited. Also, if the link  Per Cederqvist committed Aug 20, 2003 802 is removed (via @reqlink{sub-comment} or @reqlink{sub-footnote}), the  Per Cederqvist committed Aug 19, 2003 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 inherited items will still be in place. Inheritance only happens when the @field{inherit} bit is set, and if @field{inherit-limit} is 0 or greater than 1. @xref{Auxiliary Information}, for more information. Inheritance has no meaning for items placed on the server or on a conference. It is possible for a predefined aux-item to behave in a way that isn't consistent with the description in this section. The documentation for the specific aux-item should document any deviations.  Per Cederqvist committed May 23, 1999 818 @node Predefined Aux-Item Types  Per Cederqvist committed Apr 04, 1999 819 @subsection Predefined Aux-Item Types  David Byers committed Sep 13, 1997 820   David Byers committed May 12, 1999 821 Predefined Aux-Item types are part of Protocol A, and clients should  Per Cederqvist committed May 05, 2001 822 support all of them. As with other parts of the protocol, changes to  David Byers committed May 12, 1999 823 these definitions will be made backwards-compatible, if possible.  David Byers committed Sep 13, 1997 824   David Byers committed May 12, 1999 825 Creation and deletion of items with a predefined type can cause  Per Cederqvist committed May 13, 2001 826 arbitrarily complex and wondrous behavior in the server. Furthermore,  David Byers committed May 12, 1999 827 the server may place constraints on the items with regard to content,  Kent Engström committed Jul 07, 1999 828 flags, who can create them, to what objects they can be attached and  Per Cederqvist committed May 05, 2001 829 so forth. The server may also silently enforce specific values for any  David Byers committed May 12, 1999 830 field of an item, regardless of what the client requests.  David Byers committed Sep 13, 1997 831   Per Cederqvist committed Aug 08, 1998 832 All items with tags in the range 1-9999 and 30000 and up are considered  Per Cederqvist committed May 05, 2001 833 predefined. If a client attempts to create an item with a tag in this  David Byers committed Sep 13, 1997 834 range, but the server has no idea what that tag means, the server will  Per Cederqvist committed May 24, 2001 835 return an error (@errorcode{illegal-aux-item}).  David Byers committed Sep 13, 1997 836   Per Cederqvist committed May 09, 2001 837 838 839 840 841 842 843 844 Some items with tags in the range 10000-19999 are also predefined. They are items that initially were reserved for private use for a specific client, but where it was later discovered that the tag was generally useful. They should ideally have been assigned a number in the 1-9999 range from the beginning, but if they already have a widespread use they can be redefined to be predefined. Such redefinition will always be made in cooperation with the client writer.  David Byers committed Sep 13, 1997 845   Per Cederqvist committed May 24, 2001 846 847 848 @xref{Aux-Item Types}, for the complete list of predefined Aux-Item types.  Per Cederqvist committed May 01, 2001 849 850 @node Client-Specific Aux-Item Types @subsection Client-Specific Aux-Item Types  David Byers committed Sep 13, 1997 851   Per Cederqvist committed May 05, 2001 852 Client-specific items do not cause the server to perform any magic. All  Per Cederqvist committed May 01, 2001 853 the flags (except the delete flag) are left untouched, the data is not  Per Cederqvist committed May 05, 2001 854 validated in any way, and anyone can create any item. If you need more  Per Cederqvist committed May 01, 2001 855 server support than this, your item should be on the predefined list.  David Byers committed Sep 13, 1997 856   Per Cederqvist committed May 05, 2001 857 858 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  Per Cederqvist committed May 01, 2001 859 should never create items with tags in a range assigned to another  Per Cederqvist committed May 09, 2001 860 861 862 client or in an unassigned range. Assigned ranges will never change, except that specific aux-items may be redefined as predefined, as explained in @ref{Predefined Aux-Item Types}.  David Byers committed Sep 13, 1997 863   Per Cederqvist committed May 01, 2001 864 865 866 867 Currently, the following ranges are assigned to clients: @itemize @bullet @item 10000-10099: The Elisp Client @item 10100-10199: komimportmail  Per Cederqvist committed Aug 16, 2003 868 @item 10200-10299: Private test use (should never be used on a public server)  Per Cederqvist committed May 01, 2001 869 @end itemize  David Byers committed Sep 13, 1997 870   Per Cederqvist committed May 01, 2001 871 If you want a range of numbers, send e-mail to the LysKOM development  Per Cederqvist committed Aug 16, 2003 872 group, or request it via Bugzilla.  David Byers committed Sep 13, 1997 873   Per Cederqvist committed May 01, 2001 874 875 @node Experimental Aux-Item Types @subsection Experimental Aux-Item Types  David Byers committed Sep 13, 1997 876   Per Cederqvist committed May 13, 2001 877 878 Experimental numbers are free for all. Use @badspell{'em} any way you want. All  Per Cederqvist committed May 05, 2001 879 numbers in the range 20000-29999 are for experimental use.  David Byers committed Sep 13, 1997 880 881 882   Per Cederqvist committed May 01, 2001 883 884 @node Defining New Aux-Item Types @subsection Defining New Aux-Item Types  David Byers committed Sep 13, 1997 885   Per Cederqvist committed May 01, 2001 886 887 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  Per Cederqvist committed May 05, 2001 888 889 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 890   Per Cederqvist committed May 01, 2001 891