2 * Transparently handle the upgrading of server data formats.
4 * Copyright (c) 1987-2010 by the citadel.org team
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 3 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License
17 * along with this program; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
29 #include <sys/types.h>
31 #if TIME_WITH_SYS_TIME
32 # include <sys/time.h>
36 # include <sys/time.h>
45 #include <libcitadel.h>
48 #include "citserver.h"
55 #include "serv_upgrade.h"
56 #include "euidindex.h"
59 #include "ctdl_module.h"
64 * Fix up the name for Citadel user 0 and try to remove any extra users with number 0
66 void fix_sys_user_name(void)
68 struct ctdluser usbuf;
69 char usernamekey[USERNAME_SIZE];
71 /** If we have a user called Citadel rename them to SYS_Citadel */
72 if (CtdlGetUser(&usbuf, "Citadel") == 0)
74 rename_user("Citadel", "SYS_Citadel");
77 while (CtdlGetUserByNumber(&usbuf, 0) == 0)
79 /* delete user with number 0 and no name */
80 if (IsEmptyStr(usbuf.fullname))
81 cdb_delete(CDB_USERS, "", 0);
83 { /* temporarily set this user to -1 */
89 /** Make sure user SYS_* is user 0 */
90 while (CtdlGetUserByNumber(&usbuf, -1) == 0)
92 if (strncmp(usbuf.fullname, "SYS_", 4))
93 { /** Delete any user 0 that doesn't start with SYS_ */
94 makeuserkey(usernamekey,
96 cutuserkey(usbuf.fullname));
97 cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
109 * Back end processing function for cmd_bmbx
111 void cmd_bmbx_backend(struct ctdlroom *qrbuf, void *data) {
112 static struct RoomProcList *rplist = NULL;
113 struct RoomProcList *ptr;
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.
121 ptr = (struct RoomProcList *)
122 malloc(sizeof (struct RoomProcList));
123 if (ptr == NULL) return;
125 safestrncpy(ptr->name, qrbuf->QRname, sizeof ptr->name);
131 while (rplist != NULL) {
133 if (CtdlGetRoomLock(&qr, rplist->name) == 0) {
134 syslog(LOG_DEBUG, "Processing <%s>...\n", rplist->name);
135 if ( (qr.QRflags & QR_MAILBOX) == 0) {
136 syslog(LOG_DEBUG, " -- not a mailbox\n");
140 qr.QRgen = time(NULL);
141 syslog(LOG_DEBUG, " -- fixed!\n");
143 CtdlPutRoomLock(&qr);
147 rplist = rplist->next;
153 * quick fix to bump mailbox generation numbers
155 void bump_mailbox_generation_numbers(void) {
156 syslog(LOG_WARNING, "Applying security fix to mailbox rooms\n");
157 CtdlForEachRoom(cmd_bmbx_backend, NULL);
158 cmd_bmbx_backend(NULL, NULL);
164 * Back end processing function for convert_ctdluid_to_minusone()
166 void cbtm_backend(struct ctdluser *usbuf, void *data) {
167 static struct UserProcList *uplist = NULL;
168 struct UserProcList *ptr;
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.
176 ptr = (struct UserProcList *)
177 malloc(sizeof (struct UserProcList));
178 if (ptr == NULL) return;
180 safestrncpy(ptr->user, usbuf->fullname, sizeof ptr->user);
186 while (uplist != NULL) {
188 if (CtdlGetUserLock(&us, uplist->user) == 0) {
189 syslog(LOG_DEBUG, "Processing <%s>...\n", uplist->user);
190 if (us.uid == CTDLUID) {
193 CtdlPutUserLock(&us);
197 uplist = uplist->next;
203 * quick fix to change all CTDLUID users to (-1)
205 void convert_ctdluid_to_minusone(void) {
206 syslog(LOG_WARNING, "Applying uid changes\n");
207 ForEachUser(cbtm_backend, NULL);
208 cbtm_backend(NULL, NULL);
214 * Attempt to guess the name of the time zone currently in use
215 * on the underlying host system.
217 void guess_time_zone(void) {
221 fp = popen(file_guesstimezone, "r");
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 syslog(LOG_INFO, "Configuring timezone: %s\n", config.c_default_cal_zone);
234 * Do various things to our configuration file
236 void update_config(void) {
239 if (CitControl.version < 606) {
240 config.c_rfc822_strict_from = 0;
243 if (CitControl.version < 609) {
244 config.c_purge_hour = 3;
247 if (CitControl.version < 615) {
248 config.c_ldap_port = 389;
251 if (CitControl.version < 623) {
252 strcpy(config.c_ip_addr, "*");
255 if (CitControl.version < 650) {
256 config.c_enable_fulltext = 0;
259 if (CitControl.version < 652) {
260 config.c_auto_cull = 1;
263 if (CitControl.version < 725) {
264 config.c_xmpp_c2s_port = 5222;
265 config.c_xmpp_s2s_port = 5269;
268 if (IsEmptyStr(config.c_default_cal_zone)) {
278 void check_server_upgrades(void) {
281 syslog(LOG_INFO, "Server-hosted upgrade level is %d.%02d\n",
282 (CitControl.version / 100),
283 (CitControl.version % 100) );
285 if (CitControl.version < REV_LEVEL) {
287 "Server hosted updates need to be processed at "
288 "this time. Please wait...\n");
296 if ((CitControl.version > 000) && (CitControl.version < 555)) {
298 "Your data files are from a version of Citadel\n"
299 "that is too old to be upgraded. Sorry.\n");
302 if ((CitControl.version > 000) && (CitControl.version < 591)) {
303 bump_mailbox_generation_numbers();
305 if ((CitControl.version > 000) && (CitControl.version < 608)) {
306 convert_ctdluid_to_minusone();
308 if ((CitControl.version > 000) && (CitControl.version < 659)) {
309 rebuild_euid_index();
311 if (CitControl.version < 735) {
314 if (CitControl.version < 736) {
315 rebuild_usersbynumber();
317 CitControl.version = REV_LEVEL;
322 CTDL_MODULE_UPGRADE(upgrade)
324 check_server_upgrades();
326 /* return our Subversion id for the Log */