1 // Transparently handle the upgrading of server data formats. If we see
2 // an existing version number of our database, we can make some intelligent
3 // guesses about what kind of data format changes need to be applied, and
4 // we apply them transparently.
6 // Copyright (c) 1987-2022 by the citadel.org team
8 // This program is open source software; you can redistribute it and/or
9 // modify it under the terms of the GNU General Public License version 3.
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 #include "../../sysdep.h"
24 #include <sys/types.h>
29 #include <libcitadel.h>
30 #include "../../citadel_defs.h"
31 #include "../../server.h"
32 #include "../../citserver.h"
33 #include "../../support.h"
34 #include "../../config.h"
35 #include "../../control.h"
36 #include "../../database.h"
37 #include "../../user_ops.h"
38 #include "../../msgbase.h"
39 #include "serv_upgrade.h"
40 #include "../../euidindex.h"
41 #include "../../ctdl_module.h"
42 #include "../../serv_vcard.h"
43 #include "../../internet_addressing.h"
45 // oldver is the version number of Citadel Server which was active on the previous run of the program, learned from the system configuration.
46 // If we are running a new Citadel Server for the first time, oldver will be 0.
47 // We keep this value around for the entire duration of the program run because we'll need it during several stages of startup.
50 // Try to remove any extra users with number 0
51 void fix_sys_user_name(void) {
52 struct ctdluser usbuf;
53 char usernamekey[USERNAME_SIZE];
55 while (CtdlGetUserByNumber(&usbuf, 0) == 0) {
56 // delete user with number 0 and no name
57 if (IsEmptyStr(usbuf.fullname)) {
58 cdb_delete(CDB_USERS, "", 0);
61 // temporarily set this user to -1
67 // Delete any "user 0" accounts
68 while (CtdlGetUserByNumber(&usbuf, -1) == 0) {
69 makeuserkey(usernamekey, usbuf.fullname);
70 cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
75 // Back end processing function for reindex_uids()
76 void reindex_uids_backend(char *username, void *data) {
80 if (CtdlGetUserLock(&us, username) == 0) {
81 syslog(LOG_DEBUG, "Processing <%s> (%d)", us.fullname, us.uid);
82 if (us.uid == CTDLUID) {
83 us.uid = NATIVE_AUTH_UID;
86 if ((us.uid > 0) && (us.uid != NATIVE_AUTH_UID)) { // if non-native auth , index by uid
87 StrBuf *claimed_id = NewStrBuf();
88 StrBufPrintf(claimed_id, "uid:%d", us.uid);
89 attach_extauth(&us, claimed_id);
90 FreeStrBuf(&claimed_id);
96 // Build extauth index of all users with uid-based join (system auth, LDAP auth)
97 // Also changes all users with a uid of CTDLUID to NATIVE_AUTH_UID (-1)
98 void reindex_uids(void) {
99 syslog(LOG_WARNING, "upgrade: reindexing and applying uid changes");
100 ForEachUser(reindex_uids_backend, NULL);
105 // These accounts may have been created by code that ran between mid 2008 and early 2011.
106 // If present they are no longer in use and may be deleted.
107 void remove_thread_users(void) {
108 char *deleteusers[] = {
117 "SYS_select_on_master",
122 struct ctdluser usbuf;
123 for (i=0; i<(sizeof(deleteusers)/sizeof(char *)); ++i) {
124 if (CtdlGetUser(&usbuf, deleteusers[i]) == 0) {
126 strcpy(usbuf.password, "deleteme");
129 "System user account <%s> is no longer in use and will be deleted.",
137 // Attempt to guess the name of the time zone currently in use
138 // on the underlying host system.
139 void guess_time_zone(void) {
143 fp = popen(file_guesstimezone, "r");
145 if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) {
146 buf[strlen(buf)-1] = 0;
147 CtdlSetConfigStr("c_default_cal_zone", buf);
148 syslog(LOG_INFO, "Configuring timezone: %s", buf);
155 // Per-room callback function for ingest_old_roominfo_and_roompic_files()
156 // This is the second pass, where we process the list of rooms with info or pic files.
157 void iorarf_oneroom(char *roomname, char *infofile, char *picfile) {
160 char *unencoded_data;
162 long info_msgnum = 0;
166 // Test for the presence of a legacy "room info file"
167 if (!IsEmptyStr(infofile)) {
168 fp = fopen(infofile, "r");
174 fseek(fp, 0, SEEK_END);
175 data_length = ftell(fp);
177 if (data_length >= 1) {
179 unencoded_data = malloc(data_length);
180 if (unencoded_data) {
181 fread(unencoded_data, data_length, 1, fp);
182 encoded_data = malloc((data_length * 2) + 100);
184 sprintf(encoded_data, "Content-type: text/plain\nContent-transfer-encoding: base64\n\n");
185 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, BASE64_YES_LINEBREAKS);
186 snprintf(subject, sizeof subject, "Imported room banner for %s", roomname);
187 info_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
190 free(unencoded_data);
194 if (info_msgnum > 0) unlink(infofile);
197 // Test for the presence of a legacy "room picture file" and import it.
198 if (!IsEmptyStr(picfile)) {
199 fp = fopen(picfile, "r");
205 fseek(fp, 0, SEEK_END);
206 data_length = ftell(fp);
208 if (data_length >= 1) {
210 unencoded_data = malloc(data_length);
211 if (unencoded_data) {
212 fread(unencoded_data, data_length, 1, fp);
213 encoded_data = malloc((data_length * 2) + 100);
215 sprintf(encoded_data, "Content-type: image/gif\nContent-transfer-encoding: base64\n\n");
216 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, BASE64_YES_LINEBREAKS);
217 snprintf(subject, sizeof subject, "Imported room icon for %s", roomname);
218 pic_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
221 free(unencoded_data);
225 if (pic_msgnum > 0) unlink(picfile);
228 // Now we have the message numbers of our new banner and icon. Record them in the room record.
229 // NOTE: we are not deleting the old msgnum_info because that position in the record was previously
230 // a pointer to the highest message number which existed in the room when the info file was saved,
231 // and we don't want to delete messages that are not *actually* old banners.
232 struct ctdlroom qrbuf;
233 if (CtdlGetRoomLock(&qrbuf, roomname) == 0) {
234 qrbuf.msgnum_info = info_msgnum;
235 qrbuf.msgnum_pic = pic_msgnum;
236 CtdlPutRoomLock(&qrbuf);
243 struct iorarf_list *next;
244 char name[ROOMNAMELEN];
250 // Per-room callback function for ingest_old_roominfo_and_roompic_files()
251 // This is the first pass, where the list of qualifying rooms is gathered.
252 void iorarf_backend(struct ctdlroom *qrbuf, void *data) {
254 struct iorarf_list **iorarf_list = (struct iorarf_list **)data;
256 struct iorarf_list *i = malloc(sizeof(struct iorarf_list));
257 i->next = *iorarf_list;
258 strcpy(i->name, qrbuf->QRname);
262 // Test for the presence of a legacy "room info file"
263 assoc_file_name(i->info, sizeof i->info, qrbuf, ctdl_info_dir);
264 fp = fopen(i->info, "r");
272 // Test for the presence of a legacy "room picture file"
273 assoc_file_name(i->pic, sizeof i->pic, qrbuf, ctdl_image_dir);
274 fp = fopen(i->pic, "r");
282 if ( (!IsEmptyStr(i->info)) || (!IsEmptyStr(i->pic)) ) {
291 // Prior to Citadel Server version 902, room info and pictures (which comprise the
292 // displayed banner for each room) were stored in the filesystem. If we are upgrading
293 // from version >000 to version >=902, ingest those files into the database.
294 void ingest_old_roominfo_and_roompic_files(void) {
295 struct iorarf_list *il = NULL;
297 CtdlForEachRoom(iorarf_backend, &il);
299 struct iorarf_list *p;
301 iorarf_oneroom(il->name, il->info, il->pic);
307 unlink(ctdl_info_dir);
311 // For upgrades in which a new config setting appears for the first time, set default values.
312 // For new installations (oldver == 0) also set default values.
313 void update_config(void) {
316 CtdlSetConfigInt("c_rfc822_strict_from", 0);
320 CtdlSetConfigInt("c_purge_hour", 3);
324 CtdlSetConfigInt("c_ldap_port", 389);
328 CtdlSetConfigStr("c_ip_addr", "*");
332 CtdlSetConfigInt("c_enable_fulltext", 1);
336 CtdlSetConfigInt("c_auto_cull", 1);
340 CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
341 CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
345 CtdlSetConfigInt("c_nntp_port", 119);
346 CtdlSetConfigInt("c_nntps_port", 563);
349 if (IsEmptyStr(CtdlGetConfigStr("c_default_cal_zone"))) {
355 // Helper function for move_inet_addrs_from_vcards_to_user_records()
357 // Call this function as a ForEachUser backend in order to queue up
358 // user names, or call it with a null user to make it do the processing.
359 // This allows us to maintain the list as a static instead of passing
361 void miafvtur_backend(char *username, void *data) {
362 struct ctdluser usbuf;
363 char primary_inet_email[512] = { 0 };
364 char other_inet_emails[512] = { 0 };
365 char combined_inet_emails[512] = { 0 };
367 if (CtdlGetUser(&usbuf, username) != 0) {
371 struct vCard *v = vcard_get_user(&usbuf);
373 extract_inet_email_addrs(primary_inet_email, sizeof primary_inet_email, other_inet_emails, sizeof other_inet_emails, v, 1);
376 if ( (IsEmptyStr(primary_inet_email)) && (IsEmptyStr(other_inet_emails)) ) {
380 snprintf(combined_inet_emails, 512, "%s%s%s",
381 (!IsEmptyStr(primary_inet_email) ? primary_inet_email : ""),
382 ((!IsEmptyStr(primary_inet_email)&&(!IsEmptyStr(other_inet_emails))) ? "|" : ""),
383 (!IsEmptyStr(other_inet_emails) ? other_inet_emails : "")
386 CtdlSetEmailAddressesForUser(usbuf.fullname, combined_inet_emails);
390 // If our system still has a "refcount_adjustments.dat" sitting around from an old version, ingest it now.
391 int ProcessOldStyleAdjRefCountQueue(void) {
394 struct arcq arcq_rec;
395 int num_records_processed = 0;
397 fp = fopen(file_arcq, "rb");
399 return(num_records_processed);
402 syslog(LOG_INFO, "msgbase: ingesting %s", file_arcq);
404 while (fread(&arcq_rec, sizeof(struct arcq), 1, fp) == 1) {
405 AdjRefCount(arcq_rec.arcq_msgnum, arcq_rec.arcq_delta);
406 ++num_records_processed;
410 r = unlink(file_arcq);
412 syslog(LOG_ERR, "%s: %m", file_arcq);
415 return(num_records_processed);
419 // Prior to version 912 we kept a user's various Internet email addresses in their vCards.
420 // This function moves them over to the user record, which is where we keep them now.
421 void move_inet_addrs_from_vcards_to_user_records(void) {
422 ForEachUser(miafvtur_backend, NULL);
423 CtdlRebuildDirectoryIndex();
427 // We found the legacy sieve config in the user's config room. Store the message number in the user record.
428 void mifm_found_config(long msgnum, void *userdata) {
429 struct ctdluser *us = (struct ctdluser *)userdata;
431 us->msgnum_inboxrules = msgnum;
432 syslog(LOG_DEBUG, "user: <%s> inbox filter msgnum: <%ld>", us->fullname, us->msgnum_inboxrules);
436 // Helper function for migrate_inbox_filter_msgnums()
437 void mifm_backend(char *username, void *data) {
439 char roomname[ROOMNAMELEN];
441 if (CtdlGetUserLock(&us, username) == 0) {
442 // Take a spin through the user's personal config room
443 syslog(LOG_DEBUG, "Processing <%s> (%ld)", us.fullname, us.usernum);
444 snprintf(roomname, sizeof roomname, "%010ld.%s", us.usernum, USERCONFIGROOM);
445 if (CtdlGetRoom(&CC->room, roomname) == 0) {
446 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL, mifm_found_config, (void *)&us );
448 CtdlPutUserLock(&us);
453 // Prior to version 930 we used a MIME type search to locate the user's inbox filter rules.
454 // This function locates those ruleset messages and simply stores the message number in the user record.
455 void migrate_inbox_filter_msgnums(void) {
456 ForEachUser(mifm_backend, NULL);
460 // Create a default administrator account so we can log in to a new installation
461 void create_default_admin_account(void) {
462 struct ctdluser usbuf;
464 create_user(DEFAULT_ADMIN_USERNAME, CREATE_USER_DO_NOT_BECOME_USER, (-1));
465 CtdlGetUser(&usbuf, DEFAULT_ADMIN_USERNAME);
466 safestrncpy(usbuf.password, DEFAULT_ADMIN_PASSWORD, sizeof(usbuf.password));
467 usbuf.axlevel = AxAideU;
469 CtdlSetConfigStr("c_sysadm", DEFAULT_ADMIN_USERNAME);
473 // Based on the server version number reported by the existing database,
474 // run in-place data format upgrades until everything is up to date.
475 void pre_startup_upgrades(void) {
477 oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
478 syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
481 if (oldver < REV_LEVEL) {
482 syslog(LOG_WARNING, "Running pre-startup database upgrades.");
488 if ((oldver > 000) && (oldver < 591)) {
489 syslog(LOG_EMERG, "This database is too old to be upgraded. Citadel server will exit.");
492 if ((oldver > 000) && (oldver < 913)) {
495 if ((oldver > 000) && (oldver < 659)) {
496 rebuild_euid_index();
502 rebuild_usersbynumber();
505 remove_thread_users();
508 struct ctdlroom QRoom;
509 if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) {
510 QRoom.QRdefaultview = VIEW_QUEUE;
515 if ((oldver > 000) && (oldver < 902)) {
516 ingest_old_roominfo_and_roompic_files();
519 CtdlSetConfigInt("MM_hosted_upgrade_level", REV_LEVEL);
521 // Negative values for maxsessions are not allowed.
522 if (CtdlGetConfigInt("c_maxsessions") < 0) {
523 CtdlSetConfigInt("c_maxsessions", 0);
526 // We need a system default message expiry policy, because this is
527 // the top level and there's no 'higher' policy to fall back on.
528 // By default, do not expire messages at all.
529 if (CtdlGetConfigInt("c_ep_mode") == 0) {
530 CtdlSetConfigInt("c_ep_mode", EXPIRE_MANUAL);
531 CtdlSetConfigInt("c_ep_value", 0);
534 // If this is the first run on an empty database, create a default administrator
536 create_default_admin_account();
541 // Based on the server version number reported by the existing database,
542 // run in-place data format upgrades until everything is up to date.
543 void post_startup_upgrades(void) {
545 syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
547 if (oldver < REV_LEVEL) {
548 syslog(LOG_WARNING, "Running post-startup database upgrades.");
554 if ((oldver > 000) && (oldver < 912)) {
555 move_inet_addrs_from_vcards_to_user_records();
558 if ((oldver > 000) && (oldver < 922)) {
559 ProcessOldStyleAdjRefCountQueue();
562 if ((oldver > 000) && (oldver < 930)) {
563 migrate_inbox_filter_msgnums();
569 // Initialization function, called from modules_init.c
570 char *ctdl_module_init_upgrade(void) {
572 post_startup_upgrades();
575 /* return our module name for the log */