0be145a2003095bf0f970fcebc5cd0f55d80222c
[citadel] / citadel / server.h
1 /* 
2  * Main declarations file for the Citadel server
3  *
4  * Copyright (c) 1987-2020 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 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 };
64
65 #define RECPTYPES_MAGIC 0xfeeb
66
67 #define CTDLEXIT_SHUTDOWN       0       // Normal shutdown; do NOT auto-restart
68
69 /*
70  * Exit codes 101 through 109 are used for conditions in which
71  * we deliberately do NOT want the service to automatically
72  * restart.
73  */
74 #define CTDLEXIT_CONFIG         101     // Could not read system configuration
75 #define CTDLEXIT_CONTROL        102     // Could not acquire lock
76 #define CTDLEXIT_HOME           103     // Citadel home directory not found
77 #define CTDLEXIT_OOD            104     // Out Of Date config - rerun setup
78 #define CTDLEXIT_DB             105     // Unable to initialize database
79 #define CTDLEXIT_LIBCITADEL     106     // Incorrect version of libcitadel
80 #define CTDL_EXIT_UNSUP_AUTH    107     // Unsupported auth mode configured
81 #define CTDLEXIT_UNUSER         108     // Could not determine uid to run as
82 #define CTDLEXIT_CRYPTO         109     // Problem initializing SSL or TLS
83
84 /*
85  * Reasons why a session would be terminated (set CC->kill_me to these values)
86  */
87 enum {
88         KILLME_NOT,
89         KILLME_UNKNOWN,
90         KILLME_CLIENT_LOGGED_OUT,
91         KILLME_IDLE,
92         KILLME_CLIENT_DISCONNECTED,
93         KILLME_AUTHFAILED,
94         KILLME_SERVER_SHUTTING_DOWN,
95         KILLME_MAX_SESSIONS_EXCEEDED,
96         KILLME_ADMIN_TERMINATE,
97         KILLME_SELECT_INTERRUPTED,
98         KILLME_SELECT_FAILED,
99         KILLME_WRITE_FAILED,
100         KILLME_SIMULATION_WORKER,
101         KILLME_NOLOGIN,
102         KILLME_NO_CRYPTO,
103         KILLME_READSTRING_FAILED,
104         KILLME_MALLOC_FAILED,
105         KILLME_QUOTA,
106         KILLME_READ_FAILED,
107         KILLME_SPAMMER,
108         KILLME_XML_PARSER
109 };
110
111
112 #define CS_STEALTH      1       /* stealth mode */
113 #define CS_CHAT         2       /* chat mode */
114 #define CS_POSTING      4       /* Posting */
115
116 extern int ScheduledShutdown;
117 extern uid_t ctdluid;
118 extern int sanity_diag_mode;
119
120 struct ExpressMessage {
121         struct ExpressMessage *next;
122         time_t timestamp;       /* When this message was sent */
123         unsigned flags;         /* Special instructions */
124         char sender[256];       /* Name of sending user */
125         char sender_email[256]; /* Email or JID of sending user */
126         char *text;             /* Message text (if applicable) */
127 };
128
129 #define EM_BROADCAST    1       /* Broadcast message */
130 #define EM_GO_AWAY      2       /* Server requests client log off */
131 #define EM_CHAT         4       /* Server requests client enter chat */
132
133 /*
134  * Various things we need to lock and unlock
135  */
136 enum {
137         S_USERS,
138         S_ROOMS,
139         S_SESSION_TABLE,
140         S_FLOORTAB,
141         S_CHATQUEUE,
142         S_CONTROL,
143         S_NETDB,
144         S_SUPPMSGMAIN,
145         S_CONFIG,
146         S_HOUSEKEEPING,
147         S_DIRECTORY,
148         S_NETCONFIGS,
149         S_FLOORCACHE,
150         S_ATBF,
151         S_JOURNAL_QUEUE,
152         S_CHKPWD,
153         S_LOG,
154         S_NETSPOOL,
155         S_XMPP_QUEUE,
156         S_SCHEDULE_LIST,
157         S_SINGLE_USER,
158         S_LDAP,
159         S_IM_LOGS,
160         MAX_SEMAPHORES
161 };
162
163
164 /*
165  * message transfer formats
166  */
167 enum {
168         MT_CITADEL,             /* Citadel proprietary */
169         MT_RFC822,              /* RFC822 */
170         MT_MIME,                /* MIME-formatted message */
171         MT_DOWNLOAD,            /* Download a component */
172         MT_SPEW_SECTION         /* Download a component in a single operation */
173 };
174
175 /*
176  * Message format types in the database
177  */
178 #define FMT_CITADEL     0       /* Citadel vari-format (proprietary) */
179 #define FMT_FIXED       1       /* Fixed format (proprietary)        */
180 #define FMT_RFC822      4       /* Standard (headers are in M field) */
181
182
183 /*
184  * Citadel DataBases (define one for each cdb we need to open)
185  */
186 enum {
187         CDB_MSGMAIN,            /* message base                  */
188         CDB_USERS,              /* user file                     */
189         CDB_ROOMS,              /* room index                    */
190         CDB_FLOORTAB,           /* floor index                   */
191         CDB_MSGLISTS,           /* room message lists            */
192         CDB_VISIT,              /* user/room relationships       */
193         CDB_DIRECTORY,          /* address book directory        */
194         CDB_USETABLE,           /* network use table             */
195         CDB_BIGMSGS,            /* larger message bodies         */
196         CDB_FULLTEXT,           /* full text search index        */
197         CDB_EUIDINDEX,          /* locate msgs by EUID           */
198         CDB_USERSBYNUMBER,      /* index of users by number      */
199         CDB_EXTAUTH,            /* associates OpenIDs with users */
200         CDB_CONFIG,             /* system configuration database */
201         MAXCDB                  /* total number of CDB's defined */
202 };
203
204 struct cdbdata {
205         size_t len;
206         char *ptr;
207 };
208
209
210 /*
211  * Event types can't be enum'ed, because they must remain consistent between
212  * builds (to allow for binary modules built somewhere else)
213  */
214 #define EVT_STOP        0       /* Session is terminating */
215 #define EVT_START       1       /* Session is starting */
216 #define EVT_LOGIN       2       /* A user is logging in */
217 #define EVT_NEWROOM     3       /* Changing rooms */
218 #define EVT_LOGOUT      4       /* A user is logging out */
219 #define EVT_SETPASS     5       /* Setting or changing password */
220 #define EVT_CMD         6       /* Called after each server command */
221 #define EVT_RWHO        7       /* An RWHO command is being executed */
222 #define EVT_ASYNC       8       /* Doing asynchronous messages */
223 #define EVT_STEALTH     9       /* Entering stealth mode */
224 #define EVT_UNSTEALTH   10      /* Exiting stealth mode */
225
226 #define EVT_TIMER       50      /* Timer events are called once per minute
227                                    and are not tied to any session */
228 #define EVT_HOUSE       51      /* as needed houskeeping stuff */
229 #define EVT_SHUTDOWN    52      /* Server is shutting down */
230
231 #define EVT_PURGEUSER   100     /* Deleting a user */
232 #define EVT_NEWUSER     102     /* Creating a user */
233
234 #define EVT_BEFORESAVE  201
235 #define EVT_AFTERSAVE   202
236 #define EVT_SMTPSCAN    203     /* called before submitting a msg from SMTP */
237 #define EVT_AFTERUSRMBOXSAVE 204 /* called afte a message was saved into a users inbox */
238 /* Priority levels for paging functions (lower is better) */
239 enum {
240         XMSG_PRI_LOCAL,         /* Other users on -this- server */
241         XMSG_PRI_REMOTE,        /* Other users on a Citadel network (future) */
242         XMSG_PRI_FOREIGN,       /* Contacts on foreign instant message hosts */
243         MAX_XMSG_PRI
244 };
245
246
247 /* Defines the relationship of a user to a particular room */
248 typedef struct __visit {
249         long v_roomnum;
250         long v_roomgen;
251         long v_usernum;
252         long v_lastseen;
253         unsigned int v_flags;
254         char v_seen[SIZ];
255         char v_answered[SIZ];
256         int v_view;
257 } visit;
258
259 #define V_FORGET        1       /* User has zapped this room        */
260 #define V_LOCKOUT       2       /* User is locked out of this room  */
261 #define V_ACCESS        4       /* Access is granted to this room   */
262
263
264 /* Supplementary data for a message on disk
265  * These are kept separate from the message itself for one of two reasons:
266  * 1. Either their values may change at some point after initial save, or
267  * 2. They are merely caches of data which exist somewhere else, for speed.
268  * DO NOT PUT BIG DATA IN HERE ... we need this struct to be tiny for lots of quick r/w
269  */
270 struct MetaData {
271         long meta_msgnum;               /* Message number in *local* message base */
272         int meta_refcount;              /* Number of rooms pointing to this msg */
273         char meta_content_type[64];     /* Cached MIME content-type */
274         long meta_rfc822_length;        /* Cache of RFC822-translated msg length */
275 };
276
277
278 /* Calls to AdjRefCount() are queued and deferred, so the user doesn't
279  * have to wait for various disk-intensive operations to complete synchronously.
280  * This is the record format.
281  */
282 struct arcq {
283         long arcq_msgnum;               /* Message number being adjusted */
284         int arcq_delta;                 /* Adjustment ( usually 1 or -1 ) */
285 };
286
287
288 /*
289  * Serialization routines use this struct to return a pointer and a length
290  */
291 struct ser_ret {
292         size_t len;
293         unsigned char *ser;
294 };
295
296
297 /*
298  * The S_USETABLE database is used in several modules now, so we define its format here.
299  */
300 struct UseTable {
301         char ut_msgid[SIZ];
302         time_t ut_timestamp;
303 };
304
305
306 /*
307  * These one-byte field headers are found in the Citadel message store.
308  */
309 typedef enum _MsgField {
310         eAuthor       = 'A',
311         eBig_message  = 'B',
312         eExclusiveID  = 'E',
313         erFc822Addr   = 'F',
314         emessageId    = 'I',
315         eJournal      = 'J',
316         eReplyTo      = 'K',
317         eListID       = 'L',
318         eMesageText   = 'M',
319         eOriginalRoom = 'O',
320         eMessagePath  = 'P',
321         eRecipient    = 'R',
322         eTimestamp    = 'T',
323         eMsgSubject   = 'U',
324         eenVelopeTo   = 'V',
325         eWeferences   = 'W',
326         eCarbonCopY   = 'Y',
327         eErrorMsg     = '0',
328         eSuppressIdx  = '1',
329         eExtnotify    = '2',
330         eVltMsgNum    = '3'
331 } eMsgField;
332
333 #endif /* SERVER_H */