citserver version to 907
[citadel.git] / citadel / citadel.h
index 35956a4ba72dece7b50fa7fa57bac914c4aed84f..d728af6ecbc5b6f34924ac7682efe40fd0955ff5 100644 (file)
@@ -1,8 +1,15 @@
 /*
- * $Id$
- *
  * Main Citadel header file
- * See copyright.txt for copyright information.
+ *
+ * Copyright (c) 1987-2017 by the citadel.org team
+ *
+ * This program is open source software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License version 3.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  */
 
 /* system customizations are in sysconfig.h */
@@ -38,10 +45,10 @@ extern "C" {
  * usually more strict because you're not really supposed to dump/load and
  * upgrade at the same time.
  */
-#define REV_LEVEL      737             /* This version */
+#define REV_LEVEL      907             /* This version */
 #define REV_MIN                591             /* Oldest compatible database */
-#define EXPORT_REV_MIN 737             /* Oldest compatible export files */
-#define LIBCITADEL_MIN 115             /* Minimum required version of libcitadel */
+#define EXPORT_REV_MIN 760             /* Oldest compatible export files */
+#define LIBCITADEL_MIN 903             /* Minimum required version of libcitadel */
 
 #define SERVER_TYPE 0                  /* zero for stock Citadel; other developers please
                                           obtain SERVER_TYPE codes for your implementations */
@@ -54,27 +61,15 @@ extern "C" {
 
 /* 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 USERNAME_SIZE  64      /* The size of a username string */
-#define MAX_EDITORS    5       /* # of external editors supported */
-                               /* MUST be at least 1 */
+#define ROOMNAMELEN    128             /* The size of a roomname string */
+#define USERNAME_SIZE  64              /* The size of a username string */
+#define MAX_EDITORS    5               /* number of external editors supported ; must be at least 1 */
 
 /*
  * Message expiration policy stuff
  */
 typedef struct ExpirePolicy ExpirePolicy;
 struct ExpirePolicy {
-/*
-#include "datadefinitions.h"
-#include "dtds/expirepolicy-defs.h"
-#include "undef_data.h"
-*/
        int expire_mode;
        int expire_value;
 };
@@ -92,11 +87,6 @@ struct ExpirePolicy {
  */
 typedef struct march march;
 struct march {
-/*
-#include "datadefinitions.h"
-#include "dtds/march-defs.h"
-#include "undef_data.h"
-*/
        struct march *next;
        char march_name[ROOMNAMELEN];
        unsigned int march_flags;
@@ -106,27 +96,12 @@ struct march {
        int march_access;
 };
 
-#define NODENAME               config.c_nodename
-#define FQDN                   config.c_fqdn
-#define HUMANNODE              config.c_humannode
-#define PHONENUM               config.c_phonenum
-#define CTDLUID                        config.c_ctdluid
-#define CREATAIDE              config.c_creataide
-#define REGISCALL              config.c_regiscall
-#define TWITDETECT             config.c_twitdetect
-#define TWITROOM               config.c_twitroom
-#define RESTRICT_INTERNET      config.c_restrict
 
 /*
  * User records.
  */
 typedef struct ctdluser ctdluser;
-struct ctdluser {                      /* User record                      */
-/*
-#include "datadefinitions.h"
-#include "dtds/user-defs.h"
-#include "undef_data.h"
-*/
+struct ctdluser {                      /* User record                       */
        int version;                    /* Cit vers. which created this rec  */
        uid_t uid;                      /* Associate with a unix account?    */
        char password[32];              /* password                          */
@@ -138,14 +113,12 @@ struct ctdluser {                 /* User record                      */
        time_t lastcall;                /* Date/time of most recent login    */
        int USuserpurge;                /* Purge time (in days) for user     */
        char fullname[64];              /* Display name (primary identifier) */
-       cit_uint8_t USscreenwidth;      /* Screen width (for textmode users) */
-       cit_uint8_t USscreenheight;     /* Screen height(for textmode users) */
+       long msgnum_bio;                /* msgnum of user's profile (bio)    */
+       long msgnum_pic;                /* msgnum of user's avatar (photo)   */
 };
 
 
-/* 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
- * store any global flags.
+/* Bits which may appear in MMflags.
  */
 #define MM_VALID       4               /* New users need validating        */
 
@@ -154,11 +127,6 @@ struct ctdluser {                  /* User record                      */
  */
 typedef struct ctdlroom ctdlroom;
 struct ctdlroom {
-/*
-#include "datadefinitions.h"
-#include "dtds/room-defs.h"
-#include "undef_data.h"
-*/
        char QRname[ROOMNAMELEN];       /* Name of room                     */
        char QRpasswd[10];              /* Only valid if it's a private rm  */
        long QRroomaide;                /* User number of room aide         */
@@ -166,7 +134,7 @@ struct ctdlroom {
        time_t QRgen;                   /* Generation number of room        */
        unsigned QRflags;               /* See flag values below            */
        char QRdirname[15];             /* Directory name, if applicable    */
-       long QRinfo;                    /* Info file update relative to msgs*/
+       long msgnum_info;               /* msgnum of room banner (info file)*/
        char QRfloor;                   /* Which floor this room is on      */
        time_t QRmtime;                 /* Date/time of last post           */
        struct ExpirePolicy QRep;       /* Message expiration policy        */
@@ -174,6 +142,7 @@ struct ctdlroom {
        char QRorder;                   /* Sort key for room listing order  */
        unsigned QRflags2;              /* Additional flags                 */
        int QRdefaultview;              /* How to display the contents      */
+       long msgnum_pic;                /* msgnum of room picture or icon   */
 };
 
 /* Private rooms are always flagged with QR_PRIVATE.  If neither QR_PASSWORDED
@@ -201,11 +170,6 @@ struct ctdlroom {
  */
 typedef struct floor floor;
 struct floor {
-/*
-#include "datadefinitions.h"
-#include "dtds/floor-defs.h"
-#include "undef_data.h"
-*/
        unsigned short f_flags;         /* flags */
        char f_name[256];               /* name of floor */
        int f_ref_count;                /* reference count */
@@ -222,52 +186,10 @@ struct floor {
 #define NEWREGISTER    0               /* new user to register */
 #define REREGISTER     1               /* existing user reregistering */
 
-#define READ_HEADER    2
-#define READ_MSGBODY   3
-
-/* 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 */
-
-#define        NEXT_KEY        15
-#define STOP_KEY       3
-
-/* server exit codes */
-#define EXIT_NORMAL    0               /* server terminated normally */
-                                       /* 1 through 63 reserved for signals */
-#define EXIT_NULL      64              /* EOF on server command input */
-
-/* citadel.rc stuff */
-#define RC_NO          0               /* always no */
-#define RC_YES         1               /* always yes */
-#define RC_DEFAULT     2               /* setting depends on user config */
-
-/* keepalives */
-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 */
-#define GF_SKIP                1               /* <;S>kip floor mode */
-#define GF_ZAP         2               /* <;Z>ap floor mode */
-
-/*
- * MIME types used in Citadel for configuration stuff
- */
-#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 SIEVECONFIG    "application/x-citadel-sieve-config"
+/* number of items which may be handled by the CONF command */
+#define NUM_CONFIGS 71
 
-#define TRACE  CtdlLogPrintf(CTDL_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
+#define TRACE  syslog(LOG_DEBUG, "\033[31mCheckpoint: %s : %d\033[0m", __FILE__, __LINE__)
 
 #ifndef LONG_MAX
 #define LONG_MAX 2147483647L
@@ -276,9 +198,10 @@ enum {
 /*
  * Authentication modes
  */
-#define AUTHMODE_NATIVE                0       /* native Citadel authentication */
-#define AUTHMODE_HOST          1       /* host integrated */
-#define AUTHMODE_LDAP          2       /* external LDAP authentication */
+#define AUTHMODE_NATIVE                0       /* Native (self-contained or "black box") */
+#define AUTHMODE_HOST          1       /* Authenticate against the host OS user database */
+#define AUTHMODE_LDAP          2       /* Authenticate against an LDAP server with RFC 2307 schema */
+#define AUTHMODE_LDAP_AD       3       /* Authenticate against non-standard MS Active Directory LDAP */
 
 #ifdef __cplusplus
 }