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         int buffering;
 134         char *output_buffer;    /* hold output for one big dump */
 135         int buffer_len;
 136
 137         /* A linked list of all express messages sent to us. */
 138         struct ExpressMessage *FirstExpressMessage;
 139         int disable_exp;        /* Set to 1 to disable incoming pages */
 140         int newmail;            /* Other sessions increment this */
 141
 142         /* Masquerade... */
 143         char fake_username[USERNAME_SIZE];      /* Fake username <bc> */
 144         char fake_postname[USERNAME_SIZE];      /* Fake postname <bc> */
 145         char fake_hostname[64];                 /* Fake hostname <bc> */
 146         char fake_roomname[ROOMNAMELEN];        /* Fake roomname <bc> */
 147
 148         char preferred_formats[SIZ];            /* Preferred MIME formats */
 149
 150         /* Dynamically allocated session data */
 151         struct CtdlSessData *FirstSessData;
 152 };
 153
 154 typedef struct CitContext t_context;
 155
 156 /* Values for CitContext.state */
 157 enum {
 158         CON_IDLE,               /* This context is doing nothing */
 159         CON_EXECUTING           /* This context is bound to a thread */
 160 };
 161
 162
 163 #define CS_STEALTH      1       /* stealth mode */
 164 #define CS_CHAT         2       /* chat mode */
 165 #define CS_POSTING      4       /* Posting */
 166
 167 struct CitContext *MyContext(void);
 168 #define CC MyContext()
 169
 170 extern struct CitContext *ContextList;
 171 extern int ScheduledShutdown;
 172 extern struct CitControl CitControl;
 173
 174
 175 struct ExpressMessage {
 176         struct ExpressMessage *next;
 177         time_t timestamp;       /* When this message was sent */
 178         unsigned flags;         /* Special instructions */
 179         char sender[64];        /* Name of sending user */
 180         char *text;             /* Message text (if applicable) */
 181 };
 182
 183 #define EM_BROADCAST    1       /* Broadcast message */
 184 #define EM_GO_AWAY      2       /* Server requests client log off */
 185 #define EM_CHAT         4       /* Server requests client enter chat */
 186
 187 struct ChatLine {
 188         struct ChatLine *next;
 189         int chat_seq;
 190         time_t chat_time;
 191         char chat_text[SIZ];
 192         char chat_username[USERNAME_SIZE];
 193         char chat_room[ROOMNAMELEN];
 194 };
 195
 196 /*
 197  * Various things we need to lock and unlock
 198  */
 199 enum {
 200         S_USERS,
 201         S_ROOMS,
 202         S_SESSION_TABLE,
 203         S_FLOORTAB,
 204         S_CHATQUEUE,
 205         S_CONTROL,
 206         S_DATABASE,
 207         S_NETDB,
 208         S_SUPPMSGMAIN,
 209         S_I_WANNA_SELECT,
 210         S_CONFIG,
 211         S_WORKER_LIST,
 212         S_HOUSEKEEPING,
 213         S_NTTLIST,
 214         S_DIRECTORY,
 215         S_NETCONFIGS,
 216         S_PUBLIC_CLIENTS,
 217         S_LDAP,
 218         S_FLOORCACHE,
 219         MAX_SEMAPHORES
 220 };
 221
 222
 223 /*
 224  * Upload types
 225  */
 226 #define UPL_FILE        0
 227 #define UPL_NET         1
 228 #define UPL_IMAGE       2
 229
 230
 231 /*
 232  * message transfer formats
 233  */
 234 enum {
 235         MT_CITADEL,             /* Citadel proprietary */
 236         MT_RFC822,              /* RFC822 */
 237         MT_MIME,                /* MIME-formatted message */
 238         MT_DOWNLOAD             /* Download a component */
 239 };
 240
 241 /*
 242  * Message format types in the database
 243  */
 244 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 245 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 246 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 247
 248
 249 /*
 250  * Citadel DataBases (define one for each cdb we need to open)
 251  */
 252 enum {
 253         CDB_MSGMAIN,            /* message base                  */
 254         CDB_USERS,              /* user file                     */
 255         CDB_ROOMS,              /* room index                    */
 256         CDB_FLOORTAB,           /* floor index                   */
 257         CDB_MSGLISTS,           /* room message lists            */
 258         CDB_VISIT,              /* user/room relationships       */
 259         CDB_DIRECTORY,          /* address book directory        */
 260         CDB_USETABLE,           /* network use table             */
 261         MAXCDB                  /* total number of CDB's defined */
 262 };
 263
 264 struct cdbdata {
 265         size_t len;
 266         char *ptr;
 267 };
 268
 269
 270
 271 /* Structures and declarations for function hooks of various types */
 272
 273 struct LogFunctionHook {
 274         struct LogFunctionHook *next;
 275         int loglevel;
 276         void (*h_function_pointer) (char *);
 277 };
 278 extern struct LogFunctionHook *LogHookTable;
 279
 280 struct CleanupFunctionHook {
 281         struct CleanupFunctionHook *next;
 282         void (*h_function_pointer) (void);
 283 };
 284 extern struct CleanupFunctionHook *CleanupHookTable;
 285
 286
 287
 288
 289 /*
 290  * SessionFunctionHook extensions are used for any type of hook for which
 291  * the context in which it's being called (which is determined by the event
 292  * type) will make it obvious for the hook function to know where to look for
 293  * pertinent data.
 294  */
 295 struct SessionFunctionHook {
 296         struct SessionFunctionHook *next;
 297         void (*h_function_pointer) (void);
 298         int eventtype;
 299 };
 300 extern struct SessionFunctionHook *SessionHookTable;
 301
 302 /*
 303  * Event types can't be enum'ed, because they must remain consistent between
 304  * builds (to allow for binary modules built somewhere else)
 305  */
 306 #define EVT_STOP        0       /* Session is terminating */
 307 #define EVT_START       1       /* Session is starting */
 308 #define EVT_LOGIN       2       /* A user is logging in */
 309 #define EVT_NEWROOM     3       /* Changing rooms */
 310 #define EVT_LOGOUT      4       /* A user is logging out */
 311 #define EVT_SETPASS     5       /* Setting or changing password */
 312 #define EVT_CMD         6       /* Called after each server command */
 313 #define EVT_RWHO        7       /* An RWHO command is being executed */
 314
 315 #define EVT_TIMER       50      /* Timer events are called once per minute
 316                                    and are not tied to any session */
 317
 318 /*
 319  * UserFunctionHook extensions are used for any type of hook which implements
 320  * an operation on a user or username (potentially) other than the one
 321  * operating the current session.
 322  */
 323 struct UserFunctionHook {
 324         struct UserFunctionHook *next;
 325         void (*h_function_pointer) (struct ctdluser *usbuf);
 326         int eventtype;
 327 };
 328 extern struct UserFunctionHook *UserHookTable;
 329
 330 #define EVT_PURGEUSER   100     /* Deleting a user */
 331 #define EVT_NEWUSER     102     /* Creating a user */
 332
 333 /*
 334  * MessageFunctionHook extensions are used for hooks which implement handlers
 335  * for various types of message operations (save, read, etc.)
 336  */
 337 struct MessageFunctionHook {
 338         struct MessageFunctionHook *next;
 339         int (*h_function_pointer) (struct CtdlMessage *msg);
 340         int eventtype;
 341 };
 342 extern struct MessageFunctionHook *MessageHookTable;
 343
 344 #define EVT_BEFOREREAD  200
 345 #define EVT_BEFORESAVE  201
 346 #define EVT_AFTERSAVE   202
 347 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
 348
 349
 350
 351 /*
 352  * NetprocFunctionHook extensions are used for hooks which implement handlers
 353  * for incoming network messages.
 354  */
 355 struct NetprocFunctionHook {
 356         struct NetprocFunctionHook *next;
 357         int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
 358 };
 359 extern struct NetprocFunctionHook *NetprocHookTable;
 360
 361
 362 /*
 363  * DeleteFunctionHook extensions are used for hooks which get called when a
 364  * message is about to be deleted.
 365  */
 366 struct DeleteFunctionHook {
 367         struct DeleteFunctionHook *next;
 368         void (*h_function_pointer) (char *target_room, long msgnum);
 369 };
 370 extern struct DeleteFunctionHook *DeleteHookTable;
 371
 372
 373 /*
 374  * ExpressMessageFunctionHook extensions are used for hooks which implement
 375  * the sending of an express message through various channels.  Any function
 376  * registered should return the number of recipients to whom the message was
 377  * successfully transmitted.
 378  */
 379 struct XmsgFunctionHook {
 380         struct XmsgFunctionHook *next;
 381         int (*h_function_pointer) (char *, char *, char *);
 382         int order;
 383 };
 384 extern struct XmsgFunctionHook *XmsgHookTable;
 385
 386 /* Priority levels for paging functions (lower is better) */
 387 enum {
 388         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 389         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 390         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 391         MAX_XMSG_PRI
 392 };
 393
 394
 395
 396 /*
 397  * ServiceFunctionHook extensions are used for hooks which implement various
 398  * non-Citadel services (on TCP protocols) directly in the Citadel server.
 399  */
 400 struct ServiceFunctionHook {
 401         struct ServiceFunctionHook *next;
 402         int tcp_port;
 403         char *sockpath;
 404         void (*h_greeting_function) (void) ;
 405         void (*h_command_function) (void) ;
 406         int msock;
 407 };
 408 extern struct ServiceFunctionHook *ServiceHookTable;
 409
 410
 411
 412 /* Defines the relationship of a user to a particular room */
 413 struct visit {
 414         long v_roomnum;
 415         long v_roomgen;
 416         long v_usernum;
 417         long v_lastseen;
 418         unsigned int v_flags;
 419         char v_seen[SIZ];
 420         char v_answered[SIZ];
 421         int v_view;
 422 };
 423
 424 #define V_FORGET        1       /* User has zapped this room        */
 425 #define V_LOCKOUT       2       /* User is locked out of this room  */
 426 #define V_ACCESS        4       /* Access is granted to this room   */
 427
 428
 429 /* Supplementary data for a message on disk
 430  * (These are kept separately from the message itself because they are
 431  * fields whose values may change at some point after the message is saved.)
 432  */
 433 struct MetaData {
 434         long meta_msgnum;       /* Message number in *local* message base */
 435         int meta_refcount;      /* Number of rooms which point to this msg */
 436         char meta_content_type[64];
 437         /* more stuff will be added to this record in the future */
 438 };
 439
 440
 441
 442 /* Built-in debuggable stuff for checking for memory leaks */
 443 #ifdef DEBUG_MEMORY_LEAKS
 444
 445 #define mallok(howbig)          tracked_malloc(howbig, __FILE__, __LINE__)
 446 #define phree(whichptr)                 tracked_free(whichptr)
 447 #define reallok(whichptr,howbig)        tracked_realloc(whichptr,howbig)
 448 #define strdoop(orig)           tracked_strdup(orig, __FILE__, __LINE__)
 449
 450 void *tracked_malloc(size_t, char *, int);
 451 void tracked_free(void *);
 452 void *tracked_realloc(void *, size_t);
 453 void dump_tracked(void);
 454 char *tracked_strdup(const char *, char *, int);
 455
 456 struct TheHeap {
 457         struct TheHeap *next;
 458         char h_file[32];
 459         int h_line;
 460         void *h_ptr;
 461 };
 462
 463 extern struct TheHeap *heap;
 464
 465 #else
 466
 467 #define mallok(howbig)                  malloc(howbig)
 468 #define phree(whichptr)                 free(whichptr)
 469 #define reallok(whichptr,howbig)        realloc(whichptr,howbig)
 470 #define strdoop(orig)                   strdup(orig)
 471
 472
 473 #endif
 474
 475
 476 /*
 477  * Serialization routines use this struct to return a pointer and a length
 478  */
 479 struct ser_ret {
 480         size_t len;
 481         char *ser;
 482 };
 483
 484
 485 /* Preferred field order */
 486 /*               **********                     Important fields */
 487 /*                         ***************      Semi-important fields */
 488 /*                                        *     Message text (MUST be last) */
 489 #define FORDER  "IPTAFONHRDBCEGJKLQSVWXYZUM"
 490
 491 #endif /* SERVER_H */