kom-types.h 14.5 KB
Newer Older
Linus Tolke's avatar
Linus Tolke committed
1
/*
2
 * $Id: kom-types.h,v 0.19 1996/08/01 23:42:23 ceder Exp $
Per Cederqvist's avatar
Per Cederqvist committed
3
 * Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995  Lysator Academic Computer Association.
Linus Tolke's avatar
Linus Tolke committed
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 *
 * This file is part of the LysKOM server.
 * 
 * LysKOM is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License as published by 
 * the Free Software Foundation; either version 1, or (at your option) 
 * any later version.
 * 
 * LysKOM is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
 * for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with LysKOM; see the file COPYING.  If not, write to
 * Lysator, c/o ISY, Linkoping University, S-581 83 Linkoping, SWEDEN,
 * or the Free Software Foundation, Inc., 675 Mass Ave, Cambridge, 
 * MA 02139, USA.
 *
 * Please mail bug reports to bug-lyskom@lysator.liu.se. 
 */
Per Cederqvist's avatar
.    
Per Cederqvist committed
25
26
27
28
/*
 *  KOM-types.h  --  Types used by both server and client of LysKOM
 *
 *
Per Cederqvist's avatar
Per Cederqvist committed
29
 *  Copyright (C) 1990, 1991, 1992, 1993, 1994, 1995	Lysator Computer Club,
Per Cederqvist's avatar
.    
Per Cederqvist committed
30
31
32
33
34
35
 *			Linkoping University,  Sweden
 *
 *  Everyone is granted permission to copy, modify and redistribute
 *  this code, provided the people they give it to can.
 *
 *
36
37
38
39
 *  Filecreator: Thomas Bellman
 *		  Lysator Computer Club
 *		  Linkoping University
 *		  Sweden
Per Cederqvist's avatar
.    
Per Cederqvist committed
40
 *
41
 *  email:	  Bellman@Lysator.LiU.SE
Per Cederqvist's avatar
.    
Per Cederqvist committed
42
43
44
45
46
47
48
49
50
 */



#ifndef  KOM_TYPES_H_ALREADY_INCLUDED__

#define  KOM_TYPES_H_ALREADY_INCLUDED__

#ifndef SERVER
51
52
#  error must define SERVER
#endif
Per Cederqvist's avatar
.    
Per Cederqvist committed
53

54
55
56
#ifdef CLIENT
#  error This file no longer supports CLIENT
#endif
Per Cederqvist's avatar
.    
Per Cederqvist committed
57

Per Cederqvist's avatar
Per Cederqvist committed
58
59
60
61
62
typedef unsigned short Pers_no;
typedef unsigned short Conf_no;
typedef unsigned long  Text_no;
typedef unsigned long  Local_text_no;
typedef unsigned long  Session_no;
Per Cederqvist's avatar
.    
Per Cederqvist committed
63

64
65
66
67
68
69
70
71
72
73
#ifdef PROT_a

/*
 * To uniquely identify a person, conference or text, three numbers
 * are used: Universe, Site and X_{recpt,person,text}. The universe is
 * omitted when it is LysKOM, or is implied by a echo conference.
 */
/*
 * LysKOM, RFC-822, FidoNet, News are examples of universes.
 */
74
/*typedef		unsigned long		Universe;*/
75
76
77
78
79
80

/*
 * JAKOM, lysator.liu.se, 2:504/113, foo.bar.com are examples of sites
 * in the above universes. (Note that comp.lang.c is _not_ a site in
 * the News universe).
 */
81
/*typedef		unsigned long		Site;*/
82
83
84
85
86
87
88
89
90
91
92

/*
 * Fritt Forum, ceder, Per Cederqvist, comp.lang.c are examples of
 * x_recpt in the above universes.
 */

/*
 * But for now, we have a System_id (sum of Universe and Site) and a
 * Global_x.
 */

93
94
95
96
typedef		unsigned long		System_id;
typedef		unsigned long		Global_recpt;
typedef		unsigned long		Global_person;
typedef		unsigned long		Global_text;
97
98
99
100

#endif


Per Cederqvist's avatar
.    
Per Cederqvist committed
101
102
103
104
105
106
#define	MAX_PERS_NO		((Pers_no) USHRT_MAX)
#define MAX_CONF_NO		((Conf_no) USHRT_MAX)
#define MAX_TEXT_NO		((Text_no) ULONG_MAX)
#define	MAX_LOCAL_TEXT_NO	((Local_text_no) ULONG_MAX)


