8 #define INLINE __inline__
15 #include <openssl/ssl.h>
19 * New format for a message in memory
22 int cm_magic; /* Self-check (NOT SAVED TO DISK) */
23 char cm_anon_type; /* Anonymous or author-visible */
24 char cm_format_type; /* Format type */
25 char *cm_fields[256]; /* Data fields */
26 unsigned int cm_flags; /* How to handle (NOT SAVED TO DISK) */
29 #define CTDLMESSAGE_MAGIC 0x159d
30 #define CM_SKIP_HOOKS 0x01 /* Don't run server-side handlers */
34 * Generic per-session variable or data structure storage
37 struct CtdlSessData *next;
43 * Static user data symbol types. Server extensions can ask for dynamic
44 * extensions to per-session data, but the symbol ID has to be listed here.
47 SYM_DESIRED_SECTION, /* Used by the MIME parser */
48 SYM_MA_INFO, /* Handles multipart/alternative */
49 SYM_REPL, /* Used for replication checking */
50 SYM_CIT_ICAL, /* Used by the calendar service */
51 SYM_IMAP, /* Used by the IMAP service */
52 SYM_POP3, /* Used by the POP3 service */
53 SYM_SMTP, /* Used by the SMTP service */
56 SYM_VCARD, /* vCard handling requires this */
62 * Here's the big one... the Citadel context structure.
64 * This structure keeps track of all information relating to a running
65 * session on the server. We keep one of these for each session thread.
67 * Note that the first element is "*next" so that it may be used without
68 * modification in a linked list.
71 struct CitContext *next; /* Link to next session in the list */
73 struct ctdluser user; /* Database record buffers */
76 int state; /* thread state (see CON_ values below) */
77 int kill_me; /* Set to nonzero to flag for termination */
79 char curr_user[USERNAME_SIZE]; /* name of current user */
80 int logged_in; /* logged in */
81 int internal_pgm; /* authenticated as internal program */
82 char temp[PATH_MAX]; /* temp file name */
83 int nologin; /* not allowed to log in */
84 int is_local_socket; /* set to 1 if client is on unix domain sock */
85 int curr_view; /* The view type for the current user/room */
87 char net_node[PATH_MAX];/* Is the client another Citadel server? */
89 int cs_pid; /* session ID */
90 time_t lastcmd; /* time of last command executed */
91 time_t lastidle; /* For computing idle time */
92 time_t previous_login; /* Date/time of previous login */
93 char lastcmdname[5]; /* name of last command executed */
94 unsigned cs_flags; /* miscellaneous flags */
95 void (*h_command_function) (void) ; /* service command function */
96 void (*h_async_function) (void) ; /* do async msgs function */
97 int is_async; /* Nonzero if client accepts async msgs */
98 int async_waiting; /* Nonzero if there are async msgs waiting */
99 int input_waiting; /* Nonzero if there is client input waiting */
101 /* feeping creaturisms... */
102 int cs_clientdev; /* client developer ID */
103 int cs_clienttyp; /* client type code */
104 int cs_clientver; /* client version number */
105 char cs_clientname[32]; /* name of client software */
106 char cs_host[64]; /* host logged in from */
107 char cs_addr[64]; /* address logged in from */
109 /* The Internet type of thing */
110 char cs_inet_email[SIZ];/* Return address of outbound Internet mail */
112 FILE *download_fp; /* Fields relating to file transfer */
114 char upl_file[PATH_MAX];
115 char upl_path[PATH_MAX];
116 char upl_comment[SIZ];
117 char upl_filedir[PATH_MAX];
121 /* Beginning of cryptography - session nonce */
122 char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */
124 /* Redirect this session's output to somewhere else? */
133 char *output_buffer; /* hold output for one big dump */
136 /* A linked list of all instant messages sent to us. */
137 struct ExpressMessage *FirstExpressMessage;
138 int disable_exp; /* Set to 1 to disable incoming pages */
139 int newmail; /* Other sessions increment this */
142 char fake_username[USERNAME_SIZE]; /* Fake username <bc> */
143 char fake_postname[USERNAME_SIZE]; /* Fake postname <bc> */
144 char fake_hostname[64]; /* Fake hostname <bc> */
145 char fake_roomname[ROOMNAMELEN]; /* Fake roomname <bc> */
147 char preferred_formats[SIZ]; /* Preferred MIME formats */
149 /* Dynamically allocated session data */
150 struct CtdlSessData *FirstSessData;
153 typedef struct CitContext t_context;
156 * Values for CitContext.state
158 * A session that is doing nothing is in CON_IDLE state. When activity
159 * is detected on the socket, it goes to CON_READY, indicating that it
160 * needs to have a worker thread bound to it. When a thread binds to
161 * the session, it goes to CON_EXECUTING and does its thing. When the
162 * transaction is finished, the thread sets it back to CON_IDLE and lets
166 CON_IDLE, /* This context is doing nothing */
167 CON_READY, /* This context needs attention */
168 CON_EXECUTING /* This context is bound to a thread */
172 #define CS_STEALTH 1 /* stealth mode */
173 #define CS_CHAT 2 /* chat mode */
174 #define CS_POSTING 4 /* Posting */
176 struct CitContext *MyContext(void);
177 #define CC MyContext()
179 extern struct CitContext *ContextList;
180 extern int ScheduledShutdown;
181 extern struct CitControl CitControl;
184 struct ExpressMessage {
185 struct ExpressMessage *next;
186 time_t timestamp; /* When this message was sent */
187 unsigned flags; /* Special instructions */
188 char sender[64]; /* Name of sending user */
189 char *text; /* Message text (if applicable) */
192 #define EM_BROADCAST 1 /* Broadcast message */
193 #define EM_GO_AWAY 2 /* Server requests client log off */
194 #define EM_CHAT 4 /* Server requests client enter chat */
197 struct ChatLine *next;
201 char chat_username[USERNAME_SIZE];
202 char chat_room[ROOMNAMELEN];
206 * Various things we need to lock and unlock
240 * message transfer formats
243 MT_CITADEL, /* Citadel proprietary */
244 MT_RFC822, /* RFC822 */
245 MT_MIME, /* MIME-formatted message */
246 MT_DOWNLOAD /* Download a component */
250 * Message format types in the database
252 #define FMT_CITADEL 0 /* Citadel vari-format (proprietary) */
253 #define FMT_FIXED 1 /* Fixed format (proprietary) */
254 #define FMT_RFC822 4 /* Standard (headers are in M field) */
258 * Citadel DataBases (define one for each cdb we need to open)
261 CDB_MSGMAIN, /* message base */
262 CDB_USERS, /* user file */
263 CDB_ROOMS, /* room index */
264 CDB_FLOORTAB, /* floor index */
265 CDB_MSGLISTS, /* room message lists */
266 CDB_VISIT, /* user/room relationships */
267 CDB_DIRECTORY, /* address book directory */
268 CDB_USETABLE, /* network use table */
269 CDB_BIGMSGS, /* larger message bodies */
270 MAXCDB /* total number of CDB's defined */
280 /* Structures and declarations for function hooks of various types */
282 struct LogFunctionHook {
283 struct LogFunctionHook *next;
285 void (*h_function_pointer) (char *);
287 extern struct LogFunctionHook *LogHookTable;
289 struct CleanupFunctionHook {
290 struct CleanupFunctionHook *next;
291 void (*h_function_pointer) (void);
293 extern struct CleanupFunctionHook *CleanupHookTable;
299 * SessionFunctionHook extensions are used for any type of hook for which
300 * the context in which it's being called (which is determined by the event
301 * type) will make it obvious for the hook function to know where to look for
304 struct SessionFunctionHook {
305 struct SessionFunctionHook *next;
306 void (*h_function_pointer) (void);
309 extern struct SessionFunctionHook *SessionHookTable;
312 * Event types can't be enum'ed, because they must remain consistent between
313 * builds (to allow for binary modules built somewhere else)
315 #define EVT_STOP 0 /* Session is terminating */
316 #define EVT_START 1 /* Session is starting */
317 #define EVT_LOGIN 2 /* A user is logging in */
318 #define EVT_NEWROOM 3 /* Changing rooms */
319 #define EVT_LOGOUT 4 /* A user is logging out */
320 #define EVT_SETPASS 5 /* Setting or changing password */
321 #define EVT_CMD 6 /* Called after each server command */
322 #define EVT_RWHO 7 /* An RWHO command is being executed */
323 #define EVT_ASYNC 8 /* Doing asynchronous messages */
325 #define EVT_TIMER 50 /* Timer events are called once per minute
326 and are not tied to any session */
329 * UserFunctionHook extensions are used for any type of hook which implements
330 * an operation on a user or username (potentially) other than the one
331 * operating the current session.
333 struct UserFunctionHook {
334 struct UserFunctionHook *next;
335 void (*h_function_pointer) (struct ctdluser *usbuf);
338 extern struct UserFunctionHook *UserHookTable;
340 #define EVT_PURGEUSER 100 /* Deleting a user */
341 #define EVT_NEWUSER 102 /* Creating a user */
344 * MessageFunctionHook extensions are used for hooks which implement handlers
345 * for various types of message operations (save, read, etc.)
347 struct MessageFunctionHook {
348 struct MessageFunctionHook *next;
349 int (*h_function_pointer) (struct CtdlMessage *msg);
352 extern struct MessageFunctionHook *MessageHookTable;
354 #define EVT_BEFOREREAD 200
355 #define EVT_BEFORESAVE 201
356 #define EVT_AFTERSAVE 202
357 #define EVT_SMTPSCAN 203 /* called before submitting a msg from SMTP */
362 * NetprocFunctionHook extensions are used for hooks which implement handlers
363 * for incoming network messages.
365 struct NetprocFunctionHook {
366 struct NetprocFunctionHook *next;
367 int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
369 extern struct NetprocFunctionHook *NetprocHookTable;
373 * DeleteFunctionHook extensions are used for hooks which get called when a
374 * message is about to be deleted.
376 struct DeleteFunctionHook {
377 struct DeleteFunctionHook *next;
378 void (*h_function_pointer) (char *target_room, long msgnum);
380 extern struct DeleteFunctionHook *DeleteHookTable;
384 * ExpressMessageFunctionHook extensions are used for hooks which implement
385 * the sending of an instant message through various channels. Any function
386 * registered should return the number of recipients to whom the message was
387 * successfully transmitted.
389 struct XmsgFunctionHook {
390 struct XmsgFunctionHook *next;
391 int (*h_function_pointer) (char *, char *, char *);
394 extern struct XmsgFunctionHook *XmsgHookTable;
396 /* Priority levels for paging functions (lower is better) */
398 XMSG_PRI_LOCAL, /* Other users on -this- server */
399 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
400 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
407 * ServiceFunctionHook extensions are used for hooks which implement various
408 * non-Citadel services (on TCP protocols) directly in the Citadel server.
410 struct ServiceFunctionHook {
411 struct ServiceFunctionHook *next;
414 void (*h_greeting_function) (void) ;
415 void (*h_command_function) (void) ;
416 void (*h_async_function) (void) ;
419 extern struct ServiceFunctionHook *ServiceHookTable;
423 /* Defines the relationship of a user to a particular room */
429 unsigned int v_flags;
431 char v_answered[SIZ];
435 #define V_FORGET 1 /* User has zapped this room */
436 #define V_LOCKOUT 2 /* User is locked out of this room */
437 #define V_ACCESS 4 /* Access is granted to this room */
440 /* Supplementary data for a message on disk
441 * These are kept separate from the message itself for one of two reasons:
442 * 1. Either their values may change at some point after initial save, or
443 * 2. They are merely caches of data which exist somewhere else, for speed.
446 long meta_msgnum; /* Message number in *local* message base */
447 int meta_refcount; /* Number of rooms pointing to this msg */
448 char meta_content_type[64]; /* Cached MIME content-type */
449 long meta_rfc822_length; /* Cache of RFC822-translated msg length */
454 * Serialization routines use this struct to return a pointer and a length
462 /* Preferred field order */
463 /* ********** Important fields */
464 /* *************** Semi-important fields */
465 /* * Message text (MUST be last) */
466 #define FORDER "IPTAFONHRDBCEGJKLQSVWXYZUM"
468 #endif /* SERVER_H */