Protocol-A.texi 384 KB
Newer Older
David Byers's avatar
David Byers committed
1
\input texinfo                         @c -*-texinfo-*-
David Byers's avatar
David Byers committed
2
@c
3
@c FIXME (bug 194): Explain how the garb works with nice and keep-commented
David Byers's avatar
David Byers committed
4
@c
David Byers's avatar
David Byers committed
5 6 7 8
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
9 10
@c @afourpaper

Per Cederqvist's avatar
Per Cederqvist committed
11 12 13
@set PROTOEDITION 11.0
@set PROTOVER 11
@set VERSION 2.1.0
David Byers's avatar
David Byers committed
14

15 16


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


25
@c
26
@c Define a few strings that contains characters from ISO Latin-1.
27
@c
28 29 30

@iftex

31
@c ispell-ignore
32
@set IAM Inl@"agg @}t mig
33 34
@set Pell P@"ar Emanuelsson
@set Kent Kent Eng@-str@"om@penalty-10000
35 36
@set presconf @holl{27,Presentation (av nya) m@"oten}
@c ispell-end-ignore
37 38 39 40

@end iftex
@ifnottex

41
@c ispell-ignore
42 43 44
@set IAM Inlägg @}t mig
@set Pell Pär Emanuelsson
@set Kent Kent Engström
45 46
@set presconf @holl{27,Presentation (av nya) möten}
@c ispell-end-ignore
47 48 49

@end ifnottex

50 51 52 53
@c
@c Index setup
@c

54 55 56 57 58 59
@c Index for asynchronous messages.
@defcodeindex am

@c Merge all indices.
@syncodeindex am fn
@syncodeindex tp fn
60
@syncodeindex cp fn
61

62 63 64


@c
65
@c Special markup for this document.
66 67
@c

68 69 70 71 72
@c Indicate something that shouldn't be spell-checked
@macro badspell{s}
\s\
@end macro

73
@c @req{login} is used for protocol requests.
74

75 76 77 78
@macro req {n}
@code{\n\}
@end macro

79
@c @reqlink{login} is used for protocol requests, that should be linked.
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
94
@c should be linked, where the link should occur a few words after the
95 96 97 98 99 100
@c request itself.

@ifhtml

@c HTML version: make the word a link.
@macro reqdlink {n}
101
@code{@ref{\n\}}
102 103 104 105 106 107 108 109 110 111
@unmacro linkhere
@macro linkhere
@end macro
@end macro

@end ifhtml

@ifnothtml
@ifnottex

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

@macro reqdlink {n}
115
@code{\n\}
116 117 118 119 120 121
@unmacro linkhere
@macro linkhere
(@pxref{\n\})
@end macro
@end macro
@end ifnottex
122

123 124
@iftex

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

127
@c ispell-ignore
128 129 130 131 132 133
@tex
    \gdef\reqdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
134
@c ispell-end-ignore
135 136 137
@end iftex
@end ifnothtml

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

148
@c @asynclink{async-login} is used for async names, that should be linked.
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,
163
@c that should be linked, where the link should occur a few words after
164 165 166 167 168 169
@c the async name itself.

@ifhtml

@c HTML version: make the word a link.
@macro asyncdlink {n}
170
@code{@ref{\n\}}
171 172 173 174 175 176 177 178 179 180
@unmacro linkhere
@macro linkhere
@end macro
@end macro

@end ifhtml

@ifnothtml
@ifnottex

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

@macro asyncdlink {n}
184
@code{\n\}
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.

196
@c ispell-ignore
197 198 199 200 201 202
@tex
    \gdef\asyncdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
203
@c ispell-end-ignore
204 205 206
@end iftex
@end ifnothtml

207 208 209 210 211
@c @type{Conference} is used for LysKOM types.
@macro type {n}
@code{\n\}
@end macro

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}
218
@ref{\n\}
219 220 221 222 223
@end macro
@end ifhtml

