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
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/*
91 // Supplementary data for a message on disk
92 // These are kept separate from the message itself for one of two reasons:
93 // 1. Either their values may change at some point after initial save, or
94 // 2. They are merely caches of data which exist somewhere else, for speed.
95 // DO NOT PUT BIG DATA IN HERE ... we need this struct to be tiny for lots of quick r/w
96 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
97 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
99 long meta_msgnum; // Message number in *local* message base
100 int meta_refcount; // Number of rooms pointing to this msg
101 char meta_content_type[64]; // Cached MIME content-type
102 long meta_rfc822_length; // Cache of RFC822-translated msg length
106 // Calls to AdjRefCount() are queued and deferred, so the user doesn't
107 // have to wait for various disk-intensive operations to complete synchronously.
108 // This is the record format.
110 long arcq_msgnum; // Message number being adjusted
111 int arcq_delta; // Adjustment ( usually 1 or -1 )
115 // Serialization routines use this struct to return a pointer and a length
122 // The S_USETABLE database is used in several modules now, so we define its format here.
130 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
131 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
132 typedef struct ctdluser ctdluser;
133 struct ctdluser { // User record
134 int version; // Citadel version which created this record
135 uid_t uid; // Associate with a unix account?
136 char password[32]; // password
137 unsigned flags; // See US_ flags below
138 long timescalled; // Total number of logins
139 long posted; // Number of messages ever submitted
140 cit_uint8_t axlevel; // Access level
141 long usernum; // User number (never recycled)
142 time_t lastcall; // Date/time of most recent login
143 int USuserpurge; // Purge time (in days) for user
144 char fullname[64]; // Display name (primary identifier)
145 long msgnum_bio; // msgnum of user's profile (bio)
146 long msgnum_pic; // msgnum of user's avatar (photo)
147 char emailaddrs[512]; // Internet email addresses
148 long msgnum_inboxrules; // msgnum of user's inbox filtering rules
149 long lastproc_inboxrules; // msgnum of last message filtered
153 // Message expiration policy stuff
154 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
155 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
156 typedef struct ExpirePolicy ExpirePolicy;
157 struct ExpirePolicy {
164 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
165 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
167 char QRname[ROOMNAMELEN]; // Name of room
168 char QRpasswd[10]; // Only valid if it's a private rm
169 long QRroomaide; // User number of room aide
170 long QRhighest; // Highest message NUMBER in room
171 time_t QRgen; // Generation number of room
172 unsigned QRflags; // See flag values below
173 char QRdirname[15]; // Directory name, if applicable
174 long msgnum_info; // msgnum of room banner (info file)
175 char QRfloor; // Which floor this room is on
176 time_t QRmtime; // Date/time of last post
177 struct ExpirePolicy QRep; // Message expiration policy
178 long QRnumber; // Globally unique room number
179 char QRorder; // Sort key for room listing order
180 unsigned QRflags2; // Additional flags
181 int QRdefaultview; // How to display the contents
182 long msgnum_pic; // msgnum of room picture or icon
186 // Floor record. The floor number is implicit in its location in the file.
187 // NOTE: if you add fields to this, you have to also write export/import code in server/modules/migrate/serv_migrate.c
188 // NOTE: if you add fields to this, you have to also write conversion code in utils/ctdl3264/*
190 unsigned short f_flags; // flags
191 char f_name[256]; // name of floor
192 int f_ref_count; // reference count
193 struct ExpirePolicy f_ep; // default expiration policy
197 // Database records beginning with this magic number are assumed to
198 // be compressed. In the event that a database record actually begins with
199 // this magic number, we *must* compress it whether we want to or not,
200 // because the fetch function will try to uncompress it anyway.
202 // (No need to #ifdef this stuff; it compiles ok even if zlib is not present
203 // and doesn't declare anything so it won't bloat the code)
204 #define COMPRESS_MAGIC 0xc0ffeeee
206 struct CtdlCompressHeader {
208 size_t uncompressed_len;
209 size_t compressed_len;