Protocol-A.texi 291 KB
Newer Older
David Byers's avatar
David Byers committed
1
\input texinfo                         @c -*-texinfo-*-
David Byers's avatar
David Byers committed
2
3
@c
@c FIXME: Explain how the garb works with nice and keep-commented
Per Cederqvist's avatar
Per Cederqvist committed
4
5
@c FIXME: @i{Example:} is only used in front of some examples.
@c FIXME: Make all types clickable in HTML (and info?)
6
7
@c FIXME: Example [20].
@c FIXME: I]M in examples introduces spurious blank lines in DVI output.
David Byers's avatar
David Byers committed
8
@c
9
@c $Id: Protocol-A.texi,v 1.122 2001/04/30 22:22:33 ceder Exp $
David Byers's avatar
David Byers committed
10
11
12
13
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
14
@c @afourpaper
David Byers's avatar
David Byers committed
15
@c %**end of header
16
17
18
19

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

21
22
23
24
25
26
27
@c Index for asynchronous messages.
@defcodeindex am

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

28
@c @req{login} is used for protocol requests.
29

30
31
32
33
@macro req {n}
@code{\n\}
@end macro

34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
@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
77

78
79
@iftex

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

82
83
84
85
86
87
@tex
    \gdef\reqdlink#1{%
        \code{#1}%
        \gdef\linkhere{ (\pxref{#1})}%
    }
@end tex
88
89
90
@end iftex
@end ifnothtml

91
92
93
94
95
96
97
98
99
100
@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

101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
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
@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

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
193
194
195
196
197
198
199
200
@c @type{Conference} is used for LysKOM types.
@macro type {n}
@code{\n\}
@end macro

@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

201
202
203
204
205
206
207
@c @reqexample is used immediately before Protocol-A example
@c fragments.
@macro reqexample
@need 2000
@i{Example:}
@end macro

David Byers's avatar
David Byers committed
208
@ifinfo
209
210
211
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
212

Per Cederqvist's avatar
Per Cederqvist committed
213
Copyright @copyright{} 1995-2000 Lysator ACS.
David Byers's avatar
David Byers committed
214
215
216
217

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.
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233

@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
234
235
@end ifinfo

236
237
238
239
@c FIXME: What does this do?
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
240
@tex
241
242
243
244
245
\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
246

David Byers's avatar
David Byers committed
247
248
@titlepage
@title{LysKOM Protocol A}
249
250
251
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
252
253
254
255
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
Per Cederqvist's avatar
Per Cederqvist committed
256
Copyright @copyright{} 1995-2000 Lysator ACS
David Byers's avatar
David Byers committed
257
258
259
260
261
262
263
264
265
266
267
268
269
270

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
271
272
273
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
274

275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
@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
293
@node Top
294
@top LysKOM Protocol A
295

296
297
298
299
300
301
302
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.

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

@menu
305
306
307
308
309
310
311
312
313
314
* Overview::                    
* Introduction::                
* Data Types::                  
* Protocol Requests::           
* Asynchronous Messages::       
* Error Codes::                 
* LysKOM Content Types::        
* The User Area::               
* Writing Clients::             
* Importing and Exporting E-Mail::  
315
* Index::                       
David Byers's avatar
David Byers committed
316
317
@end menu

318
@node Overview
David Byers's avatar
David Byers committed
319
320
@chapter Overview

321
322
323
324
325
@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.

326
327
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/}.
328
329
@end iftex

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

338
339
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
340
341

This specification is the work of several people. The main contributors have
342
been
David Byers's avatar
David Byers committed
343
344
Per Cederqvist @email{ceder@@lysator.liu.se}, 
David Byers @email{byers@@lysator.liu.se},
345
@ifnottex
David Byers's avatar
David Byers committed
346
Pär
347
@end ifnottex
David Byers's avatar
David Byers committed
348
349
350
@iftex
P@"ar
@end iftex
David Byers's avatar
David Byers committed
351
352
353
354
Emanuelsson @email{pell@@lysator.liu.se},
Thomas Bellman @email{bellman@@lysator.liu.se}, 
Lars Aronsson @email{aronsson@@lysator.liu.se},
Linus Tolke @email{linus@@lysator.liu.se} and
355
@ifnottex
David Byers's avatar
David Byers committed
356
Kent Engström
357
@end ifnottex
David Byers's avatar
David Byers committed
358
359
360
@iftex
Kent Eng@-str@"om@penalty-10000
@end iftex
David Byers's avatar
David Byers committed
361
@email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
362

David Byers's avatar
David Byers committed
363
364
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
365

366
@menu
367
* Document Edition History::    
368
369
* Protocol Version History::    
* Notation::                    
David Byers's avatar
David Byers committed
370
371
@end menu

372
373
@node Document Edition History
@section Document Edition History
David Byers's avatar
David Byers committed
374
375

@table @asis
376

377
@item 10.4: 2001-04-07
378
Editorial changes needed to publish an online version on the web at
379
380
@uref{http://www.lysator.liu.se/lyskom/protocol/}.

Per Cederqvist's avatar
Per Cederqvist committed
381
382
@item 10.3: 2000-09-09
Several aux-items can be set on letterboxes and not only conferences.  A
383
384
385
few can now be set on the server.  The @aux{allowed-content-type} and
@aux{recommended-conf} aux-items were added.  The
@aux{mx-allow-filter} and @aux{mx-reject-forward} aux-items are marked
Per Cederqvist's avatar
Per Cederqvist committed
386
387
388
obsolete.  Text regarding mail import was improved, based on actual
experience in writing an email importer.  Reserved a range of aux-items
for komimportmail.  Several minor corrections and clarifications made.
389
Distributed with lyskomd 2.0.4.
Per Cederqvist's avatar
Per Cederqvist committed
390

Per Cederqvist's avatar
Per Cederqvist committed
391
392
393
394
@item 10.2: 1999-07-23
Some typos and other minor errors were fixed.  Distributed with lyskomd
2.0.2.

395
@item 10.1: 1999-07-12
396
Call @req{sub-comment} was incorrectly marked obsolete. This has been
397
398
corrected. Regexps are case sensitive.  The Info-Type enumeration was
introduced in the description of the protocol.  (Previous versions of
399
400
401
the protocol had broken definitions of @req{add-recipient},
@async{async-new-recipient} and @async{async-sub-recipient}.)  Distributed
with lyskomd 2.0.1.
David Byers's avatar
Server:    
David Byers committed
402

403
@item 10.0: 1999-06-27
404
405
The specification was translated to English and converted to Texinfo by
David Byers.  Protocol version 10.  Distributed with lyskomd 2.0.0.
406
Note: this edition incorrectly marked the @req{sub-comment} call as
407
408
obsolete, and stated that regexp lookup was case insensitive.  Both
statements were wrong, and has since been fixed.
409
410

@item 9.0: 1996-08-04
411
Protocol version 9.  Distributed with lyskomd 1.9.0.
412

David Byers's avatar
David Byers committed
413
@item 8.0: 1995-11-10
414
Protocol version 8.  Distributed with lyskomd 1.8.0.
David Byers's avatar
David Byers committed
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438

@item 7.1: 1995-01-08.
Protocol and document revision history were added by Per Cederqvist. Outline
mode was used to make the document more manageable. This version was
distributed with lyskomd 1.7.1.

@item 7.0: 1994-12-31.
The first specification with a version number. All calls that had been added
since 1991-06-25 were documented. Pell and Per Cederqvist did the deed. This
version was distributed with lyskomd 1.7.0.

@item 1993-05-19.
Linus Tolke wrote comments for some calls that were without comments.

@item 1992-07-06.
Linus Tolke converted the document to ISO 8859-1.

@item 1991-08-12.
Per Cederqvist started using version control for documentation.

@item 1991-06-25.
Lars Aronsson documented the protocol that was in use at the time.
@end table

439
@node Protocol Version History
440
441
442
@section Protocol Version History

@subsection Protocol version 10 (first implemented in lyskomd 2.0.0)
David Byers's avatar
David Byers committed
443

444
@table @asis
445
446
447
448
449
450

@item Error codes

The error codes are now documented.  Several error codes were changed to
more sane values while documenting the new behaviour.

451
@item New Server Calls
452
453
454

These new calls have status Recommended.

455
456
457
458
459
460
461
462
463
464
465
466
467
@itemize @bullet
@item 85=get-collate-table
@item 86=create-text
@item 87=create-anonymous-text
@item 88=create-conf
@item 89=create-person
@item 90=get-text-stat
@item 91=get-conf-stat
@item 92=modify-text-info
@item 93=modify-conf-info
@item 94=get-info
@item 95=modify-system-info
@item 96=query-predefined-aux-items
468
469
470
471
@item 98=query-read-texts
@item 99=get-membership
@item 100=add-member
@item 101=get-members
472
473
474
@item 102=set-membership-type
@item 103=local-to-global
@item 104=map-created-texts
475
476
477
478
479
480
481
@item 106=set-pers-flags
@end itemize

These new calls have status Experimental.

@itemize @bullet
@item 97=set-expire
David Byers's avatar
David Byers committed
482
@item 105=set-keep-commented
483
484
@end itemize

485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
@item Name changes

@multitable {59=create-anonymous-text} {59=create-anonymous-text-old}
@item Old name                 @tab New name
@item 5=create-person          @tab 5=create-person-old
@item 9=query-read-texts       @tab 9=query-read-texts-old
@item 10=create-conf           @tab 10=create-conf-old
@item 13=get-conf-stat-old     @tab 13=get-conf-stat-older
@item 14=add-member            @tab 14=add-member-old
@item 26=get-text-stat         @tab 26=get-text-stat-old
@item 28=create-text           @tab 28=create-text-old
@item 36=get-info              @tab 36=get-info-old
@item 46=get-membership        @tab 46=get-membership-old
@item 48=get-members           @tab 48=get-members-old
@item 50=get-conf-stat         @tab 50=get-conf-stat-old
@item 59=create-anonymous-text @tab 59=create-anonymous-text-old
@end multitable

@item Status change

The following calls have change status from Experimental to Recommended.

507
@itemize @bullet
508
509
510
511
512
@item 58=get-last-text
@item 77=set-last-read
@item 78=get-uconf-stat
@end itemize

513
The following calls have changed status from Recommended or
514
515
516
517
518
519
520
521
522
Experimental to Obsolete.

@itemize @bullet
@item 5=create-person-old
@item 9=query-read-texts-old
@item 10=create-conf-old
@item 14=add-member-old
@item 26=get-text-stat-old
@item 28=create-text-old
523
@item 36=get-info-old
524
@item 46=get-membership-old
525
@item 47=get-created-texts
526
@item 48=get-members-old
527
528
@item 50=get-conf-stat-old
@item 59=create-anonymous-text-old
529
530
@end itemize

531
@item New and Modified Structures
532
@itemize @bullet
533
@item Aux-Item
534
@item Aux-Item-Input
535
536
@item Conference
@item Info
537
538
539
@item Member
@item Membership
@item Membership-Type
540
541
@item Misc-Info
@item Text-Stat
542
543
@end itemize

544
545
546
547
548
549
@item Renamed Asynchronous Messages
A @samp{async-} prefix has been added to the name of all asynchronous
messages.  In addition, 0=new-text has been renamed to
0=async-new-text-old, and it is now considered obsolete.  Clients should
use 80=accept-async to listen to 15=async-new-text instead.

550
551
@item New Asynchronous Messages
@itemize @bullet
552
553
554
555
556
@item 14=async-deleted-text
@item 15=async-new-text
@item 16=async-new-recipient
@item 17=async-sub-recipient
@item 18=async-new-membership
557
@end itemize
558
559
560

@item Notes
@itemize @bullet
561
@item Since protocol version 9 setting a priority of zero for a
562
563
564
conference was supposed to indicate passive membership in a conference. 
It was largely up to the client to implement this. True passive
memberships have been introduced in this protocol version through the
565
Membership-type extension to the Membership type. In order to maintain
566
compatibility with clients that interpret priority 0 as passive
567
568
membership, the old calls @reqlink{add-member-old} and
@reqlink{get-membership-old} perform magic, translating between priorities 
569
570
and membership types. The magic is documented with each call.
@end itemize
571
572
@end table

573

574
@subsection Protocol version 9 (first implemented in lyskomd 1.9.0)
575
576

@table @asis
577
578
@item New functionality
@itemize @bullet
579
@item The server shall now reply with error @errorcode{not-implemented} when
580
581
582
a client attempts to use an unimplemented call.  This feature requires
that the client uses newline as call terminator.
@end itemize
Per Cederqvist's avatar
Per Cederqvist committed
583
@item Added Commands
584
@itemize @bullet
585
586
587
588
589
590
@item 79=set-info: Can change server information.
@item 80=accept-async: Can select asynchronous messages to receive.
@item 81=query-async: Can query which messages are being send.
@item 82=user-active
@item 83=who-is-on-dynamic
@item 84=get-static-session-info
591
@end itemize
592
593
@item Changed names
@itemize @bullet
594
@item @req{change-conference} was previously called @code{pepsi}.  The
595
596
597
598
name was changed, but not the functionality.
@end itemize
@item Status change
@itemize @bullet
599
600
@item 63=@req{who-is-on-ident} is now considered obsolete.
@item 64=@req{get-session-info-ident} is now considered obsolete.
601
@end itemize
602
603
@end table

604
@subsection Protocol version 8 (first implemented in lyskomd 1.8.0)
David Byers's avatar
David Byers committed
605

606
@table @asis
David Byers's avatar
David Byers committed
607
608
609
@item Added Functionality
@itemize @bullet
@item
610
30=add-recipient: Can change @misc{recpt} to @misc{cc-recpt} and vice versa.
David Byers's avatar
David Byers committed
611
@item
612
21=set-conf-type: Accepts @type{Conf-Type} and @type{Extended-Conf-Type}.
David Byers's avatar
David Byers committed
613
@item
614
10=create-conf: Accepts @type{Conf-Type} and @type{Extended-Conf-Type}.
David Byers's avatar
David Byers committed
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
@end itemize

@item New Commands
@itemize @bullet
@item
77=set-last-read
@item
78=get-uconf-stat
@end itemize
@end table

@subsection Protocol version 7 (first implemented in lyskomd 1.7.0)

@table @asis
@item Added Functionality
@itemize @bullet
@item
53=send-message: Recipient can be a conference or a person.
@end itemize

@item New Commands
@itemize @bullet
@item
74=re-z-lookup
@item
640
75=get-version-info
David Byers's avatar
David Byers committed
641
@item
642
76=lookup-z-name
David Byers's avatar
David Byers committed
643
644
645
646
647
@end itemize

@item Other
@itemize @bullet
@item
Per Cederqvist's avatar
Per Cederqvist committed
648
The asynchronous message 1=i-am-off has been removed
David Byers's avatar
David Byers committed
649
650
651
652
653
654
655
656
657
@end itemize
@end table

@subsection Protocol Version 6 (first implemented in lyskomd 1.4.0)

@table @asis
@item New Calls
@itemize @bullet
@item
658
67=lookup-person
David Byers's avatar
David Byers committed
659
@item
660
68=lookup-conf
David Byers's avatar
David Byers committed
661
@item
662
69=set-client-version
David Byers's avatar
David Byers committed
663
@item
664
70=get-client-name
David Byers's avatar
David Byers committed
665
@item
666
71=get-client-version
David Byers's avatar
David Byers committed
667
@item
668
72=mark-text
David Byers's avatar
David Byers committed
669
@item
670
73=unmark-text
David Byers's avatar
David Byers committed
671
672
673
674
675
676
677
678
679
680
@end itemize
@end table


@subsection Protocol Version 5 (first implemented in lyskomd 1.3.0)

@table @asis
@item New Calls
@itemize @bullet
@item
681
65=re-lookup-person
David Byers's avatar
David Byers committed
682
@item
683
66=re-lookup-conf
David Byers's avatar
David Byers committed
684
685
686
687
688
689
690
691
692
693
694
@end itemize
@end table

@subsection Protocol Version 4 (first implemented in lyskomd 1.1.1)

@table @asis
@item New Calls
@itemize @bullet
@item
62=login
@item
695
63=who-is-on-ident
David Byers's avatar
David Byers committed
696
@item
697
64=get-session-info-ident
David Byers's avatar
David Byers committed
698
699
700
701
702
703
704
705
706
@end itemize
@end table

@subsection Protocol Version 3 (first implemented in lyskomd 1.1.0)

@table @asis
@item New Calls
@itemize @bullet
@item
707
61=find-previous-text-no
David Byers's avatar
David Byers committed
708
@item
709
60=find-next-text-no
David Byers's avatar
David Byers committed
710
@item
711
59=create-anonymous-text
David Byers's avatar
David Byers committed
712
@item
713
58=get-last-text
David Byers's avatar
David Byers committed
714
715
716
717
718
719
720
721
722
@end itemize
@end table

@subsection Protocol Version 2 (first implemented in lyskomd 0.30.0)

@table @asis
@item New Calls
@itemize @bullet
@item
723
57=set-user-area
David Byers's avatar
David Byers committed
724
725
726
727
728
729
730
731
732
733
734
@end itemize
@end table

@subsection Protocol Version 1 (first implemented in lyskomd 0.29.2)

@table @asis
@item New Calls
All calls from 0--56.
@end table


735
@node Notation
David Byers's avatar
David Byers committed
736
737
@section Notation

738
This specification uses a BNF-like grammar to describe the protocol and
739
its data elements.
David Byers's avatar
David Byers committed
740

741
Data fields have been given names that start with a lower-case letter.
742

743
744
Fundamental data types have names in all-caps (such as @type{INT32} and
@type{ARRAY}).
745
746
747

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

Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
753
754
755
terminates statements in the grammar. In some specifications there are
literal strings. There is to be no whitespace before or after literal
strings unless there is whitespace in the literal itself.
David Byers's avatar
David Byers committed
756
757


758
@node Introduction
David Byers's avatar
David Byers committed
759
760
761
762
763
764
@chapter Introduction

This chapter introduces the concepts used in LysKOM, such as articles,
conferences and sessions. 

@menu
765
766
767
768
769
770
771
* Articles::                    
* Conferences::                 
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
* Client-Server Dialog::        
David Byers's avatar
David Byers committed
772
773
774
@end menu


775
@node Articles
David Byers's avatar
David Byers committed
776
777
@section Articles

778
An article is represented as a value of the type @type{Text-Stat} and a
David Byers's avatar
David Byers committed
779
string containing the article contents. An article will usually have one
780
781
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
782
@field{nice} value of each of its recipients and it is not marked by any
783
user.
David Byers's avatar
David Byers committed
784

785
786
787
788
789
Currently there is an array of @type{Misc-Info} included in the
@type{Text-Stat}. This array contains information about recipients,
senders, comments and footnotes. In the future the information
contained in the @type{Misc-Info} array will be integrated into the
@type{Text-Stat}.
David Byers's avatar
David Byers committed
790
791
792

Every article has at least one number, the global article number. Global
numbers are assigned in ascending order to new articles, and are never
793
reused. If an article has recipients it will also have a local number
Per Cederqvist's avatar
Per Cederqvist committed
794
for each recipient. Local numbers are used in some data structures to
795
provide more compact storage and to provide an ordering of articles for
796
797
798
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
799

800
Occasionally it is necessary to map between local and global numbers.
801
The server call @reqlink{local-to-global} does this.
David Byers's avatar
David Byers committed
802
803
804



805
@node Conferences
David Byers's avatar
David Byers committed
806
807
@section Conferences

808
Conferences hold articles. They are represented in the protocol as a
809
810
811
data type called @type{Conference}. Each conference has a
@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
812
If the supervisor is a person, the members of that person's mailbox
813
are supervisors, which in most cases is only that person. We have also
814
introduced a type called @type{UConference} (pronounced micro-conf-stat)
815
which holds a subset of the information contained in the full
816
@type{Conference} type. Use the @type{UConference} type whenever
817
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
818

819
820
821
822
Each conference has a type, which is essentially a collection of
boolean flags. Currently the flags @conftype{rd-prot},
@conftype{letterbox}, @conftype{secret}, @conftype{original},
@conftype{allow-anonymous} and @conftype{forbid-secret} are defined.
David Byers's avatar
David Byers committed
823

824
@table @conftype
David Byers's avatar
David Byers committed
825
826
827
828
829
@item rd-prot
The conference is protected from reading by non-members. Persons become
members by having one of the existing members or supervisors add him or
her to the conference. This restriction is enforced by the server.
@item original
830
831
832
833
Conferences of this type are intended for original articles only.
Comments are to be redirected to the super-conference instead. This
restriction is currently not enforced by the server; clients must
implement this functionality.
David Byers's avatar
David Byers committed
834
@item letterbox
835
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
836
are sent to the mailbox and the name of the mailbox is synchronized
837
838
with the person name. It is currently not possible to explicitly set or
clear this flag on a conference.
David Byers's avatar
David Byers committed
839
840
@item secret
Conferences of this type are secret. The server will not divulge any
841
information about the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
842
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
843
844
that person cannot log in using the person name, but must specify a
person number instead.
845
846
847
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
848
849
850
@item forbid-secret
Conferences of this type do not allow secret members. If a conference is 
changed to this type, preexisting secret members remain secret.
David Byers's avatar
David Byers committed
851
852
853
854
@end table



855
856
857
858
@menu
* Persons and Sessions::        
@end menu

859
@node Persons and Sessions
David Byers's avatar
David Byers committed
860
861
862
@subsection Persons and Sessions

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

Connections to the server are represented as values of the type
869
870
@type{Static-Session-Info}, @type{Session-Info-Ident} or
@type{Session-Info}. Sessions have session number that are unique for
871
872
873
874
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
the network connection is closed; a user can log in and out repeatedly
in a single session.
David Byers's avatar
David Byers committed
875
876


877
@node The Misc-Info List
David Byers's avatar
David Byers committed
878
879
@section The Misc-Info List

880
The @type{Misc-Info} list contains tagged data. The fields are sent in
881
groups pertaining to a particular type of information: information about
882
883
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
884
885
886
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
always sent in the order listed below.
David Byers's avatar
David Byers committed
887

888
@subsection Recipient
David Byers's avatar
David Byers committed
889

890
@table @misc
David Byers's avatar
David Byers committed
891
@item recpt
892
893
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
894
@item loc-no
895
896
Always present within a recipient group. It contains the local text
number of the article in the conference specified by the preceding
897
@misc{recpt} field.
David Byers's avatar
David Byers committed
898
@item rec-time
899
900
901
If the recipient is a person, this element is added by the server when
the recipient marks the article as read. It contains the time when the
text was read.
David Byers's avatar
David Byers committed
902
@item sent-by
903
904
905
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
906
@item sent-at
907
908
Present when the recipient was added after the article was created. It
contains the time when the recipient was added.
David Byers's avatar
David Byers committed
909
910
911
@end table


912
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
913

914
915
916
917
The carbon-copy recipient group is identical to the recipient group
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
all recipients, but not to carbon-copy recipients of the original
Per Cederqvist's avatar
Per Cederqvist committed
918
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
919

920
@table @misc
David Byers's avatar
David Byers committed
921
@item cc-recpt
922
923
Starts a carbon-copy recipient group. It contains the conference number
of a carbon-copy recipient of the article.
David Byers's avatar
David Byers committed
924
@item loc-no
925
926
Always present in a CC recipient group. It contains the local text
number of the article in the conference specified by the most recent
927
@misc{cc-recpt} field.
David Byers's avatar
David Byers committed
928
@item rec-time
929
Present after the CC recipient has read the article. It contains the
930
931
time when the article was read. Since only persons can read articles
this will only be seen if the CC recipient is a person.
David Byers's avatar
David Byers committed
932
933
934
@item sent-by
Present when a CC recipient was added by a person other than the author
after the article had been created. It contains the person number of the
935
person who added the CC recipient.
David Byers's avatar
David Byers committed
936
937
938
939
940
941
@item sent-at
Present when a CC recipient was added after the article had been
created. It is the time when the CC recipient was added.
@end table


942
943
944
945
946
@subsection Blank Carbon Copy (BCC) Recipient

The blank carbon-copy recipient group is identical to the carbon-copy
recipient group above. The difference is the visibility of the
information. A carbon-copy recipient group is visible to anyone that is
947
allowed to fetch both the text status of the involved text and the
948
conference status of the involved conference.  (That is, as long as the
949
conference isn't secret everybody is allowed to see the carbon-copy
950
951
recipient group.)

952
953
954
955
956
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.
957
958

This type of group was introduced in protocol version 10.  When
959
old-style calls such as @reqlink{get-text-stat-old}
960
961
are used this will be converted to a CC recipient group by the server
for the benefit of clients that don't understand this group.
962

963
@table @misc
964
965
966
967
968
969
@item bcc-recpt
Starts a blank carbon-copy recipient group. It contains the conference
number of a blank carbon-copy recipient of the article.
@item loc-no
Always present in a BCC recipient group. It contains the local text
number of the article in the conference specified by the most recent
970
@misc{bcc-recpt} field.
971
972
973
974
975
976
977
978
979
980
981
982
983
984
@item rec-time
Present after the BCC recipient has read the article. It contains the
time when the article was read. Since only persons can read articles
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
after the article had been created. It contains the person number of the
person who added the BCC recipient.
@item sent-at
Present when a BCC recipient was added after the article had been
created. It is the time when the BCC recipient was added.
@end table


985
@subsection Comment To
David Byers's avatar
David Byers committed
986

987
@table @misc
David Byers's avatar
David Byers committed
988
989
990
991
992
993
994
995
@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
the author, after the article had been created. It contains the person
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
996
been created. It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
997
998
999
@end table


1000
@subsection Footnote To
David Byers's avatar
David Byers committed
1001

1002
@table @misc
1003
@item footn-to
David Byers's avatar
David Byers committed
1004
1005
1006
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
1007
been created. It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
1008
1009
1010
@end table


1011
@subsection Comment in
David Byers's avatar
David Byers committed
1012

1013
@table @misc
David Byers's avatar
David Byers committed
1014
1015
1016
1017
1018
1019
@item comm-in
Present when there are comments to this article. It contains the article
number which is a comment to this article.
@end table


1020
@subsection Footnote in
David Byers's avatar
David Byers committed
1021

1022
@table @misc
1023
@item footn-in
David Byers's avatar
David Byers committed
1024
1025
1026
1027
1028
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


1029
@node The Aux-Item List
1030
@section The Aux-Item List
1031
1032
1033
1034
1035

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

@menu
1036
1037
1038
1039
1040
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
1041
1042
@end menu

1043
@node About Aux-Items
1044
@subsection About Aux-Items
1045
1046
1047
1048

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

1053
1054
1055
The exact structure of an aux item is specified elsewhere
(@pxref{LysKOM Data Types}). The important fields here are the
@field{aux-no}, @field{tag} and @field{data} fields.
1056

1057
1058
1059
1060
1061
1062
The @field{aux-no} field is used to identify an item. The
@field{aux-no} together with a text or conference number uniquely
identifies a particular aux item.  Items are numbered from one and up
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
have never been used before within a particular list.
1063

1064
1065
1066
1067
The @field{tag} field identifies the type of aux item. It is used by
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.
1068

1069
1070
1071
1072
The @field{data} field is a simple string. The meaning of the string
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.)
1073
1074
1075



1076
@node Predefined Aux-Item Types
1077
@subsection Predefined Aux-Item Types
1078

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

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

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

1095
1096
Some of the aux-items below (mostly the ones that begin with "mx-") are
used by mail importers. For information about supplementary aux-items
1097
introduced by @command{komimportmail}, see @ref{komimportmail Aux-Item Types}.
1098
1099
1100

@table @samp
@item content-type [1] (text)
1101
Specifies the content type of a text. Data is a valid MIME type or one
1102
of the special LysKOM types (@pxref{LysKOM Content Types}).
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112

This item may only be set by the author of a text. The inherit, secret
and hide-owner bits are cleared. Only one content-type item can be
created per creator.


@item fast-reply [2] (text)
Data is a string that constitutes a brief comment to the text. This
comment should be displayed immediately after the text body. 

David Byers's avatar
David Byers committed
1113
1114
An item of this type will never be inherited, can always be deleted, is
never anonymous and is never secret.
1115
1116


1117
@item cross-reference [3] (text, conference, letterbox)
David Byers's avatar
David Byers committed
1118
Data is a cross-reference to something else. The contents consist of a
1119
1120
letter, a number, and optionally a space and a descriptive text. The
letter must be one
David Byers's avatar
David Byers committed
1121
1122
1123
1124
1125
of T, C or P. T specifies that the cross-reference points to a text; C
that it points to a conference; and P that it points to a person. The
number is the id of the target of the cross reference. The descriptive
text is simly that, a text that describes the cross-reference. For
example, "T15 Check this out!" is a cross reference to text 15 with a
1126
1127
description that reads "Check this out!", and "T17" is a cross reference
without a description.
1128

David Byers's avatar
David Byers committed
1129
1130
The inherit bit is automatically cleared and the item can always be
deleted. 
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163


@item no-comments [4] (text)
When this item is set, the author requests that nobody comments the
text. This is advisory only; it is still possible to write comments, but
clients should advise the user that this is contrary to the author's
wishes. Data should be empty.

This item may only be set by the author. The secret, hide-creator and
inherit bits are automatically cleared.


@item personal-comment [5] (text)
When this item is set, the author requests only personal comments. This
is advisory only; it is still possible to create regular comments, but
clients should advise the user that the author prefers a personal
comment. Data should be empty.

This item may only be set by the author. The secret, hide-creator and
inherit bits are automatically cleared.


@item request-confirmation [6] (text)
The author requests that everyone who reads the text confirms having
done so by creating read-confirmation items on the text. Clients should
ask users if they wish to confirm having read the text when it is
displayed. Data should be empty.

The hide-creator, secret and inherit bits are automatically cleared.


@item read-confirm [7] (text)
This item can be taken as confirmation that the item creator has read
1164
1165
1166
the text to which the item is attached. Clients should never ever create
this item without an explicit confirmation from the user that the text
has indeed been read.
1167
1168

The hide-creator, secret and inherit bits are automatically cleared.
David Byers's avatar
David Byers committed
1169
Once created an item of this type cannot be deleted.
1170
1171


1172
@item redirect [8] (conference, letterbox)
David Byers's avatar
David Byers committed
1173

David Byers's avatar
David Byers committed
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
This item indicates that texts should not be sent to the conference,
but be directed to some other target instead. Clients should notify
users that attempt to send texts to the conference of the redirect and
offer to send the text to the target of the redirect instead. A typical
use of this item would be a user that does not read LysKOM very often
and would like to advise other users to send e-mail instead.

Data is PROTOCOL:ADDRESS where PROTOCOL is either "E-mail" or "LysKOM",
and ADDRESS is either an e-mail address or a LysKOM conference. 
Hopefully we'll be able to replace this with a forwarding mechanism
later.
1185
1186

This item can only be set by the conference supervisor or in the case of
David Byers's avatar
David Byers committed
1187
a mailbox, the person attached to the mailbox. The hide-creator and
1188
1189
1190
secret bits are cleared automatically. Only one redirect can be
specified.

David Byers's avatar
David Byers committed
1191

1192
@item x-face [9] (conference, letterbox, server)
1193
1194
1195
1196

Data is the face of the person in compface format. Cool, innit?

This item can only be set by the conference supervisor or in the case of
David Byers's avatar
David Byers committed
1197
a mailbox, the person attached to the mailbox. The hide-creator and
1198
1199
1200
secret bits are cleared automatically. 


1201
@item alternate-name [10] (text, conference, letterbox)
1202
1203

Data is a string that the client may use as an alternate to the name of
David Byers's avatar
David Byers committed
1204
1205
1206
a conference or the subject of a text. Note that the server does not
match against this name when performing name lookups. Clients should
only display alternate names created by the user currently logged on.
1207
1208
1209
1210
1211
1212
1213

The inherit flag is automatically cleared.


@item pgp-signature [11] (text)

Data is a PGP signature of the text. The signature should be the
David Byers's avatar
David Byers committed
1214
equivalent of what "pgp -sba" in PGP 2.6.2 generates.
1215
1216
1217
1218
1219
1220
1221
1222

The secret, hide-creator and inherit bits are automatically cleared.
Signatures cannot be deleted once they have been created.


@item pgp-public-key [12] (letterbox)

Data is the public key of the person. It is desirable that the public
David Byers's avatar
David Byers committed
1223
1224
1225
key contains a userid of the format "LysKOM <p@var{n}@@@var{server}>+",
where @var{n} is the number of the person in the LysKOM server specified
in @var{server}. This rule is currently not enforced.
1226
1227
1228
1229

This item can only be set by the person himself. The hide-creator,
secret and inherit bits are automatically cleared.

David Byers's avatar
David Byers committed
1230

1231
1232
@item e-mail-address [13] (conference, letterbox, server)

David Byers's avatar
David Byers committed
1233
1234
Data is an RFC 822-style email address. When set on a mailbox, it
should be the email address of the person. If the person has multiple
1235
1236
1237
email addresses he may set serveral e-mail-address aux-items.

The meaning of this aux-item when set on a conference that isn't a
David Byers's avatar
David Byers committed
1238
1239
1240
mailbox is vague. For a conference that is used as to import a mailing
list this should be the email address of the list. For other conferences 
we haven't really defined a sensible use.
1241
1242

When this aux-item is set on the server it shold contain the email
1243
address of the administrator (or administrators.)
1244

David Byers's avatar
David Byers committed
1245
1246
1247
This aux-item can only be set by the supervisor of a conference or the
server administrator. The creator cannot be hidden.

1248
1249
1250
1251

@item faq-text [14] (conference, server)

Data is a decimal text number, which is a FAQ for the conference (or
David Byers's avatar
David Byers committed
1252
1253
server). Creating an item of this type automatically causes creation of
a faq-for-conf item.
David Byers's avatar
David Byers committed
1254
1255
1256
1257

This item can only be set by the supervisor or server administrator. The 
hide-creator, secret, and inherit bits are automatically cleared.

1258
1259
1260
1261
1262
1263
1264
1265
1266
1267

@item creating-software [15] (text)

Data is the name and version number of the client that created the
text.  This aux-item can only be set by the author of the text.  Once
set, it cannot be removed or changed.  A typical value would be
@samp{elisp-client 0.47.3}.  Setting the creating-software aux-item is
optional.

The data should be the client name, a space, and the client version used
1268
in the @reqlink{set-client-version} call.  The server may enforce this
1269
restriction.
1270

1271
@item mx-author [16] (text)
1272

David Byers's avatar