Protocol-A.texi 284 KB
Newer Older
David Byers's avatar
David Byers committed
1
\input texinfo                         @c -*-texinfo-*-
David Byers's avatar
David Byers committed
2
3
4
@c
@c FIXME: Explain how the garb works with nice and keep-commented
@c
5
@c $Id: Protocol-A.texi,v 1.108 2001/04/16 10:06:25 ceder Exp $
David Byers's avatar
David Byers committed
6
7
8
9
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
10
@c @afourpaper
David Byers's avatar
David Byers committed
11
@c %**end of header
12
13
14
15

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

@ifinfo
18
19
20
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
21

Per Cederqvist's avatar
Per Cederqvist committed
22
Copyright @copyright{} 1995-2000 Lysator ACS.
David Byers's avatar
David Byers committed
23
24
25
26

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.
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42

@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
43
44
@end ifinfo

45
46
47
48
49
50
51
52
53
54
@c FIXME: What does this do?
@iftex
@parindent 0pt
@font@tensltt=cmsltt10
@begin tex
\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
55

David Byers's avatar
David Byers committed
56
57
@titlepage
@title{LysKOM Protocol A}
58
59
60
@subtitle{Protocol version @value{PROTOVER}}
@subtitle{Edition @value{PROTOEDITION}}
@subtitle{(lyskomd @value{VERSION})}
David Byers's avatar
David Byers committed
61
62
63
64
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
Per Cederqvist's avatar
Per Cederqvist committed
65
Copyright @copyright{} 1995-2000 Lysator ACS
David Byers's avatar
David Byers committed
66
67
68
69
70
71
72
73
74
75
76
77
78
79

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
80
81
82
@ifnothtml
@contents
@end ifnothtml
David Byers's avatar
David Byers committed
83

84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
@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
102
@node Top
103
@top LysKOM Protocol A
104

105
106
107
108
109
110
111
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
112
113

@menu
114
115
116
117
118
119
120
121
122
123
124
125
* Overview::                    
* Introduction::                
* Data Types::                  
* Protocol Requests::           
* Asynchronous Messages::       
* Error Codes::                 
* LysKOM Content Types::        
* The User Area::               
* Writing Clients::             
* Importing and Exporting E-Mail::  
* Type Index::                  
* Request Index::               
David Byers's avatar
David Byers committed
126
127
@end menu

128
@node Overview
David Byers's avatar
David Byers committed
129
130
@chapter Overview

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

136
137
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/}.
138
139
@end iftex

