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