-/* citadel.h
+/*
+ * $Id$
+ *
* main Citadel/UX header file
* see copyright.txt for copyright information
- * $Id$
*/
/* system customizations are in sysconfig.h */
+
+#ifndef CITADEL_H
+#define CITADEL_H
+
+/* Build Citadel with the calendar service only if the header *and*
+ * library for libical are both present.
+ */
+#ifdef HAVE_LIBICAL
+#ifdef HAVE_ICAL_H
+#define CITADEL_WITH_CALENDAR_SERVICE 1
+#endif
+#endif
+
#include "sysdep.h"
+#include <limits.h>
#include "sysconfig.h"
+#include "typesize.h"
#include "ipcdef.h"
-#define CITADEL "Citadel/UX 5.50alpha1"
-#define REV_LEVEL 550
-#define SERVER_TYPE 0 /* zero for stock Citadel/UX; other developers please
- obtain SERVER_TYPE codes for your implementations */
-#undef tolower
-#define tolower(x) ( ((x>='A')&&(x<='Z')) ? (x+'a'-'A') : x )
-#define NEW_CONFIG
+#ifdef __cplusplus
+extern "C" {
+#endif
-#define strucmp(lstr,rstr) struncmp(lstr,rstr,32767)
+/*
+ * Text description of this software
+ */
+#define CITADEL "Citadel/UX 6.08"
-/*
- * 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.
+/*
+ * 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. 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.
*/
-typedef unsigned char CIT_UBYTE;
+#define REV_LEVEL 608 /* This version */
+#define REV_MIN 591 /* Oldest compatible database */
+#define EXPORT_REV_MIN 608 /* Oldest compatible export files */
+
+#define SERVER_TYPE 0 /* zero for stock Citadel/UX; other developers please
+ obtain SERVER_TYPE codes for your implementations */
+
+/* Various length constants */
-#define ROOMNAMELEN 128
+#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 */
/*
* Message expiration policy stuff
struct ExpirePolicy {
int expire_mode;
int expire_value;
- };
+};
#define EXPIRE_NEXTLEVEL 0 /* Inherit expiration policy */
#define EXPIRE_MANUAL 1 /* Don't expire messages at all */
/*
- * System configuration
+ * Global system configuration.
+ *
+ * Developers: please do NOT remove the fields labelled "not in use". We
+ * can't simply remove them from the struct, because that would render the
+ * configs on existing systems corrupt. However, if you need the same number
+ * of bytes for a *new* field, feel free to use them.
*/
struct config {
- char c_nodename[16]; /* UUCP and Citadel nodename */
+ 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 */
- int c_bbsuid; /* UID of the bbs-only user */
+ 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_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 */
- char c_bbs_city[32]; /* city and state you are located in*/
+ long c_niu_1; /* (not in use) */
+ 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... */
+ char c_niu_2[15]; /* (not in use) */
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 */
- int c_port_number; /* TCP port to run the server on */
+ 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_rfc822_strict_from; /* 1 = don't correct From: forgeries*/
+ 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) */
+};
+
+/*
+ * 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 march {
+ 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 TWITROOM config.c_twitroom
#define RESTRICT_INTERNET config.c_restrict
-/* Defines the actual user record */
-struct usersupp { /* User record */
- int USuid; /* userid (==BBSUID for bbs only) */
- char password[20]; /* password (for BBS-only users) */
+/*
+ * User records.
+ */
+struct ctdluser { /* 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 */
- int timescalled; /* Total number of logins */
- int posted; /* Number of messages posted (ever) */
- char fullname[26]; /* Name for Citadel messages & mail */
- char axlevel; /* Access level */
- CIT_UBYTE USscreenwidth; /* Screen width (for textmode users)*/
- CIT_UBYTE USscreenheight; /* Screen height(for textmode users)*/
+ long timescalled; /* Total number of logins */
+ long posted; /* Number of messages posted (ever) */
+ cit_uint8_t axlevel; /* Access level */
long usernum; /* User number (never recycled) */
time_t lastcall; /* Last time the user called */
- char USname[30]; /* Real name (i.e. not a handle) */
- char USaddr[25]; /* Street address */
- char UScity[15]; /* Municipality */
- char USstate[3]; /* State or province */
- char USzip[10]; /* ZIP code */
- char USphone[11]; /* Voice telephone number */
- char USemail[32]; /* E-mail address (elsewhere) */
int USuserpurge; /* Purge time (in days) for user */
- };
+ char fullname[64]; /* Name for Citadel messages & mail */
+ cit_uint8_t USscreenwidth; /* Screen width (for textmode users)*/
+ cit_uint8_t USscreenheight; /* Screen height(for textmode users)*/
+};
-/****************************************************************************
+/*
* This is the control record for the message base...
*/
struct CitControl {
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 */
+};
/* 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
*/
#define MM_VALID 4 /* New users need validating */
-/****************************************************************************
- * Room records
+/*
+ * Room records.
*/
-struct quickroom {
+struct ctdlroom {
char QRname[ROOMNAMELEN]; /* Name of room */
char QRpasswd[10]; /* Only valid if it's a private rm */
long QRroomaide; /* User number of room aide */
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
- * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
+/* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED
+ * or QR_GUESSNAME is set, then it is invitation-only. Passworded rooms are
* flagged with both QR_PRIVATE and QR_PASSWORDED while guess-name rooms are
- * flagged with both QR_PRIVATE and QR_GUESSNAME. DO NOT set all three flags.
- *
- ****************************************************************************/
+ * flagged with both QR_PRIVATE and QR_GUESSNAME. NEVER set all three flags.
+ */
/*
- * 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_ANON 66 /* "****" header */
-#define MES_AN2 67 /* "Anonymous" header */
+#define MES_ANONONLY 66 /* "****" header */
+#define MES_ANONOPT 67 /* "Anonymous" header */
-#define M_ERROR (-1) /* Can't send message due to bad address */
-#define M_LOCAL 0 /* Local message, do no network processing */
-#define M_INTERNET 1 /* Convert msg and send as Internet mail */
-#define M_BINARY 2 /* Process recipient and send via C/UX net */
+#define MES_ERROR (-1) /* Can't send message due to bad address */
+#define MES_LOCAL 0 /* Local message, do no network processing */
+#define MES_INTERNET 1 /* Convert msg and send as Internet mail */
+#define MES_IGNET 2 /* Process recipient and send via Cit net */
/****************************************************************************/
-struct recentmsg {
- char RMnodename[10];
- long RMnum; /* Number or time of message */
- };
-
-
-/****************************************************************************
- *
+/*
* Floor record. The floor number is implicit in its location in the file.
*/
struct floor {
#define F_INUSE 1 /* floor is in use */
-/****************************************************************************
+/*
* Values used internally for function call returns, etc.
*/
#define RC_DEFAULT 2 /* setting depends on user config */
/* keepalives */
-#define KA_NO 0 /* no keepalives */
-#define KA_YES 1 /* full keepalives */
-#define KA_CHAT 2 /* half keepalives (for chat mode) */
+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 */
-/* message transfer formats */
-#define MT_CITADEL 0 /* Citadel proprietary */
-#define MT_RFC822 2 /* RFC822 */
-#define MT_RAW 3 /* IGnet raw format */
-#define MT_DATE 4 /* We're only looking for the date */
+/*
+ * 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 SPAMSTRINGS "application/x-citadel-spam-strings"
+
+#define TRACE lprintf(9, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
+
+#ifndef LONG_MAX
+#define LONG_MAX 2147483647L
+#endif
+/*
+ * Views
+ */
+#define VIEW_BBS 0 /* Traditional Citadel BBS view */
+#define VIEW_MAILBOX 1 /* Mailbox summary */
+#define VIEW_ADDRESSBOOK 2 /* Address book view */
-#define BASEROOM "Lobby"
-#define MAILROOM "Mail"
-#define AIDEROOM "Aide"
+#ifdef __cplusplus
+}
+#endif
+#ifdef tmpnam
+#undef tmpnam
+#endif
+#define tmpnam(x) CtdlTempFileName(__FILE__, __LINE__)
+#ifdef tmpfile
+#undef tmpfile
+#endif
+#define tmpfile() CtdlTempFile()
+#endif /* CITADEL_H */
projects / citadel.git / blobdiff