citadel/utils/ctdl3264.c

   1 // Attempt to convert your database from 32-bit to 64-bit.
   2 // Don't run this.  It doesn't work and if you try to run it you will immediately die.
   3 //
   4 // Copyright (c) 2023 by Art Cancro citadel.org
   5 //
   6 // This program is open source software.  Use, duplication, or disclosure
   7 // is subject to the terms of the GNU General Public License, version 3.
   8
   9 #include <stdlib.h>
  10 #include <unistd.h>
  11 #include <ctype.h>
  12 #include <stdio.h>
  13 #include <signal.h>
  14 #include <sys/types.h>
  15 #include <sys/socket.h>
  16 #include <sys/un.h>
  17 #include <netdb.h>
  18 #include <string.h>
  19 #include <pwd.h>
  20 #include <errno.h>
  21 #include <stdarg.h>
  22 #include <limits.h>
  23 #include <libcitadel.h>
  24 #include <zlib.h>
  25 #include <db.h>
  26 #include "../server/sysdep.h"
  27 #include "../server/citadel_defs.h"
  28 #include "../server/server.h"
  29 #include "../server/citadel_dirs.h"
  30 #include "ctdl3264_structs.h"
  31
  32 static DB_ENV *dbenv;           // The DB environment (global)
  33
  34 // Open the database environment
  35 void open_dbenv(char *src_dir) {
  36         int ret;
  37         int i;
  38         u_int32_t flags = 0;
  39         int dbversion_major, dbversion_minor, dbversion_patch;
  40
  41         printf( "db: open_dbenv() starting\n"
  42                 "db:    Linked zlib: %s\n"
  43                 "db: Compiled libdb: %s\n"
  44                 "db:   Linked libdb: %s\n",
  45                 zlibVersion(),
  46                 DB_VERSION_STRING,
  47                 db_version(&dbversion_major, &dbversion_minor, &dbversion_patch)
  48         );
  49
  50         // Create synthetic integer version numbers and compare them.
  51         // Never allow citserver to run with a libdb older then the one with which it was compiled.
  52         int compiled_db_version = ( (DB_VERSION_MAJOR * 1000000) + (DB_VERSION_MINOR * 1000) + (DB_VERSION_PATCH) );
  53         int linked_db_version = ( (dbversion_major * 1000000) + (dbversion_minor * 1000) + (dbversion_patch) );
  54         if (compiled_db_version > linked_db_version) {
  55                 printf( "db: ctdl3264 is running with a version of libdb older than the one with which it was compiled.\n"
  56                         "db: This is an invalid configuration.  ctdl3264 will now exit to prevent data loss.");
  57                 exit(CTDLEXIT_DB);
  58         }
  59
  60         printf("db: Setting up DB environment\n");
  61         ret = db_env_create(&dbenv, 0);
  62         if (ret) {
  63                 printf("db: db_env_create: %s\n", db_strerror(ret));
  64                 printf("db: exit code %d\n", ret);
  65                 exit(CTDLEXIT_DB);
  66         }
  67
  68         // We want to specify the shared memory buffer pool cachesize, but everything else is the default.
  69         ret = dbenv->set_cachesize(dbenv, 0, 64 * 1024, 0);
  70         if (ret) {
  71                 printf("db: set_cachesize: %s\n", db_strerror(ret));
  72                 dbenv->close(dbenv, 0);
  73                 printf("db: exit code %d\n", ret);
  74                 exit(CTDLEXIT_DB);
  75         }
  76
  77         if ((ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT))) {
  78                 printf("db: set_lk_detect: %s\n", db_strerror(ret));
  79                 dbenv->close(dbenv, 0);
  80                 printf("db: exit code %d\n", ret);
  81                 exit(CTDLEXIT_DB);
  82         }
  83
  84         flags = DB_CREATE | DB_INIT_MPOOL | DB_PRIVATE | DB_INIT_LOG;
  85         printf("db: dbenv open(dir=%s, flags=%d)\n", src_dir, flags);
  86         ret = dbenv->open(dbenv, src_dir, flags, 0);
  87         if (ret) {
  88                 printf("db: dbenv->open: %s\n", db_strerror(ret));
  89                 dbenv->close(dbenv, 0);
  90                 printf("db: exit code %d\n", ret);
  91                 exit(CTDLEXIT_DB);
  92         }
  93 }
  94
  95
  96 void close_dbenv(void) {
  97         printf("db: closing dbenv\n");
  98         int ret = dbenv->close(dbenv, 0);
  99         if (ret) {
 100                 printf("db: DBENV->close: %s\n", db_strerror(ret));
 101         }
 102 }
 103
 104
 105 // placeholder convert function for the data types not yet implemented
 106 void null_function(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
 107         printf("DB: %02x , keylen: %3d , datalen: %d , dataptr: %lx\n", which_cdb, (int)in_key->size, (int)in_data->size, (long unsigned int)in_data->data);
 108 }
 109
 110
 111 // convert function for a message in msgmain
 112 void convert_msgmain(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
 113         int32_t msgnum;
 114         memcpy(&msgnum, in_key->data, sizeof(msgnum));
 115         printf("msgmain: len is %d , key is %d\n", in_key->size, msgnum);
 116
 117         if (in_key->size != 4) {
 118                 printf("\033[31m\033[1m *** SOURCE DATABASE IS NOT 32-BIT *** ABORTING *** \033[0m\n");
 119                 abort();
 120         }
 121
 122
 123         // If the msgnum is negative, we are looking at METADATA
 124         if (msgnum < 0) {
 125                 struct MetaData_32 meta32;
 126                 if (in_data->size != sizeof meta32) {
 127                         printf("\033[31mmetadata: db says %d bytes , struct says %ld bytes\033[0m\n", in_data->size, sizeof meta32);
 128                         abort();
 129                 }
 130                 memset(&meta32, 0, sizeof meta32);
 131                 memcpy(&meta32, in_data->data, in_data->size);
 132
 133                 printf("metadata: msgnum=%d , refcount=%d , content_type=\"%s\" , rfc822len=%d\n",
 134                         meta32.meta_msgnum, meta32.meta_refcount, meta32.meta_content_type, meta32.meta_rfc822_length);
 135
 136                 //struct MetaData *meta64 = malloc(sizeof(struct MetaData));
 137                 //memset(meta64, 0, sizeof(struct MetaData));
 138                 //meta64->meta_msgnum           = (long)        meta32.meta_msgnum;
 139                 //meta64->meta_refcount         = (int)         meta32.meta_refcount;
 140                 //strcpy(meta64->meta_content_type,             meta32.meta_content_type);
 141                 //meta64->meta_rfc822_length    = (long)        meta32.meta_rfc822_length;
 142
 143         }
 144
 145         // If the msgnum is positive, we are looking at a MESSAGE
 146         else if (msgnum > 0) {
 147         }
 148
 149         // If the msgnum is 0 it's probably not a valid record.
 150 }
 151
 152
 153 // convert function for a message in msgmain
 154 void convert_users(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) {
 155         char userkey[64];
 156         memcpy(userkey, in_key->data, in_key->size);
 157         userkey[in_key->size] = 0;
 158         printf("users: len is %d , key is %s\n", in_key->size, userkey);
 159 }
 160
 161
 162 void (*convert_functions[])(int which_cdb, DBT *in_key, DBT *in_data, DBT *out_key, DBT *out_data) = {
 163         convert_msgmain,        // CDB_MSGMAIN
 164         convert_users,          // CDB_USERS
 165         null_function,          // CDB_ROOMS
 166         null_function,          // CDB_FLOORTAB
 167         null_function,          // CDB_MSGLISTS
 168         null_function,          // CDB_VISIT
 169         null_function,          // CDB_DIRECTORY
 170         null_function,          // CDB_USETABLE
 171         null_function,          // CDB_BIGMSGS
 172         null_function,          // CDB_FULLTEXT
 173         null_function,          // CDB_EUIDINDEX
 174         null_function,          // CDB_USERSBYNUMBER
 175         null_function,          // CDB_EXTAUTH
 176         null_function           // CDB_CONFIG
 177 };
 178
 179
 180 void convert_table(int which_cdb) {
 181         int ret;
 182         char dbfilename[32];
 183
 184         printf("\033[32m\033[1mConverting table %d\033[0m\n", which_cdb);
 185
 186         // shamelessly swiped from https://docs.oracle.com/database/bdb181/html/programmer_reference/am_cursor.html
 187         DB *dbp;
 188         DBC *dbcp;
 189         DBT in_key, in_data, out_key, out_data;
 190         int num_rows = 0;
 191
 192         // create a database handle
 193         ret = db_create(&dbp, dbenv, 0);
 194         if (ret) {
 195                 printf("db: db_create: %s\n", db_strerror(ret));
 196                 printf("db: exit code %d\n", ret);
 197                 exit(CTDLEXIT_DB);
 198         }
 199
 200         // open the file
 201         snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", which_cdb);
 202         printf("\033[33m\033[1mdb: opening %s\033[0m\n", dbfilename);
 203         ret = dbp->open(dbp, NULL, dbfilename, NULL, DB_BTREE, 0, 0600);
 204         if (ret) {
 205                 printf("db: db_open: %s\n", db_strerror(ret));
 206                 printf("db: exit code %d\n", ret);
 207                 exit(CTDLEXIT_DB);
 208         }
 209
 210         // Acquire a cursor
 211         if ((ret = dbp->cursor(dbp, NULL, &dbcp, 0)) != 0) {
 212                 printf("db: db_cursor: %s\n", db_strerror(ret));
 213                 printf("db: exit code %d\n", ret);
 214                 exit(CTDLEXIT_DB);
 215         }
 216
 217         // Zero out these database keys
 218         memset(&in_key, 0, sizeof(in_key));
 219         memset(&in_data, 0, sizeof(in_data));
 220         memset(&out_key, 0, sizeof(out_key));
 221         memset(&out_data, 0, sizeof(out_data));
 222
 223         // Walk through the database, calling convert functions as we go and clearing buffers before each call.
 224         while ((ret = dbcp->get(dbcp, &in_key, &in_data, DB_NEXT)) == 0) {
 225                 // Call the convert function registered to this table
 226                 convert_functions[which_cdb](which_cdb, &in_key, &in_data, &out_key, &out_data);
 227
 228                 ++num_rows;
 229         }
 230
 231         if (ret != DB_NOTFOUND) {
 232                 printf("db: db_get: %s\n", db_strerror(ret));
 233                 printf("db: exit code %d\n", ret);
 234                 exit(CTDLEXIT_DB);
 235         }
 236
 237         printf("%d rows\n", num_rows);
 238
 239         // Flush the logs...
 240         //printf("\033[33m\033[1mdb: flushing the database logs\033[0m\n");
 241         //if ((ret = dbenv->log_flush(dbenv, NULL))) {
 242                 //printf("db: log_flush: %s\n", db_strerror(ret));
 243         //}
 244
 245         // ...and close the database (table)
 246         printf("\033[33m\033[1mdb: closing database %02x\033[0m\n", which_cdb);
 247         ret = dbp->close(dbp, 0);
 248         if (ret) {
 249                 printf("db: db_close: %s\n", db_strerror(ret));
 250         }
 251
 252 }
 253
 254
 255 int main(int argc, char **argv) {
 256         char *src_dir = NULL;
 257         int confirmed = 0;
 258
 259         // Check to make sure we're running on the target 64-bit system
 260         if (sizeof(void *) != 8) {
 261                 fprintf(stderr, "%s: this is a %ld-bit system.\n", argv[0], sizeof(void *)*8);
 262                 fprintf(stderr, "%s: you must run this on a 64-bit system, onto which a 32-bit database has been copied.\n", argv[0]);
 263                 exit(1);
 264         }
 265
 266         // Parse command line
 267         int a;
 268         while ((a = getopt(argc, argv, "s:d:y")) != EOF) {
 269                 switch (a) {
 270                 case 's':
 271                         src_dir = optarg;
 272                         break;
 273                 case 'y':
 274                         confirmed = 1;
 275                         break;
 276                 default:
 277                         fprintf(stderr, "%s: usage: %s -s source_dir -d dest_dir\n", argv[0], argv[0]);
 278                         exit(2);
 279                 }
 280         }
 281
 282         // Warn the user
 283         printf("------------------------------------------------------------------------\n");
 284         printf("ctdl3264 converts a Citadel database written on a 32-bit system to one  \n");
 285         printf("that can be run on a 64-bit system.  It is intended to be run OFFLINE.  \n");
 286         printf("Neither the source nor the target data directories should be mounted by \n");
 287         printf("a running Citadel server.  We guarantee data corruption if you do not   \n");
 288         printf("observe this warning!  The source [-s] directory should contain a copy  \n");
 289         printf("of the database from your 32-bit system.  The destination [-d] directory\n");
 290         printf("should be empty and will receive your 64-bit database.                  \n");
 291         printf("------------------------------------------------------------------------\n");
 292         printf("     Source 32-bit directory: %s\n", src_dir);
 293         printf("Destination 64-bit directory: %s\n", "FIXME");
 294         printf("------------------------------------------------------------------------\n");
 295
 296         if (confirmed == 1) {
 297                 printf("You have specified the [-y] flag, so processing will continue.\n");
 298         }
 299         else {
 300                 printf("Please consult the documentation to learn how to proceed.\n");
 301                 exit(0);
 302         }
 303
 304         open_dbenv(src_dir);
 305         for (int i = 0; i < MAXCDB; ++i) {
 306                 convert_table(i);
 307         }
 308         close_dbenv();
 309
 310         exit(0);
 311 }