X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryAllCategories.php;h=03745e2c3d6adf39a4d27e929c0d5b0b9ba56fad;hb=d77e4ff0c64b79ba405d3f3327512adcb95be4fe;hp=e65ffe0e7bbfbb5f0b9cce85ee8a0a1f9c0c5e67;hpb=8961c4c4d0cdbbede05fada5b9889cce4c370cbd;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiQueryAllCategories.php b/includes/api/ApiQueryAllCategories.php index e65ffe0e7b..03745e2c3d 100644 --- a/includes/api/ApiQueryAllCategories.php +++ b/includes/api/ApiQueryAllCategories.php @@ -1,11 +1,10 @@ .@home.nl + * Created on December 12, 2007 + * + * Copyright © 2007 Roan Kattouw .@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,124 +18,174 @@ * * 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' ); } /** * Query module to enumerate all categories, even the ones that don't have * category pages. - * - * @addtogroup API + * + * @ingroup API */ class ApiQueryAllCategories extends ApiQueryGeneratorBase { - public function __construct($query, $moduleName) { - parent :: __construct($query, $moduleName, 'ac'); + public function __construct( $query, $moduleName ) { + parent::__construct( $query, $moduleName, 'ac' ); } 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 ); + } + private function run( $resultPageSet = null ) { $db = $this->getDB(); $params = $this->extractRequestParams(); - $this->addTables('categorylinks'); - $this->addFields('cl_to'); - - if (!is_null($params['from'])) - $this->addWhere('cl_to>=' . $db->addQuotes(ApiQueryBase :: titleToKey($params['from']))); - if (isset ($params['prefix'])) - $this->addWhere("cl_to LIKE '" . $db->escapeLike(ApiQueryBase :: titleToKey($params['prefix'])) . "%'"); + $this->addTables( 'category' ); + $this->addFields( 'cat_title' ); + + $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'] ) ); + $this->addWhereRange( 'cat_title', $dir, $from, $to ); - $this->addOption('LIMIT', $params['limit']+1); - $this->addOption('ORDER BY', 'cl_to' . ($params['dir'] == 'descending' ? ' DESC' : '')); - $this->addOption('DISTINCT'); + if ( isset( $params['prefix'] ) ) { + $this->addWhere( 'cat_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) ); + } + + $this->addOption( 'LIMIT', $params['limit'] + 1 ); + $this->addOption( 'ORDER BY', 'cat_title' . ( $params['dir'] == 'descending' ? ' DESC' : '' ) ); + + $prop = array_flip( $params['prop'] ); + $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) ); + if ( isset( $prop['hidden'] ) ) { + $this->addTables( array( 'page', 'page_props' ) ); + $this->addJoinConds( array( + 'page' => array( 'LEFT JOIN', array( + 'page_namespace' => NS_CATEGORY, + 'page_title=cat_title' ) ), + 'page_props' => array( 'LEFT JOIN', array( + 'pp_page=page_id', + 'pp_propname' => 'hiddencat' ) ), + ) ); + $this->addFields( 'pp_propname AS cat_hidden' ); + } - $res = $this->select(__METHOD__); + $res = $this->select( __METHOD__ ); $pages = array(); + + $result = $this->getResult(); $count = 0; - 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 cats 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', ApiQueryBase :: keyToTitle($row->cl_to)); + $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title ) ); break; } - + // Normalize titles - $titleObj = Title::makeTitle(NS_CATEGORY, $row->cl_to); - if(!is_null($resultPageSet)) + $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title ); + if ( !is_null( $resultPageSet ) ) { $pages[] = $titleObj->getPrefixedText(); - else - // Don't show "Category:" everywhere in non-generator mode - $pages[] = $titleObj->getText(); + } else { + $item = array(); + $result->setContent( $item, $titleObj->getText() ); + if ( isset( $prop['size'] ) ) { + $item['size'] = intval( $row->cat_pages ); + $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files; + $item['files'] = intval( $row->cat_files ); + $item['subcats'] = intval( $row->cat_subcats ); + } + if ( isset( $prop['hidden'] ) && $row->cat_hidden ) { + $item['hidden'] = ''; + } + $fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item ); + if ( !$fit ) { + $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title ) ); + break; + } + } } - $db->freeResult($res); - if (is_null($resultPageSet)) { - $result = $this->getResult(); - $result->setIndexedTagName($pages, 'c'); - $result->addValue('query', $this->getModuleName(), $pages); + if ( is_null( $resultPageSet ) ) { + $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' ); } else { - $resultPageSet->populateFromTitles($pages); + $resultPageSet->populateFromTitles( $pages ); } } - protected function getAllowedParams() { - return array ( + public function getAllowedParams() { + return array( 'from' => null, + 'to' => null, 'prefix' => null, 'dir' => array( - ApiBase :: PARAM_DFLT => 'ascending', - ApiBase :: PARAM_TYPE => array( + ApiBase::PARAM_DFLT => 'ascending', + ApiBase::PARAM_TYPE => array( 'ascending', 'descending' ), ), - '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 - ) + '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 + ), + 'prop' => array( + ApiBase::PARAM_TYPE => array( 'size', 'hidden' ), + ApiBase::PARAM_DFLT => '', + ApiBase::PARAM_ISMULTI => true + ), ); } - protected function getParamDescription() { - return array ( - 'from' => 'The category to start enumerating from.', - 'prefix' => 'Search for all category titles that begin with this value.', - 'dir' => 'Direction to sort in.', - 'limit' => 'How many categories to return.' + public function getParamDescription() { + return array( + 'from' => 'The category to start enumerating from', + 'to' => 'The category to stop enumerating at', + 'prefix' => 'Search for all category titles that begin with this value', + 'dir' => 'Direction to sort in', + 'limit' => 'How many categories to return', + 'prop' => array( + 'Which properties to get', + ' size - Adds number of pages in the category', + ' hidden - Tags categories that are hidden with __HIDDENCAT__', + ), ); } - protected function getDescription() { + public function getDescription() { return 'Enumerate all categories'; } protected function getExamples() { - return array ( + return array( + 'api.php?action=query&list=allcategories&acprop=size', 'api.php?action=query&generator=allcategories&gacprefix=List&prop=info', ); } public function getVersion() { - return __CLASS__ . ': $Id: ApiQueryAllLinks.php 28216 2007-12-06 18:33:18Z vasilievvv $'; + return __CLASS__ . ': $Id$'; } }