2 * Main Citadel header file
4 * Copyright (c) 1987-2012 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.
15 /* system customizations are in sysconfig.h */
19 /* #include <dmalloc.h> uncomment if using dmalloc */
23 #include "sysconfig.h"
32 * Text description of this software
33 * (We used to define this ourselves, but why bother when
34 * the GNU build tools do it for us?)
36 #define CITADEL PACKAGE_STRING
39 * REV_LEVEL is the current version number (multiplied by 100 to avoid having
40 * to fiddle with the decimal). REV_MIN is the oldest version of Citadel
41 * whose data files are compatible with the current version. If the data files
42 * are older than REV_MIN, none of the programs will work until the setup
43 * program is run again to bring things up to date. EXPORT_REV_MIN is the
44 * oldest version of Citadel whose export files we can read. The latter is
45 * usually more strict because you're not really supposed to dump/load and
46 * upgrade at the same time.
48 #define REV_LEVEL 805 /* This version */
49 #define REV_MIN 591 /* Oldest compatible database */
50 #define EXPORT_REV_MIN 760 /* Oldest compatible export files */
51 #define LIBCITADEL_MIN 805 /* Minimum required version of libcitadel */
53 #define SERVER_TYPE 0 /* zero for stock Citadel; other developers please
54 obtain SERVER_TYPE codes for your implementations */
56 #ifdef LIBCITADEL_VERSION_NUMBER
57 #if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
58 #error libcitadel is too old. Please upgrade it before continuing.
62 /* Various length constants */
64 #define UGLISTLEN 100 /* you get a ungoto list of this size */
65 #define ROOMNAMELEN 128 /* The size of a roomname string */
66 #define NONCE_SIZE 128 /* Added by <bc> to allow for APOP auth
67 * it is BIG becuase there is a hostname
68 * in the nonce, as per the APOP RFC.
71 #define USERNAME_SIZE 64 /* The size of a username string */
72 #define MAX_EDITORS 5 /* # of external editors supported */
73 /* MUST be at least 1 */
76 * Message expiration policy stuff
78 typedef struct ExpirePolicy ExpirePolicy;
81 #include "datadefinitions.h"
82 #include "dtds/expirepolicy-defs.h"
83 #include "undef_data.h"
89 #define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */
90 #define EXPIRE_MANUAL 1 /* Don't expire messages at all */
91 #define EXPIRE_NUMMSGS 2 /* Keep only latest n messages */
92 #define EXPIRE_AGE 3 /* Expire messages after n days */
96 * This struct stores a list of rooms with new messages which the client
97 * fetches from the server. This allows the client to "march" through
98 * relevant rooms without having to ask the server each time where to go next.
100 typedef struct march march;
103 #include "datadefinitions.h"
104 #include "dtds/march-defs.h"
105 #include "undef_data.h"
108 char march_name[ROOMNAMELEN];
109 unsigned int march_flags;
112 unsigned int march_flags2;
116 #define NODENAME config.c_nodename
117 #define FQDN config.c_fqdn
118 #define HUMANNODE config.c_humannode
119 #define PHONENUM config.c_phonenum
120 #define CTDLUID config.c_ctdluid
121 #define CREATAIDE config.c_creataide
122 #define REGISCALL config.c_regiscall
123 #define TWITDETECT config.c_twitdetect
124 #define TWITROOM config.c_twitroom
125 #define RESTRICT_INTERNET config.c_restrict
130 typedef struct ctdluser ctdluser;
131 struct ctdluser { /* User record */
133 #include "datadefinitions.h"
134 #include "dtds/user-defs.h"
135 #include "undef_data.h"
137 int version; /* Cit vers. which created this rec */
138 uid_t uid; /* Associate with a unix account? */
139 char password[32]; /* password */
140 unsigned flags; /* See US_ flags below */
141 long timescalled; /* Total number of logins */
142 long posted; /* Number of messages ever submitted */
143 cit_uint8_t axlevel; /* Access level */
144 long usernum; /* User number (never recycled) */
145 time_t lastcall; /* Date/time of most recent login */
146 int USuserpurge; /* Purge time (in days) for user */
147 char fullname[64]; /* Display name (primary identifier) */
151 /* Bits which may appear in CitControl.MMflags. Note that these don't
152 * necessarily pertain to the message base -- it's just a good place to
153 * store any global flags.
155 #define MM_VALID 4 /* New users need validating */
160 typedef struct ctdlroom ctdlroom;
163 #include "datadefinitions.h"
164 #include "dtds/room-defs.h"
165 #include "undef_data.h"
167 char QRname[ROOMNAMELEN]; /* Name of room */
168 char QRpasswd[10]; /* Only valid if it's a private rm */
169 long QRroomaide; /* User number of room aide */
170 long QRhighest; /* Highest message NUMBER in room */
171 time_t QRgen; /* Generation number of room */
172 unsigned QRflags; /* See flag values below */
173 char QRdirname[15]; /* Directory name, if applicable */
174 long QRinfo; /* Info file update relative to msgs*/
175 char QRfloor; /* Which floor this room is on */
176 time_t QRmtime; /* Date/time of last post */
177 struct ExpirePolicy QRep; /* Message expiration policy */
178 long QRnumber; /* Globally unique room number */
179 char QRorder; /* Sort key for room listing order */
180 unsigned QRflags2; /* Additional flags */
181 int QRdefaultview; /* How to display the contents */
184 /* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
185 * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
186 * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
187 * flagged with both QR_PRIVATE and QR_GUESSNAME. NEVER set all three flags.
193 #define MES_NORMAL 65 /* Normal message */
194 #define MES_ANONONLY 66 /* "****" header */
195 #define MES_ANONOPT 67 /* "Anonymous" header */
197 #define MES_ERROR (-1) /* Can't send message due to bad address */
198 #define MES_LOCAL 0 /* Local message, do no network processing */
199 #define MES_INTERNET 1 /* Convert msg and send as Internet mail */
200 #define MES_IGNET 2 /* Process recipient and send via Cit net */
202 /****************************************************************************/
205 * Floor record. The floor number is implicit in its location in the file.
207 typedef struct floor floor;
210 #include "datadefinitions.h"
211 #include "dtds/floor-defs.h"
212 #include "undef_data.h"
214 unsigned short f_flags; /* flags */
215 char f_name[256]; /* name of floor */
216 int f_ref_count; /* reference count */
217 struct ExpirePolicy f_ep; /* default expiration policy */
220 #define F_INUSE 1 /* floor is in use */
224 * Values used internally for function call returns, etc.
227 #define NEWREGISTER 0 /* new user to register */
228 #define REREGISTER 1 /* existing user reregistering */
230 #define READ_HEADER 2
231 #define READ_MSGBODY 3
233 /* commands we can send to the stty_ctdl() routine */
234 #define SB_NO_INTR 0 /* set to Citadel client mode, i/q disabled */
235 #define SB_YES_INTR 1 /* set to Citadel client mode, i/q enabled */
236 #define SB_SAVE 2 /* save settings */
237 #define SB_RESTORE 3 /* restore settings */
238 #define SB_LAST 4 /* redo the last command sent */
243 /* server exit codes */
244 #define EXIT_NORMAL 0 /* server terminated normally */
245 /* 1 through 63 reserved for signals */
246 #define EXIT_NULL 64 /* EOF on server command input */
248 /* citadel.rc stuff */
249 #define RC_NO 0 /* always no */
250 #define RC_YES 1 /* always yes */
251 #define RC_DEFAULT 2 /* setting depends on user config */
255 KA_NO, /* no keepalives */
256 KA_YES, /* full keepalives */
257 KA_HALF /* half keepalives */
260 /* for <;G>oto and <;S>kip commands */
261 #define GF_GOTO 0 /* <;G>oto floor mode */
262 #define GF_SKIP 1 /* <;S>kip floor mode */
263 #define GF_ZAP 2 /* <;Z>ap floor mode */
266 * MIME types used in Citadel for configuration stuff
268 #define SPOOLMIME "application/x-citadel-delivery-list"
269 #define INTERNETCFG "application/x-citadel-internet-config"
270 #define IGNETCFG "application/x-citadel-ignet-config"
271 #define IGNETMAP "application/x-citadel-ignet-map"
272 #define FILTERLIST "application/x-citadel-filter-list"
273 #define SIEVECONFIG "application/x-citadel-sieve-config"
274 #define XMPPMORTUARY "application/x-citadel-xmpp-mortuary"
276 #define TRACE syslog(LOG_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
279 #define LONG_MAX 2147483647L
283 * Authentication modes
285 #define AUTHMODE_NATIVE 0 /* Native (self-contained or "black box") */
286 #define AUTHMODE_HOST 1 /* Authenticate against the host OS user database */
287 #define AUTHMODE_LDAP 2 /* Authenticate against an LDAP server with RFC 2307 schema */
288 #define AUTHMODE_LDAP_AD 3 /* Authenticate against non-standard MS Active Directory LDAP */
294 #endif /* CITADEL_H */