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) */
59 int kill_me; /* Set to nonzero to flag for termination */
61 char curr_user[USERNAME_SIZE]; /* name of current user */
62 int logged_in; /* logged in */
63 int internal_pgm; /* authenticated as internal program */
64 char temp[32]; /* temp file name */
65 int nologin; /* not allowed to log in */
66 int is_local_socket; /* set to 1 if client is on unix domain sock */
68 char net_node[32]; /* Is the client another Citadel server? */
70 int cs_pid; /* session ID */
71 time_t cs_lastupdt; /* time of last update */
72 time_t lastcmd; /* time of last command executed */
73 time_t lastidle; /* For computing idle time */
74 char lastcmdname[5]; /* name of last command executed */
75 unsigned cs_flags; /* miscellaneous flags */
76 void (*h_command_function) (void) ; /* service command function */
77 int is_async; /* Nonzero if client accepts async msgs */
79 /* feeping creaturisms... */
80 int cs_clientdev; /* client developer ID */
81 int cs_clienttyp; /* client type code */
82 int cs_clientver; /* client version number */
83 char cs_clientname[32]; /* name of client software */
84 char cs_host[26]; /* host logged in from */
86 /* Beginning of cryptography - session nonce */
87 char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */
89 FILE *download_fp; /* Fields relating to file transfer */
93 char upl_comment[SIZ];
94 char upl_filedir[SIZ];
98 /* Redirect this session's output to somewhere else? */
102 /* A linked list of all express messages sent to us. */
103 struct ExpressMessage *FirstExpressMessage;
104 int disable_exp; /* Set to 1 to disable incoming pages */
107 char fake_username[USERNAME_SIZE]; /* Fake username <bc> */
108 char fake_postname[USERNAME_SIZE]; /* Fake postname <bc> */
109 char fake_hostname[25]; /* Fake hostname <bc> */
110 char fake_roomname[ROOMNAMELEN]; /* Fake roomname <bc> */
112 /* Dynamically allocated session data */
113 struct CtdlSessData *FirstSessData;
116 typedef struct CitContext t_context;
118 /* Values for CitContext.state */
120 CON_IDLE, /* This context is doing nothing */
121 CON_EXECUTING /* This context is bound to a thread */
125 #define CS_STEALTH 1 /* stealth mode */
126 #define CS_CHAT 2 /* chat mode */
127 #define CS_POSTING 4 /* Posting */
129 struct CitContext *MyContext(void);
130 #define CC ((struct CitContext *)MyContext())
132 extern struct CitContext *ContextList;
133 extern int ScheduledShutdown;
134 extern struct CitControl CitControl;
137 struct ExpressMessage {
138 struct ExpressMessage *next;
139 time_t timestamp; /* When this message was sent */
140 unsigned flags; /* Special instructions */
141 char sender[64]; /* Name of sending user */
142 char *text; /* Message text (if applicable) */
145 #define EM_BROADCAST 1 /* Broadcast message */
146 #define EM_GO_AWAY 2 /* Server requests client log off */
147 #define EM_CHAT 4 /* Server requests client enter chat */
150 struct ChatLine *next;
154 char chat_username[USERNAME_SIZE];
155 char chat_room[ROOMNAMELEN];
159 * Various things we need to lock and unlock
187 * message transfer formats
190 MT_CITADEL, /* Citadel proprietary */
191 MT_RFC822, /* RFC822 */
192 MT_MIME, /* MIME-formatted message */
193 MT_DOWNLOAD /* Download a component */
197 * Message format types in the database
199 #define FMT_CITADEL 0 /* Citadel vari-format (proprietary) */
200 #define FMT_FIXED 1 /* Fixed format (proprietary) */
201 #define FMT_RFC822 4 /* Standard (headers are in M field) */
205 * Citadel DataBases (define one for each cdb we need to open)
208 CDB_MSGMAIN, /* message base */
209 CDB_USERSUPP, /* user file */
210 CDB_QUICKROOM, /* room index */
211 CDB_FLOORTAB, /* floor index */
212 CDB_MSGLISTS, /* room message lists */
213 CDB_VISIT, /* user/room relationships */
214 MAXCDB /* total number of CDB's defined */
224 /* Structures and declarations for function hooks of various types */
226 struct LogFunctionHook {
227 struct LogFunctionHook *next;
229 void (*h_function_pointer) (char *);
231 extern struct LogFunctionHook *LogHookTable;
233 struct CleanupFunctionHook {
234 struct CleanupFunctionHook *next;
235 void (*h_function_pointer) (void);
237 extern struct CleanupFunctionHook *CleanupHookTable;
243 * SessionFunctionHook extensions are used for any type of hook for which
244 * the context in which it's being called (which is determined by the event
245 * type) will make it obvious for the hook function to know where to look for
248 struct SessionFunctionHook {
249 struct SessionFunctionHook *next;
250 void (*h_function_pointer) (void);
253 extern struct SessionFunctionHook *SessionHookTable;
256 * Event types can't be enum'ed, because they must remain consistent between
257 * builds (to allow for binary modules built somewhere else)
259 #define EVT_STOP 0 /* Session is terminating */
260 #define EVT_START 1 /* Session is starting */
261 #define EVT_LOGIN 2 /* A user is logging in */
262 #define EVT_NEWROOM 3 /* Changing rooms */
263 #define EVT_LOGOUT 4 /* A user is logging out */
264 #define EVT_SETPASS 5 /* Setting or changing password */
265 #define EVT_CMD 6 /* Called after each server command */
266 #define EVT_RWHO 7 /* An RWHO command is being executed */
268 #define EVT_TIMER 50 /* Timer events are called once per minute
269 and are not tied to any session */
272 * UserFunctionHook extensions are used for any type of hook which implements
273 * an operation on a user or username (potentially) other than the one
274 * operating the current session.
276 struct UserFunctionHook {
277 struct UserFunctionHook *next;
278 void (*h_function_pointer) (char *username, long usernum);
281 extern struct UserFunctionHook *UserHookTable;
283 #define EVT_PURGEUSER 100 /* Deleting a user */
284 #define EVT_OUTPUTMSG 101 /* Outputting a message */
287 * MessageFunctionHook extensions are used for hooks which implement handlers
288 * for various types of message operations (save, read, etc.)
290 struct MessageFunctionHook {
291 struct MessageFunctionHook *next;
292 int (*h_function_pointer) (struct CtdlMessage *msg);
295 extern struct MessageFunctionHook *MessageHookTable;
297 #define EVT_BEFOREREAD 200
298 #define EVT_BEFORESAVE 201
299 #define EVT_AFTERSAVE 202
303 * ExpressMessageFunctionHook extensions are used for hooks which implement
304 * the sending of an express message through various channels. Any function
305 * registered should return the number of recipients to whom the message was
306 * successfully transmitted.
308 struct XmsgFunctionHook {
309 struct XmsgFunctionHook *next;
310 int (*h_function_pointer) (char *, char *, char *);
313 extern struct XmsgFunctionHook *XmsgHookTable;
315 /* Priority levels for paging functions (lower is better) */
317 XMSG_PRI_LOCAL, /* Other users on -this- server */
318 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
319 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
326 * ServiceFunctionHook extensions are used for hooks which implement various
327 * non-Citadel services (on TCP protocols) directly in the Citadel server.
329 struct ServiceFunctionHook {
330 struct ServiceFunctionHook *next;
333 void (*h_greeting_function) (void) ;
334 void (*h_command_function) (void) ;
337 extern struct ServiceFunctionHook *ServiceHookTable;
341 /* Defines the relationship of a user to a particular room */
347 unsigned int v_flags;
351 #define V_FORGET 1 /* User has zapped this room */
352 #define V_LOCKOUT 2 /* User is locked out of this room */
353 #define V_ACCESS 4 /* Access is granted to this room */
356 #define UA_GOTOALLOWED 4
357 #define UA_HASNEWMSGS 8
361 /* Supplementary data for a message on disk
362 * (These are kept separately from the message itself because they are
363 * fields whose values may change at some point after the message is saved.)
366 long smi_msgnum; /* Message number in *local* message base */
367 int smi_refcount; /* Number of rooms which point to this msg */
368 char smi_content_type[64];
369 char smi_mod; /* Moderated to what level? */
370 /* more stuff will be added to this record in the future */
375 /* Built-in debuggable stuff for checking for memory leaks */
376 #ifdef DEBUG_MEMORY_LEAKS
378 #define mallok(howbig) tracked_malloc(howbig, __FILE__, __LINE__)
379 #define phree(whichptr) tracked_free(whichptr)
380 #define reallok(whichptr,howbig) tracked_realloc(whichptr,howbig)
381 #define strdoop(orig) tracked_strdup(orig, __FILE__, __LINE__)
383 void *tracked_malloc(size_t, char *, int);
384 void tracked_free(void *);
385 void *tracked_realloc(void *, size_t);
386 void dump_tracked(void);
387 char *tracked_strdup(const char *, char *, int);
390 struct TheHeap *next;
396 extern struct TheHeap *heap;
400 #define mallok(howbig) malloc(howbig)
401 #define phree(whichptr) free(whichptr)
402 #define reallok(whichptr,howbig) realloc(whichptr,howbig)
403 #define strdoop(orig) strdup(orig)
410 * Serialization routines use this struct to return a pointer and a length
418 /* Preferred field order */
419 /* ********** Important fields */
420 /* *************** Semi-important fields */
421 /* * Message text (MUST be last) */
422 #define FORDER "IPTAFONHRDBCEGJKLQSUVWXYZM"