Protocol-A.texi 302 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: Things that require a resolution in the WG:
4
@c FIXME:
5
6
@c FIXME: "x-kom/basic" should be "text/x-kom-basic" (6435471)
@c FIXME: get rid of "komimportmail Aux-Item Types" (6435520)
7
@c FIXME: Explain how the garb works with nice and keep-commented
8
@c FIXME:
David Byers's avatar
David Byers committed
9
@c
10
@c $Id: Protocol-A.texi,v 1.146 2001/05/08 21:47:35 ceder Exp $
David Byers's avatar
David Byers committed
11
12
13
14
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
15
16
17
18
19
@c @afourpaper

@set PROTOEDITION 10.4
@set PROTOVER 10
@set VERSION 1.0.4
David Byers's avatar
David Byers committed
20

21
22
23


@c
24
@c Define a few strings that contains characters from ISO Latin-1.
25
@c
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43

@iftex

@set IAM Inl@"a{}gg @}t mig
@set Pell P@"ar Emanuelsson
@set Kent Kent Eng@-str@"om@penalty-10000
@set presconf 27HPresentation (av nya) m@"oten

@end iftex
@ifnottex

@set IAM Inlägg @}t mig
@set Pell Pär Emanuelsson
@set Kent Kent Engström
@set presconf 27HPresentation (av nya) möten

@end ifnottex

44
45
46
47
48
49


@c
@c Index setup
@c

50
51
52
53
54
55
56
@c Index for asynchronous messages.
@defcodeindex am

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

57
58
59
60
61
62


@c
@c Special markup for Protocol-A.texi
@c

63
@c @req{login} is used for protocol requests.
64

65
66
67
68
@macro req {n}
@code{\n\}
@end macro

69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
@c @reqlink{login} is used for protocol requests, that shuld be linked.

@ifhtml
@macro reqlink {n}
@code{@ref{\n\}}
@end macro
@end ifhtml

@ifnothtml
@macro reqlink {n}
@code{\n\} (@pxref{\n\})
@end macro
@end ifnothtml

@c @reqdlink{login}...@linkhere{} is used for protocol requests, that
@c shuld be linked, where the link should occur a few words after the
@c request itself.

@ifhtml

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

@end ifhtml

@ifnothtml
@ifnottex

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

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

113
114
@iftex

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

117
118
119
120
121
122
@tex
    \gdef\reqdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
123
124
125
@end iftex
@end ifnothtml

126
127
128
129
130
131
132
133
134
135
@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

136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
@c @asynclink{async-login} is used for async names, that shuld be linked.

@ifhtml
@macro asynclink {n}
@code{@ref{\n\}}
@end macro
@end ifhtml

@ifnothtml
@macro asynclink {n}
@code{\n\} (@pxref{\n\})
@end macro
@end ifnothtml

@c @asyncdlink{async-login}...@linkhere{} is used for async messages,
@c that shuld be linked, where the link should occur a few words after
@c the async name itself.

@ifhtml

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

@end ifhtml

@ifnothtml
@ifnottex

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

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

@iftex

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

@tex
    \gdef\asyncdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
@end iftex
@end ifnothtml

193
194
195
196
197
@c @type{Conference} is used for LysKOM types.
@macro type {n}
@code{\n\}
@end macro

198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
@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

214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
@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

252
253
254
255
256
257
258
@c @reqexample is used immediately before Protocol-A example
@c fragments.
@macro reqexample
@need 2000
@i{Example:}
@end macro

259
260
@c %**end of header

David Byers's avatar
David Byers committed
261
@ifinfo
262
263
264
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
265

Per Cederqvist's avatar
Per Cederqvist committed
266
Copyright @copyright{} 1995-2000 Lysator ACS.
David Byers's avatar
David Byers committed
267
268
269
270

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.
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286

@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
287
288
@end ifinfo

289
290
291
292
@c FIXME: What does this do?
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
293
@tex
294
295
296
297
298
\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
299

David Byers's avatar
David Byers committed
300
301
@titlepage
@title{LysKOM Protocol A}
302
303
304
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
305
306
307
308
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
Per Cederqvist's avatar
Per Cederqvist committed
309
Copyright @copyright{} 1995-2000 Lysator ACS
David Byers's avatar
David Byers committed
310
311
312
313
314
315
316
317
318
319
320
321
322
323

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
324
325
326
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
327

