1 // Data types for the Citadel Server
3 // Copyright (c) 1987-2023 by the citadel.org team
5 // This program is open source software. Use, duplication, or disclosure
6 // is subject to the terms of the GNU General Public License, version 3.
12 #define INLINE __inline__
17 #include "citadel_defs.h"
19 #define OPENSSL_NO_KRB5 // work around redhat b0rken ssl headers
20 #include <openssl/ssl.h>
24 // New format for a message in memory
26 int cm_magic; // Self-check (NOT SAVED TO DISK)
27 char cm_anon_type; // Anonymous or author-visible
28 char cm_format_type; // Format type
29 char *cm_fields[256]; // Data fields
30 long cm_lengths[256]; // size of datafields
31 unsigned int cm_flags; // How to handle (NOT SAVED TO DISK)
35 // Data structure returned by validate_recipients()
53 extern int ScheduledShutdown;
55 extern int sanity_diag_mode;
58 // Instant message in transit on the system (not used in the database)
59 struct ExpressMessage {
60 struct ExpressMessage *next;
61 time_t timestamp; // When this message was sent
62 unsigned flags; // Special instructions
63 char sender[256]; // Name of sending user
64 char sender_email[256]; // Email or JID of sending user
65 char *text; // Message text (if applicable)
69 // Row being stored or fetched in the database
71 size_t len; // size of datum pointed to by ptr
76 // Defines the relationship of a user to a particular room
77 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
78 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
81 long v_roomgen; // The first three fields , sizeof(long)*3 , are the index format.
91 // This is the db index format for "visit" records, which describe the relationship between one user and one room.
99 // Supplementary data for a message on disk
100 // These are kept separate from the message itself for one of two reasons:
101 // 1. Either their values may change at some point after initial save, or
102 // 2. They are merely caches of data which exist somewhere else, for speed.
103 // DO NOT PUT BIG DATA IN HERE ... we need this struct to be tiny for lots of quick r/w
104 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
105 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
107 long meta_msgnum; // Message number in *local* message base
108 int meta_refcount; // Number of rooms pointing to this msg
109 char meta_content_type[64]; // Cached MIME content-type
110 long meta_rfc822_length; // Cache of RFC822-translated msg length
114 // Calls to AdjRefCount() are queued and deferred, so the user doesn't
115 // have to wait for various disk-intensive operations to complete synchronously.
116 // This is the record format.
118 long arcq_msgnum; // Message number being adjusted
119 int arcq_delta; // Adjustment ( usually 1 or -1 )
123 // Serialization routines use this struct to return a pointer and a length
130 // The S_USETABLE database is used in several modules now, so we define its format here.
138 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
139 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
140 typedef struct ctdluser ctdluser;
141 struct ctdluser { // User record
142 int version; // Citadel version which created this record
143 uid_t uid; // Associate with a unix account?
144 char password[32]; // password
145 unsigned flags; // See US_ flags below
148 cit_uint8_t axlevel; // Access level
149 long usernum; // User number (never recycled)
150 time_t lastcall; // Date/time of most recent login
151 int USuserpurge; // Purge time (in days) for user
152 char fullname[64]; // Display name (primary identifier)
153 long msgnum_bio; // msgnum of user's profile (bio)
154 long msgnum_pic; // msgnum of user's avatar (photo)
155 char emailaddrs[512]; // Internet email addresses
156 long msgnum_inboxrules; // msgnum of user's inbox filtering rules
157 long lastproc_inboxrules; // msgnum of last message filtered
161 // Message expiration policy stuff
162 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
163 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
164 typedef struct ExpirePolicy ExpirePolicy;
165 struct ExpirePolicy {
172 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
173 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
175 char QRname[ROOMNAMELEN]; // Name of room
176 char QRpasswd[10]; // Only valid if it's a private rm
177 long QRroomaide; // User number of room aide
178 long QRhighest; // Highest message NUMBER in room
179 time_t QRgen; // Generation number of room
180 unsigned QRflags; // See flag values below
181 char QRdirname[15]; // Directory name, if applicable
182 long msgnum_info; // msgnum of room banner (info file)
183 char QRfloor; // Which floor this room is on
184 time_t QRmtime; // Date/time of last post
185 struct ExpirePolicy QRep; // Message expiration policy
186 long QRnumber; // Globally unique room number
187 char QRorder; // Sort key for room listing order
188 unsigned QRflags2; // Additional flags
189 int QRdefaultview; // How to display the contents
190 long msgnum_pic; // msgnum of room picture or icon
194 // Floor record. The floor number is implicit in its location in the file.
195 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
196 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
198 unsigned short f_flags; // flags
199 char f_name[256]; // name of floor
200 int f_ref_count; // reference count
201 struct ExpirePolicy f_ep; // default expiration policy
205 // Database records beginning with this magic number are assumed to
206 // be compressed. In the event that a database record actually begins with
207 // this magic number, we *must* compress it whether we want to or not,
208 // because the fetch function will try to uncompress it anyway.
210 // (No need to #ifdef this stuff; it compiles ok even if zlib is not present
211 // and doesn't declare anything so it won't bloat the code)
212 #define COMPRESS_MAGIC 0xc0ffeeee
214 struct CtdlCompressHeader {
216 size_t uncompressed_len;
217 size_t compressed_len;