citadel/citadel.h

   1 /*
   2  * Main Citadel header file
   3  *
   4  * Copyright (c) 1987-2021 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 the build tools do it for us?)
  34  */
  35 #define CITADEL PACKAGE_STRING
  36
  37 #define REV_LEVEL 932           // This version
  38 #define REV_MIN         591             // Oldest compatible database
  39 #define EXPORT_REV_MIN  931             // Oldest compatible export files
  40 #define LIBCITADEL_MIN  931             // Minimum required version of libcitadel
  41 #define SERVER_TYPE     0               // zero for stock Citadel; other developers please obtain SERVER_TYPE codes for your implementations
  42
  43 #ifdef LIBCITADEL_VERSION_NUMBER
  44 #if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
  45 #error libcitadel is too old.  Please upgrade it before continuing.
  46 #endif
  47 #endif
  48
  49 /*
  50  * This is the user name and password for the default administrator account
  51  * that is created when Citadel Server is started with an empty database.
  52  */
  53 #define DEFAULT_ADMIN_USERNAME  "admin"
  54 #define DEFAULT_ADMIN_PASSWORD  "citadel"
  55
  56 /* Various length constants */
  57
  58 #define ROOMNAMELEN     128             /* The size of a roomname string */
  59 #define USERNAME_SIZE   64              /* The size of a username string */
  60 #define MAX_EDITORS     5               /* number of external editors supported ; must be at least 1 */
  61
  62 /*
  63  * Message expiration policy stuff
  64  */
  65 typedef struct ExpirePolicy ExpirePolicy;
  66 struct ExpirePolicy {
  67         int expire_mode;
  68         int expire_value;
  69 };
  70
  71 #define EXPIRE_NEXTLEVEL        0       // Inherit expiration policy
  72 #define EXPIRE_MANUAL           1       // Don't expire messages at all
  73 #define EXPIRE_NUMMSGS          2       // Keep only latest n messages
  74 #define EXPIRE_AGE              3       // Expire messages after n days
  75
  76
  77 /*
  78  * This struct stores a list of rooms with new messages which the client
  79  * fetches from the server.  This allows the client to "march" through
  80  * relevant rooms without having to ask the server each time where to go next.
  81  */
  82 typedef struct march march;
  83 struct march {
  84         struct march *next;
  85         char march_name[ROOMNAMELEN];
  86         unsigned int march_flags;
  87         char march_floor;
  88         char march_order;
  89         unsigned int march_flags2;
  90         int march_access;
  91 };
  92
  93
  94 /*
  95  * User records.
  96  */
  97 typedef struct ctdluser ctdluser;
  98 struct ctdluser {                       // User record
  99         int version;                    // Citadel version which created this record
 100         uid_t uid;                      // Associate with a unix account?
 101         char password[32];              // password
 102         unsigned flags;                 // See US_ flags below
 103         long timescalled;               // Total number of logins
 104         long posted;                    // Number of messages ever submitted
 105         cit_uint8_t axlevel;            // Access level
 106         long usernum;                   // User number (never recycled)
 107         time_t lastcall;                // Date/time of most recent login
 108         int USuserpurge;                // Purge time (in days) for user
 109         char fullname[64];              // Display name (primary identifier)
 110         long msgnum_bio;                // msgnum of user's profile (bio)
 111         long msgnum_pic;                // msgnum of user's avatar (photo)
 112         char emailaddrs[512];           // Internet email addresses
 113         long msgnum_inboxrules;         // msgnum of user's inbox filtering rules
 114         long lastproc_inboxrules;       // msgnum of last message filtered
 115 };
 116
 117
 118 /* Bits which may appear in MMflags.
 119  */
 120 #define MM_VALID        4               // New users need validating
 121
 122 /*
 123  * Room records.
 124  */
 125 typedef struct ctdlroom ctdlroom;
 126 struct ctdlroom {
 127         char QRname[ROOMNAMELEN];       // Name of room
 128         char QRpasswd[10];              // Only valid if it's a private rm
 129         long QRroomaide;                // User number of room aide
 130         long QRhighest;                 // Highest message NUMBER in room
 131         time_t QRgen;                   // Generation number of room
 132         unsigned QRflags;               // See flag values below
 133         char QRdirname[15];             // Directory name, if applicable
 134         long msgnum_info;               // msgnum of room banner (info file)
 135         char QRfloor;                   // Which floor this room is on
 136         time_t QRmtime;                 // Date/time of last post
 137         struct ExpirePolicy QRep;       // Message expiration policy
 138         long QRnumber;                  // Globally unique room number
 139         char QRorder;                   // Sort key for room listing order
 140         unsigned QRflags2;              // Additional flags
 141         int QRdefaultview;              // How to display the contents
 142         long msgnum_pic;                // msgnum of room picture or icon
 143 };
 144
 145 /* Private rooms are always flagged with QR_PRIVATE.  If neither QR_PASSWORDED
 146  * or QR_GUESSNAME is set, then it is invitation-only.  Passworded rooms are
 147  * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
 148  * flagged with both QR_PRIVATE and QR_GUESSNAME.  NEVER set all three flags.
 149  */
 150
 151 /*
 152  * Miscellaneous
 153  */
 154 #define MES_NORMAL      65              // Normal message
 155 #define MES_ANONONLY    66              // "****" header
 156 #define MES_ANONOPT     67              // "Anonymous" header
 157
 158 /****************************************************************************/
 159
 160 /*
 161  * Floor record.  The floor number is implicit in its location in the file.
 162  */
 163 typedef struct floor floor;
 164 struct floor {
 165         unsigned short f_flags;         // flags
 166         char f_name[256];               // name of floor
 167         int f_ref_count;                // reference count
 168         struct ExpirePolicy f_ep;       // default expiration policy
 169 };
 170
 171 #define F_INUSE         1               // floor is in use
 172
 173
 174 /*
 175  * Values used internally for function call returns, etc.
 176  */
 177 #define NEWREGISTER     0               // new user to register
 178 #define REREGISTER      1               // existing user reregistering
 179
 180 /* number of items which may be handled by the CONF command */
 181 #define NUM_CONFIGS 71
 182
 183 #define TRACE   syslog(LOG_DEBUG, "\033[7m  Checkpoint: %s : %d  \033[0m", __FILE__, __LINE__)
 184
 185 #ifndef LONG_MAX
 186 #define LONG_MAX 2147483647L
 187 #endif
 188
 189 /*
 190  * Authentication modes
 191  */
 192 #define AUTHMODE_NATIVE         0       // Native (self-contained or "black box")
 193 #define AUTHMODE_HOST           1       // Authenticate against the host OS user database
 194 #define AUTHMODE_LDAP           2       // Authenticate against an LDAP server with RFC 2307 schema
 195 #define AUTHMODE_LDAP_AD        3       // Authenticate against non-standard MS Active Directory LDAP
 196
 197 #ifdef __cplusplus
 198 }
 199 #endif
 200
 201 #if __GNUC__ >= 8
 202 #pragma GCC diagnostic push
 203 #pragma GCC diagnostic ignored "-Wformat-truncation"
 204 #endif
 205
 206 #endif /* CITADEL_H */