citadel/citadel.h

   1 /*
   2  * $Id$
   3  *
   4  * main Citadel/UX header file
   5  * see copyright.txt for copyright information
   6  */
   7
   8 /* system customizations are in sysconfig.h */
   9 #include "sysdep.h"
  10 #include "sysconfig.h"
  11 #include "ipcdef.h"
  12
  13 #define CITADEL "Citadel/UX 5.73"       /* Text description of this software */
  14
  15 /*
  16  * REV_LEVEL is the current version number (multiplied by 100 to avoid having
  17  * to fiddle with the decimal).  REV_MIN is the oldest version of Citadel
  18  * whose data files are compatible with the current version.  If the data files
  19  * are older than REV_MIN, none of the programs will work until the setup
  20  * program is run again to bring things up to date.
  21  */
  22 #define REV_LEVEL       573             /* This version */
  23 #define REV_MIN         570             /* Oldest compatible version */
  24
  25 #define SERVER_TYPE 0   /* zero for stock Citadel/UX; other developers please
  26                            obtain SERVER_TYPE codes for your implementations */
  27
  28 #undef  tolower
  29 #define tolower(x)      ( ((x>='A')&&(x<='Z')) ? (x+'a'-'A') : x )
  30 #define NEW_CONFIG
  31
  32 /*
  33  * The only typedef we do is an 8-bit unsigned, for screen dimensions.
  34  * All other defs are done using standard C types.  The code assumes that
  35  * 'int' 'unsigned' and 'short' are at least 16 bits, and that 'long' is at
  36  * least 32 bits.  There are no endian dependencies in any of the Citadel
  37  * programs.
  38  */
  39 typedef unsigned char CIT_UBYTE;
  40
  41 /* Various length constants */
  42
  43 #define ROOMNAMELEN     128             /* The size of the roomname structure */
  44 #define NONCE_SIZE      128             /* Added by <bc> to allow for APOP auth
  45                                          * it is BIG becuase there is a hostname
  46                                          * in the nonce, as per the APOP RFC.
  47                                          */
  48
  49 #define USERNAME_SIZE   32              /* The size of a username string */
  50
  51 /*
  52  * Message expiration policy stuff
  53  */
  54 struct ExpirePolicy {
  55         int expire_mode;
  56         int expire_value;
  57         };
  58
  59 #define EXPIRE_NEXTLEVEL        0       /* Inherit expiration policy    */
  60 #define EXPIRE_MANUAL           1       /* Don't expire messages at all */
  61 #define EXPIRE_NUMMSGS          2       /* Keep only latest n messages  */
  62 #define EXPIRE_AGE              3       /* Expire messages after n days */
  63
  64
  65 /*
  66  * Global system configuration
  67  */
  68 struct config {
  69         char c_nodename[16];            /* Unqualified "short" nodename     */
  70         char c_fqdn[64];                /* Fully Qualified Domain Name      */
  71         char c_humannode[21];           /* Long name of system              */
  72         char c_phonenum[16];            /* Dialup number of system          */
  73         uid_t c_bbsuid;                 /* UID of the bbs-only user         */
  74         char c_creataide;               /* room creator = room aide  flag   */
  75         int c_sleeping;                 /* watchdog timer setting           */
  76         char c_initax;                  /* initial access level             */
  77         char c_regiscall;               /* call number to register on       */
  78         char c_twitdetect;              /* twit detect flag                 */
  79         char c_twitroom[ROOMNAMELEN];   /* twit detect msg move to room     */
  80         char c_moreprompt[80];          /* paginator prompt                 */
  81         char c_restrict;                /* restrict Internet mail flag      */
  82         long c_msgbase;                 /* size of message base             */
  83         char c_bbs_city[32];            /* city and state you are located in*/
  84         char c_sysadm[26];              /* name of system administrator     */
  85         char c_bucket_dir[15];          /* bit bucket for files...          */
  86         int c_setup_level;              /* what rev level we've setup to    */
  87         int c_maxsessions;              /* maximum concurrent sessions      */
  88         char c_net_password[20];        /* system net password              */
  89         int c_port_number;              /* TCP port to run the server on    */
  90         int c_ipgm_secret;              /* Internal program authentication  */
  91         struct ExpirePolicy c_ep;       /* System default msg expire policy */
  92         int c_userpurge;                /* System default user purge (days) */
  93         int c_roompurge;                /* System default room purge (days) */
  94         char c_logpages[ROOMNAMELEN];   /* Room to log pages to (or not)    */
  95         char c_createax;                /* Axlevel required to create rooms */
  96         long c_maxmsglen;               /* Maximum message length           */
  97         int c_min_workers;              /* Lower limit on number of threads */
  98         int c_max_workers;              /* Upper limit on number of threads */
  99         int c_pop3_port;                /* POP3 listener port (usually 110) */
 100         int c_smtp_port;                /* SMTP listener port (usually 25)  */
 101         int c_default_filter;           /* Default moderation filter level  */
 102 };
 103
 104 #define NODENAME                config.c_nodename
 105 #define FQDN                    config.c_fqdn
 106 #define HUMANNODE               config.c_humannode
 107 #define PHONENUM                config.c_phonenum
 108 #define BBSUID                  config.c_bbsuid
 109 #define CREATAIDE               config.c_creataide
 110 #define REGISCALL               config.c_regiscall
 111 #define TWITDETECT              config.c_twitdetect
 112 #define TWITROOM                config.c_twitroom
 113 #define RESTRICT_INTERNET       config.c_restrict
 114
 115 /* Defines the actual user record */
 116
 117 struct usersupp {                       /* User record                      */
 118         int version;                    /* Cit vers. which created this rec */
 119         uid_t uid;                      /* Associate with a unix account?   */
 120         char password[32];              /* password (for BBS-only users)    */
 121         unsigned flags;                 /* See US_ flags below              */
 122         long timescalled;               /* Total number of logins           */
 123         long posted;                    /* Number of messages posted (ever) */
 124         CIT_UBYTE axlevel;              /* Access level                     */
 125         long usernum;                   /* User number (never recycled)     */
 126         time_t lastcall;                /* Last time the user called        */
 127         int USuserpurge;                /* Purge time (in days) for user    */
 128         char fullname[64];              /* Name for Citadel messages & mail */
 129         CIT_UBYTE USscreenwidth;        /* Screen width (for textmode users)*/
 130         CIT_UBYTE USscreenheight;       /* Screen height(for textmode users)*/
 131         char moderation_filter;         /* Moderation filter level          */
 132         };
 133
 134
 135 /****************************************************************************
 136  * This is the control record for the message base...
 137  */
 138 struct CitControl {
 139         long MMhighest;                 /* highest message number in file   */
 140         unsigned MMflags;               /* Global system flags              */
 141         long MMnextuser;                /* highest user number on system    */
 142         long MMnextroom;                /* highest room number on system    */
 143         int version;                    /* Server-hosted upgrade level      */
 144         };
 145
 146 /* Bits which may appear in CitControl.MMflags.  Note that these don't
 147  * necessarily pertain to the message base -- it's just a good place to
 148  * store any global flags.
 149  */
 150 #define MM_VALID        4               /* New users need validating        */
 151
 152 /****************************************************************************
 153  * Room records
 154  */
 155 struct quickroom {
 156         char QRname[ROOMNAMELEN];       /* Name of room                     */
 157         char QRpasswd[10];              /* Only valid if it's a private rm  */
 158         long QRroomaide;                /* User number of room aide         */
 159         long QRhighest;                 /* Highest message NUMBER in room   */
 160         time_t QRgen;                   /* Generation number of room        */
 161         unsigned QRflags;               /* See flag values below            */
 162         char QRdirname[15];             /* Directory name, if applicable    */
 163         long QRinfo;                    /* Info file update relative to msgs*/
 164         char QRfloor;                   /* Which floor this room is on      */
 165         time_t QRmtime;                 /* Date/time of last post           */
 166         struct ExpirePolicy QRep;       /* Message expiration policy        */
 167         long QRnumber;                  /* Globally unique room number      */
 168         char QRorder;                   /* Sort key for room listing order  */
 169         };
 170
 171
 172 /* Private rooms are always flagged with QR_PRIVATE.  If neither QR_PASSWORDED
 173  * or QR_GUESSNAME is set, then it is invitation-only.  Passworded rooms are
 174  * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
 175  * flagged with both QR_PRIVATE and QR_GUESSNAME.  NEVER set all three flags.
 176  */
 177
 178 /*
 179  * Events which might show up in the Citadel Log
 180  */
 181 #define CL_CONNECT      8               /* Connect to server                */
 182 #define CL_LOGIN        16              /* CLfullname logged in             */
 183 #define CL_NEWUSER      32              /* CLfullname is a new user         */
 184 #define CL_BADPW        64              /* Bad attempt at CLfullname's pw   */
 185 #define CL_TERMINATE    128             /* Logout - proper termination      */
 186 #define CL_DROPCARR     256             /* Logout - dropped carrier         */
 187 #define CL_SLEEPING     512             /* Logout - sleeping                */
 188 #define CL_PWCHANGE     1024            /* CLfullname changed passwords     */
 189
 190 /* Miscellaneous                                                            */
 191
 192 #define MES_NORMAL      65              /* Normal message                   */
 193 #define MES_ANON        66              /* "****" header                    */
 194 #define MES_AN2         67              /* "Anonymous" header               */
 195
 196 #define MES_ERROR       (-1)    /* Can't send message due to bad address   */
 197 #define MES_LOCAL       0       /* Local message, do no network processing */
 198 #define MES_INTERNET    1       /* Convert msg and send as Internet mail   */
 199 #define MES_BINARY      2       /* Process recipient and send via Cit net  */
 200
 201 /****************************************************************************/
 202
 203 /*
 204  * Floor record.  The floor number is implicit in its location in the file.
 205  */
 206 struct floor {
 207         unsigned short f_flags;         /* flags */
 208         char f_name[256];               /* name of floor */
 209         int f_ref_count;                /* reference count */
 210         struct ExpirePolicy f_ep;       /* default expiration policy */
 211         };
 212
 213 #define F_INUSE         1               /* floor is in use */
 214
 215
 216 /****************************************************************************
 217  * Values used internally for function call returns, etc.
 218  */
 219
 220 #define NEWREGISTER     0               /* new user to register */
 221 #define REREGISTER      1               /* existing user reregistering */
 222
 223 #define READ_HEADER     2
 224 #define READ_MSGBODY    3
 225
 226 /* commands we can send to the sttybbs() routine */
 227 #define SB_NO_INTR      0               /* set to bbs mode, i/q disabled */
 228 #define SB_YES_INTR     1               /* set to bbs mode, i/q enabled */
 229 #define SB_SAVE         2               /* save settings */
 230 #define SB_RESTORE      3               /* restore settings */
 231 #define SB_LAST         4               /* redo the last command sent */
 232
 233 #define NEXT_KEY        15
 234 #define STOP_KEY        3
 235
 236 /* server exit codes */
 237 #define EXIT_NORMAL     0               /* server terminated normally */
 238                                         /* 1 through 63 reserved for signals */
 239 #define EXIT_NULL       64              /* EOF on server command input */
 240
 241 /* citadel.rc stuff */
 242 #define RC_NO           0               /* always no */
 243 #define RC_YES          1               /* always yes */
 244 #define RC_DEFAULT      2               /* setting depends on user config */
 245
 246 /* keepalives */
 247 #define KA_NO           0               /* no keepalives */
 248 #define KA_YES          1               /* full keepalives */
 249
 250 /* for <;G>oto and <;S>kip commands */
 251 #define GF_GOTO         0               /* <;G>oto floor mode */
 252 #define GF_SKIP         1               /* <;S>kip floor mode */
 253 #define GF_ZAP          2               /* <;Z>ap floor mode */
 254
 255 /*
 256  * MIME types used in Citadel for configuration stuff
 257  */
 258 #define SPOOLMIME       "application/x-citadel-delivery-list"
 259 #define INTERNETCFG     "application/x-citadel-internet-config"
 260
 261 #define TRACE   lprintf(9, "Checkpoint: %s, %d\n", __FILE__, __LINE__)