353 lines
No EOL
11 KiB
PHP
353 lines
No EOL
11 KiB
PHP
<?php
|
|
|
|
/**
|
|
* Created on Dec 01, 2007
|
|
*
|
|
* API for MediaWiki 1.8+
|
|
*
|
|
* 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.,
|
|
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
*/
|
|
|
|
if ( !defined( 'MEDIAWIKI' ) ) {
|
|
// Eclipse helper - will be ignored in production
|
|
require_once( "ApiBase.php" );
|
|
}
|
|
|
|
/**
|
|
* @ingroup API
|
|
*/
|
|
class ApiParse extends ApiBase {
|
|
|
|
public function __construct( $main, $action ) {
|
|
parent::__construct( $main, $action );
|
|
}
|
|
|
|
public function execute() {
|
|
// Get parameters
|
|
$params = $this->extractRequestParams();
|
|
$text = $params['text'];
|
|
$title = $params['title'];
|
|
$page = $params['page'];
|
|
$oldid = $params['oldid'];
|
|
if ( !is_null( $page ) && ( !is_null( $text ) || $title != 'API' ) ) {
|
|
$this->dieUsage( 'The page parameter cannot be used together with the text and title parameters', 'params' );
|
|
}
|
|
$prop = array_flip( $params['prop'] );
|
|
$revid = false;
|
|
|
|
// The parser needs $wgTitle to be set, apparently the
|
|
// $title parameter in Parser::parse isn't enough *sigh*
|
|
global $wgParser, $wgUser, $wgTitle, $wgEnableParserCache, $wgLang;
|
|
|
|
if ( isset( $params['uselang'] ) && $params['uselang'] != $wgLang->getCode() ) {
|
|
$oldLang = $wgLang; //Backup wgLang
|
|
$wgLang = Language::factory( $params['uselang'] );
|
|
}
|
|
|
|
$popts = new ParserOptions();
|
|
$popts->setTidy( true );
|
|
$popts->enableLimitReport();
|
|
$redirValues = null;
|
|
if ( !is_null( $oldid ) || !is_null( $page ) ) {
|
|
if ( !is_null( $oldid ) ) {
|
|
// Don't use the parser cache
|
|
$rev = Revision::newFromID( $oldid );
|
|
if ( !$rev ) {
|
|
$this->dieUsage( "There is no revision ID $oldid", 'missingrev' );
|
|
}
|
|
if ( !$rev->userCan( Revision::DELETED_TEXT ) ) {
|
|
$this->dieUsage( "You don't have permission to view deleted revisions", 'permissiondenied' );
|
|
}
|
|
|
|
$text = $rev->getText( Revision::FOR_THIS_USER );
|
|
$titleObj = $rev->getTitle();
|
|
$wgTitle = $titleObj;
|
|
$p_result = $wgParser->parse( $text, $titleObj, $popts );
|
|
} else {
|
|
if ( $params['redirects'] ) {
|
|
$req = new FauxRequest( array(
|
|
'action' => 'query',
|
|
'redirects' => '',
|
|
'titles' => $page
|
|
) );
|
|
$main = new ApiMain( $req );
|
|
$main->execute();
|
|
$data = $main->getResultData();
|
|
$redirValues = @$data['query']['redirects'];
|
|
$to = $page;
|
|
foreach ( (array)$redirValues as $r ) {
|
|
$to = $r['to'];
|
|
}
|
|
} else {
|
|
$to = $page;
|
|
}
|
|
$titleObj = Title::newFromText( $to );
|
|
if ( !$titleObj ) {
|
|
$this->dieUsage( "The page you specified doesn't exist", 'missingtitle' );
|
|
}
|
|
|
|
$articleObj = new Article( $titleObj );
|
|
if ( isset( $prop['revid'] ) ) {
|
|
$oldid = $articleObj->getRevIdFetched();
|
|
}
|
|
// Try the parser cache first
|
|
$p_result = false;
|
|
$pcache = ParserCache::singleton();
|
|
if ( $wgEnableParserCache ) {
|
|
$p_result = $pcache->get( $articleObj, $wgUser );
|
|
}
|
|
if ( !$p_result ) {
|
|
$p_result = $wgParser->parse( $articleObj->getContent(), $titleObj, $popts );
|
|
|
|
if ( $wgEnableParserCache ) {
|
|
$pcache->save( $p_result, $articleObj, $popts );
|
|
}
|
|
}
|
|
}
|
|
} else {
|
|
$titleObj = Title::newFromText( $title );
|
|
if ( !$titleObj ) {
|
|
$titleObj = Title::newFromText( 'API' );
|
|
}
|
|
$wgTitle = $titleObj;
|
|
if ( $params['pst'] || $params['onlypst'] ) {
|
|
$text = $wgParser->preSaveTransform( $text, $titleObj, $wgUser, $popts );
|
|
}
|
|
if ( $params['onlypst'] ) {
|
|
// Build a result and bail out
|
|
$result_array['text'] = array();
|
|
$this->getResult()->setContent( $result_array['text'], $text );
|
|
$this->getResult()->addValue( null, $this->getModuleName(), $result_array );
|
|
return;
|
|
}
|
|
$p_result = $wgParser->parse( $text, $titleObj, $popts );
|
|
}
|
|
|
|
// Return result
|
|
$result = $this->getResult();
|
|
$result_array = array();
|
|
if ( $params['redirects'] && !is_null( $redirValues ) ) {
|
|
$result_array['redirects'] = $redirValues;
|
|
}
|
|
|
|
if ( isset( $prop['text'] ) ) {
|
|
$result_array['text'] = array();
|
|
$result->setContent( $result_array['text'], $p_result->getText() );
|
|
}
|
|
|
|
if ( !is_null( $params['summary'] ) ) {
|
|
$result_array['parsedsummary'] = array();
|
|
$result->setContent( $result_array['parsedsummary'], $wgUser->getSkin()->formatComment( $params['summary'], $titleObj ) );
|
|
}
|
|
|
|
if ( isset( $prop['langlinks'] ) ) {
|
|
$result_array['langlinks'] = $this->formatLangLinks( $p_result->getLanguageLinks() );
|
|
}
|
|
if ( isset( $prop['categories'] ) ) {
|
|
$result_array['categories'] = $this->formatCategoryLinks( $p_result->getCategories() );
|
|
}
|
|
if ( isset( $prop['links'] ) ) {
|
|
$result_array['links'] = $this->formatLinks( $p_result->getLinks() );
|
|
}
|
|
if ( isset( $prop['templates'] ) ) {
|
|
$result_array['templates'] = $this->formatLinks( $p_result->getTemplates() );
|
|
}
|
|
if ( isset( $prop['images'] ) ) {
|
|
$result_array['images'] = array_keys( $p_result->getImages() );
|
|
}
|
|
if ( isset( $prop['externallinks'] ) ) {
|
|
$result_array['externallinks'] = array_keys( $p_result->getExternalLinks() );
|
|
}
|
|
if ( isset( $prop['sections'] ) ) {
|
|
$result_array['sections'] = $p_result->getSections();
|
|
}
|
|
if ( isset( $prop['displaytitle'] ) ) {
|
|
$result_array['displaytitle'] = $p_result->getDisplayTitle() ?
|
|
$p_result->getDisplayTitle() :
|
|
$titleObj->getPrefixedText();
|
|
}
|
|
|
|
if ( isset( $prop['headitems'] ) ) {
|
|
$result_array['headitems'] = $this->formatHeadItems( $p_result->getHeadItems() );
|
|
}
|
|
|
|
if ( isset( $prop['headhtml'] ) ) {
|
|
$out = new OutputPage;
|
|
$out->addParserOutputNoText( $p_result );
|
|
$result_array['headhtml'] = array();
|
|
$result->setContent( $result_array['headhtml'], $out->headElement( $wgUser->getSkin() ) );
|
|
}
|
|
|
|
if ( !is_null( $oldid ) ) {
|
|
$result_array['revid'] = intval( $oldid );
|
|
}
|
|
|
|
$result_mapping = array(
|
|
'redirects' => 'r',
|
|
'langlinks' => 'll',
|
|
'categories' => 'cl',
|
|
'links' => 'pl',
|
|
'templates' => 'tl',
|
|
'images' => 'img',
|
|
'externallinks' => 'el',
|
|
'sections' => 's',
|
|
'headitems' => 'hi'
|
|
);
|
|
$this->setIndexedTagNames( $result_array, $result_mapping );
|
|
$result->addValue( null, $this->getModuleName(), $result_array );
|
|
|
|
if ( isset( $params['uselang'] ) ) {
|
|
$wgLang = $oldLang; //Reset $wgLang to $oldLang
|
|
}
|
|
}
|
|
|
|
private function formatLangLinks( $links ) {
|
|
$result = array();
|
|
foreach ( $links as $link ) {
|
|
$entry = array();
|
|
$bits = explode( ':', $link, 2 );
|
|
$entry['lang'] = $bits[0];
|
|
$this->getResult()->setContent( $entry, $bits[1] );
|
|
$result[] = $entry;
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
private function formatCategoryLinks( $links ) {
|
|
$result = array();
|
|
foreach ( $links as $link => $sortkey ) {
|
|
$entry = array();
|
|
$entry['sortkey'] = $sortkey;
|
|
$this->getResult()->setContent( $entry, $link );
|
|
$result[] = $entry;
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
private function formatLinks( $links ) {
|
|
$result = array();
|
|
foreach ( $links as $ns => $nslinks ) {
|
|
foreach ( $nslinks as $title => $id ) {
|
|
$entry = array();
|
|
$entry['ns'] = $ns;
|
|
$this->getResult()->setContent( $entry, Title::makeTitle( $ns, $title )->getFullText() );
|
|
if ( $id != 0 ) {
|
|
$entry['exists'] = '';
|
|
}
|
|
$result[] = $entry;
|
|
}
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
private function formatHeadItems( $headItems ) {
|
|
$result = array();
|
|
foreach ( $headItems as $tag => $content ) {
|
|
$entry = array();
|
|
$entry['tag'] = $tag;
|
|
$this->getResult()->setContent( $entry, $content );
|
|
$result[] = $entry;
|
|
}
|
|
return $result;
|
|
}
|
|
|
|
private function setIndexedTagNames( &$array, $mapping ) {
|
|
foreach ( $mapping as $key => $name ) {
|
|
if ( isset( $array[$key] ) ) {
|
|
$this->getResult()->setIndexedTagName( $array[$key], $name );
|
|
}
|
|
}
|
|
}
|
|
|
|
public function getAllowedParams() {
|
|
return array(
|
|
'title' => array(
|
|
ApiBase::PARAM_DFLT => 'API',
|
|
),
|
|
'text' => null,
|
|
'summary' => null,
|
|
'page' => null,
|
|
'redirects' => false,
|
|
'oldid' => null,
|
|
'prop' => array(
|
|
ApiBase::PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
|
|
ApiBase::PARAM_ISMULTI => true,
|
|
ApiBase::PARAM_TYPE => array(
|
|
'text',
|
|
'langlinks',
|
|
'categories',
|
|
'links',
|
|
'templates',
|
|
'images',
|
|
'externallinks',
|
|
'sections',
|
|
'revid',
|
|
'displaytitle',
|
|
'headitems',
|
|
'headhtml'
|
|
)
|
|
),
|
|
'pst' => false,
|
|
'onlypst' => false,
|
|
);
|
|
}
|
|
|
|
public function getParamDescription() {
|
|
return array(
|
|
'text' => 'Wikitext to parse.',
|
|
'summary' => 'Summary to parse.',
|
|
'redirects' => 'If the page parameter is set to a redirect, resolve it.',
|
|
'title' => 'Title of page the text belongs to.',
|
|
'page' => 'Parse the content of this page. Cannot be used together with text and title.',
|
|
'oldid' => 'Parse the content of this revision. Overrides page.',
|
|
'prop' => array( 'Which pieces of information to get.',
|
|
'NOTE: Section tree is only generated if there are more than 4 sections, or if the __TOC__ keyword is present.'
|
|
),
|
|
'pst' => array( 'Do a pre-save transform on the input before parsing it.',
|
|
'Ignored if page or oldid is used.'
|
|
),
|
|
'onlypst' => array( 'Do a PST on the input, but don\'t parse it.',
|
|
'Returns PSTed wikitext. Ignored if page or oldid is used.'
|
|
),
|
|
'uselang' => 'Which language to parse the request in.'
|
|
);
|
|
}
|
|
|
|
public function getDescription() {
|
|
return 'This module parses wikitext and returns parser output';
|
|
}
|
|
|
|
public function getPossibleErrors() {
|
|
return array_merge( parent::getPossibleErrors(), array(
|
|
array( 'code' => 'params', 'info' => 'The page parameter cannot be used together with the text and title parameters' ),
|
|
array( 'code' => 'missingrev', 'info' => 'There is no revision ID oldid' ),
|
|
array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revisions' ),
|
|
array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ),
|
|
) );
|
|
}
|
|
|
|
protected function getExamples() {
|
|
return array(
|
|
'api.php?action=parse&text={{Project:Sandbox}}'
|
|
);
|
|
}
|
|
|
|
public function getVersion() {
|
|
return __CLASS__ . ': $Id$';
|
|
}
|
|
} |