summaryrefslogtreecommitdiff
path: root/includes/update.inc
diff options
context:
space:
mode:
Diffstat (limited to 'includes/update.inc')
-rw-r--r--includes/update.inc60
1 files changed, 60 insertions, 0 deletions
diff --git a/includes/update.inc b/includes/update.inc
index 181bd712e..e27dd42d1 100644
--- a/includes/update.inc
+++ b/includes/update.inc
@@ -417,3 +417,63 @@ function update_finished($success, $results, $operations) {
}
}
+/**
+ * Return a list of all the pending database updates.
+ *
+ * @return
+ * An associative array keyed by module name which contains all information
+ * about database updates that need to be run, and any updates that are not
+ * going to proceed due to missing requirements. The system module will
+ * always be listed first.
+ *
+ * The subarray for each module can contain the following keys:
+ * - start: The starting update that is to be processed. If this does not
+ * exist then do not process any updates for this module as there are
+ * other requirements that need to be resolved.
+ * - warning: Any warnings about why this module can not be updated.
+ * - pending: An array of all the pending updates for the module including
+ * the update number and the description from source code comment for
+ * each update function. This array is keyed by the update number.
+ */
+function update_get_update_list() {
+ // Make sure that the system module is first in the list of updates.
+ $ret = array('system' => array());
+
+ $modules = drupal_get_installed_schema_version(NULL, FALSE, TRUE);
+ foreach ($modules as $module => $schema_version) {
+ $pending = array();
+ $updates = drupal_get_schema_versions($module);
+ // Skip incompatible module updates, otherwise test schema versions.
+ if (!update_check_incompatibility($module) && $updates !== FALSE && $schema_version >= 0) {
+ // module_invoke returns NULL for nonexisting hooks, so if no updates
+ // are removed, it will == 0.
+ $last_removed = module_invoke($module, 'update_last_removed');
+ if ($schema_version < $last_removed) {
+ $ret[$module]['warning'] = '<em>' . $module . '</em> module can not be updated. Its schema version is ' . $schema_version . '. Updates up to and including ' . $last_removed . ' have been removed in this release. In order to update <em>' . $module . '</em> module, you will first <a href="http://drupal.org/upgrade">need to upgrade</a> to the last version in which these updates were available.';
+ continue;
+ }
+
+ $updates = drupal_map_assoc($updates);
+ foreach (array_keys($updates) as $update) {
+ if ($update > $schema_version) {
+ // The description for an update comes from its Doxygen.
+ $func = new ReflectionFunction($module . '_update_' . $update);
+ $description = str_replace(array("\n", '*', '/'), '', $func->getDocComment());
+ $ret[$module]['pending'][$update] = "$update - $description";
+ if (!isset($ret[$module]['start'])) {
+ $ret[$module]['start'] = $update;
+ }
+ }
+ }
+ if (!isset($ret[$module]['start']) && isset($ret[$module]['pending'])) {
+ $ret[$module]['start'] = $schema_version;
+ }
+ }
+ }
+
+ if (empty($ret['system'])) {
+ unset($ret['system']);
+ }
+ return $ret;
+}
+