citadel/citadel.h

   1 /* citadel.h
   2  * main Citadel/UX header file
   3  * see copyright.txt for copyright information
   4  * $Id$
   5  */
   6
   7 /* system customizations are in sysconfig.h */
   8 #include "sysdep.h"
   9 #include "sysconfig.h"
  10 #include "ipcdef.h"
  11 #define CITADEL "Citadel/UX DR19981026"
  12 #define REV_LEVEL 511
  13 #define SERVER_TYPE 0   /* zero for stock Citadel/UX; other developers please
  14                            obtain SERVER_TYPE codes for your implementations */
  15
  16 #undef  tolower
  17 #define tolower(x)      ( ((x>='A')&&(x<='Z')) ? (x+'a'-'A') : x )
  18 #define NEW_CONFIG
  19
  20 #define strucmp(lstr,rstr) struncmp(lstr,rstr,32767)
  21
  22 /*
  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
  27  * programs.
  28  */
  29 typedef unsigned char CIT_UBYTE;
  30
  31 #define ROOMNAMELEN     128
  32
  33 /*
  34  * Message expiration policy stuff
  35  */
  36 struct ExpirePolicy {
  37         int expire_mode;
  38         int expire_value;
  39         };
  40
  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 */
  45
  46
  47 /*
  48  * System configuration
  49  */
  50 struct config {
  51         char c_nodename[16];            /* UUCP and Citadel 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         int c_defent;                   /* command generated by <E> key     */
  63         char c_moreprompt[80];          /* paginator prompt                 */
  64         char c_restrict;                /* restrict Internet mail flag      */
  65         long c_msgbase;                 /* size of message base             */
  66         char c_bbs_city[32];            /* city and state you are located in*/
  67         char c_sysadm[26];              /* name of system administrator     */
  68         char c_bucket_dir[15];          /* bit bucket for files...          */
  69         int c_setup_level;              /* what rev level we've setup to    */
  70         int c_maxsessions;              /* maximum concurrent sessions      */
  71         char c_net_password[20];        /* system net password              */
  72         int c_port_number;              /* TCP port to run the server on    */
  73         int c_ipgm_secret;              /* Internal program authentication  */
  74         struct ExpirePolicy c_ep;       /* System default msg expire policy */
  75         };
  76
  77 #define NODENAME                config.c_nodename
  78 #define FQDN                    config.c_fqdn
  79 #define HUMANNODE               config.c_humannode
  80 #define PHONENUM                config.c_phonenum
  81 #define BBSUID                  config.c_bbsuid
  82 #define CREATAIDE               config.c_creataide
  83 #define REGISCALL               config.c_regiscall
  84 #define TWITDETECT              config.c_twitdetect
  85 #define TWITROOM                config.c_twitroom
  86 #define RESTRICT_INTERNET       config.c_restrict
  87
  88 /* Defines the actual user record */
  89 struct usersupp {                       /* User record                      */
  90         int USuid;                      /* userid (==BBSUID for bbs only)   */
  91         char password[20];              /* password (for BBS-only users)    */
  92         unsigned flags;                 /* See US_ flags below              */
  93         int timescalled;                /* Total number of logins           */
  94         int posted;                     /* Number of messages posted (ever) */
  95         char fullname[26];              /* Name for Citadel messages & mail */
  96         char axlevel;                   /* Access level                     */
  97         CIT_UBYTE USscreenwidth;        /* Screen width (for textmode users)*/
  98         CIT_UBYTE USscreenheight;       /* Screen height(for textmode users)*/
  99         long usernum;                   /* User number (never recycled)     */
 100         time_t lastcall;                /* Last time the user called        */
 101         char USname[30];                /* Real name (i.e. not a handle)    */
 102         char USaddr[25];                /* Street address                   */
 103         char UScity[15];                /* Municipality                     */
 104         char USstate[3];                /* State or province                */
 105         char USzip[10];                 /* ZIP code                         */
 106         char USphone[11];               /* Voice telephone number           */
 107         char USemail[32];               /* E-mail address (elsewhere)       */
 108         };
 109
 110
 111 /* this is a mask for all of the bits the user is allowed to change */
 112 #define US_USER_SET     (US_LASTOLD | US_EXPERT | US_UNLISTED | \
 113                         US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | US_FLOORS)
 114
 115 /****************************************************************************
 116  * This is the control record for the message base...
 117  */
 118 struct CitControl {
 119         long MMhighest;                 /* highest message number in file   */
 120         unsigned MMflags;               /* Global system flags              */
 121         long MMnextuser;                /* highest user number on system    */
 122         };
 123
 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.
 127  */
 128 #define MM_VALID        4               /* New users need validating        */
 129
 130 /****************************************************************************
 131  * Room records
 132  */
 133 struct quickroom {
 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         };
 146
 147
 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. DO NOT set all three flags.
 152  *
 153  ****************************************************************************/
 154
 155 /*
 156  * Events which might show up in the Citadel Log
 157  */
 158 #define CL_CONNECT      8               /* Connect to server                */
 159 #define CL_LOGIN        16              /* CLfullname logged in             */
 160 #define CL_NEWUSER      32              /* CLfullname is a new user         */
 161 #define CL_BADPW        64              /* Bad attempt at CLfullname's pw   */
 162 #define CL_TERMINATE    128             /* Logout - proper termination      */
 163 #define CL_DROPCARR     256             /* Logout - dropped carrier         */
 164 #define CL_SLEEPING     512             /* Logout - sleeping                */
 165 #define CL_PWCHANGE     1024            /* CLfullname changed passwords     */
 166
 167 /* Miscellaneous                                                            */
 168
 169 #define MES_NORMAL      65              /* Normal message                   */
 170 #define MES_ANON        66              /* "****" header                    */
 171 #define MES_AN2         67              /* "Anonymous" header               */
 172
 173 #define M_ERROR         (-1)    /* Can't send message due to bad address   */
 174 #define M_LOCAL         0       /* Local message, do no network processing */
 175 #define M_INTERNET      1       /* Convert msg and send as Internet mail   */
 176 #define M_BINARY        2       /* Process recipient and send via C/UX net */
 177
 178 /****************************************************************************/
 179
 180 struct recentmsg {
 181         char RMnodename[10];
 182         long RMnum;                     /* Number or time of message        */
 183         };
 184
 185
 186 /****************************************************************************
 187  *
 188  * Floor record.  The floor number is implicit in its location in the file.
 189  */
 190 struct floor {
 191         unsigned short f_flags;         /* flags */
 192         char f_name[256];               /* name of floor */
 193         int f_ref_count;                /* reference count */
 194         struct ExpirePolicy f_ep;       /* default expiration policy */
 195         };
 196
 197 #define F_INUSE         1               /* floor is in use */
 198
 199
 200 /****************************************************************************
 201  * Values used internally for function call returns, etc.
 202  */
 203
 204 #define NEWREGISTER     0               /* new user to register */
 205 #define REREGISTER      1               /* existing user reregistering */
 206
 207 #define READ_HEADER     2
 208 #define READ_MSGBODY    3
 209
 210 /* commands we can send to the sttybbs() routine */
 211 #define SB_NO_INTR      0               /* set to bbs mode, i/q disabled */
 212 #define SB_YES_INTR     1               /* set to bbs mode, i/q enabled */
 213 #define SB_SAVE         2               /* save settings */
 214 #define SB_RESTORE      3               /* restore settings */
 215 #define SB_LAST         4               /* redo the last command sent */
 216
 217 #define NEXT_KEY        15
 218 #define STOP_KEY        3
 219
 220 /* server exit codes */
 221 #define EXIT_NORMAL     0               /* server terminated normally */
 222                                         /* 1 through 63 reserved for signals */
 223 #define EXIT_NULL       64              /* EOF on server command input */
 224
 225 /* citadel.rc stuff */
 226 #define RC_NO           0               /* always no */
 227 #define RC_YES          1               /* always yes */
 228 #define RC_DEFAULT      2               /* setting depends on user config */
 229
 230 /* keepalives */
 231 #define KA_NO           0               /* no keepalives */
 232 #define KA_YES          1               /* full keepalives */
 233 #define KA_CHAT         2               /* half keepalives (for chat mode) */
 234
 235 /* for <;G>oto and <;S>kip commands */
 236 #define GF_GOTO         0               /* <;G>oto floor mode */
 237 #define GF_SKIP         1               /* <;S>kip floor mode */
 238 #define GF_ZAP          2               /* <;Z>ap floor mode */
 239
 240 /* message transfer formats */
 241 #define MT_CITADEL      0               /* Citadel proprietary */
 242 #define MT_RFC822       2               /* RFC822 */
 243 #define MT_RAW          3               /* IGnet raw format */
 244 #define MT_DATE         4               /* We're only looking for the date */
 245
 246
 247
 248 #define BASEROOM        "Lobby"
 249 #define MAILROOM        "Mail"
 250 #define AIDEROOM        "Aide"
 251
 252
 253