Protocol-A.texi 357 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
@set PROTOEDITION 10.7
12
@set PROTOVER 10
Per Cederqvist's avatar
Per Cederqvist committed
13
@set VERSION 2.0.7
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

Per Cederqvist's avatar
Per Cederqvist committed
289
Copyright @copyright{} 1995-2002 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 FIXME (bug 195): What does this do?
313
@c ispell-ignore
314
315
316
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
317
@tex
318
319
320
321
322
\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
323
@c ispell-end-ignore
324

David Byers's avatar
David Byers committed
325
326
@titlepage
@title{LysKOM Protocol A}
327
328
329
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
330
331
332
@author by the LysKOM Developers

@page
333
@c ispell-ignore
David Byers's avatar
David Byers committed
334
@vskip 0pt plus 1filll
335
@c ispell-end-ignore
336
@insertcopying
David Byers's avatar
David Byers committed
337
338

@end titlepage
339
340
341
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
342

343
344
345
346
347
@dircategory LysKOM
@direntry
* Protocol A: (protocol-a).             The LysKOM Protocol A specification.
@end direntry

348
@c ispell-ignore
349
350
351
352
353
354
355
356
357
358
359
360
@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
361
@c ispell-end-ignore
362

363
@node Top
364
@top LysKOM Protocol A
365

366
367
368
369
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.

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

@menu
374
* About this document::         Copyright information.
375
376
377
378
* 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.
379
* Protocol Requests::           Each request explained in depth.
380
381
382
383
384
385
* 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.
386
* Membership visibility::       How the security features interacts.
Per Cederqvist's avatar
Per Cederqvist committed
387
* Measured Properties::         Load average, number of processed requests...
388
389
* Writing Clients::             A few tips for client writers.
* Importing and Exporting E-Mail::  A few thoughts on e-mail integration.
390
* Some Client-specific Aux-Item Types::  Informative info about more aux-items.
391
392
393
394
* 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
395
396
@end menu

397
398
399
400
401
402
403
404
@ifnottex
@node About this document
@chapter About this document

@insertcopying

@end ifnottex

405
@ifnottex
406
407
@node Preface
@chapter Preface
408
@end ifnottex
409

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

418
419
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
420

421
This specification is the work of several people.  The main contributors have
422
been
423
Per Cederqvist @email{ceder@@lysator.liu.se},
David Byers's avatar
David Byers committed
424
David Byers @email{byers@@lysator.liu.se},
425
@value{Pell} @email{pell@@lysator.liu.se},
426
Thomas Bellman @email{bellman@@lysator.liu.se},
David Byers's avatar
David Byers committed
427
428
Lars Aronsson @email{aronsson@@lysator.liu.se},
Linus Tolke @email{linus@@lysator.liu.se} and
429
@value{Kent} @email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
430

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

437
438
@node Concepts
@chapter Concepts used in LysKOM
David Byers's avatar
David Byers committed
439
440

This chapter introduces the concepts used in LysKOM, such as articles,
441
conferences and sessions.
David Byers's avatar
David Byers committed
442
443

@menu
444
445
446
447
448
449
450
451
452
453
* 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
454
455
456
@end menu


457
@node Articles
David Byers's avatar
David Byers committed
458
459
@section Articles

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

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

471
472
473
474
475
476
477
478
479
480
481
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
482

483
Occasionally it is necessary to map between local and global numbers.
484
The server call @reqdlink{local-to-global} does this@linkhere{}.
David Byers's avatar
David Byers committed
485
486
487



488
@node Conferences
David Byers's avatar
David Byers committed
489
490
@section Conferences

491
492
Conferences hold articles.  They are represented in the protocol as a
data type called @type{Conference}.  Each conference has a
493
494
@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
495
If the supervisor is a person, the members of that person's mailbox
496
497
498
499
500
501
502
503
504
505
506
507
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
508

509
Each conference has a type, which is essentially a collection of
510
boolean flags.  Currently the flags @conftype{rd-prot},
511
512
@conftype{letterbox}, @conftype{secret}, @conftype{original},
@conftype{allow-anonymous} and @conftype{forbid-secret} are defined.
David Byers's avatar
David Byers committed
513

