mirror of
https://github.com/YunoHost-Apps/mediawiki_ynh.git
synced 2024-09-03 19:46:05 +02:00
129 lines
3.5 KiB
PHP
129 lines
3.5 KiB
PHP
<?php
|
|
/**
|
|
*
|
|
*
|
|
* Created on Oct 05, 2007
|
|
*
|
|
* Copyright © 2007 Yuri Astrakhan "<Firstname><Lastname>@gmail.com"
|
|
*
|
|
* 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
|
|
*/
|
|
|
|
/**
|
|
* API module that functions as a shortcut to the wikitext preprocessor. Expands
|
|
* any templates in a provided string, and returns the result of this expansion
|
|
* to the caller.
|
|
*
|
|
* @ingroup API
|
|
*/
|
|
class ApiExpandTemplates extends ApiBase {
|
|
|
|
public function execute() {
|
|
// Cache may vary on $wgUser because ParserOptions gets data from it
|
|
$this->getMain()->setCacheMode( 'anon-public-user-private' );
|
|
|
|
// Get parameters
|
|
$params = $this->extractRequestParams();
|
|
|
|
// Create title for parser
|
|
$title_obj = Title::newFromText( $params['title'] );
|
|
if ( !$title_obj || $title_obj->isExternal() ) {
|
|
$this->dieUsageMsg( array( 'invalidtitle', $params['title'] ) );
|
|
}
|
|
|
|
$result = $this->getResult();
|
|
|
|
// Parse text
|
|
global $wgParser;
|
|
$options = ParserOptions::newFromContext( $this->getContext() );
|
|
|
|
if ( $params['includecomments'] ) {
|
|
$options->setRemoveComments( false );
|
|
}
|
|
|
|
if ( $params['generatexml'] ) {
|
|
$wgParser->startExternalParse( $title_obj, $options, OT_PREPROCESS );
|
|
$dom = $wgParser->preprocessToDom( $params['text'] );
|
|
if ( is_callable( array( $dom, 'saveXML' ) ) ) {
|
|
$xml = $dom->saveXML();
|
|
} else {
|
|
$xml = $dom->__toString();
|
|
}
|
|
$xml_result = array();
|
|
ApiResult::setContent( $xml_result, $xml );
|
|
$result->addValue( null, 'parsetree', $xml_result );
|
|
}
|
|
$retval = $wgParser->preprocess( $params['text'], $title_obj, $options );
|
|
|
|
// Return result
|
|
$retval_array = array();
|
|
ApiResult::setContent( $retval_array, $retval );
|
|
$result->addValue( null, $this->getModuleName(), $retval_array );
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return array(
|
|
'title' => array(
|
|
ApiBase::PARAM_DFLT => 'API',
|
|
),
|
|
'text' => array(
|
|
ApiBase::PARAM_TYPE => 'string',
|
|
ApiBase::PARAM_REQUIRED => true,
|
|
),
|
|
'generatexml' => false,
|
|
'includecomments' => false,
|
|
);
|
|
}
|
|
|
|
public function getParamDescription() {
|
|
return array(
|
|
'text' => 'Wikitext to convert',
|
|
'title' => 'Title of page',
|
|
'generatexml' => 'Generate XML parse tree',
|
|
'includecomments' => 'Whether to include HTML comments in the output',
|
|
);
|
|
}
|
|
|
|
public function getResultProperties() {
|
|
return array(
|
|
'' => array(
|
|
'*' => 'string'
|
|
)
|
|
);
|
|
}
|
|
|
|
public function getDescription() {
|
|
return 'Expands all templates in wikitext';
|
|
}
|
|
|
|
public function getPossibleErrors() {
|
|
return array_merge( parent::getPossibleErrors(), array(
|
|
array( 'invalidtitle', 'title' ),
|
|
) );
|
|
}
|
|
|
|
public function getExamples() {
|
|
return array(
|
|
'api.php?action=expandtemplates&text={{Project:Sandbox}}'
|
|
);
|
|
}
|
|
|
|
public function getHelpUrls() {
|
|
return 'https://www.mediawiki.org/wiki/API:Parsing_wikitext#expandtemplates';
|
|
}
|
|
}
|