]> code.citadel.org Git - citadel.git/blobdiff - citadel/server.h
* The scheduler can now "wake up" a session to deliver async messages.
[citadel.git] / citadel / server.h
index d5090ee0e10d507a1c6084eed6d1db828bbd30b8..06ed9b84660d88b76125c087f6555d11ac7a362a 100644 (file)
@@ -1,19 +1,11 @@
 /* $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 */
-
-/*
- * New format for a message in memory
- */
 
 #ifndef SERVER_H
 #define SERVER_H
 
 #ifdef __GNUC__
-#define INLINE inline
+#define INLINE __inline__
 #else
 #define INLINE
 #endif
 #include <openssl/ssl.h>
 #endif
 
-#define        CTDLMESSAGE_MAGIC               0x159d
+/*
+ * New format for a message in memory
+ */
 struct CtdlMessage {
-       int cm_magic;                   /* Self-check */
+       int cm_magic;                   /* Self-check (NOT SAVED TO DISK) */
        char cm_anon_type;              /* Anonymous or author-visible */
        char cm_format_type;            /* Format type */
        char *cm_fields[256];           /* Data fields */
        unsigned int cm_flags;          /* How to handle (NOT SAVED TO DISK) */
 };
 
+#define        CTDLMESSAGE_MAGIC               0x159d
 #define        CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
 
 
@@ -45,12 +40,20 @@ struct CtdlSessData {
 };
 
 /*
- * Static user data symbol types
+ * 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
 };
 
@@ -67,8 +70,8 @@ enum {
 struct CitContext {
        struct CitContext *next;        /* Link to next session in the list */
 
-       struct user user;       /* Database record buffers */
-       struct room room;
+       struct ctdluser user;   /* Database record buffers */
+       struct ctdlroom room;
 
        int state;              /* thread state (see CON_ values below) */
        int kill_me;            /* Set to nonzero to flag for termination */
@@ -89,7 +92,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 */
@@ -97,6 +103,7 @@ struct CitContext {
        int cs_clientver;       /* client version number */
        char cs_clientname[32]; /* name of client software */
        char cs_host[64];       /* host logged in from */
+       char cs_addr[64];       /* address logged in from */
 
        /* The Internet type of thing */
        char cs_inet_email[SIZ];/* Return address of outbound Internet mail */
@@ -121,7 +128,11 @@ struct CitContext {
        int redirect_ssl;
 #endif
 
-       /* A linked list of all express messages sent to us. */
+       int buffering;
+       char *output_buffer;    /* hold output for one big dump */
+       int buffer_len;
+
+       /* 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 */
@@ -140,10 +151,20 @@ struct CitContext {
 
 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_EXECUTING           /* This context is bound to a thread */
+       CON_READY,              /* This context needs attention */
+       CON_EXECUTING,          /* This context is bound to a thread */
 };
 
 
@@ -184,8 +205,8 @@ struct ChatLine {
  * Various things we need to lock and unlock
  */
 enum {
-       S_USERSUPP,
-       S_QUICKROOM,
+       S_USERS,
+       S_ROOMS,
        S_SESSION_TABLE,
        S_FLOORTAB,
        S_CHATQUEUE,
@@ -200,6 +221,10 @@ enum {
        S_NTTLIST,
        S_DIRECTORY,
        S_NETCONFIGS,
+       S_PUBLIC_CLIENTS,
+       S_LDAP,
+       S_FLOORCACHE,
+       S_DEBUGMEMLEAKS,
        MAX_SEMAPHORES
 };
 
@@ -235,8 +260,8 @@ enum {
  */
 enum {
        CDB_MSGMAIN,            /* message base                  */
-       CDB_USERSUPP,           /* user file                     */
-       CDB_QUICKROOM,          /* room index                    */
+       CDB_USERS,              /* user file                     */
+       CDB_ROOMS,              /* room index                    */
        CDB_FLOORTAB,           /* floor index                   */
        CDB_MSGLISTS,           /* room message lists            */
        CDB_VISIT,              /* user/room relationships       */
@@ -295,6 +320,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 */
@@ -306,13 +332,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
@@ -356,7 +382,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.
  */
@@ -387,6 +413,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;
@@ -401,6 +428,7 @@ struct visit {
        long v_lastseen;
        unsigned int v_flags;
        char v_seen[SIZ];
+       char v_answered[SIZ];
        int v_view;
 };
 
@@ -421,41 +449,6 @@ struct MetaData {
 };
 
 
-
-/* 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
  */