citadel/citadel.h

   1 /*
   2  * $Id$
   3  *
   4  * main Citadel header file
   5  * see copyright.txt for copyright information
   6  */
   7
   8 /* system customizations are in sysconfig.h */
   9
  10 #ifndef CITADEL_H
  11 #define CITADEL_H
  12 /* #include <dmalloc.h> uncomment if using dmalloc */
  13
  14 /* Build Citadel with the calendar service only if the header *and*
  15  * library for libical are both present.
  16  */
  17 #ifdef HAVE_LIBICAL
  18 #ifdef HAVE_ICAL_H
  19 #define CITADEL_WITH_CALENDAR_SERVICE 1
  20 #endif
  21 #endif
  22
  23 #include "sysdep.h"
  24 #include <limits.h>
  25 #include "sysconfig.h"
  26 #include "typesize.h"
  27 #include "ipcdef.h"
  28
  29 #ifdef __cplusplus
  30 extern "C" {
  31 #endif
  32
  33 /*
  34  * Text description of this software
  35  */
  36 #define CITADEL "Citadel 6.47"
  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       647             /* This version */
  49 #define REV_MIN         591             /* Oldest compatible database */
  50 #define EXPORT_REV_MIN  626             /* Oldest compatible export files */
  51
  52 #define SERVER_TYPE 0   /* zero for stock Citadel; other developers please
  53                            obtain SERVER_TYPE codes for your implementations */
  54
  55 /* Various length constants */
  56
  57 #define UGLISTLEN       100     /* you get a ungoto list of this size */
  58 #define ROOMNAMELEN     128     /* The size of a roomname string */
  59 #define NONCE_SIZE      128     /* Added by <bc> to allow for APOP auth
  60                                  * it is BIG becuase there is a hostname
  61                                  * in the nonce, as per the APOP RFC.
  62                                  */
  63
  64 #define USERNAME_SIZE   64      /* The size of a username string */
  65 #define MAX_EDITORS     5       /* # of external editors supported */
  66                                 /* MUST be at least 1 */
  67
  68 /*
  69  * Message expiration policy stuff
  70  */
  71 struct ExpirePolicy {
  72         int expire_mode;
  73         int expire_value;
  74 };
  75
  76 #define EXPIRE_NEXTLEVEL        0       /* Inherit expiration policy    */
  77 #define EXPIRE_MANUAL           1       /* Don't expire messages at all */
  78 #define EXPIRE_NUMMSGS          2       /* Keep only latest n messages  */
  79 #define EXPIRE_AGE              3       /* Expire messages after n days */
  80
  81
  82 /*
  83  * Global system configuration.
  84  *
  85  * Developers: please do NOT remove the fields labelled "not in use".  We
  86  * can't simply remove them from the struct, because this gets written to
  87  * disk, and if you change it then you'll break all existing systems.
  88  * However, if you'd like to reclaim some of that space for another use, feel
  89  * free to do so, as long as the sizes are kept identical.
  90  */
  91 struct config {
  92         char c_nodename[16];            /* Unqualified "short" nodename     */
  93         char c_fqdn[64];                /* Fully Qualified Domain Name      */
  94         char c_humannode[21];           /* Long name of system              */
  95         char c_phonenum[16];            /* Dialup number of system          */
  96         uid_t c_ctdluid;                /* UID under which we run Citadel   */
  97         char c_creataide;               /* room creator = room aide  flag   */
  98         int c_sleeping;                 /* watchdog timer setting           */
  99         char c_initax;                  /* initial access level             */
 100         char c_regiscall;               /* call number to register on       */
 101         char c_twitdetect;              /* twit detect flag                 */
 102         char c_twitroom[ROOMNAMELEN];   /* twit detect msg move to room     */
 103         char c_moreprompt[80];          /* paginator prompt                 */
 104         char c_restrict;                /* restrict Internet mail flag      */
 105         long c_niu_1;                   /* (not in use)                     */
 106         char c_site_location[32];               /* physical location of server      */
 107         char c_sysadm[26];              /* name of system administrator     */
 108         char c_niu_2[15];               /* (not in use)                     */
 109         int c_setup_level;              /* what rev level we've setup to    */
 110         int c_maxsessions;              /* maximum concurrent sessions      */
 111         char c_ip_addr[20];             /* IP address to listen on          */
 112         int c_port_number;              /* Cit listener port (usually 504)  */
 113         int c_ipgm_secret;              /* Internal program authentication  */
 114         struct ExpirePolicy c_ep;       /* System default msg expire policy */
 115         int c_userpurge;                /* System default user purge (days) */
 116         int c_roompurge;                /* System default room purge (days) */
 117         char c_logpages[ROOMNAMELEN];   /* Room to log pages to (or not)    */
 118         char c_createax;                /* Axlevel required to create rooms */
 119         long c_maxmsglen;               /* Maximum message length           */
 120         int c_min_workers;              /* Lower limit on number of threads */
 121         int c_max_workers;              /* Upper limit on number of threads */
 122         int c_pop3_port;                /* POP3 listener port (usually 110) */
 123         int c_smtp_port;                /* SMTP listener port (usually 25)  */
 124         int c_rfc822_strict_from;       /* 1 = don't correct From: forgeries*/
 125         int c_aide_zap;                 /* Are Aides allowed to zap rooms?  */
 126         int c_imap_port;                /* IMAP listener port (usually 143) */
 127         time_t c_net_freq;              /* how often to run the networker   */
 128         char c_disable_newu;            /* disable NEWU command             */
 129         char c_niu_4;                   /* (not in use)                     */
 130         char c_baseroom[ROOMNAMELEN];   /* Name of baseroom (Lobby)         */
 131         char c_aideroom[ROOMNAMELEN];   /* Name of aideroom (Aide)          */
 132         int c_purge_hour;               /* Hour during which db purges run  */
 133         struct ExpirePolicy c_mbxep;    /* Expire policy for mailbox rooms  */
 134         char c_ldap_host[128];          /* Host where LDAP service lives    */
 135         int c_ldap_port;                /* Port on host where LDAP lives    */
 136         char c_ldap_base_dn[256];       /* LDAP base DN                     */
 137         char c_ldap_bind_dn[256];       /* LDAP bind DN                     */
 138         char c_ldap_bind_pw[256];       /* LDAP bind password               */
 139         int c_msa_port;                 /* SMTP MSA listener port (usu 587) */
 140         int c_imaps_port;               /* IMAPS listener port (usually 993)*/
 141         int c_pop3s_port;               /* POP3S listener port (usually 995)*/
 142         int c_smtps_port;               /* SMTPS listener port (usually 465)*/
 143 };
 144
 145 /*
 146  * This struct stores a list of rooms with new messages which the client
 147  * fetches from the server.  This allows the client to "march" through
 148  * relevant rooms without having to ask the server each time where to go next.
 149  */
 150 struct march {
 151         struct march *next;
 152         char march_name[ROOMNAMELEN];
 153         unsigned int march_flags;
 154         char march_floor;
 155         char march_order;
 156         unsigned int march_flags2;
 157         int march_access;
 158 };
 159
 160 #define NODENAME                config.c_nodename
 161 #define FQDN                    config.c_fqdn
 162 #define HUMANNODE               config.c_humannode
 163 #define PHONENUM                config.c_phonenum
 164 #define CTDLUID                 config.c_ctdluid
 165 #define CREATAIDE               config.c_creataide
 166 #define REGISCALL               config.c_regiscall
 167 #define TWITDETECT              config.c_twitdetect
 168 #define TWITROOM                config.c_twitroom
 169 #define RESTRICT_INTERNET       config.c_restrict
 170
 171 /*
 172  * User records.
 173  */
 174 struct ctdluser {                       /* User record                      */
 175         int version;                    /* Cit vers. which created this rec */
 176         uid_t uid;                      /* Associate with a unix account?   */
 177         char password[32];              /* password (for Citadel-only users)*/
 178         unsigned flags;                 /* See US_ flags below              */
 179         long timescalled;               /* Total number of logins           */
 180         long posted;                    /* Number of messages posted (ever) */
 181         cit_uint8_t axlevel;            /* Access level                     */
 182         long usernum;                   /* User number (never recycled)     */
 183         time_t lastcall;                /* Last time the user called        */
 184         int USuserpurge;                /* Purge time (in days) for user    */
 185         char fullname[64];              /* Name for Citadel messages & mail */
 186         cit_uint8_t USscreenwidth;      /* Screen width (for textmode users)*/
 187         cit_uint8_t USscreenheight;     /* Screen height(for textmode users)*/
 188 };
 189
 190
 191 /* Bits which may appear in CitControl.MMflags.  Note that these don't
 192  * necessarily pertain to the message base -- it's just a good place to
 193  * store any global flags.
 194  */
 195 #define MM_VALID        4               /* New users need validating        */
 196
 197 /*
 198  * Room records.
 199  */
 200 struct ctdlroom {
 201         char QRname[ROOMNAMELEN];       /* Name of room                     */
 202         char QRpasswd[10];              /* Only valid if it's a private rm  */
 203         long QRroomaide;                /* User number of room aide         */
 204         long QRhighest;                 /* Highest message NUMBER in room   */
 205         time_t QRgen;                   /* Generation number of room        */
 206         unsigned QRflags;               /* See flag values below            */
 207         char QRdirname[15];             /* Directory name, if applicable    */
 208         long QRinfo;                    /* Info file update relative to msgs*/
 209         char QRfloor;                   /* Which floor this room is on      */
 210         time_t QRmtime;                 /* Date/time of last post           */
 211         struct ExpirePolicy QRep;       /* Message expiration policy        */
 212         long QRnumber;                  /* Globally unique room number      */
 213         char QRorder;                   /* Sort key for room listing order  */
 214         unsigned QRflags2;              /* Additional flags                 */
 215         int QRdefaultview;              /* How to display the contents      */
 216 };
 217
 218 /* Private rooms are always flagged with QR_PRIVATE.  If neither QR_PASSWORDED
 219  * or QR_GUESSNAME is set, then it is invitation-only.  Passworded rooms are
 220  * flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
 221  * flagged with both QR_PRIVATE and QR_GUESSNAME.  NEVER set all three flags.
 222  */
 223
 224 /*
 225  * Miscellaneous
 226  */
 227 #define MES_NORMAL      65              /* Normal message                   */
 228 #define MES_ANONONLY    66              /* "****" header                    */
 229 #define MES_ANONOPT     67              /* "Anonymous" header               */
 230
 231 #define MES_ERROR       (-1)    /* Can't send message due to bad address   */
 232 #define MES_LOCAL       0       /* Local message, do no network processing */
 233 #define MES_INTERNET    1       /* Convert msg and send as Internet mail   */
 234 #define MES_IGNET       2       /* Process recipient and send via Cit net  */
 235
 236 /****************************************************************************/
 237
 238 /*
 239  * Floor record.  The floor number is implicit in its location in the file.
 240  */
 241 struct floor {
 242         unsigned short f_flags;         /* flags */
 243         char f_name[256];               /* name of floor */
 244         int f_ref_count;                /* reference count */
 245         struct ExpirePolicy f_ep;       /* default expiration policy */
 246 };
 247
 248 #define F_INUSE         1               /* floor is in use */
 249
 250
 251 /*
 252  * Values used internally for function call returns, etc.
 253  */
 254
 255 #define NEWREGISTER     0               /* new user to register */
 256 #define REREGISTER      1               /* existing user reregistering */
 257
 258 #define READ_HEADER     2
 259 #define READ_MSGBODY    3
 260
 261 /* commands we can send to the stty_ctdl() routine */
 262 #define SB_NO_INTR      0               /* set to Citadel client mode, i/q disabled */
 263 #define SB_YES_INTR     1               /* set to Citadel client mode, i/q enabled */
 264 #define SB_SAVE         2               /* save settings */
 265 #define SB_RESTORE      3               /* restore settings */
 266 #define SB_LAST         4               /* redo the last command sent */
 267
 268 #define NEXT_KEY        15
 269 #define STOP_KEY        3
 270
 271 /* server exit codes */
 272 #define EXIT_NORMAL     0               /* server terminated normally */
 273                                         /* 1 through 63 reserved for signals */
 274 #define EXIT_NULL       64              /* EOF on server command input */
 275
 276 /* citadel.rc stuff */
 277 #define RC_NO           0               /* always no */
 278 #define RC_YES          1               /* always yes */
 279 #define RC_DEFAULT      2               /* setting depends on user config */
 280
 281 /* keepalives */
 282 enum {
 283         KA_NO,                          /* no keepalives */
 284         KA_YES,                         /* full keepalives */
 285         KA_HALF                         /* half keepalives */
 286 };
 287
 288 /* for <;G>oto and <;S>kip commands */
 289 #define GF_GOTO         0               /* <;G>oto floor mode */
 290 #define GF_SKIP         1               /* <;S>kip floor mode */
 291 #define GF_ZAP          2               /* <;Z>ap floor mode */
 292
 293 /*
 294  * MIME types used in Citadel for configuration stuff
 295  */
 296 #define SPOOLMIME       "application/x-citadel-delivery-list"
 297 #define INTERNETCFG     "application/x-citadel-internet-config"
 298 #define IGNETCFG        "application/x-citadel-ignet-config"
 299 #define IGNETMAP        "application/x-citadel-ignet-map"
 300 #define FILTERLIST      "application/x-citadel-filter-list"
 301
 302 #define TRACE   lprintf(CTDL_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
 303
 304 #ifndef LONG_MAX
 305 #define LONG_MAX 2147483647L
 306 #endif
 307
 308
 309 /*
 310  * Views
 311  */
 312 #define VIEW_BBS                0       /* Bulletin board view */
 313 #define VIEW_MAILBOX            1       /* Mailbox summary */
 314 #define VIEW_ADDRESSBOOK        2       /* Address book view */
 315 #define VIEW_CALENDAR           3       /* Calendar view */
 316 #define VIEW_TASKS              4       /* Tasks view */
 317 #define VIEW_NOTES              5       /* Notes view */
 318
 319 #ifdef __cplusplus
 320 }
 321 #endif
 322
 323 #endif /* CITADEL_H */