2 * Main Citadel header file
4 * Copyright (c) 1987-2017 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 911 // This version
49 #define REV_MIN 591 // Oldest compatible database
50 #define EXPORT_REV_MIN 760 // Oldest compatible export files
51 #define LIBCITADEL_MIN 903 // 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 */
65 #define USERNAME_SIZE 64 /* The size of a username string */
66 #define MAX_EDITORS 5 /* number of external editors supported ; must be at least 1 */
69 * Message expiration policy stuff
71 typedef struct ExpirePolicy ExpirePolicy;
77 #define EXPIRE_NEXTLEVEL 0 // Inherit expiration policy
78 #define EXPIRE_MANUAL 1 // Don't expire messages at all
79 #define EXPIRE_NUMMSGS 2 // Keep only latest n messages
80 #define EXPIRE_AGE 3 // Expire messages after n days
84 * This struct stores a list of rooms with new messages which the client
85 * fetches from the server. This allows the client to "march" through
86 * relevant rooms without having to ask the server each time where to go next.
88 typedef struct march march;
91 char march_name[ROOMNAMELEN];
92 unsigned int march_flags;
95 unsigned int march_flags2;
103 typedef struct ctdluser ctdluser;
104 struct ctdluser { // User record
105 int version; // Cit vers. which created this rec
106 uid_t uid; // Associate with a unix account?
107 char password[32]; // password
108 unsigned flags; // See US_ flags below
109 long timescalled; // Total number of logins
110 long posted; // Number of messages ever submitted
111 cit_uint8_t axlevel; // Access level
112 long usernum; // User number (never recycled)
113 time_t lastcall; // Date/time of most recent login
114 int USuserpurge; // Purge time (in days) for user
115 char fullname[64]; // Display name (primary identifier)
116 long msgnum_bio; // msgnum of user's profile (bio)
117 long msgnum_pic; // msgnum of user's avatar (photo)
121 /* Bits which may appear in MMflags.
123 #define MM_VALID 4 // New users need validating
128 typedef struct ctdlroom ctdlroom;
130 char QRname[ROOMNAMELEN]; // Name of room
131 char QRpasswd[10]; // Only valid if it's a private rm
132 long QRroomaide; // User number of room aide
133 long QRhighest; // Highest message NUMBER in room
134 time_t QRgen; // Generation number of room
135 unsigned QRflags; // See flag values below
136 char QRdirname[15]; // Directory name, if applicable
137 long msgnum_info; // msgnum of room banner (info file)
138 char QRfloor; // Which floor this room is on
139 time_t QRmtime; // Date/time of last post
140 struct ExpirePolicy QRep; // Message expiration policy
141 long QRnumber; // Globally unique room number
142 char QRorder; // Sort key for room listing order
143 unsigned QRflags2; // Additional flags
144 int QRdefaultview; // How to display the contents
145 long msgnum_pic; // msgnum of room picture or icon
148 /* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
149 * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
150 * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
151 * flagged with both QR_PRIVATE and QR_GUESSNAME. NEVER set all three flags.
157 #define MES_NORMAL 65 // Normal message
158 #define MES_ANONONLY 66 // "****" header
159 #define MES_ANONOPT 67 // "Anonymous" header
161 #define MES_ERROR (-1) // Can't send message due to bad address
162 #define MES_LOCAL 0 // Local message, do no network processing
163 #define MES_INTERNET 1 // Convert msg and send as Internet mail
164 #define MES_IGNET 2 // Process recipient and send via Cit net
166 /****************************************************************************/
169 * Floor record. The floor number is implicit in its location in the file.
171 typedef struct floor floor;
173 unsigned short f_flags; // flags
174 char f_name[256]; // name of floor
175 int f_ref_count; // reference count
176 struct ExpirePolicy f_ep; // default expiration policy
179 #define F_INUSE 1 // floor is in use
183 * Values used internally for function call returns, etc.
185 #define NEWREGISTER 0 // new user to register
186 #define REREGISTER 1 // existing user reregistering
188 /* number of items which may be handled by the CONF command */
189 #define NUM_CONFIGS 71
191 #define TRACE syslog(LOG_DEBUG, "\033[31mCheckpoint: %s : %d\033[0m", __FILE__, __LINE__)
194 #define LONG_MAX 2147483647L
198 * Authentication modes
200 #define AUTHMODE_NATIVE 0 // Native (self-contained or "black box")
201 #define AUTHMODE_HOST 1 // Authenticate against the host OS user database
202 #define AUTHMODE_LDAP 2 // Authenticate against an LDAP server with RFC 2307 schema
203 #define AUTHMODE_LDAP_AD 3 // Authenticate against non-standard MS Active Directory LDAP
209 #endif /* CITADEL_H */