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         int kill_me;            /* Set to nonzero to flag for termination */
  60
  61         char curr_user[32];     /* 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
  67         char net_node[32];      /* Is the client another Citadel server? */
  68         int client_socket;
  69         int cs_pid;             /* session ID */
  70         time_t cs_lastupdt;     /* time of last update */
  71         time_t lastcmd;         /* time of last command executed */
  72         time_t lastidle;        /* For computing idle time */
  73         char lastcmdname[5];    /* name of last command executed */
  74         unsigned cs_flags;      /* miscellaneous flags */
  75         void (*h_command_function) (void) ;     /* service command function */
  76
  77         /* feeping creaturisms... */
  78         int cs_clientdev;       /* client developer ID */
  79         int cs_clienttyp;       /* client type code */
  80         int cs_clientver;       /* client version number */
  81         char cs_clientname[32]; /* name of client software */
  82         char cs_host[26];       /* host logged in from */
  83
  84         FILE *download_fp;      /* Fields relating to file transfer */
  85         FILE *upload_fp;
  86         char upl_file[256];
  87         char upl_path[256];
  88         char upl_comment[256];
  89         char upl_filedir[256];
  90         char chat_room[20];     /* The chat room */
  91         char dl_is_net;
  92         char upload_type;
  93
  94         struct ExpressMessage *FirstExpressMessage;
  95
  96         char fake_username[32]; /* Fake username <bc>                */
  97         char fake_postname[32]; /* Fake postname <bc>                */
  98         char fake_hostname[25]; /* Name of the fake hostname <bc>    */
  99         char fake_roomname[ROOMNAMELEN];        /* Name of the fake room <bc> */
 100
 101         struct CtdlSessData *FirstSessData;     /* Allocated session data */
 102 };
 103
 104 typedef struct CitContext t_context;
 105
 106 /* Values for CitContext.state */
 107 enum {
 108         CON_IDLE,               /* This context is doing nothing */
 109         CON_EXECUTING           /* This context is bound to a thread */
 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         S_CONFIG,
 165         MAX_SEMAPHORES
 166 };
 167
 168
 169 /*
 170  * Upload types
 171  */
 172 #define UPL_FILE        0
 173 #define UPL_NET         1
 174 #define UPL_IMAGE       2
 175
 176
 177 /*
 178  * message transfer formats
 179  */
 180 enum {
 181         MT_CITADEL,             /* Citadel proprietary */
 182         MT_RFC822,              /* RFC822 */
 183         MT_MIME,                /* MIME-formatted message */
 184         MT_DOWNLOAD             /* Download a component */
 185 };
 186
 187 /*
 188  * Message format types in the database
 189  */
 190 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 191 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 192 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 193
 194
 195 /*
 196  * Citadel DataBases (define one for each cdb we need to open)
 197  */
 198 enum {
 199         CDB_MSGMAIN,            /* message base                  */
 200         CDB_USERSUPP,           /* user file                     */
 201         CDB_QUICKROOM,          /* room index                    */
 202         CDB_FLOORTAB,           /* floor index                   */
 203         CDB_MSGLISTS,           /* room message lists            */
 204         CDB_VISIT,              /* user/room relationships       */
 205         MAXCDB                  /* total number of CDB's defined */
 206 };
 207
 208 struct cdbdata {
 209         size_t len;
 210         char *ptr;
 211 };
 212
 213
 214
 215 /* Structures and declarations for function hooks of various types */
 216
 217 struct LogFunctionHook {
 218         struct LogFunctionHook *next;
 219         int loglevel;
 220         void (*h_function_pointer) (char *);
 221 };
 222 extern struct LogFunctionHook *LogHookTable;
 223
 224 struct CleanupFunctionHook {
 225         struct CleanupFunctionHook *next;
 226         void (*h_function_pointer) (void);
 227 };
 228 extern struct CleanupFunctionHook *CleanupHookTable;
 229
 230
 231
 232
 233 /*
 234  * SessionFunctionHook extensions are used for any type of hook for which
 235  * the context in which it's being called (which is determined by the event
 236  * type) will make it obvious for the hook function to know where to look for
 237  * pertinent data.
 238  */
 239 struct SessionFunctionHook {
 240         struct SessionFunctionHook *next;
 241         void (*h_function_pointer) (void);
 242         int eventtype;
 243 };
 244 extern struct SessionFunctionHook *SessionHookTable;
 245
 246 /*
 247  * Event types can't be enum'ed, because they must remain consistent between
 248  * builds (to allow for binary modules built somewhere else)
 249  */
 250 #define EVT_STOP        0       /* Session is terminating */
 251 #define EVT_START       1       /* Session is starting */
 252 #define EVT_LOGIN       2       /* A user is logging in */
 253 #define EVT_NEWROOM     3       /* Changing rooms */
 254 #define EVT_LOGOUT      4       /* A user is logging out */
 255 #define EVT_SETPASS     5       /* Setting or changing password */
 256 #define EVT_CMD         6       /* Called after each server command */
 257 #define EVT_RWHO        7       /* An RWHO command is being executed */
 258
 259
 260
 261
 262
 263 /*
 264  * UserFunctionHook extensions are used for any type of hook which implements
 265  * an operation on a user or username (potentially) other than the one
 266  * operating the current session.
 267  */
 268 struct UserFunctionHook {
 269         struct UserFunctionHook *next;
 270         void (*h_function_pointer) (char *username, long usernum);
 271         int eventtype;
 272 };
 273 extern struct UserFunctionHook *UserHookTable;
 274
 275 #define EVT_PURGEUSER   100     /* Deleting a user */
 276 #define EVT_OUTPUTMSG   101     /* Outputting a message */
 277
 278
 279 /*
 280  * MessageFunctionHook extensions are used for hooks which implement handlers
 281  * for various types of message operations (save, read, etc.)
 282  */
 283 struct MessageFunctionHook {
 284         struct MessageFunctionHook *next;
 285         int (*h_function_pointer) (struct CtdlMessage *msg);
 286         int eventtype;
 287 };
 288 extern struct MessageFunctionHook *MessageHookTable;
 289
 290 #define EVT_BEFOREREAD  200
 291 #define EVT_BEFORESAVE  201
 292 #define EVT_AFTERSAVE   202
 293
 294
 295 /*
 296  * ExpressMessageFunctionHook extensions are used for hooks which implement
 297  * the sending of an express message through various channels.  Any function
 298  * registered should return the number of recipients to whom the message was
 299  * successfully transmitted.
 300  */
 301 struct XmsgFunctionHook {
 302         struct XmsgFunctionHook *next;
 303         int (*h_function_pointer) (char *, char *, char *);
 304         int order;
 305 };
 306 extern struct XmsgFunctionHook *XmsgHookTable;
 307
 308 /* Priority levels for paging functions (lower is better) */
 309 enum {
 310         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 311         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 312         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 313         MAX_XMSG_PRI
 314 };
 315
 316
 317
 318 /*
 319  * ServiceFunctionHook extensions are used for hooks which implement various
 320  * non-Citadel services (on TCP protocols) directly in the Citadel server.
 321  */
 322 struct ServiceFunctionHook {
 323         struct ServiceFunctionHook *next;
 324         int tcp_port;
 325         void (*h_greeting_function) (void) ;
 326         void (*h_command_function) (void) ;
 327         int msock;
 328 };
 329 extern struct ServiceFunctionHook *ServiceHookTable;
 330
 331
 332
 333 /* Defines the relationship of a user to a particular room */
 334 struct visit {
 335         long v_roomnum;
 336         long v_roomgen;
 337         long v_usernum;
 338         long v_lastseen;
 339         unsigned int v_flags;
 340 };
 341
 342 #define V_FORGET        1       /* User has zapped this room        */
 343 #define V_LOCKOUT       2       /* User is locked out of this room  */
 344 #define V_ACCESS        4       /* Access is granted to this room   */
 345
 346 #define UA_KNOWN                2
 347 #define UA_GOTOALLOWED          4
 348 #define UA_HASNEWMSGS           8
 349 #define UA_ZAPPED               16
 350
 351
 352 /* Supplementary data for a message on disk
 353  * (These are kept separately from the message itself because they are
 354  * fields whose values may change at some point after the message is saved.)
 355  */
 356 struct SuppMsgInfo {
 357         long smi_msgnum;        /* Message number in *local* message base */
 358         int smi_refcount;       /* Number of rooms which point to this msg */
 359         char smi_content_type[64];
 360         /* more stuff will be added to this record in the future */
 361 };
 362
 363
 364
 365 /* Built-in debuggable stuff for checking for memory leaks */
 366 #ifdef DEBUG_MEMORY_LEAKS
 367
 368 #define mallok(howbig)          tracked_malloc(howbig, __FILE__, __LINE__)
 369 #define phree(whichptr)                 tracked_free(whichptr)
 370 #define reallok(whichptr,howbig)        tracked_realloc(whichptr,howbig)
 371 #define strdoop(orig)           tracked_strdup(orig, __FILE__, __LINE__)
 372
 373 void *tracked_malloc(size_t, char *, int);
 374 void tracked_free(void *);
 375 void *tracked_realloc(void *, size_t);
 376 void dump_tracked(void);
 377 char *tracked_strdup(const char *, char *, int);
 378
 379 struct TheHeap {
 380         struct TheHeap *next;
 381         char h_file[32];
 382         int h_line;
 383         void *h_ptr;
 384 };
 385
 386 extern struct TheHeap *heap;
 387
 388 #else
 389
 390 #define mallok(howbig)                  malloc(howbig)
 391 #define phree(whichptr)                 free(whichptr)
 392 #define reallok(whichptr,howbig)        realloc(whichptr,howbig)
 393 #define strdoop(orig)                   strdup(orig)
 394
 395
 396 #endif
 397
 398
 399 /*
 400  * Serialization routines use this struct to return a pointer and a length
 401  */
 402 struct ser_ret {
 403         size_t len;
 404         char *ser;
 405 };
 406
 407
 408 /* Preferred field order */
 409 /*               *********                      Important fields */
 410 /*                        ****************      Semi-important fields */
 411 /*                                        *     Message text (MUST be last) */
 412 #define FORDER  "IPTAONHRDBCEFGJKLQSUVWXYZM"