328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
@dircategory LysKOM
@direntry
* Protocol A: (protocol-a).             The LysKOM Protocol A specification.
@end direntry

@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
@ifnottex
346
@node Top
347
@top LysKOM Protocol A
348

349
350
351
352
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.

353
The most up-to-date version if this document can always be found at
354
355
@uref{http://www.lysator.liu.se/lyskom/protocol/}.
@end ifnottex
David Byers's avatar
David Byers committed
356
357

@menu
358
* Preface::                     
359
* Concepts::                    
360
361
* Fundamentals::                
* LysKOM Data Types::           
362
363
364
* Protocol Requests::           
* Asynchronous Messages::       
* Error Codes::                 
365
* Aux-Item Types::              
366
* Name Expansion::              
367
368
369
370
* LysKOM Content Types::        
* The User Area::               
* Writing Clients::             
* Importing and Exporting E-Mail::  
371
* Future changes::              
372
373
* Protocol Version History::    
* Document Edition History::    
374
* Index::                       
David Byers's avatar
David Byers committed
375
376
@end menu

377
378
@node Preface
@chapter Preface
David Byers's avatar
David Byers committed
379

380
381
382
383
384
@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.

385
386
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/}.
387
388
@end iftex

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

397
398
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
399

400
This specification is the work of several people.  The main contributors have
401
been
402
Per Cederqvist @email{ceder@@lysator.liu.se},
David Byers's avatar
David Byers committed
403
David Byers @email{byers@@lysator.liu.se},
404
@value{Pell} @email{pell@@lysator.liu.se},
405
Thomas Bellman @email{bellman@@lysator.liu.se},
David Byers's avatar
David Byers committed
406
407
Lars Aronsson @email{aronsson@@lysator.liu.se},
Linus Tolke @email{linus@@lysator.liu.se} and
408
@value{Kent} @email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
409

David Byers's avatar
David Byers committed
410
411
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
412

413
414
@node Concepts
@chapter Concepts used in LysKOM
David Byers's avatar
David Byers committed
415
416

This chapter introduces the concepts used in LysKOM, such as articles,
417
conferences and sessions.
David Byers's avatar
David Byers committed
418
419

@menu
420
421
* Articles::                    
* Conferences::                 
422
* Persons and Sessions::        
423
424
425
426
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
David Byers's avatar
David Byers committed
427
428
429
@end menu


430
@node Articles
David Byers's avatar
David Byers committed
431
432
@section Articles

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

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

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

456
Occasionally it is necessary to map between local and global numbers.
457
The server call @reqdlink{local-to-global} does this@linkhere{}.
David Byers's avatar
David Byers committed
458
459
460



461
@node Conferences
David Byers's avatar
David Byers committed
462
463
@section Conferences

464
465
Conferences hold articles.  They are represented in the protocol as a
data type called @type{Conference}.  Each conference has a
466
467
@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
468
If the supervisor is a person, the members of that person's mailbox
469
are supervisors, which in most cases is only that person.  We have also
470
introduced a type called @type{UConference} (pronounced micro-conf-stat)
471
which holds a subset of the information contained in the full
472
@type{Conference} type.  Use the @type{UConference} type whenever
473
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
474

475
Each conference has a type, which is essentially a collection of
476
boolean flags.  Currently the flags @conftype{rd-prot},
477
478
@conftype{letterbox}, @conftype{secret}, @conftype{original},
@conftype{allow-anonymous} and @conftype{forbid-secret} are defined.
David Byers's avatar
David Byers committed
479

480
@table @conftype
David Byers's avatar
David Byers committed
481
@item rd-prot
482
The conference is protected from reading by non-members.  Persons become
David Byers's avatar
David Byers committed
483
members by having one of the existing members or supervisors add him or
484
her to the conference.  This restriction is enforced by the server.
David Byers's avatar
David Byers committed
485
@item original
486
Conferences of this type are intended for original articles only.
487
Comments are to be redirected to the super-conference instead.  This
488
489
restriction is currently not enforced by the server; clients must
implement this functionality.
David Byers's avatar
David Byers committed
490
@item letterbox
491
Conferences of this type are connected to persons.  Letters to a person
David Byers's avatar
David Byers committed
492
are sent to the mailbox and the name of the mailbox is synchronized
493
with the person name.  It is currently not possible to explicitly set or
494
clear this flag on a conference.
David Byers's avatar
David Byers committed
495
@item secret
496
Conferences of this type are secret.  The server will not divulge any
497
information about the existence of the conference to persons who are not
498
members or supervisors of the conference.  If a mailbox is made secret,
David Byers's avatar
David Byers committed
499
500
that person cannot log in using the person name, but must specify a
person number instead.
501
@item allow-anonymous
502
Conferences of this type accept anonymous articles.  Other conferences
503
will reject anonymous articles.
David Byers's avatar
David Byers committed
504
@item forbid-secret
505
Conferences of this type do not allow secret members.  If a conference is
David Byers's avatar
David Byers committed
506
changed to this type, preexisting secret members remain secret.
David Byers's avatar
David Byers committed
507
508
509
510
@end table