David Byers's avatar
David Byers committed
140
LysKOM is a conferencing system@footnote{Or in modern terms, enabling
141
142
143
144
145
146
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
147

148
149
Anything described here as ``unspecified'' is liable to change in
future protocol versions.
David Byers's avatar
David Byers committed
150
151

This specification is the work of several people. The main contributors have
152
been
David Byers's avatar
David Byers committed
153
154
Per Cederqvist @email{ceder@@lysator.liu.se}, 
David Byers @email{byers@@lysator.liu.se},
David Byers's avatar
David Byers committed
155
156
157
158
159
160
@ifinfo
Pär
@end ifinfo
@iftex
P@"ar
@end iftex
David Byers's avatar
David Byers committed
161
162
163
164
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
David Byers's avatar
David Byers committed
165
166
167
168
169
170
@ifinfo
Kent Engström
@end ifinfo
@iftex
Kent Eng@-str@"om@penalty-10000
@end iftex
David Byers's avatar
David Byers committed
171
@email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
172

David Byers's avatar
David Byers committed
173
174
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
175

176
@menu
177
* Document Edition History::   
178
179
* Protocol Version History::    
* Notation::                    
David Byers's avatar
David Byers committed
180
181
@end menu

182
183
@node Document Edition History
@section Document Edition History
David Byers's avatar
David Byers committed
184
185

@table @asis
186

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

Per Cederqvist's avatar
Per Cederqvist committed
191
192
193
194
195
196
197
198
@item 10.3: 2000-09-09
Several aux-items can be set on letterboxes and not only conferences.  A
few can now be set on the server.  The @code{allowed-content-type} and
@code{recommended-conf} aux-items were added.  The
@code{mx-allow-filter} and @code{mx-reject-forward} aux-items are marked
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.
199
Distributed with lyskomd 2.0.4.
Per Cederqvist's avatar
Per Cederqvist committed
200

Per Cederqvist's avatar
Per Cederqvist committed
201
202
203
204
@item 10.2: 1999-07-23
Some typos and other minor errors were fixed.  Distributed with lyskomd
2.0.2.

205
@item 10.1: 1999-07-12
David Byers's avatar
Server:    
David Byers committed
206
Call @code{sub-comment} was incorrectly marked obsolete. This has been
207
208
209
210
211
corrected. Regexps are case sensitive.  The Info-Type enumeration was
introduced in the description of the protocol.  (Previous versions of
the protocol had broken definitions of add-recipient,
async-new-recipient and async-sub-recipient.)  Distributed with lyskomd
2.0.1.
David Byers's avatar
Server:    
David Byers committed
212

213
@item 10.0: 1999-06-27
214
215
The specification was translated to English and converted to Texinfo by
David Byers.  Protocol version 10.  Distributed with lyskomd 2.0.0.
216
Note: this edition incorrectly marked the @code{sub-comment} call as
217
218
obsolete, and stated that regexp lookup was case insensitive.  Both
statements were wrong, and has since been fixed.
219
220

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

David Byers's avatar
David Byers committed
223
@item 8.0: 1995-11-10
224
Protocol version 8.  Distributed with lyskomd 1.8.0.
David Byers's avatar
David Byers committed
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248

@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

249
@node Protocol Version History
250
251
252
@section Protocol Version History

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

254
@table @asis
255
256
257
258
259
260

@item Error codes

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

261
@item New Server Calls
262
263
264

These new calls have status Recommended.

265
266
267
268
269
270
271
272
273
274
275
276
277
@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
278
279
280
281
@item 98=query-read-texts
@item 99=get-membership
@item 100=add-member
@item 101=get-members
282
283
284
@item 102=set-membership-type
@item 103=local-to-global
@item 104=map-created-texts
285
286
287
288
289
290
291
@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
292
@item 105=set-keep-commented
293
294
@end itemize

295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
@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.

317
@itemize @bullet
318
319
320
321
322
@item 58=get-last-text
@item 77=set-last-read
@item 78=get-uconf-stat
@end itemize

323
The following calls have changed status from Recommended or
324
325
326
327
328
329
330
331
332
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
333
@item 36=get-info-old
334
@item 46=get-membership-old
335
@item 47=get-created-texts
336
@item 48=get-members-old
337
338
@item 50=get-conf-stat-old
@item 59=create-anonymous-text-old
339
340
@end itemize

341
@item New and Modified Structures
342
@itemize @bullet
343
@item Aux-Item
344
@item Aux-Item-Input
345
346
@item Conference
@item Info
347
348
349
@item Member
@item Membership
@item Membership-Type
350
351
@item Misc-Info
@item Text-Stat
352
353
@end itemize

354
355
356
357
358
359
@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.

360
361
@item New Asynchronous Messages
@itemize @bullet
362
363
364
365
366
@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
367
@end itemize
368
369
370

@item Notes
@itemize @bullet
371
@item Since protocol version 9 setting a priority of zero for a
372
373
374
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
375
Membership-type extension to the Membership type. In order to maintain
376
377
378
379
380
compatibility with clients that interpret priority 0 as passive
membership, the old calls @pxref{add-member-old} and
@pxref{get-membership-old} perform magic, translating between priorities 
and membership types. The magic is documented with each call.
@end itemize
381
382
@end table

383

384
@subsection Protocol version 9 (first implemented in lyskomd 1.9.0)
385
386

@table @asis
387
388
389
390
391
392
@item New functionality
@itemize @bullet
@item The server shall now reply with error @code{not-implemented} when
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
393
@item Added Commands
394
@itemize @bullet
395
396
397
398
399
400
@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
401
@end itemize
402
403
404
405
406
407
408
@item Changed names
@itemize @bullet
@item @code{change-conference} was previously called @code{pepsi}.  The
name was changed, but not the functionality.
@end itemize
@item Status change
@itemize @bullet
David Byers's avatar
David Byers committed
409
410
@item 63=@code{who-is-on-ident} is now considered obsolete.
@item 64=@code{get-session-info-ident} is now considered obsolete.
411
@end itemize
412
413
@end table

414
@subsection Protocol version 8 (first implemented in 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
439
440
441
442
443
444
445
446
447
448
449

@table @asis 
@item Added Functionality
@itemize @bullet
@item
30=add-recipient: Can change recpt to cc_recpt and vice versa.
@item
21=set-conf-type: Accepts Conf-Type and Extended-Conf-Type.
@item
10=create-conf: Accepts Conf-Type and Extended-Conf-Type.
@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
450
75=get-version-info
David Byers's avatar
David Byers committed
451
@item
452
76=lookup-z-name
David Byers's avatar
David Byers committed
453
454
455
456
457
@end itemize

@item Other
@itemize @bullet
@item
Per Cederqvist's avatar
Per Cederqvist committed
458
The asynchronous message 1=i-am-off has been removed
David Byers's avatar
David Byers committed
459
460
461
462
463
464
465
466
467
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
468
67=lookup-person
David Byers's avatar
David Byers committed
469
@item
470
68=lookup-conf
David Byers's avatar
David Byers committed
471
@item
472
69=set-client-version
David Byers's avatar
David Byers committed
473
@item
474
70=get-client-name
David Byers's avatar
David Byers committed
475
@item
476
71=get-client-version
David Byers's avatar
David Byers committed
477
@item
478
72=mark-text
David Byers's avatar
David Byers committed
479
@item
480
73=unmark-text
David Byers's avatar
David Byers committed
481
482
483
484
485
486
487
488
489
490
@end itemize
@end table


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

@table @asis
@item New Calls
@itemize @bullet
@item
491
65=re-lookup-person
David Byers's avatar
David Byers committed
492
@item
493
66=re-lookup-conf
David Byers's avatar
David Byers committed
494
495
496
497
498
499
500
501
502
503
504
@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
505
63=who-is-on-ident
David Byers's avatar
David Byers committed
506
@item
507
64=get-session-info-ident
David Byers's avatar
David Byers committed
508
509
510
511
512
513
514
515
516
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
517
61=find-previous-text-no
David Byers's avatar
David Byers committed
518
@item
519
60=find-next-text-no
David Byers's avatar
David Byers committed
520
@item
521
59=create-anonymous-text
David Byers's avatar
David Byers committed
522
@item
523
58=get-last-text
David Byers's avatar
David Byers committed
524
525
526
527
528
529
530
531
532
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
533
57=set-user-area
David Byers's avatar
David Byers committed
534
535
536
537
538
539
540
541
542
543
544
@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


545
@node Notation
David Byers's avatar
David Byers committed
546
547
@section Notation

548
This specification uses a BNF-like grammar to describe the protocol and
549
its data elements.
David Byers's avatar
David Byers committed
550

551
Data fields have been given names that start with a lower-case letter.
552
553
554
555
556
557
558
559
560
561
562

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

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

Comments start with @code{!} (exclamation mark) and alternatives are
separated by a @code{|} (vertical bar.) A @code{;} (semicolon)
563
564
565
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
566
567


568
@node Introduction
David Byers's avatar
David Byers committed
569
570
571
572
573
574
@chapter Introduction

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

@menu
575
576
577
578
579
580
581
* Articles::                    
* Conferences::                 
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
* Client-Server Dialog::        
David Byers's avatar
David Byers committed
582
583
584
@end menu


585
@node Articles
David Byers's avatar
David Byers committed
586
587
588
589
@section Articles

An article is represented as a value of the type @code{Text-Stat} and a
string containing the article contents. An article will usually have one
590
591
592
593
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
@code{nice} value of each of its recipients and it is not marked by any
user.
David Byers's avatar
David Byers committed
594

595
596
597
598
599
Currently there is a structure called a @code{Misc-Info-List} associated
with the @code{Text-Stat}. This list contains information about
recipients, senders, comments and footnotes. In the future the
information contained in the @code{Misc-Info-List} will be integrated
into the @code{Text-Stat}.
David Byers's avatar
David Byers committed
600
601
602

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

610
Occasionally it is necessary to map between local and global numbers.
611
The server call @code{local-to-global} does this.
David Byers's avatar
David Byers committed
612
613
614



615
@node Conferences
David Byers's avatar
David Byers committed
616
617
@section Conferences

618
619
620
621
Conferences hold articles. They are represented in the protocol as a
data type called @code{Conference}. Each conference has a
@emph{creator}, the person who created the conference, and a
@emph{supervisor}, a conference whose members can modify the conference.
David Byers's avatar
David Byers committed
622
If the supervisor is a person, the members of that person's mailbox
623
624
625
626
627
are supervisors, which in most cases is only that person. We have also
introduced a type called @code{UConference} (pronounced micro-conf-stat)
which holds a subset of the information contained in the full
@code{Conference} type. Use the @code{UConference} type whenever
possible since it places a much smaller load on the LysKOM server.
David Byers's avatar
David Byers committed
628
629

Each conference has a type, which is essentially a collection of boolean
Per Cederqvist's avatar
Per Cederqvist committed
630
flags. Currently the flags @code{rd-prot}, @code{letterbox},
631
632
@code{secret}, @code{original},  @code{allow-anonymous} and 
@code{forbid-secret} are defined.
David Byers's avatar
David Byers committed
633
634
635
636
637
638
639

@table @code
@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
640
641
642
643
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
644
@item letterbox
645
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
646
are sent to the mailbox and the name of the mailbox is synchronized
647
648
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
649
650
@item secret
Conferences of this type are secret. The server will not divulge any
651
information about the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
652
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
653
654
that person cannot log in using the person name, but must specify a
person number instead.
655
656
657
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
658
659
660
@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
661
662
663
664
@end table



665
666
667
668
@menu
* Persons and Sessions::        
@end menu

669
@node Persons and Sessions
David Byers's avatar
David Byers committed
670
671
672
@subsection Persons and Sessions

Persons are represented in the protocol by values of the type
673
674
675
676
@code{Person}. Associated with persons are statistics, a set of personal
flags and a set of privileges (@pxref{Security}.) Persons are also
associated with a conference that has the same number as the person and
the @code{letterbox} bit set.
David Byers's avatar
David Byers committed
677
678

Connections to the server are represented as values of the type
679
680
681
682
683
684
@code{Static-Session-Info}, @code{Session-Info-Ident} or
@code{Session-Info}. Sessions have session number that are unique for
each session in the lifetime of the server execution. A single user can
have several sessions running at once. The session is not released until
the network connection is closed; a user can log in and out repeatedly
in a single session.
David Byers's avatar
David Byers committed
685
686


687
@node The Misc-Info List
David Byers's avatar
David Byers committed
688
689
@section The Misc-Info List

690
691
The @code{Misc-Info} list contains tagged data. The fields are sent in
groups pertaining to a particular type of information: information about
692
693
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
694
695
696
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
697

698
@subsection Recipient
David Byers's avatar
David Byers committed
699
700
701

@table @code
@item recpt
702
703
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
704
@item loc-no
705
706
707
Always present within a recipient group. It contains the local text
number of the article in the conference specified by the preceding
@code{recpt} field.
David Byers's avatar
David Byers committed
708
@item rec-time
709
710
711
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
712
@item sent-by
713
714
715
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
716
@item sent-at
717
718
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
719
720
721
@end table


722
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
723

724
725
726
727
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
728
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
729
730
731

@table @code
@item cc-recpt
732
733
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
734
@item loc-no
735
736
737
Always present in a CC recipient group. It contains the local text
number of the article in the conference specified by the most recent
@code{cc-recpt} field.
David Byers's avatar
David Byers committed
738
@item rec-time
739
Present after the CC recipient has read the article. It contains the
740
741
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
742
743
744
@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
745
person who added the CC recipient.
David Byers's avatar
David Byers committed
746
747
748
749
750
751
@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


752
753
754
755
756
@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
757
allowed to fetch both the text status of the involved text and the
758
conference status of the involved conference.  (That is, as long as the
759
conference isn't secret everybody is allowed to see the carbon-copy
760
761
recipient group.)

762
763
764
765
766
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.
767
768

This type of group was introduced in protocol version 10.  When
769
770
771
old-style calls such as get-text-stat-old (@pxref{get-text-stat-old})
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.
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794

@table @code
@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
@code{bcc-recpt} field.
@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


795
@subsection Comment To
David Byers's avatar
David Byers committed
796
797
798
799
800
801
802
803
804
805

@table @code
@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
806
been created. It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
807
808
809
@end table


810
@subsection Footnote To
David Byers's avatar
David Byers committed
811
812

@table @code
813
@item footn-to
David Byers's avatar
David Byers committed
814
815
816
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
817
been created. It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
818
819
820
@end table


821
@subsection Comment in
David Byers's avatar
David Byers committed
822
823
824
825
826
827
828
829

@table @code
@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


830
@subsection Footnote in
David Byers's avatar
David Byers committed
831
832

@table @code
833
@item footn-in
David Byers's avatar
David Byers committed
834
835
836
837
838
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


839
@node The Aux-Item List
840
@section The Aux-Item List
841
842
843
844
845

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

@menu
846
847
848
849
850
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
851
852
@end menu

853
@node About Aux-Items
854
@subsection About Aux-Items
855
856
857
858

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
859
out a case where setting an aux-item on the mailbox wasn't as good as
860
861
862
863
864
865
866
867
868
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.)

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

The aux-no field is used to identify an item. The aux-no together with a
text or conference number uniquely identifies a particular aux item.
869
Items are numbered from one and up within each item list. Once assigned,
870
871
872
873
the 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.

874
The tag field identifies the type of aux item. It is used by the server
875
876
877
878
879
880
881
882
883
884
and by clients to figure out how to interpret the data field, and by the
server to decide if the item needs special treatment.

The data field is a simple string. The meaning of the string is
determined by the 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.)



