dépôts / lhc / web / wiklou.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | inline | side by side
Revert changes to SpecialSearch.php in r70608 because Special:Search didn't load...
[lhc/web/wiklou.git] / includes / api / ApiQuery.php
diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php
index 44daf13..cb7080d 100644 (file)
--- a/includes/api/ApiQuery.php
+++ b/includes/api/ApiQuery.php
@@ -1,11 +1,11 @@
 <?php
 
 <?php
 
-/*
+/**
  * Created on Sep 7, 2006
  *
  * API for MediaWiki 1.8+
  *
  * Created on Sep 7, 2006
  *
  * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Copyright © 2006 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
  *
  * 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
@@ -19,13 +19,13 @@
  *
  * 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.,
  *
  * 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.
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  * http://www.gnu.org/copyleft/gpl.html
  */
 
  * http://www.gnu.org/copyleft/gpl.html
  */
 
-if (!defined('MEDIAWIKI')) {
+if ( !defined( 'MEDIAWIKI' ) ) {
        // Eclipse helper - will be ignored in production
        // Eclipse helper - will be ignored in production
-       require_once ('ApiBase.php');
+       require_once( 'ApiBase.php' );
 }
 
 /**
 }
 
 /**
@@ -43,12 +43,13 @@ class ApiQuery extends ApiBase {
 
        private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames;
        private $mPageSet;
 
        private $mPropModuleNames, $mListModuleNames, $mMetaModuleNames;
        private $mPageSet;
-       private $params, $redirect;
+       private $params;
 
 
-       private $mQueryPropModules = array (
+       private $mQueryPropModules = array(
                'info' => 'ApiQueryInfo',
                'revisions' => 'ApiQueryRevisions',
                'links' => 'ApiQueryLinks',
                'info' => 'ApiQueryInfo',
                'revisions' => 'ApiQueryRevisions',
                'links' => 'ApiQueryLinks',
+               'iwlinks' => 'ApiQueryIWLinks',
                'langlinks' => 'ApiQueryLangLinks',
                'images' => 'ApiQueryImages',
                'imageinfo' => 'ApiQueryImageInfo',
                'langlinks' => 'ApiQueryLangLinks',
                'images' => 'ApiQueryImages',
                'imageinfo' => 'ApiQueryImageInfo',
@@ -59,7 +60,7 @@ class ApiQuery extends ApiBase {
                'duplicatefiles' => 'ApiQueryDuplicateFiles',
        );
 
                'duplicatefiles' => 'ApiQueryDuplicateFiles',
        );
 
-       private $mQueryListModules = array (
+       private $mQueryListModules = array(
                'allimages' => 'ApiQueryAllimages',
                'allpages' => 'ApiQueryAllpages',
                'alllinks' => 'ApiQueryAllLinks',
                'allimages' => 'ApiQueryAllimages',
                'allpages' => 'ApiQueryAllpages',
                'alllinks' => 'ApiQueryAllLinks',
@@ -70,10 +71,13 @@ class ApiQuery extends ApiBase {
                'categorymembers' => 'ApiQueryCategoryMembers',
                'deletedrevs' => 'ApiQueryDeletedrevs',
                'embeddedin' => 'ApiQueryBacklinks',
                'categorymembers' => 'ApiQueryCategoryMembers',
                'deletedrevs' => 'ApiQueryDeletedrevs',
                'embeddedin' => 'ApiQueryBacklinks',
+               'filearchive' => 'ApiQueryFilearchive',
                'imageusage' => 'ApiQueryBacklinks',
                'imageusage' => 'ApiQueryBacklinks',
+               'iwbacklinks' => 'ApiQueryIWBacklinks',
                'logevents' => 'ApiQueryLogEvents',
                'recentchanges' => 'ApiQueryRecentChanges',
                'search' => 'ApiQuerySearch',
                'logevents' => 'ApiQueryLogEvents',
                'recentchanges' => 'ApiQueryRecentChanges',
                'search' => 'ApiQuerySearch',
+               'tags' => 'ApiQueryTags',
                'usercontribs' => 'ApiQueryContributions',
                'watchlist' => 'ApiQueryWatchlist',
                'watchlistraw' => 'ApiQueryWatchlistRaw',
                'usercontribs' => 'ApiQueryContributions',
                'watchlist' => 'ApiQueryWatchlist',
                'watchlistraw' => 'ApiQueryWatchlistRaw',
@@ -83,7 +87,7 @@ class ApiQuery extends ApiBase {
                'protectedtitles' => 'ApiQueryProtectedTitles',
        );
 
                'protectedtitles' => 'ApiQueryProtectedTitles',
        );
 
-       private $mQueryMetaModules = array (
+       private $mQueryMetaModules = array(
                'siteinfo' => 'ApiQuerySiteinfo',
                'userinfo' => 'ApiQueryUserInfo',
                'allmessages' => 'ApiQueryAllmessages',
                'siteinfo' => 'ApiQuerySiteinfo',
                'userinfo' => 'ApiQueryUserInfo',
                'allmessages' => 'ApiQueryAllmessages',
@@ -92,22 +96,22 @@ class ApiQuery extends ApiBase {
        private $mSlaveDB = null;
        private $mNamedDB = array();
 
        private $mSlaveDB = null;
        private $mNamedDB = array();
 
-       public function __construct($main, $action) {
-               parent :: __construct($main, $action);
+       public function __construct( $main, $action ) {
+               parent::__construct( $main, $action );
 
                // Allow custom modules to be added in LocalSettings.php
                global $wgAPIPropModules, $wgAPIListModules, $wgAPIMetaModules;
 
                // Allow custom modules to be added in LocalSettings.php
                global $wgAPIPropModules, $wgAPIListModules, $wgAPIMetaModules;
-               self :: appendUserModules($this->mQueryPropModules, $wgAPIPropModules);
-               self :: appendUserModules($this->mQueryListModules, $wgAPIListModules);
-               self :: appendUserModules($this->mQueryMetaModules, $wgAPIMetaModules);
+               self::appendUserModules( $this->mQueryPropModules, $wgAPIPropModules );
+               self::appendUserModules( $this->mQueryListModules, $wgAPIListModules );
+               self::appendUserModules( $this->mQueryMetaModules, $wgAPIMetaModules );
 
 
-               $this->mPropModuleNames = array_keys($this->mQueryPropModules);
-               $this->mListModuleNames = array_keys($this->mQueryListModules);
-               $this->mMetaModuleNames = array_keys($this->mQueryMetaModules);
+               $this->mPropModuleNames = array_keys( $this->mQueryPropModules );
+               $this->mListModuleNames = array_keys( $this->mQueryListModules );
+               $this->mMetaModuleNames = array_keys( $this->mQueryMetaModules );
 
                // Allow the entire list of modules at first,
                // but during module instantiation check if it can be used as a generator.
 
                // Allow the entire list of modules at first,
                // but during module instantiation check if it can be used as a generator.
-               $this->mAllowedGenerators = array_merge($this->mListModuleNames, $this->mPropModuleNames);
+               $this->mAllowedGenerators = array_merge( $this->mListModuleNames, $this->mPropModuleNames );
        }
 
        /**
        }
 
        /**
@@ -115,9 +119,9 @@ class ApiQuery extends ApiBase {
         * @param $modules array Module array
         * @param $newModules array Module array to add to $modules
         */
         * @param $modules array Module array
         * @param $newModules array Module array to add to $modules
         */
-       private static function appendUserModules(&$modules, $newModules) {
-               if (is_array( $newModules )) {
-                       foreach ( $newModules as $moduleName => $moduleClass) {
+       private static function appendUserModules( &$modules, $newModules ) {
+               if ( is_array( $newModules ) ) {
+                       foreach ( $newModules as $moduleName => $moduleClass ) {
                                $modules[$moduleName] = $moduleClass;
                        }
                }
                                $modules[$moduleName] = $moduleClass;
                        }
                }
@@ -128,9 +132,9 @@ class ApiQuery extends ApiBase {
         * @return Database
         */
        public function getDB() {
         * @return Database
         */
        public function getDB() {
-               if (!isset ($this->mSlaveDB)) {
+               if ( !isset( $this->mSlaveDB ) ) {
                        $this->profileDBIn();
                        $this->profileDBIn();
-                       $this->mSlaveDB = wfGetDB(DB_SLAVE,'api');
+                       $this->mSlaveDB = wfGetDB( DB_SLAVE, 'api' );
                        $this->profileDBOut();
                }
                return $this->mSlaveDB;
                        $this->profileDBOut();
                }
                return $this->mSlaveDB;
@@ -146,10 +150,10 @@ class ApiQuery extends ApiBase {
         * @param $groups array Query groups
         * @return Database
         */
         * @param $groups array Query groups
         * @return Database
         */
-       public function getNamedDB($name, $db, $groups) {
-               if (!array_key_exists($name, $this->mNamedDB)) {
+       public function getNamedDB( $name, $db, $groups ) {
+               if ( !array_key_exists( $name, $this->mNamedDB ) ) {
                        $this->profileDBIn();
                        $this->profileDBIn();
-                       $this->mNamedDB[$name] = wfGetDB($db, $groups);
+                       $this->mNamedDB[$name] = wfGetDB( $db, $groups );
                        $this->profileDBOut();
                }
                return $this->mNamedDB[$name];
                        $this->profileDBOut();
                }
                return $this->mNamedDB[$name];
@@ -168,15 +172,40 @@ class ApiQuery extends ApiBase {
         * @return array(modulename => classname)
         */
        function getModules() {
         * @return array(modulename => classname)
         */
        function getModules() {
-               return array_merge($this->mQueryPropModules, $this->mQueryListModules, $this->mQueryMetaModules);
+               return array_merge( $this->mQueryPropModules, $this->mQueryListModules, $this->mQueryMetaModules );
        }
        }
-       
+
+       /**
+        * Get whether the specified module is a prop, list or a meta query module
+        * @param $moduleName string Name of the module to find type for
+        * @return mixed string or null
+        */
+       function getModuleType( $moduleName ) {
+               if ( array_key_exists ( $moduleName, $this->mQueryPropModules ) ) {
+                       return 'prop';
+               }
+
+               if ( array_key_exists ( $moduleName, $this->mQueryListModules ) ) {
+                       return 'list';
+               }
+
+               if ( array_key_exists ( $moduleName, $this->mQueryMetaModules ) ) {
+                       return 'meta';
+               }
+
+               return null;
+       }
+
        public function getCustomPrinter() {
                // If &exportnowrap is set, use the raw formatter
        public function getCustomPrinter() {
                // If &exportnowrap is set, use the raw formatter
-               if ($this->getParameter('exportnowrap'))
-                       return new ApiFormatRaw($this->getMain());
-               else
+               if ( $this->getParameter( 'export' ) &&
+                               $this->getParameter( 'exportnowrap' ) )
+               {
+                       return new ApiFormatRaw( $this->getMain(),
+                               $this->getMain()->createPrinterByName( 'xml' ) );
+               } else {
                        return null;
                        return null;
+               }
        }
 
        /**
        }
 
        /**
@@ -190,48 +219,68 @@ class ApiQuery extends ApiBase {
         * #5 Execute all requested modules
         */
        public function execute() {
         * #5 Execute all requested modules
         */
        public function execute() {
-
                $this->params = $this->extractRequestParams();
                $this->redirects = $this->params['redirects'];
                $this->params = $this->extractRequestParams();
                $this->redirects = $this->params['redirects'];
+               $this->convertTitles = $this->params['converttitles'];
 
 
-               //
                // Create PageSet
                // Create PageSet
-               //
-               $this->mPageSet = new ApiPageSet($this, $this->redirects);
+               $this->mPageSet = new ApiPageSet( $this, $this->redirects, $this->convertTitles );
 
 
-               //
                // Instantiate requested modules
                // Instantiate requested modules
-               //
-               $modules = array ();
-               $this->InstantiateModules($modules, 'prop', $this->mQueryPropModules);
-               $this->InstantiateModules($modules, 'list', $this->mQueryListModules);
-               $this->InstantiateModules($modules, 'meta', $this->mQueryMetaModules);
+               $modules = array();
+               $this->instantiateModules( $modules, 'prop', $this->mQueryPropModules );
+               $this->instantiateModules( $modules, 'list', $this->mQueryListModules );
+               $this->instantiateModules( $modules, 'meta', $this->mQueryMetaModules );
+
+               $cacheMode = 'public';
 
 
-               //
                // If given, execute generator to substitute user supplied data with generated data.
                // If given, execute generator to substitute user supplied data with generated data.
-               //
-               if (isset ($this->params['generator'])) {
-                       $this->executeGeneratorModule($this->params['generator'], $modules);
+               if ( isset( $this->params['generator'] ) ) {
+                       $generator = $this->newGenerator( $this->params['generator'] );
+                       $params = $generator->extractRequestParams();
+                       $cacheMode = $this->mergeCacheMode( $cacheMode,
+                               $generator->getCacheMode( $params ) );
+                       $this->executeGeneratorModule( $generator, $modules );
                } else {
                        // Append custom fields and populate page/revision information
                } else {
                        // Append custom fields and populate page/revision information
-                       $this->addCustomFldsToPageSet($modules, $this->mPageSet);
+                       $this->addCustomFldsToPageSet( $modules, $this->mPageSet );
                        $this->mPageSet->execute();
                }
 
                        $this->mPageSet->execute();
                }
 
-               //
                // Record page information (title, namespace, if exists, etc)
                // Record page information (title, namespace, if exists, etc)
-               //
                $this->outputGeneralPageInfo();
 
                $this->outputGeneralPageInfo();
 
-               //
                // Execute all requested modules.
                // Execute all requested modules.
-               //
-               foreach ($modules as $module) {
+               foreach ( $modules as $module ) {
+                       $params = $module->extractRequestParams();
+                       $cacheMode = $this->mergeCacheMode(
+                               $cacheMode, $module->getCacheMode( $params ) );
                        $module->profileIn();
                        $module->execute();
                        $module->profileIn();
                        $module->execute();
-                       wfRunHooks('APIQueryAfterExecute', array(&$module));
+                       wfRunHooks( 'APIQueryAfterExecute', array( &$module ) );
                        $module->profileOut();
                }
                        $module->profileOut();
                }
+
+               // Set the cache mode
+               $this->getMain()->setCacheMode( $cacheMode );
+       }
+
+       /**
+        * Update a cache mode string, applying the cache mode of a new module to it.
+        * The cache mode may increase in the level of privacy, but public modules
+        * added to private data do not decrease the level of privacy.
+        */
+       protected function mergeCacheMode( $cacheMode, $modCacheMode ) {
+               if ( $modCacheMode === 'anon-public-user-private' ) {
+                       if ( $cacheMode !== 'private' ) {
+                               $cacheMode = 'anon-public-user-private';
+                       }
+               } elseif ( $modCacheMode === 'public' ) {
+                       // do nothing, if it's public already it will stay public
+               } else { // private
+                       $cacheMode = 'private';
+               }
+               return $cacheMode;
        }
 
        /**
        }
 
        /**
@@ -241,10 +290,10 @@ class ApiQuery extends ApiBase {
         * @param $modules array of module objects
         * @param $pageSet ApiPageSet
         */
         * @param $modules array of module objects
         * @param $pageSet ApiPageSet
         */
-       private function addCustomFldsToPageSet($modules, $pageSet) {
+       private function addCustomFldsToPageSet( $modules, $pageSet ) {
                // Query all requested modules.
                // Query all requested modules.
-               foreach ($modules as $module) {
-                       $module->requestExtraData($pageSet);
+               foreach ( $modules as $module ) {
+                       $module->requestExtraData( $pageSet );
                }
        }
 
                }
        }
 
@@ -254,11 +303,13 @@ class ApiQuery extends ApiBase {
         * @param $param string Parameter name to read modules from
         * @param $moduleList array(modulename => classname)
         */
         * @param $param string Parameter name to read modules from
         * @param $moduleList array(modulename => classname)
         */
-       private function InstantiateModules(&$modules, $param, $moduleList) {
+       private function instantiateModules( &$modules, $param, $moduleList ) {
                $list = @$this->params[$param];
                $list = @$this->params[$param];
-               if (!is_null ($list))
-                       foreach ($list as $moduleName)
-                               $modules[] = new $moduleList[$moduleName] ($this, $moduleName);
+               if ( !is_null ( $list ) ) {
+                       foreach ( $list as $moduleName ) {
+                               $modules[] = new $moduleList[$moduleName] ( $this, $moduleName );
+                       }
+               }
        }
 
        /**
        }
 
        /**
@@ -267,184 +318,217 @@ class ApiQuery extends ApiBase {
         * and missing or invalid title/pageids/revids.
         */
        private function outputGeneralPageInfo() {
         * and missing or invalid title/pageids/revids.
         */
        private function outputGeneralPageInfo() {
-
                $pageSet = $this->getPageSet();
                $result = $this->getResult();
 
                $pageSet = $this->getPageSet();
                $result = $this->getResult();
 
-               # We don't check for a full result set here because we can't be adding
-               # more than 380K. The maximum revision size is in the megabyte range,
-               # and the maximum result size must be even higher than that.
+               // We don't check for a full result set here because we can't be adding
+               // more than 380K. The maximum revision size is in the megabyte range,
+               // and the maximum result size must be even higher than that.
 
                // Title normalizations
 
                // Title normalizations
-               $normValues = array ();
-               foreach ($pageSet->getNormalizedTitles() as $rawTitleStr => $titleStr) {
-                       $normValues[] = array (
+               $normValues = array();
+               foreach ( $pageSet->getNormalizedTitles() as $rawTitleStr => $titleStr ) {
+                       $normValues[] = array(
                                'from' => $rawTitleStr,
                                'to' => $titleStr
                        );
                }
 
                                'from' => $rawTitleStr,
                                'to' => $titleStr
                        );
                }
 
-               if (count($normValues)) {
-                       $result->setIndexedTagName($normValues, 'n');
-                       $result->addValue('query', 'normalized', $normValues);
+               if ( count( $normValues ) ) {
+                       $result->setIndexedTagName( $normValues, 'n' );
+                       $result->addValue( 'query', 'normalized', $normValues );
+               }
+
+               // Title conversions
+               $convValues = array();
+               foreach ( $pageSet->getConvertedTitles() as $rawTitleStr => $titleStr ) {
+                       $convValues[] = array(
+                               'from' => $rawTitleStr,
+                               'to' => $titleStr
+                       );
+               }
+
+               if ( count( $convValues ) ) {
+                       $result->setIndexedTagName( $convValues, 'c' );
+                       $result->addValue( 'query', 'converted', $convValues );
                }
 
                // Interwiki titles
                }
 
                // Interwiki titles
-               $intrwValues = array ();
-               foreach ($pageSet->getInterwikiTitles() as $rawTitleStr => $interwikiStr) {
-                       $intrwValues[] = array (
+               $intrwValues = array();
+               foreach ( $pageSet->getInterwikiTitles() as $rawTitleStr => $interwikiStr ) {
+                       $intrwValues[] = array(
                                'title' => $rawTitleStr,
                                'iw' => $interwikiStr
                        );
                }
 
                                'title' => $rawTitleStr,
                                'iw' => $interwikiStr
                        );
                }
 
-               if (count($intrwValues)) {
-                       $result->setIndexedTagName($intrwValues, 'i');
-                       $result->addValue('query', 'interwiki', $intrwValues);
+               if ( count( $intrwValues ) ) {
+                       $result->setIndexedTagName( $intrwValues, 'i' );
+                       $result->addValue( 'query', 'interwiki', $intrwValues );
                }
 
                // Show redirect information
                }
 
                // Show redirect information
-               $redirValues = array ();
-               foreach ($pageSet->getRedirectTitles() as $titleStrFrom => $titleStrTo) {
-                       $redirValues[] = array (
-                               'from' => strval($titleStrFrom),
+               $redirValues = array();
+               foreach ( $pageSet->getRedirectTitles() as $titleStrFrom => $titleStrTo ) {
+                       $redirValues[] = array(
+                               'from' => strval( $titleStrFrom ),
                                'to' => $titleStrTo
                        );
                }
 
                                'to' => $titleStrTo
                        );
                }
 
-               if (count($redirValues)) {
-                       $result->setIndexedTagName($redirValues, 'r');
-                       $result->addValue('query', 'redirects', $redirValues);
+               if ( count( $redirValues ) ) {
+                       $result->setIndexedTagName( $redirValues, 'r' );
+                       $result->addValue( 'query', 'redirects', $redirValues );
                }
 
                //
                // Missing revision elements
                //
                $missingRevIDs = $pageSet->getMissingRevisionIDs();
                }
 
                //
                // Missing revision elements
                //
                $missingRevIDs = $pageSet->getMissingRevisionIDs();
-               if (count($missingRevIDs)) {
-                       $revids = array ();
-                       foreach ($missingRevIDs as $revid) {
-                               $revids[$revid] = array (
+               if ( count( $missingRevIDs ) ) {
+                       $revids = array();
+                       foreach ( $missingRevIDs as $revid ) {
+                               $revids[$revid] = array(
                                        'revid' => $revid
                                );
                        }
                                        'revid' => $revid
                                );
                        }
-                       $result->setIndexedTagName($revids, 'rev');
-                       $result->addValue('query', 'badrevids', $revids);
+                       $result->setIndexedTagName( $revids, 'rev' );
+                       $result->addValue( 'query', 'badrevids', $revids );
                }
 
                //
                // Page elements
                //
                }
 
                //
                // Page elements
                //
-               $pages = array ();
+               $pages = array();
 
                // Report any missing titles
 
                // Report any missing titles
-               foreach ($pageSet->getMissingTitles() as $fakeId => $title) {
+               foreach ( $pageSet->getMissingTitles() as $fakeId => $title ) {
                        $vals = array();
                        $vals = array();
-                       ApiQueryBase :: addTitleInfo($vals, $title);
+                       ApiQueryBase::addTitleInfo( $vals, $title );
                        $vals['missing'] = '';
                        $pages[$fakeId] = $vals;
                }
                // Report any invalid titles
                        $vals['missing'] = '';
                        $pages[$fakeId] = $vals;
                }
                // Report any invalid titles
-               foreach ($pageSet->getInvalidTitles() as $fakeId => $title)
-                       $pages[$fakeId] = array('title' => $title, 'invalid' => '');
+               foreach ( $pageSet->getInvalidTitles() as $fakeId => $title ) {
+                       $pages[$fakeId] = array( 'title' => $title, 'invalid' => '' );
+               }
                // Report any missing page ids
                // Report any missing page ids
-               foreach ($pageSet->getMissingPageIDs() as $pageid) {
-                       $pages[$pageid] = array (
+               foreach ( $pageSet->getMissingPageIDs() as $pageid ) {
+                       $pages[$pageid] = array(
                                'pageid' => $pageid,
                                'missing' => ''
                        );
                }
                                'pageid' => $pageid,
                                'missing' => ''
                        );
                }
+               // Report special pages
+               foreach ( $pageSet->getSpecialTitles() as $fakeId => $title ) {
+                       $vals = array();
+                       ApiQueryBase::addTitleInfo( $vals, $title );
+                       $vals['special'] = '';
+                       if ( $title->getNamespace() == NS_SPECIAL &&
+                                       !SpecialPage::exists( $title->getText() ) ) {
+                               $vals['missing'] = '';
+                       } elseif ( $title->getNamespace() == NS_MEDIA &&
+                                       !wfFindFile( $title ) ) {
+                               $vals['missing'] = '';
+                       }
+                       $pages[$fakeId] = $vals;
+               }
 
                // Output general page information for found titles
 
                // Output general page information for found titles
-               foreach ($pageSet->getGoodTitles() as $pageid => $title) {
+               foreach ( $pageSet->getGoodTitles() as $pageid => $title ) {
                        $vals = array();
                        $vals['pageid'] = $pageid;
                        $vals = array();
                        $vals['pageid'] = $pageid;
-                       ApiQueryBase :: addTitleInfo($vals, $title);
+                       ApiQueryBase::addTitleInfo( $vals, $title );
                        $pages[$pageid] = $vals;
                }
 
                        $pages[$pageid] = $vals;
                }
 
-               if (count($pages)) {
-
-                       if ($this->params['indexpageids']) {
-                               $pageIDs = array_keys($pages);
+               if ( count( $pages ) ) {
+                       if ( $this->params['indexpageids'] ) {
+                               $pageIDs = array_keys( $pages );
                                // json treats all map keys as strings - converting to match
                                // json treats all map keys as strings - converting to match
-                               $pageIDs = array_map('strval', $pageIDs);
-                               $result->setIndexedTagName($pageIDs, 'id');
-                               $result->addValue('query', 'pageids', $pageIDs);
+                               $pageIDs = array_map( 'strval', $pageIDs );
+                               $result->setIndexedTagName( $pageIDs, 'id' );
+                               $result->addValue( 'query', 'pageids', $pageIDs );
                        }
 
                        }
 
-                       $result->setIndexedTagName($pages, 'page');
-                       $result->addValue('query', 'pages', $pages);
-                       
-                       if ($this->params['export']) {
-                               $exporter = new WikiExporter($this->getDB());
-                               // WikiExporter writes to stdout, so catch its
-                               // output with an ob
-                               ob_start();
-                               $exporter->openStream();
-                               foreach ($pageSet->getGoodTitles() as $title)
-                                       if ($title->userCanRead())
-                                               $exporter->pageByTitle($title);
-                               $exporter->closeStream();
-                               $exportxml = ob_get_contents();
-                               ob_end_clean();
-                               // Don't check the size of exported stuff
-                               // It's not continuable, so it would cause more
-                               // problems than it'd solve
-                               $result->disableSizeCheck();
-                               if ($this->params['exportnowrap']) {
-                                       $result->reset();
-                                       // Raw formatter will handle this
-                                       $result->addValue(null, 'text', $exportxml);
-                                       $result->addValue(null, 'mime', 'text/xml');
-                               } else {
-                                       $r = array();
-                                       ApiResult::setContent($r, $exportxml);
-                                       $result->addValue('query', 'export', $r);
+                       $result->setIndexedTagName( $pages, 'page' );
+                       $result->addValue( 'query', 'pages', $pages );
+               }
+               if ( $this->params['export'] ) {
+                       $exporter = new WikiExporter( $this->getDB() );
+                       // WikiExporter writes to stdout, so catch its
+                       // output with an ob
+                       ob_start();
+                       $exporter->openStream();
+                       foreach ( @$pageSet->getGoodTitles() as $title ) {
+                               if ( $title->userCanRead() ) {
+                                       $exporter->pageByTitle( $title );
                                }
                                }
-                               $result->enableSizeCheck();
                        }
                        }
+                       $exporter->closeStream();
+                       $exportxml = ob_get_contents();
+                       ob_end_clean();
+
+                       // Don't check the size of exported stuff
+                       // It's not continuable, so it would cause more
+                       // problems than it'd solve
+                       $result->disableSizeCheck();
+                       if ( $this->params['exportnowrap'] ) {
+                               $result->reset();
+                               // Raw formatter will handle this
+                               $result->addValue( null, 'text', $exportxml );
+                               $result->addValue( null, 'mime', 'text/xml' );
+                       } else {
+                               $r = array();
+                               ApiResult::setContent( $r, $exportxml );
+                               $result->addValue( 'query', 'export', $r );
+                       }
+                       $result->enableSizeCheck();
                }
        }
 
        /**
                }
        }
 
        /**
-        * For generator mode, execute generator, and use its output as new
-        * ApiPageSet
+        * Create a generator object of the given type and return it
         * @param $generatorName string Module name
         * @param $generatorName string Module name
-        * @param $modules array of module objects
         */
         */
-       protected function executeGeneratorModule($generatorName, $modules) {
-
+       public function newGenerator( $generatorName ) {
                // Find class that implements requested generator
                // Find class that implements requested generator
-               if (isset ($this->mQueryListModules[$generatorName])) {
+               if ( isset( $this->mQueryListModules[$generatorName] ) ) {
                        $className = $this->mQueryListModules[$generatorName];
                        $className = $this->mQueryListModules[$generatorName];
-               } elseif (isset ($this->mQueryPropModules[$generatorName])) {
+               } elseif ( isset( $this->mQueryPropModules[$generatorName] ) ) {
                        $className = $this->mQueryPropModules[$generatorName];
                } else {
                        $className = $this->mQueryPropModules[$generatorName];
                } else {
-                       ApiBase :: dieDebug(__METHOD__, "Unknown generator=$generatorName");
+                       ApiBase::dieDebug( __METHOD__, "Unknown generator=$generatorName" );
                }
                }
+               $generator = new $className ( $this, $generatorName );
+               if ( !$generator instanceof ApiQueryGeneratorBase ) {
+                       $this->dieUsage( "Module $generatorName cannot be used as a generator", 'badgenerator' );
+               }
+               $generator->setGeneratorMode();
+               return $generator;
+       }
 
 
+       /**
+        * For generator mode, execute generator, and use its output as new
+        * ApiPageSet
+        * @param $generatorName string Module name
+        * @param $modules array of module objects
+        */
+       protected function executeGeneratorModule( $generator, $modules ) {
                // Generator results
                // Generator results
-               $resultPageSet = new ApiPageSet($this, $this->redirects);
-
-               // Create and execute the generator
-               $generator = new $className ($this, $generatorName);
-               if (!$generator instanceof ApiQueryGeneratorBase)
-                       $this->dieUsage("Module $generatorName cannot be used as a generator", "badgenerator");
-
-               $generator->setGeneratorMode();
+               $resultPageSet = new ApiPageSet( $this, $this->redirects, $this->convertTitles );
 
                // Add any additional fields modules may need
 
                // Add any additional fields modules may need
-               $generator->requestExtraData($this->mPageSet);
-               $this->addCustomFldsToPageSet($modules, $resultPageSet);
+               $generator->requestExtraData( $this->mPageSet );
+               $this->addCustomFldsToPageSet( $modules, $resultPageSet );
 
                // Populate page information with the original user input
                $this->mPageSet->execute();
 
                // populate resultPageSet with the generator output
                $generator->profileIn();
 
                // Populate page information with the original user input
                $this->mPageSet->execute();
 
                // populate resultPageSet with the generator output
                $generator->profileIn();
-               $generator->executeGenerator($resultPageSet);
-               wfRunHooks('APIQueryGeneratorAfterExecute', array(&$generator, &$resultPageSet));
+               $generator->executeGenerator( $resultPageSet );
+               wfRunHooks( 'APIQueryGeneratorAfterExecute', array( &$generator, &$resultPageSet ) );
                $resultPageSet->finishPageSetGeneration();
                $generator->profileOut();
 
                $resultPageSet->finishPageSetGeneration();
                $generator->profileOut();
 
@@ -453,23 +537,24 @@ class ApiQuery extends ApiBase {
        }
 
        public function getAllowedParams() {
        }
 
        public function getAllowedParams() {
-               return array (
-                       'prop' => array (
-                               ApiBase :: PARAM_ISMULTI => true,
-                               ApiBase :: PARAM_TYPE => $this->mPropModuleNames
+               return array(
+                       'prop' => array(
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_TYPE => $this->mPropModuleNames
                        ),
                        ),
-                       'list' => array (
-                               ApiBase :: PARAM_ISMULTI => true,
-                               ApiBase :: PARAM_TYPE => $this->mListModuleNames
+                       'list' => array(
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_TYPE => $this->mListModuleNames
                        ),
                        ),
-                       'meta' => array (
-                               ApiBase :: PARAM_ISMULTI => true,
-                               ApiBase :: PARAM_TYPE => $this->mMetaModuleNames
+                       'meta' => array(
+                               ApiBase::PARAM_ISMULTI => true,
+                               ApiBase::PARAM_TYPE => $this->mMetaModuleNames
                        ),
                        ),
-                       'generator' => array (
-                               ApiBase :: PARAM_TYPE => $this->mAllowedGenerators
+                       'generator' => array(
+                               ApiBase::PARAM_TYPE => $this->mAllowedGenerators
                        ),
                        'redirects' => false,
                        ),
                        'redirects' => false,
+                       'converttitles' => false,
                        'indexpageids' => false,
                        'export' => false,
                        'exportnowrap' => false,
                        'indexpageids' => false,
                        'export' => false,
                        'exportnowrap' => false,
@@ -481,28 +566,27 @@ class ApiQuery extends ApiBase {
         * @return string
         */
        public function makeHelpMsg() {
         * @return string
         */
        public function makeHelpMsg() {
-
                $msg = '';
 
                // Make sure the internal object is empty
                // (just in case a sub-module decides to optimize during instantiation)
                $this->mPageSet = null;
                $msg = '';
 
                // Make sure the internal object is empty
                // (just in case a sub-module decides to optimize during instantiation)
                $this->mPageSet = null;
-               $this->mAllowedGenerators = array();    // Will be repopulated
+               $this->mAllowedGenerators = array(); // Will be repopulated
 
 
-               $astriks = str_repeat('--- ', 8);
-               $astriks2 = str_repeat('*** ', 10);
+               $astriks = str_repeat( '--- ', 8 );
+               $astriks2 = str_repeat( '*** ', 10 );
                $msg .= "\n$astriks Query: Prop  $astriks\n\n";
                $msg .= "\n$astriks Query: Prop  $astriks\n\n";
-               $msg .= $this->makeHelpMsgHelper($this->mQueryPropModules, 'prop');
+               $msg .= $this->makeHelpMsgHelper( $this->mQueryPropModules, 'prop' );
                $msg .= "\n$astriks Query: List  $astriks\n\n";
                $msg .= "\n$astriks Query: List  $astriks\n\n";
-               $msg .= $this->makeHelpMsgHelper($this->mQueryListModules, 'list');
+               $msg .= $this->makeHelpMsgHelper( $this->mQueryListModules, 'list' );
                $msg .= "\n$astriks Query: Meta  $astriks\n\n";
                $msg .= "\n$astriks Query: Meta  $astriks\n\n";
-               $msg .= $this->makeHelpMsgHelper($this->mQueryMetaModules, 'meta');
+               $msg .= $this->makeHelpMsgHelper( $this->mQueryMetaModules, 'meta' );
                $msg .= "\n\n$astriks2 Modules: continuation  $astriks2\n\n";
 
                // Perform the base call last because the $this->mAllowedGenerators
                // will be updated inside makeHelpMsgHelper()
                // Use parent to make default message for the query module
                $msg .= "\n\n$astriks2 Modules: continuation  $astriks2\n\n";
 
                // Perform the base call last because the $this->mAllowedGenerators
                // will be updated inside makeHelpMsgHelper()
                // Use parent to make default message for the query module
-               $msg = parent :: makeHelpMsg() . $msg;
+               $msg = parent::makeHelpMsg() . $msg;
 
                return $msg;
        }
 
                return $msg;
        }
@@ -513,25 +597,25 @@ class ApiQuery extends ApiBase {
         * @param $paramName string Parameter name
         * @return string
         */
         * @param $paramName string Parameter name
         * @return string
         */
-       private function makeHelpMsgHelper($moduleList, $paramName) {
-
-               $moduleDescriptions = array ();
+       private function makeHelpMsgHelper( $moduleList, $paramName ) {
+               $moduleDescriptions = array();
 
 
-               foreach ($moduleList as $moduleName => $moduleClass) {
-                       $module = new $moduleClass ($this, $moduleName, null);
+               foreach ( $moduleList as $moduleName => $moduleClass ) {
+                       $module = new $moduleClass ( $this, $moduleName, null );
 
 
-                       $msg = ApiMain::makeHelpMsgHeader($module, $paramName);
+                       $msg = ApiMain::makeHelpMsgHeader( $module, $paramName );
                        $msg2 = $module->makeHelpMsg();
                        $msg2 = $module->makeHelpMsg();
-                       if ($msg2 !== false)
+                       if ( $msg2 !== false ) {
                                $msg .= $msg2;
                                $msg .= $msg2;
-                       if ($module instanceof ApiQueryGeneratorBase) {
+                       }
+                       if ( $module instanceof ApiQueryGeneratorBase ) {
                                $this->mAllowedGenerators[] = $moduleName;
                                $msg .= "Generator:\n  This module may be used as a generator\n";
                        }
                        $moduleDescriptions[] = $msg;
                }
 
                                $this->mAllowedGenerators[] = $moduleName;
                                $msg .= "Generator:\n  This module may be used as a generator\n";
                        }
                        $moduleDescriptions[] = $msg;
                }
 
-               return implode("\n", $moduleDescriptions);
+               return implode( "\n", $moduleDescriptions );
        }
 
        /**
        }
 
        /**
@@ -539,8 +623,8 @@ class ApiQuery extends ApiBase {
         * @return string
         */
        public function makeHelpMsgParameters() {
         * @return string
         */
        public function makeHelpMsgParameters() {
-               $psModule = new ApiPageSet($this);
-               return $psModule->makeHelpMsgParameters() . parent :: makeHelpMsgParameters();
+               $psModule = new ApiPageSet( $this );
+               return $psModule->makeHelpMsgParameters() . parent::makeHelpMsgParameters();
        }
 
        public function shouldCheckMaxlag() {
        }
 
        public function shouldCheckMaxlag() {
@@ -548,37 +632,46 @@ class ApiQuery extends ApiBase {
        }
 
        public function getParamDescription() {
        }
 
        public function getParamDescription() {
-               return array (
-                       'prop' => 'Which properties to get for the titles/revisions/pageids',
-                       'list' => 'Which lists to get',
-                       'meta' => 'Which meta data to get about the site',
-                       'generator' => 'Use the output of a list as the input for other prop/list/meta items',
+               return array(
+                       'prop' => 'Which properties to get for the titles/revisions/pageids. Module help is available below',
+                       'list' => 'Which lists to get. Module help is available below',
+                       'meta' => 'Which metadata to get about the site. Module help is available below',
+                       'generator' => array( 'Use the output of a list as the input for other prop/list/meta items',
+                                       'NOTE: generator parameter names must be prefixed with a \'g\', see examples' ),
                        'redirects' => 'Automatically resolve redirects',
                        'redirects' => 'Automatically resolve redirects',
-                       'indexpageids' => 'Include an additional pageids section listing all returned page IDs.',
+                       'converttitles' => "Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion.",
+                       'indexpageids' => 'Include an additional pageids section listing all returned page IDs',
                        'export' => 'Export the current revisions of all given or generated pages',
                        'export' => 'Export the current revisions of all given or generated pages',
-                       'exportnowrap' => 'Return the export XML without wrapping it in an XML result',
+                       'exportnowrap' => 'Return the export XML without wrapping it in an XML result (same format as Special:Export). Can only be used with export',
                );
        }
 
        public function getDescription() {
                );
        }
 
        public function getDescription() {
-               return array (
+               return array(
                        'Query API module allows applications to get needed pieces of data from the MediaWiki databases,',
                        'and is loosely based on the old query.php interface.',
                        'Query API module allows applications to get needed pieces of data from the MediaWiki databases,',
                        'and is loosely based on the old query.php interface.',
-                       'All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites.'
+                       'All data modifications will first have to use query to acquire a token to prevent abuse from malicious sites'
                );
        }
 
                );
        }
 
+       public function getPossibleErrors() {
+               return array_merge( parent::getPossibleErrors(), array(
+                       array( 'code' => 'badgenerator', 'info' => 'Module $generatorName cannot be used as a generator' ),
+               ) );
+       }
+
        protected function getExamples() {
        protected function getExamples() {
-               return array (
-                       'api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment'
+               return array(
+                       'api.php?action=query&prop=revisions&meta=siteinfo&titles=Main%20Page&rvprop=user|comment',
+                       'api.php?action=query&generator=allpages&gapprefix=API/&prop=revisions',
                );
        }
 
        public function getVersion() {
                );
        }
 
        public function getVersion() {
-               $psModule = new ApiPageSet($this);
-               $vers = array ();
+               $psModule = new ApiPageSet( $this );
+               $vers = array();
                $vers[] = __CLASS__ . ': $Id$';
                $vers[] = $psModule->getVersion();
                return $vers;
        }
                $vers[] = __CLASS__ . ': $Id$';
                $vers[] = $psModule->getVersion();
                return $vers;
        }
-}
\ No newline at end of file
+}
Wiklou, le Wiki du Wiklou