* Renamed "struct user" to "struct ctdluser"
[citadel.git] / citadel / citadel.h
index 048bfcafefb154b5c073a7cef72c1760ca951e42..3e970484b7b390651e664e6ca223ff369d585313 100644 (file)
@@ -6,39 +6,63 @@
  */
 
 /* system customizations are in sysconfig.h */
+
+#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"
 
-#define CITADEL        "Citadel/UX 5.73"       /* Text description of this software */
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+/*
+ * Text description of this software
+ */
+#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      573             /* This version */
-#define REV_MIN                570             /* 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 */
 
-#undef tolower
-#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 ROOMNAMELEN    128
+#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 */
 
 /*
  * Message expiration policy stuff
@@ -46,7 +70,7 @@ typedef unsigned char CIT_UBYTE;
 struct ExpirePolicy {
        int expire_mode;
        int expire_value;
-       };
+};
 
 #define EXPIRE_NEXTLEVEL       0       /* Inherit expiration policy    */
 #define EXPIRE_MANUAL          1       /* Don't expire messages at all */
@@ -55,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     */
@@ -71,14 +100,14 @@ 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             */
-       char c_bbs_city[32];            /* city and state you are located in*/
+       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              */
-       int c_port_number;              /* TCP port to run the server on    */
+       char c_net_password[20];        /* system net password (obsolete)   */
+       int c_port_number;              /* Cit listener port (usually 504)  */
        int c_ipgm_secret;              /* Internal program authentication  */
        struct ExpirePolicy c_ep;       /* System default msg expire policy */
        int c_userpurge;                /* System default user purge (days) */
@@ -90,7 +119,29 @@ 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_default_filter;           /* Default moderation filter level  */
+       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   */
+       char c_disable_newu;            /* disable NEWU command             */
+       char c_aide_mailboxes;          /* give Aides access to mailboxes   */
+       char c_baseroom[ROOMNAMELEN];   /* Name of baseroom (Lobby)         */
+       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
@@ -104,27 +155,27 @@ struct config {
 #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)*/
-       char moderation_filter;         /* Moderation filter level          */
-       };
+       cit_uint8_t USscreenwidth;      /* Screen width (for textmode users)*/
+       cit_uint8_t USscreenheight;     /* Screen height(for textmode users)*/
+};
 
 
-/****************************************************************************
+/*
  * This is the control record for the message base... 
  */
 struct CitControl {
@@ -133,7 +184,7 @@ struct CitControl {
        long MMnextuser;                /* highest user number on system    */
        long MMnextroom;                /* highest room number on system    */
        int version;                    /* Server-hosted upgrade level      */
-       };
+};
 
 /* Bits which may appear in CitControl.MMflags.  Note that these don't
  * necessarily pertain to the message base -- it's just a good place to
@@ -141,10 +192,10 @@ 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         */
@@ -158,8 +209,9 @@ struct quickroom {
        struct ExpirePolicy QRep;       /* Message expiration policy        */
        long QRnumber;                  /* Globally unique room number      */
        char QRorder;                   /* Sort key for room listing order  */
-       };
-
+       unsigned QRflags2;              /* Additional flags                 */
+       int QRdefaultview;              /* How to display the contents      */
+};
 
 /* Private rooms are always flagged with QR_PRIVATE.  If neither QR_PASSWORDED
  * or QR_GUESSNAME is set, then it is invitation-only.  Passworded rooms are
@@ -168,27 +220,16 @@ 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_ANON       66              /* "****" header                    */
-#define MES_AN2                67              /* "Anonymous" header               */
+#define MES_ANONONLY   66              /* "****" header                    */
+#define MES_ANONOPT    67              /* "Anonymous" header               */
 
 #define MES_ERROR      (-1)    /* Can't send message due to bad address   */
 #define MES_LOCAL      0       /* Local message, do no network processing */
 #define MES_INTERNET   1       /* Convert msg and send as Internet mail   */
-#define MES_BINARY     2       /* Process recipient and send via Cit net  */
+#define MES_IGNET      2       /* Process recipient and send via Cit net  */
 
 /****************************************************************************/
 
@@ -205,7 +246,7 @@ struct floor {
 #define F_INUSE                1               /* floor is in use */
 
 
-/****************************************************************************
+/*
  * Values used internally for function call returns, etc.
  */
 
@@ -236,9 +277,11 @@ struct floor {
 #define RC_DEFAULT     2               /* setting depends on user config */
 
 /* keepalives */
-#define KA_NO          0               /* no keepalives */
-#define KA_YES         1               /* full keepalives */
-#define KA_CHAT                2               /* half keepalives (for chat mode) */
+enum {
+       KA_NO,                          /* no keepalives */
+       KA_YES,                         /* full keepalives */
+       KA_HALF                         /* half keepalives */
+};
 
 /* for <;G>oto and <;S>kip commands */
 #define GF_GOTO                0               /* <;G>oto floor mode */
@@ -250,5 +293,37 @@ struct floor {
  */
 #define SPOOLMIME      "application/x-citadel-delivery-list"
 #define        INTERNETCFG     "application/x-citadel-internet-config"
+#define IGNETCFG       "application/x-citadel-ignet-config"
+#define IGNETMAP       "application/x-citadel-ignet-map"
+#define FILTERLIST     "application/x-citadel-filter-list"
+#define SPAMSTRINGS    "application/x-citadel-spam-strings"
 
 #define TRACE  lprintf(9, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
+
+#ifndef LONG_MAX
+#define LONG_MAX 2147483647L
+#endif
+
+
+/*
+ * Views
+ */
+#define        VIEW_BBS                0       /* Traditional Citadel BBS view */
+#define VIEW_MAILBOX           1       /* Mailbox summary */
+#define VIEW_ADDRESSBOOK       2       /* Address book view */
+
+#ifdef __cplusplus
+}
+#endif
+
+#ifdef tmpnam
+#undef tmpnam
+#endif
+#define tmpnam(x)      CtdlTempFileName(__FILE__, __LINE__)
+
+#ifdef tmpfile
+#undef tmpfile
+#endif
+#define tmpfile()      CtdlTempFile()
+
+#endif /* CITADEL_H */