@ifnothtml
@macro lt {n}
224
\n\
225 226 227
@end macro
@end ifnothtml

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

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

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


282 283
@c %**end of header

284
@copying
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's avatar
David Byers committed
288

289
Copyright @copyright{} 1995-2003 Lysator ACS.
David Byers's avatar
David Byers committed
290

291
@quotation
David Byers's avatar
David Byers committed
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.
295

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).
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.
309 310
@end quotation
@end copying
David Byers's avatar
David Byers committed
311

312
@c ispell-ignore
313
@iftex
Per Cederqvist's avatar
Per Cederqvist committed
314 315
@c
@c Don't indent the first line of paragraphs.
316
@parindent 0pt
Per Cederqvist's avatar
Per Cederqvist committed
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:
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's avatar
Per Cederqvist committed
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
337
@tex
338
\global\font\tensltt=cmsltt10
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
344
@c ispell-end-ignore
345

David Byers's avatar
David Byers committed
346 347
@titlepage
@title{LysKOM Protocol A}
348 349 350
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
351 352 353
@author by the LysKOM Developers

@page
354
@c ispell-ignore
David Byers's avatar
David Byers committed
355
@vskip 0pt plus 1filll
356
@c ispell-end-ignore
357
@insertcopying
David Byers's avatar
David Byers committed
358 359

@end titlepage
360 361 362
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
363

364 365 366 367 368
@dircategory LysKOM
@direntry
* Protocol A: (protocol-a).             The LysKOM Protocol A specification.
@end direntry

369
@c ispell-ignore
370 371 372 373 374 375 376 377 378 379 380 381
@ifhtml
@html
<a href="http://www.lysator.liu.se/" ><img
src="http://www.lysator.liu.se/icons/lyslogo.gif" alt="Lysator"
width=40 border=0 height=40 align=left ></a>

<a href="http://www.lysator.liu.se/lyskom/" ><img
src="http://www.lysator.liu.se/icons/lyskom.gif" alt="LysKOM" width=40
border=0 height=40 align=left ></a>
<br clear=all>
@end html
@end ifhtml
382
@c ispell-end-ignore
383

384
@node Top
385
@top LysKOM Protocol A
386

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.

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

@menu
395
* About this document::         Copyright information.
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.
400
* Protocol Requests::           Each request explained in depth.
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.
407
* Membership visibility::       How the security features interacts.
Per Cederqvist's avatar
Per Cederqvist committed
408
* Measured Properties::         Load average, number of processed requests...
409 410
* Writing Clients::             A few tips for client writers.
* Importing and Exporting E-Mail::  A few thoughts on e-mail integration.
411
* Some Client-specific Aux-Item Types::  Informative info about more aux-items.
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's avatar
David Byers committed
416 417
@end menu

418 419 420 421 422 423 424 425
@ifnottex
@node About this document
@chapter About this document

@insertcopying

@end ifnottex

426
@ifnottex
427 428
@node Preface
@chapter Preface
429
@end ifnottex
430

David Byers's avatar
David Byers committed
431
LysKOM is a conferencing system@footnote{Or in modern terms, enabling
432
technology for Computer-Supported Cooperative Work (CSCW).}.  Similar
433
systems were QZ-KOM and PortaCOM@footnote{Also known as ``PottaKOM'' and
434
``BortaKOM.''}.  The LysKOM system is copyrighted by Lysator Academic
435
Computing Society and distributed under conditions of the GNU Public
436
License.  LysKOM and its documentation is provided ``as is'' without
437
warranty of any kind.
David Byers's avatar
David Byers committed
438

439 440
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
441

442
This specification is the work of several people.  The main contributors have
443
been
444
Per Cederqvist @email{ceder@@lysator.liu.se},
David Byers's avatar
David Byers committed
445
David Byers @email{byers@@lysator.liu.se},
446
@value{Pell} @email{pell@@lysator.liu.se},
447
Thomas Bellman @email{bellman@@lysator.liu.se},
David Byers's avatar
David Byers committed
448 449
Lars Aronsson @email{aronsson@@lysator.liu.se},
Linus Tolke @email{linus@@lysator.liu.se} and
450
@value{Kent} @email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
451

