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
18 #define DLEXP __declspec(dllexport)
20 #define DLEXP __declspec(dllimport)
26 #endif /* __CYGWIN__ */
30 #define CTDLMESSAGE_MAGIC 0x159d
32 int cm_magic; /* Self-check */
33 char cm_anon_type; /* Anonymous or author-visible */
34 char cm_format_type; /* Format type */
35 char *cm_fields[256]; /* Data fields */
36 unsigned int cm_flags; /* How to handle (NOT SAVED TO DISK) */
39 #define CM_SKIP_HOOKS 0x01 /* Don't run server-side handlers */
43 * Generic per-session variable or data structure storage
46 struct CtdlSessData *next;
52 * Static user data symbol types
55 SYM_DESIRED_SECTION, /* Used by the MIME parser */
56 SYM_MA_INFO, /* Handles multipart/alternative */
57 SYM_REPL, /* Used for replication checking */
63 * Here's the big one... the Citadel context structure.
65 * This structure keeps track of all information relating to a running
66 * session on the server. We keep one of these for each session thread.
68 * Note that the first element is "*next" so that it may be used without
69 * modification in a linked list.
72 struct CitContext *next; /* Link to next session in the list */
74 struct usersupp usersupp; /* Database record buffers */
75 struct quickroom quickroom;
77 int state; /* thread state (see CON_ values below) */
78 int kill_me; /* Set to nonzero to flag for termination */
80 char curr_user[USERNAME_SIZE]; /* name of current user */
81 int logged_in; /* logged in */
82 int internal_pgm; /* authenticated as internal program */
83 char temp[32]; /* temp file name */
84 int nologin; /* not allowed to log in */
85 int is_local_socket; /* set to 1 if client is on unix domain sock */
87 char net_node[32]; /* Is the client another Citadel server? */
89 int cs_pid; /* session ID */
90 time_t cs_lastupdt; /* time of last update */
91 time_t lastcmd; /* time of last command executed */
92 time_t lastidle; /* For computing idle time */
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 int is_async; /* Nonzero if client accepts async msgs */
98 /* feeping creaturisms... */
99 int cs_clientdev; /* client developer ID */
100 int cs_clienttyp; /* client type code */
101 int cs_clientver; /* client version number */
102 char cs_clientname[32]; /* name of client software */
103 char cs_host[26]; /* host logged in from */
105 /* Beginning of cryptography - session nonce */
106 char cs_nonce[NONCE_SIZE]; /* The nonce for this session's next auth transaction */
108 FILE *download_fp; /* Fields relating to file transfer */
112 char upl_comment[SIZ];
113 char upl_filedir[SIZ];
117 /* Redirect this session's output to somewhere else? */
121 /* A linked list of all express messages sent to us. */
122 struct ExpressMessage *FirstExpressMessage;
123 int disable_exp; /* Set to 1 to disable incoming pages */
126 char fake_username[USERNAME_SIZE]; /* Fake username <bc> */
127 char fake_postname[USERNAME_SIZE]; /* Fake postname <bc> */
128 char fake_hostname[25]; /* Fake hostname <bc> */
129 char fake_roomname[ROOMNAMELEN]; /* Fake roomname <bc> */
131 /* Dynamically allocated session data */
132 struct CtdlSessData *FirstSessData;
135 typedef struct CitContext t_context;
137 /* Values for CitContext.state */
139 CON_IDLE, /* This context is doing nothing */
140 CON_EXECUTING /* This context is bound to a thread */
144 #define CS_STEALTH 1 /* stealth mode */
145 #define CS_CHAT 2 /* chat mode */
146 #define CS_POSTING 4 /* Posting */
148 struct CitContext *MyContext(void);
149 #define CC ((struct CitContext *)MyContext())
151 extern DLEXP struct CitContext *ContextList;
152 extern DLEXP int ScheduledShutdown;
153 extern DLEXP struct CitControl CitControl;
156 struct ExpressMessage {
157 struct ExpressMessage *next;
158 time_t timestamp; /* When this message was sent */
159 unsigned flags; /* Special instructions */
160 char sender[64]; /* Name of sending user */
161 char *text; /* Message text (if applicable) */
164 #define EM_BROADCAST 1 /* Broadcast message */
165 #define EM_GO_AWAY 2 /* Server requests client log off */
166 #define EM_CHAT 4 /* Server requests client enter chat */
169 struct ChatLine *next;
173 char chat_username[USERNAME_SIZE];
174 char chat_room[ROOMNAMELEN];
178 * Various things we need to lock and unlock
208 * message transfer formats
211 MT_CITADEL, /* Citadel proprietary */
212 MT_RFC822, /* RFC822 */
213 MT_MIME, /* MIME-formatted message */
214 MT_DOWNLOAD /* Download a component */
218 * Message format types in the database
220 #define FMT_CITADEL 0 /* Citadel vari-format (proprietary) */
221 #define FMT_FIXED 1 /* Fixed format (proprietary) */
222 #define FMT_RFC822 4 /* Standard (headers are in M field) */
226 * Citadel DataBases (define one for each cdb we need to open)
229 CDB_MSGMAIN, /* message base */
230 CDB_USERSUPP, /* user file */
231 CDB_QUICKROOM, /* room index */
232 CDB_FLOORTAB, /* floor index */
233 CDB_MSGLISTS, /* room message lists */
234 CDB_VISIT, /* user/room relationships */
235 MAXCDB /* total number of CDB's defined */
245 /* Structures and declarations for function hooks of various types */
247 struct LogFunctionHook {
248 struct LogFunctionHook *next;
250 void (*h_function_pointer) (char *);
252 extern DLEXP struct LogFunctionHook *LogHookTable;
254 struct CleanupFunctionHook {
255 struct CleanupFunctionHook *next;
256 void (*h_function_pointer) (void);
258 extern DLEXP struct CleanupFunctionHook *CleanupHookTable;
264 * SessionFunctionHook extensions are used for any type of hook for which
265 * the context in which it's being called (which is determined by the event
266 * type) will make it obvious for the hook function to know where to look for
269 struct SessionFunctionHook {
270 struct SessionFunctionHook *next;
271 void (*h_function_pointer) (void);
274 extern DLEXP struct SessionFunctionHook *SessionHookTable;
277 * Event types can't be enum'ed, because they must remain consistent between
278 * builds (to allow for binary modules built somewhere else)
280 #define EVT_STOP 0 /* Session is terminating */
281 #define EVT_START 1 /* Session is starting */
282 #define EVT_LOGIN 2 /* A user is logging in */
283 #define EVT_NEWROOM 3 /* Changing rooms */
284 #define EVT_LOGOUT 4 /* A user is logging out */
285 #define EVT_SETPASS 5 /* Setting or changing password */
286 #define EVT_CMD 6 /* Called after each server command */
287 #define EVT_RWHO 7 /* An RWHO command is being executed */
289 #define EVT_TIMER 50 /* Timer events are called once per minute
290 and are not tied to any session */
293 * UserFunctionHook extensions are used for any type of hook which implements
294 * an operation on a user or username (potentially) other than the one
295 * operating the current session.
297 struct UserFunctionHook {
298 struct UserFunctionHook *next;
299 void (*h_function_pointer) (char *username, long usernum);
302 extern DLEXP struct UserFunctionHook *UserHookTable;
304 #define EVT_PURGEUSER 100 /* Deleting a user */
305 #define EVT_OUTPUTMSG 101 /* Outputting a message */
308 * MessageFunctionHook extensions are used for hooks which implement handlers
309 * for various types of message operations (save, read, etc.)
311 struct MessageFunctionHook {
312 struct MessageFunctionHook *next;
313 int (*h_function_pointer) (struct CtdlMessage *msg);
316 extern DLEXP struct MessageFunctionHook *MessageHookTable;
318 #define EVT_BEFOREREAD 200
319 #define EVT_BEFORESAVE 201
320 #define EVT_AFTERSAVE 202
324 * ExpressMessageFunctionHook extensions are used for hooks which implement
325 * the sending of an express message through various channels. Any function
326 * registered should return the number of recipients to whom the message was
327 * successfully transmitted.
329 struct XmsgFunctionHook {
330 struct XmsgFunctionHook *next;
331 int (*h_function_pointer) (char *, char *, char *);
334 extern DLEXP struct XmsgFunctionHook *XmsgHookTable;
336 /* Priority levels for paging functions (lower is better) */
338 XMSG_PRI_LOCAL, /* Other users on -this- server */
339 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
340 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
347 * ServiceFunctionHook extensions are used for hooks which implement various
348 * non-Citadel services (on TCP protocols) directly in the Citadel server.
350 struct ServiceFunctionHook {
351 struct ServiceFunctionHook *next;
354 void (*h_greeting_function) (void) ;
355 void (*h_command_function) (void) ;
358 extern DLEXP struct ServiceFunctionHook *ServiceHookTable;
362 /* Defines the relationship of a user to a particular room */
368 unsigned int v_flags;
372 #define V_FORGET 1 /* User has zapped this room */
373 #define V_LOCKOUT 2 /* User is locked out of this room */
374 #define V_ACCESS 4 /* Access is granted to this room */
377 #define UA_GOTOALLOWED 4
378 #define UA_HASNEWMSGS 8
382 /* Supplementary data for a message on disk
383 * (These are kept separately from the message itself because they are
384 * fields whose values may change at some point after the message is saved.)
387 long smi_msgnum; /* Message number in *local* message base */
388 int smi_refcount; /* Number of rooms which point to this msg */
389 char smi_content_type[64];
390 char smi_mod; /* Moderated to what level? */
391 /* more stuff will be added to this record in the future */
396 /* Built-in debuggable stuff for checking for memory leaks */
397 #ifdef DEBUG_MEMORY_LEAKS
399 #define mallok(howbig) tracked_malloc(howbig, __FILE__, __LINE__)
400 #define phree(whichptr) tracked_free(whichptr)
401 #define reallok(whichptr,howbig) tracked_realloc(whichptr,howbig)
402 #define strdoop(orig) tracked_strdup(orig, __FILE__, __LINE__)
404 void *tracked_malloc(size_t, char *, int);
405 void tracked_free(void *);
406 void *tracked_realloc(void *, size_t);
407 void dump_tracked(void);
408 char *tracked_strdup(const char *, char *, int);
411 struct TheHeap *next;
417 extern DLEXP struct TheHeap *heap;
421 #define mallok(howbig) malloc(howbig)
422 #define phree(whichptr) free(whichptr)
423 #define reallok(whichptr,howbig) realloc(whichptr,howbig)
424 #define strdoop(orig) strdup(orig)
431 * Serialization routines use this struct to return a pointer and a length
439 /* Preferred field order */
440 /* ********** Important fields */
441 /* *************** Semi-important fields */
442 /* * Message text (MUST be last) */
443 #define FORDER "IPTAFONHRDBCEGJKLQSUVWXYZM"
445 #endif /* SERVER_H */