511
@node Persons and Sessions
512
@section Persons and Sessions
David Byers's avatar
David Byers committed
513
514

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

Connections to the server are represented as values of the type
521
@type{Static-Session-Info}, @type{Session-Info-Ident} or
522
523
524
@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
525
526
the network connection is closed; a user can log in and out repeatedly
in a single session.
David Byers's avatar
David Byers committed
527
528


529
@node The Misc-Info List
David Byers's avatar
David Byers committed
530
531
@section The Misc-Info List

532
The @type{Misc-Info} list contains tagged data.  The fields are sent in
533
groups pertaining to a particular type of information: information about
534
535
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
536
537
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
538
always sent in the order listed below.
David Byers's avatar
David Byers committed
539

540
@subsection Recipient
David Byers's avatar
David Byers committed
541

542
@table @misc
David Byers's avatar
David Byers committed
543
@item recpt
544
Starts a recipient group.  It contains the conference number of a
545
recipient of the article.
David Byers's avatar
David Byers committed
546
@item loc-no
547
Always present within a recipient group.  It contains the local text
548
number of the article in the conference specified by the preceding
549
@misc{recpt} field.
David Byers's avatar
David Byers committed
550
@item rec-time
551
If the recipient is a person, this element is added by the server when
552
the recipient marks the article as read.  It contains the time when the
553
text was read.
David Byers's avatar
David Byers committed
554
@item sent-by
555
556
557
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
558
@item sent-at
559
Present when the recipient was added after the article was created.  It
560
contains the time when the recipient was added.
David Byers's avatar
David Byers committed
561
562
563
@end table


564
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
565

566
The carbon-copy recipient group is identical to the recipient group
567
568
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
569
all recipients, but not to carbon-copy recipients of the original
570
article.  This difference is enforced by the clients.
David Byers's avatar
David Byers committed
571

572
@table @misc
David Byers's avatar
David Byers committed
573
@item cc-recpt
574
Starts a carbon-copy recipient group.  It contains the conference number
575
of a carbon-copy recipient of the article.
David Byers's avatar
David Byers committed
576
@item loc-no
577
Always present in a CC recipient group.  It contains the local text
578
number of the article in the conference specified by the most recent
579
@misc{cc-recpt} field.
David Byers's avatar
David Byers committed
580
@item rec-time
581
582
Present after the CC recipient has read the article.  It contains the
time when the article was read.  Since only persons can read articles
583
this will only be seen if the CC recipient is a person.
David Byers's avatar
David Byers committed
584
585
@item sent-by
Present when a CC recipient was added by a person other than the author
586
after the article had been created.  It contains the person number of the
587
person who added the CC recipient.
David Byers's avatar
David Byers committed
588
589
@item sent-at
Present when a CC recipient was added after the article had been
590
created.  It is the time when the CC recipient was added.
David Byers's avatar
David Byers committed
591
592
593
@end table


594
595
596
@subsection Blank Carbon Copy (BCC) Recipient

The blank carbon-copy recipient group is identical to the carbon-copy
597
598
recipient group above.  The difference is the visibility of the
information.  A carbon-copy recipient group is visible to anyone that is
599
allowed to fetch both the text status of the involved text and the
600
conference status of the involved conference.  (That is, as long as the
601
conference isn't secret everybody is allowed to see the carbon-copy
602
603
recipient group.)

604
605
606
607
608
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.
609
610

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