107
108
109
110
#define PASSWD_LEN 64
typedef char   Password[PASSWD_LEN];
typedef off_t  Text_index;
typedef time_t Time;
Per Cederqvist's avatar
.    
Per Cederqvist committed
111
112
113
114
115
116
117
118


/*
 * The privilige bits:  says what priviliges a person has.  E g
 *  if he is allowed to read texts he normally shouldn't be allowed
 *  to read. See file doc/security-levels.txt
 */
typedef	struct {
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
	unsigned int	wheel	: 1;
	unsigned int	admin	: 1;
	unsigned int	statistic : 1;
	unsigned int	create_pers: 1;
	unsigned int	create_conf: 1;
	unsigned int	change_name: 1;
	unsigned int	extern_gw : 1;
	unsigned int	flg8	: 1;	/* For future use. */
	unsigned int	flg9    : 1;
	unsigned int	flg10   : 1;
	unsigned int	flg11   : 1;
	unsigned int	flg12	: 1;
	unsigned int	flg13	: 1;
	unsigned int	flg14	: 1;
	unsigned int	flg15	: 1;
	unsigned int	flg16	: 1;
Per Cederqvist's avatar
.    
Per Cederqvist committed
135
136
137
138
139
140
} Priv_bits;

/*
 * Flags in the Person struct.
 */
typedef struct {
Per Cederqvist's avatar
Per Cederqvist committed
141
142
    unsigned int  unread_is_secret : 1;/* FALSE if everyone is allowed to ask
					  how many unread texts you have. */
143
144
145
146
147
148
149
    unsigned int  flg2	: 1;
    unsigned int  flg3	: 1;
    unsigned int  flg4	: 1;
    unsigned int  flg5	: 1;
    unsigned int  flg6	: 1;
    unsigned int  flg7	: 1;
    unsigned int  flg8	: 1;
Per Cederqvist's avatar
.    
Per Cederqvist committed
150
151
152
153
} Personal_flags;


/* See file doc/misc_items */
154
155
156
157
158
159
160
161
162
typedef enum {
    recpt     = 0,	/* 0 Recipient (conference) */
    cc_recpt  = 1,	/* 1 Carbon Copy recipient (extra kopia) */
    comm_to   = 2,	/* 2 Comment to (text) */
    comm_in   = 3,	/* 3 Commented in (text) */
    footn_to  = 4,	/* 4 This is a footnote to (text) */
    footn_in  = 5,	/* 5 Footnote to this text in (text) */
#ifdef PROT_a
    x_author  = 10,	/* 10 External author (Global_name). */
Per Cederqvist's avatar
.    
Per Cederqvist committed
163
164
#endif
    
165
166
167
168
169
170
171
172
173
174
175
    loc_no    = 6,	/* 6 Sequence number within conference */
    rec_time  = 7,	/* 7 Received at (time) */
    sent_by   = 8,	/* 8 Sent by (person) */
    sent_at   = 9	/* 9 Sent at (time) */
#ifdef PROT_a
	,
    x_person  = 11,	/* 11 External person id. (Global_name). */
    x_recpt   = 12,	/* 12 External recipient. (Global_name). */
    x_text    = 13,	/* 13 External text. (Global_text). */
    x_system  = 14	/* 14 External system identification (System_id). */
#endif
Per Cederqvist's avatar
.    
Per Cederqvist committed
176
177
} Info_type;

178
179
180
181
#ifdef PROT_a
typedef String Global_name;
#endif

Per Cederqvist's avatar
.    
Per Cederqvist committed
182
183
184
185
186
187
188
typedef	union {
		Conf_no		recipient;
		Conf_no		cc_recipient;
		Text_no		comment_to;
		Text_no		commented_in;
		Text_no		footnote_to;
		Text_no		footnoted_in;
189
190
191
192
193
194
195

#ifdef PROT_a
		Global_name	x_author; /* Protocol a. */
#endif

		Local_text_no	local_no;
		Time		received_at;
Per Cederqvist's avatar
.    
Per Cederqvist committed
196
197
		Pers_no		sender;
		Time		sent_at;
198
199
200
201
202
203
204

#ifdef PROT_a
		Global_name	global_person;
		Global_name	global_recpt;
		Global_text	global_text;
		System_id	system_id;
#endif
Per Cederqvist's avatar
.    
Per Cederqvist committed
205
206
207
208
209
210
211
212
213
214
215
216
217
} Info_datum;


/*  This struct contains miscellaneous information about a text.  */
typedef	struct {
	Info_type	type;
	Info_datum	datum;
} Misc_info;


