citadel/server.h

   1 /* $Id$ */
   2
   3 /* Uncomment this if you want to track memory leaks.
   4  * This incurs some overhead, so don't use it unless you're debugging the code!
   5  */
   6 /* #define DEBUG_MEMORY_LEAKS */
   7
   8 /*
   9  * New format for a message in memory
  10  */
  11
  12 #ifndef SERVER_H
  13 #define SERVER_H
  14
  15 #ifdef __GNUC__
  16 #define INLINE inline
  17 #else
  18 #define INLINE
  19 #endif
  20
  21 #ifdef __CYGWIN__
  22
  23 #ifdef IN_LIBCIT
  24 #define DLEXP __declspec(dllexport)
  25 #else
  26 #define DLEXP __declspec(dllimport)
  27 #endif
  28
  29 #else
  30 #define DLEXP
  31
  32 #endif /* __CYGWIN__ */
  33
  34 #include "citadel.h"
  35 #ifdef HAVE_OPENSSL
  36 #include <openssl/ssl.h>
  37 #endif
  38
  39 #define CTDLMESSAGE_MAGIC               0x159d
  40 struct CtdlMessage {
  41         int cm_magic;                   /* Self-check */
  42         char cm_anon_type;              /* Anonymous or author-visible */
  43         char cm_format_type;            /* Format type */
  44         char *cm_fields[256];           /* Data fields */
  45         unsigned int cm_flags;          /* How to handle (NOT SAVED TO DISK) */
  46 };
  47
  48 #define CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
  49
  50
  51 /*
  52  * Generic per-session variable or data structure storage
  53  */
  54 struct CtdlSessData {
  55         struct CtdlSessData *next;
  56         unsigned long sym_id;
  57         void *sym_data;
  58 };
  59
  60 /*
  61  * Static user data symbol types
  62  */
  63 enum {
  64         SYM_DESIRED_SECTION,            /* Used by the MIME parser */
  65         SYM_MA_INFO,                    /* Handles multipart/alternative */
  66         SYM_REPL,                       /* Used for replication checking */
  67         SYM_MAX
  68 };
  69
  70
  71 /*
  72  * Here's the big one... the Citadel context structure.
  73  *
  74  * This structure keeps track of all information relating to a running
  75  * session on the server.  We keep one of these for each session thread.
  76  *
  77  * Note that the first element is "*next" so that it may be used without
  78  * modification in a linked list.
  79  */
  80 struct CitContext {
  81         struct CitContext *next;        /* Link to next session in the list */
  82
  83         struct usersupp usersupp;       /* Database record buffers */
  84         struct quickroom quickroom;
  85
  86         int state;              /* thread state (see CON_ values below) */
  87         int kill_me;            /* Set to nonzero to flag for termination */
  88
  89         char curr_user[USERNAME_SIZE];  /* name of current user */
  90         int logged_in;          /* logged in */
  91         int internal_pgm;       /* authenticated as internal program */
  92         char temp[32];          /* temp file name */
  93         int nologin;            /* not allowed to log in */
  94         int is_local_socket;    /* set to 1 if client is on unix domain sock */
  95
  96         char net_node[32];      /* Is the client another Citadel server? */
  97         int client_socket;
  98         int cs_pid;             /* session ID */
  99         time_t cs_lastupdt;     /* time of last update */
 100         time_t lastcmd;         /* time of last command executed */
 101         time_t lastidle;        /* For computing idle time */
 102         char lastcmdname[5];    /* name of last command executed */
 103         unsigned cs_flags;      /* miscellaneous flags */
 104         void (*h_command_function) (void) ;     /* service command function */
 105         int is_async;           /* Nonzero if client accepts async msgs */
 106
 107         /* feeping creaturisms... */
 108         int cs_clientdev;       /* client developer ID */
 109         int cs_clienttyp;       /* client type code */
 110         int cs_clientver;       /* client version number */
 111         char cs_clientname[32]; /* name of client software */
 112         char cs_host[64];       /* host logged in from */
 113
 114         /* The Internet type of thing */
 115         char *cs_inet_email;    /* Return address of outbound Internet mail */
 116
 117         FILE *download_fp;      /* Fields relating to file transfer */
 118         FILE *upload_fp;
 119         char upl_file[SIZ];
 120         char upl_path[SIZ];
 121         char upl_comment[SIZ];
 122         char upl_filedir[SIZ];
 123         char dl_is_net;
 124         char upload_type;
 125
 126         /* Beginning of cryptography - session nonce */
 127         char cs_nonce[NONCE_SIZE];      /* The nonce for this session's next auth transaction */
 128
 129         /* Redirect this session's output to somewhere else? */
 130         FILE *redirect_fp;
 131         int redirect_sock;
 132 #ifdef HAVE_OPENSSL
 133         SSL *ssl;
 134         int redirect_ssl;
 135 #endif
 136
 137         /* A linked list of all express messages sent to us. */
 138         struct ExpressMessage *FirstExpressMessage;
 139         int disable_exp;        /* Set to 1 to disable incoming pages */
 140         int newmail;            /* Other sessions increment this */
 141
 142         /* Masquerade... */
 143         char fake_username[USERNAME_SIZE];      /* Fake username <bc> */
 144         char fake_postname[USERNAME_SIZE];      /* Fake postname <bc> */
 145         char fake_hostname[64];                 /* Fake hostname <bc> */
 146         char fake_roomname[ROOMNAMELEN];        /* Fake roomname <bc> */
 147
 148         char preferred_formats[SIZ];            /* Preferred MIME formats */
 149
 150         /* Dynamically allocated session data */
 151         struct CtdlSessData *FirstSessData;
 152 };
 153
 154 typedef struct CitContext t_context;
 155
 156 /* Values for CitContext.state */
 157 enum {
 158         CON_IDLE,               /* This context is doing nothing */
 159         CON_EXECUTING           /* This context is bound to a thread */
 160 };
 161
 162
 163 #define CS_STEALTH      1       /* stealth mode */
 164 #define CS_CHAT         2       /* chat mode */
 165 #define CS_POSTING      4       /* Posting */
 166
 167 struct CitContext *MyContext(void);
 168 #define CC ((struct CitContext *)MyContext())
 169
 170 extern DLEXP struct CitContext *ContextList;
 171 extern DLEXP int ScheduledShutdown;
 172 extern DLEXP struct CitControl CitControl;
 173
 174
 175 struct ExpressMessage {
 176         struct ExpressMessage *next;
 177         time_t timestamp;       /* When this message was sent */
 178         unsigned flags;         /* Special instructions */
 179         char sender[64];        /* Name of sending user */
 180         char *text;             /* Message text (if applicable) */
 181 };
 182
 183 #define EM_BROADCAST    1       /* Broadcast message */
 184 #define EM_GO_AWAY      2       /* Server requests client log off */
 185 #define EM_CHAT         4       /* Server requests client enter chat */
 186
 187 struct ChatLine {
 188         struct ChatLine *next;
 189         int chat_seq;
 190         time_t chat_time;
 191         char chat_text[SIZ];
 192         char chat_username[USERNAME_SIZE];
 193         char chat_room[ROOMNAMELEN];
 194 };
 195
 196 /*
 197  * Various things we need to lock and unlock
 198  */
 199 enum {
 200         S_USERSUPP,
 201         S_QUICKROOM,
 202         S_SESSION_TABLE,
 203         S_FLOORTAB,
 204         S_CHATQUEUE,
 205         S_CONTROL,
 206         S_DATABASE,
 207         S_NETDB,
 208         S_SUPPMSGMAIN,
 209         S_I_WANNA_SELECT,
 210         S_CONFIG,
 211         S_WORKER_LIST,
 212         S_HOUSEKEEPING,
 213         S_NTTLIST,
 214         S_DIRECTORY,
 215         S_NETCONFIGS,
 216         MAX_SEMAPHORES
 217 };
 218
 219
 220 /*
 221  * Upload types
 222  */
 223 #define UPL_FILE        0
 224 #define UPL_NET         1
 225 #define UPL_IMAGE       2
 226
 227
 228 /*
 229  * message transfer formats
 230  */
 231 enum {
 232         MT_CITADEL,             /* Citadel proprietary */
 233         MT_RFC822,              /* RFC822 */
 234         MT_MIME,                /* MIME-formatted message */
 235         MT_DOWNLOAD             /* Download a component */
 236 };
 237
 238 /*
 239  * Message format types in the database
 240  */
 241 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 242 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 243 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 244
 245
 246 /*
 247  * Citadel DataBases (define one for each cdb we need to open)
 248  */
 249 enum {
 250         CDB_MSGMAIN,            /* message base                  */
 251         CDB_USERSUPP,           /* user file                     */
 252         CDB_QUICKROOM,          /* room index                    */
 253         CDB_FLOORTAB,           /* floor index                   */
 254         CDB_MSGLISTS,           /* room message lists            */
 255         CDB_VISIT,              /* user/room relationships       */
 256         CDB_DIRECTORY,          /* address book directory        */
 257         CDB_USETABLE,           /* network use table             */
 258         MAXCDB                  /* total number of CDB's defined */
 259 };
 260
 261 struct cdbdata {
 262         size_t len;
 263         char *ptr;
 264 };
 265
 266
 267
 268 /* Structures and declarations for function hooks of various types */
 269
 270 struct LogFunctionHook {
 271         struct LogFunctionHook *next;
 272         int loglevel;
 273         void (*h_function_pointer) (char *);
 274 };
 275 extern DLEXP struct LogFunctionHook *LogHookTable;
 276
 277 struct CleanupFunctionHook {
 278         struct CleanupFunctionHook *next;
 279         void (*h_function_pointer) (void);
 280 };
 281 extern DLEXP struct CleanupFunctionHook *CleanupHookTable;
 282
 283
 284
 285
 286 /*
 287  * SessionFunctionHook extensions are used for any type of hook for which
 288  * the context in which it's being called (which is determined by the event
 289  * type) will make it obvious for the hook function to know where to look for
 290  * pertinent data.
 291  */
 292 struct SessionFunctionHook {
 293         struct SessionFunctionHook *next;
 294         void (*h_function_pointer) (void);
 295         int eventtype;
 296 };
 297 extern DLEXP struct SessionFunctionHook *SessionHookTable;
 298
 299 /*
 300  * Event types can't be enum'ed, because they must remain consistent between
 301  * builds (to allow for binary modules built somewhere else)
 302  */
 303 #define EVT_STOP        0       /* Session is terminating */
 304 #define EVT_START       1       /* Session is starting */
 305 #define EVT_LOGIN       2       /* A user is logging in */
 306 #define EVT_NEWROOM     3       /* Changing rooms */
 307 #define EVT_LOGOUT      4       /* A user is logging out */
 308 #define EVT_SETPASS     5       /* Setting or changing password */
 309 #define EVT_CMD         6       /* Called after each server command */
 310 #define EVT_RWHO        7       /* An RWHO command is being executed */
 311
 312 #define EVT_TIMER       50      /* Timer events are called once per minute
 313                                    and are not tied to any session */
 314
 315 /*
 316  * UserFunctionHook extensions are used for any type of hook which implements
 317  * an operation on a user or username (potentially) other than the one
 318  * operating the current session.
 319  */
 320 struct UserFunctionHook {
 321         struct UserFunctionHook *next;
 322         void (*h_function_pointer) (char *username, long usernum);
 323         int eventtype;
 324 };
 325 extern DLEXP struct UserFunctionHook *UserHookTable;
 326
 327 #define EVT_PURGEUSER   100     /* Deleting a user */
 328 #define EVT_OUTPUTMSG   101     /* Outputting a message */
 329
 330 /*
 331  * MessageFunctionHook extensions are used for hooks which implement handlers
 332  * for various types of message operations (save, read, etc.)
 333  */
 334 struct MessageFunctionHook {
 335         struct MessageFunctionHook *next;
 336         int (*h_function_pointer) (struct CtdlMessage *msg);
 337         int eventtype;
 338 };
 339 extern DLEXP struct MessageFunctionHook *MessageHookTable;
 340
 341 #define EVT_BEFOREREAD  200
 342 #define EVT_BEFORESAVE  201
 343 #define EVT_AFTERSAVE   202
 344 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
 345
 346
 347
 348 /*
 349  * NetprocFunctionHook extensions are used for hooks which implement handlers
 350  * for incoming network messages.
 351  */
 352 struct NetprocFunctionHook {
 353         struct NetprocFunctionHook *next;
 354         int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
 355 };
 356 extern DLEXP struct NetprocFunctionHook *NetprocHookTable;
 357
 358
 359 /*
 360  * DeleteFunctionHook extensions are used for hooks which get called when a
 361  * message is about to be deleted.
 362  */
 363 struct DeleteFunctionHook {
 364         struct DeleteFunctionHook *next;
 365         void (*h_function_pointer) (char *target_room, long msgnum);
 366 };
 367 extern DLEXP struct DeleteFunctionHook *DeleteHookTable;
 368
 369
 370 /*
 371  * ExpressMessageFunctionHook extensions are used for hooks which implement
 372  * the sending of an express message through various channels.  Any function
 373  * registered should return the number of recipients to whom the message was
 374  * successfully transmitted.
 375  */
 376 struct XmsgFunctionHook {
 377         struct XmsgFunctionHook *next;
 378         int (*h_function_pointer) (char *, char *, char *);
 379         int order;
 380 };
 381 extern DLEXP struct XmsgFunctionHook *XmsgHookTable;
 382
 383 /* Priority levels for paging functions (lower is better) */
 384 enum {
 385         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 386         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 387         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 388         MAX_XMSG_PRI
 389 };
 390
 391
 392
 393 /*
 394  * ServiceFunctionHook extensions are used for hooks which implement various
 395  * non-Citadel services (on TCP protocols) directly in the Citadel server.
 396  */
 397 struct ServiceFunctionHook {
 398         struct ServiceFunctionHook *next;
 399         int tcp_port;
 400         char *sockpath;
 401         void (*h_greeting_function) (void) ;
 402         void (*h_command_function) (void) ;
 403         int msock;
 404 };
 405 extern DLEXP struct ServiceFunctionHook *ServiceHookTable;
 406
 407
 408
 409 /* Defines the relationship of a user to a particular room */
 410 struct visit {
 411         long v_roomnum;
 412         long v_roomgen;
 413         long v_usernum;
 414         long v_lastseen;
 415         unsigned int v_flags;
 416         char v_seen[SIZ];
 417         int v_view;
 418 };
 419
 420 #define V_FORGET        1       /* User has zapped this room        */
 421 #define V_LOCKOUT       2       /* User is locked out of this room  */
 422 #define V_ACCESS        4       /* Access is granted to this room   */
 423
 424 #define UA_KNOWN                2
 425 #define UA_GOTOALLOWED          4
 426 #define UA_HASNEWMSGS           8
 427 #define UA_ZAPPED               16
 428
 429
 430 /* Supplementary data for a message on disk
 431  * (These are kept separately from the message itself because they are
 432  * fields whose values may change at some point after the message is saved.)
 433  */
 434 struct MetaData {
 435         long meta_msgnum;       /* Message number in *local* message base */
 436         int meta_refcount;      /* Number of rooms which point to this msg */
 437         char meta_content_type[64];
 438         /* more stuff will be added to this record in the future */
 439 };
 440
 441
 442
 443 /* Built-in debuggable stuff for checking for memory leaks */
 444 #ifdef DEBUG_MEMORY_LEAKS
 445
 446 #define mallok(howbig)          tracked_malloc(howbig, __FILE__, __LINE__)
 447 #define phree(whichptr)                 tracked_free(whichptr)
 448 #define reallok(whichptr,howbig)        tracked_realloc(whichptr,howbig)
 449 #define strdoop(orig)           tracked_strdup(orig, __FILE__, __LINE__)
 450
 451 void *tracked_malloc(size_t, char *, int);
 452 void tracked_free(void *);
 453 void *tracked_realloc(void *, size_t);
 454 void dump_tracked(void);
 455 char *tracked_strdup(const char *, char *, int);
 456
 457 struct TheHeap {
 458         struct TheHeap *next;
 459         char h_file[32];
 460         int h_line;
 461         void *h_ptr;
 462 };
 463
 464 extern DLEXP struct TheHeap *heap;
 465
 466 #else
 467
 468 #define mallok(howbig)                  malloc(howbig)
 469 #define phree(whichptr)                 free(whichptr)
 470 #define reallok(whichptr,howbig)        realloc(whichptr,howbig)
 471 #define strdoop(orig)                   strdup(orig)
 472
 473
 474 #endif
 475
 476
 477 /*
 478  * Serialization routines use this struct to return a pointer and a length
 479  */
 480 struct ser_ret {
 481         size_t len;
 482         char *ser;
 483 };
 484
 485
 486 /* Preferred field order */
 487 /*               **********                     Important fields */
 488 /*                         ***************      Semi-important fields */
 489 /*                                        *     Message text (MUST be last) */
 490 #define FORDER  "IPTAFONHRDBCEGJKLQSUVWXYZM"
 491
 492 #endif /* SERVER_H */