X-Git-Url: https://scripts.mit.edu/gitweb/autoinstallsdev/mediawiki.git/blobdiff_plain/19e297c21b10b1b8a3acad5e73fc71dcb35db44a..6932310fd58ebef145fa01eb76edf7150284d8ea:/includes/api/ApiQueryAllCategories.php

diff --git a/includes/api/ApiQueryAllCategories.php b/includes/api/ApiQueryAllCategories.php
index 9f20ed86..aa89158f 100644
--- a/includes/api/ApiQueryAllCategories.php
+++ b/includes/api/ApiQueryAllCategories.php
@@ -1,10 +1,10 @@
 <?php
 /**
- * API for MediaWiki 1.8+
+ *
  *
  * Created on December 12, 2007
  *
- * Copyright © 2007 Roan Kattouw <Firstname>.<Lastname>@home.nl
+ * Copyright © 2007 Roan Kattouw "<Firstname>.<Lastname>@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
@@ -24,11 +24,6 @@
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-	// Eclipse helper - will be ignored in production
-	require_once( 'ApiQueryBase.php' );
-}
-
 /**
  * Query module to enumerate all categories, even the ones that don't have
  * category pages.
@@ -37,7 +32,7 @@ if ( !defined( 'MEDIAWIKI' ) ) {
  */
 class ApiQueryAllCategories extends ApiQueryGeneratorBase {
 
-	public function __construct( $query, $moduleName ) {
+	public function __construct( ApiQuery $query, $moduleName ) {
 		parent::__construct( $query, $moduleName, 'ac' );
 	}
 
@@ -53,6 +48,9 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
 		$this->run( $resultPageSet );
 	}
 
+	/**
+	 * @param ApiPageSet $resultPageSet
+	 */
 	private function run( $resultPageSet = null ) {
 		$db = $this->getDB();
 		$params = $this->extractRequestParams();
@@ -60,132 +58,148 @@ class ApiQueryAllCategories extends ApiQueryGeneratorBase {
 		$this->addTables( 'category' );
 		$this->addFields( 'cat_title' );
 
+		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( "cat_title $op= $cont_from" );
+		}
+
 		$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'], NS_CATEGORY ) );
+		$to = ( $params['to'] === null
+			? null
+			: $this->titlePartToKey( $params['to'], NS_CATEGORY ) );
 		$this->addWhereRange( 'cat_title', $dir, $from, $to );
 
+		$min = $params['min'];
+		$max = $params['max'];
+		if ( $dir == 'newer' ) {
+			$this->addWhereRange( 'cat_pages', 'newer', $min, $max );
+		} else {
+			$this->addWhereRange( 'cat_pages', 'older', $max, $min );
+		}
+
 		if ( isset( $params['prefix'] ) ) {
-			$this->addWhere( 'cat_title' . $db->buildLike( $this->titlePartToKey( $params['prefix'] ), $db->anyString() ) );
+			$this->addWhere( 'cat_title' . $db->buildLike(
+				$this->titlePartToKey( $params['prefix'], NS_CATEGORY ),
+				$db->anyString() ) );
 		}
 
 		$this->addOption( 'LIMIT', $params['limit'] + 1 );
-		$this->addOption( 'ORDER BY', 'cat_title' . ( $params['dir'] == 'descending' ? ' DESC' : '' ) );
+		$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
+		$this->addOption( 'ORDER BY', 'cat_title' . $sort );
 
 		$prop = array_flip( $params['prop'] );
-		$this->addFieldsIf( array( 'cat_pages', 'cat_subcats', 'cat_files' ), isset( $prop['size'] ) );
+		$this->addFieldsIf( [ '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(
+			$this->addTables( [ 'page', 'page_props' ] );
+			$this->addJoinConds( [
+				'page' => [ 'LEFT JOIN', [
 					'page_namespace' => NS_CATEGORY,
-					'page_title=cat_title' ) ),
-				'page_props' => array( 'LEFT JOIN', array(
+					'page_title=cat_title' ] ],
+				'page_props' => [ 'LEFT JOIN', [
 					'pp_page=page_id',
-					'pp_propname' => 'hiddencat' ) ),
-			) );
-			$this->addFields( 'pp_propname AS cat_hidden' );
+					'pp_propname' => 'hiddencat' ] ],
+			] );
+			$this->addFields( [ 'cat_hidden' => 'pp_propname' ] );
 		}
 
 		$res = $this->select( __METHOD__ );
 
