* Parser now returns list of sections (for API; some extensions probably also need it)
[lhc/web/wiklou.git] / includes / api / ApiParse.php
1 <?php
2
3 /*
4 * Created on Dec 01, 2007
5 *
6 * API for MediaWiki 1.8+
7 *
8 * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com
9 *
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.
14 *
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.
19 *
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
24 */
25
26 if (!defined('MEDIAWIKI')) {
27 // Eclipse helper - will be ignored in production
28 require_once ("ApiBase.php");
29 }
30
31 /**
32 * @addtogroup API
33 */
34 class ApiParse extends ApiBase {
35
36 public function __construct($main, $action) {
37 parent :: __construct($main, $action);
38 }
39
40 public function execute() {
41 // Get parameters
42 $params = $this->extractRequestParams();
43 $text = $params['text'];
44 $title = $params['title'];
45 $retval = '';
46
47 //Create title for parser
48 $title_obj = Title :: newFromText($params['title']);
49 if(!$title_obj)
50 $title_obj = Title :: newFromText("API"); // Default title is "API". For example, ExpandTemplates uses "ExpendTemplates" for it
51
52 // Parse text
53 global $wgParser;
54 $p_result = $wgParser->parse( $text, $title_obj, new ParserOptions() );
55
56 // Return result
57 $result = $this->getResult();
58 $result_array = array(
59 'text' => array(),
60 'langlinks' => $this->formatLangLinks( $p_result->getLanguageLinks() ),
61 'categories' => $this->formatCategoryLinks( $p_result->getCategories() ),
62 'links' => $this->formatLinks( $p_result->getLinks() ),
63 'templates' => $this->formatLinks( $p_result->getTemplates() ),
64 'images' => array_keys( $p_result->getImages() ),
65 'externallinks' => array_keys( $p_result->getExternalLinks() ),
66 'sections' => $p_result->getSections(),
67 );
68 $result_mapping = array(
69 'langlinks' => 'll',
70 'categories' => 'cl',
71 'links' => 'pl',
72 'templates' => 'tl',
73 'images' => 'img',
74 'externallinks' => 'el',
75 'sections' => 's',
76 );
77 $this->setIndexedTagNames( $result_array, $result_mapping );
78 $result->setContent( $result_array['text'], $p_result->getText() );
79 $result->addValue( null, $this->getModuleName(), $result_array );
80 }
81
82 private function formatLangLinks( $links ) {
83 $result = array();
84 foreach( $links as $link ) {
85 $entry = array();
86 $bits = split( ':', $link, 2 );
87 $entry['lang'] = $bits[0];
88 $this->getResult()->setContent( $entry, $bits[1] );
89 $result[] = $entry;
90 }
91 return $result;
92 }
93
94 private function formatCategoryLinks( $links ) {
95 $result = array();
96 foreach( $links as $link => $sortkey ) {
97 $entry = array();
98 $entry['sortkey'] = $sortkey;
99 $this->getResult()->setContent( $entry, $link );
100 $result[] = $entry;
101 }
102 return $result;
103 }
104
105 private function formatLinks( $links ) {
106 $result = array();
107 foreach( $links as $ns => $nslinks ) {
108 foreach( $nslinks as $title => $id ) {
109 $entry = array();
110 $entry['ns'] = $ns;
111 $this->getResult()->setContent( $entry, Title::makeTitle( $ns, $title )->getFullText() );
112 if( $id != 0 )
113 $entry['exists'] = '';
114 $result[] = $entry;
115 }
116 }
117 return $result;
118 }
119
120 private function setIndexedTagNames( &$array, $mapping ) {
121 foreach( $mapping as $key => $name ) {
122 if( isset( $array[$key] ) )
123 $this->getResult()->setIndexedTagName( $array[$key], $name );
124 }
125 }
126
127 protected function getAllowedParams() {
128 return array (
129 'title' => array(
130 ApiBase :: PARAM_DFLT => 'API',
131 ),
132 'text' => null
133 );
134 }
135
136 protected function getParamDescription() {
137 return array (
138 'text' => 'Wikitext to parse',
139 'title' => 'Title of page',
140 );
141 }
142
143 protected function getDescription() {
144 return 'This module parses wikitext and returns parser output';
145 }
146
147 protected function getExamples() {
148 return array (
149 'api.php?action=parse&text={{Project:Sandbox}}'
150 );
151 }
152
153 public function getVersion() {
154 return __CLASS__ . ': $Id$';
155 }
156 }
157