X-Git-Url: https://code.citadel.org/?a=blobdiff_plain;f=citadel%2Fmodules%2Fupgrade%2Fserv_upgrade.c;h=4311504a4e94346fddaaa339b8000a00978cd81d;hb=bdfa2e9b6af7e32b11461433a28dd6551f830888;hp=4b6079905587701e4c988e4ccac121cb7b32282b;hpb=263eb53ff5e8a68b61789dad6ac3f999d98e8f2c;p=citadel.git diff --git a/citadel/modules/upgrade/serv_upgrade.c b/citadel/modules/upgrade/serv_upgrade.c index 4b6079905..4311504a4 100644 --- a/citadel/modules/upgrade/serv_upgrade.c +++ b/citadel/modules/upgrade/serv_upgrade.c @@ -1,23 +1,18 @@ /* - * $Id$ + * Transparently handle the upgrading of server data formats. If we see + * an existing version number of our database, we can make some intelligent + * guesses about what kind of data format changes need to be applied, and + * we apply them transparently. * - * Transparently handle the upgrading of server data formats. + * Copyright (c) 1987-2019 by the citadel.org team * - * Copyright (c) 1987-2010 by the citadel.org team + * This program is open source software; you can redistribute it and/or + * modify it under the terms of the GNU General Public License version 3. * - * This program is free software; you can redistribute it and/or modify - * it under the terms of the GNU General Public License as published by - * the Free Software Foundation; either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program; if not, write to the Free Software - * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. */ #include "sysdep.h" @@ -56,11 +51,16 @@ #include "msgbase.h" #include "serv_upgrade.h" #include "euidindex.h" - - #include "ctdl_module.h" +#include "serv_vcard.h" +#include "internet_addressing.h" - +/* + * oldver is the version number of Citadel Server which was active on the previous run of the program, learned from the system configuration. + * If we are running a new Citadel Server for the first time, oldver will be 0. + * We keep this value around for the entire duration of the program run because we'll need it during several stages of startup. + */ +int oldver = 0; /* * Fix up the name for Citadel user 0 and try to remove any extra users with number 0 @@ -79,27 +79,25 @@ void fix_sys_user_name(void) while (CtdlGetUserByNumber(&usbuf, 0) == 0) { /* delete user with number 0 and no name */ - if (IsEmptyStr(usbuf.fullname)) + if (IsEmptyStr(usbuf.fullname)) { cdb_delete(CDB_USERS, "", 0); - else - { /* temporarily set this user to -1 */ + } + else { + /* temporarily set this user to -1 */ usbuf.usernum = -1; CtdlPutUser(&usbuf); } } - /** Make sure user SYS_* is user 0 */ + /* Make sure user SYS_* is user 0 */ while (CtdlGetUserByNumber(&usbuf, -1) == 0) { if (strncmp(usbuf.fullname, "SYS_", 4)) - { /** Delete any user 0 that doesn't start with SYS_ */ - makeuserkey(usernamekey, - usbuf.fullname, - cutuserkey(usbuf.fullname)); + { /* Delete any user 0 that doesn't start with SYS_ */ + makeuserkey(usernamekey, usbuf.fullname, cutusername(usbuf.fullname)); cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey)); } - else - { + else { usbuf.usernum = 0; CtdlPutUser(&usbuf); } @@ -108,76 +106,24 @@ void fix_sys_user_name(void) /* - * Back end processing function for cmd_bmbx - */ -void cmd_bmbx_backend(struct ctdlroom *qrbuf, void *data) { - static struct RoomProcList *rplist = NULL; - struct RoomProcList *ptr; - struct ctdlroom qr; - - /* Lazy programming here. Call this function as a CtdlForEachRoom backend - * in order to queue up the room names, or call it with a null room - * to make it do the processing. - */ - if (qrbuf != NULL) { - ptr = (struct RoomProcList *) - malloc(sizeof (struct RoomProcList)); - if (ptr == NULL) return; - - safestrncpy(ptr->name, qrbuf->QRname, sizeof ptr->name); - ptr->next = rplist; - rplist = ptr; - return; - } - - while (rplist != NULL) { - - if (CtdlGetRoomLock(&qr, rplist->name) == 0) { - CtdlLogPrintf(CTDL_DEBUG, "Processing <%s>...\n", rplist->name); - if ( (qr.QRflags & QR_MAILBOX) == 0) { - CtdlLogPrintf(CTDL_DEBUG, " -- not a mailbox\n"); - } - else { - - qr.QRgen = time(NULL); - CtdlLogPrintf(CTDL_DEBUG, " -- fixed!\n"); - } - CtdlPutRoomLock(&qr); - } - - ptr = rplist; - rplist = rplist->next; - free(ptr); - } -} - -/* - * quick fix to bump mailbox generation numbers + * Back end processing function for reindex_uids() + * Call this function as a ForEachUser backend in order to queue up + * user names, or call it with a null user to make it do the processing. + * This allows us to maintain the list as a static instead of passing + * pointers around. */ -void bump_mailbox_generation_numbers(void) { - CtdlLogPrintf(CTDL_WARNING, "Applying security fix to mailbox rooms\n"); - CtdlForEachRoom(cmd_bmbx_backend, NULL); - cmd_bmbx_backend(NULL, NULL); - return; -} - - -/* - * Back end processing function for convert_ctdluid_to_minusone() - */ -void cbtm_backend(struct ctdluser *usbuf, void *data) { +void reindex_uids_backend(struct ctdluser *usbuf, void *data) { static struct UserProcList *uplist = NULL; struct UserProcList *ptr; struct ctdluser us; - /* Lazy programming here. Call this function as a ForEachUser backend - * in order to queue up the room names, or call it with a null user - * to make it do the processing. - */ + /* this is the calling mode where we add a user */ + if (usbuf != NULL) { - ptr = (struct UserProcList *) - malloc(sizeof (struct UserProcList)); - if (ptr == NULL) return; + ptr = (struct UserProcList *) malloc(sizeof (struct UserProcList)); + if (ptr == NULL) { + return; + } safestrncpy(ptr->user, usbuf->fullname, sizeof ptr->user); ptr->next = uplist; @@ -185,14 +131,22 @@ void cbtm_backend(struct ctdluser *usbuf, void *data) { return; } + /* this is the calling mode where we do the processing */ + while (uplist != NULL) { if (CtdlGetUserLock(&us, uplist->user) == 0) { - CtdlLogPrintf(CTDL_DEBUG, "Processing <%s>...\n", uplist->user); + syslog(LOG_DEBUG, "Processing <%s> (%d)", uplist->user, us.uid); if (us.uid == CTDLUID) { - us.uid = (-1); + us.uid = NATIVE_AUTH_UID; } CtdlPutUserLock(&us); + if ((us.uid > 0) && (us.uid != NATIVE_AUTH_UID)) { // if non-native auth , index by uid + StrBuf *claimed_id = NewStrBuf(); + StrBufPrintf(claimed_id, "uid:%d", us.uid); + attach_extauth(&us, claimed_id); + FreeStrBuf(&claimed_id); + } } ptr = uplist; @@ -201,17 +155,53 @@ void cbtm_backend(struct ctdluser *usbuf, void *data) { } } + /* - * quick fix to change all CTDLUID users to (-1) + * Build extauth index of all users with uid-based join (system auth, LDAP auth) + * Also changes all users with a uid of CTDLUID to NATIVE_AUTH_UID (-1) */ -void convert_ctdluid_to_minusone(void) { - CtdlLogPrintf(CTDL_WARNING, "Applying uid changes\n"); - ForEachUser(cbtm_backend, NULL); - cbtm_backend(NULL, NULL); +void reindex_uids(void) { + syslog(LOG_WARNING, "upgrade: reindexing and applying uid changes"); + ForEachUser(reindex_uids_backend, NULL); + reindex_uids_backend(NULL, NULL); return; } +/* + * These accounts may have been created by code that ran between mid 2008 and early 2011. + * If present they are no longer in use and may be deleted. + */ +void remove_thread_users(void) { + char *deleteusers[] = { + "SYS_checkpoint", + "SYS_extnotify", + "SYS_IGnet Queue", + "SYS_indexer", + "SYS_network", + "SYS_popclient", + "SYS_purger", + "SYS_rssclient", + "SYS_select_on_master", + "SYS_SMTP Send" + }; + + int i; + struct ctdluser usbuf; + for (i=0; i<(sizeof(deleteusers)/sizeof(char *)); ++i) { + if (CtdlGetUser(&usbuf, deleteusers[i]) == 0) { + usbuf.axlevel = 0; + strcpy(usbuf.password, "deleteme"); + CtdlPutUser(&usbuf); + syslog(LOG_INFO, + "System user account <%s> is no longer in use and will be deleted.", + deleteusers[i] + ); + } + } +} + + /* * Attempt to guess the name of the time zone currently in use * on the underlying host system. @@ -224,8 +214,8 @@ void guess_time_zone(void) { if (fp) { if (fgets(buf, sizeof buf, fp) && (strlen(buf) > 2)) { buf[strlen(buf)-1] = 0; - safestrncpy(config.c_default_cal_zone, buf, sizeof config.c_default_cal_zone); - CtdlLogPrintf(CTDL_INFO, "Configuring timezone: %s\n", config.c_default_cal_zone); + CtdlSetConfigStr("c_default_cal_zone", buf); + syslog(LOG_INFO, "Configuring timezone: %s", buf); } fclose(fp); } @@ -233,98 +223,436 @@ void guess_time_zone(void) { /* - * Do various things to our configuration file + * Per-room callback function for ingest_old_roominfo_and_roompic_files() + * + * This is the second pass, where we process the list of rooms with info or pic files. + */ +void iorarf_oneroom(char *roomname, char *infofile, char *picfile) +{ + FILE *fp; + long data_length; + char *unencoded_data; + char *encoded_data; + long info_msgnum = 0; + long pic_msgnum = 0; + char subject[SIZ]; + + // Test for the presence of a legacy "room info file" + if (!IsEmptyStr(infofile)) { + fp = fopen(infofile, "r"); + } + else { + fp = NULL; + } + if (fp) { + fseek(fp, 0, SEEK_END); + data_length = ftell(fp); + + if (data_length >= 1) { + rewind(fp); + unencoded_data = malloc(data_length); + if (unencoded_data) { + fread(unencoded_data, data_length, 1, fp); + encoded_data = malloc((data_length * 2) + 100); + if (encoded_data) { + sprintf(encoded_data, "Content-type: text/plain\nContent-transfer-encoding: base64\n\n"); + CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1); + snprintf(subject, sizeof subject, "Imported room banner for %s", roomname); + info_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject); + free(encoded_data); + } + free(unencoded_data); + } + } + fclose(fp); + if (info_msgnum > 0) unlink(infofile); + } + + // Test for the presence of a legacy "room picture file" and import it. + if (!IsEmptyStr(picfile)) { + fp = fopen(picfile, "r"); + } + else { + fp = NULL; + } + if (fp) { + fseek(fp, 0, SEEK_END); + data_length = ftell(fp); + + if (data_length >= 1) { + rewind(fp); + unencoded_data = malloc(data_length); + if (unencoded_data) { + fread(unencoded_data, data_length, 1, fp); + encoded_data = malloc((data_length * 2) + 100); + if (encoded_data) { + sprintf(encoded_data, "Content-type: image/gif\nContent-transfer-encoding: base64\n\n"); + CtdlEncodeBase64(&encoded_data[strlen(encoded_data)], unencoded_data, data_length, 1); + snprintf(subject, sizeof subject, "Imported room icon for %s", roomname); + pic_msgnum = quickie_message("Citadel", NULL, NULL, SYSCONFIGROOM, encoded_data, FMT_RFC822, subject); + free(encoded_data); + } + free(unencoded_data); + } + } + fclose(fp); + if (pic_msgnum > 0) unlink(picfile); + } + + // Now we have the message numbers of our new banner and icon. Record them in the room record. + // NOTE: we are not deleting the old msgnum_info because that position in the record was previously + // a pointer to the highest message number which existed in the room when the info file was saved, + // and we don't want to delete messages that are not *actually* old banners. + struct ctdlroom qrbuf; + if (CtdlGetRoomLock(&qrbuf, roomname) == 0) { + qrbuf.msgnum_info = info_msgnum; + qrbuf.msgnum_pic = pic_msgnum; + CtdlPutRoomLock(&qrbuf); + } + +} + + +struct iorarf_list { + struct iorarf_list *next; + char name[ROOMNAMELEN]; + char info[PATH_MAX]; + char pic[PATH_MAX]; +}; + + +/* + * Per-room callback function for ingest_old_roominfo_and_roompic_files() + * + * This is the first pass, where the list of qualifying rooms is gathered. + */ +void iorarf_backend(struct ctdlroom *qrbuf, void *data) +{ + FILE *fp; + struct iorarf_list **iorarf_list = (struct iorarf_list **)data; + + struct iorarf_list *i = malloc(sizeof(struct iorarf_list)); + i->next = *iorarf_list; + strcpy(i->name, qrbuf->QRname); + strcpy(i->info, ""); + strcpy(i->pic, ""); + + // Test for the presence of a legacy "room info file" + assoc_file_name(i->info, sizeof i->info, qrbuf, ctdl_info_dir); + fp = fopen(i->info, "r"); + if (fp) { + fclose(fp); + } + else { + i->info[0] = 0; + } + + // Test for the presence of a legacy "room picture file" + assoc_file_name(i->pic, sizeof i->pic, qrbuf, ctdl_image_dir); + fp = fopen(i->pic, "r"); + if (fp) { + fclose(fp); + } + else { + i->pic[0] = 0; + } + + if ( (!IsEmptyStr(i->info)) || (!IsEmptyStr(i->pic)) ) { + *iorarf_list = i; + } + else { + free(i); + } +} + + +/* + * Prior to Citadel Server version 902, room info and pictures (which comprise the + * displayed banner for each room) were stored in the filesystem. If we are upgrading + * from version >000 to version >=902, ingest those files into the database. + */ +void ingest_old_roominfo_and_roompic_files(void) +{ + struct iorarf_list *il = NULL; + + CtdlForEachRoom(iorarf_backend, &il); + + struct iorarf_list *p; + while (il) { + iorarf_oneroom(il->name, il->info, il->pic); + p = il->next; + free(il); + il = p; + } + + unlink(ctdl_info_dir); +} + + +/* + * For upgrades in which a new config setting appears for the first time, set default values. + * For new installations (oldver == 0) also set default values. */ void update_config(void) { - get_config(); - if (CitControl.version < 606) { - config.c_rfc822_strict_from = 0; + if (oldver < 606) { + CtdlSetConfigInt("c_rfc822_strict_from", 0); + } + + if (oldver < 609) { + CtdlSetConfigInt("c_purge_hour", 3); } - if (CitControl.version < 609) { - config.c_purge_hour = 3; + if (oldver < 615) { + CtdlSetConfigInt("c_ldap_port", 389); } - if (CitControl.version < 615) { - config.c_ldap_port = 389; + if (oldver < 623) { + CtdlSetConfigStr("c_ip_addr", "*"); } - if (CitControl.version < 623) { - strcpy(config.c_ip_addr, "0.0.0.0"); + if (oldver < 650) { + CtdlSetConfigInt("c_enable_fulltext", 1); } - if (CitControl.version < 650) { - config.c_enable_fulltext = 0; + if (oldver < 652) { + CtdlSetConfigInt("c_auto_cull", 1); } - if (CitControl.version < 652) { - config.c_auto_cull = 1; + if (oldver < 725) { + CtdlSetConfigInt("c_xmpp_c2s_port", 5222); + CtdlSetConfigInt("c_xmpp_s2s_port", 5269); } - if (CitControl.version < 725) { - config.c_xmpp_c2s_port = 5222; - config.c_xmpp_s2s_port = 5269; + if (oldver < 830) { + CtdlSetConfigInt("c_nntp_port", 119); + CtdlSetConfigInt("c_nntps_port", 563); } - if (IsEmptyStr(config.c_default_cal_zone)) { + if (IsEmptyStr(CtdlGetConfigStr("c_default_cal_zone"))) { guess_time_zone(); } +} + + +/* + * Helper function for move_inet_addrs_from_vcards_to_user_records() + * + * Call this function as a ForEachUser backend in order to queue up + * user names, or call it with a null user to make it do the processing. + * This allows us to maintain the list as a static instead of passing + * pointers around. + */ +void miafvtur_backend(struct ctdluser *usbuf, void *data) { + + struct miafvtur { + char name[64]; + char emails[512]; + }; + + static struct miafvtur *m = NULL; + static int num_m = 0; + static int alloc_m = 0; + + /* this is the calling mode where we add a user */ - put_config(); + if (usbuf != NULL) { + char primary_inet_email[512] = { 0 }; + char other_inet_emails[512] = { 0 }; + struct vCard *v = vcard_get_user(usbuf); + if (!v) return; + extract_inet_email_addrs(primary_inet_email, sizeof primary_inet_email, other_inet_emails, sizeof other_inet_emails, v, 1); + vcard_free(v); + + if ( (IsEmptyStr(primary_inet_email)) && (IsEmptyStr(other_inet_emails)) ) { + return; + } + + if (num_m >= alloc_m) { + if (alloc_m == 0) { + alloc_m = 100; + m = malloc(sizeof(struct miafvtur) * alloc_m); + } + else { + alloc_m *= 2; + m = realloc(m, (sizeof(struct miafvtur) * alloc_m)); + } + } + + strcpy(m[num_m].name, usbuf->fullname); + snprintf(m[num_m].emails, 512, "%s%s%s", + (!IsEmptyStr(primary_inet_email) ? primary_inet_email : ""), + ((!IsEmptyStr(primary_inet_email)&&(!IsEmptyStr(other_inet_emails))) ? "|" : ""), + (!IsEmptyStr(other_inet_emails) ? other_inet_emails : "") + ); + ++num_m; + return; + } + + /* this is the calling mode where we do the processing */ + int i; + for (i=0; i 000) && (CitControl.version < 555)) { - CtdlLogPrintf(CTDL_EMERG, - "Your data files are from a version of Citadel\n" - "that is too old to be upgraded. Sorry.\n"); + if ((oldver > 000) && (oldver < 591)) { + syslog(LOG_EMERG, "This database is too old to be upgraded. Citadel server will exit."); exit(EXIT_FAILURE); } - if ((CitControl.version > 000) && (CitControl.version < 591)) { - bump_mailbox_generation_numbers(); - } - if ((CitControl.version > 000) && (CitControl.version < 608)) { - convert_ctdluid_to_minusone(); + if ((oldver > 000) && (oldver < 913)) { + reindex_uids(); } - if ((CitControl.version > 000) && (CitControl.version < 659)) { + if ((oldver > 000) && (oldver < 659)) { rebuild_euid_index(); } - if (CitControl.version < 735) { + if (oldver < 735) { fix_sys_user_name(); } - if (CitControl.version < 736) { + if (oldver < 736) { rebuild_usersbynumber(); } - CitControl.version = REV_LEVEL; - put_control(); + if (oldver < 790) { + remove_thread_users(); + } + if (oldver < 810) { + struct ctdlroom QRoom; + if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) { + QRoom.QRdefaultview = VIEW_QUEUE; + CtdlPutRoom(&QRoom); + } + } + + if ((oldver > 000) && (oldver < 902)) { + ingest_old_roominfo_and_roompic_files(); + } + + CtdlSetConfigInt("MM_hosted_upgrade_level", REV_LEVEL); + + /* + * Negative values for maxsessions are not allowed. + */ + if (CtdlGetConfigInt("c_maxsessions") < 0) { + CtdlSetConfigInt("c_maxsessions", 0); + } + + /* We need a system default message expiry policy, because this is + * the top level and there's no 'higher' policy to fall back on. + * By default, do not expire messages at all. + */ + if (CtdlGetConfigInt("c_ep_mode") == 0) { + CtdlSetConfigInt("c_ep_mode", EXPIRE_MANUAL); + CtdlSetConfigInt("c_ep_value", 0); + } +} + + +/* + * Based on the server version number reported by the existing database, + * run in-place data format upgrades until everything is up to date. + */ +void post_startup_upgrades(void) { + + syslog(LOG_INFO, "Existing database version on disk is %d", oldver); + + if (oldver < REV_LEVEL) { + syslog(LOG_WARNING, "Running post-startup database upgrades."); + } + else { + return; + } + + if ((oldver > 000) && (oldver < 912)) { + move_inet_addrs_from_vcards_to_user_records(); + } + + if ((oldver > 000) && (oldver < 922)) { + ProcessOldStyleAdjRefCountQueue(); + } } CTDL_MODULE_UPGRADE(upgrade) { - check_server_upgrades(); + pre_startup_upgrades(); + + /* return our module id for the Log */ + return "upgrade"; +} + +CTDL_MODULE_INIT(upgrade) +{ + if(!threading) + { + post_startup_upgrades(); + } - /* return our Subversion id for the Log */ - return "$Id$"; + /* return our module name for the log */ + return "upgrade"; }