update.module 20 KB
Newer Older
1 2 3 4 5 6 7 8
<?php
// $Id$

/**
 * @file
 * The "Update status" module checks for available updates of Drupal core and
 * any installed contributed modules and themes. It warns site administrators
 * if newer releases are available via the system status report
9
 * (admin/reports/status), the module and theme pages, and optionally via email.
10 11 12 13 14 15 16 17 18 19
 */

/**
 * URL to check for updates, if a given project doesn't define its own.
 */
define('UPDATE_DEFAULT_URL', 'http://updates.drupal.org/release-history');

// These are internally used constants for this code, do not modify.

/**
20
 * Project is missing security update(s).
21
 */
22
define('UPDATE_NOT_SECURE', 1);
23 24

/**
25
 * Current release has been unpublished and is no longer available.
26
 */
27 28 29 30 31 32
define('UPDATE_REVOKED', 2);

/**
 * Current release is no longer supported by the project maintainer.
 */
define('UPDATE_NOT_SUPPORTED', 3);
33 34 35 36

/**
 * Project has a new release available, but it is not a security release.
 */
37 38 39 40 41 42
define('UPDATE_NOT_CURRENT', 4);

/**
 * Project is up to date.
 */
define('UPDATE_CURRENT', 5);
43 44 45 46

/**
 * Project's status cannot be checked.
 */
47
define('UPDATE_NOT_CHECKED', -1);
48 49 50 51

/**
 * No available update data was found for project.
 */
52 53
define('UPDATE_UNKNOWN', -2);

54 55 56 57 58 59

/**
 * Implementation of hook_help().
 */
function update_help($path, $arg) {
  switch ($path) {
60
    case 'admin/reports/updates':
61 62 63
      $output = '<p>'. t('Here you can find information about available updates for your installed modules and themes. Note that each module or theme is part of a "project", which may or may not have the same name, and might include multiple modules or themes within it.') .'</p>';
      $output .= '<p>'. t('To extend the functionality or to change the look of your site, a number of contributed <a href="@modules">modules</a> and <a href="@themes">themes</a> are available.', array('@modules' => 'http://drupal.org/project/modules', '@themes' => 'http://drupal.org/project/themes')) .'</p>';
      return $output;
64 65 66 67 68 69 70 71 72 73 74
    case 'admin/build/themes':
    case 'admin/build/modules':
      include_once './includes/install.inc';
      $status = update_requirements('runtime');
      foreach (array('core', 'contrib') as $report_type) {
        $type = 'update_'. $report_type;
        if (isset($status[$type]['severity'])) {
          if ($status[$type]['severity'] == REQUIREMENT_ERROR) {
            drupal_set_message($status[$type]['description'], 'error');
          }
          elseif ($status[$type]['severity'] == REQUIREMENT_WARNING) {
75
            drupal_set_message($status[$type]['description'], 'warning');
76 77 78
          }
        }
      }
79
      return '<p>'. t('See the <a href="@available_updates">available updates</a> page for information on installed modules and themes with new versions released.', array('@available_updates' => url('admin/reports/updates'))) .'</p>';
80

81 82
    case 'admin/reports/updates/settings':
    case 'admin/reports/status':
83 84 85
      // These two pages don't need additional nagging.
      break;

86 87
    case 'admin/help#update':
      $output = '<p>'. t("The Update status module periodically checks for new versions of your site's software (including contributed modules and themes), and alerts you to available updates.") .'</p>';
88
      $output .= '<p>'. t('The <a href="@update-report">report of available updates</a> will alert you when new releases are available for download. You may configure options for update checking frequency and notifications at the <a href="@update-settings">Update status module settings page</a>.', array('@update-report' => url('admin/reports/updates'), '@update-settings' => url('admin/reports/updates/settings'))) .'</p>';
89
      $output .= '<p>'. t('Please note that in order to provide this information, anonymous usage statistics are sent to drupal.org. If desired, you may disable the Update status module from the <a href="@modules">module administration page</a>.', array('@modules' => url('admin/build/modules'))) .'</p>';
90
      $output .= '<p>'. t('For more information, see the online handbook entry for <a href="@update">Update status module</a>.', array('@update' => 'http://drupal.org/handbook/modules/update')) .'</p>';
91 92
      return $output;

93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118
    default:
      // Otherwise, if we're on *any* admin page and there's a security
      // update missing, print an error message about it.
      if (arg(0) == 'admin' && strpos($path, '#') === FALSE
          && user_access('administer site configuration')) {
        include_once './includes/install.inc';
        $status = update_requirements('runtime');
        foreach (array('core', 'contrib') as $report_type) {
          $type = 'update_'. $report_type;
          if (isset($status[$type])
              && isset($status[$type]['reason'])
              && $status[$type]['reason'] === UPDATE_NOT_SECURE) {
            drupal_set_message($status[$type]['description'], 'error');
          }
        }
      }

  }
}

