]> code.citadel.org Git - citadel.git/blobdiff - citadel/server.h
Changes to dynloader et al to handle ICQ module being written
[citadel.git] / citadel / server.h
index 72fdb8b801827c7aa103443f6e281ebf17eebc8a..b815334423d3a7fe75d5932189b1f308f9206758 100644 (file)
@@ -2,14 +2,28 @@
 typedef pthread_t THREAD;
 
 /* Uncomment this if you want to track memory leaks.
- * (Don't do this unless you're a developer!)
+ * This incurs some overhead, so don't use it unless you're debugging the code!
  */
-/* #define DEBUG_MEMORY_LEAKS */
+#define DEBUG_MEMORY_LEAKS
+
+
+/*
+ * Generic per-session variable or data structure storage
+ */
+struct CtdlSessData {
+       struct CtdlSessData *next;
+       unsigned long sym_id;
+       void *sym_data;
+};
+
+/*
+ * Static user data symbol types
+ */
+enum {
+       SYM_DESIRED_SECTION,            /* Used by the MIME parser */
+       SYM_MAX
+};
 
-struct ExpressMessage {
-       struct ExpressMessage *next;
-       char em_text[300];
-       };
 
 /*
  * Here's the big one... the Citadel context structure.
@@ -23,65 +37,63 @@ struct ExpressMessage {
 struct CitContext {
        struct CitContext *next;        /* Link to next session in the list */
 
-        struct usersupp usersupp;      /* Database record buffers */
-        struct quickroom quickroom;
-       
+       struct usersupp usersupp;       /* Database record buffers */
+       struct quickroom quickroom;
+
        long *msglist;
        int num_msgs;
 
-        char curr_user[32];            /* name of current user */
-        int logged_in;                 /* logged in */
-        int internal_pgm;              /* authenticated as internal program */
-        char temp[32];                 /* temp file name */
-        int nologin;                   /* not allowed to log in */
+       char curr_user[32];     /* name of current user */
+       int logged_in;          /* logged in */
+       int internal_pgm;       /* authenticated as internal program */
+       char temp[32];          /* temp file name */
+       int nologin;            /* not allowed to log in */
 
-        char net_node[32];
+       char net_node[32];
        THREAD mythread;
+       int n_crit;             /* number of critical sections open */
        int client_socket;
-       struct ExpressMessage *FirstExpressMessage;
-       int cs_pid;                     /* session ID */
-       char cs_room[20];               /* current room */
-       time_t cs_lastupdt;             /* time of last update */
-       time_t lastcmd;                 /* time of last command executed */
-       time_t lastidle;                /* For computing idle time */
-       char lastcmdname[5];            /* name of last command executed */
-       unsigned cs_flags;              /* miscellaneous flags */
-
-                                       /* feeping creaturisms... */
-       int cs_clientdev;               /* client developer ID */
-       int cs_clienttyp;               /* client type code */
-       int cs_clientver;               /* client version number */
-       char cs_clientname[32];         /* name of client software */
-       char cs_host[25];               /* host logged in from */
-
-        FILE *download_fp;             /* Fields relating to file transfer */
-        FILE *upload_fp;
+       int cs_pid;             /* session ID */
+       char cs_room[ROOMNAMELEN];      /* current room */
+       time_t cs_lastupdt;     /* time of last update */
+       time_t lastcmd;         /* time of last command executed */
+       time_t lastidle;        /* For computing idle time */
+       char lastcmdname[5];    /* name of last command executed */
+       unsigned cs_flags;      /* miscellaneous flags */
+
+       /* feeping creaturisms... */
+       int cs_clientdev;       /* client developer ID */
+       int cs_clienttyp;       /* client type code */
+       int cs_clientver;       /* client version number */
+       char cs_clientname[32]; /* name of client software */
+       char cs_host[25];       /* host logged in from */
+
+       FILE *download_fp;      /* Fields relating to file transfer */
+       FILE *upload_fp;
        char upl_file[256];
        char upl_path[256];
        char upl_comment[256];
        char upl_filedir[256];
-       char chat_room[20];             /* The chat room */
+       char chat_room[20];     /* The chat room */
        char dl_is_net;
        char upload_type;
 
