Protocol-A.texi 305 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: 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
11
12
13
@c @afourpaper

@set PROTOEDITION 10.4
@set PROTOVER 10
@set VERSION 1.0.4
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
33
34
@set IAM Inl@"a{}gg @}t mig
@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
@c
@c Define other strings.
@c
53

54
55
56
@macro daemon
@badspell{d@ae{}mon}
@end macro
57
58
59
60
61

@c
@c Index setup
@c

62
63
64
65
66
67
68
@c Index for asynchronous messages.
@defcodeindex am

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

69
70
71


@c
72
@c Special markup for this document.
73
74
@c

75
76
77
78
79
@c Indicate something that shouldn't be spell-checked
@macro badspell{s}
\s\
@end macro

80
@c @req{login} is used for protocol requests.
81

82
83
84
85
@macro req {n}
@code{\n\}
@end macro

86
@c @reqlink{login} is used for protocol requests, that should be linked.
87
88
89
90
91
92
93
94
95
96
97
98
99
100

@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
101
@c should be linked, where the link should occur a few words after the
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
@c request itself.

@ifhtml

@c HTML version: make the word a link.
@macro reqdlink {n}
@code{@ref{\n\}}@c
@unmacro linkhere
@macro linkhere
@end macro
@end macro

@end ifhtml

@ifnothtml
@ifnottex

119
@c Info version: create @linkhere as a macro that contains a reference.
120
121
122
123
124
125
126
127
128

@macro reqdlink {n}
@code{\n\}@c
@unmacro linkhere
@macro linkhere
(@pxref{\n\})
@end macro
@end macro
@end ifnottex
129

130
131
@iftex

132
@c TeX version: this produces output similar to the Info version.
133

134
@c ispell-ignore
135
136
137
138
139
140
@tex
    \gdef\reqdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
141
@c ispell-end-ignore
142
143
144
@end iftex
@end ifnothtml

145
146
147
148
149
150
151
152
153
154
@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

155
@c @asynclink{async-login} is used for async names, that should be linked.
156
157
158
159
160
161
162
163
164
165
166
167
168
169

@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,
170
@c that should be linked, where the link should occur a few words after
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
@c the async name itself.

@ifhtml

@c HTML version: make the word a link.
@macro asyncdlink {n}
@code{@ref{\n\}}@c
@unmacro linkhere
@macro linkhere
@end macro
@end macro

@end ifhtml

@ifnothtml
@ifnottex

188
@c Info version: create @linkhere as a macro that contains a reference.
189
190
191
192
193
194
195
196
197
198
199
200
201
202

@macro asyncdlink {n}
@code{\n\}@c
@unmacro linkhere
@macro linkhere
(@pxref{\n\})
@end macro
@end macro
@end ifnottex

@iftex

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

203
@c ispell-ignore
204
205
206
207
208
209
@tex
    \gdef\asyncdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
210
@c ispell-end-ignore
211
212
213
@end iftex
@end ifnothtml

214
215
216
217
218
@c @type{Conference} is used for LysKOM types.
@macro type {n}
@code{\n\}
@end macro

219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
@c @lt{Conference} is used for linked types.  The link is only present
@c when it is unobtrusive.  It should only be used inside
@c @example...@end example.

@ifhtml
@macro lt {n}
@ref{\n\}@c
@end macro
@end ifhtml

@ifnothtml
@macro lt {n}
\n\@c
@end macro
@end ifnothtml

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
266
267
268
269
270
271
272
@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

273
274
275
276
277
278
279
@c @reqexample is used immediately before Protocol-A example
@c fragments.
@macro reqexample
@need 2000
@i{Example:}
@end macro

280
281
@c %**end of header

David Byers's avatar
David Byers committed
282
@ifinfo
283
284
285
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
286

Per Cederqvist's avatar
Per Cederqvist committed
287
Copyright @copyright{} 1995-2000 Lysator ACS.
David Byers's avatar
David Byers committed
288
289
290
291

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.
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307

@ignore
Permission is granted to process this file through TeX
and print the results, provided the printed document
carries a copying permission notice identical to this
one except for the removal of this paragraph (this
paragraph not being relevant to the printed manual).
@end ignore

Modified versions of this document may be redistributed with the added
condition that all modifications not cleared with the LysKOM development group
are clearly marked and that the entire modified work be redistributed under the
same conditions as the original.

