mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets
synced 2024-12-22 11:42:40 +00:00
01f6a6c34e
Bug: T278278 Change-Id: I49b57e68079c998419e235b1727eea8c121c234b
187 lines
5.5 KiB
PHP
187 lines
5.5 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Copyright 2014
|
|
*
|
|
* This program is free software; you can redistribute it and/or modify
|
|
* it under the terms of the GNU General Public License as published by
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* This program is distributed in the hope that it will be useful,
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
* GNU General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU General Public License along
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*
|
|
* @file
|
|
*/
|
|
|
|
namespace MediaWiki\Extension\Gadgets\Content;
|
|
|
|
use Content;
|
|
use DeferrableUpdate;
|
|
use FormatJson;
|
|
use JsonContentHandler;
|
|
use Linker;
|
|
use MediaWiki\Content\Renderer\ContentParseParams;
|
|
use MediaWiki\Revision\SlotRenderingProvider;
|
|
use ParserOutput;
|
|
use Title;
|
|
|
|
class GadgetDefinitionContentHandler extends JsonContentHandler {
|
|
public function __construct() {
|
|
parent::__construct( 'GadgetDefinition' );
|
|
}
|
|
|
|
/**
|
|
* @param Title $title
|
|
* @return bool
|
|
*/
|
|
public function canBeUsedOn( Title $title ) {
|
|
return $title->inNamespace( NS_GADGET_DEFINITION );
|
|
}
|
|
|
|
/**
|
|
* @return string
|
|
*/
|
|
protected function getContentClass() {
|
|
return GadgetDefinitionContent::class;
|
|
}
|
|
|
|
public function makeEmptyContent() {
|
|
$class = $this->getContentClass();
|
|
return new $class( FormatJson::encode( $this->getDefaultMetadata(), "\t" ) );
|
|
}
|
|
|
|
public function getDefaultMetadata() {
|
|
return [
|
|
'settings' => [
|
|
'rights' => [],
|
|
'default' => false,
|
|
'package' => false,
|
|
'hidden' => false,
|
|
'skins' => [],
|
|
'actions' => [],
|
|
'category' => '',
|
|
'supportsUrlLoad' => false,
|
|
],
|
|
'module' => [
|
|
'scripts' => [],
|
|
'styles' => [],
|
|
'datas' => [],
|
|
'peers' => [],
|
|
'dependencies' => [],
|
|
'messages' => [],
|
|
'type' => '',
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* @param Title $title The title of the page to supply the updates for.
|
|
* @param string $role The role (slot) in which the content is being used.
|
|
* @return DeferrableUpdate[] A list of DeferrableUpdate objects for putting information
|
|
* about this content object somewhere.
|
|
*/
|
|
public function getDeletionUpdates( Title $title, $role ) {
|
|
return array_merge(
|
|
parent::getDeletionUpdates( $title, $role ),
|
|
[ new GadgetDefinitionDeletionUpdate( $title ) ]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param Title $title The title of the page to supply the updates for.
|
|
* @param Content $content The content to generate data updates for.
|
|
* @param string $role The role (slot) in which the content is being used.
|
|
* @param SlotRenderingProvider $slotOutput A provider that can be used to gain access to
|
|
* a ParserOutput of $content by calling $slotOutput->getSlotParserOutput( $role, false ).
|
|
* @return DeferrableUpdate[] A list of DeferrableUpdate objects for putting information
|
|
* about this content object somewhere.
|
|
*/
|
|
public function getSecondaryDataUpdates(
|
|
Title $title,
|
|
Content $content,
|
|
$role,
|
|
SlotRenderingProvider $slotOutput
|
|
) {
|
|
return array_merge(
|
|
parent::getSecondaryDataUpdates( $title, $content, $role, $slotOutput ),
|
|
[ new GadgetDefinitionSecondaryDataUpdate( $title ) ]
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @inheritDoc
|
|
*/
|
|
protected function fillParserOutput(
|
|
Content $content,
|
|
ContentParseParams $cpoParams,
|
|
ParserOutput &$parserOutput
|
|
) {
|
|
'@phan-var GadgetDefinitionContent $content';
|
|
// Create a deep clone. FIXME: unserialize(serialize()) is hacky.
|
|
$data = unserialize( serialize( $content->getData()->getValue() ) );
|
|
if ( $data !== null ) {
|
|
foreach ( [ 'scripts', 'styles', 'datas' ] as $type ) {
|
|
if ( isset( $data->module->{$type} ) ) {
|
|
foreach ( $data->module->{$type} as &$page ) {
|
|
$title = Title::makeTitleSafe( NS_GADGET, $page );
|
|
$this->makeLink( $parserOutput, $page, $title );
|
|
}
|
|
}
|
|
}
|
|
foreach ( $data->module->dependencies as &$dep ) {
|
|
if ( str_starts_with( $dep, 'ext.gadget.' ) ) {
|
|
$gadgetId = explode( 'ext.gadget.', $dep )[1];
|
|
$title = Title::makeTitleSafe( NS_GADGET_DEFINITION, $gadgetId );
|
|
$this->makeLink( $parserOutput, $dep, $title );
|
|
}
|
|
}
|
|
foreach ( $data->module->peers as &$peer ) {
|
|
$title = Title::makeTitleSafe( NS_GADGET_DEFINITION, $peer );
|
|
$this->makeLink( $parserOutput, $peer, $title );
|
|
}
|
|
foreach ( $data->module->messages as &$msg ) {
|
|
$title = Title::makeTitleSafe( NS_MEDIAWIKI, $msg );
|
|
$this->makeLink( $parserOutput, $msg, $title );
|
|
}
|
|
if ( $data->settings->category ) {
|
|
$this->makeLink(
|
|
$parserOutput,
|
|
$data->settings->category,
|
|
Title::makeTitleSafe( NS_MEDIAWIKI, "gadget-section-" . $data->settings->category )
|
|
);
|
|
}
|
|
}
|
|
|
|
if ( !$cpoParams->getGenerateHtml() || !$content->isValid() ) {
|
|
$parserOutput->setText( '' );
|
|
} else {
|
|
$parserOutput->setText( $content->rootValueTable( $data ) );
|
|
$parserOutput->addModuleStyles( [ 'mediawiki.content.json' ] );
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Create a link on the page
|
|
* @param ParserOutput $parserOutput
|
|
* @param string &$text The text to link
|
|
* @param Title|null $title Link target title
|
|
* @return void
|
|
*/
|
|
private function makeLink( ParserOutput $parserOutput, string &$text, ?Title $title ) {
|
|
if ( $title ) {
|
|
$parserOutput->addLink( $title );
|
|
$text = new GadgetDefinitionContentArmor(
|
|
Linker::link( $title, htmlspecialchars( '"' . $text . '"' ) )
|
|
);
|
|
}
|
|
}
|
|
}
|