SystemTestController.php 9.37 KB
Newer Older
1 2 3 4 5 6 7 8 9
<?php

/**
 * @file
 * Contains \Drupal\system_test\Controller\SystemTestController.
 */

namespace Drupal\system_test\Controller;

10
use Drupal\Core\Access\AccessResult;
11
use Drupal\Core\Controller\ControllerBase;
12
use Drupal\Core\Render\RendererInterface;
13
use Drupal\Core\Render\Markup;
14
use Drupal\Core\Session\AccountInterface;
15 16
use Drupal\Core\Url;
use Symfony\Component\HttpFoundation\RedirectResponse;
17 18
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
19 20
use Drupal\Core\Lock\LockBackendInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;
21 22 23 24 25 26

/**
 * Controller routines for system_test routes.
 */
class SystemTestController extends ControllerBase {

27 28 29 30 31 32 33
  /**
   * The lock service.
   *
   * @var \Drupal\Core\Lock\LockBackendInterface
   */
  protected $lock;

34 35 36 37 38 39 40
  /**
   * The persistent lock service.
   *
   * @var \Drupal\Core\Lock\LockBackendInterface
   */
  protected $persistentLock;

41 42 43 44 45 46 47 48 49 50 51 52 53 54
  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The renderer.
   *
   * @var \Drupal\Core\Render\RendererInterface
   */
  protected $renderer;

55 56 57
  /**
   * Constructs the SystemTestController.
   *
58 59
   * @param \Drupal\Core\Lock\LockBackendInterface $lock
   *   The lock service.
60 61
   * @param \Drupal\Core\Lock\LockBackendInterface $persistent_lock
   *   The persistent lock service.
62 63 64 65
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Render\RendererInterface $renderer
   *   The renderer.
66
   */
67
  public function __construct(LockBackendInterface $lock, LockBackendInterface $persistent_lock, AccountInterface $current_user, RendererInterface $renderer) {
68
    $this->lock = $lock;
69
    $this->persistentLock = $persistent_lock;
70 71
    $this->currentUser = $current_user;
    $this->renderer = $renderer;
72 73 74 75 76 77
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
78 79 80 81 82 83
    return new static(
      $container->get('lock'),
      $container->get('lock.persistent'),
      $container->get('current_user'),
      $container->get('renderer')
    );
84 85
  }

86 87 88 89 90 91 92
  /**
   * Tests main content fallback.
   *
   * @return string
   *   The text to display.
   */
  public function mainContentFallback() {
93
    return ['#markup' => $this->t('Content to test main content fallback')];
94 95
  }

96 97 98 99 100 101 102 103 104
  /**
   * Tests setting messages and removing one before it is displayed.
   *
   * @return string
   *   Empty string, we just test the setting of messages.
   */
  public function drupalSetMessageTest() {
    // Set two messages.
    drupal_set_message('First message (removed).');
105
    drupal_set_message(t('Second message with <em>markup!</em> (not removed).'));
106 107 108

    // Remove the first.
    unset($_SESSION['messages']['status'][0]);
109 110 111 112 113 114 115

    // Duplicate message check.
    drupal_set_message('Non Duplicated message', 'status', FALSE);
    drupal_set_message('Non Duplicated message', 'status', FALSE);

    drupal_set_message('Duplicated message', 'status', TRUE);
    drupal_set_message('Duplicated message', 'status', TRUE);
116

117 118 119 120 121
    // Add a Markup message.
    drupal_set_message(Markup::create('Markup with <em>markup!</em>'));
    // Test duplicate Markup messages.
    drupal_set_message(Markup::create('Markup with <em>markup!</em>'));
    // Ensure that multiple Markup messages work.
122
    drupal_set_message(Markup::create('Markup2 with <em>markup!</em>'));
123 124

    // Test mixing of types.
125 126 127 128
    drupal_set_message(Markup::create('Non duplicate Markup / string.'));
    drupal_set_message('Non duplicate Markup / string.');
    drupal_set_message(Markup::create('Duplicate Markup / string.'), 'status', TRUE);
    drupal_set_message('Duplicate Markup / string.', 'status', TRUE);
129 130 131 132

    // Test auto-escape of non safe strings.
    drupal_set_message('<em>This<span>markup will be</span> escaped</em>.');

133
    return [];
134 135
  }

136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163
  /**
   * Controller to return $_GET['destination'] for testing.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response.
   */
  public function getDestination(Request $request) {
    $response = new Response($request->query->get('destination'));
    return $response;
  }

  /**
   * Controller to return $_REQUEST['destination'] for testing.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request.
   *
   * @return \Symfony\Component\HttpFoundation\Response
   *   The response.
   */
  public function requestDestination(Request $request) {
    $response = new Response($request->request->get('destination'));
    return $response;
  }

164
  /**
165
   * Try to acquire a named lock and report the outcome.
166 167
   */
  public function lockAcquire() {
168 169 170 171 172 173 174
    if ($this->lock->acquire('system_test_lock_acquire')) {
      $this->lock->release('system_test_lock_acquire');
      return ['#markup' => 'TRUE: Lock successfully acquired in \Drupal\system_test\Controller\SystemTestController::lockAcquire()'];
    }
    else {
      return ['#markup' => 'FALSE: Lock not acquired in \Drupal\system_test\Controller\SystemTestController::lockAcquire()'];
    }
175 176 177
  }

