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: Explain how the garb works with nice and keep-commented
David Byers's avatar
David Byers committed
4
@c
5
@c $Id: Protocol-A.texi,v 1.147 2001/05/09 06:55:10 ceder Exp $
David Byers's avatar
David Byers committed
6
7
8
9
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
10
11
12
13
14
@c @afourpaper

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

16
17
18


@c
19
@c Define a few strings that contains characters from ISO Latin-1.
20
@c
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

@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

39
40
41
42
43
44


@c
@c Index setup
@c

45
46
47
48
49
50
51
@c Index for asynchronous messages.
@defcodeindex am

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

52
53
54
55
56
57


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

58
@c @req{login} is used for protocol requests.
59

60
61
62
63
@macro req {n}
@code{\n\}
@end macro

64
65
66
67
68
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
@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
107

108
109
@iftex

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

112
113
114
115
116
117
@tex
    \gdef\reqdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
118
119
120
@end iftex
@end ifnothtml

121
122
123
124
125
126
127
128
129
130
@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

131
132
133
134
135
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
@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

188
189
190
191
192
@c @type{Conference} is used for LysKOM types.
@macro type {n}
@code{\n\}
@end macro

193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
@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

209
210
211
212
213
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
@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

247
248
249
250
251
252
253
@c @reqexample is used immediately before Protocol-A example
@c fragments.
@macro reqexample
@need 2000
@i{Example:}
@end macro

254
255
@c %**end of header

David Byers's avatar
David Byers committed
256
@ifinfo
257
258
259
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
260

Per Cederqvist's avatar
Per Cederqvist committed
261
Copyright @copyright{} 1995-2000 Lysator ACS.
David Byers's avatar
David Byers committed
262
263
264
265

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.
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281

@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
282
283
@end ifinfo

284
285
286
287
@c FIXME: What does this do?
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
288
@tex
289
290
291
292
293
\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
294

David Byers's avatar
David Byers committed
295
296
@titlepage
@title{LysKOM Protocol A}
297
298
299
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
300
301
302
303
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
Per Cederqvist's avatar
Per Cederqvist committed
304
Copyright @copyright{} 1995-2000 Lysator ACS
David Byers's avatar
David Byers committed
305
306
307
308
309
310
311
312
313
314
315
316
317
318

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
319
320
321
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
322

323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
@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
341
@node Top
342
@top LysKOM Protocol A
343

344
345
346
347
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.

348
The most up-to-date version if this document can always be found at
349
350
@uref{http://www.lysator.liu.se/lyskom/protocol/}.
@end ifnottex
David Byers's avatar
David Byers committed
351
352

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

372
373
@node Preface
@chapter Preface
David Byers's avatar
David Byers committed
374

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

380
381
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/}.
382
383
@end iftex

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

392
393
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
394

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

David Byers's avatar
David Byers committed
405
406
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
407

408
409
@node Concepts
@chapter Concepts used in LysKOM
David Byers's avatar
David Byers committed
410
411

This chapter introduces the concepts used in LysKOM, such as articles,
412
conferences and sessions.
David Byers's avatar
David Byers committed
413
414

@menu
415
416
* Articles::                    
* Conferences::                 
417
* Persons and Sessions::        
418
419
420
421
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
David Byers's avatar
David Byers committed
422
423
424
@end menu


425
@node Articles
David Byers's avatar
David Byers committed
426
427
@section Articles

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

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

439
440
441
442
443
444
445
446
447
448
449
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
450

451
Occasionally it is necessary to map between local and global numbers.
452
The server call @reqdlink{local-to-global} does this@linkhere{}.
David Byers's avatar
David Byers committed
453
454
455



456
@node Conferences
David Byers's avatar
David Byers committed
457
458
@section Conferences

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

470
Each conference has a type, which is essentially a collection of
471
boolean flags.  Currently the flags @conftype{rd-prot},
472
473
@conftype{letterbox}, @conftype{secret}, @conftype{original},
@conftype{allow-anonymous} and @conftype{forbid-secret} are defined.
David Byers's avatar
David Byers committed
474

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



506
@node Persons and Sessions
507
@section Persons and Sessions
David Byers's avatar
David Byers committed
508
509

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

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


524
@node The Misc-Info List
David Byers's avatar
David Byers committed
525
526
@section The Misc-Info List

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

535
@subsection Recipient
David Byers's avatar
David Byers committed
536

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


559
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
560

