X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryLinks.php;h=5cf9068247d4e90641c88ef5aafc7a32329096f6;hb=bb52be9f3da314361cdb90642f941aea669a1d3e;hp=65975b23e2286b4b43147e59c6e9dd25b0366bb6;hpb=6309c920dd71b639c78dcdc2cb3a490ccaad18e4;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/api/ApiQueryLinks.php b/includes/api/ApiQueryLinks.php
index 65975b23e2..5cf9068247 100644
--- a/includes/api/ApiQueryLinks.php
+++ b/includes/api/ApiQueryLinks.php
@@ -24,11 +24,6 @@
  * @file
  */
 
-if ( !defined( 'MEDIAWIKI' ) ) {
-	// Eclipse helper - will be ignored in production
-	require_once( "ApiQueryBase.php" );
-}
-
 /**
  * A query module to list all wiki links on a given set of pages.
  *
@@ -39,7 +34,7 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 	const LINKS = 'links';
 	const TEMPLATES = 'templates';
 
-	private $table, $prefix, $description;
+	private $table, $prefix, $description, $helpUrl;
 
 	public function __construct( $query, $moduleName ) {
 		switch ( $moduleName ) {
@@ -48,12 +43,16 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 				$this->prefix = 'pl';
 				$this->description = 'link';
 				$this->titlesParam = 'titles';
+				$this->titlesParamDescription = 'Only list links to these titles. Useful for checking whether a certain page links to a certain title.';
+				$this->helpUrl = 'https://www.mediawiki.org/wiki/API:Properties#links_.2F_pl';
 				break;
 			case self::TEMPLATES:
 				$this->table = 'templatelinks';
 				$this->prefix = 'tl';
 				$this->description = 'template';
 				$this->titlesParam = 'templates';
+				$this->titlesParamDescription = 'Only list these templates. Useful for checking whether a certain page uses a certain template.';
+				$this->helpUrl = 'https://www.mediawiki.org/wiki/API:Properties#templates_.2F_tl';
 				break;
 			default:
 				ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
@@ -74,6 +73,10 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 		$this->run( $resultPageSet );
 	}
 
+	/**
+	 * @param $resultPageSet ApiPageSet
+	 * @return
+	 */
 	private function run( $resultPageSet = null ) {
 		if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
 			return;	// nothing to do
@@ -96,7 +99,7 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 			foreach ( $params[$this->titlesParam] as $t ) {
 				$title = Title::newFromText( $t );
 				if ( !$title ) {
-					$this->setWarning( "``$t'' is not a valid title" );
+					$this->setWarning( "\"$t\" is not a valid title" );
 				} else {
 					$lb->addObj( $title );
 				}
@@ -113,18 +116,20 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 				$this->dieUsage( 'Invalid continue param. You should pass the ' .
 					'original value returned by the previous query', '_badcontinue' );
 			}
+			$op = $params['dir'] == 'descending' ? '<' : '>';
 			$plfrom = intval( $cont[0] );
 			$plns = intval( $cont[1] );
-			$pltitle = $this->getDB()->strencode( $this->titleToKey( $cont[2] ) );
+			$pltitle = $this->getDB()->addQuotes( $this->titleToKey( $cont[2] ) );
 			$this->addWhere(
-				"{$this->prefix}_from > $plfrom OR " .
+				"{$this->prefix}_from $op $plfrom OR " .
 				"({$this->prefix}_from = $plfrom AND " .
-				"({$this->prefix}_namespace > $plns OR " .
+				"({$this->prefix}_namespace $op $plns OR " .
 				"({$this->prefix}_namespace = $plns AND " .
-				"{$this->prefix}_title >= '$pltitle')))"
+				"{$this->prefix}_title $op= $pltitle)))"
 			);
 		}
 
