* Store the body of any large (>1K) message in a separate database. This
[citadel.git] / citadel / server.h
index cf2dc329a87067c99bbf64af0a252a46be83e82c..a8f072d37a6bf5c6c5b28991d6e9800c99688082 100644 (file)
@@ -1,47 +1,32 @@
 /* $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
 
-#ifdef __CYGWIN__
-
-#ifdef IN_LIBCIT
-#define DLEXP __declspec(dllexport)
-#else
-#define DLEXP __declspec(dllimport)
-#endif
-
-#else
-#define DLEXP
-
-#endif /* __CYGWIN__ */
-
 #include "citadel.h"
+#ifdef HAVE_OPENSSL
+#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 */
 
 
@@ -55,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
 };
 
@@ -77,8 +70,8 @@ enum {
 struct CitContext {
        struct CitContext *next;        /* Link to next session in the list */
 
-       struct usersupp usersupp;       /* Database record buffers */
-       struct quickroom quickroom;
+       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 */
@@ -86,64 +79,92 @@ struct CitContext {
        char curr_user[USERNAME_SIZE];  /* name of current user */
        int logged_in;          /* logged in */
        int internal_pgm;       /* authenticated as internal program */
-       char temp[32];          /* temp file name */
+       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 */
 
-       char net_node[32];      /* Is the client another Citadel server? */
+       char net_node[PATH_MAX];/* Is the client another Citadel server? */
        int client_socket;
        int cs_pid;             /* session ID */
-       time_t cs_lastupdt;     /* time of last update */
        time_t lastcmd;         /* time of last command executed */
        time_t lastidle;        /* For computing idle time */
+       time_t previous_login;  /* Date/time of previous login */
        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 */
        int cs_clienttyp;       /* client type code */
        int cs_clientver;       /* client version number */
        char cs_clientname[32]; /* name of client software */
-       char cs_host[26];       /* host logged in from */
+       char cs_host[64];       /* host logged in from */
+       char cs_addr[64];       /* address logged in from */
 
-       /* Beginning of cryptography - session nonce */
-       char cs_nonce[NONCE_SIZE];      /* The nonce for this session's next auth transaction */
+       /* The Internet type of thing */
+       char cs_inet_email[SIZ];/* Return address of outbound Internet mail */
 
        FILE *download_fp;      /* Fields relating to file transfer */
        FILE *upload_fp;
-       char upl_file[SIZ];
-       char upl_path[SIZ];
+       char upl_file[PATH_MAX];
+       char upl_path[PATH_MAX];
        char upl_comment[SIZ];
-       char upl_filedir[SIZ];
+       char upl_filedir[PATH_MAX];
        char dl_is_net;
        char upload_type;
 
+       /* Beginning of cryptography - session nonce */
+       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;
+#ifdef HAVE_OPENSSL
+       SSL *ssl;
+       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 */
 
        /* Masquerade... */
        char fake_username[USERNAME_SIZE];      /* Fake username <bc> */ 
        char fake_postname[USERNAME_SIZE];      /* Fake postname <bc> */
-       char fake_hostname[25];                 /* Fake hostname <bc> */
+       char fake_hostname[64];                 /* Fake hostname <bc> */
        char fake_roomname[ROOMNAMELEN];        /* Fake roomname <bc> */
 
+       char preferred_formats[SIZ];            /* Preferred MIME formats */
+
        /* Dynamically allocated session data */
        struct CtdlSessData *FirstSessData;
 };
 
 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 */
 };
 
 
@@ -152,11 +173,11 @@ enum {
 #define CS_POSTING     4       /* Posting */
 
 struct CitContext *MyContext(void);
-#define CC ((struct CitContext *)MyContext())
+#define CC MyContext()
 
-extern DLEXP struct CitContext *ContextList;
-extern DLEXP int ScheduledShutdown;
-extern DLEXP struct CitControl CitControl;
+extern struct CitContext *ContextList;
+extern int ScheduledShutdown;
+extern struct CitControl CitControl;
 
 
 struct ExpressMessage {
@@ -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,
@@ -198,6 +219,12 @@ enum {
        S_WORKER_LIST,
        S_HOUSEKEEPING,
        S_NTTLIST,
+       S_DIRECTORY,
+       S_NETCONFIGS,
+       S_PUBLIC_CLIENTS,
+       S_LDAP,
+       S_FLOORCACHE,
+       S_DEBUGMEMLEAKS,
        MAX_SEMAPHORES
 };
 
@@ -233,11 +260,14 @@ 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       */
+       CDB_DIRECTORY,          /* address book directory        */
+       CDB_USETABLE,           /* network use table             */
+       CDB_BIGMSGS,            /* larger message bodies         */
        MAXCDB                  /* total number of CDB's defined */
 };
 
@@ -255,13 +285,13 @@ struct LogFunctionHook {
        int loglevel;
        void (*h_function_pointer) (char *);
 };
-extern DLEXP struct LogFunctionHook *LogHookTable;
+extern struct LogFunctionHook *LogHookTable;
 
 struct CleanupFunctionHook {
        struct CleanupFunctionHook *next;
        void (*h_function_pointer) (void);
 };
-extern DLEXP struct CleanupFunctionHook *CleanupHookTable;
+extern struct CleanupFunctionHook *CleanupHookTable;
 
 
 
@@ -277,7 +307,7 @@ struct SessionFunctionHook {
        void (*h_function_pointer) (void);
        int eventtype;
 };
-extern DLEXP struct SessionFunctionHook *SessionHookTable;
+extern struct SessionFunctionHook *SessionHookTable;
 
 /* 
  * Event types can't be enum'ed, because they must remain consistent between
@@ -291,6 +321,7 @@ extern DLEXP 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 */
@@ -302,13 +333,13 @@ extern DLEXP 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 DLEXP struct UserFunctionHook *UserHookTable;
+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
@@ -319,16 +350,40 @@ struct MessageFunctionHook {
        int (*h_function_pointer) (struct CtdlMessage *msg);
        int eventtype;
 };
-extern DLEXP struct MessageFunctionHook *MessageHookTable;
+extern struct MessageFunctionHook *MessageHookTable;
 
 #define EVT_BEFOREREAD 200
 #define EVT_BEFORESAVE 201
 #define EVT_AFTERSAVE  202
+#define EVT_SMTPSCAN   203     /* called before submitting a msg from SMTP */
+
+
+
+/*
+ * NetprocFunctionHook extensions are used for hooks which implement handlers
+ * for incoming network messages.
+ */
+struct NetprocFunctionHook {
+       struct NetprocFunctionHook *next;
+       int (*h_function_pointer) (struct CtdlMessage *msg, char *target_room);
+};
+extern struct NetprocFunctionHook *NetprocHookTable;
+
+
+/*
+ * DeleteFunctionHook extensions are used for hooks which get called when a
+ * message is about to be deleted.
+ */
+struct DeleteFunctionHook {
+       struct DeleteFunctionHook *next;
+       void (*h_function_pointer) (char *target_room, long msgnum);
+};
+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.
  */
@@ -337,7 +392,7 @@ struct XmsgFunctionHook {
        int (*h_function_pointer) (char *, char *, char *);
        int order;
 };
-extern DLEXP struct XmsgFunctionHook *XmsgHookTable;
+extern struct XmsgFunctionHook *XmsgHookTable;
 
 /* Priority levels for paging functions (lower is better) */
 enum {
@@ -359,9 +414,10 @@ struct ServiceFunctionHook {
        char *sockpath;
        void (*h_greeting_function) (void) ;
        void (*h_command_function) (void) ;
+       void (*h_async_function) (void) ;
        int msock;
 };
-extern DLEXP struct ServiceFunctionHook *ServiceHookTable;
+extern struct ServiceFunctionHook *ServiceHookTable;
 
 
 
@@ -373,17 +429,14 @@ struct visit {
        long v_lastseen;
        unsigned int v_flags;
        char v_seen[SIZ];
+       char v_answered[SIZ];
+       int v_view;
 };
 
 #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
-#define UA_HASNEWMSGS           8
-#define UA_ZAPPED              16
-
 
 /* Supplementary data for a message on disk
  * (These are kept separately from the message itself because they are
@@ -393,46 +446,10 @@ 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];
-       char meta_mod;          /* Moderated to what level? */
        /* more stuff will be added to this record in the future */
 };
 
 
-
-/* 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 DLEXP 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
  */
@@ -446,6 +463,6 @@ struct ser_ret {
 /*               **********                    Important fields */
 /*                         ***************     Semi-important fields */
 /*                                        *    Message text (MUST be last) */
-#define FORDER "IPTAFONHRDBCEGJKLQSUVWXYZM"
+#define FORDER "IPTAFONHRDBCEGJKLQSVWXYZUM"
 
 #endif /* SERVER_H */