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         char *SMTP_RECPS;
 129         char *SMTP_ROOMS;
 130         struct cit_ical *CIT_ICAL;              /* calendaring data */
 131         struct ma_info *ma;                     /* multipart/alternative data */
 132 };
 133
 134 typedef struct CitContext t_context;
 135
 136 /*
 137  * Values for CitContext.state
 138  *
 139  * A session that is doing nothing is in CON_IDLE state.  When activity
 140  * is detected on the socket, it goes to CON_READY, indicating that it
 141  * needs to have a worker thread bound to it.  When a thread binds to
 142  * the session, it goes to CON_EXECUTING and does its thing.  When the
 143  * transaction is finished, the thread sets it back to CON_IDLE and lets
 144  * it go.
 145  */
 146 enum {
 147         CON_IDLE,               /* This context is doing nothing */
 148         CON_READY,              /* This context needs attention */
 149         CON_EXECUTING           /* This context is bound to a thread */
 150 };
 151
 152
 153 #define CS_STEALTH      1       /* stealth mode */
 154 #define CS_CHAT         2       /* chat mode */
 155 #define CS_POSTING      4       /* Posting */
 156
 157 struct CitContext *MyContext(void);
 158 #define CC MyContext()
 159
 160 extern struct CitContext *ContextList;
 161 extern int ScheduledShutdown;
 162 extern struct CitControl CitControl;
 163
 164
 165 struct ExpressMessage {
 166         struct ExpressMessage *next;
 167         time_t timestamp;       /* When this message was sent */
 168         unsigned flags;         /* Special instructions */
 169         char sender[64];        /* Name of sending user */
 170         char *text;             /* Message text (if applicable) */
 171 };
 172
 173 #define EM_BROADCAST    1       /* Broadcast message */
 174 #define EM_GO_AWAY      2       /* Server requests client log off */
 175 #define EM_CHAT         4       /* Server requests client enter chat */
 176
 177 struct ChatLine {
 178         struct ChatLine *next;
 179         int chat_seq;
 180         time_t chat_time;
 181         char chat_text[SIZ];
 182         char chat_username[USERNAME_SIZE];
 183         char chat_room[ROOMNAMELEN];
 184 };
 185
 186 /*
 187  * Various things we need to lock and unlock
 188  */
 189 enum {
 190         S_USERS,
 191         S_ROOMS,
 192         S_SESSION_TABLE,
 193         S_FLOORTAB,
 194         S_CHATQUEUE,
 195         S_CONTROL,
 196         S_NETDB,
 197         S_SUPPMSGMAIN,
 198         S_CONFIG,
 199         S_WORKER_LIST,
 200         S_HOUSEKEEPING,
 201         S_NTTLIST,
 202         S_DIRECTORY,
 203         S_NETCONFIGS,
 204         S_PUBLIC_CLIENTS,
 205         S_LDAP,
 206         S_FLOORCACHE,
 207         S_DEBUGMEMLEAKS,
 208         MAX_SEMAPHORES
 209 };
 210
 211
 212 /*
 213  * Upload types
 214  */
 215 #define UPL_FILE        0
 216 #define UPL_NET         1
 217 #define UPL_IMAGE       2
 218
 219
 220 /*
 221  * message transfer formats
 222  */
 223 enum {
 224         MT_CITADEL,             /* Citadel proprietary */
 225         MT_RFC822,              /* RFC822 */
 226         MT_MIME,                /* MIME-formatted message */
 227         MT_DOWNLOAD             /* Download a component */
 228 };
 229
 230 /*
 231  * Message format types in the database
 232  */
 233 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 234 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 235 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 236
 237
 238 /*
 239  * Citadel DataBases (define one for each cdb we need to open)
 240  */
 241 enum {
 242         CDB_MSGMAIN,            /* message base                  */
 243         CDB_USERS,              /* user file                     */
 244         CDB_ROOMS,              /* room index                    */
 245         CDB_FLOORTAB,           /* floor index                   */
 246         CDB_MSGLISTS,           /* room message lists            */
 247         CDB_VISIT,              /* user/room relationships       */
 248         CDB_DIRECTORY,          /* address book directory        */
 249         CDB_USETABLE,           /* network use table             */
 250         CDB_BIGMSGS,            /* larger message bodies         */
 251         MAXCDB                  /* total number of CDB's defined */
 252 };
 253
 254 struct cdbdata {
 255         size_t len;
 256         char *ptr;
 257 };
 258
 259
 260
 261 /* Structures and declarations for function hooks of various types */
 262
 263 struct LogFunctionHook {
 264         struct LogFunctionHook *next;
 265         int loglevel;
 266         void (*h_function_pointer) (char *);
 267 };
 268 extern struct LogFunctionHook *LogHookTable;
 269
 270 struct CleanupFunctionHook {
 271         struct CleanupFunctionHook *next;
 272         void (*h_function_pointer) (void);
 273 };
 274 extern struct CleanupFunctionHook *CleanupHookTable;
 275
 276
 277
 278
 279 /*
 280  * SessionFunctionHook extensions are used for any type of hook for which
 281  * the context in which it's being called (which is determined by the event
 282  * type) will make it obvious for the hook function to know where to look for
 283  * pertinent data.
 284  */
 285 struct SessionFunctionHook {
 286         struct SessionFunctionHook *next;
 287         void (*h_function_pointer) (void);
 288         int eventtype;
 289 };
 290 extern struct SessionFunctionHook *SessionHookTable;
 291
 292 /*
 293  * Event types can't be enum'ed, because they must remain consistent between
 294  * builds (to allow for binary modules built somewhere else)
 295  */
 296 #define EVT_STOP        0       /* Session is terminating */
 297 #define EVT_START       1       /* Session is starting */
 298 #define EVT_LOGIN       2       /* A user is logging in */
 299 #define EVT_NEWROOM     3       /* Changing rooms */
 300 #define EVT_LOGOUT      4       /* A user is logging out */
 301 #define EVT_SETPASS     5       /* Setting or changing password */
 302 #define EVT_CMD         6       /* Called after each server command */
 303 #define EVT_RWHO        7       /* An RWHO command is being executed */
 304 #define EVT_ASYNC       8       /* Doing asynchronous messages */
 305
 306 #define EVT_TIMER       50      /* Timer events are called once per minute
 307                                    and are not tied to any session */
 308
 309 /*
 310  * UserFunctionHook extensions are used for any type of hook which implements
 311  * an operation on a user or username (potentially) other than the one
 312  * operating the current session.
 313  */
 314 struct UserFunctionHook {
 315         struct UserFunctionHook *next;
 316         void (*h_function_pointer) (struct ctdluser *usbuf);
 317         int eventtype;
 318 };
 319 extern struct UserFunctionHook *UserHookTable;
 320
 321 #define EVT_PURGEUSER   100     /* Deleting a user */
 322 #define EVT_NEWUSER     102     /* Creating a user */
 323
 324 /*
 325  * MessageFunctionHook extensions are used for hooks which implement handlers
 326  * for various types of message operations (save, read, etc.)
 327  */
 328 struct MessageFunctionHook {
 329         struct MessageFunctionHook *next;
 330         int (*h_function_pointer) (struct CtdlMessage *msg);
 331         int eventtype;
 332 };
 333 extern struct MessageFunctionHook *MessageHookTable;
 334
 335 #define EVT_BEFOREREAD  200
 336 #define EVT_BEFORESAVE  201
 337 #define EVT_AFTERSAVE   202
 338 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
 339
 340
 341
 342 /*
 343  * NetprocFunctionHook extensions are used for hooks which implement handlers
 344  * for incoming network messages.
 345  */
 346 struct NetprocFunctionHook {
 347         struct NetprocFunctionHook *next;
 348         int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
 349 };
 350 extern struct NetprocFunctionHook *NetprocHookTable;
 351
 352
 353 /*
 354  * DeleteFunctionHook extensions are used for hooks which get called when a
 355  * message is about to be deleted.
 356  */
 357 struct DeleteFunctionHook {
 358         struct DeleteFunctionHook *next;
 359         void (*h_function_pointer) (char *target_room, long msgnum);
 360 };
 361 extern struct DeleteFunctionHook *DeleteHookTable;
 362
 363
 364 /*
 365  * ExpressMessageFunctionHook extensions are used for hooks which implement
 366  * the sending of an instant message through various channels.  Any function
 367  * registered should return the number of recipients to whom the message was
 368  * successfully transmitted.
 369  */
 370 struct XmsgFunctionHook {
 371         struct XmsgFunctionHook *next;
 372         int (*h_function_pointer) (char *, char *, char *);
 373         int order;
 374 };
 375 extern struct XmsgFunctionHook *XmsgHookTable;
 376
 377 /* Priority levels for paging functions (lower is better) */
 378 enum {
 379         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 380         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 381         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 382         MAX_XMSG_PRI
 383 };
 384
 385
 386
 387 /*
 388  * ServiceFunctionHook extensions are used for hooks which implement various
 389  * non-Citadel services (on TCP protocols) directly in the Citadel server.
 390  */
 391 struct ServiceFunctionHook {
 392         struct ServiceFunctionHook *next;
 393         int tcp_port;
 394         char *sockpath;
 395         void (*h_greeting_function) (void) ;
 396         void (*h_command_function) (void) ;
 397         void (*h_async_function) (void) ;
 398         int msock;
 399 };
 400 extern struct ServiceFunctionHook *ServiceHookTable;
 401
 402
 403
 404 /* Defines the relationship of a user to a particular room */
 405 struct visit {
 406         long v_roomnum;
 407         long v_roomgen;
 408         long v_usernum;
 409         long v_lastseen;
 410         unsigned int v_flags;
 411         char v_seen[SIZ];
 412         char v_answered[SIZ];
 413         int v_view;
 414 };
 415
 416 #define V_FORGET        1       /* User has zapped this room        */
 417 #define V_LOCKOUT       2       /* User is locked out of this room  */
 418 #define V_ACCESS        4       /* Access is granted to this room   */
 419
 420
 421 /* Supplementary data for a message on disk
 422  * These are kept separate from the message itself for one of two reasons:
 423  * 1. Either their values may change at some point after initial save, or
 424  * 2. They are merely caches of data which exist somewhere else, for speed.
 425  */
 426 struct MetaData {
 427         long meta_msgnum;               /* Message number in *local* message base */
 428         int meta_refcount;              /* Number of rooms pointing to this msg */
 429         char meta_content_type[64];     /* Cached MIME content-type */
 430         long meta_rfc822_length;        /* Cache of RFC822-translated msg length */
 431 };
 432
 433
 434 /*
 435  * Serialization routines use this struct to return a pointer and a length
 436  */
 437 struct ser_ret {
 438         size_t len;
 439         unsigned char *ser;
 440 };
 441
 442
 443 /* Preferred field order */
 444 /*               **********                     Important fields */
 445 /*                         ***************      Semi-important fields */
 446 /*                                        *     Message text (MUST be last) */
 447 #define FORDER  "IPTAFONHRDBCEGJKLQSVWXYZUM"
 448
 449 #endif /* SERVER_H */