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