Protocol-A.texi 277 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.85 1999/07/11 00:50:22 ceder Exp $
David Byers's avatar
David Byers committed
6
7
8
9
10
11
12
@c %**start of header
@setfilename protocol-a.info
@settitle LysKOM Protocol A
@setchapternewpage odd
@c %**end of header
@iftex
@parindent 0pt
13
@font@tensltt=cmsltt10
14
15
16
17
18
@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
David Byers's avatar
David Byers committed
19
20
21
@end iftex

@ifinfo
22
This is specification 10.1 of LysKOM Protocol A.  It specifies version
23
10 of the protocol.
David Byers's avatar
David Byers committed
24

David Byers's avatar
David Byers committed
25
Copyright @copyright{} 1995-1999 Lysator ACS.
David Byers's avatar
David Byers committed
26
27
28
29
30
31

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.
@end ifinfo

32
33
34
35
36
@dircategory LysKOM
@direntry
* Protocol A: (protocol-a).             The LysKOM Protocol A specification.
@end direntry

David Byers's avatar
David Byers committed
37
38
39
40
@titlepage
@sp 10
@title{LysKOM Protocol A}
@sp 2
41
@subtitle{Protocol version 10}
David Byers's avatar
David Byers committed
42
43
44
45
46
@sp 2
@author by the LysKOM Developers

@page
@vskip 0pt plus 1filll
David Byers's avatar
David Byers committed
47
Copyright @copyright{} 1995-1999 Lysator ACS
David Byers's avatar
David Byers committed
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63

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

@ifinfo
64
@node Top
65
@top LysKOM Protocol A
66
67

This document specifies version 10 of LysKOM Protocol A.
68
This is revision 10.1 of the specification.
David Byers's avatar
David Byers committed
69
70

@menu
71
72
73
74
75
76
77
78
79
80
81
82
* 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
83
84
85
@end menu
@end ifinfo

86
@node Overview
David Byers's avatar
David Byers committed
87
88
89
@chapter Overview

