5 * Created on Dec 01, 2007
7 * Copyright © 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License as published by
11 * the Free Software Foundation; either version 2 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU General Public License for more details.
19 * You should have received a copy of the GNU General Public License along
20 * with this program; if not, write to the Free Software Foundation, Inc.,
21 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
22 * http://www.gnu.org/copyleft/gpl.html
27 if ( !defined( 'MEDIAWIKI' ) ) {
28 // Eclipse helper - will be ignored in production
29 require_once( "ApiBase.php" );
35 class ApiParse
extends ApiBase
{
39 public function __construct( $main, $action ) {
40 parent
::__construct( $main, $action );
43 public function execute() {
44 // The data is hot but user-dependent, like page views, so we set vary cookies
45 $this->getMain()->setCacheMode( 'anon-public-user-private' );
48 $params = $this->extractRequestParams();
49 $text = $params['text'];
50 $title = $params['title'];
51 $page = $params['page'];
52 $pageid = $params['pageid'];
53 $oldid = $params['oldid'];
55 if ( !is_null( $page ) && ( !is_null( $text ) ||
$title != 'API' ) ) {
56 $this->dieUsage( 'The page parameter cannot be used together with the text and title parameters', 'params' );
58 $prop = array_flip( $params['prop'] );
60 if ( isset( $params['section'] ) ) {
61 $this->section
= $params['section'];
63 $this->section
= false;
66 // The parser needs $wgTitle to be set, apparently the
67 // $title parameter in Parser::parse isn't enough *sigh*
68 global $wgParser, $wgUser, $wgTitle, $wgLang;
70 // Currently unnecessary, code to act as a safeguard against any change in current behaviour of uselang breaks
72 if ( isset( $params['uselang'] ) && $params['uselang'] != $wgLang->getCode() ) {
73 $oldLang = $wgLang; // Backup wgLang
74 $wgLang = Language
::factory( $params['uselang'] );
77 $popts = new ParserOptions();
78 $popts->setTidy( true );
79 $popts->enableLimitReport( !$params['disablepp'] );
81 if ( !is_null( $oldid ) ||
!is_null( $pageid ) ||
!is_null( $page ) ) {
82 if ( !is_null( $oldid ) ) {
83 // Don't use the parser cache
84 $rev = Revision
::newFromID( $oldid );
86 $this->dieUsage( "There is no revision ID $oldid", 'missingrev' );
88 if ( !$rev->userCan( Revision
::DELETED_TEXT
) ) {
89 $this->dieUsage( "You don't have permission to view deleted revisions", 'permissiondenied' );
92 $titleObj = $rev->getTitle();
96 // If for some reason the "oldid" is actually the current revision, it may be cached
97 if ( $titleObj->getLatestRevID() === intval( $oldid ) ) {
98 $articleObj = new Article( $titleObj );
100 $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid ) ;
103 $text = $rev->getText( Revision
::FOR_THIS_USER
);
105 $wgTitle = $titleObj;
107 if ( $this->section
!== false ) {
108 $text = $this->getSectionText( $text, 'r' . $rev );
111 $p_result = $wgParser->parse( $text, $titleObj, $popts );
114 if ( !is_null ( $pageid ) ) {
115 $titleObj = Title
::newFromID( $pageid );
118 $this->dieUsageMsg( array( 'nosuchpageid', $pageid ) );
121 if ( $params['redirects'] ) {
122 $req = new FauxRequest( array(
127 $main = new ApiMain( $req );
129 $data = $main->getResultData();
130 $redirValues = @$data['query']['redirects'];
132 foreach ( (array)$redirValues as $r ) {
138 $titleObj = Title
::newFromText( $to );
139 if ( !$titleObj ||
!$titleObj->exists() ) {
140 $this->dieUsage( "The page you specified doesn't exist", 'missingtitle' );
143 $wgTitle = $titleObj;
145 $articleObj = new Article( $titleObj );
146 if ( isset( $prop['revid'] ) ) {
147 $oldid = $articleObj->getRevIdFetched();
150 $p_result = $this->getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageid ) ;
153 $titleObj = Title
::newFromText( $title );
155 $titleObj = Title
::newFromText( 'API' );
157 $wgTitle = $titleObj;
159 if ( $this->section
!== false ) {
160 $text = $this->getSectionText( $text, $titleObj->getText() );
163 if ( $params['pst'] ||
$params['onlypst'] ) {
164 $text = $wgParser->preSaveTransform( $text, $titleObj, $wgUser, $popts );
166 if ( $params['onlypst'] ) {
167 // Build a result and bail out
168 $result_array['text'] = array();
169 $this->getResult()->setContent( $result_array['text'], $text );
170 $this->getResult()->addValue( null, $this->getModuleName(), $result_array );
173 $p_result = $wgParser->parse( $text, $titleObj, $popts );
177 $result = $this->getResult();
178 $result_array = array();
180 $result_array['title'] = $titleObj->getPrefixedText();
182 if ( !is_null( $oldid ) ) {
183 $result_array['revid'] = intval( $oldid );
186 if ( $params['redirects'] && !is_null( $redirValues ) ) {
187 $result_array['redirects'] = $redirValues;
190 if ( isset( $prop['text'] ) ) {
191 $result_array['text'] = array();
192 $result->setContent( $result_array['text'], $p_result->getText() );
195 if ( !is_null( $params['summary'] ) ) {
196 $result_array['parsedsummary'] = array();
197 $result->setContent( $result_array['parsedsummary'], $wgUser->getSkin()->formatComment( $params['summary'], $titleObj ) );
200 if ( isset( $prop['langlinks'] ) ) {
201 $result_array['langlinks'] = $this->formatLangLinks( $p_result->getLanguageLinks() );
203 if ( isset( $prop['languageshtml'] ) ) {
204 $languagesHtml = $this->languagesHtml( $p_result->getLanguageLinks() );
205 $result_array['languageshtml'] = array();
206 $result->setContent( $result_array['languageshtml'], $languagesHtml );
208 if ( isset( $prop['categories'] ) ) {
209 $result_array['categories'] = $this->formatCategoryLinks( $p_result->getCategories() );
211 if ( isset( $prop['categorieshtml'] ) ) {
212 $categoriesHtml = $this->categoriesHtml( $p_result->getCategories() );
213 $result_array['categorieshtml'] = array();
214 $result->setContent( $result_array['categorieshtml'], $categoriesHtml );
216 if ( isset( $prop['links'] ) ) {
217 $result_array['links'] = $this->formatLinks( $p_result->getLinks() );
219 if ( isset( $prop['templates'] ) ) {
220 $result_array['templates'] = $this->formatLinks( $p_result->getTemplates() );
222 if ( isset( $prop['images'] ) ) {
223 $result_array['images'] = array_keys( $p_result->getImages() );
225 if ( isset( $prop['externallinks'] ) ) {
226 $result_array['externallinks'] = array_keys( $p_result->getExternalLinks() );
228 if ( isset( $prop['sections'] ) ) {
229 $result_array['sections'] = $p_result->getSections();
232 if ( isset( $prop['displaytitle'] ) ) {
233 $result_array['displaytitle'] = $p_result->getDisplayTitle() ?
234 $p_result->getDisplayTitle() :
235 $titleObj->getPrefixedText();
238 if ( isset( $prop['headitems'] ) ||
isset( $prop['headhtml'] ) ) {
239 $out = new OutputPage
;
240 $out->addParserOutputNoText( $p_result );
241 $userSkin = $wgUser->getSkin();
244 if ( isset( $prop['headitems'] ) ) {
245 $headItems = $this->formatHeadItems( $p_result->getHeadItems() );
247 $userSkin->setupUserCss( $out );
248 $css = $this->formatCss( $out->buildCssLinksArray() );
250 $scripts = array( $out->getHeadScripts( $userSkin ) );
252 $result_array['headitems'] = array_merge( $headItems, $css, $scripts );
255 if ( isset( $prop['headhtml'] ) ) {
256 $result_array['headhtml'] = array();
257 $result->setContent( $result_array['headhtml'], $out->headElement( $userSkin ) );
260 if ( isset( $prop['iwlinks'] ) ) {
261 $result_array['iwlinks'] = $this->formatIWLinks( $p_result->getInterwikiLinks() );
264 $result_mapping = array(
267 'categories' => 'cl',
271 'externallinks' => 'el',
276 $this->setIndexedTagNames( $result_array, $result_mapping );
277 $result->addValue( null, $this->getModuleName(), $result_array );
279 if ( !is_null( $oldLang ) ) {
280 $wgLang = $oldLang; // Reset $wgLang to $oldLang
285 * @param $articleObj Article
286 * @param $titleObj Title
288 * @param $popts ParserOptions
289 * @return ParserOutput
291 private function getParsedSectionOrText( $articleObj, $titleObj, $popts, $pageId = null ) {
294 if ( $this->section
!== false ) {
295 $text = $this->getSectionText( $text, !is_null ( $pageId )
296 ?
'page id ' . $pageId : $titleObj->getText() );
298 return $wgParser->parse( $text, $titleObj, $popts );
300 // Try the parser cache first
301 return $articleObj->getParserOutput();
305 private function getSectionText( $text, $what ) {
307 $text = $wgParser->getSection( $text, $this->section
, false );
308 if ( $text === false ) {
309 $this->dieUsage( "There is no section {$this->section} in " . $what, 'nosuchsection' );
314 private function formatLangLinks( $links ) {
316 foreach ( $links as $link ) {
318 $bits = explode( ':', $link, 2 );
319 $entry['lang'] = $bits[0];
320 $this->getResult()->setContent( $entry, $bits[1] );
326 private function formatCategoryLinks( $links ) {
328 foreach ( $links as $link => $sortkey ) {
330 $entry['sortkey'] = $sortkey;
331 $this->getResult()->setContent( $entry, $link );
337 private function categoriesHtml( $categories ) {
338 global $wgOut, $wgUser;
339 $wgOut->addCategoryLinks( $categories );
340 $sk = $wgUser->getSkin();
341 return $sk->getCategories();
344 private function languagesHtml( $languages ) {
345 global $wgOut, $wgUser;
346 $wgOut->setLanguageLinks( $languages );
347 $sk = $wgUser->getSkin();
348 return $sk->otherLanguages();
351 private function formatLinks( $links ) {
353 foreach ( $links as $ns => $nslinks ) {
354 foreach ( $nslinks as $title => $id ) {
357 $this->getResult()->setContent( $entry, Title
::makeTitle( $ns, $title )->getFullText() );
359 $entry['exists'] = '';
367 private function formatIWLinks( $iw ) {
369 foreach ( $iw as $prefix => $titles ) {
370 foreach ( array_keys( $titles ) as $title ) {
372 $entry['prefix'] = $prefix;
374 $title = Title
::newFromText( "{$prefix}:{$title}" );
376 $entry['url'] = $title->getFullURL();
379 $this->getResult()->setContent( $entry, $title->getFullText() );
386 private function formatHeadItems( $headItems ) {
388 foreach ( $headItems as $tag => $content ) {
390 $entry['tag'] = $tag;
391 $this->getResult()->setContent( $entry, $content );
397 private function formatCss( $css ) {
399 foreach ( $css as $file => $link ) {
401 $entry['file'] = $file;
402 $this->getResult()->setContent( $entry, $link );
408 private function setIndexedTagNames( &$array, $mapping ) {
409 foreach ( $mapping as $key => $name ) {
410 if ( isset( $array[$key] ) ) {
411 $this->getResult()->setIndexedTagName( $array[$key], $name );
416 public function getAllowedParams() {
419 ApiBase
::PARAM_DFLT
=> 'API',
425 'redirects' => false,
428 ApiBase
::PARAM_DFLT
=> 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
429 ApiBase
::PARAM_ISMULTI
=> true,
430 ApiBase
::PARAM_TYPE
=> array(
452 'disablepp' => false,
456 public function getParamDescription() {
457 $p = $this->getModulePrefix();
459 'text' => 'Wikitext to parse',
460 'summary' => 'Summary to parse',
461 'redirects' => "If the {$p}page parameter is set to a redirect, resolve it",
462 'title' => 'Title of page the text belongs to',
463 'page' => "Parse the content of this page. Cannot be used together with {$p}text and {$p}title",
464 'pageid' => "Parse the content of this page. Overrides {$p}page",
465 'oldid' => "Parse the content of this revision. Overrides {$p}page and {$p}pageid",
467 'Which pieces of information to get',
468 ' text - Gives the parsed text of the wikitext',
469 ' langlinks - Gives the language links in the parsed wikitext',
470 ' categories - Gives the categories in the parsed wikitext',
471 ' categorieshtml - Gives the HTML version of the categories',
472 ' languageshtml - Gives the HTML version of the language links',
473 ' links - Gives the internal links in the parsed wikitext',
474 ' templates - Gives the templates in the parsed wikitext',
475 ' images - Gives the images in the parsed wikitext',
476 ' externallinks - Gives the external links in the parsed wikitext',
477 ' sections - Gives the sections in the parsed wikitext',
478 ' revid - Adds the revision ID of the parsed page',
479 ' displaytitle - Adds the title of the parsed wikitext',
480 ' headitems - Gives items to put in the <head> of the page',
481 ' headhtml - Gives parsed <head> of the page',
482 ' iwlinks - Gives interwiki links in the parsed wikitext',
483 'NOTE: Section tree is only generated if there are more than 4 sections, or if the __TOC__ keyword is present'
486 'Do a pre-save transform on the input before parsing it',
487 'Ignored if page, pageid or oldid is used'
490 'Do a pre-save transform (PST) on the input, but don\'t parse it',
491 'Returns the same wikitext, after a PST has been applied. Ignored if page, pageid or oldid is used'
493 'uselang' => 'Which language to parse the request in',
494 'section' => 'Only retrieve the content of this section number',
495 'disablepp' => 'Disable the PP Report from the parser output',
499 public function getDescription() {
500 return 'This module parses wikitext and returns parser output';
503 public function getPossibleErrors() {
504 return array_merge( parent
::getPossibleErrors(), array(
505 array( 'code' => 'params', 'info' => 'The page parameter cannot be used together with the text and title parameters' ),
506 array( 'code' => 'missingrev', 'info' => 'There is no revision ID oldid' ),
507 array( 'code' => 'permissiondenied', 'info' => 'You don\'t have permission to view deleted revisions' ),
508 array( 'code' => 'missingtitle', 'info' => 'The page you specified doesn\'t exist' ),
509 array( 'code' => 'nosuchsection', 'info' => 'There is no section sectionnumber in page' ),
510 array( 'nosuchpageid' ),
514 protected function getExamples() {
516 'api.php?action=parse&text={{Project:Sandbox}}'
520 public function getVersion() {
521 return __CLASS__
. ': $Id$';