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 813 /* This version */
49 #define REV_MIN 591 /* Oldest compatible database */
50 #define EXPORT_REV_MIN 760 /* Oldest compatible export files */
51 #define LIBCITADEL_MIN 812 /* 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 ROOMNAMELEN 128 /* The size of a roomname string */
66 #define USERNAME_SIZE 64 /* The size of a username string */
67 #define MAX_EDITORS 5 /* # of external editors supported */
68 /* MUST be at least 1 */
71 * Message expiration policy stuff
73 typedef struct ExpirePolicy ExpirePolicy;
79 #define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */
80 #define EXPIRE_MANUAL 1 /* Don't expire messages at all */
81 #define EXPIRE_NUMMSGS 2 /* Keep only latest n messages */
82 #define EXPIRE_AGE 3 /* Expire messages after n days */
86 * This struct stores a list of rooms with new messages which the client
87 * fetches from the server. This allows the client to "march" through
88 * relevant rooms without having to ask the server each time where to go next.
90 typedef struct march march;
93 char march_name[ROOMNAMELEN];
94 unsigned int march_flags;
97 unsigned int march_flags2;
101 #define NODENAME config.c_nodename
102 #define FQDN config.c_fqdn
103 #define HUMANNODE config.c_humannode
104 #define PHONENUM config.c_phonenum
105 #define CTDLUID config.c_ctdluid
106 #define CREATAIDE config.c_creataide
107 #define REGISCALL config.c_regiscall
108 #define TWITDETECT config.c_twitdetect
109 #define TWITROOM config.c_twitroom
110 #define RESTRICT_INTERNET config.c_restrict
115 typedef struct ctdluser ctdluser;
116 struct ctdluser { /* User record */
117 int version; /* Cit vers. which created this rec */
118 uid_t uid; /* Associate with a unix account? */
119 char password[32]; /* password */
120 unsigned flags; /* See US_ flags below */
121 long timescalled; /* Total number of logins */
122 long posted; /* Number of messages ever submitted */
123 cit_uint8_t axlevel; /* Access level */
124 long usernum; /* User number (never recycled) */
125 time_t lastcall; /* Date/time of most recent login */
126 int USuserpurge; /* Purge time (in days) for user */
127 char fullname[64]; /* Display name (primary identifier) */
131 /* Bits which may appear in CitControl.MMflags. Note that these don't
132 * necessarily pertain to the message base -- it's just a good place to
133 * store any global flags.
135 #define MM_VALID 4 /* New users need validating */
140 typedef struct ctdlroom ctdlroom;
142 char QRname[ROOMNAMELEN]; /* Name of room */
143 char QRpasswd[10]; /* Only valid if it's a private rm */
144 long QRroomaide; /* User number of room aide */
145 long QRhighest; /* Highest message NUMBER in room */
146 time_t QRgen; /* Generation number of room */
147 unsigned QRflags; /* See flag values below */
148 char QRdirname[15]; /* Directory name, if applicable */
149 long QRinfo; /* Info file update relative to msgs*/
150 char QRfloor; /* Which floor this room is on */
151 time_t QRmtime; /* Date/time of last post */
152 struct ExpirePolicy QRep; /* Message expiration policy */
153 long QRnumber; /* Globally unique room number */
154 char QRorder; /* Sort key for room listing order */
155 unsigned QRflags2; /* Additional flags */
156 int QRdefaultview; /* How to display the contents */
159 /* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
160 * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
161 * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
162 * flagged with both QR_PRIVATE and QR_GUESSNAME. NEVER set all three flags.
168 #define MES_NORMAL 65 /* Normal message */
169 #define MES_ANONONLY 66 /* "****" header */
170 #define MES_ANONOPT 67 /* "Anonymous" header */
172 #define MES_ERROR (-1) /* Can't send message due to bad address */
173 #define MES_LOCAL 0 /* Local message, do no network processing */
174 #define MES_INTERNET 1 /* Convert msg and send as Internet mail */
175 #define MES_IGNET 2 /* Process recipient and send via Cit net */
177 /****************************************************************************/
180 * Floor record. The floor number is implicit in its location in the file.
182 typedef struct floor floor;
184 unsigned short f_flags; /* flags */
185 char f_name[256]; /* name of floor */
186 int f_ref_count; /* reference count */
187 struct ExpirePolicy f_ep; /* default expiration policy */
190 #define F_INUSE 1 /* floor is in use */
194 * Values used internally for function call returns, etc.
197 #define NEWREGISTER 0 /* new user to register */
198 #define REREGISTER 1 /* existing user reregistering */
200 /* number of items which may be handled by the CONF command */
201 #define NUM_CONFIGS 70
203 #define TRACE syslog(LOG_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
206 #define LONG_MAX 2147483647L
210 * Authentication modes
212 #define AUTHMODE_NATIVE 0 /* Native (self-contained or "black box") */
213 #define AUTHMODE_HOST 1 /* Authenticate against the host OS user database */
214 #define AUTHMODE_LDAP 2 /* Authenticate against an LDAP server with RFC 2307 schema */
215 #define AUTHMODE_LDAP_AD 3 /* Authenticate against non-standard MS Active Directory LDAP */
221 #endif /* CITADEL_H */