X-Git-Url: http://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryAllCategories.php;h=5a5298d6705c86728b3effbe4afd37cbd1074dad;hb=b512a8a1974d8317ab848a261ec18510ff1fac26;hp=f65de6de2123f14a1a8bb713bab0fc9bf17e6f94;hpb=5ea924d9dc5a1e9a17d23443009b5a7ded6563e1;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiQueryAllCategories.php b/includes/api/ApiQueryAllCategories.php index f65de6de21..5a5298d670 100644 --- a/includes/api/ApiQueryAllCategories.php +++ b/includes/api/ApiQueryAllCategories.php @@ -1,11 +1,11 @@ .@home.nl + * Copyright © 2007 Roan Kattouw .@home.nl * * 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,122 +23,137 @@ * 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' ); } /** * 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 executeGenerator( $resultPageSet ) { + $this->run( $resultPageSet ); } - private function run($resultPageSet = null) { - + private function run( $resultPageSet = null ) { $db = $this->getDB(); $params = $this->extractRequestParams(); - $this->addTables('category'); - $this->addFields('cat_title'); + $this->addTables( 'category' ); + $this->addFields( 'cat_title' ); - if (!is_null($params['from'])) - $this->addWhere('cat_title>=' . $db->addQuotes(ApiQueryBase :: titleToKey($params['from']))); - if (isset ($params['prefix'])) - $this->addWhere("cat_title LIKE '" . $db->escapeLike(ApiQueryBase :: titleToKey($params['prefix'])) . "%'"); - - $this->addOption('LIMIT', $params['limit']+1); - $this->addOption('ORDER BY', 'cat_title' . ($params['dir'] == 'descending' ? ' DESC' : '')); + $dir = ( $params['dir'] == 'descending' ? 'older' : 'newer' ); + $from = ( is_null( $params['from'] ) ? null : $this->titlePartToKey( $params['from'] ) ); + $this->addWhereRange( 'cat_title', $dir, $from, null ); + if ( isset( $params['prefix'] ) ) { + $this->addWhere( 'cat_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) ); + } - $prop = array_flip($params['prop']); - $this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset($prop['size']) ); - //$this->addFieldsIf( 'cat_hidden', isset($prop['hidden']) ); + $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(); $categories = array(); $result = $this->getResult(); $count = 0; - while ($row = $db->fetchObject($res)) { - if (++ $count > $params['limit']) { + while ( $row = $db->fetchObject( $res ) ) { + 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->cat_title)); + $this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title ) ); break; } // Normalize titles - $titleObj = Title::makeTitle(NS_CATEGORY, $row->cat_title); - if(!is_null($resultPageSet)) + $titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title ); + if ( !is_null( $resultPageSet ) ) { $pages[] = $titleObj->getPrefixedText(); - else { + } else { $item = array(); $result->setContent( $item, $titleObj->getText() ); - if( isset( $prop['size'] ) ) { - $item['size'] = $row->cat_pages; + if ( isset( $prop['size'] ) ) { + $item['size'] = intval( $row->cat_pages ); $item['pages'] = $row->cat_pages - $row->cat_subcats - $row->cat_files; - $item['files'] = $row->cat_files; - $item['subcats'] = $row->cat_subcats; + $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; } - //Isn't populated, so doesn't work - //if( isset( $prop['hidden'] ) && $row->cat_hidden ) - // $item['hidden'] = ''; - $categories[] = $item; } } - $db->freeResult($res); + $db->freeResult( $res ); - if (is_null($resultPageSet)) { - $result->setIndexedTagName($categories, 'c'); - $result->addValue('query', $this->getModuleName(), $categories); + if ( is_null( $resultPageSet ) ) { + $result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' ); } else { - $resultPageSet->populateFromTitles($pages); + $resultPageSet->populateFromTitles( $pages ); } } public function getAllowedParams() { - return array ( + return array( 'from' => 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 + 'prop' => array( + ApiBase::PARAM_TYPE => array( 'size', 'hidden' ), + ApiBase::PARAM_DFLT => '', + ApiBase::PARAM_ISMULTI => true ), ); } public function getParamDescription() { - return array ( + 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.', @@ -152,7 +167,7 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase { } 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', ); @@ -161,4 +176,4 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase { public function getVersion() { return __CLASS__ . ': $Id$'; } -} +} \ No newline at end of file