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 the citadel.org team
   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 *key, DBT *data) {
 107         //printf("DB: %02x , keylen: %3d , datalen: %d , dataptr: %x\n", which_cdb, (int)key->size, (int)data->size, data->data);
 108 }
 109
 110
 111 // convert function for a message in msgmain
 112 void convert_msgmain(int which_cdb, DBT *key, DBT *data) {
 113         long msgnum;
 114         memcpy(&msgnum, key->data, sizeof(msgnum));
 115         printf("msgmain: len is %d , key is %ld\n", key->size, msgnum);
 116
 117         if (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
 124         // If the msgnum is positive, we are looking at a MESSAGE
 125         // If the msgnum is negative, we are looking at METADATA
 126 }
 127
 128
 129 // convert function for a message in msgmain
 130 void convert_users(int which_cdb, DBT *key, DBT *data) {
 131         char userkey[64];
 132         memcpy(userkey, key->data, key->size);
 133         userkey[key->size] = 0;
 134         printf("users: len is %d , key is %s\n", key->size, userkey);
 135 }
 136
 137
 138 void (*convert_functions[])(int which_cdb, DBT *key, DBT *data) = {
 139         convert_msgmain,        // CDB_MSGMAIN
 140         convert_users,          // CDB_USERS
 141         null_function,          // CDB_ROOMS
 142         null_function,          // CDB_FLOORTAB
 143         null_function,          // CDB_MSGLISTS
 144         null_function,          // CDB_VISIT
 145         null_function,          // CDB_DIRECTORY
 146         null_function,          // CDB_USETABLE
 147         null_function,          // CDB_BIGMSGS
 148         null_function,          // CDB_FULLTEXT
 149         null_function,          // CDB_EUIDINDEX
 150         null_function,          // CDB_USERSBYNUMBER
 151         null_function,          // CDB_EXTAUTH
 152         null_function           // CDB_CONFIG
 153 };
 154
 155
 156 void convert_table(int which_cdb) {
 157         int ret;
 158         char dbfilename[32];
 159
 160         printf("\033[32m\033[1mConverting table %d\033[0m\n", which_cdb);
 161
 162         // shamelessly swiped from https://docs.oracle.com/database/bdb181/html/programmer_reference/am_cursor.html
 163         DB *dbp;
 164         DBC *dbcp;
 165         DBT key, data;
 166         int num_rows = 0;
 167
 168         // create a database handle
 169         ret = db_create(&dbp, dbenv, 0);
 170         if (ret) {
 171                 printf("db: db_create: %s\n", db_strerror(ret));
 172                 printf("db: exit code %d\n", ret);
 173                 exit(CTDLEXIT_DB);
 174         }
 175
 176         // open the file
 177         snprintf(dbfilename, sizeof dbfilename, "cdb.%02x", which_cdb);
 178         printf("\033[33m\033[1mdb: opening %s\033[0m\n", dbfilename);
 179         ret = dbp->open(dbp, NULL, dbfilename, NULL, DB_BTREE, 0, 0600);
 180         if (ret) {
 181                 printf("db: db_open: %s\n", db_strerror(ret));
 182                 printf("db: exit code %d\n", ret);
 183                 exit(CTDLEXIT_DB);
 184         }
 185
 186         // Acquire a cursor
 187         if ((ret = dbp->cursor(dbp, NULL, &dbcp, 0)) != 0) {
 188                 printf("db: db_cursor: %s\n", db_strerror(ret));
 189                 printf("db: exit code %d\n", ret);
 190                 exit(CTDLEXIT_DB);
 191         }
 192
 193         // Initialize the key/data return pair.
 194         memset(&key, 0, sizeof(key));
 195         memset(&data, 0, sizeof(data));
 196
 197         // Walk through the database and print out the key/data pairs.
 198         while ((ret = dbcp->get(dbcp, &key, &data, DB_NEXT)) == 0) {
 199
 200                 ++num_rows;
 201
 202                 // Call the convert function (this will need some parameters later)
 203                 convert_functions[which_cdb](which_cdb, &key, &data);
 204         }
 205
 206         if (ret != DB_NOTFOUND) {
 207                 printf("db: db_get: %s\n", db_strerror(ret));
 208                 printf("db: exit code %d\n", ret);
 209                 exit(CTDLEXIT_DB);
 210         }
 211
 212         printf("%d rows\n", num_rows);
 213
 214         // Flush the logs...
 215         //printf("\033[33m\033[1mdb: flushing the database logs\033[0m\n");
 216         //if ((ret = dbenv->log_flush(dbenv, NULL))) {
 217                 //printf("db: log_flush: %s\n", db_strerror(ret));
 218         //}
 219
 220         // ...and close the database (table)
 221         printf("\033[33m\033[1mdb: closing database %02x\033[0m\n", which_cdb);
 222         ret = dbp->close(dbp, 0);
 223         if (ret) {
 224                 printf("db: db_close: %s\n", db_strerror(ret));
 225         }
 226
 227 }
 228
 229
 230 int main(int argc, char **argv) {
 231         char *src_dir = NULL;
 232         int confirmed = 0;
 233
 234         // Check to make sure we're running on the target 64-bit system
 235         if (sizeof(void *) != 8) {
 236                 fprintf(stderr, "%s: this is a %ld-bit system.\n", argv[0], sizeof(void *)*8);
 237                 fprintf(stderr, "%s: you must run this on a 64-bit system, onto which a 32-bit database has been copied.\n", argv[0]);
 238                 exit(1);
 239         }
 240
 241         // Parse command line
 242         int a;
 243         while ((a = getopt(argc, argv, "s:d:y")) != EOF) {
 244                 switch (a) {
 245                 case 's':
 246                         src_dir = optarg;
 247                         break;
 248                 case 'y':
 249                         confirmed = 1;
 250                         break;
 251                 default:
 252                         fprintf(stderr, "%s: usage: %s -s source_dir -d dest_dir\n", argv[0], argv[0]);
 253                         exit(2);
 254                 }
 255         }
 256
 257         // Warn the user
 258         printf("------------------------------------------------------------------------\n");
 259         printf("ctdl3264 converts a Citadel database written on a 32-bit system to one  \n");
 260         printf("that can be run on a 64-bit system.  It is intended to be run OFFLINE.  \n");
 261         printf("Neither the source nor the target data directories should be mounted by \n");
 262         printf("a running Citadel server.  We guarantee data corruption if you do not   \n");
 263         printf("observe this warning!  The source [-s] directory should contain a copy  \n");
 264         printf("of the database from your 32-bit system.  The destination [-d] directory\n");
 265         printf("should be empty and will receive your 64-bit database.                  \n");
 266         printf("------------------------------------------------------------------------\n");
 267         printf("     Source 32-bit directory: %s\n", src_dir);
 268         printf("Destination 64-bit directory: %s\n", "FIXME");
 269         printf("------------------------------------------------------------------------\n");
 270
 271         if (confirmed == 1) {
 272                 printf("You have specified the [-y] flag, so processing will continue.\n");
 273         }
 274         else {
 275                 printf("Please consult the documentation to learn how to proceed.\n");
 276                 exit(0);
 277         }
 278
 279         open_dbenv(src_dir);
 280         for (int i = 0; i < MAXCDB; ++i) {
 281                 convert_table(i);
 282         }
 283         close_dbenv();
 284
 285         exit(0);
 286 }