You are here

Home » API reference » Bakery Single Sign-On System 8.2 » ChildDeprecatedController.php

class ChildDeprecatedController in Bakery Single Sign-On System 8.2

Hierarchy

Expanded class hierarchy of ChildDeprecatedController

File

src/Controller/ChildDeprecatedController.php, line 12

Namespace

Drupal\bakery\Controller
View source 
class ChildDeprecatedController extends ControllerBase {

  /**
   * @var \Drupal\bakery\Kitchen
   */
  protected $kitchen;

  /**
   * Initialize bakery service.
   *
   * @param \Drupal\bakery\Kitchen $kitchen
   *   Kitchen service.
   */
  public function __construct(Kitchen $kitchen) {
    $this->kitchen = $kitchen;
  }

  /**
   * When this controller is created, it will get the bakery.bakery_service.
   *
   * @param \Symfony\Component\DependencyInjection\ContainerInterface $container
   *   For getting Bakery service.
   *
   * @return static
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('bakery.kitchen'));
  }

  /**
   * Custom return for child registration process.
   *
   * Redirects to the homepage on success or to
   * the register page if there was a problem.
   */
  public function registerReturn() {
    $cookie = $this->kitchen
      ->taste(Kitchen::OATMEAL);
    if ($cookie) {

      // Valid cookie, now destroy it.
      $this->kitchen
        ->eat(Kitchen::OATMEAL);

      // Destination in cookie was set before user left this site, extract it to
      // be sure destination workflow is followed.
      if (empty($cookie['data']['destination'])) {
        $destination = '<front>';
      }
      else {
        $destination = $cookie['data']['destination'];
      }
      $errors = $cookie['data']['errors'];
      if (empty($errors)) {
        $this
          ->messenger()
          ->addMessage($this
          ->t('Registration successful. You are now logged in.'));

        // Redirect to destination.
        $this
          ->redirect($destination);
      }
      else {
        if (!empty($errors['register'])) {
          $this
            ->messenger()
            ->addError($this
            ->t('Registration is not enabled on @master. Please contact a site administrator.', [
            '@master' => $this
              ->config('bakery.settings')
              ->get('bakery_master'),
          ]));
          $this
            ->getLogger('bakery')
            ->error('Master Bakery site user registration is disabled', []);
        }
        if (!empty($errors['validate'])) {

          // If the user must validate their email then we need to create an
          // account for them on the child site.
          // Save a stub account so we have a child UID to send.
          $language = $this
            ->languageManager()
            ->getCurrentLanguage()
            ->getId();
          $account = User::create();

          // Mandatory settings.
          $account
            ->setPassword(user_password());
          $account
            ->enforceIsNew();
          $account
            ->setEmail($cookie['data']['mail']);

          // This username must be unique and accept only a-Z,0-9, - _ @ .
          $account
            ->setUsername($cookie['name']);

          // Optional settings.
          $account
            ->set('init', $this->kitchen
            ->generateInitField($cookie['data']['uid']));
          $account
            ->set('langcode', $language);
          $account
            ->set('preferred_langcode', $language);
          $account
            ->set('preferred_admin_langcode', $language);

          // $user->set("setting_name", 'setting_value');.
          $account
            ->activate();

          // Save user.
          $account
            ->save();

          // Notify the user that they need to validate their email.
          _user_mail_notify('register_no_approval_required', $account);
          unset($_SESSION['bakery']['register']);
          $this
            ->messenger()
            ->addMessage($this
            ->t('A welcome message with further instructions has been sent to your e-mail address.'));
        }
        if (!empty($errors['name'])) {
          $this
            ->messenger()
            ->addError($this
            ->t('Name is already taken.'));
        }
        if (!empty($errors['mail'])) {
          $this
            ->messenger()
            ->addError($this
            ->t('E-mail address is already registered.'));
        }
        if (!empty($errors['mail_denied'])) {
          $this
            ->messenger()
            ->addError($this
            ->t('The e-mail address has been denied access..'));
        }
        if (!empty($errors['name_denied'])) {
          $this
            ->messenger()
            ->addError($this
            ->t('The name has been denied access..'));
        }

        // There are errors so keep user on registration page.
        $this
          ->redirect('user.register');
      }
    }
    throw new AccessDeniedHttpException();
  }

  /**
   * Custom return for errors during child login process.
   */
  public function loginReturn() {
    $cookie = $this->kitchen
      ->taste(Kitchen::OATMEAL);
    if ($cookie) {

      // Valid cookie, now destroy it.
      $this->kitchen
        ->eat(Kitchen::OATMEAL);
      if (!empty($cookie['data']['errors'])) {
        $errors = $cookie['data']['errors'];
        if (!empty($errors['incorrect-credentials'])) {
          $this
            ->messenger()
            ->addError($this
            ->t('Sorry, unrecognized username or password.'));
        }
        elseif (!empty($errors['name'])) {

          // In case an attacker got the hash we filter the argument
          // here to avoid exposing a XSS vector.
          $this
            ->messenger()
            ->addError(Xss::filter($errors['name']));
        }
      }
      if (empty($cookie['data']['destination'])) {
        return $this
          ->redirect('user.page');
      }
      else {

        // This is probably broken. Controller redirect only works for routes
        // and my gut tells me this is going to be populated with like a path
        // or something from a destination parameter.
        return $this
          ->redirect($cookie['data']['destination']);
      }
    }
    throw new AccessDeniedHttpException();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ChildDeprecatedController::$kitchen protected property
ChildDeprecatedController::create public static function When this controller is created, it will get the bakery.bakery_service. Overrides ControllerBase::create
ChildDeprecatedController::loginReturn public function Custom return for errors during child login process.
ChildDeprecatedController::registerReturn public function Custom return for child registration process.
ChildDeprecatedController::__construct public function Initialize bakery service.
ControllerBase::$configFactory protected property The configuration factory.
ControllerBase::$currentUser protected property The current user service. 1
ControllerBase::$entityFormBuilder protected property The entity form builder.
ControllerBase::$entityManager protected property The entity manager.
ControllerBase::$entityTypeManager protected property The entity type manager.
ControllerBase::$formBuilder protected property The form builder. 2
ControllerBase::$keyValue protected property The key-value storage. 1
ControllerBase::$languageManager protected property The language manager. 1
ControllerBase::$moduleHandler protected property The module handler. 2
ControllerBase::$stateService protected property The state service.
ControllerBase::cache protected function Returns the requested cache bin.
ControllerBase::config protected function Retrieves a configuration object.
ControllerBase::container private function Returns the service container.
ControllerBase::currentUser protected function Returns the current user. 1
ControllerBase::entityFormBuilder protected function Retrieves the entity form builder.
ControllerBase::entityManager Deprecated protected function Retrieves the entity manager service.
ControllerBase::entityTypeManager protected function Retrieves the entity type manager.
ControllerBase::formBuilder protected function Returns the form builder service. 2
ControllerBase::keyValue protected function Returns a key/value storage collection. 1
ControllerBase::languageManager protected function Returns the language manager service. 1
ControllerBase::moduleHandler protected function Returns the module handler. 2
ControllerBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
ControllerBase::state protected function Returns the state storage service.
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.