885
@node Predefined Aux-Item Types
886
@subsection Predefined Aux-Item Types
887

David Byers's avatar
David Byers committed
888
889
890
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.
891

David Byers's avatar
David Byers committed
892
893
894
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,
895
flags, who can create them, to what objects they can be attached and
David Byers's avatar
David Byers committed
896
897
so forth. The server may also silently enforce specific values for any
field of an item, regardless of what the client requests.
898

899
All items with tags in the range 1-9999 and 30000 and up are considered
900
901
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
902
return an error (illegal-aux-item.)
903

904
905
906
Some of the aux-items below (mostly the ones that begin with "mx-") are
used by mail importers. For information about supplementary aux-items
introduced by @code{komimportmail}, see @ref{komimportmail Aux-Item Types}.
907
908
909

@table @samp
@item content-type [1] (text)
910
Specifies the content type of a text. Data is a valid MIME type or one
911
912
913
914
915
916
917
918
919
920
921
of the special LysKOM types (@pxref{LysKOM Content Types}.)

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
922
923
An item of this type will never be inherited, can always be deleted, is
never anonymous and is never secret.
924
925


926
@item cross-reference [3] (text, conference, letterbox)
David Byers's avatar
David Byers committed
927
Data is a cross-reference to something else. The contents consist of a
928
929
letter, a number, and optionally a space and a descriptive text. The
letter must be one
David Byers's avatar
David Byers committed
930
931
932
933
934
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
935
936
description that reads "Check this out!", and "T17" is a cross reference
without a description.
937

David Byers's avatar
David Byers committed
938
939
The inherit bit is automatically cleared and the item can always be
deleted. 
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972


@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
973
974
975
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.
976
977

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


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

David Byers's avatar
David Byers committed
983
984
985
986
987
988
989
990
991
992
993
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.
994
995

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

David Byers's avatar
David Byers committed
1000

For faster browsing, not all history is shown. View entire blame