LysKOM is a conferencing system@footnote{Or in modern terms, enabling
90
91
92
93
94
95
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
96

97
This document specifies version 10 of protocol A used between a LysKOM
98
99
client and a LysKOM server. Anything described here as ``unspecified''
is liable to change in future protocol versions.
David Byers's avatar
David Byers committed
100
101

This specification is the work of several people. The main contributors have
102
been
David Byers's avatar
David Byers committed
103
104
Per Cederqvist @email{ceder@@lysator.liu.se}, 
David Byers @email{byers@@lysator.liu.se},
David Byers's avatar
David Byers committed
105
106
107
108
109
110
@ifinfo
Pär
@end ifinfo
@iftex
P@"ar
@end iftex
David Byers's avatar
David Byers committed
111
112
113
114
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
115
116
117
118
119
120
@ifinfo
Kent Engström
@end ifinfo
@iftex
Kent Eng@-str@"om@penalty-10000
@end iftex
David Byers's avatar
David Byers committed
121
@email{kent@@lysator.liu.se}.
David Byers's avatar
David Byers committed
122

David Byers's avatar
David Byers committed
123
124
The LysKOM developers can be reached by email to
@email{lyskom@@lysator.liu.se}.
David Byers's avatar
David Byers committed
125

126
127
128
129
@menu
* Document Revision History::   
* Protocol Version History::    
* Notation::                    
David Byers's avatar
David Byers committed
130
131
@end menu

132
@node Document Revision History
David Byers's avatar
David Byers committed
133
134
135
@section Document Revision History

@table @asis
136

137
@item 10.1: 1999-07-11
David Byers's avatar
Server:    
David Byers committed
138
Call @code{sub-comment} was incorrectly marked obsolete. This has been
139
corrected. Regexps are case sensitive.  Distributed with lyskomd 2.0.1.
David Byers's avatar
Server:    
David Byers committed
140

141
@item 10.0: 1999-06-27
142
143
The specification was translated to English and converted to Texinfo by
David Byers.  Protocol version 10.  Distributed with lyskomd 2.0.0.
144
145
146
Note: this revision incorrectly marked the @code{sub-comment} call as
obsolete, and stated that regexp lookup was case insensitive.  Both
statements were wrong, and has since been fixed.
147
148

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

David Byers's avatar
David Byers committed
151
@item 8.0: 1995-11-10
152
Protocol version 8.  Distributed with lyskomd 1.8.0.
David Byers's avatar
David Byers committed
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176

@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

177
@node Protocol Version History
178
179
180
@section Protocol Version History

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

182
@table @asis
183
184
185
186
187
188

@item Error codes

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

189
@item New Server Calls
190
191
192

These new calls have status Recommended.

193
194
195
196
197
198
199
200
201
202
203
204
205
@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
206
207
208
209
@item 98=query-read-texts
@item 99=get-membership
@item 100=add-member
@item 101=get-members
210
211
212
@item 102=set-membership-type
@item 103=local-to-global
@item 104=map-created-texts
213
214
215
216
217
218
219
@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
220
@item 105=set-keep-commented
221
222
@end itemize

223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
@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.

245
@itemize @bullet
246
247
248
249
250
@item 58=get-last-text
@item 77=set-last-read
@item 78=get-uconf-stat
@end itemize

251
The following calls have changed status from Recommended or
252
253
254
255
256
257
258
259
260
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
261
@item 36=get-info-old
262
@item 46=get-membership-old
263
@item 47=get-created-texts
264
@item 48=get-members-old
265
266
@item 50=get-conf-stat-old
@item 59=create-anonymous-text-old
267
268
@end itemize

269
@item New and Modified Structures
270
@itemize @bullet
271
@item Aux-Item
272
@item Aux-Item-Input
273
274
@item Conference
@item Info
275
276
277
@item Member
@item Membership
@item Membership-Type
278
279
@item Misc-Info
@item Text-Stat
280
281
@end itemize

282
283
284
285
286
287
@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.

288
289
@item New Asynchronous Messages
@itemize @bullet
290
291
292
293
294
@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
295
@end itemize
296
297
298

@item Notes
@itemize @bullet
299
@item Since protocol version 9 setting a priority of zero for a
300
301
302
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
303
Membership-type extension to the Membership type. In order to maintain
304
305
306
307
308
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
309
310
@end table

311

312
@subsection Protocol version 9 (first implemented in lyskomd 1.9.0)
313
314

@table @asis
315
316
317
318
319
320
@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
321
@item Added Commands
322
@itemize @bullet
323
324
325
326
327
328
@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
329
@end itemize
330
331
332
333
334
335
336
@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
337
338
@item 63=@code{who-is-on-ident} is now considered obsolete.
@item 64=@code{get-session-info-ident} is now considered obsolete.
339
@end itemize
340
341
@end table

342
@subsection Protocol version 8 (first implemented in lyskomd 1.8.0)
David Byers's avatar
David Byers committed
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377

@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
378
75=get-version-info
David Byers's avatar
David Byers committed
379
@item
380
76=lookup-z-name
David Byers's avatar
David Byers committed
381
382
383
384
385
@end itemize

@item Other
@itemize @bullet
@item
Per Cederqvist's avatar
Per Cederqvist committed
386
The asynchronous message 1=i-am-off has been removed
David Byers's avatar
David Byers committed
387
388
389
390
391
392
393
394
395
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
396
67=lookup-person
David Byers's avatar
David Byers committed
397
@item
398
68=lookup-conf
David Byers's avatar
David Byers committed
399
@item
400
69=set-client-version
David Byers's avatar
David Byers committed
401
@item
402
70=get-client-name
David Byers's avatar
David Byers committed
403
@item
404
71=get-client-version
David Byers's avatar
David Byers committed
405
@item
406
72=mark-text
David Byers's avatar
David Byers committed
407
@item
408
73=unmark-text
David Byers's avatar
David Byers committed
409
410
411
412
413
414
415
416
417
418
@end itemize
@end table


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

@table @asis
@item New Calls
@itemize @bullet
@item
419
65=re-lookup-person
David Byers's avatar
David Byers committed
420
@item
421
66=re-lookup-conf
David Byers's avatar
David Byers committed
422
423
424
425
426
427
428
429
430
431
432
@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
433
63=who-is-on-ident
David Byers's avatar
David Byers committed
434
@item
435
64=get-session-info-ident
David Byers's avatar
David Byers committed
436
437
438
439
440
441
442
443
444
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
445
61=find-previous-text-no
David Byers's avatar
David Byers committed
446
@item
447
60=find-next-text-no
David Byers's avatar
David Byers committed
448
@item
449
59=create-anonymous-text
David Byers's avatar
David Byers committed
450
@item
451
58=get-last-text
David Byers's avatar
David Byers committed
452
453
454
455
456
457
458
459
460
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
461
57=set-user-area
David Byers's avatar
David Byers committed
462
463
464
465
466
467
468
469
470
471
472
@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


473
@node Notation
David Byers's avatar
David Byers committed
474
475
@section Notation

476
This specification uses a BNF-like grammar to describe the protocol and
477
its data elements.
David Byers's avatar
David Byers committed
478

479
Data fields have been given names that start with a lower-case letter.
480
481
482
483
484
485
486
487
488
489
490

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)
491
492
493
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
494
495


