citadel/server.h

   1 /*
   2  * Main declarations file for the Citadel server
   3  *
   4  * Copyright (c) 1987-2017 by the citadel.org team
   5  *
   6  * This program is open source software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License, version 3.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14
  15 #ifndef SERVER_H
  16 #define SERVER_H
  17
  18 #ifdef __GNUC__
  19 #define INLINE __inline__
  20 #else
  21 #define INLINE
  22 #endif
  23
  24 #include "citadel.h"
  25 #ifdef HAVE_OPENSSL
  26 #define OPENSSL_NO_KRB5         /* work around redhat b0rken ssl headers */
  27 #include <openssl/ssl.h>
  28 #endif
  29
  30 /*
  31  * New format for a message in memory
  32  */
  33 struct CtdlMessage {
  34         int cm_magic;                   /* Self-check (NOT SAVED TO DISK) */
  35         char cm_anon_type;              /* Anonymous or author-visible */
  36         char cm_format_type;            /* Format type */
  37         char *cm_fields[256];           /* Data fields */
  38         long cm_lengths[256];           /* size of datafields */
  39         unsigned int cm_flags;          /* How to handle (NOT SAVED TO DISK) */
  40 };
  41
  42 #define CTDLMESSAGE_MAGIC               0x159d
  43 #define CM_SKIP_HOOKS   0x01            /* Don't run server-side handlers */
  44
  45
  46 /* Data structure returned by validate_recipients() */
  47 typedef struct __recptypes {
  48         int recptypes_magic;
  49         int num_local;
  50         int num_internet;
  51         int num_ignet;
  52         int num_room;
  53         int num_error;
  54         char *errormsg;
  55         char *recp_local;
  56         char *recp_internet;
  57         char *recp_room;
  58         char *recp_orgroom;
  59         char *display_recp;
  60         char *bounce_to;
  61         char *envelope_from;
  62         char *sending_room;
  63 } recptypes;
  64
  65 #define RECPTYPES_MAGIC 0xfeeb
  66
  67
  68 #define CTDLEXIT_SHUTDOWN       0       /* Normal shutdown; do NOT auto-restart */
  69
  70 /*
  71  * Exit codes 101 through 109 are used for conditions in which
  72  * we deliberately do NOT want the service to automatically
  73  * restart.
  74  */
  75 #define CTDLEXIT_CONFIG         101     /* Could not read citadel.config */
  76 #define CTDLEXIT_CONTROL        102     /* Could not acquire lock */
  77 #define CTDLEXIT_HOME           103     /* Citadel home directory not found */
  78 #define CTDLEXIT_OOD            104     /* Out Of Date config - rerun setup */
  79 #define CTDLEXIT_DB             105     /* Unable to initialize database */
  80 #define CTDLEXIT_LIBCITADEL     106     /* Incorrect version of libcitadel */
  81 #define CTDL_EXIT_UNSUP_AUTH    107     /* Unsupported auth mode configured */
  82 #define CTDLEXIT_UNUSER         108     /* Could not determine uid to run as */
  83 #define CTDLEXIT_CRYPTO         109     /* Problem initializing SSL or TLS */
  84
  85 /*
  86  * Reasons why a session would be terminated (set CC->kill_me to these values)
  87  */
  88 enum {
  89         KILLME_NOT,
  90         KILLME_UNKNOWN,
  91         KILLME_CLIENT_LOGGED_OUT,
  92         KILLME_IDLE,
  93         KILLME_CLIENT_DISCONNECTED,
  94         KILLME_AUTHFAILED,
  95         KILLME_SERVER_SHUTTING_DOWN,
  96         KILLME_MAX_SESSIONS_EXCEEDED,
  97         KILLME_ADMIN_TERMINATE,
  98         KILLME_SELECT_INTERRUPTED,
  99         KILLME_SELECT_FAILED,
 100         KILLME_WRITE_FAILED,
 101         KILLME_SIMULATION_WORKER,
 102         KILLME_NOLOGIN,
 103         KILLME_NO_CRYPTO,
 104         KILLME_READSTRING_FAILED,
 105         KILLME_MALLOC_FAILED,
 106         KILLME_QUOTA,
 107         KILLME_READ_FAILED,
 108         KILLME_ILLEGAL_MANAGESIEVE_COMMAND,
 109         KILLME_SPAMMER,
 110         KILLME_XML_PARSER
 111 };
 112
 113
 114 #define CS_STEALTH      1       /* stealth mode */
 115 #define CS_CHAT         2       /* chat mode */
 116 #define CS_POSTING      4       /* Posting */
 117
 118
 119 extern int ScheduledShutdown;
 120 extern uid_t ctdluid;
 121
 122 struct ExpressMessage {
 123         struct ExpressMessage *next;
 124         time_t timestamp;       /* When this message was sent */
 125         unsigned flags;         /* Special instructions */
 126         char sender[256];       /* Name of sending user */
 127         char sender_email[256]; /* Email or JID of sending user */
 128         char *text;             /* Message text (if applicable) */
 129 };
 130
 131 #define EM_BROADCAST    1       /* Broadcast message */
 132 #define EM_GO_AWAY      2       /* Server requests client log off */
 133 #define EM_CHAT         4       /* Server requests client enter chat */
 134
 135 /*
 136  * Various things we need to lock and unlock
 137  */
 138 enum {
 139         S_USERS,
 140         S_ROOMS,
 141         S_SESSION_TABLE,
 142         S_FLOORTAB,
 143         S_CHATQUEUE,
 144         S_CONTROL,
 145         S_NETDB,
 146         S_SUPPMSGMAIN,
 147         S_CONFIG,
 148         S_HOUSEKEEPING,
 149         S_DIRECTORY,
 150         S_NETCONFIGS,
 151         S_PUBLIC_CLIENTS,
 152         S_FLOORCACHE,
 153         S_ATBF,
 154         S_JOURNAL_QUEUE,
 155         S_RPLIST,
 156         S_SIEVELIST,
 157         S_CHKPWD,
 158         S_LOG,
 159         S_NETSPOOL,
 160         S_XMPP_QUEUE,
 161         S_SCHEDULE_LIST,
 162         S_SINGLE_USER,
 163         S_LDAP,
 164         S_IM_LOGS,
 165         MAX_SEMAPHORES
 166 };
 167
 168
 169 /*
 170  * Upload types
 171  */
 172 #define UPL_FILE        0
 173 #define UPL_NET         1
 174 #define UPL_IMAGE       2
 175
 176
 177 /*
 178  * message transfer formats
 179  */
 180 enum {
 181         MT_CITADEL,             /* Citadel proprietary */
 182         MT_RFC822,              /* RFC822 */
 183         MT_MIME,                /* MIME-formatted message */
 184         MT_DOWNLOAD,            /* Download a component */
 185         MT_SPEW_SECTION         /* Download a component in a single operation */
 186 };
 187
 188 /*
 189  * Message format types in the database
 190  */
 191 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
 192 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
 193 #define FMT_RFC822      4       /* Standard (headers are in M field) */
 194
 195
 196 /*
 197  * Citadel DataBases (define one for each cdb we need to open)
 198  */
 199 enum {
 200         CDB_MSGMAIN,            /* message base                  */
 201         CDB_USERS,              /* user file                     */
 202         CDB_ROOMS,              /* room index                    */
 203         CDB_FLOORTAB,           /* floor index                   */
 204         CDB_MSGLISTS,           /* room message lists            */
 205         CDB_VISIT,              /* user/room relationships       */
 206         CDB_DIRECTORY,          /* address book directory        */
 207         CDB_USETABLE,           /* network use table             */
 208         CDB_BIGMSGS,            /* larger message bodies         */
 209         CDB_FULLTEXT,           /* full text search index        */
 210         CDB_EUIDINDEX,          /* locate msgs by EUID           */
 211         CDB_USERSBYNUMBER,      /* index of users by number      */
 212         CDB_EXTAUTH,            /* associates OpenIDs with users */
 213         CDB_CONFIG,             /* system configuration database */
 214         MAXCDB                  /* total number of CDB's defined */
 215 };
 216
 217 struct cdbdata {
 218         size_t len;
 219         char *ptr;
 220 };
 221
 222
 223 /*
 224  * Event types can't be enum'ed, because they must remain consistent between
 225  * builds (to allow for binary modules built somewhere else)
 226  */
 227 #define EVT_STOP        0       /* Session is terminating */
 228 #define EVT_START       1       /* Session is starting */
 229 #define EVT_LOGIN       2       /* A user is logging in */
 230 #define EVT_NEWROOM     3       /* Changing rooms */
 231 #define EVT_LOGOUT      4       /* A user is logging out */
 232 #define EVT_SETPASS     5       /* Setting or changing password */
 233 #define EVT_CMD         6       /* Called after each server command */
 234 #define EVT_RWHO        7       /* An RWHO command is being executed */
 235 #define EVT_ASYNC       8       /* Doing asynchronous messages */
 236 #define EVT_STEALTH     9       /* Entering stealth mode */
 237 #define EVT_UNSTEALTH   10      /* Exiting stealth mode */
 238
 239 #define EVT_TIMER       50      /* Timer events are called once per minute
 240                                    and are not tied to any session */
 241 #define EVT_HOUSE       51      /* as needed houskeeping stuff */
 242 #define EVT_SHUTDOWN    52      /* Server is shutting down */
 243
 244 #define EVT_PURGEUSER   100     /* Deleting a user */
 245 #define EVT_NEWUSER     102     /* Creating a user */
 246
 247 #define EVT_BEFOREREAD  200
 248 #define EVT_BEFORESAVE  201
 249 #define EVT_AFTERSAVE   202
 250 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
 251 #define EVT_AFTERUSRMBOXSAVE 204 /* called afte a message was saved into a users inbox */
 252 /* Priority levels for paging functions (lower is better) */
 253 enum {
 254         XMSG_PRI_LOCAL,         /* Other users on -this- server */
 255         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
 256         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
 257         MAX_XMSG_PRI
 258 };
 259
 260
 261 /* Defines the relationship of a user to a particular room */
 262 typedef struct __visit {
 263         long v_roomnum;
 264         long v_roomgen;
 265         long v_usernum;
 266         long v_lastseen;
 267         unsigned int v_flags;
 268         char v_seen[SIZ];
 269         char v_answered[SIZ];
 270         int v_view;
 271 } visit;
 272
 273 #define V_FORGET        1       /* User has zapped this room        */
 274 #define V_LOCKOUT       2       /* User is locked out of this room  */
 275 #define V_ACCESS        4       /* Access is granted to this room   */
 276
 277
 278 /* Supplementary data for a message on disk
 279  * These are kept separate from the message itself for one of two reasons:
 280  * 1. Either their values may change at some point after initial save, or
 281  * 2. They are merely caches of data which exist somewhere else, for speed.
 282  */
 283 struct MetaData {
 284         long meta_msgnum;               /* Message number in *local* message base */
 285         int meta_refcount;              /* Number of rooms pointing to this msg */
 286         char meta_content_type[64];     /* Cached MIME content-type */
 287         long meta_rfc822_length;        /* Cache of RFC822-translated msg length */
 288         char mimetype[64];              /* if we were able to guess the mimetype for the data */
 289 };
 290
 291 /* Calls to AdjRefCount() are queued and deferred, so the user doesn't
 292  * have to wait for various disk-intensive operations to complete synchronously.
 293  * This is the record format.
 294  */
 295 struct arcq {
 296         long arcq_msgnum;               /* Message number being adjusted */
 297         int arcq_delta;                 /* Adjustment ( usually 1 or -1 ) */
 298 };
 299
 300
 301 /*
 302  * Serialization routines use this struct to return a pointer and a length
 303  */
 304 struct ser_ret {
 305         size_t len;
 306         unsigned char *ser;
 307 };
 308
 309
 310 /*
 311  * The S_USETABLE database is used in several modules now, so we define its format here.
 312  */
 313 struct UseTable {
 314         char ut_msgid[SIZ];
 315         time_t ut_timestamp;
 316 };
 317
 318
 319
 320 /* Preferred field order                                                        */
 321 /*               **********                     Important fields                */
 322 /*                         ***************      Semi-important fields           */
 323 /*                                        **    internal only                   */
 324 /*                                          *   Message text (MUST be last)     */
 325 ///#define FORDER       "IPTAFONHRDBCEWJGKLQSVXZYU12M"
 326
 327 typedef enum _MsgField {
 328         eAuthor       = 'A',
 329         eBig_message  = 'B',
 330         eRemoteRoom   = 'C',
 331         eDestination  = 'D',
 332         eExclusiveID  = 'E',
 333         erFc822Addr   = 'F',
 334         eHumanNode    = 'H',
 335         emessageId    = 'I',
 336         eJournal      = 'J',
 337         eReplyTo      = 'K',
 338         eListID       = 'L',
 339         eMesageText   = 'M',
 340         eNodeName     = 'N',
 341         eOriginalRoom = 'O',
 342         eMessagePath  = 'P',
 343         eRecipient    = 'R',
 344         eSpecialField = 'S',
 345         eTimestamp    = 'T',
 346         eMsgSubject   = 'U',
 347         eenVelopeTo   = 'V',
 348         eWeferences   = 'W',
 349         eCarbonCopY   = 'Y',
 350         eErrorMsg     = '0',
 351         eSuppressIdx  = '1',
 352         eExtnotify    = '2',
 353         eVltMsgNum    = '3'
 354 }eMsgField;
 355
 356 #endif /* SERVER_H */