514
@table @conftype
David Byers's avatar
David Byers committed
515
@item rd-prot
516
The conference is protected from reading by non-members.  Persons become
David Byers's avatar
David Byers committed
517
members by having one of the existing members or supervisors add him or
518
her to the conference.  This restriction is enforced by the server.
David Byers's avatar
David Byers committed
519
@item original
520
Conferences of this type are intended for original articles only.
521
522
523
524
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
525
@item letterbox
526
Conferences of this type are connected to persons.  Letters to a person
David Byers's avatar
David Byers committed
527
are sent to the mailbox and the name of the mailbox is synchronized
528
with the person name.  It is currently not possible to explicitly set or
529
clear this flag on a conference.
David Byers's avatar
David Byers committed
530
@item secret
531
Conferences of this type are secret.  The server will not divulge any
532
information about the existence of the conference to persons who are not
533
members or supervisors of the conference.  If a mailbox is made secret,
David Byers's avatar
David Byers committed
534
535
that person cannot log in using the person name, but must specify a
person number instead.
536
@item allow-anonymous
537
Conferences of this type accept anonymous articles.  Other conferences
538
will reject anonymous articles.
David Byers's avatar
David Byers committed
539
@item forbid-secret
540
Conferences of this type do not allow secret members.  If a conference is
David Byers's avatar
David Byers committed
541
changed to this type, preexisting secret members remain secret.
David Byers's avatar
David Byers committed
542
543
544
545
@end table



546
@node Persons and Sessions
547
@section Persons and Sessions
David Byers's avatar
David Byers committed
548
549

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

Connections to the server are represented as values of the type
556
@type{Static-Session-Info}, @type{Session-Info-Ident} or
557
558
559
@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
560
561
the network connection is closed; a user can log in and out repeatedly
in a single session.
David Byers's avatar
David Byers committed
562
563


564
@node The Misc-Info List
David Byers's avatar
David Byers committed
565
566
@section The Misc-Info List

567
The @type{Misc-Info} list contains tagged data.  The fields are sent in
568
groups pertaining to a particular type of information: information about
569
570
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
571
572
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
573
always sent in the order listed below.
David Byers's avatar
David Byers committed
574

575
@subsection Recipient
David Byers's avatar
David Byers committed
576

577
@table @misc
David Byers's avatar
David Byers committed
578
@item recpt
579
Starts a recipient group.  It contains the conference number of a
580
recipient of the article.
David Byers's avatar
David Byers committed
581
@item loc-no
582
Always present within a recipient group.  It contains the local text
583
number of the article in the conference specified by the preceding
584
@misc{recpt} field.
David Byers's avatar
David Byers committed
585
@item rec-time
586
If the recipient is a person, this element is added by the server when
587
the recipient marks the article as read.  It contains the time when the
588
text was read.
David Byers's avatar
David Byers committed
589
@item sent-by
590
591
592
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
593
@item sent-at
594
Present when the recipient was added after the article was created.  It
595
contains the time when the recipient was added.
David Byers's avatar
David Byers committed
596
597
598
@end table


599
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
600

601
The carbon-copy recipient group is identical to the recipient group
602
603
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
604
all recipients, but not to carbon-copy recipients of the original
605
article.  This difference is enforced by the clients.
David Byers's avatar
David Byers committed
606

607
@table @misc
David Byers's avatar
David Byers committed
608
@item cc-recpt
609
Starts a carbon-copy recipient group.  It contains the conference number
610
of a carbon-copy recipient of the article.
David Byers's avatar
David Byers committed
611
@item loc-no
612
Always present in a CC recipient group.  It contains the local text
613
number of the article in the conference specified by the most recent
614
@misc{cc-recpt} field.
David Byers's avatar
David Byers committed
615
@item rec-time
616
617
Present after the CC recipient has read the article.  It contains the
time when the article was read.  Since only persons can read articles
618
this will only be seen if the CC recipient is a person.
David Byers's avatar
David Byers committed
619
620
@item sent-by
Present when a CC recipient was added by a person other than the author
621
after the article had been created.  It contains the person number of the
622
person who added the CC recipient.
David Byers's avatar
David Byers committed
623
624
@item sent-at
Present when a CC recipient was added after the article had been
625
created.  It is the time when the CC recipient was added.
David Byers's avatar
David Byers committed
626
627
628
@end table


