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