]> code.citadel.org Git - citadel.git/blobdiff - citadel/server.h
* Finished removing all the "dynamic session data" stuff in order to
[citadel.git] / citadel / server.h
index b83a8079a3e881d59efd300206094bfd55e03b73..32362acf7f166d88e96a3c086565d8b3a24cdcef 100644 (file)
@@ -1,22 +1,18 @@
 /* $Id$ */
 
-/* Uncomment this if you want to track memory leaks.
- * This incurs some overhead, so don't use it unless you're debugging the code!
- */
-/* #define DEBUG_MEMORY_LEAKS */
-
 
 #ifndef SERVER_H
 #define SERVER_H
 
 #ifdef __GNUC__
-#define INLINE inline
+#define INLINE __inline__
 #else
 #define INLINE
 #endif
 
 #include "citadel.h"
 #ifdef HAVE_OPENSSL
+#define OPENSSL_NO_KRB5                /* work around redhat b0rken ssl headers */
 #include <openssl/ssl.h>
 #endif
 
@@ -35,34 +31,6 @@ struct CtdlMessage {
 #define        CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
 
 
-/*
- * 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.  Server extensions can ask for dynamic
- * extensions to per-session data, but the symbol ID has to be listed here.
- */
-enum {
-       SYM_DESIRED_SECTION,            /* Used by the MIME parser */
-       SYM_MA_INFO,                    /* Handles multipart/alternative */
-       SYM_REPL,                       /* Used for replication checking */
-       SYM_CIT_ICAL,                   /* Used by the calendar service */
-       SYM_IMAP,                       /* Used by the IMAP service */
-       SYM_POP3,                       /* Used by the POP3 service */
-       SYM_SMTP,                       /* Used by the SMTP service */
-       SYM_SMTP_RECPS,
-       SYM_SMTP_ROOMS,
-       SYM_VCARD,                      /* vCard handling requires this */
-       SYM_MAX
-};
-
-
 /*
  * Here's the big one... the Citadel context structure.
  *
@@ -73,6 +41,7 @@ enum {
  * modification in a linked list.
  */
 struct CitContext {
+       struct CitContext *prev;        /* Link to previous session in list */
        struct CitContext *next;        /* Link to next session in the list */
 
        struct ctdluser user;   /* Database record buffers */
@@ -87,6 +56,7 @@ struct CitContext {
        char temp[PATH_MAX];    /* temp file name */
        int nologin;            /* not allowed to log in */
        int is_local_socket;    /* set to 1 if client is on unix domain sock */
+       int curr_view;          /* The view type for the current user/room */
 
        char net_node[PATH_MAX];/* Is the client another Citadel server? */
        int client_socket;
@@ -97,7 +67,10 @@ struct CitContext {
        char lastcmdname[5];    /* name of last command executed */
        unsigned cs_flags;      /* miscellaneous flags */
        void (*h_command_function) (void) ;     /* service command function */
+       void (*h_async_function) (void) ;       /* do async msgs function */
        int is_async;           /* Nonzero if client accepts async msgs */
+       int async_waiting;      /* Nonzero if there are async msgs waiting */
+       int input_waiting;      /* Nonzero if there is client input waiting */
 
        /* feeping creaturisms... */
        int cs_clientdev;       /* client developer ID */
@@ -111,6 +84,7 @@ struct CitContext {
        char cs_inet_email[SIZ];/* Return address of outbound Internet mail */
 
        FILE *download_fp;      /* Fields relating to file transfer */
+       char download_desired_section[128];
        FILE *upload_fp;
        char upl_file[PATH_MAX];
        char upl_path[PATH_MAX];
@@ -123,8 +97,10 @@ struct CitContext {
        char cs_nonce[NONCE_SIZE];      /* The nonce for this session's next auth transaction */
 
        /* Redirect this session's output to somewhere else? */
-       FILE *redirect_fp;
-       int redirect_sock;
+       FILE *redirect_fp;              /* a file instead (will go away) */
+       char *redirect_buffer;          /* the buffer */
+       size_t redirect_len;            /* length of data in buffer */
+       size_t redirect_alloc;          /* length of allocated buffer */
 #ifdef HAVE_OPENSSL
        SSL *ssl;
        int redirect_ssl;
@@ -134,7 +110,7 @@ struct CitContext {
        char *output_buffer;    /* hold output for one big dump */
        int buffer_len;
 
-       /* A linked list of all express messages sent to us. */
+       /* A linked list of all instant messages sent to us. */
        struct ExpressMessage *FirstExpressMessage;
        int disable_exp;        /* Set to 1 to disable incoming pages */
        int newmail;            /* Other sessions increment this */
@@ -148,14 +124,30 @@ struct CitContext {
        char preferred_formats[SIZ];            /* Preferred MIME formats */
 
        /* Dynamically allocated session data */
-       struct CtdlSessData *FirstSessData;
+       struct citimap *IMAP;
+       struct citpop3 *POP3;
+       struct citsmtp *SMTP;
+       char *SMTP_RECPS;
+       char *SMTP_ROOMS;
+       struct cit_ical *CIT_ICAL;              /* calendaring data */
+       struct ma_info *ma;                     /* multipart/alternative data */
 };
 
 typedef struct CitContext t_context;
 
-/* Values for CitContext.state */
+/*
+ * Values for CitContext.state
+ * 
+ * A session that is doing nothing is in CON_IDLE state.  When activity
+ * is detected on the socket, it goes to CON_READY, indicating that it
+ * needs to have a worker thread bound to it.  When a thread binds to
+ * the session, it goes to CON_EXECUTING and does its thing.  When the
+ * transaction is finished, the thread sets it back to CON_IDLE and lets
+ * it go.
+ */
 enum {
        CON_IDLE,               /* This context is doing nothing */
+       CON_READY,              /* This context needs attention */
        CON_EXECUTING           /* This context is bound to a thread */
 };
 
@@ -203,10 +195,8 @@ enum {
        S_FLOORTAB,
        S_CHATQUEUE,
        S_CONTROL,
-       S_DATABASE,
        S_NETDB,
        S_SUPPMSGMAIN,
-       S_I_WANNA_SELECT,
        S_CONFIG,
        S_WORKER_LIST,
        S_HOUSEKEEPING,
@@ -214,6 +204,9 @@ enum {
        S_DIRECTORY,
        S_NETCONFIGS,
        S_PUBLIC_CLIENTS,
+       S_LDAP,
+       S_FLOORCACHE,
+       S_DEBUGMEMLEAKS,
        MAX_SEMAPHORES
 };
 
@@ -256,6 +249,7 @@ enum {
        CDB_VISIT,              /* user/room relationships       */
        CDB_DIRECTORY,          /* address book directory        */
        CDB_USETABLE,           /* network use table             */
+       CDB_BIGMSGS,            /* larger message bodies         */
        MAXCDB                  /* total number of CDB's defined */
 };
 
@@ -309,6 +303,7 @@ extern struct SessionFunctionHook *SessionHookTable;
 #define EVT_SETPASS    5       /* Setting or changing password */
 #define EVT_CMD                6       /* Called after each server command */
 #define EVT_RWHO       7       /* An RWHO command is being executed */
+#define EVT_ASYNC      8       /* Doing asynchronous messages */
 
 #define EVT_TIMER      50      /* Timer events are called once per minute
                                   and are not tied to any session */
@@ -320,13 +315,13 @@ extern struct SessionFunctionHook *SessionHookTable;
  */
 struct UserFunctionHook {
        struct UserFunctionHook *next;
-       void (*h_function_pointer) (char *username, long usernum);
+       void (*h_function_pointer) (struct ctdluser *usbuf);
        int eventtype;
 };
 extern struct UserFunctionHook *UserHookTable;
 
 #define EVT_PURGEUSER  100     /* Deleting a user */
-#define EVT_OUTPUTMSG  101     /* Outputting a message */
+#define EVT_NEWUSER    102     /* Creating a user */
 
 /*
  * MessageFunctionHook extensions are used for hooks which implement handlers
@@ -370,7 +365,7 @@ extern struct DeleteFunctionHook *DeleteHookTable;
 
 /*
  * ExpressMessageFunctionHook extensions are used for hooks which implement
- * the sending of an express message through various channels.  Any function
+ * the sending of an instant message through various channels.  Any function
  * registered should return the number of recipients to whom the message was
  * successfully transmitted.
  */
@@ -401,6 +396,7 @@ struct ServiceFunctionHook {
        char *sockpath;
        void (*h_greeting_function) (void) ;
        void (*h_command_function) (void) ;
+       void (*h_async_function) (void) ;
        int msock;
 };
 extern struct ServiceFunctionHook *ServiceHookTable;
@@ -425,58 +421,24 @@ struct visit {
 
 
 /* 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.)
+ * These are kept separate from the message itself for one of two reasons:
+ * 1. Either their values may change at some point after initial save, or
+ * 2. They are merely caches of data which exist somewhere else, for speed.
  */
 struct MetaData {
-       long meta_msgnum;       /* Message number in *local* message base */
-       int meta_refcount;      /* Number of rooms which point to this msg */
-       char meta_content_type[64];
-       /* more stuff will be added to this record in the future */
+       long meta_msgnum;               /* Message number in *local* message base */
+       int meta_refcount;              /* Number of rooms pointing to this msg */
+       char meta_content_type[64];     /* Cached MIME content-type */
+       long meta_rfc822_length;        /* Cache of RFC822-translated msg length */
 };
 
 
-
-/* Built-in debuggable stuff for checking for memory leaks */
-#ifdef DEBUG_MEMORY_LEAKS
-
-#define mallok(howbig)         tracked_malloc(howbig, __FILE__, __LINE__)
-#define phree(whichptr)                        tracked_free(whichptr)
-#define reallok(whichptr,howbig)       tracked_realloc(whichptr,howbig)
-#define strdoop(orig)          tracked_strdup(orig, __FILE__, __LINE__)
-
-void *tracked_malloc(size_t, char *, int);
-void tracked_free(void *);
-void *tracked_realloc(void *, size_t);
-void dump_tracked(void);
-char *tracked_strdup(const char *, char *, int);
-
-struct TheHeap {
-       struct TheHeap *next;
-       char h_file[32];
-       int h_line;
-       void *h_ptr;
-};
-
-extern struct TheHeap *heap;
-
-#else
-
-#define mallok(howbig)                 malloc(howbig)
-#define phree(whichptr)                        free(whichptr)
-#define reallok(whichptr,howbig)       realloc(whichptr,howbig)
-#define strdoop(orig)                  strdup(orig)
-
-
-#endif
-
-
 /* 
  * Serialization routines use this struct to return a pointer and a length
  */
 struct ser_ret {
         size_t len;
-        char *ser;
+        unsigned char *ser;
 };