PhabricatorAuthStartController.php

<?php

final class PhabricatorAuthStartController
  extends PhabricatorAuthController {

  public function shouldRequireLogin() {
    return false;
  }

  public function handleRequest(AphrontRequest $request) {
    $viewer = $request->getUser();

    if ($viewer->isLoggedIn()) {
      // Kick the user home if they are already logged in.
      return id(new AphrontRedirectResponse())->setURI('/');
    }

    if ($request->isAjax()) {
      return $this->processAjaxRequest();
    }

    if ($request->isConduit()) {
      return $this->processConduitRequest();
    }

    // If the user gets this far, they aren't logged in, so if they have a
    // user session token we can conclude that it's invalid: if it was valid,
    // they'd have been logged in above and never made it here. Try to clear
    // it and warn the user they may need to nuke their cookies.

    $session_token = $request->getCookie(PhabricatorCookies::COOKIE_SESSION);
    $did_clear = $request->getStr('cleared');

    if ($session_token !== null && strlen($session_token)) {
      $kind = PhabricatorAuthSessionEngine::getSessionKindFromToken(
        $session_token);
      switch ($kind) {
        case PhabricatorAuthSessionEngine::KIND_ANONYMOUS:
          // If this is an anonymous session. It's expected that they won't
          // be logged in, so we can just continue.
          break;
        default:
          // The session cookie is invalid, so try to clear it.
          $request->clearCookie(PhabricatorCookies::COOKIE_USERNAME);
          $request->clearCookie(PhabricatorCookies::COOKIE_SESSION);

          // We've previously tried to clear the cookie but we ended up back
          // here, so it didn't work. Hard fatal instead of trying again.
          if ($did_clear) {
            return $this->renderError(
              pht(
                'Your login session is invalid, and clearing the session '.
                'cookie was unsuccessful. Try clearing your browser cookies.'));
          }

          $redirect_uri = $request->getRequestURI();
          $redirect_uri->replaceQueryParam('cleared', 1);
          return id(new AphrontRedirectResponse())->setURI($redirect_uri);
      }
    }

    // If we just cleared the session cookie and it worked, clean up after
    // ourselves by redirecting to get rid of the "cleared" parameter. The
    // the workflow will continue normally.
    if ($did_clear) {
      $redirect_uri = $request->getRequestURI();
      $redirect_uri->removeQueryParam('cleared');
      return id(new AphrontRedirectResponse())->setURI($redirect_uri);
    }

    $providers = PhabricatorAuthProvider::getAllEnabledProviders();
    foreach ($providers as $key => $provider) {
      if (!$provider->shouldAllowLogin()) {
        unset($providers[$key]);
      }
    }

    $configs = array();
    foreach ($providers as $provider) {
      $configs[] = $provider->getProviderConfig();
    }

    if (!$providers) {
      if ($this->isFirstTimeSetup()) {
        // If this is a fresh install, let the user register their admin
        // account.
        return id(new AphrontRedirectResponse())
          ->setURI($this->getApplicationURI('/register/'));
      }

      return $this->renderError(
        pht(
          'This server is not configured with any enabled authentication '.
          'providers which can be used to log in. If you have accidentally '.
          'locked yourself out by disabling all providers, you can use `%s` '.
          'to recover access to an account.',
          './bin/auth recover <username>'));
    }

    $next_uri = $request->getStr('next');
    if (phutil_nonempty_string($next_uri)) {
      if ($this->getDelegatingController()) {
        // Only set a next URI from the request path if this controller was
        // delegated to, which happens when a user tries to view a page which
        // requires them to login.

        // If this controller handled the request directly, we're on the main
        // login page, and never want to redirect the user back here after they
        // login.
        $next_uri = (string)$this->getRequest()->getRequestURI();
      }
    }

    if (!$request->isFormPost()) {
      if (phutil_nonempty_string($next_uri)) {
        PhabricatorCookies::setNextURICookie($request, $next_uri);
      }
      PhabricatorCookies::setClientIDCookie($request);
    }

    $auto_response = $this->tryAutoLogin($providers);
    if ($auto_response) {
      return $auto_response;
    }

    $invite = $this->loadInvite();

    $not_buttons = array();
    $are_buttons = array();
    $providers = msort($providers, 'getLoginOrder');
    foreach ($providers as $provider) {
      if ($invite) {
        $form = $provider->buildInviteForm($this);
      } else {
        $form = $provider->buildLoginForm($this);
      }
      if ($provider->isLoginFormAButton()) {
        $are_buttons[] = $form;
      } else {
        $not_buttons[] = $form;
      }
    }

    $out = array();
    $out[] = $not_buttons;
    if ($are_buttons) {
      require_celerity_resource('auth-css');

      foreach ($are_buttons as $key => $button) {
        $are_buttons[$key] = phutil_tag(
          'div',
          array(
            'class' => 'phabricator-login-button mmb',
          ),
          $button);
      }

      // If we only have one button, add a second pretend button so that we
      // always have two columns. This makes it easier to get the alignments
      // looking reasonable.
      if (count($are_buttons) == 1) {
        $are_buttons[] = null;
      }

      $button_columns = id(new AphrontMultiColumnView())
        ->setFluidLayout(true);
      $are_buttons = array_chunk($are_buttons, ceil(count($are_buttons) / 2));
      foreach ($are_buttons as $column) {
        $button_columns->addColumn($column);
      }

      $out[] = phutil_tag(
        'div',
        array(
          'class' => 'phabricator-login-buttons',
        ),
        $button_columns);
    }

    $invite_message = null;
    if ($invite) {
      $invite_message = $this->renderInviteHeader($invite);
    }

    $custom_message = $this->newCustomStartMessage();

    $email_login = $this->newEmailLoginView($configs);

    $crumbs = $this->buildApplicationCrumbs();
    $crumbs->addTextCrumb(pht('Login'));
    $crumbs->setBorder(true);

    $title = pht('Login');
    $view = array(
      $invite_message,
      $custom_message,
      $out,
      $email_login,
    );

    return $this->newPage()
      ->setTitle($title)
      ->setCrumbs($crumbs)
      ->appendChild($view);
  }


  private function processAjaxRequest() {
    $request = $this->getRequest();
    $viewer = $request->getUser();

    // We end up here if the user clicks a workflow link that they need to
    // login to use. We give them a dialog saying "You need to login...".

    if ($request->isDialogFormPost()) {
      return id(new AphrontRedirectResponse())->setURI(
        $request->getRequestURI());
    }

    // Often, users end up here by clicking a disabled action link in the UI
    // (for example, they might click "Edit Subtasks" on a Maniphest task
    // page). After they log in we want to send them back to that main object
    // page if we can, since it's confusing to end up on a standalone page with
    // only a dialog (particularly if that dialog is another error,
    // like a policy exception).

    $via_header = AphrontRequest::getViaHeaderName();
    $via_uri = AphrontRequest::getHTTPHeader($via_header);
    if ($via_uri !== null && strlen($via_uri)) {
      PhabricatorCookies::setNextURICookie($request, $via_uri, $force = true);
    }

    return $this->newDialog()
      ->setTitle(pht('Login Required'))
      ->appendParagraph(pht('You must log in to take this action.'))
      ->addSubmitButton(pht('Log In'))
      ->addCancelButton('/');
  }


  private function processConduitRequest() {
    $request = $this->getRequest();
    $viewer = $request->getUser();

    // A common source of errors in Conduit client configuration is getting
    // the request path wrong. The client will end up here, so make some
    // effort to give them a comprehensible error message.

    $request_path = $this->getRequest()->getPath();
    $conduit_path = '/api/<method>';
    $example_path = '/api/conduit.ping';

    $message = pht(
      'ERROR: You are making a Conduit API request to "%s", but the correct '.
      'HTTP request path to use in order to access a Conduit method is "%s" '.
      '(for example, "%s"). Check your configuration.',
      $request_path,
      $conduit_path,
      $example_path);

    return id(new AphrontPlainTextResponse())->setContent($message);
  }

  protected function renderError($message) {
    return $this->renderErrorPage(
      pht('Authentication Failure'),
      array($message));
  }

  private function tryAutoLogin(array $providers) {
    $request = $this->getRequest();

    // If the user just logged out, don't immediately log them in again.
    if ($request->getURIData('loggedout')) {
      return null;
    }

    // If we have more than one provider, we can't autologin because we
    // don't know which one the user wants.
    if (count($providers) != 1) {
      return null;
    }

    $provider = head($providers);
    if (!$provider->supportsAutoLogin()) {
      return null;
    }

    $config = $provider->getProviderConfig();
    if (!$config->getShouldAutoLogin()) {
      return null;
    }

    $auto_uri = $provider->getAutoLoginURI($request);

    return id(new AphrontRedirectResponse())
      ->setIsExternal(true)
      ->setURI($auto_uri);
  }

  private function newEmailLoginView(array $configs) {
    assert_instances_of($configs, 'PhabricatorAuthProviderConfig');

    // Check if password auth is enabled. If it is, the password login form
    // renders a "Forgot password?" link, so we don't need to provide a
    // supplemental link.

    $has_password = false;
    foreach ($configs as $config) {
      $provider = $config->getProvider();
      if ($provider instanceof PhabricatorPasswordAuthProvider) {
        $has_password = true;
      }
    }

    if ($has_password) {
      return null;
    }

    $view = array(
      pht('Trouble logging in?'),
      ' ',
      phutil_tag(
        'a',
        array(
          'href' => '/login/email/',
        ),
        pht('Send a login link to your email address.')),
    );

    return phutil_tag(
      'div',
      array(
        'class' => 'auth-custom-message',
      ),
      $view);
  }


}