/**
 * Implementation of hook_menu().
 */
function update_menu() {
  $items = array();

119
  $items['admin/reports/updates'] = array(
120 121 122 123 124 125 126
    'title' => 'Available updates',
    'description' => 'Get a status report about available updates for your installed modules and themes.',
    'page callback' => 'update_status',
    'access arguments' => array('administer site configuration'),
    'file' => 'update.report.inc',
    'weight' => 10,
  );
127
  $items['admin/reports/updates/list'] = array(
128 129 130 131 132 133
    'title' => 'List',
    'page callback' => 'update_status',
    'access arguments' => array('administer site configuration'),
    'file' => 'update.report.inc',
    'type' => MENU_DEFAULT_LOCAL_TASK,
  );
134
  $items['admin/reports/updates/settings'] = array(
135 136 137 138 139 140 141
    'title' => 'Settings',
    'page callback' => 'drupal_get_form',
    'page arguments' => array('update_settings'),
    'access arguments' => array('administer site configuration'),
    'file' => 'update.settings.inc',
    'type' => MENU_LOCAL_TASK,
  );
142
  $items['admin/reports/updates/check'] = array(
143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195
    'title' => 'Manual update check',
    'page callback' => 'update_manual_status',
    'access arguments' => array('administer site configuration'),
    'file' => 'update.fetch.inc',
    'type' => MENU_CALLBACK,
  );

  return $items;
}

/**
 * Implementation of the hook_theme() registry.
 */
function update_theme() {
  return array(
    'update_settings' => array(
      'arguments' => array('form' => NULL),
    ),
    'update_report' => array(
      'arguments' => array('data' => NULL),
    ),
    'update_version' => array(
      'arguments' => array('version' => NULL, 'tag' => NULL, 'class' => NULL),
    ),
  );
}

/**
 * Implementation of hook_requirements.
 *
 * @return
 *   An array describing the status of the site regarding available updates.
 *   If there is no update data, only one record will be returned, indicating
 *   that the status of core can't be determined. If data is available, there
 *   will be two records: one for core, and another for all of contrib
 *   (assuming there are any contributed modules or themes enabled on the
 *   site). In addition to the fields expected by hook_requirements ('value',
 *   'severity', and optionally 'description'), this array will contain a
 *   'reason' attribute, which is an integer constant to indicate why the
 *   given status is being returned (UPDATE_NOT_SECURE, UPDATE_NOT_CURRENT, or
 *   UPDATE_UNKNOWN). This is used for generating the appropriate e-mail
 *   notification messages during update_cron(), and might be useful for other
 *   modules that invoke update_requirements() to find out if the site is up
 *   to date or not.
 *
 * @see _update_message_text()
 * @see _update_cron_notify()
 */
