* guesses about what kind of data format changes need to be applied, and
* we apply them transparently.
*
- * Copyright (c) 1987-2017 by the citadel.org team
+ * Copyright (c) 1987-2019 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.
#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
+ * Try to remove any extra users with number 0
*/
void fix_sys_user_name(void)
{
struct ctdluser usbuf;
char usernamekey[USERNAME_SIZE];
- /** If we have a user called Citadel rename them to SYS_Citadel */
- if (CtdlGetUser(&usbuf, "Citadel") == 0)
- {
- rename_user("Citadel", "SYS_Citadel");
- }
-
- while (CtdlGetUserByNumber(&usbuf, 0) == 0)
- {
+ while (CtdlGetUserByNumber(&usbuf, 0) == 0) {
/* delete user with number 0 and no name */
if (IsEmptyStr(usbuf.fullname)) {
cdb_delete(CDB_USERS, "", 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));
- cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
- }
- else {
- usbuf.usernum = 0;
- CtdlPutUser(&usbuf);
- }
+ /* Delete any "user 0" accounts */
+ while (CtdlGetUserByNumber(&usbuf, -1) == 0) {
+ makeuserkey(usernamekey, usbuf.fullname, cutusername(usbuf.fullname));
+ cdb_delete(CDB_USERS, usernamekey, strlen(usernamekey));
}
}
/*
* 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 reindex_uids_backend(struct ctdluser *usbuf, void *data) {
- static struct UserProcList *uplist = NULL;
- struct UserProcList *ptr;
- struct ctdluser us;
+void reindex_uids_backend(char *username, void *data) {
- /* this is the calling mode where we add a user */
+ struct ctdluser us;
- if (usbuf != NULL) {
- ptr = (struct UserProcList *) malloc(sizeof (struct UserProcList));
- if (ptr == NULL) {
- return;
+ if (CtdlGetUserLock(&us, username) == 0) {
+ syslog(LOG_DEBUG, "Processing <%s> (%d)", us.fullname, us.uid);
+ if (us.uid == CTDLUID) {
+ us.uid = NATIVE_AUTH_UID;
}
-
- safestrncpy(ptr->user, usbuf->fullname, sizeof ptr->user);
- ptr->next = uplist;
- uplist = ptr;
- return;
- }
-
- /* this is the calling mode where we do the processing */
-
- while (uplist != NULL) {
-
- if (CtdlGetUserLock(&us, uplist->user) == 0) {
- syslog(LOG_DEBUG, "Processing <%s> (%d)", uplist->user, us.uid);
- if (us.uid == CTDLUID) {
- us.uid = NATIVE_AUTH_UID;
- }
- CtdlPutUserLock(&us);
- if (us.uid > 0) { // 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);
- }
+ 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;
- uplist = uplist->next;
- free(ptr);
}
}
+
/*
* 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 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.
/*
- * Perform any upgrades that can be done automatically based on our knowledge of the previous
- * version of Citadel server that was running here.
- *
- * Note that if the previous version was 0 then this is a new installation running for the first time.
+ * 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) {
- int oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
-
if (oldver < 606) {
CtdlSetConfigInt("c_rfc822_strict_from", 0);
}
* This allows us to maintain the list as a static instead of passing
* pointers around.
*/
-void miafvtur_backend(struct ctdluser *usbuf, void *data) {
+void miafvtur_backend(char *username, void *data) {
+ struct ctdluser usbuf;
+ char primary_inet_email[512] = { 0 };
+ char other_inet_emails[512] = { 0 };
+ char combined_inet_emails[512] = { 0 };
- struct miafvtur {
- char name[64];
- char emails[512];
- };
+ if (CtdlGetUser(&usbuf, username) != 0) {
+ return;
+ }
- static struct miafvtur *m = NULL;
- static int num_m = 0;
- static int alloc_m = 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;
+ }
- /* this is the calling mode where we add a user */
+ snprintf(combined_inet_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 : "")
+ );
- 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;
- }
+ CtdlSetEmailAddressesForUser(usbuf.fullname, combined_inet_emails);
+}
- 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;
+/*
+ * If our system still has a "refcount_adjustments.dat" sitting around from an old version, ingest it now.
+ */
+int ProcessOldStyleAdjRefCountQueue(void)
+{
+ int r;
+ FILE *fp;
+ struct arcq arcq_rec;
+ int num_records_processed = 0;
+
+ fp = fopen(file_arcq, "rb");
+ if (fp == NULL) {
+ return(num_records_processed);
}
- /* this is the calling mode where we do the processing */
+ syslog(LOG_INFO, "msgbase: ingesting %s", file_arcq);
- int i;
- struct ctdluser u;
+ while (fread(&arcq_rec, sizeof(struct arcq), 1, fp) == 1) {
+ AdjRefCount(arcq_rec.arcq_msgnum, arcq_rec.arcq_delta);
+ ++num_records_processed;
+ }
- for (i=0; i<num_m; ++i) {
- syslog(LOG_DEBUG, "<%s> = <%s>", m[i].name, m[i].emails);
- if (CtdlGetUser(&u, m[i].name) == 0) {
- safestrncpy(u.emailaddrs, m[i].emails, sizeof u.emailaddrs);
- CtdlPutUser(&u);
- }
+ fclose(fp);
+ r = unlink(file_arcq);
+ if (r != 0) {
+ syslog(LOG_ERR, "%s: %m", file_arcq);
}
- free(m);
- num_m = 0;
- alloc_m = 0;
- return;
+
+ return(num_records_processed);
}
void move_inet_addrs_from_vcards_to_user_records(void)
{
ForEachUser(miafvtur_backend, NULL);
- miafvtur_backend(NULL, NULL);
CtdlRebuildDirectoryIndex();
}
/*
- * Based on the server version number reported by the existing database,
- * run in-place data format upgrades until everything is up to date.
+ * Create a default administrator account so we can log in to a new installation
*/
-void check_server_upgrades(void) {
-
- syslog(LOG_INFO, "Existing database version on disk is %d", CtdlGetConfigInt("MM_hosted_upgrade_level"));
+void create_default_admin_account(void) {
+ struct ctdluser usbuf;
+ create_user(DEFAULT_ADMIN_USERNAME, CREATE_USER_DO_NOT_BECOME_USER, (-1));
+ CtdlGetUser(&usbuf, DEFAULT_ADMIN_USERNAME);
+ safestrncpy(usbuf.password, DEFAULT_ADMIN_PASSWORD, sizeof(usbuf.password));
+ usbuf.axlevel = AxAideU;
+ CtdlPutUser(&usbuf);
+ CtdlSetConfigStr("c_sysadm", DEFAULT_ADMIN_USERNAME);
+}
- reindex_uids(); // FIXME FIXME FIXME remove this line after testing
+/*
+ * Based on the server version number reported by the existing database,
+ * run in-place data format upgrades until everything is up to date.
+ */
+void pre_startup_upgrades(void) {
+ oldver = CtdlGetConfigInt("MM_hosted_upgrade_level");
+ syslog(LOG_INFO, "Existing database version on disk is %d", oldver);
+ update_config();
- if (CtdlGetConfigInt("MM_hosted_upgrade_level") < REV_LEVEL) {
- syslog(LOG_WARNING, "Server hosted updates need to be processed at this time. Please wait...");
+ if (oldver < REV_LEVEL) {
+ syslog(LOG_WARNING, "Running pre-startup database upgrades.");
}
else {
return;
}
- update_config();
-
- if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 591)) {
+ if ((oldver > 000) && (oldver < 591)) {
syslog(LOG_EMERG, "This database is too old to be upgraded. Citadel server will exit.");
exit(EXIT_FAILURE);
}
- if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 913)) {
+ if ((oldver > 000) && (oldver < 913)) {
reindex_uids();
}
- if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 659)) {
+ if ((oldver > 000) && (oldver < 659)) {
rebuild_euid_index();
}
- if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 735) {
+ if (oldver < 735) {
fix_sys_user_name();
}
- if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 736) {
+ if (oldver < 736) {
rebuild_usersbynumber();
}
- if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 790) {
+ if (oldver < 790) {
remove_thread_users();
}
- if (CtdlGetConfigInt("MM_hosted_upgrade_level") < 810) {
+ if (oldver < 810) {
struct ctdlroom QRoom;
if (!CtdlGetRoom(&QRoom, SMTP_SPOOLOUT_ROOM)) {
QRoom.QRdefaultview = VIEW_QUEUE;
}
}
- if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 902)) {
+ if ((oldver > 000) && (oldver < 902)) {
ingest_old_roominfo_and_roompic_files();
}
- if ((CtdlGetConfigInt("MM_hosted_upgrade_level") > 000) && (CtdlGetConfigInt("MM_hosted_upgrade_level") < 912)) {
- move_inet_addrs_from_vcards_to_user_records();
- }
-
CtdlSetConfigInt("MM_hosted_upgrade_level", REV_LEVEL);
/*
CtdlSetConfigInt("c_ep_mode", EXPIRE_MANUAL);
CtdlSetConfigInt("c_ep_value", 0);
}
+
+ /*
+ * If this is the first run on an empty database, create a default administrator
+ */
+ if (oldver == 0) {
+ create_default_admin_account();
+ }
+}
+
+
+/*
+ * 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 module name for the log */
+ return "upgrade";
+}