Protocol-A.texi 259 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
David Byers's avatar
David Byers committed
5
@c $Id: Protocol-A.texi,v 1.49 1999/01/13 12:00:13 byers 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 the specification of LysKOM Protocol A v. 9.0
David Byers's avatar
David Byers committed
23

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

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

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

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

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

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
@node Top, Overview, (dir), (dir)
@comment node-name, next, previous, up
Per Cederqvist's avatar
Per Cederqvist committed
65
This document specifies LysKOM Protocol A, version 9.0.
David Byers's avatar
David Byers committed
66

67
68
69
70
FIXME: This document is not yet published.  The document you are looking
at has the version numbers all wrong.  This will be fixed before
publication.

David Byers's avatar
David Byers committed
71
72
73
74
75
76
@menu
* Overview::
* Introduction::
* Data Types::
* Protocol Requests::
* Asynchronous Messages::
77
78
79
80
* Error Codes::
* LysKOM Content Types::
* The User Area::
* Writing Clients::
81
82
* Type Index::
* Request Index::
David Byers's avatar
David Byers committed
83
84
85
86
87
88
89
@end menu
@end ifinfo

@node Overview, Document Revision History, Top, Top
@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
98
99
This document specifies version 10.0 of protocol A used between a LysKOM
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
103
104
been
Per Cederqvist @code{<ceder@@lysator.liu.se>}, 
David Byers @code{<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
111
112
113
Emanuelsson @code{<pell@@lysator.liu.se>},
Thomas Bellman @code{<bellman@@lysator.liu.se>}, 
Lars Aronsson @code{<aronsson@@lysator.liu.se>},
David Byers's avatar
David Byers committed
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
Linus Tolke @code{<linus@@lysator.liu.se>} and
@ifinfo
Kent Engström
@end ifinfo
@iftex
Kent Eng@-str@"om@penalty-10000
@end iftex
@code{<kent@@lysator.liu.se>}.

The LysKOM developers can be reached by email to @code{lyskom@@lysator.liu.se}.

@menu 
* Document Revision History::
* Protocol Revision History::
* Protocol Design Principles::
* Notation::
@end menu

@node Document Revision History, Protocol Revision History, Overview, Overview
@section Document Revision History

@table @asis
136

137
138
139
140
@item 9.0: @i{In progress}
Protocol version 9 is begin developed and this document needs to be
updated.

David Byers's avatar
David Byers committed
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
@item 8.0: 1995-11-10
Protocol version 8 is being documented. This specification was translated to
English and converted to Texinfo by David Byers.

@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

@node Protocol Revision History, Protocol Design Principles, Document Revision History, Overview
@section Protocol Revision History

171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
@subsection Protocol version 10.0
@table @asis
@item New Server Calls
@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
@item 97=set-expire
188
189
190
191
@item 98=query-read-texts
@item 99=get-membership
@item 100=add-member
@item 101=get-members
192
193
@item 102=local-to-global
@item 103=map-created-texts
David Byers's avatar
David Byers committed
194
@item 105=set-keep-commented
195
196
197
198
199
@end itemize

@item Removed Server Calls
@itemize @bullet
@item  5=create-person
200
@item  9=query-read-texts
201
@item 10=create-conf
202
@item 14=add-member
203
204
205
@item 26=get-text-stat
@item 28=create-text
@item 36=get-info-old
206
207
@item 46=get-membership-old
@item 48=get-members-old
208
209
210
211
212
213
@item 50=get-conf-stat
@item 59=create-anonymous-text
@end itemize

@item New and New Modified Structures
@itemize @bullet
214
@item Aux-Item
215
@item Aux-Item-Input
216
217
@item Conference
@item Info
218
219
220
@item Member
@item Membership
@item Membership-Type
221
222
@item Misc-Info
@item Text-Stat
223
224
225
226
227
228
229
@end itemize

@item New Asynchronous Messages
@itemize @bullet
@item async-deleted-text message
@item New async-new-text message
@end itemize
230
231
232
233
234
235
236
237
238
239
240
241
242

@item Notes
@itemize @bullet
@item Since protocol version 9 setting a priority of zero in a
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
Membership-type extension to Membership type. In order to maintain
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
243
244
@end table

245

246
247
248
@subsection Protocol version 9.0

@table @asis
Per Cederqvist's avatar
Per Cederqvist committed
249
@item Added Commands
250
@itemize @bullet
251
252
253
254
255
256
@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
257
258
259
@end itemize
@end table

David Byers's avatar
David Byers committed
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
@subsection Protocol version 8.0

@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
75=get_version_info
@item
76=lookup_z_name
@end itemize

@item Other
@itemize @bullet
@item
Per Cederqvist's avatar
Per Cederqvist committed
304
The asynchronous message 1=i-am-off has been removed
David Byers's avatar
David Byers committed
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
67=lookup_person
@item
68=lookup_conf
@item
69=set_client_version
@item
70=get_client_name
@item
71=get_client_version
@item
72=mark_text
@item
73=unmark_text
@end itemize
@end table


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

@table @asis
@item New Calls
@itemize @bullet
@item
65=re_lookup_person
@item
66=re_lookup_conf
@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
63=who_is_on_ident
@item
64=get_session_info_ident
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
61=find_previous_text_no
@item
60=find_next_text_no
@item
59=create_anonymous_text
@item
58=get_last_text
@end itemize
@end table

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

@table @asis
@item New Calls
@itemize @bullet
@item
57=set_user_area
@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


@node Protocol Design Principles, Notation, Protocol Revision History, Overview
@section Transport Protocol Requirements

LysKOM protocol A can be run on top of any reliable, bidirectional,
8-bit data stream. All current implementations use TCP/IP. At Lysator
port 4894 is used on the host @code{kom.lysator.liu.se}.

398
Data in protocol A is ASCII clear text except within Hollerith strings,
399
400
401
402
where arbitrary eight-bit characters are allowed. Data arguments are
separated by whitespace. The reason for this unorthodox design is that
the protocol should be usable from a text-only terminal, something that
is very useful during server and early client development.
David Byers's avatar
David Byers committed
403
404
405
406
407


@node Notation, , Protocol Design Principles, Overview
@section Notation

408
409
410
This specification uses a BNF-like grammar to describe the protocol and
its data elements. It does not use ASN.1 because we don't know ASN.1 and
probably wouldn't like it very much even if we did.
David Byers's avatar
David Byers committed
411

412
Data fields have been given names that start with a lower-case letter.
413
414
415
416
417
418
419
420
421
422
423

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)
424
425
426
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
427
428
429
430
431
432
433
434
435
436
437
438
439