function update_requirements($phase) {
  if ($phase == 'runtime') {
    if ($available = update_get_available(FALSE)) {
      include_once './modules/update/update.compare.inc';
      $data = update_calculate_project_data($available);
196 197
      // First, populate the requirements for core:
      $requirements['update_core'] = _update_requirement_check($data['drupal'], 'core');
198 199 200
      // We don't want to check drupal a second time.
      unset($data['drupal']);
      if (!empty($data)) {
201 202 203 204 205 206 207
        // Now, sort our $data array based on each project's status. The
        // status constants are numbered in the right order of precedence, so
        // we just need to make sure the projects are sorted in ascending
        // order of status, and we can look at the first project we find.
        uasort($data, '_update_project_status_sort');
        $first_project = reset($data);
        $requirements['update_contrib'] = _update_requirement_check($first_project, 'contrib');
208 209 210
      }
    }
    else {
211
      $requirements['update_core']['title'] = t('Drupal core update status');
212 213 214 215 216 217 218 219 220
      $requirements['update_core']['value'] = t('No update data available');
      $requirements['update_core']['severity'] = REQUIREMENT_WARNING;
      $requirements['update_core']['reason'] = UPDATE_UNKNOWN;
      $requirements['update_core']['description'] = _update_no_data();
    }
    return $requirements;
  }
}

221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255
/**
 * Private helper method to fill in the requirements array.
 *
 * This is shared for both core and contrib to generate the right elements in
 * the array for hook_requirements().
 *
 * @param $project
 *  Array of information about the project we're testing as returned by
 *  update_calculate_project_data().
 * @param $type
 *  What kind of project is this ('core' or 'contrib').
 *
 * @return
 *  An array to be included in the nested $requirements array.
 *
 * @see hook_requirements()
 * @see update_requirements()
 * @see update_calculate_project_data()
 */
function _update_requirement_check($project, $type) {
  $requirement = array();
  if ($type == 'core') {
    $requirement['title'] = t('Drupal core update status');
  }
  else {
    $requirement['title'] = t('Module and theme update status');
  }
  $status = $project['status'];
  if ($status != UPDATE_CURRENT) {
    $requirement['reason'] = $status;
    $requirement['description'] = _update_message_text($type, $status, TRUE);
    $requirement['severity'] = REQUIREMENT_ERROR;
  }
  switch ($status) {
    case UPDATE_NOT_SECURE:
256
      $requirement_label = t('Not secure!');
257 258
      break;
    case UPDATE_REVOKED:
259
      $requirement_label = t('Revoked!');
260 261
      break;
    case UPDATE_NOT_SUPPORTED:
262
      $requirement_label = t('Unsupported release');
263 264
      break;
    case UPDATE_NOT_CURRENT:
265
      $requirement_label = t('Out of date');
266 267 268 269
      $requirement['severity'] = variable_get('update_notification_threshold', 'all') == 'all' ? REQUIREMENT_ERROR : REQUIREMENT_WARNING;
      break;
    case UPDATE_UNKNOWN:
    case UPDATE_NOT_CHECKED:
270
      $requirement_label = isset($project['reason']) ? $project['reason'] : t('Can not determine status');
271
      $requirement['severity'] = REQUIREMENT_WARNING;
272 273
      break;
    default:
274
      $requirement_label = t('Up to date');
275 276
  }
  if ($status != UPDATE_CURRENT && $type == 'core' && isset($project['recommended'])) {
277
    $requirement_label .= ' '. t('(version @version available)', array('@version' => $project['recommended']));
278
  }
279
  $requirement['value'] = l($requirement_label, 'admin/reports/updates');
280 281 282
  return $requirement;
}

283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314
/**
 * Implementation of hook_cron().
 */
function update_cron() {
  $frequency = variable_get('update_check_frequency', 1);
  $interval = 60 * 60 * 24 * $frequency;
  if (time() - variable_get('update_last_check', 0) > $interval) {
    update_refresh();
    _update_cron_notify();
  }
}

/**
 * Implementation of hook_form_alter().
 *
 * Adds a submit handler to the system modules and themes forms, so that if a
 * site admin saves either form, we invalidate the cache of available updates.
 *
 * @see update_invalidate_cache()
 */
function update_form_alter(&$form, $form_state, $form_id) {
  if ($form_id == 'system_modules' || $form_id == 'system_themes' ) {
    $form['#submit'][] = 'update_invalidate_cache';
  }
}

/**
 * Prints a warning message when there is no data about available updates.
 */
