LTIToolProviderController.php in LTI Tool Provider 2.x

Namespace

Drupal\lti_tool_provider\Controller

File

src/Controller/LTIToolProviderController.php

<?php

namespace Drupal\lti_tool_provider\Controller;

use Drupal;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Controller\ControllerBase;
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\Core\PageCache\ResponsePolicy\KillSwitch;
use Drupal\Core\PageCache\ResponsePolicyInterface;
use Drupal\Core\Routing\TrustedRedirectResponse;
use Drupal\lti_tool_provider\Event\LtiToolProviderLaunchRedirectEvent;
use Drupal\lti_tool_provider\Event\LtiToolProviderReturnEvent;
use Drupal\lti_tool_provider\LtiToolProviderEvent;
use Exception;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\EventDispatcher\EventDispatcherInterface;
use Symfony\Component\HttpFoundation\RedirectResponse;
use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Session\SessionInterface;

/**
 * Returns responses for lti_tool_provider module routes.
 */
class LTIToolProviderController extends ControllerBase {

  /**
   * The configuration factory.
   *
   * @var ConfigFactoryInterface
   */
  protected $configFactory;

  /**
   * A logger instance.
   *
   * @var LoggerChannelFactoryInterface
   */
  protected $loggerFactory;

  /**
   * The event dispatcher.
   *
   * @var EventDispatcherInterface
   */
  protected $eventDispatcher;

  /**
   * The page cache kill switch.
   *
   * @var ResponsePolicyInterface|KillSwitch
   */
  protected $killSwitch;

  /**
   * The request.
   *
   * @var Request
   */
  protected $request;

  /**
   * The request session.
   *
   * @var SessionInterface
   */
  protected $session;

  /**
   * The LTI context.
   *
   * @var mixed
   */
  protected $context;

  /**
   * Optional destination.
   *
   * @var string
   */
  protected $destination;

  /**
   * Constructs a HTTP basic authentication provider object.
   *
   * @param ConfigFactoryInterface $configFactory
   *   The configuration factory.
   * @param LoggerChannelFactoryInterface $loggerFactory
   *   A logger instance.
   * @param EventDispatcherInterface $eventDispatcher
   *   The event dispatcher.
   * @param ResponsePolicyInterface $killSwitch
   *   The page cache kill switch.
   * @param Request $request
   *   The request.
   * @param SessionInterface $session
   *   The request session.
   * @param mixed $context
   *   The LTI context.
   * @param string | null $destination
   *   Optional destination.
   */
  public function __construct(ConfigFactoryInterface $configFactory, LoggerChannelFactoryInterface $loggerFactory, EventDispatcherInterface $eventDispatcher, ResponsePolicyInterface $killSwitch, Request $request, SessionInterface $session, $context, ?string $destination) {
    $this->configFactory = $configFactory;
    $this->loggerFactory = $loggerFactory
      ->get('lti_tool_provider');
    $this->eventDispatcher = $eventDispatcher;
    $this->killSwitch = $killSwitch;
    $this->request = $request;
    $this->session = $session;
    $this->context = $context;
    $this->destination = $destination;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : LTIToolProviderController {

    /* @var $configFactory ConfigFactoryInterface */
    $configFactory = $container
      ->get('config.factory');

    /* @var $loggerFactory LoggerChannelFactoryInterface */
    $loggerFactory = $container
      ->get('logger.factory');

    /* @var $eventDispatcher EventDispatcherInterface */
    $eventDispatcher = $container
      ->get('event_dispatcher');

    /* @var $killSwitch ResponsePolicyInterface */
    $killSwitch = $container
      ->get('page_cache_kill_switch');
    $request = Drupal::request();
    $session = $request
      ->getSession();
    $context = $session
      ->get('lti_tool_provider_context');
    $destination = Drupal::config('lti_tool_provider.settings')
      ->get('destination');
    return new static($configFactory, $loggerFactory, $eventDispatcher, $killSwitch, $request, $session, $context, $destination);
  }

  /**
   * LTI launch.
   *
   * Authenticates the user via the authentication.lti_tool_provider service,
   * login that user, and then redirect the user to the appropriate page.
   *
   * @return RedirectResponse
   *   Redirect user to appropriate LTI url.
   *
   * @see \Drupal\lti_tool_provider\Authentication\Provider\LTIToolProvider
   *   This controller requires that the authentication.lti_tool_provider
   *   service is attached to this route in lti_tool_provider.routing.yml.
   */
  public function ltiLaunch() : RedirectResponse {
    try {
      $destination = '/';
      if (empty($this->context)) {
        throw new Exception('LTI context missing.');
      }
      if (!empty($this->destination)) {
        $destination = $this->destination;
      }
      if (isset($this->context['custom_destination']) && !empty($this->context['custom_destination'])) {
        $destination = $this->context['custom_destination'];
      }
      $this->killSwitch
        ->trigger();
      $event = new LtiToolProviderLaunchRedirectEvent($this->context, $destination);
      LtiToolProviderEvent::dispatchEvent($this->eventDispatcher, $event);
      if ($event
        ->isCancelled()) {
        throw new Exception($event
          ->getMessage());
      }
      $destination = $event
        ->getDestination();
      return new RedirectResponse($destination);
    } catch (Exception $e) {
      $this->loggerFactory
        ->warning($e
        ->getMessage());
      return new RedirectResponse('/', 500);
    }
  }

  /**
   * LTI return.
   *
   * Logs the user out and returns the user to the LMS.
   *
   * @return RedirectResponse
   *   Redirect user to appropriate return url.
   */
  public function ltiReturn() {
    try {
      $destination = '/';
      if (empty($this->context)) {
        throw new Exception('LTI context missing in return request.');
      }
      if (!empty($this->destination)) {
        $destination = $this->destination;
      }
      if (isset($this->context['launch_presentation_return_url']) && !empty($this->context['launch_presentation_return_url'])) {
        $destination = $this->context['launch_presentation_return_url'];
      }
      $this->killSwitch
        ->trigger();
      $event = new LtiToolProviderReturnEvent($this->context, $destination);
      LtiToolProviderEvent::dispatchEvent($this->eventDispatcher, $event);
      if ($event
        ->isCancelled()) {
        throw new Exception($event
          ->getMessage());
      }
      $destination = $event
        ->getDestination();
      $this
        ->userLogout();
      return new TrustedRedirectResponse($destination);
    } catch (Exception $e) {
      $this->loggerFactory
        ->warning($e
        ->getMessage());
      return new RedirectResponse('/', 500);
    }
  }
  protected function userLogout() {
    user_logout();
  }

  /**
   * Checks access for LTI routes.
   *
   * @return AccessResult
   *   The access result.
   */
  public function access() : AccessResult {
    return AccessResult::allowedIf(!empty($this->context));
  }

}

Classes

Name	Description
LTIToolProviderController	Returns responses for lti_tool_provider module routes.