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
238 // export function for a msglist or a fulltext index record
239 // (both are indexed by a long and the data is arrays of longs)
240 void export_msglists(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
243 char *table = (which_cdb == CDB_FULLTEXT) ? "FullText" : "Msglist";
245 // records are indexed by a single "long" and contains an array of zero or more "long"s
246 // and remember ... "long" is int32_t on the source system
249 memcpy(&in_roomnum, in_key->data, sizeof(in_roomnum));
250 out_roomnum = (long) in_roomnum;
252 if (in_key->size != 4) {
253 fprintf(stderr, "\033[31m\033[1m *** SOURCE DATABASE IS NOT 32-BIT *** ABORTING *** \033[0m\n");
257 int num_msgs = in_data->size / sizeof(int32_t);
258 // printf("\033[32m\033[1m%s: key %ld (%d messages)\033[0m\n", table, out_roomnum, num_msgs);
260 // the key is a "long"
261 out_key->size = sizeof(out_roomnum);
262 out_key->data = realloc(out_key->data, out_key->size);
263 memcpy(out_key->data, &out_roomnum, sizeof(out_roomnum));
265 // the data is another array, but a wider type
266 out_data->size = sizeof(long) * num_msgs;
267 out_data->data = realloc(out_data->data, out_data->size);
271 for (i=0; i<num_msgs; ++i) {
272 memcpy(&in_msg, (in_data->data + (i * sizeof(int32_t))), sizeof(int32_t));
273 out_msg = (long) in_msg;
274 memcpy((out_data->data + (i * sizeof(long))), &out_msg, sizeof(long));
275 // printf("msg#%ld\n", out_msg);
280 // export function for a visit record
281 void export_visits(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
284 struct visit_32 *visit32 = (struct visit_32 *)in_data->data;
285 out_data->size = sizeof(struct visit);
286 out_data->data = realloc(out_data->data, out_data->size);
287 struct visit *visit64 = (struct visit *)out_data->data;
289 // the data (zero it out so it will compress well)
290 memset(visit64, 0, sizeof(struct visit));
291 visit64->v_roomnum = (long) visit32->v_roomnum;
292 visit64->v_roomgen = (long) visit32->v_roomgen;
293 visit64->v_usernum = (long) visit32->v_usernum;
294 visit64->v_lastseen = (long) visit32->v_lastseen;
295 visit64->v_flags = (unsigned) visit32->v_flags;
296 strcpy(visit64->v_seen, visit32->v_seen);
297 strcpy(visit64->v_answered, visit32->v_answered);
298 visit64->v_view = (int) visit32->v_view;
300 // printf("\033[32m\033[1mVisit: room %10ld, gen %10ld, user %10ld\033[0m\n", visit64->v_roomnum, visit64->v_roomgen, visit64->v_usernum);
302 // create the key (which is based on the data, so there is no need to convert the old key)
303 out_key->size = sizeof(struct visit_index);
304 out_key->data = realloc(out_key->data, out_key->size);
305 struct visit_index *newvisitindex = (struct visit_index *) out_key->data;
306 newvisitindex->iRoomID = visit64->v_roomnum;
307 newvisitindex->iRoomGen = visit64->v_roomgen;
308 newvisitindex->iUserID = visit64->v_usernum;
312 // export function for a directory record
313 void export_dir(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
315 // the key is a string
316 out_key->size = in_key->size;
317 out_key->data = realloc(out_key->data, out_key->size + 1);
318 memcpy(out_key->data, in_key->data, in_key->size);
319 char *k = (char *)out_key->data;
320 k[out_key->size] = 0;
322 // the data is also a string
323 out_data->size = in_data->size;
324 out_data->data = realloc(out_data->data, out_data->size + 1);
325 memcpy(out_data->data, in_data->data, in_data->size);
326 char *d = (char *)out_data->data;
327 d[out_data->size] = 0;
329 // please excuse my friend, he isn't null terminated
330 // printf("\033[32m\033[1mDirectory entry: %s -> %s\033[0m\n", (char *)out_key->data, (char *)out_data->data);
334 // export function for a use table record
335 void export_usetable(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
337 // the key is an int, which is the same size (32 bits) on both 32 and 64 bit systems
338 out_key->size = in_key->size;
339 out_key->data = realloc(out_key->data, out_key->size);
340 memcpy(out_key->data, in_key->data, in_key->size);
342 // the data is a "struct UseTable"
343 struct UseTable_32 *use32 = (struct UseTable_32 *)in_data->data;
344 out_data->size = sizeof(struct UseTable);
345 out_data->data = realloc(out_data->data, out_data->size);
346 memset(out_data->data, 0, out_data->size);
347 struct UseTable *use64 = (struct UseTable *)out_data->data;
350 use64->hash = use32->hash;
351 use64->timestamp = (time_t) use32->timestamp;
353 // printf("\033[32m\033[1muse table: %d , %s\033[0m\n", use64->hash, asctime(localtime(&use64->timestamp)));
357 // export function for large message texts
358 void export_bigmsgs(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
360 // The key is a packed long
363 memcpy(&in_msgnum, in_key->data, sizeof(in_msgnum));
364 out_msgnum = (long)in_msgnum;
366 if (in_key->size != 4) {
367 fprintf(stderr, "\033[31m\033[1m *** SOURCE DATABASE IS NOT 32-BIT *** ABORTING *** \033[0m\n");
371 out_key->size = sizeof(long);
372 out_key->data = realloc(out_key->data, out_key->size);
373 memcpy(out_key->data, &out_msgnum, sizeof(long));
375 // the data is binary-ish but has no packed integers
376 out_data->size = in_data->size;
377 out_data->data = realloc(out_data->data, out_data->size);
378 memcpy(out_data->data, in_data->data, in_data->size);
380 // printf("\033[32m\033[1mBigmsg %ld , length %d\033[0m\n", out_msgnum, out_data->size);
384 // export function for EUID Index records
385 void export_euidindex(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
387 // The structure of an euidindex record *key* is:
388 // |----room_number----|----------EUID-------------|
389 // (sizeof long) (actual length of euid)
391 // The structure of an euidindex record *value* is:
392 // |-----msg_number----|----room_number----|----------EUID-------------|
393 // (sizeof long) (sizeof long) (actual length of euid)
395 int32_t in_msgnum = 0;
396 int32_t in_roomnum = 0;
399 long out_roomnum = 0;
401 memcpy(&in_msgnum, in_data->data, sizeof(in_msgnum));
402 memcpy(&in_roomnum, in_data->data+sizeof(int32_t), sizeof(in_msgnum));
403 strcpy(euid, in_data->data+(sizeof(int32_t)*2));
405 out_msgnum = (long) in_msgnum;
406 out_roomnum = (long) in_roomnum;
407 // printf("euidindex: msgnum=%ld, roomnum=%ld, euid=\"%s\"\n", out_msgnum, out_roomnum, euid);
409 out_key->size = sizeof(long) + strlen(euid) + 1;
410 out_key->data = realloc(out_key->data, out_key->size);
411 memcpy(out_key->data, &out_roomnum, sizeof(out_roomnum));
412 strcpy(out_key->data+sizeof(out_roomnum), euid);
414 out_data->size = sizeof(long) + sizeof(long) + strlen(euid) + 1;
415 out_data->data = realloc(out_data->data, out_data->size);
416 memcpy(out_data->data, &out_msgnum, sizeof(out_msgnum));
417 memcpy(out_data->data+sizeof(out_msgnum), &out_roomnum, sizeof(out_roomnum));
418 strcpy(out_data->data+sizeof(out_msgnum)+sizeof(out_roomnum), euid);
422 // convert users-by-number records
423 void export_usersbynumber(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
426 // and remember ... "long" is int32_t on the source system
429 memcpy(&in_usernum, in_key->data, sizeof(in_usernum));
430 out_usernum = (long) in_usernum;
432 if (in_key->size != 4) {
433 fprintf(stderr, "\033[31m\033[1m *** SOURCE DATABASE IS NOT 32-BIT *** ABORTING *** \033[0m\n");
437 out_key->size = sizeof(out_usernum);
438 out_key->data = realloc(out_key->data, out_key->size);
439 memcpy(out_key->data, &out_usernum, sizeof(out_usernum));
442 out_data->size = in_data->size;
443 out_data->data = realloc(out_data->data, out_data->size);
444 memcpy(out_data->data, in_data->data, in_data->size);
446 // printf("usersbynumber: %ld --> %s\n", out_usernum, (char *)out_data->data);
450 // export function for a config record
451 void export_config(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
453 // the key is a string
454 out_key->size = in_key->size;
455 out_key->data = realloc(out_key->data, out_key->size + 1);
456 memcpy(out_key->data, in_key->data, in_key->size);
457 char *k = (char *)out_key->data;
458 k[out_key->size] = 0;
460 // the data is a pair of strings
461 out_data->size = in_data->size;
462 out_data->data = realloc(out_data->data, out_data->size + 1);
463 memcpy(out_data->data, in_data->data, in_data->size);
464 char *d = (char *)out_data->data;
465 d[out_data->size] = 0;
467 // please excuse my friend, he isn't null terminated
468 // printf("\033[32m\033[1mConfig entry: %s -> %s\033[0m\n", (char *)out_key->data, (char *)out_data->data+strlen(out_data->data)+1);
473 // For obsolete databases, zero all the output
474 void zero_function(int which_cdb, DBT *in_key, DBT *in_data) {
475 //printf("Table %02x, keylen=%d, datalen=%d\n", which_cdb, in_key->size, in_data->size);
479 void (*export_functions[])(int which_cdb, DBT *in_key, DBT *in_data) = {
480 export_msgmain, // CDB_MSGMAIN
481 export_user, // CDB_USERS
482 export_room, // CDB_ROOMS
483 export_floor, // CDB_FLOORTAB
484 zero_function, // CDB_MSGLISTS
485 zero_function, // CDB_VISIT
486 zero_function, // CDB_DIRECTORY
487 zero_function, // CDB_USETABLE
488 zero_function, // CDB_BIGMSGS
489 zero_function, // CDB_FULLTEXT
490 zero_function, // CDB_EUIDINDEX
491 zero_function, // CDB_USERSBYNUMBER
492 zero_function, // CDB_UNUSED1 (obsolete)
493 zero_function // CDB_CONFIG
497 void export_table(int which_cdb, DB_ENV *src_dbenv) {
503 // shamelessly swiped from https://docs.oracle.com/database/bdb181/html/programmer_reference/am_cursor.html
506 DBT in_key, in_data, uncomp_data;
507 int num_good_rows = 0;
508 int num_bad_rows = 0;
510 snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", which_cdb);
512 // create a database handle for the source table
513 ret = db_create(&src_dbp, src_dbenv, 0);
515 fprintf(stderr, "db: db_create: %s\n", db_strerror(ret));
516 fprintf(stderr, "db: exit code %d\n", ret);
520 // open the file containing the source table
521 ret = src_dbp->open(src_dbp, NULL, dbfilename, NULL, DB_BTREE, 0, 0600);
523 fprintf(stderr, "db: db_open: %s\n", db_strerror(ret));
524 fprintf(stderr, "db: exit code %d\n", ret);
528 // Acquire a cursor to read the source table
529 if ((ret = src_dbp->cursor(src_dbp, NULL, &src_dbcp, 0)) != 0) {
530 fprintf(stderr, "db: db_cursor: %s\n", db_strerror(ret));
531 fprintf(stderr, "db: exit code %d\n", ret);
535 // Zero out these database keys
536 memset(&in_key, 0, sizeof(DBT)); // input
537 memset(&in_data, 0, sizeof(DBT));
538 memset(&uncomp_data, 0, sizeof(DBT)); // decompressed input (the key doesn't change)
540 // Walk through the database, calling export functions as we go and clearing buffers before each call.
541 while (ret = src_dbcp->get(src_dbcp, &in_key, &in_data, DB_NEXT) == 0) {
543 // If either the key or data are zero length, skip this record
544 if ((in_key.size == 0) || (in_data.size == 0)) {
548 else { // Both key and data are >0 length so we're good to go
550 // Do we need to decompress?
551 static int32_t magic = COMPRESS_MAGIC;
553 if ( (in_data.size >= sizeof(struct CtdlCompressHeader)) && (!memcmp(in_data.data, &magic, sizeof(magic))) ) {
555 // yes, we need to decompress
557 struct CtdlCompressHeader comp;
558 memcpy(&comp, in_data.data, sizeof(struct CtdlCompressHeader));
559 uncomp_data.size = comp.uncompressed_len;
560 uncomp_data.data = realloc(uncomp_data.data, uncomp_data.size);
561 destLen = (uLongf)comp.uncompressed_len;
563 ret = uncompress((Bytef *)uncomp_data.data, (uLongf *)&destLen, (const Bytef *)in_data.data+sizeof(struct CtdlCompressHeader), (uLong)comp.compressed_len);
565 fprintf(stderr, "db: uncompress() error %d\n", ret);
570 // Call the export function registered to this table
571 export_functions[which_cdb](which_cdb, &in_key, (compressed ? &uncomp_data : &in_data));
573 // Knowing the total number of rows isn't critical to the program. It's just for the user to know.
578 // free any leftover out_data pointers
579 free(uncomp_data.data);
581 // ...and close the database (table)
582 ret = src_dbp->close(src_dbp, 0);
584 fprintf(stderr, "db: db_close: %s\n", db_strerror(ret));
591 int main(int argc, char **argv) {
593 char *src_dir = NULL;
594 char *dst_dir = NULL;
596 static DB_ENV *src_dbenv; // Source DB environment (global)
598 // Parse command line
600 while ((a = getopt(argc, argv, "h:d:y")) != EOF) {
612 fprintf(stderr, "%s: usage: %s -s source_dir -d dest_dir\n", argv[0], argv[0]);
618 fprintf(stderr, "------------------------------------------------------------------------\n");
619 fprintf(stderr, "This utility must be run while the server is OFFLINE. \n");
620 fprintf(stderr, "We \033[1mguarantee\033[0m data corruption if you do not \n");
621 fprintf(stderr, "observe this warning! The source [-s] directory should contain a copy \n");
622 fprintf(stderr, "of the database from your source system. The dump [-d] directory \n");
623 fprintf(stderr, "should be empty and will receive your dump file. \n");
624 fprintf(stderr, "------------------------------------------------------------------------\n");
625 fprintf(stderr, " Source (database) directory: %s\n", src_dir);
626 fprintf(stderr, "------------------------------------------------------------------------\n");
628 if (confirmed == 1) {
629 fprintf(stderr, "You have specified the [-y] flag, so processing will continue.\n");
632 fprintf(stderr, "Please read [ https://www.citadel.org/ctdldump.html ] to learn how to proceed.\n");
636 src_dbenv = open_dbenv(src_dir);
637 for (i = 0; i < MAXCDB; ++i) {
638 export_table(i, src_dbenv);
640 close_dbenv(src_dbenv);