class Cookie in Drupal 9

Cookie based authentication provider.

Hierarchy

• class \Drupal\user\Authentication\Provider\Cookie implements \Symfony\Component\EventDispatcher\EventSubscriberInterface, AuthenticationProviderInterface uses StringTranslationTrait

3 string references to 'Cookie'

FinishResponseSubscriber::setResponseCacheable in core/lib/Drupal/Core/EventSubscriber/FinishResponseSubscriber.php

Add Cache-Control and Expires headers to a cacheable response.

PageCache::lookup in core/modules/page_cache/src/StackMiddleware/PageCache.php

Retrieves a response from the cache or fetches it from the backend.

user.services.yml in core/modules/user/user.services.yml

core/modules/user/user.services.yml

1 service uses Cookie

user.authentication.cookie in core/modules/user/user.services.yml

Drupal\user\Authentication\Provider\Cookie

File

core/modules/user/src/Authentication/Provider/Cookie.php, line 23

Namespace

Drupal\user\Authentication\Provider

class Cookie implements AuthenticationProviderInterface, EventSubscriberInterface {
  use StringTranslationTrait;

  /**
   * The session configuration.
   *
   * @var \Drupal\Core\Session\SessionConfigurationInterface
   */
  protected $sessionConfiguration;

  /**
   * The database connection.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $connection;

  /**
   * The messenger.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

  /**
   * Constructs a new cookie authentication provider.
   *
   * @param \Drupal\Core\Session\SessionConfigurationInterface $session_configuration
   *   The session configuration.
   * @param \Drupal\Core\Database\Connection $connection
   *   The database connection.
   * @param \Drupal\Core\Messenger\MessengerInterface|null $messenger
   *   The messenger.
   */
  public function __construct(SessionConfigurationInterface $session_configuration, Connection $connection, MessengerInterface $messenger = NULL) {
    $this->sessionConfiguration = $session_configuration;
    $this->connection = $connection;
    $this->messenger = $messenger;
    if ($this->messenger === NULL) {
      @trigger_error('The MessengerInterface must be passed to ' . __NAMESPACE__ . '\\Cookie::__construct(). It was added in drupal:9.2.0 and will be required before drupal:10.0.0.', E_USER_DEPRECATED);
      $this->messenger = \Drupal::messenger();
    }
  }

  /**
   * {@inheritdoc}
   */
  public function applies(Request $request) {
    $applies = $request
      ->hasSession() && $this->sessionConfiguration
      ->hasSession($request);
    if (!$applies && $request->query
      ->has('check_logged_in')) {
      $domain = ltrim(ini_get('session.cookie_domain'), '.') ?: $request
        ->getHttpHost();
      $this->messenger
        ->addMessage($this
        ->t('To log in to this site, your browser must accept cookies from the domain %domain.', [
        '%domain' => $domain,
      ]), 'error');
    }
    return $applies;
  }

  /**
   * {@inheritdoc}
   */
  public function authenticate(Request $request) {
    return $this
      ->getUserFromSession($request
      ->getSession());
  }

  /**
   * Returns the UserSession object for the given session.
   *
   * @param \Symfony\Component\HttpFoundation\Session\SessionInterface $session
   *   The session.
   *
   * @return \Drupal\Core\Session\AccountInterface|null
   *   The UserSession object for the current user, or NULL if this is an
   *   anonymous session.
   */
  protected function getUserFromSession(SessionInterface $session) {
    if ($uid = $session
      ->get('uid')) {

      // @todo Load the User entity in SessionHandler so we don't need queries.
      // @see https://www.drupal.org/node/2345611
      $values = $this->connection
        ->query('SELECT * FROM {users_field_data} [u] WHERE [u].[uid] = :uid AND [u].[default_langcode] = 1', [
        ':uid' => $uid,
      ])
        ->fetchAssoc();

      // Check if the user data was found and the user is active.
      if (!empty($values) && $values['status'] == 1) {

        // Add the user's roles.
        $rids = $this->connection
          ->query('SELECT [roles_target_id] FROM {user__roles} WHERE [entity_id] = :uid', [
          ':uid' => $values['uid'],
        ])
          ->fetchCol();
        $values['roles'] = array_merge([
          AccountInterface::AUTHENTICATED_ROLE,
        ], $rids);
        return new UserSession($values);
      }
    }

    // This is an anonymous session.
    return NULL;
  }

  /**
   * Adds a query parameter to check successful log in redirect URL.
   *
   * @param \Symfony\Component\HttpKernel\Event\ResponseEvent $event
   *   The Event to process.
   */
  public function addCheckToUrl(ResponseEvent $event) {
    $response = $event
      ->getResponse();
    if ($response instanceof RedirectResponse && $event
      ->getRequest()
      ->hasSession()) {
      if ($event
        ->getRequest()
        ->getSession()
        ->has('check_logged_in')) {
        $event
          ->getRequest()
          ->getSession()
          ->remove('check_logged_in');
        $url = $response
          ->getTargetUrl();
        $options = UrlHelper::parse($url);
        $options['query']['check_logged_in'] = '1';
        $url = $options['path'] . '?' . UrlHelper::buildQuery($options['query']);
        if (!empty($options['#fragment'])) {
          $url .= '#' . $options['#fragment'];
        }
        $response
          ->setTargetUrl($url);
      }
    }
  }

  /**
   * Registers the methods in this class that should be listeners.
   *
   * @return array
   *   An array of event listener definitions.
   */
  public static function getSubscribedEvents() {
    $events[KernelEvents::RESPONSE][] = [
      'addCheckToUrl',
      -1000,
    ];
    return $events;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
Cookie::$connection	protected	property	The database connection.
Cookie::$messenger	protected	property	The messenger.
Cookie::$sessionConfiguration	protected	property	The session configuration.
Cookie::addCheckToUrl	public	function	Adds a query parameter to check successful log in redirect URL.
Cookie::applies	public	function	Checks whether suitable authentication credentials are on the request. Overrides AuthenticationProviderInterface::applies
Cookie::authenticate	public	function	Authenticates the user. Overrides AuthenticationProviderInterface::authenticate
Cookie::getSubscribedEvents	public static	function	Registers the methods in this class that should be listeners.
Cookie::getUserFromSession	protected	function	Returns the UserSession object for the given session.
Cookie::__construct	public	function	Constructs a new cookie authentication provider.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.