]> code.citadel.org Git - citadel.git/blobdiff - citadel/citadel.h
* Variable names, comments, documentation, etc... removed the acronym 'BBS'
[citadel.git] / citadel / citadel.h
index 3e970484b7b390651e664e6ca223ff369d585313..677ac0ad91dbc143b78035bbd58fc8f074ade7de 100644 (file)
@@ -1,7 +1,7 @@
 /*
  * $Id$
  *
- * main Citadel/UX header file
+ * main Citadel header file
  * see copyright.txt for copyright information
  */
 
@@ -9,6 +9,7 @@
 
 #ifndef CITADEL_H
 #define CITADEL_H
+/* #include <dmalloc.h> uncomment if using dmalloc */
 
 /* Build Citadel with the calendar service only if the header *and*
  * library for libical are both present.
@@ -32,7 +33,7 @@ extern "C" {
 /*
  * Text description of this software
  */
-#define CITADEL        "Citadel/UX 6.08"
+#define CITADEL        "Citadel 6.45"
 
 /*
  * REV_LEVEL is the current version number (multiplied by 100 to avoid having
@@ -44,11 +45,11 @@ extern "C" {
  * usually more strict because you're not really supposed to dump/load and
  * upgrade at the same time.
  */
-#define REV_LEVEL      608             /* This version */
+#define REV_LEVEL      645             /* This version */
 #define REV_MIN                591             /* Oldest compatible database */
-#define EXPORT_REV_MIN 608             /* Oldest compatible export files */
+#define EXPORT_REV_MIN 626             /* Oldest compatible export files */
 
-#define SERVER_TYPE 0  /* zero for stock Citadel/UX; other developers please
+#define SERVER_TYPE 0  /* zero for stock Citadel; other developers please
                           obtain SERVER_TYPE codes for your implementations */
 
 /* Various length constants */
@@ -82,16 +83,17 @@ struct ExpirePolicy {
  * 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.
+ * can't simply remove them from the struct, because this gets written to
+ * disk, and if you change it then you'll break all existing systems.
+ * However, if you'd like to reclaim some of that space for another use, feel
+ * free to do so, as long as the sizes are kept identical.
  */
 struct config {
        char c_nodename[16];            /* Unqualified "short" nodename     */
        char c_fqdn[64];                /* Fully Qualified Domain Name      */
        char c_humannode[21];           /* Long name of system              */
        char c_phonenum[16];            /* Dialup number of system          */
-       uid_t c_bbsuid;                 /* UID of the bbs-only user         */
+       uid_t c_ctdluid;                /* UID under which we run Citadel   */
        char c_creataide;               /* room creator = room aide  flag   */
        int c_sleeping;                 /* watchdog timer setting           */
        char c_initax;                  /* initial access level             */
@@ -101,12 +103,12 @@ struct config {
        char c_moreprompt[80];          /* paginator prompt                 */
        char c_restrict;                /* restrict Internet mail flag      */
        long c_niu_1;                   /* (not in use)                     */
-       char c_bbs_city[32];            /* physical location of server      */
+       char c_site_location[32];               /* physical location of server      */
        char c_sysadm[26];              /* name of system administrator     */
        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)   */
+       char c_ip_addr[20];             /* IP address to listen on          */
        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 */
@@ -124,9 +126,20 @@ struct config {
        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_niu_4;                   /* (not in use)                     */
        char c_baseroom[ROOMNAMELEN];   /* Name of baseroom (Lobby)         */
        char c_aideroom[ROOMNAMELEN];   /* Name of aideroom (Aide)          */
+       int c_purge_hour;               /* Hour during which db purges run  */
+       struct ExpirePolicy c_mbxep;    /* Expire policy for mailbox rooms  */
+       char c_ldap_host[128];          /* Host where LDAP service lives    */
+       int c_ldap_port;                /* Port on host where LDAP lives    */
+       char c_ldap_base_dn[256];       /* LDAP base DN                     */
+       char c_ldap_bind_dn[256];       /* LDAP bind DN                     */
+       char c_ldap_bind_pw[256];       /* LDAP bind password               */
+       int c_msa_port;                 /* SMTP MSA listener port (usu 587) */
+       int c_imaps_port;               /* IMAPS listener port (usually 993)*/
+       int c_pop3s_port;               /* POP3S listener port (usually 995)*/
+       int c_smtps_port;               /* SMTPS listener port (usually 465)*/
 };
 
 /*
@@ -148,7 +161,7 @@ struct march {
 #define FQDN                   config.c_fqdn
 #define HUMANNODE              config.c_humannode
 #define PHONENUM               config.c_phonenum
-#define BBSUID                 config.c_bbsuid
+#define CTDLUID                        config.c_ctdluid
 #define CREATAIDE              config.c_creataide
 #define REGISCALL              config.c_regiscall
 #define TWITDETECT             config.c_twitdetect
@@ -161,7 +174,7 @@ struct march {
 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)    */
+       char password[32];              /* password (for Citadel-only users)*/
        unsigned flags;                 /* See US_ flags below              */
        long timescalled;               /* Total number of logins           */
        long posted;                    /* Number of messages posted (ever) */
@@ -241,7 +254,7 @@ struct floor {
        char f_name[256];               /* name of floor */
        int f_ref_count;                /* reference count */
        struct ExpirePolicy f_ep;       /* default expiration policy */
-       };
+};
 
 #define F_INUSE                1               /* floor is in use */
 
@@ -256,9 +269,9 @@ struct floor {
 #define READ_HEADER    2
 #define READ_MSGBODY   3
 
-/* commands we can send to the sttybbs() routine */
-#define SB_NO_INTR     0               /* set to bbs mode, i/q disabled */
-#define SB_YES_INTR    1               /* set to bbs mode, i/q enabled */
+/* commands we can send to the stty_ctdl() routine */
+#define SB_NO_INTR     0               /* set to Citadel client mode, i/q disabled */
+#define SB_YES_INTR    1               /* set to Citadel client mode, i/q enabled */
 #define SB_SAVE                2               /* save settings */
 #define SB_RESTORE     3               /* restore settings */
 #define SB_LAST                4               /* redo the last command sent */
@@ -296,9 +309,8 @@ enum {
 #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__)
+#define TRACE  lprintf(CTDL_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
 
 #ifndef LONG_MAX
 #define LONG_MAX 2147483647L
@@ -308,22 +320,15 @@ enum {
 /*
  * Views
  */
-#define        VIEW_BBS                0       /* Traditional Citadel BBS view */
+#define        VIEW_BBS                0       /* Bulletin board view */
 #define VIEW_MAILBOX           1       /* Mailbox summary */
 #define VIEW_ADDRESSBOOK       2       /* Address book view */
+#define VIEW_CALENDAR          3       /* Calendar view */
+#define VIEW_TASKS             4       /* Tasks view */
+#define VIEW_NOTES             5       /* Notes 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 */