David Byers's avatar
David Byers committed
452
The LysKOM developers can be reached by email to
453 454
@email{lyskom@@lysator.liu.se}.  If you find any errors in this
document, please report them at
Per Cederqvist's avatar
Per Cederqvist committed
455 456
@uref{http://bugzilla.lysator.liu.se/}.  Use @samp{lyskomd} as the
product, and @samp{documentation} as component.
David Byers's avatar
David Byers committed
457

458 459
@node Concepts
@chapter Concepts used in LysKOM
David Byers's avatar
David Byers committed
460 461

This chapter introduces the concepts used in LysKOM, such as articles,
462
conferences and sessions.
David Byers's avatar
David Byers committed
463 464

@menu
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's avatar
David Byers committed
475 476 477
@end menu


478
@node Articles
David Byers's avatar
David Byers committed
479 480
@section Articles

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

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

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's avatar
David Byers committed
503

504
Occasionally it is necessary to map between local and global numbers.
505
The server call @reqdlink{local-to-global} does this@linkhere{}.
David Byers's avatar
David Byers committed
506 507 508



509
@node Conferences
David Byers's avatar
David Byers committed
510 511
@section Conferences

512 513
Conferences hold articles.  They are represented in the protocol as a
data type called @type{Conference}.  Each conference has a
514 515
@dfn{creator}, the person who created the conference, and a
@dfn{supervisor}, a conference whose members can modify the conference.
David Byers's avatar
David Byers committed
516
If the supervisor is a person, the members of that person's mailbox
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's avatar
David Byers committed
529

530
Each conference has a type, which is essentially a collection of
531
boolean flags.  Currently the flags @conftype{rd-prot},
532 533
@conftype{letterbox}, @conftype{secret}, @conftype{original},
@conftype{allow-anonymous} and @conftype{forbid-secret} are defined.
David Byers's avatar
David Byers committed
534

535
@table @conftype
David Byers's avatar
David Byers committed
536
@item rd-prot
537
The conference is protected from reading by non-members.  Persons become
David Byers's avatar
David Byers committed
538
members by having one of the existing members or supervisors add him or
539
her to the conference.  This restriction is enforced by the server.
David Byers's avatar
David Byers committed
540
@item original
541
Conferences of this type are intended for original articles only.
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's avatar
David Byers committed
546
@item letterbox
547
Conferences of this type are connected to persons.  Letters to a person
David Byers's avatar
David Byers committed
548
are sent to the mailbox and the name of the mailbox is synchronized
549
with the person name.  It is currently not possible to explicitly set or
550
clear this flag on a conference.
David Byers's avatar
David Byers committed
551
@item secret
552
Conferences of this type are secret.  The server will not divulge any
553
information about the existence of the conference to persons who are not
554
members or supervisors of the conference.  If a mailbox is made secret,
David Byers's avatar
David Byers committed
555 556
that person cannot log in using the person name, but must specify a
person number instead.
557
@item allow-anonymous
558
Conferences of this type accept anonymous articles.  Other conferences
559
will reject anonymous articles.
David Byers's avatar
David Byers committed
560
@item forbid-secret
561
Conferences of this type do not allow secret members.  If a conference is
David Byers's avatar
David Byers committed
562
changed to this type, preexisting secret members remain secret.
David Byers's avatar
David Byers committed
563 564 565 566
@end table



567
@node Persons and Sessions
568
@section Persons and Sessions
David Byers's avatar
David Byers committed
569 570

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

Connections to the server are represented as values of the type
577
@type{Static-Session-Info}, @type{Session-Info-Ident} or
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
581 582
the network connection is closed; a user can log in and out repeatedly
in a single session.
David Byers's avatar
David Byers committed
583 584


585
@node The Misc-Info List
David Byers's avatar
David Byers committed
586 587
@section The Misc-Info List

588
The @type{Misc-Info} list contains tagged data.  The fields are sent in
589
groups pertaining to a particular type of information: information about
590 591
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
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
594
always sent in the order listed below.
David Byers's avatar
David Byers committed
595

596
@subsection Recipient
David Byers's avatar
David Byers committed
597

598
@table @misc
David Byers's avatar
David Byers committed
599
@item recpt
600
Starts a recipient group.  It contains the conference number of a
601
recipient of the article.
David Byers's avatar
David Byers committed
602
@item loc-no
603
Always present within a recipient group.  It contains the local text
604
number of the article in the conference specified by the preceding
605
@misc{recpt} field.
David Byers's avatar
David Byers committed
606
@item rec-time
607
If the recipient is a person, this element is added by the server when
608
the recipient marks the article as read.  It contains the time when the
609
text was read.
David Byers's avatar
David Byers committed
610
@item sent-by
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's avatar
David Byers committed
614
@item sent-at
615
Present when the recipient was added after the article was created.  It
616
contains the time when the recipient was added.
David Byers's avatar
David Byers committed
617 618 619
@end table


620
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
621

622
The carbon-copy recipient group is identical to the recipient group
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
625
all recipients, but not to carbon-copy recipients of the original
626
article.  This difference is enforced by the clients.
David Byers's avatar
David Byers committed
627

628
@table @misc
David Byers's avatar
David Byers committed
629
@item cc-recpt
630
Starts a carbon-copy recipient group.  It contains the conference number
631
of a carbon-copy recipient of the article.
David Byers's avatar
David Byers committed
632
@item loc-no
633
Always present in a CC recipient group.  It contains the local text
634
number of the article in the conference specified by the most recent
635
@misc{cc-recpt} field.
David Byers's avatar
David Byers committed
636
@item rec-time
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
639
this will only be seen if the CC recipient is a person.
David Byers's avatar
David Byers committed
640 641
@item sent-by
Present when a CC recipient was added by a person other than the author
642
after the article had been created.  It contains the person number of the
643
person who added the CC recipient.
David Byers's avatar
David Byers committed
644 645
@item sent-at
Present when a CC recipient was added after the article had been
646
created.  It is the time when the CC recipient was added.
David Byers's avatar
David Byers committed
647 648 649
@end table


650 651 652
@subsection Blank Carbon Copy (BCC) Recipient

The blank carbon-copy recipient group is identical to the carbon-copy
653 654
recipient group above.  The difference is the visibility of the
information.  A carbon-copy recipient group is visible to anyone that is
655
allowed to fetch both the text status of the involved text and the
656
conference status of the involved conference.  (That is, as long as the
657
conference isn't secret everybody is allowed to see the carbon-copy
658 659
recipient group.)

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.
665 666

This type of group was introduced in protocol version 10.  When
667
old-style calls such as @reqlink{get-text-stat-old}
668
are used this will be converted to a CC recipient group by the server
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.)
672

