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
  12 #ifndef SERVER_H
  13 #define SERVER_H
  14
  15 #ifdef __GNUC__
  16 #define INLINE inline
  17 #else
  18 #define INLINE
  19 #endif
  20
  21 #ifdef __CYGWIN__
  22
  23 #ifdef IN_LIBCIT
  24 #define DLEXP __declspec(dllexport)
  25 #else
  26 #define DLEXP __declspec(dllimport)
  27 #endif
  28
  29 #else
  30 #define DLEXP
  31
  32 #endif /* __CYGWIN__ */
  33
  34 #include "citadel.h"
  35 #ifdef HAVE_OPENSSL
  36 #include <openssl/ssl.h>
  37 #endif
  38
  39 #define CTDLMESSAGE_MAGIC               0x159d
  40 struct CtdlMessage {
  41         int cm_magic;                   /* Self-check */
  42         char cm_anon_type;              /* Anonymous or author-visible */
  43         char cm_format_type;            /* Format type */
  44         char *cm_fields[256];           /* Data fields */
  45         unsigned int cm_flags;          /* How to handle (NOT SAVED TO DISK) */
  46 };
  47
  48 #define CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
  49
  50
  51 /*
  52  * Generic per-session variable or data structure storage
  53  */
  54 struct CtdlSessData {
  55         struct CtdlSessData *next;
  56         unsigned long sym_id;
  57         void *sym_data;
  58 };
  59
  60 /*
  61  * Static user data symbol types
  62  */
  63 enum {
  64         SYM_DESIRED_SECTION,            /* Used by the MIME parser */
  65         SYM_MA_INFO,                    /* Handles multipart/alternative */
  66         SYM_REPL,                       /* Used for replication checking */
  67         SYM_MAX
  68 };
  69
  70
  71 /*
  72  * Here's the big one... the Citadel context structure.
  73  *
  74  * This structure keeps track of all information relating to a running
  75  * session on the server.  We keep one of these for each session thread.
  76  *
  77  * Note that the first element is "*next" so that it may be used without
  78  * modification in a linked list.
  79  */
  80 struct CitContext {
  81         struct CitContext *next;        /* Link to next session in the list */
  82
  83         struct usersupp usersupp;       /* Database record buffers */
  84         struct quickroom quickroom;
  85
  86         int state;              /* thread state (see CON_ values below) */
  87         int kill_me;            /* Set to nonzero to flag for termination */
  88
  89         char curr_user[USERNAME_SIZE];  /* name of current user */
  90         int logged_in;          /* logged in */
  91         int internal_pgm;       /* authenticated as internal program */
  92         char temp[32];          /* temp file name */
  93         int nologin;            /* not allowed to log in */
  94         int is_local_socket;    /* set to 1 if client is on unix domain sock */
  95
  96         char net_node[32];      /* Is the client another Citadel server? */
  97         int client_socket;
  98         int cs_pid;             /* session ID */
  99         time_t cs_lastupdt;     /* time of last update */
 100         time_t lastcmd;         /* time of last command executed */
 101         time_t lastidle;        /* For computing idle time */
 102         char lastcmdname[5];    /* name of last command executed */
 103         unsigned cs_flags;      /* miscellaneous flags */
 104         void (*h_command_function) (void) ;     /* service command function */
 105         int is_async;           /* Nonzero if client accepts async msgs */
 106
 107         /* feeping creaturisms... */
 108         int cs_clientdev;       /* client developer ID */
 109         int cs_clienttyp;       /* client type code */
 110         int cs_clientver;       /* client version number */
 111         char cs_clientname[32]; /* name of client software */
 112         char cs_host[64];       /* host logged in from */
 113
 114         /* Beginning of cryptography - session nonce */
 115         char cs_nonce[NONCE_SIZE];      /* The nonce for this session's next auth transaction */
 116
 117         FILE *download_fp;      /* Fields relating to file transfer */
 118         FILE *upload_fp;
 119         char upl_file[SIZ];
 120         char upl_path[SIZ];
 121         char upl_comment[SIZ];
 122         char upl_filedir[SIZ];
 123         char dl_is_net;
 124         char upload_type;
 125
 126         /* Redirect this session's output to somewhere else? */
 127         FILE *redirect_fp;
 128         int redirect_sock;
 129 #ifdef HAVE_OPENSSL
 130         SSL *ssl;
 131         int redirect_ssl;
 132 #endif
 133
 134         /* A linked list of all express messages sent to us. */
 135         struct ExpressMessage *FirstExpressMessage;
 136         int disable_exp;        /* Set to 1 to disable incoming pages */
 137
 138         /* Masquerade... */
 139         char fake_username[USERNAME_SIZE];      /* Fake username <bc> */
 140         char fake_postname[USERNAME_SIZE];      /* Fake postname <bc> */
 141         char fake_hostname[25];                 /* Fake hostname <bc> */
 142         char fake_roomname[ROOMNAMELEN];        /* Fake roomname <bc> */
 143
 144         /* Dynamically allocated session data */
 145         struct CtdlSessData *FirstSessData;
 146 };
 147
 148 typedef struct CitContext t_context;
 149
 150 /* Values for CitContext.state */
 151 enum {
 152         CON_IDLE,               /* This context is doing nothing */
 153         CON_EXECUTING           /* This context is bound to a thread */
 154 };
 155
 156
 157 #define CS_STEALTH      1       /* stealth mode */
 158 #define CS_CHAT         2       /* chat mode */
 159 #define CS_POSTING      4       /* Posting */
 160
 161 struct CitContext *MyContext(void);
 162 #define CC ((struct CitContext *)MyContext())
 163
 164 extern DLEXP struct CitContext *ContextList;
 165 extern DLEXP int ScheduledShutdown;
 166 extern DLEXP struct CitControl CitControl;
 167
 168
 169 struct ExpressMessage {
 170         struct ExpressMessage *next;
 171         time_t timestamp;       /* When this message was sent */
 172         unsigned flags;         /* Special instructions */
 173         char sender[64];        /* Name of sending user */
 174         char *text;             /* Message text (if applicable) */
 175 };
 176
 177 #define EM_BROADCAST    1       /* Broadcast message */
 178 #define EM_GO_AWAY      2       /* Server requests client log off */
 179 #define EM_CHAT         4       /* Server requests client enter chat */
 180
 181 struct ChatLine {
 182         struct ChatLine *next;
 183         int chat_seq;
 184         time_t chat_time;
 185         char chat_text[SIZ];
 186         char chat_username[USERNAME_SIZE];
 187         char chat_room[ROOMNAMELEN];
 188 };
 189
 190 /*
 191  * Various things we need to lock and unlock
 192  */
 193 enum {
 194         S_USERSUPP,
 195         S_QUICKROOM,
 196         S_SESSION_TABLE,
 197         S_FLOORTAB,
 198         S_CHATQUEUE,
 199         S_CONTROL,
 200         S_DATABASE,
 201         S_NETDB,
 202         S_SUPPMSGMAIN,
 203         S_I_WANNA_SELECT,
 204         S_CONFIG,
 205         S_WORKER_LIST,
 206         S_HOUSEKEEPING,
 207         S_NTTLIST,
 208         S_DIRECTORY,
 209         MAX_SEMAPHORES
 210 };
 211
 212
 213 /*
 214  * Upload types
 215  */
 216 #define UPL_FILE        0
 217 #define UPL_NET         1
 218 #define UPL_IMAGE       2
 219
 220
 221 /*
 222  * message transfer formats
 223  */
 224 enum {
 225         MT_CITADEL,             /* Citadel proprietary */
 226         MT_RFC822,              /* RFC822 */
 227         MT_MIME,                /* MIME-formatted message */
 228         MT_DOWNLOAD             /* Download a component */
 229 };
 230
 231 /*
 232  * Message format types in the database
 233  */
 234 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 235 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 236 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 237
 238
 239 /*
 240  * Citadel DataBases (define one for each cdb we need to open)
 241  */
 242 enum {
 243         CDB_MSGMAIN,            /* message base                  */
 244         CDB_USERSUPP,           /* user file                     */
 245         CDB_QUICKROOM,          /* room index                    */
 246         CDB_FLOORTAB,           /* floor index                   */
 247         CDB_MSGLISTS,           /* room message lists            */
 248         CDB_VISIT,              /* user/room relationships       */
 249         CDB_DIRECTORY,          /* address book directory        */
 250         MAXCDB                  /* total number of CDB's defined */
 251 };
 252
 253 struct cdbdata {
 254         size_t len;
 255         char *ptr;
 256 };
 257
 258
 259
 260 /* Structures and declarations for function hooks of various types */
 261
 262 struct LogFunctionHook {
 263         struct LogFunctionHook *next;
 264         int loglevel;
 265         void (*h_function_pointer) (char *);
 266 };
 267 extern DLEXP struct LogFunctionHook *LogHookTable;
 268
 269 struct CleanupFunctionHook {
 270         struct CleanupFunctionHook *next;
 271         void (*h_function_pointer) (void);
 272 };
 273 extern DLEXP struct CleanupFunctionHook *CleanupHookTable;
 274
 275
 276
 277
 278 /*
 279  * SessionFunctionHook extensions are used for any type of hook for which
 280  * the context in which it's being called (which is determined by the event
 281  * type) will make it obvious for the hook function to know where to look for
 282  * pertinent data.
 283  */
 284 struct SessionFunctionHook {
 285         struct SessionFunctionHook *next;
 286         void (*h_function_pointer) (void);
 287         int eventtype;
 288 };
 289 extern DLEXP struct SessionFunctionHook *SessionHookTable;
 290
 291 /*
 292  * Event types can't be enum'ed, because they must remain consistent between
 293  * builds (to allow for binary modules built somewhere else)
 294  */
 295 #define EVT_STOP        0       /* Session is terminating */
 296 #define EVT_START       1       /* Session is starting */
 297 #define EVT_LOGIN       2       /* A user is logging in */
 298 #define EVT_NEWROOM     3       /* Changing rooms */
 299 #define EVT_LOGOUT      4       /* A user is logging out */
 300 #define EVT_SETPASS     5       /* Setting or changing password */
 301 #define EVT_CMD         6       /* Called after each server command */
 302 #define EVT_RWHO        7       /* An RWHO command is being executed */
 303
 304 #define EVT_TIMER       50      /* Timer events are called once per minute
 305                                    and are not tied to any session */
 306
 307 /*
 308  * UserFunctionHook extensions are used for any type of hook which implements
 309  * an operation on a user or username (potentially) other than the one
 310  * operating the current session.
 311  */
 312 struct UserFunctionHook {
 313         struct UserFunctionHook *next;
 314         void (*h_function_pointer) (char *username, long usernum);
 315         int eventtype;
 316 };
 317 extern DLEXP struct UserFunctionHook *UserHookTable;
 318
 319 #define EVT_PURGEUSER   100     /* Deleting a user */
 320 #define EVT_OUTPUTMSG   101     /* Outputting a message */
 321
 322 /*
 323  * MessageFunctionHook extensions are used for hooks which implement handlers
 324  * for various types of message operations (save, read, etc.)
 325  */
 326 struct MessageFunctionHook {
 327         struct MessageFunctionHook *next;
 328         int (*h_function_pointer) (struct CtdlMessage *msg);
 329         int eventtype;
 330 };
 331 extern DLEXP struct MessageFunctionHook *MessageHookTable;
 332
 333 #define EVT_BEFOREREAD  200
 334 #define EVT_BEFORESAVE  201
 335 #define EVT_AFTERSAVE   202
 336
 337
 338
 339 /*
 340  * NetprocFunctionHook extensions are used for hooks which implement handlers
 341  * for incoming network messages.
 342  */
 343 struct NetprocFunctionHook {
 344         struct NetprocFunctionHook *next;
 345         int (*h_function_pointer) (struct CtdlMessage *msg);
 346 };
 347 extern DLEXP struct NetprocFunctionHook *NetprocHookTable;
 348
 349
 350
 351 /*
 352  * ExpressMessageFunctionHook extensions are used for hooks which implement
 353  * the sending of an express message through various channels.  Any function
 354  * registered should return the number of recipients to whom the message was
 355  * successfully transmitted.
 356  */
 357 struct XmsgFunctionHook {
 358         struct XmsgFunctionHook *next;
 359         int (*h_function_pointer) (char *, char *, char *);
 360         int order;
 361 };
 362 extern DLEXP struct XmsgFunctionHook *XmsgHookTable;
 363
 364 /* Priority levels for paging functions (lower is better) */
 365 enum {
 366         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 367         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 368         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 369         MAX_XMSG_PRI
 370 };
 371
 372
 373
 374 /*
 375  * ServiceFunctionHook extensions are used for hooks which implement various
 376  * non-Citadel services (on TCP protocols) directly in the Citadel server.
 377  */
 378 struct ServiceFunctionHook {
 379         struct ServiceFunctionHook *next;
 380         int tcp_port;
 381         char *sockpath;
 382         void (*h_greeting_function) (void) ;
 383         void (*h_command_function) (void) ;
 384         int msock;
 385 };
 386 extern DLEXP struct ServiceFunctionHook *ServiceHookTable;
 387
 388
 389
 390 /* Defines the relationship of a user to a particular room */
 391 struct visit {
 392         long v_roomnum;
 393         long v_roomgen;
 394         long v_usernum;
 395         long v_lastseen;
 396         unsigned int v_flags;
 397         char v_seen[SIZ];
 398 };
 399
 400 #define V_FORGET        1       /* User has zapped this room        */
 401 #define V_LOCKOUT       2       /* User is locked out of this room  */
 402 #define V_ACCESS        4       /* Access is granted to this room   */
 403
 404 #define UA_KNOWN                2
 405 #define UA_GOTOALLOWED          4
 406 #define UA_HASNEWMSGS           8
 407 #define UA_ZAPPED               16
 408
 409
 410 /* Supplementary data for a message on disk
 411  * (These are kept separately from the message itself because they are
 412  * fields whose values may change at some point after the message is saved.)
 413  */
 414 struct MetaData {
 415         long meta_msgnum;       /* Message number in *local* message base */
 416         int meta_refcount;      /* Number of rooms which point to this msg */
 417         char meta_content_type[64];
 418         char meta_mod;          /* Moderated to what level? */
 419         /* more stuff will be added to this record in the future */
 420 };
 421
 422
 423
 424 /* Built-in debuggable stuff for checking for memory leaks */
 425 #ifdef DEBUG_MEMORY_LEAKS
 426
 427 #define mallok(howbig)          tracked_malloc(howbig, __FILE__, __LINE__)
 428 #define phree(whichptr)                 tracked_free(whichptr)
 429 #define reallok(whichptr,howbig)        tracked_realloc(whichptr,howbig)
 430 #define strdoop(orig)           tracked_strdup(orig, __FILE__, __LINE__)
 431
 432 void *tracked_malloc(size_t, char *, int);
 433 void tracked_free(void *);
 434 void *tracked_realloc(void *, size_t);
 435 void dump_tracked(void);
 436 char *tracked_strdup(const char *, char *, int);
 437
 438 struct TheHeap {
 439         struct TheHeap *next;
 440         char h_file[32];
 441         int h_line;
 442         void *h_ptr;
 443 };
 444
 445 extern DLEXP struct TheHeap *heap;
 446
 447 #else
 448
 449 #define mallok(howbig)                  malloc(howbig)
 450 #define phree(whichptr)                 free(whichptr)
 451 #define reallok(whichptr,howbig)        realloc(whichptr,howbig)
 452 #define strdoop(orig)                   strdup(orig)
 453
 454
 455 #endif
 456
 457
 458 /*
 459  * Serialization routines use this struct to return a pointer and a length
 460  */
 461 struct ser_ret {
 462         size_t len;
 463         char *ser;
 464 };
 465
 466
 467 /* Preferred field order */
 468 /*               **********                     Important fields */
 469 /*                         ***************      Semi-important fields */
 470 /*                                        *     Message text (MUST be last) */
 471 #define FORDER  "IPTAFONHRDBCEGJKLQSUVWXYZM"
 472
 473 #endif /* SERVER_H */