2 * Main declarations file for the Citadel server
4 * Copyright (c) 1987-2018 by the citadel.org team
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.
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.
19 #define INLINE __inline__
26 #define OPENSSL_NO_KRB5 /* work around redhat b0rken ssl headers */
27 #include <openssl/ssl.h>
31 * New format for a message in memory
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) */
42 #define CTDLMESSAGE_MAGIC 0x159d
43 #define CM_SKIP_HOOKS 0x01 /* Don't run server-side handlers */
46 /* Data structure returned by validate_recipients() */
47 typedef struct __recptypes {
65 #define RECPTYPES_MAGIC 0xfeeb
67 #define CTDLEXIT_SHUTDOWN 0 // Normal shutdown; do NOT auto-restart
70 * Exit codes 101 through 109 are used for conditions in which
71 * we deliberately do NOT want the service to automatically
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
85 * Reasons why a session would be terminated (set CC->kill_me to these values)
90 KILLME_CLIENT_LOGGED_OUT,
92 KILLME_CLIENT_DISCONNECTED,
94 KILLME_SERVER_SHUTTING_DOWN,
95 KILLME_MAX_SESSIONS_EXCEEDED,
96 KILLME_ADMIN_TERMINATE,
97 KILLME_SELECT_INTERRUPTED,
100 KILLME_SIMULATION_WORKER,
103 KILLME_READSTRING_FAILED,
104 KILLME_MALLOC_FAILED,
107 KILLME_ILLEGAL_MANAGESIEVE_COMMAND,
113 #define CS_STEALTH 1 /* stealth mode */
114 #define CS_CHAT 2 /* chat mode */
115 #define CS_POSTING 4 /* Posting */
117 extern int ScheduledShutdown;
118 extern uid_t ctdluid;
119 extern int sanity_diag_mode;
121 struct ExpressMessage {
122 struct ExpressMessage *next;
123 time_t timestamp; /* When this message was sent */
124 unsigned flags; /* Special instructions */
125 char sender[256]; /* Name of sending user */
126 char sender_email[256]; /* Email or JID of sending user */
127 char *text; /* Message text (if applicable) */
130 #define EM_BROADCAST 1 /* Broadcast message */
131 #define EM_GO_AWAY 2 /* Server requests client log off */
132 #define EM_CHAT 4 /* Server requests client enter chat */
135 * Various things we need to lock and unlock
168 * message transfer formats
171 MT_CITADEL, /* Citadel proprietary */
172 MT_RFC822, /* RFC822 */
173 MT_MIME, /* MIME-formatted message */
174 MT_DOWNLOAD, /* Download a component */
175 MT_SPEW_SECTION /* Download a component in a single operation */
179 * Message format types in the database
181 #define FMT_CITADEL 0 /* Citadel vari-format (proprietary) */
182 #define FMT_FIXED 1 /* Fixed format (proprietary) */
183 #define FMT_RFC822 4 /* Standard (headers are in M field) */
187 * Citadel DataBases (define one for each cdb we need to open)
190 CDB_MSGMAIN, /* message base */
191 CDB_USERS, /* user file */
192 CDB_ROOMS, /* room index */
193 CDB_FLOORTAB, /* floor index */
194 CDB_MSGLISTS, /* room message lists */
195 CDB_VISIT, /* user/room relationships */
196 CDB_DIRECTORY, /* address book directory */
197 CDB_USETABLE, /* network use table */
198 CDB_BIGMSGS, /* larger message bodies */
199 CDB_FULLTEXT, /* full text search index */
200 CDB_EUIDINDEX, /* locate msgs by EUID */
201 CDB_USERSBYNUMBER, /* index of users by number */
202 CDB_EXTAUTH, /* associates OpenIDs with users */
203 CDB_CONFIG, /* system configuration database */
204 MAXCDB /* total number of CDB's defined */
214 * Event types can't be enum'ed, because they must remain consistent between
215 * builds (to allow for binary modules built somewhere else)
217 #define EVT_STOP 0 /* Session is terminating */
218 #define EVT_START 1 /* Session is starting */
219 #define EVT_LOGIN 2 /* A user is logging in */
220 #define EVT_NEWROOM 3 /* Changing rooms */
221 #define EVT_LOGOUT 4 /* A user is logging out */
222 #define EVT_SETPASS 5 /* Setting or changing password */
223 #define EVT_CMD 6 /* Called after each server command */
224 #define EVT_RWHO 7 /* An RWHO command is being executed */
225 #define EVT_ASYNC 8 /* Doing asynchronous messages */
226 #define EVT_STEALTH 9 /* Entering stealth mode */
227 #define EVT_UNSTEALTH 10 /* Exiting stealth mode */
229 #define EVT_TIMER 50 /* Timer events are called once per minute
230 and are not tied to any session */
231 #define EVT_HOUSE 51 /* as needed houskeeping stuff */
232 #define EVT_SHUTDOWN 52 /* Server is shutting down */
234 #define EVT_PURGEUSER 100 /* Deleting a user */
235 #define EVT_NEWUSER 102 /* Creating a user */
237 #define EVT_BEFOREREAD 200
238 #define EVT_BEFORESAVE 201
239 #define EVT_AFTERSAVE 202
240 #define EVT_SMTPSCAN 203 /* called before submitting a msg from SMTP */
241 #define EVT_AFTERUSRMBOXSAVE 204 /* called afte a message was saved into a users inbox */
242 /* Priority levels for paging functions (lower is better) */
244 XMSG_PRI_LOCAL, /* Other users on -this- server */
245 XMSG_PRI_REMOTE, /* Other users on a Citadel network (future) */
246 XMSG_PRI_FOREIGN, /* Contacts on foreign instant message hosts */
251 /* Defines the relationship of a user to a particular room */
252 typedef struct __visit {
257 unsigned int v_flags;
259 char v_answered[SIZ];
263 #define V_FORGET 1 /* User has zapped this room */
264 #define V_LOCKOUT 2 /* User is locked out of this room */
265 #define V_ACCESS 4 /* Access is granted to this room */
268 /* Supplementary data for a message on disk
269 * These are kept separate from the message itself for one of two reasons:
270 * 1. Either their values may change at some point after initial save, or
271 * 2. They are merely caches of data which exist somewhere else, for speed.
272 * DO NOT PUT BIG DATA IN HERE ... we need this struct to be tiny for lots of quick r/w
275 long meta_msgnum; /* Message number in *local* message base */
276 int meta_refcount; /* Number of rooms pointing to this msg */
277 char meta_content_type[64]; /* Cached MIME content-type */
278 long meta_rfc822_length; /* Cache of RFC822-translated msg length */
282 /* Calls to AdjRefCount() are queued and deferred, so the user doesn't
283 * have to wait for various disk-intensive operations to complete synchronously.
284 * This is the record format.
287 long arcq_msgnum; /* Message number being adjusted */
288 int arcq_delta; /* Adjustment ( usually 1 or -1 ) */
293 * Serialization routines use this struct to return a pointer and a length
302 * The S_USETABLE database is used in several modules now, so we define its format here.
309 typedef enum _MsgField {
338 #endif /* SERVER_H */