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         int is_local_socket;    /* set to 1 if client is on unix domain sock */
  67
  68         char net_node[32];      /* Is the client another Citadel server? */
  69         int client_socket;
  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
  78         /* feeping creaturisms... */
  79         int cs_clientdev;       /* client developer ID */
  80         int cs_clienttyp;       /* client type code */
  81         int cs_clientver;       /* client version number */
  82         char cs_clientname[32]; /* name of client software */
  83         char cs_host[26];       /* host logged in from */
  84
  85         FILE *download_fp;      /* Fields relating to file transfer */
  86         FILE *upload_fp;
  87         char upl_file[256];
  88         char upl_path[256];
  89         char upl_comment[256];
  90         char upl_filedir[256];
  91         char dl_is_net;
  92         char upload_type;
  93
  94         /* Redirect this session's output to somewhere else? */
  95         FILE *redirect_fp;
  96         int redirect_sock;
  97
  98         /* A linked list of all express messages sent to us. */
  99         struct ExpressMessage *FirstExpressMessage;
 100         int disable_exp;        /* Set to 1 to disable incoming pages */
 101
 102         /* Masquerade... */
 103         char fake_username[32]; /* Fake username <bc>                */
 104         char fake_postname[32]; /* Fake postname <bc>                */
 105         char fake_hostname[25]; /* Name of the fake hostname <bc>    */
 106         char fake_roomname[ROOMNAMELEN];        /* Name of the fake room <bc> */
 107
 108         /* Dynamically allocated session data */
 109         struct CtdlSessData *FirstSessData;
 110 };
 111
 112 typedef struct CitContext t_context;
 113
 114 /* Values for CitContext.state */
 115 enum {
 116         CON_IDLE,               /* This context is doing nothing */
 117         CON_EXECUTING           /* This context is bound to a thread */
 118 };
 119
 120
 121 #define CS_STEALTH      1       /* stealth mode */
 122 #define CS_CHAT         2       /* chat mode */
 123 #define CS_POSTING      4       /* Posting */
 124
 125 struct CitContext *MyContext(void);
 126 #define CC ((struct CitContext *)MyContext())
 127
 128 extern struct CitContext *ContextList;
 129 extern int ScheduledShutdown;
 130 extern struct CitControl CitControl;
 131
 132
 133 struct ExpressMessage {
 134         struct ExpressMessage *next;
 135         time_t timestamp;       /* When this message was sent */
 136         unsigned flags;         /* Special instructions */
 137         char sender[64];        /* Name of sending user */
 138         char *text;             /* Message text (if applicable) */
 139 };
 140
 141 #define EM_BROADCAST    1       /* Broadcast message */
 142 #define EM_GO_AWAY      2       /* Server requests client log off */
 143 #define EM_CHAT         4       /* Server requests client enter chat */
 144
 145 struct ChatLine {
 146         struct ChatLine *next;
 147         int chat_seq;
 148         time_t chat_time;
 149         char chat_text[256];
 150         char chat_username[32];
 151         char chat_room[ROOMNAMELEN];
 152 };
 153
 154 /*
 155  * Various things we need to lock and unlock
 156  */
 157 enum {
 158         S_USERSUPP,
 159         S_USER_TRANS,
 160         S_QUICKROOM,
 161         S_MSGMAIN,
 162         S_CALLLOG,
 163         S_SESSION_TABLE,
 164         S_FLOORTAB,
 165         S_CHATQUEUE,
 166         S_CONTROL,
 167         S_HOUSEKEEPING,
 168         S_DATABASE,
 169         S_NETDB,
 170         S_SUPPMSGMAIN,
 171         S_I_WANNA_SELECT,
 172         S_CONFIG,
 173         MAX_SEMAPHORES
 174 };
 175
 176
 177 /*
 178  * Upload types
 179  */
 180 #define UPL_FILE        0
 181 #define UPL_NET         1
 182 #define UPL_IMAGE       2
 183
 184
 185 /*
 186  * message transfer formats
 187  */
 188 enum {
 189         MT_CITADEL,             /* Citadel proprietary */
 190         MT_RFC822,              /* RFC822 */
 191         MT_MIME,                /* MIME-formatted message */
 192         MT_DOWNLOAD             /* Download a component */
 193 };
 194
 195 /*
 196  * Message format types in the database
 197  */
 198 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 199 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 200 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 201
 202
 203 /*
 204  * Citadel DataBases (define one for each cdb we need to open)
 205  */
 206 enum {
 207         CDB_MSGMAIN,            /* message base                  */
 208         CDB_USERSUPP,           /* user file                     */
 209         CDB_QUICKROOM,          /* room index                    */
 210         CDB_FLOORTAB,           /* floor index                   */
 211         CDB_MSGLISTS,           /* room message lists            */
 212         CDB_VISIT,              /* user/room relationships       */
 213         MAXCDB                  /* total number of CDB's defined */
 214 };
 215
 216 struct cdbdata {
 217         size_t len;
 218         char *ptr;
 219 };
 220
 221
 222
 223 /* Structures and declarations for function hooks of various types */
 224
 225 struct LogFunctionHook {
 226         struct LogFunctionHook *next;
 227         int loglevel;
 228         void (*h_function_pointer) (char *);
 229 };
 230 extern struct LogFunctionHook *LogHookTable;
 231
 232 struct CleanupFunctionHook {
 233         struct CleanupFunctionHook *next;
 234         void (*h_function_pointer) (void);
 235 };
 236 extern struct CleanupFunctionHook *CleanupHookTable;
 237
 238
 239
 240
 241 /*
 242  * SessionFunctionHook extensions are used for any type of hook for which
 243  * the context in which it's being called (which is determined by the event
 244  * type) will make it obvious for the hook function to know where to look for
 245  * pertinent data.
 246  */
 247 struct SessionFunctionHook {
 248         struct SessionFunctionHook *next;
 249         void (*h_function_pointer) (void);
 250         int eventtype;
 251 };
 252 extern struct SessionFunctionHook *SessionHookTable;
 253
 254 /*
 255  * Event types can't be enum'ed, because they must remain consistent between
 256  * builds (to allow for binary modules built somewhere else)
 257  */
 258 #define EVT_STOP        0       /* Session is terminating */
 259 #define EVT_START       1       /* Session is starting */
 260 #define EVT_LOGIN       2       /* A user is logging in */
 261 #define EVT_NEWROOM     3       /* Changing rooms */
 262 #define EVT_LOGOUT      4       /* A user is logging out */
 263 #define EVT_SETPASS     5       /* Setting or changing password */
 264 #define EVT_CMD         6       /* Called after each server command */
 265 #define EVT_RWHO        7       /* An RWHO command is being executed */
 266
 267
 268 #define EVT_TIMER       50      /* Timer events are called once per minute
 269                                    and are not tied to any session */
 270
 271 /*
 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.
 275  */
 276 struct UserFunctionHook {
 277         struct UserFunctionHook *next;
 278         void (*h_function_pointer) (char *username, long usernum);
 279         int eventtype;
 280 };
 281 extern struct UserFunctionHook *UserHookTable;
 282
 283 #define EVT_PURGEUSER   100     /* Deleting a user */
 284 #define EVT_OUTPUTMSG   101     /* Outputting a message */
 285
 286
 287 /*
 288  * MessageFunctionHook extensions are used for hooks which implement handlers
 289  * for various types of message operations (save, read, etc.)
 290  */
 291 struct MessageFunctionHook {
 292         struct MessageFunctionHook *next;
 293         int (*h_function_pointer) (struct CtdlMessage *msg);
 294         int eventtype;
 295 };
 296 extern struct MessageFunctionHook *MessageHookTable;
 297
 298 #define EVT_BEFOREREAD  200
 299 #define EVT_BEFORESAVE  201
 300 #define EVT_AFTERSAVE   202
 301
 302
 303 /*
 304  * ExpressMessageFunctionHook extensions are used for hooks which implement
 305  * the sending of an express message through various channels.  Any function
 306  * registered should return the number of recipients to whom the message was
 307  * successfully transmitted.
 308  */
 309 struct XmsgFunctionHook {
 310         struct XmsgFunctionHook *next;
 311         int (*h_function_pointer) (char *, char *, char *);
 312         int order;
 313 };
 314 extern struct XmsgFunctionHook *XmsgHookTable;
 315
 316 /* Priority levels for paging functions (lower is better) */
 317 enum {
 318         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 319         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 320         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 321         MAX_XMSG_PRI
 322 };
 323
 324
 325
 326 /*
 327  * ServiceFunctionHook extensions are used for hooks which implement various
 328  * non-Citadel services (on TCP protocols) directly in the Citadel server.
 329  */
 330 struct ServiceFunctionHook {
 331         struct ServiceFunctionHook *next;
 332         int tcp_port;
 333         char *sockpath;
 334         void (*h_greeting_function) (void) ;
 335         void (*h_command_function) (void) ;
 336         int msock;
 337 };
 338 extern struct ServiceFunctionHook *ServiceHookTable;
 339
 340
 341
 342 /* Defines the relationship of a user to a particular room */
 343 struct visit {
 344         long v_roomnum;
 345         long v_roomgen;
 346         long v_usernum;
 347         long v_lastseen;
 348         unsigned int v_flags;
 349 };
 350
 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   */
 354
 355 #define UA_KNOWN                2
 356 #define UA_GOTOALLOWED          4
 357 #define UA_HASNEWMSGS           8
 358 #define UA_ZAPPED               16
 359
 360
 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.)
 364  */
 365 struct SuppMsgInfo {
 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 */
 371 };
 372
 373
 374
 375 /* Built-in debuggable stuff for checking for memory leaks */
 376 #ifdef DEBUG_MEMORY_LEAKS
 377
 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__)
 382
 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);
 388
 389 struct TheHeap {
 390         struct TheHeap *next;
 391         char h_file[32];
 392         int h_line;
 393         void *h_ptr;
 394 };
 395
 396 extern struct TheHeap *heap;
 397
 398 #else
 399
 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)
 404
 405
 406 #endif
 407
 408
 409 /*
 410  * Serialization routines use this struct to return a pointer and a length
 411  */
 412 struct ser_ret {
 413         size_t len;
 414         char *ser;
 415 };
 416
 417
 418 /* Preferred field order */
 419 /*               **********                     Important fields */
 420 /*                         ***************      Semi-important fields */
 421 /*                                        *     Message text (MUST be last) */
 422 #define FORDER  "IPTAFONHRDBCEGJKLQSUVWXYZM"