Version 1
[yaffs-website] / vendor / drush / drush / commands / pm / updatestatus.pm.inc
diff --git a/vendor/drush/drush/commands/pm/updatestatus.pm.inc b/vendor/drush/drush/commands/pm/updatestatus.pm.inc
new file mode 100644 (file)
index 0000000..535d4dc
--- /dev/null
@@ -0,0 +1,246 @@
+<?php
+
+/**
+ * @file
+ * pm-updatestatus command implementation.
+ */
+
+/**
+ * Command callback. Displays update status info of installed projects.
+ *
+ * Pass specific projects as arguments, otherwise we show all that are
+ * updateable.
+ */
+function drush_pm_updatestatus() {
+  // Get specific requests.
+  $args = pm_parse_arguments(func_get_args(), FALSE);
+
+  // Get installed extensions and projects.
+  $extensions = drush_get_extensions();
+  $projects = drush_get_projects($extensions);
+
+  // Parse out project name and version.
+  $requests = array();
+  foreach ($args as $request) {
+    $request = pm_parse_request($request, NULL, $projects);
+    $requests[$request['name']] = $request;
+  }
+
+  // Get the engine instance.
+  $update_status = drush_get_engine('update_status');
+
+  // If the user doesn't provide a value for check-disabled option,
+  // and the update backend is 'drupal', use NULL, so the engine
+  // will respect update.module defaults.
+  $check_disabled_default = ($update_status->engine == 'drupal') ? NULL : FALSE;
+  $check_disabled = drush_get_option('check-disabled', $check_disabled_default);
+
+  $update_info = $update_status->getStatus($projects, $check_disabled);
+
+  foreach ($extensions as $name => $extension) {
+    // Add an item to $update_info for each enabled extension which was obtained
+    // from cvs or git and its project is unknown (because of cvs_deploy or
+    // git_deploy is not enabled).
+    if (!isset($extension->info['project'])) {
+      if ((isset($extension->vcs)) && ($extension->status)) {
+        $update_info[$name] = array(
+          'name' => $name,
+          'label' => $extension->label,
+          'existing_version' => 'Unknown',
+          'status' => DRUSH_UPDATESTATUS_PROJECT_NOT_PACKAGED,
+          'status_msg' => dt('Project was not packaged by drupal.org but obtained from !vcs. You need to enable !vcs_deploy module', array('!vcs' => $extension->vcs)),
+        );
+        // The user may have requested to update a project matching this
+        // extension. If it was by coincidence or error we don't mind as we've
+        // already added an item to $update_info. Just clean up $requests.
+        if (isset($requests[$name])) {
+          unset($requests[$name]);
+        }
+      }
+    }
+    // Additionally if the extension name is distinct to the project name and
+    // the user asked to update the extension, fix the request.
+    elseif ((isset($requests[$name])) && ($name != $extension->info['project'])) {
+      $requests[$extension->info['project']] = $requests[$name];
+      unset($requests[$name]);
+    }
+  }
+  // If specific project updates were requested then remove releases for all
+  // others.
+  $requested = func_get_args();
+  if (!empty($requested)) {
+    foreach ($update_info as $name => $project) {
+      if (!isset($requests[$name])) {
+        unset($update_info[$name]);
+      }
+    }
+  }
+  // Add an item to $update_info for each request not present in $update_info.
+  foreach ($requests as $name => $request) {
+    if (!isset($update_info[$name])) {
+      // Disabled projects.
+      if ((isset($projects[$name])) && ($projects[$name]['status'] == 0)) {
+        $update_info[$name] = array(
+          'name' => $name,
+          'label' => $projects[$name]['label'],
+          'existing_version' => $projects[$name]['version'],
+          'status' => DRUSH_UPDATESTATUS_REQUESTED_PROJECT_NOT_UPDATEABLE,
+        );
+        unset($requests[$name]);
+      }
+      // At this point we are unable to find matching installed project.
+      // It does not exist at all or it is misspelled,...
+      else {
+        $update_info[$name] = array(
+          'name' => $name,
+          'label' => $name,
+          'existing_version' => 'Unknown',
+          'status'=> DRUSH_UPDATESTATUS_REQUESTED_PROJECT_NOT_FOUND,
+        );
+      }
+    }
+  }
+
+  // If specific versions were requested, match the requested release.
+  foreach ($requests as $name => $request) {
+    if (!empty($request['version'])) {
+      if (empty($update_info[$name]['releases'][$request['version']])) {
+        $update_info[$name]['status'] = DRUSH_UPDATESTATUS_REQUESTED_VERSION_NOT_FOUND;
+      }
+      elseif ($request['version'] == $update_info[$name]['existing_version']) {
+        $update_info[$name]['status'] = DRUSH_UPDATESTATUS_REQUESTED_VERSION_CURRENT;
+      }
+      // TODO: should we warn/reject if this is a downgrade?
+      else {
+        $update_info[$name]['status'] = DRUSH_UPDATESTATUS_REQUESTED_VERSION_NOT_CURRENT;
+        $update_info[$name]['candidate_version'] = $request['version'];
+      }
+    }
+  }
+  // Process locks specified on the command line.
+  $locked_list = drush_pm_update_lock($update_info, drush_get_option_list('lock'), drush_get_option_list('unlock'), drush_get_option('lock-message'));
+
+  // Build project updatable messages, set candidate version and mark
+  // 'updateable' in the project.
+  foreach ($update_info as $key => $project) {
+    switch($project['status']) {
+      case DRUSH_UPDATESTATUS_NOT_SECURE:
+        $status = dt('SECURITY UPDATE available');
+        pm_release_recommended($project);
+        break;
+      case DRUSH_UPDATESTATUS_REVOKED:
+        $status = dt('Installed version REVOKED');
+        pm_release_recommended($project);
+        break;
+      case DRUSH_UPDATESTATUS_NOT_SUPPORTED:
+        $status = dt('Installed version not supported');
+        pm_release_recommended($project);
+        break;
+      case DRUSH_UPDATESTATUS_NOT_CURRENT:
+        $status = dt('Update available');
+        pm_release_recommended($project);
+        break;
+      case DRUSH_UPDATESTATUS_CURRENT:
+        $status = dt('Up to date');
+        pm_release_recommended($project);
+        $project['updateable'] = FALSE;
+        break;
+      case DRUSH_UPDATESTATUS_NOT_CHECKED:
+      case DRUSH_UPDATESTATUS_NOT_FETCHED:
+      case DRUSH_UPDATESTATUS_FETCH_PENDING:
+        $status = dt('Unable to check status');
+        break;
+      case DRUSH_UPDATESTATUS_PROJECT_NOT_PACKAGED:
+        $status = $project['status_msg'];
+        break;
+      case DRUSH_UPDATESTATUS_REQUESTED_PROJECT_NOT_UPDATEABLE:
+        $status = dt('Project has no enabled extensions and can\'t be updated');
+        break;
+      case DRUSH_UPDATESTATUS_REQUESTED_PROJECT_NOT_FOUND:
+        $status = dt('Specified project not found');
+        break;
+      case DRUSH_UPDATESTATUS_REQUESTED_VERSION_NOT_FOUND:
+        $status = dt('Specified version not found');
+        break;
+      case DRUSH_UPDATESTATUS_REQUESTED_VERSION_CURRENT:
+        $status = dt('Specified version already installed');
+        break;
+      case DRUSH_UPDATESTATUS_REQUESTED_VERSION_NOT_CURRENT:
+        $status = dt('Specified version available');
+        $project['updateable'] = TRUE;
+        break;
+      default:
+        $status = dt('Unknown');
+        break;
+    }
+
+    if (isset($project['locked'])) {
+      $status = $project['locked'] . " ($status)";
+    }
+    // Persist candidate_version in $update_info (plural).
+    if (empty($project['candidate_version'])) {
+      $update_info[$key]['candidate_version'] = $project['existing_version']; // Default to no change
+    }
+    else {
+      $update_info[$key]['candidate_version'] = $project['candidate_version'];
+    }
+    $update_info[$key]['status_msg'] = $status;
+    if (isset($project['updateable'])) {
+      $update_info[$key]['updateable'] = $project['updateable'];
+    }
+  }
+
+  // Filter projects to show.
+  return pm_project_filter($update_info, drush_get_option('security-only'));
+}
+
+/**
+ * Filter projects based on verbosity level and $security_only flag.
+ *
+ * @param array $update_info
+ *   Update info for projects.
+ * @param bool $security_only
+ *   Whether to select only projects with security updates.
+ *
+ * @return
+ *   Array of projects matching filter criteria.
+ */
+function pm_project_filter($update_info, $security_only) {
+  $eligible = array();
+  foreach ($update_info as $key => $project) {
+    if ($security_only) {
+      if ($project['status'] == DRUSH_UPDATESTATUS_NOT_SECURE) {
+        $eligible[$key] = $project;
+      }
+    }
+    elseif (drush_get_context('DRUSH_VERBOSE')) {
+      $eligible[$key] = $project;
+    }
+    elseif ($project['status'] != DRUSH_UPDATESTATUS_CURRENT) {
+      $eligible[$key] = $project;
+    }
+  }
+  return $eligible;
+}
+
+/**
+ * Set a release to a recommended version (if available), and set as updateable.
+ */
+function pm_release_recommended(&$project) {
+  if (isset($project['recommended'])) {
+    $project['candidate_version'] = $project['recommended'];
+    $project['updateable'] = TRUE;
+  }
+  // If installed version is dev and the candidate version is older, choose
+  // latest dev as candidate.
+  if (($project['install_type'] == 'dev') && isset($project['candidate_version'])) {
+    if ($project['releases'][$project['candidate_version']]['date'] < $project['datestamp']) {
+      $project['candidate_version'] = $project['latest_dev'];
+      if ($project['releases'][$project['candidate_version']]['date'] <= $project['datestamp']) {
+        $project['candidate_version'] = $project['existing_version'];
+        $project['updateable'] = FALSE;
+      }
+    }
+  }
+}
+