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         int curr_view;          /* The view type for the current user/room */
  86
  87         char net_node[PATH_MAX];/* Is the client another Citadel server? */
  88         int client_socket;
  89         int cs_pid;             /* session ID */
  90         time_t lastcmd;         /* time of last command executed */
  91         time_t lastidle;        /* For computing idle time */
  92         time_t previous_login;  /* Date/time of previous login */
  93         char lastcmdname[5];    /* name of last command executed */
  94         unsigned cs_flags;      /* miscellaneous flags */
  95         void (*h_command_function) (void) ;     /* service command function */
  96         void (*h_async_function) (void) ;       /* do async msgs function */
  97         int is_async;           /* Nonzero if client accepts async msgs */
  98         int async_waiting;      /* Nonzero if there are async msgs waiting */
  99         int input_waiting;      /* Nonzero if there is client input waiting */
 100
 101         /* feeping creaturisms... */
 102         int cs_clientdev;       /* client developer ID */
 103         int cs_clienttyp;       /* client type code */
 104         int cs_clientver;       /* client version number */
 105         char cs_clientname[32]; /* name of client software */
 106         char cs_host[64];       /* host logged in from */
 107         char cs_addr[64];       /* address logged in from */
 108
 109         /* The Internet type of thing */
 110         char cs_inet_email[SIZ];/* Return address of outbound Internet mail */
 111
 112         FILE *download_fp;      /* Fields relating to file transfer */
 113         FILE *upload_fp;
 114         char upl_file[PATH_MAX];
 115         char upl_path[PATH_MAX];
 116         char upl_comment[SIZ];
 117         char upl_filedir[PATH_MAX];
 118         char dl_is_net;
 119         char upload_type;
 120
 121         /* Beginning of cryptography - session nonce */
 122         char cs_nonce[NONCE_SIZE];      /* The nonce for this session's next auth transaction */
 123
 124         /* Redirect this session's output to somewhere else? */
 125         FILE *redirect_fp;
 126         int redirect_sock;
 127 #ifdef HAVE_OPENSSL
 128         SSL *ssl;
 129         int redirect_ssl;
 130 #endif
 131
 132         int buffering;
 133         char *output_buffer;    /* hold output for one big dump */
 134         int buffer_len;
 135
 136         /* A linked list of all instant messages sent to us. */
 137         struct ExpressMessage *FirstExpressMessage;
 138         int disable_exp;        /* Set to 1 to disable incoming pages */
 139         int newmail;            /* Other sessions increment this */
 140
 141         /* Masquerade... */
 142         char fake_username[USERNAME_SIZE];      /* Fake username <bc> */
 143         char fake_postname[USERNAME_SIZE];      /* Fake postname <bc> */
 144         char fake_hostname[64];                 /* Fake hostname <bc> */
 145         char fake_roomname[ROOMNAMELEN];        /* Fake roomname <bc> */
 146
 147         char preferred_formats[SIZ];            /* Preferred MIME formats */
 148
 149         /* Dynamically allocated session data */
 150         struct CtdlSessData *FirstSessData;
 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 extern struct CitContext *ContextList;
 180 extern int ScheduledShutdown;
 181 extern struct CitControl CitControl;
 182
 183
 184 struct ExpressMessage {
 185         struct ExpressMessage *next;
 186         time_t timestamp;       /* When this message was sent */
 187         unsigned flags;         /* Special instructions */
 188         char sender[64];        /* Name of sending user */
 189         char *text;             /* Message text (if applicable) */
 190 };
 191
 192 #define EM_BROADCAST    1       /* Broadcast message */
 193 #define EM_GO_AWAY      2       /* Server requests client log off */
 194 #define EM_CHAT         4       /* Server requests client enter chat */
 195
 196 struct ChatLine {
 197         struct ChatLine *next;
 198         int chat_seq;
 199         time_t chat_time;
 200         char chat_text[SIZ];
 201         char chat_username[USERNAME_SIZE];
 202         char chat_room[ROOMNAMELEN];
 203 };
 204
 205 /*
 206  * Various things we need to lock and unlock
 207  */
 208 enum {
 209         S_USERS,
 210         S_ROOMS,
 211         S_SESSION_TABLE,
 212         S_FLOORTAB,
 213         S_CHATQUEUE,
 214         S_CONTROL,
 215         S_NETDB,
 216         S_SUPPMSGMAIN,
 217         S_CONFIG,
 218         S_WORKER_LIST,
 219         S_HOUSEKEEPING,
 220         S_NTTLIST,
 221         S_DIRECTORY,
 222         S_NETCONFIGS,
 223         S_PUBLIC_CLIENTS,
 224         S_LDAP,
 225         S_FLOORCACHE,
 226         S_DEBUGMEMLEAKS,
 227         MAX_SEMAPHORES
 228 };
 229
 230
 231 /*
 232  * Upload types
 233  */
 234 #define UPL_FILE        0
 235 #define UPL_NET         1
 236 #define UPL_IMAGE       2
 237
 238
 239 /*
 240  * message transfer formats
 241  */
 242 enum {
 243         MT_CITADEL,             /* Citadel proprietary */
 244         MT_RFC822,              /* RFC822 */
 245         MT_MIME,                /* MIME-formatted message */
 246         MT_DOWNLOAD             /* Download a component */
 247 };
 248
 249 /*
 250  * Message format types in the database
 251  */
 252 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 253 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 254 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 255
 256
 257 /*
 258  * Citadel DataBases (define one for each cdb we need to open)
 259  */
 260 enum {
 261         CDB_MSGMAIN,            /* message base                  */
 262         CDB_USERS,              /* user file                     */
 263         CDB_ROOMS,              /* room index                    */
 264         CDB_FLOORTAB,           /* floor index                   */
 265         CDB_MSGLISTS,           /* room message lists            */
 266         CDB_VISIT,              /* user/room relationships       */
 267         CDB_DIRECTORY,          /* address book directory        */
 268         CDB_USETABLE,           /* network use table             */
 269         CDB_BIGMSGS,            /* larger message bodies         */
 270         MAXCDB                  /* total number of CDB's defined */
 271 };
 272
 273 struct cdbdata {
 274         size_t len;
 275         char *ptr;
 276 };
 277
 278
 279
 280 /* Structures and declarations for function hooks of various types */
 281
 282 struct LogFunctionHook {
 283         struct LogFunctionHook *next;
 284         int loglevel;
 285         void (*h_function_pointer) (char *);
 286 };
 287 extern struct LogFunctionHook *LogHookTable;
 288
 289 struct CleanupFunctionHook {
 290         struct CleanupFunctionHook *next;
 291         void (*h_function_pointer) (void);
 292 };
 293 extern struct CleanupFunctionHook *CleanupHookTable;
 294
 295
 296
 297
 298 /*
 299  * SessionFunctionHook extensions are used for any type of hook for which
 300  * the context in which it's being called (which is determined by the event
 301  * type) will make it obvious for the hook function to know where to look for
 302  * pertinent data.
 303  */
 304 struct SessionFunctionHook {
 305         struct SessionFunctionHook *next;
 306         void (*h_function_pointer) (void);
 307         int eventtype;
 308 };
 309 extern struct SessionFunctionHook *SessionHookTable;
 310
 311 /*
 312  * Event types can't be enum'ed, because they must remain consistent between
 313  * builds (to allow for binary modules built somewhere else)
 314  */
 315 #define EVT_STOP        0       /* Session is terminating */
 316 #define EVT_START       1       /* Session is starting */
 317 #define EVT_LOGIN       2       /* A user is logging in */
 318 #define EVT_NEWROOM     3       /* Changing rooms */
 319 #define EVT_LOGOUT      4       /* A user is logging out */
 320 #define EVT_SETPASS     5       /* Setting or changing password */
 321 #define EVT_CMD         6       /* Called after each server command */
 322 #define EVT_RWHO        7       /* An RWHO command is being executed */
 323 #define EVT_ASYNC       8       /* Doing asynchronous messages */
 324
 325 #define EVT_TIMER       50      /* Timer events are called once per minute
 326                                    and are not tied to any session */
 327
 328 /*
 329  * UserFunctionHook extensions are used for any type of hook which implements
 330  * an operation on a user or username (potentially) other than the one
 331  * operating the current session.
 332  */
 333 struct UserFunctionHook {
 334         struct UserFunctionHook *next;
 335         void (*h_function_pointer) (struct ctdluser *usbuf);
 336         int eventtype;
 337 };
 338 extern struct UserFunctionHook *UserHookTable;
 339
 340 #define EVT_PURGEUSER   100     /* Deleting a user */
 341 #define EVT_NEWUSER     102     /* Creating a user */
 342
 343 /*
 344  * MessageFunctionHook extensions are used for hooks which implement handlers
 345  * for various types of message operations (save, read, etc.)
 346  */
 347 struct MessageFunctionHook {
 348         struct MessageFunctionHook *next;
 349         int (*h_function_pointer) (struct CtdlMessage *msg);
 350         int eventtype;
 351 };
 352 extern struct MessageFunctionHook *MessageHookTable;
 353
 354 #define EVT_BEFOREREAD  200
 355 #define EVT_BEFORESAVE  201
 356 #define EVT_AFTERSAVE   202
 357 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
 358
 359
 360
 361 /*
 362  * NetprocFunctionHook extensions are used for hooks which implement handlers
 363  * for incoming network messages.
 364  */
 365 struct NetprocFunctionHook {
 366         struct NetprocFunctionHook *next;
 367         int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
 368 };
 369 extern struct NetprocFunctionHook *NetprocHookTable;
 370
 371
 372 /*
 373  * DeleteFunctionHook extensions are used for hooks which get called when a
 374  * message is about to be deleted.
 375  */
 376 struct DeleteFunctionHook {
 377         struct DeleteFunctionHook *next;
 378         void (*h_function_pointer) (char *target_room, long msgnum);
 379 };
 380 extern struct DeleteFunctionHook *DeleteHookTable;
 381
 382
 383 /*
 384  * ExpressMessageFunctionHook extensions are used for hooks which implement
 385  * the sending of an instant message through various channels.  Any function
 386  * registered should return the number of recipients to whom the message was
 387  * successfully transmitted.
 388  */
 389 struct XmsgFunctionHook {
 390         struct XmsgFunctionHook *next;
 391         int (*h_function_pointer) (char *, char *, char *);
 392         int order;
 393 };
 394 extern struct XmsgFunctionHook *XmsgHookTable;
 395
 396 /* Priority levels for paging functions (lower is better) */
 397 enum {
 398         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 399         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 400         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 401         MAX_XMSG_PRI
 402 };
 403
 404
 405
 406 /*
 407  * ServiceFunctionHook extensions are used for hooks which implement various
 408  * non-Citadel services (on TCP protocols) directly in the Citadel server.
 409  */
 410 struct ServiceFunctionHook {
 411         struct ServiceFunctionHook *next;
 412         int tcp_port;
 413         char *sockpath;
 414         void (*h_greeting_function) (void) ;
 415         void (*h_command_function) (void) ;
 416         void (*h_async_function) (void) ;
 417         int msock;
 418 };
 419 extern struct ServiceFunctionHook *ServiceHookTable;
 420
 421
 422
 423 /* Defines the relationship of a user to a particular room */
 424 struct visit {
 425         long v_roomnum;
 426         long v_roomgen;
 427         long v_usernum;
 428         long v_lastseen;
 429         unsigned int v_flags;
 430         char v_seen[SIZ];
 431         char v_answered[SIZ];
 432         int v_view;
 433 };
 434
 435 #define V_FORGET        1       /* User has zapped this room        */
 436 #define V_LOCKOUT       2       /* User is locked out of this room  */
 437 #define V_ACCESS        4       /* Access is granted to this room   */
 438
 439
 440 /* Supplementary data for a message on disk
 441  * (These are kept separately from the message itself because they are
 442  * fields whose values may change at some point after the message is saved.)
 443  */
 444 struct MetaData {
 445         long meta_msgnum;       /* Message number in *local* message base */
 446         int meta_refcount;      /* Number of rooms which point to this msg */
 447         char meta_content_type[64];
 448         /* more stuff will be added to this record in the future */
 449 };
 450
 451
 452 /*
 453  * Serialization routines use this struct to return a pointer and a length
 454  */
 455 struct ser_ret {
 456         size_t len;
 457         unsigned char *ser;
 458 };
 459
 460
 461 /* Preferred field order */
 462 /*               **********                     Important fields */
 463 /*                         ***************      Semi-important fields */
 464 /*                                        *     Message text (MUST be last) */
 465 #define FORDER  "IPTAFONHRDBCEGJKLQSVWXYZUM"
 466
 467 #endif /* SERVER_H */