Protocol-A.texi 230 KB
 David Byers committed Jan 13, 1996 1 \input texinfo @c -*-texinfo-*-  David Byers committed Jun 14, 1998 2 @c $Id: Protocol-A.texi,v 1.7 1998/06/14 14:50:17 byers Exp$  David Byers committed Jan 13, 1996 3 4 5 6 7 8 9 @c %**start of header @setfilename protocol-a.info @settitle LysKOM Protocol A @setchapternewpage odd @c %**end of header @iftex @parindent 0pt  David Byers committed Jul 27, 1996 10 @font@tensltt=cmsltt10  David Byers committed Jun 14, 1996 11 12 13 14 15 @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 committed Jan 13, 1996 16 17 18 @end iftex @ifinfo  David Byers committed Jun 14, 1996 19 This is the specification of LysKOM Protocol A v. 9.0  David Byers committed Jan 13, 1996 20   David Byers committed Jul 27, 1996 21 Copyright @copyright{} 1995, 1996 Lysator ACS.  David Byers committed Jan 13, 1996 22 23 24 25 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 @titlepage @sp 10 @title{LysKOM Protocol A} @sp 2  David Byers committed Sep 13, 1997 32 @subtitle{Protocol version 10.0}  David Byers committed Jan 13, 1996 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 @sp 2 @author by the LysKOM Developers @page @vskip 0pt plus 1filll Copyright @copyright{} 1995 Lysator ACS 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  David Byers committed Jun 14, 1996 57 This document specifies LysKOM Protocol A, version 9.0  David Byers committed Jan 13, 1996 58 59 60 61 62 63 64  @menu * Overview:: * Introduction:: * Data Types:: * Protocol Requests:: * Asynchronous Messages::  David Byers committed Sep 13, 1997 65 66 67 68 69 * Error Codes:: * LysKOM Content Types:: * The User Area:: * Writing Clients:: * Indexes and Overviews::  David Byers committed Jan 13, 1996 70 71 72 73 74 75 76 @end menu @end ifinfo @node Overview, Document Revision History, Top, Top @chapter Overview LysKOM is a conferencing system@footnote{Or in modern terms, enabling  David Byers committed Sep 13, 1997 77 78 79 80 81 82 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 committed Jan 13, 1996 83   David Byers committed Sep 13, 1997 84 85 86 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 committed Jan 13, 1996 87 88  This specification is the work of several people. The main contributors have  David Byers committed Sep 13, 1997 89 90 91 been Per Cederqvist @code{}, David Byers @code{},  David Byers committed Jan 13, 1996 92 93 94 95 96 97 @ifinfo Pr @end ifinfo @iftex P@"ar @end iftex  David Byers committed Sep 13, 1997 98 99 100 Emanuelsson @code{}, Thomas Bellman @code{}, Lars Aronsson @code{},  David Byers committed Jan 13, 1996 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 Linus Tolke @code{} and @ifinfo Kent Engstrm @end ifinfo @iftex Kent Eng@-str@"om@penalty-10000 @end iftex @code{}. 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  David Byers committed Sep 13, 1997 123   David Byers committed Jun 14, 1996 124 125 126 127 @item 9.0: @i{In progress} Protocol version 9 is begin developed and this document needs to be updated.  David Byers committed Jan 13, 1996 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 @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  David Byers committed Sep 13, 1997 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 @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  David Byers committed Jun 14, 1998 175 176 177 178 @item 98=query-read-texts @item 99=get-membership @item 100=add-member @item 101=get-members  David Byers committed Sep 13, 1997 179 180 181 182 183 @end itemize @item Removed Server Calls @itemize @bullet @item 5=create-person  David Byers committed Jun 14, 1998 184 @item 9=query-read-texts  David Byers committed Sep 13, 1997 185 @item 10=create-conf  David Byers committed Jun 14, 1998 186 @item 14=add-member  David Byers committed Sep 13, 1997 187 188 189 @item 26=get-text-stat @item 28=create-text @item 36=get-info-old  David Byers committed Jun 14, 1998 190 191 @item 46=get-membership-old @item 48=get-members-old  David Byers committed Sep 13, 1997 192 193 194 195 196 197 198 199 200 201 @item 50=get-conf-stat @item 59=create-anonymous-text @end itemize @item New and New Modified Structures @itemize @bullet @item Aux-item @item Aux-item-list @item Conference @item Info  David Byers committed Jun 14, 1998 202 203 204 @item Member @item Membership @item Membership-Type  David Byers committed Sep 13, 1997 205 206 207 208 209 210 211 212 213 214 215 @item Misc-info @item Text-stat @end itemize @item New Asynchronous Messages @itemize @bullet @item async-deleted-text message @item New async-new-text message @end itemize @end table  David Byers committed Jun 14, 1996 216 217 218 219 220 @subsection Protocol version 9.0 @table @asis @item Added Functionality @itemize @bullet  David Byers committed Sep 13, 1997 221 222 223 224 225 226 @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  David Byers committed Jun 14, 1996 227 228 229 @end itemize @end table  David Byers committed Jan 13, 1996 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 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 304 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 @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 Det asynkrona meddelanded 1=i-am-off has been removed @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}.  David Byers committed Sep 13, 1997 368 369 370 371 372 Data in protocol A is ASCII clear text except within hollerith strings, 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 committed Jan 13, 1996 373 374 375 376 377  @node Notation, , Protocol Design Principles, Overview @section Notation  David Byers committed Sep 13, 1997 378 379 380 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 committed Jan 13, 1996 381   David Byers committed Sep 13, 1997 382 383 384 385 386 387 388 389 Data fields have been given names that start with a lower-case letter. Data types have names that start with an upper-case letter. The operator @code{::=} defines the name to its left and @code{:} (a colon) specifies a type. Comments start with @code{!} (exclamation mark) and alternatives are separated by a @code{|} (vertical bar.) A @code{;} (semicolon) 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 committed Jan 13, 1996 390 391 392 393 394 395 396 397 398 399 400 401 402  @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 ::  David Byers committed Sep 13, 1997 403 * The Aux-Item List ::  David Byers committed Jan 13, 1996 404 405 406 407 408 409 410 411 412 413 414 * 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  David Byers committed Sep 13, 1997 415 416 417 418 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 committed Jan 13, 1996 419   David Byers committed Sep 13, 1997 420 421 422 423 424 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 committed Jan 13, 1996 425 426 427  Every article has at least one number, the global article number. Global numbers are assigned in ascending order to new articles, and are never  David Byers committed Sep 13, 1997 428 429 430 431 432 433 reused. If an article has recipients it will also have a local number for each recipients. Local numbers are used in some data structures to provide more compact storage and to provida an ordering of articles for 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 committed Jan 13, 1996 434   David Byers committed Sep 13, 1997 435 436 Occasionally it is necessary to map between local and global numbers. The server call @code{get-map} does this.  David Byers committed Jan 13, 1996 437 438 439 440 441 442  @node Conferences, Persons and Sessions, Articles, Introduction @section Conferences  David Byers committed Sep 13, 1997 443 444 445 446 447 448 449 450 451 452 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. If the supervisor is a person, the members of that person's letterbox 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 committed Jan 13, 1996 453 454 455  Each conference has a type, which is essentially a collection of boolean flags. Currently the types @code{rd-prot}, @code{letterbox},  David Byers committed Sep 13, 1997 456 @code{secret}, @code{original} and @code{allow-anonymous} are defined.  David Byers committed Jan 13, 1996 457 458 459 460 461 462 463  @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  David Byers committed Sep 13, 1997 464 465 466 467 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 committed Jan 13, 1996 468 @item letterbox  David Byers committed Sep 13, 1997 469 470 471 472 Conferences of this type are connected to persons. Letters to a person are sent to the letterbox and the name of the letterbox is synchronised with the person name. It is currently not possible to explicitly set or clear this flag on a conference.  David Byers committed Jan 13, 1996 473 474 475 476 477 478 @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 members or supervisors of the conference. If a letterbox is made secret, that person cannot log in using the person name, but must specify a person number instead.  David Byers committed Sep 13, 1997 479 480 481 @item allow-anonymous Conferences of this type accept anonymous articles. Other conferences will reject anonymous articles.  David Byers committed Jan 13, 1996 482 483 484 485 486 487 488 489 @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  David Byers committed Sep 13, 1997 490 491 492 493 @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 committed Jan 13, 1996 494 495  Connections to the server are represented as values of the type  David Byers committed Sep 13, 1997 496 497 498 499 500 501 @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 committed Jan 13, 1996 502 503   David Byers committed Sep 13, 1997 504 @node The Misc-Info List, The Aux-Item List, Persons and Sessions, Introduction  David Byers committed Jan 13, 1996 505 506 @section The Misc-Info List  David Byers committed Sep 13, 1997 507 508 509 510 511 512 The @code{Misc-Info} list contains tagged data. The fields are sent in groups pertaining to a particular type of information: information about recipient; carbon copy recipient, comment to; footnote to; comment in 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 committed Jan 13, 1996 513   David Byers committed Jun 14, 1996 514 @subsection Recipient  David Byers committed Jan 13, 1996 515 516 517  @table @code @item recpt  David Byers committed Sep 13, 1997 518 519 Starts a recipient group. It contains the conference number of a recipient of the article.  David Byers committed Jan 13, 1996 520 @item loc-no  David Byers committed Sep 13, 1997 521 522 523 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 committed Jan 13, 1996 524 @item rec-time  David Byers committed Sep 13, 1997 525 526 527 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 committed Jan 13, 1996 528 @item sent-by  David Byers committed Sep 13, 1997 529 530 531 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 committed Jan 13, 1996 532 @item sent-at  David Byers committed Sep 13, 1997 533 534 Present when the recipient was added after the article was created. It contains the time when the recipient was added.  David Byers committed Jan 13, 1996 535 536 537 @end table  David Byers committed Jun 14, 1996 538 @subsection Carbon Copy (CC) Recipient  David Byers committed Jan 13, 1996 539   David Byers committed Sep 13, 1997 540 541 542 543 544 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 article.  David Byers committed Jan 13, 1996 545 546 547  @table @code @item cc-recpt  David Byers committed Sep 13, 1997 548 549 Starts a carbon-copy recipient group. It contains the conference number of a carbon-copy recipient of the article.  David Byers committed Jan 13, 1996 550 @item loc-no  David Byers committed Sep 13, 1997 551 552 553 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 committed Jan 13, 1996 554 @item rec-time  David Byers committed Sep 13, 1997 555 556 Present after the CC recipient has read the article. It contains the time when the article was read.  David Byers committed Jan 13, 1996 557 558 559 560 561 562 563 564 565 566 @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 person who added the cc recipient. @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  David Byers committed Jun 14, 1996 567 @subsection Comment To  David Byers committed Jan 13, 1996 568 569 570 571 572 573 574 575 576 577 578 579 580 581  @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  David Byers committed Jun 14, 1996 582 @subsection Footnote To  David Byers committed Jan 13, 1996 583 584  @table @code  David Byers committed Sep 13, 1997 585 @item footn-to  David Byers committed Jan 13, 1996 586 587 588 589 590 591 592 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  David Byers committed Jun 14, 1996 593 @subsection Comment in  David Byers committed Jan 13, 1996 594 595 596 597 598 599 600 601  @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  David Byers committed Jun 14, 1996 602 @subsection Footnote in  David Byers committed Jan 13, 1996 603 604  @table @code  David Byers committed Sep 13, 1997 605 @item footn-in  David Byers committed Jan 13, 1996 606 607 608 609 610 Present when there are footnotes to this article. It contains the article number which is a footnote to this article. @end table  David Byers committed Sep 13, 1997 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 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 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 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 @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 out a case where setting an aux-item on the letterbox wasn't as good as 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. Items are numbered from one and up within each item list Once assigned, 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. The tag field ideintifies the type of aux item. It is used by the server and by clients to figure out how to interpret the data field, and by the server to decide if the item needs special treatment. 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. All items with tags in the rande 1-9999 and 30000 and up are considered 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. The inherit bit is automatically cleared. @item cross-reference [3] (text, conference) Data is a cross-reference to something else. The contents must match "$$T\|C\|P$$$$[0-9]+$$ $$.*$$", where \1 specifies if the cross reference leads to a text, conference or person, \2 specified the number of the target (text-no, conf-no or pers-no) and \3 is simply descriptive text. The inherit bit is automatically cleared. @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 the text to which the item is attached. The hide-creator, secret and inherit bits are automatically cleared. @item redirect [8] (conference) When set, messages sent directly to the conference should really be sent elsewhere. 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 forwardning mechanism later. This item can only be set by the conference supervisor or in the case of a letterbox, the person attached to the letterbox. The hide-creator and secret bits are cleared automatically. Only one redirect can be specified. @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 a letterbox, the person attached to the letterbox. The hide-creator and secret bits are cleared automatically. @item alternate-name [10] (text, conferece) Data is a string that the client may use as an alternate to the name of a conference or the subject of a text. The inherit flag is automatically cleared. @item pgp-signature [11] (text) Data is a PGP signature of the text. The signature should be the equivalent of what "pgp -sba" generates. 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 +", where \1 is the number of the person in the LysKOM server specified in \2. This item can only be set by the person himself. The hide-creator, secret and inherit bits are automatically cleared. @end table @node Client-Specific Aux-Item Types, Experimental Aux-Item Types, Predefined Aux-Item Types, The Aux-Item List @subsubsection Client-Specific Aux-Item Types Client-specific items do not cause the server to perform any magic. All the flags (except the delete flag) are left untouched, the data is not validated in any way, and anyone can create any item. If you need more server support than this, your item should be on the predefined list. All tags in the range 10000-19999 are reserved for clients. Blocks of 100 numbers at a time can be assigned to specific clients. A client should never create items with tags in a range assigned to another client or in an unassigned range. Assigned ranges will never change. Currently, the following ranges are assigned to clients: @itemize @bullet @item 10000-10099: The Elisp Client @end itemize If you want a range of numbers, send e-mail to the LysKOM development group. @node Experimental Aux-Item Types, Defining New Aux-Item Types, Client-Specific Aux-Item Types, The Aux-Item List @subsubsection Experimental Aux-Item Types Experimental numbers are free for all. Use 'em any way you want. All numbers in the range 20000-29999 are for experimental use. @node Defining New Aux-Item Types, , Experimental Aux-Item Types, The Aux-Item List @subsubsection Defining New Aux-Item Types If you want a new predifined item type, just document what it does, what the data format looks like and what the server is to do with the item and send this to the LysKOM development group. We'll assign a number to oooyour item and put the documentation in this document. If you're not sure what you want the data to look like yet, make a note in your documentation that the data format might change. Once you have a data format you're happy with, update the documentation so others may use your item. If you need serious magic in the server (more than can be specified with the lyskomd configuration file), you'll probably have to write the code yourself, or hope that the development group thinks your idea is so cool we do the job for you. The idea is not to reject any type of item, unless there's already an item type that does the job just as well. Adding item types should be a much less painful process than adding new calls. @node Security, Membership and Reading, The Aux-Item List, Introduction  David Byers committed Jan 13, 1996 853 854 855 856 857 858 859 860 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 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 @subsection Security Security in LysKOM is based on two components. Each person has a set of privileges and each session has a security level. Rights in the system require both the sufficient privileges and a sufficient security level. The privileges currently available are wheel, admin, statistic, create-conf, create-pers and change-name. Security levels range from 0 to 255. @table @code @item wheel @emph{Normally not assigned} @table @asis @item Level 0 Person may always log in, even when LysKOM is crowded. @item Level 6 Person may set Priv-Bits for all persons. @item Level 7 Person may set password for all persons. @item Level 8 Person acts as supervisor for everything. @item Level 10 Person can read all articles. @end table @item admin @emph{Normally not assigned} @table @asis @item Level 1 Shut down the server@* Set motd_of_kom@* Read last_login @item Level 2 Read status of secret conferences and persons@* Read the protected parts of person and conference statuses@* Read the entire text status, even when there are secret recipients @item Level 3 Change everybody's names @item Level 4 Add/remove members@* Add/remove recipients to articles @item Level 5 Set super-conference@* Remove articles @item Level 6 Set administrator @end table @item statistic @emph{Normally not assigned} @table @asis @item Level 2 Read the statistics portions of persons, even if protected @end table @item create_conf @emph{Normally assigned} @table @asis @item Level 0 Create conferences @end table @item create_pers @emph{Normally assigned} @table @asis @item Level 0 Create persons @end table @end table @node Membership and Reading, Client-Server Dialog, Security, Introduction @section Membership and Reading  David Byers committed Sep 13, 1997 929 930 931 Persons' memberships in conferences are represented in the protocol as arrays of @code{Membership}-typed values. This structure contains a record of what the person has read in that conference.  David Byers committed Jan 13, 1996 932   David Byers committed Sep 13, 1997 933 934 935 936 937 The first part of the record is the @code{last-text-read} field. It contains the highest local text number such that the person has read every text with an equal or lower local number. The second part of the record is the @code{read-texts} array, which contains the local text numbers higher than @code{last-text-read} that are also read.  David Byers committed Jan 13, 1996 938 939  Finding out which articles a person has read in a particular conference  David Byers committed Sep 13, 1997 940 941 requires a few calls. Normally, a client will retrieve a batch of perhaps 50 articles at a time. The outline of the process is as follows:  David Byers committed Jan 13, 1996 942 943 944 945 946 947 948 949 950  @enumerate @item Fetch the membership to get the @code{last-text-read} @item Translate 50 local numbers starting as @code{last-text-read} to global numbers. @item Remove the local numbers that are in @code{read-texts} from the result @item Get and translate more texts as needed. @end enumerate  David Byers committed Sep 13, 1997 951 952 953 The process is complicated because of the translation between local and global text numbers. In the future there will hopefully be a single call that does this work in the server.  David Byers committed Jan 13, 1996 954 955 956 957 958 959 960 961 962 963 964  @node Client-Server Dialog, ,Membership and Reading , Introduction @section Client-Server Dialog The client-server dialog consists of two phases, establishing the connection and the LysKOM session itself. @subsection Connecting to the Server A connection to the server is initiated by connecting to the appropriate  David Byers committed Sep 13, 1997 965 966 967 968 969 network port@footnote{The default port for a LysKOM server is 4894} and sending a single letter which is used to select a protocol version followed by connection information required by that protocol. In protocol A the connection information is a Hollerith string saying who the user connecting is followed by a hewline character.  David Byers committed Jan 13, 1996 970 971 972 973 974 975 976 977 978 979 980 981 982 983  When the server has accepted the connection its reply is protocol-dependent. Protocol A servers will reply with the string @code{LysKOM} on a single line. @example % telnet kom.lysator.liu.se Trying 130.236.254.151 ... Connected to varg.lysator.liu.se. Escape character is '^]'. A5Hbyers LysKOM @end example  David Byers committed Sep 13, 1997 984 985 986 987 After connecting, calls to the server can be made. Most calls require the user to log in, but some calls can be made without a log-in. Calls to the server are made by sending a reference number followed by the call as specified.  David Byers committed Jan 13, 1996 988 989 990 991 992 993 994 995  @example server-call ::= ( ref-no : INT32; request : Protocol-Request; ) @end example  David Byers committed Sep 13, 1997 996 997 998 At some future point the server will reply with the result of the request or an error code preceded by an indicator and the reference number.  David Byers committed Jan 13, 1996 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012  @example server-reply ::= ok-reply | error-reply; ok-reply ::= ( "=" ref-no : INT32; reply-data; ) error-reply ::= ( "%" ref-no : INT32; error-no : Error-No;  David Byers committed Sep 13, 1997 1013  error-status : INT32;  David Byers committed Jan 13, 1996 1014 1015 1016 1017 1018 1019  ) error-no ::= INT32; @end example Our notation is not flexible enough to specify the two-way nature of the  David Byers committed Sep 13, 1997 1020 1021 1022 1023 1024 1025 communication. @code{ref-no} in the reply is always the same as @code{ref-no} in the corresponding request. @code{reply-data} depends on which request was made and is specified together with each request. Please note that there is no whitespace after the initial indicator in the reply.  David Byers committed Jan 13, 1996 1026   David Byers committed Sep 13, 1997 1027 Error reporting is covered in more detail in chapter @ref{Error Codes}.  David Byers committed Jan 13, 1996 1028 1029 1030 1031 1032  @node Data Types, , , Top @chapter Data Types  David Byers committed Sep 13, 1997 1033 1034 1035 1036 The data types in protocol A come in two flavors. The first (vanilla) are the simple data types from which the LysKOM (chocolate) data types are built. Simple data types include things like integers and strings while complex data types include things such as conferences and people.  David Byers committed Jan 13, 1996 1037 1038 1039 1040  @menu * Simple Data Types:: * LysKOM Data Types::  David Byers committed Sep 13, 1997 1041 * Name Expansion::  David Byers committed Jan 13, 1996 1042 1043 1044 1045 1046 @end menu @node Simple Data Types, LysKOM Data Types, Data Types, Data Types @section Simple Data Types  David Byers committed Sep 13, 1997 1047 1048 1049 1050 1051 Data elements are sent from client to server separated by one or more ASCII spaces (0x20), tab characters (0x09), line feeds (0x0A) or carriage returns (0x0D.) In messages from server to client the data elements are separated by exactly one space character and the entire message terminated with a line feed.  David Byers committed Jan 13, 1996 1052 1053 1054 1055  @subsection Integers  David Byers committed Sep 13, 1997 1056 1057 1058 @dfn{INT32}, @dfn{INT16}, @dfn{INT8} and @dfn{BOOL} are non-negative integers which must fit in 32, 16, 8 and 1 bits, respectively. They are transmitted to the server in ASCII-encoded decimal notation.  David Byers committed Jan 13, 1996 1059 1060 1061 1062 1063 1064 1065  @subsection Strings @dfn{HOLLERITH} denotes character strings of arbitrary length. They are transmitted as @code{H} where @code{} is the string and @code{} is the number of characters in @code{} in decimal  David Byers committed Sep 13, 1997 1066 1067 1068 1069 notation. All byte values are allowed in the string itself, including nulls. Long live FORTRAN!  David Byers committed Jan 13, 1996 1070 1071 1072 1073 1074  @subsection Bit Strings  David Byers committed Sep 13, 1997 1075 1076 @dfn{BITSTRING} is a string of bits, commonly used for a set of boolean-valued flags. Bit strings are denoted as  David Byers committed Jan 13, 1996 1077 1078 1079 1080 1081  @example BITSTRING ( name-1; name-2; name-3; ... ) @end example  David Byers committed Sep 13, 1997 1082 1083 in this specification. They are transmitted as a sequence of ASCII ones and zeroes in the order the fields are listed.  David Byers committed Jan 13, 1996 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095  For instance, given the specification @example shape-of-world : BITSTRING ( is-flat; is-round; is-2d; is-3d; ) @end example  David Byers committed Sep 13, 1997 1096 1097 most peoples idea of @code{shape-of-world} would be sent as @code{0101} (round and three-dimensional.)  David Byers committed Jan 13, 1996 1098 1099 1100 1101  @subsection Arrays  David Byers committed Sep 13, 1997 1102 1103 1104 @dfn{ARRAY} is a list of a fixed number of elements of a single type. The specification for an array is @code{ARRAY } where @code{} is the type of the array elements.  David Byers committed Jan 13, 1996 1105   David Byers committed Sep 13, 1997 1106 1107 1108 1109 1110 Arrays are transmitted as an @code{ @{ ... @}} where @code{} is the number of elements and each @code{} is an element of the array. A special case is when the array is empty, in which case the server transmits it as @code{0 *}. Note that the client must always transmit empty arrays as @code{0 @{ @}}.  David Byers committed Jan 13, 1996 1111   David Byers committed Sep 13, 1997 1112 1113 1114 In some calls the client can ask the server not to send the array contents, only its length. In these cases the array is transmitted as @code{ *} where @code{} is the number of elements in the array.  David Byers committed Jan 13, 1996 1115 1116 1117 1118  @subsection Selection  David Byers committed Sep 13, 1997 1119 1120 @dfn{SELECTION} is tagged data. It consists of an INT32 selector followed by a tail of an arbitrary type and is specified as  David Byers committed Jan 13, 1996 1121 1122 1123 1124 1125 1126 1127 1128 1129  @example SELECTION ( = : ; = : ; ... ) @end example  David Byers committed Sep 13, 1997 1130 1131 1132 where each @code{} is the selector value, @code{} the selector name and @code{} the name of the selector tail and @code{} its type.  David Byers committed Jan 13, 1996 1133   David Byers committed Sep 13, 1997 1134 1135 1136 When transmitted, the selector is transmitted as an INT32 followed by the tail belonging to that selector. For instance, given the specification  David Byers committed Jan 13, 1996 1137 1138 1139 1140 1141 1142 1143 1144  @example phrase : SELECTION ( 1=hello name : HOLLERITH; 2=howdy ; ) @end example  David Byers committed Sep 13, 1997 1145 1146 two legal messages of the type @code{phrase} are @samp{1 4HJohn} and @samp{2}.  David Byers committed Jan 13, 1996 1147 1148 1149 1150 1151 1152 1153 1154 1155  @subsection RPC @dfn{RPC} is a notation used to specify calls to the server. An RPC specification has the following form: @example RPC (  David Byers committed Jun 14, 1996 1156 1157  <> ( ) -> ( ) ; <> ( ) -> ( ) ;  David Byers committed Jan 13, 1996 1158 1159 1160  ) @end example  David Byers committed Sep 13, 1997 1161 1162 1163 where each @code{} is the name of a call, @code{} is the call number, @code{} is a single data element sent as a request and @code{} is a single data element sent in reply from the server.  David Byers committed Jan 13, 1996 1164 1165  RPC calls are trasmitted as @code{ } where @code{} and  David Byers committed Sep 13, 1997 1166 1167 1168 1169 @code{} have the same meaning as above. Note that in the client-server dialog a reference number must also be supplied with each request. This reference number is not part of the RPC itself, but is required for communications @xref{Client-Server Dialog}.  David Byers committed Jan 13, 1996 1170 1171 1172 1173 1174  @subsection Structure  David Byers committed Sep 13, 1997 1175 1176 Structures are collections of several data items. In the specification they are written as  David Byers committed Jan 13, 1996 1177 1178 1179 1180 1181 1182 1183 1184  @example ( : ; : ; ... ) @end example  David Byers committed Sep 13, 1997 1185 1186 where each @code{} is the name of a data field and the corresponding @code{} is its type.  David Byers committed Jan 13, 1996 1187 1188 1189 1190  Structures are transmitted as a sequence of their fields.  David Byers committed Sep 13, 1997 1191 @node LysKOM Data Types, Name Expansion, Simple Data Types, Data Types  David Byers committed Jan 13, 1996 1192 1193 @section LysKOM Data Types  David Byers committed Sep 13, 1997 1194 1195 1196 1197 In this section the data types specific to LysKOM are defined. Most of these will probably make very little sense until you know what calls there are. This section does not include the server calls or asynchronous messages, even though these are also data types.  David Byers committed Jan 13, 1996 1198 1199 1200 1201 1202 1203  Since the types defined here are all based on the simple types, the definitions are more concise in this section. @subsection Common Types  David Byers committed Sep 13, 1997 1204 1205 The types defined in this section are fairly simple and used in many of the more complex data types.  David Byers committed Jan 13, 1996 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222  @subsubsection Time @example Time ::= ( seconds : INT32; minutes : INT32; hours : INT32; day : INT32; month : INT32; year : INT32; day-of-week : INT32; day-of-year : INT32; is-dst : BOOL; ) @end example  David Byers committed Sep 13, 1997 1223 1224 1225 1226 1227 1228 1229 1230 @code{Time} is used to specify times in several data structures. The fields @code{seconds}, @code{minutes} and @code{hours} give wall clock time. @code{day} is the day of month and @code{month} is the current month, starting with zero for January. @code{year} is the number of years since 1900. @code{day-of-week} is the current weekday, with zero used for Sunday. @code{day-of-year} is how many days of the year have passed starting with zero and @code{is-dst} is true when the time indicated is daylight savings time.  David Byers committed Jan 13, 1996 1231   David Byers committed Sep 13, 1997 1232 1233 When the server receives a @code{Time} structure from a client it ignores the @code{day-of-week} and @code{day-of-year} fields.  David Byers committed Jan 13, 1996 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243  All times are expressed in the time zone of the server. @subsubsection Conference Numbers @example Conf-No ::= INT16; Conf-No-List ::= ARRAY Conf-No @end example  David Byers committed Sep 13, 1997 1244 1245 1246 These two types denote conference numbers. @code{Conf-No} is used when only a single number is permitted and @code{Conf-No-List} when multiple conference numbers can be specified.  David Byers committed Jan 13, 1996 1247 1248 1249  @subsubsection Text Numbers  David Byers committed Oct 23, 1997 1250   David Byers committed Jan 13, 1996 1251 1252 1253 1254 1255 1256 1257 1258 1259 @example Text-No ::= INT32; Local-Text-No ::= INT32; Text-List ::= ( first-local-no : Local-Text-No; texts : ARRAY Text-No; ) @end example  David Byers committed Sep 13, 1997 1260 1261 1262 These three types are used to indicate articles in the LysKOM database. @code{Text-No} is a global text number and @code{Local-Text-No} a local text number. @code{Text-List} is used when a mapping from local to  David Byers committed Jan 13, 1996 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 global numbers are required. @subsubsection Person and Session Numbers @example Pers-No ::= Conf-No; Pers-List ::= ARRAY Pers-No; Session-No ::= INT32; @end example  David Byers committed Sep 13, 1997 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 @code{Pers-No} is used to indicate a person and @code{Pers-List} to indicate several. @code{Session-No} is used in a few data structures relating to information about active LysKOM sessions. @subsection Auxiliary Information @example Aux-no ::= INT32; Aux-Item ::= ( aux-no : Aux-no; tag : INT32; creator : Pers-No; created-at : Time; flags : Aux-Item-Flags; inherit-limit : INT32; data : HOLLERITH; ) Aux-Item-Flags ::= BITSTRING ( deleted; inherit; secret; hide-creator;  David Byers committed Jun 14, 1998 1297  dont-garb;  David Byers committed Sep 13, 1997 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330  reserved2; reserved3; reserved4; ) @end example The fields in an Aux-Item have the following meaning: @table @code @item aux-no The number of the item within the list where it is found. This number together with a conference or text number uniquely identifies a particular aux-item. @item tag The item tag. The tag determines what the data means. @item creator The person who created the item, or zero if the item was created anonymously or if the owner is being withheld. @item created-at The time when the item was created @item flags The item flags (see below) @item inherit-limit Determines how many times (how deep) an item may be inherited. If zero, the item is inherited an unlimited number of times. If nonzero it is @b{one more} than the number of additional times the item may be inherited. Thus, 1 means that inheritance will be blocked and 2 means that the item will be inherited only to the next level. @item data The item data. @end table The flags that can be set on an aux-item have the following meaning:  David Byers committed Jan 13, 1996 1331   David Byers committed Sep 13, 1997 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 @table @code @item deleted The item has been deleted, and should not be used for anything. @item inherit The item will be inherited (if the inherit-limit field allows it.) @item secret The item will not be revealed to anyone but the item's creator and supervisors of the creator. @item hide-creator The item creator will be withheld from everyone but the item's creator and supervisors of the creator.  David Byers committed Jun 14, 1998 1343 1344 @item dont-garb The object the item is set on will not be garbage-collected.  David Byers committed Sep 13, 1997 1345 @end table  David Byers committed Jan 13, 1996 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362  @subsection Conference Types @example Conf-Type ::= BITSTRING ( rd_prot; original; secret; letterbox; ) Extended-Conf-Type ::= BITSTRING ( rd_prot; original; secret; letterbox;  David Byers committed Sep 13, 1997 1363  allow-anonymous;  David Byers committed Jan 13, 1996 1364 1365 1366 1367 1368 1369 1370 1371  reserved1; reserved2; reserved3; ) Any-Conf-Type ::= Conf-Type | Extended-Conf-Type; @end example  David Byers committed Sep 13, 1997 1372 1373 1374 1375 1376 These types are used to specify the type of a conference. @code{Conf-Type} is used in data types and calls that were created before version 8.0 of the protocol and has been augmented in @code{Extended-Conf-Type}. The type @code{Any-Conf-Type} is used when either is admissible.  David Byers committed Jan 13, 1996 1377   David Byers committed Sep 13, 1997 1378 1379 The bits have the following meaning (@pxref{Conferences}, for more info.)  David Byers committed Jan 13, 1996 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394  @table @code @item rd_prot If unset anyone can add themselves as members to the conference. @item original If set, comments are not allowed in the conference. @item secret If set the conference is secret. It's existence will only be revealed to members and supervisors. @item letterbox Set if the conference is a person's mailbox.  David Byers committed Sep 13, 1997 1395 @item allow-anonymous  David Byers committed Jan 13, 1996 1396 1397 1398 1399 1400 Set if anonymous articles are allowed in the conference. @item reserved1 @itemx reserved2 @itemx reserved3  David Byers committed Sep 13, 1997 1401 1402 1403 Reserved for future use. The values of these bits should be never be modified or used by clients who do not know their meaning. When a new conference is created these should always be set to zero.  David Byers committed Jan 13, 1996 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 @end table @subsection Conference Search Results @example Conf-Z-Info ::= ( name : HOLLERITH; type : Conf-Type; conf_no : Conf_no; ) Conf-Z-Info-List ::= ARRAY Conf-Z-Info; @end example  David Byers committed Sep 13, 1997 1419 1420 These types are used for the result of some calls that search for conferences based on their names.  David Byers committed Jan 13, 1996 1421 1422 1423 1424 1425 1426 1427  @subsection Conference Status Types @example Garb-Nice ::= INT32;  David Byers committed Sep 13, 1997 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444  Conference-old ::= ( name : HOLLERITH; type : Conf-Type; creation-time : Time; last-written : Time; creator : Pers-No; presentation : Text-No; supervisor : Conf-No; permitted-submitters : Conf-No; super-conf : Conf-No; msg-of-day : Text-No; nice : Garb-Nice; no-of-members : INT16; first-local-no : Local-Text-No; no-of-texts : INTEGER; )  David Byers committed Jan 13, 1996 1445 1446 1447  Conference ::= ( name : HOLLERITH; type : Conf-Type;  David Byers committed Sep 13, 1997 1448  type : Extended-Conf-Type;  David Byers committed Jan 13, 1996 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460  creation-time : Time; last-written : Time; creator : Pers-No; presentation : Text-No; supervisor : Conf-No; permitted-submitters : Conf-No; super-conf : Conf-No; msg-of-day : Text-No; nice : Garb-Nice; no-of-members : INT16; first-local-no : Local-Text-No; no-of-texts : INTEGER;  David Byers committed Sep 13, 1997 1461 1462  expire : Garb-Nice; aux-items : ARRAY Aux-Item;  David Byers committed Jan 13, 1996 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472  ) UConference ::= ( name : HOLLERITH; type : Extended-Conf-Type; highest-local-no : Local-Text-No; nice : Garb-Nice; ) @end example  David Byers committed Sep 13, 1997 1473 1474 1475 1476 1477 These three types are used to specify information about a conference. @code{Garb-Nice} is a quantity used to specify how long articled are kept in a conference before being removed. @code{Conference} is the full information about a conference and @code{UConference} is brief information about a conference.  David Byers committed Jan 13, 1996 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492  The fields of @code{Conference} are @table @code @item name The name of this conference. @item type The type of the conference. @item creation-time The date and time when the conference was created. @item last-written The date when something was last written in the conference. @item creator The person who created the conference. @item presentation  David Byers committed Sep 13, 1997 1493 1494 The article containing the conference presentation or zero if the conference has no presentation.  David Byers committed Jan 13, 1996 1495 @item supervisor  David Byers committed Sep 13, 1997 1496 1497 1498 The conference@footnote{The @code{supervisor} may be a person, in which case the members of that person's letterbox become supervisors.} who supervises this conference.  David Byers committed Jan 13, 1996 1499 @item permitted-submitters  David Byers committed Sep 13, 1997 1500 1501 1502 1503 The conference whose members@footnote{@code{permitted-submitters} can be a person, in which case all persons who are members of the associated letterbox are allowed to submit articles to the conference.} may submit articles to the conference, or zero if anyone may do so.  David Byers committed Jan 13, 1996 1504 1505 1506 1507 1508 1509 @item super-conf The conference that receives comments if this conference does not accept them. Zero means the author of the comment in question. @item msg-of-day The conference notice, if any. @item nice  David Byers committed Sep 13, 1997 1510 1511 The number of days an article should be kept before being removed from the conference.  David Byers committed Jan 13, 1996 1512 1513 1514 1515 1516 1517 @item no-of-members The number of members of this conference. @item first-local-no The local number of the oldest existing article in the conference. @item no-of-texts The number of articles in the conference.  David Byers committed Sep 13, 1997 1518 1519 1520 1521 1522 1523 @item expire This field will be used to control when a conference expires. It is not used at the moment, and should be set to zero for future compatibility. @item aux-items The conference's aux item list.  David Byers committed Jan 13, 1996 1524 1525 1526 1527 1528 1529 1530 1531 @end table The fields of @code{UConference} are @table @code @item name The name of this conference. @item type  David Byers committed Sep 13, 1997 1532 1533 The conference type. Note that this is an extended conference type, unlike the type field of @code{Conference}.  David Byers committed Jan 13, 1996 1534 1535 1536 @item highest-local-no The local number of the newest article in the conference. @item nice  David Byers committed Sep 13, 1997 1537 1538 The number of days an article should be kept before being removed from the conference.  David Byers committed Jan 13, 1996 1539 1540 1541 1542 1543 1544 1545 @end table @subsection Server Information @example Info ::=  David Byers committed Sep 13, 1997 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555  ( version : INT32; conf-pres-conf : Conf-No; pers-pres-conf : Conf-No; motd-conf : Conf-No; kom-news-conf : Conf-No; motd-of-lyskom : Text-No; aux-item-list : Aux-item-list; ) Info-old ::=  David Byers committed Jul 27, 1996 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567  ( version : INT32; conf-pres-conf : Conf-No; pers-pres-conf : Conf-No; motd-conf : Conf-No; kom-news-conf : Conf-No; motd-of-lyskom : Text-No; ) Version-Info ::= ( protocol-version : INT32; server-software : HOLLERITH software-version : HOLLERITH  David Byers committed Jan 13, 1996 1568 1569 1570  ) @end example  David Byers committed Jul 27, 1996 1571 1572 These data types contain information about the LysKOM server. The fields of @code{Info} are  David Byers committed Jan 13, 1996 1573 1574 1575  @table @code @item version  David Byers committed Sep 13, 1997 1576 1577 1578 1579 1580 The server version encoded as a number @code{aabbcc} where @code{aa} is the major version number, @code{bb} the minor number and @code{cc} the secondary minor version. For instance, @code{10607} is version 1.6.7 of the server. If greater than 10699 the @code{get-version-info} should be used instead.  David Byers committed Jan 13, 1996 1581 1582 1583 1584 1585 1586 1587 1588 1589 @item conf-pres-conf The conference that contains conference presentations. @item pers-pres-conf The conference that contains person presentations. @item motd-conf The conference that contains conference and person notices. @item kom-news-conf The conference that contains news about LysKOM. @item motd-of-lyskom  David Byers committed Sep 13, 1997 1590 1591 The number of an article to display when LysKOM is entered or zero if there is none.  David Byers committed Jan 13, 1996 1592 1593 @end table  David Byers committed Jul 27, 1996 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 The fields of @code{Version-Info} are: @table @code @item protocol-version The version of protocol A the server is using. This may be used to ascertain which calls are available. @item server-software Human-readable name of the server software. @item software-version Human-readable name of the server software version. @end table  David Byers committed Jan 13, 1996 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662  @subsection Person Status Types @example Person ::= ( username : HOLLERITH; privileges : Priv-Bits; flags : Personal-Flags; last-login : Time; user-area : Text-No; total-time-present : INT32; sessions : INT32; created-lines : INT32; created-bytes : INT32; read-texts : INT32; no-of-text-fetches : INT32; created-persons : INT16; created-confs : INT16; first-created-local-no : INT32; no-of-created-texts : INT32; no-of-marks : INT16; no-of-confs :