-       char ucache_name[32];           /* For a performance boost, we cache */
-       long ucache_pos;                /* the position of the last user rec */
-       char fake_username[32];         /* Fake username <bc>                */
-       char fake_postname[32];         /* Fake postname <bc>                */
-       char fake_hostname[25];         /* Name of the fake hostname <bc>    */
-       char fake_roomname[ROOMNAMELEN];/* Name of the fake room <bc>        */
-       char last_pager[32];            /* The username of the last pager    */
+       struct ExpressMessage *FirstExpressMessage;
 
-       int FloorBeingSearched;         /* This is used by cmd_lrms() etc.   */
+       char fake_username[32]; /* Fake username <bc>                */
+       char fake_postname[32]; /* Fake postname <bc>                */
+       char fake_hostname[25]; /* Name of the fake hostname <bc>    */
+       char fake_roomname[ROOMNAMELEN];        /* Name of the fake room <bc> */
 
-       int CtdlErrno;                  /* Error return for CitadelAPI calls */
-       };
+       int FloorBeingSearched; /* This is used by cmd_lrms() etc.   */
+       struct CtdlSessData *FirstSessData;
+};
 
 typedef struct CitContext t_context;
 
-#define CS_STEALTH     1               /* stealth mode */
-#define CS_CHAT                2               /* chat mode */
-#define CS_POSTING     4               /* Posting */
+#define CS_STEALTH     1       /* stealth mode */
+#define CS_CHAT                2       /* chat mode */
+#define CS_POSTING     4       /* Posting */
 
 struct CitContext *MyContext(void);
 #define CC ((struct CitContext *)MyContext())
@@ -90,6 +102,19 @@ extern struct CitContext *ContextList;
 extern int ScheduledShutdown;
 extern struct CitControl CitControl;
 
+
+struct ExpressMessage {
+       struct ExpressMessage *next;
+       time_t timestamp;       /* When this message was sent */
+       unsigned flags;         /* Special instructions */
+       char sender[64];        /* Name of sending user */
+       char *text;             /* Message text (if applicable) */
+};
+
+#define EM_BROADCAST   1       /* Broadcast message */
+#define EM_GO_AWAY     2       /* Server requests client log off */
+#define EM_CHAT                4       /* Server requests client enter chat */
+
 struct ChatLine {
        struct ChatLine *next;
        int chat_seq;
@@ -97,23 +122,27 @@ struct ChatLine {
        char chat_text[256];
        char chat_room[20];
        char chat_username[32];
-       };
+};
 
 /*
  * Various things we need to lock and unlock
  */
-#define S_USERSUPP     0
-#define S_USER_TRANS   1
-#define S_QUICKROOM    2
-#define S_MSGMAIN      3
-#define S_CALLLOG      4
-#define S_SESSION_TABLE        5
-#define S_FLOORTAB     6
-#define S_CHATQUEUE    7
-#define S_CONTROL      8
-#define S_HOUSEKEEPING 9
-#define S_DATABASE     10
-#define MAX_SEMAPHORES 11
+enum {
+       S_USERSUPP,
+       S_USER_TRANS,
+       S_QUICKROOM,
+       S_MSGMAIN,
+       S_CALLLOG,
+       S_SESSION_TABLE,
+       S_FLOORTAB,
+       S_CHATQUEUE,
+       S_CONTROL,
+       S_HOUSEKEEPING,
+       S_DATABASE,
+       S_NETDB,
+       S_SUPPMSGMAIN,
+       MAX_SEMAPHORES
+};
 
 
 /*
@@ -127,28 +156,33 @@ struct ChatLine {
 /*
  * message transfer formats
  */
-#define MT_CITADEL     0               /* Citadel proprietary */
-#define MT_DATE                1               /* We're only looking for the date */
-#define MT_RFC822      2               /* RFC822 */
-#define MT_RAW         3               /* IGnet raw format */
-#define MT_MIME                4               /* We're only looking for the date */
+enum {
+       MT_CITADEL,             /* Citadel proprietary */
+       MT_DATE,                /* We're only looking for the date */
+       MT_RFC822,              /* RFC822 */
+       MT_RAW,                 /* IGnet raw format */
+       MT_MIME,                /* MIME-formatted message */
+       MT_DOWNLOAD             /* Download a component */
+};
 
 
 /*
  * Citadel DataBases (define one for each cdb we need to open)
  */
