* modules registering serverports now need to specify a plaintext name.
[citadel.git] / citadel / server.h
index 8281869e162ae524189f86fa0fb06570ef33c30b..3913cee5885ec64b20f6ef841c1679b10fef7fed 100644 (file)
@@ -31,14 +31,27 @@ struct CtdlMessage {
 #define        CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
 
 
+
+/*
+ * Exit codes 101 through 109 are used for conditions in which
+ * we deliberately do NOT want the service to automatically
+ * restart.
+ */
+#define CTDLEXIT_CONFIG                101     /* Could not read citadel.config */
+#define CTDLEXIT_CONTROL       102     /* Could not acquire lock */
+#define CTDLEXIT_HOME          103     /* Citadel home directory not found */
+#define CTDLEXIT_OOD           104     /* Out Of Date config - rerun setup */
+#define CTDLEXIT_DB            105     /* Unable to initialize database */
+
+
+
+
 /*
  * Here's the big one... the Citadel context structure.
  *
  * This structure keeps track of all information relating to a running 
  * session on the server.  We keep one of these for each session thread.
  *
- * Note that the first element is "*next" so that it may be used without
- * modification in a linked list.
  */
 struct CitContext {
        struct CitContext *prev;        /* Link to previous session in list */
@@ -57,6 +70,7 @@ struct CitContext {
        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 */
+       int is_master;          /* Is this session logged in using the master user? */
 
        char net_node[32]       ;/* Is the client another Citadel server? */
        time_t previous_login;  /* Date/time of previous login */
@@ -68,7 +82,7 @@ struct CitContext {
        int async_waiting;      /* Nonzero if there are async msgs waiting */
        int input_waiting;      /* Nonzero if there is client input waiting */
 
-       /* feeping creaturisms... */
+       /* Client information */
        int cs_clientdev;       /* client developer ID */
        int cs_clienttyp;       /* client type code */
        int cs_clientver;       /* client version number */
@@ -77,7 +91,9 @@ struct CitContext {
        char cs_addr[64];       /* address logged in from */
 
        /* The Internet type of thing */
-       char cs_inet_email[128];/* Return address of outbound Internet mail */
+       char cs_inet_email[128];                /* Return address of outbound Internet mail */
+       char cs_inet_other_emails[1024];        /* User's other valid Internet email addresses */
+       char cs_inet_fn[128];                   /* Friendly-name of outbound Internet mail */
 
        FILE *download_fp;      /* Fields relating to file transfer */
        char download_desired_section[128];
@@ -113,11 +129,10 @@ struct CitContext {
        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[64];                 /* Fake hostname <bc> */
-       char fake_roomname[ROOMNAMELEN];        /* Fake roomname <bc> */
+       /* Masqueraded values in the 'who is online' list */
+       char fake_username[USERNAME_SIZE];
+       char fake_hostname[64];
+       char fake_roomname[ROOMNAMELEN];
 
        char preferred_formats[256];            /* Preferred MIME formats */
 
@@ -125,10 +140,10 @@ struct CitContext {
        struct citimap *IMAP;
        struct citpop3 *POP3;
        struct citsmtp *SMTP;
-       char *SMTP_RECPS;
-       char *SMTP_ROOMS;
+       struct citmgsve *MGSVE; /**< Managesieve Session struct */
        struct cit_ical *CIT_ICAL;              /* calendaring data */
        struct ma_info *ma;                     /* multipart/alternative data */
+       const char* ServiceName; /**< whats our actual purpose? */
 };
 
 typedef struct CitContext t_context;
@@ -218,6 +233,12 @@ enum {
        S_LDAP,
        S_FLOORCACHE,
        S_DEBUGMEMLEAKS,
+       S_ATBF,
+       S_JOURNAL_QUEUE,
+       S_RPLIST,
+       S_SIEVELIST,
+       S_CHKPWD,
+       S_LOG,
        MAX_SEMAPHORES
 };
 
@@ -237,7 +258,8 @@ enum {
        MT_CITADEL,             /* Citadel proprietary */
        MT_RFC822,              /* RFC822 */
        MT_MIME,                /* MIME-formatted message */
-       MT_DOWNLOAD             /* Download a component */
+       MT_DOWNLOAD,            /* Download a component */
+       MT_SPEW_SECTION         /* Download a component in a single operation */
 };
 
 /*
@@ -261,6 +283,8 @@ enum {
        CDB_DIRECTORY,          /* address book directory        */
        CDB_USETABLE,           /* network use table             */
        CDB_BIGMSGS,            /* larger message bodies         */
+       CDB_FULLTEXT,           /* full text search index        */
+       CDB_EUIDINDEX,          /* locate msgs by EUID           */
        MAXCDB                  /* total number of CDB's defined */
 };
 
@@ -286,6 +310,12 @@ struct CleanupFunctionHook {
 };
 extern struct CleanupFunctionHook *CleanupHookTable;
 
+struct FixedOutputHook {
+       struct FixedOutputHook *next;
+       char content_type[64];
+       void (*h_function_pointer) (char *, int);
+};
+extern struct FixedOutputHook *FixedOutputTable;
 
 
 
@@ -318,7 +348,7 @@ extern struct SessionFunctionHook *SessionHookTable;
 
 #define EVT_TIMER      50      /* Timer events are called once per minute
                                   and are not tied to any session */
-
+#define EVT_HOUSE      51      /* as needed houskeeping stuff */
 /*
  * UserFunctionHook extensions are used for any type of hook which implements
  * an operation on a user or username (potentially) other than the one
@@ -351,7 +381,6 @@ extern struct MessageFunctionHook *MessageHookTable;
 #define EVT_SMTPSCAN   203     /* called before submitting a msg from SMTP */
 
 
-
 /*
  * NetprocFunctionHook extensions are used for hooks which implement handlers
  * for incoming network messages.
@@ -399,7 +428,7 @@ enum {
 
 /*
  * ServiceFunctionHook extensions are used for hooks which implement various
- * non-Citadel services (on TCP protocols) directly in the Citadel server.
+ * protocols (either on TCP or on unix domain sockets) directly in the Citadel server.
  */
 struct ServiceFunctionHook {
        struct ServiceFunctionHook *next;
@@ -409,10 +438,38 @@ struct ServiceFunctionHook {
        void (*h_command_function) (void) ;
        void (*h_async_function) (void) ;
        int msock;
+       const char* ServiceName; /* this is just for debugging and logging purposes. */
 };
 extern struct ServiceFunctionHook *ServiceHookTable;
 
 
+/*
+ * RoomFunctionHook extensions are used for hooks which impliment room
+ * processing functions when new messages are added EG. SIEVE.
+ */
+struct RoomFunctionHook {
+       struct RoomFunctionHook *next;
+       int (*fcn_ptr) (struct ctdlroom *);
+};
+extern struct RoomFunctionHook *RoomHookTable;
+
+
+struct MaintenanceThreadHook {
+       struct MaintenanceThreadHook *next;
+       char *name;
+       void *(*fcn_ptr) (void *arg);
+       pthread_t MaintenanceThread_tid;
+};
+extern struct MaintenanceThreadHook *MaintenanceThreadHookTable;
+
+
+struct SearchFunctionHook {
+       struct SearchFunctionHook *next;
+       void (*fcn_ptr) (int *, long **, char *);
+       char *name;
+};
+extern struct SearchFunctionHook *SearchFunctionHookTable;
+
 
 /* Defines the relationship of a user to a particular room */
 struct visit {
@@ -443,6 +500,15 @@ struct MetaData {
        long meta_rfc822_length;        /* Cache of RFC822-translated msg length */
 };
 
+/* Calls to AdjRefCount() are queued and deferred, so the user doesn't
+ * have to wait for various disk-intensive operations to complete synchronously.
+ * This is the record format.
+ */
+struct arcq {
+       long arcq_msgnum;               /* Message number being adjusted */
+       int arcq_delta;                 /* Adjustment ( usually 1 or -1 ) */
+};
+
 
 /* 
  * Serialization routines use this struct to return a pointer and a length
@@ -453,10 +519,10 @@ struct ser_ret {
 };
 
 
-/* Preferred field order */
-/*               **********                    Important fields */
-/*                         ***************     Semi-important fields */
-/*                                        *    Message text (MUST be last) */
-#define FORDER "IPTAFONHRDBCEGJKLQSVWXYZUM"
+/* Preferred field order                                                       */
+/*               **********                    Important fields                */
+/*                         ***************     Semi-important fields           */
+/*                                        *    Message text (MUST be last)     */
+#define FORDER "IPTAFONHRDBCEJGKLQSVWXZYUM"
 
 #endif /* SERVER_H */