X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryLinks.php;h=da2fd99b6f1dfa242d8096d3390c3b71b564ad3f;hb=4f5d2386f35384cea26db6f1ea6d7b5e425b8435;hp=6bbd893ec5d4f3b3fb07cf5eede1e3083b36be04;hpb=dc4efc975bf621471a57a15d489c4a33d243e935;p=lhc%2Fweb%2Fwiklou.git

diff --git a/includes/api/ApiQueryLinks.php b/includes/api/ApiQueryLinks.php
index 6bbd893ec5..7b675b0eed 100644
--- a/includes/api/ApiQueryLinks.php
+++ b/includes/api/ApiQueryLinks.php
@@ -1,11 +1,10 @@
 <?php
-
-/*
- * Created on May 12, 2007
+/**
  *
- * API for MediaWiki 1.8+
  *
- * Copyright (C) 2006 Yuri Astrakhan <Firstname><Lastname>@gmail.com
+ * Created on May 12, 2007
+ *
+ * Copyright © 2006 Yuri Astrakhan "<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
@@ -19,15 +18,12 @@
  *
  * 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')) {
-	// 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.
  *
@@ -38,162 +34,205 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 	const LINKS = 'links';
 	const TEMPLATES = 'templates';
 
-	private $table, $prefix, $description;
-
-	public function __construct($query, $moduleName) {
+	private $table, $prefix, $description, $helpUrl;
 
-		switch ($moduleName) {
-			case self::LINKS :
+	public function __construct( $query, $moduleName ) {
+		switch ( $moduleName ) {
+			case self::LINKS:
 				$this->table = 'pagelinks';
 				$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 :
+			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');
+			default:
+				ApiBase::dieDebug( __METHOD__, 'Unknown module name' );
 		}
 
-		parent :: __construct($query, $moduleName, $this->prefix);
+		parent::__construct( $query, $moduleName, $this->prefix );
 	}
 
 	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)
+	/**
+	 * @param $resultPageSet ApiPageSet
+	 * @return
+	 */
+	private function run( $resultPageSet = null ) {
+		if ( $this->getPageSet()->getGoodTitleCount() == 0 ) {
 			return;	// nothing to do
+		}
 
 		$params = $this->extractRequestParams();
 
-		$this->addFields(array (
-			$this->prefix . '_from pl_from',
-			$this->prefix . '_namespace pl_namespace',
-			$this->prefix . '_title pl_title'
-		));
-
-		$this->addTables($this->table);
-		$this->addWhereFld($this->prefix . '_from', array_keys($this->getPageSet()->getGoodTitles()));
-		$this->addWhereFld($this->prefix . '_namespace', $params['namespace']);
-
-		if(!is_null($params['continue'])) {
-			$cont = explode('|', $params['continue']);
-			if(count($cont) != 3)
-				$this->dieUsage("Invalid continue param. You should pass the " .
-					"original value returned by the previous query", "_badcontinue");
-			$plfrom = intval($cont[0]);
-			$plns = intval($cont[1]);
-			$pltitle = $this->getDb()->strencode($this->titleToKey($cont[2]));
-			$this->addWhere("{$this->prefix}_from > $plfrom OR ".
-					"({$this->prefix}_from = $plfrom AND ".
-					"({$this->prefix}_namespace > $plns OR ".
-					"({$this->prefix}_namespace = $plns AND ".
-					"{$this->prefix}_title >= '$pltitle')))");
+		$this->addFields( array(
+			$this->prefix . '_from AS pl_from',
+			$this->prefix . '_namespace AS pl_namespace',
+			$this->prefix . '_title AS pl_title'
+		) );
+
+		$this->addTables( $this->table );
+		$this->addWhereFld( $this->prefix . '_from', array_keys( $this->getPageSet()->getGoodTitles() ) );
+		$this->addWhereFld( $this->prefix . '_namespace', $params['namespace'] );
+
+		if ( !is_null( $params[$this->titlesParam] ) ) {
+			$lb = new LinkBatch;
+			foreach ( $params[$this->titlesParam] as $t ) {
+				$title = Title::newFromText( $t );
+				if ( !$title ) {
+					$this->setWarning( "\"$t\" is not a valid title" );
+				} else {
+					$lb->addObj( $title );
+				}
+			}
+			$cond = $lb->constructSet( $this->prefix, $this->getDB() );
+			if ( $cond ) {
+				$this->addWhere( $cond );
+			}
 		}
 
-		# 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
-		# already. To work around this, we drop constant fields in the WHERE
-		# clause from the ORDER BY clause
+		if ( !is_null( $params['continue'] ) ) {
+			$cont = explode( '|', $params['continue'] );
+			if ( count( $cont ) != 3 ) {
+				$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()->addQuotes( $this->titleToKey( $cont[2] ) );
+			$this->addWhere(
+				"{$this->prefix}_from $op $plfrom OR " .
+				"({$this->prefix}_from = $plfrom AND " .
+				"({$this->prefix}_namespace $op $plns OR " .
+				"({$this->prefix}_namespace = $plns AND " .
+				"{$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
+		// already. To work around this, we drop constant fields in the WHERE
+		// clause from the ORDER BY clause
 		$order = array();
-		if(count($this->getPageSet()->getGoodTitles()) != 1)
-			$order[] = "{$this->prefix}_from";
-		if(count($params['namespace']) != 1)
-			$order[] = "{$this->prefix}_namespace";
-		$order[] = "{$this->prefix}_title";
-		$this->addOption('ORDER BY', implode(", ", $order));
-		$this->addOption('USE INDEX', "{$this->prefix}_from");
-		$this->addOption('LIMIT', $params['limit'] + 1);
-
-		$db = $this->getDB();
-		$res = $this->select(__METHOD__);
-
-		if (is_null($resultPageSet)) {
-
-			$data = array();
-			$lastId = 0;	// database has no ID 0
+		if ( count( $this->getPageSet()->getGoodTitles() ) != 1 ) {
+			$order[] = $this->prefix . '_from' . $sort;
+		}
+		if ( count( $params['namespace'] ) != 1 ) {
+			$order[] = $this->prefix . '_namespace' . $sort;
+		}
+
+		$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__ );
+
+		if ( is_null( $resultPageSet ) ) {
 			$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 pages to be had. Stop here...
-					$this->setContinueEnumParameter('continue',
+					$this->setContinueEnumParameter( 'continue',
 						"{$row->pl_from}|{$row->pl_namespace}|" .
-						$this->keyToTitle($row->pl_title));
+						$this->keyToTitle( $row->pl_title ) );
 					break;
 				}
-				if ($lastId != $row->pl_from) {
-					if($lastId != 0) {
-						$this->addPageSubItems($lastId, $data);
-						$data = array();
-					}
-					$lastId = $row->pl_from;
-				}
-
 				$vals = array();
-				ApiQueryBase :: addTitleInfo($vals, Title :: makeTitle($row->pl_namespace, $row->pl_title));
-				$data[] = $vals;
-			}
-
-			if($lastId != 0) {
-				$this->addPageSubItems($lastId, $data);
+				ApiQueryBase::addTitleInfo( $vals, Title::makeTitle( $row->pl_namespace, $row->pl_title ) );
+				$fit = $this->addPageSubItem( $row->pl_from, $vals );
+				if ( !$fit ) {
+					$this->setContinueEnumParameter( 'continue',
+						"{$row->pl_from}|{$row->pl_namespace}|" .
+						$this->keyToTitle( $row->pl_title ) );
+					break;
+				}
 			}
-
 		} else {
-
 			$titles = array();
 			$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 pages to be had. Stop here...
-					$this->setContinueEnumParameter('continue',
+					$this->setContinueEnumParameter( 'continue',
 						"{$row->pl_from}|{$row->pl_namespace}|" .
-						$this->keyToTitle($row->pl_title));
+						$this->keyToTitle( $row->pl_title ) );
 					break;
 				}
-				$titles[] = Title :: makeTitle($row->pl_namespace, $row->pl_title);
+				$titles[] = Title::makeTitle( $row->pl_namespace, $row->pl_title );
 			}
-			$resultPageSet->populateFromTitles($titles);
+			$resultPageSet->populateFromTitles( $titles );
 		}
+	}
 
