X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/74c929b24b048c9f1e31e17db757ae4195cd7673..d57edfddd6c01f0ed6b1a84019649cdf6cddd5f8:/includes/api/ApiQueryCategories.php diff --git a/includes/api/ApiQueryCategories.php b/includes/api/ApiQueryCategories.php index 9c4e9b41..9e801f0a 100644 --- a/includes/api/ApiQueryCategories.php +++ b/includes/api/ApiQueryCategories.php @@ -1,11 +1,10 @@ @gmail.com + * Created on May 13, 2007 + * + * 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 @@ -19,13 +18,15 @@ * * 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')) { +if ( !defined( 'MEDIAWIKI' ) ) { // Eclipse helper - will be ignored in production - require_once ("ApiQueryBase.php"); + require_once( "ApiQueryBase.php" ); } /** @@ -35,182 +36,194 @@ if (!defined('MEDIAWIKI')) { */ class ApiQueryCategories extends ApiQueryGeneratorBase { - public function __construct($query, $moduleName) { - parent :: __construct($query, $moduleName, 'cl'); + public function __construct( $query, $moduleName ) { + parent::__construct( $query, $moduleName, 'cl' ); } public function execute() { $this->run(); } - public function executeGenerator($resultPageSet) { - $this->run($resultPageSet); + public function getCacheMode( $params ) { + return 'public'; } - private function run($resultPageSet = null) { + public function executeGenerator( $resultPageSet ) { + $this->run( $resultPageSet ); + } - if ($this->getPageSet()->getGoodTitleCount() == 0) + private function run( $resultPageSet = null ) { + if ( $this->getPageSet()->getGoodTitleCount() == 0 ) { return; // nothing to do + } $params = $this->extractRequestParams(); - $prop = $params['prop']; - $show = array_flip((array)$params['show']); + $prop = array_flip( (array)$params['prop'] ); + $show = array_flip( (array)$params['show'] ); - $this->addFields(array ( + $this->addFields( array( 'cl_from', 'cl_to' - )); - - $fld_sortkey = $fld_timestamp = false; - if (!is_null($prop)) { - foreach($prop as $p) { - switch ($p) { - case 'sortkey': - $this->addFields('cl_sortkey'); - $fld_sortkey = true; - break; - case 'timestamp': - $this->addFields('cl_timestamp'); - $fld_timestamp = true; - break; - default : - ApiBase :: dieDebug(__METHOD__, "Unknown prop=$p"); + ) ); + + $this->addFieldsIf( array( 'cl_sortkey', 'cl_sortkey_prefix' ), isset( $prop['sortkey'] ) ); + $this->addFieldsIf( 'cl_timestamp', isset( $prop['timestamp'] ) ); + + $this->addTables( 'categorylinks' ); + $this->addWhereFld( 'cl_from', array_keys( $this->getPageSet()->getGoodTitles() ) ); + if ( !is_null( $params['categories'] ) ) { + $cats = array(); + foreach ( $params['categories'] as $cat ) { + $title = Title::newFromText( $cat ); + if ( !$title || $title->getNamespace() != NS_CATEGORY ) { + $this->setWarning( "``$cat'' is not a category" ); + } else { + $cats[] = $title->getDBkey(); } } + $this->addWhereFld( 'cl_to', $cats ); } - $this->addTables('categorylinks'); - $this->addWhereFld('cl_from', array_keys($this->getPageSet()->getGoodTitles())); - if(!is_null($params['continue'])) { - $cont = explode('|', $params['continue']); - if(count($cont) != 2) - $this->dieUsage("Invalid continue param. You should pass the " . - "original value returned by the previous query", "_badcontinue"); - $clfrom = intval($cont[0]); - $clto = $this->getDB()->strencode($this->titleToKey($cont[1])); - $this->addWhere("cl_from > $clfrom OR ". - "(cl_from = $clfrom AND ". - "cl_to >= '$clto')"); + if ( !is_null( $params['continue'] ) ) { + $cont = explode( '|', $params['continue'] ); + if ( count( $cont ) != 2 ) { + $this->dieUsage( "Invalid continue param. You should pass the " . + "original value returned by the previous query", "_badcontinue" ); + } + $clfrom = intval( $cont[0] ); + $clto = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) ); + $this->addWhere( + "cl_from > $clfrom OR " . + "(cl_from = $clfrom AND " . + "cl_to >= '$clto')" + ); } - if(isset($show['hidden']) && isset($show['!hidden'])) - $this->dieUsage("Incorrect parameter - mutually exclusive values may not be supplied", 'show'); - if(isset($show['hidden']) || isset($show['!hidden'])) + + if ( isset( $show['hidden'] ) && isset( $show['!hidden'] ) ) { + $this->dieUsageMsg( array( 'show' ) ); + } + if ( isset( $show['hidden'] ) || isset( $show['!hidden'] ) || isset( $prop['hidden'] ) ) { - $this->addOption('STRAIGHT_JOIN'); - $this->addTables(array('page', 'page_props')); - $this->addJoinConds(array( - 'page' => array('LEFT JOIN', array( + $this->addOption( 'STRAIGHT_JOIN' ); + $this->addTables( array( 'page', 'page_props' ) ); + $this->addFieldsIf( 'pp_propname', isset( $prop['hidden'] ) ); + $this->addJoinConds( array( + 'page' => array( 'LEFT JOIN', array( 'page_namespace' => NS_CATEGORY, - 'page_title = cl_to')), - 'page_props' => array('LEFT JOIN', array( + 'page_title = cl_to' ) ), + 'page_props' => array( 'LEFT JOIN', array( 'pp_page=page_id', - 'pp_propname' => 'hiddencat')) - )); - if(isset($show['hidden'])) - $this->addWhere(array('pp_propname IS NOT NULL')); - else - $this->addWhere(array('pp_propname IS NULL')); + 'pp_propname' => 'hiddencat' ) ) + ) ); + if ( isset( $show['hidden'] ) ) { + $this->addWhere( array( 'pp_propname IS NOT NULL' ) ); + } elseif ( isset( $show['!hidden'] ) ) { + $this->addWhere( array( 'pp_propname IS NULL' ) ); + } } - # Don't order by cl_from if it's constant in the WHERE clause - if(count($this->getPageSet()->getGoodTitles()) == 1) - $this->addOption('ORDER BY', 'cl_to'); - else - $this->addOption('ORDER BY', "cl_from, cl_to"); - - $db = $this->getDB(); - $res = $this->select(__METHOD__); + $this->addOption( 'USE INDEX', array( 'categorylinks' => 'cl_from' ) ); + // Don't order by cl_from if it's constant in the WHERE clause + if ( count( $this->getPageSet()->getGoodTitles() ) == 1 ) { + $this->addOption( 'ORDER BY', 'cl_to' ); + } else { + $this->addOption( 'ORDER BY', "cl_from, cl_to" ); + } - if (is_null($resultPageSet)) { + $res = $this->select( __METHOD__ ); - $data = array(); - $lastId = 0; // database has no ID 0 - $count = 0; - while ($row = $db->fetchObject($res)) { - if (++$count > $params['limit']) { + $count = 0; + if ( is_null( $resultPageSet ) ) { + foreach ( $res as $row ) { + if ( ++$count > $params['limit'] ) { // We've reached the one extra which shows that // there are additional pages to be had. Stop here... - $this->setContinueEnumParameter('continue', $row->cl_from . - '|' . $this->keyToTitle($row->cl_to)); + $this->setContinueEnumParameter( 'continue', $row->cl_from . + '|' . $this->keyToTitle( $row->cl_to ) ); break; } - if ($lastId != $row->cl_from) { - if($lastId != 0) { - $this->addPageSubItems($lastId, $data); - $data = array(); - } - $lastId = $row->cl_from; - } - - $title = Title :: makeTitle(NS_CATEGORY, $row->cl_to); + $title = Title::makeTitle( NS_CATEGORY, $row->cl_to ); $vals = array(); - ApiQueryBase :: addTitleInfo($vals, $title); - if ($fld_sortkey) - $vals['sortkey'] = $row->cl_sortkey; - if ($fld_timestamp) - $vals['timestamp'] = wfTimestamp(TS_ISO_8601, $row->cl_timestamp); - - $data[] = $vals; - } + ApiQueryBase::addTitleInfo( $vals, $title ); + if ( isset( $prop['sortkey'] ) ) { + $vals['sortkey'] = bin2hex( $row->cl_sortkey ); + $vals['sortkeyprefix'] = $row->cl_sortkey_prefix; + } + if ( isset( $prop['timestamp'] ) ) { + $vals['timestamp'] = wfTimestamp( TS_ISO_8601, $row->cl_timestamp ); + } + if ( isset( $prop['hidden'] ) && !is_null( $row->pp_propname ) ) { + $vals['hidden'] = ''; + } - if($lastId != 0) { - $this->addPageSubItems($lastId, $data); + $fit = $this->addPageSubItem( $row->cl_from, $vals ); + if ( !$fit ) { + $this->setContinueEnumParameter( 'continue', $row->cl_from . + '|' . $this->keyToTitle( $row->cl_to ) ); + break; + } } - } else { - $titles = array(); - while ($row = $db->fetchObject($res)) { - if (++$count > $params['limit']) { + foreach ( $res as $row ) { + if ( ++$count > $params['limit'] ) { // We've reached the one extra which shows that // there are additional pages to be had. Stop here... - $this->setContinueEnumParameter('continue', $row->cl_from . - '|' . $this->keyToTitle($row->cl_to)); + $this->setContinueEnumParameter( 'continue', $row->cl_from . + '|' . $this->keyToTitle( $row->cl_to ) ); break; } - $titles[] = Title :: makeTitle(NS_CATEGORY, $row->cl_to); + $titles[] = Title :: makeTitle( NS_CATEGORY, $row->cl_to ); } - $resultPageSet->populateFromTitles($titles); + $resultPageSet->populateFromTitles( $titles ); } - - $db->freeResult($res); } public function getAllowedParams() { - return array ( - 'prop' => array ( - ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_TYPE => array ( + return array( + 'prop' => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => array ( 'sortkey', 'timestamp', + 'hidden', ) ), 'show' => array( - ApiBase :: PARAM_ISMULTI => true, - ApiBase :: PARAM_TYPE => array( + ApiBase::PARAM_ISMULTI => true, + ApiBase::PARAM_TYPE => array( 'hidden', '!hidden', ) ), 'limit' => array( - ApiBase :: PARAM_DFLT => 10, - ApiBase :: PARAM_TYPE => 'limit', - ApiBase :: PARAM_MIN => 1, - ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1, - ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2 + ApiBase::PARAM_DFLT => 10, + ApiBase::PARAM_TYPE => 'limit', + ApiBase::PARAM_MIN => 1, + ApiBase::PARAM_MAX => ApiBase::LIMIT_BIG1, + ApiBase::PARAM_MAX2 => ApiBase::LIMIT_BIG2 ), 'continue' => null, + 'categories' => array( + ApiBase::PARAM_ISMULTI => true, + ), ); } public function getParamDescription() { - return array ( - 'prop' => 'Which additional properties to get for each category.', + return array( + 'prop' => array( + 'Which additional properties to get for each category', + ' sortkey - Adds the sortkey (hexadecimal string) and sortkey prefix (human-readable part) for the category', + ' timestamp - Adds timestamp of when the category was added', + ' hidden - Tags categories that are hidden with __HIDDENCAT__', + ), 'limit' => 'How many categories to return', 'show' => 'Which kind of categories to show', 'continue' => 'When more results are available, use this to continue', + 'categories' => 'Only list these categories. Useful for checking whether a certain page is in a certain category', ); } @@ -218,16 +231,22 @@ class ApiQueryCategories extends ApiQueryGeneratorBase { return 'List all categories the page(s) belong to'; } + public function getPossibleErrors() { + return array_merge( parent::getPossibleErrors(), array( + array( 'show' ), + ) ); + } + protected function getExamples() { - return array ( - "Get a list of categories [[Albert Einstein]] belongs to:", - " api.php?action=query&prop=categories&titles=Albert%20Einstein", - "Get information about all categories used in the [[Albert Einstein]]:", - " api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info" - ); + return array( + 'Get a list of categories [[Albert Einstein]] belongs to:', + ' api.php?action=query&prop=categories&titles=Albert%20Einstein', + 'Get information about all categories used in the [[Albert Einstein]]:', + ' api.php?action=query&generator=categories&titles=Albert%20Einstein&prop=info' + ); } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryCategories.php 44585 2008-12-14 17:39:50Z catrope $'; + return __CLASS__ . ': $Id$'; } }