X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fserver.h;h=bcca4fb2b9345e788791573d2bc0eecfe4de70cb;hb=7555d277f2ccfa8d3f484e5e1dc76e64284afe11;hp=d1ec072c822b0e3cf1073d594247f40be554f812;hpb=a337b58c154994e7644dd6b5e1928f06ee9d766e;p=citadel.git diff --git a/citadel/server.h b/citadel/server.h index d1ec072c8..bcca4fb2b 100644 --- a/citadel/server.h +++ b/citadel/server.h @@ -1,4 +1,3 @@ -/* $Id$ */ #ifndef SERVER_H @@ -12,6 +11,7 @@ #include "citadel.h" #ifdef HAVE_OPENSSL +#define OPENSSL_NO_KRB5 /* work around redhat b0rken ssl headers */ #include #endif @@ -30,129 +30,48 @@ 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; -}; + +#define CTDLEXIT_SHUTDOWN 0 /* Normal shutdown; do NOT auto-restart */ /* - * 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. + * Exit codes 101 through 109 are used for conditions in which + * we deliberately do NOT want the service to automatically + * restart. */ -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 -}; - +#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 */ +#define CTDLEXIT_LIBCITADEL 106 /* Incorrect version of libcitadel */ +#define CTDL_EXIT_UNSUP_AUTH 107 /* Unsupported auth mode configured */ /* - * 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. + * Reasons why a session would be terminated (set CC->kill_me to these values) */ -struct CitContext { - struct CitContext *next; /* Link to next session in the list */ - - 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 */ - - char curr_user[USERNAME_SIZE]; /* name of current user */ - int logged_in; /* logged in */ - int internal_pgm; /* authenticated as internal program */ - 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[PATH_MAX];/* Is the client another Citadel server? */ - int client_socket; - int cs_pid; /* session ID */ - 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 */ - 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[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 */ - - FILE *download_fp; /* Fields relating to file transfer */ - FILE *upload_fp; - char upl_file[PATH_MAX]; - char upl_path[PATH_MAX]; - char upl_comment[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 - - int buffering; - char *output_buffer; /* hold output for one big dump */ - int buffer_len; - - /* 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 */ - - /* Masquerade... */ - char fake_username[USERNAME_SIZE]; /* Fake username */ - char fake_postname[USERNAME_SIZE]; /* Fake postname */ - char fake_hostname[64]; /* Fake hostname */ - char fake_roomname[ROOMNAMELEN]; /* Fake roomname */ - - char preferred_formats[SIZ]; /* Preferred MIME formats */ - - /* Dynamically allocated session data */ - struct CtdlSessData *FirstSessData; -}; - -typedef struct CitContext t_context; - -/* Values for CitContext.state */ enum { - CON_IDLE, /* This context is doing nothing */ - CON_READY, /* This context is ready-to-run */ - CON_EXECUTING, /* This context is bound to a thread */ + KILLME_NOT, + KILLME_UNKNOWN, + KILLME_CLIENT_LOGGED_OUT, + KILLME_IDLE, + KILLME_CLIENT_DISCONNECTED, + KILLME_AUTHFAILED, + KILLME_SERVER_SHUTTING_DOWN, + KILLME_MAX_SESSIONS_EXCEEDED, + KILLME_ADMIN_TERMINATE, + KILLME_SELECT_INTERRUPTED, + KILLME_SELECT_FAILED, + KILLME_WRITE_FAILED, + KILLME_SIMULATION_WORKER, + KILLME_NOLOGIN, + KILLME_NO_CRYPTO, + KILLME_READSTRING_FAILED, + KILLME_MALLOC_FAILED, + KILLME_QUOTA, + KILLME_READ_FAILED, + KILLME_ILLEGAL_MANAGESIEVE_COMMAND, + KILLME_SPAMMER, + KILLME_XML_PARSER }; @@ -160,19 +79,30 @@ enum { #define CS_CHAT 2 /* chat mode */ #define CS_POSTING 4 /* Posting */ -struct CitContext *MyContext(void); -#define CC MyContext() -extern struct CitContext *ContextList; +/* + * This is the control record for the message base... + */ +struct CitControl { + long MMhighest; /* highest message number in file */ + unsigned MMflags; /* Global system flags */ + long MMnextuser; /* highest user number on system */ + long MMnextroom; /* highest room number on system */ + int version; /* Server-hosted upgrade level */ + int fulltext_wordbreaker; /* ID of wordbreaker in use */ + long MMfulltext; /* highest message number indexed */ + int MMdbversion; /* Version of Berkeley DB used on previous server run */ +}; + extern int ScheduledShutdown; extern struct CitControl CitControl; - struct ExpressMessage { struct ExpressMessage *next; time_t timestamp; /* When this message was sent */ unsigned flags; /* Special instructions */ - char sender[64]; /* Name of sending user */ + char sender[256]; /* Name of sending user */ + char sender_email[256]; /* Email or JID of sending user */ char *text; /* Message text (if applicable) */ }; @@ -180,15 +110,6 @@ struct ExpressMessage { #define EM_GO_AWAY 2 /* Server requests client log off */ #define EM_CHAT 4 /* Server requests client enter chat */ -struct ChatLine { - struct ChatLine *next; - int chat_seq; - time_t chat_time; - char chat_text[SIZ]; - char chat_username[USERNAME_SIZE]; - char chat_room[ROOMNAMELEN]; -}; - /* * Various things we need to lock and unlock */ @@ -199,20 +120,27 @@ enum { S_FLOORTAB, S_CHATQUEUE, S_CONTROL, - S_DATABASE, S_NETDB, S_SUPPMSGMAIN, - S_I_WANNA_SELECT, S_CONFIG, - S_WORKER_LIST, S_HOUSEKEEPING, S_NTTLIST, S_DIRECTORY, S_NETCONFIGS, S_PUBLIC_CLIENTS, - S_LDAP, S_FLOORCACHE, - S_DEBUGMEMLEAKS, + S_ATBF, + S_JOURNAL_QUEUE, + S_RPLIST, + S_SIEVELIST, + S_CHKPWD, + S_LOG, + S_NETSPOOL, + S_XMPP_QUEUE, + S_SCHEDULE_LIST, + S_SINGLE_USER, + S_LDAP, + S_IM_LOGS, MAX_SEMAPHORES }; @@ -232,7 +160,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 */ }; /* @@ -255,6 +184,11 @@ enum { CDB_VISIT, /* user/room relationships */ 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 */ + CDB_USERSBYNUMBER, /* index of users by number */ + CDB_OPENID, /* associates OpenIDs with users */ MAXCDB /* total number of CDB's defined */ }; @@ -264,38 +198,6 @@ struct cdbdata { }; - -/* Structures and declarations for function hooks of various types */ - -struct LogFunctionHook { - struct LogFunctionHook *next; - int loglevel; - void (*h_function_pointer) (char *); -}; -extern struct LogFunctionHook *LogHookTable; - -struct CleanupFunctionHook { - struct CleanupFunctionHook *next; - void (*h_function_pointer) (void); -}; -extern struct CleanupFunctionHook *CleanupHookTable; - - - - -/* - * SessionFunctionHook extensions are used for any type of hook for which - * the context in which it's being called (which is determined by the event - * type) will make it obvious for the hook function to know where to look for - * pertinent data. - */ -struct SessionFunctionHook { - struct SessionFunctionHook *next; - void (*h_function_pointer) (void); - int eventtype; -}; -extern struct SessionFunctionHook *SessionHookTable; - /* * Event types can't be enum'ed, because they must remain consistent between * builds (to allow for binary modules built somewhere else) @@ -308,78 +210,22 @@ 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_STEALTH 9 /* Entering stealth mode */ +#define EVT_UNSTEALTH 10 /* Exiting stealth mode */ #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 - * an operation on a user or username (potentially) other than the one - * operating the current session. - */ -struct UserFunctionHook { - struct UserFunctionHook *next; - void (*h_function_pointer) (struct ctdluser *usbuf); - int eventtype; -}; -extern struct UserFunctionHook *UserHookTable; +#define EVT_HOUSE 51 /* as needed houskeeping stuff */ +#define EVT_SHUTDOWN 52 /* Server is shutting down */ #define EVT_PURGEUSER 100 /* Deleting a user */ #define EVT_NEWUSER 102 /* Creating a user */ -/* - * MessageFunctionHook extensions are used for hooks which implement handlers - * for various types of message operations (save, read, etc.) - */ -struct MessageFunctionHook { - struct MessageFunctionHook *next; - int (*h_function_pointer) (struct CtdlMessage *msg); - int eventtype; -}; -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 - * registered should return the number of recipients to whom the message was - * successfully transmitted. - */ -struct XmsgFunctionHook { - struct XmsgFunctionHook *next; - int (*h_function_pointer) (char *, char *, char *); - int order; -}; -extern struct XmsgFunctionHook *XmsgHookTable; - /* Priority levels for paging functions (lower is better) */ enum { XMSG_PRI_LOCAL, /* Other users on -this- server */ @@ -389,25 +235,8 @@ 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 struct ServiceFunctionHook *ServiceHookTable; - - - /* Defines the relationship of a user to a particular room */ -struct visit { +typedef struct __visit { long v_roomnum; long v_roomgen; long v_usernum; @@ -416,7 +245,7 @@ struct visit { char v_seen[SIZ]; char v_answered[SIZ]; int v_view; -}; +} visit; #define V_FORGET 1 /* User has zapped this room */ #define V_LOCKOUT 2 /* User is locked out of this room */ @@ -424,14 +253,25 @@ 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 */ + char mimetype[64]; /* if we were able to guess the mimetype for the data */ +}; + +/* 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 ) */ }; @@ -440,14 +280,24 @@ struct MetaData { */ struct ser_ret { size_t len; - char *ser; + unsigned char *ser; }; -/* Preferred field order */ -/* ********** Important fields */ -/* *************** Semi-important fields */ -/* * Message text (MUST be last) */ -#define FORDER "IPTAFONHRDBCEGJKLQSVWXYZUM" +/* + * The S_USETABLE database is used in several modules now, so we define its format here. + */ +struct UseTable { + char ut_msgid[SIZ]; + time_t ut_timestamp; +}; + + + +/* Preferred field order */ +/* ********** Important fields */ +/* *************** Semi-important fields */ +/* * Message text (MUST be last) */ +#define FORDER "IPTAFONHRDBCEWJGKLQSVXZYUM" #endif /* SERVER_H */