]> code.citadel.org Git - citadel.git/blobdiff - citadel/citadel.h
*** empty log message ***
[citadel.git] / citadel / citadel.h
index 7fff11ec189fa915e89be46f63c29d6d27e3d8f1..814cf2c3d88c5febfd4c6c92b28f8b31a704ea2c 100644 (file)
@@ -32,44 +32,37 @@ extern "C" {
 /*
  * Text description of this software
  */
-#define CITADEL        "Citadel/UX 6.06"
+#define CITADEL        "Citadel/UX 6.08"
 
 /*
  * REV_LEVEL is the current version number (multiplied by 100 to avoid having
  * to fiddle with the decimal).  REV_MIN is the oldest version of Citadel
  * whose data files are compatible with the current version.  If the data files
  * are older than REV_MIN, none of the programs will work until the setup
- * program is run again to bring things up to date.
+ * program is run again to bring things up to date.  EXPORT_REV_MIN is the
+ * oldest version of Citadel whose export files we can read.  The latter is
+ * usually more strict because you're not really supposed to dump/load and
+ * upgrade at the same time.
  */
-#define REV_LEVEL      606             /* This version */
-#define REV_MIN                591             /* Oldest compatible version */
+#define REV_LEVEL      608             /* This version */
+#define REV_MIN                591             /* Oldest compatible database */
+#define EXPORT_REV_MIN 608             /* Oldest compatible export files */
 
 #define SERVER_TYPE 0  /* zero for stock Citadel/UX; other developers please
                           obtain SERVER_TYPE codes for your implementations */
 
-/*
- * This is a better implementation of tolower() than that found on some
- * systems (there are operating systems out there on which tolower() will
- * screw up if you give it a character that is already lower case).
- */
-#ifdef  tolower
-#undef tolower
-#endif
-#define tolower(x)     ( ((x>='A')&&(x<='Z')) ? (x+'a'-'A') : x )
-#define NEW_CONFIG
-
 /* Various length constants */
 
-#define UGLISTLEN   100   /* you get a ungoto list of this size */
-#define ROOMNAMELEN    128             /* The size of a roomname string */
-#define NONCE_SIZE     128             /* Added by <bc> to allow for APOP auth 
-                                        * it is BIG becuase there is a hostname
-                                        * in the nonce, as per the APOP RFC.
-                                        */
+#define UGLISTLEN      100     /* you get a ungoto list of this size */
+#define ROOMNAMELEN    128     /* The size of a roomname string */
+#define NONCE_SIZE     128     /* Added by <bc> to allow for APOP auth 
+                                * it is BIG becuase there is a hostname
+                                * in the nonce, as per the APOP RFC.
+                                */
                                         
-#define USERNAME_SIZE  64              /* The size of a username string */
-#define MAX_EDITORS    5               /* # of external editors supported */
-                                       /* MUST be at least 1 */
+#define USERNAME_SIZE  64      /* The size of a username string */
+#define MAX_EDITORS    5       /* # of external editors supported */
+                               /* MUST be at least 1 */
 
 /*
  * Message expiration policy stuff
@@ -86,7 +79,12 @@ struct ExpirePolicy {
 
 
 /* 
- * Global system configuration 
+ * Global system configuration.
+ * 
+ * Developers: please do NOT remove the fields labelled "not in use".  We
+ * can't simply remove them from the struct, because that would render the
+ * configs on existing systems corrupt.  However, if you need the same number
+ * of bytes for a *new* field, feel free to use them.
  */
 struct config {
        char c_nodename[16];            /* Unqualified "short" nodename     */
@@ -102,10 +100,10 @@ struct config {
        char c_twitroom[ROOMNAMELEN];   /* twit detect msg move to room     */
        char c_moreprompt[80];          /* paginator prompt                 */
        char c_restrict;                /* restrict Internet mail flag      */
-       long c_msgbase;                 /* size of message base (obsolete)  */
+       long c_niu_1;                   /* (not in use)                     */
        char c_bbs_city[32];            /* physical location of server      */
        char c_sysadm[26];              /* name of system administrator     */
-       char c_bucket_dir[15];          /* bit bucket for files...          */
+       char c_niu_2[15];               /* (not in use)                     */
        int c_setup_level;              /* what rev level we've setup to    */
        int c_maxsessions;              /* maximum concurrent sessions      */
        char c_net_password[20];        /* system net password (obsolete)   */
@@ -131,6 +129,11 @@ struct config {
        char c_aideroom[ROOMNAMELEN];   /* Name of aideroom (Aide)          */
 };
 
+/*
+ * This struct stores a list of rooms with new messages which the client
+ * fetches from the server.  This allows the client to "march" through
+ * relevant rooms without having to ask the server each time where to go next.
+ */
 struct march {
        struct march *next;
        char march_name[ROOMNAMELEN];
@@ -152,9 +155,10 @@ struct march {
 #define TWITROOM               config.c_twitroom
 #define RESTRICT_INTERNET      config.c_restrict
 
-/* Defines the actual user record */
-struct usersupp {                      /* User record                      */
+/*
+ * User records.
+ */
+struct user {                  /* User record                      */
        int version;                    /* Cit vers. which created this rec */
        uid_t uid;                      /* Associate with a unix account?   */
        char password[32];              /* password (for BBS-only users)    */
@@ -189,9 +193,9 @@ struct CitControl {
 #define MM_VALID       4               /* New users need validating        */
 
 /*
- * Room records
+ * Room records.
  */
-struct quickroom {
+struct room {
        char QRname[ROOMNAMELEN];       /* Name of room                     */
        char QRpasswd[10];              /* Only valid if it's a private rm  */
        long QRroomaide;                /* User number of room aide         */
@@ -216,19 +220,8 @@ struct quickroom {
  */
 
 /*
- * Events which might show up in the Citadel Log
+ * Miscellaneous
  */
-#define CL_CONNECT     8               /* Connect to server                */
-#define CL_LOGIN       16              /* CLfullname logged in             */
-#define CL_NEWUSER     32              /* CLfullname is a new user         */
-#define CL_BADPW       64              /* Bad attempt at CLfullname's pw   */
-#define CL_TERMINATE   128             /* Logout - proper termination      */
-#define CL_DROPCARR    256             /* Logout - dropped carrier         */
-#define CL_SLEEPING    512             /* Logout - sleeping                */
-#define CL_PWCHANGE    1024            /* CLfullname changed passwords     */
-
-/* Miscellaneous                                                            */
-
 #define MES_NORMAL     65              /* Normal message                   */
 #define MES_ANONONLY   66              /* "****" header                    */
 #define MES_ANONOPT    67              /* "Anonymous" header               */