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
24 #define DLEXP __declspec(dllexport)
26 #define DLEXP __declspec(dllimport)
32 #endif /* __CYGWIN__ */
36 #include <openssl/ssl.h>
39 #define CTDLMESSAGE_MAGIC 0x159d
41 int cm_magic; /* Self-check */
42 char cm_anon_type; /* Anonymous or author-visible */
43 char cm_format_type; /* Format type */
44 char *cm_fields[256]; /* Data fields */
45 unsigned int cm_flags; /* How to handle (NOT SAVED TO DISK) */
48 #define CM_SKIP_HOOKS 0x01 /* Don't run server-side handlers */
52 * Generic per-session variable or data structure storage
55 struct CtdlSessData *next;
61 * Static user data symbol types
64 SYM_DESIRED_SECTION, /* Used by the MIME parser */
65 SYM_MA_INFO, /* Handles multipart/alternative */
66 SYM_REPL, /* Used for replication checking */
72 * Here's the big one... the Citadel context structure.
74 * This structure keeps track of all information relating to a running
75 * session on the server. We keep one of these for each session thread.
77 * Note that the first element is "*next" so that it may be used without
78 * modification in a linked list.
81 struct CitContext *next; /* Link to next session in the list */
83 struct usersupp usersupp; /* Database record buffers */
84 struct quickroom quickroom;
86 int state; /* thread state (see CON_ values below) */
87 int kill_me; /* Set to nonzero to flag for termination */
89 char curr_user[USERNAME_SIZE]; /* name of current user */
90 int logged_in; /* logged in */
91 int internal_pgm; /* authenticated as internal program */
92 char temp[32]; /* temp file name */
93 int nologin; /* not allowed to log in */
94 int is_local_socket; /* set to 1 if client is on unix domain sock */
96 char net_node[32]; /* Is the client another Citadel server? */
98 int cs_pid; /* session ID */
99 time_t cs_lastupdt; /* time of last update */
100 time_t lastcmd; /* time of last command executed */
101 time_t lastidle; /* For computing idle time */
102 char lastcmdname[5]; /* name of last command executed */
103 unsigned cs_flags; /* miscellaneous flags */
104 void (*h_command_function) (void) ; /* service command function */
105 int is_async; /* Nonzero if client accepts async msgs */
107 /* feeping creaturisms... */
108 int cs_clientdev; /* client developer ID */
109 int cs_clienttyp; /* client type code */
110 int cs_clientver; /* client version number */
111 char cs_clientname[32]; /* name of client software */
112 char cs_host[64]; /* host logged in from */
114 /* The Internet type of thing */
115 char *cs_inet_email; /* Return address of outbound Internet mail */
117 FILE *download_fp; /* Fields relating to file transfer */
121 char upl_comment[SIZ];
122 char upl_filedir[SIZ];
126 /* Beginning of cryptography - session nonce */
127 char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */
129 /* Redirect this session's output to somewhere else? */
137 /* A linked list of all express messages sent to us. */
138 struct ExpressMessage *FirstExpressMessage;
139 int disable_exp; /* Set to 1 to disable incoming pages */
140 int newmail; /* Other sessions increment this */
143 char fake_username[USERNAME_SIZE]; /* Fake username <bc> */
144 char fake_postname[USERNAME_SIZE]; /* Fake postname <bc> */
145 char fake_hostname[64]; /* Fake hostname <bc> */
146 char fake_roomname[ROOMNAMELEN]; /* Fake roomname <bc> */
148 struct CtdlMessage *cached_msg;
150 char preferred_formats[SIZ]; /* Preferred MIME formats */
152 /* Dynamically allocated session data */
153 struct CtdlSessData *FirstSessData;
156 typedef struct CitContext t_context;
158 /* Values for CitContext.state */
160 CON_IDLE, /* This context is doing nothing */
161 CON_EXECUTING /* This context is bound to a thread */
165 #define CS_STEALTH 1 /* stealth mode */
166 #define CS_CHAT 2 /* chat mode */
167 #define CS_POSTING 4 /* Posting */
169 struct CitContext *MyContext(void);
170 #define CC ((struct CitContext *)MyContext())
172 extern DLEXP struct CitContext *ContextList;
173 extern DLEXP int ScheduledShutdown;
174 extern DLEXP struct CitControl CitControl;
177 struct ExpressMessage {
178 struct ExpressMessage *next;
179 time_t timestamp; /* When this message was sent */
180 unsigned flags; /* Special instructions */
181 char sender[64]; /* Name of sending user */
182 char *text; /* Message text (if applicable) */
185 #define EM_BROADCAST 1 /* Broadcast message */
186 #define EM_GO_AWAY 2 /* Server requests client log off */
187 #define EM_CHAT 4 /* Server requests client enter chat */
190 struct ChatLine *next;
194 char chat_username[USERNAME_SIZE];
195 char chat_room[ROOMNAMELEN];
199 * Various things we need to lock and unlock
230 * message transfer formats
233 MT_CITADEL, /* Citadel proprietary */
234 MT_RFC822, /* RFC822 */
235 MT_MIME, /* MIME-formatted message */
236 MT_DOWNLOAD /* Download a component */
240 * Message format types in the database
242 #define FMT_CITADEL 0 /* Citadel vari-format (proprietary) */
243 #define FMT_FIXED 1 /* Fixed format (proprietary) */
244 #define FMT_RFC822 4 /* Standard (headers are in M field) */
248 * Citadel DataBases (define one for each cdb we need to open)
251 CDB_MSGMAIN, /* message base */
252 CDB_USERSUPP, /* user file */
253 CDB_QUICKROOM, /* room index */
254 CDB_FLOORTAB, /* floor index */
255 CDB_MSGLISTS, /* room message lists */
256 CDB_VISIT, /* user/room relationships */
257 CDB_DIRECTORY, /* address book directory */
258 CDB_USETABLE, /* network use table */
259 MAXCDB /* total number of CDB's defined */
269 /* Structures and declarations for function hooks of various types */
271 struct LogFunctionHook {
272 struct LogFunctionHook *next;
274 void (*h_function_pointer) (char *);
276 extern DLEXP struct LogFunctionHook *LogHookTable;
278 struct CleanupFunctionHook {
279 struct CleanupFunctionHook *next;
280 void (*h_function_pointer) (void);
282 extern DLEXP struct CleanupFunctionHook *CleanupHookTable;
288 * SessionFunctionHook extensions are used for any type of hook for which
289 * the context in which it's being called (which is determined by the event
290 * type) will make it obvious for the hook function to know where to look for
293 struct SessionFunctionHook {
294 struct SessionFunctionHook *next;
295 void (*h_function_pointer) (void);
298 extern DLEXP struct SessionFunctionHook *SessionHookTable;
301 * Event types can't be enum'ed, because they must remain consistent between
302 * builds (to allow for binary modules built somewhere else)
304 #define EVT_STOP 0 /* Session is terminating */
305 #define EVT_START 1 /* Session is starting */
306 #define EVT_LOGIN 2 /* A user is logging in */
307 #define EVT_NEWROOM 3 /* Changing rooms */
308 #define EVT_LOGOUT 4 /* A user is logging out */
309 #define EVT_SETPASS 5 /* Setting or changing password */
310 #define EVT_CMD 6 /* Called after each server command */
311 #define EVT_RWHO 7 /* An RWHO command is being executed */
313 #define EVT_TIMER 50 /* Timer events are called once per minute
314 and are not tied to any session */
317 * UserFunctionHook extensions are used for any type of hook which implements
318 * an operation on a user or username (potentially) other than the one
319 * operating the current session.
321 struct UserFunctionHook {
322 struct UserFunctionHook *next;
323 void (*h_function_pointer) (char *username, long usernum);
326 extern DLEXP struct UserFunctionHook *UserHookTable;
328 #define EVT_PURGEUSER 100 /* Deleting a user */
329 #define EVT_OUTPUTMSG 101 /* Outputting a message */
332 * MessageFunctionHook extensions are used for hooks which implement handlers
333 * for various types of message operations (save, read, etc.)
335 struct MessageFunctionHook {
336 struct MessageFunctionHook *next;
337 int (*h_function_pointer) (struct CtdlMessage *msg);
340 extern DLEXP struct MessageFunctionHook *MessageHookTable;
342 #define EVT_BEFOREREAD 200
343 #define EVT_BEFORESAVE 201
344 #define EVT_AFTERSAVE 202
345 #define EVT_SMTPSCAN 203 /* called before submitting a msg from SMTP */
350 * NetprocFunctionHook extensions are used for hooks which implement handlers
351 * for incoming network messages.
353 struct NetprocFunctionHook {
354 struct NetprocFunctionHook *next;
355 int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
357 extern DLEXP struct NetprocFunctionHook *NetprocHookTable;
361 * DeleteFunctionHook extensions are used for hooks which get called when a
362 * message is about to be deleted.
364 struct DeleteFunctionHook {
365 struct DeleteFunctionHook *next;
366 void (*h_function_pointer) (char *target_room, long msgnum);
368 extern DLEXP struct DeleteFunctionHook *DeleteHookTable;
372 * ExpressMessageFunctionHook extensions are used for hooks which implement
373 * the sending of an express message through various channels. Any function
374 * registered should return the number of recipients to whom the message was
375 * successfully transmitted.
377 struct XmsgFunctionHook {
378 struct XmsgFunctionHook *next;
379 int (*h_function_pointer) (char *, char *, char *);
382 extern DLEXP struct XmsgFunctionHook *XmsgHookTable;
384 /* Priority levels for paging functions (lower is better) */
386 XMSG_PRI_LOCAL, /* Other users on -this- server */
387 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
388 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
395 * ServiceFunctionHook extensions are used for hooks which implement various
396 * non-Citadel services (on TCP protocols) directly in the Citadel server.
398 struct ServiceFunctionHook {
399 struct ServiceFunctionHook *next;
402 void (*h_greeting_function) (void) ;
403 void (*h_command_function) (void) ;
406 extern DLEXP struct ServiceFunctionHook *ServiceHookTable;
410 /* Defines the relationship of a user to a particular room */
416 unsigned int v_flags;
421 #define V_FORGET 1 /* User has zapped this room */
422 #define V_LOCKOUT 2 /* User is locked out of this room */
423 #define V_ACCESS 4 /* Access is granted to this room */
426 #define UA_GOTOALLOWED 4
427 #define UA_HASNEWMSGS 8
431 /* Supplementary data for a message on disk
432 * (These are kept separately from the message itself because they are
433 * fields whose values may change at some point after the message is saved.)
436 long meta_msgnum; /* Message number in *local* message base */
437 int meta_refcount; /* Number of rooms which point to this msg */
438 char meta_content_type[64];
439 /* more stuff will be added to this record in the future */
444 /* Built-in debuggable stuff for checking for memory leaks */
445 #ifdef DEBUG_MEMORY_LEAKS
447 #define mallok(howbig) tracked_malloc(howbig, __FILE__, __LINE__)
448 #define phree(whichptr) tracked_free(whichptr)
449 #define reallok(whichptr,howbig) tracked_realloc(whichptr,howbig)
450 #define strdoop(orig) tracked_strdup(orig, __FILE__, __LINE__)
452 void *tracked_malloc(size_t, char *, int);
453 void tracked_free(void *);
454 void *tracked_realloc(void *, size_t);
455 void dump_tracked(void);
456 char *tracked_strdup(const char *, char *, int);
459 struct TheHeap *next;
465 extern DLEXP struct TheHeap *heap;
469 #define mallok(howbig) malloc(howbig)
470 #define phree(whichptr) free(whichptr)
471 #define reallok(whichptr,howbig) realloc(whichptr,howbig)
472 #define strdoop(orig) strdup(orig)
479 * Serialization routines use this struct to return a pointer and a length
487 /* Preferred field order */
488 /* ********** Important fields */
489 /* *************** Semi-important fields */
490 /* * Message text (MUST be last) */
491 #define FORDER "IPTAFONHRDBCEGJKLQSUVWXYZM"
493 #endif /* SERVER_H */