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 #define CTDLEXIT_LIBCITADEL     106     /* Incorrect version of libcitadel */
  46
  47
  48
  49
  50 /*
  51  * Here's the big one... the Citadel context structure.
  52  *
  53  * This structure keeps track of all information relating to a running
  54  * session on the server.  We keep one of these for each session thread.
  55  *
  56  */
  57 struct CitContext {
  58         struct CitContext *prev;        /* Link to previous session in list */
  59         struct CitContext *next;        /* Link to next session in the list */
  60
  61         int state;              /* thread state (see CON_ values below) */
  62         int kill_me;            /* Set to nonzero to flag for termination */
  63         int client_socket;
  64         int cs_pid;             /* session ID */
  65         time_t lastcmd;         /* time of last command executed */
  66         time_t lastidle;        /* For computing idle time */
  67
  68         char curr_user[USERNAME_SIZE];  /* name of current user */
  69         int logged_in;          /* logged in */
  70         int internal_pgm;       /* authenticated as internal program */
  71         int nologin;            /* not allowed to log in */
  72         int is_local_socket;    /* set to 1 if client is on unix domain sock */
  73         int curr_view;          /* The view type for the current user/room */
  74         int is_master;          /* Is this session logged in using the master user? */
  75
  76         char net_node[32]       ;/* Is the client another Citadel server? */
  77         time_t previous_login;  /* Date/time of previous login */
  78         char lastcmdname[5];    /* name of last command executed */
  79         unsigned cs_flags;      /* miscellaneous flags */
  80         void (*h_command_function) (void) ;     /* service command function */
  81         void (*h_async_function) (void) ;       /* do async msgs function */
  82         int is_async;           /* Nonzero if client accepts async msgs */
  83         int async_waiting;      /* Nonzero if there are async msgs waiting */
  84         int input_waiting;      /* Nonzero if there is client input waiting */
  85
  86         /* Client information */
  87         int cs_clientdev;       /* client developer ID */
  88         int cs_clienttyp;       /* client type code */
  89         int cs_clientver;       /* client version number */
  90         char cs_clientname[32]; /* name of client software */
  91         char cs_host[64];       /* host logged in from */
  92         char cs_addr[64];       /* address logged in from */
  93
  94         /* The Internet type of thing */
  95         char cs_inet_email[128];                /* Return address of outbound Internet mail */
  96         char cs_inet_other_emails[1024];        /* User's other valid Internet email addresses */
  97         char cs_inet_fn[128];                   /* Friendly-name of outbound Internet mail */
  98
  99         FILE *download_fp;      /* Fields relating to file transfer */
 100         char download_desired_section[128];
 101         FILE *upload_fp;
 102         char upl_file[256];
 103         char upl_path[PATH_MAX];
 104         char upl_comment[256];
 105         char upl_filedir[PATH_MAX];
 106         char dl_is_net;
 107         char upload_type;
 108
 109         struct ctdluser user;   /* Database record buffers */
 110         struct ctdlroom room;
 111
 112         /* Beginning of cryptography - session nonce */
 113         char cs_nonce[NONCE_SIZE];      /* The nonce for this session's next auth transaction */
 114
 115         /* Redirect this session's output to a memory buffer? */
 116         char *redirect_buffer;          /* the buffer */
 117         size_t redirect_len;            /* length of data in buffer */
 118         size_t redirect_alloc;          /* length of allocated buffer */
 119 #ifdef HAVE_OPENSSL
 120         SSL *ssl;
 121         int redirect_ssl;
 122 #endif
 123
 124         int buffering;
 125         char *output_buffer;    /* hold output for one big dump */
 126         int buffer_len;
 127
 128         /* A linked list of all instant messages sent to us. */
 129         struct ExpressMessage *FirstExpressMessage;
 130         int disable_exp;        /* Set to 1 to disable incoming pages */
 131         int newmail;            /* Other sessions increment this */
 132
 133         /* Masqueraded values in the 'who is online' list */
 134         char fake_username[USERNAME_SIZE];
 135         char fake_hostname[64];
 136         char fake_roomname[ROOMNAMELEN];
 137
 138         /* Preferred MIME formats */
 139         char preferred_formats[256];
 140         int msg4_dont_decode;
 141
 142         /* Dynamically allocated session data */
 143         char *session_specific_data;            /* Used by individual protocol modules */
 144         struct cit_ical *CIT_ICAL;              /* calendaring data */
 145         struct ma_info *ma;                     /* multipart/alternative data */
 146         const char* ServiceName;                /**< whats our actual purpose? */
 147 };
 148
 149 typedef struct CitContext t_context;
 150
 151 /*
 152  * Values for CitContext.state
 153  *
 154  * A session that is doing nothing is in CON_IDLE state.  When activity
 155  * is detected on the socket, it goes to CON_READY, indicating that it
 156  * needs to have a worker thread bound to it.  When a thread binds to
 157  * the session, it goes to CON_EXECUTING and does its thing.  When the
 158  * transaction is finished, the thread sets it back to CON_IDLE and lets
 159  * it go.
 160  */
 161 enum {
 162         CON_IDLE,               /* This context is doing nothing */
 163         CON_READY,              /* This context needs attention */
 164         CON_EXECUTING           /* This context is bound to a thread */
 165 };
 166
 167
 168 #define CS_STEALTH      1       /* stealth mode */
 169 #define CS_CHAT         2       /* chat mode */
 170 #define CS_POSTING      4       /* Posting */
 171
 172 struct CitContext *MyContext(void);
 173 #define CC MyContext()
 174
 175 /*
 176  * This is the control record for the message base...
 177  */
 178 struct CitControl {
 179         long MMhighest;                 /* highest message number in file   */
 180         unsigned MMflags;               /* Global system flags              */
 181         long MMnextuser;                /* highest user number on system    */
 182         long MMnextroom;                /* highest room number on system    */
 183         int version;                    /* Server-hosted upgrade level      */
 184         int fulltext_wordbreaker;       /* ID of wordbreaker in use         */
 185         long MMfulltext;                /* highest message number indexed   */
 186 };
 187
 188 extern struct CitContext *ContextList;
 189 extern int ScheduledShutdown;
 190 extern struct CitControl CitControl;
 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[256];       /* Name of sending user */
 197         char sender_email[256]; /* Email or JID of sending user */
 198         char *text;             /* Message text (if applicable) */
 199 };
 200
 201 #define EM_BROADCAST    1       /* Broadcast message */
 202 #define EM_GO_AWAY      2       /* Server requests client log off */
 203 #define EM_CHAT         4       /* Server requests client enter chat */
 204
 205 struct ChatLine {
 206         struct ChatLine *next;
 207         int chat_seq;
 208         time_t chat_time;
 209         char chat_text[SIZ];
 210         char chat_username[USERNAME_SIZE];
 211         char chat_room[ROOMNAMELEN];
 212 };
 213
 214 /*
 215  * Various things we need to lock and unlock
 216  */
 217 enum {
 218         S_USERS,
 219         S_ROOMS,
 220         S_SESSION_TABLE,
 221         S_FLOORTAB,
 222         S_CHATQUEUE,
 223         S_CONTROL,
 224         S_NETDB,
 225         S_SUPPMSGMAIN,
 226         S_CONFIG,
 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         S_NETSPOOL,
 242         S_THREAD_LIST,
 243         S_XMPP_QUEUE,
 244         S_SCHEDULE_LIST,
 245         MAX_SEMAPHORES
 246 };
 247
 248
 249 /*
 250  * Upload types
 251  */
 252 #define UPL_FILE        0
 253 #define UPL_NET         1
 254 #define UPL_IMAGE       2
 255
 256
 257 /*
 258  * message transfer formats
 259  */
 260 enum {
 261         MT_CITADEL,             /* Citadel proprietary */
 262         MT_RFC822,              /* RFC822 */
 263         MT_MIME,                /* MIME-formatted message */
 264         MT_DOWNLOAD,            /* Download a component */
 265         MT_SPEW_SECTION         /* Download a component in a single operation */
 266 };
 267
 268 /*
 269  * Message format types in the database
 270  */
 271 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 272 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 273 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 274
 275
 276 /*
 277  * Citadel DataBases (define one for each cdb we need to open)
 278  */
 279 enum {
 280         CDB_MSGMAIN,            /* message base                  */
 281         CDB_USERS,              /* user file                     */
 282         CDB_ROOMS,              /* room index                    */
 283         CDB_FLOORTAB,           /* floor index                   */
 284         CDB_MSGLISTS,           /* room message lists            */
 285         CDB_VISIT,              /* user/room relationships       */
 286         CDB_DIRECTORY,          /* address book directory        */
 287         CDB_USETABLE,           /* network use table             */
 288         CDB_BIGMSGS,            /* larger message bodies         */
 289         CDB_FULLTEXT,           /* full text search index        */
 290         CDB_EUIDINDEX,          /* locate msgs by EUID           */
 291         MAXCDB                  /* total number of CDB's defined */
 292 };
 293
 294 struct cdbdata {
 295         size_t len;
 296         char *ptr;
 297 };
 298
 299
 300 /*
 301  * Event types can't be enum'ed, because they must remain consistent between
 302  * builds (to allow for binary modules built somewhere else)
 303  */
 304 #define EVT_STOP        0       /* Session is terminating */
 305 #define EVT_START       1       /* Session is starting */
 306 #define EVT_LOGIN       2       /* A user is logging in */
 307 #define EVT_NEWROOM     3       /* Changing rooms */
 308 #define EVT_LOGOUT      4       /* A user is logging out */
 309 #define EVT_SETPASS     5       /* Setting or changing password */
 310 #define EVT_CMD         6       /* Called after each server command */
 311 #define EVT_RWHO        7       /* An RWHO command is being executed */
 312 #define EVT_ASYNC       8       /* Doing asynchronous messages */
 313 #define EVT_STEALTH     9       /* Entering stealth mode */
 314 #define EVT_UNSTEALTH   10      /* Exiting stealth mode */
 315
 316 #define EVT_TIMER       50      /* Timer events are called once per minute
 317                                    and are not tied to any session */
 318 #define EVT_HOUSE       51      /* as needed houskeeping stuff */
 319
 320 #define EVT_PURGEUSER   100     /* Deleting a user */
 321 #define EVT_NEWUSER     102     /* Creating a user */
 322
 323 #define EVT_BEFOREREAD  200
 324 #define EVT_BEFORESAVE  201
 325 #define EVT_AFTERSAVE   202
 326 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
 327 /* Priority levels for paging functions (lower is better) */
 328 enum {
 329         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 330         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 331         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 332         MAX_XMSG_PRI
 333 };
 334
 335
 336 /* Defines the relationship of a user to a particular room */
 337 struct visit {
 338         long v_roomnum;
 339         long v_roomgen;
 340         long v_usernum;
 341         long v_lastseen;
 342         unsigned int v_flags;
 343         char v_seen[SIZ];
 344         char v_answered[SIZ];
 345         int v_view;
 346 };
 347
 348 #define V_FORGET        1       /* User has zapped this room        */
 349 #define V_LOCKOUT       2       /* User is locked out of this room  */
 350 #define V_ACCESS        4       /* Access is granted to this room   */
 351
 352
 353 /* Supplementary data for a message on disk
 354  * These are kept separate from the message itself for one of two reasons:
 355  * 1. Either their values may change at some point after initial save, or
 356  * 2. They are merely caches of data which exist somewhere else, for speed.
 357  */
 358 struct MetaData {
 359         long meta_msgnum;               /* Message number in *local* message base */
 360         int meta_refcount;              /* Number of rooms pointing to this msg */
 361         char meta_content_type[64];     /* Cached MIME content-type */
 362         long meta_rfc822_length;        /* Cache of RFC822-translated msg length */
 363 };
 364
 365 /* Calls to AdjRefCount() are queued and deferred, so the user doesn't
 366  * have to wait for various disk-intensive operations to complete synchronously.
 367  * This is the record format.
 368  */
 369 struct arcq {
 370         long arcq_msgnum;               /* Message number being adjusted */
 371         int arcq_delta;                 /* Adjustment ( usually 1 or -1 ) */
 372 };
 373
 374
 375 /*
 376  * Serialization routines use this struct to return a pointer and a length
 377  */
 378 struct ser_ret {
 379         size_t len;
 380         unsigned char *ser;
 381 };
 382
 383
 384 /*
 385  * The S_USETABLE database is used in several modules now, so we define its format here.
 386  */
 387 struct UseTable {
 388         char ut_msgid[SIZ];
 389         time_t ut_timestamp;
 390 };
 391
 392
 393
 394 /* Preferred field order                                                        */
 395 /*               **********                     Important fields                */
 396 /*                         ***************      Semi-important fields           */
 397 /*                                        *     Message text (MUST be last)     */
 398 #define FORDER  "IPTAFONHRDBCEJGKLQSVWXZYUM"
 399
 400 #endif /* SERVER_H */