561
The carbon-copy recipient group is identical to the recipient group
562
563
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
564
all recipients, but not to carbon-copy recipients of the original
565
article.  This difference is enforced by the clients.
David Byers's avatar
David Byers committed
566

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


589
590
591
@subsection Blank Carbon Copy (BCC) Recipient

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

599
600
601
602
603
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.
604
605

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

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


634
@subsection Comment To
David Byers's avatar
David Byers committed
635

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


649
@subsection Footnote To
David Byers's avatar
David Byers committed
650

651
@table @misc
652
@item footn-to
David Byers's avatar
David Byers committed
653
654
655
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
656
been created.  It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
657
658
659
@end table


660
@subsection Comment in
David Byers's avatar
David Byers committed
661

662
@table @misc
David Byers's avatar
David Byers committed
663
@item comm-in
664
Present when there are comments to this article.  It contains the article
David Byers's avatar
David Byers committed
665
666
667
668
number which is a comment to this article.
@end table


669
@subsection Footnote in
David Byers's avatar
David Byers committed
670

671
@table @misc
672
@item footn-in
673
Present when there are footnotes to this article.  It contains the
David Byers's avatar
David Byers committed
674
675
676
677
article number which is a footnote to this article.
@end table


678
@node The Aux-Item List
679
@section The Aux-Item List
680
681

The aux-item list is used as a generic extension mechanism in the LysKOM
682
server and in protocol A.
683
684

@menu
685
686
687
688
689
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
690
691
@end menu

692
@node About Aux-Items
693
@subsection About Aux-Items
694
695
696

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

702
The exact structure of an aux item is specified elsewhere
703
(@pxref{Auxiliary Information}).  The important fields here are the
704
@field{aux-no}, @field{tag} and @field{data} fields.
705

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

713
The @field{tag} field identifies the type of aux item.  It is used by
714
715
716
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.
717

718
The @field{data} field is a simple string.  The meaning of the string
719
720
721
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.)
722
723
724



725
@node Predefined Aux-Item Types
726
@subsection Predefined Aux-Item Types
727

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

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

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

744
745
746
747
748
749
750
751
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.
752

753
754
@node Client-Specific Aux-Item Types
@subsection Client-Specific Aux-Item Types
755

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

761
762
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
763
should never create items with tags in a range assigned to another
764
765
766
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}.
767

768
769
770
771
772
Currently, the following ranges are assigned to clients:
@itemize @bullet
@item 10000-10099: The Elisp Client
@item 10100-10199: komimportmail
@end itemize
773

774
775
If you want a range of numbers, send e-mail to the LysKOM development
group.
776

777
778
@node Experimental Aux-Item Types
@subsection Experimental Aux-Item Types
779

780
781
Experimental numbers are free for all.  Use 'em any way you want.  All
numbers in the range 20000-29999 are for experimental use.
782
783
784



785
786
@node Defining New Aux-Item Types
@subsection Defining New Aux-Item Types
787

788
789
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
790
791
and send this to the LysKOM development group.  We'll assign a number to
your item and put the documentation in this document.
792

793
If you're not sure what you want the data to look like yet, make a note
794
in your documentation that the data format might change.  Once you have a
795
796
data format you're happy with, update the documentation so others may
use your item.
797

798
799
800
801
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.
802

803
The idea is not to reject any type of item, unless there's already an
804
item type that does the job just as well.  Adding item types should be a
805
much less painful process than adding new calls.
806
807
808
809
810





811
812
@node Security
@section Security
813

814
815
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
816
system require both the sufficient privileges and a sufficient
817
security level.  The privileges currently available are @priv{wheel},
818
@priv{admin}, @priv{statistic}, @priv{create-conf}, @priv{create-pers}
819
and @priv{change-name}.  Security levels range from 0 to 255.
820

821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
@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
836

837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
@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
859

860
861
862
863
864
865
@item statistic
@emph{Normally not assigned}
@table @asis
@item Level 2
Read the statistics portions of persons, even if protected
@end table
866

867
868
869
870
871
872
@item create-conf
@emph{Normally assigned}
@table @asis
@item Level 0
Create conferences
@end table
873

874
875
876
877
878
879
@item create-pers
@emph{Normally assigned}
@table @asis
@item Level 0
Create persons
@end table
880

881
@end table
David Byers's avatar
David Byers committed
882

883

884
885
@node Membership and Reading
@section Membership and Reading
886

887
Persons' memberships in conferences are represented in the protocol as
888
arrays of @type{Membership}-typed values.  This structure contains
889
890
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
891

