Migrate all callers of Hooks::run() to use the new HookContainer/HookRunner system. General principles: * Use DI if it is already used. We're not changing the way state is managed in this patch. * HookContainer is always injected, not HookRunner. HookContainer is a service, it's a more generic interface, it is the only thing that provides isRegistered() which is needed in some cases, and a HookRunner can be efficiently constructed from it (confirmed by benchmark). Because HookContainer is needed for object construction, it is also needed by all factories. * "Ask your friendly local base class". Big hierarchies like SpecialPage and ApiBase have getHookContainer() and getHookRunner() methods in the base class, and classes that extend that base class are not expected to know or care where the base class gets its HookContainer from. * ProtectedHookAccessorTrait provides protected getHookContainer() and getHookRunner() methods, getting them from the global service container. The point of this is to ease migration to DI by ensuring that call sites ask their local friendly base class rather than getting a HookRunner from the service container directly. * Private $this->hookRunner. In some smaller classes where accessor methods did not seem warranted, there is a private HookRunner property which is accessed directly. Very rarely (two cases), there is a protected property, for consistency with code that conventionally assumes protected=private, but in cases where the class might actually be overridden, a protected accessor is preferred over a protected property. * The last resort: Hooks::runner(). Mostly for static, file-scope and global code. In a few cases it was used for objects with broken construction schemes, out of horror or laziness. Constructors with new required arguments: * AuthManager * BadFileLookup * BlockManager * ClassicInterwikiLookup * ContentHandlerFactory * ContentSecurityPolicy * DefaultOptionsManager * DerivedPageDataUpdater * FullSearchResultWidget * HtmlCacheUpdater * LanguageFactory * LanguageNameUtils * LinkRenderer * LinkRendererFactory * LocalisationCache * MagicWordFactory * MessageCache * NamespaceInfo * PageEditStash * PageHandlerFactory * PageUpdater * ParserFactory * PermissionManager * RevisionStore * RevisionStoreFactory * SearchEngineConfig * SearchEngineFactory * SearchFormWidget * SearchNearMatcher * SessionBackend * SpecialPageFactory * UserNameUtils * UserOptionsManager * WatchedItemQueryService * WatchedItemStore Constructors with new optional arguments: * DefaultPreferencesFactory * Language * LinkHolderArray * MovePage * Parser * ParserCache * PasswordReset * Router setHookContainer() now required after construction: * AuthenticationProvider * ResourceLoaderModule * SearchEngine Change-Id: Id442b0dbe43aba84bd5cf801d86dedc768b082c7
181 lines
4.4 KiB
PHP
181 lines
4.4 KiB
PHP
<?php
|
|
|
|
namespace MediaWiki\Rest;
|
|
|
|
use ExtensionRegistry;
|
|
use IContextSource;
|
|
use MediaWiki;
|
|
use MediaWiki\MediaWikiServices;
|
|
use MediaWiki\Rest\BasicAccess\MWBasicAuthorizer;
|
|
use MediaWiki\Rest\Validator\Validator;
|
|
use RequestContext;
|
|
use Title;
|
|
use WebResponse;
|
|
use Wikimedia\Message\ITextFormatter;
|
|
|
|
class EntryPoint {
|
|
/** @var RequestInterface */
|
|
private $request;
|
|
/** @var WebResponse */
|
|
private $webResponse;
|
|
/** @var Router */
|
|
private $router;
|
|
/** @var RequestContext */
|
|
private $context;
|
|
|
|
/**
|
|
* @param IContextSource $context
|
|
* @param RequestInterface $request
|
|
* @return Router
|
|
*/
|
|
private static function createRouter(
|
|
IContextSource $context, RequestInterface $request
|
|
): Router {
|
|
global $IP;
|
|
|
|
$services = MediaWikiServices::getInstance();
|
|
$conf = $services->getMainConfig();
|
|
|
|
$responseFactory = new ResponseFactory( self::getTextFormatters( $services ) );
|
|
|
|
$authorizer = new MWBasicAuthorizer( $context->getUser(),
|
|
$services->getPermissionManager() );
|
|
|
|
$objectFactory = $services->getObjectFactory();
|
|
$restValidator = new Validator( $objectFactory,
|
|
$services->getPermissionManager(),
|
|
$request,
|
|
RequestContext::getMain()->getUser()
|
|
);
|
|
|
|
// Always include the "official" routes. Include additional routes if specified.
|
|
$routeFiles = array_merge(
|
|
[ 'includes/Rest/coreRoutes.json' ],
|
|
$conf->get( 'RestAPIAdditionalRouteFiles' )
|
|
);
|
|
array_walk( $routeFiles, function ( &$val, $key ) {
|
|
global $IP;
|
|
$val = "$IP/$val";
|
|
} );
|
|
|
|
return new Router(
|
|
$routeFiles,
|
|
ExtensionRegistry::getInstance()->getAttribute( 'RestRoutes' ),
|
|
$conf->get( 'CanonicalServer' ),
|
|
$conf->get( 'RestPath' ),
|
|
$services->getLocalServerObjectCache(),
|
|
$responseFactory,
|
|
$authorizer,
|
|
$objectFactory,
|
|
$restValidator,
|
|
$services->getHookContainer()
|
|
);
|
|
}
|
|
|
|
public static function main() {
|
|
// URL safety checks
|
|
global $wgRequest;
|
|
|
|
$context = RequestContext::getMain();
|
|
|
|
// Set $wgTitle and the title in RequestContext, as in api.php
|
|
global $wgTitle;
|
|
$wgTitle = Title::makeTitle( NS_SPECIAL, 'Badtitle/rest.php' );
|
|
$context->setTitle( $wgTitle );
|
|
|
|
$services = MediaWikiServices::getInstance();
|
|
$conf = $services->getMainConfig();
|
|
|
|
if ( !$conf->get( 'EnableRestAPI' ) ) {
|
|
wfHttpError( 403, 'Access Denied',
|
|
'Set $wgEnableRestAPI to true to enable the experimental REST API' );
|
|
return;
|
|
}
|
|
|
|
$request = new RequestFromGlobals( [
|
|
'cookiePrefix' => $conf->get( 'CookiePrefix' )
|
|
] );
|
|
|
|
$router = self::createRouter( $context, $request );
|
|
|
|
$entryPoint = new self(
|
|
$context,
|
|
$request,
|
|
$wgRequest->response(),
|
|
$router );
|
|
$entryPoint->execute();
|
|
}
|
|
|
|
/**
|
|
* Get a TextFormatter array from MediaWikiServices
|
|
*
|
|
* @param MediaWikiServices $services
|
|
* @return ITextFormatter[]
|
|
*/
|
|
public static function getTextFormatters( MediaWikiServices $services ) {
|
|
$langs = array_unique( [
|
|
$services->getMainConfig()->get( 'ContLang' )->getCode(),
|
|
'en'
|
|
] );
|
|
$textFormatters = [];
|
|
$factory = $services->getMessageFormatterFactory();
|
|
foreach ( $langs as $lang ) {
|
|
$textFormatters[] = $factory->getTextFormatter( $lang );
|
|
}
|
|
return $textFormatters;
|
|
}
|
|
|
|
public function __construct( RequestContext $context, RequestInterface $request,
|
|
WebResponse $webResponse, Router $router
|
|
) {
|
|
$this->context = $context;
|
|
$this->request = $request;
|
|
$this->webResponse = $webResponse;
|
|
$this->router = $router;
|
|
}
|
|
|
|
public function execute() {
|
|
ob_start();
|
|
$response = $this->router->execute( $this->request );
|
|
|
|
$this->webResponse->header(
|
|
'HTTP/' . $response->getProtocolVersion() . ' ' .
|
|
$response->getStatusCode() . ' ' .
|
|
$response->getReasonPhrase() );
|
|
|
|
foreach ( $response->getRawHeaderLines() as $line ) {
|
|
$this->webResponse->header( $line );
|
|
}
|
|
|
|
foreach ( $response->getCookies() as $cookie ) {
|
|
$this->webResponse->setCookie(
|
|
$cookie['name'],
|
|
$cookie['value'],
|
|
$cookie['expiry'],
|
|
$cookie['options'] );
|
|
}
|
|
|
|
// Clear all errors that might have been displayed if display_errors=On
|
|
ob_end_clean();
|
|
|
|
$stream = $response->getBody();
|
|
$stream->rewind();
|
|
|
|
MediaWiki::preOutputCommit( $this->context );
|
|
|
|
if ( $stream instanceof CopyableStreamInterface ) {
|
|
$stream->copyToStream( fopen( 'php://output', 'w' ) );
|
|
} else {
|
|
while ( true ) {
|
|
$buffer = $stream->read( 65536 );
|
|
if ( $buffer === '' ) {
|
|
break;
|
|
}
|
|
echo $buffer;
|
|
}
|
|
}
|
|
|
|
$mw = new MediaWiki;
|
|
$mw->doPostOutputShutdown();
|
|
}
|
|
}
|