* Renamed "struct user" to "struct ctdluser"
[citadel.git] / citadel / citadel.h
index ed51301c21bd53c28bb42e767651b41ea8a46a3c..3e970484b7b390651e664e6ca223ff369d585313 100644 (file)
 #ifndef CITADEL_H
 #define CITADEL_H
 
+/* Build Citadel with the calendar service only if the header *and*
+ * library for libical are both present.
+ */
+#ifdef HAVE_LIBICAL
+#ifdef HAVE_ICAL_H
+#define CITADEL_WITH_CALENDAR_SERVICE 1
+#endif
+#endif
+
 #include "sysdep.h"
 #include <limits.h>
 #include "sysconfig.h"
+#include "typesize.h"
 #include "ipcdef.h"
 
 #ifdef __cplusplus
@@ -22,51 +32,37 @@ extern "C" {
 /*
  * Text description of this software
  */
-#define CITADEL        "Citadel/UX 6.01"
+#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      601             /* 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
-
-/* 
- * The only typedef we do is an 8-bit unsigned, for screen dimensions.
- * All other defs are done using standard C types.  The code assumes that
- * 'int' 'unsigned' and 'short' are at least 16 bits, and that 'long' is at
- * least 32 bits.  There are no endian dependencies in any of the Citadel
- * programs.
- */
-typedef unsigned char CIT_UBYTE;
-
 /* 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  32              /* The size of a username string */
+#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
@@ -83,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     */
@@ -99,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)   */
@@ -118,7 +119,7 @@ struct config {
        int c_max_workers;              /* Upper limit on number of threads */
        int c_pop3_port;                /* POP3 listener port (usually 110) */
        int c_smtp_port;                /* SMTP listener port (usually 25)  */
-       int c_unused_1;                 /* Nothin' here anymore...          */
+       int c_rfc822_strict_from;       /* 1 = don't correct From: forgeries*/
        int c_aide_zap;                 /* Are Aides allowed to zap rooms?  */
        int c_imap_port;                /* IMAP listener port (usually 143) */
        time_t c_net_freq;              /* how often to run the networker   */
@@ -128,11 +129,19 @@ 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];
+       unsigned int march_flags;
        char march_floor;
        char march_order;
+       unsigned int march_flags2;
+       int march_access;
 };
 
 #define NODENAME               config.c_nodename
@@ -146,22 +155,23 @@ 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 ctdluser {                      /* 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)    */
        unsigned flags;                 /* See US_ flags below              */
        long timescalled;               /* Total number of logins           */
        long posted;                    /* Number of messages posted (ever) */
-       CIT_UBYTE axlevel;              /* Access level                     */
+       cit_uint8_t axlevel;            /* Access level                     */
        long usernum;                   /* User number (never recycled)     */
        time_t lastcall;                /* Last time the user called        */
        int USuserpurge;                /* Purge time (in days) for user    */
        char fullname[64];              /* Name for Citadel messages & mail */
-       CIT_UBYTE USscreenwidth;        /* Screen width (for textmode users)*/
-       CIT_UBYTE USscreenheight;       /* Screen height(for textmode users)*/
+       cit_uint8_t USscreenwidth;      /* Screen width (for textmode users)*/
+       cit_uint8_t USscreenheight;     /* Screen height(for textmode users)*/
 };
 
 
@@ -183,9 +193,9 @@ struct CitControl {
 #define MM_VALID       4               /* New users need validating        */
 
 /*
- * Room records
+ * Room records.
  */
-struct quickroom {
+struct ctdlroom {
        char QRname[ROOMNAMELEN];       /* Name of room                     */
        char QRpasswd[10];              /* Only valid if it's a private rm  */
        long QRroomaide;                /* User number of room aide         */
@@ -210,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               */
@@ -317,4 +316,14 @@ enum {
 }
 #endif
 
+#ifdef tmpnam
+#undef tmpnam
+#endif
+#define tmpnam(x)      CtdlTempFileName(__FILE__, __LINE__)
+
+#ifdef tmpfile
+#undef tmpfile
+#endif
+#define tmpfile()      CtdlTempFile()
+
 #endif /* CITADEL_H */