4 * Main Citadel header file
5 * See copyright.txt for copyright information.
8 /* system customizations are in sysconfig.h */
12 /* #include <dmalloc.h> uncomment if using dmalloc */
14 /* Build Citadel with the calendar service only if the header *and*
15 * library for libical are both present.
19 #define CITADEL_WITH_CALENDAR_SERVICE 1
25 #include "sysconfig.h"
34 * Text description of this software
35 * (We used to define this ourselves, but why bother when
36 * the GNU build tools do it for us?)
38 #define CITADEL PACKAGE_STRING
41 * REV_LEVEL is the current version number (multiplied by 100 to avoid having
42 * to fiddle with the decimal). REV_MIN is the oldest version of Citadel
43 * whose data files are compatible with the current version. If the data files
44 * are older than REV_MIN, none of the programs will work until the setup
45 * program is run again to bring things up to date. EXPORT_REV_MIN is the
46 * oldest version of Citadel whose export files we can read. The latter is
47 * usually more strict because you're not really supposed to dump/load and
48 * upgrade at the same time.
50 #define REV_LEVEL 732 /* This version */
51 #define REV_MIN 591 /* Oldest compatible database */
52 #define EXPORT_REV_MIN 725 /* Oldest compatible export files */
53 #define LIBCITADEL_MIN 107 /* Minimum required version of libcitadel */
55 #define SERVER_TYPE 0 /* zero for stock Citadel; other developers please
56 obtain SERVER_TYPE codes for your implementations */
58 #ifdef LIBCITADEL_VERSION_NUMBER
59 #if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
60 #error libcitadel is too old. Please upgrade it before continuing.
64 /* Various length constants */
66 #define UGLISTLEN 100 /* you get a ungoto list of this size */
67 #define ROOMNAMELEN 128 /* The size of a roomname string */
68 #define NONCE_SIZE 128 /* Added by <bc> to allow for APOP auth
69 * it is BIG becuase there is a hostname
70 * in the nonce, as per the APOP RFC.
73 #define USERNAME_SIZE 64 /* The size of a username string */
74 #define MAX_EDITORS 5 /* # of external editors supported */
75 /* MUST be at least 1 */
78 * Message expiration policy stuff
80 typedef struct ExpirePolicy ExpirePolicy;
83 #include "datadefinitions.h"
84 #include "dtds/expirepolicy-defs.h"
85 #include "undef_data.h"
91 #define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */
92 #define EXPIRE_MANUAL 1 /* Don't expire messages at all */
93 #define EXPIRE_NUMMSGS 2 /* Keep only latest n messages */
94 #define EXPIRE_AGE 3 /* Expire messages after n days */
98 * This struct stores a list of rooms with new messages which the client
99 * fetches from the server. This allows the client to "march" through
100 * relevant rooms without having to ask the server each time where to go next.
102 typedef struct march march;
105 #include "datadefinitions.h"
106 #include "dtds/march-defs.h"
107 #include "undef_data.h"
110 char march_name[ROOMNAMELEN];
111 unsigned int march_flags;
114 unsigned int march_flags2;
118 #define NODENAME config.c_nodename
119 #define FQDN config.c_fqdn
120 #define HUMANNODE config.c_humannode
121 #define PHONENUM config.c_phonenum
122 #define CTDLUID config.c_ctdluid
123 #define CREATAIDE config.c_creataide
124 #define REGISCALL config.c_regiscall
125 #define TWITDETECT config.c_twitdetect
126 #define TWITROOM config.c_twitroom
127 #define RESTRICT_INTERNET config.c_restrict
132 typedef struct ctdluser ctdluser;
133 struct ctdluser { /* User record */
135 #include "datadefinitions.h"
136 #include "dtds/user-defs.h"
137 #include "undef_data.h"
139 int version; /* Cit vers. which created this rec */
140 uid_t uid; /* Associate with a unix account? */
141 char password[32]; /* password */
142 unsigned flags; /* See US_ flags below */
143 long timescalled; /* Total number of logins */
144 long posted; /* Number of messages ever submitted */
145 cit_uint8_t axlevel; /* Access level */
146 long usernum; /* User number (never recycled) */
147 time_t lastcall; /* Date/time of most recent login */
148 int USuserpurge; /* Purge time (in days) for user */
149 char fullname[64]; /* Display name (primary identifier) */
150 cit_uint8_t USscreenwidth; /* Screen width (for textmode users) */
151 cit_uint8_t USscreenheight; /* Screen height(for textmode users) */
155 /* Bits which may appear in CitControl.MMflags. Note that these don't
156 * necessarily pertain to the message base -- it's just a good place to
157 * store any global flags.
159 #define MM_VALID 4 /* New users need validating */
164 typedef struct ctdlroom ctdlroom;
167 #include "datadefinitions.h"
168 #include "dtds/room-defs.h"
169 #include "undef_data.h"
171 char QRname[ROOMNAMELEN]; /* Name of room */
172 char QRpasswd[10]; /* Only valid if it's a private rm */
173 long QRroomaide; /* User number of room aide */
174 long QRhighest; /* Highest message NUMBER in room */
175 time_t QRgen; /* Generation number of room */
176 unsigned QRflags; /* See flag values below */
177 char QRdirname[15]; /* Directory name, if applicable */
178 long QRinfo; /* Info file update relative to msgs*/
179 char QRfloor; /* Which floor this room is on */
180 time_t QRmtime; /* Date/time of last post */
181 struct ExpirePolicy QRep; /* Message expiration policy */
182 long QRnumber; /* Globally unique room number */
183 char QRorder; /* Sort key for room listing order */
184 unsigned QRflags2; /* Additional flags */
185 int QRdefaultview; /* How to display the contents */
188 /* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
189 * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
190 * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
191 * flagged with both QR_PRIVATE and QR_GUESSNAME. NEVER set all three flags.
197 #define MES_NORMAL 65 /* Normal message */
198 #define MES_ANONONLY 66 /* "****" header */
199 #define MES_ANONOPT 67 /* "Anonymous" header */
201 #define MES_ERROR (-1) /* Can't send message due to bad address */
202 #define MES_LOCAL 0 /* Local message, do no network processing */
203 #define MES_INTERNET 1 /* Convert msg and send as Internet mail */
204 #define MES_IGNET 2 /* Process recipient and send via Cit net */
206 /****************************************************************************/
209 * Floor record. The floor number is implicit in its location in the file.
211 typedef struct floor floor;
214 #include "datadefinitions.h"
215 #include "dtds/floor-defs.h"
216 #include "undef_data.h"
218 unsigned short f_flags; /* flags */
219 char f_name[256]; /* name of floor */
220 int f_ref_count; /* reference count */
221 struct ExpirePolicy f_ep; /* default expiration policy */
224 #define F_INUSE 1 /* floor is in use */
228 * Values used internally for function call returns, etc.
231 #define NEWREGISTER 0 /* new user to register */
232 #define REREGISTER 1 /* existing user reregistering */
234 #define READ_HEADER 2
235 #define READ_MSGBODY 3
237 /* commands we can send to the stty_ctdl() routine */
238 #define SB_NO_INTR 0 /* set to Citadel client mode, i/q disabled */
239 #define SB_YES_INTR 1 /* set to Citadel client mode, i/q enabled */
240 #define SB_SAVE 2 /* save settings */
241 #define SB_RESTORE 3 /* restore settings */
242 #define SB_LAST 4 /* redo the last command sent */
247 /* server exit codes */
248 #define EXIT_NORMAL 0 /* server terminated normally */
249 /* 1 through 63 reserved for signals */
250 #define EXIT_NULL 64 /* EOF on server command input */
252 /* citadel.rc stuff */
253 #define RC_NO 0 /* always no */
254 #define RC_YES 1 /* always yes */
255 #define RC_DEFAULT 2 /* setting depends on user config */
259 KA_NO, /* no keepalives */
260 KA_YES, /* full keepalives */
261 KA_HALF /* half keepalives */
264 /* for <;G>oto and <;S>kip commands */
265 #define GF_GOTO 0 /* <;G>oto floor mode */
266 #define GF_SKIP 1 /* <;S>kip floor mode */
267 #define GF_ZAP 2 /* <;Z>ap floor mode */
270 * MIME types used in Citadel for configuration stuff
272 #define SPOOLMIME "application/x-citadel-delivery-list"
273 #define INTERNETCFG "application/x-citadel-internet-config"
274 #define IGNETCFG "application/x-citadel-ignet-config"
275 #define IGNETMAP "application/x-citadel-ignet-map"
276 #define FILTERLIST "application/x-citadel-filter-list"
277 #define SIEVECONFIG "application/x-citadel-sieve-config"
279 #define TRACE lprintf(CTDL_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
282 #define LONG_MAX 2147483647L
286 * Authentication modes
288 #define AUTHMODE_NATIVE 0 /* native Citadel authentication */
289 #define AUTHMODE_HOST 1 /* host integrated */
290 #define AUTHMODE_LDAP 2 /* external LDAP authentication */
296 #endif /* CITADEL_H */