Your IP : 216.73.216.43

Current Path : /proc/3751963/cwd/public_html/pano.4uweb.ca/src/Library/Http/
Upload File :
Current File : //proc/3751963/cwd/public_html/pano.4uweb.ca/src/Library/Http/HttpFactory.php

<?php
/**
 * @package   panopticon
 * @copyright Copyright (c)2023-2024 Nicholas K. Dionysopoulos / Akeeba Ltd
 * @license   https://www.gnu.org/licenses/agpl-3.0.txt GNU Affero General Public License, version 3 or later
 */

namespace Akeeba\Panopticon\Library\Http;

defined('AKEEBA') || die;

use Akeeba\Panopticon\Container;
use Awf\Uri\Uri;
use GuzzleHttp\Client;
use GuzzleHttp\HandlerStack;
use GuzzleHttp\RequestOptions;
use Kevinrob\GuzzleCache\CacheMiddleware;
use Kevinrob\GuzzleCache\KeyValueHttpHeader;
use Kevinrob\GuzzleCache\Storage\Psr6CacheStorage;
use Kevinrob\GuzzleCache\Strategy\GreedyCacheStrategy;
use Kevinrob\GuzzleCache\Strategy\PrivateCacheStrategy;

class HttpFactory
{
	private static $instances = [];

	public function __construct(private Container $container) {}

	/**
	 * Makes a new Guzzle HTTP client instance. All parameters are options.
	 *
	 * @param   HandlerStack|null  $stack          The handler stack to use.
	 * @param   array              $clientOptions  The client options.
	 * @param   bool               $cache          Whether to enable caching.
	 * @param   int|null           $cacheTTL       The cache TTL. Leave NULL to respect HTTP headers.
	 * @param   bool               $singleton      Whether to return a Singleton instance.
	 *
	 * @return  Client  The client instance.
	 */
	public function makeClient(
		?HandlerStack $stack = null,
		array         $clientOptions = [],
		bool          $cache = true,
		?int          $cacheTTL = null,
		bool          $singleton = true
	): Client
	{
		$signature = hash(
			'md5',
			($stack ? serialize($stack) : '*NULL*')
			. '#' .
			(!empty($clientOptions) ? serialize($clientOptions) : '*NULL*')
			. '#' .
			($cache ? 'cache' : 'no-cache')
		);

		if ($singleton && isset(self::$instances[$signature]))
		{
			return self::$instances[$signature];
		}

		$stack ??= HandlerStack::create();

		if ($cache)
		{
			$cachePool = new Psr6CacheStorage(
				$this->container->cacheFactory->pool('http')
			);

			if ($cacheTTL !== null && $cacheTTL > 0)
			{
				$greedyCacheStrategy = new GreedyCacheStrategy(
					$cachePool,
					$cacheTTL,
					new KeyValueHttpHeader(
						['Authorization', 'X-Joomla-Token']
					)
				);

				$stack->push(new CacheMiddleware($greedyCacheStrategy), 'greedy-cache');
			}
			else
			{
				$cacheStrategy = new PrivateCacheStrategy($cachePool);
				$stack->push(new CacheMiddleware($cacheStrategy), 'cache');
			}

		}

		$clientOptions = array_merge($clientOptions + ['handler' => $stack]);

		$client = new Client(
			$clientOptions
		);

		if ($singleton)
		{
			self::$instances[$signature] = $client;
		}

		return $client;
	}

	/**
	 * Get the default request options.
	 *
	 * This currently takes into account the following:
	 * - **Proxy settings** defined in the application configuration
	 * - **SSL CA bundle** defined in the AKEEBA_CACERT_PEM constant in the bootstrap.php file
	 *
	 * @return array
	 */
	public function getDefaultRequestOptions(): array
	{
		$options = [];

		$proxySettings = $this->getProxySettings();

		if (!empty($proxySettings))
		{
			$options[RequestOptions::PROXY] = $proxySettings;
		}

		if (defined('AKEEBA_CACERT_PEM'))
		{
			$options[RequestOptions::VERIFY] = AKEEBA_CACERT_PEM;
		}

		return $options;
	}

	/**
	 * Construct the Guzzle proxy settings based on the application configuration.
	 *
	 * @return array|null The proxy settings; NULL if no proxy is defined and/or requested.
	 * @see https://docs.guzzlephp.org/en/stable/request-options.html#proxy
	 */
	private function getProxySettings(): ?array
	{
		// Get the application configuration variables
		$config  = $this->container->appConfig;
		$enabled = $config->get('proxy_enabled', false);
		$host    = trim($config->get('proxy_host', ''));
		$port    = (int) $config->get('proxy_port', 0);
		$user    = $config->get('proxy_user', '');
		$pass    = $config->get('proxy_pass', '');
		$noProxy = $config->get('proxy_no', '');

		// Are we really enabled and ready to use a proxy server?
		$enabled = $enabled && !empty($host) && is_int($port) && $port > 0 && $port < 65536;

		if (!$enabled)
		{
			return null;
		}

		// Construct the proxy URL out of the individual components
		$proxyUri = new Uri('http://' . $host);
		$proxyUri->setPort($port);

		if (!empty($user) && !empty($pass))
		{
			$proxyUri->setUser($user);
			$proxyUri->setPass($pass);
		}

		$proxyUrl = $proxyUri->toString(['scheme', 'user', 'pass', 'host', 'port']);

		// Get the no proxy domain names
		if (!is_array($noProxy))
		{
			$noProxy = explode(',', $noProxy);
			$noProxy = array_map('trim', $noProxy);
			$noProxy = array_filter($noProxy);
		}

		// Construct and return the Guzzle proxy settings
		$proxySettings = [
			'http'  => $proxyUrl,
			'https' => $proxyUrl,
		];

		if (!empty($noProxy))
		{
			$proxySettings['no'] = $noProxy;
		}

		return $proxySettings;
	}
}