X-Git-Url: https://scripts.mit.edu/gitweb/autoinstalls/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/api/ApiQueryBase.php diff --git a/includes/api/ApiQueryBase.php b/includes/api/ApiQueryBase.php index 477b740a..6987dfb1 100644 --- a/includes/api/ApiQueryBase.php +++ b/includes/api/ApiQueryBase.php @@ -1,10 +1,10 @@ @gmail.com + * Copyright © 2006 Yuri Astrakhan "@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 @@ -24,10 +24,8 @@ * @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. @@ -40,13 +38,23 @@ abstract class ApiQueryBase extends ApiBase { private $mQueryModule, $mDb, $tables, $where, $fields, $options, $join_conds; - public function __construct( ApiBase $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 @@ -54,26 +62,101 @@ abstract class ApiQueryBase extends ApiBase { * * 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->join_conds = array(); + $this->tables = []; + $this->where = []; + $this->fields = []; + $this->options = []; + $this->join_conds = []; } /** * Add a set of tables to the internal array - * @param $tables mixed Table name or array of table names - * @param $alias mixed Table alias, or null for no alias. Cannot be + * @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 ) { @@ -84,30 +167,20 @@ abstract class ApiQueryBase extends ApiBase { $this->tables = array_merge( $this->tables, $tables ); } else { if ( !is_null( $alias ) ) { - $tables = $this->getAliasedName( $tables, $alias ); + $this->tables[$alias] = $tables; + } else { + $this->tables[] = $tables; } - $this->tables[] = $tables; } } - /** - * Get the SQL for a table name with alias - * @param $table string Table name - * @param $alias string Alias - * @return string SQL - */ - protected function getAliasedName( $table, $alias ) { - return $this->getDB()->tableName( $table ) . ' ' . $alias; - } - /** * Add a set of JOIN conditions to the internal array * - * JOIN conditions are formatted as array( tablename => array(jointype, - * conditions) e.g. array('page' => array('LEFT JOIN', - * 'page_id=rev_page')) . conditions may be a string or an - * addWhere()-style array - * @param $join_conds array JOIN conditions + * 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 ) ) { @@ -118,7 +191,7 @@ abstract class ApiQueryBase extends ApiBase { /** * Add a set of fields to select to the internal array - * @param $value mixed Field name or array of field names + * @param array|string $value Field name or array of field names */ protected function addFields( $value ) { if ( is_array( $value ) ) { @@ -130,28 +203,30 @@ abstract class ApiQueryBase extends ApiBase { /** * Same as addFields(), but add the fields only if a condition is met - * @param $value mixed See addFields() - * @param $condition bool If false, do nothing + * @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; } /** * Add a set of WHERE clauses to the internal array. - * Clauses can be formatted as 'foo=bar' or array('foo' => 'bar'), + * 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, array('foo=bar', 'baz' => 3, 'bla' => 'foo') translates + * For example, [ 'foo=bar', 'baz' => 3, 'bla' => 'foo' ] translates * to "foo=bar AND baz='3' AND bla='foo'" - * @param $value mixed String or array + * @param string|array $value */ protected function addWhere( $value ) { if ( is_array( $value ) ) { @@ -167,22 +242,24 @@ abstract class ApiQueryBase extends ApiBase { /** * Same as addWhere(), but add the WHERE clauses only if a condition is met - * @param $value mixed See addWhere() - * @param $condition bool If false, do nothing + * @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; } /** * Equivalent to addWhere(array($field => $value)) - * @param $field string Field name - * @param $value string Value; ignored if null or empty array; + * @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 @@ -195,14 +272,14 @@ abstract class ApiQueryBase extends ApiBase { /** * Add a WHERE clause corresponding to a range, and an ORDER BY * clause to sort in the right direction - * @param $field string Field name - * @param $dir string If 'newer', sort in ascending order, otherwise + * @param string $field Field name + * @param string $dir If 'newer', sort in ascending order, otherwise * sort in descending order - * @param $start string Value to start the list at. If $dir == 'newer' + * @param string $start Value to start the list at. If $dir == 'newer' * this is the lower boundary, otherwise it's the upper boundary - * @param $end string Value to end the list at. If $dir == 'newer' this + * @param string $end Value to end the list at. If $dir == 'newer' this * is the upper boundary, otherwise it's the lower boundary - * @param $sort bool If false, don't add an ORDER BY clause + * @param bool $sort If false, don't add an ORDER BY clause */ protected function addWhereRange( $field, $dir, $start, $end, $sort = true ) { $isDirNewer = ( $dir === 'newer' ); @@ -220,19 +297,36 @@ abstract class ApiQueryBase extends ApiBase { if ( $sort ) { $order = $field . ( $isDirNewer ? '' : ' DESC' ); - if ( !isset( $this->options['ORDER BY'] ) ) { - $this->addOption( 'ORDER BY', $order ); - } else { - $this->addOption( 'ORDER BY', $this->options['ORDER BY'] . ', ' . $order ); - } + // Append ORDER BY + $optionOrderBy = isset( $this->options['ORDER BY'] ) + ? (array)$this->options['ORDER BY'] + : []; + $optionOrderBy[] = $order; + $this->addOption( 'ORDER BY', $optionOrderBy ); } } + /** + * 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 ); + } + /** * Add an option such as LIMIT or USE INDEX. If an option was set * before, the old value will be overwritten - * @param $name string Option name - * @param $value string Option value + * @param string $name Option name + * @param string|string[] $value Option value */ protected function addOption( $name, $value = null ) { if ( is_null( $value ) ) { @@ -244,95 +338,176 @@ abstract class ApiQueryBase extends ApiBase { /** * Execute a SELECT query based on the values in the internal arrays - * @param $method string Function the query should be attributed to. + * @param string $method Function the query should be attributed to. * You should usually use __METHOD__ here - * @param $extraQuery array Query data to add but not store in the object - * Format is array( 'tables' => ..., 'fields' => ..., 'where' => ..., 'options' => ..., 'join_conds' => ... ) + * @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() ) { - - $tables = array_merge( $this->tables, isset( $extraQuery['tables'] ) ? (array)$extraQuery['tables'] : array() ); - $fields = array_merge( $this->fields, isset( $extraQuery['fields'] ) ? (array)$extraQuery['fields'] : array() ); - $where = array_merge( $this->where, isset( $extraQuery['where'] ) ? (array)$extraQuery['where'] : array() ); - $options = array_merge( $this->options, isset( $extraQuery['options'] ) ? (array)$extraQuery['options'] : array() ); - $join_conds = array_merge( $this->join_conds, isset( $extraQuery['join_conds'] ) ? (array)$extraQuery['join_conds'] : array() ); + 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( $tables, $fields, $where, $method, $options, $join_conds ); - $this->profileDBOut(); + if ( $hookData !== null ) { + Hooks::run( 'ApiQueryBaseAfterQuery', [ $this, $res, &$hookData ] ); + } return $res; } /** - * Estimate the row count for the SELECT query that would be run if we - * called select() right now, and check if it's acceptable. - * @return bool true if acceptable, false otherwise + * 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 */ - protected function checkRowCount() { + protected function processRow( $row, array &$data, array &$hookData ) { + return Hooks::run( 'ApiQueryBaseProcessRow', [ $this, $row, &$data, &$hookData ] ); + } + + /** + * @param string $query + * @param string $protocol + * @return null|string + */ + public function prepareUrlQuerySearchString( $query = null, $protocol = null ) { $db = $this->getDB(); - $this->profileDBIn(); - $rowcount = $db->estimateRowCount( $this->tables, $this->fields, $this->where, __METHOD__, $this->options ); - $this->profileDBOut(); + if ( !is_null( $query ) || $query != '' ) { + if ( is_null( $protocol ) ) { + $protocol = 'http://'; + } - global $wgAPIMaxDBRows; - if ( $rowcount > $wgAPIMaxDBRows ) { - return false; + $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 true; + + return null; } /** - * Add information (title and namespace) about a Title object to a - * result array - * @param $arr array Result array à la ApiResult - * @param $title Title - * @param $prefix string Module prefix + * Filters hidden users (where the user doesn't have the right to view them) + * Also adds relevant block information + * + * @param bool $showBlockInfo + * @return void */ - public static function addTitleInfo( &$arr, $title, $prefix = '' ) { - $arr[$prefix . 'ns'] = intval( $title->getNamespace() ); - $arr[$prefix . 'title'] = $title->getPrefixedText(); + 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' ); + } } - /** - * Override this method to request extra fields from the pageSet - * using $pageSet->requestField('fieldName') - * @param $pageSet ApiPageSet + /**@}*/ + + /************************************************************************//** + * @name Utility methods + * @{ */ - public function requestExtraData( $pageSet ) { - } /** - * Get the main Query module - * @return ApiQuery + * 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 */ - public function getQuery() { - return $this->mQueryModule; + public static function addTitleInfo( &$arr, $title, $prefix = '' ) { + $arr[$prefix . 'ns'] = intval( $title->getNamespace() ); + $arr[$prefix . 'title'] = $title->getPrefixedText(); } /** * Add a sub-element under the page element with the given page ID - * @param $pageId int Page ID - * @param $data array Data array à la ApiResult + * @param int $pageId Page ID + * @param array $data Data array à la ApiResult * @return bool Whether the element fit in the result */ protected function addPageSubItems( $pageId, $data ) { $result = $this->getResult(); - $result->setIndexedTagName( $data, $this->getModulePrefix() ); - return $result->addValue( array( 'query', 'pages', intval( $pageId ) ), + ApiResult::setIndexedTagName( $data, $this->getModulePrefix() ); + + return $result->addValue( [ 'query', 'pages', intval( $pageId ) ], $this->getModuleName(), $data ); } /** * Same as addPageSubItems(), but one element of $data at a time - * @param $pageId int Page ID - * @param $item array Data array à la ApiResult - * @param $elemname string XML element name. If null, getModuleName() + * @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 */ @@ -341,197 +516,101 @@ abstract class ApiQueryBase extends ApiBase { $elemname = $this->getModulePrefix(); } $result = $this->getResult(); - $fit = $result->addValue( array( 'query', 'pages', $pageId, - $this->getModuleName() ), null, $item ); + $fit = $result->addValue( [ 'query', 'pages', $pageId, + $this->getModuleName() ], null, $item ); if ( !$fit ) { return false; } - $result->setIndexedTagName_internal( array( 'query', 'pages', $pageId, - $this->getModuleName() ), $elemname ); + $result->addIndexedTagName( [ 'query', 'pages', $pageId, + $this->getModuleName() ], $elemname ); + return true; } /** * Set a query-continue value - * @param $paramName string Parameter name - * @param $paramValue string Parameter value + * @param string $paramName Parameter name + * @param string|array $paramValue Parameter value */ protected function setContinueEnumParameter( $paramName, $paramValue ) { - $paramName = $this->encodeParamName( $paramName ); - $msg = array( $paramName => $paramValue ); - $this->getResult()->disableSizeCheck(); - $this->getResult()->addValue( 'query-continue', $this->getModuleName(), $msg ); - $this->getResult()->enableSizeCheck(); - } - - /** - * Get the Query database connection (read-only) - * @return Database - */ - protected function getDB() { - if ( is_null( $this->mDb ) ) { - $apiQuery = $this->getQuery(); - $this->mDb = $apiQuery->getDB(); - } - return $this->mDb; - } - - /** - * Selects the query database connection with the given name. - * See ApiQuery::getNamedDB() for more information - * @param $name string Name to assign to the database connection - * @param $db int One of the DB_* constants - * @param $groups array Query groups - * @return Database - */ - public function selectNamedDB( $name, $db, $groups ) { - $this->mDb = $this->getQuery()->getNamedDB( $name, $db, $groups ); - } - - /** - * Get the PageSet object to work on - * @return ApiPageSet - */ - protected function getPageSet() { - return $this->getQuery()->getPageSet(); - } - - /** - * Convert a title to a DB key - * @param $title string Page title with spaces - * @return string Page title with underscores - */ - public function titleToKey( $title ) { - // Don't throw an error if we got an empty string - if ( trim( $title ) == '' ) { - return ''; - } - $t = Title::newFromText( $title ); - if ( !$t ) { - $this->dieUsageMsg( array( 'invalidtitle', $title ) ); - } - return $t->getPrefixedDbKey(); + $this->getContinuationManager()->addContinueParam( $this, $paramName, $paramValue ); } /** - * The inverse of titleToKey() - * @param $key string Page title with underscores - * @return string Page title with spaces - */ - public function keyToTitle( $key ) { - // Don't throw an error if we got an empty string - if ( trim( $key ) == '' ) { - return ''; + * 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 ) ] ); } - $t = Title::newFromDbKey( $key ); - // This really shouldn't happen but we gotta check anyway - if ( !$t ) { - $this->dieUsageMsg( array( 'invalidtitle', $key ) ); + 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 $t->getPrefixedText(); - } - - /** - * An alternative to titleToKey() that doesn't trim trailing spaces - * @param $titlePart string Title part with spaces - * @return string Title part with underscores - */ - public function titlePartToKey( $titlePart ) { - return substr( $this->titleToKey( $titlePart . 'x' ), 0, - 1 ); - } - /** - * An alternative to keyToTitle() that doesn't trim trailing spaces - * @param $keyPart string Key part with spaces - * @return string Key part with underscores - */ - public function keyPartToTitle( $keyPart ) { - return substr( $this->keyToTitle( $keyPart . 'x' ), 0, - 1 ); + return substr( $t->getDBkey(), 0, -1 ); } /** - * Filters hidden users (where the user doesn't have the right to view them) - * Also adds relevant block information + * Convert an input title or title prefix into a namespace constant and dbkey. * - * @param bool $showBlockInfo - * @return void - */ - public function showHiddenUsersAddBlockInfo( $showBlockInfo ) { - global $wgUser; - $userCanViewHiddenUsers = $wgUser->isAllowed( 'hideuser' ); - - if ( $showBlockInfo || !$userCanViewHiddenUsers ) { - $this->addTables( 'ipblocks' ); - $this->addJoinConds( array( - 'ipblocks' => array( 'LEFT JOIN', 'ipb_user=user_id' ), - ) ); - - $this->addFields( 'ipb_deleted' ); - - if ( $showBlockInfo ) { - $this->addFields( array( 'ipb_reason', 'ipb_by_text', 'ipb_expiry' ) ); - } - - // Don't show hidden names - if ( !$userCanViewHiddenUsers ) { - $this->addWhere( 'ipb_deleted = 0 OR ipb_deleted IS NULL' ); - } + * @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 getPossibleErrors() { - return array_merge( parent::getPossibleErrors(), array( - array( 'invalidtitle', 'title' ), - array( 'invalidtitle', 'key' ), - ) ); + return [ $t->getNamespace(), substr( $t->getDBkey(), 0, -1 ) ]; } /** - * Get version string for use in the API help output - * @return string + * @param string $hash + * @return bool */ - public static function getBaseVersion() { - return __CLASS__ . ': $Id$'; - } -} - -/** - * @ingroup API - */ -abstract class ApiQueryGeneratorBase extends ApiQueryBase { - - private $mIsGenerator; - - public function __construct( $query, $moduleName, $paramPrefix = '' ) { - parent::__construct( $query, $moduleName, $paramPrefix ); - $this->mIsGenerator = false; + public function validateSha1Hash( $hash ) { + return (bool)preg_match( '/^[a-f0-9]{40}$/', $hash ); } /** - * Switch this module to generator mode. By default, generator mode is - * switched off and the module acts like a normal query module. + * @param string $hash + * @return bool */ - public function setGeneratorMode() { - $this->mIsGenerator = true; + public function validateSha1Base36Hash( $hash ) { + return (bool)preg_match( '/^[a-z0-9]{31}$/', $hash ); } /** - * Overrides base class to prepend 'g' to every generator parameter - * @param $paramName string Parameter name - * @return string Prefixed parameter name + * Check whether the current user has permission to view revision-deleted + * fields. + * @return bool */ - public function encodeParamName( $paramName ) { - if ( $this->mIsGenerator ) { - return 'g' . parent::encodeParamName( $paramName ); - } else { - return parent::encodeParamName( $paramName ); - } + public function userCanSeeRevDel() { + return $this->getUser()->isAllowedAny( + 'deletedhistory', + 'deletedtext', + 'suppressrevision', + 'viewsuppressed' + ); } - /** - * Execute this module as a generator - * @param $resultPageSet ApiPageSet: All output should be appended to - * this object - */ - public abstract function executeGenerator( $resultPageSet ); + /**@}*/ }