629
630
631
@subsection Blank Carbon Copy (BCC) Recipient

The blank carbon-copy recipient group is identical to the carbon-copy
632
633
recipient group above.  The difference is the visibility of the
information.  A carbon-copy recipient group is visible to anyone that is
634
allowed to fetch both the text status of the involved text and the
635
conference status of the involved conference.  (That is, as long as the
636
conference isn't secret everybody is allowed to see the carbon-copy
637
638
recipient group.)

639
640
641
642
643
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.
644
645

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

652
@table @misc
653
@item bcc-recpt
654
Starts a blank carbon-copy recipient group.  It contains the conference
655
656
number of a blank carbon-copy recipient of the article.
@item loc-no
657
Always present in a BCC recipient group.  It contains the local text
658
number of the article in the conference specified by the most recent
659
@misc{bcc-recpt} field.
660
@item rec-time
661
662
Present after the BCC recipient has read the article.  It contains the
time when the article was read.  Since only persons can read articles
663
664
665
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
666
after the article had been created.  It contains the person number of the
667
668
669
person who added the BCC recipient.
@item sent-at
Present when a BCC recipient was added after the article had been
670
created.  It is the time when the BCC recipient was added.
671
672
673
@end table


674
@subsection Comment To
David Byers's avatar
David Byers committed
675

676
@table @misc
David Byers's avatar
David Byers committed
677
678
679
680
@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
681
the author, after the article had been created.  It contains the person
David Byers's avatar
David Byers committed
682
683
684
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
685
been created.  It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
686
687
688
@end table


689
@subsection Footnote To
David Byers's avatar
David Byers committed
690

691
@table @misc
692
@item footn-to
David Byers's avatar
David Byers committed
693
694
695
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
696
been created.  It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
697
698
699
@end table


700
@subsection Comment in
David Byers's avatar
David Byers committed
701

702
@table @misc
David Byers's avatar
David Byers committed
703
@item comm-in
704
Present when there are comments to this article.  It contains the article
David Byers's avatar
David Byers committed
705
706
707
708
number which is a comment to this article.
@end table


709
@subsection Footnote in
David Byers's avatar
David Byers committed
710

711
@table @misc
712
@item footn-in
713
Present when there are footnotes to this article.  It contains the
David Byers's avatar
David Byers committed
714
715
716
717
article number which is a footnote to this article.
@end table


718
@node The Aux-Item List
719
@section The Aux-Item List
720
721

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

@menu
725
726
727
728
729
730
731
* About Aux-Items::             An introduction to aux-items.
* 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.
732
733
@end menu

734
@node About Aux-Items
735
@subsection About Aux-Items
736
737
738

Aux-items were introduced in protocol version 10 as a mechanism for
extending the conference, text and server information structures without
739
changing the protocol.  Persons were excluded since nobody could figure
David Byers's avatar
David Byers committed
740
out a case where setting an aux-item on the mailbox wasn't as good as
741
742
743
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.)

744
The exact structure of an aux item is specified elsewhere
745
(@pxref{Auxiliary Information}).  The important fields here are the
746
@field{aux-no}, @field{tag} and @field{data} fields.
747

748
The @field{aux-no} field is used to identify an item.  The
749
750
@field{aux-no} together with a text or conference number uniquely
identifies a particular aux item.  Items are numbered from one and up
751
752
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
753
have never been used before within a particular list.
754

755
The @field{tag} field identifies the type of aux item.  It is used by
756
757
758
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.
759

760
The @field{data} field is a simple string.  The meaning of the string
761
762
763
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.)
764
765
766



767
@node Predefined Aux-Item Types
768
@subsection Predefined Aux-Item Types
769

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

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

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

