2 * main Citadel/UX header file
3 * see copyright.txt for copyright information
7 /* system customizations are in sysconfig.h */
11 #define CITADEL "Citadel/UX 5.70"
13 #define SERVER_TYPE 0 /* zero for stock Citadel/UX; other developers please
14 obtain SERVER_TYPE codes for your implementations */
17 #define tolower(x) ( ((x>='A')&&(x<='Z')) ? (x+'a'-'A') : x )
20 #define strucmp(lstr,rstr) struncmp(lstr,rstr,32767)
23 * The only typedef we do is an 8-bit unsigned, for screen dimensions.
24 * All other defs are done using standard C types. The code assumes that
25 * 'int' 'unsigned' and 'short' are at least 16 bits, and that 'long' is at
26 * least 32 bits. There are no endian dependencies in any of the Citadel
29 typedef unsigned char CIT_UBYTE;
31 #define ROOMNAMELEN 128
34 * Message expiration policy stuff
41 #define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */
42 #define EXPIRE_MANUAL 1 /* Don't expire messages at all */
43 #define EXPIRE_NUMMSGS 2 /* Keep only latest n messages */
44 #define EXPIRE_AGE 3 /* Expire messages after n days */
48 * Global system configuration
51 char c_nodename[16]; /* Unqualified "short" nodename */
52 char c_fqdn[64]; /* Fully Qualified Domain Name */
53 char c_humannode[21]; /* Long name of system */
54 char c_phonenum[16]; /* Dialup number of system */
55 int c_bbsuid; /* UID of the bbs-only user */
56 char c_creataide; /* room creator = room aide flag */
57 int c_sleeping; /* watchdog timer setting */
58 char c_initax; /* initial access level */
59 char c_regiscall; /* call number to register on */
60 char c_twitdetect; /* twit detect flag */
61 char c_twitroom[ROOMNAMELEN]; /* twit detect msg move to room */
62 char c_moreprompt[80]; /* paginator prompt */
63 char c_restrict; /* restrict Internet mail flag */
64 long c_msgbase; /* size of message base */
65 char c_bbs_city[32]; /* city and state you are located in*/
66 char c_sysadm[26]; /* name of system administrator */
67 char c_bucket_dir[15]; /* bit bucket for files... */
68 int c_setup_level; /* what rev level we've setup to */
69 int c_maxsessions; /* maximum concurrent sessions */
70 char c_net_password[20]; /* system net password */
71 int c_port_number; /* TCP port to run the server on */
72 int c_ipgm_secret; /* Internal program authentication */
73 struct ExpirePolicy c_ep; /* System default msg expire policy */
74 int c_userpurge; /* System default user purge (days) */
75 int c_roompurge; /* System default room purge (days) */
76 char c_logpages[ROOMNAMELEN]; /* Room to log pages to (or not) */
77 char c_createax; /* Axlevel required to create rooms */
78 long c_maxmsglen; /* Maximum message length */
79 int c_min_workers; /* Lower limit on number of threads */
80 int c_max_workers; /* Upper limit on number of threads */
83 #define NODENAME config.c_nodename
84 #define FQDN config.c_fqdn
85 #define HUMANNODE config.c_humannode
86 #define PHONENUM config.c_phonenum
87 #define BBSUID config.c_bbsuid
88 #define CREATAIDE config.c_creataide
89 #define REGISCALL config.c_regiscall
90 #define TWITDETECT config.c_twitdetect
91 #define TWITROOM config.c_twitroom
92 #define RESTRICT_INTERNET config.c_restrict
94 /* Defines the actual user record */
96 struct usersupp { /* User record */
97 int version; /* Cit vers. which created this rec */
98 uid_t uid; /* Associate with a unix account? */
99 char password[32]; /* password (for BBS-only users) */
100 unsigned flags; /* See US_ flags below */
101 long timescalled; /* Total number of logins */
102 long posted; /* Number of messages posted (ever) */
103 CIT_UBYTE axlevel; /* Access level */
104 long usernum; /* User number (never recycled) */
105 time_t lastcall; /* Last time the user called */
106 int USuserpurge; /* Purge time (in days) for user */
107 char fullname[64]; /* Name for Citadel messages & mail */
108 CIT_UBYTE USscreenwidth; /* Screen width (for textmode users)*/
109 CIT_UBYTE USscreenheight; /* Screen height(for textmode users)*/
113 /****************************************************************************
114 * This is the control record for the message base...
117 long MMhighest; /* highest message number in file */
118 unsigned MMflags; /* Global system flags */
119 long MMnextuser; /* highest user number on system */
120 long MMnextroom; /* highest room number on system */
121 int version; /* Server-hosted upgrade level */
124 /* Bits which may appear in CitControl.MMflags. Note that these don't
125 * necessarily pertain to the message base -- it's just a good place to
126 * store any global flags.
128 #define MM_VALID 4 /* New users need validating */
130 /****************************************************************************
134 char QRname[ROOMNAMELEN]; /* Name of room */
135 char QRpasswd[10]; /* Only valid if it's a private rm */
136 long QRroomaide; /* User number of room aide */
137 long QRhighest; /* Highest message NUMBER in room */
138 time_t QRgen; /* Generation number of room */
139 unsigned QRflags; /* See flag values below */
140 char QRdirname[15]; /* Directory name, if applicable */
141 long QRinfo; /* Info file update relative to msgs*/
142 char QRfloor; /* Which floor this room is on */
143 time_t QRmtime; /* Date/time of last post */
144 struct ExpirePolicy QRep; /* Message expiration policy */
145 long QRnumber; /* Globally unique room number */
146 char QRorder; /* Sort key for room listing order */
150 /* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
151 * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
152 * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
153 * flagged with both QR_PRIVATE and QR_GUESSNAME. NEVER set all three flags.
157 * Events which might show up in the Citadel Log
159 #define CL_CONNECT 8 /* Connect to server */
160 #define CL_LOGIN 16 /* CLfullname logged in */
161 #define CL_NEWUSER 32 /* CLfullname is a new user */
162 #define CL_BADPW 64 /* Bad attempt at CLfullname's pw */
163 #define CL_TERMINATE 128 /* Logout - proper termination */
164 #define CL_DROPCARR 256 /* Logout - dropped carrier */
165 #define CL_SLEEPING 512 /* Logout - sleeping */
166 #define CL_PWCHANGE 1024 /* CLfullname changed passwords */
170 #define MES_NORMAL 65 /* Normal message */
171 #define MES_ANON 66 /* "****" header */
172 #define MES_AN2 67 /* "Anonymous" header */
174 #define MES_ERROR (-1) /* Can't send message due to bad address */
175 #define MES_LOCAL 0 /* Local message, do no network processing */
176 #define MES_INTERNET 1 /* Convert msg and send as Internet mail */
177 #define MES_BINARY 2 /* Process recipient and send via Cit net */
179 /****************************************************************************/
183 long RMnum; /* Number or time of message */
187 /****************************************************************************
189 * Floor record. The floor number is implicit in its location in the file.
192 unsigned short f_flags; /* flags */
193 char f_name[256]; /* name of floor */
194 int f_ref_count; /* reference count */
195 struct ExpirePolicy f_ep; /* default expiration policy */
198 #define F_INUSE 1 /* floor is in use */
201 /****************************************************************************
202 * Values used internally for function call returns, etc.
205 #define NEWREGISTER 0 /* new user to register */
206 #define REREGISTER 1 /* existing user reregistering */
208 #define READ_HEADER 2
209 #define READ_MSGBODY 3
211 /* commands we can send to the sttybbs() routine */
212 #define SB_NO_INTR 0 /* set to bbs mode, i/q disabled */
213 #define SB_YES_INTR 1 /* set to bbs mode, i/q enabled */
214 #define SB_SAVE 2 /* save settings */
215 #define SB_RESTORE 3 /* restore settings */
216 #define SB_LAST 4 /* redo the last command sent */
221 /* server exit codes */
222 #define EXIT_NORMAL 0 /* server terminated normally */
223 /* 1 through 63 reserved for signals */
224 #define EXIT_NULL 64 /* EOF on server command input */
226 /* citadel.rc stuff */
227 #define RC_NO 0 /* always no */
228 #define RC_YES 1 /* always yes */
229 #define RC_DEFAULT 2 /* setting depends on user config */
232 #define KA_NO 0 /* no keepalives */
233 #define KA_YES 1 /* full keepalives */
234 #define KA_CHAT 2 /* half keepalives (for chat mode) */
236 /* for <;G>oto and <;S>kip commands */
237 #define GF_GOTO 0 /* <;G>oto floor mode */
238 #define GF_SKIP 1 /* <;S>kip floor mode */
239 #define GF_ZAP 2 /* <;Z>ap floor mode */
242 * MIME types used in Citadel for configuration stuff
244 #define SPOOLMIME "application/x-citadel-delivery-list"
245 #define INTERNETCFG "application/x-citadel-internet-config"
248 * This structure is used to hold all of the fields of a message
249 * during conversion, processing, or whatever.
271 #define TRACE lprintf(9, "Checkpoint: %s, %d\n", __FILE__, __LINE__)