Permission is granted to copy and distribute translations of this manual into
another language under the same conditions as for modified versions.
David Byers's avatar
David Byers committed
308
309
@end ifinfo

310
@c FIXME: What does this do?
311
@c ispell-ignore
312
313
314
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
315
@tex
316
317
318
319
320
\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
321
@c ispell-end-ignore
322

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

@page
331
@c ispell-ignore
David Byers's avatar
David Byers committed
332
@vskip 0pt plus 1filll
333
@c ispell-end-ignore
Per Cederqvist's avatar
Per Cederqvist committed
334
Copyright @copyright{} 1995-2000 Lysator ACS
David Byers's avatar
David Byers committed
335
336
337
338
339
340
341
342
343
344
345
346
347
348

Permission is granted to make and distribute verbatim copies of this document
provided the copyright notice and this permission notice are preserved on all
copies.

Modified versions of this document may be redistributed with the added
condition that all modifications not cleared with the LysKOM development group
are clearly marked and that the entire modified work be redistributed under the
same conditions as the original.

Permission is granted to copy and distribute translations of this manual into
another language under the same conditions as for modified versions.

@end titlepage
349
350
351
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
352

353
354
355
356
357
@dircategory LysKOM
@direntry
* Protocol A: (protocol-a).             The LysKOM Protocol A specification.
@end direntry

358
@c ispell-ignore
359
360
361
362
363
364
365
366
367
368
369
370
@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
371
@c ispell-end-ignore
372
@ifnottex
373
@node Top
374
@top LysKOM Protocol A
375

376
377
378
379
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.

