Protocol-A.texi 289 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
@c FIXME: create @asynklink and @asyncdlink, and substitute them for @async.
David Byers's avatar
David Byers committed
7
@c
8
@c $Id: Protocol-A.texi,v 1.120 2001/04/30 21:46:19 ceder Exp $
David Byers's avatar
David Byers committed
9
10
11
12
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
13
@c @afourpaper
David Byers's avatar
David Byers committed
14
@c %**end of header
15
16
17
18

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

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

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

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

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

33
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
@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
76

77
78
@iftex

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

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

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

@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

David Byers's avatar
David Byers committed
143
@ifinfo
144
145
146
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
147

Per Cederqvist's avatar
Per Cederqvist committed
148
Copyright @copyright{} 1995-2000 Lysator ACS.
David Byers's avatar
David Byers committed
149
150
151
152

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.
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168

@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
169
170
@end ifinfo

171
172
173
174
@c FIXME: What does this do?
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
175
@tex
176
177
178
179
180
\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
181

David Byers's avatar
David Byers committed
182
183
@titlepage
@title{LysKOM Protocol A}
184
185
186
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
187
188
189
190
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
Per Cederqvist's avatar
Per Cederqvist committed
191
Copyright @copyright{} 1995-2000 Lysator ACS
David Byers's avatar
David Byers committed
192
193
194
195
196
197
198
199
200
201
202
203
204
205

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
206
207
208
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
209

210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
@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
228
@node Top
229
@top LysKOM Protocol A
230

231
232
233
234
235
236
237
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
238
239

@menu
240
241
242
243
244
245
246
247
248
249
* Overview::                    
* Introduction::                
* Data Types::                  
* Protocol Requests::           
* Asynchronous Messages::       
* Error Codes::                 
* LysKOM Content Types::        
* The User Area::               
* Writing Clients::             
* Importing and Exporting E-Mail::  
250
* Index::                       
David Byers's avatar
David Byers committed
251
252
@end menu

253
@node Overview
David Byers's avatar
David Byers committed
254
255
@chapter Overview

256
257
258
259
260
@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.

261
262
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/}.
263
264
@end iftex

