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

5 files changed, 61 insertions, 8 deletions

diff --git a/includes/resourceloader/ResourceLoader.php b/includes/resourceloader/ResourceLoader.php
index defa97eb499a..4f128563a346 100644
--- a/includes/resourceloader/ResourceLoader.php
+++ b/includes/resourceloader/ResourceLoader.php
@@ -21,6 +21,8 @@
  */
 
 use MediaWiki\HeaderCallback;
+use MediaWiki\HookContainer\HookContainer;
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerInterface;
@@ -62,6 +64,12 @@ class ResourceLoader implements LoggerAwareInterface {
 	/** @var LoggerInterface */
 	private $logger;
 
+	/** @var HookContainer */
+	private $hookContainer;
+
+	/** @var HookRunner */
+	private $hookRunner;
+
 	/** @var ResourceLoaderModule[] Map of (module name => ResourceLoaderModule) */
 	protected $modules = [];
 	/** @var array[] Map of (module name => associative info array) */
@@ -244,6 +252,9 @@ class ResourceLoader implements LoggerAwareInterface {
 		}
 		$this->config = $config;
 
+		$this->hookContainer = $services->getHookContainer();
+		$this->hookRunner = new HookRunner( $this->hookContainer );
+
 		// Add 'local' source first
 		$this->addSource( 'local', $config->get( 'LoadScript' ) );
 
@@ -404,10 +415,7 @@ class ResourceLoader implements LoggerAwareInterface {
 		// This has a 'qunit' key for compat with the below hook.
 		$testModulesMeta = [ 'qunit' => [] ];
 
-		// Get test suites from extensions
-		// Avoid PHP 7.1 warning from passing $this by reference
-		$rl = $this;
-		Hooks::run( 'ResourceLoaderTestModules', [ &$testModulesMeta, &$rl ] );
+		$this->hookRunner->onResourceLoaderTestModules( $testModulesMeta, $this );
 		$extRegistry = ExtensionRegistry::getInstance();
 		// In case of conflict, the deprecated hook has precedence.
 		$testModules = $testModulesMeta['qunit']
@@ -527,6 +535,7 @@ class ResourceLoader implements LoggerAwareInterface {
 			}
 			$object->setConfig( $this->getConfig() );
 			$object->setLogger( $this->logger );
+			$object->setHookContainer( $this->hookContainer );
 			$object->setName( $name );
 			$object->setDependencyAccessCallbacks(
 				[ $this, 'loadModuleDependenciesInternal' ],
@@ -2002,7 +2011,7 @@ MESSAGE;
 			'wgEnableUploads' => $conf->get( 'EnableUploads' ),
 		];
 
-		Hooks::run( 'ResourceLoaderGetConfigVars', [ &$vars, $skin, $conf ] );
+		Hooks::runner()->onResourceLoaderGetConfigVars( $vars, $skin, $conf );
 
 		return $vars;
 	}
diff --git a/includes/resourceloader/ResourceLoaderForeignApiModule.php b/includes/resourceloader/ResourceLoaderForeignApiModule.php
index 152a1f706149..195a55d13cd6 100644
--- a/includes/resourceloader/ResourceLoaderForeignApiModule.php
+++ b/includes/resourceloader/ResourceLoaderForeignApiModule.php
@@ -28,7 +28,7 @@
 class ResourceLoaderForeignApiModule extends ResourceLoaderFileModule {
 	public function getDependencies( ResourceLoaderContext $context = null ) {
 		$dependencies = $this->dependencies;
-		Hooks::run( 'ResourceLoaderForeignApiModules', [ &$dependencies, $context ] );
+		$this->getHookRunner()->onResourceLoaderForeignApiModules( $dependencies, $context );
 		return $dependencies;
 	}
 }
diff --git a/includes/resourceloader/ResourceLoaderModule.php b/includes/resourceloader/ResourceLoaderModule.php
index 2fc3f52de906..4cb6209d159f 100644
--- a/includes/resourceloader/ResourceLoaderModule.php
+++ b/includes/resourceloader/ResourceLoaderModule.php
@@ -20,6 +20,8 @@
  * @author Roan Kattouw
  */
 
+use MediaWiki\HookContainer\HookContainer;
+use MediaWiki\HookContainer\HookRunner;
 use MediaWiki\MediaWikiServices;
 use Psr\Log\LoggerAwareInterface;
 use Psr\Log\LoggerInterface;
@@ -70,6 +72,16 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
 	/** @var string|bool Deprecation string or true if deprecated; false otherwise */
 	protected $deprecated = false;
 
+	/**
+	 * @var HookContainer|null
+	 */
+	private $hookContainer;
+
+	/**
+	 * @var HookRunner|null
+	 */
+	private $hookRunner;
+
 	/** @var string Scripts only */
 	public const TYPE_SCRIPTS = 'scripts';
 	/** @var string Styles only */
@@ -244,6 +256,38 @@ abstract class ResourceLoaderModule implements LoggerAwareInterface {
 	}
 
 	/**
+	 * @since 1.35
+	 * @internal
+	 * @param HookContainer $hookContainer
+	 */
+	public function setHookContainer( HookContainer $hookContainer ) {
+		$this->hookContainer = $hookContainer;
+		$this->hookRunner = new HookRunner( $hookContainer );
+	}
+
+	/**
+	 * Get a HookContainer, for running extension hooks or for hook metadata.
+	 *
+	 * @since 1.35
+	 * @return HookContainer
+	 */
+	protected function getHookContainer() : HookContainer {
+		return $this->hookContainer;
+	}
+
+	/**
+	 * Get a HookRunner for running core hooks.
+	 *
+	 * @internal This is for use by core only. Hook interfaces may be removed
+	 *   without notice.
+	 * @since 1.35
+	 * @return HookRunner
+	 */
+	protected function getHookRunner() : HookRunner {
+		return $this->hookRunner;
+	}
+
+	/**
 	 * Get the URL or URLs to load for this module's JS in debug mode.
 	 * The default behavior is to return a load.php?only=scripts URL for
 	 * the module, but file-based modules will want to override this to
diff --git a/includes/resourceloader/ResourceLoaderSiteModule.php b/includes/resourceloader/ResourceLoaderSiteModule.php
index e04901c3efbd..292ea354664d 100644
--- a/includes/resourceloader/ResourceLoaderSiteModule.php
+++ b/includes/resourceloader/ResourceLoaderSiteModule.php
@@ -42,7 +42,7 @@ class ResourceLoaderSiteModule extends ResourceLoaderWikiModule {
 			$skin = $context->getSkin();
 			$pages['MediaWiki:Common.js'] = [ 'type' => 'script' ];
 			$pages['MediaWiki:' . ucfirst( $skin ) . '.js'] = [ 'type' => 'script' ];
-			Hooks::run( 'ResourceLoaderSiteModulePages', [ $skin, &$pages ] );
+			$this->getHookRunner()->onResourceLoaderSiteModulePages( $skin, $pages );
 		}
 		return $pages;
 	}
diff --git a/includes/resourceloader/ResourceLoaderSiteStylesModule.php b/includes/resourceloader/ResourceLoaderSiteStylesModule.php
index 82ecadd3a75c..5a89f2e53755 100644
--- a/includes/resourceloader/ResourceLoaderSiteStylesModule.php
+++ b/includes/resourceloader/ResourceLoaderSiteStylesModule.php
@@ -43,7 +43,7 @@ class ResourceLoaderSiteStylesModule extends ResourceLoaderWikiModule {
 			$pages['MediaWiki:Common.css'] = [ 'type' => 'style' ];
 			$pages['MediaWiki:' . ucfirst( $skin ) . '.css'] = [ 'type' => 'style' ];
 			$pages['MediaWiki:Print.css'] = [ 'type' => 'style', 'media' => 'print' ];
-			Hooks::run( 'ResourceLoaderSiteStylesModulePages', [ $skin, &$pages ] );
+			$this->getHookRunner()->onResourceLoaderSiteStylesModulePages( $skin, $pages );
 		}
 		return $pages;
 	}