UpdateTestController.php 2.76 KB
Newer Older
1 2 3
<?php

namespace Drupal\update_test\Controller;
4 5

use Drupal\Core\Controller\ControllerBase;
6
use Symfony\Component\HttpFoundation\Response;
7
use Symfony\Component\HttpFoundation\BinaryFileResponse;
8 9 10 11

/**
 * Provides different routes of the update_test module.
 */
12
class UpdateTestController extends ControllerBase {
13 14 15 16 17 18 19 20 21 22 23 24 25 26 27

  /**
   * Displays an Error 503 (Service unavailable) page.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   Returns the response with a special header.
   */
  public function updateError() {
    $response = new Response();
    $response->setStatusCode(503);
    $response->headers->set('Status', '503 Service unavailable');

    return $response;
  }

28
  /**
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
   * Page callback: Prints mock XML for the Update Manager module.
   *
   * The specific XML file to print depends on two things: the project we're
   * trying to fetch data for, and the desired "availability scenario" for that
   * project which we're trying to test. Before attempting to fetch this data (by
   * checking for updates on the available updates report), callers need to define
   * the 'update_test_xml_map' variable as an array, keyed by project name,
   * indicating which availability scenario to use for that project.
   *
   * @param string $project_name
   *   The project short name the update manager is trying to fetch data for (the
   *   fetch URLs are of the form: [base_url]/[project_name]/[core_version]).
   * @param string $version
   *   The version of Drupal core.
   *
44
   * @return \Symfony\Component\HttpFoundation\BinaryFileResponse|Response
45 46 47
   *   A BinaryFileResponse object containing the content of the XML release file
   *   for the specified project if one is available; a Response object with no
   *   content otherwise.
48 49
   */
  public function updateTest($project_name, $version) {
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65
    $xml_map = $this->config('update_test.settings')->get('xml_map');
    if (isset($xml_map[$project_name])) {
      $availability_scenario = $xml_map[$project_name];
    }
    elseif (isset($xml_map['#all'])) {
      $availability_scenario = $xml_map['#all'];
    }
    else {
      // The test didn't specify (for example, the webroot has other modules and
      // themes installed but they're disabled by the version of the site
      // running the test. So, we default to a file we know won't exist, so at
      // least we'll get an empty xml response instead of a bunch of Drupal page
      // output.
      $availability_scenario = '#broken#';
    }

66
    $file = __DIR__ . "/../../../../fixtures/release-history/$project_name.$availability_scenario.xml";
67
    $headers = ['Content-Type' => 'text/xml; charset=utf-8'];
68 69 70 71 72
    if (!is_file($file)) {
      // Return an empty response.
      return new Response('', 200, $headers);
    }
    return new BinaryFileResponse($file, 200, $headers);
73 74
  }

75
}