Protocol-A.texi 307 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
53
@c
@c Index setup
@c

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

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

61
62
63


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

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

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

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

78
@c @reqlink{login} is used for protocol requests, that should be linked.
79
80
81
82
83
84
85
86
87
88
89
90
91
92

@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
93
@c should be linked, where the link should occur a few words after the
94
95
96
97
98
99
@c request itself.

@ifhtml

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

@end ifhtml

@ifnothtml
@ifnottex

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

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

122
123
@iftex

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

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

137
138
139
140
141
142
143
144
145
146
@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

147
@c @asynclink{async-login} is used for async names, that should be linked.
148
149
150
151
152
153
154
155
156
157
158
159
160
161

@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,
162
@c that should be linked, where the link should occur a few words after
163
164
165
166
167
168
@c the async name itself.

@ifhtml

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

@end ifhtml

@ifnothtml
@ifnottex

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

@macro asyncdlink {n}
183
@code{\n\}
184
185
186
187
188
189
190
191
192
193
194
@unmacro linkhere
@macro linkhere
(@pxref{\n\})
@end macro
@end macro
@end ifnottex

@iftex

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

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

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

211
212
213
214
215
216
@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}
217
@ref{\n\}
218
219
220
221
222
@end macro
@end ifhtml

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

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
252
253
254
255
256
257
258
259
260
261
262
263
264
@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

265
266
267
268
269
270
271
@c @reqexample is used immediately before Protocol-A example
@c fragments.
@macro reqexample
@need 2000
@i{Example:}
@end macro

272
273
274
275
276
277
278
279
280
@c
@c Define strings that can be encoded as macros instead of with @set.
@c

@macro daemon
@badspell{d@ae{}mon}
@end macro


281
282
@c %**end of header

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

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

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

@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
309
310
@end ifinfo

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

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

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

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
350
351
352
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
353

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

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

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

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

@menu
386
387
388
389
* Preface::                     What is LysKOM?  Who wrote this document?
* Concepts::                    Articles, conferences, aux-items, @dots{}
* Fundamentals::                The building blocks of Protocol A.
* LysKOM Data Types::           Domain-specific data types used in Protocol A.
390
* Protocol Requests::           Each request explained in depth.
391
392
393
394
395
396
397
398
399
400
401
402
* Asynchronous Messages::       Unsolicited information from the server.
* Error Codes::                 All error codes with explanations.
* Aux-Item Types::              All predefined aux-item types.
* Name Expansion::              Looking up the name of a conference or person.
* LysKOM Content Types::        Predefined content types for articles.
* The User Area::               Store client-specific settings in the server.
* Writing Clients::             A few tips for client writers.
* Importing and Exporting E-Mail::  A few thoughts on e-mail integration.
* Future changes::              The protocol is not yet perfect.
* Protocol Version History::    The protocol was even less perfect before.
* Document Edition History::    Changes in this document.
* Index::                       Index of protocol elements.
David Byers's avatar
David Byers committed
403
404
@end menu

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

408
409
410
411
412
@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.

413
414
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/}.
415
416
@end iftex

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

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

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

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

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

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

@menu
448
449
450
451
452
453
454
455
456
457
* Articles::                    Reading and writing articles is what
                                  LysKOM is about.
* Conferences::                 Articles are organized in conferences.
* Persons and Sessions::        Persons log on to the LysKOM system.
* The Misc-Info List::          How articles are organized in comment
                                  chains and in conferences.
* The Aux-Item List::           A generic extension mechanism.
* Security::                    Some persons have more privileges than
                                  others.
* Membership and Reading::      You don't have to read anything twice.
David Byers's avatar
David Byers committed
458
459
460
@end menu


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

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

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

475
476
477
478
479
480
481
482
483
484
485
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
486

487
Occasionally it is necessary to map between local and global numbers.
488
The server call @reqdlink{local-to-global} does this@linkhere{}.
David Byers's avatar
David Byers committed
489
490
491



492
@node Conferences
David Byers's avatar
David Byers committed
493
494
@section Conferences

495
496
Conferences hold articles.  They are represented in the protocol as a
data type called @type{Conference}.  Each conference has a
497
498
@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
499
If the supervisor is a person, the members of that person's mailbox
500
are supervisors, which in most cases is only that person.  We have also
501
introduced a type called @type{UConference} (pronounced micro-conf-stat)
502
which holds a subset of the information contained in the full
503
@type{Conference} type.  Use the @type{UConference} type whenever
504
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
505

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

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



542
@node Persons and Sessions
543
@section Persons and Sessions
David Byers's avatar
David Byers committed
544
545

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

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


560
@node The Misc-Info List
David Byers's avatar
David Byers committed
561
562
@section The Misc-Info List

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

571
@subsection Recipient
David Byers's avatar
David Byers committed
572

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


595
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
596

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

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


625
626
627
@subsection Blank Carbon Copy (BCC) Recipient

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

635
636
637
638
639
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.
640
641

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

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


670
@subsection Comment To
David Byers's avatar
David Byers committed
671

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


685
@subsection Footnote To
David Byers's avatar
David Byers committed
686

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


696
@subsection Comment in
David Byers's avatar
David Byers committed
697

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


705
@subsection Footnote in
David Byers's avatar
David Byers committed
706

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


714
@node The Aux-Item List
715
@section The Aux-Item List
716
717

The aux-item list is used as a generic extension mechanism in the LysKOM
718
server and in protocol A.
719
720