892
893
There are two kinds of memberships.  An active membership indicates that
the person is actively participating in the conference, wants to know if
894
there are unread texts and wants to receive messages send to the
895
conference.  A passive membership is similar to no membership at all.  The
896
person is still a member but will not receive messages sent to the
897
conference and will not be notified when there are new texts.  From the
898
899
user's perspective, passive membership should be like no membership at
all, but the server still remembers what the user has read in the
900
conference while he or she was an active member.  Since protocol version
901
10 a bit in the membership type field of the membership structure
902
indicates the type of membership.  Previously the server did not support
903
904
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
905

906
The membership record indicates which texts have been read through the
907
908
@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
909
910
texts with local numbers contained in the @field{read-texts} array have
been read.
911

912
Finding out which articles a person has read in a particular conference
913
914
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:
915

916
917
918
919
@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.
920
@item Remove the global numbers corresponding to local numbers contained
921
922
923
in @field{read-texts} from the result.
@item Get and translate more texts as needed.
@end enumerate
924

925
The process is complicated because of the translation between local
926
and global text numbers.  If the server does not implement the
927
928
929
@reqdlink{local-to-global} call@linkhere{}, it is possible to use the less
efficient but perfectly serviceable @reqdlink{get-map} call
instead@linkhere{}.
930

931

932
933
@node Fundamentals
@chapter Fundamentals of Protocol A
934

935
The data types in protocol A come in two flavors.  The first (vanilla)
936
are the simple data types from which the LysKOM (chocolate) data types
937
are built.  Simple data types include things like integers and strings
938
while complex data types include things such as conferences and people.
939

940
941
942
@menu
* Notation::                    
* Simple Data Types::           
943
* Connecting to the Server::    
944
* Client-Server Dialog::        
945
* Protocol Error Messages::     
946
@end menu
947

948
949
@node Notation
@section Notation
950

951
952
This specification uses a BNF-like grammar to describe the protocol and
its data elements.
953

954
Data fields have been given names that start with a lower-case letter.
955

956
957
Fundamental data types have names in all-caps (such as @type{INT32} and
@type{ARRAY}).
958

959
Derived data types have names that start with an upper-case letter.  (If
960
961
962
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.
963

964
965
Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
966
967
terminates statements in the grammar.  In some specifications there are
literal strings.  There is to be no whitespace before or after literal
968
strings unless there is whitespace in the literal itself.
969
970


971
972
@node Simple Data Types
@section Simple Data Types
973

974
975
976
977
978
@anchor{INT32}
@anchor{INT16}
@anchor{INT8}
@anchor{BOOL}
@subsection Integers
979

980
981
982
983
984
@tindex INT32
@tindex INT16
@tindex INT8
@tindex BOOL
@type{INT32}, @type{INT16}, @type{INT8} and @type{BOOL} are non-negative
985
integers which must fit in 32, 16, 8 and 1 bits, respectively.  They are
986
transmitted to the server in ASCII-encoded decimal notation.
987

988

989
990
@anchor{HOLLERITH}
@subsection Strings
991

992
@tindex HOLLERITH
993
@type{HOLLERITH} denotes character strings of arbitrary length.  They are
994
995
transmitted as @code{@var{n}H@var{text}} where @var{text} is the string and
@var{n} is the number of characters in @var{text} in decimal
996
notation.  All byte values are allowed in the string itself, including
997
nulls.
998

999
Long live FORTRAN!
1000

1001
1002


1003
1004
@anchor{BITSTRING}
@subsection Bit Strings
1005

1006
1007
@tindex BITSTRING
@type{BITSTRING} is a string of bits, commonly used for a set of
1008
boolean-valued flags.  Bit strings are denoted as
1009

1010
1011
1012
@example
        BITSTRING ( name-1; name-2; name-3; @dots{} )
@end example
1013

1014
in this specification.  They are transmitted as a sequence of ASCII ones
1015
and zeroes in the order the fields are listed.
1016

1017
For instance, given the specification
1018

1019
1020
1021
1022
1023
1024
1025
1026
@example
        shape-of-world ::= BITSTRING (
                is-flat;
                is-round;
                is-2d;
                is-3d;
        )
@end example
1027

1028
1029
most peoples idea of @code{shape-of-world} would be sent as @code{0101}
(round and three-dimensional.)
1030
1031


1032
1033
@anchor{ENUMERATION}
@subsection Enumerations
1034

1035
@tindex ENUMERATION
Per Cederqvist's avatar