citadel/modules/upgrade/serv_upgrade.c

   1 /*
   2  * $Id$
   3  *
   4  * Transparently handle the upgrading of server data formats.
   5  *
   6  * Copyright (c) 1987-2009 by the citadel.org team
   7  *
   8  *  This program is free software; you can redistribute it and/or modify
   9  *  it under the terms of the GNU General Public License as published by
  10  *  the Free Software Foundation; either version 3 of the License, or
  11  *  (at your option) any later version.
  12  *
  13  *  This program is distributed in the hope that it will be useful,
  14  *  but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  16  *  GNU General Public License for more details.
  17  *
  18  *  You should have received a copy of the GNU General Public License
  19  *  along with this program; if not, write to the Free Software
  20  *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  21  */
  22
  23 #include "sysdep.h"
  24 #include <stdlib.h>
  25 #include <unistd.h>
  26 #include <stdio.h>
  27 #include <fcntl.h>
  28 #include <signal.h>
  29 #include <pwd.h>
  30 #include <errno.h>
  31 #include <sys/types.h>
  32
  33 #if TIME_WITH_SYS_TIME
  34 # include <sys/time.h>
  35 # include <time.h>
  36 #else
  37 # if HAVE_SYS_TIME_H
  38 #  include <sys/time.h>
  39 # else
  40 #  include <time.h>
  41 # endif
  42 #endif
  43
  44 #include <sys/wait.h>
  45 #include <string.h>
  46 #include <limits.h>
  47 #include <libcitadel.h>
  48 #include "citadel.h"
  49 #include "server.h"
  50 #include "citserver.h"
  51 #include "support.h"
  52 #include "config.h"
  53 #include "control.h"
  54 #include "database.h"
  55 #include "user_ops.h"
  56 #include "msgbase.h"
  57 #include "serv_upgrade.h"
  58 #include "euidindex.h"
  59
  60
  61 #include "ctdl_module.h"
  62
  63
  64
  65 /*
  66  * Fix up the name for Citadel user 0 and try to remove any extra users with number 0
  67  */
  68 void fix_sys_user_name(void)
  69 {
  70         struct ctdluser usbuf;
  71         char usernamekey[USERNAME_SIZE];
  72
  73         /** If we have a user called Citadel rename them to SYS_Citadel */
  74         if (getuser(&usbuf, "Citadel") == 0)
  75         {
  76                 rename_user("Citadel", "SYS_Citadel");
  77         }
  78
  79         while (getuserbynumber(&usbuf, 0) == 0)
  80         {
  81                 /* delete user with number 0 and no name */
  82                 if (IsEmptyStr(usbuf.fullname))
  83                         cdb_delete(CDB_USERS, "", 0);
  84                 else
  85                 { /* temporarily set this user to -1 */
  86                         usbuf.usernum = -1;
  87                         putuser(&usbuf);
  88                 }
  89         }
  90
  91         /** Make sure user SYS_* is user 0 */
  92         while (getuserbynumber(&usbuf, -1) == 0)
  93         {
  94                 if (strncmp(usbuf.fullname, "SYS_", 4))
  95                 {       /** Delete any user 0 that doesn't start with SYS_ */
  96                         makeuserkey(usernamekey, usbuf.fullname);
  97                         cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
  98                 }
  99                 else
 100                 {
 101                         usbuf.usernum = 0;
 102                         putuser(&usbuf);
 103                 }
 104         }
 105 }
 106
 107
 108 /*
 109  * Back end processing function for cmd_bmbx
 110  */
 111 void cmd_bmbx_backend(struct ctdlroom *qrbuf, void *data) {
 112         static struct RoomProcList *rplist = NULL;
 113         struct RoomProcList *ptr;
 114         struct ctdlroom qr;
 115
 116         /* Lazy programming here.  Call this function as a CtdlForEachRoom backend
 117          * in order to queue up the room names, or call it with a null room
 118          * to make it do the processing.
 119          */
 120         if (qrbuf != NULL) {
 121                 ptr = (struct RoomProcList *)
 122                         malloc(sizeof (struct RoomProcList));
 123                 if (ptr == NULL) return;
 124
 125                 safestrncpy(ptr->name, qrbuf->QRname, sizeof ptr->name);
 126                 ptr->next = rplist;
 127                 rplist = ptr;
 128                 return;
 129         }
 130
 131         while (rplist != NULL) {
 132
 133                 if (CtdlGetRoomLock(&qr, rplist->name) == 0) {
 134                         CtdlLogPrintf(CTDL_DEBUG, "Processing <%s>...\n", rplist->name);
 135                         if ( (qr.QRflags & QR_MAILBOX) == 0) {
 136                                 CtdlLogPrintf(CTDL_DEBUG, "  -- not a mailbox\n");
 137                         }
 138                         else {
 139
 140                                 qr.QRgen = time(NULL);
 141                                 CtdlLogPrintf(CTDL_DEBUG, "  -- fixed!\n");
 142                         }
 143                         CtdlPutRoomLock(&qr);
 144                 }
 145
 146                 ptr = rplist;
 147                 rplist = rplist->next;
 148                 free(ptr);
 149         }
 150 }
 151
 152 /*
 153  * quick fix to bump mailbox generation numbers
 154  */
 155 void bump_mailbox_generation_numbers(void) {
 156         CtdlLogPrintf(CTDL_WARNING, "Applying security fix to mailbox rooms\n");
 157         CtdlForEachRoom(cmd_bmbx_backend, NULL);
 158         cmd_bmbx_backend(NULL, NULL);
 159         return;
 160 }
 161
 162
 163 /*
 164  * Back end processing function for convert_ctdluid_to_minusone()
 165  */
 166 void cbtm_backend(struct ctdluser *usbuf, void *data) {
 167         static struct UserProcList *uplist = NULL;
 168         struct UserProcList *ptr;
 169         struct ctdluser us;
 170
 171         /* Lazy programming here.  Call this function as a ForEachUser backend
 172          * in order to queue up the room names, or call it with a null user
 173          * to make it do the processing.
 174          */
 175         if (usbuf != NULL) {
 176                 ptr = (struct UserProcList *)
 177                         malloc(sizeof (struct UserProcList));
 178                 if (ptr == NULL) return;
 179
 180                 safestrncpy(ptr->user, usbuf->fullname, sizeof ptr->user);
 181                 ptr->next = uplist;
 182                 uplist = ptr;
 183                 return;
 184         }
 185
 186         while (uplist != NULL) {
 187
 188                 if (lgetuser(&us, uplist->user) == 0) {
 189                         CtdlLogPrintf(CTDL_DEBUG, "Processing <%s>...\n", uplist->user);
 190                         if (us.uid == CTDLUID) {
 191                                 us.uid = (-1);
 192                         }
 193                         lputuser(&us);
 194                 }
 195
 196                 ptr = uplist;
 197                 uplist = uplist->next;
 198                 free(ptr);
 199         }
 200 }
 201
 202 /*
 203  * quick fix to change all CTDLUID users to (-1)
 204  */
 205 void convert_ctdluid_to_minusone(void) {
 206         CtdlLogPrintf(CTDL_WARNING, "Applying uid changes\n");
 207         ForEachUser(cbtm_backend, NULL);
 208         cbtm_backend(NULL, NULL);
 209         return;
 210 }
 211
 212
 213 /*
 214  * Attempt to guess the name of the time zone currently in use
 215  * on the underlying host system.
 216  */
 217 void guess_time_zone(void) {
 218         FILE *fp;
 219         char buf[PATH_MAX];
 220
 221         fp = popen(file_guesstimezone, "r");
 222         if (fp) {
 223                 if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) {
 224                         buf[strlen(buf)-1] = 0;
 225                         safestrncpy(config.c_default_cal_zone, buf, sizeof config.c_default_cal_zone);
 226                         CtdlLogPrintf(CTDL_INFO, "Configuring timezone: %s\n", config.c_default_cal_zone);
 227                 }
 228                 fclose(fp);
 229         }
 230 }
 231
 232
 233 /*
 234  * Do various things to our configuration file
 235  */
 236 void update_config(void) {
 237         get_config();
 238
 239         if (CitControl.version < 606) {
 240                 config.c_rfc822_strict_from = 0;
 241         }
 242
 243         if (CitControl.version < 609) {
 244                 config.c_purge_hour = 3;
 245         }
 246
 247         if (CitControl.version < 615) {
 248                 config.c_ldap_port = 389;
 249         }
 250
 251         if (CitControl.version < 623) {
 252                 strcpy(config.c_ip_addr, "0.0.0.0");
 253         }
 254
 255         if (CitControl.version < 650) {
 256                 config.c_enable_fulltext = 0;
 257         }
 258
 259         if (CitControl.version < 652) {
 260                 config.c_auto_cull = 1;
 261         }
 262
 263         if (CitControl.version < 725) {
 264                 config.c_xmpp_c2s_port = 5222;
 265                 config.c_xmpp_s2s_port = 5269;
 266         }
 267
 268         /* Erase LDAP config that might be left over from the old connector
 269          * which served a different purpose.
 270          */
 271         if (CitControl.version < 760) {
 272                 strcpy(config.c_ldap_host, "");
 273                 config.c_ldap_port = 389;
 274                 strcpy(config.c_ldap_base_dn, "");
 275                 strcpy(config.c_ldap_bind_dn, "");
 276                 strcpy(config.c_ldap_bind_pw, "");
 277         }
 278
 279         if (IsEmptyStr(config.c_default_cal_zone)) {
 280                 guess_time_zone();
 281         }
 282
 283         put_config();
 284 }
 285
 286
 287
 288
 289 void check_server_upgrades(void) {
 290
 291         get_control();
 292         CtdlLogPrintf(CTDL_INFO, "Server-hosted upgrade level is %d.%02d\n",
 293                 (CitControl.version / 100),
 294                 (CitControl.version % 100) );
 295
 296         if (CitControl.version < REV_LEVEL) {
 297                 CtdlLogPrintf(CTDL_WARNING,
 298                         "Server hosted updates need to be processed at "
 299                         "this time.  Please wait...\n");
 300         }
 301         else {
 302                 return;
 303         }
 304
 305         update_config();
 306
 307         if ((CitControl.version > 000) && (CitControl.version < 555)) {
 308                 CtdlLogPrintf(CTDL_EMERG,
 309                         "Your data files are from a version of Citadel\n"
 310                         "that is too old to be upgraded.  Sorry.\n");
 311                 exit(EXIT_FAILURE);
 312         }
 313         if ((CitControl.version > 000) && (CitControl.version < 591)) {
 314                 bump_mailbox_generation_numbers();
 315         }
 316         if ((CitControl.version > 000) && (CitControl.version < 608)) {
 317                 convert_ctdluid_to_minusone();
 318         }
 319         if ((CitControl.version > 000) && (CitControl.version < 659)) {
 320                 rebuild_euid_index();
 321         }
 322         if (CitControl.version < 735) {
 323                 fix_sys_user_name();
 324         }
 325         if (CitControl.version < 736) {
 326                 rebuild_usersbynumber();
 327         }
 328         CitControl.version = REV_LEVEL;
 329         put_control();
 330 }
 331
 332
 333 CTDL_MODULE_UPGRADE(upgrade)
 334 {
 335         check_server_upgrades();
 336
 337         /* return our Subversion id for the Log */
 338         return "$Id$";
 339 }