More sane behavior on a new installation
[citadel.git] / citadel / modules / upgrade / serv_upgrade.c
index 2646009c3dcefe0da675005529f15cdf54ae39c5..ebd48a213590f329fa7a85efa2fd77dee92caca0 100644 (file)
@@ -1,8 +1,15 @@
 /*
- * $Id$
- *
  * Transparently handle the upgrading of server data formats.
  *
+ * Copyright (c) 1987-2012 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.
+ *
+ * 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 "config.h"
 #include "control.h"
 #include "database.h"
-#include "room_ops.h"
 #include "user_ops.h"
 #include "msgbase.h"
 #include "serv_upgrade.h"
 #include "euidindex.h"
+#include "ctdl_module.h"
 
 
-#include "ctdl_module.h"
+/*
+ * Fix up the name for Citadel user 0 and try to remove any extra users with number 0
+ */
+void fix_sys_user_name(void)
+{
+       struct ctdluser usbuf;
+       char usernamekey[USERNAME_SIZE];
+
+       /** If we have a user called Citadel rename them to SYS_Citadel */
+       if (CtdlGetUser(&usbuf, "Citadel") == 0)
+       {
+               rename_user("Citadel", "SYS_Citadel");
+       }
+
+       while (CtdlGetUserByNumber(&usbuf, 0) == 0)
+       {
+               /* delete user with number 0 and no name */
+               if (IsEmptyStr(usbuf.fullname)) {
+                       cdb_delete(CDB_USERS, "", 0);
+               }
+               else {
+                       /* temporarily set this user to -1 */
+                       usbuf.usernum = -1;
+                       CtdlPutUser(&usbuf);
+               }
+       }
+
+       /* 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, cutuserkey(usbuf.fullname));
+                       cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
+               }
+               else {
+                       usbuf.usernum = 0;
+                       CtdlPutUser(&usbuf);
+               }
+       }
+}
 
 
 /* 
@@ -55,13 +102,12 @@ void cmd_bmbx_backend(struct ctdlroom *qrbuf, void *data) {
        struct RoomProcList *ptr;
        struct ctdlroom qr;
 
-       /* Lazy programming here.  Call this function as a ForEachRoom backend
+       /* 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));
+               ptr = (struct RoomProcList *) malloc(sizeof (struct RoomProcList));
                if (ptr == NULL) return;
 
                safestrncpy(ptr->name, qrbuf->QRname, sizeof ptr->name);
@@ -72,17 +118,17 @@ void cmd_bmbx_backend(struct ctdlroom *qrbuf, void *data) {
 
        while (rplist != NULL) {
 
-               if (lgetroom(&qr, rplist->name) == 0) {
-                       lprintf(CTDL_DEBUG, "Processing <%s>...\n", rplist->name);
+               if (CtdlGetRoomLock(&qr, rplist->name) == 0) {
+                       syslog(LOG_DEBUG, "Processing <%s>...", rplist->name);
                        if ( (qr.QRflags & QR_MAILBOX) == 0) {
-                               lprintf(CTDL_DEBUG, "  -- not a mailbox\n");
+                               syslog(LOG_DEBUG, "  -- not a mailbox");
                        }
                        else {
 
                                qr.QRgen = time(NULL);
-                               lprintf(CTDL_DEBUG, "  -- fixed!\n");
+                               syslog(LOG_DEBUG, "  -- fixed!");
                        }
-                       lputroom(&qr);
+                       CtdlPutRoomLock(&qr);
                }
 
                ptr = rplist;
@@ -95,8 +141,8 @@ void cmd_bmbx_backend(struct ctdlroom *qrbuf, void *data) {
  * quick fix to bump mailbox generation numbers
  */
 void bump_mailbox_generation_numbers(void) {
-       lprintf(CTDL_WARNING, "Applying security fix to mailbox rooms\n");
-       ForEachRoom(cmd_bmbx_backend, NULL);
+       syslog(LOG_WARNING, "Applying security fix to mailbox rooms");
+       CtdlForEachRoom(cmd_bmbx_backend, NULL);
        cmd_bmbx_backend(NULL, NULL);
        return;
 }
@@ -127,12 +173,12 @@ void cbtm_backend(struct ctdluser *usbuf, void *data) {
 
        while (uplist != NULL) {
 
-               if (lgetuser(&us, uplist->user) == 0) {
-                       lprintf(CTDL_DEBUG, "Processing <%s>...\n", uplist->user);
+               if (CtdlGetUserLock(&us, uplist->user) == 0) {
+                       syslog(LOG_DEBUG, "Processing <%s>...", uplist->user);
                        if (us.uid == CTDLUID) {
                                us.uid = (-1);
                        }
-                       lputuser(&us);
+                       CtdlPutUserLock(&us);
                }
 
                ptr = uplist;
@@ -145,14 +191,73 @@ void cbtm_backend(struct ctdluser *usbuf, void *data) {
  * quick fix to change all CTDLUID users to (-1)
  */
 void convert_ctdluid_to_minusone(void) {
-       lprintf(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]
+                       );
+               }
+       }
+}
+
+
 /*
- * Do various things to our configuration file
+ * Attempt to guess the name of the time zone currently in use
+ * on the underlying host system.
+ */
+void guess_time_zone(void) {
+       FILE *fp;
+       char buf[PATH_MAX];
+
+       fp = popen(file_guesstimezone, "r");
+       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);
+                       syslog(LOG_INFO, "Configuring timezone: %s", config.c_default_cal_zone);
+               }
+               fclose(fp);
+       }
+}
+
+
+/*
+ * 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();
@@ -170,11 +275,11 @@ void update_config(void) {
        }
 
        if (CitControl.version < 623) {
-               strcpy(config.c_ip_addr, "0.0.0.0");
+               strcpy(config.c_ip_addr, "*");
        }
 
        if (CitControl.version < 650) {
-               config.c_enable_fulltext = 0;
+               config.c_enable_fulltext = 1;
        }
 
        if (CitControl.version < 652) {
@@ -186,23 +291,31 @@ void update_config(void) {
                config.c_xmpp_s2s_port = 5269;
        }
 
+       if (IsEmptyStr(config.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();
-       lprintf(CTDL_INFO, "Server-hosted upgrade level is %d.%02d\n",
+       syslog(LOG_INFO, "Existing database version on disk is %d.%02d",
                (CitControl.version / 100),
-               (CitControl.version % 100) );
+               (CitControl.version % 100)
+       );
 
        if (CitControl.version < REV_LEVEL) {
-               lprintf(CTDL_WARNING,
-                       "Server hosted updates need to be processed at "
-                       "this time.  Please wait...\n");
+               syslog(LOG_WARNING,
+                       "Server hosted updates need to be processed at this time.  Please wait..."
+               );
        }
        else {
                return;
@@ -211,9 +324,7 @@ void check_server_upgrades(void) {
        update_config();
 
        if ((CitControl.version > 000) && (CitControl.version < 555)) {
-               lprintf(CTDL_EMERG,
-                       "Your data files are from a version of Citadel\n"
-                       "that is too old to be upgraded.  Sorry.\n");
+               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)) {
@@ -225,8 +336,33 @@ void check_server_upgrades(void) {
        if ((CitControl.version > 000) && (CitControl.version < 659)) {
                rebuild_euid_index();
        }
-
+       if (CitControl.version < 735) {
+               fix_sys_user_name();
+       }
+       if (CitControl.version < 736) {
+               rebuild_usersbynumber();
+       }
+       if (CitControl.version < 790) {
+               remove_thread_users();
+       }
        CitControl.version = REV_LEVEL;
+
+       /*
+        * Negative values for maxsessions are not allowed.
+        */
+       if (config.c_maxsessions < 0) {
+               config.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 (config.c_ep.expire_mode == 0) {
+               config.c_ep.expire_mode = EXPIRE_MANUAL;
+               config.c_ep.expire_value = 0;
+       }
+
        put_control();
 }
 
@@ -235,6 +371,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";
 }