Begin removing the decimal point from our version number (901 instead of 9.01)
[citadel.git] / citadel / modules / upgrade / serv_upgrade.c
index de3eb9ab5227d7e17566f40279dad05f084513bb..249c825053524575e3bf5b990a442bf9d88fc111 100644 (file)
@@ -1,23 +1,15 @@
 /*
- * $Id$
- *
  * Transparently handle the upgrading of server data formats.
  *
- * Copyright (c) 1987-2009 by the citadel.org team
- *
- *  This program is free software; you can redistribute it and/or modify
- *  it under the terms of the GNU General Public License as published by
- *  the Free Software Foundation; either version 3 of the License, or
- *  (at your option) any later version.
+ * Copyright (c) 1987-2016 by the citadel.org team
  *
- *  This program is distributed in the hope that it will be useful,
- *  but WITHOUT ANY WARRANTY; without even the implied warranty of
- *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
- *  GNU General Public License for more details.
+ * 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.
  *
- *  You should have received a copy of the GNU General Public License
- *  along with this program; if not, write to the Free Software
- *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
  */
 
 #include "sysdep.h"
 #include "msgbase.h"
 #include "serv_upgrade.h"
 #include "euidindex.h"
-
-
 #include "ctdl_module.h"
 
 
-
 /*
  * Fix up the name for Citadel user 0 and try to remove any extra users with number 0
  */
