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