/*  Fields of this type is supposed to tell the garbage collector
 *  which texts it should remove first.
 */
218
typedef unsigned long	Garb_nice;
Per Cederqvist's avatar
.    
Per Cederqvist committed
219
220
221
222
223
224
225
226
227


/*  Struct for text status  */
typedef struct {
	Time		  creation_time;
#ifdef SERVER
        long              file_pos; /* Start of the text in the text file. */
#endif
	Pers_no		  author;
228
	unsigned short		  no_of_lines;
Per Cederqvist's avatar
.    
Per Cederqvist committed
229
	String_size	  no_of_chars;
230
231
	unsigned short		  no_of_marks;	/* Antal markeringar */
	unsigned short		  no_of_misc;	/* Recipients, times, comments, ... */
Per Cederqvist's avatar
.    
Per Cederqvist committed
232
233
234
235
236
	Misc_info	* misc_items;	/* List of miscellaneous info. */
} Text_stat;


typedef	struct {
Per Cederqvist's avatar
Per Cederqvist committed
237
238
239
240
241
242
243
244
245
246
247
	unsigned int	rd_prot	: 1;	/* !(Can anyone become a member?) */
	unsigned int	original : 1;	/* Comments forbidden? */
	unsigned int	secret : 1;	/* Secret conference? */
				/* Note: if a letterbox is secret it
				 * will be very hard for that person
				 * to log in, since he can't map his
				 * name to a pers_no. He must either
				 * know his pers_no, or have another
				 * identity which is his supervisor.
				 */
	unsigned int	letter_box : 1;	/* Is this a letter box? */
248
249
250
251
	unsigned int    anarchy : 1; /* do we accept anonymous messages */
	unsigned int	reserved1 : 1;
	unsigned int	reserved2 : 1;
	unsigned int	reserved3 : 1;
Per Cederqvist's avatar
.    
Per Cederqvist committed
252
253
254
255
256
257
258
259
260
261
262
} Conf_type;


typedef struct {
	Pers_no		member;
} Member;


/* Struct for marks */
typedef struct {
	Text_no		text_no;
Per Cederqvist's avatar
Per Cederqvist committed
263
	unsigned char	mark_type;	/* It's up to the clients to decide the
Per Cederqvist's avatar
.    
Per Cederqvist committed
264
265
266
267
268
269
270
271
					   meaning of this field. */
} Mark;



/*  Information about a person's membership in a conference  */
typedef struct {
	Conf_no		conf_no;
Per Cederqvist's avatar
Per Cederqvist committed
272
	unsigned char	priority;	/* Interrupt priority */
Per Cederqvist's avatar
.    
Per Cederqvist committed
273
274
275
276
	Time		last_time_read;	/* Updated every time a text in this
					   conf. is marked as read.	*/
	Local_text_no	last_text_read;	/* All texts before and inclusive this
					   are read	*/
Per Cederqvist's avatar
Per Cederqvist committed
277
	unsigned short	no_of_read;
Per Cederqvist's avatar
.    
Per Cederqvist committed
278
279
280
281
282
283
284
285
	Local_text_no * read_texts;	/* Texts after last_text_read. Sorted
					   in ascending order */
} Membership;


/* Some structs to handle variable-sized arrays. */

typedef struct {
286
	unsigned short	  no_of_marks;
Per Cederqvist's avatar
.    
Per Cederqvist committed
287
288
289
290
291
	Mark	* marks;		/* Pointer to an array of marks. */
} Mark_list;


typedef struct {
292
    unsigned short no_of_confs;
Per Cederqvist's avatar
.    
Per Cederqvist committed
293
294
295
296
297
    Conf_no  *conf_nos;
} Conf_no_list;


typedef struct {
298
	unsigned short	  no_of_members;
Per Cederqvist's avatar
.    
Per Cederqvist committed
299
300
301
302
303
304
	Member	* members;
} Member_list;


typedef  struct {
	Local_text_no	  first_local_no;
305
    	unsigned long		  no_of_texts;
Per Cederqvist's avatar
.    
Per Cederqvist committed
306
307
308
309
310
311
312
313
	Text_no		* texts;
}  Text_list;


/*  A list of conference numbers, also telling if it is a
 *  mailbox (i e a person) or an ordinary conference.	*/
/* Delete this ugly variant as soon as possible! */
typedef struct {
314
	unsigned long		  no_of_conf_nos;
Per Cederqvist's avatar
.    
Per Cederqvist committed
315
316
317
318
319
320
321
322
323
324
	Conf_no		* conf_nos;
	Conf_type	* type_of_conf;
} Conf_list_old;
/* This is the way it should look! */
typedef struct {
	Conf_no   conf_no;
	Conf_type type;
} Micro_conf;

