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                 $prop = array_flip($params['prop']);
  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                 if(isset($prop['text'])) {
  60                         $result_array['text'] = array();
  61                         $result->setContent($result_array['text'], $p_result->getText());
  62                 }
  63                 if(isset($prop['langlinks']))
  64                         $result_array['langlinks'] = $this->formatLangLinks($p_result->getLanguageLinks());
  65                 if(isset($prop['categories']))
  66                         $result_array['categories'] = $this->formatCategoryLinks($p_result->getCategories());
  67                 if(isset($prop['links']))
  68                         $result_array['links'] = $this->formatLinks($p_result->getLinks());
  69                 if(isset($prop['templates']))
  70                         $result_array['templates'] = $this->formatLinks($p_result->getTemplates());
  71                 if(isset($prop['images']))
  72                         $result_array['images'] = array_keys($p_result->getImages());
  73                 if(isset($prop['externallinks']))
  74                         $result_array['externallinks'] = array_keys($p_result->getExternalLinks());
  75                 if(isset($prop['sections']))
  76                         $result_array['sections'] = $p_result->getSections();
  77
  78                 $result_mapping = array(
  79                         'langlinks' => 'll',
  80                         'categories' => 'cl',
  81                         'links' => 'pl',
  82                         'templates' => 'tl',
  83                         'images' => 'img',
  84                         'externallinks' => 'el',
  85                         'sections' => 's',
  86                 );
  87                 $this->setIndexedTagNames( $result_array, $result_mapping );
  88                 $result->addValue( null, $this->getModuleName(), $result_array );
  89         }
  90
  91         private function formatLangLinks( $links ) {
  92                 $result = array();
  93                 foreach( $links as $link ) {
  94                         $entry = array();
  95                         $bits = split( ':', $link, 2 );
  96                         $entry['lang'] = $bits[0];
  97                         $this->getResult()->setContent( $entry, $bits[1] );
  98                         $result[] = $entry;
  99                 }
 100                 return $result;
 101         }
 102
 103         private function formatCategoryLinks( $links ) {
 104                 $result = array();
 105                 foreach( $links as $link => $sortkey ) {
 106                         $entry = array();
 107                         $entry['sortkey'] = $sortkey;
 108                         $this->getResult()->setContent( $entry, $link );
 109                         $result[] = $entry;
 110                 }
 111                 return $result;
 112         }
 113
 114         private function formatLinks( $links ) {
 115                 $result = array();
 116                 foreach( $links as $ns => $nslinks ) {
 117                         foreach( $nslinks as $title => $id ) {
 118                                 $entry = array();
 119                                 $entry['ns'] = $ns;
 120                                 $this->getResult()->setContent( $entry, Title::makeTitle( $ns, $title )->getFullText() );
 121                                 if( $id != 0 )
 122                                         $entry['exists'] = '';
 123                                 $result[] = $entry;
 124                         }
 125                 }
 126                 return $result;
 127         }
 128
 129         private function setIndexedTagNames( &$array, $mapping ) {
 130                 foreach( $mapping as $key => $name ) {
 131                         if( isset( $array[$key] ) )
 132                                 $this->getResult()->setIndexedTagName( $array[$key], $name );
 133                 }
 134         }
 135
 136         protected function getAllowedParams() {
 137                 return array (
 138                         'title' => array(
 139                                 ApiBase :: PARAM_DFLT => 'API',
 140                         ),
 141                         'text' => null,
 142                         'prop' => array(
 143                                 ApiBase :: PARAM_DFLT => 'text|langlinks|categories|links|templates|images|externallinks|sections',
 144                                 ApiBase :: PARAM_ISMULTI => true,
 145                                 ApiBase :: PARAM_TYPE => array(
 146                                         'text',
 147                                         'langlinks',
 148                                         'categories',
 149                                         'links',
 150                                         'templates',
 151                                         'images',
 152                                         'externallinks',
 153                                         'sections'
 154                                 )
 155                         )
 156                 );
 157         }
 158
 159         protected function getParamDescription() {
 160                 return array (
 161                         'text' => 'Wikitext to parse',
 162                         'title' => 'Title of page',
 163                         'prop' => 'Which pieces of information to get'
 164                 );
 165         }
 166
 167         protected function getDescription() {
 168                 return 'This module parses wikitext and returns parser output';
 169         }
 170
 171         protected function getExamples() {
 172                 return array (
 173                         'api.php?action=parse&text={{Project:Sandbox}}'
 174                 );
 175         }
 176
 177         public function getVersion() {
 178                 return __CLASS__ . ': $Id$';
 179         }
 180 }
 181