3 /* Uncomment this if you want to track memory leaks.
4 * This incurs some overhead, so don't use it unless you're debugging the code!
6 /* #define DEBUG_MEMORY_LEAKS */
9 * New format for a message in memory
23 #include <openssl/ssl.h>
26 #define CTDLMESSAGE_MAGIC 0x159d
28 int cm_magic; /* Self-check */
29 char cm_anon_type; /* Anonymous or author-visible */
30 char cm_format_type; /* Format type */
31 char *cm_fields[256]; /* Data fields */
32 unsigned int cm_flags; /* How to handle (NOT SAVED TO DISK) */
35 #define CM_SKIP_HOOKS 0x01 /* Don't run server-side handlers */
39 * Generic per-session variable or data structure storage
42 struct CtdlSessData *next;
48 * Static user data symbol types
51 SYM_DESIRED_SECTION, /* Used by the MIME parser */
52 SYM_MA_INFO, /* Handles multipart/alternative */
53 SYM_REPL, /* Used for replication checking */
59 * Here's the big one... the Citadel context structure.
61 * This structure keeps track of all information relating to a running
62 * session on the server. We keep one of these for each session thread.
64 * Note that the first element is "*next" so that it may be used without
65 * modification in a linked list.
68 struct CitContext *next; /* Link to next session in the list */
70 struct ctdluser user; /* Database record buffers */
73 int state; /* thread state (see CON_ values below) */
74 int kill_me; /* Set to nonzero to flag for termination */
76 char curr_user[USERNAME_SIZE]; /* name of current user */
77 int logged_in; /* logged in */
78 int internal_pgm; /* authenticated as internal program */
79 char temp[PATH_MAX]; /* temp file name */
80 int nologin; /* not allowed to log in */
81 int is_local_socket; /* set to 1 if client is on unix domain sock */
83 char net_node[PATH_MAX];/* Is the client another Citadel server? */
85 int cs_pid; /* session ID */
86 time_t lastcmd; /* time of last command executed */
87 time_t lastidle; /* For computing idle time */
88 time_t previous_login; /* Date/time of previous login */
89 char lastcmdname[5]; /* name of last command executed */
90 unsigned cs_flags; /* miscellaneous flags */
91 void (*h_command_function) (void) ; /* service command function */
92 int is_async; /* Nonzero if client accepts async msgs */
94 /* feeping creaturisms... */
95 int cs_clientdev; /* client developer ID */
96 int cs_clienttyp; /* client type code */
97 int cs_clientver; /* client version number */
98 char cs_clientname[32]; /* name of client software */
99 char cs_host[64]; /* host logged in from */
100 char cs_addr[64]; /* address logged in from */
102 /* The Internet type of thing */
103 char cs_inet_email[SIZ];/* Return address of outbound Internet mail */
105 FILE *download_fp; /* Fields relating to file transfer */
107 char upl_file[PATH_MAX];
108 char upl_path[PATH_MAX];
109 char upl_comment[SIZ];
110 char upl_filedir[PATH_MAX];
114 /* Beginning of cryptography - session nonce */
115 char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */
117 /* Redirect this session's output to somewhere else? */
125 /* A linked list of all express messages sent to us. */
126 struct ExpressMessage *FirstExpressMessage;
127 int disable_exp; /* Set to 1 to disable incoming pages */
128 int newmail; /* Other sessions increment this */
131 char fake_username[USERNAME_SIZE]; /* Fake username <bc> */
132 char fake_postname[USERNAME_SIZE]; /* Fake postname <bc> */
133 char fake_hostname[64]; /* Fake hostname <bc> */
134 char fake_roomname[ROOMNAMELEN]; /* Fake roomname <bc> */
136 char preferred_formats[SIZ]; /* Preferred MIME formats */
138 /* Dynamically allocated session data */
139 struct CtdlSessData *FirstSessData;
142 typedef struct CitContext t_context;
144 /* Values for CitContext.state */
146 CON_IDLE, /* This context is doing nothing */
147 CON_EXECUTING /* This context is bound to a thread */
151 #define CS_STEALTH 1 /* stealth mode */
152 #define CS_CHAT 2 /* chat mode */
153 #define CS_POSTING 4 /* Posting */
155 struct CitContext *MyContext(void);
156 #define CC MyContext()
158 extern struct CitContext *ContextList;
159 extern int ScheduledShutdown;
160 extern struct CitControl CitControl;
163 struct ExpressMessage {
164 struct ExpressMessage *next;
165 time_t timestamp; /* When this message was sent */
166 unsigned flags; /* Special instructions */
167 char sender[64]; /* Name of sending user */
168 char *text; /* Message text (if applicable) */
171 #define EM_BROADCAST 1 /* Broadcast message */
172 #define EM_GO_AWAY 2 /* Server requests client log off */
173 #define EM_CHAT 4 /* Server requests client enter chat */
176 struct ChatLine *next;
180 char chat_username[USERNAME_SIZE];
181 char chat_room[ROOMNAMELEN];
185 * Various things we need to lock and unlock
217 * message transfer formats
220 MT_CITADEL, /* Citadel proprietary */
221 MT_RFC822, /* RFC822 */
222 MT_MIME, /* MIME-formatted message */
223 MT_DOWNLOAD /* Download a component */
227 * Message format types in the database
229 #define FMT_CITADEL 0 /* Citadel vari-format (proprietary) */
230 #define FMT_FIXED 1 /* Fixed format (proprietary) */
231 #define FMT_RFC822 4 /* Standard (headers are in M field) */
235 * Citadel DataBases (define one for each cdb we need to open)
238 CDB_MSGMAIN, /* message base */
239 CDB_USERS, /* user file */
240 CDB_ROOMS, /* room index */
241 CDB_FLOORTAB, /* floor index */
242 CDB_MSGLISTS, /* room message lists */
243 CDB_VISIT, /* user/room relationships */
244 CDB_DIRECTORY, /* address book directory */
245 CDB_USETABLE, /* network use table */
246 MAXCDB /* total number of CDB's defined */
256 /* Structures and declarations for function hooks of various types */
258 struct LogFunctionHook {
259 struct LogFunctionHook *next;
261 void (*h_function_pointer) (char *);
263 extern struct LogFunctionHook *LogHookTable;
265 struct CleanupFunctionHook {
266 struct CleanupFunctionHook *next;
267 void (*h_function_pointer) (void);
269 extern struct CleanupFunctionHook *CleanupHookTable;
275 * SessionFunctionHook extensions are used for any type of hook for which
276 * the context in which it's being called (which is determined by the event
277 * type) will make it obvious for the hook function to know where to look for
280 struct SessionFunctionHook {
281 struct SessionFunctionHook *next;
282 void (*h_function_pointer) (void);
285 extern struct SessionFunctionHook *SessionHookTable;
288 * Event types can't be enum'ed, because they must remain consistent between
289 * builds (to allow for binary modules built somewhere else)
291 #define EVT_STOP 0 /* Session is terminating */
292 #define EVT_START 1 /* Session is starting */
293 #define EVT_LOGIN 2 /* A user is logging in */
294 #define EVT_NEWROOM 3 /* Changing rooms */
295 #define EVT_LOGOUT 4 /* A user is logging out */
296 #define EVT_SETPASS 5 /* Setting or changing password */
297 #define EVT_CMD 6 /* Called after each server command */
298 #define EVT_RWHO 7 /* An RWHO command is being executed */
300 #define EVT_TIMER 50 /* Timer events are called once per minute
301 and are not tied to any session */
304 * UserFunctionHook extensions are used for any type of hook which implements
305 * an operation on a user or username (potentially) other than the one
306 * operating the current session.
308 struct UserFunctionHook {
309 struct UserFunctionHook *next;
310 void (*h_function_pointer) (char *username, long usernum);
313 extern struct UserFunctionHook *UserHookTable;
315 #define EVT_PURGEUSER 100 /* Deleting a user */
316 #define EVT_OUTPUTMSG 101 /* Outputting a message */
319 * MessageFunctionHook extensions are used for hooks which implement handlers
320 * for various types of message operations (save, read, etc.)
322 struct MessageFunctionHook {
323 struct MessageFunctionHook *next;
324 int (*h_function_pointer) (struct CtdlMessage *msg);
327 extern struct MessageFunctionHook *MessageHookTable;
329 #define EVT_BEFOREREAD 200
330 #define EVT_BEFORESAVE 201
331 #define EVT_AFTERSAVE 202
332 #define EVT_SMTPSCAN 203 /* called before submitting a msg from SMTP */
337 * NetprocFunctionHook extensions are used for hooks which implement handlers
338 * for incoming network messages.
340 struct NetprocFunctionHook {
341 struct NetprocFunctionHook *next;
342 int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
344 extern struct NetprocFunctionHook *NetprocHookTable;
348 * DeleteFunctionHook extensions are used for hooks which get called when a
349 * message is about to be deleted.
351 struct DeleteFunctionHook {
352 struct DeleteFunctionHook *next;
353 void (*h_function_pointer) (char *target_room, long msgnum);
355 extern struct DeleteFunctionHook *DeleteHookTable;
359 * ExpressMessageFunctionHook extensions are used for hooks which implement
360 * the sending of an express message through various channels. Any function
361 * registered should return the number of recipients to whom the message was
362 * successfully transmitted.
364 struct XmsgFunctionHook {
365 struct XmsgFunctionHook *next;
366 int (*h_function_pointer) (char *, char *, char *);
369 extern struct XmsgFunctionHook *XmsgHookTable;
371 /* Priority levels for paging functions (lower is better) */
373 XMSG_PRI_LOCAL, /* Other users on -this- server */
374 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
375 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
382 * ServiceFunctionHook extensions are used for hooks which implement various
383 * non-Citadel services (on TCP protocols) directly in the Citadel server.
385 struct ServiceFunctionHook {
386 struct ServiceFunctionHook *next;
389 void (*h_greeting_function) (void) ;
390 void (*h_command_function) (void) ;
393 extern struct ServiceFunctionHook *ServiceHookTable;
397 /* Defines the relationship of a user to a particular room */
403 unsigned int v_flags;
408 #define V_FORGET 1 /* User has zapped this room */
409 #define V_LOCKOUT 2 /* User is locked out of this room */
410 #define V_ACCESS 4 /* Access is granted to this room */
413 /* Supplementary data for a message on disk
414 * (These are kept separately from the message itself because they are
415 * fields whose values may change at some point after the message is saved.)
418 long meta_msgnum; /* Message number in *local* message base */
419 int meta_refcount; /* Number of rooms which point to this msg */
420 char meta_content_type[64];
421 /* more stuff will be added to this record in the future */
426 /* Built-in debuggable stuff for checking for memory leaks */
427 #ifdef DEBUG_MEMORY_LEAKS
429 #define mallok(howbig) tracked_malloc(howbig, __FILE__, __LINE__)
430 #define phree(whichptr) tracked_free(whichptr)
431 #define reallok(whichptr,howbig) tracked_realloc(whichptr,howbig)
432 #define strdoop(orig) tracked_strdup(orig, __FILE__, __LINE__)
434 void *tracked_malloc(size_t, char *, int);
435 void tracked_free(void *);
436 void *tracked_realloc(void *, size_t);
437 void dump_tracked(void);
438 char *tracked_strdup(const char *, char *, int);
441 struct TheHeap *next;
447 extern struct TheHeap *heap;
451 #define mallok(howbig) malloc(howbig)
452 #define phree(whichptr) free(whichptr)
453 #define reallok(whichptr,howbig) realloc(whichptr,howbig)
454 #define strdoop(orig) strdup(orig)
461 * Serialization routines use this struct to return a pointer and a length
469 /* Preferred field order */
470 /* ********** Important fields */
471 /* *************** Semi-important fields */
472 /* * Message text (MUST be last) */
473 #define FORDER "IPTAFONHRDBCEGJKLQSVWXYZUM"
475 #endif /* SERVER_H */