]> scripts.mit.edu Git - autoinstalls/mediawiki.git/blobdiff - includes/api/ApiQueryBase.php
MediaWiki 1.30.2
[autoinstalls/mediawiki.git] / includes / api / ApiQueryBase.php
index 28adb41554ba0f4b0926909c046c3c8f3312a406..6987dfb13fa9b2a91a19dc07f47b291ac373f571 100644 (file)
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on Sep 7, 2006
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on Sep 7, 2006
+ *
+ * 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
  *
  * 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
+ *
+ * @file
  */
 
-if (!defined('MEDIAWIKI')) {
-       // Eclipse helper - will be ignored in production
-       require_once ('ApiBase.php');
-}
+use Wikimedia\Rdbms\IDatabase;
+use Wikimedia\Rdbms\ResultWrapper;
 
 /**
  * This is a base class for all Query modules.
- * It provides some common functionality such as constructing various SQL queries.
- * 
- * @addtogroup API
+ * It provides some common functionality such as constructing various SQL
+ * queries.
+ *
+ * @ingroup API
  */
 abstract class ApiQueryBase extends ApiBase {
 
-       private $mQueryModule, $mDb, $tables, $where, $fields, $options;
+       private $mQueryModule, $mDb, $tables, $where, $fields, $options, $join_conds;
 
-       public function __construct($query, $moduleName, $paramPrefix = '') {
-               parent :: __construct($query->getMain(), $moduleName, $paramPrefix);
-               $this->mQueryModule = $query;
+       /**
+        * @param ApiQuery $queryModule
+        * @param string $moduleName
+        * @param string $paramPrefix
+        */
+       public function __construct( ApiQuery $queryModule, $moduleName, $paramPrefix = '' ) {
+               parent::__construct( $queryModule->getMain(), $moduleName, $paramPrefix );
+               $this->mQueryModule = $queryModule;
                $this->mDb = null;
                $this->resetQueryParams();
        }
 
+       /************************************************************************//**
+        * @name   Methods to implement
+        * @{
+        */
+
+       /**
+        * Get the cache mode for the data generated by this module. Override
+        * this in the module subclass. For possible return values and other
+        * details about cache modes, see ApiMain::setCacheMode()
+        *
+        * Public caching will only be allowed if *all* the modules that supply
+        * data for a given request return a cache mode of public.
+        *
+        * @param array $params
+        * @return string
+        */
+       public function getCacheMode( $params ) {
+               return 'private';
+       }
+
+       /**
+        * Override this method to request extra fields from the pageSet
+        * using $pageSet->requestField('fieldName')
+        *
+        * Note this only makes sense for 'prop' modules, as 'list' and 'meta'
+        * modules should not be using the pageset.
+        *
+        * @param ApiPageSet $pageSet
+        */
+       public function requestExtraData( $pageSet ) {
+       }
+
+       /**@}*/
+
+       /************************************************************************//**
+        * @name   Data access
+        * @{
+        */
+
+       /**
+        * Get the main Query module
+        * @return ApiQuery
+        */
+       public function getQuery() {
+               return $this->mQueryModule;
+       }
+
+       /** @inheritDoc */
+       public function getParent() {
+               return $this->getQuery();
+       }
+
+       /**
+        * Get the Query database connection (read-only)
+        * @return IDatabase
+        */
+       protected function getDB() {
+               if ( is_null( $this->mDb ) ) {
+                       $this->mDb = $this->getQuery()->getDB();
+               }
+
+               return $this->mDb;
+       }
+
+       /**
+        * Selects the query database connection with the given name.
+        * See ApiQuery::getNamedDB() for more information
+        * @param string $name Name to assign to the database connection
+        * @param int $db One of the DB_* constants
+        * @param string|string[] $groups Query groups
+        * @return IDatabase
+        */
+       public function selectNamedDB( $name, $db, $groups ) {
+               $this->mDb = $this->getQuery()->getNamedDB( $name, $db, $groups );
+               return $this->mDb;
+       }
+
+       /**
+        * Get the PageSet object to work on
+        * @return ApiPageSet
+        */
+       protected function getPageSet() {
+               return $this->getQuery()->getPageSet();
+       }
+
+       /**@}*/
+
+       /************************************************************************//**
+        * @name   Querying
+        * @{
+        */
+
+       /**
+        * Blank the internal arrays with query parameters
+        */
        protected function resetQueryParams() {
-               $this->tables = array ();
-               $this->where = array ();
-               $this->fields = array ();
-               $this->options = array ();
+               $this->tables = [];
+               $this->where = [];
+               $this->fields = [];
+               $this->options = [];
+               $this->join_conds = [];
        }
 
-       protected function addTables($tables, $alias = null) {
-               if (is_array($tables)) {
-                       if (!is_null($alias))
-                               ApiBase :: dieDebug(__METHOD__, 'Multiple table aliases not supported');
-                       $this->tables = array_merge($this->tables, $tables);
+       /**
+        * Add a set of tables to the internal array
+        * @param string|string[] $tables Table name or array of table names
+        * @param string|null $alias Table alias, or null for no alias. Cannot be
+        *  used with multiple tables
+        */
+       protected function addTables( $tables, $alias = null ) {
+               if ( is_array( $tables ) ) {
+                       if ( !is_null( $alias ) ) {
+                               ApiBase::dieDebug( __METHOD__, 'Multiple table aliases not supported' );
+                       }
+                       $this->tables = array_merge( $this->tables, $tables );
                } else {
-                       if (!is_null($alias))
-                               $tables = $this->getDB()->tableName($tables) . ' ' . $alias;
-                       $this->tables[] = $tables;
+                       if ( !is_null( $alias ) ) {
+                               $this->tables[$alias] = $tables;
+                       } else {
+                               $this->tables[] = $tables;
+                       }
+               }
+       }
+
+       /**
+        * Add a set of JOIN conditions to the internal array
+        *
+        * JOIN conditions are formatted as [ tablename => [ jointype, conditions ] ]
+        * e.g. [ 'page' => [ 'LEFT JOIN', 'page_id=rev_page' ] ].
+        * Conditions may be a string or an addWhere()-style array.
+        * @param array $join_conds JOIN conditions
+        */
+       protected function addJoinConds( $join_conds ) {
+               if ( !is_array( $join_conds ) ) {
+                       ApiBase::dieDebug( __METHOD__, 'Join conditions have to be arrays' );
                }
+               $this->join_conds = array_merge( $this->join_conds, $join_conds );
        }
 
-       protected function addFields($value) {
-               if (is_array($value))
-                       $this->fields = array_merge($this->fields, $value);
-               else
+       /**
+        * Add a set of fields to select to the internal array
+        * @param array|string $value Field name or array of field names
+        */
+       protected function addFields( $value ) {
+               if ( is_array( $value ) ) {
+                       $this->fields = array_merge( $this->fields, $value );
+               } else {
                        $this->fields[] = $value;
+               }
        }
 
-       protected function addFieldsIf($value, $condition) {
-               if ($condition) {
-                       $this->addFields($value);
+       /**
+        * Same as addFields(), but add the fields only if a condition is met
+        * @param array|string $value See addFields()
+        * @param bool $condition If false, do nothing
+        * @return bool $condition
+        */
+       protected function addFieldsIf( $value, $condition ) {
+               if ( $condition ) {
+                       $this->addFields( $value );
+
                        return true;
                }
+
                return false;
        }
 
-       protected function addWhere($value) {
-               if (is_array($value))
-                       $this->where = array_merge($this->where, $value);
-               else
+       /**
+        * Add a set of WHERE clauses to the internal array.
+        * Clauses can be formatted as 'foo=bar' or [ 'foo' => 'bar' ],
+        * the latter only works if the value is a constant (i.e. not another field)
+        *
+        * If $value is an empty array, this function does nothing.
+        *
+        * For example, [ 'foo=bar', 'baz' => 3, 'bla' => 'foo' ] translates
+        * to "foo=bar AND baz='3' AND bla='foo'"
+        * @param string|array $value
+        */
+       protected function addWhere( $value ) {
+               if ( is_array( $value ) ) {
+                       // Sanity check: don't insert empty arrays,
+                       // Database::makeList() chokes on them
+                       if ( count( $value ) ) {
+                               $this->where = array_merge( $this->where, $value );
+                       }
+               } else {
                        $this->where[] = $value;
+               }
        }
 
-       protected function addWhereIf($value, $condition) {
-               if ($condition) {
-                       $this->addWhere($value);
+       /**
+        * Same as addWhere(), but add the WHERE clauses only if a condition is met
+        * @param string|array $value
+        * @param bool $condition If false, do nothing
+        * @return bool $condition
+        */
+       protected function addWhereIf( $value, $condition ) {
+               if ( $condition ) {
+                       $this->addWhere( $value );
+
                        return true;
                }
+
                return false;
        }
 
-       protected function addWhereFld($field, $value) {
-               if (!is_null($value))
+       /**
+        * Equivalent to addWhere(array($field => $value))
+        * @param string $field Field name
+        * @param string|string[] $value Value; ignored if null or empty array;
+        */
+       protected function addWhereFld( $field, $value ) {
+               // Use count() to its full documented capabilities to simultaneously
+               // test for null, empty array or empty countable object
+               if ( count( $value ) ) {
                        $this->where[$field] = $value;
+               }
        }
 
-       protected function addWhereRange($field, $dir, $start, $end) {
-               $isDirNewer = ($dir === 'newer');
-               $after = ($isDirNewer ? '>=' : '<=');
-               $before = ($isDirNewer ? '<=' : '>=');
+       /**
+        * Add a WHERE clause corresponding to a range, and an ORDER BY
+        * clause to sort in the right direction
+        * @param string $field Field name
+        * @param string $dir If 'newer', sort in ascending order, otherwise
+        *  sort in descending order
+        * @param string $start Value to start the list at. If $dir == 'newer'
+        *  this is the lower boundary, otherwise it's the upper boundary
+        * @param string $end Value to end the list at. If $dir == 'newer' this
+        *  is the upper boundary, otherwise it's the lower boundary
+        * @param bool $sort If false, don't add an ORDER BY clause
+        */
+       protected function addWhereRange( $field, $dir, $start, $end, $sort = true ) {
+               $isDirNewer = ( $dir === 'newer' );
+               $after = ( $isDirNewer ? '>=' : '<=' );
+               $before = ( $isDirNewer ? '<=' : '>=' );
                $db = $this->getDB();
 
-               if (!is_null($start))
-                       $this->addWhere($field . $after . $db->addQuotes($start));
+               if ( !is_null( $start ) ) {
+                       $this->addWhere( $field . $after . $db->addQuotes( $start ) );
+               }
+
+               if ( !is_null( $end ) ) {
+                       $this->addWhere( $field . $before . $db->addQuotes( $end ) );
+               }
 
-               if (!is_null($end))
-                       $this->addWhere($field . $before . $db->addQuotes($end));
+               if ( $sort ) {
+                       $order = $field . ( $isDirNewer ? '' : ' DESC' );
+                       // Append ORDER BY
+                       $optionOrderBy = isset( $this->options['ORDER BY'] )
+                               ? (array)$this->options['ORDER BY']
+                               : [];
+                       $optionOrderBy[] = $order;
+                       $this->addOption( 'ORDER BY', $optionOrderBy );
+               }
+       }
 
-               $this->addOption('ORDER BY', $field . ($isDirNewer ? '' : ' DESC'));
+       /**
+        * Add a WHERE clause corresponding to a range, similar to addWhereRange,
+        * but converts $start and $end to database timestamps.
+        * @see addWhereRange
+        * @param string $field
+        * @param string $dir
+        * @param string $start
+        * @param string $end
+        * @param bool $sort
+        */
+       protected function addTimestampWhereRange( $field, $dir, $start, $end, $sort = true ) {
+               $db = $this->getDB();
+               $this->addWhereRange( $field, $dir,
+                       $db->timestampOrNull( $start ), $db->timestampOrNull( $end ), $sort );
        }
 
-       protected function addOption($name, $value = null) {
-               if (is_null($value))
+       /**
+        * Add an option such as LIMIT or USE INDEX. If an option was set
+        * before, the old value will be overwritten
+        * @param string $name Option name
+        * @param string|string[] $value Option value
+        */
+       protected function addOption( $name, $value = null ) {
+               if ( is_null( $value ) ) {
                        $this->options[] = $name;
-               else
+               } else {
                        $this->options[$name] = $value;
+               }
        }
 
-       protected function select($method) {
+       /**
+        * Execute a SELECT query based on the values in the internal arrays
+        * @param string $method Function the query should be attributed to.
+        *  You should usually use __METHOD__ here
+        * @param array $extraQuery Query data to add but not store in the object
+        *  Format is [
+        *    'tables' => ...,
+        *    'fields' => ...,
+        *    'where' => ...,
+        *    'options' => ...,
+        *    'join_conds' => ...
+        *  ]
+        * @param array|null &$hookData If set, the ApiQueryBaseBeforeQuery and
+        *  ApiQueryBaseAfterQuery hooks will be called, and the
+        *  ApiQueryBaseProcessRow hook will be expected.
+        * @return ResultWrapper
+        */
+       protected function select( $method, $extraQuery = [], array &$hookData = null ) {
+               $tables = array_merge(
+                       $this->tables,
+                       isset( $extraQuery['tables'] ) ? (array)$extraQuery['tables'] : []
+               );
+               $fields = array_merge(
+                       $this->fields,
+                       isset( $extraQuery['fields'] ) ? (array)$extraQuery['fields'] : []
+               );
+               $where = array_merge(
+                       $this->where,
+                       isset( $extraQuery['where'] ) ? (array)$extraQuery['where'] : []
+               );
+               $options = array_merge(
+                       $this->options,
+                       isset( $extraQuery['options'] ) ? (array)$extraQuery['options'] : []
+               );
+               $join_conds = array_merge(
+                       $this->join_conds,
+                       isset( $extraQuery['join_conds'] ) ? (array)$extraQuery['join_conds'] : []
+               );
+
+               if ( $hookData !== null ) {
+                       Hooks::run( 'ApiQueryBaseBeforeQuery',
+                               [ $this, &$tables, &$fields, &$where, &$options, &$join_conds, &$hookData ]
+                       );
+               }
 
-               // getDB has its own profileDBIn/Out calls
-               $db = $this->getDB();
+               $res = $this->getDB()->select( $tables, $fields, $where, $method, $options, $join_conds );
 
-               $this->profileDBIn();
-               $res = $db->select($this->tables, $this->fields, $this->where, $method, $this->options);
-               $this->profileDBOut();
+               if ( $hookData !== null ) {
+                       Hooks::run( 'ApiQueryBaseAfterQuery', [ $this, $res, &$hookData ] );
+               }
 
                return $res;
        }
 
-       public static function addTitleInfo(&$arr, $title, $prefix='') {
-               $arr[$prefix . 'ns'] = intval($title->getNamespace());
-               $arr[$prefix . 'title'] = $title->getPrefixedText();
-       }
-       
        /**
-        * Override this method to request extra fields from the pageSet
-        * using $pageSet->requestField('fieldName')
+        * Call the ApiQueryBaseProcessRow hook
+        *
+        * Generally, a module that passed $hookData to self::select() will call
+        * this just before calling ApiResult::addValue(), and treat a false return
+        * here in the same way it treats a false return from addValue().
+        *
+        * @since 1.28
+        * @param object $row Database row
+        * @param array &$data Data to be added to the result
+        * @param array &$hookData Hook data from ApiQueryBase::select()
+        * @return bool Return false if row processing should end with continuation
         */
-       public function requestExtraData($pageSet) {
+       protected function processRow( $row, array &$data, array &$hookData ) {
+               return Hooks::run( 'ApiQueryBaseProcessRow', [ $this, $row, &$data, &$hookData ] );
        }
 
        /**
-        * Get the main Query module
+        * @param string $query
+        * @param string $protocol
+        * @return null|string
         */
-       public function getQuery() {
-               return $this->mQueryModule;
+       public function prepareUrlQuerySearchString( $query = null, $protocol = null ) {
+               $db = $this->getDB();
+               if ( !is_null( $query ) || $query != '' ) {
+                       if ( is_null( $protocol ) ) {
+                               $protocol = 'http://';
+                       }
+
+                       $likeQuery = LinkFilter::makeLikeArray( $query, $protocol );
+                       if ( !$likeQuery ) {
+                               $this->dieWithError( 'apierror-badquery' );
+                       }
+
+                       $likeQuery = LinkFilter::keepOneWildcard( $likeQuery );
+
+                       return 'el_index ' . $db->buildLike( $likeQuery );
+               } elseif ( !is_null( $protocol ) ) {
+                       return 'el_index ' . $db->buildLike( "$protocol", $db->anyString() );
+               }
+
+               return null;
        }
 
        /**
-        * Add sub-element under the page element with the given pageId. 
+        * Filters hidden users (where the user doesn't have the right to view them)
+        * Also adds relevant block information
+        *
+        * @param bool $showBlockInfo
+        * @return void
         */
-       protected function addPageSubItems($pageId, $data) {
-               $result = $this->getResult();
-               $result->setIndexedTagName($data, $this->getModulePrefix());
-               $result->addValue(array ('query', 'pages', intval($pageId)),
-                       $this->getModuleName(),
-                       $data);
+       public function showHiddenUsersAddBlockInfo( $showBlockInfo ) {
+               $this->addTables( 'ipblocks' );
+               $this->addJoinConds( [
+                       'ipblocks' => [ 'LEFT JOIN', 'ipb_user=user_id' ],
+               ] );
+
+               $this->addFields( 'ipb_deleted' );
+
+               if ( $showBlockInfo ) {
+                       $this->addFields( [
+                               'ipb_id',
+                               'ipb_by',
+                               'ipb_by_text',
+                               'ipb_expiry',
+                               'ipb_timestamp'
+                       ] );
+                       $commentQuery = CommentStore::newKey( 'ipb_reason' )->getJoin();
+                       $this->addTables( $commentQuery['tables'] );
+                       $this->addFields( $commentQuery['fields'] );
+                       $this->addJoinConds( $commentQuery['joins'] );
+               }
+
+               // Don't show hidden names
+               if ( !$this->getUser()->isAllowed( 'hideuser' ) ) {
+                       $this->addWhere( 'ipb_deleted = 0 OR ipb_deleted IS NULL' );
+               }
        }
 
-       protected function setContinueEnumParameter($paramName, $paramValue) {
-               
-               $paramName = $this->encodeParamName($paramName);
-               $msg = array( $paramName => $paramValue );
+       /**@}*/
 
-//             This is an alternative continue format as a part of the URL string
-//             ApiResult :: setContent($msg, $paramName . '=' . urlencode($paramValue));
-               
-               $this->getResult()->addValue('query-continue', $this->getModuleName(), $msg);
-       }
+       /************************************************************************//**
+        * @name   Utility methods
+        * @{
+        */
 
        /**
-        * Get the Query database connection (readonly)
+        * Add information (title and namespace) about a Title object to a
+        * result array
+        * @param array &$arr Result array à la ApiResult
+        * @param Title $title
+        * @param string $prefix Module prefix
         */
-       protected function getDB() {
-               if (is_null($this->mDb))
-                       $this->mDb = $this->getQuery()->getDB();
-               return $this->mDb;
+       public static function addTitleInfo( &$arr, $title, $prefix = '' ) {
+               $arr[$prefix . 'ns'] = intval( $title->getNamespace() );
+               $arr[$prefix . 'title'] = $title->getPrefixedText();
        }
 
        /**
-        * Selects the query database connection with the given name.
-        * If no such connection has been requested before, it will be created. 
-        * Subsequent calls with the same $name will return the same connection 
-        * as the first, regardless of $db or $groups new values. 
+        * Add a sub-element under the page element with the given page ID
+        * @param int $pageId Page ID
+        * @param array $data Data array à la ApiResult
+        * @return bool Whether the element fit in the result
         */
-       public function selectNamedDB($name, $db, $groups) {
-               $this->mDb = $this->getQuery()->getNamedDB($name, $db, $groups);        
+       protected function addPageSubItems( $pageId, $data ) {
+               $result = $this->getResult();
+               ApiResult::setIndexedTagName( $data, $this->getModulePrefix() );
+
+               return $result->addValue( [ 'query', 'pages', intval( $pageId ) ],
+                       $this->getModuleName(),
+                       $data );
        }
 
        /**
-        * Get the PageSet object to work on
-        * @return ApiPageSet data
+        * Same as addPageSubItems(), but one element of $data at a time
+        * @param int $pageId Page ID
+        * @param array $item Data array à la ApiResult
+        * @param string $elemname XML element name. If null, getModuleName()
+        *  is used
+        * @return bool Whether the element fit in the result
         */
-       protected function getPageSet() {
-               return $this->getQuery()->getPageSet();
+       protected function addPageSubItem( $pageId, $item, $elemname = null ) {
+               if ( is_null( $elemname ) ) {
+                       $elemname = $this->getModulePrefix();
+               }
+               $result = $this->getResult();
+               $fit = $result->addValue( [ 'query', 'pages', $pageId,
+                       $this->getModuleName() ], null, $item );
+               if ( !$fit ) {
+                       return false;
+               }
+               $result->addIndexedTagName( [ 'query', 'pages', $pageId,
+                       $this->getModuleName() ], $elemname );
+
+               return true;
        }
 
        /**
-        * This is a very simplistic utility function
-        * to convert a non-namespaced title string to a db key.
-        * It will replace all ' ' with '_'
+        * Set a query-continue value
+        * @param string $paramName Parameter name
+        * @param string|array $paramValue Parameter value
         */
-       public static function titleToKey($title) {
-               return str_replace(' ', '_', $title);
+       protected function setContinueEnumParameter( $paramName, $paramValue ) {
+               $this->getContinuationManager()->addContinueParam( $this, $paramName, $paramValue );
        }
 
-       public static function keyToTitle($key) {
-               return str_replace('_', ' ', $key);
-       }
-
-       public function getTokenFlag($tokenArr, $action) {
-               if (in_array($action, $tokenArr)) {
-                       global $wgUser;
-                       if ($wgUser->isAllowed($action))
-                               return true;
-                       else
-                               $this->dieUsage("Action '$action' is not allowed for the current user", 'permissiondenied');
+       /**
+        * Convert an input title or title prefix into a dbkey.
+        *
+        * $namespace should always be specified in order to handle per-namespace
+        * capitalization settings.
+        *
+        * @param string $titlePart Title part
+        * @param int $namespace Namespace of the title
+        * @return string DBkey (no namespace prefix)
+        */
+       public function titlePartToKey( $titlePart, $namespace = NS_MAIN ) {
+               $t = Title::makeTitleSafe( $namespace, $titlePart . 'x' );
+               if ( !$t || $t->hasFragment() ) {
+                       // Invalid title (e.g. bad chars) or contained a '#'.
+                       $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
+               }
+               if ( $namespace != $t->getNamespace() || $t->isExternal() ) {
+                       // This can happen in two cases. First, if you call titlePartToKey with a title part
+                       // that looks like a namespace, but with $defaultNamespace = NS_MAIN. It would be very
+                       // difficult to handle such a case. Such cases cannot exist and are therefore treated
+                       // as invalid user input. The second case is when somebody specifies a title interwiki
+                       // prefix.
+                       $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
                }
-               return false;
-       }
-       
-       public static function getBaseVersion() {
-               return __CLASS__ . ': $Id: ApiQueryBase.php 24533 2007-08-01 22:46:22Z yurik $';
-       }
-}
 
-/**
- * @addtogroup API
- */
-abstract class ApiQueryGeneratorBase extends ApiQueryBase {
+               return substr( $t->getDBkey(), 0, -1 );
+       }
 
-       private $mIsGenerator;
+       /**
+        * Convert an input title or title prefix into a namespace constant and dbkey.
+        *
+        * @since 1.26
+        * @param string $titlePart Title part
+        * @param int $defaultNamespace Default namespace if none is given
+        * @return array (int, string) Namespace number and DBkey
+        */
+       public function prefixedTitlePartToKey( $titlePart, $defaultNamespace = NS_MAIN ) {
+               $t = Title::newFromText( $titlePart . 'x', $defaultNamespace );
+               if ( !$t || $t->hasFragment() || $t->isExternal() ) {
+                       // Invalid title (e.g. bad chars) or contained a '#'.
+                       $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $titlePart ) ] );
+               }
 
-       public function __construct($query, $moduleName, $paramPrefix = '') {
-               parent :: __construct($query, $moduleName, $paramPrefix);
-               $this->mIsGenerator = false;
+               return [ $t->getNamespace(), substr( $t->getDBkey(), 0, -1 ) ];
        }
 
-       public function setGeneratorMode() {
-               $this->mIsGenerator = true;
+       /**
+        * @param string $hash
+        * @return bool
+        */
+       public function validateSha1Hash( $hash ) {
+               return (bool)preg_match( '/^[a-f0-9]{40}$/', $hash );
        }
 
        /**
-        * Overrides base class to prepend 'g' to every generator parameter
+        * @param string $hash
+        * @return bool
         */
-       public function encodeParamName($paramName) {
-               if ($this->mIsGenerator)
-                       return 'g' . parent :: encodeParamName($paramName);
-               else
-                       return parent :: encodeParamName($paramName);
+       public function validateSha1Base36Hash( $hash ) {
+               return (bool)preg_match( '/^[a-z0-9]{31}$/', $hash );
        }
 
        /**
-        * Execute this module as a generator
-        * @param $resultPageSet PageSet: All output should be appended to this object
+        * Check whether the current user has permission to view revision-deleted
+        * fields.
+        * @return bool
         */
-       public abstract function executeGenerator($resultPageSet);
-}
+       public function userCanSeeRevDel() {
+               return $this->getUser()->isAllowedAny(
+                       'deletedhistory',
+                       'deletedtext',
+                       'suppressrevision',
+                       'viewsuppressed'
+               );
+       }
 
+       /**@}*/
+}