mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/TemplateData
synced 2024-11-12 01:09:40 +00:00
d66b4c6090
We only have 65535 bytes, let's use them wisely. Prior to Ib2db241a in core (1.22wmf12) even binary page properties were sometimes shown as plaintext (e.g. on Special:PagesWithProp). Thus this introduces a "soft dependency" on that change. No backwards-incompatible changes were made in public methods. Added two new ones: * Add TemplateDataBlob#getJSONForDatabase which returns compressed JSON, use it where applicable. * Add TemplateDataBlob::newFromDatabase which accept compressed and uncompressed JSON, use it where applicable. Use a long pseudorandom string in the test. Bug: 51740 Change-Id: Ie66b0dd6b6dab6f8648e78595c41e52d9c704d57
95 lines
2.9 KiB
PHP
95 lines
2.9 KiB
PHP
<?php
|
|
/**
|
|
* Hooks for TemplateInfo extension
|
|
*
|
|
* @file
|
|
* @ingroup Extensions
|
|
*/
|
|
|
|
class TemplateDataHooks {
|
|
|
|
/**
|
|
* Register parser hooks
|
|
*/
|
|
public static function onParserFirstCallInit( &$parser ) {
|
|
$parser->setHook( 'templatedata', array( 'TemplateDataHooks', 'render' ) );
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Register unit tests
|
|
*/
|
|
public static function onUnitTestsList( array &$files ) {
|
|
$testDir = __DIR__ . '/tests/';
|
|
$files = array_merge( $files, glob( "$testDir/*Test.php" ) );
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* @param Page &$page
|
|
* @param User &$user
|
|
* @param Content &$content
|
|
* @param string &$summary
|
|
* @param $minor
|
|
* @param bool|null $watchthis
|
|
* @param $sectionanchor
|
|
* @param &$flags
|
|
* @param Status &$status
|
|
*/
|
|
public static function onPageContentSave( &$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.
|
|
|
|
$editInfo = $page->prepareContentForEdit( $content, null, $user, $serialisation_format = null );
|
|
|
|
if ( isset( $editInfo->output->ext_templatedata_status ) ) {
|
|
$validation = $editInfo->output->ext_templatedata_status;
|
|
if ( !$validation->isOK() ) {
|
|
// Abort edit, show error message from TemplateDataBlob::getStatus
|
|
$status->merge( $validation );
|
|
return false;
|
|
}
|
|
}
|
|
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()->ext_templatedata_status = $status;
|
|
return '<div class="error">' . $status->getHtml() . '</div>';
|
|
}
|
|
|
|
$parser->getOutput()->setProperty( 'templatedata', $ti->getJSONForDatabase() );
|
|
|
|
$parser->getOutput()->addModules( 'ext.templateData' );
|
|
|
|
return $ti->getHtml( $parser->getOptions()->getUserLangObj() );
|
|
}
|
|
}
|