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-2017 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"
55 #include "serv_vcard.h"
56 #include "internet_addressing.h"
60 * Fix up the name for Citadel user 0 and try to remove any extra users with number 0
62 void fix_sys_user_name(void)
64 struct ctdluser usbuf;
65 char usernamekey[USERNAME_SIZE];
67 /** If we have a user called Citadel rename them to SYS_Citadel */
68 if (CtdlGetUser(&usbuf, "Citadel") == 0)
70 rename_user("Citadel", "SYS_Citadel");
73 while (CtdlGetUserByNumber(&usbuf, 0) == 0)
75 /* delete user with number 0 and no name */
76 if (IsEmptyStr(usbuf.fullname)) {
77 cdb_delete(CDB_USERS, "", 0);
80 /* temporarily set this user to -1 */
86 /* Make sure user SYS_* is user 0 */
87 while (CtdlGetUserByNumber(&usbuf, -1) == 0)
89 if (strncmp(usbuf.fullname, "SYS_", 4))
90 { /* Delete any user 0 that doesn't start with SYS_ */
91 makeuserkey(usernamekey, usbuf.fullname, cutuserkey(usbuf.fullname));
92 cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
103 * Back end processing function for convert_ctdluid_to_minusone()
104 * Call this function as a ForEachUser backend in order to queue up
105 * room names, or call it with a null user to make it do the processing.
106 * This allows us to maintain the list as a static instead of passing
109 void cbtm_backend(struct ctdluser *usbuf, void *data) {
110 static struct UserProcList *uplist = NULL;
111 struct UserProcList *ptr;
114 /* this is the calling mode where we add a user */
117 ptr = (struct UserProcList *)
118 malloc(sizeof (struct UserProcList));
119 if (ptr == NULL) return;
121 safestrncpy(ptr->user, usbuf->fullname, sizeof ptr->user);
127 /* this is the calling mode where we do the processing */
129 while (uplist != NULL) {
131 if (CtdlGetUserLock(&us, uplist->user) == 0) {
132 syslog(LOG_DEBUG, "Processing <%s>...", uplist->user);
133 if (us.uid == CTDLUID) {
136 CtdlPutUserLock(&us);
140 uplist = uplist->next;
146 * quick fix to change all CTDLUID users to (-1)
148 void convert_ctdluid_to_minusone(void) {
149 syslog(LOG_WARNING, "Applying uid changes");
150 ForEachUser(cbtm_backend, NULL);
151 cbtm_backend(NULL, NULL);
158 * These accounts may have been created by code that ran between mid 2008 and early 2011.
159 * If present they are no longer in use and may be deleted.
161 void remove_thread_users(void) {
162 char *deleteusers[] = {
171 "SYS_select_on_master",
176 struct ctdluser usbuf;
177 for (i=0; i<(sizeof(deleteusers)/sizeof(char *)); ++i) {
178 if (CtdlGetUser(&usbuf, deleteusers[i]) == 0) {
180 strcpy(usbuf.password, "deleteme");
183 "System user account <%s> is no longer in use and will be deleted.",
192 * Attempt to guess the name of the time zone currently in use
193 * on the underlying host system.
195 void guess_time_zone(void) {
199 fp = popen(file_guesstimezone, "r");
201 if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) {
202 buf[strlen(buf)-1] = 0;
203 CtdlSetConfigStr("c_default_cal_zone", buf);
204 syslog(LOG_INFO, "Configuring timezone: %s", buf);
212 * Per-room callback function for ingest_old_roominfo_and_roompic_files()
214 * This is the second pass, where we process the list of rooms with info or pic files.
216 void iorarf_oneroom(char *roomname, char *infofile, char *picfile)
220 char *unencoded_data;
222 long info_msgnum = 0;
226 // Test for the presence of a legacy "room info file"
227 if (!IsEmptyStr(infofile)) {
228 fp = fopen(infofile, "r");
234 fseek(fp, 0, SEEK_END);
235 data_length = ftell(fp);
237 if (data_length >= 1) {
239 unencoded_data = malloc(data_length);
240 if (unencoded_data) {
241 fread(unencoded_data, data_length, 1, fp);
242 encoded_data = malloc((data_length * 2) + 100);
244 sprintf(encoded_data, "Content-type: text/plain\nContent-transfer-encoding: base64\n\n");
245 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
246 snprintf(subject, sizeof subject, "Imported room banner for %s", roomname);
247 info_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
250 free(unencoded_data);
254 if (info_msgnum > 0) unlink(infofile);
257 // Test for the presence of a legacy "room picture file" and import it.
258 if (!IsEmptyStr(picfile)) {
259 fp = fopen(picfile, "r");
265 fseek(fp, 0, SEEK_END);
266 data_length = ftell(fp);
268 if (data_length >= 1) {
270 unencoded_data = malloc(data_length);
271 if (unencoded_data) {
272 fread(unencoded_data, data_length, 1, fp);
273 encoded_data = malloc((data_length * 2) + 100);
275 sprintf(encoded_data, "Content-type: image/gif\nContent-transfer-encoding: base64\n\n");
276 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
277 snprintf(subject, sizeof subject, "Imported room icon for %s", roomname);
278 pic_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
281 free(unencoded_data);
285 if (pic_msgnum > 0) unlink(picfile);
288 // Now we have the message numbers of our new banner and icon. Record them in the room record.
289 // NOTE: we are not deleting the old msgnum_info because that position in the record was previously
290 // a pointer to the highest message number which existed in the room when the info file was saved,
291 // and we don't want to delete messages that are not *actually* old banners.
292 struct ctdlroom qrbuf;
293 if (CtdlGetRoomLock(&qrbuf, roomname) == 0) {
294 qrbuf.msgnum_info = info_msgnum;
295 qrbuf.msgnum_pic = pic_msgnum;
296 CtdlPutRoomLock(&qrbuf);
303 struct iorarf_list *next;
304 char name[ROOMNAMELEN];
311 * Per-room callback function for ingest_old_roominfo_and_roompic_files()
313 * This is the first pass, where the list of qualifying rooms is gathered.
315 void iorarf_backend(struct ctdlroom *qrbuf, void *data)
318 struct iorarf_list **iorarf_list = (struct iorarf_list **)data;
320 struct iorarf_list *i = malloc(sizeof(struct iorarf_list));
321 i->next = *iorarf_list;
322 strcpy(i->name, qrbuf->QRname);
326 // Test for the presence of a legacy "room info file"
327 assoc_file_name(i->info, sizeof i->info, qrbuf, ctdl_info_dir);
328 fp = fopen(i->info, "r");
336 // Test for the presence of a legacy "room picture file"
337 assoc_file_name(i->pic, sizeof i->pic, qrbuf, ctdl_image_dir);
338 fp = fopen(i->pic, "r");
346 if ( (!IsEmptyStr(i->info)) || (!IsEmptyStr(i->pic)) ) {
356 * Prior to Citadel Server version 902, room info and pictures (which comprise the
357 * displayed banner for each room) were stored in the filesystem. If we are upgrading
358 * from version >000 to version >=902, ingest those files into the database.
360 void ingest_old_roominfo_and_roompic_files(void)
362 struct iorarf_list *il = NULL;
364 CtdlForEachRoom(iorarf_backend, &il);
366 struct iorarf_list *p;
368 iorarf_oneroom(il->name, il->info, il->pic);
374 unlink(ctdl_info_dir);
379 * Perform any upgrades that can be done automatically based on our knowledge of the previous
380 * version of Citadel server that was running here.
382 * Note that if the previous version was 0 then this is a new installation running for the first time.
384 void update_config(void) {
386 int oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
389 CtdlSetConfigInt("c_rfc822_strict_from", 0);
393 CtdlSetConfigInt("c_purge_hour", 3);
397 CtdlSetConfigInt("c_ldap_port", 389);
401 CtdlSetConfigStr("c_ip_addr", "*");
405 CtdlSetConfigInt("c_enable_fulltext", 1);
409 CtdlSetConfigInt("c_auto_cull", 1);
413 CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
414 CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
418 CtdlSetConfigInt("c_nntp_port", 119);
419 CtdlSetConfigInt("c_nntps_port", 563);
422 if (IsEmptyStr(CtdlGetConfigStr("c_default_cal_zone"))) {
429 * Helper function for move_inet_addrs_from_vcards_to_user_records()
431 * Call this function as a ForEachUser backend in order to queue up
432 * room names, or call it with a null user to make it do the processing.
433 * This allows us to maintain the list as a static instead of passing
436 void miafvtur_backend(struct ctdluser *usbuf, void *data) {
443 static struct miafvtur *m = NULL;
444 static int num_m = 0;
445 static int alloc_m = 0;
447 /* this is the calling mode where we add a user */
450 char primary_inet_email[512] = { 0 };
451 char other_inet_emails[512] = { 0 };
452 struct vCard *v = vcard_get_user(usbuf);
454 extract_inet_email_addrs(primary_inet_email, sizeof primary_inet_email, other_inet_emails, sizeof other_inet_emails, v, 1);
457 if ( (IsEmptyStr(primary_inet_email)) && (IsEmptyStr(other_inet_emails)) ) {
461 if (num_m >= alloc_m) {
464 m = malloc(sizeof(struct miafvtur) * alloc_m);
468 m = realloc(m, (sizeof(struct miafvtur) * alloc_m));
472 strcpy(m[num_m].name, usbuf->fullname);
473 snprintf(m[num_m].emails, 512, "%s%s%s",
474 (!IsEmptyStr(primary_inet_email) ? primary_inet_email : ""),
475 ((!IsEmptyStr(primary_inet_email)&&(!IsEmptyStr(other_inet_emails))) ? "|" : ""),
476 (!IsEmptyStr(other_inet_emails) ? other_inet_emails : "")
482 /* this is the calling mode where we do the processing */
487 CtdlRebuildDirectoryIndex();
489 for (i=0; i<num_m; ++i) {
490 syslog(LOG_DEBUG, "<%s> = <%s>", m[i].name, m[i].emails);
491 if (CtdlGetUser(&u, m[i].name) == 0) {
492 safestrncpy(u.emailaddrs, m[i].emails, sizeof u.emailaddrs);
505 * Prior to version 912 we kept a user's various Internet email addresses in their vCards.
506 * This function moves them over to the user record, which is where we keep them now.
508 void move_inet_addrs_from_vcards_to_user_records(void)
510 ForEachUser(miafvtur_backend, NULL);
511 miafvtur_backend(NULL, NULL);
516 * Based on the server version number reported by the existing database,
517 * run in-place data format upgrades until everything is up to date.
519 void check_server_upgrades(void) {
521 syslog(LOG_INFO, "Existing database version on disk is %d", CtdlGetConfigInt("MM_hosted_upgrade_level"));
523 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < REV_LEVEL) {
524 syslog(LOG_WARNING, "Server hosted updates need to be processed at this time. Please wait...");
532 if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 591)) {
533 syslog(LOG_EMERG, "This database is too old to be upgraded. Citadel server will exit.");
536 if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 608)) {
537 convert_ctdluid_to_minusone();
539 if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 659)) {
540 rebuild_euid_index();
542 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 735) {
545 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 736) {
546 rebuild_usersbynumber();
548 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 790) {
549 remove_thread_users();
551 if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 810) {
552 struct ctdlroom QRoom;
553 if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) {
554 QRoom.QRdefaultview = VIEW_QUEUE;
557 if (!CtdlGetRoom(&QRoom, FNBL_QUEUE_ROOM)) {
558 QRoom.QRdefaultview = VIEW_QUEUE;
563 if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 902)) {
564 ingest_old_roominfo_and_roompic_files();
567 if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 912)) {
568 move_inet_addrs_from_vcards_to_user_records();
571 CtdlSetConfigInt("MM_hosted_upgrade_level", REV_LEVEL);
574 * Negative values for maxsessions are not allowed.
576 if (CtdlGetConfigInt("c_maxsessions") < 0) {
577 CtdlSetConfigInt("c_maxsessions", 0);
580 /* We need a system default message expiry policy, because this is
581 * the top level and there's no 'higher' policy to fall back on.
582 * By default, do not expire messages at all.
584 if (CtdlGetConfigInt("c_ep_mode") == 0) {
585 CtdlSetConfigInt("c_ep_mode", EXPIRE_MANUAL);
586 CtdlSetConfigInt("c_ep_value", 0);
591 CTDL_MODULE_UPGRADE(upgrade)
593 check_server_upgrades();
595 /* return our module id for the Log */