X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/api/ApiQueryAllpages.php diff --git a/includes/api/ApiQueryAllpages.php b/includes/api/ApiQueryAllpages.php index 1a2196c5..315def04 100644 --- a/includes/api/ApiQueryAllpages.php +++ b/includes/api/ApiQueryAllpages.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 @@ -23,20 +23,16 @@ * * @file */ - -if ( !defined( 'MEDIAWIKI' ) ) { - // Eclipse helper - will be ignored in production - require_once( 'ApiQueryBase.php' ); -} +use MediaWiki\MediaWikiServices; /** * Query module to enumerate all available pages. * * @ingroup API */ -class ApiQueryAllpages extends ApiQueryGeneratorBase { +class ApiQueryAllPages extends ApiQueryGeneratorBase { - public function __construct( $query, $moduleName ) { + public function __construct( ApiQuery $query, $moduleName ) { parent::__construct( $query, $moduleName, 'ap' ); } @@ -48,14 +44,22 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase { return 'public'; } + /** + * @param ApiPageSet $resultPageSet + * @return void + */ public function executeGenerator( $resultPageSet ) { if ( $resultPageSet->isResolvingRedirects() ) { - $this->dieUsage( 'Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator', 'params' ); + $this->dieWithError( 'apierror-allpages-generator-redirects', 'params' ); } $this->run( $resultPageSet ); } + /** + * @param ApiPageSet $resultPageSet + * @return void + */ private function run( $resultPageSet = null ) { $db = $this->getDB(); @@ -64,32 +68,61 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase { // Page filters $this->addTables( 'page' ); - if ( $params['filterredir'] == 'redirects' ) { - $this->addWhereFld( 'page_is_redirect', 1 ); - } elseif ( $params['filterredir'] == 'nonredirects' ) { - $this->addWhereFld( 'page_is_redirect', 0 ); + if ( !is_null( $params['continue'] ) ) { + $cont = explode( '|', $params['continue'] ); + $this->dieContinueUsageIf( count( $cont ) != 1 ); + $op = $params['dir'] == 'descending' ? '<' : '>'; + $cont_from = $db->addQuotes( $cont[0] ); + $this->addWhere( "page_title $op= $cont_from" ); + } + + $miserMode = $this->getConfig()->get( 'MiserMode' ); + if ( !$miserMode ) { + if ( $params['filterredir'] == 'redirects' ) { + $this->addWhereFld( 'page_is_redirect', 1 ); + } elseif ( $params['filterredir'] == 'nonredirects' ) { + $this->addWhereFld( 'page_is_redirect', 0 ); + } } $this->addWhereFld( 'page_namespace', $params['namespace'] ); $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' ); - $from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) ); - $to = ( is_null( $params['to'] ) ? null : $this->titlePartToKey( $params['to'] ) ); + $from = ( $params['from'] === null + ? null + : $this->titlePartToKey( $params['from'], $params['namespace'] ) ); + $to = ( $params['to'] === null + ? null + : $this->titlePartToKey( $params['to'], $params['namespace'] ) ); $this->addWhereRange( 'page_title', $dir, $from, $to ); - + if ( isset( $params['prefix'] ) ) { - $this->addWhere( 'page_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) ); + $this->addWhere( 'page_title' . $db->buildLike( + $this->titlePartToKey( $params['prefix'], $params['namespace'] ), + $db->anyString() ) ); } if ( is_null( $resultPageSet ) ) { - $selectFields = array( + $selectFields = [ 'page_namespace', 'page_title', 'page_id' - ); + ]; } else { $selectFields = $resultPageSet->getPageTableFields(); } + $miserModeFilterRedirValue = null; + $miserModeFilterRedir = $miserMode && $params['filterredir'] !== 'all'; + if ( $miserModeFilterRedir ) { + $selectFields[] = 'page_is_redirect'; + + if ( $params['filterredir'] == 'redirects' ) { + $miserModeFilterRedirValue = 1; + } elseif ( $params['filterredir'] == 'nonredirects' ) { + $miserModeFilterRedirValue = 0; + } + } + $this->addFields( $selectFields ); $forceNameTitleIndex = true; if ( isset( $params['minsize'] ) ) { @@ -103,46 +136,73 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase { } // Page protection filtering - if ( !empty( $params['prtype'] ) ) { + if ( count( $params['prtype'] ) || $params['prexpiry'] != 'all' ) { $this->addTables( 'page_restrictions' ); $this->addWhere( 'page_id=pr_page' ); - $this->addWhere( 'pr_expiry>' . $db->addQuotes( $db->timestamp() ) ); - $this->addWhereFld( 'pr_type', $params['prtype'] ); + $this->addWhere( "pr_expiry > {$db->addQuotes( $db->timestamp() )} OR pr_expiry IS NULL" ); + + if ( count( $params['prtype'] ) ) { + $this->addWhereFld( 'pr_type', $params['prtype'] ); - if ( isset( $params['prlevel'] ) ) { - // Remove the empty string and '*' from the prlevel array - $prlevel = array_diff( $params['prlevel'], array( '', '*' ) ); + if ( isset( $params['prlevel'] ) ) { + // Remove the empty string and '*' from the prlevel array + $prlevel = array_diff( $params['prlevel'], [ '', '*' ] ); - if ( !empty( $prlevel ) ) { - $this->addWhereFld( 'pr_level', $prlevel ); + if ( count( $prlevel ) ) { + $this->addWhereFld( 'pr_level', $prlevel ); + } + } + if ( $params['prfiltercascade'] == 'cascading' ) { + $this->addWhereFld( 'pr_cascade', 1 ); + } elseif ( $params['prfiltercascade'] == 'noncascading' ) { + $this->addWhereFld( 'pr_cascade', 0 ); } } - if ( $params['prfiltercascade'] == 'cascading' ) { - $this->addWhereFld( 'pr_cascade', 1 ); - } elseif ( $params['prfiltercascade'] == 'noncascading' ) { - $this->addWhereFld( 'pr_cascade', 0 ); + $forceNameTitleIndex = false; + + if ( $params['prexpiry'] == 'indefinite' ) { + $this->addWhere( "pr_expiry = {$db->addQuotes( $db->getInfinity() )} OR pr_expiry IS NULL" ); + } elseif ( $params['prexpiry'] == 'definite' ) { + $this->addWhere( "pr_expiry != {$db->addQuotes( $db->getInfinity() )}" ); } $this->addOption( 'DISTINCT' ); - - $forceNameTitleIndex = false; - } elseif ( isset( $params['prlevel'] ) ) { - $this->dieUsage( 'prlevel may not be used without prtype', 'params' ); + $this->dieWithError( + [ 'apierror-invalidparammix-mustusewith', 'prlevel', 'prtype' ], 'invalidparammix' + ); } if ( $params['filterlanglinks'] == 'withoutlanglinks' ) { $this->addTables( 'langlinks' ); - $this->addJoinConds( array( 'langlinks' => array( 'LEFT JOIN', 'page_id=ll_from' ) ) ); + $this->addJoinConds( [ 'langlinks' => [ 'LEFT JOIN', 'page_id=ll_from' ] ] ); $this->addWhere( 'll_from IS NULL' ); $forceNameTitleIndex = false; } elseif ( $params['filterlanglinks'] == 'withlanglinks' ) { $this->addTables( 'langlinks' ); $this->addWhere( 'page_id=ll_from' ); $this->addOption( 'STRAIGHT_JOIN' ); - // We have to GROUP BY all selected fields to stop - // PostgreSQL from whining - $this->addOption( 'GROUP BY', implode( ', ', $selectFields ) ); + + // MySQL filesorts if we use a GROUP BY that works with the rules + // in the 1992 SQL standard (it doesn't like having the + // constant-in-WHERE page_namespace column in there). Using the + // 1999 rules works fine, but that breaks other DBs. Sigh. + /// @todo Once we drop support for 1992-rule DBs, we can simplify this. + $dbType = $db->getType(); + if ( $dbType === 'mysql' || $dbType === 'sqlite' ) { + // Ignore the rules, or 1999 rules if you count unique keys + // over non-NULL columns as satisfying the requirement for + // "functional dependency" and don't require including + // constant-in-WHERE columns in the GROUP BY. + $this->addOption( 'GROUP BY', [ 'page_title' ] ); + } elseif ( $dbType === 'postgres' && $db->getServerVersion() >= 9.1 ) { + // 1999 rules only counting primary keys + $this->addOption( 'GROUP BY', [ 'page_title', 'page_id' ] ); + } else { + // 1992 rules + $this->addOption( 'GROUP BY', $selectFields ); + } + $forceNameTitleIndex = false; } @@ -154,26 +214,41 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase { $this->addOption( 'LIMIT', $limit + 1 ); $res = $this->select( __METHOD__ ); + // Get gender information + if ( MWNamespace::hasGenderDistinction( $params['namespace'] ) ) { + $users = []; + foreach ( $res as $row ) { + $users[] = $row->page_title; + } + MediaWikiServices::getInstance()->getGenderCache()->doQuery( $users, __METHOD__ ); + $res->rewind(); // reset + } + $count = 0; $result = $this->getResult(); foreach ( $res as $row ) { - if ( ++ $count > $limit ) { - // We've reached the one extra which shows that there are additional pages to be had. Stop here... - // TODO: Security issue - if the user has no right to view next title, it will still be shown - $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->page_title ) ); + if ( ++$count > $limit ) { + // We've reached the one extra which shows that there are + // additional pages to be had. Stop here... + $this->setContinueEnumParameter( 'continue', $row->page_title ); break; } + if ( $miserModeFilterRedir && (int)$row->page_is_redirect !== $miserModeFilterRedirValue ) { + // Filter implemented in PHP due to being in Miser Mode + continue; + } + if ( is_null( $resultPageSet ) ) { $title = Title::makeTitle( $row->page_namespace, $row->page_title ); - $vals = array( + $vals = [ 'pageid' => intval( $row->page_id ), 'ns' => intval( $title->getNamespace() ), 'title' => $title->getPrefixedText() - ); - $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $vals ); + ]; + $fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $vals ); if ( !$fit ) { - $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->page_title ) ); + $this->setContinueEnumParameter( 'continue', $row->page_title ); break; } } else { @@ -182,120 +257,104 @@ class ApiQueryAllpages extends ApiQueryGeneratorBase { } if ( is_null( $resultPageSet ) ) { - $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'p' ); + $result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'p' ); } } public function getAllowedParams() { - global $wgRestrictionLevels; - - return array( + $ret = [ 'from' => null, + 'continue' => [ + ApiBase::PARAM_HELP_MSG => 'api-help-param-continue', + ], 'to' => null, 'prefix' => null, - 'namespace' => array( - ApiBase::PARAM_DFLT => 0, + 'namespace' => [ + ApiBase::PARAM_DFLT => NS_MAIN, ApiBase::PARAM_TYPE => 'namespace', - ), - 'filterredir' => array( + ], + 'filterredir' => [ ApiBase::PARAM_DFLT => 'all', - ApiBase::PARAM_TYPE => array( + ApiBase::PARAM_TYPE => [ 'all', 'redirects', 'nonredirects' - ) - ), - 'minsize' => array( + ] + ], + 'minsize' => [ ApiBase::PARAM_TYPE => 'integer', - ), - 'maxsize' => array( + ], + 'maxsize' => [ ApiBase::PARAM_TYPE => 'integer', - ), - 'prtype' => array( + ], + 'prtype' => [ ApiBase::PARAM_TYPE => Title::getFilteredRestrictionTypes( true ), ApiBase::PARAM_ISMULTI => true - ), - 'prlevel' => array( - ApiBase::PARAM_TYPE => $wgRestrictionLevels, + ], + 'prlevel' => [ + ApiBase::PARAM_TYPE => $this->getConfig()->get( 'RestrictionLevels' ), ApiBase::PARAM_ISMULTI => true - ), - 'prfiltercascade' => array( + ], + 'prfiltercascade' => [ ApiBase::PARAM_DFLT => 'all', - ApiBase::PARAM_TYPE => array( + ApiBase::PARAM_TYPE => [ 'cascading', 'noncascading', 'all' - ), - ), - 'limit' => array( + ], + ], + 'limit' => [ ApiBase::PARAM_DFLT => 10, ApiBase::PARAM_TYPE => 'limit', ApiBase::PARAM_MIN => 1, ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 - ), - 'dir' => array( + ], + 'dir' => [ ApiBase::PARAM_DFLT => 'ascending', - ApiBase::PARAM_TYPE => array( + ApiBase::PARAM_TYPE => [ 'ascending', 'descending' - ) - ), - 'filterlanglinks' => array( - ApiBase::PARAM_TYPE => array( + ] + ], + 'filterlanglinks' => [ + ApiBase::PARAM_TYPE => [ 'withlanglinks', 'withoutlanglinks', 'all' - ), + ], ApiBase::PARAM_DFLT => 'all' - ) - ); - } - - public function getParamDescription() { - $p = $this->getModulePrefix(); - return array( - 'from' => 'The page title to start enumerating from', - 'to' => 'The page title to stop enumerating at', - 'prefix' => 'Search for all page titles that begin with this value', - 'namespace' => 'The namespace to enumerate', - 'filterredir' => 'Which pages to list', - 'dir' => 'The direction in which to list', - 'minsize' => 'Limit to pages with at least this many bytes', - 'maxsize' => 'Limit to pages with at most this many bytes', - 'prtype' => 'Limit to protected pages only', - 'prlevel' => "The protection level (must be used with {$p}prtype= parameter)", - 'prfiltercascade' => "Filter protections based on cascadingness (ignored when {$p}prtype isn't set)", - 'filterlanglinks' => 'Filter based on whether a page has langlinks', - 'limit' => 'How many total pages to return.' - ); - } + ], + 'prexpiry' => [ + ApiBase::PARAM_TYPE => [ + 'indefinite', + 'definite', + 'all' + ], + ApiBase::PARAM_DFLT => 'all' + ], + ]; - public function getDescription() { - return 'Enumerate all pages sequentially in a given namespace'; - } + if ( $this->getConfig()->get( 'MiserMode' ) ) { + $ret['filterredir'][ApiBase::PARAM_HELP_MSG_APPEND] = [ 'api-help-param-limited-in-miser-mode' ]; + } - public function getPossibleErrors() { - return array_merge( parent::getPossibleErrors(), array( - array( 'code' => 'params', 'info' => 'Use "gapfilterredir=nonredirects" option instead of "redirects" when using allpages as a generator' ), - array( 'code' => 'params', 'info' => 'prlevel may not be used without prtype' ), - ) ); + return $ret; } - protected function getExamples() { - return array( - 'Simple Use', - ' Show a list of pages starting at the letter "B"', - ' api.php?action=query&list=allpages&apfrom=B', - 'Using as Generator', - ' Show info about 4 pages starting at the letter "T"', - ' api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info', - ' Show content of first 2 non-redirect pages begining at "Re"', - ' api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content' - ); + protected function getExamplesMessages() { + return [ + 'action=query&list=allpages&apfrom=B' + => 'apihelp-query+allpages-example-B', + 'action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info' + => 'apihelp-query+allpages-example-generator', + 'action=query&generator=allpages&gaplimit=2&' . + 'gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content' + => 'apihelp-query+allpages-example-generator-revisions', + ]; } - public function getVersion() { - return __CLASS__ . ': $Id$'; + public function getHelpUrls() { + return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allpages'; } }