From 222b01f5169f1c7e69762e0e8904c24f78f71882 Mon Sep 17 00:00:00 2001 From: Pierre Schmitz Date: Wed, 28 Jul 2010 11:52:48 +0200 Subject: update to MediaWiki 1.16.0 --- includes/api/ApiQueryCategoryMembers.php | 186 ++++++++++++++++++------------- 1 file changed, 109 insertions(+), 77 deletions(-) (limited to 'includes/api/ApiQueryCategoryMembers.php') diff --git a/includes/api/ApiQueryCategoryMembers.php b/includes/api/ApiQueryCategoryMembers.php index 45461abd..107f5049 100644 --- a/includes/api/ApiQueryCategoryMembers.php +++ b/includes/api/ApiQueryCategoryMembers.php @@ -23,9 +23,9 @@ * http://www.gnu.org/copyleft/gpl.html */ -if (!defined('MEDIAWIKI')) { +if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production - require_once ("ApiQueryBase.php"); + require_once ( "ApiQueryBase.php" ); } /** @@ -35,8 +35,8 @@ if (!defined('MEDIAWIKI')) { */ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase { - public function __construct($query, $moduleName) { - parent :: __construct($query, $moduleName, 'cm'); + public function __construct( $query, $moduleName ) { + parent :: __construct( $query, $moduleName, 'cm' ); } public function execute() { @@ -47,113 +47,128 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase { return 'public'; } - public function executeGenerator($resultPageSet) { - $this->run($resultPageSet); + public function executeGenerator( $resultPageSet ) { + $this->run( $resultPageSet ); } - private function run($resultPageSet = null) { + private function run( $resultPageSet = null ) { $params = $this->extractRequestParams(); - if ( !isset($params['title']) || is_null($params['title']) ) - $this->dieUsage("The cmtitle parameter is required", 'notitle'); - $categoryTitle = Title::newFromText($params['title']); + if ( !isset( $params['title'] ) || is_null( $params['title'] ) ) + $this->dieUsage( "The cmtitle parameter is required", 'notitle' ); + $categoryTitle = Title::newFromText( $params['title'] ); if ( is_null( $categoryTitle ) || $categoryTitle->getNamespace() != NS_CATEGORY ) - $this->dieUsage("The category name you entered is not valid", 'invalidcategory'); + $this->dieUsage( "The category name you entered is not valid", 'invalidcategory' ); - $prop = array_flip($params['prop']); - $fld_ids = isset($prop['ids']); - $fld_title = isset($prop['title']); - $fld_sortkey = isset($prop['sortkey']); - $fld_timestamp = isset($prop['timestamp']); + $prop = array_flip( $params['prop'] ); + $fld_ids = isset( $prop['ids'] ); + $fld_title = isset( $prop['title'] ); + $fld_sortkey = isset( $prop['sortkey'] ); + $fld_timestamp = isset( $prop['timestamp'] ); - if (is_null($resultPageSet)) { - $this->addFields(array('cl_from', 'cl_sortkey', 'page_namespace', 'page_title')); - $this->addFieldsIf('page_id', $fld_ids); + if ( is_null( $resultPageSet ) ) { + $this->addFields( array( 'cl_from', 'cl_sortkey', 'page_namespace', 'page_title' ) ); + $this->addFieldsIf( 'page_id', $fld_ids ); } else { - $this->addFields($resultPageSet->getPageTableFields()); // will include page_ id, ns, title - $this->addFields(array('cl_from', 'cl_sortkey')); + $this->addFields( $resultPageSet->getPageTableFields() ); // will include page_ id, ns, title + $this->addFields( array( 'cl_from', 'cl_sortkey' ) ); } - $this->addFieldsIf('cl_timestamp', $fld_timestamp || $params['sort'] == 'timestamp'); - $this->addTables(array('page','categorylinks')); // must be in this order for 'USE INDEX' + $this->addFieldsIf( 'cl_timestamp', $fld_timestamp || $params['sort'] == 'timestamp' ); + $this->addTables( array( 'page', 'categorylinks' ) ); // must be in this order for 'USE INDEX' // Not needed after bug 10280 is applied to servers - if($params['sort'] == 'timestamp') - $this->addOption('USE INDEX', 'cl_timestamp'); + if ( $params['sort'] == 'timestamp' ) + $this->addOption( 'USE INDEX', 'cl_timestamp' ); else - $this->addOption('USE INDEX', 'cl_sortkey'); - - $this->addWhere('cl_from=page_id'); - $this->setContinuation($params['continue'], $params['dir']); - $this->addWhereFld('cl_to', $categoryTitle->getDBkey()); - $this->addWhereFld('page_namespace', $params['namespace']); - if($params['sort'] == 'timestamp') - $this->addWhereRange('cl_timestamp', ($params['dir'] == 'asc' ? 'newer' : 'older'), $params['start'], $params['end']); + $this->addOption( 'USE INDEX', 'cl_sortkey' ); + + $this->addWhere( 'cl_from=page_id' ); + $this->setContinuation( $params['continue'], $params['dir'] ); + $this->addWhereFld( 'cl_to', $categoryTitle->getDBkey() ); + // Scanning large datasets for rare categories sucks, and I already told + // how to have efficient subcategory access :-) ~~~~ (oh well, domas) + global $wgMiserMode; + $miser_ns = array(); + if ( $wgMiserMode ) { + $miser_ns = $params['namespace']; + } else { + $this->addWhereFld( 'page_namespace', $params['namespace'] ); + } + if ( $params['sort'] == 'timestamp' ) + $this->addWhereRange( 'cl_timestamp', ( $params['dir'] == 'asc' ? 'newer' : 'older' ), $params['start'], $params['end'] ); else { - $this->addWhereRange('cl_sortkey', ($params['dir'] == 'asc' ? 'newer' : 'older'), $params['startsortkey'], $params['endsortkey']); - $this->addWhereRange('cl_from', ($params['dir'] == 'asc' ? 'newer' : 'older'), null, null); + $this->addWhereRange( 'cl_sortkey', ( $params['dir'] == 'asc' ? 'newer' : 'older' ), $params['startsortkey'], $params['endsortkey'] ); + $this->addWhereRange( 'cl_from', ( $params['dir'] == 'asc' ? 'newer' : 'older' ), null, null ); } $limit = $params['limit']; - $this->addOption('LIMIT', $limit +1); + $this->addOption( 'LIMIT', $limit + 1 ); $db = $this->getDB(); $data = array (); $count = 0; $lastSortKey = null; - $res = $this->select(__METHOD__); - while ($row = $db->fetchObject($res)) { - if (++ $count > $limit) { + $res = $this->select( __METHOD__ ); + while ( $row = $db->fetchObject( $res ) ) { + 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 - if ($params['sort'] == 'timestamp') - $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->cl_timestamp)); + if ( $params['sort'] == 'timestamp' ) + $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->cl_timestamp ) ); else - $this->setContinueEnumParameter('continue', $this->getContinueStr($row, $lastSortKey)); + $this->setContinueEnumParameter( 'continue', $this->getContinueStr( $row, $lastSortKey ) ); break; } - if (is_null($resultPageSet)) { + // Since domas won't tell anyone what he told long ago, apply + // cmnamespace here. This means the query may return 0 actual + // results, but on the other hand it could save returning 5000 + // useless results to the client. ~~~~ + if ( count( $miser_ns ) && !in_array( $row->page_namespace, $miser_ns ) ) + continue; + + if ( is_null( $resultPageSet ) ) { $vals = array(); - if ($fld_ids) - $vals['pageid'] = intval($row->page_id); - if ($fld_title) { - $title = Title :: makeTitle($row->page_namespace, $row->page_title); - ApiQueryBase::addTitleInfo($vals, $title); + if ( $fld_ids ) + $vals['pageid'] = intval( $row->page_id ); + if ( $fld_title ) { + $title = Title :: makeTitle( $row->page_namespace, $row->page_title ); + ApiQueryBase::addTitleInfo( $vals, $title ); } - if ($fld_sortkey) + if ( $fld_sortkey ) $vals['sortkey'] = $row->cl_sortkey; - if ($fld_timestamp) - $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp); - $fit = $this->getResult()->addValue(array('query', $this->getModuleName()), - null, $vals); - if(!$fit) + if ( $fld_timestamp ) + $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp ); + $fit = $this->getResult()->addValue( array( 'query', $this->getModuleName() ), + null, $vals ); + if ( !$fit ) { - if ($params['sort'] == 'timestamp') - $this->setContinueEnumParameter('start', wfTimestamp(TS_ISO_8601, $row->cl_timestamp)); + if ( $params['sort'] == 'timestamp' ) + $this->setContinueEnumParameter( 'start', wfTimestamp( TS_ISO_8601, $row->cl_timestamp ) ); else - $this->setContinueEnumParameter('continue', $this->getContinueStr($row, $lastSortKey)); + $this->setContinueEnumParameter( 'continue', $this->getContinueStr( $row, $lastSortKey ) ); break; } } else { - $resultPageSet->processDbRow($row); + $resultPageSet->processDbRow( $row ); } $lastSortKey = $row->cl_sortkey; // detect duplicate sortkeys } - $db->freeResult($res); + $db->freeResult( $res ); - if (is_null($resultPageSet)) { + if ( is_null( $resultPageSet ) ) { $this->getResult()->setIndexedTagName_internal( - array('query', $this->getModuleName()), 'cm'); + array( 'query', $this->getModuleName() ), 'cm' ); } } - private function getContinueStr($row, $lastSortKey) { + private function getContinueStr( $row, $lastSortKey ) { $ret = $row->cl_sortkey . '|'; - if ($row->cl_sortkey == $lastSortKey) // duplicate sort key, add cl_from + if ( $row->cl_sortkey == $lastSortKey ) // duplicate sort key, add cl_from $ret .= $row->cl_from; return $ret; } @@ -161,24 +176,24 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase { /** * Add DB WHERE clause to continue previous query based on 'continue' parameter */ - private function setContinuation($continue, $dir) { - if (is_null($continue)) + private function setContinuation( $continue, $dir ) { + if ( is_null( $continue ) ) return; // This is not a continuation request - $pos = strrpos($continue, '|'); - $sortkey = substr($continue, 0, $pos); - $fromstr = substr($continue, $pos + 1); - $from = intval($fromstr); + $pos = strrpos( $continue, '|' ); + $sortkey = substr( $continue, 0, $pos ); + $fromstr = substr( $continue, $pos + 1 ); + $from = intval( $fromstr ); - if ($from == 0 && strlen($fromstr) > 0) - $this->dieUsage("Invalid continue param. You should pass the original value returned by the previous query", "badcontinue"); + if ( $from == 0 && strlen( $fromstr ) > 0 ) + $this->dieUsage( "Invalid continue param. You should pass the original value returned by the previous query", "badcontinue" ); - $encSortKey = $this->getDB()->addQuotes($sortkey); - $encFrom = $this->getDB()->addQuotes($from); + $encSortKey = $this->getDB()->addQuotes( $sortkey ); + $encFrom = $this->getDB()->addQuotes( $from ); - $op = ($dir == 'desc' ? '<' : '>'); + $op = ( $dir == 'desc' ? '<' : '>' ); - if ($from != 0) { + if ( $from != 0 ) { // Duplicate sort key continue $this->addWhere( "cl_sortkey$op$encSortKey OR (cl_sortkey=$encSortKey AND cl_from$op=$encFrom)" ); } else { @@ -237,7 +252,8 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase { } public function getParamDescription() { - return array ( + global $wgMiserMode; + $desc = array ( 'title' => 'Which category to enumerate (required). Must include Category: prefix', 'prop' => 'What pieces of information to include', 'namespace' => 'Only include pages in these namespaces', @@ -250,11 +266,27 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase { 'continue' => 'For large categories, give the value retured from previous query', 'limit' => 'The maximum number of pages to return.', ); + if ( $wgMiserMode ) { + $desc['namespace'] = array( + $desc['namespace'], + 'NOTE: Due to $wgMiserMode, using this may result in fewer than "limit" results', + 'returned before continuing; in extreme cases, zero results may be returned.', + ); + } + return $desc; } public function getDescription() { return 'List all pages in a given category'; } + + public function getPossibleErrors() { + return array_merge( parent::getPossibleErrors(), array( + array( 'code' => 'notitle', 'info' => 'The cmtitle parameter is required' ), + array( 'code' => 'invalidcategory', 'info' => 'The category name you entered is not valid' ), + array( 'code' => 'badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ), + ) ); + } protected function getExamples() { return array ( @@ -266,6 +298,6 @@ class ApiQueryCategoryMembers extends ApiQueryGeneratorBase { } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryCategoryMembers.php 69986 2010-07-27 03:57:39Z tstarling $'; + return __CLASS__ . ': $Id: ApiQueryCategoryMembers.php 69932 2010-07-26 08:03:21Z tstarling $'; } } -- cgit v1.2.2