X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fcitadel.h;h=d728af6ecbc5b6f34924ac7682efe40fd0955ff5;hb=a21ccc76e93fe4f0cf95257c1e5fffe76fdb09d5;hp=b790f860b3041e3e6ca2d5d468e19379b64a34ee;hpb=eb7010b4f40377ed47459da4704dfc0675a387b2;p=citadel.git diff --git a/citadel/citadel.h b/citadel/citadel.h index b790f860b..d728af6ec 100644 --- a/citadel/citadel.h +++ b/citadel/citadel.h @@ -1,8 +1,15 @@ /* - * $Id$ - * * Main Citadel header file - * See copyright.txt for copyright information. + * + * Copyright (c) 1987-2017 by the citadel.org team + * + * This program is open source software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License version 3. + * + * 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. */ /* system customizations are in sysconfig.h */ @@ -11,15 +18,6 @@ #define CITADEL_H /* #include 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 #include "sysconfig.h" @@ -47,35 +45,31 @@ extern "C" { * usually more strict because you're not really supposed to dump/load and * upgrade at the same time. */ -#define REV_LEVEL 710 /* This version */ +#define REV_LEVEL 907 /* This version */ #define REV_MIN 591 /* Oldest compatible database */ -#define EXPORT_REV_MIN 706 /* Oldest compatible export files */ +#define EXPORT_REV_MIN 760 /* Oldest compatible export files */ +#define LIBCITADEL_MIN 903 /* Minimum required version of libcitadel */ + +#define SERVER_TYPE 0 /* zero for stock Citadel; 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 */ +#ifdef LIBCITADEL_VERSION_NUMBER +#if LIBCITADEL_VERSION_NUMBER < LIBCITADEL_MIN +#error libcitadel is too old. Please upgrade it before continuing. +#endif +#endif /* 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 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 */ +#define ROOMNAMELEN 128 /* The size of a roomname string */ +#define USERNAME_SIZE 64 /* The size of a username string */ +#define MAX_EDITORS 5 /* number 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; }; @@ -91,12 +85,8 @@ struct ExpirePolicy { * 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. */ +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; @@ -106,57 +96,37 @@ struct march { 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 */ -/* -#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 (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)*/ +typedef struct ctdluser ctdluser; +struct ctdluser { /* User record */ + 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) */ + long msgnum_bio; /* msgnum of user's profile (bio) */ + long msgnum_pic; /* msgnum of user's avatar (photo) */ }; -/* 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. +/* Bits which may appear in MMflags. */ #define MM_VALID 4 /* New users need validating */ /* * Room records. */ +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 */ @@ -164,7 +134,7 @@ struct ctdlroom { 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*/ + long msgnum_info; /* msgnum of room banner (info file)*/ char QRfloor; /* Which floor this room is on */ time_t QRmtime; /* Date/time of last post */ struct ExpirePolicy QRep; /* Message expiration policy */ @@ -172,6 +142,7 @@ struct ctdlroom { char QRorder; /* Sort key for room listing order */ unsigned QRflags2; /* Additional flags */ int QRdefaultview; /* How to display the contents */ + long msgnum_pic; /* msgnum of room picture or icon */ }; /* Private rooms are always flagged with QR_PRIVATE. If neither QR_PASSWORDED @@ -197,12 +168,8 @@ struct ctdlroom { /* * 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 */ @@ -219,70 +186,22 @@ struct floor { #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 */ -}; +/* number of items which may be handled by the CONF command */ +#define NUM_CONFIGS 71 -/* 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 SIEVECONFIG "application/x-citadel-sieve-config" - -#define TRACE lprintf(CTDL_DEBUG, "Checkpoint: %s, %d\n", __FILE__, __LINE__) +#define TRACE syslog(LOG_DEBUG, "\033[31mCheckpoint: %s : %d\033[0m", __FILE__, __LINE__) #ifndef LONG_MAX #define LONG_MAX 2147483647L #endif - /* - * Views + * Authentication modes */ -#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 */ -#define VIEW_WIKI 6 /* Wiki view */ -#define VIEW_CALBRIEF 7 /* Brief Calendar view */ -#define VIEW_SIEVE 8 /* Sieve manage rules store */ +#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 }