function _update_no_data() {
  $destination = drupal_get_destination();
  return t('No information is available about potential new releases for currently installed modules and themes. To check for updates, you may need to <a href="@run_cron">run cron</a> or you can <a href="@check_manually">check manually</a>. Please note that checking for available updates can take a long time, so please be patient.', array(
315 316
    '@run_cron' => url('admin/reports/status/run-cron', array('query' => $destination)),
    '@check_manually' => url('admin/reports/updates/check', array('query' => $destination)),
317 318 319 320 321 322 323
  ));
}

/**
 * Internal helper to try to get the update information from the cache
 * if possible, and to refresh the cache when necessary.
 *
324 325 326 327 328 329 330 331
 * In addition to checking the cache lifetime, this function also ensures that
 * there are no .info files for enabled modules or themes that have a newer
 * modification timestamp than the last time we checked for available update
 * data. If any .info file was modified, it almost certainly means a new
 * version of something was installed. Without fresh available update data,
 * the logic in update_calculate_project_data() will be wrong and produce
 * confusing, bogus results.
 *
332 333 334
 * @param $refresh
 *   Boolean to indicate if this method should refresh the cache automatically
 *   if there's no data.
335 336 337
 *
 * @see update_refresh()
 * @see update_get_projects()
338 339
 */
function update_get_available($refresh = FALSE) {
340
  include_once './modules/update/update.compare.inc';
341
  $available = array();
342 343 344 345 346 347 348 349 350 351 352 353 354

  // First, make sure that none of the .info files have a change time
  // newer than the last time we checked for available updates.
  $needs_refresh = FALSE;
  $last_check = variable_get('update_last_check', 0);
  $projects = update_get_projects();
  foreach ($projects as $key => $project) {
    if ($project['info']['_info_file_ctime'] > $last_check) {
      $needs_refresh = TRUE;
      break;
    }
  }
  if (!$needs_refresh && ($cache = cache_get('update_info', 'cache_update'))
355 356 357
       && $cache->expire > time()) {
    $available = $cache->data;
  }
358 359 360 361
  elseif ($needs_refresh || $refresh) {
    // If we need to refresh due to a newer .info file, ignore the argument
    // and force the refresh (e.g., even for update_requirements()) to prevent
    // bogus results.
362 363 364 365 366
    $available = update_refresh();
  }
  return $available;
}

367
/**
368 369 370 371 372
 * Implementation of hook_flush_caches().
 *
 * The function update.php (among others) calls this hook to flush the caches.
 * Since we're running update.php, we are likely to install a new version of
 * something, in which case, we want to check for available update data again.
373 374 375 376 377
 */
function update_flush_caches() {
  return array('cache_update');
}

378 379 380 381
/**
 * Invalidates any cached data relating to update status.
 */
function update_invalidate_cache() {
382
  cache_clear_all('*', 'cache_update', TRUE);
383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407
}

/**
 * Wrapper to load the include file and then refresh the release data.
 */
function update_refresh() {
  include_once './modules/update/update.fetch.inc';
  return _update_refresh();
}

/**
 * Implementation of hook_mail().
 *
 * Constructs the email notification message when the site is out of date.
 *
 * @param $key
 *   Unique key to indicate what message to build, always 'status_notify'.
 * @param $message
 *   Reference to the message array being built.
 * @param $params
 *   Array of parameters to indicate what kind of text to include in the
 *   message body. This is a keyed array of message type ('core' or 'contrib')
 *   as the keys, and the status reason constant (UPDATE_NOT_SECURE, etc) for
 *   the values.
 *
408 409 410
 * @see drupal_mail()
 * @see _update_cron_notify()
 * @see _update_message_text()
411 412 413 414 415 416 417 418
 */
function update_mail($key, &$message, $params) {
  $language = $message['language'];
  $langcode = $language->language;
  $message['subject'] .= t('New release(s) available for !site_name', array('!site_name' => variable_get('site_name', 'Drupal')), $langcode);
  foreach ($params as $msg_type => $msg_reason) {
    $message['body'][] = _update_message_text($msg_type, $msg_reason, FALSE, $language);
  }
419
  $message['body'][] = t('See the available updates page for more information:', array(), $langcode) ."\n". url('admin/reports/updates', array('absolute' => TRUE, 'language' => $language));
420 421 422 423 424 425 426
}