673
@table @misc
674
@item bcc-recpt
675
Starts a blank carbon-copy recipient group.  It contains the conference
676 677
number of a blank carbon-copy recipient of the article.
@item loc-no
678
Always present in a BCC recipient group.  It contains the local text
679
number of the article in the conference specified by the most recent
680
@misc{bcc-recpt} field.
681
@item rec-time
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
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
687
after the article had been created.  It contains the person number of the
688 689 690
person who added the BCC recipient.
@item sent-at
Present when a BCC recipient was added after the article had been
691
created.  It is the time when the BCC recipient was added.
692 693 694
@end table


695
@subsection Comment To
David Byers's avatar
David Byers committed
696

697
@table @misc
David Byers's avatar
David Byers committed
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
702
the author, after the article had been created.  It contains the person
David Byers's avatar
David Byers committed
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
706
been created.  It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
707 708 709
@end table


710
@subsection Footnote To
David Byers's avatar
David Byers committed
711

712
@table @misc
713
@item footn-to
David Byers's avatar
David Byers committed
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
717
been created.  It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
718 719 720
@end table


721
@subsection Comment in
David Byers's avatar
David Byers committed
722

723
@table @misc
David Byers's avatar
David Byers committed
724
@item comm-in
725
Present when there are comments to this article.  It contains the article
David Byers's avatar
David Byers committed
726 727 728 729
number which is a comment to this article.
@end table