@@ -79,25 +68,25 @@ void fix_sys_user_name(void)
        while (CtdlGetUserByNumber(&usbuf, 0) == 0)
        {
                /* delete user with number 0 and no name */
-               if (IsEmptyStr(usbuf.fullname))
+               if (IsEmptyStr(usbuf.fullname)) {
                        cdb_delete(CDB_USERS, "", 0);
-               else
-               { /* temporarily set this user to -1 */
+               }
+               else {
+                       /* temporarily set this user to -1 */
                        usbuf.usernum = -1;
                        CtdlPutUser(&usbuf);
                }
        }
 
-       /** Make sure user SYS_* is user 0 */
+       /* Make sure user SYS_* is user 0 */
        while (CtdlGetUserByNumber(&usbuf, -1) == 0)
        {
                if (strncmp(usbuf.fullname, "SYS_", 4))
-               {       /** Delete any user 0 that doesn't start with SYS_ */
-                       makeuserkey(usernamekey, usbuf.fullname);
+               {       /* Delete any user 0 that doesn't start with SYS_ */
+                       makeuserkey(usernamekey, usbuf.fullname, cutuserkey(usbuf.fullname));
                        cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
                }
-               else
-               {
+               else {
                        usbuf.usernum = 0;
                        CtdlPutUser(&usbuf);
                }
@@ -105,61 +94,6 @@ void fix_sys_user_name(void)
 }
 
 
-/* 
- * Back end processing function for cmd_bmbx
- */
-void cmd_bmbx_backend(struct ctdlroom *qrbuf, void *data) {
-       static struct RoomProcList *rplist = NULL;
-       struct RoomProcList *ptr;
-       struct ctdlroom qr;
-
-       /* Lazy programming here.  Call this function as a CtdlForEachRoom backend
-        * in order to queue up the room names, or call it with a null room
-        * to make it do the processing.
-        */
-       if (qrbuf != NULL) {
-               ptr = (struct RoomProcList *)
-                       malloc(sizeof (struct RoomProcList));
-               if (ptr == NULL) return;
-
-               safestrncpy(ptr->name, qrbuf->QRname, sizeof ptr->name);
-               ptr->next = rplist;
-               rplist = ptr;
-               return;
-       }
-
-       while (rplist != NULL) {
-
-               if (CtdlGetRoomLock(&qr, rplist->name) == 0) {
-                       CtdlLogPrintf(CTDL_DEBUG, "Processing <%s>...\n", rplist->name);
-                       if ( (qr.QRflags & QR_MAILBOX) == 0) {
-                               CtdlLogPrintf(CTDL_DEBUG, "  -- not a mailbox\n");
-                       }
-                       else {
-
-                               qr.QRgen = time(NULL);
-                               CtdlLogPrintf(CTDL_DEBUG, "  -- fixed!\n");
-                       }
-                       CtdlPutRoomLock(&qr);
-               }
-
-               ptr = rplist;
-               rplist = rplist->next;
-               free(ptr);
-       }
-}
-
-/*
- * quick fix to bump mailbox generation numbers
- */
-void bump_mailbox_generation_numbers(void) {
-       CtdlLogPrintf(CTDL_WARNING, "Applying security fix to mailbox rooms\n");
-       CtdlForEachRoom(cmd_bmbx_backend, NULL);
-       cmd_bmbx_backend(NULL, NULL);
-       return;
-}
-
-
 /* 
  * Back end processing function for convert_ctdluid_to_minusone()
  */
@@ -186,7 +120,7 @@ void cbtm_backend(struct ctdluser *usbuf, void *data) {
        while (uplist != NULL) {
 
                if (CtdlGetUserLock(&us, uplist->user) == 0) {
-                       CtdlLogPrintf(CTDL_DEBUG, "Processing <%s>...\n", uplist->user);
+                       syslog(LOG_DEBUG, "Processing <%s>...", uplist->user);
                        if (us.uid == CTDLUID) {
                                us.uid = (-1);
                        }
@@ -203,13 +137,48 @@ void cbtm_backend(struct ctdluser *usbuf, void *data) {
  * quick fix to change all CTDLUID users to (-1)
  */
 void convert_ctdluid_to_minusone(void) {
-       CtdlLogPrintf(CTDL_WARNING, "Applying uid changes\n");
+       syslog(LOG_WARNING, "Applying uid changes");
        ForEachUser(cbtm_backend, NULL);
        cbtm_backend(NULL, 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.
+ */
+void remove_thread_users(void) {
+       char *deleteusers[] = {
+               "SYS_checkpoint",
+               "SYS_extnotify",
+               "SYS_IGnet Queue",
+               "SYS_indexer",
+               "SYS_network",
+               "SYS_popclient",
+               "SYS_purger",
+               "SYS_rssclient",
+               "SYS_select_on_master",
+               "SYS_SMTP Send"
+       };
+
+       int i;
+       struct ctdluser usbuf;
+       for (i=0; i<(sizeof(deleteusers)/sizeof(char *)); ++i) {
+               if (CtdlGetUser(&usbuf, deleteusers[i]) == 0) {
+                       usbuf.axlevel = 0;
+                       strcpy(usbuf.password, "deleteme");
+                       CtdlPutUser(&usbuf);
+                       syslog(LOG_INFO,
+                               "System user account <%s> is no longer in use and will be deleted.",
+                               deleteusers[i]
+                       );
+               }
+       }
+}
+
+
 /*
  * Attempt to guess the name of the time zone currently in use
  * on the underlying host system.
@@ -222,8 +191,8 @@ void guess_time_zone(void) {
        if (fp) {
                if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) {
                        buf[strlen(buf)-1] = 0;
-                       safestrncpy(config.c_default_cal_zone, buf, sizeof config.c_default_cal_zone);
-                       CtdlLogPrintf(CTDL_INFO, "Configuring timezone: %s\n", config.c_default_cal_zone);
+                       CtdlSetConfigStr("c_default_cal_zone", buf);
+                       syslog(LOG_INFO, "Configuring timezone: %s", buf);
                }
                fclose(fp);
        }
@@ -231,72 +200,68 @@ void guess_time_zone(void) {
 
 
 /*
- * Do various things to our configuration file
+ * 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.
  */
 void update_config(void) {
-       get_config();
 
-       if (CitControl.version < 606) {
-               config.c_rfc822_strict_from = 0;
+       int oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
+
+       if (oldver < 606) {
+               CtdlSetConfigInt("c_rfc822_strict_from", 0);
        }
 
-       if (CitControl.version < 609) {
-               config.c_purge_hour = 3;
+       if (oldver < 609) {
+               CtdlSetConfigInt("c_purge_hour", 3);
        }
 
-       if (CitControl.version < 615) {
-               config.c_ldap_port = 389;
+       if (oldver < 615) {
+               CtdlSetConfigInt("c_ldap_port", 389);
        }
 
-       if (CitControl.version < 623) {
-               strcpy(config.c_ip_addr, "0.0.0.0");
+       if (oldver < 623) {
+               CtdlSetConfigStr("c_ip_addr", "*");
        }
 
-       if (CitControl.version < 650) {
-               config.c_enable_fulltext = 0;
+       if (oldver < 650) {
+               CtdlSetConfigInt("c_enable_fulltext", 1);
        }
 
-       if (CitControl.version < 652) {
-               config.c_auto_cull = 1;
+       if (oldver < 652) {
+               CtdlSetConfigInt("c_auto_cull", 1);
        }
 
-       if (CitControl.version < 725) {
-               config.c_xmpp_c2s_port = 5222;
-               config.c_xmpp_s2s_port = 5269;
+       if (oldver < 725) {
+               CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
+               CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
        }
 
-       /* Erase LDAP config that might be left over from the old connector
-        * which served a different purpose.
-        */
-       if (CitControl.version < 760) {
-               strcpy(config.c_ldap_host, "");
-               config.c_ldap_port = 389;
-               strcpy(config.c_ldap_base_dn, "");
-               strcpy(config.c_ldap_bind_dn, "");
-               strcpy(config.c_ldap_bind_pw, "");
+       if (oldver < 830) {
+               CtdlSetConfigInt("c_nntp_port", 119);
+               CtdlSetConfigInt("c_nntps_port", 563);
        }
 
-       if (IsEmptyStr(config.c_default_cal_zone)) {
+       if (IsEmptyStr(CtdlGetConfigStr("c_default_cal_zone"))) {
                guess_time_zone();
        }
-
-       put_config();
 }
 
 
 
-
+/*
+ * 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) {
 
-       get_control();
-       CtdlLogPrintf(CTDL_INFO, "Server-hosted upgrade level is %d.%02d\n",
-               (CitControl.version / 100),
-               (CitControl.version % 100) );
+       syslog(LOG_INFO, "Existing database version on disk is %d", CtdlGetConfigInt("MM_hosted_upgrade_level"));
 
-       if (CitControl.version < REV_LEVEL) {
-               CtdlLogPrintf(CTDL_WARNING,
-                       "Server hosted updates need to be processed at "
-                       "this time.  Please wait...\n");
+       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < REV_LEVEL) {
+               syslog(LOG_WARNING,
+                       "Server hosted updates need to be processed at this time.  Please wait..."
+               );
        }
        else {
                return;
@@ -304,29 +269,54 @@ void check_server_upgrades(void) {
 
        update_config();
 
-       if ((CitControl.version > 000) && (CitControl.version < 555)) {
-               CtdlLogPrintf(CTDL_EMERG,
-                       "Your data files are from a version of Citadel\n"
-                       "that is too old to be upgraded.  Sorry.\n");
+       if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 591)) {
+               syslog(LOG_EMERG, "This database is too old to be upgraded.  Citadel server will exit.");
                exit(EXIT_FAILURE);
        }
-       if ((CitControl.version > 000) && (CitControl.version < 591)) {
-               bump_mailbox_generation_numbers();
-       }
-       if ((CitControl.version > 000) && (CitControl.version < 608)) {
+       if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 608)) {
                convert_ctdluid_to_minusone();
        }
-       if ((CitControl.version > 000) && (CitControl.version < 659)) {
+       if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 659)) {
                rebuild_euid_index();
        }
-       if (CitControl.version < 735) {
+       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 735) {
                fix_sys_user_name();
        }
-       if (CitControl.version < 736) {
+       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 736) {
                rebuild_usersbynumber();
        }
-       CitControl.version = REV_LEVEL;
-       put_control();
+       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 790) {
+               remove_thread_users();
+       }
+       if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 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);
+               }
+       }
+
+       CtdlSetConfigInt("MM_hosted_upgrade_level", REV_LEVEL);
+
+       /*
+        * Negative values for maxsessions are not allowed.
+        */
+       if (CtdlGetConfigInt("c_maxsessions") < 0) {
+               CtdlSetConfigInt("c_maxsessions", 0);
+       }
+
+       /* We need a system default message expiry policy, because this is
+        * the top level and there's no 'higher' policy to fall back on.
+        * By default, do not expire messages at all.
+        */
+       if (CtdlGetConfigInt("c_ep_mode") == 0) {
+               CtdlSetConfigInt("c_ep_mode", EXPIRE_MANUAL);
+               CtdlSetConfigInt("c_ep_value", 0);
+       }
 }
 
 
@@ -334,6 +324,6 @@ CTDL_MODULE_UPGRADE(upgrade)
 {
        check_server_upgrades();
        
-       /* return our Subversion id for the Log */
-       return "$Id$";
+       /* return our module id for the Log */
+       return "upgrade";
 }