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