mediawiki-extensions-Templa.../includes/TemplateDataHooks.php

148 lines
4.8 KiB
PHP
Raw Normal View History

<?php
/**
* Hooks for TemplateData extension
*
* @file
* @ingroup Extensions
*/
class TemplateDataHooks {
/**
* Register parser hooks
* @param Parser &$parser
* @return bool
*/
public static function onParserFirstCallInit( &$parser ) {
$parser->setHook( 'templatedata', [ 'TemplateDataHooks', 'render' ] );
return true;
}
/**
* Register qunit unit tests
* @param array &$testModules
* @param ResourceLoader &$resourceLoader
* @return bool
*/
public static function onResourceLoaderTestModules(
array &$testModules,
ResourceLoader &$resourceLoader
) {
$testModules['qunit']['ext.templateData.test'] = [
'scripts' => [ 'tests/ext.templateData.tests.js' ],
'dependencies' => [ 'ext.templateDataGenerator.data' ],
'localBasePath' => dirname( __DIR__ ) ,
'remoteExtPath' => 'TemplateData',
];
return true;
}
/**
* Conditionally register the jquery.uls.data module, in case they've already been
* registered by the UniversalLanguageSelector extension or the VisualEditor extension.
*
* @param ResourceLoader &$resourceLoader
*/
public static function onResourceLoaderRegisterModules( ResourceLoader &$resourceLoader ) {
$resourceModules = $resourceLoader->getConfig()->get( 'ResourceModules' );
$name = 'jquery.uls.data';
if ( !isset( $resourceModules[$name] ) && !$resourceLoader->isModuleRegistered( $name ) ) {
$resourceLoader->register( [
'jquery.uls.data' => [
'localBasePath' => dirname( __DIR__ ),
'remoteExtPath' => 'TemplateData',
'scripts' => [
'lib/jquery.uls/src/jquery.uls.data.js',
'lib/jquery.uls/src/jquery.uls.data.utils.js',
],
'targets' => [ 'desktop', 'mobile' ],
]
] );
}
}
/**
* @param WikiPage &$page
* @param User &$user
* @param Content &$content
* @param string &$summary
* @param bool $minor
* @param bool|null $watchthis
* @param string $sectionanchor
* @param int &$flags
* @param Status &$status
* @return bool
*/
public static function onPageContentSave( WikiPage &$page, &$user, &$content, &$summary, $minor,
$watchthis, $sectionanchor, &$flags, &$status
) {
// The PageContentSave hook provides raw $text, but not $parser because at this stage
// the page is not actually parsed yet. Which means we can't know whether self::render()
// got a valid tag or not. Looking at $text directly is not a solution either as
// it may not be in the current page (it can be transcluded).
// Since there is no later hook that allows aborting the save and showing an error,
// we will have to trigger the parser ourselves.
// Fortunately this causes no overhead since the below (copied from WikiPage::doEditContent,
// right after this hook is ran) has guards that lazy-init and return early if called again
// later by the real WikiPage.
// Specify format the same way the API and EditPage do to avoid extra parsing
$format = $content->getContentHandler()->getDefaultFormat();
$editInfo = $page->prepareContentForEdit( $content, null, $user, $format );
$templateDataStatus = $editInfo->output->getExtensionData( 'TemplateDataStatus' );
if ( $templateDataStatus instanceof Status && !$templateDataStatus->isOK() ) {
// Abort edit, show error message from TemplateDataBlob::getStatus
$status->merge( $templateDataStatus );
return false;
}
return true;
}
/**
* Parser hook registering the GUI module only in edit pages.
*
* @param EditPage $editPage
* @param OutputPage $output
* @return bool
*/
public static function onEditPage( EditPage $editPage, OutputPage $output ) {
global $wgTemplateDataUseGUI;
if ( $wgTemplateDataUseGUI ) {
if ( $output->getTitle()->inNamespace( NS_TEMPLATE ) ) {
$output->addModules( 'ext.templateDataGenerator.editPage' );
}
}
return true;
}
/**
* Parser hook for <templatedata>.
* If there is any JSON provided, render the template documentation on the page.
*
* @param string $input The content of the tag.
* @param array $args The attributes of the tag.
* @param Parser $parser Parser instance available to render
* wikitext into html, or parser methods.
* @param PPFrame $frame Can be used to see what template parameters ("{{{1}}}", etc.)
* this hook was used with.
*
* @return string HTML to insert in the page.
*/
public static function render( $input, $args, $parser, $frame ) {
$ti = TemplateDataBlob::newFromJSON( $input );
$status = $ti->getStatus();
if ( !$status->isOK() ) {
$parser->getOutput()->setExtensionData( 'TemplateDataStatus', $status );
return '<div class="errorbox">' . $status->getHTML() . '</div>';
}
$parser->getOutput()->setProperty( 'templatedata', $ti->getJSONForDatabase() );
$parser->getOutput()->addModuleStyles( 'ext.templateData' );
$parser->enableOOUI();
return $ti->getHtml( $parser->getOptions()->getUserLangObj() );
}
}