@node Introduction, , , Top
@chapter Introduction

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

@menu
* Articles ::
* Conferences ::
* Persons and Sessions ::
* The Misc-Info List ::
440
* The Aux-Item List ::
David Byers's avatar
David Byers committed
441
442
443
444
445
446
447
448
449
450
451
* Security ::
* Membership and Reading::
* Client-Server Dialog ::
@end menu


@node Articles, Conferences, , Introduction
@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
452
453
454
455
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
456

457
458
459
460
461
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
462
463
464

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

472
Occasionally it is necessary to map between local and global numbers.
473
The server call @code{local-to-global} does this.
David Byers's avatar
David Byers committed
474
475
476
477
478
479



@node Conferences, Persons and Sessions, Articles, Introduction
@section Conferences

480
481
482
483
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
484
If the supervisor is a person, the members of that person's mailbox
485
486
487
488
489
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
490
491

Each conference has a type, which is essentially a collection of boolean
Per Cederqvist's avatar
Per Cederqvist committed
492
flags. Currently the flags @code{rd-prot}, @code{letterbox},
493
@code{secret}, @code{original} and @code{allow-anonymous} are defined.
David Byers's avatar
David Byers committed
494
495
496
497
498
499
500

@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
501
502
503
504
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
505
@item letterbox
506
Conferences of this type are connected to persons. Letters to a person
David Byers's avatar
David Byers committed
507
are sent to the mailbox and the name of the mailbox is synchronized
508
509
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
510
511
512
@item secret
Conferences of this type are secret. The server will not divulge any
information of the existence of the conference to persons who are not
David Byers's avatar
David Byers committed
513
members or supervisors of the conference. If a mailbox is made secret,
David Byers's avatar
David Byers committed
514
515
that person cannot log in using the person name, but must specify a
person number instead.
516
517
518
@item allow-anonymous
Conferences of this type accept anonymous articles. Other conferences
will reject anonymous articles.
David Byers's avatar
David Byers committed
519
520
521
@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
522
523
524
525
526
527
528
529
@end table



