SessionTestController.php

<?php

declare (strict_types=1);
namespace Drupal\session_test\Controller;

use Drupal\Core\Controller\ControllerBase;
use Drupal\session_test\Session\TestSessionBag;
use Symfony\Component\HttpFoundation\JsonResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;

/**
 * Controller providing page callbacks for session tests.
 */
class SessionTestController extends ControllerBase {
  
  /**
   * Prints the stored session value to the screen.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   */
  public function get(Request $request) : array {
    $value = $request->getSession()
      ->get('session_test_value');
    return empty($value) ? [] : [
      '#markup' => $this->t('The current value of the stored session variable is: %val', [
        '%val' => $value,
      ]),
    ];
  }
  
  /**
   * Prints the stored session value to the screen.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   */
  public function getFromSessionObject(Request $request) : array {
    $value = $request->getSession()
      ->get("session_test_key");
    return empty($value) ? [] : [
      '#markup' => $this->t('The current value of the stored session variable is: %val', [
        '%val' => $value,
      ]),
    ];
  }
  
  /**
   * Print the current session ID.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   */
  public function getId(Request $request) : array {
    // Set a value in session, so that SessionManager::save() will start
    // a session.
    $session = $request->getSession();
    $session->set('test', 'test');
    $session->save();
    return [
      '#markup' => 'session_id:' . session_id() . "\n",
    ];
  }
  
  /**
   * Print the current session ID as read from the cookie.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   */
  public function getIdFromCookie(Request $request) : array {
    return [
      '#markup' => 'session_id:' . $request->cookies
        ->get(session_name()) . "\n",
      '#cache' => [
        'contexts' => [
          'cookies:' . session_name(),
        ],
      ],
    ];
  }
  
  /**
   * Stores a value in 'session_test_value' session attribute.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param string $test_value
   *   A session value.
   */
  public function set(Request $request, $test_value) : array {
    $request->getSession()
      ->set('session_test_value', $test_value);
    return [
      '#markup' => $this->t('The current value of the stored session variable has been set to %val', [
        '%val' => $test_value,
      ]),
    ];
  }
  
  /**
   * Turns off session saving and then tries to save a value anyway.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param string $test_value
   *   A session value.
   */
  public function noSet(Request $request, $test_value) : array {
    \Drupal::service('session_handler.write_safe')->setSessionWritable(FALSE);
    $this->set($request, $test_value);
    return [
      '#markup' => $this->t('session saving was disabled, and then %val was set', [
        '%val' => $test_value,
      ]),
    ];
  }
  
  /**
   * Sets a message to me displayed on the following page.
   */
  public function setMessage() : Response {
    $this->messenger()
      ->addStatus($this->t('This is a dummy message.'));
    return new Response((string) $this->t('A message was set.'));
    // Do not return anything, so the current request does not result in a
    // themed page with messages. The message will be displayed in the following
    // request instead.
  }
  
  /**
   * Sets a message but call drupal_save_session(FALSE).
   */
  public function setMessageButDoNotSave() : array {
    \Drupal::service('session_handler.write_safe')->setSessionWritable(FALSE);
    $this->setMessage();
    return [
      '#markup' => '',
    ];
  }
  
  /**
   * Only available if current user is logged in.
   */
  public function isLoggedIn() : array {
    return [
      '#markup' => $this->t('User is logged in.'),
    ];
  }
  
  /**
   * Returns the trace recorded by test proxy session handlers as JSON.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   */
  public function traceHandler(Request $request) : Response {
    // Increment trace-handler counter and save the session.
    $session = $request->getSession();
    $counter = $session->get('trace-handler', 0);
    $session->set('trace-handler', $counter + 1);
    $session->save();
    // Collect traces and return them in JSON format.
    $trace = \Drupal::service('session_test.session_handler_proxy_trace')->getArrayCopy();
    return new JsonResponse($trace);
  }
  