730
@subsection Footnote in
David Byers's avatar
David Byers committed
731

732
@table @misc
733
@item footn-in
734
Present when there are footnotes to this article.  It contains the
David Byers's avatar
David Byers committed
735 736 737 738
article number which is a footnote to this article.
@end table


739
@node The Aux-Item List
740
@section The Aux-Item List
741 742

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

@menu
746
* About Aux-Items::             An introduction to aux-items.
747
* Aux-Item Inheritance::        Comments can inherit aux items.
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.
754 755
@end menu

756
@node About Aux-Items
757
@subsection About Aux-Items
758 759 760

Aux-items were introduced in protocol version 10 as a mechanism for
extending the conference, text and server information structures without
761 762
changing the protocol.  (There is no need for aux-items on persons --
just add an aux-item to the corresponding mailbox.)
763

764
The exact structure of an aux item is specified elsewhere
765
(@pxref{Auxiliary Information}).  The important fields here are the
766
@field{aux-no}, @field{tag} and @field{data} fields.
767

768
The @field{aux-no} field is used to identify an item.  The
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
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
773
have never been used before within a particular list.
774

775
The @field{tag} field identifies the type of aux item.  It is used by
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.
779

780
The @field{data} field is a simple string.  The meaning of the string
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.)
784 785 786



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
802
is removed (via @reqlink{sub-comment} or @reqlink{sub-footnote}), the
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.



818
@node Predefined Aux-Item Types
819
@subsection Predefined Aux-Item Types
820

David Byers's avatar
David Byers committed
821
Predefined Aux-Item types are part of Protocol A, and clients should
822
support all of them.  As with other parts of the protocol, changes to
David Byers's avatar
David Byers committed
823
these definitions will be made backwards-compatible, if possible.
824

David Byers's avatar
David Byers committed
825
Creation and deletion of items with a predefined type can cause
826
arbitrarily complex and wondrous behavior in the server.  Furthermore,
David Byers's avatar
David Byers committed
827
the server may place constraints on the items with regard to content,
828
flags, who can create them, to what objects they can be attached and
829
so forth.  The server may also silently enforce specific values for any
David Byers's avatar
David Byers committed
830
field of an item, regardless of what the client requests.
831

832
All items with tags in the range 1-9999 and 30000 and up are considered
833
predefined.  If a client attempts to create an item with a tag in this
834
range, but the server has no idea what that tag means, the server will
835
return an error (@errorcode{illegal-aux-item}).
836

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.
845

846 847 848
@xref{Aux-Item Types}, for the complete list of predefined Aux-Item
types.

849 850
@node Client-Specific Aux-Item Types
@subsection Client-Specific Aux-Item Types
851

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

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
859
should never create items with tags in a range assigned to another
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}.
863

864 865 866 867
Currently, the following ranges are assigned to clients:
@itemize @bullet
@item 10000-10099: The Elisp Client
@item 10100-10199: komimportmail
868
@item 10200-10299: Private test use (should never be used on a public server)
869
@end itemize
870

871
If you want a range of numbers, send e-mail to the LysKOM development
872
group, or request it via Bugzilla.
873

874 875
@node Experimental Aux-Item Types
@subsection Experimental Aux-Item Types
876

877 878
Experimental numbers are free for all.  Use @badspell{'em} any way you
want.  All
879
numbers in the range 20000-29999 are for experimental use.
880 881 882



883 884
@node Defining New Aux-Item Types
@subsection Defining New Aux-Item Types
885

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
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.
890

891