786
787
788
789
790
791
792
793
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.
794

795
796
797
@xref{Aux-Item Types}, for the complete list of predefined Aux-Item
types.

798
799
@node Client-Specific Aux-Item Types
@subsection Client-Specific Aux-Item Types
800

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

806
807
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
808
should never create items with tags in a range assigned to another
809
810
811
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}.
812

813
814
815
816
817
Currently, the following ranges are assigned to clients:
@itemize @bullet
@item 10000-10099: The Elisp Client
@item 10100-10199: komimportmail
@end itemize
818

819
820
If you want a range of numbers, send e-mail to the LysKOM development
group.
821

822
823
@node Experimental Aux-Item Types
@subsection Experimental Aux-Item Types
824

825
826
Experimental numbers are free for all.  Use @badspell{'em} any way you
want.  All
827
numbers in the range 20000-29999 are for experimental use.
828
829
830



831
832
@node Defining New Aux-Item Types
@subsection Defining New Aux-Item Types
833

834
835
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
836
837
and send this to the LysKOM development group.  We'll assign a number to
your item and put the documentation in this document.
838

839
If you're not sure what you want the data to look like yet, make a note
840
in your documentation that the data format might change.  Once you have a
841
842
data format you're happy with, update the documentation so others may
use your item.
843

844
845
846
847
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.
848

849
The idea is not to reject any type of item, unless there's already an
850
item type that does the job just as well.  Adding item types should be a
851
much less painful process than adding new calls.
852
853
854
855
856





857
858
@node Security
@section Security
859

860
861
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
862
system require both the sufficient privileges and a sufficient
863
security level.  The privileges currently available are @priv{wheel},
864
@priv{admin}, @priv{statistic}, @priv{create-conf}, @priv{create-pers}
865
and @priv{change-name}.  Security levels range from 0 to 255.
866

867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
@table @priv
@item wheel
@emph{Normally not assigned}
@table @asis
@item Level 0
Person may always log in, even when LysKOM is crowded.
@item Level 6
Person may set Priv-Bits for all persons.
@item Level 7
Person may set password for all persons.
@item Level 8
Person acts as supervisor for everything.
@item Level 10
Person can read all articles.
@end table
David Byers's avatar
David Byers committed
882

883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
@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
905

906
907
908
909
910
911
@item statistic
@emph{Normally not assigned}
@table @asis
@item Level 2
Read the statistics portions of persons, even if protected
@end table
912

913
@item create-conf
914
915
916
@emph{Normally not assigned}@footnote{The LysKOM server is normally
configured so that anybody can create new conferences, even if they do
not have this privilege.}
917
918
919
920
@table @asis
@item Level 0
Create conferences
@end table
921

922
@item create-pers
923
924
925
@emph{Normally not assigned}@footnote{The LysKOM server is normally
configured so that anybody can create new persons, even if they do not
have this privilege.}
926
927
928
929
@table @asis
@item Level 0
Create persons
@end table
930

931
932
933
934
935
936
937
@item change-name
@emph{Normally assigned}
@table @asis
@item Level 0
Change names of conferences he is supervisor for
@end table

938
@end table
David Byers's avatar
David Byers committed
939

940

941
942
@node Membership and Reading
@section Membership and Reading
943

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

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

963
The membership record indicates which texts have been read through the
964
965
@field{read-ranges} field, which contains a list of ranges of local
text numbers that has been read.
966

967
Finding out which articles a person has read in a particular conference
968
969
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:
970

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

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

986

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

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

995
@menu
996
997
998
999
1000
* Notation::                    The grammar used in this document.
* Simple Data Types::           BOOL, INT32, ARRAY, @dots{}
* Connecting to the Server::    The initial handshake.
* Client-Server Dialog::        Requests, replies, asynchronous messages.
* Protocol Error Messages::     How the server reacts to syntax errors.
1001
@end menu
1002

1003
1004
@node Notation
@section Notation
1005

1006
1007
This specification uses a BNF-like grammar to describe the protocol and
its data elements.
1008