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