phorge/src/applications/auth/controller/PhabricatorOAuthLoginController.php

<?php

/*
 * Copyright 2012 Facebook, Inc.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *   http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

final class PhabricatorOAuthLoginController
  extends PhabricatorAuthController {

  private $provider;
  private $userID;

  private $accessToken;
  private $tokenExpires;
  private $oauthState;

  public function shouldRequireLogin() {
    return false;
  }

  public function willProcessRequest(array $data) {
    $this->provider = PhabricatorOAuthProvider::newProvider($data['provider']);
  }

  public function processRequest() {
    $current_user = $this->getRequest()->getUser();

    $provider = $this->provider;
    if (!$provider->isProviderEnabled()) {
      return new Aphront400Response();
    }

    $provider_name = $provider->getProviderName();
    $provider_key = $provider->getProviderKey();

    $request = $this->getRequest();

    if ($request->getStr('error')) {
      $error_view = id(new PhabricatorOAuthFailureView())
        ->setRequest($request);
      return $this->buildErrorResponse($error_view);
    }

    $error_response = $this->retrieveAccessToken($provider);
    if ($error_response) {
      return $error_response;
    }

    $userinfo_uri = new PhutilURI($provider->getUserInfoURI());
    $userinfo_uri->setQueryParam('access_token', $this->accessToken);
    $userinfo_uri = (string)$userinfo_uri;

    try {
      $user_data = HTTPSFuture::loadContent($userinfo_uri);
      if ($user_data === false) {
        throw new PhabricatorOAuthProviderException(
          "Request to '{$userinfo_uri}' failed!");
      }
      $provider->setUserData($user_data);
    } catch (PhabricatorOAuthProviderException $e) {
      return $this->buildErrorResponse(new PhabricatorOAuthFailureView(), $e);
    }
    $provider->setAccessToken($this->accessToken);

    $user_id = $provider->retrieveUserID();
    $provider_key = $provider->getProviderKey();

    $oauth_info = $this->retrieveOAuthInfo($provider);

    if ($current_user->getPHID()) {
      if ($oauth_info->getID()) {
        if ($oauth_info->getUserID() != $current_user->getID()) {
          $dialog = new AphrontDialogView();
          $dialog->setUser($current_user);
          $dialog->setTitle('Already Linked to Another Account');
          $dialog->appendChild(
            hsprintf(
              '<p>The %s account you just authorized is already linked to '.
              'another Phabricator account. Before you can associate your %s '.
              'account with this Phabriactor account, you must unlink it from '.
              'the Phabricator account it is currently linked to.</p>',
              $provider_name,
              $provider_name));
          $dialog->addCancelButton($provider->getSettingsPanelURI());

          return id(new AphrontDialogResponse())->setDialog($dialog);
        } else {
          $this->saveOAuthInfo($oauth_info); // Refresh token.
          return id(new AphrontRedirectResponse())
            ->setURI($provider->getSettingsPanelURI());
        }
      }

      $existing_oauth = id(new PhabricatorUserOAuthInfo())->loadOneWhere(
        'userID = %d AND oauthProvider = %s',
        $current_user->getID(),
        $provider_key);

      if ($existing_oauth) {
        $dialog = new AphrontDialogView();
        $dialog->setUser($current_user);
        $dialog->setTitle('Already Linked to an Account From This Provider');
        $dialog->appendChild(
          hsprintf(
            '<p>The account you are logged in with is already linked to a %s '.
            'account. Before you can link it to a different %s account, you '.
            'must unlink the old account.</p>',
            $provider_name,
            $provider_name));
        $dialog->addCancelButton($provider->getSettingsPanelURI());
        return id(new AphrontDialogResponse())->setDialog($dialog);
      }

      if (!$request->isDialogFormPost()) {
        $dialog = new AphrontDialogView();
        $dialog->setUser($current_user);
        $dialog->setTitle('Link '.$provider_name.' Account');
        $dialog->appendChild(
          hsprintf(
            '<p>Link your %s account to your Phabricator account?</p>',
            $provider_name));
        $dialog->addHiddenInput('confirm_token', $provider->getAccessToken());
        $dialog->addHiddenInput('expires', $oauth_info->getTokenExpires());
        $dialog->addHiddenInput('state', $this->oauthState);
        $dialog->addHiddenInput('scope', $oauth_info->getTokenScope());
        $dialog->addSubmitButton('Link Accounts');
        $dialog->addCancelButton($provider->getSettingsPanelURI());

        return id(new AphrontDialogResponse())->setDialog($dialog);
      }

      $oauth_info->setUserID($current_user->getID());

      $this->saveOAuthInfo($oauth_info);

      return id(new AphrontRedirectResponse())
        ->setURI($provider->getSettingsPanelURI());
    }

    // Login with known auth.

    if ($oauth_info->getID()) {
      $unguarded = AphrontWriteGuard::beginScopedUnguardedWrites();

      $known_user = id(new PhabricatorUser())->load($oauth_info->getUserID());

      $request->getApplicationConfiguration()->willAuthenticateUserWithOAuth(
        $known_user,
        $oauth_info,
        $provider);

      $session_key = $known_user->establishSession('web');

      $this->saveOAuthInfo($oauth_info);

      $request->setCookie('phusr', $known_user->getUsername());
      $request->setCookie('phsid', $session_key);

      $uri = new PhutilURI('/login/validate/');
      $uri->setQueryParams(
        array(
          'phusr' => $known_user->getUsername(),
        ));

      return id(new AphrontRedirectResponse())->setURI((string)$uri);
    }

    $oauth_email = $provider->retrieveUserEmail();
    if ($oauth_email) {
      $known_email = id(new PhabricatorUserEmail())
        ->loadOneWhere('address = %s', $oauth_email);
      if ($known_email) {
        $dialog = new AphrontDialogView();
        $dialog->setUser($current_user);
        $dialog->setTitle('Already Linked to Another Account');
        $dialog->appendChild(
          hsprintf(
            '<p>The %s account you just authorized has an email address which '.
            'is already in use by another Phabricator account. To link the '.
            'accounts, log in to your Phabricator account and then go to '.
            'Settings.</p>',
            $provider_name));

        $user = id(new PhabricatorUser())
          ->loadOneWhere('phid = %s', $known_email->getUserPHID());
        $oauth_infos = id(new PhabricatorUserOAuthInfo())
          ->loadAllWhere('userID = %d', $user->getID());
        if ($oauth_infos) {
          $providers = array();
          foreach ($oauth_infos as $info) {
            $provider = $info->getOAuthProvider();
            $providers[] = PhabricatorOAuthProvider::newProvider($provider)
              ->getProviderName();
          }
          $dialog->appendChild(
            hsprintf(
              '<p>The account is associated with: %s.</p>',
              implode(', ', $providers)));
        }

        $dialog->addCancelButton('/login/');

        return id(new AphrontDialogResponse())->setDialog($dialog);
      }
    }

    if (!$provider->isProviderRegistrationEnabled()) {
      $dialog = new AphrontDialogView();
      $dialog->setUser($current_user);
      $dialog->setTitle('No Account Registration With '.$provider_name);
      $dialog->appendChild(
        hsprintf(
          '<p>You can not register a new account using %s; you can only use '.
          'your %s account to log into an existing Phabricator account which '.
          'you have registered through other means.</p>',
          $provider_name,
          $provider_name));
      $dialog->addCancelButton('/login/');

      return id(new AphrontDialogResponse())->setDialog($dialog);
    }

    $controller = PhabricatorEnv::newObjectFromConfig(
      'controller.oauth-registration',
      array($this->getRequest()));

    $controller->setOAuthProvider($provider);
    $controller->setOAuthInfo($oauth_info);
    $controller->setOAuthState($this->oauthState);

    return $this->delegateToController($controller);
  }

  private function buildErrorResponse(PhabricatorOAuthFailureView $view,
    Exception $e = null) {

    $provider = $this->provider;

    $provider_name = $provider->getProviderName();
    $view->setOAuthProvider($provider);

    if ($e) {
      $view->setException($e);
    }

    return $this->buildStandardPageResponse(
      $view,
      array(
        'title' => $provider_name.' Auth Failed',
      ));
  }

  private function retrieveAccessToken(PhabricatorOAuthProvider $provider) {
    $request = $this->getRequest();

    $token = $request->getStr('confirm_token');
    if ($token) {
      $this->tokenExpires = $request->getInt('expires');
      $this->accessToken  = $token;
      $this->oauthState   = $request->getStr('state');
      return null;
    }

    $client_id      = $provider->getClientID();
    $client_secret  = $provider->getClientSecret();
    $redirect_uri   = $provider->getRedirectURI();
    $auth_uri       = $provider->getTokenURI();

    $code = $request->getStr('code');
    $query_data = array(
      'client_id'     => $client_id,
      'client_secret' => $client_secret,
      'redirect_uri'  => $redirect_uri,
      'code'          => $code,
    ) + $provider->getExtraTokenParameters();

    $future = new HTTPSFuture($auth_uri, $query_data);
    $future->setMethod('POST');
    try {
      list($response) = $future->resolvex();
    } catch (Exception $ex) {
      return $this->buildErrorResponse(new PhabricatorOAuthFailureView());
    }
    $data = $provider->decodeTokenResponse($response);

    $token = idx($data, 'access_token');
    if (!$token) {
      return $this->buildErrorResponse(new PhabricatorOAuthFailureView());
    }

    $this->tokenExpires = $provider->getTokenExpiryFromArray($data);
    $this->accessToken  = $token;
    $this->oauthState   = $request->getStr('state');

    return null;
  }

  private function retrieveOAuthInfo(PhabricatorOAuthProvider $provider) {

    $oauth_info = id(new PhabricatorUserOAuthInfo())->loadOneWhere(
      'oauthProvider = %s and oauthUID = %s',
      $provider->getProviderKey(),
      $provider->retrieveUserID());

    $scope = $this->getRequest()->getStr('scope');

    if (!$oauth_info) {
      $oauth_info = new PhabricatorUserOAuthInfo();
      $oauth_info->setOAuthProvider($provider->getProviderKey());
      $oauth_info->setOAuthUID($provider->retrieveUserID());
      // some providers don't tell you what scope you got, so default
      // to the minimum Phabricator requires rather than assuming no scope
      if (!$scope) {
        $scope = $provider->getMinimumScope();
      }
    }

    $oauth_info->setAccountURI($provider->retrieveUserAccountURI());
    $oauth_info->setAccountName($provider->retrieveUserAccountName());
    $oauth_info->setToken($provider->getAccessToken());
    $oauth_info->setTokenStatus(PhabricatorUserOAuthInfo::TOKEN_STATUS_GOOD);
    $oauth_info->setTokenScope($scope);

    // If we have out-of-date expiration info, just clear it out. Then replace
    // it with good info if the provider gave it to us.
    $expires = $oauth_info->getTokenExpires();
    if ($expires <= time()) {
      $expires = null;
    }
    if ($this->tokenExpires) {
      $expires = $this->tokenExpires;
    }
    $oauth_info->setTokenExpires($expires);

    return $oauth_info;
  }

  private function saveOAuthInfo(PhabricatorUserOAuthInfo $info) {
    // UNGUARDED WRITES: Logging-in users don't have their CSRF set up yet.
    $unguarded = AphrontWriteGuard::beginScopedUnguardedWrites();
    $info->save();
  }
}