+		$sort = ( $params['dir'] == 'descending' ? ' DESC' : '' );
 		// Here's some MySQL craziness going on: if you use WHERE foo='bar'
 		// and later ORDER BY foo MySQL doesn't notice the ORDER BY is pointless
 		// but instead goes and filesorts, because the index for foo was used
@@ -132,15 +137,15 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 		// clause from the ORDER BY clause
 		$order = array();
 		if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
-			$order[] = "{$this->prefix}_from";
+			$order[] = $this->prefix . '_from' . $sort;
 		}
 		if ( count( $params['namespace'] ) != 1 ) {
-			$order[] = "{$this->prefix}_namespace";
+			$order[] = $this->prefix . '_namespace' . $sort;
 		}
 
-		$order[] = "{$this->prefix}_title";
-		$this->addOption( 'ORDER BY', implode( ', ', $order ) );
-		$this->addOption( 'USE INDEX', "{$this->prefix}_from" );
+		$order[] = $this->prefix . '_title' . $sort;
+		$this->addOption( 'ORDER BY', $order );
+		$this->addOption( 'USE INDEX', $this->prefix . '_from' );
 		$this->addOption( 'LIMIT', $params['limit'] + 1 );
 
 		$res = $this->select( __METHOD__ );
@@ -201,39 +206,54 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 			$this->titlesParam => array(
 				ApiBase::PARAM_ISMULTI => true,
 			),
+			'dir' => array(
+				ApiBase::PARAM_DFLT => 'ascending',
+				ApiBase::PARAM_TYPE => array(
+					'ascending',
+					'descending'
+				)
+			),
 		);
 	}
 
 	public function getParamDescription() {
 		$desc = $this->description;
-		$arr = array(
+		return array(
 			'namespace' => "Show {$desc}s in this namespace(s) only",
 			'limit' => "How many {$desc}s to return",
 			'continue' => 'When more results are available, use this to continue',
+			$this->titlesParam => $this->titlesParamDescription,
+			'dir' => 'The direction in which to list',
+		);
+	}
+
+	public function getResultProperties() {
+		return array(
+			'' => array(
+				'ns' => 'namespace',
+				'title' => 'string'
+			)
 		);
-		if ( $this->getModuleName() == self::LINKS ) {
-			$arr[$this->titlesParam] = 'Only list links to these titles. Useful for checking whether a certain page links to a certain title.';
-		} else if ( $this->getModuleName() == self::TEMPLATES ) {
-			$arr[$this->titlesParam] = 'Only list these templates. Useful for checking whether a certain page uses a certain template.';
-		}
-		return $arr;
 	}
 
 	public function getDescription() {
 		return "Returns all {$this->description}s from the given page(s)";
 	}
 
-	protected function getExamples() {
+	public function getExamples() {
+		$desc = $this->description;
+		$name = $this->getModuleName();
 		return array(
-			"Get {$this->description}s from the [[Main Page]]:",
-			"  api.php?action=query&prop={$this->getModuleName()}&titles=Main%20Page",
-			"Get information about the {$this->description} pages in the [[Main Page]]:",
-			"  api.php?action=query&generator={$this->getModuleName()}&titles=Main%20Page&prop=info",
-			"Get {$this->description}s from the Main Page in the User and Template namespaces:",
-			"  api.php?action=query&prop={$this->getModuleName()}&titles=Main%20Page&{$this->prefix}namespace=2|10"
+			"api.php?action=query&prop={$name}&titles=Main%20Page" => "Get {$desc}s from the [[Main Page]]:",
+			"api.php?action=query&generator={$name}&titles=Main%20Page&prop=info" => "Get information about the {$desc} pages in the [[Main Page]]:",
+			"api.php?action=query&prop={$name}&titles=Main%20Page&{$this->prefix}namespace=2|10" => "Get {$desc}s from the Main Page in the User and Template namespaces:",
 		);
 	}
 
+	public function getHelpUrls() {
+		return $this->helpUrl;
+	}
+
 	public function getVersion() {
 		return __CLASS__ . ': $Id$';
 	}