mediawiki-extensions-RelatedArticles/includes/FooterHooks.php

<?php

namespace RelatedArticles;

use BetaFeatures;
use OutputPage;
use ResourceLoader;
use Skin;
use ConfigFactory;
use User;
use DisambiguatorHooks;

class FooterHooks {

	/**
	 * Handler for the <code>MakeGlobalVariablesScript</code> hook.
	 *
	 * Sets the value of the <code>wgRelatedArticles</code> global variable
	 * to the list of related articles in the cached parser output.
	 *
	 * @param array $vars
	 * @param OutputPage $out
	 * @return boolean Always <code>true</code>
	 */
	public static function onMakeGlobalVariablesScript( &$vars, OutputPage $out ) {
		$config = ConfigFactory::getDefaultInstance()->makeConfig( 'RelatedArticles' );

		$vars['wgRelatedArticles'] = $out->getProperty( 'RelatedArticles' );

		$vars['wgRelatedArticlesUseCirrusSearch'] = $config->get( 'RelatedArticlesUseCirrusSearch' );
		$vars['wgRelatedArticlesOnlyUseCirrusSearch'] =
			$config->get( 'RelatedArticlesOnlyUseCirrusSearch' );

		return true;
	}

	/**
	 * Handler for the <code>BeforePageDisplay</code> hook.
	 *
	 * Adds the <code>ext.relatedArticles.readMore.bootstrap</code> module
	 * to the output when:
	 *
	 * <ol>
	 *   <li>The page is not a disambiguation page</li>
	 *   <li><code>$wgRelatedArticlesShowInFooter</code> is truthy</li>
	 *   <li>On mobile, the output is being rendered with
	 *     <code>SkinMinervaBeta<code></li>
	 *   <li>On desktop, the beta feature has been enabled</li>
	 *   <li>The page is in mainspace</li>
	 * </ol>
	 *
	 * @param OutputPage $out
	 * @param Skin $skin
	 * @return boolean Always <code>true</code>
	 */
	public static function onBeforePageDisplay( OutputPage $out, Skin $skin ) {
		if ( class_exists( 'DisambiguatorHooks' ) &&
			DisambiguatorHooks::isDisambiguationPage( $out->getTitle() ) ) {
			return true;
		}
		$config = ConfigFactory::getDefaultInstance()->makeConfig( 'RelatedArticles' );
		$showReadMore = $config->get( 'RelatedArticlesShowInFooter' );

		$title = $out->getContext()->getTitle();

		if (
			$showReadMore &&
			$title->inNamespace( NS_MAIN ) &&
			!$title->isMainPage()
		) {
			if (
				get_class( $skin ) === 'SkinMinervaBeta' ||
				(
					class_exists( 'BetaFeatures' ) &&
					BetaFeatures::isFeatureEnabled( $out->getUser(), 'read-more' )
				)
			) {
				$out->addModules( [ 'ext.relatedArticles.readMore.bootstrap' ] );
			}
		}

		return true;
	}

	/**
	 * EventLoggingRegisterSchemas hook handler.
	 *
	 * Registers our EventLogging schemas so that they can be converted to
	 * ResourceLoaderSchemaModules by the EventLogging extension.
	 *
	 * If the module has already been registered in
	 * onResourceLoaderRegisterModules, then it is overwritten.
	 *
	 * @param array $schemas The schemas currently registered with the EventLogging
	 *  extension
	 * @return bool Always true
	 */
	public static function onEventLoggingRegisterSchemas( &$schemas ) {
		// @see https://meta.wikimedia.org/wiki/Schema:RelatedArticles
		$schemas['RelatedArticles'] = 14496900;

		return true;
	}

	/**
	 * ResourceLoaderGetConfigVars hook handler for setting a config variable
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderGetConfigVars
	 *
	 * @param array $vars
	 * @return boolean
	 */
	public static function onResourceLoaderGetConfigVars( &$vars ) {
		$config = ConfigFactory::getDefaultInstance()->makeConfig( 'RelatedArticles' );
		$vars['wgRelatedArticlesLoggingSamplingRate'] =
			$config->get( 'RelatedArticlesLoggingSamplingRate' );

		return true;
	}

	/**
	 * Register the "ext.relatedArticles.readMore" module.
	 * Optionally update the dependencies and scripts if EventLogging is installed.
	 *
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderRegisterModules
	 *
	 * @param ResourceLoader &$resourceLoader The ResourceLoader object
	 * @return boolean
	 */
	public static function onResourceLoaderRegisterModules( ResourceLoader &$resourceLoader ) {
		$dependencies = [
			"mediawiki.user",
			"mediawiki.util"
		];
		$scripts = [
			"resources/ext.relatedArticles.readMore/index.js"
		];

		if ( class_exists( 'EventLogging' ) ) {
			$dependencies[] = "mediawiki.viewport";
			$dependencies[] = "ext.eventLogging.Schema";
			$scripts[] = "resources/ext.relatedArticles.readMore/eventLogging.js";
		}

		$resourceLoader->register(
			"ext.relatedArticles.readMore",
			[
				"dependencies" => $dependencies,
				"scripts" => $scripts,
				"styles" => [
					"resources/ext.relatedArticles.readMore/readMore.less"
				],
				"skinStyles" => [
					"default" => "resources/ext.relatedArticles.readMore/readMore.default.less",
					"monobook" => [
						"resources/ext.relatedArticles.readMore/readMore.default.less",
						"resources/ext.relatedArticles.readMore/readMore.monobook.less"
					],
					"minerva" => "resources/ext.relatedArticles.readMore/readMore.minerva.less"
				],
				"messages" => [
					"relatedarticles-read-more-heading"
				],
				"targets" => [
					"desktop",
					"mobile"
				],
				"localBasePath" => __DIR__ . "/..",
				"remoteExtPath" => "RelatedArticles"
			]
		);

		return true;
	}

	/**
	 * GetBetaFeaturePreferences hook handler
	 * The beta feature is for showing ReadMore, not for showing related
	 * articles in the sidebar.
	 * @see https://www.mediawiki.org/wiki/Manual:Hooks/GetBetaFeaturePreferences
	 *
	 * @param User $user
	 * @param array $preferences
	 *
	 * @return bool
	 */
	public static function onGetBetaFeaturePreferences( User $user, array &$preferences ) {
		$config = ConfigFactory::getDefaultInstance()->makeConfig( 'RelatedArticles' );
		$showReadMore = $config->get( 'RelatedArticlesShowInFooter' );

		if ( $showReadMore ) {
			$wgExtensionAssetsPath = $config->get( 'ExtensionAssetsPath' );

			$preferences['read-more'] = [
				'label-message' => 'relatedarticles-read-more-beta-feature-title',
				'desc-message' => 'relatedarticles-read-more-beta-feature-description',
				'screenshot' => [
					'ltr' => "$wgExtensionAssetsPath/RelatedArticles/images/BetaFeatures/wb-readmore-beta-ltr.svg",
					'rtl' => "$wgExtensionAssetsPath/RelatedArticles/images/BetaFeatures/wb-readmore-beta-rtl.svg",
				],
				'info-link' => 'https://www.mediawiki.org/wiki/Reading/Web/Projects/Read_more',
				'discussion-link' => 'https://www.mediawiki.org/wiki/Talk:Reading/Web/Projects/Read_more',
			];

		}

		return true;
	}

}