PantheonGuzzle.php

<?php

namespace Drupal\search_api_pantheon\Services;

use Drupal\search_api_pantheon\Traits\EndpointAwareTrait;
use GuzzleHttp\Client;
use GuzzleHttp\Handler\CurlHandler;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\Middleware;
use Http\Factory\Guzzle\RequestFactory;
use Http\Factory\Guzzle\StreamFactory;
use Psr\Http\Client\ClientInterface;
use Psr\Http\Message\RequestInterface;
use Psr\Http\Message\ResponseInterface;
use Psr\Log\LoggerAwareInterface;
use Psr\Log\LoggerAwareTrait;
use Solarium\Core\Client\Adapter\AdapterInterface;
use Solarium\Core\Client\Adapter\Psr18Adapter;
use Drupal\Core\Logger\LoggerChannelFactoryInterface;
use Drupal\Core\Session\AccountProxyInterface;

/**
 * Pantheon-specific extension of the Guzzle http query class.
 *
 * @package \Drupal\search_api_pantheon
 */
class PantheonGuzzle extends Client implements
  ClientInterface,
  LoggerAwareInterface {
  use LoggerAwareTrait;
  use EndpointAwareTrait;

  public static $messageFormats = [
        '{method} {uri} HTTP/{version}',
        'HEADERS: {req_headers}',
        'BODY: {req_body}',
        'RESPONSE: {code} - {res_body}',
    ];

  /**
   * Class Constructor.
   */
  public function __construct(Endpoint $endpoint, LoggerChannelFactoryInterface $logger_factory, AccountProxyInterface $current_user) {
    $stack = new HandlerStack();
    $stack->setHandler(new CurlHandler());
    $stack->push(
          Middleware::mapRequest([$this, 'requestUriAlterForPantheonEnvironment']),
          'rewriter'
      );
    /**
     *$stack->push(
     * Middleware::log(
     * $loggerChannelFactory->get('PantheonGuzzle'),
     * new MessageFormatter(static::$messageFormats),
     * LogLevel::DEBUG
     * ), 'logger'
     * );
     **/
    $cert = ($_SERVER['HOME'] ?? '') . '/certs/binding.pem';
    $config = [
          'base_uri' => $endpoint->getBaseUri(),
          'http_errors' => FALSE,
          'debug' => FALSE,
          'verify' => FALSE,
          'handler' => $stack,
          'allow_redirects' => FALSE,
      ];
    // Putting `?debug=true` at the end of any Solr url will show you the low-level debugging from guzzle.
    if ((php_sapi_name() === 'cli' || isset($_GET['debug'])) && $current_user->hasPermission('access search_api_pantheon debug information')) {
      $config['debug'] = TRUE;
    }
    if (is_file($cert)) {
      $config['cert'] = $cert;
    }
    parent::__construct($config);
    if (!$endpoint instanceof Endpoint) {
      throw new \InvalidArgumentException('Endpoint must be an instance of Endpoint');
    }
    $this->setEndpoint($endpoint);
    if ($logger_factory instanceof LoggerChannelFactoryInterface) {
      $this->setLogger($logger_factory->get('PantheonGuzzle'));
    }
    $this->setLogger($logger_factory->get('PantheonGuzzle'));
  }

  /**
   * Send a guzzle request.
   *
   * @param \Psr\Http\Message\RequestInterface $request
   *   A PSR 7 request.
   *
   * @return \Psr\Http\Message\ResponseInterface
   *   Response from the guzzle send.
   *
   * @throws \GuzzleHttp\Exception\GuzzleException
   */
  public function sendRequest(RequestInterface $request): ResponseInterface {
    return $this->send($request);
  }

  /**
   * Make a query and return the JSON results.
   *
   * @param string $path
   *   URL path to add to the query.
   * @param array $guzzleOptions
   *   Options to pass to the Guzzle client.
   *
   * @return mixed
   *   Response from the query.
   *
   * @throws \Exception
   *
   * @throws \JsonException
   */
  public function getQueryResult(
        string $path,
        array $guzzleOptions = ['query' => [], 'headers' => ['Content-Type' => 'application/json']]
    ) {
    $response = $this->get($path, $guzzleOptions);
    if (
          $response instanceof ResponseInterface && !in_array($response->getStatusCode(), [200, 201, 202, 203, 204])
      ) {
      $this->logger->error('Query Failed: ' . $response->getReasonPhrase());
    }
    $content_type = $response->getHeader('Content-Type')[0] ?? '';
    if (strpos($content_type, 'application/json') !== FALSE) {
      return json_decode(
            $response->getBody(),
            TRUE,
            512,
            JSON_THROW_ON_ERROR
        );
    }
    return (string) $response->getBody();
  }

  /**
   * Get a PSR adapter interface based on this class.
   *
   * @return \Solarium\Core\Client\Adapter\AdapterInterface
   *   The interface in question.
   */
  public function getPsr18Adapter(): AdapterInterface {
    return new Psr18Adapter(
          $this,
          new RequestFactory(),
          new StreamFactory()
      );
  }

  /**
   * Request Middleware Callback.
   *
   * @param \Psr\Http\Message\RequestInterface $request
   *
   * @return \Psr\Http\Message\RequestInterface
   */
  public function requestUriAlterForPantheonEnvironment(RequestInterface $request) {
    $toAdd = '';
    $uri = $request->getUri();
    $path = $uri->getPath();
    $path_parts = explode('/', $path);
    $shouldBeInUrl = $this->endpoint->getMySitename();
    $shouldBeInPath = $this->endpoint->getPath();
    if (!in_array(trim($shouldBeInUrl, '/'), $path_parts)) {
      array_unshift($path_parts, trim($this->endpoint->getCore(), '/'));
    }
    if (!in_array(trim($shouldBeInPath, '/'), $path_parts)) {
      array_unshift($path_parts, trim($this->endpoint->getPath(), '/'));
    }
    $path_parts = array_filter($path_parts, function ($item) {
        return !empty($item);
    });
    $uri = $uri->withPath('/' . ltrim(implode('/', $path_parts), '/'));
    return $request->withUri($uri);
  }

}