  /**
178
   * Try to acquire a specific lock, and then exit.
179 180
   */
  public function lockExit() {
181 182 183 184 185 186 187 188
    if ($this->lock->acquire('system_test_lock_exit', 900)) {
      echo 'TRUE: Lock successfully acquired in \Drupal\system_test\Controller\SystemTestController::lockExit()';
      // The shut-down function should release the lock.
      exit();
    }
    else {
      return ['#markup' => 'FALSE: Lock not acquired in system_test_lock_exit()'];
    }
189 190
  }

191 192 193 194 195 196 197 198 199 200 201
  /**
   * Creates a lock that will persist across requests.
   *
   * @param string $lock_name
   *   The name of the persistent lock to acquire.
   *
   * @return string
   *   The text to display.
   */
  public function lockPersist($lock_name) {
    if ($this->persistentLock->acquire($lock_name)) {
202
      return ['#markup' => 'TRUE: Lock successfully acquired in SystemTestController::lockPersist()'];
203 204
    }
    else {
205
      return ['#markup' => 'FALSE: Lock not acquired in SystemTestController::lockPersist()'];
206 207 208
    }
  }

209 210 211
  /**
   * Set cache tag on on the returned render array.
   */
212
  public function system_test_cache_tags_page() {
213
    $build['main'] = array(
214
      '#cache' => array('tags' => array('system_test_cache_tags_page')),
215 216 217 218 219 220
      '#pre_render' => array(
        '\Drupal\system_test\Controller\SystemTestController::preRenderCacheTags',
      ),
      'message' => array(
        '#markup' => 'Cache tags page example',
      ),
221 222 223 224
    );
    return $build;
  }

225 226 227 228 229 230 231 232 233 234 235 236 237
  /**
   * Set cache max-age on the returned render array.
   */
  public function system_test_cache_maxage_page() {
    $build['main'] = array(
      '#cache' => array('max-age' => 90),
      'message' => array(
        '#markup' => 'Cache max-age page example',
      ),
    );
    return $build;
  }

238 239 240 241
  /**
   * Sets a cache tag on an element to help test #pre_render and cache tags.
   */
  public static function preRenderCacheTags($elements) {
242
    $elements['#cache']['tags'][] = 'pre_render';
243 244 245
    return $elements;
  }

246
  /**
247 248 249
   * Initialize authorize.php during testing.
   *
   * @see system_authorized_init().
250 251
   */
  public function authorizeInit($page_title) {
252 253 254
    $authorize_url = Url::fromUri('base:core/authorize.php', array('absolute' => TRUE))->toString();
    system_authorized_init('system_test_authorize_run', drupal_get_path('module', 'system_test') . '/system_test.module', array(), $page_title);
    return new RedirectResponse($authorize_url);
255 256 257
  }

  /**
258
   * Sets a header.
259
   */
260 261 262 263 264 265 266
  public function setHeader(Request $request) {
    $query = $request->query->all();
    $response = new Response();
    $response->headers->set($query['name'], $query['value']);
    $response->setContent($this->t('The following header was set: %name: %value', array('%name' => $query['name'], '%value' => $query['value'])));

    return $response;
267 268 269
  }

  /**
270
   * A simple page callback which adds a register shutdown function.
271 272
   */
  public function shutdownFunctions($arg1, $arg2) {
273
    drupal_register_shutdown_function('_system_test_first_shutdown_function', $arg1, $arg2);
274 275 276 277 278 279
    // If using PHP-FPM then fastcgi_finish_request() will have been fired
    // preventing further output to the browser which means that the escaping of
    // the exception message can not be tested.
    // @see _drupal_shutdown_function()
    // @see \Drupal\system\Tests\System\ShutdownFunctionsTest
    if (function_exists('fastcgi_finish_request')) {
280
      return ['#markup' => 'The function fastcgi_finish_request exists when serving the request.'];
281
    }
282
    return [];
283 284
  }

285 286 287 288 289 290 291 292 293 294 295 296
  /**
   * Returns the title for system_test.info.yml's configure route.
   *
   * @param string $foo
   *   Any string for the {foo} slug.
   *
   * @return string
   */
  public function configureTitle($foo) {
    return 'Bar.' . $foo;
  }

297 298 299 300 301 302 303 304 305 306 307
  /**
   * Shows permission-dependent content.
   *
   * @return array
   *   A render array.
   */
  public function permissionDependentContent() {
    $build = [];

    // The content depends on the access result.
    $access = AccessResult::allowedIfHasPermission($this->currentUser, 'pet llamas');
308
    $this->renderer->addCacheableDependency($build, $access);
309 310 311 312 313 314 315 316 317 318 319 320

    // Build the content.
    if ($access->isAllowed()) {
      $build['allowed'] = ['#markup' => 'Permission to pet llamas: yes!'];
    }
    else {
      $build['forbidden'] = ['#markup' => 'Permission to pet llamas: no!'];
    }

    return $build;
  }

321
}