/**
 * Helper function to return the appropriate message text when the site is out
 * of date or missing a security update.
 *
 * These error messages are shared by both update_requirements() for the
427
 * site-wide status report at admin/reports/status and in the body of the
428 429 430 431 432 433
 * notification emails generated by update_cron().
 *
 * @param $msg_type
 *   String to indicate what kind of message to generate. Can be either
 *   'core' or 'contrib'.
 * @param $msg_reason
434
 *   Integer constant specifying why message is generated.
435 436 437 438 439 440 441 442 443 444 445
 * @param $report_link
 *   Boolean that controls if a link to the updates report should be added.
 * @param $language
 *   An optional language object to use.
 * @return
 *   The properly translated error message for the given key.
 */
function _update_message_text($msg_type, $msg_reason, $report_link = FALSE, $language = NULL) {
  $langcode = isset($language) ? $language->language : NULL;
  $text = '';
  switch ($msg_reason) {
446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472
    case UPDATE_NOT_SECURE:
      if ($msg_type == 'core') {
        $text = t('There is a security update available for your version of Drupal. To ensure the security of your server, you should update immediately!', array(), $langcode);
      }
      else {
        $text = t('There are security updates available for one or more of your modules or themes. To ensure the security of your server, you should update immediately!', array(), $langcode);
      }
      break;

    case UPDATE_REVOKED:
      if ($msg_type == 'core') {
        $text = t('Your version of Drupal has been revoked and is no longer available for download. Upgrading is strongly recommended!', array(), $langcode);
      }
      else {
        $text = t('The installed version of at least one of your modules or themes has been revoked and is no longer available for download. Upgrading or disabling is strongly recommended!', array(), $langcode);
      }
      break;

    case UPDATE_NOT_SUPPORTED:
      if ($msg_type == 'core') {
        $text = t('Your version of Drupal is no longer supported. Upgrading is strongly recommended!', array(), $langcode);
      }
      else {
        $text = t('The installed version of at least one of your modules or themes is no longer supported. Upgrading or disabling is strongly recommended! Please see the project homepage for more details.', array(), $langcode);
      }
      break;

473 474 475 476 477 478 479 480 481
    case UPDATE_NOT_CURRENT:
      if ($msg_type == 'core') {
        $text = t('There are updates available for your version of Drupal. To ensure the proper functioning of your site, you should update as soon as possible.', array(), $langcode);
      }
      else {
        $text = t('There are updates available for one or more of your modules or themes. To ensure the proper functioning of your site, you should update as soon as possible.', array(), $langcode);
      }
      break;

482 483
    case UPDATE_UNKNOWN:
    case UPDATE_NOT_CHECKED:
484
      if ($msg_type == 'core') {
485
        $text = t('There was a problem determining the status of available updates for your version of Drupal.', array(), $langcode);
486 487
      }
      else {
488
        $text = t('There was a problem determining the status of available updates for one or more of your modules or themes.', array(), $langcode);
489 490 491 492 493
      }
      break;
  }

  if ($report_link) {
494
    $text .= ' '. t('See the <a href="@available_updates">available updates</a> page for more information.', array('@available_updates' => url('admin/reports/updates', array('language' => $language))), $langcode);
495 496 497 498
  }

  return $text;
}
499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514

/**
 * Private sort function to order projects based on their status.
 *
 * @see update_requirements()
 * @see uasort()
 */
function _update_project_status_sort($a, $b) {
  // The status constants are numerically in the right order, so we can
  // usually subtract the two to compare in the order we want. However,
  // negative status values should be treated as if they are huge, since we
  // always want them at the bottom of the list.
  $a_status = $a['status'] > 0 ? $a['status'] : (-10 * $a['status']);
  $b_status = $b['status'] > 0 ? $b['status'] : (-10 * $b['status']);
  return $a_status - $b_status;
}