<?php

/**

 * @file

 * Administrative screens and processing functions of the Update Manager module.

 *

 * This allows site administrators with the 'administer software updates'

 * permission to either upgrade existing projects, or download and install new

 * ones, so long as the killswitch setting ('allow_authorize_operations') is

 * still TRUE.

 *

 * To install new code, the administrator is prompted for either the URL of an

 * archive file, or to directly upload the archive file. The archive is loaded

 * into a temporary location, extracted, and verified. If everything is

 * successful, the user is redirected to authorize.php to type in file transfer

 * credentials and authorize the installation to proceed with elevated

 * privileges, such that the extracted files can be copied out of the temporary

 * location and into the live web root.

 *

 * Updating existing code is a more elaborate process. The first step is a

 * selection form where the user is presented with a table of installed projects

 * that are missing newer releases. The user selects which projects they wish to

 * update, and presses the "Download updates" button to continue. This sets up a

 * batch to fetch all the selected releases, and redirects to

 * admin/update/download to display the batch progress bar as it runs. Each

 * batch operation is responsible for downloading a single file, extracting the

 * archive, and verifying the contents. If there are any errors, the user is

 * redirected back to the first page with the error messages. If all downloads

 * were extacted and verified, the user is instead redirected to

 * admin/update/ready, a landing page which reminds them to backup their

 * database and asks if they want to put the site offline during the update.

 * Once the user presses the "Install updates" button, they are redirected to

 * authorize.php to supply their web root file access credentials. The

 * authorized operation (which lives in update.authorize.inc) sets up a batch to

 * copy each extracted update from the temporary location into the live web

 * root.

 */

/**

 * @defgroup update_manager_update Update Manager module: update

 * @{

 * Update Manager module functionality for updating existing code.

 *

 * Provides a user interface to update existing code.

 */

/**

 * Form constructor for the update form of the Update Manager module.

 *

 * This presents a table with all projects that have available updates with

 * checkboxes to select which ones to upgrade.

 *

 * @param $context

 *   String representing the context from which we're trying to update.

 *   Allowed values are 'module', 'theme', and 'report'.

 *

 * @see update_manager_update_form_validate()

 * @see update_manager_update_form_submit()

 * @see update_menu()

 * @ingroup forms

 */