496
@node Introduction
David Byers's avatar
David Byers committed
497
498
499
500
501
502
@chapter Introduction

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

@menu
503
504
505
506
507
508
509
* Articles::                    
* Conferences::                 
* The Misc-Info List::          
* The Aux-Item List::           
* Security::                    
* Membership and Reading::      
* Client-Server Dialog::        
David Byers's avatar
David Byers committed
510
511
512
@end menu


513
@node Articles
David Byers's avatar
David Byers committed
514
515
516
517
@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
518
519
520
521
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
522

523
524
525
526
527
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
528
529
530

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

538
Occasionally it is necessary to map between local and global numbers.
539
The server call @code{local-to-global} does this.
David Byers's avatar
David Byers committed
540
541
542



543
@node Conferences
David Byers's avatar
David Byers committed
544
545
@section Conferences

546
547
548
549
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
550
If the supervisor is a person, the members of that person's mailbox
551
552
553
554
555
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
556
557

Each conference has a type, which is essentially a collection of boolean
Per Cederqvist's avatar
Per Cederqvist committed
558
flags. Currently the flags @code{rd-prot}, @code{letterbox},
559
560
@code{secret}, @code{original},  @code{allow-anonymous} and 
@code{forbid-secret} are defined.
David Byers's avatar
David Byers committed
561
562
563
564
565
566
567

@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
568
569
570
571
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
572
@item letterbox
573
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
574
are sent to the mailbox and the name of the mailbox is synchronized
575
576
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
577
578
@item secret
Conferences of this type are secret. The server will not divulge any
579
information about the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
580
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
581
582
that person cannot log in using the person name, but must specify a
person number instead.
583
584
585
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
586
587
588
@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
589
590
591
592
@end table



593
594
595
596
@menu
* Persons and Sessions::        
@end menu

597
@node Persons and Sessions
David Byers's avatar
David Byers committed
598
599
600
@subsection Persons and Sessions

Persons are represented in the protocol by values of the type
601
602
603
604
@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
605
606

Connections to the server are represented as values of the type
607
608
609
610
611
612
@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
613
614


615
@node The Misc-Info List
David Byers's avatar
David Byers committed
616
617
@section The Misc-Info List

618
619
The @code{Misc-Info} list contains tagged data. The fields are sent in
groups pertaining to a particular type of information: information about
620
621
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
622
623
624
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
625

626
@subsection Recipient
David Byers's avatar
David Byers committed
627
628
629

@table @code
@item recpt
630
631
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
632
@item loc-no
633
634
635
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
636
@item rec-time
637
638
639
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
640
@item sent-by
641
642
643
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
644
@item sent-at
645
646
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
647
648
649
@end table


650
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
651

652
653
654
655
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
656
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
657
658
659

@table @code
@item cc-recpt
660
661
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
662
@item loc-no
663
664
665
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
666
@item rec-time
667
Present after the CC recipient has read the article. It contains the
668
669
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
670
671
672
@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
673
person who added the CC recipient.
David Byers's avatar
David Byers committed
674
675
676
677
678
679
@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


680
681
682
683
684
@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
685
allowed to fetch both the text status of the involved text and the
686
conference status of the involved conference.  (That is, as long as the
687
conference isn't secret everybody is allowed to see the carbon-copy
688
689
690
691
692
693
recipient group.)