  /**
   * Returns an updated trace recorded by test proxy session handlers as JSON.
   *
   * The session data is rewritten without modification to invoke
   * `\SessionUpdateTimestampHandlerInterface::updateTimestamp`.
   *
   * Expects that there is an existing stacked session handler trace as recorded
   * by `traceHandler()`.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The incoming request.
   *
   * @throws \AssertionError
   */
  public function traceHandlerRewriteUnmodified(Request $request) : Response {
    // Assert that there is an existing session with stacked handler trace data.
    $session = $request->getSession();
    assert(is_int($session->get('trace-handler')) && $session->get('trace-handler') > 0, 'Existing stacked session handler trace not found');
    // Save unmodified session data.
    assert(ini_get('session.lazy_write'), 'session.lazy_write must be enabled to invoke updateTimestamp()');
    $session->save();
    // Collect traces and return them in JSON format.
    $trace = \Drupal::service('session_test.session_handler_proxy_trace')->getArrayCopy();
    return new JsonResponse($trace);
  }
  
  /**
   * Returns the values stored in the active session and the user ID.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   */
  public function getSession(Request $request) : Response {
    return new JsonResponse([
      'session' => $request->getSession()
        ->all(),
      'user' => $this->currentUser()
        ->id(),
    ]);
  }
  
  /**
   * Sets a test value on the session.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   * @param string $test_value
   *   A value to set on the session.
   */
  public function setSession(Request $request, $test_value) : Response {
    $session = $request->getSession();
    $session->set('test_value', $test_value);
    return new JsonResponse([
      'session' => $session->all(),
      'user' => $this->currentUser()
        ->id(),
    ]);
  }
  
  /**
   * Sets the test flag in the session test bag.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   */
  public function setSessionBagFlag(Request $request) : Response {
    /** @var \Drupal\session_test\Session\TestSessionBag */
    $bag = $request->getSession()
      ->getBag(TestSessionBag::BAG_NAME);
    $bag->setFlag();
    return new Response();
  }
  
  /**
   * Clears the test flag from the session test bag.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   */
  public function clearSessionBagFlag(Request $request) : Response {
    /** @var \Drupal\session_test\Session\TestSessionBag */
    $bag = $request->getSession()
      ->getBag(TestSessionBag::BAG_NAME);
    $bag->clearFlag();
    return new Response();
  }
  
  /**
   * Prints a message if the flag in the session bag is set.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   */
  public function hasSessionBagFlag(Request $request) : Response {
    /** @var \Drupal\session_test\Session\TestSessionBag */
    $bag = $request->getSession()
      ->getBag(TestSessionBag::BAG_NAME);
    return new Response(empty($bag->hasFlag()) ? (string) $this->t('Flag is absent from session bag') : (string) $this->t('Flag is present in session bag'));
  }
  
  /**
   * Trigger an exception when the session is written.
   *
   * @param \Symfony\Component\HttpFoundation\Request $request
   *   The request object.
   */
  public function triggerWriteException(Request $request) : Response {
    $session = $request->getSession();
    $session->set('test_value', 'Ensure session contains some data');
    // Move sessions table out of the way.
    $schema = \Drupal::database()->schema();
    $schema->renameTable('sessions', 'sessions_tmp');
    // There needs to be a session table, otherwise
    // InstallerRedirectTrait::shouldRedirectToInstaller() will instruct the
    // handleException::handleException to redirect to the installer.
    $schema->createTable('sessions', [
      'description' => "Fake sessions table missing some columns.",
      'fields' => [
        'sid' => [
          'description' => "A fake session ID column.",
          'type' => 'varchar_ascii',
          'length' => 128,
          'not null' => TRUE,
        ],
      ],
      'primary key' => [
        'sid',
      ],
    ]);
    drupal_register_shutdown_function(function () {
      $schema = \Drupal::database()->schema();
      $schema->dropTable('sessions');
      $schema->renameTable('sessions_tmp', 'sessions');
    });
    return new Response();
  }

}