typedef struct {
325
	unsigned long       no_of_confs;
Per Cederqvist's avatar
.    
Per Cederqvist committed
326
327
328
329
330
331
	Micro_conf * confs;
} Conf_list;


/*  A list of person numbers  */
typedef struct {
332
	unsigned long		  no_of_persons;
Per Cederqvist's avatar
.    
Per Cederqvist committed
333
334
335
336
	Pers_no		* persons;
} Pers_list;

typedef struct {
337
	unsigned short	      no_of_confs;
Per Cederqvist's avatar
.    
Per Cederqvist committed
338
339
340
	Membership  * confs;
} Membership_list;

David Byers's avatar
David Byers committed
341
typedef struct {
342
	int		       length;
David Byers's avatar
David Byers committed
343
344
345
        long                  *data;
} Number_list;

Per Cederqvist's avatar
.    
Per Cederqvist committed
346
347
348
349
350
351
352
353
354
355
356
357

/* The Info struct */
typedef struct {
	long		version;
	Conf_no		conf_pres_conf; /* Presentation of new confs */
	Conf_no		pers_pres_conf;	/* Presentation of new persons */
	Conf_no		motd_conf; 	/* Conf that receive motds */
	Conf_no		kom_news_conf;  /* News about kom */
	Text_no		motd_of_lyskom; /* To be displayed after login */
	/* and maybe more... */
} Info;

358
359
360
/* For performance reasons, sort the fields in increasing size.
  The comments about number of bits are true on a Sun Sparc-2, not
  necessarily anything else.  The code should work anyhow. */
Per Cederqvist's avatar
.    
Per Cederqvist committed
361
typedef	struct {
362
363
364
365
        /* 8-bit quantities */
	Conf_type	type;		/* secret, rd_prot etc */

	/* 16-bit quantities */
Per Cederqvist's avatar
.    
Per Cederqvist committed
366
367
368
369
370
371
372
373
	Pers_no		creator;
	Conf_no		supervisor;	/* Organisat|r f|r m|tet */
	Conf_no		permitted_submitters;	/* People who are allowed
					   to submit texts to this conf. 
					   0 -> anyone may submit. */
	Conf_no		super_conf;	/* Send unallowed submissions to
					   the super_conf. 
					   0 -> unallowed submissions bounce */
374
375
376
377

	/* 32-bit quantities */
	Time		creation_time;
	Text_no		presentation;
Per Cederqvist's avatar
.    
Per Cederqvist committed
378
379
380
381
382
383
384
	Time		last_written;	/* Time of latest text in this conf. */
	Text_no		msg_of_day;	/* Message to be displayed when this
					   conf is referenced by the user. */
	Garb_nice	nice;		/* How long do texts in this
					   conf live? */
	String		name;		/* Name of conference */
#ifdef CLIENT
385
	unsigned short		no_of_members;
Per Cederqvist's avatar
.    
Per Cederqvist committed
386
	Local_text_no	first_local_no;
387
	unsigned long		no_of_texts;
Per Cederqvist's avatar
.    
Per Cederqvist committed
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
#else
	Member_list	members;	/* List of members in conf */
	Text_list	texts;		/* List of texts */
#endif
} Conference;



typedef struct {
	String		name;		/* Name of conference */
	Conf_type	type;		/* secret, rd_prot etc */
	Local_text_no	highest_local_no; /* highest local text no */
	Garb_nice	nice;	        /* Number of days to live */
} Small_conf;

403
404
405
406
407
408
409
410
411
412
typedef struct {
	String      name;
	Conf_type   type;
	Conf_no     conf_no;
} Conf_z_info;

typedef struct {
	unsigned short    no_of_confs;
	Conf_z_info     * confs;
} Conf_z_info_list;
Per Cederqvist's avatar
.    
Per Cederqvist committed
413
414
415
416
417
418
419
420