617
@table @misc
618
@item bcc-recpt
619
Starts a blank carbon-copy recipient group.  It contains the conference
620
621
number of a blank carbon-copy recipient of the article.
@item loc-no
622
Always present in a BCC recipient group.  It contains the local text
623
number of the article in the conference specified by the most recent
624
@misc{bcc-recpt} field.
625
@item rec-time
626
627
Present after the BCC recipient has read the article.  It contains the
time when the article was read.  Since only persons can read articles
628
629
630
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
631
after the article had been created.  It contains the person number of the
632
633
634
person who added the BCC recipient.
@item sent-at
Present when a BCC recipient was added after the article had been
635
created.  It is the time when the BCC recipient was added.
636
637
638
@end table


639
@subsection Comment To
David Byers's avatar
David Byers committed
640

641
@table @misc
David Byers's avatar
David Byers committed
642
643
644
645
@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
646
the author, after the article had been created.  It contains the person
David Byers's avatar
David Byers committed
647
648
649
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
650
been created.  It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
651
652
653
@end table


654
@subsection Footnote To
David Byers's avatar
David Byers committed
655

656
@table @misc
657
@item footn-to
David Byers's avatar
David Byers committed
658
659
660
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
661
been created.  It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
662
663
664
@end table


665
@subsection Comment in
David Byers's avatar
David Byers committed
666

667
@table @misc
David Byers's avatar
David Byers committed
668
@item comm-in
669
Present when there are comments to this article.  It contains the article
David Byers's avatar
David Byers committed
670
671
672
673
number which is a comment to this article.
@end table


674
@subsection Footnote in
David Byers's avatar
David Byers committed
675

676
@table @misc
677
@item footn-in
678
Present when there are footnotes to this article.  It contains the
David Byers's avatar
David Byers committed
679
680
681
682
article number which is a footnote to this article.
@end table


683
@node The Aux-Item List
684
@section The Aux-Item List
685
686

The aux-item list is used as a generic extension mechanism in the LysKOM
687
server and in protocol A.
688
689

@menu
690
691
692
693
694
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
695
696
@end menu

697
@node About Aux-Items
698
@subsection About Aux-Items
699
700
701

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

707
The exact structure of an aux item is specified elsewhere
708
(@pxref{Auxiliary Information}).  The important fields here are the
709
@field{aux-no}, @field{tag} and @field{data} fields.
710

711
The @field{aux-no} field is used to identify an item.  The
712
713
@field{aux-no} together with a text or conference number uniquely
identifies a particular aux item.  Items are numbered from one and up
714
715
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
716
have never been used before within a particular list.
717

718
The @field{tag} field identifies the type of aux item.  It is used by
719
720
721
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.
722

723
The @field{data} field is a simple string.  The meaning of the string
724
725
726
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.)
727
728
729



730
@node Predefined Aux-Item Types
731
@subsection Predefined Aux-Item Types
732

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

David Byers's avatar
David Byers committed
737
Creation and deletion of items with a predefined type can cause
738
arbitrarily complex and wonderous behavior in the server.  Furthermore,
David Byers's avatar
David Byers committed
739
the server may place constraints on the items with regard to content,
740
flags, who can create them, to what objects they can be attached and
741
so forth.  The server may also silently enforce specific values for any
David Byers's avatar
David Byers committed
742
field of an item, regardless of what the client requests.
743

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


750
751
@node Client-Specific Aux-Item Types
@subsection Client-Specific Aux-Item Types
752

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

758
759
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
760
should never create items with tags in a range assigned to another
761
client or in an unassigned range.  Assigned ranges will never change.
762

763
764
765
766
767
Currently, the following ranges are assigned to clients:
@itemize @bullet
@item 10000-10099: The Elisp Client
@item 10100-10199: komimportmail
@end itemize
768

769
770
If you want a range of numbers, send e-mail to the LysKOM development
group.
771

772
773
774
@menu
* komimportmail Aux-Item Types::  
@end menu
775

776
777
@node komimportmail Aux-Item Types
@subsubsection komimportmail Aux-Item Types
778

779
780
781
During the design and implementation of the @command{komimportmail} mail
importer, some new aux-items were defined to solve specific problems.
These aux-items are documented here:
782

783
@table @samp
784

785
@item mx-mime-belongs-to [10100] (text)
786

787
788
Data is a decimal text number that this text is an attachment to.  Most
likely, the current text is also a comment (or perhaps a footnote) to
789
the text mentioned in the aux-item.  A client can use this aux-item to
790
791
alter the display format of the text (stating that this is an
attachment, not a normal comment).
792
793


794
@item mx-mime-part-in [10101] (text)
795

