2 * Transparently handle the upgrading of server data formats. If we see
3 * an existing version number of our database, we can make some intelligent
4 * guesses about what kind of data format changes need to be applied, and
5 * we apply them transparently.
7 * Copyright (c) 1987-2016 by the citadel.org team
9 * This program is open source software; you can redistribute it and/or
10 * modify it under the terms of the GNU General Public License version 3.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
26 #include <sys/types.h>
28 #if TIME_WITH_SYS_TIME
29 # include <sys/time.h>
33 # include <sys/time.h>
42 #include <libcitadel.h>
45 #include "citserver.h"
52 #include "serv_upgrade.h"
53 #include "euidindex.h"
54 #include "ctdl_module.h"
58 * Fix up the name for Citadel user 0 and try to remove any extra users with number 0
60 void fix_sys_user_name(void)
62 struct ctdluser usbuf;
63 char usernamekey[USERNAME_SIZE];
65 /** If we have a user called Citadel rename them to SYS_Citadel */
66 if (CtdlGetUser(&usbuf, "Citadel") == 0)
68 rename_user("Citadel", "SYS_Citadel");
71 while (CtdlGetUserByNumber(&usbuf, 0) == 0)
73 /* delete user with number 0 and no name */
74 if (IsEmptyStr(usbuf.fullname)) {
75 cdb_delete(CDB_USERS, "", 0);
78 /* temporarily set this user to -1 */
84 /* Make sure user SYS_* is user 0 */
85 while (CtdlGetUserByNumber(&usbuf, -1) == 0)
87 if (strncmp(usbuf.fullname, "SYS_", 4))
88 { /* Delete any user 0 that doesn't start with SYS_ */
89 makeuserkey(usernamekey, usbuf.fullname, cutuserkey(usbuf.fullname));
90 cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
101 * Back end processing function for convert_ctdluid_to_minusone()
103 void cbtm_backend(struct ctdluser *usbuf, void *data) {
104 static struct UserProcList *uplist = NULL;
105 struct UserProcList *ptr;
108 /* Lazy programming here. Call this function as a ForEachUser backend
109 * in order to queue up the room names, or call it with a null user
110 * to make it do the processing.
113 ptr = (struct UserProcList *)
114 malloc(sizeof (struct UserProcList));
115 if (ptr == NULL) return;
117 safestrncpy(ptr->user, usbuf->fullname, sizeof ptr->user);
123 while (uplist != NULL) {
125 if (CtdlGetUserLock(&us, uplist->user) == 0) {
126 syslog(LOG_DEBUG, "Processing <%s>...", uplist->user);
127 if (us.uid == CTDLUID) {
130 CtdlPutUserLock(&us);
134 uplist = uplist->next;
140 * quick fix to change all CTDLUID users to (-1)
142 void convert_ctdluid_to_minusone(void) {
143 syslog(LOG_WARNING, "Applying uid changes");
144 ForEachUser(cbtm_backend, NULL);
145 cbtm_backend(NULL, NULL);
152 * These accounts may have been created by code that ran between mid 2008 and early 2011.
153 * If present they are no longer in use and may be deleted.
155 void remove_thread_users(void) {
156 char *deleteusers[] = {
165 "SYS_select_on_master",
170 struct ctdluser usbuf;
171 for (i=0; i<(sizeof(deleteusers)/sizeof(char *)); ++i) {
172 if (CtdlGetUser(&usbuf, deleteusers[i]) == 0) {
174 strcpy(usbuf.password, "deleteme");
177 "System user account <%s> is no longer in use and will be deleted.",
186 * Attempt to guess the name of the time zone currently in use
187 * on the underlying host system.
189 void guess_time_zone(void) {
193 fp = popen(file_guesstimezone, "r");
195 if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) {
196 buf[strlen(buf)-1] = 0;
197 CtdlSetConfigStr("c_default_cal_zone", buf);
198 syslog(LOG_INFO, "Configuring timezone: %s", buf);
207 * Per-room callback function for ingest_old_roominfo_and_roompic_files()
209 * This is the second pass, where we process the list of rooms with info or pic files.
211 void iorarf_oneroom(char *roomname, char *infofile, char *picfile)
215 char *unencoded_data;
217 long info_msgnum = 0;
221 syslog(LOG_DEBUG, "iorarf_oneroom( %s , %s , %s )", roomname, infofile, picfile);
223 // Test for the presence of a legacy "room info file"
224 if (!IsEmptyStr(infofile)) {
225 fp = fopen(infofile, "r");
231 fseek(fp, 0, SEEK_END);
232 data_length = ftell(fp);
234 if (data_length >= 1) {
236 unencoded_data = malloc(data_length);
237 if (unencoded_data) {
238 fread(unencoded_data, data_length, 1, fp);
239 encoded_data = malloc((data_length * 2) + 100);
241 sprintf(encoded_data, "Content-type: text/plain\nContent-transfer-encoding: base64\n\n");
242 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
243 snprintf(subject, sizeof subject, "Imported room banner for %s", roomname);
244 info_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
247 free(unencoded_data);
254 // Test for the presence of a legacy "room picture file" and import it.
255 if (!IsEmptyStr(picfile)) {
256 fp = fopen(picfile, "r");
262 fseek(fp, 0, SEEK_END);
263 data_length = ftell(fp);
265 if (data_length >= 1) {
267 unencoded_data = malloc(data_length);
268 if (unencoded_data) {
269 fread(unencoded_data, data_length, 1, fp);
270 encoded_data = malloc((data_length * 2) + 100);
272 sprintf(encoded_data, "Content-type: image/gif\nContent-transfer-encoding: base64\n\n");
273 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
274 snprintf(subject, sizeof subject, "Imported room icon for %s", roomname);
275 pic_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
278 free(unencoded_data);
285 // Now we have the message numbers of our new banner and icon. Record them in the room record.
286 // NOTE: we are not deleting the old msgnum_info because that position in the record was previously
287 // a pointer to the highest message number which existed in the room when the info file was saved,
288 // and we don't want to delete messages that are not *actually* old banners.
289 struct ctdlroom qrbuf;
290 if (CtdlGetRoomLock(&qrbuf, roomname) == 0) {
291 qrbuf.msgnum_info = info_msgnum;
292 qrbuf.msgnum_pic = pic_msgnum;
293 CtdlPutRoomLock(&qrbuf);
301 struct iorarf_list *next;
302 char name[ROOMNAMELEN];
309 * Per-room callback function for ingest_old_roominfo_and_roompic_files()
311 * This is the first pass, where the list of qualifying rooms is gathered.
313 void iorarf_backend(struct ctdlroom *qrbuf, void *data)
316 struct iorarf_list **iorarf_list = (struct iorarf_list **)data;
318 struct iorarf_list *i = malloc(sizeof(struct iorarf_list));
319 i->next = *iorarf_list;
320 strcpy(i->name, qrbuf->QRname);
324 // Test for the presence of a legacy "room info file"
325 assoc_file_name(i->info, sizeof i->info, qrbuf, ctdl_info_dir);
326 fp = fopen(i->info, "r");
334 // Test for the presence of a legacy "room picture file"
335 assoc_file_name(i->pic, sizeof i->pic, qrbuf, ctdl_image_dir);
336 fp = fopen(i->pic, "r");
344 if ( (!IsEmptyStr(i->info)) || (!IsEmptyStr(i->pic)) ) {
354 * Prior to Citadel Server version 902, room info and pictures (which comprise the
355 * displayed banner for each room) were stored in the filesystem. If we are upgrading
356 * from version >000 to version >=902, ingest those files into the database.
358 void ingest_old_roominfo_and_roompic_files(void)
360 struct iorarf_list *il = NULL;
362 CtdlForEachRoom(iorarf_backend, &il);
364 struct iorarf_list *p;
366 iorarf_oneroom(il->name, il->info, il->pic);
376 * Perform any upgrades that can be done automatically based on our knowledge of the previous
377 * version of Citadel server that was running here.
379 * Note that if the previous version was 0 then this is a new installation running for the first time.
381 void update_config(void) {
383 int oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
386 CtdlSetConfigInt("c_rfc822_strict_from", 0);
390 CtdlSetConfigInt("c_purge_hour", 3);
394 CtdlSetConfigInt("c_ldap_port", 389);
398 CtdlSetConfigStr("c_ip_addr", "*");
402 CtdlSetConfigInt("c_enable_fulltext", 1);
406 CtdlSetConfigInt("c_auto_cull", 1);
410 CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
411 CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
415 CtdlSetConfigInt("c_nntp_port", 119);
416 CtdlSetConfigInt("c_nntps_port", 563);
419 if (IsEmptyStr(CtdlGetConfigStr("c_default_cal_zone"))) {
427 * Based on the server version number reported by the existing database,
428 * run in-place data format upgrades until everything is up to date.
430 void check_server_upgrades(void) {
432 syslog(LOG_INFO, "Existing database version on disk is %d", CtdlGetConfigInt("MM_hosted_upgrade_level"));
434 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < REV_LEVEL) {
436 "Server hosted updates need to be processed at this time. Please wait..."
445 if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 591)) {
446 syslog(LOG_EMERG, "This database is too old to be upgraded. Citadel server will exit.");
449 if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 608)) {
450 convert_ctdluid_to_minusone();
452 if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 659)) {
453 rebuild_euid_index();
455 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 735) {
458 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 736) {
459 rebuild_usersbynumber();
461 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 790) {
462 remove_thread_users();
464 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 810) {
465 struct ctdlroom QRoom;
466 if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) {
467 QRoom.QRdefaultview = VIEW_QUEUE;
470 if (!CtdlGetRoom(&QRoom, FNBL_QUEUE_ROOM)) {
471 QRoom.QRdefaultview = VIEW_QUEUE;
476 if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 902)) {
477 ingest_old_roominfo_and_roompic_files();
480 CtdlSetConfigInt("MM_hosted_upgrade_level", REV_LEVEL);
483 * Negative values for maxsessions are not allowed.
485 if (CtdlGetConfigInt("c_maxsessions") < 0) {
486 CtdlSetConfigInt("c_maxsessions", 0);
489 /* We need a system default message expiry policy, because this is
490 * the top level and there's no 'higher' policy to fall back on.
491 * By default, do not expire messages at all.
493 if (CtdlGetConfigInt("c_ep_mode") == 0) {
494 CtdlSetConfigInt("c_ep_mode", EXPIRE_MANUAL);
495 CtdlSetConfigInt("c_ep_value", 0);
500 CTDL_MODULE_UPGRADE(upgrade)
502 check_server_upgrades();
503 ingest_old_roominfo_and_roompic_files(); // FIXME remove this line, it's proper above!!!!
505 /* return our module id for the Log */