1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
|
<?php
/*
* Created on Dec 01, 2007
*
* API for MediaWiki 1.8+
*
* Copyright (C) 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;
global $wgParser, $wgUser;
$popts = new ParserOptions();
$popts->setTidy(true);
$popts->enableLimitReport();
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->getRawText();
$titleObj = $rev->getTitle();
$p_result = $wgParser->parse($text, $titleObj, $popts);
}
else
{
$titleObj = Title::newFromText($page);
if(!$titleObj)
$this->dieUsage("The page you specified doesn't exist", 'missingtitle');
// Try the parser cache first
$articleObj = new Article($titleObj);
if(isset($prop['revid']))
$oldid = $articleObj->getRevIdFetched();
$pcache = ParserCache::singleton();
$p_result = $pcache->get($articleObj, $wgUser);
if(!$p_result) {
$p_result = $wgParser->parse($articleObj->getContent(), $titleObj, $popts);
global $wgUseParserCache;
if($wgUseParserCache)
$pcache->save($p_result, $articleObj, $wgUser);
}
}
}
else
{
$titleObj = Title::newFromText($title);
if(!$titleObj)
$titleObj = Title::newFromText("API");
$p_result = $wgParser->parse($text, $titleObj, $popts);
}
// Return result
$result = $this->getResult();
$result_array = array();
if(isset($prop['text'])) {
$result_array['text'] = array();
$result->setContent($result_array['text'], $p_result->getText());
}
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(!is_null($oldid))
$result_array['revid'] = $oldid;
$result_mapping = array(
'langlinks' => 'll',
'categories' => 'cl',
'links' => 'pl',
'templates' => 'tl',
'images' => 'img',
'externallinks' => 'el',
'sections' => 's',
);
$this->setIndexedTagNames( $result_array, $result_mapping );
$result->addValue( null, $this->getModuleName(), $result_array );
}
private function formatLangLinks( $links ) {
$result = array();
foreach( $links as $link ) {
$entry = array();
$bits = split( ':', $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 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,
'page' => null,
'oldid' => null,
'prop' => array(
ApiBase :: PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections|revid',
ApiBase :: PARAM_ISMULTI => true,
ApiBase :: PARAM_TYPE => array(
'text',
'langlinks',
'categories',
'links',
'templates',
'images',
'externallinks',
'sections',
'revid'
)
)
);
}
public function getParamDescription() {
return array (
'text' => 'Wikitext to parse',
'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'
),
);
}
public function getDescription() {
return 'This module parses wikitext and returns parser output';
}
protected function getExamples() {
return array (
'api.php?action=parse&text={{Project:Sandbox}}'
);
}
public function getVersion() {
return __CLASS__ . ': $Id: ApiParse.php 36983 2008-07-03 15:01:50Z catrope $';
}
}
|
