4 * main Citadel header file
5 * see copyright.txt for copyright information
8 /* system customizations are in sysconfig.h */
13 /* Build Citadel with the calendar service only if the header *and*
14 * library for libical are both present.
18 #define CITADEL_WITH_CALENDAR_SERVICE 1
24 #include "sysconfig.h"
33 * Text description of this software
35 #define CITADEL "Citadel 6.27"
38 * REV_LEVEL is the current version number (multiplied by 100 to avoid having
39 * to fiddle with the decimal). REV_MIN is the oldest version of Citadel
40 * whose data files are compatible with the current version. If the data files
41 * are older than REV_MIN, none of the programs will work until the setup
42 * program is run again to bring things up to date. EXPORT_REV_MIN is the
43 * oldest version of Citadel whose export files we can read. The latter is
44 * usually more strict because you're not really supposed to dump/load and
45 * upgrade at the same time.
47 #define REV_LEVEL 627 /* This version */
48 #define REV_MIN 591 /* Oldest compatible database */
49 #define EXPORT_REV_MIN 626 /* Oldest compatible export files */
51 #define SERVER_TYPE 0 /* zero for stock Citadel; other developers please
52 obtain SERVER_TYPE codes for your implementations */
54 /* Various length constants */
56 #define UGLISTLEN 100 /* you get a ungoto list of this size */
57 #define ROOMNAMELEN 128 /* The size of a roomname string */
58 #define NONCE_SIZE 128 /* Added by <bc> to allow for APOP auth
59 * it is BIG becuase there is a hostname
60 * in the nonce, as per the APOP RFC.
63 #define USERNAME_SIZE 64 /* The size of a username string */
64 #define MAX_EDITORS 5 /* # of external editors supported */
65 /* MUST be at least 1 */
68 * Message expiration policy stuff
75 #define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */
76 #define EXPIRE_MANUAL 1 /* Don't expire messages at all */
77 #define EXPIRE_NUMMSGS 2 /* Keep only latest n messages */
78 #define EXPIRE_AGE 3 /* Expire messages after n days */
82 * Global system configuration.
84 * Developers: please do NOT remove the fields labelled "not in use". We
85 * can't simply remove them from the struct, because this gets written to
86 * disk, and if you change it then you'll break all existing systems.
87 * However, if you'd like to reclaim some of that space for another use, feel
88 * free to do so, as long as the sizes are kept identical.
91 char c_nodename[16]; /* Unqualified "short" nodename */
92 char c_fqdn[64]; /* Fully Qualified Domain Name */
93 char c_humannode[21]; /* Long name of system */
94 char c_phonenum[16]; /* Dialup number of system */
95 uid_t c_bbsuid; /* UID of the bbs-only user */
96 char c_creataide; /* room creator = room aide flag */
97 int c_sleeping; /* watchdog timer setting */
98 char c_initax; /* initial access level */
99 char c_regiscall; /* call number to register on */
100 char c_twitdetect; /* twit detect flag */
101 char c_twitroom[ROOMNAMELEN]; /* twit detect msg move to room */
102 char c_moreprompt[80]; /* paginator prompt */
103 char c_restrict; /* restrict Internet mail flag */
104 long c_niu_1; /* (not in use) */
105 char c_bbs_city[32]; /* physical location of server */
106 char c_sysadm[26]; /* name of system administrator */
107 char c_niu_2[15]; /* (not in use) */
108 int c_setup_level; /* what rev level we've setup to */
109 int c_maxsessions; /* maximum concurrent sessions */
110 char c_ip_addr[20]; /* IP address to listen on */
111 int c_port_number; /* Cit listener port (usually 504) */
112 int c_ipgm_secret; /* Internal program authentication */
113 struct ExpirePolicy c_ep; /* System default msg expire policy */
114 int c_userpurge; /* System default user purge (days) */
115 int c_roompurge; /* System default room purge (days) */
116 char c_logpages[ROOMNAMELEN]; /* Room to log pages to (or not) */
117 char c_createax; /* Axlevel required to create rooms */
118 long c_maxmsglen; /* Maximum message length */
119 int c_min_workers; /* Lower limit on number of threads */
120 int c_max_workers; /* Upper limit on number of threads */
121 int c_pop3_port; /* POP3 listener port (usually 110) */
122 int c_smtp_port; /* SMTP listener port (usually 25) */
123 int c_rfc822_strict_from; /* 1 = don't correct From: forgeries*/
124 int c_aide_zap; /* Are Aides allowed to zap rooms? */
125 int c_imap_port; /* IMAP listener port (usually 143) */
126 time_t c_net_freq; /* how often to run the networker */
127 char c_disable_newu; /* disable NEWU command */
128 char c_niu_4; /* (not in use) */
129 char c_baseroom[ROOMNAMELEN]; /* Name of baseroom (Lobby) */
130 char c_aideroom[ROOMNAMELEN]; /* Name of aideroom (Aide) */
131 int c_purge_hour; /* Hour during which db purges run */
132 struct ExpirePolicy c_mbxep; /* Expire policy for mailbox rooms */
133 char c_ldap_host[128]; /* Host where LDAP service lives */
134 int c_ldap_port; /* Port on host where LDAP lives */
135 char c_ldap_base_dn[256]; /* LDAP base DN */
136 char c_ldap_bind_dn[256]; /* LDAP bind DN */
137 char c_ldap_bind_pw[256]; /* LDAP bind password */
138 int c_msa_port; /* SMTP MSA listener port (usu 587) */
142 * This struct stores a list of rooms with new messages which the client
143 * fetches from the server. This allows the client to "march" through
144 * relevant rooms without having to ask the server each time where to go next.
148 char march_name[ROOMNAMELEN];
149 unsigned int march_flags;
152 unsigned int march_flags2;
156 #define NODENAME config.c_nodename
157 #define FQDN config.c_fqdn
158 #define HUMANNODE config.c_humannode
159 #define PHONENUM config.c_phonenum
160 #define BBSUID config.c_bbsuid
161 #define CREATAIDE config.c_creataide
162 #define REGISCALL config.c_regiscall
163 #define TWITDETECT config.c_twitdetect
164 #define TWITROOM config.c_twitroom
165 #define RESTRICT_INTERNET config.c_restrict
170 struct ctdluser { /* User record */
171 int version; /* Cit vers. which created this rec */
172 uid_t uid; /* Associate with a unix account? */
173 char password[32]; /* password (for BBS-only users) */
174 unsigned flags; /* See US_ flags below */
175 long timescalled; /* Total number of logins */
176 long posted; /* Number of messages posted (ever) */
177 cit_uint8_t axlevel; /* Access level */
178 long usernum; /* User number (never recycled) */
179 time_t lastcall; /* Last time the user called */
180 int USuserpurge; /* Purge time (in days) for user */
181 char fullname[64]; /* Name for Citadel messages & mail */
182 cit_uint8_t USscreenwidth; /* Screen width (for textmode users)*/
183 cit_uint8_t USscreenheight; /* Screen height(for textmode users)*/
188 * This is the control record for the message base...
191 long MMhighest; /* highest message number in file */
192 unsigned MMflags; /* Global system flags */
193 long MMnextuser; /* highest user number on system */
194 long MMnextroom; /* highest room number on system */
195 int version; /* Server-hosted upgrade level */
198 /* Bits which may appear in CitControl.MMflags. Note that these don't
199 * necessarily pertain to the message base -- it's just a good place to
200 * store any global flags.
202 #define MM_VALID 4 /* New users need validating */
208 char QRname[ROOMNAMELEN]; /* Name of room */
209 char QRpasswd[10]; /* Only valid if it's a private rm */
210 long QRroomaide; /* User number of room aide */
211 long QRhighest; /* Highest message NUMBER in room */
212 time_t QRgen; /* Generation number of room */
213 unsigned QRflags; /* See flag values below */
214 char QRdirname[15]; /* Directory name, if applicable */
215 long QRinfo; /* Info file update relative to msgs*/
216 char QRfloor; /* Which floor this room is on */
217 time_t QRmtime; /* Date/time of last post */
218 struct ExpirePolicy QRep; /* Message expiration policy */
219 long QRnumber; /* Globally unique room number */
220 char QRorder; /* Sort key for room listing order */
221 unsigned QRflags2; /* Additional flags */
222 int QRdefaultview; /* How to display the contents */
225 /* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
226 * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
227 * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
228 * flagged with both QR_PRIVATE and QR_GUESSNAME. NEVER set all three flags.
234 #define MES_NORMAL 65 /* Normal message */
235 #define MES_ANONONLY 66 /* "****" header */
236 #define MES_ANONOPT 67 /* "Anonymous" header */
238 #define MES_ERROR (-1) /* Can't send message due to bad address */
239 #define MES_LOCAL 0 /* Local message, do no network processing */
240 #define MES_INTERNET 1 /* Convert msg and send as Internet mail */
241 #define MES_IGNET 2 /* Process recipient and send via Cit net */
243 /****************************************************************************/
246 * Floor record. The floor number is implicit in its location in the file.
249 unsigned short f_flags; /* flags */
250 char f_name[256]; /* name of floor */
251 int f_ref_count; /* reference count */
252 struct ExpirePolicy f_ep; /* default expiration policy */
255 #define F_INUSE 1 /* floor is in use */
259 * Values used internally for function call returns, etc.
262 #define NEWREGISTER 0 /* new user to register */
263 #define REREGISTER 1 /* existing user reregistering */
265 #define READ_HEADER 2
266 #define READ_MSGBODY 3
268 /* commands we can send to the sttybbs() routine */
269 #define SB_NO_INTR 0 /* set to bbs mode, i/q disabled */
270 #define SB_YES_INTR 1 /* set to bbs mode, i/q enabled */
271 #define SB_SAVE 2 /* save settings */
272 #define SB_RESTORE 3 /* restore settings */
273 #define SB_LAST 4 /* redo the last command sent */
278 /* server exit codes */
279 #define EXIT_NORMAL 0 /* server terminated normally */
280 /* 1 through 63 reserved for signals */
281 #define EXIT_NULL 64 /* EOF on server command input */
283 /* citadel.rc stuff */
284 #define RC_NO 0 /* always no */
285 #define RC_YES 1 /* always yes */
286 #define RC_DEFAULT 2 /* setting depends on user config */
290 KA_NO, /* no keepalives */
291 KA_YES, /* full keepalives */
292 KA_HALF /* half keepalives */
295 /* for <;G>oto and <;S>kip commands */
296 #define GF_GOTO 0 /* <;G>oto floor mode */
297 #define GF_SKIP 1 /* <;S>kip floor mode */
298 #define GF_ZAP 2 /* <;Z>ap floor mode */
301 * MIME types used in Citadel for configuration stuff
303 #define SPOOLMIME "application/x-citadel-delivery-list"
304 #define INTERNETCFG "application/x-citadel-internet-config"
305 #define IGNETCFG "application/x-citadel-ignet-config"
306 #define IGNETMAP "application/x-citadel-ignet-map"
307 #define FILTERLIST "application/x-citadel-filter-list"
309 #define TRACE lprintf(CTDL_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
312 #define LONG_MAX 2147483647L
319 #define VIEW_BBS 0 /* Traditional Citadel BBS view */
320 #define VIEW_MAILBOX 1 /* Mailbox summary */
321 #define VIEW_ADDRESSBOOK 2 /* Address book view */
322 #define VIEW_CALENDAR 3 /* Calendar view */
323 #define VIEW_TASKS 4 /* Tasks view */
324 #define VIEW_NOTES 5 /* Notes view */
330 #endif /* CITADEL_H */