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-2023 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 "../../makeuserkey.h"
39 #include "../../msgbase.h"
40 #include "serv_upgrade.h"
41 #include "../../euidindex.h"
42 #include "../../ctdl_module.h"
43 #include "../../serv_vcard.h"
44 #include "../../internet_addressing.h"
46 // oldver is the version number of Citadel Server which was active on the previous run of the program, learned from the system configuration.
47 // If we are running a new Citadel Server for the first time, oldver will be 0.
48 // We keep this value around for the entire duration of the program run because we'll need it during several stages of startup.
51 // Try to remove any extra users with number 0
52 void fix_sys_user_name(void) {
53 struct ctdluser usbuf;
54 char usernamekey[USERNAME_SIZE];
56 while (CtdlGetUserByNumber(&usbuf, 0) == 0) {
57 // delete user with number 0 and no name
58 if (IsEmptyStr(usbuf.fullname)) {
59 cdb_delete(CDB_USERS, "", 0);
62 // temporarily set this user to -1
68 // Delete any "user 0" accounts
69 while (CtdlGetUserByNumber(&usbuf, -1) == 0) {
70 makeuserkey(usernamekey, usbuf.fullname);
71 cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
76 // These accounts may have been created by code that ran between mid 2008 and early 2011.
77 // If present they are no longer in use and may be deleted.
78 void remove_thread_users(void) {
79 char *deleteusers[] = {
88 "SYS_select_on_master",
93 struct ctdluser usbuf;
94 for (i=0; i<(sizeof(deleteusers)/sizeof(char *)); ++i) {
95 if (CtdlGetUser(&usbuf, deleteusers[i]) == 0) {
97 strcpy(usbuf.password, "deleteme");
100 "System user account <%s> is no longer in use and will be deleted.",
108 // Attempt to guess the name of the time zone currently in use
109 // on the underlying host system.
110 void guess_time_zone(void) {
114 fp = popen(file_guesstimezone, "r");
116 if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) {
117 buf[strlen(buf)-1] = 0;
118 CtdlSetConfigStr("c_default_cal_zone", buf);
119 syslog(LOG_INFO, "Configuring timezone: %s", buf);
126 // Per-room callback function for ingest_old_roominfo_and_roompic_files()
127 // This is the second pass, where we process the list of rooms with info or pic files.
128 void iorarf_oneroom(char *roomname, char *infofile, char *picfile) {
131 char *unencoded_data;
133 long info_msgnum = 0;
137 // Test for the presence of a legacy "room info file"
138 if (!IsEmptyStr(infofile)) {
139 fp = fopen(infofile, "r");
145 fseek(fp, 0, SEEK_END);
146 data_length = ftell(fp);
148 if (data_length >= 1) {
150 unencoded_data = malloc(data_length);
151 if (unencoded_data) {
152 fread(unencoded_data, data_length, 1, fp);
153 encoded_data = malloc((data_length * 2) + 100);
155 sprintf(encoded_data, "Content-type: text/plain\nContent-transfer-encoding: base64\n\n");
156 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, BASE64_YES_LINEBREAKS);
157 snprintf(subject, sizeof subject, "Imported room banner for %s", roomname);
158 info_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
161 free(unencoded_data);
165 if (info_msgnum > 0) unlink(infofile);
168 // Test for the presence of a legacy "room picture file" and import it.
169 if (!IsEmptyStr(picfile)) {
170 fp = fopen(picfile, "r");
176 fseek(fp, 0, SEEK_END);
177 data_length = ftell(fp);
179 if (data_length >= 1) {
181 unencoded_data = malloc(data_length);
182 if (unencoded_data) {
183 fread(unencoded_data, data_length, 1, fp);
184 encoded_data = malloc((data_length * 2) + 100);
186 sprintf(encoded_data, "Content-type: image/gif\nContent-transfer-encoding: base64\n\n");
187 CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, BASE64_YES_LINEBREAKS);
188 snprintf(subject, sizeof subject, "Imported room icon for %s", roomname);
189 pic_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject);
192 free(unencoded_data);
196 if (pic_msgnum > 0) unlink(picfile);
199 // Now we have the message numbers of our new banner and icon. Record them in the room record.
200 // NOTE: we are not deleting the old msgnum_info because that position in the record was previously
201 // a pointer to the highest message number which existed in the room when the info file was saved,
202 // and we don't want to delete messages that are not *actually* old banners.
203 struct ctdlroom qrbuf;
204 if (CtdlGetRoomLock(&qrbuf, roomname) == 0) {
205 qrbuf.msgnum_info = info_msgnum;
206 qrbuf.msgnum_pic = pic_msgnum;
207 CtdlPutRoomLock(&qrbuf);
214 struct iorarf_list *next;
215 char name[ROOMNAMELEN];
221 // Per-room callback function for ingest_old_roominfo_and_roompic_files()
222 // This is the first pass, where the list of qualifying rooms is gathered.
223 void iorarf_backend(struct ctdlroom *qrbuf, void *data) {
225 struct iorarf_list **iorarf_list = (struct iorarf_list **)data;
227 struct iorarf_list *i = malloc(sizeof(struct iorarf_list));
228 i->next = *iorarf_list;
229 strcpy(i->name, qrbuf->QRname);
233 // Test for the presence of a legacy "room info file"
234 assoc_file_name(i->info, sizeof i->info, qrbuf, ctdl_info_dir);
235 fp = fopen(i->info, "r");
243 // Test for the presence of a legacy "room picture file"
244 assoc_file_name(i->pic, sizeof i->pic, qrbuf, ctdl_image_dir);
245 fp = fopen(i->pic, "r");
253 if ( (!IsEmptyStr(i->info)) || (!IsEmptyStr(i->pic)) ) {
262 // Prior to Citadel Server version 902, room info and pictures (which comprise the
263 // displayed banner for each room) were stored in the filesystem. If we are upgrading
264 // from version >000 to version >=902, ingest those files into the database.
265 void ingest_old_roominfo_and_roompic_files(void) {
266 struct iorarf_list *il = NULL;
268 CtdlForEachRoom(iorarf_backend, &il);
270 struct iorarf_list *p;
272 iorarf_oneroom(il->name, il->info, il->pic);
278 unlink(ctdl_info_dir);
282 // For upgrades in which a new config setting appears for the first time, set default values.
283 // For new installations (oldver == 0) also set default values.
284 void update_config(void) {
287 CtdlSetConfigInt("c_rfc822_strict_from", 0);
291 CtdlSetConfigInt("c_purge_hour", 3);
295 CtdlSetConfigInt("c_ldap_port", 389);
299 CtdlSetConfigStr("c_ip_addr", "*");
303 CtdlSetConfigInt("c_enable_fulltext", 1);
307 CtdlSetConfigInt("c_xmpp_c2s_port", 5222);
308 CtdlSetConfigInt("c_xmpp_s2s_port", 5269);
312 CtdlSetConfigInt("c_nntp_port", 119);
313 CtdlSetConfigInt("c_nntps_port", 563);
316 if (IsEmptyStr(CtdlGetConfigStr("c_default_cal_zone"))) {
322 // Helper function for move_inet_addrs_from_vcards_to_user_records()
324 // Call this function as a ForEachUser backend in order to queue up
325 // user names, or call it with a null user to make it do the processing.
326 // This allows us to maintain the list as a static instead of passing
328 void miafvtur_backend(char *username, void *data) {
329 struct ctdluser usbuf;
330 char primary_inet_email[512] = { 0 };
331 char other_inet_emails[512] = { 0 };
332 char combined_inet_emails[512] = { 0 };
334 if (CtdlGetUser(&usbuf, username) != 0) {
338 struct vCard *v = vcard_get_user(&usbuf);
340 extract_inet_email_addrs(primary_inet_email, sizeof primary_inet_email, other_inet_emails, sizeof other_inet_emails, v, 1);
343 if ( (IsEmptyStr(primary_inet_email)) && (IsEmptyStr(other_inet_emails)) ) {
347 snprintf(combined_inet_emails, 512, "%s%s%s",
348 (!IsEmptyStr(primary_inet_email) ? primary_inet_email : ""),
349 ((!IsEmptyStr(primary_inet_email)&&(!IsEmptyStr(other_inet_emails))) ? "|" : ""),
350 (!IsEmptyStr(other_inet_emails) ? other_inet_emails : "")
353 CtdlSetEmailAddressesForUser(usbuf.fullname, combined_inet_emails);
357 // If our system still has a "refcount_adjustments.dat" sitting around from an old version, ingest it now.
358 int ProcessOldStyleAdjRefCountQueue(void) {
361 struct arcq arcq_rec;
362 int num_records_processed = 0;
364 fp = fopen(file_arcq, "rb");
366 return(num_records_processed);
369 syslog(LOG_INFO, "msgbase: ingesting %s", file_arcq);
371 while (fread(&arcq_rec, sizeof(struct arcq), 1, fp) == 1) {
372 AdjRefCount(arcq_rec.arcq_msgnum, arcq_rec.arcq_delta);
373 ++num_records_processed;
377 r = unlink(file_arcq);
379 syslog(LOG_ERR, "%s: %m", file_arcq);
382 return(num_records_processed);
386 // Prior to version 912 we kept a user's various Internet email addresses in their vCards.
387 // This function moves them over to the user record, which is where we keep them now.
388 void move_inet_addrs_from_vcards_to_user_records(void) {
389 ForEachUser(miafvtur_backend, NULL);
390 CtdlRebuildDirectoryIndex();
394 // We found the legacy sieve config in the user's config room. Store the message number in the user record.
395 void mifm_found_config(long msgnum, void *userdata) {
396 struct ctdluser *us = (struct ctdluser *)userdata;
398 us->msgnum_inboxrules = msgnum;
399 syslog(LOG_DEBUG, "user: <%s> inbox filter msgnum: <%ld>", us->fullname, us->msgnum_inboxrules);
403 // Helper function for migrate_inbox_filter_msgnums()
404 void mifm_backend(char *username, void *data) {
406 char roomname[ROOMNAMELEN];
408 if (CtdlGetUserLock(&us, username) == 0) {
409 // Take a spin through the user's personal config room
410 syslog(LOG_DEBUG, "Processing <%s> (%ld)", us.fullname, us.usernum);
411 snprintf(roomname, sizeof roomname, "%010ld.%s", us.usernum, USERCONFIGROOM);
412 if (CtdlGetRoom(&CC->room, roomname) == 0) {
413 CtdlForEachMessage(MSGS_LAST, 1, NULL, SIEVECONFIG, NULL, mifm_found_config, (void *)&us );
415 CtdlPutUserLock(&us);
420 // Prior to version 930 we used a MIME type search to locate the user's inbox filter rules.
421 // This function locates those ruleset messages and simply stores the message number in the user record.
422 void migrate_inbox_filter_msgnums(void) {
423 ForEachUser(mifm_backend, NULL);
427 // Create a default administrator account so we can log in to a new installation
428 void create_default_admin_account(void) {
429 struct ctdluser usbuf;
431 create_user(DEFAULT_ADMIN_USERNAME, CREATE_USER_DO_NOT_BECOME_USER, (-1));
432 CtdlGetUser(&usbuf, DEFAULT_ADMIN_USERNAME);
433 safestrncpy(usbuf.password, DEFAULT_ADMIN_PASSWORD, sizeof(usbuf.password));
434 usbuf.axlevel = AxAideU;
436 CtdlSetConfigStr("c_sysadm", DEFAULT_ADMIN_USERNAME);
440 void regenerate_secondary_indices(void) {
441 syslog(LOG_INFO, "regenerate_secondary_indices has been activated.");
443 rebuild_usersbynumber();
444 rebuild_euid_index();
445 CtdlRebuildDirectoryIndex();
446 // we also need to trigger the fulltext foo
448 CtdlSetConfigInt("regenerate_secondary_indices", 0);
452 // Based on the server version number reported by the existing database,
453 // run in-place data format upgrades until everything is up to date.
454 void pre_startup_upgrades(void) {
456 oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
457 syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
460 if (oldver < REV_LEVEL) {
461 syslog(LOG_WARNING, "Running pre-startup database upgrades.");
467 if ((oldver > 000) && (oldver < 591)) {
468 syslog(LOG_EMERG, "This database is too old to be upgraded. Citadel server will exit.");
471 if ((oldver > 000) && (oldver < 659)) {
472 rebuild_euid_index();
478 rebuild_usersbynumber();
481 remove_thread_users();
484 struct ctdlroom QRoom;
485 if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) {
486 QRoom.QRdefaultview = VIEW_QUEUE;
490 if ((oldver > 000) && (oldver < 902)) {
491 ingest_old_roominfo_and_roompic_files();
493 if ((oldver > 000) && (oldver < 973)) { // This was the old extauth table.
494 cdb_trunc(CDB_UNUSED1); // We will do this better someday.
496 if ((oldver > 000) && (oldver < 975)) { // An unrepairable defect was found in this table.
497 cdb_trunc(CDB_USETABLE); // We have to discard it and start over.
500 CtdlSetConfigInt("MM_hosted_upgrade_level", REV_LEVEL);
502 // Negative values for maxsessions are not allowed.
503 if (CtdlGetConfigInt("c_maxsessions") < 0) {
504 CtdlSetConfigInt("c_maxsessions", 0);
507 // We need a system default message expiry policy, because this is
508 // the top level and there's no 'higher' policy to fall back on.
509 // By default, do not expire messages at all.
510 if (CtdlGetConfigInt("c_ep_mode") == 0) {
511 CtdlSetConfigInt("c_ep_mode", EXPIRE_MANUAL);
512 CtdlSetConfigInt("c_ep_value", 0);
515 // If this is the first run on an empty database, create a default administrator
517 create_default_admin_account();
522 // Based on the server version number reported by the existing database,
523 // run in-place data format upgrades until everything is up to date.
524 void post_startup_upgrades(void) {
526 syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
528 if (oldver < REV_LEVEL) {
529 syslog(LOG_WARNING, "Running post-startup database upgrades.");
531 if ((oldver > 000) && (oldver < 912)) {
532 move_inet_addrs_from_vcards_to_user_records();
535 if ((oldver > 000) && (oldver < 922)) {
536 ProcessOldStyleAdjRefCountQueue();
539 if ((oldver > 000) && (oldver < 930)) {
540 migrate_inbox_filter_msgnums();
546 // Initialization function, called from modules_init.c
547 char *ctdl_module_init_upgrade(void) {
549 post_startup_upgrades();
552 /* return our module name for the log */