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