aboutsummaryrefslogtreecommitdiff
path: root/engine/lib/version.php
diff options
context:
space:
mode:
authorbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-02-18 00:46:54 +0000
committerbrettp <brettp@36083f99-b078-4883-b0ff-0f9b5a30f544>2011-02-18 00:46:54 +0000
commit5a06233304a9965c8319ec5c1fcc4fd582393d02 (patch)
treec70268e7920779f890ad3858c39b1ed2b0fa1623 /engine/lib/version.php
parent5ee52a817885e641a56eef6ebcdd4250ef8be4b5 (diff)
downloadelgg-5a06233304a9965c8319ec5c1fcc4fd582393d02.tar.gz
elgg-5a06233304a9965c8319ec5c1fcc4fd582393d02.tar.bz2
Fixes #1433, #2183. Upgrades are now tracked and will be run if needed regardless of version.
git-svn-id: http://code.elgg.org/elgg/trunk@8277 36083f99-b078-4883-b0ff-0f9b5a30f544
Diffstat (limited to 'engine/lib/version.php')
-rw-r--r--engine/lib/version.php211
1 files changed, 168 insertions, 43 deletions
diff --git a/engine/lib/version.php b/engine/lib/version.php
index 4ffe85bc5..60ae2c973 100644
--- a/engine/lib/version.php
+++ b/engine/lib/version.php
@@ -19,47 +19,151 @@ function upgrade_code($version, $quiet = FALSE) {
global $CONFIG;
$version = (int) $version;
+ $upgrade_path = elgg_get_config('path') . 'engine/lib/upgrades/';
+ $processed_upgrades = unserialize(datalist_get('processed_upgrades'));
+ // the day we started the new upgrade names
+ $upgrade_epoch = 2011021700;
- if ($handle = opendir($CONFIG->path . 'engine/lib/upgrades/')) {
- $upgrades = array();
-
- while ($updatefile = readdir($handle)) {
- // Look for upgrades and add to upgrades list
- if (!is_dir($CONFIG->path . 'engine/lib/upgrades/' . $updatefile)) {
- if (preg_match('/^([0-9]{10})\.(php)$/', $updatefile, $matches)) {
- $core_version = (int) $matches[1];
- if ($core_version > $version) {
- $upgrades[] = $updatefile;
- }
+ if (!$processed_upgrades) {
+ $processed_upgrades = array();
+ }
+
+ $upgrades = array();
+
+ $upgrade_files = elgg_get_upgrade_files($upgrade_path);
+
+ if ($upgrade_files === false) {
+ return false;
+ }
+
+ // bootstrap into the new upgrade system.
+ // can't do this in an upgrade because we need to check for 2010050701,
+ // which would already have been run by then.
+ if ($version < $upgrade_epoch) {
+ foreach ($upgrade_files as $upgrade_file) {
+ $upgrade_version = elgg_get_upgrade_file_version($upgrade_file);
+
+ // the upgrade that made life difficult
+ // the only way to test if we're upgrading from 1.7 to 1.8 or within 1.8
+ // is to test for the the walled_garden config option, which
+ // 2010050701 explicitly sets
+ if ($upgrade_version == 2010050701) {
+ $db_prefix = elgg_get_config('dbprefix');
+ $site_guid = elgg_get_config('site_guid');
+ $q = "SELECT value FROM {$db_prefix}config
+ WHERE name = 'walled_garden' AND site_guid = {$site_guid}";
+ $result = get_data_row($q);
+ if (!$result) {
+ $upgrades[] = $upgrade_file;
}
+
+ continue;
+ } elseif ($version < $upgrade_version) {
+ $upgrades[] = $upgrade_file;
+ } else {
+ // all of the upgrades before the epoch have been run except one...
+ $processed_upgrades[] = $upgrade_file;
}
}
+ } else {
+ // add any upgrades that haven't been run to the upgrades list
+ $upgrades = elgg_get_unprocessed_upgrades($upgrade_files, $processed_upgrades);
+ }
+
+ // Sort and execute
+ ksort($upgrades);
+
+ foreach ($upgrades as $upgrade) {
+ $upgrade_version = elgg_get_upgrade_file_version($upgrade);
+ $success = true;
- // Sort and execute
- asort($upgrades);
-
- if (sizeof($upgrades) > 0) {
- foreach ($upgrades as $upgrade) {
- // hide all errors.
- if ($quiet) {
- // hide include errors as well as any exceptions that might happen
- try {
- if (!@include($CONFIG->path . 'engine/lib/upgrades/' . $upgrade)) {
- error_log($e->getmessage());
- }
- } catch (Exception $e) {
- error_log($e->getmessage());
- }
- } else {
- include($CONFIG->path . 'engine/lib/upgrades/' . $upgrade);
+ // hide all errors.
+ if ($quiet) {
+ // hide include errors as well as any exceptions that might happen
+ try {
+ if (!@include("$upgrade_path/$upgrade")) {
+ $success = false;
+ error_log($e->getmessage());
}
+ } catch (Exception $e) {
+ $success = false;
+ error_log($e->getmessage());
+ }
+ } else {
+ if (!include("$upgrade_path/$upgrade")) {
+ $success = false;
}
}
- return TRUE;
+ if ($success) {
+ // incrementally set upgrade so we know where to start if something fails.
+ $processed_upgrades[] = $upgrade;
+
+ // don't set the version to a lower number in instances where an upgrade
+ // has been merged from a lower version
+ if ($upgrade_version > $version) {
+ datalist_set('version', $upgrade_version);
+ }
+
+ $processed_upgrades = array_unique($processed_upgrades);
+ datalist_set('processed_upgrades', serialize($processed_upgrades));
+ } else {
+ return false;
+ }
}
- return FALSE;
+ return true;
+}
+
+/**
+ * Returns the version of the upgrade filename.
+ *
+ * @param string $filename The upgrade filename. No full path.
+ * @return int|false
+ * @since 1.8
+ */
+function elgg_get_upgrade_file_version($filename) {
+ preg_match('/^([0-9]{10})([\.a-z0-9-_]+)?\.(php)$/i', $filename, $matches);
+
+ if (isset($matches[1])) {
+ return (int) $matches[1];
+ }
+
+ return false;
+}
+
+/**
+ * Returns a list of upgrade files relative to the $upgrade_path dir.
+ *
+ * @param string $upgrade_path The up
+ * @return array|false
+ */
+function elgg_get_upgrade_files($upgrade_path = null) {
+ if (!$upgrade_path) {
+ $upgrade_path = elgg_get_config('path') . 'engine/lib/upgrades/';
+ }
+ $upgrade_path = sanitise_filepath($upgrade_path);
+ $handle = opendir($upgrade_path);
+
+ if (!$handle) {
+ return false;
+ }
+
+ $upgrade_files = array();
+
+ while ($upgrade_file = readdir($handle)) {
+ // make sure this is a wellformed upgrade.
+ if (is_dir($upgrade_path . '$upgrade_file')) {
+ continue;
+ }
+ $upgrade_version = elgg_get_upgrade_file_version($upgrade_file);
+ if (!$upgrade_version) {
+ continue;
+ }
+ $upgrade_files[] = $upgrade_file;
+ }
+
+ return $upgrade_files;
}
/**
@@ -82,6 +186,30 @@ function get_version($humanreadable = false) {
}
/**
+ * Checks if any upgrades need to be run.
+ *
+ * @param null|array $upgrade_files Optional upgrade files
+ * @param null|array $processed_upgrades Optional processed upgrades
+ *
+ * @return array()
+ */
+function elgg_get_unprocessed_upgrades($upgrade_files = null, $processed_upgrades = null) {
+ if ($upgrade_files === null) {
+ $upgrade_files = elgg_get_upgrade_files();
+ }
+
+ if ($processed_upgrades === null) {
+ $processed_upgrades = unserialize(datalist_get('processed_upgrades'));
+ if (!is_array($processed_upgrades)) {
+ $processed_upgrades = array();
+ }
+ }
+
+ $unprocessed = array_diff($upgrade_files, $processed_upgrades);
+ return $unprocessed;
+}
+
+/**
* Determines whether or not the database needs to be upgraded.
*
* @return true|false Depending on whether or not the db version matches the code version
@@ -114,23 +242,20 @@ function version_upgrade() {
// See http://trac.elgg.org/elgg/ticket/1432 for more.
$quiet = !$dbversion;
- // Upgrade database
- if (db_upgrade($dbversion, '', $quiet)) {
- system_message(elgg_echo('upgrade:db'));
- }
+ // Note: Database upgrades are deprecated as of 1.8. Use code upgrades. See #1433
- // Upgrade core
if (upgrade_code($dbversion, $quiet)) {
system_message(elgg_echo('upgrade:core'));
- }
- // Now we trigger an event to give the option for plugins to do something
- $upgrade_details = new stdClass;
- $upgrade_details->from = $dbversion;
- $upgrade_details->to = get_version();
+ // Now we trigger an event to give the option for plugins to do something
+ $upgrade_details = new stdClass;
+ $upgrade_details->from = $dbversion;
+ $upgrade_details->to = get_version();
+
+ elgg_trigger_event('upgrade', 'upgrade', $upgrade_details);
- elgg_trigger_event('upgrade', 'upgrade', $upgrade_details);
+ return true;
+ }
- // Update the version
- datalist_set('version', get_version());
+ return false;
}