aboutsummaryrefslogtreecommitdiffstats
path: root/includes/import
diff options
context:
space:
mode:
authorTim Starling <tstarling@wikimedia.org>2020-03-19 13:42:09 +1100
committerReedy <reedy@wikimedia.org>2020-05-30 14:23:28 +0000
commit68c433bd23bd134883225f03626a94a16fc16bda (patch)
tree85bbc470ac4e40853bb012e04d7a4bda9f5be293 /includes/import
parent2530009b8c1146716f23539925d9c86c620db918 (diff)
downloadmediawikicore-68c433bd23bd134883225f03626a94a16fc16bda.tar.gz
mediawikicore-68c433bd23bd134883225f03626a94a16fc16bda.zip
Hooks::run() call site migration
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
Diffstat (limited to 'includes/import')
-rw-r--r--includes/import/WikiImporter.php30
1 files changed, 13 insertions, 17 deletions
diff --git a/includes/import/WikiImporter.php b/includes/import/WikiImporter.php
index c9d8fd717363..27ffdd3f8449 100644
--- a/includes/import/WikiImporter.php
+++ b/includes/import/WikiImporter.php
@@ -24,6 +24,7 @@
* @ingroup SpecialPage
*/
+use MediaWiki\HookContainer\HookRunner;
use MediaWiki\MediaWikiServices;
/**
@@ -46,6 +47,8 @@ class WikiImporter {
private $config;
/** @var ImportTitleFactory */
private $importTitleFactory;
+ /** @var HookRunner */
+ private $hookRunner;
/** @var array */
private $countableCache = [];
/** @var bool */
@@ -66,6 +69,7 @@ class WikiImporter {
$this->reader = new XMLReader();
$this->config = $config;
+ $this->hookRunner = Hooks::runner();
if ( !in_array( 'uploadsource', stream_get_wrappers() ) ) {
stream_wrapper_register( 'uploadsource', UploadSourceAdapter::class );
@@ -431,8 +435,8 @@ class WikiImporter {
}
}
- return Hooks::run( 'AfterImportPage', [ $title, $foreignTitle, $revCount,
- $sRevCount, $pageInfo ] );
+ return $this->hookRunner->onAfterImportPage( $title, $foreignTitle,
+ $revCount, $sRevCount, $pageInfo );
}
/**
@@ -597,7 +601,7 @@ class WikiImporter {
}
$type = $this->reader->nodeType;
- if ( !Hooks::run( 'ImportHandleToplevelXMLTag', [ $this ] ) ) {
+ if ( !$this->hookRunner->onImportHandleToplevelXMLTag( $this ) ) {
// Do nothing
} elseif ( $tag == 'mediawiki' && $type == XMLReader::END_ELEMENT ) {
break;
@@ -679,9 +683,7 @@ class WikiImporter {
$tag = $this->reader->localName;
- if ( !Hooks::run( 'ImportHandleLogItemXMLTag', [
- $this, $logInfo
- ] ) ) {
+ if ( !$this->hookRunner->onImportHandleLogItemXMLTag( $this, $logInfo ) ) {
// Do nothing
} elseif ( in_array( $tag, $normalFields ) ) {
$logInfo[$tag] = $this->nodeContents();
@@ -740,9 +742,6 @@ class WikiImporter {
return $this->logItemCallback( $revision );
}
- /**
- * @suppress PhanTypeInvalidDimOffset Phan not reading the reference inside the hook
- */
private function handlePage() {
// Handle page data.
$this->debug( "Enter page handler." );
@@ -767,8 +766,7 @@ class WikiImporter {
if ( $badTitle ) {
// The title is invalid, bail out of this page
$skip = true;
- } elseif ( !Hooks::run( 'ImportHandlePageXMLTag', [ $this,
- &$pageInfo ] ) ) {
+ } elseif ( !$this->hookRunner->onImportHandlePageXMLTag( $this, $pageInfo ) ) {
// Do nothing
} elseif ( in_array( $tag, $normalFields ) ) {
// An XML snippet:
@@ -843,9 +841,9 @@ class WikiImporter {
$tag = $this->reader->localName;
- if ( !Hooks::run( 'ImportHandleRevisionXMLTag', [
- $this, $pageInfo, $revisionInfo
- ] ) ) {
+ if ( !$this->hookRunner->onImportHandleRevisionXMLTag(
+ $this, $pageInfo, $revisionInfo )
+ ) {
// Do nothing
} elseif ( in_array( $tag, $normalFields ) ) {
$revisionInfo[$tag] = $this->nodeContents();
@@ -963,9 +961,7 @@ class WikiImporter {
$tag = $this->reader->localName;
- if ( !Hooks::run( 'ImportHandleUploadXMLTag', [
- $this, $pageInfo
- ] ) ) {
+ if ( !$this->hookRunner->onImportHandleUploadXMLTag( $this, $pageInfo ) ) {
// Do nothing
} elseif ( in_array( $tag, $normalFields ) ) {
$uploadInfo[$tag] = $this->nodeContents();