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 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, 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() {
41 // The data is hot but user-dependent, like page views, so we set vary cookies
42 $this->getMain()->setCacheMode( 'anon-public-user-private' );
45 $params = $this->extractRequestParams();
46 $text = $params['text'];
47 $title = $params['title'];
48 $page = $params['page'];
49 $pageid = $params['pageid'];
50 $oldid = $params['oldid'];
52 if ( !is_null( $page ) && ( !is_null( $text ) ||
$title != 'API' ) ) {
53 $this->dieUsage( 'The page parameter cannot be used together with the text and title parameters', 'params' );
55 $prop = array_flip( $params['prop'] );
57 if ( isset( $params['section'] ) ) {
58 $this->section
= $params['section'];
60 $this->section
= false;
63 // The parser needs $wgTitle to be set, apparently the
64 // $title parameter in Parser::parse isn't enough *sigh*
65 global $wgParser, $wgUser, $wgTitle, $wgEnableParserCache, $wgLang;
67 // Currently unnecessary, code to act as a safeguard against any change in current behaviour of uselang breaks
69 if ( isset( $params['uselang'] ) && $params['uselang'] != $wgLang->getCode() ) {
70 $oldLang = $wgLang; // Backup wgLang
71 $wgLang = Language
::factory( $params['uselang'] );
74 $popts = new ParserOptions();
75 $popts->setTidy( true );
76 $popts->enableLimitReport( !$params['disablepp'] );
78 if ( !is_null( $oldid ) ||
!is_null( $pageid ) ||
!is_null( $page ) ) {
79 if ( !is_null( $oldid ) ) {
80 // Don't use the parser cache
81 $rev = Revision
::newFromID( $oldid );
83 $this->dieUsage( "There is no revision ID $oldid", 'missingrev' );
85 if ( !$rev->userCan( Revision
::DELETED_TEXT
) ) {
86 $this->dieUsage( "You don't have permission to view deleted revisions", 'permissiondenied' );
89 $text = $rev->getText( Revision
::FOR_THIS_USER
);
90 $titleObj = $rev->getTitle();
93 if ( $this->section
!== false ) {
94 $text = $this->getSectionText( $text, 'r' . $rev );
97 $p_result = $wgParser->parse( $text, $titleObj, $popts );
99 if ( !is_null ( $pageid ) ) {
100 $titleObj = Title
::newFromID( $pageid );
103 $this->dieUsageMsg( array( 'nosuchpageid', $pageid ) );
106 if ( $params['redirects'] ) {
107 $req = new FauxRequest( array(
112 $main = new ApiMain( $req );
114 $data = $main->getResultData();
115 $redirValues = @$data['query']['redirects'];
117 foreach ( (array)$redirValues as $r ) {
123 $titleObj = Title
::newFromText( $to );
125 $this->dieUsage( "The page you specified doesn't exist", 'missingtitle' );
128 $wgTitle = $titleObj;
130 $articleObj = new Article( $titleObj );
131 if ( isset( $prop['revid'] ) ) {
132 $oldid = $articleObj->getRevIdFetched();
135 if ( $this->section
!== false ) {
136 $text = $this->getSectionText( $text, !is_null ( $pageid ) ?
'page id ' . $pageid : $titleObj->getText() );
137 $p_result = $wgParser->parse( $text, $titleObj, $popts );
139 // Try the parser cache first
141 $pcache = ParserCache
::singleton();
142 if ( $wgEnableParserCache ) {
143 $p_result = $pcache->get( $articleObj, $popts );
146 $p_result = $wgParser->parse( $articleObj->getContent(), $titleObj, $popts );
148 if ( $wgEnableParserCache ) {
149 $pcache->save( $p_result, $articleObj, $popts );
155 $titleObj = Title
::newFromText( $title );
157 $titleObj = Title
::newFromText( 'API' );
159 $wgTitle = $titleObj;
161 if ( $this->section
!== false ) {
162 $text = $this->getSectionText( $text, $titleObj->getText() );
165 if ( $params['pst'] ||
$params['onlypst'] ) {
166 $text = $wgParser->preSaveTransform( $text, $titleObj, $wgUser, $popts );
168 if ( $params['onlypst'] ) {
169 // Build a result and bail out
170 $result_array['text'] = array();
171 $this->getResult()->setContent( $result_array['text'], $text );
172 $this->getResult()->addValue( null, $this->getModuleName(), $result_array );
175 $p_result = $wgParser->parse( $text, $titleObj, $popts );
179 $result = $this->getResult();
180 $result_array = array();
181 if ( $params['redirects'] && !is_null( $redirValues ) ) {
182 $result_array['redirects'] = $redirValues;
185 if ( isset( $prop['text'] ) ) {
186 $result_array['text'] = array();
187 $result->setContent( $result_array['text'], $p_result->getText() );
190 if ( !is_null( $params['summary'] ) ) {
191 $result_array['parsedsummary'] = array();
192 $result->setContent( $result_array['parsedsummary'], $wgUser->getSkin()->formatComment( $params['summary'], $titleObj ) );
195 if ( isset( $prop['langlinks'] ) ) {
196 $result_array['langlinks'] = $this->formatLangLinks( $p_result->getLanguageLinks() );
198 if ( isset( $prop['categories'] ) ) {
199 $result_array['categories'] = $this->formatCategoryLinks( $p_result->getCategories() );
201 if ( isset( $prop['links'] ) ) {
202 $result_array['links'] = $this->formatLinks( $p_result->getLinks() );
204 if ( isset( $prop['templates'] ) ) {
205 $result_array['templates'] = $this->formatLinks( $p_result->getTemplates() );
207 if ( isset( $prop['images'] ) ) {
208 $result_array['images'] = array_keys( $p_result->getImages() );
210 if ( isset( $prop['externallinks'] ) ) {
211 $result_array['externallinks'] = array_keys( $p_result->getExternalLinks() );
213 if ( isset( $prop['sections'] ) ) {
214 $result_array['sections'] = $p_result->getSections();
217 if ( isset( $prop['displaytitle'] ) ) {
218 $result_array['displaytitle'] = $p_result->getDisplayTitle() ?
219 $p_result->getDisplayTitle() :
220 $titleObj->getPrefixedText();
223 if ( isset( $prop['headitems'] ) ||
isset( $prop['headhtml'] ) ) {
224 $out = new OutputPage
;
225 $out->addParserOutputNoText( $p_result );
226 $userSkin = $wgUser->getSkin();
229 if ( isset( $prop['headitems'] ) ) {
230 $headItems = $this->formatHeadItems( $p_result->getHeadItems() );
232 $userSkin->setupUserCss( $out );
233 $css = $this->formatCss( $out->buildCssLinksArray() );
235 $scripts = array( $out->getHeadScripts( $userSkin ) );
237 $result_array['headitems'] = array_merge( $headItems , $css, $scripts );
240 if ( isset( $prop['headhtml'] ) ) {
241 $result_array['headhtml'] = array();
242 $result->setContent( $result_array['headhtml'], $out->headElement( $userSkin ) );
245 if ( isset( $prop['iwlinks'] ) ) {
246 $result_array['iwlinks'] = $this->formatIWLinks( $p_result->getInterwikiLinks() );
249 if ( !is_null( $oldid ) ) {
250 $result_array['revid'] = intval( $oldid );
253 $result_mapping = array(
256 'categories' => 'cl',
260 'externallinks' => 'el',
265 $this->setIndexedTagNames( $result_array, $result_mapping );
266 $result->addValue( null, $this->getModuleName(), $result_array );
268 if ( !is_null( $oldLang ) ) {
269 $wgLang = $oldLang; // Reset $wgLang to $oldLang
273 private function getSectionText( $text, $what ) {
275 $text = $wgParser->getSection( $text, $this->section
, false );
276 if ( $text === false ) {
277 $this->dieUsage( "There is no section {$this->section} in " . $what, 'nosuchsection' );
282 private function formatLangLinks( $links ) {
284 foreach ( $links as $link ) {
286 $bits = explode( ':', $link, 2 );
287 $entry['lang'] = $bits[0];
288 $this->getResult()->setContent( $entry, $bits[1] );
294 private function formatCategoryLinks( $links ) {
296 foreach ( $links as $link => $sortkey ) {
298 $entry['sortkey'] = $sortkey;
299 $this->getResult()->setContent( $entry, $link );
305 private function formatLinks( $links ) {
307 foreach ( $links as $ns => $nslinks ) {
308 foreach ( $nslinks as $title => $id ) {
311 $this->getResult()->setContent( $entry, Title
::makeTitle( $ns, $title )->getFullText() );
313 $entry['exists'] = '';
321 private function formatIWLinks( $iw ) {
323 foreach ( $iw as $prefix => $titles ) {
324 foreach ( $titles as $title => $id ) {
326 $entry['prefix'] = $prefix;
328 $title = Title
::newFromText( "{$prefix}:{$title}" );
330 $entry['url'] = $title->getFullURL();
333 $this->getResult()->setContent( $entry, $title->getFullText() );
340 private function formatHeadItems( $headItems ) {
342 foreach ( $headItems as $tag => $content ) {
344 $entry['tag'] = $tag;
345 $this->getResult()->setContent( $entry, $content );
351 private function formatCss( $css ) {
353 foreach ( $css as $file => $link ) {
355 $entry['file'] = $file;
356 $this->getResult()->setContent( $entry, $link );
362 private function setIndexedTagNames( &$array, $mapping ) {
363 foreach ( $mapping as $key => $name ) {
364 if ( isset( $array[$key] ) ) {
365 $this->getResult()->setIndexedTagName( $array[$key], $name );
370 public function getAllowedParams() {
373 ApiBase
::PARAM_DFLT
=> 'API',
379 'redirects' => false,
382 ApiBase
::PARAM_DFLT
=> 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
383 ApiBase
::PARAM_ISMULTI
=> true,
384 ApiBase
::PARAM_TYPE
=> array(
404 'disablepp' => false,
408 public function getParamDescription() {
409 $p = $this->getModulePrefix();
411 'text' => 'Wikitext to parse',
412 'summary' => 'Summary to parse',
413 'redirects' => "If the {$p}page parameter is set to a redirect, resolve it",
414 'title' => 'Title of page the text belongs to',
415 'page' => "Parse the content of this page. Cannot be used together with {$p}text and {$p}title",
416 'pageid' => "Parse the content of this page. Overrides {$p}page",
417 'oldid' => "Parse the content of this revision. Overrides {$p}page and {$p}pageid",
419 'Which pieces of information to get',
420 ' text - Gives the parsed text of the wikitext',
421 ' langlinks - Gives the langlinks the parsed wikitext',
422 ' categories - Gives the categories of the parsed wikitext',
423 ' links - Gives the internal links in the parsed wikitext',
424 ' templates - Gives the templates in the parsed wikitext',
425 ' images - Gives the images in the parsed wikitext',
426 ' externallinks - Gives the external links in the parsed wikitext',
427 ' sections - Gives the sections in the parsed wikitext',
428 ' revid - Adds the revision id of the parsed page',
429 ' displaytitle - Adds the title of the parsed wikitext',
430 ' headitems - Gives items to put in the <head> of the page',
431 ' headhtml - Gives parsed <head> of the page',
432 ' iwlinks - Gives interwiki links in the parsed wikitext',
433 'NOTE: Section tree is only generated if there are more than 4 sections, or if the __TOC__ keyword is present'
436 'Do a pre-save transform on the input before parsing it',
437 'Ignored if page, pageid or oldid is used'
440 'Do a pre-save transform (PST) on the input, but don\'t parse it',
441 'Returns the same wikitext, after a PST has been applied. Ignored if page, pageid or oldid is used'
443 'uselang' => 'Which language to parse the request in',
444 'section' => 'Only retrieve the content of this section number',
445 'disablepp' => 'Disable the PP Report from the parser output',
449 public function getDescription() {
450 return 'This module parses wikitext and returns parser output';
453 public function getPossibleErrors() {
454 return array_merge( parent
::getPossibleErrors(), array(
455 array( 'code' => 'params', 'info' => 'The page parameter cannot be used together with the text and title parameters' ),
456 array( 'code' => 'missingrev', 'info' => 'There is no revision ID oldid' ),
457 array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revisions' ),
458 array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ),
459 array( 'code' => 'nosuchsection', 'info' => 'There is no section sectionnumber in page' ),
460 array( 'nosuchpageid' ),
464 protected function getExamples() {
466 'api.php?action=parse&text={{Project:Sandbox}}'
470 public function getVersion() {
471 return __CLASS__
. ': $Id$';