-#define CDB_MSGMAIN    0       /* message base                  */
-#define CDB_USERSUPP   1       /* user file                     */
-#define CDB_QUICKROOM  2       /* room index                    */
-#define CDB_FLOORTAB   3       /* floor index                   */
-#define CDB_MSGLISTS   4       /* room message lists            */
-#define CDB_VISIT      5       /* user/room relationships       */
-#define MAXCDB         6       /* total number of CDB's defined */
+enum {
+       CDB_MSGMAIN,            /* message base                  */
+       CDB_USERSUPP,           /* user file                     */
+       CDB_QUICKROOM,          /* room index                    */
+       CDB_FLOORTAB,           /* floor index                   */
+       CDB_MSGLISTS,           /* room message lists            */
+       CDB_VISIT,              /* user/room relationships       */
+       MAXCDB                  /* total number of CDB's defined */
+};
 
 struct cdbdata {
        size_t len;
        char *ptr;
-       };
+};
 
 
 /* Structures and declarations for function hooks of various types */
@@ -157,13 +191,13 @@ struct LogFunctionHook {
        struct LogFunctionHook *next;
        int loglevel;
        void (*h_function_pointer) (char *);
-       };
+};
 extern struct LogFunctionHook *LogHookTable;
 
 struct CleanupFunctionHook {
        struct CleanupFunctionHook *next;
        void (*h_function_pointer) (void);
-       };
+};
 extern struct CleanupFunctionHook *CleanupHookTable;
 
 
@@ -177,15 +211,20 @@ struct SessionFunctionHook {
        struct SessionFunctionHook *next;
        void (*h_function_pointer) (void);
        int eventtype;
-       };
+};
 extern struct SessionFunctionHook *SessionHookTable;
 
+/* 
+ * Event types can't be enum'ed, because they must remain consistent between
+ * builds (to allow for binary modules built somewhere else)
+ */
 #define EVT_STOP       0       /* Session is terminating */
 #define EVT_START      1       /* Session is starting */
 #define EVT_LOGIN      2       /* A user is logging in */
 #define EVT_NEWROOM    3       /* Changing rooms */
 #define EVT_LOGOUT     4       /* A user is logging out */
 #define EVT_SETPASS    5       /* Setting or changing password */
+#define EVT_CMD                6       /* Called after each server command */
 
 
 /*
@@ -197,7 +236,7 @@ struct UserFunctionHook {
        struct UserFunctionHook *next;
        void (*h_function_pointer) (char *username, long usernum);
        int eventtype;
-       };
+};
 extern struct UserFunctionHook *UserHookTable;
 
 #define EVT_PURGEUSER  100     /* Deleting a user */
@@ -211,11 +250,11 @@ struct visit {
        long v_usernum;
        long v_lastseen;
        unsigned int v_flags;
-       };
+};
 
-#define V_FORGET       1               /* User has zapped this room        */
-#define V_LOCKOUT      2               /* User is locked out of this room  */
-#define V_ACCESS       4               /* Access is granted to this room   */
+#define V_FORGET       1       /* User has zapped this room        */
+#define V_LOCKOUT      2       /* User is locked out of this room  */
+#define V_ACCESS       4       /* Access is granted to this room   */
 
 #define UA_KNOWN                2
 #define UA_GOTOALLOWED          4
@@ -223,6 +262,17 @@ struct visit {
 #define UA_ZAPPED              16
 
 
+/* Supplementary data for a message on disk
+ * (These are kept separately from the message itself because they are
+ * fields whose values may change at some point after the message is saved.)
+ */
+struct SuppMsgInfo {
+       long smi_msgnum;        /* Redundant, but useful for self-check */
+       int smi_refcount;       /* Number of rooms which point to this msg */
+       /* more stuff will be added to this record in the future */
+};
+
+
 
 /* Built-in debuggable stuff for checking for memory leaks */
 #ifdef DEBUG_MEMORY_LEAKS
@@ -237,11 +287,11 @@ void *tracked_realloc(void *, size_t);
 void dump_tracked(void);
 
 struct TheHeap {
-        struct TheHeap *next;
-        char h_file[32];
-        int h_line;
-        void *h_ptr;
-        };
+       struct TheHeap *next;
+       char h_file[32];
+       int h_line;
+       void *h_ptr;
+};
 
 extern struct TheHeap *heap;