380
The most up-to-date version if this document can always be found at
381
382
@uref{http://www.lysator.liu.se/lyskom/protocol/}.
@end ifnottex
David Byers's avatar
David Byers committed
383
384

@menu
385
* Preface::                     
386
* Concepts::                    
387
388
* Fundamentals::                
* LysKOM Data Types::           
389
390
391
* Protocol Requests::           
* Asynchronous Messages::       
* Error Codes::                 
392
* Aux-Item Types::              
393
* Name Expansion::              
394
395
396
397
* LysKOM Content Types::        
* The User Area::               
* Writing Clients::             
* Importing and Exporting E-Mail::  
398
* Future changes::              
399
400
* Protocol Version History::    
* Document Edition History::    
401
* Index::                       
David Byers's avatar
David Byers committed
402
403
@end menu

404
405
@node Preface
@chapter Preface
David Byers's avatar
David Byers committed
406

407
408
409
410
411
@iftex
This document specifies version @value{PROTOVER} of LysKOM Protocol A.
This is edition @value{PROTOEDITION} of the specification.  It
corresponds to version @value{VERSION} of lyskomd.

412
413
The most up-to-date version if this document can always be found on
the web at @uref{http://www.lysator.liu.se/lyskom/protocol/}.
414
415
@end iftex

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

424
425
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
426

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

David Byers's avatar
David Byers committed
437
438
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
439

440
441
@node Concepts
@chapter Concepts used in LysKOM
David Byers's avatar
David Byers committed
442
443

This chapter introduces the concepts used in LysKOM, such as articles,
444
conferences and sessions.
David Byers's avatar
David Byers committed
445
446

@menu
447
448
* Articles::                    
* Conferences::                 
449
* Persons and Sessions::        
450
451
452
453
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
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
are supervisors, which in most cases is only that person.  We have also
497
introduced a type called @type{UConference} (pronounced micro-conf-stat)
498
which holds a subset of the information contained in the full
499
@type{Conference} type.  Use the @type{UConference} type whenever
500
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
501

502
Each conference has a type, which is essentially a collection of
503
boolean flags.  Currently the flags @conftype{rd-prot},
504
505
@conftype{letterbox}, @conftype{secret}, @conftype{original},
@conftype{allow-anonymous} and @conftype{forbid-secret} are defined.
David Byers's avatar
David Byers committed
506

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



538
@node Persons and Sessions
539
@section Persons and Sessions
David Byers's avatar
David Byers committed
540
541

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

Connections to the server are represented as values of the type
548
@type{Static-Session-Info}, @type{Session-Info-Ident} or
549
550
551
@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
552
553
the network connection is closed; a user can log in and out repeatedly
in a single session.
David Byers's avatar
David Byers committed
554
555


556
@node The Misc-Info List
David Byers's avatar
David Byers committed
557
558
@section The Misc-Info List

559
The @type{Misc-Info} list contains tagged data.  The fields are sent in
560
groups pertaining to a particular type of information: information about
561
562
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
563
564
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
565
always sent in the order listed below.
David Byers's avatar
David Byers committed
566

567
@subsection Recipient
David Byers's avatar
David Byers committed
568

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


591
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
592

593
The carbon-copy recipient group is identical to the recipient group
594
595
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
596
all recipients, but not to carbon-copy recipients of the original
597
article.  This difference is enforced by the clients.
David Byers's avatar
David Byers committed
598

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


621
622
623
@subsection Blank Carbon Copy (BCC) Recipient

The blank carbon-copy recipient group is identical to the carbon-copy
624
625
recipient group above.  The difference is the visibility of the
information.  A carbon-copy recipient group is visible to anyone that is
626
allowed to fetch both the text status of the involved text and the
627
conference status of the involved conference.  (That is, as long as the
628
conference isn't secret everybody is allowed to see the carbon-copy
629
630
recipient group.)

631
632
633
634
635
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.
636
637

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

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


666
@subsection Comment To
David Byers's avatar
David Byers committed
667

668
@table @misc
David Byers's avatar
David Byers committed
669
670
671
672
@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
673
the author, after the article had been created.  It contains the person
David Byers's avatar
David Byers committed
674
675
676
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
677
been created.  It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
678
679
680
@end table


681
@subsection Footnote To
David Byers's avatar
David Byers committed
682

683
@table @misc
684
@item footn-to
David Byers's avatar
David Byers committed
685
686
687
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
688
been created.  It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
689
690
691
@end table


692
@subsection Comment in
David Byers's avatar
David Byers committed
693

694
@table @misc
David Byers's avatar
David Byers committed
695
@item comm-in
696
Present when there are comments to this article.  It contains the article
David Byers's avatar
David Byers committed
697
698
699
700
number which is a comment to this article.
@end table


701
@subsection Footnote in
David Byers's avatar
David Byers committed
702

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


710
@node The Aux-Item List
711
@section The Aux-Item List
712
713

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

@menu
717
718
719
720
721
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
722
723
@end menu

724
@node About Aux-Items
725
@subsection About Aux-Items
726
727
728

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

734
The exact structure of an aux item is specified elsewhere
735
(@pxref{Auxiliary Information}).  The important fields here are the
736
@field{aux-no}, @field{tag} and @field{data} fields.
737

738
The @field{aux-no} field is used to identify an item.  The
739
740
@field{aux-no} together with a text or conference number uniquely
identifies a particular aux item.  Items are numbered from one and up
741
742
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
743
have never been used before within a particular list.
744

745
The @field{tag} field identifies the type of aux item.  It is used by
746
747
748
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.
749

750
The @field{data} field is a simple string.  The meaning of the string
751
752
753
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.)
754
755
756



757
@node Predefined Aux-Item Types
758
@subsection Predefined Aux-Item Types
759

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

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

771
All items with tags in the range 1-9999 and 30000 and up are considered
772
predefined.  If a client attempts to create an item with a tag in this
773
range, but the server has no idea what that tag means, the server will
David Byers's avatar
David Byers committed
774
return an error (illegal-aux-item.)
775

776
777
778
779
780
781
782
783
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.
784

785
786
@node Client-Specific Aux-Item Types
@subsection Client-Specific Aux-Item Types
787

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

793
794
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
795
should never create items with tags in a range assigned to another
796
797
798
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}.
799

800
801
802
803
804
Currently, the following ranges are assigned to clients:
@itemize @bullet
@item 10000-10099: The Elisp Client
@item 10100-10199: komimportmail
@end itemize
805

806
807
If you want a range of numbers, send e-mail to the LysKOM development
group.
808

809
810
@node Experimental Aux-Item Types
@subsection Experimental Aux-Item Types
811

