1 // Don't run this. It doesn't work and if you try to run it you will immediately die.
3 // Copyright (c) 2023 by Art Cancro citadel.org
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.
13 #include <sys/types.h>
14 #include <sys/socket.h>
22 #include <libcitadel.h>
25 #include "../server/sysdep.h"
26 #include "../server/citadel_defs.h"
27 #include "../server/server.h"
28 #include "../server/citadel_dirs.h"
32 // Wrapper for realloc() that crashes and burns if the call fails.
33 void *reallok(void *ptr, size_t size) {
34 void *p = realloc(ptr, size);
36 fprintf(stderr, "realloc() failed to resize %p to %ld bytes, error: %m\n", ptr, size);
43 // convert a binary blob to base64 (non-reentrant!)
44 char *b64out(void *data, size_t len) {
45 static char *outbuf = NULL;
46 static size_t outlen = 0;
48 if ((outbuf == NULL) || (outlen < (len * 2))) {
49 outbuf = reallok(outbuf, (len * 2));
53 CtdlEncodeBase64(outbuf, data, len, 0);
58 // Open a database environment
59 DB_ENV *open_dbenv(char *dirname) {
66 int dbversion_major, dbversion_minor, dbversion_patch;
68 db_version(&dbversion_major, &dbversion_minor, &dbversion_patch);
70 // Create synthetic integer version numbers and compare them.
71 // Never run with a libdb other than the one with which it was compiled.
72 int compiled_db_version = ( (DB_VERSION_MAJOR * 1000000) + (DB_VERSION_MINOR * 1000) + (DB_VERSION_PATCH) );
73 int linked_db_version = ( (dbversion_major * 1000000) + (dbversion_minor * 1000) + (dbversion_patch) );
74 if (compiled_db_version != linked_db_version) {
75 fprintf(stderr, "ctdldump: ctdldump is running with a version of libdb other than the one with which it was compiled.\n"
76 "ctdldump: This is an invalid configuration. ctdldump will now exit to prevent data loss.");
80 ret = db_env_create(&dbenv, 0);
82 fprintf(stderr, "ctdldump: db_env_create: %s\n", db_strerror(ret));
83 fprintf(stderr, "ctdldump: exit code %d\n", ret);
87 // We want to specify the shared memory buffer pool cachesize, but everything else is the default.
88 ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
90 fprintf(stderr, "ctdldump: set_cachesize: %s\n", db_strerror(ret));
91 dbenv->close(dbenv, 0);
92 fprintf(stderr, "ctdldump: exit code %d\n", ret);
96 if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
97 fprintf(stderr, "ctdldump: set_lk_detect: %s\n", db_strerror(ret));
98 dbenv->close(dbenv, 0);
99 fprintf(stderr, "ctdldump: exit code %d\n", ret);
103 flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_LOG;
104 ret = dbenv->open(dbenv, dirname, flags, 0);
106 fprintf(stderr, "ctdldump: dbenv->open: %s\n", db_strerror(ret));
107 dbenv->close(dbenv, 0);
108 fprintf(stderr, "ctdldump: exit code %d\n", ret);
116 void close_dbenv(DB_ENV *dbenv) {
117 int ret = dbenv->close(dbenv, 0);
119 fprintf(stderr, "ctdldump: dbenv->close: %s\n", db_strerror(ret));
124 // export function for a message in msgmain
125 void export_msgmain(int which_cdb, DBT *in_key, DBT *in_data) {
128 memcpy(&in_msgnum, in_key->data, sizeof(in_msgnum));
130 // If the msgnum is negative, we are looking at METADATA
132 struct MetaData *meta = (struct MetaData *)in_data->data;
133 printf("msgmeta|%ld|%d|%s|%ld|\n",
136 meta->meta_content_type,
137 meta->meta_rfc822_length
141 // If the msgnum is positive, we are looking at a MESSAGE
142 else if (in_msgnum > 0) {
143 printf("msgtext|%ld|%s|\n", in_msgnum, b64out(in_data->data, in_data->size));
146 // If the msgnum is 0 it's probably not a valid record.
150 // export function for a user record
151 void export_user(int which_cdb, DBT *in_key, DBT *in_data) {
153 struct ctdluser *user = (struct ctdluser *)in_data->data;
155 printf("user|%d|%d|%s|%u|%d|%ld|%ld|%d|%s|%ld|%ld|%s|%ld|%ld|\n",
167 b64out(user->emailaddrs, strlen(user->emailaddrs)),
168 user->msgnum_inboxrules,
169 user->lastproc_inboxrules
174 // export function for a room record
175 void export_room(int which_cdb, DBT *in_key, DBT *in_data) {
177 struct ctdlroom *room = (struct ctdlroom *)in_data->data;
179 printf("room|%s|%s|%ld|%ld|%ld|%u|%s|%ld|%d|%ld|%d|%d|%ld|%d|%u|%d|%ld|\n",
190 room->QRep.expire_mode,
191 room->QRep.expire_value,
201 // export function for a floor record
202 void export_floor(int which_cdb, DBT *in_key, DBT *in_data) {
205 memcpy(&floor_num, in_key->data, sizeof(int));
207 struct floor *floor = (struct floor *)in_data->data;
209 printf("floor|%d|%u|%s|%d|%d|%d|\n",
214 floor->f_ep.expire_mode,
215 floor->f_ep.expire_value
220 // export function for a msglist
221 // (indexed by a long and the data is arrays of longs)
222 void export_msglist(int which_cdb, DBT *in_key, DBT *in_data) {
227 // records are indexed by a single "long" and contains an array of zero or more "long"s
229 memcpy(&roomnum, in_key->data, sizeof(long));
231 printf("msglist|%ld|", roomnum);
233 if (in_data->size > 0) {
234 num_msgs = in_data->size / sizeof(long);
235 for (i=0; i<num_msgs; ++i) {
236 memcpy(&msg, (in_data->data + (i * sizeof(long))), sizeof(long));
247 // export function for a full text search index record
248 // (indexed by an int and the data is arrays of longs)
249 void export_fulltext(int which_cdb, DBT *in_key, DBT *in_data) {
254 // records are indexed by a single "int" and contains an array of zero or more "long"s
256 memcpy(&indexnum, in_key->data, sizeof(int));
258 printf("fulltext|%d|", indexnum);
260 if (in_data->size > 0) {
261 num_msgs = in_data->size / sizeof(long);
262 for (i=0; i<num_msgs; ++i) {
263 memcpy(&msg, (in_data->data + (i * sizeof(long))), sizeof(long));
274 // export function for a visit record
275 void export_visit(int which_cdb, DBT *in_key, DBT *in_data) {
276 struct visit *visit = (struct visit *)in_data->data;
279 // If there is corrupt data in the "seen" array, cut that out before exporting
280 len = strlen(visit->v_seen);
281 for (i=0; i<len; ++i) {
282 if (!isprint(visit->v_seen[i])) {
283 visit->v_seen[i] = 0;
287 // If there is corrupt data in the "answered" array, cut that out before exporting
288 len = strlen(visit->v_answered);
289 for (i=0; i<len; ++i) {
290 if (!isprint(visit->v_answered[i])) {
291 visit->v_answered[i] = 0;
296 printf("visit|%ld|%ld|%ld|%ld|%u|%s|%s|%d|\n",
309 // export function for a directory record
310 void export_dir(int which_cdb, DBT *in_key, DBT *in_data) {
312 fwrite(in_key->data, in_key->size, 1, stdout);
313 printf("|%s|\n", (char *)in_data->data);
317 // export function for a use table record
318 void export_usetable(int which_cdb, DBT *in_key, DBT *in_data) {
319 struct UseTable *u = (struct UseTable *)in_data->data;
320 printf("use|%d|%ld|\n", u->hash, u->timestamp);
324 // export function for large message texts
325 void export_bigmsg(int which_cdb, DBT *in_key, DBT *in_data) {
328 memcpy(&msgnum, in_key->data, sizeof(msgnum));
329 printf("bigmsg|%ld|%s|\n", msgnum, b64out(in_data->data, in_data->size));
333 // export function for EUID Index records
334 void export_euidindex(int which_cdb, DBT *in_key, DBT *in_data) {
336 // The structure of an euidindex record *key* is:
337 // |----room_number----|----------EUID-------------|
338 // (sizeof long) (actual length of euid)
340 // The structure of an euidindex record *value* is:
341 // |-----msg_number----|----room_number----|----------EUID-------------|
342 // (sizeof long) (sizeof long) (actual length of euid)
344 long msgnum, roomnum;
347 memcpy(&msgnum, in_data->data, sizeof(long));
348 memcpy(&roomnum, in_data->data+sizeof(long), sizeof(msgnum));
349 euid = in_data->data+(sizeof(long)*2);
351 printf("euidindex|%ld|%ld|%s|\n", msgnum, roomnum, euid);
355 // export users-by-number records
356 // (This is a secondary index -- should we just regenerate the data after import?)
357 void export_usersbynumber(int which_cdb, DBT *in_key, DBT *in_data) {
361 memcpy(&usernum, in_key->data, sizeof(usernum));
364 printf("usersbynumber|%ld|%s|\n", usernum, (char *)in_data->data);
368 // export function for a config record
369 void export_config(int which_cdb, DBT *in_key, DBT *in_data) {
371 printf("config|%s|%s|\n",
372 (char *)in_data->data,
373 (char *)in_data->data + strlen(in_data->data) + 1
379 // For obsolete databases, zero all the output
380 void zero_function(int which_cdb, DBT *in_key, DBT *in_data) {
385 void (*export_functions[])(int which_cdb, DBT *in_key, DBT *in_data) = {
386 export_msgmain, // 00 CDB_MSGMAIN
387 export_user, // 01 CDB_USERS
388 export_room, // 02 CDB_ROOMS
389 export_floor, // 03 CDB_FLOORTAB
390 export_msglist, // 04 CDB_MSGLISTS
391 export_visit, // 05 CDB_VISIT
392 export_dir, // 06 CDB_DIRECTORY
393 export_usetable, // 07 CDB_USETABLE
394 export_bigmsg, // 08 CDB_BIGMSGS
395 export_fulltext, // 09 CDB_FULLTEXT
396 export_euidindex, // 0a CDB_EUIDINDEX
397 export_usersbynumber, // 0b CDB_USERSBYNUMBER
398 zero_function, // 0c CDB_UNUSED1 (obsolete)
399 export_config // 0d CDB_CONFIG
403 void export_table(int which_cdb, DB_ENV *src_dbenv) {
409 // shamelessly swiped from https://docs.oracle.com/database/bdb181/html/programmer_reference/am_cursor.html
412 DBT in_key, in_data, uncomp_data;
413 int num_good_rows = 0;
414 int num_bad_rows = 0;
416 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", which_cdb);
418 // create a database handle for the source table
419 ret = db_create(&src_dbp, src_dbenv, 0);
421 fprintf(stderr, "ctdldump: db_create: %s\n", db_strerror(ret));
422 fprintf(stderr, "ctdldump: exit code %d\n", ret);
426 // open the file containing the source table
427 ret = src_dbp->open(src_dbp, NULL, dbfilename, NULL, DB_BTREE, 0, 0600);
429 fprintf(stderr, "ctdldump: db_open(%s): %s (skipping empty or missing table)\n", dbfilename, db_strerror(ret));
433 // Acquire a cursor to read the source table
434 if ((ret = src_dbp->cursor(src_dbp, NULL, &src_dbcp, 0)) != 0) {
435 fprintf(stderr, "ctdldump: db_cursor: %s\n", db_strerror(ret));
436 fprintf(stderr, "ctdldump: exit code %d\n", ret);
440 // Zero out these database keys
441 memset(&in_key, 0, sizeof(DBT)); // input
442 memset(&in_data, 0, sizeof(DBT));
443 memset(&uncomp_data, 0, sizeof(DBT)); // decompressed input (the key doesn't change)
445 // Walk through the database, calling export functions as we go and clearing buffers before each call.
446 while (ret = src_dbcp->get(src_dbcp, &in_key, &in_data, DB_NEXT) == 0) {
448 // If either the key or data are zero length, skip this record
449 if ((in_key.size == 0) || (in_data.size == 0)) {
453 else { // Both key and data are >0 length so we're good to go
455 // Do we need to decompress?
456 static int32_t magic = COMPRESS_MAGIC;
458 if ((in_data.size >= sizeof(struct CtdlCompressHeader)) && (!memcmp(in_data.data, &magic, sizeof(magic)))) {
460 // yes, we need to decompress
462 struct CtdlCompressHeader comp;
463 memcpy(&comp, in_data.data, sizeof(struct CtdlCompressHeader));
464 uncomp_data.size = comp.uncompressed_len;
465 uncomp_data.data = reallok(uncomp_data.data, uncomp_data.size);
466 destLen = (uLongf)comp.uncompressed_len;
468 ret = uncompress((Bytef *)uncomp_data.data, (uLongf *)&destLen,
469 (const Bytef *)in_data.data+sizeof(struct CtdlCompressHeader),
470 (uLong)comp.compressed_len);
472 fprintf(stderr, "ctdldump: uncompress() error %d\n", ret);
477 // Call the export function registered to this table
478 export_functions[which_cdb](which_cdb, &in_key, (compressed ? &uncomp_data : &in_data));
480 // Knowing the total number of rows isn't critical to the program. It's just for the user to know.
486 // free any leftover out_data pointers
487 free(uncomp_data.data);
489 // ...and close the database (table)
490 ret = src_dbp->close(src_dbp, 0);
492 fprintf(stderr, "ctdldump: db_close: %s\n", db_strerror(ret));
499 int main(int argc, char **argv) {
501 char src_dir[PATH_MAX];
503 static DB_ENV *src_dbenv; // Source DB environment (global)
505 // display the greeting
506 fprintf(stderr, "\033[44m\033[33m\033[1m \033[K\033[0m\n"
507 "\033[44m\033[33m\033[1m DB Dump utility for Citadel \033[K\033[0m\n"
508 "\033[44m\033[33m\033[1m Copyright (c) 2023 by citadel.org et al. \033[K\033[0m\n"
509 "\033[44m\033[33m\033[1m This program is open source software. Use, duplication, or disclosure \033[K\033[0m\n"
510 "\033[44m\033[33m\033[1m is subject to the terms of the GNU General Public license v3. \033[K\033[0m\n"
511 "\033[44m\033[33m\033[1m \033[K\033[0m\n");
513 // Default source directory unless overridden
514 snprintf(src_dir, sizeof(src_dir), "%s/data", CTDLDIR);
516 // Parse command line
518 while ((a = getopt(argc, argv, "h:y")) != EOF) {
521 snprintf(src_dir, sizeof(src_dir), "%s/data", optarg);
527 fprintf(stderr, "%s: usage: %s -s citadel_dir [>dumpfile]\n", argv[0], argv[0]);
532 if (src_dir == NULL) {
533 fprintf(stderr, "ctdldump: no source directory was specified.\n");
537 if (confirmed == 1) {
538 fprintf(stderr, "ctdldump: You have specified the [-y] flag, so processing will continue.\n");
541 fprintf(stderr, "ctdldump: usage: ctdldump -y -h[citadel_dir] >[dump_file]\n");
542 fprintf(stderr, " [citadel_dir] is your database directory, usually /usr/local/citadel\n");
543 fprintf(stderr, " Please read [ https://www.citadel.org/dump-and-load.html ] to learn how to proceed.\n");
547 src_dbenv = open_dbenv(src_dir);
549 for (i = 0; i < MAXCDB; ++i) {
550 export_table(i, src_dbenv);
552 close_dbenv(src_dbenv);
555 fprintf(stderr, "ctdldump: \033[32m\033[1mfinished\033[0m\n");