@menu
721
722
723
724
725
726
727
* About Aux-Items::             An introduction to aux-items.
* Predefined Aux-Item Types::   Predefined aux-items are part of the protocol.
* Client-Specific Aux-Item Types::  Clients can allocate aux-items for
                                    their private use.
* Experimental Aux-Item Types::  A block of aux-items are reserved for
                                    experimental use.
* Defining New Aux-Item Types::  Creating new aux-item types is easy.
728
729
@end menu

730
@node About Aux-Items
731
@subsection About Aux-Items
732
733
734

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

740
The exact structure of an aux item is specified elsewhere
741
(@pxref{Auxiliary Information}).  The important fields here are the
742
@field{aux-no}, @field{tag} and @field{data} fields.
743

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

751
The @field{tag} field identifies the type of aux item.  It is used by
752
753
754
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.
755

756
The @field{data} field is a simple string.  The meaning of the string
757
758
759
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.)
760
761
762



763
@node Predefined Aux-Item Types
764
@subsection Predefined Aux-Item Types
765

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

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

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

782
783
784
785
786
787
788
789
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.
790

791
792
@node Client-Specific Aux-Item Types
@subsection Client-Specific Aux-Item Types
793

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

799
800
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
801
should never create items with tags in a range assigned to another
802
803
804
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}.
805

806
807
808
809
810
Currently, the following ranges are assigned to clients:
@itemize @bullet
@item 10000-10099: The Elisp Client
@item 10100-10199: komimportmail
@end itemize
811

812
813
If you want a range of numbers, send e-mail to the LysKOM development
group.
814

815
816
@node Experimental Aux-Item Types
@subsection Experimental Aux-Item Types
817

818
819
Experimental numbers are free for all.  Use @badspell{'em} any way you
want.  All
820
numbers in the range 20000-29999 are for experimental use.
821
822
823



824
825
@node Defining New Aux-Item Types
@subsection Defining New Aux-Item Types
826

827
828
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
829
830
and send this to the LysKOM development group.  We'll assign a number to
your item and put the documentation in this document.
831

832
If you're not sure what you want the data to look like yet, make a note
833
in your documentation that the data format might change.  Once you have a
834
835
data format you're happy with, update the documentation so others may
use your item.
836

837
838
839
840
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.
841

842
The idea is not to reject any type of item, unless there's already an
843
item type that does the job just as well.  Adding item types should be a
844
much less painful process than adding new calls.
845
846
847
848
849





850
851
@node Security
@section Security
852

853
854
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
855
system require both the sufficient privileges and a sufficient
856
security level.  The privileges currently available are @priv{wheel},
857
@priv{admin}, @priv{statistic}, @priv{create-conf}, @priv{create-pers}
858
and @priv{change-name}.  Security levels range from 0 to 255.
859

860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
@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
875

876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
@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
898

899
900
901
902
903
904
@item statistic
@emph{Normally not assigned}
@table @asis
@item Level 2
Read the statistics portions of persons, even if protected
@end table
905

906
907
908
909
910
911
@item create-conf
@emph{Normally assigned}
@table @asis
@item Level 0
Create conferences
@end table
912

913
914
915
916
917
918
@item create-pers
@emph{Normally assigned}
@table @asis
@item Level 0
Create persons
@end table
919

920
@end table
David Byers's avatar
David Byers committed
921

922

923
924
@node Membership and Reading
@section Membership and Reading
925

926
Persons' memberships in conferences are represented in the protocol as
927
arrays of @type{Membership}-typed values.  This structure contains
928
929
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
930

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

945
The membership record indicates which texts have been read through the
946
947
@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
948
949
texts with local numbers contained in the @field{read-texts} array have
been read.
950

951
Finding out which articles a person has read in a particular conference
952
953
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:
954

955
956
957
958
@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.
959
@item Remove the global numbers corresponding to local numbers contained
960
961
962
in @field{read-texts} from the result.
@item Get and translate more texts as needed.
@end enumerate
963

964
The process is complicated because of the translation between local
965
and global text numbers.  If the server does not implement the
966
967
968
@reqdlink{local-to-global} call@linkhere{}, it is possible to use the less
efficient but perfectly serviceable @reqdlink{get-map} call
instead@linkhere{}.
969

970

971
972
@node Fundamentals
@chapter Fundamentals of Protocol A
973

974
The data types in protocol A come in two flavors.  The first (vanilla)
975
are the simple data types from which the LysKOM (chocolate) data types
976
are built.  Simple data types include things like integers and strings
977
while complex data types include things such as conferences and people.
978

979
@menu
980
981
982
983
984
* Notation::                    The grammar used in this document.
* Simple Data Types::           BOOL, INT32, ARRAY, @dots{}
* Connecting to the Server::    The initial handshake.
* Client-Server Dialog::        Requests, replies, asynchronous messages.
* Protocol Error Messages::     How the server reacts to syntax errors.
985
@end menu
986

987
988
@node Notation
@section Notation
989

990
991
This specification uses a BNF-like grammar to describe the protocol and
its data elements.
992

993
Data fields have been given names that start with a lower-case letter.
994

995
996
Fundamental data types have names in all-caps (such as @type{INT32} and
@type{ARRAY}).
997

998
Derived data types have names that start with an upper-case letter.  (If
999
1000
1001
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.
1002

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


1010
1011
@node Simple Data Types
@section Simple Data Types
1012