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
11 #define CTDLMESSAGE_MAGIC 0x159d
13 int cm_magic; /* Self-check */
14 char cm_anon_type; /* Anonymous or author-visible */
15 char cm_format_type; /* Format type */
16 char *cm_fields[256]; /* Data fields */
17 unsigned int cm_flags; /* How to handle (NOT SAVED TO DISK) */
20 #define CM_SKIP_HOOKS 0x01 /* Don't run server-side handlers */
24 * Generic per-session variable or data structure storage
27 struct CtdlSessData *next;
33 * Static user data symbol types
36 SYM_DESIRED_SECTION, /* Used by the MIME parser */
37 SYM_MA_INFO, /* Handles multipart/alternative */
38 SYM_REPL, /* Used for replication checking */
44 * Here's the big one... the Citadel context structure.
46 * This structure keeps track of all information relating to a running
47 * session on the server. We keep one of these for each session thread.
49 * Note that the first element is "*next" so that it may be used without
50 * modification in a linked list.
53 struct CitContext *next; /* Link to next session in the list */
55 struct usersupp usersupp; /* Database record buffers */
56 struct quickroom quickroom;
58 int state; /* thread state (see CON_ values below) */
60 char curr_user[32]; /* name of current user */
61 int logged_in; /* logged in */
62 int internal_pgm; /* authenticated as internal program */
63 char temp[32]; /* temp file name */
64 int nologin; /* not allowed to log in */
68 int cs_pid; /* session ID */
69 time_t cs_lastupdt; /* time of last update */
70 time_t lastcmd; /* time of last command executed */
71 time_t lastidle; /* For computing idle time */
72 char lastcmdname[5]; /* name of last command executed */
73 unsigned cs_flags; /* miscellaneous flags */
75 /* feeping creaturisms... */
76 int cs_clientdev; /* client developer ID */
77 int cs_clienttyp; /* client type code */
78 int cs_clientver; /* client version number */
79 char cs_clientname[32]; /* name of client software */
80 char cs_host[26]; /* host logged in from */
82 FILE *download_fp; /* Fields relating to file transfer */
86 char upl_comment[256];
87 char upl_filedir[256];
88 char chat_room[20]; /* The chat room */
92 struct ExpressMessage *FirstExpressMessage;
94 char fake_username[32]; /* Fake username <bc> */
95 char fake_postname[32]; /* Fake postname <bc> */
96 char fake_hostname[25]; /* Name of the fake hostname <bc> */
97 char fake_roomname[ROOMNAMELEN]; /* Name of the fake room <bc> */
99 int FloorBeingSearched; /* This is used by cmd_lrms() etc. */
100 struct CtdlSessData *FirstSessData;
103 typedef struct CitContext t_context;
105 /* Values for CitContext.state */
107 CON_IDLE, /* This context is doing nothing */
108 CON_EXECUTING, /* This context is bound to a thread */
109 CON_DYING /* This context is being terminated */
113 #define CS_STEALTH 1 /* stealth mode */
114 #define CS_CHAT 2 /* chat mode */
115 #define CS_POSTING 4 /* Posting */
117 struct CitContext *MyContext(void);
118 #define CC ((struct CitContext *)MyContext())
120 extern struct CitContext *ContextList;
121 extern int ScheduledShutdown;
122 extern struct CitControl CitControl;
125 struct ExpressMessage {
126 struct ExpressMessage *next;
127 time_t timestamp; /* When this message was sent */
128 unsigned flags; /* Special instructions */
129 char sender[64]; /* Name of sending user */
130 char *text; /* Message text (if applicable) */
133 #define EM_BROADCAST 1 /* Broadcast message */
134 #define EM_GO_AWAY 2 /* Server requests client log off */
135 #define EM_CHAT 4 /* Server requests client enter chat */
138 struct ChatLine *next;
143 char chat_username[32];
147 * Various things we need to lock and unlock
177 * message transfer formats
180 MT_CITADEL, /* Citadel proprietary */
181 MT_RFC822, /* RFC822 */
182 MT_MIME, /* MIME-formatted message */
183 MT_DOWNLOAD /* Download a component */
188 * Citadel DataBases (define one for each cdb we need to open)
191 CDB_MSGMAIN, /* message base */
192 CDB_USERSUPP, /* user file */
193 CDB_QUICKROOM, /* room index */
194 CDB_FLOORTAB, /* floor index */
195 CDB_MSGLISTS, /* room message lists */
196 CDB_VISIT, /* user/room relationships */
197 MAXCDB /* total number of CDB's defined */
207 /* Structures and declarations for function hooks of various types */
209 struct LogFunctionHook {
210 struct LogFunctionHook *next;
212 void (*h_function_pointer) (char *);
214 extern struct LogFunctionHook *LogHookTable;
216 struct CleanupFunctionHook {
217 struct CleanupFunctionHook *next;
218 void (*h_function_pointer) (void);
220 extern struct CleanupFunctionHook *CleanupHookTable;
226 * SessionFunctionHook extensions are used for any type of hook for which
227 * the context in which it's being called (which is determined by the event
228 * type) will make it obvious for the hook function to know where to look for
231 struct SessionFunctionHook {
232 struct SessionFunctionHook *next;
233 void (*h_function_pointer) (void);
236 extern struct SessionFunctionHook *SessionHookTable;
239 * Event types can't be enum'ed, because they must remain consistent between
240 * builds (to allow for binary modules built somewhere else)
242 #define EVT_STOP 0 /* Session is terminating */
243 #define EVT_START 1 /* Session is starting */
244 #define EVT_LOGIN 2 /* A user is logging in */
245 #define EVT_NEWROOM 3 /* Changing rooms */
246 #define EVT_LOGOUT 4 /* A user is logging out */
247 #define EVT_SETPASS 5 /* Setting or changing password */
248 #define EVT_CMD 6 /* Called after each server command */
249 #define EVT_RWHO 7 /* An RWHO command is being executed */
256 * UserFunctionHook extensions are used for any type of hook which implements
257 * an operation on a user or username (potentially) other than the one
258 * operating the current session.
260 struct UserFunctionHook {
261 struct UserFunctionHook *next;
262 void (*h_function_pointer) (char *username, long usernum);
265 extern struct UserFunctionHook *UserHookTable;
267 #define EVT_PURGEUSER 100 /* Deleting a user */
268 #define EVT_OUTPUTMSG 101 /* Outputting a message */
272 * MessageFunctionHook extensions are used for hooks which implement handlers
273 * for various types of message operations (save, read, etc.)
275 struct MessageFunctionHook {
276 struct MessageFunctionHook *next;
277 int (*h_function_pointer) (struct CtdlMessage *msg);
280 extern struct MessageFunctionHook *MessageHookTable;
282 #define EVT_BEFOREREAD 200
283 #define EVT_BEFORESAVE 201
284 #define EVT_AFTERSAVE 202
288 * ExpressMessageFunctionHook extensions are used for hooks which implement
289 * the sending of an express message through various channels. Any function
290 * registered should return the number of recipients to whom the message was
291 * successfully transmitted.
293 struct XmsgFunctionHook {
294 struct XmsgFunctionHook *next;
295 int (*h_function_pointer) (char *, char *, char *);
298 extern struct XmsgFunctionHook *XmsgHookTable;
300 /* Priority levels for paging functions (lower is better) */
302 XMSG_PRI_LOCAL, /* Other users on -this- server */
303 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
304 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
312 /* Defines the relationship of a user to a particular room */
318 unsigned int v_flags;
321 #define V_FORGET 1 /* User has zapped this room */
322 #define V_LOCKOUT 2 /* User is locked out of this room */
323 #define V_ACCESS 4 /* Access is granted to this room */
326 #define UA_GOTOALLOWED 4
327 #define UA_HASNEWMSGS 8
331 /* Supplementary data for a message on disk
332 * (These are kept separately from the message itself because they are
333 * fields whose values may change at some point after the message is saved.)
336 long smi_msgnum; /* Message number in *local* message base */
337 int smi_refcount; /* Number of rooms which point to this msg */
338 char smi_content_type[64];
339 /* more stuff will be added to this record in the future */
344 /* Built-in debuggable stuff for checking for memory leaks */
345 #ifdef DEBUG_MEMORY_LEAKS
347 #define mallok(howbig) tracked_malloc(howbig, __FILE__, __LINE__)
348 #define phree(whichptr) tracked_free(whichptr)
349 #define reallok(whichptr,howbig) tracked_realloc(whichptr,howbig)
350 #define strdoop(orig) tracked_strdup(orig, __FILE__, __LINE__)
352 void *tracked_malloc(size_t, char *, int);
353 void tracked_free(void *);
354 void *tracked_realloc(void *, size_t);
355 void dump_tracked(void);
356 char *tracked_strdup(const char *, char *, int);
359 struct TheHeap *next;
365 extern struct TheHeap *heap;
369 #define mallok(howbig) malloc(howbig)
370 #define phree(whichptr) free(whichptr)
371 #define reallok(whichptr,howbig) realloc(whichptr,howbig)
372 #define strdoop(orig) strdup(orig)
379 * Serialization routines use this struct to return a pointer and a length
387 /* Preferred field order */
388 /* ********* Important fields */
389 /* **************** Semi-important fields */
390 /* * Message text (MUST be last) */
391 #define FORDER "IPTAONHRDBCEFGJKLQSUVWXYZM"