function update_manager_update_form($form, $form_state, $context) {

  if (!_update_manager_check_backends($form, 'update')) {

    return $form;

  }

  $form['#theme'] = 'update_manager_update_form';

  $available = update_get_available(TRUE);

  if (empty($available)) {

    $form['message'] = array(

      '#markup' => t('There was a problem getting update information. Try again later.'),

    );

    return $form;

  }

  $form['#attached']['css'][] = drupal_get_path('module', 'update') . '/update.css';

  // This will be a nested array. The first key is the kind of project, which

  // can be either 'enabled', 'disabled', 'manual' (projects which require

  // manual updates, such as core). Then, each subarray is an array of

  // projects of that type, indexed by project short name, and containing an

  // array of data for cells in that project's row in the appropriate table.

  $projects = array();

  // This stores the actual download link we're going to update from for each

  // project in the form, regardless of if it's enabled or disabled.

  $form['project_downloads'] = array('#tree' => TRUE);

  module_load_include('inc', 'update', 'update.compare');

  $project_data = update_calculate_project_data($available);

  foreach ($project_data as $name => $project) {

    // Filter out projects which are up to date already.

    if ($project['status'] == UPDATE_CURRENT) {

      continue;

    }

    // The project name to display can vary based on the info we have.

    if (!empty($project['title'])) {

      if (!empty($project['link'])) {

        $project_name = l($project['title'], $project['link']);

      }

      else {

        $project_name = check_plain($project['title']);

      }

    }

    elseif (!empty($project['info']['name'])) {

      $project_name = check_plain($project['info']['name']);

    }

    else {

      $project_name = check_plain($name);

    }

    if ($project['project_type'] == 'theme' || $project['project_type'] == 'theme-disabled') {

      $project_name .= ' ' . t('(Theme)');

    }

    if (empty($project['recommended'])) {

      // If we don't know what to recommend they upgrade to, we should skip

      // the project entirely.

      continue;

    }

    $recommended_release = $project['releases'][$project['recommended']];

    $recommended_version = $recommended_release['version'] . ' ' . l(t('(Release notes)'), $recommended_release['release_link'], array('attributes' => array('title' => t('Release notes for @project_title', array('@project_title' => $project['title'])))));

    if ($recommended_release['version_major'] != $project['existing_major']) {

      $recommended_version .= '<div title="Major upgrade warning" class="update-major-version-warning">' . t('This update is a major version update which means that it may not be backwards compatible with your currently running version.  It is recommended that you read the release notes and proceed at your own risk.') . '</div>';

    }

    // Create an entry for this project.

    $entry = array(

      'title' => $project_name,

      'installed_version' => $project['existing_version'],

      'recommended_version' => $recommended_version,

    );

    switch ($project['status']) {

      case UPDATE_NOT_SECURE:

      case UPDATE_REVOKED:

        $entry['title'] .= ' ' . t('(Security update)');

        $entry['#weight'] = -2;

        $type = 'security';

        break;

      case UPDATE_NOT_SUPPORTED:

        $type = 'unsupported';

        $entry['title'] .= ' ' . t('(Unsupported)');

        $entry['#weight'] = -1;

        break;

      case UPDATE_UNKNOWN:

      case UPDATE_NOT_FETCHED:

      case UPDATE_NOT_CHECKED:

      case UPDATE_NOT_CURRENT:

        $type = 'recommended';

        break;

      default:

        // Jump out of the switch and onto the next project in foreach.

        continue 2;

    }

    $entry['#attributes'] = array('class' => array('update-' . $type));

    // Drupal core needs to be upgraded manually.

    $needs_manual = $project['project_type'] == 'core';

    if ($needs_manual) {

      // There are no checkboxes in the 'Manual updates' table so it will be

      // rendered by theme('table'), not theme('tableselect'). Since the data

      // formats are incompatible, we convert now to the format expected by

      // theme('table').

      unset($entry['#weight']);

      $attributes = $entry['#attributes'];

      unset($entry['#attributes']);

      $entry = array(

        'data' => $entry,

      ) + $attributes;

    }

    else {

      $form['project_downloads'][$name] = array(

        '#type' => 'value',

        '#value' => $recommended_release['download_link'],

      );

    }

    // Based on what kind of project this is, save the entry into the

    // appropriate subarray.

    switch ($project['project_type']) {

      case 'core':

        // Core needs manual updates at this time.

        $projects['manual'][$name] = $entry;

        break;

      case 'module':

      case 'theme':

        $projects['enabled'][$name] = $entry;

        break;

      case 'module-disabled':

      case 'theme-disabled':

        $projects['disabled'][$name] = $entry;

        break;

    }

  }

  if (empty($projects)) {

    $form['message'] = array(

      '#markup' => t('All of your projects are up to date.'),

    );

    return $form;

  }

  $headers = array(

    'title' => array(

      'data' => t('Name'),

      'class' => array('update-project-name'),

    ),

    'installed_version' => t('Installed version'),

    'recommended_version' => t('Recommended version'),

  );

  if (!empty($projects['enabled'])) {

    $form['projects'] = array(

      '#type' => 'tableselect',

      '#header' => $headers,

      '#options' => $projects['enabled'],

    );

    if (!empty($projects['disabled'])) {

      $form['projects']['#prefix'] = '<h2>' . t('Enabled') . '</h2>';

    }

  }

  if (!empty($projects['disabled'])) {

    $form['disabled_projects'] = array(

      '#type' => 'tableselect',

      '#header' => $headers,

      '#options' => $projects['disabled'],

      '#weight' => 1,

      '#prefix' => '<h2>' . t('Disabled') . '</h2>',

    );

  }

  // If either table has been printed yet, we need a submit button and to

  // validate the checkboxes.

  if (!empty($projects['enabled']) || !empty($projects['disabled'])) {

    $form['actions'] = array('#type' => 'actions');

    $form['actions']['submit'] = array(

      '#type' => 'submit',

      '#value' => t('Download these updates'),

    );

    $form['#validate'][] = 'update_manager_update_form_validate';

  }

  if (!empty($projects['manual'])) {

    $prefix = '<h2>' . t('Manual updates required') . '</h2>';

    $prefix .= '<p>' . t('Updates of Drupal core are not supported at this time.') . '</p>';

    $form['manual_updates'] = array(

      '#type' => 'markup',

      '#markup' => theme('table', array('header' => $headers, 'rows' => $projects['manual'])),

      '#prefix' => $prefix,

      '#weight' => 120,

    );

  }

  return $form;

}

/**

 * Returns HTML for the first page in the process of updating projects.

 *

 * @param $variables

 *   An associative array containing:

 *   - form: A render element representing the form.

 *

 * @ingroup themeable

 */

function theme_update_manager_update_form($variables) {

  $form = $variables['form'];

  $last = variable_get('update_last_check', 0);

  $output = theme('update_last_check', array('last' => $last));

  $output .= drupal_render_children($form);

  return $output;

}

/**

 * Form validation handler for update_manager_update_form().

 *

 * Ensures that at least one project is selected.

 *

 * @see update_manager_update_form_submit()

 */

