citadel/utils/ctdldump.c

   1 // Don't run this.  It doesn't work and if you try to run it you will immediately die.
   2 //
   3 // Copyright (c) 2023 by Art Cancro citadel.org
   4 //
   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.
   7
   8 #include <stdlib.h>
   9 #include <unistd.h>
  10 #include <ctype.h>
  11 #include <stdio.h>
  12 #include <signal.h>
  13 #include <sys/types.h>
  14 #include <sys/socket.h>
  15 #include <sys/un.h>
  16 #include <netdb.h>
  17 #include <string.h>
  18 #include <pwd.h>
  19 #include <errno.h>
  20 #include <stdarg.h>
  21 #include <limits.h>
  22 #include <libcitadel.h>
  23 #include <zlib.h>
  24 #include <db.h>
  25 #include "../server/sysdep.h"
  26 #include "../server/citadel_defs.h"
  27 #include "../server/server.h"
  28 #include "../server/citadel_dirs.h"
  29
  30
  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);
  34         if (!p) {
  35                 fprintf(stderr, "realloc() failed to resize %p to %ld bytes, error: %m\n", ptr, size);
  36                 abort();
  37         }
  38         return p;
  39 }
  40
  41
  42 // convert a binary blob to base64 (non-reentrant!)
  43 char *b64out(void *data, size_t len) {
  44         static char *outbuf = NULL;
  45         static size_t outlen = 0;
  46
  47         if ((outbuf == NULL) || (outlen < (len * 2))) {
  48                 outbuf = reallok(outbuf, (len * 2));
  49                 outlen = len * 2;
  50         }
  51
  52         CtdlEncodeBase64(outbuf, data, len, 0);
  53         return(outbuf);
  54 }
  55
  56
  57 // Open a database environment
  58 DB_ENV *open_dbenv(char *dirname) {
  59
  60         DB_ENV *dbenv = NULL;
  61
  62         int ret;
  63         int i;
  64         u_int32_t flags = 0;
  65         int dbversion_major, dbversion_minor, dbversion_patch;
  66
  67         db_version(&dbversion_major, &dbversion_minor, &dbversion_patch);
  68
  69         // Create synthetic integer version numbers and compare them.
  70         // Never run with a libdb other than the one with which it was compiled.
  71         int compiled_db_version = ( (DB_VERSION_MAJOR * 1000000) + (DB_VERSION_MINOR * 1000) + (DB_VERSION_PATCH) );
  72         int linked_db_version = ( (dbversion_major * 1000000) + (dbversion_minor * 1000) + (dbversion_patch) );
  73         if (compiled_db_version != linked_db_version) {
  74                 fprintf(stderr, "ctdldump: ctdldump is running with a version of libdb other than the one with which it was compiled.\n"
  75                         "ctdldump: This is an invalid configuration.  ctdldump will now exit to prevent data loss.");
  76                 exit(CTDLEXIT_DB);
  77         }
  78
  79         ret = db_env_create(&dbenv, 0);
  80         if (ret) {
  81                 fprintf(stderr, "ctdldump: db_env_create: %s\n", db_strerror(ret));
  82                 fprintf(stderr, "ctdldump: exit code %d\n", ret);
  83                 exit(CTDLEXIT_DB);
  84         }
  85
  86         // We want to specify the shared memory buffer pool cachesize, but everything else is the default.
  87         ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
  88         if (ret) {
  89                 fprintf(stderr, "ctdldump: set_cachesize: %s\n", db_strerror(ret));
  90                 dbenv->close(dbenv, 0);
  91                 fprintf(stderr, "ctdldump: exit code %d\n", ret);
  92                 exit(CTDLEXIT_DB);
  93         }
  94
  95         if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
  96                 fprintf(stderr, "ctdldump: set_lk_detect: %s\n", db_strerror(ret));
  97                 dbenv->close(dbenv, 0);
  98                 fprintf(stderr, "ctdldump: exit code %d\n", ret);
  99                 exit(CTDLEXIT_DB);
 100         }
 101
 102         flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_LOG;
 103         ret = dbenv->open(dbenv, dirname, flags, 0);
 104         if (ret) {
 105                 fprintf(stderr, "ctdldump: dbenv->open: %s\n", db_strerror(ret));
 106                 dbenv->close(dbenv, 0);
 107                 fprintf(stderr, "ctdldump: exit code %d\n", ret);
 108                 exit(CTDLEXIT_DB);
 109         }
 110
 111         return(dbenv);
 112 }
 113
 114
 115 void close_dbenv(DB_ENV *dbenv) {
 116         int ret = dbenv->close(dbenv, 0);
 117         if (ret) {
 118                 fprintf(stderr, "ctdldump: dbenv->close: %s\n", db_strerror(ret));
 119         }
 120 }
 121
 122
 123 // export function for a message in msgmain
 124 void export_msgmain(int which_cdb, DBT *in_key, DBT *in_data) {
 125         long in_msgnum;
 126
 127         memcpy(&in_msgnum, in_key->data, sizeof(in_msgnum));
 128
 129         // If the msgnum is negative, we are looking at METADATA
 130         if (in_msgnum < 0) {
 131                 struct MetaData *meta = (struct MetaData *)in_data->data;
 132                 printf("msgmeta|%ld|%d|%s|%ld|\n",
 133                         meta->meta_msgnum,
 134                         meta->meta_refcount,
 135                         meta->meta_content_type,
 136                         meta->meta_rfc822_length
 137                 );
 138         }
 139
 140         // If the msgnum is positive, we are looking at a MESSAGE
 141         else if (in_msgnum > 0) {
 142                 printf("msgtext|%ld|%s|\n", in_msgnum, b64out(in_data->data, in_data->size));
 143         }
 144
 145         // If the msgnum is 0 it's probably not a valid record.
 146 }
 147
 148
 149 // export function for a user record
 150 void export_user(int which_cdb, DBT *in_key, DBT *in_data) {
 151
 152         struct ctdluser *user = (struct ctdluser *)in_data->data;
 153
 154         printf("user|%d|%d|%s|%u|%d|%ld|%ld|%d|%s|%ld|%ld|%s|%ld|%ld|\n",
 155                 user->version,
 156                 user->uid,
 157                 user->password,
 158                 user->flags,
 159                 user->axlevel,
 160                 user->usernum,
 161                 user->lastcall,
 162                 user->USuserpurge,
 163                 user->fullname,
 164                 user->msgnum_bio,
 165                 user->msgnum_pic,
 166                 b64out(user->emailaddrs, strlen(user->emailaddrs)),
 167                 user->msgnum_inboxrules,
 168                 user->lastproc_inboxrules
 169         );
 170 }
 171
 172
 173 // export function for a room record
 174 void export_room(int which_cdb, DBT *in_key, DBT *in_data) {
 175
 176         struct ctdlroom *room = (struct ctdlroom *)in_data->data;
 177
 178         printf("room|%s|%s|%ld|%ld|%ld|%u|%s|%ld|%d|%ld|%d|%d|%ld|%d|%u|%d|%ld|\n",
 179                 room->QRname,
 180                 room->QRpasswd,
 181                 room->QRroomaide,
 182                 room->QRhighest,
 183                 room->QRgen,
 184                 room->QRflags,
 185                 room->QRdirname,
 186                 room->msgnum_info,
 187                 room->QRfloor,
 188                 room->QRmtime,
 189                 room->QRep.expire_mode,
 190                 room->QRep.expire_value,
 191                 room->QRnumber,
 192                 room->QRorder,
 193                 room->QRflags2,
 194                 room->QRdefaultview,
 195                 room->msgnum_pic
 196         );
 197 }
 198
 199
 200 // export function for a floor record
 201 void export_floor(int which_cdb, DBT *in_key, DBT *in_data) {
 202
 203         int floor_num;
 204         memcpy(&floor_num, in_key->data, sizeof(int));
 205
 206         struct floor *floor = (struct floor *)in_data->data;
 207
 208         printf("floor|%d|%u|%s|%d|%d|%d|\n",
 209                 floor_num,
 210                 floor->f_flags,
 211                 floor->f_name,
 212                 floor->f_ref_count,
 213                 floor->f_ep.expire_mode,
 214                 floor->f_ep.expire_value
 215         );
 216 }
 217
 218
 219 // export function for a msglist or a fulltext index record
 220 // (both are indexed by a long and the data is arrays of longs)
 221 void export_msglist(int which_cdb, DBT *in_key, DBT *in_data) {
 222         int i;
 223         int num_msgs;
 224         long msg;
 225
 226         // records are indexed by a single "long" and contains an array of zero or more "long"s
 227         long roomnum;
 228         memcpy(&roomnum, in_key->data, sizeof(long));
 229
 230         printf("msglist|%ld|", roomnum);
 231
 232         if (in_data->size > 0) {
 233                 num_msgs = in_data->size / sizeof(long);
 234                 for (i=0; i<num_msgs; ++i) {
 235                         memcpy(&msg, (in_data->data + (i * sizeof(long))), sizeof(long));
 236                         if (i != 0) {
 237                                 printf(",");
 238                         }
 239                         printf("%ld", msg);
 240                 }
 241         }
 242         printf("|\n");
 243 }
 244
 245
 246 // export function for a visit record
 247 void export_visit(int which_cdb, DBT *in_key, DBT *in_data) {
 248         struct visit *visit = (struct visit *)in_data->data;
 249         printf("visit|%ld|%ld|%ld|%ld|%u|%s|%s|%d|\n",
 250                 visit->v_roomnum,
 251                 visit->v_roomgen,
 252                 visit->v_usernum,
 253                 visit->v_lastseen,
 254                 visit->v_flags,
 255                 visit->v_seen,
 256                 visit->v_answered,
 257                 visit->v_view
 258         );
 259 }
 260
 261
 262 // export function for a directory record
 263 // (This is a secondary index -- should we just regenerate the data after import?)
 264 // void export_dir(int which_cdb, DBT *in_key, DBT *in_data) {
 265         // printf("dir|");
 266         // fwrite(in_key->data, in_key->size, 1, stdout);
 267         // printf("|%s|\n", (char *)in_data->data);
 268 // }
 269
 270
 271 // export function for a use table record
 272 void export_usetable(int which_cdb, DBT *in_key, DBT *in_data) {
 273         struct UseTable *u = (struct UseTable *)in_data->data;
 274         printf("use|%d|%ld|\n", u->hash, u->timestamp);
 275 }
 276
 277
 278 // export function for large message texts
 279 void export_bigmsg(int which_cdb, DBT *in_key, DBT *in_data) {
 280         long msgnum;
 281
 282         memcpy(&msgnum, in_key->data, sizeof(msgnum));
 283         printf("bigmsg|%ld|%s|\n", msgnum, b64out(in_data->data, in_data->size));
 284 }
 285
 286
 287 // export function for EUID Index records
 288 //void export_euidindex(int which_cdb, DBT *in_key, DBT *in_data) {
 289
 290         // The structure of an euidindex record *key* is:
 291         // |----room_number----|----------EUID-------------|
 292         //    (sizeof long)       (actual length of euid)
 293
 294         // The structure of an euidindex record *value* is:
 295         // |-----msg_number----|----room_number----|----------EUID-------------|
 296         //    (sizeof long)       (sizeof long)       (actual length of euid)
 297
 298         //long msgnum, roomnum;
 299         //char *euid;
 300
 301         //memcpy(&msgnum, in_data->data, sizeof(long));
 302         //memcpy(&roomnum, in_data->data+sizeof(long), sizeof(msgnum));
 303         //euid = in_data->data+(sizeof(long)*2);
 304 //
 305         //printf("euidindex|%ld|%ld|%s|\n", msgnum, roomnum, euid);
 306 //}
 307
 308
 309 // export users-by-number records
 310 // (This is a secondary index -- should we just regenerate the data after import?)
 311 //void export_usersbynumber(int which_cdb, DBT *in_key, DBT *in_data) {
 312
 313         // key is a long
 314         //long usernum;
 315         //memcpy(&usernum, in_key->data, sizeof(usernum));
 316
 317         // value is a string
 318         //printf("usersbynumber|%ld|%s|\n", usernum, (char *)in_data->data);
 319 //}
 320
 321
 322 // export function for a config record
 323 void export_config(int which_cdb, DBT *in_key, DBT *in_data) {
 324
 325         printf("config|%s|%s|\n",
 326                 (char *)in_data->data,
 327                 (char *)in_data->data + strlen(in_data->data) + 1
 328         );
 329
 330 }
 331
 332
 333 // For obsolete databases, zero all the output
 334 void zero_function(int which_cdb, DBT *in_key, DBT *in_data) {
 335         // do nothing
 336 }
 337
 338
 339 void (*export_functions[])(int which_cdb, DBT *in_key, DBT *in_data) = {
 340         export_msgmain,         // CDB_MSGMAIN
 341         export_user,            // CDB_USERS
 342         export_room,            // CDB_ROOMS
 343         export_floor,           // CDB_FLOORTAB
 344         export_msglist,         // CDB_MSGLISTS
 345         export_visit,           // CDB_VISIT
 346         zero_function,          // CDB_DIRECTORY (regenerate this on the server)
 347         export_usetable,        // CDB_USETABLE
 348         export_bigmsg,          // CDB_BIGMSGS
 349         zero_function,          // CDB_FULLTEXT (regenerate this on the server)
 350         zero_function,          // CDB_EUIDINDEX (regenerate this on the server)
 351         zero_function,          // CDB_USERSBYNUMBER (regenerate this on the server)
 352         zero_function,          // CDB_UNUSED1 (obsolete)
 353         export_config           // CDB_CONFIG
 354 };
 355
 356
 357 void export_table(int which_cdb, DB_ENV *src_dbenv) {
 358         int ret;
 359         int compressed;
 360         char dbfilename[32];
 361         uLongf destLen = 0;
 362
 363         // shamelessly swiped from https://docs.oracle.com/database/bdb181/html/programmer_reference/am_cursor.html
 364         DB *src_dbp;
 365         DBC *src_dbcp;
 366         DBT in_key, in_data, uncomp_data;
 367         int num_good_rows = 0;
 368         int num_bad_rows = 0;
 369
 370         snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", which_cdb);
 371
 372         // create a database handle for the source table
 373         ret = db_create(&src_dbp, src_dbenv, 0);
 374         if (ret) {
 375                 fprintf(stderr, "ctdldump: db_create: %s\n", db_strerror(ret));
 376                 fprintf(stderr, "ctdldump: exit code %d\n", ret);
 377                 exit(CTDLEXIT_DB);
 378         }
 379
 380         // open the file containing the source table
 381         ret = src_dbp->open(src_dbp, NULL, dbfilename, NULL, DB_BTREE, 0, 0600);
 382         if (ret) {
 383                 fprintf(stderr, "ctdldump: db_open: %s\n", db_strerror(ret));
 384                 fprintf(stderr, "ctdldump: exit code %d\n", ret);
 385                 exit(CTDLEXIT_DB);
 386         }
 387
 388         // Acquire a cursor to read the source table
 389         if ((ret = src_dbp->cursor(src_dbp, NULL, &src_dbcp, 0)) != 0) {
 390                 fprintf(stderr, "ctdldump: db_cursor: %s\n", db_strerror(ret));
 391                 fprintf(stderr, "ctdldump: exit code %d\n", ret);
 392                 exit(CTDLEXIT_DB);
 393         }
 394
 395         // Zero out these database keys
 396         memset(&in_key,         0, sizeof(DBT));        // input
 397         memset(&in_data,        0, sizeof(DBT));
 398         memset(&uncomp_data,    0, sizeof(DBT));        // decompressed input (the key doesn't change)
 399
 400         // Walk through the database, calling export functions as we go and clearing buffers before each call.
 401         while (ret = src_dbcp->get(src_dbcp, &in_key, &in_data, DB_NEXT) == 0) {
 402
 403                 // If either the key or data are zero length, skip this record
 404                 if ((in_key.size == 0) || (in_data.size == 0)) {
 405                         ++num_bad_rows;
 406                 }
 407
 408                 else {  // Both key and data are >0 length so we're good to go
 409
 410                         // Do we need to decompress?
 411                         static int32_t magic = COMPRESS_MAGIC;
 412                         compressed = 0;
 413                         if ((in_data.size >= sizeof(struct CtdlCompressHeader)) && (!memcmp(in_data.data, &magic, sizeof(magic)))) {
 414
 415                                 // yes, we need to decompress
 416                                 compressed = 1;
 417                                 struct CtdlCompressHeader comp;
 418                                 memcpy(&comp, in_data.data, sizeof(struct CtdlCompressHeader));
 419                                 uncomp_data.size = comp.uncompressed_len;
 420                                 uncomp_data.data = reallok(uncomp_data.data, uncomp_data.size);
 421                                 destLen = (uLongf)comp.uncompressed_len;
 422
 423                                 ret = uncompress((Bytef *)uncomp_data.data, (uLongf *)&destLen,
 424                                                 (const Bytef *)in_data.data+sizeof(struct CtdlCompressHeader),
 425                                                 (uLong)comp.compressed_len);
 426                                 if (ret != Z_OK) {
 427                                         fprintf(stderr, "ctdldump: uncompress() error %d\n", ret);
 428                                         exit(CTDLEXIT_DB);
 429                                 }
 430                         }
 431
 432                         // Call the export function registered to this table
 433                         export_functions[which_cdb](which_cdb, &in_key, (compressed ? &uncomp_data : &in_data));
 434
 435                         // Knowing the total number of rows isn't critical to the program.  It's just for the user to know.
 436                         fflush(stdout);
 437                 }
 438         }
 439
 440         // free any leftover out_data pointers
 441         free(uncomp_data.data);
 442
 443         // ...and close the database (table)
 444         ret = src_dbp->close(src_dbp, 0);
 445         if (ret) {
 446                 fprintf(stderr, "ctdldump: db_close: %s\n", db_strerror(ret));
 447         }
 448
 449
 450 }
 451
 452
 453 int main(int argc, char **argv) {
 454         int i = 0;
 455         char *src_dir = NULL;
 456         char *dst_dir = NULL;
 457         int confirmed = 0;
 458         static DB_ENV *src_dbenv;               // Source DB environment (global)
 459
 460         // display the greeting
 461         fprintf(stderr, "\033[44m\033[30m \033[K\033[0m\n"
 462                         "\033[44m\033[30m DB Dump utility for Citadel \033[K\033[0m\n"
 463                         "\033[44m\033[30m Copyright (c) 2023 by citadel.org et al.  \033[K\033[0m\n"
 464                         "\033[44m\033[30m This program is open source software.  Use, duplication, or disclosure \033[K\033[0m\n"
 465                         "\033[44m\033[30m is subject to the terms of the GNU General Public license v3. \033[K\033[0m\n"
 466                         "\033[44m\033[30m \033[K\033[0m\n");
 467
 468         // Parse command line
 469         int a;
 470         while ((a = getopt(argc, argv, "h:y")) != EOF) {
 471                 switch (a) {
 472                 case 'h':
 473                         src_dir = optarg;
 474                         break;
 475                 case 'y':
 476                         confirmed = 1;
 477                         break;
 478                 default:
 479                         fprintf(stderr, "%s: usage: %s -s source_dir [>dumpfile]\n", argv[0], argv[0]);
 480                         exit(2);
 481                 }
 482         }
 483
 484         if (confirmed == 1) {
 485                 fprintf(stderr, "ctdldump: You have specified the [-y] flag, so processing will continue.\n");
 486         }
 487         else {
 488                 fprintf(stderr, "ctdldump: Please read [ https://www.citadel.org/dump-and-load.html ] to learn how to proceed.\n");
 489                 exit(0);
 490         }
 491
 492         src_dbenv = open_dbenv(src_dir);
 493         printf("begin|\n");
 494         for (i = 0; i < MAXCDB; ++i) {
 495                 export_table(i, src_dbenv);
 496                 if (i == CDB_CONFIG) {
 497                         printf("config|regenerate_secondary_indices|1|\n");             // Force citserver to rebuild those tables
 498                         printf("config|MM_fulltext_wordbreaker|0|\n");                  // Burn the full text search index
 499                 }
 500         }
 501         close_dbenv(src_dbenv);
 502         printf("end|\n");
 503
 504         exit(0);
 505 }