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         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         };
  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         int USuserpurge;                /* Purge time (in days) for user    */
 109         };
 110
 111
 112 /* this is a mask for all of the bits the user is allowed to change */
 113 #define US_USER_SET     (US_LASTOLD | US_EXPERT | US_UNLISTED | \
 114                         US_NOPROMPT | US_DISAPPEAR | US_PAGINATOR | US_FLOORS)
 115
 116 /****************************************************************************
 117  * This is the control record for the message base...
 118  */
 119 struct CitControl {
 120         long MMhighest;                 /* highest message number in file   */
 121         unsigned MMflags;               /* Global system flags              */
 122         long MMnextuser;                /* highest user number on system    */
 123         };
 124
 125 /* Bits which may appear in CitControl.MMflags.  Note that these don't
 126  * necessarily pertain to the message base -- it's just a good place to
 127  * store any global flags.
 128  */
 129 #define MM_VALID        4               /* New users need validating        */
 130
 131 /****************************************************************************
 132  * Room records
 133  */
 134 struct quickroom {
 135         char QRname[ROOMNAMELEN];       /* Name of room                     */
 136         char QRpasswd[10];              /* Only valid if it's a private rm  */
 137         long QRroomaide;                /* User number of room aide         */
 138         long QRhighest;                 /* Highest message NUMBER in room   */
 139         time_t QRgen;                   /* Generation number of room        */
 140         unsigned QRflags;               /* See flag values below            */
 141         char QRdirname[15];             /* Directory name, if applicable    */
 142         long QRinfo;                    /* Info file update relative to msgs*/
 143         char QRfloor;                   /* Which floor this room is on      */
 144         time_t QRmtime;                 /* Date/time of last post           */
 145         struct ExpirePolicy QRep;       /* Message expiration policy        */
 146         };
 147
 148
 149 /* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
 150  * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
 151  * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
 152  * flagged with both QR_PRIVATE and QR_GUESSNAME. DO NOT set all three flags.
 153  *
 154  ****************************************************************************/
 155
 156 /*
 157  * Events which might show up in the Citadel Log
 158  */
 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     */
 167
 168 /* Miscellaneous                                                            */
 169
 170 #define MES_NORMAL      65              /* Normal message                   */
 171 #define MES_ANON        66              /* "****" header                    */
 172 #define MES_AN2         67              /* "Anonymous" header               */
 173
 174 #define M_ERROR         (-1)    /* Can't send message due to bad address   */
 175 #define M_LOCAL         0       /* Local message, do no network processing */
 176 #define M_INTERNET      1       /* Convert msg and send as Internet mail   */
 177 #define M_BINARY        2       /* Process recipient and send via C/UX net */
 178
 179 /****************************************************************************/
 180
 181 struct recentmsg {
 182         char RMnodename[10];
 183         long RMnum;                     /* Number or time of message        */
 184         };
 185
 186
 187 /****************************************************************************
 188  *
 189  * Floor record.  The floor number is implicit in its location in the file.
 190  */
 191 struct floor {
 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 */
 196         };
 197
 198 #define F_INUSE         1               /* floor is in use */
 199
 200
 201 /****************************************************************************
 202  * Values used internally for function call returns, etc.
 203  */
 204
 205 #define NEWREGISTER     0               /* new user to register */
 206 #define REREGISTER      1               /* existing user reregistering */
 207
 208 #define READ_HEADER     2
 209 #define READ_MSGBODY    3
 210
 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 */
 217
 218 #define NEXT_KEY        15
 219 #define STOP_KEY        3
 220
 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 */
 225
 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 */
 230
 231 /* keepalives */
 232 #define KA_NO           0               /* no keepalives */
 233 #define KA_YES          1               /* full keepalives */
 234 #define KA_CHAT         2               /* half keepalives (for chat mode) */
 235
 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 */
 240
 241 /* message transfer formats */
 242 #define MT_CITADEL      0               /* Citadel proprietary */
 243 #define MT_RFC822       2               /* RFC822 */
 244 #define MT_RAW          3               /* IGnet raw format */
 245 #define MT_DATE         4               /* We're only looking for the date */
 246
 247
 248
 249 #define BASEROOM        "Lobby"
 250 #define MAILROOM        "Mail"
 251 #define AIDEROOM        "Aide"
 252
 253
 254