* (bug 11173) Allow limited wikicode rendering via api.php

* (bug 11572) API should provide interface for expanding templates

Patches by VasilevVV

diff --git a/RELEASE-NOTES b/RELEASE-NOTES
index 0d33571..87b6d83 100644 (file)
--- a/RELEASE-NOTES
+++ b/RELEASE-NOTES
@@ -108,6 +108,8 @@ Full API documentation is available at http://www.mediawiki.org/wiki/API
 * Fixed rvlimit of the revisions query to only enforce the lower query limit if
   revision content is requested.
 * Include svn revision number (if install is checked-out from svn) in siteinfo query.
+* (bug 11173) Allow limited wikicode rendering via api.php
+* (bug 11572) API should provide interface for expanding templates
 
 === Languages updated in 1.12 ===
 

diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php
index 486bdaa..e1534fe 100644 (file)
--- a/includes/AutoLoader.php
+++ b/includes/AutoLoader.php
@@ -308,6 +308,7 @@ function __autoload($className) {
                'ApiLogin' => 'includes/api/ApiLogin.php',
                'ApiMain' => 'includes/api/ApiMain.php',
                'ApiOpenSearch' => 'includes/api/ApiOpenSearch.php',
+               'ApiExpandTemplates' => 'includes/api/ApiExpandTemplates.php',
                'ApiPageSet' => 'includes/api/ApiPageSet.php',
                'ApiQuery' => 'includes/api/ApiQuery.php',
                'ApiQueryAllpages' => 'includes/api/ApiQueryAllpages.php',
@@ -333,6 +334,7 @@ function __autoload($className) {
                'ApiQuerySiteinfo' => 'includes/api/ApiQuerySiteinfo.php',
                'ApiQueryUserInfo' => 'includes/api/ApiQueryUserInfo.php',
                'ApiQueryWatchlist' => 'includes/api/ApiQueryWatchlist.php',
+               'ApiRender' => 'includes/api/ApiRender.php',
                'ApiResult' => 'includes/api/ApiResult.php',
        );
        

diff --git a/includes/api/ApiExpandTemplates.php b/includes/api/ApiExpandTemplates.php
new file mode 100644 (file)
index 0000000..5cfb802
--- /dev/null
+++ b/includes/api/ApiExpandTemplates.php
@@ -0,0 +1,93 @@
+<?php\r
+\r
+/*\r
+ * Created on Oct 05, 2007\r
+ *\r
+ * API for MediaWiki 1.8+\r
+ *\r
+ * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com\r
+ *\r
+ * This program is free software; you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation; either version 2 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License along\r
+ * with this program; if not, write to the Free Software Foundation, Inc.,\r
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
+ * http://www.gnu.org/copyleft/gpl.html\r
+ */\r
+\r
+if (!defined('MEDIAWIKI')) {\r
+       // Eclipse helper - will be ignored in production\r
+       require_once ("ApiBase.php");\r
+}\r
+\r
+/**\r
+ * @addtogroup API\r
+ */\r
+class ApiExpandTemplates extends ApiBase {\r
+\r
+       public function __construct($main, $action) {\r
+               parent :: __construct($main, $action);\r
+       }\r
+\r
+       public function execute() {\r
+               // Get parameters\r
+               $params = $this->extractRequestParams();\r
+               $text = $params['text'];\r
+               $title = $params['title'];\r
+               $retval = '';\r
+\r
+               //Create title for parser\r
+               $title_obj = Title :: newFromText($params['title']);\r
+               if(!$title_obj)\r
+                       $title_obj = Title :: newFromText("API");       //  Default title is "API". For example, ExpandTemplates uses "ExpendTemplates" for it\r
+\r
+               // Parse text\r
+               global $wgParser;\r
+               $retval = $wgParser->preprocess( $text, $title_obj, new ParserOptions() );\r
+\r
+               // Return result\r
+               $result = $this->getResult();\r
+               $retval_array = array();\r
+               $result->setContent( $retval_array, $retval );\r
+               $result->addValue( null, 'expandtemplates', $retval_array );\r
+       }\r
+\r
+       protected function getAllowedParams() {\r
+               return array (\r
+                       'title' => array( \r
+                               ApiBase :: PARAM_DFLT => 'API',\r
+                       ),\r
+                       'text' => null\r
+               );\r
+       }\r
+\r
+       protected function getParamDescription() {\r
+               return array (\r
+                       'text' => 'Wikitext to convert',\r
+                       'title' => 'Title of page',\r
+               );\r
+       }\r
+\r
+       protected function getDescription() {\r
+               return 'This module expand all templates in wikitext';\r
+       }\r
+\r
+       protected function getExamples() {\r
+               return array (\r
+                       'api.php?action=expandtemplates&text={{Project:Sandbox}}'\r
+               );\r
+       }\r
+\r
+       public function getVersion() {\r
+               return __CLASS__ . ': $Id$';\r
+       }\r
+}\r
+\r

diff --git a/includes/api/ApiMain.php b/includes/api/ApiMain.php
index 49542e6..52ea73d 100644 (file)
--- a/includes/api/ApiMain.php
+++ b/includes/api/ApiMain.php
@@ -54,6 +54,8 @@ class ApiMain extends ApiBase {
        private static $Modules = array (
                'login' => 'ApiLogin',
                'query' => 'ApiQuery',
+               'expandtemplates' => 'ApiExpandTemplates',
+               'render' => 'ApiRender',
                'opensearch' => 'ApiOpenSearch',
                'feedwatchlist' => 'ApiFeedWatchlist',
                'help' => 'ApiHelp',
@@ -539,3 +541,4 @@ class UsageException extends Exception {
        }
 }
 
+

diff --git a/includes/api/ApiRender.php b/includes/api/ApiRender.php
new file mode 100644 (file)
index 0000000..ecb9967
--- /dev/null
+++ b/includes/api/ApiRender.php
@@ -0,0 +1,94 @@
+<?php\r
+\r
+/*\r
+ * Created on Oct 06, 2007\r
+ *\r
+ * API for MediaWiki 1.8+\r
+ *\r
+ * Copyright (C) 2007 Yuri Astrakhan <Firstname><Lastname>@gmail.com\r
+ *\r
+ * This program is free software; you can redistribute it and/or modify\r
+ * it under the terms of the GNU General Public License as published by\r
+ * the Free Software Foundation; either version 2 of the License, or\r
+ * (at your option) any later version.\r
+ *\r
+ * This program is distributed in the hope that it will be useful,\r
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of\r
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the\r
+ * GNU General Public License for more details.\r
+ *\r
+ * You should have received a copy of the GNU General Public License along\r
+ * with this program; if not, write to the Free Software Foundation, Inc.,\r
+ * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.\r
+ * http://www.gnu.org/copyleft/gpl.html\r
+ */\r
+\r
+if (!defined('MEDIAWIKI')) {\r
+       // Eclipse helper - will be ignored in production\r
+       require_once ("ApiBase.php");\r
+}\r
+\r
+/**\r
+ * @addtogroup API\r
+ */\r
+class ApiRender extends ApiBase {\r
+\r
+       public function __construct($main, $action) {\r
+               parent :: __construct($main, $action);\r
+       }\r
+\r
+       public function execute() {\r
+               // Get parameters\r
+               $params = $this->extractRequestParams();\r
+               $text = $params['text'];\r
+               $title = $params['title'];\r
+               $retval = '';\r
+\r
+               //Create title for parser\r
+               $title_obj = Title :: newFromText($params['title']);\r
+               if(!$title_obj)\r
+                       $title_obj = Title :: newFromText("API");       //  Default title is "API". For example, ExpandTemplates uses "ExpendTemplates" for it\r
+\r
+               // Parse text\r
+               global $wgParser;\r
+               $p_result = $wgParser->parse( $text, $title_obj, new ParserOptions() );\r
+               $retval = $p_result->getText();\r
+\r
+               // Return result\r
+               $result = $this->getResult();\r
+               $retval_array = array();\r
+               $result->setContent( $retval_array, $retval );\r
+               $result->addValue( null, 'render', $retval_array );\r
+       }\r
+\r
+       protected function getAllowedParams() {\r
+               return array (\r
+                       'title' => array( \r
+                               ApiBase :: PARAM_DFLT => 'API',\r
+                       ),\r
+                       'text' => null\r
+               );\r
+       }\r
+\r
+       protected function getParamDescription() {\r
+               return array (\r
+                       'text' => 'Wikitext to render',\r
+                       'title' => 'Title of page',\r
+               );\r
+       }\r
+\r
+       protected function getDescription() {\r
+               return 'This module allows to get rendered wikitext';\r
+       }\r
+\r
+       protected function getExamples() {\r
+               return array (\r
+                       'api.php?action=render&text={{Project:Sandbox}}'\r
+               );\r
+       }\r
+\r
+       public function getVersion() {\r
+               return __CLASS__ . ': $Id$';\r
+       }\r
+}\r
+\r