MakeGlobalVariablesScript hook.
*
* Sets the value of the wgRelatedArticles global variable
* to the list of related articles in the cached parser output.
*
* @param array &$vars variables to be added into the output of OutputPage::headElement.
* @param OutputPage $out OutputPage instance calling the hook
* @return bool Always true
*/
public static function onMakeGlobalVariablesScript( &$vars, OutputPage $out ) {
$config = MediaWikiServices::getInstance()->getConfigFactory()
->makeConfig( 'RelatedArticles' );
$vars['wgRelatedArticles'] = $out->getProperty( 'RelatedArticles' );
$vars['wgRelatedArticlesUseCirrusSearch'] = $config->get( 'RelatedArticlesUseCirrusSearch' );
$vars['wgRelatedArticlesOnlyUseCirrusSearch'] =
$config->get( 'RelatedArticlesOnlyUseCirrusSearch' );
return true;
}
/**
* Uses the Disambiguator extension to test whether the page is a disambiguation page.
*
* If the Disambiguator extension isn't installed, then the test always fails, i.e. the page is
* never a disambiguation page.
*
* @return boolean
*/
private static function isDisambiguationPage( Title $title ) {
return \ExtensionRegistry::getInstance()->isLoaded( 'Disambiguator' ) &&
DisambiguatorHooks::isDisambiguationPage( $title );
}
/**
* Check whether the output page is a diff page
*
* @param OutputPage $out
* @return bool
*/
private static function isDiffPage( OutputPage $out ) {
$request = $out->getRequest();
$type = $request->getText( 'type' );
$diff = $request->getText( 'diff' );
$oldId = $request->getText( 'oldid' );
$isSpecialMobileDiff = $out->getTitle()->isSpecial( 'MobileDiff' );
return $type === 'revision' || $diff || $oldId || $isSpecialMobileDiff;
}
/**
* Is ReadMore allowed on skin?
*
* The feature is allowed on all skins as long as they are whitelisted
* in the configuration variable `RelatedArticlesFooterWhitelistedSkins`.
*
* @param User $user
* @param Skin $skin
* @return bool
*/
private static function isReadMoreAllowedOnSkin( User $user, Skin $skin ) {
$config = MediaWikiServices::getInstance()->getConfigFactory()
->makeConfig( 'RelatedArticles' );
$skins = $config->get( 'RelatedArticlesFooterWhitelistedSkins' );
$skinName = $skin->getSkinName();
return in_array( $skinName, $skins );
}
/**
* Handler for the BeforePageDisplay hook.
*
* Adds the ext.relatedArticles.readMore.bootstrap module
* to the output when:
*
*
* - On mobile, the output is being rendered with
*
SkinMinervaBeta
* - The page is in mainspace
* - The action is 'view'
* - The page is not the Main Page
* - The page is not a disambiguation page
* - The page is not a diff page
* - The feature is allowed on the skin (see isReadMoreAllowedOnSkin() above)
*
*
* @param OutputPage $out The OutputPage object
* @param Skin $skin Skin object that will be used to generate the page
* @return bool Always true
*/
public static function onBeforePageDisplay( OutputPage $out, Skin $skin ) {
$title = $out->getContext()->getTitle();
$action = $out->getRequest()->getText( 'action', 'view' );
if (
$title->inNamespace( NS_MAIN ) &&
// T120735
$action === 'view' &&
!$title->isMainPage() &&
!self::isDisambiguationPage( $title ) &&
!self::isDiffPage( $out ) &&
self::isReadMoreAllowedOnSkin( $out->getUser(), $skin )
) {
$out->addModules( [ 'ext.relatedArticles.readMore.bootstrap' ] );
}
return true;
}
/**
* ResourceLoaderGetConfigVars hook handler for setting a config variable
* @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderGetConfigVars
*
* @param array &$vars Array of variables to be added into the output of the startup module.
* @return bool
*/
public static function onResourceLoaderGetConfigVars( &$vars ) {
$config = MediaWikiServices::getInstance()->getConfigFactory()
->makeConfig( 'RelatedArticles' );
$vars['wgRelatedArticlesLoggingBucketSize'] =
$config->get( 'RelatedArticlesLoggingBucketSize' );
$vars['wgRelatedArticlesEnabledBucketSize']
= $config->get( 'RelatedArticlesEnabledBucketSize' );
$limit = $config->get( 'RelatedArticlesCardLimit' );
$vars['wgRelatedArticlesCardLimit'] = $limit;
if ( $limit < 1 || $limit > 20 ) {
throw new \RuntimeException(
'The value of wgRelatedArticlesCardLimit is not valid. It should be between 1 and 20.'
);
}
return true;
}
/**
* Register the "ext.relatedArticles.readMore.eventLogging" 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 bool
*/
public static function onResourceLoaderRegisterModules( ResourceLoader &$resourceLoader ) {
$dependencies = [];
$scripts = [];
if ( class_exists( 'EventLogging' ) ) {
$dependencies[] = "mediawiki.user";
$dependencies[] = "mediawiki.viewport";
$dependencies[] = "ext.eventLogging.subscriber";
$dependencies[] = "mediawiki.experiments";
$scripts[] = "resources/ext.relatedArticles.readMore.eventLogging/index.js";
}
$resourceLoader->register(
"ext.relatedArticles.readMore.eventLogging",
[
"dependencies" => $dependencies,
"scripts" => $scripts,
"targets" => [
"desktop",
"mobile"
],
"localBasePath" => __DIR__ . "/..",
"remoteExtPath" => "RelatedArticles"
]
);
return true;
}
/**
* Handler for the ParserFirstCallInit hook.
*
* Registers the related parser function (see
* {@see Hooks::onFuncRelated}).
*
* @param Parser &$parser Parser object
* @return bool Always true
*/
public static function onParserFirstCallInit( Parser &$parser ) {
$parser->setFunctionHook( 'related', 'RelatedArticles\\Hooks::onFuncRelated' );
return true;
}
/**
* The related parser function.
*
* Appends the arguments to the internal list so that it can be used
* more that once per page.
* We don't use setProperty here is there is no need
* to store it as a page prop in the database, only in the cache.
*
* @todo Test for uniqueness
* @param Parser $parser Parser object
*
* @return string Always ''
*/
public static function onFuncRelated( Parser $parser ) {
$parserOutput = $parser->getOutput();
$relatedPages = $parserOutput->getExtensionData( 'RelatedArticles' );
if ( !$relatedPages ) {
$relatedPages = [];
}
$args = func_get_args();
array_shift( $args );
// Add all the related pages passed by the parser function
// {{#related:Test with read more|Foo|Bar}}
foreach ( $args as $relatedPage ) {
$relatedPages[] = $relatedPage;
}
$parserOutput->setExtensionData( 'RelatedArticles', $relatedPages );
return '';
}
/**
* Passes the related pages list from the cached parser output
* object to the output page for rendering.
*
* The list of related pages will be retrieved using
* ParserOutput#getExtensionData.
*
* @param OutputPage &$out the OutputPage object
* @param ParserOutput $parserOutput ParserOutput object
* @return bool Always true
*/
public static function onOutputPageParserOutput( OutputPage &$out, ParserOutput $parserOutput ) {
$related = $parserOutput->getExtensionData( 'RelatedArticles' );
if ( $related ) {
$out->setProperty( 'RelatedArticles', $related );
}
return true;
}
/**
* Register QUnit tests.
* @see https://www.mediawiki.org/wiki/Manual:Hooks/ResourceLoaderTestModules
*
* @param array &$modules array of javascript testing modules
* @param \ResourceLoader &$rl Resource Loader
* @return bool
*/
public static function onResourceLoaderTestModules( &$modules, &$rl ) {
$boilerplate = [
'localBasePath' => __DIR__ . '/../tests/qunit/',
'remoteExtPath' => 'RelatedArticles/tests/qunit',
'targets' => [ 'desktop', 'mobile' ],
];
$modules['qunit']['ext.relatedArticles.cards.tests'] = $boilerplate + [
'dependencies' => [
'ext.relatedArticles.cards'
],
'scripts' => [
'ext.relatedArticles.cards/CardModel.js',
'ext.relatedArticles.cards/CardView.js',
]
];
$modules['qunit']['ext.relatedArticles.readMore.gateway.tests'] = $boilerplate + [
'scripts' => [
'ext.relatedArticles.readMore.gateway/test_RelatedPagesGateway.js',
],
'dependencies' => [
'ext.relatedArticles.readMore.gateway',
],
];
return true;
}
}