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 #include <openssl/ssl.h>
  16 #endif
  17
  18 /*
  19  * New format for a message in memory
  20  */
  21 struct CtdlMessage {
  22         int cm_magic;                   /* Self-check (NOT SAVED TO DISK) */
  23         char cm_anon_type;              /* Anonymous or author-visible */
  24         char cm_format_type;            /* Format type */
  25         char *cm_fields[256];           /* Data fields */
  26         unsigned int cm_flags;          /* How to handle (NOT SAVED TO DISK) */
  27 };
  28
  29 #define CTDLMESSAGE_MAGIC               0x159d
  30 #define CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
  31
  32
  33 /*
  34  * Generic per-session variable or data structure storage
  35  */
  36 struct CtdlSessData {
  37         struct CtdlSessData *next;
  38         unsigned long sym_id;
  39         void *sym_data;
  40 };
  41
  42 /*
  43  * Static user data symbol types.  Server extensions can ask for dynamic
  44  * extensions to per-session data, but the symbol ID has to be listed here.
  45  */
  46 enum {
  47         SYM_DESIRED_SECTION,            /* Used by the MIME parser */
  48         SYM_MA_INFO,                    /* Handles multipart/alternative */
  49         SYM_REPL,                       /* Used for replication checking */
  50         SYM_CIT_ICAL,                   /* Used by the calendar service */
  51         SYM_IMAP,                       /* Used by the IMAP service */
  52         SYM_POP3,                       /* Used by the POP3 service */
  53         SYM_SMTP,                       /* Used by the SMTP service */
  54         SYM_SMTP_RECPS,
  55         SYM_SMTP_ROOMS,
  56         SYM_VCARD,                      /* vCard handling requires this */
  57         SYM_MAX
  58 };
  59
  60
  61 /*
  62  * Here's the big one... the Citadel context structure.
  63  *
  64  * This structure keeps track of all information relating to a running
  65  * session on the server.  We keep one of these for each session thread.
  66  *
  67  * Note that the first element is "*next" so that it may be used without
  68  * modification in a linked list.
  69  */
  70 struct CitContext {
  71         struct CitContext *next;        /* Link to next session in the list */
  72
  73         struct ctdluser user;   /* Database record buffers */
  74         struct ctdlroom room;
  75
  76         int state;              /* thread state (see CON_ values below) */
  77         int kill_me;            /* Set to nonzero to flag for termination */
  78
  79         char curr_user[USERNAME_SIZE];  /* name of current user */
  80         int logged_in;          /* logged in */
  81         int internal_pgm;       /* authenticated as internal program */
  82         char temp[PATH_MAX];    /* temp file name */
  83         int nologin;            /* not allowed to log in */
  84         int is_local_socket;    /* set to 1 if client is on unix domain sock */
  85
  86         char net_node[PATH_MAX];/* Is the client another Citadel server? */
  87         int client_socket;
  88         int cs_pid;             /* session ID */
  89         time_t lastcmd;         /* time of last command executed */
  90         time_t lastidle;        /* For computing idle time */
  91         time_t previous_login;  /* Date/time of previous login */
  92         char lastcmdname[5];    /* name of last command executed */
  93         unsigned cs_flags;      /* miscellaneous flags */
  94         void (*h_command_function) (void) ;     /* service command function */
  95         int is_async;           /* Nonzero if client accepts async msgs */
  96
  97         /* feeping creaturisms... */
  98         int cs_clientdev;       /* client developer ID */
  99         int cs_clienttyp;       /* client type code */
 100         int cs_clientver;       /* client version number */
 101         char cs_clientname[32]; /* name of client software */
 102         char cs_host[64];       /* host logged in from */
 103         char cs_addr[64];       /* address logged in from */
 104
 105         /* The Internet type of thing */
 106         char cs_inet_email[SIZ];/* Return address of outbound Internet mail */
 107
 108         FILE *download_fp;      /* Fields relating to file transfer */
 109         FILE *upload_fp;
 110         char upl_file[PATH_MAX];
 111         char upl_path[PATH_MAX];
 112         char upl_comment[SIZ];
 113         char upl_filedir[PATH_MAX];
 114         char dl_is_net;
 115         char upload_type;
 116
 117         /* Beginning of cryptography - session nonce */
 118         char cs_nonce[NONCE_SIZE];      /* The nonce for this session's next auth transaction */
 119
 120         /* Redirect this session's output to somewhere else? */
 121         FILE *redirect_fp;
 122         int redirect_sock;
 123 #ifdef HAVE_OPENSSL
 124         SSL *ssl;
 125         int redirect_ssl;
 126 #endif
 127
 128         int buffering;
 129         char *output_buffer;    /* hold output for one big dump */
 130         int buffer_len;
 131
 132         /* A linked list of all instant messages sent to us. */
 133         struct ExpressMessage *FirstExpressMessage;
 134         int disable_exp;        /* Set to 1 to disable incoming pages */
 135         int newmail;            /* Other sessions increment this */
 136
 137         /* Masquerade... */
 138         char fake_username[USERNAME_SIZE];      /* Fake username <bc> */
 139         char fake_postname[USERNAME_SIZE];      /* Fake postname <bc> */
 140         char fake_hostname[64];                 /* Fake hostname <bc> */
 141         char fake_roomname[ROOMNAMELEN];        /* Fake roomname <bc> */
 142
 143         char preferred_formats[SIZ];            /* Preferred MIME formats */
 144
 145         /* Dynamically allocated session data */
 146         struct CtdlSessData *FirstSessData;
 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 extern struct CitContext *ContextList;
 176 extern int ScheduledShutdown;
 177 extern struct CitControl CitControl;
 178
 179
 180 struct ExpressMessage {
 181         struct ExpressMessage *next;
 182         time_t timestamp;       /* When this message was sent */
 183         unsigned flags;         /* Special instructions */
 184         char sender[64];        /* Name of sending user */
 185         char *text;             /* Message text (if applicable) */
 186 };
 187
 188 #define EM_BROADCAST    1       /* Broadcast message */
 189 #define EM_GO_AWAY      2       /* Server requests client log off */
 190 #define EM_CHAT         4       /* Server requests client enter chat */
 191
 192 struct ChatLine {
 193         struct ChatLine *next;
 194         int chat_seq;
 195         time_t chat_time;
 196         char chat_text[SIZ];
 197         char chat_username[USERNAME_SIZE];
 198         char chat_room[ROOMNAMELEN];
 199 };
 200
 201 /*
 202  * Various things we need to lock and unlock
 203  */
 204 enum {
 205         S_USERS,
 206         S_ROOMS,
 207         S_SESSION_TABLE,
 208         S_FLOORTAB,
 209         S_CHATQUEUE,
 210         S_CONTROL,
 211         S_DATABASE,
 212         S_NETDB,
 213         S_SUPPMSGMAIN,
 214         S_I_WANNA_SELECT,
 215         S_CONFIG,
 216         S_WORKER_LIST,
 217         S_HOUSEKEEPING,
 218         S_NTTLIST,
 219         S_DIRECTORY,
 220         S_NETCONFIGS,
 221         S_PUBLIC_CLIENTS,
 222         S_LDAP,
 223         S_FLOORCACHE,
 224         S_DEBUGMEMLEAKS,
 225         MAX_SEMAPHORES
 226 };
 227
 228
 229 /*
 230  * Upload types
 231  */
 232 #define UPL_FILE        0
 233 #define UPL_NET         1
 234 #define UPL_IMAGE       2
 235
 236
 237 /*
 238  * message transfer formats
 239  */
 240 enum {
 241         MT_CITADEL,             /* Citadel proprietary */
 242         MT_RFC822,              /* RFC822 */
 243         MT_MIME,                /* MIME-formatted message */
 244         MT_DOWNLOAD             /* Download a component */
 245 };
 246
 247 /*
 248  * Message format types in the database
 249  */
 250 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 251 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 252 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 253
 254
 255 /*
 256  * Citadel DataBases (define one for each cdb we need to open)
 257  */
 258 enum {
 259         CDB_MSGMAIN,            /* message base                  */
 260         CDB_USERS,              /* user file                     */
 261         CDB_ROOMS,              /* room index                    */
 262         CDB_FLOORTAB,           /* floor index                   */
 263         CDB_MSGLISTS,           /* room message lists            */
 264         CDB_VISIT,              /* user/room relationships       */
 265         CDB_DIRECTORY,          /* address book directory        */
 266         CDB_USETABLE,           /* network use table             */
 267         MAXCDB                  /* total number of CDB's defined */
 268 };
 269
 270 struct cdbdata {
 271         size_t len;
 272         char *ptr;
 273 };
 274
 275
 276
 277 /* Structures and declarations for function hooks of various types */
 278
 279 struct LogFunctionHook {
 280         struct LogFunctionHook *next;
 281         int loglevel;
 282         void (*h_function_pointer) (char *);
 283 };
 284 extern struct LogFunctionHook *LogHookTable;
 285
 286 struct CleanupFunctionHook {
 287         struct CleanupFunctionHook *next;
 288         void (*h_function_pointer) (void);
 289 };
 290 extern struct CleanupFunctionHook *CleanupHookTable;
 291
 292
 293
 294
 295 /*
 296  * SessionFunctionHook extensions are used for any type of hook for which
 297  * the context in which it's being called (which is determined by the event
 298  * type) will make it obvious for the hook function to know where to look for
 299  * pertinent data.
 300  */
 301 struct SessionFunctionHook {
 302         struct SessionFunctionHook *next;
 303         void (*h_function_pointer) (void);
 304         int eventtype;
 305 };
 306 extern struct SessionFunctionHook *SessionHookTable;
 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
 321 #define EVT_TIMER       50      /* Timer events are called once per minute
 322                                    and are not tied to any session */
 323
 324 /*
 325  * UserFunctionHook extensions are used for any type of hook which implements
 326  * an operation on a user or username (potentially) other than the one
 327  * operating the current session.
 328  */
 329 struct UserFunctionHook {
 330         struct UserFunctionHook *next;
 331         void (*h_function_pointer) (struct ctdluser *usbuf);
 332         int eventtype;
 333 };
 334 extern struct UserFunctionHook *UserHookTable;
 335
 336 #define EVT_PURGEUSER   100     /* Deleting a user */
 337 #define EVT_NEWUSER     102     /* Creating a user */
 338
 339 /*
 340  * MessageFunctionHook extensions are used for hooks which implement handlers
 341  * for various types of message operations (save, read, etc.)
 342  */
 343 struct MessageFunctionHook {
 344         struct MessageFunctionHook *next;
 345         int (*h_function_pointer) (struct CtdlMessage *msg);
 346         int eventtype;
 347 };
 348 extern struct MessageFunctionHook *MessageHookTable;
 349
 350 #define EVT_BEFOREREAD  200
 351 #define EVT_BEFORESAVE  201
 352 #define EVT_AFTERSAVE   202
 353 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
 354
 355
 356
 357 /*
 358  * NetprocFunctionHook extensions are used for hooks which implement handlers
 359  * for incoming network messages.
 360  */
 361 struct NetprocFunctionHook {
 362         struct NetprocFunctionHook *next;
 363         int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
 364 };
 365 extern struct NetprocFunctionHook *NetprocHookTable;
 366
 367
 368 /*
 369  * DeleteFunctionHook extensions are used for hooks which get called when a
 370  * message is about to be deleted.
 371  */
 372 struct DeleteFunctionHook {
 373         struct DeleteFunctionHook *next;
 374         void (*h_function_pointer) (char *target_room, long msgnum);
 375 };
 376 extern struct DeleteFunctionHook *DeleteHookTable;
 377
 378
 379 /*
 380  * ExpressMessageFunctionHook extensions are used for hooks which implement
 381  * the sending of an instant message through various channels.  Any function
 382  * registered should return the number of recipients to whom the message was
 383  * successfully transmitted.
 384  */
 385 struct XmsgFunctionHook {
 386         struct XmsgFunctionHook *next;
 387         int (*h_function_pointer) (char *, char *, char *);
 388         int order;
 389 };
 390 extern struct XmsgFunctionHook *XmsgHookTable;
 391
 392 /* Priority levels for paging functions (lower is better) */
 393 enum {
 394         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 395         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 396         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 397         MAX_XMSG_PRI
 398 };
 399
 400
 401
 402 /*
 403  * ServiceFunctionHook extensions are used for hooks which implement various
 404  * non-Citadel services (on TCP protocols) directly in the Citadel server.
 405  */
 406 struct ServiceFunctionHook {
 407         struct ServiceFunctionHook *next;
 408         int tcp_port;
 409         char *sockpath;
 410         void (*h_greeting_function) (void) ;
 411         void (*h_command_function) (void) ;
 412         int msock;
 413 };
 414 extern struct ServiceFunctionHook *ServiceHookTable;
 415
 416
 417
 418 /* Defines the relationship of a user to a particular room */
 419 struct visit {
 420         long v_roomnum;
 421         long v_roomgen;
 422         long v_usernum;
 423         long v_lastseen;
 424         unsigned int v_flags;
 425         char v_seen[SIZ];
 426         char v_answered[SIZ];
 427         int v_view;
 428 };
 429
 430 #define V_FORGET        1       /* User has zapped this room        */
 431 #define V_LOCKOUT       2       /* User is locked out of this room  */
 432 #define V_ACCESS        4       /* Access is granted to this room   */
 433
 434
 435 /* Supplementary data for a message on disk
 436  * (These are kept separately from the message itself because they are
 437  * fields whose values may change at some point after the message is saved.)
 438  */
 439 struct MetaData {
 440         long meta_msgnum;       /* Message number in *local* message base */
 441         int meta_refcount;      /* Number of rooms which point to this msg */
 442         char meta_content_type[64];
 443         /* more stuff will be added to this record in the future */
 444 };
 445
 446
 447 /*
 448  * Serialization routines use this struct to return a pointer and a length
 449  */
 450 struct ser_ret {
 451         size_t len;
 452         char *ser;
 453 };
 454
 455
 456 /* Preferred field order */
 457 /*               **********                     Important fields */
 458 /*                         ***************      Semi-important fields */
 459 /*                                        *     Message text (MUST be last) */
 460 #define FORDER  "IPTAFONHRDBCEGJKLQSVWXYZUM"
 461
 462 #endif /* SERVER_H */