David Byers's avatar
David Byers committed
265
LysKOM is a conferencing system@footnote{Or in modern terms, enabling
266
267
268
269
270
271
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
272

273
274
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
275
276

This specification is the work of several people. The main contributors have
277
been
David Byers's avatar
David Byers committed
278
279
Per Cederqvist @email{ceder@@lysator.liu.se}, 
David Byers @email{byers@@lysator.liu.se},
280
@ifnottex
David Byers's avatar
David Byers committed
281
Pär
282
@end ifnottex
David Byers's avatar
David Byers committed
283
284
285
@iftex
P@"ar
@end iftex
David Byers's avatar
David Byers committed
286
287
288
289
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
290
@ifnottex
David Byers's avatar
David Byers committed
291
Kent Engström
292
@end ifnottex
David Byers's avatar
David Byers committed
293
294
295
@iftex
Kent Eng@-str@"om@penalty-10000
@end iftex
David Byers's avatar
David Byers committed
296
@email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
297

David Byers's avatar
David Byers committed
298
299
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
300

301
@menu
302
* Document Edition History::    
303
304
* Protocol Version History::    
* Notation::                    
David Byers's avatar
David Byers committed
305
306
@end menu

307
308
@node Document Edition History
@section Document Edition History
David Byers's avatar
David Byers committed
309
310

@table @asis
311

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

Per Cederqvist's avatar
Per Cederqvist committed
316
317
@item 10.3: 2000-09-09
Several aux-items can be set on letterboxes and not only conferences.  A
318
319
320
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
321
322
323
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.
324
Distributed with lyskomd 2.0.4.
Per Cederqvist's avatar
Per Cederqvist committed
325

Per Cederqvist's avatar
Per Cederqvist committed
326
327
328
329
@item 10.2: 1999-07-23
Some typos and other minor errors were fixed.  Distributed with lyskomd
2.0.2.

330
@item 10.1: 1999-07-12
331
Call @req{sub-comment} was incorrectly marked obsolete. This has been
332
333
corrected. Regexps are case sensitive.  The Info-Type enumeration was
introduced in the description of the protocol.  (Previous versions of
334
335
336
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
337

338
@item 10.0: 1999-06-27
339
340
The specification was translated to English and converted to Texinfo by
David Byers.  Protocol version 10.  Distributed with lyskomd 2.0.0.
341
Note: this edition incorrectly marked the @req{sub-comment} call as
342
343
obsolete, and stated that regexp lookup was case insensitive.  Both
statements were wrong, and has since been fixed.
344
345

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

David Byers's avatar
David Byers committed
348
@item 8.0: 1995-11-10
349
Protocol version 8.  Distributed with lyskomd 1.8.0.
David Byers's avatar
David Byers committed
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373

@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

374
@node Protocol Version History
375
376
377
@section Protocol Version History

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

379
@table @asis
380
381
382
383
384
385

@item Error codes

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

386
@item New Server Calls
387
388
389

These new calls have status Recommended.

390
391
392
393
394
395
396
397
398
399
400
401
402
@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
403
404
405
406
@item 98=query-read-texts
@item 99=get-membership
@item 100=add-member
@item 101=get-members
407
408
409
@item 102=set-membership-type
@item 103=local-to-global
@item 104=map-created-texts
410
411
412
413
414
415
416
@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
417
@item 105=set-keep-commented
418
419
@end itemize

420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
@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.

442
@itemize @bullet
443
444
445
446
447
@item 58=get-last-text
@item 77=set-last-read
@item 78=get-uconf-stat
@end itemize

448
The following calls have changed status from Recommended or
449
450
451
452
453
454
455
456
457
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
458
@item 36=get-info-old
459
@item 46=get-membership-old
460
@item 47=get-created-texts
461
@item 48=get-members-old
462
463
@item 50=get-conf-stat-old
@item 59=create-anonymous-text-old
464
465
@end itemize

466
@item New and Modified Structures
467
@itemize @bullet
468
@item Aux-Item
469
@item Aux-Item-Input
470
471
@item Conference
@item Info
472
473
474
@item Member
@item Membership
@item Membership-Type
475
476
@item Misc-Info
@item Text-Stat
477
478
@end itemize

479
480
481
482
483
484
@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.

485
486
@item New Asynchronous Messages
@itemize @bullet
487
488
489
490
491
@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
492
@end itemize
493
494
495

@item Notes
@itemize @bullet
496
@item Since protocol version 9 setting a priority of zero for a
497
498
499
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
500
Membership-type extension to the Membership type. In order to maintain
501
compatibility with clients that interpret priority 0 as passive
502
503
membership, the old calls @reqlink{add-member-old} and
@reqlink{get-membership-old} perform magic, translating between priorities 
504
505
and membership types. The magic is documented with each call.
@end itemize
506
507
@end table

508

509
@subsection Protocol version 9 (first implemented in lyskomd 1.9.0)
510
511

@table @asis
512
513
@item New functionality
@itemize @bullet
514
@item The server shall now reply with error @errorcode{not-implemented} when
515
516
517
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
518
@item Added Commands
519
@itemize @bullet
520
521
522
523
524
525
@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
526
@end itemize
527
528
@item Changed names
@itemize @bullet
529
@item @req{change-conference} was previously called @code{pepsi}.  The
530
531
532
533
name was changed, but not the functionality.
@end itemize
@item Status change
@itemize @bullet
534
535
@item 63=@req{who-is-on-ident} is now considered obsolete.
@item 64=@req{get-session-info-ident} is now considered obsolete.
536
@end itemize
537
538
@end table

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

541
@table @asis
David Byers's avatar
David Byers committed
542
543
544
@item Added Functionality
@itemize @bullet
@item
545
30=add-recipient: Can change @misc{recpt} to @misc{cc-recpt} and vice versa.
David Byers's avatar
David Byers committed
546
@item
547
21=set-conf-type: Accepts @type{Conf-Type} and @type{Extended-Conf-Type}.
David Byers's avatar
David Byers committed
548
@item
549
10=create-conf: Accepts @type{Conf-Type} and @type{Extended-Conf-Type}.
David Byers's avatar
David Byers committed
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
@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
575
75=get-version-info
David Byers's avatar
David Byers committed
576
@item
577
76=lookup-z-name
David Byers's avatar
David Byers committed
578
579
580
581
582
@end itemize

@item Other
@itemize @bullet
@item
Per Cederqvist's avatar
Per Cederqvist committed
583
The asynchronous message 1=i-am-off has been removed
David Byers's avatar
David Byers committed
584
585
586
587
588
589
590
591
592
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
593
67=lookup-person
David Byers's avatar
David Byers committed
594
@item
595
68=lookup-conf
David Byers's avatar
David Byers committed
596
@item
597
69=set-client-version
David Byers's avatar
David Byers committed
598
@item
599
70=get-client-name
David Byers's avatar
David Byers committed
600
@item
601
71=get-client-version
David Byers's avatar
David Byers committed
602
@item
603
72=mark-text
David Byers's avatar
David Byers committed
604
@item
605
73=unmark-text
David Byers's avatar
David Byers committed
606
607
608
609
610
611
612
613
614
615
@end itemize
@end table


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

@table @asis
@item New Calls
@itemize @bullet
@item
616
65=re-lookup-person
David Byers's avatar
David Byers committed
617
@item
618
66=re-lookup-conf
David Byers's avatar
David Byers committed
619
620
621
622
623
624
625
626
627
628
629
@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
630
63=who-is-on-ident
David Byers's avatar
David Byers committed
631
@item
632
64=get-session-info-ident
David Byers's avatar
David Byers committed
633
634
635
636
637
638
639
640
641
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
642
61=find-previous-text-no
David Byers's avatar
David Byers committed
643
@item
644
60=find-next-text-no
David Byers's avatar
David Byers committed
645
@item
646
59=create-anonymous-text
David Byers's avatar
David Byers committed
647
@item
648
58=get-last-text
David Byers's avatar
David Byers committed
649
650
651
652
653
654
655
656
657
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
658
57=set-user-area
David Byers's avatar
David Byers committed
659
660
661
662
663
664
665
666
667
668
669
@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


670
@node Notation
David Byers's avatar
David Byers committed
671
672
@section Notation

673
This specification uses a BNF-like grammar to describe the protocol and
674
its data elements.
David Byers's avatar
David Byers committed
675

676
Data fields have been given names that start with a lower-case letter.
677

678
679
Fundamental data types have names in all-caps (such as @type{INT32} and
@type{ARRAY}).
680
681
682

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
683
letter, like this: @type{Text-Stat}.)  The operator @code{::=} defines
684
685
686
687
the name to its left.

Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
688
689
690
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
691
692


693
@node Introduction
David Byers's avatar
David Byers committed
694
695
696
697
698
699
@chapter Introduction

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

@menu
700
701
702
703
704
705
706
* Articles::                    
* Conferences::                 
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
* Client-Server Dialog::        
David Byers's avatar
David Byers committed
707
708
709
@end menu


710
@node Articles
David Byers's avatar
David Byers committed
711
712
@section Articles

713
An article is represented as a value of the type @type{Text-Stat} and a
David Byers's avatar
David Byers committed
714
string containing the article contents. An article will usually have one
715
716
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
717
@field{nice} value of each of its recipients and it is not marked by any
718
user.
David Byers's avatar
David Byers committed
719

720
721
722
723
724
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
725
726
727

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

735
Occasionally it is necessary to map between local and global numbers.
736
The server call @reqlink{local-to-global} does this.
David Byers's avatar
David Byers committed
737
738
739



740
@node Conferences
David Byers's avatar
David Byers committed
741
742
@section Conferences

743
Conferences hold articles. They are represented in the protocol as a
744
745
746
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
747
If the supervisor is a person, the members of that person's mailbox
748
are supervisors, which in most cases is only that person. We have also
749
introduced a type called @type{UConference} (pronounced micro-conf-stat)
750
which holds a subset of the information contained in the full
751
@type{Conference} type. Use the @type{UConference} type whenever
752
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
753

754
755
756
757
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
758

759
@table @conftype
David Byers's avatar
David Byers committed
760
761
762
763
764
@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
765
766
767
768
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
769
@item letterbox
770
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
771
are sent to the mailbox and the name of the mailbox is synchronized
772
773
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
774
775
@item secret
Conferences of this type are secret. The server will not divulge any
776
information about the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
777
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
778
779
that person cannot log in using the person name, but must specify a
person number instead.
780
781
782
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
783
784
785
@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
786
787
788
789
@end table



790
791
792
793
@menu
* Persons and Sessions::        
@end menu

794
@node Persons and Sessions
David Byers's avatar
David Byers committed
795
796
797
@subsection Persons and Sessions

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

Connections to the server are represented as values of the type
804
805
@type{Static-Session-Info}, @type{Session-Info-Ident} or
@type{Session-Info}. Sessions have session number that are unique for
806
807
808
809
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
810
811


812
@node The Misc-Info List
David Byers's avatar
David Byers committed
813
814
@section The Misc-Info List

815
The @type{Misc-Info} list contains tagged data. The fields are sent in
816
groups pertaining to a particular type of information: information about
817
818
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
819
820
821
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
822

823
@subsection Recipient
David Byers's avatar
David Byers committed
824

825
@table @misc
David Byers's avatar
David Byers committed
826
@item recpt
827
828
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
829
@item loc-no
830
831
Always present within a recipient group. It contains the local text
number of the article in the conference specified by the preceding
832
@misc{recpt} field.
David Byers's avatar
David Byers committed
833
@item rec-time
834
835
836
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
837
@item sent-by
838
839
840
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
841
@item sent-at
842
843
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
844
845
846
@end table


847
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
848

849
850
851
852
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
853
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
854

855
@table @misc
David Byers's avatar
David Byers committed
856
@item cc-recpt
857
858
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
859
@item loc-no
860
861
Always present in a CC recipient group. It contains the local text
number of the article in the conference specified by the most recent
862
@misc{cc-recpt} field.
David Byers's avatar
David Byers committed
863
@item rec-time
864
Present after the CC recipient has read the article. It contains the
865
866
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
867
868
869
@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
870
person who added the CC recipient.
David Byers's avatar
David Byers committed
871
872
873
874
875
876
@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


877
878
879
880
881
@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
882
allowed to fetch both the text status of the involved text and the
883
conference status of the involved conference.  (That is, as long as the
884
conference isn't secret everybody is allowed to see the carbon-copy
885
886
recipient group.)

887
888
889
890
891
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.
892
893

This type of group was introduced in protocol version 10.  When
894
old-style calls such as @reqlink{get-text-stat-old}
895
896
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.
897

898
@table @misc
899
900
901
902
903
904
@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
905
@misc{bcc-recpt} field.
906
907
908
909
910
911
912
913
914
915
916
917
918
919
@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


920
@subsection Comment To
David Byers's avatar
David Byers committed
921

922
@table @misc
David Byers's avatar
David Byers committed
923
924
925
926
927
928
929
930
@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
931
been created. It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
932
933
934
@end table


935
@subsection Footnote To
David Byers's avatar
David Byers committed
936

937
@table @misc
938
@item footn-to
David Byers's avatar
David Byers committed
939
940
941
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
942
been created. It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
943
944
945
@end table


946
@subsection Comment in
David Byers's avatar
David Byers committed
947

948
@table @misc
David Byers's avatar
David Byers committed
949
950
951
952
953
954
@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


955
@subsection Footnote in
David Byers's avatar
David Byers committed
956

957
@table @misc
958
@item footn-in
David Byers's avatar
David Byers committed
959
960
961
962
963
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


964
@node The Aux-Item List
965
@section The Aux-Item List
966
967
968
969
970

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

@menu
971
972
973
974
975
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
976
977
@end menu

978
@node About Aux-Items
979
@subsection About Aux-Items
980
981
982
983

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
984
out a case where setting an aux-item on the mailbox wasn't as good as
985
986
987
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.)

