]> code.citadel.org Git - citadel.git/blobdiff - citadel/citadel.h
Still working on sixel
[citadel.git] / citadel / citadel.h
diff --git a/citadel/citadel.h b/citadel/citadel.h
deleted file mode 100644 (file)
index c5e5fb4..0000000
+++ /dev/null
@@ -1,334 +0,0 @@
-/*
- * $Id$
- *
- * main Citadel header file
- * see copyright.txt for copyright information
- */
-
-/* system customizations are in sysconfig.h */
-
-#ifndef CITADEL_H
-#define CITADEL_H
-/* #include <dmalloc.h> uncomment if using dmalloc */
-
-/* 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"
-
-#ifdef __cplusplus
-extern "C" {
-#endif
-
-/*
- * Text description of this software
- */
-#define CITADEL        "Citadel 6.46"
-
-/*
- * 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.
- */
-#define REV_LEVEL      646             /* This version */
-#define REV_MIN                591             /* Oldest compatible database */
-#define EXPORT_REV_MIN 626             /* Oldest compatible export files */
-
-#define SERVER_TYPE 0  /* zero for stock Citadel; other developers please
-                          obtain SERVER_TYPE codes for your implementations */
-
-/* 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 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 */
-#define EXPIRE_NUMMSGS         2       /* Keep only latest n messages  */
-#define EXPIRE_AGE             3       /* Expire messages after n days */
-
-
-/* 
- * Global system configuration.
- * 
- * Developers: please do NOT remove the fields labelled "not in use".  We
- * can't simply remove them from the struct, because this gets written to
- * disk, and if you change it then you'll break all existing systems.
- * However, if you'd like to reclaim some of that space for another use, feel
- * free to do so, as long as the sizes are kept identical.
- */
-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_ctdluid;                /* UID under which we run Citadel   */
-       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_niu_1;                   /* (not in use)                     */
-       char c_site_location[32];               /* physical location of server      */
-       char c_sysadm[26];              /* name of system administrator     */
-       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_ip_addr[20];             /* IP address to listen on          */
-       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_niu_4;                   /* (not in use)                     */
-       char c_baseroom[ROOMNAMELEN];   /* Name of baseroom (Lobby)         */
-       char c_aideroom[ROOMNAMELEN];   /* Name of aideroom (Aide)          */
-       int c_purge_hour;               /* Hour during which db purges run  */
-       struct ExpirePolicy c_mbxep;    /* Expire policy for mailbox rooms  */
-       char c_ldap_host[128];          /* Host where LDAP service lives    */
-       int c_ldap_port;                /* Port on host where LDAP lives    */
-       char c_ldap_base_dn[256];       /* LDAP base DN                     */
-       char c_ldap_bind_dn[256];       /* LDAP bind DN                     */
-       char c_ldap_bind_pw[256];       /* LDAP bind password               */
-       int c_msa_port;                 /* SMTP MSA listener port (usu 587) */
-       int c_imaps_port;               /* IMAPS listener port (usually 993)*/
-       int c_pop3s_port;               /* POP3S listener port (usually 995)*/
-       int c_smtps_port;               /* SMTPS listener port (usually 465)*/
-};
-
-/*
- * 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 HUMANNODE              config.c_humannode
-#define PHONENUM               config.c_phonenum
-#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
-
-/*
- * 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 Citadel-only users)*/
-       unsigned flags;                 /* See US_ flags below              */
-       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        */
-       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 {
-       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      */
-};
-
-/* 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.
- */
-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         */
-       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
- * 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.  NEVER set all three flags.
- */
-
-/*
- * Miscellaneous
- */
-#define MES_NORMAL     65              /* Normal message                   */
-#define MES_ANONONLY   66              /* "****" header                    */
-#define MES_ANONOPT    67              /* "Anonymous" header               */
-
-#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  */
-
-/****************************************************************************/
-
-/*
- * Floor record.  The floor number is implicit in its location in the file.
- */
-struct floor {
-       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 */
-
-
-/*
- * Values used internally for function call returns, etc.
- */
-
-#define NEWREGISTER    0               /* new user to register */
-#define REREGISTER     1               /* existing user reregistering */
-
-#define READ_HEADER    2
-#define READ_MSGBODY   3
-
-/* 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        NEXT_KEY        15
-#define STOP_KEY       3
-
-/* server exit codes */
-#define EXIT_NORMAL    0               /* server terminated normally */
-                                       /* 1 through 63 reserved for signals */
-#define EXIT_NULL      64              /* EOF on server command input */
-
-/* citadel.rc stuff */
-#define RC_NO          0               /* always no */
-#define RC_YES         1               /* always yes */
-#define RC_DEFAULT     2               /* setting depends on user config */
-
-/* keepalives */
-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 */
-
-/*
- * 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 TRACE  lprintf(CTDL_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__)
-
-#ifndef LONG_MAX
-#define LONG_MAX 2147483647L
-#endif
-
-
-/*
- * Views
- */
-#define        VIEW_BBS                0       /* Bulletin board view */
-#define VIEW_MAILBOX           1       /* Mailbox summary */
-#define VIEW_ADDRESSBOOK       2       /* Address book view */
-#define VIEW_CALENDAR          3       /* Calendar view */
-#define VIEW_TASKS             4       /* Tasks view */
-#define VIEW_NOTES             5       /* Notes view */
-
-#ifdef __cplusplus
-}
-#endif
-
-#endif /* CITADEL_H */