812
813
Experimental numbers are free for all.  Use @badspell{'em} any way you
want.  All
814
numbers in the range 20000-29999 are for experimental use.
815
816
817



818
819
@node Defining New Aux-Item Types
@subsection Defining New Aux-Item Types
820

821
822
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
823
824
and send this to the LysKOM development group.  We'll assign a number to
your item and put the documentation in this document.
825

826
If you're not sure what you want the data to look like yet, make a note
827
in your documentation that the data format might change.  Once you have a
828
829
data format you're happy with, update the documentation so others may
use your item.
830

831
832
833
834
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.
835

836
The idea is not to reject any type of item, unless there's already an
837
item type that does the job just as well.  Adding item types should be a
838
much less painful process than adding new calls.
839
840
841
842
843





844
845
@node Security
@section Security
846

847
848
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
849
system require both the sufficient privileges and a sufficient
850
security level.  The privileges currently available are @priv{wheel},
851
@priv{admin}, @priv{statistic}, @priv{create-conf}, @priv{create-pers}
852
and @priv{change-name}.  Security levels range from 0 to 255.
853

854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
@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
869

870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
@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
892

893
894
895
896
897
898
@item statistic
@emph{Normally not assigned}
@table @asis
@item Level 2
Read the statistics portions of persons, even if protected
@end table
899

900
901
902
903
904
905
@item create-conf
@emph{Normally assigned}
@table @asis
@item Level 0
Create conferences
@end table
906

907
908
909
910
911
912
@item create-pers
@emph{Normally assigned}
@table @asis
@item Level 0
Create persons
@end table
913

914
@end table
David Byers's avatar
David Byers committed
915

916

917
918
@node Membership and Reading
@section Membership and Reading
919

920
Persons' memberships in conferences are represented in the protocol as
921
arrays of @type{Membership}-typed values.  This structure contains
922
923
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
924

925
926
There are two kinds of memberships.  An active membership indicates that
the person is actively participating in the conference, wants to know if
927
there are unread texts and wants to receive messages send to the
928
conference.  A passive membership is similar to no membership at all.  The
929
person is still a member but will not receive messages sent to the
930
conference and will not be notified when there are new texts.  From the
931
932
user's perspective, passive membership should be like no membership at
all, but the server still remembers what the user has read in the
933
conference while he or she was an active member.  Since protocol version
934
10 a bit in the membership type field of the membership structure
935
indicates the type of membership.  Previously the server did not support
936
937
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
938

939
The membership record indicates which texts have been read through the
940
941
@field{last-text-read} and @field{read-texts} fields.  All texts with local
numbers up to @field{last-text-read} have been read.  In addition, all
942
943
texts with local numbers contained in the @field{read-texts} array have
been read.
944

945
Finding out which articles a person has read in a particular conference
946
947
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:
948

949
950
951
952
@enumerate
@item Fetch the membership to get the @field{last-text-read}
@item Use @reqlink{local-to-global} to translate a number of local
numbers to global numbers.
953
@item Remove the global numbers corresponding to local numbers contained
954
955
956
in @field{read-texts} from the result.
@item Get and translate more texts as needed.
@end enumerate
957

958
The process is complicated because of the translation between local
959
and global text numbers.  If the server does not implement the
960
961
962
@reqdlink{local-to-global} call@linkhere{}, it is possible to use the less
efficient but perfectly serviceable @reqdlink{get-map} call
instead@linkhere{}.
963

964

965
966
@node Fundamentals
@chapter Fundamentals of Protocol A
967

968
The data types in protocol A come in two flavors.  The first (vanilla)
969
are the simple data types from which the LysKOM (chocolate) data types
970
are built.  Simple data types include things like integers and strings
971
while complex data types include things such as conferences and people.
972

973
974
975
@menu
* Notation::                    
* Simple Data Types::           
976
* Connecting to the Server::    
977
* Client-Server Dialog::        
978
* Protocol Error Messages::     
979
@end menu
980

981
982
@node Notation
@section Notation
983

984
985
This specification uses a BNF-like grammar to describe the protocol and
its data elements.
986

987
Data fields have been given names that start with a lower-case letter.
988

989
990
Fundamental data types have names in all-caps (such as @type{INT32} and
@type{ARRAY}).
991

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

997
998
Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
999
1000
terminates statements in the grammar.  In some specifications there are
literal strings.  There is to be no whitespace before or after literal
1001
strings unless there is whitespace in the literal itself.
1002
1003


1004
1005
@node Simple Data Types
@section Simple Data Types
1006