You are here

Home » API reference » Simple FB Connect 8.3 » SimpleFbConnectController.php

class SimpleFbConnectController in Simple FB Connect 8.3

Same name and namespace in other branches
  1. 8 src/Controller/SimpleFBConnectController.php \Drupal\simple_fb_connect\Controller\SimpleFBConnectController
  2. 8.2 src/Controller/SimpleFbConnectController.php \Drupal\simple_fb_connect\Controller\SimpleFbConnectController

Returns responses for Simple FB Connect module routes.

Hierarchy

Expanded class hierarchy of SimpleFbConnectController

File

src/Controller/SimpleFbConnectController.php, line 19

Namespace

Drupal\simple_fb_connect\Controller
View source 
class SimpleFbConnectController extends ControllerBase {
  protected $fbManager;
  protected $userManager;
  protected $postLoginManager;
  protected $persistentDataHandler;
  protected $fbFactory;

  /**
   * Constructor.
   *
   * The constructor parameters are passed from the create() method.
   *
   * @param \Drupal\simple_fb_connect\SimpleFbConnectFbManager $fb_manager
   *   SimpleFbConnectFbManager object.
   * @param \Drupal\simple_fb_connect\SimpleFbConnectUserManager $user_manager
   *   SimpleFbConnectUserManager object.
   * @param \Drupal\simple_fb_connect\SimpleFbConnectPostLoginManager $post_login_manager
   *   SimpleFbConnectPostLoginManager object.
   * @param \Drupal\simple_fb_connect\SimpleFbConnectPersistentDataHandler $persistent_data_handler
   *   SimpleFbConnectPersistentDataHandler object.
   * @param \Drupal\simple_fb_connect\SimpleFbConnectFbFactory $fb_factory
   *   SimpleFbConnectFbFactory object.
   */
  public function __construct(SimpleFbConnectFbManager $fb_manager, SimpleFbConnectUserManager $user_manager, SimpleFbConnectPostLoginManager $post_login_manager, SimpleFbConnectPersistentDataHandler $persistent_data_handler, SimpleFbConnectFbFactory $fb_factory) {
    $this->fbManager = $fb_manager;
    $this->userManager = $user_manager;
    $this->postLoginManager = $post_login_manager;
    $this->persistentDataHandler = $persistent_data_handler;
    $this->fbFactory = $fb_factory;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('simple_fb_connect.fb_manager'), $container
      ->get('simple_fb_connect.user_manager'), $container
      ->get('simple_fb_connect.post_login_manager'), $container
      ->get('simple_fb_connect.persistent_data_handler'), $container
      ->get('simple_fb_connect.fb_factory'));
  }

  /**
   * Response for path 'user/simple-fb-connect'.
   *
   * Redirects the user to FB for authentication.
   */
  public function redirectToFb() {

    // Try to get an instance of Facebook service.
    if (!($facebook = $this->fbFactory
      ->getFbService())) {
      drupal_set_message($this
        ->t('Simple FB Connect is not configured properly. Please contact site administrator.'), 'error');
      return $this
        ->redirect('user.login');
    }

    // Facebook service was returned, inject it to $fbManager.
    $this->fbManager
      ->setFacebookService($facebook);

    // Save post login path to session if it was set as a query parameter.
    if ($post_login_path = $this->postLoginManager
      ->getPostLoginPathFromRequest()) {
      $this->postLoginManager
        ->savePostLoginPath($post_login_path);
    }

    // Generate the URL where the user will be redirected for FB login.
    // If the user did not have email permission granted on previous attempt,
    // we use the re-request URL requesting only the email address.
    $fb_login_url = $this->fbManager
      ->getFbLoginUrl();
    if ($this->persistentDataHandler
      ->get('reprompt')) {
      $fb_login_url = $this->fbManager
        ->getFbReRequestUrl();
    }
    return new TrustedRedirectResponse($fb_login_url);
  }

  /**
   * Response for path 'user/simple-fb-connect/return'.
   *
   * Facebook returns the user here after user has authenticated in FB.
   */
  public function returnFromFb() {

    // Try to get an instance of Facebook service.
    if (!($facebook = $this->fbFactory
      ->getFbService())) {
      drupal_set_message($this
        ->t('Simple FB Connect is not configured properly. Please contact site administrator.'), 'error');
      return $this
        ->redirect('user.login');
    }

    // Facebook service was returned, inject it to $fbManager.
    $this->fbManager
      ->setFacebookService($facebook);

    // Read user's access token from Facebook.
    if (!($access_token = $this->fbManager
      ->getAccessTokenFromFb())) {
      drupal_set_message($this
        ->t('Facebook login failed.'), 'error');
      return $this
        ->redirect('user.login');
    }

    // Check that user authorized our app to access user's email address.
    if (!$this->fbManager
      ->checkPermission('email')) {
      if ($site_name = $this
        ->config('system.site')
        ->get('name')) {
        drupal_set_message($this
          ->t('Facebook login failed. @site_name requires permission to get your email address from Facebook. Please try again and give the permission.', [
          '@site_name' => $site_name,
        ]), 'error');
      }
      else {
        drupal_set_message($this
          ->t('Facebook login failed. This site requires permission to get your email address from Facebook. Please try again and give the permission.'), 'error');
      }
      $this->persistentDataHandler
        ->set('reprompt', TRUE);
      return $this
        ->redirect('user.login');
    }

    // Get user's FB profile from Facebook API.
    if (!($fb_profile = $this->fbManager
      ->getFbProfile())) {
      drupal_set_message($this
        ->t('Facebook login failed, Facebook profile could not be loaded. Please contact site administrator.'), 'error');
      return $this
        ->redirect('user.login');
    }

    // Get user's email from the FB profile.
    if (!($email = $this->fbManager
      ->getEmail($fb_profile))) {
      drupal_set_message($this
        ->t('Facebook login failed. This site requires an email address. Please add one in your Facebook profile and try again.'), 'error');
      return $this
        ->redirect('user.login');
    }

    // Save access token to session so that event subscribers can call FB API.
    $this->persistentDataHandler
      ->set('access_token', $access_token);

    // If we have an existing user with the same email address, try to log in.
    if ($drupal_user = $this->userManager
      ->loadUserByProperty('mail', $email)) {
      if ($this->userManager
        ->loginUser($drupal_user)) {

        // Redirect the user to post login path.
        return new RedirectResponse($this->postLoginManager
          ->getPostLoginPath());
      }
      else {

        // Login was not successful. Unset access token from session.
        $this->persistentDataHandler
          ->set('access_token', NULL);
        return $this
          ->redirect('user.login');
      }
    }

    // If there was no existing user, try to create a new user.
    $fbid = $fb_profile
      ->getField('id');
    $fb_profile_pic = $this->fbManager
      ->getFbProfilePic();
    if ($drupal_user = $this->userManager
      ->createUser($fb_profile
      ->getField('name'), $email, $fbid, $fb_profile_pic)) {

      // Log the newly created user in.
      if ($this->userManager
        ->loginUser($drupal_user)) {

        // Check if new users should be redirected to Drupal user form.
        if ($this->postLoginManager
          ->getRedirectNewUsersToUserFormSetting()) {
          drupal_set_message($this
            ->t("Please take a moment to confirm your account details. Since you logged in with Facebook, you don't need to update your password."));
          return new RedirectResponse($this->postLoginManager
            ->getPathToUserForm($drupal_user));
        }

        // Use normal post login path if user wasn't redirected to user form.
        return new RedirectResponse($this->postLoginManager
          ->getPostLoginPath());
      }
      else {

        // New user was created but the account is pending approval.
        // Unset access token from session.
        $this->persistentDataHandler
          ->set('access_token', NULL);
        drupal_set_message($this
          ->t('You will receive an email when a site administrator activates your account.'), 'warning');
        return $this
          ->redirect('user.login');
      }
    }
    else {

      // User could not be created. Unset access token from session.
      $this->persistentDataHandler
        ->set('access_token', NULL);
      return $this
        ->redirect('user.login');
    }

    // This should never be reached, user should have been redirected already.
    $this->persistentDataHandler
      ->set('access_token', NULL);
    throw new AccessDeniedHttpException();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
SimpleFbConnectController::$fbFactory protected property
SimpleFbConnectController::$fbManager protected property
SimpleFbConnectController::$persistentDataHandler protected property
SimpleFbConnectController::$postLoginManager protected property
SimpleFbConnectController::$userManager protected property
SimpleFbConnectController::create public static function Instantiates a new instance of this class. Overrides ControllerBase::create
SimpleFbConnectController::redirectToFb public function Response for path 'user/simple-fb-connect'.
SimpleFbConnectController::returnFromFb public function Response for path 'user/simple-fb-connect/return'.
SimpleFbConnectController::__construct public function Constructor.
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.