citadel/server.h

   1 /* $Id$ */
   2
   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!
   5  */
   6 #define DEBUG_MEMORY_LEAKS
   7
   8 /*
   9  * New format for a message in memory
  10  */
  11 #define CTDLMESSAGE_MAGIC               0x159d
  12 struct CtdlMessage {
  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) */
  18 };
  19
  20 #define CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
  21
  22
  23 /*
  24  * Generic per-session variable or data structure storage
  25  */
  26 struct CtdlSessData {
  27         struct CtdlSessData *next;
  28         unsigned long sym_id;
  29         void *sym_data;
  30 };
  31
  32 /*
  33  * Static user data symbol types
  34  */
  35 enum {
  36         SYM_DESIRED_SECTION,            /* Used by the MIME parser */
  37         SYM_MA_INFO,                    /* Handles multipart/alternative */
  38         SYM_REPL,                       /* Used for replication checking */
  39         SYM_MAX
  40 };
  41
  42
  43 /*
  44  * Here's the big one... the Citadel context structure.
  45  *
  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.
  48  *
  49  * Note that the first element is "*next" so that it may be used without
  50  * modification in a linked list.
  51  */
  52 struct CitContext {
  53         struct CitContext *next;        /* Link to next session in the list */
  54
  55         struct usersupp usersupp;       /* Database record buffers */
  56         struct quickroom quickroom;
  57
  58         int state;              /* thread state (see CON_ values below) */
  59
  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 */
  65
  66         char net_node[32];
  67         int client_socket;
  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 */
  74
  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 */
  81
  82         FILE *download_fp;      /* Fields relating to file transfer */
  83         FILE *upload_fp;
  84         char upl_file[256];
  85         char upl_path[256];
  86         char upl_comment[256];
  87         char upl_filedir[256];
  88         char chat_room[20];     /* The chat room */
  89         char dl_is_net;
  90         char upload_type;
  91
  92         struct ExpressMessage *FirstExpressMessage;
  93
  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> */
  98
  99         int FloorBeingSearched; /* This is used by cmd_lrms() etc.   */
 100         struct CtdlSessData *FirstSessData;
 101 };
 102
 103 typedef struct CitContext t_context;
 104
 105 /* Values for CitContext.state */
 106 enum {
 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 */
 110 };
 111
 112
 113 #define CS_STEALTH      1       /* stealth mode */
 114 #define CS_CHAT         2       /* chat mode */
 115 #define CS_POSTING      4       /* Posting */
 116
 117 struct CitContext *MyContext(void);
 118 #define CC ((struct CitContext *)MyContext())
 119
 120 extern struct CitContext *ContextList;
 121 extern int ScheduledShutdown;
 122 extern struct CitControl CitControl;
 123
 124
 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) */
 131 };
 132
 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 */
 136
 137 struct ChatLine {
 138         struct ChatLine *next;
 139         int chat_seq;
 140         time_t chat_time;
 141         char chat_text[256];
 142         char chat_room[20];
 143         char chat_username[32];
 144 };
 145
 146 /*
 147  * Various things we need to lock and unlock
 148  */
 149 enum {
 150         S_USERSUPP,
 151         S_USER_TRANS,
 152         S_QUICKROOM,
 153         S_MSGMAIN,
 154         S_CALLLOG,
 155         S_SESSION_TABLE,
 156         S_FLOORTAB,
 157         S_CHATQUEUE,
 158         S_CONTROL,
 159         S_HOUSEKEEPING,
 160         S_DATABASE,
 161         S_NETDB,
 162         S_SUPPMSGMAIN,
 163         S_I_WANNA_SELECT,
 164         MAX_SEMAPHORES
 165 };
 166
 167
 168 /*
 169  * Upload types
 170  */
 171 #define UPL_FILE        0
 172 #define UPL_NET         1
 173 #define UPL_IMAGE       2
 174
 175
 176 /*
 177  * message transfer formats
 178  */
 179 enum {
 180         MT_CITADEL,             /* Citadel proprietary */
 181         MT_RFC822,              /* RFC822 */
 182         MT_MIME,                /* MIME-formatted message */
 183         MT_DOWNLOAD             /* Download a component */
 184 };
 185
 186
 187 /*
 188  * Citadel DataBases (define one for each cdb we need to open)
 189  */
 190 enum {
 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 */
 198 };
 199
 200 struct cdbdata {
 201         size_t len;
 202         char *ptr;
 203 };
 204
 205
 206
 207 /* Structures and declarations for function hooks of various types */
 208
 209 struct LogFunctionHook {
 210         struct LogFunctionHook *next;
 211         int loglevel;
 212         void (*h_function_pointer) (char *);
 213 };
 214 extern struct LogFunctionHook *LogHookTable;
 215
 216 struct CleanupFunctionHook {
 217         struct CleanupFunctionHook *next;
 218         void (*h_function_pointer) (void);
 219 };
 220 extern struct CleanupFunctionHook *CleanupHookTable;
 221
 222
 223
 224
 225 /*
 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
 229  * pertinent data.
 230  */
 231 struct SessionFunctionHook {
 232         struct SessionFunctionHook *next;
 233         void (*h_function_pointer) (void);
 234         int eventtype;
 235 };
 236 extern struct SessionFunctionHook *SessionHookTable;
 237
 238 /*
 239  * Event types can't be enum'ed, because they must remain consistent between
 240  * builds (to allow for binary modules built somewhere else)
 241  */
 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 */
 250
 251
 252
 253
 254
 255 /*
 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.
 259  */
 260 struct UserFunctionHook {
 261         struct UserFunctionHook *next;
 262         void (*h_function_pointer) (char *username, long usernum);
 263         int eventtype;
 264 };
 265 extern struct UserFunctionHook *UserHookTable;
 266
 267 #define EVT_PURGEUSER   100     /* Deleting a user */
 268 #define EVT_OUTPUTMSG   101     /* Outputting a message */
 269
 270
 271 /*
 272  * MessageFunctionHook extensions are used for hooks which implement handlers
 273  * for various types of message operations (save, read, etc.)
 274  */
 275 struct MessageFunctionHook {
 276         struct MessageFunctionHook *next;
 277         int (*h_function_pointer) (struct CtdlMessage *msg);
 278         int eventtype;
 279 };
 280 extern struct MessageFunctionHook *MessageHookTable;
 281
 282 #define EVT_BEFOREREAD  200
 283 #define EVT_BEFORESAVE  201
 284 #define EVT_AFTERSAVE   202
 285
 286
 287 /*
 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.
 292  */
 293 struct XmsgFunctionHook {
 294         struct XmsgFunctionHook *next;
 295         int (*h_function_pointer) (char *, char *, char *);
 296         int order;
 297 };
 298 extern struct XmsgFunctionHook *XmsgHookTable;
 299
 300 /* Priority levels for paging functions (lower is better) */
 301 enum {
 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 */
 305         MAX_XMSG_PRI
 306 };
 307
 308
 309
 310
 311
 312 /* Defines the relationship of a user to a particular room */
 313 struct visit {
 314         long v_roomnum;
 315         long v_roomgen;
 316         long v_usernum;
 317         long v_lastseen;
 318         unsigned int v_flags;
 319 };
 320
 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   */
 324
 325 #define UA_KNOWN                2
 326 #define UA_GOTOALLOWED          4
 327 #define UA_HASNEWMSGS           8
 328 #define UA_ZAPPED               16
 329
 330
 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.)
 334  */
 335 struct SuppMsgInfo {
 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 */
 340 };
 341
 342
 343
 344 /* Built-in debuggable stuff for checking for memory leaks */
 345 #ifdef DEBUG_MEMORY_LEAKS
 346
 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__)
 351
 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);
 357
 358 struct TheHeap {
 359         struct TheHeap *next;
 360         char h_file[32];
 361         int h_line;
 362         void *h_ptr;
 363 };
 364
 365 extern struct TheHeap *heap;
 366
 367 #else
 368
 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)
 373
 374
 375 #endif
 376
 377
 378 /*
 379  * Serialization routines use this struct to return a pointer and a length
 380  */
 381 struct ser_ret {
 382         size_t len;
 383         char *ser;
 384 };
 385
 386
 387 /* Preferred field order */
 388 /*               *********                      Important fields */
 389 /*                        ****************      Semi-important fields */
 390 /*                                        *     Message text (MUST be last) */
 391 #define FORDER  "IPTAONHRDBCEFGJKLQSUVWXYZM"