796
Data is a decimal text number of a text that is an attachment to the
797
current one.  In other words: this is the converse of mx-mime-belongs-to.
798
799
A client can use this aux-item to know which comments to mark as
attachments; the remaining comments are assumed to be normal.
800

801
@item mx-mime-misc [10102] (text)
802

803
Data is a string that contains all of the MIME headers for the current
804
text.  It is set by the importer.  The fields are concatenated with
805
"\n".
806

807
Clients are encouraged to provide a command to display this.
808

809
@item mx-envelope-sender [10103] (text)
810

811
Data is the envelope sender of an imported text.  The mail server is
812
supposed to pass this information to the importer, for inclusion here.
David Byers's avatar
David Byers committed
813

814
@item mx-mime-file-name [10104] (text)
David Byers's avatar
David Byers committed
815

816
Data is the file name of an attachment.  Most likely, the importer gets
817
818
this information from a @code{name} parameter on a @code{Content-Type}
MIME header line.
819

820
821
Clients are encouraged to use this file name as the default file name
when the user chooses to save the text.
822

823
@end table
David Byers's avatar
David Byers committed
824

825
826
@node Experimental Aux-Item Types
@subsection Experimental Aux-Item Types
827

828
829
Experimental numbers are free for all.  Use 'em any way you want.  All
numbers in the range 20000-29999 are for experimental use.
830
831
832



833
834
@node Defining New Aux-Item Types
@subsection Defining New Aux-Item Types
835

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

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

846
847
848
849
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.
850

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





859
860
@node Security
@section Security
861

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

869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
@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
884

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

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

915
916
917
918
919
920
@item create-conf
@emph{Normally assigned}
@table @asis
@item Level 0
Create conferences
@end table
921

922
923
924
925
926
927
@item create-pers
@emph{Normally assigned}
@table @asis
@item Level 0
Create persons
@end table
928

929
@end table
David Byers's avatar
David Byers committed
930

931

932
933
@node Membership and Reading
@section Membership and Reading
934

935
Persons' memberships in conferences are represented in the protocol as
936
arrays of @type{Membership}-typed values.  This structure contains
937
938
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
939

940
941
There are two kinds of memberships.  An active membership indicates that
the person is actively participating in the conference, wants to know if
942
there are unread texts and wants to receive messages send to the
943
conference.  A passive membership is similar to no membership at all.  The
944
person is still a member but will not receive messages sent to the
945
conference and will not be notified when there are new texts.  From the
946
947
user's perspective, passive membership should be like no membership at
all, but the server still remembers what the user has read in the
948
conference while he or she was an active member.  Since protocol version
949
10 a bit in the membership type field of the membership structure
950
indicates the type of membership.  Previously the server did not support
951
952
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
953

954
The membership record indicates which texts have been read through the
955
956
@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
957
958
texts with local numbers contained in the @field{read-texts} array have
been read.
959

960
Finding out which articles a person has read in a particular conference
961
962
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:
963

964
965
966
967
@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.
968
@item Remove the global numbers corresponding to local numbers contained
969
970
971
in @field{read-texts} from the result.
@item Get and translate more texts as needed.
@end enumerate
972

973
The process is complicated because of the translation between local
974
and global text numbers.  If the server does not implement the
975
976
977
@reqdlink{local-to-global} call@linkhere{}, it is possible to use the less
efficient but perfectly serviceable @reqdlink{get-map} call
instead@linkhere{}.
978

979

980
981
@node Fundamentals
@chapter Fundamentals of Protocol A
982

983
The data types in protocol A come in two flavors.  The first (vanilla)
984
are the simple data types from which the LysKOM (chocolate) data types
985
are built.  Simple data types include things like integers and strings
986
while complex data types include things such as conferences and people.
987

988
989
990
@menu
* Notation::                    
* Simple Data Types::           
991
* Connecting to the Server::    
992
* Client-Server Dialog::        
993
* Protocol Error Messages::     
994
@end menu
995

996
997
@node Notation
@section Notation
998

999
1000
This specification uses a BNF-like grammar to describe the protocol and
its data elements.
1001

1002
Data fields have been given names that start with a lower-case letter.
1003

1004
1005
Fundamental data types have names in all-caps (such as @type{INT32} and
@type{ARRAY}).
1006

1007
Derived data types have names that start with an upper-case letter.  (If
1008
1009
1010
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.
1011

1012
1013
Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
1014
1015
terminates statements in the grammar.  In some specifications there are
literal strings.  There is to be no whitespace before or after literal
1016