/*  Struct for persons  */
typedef struct {
	Text_no		user_area;	/* Misc info the clients might want to
					   store. 0 = not used. */
	Priv_bits	privileges;
	Personal_flags	flags;
	Time		last_login; 	/* Or logout */
421
422
423
424
425
426
427
428
	unsigned long		total_time_present; /* Number of seconds. */
	unsigned long		sessions;	/* Number of sessions */
	unsigned long		created_lines;	/* No. of created lines (statistics) */
	unsigned long		created_bytes;	/* No. of created bytes (statistics) */
	unsigned long		read_texts;	/* No. of read texts (statistics) */
	unsigned long		no_of_text_fetches; /* (statistics) */
	unsigned short		created_persons; /* (statistics) */
	unsigned short		created_confs;	/* (statistics) */
Per Cederqvist's avatar
.    
Per Cederqvist committed
429
430
431
432
	String		username;	/* User-name & hostname */
#ifdef CLIENT
	Local_text_no	first_created_text; /* The first text that still
					     * exists. */
433
434
435
	unsigned long		no_of_created_texts;
	unsigned short		no_of_marks;	/* This many marked texts */
	unsigned short		no_of_confs;	/* Member in this many confs */
Per Cederqvist's avatar
.    
Per Cederqvist committed
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
#else	/* SERVER */
	Text_list	created_texts;
	Mark_list	marks;		/* List of marked texts */
	Membership_list conferences;	/* List of conferences the person is
					 * a member in. */
	Password	pwd;		/* Encrypted password */
#endif
} Person;


/*
 * This struct is returned from the 'who_is_on' call.
 */
typedef struct {
	Pers_no		person;
	String		what_am_i_doing;
	Conf_no		working_conference;
} Who_info_old;

typedef struct {
	Pers_no		person;
	String		what_am_i_doing;
	String		username;           /* Userid and hostname. */
	Conf_no		working_conference;
	Session_no	session_no;         /* Serial number of connection. */
} Who_info;

463
464
465
466
467
468
469
470
471
472
typedef struct {
	Pers_no		person;
	String		what_am_i_doing;
	String		username;           /* Userid and hostname. */
	String		ident_user;	     /* According to Ident protocol. */
	String		hostname; 	     /* According to TCP/IP. */
	Conf_no		working_conference;
	Session_no	session_no;         /* Serial number of connection. */
} Who_info_ident;

Per Cederqvist's avatar
.    
Per Cederqvist committed
473
474
475
476
477
478
479
typedef struct {
	Pers_no		person;
	String		what_am_i_doing;
	String		username;            /* Userid and hostname. */
	Conf_no		working_conference;
	Session_no	session;             /* Serial number of connection. */
	Time		connection_time;     /* Not logintime. */
480
	unsigned long		idle_time; 	     /* Seconds. */
Per Cederqvist's avatar
.    
Per Cederqvist committed
481
482
} Session_info;

483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
typedef struct {
	Session_no     session;
	Pers_no        person;
	Conf_no        working_conference;
	unsigned long  idle_time;
	Bool           invisible;
	String         what_am_i_doing;
} Dynamic_session_info;

typedef struct {
	long		          no_of_sessions;
    	Dynamic_session_info	* sessions;
} Dynamic_session_info_list;	

typedef struct {
	String  username;
	String  hostname;
	String  ident_user;
	Time    connection_time;
} Static_session_info;
Per Cederqvist's avatar
.    
Per Cederqvist committed
503

504
505
506
507
508
509
510
511
512
513
typedef struct {
	Pers_no		person;
	String		what_am_i_doing;
	String		username;            /* Userid and hostname,
						according to the client. */
	String		ident_user;	     /* According to Ident protocol. */
	String		hostname; 	     /* According to TCP/IP. */
	Conf_no		working_conference;
	Session_no	session;             /* Serial number of connection. */
	Time		connection_time;     /* Not logintime. */
514
	unsigned long		idle_time; 	     /* Seconds. */
515
516
} Session_info_ident;

Per Cederqvist's avatar
.    
Per Cederqvist committed
517
518
519
520
521
522
523
524
525
526
527
528
529

typedef struct {
	int		  no_of_persons;
    	Who_info_old	* info;
} Who_info_list_old;	


typedef struct {
	int		  no_of_persons;
    	Who_info	* info;
} Who_info_list;	


530
531
532
533
534
typedef struct {
	int		  no_of_persons;
    	Who_info_ident	* info;
} Who_info_ident_list;

535
536
537
538
539
540
541
542
543
544
545
546
547
548
typedef struct {
        unsigned long protocol_version;
        String        server_name;
        String        server_version;
} Version_info;

#ifdef SERVER
typedef struct {
        unsigned long protocol_version;
        char *        server_name;
        char *        server_version;
} Version_info_internal;
#endif

Per Cederqvist's avatar
.    
Per Cederqvist committed
549
#endif	/*  ifndef  KOM_TYPES_H_ALREADY_INCLUDED__  */