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         int FloorBeingSearched; /* This is used by cmd_lrms() etc.   */
 102
 103         struct CtdlSessData *FirstSessData;     /* Allocated session data */
 104         char buffer1[256];              /* General-purpose workspace */
 105         char buffer2[256];              /* General-purpose workspace */
 106 };
 107
 108 typedef struct CitContext t_context;
 109
 110 /* Values for CitContext.state */
 111 enum {
 112         CON_IDLE,               /* This context is doing nothing */
 113         CON_EXECUTING           /* This context is bound to a thread */
 114 };
 115
 116
 117 #define CS_STEALTH      1       /* stealth mode */
 118 #define CS_CHAT         2       /* chat mode */
 119 #define CS_POSTING      4       /* Posting */
 120
 121 struct CitContext *MyContext(void);
 122 #define CC ((struct CitContext *)MyContext())
 123
 124 extern struct CitContext *ContextList;
 125 extern int ScheduledShutdown;
 126 extern struct CitControl CitControl;
 127
 128
 129 struct ExpressMessage {
 130         struct ExpressMessage *next;
 131         time_t timestamp;       /* When this message was sent */
 132         unsigned flags;         /* Special instructions */
 133         char sender[64];        /* Name of sending user */
 134         char *text;             /* Message text (if applicable) */
 135 };
 136
 137 #define EM_BROADCAST    1       /* Broadcast message */
 138 #define EM_GO_AWAY      2       /* Server requests client log off */
 139 #define EM_CHAT         4       /* Server requests client enter chat */
 140
 141 struct ChatLine {
 142         struct ChatLine *next;
 143         int chat_seq;
 144         time_t chat_time;
 145         char chat_text[256];
 146         char chat_room[20];
 147         char chat_username[32];
 148 };
 149
 150 /*
 151  * Various things we need to lock and unlock
 152  */
 153 enum {
 154         S_USERSUPP,
 155         S_USER_TRANS,
 156         S_QUICKROOM,
 157         S_MSGMAIN,
 158         S_CALLLOG,
 159         S_SESSION_TABLE,
 160         S_FLOORTAB,
 161         S_CHATQUEUE,
 162         S_CONTROL,
 163         S_HOUSEKEEPING,
 164         S_DATABASE,
 165         S_NETDB,
 166         S_SUPPMSGMAIN,
 167         S_I_WANNA_SELECT,
 168         S_CONFIG,
 169         MAX_SEMAPHORES
 170 };
 171
 172
 173 /*
 174  * Upload types
 175  */
 176 #define UPL_FILE        0
 177 #define UPL_NET         1
 178 #define UPL_IMAGE       2
 179
 180
 181 /*
 182  * message transfer formats
 183  */
 184 enum {
 185         MT_CITADEL,             /* Citadel proprietary */
 186         MT_RFC822,              /* RFC822 */
 187         MT_MIME,                /* MIME-formatted message */
 188         MT_DOWNLOAD             /* Download a component */
 189 };
 190
 191 /*
 192  * Message format types in the database
 193  */
 194 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 195 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 196 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 197
 198
 199 /*
 200  * Citadel DataBases (define one for each cdb we need to open)
 201  */
 202 enum {
 203         CDB_MSGMAIN,            /* message base                  */
 204         CDB_USERSUPP,           /* user file                     */
 205         CDB_QUICKROOM,          /* room index                    */
 206         CDB_FLOORTAB,           /* floor index                   */
 207         CDB_MSGLISTS,           /* room message lists            */
 208         CDB_VISIT,              /* user/room relationships       */
 209         MAXCDB                  /* total number of CDB's defined */
 210 };
 211
 212 struct cdbdata {
 213         size_t len;
 214         char *ptr;
 215 };
 216
 217
 218
 219 /* Structures and declarations for function hooks of various types */
 220
 221 struct LogFunctionHook {
 222         struct LogFunctionHook *next;
 223         int loglevel;
 224         void (*h_function_pointer) (char *);
 225 };
 226 extern struct LogFunctionHook *LogHookTable;
 227
 228 struct CleanupFunctionHook {
 229         struct CleanupFunctionHook *next;
 230         void (*h_function_pointer) (void);
 231 };
 232 extern struct CleanupFunctionHook *CleanupHookTable;
 233
 234
 235
 236
 237 /*
 238  * SessionFunctionHook extensions are used for any type of hook for which
 239  * the context in which it's being called (which is determined by the event
 240  * type) will make it obvious for the hook function to know where to look for
 241  * pertinent data.
 242  */
 243 struct SessionFunctionHook {
 244         struct SessionFunctionHook *next;
 245         void (*h_function_pointer) (void);
 246         int eventtype;
 247 };
 248 extern struct SessionFunctionHook *SessionHookTable;
 249
 250 /*
 251  * Event types can't be enum'ed, because they must remain consistent between
 252  * builds (to allow for binary modules built somewhere else)
 253  */
 254 #define EVT_STOP        0       /* Session is terminating */
 255 #define EVT_START       1       /* Session is starting */
 256 #define EVT_LOGIN       2       /* A user is logging in */
 257 #define EVT_NEWROOM     3       /* Changing rooms */
 258 #define EVT_LOGOUT      4       /* A user is logging out */
 259 #define EVT_SETPASS     5       /* Setting or changing password */
 260 #define EVT_CMD         6       /* Called after each server command */
 261 #define EVT_RWHO        7       /* An RWHO command is being executed */
 262
 263
 264
 265
 266
 267 /*
 268  * UserFunctionHook extensions are used for any type of hook which implements
 269  * an operation on a user or username (potentially) other than the one
 270  * operating the current session.
 271  */
 272 struct UserFunctionHook {
 273         struct UserFunctionHook *next;
 274         void (*h_function_pointer) (char *username, long usernum);
 275         int eventtype;
 276 };
 277 extern struct UserFunctionHook *UserHookTable;
 278
 279 #define EVT_PURGEUSER   100     /* Deleting a user */
 280 #define EVT_OUTPUTMSG   101     /* Outputting a message */
 281
 282
 283 /*
 284  * MessageFunctionHook extensions are used for hooks which implement handlers
 285  * for various types of message operations (save, read, etc.)
 286  */
 287 struct MessageFunctionHook {
 288         struct MessageFunctionHook *next;
 289         int (*h_function_pointer) (struct CtdlMessage *msg);
 290         int eventtype;
 291 };
 292 extern struct MessageFunctionHook *MessageHookTable;
 293
 294 #define EVT_BEFOREREAD  200
 295 #define EVT_BEFORESAVE  201
 296 #define EVT_AFTERSAVE   202
 297
 298
 299 /*
 300  * ExpressMessageFunctionHook extensions are used for hooks which implement
 301  * the sending of an express message through various channels.  Any function
 302  * registered should return the number of recipients to whom the message was
 303  * successfully transmitted.
 304  */
 305 struct XmsgFunctionHook {
 306         struct XmsgFunctionHook *next;
 307         int (*h_function_pointer) (char *, char *, char *);
 308         int order;
 309 };
 310 extern struct XmsgFunctionHook *XmsgHookTable;
 311
 312 /* Priority levels for paging functions (lower is better) */
 313 enum {
 314         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 315         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 316         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 317         MAX_XMSG_PRI
 318 };
 319
 320
 321
 322 /*
 323  * ServiceFunctionHook extensions are used for hooks which implement various
 324  * non-Citadel services (on TCP protocols) directly in the Citadel server.
 325  */
 326 struct ServiceFunctionHook {
 327         struct ServiceFunctionHook *next;
 328         int tcp_port;
 329         void (*h_greeting_function) (void) ;
 330         void (*h_command_function) (void) ;
 331         int msock;
 332 };
 333 extern struct ServiceFunctionHook *ServiceHookTable;
 334
 335
 336
 337 /* Defines the relationship of a user to a particular room */
 338 struct visit {
 339         long v_roomnum;
 340         long v_roomgen;
 341         long v_usernum;
 342         long v_lastseen;
 343         unsigned int v_flags;
 344 };
 345
 346 #define V_FORGET        1       /* User has zapped this room        */
 347 #define V_LOCKOUT       2       /* User is locked out of this room  */
 348 #define V_ACCESS        4       /* Access is granted to this room   */
 349
 350 #define UA_KNOWN                2
 351 #define UA_GOTOALLOWED          4
 352 #define UA_HASNEWMSGS           8
 353 #define UA_ZAPPED               16
 354
 355
 356 /* Supplementary data for a message on disk
 357  * (These are kept separately from the message itself because they are
 358  * fields whose values may change at some point after the message is saved.)
 359  */
 360 struct SuppMsgInfo {
 361         long smi_msgnum;        /* Message number in *local* message base */
 362         int smi_refcount;       /* Number of rooms which point to this msg */
 363         char smi_content_type[64];
 364         /* more stuff will be added to this record in the future */
 365 };
 366
 367
 368
 369 /* Built-in debuggable stuff for checking for memory leaks */
 370 #ifdef DEBUG_MEMORY_LEAKS
 371
 372 #define mallok(howbig)          tracked_malloc(howbig, __FILE__, __LINE__)
 373 #define phree(whichptr)                 tracked_free(whichptr)
 374 #define reallok(whichptr,howbig)        tracked_realloc(whichptr,howbig)
 375 #define strdoop(orig)           tracked_strdup(orig, __FILE__, __LINE__)
 376
 377 void *tracked_malloc(size_t, char *, int);
 378 void tracked_free(void *);
 379 void *tracked_realloc(void *, size_t);
 380 void dump_tracked(void);
 381 char *tracked_strdup(const char *, char *, int);
 382
 383 struct TheHeap {
 384         struct TheHeap *next;
 385         char h_file[32];
 386         int h_line;
 387         void *h_ptr;
 388 };
 389
 390 extern struct TheHeap *heap;
 391
 392 #else
 393
 394 #define mallok(howbig)                  malloc(howbig)
 395 #define phree(whichptr)                 free(whichptr)
 396 #define reallok(whichptr,howbig)        realloc(whichptr,howbig)
 397 #define strdoop(orig)                   strdup(orig)
 398
 399
 400 #endif
 401
 402
 403 /*
 404  * Serialization routines use this struct to return a pointer and a length
 405  */
 406 struct ser_ret {
 407         size_t len;
 408         char *ser;
 409 };
 410
 411
 412 /* Preferred field order */
 413 /*               *********                      Important fields */
 414 /*                        ****************      Semi-important fields */
 415 /*                                        *     Message text (MUST be last) */
 416 #define FORDER  "IPTAONHRDBCEFGJKLQSUVWXYZM"