2 * main Citadel/UX header file
3 * see copyright.doc for copyright information
6 /* system customizations are in sysconfig.h */
10 #define CITADEL "Citadel/UX DR19980818"
12 #define SERVER_TYPE 0 /* zero for stock Citadel/UX; other developers please
13 obtain SERVER_TYPE codes for your implementations */
16 #define tolower(x) ( ((x>='A')&&(x<='Z')) ? (x+'a'-'A') : x )
19 #define strucmp(lstr,rstr) struncmp(lstr,rstr,32767)
22 * The only typedef we do is an 8-bit unsigned, for screen dimensions.
23 * All other defs are done using standard C types. The code assumes that
24 * 'int' 'unsigned' and 'short' are at least 16 bits, and that 'long' is at
25 * least 32 bits. There are no endian dependencies in any of the Citadel
28 typedef unsigned char CIT_UBYTE;
31 char c_nodename[16]; /* UUCP and Citadel nodename */
32 char c_fqdn[64]; /* Fully Qualified Domain Name */
33 char c_humannode[21]; /* Long name of system */
34 char c_phonenum[16]; /* Dialup number of system */
35 int c_bbsuid; /* UID of the bbs-only user */
36 char c_creataide; /* room creator = room aide flag */
37 int c_sleeping; /* watchdog timer setting */
38 char c_initax; /* initial access level */
39 char c_regiscall; /* call number to register on */
40 char c_twitdetect; /* twit detect flag */
41 char c_twitroom[20]; /* twit detect msg move to room */
42 int c_defent; /* command generated by <E> key */
43 char c_moreprompt[80]; /* paginator prompt */
44 char c_restrict; /* restrict Internet mail flag */
45 long c_msgbase; /* size of message base */
46 char c_bbs_city[32]; /* city and state you are located in*/
47 char c_sysadm[26]; /* name of system administrator */
48 char c_bucket_dir[15]; /* bit bucket for files... */
49 int c_setup_level; /* what rev level we've setup to */
50 int c_maxsessions; /* maximum concurrent sessions */
51 char c_net_password[20]; /* system net password */
52 int c_port_number; /* TCP port to run the server on */
53 int c_ipgm_secret; /* Internal program authentication */
56 #define NODENAME config.c_nodename
57 #define FQDN config.c_fqdn
58 #define HUMANNODE config.c_humannode
59 #define PHONENUM config.c_phonenum
60 #define BBSUID config.c_bbsuid
61 #define CREATAIDE config.c_creataide
62 #define REGISCALL config.c_regiscall
63 #define TWITDETECT config.c_twitdetect
64 #define TWITROOM config.c_twitroom
65 #define RESTRICT_INTERNET config.c_restrict
68 /* Defines the relationship of a user to a particular room */
76 #define V_FORGET 1 /* User has zapped this room */
77 #define V_LOCKOUT 2 /* User is locked out of this room */
78 #define V_ACCESS 4 /* Access is granted to this room */
82 #define UA_GOTOALLOWED 4
83 #define UA_HASNEWMSGS 8
86 /* Defines the actual user record */
87 struct usersupp { /* User record */
88 int USuid; /* userid (==BBSUID for bbs only) */
89 char password[20]; /* password (for BBS-only users) */
90 unsigned flags; /* See US_ flags below */
91 int timescalled; /* Total number of logins */
92 int posted; /* Number of messages posted (ever) */
93 char fullname[26]; /* Name for Citadel messages & mail */
94 char axlevel; /* Access level */
95 CIT_UBYTE USscreenwidth; /* Screen width (for textmode users)*/
96 CIT_UBYTE USscreenheight; /* Screen height(for textmode users)*/
97 long usernum; /* User number (never recycled) */
98 time_t lastcall; /* Last time the user called */
99 char USname[30]; /* Real name (i.e. not a handle) */
100 char USaddr[25]; /* Street address */
101 char UScity[15]; /* Municipality */
102 char USstate[3]; /* State or province */
103 char USzip[10]; /* ZIP code */
104 char USphone[11]; /* Voice telephone number */
105 char USemail[32]; /* E-mail address (elsewhere) */
109 /* this is a mask for all of the bits the user is allowed to change */
110 #define US_USER_SET (US_LASTOLD | US_EXPERT | US_UNLISTED | \
111 US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | US_FLOORS)
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 */
122 /* Bits which may appear in CitControl.MMflags. Note that these don't
123 * necessarily pertain to the message base -- it's just a good place to
124 * store any global flags.
126 #define MM_VALID 4 /* New users need validating */
128 /****************************************************************************
132 char QRname[20]; /* Max. len is 19, plus null term */
133 char QRpasswd[10]; /* Only valid if it's a private rm */
134 long QRroomaide; /* User number of room aide */
135 long QRhighest; /* Highest message NUMBER in room */
136 long QRgen; /* Generation number of room */
137 unsigned QRflags; /* See flag values below */
138 char QRdirname[15]; /* Directory name, if applicable */
139 long QRinfo; /* Info file update relative to msgs*/
140 char QRfloor; /* Which floor this room is on */
141 time_t QRmtime; /* Date/time of last post */
145 /* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
146 * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
147 * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
148 * flagged with both QR_PRIVATE and QR_GUESSNAME. DO NOT set all three flags.
150 ****************************************************************************/
153 * Events which might show up in the Citadel Log
155 #define CL_CONNECT 8 /* Connect to server */
156 #define CL_LOGIN 16 /* CLfullname logged in */
157 #define CL_NEWUSER 32 /* CLfullname is a new user */
158 #define CL_BADPW 64 /* Bad attempt at CLfullname's pw */
159 #define CL_TERMINATE 128 /* Logout - proper termination */
160 #define CL_DROPCARR 256 /* Logout - dropped carrier */
161 #define CL_SLEEPING 512 /* Logout - sleeping */
162 #define CL_PWCHANGE 1024 /* CLfullname changed passwords */
166 #define MES_NORMAL 65 /* Normal message */
167 #define MES_ANON 66 /* "****" header */
168 #define MES_AN2 67 /* "Anonymous" header */
170 #define M_ERROR (-1) /* Can't send message due to bad address */
171 #define M_LOCAL 0 /* Local message, do no network processing */
172 #define M_INTERNET 1 /* Convert msg and send as Internet mail */
173 #define M_BINARY 2 /* Process recipient and send via C/UX net */
175 /****************************************************************************/
179 long RMnum; /* Number or time of message */
183 /****************************************************************************
185 * Floor record. The floor number is implicit in its location in the file.
188 unsigned short f_flags; /* flags */
189 char f_name[256]; /* name of floor */
190 int f_ref_count; /* reference count */
193 #define F_INUSE 1 /* floor is in use */
196 /****************************************************************************
197 * Values used internally for function call returns, etc.
200 #define NEWREGISTER 0 /* new user to register */
201 #define REREGISTER 1 /* existing user reregistering */
203 #define READ_HEADER 2
204 #define READ_MSGBODY 3
206 /* commands we can send to the sttybbs() routine */
207 #define SB_NO_INTR 0 /* set to bbs mode, i/q disabled */
208 #define SB_YES_INTR 1 /* set to bbs mode, i/q enabled */
209 #define SB_SAVE 2 /* save settings */
210 #define SB_RESTORE 3 /* restore settings */
215 /* server exit codes */
216 #define EXIT_NORMAL 0 /* server terminated normally */
217 /* 1 through 63 reserved for signals */
218 #define EXIT_NULL 64 /* EOF on server command input */
220 /* citadel.rc stuff */
221 #define RC_NO 0 /* always no */
222 #define RC_YES 1 /* always yes */
223 #define RC_DEFAULT 2 /* setting depends on user config */
226 #define KA_NO 0 /* no keepalives */
227 #define KA_YES 1 /* full keepalives */
228 #define KA_CHAT 2 /* half keepalives (for chat mode) */
230 /* for <;G>oto and <;S>kip commands */
231 #define GF_GOTO 0 /* <;G>oto floor mode */
232 #define GF_SKIP 1 /* <;S>kip floor mode */
233 #define GF_ZAP 2 /* <;Z>ap floor mode */
235 /* message transfer formats */
236 #define MT_CITADEL 0 /* Citadel proprietary */
237 #define MT_RFC822 2 /* RFC822 */
238 #define MT_RAW 3 /* IGnet raw format */