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", meta->meta_msgnum, meta->meta_refcount, meta->meta_content_type, meta->meta_rfc822_length);
158 // If the msgnum is positive, we are looking at a MESSAGE
159 else if (in_msgnum > 0) {
160 printf("msgtext|%s\n", hexout(in_data->data, in_data->size));
163 // If the msgnum is 0 it's probably not a valid record.
167 // export function for a user record
168 void export_user(int which_cdb, DBT *in_key, DBT *in_data) {
170 struct ctdluser *user = (struct ctdluser *)in_data->data;
172 printf("user|%d|%d|%s|%u|%d|%ld|%ld|%d|%s|%ld|%ld|%s|%ld|%ld\n",
173 user->version, // Citadel version which created this record
174 user->uid, // Associate with a unix account?
175 user->password, // password
176 user->flags, // See US_ flags
177 user->axlevel, // Access level
178 user->usernum, // User number (never recycled)
179 user->lastcall, // Date/time of most recent login
180 user->USuserpurge, // Purge time (in days) for user
181 user->fullname, // Display name (primary identifier)
182 user->msgnum_bio, // msgnum of user's profile (bio)
183 user->msgnum_pic, // msgnum of user's avatar (photo)
184 hexout(user->emailaddrs, strlen(user->emailaddrs)), // Internet email addresses
185 user->msgnum_inboxrules, // msgnum of user's inbox filtering rules
186 user->lastproc_inboxrules // msgnum of last message filtered
191 // export function for a room record
192 void export_room(int which_cdb, DBT *in_key, DBT *in_data) {
194 struct ctdlroom *room = (struct ctdlroom *)in_data->data;
196 printf("room|%s|%s|%ld|%ld|%ld|%u|%s|%ld|%d|%ld|%d|%d|%ld|%d|%u|%d|%ld\n",
207 room->QRep.expire_mode,
208 room->QRep.expire_value,
218 // export function for a floor record
219 void export_floor(int which_cdb, DBT *in_key, DBT *in_data) {
222 memcpy(&floor_num, in_key->data, sizeof(int));
224 struct floor *floor = (struct floor *)in_data->data;
226 printf("floor|%d|%u|%s|%d|%d|%d\n",
231 floor->f_ep.expire_mode,
232 floor->f_ep.expire_value
237 // export function for a msglist or a fulltext index record
238 // (both are indexed by a long and the data is arrays of longs)
239 void export_msglist(int which_cdb, DBT *in_key, DBT *in_data) {
244 // records are indexed by a single "long" and contains an array of zero or more "long"s
246 memcpy(&roomnum, in_key->data, sizeof(long));
248 printf("msglist|%ld|", roomnum);
250 if (in_data->size > 0) {
251 num_msgs = in_data->size / sizeof(long);
252 for (i=0; i<num_msgs; ++i) {
253 memcpy(&msg, (in_data->data + (i * sizeof(long))), sizeof(long));
264 // export function for a visit record
265 void export_visit(int which_cdb, DBT *in_key, DBT *in_data) {
267 struct visit *visit = (struct visit *)in_data->data;
269 printf("visit|%ld|%ld|%ld|%ld|%u|%s|%s|%d\n",
283 // export function for a directory record
284 void export_dir(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
286 // the key is a string
287 out_key->size = in_key->size;
288 out_key->data = realloc(out_key->data, out_key->size + 1);
289 memcpy(out_key->data, in_key->data, in_key->size);
290 char *k = (char *)out_key->data;
291 k[out_key->size] = 0;
293 // the data is also a string
294 out_data->size = in_data->size;
295 out_data->data = realloc(out_data->data, out_data->size + 1);
296 memcpy(out_data->data, in_data->data, in_data->size);
297 char *d = (char *)out_data->data;
298 d[out_data->size] = 0;
300 // please excuse my friend, he isn't null terminated
301 // printf("\033[32m\033[1mDirectory entry: %s -> %s\033[0m\n", (char *)out_key->data, (char *)out_data->data);
305 // export function for a use table record
306 void export_usetable(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
308 // the key is an int, which is the same size (32 bits) on both 32 and 64 bit systems
309 out_key->size = in_key->size;
310 out_key->data = realloc(out_key->data, out_key->size);
311 memcpy(out_key->data, in_key->data, in_key->size);
313 // the data is a "struct UseTable"
314 struct UseTable_32 *use32 = (struct UseTable_32 *)in_data->data;
315 out_data->size = sizeof(struct UseTable);
316 out_data->data = realloc(out_data->data, out_data->size);
317 memset(out_data->data, 0, out_data->size);
318 struct UseTable *use64 = (struct UseTable *)out_data->data;
321 use64->hash = use32->hash;
322 use64->timestamp = (time_t) use32->timestamp;
324 // printf("\033[32m\033[1muse table: %d , %s\033[0m\n", use64->hash, asctime(localtime(&use64->timestamp)));
328 // export function for large message texts
329 void export_bigmsgs(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
331 // The key is a packed long
334 memcpy(&in_msgnum, in_key->data, sizeof(in_msgnum));
335 out_msgnum = (long)in_msgnum;
337 if (in_key->size != 4) {
338 fprintf(stderr, "\033[31m\033[1m *** SOURCE DATABASE IS NOT 32-BIT *** ABORTING *** \033[0m\n");
342 out_key->size = sizeof(long);
343 out_key->data = realloc(out_key->data, out_key->size);
344 memcpy(out_key->data, &out_msgnum, sizeof(long));
346 // the data is binary-ish but has no packed integers
347 out_data->size = in_data->size;
348 out_data->data = realloc(out_data->data, out_data->size);
349 memcpy(out_data->data, in_data->data, in_data->size);
351 // printf("\033[32m\033[1mBigmsg %ld , length %d\033[0m\n", out_msgnum, out_data->size);
355 // export function for EUID Index records
356 void export_euidindex(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
358 // The structure of an euidindex record *key* is:
359 // |----room_number----|----------EUID-------------|
360 // (sizeof long) (actual length of euid)
362 // The structure of an euidindex record *value* is:
363 // |-----msg_number----|----room_number----|----------EUID-------------|
364 // (sizeof long) (sizeof long) (actual length of euid)
366 int32_t in_msgnum = 0;
367 int32_t in_roomnum = 0;
370 long out_roomnum = 0;
372 memcpy(&in_msgnum, in_data->data, sizeof(in_msgnum));
373 memcpy(&in_roomnum, in_data->data+sizeof(int32_t), sizeof(in_msgnum));
374 strcpy(euid, in_data->data+(sizeof(int32_t)*2));
376 out_msgnum = (long) in_msgnum;
377 out_roomnum = (long) in_roomnum;
378 // printf("euidindex: msgnum=%ld, roomnum=%ld, euid=\"%s\"\n", out_msgnum, out_roomnum, euid);
380 out_key->size = sizeof(long) + strlen(euid) + 1;
381 out_key->data = realloc(out_key->data, out_key->size);
382 memcpy(out_key->data, &out_roomnum, sizeof(out_roomnum));
383 strcpy(out_key->data+sizeof(out_roomnum), euid);
385 out_data->size = sizeof(long) + sizeof(long) + strlen(euid) + 1;
386 out_data->data = realloc(out_data->data, out_data->size);
387 memcpy(out_data->data, &out_msgnum, sizeof(out_msgnum));
388 memcpy(out_data->data+sizeof(out_msgnum), &out_roomnum, sizeof(out_roomnum));
389 strcpy(out_data->data+sizeof(out_msgnum)+sizeof(out_roomnum), euid);
393 // convert users-by-number records
394 void export_usersbynumber(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
397 // and remember ... "long" is int32_t on the source system
400 memcpy(&in_usernum, in_key->data, sizeof(in_usernum));
401 out_usernum = (long) in_usernum;
403 if (in_key->size != 4) {
404 fprintf(stderr, "\033[31m\033[1m *** SOURCE DATABASE IS NOT 32-BIT *** ABORTING *** \033[0m\n");
408 out_key->size = sizeof(out_usernum);
409 out_key->data = realloc(out_key->data, out_key->size);
410 memcpy(out_key->data, &out_usernum, sizeof(out_usernum));
413 out_data->size = in_data->size;
414 out_data->data = realloc(out_data->data, out_data->size);
415 memcpy(out_data->data, in_data->data, in_data->size);
417 // printf("usersbynumber: %ld --> %s\n", out_usernum, (char *)out_data->data);
421 // export function for a config record
422 void export_config(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
424 // the key is a string
425 out_key->size = in_key->size;
426 out_key->data = realloc(out_key->data, out_key->size + 1);
427 memcpy(out_key->data, in_key->data, in_key->size);
428 char *k = (char *)out_key->data;
429 k[out_key->size] = 0;
431 // the data is a pair of strings
432 out_data->size = in_data->size;
433 out_data->data = realloc(out_data->data, out_data->size + 1);
434 memcpy(out_data->data, in_data->data, in_data->size);
435 char *d = (char *)out_data->data;
436 d[out_data->size] = 0;
438 // please excuse my friend, he isn't null terminated
439 // printf("\033[32m\033[1mConfig entry: %s -> %s\033[0m\n", (char *)out_key->data, (char *)out_data->data+strlen(out_data->data)+1);
444 // For obsolete databases, zero all the output
445 void zero_function(int which_cdb, DBT *in_key, DBT *in_data) {
446 //printf("Table %02x, keylen=%d, datalen=%d\n", which_cdb, in_key->size, in_data->size);
450 void (*export_functions[])(int which_cdb, DBT *in_key, DBT *in_data) = {
451 export_msgmain, // CDB_MSGMAIN
452 export_user, // CDB_USERS
453 export_room, // CDB_ROOMS
454 export_floor, // CDB_FLOORTAB
455 export_msglist, // CDB_MSGLISTS
456 export_visit, // CDB_VISIT
457 zero_function, // CDB_DIRECTORY
458 zero_function, // CDB_USETABLE
459 zero_function, // CDB_BIGMSGS
460 zero_function, // CDB_FULLTEXT
461 zero_function, // CDB_EUIDINDEX
462 zero_function, // CDB_USERSBYNUMBER
463 zero_function, // CDB_UNUSED1 (obsolete)
464 zero_function // CDB_CONFIG
468 void export_table(int which_cdb, DB_ENV *src_dbenv) {
474 // shamelessly swiped from https://docs.oracle.com/database/bdb181/html/programmer_reference/am_cursor.html
477 DBT in_key, in_data, uncomp_data;
478 int num_good_rows = 0;
479 int num_bad_rows = 0;
481 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", which_cdb);
483 // create a database handle for the source table
484 ret = db_create(&src_dbp, src_dbenv, 0);
486 fprintf(stderr, "db: db_create: %s\n", db_strerror(ret));
487 fprintf(stderr, "db: exit code %d\n", ret);
491 // open the file containing the source table
492 ret = src_dbp->open(src_dbp, NULL, dbfilename, NULL, DB_BTREE, 0, 0600);
494 fprintf(stderr, "db: db_open: %s\n", db_strerror(ret));
495 fprintf(stderr, "db: exit code %d\n", ret);
499 // Acquire a cursor to read the source table
500 if ((ret = src_dbp->cursor(src_dbp, NULL, &src_dbcp, 0)) != 0) {
501 fprintf(stderr, "db: db_cursor: %s\n", db_strerror(ret));
502 fprintf(stderr, "db: exit code %d\n", ret);
506 // Zero out these database keys
507 memset(&in_key, 0, sizeof(DBT)); // input
508 memset(&in_data, 0, sizeof(DBT));
509 memset(&uncomp_data, 0, sizeof(DBT)); // decompressed input (the key doesn't change)
511 // Walk through the database, calling export functions as we go and clearing buffers before each call.
512 while (ret = src_dbcp->get(src_dbcp, &in_key, &in_data, DB_NEXT) == 0) {
514 // If either the key or data are zero length, skip this record
515 if ((in_key.size == 0) || (in_data.size == 0)) {
519 else { // Both key and data are >0 length so we're good to go
521 // Do we need to decompress?
522 static int32_t magic = COMPRESS_MAGIC;
524 if ( (in_data.size >= sizeof(struct CtdlCompressHeader)) && (!memcmp(in_data.data, &magic, sizeof(magic))) ) {
526 // yes, we need to decompress
528 struct CtdlCompressHeader comp;
529 memcpy(&comp, in_data.data, sizeof(struct CtdlCompressHeader));
530 uncomp_data.size = comp.uncompressed_len;
531 uncomp_data.data = realloc(uncomp_data.data, uncomp_data.size);
532 destLen = (uLongf)comp.uncompressed_len;
534 ret = uncompress((Bytef *)uncomp_data.data, (uLongf *)&destLen, (const Bytef *)in_data.data+sizeof(struct CtdlCompressHeader), (uLong)comp.compressed_len);
536 fprintf(stderr, "db: uncompress() error %d\n", ret);
541 // Call the export function registered to this table
542 export_functions[which_cdb](which_cdb, &in_key, (compressed ? &uncomp_data : &in_data));
544 // Knowing the total number of rows isn't critical to the program. It's just for the user to know.
549 // free any leftover out_data pointers
550 free(uncomp_data.data);
552 // ...and close the database (table)
553 ret = src_dbp->close(src_dbp, 0);
555 fprintf(stderr, "db: db_close: %s\n", db_strerror(ret));
562 int main(int argc, char **argv) {
564 char *src_dir = NULL;
565 char *dst_dir = NULL;
567 static DB_ENV *src_dbenv; // Source DB environment (global)
569 // Parse command line
571 while ((a = getopt(argc, argv, "h:d:y")) != EOF) {
583 fprintf(stderr, "%s: usage: %s -s source_dir -d dest_dir\n", argv[0], argv[0]);
589 fprintf(stderr, "------------------------------------------------------------------------\n");
590 fprintf(stderr, "This utility must be run while the server is OFFLINE. \n");
591 fprintf(stderr, "We \033[1mguarantee\033[0m data corruption if you do not \n");
592 fprintf(stderr, "observe this warning! The source [-s] directory should contain a copy \n");
593 fprintf(stderr, "of the database from your source system. The dump [-d] directory \n");
594 fprintf(stderr, "should be empty and will receive your dump file. \n");
595 fprintf(stderr, "------------------------------------------------------------------------\n");
596 fprintf(stderr, " Source (database) directory: %s\n", src_dir);
597 fprintf(stderr, "------------------------------------------------------------------------\n");
599 if (confirmed == 1) {
600 fprintf(stderr, "You have specified the [-y] flag, so processing will continue.\n");
603 fprintf(stderr, "Please read [ https://www.citadel.org/ctdldump.html ] to learn how to proceed.\n");
607 src_dbenv = open_dbenv(src_dir);
608 for (i = 0; i < MAXCDB; ++i) {
609 export_table(i, src_dbenv);
611 close_dbenv(src_dbenv);