A BCC recipient group is only visible to members and supervisors of the
recipient.  This is enforced by the server.

This type of group was introduced in protocol version 10.  When
694
695
696
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.
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719

@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


720
@subsection Comment To
David Byers's avatar
David Byers committed
721
722
723
724
725
726
727
728
729
730

@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
731
been created. It contains the time when it was added as a comment.
David Byers's avatar
David Byers committed
732
733
734
@end table


735
@subsection Footnote To
David Byers's avatar
David Byers committed
736
737

@table @code
738
@item footn-to
David Byers's avatar
David Byers committed
739
740
741
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
742
been created. It contains the time when it was added as a footnote.
David Byers's avatar
David Byers committed
743
744
745
@end table


746
@subsection Comment in
David Byers's avatar
David Byers committed
747
748
749
750
751
752
753
754

@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


755
@subsection Footnote in
David Byers's avatar
David Byers committed
756
757

@table @code
758
@item footn-in
David Byers's avatar
David Byers committed
759
760
761
762
763
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


764
@node The Aux-Item List
765
@section The Aux-Item List
766
767
768
769
770

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

@menu
771
772
773
774
775
* About Aux-Items::             
* Predefined Aux-Item Types::   
* Client-Specific Aux-Item Types::  
* Experimental Aux-Item Types::  
* Defining New Aux-Item Types::  
776
777
@end menu

778
@node About Aux-Items
779
@subsection About Aux-Items
780
781
782
783

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
784
out a case where setting an aux-item on the mailbox wasn't as good as
785
786
787
788
789
790
791
792
793
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.
794
Items are numbered from one and up within each item list. Once assigned,
795
796
797
798
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.

799
The tag field identifies the type of aux item. It is used by the server
800
801
802
803
804
805
806
807
808
809
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.)



810
@node Predefined Aux-Item Types
811
@subsection Predefined Aux-Item Types
812

David Byers's avatar
David Byers committed
813
814
815
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.
816

David Byers's avatar
David Byers committed
817
818
819
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,
820
flags, who can create them, to what objects they can be attached and
David Byers's avatar
David Byers committed
821
822
so forth. The server may also silently enforce specific values for any
field of an item, regardless of what the client requests.
823

824
All items with tags in the range 1-9999 and 30000 and up are considered
825
826
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
827
return an error (illegal-aux-item.)
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844



@table @samp
@item content-type [1] (text)
Specifies the content type of a text. Data is a valid MIME type of one
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
845
846
An item of this type will never be inherited, can always be deleted, is
never anonymous and is never secret.
847
848
849


@item cross-reference [3] (text, conference)
David Byers's avatar
David Byers committed
850
851
852
853
854
855
856
857
Data is a cross-reference to something else. The contents consist of a
letter, a number, a space and a descriptive text. The letter must be one
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
description that reads "Check this out!".
858

David Byers's avatar
David Byers committed
859
860
The inherit bit is automatically cleared and the item can always be
deleted. 
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893


@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
894
895
896
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.
897
898

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


@item redirect [8] (conference)
David Byers's avatar
David Byers committed
903

David Byers's avatar
David Byers committed
904
905
906
907
908
909
910
911
912
913
914
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.
915
916

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

David Byers's avatar
David Byers committed
921

922
923
924
925
926
@item x-face [9] (conference)

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
927
a mailbox, the person attached to the mailbox. The hide-creator and
928
929
930
secret bits are cleared automatically. 


931
@item alternate-name [10] (text, conference)
932
933

Data is a string that the client may use as an alternate to the name of
David Byers's avatar
David Byers committed
934
935
936
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.
937
938
939
940
941
942
943

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
944
equivalent of what "pgp -sba" in PGP 2.6.2 generates.
945
946
947
948
949
950
951
952

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

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
960

961
962
@item e-mail-address [13] (conference, letterbox, server)

David Byers's avatar
David Byers committed
963
964
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
965
966
967
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
968
969
970
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.
971
972

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

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

978
979
980
981

@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
982
983
server). Creating an item of this type automatically causes creation of
a faq-for-conf item.
David Byers's avatar
David Byers committed
984
985
986
987

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

988
989
990
991
992
993
994
995
996
997
998
999

@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
in the @code{set-client-version} call.  The server may enforce this
restriction.
1000