mirror of
https://gerrit.wikimedia.org/r/mediawiki/extensions/Gadgets
synced 2024-12-13 15:58:21 +00:00
519f30355e
Implements: * Gadget definition content and content handler * Basic validation for gadget definition content * GadgetDefinitionNamespace implementation of GadgetRepo * DataUpdates upon editing/deletion of Gadget definition pages * EditFilterMerged hook for improved error messages * 'GadgetsRepoClass' option to switch GadgetRepo implementation used * Lazy-load the GadgetResourceLoaderModule class so we don't need to load each individual gadget object unless its needed Note that Special:Gadgets's export feature intentionally doesn't work yet, and will be fixed in a follow up patch. Bug: T106177 Change-Id: Ib11db5fb0f7b46793bfa956cf1367f1dc1059b1c
126 lines
3.4 KiB
PHP
126 lines
3.4 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
|
|
*/
|
|
|
|
class GadgetDefinitionContent extends JsonContent {
|
|
|
|
public function __construct( $text ) {
|
|
parent::__construct( $text, 'GadgetDefinition' );
|
|
}
|
|
|
|
public function isValid() {
|
|
// parent::isValid() is called in validate()
|
|
return $this->validate()->isOK();
|
|
}
|
|
|
|
/**
|
|
* Pretty-print JSON.
|
|
*
|
|
* If called before validation, it may return JSON "null".
|
|
*
|
|
* @return string
|
|
*/
|
|
public function beautifyJSON() {
|
|
// @todo we should normalize entries in module.scripts and module.styles
|
|
return FormatJson::encode( $this->getAssocArray(), true, FormatJson::UTF8_OK );
|
|
}
|
|
|
|
/**
|
|
* Register some links
|
|
*
|
|
* @param Title $title
|
|
* @param int $revId
|
|
* @param ParserOptions $options
|
|
* @param bool $generateHtml
|
|
* @param ParserOutput $output
|
|
*/
|
|
protected function fillParserOutput( Title $title, $revId,
|
|
ParserOptions $options, $generateHtml, ParserOutput &$output
|
|
) {
|
|
parent::fillParserOutput( $title, $revId, $options, $generateHtml, $output );
|
|
$assoc = $this->getAssocArray();
|
|
foreach ( array( 'scripts', 'styles' ) as $type ) {
|
|
foreach ( $assoc['module'][$type] as $page ) {
|
|
$title = Title::makeTitleSafe( NS_GADGET, $page );
|
|
if ( $title ) {
|
|
$output->addLink( $title );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
/**
|
|
* @return Status
|
|
*/
|
|
public function validate() {
|
|
if ( !parent::isValid() ) {
|
|
return $this->getData();
|
|
}
|
|
|
|
$validator = new GadgetDefinitionValidator();
|
|
return $validator->validate( $this->getAssocArray() );
|
|
}
|
|
|
|
/**
|
|
* Get the JSON content as an associative array with
|
|
* all fields filled out, populating defaults as necessary.
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getAssocArray() {
|
|
$info = wfObjectToArray( $this->getData()->getValue() );
|
|
/** @var GadgetDefinitionContentHandler $handler */
|
|
$handler = $this->getContentHandler();
|
|
$info = wfArrayPlus2d( $info, $handler->getDefaultMetadata() );
|
|
|
|
return $info;
|
|
}
|
|
|
|
/**
|
|
* @param WikiPage $page
|
|
* @param ParserOutput $parserOutput
|
|
* @return DataUpdate[]
|
|
*/
|
|
public function getDeletionUpdates( WikiPage $page, ParserOutput $parserOutput = null ) {
|
|
return array_merge(
|
|
parent::getDeletionUpdates( $page, $parserOutput ),
|
|
array( new GadgetDefinitionDeletionUpdate( $page->getTitle()->getText() ) )
|
|
);
|
|
}
|
|
|
|
/**
|
|
* @param Title $title
|
|
* @param Content $old
|
|
* @param bool $recursive
|
|
* @param ParserOutput $parserOutput
|
|
* @return DataUpdate[]
|
|
*/
|
|
public function getSecondaryDataUpdates( Title $title, Content $old = null,
|
|
$recursive = true, ParserOutput $parserOutput = null
|
|
) {
|
|
return array_merge(
|
|
parent::getSecondaryDataUpdates( $title, $old, $recursive, $parserOutput ),
|
|
array( new GadgetDefinitionSecondaryDataUpdate( $title->getText() ) )
|
|
);
|
|
}
|
|
}
|