@node Persons and Sessions, The Misc-Info List, Conferences, Introduction
@subsection Persons and Sessions

Persons are represented in the protocol by values of the type
530
531
532
533
@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
534
535

Connections to the server are represented as values of the type
536
537
538
539
540
541
@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
542
543


544
@node The Misc-Info List, The Aux-Item List, Persons and Sessions, Introduction
David Byers's avatar
David Byers committed
545
546
@section The Misc-Info List

547
548
The @code{Misc-Info} list contains tagged data. The fields are sent in
groups pertaining to a particular type of information: information about
549
550
recipient; carbon copy recipient; blank carbon copy recipient;
comment to; footnote to; comment in
551
552
553
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
554

555
@subsection Recipient
David Byers's avatar
David Byers committed
556
557
558

@table @code
@item recpt
559
560
Starts a recipient group. It contains the conference number of a
recipient of the article.
David Byers's avatar
David Byers committed
561
@item loc-no
562
563
564
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
565
@item rec-time
566
567
568
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
569
@item sent-by
570
571
572
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
573
@item sent-at
574
575
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
576
577
578
@end table


579
@subsection Carbon Copy (CC) Recipient
David Byers's avatar
David Byers committed
580

581
582
583
584
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
585
article. This difference is enforced by the clients.
David Byers's avatar
David Byers committed
586
587
588

@table @code
@item cc-recpt
589
590
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
591
@item loc-no
592
593
594
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
595
@item rec-time
596
Present after the CC recipient has read the article. It contains the
597
598
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
599
600
601
@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
602
person who added the CC recipient.
David Byers's avatar
David Byers committed
603
604
605
606
607
608
@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


