citadel/server.h

   1 /* $Id$ */
   2
   3
   4 #ifndef SERVER_H
   5 #define SERVER_H
   6
   7 #ifdef __GNUC__
   8 #define INLINE __inline__
   9 #else
  10 #define INLINE
  11 #endif
  12
  13 #include "citadel.h"
  14 #ifdef HAVE_OPENSSL
  15 #define OPENSSL_NO_KRB5         /* work around redhat b0rken ssl headers */
  16 #include <openssl/ssl.h>
  17 #endif
  18
  19 /*
  20  * New format for a message in memory
  21  */
  22 struct CtdlMessage {
  23         int cm_magic;                   /* Self-check (NOT SAVED TO DISK) */
  24         char cm_anon_type;              /* Anonymous or author-visible */
  25         char cm_format_type;            /* Format type */
  26         char *cm_fields[256];           /* Data fields */
  27         unsigned int cm_flags;          /* How to handle (NOT SAVED TO DISK) */
  28 };
  29
  30 #define CTDLMESSAGE_MAGIC               0x159d
  31 #define CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
  32
  33
  34
  35 /*
  36  * Exit codes 101 through 109 are used for conditions in which
  37  * we deliberately do NOT want the service to automatically
  38  * restart.
  39  */
  40 #define CTDLEXIT_CONFIG         101     /* Could not read citadel.config */
  41 #define CTDLEXIT_CONTROL        102     /* Could not acquire lock */
  42 #define CTDLEXIT_HOME           103     /* Citadel home directory not found */
  43 #define CTDLEXIT_OOD            104     /* Out Of Date config - rerun setup */
  44 #define CTDLEXIT_DB             105     /* Unable to initialize database */
  45
  46
  47
  48
  49 /*
  50  * Here's the big one... the Citadel context structure.
  51  *
  52  * This structure keeps track of all information relating to a running
  53  * session on the server.  We keep one of these for each session thread.
  54  *
  55  */
  56 struct CitContext {
  57         struct CitContext *prev;        /* Link to previous session in list */
  58         struct CitContext *next;        /* Link to next session in the list */
  59
  60         int state;              /* thread state (see CON_ values below) */
  61         int kill_me;            /* Set to nonzero to flag for termination */
  62         int client_socket;
  63         int cs_pid;             /* session ID */
  64         time_t lastcmd;         /* time of last command executed */
  65         time_t lastidle;        /* For computing idle time */
  66
  67         char curr_user[USERNAME_SIZE];  /* name of current user */
  68         int logged_in;          /* logged in */
  69         int internal_pgm;       /* authenticated as internal program */
  70         int nologin;            /* not allowed to log in */
  71         int is_local_socket;    /* set to 1 if client is on unix domain sock */
  72         int curr_view;          /* The view type for the current user/room */
  73         int is_master;          /* Is this session logged in using the master user? */
  74
  75         char net_node[32]       ;/* Is the client another Citadel server? */
  76         time_t previous_login;  /* Date/time of previous login */
  77         char lastcmdname[5];    /* name of last command executed */
  78         unsigned cs_flags;      /* miscellaneous flags */
  79         void (*h_command_function) (void) ;     /* service command function */
  80         void (*h_async_function) (void) ;       /* do async msgs function */
  81         int is_async;           /* Nonzero if client accepts async msgs */
  82         int async_waiting;      /* Nonzero if there are async msgs waiting */
  83         int input_waiting;      /* Nonzero if there is client input waiting */
  84
  85         /* Client information */
  86         int cs_clientdev;       /* client developer ID */
  87         int cs_clienttyp;       /* client type code */
  88         int cs_clientver;       /* client version number */
  89         char cs_clientname[32]; /* name of client software */
  90         char cs_host[64];       /* host logged in from */
  91         char cs_addr[64];       /* address logged in from */
  92
  93         /* The Internet type of thing */
  94         char cs_inet_email[128];                /* Return address of outbound Internet mail */
  95         char cs_inet_other_emails[1024];        /* User's other valid Internet email addresses */
  96         char cs_inet_fn[128];                   /* Friendly-name of outbound Internet mail */
  97
  98         FILE *download_fp;      /* Fields relating to file transfer */
  99         char download_desired_section[128];
 100         FILE *upload_fp;
 101         char upl_file[256];
 102         char upl_path[PATH_MAX];
 103         char upl_comment[256];
 104         char upl_filedir[PATH_MAX];
 105         char dl_is_net;
 106         char upload_type;
 107
 108         struct ctdluser user;   /* Database record buffers */
 109         struct ctdlroom room;
 110
 111         /* Beginning of cryptography - session nonce */
 112         char cs_nonce[NONCE_SIZE];      /* The nonce for this session's next auth transaction */
 113
 114         /* Redirect this session's output to a memory buffer? */
 115         char *redirect_buffer;          /* the buffer */
 116         size_t redirect_len;            /* length of data in buffer */
 117         size_t redirect_alloc;          /* length of allocated buffer */
 118 #ifdef HAVE_OPENSSL
 119         SSL *ssl;
 120         int redirect_ssl;
 121 #endif
 122
 123         int buffering;
 124         char *output_buffer;    /* hold output for one big dump */
 125         int buffer_len;
 126
 127         /* A linked list of all instant messages sent to us. */
 128         struct ExpressMessage *FirstExpressMessage;
 129         int disable_exp;        /* Set to 1 to disable incoming pages */
 130         int newmail;            /* Other sessions increment this */
 131
 132         /* Masqueraded values in the 'who is online' list */
 133         char fake_username[USERNAME_SIZE];
 134         char fake_hostname[64];
 135         char fake_roomname[ROOMNAMELEN];
 136
 137         char preferred_formats[256];            /* Preferred MIME formats */
 138
 139         /* Dynamically allocated session data */
 140         struct citimap *IMAP;
 141         struct citpop3 *POP3;
 142         struct citsmtp *SMTP;
 143         struct citmgsve *MGSVE; /**< Managesieve Session struct */
 144         struct cit_ical *CIT_ICAL;              /* calendaring data */
 145         struct ma_info *ma;                     /* multipart/alternative data */
 146 };
 147
 148 typedef struct CitContext t_context;
 149
 150 /*
 151  * Values for CitContext.state
 152  *
 153  * A session that is doing nothing is in CON_IDLE state.  When activity
 154  * is detected on the socket, it goes to CON_READY, indicating that it
 155  * needs to have a worker thread bound to it.  When a thread binds to
 156  * the session, it goes to CON_EXECUTING and does its thing.  When the
 157  * transaction is finished, the thread sets it back to CON_IDLE and lets
 158  * it go.
 159  */
 160 enum {
 161         CON_IDLE,               /* This context is doing nothing */
 162         CON_READY,              /* This context needs attention */
 163         CON_EXECUTING           /* This context is bound to a thread */
 164 };
 165
 166
 167 #define CS_STEALTH      1       /* stealth mode */
 168 #define CS_CHAT         2       /* chat mode */
 169 #define CS_POSTING      4       /* Posting */
 170
 171 struct CitContext *MyContext(void);
 172 #define CC MyContext()
 173
 174 /*
 175  * This is the control record for the message base...
 176  */
 177 struct CitControl {
 178         long MMhighest;                 /* highest message number in file   */
 179         unsigned MMflags;               /* Global system flags              */
 180         long MMnextuser;                /* highest user number on system    */
 181         long MMnextroom;                /* highest room number on system    */
 182         int version;                    /* Server-hosted upgrade level      */
 183         int fulltext_wordbreaker;       /* ID of wordbreaker in use         */
 184         long MMfulltext;                /* highest message number indexed   */
 185 };
 186
 187 extern struct CitContext *ContextList;
 188 extern int ScheduledShutdown;
 189 extern struct CitControl CitControl;
 190
 191
 192 struct ExpressMessage {
 193         struct ExpressMessage *next;
 194         time_t timestamp;       /* When this message was sent */
 195         unsigned flags;         /* Special instructions */
 196         char sender[64];        /* Name of sending user */
 197         char *text;             /* Message text (if applicable) */
 198 };
 199
 200 #define EM_BROADCAST    1       /* Broadcast message */
 201 #define EM_GO_AWAY      2       /* Server requests client log off */
 202 #define EM_CHAT         4       /* Server requests client enter chat */
 203
 204 struct ChatLine {
 205         struct ChatLine *next;
 206         int chat_seq;
 207         time_t chat_time;
 208         char chat_text[SIZ];
 209         char chat_username[USERNAME_SIZE];
 210         char chat_room[ROOMNAMELEN];
 211 };
 212
 213 /*
 214  * Various things we need to lock and unlock
 215  */
 216 enum {
 217         S_USERS,
 218         S_ROOMS,
 219         S_SESSION_TABLE,
 220         S_FLOORTAB,
 221         S_CHATQUEUE,
 222         S_CONTROL,
 223         S_NETDB,
 224         S_SUPPMSGMAIN,
 225         S_CONFIG,
 226         S_WORKER_LIST,
 227         S_HOUSEKEEPING,
 228         S_NTTLIST,
 229         S_DIRECTORY,
 230         S_NETCONFIGS,
 231         S_PUBLIC_CLIENTS,
 232         S_LDAP,
 233         S_FLOORCACHE,
 234         S_DEBUGMEMLEAKS,
 235         S_ATBF,
 236         S_JOURNAL_QUEUE,
 237         S_RPLIST,
 238         S_SIEVELIST,
 239         S_CHKPWD,
 240         S_LOG,
 241         MAX_SEMAPHORES
 242 };
 243
 244
 245 /*
 246  * Upload types
 247  */
 248 #define UPL_FILE        0
 249 #define UPL_NET         1
 250 #define UPL_IMAGE       2
 251
 252
 253 /*
 254  * message transfer formats
 255  */
 256 enum {
 257         MT_CITADEL,             /* Citadel proprietary */
 258         MT_RFC822,              /* RFC822 */
 259         MT_MIME,                /* MIME-formatted message */
 260         MT_DOWNLOAD,            /* Download a component */
 261         MT_SPEW_SECTION         /* Download a component in a single operation */
 262 };
 263
 264 /*
 265  * Message format types in the database
 266  */
 267 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 268 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 269 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 270
 271
 272 /*
 273  * Citadel DataBases (define one for each cdb we need to open)
 274  */
 275 enum {
 276         CDB_MSGMAIN,            /* message base                  */
 277         CDB_USERS,              /* user file                     */
 278         CDB_ROOMS,              /* room index                    */
 279         CDB_FLOORTAB,           /* floor index                   */
 280         CDB_MSGLISTS,           /* room message lists            */
 281         CDB_VISIT,              /* user/room relationships       */
 282         CDB_DIRECTORY,          /* address book directory        */
 283         CDB_USETABLE,           /* network use table             */
 284         CDB_BIGMSGS,            /* larger message bodies         */
 285         CDB_FULLTEXT,           /* full text search index        */
 286         CDB_EUIDINDEX,          /* locate msgs by EUID           */
 287         MAXCDB                  /* total number of CDB's defined */
 288 };
 289
 290 struct cdbdata {
 291         size_t len;
 292         char *ptr;
 293 };
 294
 295
 296
 297 /* Structures and declarations for function hooks of various types */
 298
 299 struct LogFunctionHook {
 300         struct LogFunctionHook *next;
 301         int loglevel;
 302         void (*h_function_pointer) (char *);
 303 };
 304 extern struct LogFunctionHook *LogHookTable;
 305
 306 struct CleanupFunctionHook {
 307         struct CleanupFunctionHook *next;
 308         void (*h_function_pointer) (void);
 309 };
 310 extern struct CleanupFunctionHook *CleanupHookTable;
 311
 312 struct FixedOutputHook {
 313         struct FixedOutputHook *next;
 314         char content_type[64];
 315         void (*h_function_pointer) (char *, int);
 316 };
 317 extern struct FixedOutputHook *FixedOutputTable;
 318
 319
 320
 321 /*
 322  * SessionFunctionHook extensions are used for any type of hook for which
 323  * the context in which it's being called (which is determined by the event
 324  * type) will make it obvious for the hook function to know where to look for
 325  * pertinent data.
 326  */
 327 struct SessionFunctionHook {
 328         struct SessionFunctionHook *next;
 329         void (*h_function_pointer) (void);
 330         int eventtype;
 331 };
 332 extern struct SessionFunctionHook *SessionHookTable;
 333
 334 /*
 335  * Event types can't be enum'ed, because they must remain consistent between
 336  * builds (to allow for binary modules built somewhere else)
 337  */
 338 #define EVT_STOP        0       /* Session is terminating */
 339 #define EVT_START       1       /* Session is starting */
 340 #define EVT_LOGIN       2       /* A user is logging in */
 341 #define EVT_NEWROOM     3       /* Changing rooms */
 342 #define EVT_LOGOUT      4       /* A user is logging out */
 343 #define EVT_SETPASS     5       /* Setting or changing password */
 344 #define EVT_CMD         6       /* Called after each server command */
 345 #define EVT_RWHO        7       /* An RWHO command is being executed */
 346 #define EVT_ASYNC       8       /* Doing asynchronous messages */
 347
 348 #define EVT_TIMER       50      /* Timer events are called once per minute
 349                                    and are not tied to any session */
 350 #define EVT_HOUSE       51      /* as needed houskeeping stuff */
 351 /*
 352  * UserFunctionHook extensions are used for any type of hook which implements
 353  * an operation on a user or username (potentially) other than the one
 354  * operating the current session.
 355  */
 356 struct UserFunctionHook {
 357         struct UserFunctionHook *next;
 358         void (*h_function_pointer) (struct ctdluser *usbuf);
 359         int eventtype;
 360 };
 361 extern struct UserFunctionHook *UserHookTable;
 362
 363 #define EVT_PURGEUSER   100     /* Deleting a user */
 364 #define EVT_NEWUSER     102     /* Creating a user */
 365
 366 /*
 367  * MessageFunctionHook extensions are used for hooks which implement handlers
 368  * for various types of message operations (save, read, etc.)
 369  */
 370 struct MessageFunctionHook {
 371         struct MessageFunctionHook *next;
 372         int (*h_function_pointer) (struct CtdlMessage *msg);
 373         int eventtype;
 374 };
 375 extern struct MessageFunctionHook *MessageHookTable;
 376
 377 #define EVT_BEFOREREAD  200
 378 #define EVT_BEFORESAVE  201
 379 #define EVT_AFTERSAVE   202
 380 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
 381
 382
 383 /*
 384  * NetprocFunctionHook extensions are used for hooks which implement handlers
 385  * for incoming network messages.
 386  */
 387 struct NetprocFunctionHook {
 388         struct NetprocFunctionHook *next;
 389         int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
 390 };
 391 extern struct NetprocFunctionHook *NetprocHookTable;
 392
 393
 394 /*
 395  * DeleteFunctionHook extensions are used for hooks which get called when a
 396  * message is about to be deleted.
 397  */
 398 struct DeleteFunctionHook {
 399         struct DeleteFunctionHook *next;
 400         void (*h_function_pointer) (char *target_room, long msgnum);
 401 };
 402 extern struct DeleteFunctionHook *DeleteHookTable;
 403
 404
 405 /*
 406  * ExpressMessageFunctionHook extensions are used for hooks which implement
 407  * the sending of an instant message through various channels.  Any function
 408  * registered should return the number of recipients to whom the message was
 409  * successfully transmitted.
 410  */
 411 struct XmsgFunctionHook {
 412         struct XmsgFunctionHook *next;
 413         int (*h_function_pointer) (char *, char *, char *);
 414         int order;
 415 };
 416 extern struct XmsgFunctionHook *XmsgHookTable;
 417
 418 /* Priority levels for paging functions (lower is better) */
 419 enum {
 420         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 421         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 422         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 423         MAX_XMSG_PRI
 424 };
 425
 426
 427
 428 /*
 429  * ServiceFunctionHook extensions are used for hooks which implement various
 430  * protocols (either on TCP or on unix domain sockets) directly in the Citadel server.
 431  */
 432 struct ServiceFunctionHook {
 433         struct ServiceFunctionHook *next;
 434         int tcp_port;
 435         char *sockpath;
 436         void (*h_greeting_function) (void) ;
 437         void (*h_command_function) (void) ;
 438         void (*h_async_function) (void) ;
 439         int msock;
 440 };
 441 extern struct ServiceFunctionHook *ServiceHookTable;
 442
 443
 444 /*
 445  * RoomFunctionHook extensions are used for hooks which impliment room
 446  * processing functions when new messages are added EG. SIEVE.
 447  */
 448 struct RoomFunctionHook {
 449         struct RoomFunctionHook *next;
 450         int (*fcn_ptr) (struct ctdlroom *);
 451 };
 452 extern struct RoomFunctionHook *RoomHookTable;
 453
 454
 455 struct MaintenanceThreadHook {
 456         struct MaintenanceThreadHook *next;
 457         char *name;
 458         void *(*fcn_ptr) (void *arg);
 459         pthread_t MaintenanceThread_tid;
 460 };
 461 extern struct MaintenanceThreadHook *MaintenanceThreadHookTable;
 462
 463
 464 struct SearchFunctionHook {
 465         struct SearchFunctionHook *next;
 466         void (*fcn_ptr) (int *, long **, char *);
 467         char *name;
 468 };
 469 extern struct SearchFunctionHook *SearchFunctionHookTable;
 470
 471
 472 /* Defines the relationship of a user to a particular room */
 473 struct visit {
 474         long v_roomnum;
 475         long v_roomgen;
 476         long v_usernum;
 477         long v_lastseen;
 478         unsigned int v_flags;
 479         char v_seen[SIZ];
 480         char v_answered[SIZ];
 481         int v_view;
 482 };
 483
 484 #define V_FORGET        1       /* User has zapped this room        */
 485 #define V_LOCKOUT       2       /* User is locked out of this room  */
 486 #define V_ACCESS        4       /* Access is granted to this room   */
 487
 488
 489 /* Supplementary data for a message on disk
 490  * These are kept separate from the message itself for one of two reasons:
 491  * 1. Either their values may change at some point after initial save, or
 492  * 2. They are merely caches of data which exist somewhere else, for speed.
 493  */
 494 struct MetaData {
 495         long meta_msgnum;               /* Message number in *local* message base */
 496         int meta_refcount;              /* Number of rooms pointing to this msg */
 497         char meta_content_type[64];     /* Cached MIME content-type */
 498         long meta_rfc822_length;        /* Cache of RFC822-translated msg length */
 499 };
 500
 501 /* Calls to AdjRefCount() are queued and deferred, so the user doesn't
 502  * have to wait for various disk-intensive operations to complete synchronously.
 503  * This is the record format.
 504  */
 505 struct arcq {
 506         long arcq_msgnum;               /* Message number being adjusted */
 507         int arcq_delta;                 /* Adjustment ( usually 1 or -1 ) */
 508 };
 509
 510
 511 /*
 512  * Serialization routines use this struct to return a pointer and a length
 513  */
 514 struct ser_ret {
 515         size_t len;
 516         unsigned char *ser;
 517 };
 518
 519
 520 /* Preferred field order                                                        */
 521 /*               **********                     Important fields                */
 522 /*                         ***************      Semi-important fields           */
 523 /*                                        *     Message text (MUST be last)     */
 524 #define FORDER  "IPTAFONHRDBCEJGKLQSVWXZYUM"
 525
 526 #endif /* SERVER_H */