4 * Created on Dec 01, 2007
6 * API for MediaWiki 1.8+
8 * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( "ApiBase.php" );
34 class ApiParse
extends ApiBase
{
36 public function __construct( $main, $action ) {
37 parent
::__construct( $main, $action );
40 public function execute() {
42 $params = $this->extractRequestParams();
43 $text = $params['text'];
44 $title = $params['title'];
45 $page = $params['page'];
46 $oldid = $params['oldid'];
47 if ( !is_null( $page ) && ( !is_null( $text ) ||
$title != 'API' ) ) {
48 $this->dieUsage( 'The page parameter cannot be used together with the text and title parameters', 'params' );
50 $prop = array_flip( $params['prop'] );
53 // The parser needs $wgTitle to be set, apparently the
54 // $title parameter in Parser::parse isn't enough *sigh*
55 global $wgParser, $wgUser, $wgTitle, $wgEnableParserCache, $wgLang;
57 // Current unncessary, code to act as a safeguard against any change in current behaviour of uselang breaks
59 if ( isset( $params['uselang'] ) && $params['uselang'] != $wgLang->getCode() ) {
60 $oldLang = $wgLang; // Backup wgLang
61 $wgLang = Language
::factory( $params['uselang'] );
64 $popts = new ParserOptions();
65 $popts->setTidy( true );
66 $popts->enableLimitReport();
68 if ( !is_null( $oldid ) ||
!is_null( $page ) ) {
69 if ( !is_null( $oldid ) ) {
70 // Don't use the parser cache
71 $rev = Revision
::newFromID( $oldid );
73 $this->dieUsage( "There is no revision ID $oldid", 'missingrev' );
75 if ( !$rev->userCan( Revision
::DELETED_TEXT
) ) {
76 $this->dieUsage( "You don't have permission to view deleted revisions", 'permissiondenied' );
79 $text = $rev->getText( Revision
::FOR_THIS_USER
);
80 $titleObj = $rev->getTitle();
82 $p_result = $wgParser->parse( $text, $titleObj, $popts );
84 if ( $params['redirects'] ) {
85 $req = new FauxRequest( array(
90 $main = new ApiMain( $req );
92 $data = $main->getResultData();
93 $redirValues = @$data['query']['redirects'];
95 foreach ( (array)$redirValues as $r ) {
101 $titleObj = Title
::newFromText( $to );
103 $this->dieUsage( "The page you specified doesn't exist", 'missingtitle' );
106 $articleObj = new Article( $titleObj );
107 if ( isset( $prop['revid'] ) ) {
108 $oldid = $articleObj->getRevIdFetched();
110 // Try the parser cache first
112 $pcache = ParserCache
::singleton();
113 if ( $wgEnableParserCache ) {
114 $p_result = $pcache->get( $articleObj, $wgUser );
117 $p_result = $wgParser->parse( $articleObj->getContent(), $titleObj, $popts );
119 if ( $wgEnableParserCache ) {
120 $pcache->save( $p_result, $articleObj, $popts );
125 $titleObj = Title
::newFromText( $title );
127 $titleObj = Title
::newFromText( 'API' );
129 $wgTitle = $titleObj;
130 if ( $params['pst'] ||
$params['onlypst'] ) {
131 $text = $wgParser->preSaveTransform( $text, $titleObj, $wgUser, $popts );
133 if ( $params['onlypst'] ) {
134 // Build a result and bail out
135 $result_array['text'] = array();
136 $this->getResult()->setContent( $result_array['text'], $text );
137 $this->getResult()->addValue( null, $this->getModuleName(), $result_array );
140 $p_result = $wgParser->parse( $text, $titleObj, $popts );
144 $result = $this->getResult();
145 $result_array = array();
146 if ( $params['redirects'] && !is_null( $redirValues ) ) {
147 $result_array['redirects'] = $redirValues;
150 if ( isset( $prop['text'] ) ) {
151 $result_array['text'] = array();
152 $result->setContent( $result_array['text'], $p_result->getText() );
155 if ( !is_null( $params['summary'] ) ) {
156 $result_array['parsedsummary'] = array();
157 $result->setContent( $result_array['parsedsummary'], $wgUser->getSkin()->formatComment( $params['summary'], $titleObj ) );
160 if ( isset( $prop['langlinks'] ) ) {
161 $result_array['langlinks'] = $this->formatLangLinks( $p_result->getLanguageLinks() );
163 if ( isset( $prop['categories'] ) ) {
164 $result_array['categories'] = $this->formatCategoryLinks( $p_result->getCategories() );
166 if ( isset( $prop['links'] ) ) {
167 $result_array['links'] = $this->formatLinks( $p_result->getLinks() );
169 if ( isset( $prop['templates'] ) ) {
170 $result_array['templates'] = $this->formatLinks( $p_result->getTemplates() );
172 if ( isset( $prop['images'] ) ) {
173 $result_array['images'] = array_keys( $p_result->getImages() );
175 if ( isset( $prop['externallinks'] ) ) {
176 $result_array['externallinks'] = array_keys( $p_result->getExternalLinks() );
178 if ( isset( $prop['sections'] ) ) {
179 $result_array['sections'] = $p_result->getSections();
181 if ( isset( $prop['displaytitle'] ) ) {
182 $result_array['displaytitle'] = $p_result->getDisplayTitle() ?
183 $p_result->getDisplayTitle() :
184 $titleObj->getPrefixedText();
187 if ( isset( $prop['headitems'] ) ) {
188 $result_array['headitems'] = $this->formatHeadItems( $p_result->getHeadItems() );
191 if ( isset( $prop['headhtml'] ) ) {
192 $out = new OutputPage
;
193 $out->addParserOutputNoText( $p_result );
194 $result_array['headhtml'] = array();
195 $result->setContent( $result_array['headhtml'], $out->headElement( $wgUser->getSkin() ) );
198 if ( !is_null( $oldid ) ) {
199 $result_array['revid'] = intval( $oldid );
202 $result_mapping = array(
205 'categories' => 'cl',
209 'externallinks' => 'el',
213 $this->setIndexedTagNames( $result_array, $result_mapping );
214 $result->addValue( null, $this->getModuleName(), $result_array );
216 if ( !is_null( $oldLang ) ) {
217 $wgLang = $oldLang; // Reset $wgLang to $oldLang
221 private function formatLangLinks( $links ) {
223 foreach ( $links as $link ) {
225 $bits = explode( ':', $link, 2 );
226 $entry['lang'] = $bits[0];
227 $this->getResult()->setContent( $entry, $bits[1] );
233 private function formatCategoryLinks( $links ) {
235 foreach ( $links as $link => $sortkey ) {
237 $entry['sortkey'] = $sortkey;
238 $this->getResult()->setContent( $entry, $link );
244 private function formatLinks( $links ) {
246 foreach ( $links as $ns => $nslinks ) {
247 foreach ( $nslinks as $title => $id ) {
250 $this->getResult()->setContent( $entry, Title
::makeTitle( $ns, $title )->getFullText() );
252 $entry['exists'] = '';
260 private function formatHeadItems( $headItems ) {
262 foreach ( $headItems as $tag => $content ) {
264 $entry['tag'] = $tag;
265 $this->getResult()->setContent( $entry, $content );
271 private function setIndexedTagNames( &$array, $mapping ) {
272 foreach ( $mapping as $key => $name ) {
273 if ( isset( $array[$key] ) ) {
274 $this->getResult()->setIndexedTagName( $array[$key], $name );
279 public function getAllowedParams() {
282 ApiBase
::PARAM_DFLT
=> 'API',
287 'redirects' => false,
290 ApiBase
::PARAM_DFLT
=> 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
291 ApiBase
::PARAM_ISMULTI
=> true,
292 ApiBase
::PARAM_TYPE
=> array(
312 public function getParamDescription() {
314 'text' => 'Wikitext to parse.',
315 'summary' => 'Summary to parse.',
316 'redirects' => 'If the page parameter is set to a redirect, resolve it.',
317 'title' => 'Title of page the text belongs to.',
318 'page' => 'Parse the content of this page. Cannot be used together with text and title.',
319 'oldid' => 'Parse the content of this revision. Overrides page.',
320 'prop' => array( 'Which pieces of information to get.',
321 'NOTE: Section tree is only generated if there are more than 4 sections, or if the __TOC__ keyword is present.'
323 'pst' => array( 'Do a pre-save transform on the input before parsing it.',
324 'Ignored if page or oldid is used.'
326 'onlypst' => array( 'Do a PST on the input, but don\'t parse it.',
327 'Returns PSTed wikitext. Ignored if page or oldid is used.'
329 'uselang' => 'Which language to parse the request in.'
333 public function getDescription() {
334 return 'This module parses wikitext and returns parser output';
337 public function getPossibleErrors() {
338 return array_merge( parent
::getPossibleErrors(), array(
339 array( 'code' => 'params', 'info' => 'The page parameter cannot be used together with the text and title parameters' ),
340 array( 'code' => 'missingrev', 'info' => 'There is no revision ID oldid' ),
341 array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revisions' ),
342 array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ),
346 protected function getExamples() {
348 'api.php?action=parse&text={{Project:Sandbox}}'
352 public function getVersion() {
353 return __CLASS__
. ': $Id$';