609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
@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
allowed to fetch both the text status of the involed text and the
conference status of the involved conference.  (That is, as long as the
conference isn't secret everybody is allowed to se the carbon-copy
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
old-style calls such as @code{@xref{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.

@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


649
@subsection Comment To
David Byers's avatar
David Byers committed
650
651
652
653
654
655
656
657
658
659
660
661
662
663

@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
been created. It contains the time when is was added as a comment.
@end table


664
@subsection Footnote To
David Byers's avatar
David Byers committed
665
666

@table @code
667
@item footn-to
David Byers's avatar
David Byers committed
668
669
670
671
672
673
674
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
been created. It contains the time when is was added as a footnote.
@end table


675
@subsection Comment in
David Byers's avatar
David Byers committed
676
677
678
679
680
681
682
683

@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


684
@subsection Footnote in
David Byers's avatar
David Byers committed
685
686

@table @code
687
@item footn-in
David Byers's avatar
David Byers committed
688
689
690
691
692
Present when there are footnotes to this article. It contains the
article number which is a footnote to this article.
@end table


693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
@node The Aux-Item List, Security, The Misc-Info List, Introduction
@subsection The Aux-Item List

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

@menu
* About Aux-Items ::
* Predefined Aux-Item Types ::
* Client-Specific Aux-Item Types ::
* Experimental Aux-Item Types ::
* Defining New Aux-Item Types ::
@end menu

@node About Aux-Items, Predefined Aux-Item Types, , The Aux-Item List
@subsubsection About Aux-Items

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
713
out a case where setting an aux-item on the mailbox wasn't as good as
714
715
716
717
718
719
720
721
722
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.
723
Items are numbered from one and up within each item list. Once assigned,
724
725
726
727
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.

728
The tag field identifies the type of aux item. It is used by the server
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
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.)



@node Predefined Aux-Item Types, Client-Specific Aux-Item Types, About Aux-Items, The Aux-Item List
@subsubsection Predefined Aux-Item Types

Predefined Aux-Item types are part of Protocol A, and clients are
encouraged to support all of them. As with other parts of the protocol,
changes to these item types will probably always be
backwards-compatible.

Predefined types can case serious magic to be invoked in the server.
There is no limit to the strangeness that may be associated with this
type of item. The server may also place limits on who may create
predefined items, might verify the data field, and can force any field
in the item to a specific value, no matter what the client specified.

753
All items with tags in the range 1-9999 and 30000 and up are considered
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
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
return an error (KOM_ILL_AUX.)



@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
774
775
An item of this type will never be inherited, can always be deleted, is
never anonymous and is never secret.
776
777
778


@item cross-reference [3] (text, conference)
David Byers's avatar
David Byers committed
779
780
781
782
783
784
785
786
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!".
787

David Byers's avatar
David Byers committed
788
789
The inherit bit is automatically cleared and the item can always be
deleted. 
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822


@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
823
824
825
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.
826
827

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


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

David Byers's avatar
David Byers committed
833
834
835
836
837
838
839
840
841
842
843
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.
844
845

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

David Byers's avatar
David Byers committed
850

851
852
853
854
855
@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
856
a mailbox, the person attached to the mailbox. The hide-creator and
857
858
859
secret bits are cleared automatically. 


860
@item alternate-name [10] (text, conference)
861
862

Data is a string that the client may use as an alternate to the name of
David Byers's avatar
David Byers committed
863
864
865
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.
866
867
868
869
870
871
872

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
873
equivalent of what "pgp -sba" in PGP 2.6.2 generates.
874
875
876
877
878
879
880
881
882
883

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
key contains a userid of the format "LysKOM <p\([0-9]\)@@\(.*\)>+", where
\1 is the number of the person in the LysKOM server specified in \2.
David Byers's avatar
David Byers committed
884
This rule is currently not enforced.
885
886
887
888

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
889

890
891
@item e-mail-address [13] (conference, letterbox, server)

David Byers's avatar
David Byers committed
892
893
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
894
895
896
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
897
898
899
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.
900
901
902
903

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

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

907
908
909
910

@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
911
912
913
914
915
916
917
server).  This aux-item can only be set by the administrator. Adding
this item to a conference or to the server automatically marks the text.
Deleting the item unmarks the text. 

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

918
919
920
921
922
923
924
925
926
927
928
929

@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.
930

931
@item x-author [16] (text)
932
933
934
935
936
937

For imported texts using email gateway. Data is a string with
the (readable) name of the author.

Kom clients should show this field instead of the id of the importing kom-id.

938
@item x-from [17] (text)
939
940
941
942

Data is a plain email addres, the From: field from an imported email.
Used by the kom client to construct an email reply to an imported text.

943
@item x-reply-to [18] (text)
944

945
946
Data is a plain email addres, comes from the Reply-To: field in the
imported email.
947

948
@item x-to [19] (text)
949

950
Data is one email address can be in variable format. Multiple x-to
951
952
953
954
955
956
can be present. The format is the same as is allowed in To: fields in
emails. If the text is imported these are the other receivers as seen in
the email. If the text originates from a kom-person (and thus not an
importer) this field is used in constructing an email, if an exporter
is present.

957
@item x-cc [20] (text)
958

959
960
Data in the same format as for "x-to", usage the same but will
be a carbon copy instead when exported.
961

962
@item x-date [21] (text)
963

964
Data is the send-date of an imported email. Can be in free format, even
965
966
967
968
969
if a readable format, such as "YYYY-MM-DD hh:mm:ss", is preferred. Kom
client should display this date as originating date, date of the
imported text entity in kom may be different (and can be shown as
received). In case of the text being exported from kom, this date is set
by the exporter.
970

971
@item x-message-id [22] (text)
972
973

Data is a string which is the message id from the imported email.
974
975
976
977
978
979
980
981
Message id does not contain the enclosing < >. Preferably the importer
should only add receivers when importing the same email more times with
the same msg-id. When a text is exported, the x-message-id is
constructed as an email address which contains the kom text number and
server in an unique way. (x-message-id is generally generated by the
exporter as follows.  A kom text that is exported is copied to the
importer, the importer sets the fields in the originating kom text which
it normally would set when importing.) Preliminary, the format is
982
"Text-<textno>@@<lyskomserver>".  Lyskom server takes the same format as
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
vaguely defined in aux-info pgp-public-key [12].

@item x-in-reply-to [23] (text)

Data is a string which stores one "In-Reply-To:" msg id from the
email. If several msg ids are present all of them have one x-in-reply-to
each. The stored msg id has the same format as x-message-id.  For each such
text a kom (comment) link should be created by the importer if these
referenced emails previously has been imported. Exporters must set this
for kom texts that are exported as emails, if the text is a
comment. Multiple x-in-reply-to can exist.

@item x-misc [24] (text)

Data is a string that contains all of the headers (incl subject:),
including whose that are redundantly stored in other aux-items. It is
set by the importer. The fields are concatenated with "\n".