citadel/server.h

   1 /* $Id$ */
   2
   3
   4 #ifndef SERVER_H
   5 #define SERVER_H
   6
   7 #ifdef __GNUC__
   8 #define INLINE __inline__
   9 #else
  10 #define INLINE
  11 #endif
  12
  13 #include "citadel.h"
  14 #ifdef HAVE_OPENSSL
  15 #define OPENSSL_NO_KRB5         /* work around redhat b0rken ssl headers */
  16 #include <openssl/ssl.h>
  17 #endif
  18
  19 /*
  20  * New format for a message in memory
  21  */
  22 struct CtdlMessage {
  23         int cm_magic;                   /* Self-check (NOT SAVED TO DISK) */
  24         char cm_anon_type;              /* Anonymous or author-visible */
  25         char cm_format_type;            /* Format type */
  26         char *cm_fields[256];           /* Data fields */
  27         unsigned int cm_flags;          /* How to handle (NOT SAVED TO DISK) */
  28 };
  29
  30 #define CTDLMESSAGE_MAGIC               0x159d
  31 #define CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
  32
  33
  34
  35 #define CTDLEXIT_SHUTDOWN       0       /* Normal shutdown; do NOT auto-restart */
  36
  37 /*
  38  * Exit codes 101 through 109 are used for conditions in which
  39  * we deliberately do NOT want the service to automatically
  40  * restart.
  41  */
  42 #define CTDLEXIT_CONFIG         101     /* Could not read citadel.config */
  43 #define CTDLEXIT_CONTROL        102     /* Could not acquire lock */
  44 #define CTDLEXIT_HOME           103     /* Citadel home directory not found */
  45 #define CTDLEXIT_OOD            104     /* Out Of Date config - rerun setup */
  46 #define CTDLEXIT_DB             105     /* Unable to initialize database */
  47 #define CTDLEXIT_LIBCITADEL     106     /* Incorrect version of libcitadel */
  48 #define CTDL_EXIT_UNSUP_AUTH    107     /* Unsupported auth mode configured */
  49
  50
  51
  52 #define CS_STEALTH      1       /* stealth mode */
  53 #define CS_CHAT         2       /* chat mode */
  54 #define CS_POSTING      4       /* Posting */
  55
  56
  57 /*
  58  * This is the control record for the message base...
  59  */
  60 struct CitControl {
  61         long MMhighest;                 /* highest message number in file   */
  62         unsigned MMflags;               /* Global system flags              */
  63         long MMnextuser;                /* highest user number on system    */
  64         long MMnextroom;                /* highest room number on system    */
  65         int version;                    /* Server-hosted upgrade level      */
  66         int fulltext_wordbreaker;       /* ID of wordbreaker in use         */
  67         long MMfulltext;                /* highest message number indexed   */
  68         int MMdbversion;                /* Version of Berkeley DB used on previous server run */
  69 };
  70
  71 extern int ScheduledShutdown;
  72 extern struct CitControl CitControl;
  73
  74 struct ExpressMessage {
  75         struct ExpressMessage *next;
  76         time_t timestamp;       /* When this message was sent */
  77         unsigned flags;         /* Special instructions */
  78         char sender[256];       /* Name of sending user */
  79         char sender_email[256]; /* Email or JID of sending user */
  80         char *text;             /* Message text (if applicable) */
  81 };
  82
  83 #define EM_BROADCAST    1       /* Broadcast message */
  84 #define EM_GO_AWAY      2       /* Server requests client log off */
  85 #define EM_CHAT         4       /* Server requests client enter chat */
  86
  87 /*
  88  * Various things we need to lock and unlock
  89  */
  90 enum {
  91         S_USERS,
  92         S_ROOMS,
  93         S_SESSION_TABLE,
  94         S_FLOORTAB,
  95         S_CHATQUEUE,
  96         S_CONTROL,
  97         S_NETDB,
  98         S_SUPPMSGMAIN,
  99         S_CONFIG,
 100         S_HOUSEKEEPING,
 101         S_NTTLIST,
 102         S_DIRECTORY,
 103         S_NETCONFIGS,
 104         S_PUBLIC_CLIENTS,
 105         S_FLOORCACHE,
 106         S_DEBUGMEMLEAKS,
 107         S_ATBF,
 108         S_JOURNAL_QUEUE,
 109         S_RPLIST,
 110         S_SIEVELIST,
 111         S_CHKPWD,
 112         S_LOG,
 113         S_NETSPOOL,
 114         S_THREAD_LIST,
 115         S_XMPP_QUEUE,
 116         S_SCHEDULE_LIST,
 117         S_SINGLE_USER,
 118         S_LDAP,
 119         S_IM_LOGS,
 120         MAX_SEMAPHORES
 121 };
 122
 123
 124 /*
 125  * Upload types
 126  */
 127 #define UPL_FILE        0
 128 #define UPL_NET         1
 129 #define UPL_IMAGE       2
 130
 131
 132 /*
 133  * message transfer formats
 134  */
 135 enum {
 136         MT_CITADEL,             /* Citadel proprietary */
 137         MT_RFC822,              /* RFC822 */
 138         MT_MIME,                /* MIME-formatted message */
 139         MT_DOWNLOAD,            /* Download a component */
 140         MT_SPEW_SECTION         /* Download a component in a single operation */
 141 };
 142
 143 /*
 144  * Message format types in the database
 145  */
 146 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 147 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 148 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 149
 150
 151 /*
 152  * Citadel DataBases (define one for each cdb we need to open)
 153  */
 154 enum {
 155         CDB_MSGMAIN,            /* message base                  */
 156         CDB_USERS,              /* user file                     */
 157         CDB_ROOMS,              /* room index                    */
 158         CDB_FLOORTAB,           /* floor index                   */
 159         CDB_MSGLISTS,           /* room message lists            */
 160         CDB_VISIT,              /* user/room relationships       */
 161         CDB_DIRECTORY,          /* address book directory        */
 162         CDB_USETABLE,           /* network use table             */
 163         CDB_BIGMSGS,            /* larger message bodies         */
 164         CDB_FULLTEXT,           /* full text search index        */
 165         CDB_EUIDINDEX,          /* locate msgs by EUID           */
 166         CDB_USERSBYNUMBER,      /* index of users by number      */
 167         CDB_OPENID,             /* associates OpenIDs with users */
 168         MAXCDB                  /* total number of CDB's defined */
 169 };
 170
 171 struct cdbdata {
 172         size_t len;
 173         char *ptr;
 174 };
 175
 176
 177 /*
 178  * Event types can't be enum'ed, because they must remain consistent between
 179  * builds (to allow for binary modules built somewhere else)
 180  */
 181 #define EVT_STOP        0       /* Session is terminating */
 182 #define EVT_START       1       /* Session is starting */
 183 #define EVT_LOGIN       2       /* A user is logging in */
 184 #define EVT_NEWROOM     3       /* Changing rooms */
 185 #define EVT_LOGOUT      4       /* A user is logging out */
 186 #define EVT_SETPASS     5       /* Setting or changing password */
 187 #define EVT_CMD         6       /* Called after each server command */
 188 #define EVT_RWHO        7       /* An RWHO command is being executed */
 189 #define EVT_ASYNC       8       /* Doing asynchronous messages */
 190 #define EVT_STEALTH     9       /* Entering stealth mode */
 191 #define EVT_UNSTEALTH   10      /* Exiting stealth mode */
 192
 193 #define EVT_TIMER       50      /* Timer events are called once per minute
 194                                    and are not tied to any session */
 195 #define EVT_HOUSE       51      /* as needed houskeeping stuff */
 196 #define EVT_SHUTDOWN    52      /* Server is shutting down */
 197
 198 #define EVT_PURGEUSER   100     /* Deleting a user */
 199 #define EVT_NEWUSER     102     /* Creating a user */
 200
 201 #define EVT_BEFOREREAD  200
 202 #define EVT_BEFORESAVE  201
 203 #define EVT_AFTERSAVE   202
 204 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
 205 /* Priority levels for paging functions (lower is better) */
 206 enum {
 207         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 208         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 209         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 210         MAX_XMSG_PRI
 211 };
 212
 213
 214 /* Defines the relationship of a user to a particular room */
 215 struct visit {
 216         long v_roomnum;
 217         long v_roomgen;
 218         long v_usernum;
 219         long v_lastseen;
 220         unsigned int v_flags;
 221         char v_seen[SIZ];
 222         char v_answered[SIZ];
 223         int v_view;
 224 };
 225
 226 #define V_FORGET        1       /* User has zapped this room        */
 227 #define V_LOCKOUT       2       /* User is locked out of this room  */
 228 #define V_ACCESS        4       /* Access is granted to this room   */
 229
 230
 231 /* Supplementary data for a message on disk
 232  * These are kept separate from the message itself for one of two reasons:
 233  * 1. Either their values may change at some point after initial save, or
 234  * 2. They are merely caches of data which exist somewhere else, for speed.
 235  */
 236 struct MetaData {
 237         long meta_msgnum;               /* Message number in *local* message base */
 238         int meta_refcount;              /* Number of rooms pointing to this msg */
 239         char meta_content_type[64];     /* Cached MIME content-type */
 240         long meta_rfc822_length;        /* Cache of RFC822-translated msg length */
 241         char mimetype[64];              /* if we were able to guess the mimetype for the data */
 242 };
 243
 244 /* Calls to AdjRefCount() are queued and deferred, so the user doesn't
 245  * have to wait for various disk-intensive operations to complete synchronously.
 246  * This is the record format.
 247  */
 248 struct arcq {
 249         long arcq_msgnum;               /* Message number being adjusted */
 250         int arcq_delta;                 /* Adjustment ( usually 1 or -1 ) */
 251 };
 252
 253
 254 /*
 255  * Serialization routines use this struct to return a pointer and a length
 256  */
 257 struct ser_ret {
 258         size_t len;
 259         unsigned char *ser;
 260 };
 261
 262
 263 /*
 264  * The S_USETABLE database is used in several modules now, so we define its format here.
 265  */
 266 struct UseTable {
 267         char ut_msgid[SIZ];
 268         time_t ut_timestamp;
 269 };
 270
 271
 272
 273 /* Preferred field order                                                        */
 274 /*               **********                     Important fields                */
 275 /*                         ***************      Semi-important fields           */
 276 /*                                        *     Message text (MUST be last)     */
 277 #define FORDER  "IPTAFONHRDBCEWJGKLQSVXZYUM"
 278
 279 #endif /* SERVER_H */