]> code.citadel.org Git - citadel.git/blobdiff - citadel/server.h
* Added a new message function hook type EVT_SMTPSCAN which permits modules to
[citadel.git] / citadel / server.h
index 61228feea1a988e6765a1c3ac6c1f0b4570ae763..127be4c9572fdfeb016ee487c81ed088c0a9b60d 100644 (file)
@@ -3,11 +3,39 @@
 /* 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
+/* #define DEBUG_MEMORY_LEAKS */
 
 /*
  * New format for a message in memory
  */
+
+#ifndef SERVER_H
+#define SERVER_H
+
+#ifdef __GNUC__
+#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
 struct CtdlMessage {
        int cm_magic;                   /* Self-check */
@@ -58,13 +86,14 @@ struct CitContext {
        int state;              /* thread state (see CON_ values below) */
        int kill_me;            /* Set to nonzero to flag for termination */
 
-       char curr_user[32];     /* name of current user */
+       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 */
        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];
+       char net_node[32];      /* Is the client another Citadel server? */
        int client_socket;
        int cs_pid;             /* session ID */
        time_t cs_lastupdt;     /* time of last update */
@@ -72,32 +101,51 @@ struct CitContext {
        time_t lastidle;        /* For computing idle time */
        char lastcmdname[5];    /* name of last command executed */
        unsigned cs_flags;      /* miscellaneous flags */
+       void (*h_command_function) (void) ;     /* service command function */
+       int is_async;           /* Nonzero if client accepts async msgs */
 
        /* 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 */
+
+       /* The Internet type of thing */
+       char *cs_inet_email;    /* Return address of outbound Internet mail */
 
        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 upl_file[SIZ];
+       char upl_path[SIZ];
+       char upl_comment[SIZ];
+       char upl_filedir[SIZ];
        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. */
        struct ExpressMessage *FirstExpressMessage;
+       int disable_exp;        /* Set to 1 to disable incoming pages */
+       int newmail;            /* Other sessions increment this */
 
-       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> */
+       /* Masquerade... */
+       char fake_username[USERNAME_SIZE];      /* Fake username <bc> */ 
+       char fake_postname[USERNAME_SIZE];      /* Fake postname <bc> */
+       char fake_hostname[64];                 /* Fake hostname <bc> */
+       char fake_roomname[ROOMNAMELEN];        /* Fake roomname <bc> */
 
-       int FloorBeingSearched; /* This is used by cmd_lrms() etc.   */
+       /* Dynamically allocated session data */
        struct CtdlSessData *FirstSessData;
 };
 
@@ -117,9 +165,9 @@ enum {
 struct CitContext *MyContext(void);
 #define CC ((struct CitContext *)MyContext())
 
-extern struct CitContext *ContextList;
-extern int ScheduledShutdown;
-extern struct CitControl CitControl;
+extern DLEXP struct CitContext *ContextList;
+extern DLEXP int ScheduledShutdown;
+extern DLEXP struct CitControl CitControl;
 
 
 struct ExpressMessage {
@@ -138,9 +186,9 @@ struct ChatLine {
        struct ChatLine *next;
        int chat_seq;
        time_t chat_time;
-       char chat_text[256];
-       char chat_room[20];
-       char chat_username[32];
+       char chat_text[SIZ];
+       char chat_username[USERNAME_SIZE];
+       char chat_room[ROOMNAMELEN];
 };
 
 /*
@@ -148,19 +196,20 @@ struct ChatLine {
  */
 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,
        S_I_WANNA_SELECT,
+       S_CONFIG,
+       S_WORKER_LIST,
+       S_HOUSEKEEPING,
+       S_NTTLIST,
+       S_DIRECTORY,
        MAX_SEMAPHORES
 };
 
@@ -183,6 +232,13 @@ enum {
        MT_DOWNLOAD             /* Download a component */
 };
 
+/*
+ * Message format types in the database
+ */
+#define        FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
+#define FMT_FIXED      1       /* Fixed format (proprietary)        */
+#define FMT_RFC822     4       /* Standard (headers are in M field) */
+
 
 /*
  * Citadel DataBases (define one for each cdb we need to open)
@@ -194,6 +250,8 @@ enum {
        CDB_FLOORTAB,           /* floor index                   */
        CDB_MSGLISTS,           /* room message lists            */
        CDB_VISIT,              /* user/room relationships       */
+       CDB_DIRECTORY,          /* address book directory        */
+       CDB_USETABLE,           /* network use table             */
        MAXCDB                  /* total number of CDB's defined */
 };
 
@@ -211,13 +269,13 @@ struct LogFunctionHook {
        int loglevel;
        void (*h_function_pointer) (char *);
 };
-extern struct LogFunctionHook *LogHookTable;
+extern DLEXP struct LogFunctionHook *LogHookTable;
 
 struct CleanupFunctionHook {
        struct CleanupFunctionHook *next;
        void (*h_function_pointer) (void);
 };
-extern struct CleanupFunctionHook *CleanupHookTable;
+extern DLEXP struct CleanupFunctionHook *CleanupHookTable;
 
 
 
@@ -233,7 +291,7 @@ struct SessionFunctionHook {
        void (*h_function_pointer) (void);
        int eventtype;
 };
-extern struct SessionFunctionHook *SessionHookTable;
+extern DLEXP struct SessionFunctionHook *SessionHookTable;
 
 /* 
  * Event types can't be enum'ed, because they must remain consistent between
@@ -248,9 +306,8 @@ extern struct SessionFunctionHook *SessionHookTable;
 #define EVT_CMD                6       /* Called after each server command */
 #define EVT_RWHO       7       /* An RWHO command is being executed */
 
-
-
-
+#define EVT_TIMER      50      /* Timer events are called once per minute
+                                  and are not tied to any session */
 
 /*
  * UserFunctionHook extensions are used for any type of hook which implements
@@ -262,12 +319,11 @@ struct UserFunctionHook {
        void (*h_function_pointer) (char *username, long usernum);
        int eventtype;
 };
-extern struct UserFunctionHook *UserHookTable;
+extern DLEXP struct UserFunctionHook *UserHookTable;
 
 #define EVT_PURGEUSER  100     /* Deleting a user */
 #define EVT_OUTPUTMSG  101     /* Outputting a message */
 
-
 /*
  * MessageFunctionHook extensions are used for hooks which implement handlers
  * for various types of message operations (save, read, etc.)
@@ -277,11 +333,35 @@ struct MessageFunctionHook {
        int (*h_function_pointer) (struct CtdlMessage *msg);
        int eventtype;
 };
-extern struct MessageFunctionHook *MessageHookTable;
+extern DLEXP 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 DLEXP 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 DLEXP struct DeleteFunctionHook *DeleteHookTable;
 
 
 /*
@@ -295,7 +375,7 @@ struct XmsgFunctionHook {
        int (*h_function_pointer) (char *, char *, char *);
        int order;
 };
-extern struct XmsgFunctionHook *XmsgHookTable;
+extern DLEXP struct XmsgFunctionHook *XmsgHookTable;
 
 /* Priority levels for paging functions (lower is better) */
 enum {
@@ -307,6 +387,20 @@ enum {
 
 
 
+/*
+ * ServiceFunctionHook extensions are used for hooks which implement various
+ * non-Citadel services (on TCP protocols) directly in the Citadel server.
+ */
+struct ServiceFunctionHook {
+       struct ServiceFunctionHook *next;
+       int tcp_port;
+       char *sockpath;
+       void (*h_greeting_function) (void) ;
+       void (*h_command_function) (void) ;
+       int msock;
+};
+extern DLEXP struct ServiceFunctionHook *ServiceHookTable;
+
 
 
 /* Defines the relationship of a user to a particular room */
@@ -316,6 +410,8 @@ struct visit {
        long v_usernum;
        long v_lastseen;
        unsigned int v_flags;
+       char v_seen[SIZ];
+       int v_view;
 };
 
 #define V_FORGET       1       /* User has zapped this room        */
@@ -332,10 +428,10 @@ struct visit {
  * (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;        /* Message number in *local* message base */
-       int smi_refcount;       /* Number of rooms which point to this msg */
-       char smi_content_type[64];
+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 */
 };
 
@@ -362,7 +458,7 @@ struct TheHeap {
        void *h_ptr;
 };
 
-extern struct TheHeap *heap;
+extern DLEXP struct TheHeap *heap;
 
 #else
 
@@ -385,7 +481,9 @@ struct ser_ret {
 
 
 /* Preferred field order */
-/*               *********                     Important fields */
-/*                        ****************     Semi-important fields */
+/*               **********                    Important fields */
+/*                         ***************     Semi-important fields */
 /*                                        *    Message text (MUST be last) */
-#define FORDER "IPTAONHRDBCEFGJKLQSUVWXYZM"
+#define FORDER "IPTAFONHRDBCEGJKLQSUVWXYZM"
+
+#endif /* SERVER_H */