4 * Created on Dec 01, 2007
6 * API for MediaWiki 1.8+
8 * Copyright (C) 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');
49 $prop = array_flip($params['prop']);
52 // The parser needs $wgTitle to be set, apparently the
53 // $title parameter in Parser::parse isn't enough *sigh*
54 global $wgParser, $wgUser, $wgTitle;
55 $popts = new ParserOptions();
56 $popts->setTidy(true);
57 $popts->enableLimitReport();
59 if(!is_null($oldid) ||
!is_null($page))
63 # Don't use the parser cache
64 $rev = Revision
::newFromID($oldid);
66 $this->dieUsage("There is no revision ID $oldid", 'missingrev');
67 if(!$rev->userCan(Revision
::DELETED_TEXT
))
68 $this->dieUsage("You don't have permission to view deleted revisions", 'permissiondenied');
69 $text = $rev->getText( Revision
::FOR_THIS_USER
);
70 $titleObj = $rev->getTitle();
72 $p_result = $wgParser->parse($text, $titleObj, $popts);
76 if($params['redirects'])
78 $req = new FauxRequest(array(
83 $main = new ApiMain($req);
85 $data = $main->getResultData();
86 $redirValues = @$data['query']['redirects'];
88 foreach((array)$redirValues as $r)
93 $titleObj = Title
::newFromText($to);
95 $this->dieUsage("The page you specified doesn't exist", 'missingtitle');
97 $articleObj = new Article($titleObj);
98 if(isset($prop['revid']))
99 $oldid = $articleObj->getRevIdFetched();
100 // Try the parser cache first
101 $pcache = ParserCache
::singleton();
102 $p_result = $pcache->get($articleObj, $wgUser);
105 $p_result = $wgParser->parse($articleObj->getContent(), $titleObj, $popts);
106 global $wgUseParserCache;
107 if($wgUseParserCache)
108 $pcache->save($p_result, $articleObj, $popts);
114 $titleObj = Title
::newFromText($title);
116 $titleObj = Title
::newFromText("API");
117 $wgTitle = $titleObj;
118 if($params['pst'] ||
$params['onlypst'])
119 $text = $wgParser->preSaveTransform($text, $titleObj, $wgUser, $popts);
120 if($params['onlypst'])
122 // Build a result and bail out
123 $result_array['text'] = array();
124 $this->getResult()->setContent($result_array['text'], $text);
125 $this->getResult()->addValue(null, $this->getModuleName(), $result_array);
128 $p_result = $wgParser->parse($text, $titleObj, $popts);
132 $result = $this->getResult();
133 $result_array = array();
134 if($params['redirects'] && !is_null($redirValues))
135 $result_array['redirects'] = $redirValues;
136 if(isset($prop['text'])) {
137 $result_array['text'] = array();
138 $result->setContent($result_array['text'], $p_result->getText());
140 if(isset($prop['langlinks']))
141 $result_array['langlinks'] = $this->formatLangLinks($p_result->getLanguageLinks());
142 if(isset($prop['categories']))
143 $result_array['categories'] = $this->formatCategoryLinks($p_result->getCategories());
144 if(isset($prop['links']))
145 $result_array['links'] = $this->formatLinks($p_result->getLinks());
146 if(isset($prop['templates']))
147 $result_array['templates'] = $this->formatLinks($p_result->getTemplates());
148 if(isset($prop['images']))
149 $result_array['images'] = array_keys($p_result->getImages());
150 if(isset($prop['externallinks']))
151 $result_array['externallinks'] = array_keys($p_result->getExternalLinks());
152 if(isset($prop['sections']))
153 $result_array['sections'] = $p_result->getSections();
154 if(isset($prop['displaytitle']))
155 $result_array['displaytitle'] = $p_result->getDisplayTitle() ?
156 $p_result->getDisplayTitle() :
157 $titleObj->getPrefixedText();
159 $result_array['revid'] = intval($oldid);
161 $result_mapping = array(
164 'categories' => 'cl',
168 'externallinks' => 'el',
171 $this->setIndexedTagNames( $result_array, $result_mapping );
172 $result->addValue( null, $this->getModuleName(), $result_array );
175 private function formatLangLinks( $links ) {
177 foreach( $links as $link ) {
179 $bits = split( ':', $link, 2 );
180 $entry['lang'] = $bits[0];
181 $this->getResult()->setContent( $entry, $bits[1] );
187 private function formatCategoryLinks( $links ) {
189 foreach( $links as $link => $sortkey ) {
191 $entry['sortkey'] = $sortkey;
192 $this->getResult()->setContent( $entry, $link );
198 private function formatLinks( $links ) {
200 foreach( $links as $ns => $nslinks ) {
201 foreach( $nslinks as $title => $id ) {
204 $this->getResult()->setContent( $entry, Title
::makeTitle( $ns, $title )->getFullText() );
206 $entry['exists'] = '';
213 private function setIndexedTagNames( &$array, $mapping ) {
214 foreach( $mapping as $key => $name ) {
215 if( isset( $array[$key] ) )
216 $this->getResult()->setIndexedTagName( $array[$key], $name );
220 public function getAllowedParams() {
223 ApiBase
:: PARAM_DFLT
=> 'API',
227 'redirects' => false,
230 ApiBase
:: PARAM_DFLT
=> 'text|langlinks|categories|links|templates|images|externallinks|sections|revid|displaytitle',
231 ApiBase
:: PARAM_ISMULTI
=> true,
232 ApiBase
:: PARAM_TYPE
=> array(
250 public function getParamDescription() {
252 'text' => 'Wikitext to parse',
253 'redirects' => 'If the page parameter is set to a redirect, resolve it',
254 'title' => 'Title of page the text belongs to',
255 'page' => 'Parse the content of this page. Cannot be used together with text and title',
256 'oldid' => 'Parse the content of this revision. Overrides page',
257 'prop' => array('Which pieces of information to get.',
258 'NOTE: Section tree is only generated if there are more than 4 sections, or if the __TOC__ keyword is present'
260 'pst' => array( 'Do a pre-save transform on the input before parsing it.',
261 'Ignored if page or oldid is used.'
263 'onlypst' => array('Do a PST on the input, but don\'t parse it.',
264 'Returns PSTed wikitext. Ignored if page or oldid is used.'
269 public function getDescription() {
270 return 'This module parses wikitext and returns parser output';
273 protected function getExamples() {
275 'api.php?action=parse&text={{Project:Sandbox}}'
279 public function getVersion() {
280 return __CLASS__
. ': $Id$';