Page MenuHomeWickedGov Phorge
Files F5983251

ShellboxClientFactory.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

ShellboxClientFactory.php
View Options

<?php
namespace MediaWiki\Shell;
use GuzzleHttp\Psr7\Uri;
use GuzzleHttp\RequestOptions;
use MediaWiki\Http\HttpRequestFactory;
use RuntimeException;
use Shellbox\Client;
use Shellbox\RPC\LocalRpcClient;
use Shellbox\RPC\RpcClient;
/**
* This is a service which provides a configured client to access a remote
* Shellbox installation.
*
* @since 1.36
*/
class ShellboxClientFactory {
/** @var HttpRequestFactory */
private $requestFactory;
/** @var (string|false|null)[]|null */
private $urls;
/** @var string|null */
private $key;
/** The default request timeout, in seconds */
public const DEFAULT_TIMEOUT = 10;
/**
* @internal Use MediaWikiServices::getShellboxClientFactory()
* @param HttpRequestFactory $requestFactory The factory which will be used
* to make HTTP clients.
* @param (string|false|null)[]|null $urls The Shellbox base URL mapping
* @param string|null $key The shared secret key used for HMAC authentication
*/
public function __construct( HttpRequestFactory $requestFactory, $urls, $key ) {
$this->requestFactory = $requestFactory;
$this->urls = $urls;
$this->key = $key;
}
/**
* Test whether remote Shellbox is enabled by configuration.
*
* @param string|null $service Same as the service option for getClient.
* @return bool
*/
public function isEnabled( ?string $service = null ): bool {
return $this->getUrl( $service ) !== null;
}
/**
* Get a Shellbox client with the specified options. If remote Shellbox is
* not configured (isEnabled() returns false), an exception will be thrown.
*
* @param array $options Associative array of options:
* - timeout: The request timeout in seconds
* - service: the shellbox backend name to get the URL from the mapping
* @return Client
* @throws RuntimeException
*/
public function getClient( array $options = [] ) {
$url = $this->getUrl( $options['service'] ?? null );
if ( $url === null ) {
throw new RuntimeException( 'To use a remote shellbox to run shell commands, ' .
'$wgShellboxUrls and $wgShellboxSecretKey must be configured.' );
}
return new Client(
$this->requestFactory->createGuzzleClient( [
RequestOptions::TIMEOUT => $options['timeout'] ?? self::DEFAULT_TIMEOUT,
RequestOptions::HTTP_ERRORS => false,
] ),
new Uri( $url ),
$this->key,
[ 'allowUrlFiles' => true ]
);
}
/**
* Get a Shellbox RPC client with the specified options. If remote Shellbox is
* not configured (isEnabled() returns false), an exception will be thrown.
*
* @param array $options Associative array of options:
* - timeout: The request timeout in seconds
* - service: the shellbox backend name to get the URL from the mapping
* @return RpcClient
* @throws RuntimeException
*/
public function getRemoteRpcClient( array $options = [] ): RpcClient {
return $this->getClient( $options );
}
/**
* Get a Shellbox RPC client with specified options. If remote Shellbox is
* not configured (isEnabled() returns false), a local fallback is returned.
*
* @param array $options
* @return RpcClient
*/
public function getRpcClient( array $options = [] ): RpcClient {
$url = $this->getUrl( $options['service'] ?? null );
if ( $url === null ) {
return new LocalRpcClient();
}
return $this->getRemoteRpcClient( $options );
}
private function getUrl( ?string $service ): ?string {
if ( $this->urls === null || $this->key === null || $this->key === '' ) {
return null;
}
// @phan-suppress-next-line PhanTypeMismatchDimFetchNullable False positive
$url = $this->urls[$service] ?? $this->urls['default'] ?? null;
if ( !is_string( $url ) ) {
return null;
}
return $url;
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, Oct 3, 22:47 (1 w, 5 d ago)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
27/12/e68b59b7c26a76b3cd6726b6d39e
Default Alt Text
ShellboxClientFactory.php (3 KB)

Event Timeline