0be1887f2d
* Add FileBackend::addShellboxInputFile(), allowing Shellbox to read directly from a FileBackend. Add generic, FS and Swift implementations. * Add FileRepo wrapper, which takes a FileRepo virtual URL. * Add File::addToShellboxCommand(), which allows a File to be used as input in a Shellbox command. * Add configuration. * Extend FileBackend::getFileHttpUrl(), adding method and ipRange parameters. Unindent existing code. I was going to add support for PUT requests, but I reverted it due to the impossibility of supporting FileBackendMultiWrite. I left the method parameter in getFileHttpUrl(). Bug: T292322 Change-Id: If9487a0c9586065bf044b69ac04cc7a06b6e8856 (cherry picked from commit 8cdde9dcb03e33332e49aed06aa71b60ae2c9b33)
122 lines
3.6 KiB
PHP
122 lines
3.6 KiB
PHP
<?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;
|
|
}
|
|
|
|
}
|