Modified the behavior of ForEachUser() to do the two phase load/perform cycle
[citadel.git] / citadel / modules / upgrade / serv_upgrade.c
index d4cd4904b81f380c3c62ffaa22d14972e5bbd94c..59089d295fbfbfd738b801ab8bcde093fadb2748 100644 (file)
@@ -4,7 +4,7 @@
  * guesses about what kind of data format changes need to be applied, and
  * we apply them transparently.
  *
- * Copyright (c) 1987-2016 by the citadel.org team
+ * Copyright (c) 1987-2019 by the citadel.org team
  *
  * This program is open source software; you can redistribute it and/or
  * modify it under the terms of the GNU General Public License version 3.
 #include "serv_upgrade.h"
 #include "euidindex.h"
 #include "ctdl_module.h"
+#include "serv_vcard.h"
+#include "internet_addressing.h"
 
+/*
+ * oldver is the version number of Citadel Server which was active on the previous run of the program, learned from the system configuration.
+ * If we are running a new Citadel Server for the first time, oldver will be 0.
+ * We keep this value around for the entire duration of the program run because we'll need it during several stages of startup.
+ */
+int oldver = 0;
 
 /*
  * Fix up the name for Citadel user 0 and try to remove any extra users with number 0
@@ -86,7 +94,7 @@ void fix_sys_user_name(void)
        {
                if (strncmp(usbuf.fullname, "SYS_", 4))
                {       /* Delete any user 0 that doesn't start with SYS_ */