function update_manager_update_form_validate($form, &$form_state) {

  if (!empty($form_state['values']['projects'])) {

    $enabled = array_filter($form_state['values']['projects']);

  }

  if (!empty($form_state['values']['disabled_projects'])) {

    $disabled = array_filter($form_state['values']['disabled_projects']);

  }

  if (empty($enabled) && empty($disabled)) {

    form_set_error('projects', t('You must select at least one project to update.'));

  }

}

/**

 * Form submission handler for update_manager_update_form().

 *

 * Sets up a batch that downloads, extracts, and verifies the selected releases.

 *

 * @see update_manager_update_form_validate()

 */

function update_manager_update_form_submit($form, &$form_state) {

  $projects = array();

  foreach (array('projects', 'disabled_projects') as $type) {

    if (!empty($form_state['values'][$type])) {

      $projects = array_merge($projects, array_keys(array_filter($form_state['values'][$type])));

    }

  }

  $operations = array();

  foreach ($projects as $project) {

    $operations[] = array(

      'update_manager_batch_project_get',

      array(

        $project,

        $form_state['values']['project_downloads'][$project],

      ),

    );

  }

  $batch = array(

    'title' => t('Downloading updates'),

    'init_message' => t('Preparing to download selected updates'),

    'operations' => $operations,

    'finished' => 'update_manager_download_batch_finished',

    'file' => drupal_get_path('module', 'update') . '/update.manager.inc',

  );

  batch_set($batch);

}

/**

 * Implements callback_batch_finished().

 *

 * Batch callback: Performs actions when the download batch is completed.

 *

 * @param $success

 *   TRUE if the batch operation was successful, FALSE if there were errors.

 * @param $results

 *   An associative array of results from the batch operation.

 */

function update_manager_download_batch_finished($success, $results) {

  if (!empty($results['errors'])) {

    $error_list = array(

      'title' => t('Downloading updates failed:'),

      'items' => $results['errors'],

    );

    drupal_set_message(theme('item_list', $error_list), 'error');

  }

  elseif ($success) {

    drupal_set_message(t('Updates downloaded successfully.'));

    $_SESSION['update_manager_update_projects'] = $results['projects'];

    drupal_goto('admin/update/ready');

  }

  else {

    // Ideally we're catching all Exceptions, so they should never see this,

    // but just in case, we have to tell them something.

    drupal_set_message(t('Fatal error trying to download.'), 'error');

  }

}

/**

 * Form constructor for the update ready form.

 *

 * Build the form when the site is ready to update (after downloading).

 *

 * This form is an intermediary step in the automated update workflow. It is

 * presented to the site administrator after all the required updates have been

 * downloaded and verified. The point of this page is to encourage the user to

 * backup their site, give them the opportunity to put the site offline, and

 * then ask them to confirm that the update should continue. After this step,

 * the user is redirected to authorize.php to enter their file transfer

 * credentials and attempt to complete the update.

 *

 * @see update_manager_update_ready_form_submit()

 * @see update_menu()

 * @ingroup forms

 */

function update_manager_update_ready_form($form, &$form_state) {

  if (!_update_manager_check_backends($form, 'update')) {

    return $form;

  }

  $form['backup'] = array(

    '#prefix' => '<strong>',

    '#markup' => t('Back up your database and site before you continue. <a href="@backup_url">Learn how</a>.', array('@backup_url' => url('http://drupal.org/node/22281'))),

    '#suffix' => '</strong>',

  );

  $form['maintenance_mode'] = array(

    '#title' => t('Perform updates with site in maintenance mode (strongly recommended)'),

    '#type' => 'checkbox',

    '#default_value' => TRUE,

  );

  $form['actions'] = array('#type' => 'actions');

  $form['actions']['submit'] = array(

    '#type' => 'submit',

    '#value' => t('Continue'),

  );

  return $form;

}

/**

 * Form submission handler for update_manager_update_ready_form().

 *

 * If the site administrator requested that the site is put offline during the

 * update, do so now. Otherwise, pull information about all the required updates

 * out of the SESSION, figure out what Drupal\Core\Updater\Updater class is

 * needed for each one, generate an array of update operations to perform, and

 * hand it all off to system_authorized_init(), then redirect to authorize.php.

 *

 * @see update_authorize_run_update()

 * @see system_authorized_init()

 * @see system_authorized_get_url()

 */

function update_manager_update_ready_form_submit($form, &$form_state) {

  // Store maintenance_mode setting so we can restore it when done.

  $_SESSION['maintenance_mode'] = variable_get('maintenance_mode', FALSE);

  if ($form_state['values']['maintenance_mode'] == TRUE) {

    variable_set('maintenance_mode', TRUE);

  }