988
989
990
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.
991

992
993
994
995
996
997
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.
998

999
1000
1001
1002
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.
1003

1004
1005
1006
1007
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.)
1008
1009
1010



1011
@node Predefined Aux-Item Types
1012
@subsection Predefined Aux-Item Types
1013

David Byers's avatar
David Byers committed
1014
1015
1016
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.
1017

David Byers's avatar
David Byers committed
1018
1019
1020
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,
1021
flags, who can create them, to what objects they can be attached and
David Byers's avatar
David Byers committed
1022
1023
so forth. The server may also silently enforce specific values for any
field of an item, regardless of what the client requests.
1024

1025
All items with tags in the range 1-9999 and 30000 and up are considered
1026
1027
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
1028
return an error (illegal-aux-item.)
1029

1030
1031
Some of the aux-items below (mostly the ones that begin with "mx-") are
used by mail importers. For information about supplementary aux-items
1032
introduced by @command{komimportmail}, see @ref{komimportmail Aux-Item Types}.
1033
1034
1035

@table @samp
@item content-type [1] (text)
1036
Specifies the content type of a text. Data is a valid MIME type or one
1037
of the special LysKOM types (@pxref{LysKOM Content Types}).
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047

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
1048
1049
An item of this type will never be inherited, can always be deleted, is
never anonymous and is never secret.
1050
1051


1052
@item cross-reference [3] (text, conference, letterbox)
David Byers's avatar
David Byers committed
1053
Data is a cross-reference to something else. The contents consist of a
1054
1055
letter, a number, and optionally a space and a descriptive text. The
letter must be one
David Byers's avatar
David Byers committed
1056
1057
1058
1059
1060
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
1061
1062
description that reads "Check this out!", and "T17" is a cross reference
without a description.
1063

David Byers's avatar
David Byers committed
1064
1065
The inherit bit is automatically cleared and the item can always be
deleted. 
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098


@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
1099
1100
1101
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.
1102
1103

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


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

David Byers's avatar
David Byers committed
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
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.
1120
1121

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

David Byers's avatar
David Byers committed
1126

1127
@item x-face [9] (conference, letterbox, server)
1128
1129
1130
1131

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
1132
a mailbox, the person attached to the mailbox. The hide-creator and
1133
1134
1135
secret bits are cleared automatically. 


1136
@item alternate-name [10] (text, conference, letterbox)
1137
1138

Data is a string that the client may use as an alternate to the name of
David Byers's avatar
David Byers committed