/*
- * $Id$
+ * Main Citadel header file
*
- * main Citadel/UX header file
- * see copyright.txt for copyright information
+ * Copyright (c) 1987-2011 by the citadel.org team
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * 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.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
/* system customizations are in sysconfig.h */
#ifndef CITADEL_H
#define CITADEL_H
+/* #include <dmalloc.h> uncomment if using dmalloc */
#include "sysdep.h"
#include <limits.h>
#include "sysconfig.h"
+#include "typesize.h"
#include "ipcdef.h"
+#ifdef __cplusplus
+extern "C" {
+#endif
+
/*
* Text description of this software
+ * (We used to define this ourselves, but why bother when
+ * the GNU build tools do it for us?)
*/
-#define CITADEL "Citadel/UX 5.91"
+#define CITADEL PACKAGE_STRING
/*
* REV_LEVEL is the current version number (multiplied by 100 to avoid having
* to fiddle with the decimal). REV_MIN is the oldest version of Citadel
* whose data files are compatible with the current version. If the data files
* are older than REV_MIN, none of the programs will work until the setup
- * program is run again to bring things up to date.
+ * program is run again to bring things up to date. EXPORT_REV_MIN is the
+ * oldest version of Citadel whose export files we can read. The latter is
+ * usually more strict because you're not really supposed to dump/load and
+ * upgrade at the same time.
*/
-#define REV_LEVEL 591 /* This version */
-#define REV_MIN 591 /* Oldest compatible version */
+#define REV_LEVEL 803 /* This version */
+#define REV_MIN 591 /* Oldest compatible database */
+#define EXPORT_REV_MIN 760 /* Oldest compatible export files */
+#define LIBCITADEL_MIN 802 /* Minimum required version of libcitadel */
-#define SERVER_TYPE 0 /* zero for stock Citadel/UX; other developers please
- obtain SERVER_TYPE codes for your implementations */
+#define SERVER_TYPE 0 /* zero for stock Citadel; other developers please
+ obtain SERVER_TYPE codes for your implementations */
-/*
- * This is a better implementation of tolower() than that found on some
- * systems (there are operating systems out there on which tolower() will
- * screw up if you give it a character that is already lower case).
- */
-#ifdef tolower
-#undef tolower
+#ifdef LIBCITADEL_VERSION_NUMBER
+#if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN
+#error libcitadel is too old. Please upgrade it before continuing.
+#endif
#endif
-#define tolower(x) ( ((x>='A')&&(x<='Z')) ? (x+'a'-'A') : x )
-#define NEW_CONFIG
-
-/*
- * The only typedef we do is an 8-bit unsigned, for screen dimensions.
- * All other defs are done using standard C types. The code assumes that
- * 'int' 'unsigned' and 'short' are at least 16 bits, and that 'long' is at
- * least 32 bits. There are no endian dependencies in any of the Citadel
- * programs.
- */
-typedef unsigned char CIT_UBYTE;
/* 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 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 32 /* The size of a username string */
+#define USERNAME_SIZE 64 /* The size of a username string */
+#define MAX_EDITORS 5 /* # 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;
};
#define EXPIRE_AGE 3 /* Expire messages after n days */
-/*
- * Global system configuration
+/*
+ * This struct stores a list of rooms with new messages which the client
+ * fetches from the server. This allows the client to "march" through
+ * relevant rooms without having to ask the server each time where to go next.
*/
-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 */
- char c_creataide; /* room creator = room aide flag */
- int c_sleeping; /* watchdog timer setting */
- char c_initax; /* initial access level */
- char c_regiscall; /* call number to register on */
- char c_twitdetect; /* twit detect flag */
- char c_twitroom[ROOMNAMELEN]; /* twit detect msg move to room */
- char c_moreprompt[80]; /* paginator prompt */
- char c_restrict; /* restrict Internet mail flag */
- long c_msgbase; /* size of message base (obsolete) */
- char c_bbs_city[32]; /* physical location of server */
- char c_sysadm[26]; /* name of system administrator */
- char c_bucket_dir[15]; /* bit bucket for files... */
- 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) */
- 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 */
- int c_userpurge; /* System default user purge (days) */
- int c_roompurge; /* System default room purge (days) */
- char c_logpages[ROOMNAMELEN]; /* Room to log pages to (or not) */
- char c_createax; /* Axlevel required to create rooms */
- long c_maxmsglen; /* Maximum message length */
- int c_min_workers; /* Lower limit on number of threads */
- int c_max_workers; /* Upper limit on number of threads */
- int c_pop3_port; /* POP3 listener port (usually 110) */
- int c_smtp_port; /* SMTP listener port (usually 25) */
- int c_unused_1; /* Nothin' here anymore... */
- int c_aide_zap; /* Are Aides allowed to zap rooms? */
- 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_baseroom[ROOMNAMELEN]; /* Name of baseroom (Lobby) */
- char c_aideroom[ROOMNAMELEN]; /* Name of aideroom (Aide) */
-};
-
+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;
char march_floor;
char march_order;
+ unsigned int march_flags2;
+ int march_access;
};
#define NODENAME config.c_nodename
#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
#define TWITROOM config.c_twitroom
#define RESTRICT_INTERNET config.c_restrict
-/* Defines the actual user record */
-
-struct usersupp { /* 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) */
- unsigned flags; /* See US_ flags below */
- long timescalled; /* Total number of logins */
- long posted; /* Number of messages posted (ever) */
- CIT_UBYTE axlevel; /* Access level */
- long usernum; /* User number (never recycled) */
- time_t lastcall; /* Last time the user called */
- int USuserpurge; /* Purge time (in days) for user */
- char fullname[64]; /* Name for Citadel messages & mail */
- CIT_UBYTE USscreenwidth; /* Screen width (for textmode users)*/
- CIT_UBYTE USscreenheight; /* Screen height(for textmode users)*/
-};
-
-
/*
- * This is the control record for the message base...
+ * User records.
*/
-struct CitControl {
- long MMhighest; /* highest message number in file */
- unsigned MMflags; /* Global system flags */
- long MMnextuser; /* highest user number on system */
- long MMnextroom; /* highest room number on system */
- int version; /* Server-hosted upgrade level */
+typedef struct ctdluser ctdluser;
+struct ctdluser { /* User record */
+/*
+#include "datadefinitions.h"
+#include "dtds/user-defs.h"
+#include "undef_data.h"
+*/
+ int version; /* Cit vers. which created this rec */
+ uid_t uid; /* Associate with a unix account? */
+ char password[32]; /* password */
+ unsigned flags; /* See US_ flags below */
+ long timescalled; /* Total number of logins */
+ long posted; /* Number of messages ever submitted */
+ cit_uint8_t axlevel; /* Access level */
+ long usernum; /* User number (never recycled) */
+ time_t lastcall; /* Date/time of most recent login */
+ int USuserpurge; /* Purge time (in days) for user */
+ char fullname[64]; /* Display name (primary identifier) */
};
+
/* 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.
#define MM_VALID 4 /* New users need validating */
/*
- * Room records
+ * Room records.
*/
-struct quickroom {
- char QRname[ROOMNAMELEN]; /* Name of room */
- char QRpasswd[10]; /* Only valid if it's a private rm */
- long QRroomaide; /* User number of room aide */
- long QRhighest; /* Highest message NUMBER in room */
- 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*/
- char QRfloor; /* Which floor this room is on */
- time_t QRmtime; /* Date/time of last post */
- struct ExpirePolicy QRep; /* Message expiration policy */
- long QRnumber; /* Globally unique room number */
- char QRorder; /* Sort key for room listing order */
- unsigned QRflags2; /* Additional flags */
- int QRdefaultview; /* How to display the contents */
+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 */
+ long QRhighest; /* Highest message NUMBER in room */
+ 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*/
+ char QRfloor; /* Which floor this room is on */
+ time_t QRmtime; /* Date/time of last post */
+ struct ExpirePolicy QRep; /* Message expiration policy */
+ long QRnumber; /* Globally unique room number */
+ char QRorder; /* Sort key for room listing order */
+ unsigned QRflags2; /* Additional flags */
+ int QRdefaultview; /* How to display the contents */
};
/* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
*/
/*
- * Events which might show up in the Citadel Log
+ * Miscellaneous
*/
-#define CL_CONNECT 8 /* Connect to server */
-#define CL_LOGIN 16 /* CLfullname logged in */
-#define CL_NEWUSER 32 /* CLfullname is a new user */
-#define CL_BADPW 64 /* Bad attempt at CLfullname's pw */
-#define CL_TERMINATE 128 /* Logout - proper termination */
-#define CL_DROPCARR 256 /* Logout - dropped carrier */
-#define CL_SLEEPING 512 /* Logout - sleeping */
-#define CL_PWCHANGE 1024 /* CLfullname changed passwords */
-
-/* Miscellaneous */
-
#define MES_NORMAL 65 /* Normal message */
#define MES_ANONONLY 66 /* "****" header */
#define MES_ANONOPT 67 /* "Anonymous" header */
/*
* Floor record. The floor number is implicit in its location in the file.
*/
+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 */
struct ExpirePolicy f_ep; /* default expiration policy */
- };
+};
#define F_INUSE 1 /* floor is in use */
#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 */
#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 SIEVECONFIG "application/x-citadel-sieve-config"
+#define XMPPMORTUARY "application/x-citadel-xmpp-mortuary"
-#define TRACE lprintf(9, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
+#define TRACE syslog(LOG_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
#ifndef LONG_MAX
#define LONG_MAX 2147483647L
#endif
-#endif /* CITADEL_H */
-
-
/*
- * Views
+ * Authentication modes
*/
-#define VIEW_BBS 0 /* Traditional Citadel BBS view */
-#define VIEW_MAILBOX 1 /* Mailbox summary */
-#define VIEW_ADDRESSBOOK 2 /* Address book view */
+#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
+}
+#endif
+
+#endif /* CITADEL_H */