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"
59 * oldver is the version number of Citadel Server which was active on the previous run of the program, learned from the system configuration.
60 * If we are running a new Citadel Server for the first time, oldver will be 0.
61 * We keep this value around for the entire duration of the program run because we'll need it during several stages of startup.
66 * Fix up the name for Citadel user 0 and try to remove any extra users with number 0
68 void fix_sys_user_name(void)
70 struct ctdluser usbuf;
71 char usernamekey[USERNAME_SIZE];
73 /** If we have a user called Citadel rename them to SYS_Citadel */
74 if (CtdlGetUser(&usbuf, "Citadel") == 0)
76 rename_user("Citadel", "SYS_Citadel");
79 while (CtdlGetUserByNumber(&usbuf, 0) == 0)
81 /* delete user with number 0 and no name */
82 if (IsEmptyStr(usbuf.fullname)) {
83 cdb_delete(CDB_USERS, "", 0);
86 /* temporarily set this user to -1 */
92 /* Make sure user SYS_* is user 0 */
93 while (CtdlGetUserByNumber(&usbuf, -1) == 0)
95 if (strncmp(usbuf.fullname, "SYS_", 4))
96 { /* Delete any user 0 that doesn't start with SYS_ */
97 makeuserkey(usernamekey, usbuf.fullname, cutuserkey(usbuf.fullname));
98 cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
109 * Back end processing function for reindex_uids()
110 * Call this function as a ForEachUser backend in order to queue up
111 * user names, or call it with a null user to make it do the processing.
112 * This allows us to maintain the list as a static instead of passing
115 void reindex_uids_backend(struct ctdluser *usbuf, void *data) {
116 static struct UserProcList *uplist = NULL;
117 struct UserProcList *ptr;
120 /* this is the calling mode where we add a user */
123 ptr = (struct UserProcList *) malloc(sizeof (struct UserProcList));
128 safestrncpy(ptr->user, usbuf->fullname, sizeof ptr->user);
134 /* this is the calling mode where we do the processing */
136 while (uplist != NULL) {
138 if (CtdlGetUserLock(&us, uplist->user) == 0) {
139 syslog(LOG_DEBUG, "Processing <%s> (%d)", uplist->user, us.uid);
140 if (us.uid == CTDLUID) {
141 us.uid = NATIVE_AUTH_UID;
143 CtdlPutUserLock(&us);
144 if ((us.uid > 0) && (us.uid != NATIVE_AUTH_UID)) { // if non-native auth , index by uid
146 syslog(LOG_DEBUG, "\033[31m attaching %d to %s \033[0m", us.uid , us.fullname);
149 StrBuf *claimed_id = NewStrBuf();
150 StrBufPrintf(claimed_id, "uid:%d", us.uid);
151 attach_extauth(&us, claimed_id);
152 FreeStrBuf(&claimed_id);
157 uplist = uplist->next;
163 * Build extauth index of all users with uid-based join (system auth, LDAP auth)
164 * Also changes all users with a uid of CTDLUID to NATIVE_AUTH_UID (-1)
166 void reindex_uids(void) {
167 syslog(LOG_WARNING, "upgrade: reindexing and applying uid changes");
168 ForEachUser(reindex_uids_backend, NULL);
169 reindex_uids_backend(NULL, NULL);
176 * These accounts may have been created by code that ran between mid 2008 and early 2011.
177 * If present they are no longer in use and may be deleted.
179 void remove_thread_users(void) {
180 char *deleteusers[] = {
189 "SYS_select_on_master",
194 struct ctdluser usbuf;
195 for (i=0; i<(sizeof(deleteusers)/sizeof(char *)); ++i) {
196 if (CtdlGetUser(&usbuf, deleteusers[i]) == 0) {
198 strcpy(usbuf.password, "deleteme");
201 "System user account <%s> is no longer in use and will be deleted.",
210 * Attempt to guess the name of the time zone currently in use
211 * on the underlying host system.
213 void guess_time_zone(void) {
217 fp = popen(file_guesstimezone, "r");
219 if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) {
220 buf[strlen(buf)-1] = 0;
221 CtdlSetConfigStr("c_default_cal_zone", buf);
222 syslog(LOG_INFO, "Configuring timezone: %s", buf);
230 * Per-room callback function for ingest_old_roominfo_and_roompic_files()
232 * This is the second pass, where we process the list of rooms with info or pic files.
234 void iorarf_oneroom(char *roomname, char *infofile, char *picfile)
238 char *unencoded_data;
240 long info_msgnum = 0;
244 // Test for the presence of a legacy "room info file"
245 if (!IsEmptyStr(infofile)) {
246 fp = fopen(infofile, "r");
252 fseek(fp, 0, SEEK_END);
253 data_length = ftell(fp);
255 if (data_length >= 1) {
257 unencoded_data = malloc(data_length);
258 if (unencoded_data) {
259 fread(unencoded_data, data_length, 1, fp);
260 encoded_data = malloc((data_length * 2) + 100);
262 sprintf(encoded_data, "Content-type: text/plain\nContent-transfer-encoding: base64\n\n");
263 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
264 snprintf(subject, sizeof subject, "Imported room banner for %s", roomname);
265 info_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
268 free(unencoded_data);
272 if (info_msgnum > 0) unlink(infofile);
275 // Test for the presence of a legacy "room picture file" and import it.
276 if (!IsEmptyStr(picfile)) {
277 fp = fopen(picfile, "r");
283 fseek(fp, 0, SEEK_END);
284 data_length = ftell(fp);
286 if (data_length >= 1) {
288 unencoded_data = malloc(data_length);
289 if (unencoded_data) {
290 fread(unencoded_data, data_length, 1, fp);
291 encoded_data = malloc((data_length * 2) + 100);
293 sprintf(encoded_data, "Content-type: image/gif\nContent-transfer-encoding: base64\n\n");
294 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
295 snprintf(subject, sizeof subject, "Imported room icon for %s", roomname);
296 pic_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
299 free(unencoded_data);
303 if (pic_msgnum > 0) unlink(picfile);
306 // Now we have the message numbers of our new banner and icon. Record them in the room record.
307 // NOTE: we are not deleting the old msgnum_info because that position in the record was previously
308 // a pointer to the highest message number which existed in the room when the info file was saved,
309 // and we don't want to delete messages that are not *actually* old banners.
310 struct ctdlroom qrbuf;
311 if (CtdlGetRoomLock(&qrbuf, roomname) == 0) {
312 qrbuf.msgnum_info = info_msgnum;
313 qrbuf.msgnum_pic = pic_msgnum;
314 CtdlPutRoomLock(&qrbuf);
321 struct iorarf_list *next;
322 char name[ROOMNAMELEN];
329 * Per-room callback function for ingest_old_roominfo_and_roompic_files()
331 * This is the first pass, where the list of qualifying rooms is gathered.
333 void iorarf_backend(struct ctdlroom *qrbuf, void *data)
336 struct iorarf_list **iorarf_list = (struct iorarf_list **)data;
338 struct iorarf_list *i = malloc(sizeof(struct iorarf_list));
339 i->next = *iorarf_list;
340 strcpy(i->name, qrbuf->QRname);
344 // Test for the presence of a legacy "room info file"
345 assoc_file_name(i->info, sizeof i->info, qrbuf, ctdl_info_dir);
346 fp = fopen(i->info, "r");
354 // Test for the presence of a legacy "room picture file"
355 assoc_file_name(i->pic, sizeof i->pic, qrbuf, ctdl_image_dir);
356 fp = fopen(i->pic, "r");
364 if ( (!IsEmptyStr(i->info)) || (!IsEmptyStr(i->pic)) ) {
374 * Prior to Citadel Server version 902, room info and pictures (which comprise the
375 * displayed banner for each room) were stored in the filesystem. If we are upgrading
376 * from version >000 to version >=902, ingest those files into the database.
378 void ingest_old_roominfo_and_roompic_files(void)
380 struct iorarf_list *il = NULL;
382 CtdlForEachRoom(iorarf_backend, &il);
384 struct iorarf_list *p;
386 iorarf_oneroom(il->name, il->info, il->pic);
392 unlink(ctdl_info_dir);
397 * For upgrades in which a new config setting appears for the first time, set default values.
398 * For new installations (oldver == 0) also set default values.
400 void update_config(void) {
403 CtdlSetConfigInt("c_rfc822_strict_from", 0);
407 CtdlSetConfigInt("c_purge_hour", 3);
411 CtdlSetConfigInt("c_ldap_port", 389);
415 CtdlSetConfigStr("c_ip_addr", "*");
419 CtdlSetConfigInt("c_enable_fulltext", 1);
423 CtdlSetConfigInt("c_auto_cull", 1);
427 CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
428 CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
432 CtdlSetConfigInt("c_nntp_port", 119);
433 CtdlSetConfigInt("c_nntps_port", 563);
436 if (IsEmptyStr(CtdlGetConfigStr("c_default_cal_zone"))) {
443 * Helper function for move_inet_addrs_from_vcards_to_user_records()
445 * Call this function as a ForEachUser backend in order to queue up
446 * user names, or call it with a null user to make it do the processing.
447 * This allows us to maintain the list as a static instead of passing
450 void miafvtur_backend(struct ctdluser *usbuf, void *data) {
457 static struct miafvtur *m = NULL;
458 static int num_m = 0;
459 static int alloc_m = 0;
461 /* this is the calling mode where we add a user */
464 char primary_inet_email[512] = { 0 };
465 char other_inet_emails[512] = { 0 };
466 struct vCard *v = vcard_get_user(usbuf);
468 extract_inet_email_addrs(primary_inet_email, sizeof primary_inet_email, other_inet_emails, sizeof other_inet_emails, v, 1);
471 if ( (IsEmptyStr(primary_inet_email)) && (IsEmptyStr(other_inet_emails)) ) {
475 if (num_m >= alloc_m) {
478 m = malloc(sizeof(struct miafvtur) * alloc_m);
482 m = realloc(m, (sizeof(struct miafvtur) * alloc_m));
486 strcpy(m[num_m].name, usbuf->fullname);
487 snprintf(m[num_m].emails, 512, "%s%s%s",
488 (!IsEmptyStr(primary_inet_email) ? primary_inet_email : ""),
489 ((!IsEmptyStr(primary_inet_email)&&(!IsEmptyStr(other_inet_emails))) ? "|" : ""),
490 (!IsEmptyStr(other_inet_emails) ? other_inet_emails : "")
496 /* this is the calling mode where we do the processing */
501 for (i=0; i<num_m; ++i) {
502 syslog(LOG_DEBUG, "<%s> = <%s>", m[i].name, m[i].emails);
503 if (CtdlGetUser(&u, m[i].name) == 0) {
504 safestrncpy(u.emailaddrs, m[i].emails, sizeof u.emailaddrs);
516 * Prior to version 912 we kept a user's various Internet email addresses in their vCards.
517 * This function moves them over to the user record, which is where we keep them now.
519 void move_inet_addrs_from_vcards_to_user_records(void)
521 ForEachUser(miafvtur_backend, NULL);
522 miafvtur_backend(NULL, NULL);
523 CtdlRebuildDirectoryIndex();
528 * Based on the server version number reported by the existing database,
529 * run in-place data format upgrades until everything is up to date.
531 void check_server_upgrades(void) {
533 oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
534 syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
537 if (oldver < REV_LEVEL) {
538 syslog(LOG_WARNING, "Server hosted updates need to be processed at this time. Please wait...");
544 if ((oldver > 000) && (oldver < 591)) {
545 syslog(LOG_EMERG, "This database is too old to be upgraded. Citadel server will exit.");
548 if ((oldver > 000) && (oldver < 913)) {
551 if ((oldver > 000) && (oldver < 659)) {
552 rebuild_euid_index();
558 rebuild_usersbynumber();
561 remove_thread_users();
564 struct ctdlroom QRoom;
565 if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) {
566 QRoom.QRdefaultview = VIEW_QUEUE;
571 if ((oldver > 000) && (oldver < 902)) {
572 ingest_old_roominfo_and_roompic_files();
575 if ((oldver > 000) && (oldver < 912)) {
576 move_inet_addrs_from_vcards_to_user_records();
579 CtdlSetConfigInt("MM_hosted_upgrade_level", REV_LEVEL);
582 * Negative values for maxsessions are not allowed.
584 if (CtdlGetConfigInt("c_maxsessions") < 0) {
585 CtdlSetConfigInt("c_maxsessions", 0);
588 /* We need a system default message expiry policy, because this is
589 * the top level and there's no 'higher' policy to fall back on.
590 * By default, do not expire messages at all.
592 if (CtdlGetConfigInt("c_ep_mode") == 0) {
593 CtdlSetConfigInt("c_ep_mode", EXPIRE_MANUAL);
594 CtdlSetConfigInt("c_ep_value", 0);
599 CTDL_MODULE_UPGRADE(upgrade)
601 check_server_upgrades();
603 /* return our module id for the Log */