-		$pages = array();
+		$pages = [];
 
 		$result = $this->getResult();
 		$count = 0;
 		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', $this->keyToTitle( $row->cat_title ) );
+			if ( ++$count > $params['limit'] ) {
+				// We've reached the one extra which shows that there are
+				// additional cats to be had. Stop here...
+				$this->setContinueEnumParameter( 'continue', $row->cat_title );
 				break;
 			}
 
 			// Normalize titles
 			$titleObj = Title::makeTitle( NS_CATEGORY, $row->cat_title );
 			if ( !is_null( $resultPageSet ) ) {
-				$pages[] = $titleObj->getPrefixedText();
+				$pages[] = $titleObj;
 			} else {
-				$item = array();
-				$result->setContent( $item, $titleObj->getText() );
+				$item = [];
+				ApiResult::setContentValue( $item, 'category', $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'] = '';
+				if ( isset( $prop['hidden'] ) ) {
+					$item['hidden'] = (bool)$row->cat_hidden;
 				}
-				$fit = $result->addValue( array( 'query', $this->getModuleName() ), null, $item );
+				$fit = $result->addValue( [ 'query', $this->getModuleName() ], null, $item );
 				if ( !$fit ) {
-					$this->setContinueEnumParameter( 'from', $this->keyToTitle( $row->cat_title ) );
+					$this->setContinueEnumParameter( 'continue', $row->cat_title );
 					break;
 				}
 			}
 		}
 
 		if ( is_null( $resultPageSet ) ) {
-			$result->setIndexedTagName_internal( array( 'query', $this->getModuleName() ), 'c' );
+			$result->addIndexedTagName( [ 'query', $this->getModuleName() ], 'c' );
 		} else {
 			$resultPageSet->populateFromTitles( $pages );
 		}
 	}
 
 	public function getAllowedParams() {
-		return array(
+		return [
 			'from' => null,
+			'continue' => [
+				ApiBase::PARAM_HELP_MSG => 'api-help-param-continue',
+			],
 			'to' => null,
 			'prefix' => null,
-			'dir' => array(
+			'dir' => [
 				ApiBase::PARAM_DFLT => 'ascending',
-				ApiBase::PARAM_TYPE => array(
+				ApiBase::PARAM_TYPE => [
 					'ascending',
 					'descending'
-				),
-			),
-			'limit' => array(
+				],
+			],
+			'min' => [
+				ApiBase::PARAM_TYPE => 'integer'
+			],
+			'max' => [
+				ApiBase::PARAM_TYPE => 'integer'
+			],
+			'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
-			),
-			'prop' => array(
-				ApiBase::PARAM_TYPE => array( 'size', 'hidden' ),
+			],
+			'prop' => [
+				ApiBase::PARAM_TYPE => [ 'size', 'hidden' ],
 				ApiBase::PARAM_DFLT => '',
-				ApiBase::PARAM_ISMULTI => true
-			),
-		);
-	}
-
-	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__',
-			),
-		);
-	}
-
-	public function getDescription() {
-		return 'Enumerate all categories';
+				ApiBase::PARAM_ISMULTI => true,
+				ApiBase::PARAM_HELP_MSG_PER_VALUE => [],
+			],
+		];
 	}
 
-	protected function getExamples() {
-		return array(
-			'api.php?action=query&list=allcategories&acprop=size',
-			'api.php?action=query&generator=allcategories&gacprefix=List&prop=info',
-		);
+	protected function getExamplesMessages() {
+		return [
+			'action=query&list=allcategories&acprop=size'
+				=> 'apihelp-query+allcategories-example-size',
+			'action=query&generator=allcategories&gacprefix=List&prop=info'
+				=> 'apihelp-query+allcategories-example-generator',
+		];
 	}
 
-	public function getVersion() {
-		return __CLASS__ . ': $Id$';
+	public function getHelpUrls() {
+		return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Allcategories';
 	}
 }