-		$db->freeResult($res);
+	public function getAllowedParams() {
+		return array(
+			'namespace' => array(
+				ApiBase::PARAM_TYPE => 'namespace',
+				ApiBase::PARAM_ISMULTI => true
+			),
+			'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
+			),
+			'continue' => null,
+			$this->titlesParam => array(
+				ApiBase::PARAM_ISMULTI => true,
+			),
+			'dir' => array(
+				ApiBase::PARAM_DFLT => 'ascending',
+				ApiBase::PARAM_TYPE => array(
+					'ascending',
+					'descending'
+				)
+			),
+		);
 	}
 
-	public function getAllowedParams()
-	{
+	public function getParamDescription() {
+		$desc = $this->description;
 		return array(
-				'namespace' => array(
-					ApiBase :: PARAM_TYPE => 'namespace',
-					ApiBase :: PARAM_ISMULTI => true
-				),
-				'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
-				),
-				'continue' => null,
-			);
+			'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 getParamDescription()
-	{
+	public function getResultProperties() {
 		return array(
-				'namespace' => "Show {$this->description}s in this namespace(s) only",
-				'limit' => 'How many links to return',
-				'continue' => 'When more results are available, use this to continue',
+			'' => array(
+				'ns' => 'namespace',
+				'title' => 'string'
+			)
 		);
 	}
 
@@ -201,15 +240,18 @@ class ApiQueryLinks extends ApiQueryGeneratorBase {
 		return "Returns all {$this->description}s from the given page(s)";
 	}
 
-	protected function getExamples() {
-		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"
-			);
+	public function getExamples() {
+		$desc = $this->description;
+		$name = $this->getModuleName();
+		return array(
+			"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() {