8 #define INLINE __inline__
15 #define OPENSSL_NO_KRB5 /* work around redhat b0rken ssl headers */
16 #include <openssl/ssl.h>
20 * New format for a message in memory
23 int cm_magic; /* Self-check (NOT SAVED TO DISK) */
24 char cm_anon_type; /* Anonymous or author-visible */
25 char cm_format_type; /* Format type */
26 char *cm_fields[256]; /* Data fields */
27 unsigned int cm_flags; /* How to handle (NOT SAVED TO DISK) */
30 #define CTDLMESSAGE_MAGIC 0x159d
31 #define CM_SKIP_HOOKS 0x01 /* Don't run server-side handlers */
36 * Exit codes 101 through 109 are used for conditions in which
37 * we deliberately do NOT want the service to automatically
40 #define CTDLEXIT_CONFIG 101 /* Could not read citadel.config */
41 #define CTDLEXIT_CONTROL 102 /* Could not acquire lock */
42 #define CTDLEXIT_HOME 103 /* Citadel home directory not found */
43 #define CTDLEXIT_OOD 104 /* Out Of Date config - rerun setup */
44 #define CTDLEXIT_DB 105 /* Unable to initialize database */
50 * Here's the big one... the Citadel context structure.
52 * This structure keeps track of all information relating to a running
53 * session on the server. We keep one of these for each session thread.
55 * Note that the first element is "*next" so that it may be used without
56 * modification in a linked list.
59 struct CitContext *prev; /* Link to previous session in list */
60 struct CitContext *next; /* Link to next session in the list */
62 int state; /* thread state (see CON_ values below) */
63 int kill_me; /* Set to nonzero to flag for termination */
65 int cs_pid; /* session ID */
66 time_t lastcmd; /* time of last command executed */
67 time_t lastidle; /* For computing idle time */
69 char curr_user[USERNAME_SIZE]; /* name of current user */
70 int logged_in; /* logged in */
71 int internal_pgm; /* authenticated as internal program */
72 int nologin; /* not allowed to log in */
73 int is_local_socket; /* set to 1 if client is on unix domain sock */
74 int curr_view; /* The view type for the current user/room */
76 char net_node[32] ;/* Is the client another Citadel server? */
77 time_t previous_login; /* Date/time of previous login */
78 char lastcmdname[5]; /* name of last command executed */
79 unsigned cs_flags; /* miscellaneous flags */
80 void (*h_command_function) (void) ; /* service command function */
81 void (*h_async_function) (void) ; /* do async msgs function */
82 int is_async; /* Nonzero if client accepts async msgs */
83 int async_waiting; /* Nonzero if there are async msgs waiting */
84 int input_waiting; /* Nonzero if there is client input waiting */
86 /* feeping creaturisms... */
87 int cs_clientdev; /* client developer ID */
88 int cs_clienttyp; /* client type code */
89 int cs_clientver; /* client version number */
90 char cs_clientname[32]; /* name of client software */
91 char cs_host[64]; /* host logged in from */
92 char cs_addr[64]; /* address logged in from */
94 /* The Internet type of thing */
95 char cs_inet_email[128];/* Return address of outbound Internet mail */
97 FILE *download_fp; /* Fields relating to file transfer */
98 char download_desired_section[128];
101 char upl_path[PATH_MAX];
102 char upl_comment[256];
103 char upl_filedir[PATH_MAX];
107 struct ctdluser user; /* Database record buffers */
108 struct ctdlroom room;
110 /* Beginning of cryptography - session nonce */
111 char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */
113 /* Redirect this session's output to a memory buffer? */
114 char *redirect_buffer; /* the buffer */
115 size_t redirect_len; /* length of data in buffer */
116 size_t redirect_alloc; /* length of allocated buffer */
123 char *output_buffer; /* hold output for one big dump */
126 /* A linked list of all instant messages sent to us. */
127 struct ExpressMessage *FirstExpressMessage;
128 int disable_exp; /* Set to 1 to disable incoming pages */
129 int newmail; /* Other sessions increment this */
132 char fake_username[USERNAME_SIZE]; /* Fake username <bc> */
133 char fake_postname[USERNAME_SIZE]; /* Fake postname <bc> */
134 char fake_hostname[64]; /* Fake hostname <bc> */
135 char fake_roomname[ROOMNAMELEN]; /* Fake roomname <bc> */
137 char preferred_formats[256]; /* Preferred MIME formats */
139 /* Dynamically allocated session data */
140 struct citimap *IMAP;
141 struct citpop3 *POP3;
142 struct citsmtp *SMTP;
143 struct citmgsve *MGSVE; /**< Managesieve Session struct */
146 struct cit_ical *CIT_ICAL; /* calendaring data */
147 struct ma_info *ma; /* multipart/alternative data */
150 typedef struct CitContext t_context;
153 * Values for CitContext.state
155 * A session that is doing nothing is in CON_IDLE state. When activity
156 * is detected on the socket, it goes to CON_READY, indicating that it
157 * needs to have a worker thread bound to it. When a thread binds to
158 * the session, it goes to CON_EXECUTING and does its thing. When the
159 * transaction is finished, the thread sets it back to CON_IDLE and lets
163 CON_IDLE, /* This context is doing nothing */
164 CON_READY, /* This context needs attention */
165 CON_EXECUTING /* This context is bound to a thread */
169 #define CS_STEALTH 1 /* stealth mode */
170 #define CS_CHAT 2 /* chat mode */
171 #define CS_POSTING 4 /* Posting */
173 struct CitContext *MyContext(void);
174 #define CC MyContext()
177 * This is the control record for the message base...
180 long MMhighest; /* highest message number in file */
181 unsigned MMflags; /* Global system flags */
182 long MMnextuser; /* highest user number on system */
183 long MMnextroom; /* highest room number on system */
184 int version; /* Server-hosted upgrade level */
185 int fulltext_wordbreaker; /* ID of wordbreaker in use */
186 long MMfulltext; /* highest message number indexed */
189 extern struct CitContext *ContextList;
190 extern int ScheduledShutdown;
191 extern struct CitControl CitControl;
194 struct ExpressMessage {
195 struct ExpressMessage *next;
196 time_t timestamp; /* When this message was sent */
197 unsigned flags; /* Special instructions */
198 char sender[64]; /* Name of sending user */
199 char *text; /* Message text (if applicable) */
202 #define EM_BROADCAST 1 /* Broadcast message */
203 #define EM_GO_AWAY 2 /* Server requests client log off */
204 #define EM_CHAT 4 /* Server requests client enter chat */
207 struct ChatLine *next;
211 char chat_username[USERNAME_SIZE];
212 char chat_room[ROOMNAMELEN];
216 * Various things we need to lock and unlock
254 * message transfer formats
257 MT_CITADEL, /* Citadel proprietary */
258 MT_RFC822, /* RFC822 */
259 MT_MIME, /* MIME-formatted message */
260 MT_DOWNLOAD, /* Download a component */
261 MT_SPEW_SECTION /* Download a component in a single operation */
265 * Message format types in the database
267 #define FMT_CITADEL 0 /* Citadel vari-format (proprietary) */
268 #define FMT_FIXED 1 /* Fixed format (proprietary) */
269 #define FMT_RFC822 4 /* Standard (headers are in M field) */
273 * Citadel DataBases (define one for each cdb we need to open)
276 CDB_MSGMAIN, /* message base */
277 CDB_USERS, /* user file */
278 CDB_ROOMS, /* room index */
279 CDB_FLOORTAB, /* floor index */
280 CDB_MSGLISTS, /* room message lists */
281 CDB_VISIT, /* user/room relationships */
282 CDB_DIRECTORY, /* address book directory */
283 CDB_USETABLE, /* network use table */
284 CDB_BIGMSGS, /* larger message bodies */
285 CDB_FULLTEXT, /* full text search index */
286 CDB_EUIDINDEX, /* locate msgs by EUID */
287 MAXCDB /* total number of CDB's defined */
297 /* Structures and declarations for function hooks of various types */
299 struct LogFunctionHook {
300 struct LogFunctionHook *next;
302 void (*h_function_pointer) (char *);
304 extern struct LogFunctionHook *LogHookTable;
306 struct CleanupFunctionHook {
307 struct CleanupFunctionHook *next;
308 void (*h_function_pointer) (void);
310 extern struct CleanupFunctionHook *CleanupHookTable;
312 struct FixedOutputHook {
313 struct FixedOutputHook *next;
314 char content_type[64];
315 void (*h_function_pointer) (char *, int);
317 extern struct FixedOutputHook *FixedOutputTable;
322 * SessionFunctionHook extensions are used for any type of hook for which
323 * the context in which it's being called (which is determined by the event
324 * type) will make it obvious for the hook function to know where to look for
327 struct SessionFunctionHook {
328 struct SessionFunctionHook *next;
329 void (*h_function_pointer) (void);
332 extern struct SessionFunctionHook *SessionHookTable;
335 * Event types can't be enum'ed, because they must remain consistent between
336 * builds (to allow for binary modules built somewhere else)
338 #define EVT_STOP 0 /* Session is terminating */
339 #define EVT_START 1 /* Session is starting */
340 #define EVT_LOGIN 2 /* A user is logging in */
341 #define EVT_NEWROOM 3 /* Changing rooms */
342 #define EVT_LOGOUT 4 /* A user is logging out */
343 #define EVT_SETPASS 5 /* Setting or changing password */
344 #define EVT_CMD 6 /* Called after each server command */
345 #define EVT_RWHO 7 /* An RWHO command is being executed */
346 #define EVT_ASYNC 8 /* Doing asynchronous messages */
348 #define EVT_TIMER 50 /* Timer events are called once per minute
349 and are not tied to any session */
352 * UserFunctionHook extensions are used for any type of hook which implements
353 * an operation on a user or username (potentially) other than the one
354 * operating the current session.
356 struct UserFunctionHook {
357 struct UserFunctionHook *next;
358 void (*h_function_pointer) (struct ctdluser *usbuf);
361 extern struct UserFunctionHook *UserHookTable;
363 #define EVT_PURGEUSER 100 /* Deleting a user */
364 #define EVT_NEWUSER 102 /* Creating a user */
367 * MessageFunctionHook extensions are used for hooks which implement handlers
368 * for various types of message operations (save, read, etc.)
370 struct MessageFunctionHook {
371 struct MessageFunctionHook *next;
372 int (*h_function_pointer) (struct CtdlMessage *msg);
375 extern struct MessageFunctionHook *MessageHookTable;
377 #define EVT_BEFOREREAD 200
378 #define EVT_BEFORESAVE 201
379 #define EVT_AFTERSAVE 202
380 #define EVT_SMTPSCAN 203 /* called before submitting a msg from SMTP */
385 * NetprocFunctionHook extensions are used for hooks which implement handlers
386 * for incoming network messages.
388 struct NetprocFunctionHook {
389 struct NetprocFunctionHook *next;
390 int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
392 extern struct NetprocFunctionHook *NetprocHookTable;
396 * DeleteFunctionHook extensions are used for hooks which get called when a
397 * message is about to be deleted.
399 struct DeleteFunctionHook {
400 struct DeleteFunctionHook *next;
401 void (*h_function_pointer) (char *target_room, long msgnum);
403 extern struct DeleteFunctionHook *DeleteHookTable;
407 * ExpressMessageFunctionHook extensions are used for hooks which implement
408 * the sending of an instant message through various channels. Any function
409 * registered should return the number of recipients to whom the message was
410 * successfully transmitted.
412 struct XmsgFunctionHook {
413 struct XmsgFunctionHook *next;
414 int (*h_function_pointer) (char *, char *, char *);
417 extern struct XmsgFunctionHook *XmsgHookTable;
419 /* Priority levels for paging functions (lower is better) */
421 XMSG_PRI_LOCAL, /* Other users on -this- server */
422 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
423 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
430 * ServiceFunctionHook extensions are used for hooks which implement various
431 * non-Citadel services (on TCP protocols) directly in the Citadel server.
433 struct ServiceFunctionHook {
434 struct ServiceFunctionHook *next;
437 void (*h_greeting_function) (void) ;
438 void (*h_command_function) (void) ;
439 void (*h_async_function) (void) ;
442 extern struct ServiceFunctionHook *ServiceHookTable;
446 /* Defines the relationship of a user to a particular room */
452 unsigned int v_flags;
454 char v_answered[SIZ];
458 #define V_FORGET 1 /* User has zapped this room */
459 #define V_LOCKOUT 2 /* User is locked out of this room */
460 #define V_ACCESS 4 /* Access is granted to this room */
463 /* Supplementary data for a message on disk
464 * These are kept separate from the message itself for one of two reasons:
465 * 1. Either their values may change at some point after initial save, or
466 * 2. They are merely caches of data which exist somewhere else, for speed.
469 long meta_msgnum; /* Message number in *local* message base */
470 int meta_refcount; /* Number of rooms pointing to this msg */
471 char meta_content_type[64]; /* Cached MIME content-type */
472 long meta_rfc822_length; /* Cache of RFC822-translated msg length */
475 /* Calls to AdjRefCount() are queued and deferred, so the user doesn't
476 * have to wait for various disk-intensive operations to complete synchronously.
477 * This is the record format.
480 long arcq_msgnum; /* Message number being adjusted */
481 int arcq_delta; /* Adjustment ( usually 1 or -1 ) */
486 * Serialization routines use this struct to return a pointer and a length
494 /* Preferred field order */
495 /* ********** Important fields */
496 /* *************** Semi-important fields */
497 /* * Message text (MUST be last) */
498 #define FORDER "IPTAFONHRDBCEJGKLQSVWXZYUM"
500 #endif /* SERVER_H */