-                       makeuserkey(usernamekey, usbuf.fullname, cutuserkey(usbuf.fullname));
+                       makeuserkey(usernamekey, usbuf.fullname, cutusername(usbuf.fullname));
                        cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
                }
                else {
@@ -98,56 +106,39 @@ void fix_sys_user_name(void)
 
 
 /* 
- * Back end processing function for convert_ctdluid_to_minusone()
+ * Back end processing function for reindex_uids()
  */
-void cbtm_backend(struct ctdluser *usbuf, void *data) {
-       static struct UserProcList *uplist = NULL;
-       struct UserProcList *ptr;
-       struct ctdluser us;
+void reindex_uids_backend(char *username, void *data) {
 
-       /* Lazy programming here.  Call this function as a ForEachUser backend
-        * in order to queue up the room names, or call it with a null user
-        * to make it do the processing.
-        */
-       if (usbuf != NULL) {
-               ptr = (struct UserProcList *)
-                       malloc(sizeof (struct UserProcList));
-               if (ptr == NULL) return;
-
-               safestrncpy(ptr->user, usbuf->fullname, sizeof ptr->user);
-               ptr->next = uplist;
-               uplist = ptr;
-               return;
-       }
-
-       while (uplist != NULL) {
+       struct ctdluser us;
 
-               if (CtdlGetUserLock(&us, uplist->user) == 0) {
-                       syslog(LOG_DEBUG, "Processing <%s>...", uplist->user);
-                       if (us.uid == CTDLUID) {
-                               us.uid = (-1);
-                       }
-                       CtdlPutUserLock(&us);
+       if (CtdlGetUserLock(&us, username) == 0) {
+               syslog(LOG_DEBUG, "Processing <%s> (%d)", us.fullname, us.uid);
+               if (us.uid == CTDLUID) {
+                       us.uid = NATIVE_AUTH_UID;
+               }
+               CtdlPutUserLock(&us);
+               if ((us.uid > 0) && (us.uid != NATIVE_AUTH_UID)) {              // if non-native auth , index by uid
+                       StrBuf *claimed_id = NewStrBuf();
+                       StrBufPrintf(claimed_id, "uid:%d", us.uid);
+                       attach_extauth(&us, claimed_id);
+                       FreeStrBuf(&claimed_id);
                }
-
-               ptr = uplist;
-               uplist = uplist->next;
-               free(ptr);
        }
 }
 
+
 /*
- * quick fix to change all CTDLUID users to (-1)
+ * Build extauth index of all users with uid-based join (system auth, LDAP auth)
+ * Also changes all users with a uid of CTDLUID to NATIVE_AUTH_UID (-1)
  */
-void convert_ctdluid_to_minusone(void) {
-       syslog(LOG_WARNING, "Applying uid changes");
-       ForEachUser(cbtm_backend, NULL);
-       cbtm_backend(NULL, NULL);
+void reindex_uids(void) {
+       syslog(LOG_WARNING, "upgrade: reindexing and applying uid changes");
+       ForEachUser(reindex_uids_backend, NULL);
        return;
 }
 
 
-
 /*
  * These accounts may have been created by code that ran between mid 2008 and early 2011.
  * If present they are no longer in use and may be deleted.
@@ -202,7 +193,6 @@ void guess_time_zone(void) {
 }
 
 
-
 /*
  * Per-room callback function for ingest_old_roominfo_and_roompic_files()
  *
@@ -218,8 +208,6 @@ void iorarf_oneroom(char *roomname, char *infofile, char *picfile)
        long pic_msgnum = 0;
        char subject[SIZ];
 
-       syslog(LOG_DEBUG, "iorarf_oneroom( %s , %s , %s )", roomname, infofile, picfile);
-
        // Test for the presence of a legacy "room info file"
        if (!IsEmptyStr(infofile)) {
                fp = fopen(infofile, "r");
@@ -248,7 +236,7 @@ void iorarf_oneroom(char *roomname, char *infofile, char *picfile)
                        }
                }
                fclose(fp);
-               // unlink(filename);
+               if (info_msgnum > 0) unlink(infofile);
        }
 
        // Test for the presence of a legacy "room picture file" and import it.
@@ -279,7 +267,7 @@ void iorarf_oneroom(char *roomname, char *infofile, char *picfile)
                        }
                }
                fclose(fp);
-               // unlink(filename);
+               if (pic_msgnum > 0) unlink(picfile);
        }
 
        // Now we have the message numbers of our new banner and icon.  Record them in the room record.
@@ -296,7 +284,6 @@ void iorarf_oneroom(char *roomname, char *infofile, char *picfile)
 }
 
 
-
 struct iorarf_list {
        struct iorarf_list *next;
        char name[ROOMNAMELEN];
@@ -369,19 +356,16 @@ void ingest_old_roominfo_and_roompic_files(void)
                il = p;
        }
 
+       unlink(ctdl_info_dir);
 }
 
 
 /*
- * Perform any upgrades that can be done automatically based on our knowledge of the previous
- * version of Citadel server that was running here.
- *
- * Note that if the previous version was 0 then this is a new installation running for the first time.
+ * For upgrades in which a new config setting appears for the first time, set default values.
+ * For new installations (oldver == 0) also set default values.
  */
 void update_config(void) {
 
-       int oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
-
        if (oldver < 606) {
                CtdlSetConfigInt("c_rfc822_strict_from", 0);
        }
@@ -422,56 +406,131 @@ void update_config(void) {
 }
 
 
+/*
+ * Helper function for move_inet_addrs_from_vcards_to_user_records()
+ *
+ * Call this function as a ForEachUser backend in order to queue up
+ * user names, or call it with a null user to make it do the processing.
+ * This allows us to maintain the list as a static instead of passing
+ * pointers around.
+ */
+void miafvtur_backend(char *username, void *data) {
+       struct ctdluser usbuf;
+       char primary_inet_email[512] = { 0 };
+       char other_inet_emails[512] = { 0 };
+       char combined_inet_emails[512] = { 0 };
+
+       if (CtdlGetUser(&usbuf, username) != 0) {
+               return;
+       }
+
+       struct vCard *v = vcard_get_user(&usbuf);
+       if (!v) return;
+       extract_inet_email_addrs(primary_inet_email, sizeof primary_inet_email, other_inet_emails, sizeof other_inet_emails, v, 1);
+       vcard_free(v);
+       
+       if ( (IsEmptyStr(primary_inet_email)) && (IsEmptyStr(other_inet_emails)) ) {
+               return;
+       }
+
+       snprintf(combined_inet_emails, 512, "%s%s%s",
+               (!IsEmptyStr(primary_inet_email) ? primary_inet_email : ""),
+               ((!IsEmptyStr(primary_inet_email)&&(!IsEmptyStr(other_inet_emails))) ? "|" : ""),
+               (!IsEmptyStr(other_inet_emails) ? other_inet_emails : "")
+       );
+
+       CtdlSetEmailAddressesForUser(usbuf.fullname, combined_inet_emails);
+}
+
+
+/*
+ * If our system still has a "refcount_adjustments.dat" sitting around from an old version, ingest it now.
+ */
+int ProcessOldStyleAdjRefCountQueue(void)
+{
+       int r;
+       FILE *fp;
+       struct arcq arcq_rec;
+       int num_records_processed = 0;
+
+       fp = fopen(file_arcq, "rb");
+       if (fp == NULL) {
+               return(num_records_processed);
+       }
+
+       syslog(LOG_INFO, "msgbase: ingesting %s", file_arcq);
+
+       while (fread(&arcq_rec, sizeof(struct arcq), 1, fp) == 1) {
+               AdjRefCount(arcq_rec.arcq_msgnum, arcq_rec.arcq_delta);
+               ++num_records_processed;
+       }
+
+       fclose(fp);
+       r = unlink(file_arcq);
+       if (r != 0) {
+               syslog(LOG_ERR, "%s: %m", file_arcq);
+       }
+
+       return(num_records_processed);
+}
+
+
+/*
+ * Prior to version 912 we kept a user's various Internet email addresses in their vCards.
+ * This function moves them over to the user record, which is where we keep them now.
+ */
+void move_inet_addrs_from_vcards_to_user_records(void)
+{
+       ForEachUser(miafvtur_backend, NULL);
+       CtdlRebuildDirectoryIndex();
+}
+
 
 /*
  * Based on the server version number reported by the existing database,
  * run in-place data format upgrades until everything is up to date.
  */
-void check_server_upgrades(void) {
+void pre_startup_upgrades(void) {
 
-       syslog(LOG_INFO, "Existing database version on disk is %d", CtdlGetConfigInt("MM_hosted_upgrade_level"));
+       oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
+       syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
+       update_config();
 
-       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < REV_LEVEL) {
-               syslog(LOG_WARNING, "Server hosted updates need to be processed at this time.  Please wait...");
+       if (oldver < REV_LEVEL) {
+               syslog(LOG_WARNING, "Running pre-startup database upgrades.");
        }
        else {
                return;
        }
 
-       update_config();
-
-       if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 591)) {
+       if ((oldver > 000) && (oldver < 591)) {
                syslog(LOG_EMERG, "This database is too old to be upgraded.  Citadel server will exit.");
                exit(EXIT_FAILURE);
        }
-       if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 608)) {
-               convert_ctdluid_to_minusone();
+       if ((oldver > 000) && (oldver < 913)) {
+               reindex_uids();
        }
-       if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 659)) {
+       if ((oldver > 000) && (oldver < 659)) {
                rebuild_euid_index();
        }
-       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 735) {
+       if (oldver < 735) {
                fix_sys_user_name();
        }
-       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 736) {
+       if (oldver < 736) {
                rebuild_usersbynumber();
        }
-       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 790) {
+       if (oldver < 790) {
                remove_thread_users();
        }
-       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 810) {
+       if (oldver < 810) {
                struct ctdlroom QRoom;
                if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) {
                        QRoom.QRdefaultview = VIEW_QUEUE;
                        CtdlPutRoom(&QRoom);
                }
-               if (!CtdlGetRoom(&QRoom, FNBL_QUEUE_ROOM)) {
-                       QRoom.QRdefaultview = VIEW_QUEUE;
-                       CtdlPutRoom(&QRoom);
-               }
        }
 
-       if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 902)) {
+       if ((oldver > 000) && (oldver < 902)) {
                ingest_old_roominfo_and_roompic_files();
        }
 
@@ -495,10 +554,47 @@ void check_server_upgrades(void) {
 }
 
 
+/*
+ * Based on the server version number reported by the existing database,
+ * run in-place data format upgrades until everything is up to date.
+ */
+void post_startup_upgrades(void) {
+
+       syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
+
+       if (oldver < REV_LEVEL) {
+               syslog(LOG_WARNING, "Running post-startup database upgrades.");
+       }
+       else {
+               return;
+       }
+
+       if ((oldver > 000) && (oldver < 912)) {
+               move_inet_addrs_from_vcards_to_user_records();
+       }
+
+       if ((oldver > 000) && (oldver < 922)) {
+               ProcessOldStyleAdjRefCountQueue();
+       }
+}
+
+
 CTDL_MODULE_UPGRADE(upgrade)
 {
-       check_server_upgrades();
+       pre_startup_upgrades();
        
        /* return our module id for the Log */
        return "upgrade";
 }
+
+CTDL_MODULE_INIT(upgrade)
+{
+       if(!threading)
+       {
+               move_inet_addrs_from_vcards_to_user_records();
+               post_startup_upgrades();
+       }
+       
+       /* return our module name for the log */
+        return "upgrade";
+}