citadel/citadel.h

   1 /*
   2  * Main Citadel header file
   3  *
   4  * Copyright (c) 1987-2014 by the citadel.org team
   5  *
   6  * This program is open source software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License version 3.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  */
  14
  15 /* system customizations are in sysconfig.h */
  16
  17 #ifndef CITADEL_H
  18 #define CITADEL_H
  19 /* #include <dmalloc.h> uncomment if using dmalloc */
  20
  21 #include "sysdep.h"
  22 #include <limits.h>
  23 #include "sysconfig.h"
  24 #include "typesize.h"
  25 #include "ipcdef.h"
  26
  27 #ifdef __cplusplus
  28 extern "C" {
  29 #endif
  30
  31 /*
  32  * Text description of this software
  33  * (We used to define this ourselves, but why bother when
  34  * the GNU build tools do it for us?)
  35  */
  36 #define CITADEL PACKAGE_STRING
  37
  38 /*
  39  * REV_LEVEL is the current version number (multiplied by 100 to avoid having
  40  * to fiddle with the decimal).  REV_MIN is the oldest version of Citadel
  41  * whose data files are compatible with the current version.  If the data files
  42  * are older than REV_MIN, none of the programs will work until the setup
  43  * program is run again to bring things up to date.  EXPORT_REV_MIN is the
  44  * oldest version of Citadel whose export files we can read.  The latter is
  45  * usually more strict because you're not really supposed to dump/load and
  46  * upgrade at the same time.
  47  */
  48 #define REV_LEVEL       830             /* This version */
  49 #define REV_MIN         591             /* Oldest compatible database */
  50 #define EXPORT_REV_MIN  760             /* Oldest compatible export files */
  51 #define LIBCITADEL_MIN  829             /* Minimum required version of libcitadel */
  52
  53 #define SERVER_TYPE 0                   /* zero for stock Citadel; other developers please
  54                                            obtain SERVER_TYPE codes for your implementations */
  55
  56 #ifdef LIBCITADEL_VERSION_NUMBER
  57 #if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
  58 #error libcitadel is too old.  Please upgrade it before continuing.
  59 #endif
  60 #endif
  61
  62 /* Various length constants */
  63
  64 #define ROOMNAMELEN     128             /* The size of a roomname string */
  65 #define USERNAME_SIZE   64              /* The size of a username string */
  66 #define MAX_EDITORS     5               /* number of external editors supported ; must be at least 1 */
  67
  68 /*
  69  * Message expiration policy stuff
  70  */
  71 typedef struct ExpirePolicy ExpirePolicy;
  72 struct ExpirePolicy {
  73         int expire_mode;
  74         int expire_value;
  75 };
  76
  77 #define EXPIRE_NEXTLEVEL        0       /* Inherit expiration policy    */
  78 #define EXPIRE_MANUAL           1       /* Don't expire messages at all */
  79 #define EXPIRE_NUMMSGS          2       /* Keep only latest n messages  */
  80 #define EXPIRE_AGE              3       /* Expire messages after n days */
  81
  82
  83 /*
  84  * This struct stores a list of rooms with new messages which the client
  85  * fetches from the server.  This allows the client to "march" through
  86  * relevant rooms without having to ask the server each time where to go next.
  87  */
  88 typedef struct march march;
  89 struct march {
  90         struct march *next;
  91         char march_name[ROOMNAMELEN];
  92         unsigned int march_flags;
  93         char march_floor;
  94         char march_order;
  95         unsigned int march_flags2;
  96         int march_access;
  97 };
  98
  99
 100 /*
 101  * User records.
 102  */
 103 typedef struct ctdluser ctdluser;
 104 struct ctdluser {                       /* User record                       */
 105         int version;                    /* Cit vers. which created this rec  */
 106         uid_t uid;                      /* Associate with a unix account?    */
 107         char password[32];              /* password                          */
 108         unsigned flags;                 /* See US_ flags below               */
 109         long timescalled;               /* Total number of logins            */
 110         long posted;                    /* Number of messages ever submitted */
 111         cit_uint8_t axlevel;            /* Access level                      */
 112         long usernum;                   /* User number (never recycled)      */
 113         time_t lastcall;                /* Date/time of most recent login    */
 114         int USuserpurge;                /* Purge time (in days) for user     */
 115         char fullname[64];              /* Display name (primary identifier) */
 116 };
 117
 118
 119 /* Bits which may appear in CitControl.MMflags.  Note that these don't
 120  * necessarily pertain to the message base -- it's just a good place to
 121  * store any global flags.
 122  */
 123 #define MM_VALID        4               /* New users need validating        */
 124
 125 /*
 126  * Room records.
 127  */
 128 typedef struct ctdlroom ctdlroom;
 129 struct ctdlroom {
 130         char QRname[ROOMNAMELEN];       /* Name of room                     */
 131         char QRpasswd[10];              /* Only valid if it's a private rm  */
 132         long QRroomaide;                /* User number of room aide         */
 133         long QRhighest;                 /* Highest message NUMBER in room   */
 134         time_t QRgen;                   /* Generation number of room        */
 135         unsigned QRflags;               /* See flag values below            */
 136         char QRdirname[15];             /* Directory name, if applicable    */
 137         long QRinfo;                    /* Info file update relative to msgs*/
 138         char QRfloor;                   /* Which floor this room is on      */
 139         time_t QRmtime;                 /* Date/time of last post           */
 140         struct ExpirePolicy QRep;       /* Message expiration policy        */
 141         long QRnumber;                  /* Globally unique room number      */
 142         char QRorder;                   /* Sort key for room listing order  */
 143         unsigned QRflags2;              /* Additional flags                 */
 144         int QRdefaultview;              /* How to display the contents      */
 145 };
 146
 147 /* Private rooms are always flagged with QR_PRIVATE.  If neither QR_PASSWORDED
 148  * or QR_GUESSNAME is set, then it is invitation-only.  Passworded rooms are
 149  * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
 150  * flagged with both QR_PRIVATE and QR_GUESSNAME.  NEVER set all three flags.
 151  */
 152
 153 /*
 154  * Miscellaneous
 155  */
 156 #define MES_NORMAL      65              /* Normal message                   */
 157 #define MES_ANONONLY    66              /* "****" header                    */
 158 #define MES_ANONOPT     67              /* "Anonymous" header               */
 159
 160 #define MES_ERROR       (-1)    /* Can't send message due to bad address   */
 161 #define MES_LOCAL       0       /* Local message, do no network processing */
 162 #define MES_INTERNET    1       /* Convert msg and send as Internet mail   */
 163 #define MES_IGNET       2       /* Process recipient and send via Cit net  */
 164
 165 /****************************************************************************/
 166
 167 /*
 168  * Floor record.  The floor number is implicit in its location in the file.
 169  */
 170 typedef struct floor floor;
 171 struct floor {
 172         unsigned short f_flags;         /* flags */
 173         char f_name[256];               /* name of floor */
 174         int f_ref_count;                /* reference count */
 175         struct ExpirePolicy f_ep;       /* default expiration policy */
 176 };
 177
 178 #define F_INUSE         1               /* floor is in use */
 179
 180
 181 /*
 182  * Values used internally for function call returns, etc.
 183  */
 184
 185 #define NEWREGISTER     0               /* new user to register */
 186 #define REREGISTER      1               /* existing user reregistering */
 187
 188 /* number of items which may be handled by the CONF command */
 189 #define NUM_CONFIGS 71
 190
 191 #define TRACE   syslog(LOG_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
 192
 193 #ifndef LONG_MAX
 194 #define LONG_MAX 2147483647L
 195 #endif
 196
 197 /*
 198  * Authentication modes
 199  */
 200 #define AUTHMODE_NATIVE         0       /* Native (self-contained or "black box") */
 201 #define AUTHMODE_HOST           1       /* Authenticate against the host OS user database */
 202 #define AUTHMODE_LDAP           2       /* Authenticate against an LDAP server with RFC 2307 schema */
 203 #define AUTHMODE_LDAP_AD        3       /* Authenticate against non-standard MS Active Directory LDAP */
 204
 205 #ifdef __cplusplus
 206 }
 207 #endif
 208
 209 #endif /* CITADEL_H */