phorge-phorge/src/applications/auth/controller/oauthdiagnostics/PhabricatorOAuthDiagnosticsController.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.
 */

class PhabricatorOAuthDiagnosticsController
  extends PhabricatorAuthController {

  public function shouldRequireLogin() {
    return false;
  }

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

  public function processRequest() {

    $provider = $this->provider;

    $auth_enabled   = $provider->isProviderEnabled();
    $client_id      = $provider->getClientID();
    $client_secret  = $provider->getClientSecret();
    $key            = $provider->getProviderKey();
    $name           = phutil_escape_html($provider->getProviderName());

    $res_ok = '<strong style="color: #00aa00;">OK</strong>';
    $res_no = '<strong style="color: #aa0000;">NO</strong>';
    $res_na = '<strong style="color: #999999;">N/A</strong>';

    $results = array();
    $auth_key = $key . '.auth-enabled';
    if (!$auth_enabled) {
      $results[$auth_key] = array(
        $res_no,
        'false',
        $name . ' authentication is disabled in the configuration. Edit the '.
        'Phabricator configuration to enable "'.$auth_key.'".');
    } else {
      $results[$auth_key] = array(
        $res_ok,
        'true',
        $name.' authentication is enabled.');
    }

    $client_id_key = $key. '.application-id';
    if (!$client_id) {
      $results[$client_id_key] = array(
        $res_no,
        null,
        'No '.$name.' Application ID is configured. Edit the Phabricator '.
        'configuration to specify an application ID in '.
        '"'.$client_id_key.'". '.$provider->renderGetClientIDHelp());
    } else {
      $results[$client_id_key] = array(
        $res_ok,
        $client_id,
        'Application ID is set.');
    }

    $client_secret_key = $key.'.application-secret';
    if (!$client_secret) {
      $results[$client_secret_key] = array(
        $res_no,
        null,
        'No '.$name.' Application secret is configured. Edit the '.
        'Phabricator configuration to specify an Application Secret, in '.
        '"'.$client_secret_key.'". '.$provider->renderGetClientSecretHelp());
    } else {
      $results[$client_secret_key] = array(
        $res_ok,
        "It's a secret!",
        'Application secret is set.');
    }

    $timeout = stream_context_create(
      array(
        'http' => array(
          'ignore_errors' => true,
          'timeout'       => 5,
        ),
      ));
    $timeout_strict = stream_context_create(
      array(
        'http' => array(
          'timeout'       => 5,
        ),
      ));

    $internet = @file_get_contents("http://google.com/", false, $timeout);
    if ($internet === false) {
      $results['internet'] = array(
        $res_no,
        null,
        'Unable to make an HTTP request to Google. Check your outbound '.
        'internet connection and firewall/filtering settings.');
    } else {
      $results['internet'] = array(
        $res_ok,
        null,
        'Internet seems OK.');
    }

    $test_uris = $provider->getTestURIs();
    foreach ($test_uris as $uri) {
      $success = @file_get_contents($uri, false, $timeout);
      if ($success === false) {
        $results[$uri] = array(
          $res_no,
          null,
          "Unable to make an HTTP request to {$uri}. {$name} may be ".
          'down or inaccessible.');
      } else {
        $results[$uri] = array(
          $res_ok,
          null,
          'Made a request to '.$uri.'.');
      }
    }

    $test_uri = new PhutilURI($provider->getTokenURI());
    $test_uri->setQueryParams(
      array(
        'client_id'       => $client_id,
        'client_secret'   => $client_secret,
        'grant_type'      => 'client_credentials',
      ));

    $token_value  = @file_get_contents($test_uri, false, $timeout);
    $token_strict = @file_get_contents($test_uri, false, $timeout_strict);
    if ($token_value === false) {
      $results['App Login'] = array(
        $res_no,
        null,
        "Unable to perform an application login with your Application ID and ".
        "Application Secret. You may have mistyped or misconfigured them; ".
        "{$name} may have revoked your authorization; or {$name} may be ".
        "having technical problems.");
    } else {
      if ($token_strict) {
        $results['App Login'] = array(
          $res_ok,
          '(A Valid Token)',
          "Raw application login to {$name} works.");
      } else {
        $data = json_decode($token_value, true);
        if (!is_array($data)) {
          $results['App Login'] = array(
            $res_no,
            $token_value,
            "Application Login failed but the provider did not respond ".
            "with valid JSON error information. {$name} may be experiencing ".
            "technical problems.");
        } else {
          $results['App Login'] = array(
            $res_no,
            null,
            "Application Login failed with error: ".$token_value);
        }
      }
    }

    return $this->renderResults($results);
  }

  private function renderResults($results) {
    $provider = $this->provider;

    $rows = array();
    foreach ($results as $key => $result) {
      $rows[] = array(
        phutil_escape_html($key),
        $result[0],
        phutil_escape_html($result[1]),
        phutil_escape_html($result[2]),
      );
    }

    $table_view = new AphrontTableView($rows);
    $table_view->setHeaders(
      array(
        'Test',
        'Result',
        'Value',
        'Details',
      ));
    $table_view->setColumnClasses(
      array(
        null,
        null,
        null,
        'wide',
      ));

    $title = $provider->getProviderName() . ' Auth Diagnostics';

    $panel_view = new AphrontPanelView();
    $panel_view->setHeader($title);
    $panel_view->appendChild(
      '<p class="aphront-panel-instructions">These tests may be able to '.
      'help diagnose the root cause of problems you experience with '.
      $provider->getProviderName() .
      ' Authentication. Reload the page to run the tests again.</p>');
    $panel_view->appendChild($table_view);

    return $this->buildStandardPageResponse(
      $panel_view,
      array(
        'title' => $title,
      ));
  }

}