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
145 StrBuf *claimed_id = NewStrBuf();
146 StrBufPrintf(claimed_id, "uid:%d", us.uid);
147 attach_extauth(&us, claimed_id);
148 FreeStrBuf(&claimed_id);
153 uplist = uplist->next;
160 * Build extauth index of all users with uid-based join (system auth, LDAP auth)
161 * Also changes all users with a uid of CTDLUID to NATIVE_AUTH_UID (-1)
163 void reindex_uids(void) {
164 syslog(LOG_WARNING, "upgrade: reindexing and applying uid changes");
165 ForEachUser(reindex_uids_backend, NULL);
166 reindex_uids_backend(NULL, NULL);
172 * These accounts may have been created by code that ran between mid 2008 and early 2011.
173 * If present they are no longer in use and may be deleted.
175 void remove_thread_users(void) {
176 char *deleteusers[] = {
185 "SYS_select_on_master",
190 struct ctdluser usbuf;
191 for (i=0; i<(sizeof(deleteusers)/sizeof(char *)); ++i) {
192 if (CtdlGetUser(&usbuf, deleteusers[i]) == 0) {
194 strcpy(usbuf.password, "deleteme");
197 "System user account <%s> is no longer in use and will be deleted.",
206 * Attempt to guess the name of the time zone currently in use
207 * on the underlying host system.
209 void guess_time_zone(void) {
213 fp = popen(file_guesstimezone, "r");
215 if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) {
216 buf[strlen(buf)-1] = 0;
217 CtdlSetConfigStr("c_default_cal_zone", buf);
218 syslog(LOG_INFO, "Configuring timezone: %s", buf);
226 * Per-room callback function for ingest_old_roominfo_and_roompic_files()
228 * This is the second pass, where we process the list of rooms with info or pic files.
230 void iorarf_oneroom(char *roomname, char *infofile, char *picfile)
234 char *unencoded_data;
236 long info_msgnum = 0;
240 // Test for the presence of a legacy "room info file"
241 if (!IsEmptyStr(infofile)) {
242 fp = fopen(infofile, "r");
248 fseek(fp, 0, SEEK_END);
249 data_length = ftell(fp);
251 if (data_length >= 1) {
253 unencoded_data = malloc(data_length);
254 if (unencoded_data) {
255 fread(unencoded_data, data_length, 1, fp);
256 encoded_data = malloc((data_length * 2) + 100);
258 sprintf(encoded_data, "Content-type: text/plain\nContent-transfer-encoding: base64\n\n");
259 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
260 snprintf(subject, sizeof subject, "Imported room banner for %s", roomname);
261 info_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
264 free(unencoded_data);
268 if (info_msgnum > 0) unlink(infofile);
271 // Test for the presence of a legacy "room picture file" and import it.
272 if (!IsEmptyStr(picfile)) {
273 fp = fopen(picfile, "r");
279 fseek(fp, 0, SEEK_END);
280 data_length = ftell(fp);
282 if (data_length >= 1) {
284 unencoded_data = malloc(data_length);
285 if (unencoded_data) {
286 fread(unencoded_data, data_length, 1, fp);
287 encoded_data = malloc((data_length * 2) + 100);
289 sprintf(encoded_data, "Content-type: image/gif\nContent-transfer-encoding: base64\n\n");
290 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1);
291 snprintf(subject, sizeof subject, "Imported room icon for %s", roomname);
292 pic_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
295 free(unencoded_data);
299 if (pic_msgnum > 0) unlink(picfile);
302 // Now we have the message numbers of our new banner and icon. Record them in the room record.
303 // NOTE: we are not deleting the old msgnum_info because that position in the record was previously
304 // a pointer to the highest message number which existed in the room when the info file was saved,
305 // and we don't want to delete messages that are not *actually* old banners.
306 struct ctdlroom qrbuf;
307 if (CtdlGetRoomLock(&qrbuf, roomname) == 0) {
308 qrbuf.msgnum_info = info_msgnum;
309 qrbuf.msgnum_pic = pic_msgnum;
310 CtdlPutRoomLock(&qrbuf);
317 struct iorarf_list *next;
318 char name[ROOMNAMELEN];
325 * Per-room callback function for ingest_old_roominfo_and_roompic_files()
327 * This is the first pass, where the list of qualifying rooms is gathered.
329 void iorarf_backend(struct ctdlroom *qrbuf, void *data)
332 struct iorarf_list **iorarf_list = (struct iorarf_list **)data;
334 struct iorarf_list *i = malloc(sizeof(struct iorarf_list));
335 i->next = *iorarf_list;
336 strcpy(i->name, qrbuf->QRname);
340 // Test for the presence of a legacy "room info file"
341 assoc_file_name(i->info, sizeof i->info, qrbuf, ctdl_info_dir);
342 fp = fopen(i->info, "r");
350 // Test for the presence of a legacy "room picture file"
351 assoc_file_name(i->pic, sizeof i->pic, qrbuf, ctdl_image_dir);
352 fp = fopen(i->pic, "r");
360 if ( (!IsEmptyStr(i->info)) || (!IsEmptyStr(i->pic)) ) {
370 * Prior to Citadel Server version 902, room info and pictures (which comprise the
371 * displayed banner for each room) were stored in the filesystem. If we are upgrading
372 * from version >000 to version >=902, ingest those files into the database.
374 void ingest_old_roominfo_and_roompic_files(void)
376 struct iorarf_list *il = NULL;
378 CtdlForEachRoom(iorarf_backend, &il);
380 struct iorarf_list *p;
382 iorarf_oneroom(il->name, il->info, il->pic);
388 unlink(ctdl_info_dir);
393 * For upgrades in which a new config setting appears for the first time, set default values.
394 * For new installations (oldver == 0) also set default values.
396 void update_config(void) {
399 CtdlSetConfigInt("c_rfc822_strict_from", 0);
403 CtdlSetConfigInt("c_purge_hour", 3);
407 CtdlSetConfigInt("c_ldap_port", 389);
411 CtdlSetConfigStr("c_ip_addr", "*");
415 CtdlSetConfigInt("c_enable_fulltext", 1);
419 CtdlSetConfigInt("c_auto_cull", 1);
423 CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
424 CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
428 CtdlSetConfigInt("c_nntp_port", 119);
429 CtdlSetConfigInt("c_nntps_port", 563);
432 if (IsEmptyStr(CtdlGetConfigStr("c_default_cal_zone"))) {
439 * Helper function for move_inet_addrs_from_vcards_to_user_records()
441 * Call this function as a ForEachUser backend in order to queue up
442 * user names, or call it with a null user to make it do the processing.
443 * This allows us to maintain the list as a static instead of passing
446 void miafvtur_backend(struct ctdluser *usbuf, void *data) {
453 static struct miafvtur *m = NULL;
454 static int num_m = 0;
455 static int alloc_m = 0;
457 /* this is the calling mode where we add a user */
460 char primary_inet_email[512] = { 0 };
461 char other_inet_emails[512] = { 0 };
462 struct vCard *v = vcard_get_user(usbuf);
464 extract_inet_email_addrs(primary_inet_email, sizeof primary_inet_email, other_inet_emails, sizeof other_inet_emails, v, 1);
467 if ( (IsEmptyStr(primary_inet_email)) && (IsEmptyStr(other_inet_emails)) ) {
471 if (num_m >= alloc_m) {
474 m = malloc(sizeof(struct miafvtur) * alloc_m);
478 m = realloc(m, (sizeof(struct miafvtur) * alloc_m));
482 strcpy(m[num_m].name, usbuf->fullname);
483 snprintf(m[num_m].emails, 512, "%s%s%s",
484 (!IsEmptyStr(primary_inet_email) ? primary_inet_email : ""),
485 ((!IsEmptyStr(primary_inet_email)&&(!IsEmptyStr(other_inet_emails))) ? "|" : ""),
486 (!IsEmptyStr(other_inet_emails) ? other_inet_emails : "")
492 /* this is the calling mode where we do the processing */
497 for (i=0; i<num_m; ++i) {
498 syslog(LOG_DEBUG, "<%s> = <%s>", m[i].name, m[i].emails);
499 if (CtdlGetUser(&u, m[i].name) == 0) {
500 safestrncpy(u.emailaddrs, m[i].emails, sizeof u.emailaddrs);
512 * Prior to version 912 we kept a user's various Internet email addresses in their vCards.
513 * This function moves them over to the user record, which is where we keep them now.
515 void move_inet_addrs_from_vcards_to_user_records(void)
517 ForEachUser(miafvtur_backend, NULL);
518 miafvtur_backend(NULL, NULL);
519 CtdlRebuildDirectoryIndex();
524 * Based on the server version number reported by the existing database,
525 * run in-place data format upgrades until everything is up to date.
527 void pre_startup_upgrades(void) {
529 oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
530 syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
533 if (oldver < REV_LEVEL) {
534 syslog(LOG_WARNING, "Running pre-startup database upgrades.");
540 if ((oldver > 000) && (oldver < 591)) {
541 syslog(LOG_EMERG, "This database is too old to be upgraded. Citadel server will exit.");
544 if ((oldver > 000) && (oldver < 913)) {
547 if ((oldver > 000) && (oldver < 659)) {
548 rebuild_euid_index();
554 rebuild_usersbynumber();
557 remove_thread_users();
560 struct ctdlroom QRoom;
561 if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) {
562 QRoom.QRdefaultview = VIEW_QUEUE;
567 if ((oldver > 000) && (oldver < 902)) {
568 ingest_old_roominfo_and_roompic_files();
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);
592 * Based on the server version number reported by the existing database,
593 * run in-place data format upgrades until everything is up to date.
595 void post_startup_upgrades(void) {
597 syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
599 if (oldver < REV_LEVEL) {
600 syslog(LOG_WARNING, "Running post-startup database upgrades.");
606 if ((oldver > 000) && (oldver < 912)) {
607 move_inet_addrs_from_vcards_to_user_records();
612 CTDL_MODULE_UPGRADE(upgrade)
614 pre_startup_upgrades();
616 /* return our module id for the Log */
620 CTDL_MODULE_INIT(upgrade)
624 post_startup_upgrades();
627 /* return our module name for the log */