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"
31 // Wrapper for realloc() that crashes and burns if the call fails.
32 void *reallok(void *ptr, size_t size) {
33 void *p = realloc(ptr, size);
35 fprintf(stderr, "realloc() failed to resize %p to %ld bytes, error: %m\n", ptr, size);
40 #define realloc reallok
43 // convert a binary blob to hex (non-reentrant!!!)
44 char *hexout(void *data, size_t len) {
45 static char *outbuf = NULL;
46 static size_t outlen = 0;
50 if ((outbuf == NULL) || (outlen < (len * 2))) {
51 outbuf = reallok(outbuf, (len * 2));
55 for (i=0; i<len; ++i) {
57 memcpy(&ch, data+i, 1);
58 sprintf((outbuf + (i * 2)), "%02X", (int) ch);
65 // Open a database environment
66 DB_ENV *open_dbenv(char *dirname) {
73 int dbversion_major, dbversion_minor, dbversion_patch;
76 "db: open_dbenv() starting\n"
77 "db: Linked zlib: %s\n"
78 "db: Compiled libdb: %s\n"
79 "db: Linked libdb: %s\n",
82 db_version(&dbversion_major, &dbversion_minor, &dbversion_patch)
85 // Create synthetic integer version numbers and compare them.
86 // Never run with a libdb older than the one with which it was compiled.
87 int compiled_db_version = ( (DB_VERSION_MAJOR * 1000000) + (DB_VERSION_MINOR * 1000) + (DB_VERSION_PATCH) );
88 int linked_db_version = ( (dbversion_major * 1000000) + (dbversion_minor * 1000) + (dbversion_patch) );
89 if (compiled_db_version > linked_db_version) {
90 fprintf(stderr, "db: ctdldump is running with a version of libdb older than the one with which it was compiled.\n"
91 "db: This is an invalid configuration. ctdldump will now exit to prevent data loss.");
95 fprintf(stderr, "db: Setting up DB environment\n");
96 ret = db_env_create(&dbenv, 0);
98 fprintf(stderr, "db: db_env_create: %s\n", db_strerror(ret));
99 fprintf(stderr, "db: exit code %d\n", ret);
103 // We want to specify the shared memory buffer pool cachesize, but everything else is the default.
104 ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
106 fprintf(stderr, "db: set_cachesize: %s\n", db_strerror(ret));
107 dbenv->close(dbenv, 0);
108 fprintf(stderr, "db: exit code %d\n", ret);
112 if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
113 fprintf(stderr, "db: set_lk_detect: %s\n", db_strerror(ret));
114 dbenv->close(dbenv, 0);
115 fprintf(stderr, "db: exit code %d\n", ret);
119 flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_LOG;
120 fprintf(stderr, "db: dbenv open(dir=%s, flags=%d)\n", dirname, flags);
121 ret = dbenv->open(dbenv, dirname, flags, 0);
123 fprintf(stderr, "db: dbenv->open: %s\n", db_strerror(ret));
124 dbenv->close(dbenv, 0);
125 fprintf(stderr, "db: exit code %d\n", ret);
133 void close_dbenv(DB_ENV *dbenv) {
134 int ret = dbenv->close(dbenv, 0);
136 fprintf(stderr, "db: dbenv->close: %s\n", db_strerror(ret));
141 // export function for a message in msgmain
142 void export_msgmain(int which_cdb, DBT *in_key, DBT *in_data) {
145 if (in_key->size != sizeof(long)) {
146 fprintf(stderr, "\033[31m\033[1m *** BAD DATA *** ABORTING *** \033[0m\n");
150 memcpy(&in_msgnum, in_key->data, sizeof(in_msgnum));
152 // If the msgnum is negative, we are looking at METADATA
154 struct MetaData *meta = (struct MetaData *)in_data->data;
155 printf("msgmeta|%ld|%d|%s|%ld\n",
158 meta->meta_content_type,
159 meta->meta_rfc822_length
163 // If the msgnum is positive, we are looking at a MESSAGE
164 else if (in_msgnum > 0) {
165 printf("msgtext|%ld|%s\n", in_msgnum, hexout(in_data->data, in_data->size));
168 // If the msgnum is 0 it's probably not a valid record.
172 // export function for a user record
173 void export_user(int which_cdb, DBT *in_key, DBT *in_data) {
175 struct ctdluser *user = (struct ctdluser *)in_data->data;
177 printf("user|%d|%d|%s|%u|%d|%ld|%ld|%d|%s|%ld|%ld|%s|%ld|%ld\n",
189 hexout(user->emailaddrs, strlen(user->emailaddrs)),
190 user->msgnum_inboxrules,
191 user->lastproc_inboxrules
196 // export function for a room record
197 void export_room(int which_cdb, DBT *in_key, DBT *in_data) {
199 struct ctdlroom *room = (struct ctdlroom *)in_data->data;
201 printf("room|%s|%s|%ld|%ld|%ld|%u|%s|%ld|%d|%ld|%d|%d|%ld|%d|%u|%d|%ld\n",
212 room->QRep.expire_mode,
213 room->QRep.expire_value,
223 // export function for a floor record
224 void export_floor(int which_cdb, DBT *in_key, DBT *in_data) {
227 memcpy(&floor_num, in_key->data, sizeof(int));
229 struct floor *floor = (struct floor *)in_data->data;
231 printf("floor|%d|%u|%s|%d|%d|%d\n",
236 floor->f_ep.expire_mode,
237 floor->f_ep.expire_value
242 // export function for a msglist or a fulltext index record
243 // (both are indexed by a long and the data is arrays of longs)
244 void export_msglist(int which_cdb, DBT *in_key, DBT *in_data) {
249 // records are indexed by a single "long" and contains an array of zero or more "long"s
251 memcpy(&roomnum, in_key->data, sizeof(long));
253 printf("msglist|%ld|", roomnum);
255 if (in_data->size > 0) {
256 num_msgs = in_data->size / sizeof(long);
257 for (i=0; i<num_msgs; ++i) {
258 memcpy(&msg, (in_data->data + (i * sizeof(long))), sizeof(long));
269 // export function for a visit record
270 void export_visit(int which_cdb, DBT *in_key, DBT *in_data) {
271 struct visit *visit = (struct visit *)in_data->data;
272 printf("visit|%ld|%ld|%ld|%ld|%u|%s|%s|%d\n",
285 // export function for a directory record
286 // (This is a secondary index -- should we just regenerate the data after import?)
287 void export_dir(int which_cdb, DBT *in_key, DBT *in_data) {
289 fwrite(in_key->data, in_key->size, 1, stdout);
290 printf("|%s\n", (char *)in_data->data);
294 // export function for a use table record
295 void export_usetable(int which_cdb, DBT *in_key, DBT *in_data) {
296 struct UseTable *u = (struct UseTable *)in_data->data;
297 printf("use|%d|%ld\n", u->hash, u->timestamp);
301 // export function for large message texts
302 void export_bigmsg(int which_cdb, DBT *in_key, DBT *in_data) {
305 memcpy(&msgnum, in_key->data, sizeof(msgnum));
306 printf("bigmsg|%ld|%s\n", msgnum, hexout(in_data->data, in_data->size));
310 // export function for EUID Index records
311 void export_euidindex(int which_cdb, DBT *in_key, DBT *in_data) {
313 // The structure of an euidindex record *key* is:
314 // |----room_number----|----------EUID-------------|
315 // (sizeof long) (actual length of euid)
317 // The structure of an euidindex record *value* is:
318 // |-----msg_number----|----room_number----|----------EUID-------------|
319 // (sizeof long) (sizeof long) (actual length of euid)
321 long msgnum, roomnum;
324 memcpy(&msgnum, in_data->data, sizeof(long));
325 memcpy(&roomnum, in_data->data+sizeof(long), sizeof(msgnum));
326 euid = in_data->data+(sizeof(long)*2);
328 printf("euidindex|%ld|%ld|%s\n", msgnum, roomnum, euid);
333 // export users-by-number records
334 // (This is a secondary index -- should we just regenerate the data after import?)
335 void export_usersbynumber(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
338 // and remember ... "long" is int32_t on the source system
341 memcpy(&in_usernum, in_key->data, sizeof(in_usernum));
342 out_usernum = (long) in_usernum;
344 if (in_key->size != 4) {
345 fprintf(stderr, "\033[31m\033[1m *** SOURCE DATABASE IS NOT 32-BIT *** ABORTING *** \033[0m\n");
349 out_key->size = sizeof(out_usernum);
350 out_key->data = realloc(out_key->data, out_key->size);
351 memcpy(out_key->data, &out_usernum, sizeof(out_usernum));
354 out_data->size = in_data->size;
355 out_data->data = realloc(out_data->data, out_data->size);
356 memcpy(out_data->data, in_data->data, in_data->size);
358 // printf("usersbynumber: %ld --> %s\n", out_usernum, (char *)out_data->data);
364 // export function for a config record
365 void export_config(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
367 // the key is a string
368 out_key->size = in_key->size;
369 out_key->data = realloc(out_key->data, out_key->size + 1);
370 memcpy(out_key->data, in_key->data, in_key->size);
371 char *k = (char *)out_key->data;
372 k[out_key->size] = 0;
374 // the data is a pair of strings
375 out_data->size = in_data->size;
376 out_data->data = realloc(out_data->data, out_data->size + 1);
377 memcpy(out_data->data, in_data->data, in_data->size);
378 char *d = (char *)out_data->data;
379 d[out_data->size] = 0;
381 // please excuse my friend, he isn't null terminated
382 // printf("\033[32m\033[1mConfig entry: %s -> %s\033[0m\n", (char *)out_key->data, (char *)out_data->data+strlen(out_data->data)+1);
387 // For obsolete databases, zero all the output
388 void zero_function(int which_cdb, DBT *in_key, DBT *in_data) {
393 void (*export_functions[])(int which_cdb, DBT *in_key, DBT *in_data) = {
394 export_msgmain, // CDB_MSGMAIN
395 export_user, // CDB_USERS
396 export_room, // CDB_ROOMS
397 export_floor, // CDB_FLOORTAB
398 export_msglist, // CDB_MSGLISTS
399 export_visit, // CDB_VISIT
400 export_dir, // CDB_DIRECTORY
401 export_usetable, // CDB_USETABLE
402 export_bigmsg, // CDB_BIGMSGS
403 zero_function, // CDB_FULLTEXT (regenerate this on the server)
404 export_euidindex, // CDB_EUIDINDEX
405 zero_function, // CDB_USERSBYNUMBER
406 zero_function, // CDB_UNUSED1 (obsolete)
407 zero_function // CDB_CONFIG
411 void export_table(int which_cdb, DB_ENV *src_dbenv) {
417 // shamelessly swiped from https://docs.oracle.com/database/bdb181/html/programmer_reference/am_cursor.html
420 DBT in_key, in_data, uncomp_data;
421 int num_good_rows = 0;
422 int num_bad_rows = 0;
424 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", which_cdb);
426 // create a database handle for the source table
427 ret = db_create(&src_dbp, src_dbenv, 0);
429 fprintf(stderr, "db: db_create: %s\n", db_strerror(ret));
430 fprintf(stderr, "db: exit code %d\n", ret);
434 // open the file containing the source table
435 ret = src_dbp->open(src_dbp, NULL, dbfilename, NULL, DB_BTREE, 0, 0600);
437 fprintf(stderr, "db: db_open: %s\n", db_strerror(ret));
438 fprintf(stderr, "db: exit code %d\n", ret);
442 // Acquire a cursor to read the source table
443 if ((ret = src_dbp->cursor(src_dbp, NULL, &src_dbcp, 0)) != 0) {
444 fprintf(stderr, "db: db_cursor: %s\n", db_strerror(ret));
445 fprintf(stderr, "db: exit code %d\n", ret);
449 // Zero out these database keys
450 memset(&in_key, 0, sizeof(DBT)); // input
451 memset(&in_data, 0, sizeof(DBT));
452 memset(&uncomp_data, 0, sizeof(DBT)); // decompressed input (the key doesn't change)
454 // Walk through the database, calling export functions as we go and clearing buffers before each call.
455 while (ret = src_dbcp->get(src_dbcp, &in_key, &in_data, DB_NEXT) == 0) {
457 // If either the key or data are zero length, skip this record
458 if ((in_key.size == 0) || (in_data.size == 0)) {
462 else { // Both key and data are >0 length so we're good to go
464 // Do we need to decompress?
465 static int32_t magic = COMPRESS_MAGIC;
467 if ((in_data.size >= sizeof(struct CtdlCompressHeader)) && (!memcmp(in_data.data, &magic, sizeof(magic)))) {
469 // yes, we need to decompress
471 struct CtdlCompressHeader comp;
472 memcpy(&comp, in_data.data, sizeof(struct CtdlCompressHeader));
473 uncomp_data.size = comp.uncompressed_len;
474 uncomp_data.data = realloc(uncomp_data.data, uncomp_data.size);
475 destLen = (uLongf)comp.uncompressed_len;
477 ret = uncompress((Bytef *)uncomp_data.data, (uLongf *)&destLen,
478 (const Bytef *)in_data.data+sizeof(struct CtdlCompressHeader),
479 (uLong)comp.compressed_len);
481 fprintf(stderr, "db: uncompress() error %d\n", ret);
486 // Call the export function registered to this table
487 export_functions[which_cdb](which_cdb, &in_key, (compressed ? &uncomp_data : &in_data));
489 // Knowing the total number of rows isn't critical to the program. It's just for the user to know.
494 // free any leftover out_data pointers
495 free(uncomp_data.data);
497 // ...and close the database (table)
498 ret = src_dbp->close(src_dbp, 0);
500 fprintf(stderr, "db: db_close: %s\n", db_strerror(ret));
507 int main(int argc, char **argv) {
509 char *src_dir = NULL;
510 char *dst_dir = NULL;
512 static DB_ENV *src_dbenv; // Source DB environment (global)
514 // Parse command line
516 while ((a = getopt(argc, argv, "h:d:y")) != EOF) {
528 fprintf(stderr, "%s: usage: %s -s source_dir -d dest_dir\n", argv[0], argv[0]);
534 fprintf(stderr, "------------------------------------------------------------------------\n");
535 fprintf(stderr, "This utility must be run while the server is NOT RUNNING. \n");
536 fprintf(stderr, "We \033[1mguarantee\033[0m data corruption if you do not \n");
537 fprintf(stderr, "observe this warning! The source [-s] directory should contain a copy \n");
538 fprintf(stderr, "of the database from your source system. The dump [-d] directory \n");
539 fprintf(stderr, "should be empty and will receive your dump file. \n");
540 fprintf(stderr, "------------------------------------------------------------------------\n");
541 fprintf(stderr, " Source (database) directory: %s\n", src_dir);
542 fprintf(stderr, "------------------------------------------------------------------------\n");
544 if (confirmed == 1) {
545 fprintf(stderr, "You have specified the [-y] flag, so processing will continue.\n");
548 fprintf(stderr, "Please read [ https://www.citadel.org/ctdldump.html ] to learn how to proceed.\n");
552 src_dbenv = open_dbenv(src_dir);
553 for (i = 0; i < MAXCDB; ++i) {
554 export_table(i, src_dbenv);
556 close_dbenv(src_dbenv);