]> code.citadel.org Git - citadel.git/blob - citadel/utils/ctdldump.c
ctdldump: export use table
[citadel.git] / 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                 exit(1);
37         }
38         return p;
39 }
40 #define realloc reallok
41
42
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;
47         int i;
48         char ch;
49
50         if ((outbuf == NULL) || (outlen < (len * 2))) {
51                 outbuf = reallok(outbuf, (len * 2));
52                 outlen = len * 2;
53         }
54
55         for (i=0; i<len; ++i) {
56                 ch = 0;
57                 memcpy(&ch, data+i, 1);
58                 sprintf((outbuf + (i * 2)), "%02X", (int) ch);
59         }
60
61         return(outbuf);
62 }
63
64
65 // Open a database environment
66 DB_ENV *open_dbenv(char *dirname) {
67
68         DB_ENV *dbenv = NULL;
69
70         int ret;
71         int i;
72         u_int32_t flags = 0;
73         int dbversion_major, dbversion_minor, dbversion_patch;
74
75         fprintf(stderr,
76                 "db: open_dbenv() starting\n"
77                 "db:    Linked zlib: %s\n"
78                 "db: Compiled libdb: %s\n"
79                 "db:   Linked libdb: %s\n",
80                 zlibVersion(),
81                 DB_VERSION_STRING,
82                 db_version(&dbversion_major, &dbversion_minor, &dbversion_patch)
83         );
84
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.");
92                 exit(CTDLEXIT_DB);
93         }
94
95         fprintf(stderr, "db: Setting up DB environment\n");
96         ret = db_env_create(&dbenv, 0);
97         if (ret) {
98                 fprintf(stderr, "db: db_env_create: %s\n", db_strerror(ret));
99                 fprintf(stderr, "db: exit code %d\n", ret);
100                 exit(CTDLEXIT_DB);
101         }
102
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);
105         if (ret) {
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);
109                 exit(CTDLEXIT_DB);
110         }
111
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);
116                 exit(CTDLEXIT_DB);
117         }
118
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);
122         if (ret) {
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);
126                 exit(CTDLEXIT_DB);
127         }
128
129         return(dbenv);
130 }
131
132
133 void close_dbenv(DB_ENV *dbenv) {
134         int ret = dbenv->close(dbenv, 0);
135         if (ret) {
136                 fprintf(stderr, "db: dbenv->close: %s\n", db_strerror(ret));
137         }
138 }
139
140
141 // export function for a message in msgmain
142 void export_msgmain(int which_cdb, DBT *in_key, DBT *in_data) {
143         long in_msgnum;
144
145         if (in_key->size != sizeof(long)) {
146                 fprintf(stderr, "\033[31m\033[1m *** BAD DATA *** ABORTING *** \033[0m\n");
147                 abort();
148         }
149
150         memcpy(&in_msgnum, in_key->data, sizeof(in_msgnum));
151
152         // If the msgnum is negative, we are looking at METADATA
153         if (in_msgnum < 0) {
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);
156         }
157
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));
161         }
162
163         // If the msgnum is 0 it's probably not a valid record.
164 }
165
166
167 // export function for a user record
168 void export_user(int which_cdb, DBT *in_key, DBT *in_data) {
169
170         struct ctdluser *user = (struct ctdluser *)in_data->data;
171
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
187         );
188 }
189
190
191 // export function for a room record
192 void export_room(int which_cdb, DBT *in_key, DBT *in_data) {
193
194         struct ctdlroom *room = (struct ctdlroom *)in_data->data;
195
196         printf("room|%s|%s|%ld|%ld|%ld|%u|%s|%ld|%d|%ld|%d|%d|%ld|%d|%u|%d|%ld\n",
197                 room->QRname,
198                 room->QRpasswd,
199                 room->QRroomaide,
200                 room->QRhighest,
201                 room->QRgen,
202                 room->QRflags,
203                 room->QRdirname,
204                 room->msgnum_info,
205                 room->QRfloor,
206                 room->QRmtime,
207                 room->QRep.expire_mode,
208                 room->QRep.expire_value,
209                 room->QRnumber,
210                 room->QRorder,
211                 room->QRflags2,
212                 room->QRdefaultview,
213                 room->msgnum_pic
214         );
215 }
216
217
218 // export function for a floor record
219 void export_floor(int which_cdb, DBT *in_key, DBT *in_data) {
220
221         int floor_num;
222         memcpy(&floor_num, in_key->data, sizeof(int));
223
224         struct floor *floor = (struct floor *)in_data->data;
225
226         printf("floor|%d|%u|%s|%d|%d|%d\n",
227                 floor_num,
228                 floor->f_flags,
229                 floor->f_name,
230                 floor->f_ref_count,
231                 floor->f_ep.expire_mode,
232                 floor->f_ep.expire_value
233         );
234 }
235
236
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) {
240         int i;
241         int num_msgs;
242         long msg;
243
244         // records are indexed by a single "long" and contains an array of zero or more "long"s
245         long roomnum;
246         memcpy(&roomnum, in_key->data, sizeof(long));
247
248         printf("msglist|%ld|", roomnum);
249
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));
254                         if (i != 0) {
255                                 printf(",");
256                         }
257                         printf("%ld", msg);
258                 }
259         }
260         printf("\n");
261 }
262
263
264 // export function for a visit record
265 void export_visit(int which_cdb, DBT *in_key, DBT *in_data) {
266         struct visit *visit = (struct visit *)in_data->data;
267         printf("visit|%ld|%ld|%ld|%ld|%u|%s|%s|%d\n",
268                 visit->v_roomnum,
269                 visit->v_roomgen,
270                 visit->v_usernum,
271                 visit->v_lastseen,
272                 visit->v_flags,
273                 visit->v_seen,
274                 visit->v_answered,
275                 visit->v_view
276         );
277 }
278
279
280 // export function for a directory record
281 // (This is a secondary index -- should we just regenerate the data after import?)
282 void export_dir(int which_cdb, DBT *in_key, DBT *in_data) {
283         printf("dir|");
284         fwrite(in_key->data, in_key->size, 1, stdout);
285         printf("|");
286         fwrite(in_data->data, in_data->size, 1, stdout);
287         printf("\n");
288 }
289
290
291 // export function for a use table record
292 void export_usetable(int which_cdb, DBT *in_key, DBT *in_data) {
293         struct UseTable *u = (struct UseTable *)in_data->data;
294         printf("use|%d|%ld\n", u->hash, u->timestamp);
295 }
296
297
298 #if 0
299 // export function for large message texts
300 void export_bigmsgs(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
301
302         // The key is a packed long
303         int32_t in_msgnum;
304         long out_msgnum;
305         memcpy(&in_msgnum, in_key->data, sizeof(in_msgnum));
306         out_msgnum = (long)in_msgnum;
307
308         if (in_key->size != 4) {
309                 fprintf(stderr, "\033[31m\033[1m *** SOURCE DATABASE IS NOT 32-BIT *** ABORTING *** \033[0m\n");
310                 abort();
311         }
312
313         out_key->size = sizeof(long);
314         out_key->data = realloc(out_key->data, out_key->size);
315         memcpy(out_key->data, &out_msgnum, sizeof(long));
316
317         // the data is binary-ish but has no packed integers
318         out_data->size = in_data->size;
319         out_data->data = realloc(out_data->data, out_data->size);
320         memcpy(out_data->data, in_data->data, in_data->size);
321
322         // printf("\033[32m\033[1mBigmsg %ld , length %d\033[0m\n", out_msgnum, out_data->size);
323 }
324
325
326 // export function for EUID Index records
327 void export_euidindex(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
328
329         // The structure of an euidindex record *key* is:
330         // |----room_number----|----------EUID-------------|
331         //    (sizeof long)       (actual length of euid)
332
333         // The structure of an euidindex record *value* is:
334         // |-----msg_number----|----room_number----|----------EUID-------------|
335         //    (sizeof long)       (sizeof long)       (actual length of euid)
336
337         int32_t in_msgnum = 0;
338         int32_t in_roomnum = 0;
339         char euid[SIZ];
340         long out_msgnum = 0;
341         long out_roomnum = 0;
342
343         memcpy(&in_msgnum, in_data->data, sizeof(in_msgnum));
344         memcpy(&in_roomnum, in_data->data+sizeof(int32_t), sizeof(in_msgnum));
345         strcpy(euid, in_data->data+(sizeof(int32_t)*2));
346
347         out_msgnum = (long) in_msgnum;
348         out_roomnum = (long) in_roomnum;
349         // printf("euidindex: msgnum=%ld, roomnum=%ld, euid=\"%s\"\n", out_msgnum, out_roomnum, euid);
350
351         out_key->size = sizeof(long) + strlen(euid) + 1;
352         out_key->data = realloc(out_key->data, out_key->size);
353         memcpy(out_key->data, &out_roomnum, sizeof(out_roomnum));
354         strcpy(out_key->data+sizeof(out_roomnum), euid);
355
356         out_data->size = sizeof(long) + sizeof(long) + strlen(euid) + 1;
357         out_data->data = realloc(out_data->data, out_data->size);
358         memcpy(out_data->data, &out_msgnum, sizeof(out_msgnum));
359         memcpy(out_data->data+sizeof(out_msgnum), &out_roomnum, sizeof(out_roomnum));
360         strcpy(out_data->data+sizeof(out_msgnum)+sizeof(out_roomnum), euid);
361 }
362
363
364 // convert users-by-number records
365 void export_usersbynumber(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
366
367         // key is a long
368         // and remember ... "long" is int32_t on the source system
369         int32_t in_usernum;
370         long out_usernum;
371         memcpy(&in_usernum, in_key->data, sizeof(in_usernum));
372         out_usernum = (long) in_usernum;
373
374         if (in_key->size != 4) {
375                 fprintf(stderr, "\033[31m\033[1m *** SOURCE DATABASE IS NOT 32-BIT *** ABORTING *** \033[0m\n");
376                 abort();
377         }
378
379         out_key->size = sizeof(out_usernum);
380         out_key->data = realloc(out_key->data, out_key->size);
381         memcpy(out_key->data, &out_usernum, sizeof(out_usernum));
382
383         // value is a string
384         out_data->size = in_data->size;
385         out_data->data = realloc(out_data->data, out_data->size);
386         memcpy(out_data->data, in_data->data, in_data->size);
387
388         // printf("usersbynumber: %ld --> %s\n", out_usernum, (char *)out_data->data);
389 }
390
391
392 // export function for a config record
393 void export_config(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
394
395         // the key is a string
396         out_key->size = in_key->size;
397         out_key->data = realloc(out_key->data, out_key->size + 1);
398         memcpy(out_key->data, in_key->data, in_key->size);
399         char *k = (char *)out_key->data;
400         k[out_key->size] = 0;
401
402         // the data is a pair of strings
403         out_data->size = in_data->size;
404         out_data->data = realloc(out_data->data, out_data->size + 1);
405         memcpy(out_data->data, in_data->data, in_data->size);
406         char *d = (char *)out_data->data;
407         d[out_data->size] = 0;
408
409         // please excuse my friend, he isn't null terminated
410         // printf("\033[32m\033[1mConfig entry: %s -> %s\033[0m\n", (char *)out_key->data, (char *)out_data->data+strlen(out_data->data)+1);
411 }
412
413 #endif
414
415 // For obsolete databases, zero all the output
416 void zero_function(int which_cdb, DBT *in_key, DBT *in_data) {
417         //printf("Table %02x, keylen=%d, datalen=%d\n", which_cdb, in_key->size, in_data->size);
418 }
419
420
421 void (*export_functions[])(int which_cdb, DBT *in_key, DBT *in_data) = {
422         export_msgmain,         // CDB_MSGMAIN
423         export_user,            // CDB_USERS
424         export_room,            // CDB_ROOMS
425         export_floor,           // CDB_FLOORTAB
426         export_msglist,         // CDB_MSGLISTS
427         export_visit,           // CDB_VISIT
428         export_dir,             // CDB_DIRECTORY
429         export_usetable,        // CDB_USETABLE
430         zero_function,          // CDB_BIGMSGS
431         zero_function,          // CDB_FULLTEXT
432         zero_function,          // CDB_EUIDINDEX
433         zero_function,          // CDB_USERSBYNUMBER
434         zero_function,          // CDB_UNUSED1 (obsolete)
435         zero_function           // CDB_CONFIG
436 };
437
438
439 void export_table(int which_cdb, DB_ENV *src_dbenv) {
440         int ret;
441         int compressed;
442         char dbfilename[32];
443         uLongf destLen = 0;
444
445         // shamelessly swiped from https://docs.oracle.com/database/bdb181/html/programmer_reference/am_cursor.html
446         DB *src_dbp;
447         DBC *src_dbcp;
448         DBT in_key, in_data, uncomp_data;
449         int num_good_rows = 0;
450         int num_bad_rows = 0;
451
452         snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", which_cdb);
453
454         // create a database handle for the source table
455         ret = db_create(&src_dbp, src_dbenv, 0);
456         if (ret) {
457                 fprintf(stderr, "db: db_create: %s\n", db_strerror(ret));
458                 fprintf(stderr, "db: exit code %d\n", ret);
459                 exit(CTDLEXIT_DB);
460         }
461
462         // open the file containing the source table
463         ret = src_dbp->open(src_dbp, NULL, dbfilename, NULL, DB_BTREE, 0, 0600);
464         if (ret) {
465                 fprintf(stderr, "db: db_open: %s\n", db_strerror(ret));
466                 fprintf(stderr, "db: exit code %d\n", ret);
467                 exit(CTDLEXIT_DB);
468         }
469
470         // Acquire a cursor to read the source table
471         if ((ret = src_dbp->cursor(src_dbp, NULL, &src_dbcp, 0)) != 0) {
472                 fprintf(stderr, "db: db_cursor: %s\n", db_strerror(ret));
473                 fprintf(stderr, "db: exit code %d\n", ret);
474                 exit(CTDLEXIT_DB);
475         }
476
477         // Zero out these database keys
478         memset(&in_key,         0, sizeof(DBT));        // input
479         memset(&in_data,        0, sizeof(DBT));
480         memset(&uncomp_data,    0, sizeof(DBT));        // decompressed input (the key doesn't change)
481
482         // Walk through the database, calling export functions as we go and clearing buffers before each call.
483         while (ret = src_dbcp->get(src_dbcp, &in_key, &in_data, DB_NEXT) == 0) {
484         
485                 // If either the key or data are zero length, skip this record
486                 if ((in_key.size == 0) || (in_data.size == 0)) {
487                         ++num_bad_rows;
488                 }
489
490                 else {  // Both key and data are >0 length so we're good to go
491
492                         // Do we need to decompress?
493                         static int32_t magic = COMPRESS_MAGIC;
494                         compressed = 0;
495                         if ( (in_data.size >= sizeof(struct CtdlCompressHeader)) && (!memcmp(in_data.data, &magic, sizeof(magic))) ) {
496         
497                                 // yes, we need to decompress
498                                 compressed = 1;
499                                 struct CtdlCompressHeader comp;
500                                 memcpy(&comp, in_data.data, sizeof(struct CtdlCompressHeader));
501                                 uncomp_data.size = comp.uncompressed_len;
502                                 uncomp_data.data = realloc(uncomp_data.data, uncomp_data.size);
503                                 destLen = (uLongf)comp.uncompressed_len;
504         
505                                 ret = uncompress((Bytef *)uncomp_data.data, (uLongf *)&destLen, (const Bytef *)in_data.data+sizeof(struct CtdlCompressHeader), (uLong)comp.compressed_len);
506                                 if (ret != Z_OK) {
507                                         fprintf(stderr, "db: uncompress() error %d\n", ret);
508                                         exit(CTDLEXIT_DB);
509                                 }
510                         }
511         
512                         // Call the export function registered to this table
513                         export_functions[which_cdb](which_cdb, &in_key, (compressed ? &uncomp_data : &in_data));
514         
515                         // Knowing the total number of rows isn't critical to the program.  It's just for the user to know.
516                         fflush(stdout);
517                 }
518         }
519
520         // free any leftover out_data pointers
521         free(uncomp_data.data);
522
523         // ...and close the database (table)
524         ret = src_dbp->close(src_dbp, 0);
525         if (ret) {
526                 fprintf(stderr, "db: db_close: %s\n", db_strerror(ret));
527         }
528
529
530 }
531
532
533 int main(int argc, char **argv) {
534         int i = 0;
535         char *src_dir = NULL;
536         char *dst_dir = NULL;
537         int confirmed = 0;
538         static DB_ENV *src_dbenv;               // Source DB environment (global)
539
540         // Parse command line
541         int a;
542         while ((a = getopt(argc, argv, "h:d:y")) != EOF) {
543                 switch (a) {
544                 case 'h':
545                         src_dir = optarg;
546                         break;
547                 case 'd':
548                         dst_dir = optarg;
549                         break;
550                 case 'y':
551                         confirmed = 1;
552                         break;
553                 default:
554                         fprintf(stderr, "%s: usage: %s -s source_dir -d dest_dir\n", argv[0], argv[0]);
555                         exit(2);
556                 }
557         }
558
559         // Warn the user
560         fprintf(stderr, "------------------------------------------------------------------------\n");
561         fprintf(stderr, "This utility must be run while the server is OFFLINE.                   \n");
562         fprintf(stderr, "We \033[1mguarantee\033[0m data corruption if you do not                              \n");
563         fprintf(stderr, "observe this warning!  The source [-s] directory should contain a copy  \n");
564         fprintf(stderr, "of the database from your source system.  The dump [-d] directory       \n");
565         fprintf(stderr, "should be empty and will receive your dump file.                        \n");
566         fprintf(stderr, "------------------------------------------------------------------------\n");
567         fprintf(stderr, " Source (database) directory: %s\n", src_dir);
568         fprintf(stderr, "------------------------------------------------------------------------\n");
569
570         if (confirmed == 1) {
571                 fprintf(stderr, "You have specified the [-y] flag, so processing will continue.\n");
572         }
573         else {
574                 fprintf(stderr, "Please read [ https://www.citadel.org/ctdldump.html ] to learn how to proceed.\n");
575                 exit(0);
576         }
577
578         src_dbenv = open_dbenv(src_dir);
579         for (i = 0; i < MAXCDB; ++i) {
580                 export_table(i, src_dbenv);
581         }
582         close_dbenv(src_dbenv);
583
584         exit(0);
585 }