1 // Load (restore) the Citadel database from a flat file created by ctdldump
3 // Copyright (c) 2023-2024 by citadel.org (Art Cancro et al.)
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>
23 #include <libcitadel.h>
25 #include "../server/sysdep.h"
26 #include "../server/citadel_defs.h"
27 #include "../server/server.h"
28 #include "../server/makeuserkey.h"
29 #include "../server/citadel_dirs.h"
30 #include "../server/database.h"
34 // Wrapper for realloc() that crashes and burns if the call fails.
35 void *reallok(void *ptr, size_t size) {
36 void *p = realloc(ptr, size);
38 fprintf(stderr, "realloc() failed to resize %p to %ld bytes, error: %m\n", ptr, size);
45 // Convert a "msgtext" record to a message on disk. NOT THREADSAFE
46 // This also works for "bigmsg" records.
47 int import_msgtext(char *line, struct cdbkeyval *kv) {
49 static char *b64_decoded_msg = NULL;
50 static size_t b64_decoded_alloc = 0;
54 token = strtok(line, "|");
55 msgnum = atol(strtok(NULL, "|"));
56 token = strtok(NULL, "|");
58 // The record key will be the message number
59 kv->key.len = sizeof(long);
60 kv->key.ptr = reallok(kv->key.ptr, kv->key.len);
61 memcpy(kv->key.ptr, &msgnum, kv->key.len);
63 // The record data will be the decoded message text.
64 // We are allocating more memory than we need, but BDB will only write the number of bytes we tell it to.
65 kv->val.ptr = (char *) reallok(kv->val.ptr, strlen(token));
66 kv->val.len = CtdlDecodeBase64(kv->val.ptr, token, strlen(token));
71 // Convert a "msgmeta" record to a message metadata record on disk. NOT THREADSAFE
72 int import_msgmeta(char *line, struct cdbkeyval *kv) {
76 m = malloc(sizeof(struct MetaData));
78 fprintf(stderr, "import_msgmeta: malloc: %s\n", strerror(errno));
81 memset(m, 0, sizeof(struct MetaData));
84 for (int i=0; (token = strsep(&p, "|")); ++i) {
87 m->meta_msgnum = atol(token);
90 m->meta_refcount = atoi(token);
93 strncpy(m->meta_content_type, token, sizeof(m->meta_content_type));
96 m->meta_rfc822_length = atol(token);
101 // metadata records are stored in the CDB_MSGMAIN table,
102 // but with the index being the *negative* of the message number.
103 long index = 0 - m->meta_msgnum;
104 kv->key.len = sizeof(long);
105 kv->key.ptr = reallok(NULL, kv->key.len);
106 memcpy(kv->key.ptr, &index, kv->key.len);
109 kv->val.len = sizeof(struct MetaData);
110 kv->val.ptr = (char *) m; // out_data owns this memory now
116 // Convert a "user" record to a record on disk. (Source string is unusable after this function is called.)
117 int import_user(char *line, struct cdbkeyval *kv) {
118 char userkey[USERNAME_SIZE];
122 u = malloc(sizeof(struct ctdluser));
124 fprintf(stderr, "malloc failed\n");
127 memset(u, 0, sizeof(struct ctdluser));
130 for (int i=0; (token = strsep(&p, "|")); ++i) {
133 u->version = atoi(token);
136 u->uid = atoi(token);
139 safestrncpy(u->password, token, sizeof(u->password));
142 u->flags = atoi(token);
145 u->axlevel = atoi(token);
148 u->usernum = atol(token);
151 u->lastcall = atol(token);
154 u->USuserpurge = atoi(token);
157 safestrncpy(u->fullname, token, sizeof(u->fullname));
160 u->msgnum_bio = atol(token);
163 u->msgnum_pic = atol(token);
167 dlen = CtdlDecodeBase64(token, token, strlen(token)); // Decode in place
168 if (dlen >= sizeof(u->emailaddrs)) {
169 dlen = sizeof(u->emailaddrs) - 1;
171 memcpy(u->emailaddrs, token, dlen);
172 u->emailaddrs[dlen] = 0;
175 u->msgnum_inboxrules = atol(token);
178 u->lastproc_inboxrules = atol(token);
183 // reject any user records without names
184 if (strlen(u->fullname) == 0) {
190 makeuserkey(userkey, u->fullname);
191 kv->key.len = strlen(userkey);
192 kv->key.ptr = strdup(userkey);
193 kv->val.len = sizeof(struct ctdluser);
194 kv->val.ptr = (char *) u;
199 // Convert a "room" record to a record on disk. (Source string is unusable after this function is called.)
200 int import_room(char *line, struct cdbkeyval *kv) {
204 r = malloc(sizeof(struct ctdlroom));
206 fprintf(stderr, "import_room: malloc: %s\n", strerror(errno));
209 memset(r, 0, sizeof(struct ctdlroom));
212 for (int i=0; (token = strsep(&p, "|")); ++i) {
215 strncpy(r->QRname, token, sizeof(r->QRname));
218 strncpy(r->QRpasswd, token, sizeof (r->QRpasswd));
221 r->QRroomaide = atol(token);
224 r->QRhighest = atol(token);
227 r->QRgen = atol(token);
230 r->QRflags = atoi(token);
233 strncpy(r->QRdirname, token, sizeof(r->QRdirname));
236 r->msgnum_info = atol(token);
239 r->QRfloor = atoi(token);
242 r->QRmtime = atol(token);
245 r->QRep.expire_mode = atoi(token);
248 r->QRep.expire_value = atoi(token);
251 r->QRnumber = atol(token);
254 r->QRorder = atoi(token);
257 r->QRflags2 = atoi(token);
260 r->QRdefaultview = atoi(token);
263 r->msgnum_pic = atol(token);
268 // The key is the room name in all lower case
269 kv->key.len = strlen(r->QRname);
270 kv->key.ptr = strdup(r->QRname);
271 char *k = (char *)kv->key.ptr;
272 for (int i=0; i<=kv->key.len; ++i) {
273 k[i] = tolower(k[i]);
276 kv->val.len = sizeof(struct ctdlroom);
277 kv->val.ptr = (char *) r;
282 // Convert a floor record to a record on disk.
283 int import_floor(char *line, struct cdbkeyval *kv) {
288 f = malloc(sizeof(struct floor));
290 fprintf(stderr, "import_floor: malloc: %s\n", strerror(errno));
293 memset(f, 0, sizeof(struct floor));
296 for (int i=0; (token = strsep(&p, "|")); ++i) {
299 floor_num = atoi(token);
302 f->f_flags = atoi(token);
305 strncpy(f->f_name, token, sizeof(f->f_name));
308 f->f_ref_count = atoi(token);
311 f->f_ep.expire_mode = atoi(token);
314 f->f_ep.expire_value = atoi(token);
319 kv->key.len = sizeof(int);
320 kv->key.ptr = malloc(kv->key.len);
321 memcpy(kv->key.ptr, &floor_num, kv->key.len);
323 kv->val.len = sizeof(struct floor);
324 kv->val.ptr = (char *) f;
329 // Import a msglist record
330 // msglist|26|32,33,34,35,36,37,38,39,40,41,42,43,44,45,46,47,48,49,50,51|
331 int import_msglist(char *line, struct cdbkeyval *kv) {
333 char *token, *mtoken;
337 long *msglist = NULL;
339 for (int i=0; (token = strsep(&p, "|")); ++i) {
342 roomnum = atol(token);
346 for (int j=0; (mtoken = strsep(&q, ",")); ++j) {
347 msglist = realloc(msglist, (num_msgs+1) * sizeof(long));
348 msglist[num_msgs++] = atol(mtoken);
354 kv->key.len = sizeof(long);
355 kv->key.ptr = malloc(kv->key.len);
356 memcpy(kv->key.ptr, &roomnum, kv->key.len);
358 kv->val.len = num_msgs * sizeof(long);
359 kv->val.ptr = (char *) msglist;
365 // Convert a "visit" record to a record on disk.
366 int import_visit(char *line, struct cdbkeyval *kv) {
370 v = malloc(sizeof(struct visit));
372 fprintf(stderr, "import_visit: malloc: %s\n", strerror(errno));
375 memset(v, 0, sizeof(struct visit));
378 for (int i=0; (token = strsep(&p, "|")); ++i) {
381 v->v_roomnum = atol(token);
384 v->v_roomgen = atol(token);
387 v->v_usernum = atol(token);
390 v->v_lastseen = atoi(token);
393 v->v_flags = atoi(token);
396 strncpy(v->v_seen, token, sizeof(v->v_seen));
399 strncpy(v->v_answered, token, sizeof(v->v_answered));
402 v->v_view = atoi(token);
407 // The key is the same as the first three data members (3 x long)
408 kv->key.len = sizeof(long) * 3;
409 kv->key.ptr = reallok(NULL, kv->key.len);
410 memcpy(kv->key.ptr, v, kv->key.len);
412 kv->val.len = sizeof(struct visit);
413 kv->val.ptr = (char *) v;
418 // Convert a "dir" record to a record on disk.
419 int import_dir(char *line, struct cdbkeyval *kv) {
421 char username[USERNAME_SIZE];
425 for (int i=0; (token = strsep(&p, "|")); ++i) {
428 strncpy(dirkey, token, sizeof(dirkey));
431 strncpy(username, token, sizeof(username));
436 kv->key.len = strlen(dirkey);
437 kv->key.ptr = reallok(NULL, kv->key.len);
438 memcpy(kv->key.ptr, dirkey, strlen(dirkey));
440 kv->val.len = strlen(username) + 1;
441 kv->val.ptr = strdup(username);
447 // Convert a "usetable" record to a record on disk.
448 int import_usetable(char *line, struct cdbkeyval *kv) {
452 u = malloc(sizeof(struct UseTable));
454 fprintf(stderr, "import_usetable: malloc: %s\n", strerror(errno));
457 memset(u, 0, sizeof(struct UseTable));
460 for (int i=0; (token = strsep(&p, "|")); ++i) {
463 u->hash = atoi(token);
466 u->timestamp = atol(token);
471 // the key is just an int (the hash)
472 kv->key.len = sizeof(int);
473 kv->key.ptr = reallok(NULL, kv->key.len);
474 memcpy(kv->key.ptr, &u->hash, kv->key.len);
476 kv->val.len = sizeof(struct UseTable);
477 kv->val.ptr = (char *) u;
482 // Import a full text search index record.
483 // It's just like a msglists record: a key and a list of message numbers, but the key is "int" instead of "long"
484 int import_fulltext(char *line, struct cdbkeyval *kv) {
486 char *token, *mtoken;
490 long *msglist = NULL;
492 for (int i=0; (token = strsep(&p, "|")); ++i) {
495 indexnum = atoi(token);
499 for (int j=0; (mtoken = strsep(&q, ",")); ++j) {
500 msglist = realloc(msglist, (num_msgs+1) * sizeof(long));
501 msglist[num_msgs++] = atol(mtoken);
507 kv->key.len = sizeof(int);
508 kv->key.ptr = malloc(kv->key.len);
509 memcpy(kv->key.ptr, &indexnum, kv->key.len);
511 kv->val.len = num_msgs * sizeof(long);
512 kv->val.ptr = (char *) msglist;
518 // Import an EUID Index record
519 // euidindex|msgnum|roomnum|euid|
520 int import_euidindex(char *line, struct cdbkeyval *kv) {
527 for (int i=0; (token = strsep(&p, "|")); ++i) {
530 msgnum = atol(token);
533 roomnum = atol(token);
536 strncpy(euid, token, sizeof(euid));
541 // The structure of an euidindex record *key* is:
542 // |----room_number----|----------EUID-------------|
543 // (sizeof long) (actual length of euid)
544 kv->key.len = sizeof(long) + strlen(euid) + 1;
545 kv->key.ptr = reallok(NULL, kv->key.len);
546 memcpy(kv->key.ptr, &roomnum, sizeof(long));
547 strcpy(kv->key.ptr + sizeof(long), euid);
549 // The structure of an euidindex record *value* is:
550 // |-----msg_number----|----room_number----|----------EUID-------------|
551 // (sizeof long) (sizeof long) (actual length of euid)
552 kv->val.len = sizeof(long) + sizeof(long) + strlen(euid) + 1;
553 kv->val.ptr = (char *) reallok(NULL, kv->val.len);
554 memcpy(kv->val.ptr, &msgnum, sizeof(long));
555 memcpy(kv->val.ptr + sizeof(long), &roomnum, sizeof(long));
556 strcpy(kv->val.ptr + sizeof(long) + sizeof(long), euid);
562 // Import a "users by number" (secondary index) record
563 // The key is a "long"
564 int import_usersbynumber(char *line, struct cdbkeyval *kv) {
569 for (int i=0; (token = strsep(&p, "|")); ++i) {
572 usernum = atol(token);
575 kv->key.len = sizeof(long);
576 kv->key.ptr = reallok(NULL, sizeof(long));
577 memcpy(kv->key.ptr, &usernum, kv->key.len);
578 kv->val.ptr = (char *) strdup(token);
579 kv->val.len = strlen(kv->val.ptr) + 1;
584 return(0); // should never get here unless it's a bad record
588 // Import a config record
589 // The key is the config key
590 // The data is the config key, a null, the value, and another null
591 int import_config(char *line, struct cdbkeyval *kv) {
596 for (int i=0; (token = strsep(&p, "|")); ++i) {
600 kv->key.len = strlen(token);
601 kv->key.ptr = strdup(token);
605 kv->val.len = strlen(k) + strlen(v) + 2;
606 kv->val.ptr = (char *) reallok(NULL, kv->val.len);
607 strcpy(kv->val.ptr, k);
608 strcpy(kv->val.ptr + strlen(k) + 1, v);
617 // Ingest one line of dump data. NOT REENTRANT
618 void ingest_one(char *line, struct cdbkeyval *kv) {
620 static int good_rows = 0;
621 static int bad_rows = 0;
622 static int current_cdb = -1 ;
623 char record_type[32];
626 // Clear out our record buffer
627 memset(kv, 0, sizeof(struct cdbkeyval));
630 // Identify the record type we are currently working with,
631 // then call the correct conversion function to load up our record buffer.
632 extract_token(record_type, line, 0, '|', sizeof record_type);
633 if (!strcasecmp(record_type, "msgtext")) {
634 current_cdb = CDB_MSGMAIN;
635 row_was_good = import_msgtext(line, kv);
637 else if (!strcasecmp(record_type, "msgmeta")) {
638 current_cdb = CDB_MSGMAIN;
639 row_was_good = import_msgmeta(line, kv);
641 else if (!strcasecmp(record_type, "user")) {
642 current_cdb = CDB_USERS;
643 row_was_good = import_user(line, kv);
645 else if (!strcasecmp(record_type, "room")) {
646 current_cdb = CDB_ROOMS;
647 row_was_good = import_room(line, kv);
649 else if (!strcasecmp(record_type, "floor")) {
650 current_cdb = CDB_FLOORTAB;
651 row_was_good = import_floor(line, kv);
653 else if (!strcasecmp(record_type, "msglist")) {
654 current_cdb = CDB_MSGLISTS;
655 row_was_good = import_msglist(line, kv);
657 else if (!strcasecmp(record_type, "visit")) {
658 current_cdb = CDB_VISIT;
659 row_was_good = import_visit(line, kv);
661 else if (!strcasecmp(record_type, "dir")) {
662 current_cdb = CDB_DIRECTORY;
663 row_was_good = import_dir(line, kv);
665 else if (!strcasecmp(record_type, "use")) {
666 current_cdb = CDB_USETABLE;
667 row_was_good = import_usetable(line, kv);
669 else if (!strcasecmp(record_type, "bigmsg")) {
670 current_cdb = CDB_BIGMSGS;
671 row_was_good = import_msgtext(line, kv);
673 else if (!strcasecmp(record_type, "fulltext")) {
674 current_cdb = CDB_FULLTEXT;
675 row_was_good = import_fulltext(line, kv);
677 else if (!strcasecmp(record_type, "euidindex")) {
678 current_cdb = CDB_EUIDINDEX;
679 row_was_good = import_euidindex(line, kv);
681 else if (!strcasecmp(record_type, "usersbynumber")) {
682 current_cdb = CDB_USERSBYNUMBER;
683 row_was_good = import_usersbynumber(line, kv);
685 else if (!strcasecmp(record_type, "config")) {
686 current_cdb = CDB_CONFIG;
687 row_was_good = import_config(line, kv);
693 // If the conversion function was successful, write the record to the database.
694 if ( (row_was_good) && (current_cdb >= 0) ) {
695 cdb_store(current_cdb, kv->key.ptr, kv->key.len, kv->val.ptr, kv->val.len);
702 fprintf(stderr, "\r \033[32m%9d\033[0m / \033[31m%8d\033[0m ", good_rows, bad_rows);
708 // This is the loop that loads the dump data. NOT REENTRANT
710 static size_t line_alloc = 1;
712 static size_t line_len = 0;
718 memset(&kv, 0, sizeof(struct cdbkeyval));
720 line = reallok(NULL, line_alloc);
725 while (ch = getc(stdin), ((ch != '\n') && (ch > 0))) {
726 if ((line_len+2) > line_alloc) {
728 line = reallok(line, line_alloc);
730 line[line_len++] = ch;
739 if ( (begin_found) && (!end_found) ) {
740 ingest_one(line, &kv);
742 if (!strncasecmp(line, HKEY("begin|"))) {
744 fprintf(stderr, " good rows / bad rows:\n");
746 if (!strncasecmp(line, HKEY("end|"))) {
747 fprintf(stderr, "\n");
755 fprintf(stderr, "\033[31mWARNING: \"begin\" line was not found in the loaded data.\033[0m\n");
758 fprintf(stderr, "\033[31mWARNING: \"end\" line was not found in the loaded data.\033[0m\n");
764 int main(int argc, char **argv) {
766 char *ctdldir = CTDLDIR;
768 // display the greeting
770 "\033[44m\033[1m╔════════════════════════════════════════════════════════════════════════╗\033[0m\n"
771 "\033[44m\033[1m║ DB Load utility for Citadel version %-4d ║\033[0m\n"
772 "\033[44m\033[1m║ Copyright (c) 2023-2024 by citadel.org et al. ║\033[0m\n"
773 "\033[44m\033[1m║ This program is open source software. Use, duplication, or disclosure ║\033[0m\n"
774 "\033[44m\033[1m║ is subject to the terms of the GNU General Public license v3. ║\033[0m\n"
775 "\033[44m\033[1m╚════════════════════════════════════════════════════════════════════════╝\033[0m\n",
779 // Parse command line
781 while ((a = getopt(argc, argv, "h:y")) != EOF) {
790 fprintf(stderr, "%s: usage: %s -h citadel_dir [<dumpfile]\n", argv[0], argv[0]);
795 if (confirmed == 1) {
796 fprintf(stderr, "ctdlload: You have specified the [-y] flag, so processing will continue.\n");
799 fprintf(stderr, "ctdlload: usage: ctdlload -y -h[citadel_dir] <[dump_file]\n");
800 fprintf(stderr, " -y : yes, I know this program can do damage and I want to run it anyway.\n");
801 fprintf(stderr, " -h : [citadel_dir] is your server directory, usually /usr/local/citadel\n");
802 fprintf(stderr, " Please read [ https://www.citadel.org/dump-and-load.html ] to learn how to proceed.\n");
806 if (chdir(ctdldir) != 0) {
807 fprintf(stderr, "ctdlload: unable to change directory to [%s]: %m", ctdldir);
811 // backend modules use syslog -- redirect to stderr
812 openlog("ctdlload", LOG_PERROR , LOG_DAEMON);
814 // Remove any database that is already in the target directory (yes, delete it, be careful)
815 system("rm -fv ./data/*");
817 // initialize the database backend
819 cdb_open_databases();
821 // Load rows from the input source
825 cdb_close_databases();
827 fprintf(stderr, "ctdlload: \033[32m\033[1mfinished\033[0m\n");