X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryLinks.php;h=65975b23e2286b4b43147e59c6e9dd25b0366bb6;hb=78e92a9eaf63d2030289a282712faa9028adf993;hp=330fb2fdbd474bf0ce4fe6c395830d7e1a1a1dd6;hpb=a15c419b3d130248f2556b9d00643ba9666a4189;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiQueryLinks.php b/includes/api/ApiQueryLinks.php index 330fb2fdbd..65975b23e2 100644 --- a/includes/api/ApiQueryLinks.php +++ b/includes/api/ApiQueryLinks.php @@ -1,11 +1,10 @@ @gmail.com + * Created on May 12, 2007 + * + * Copyright © 2006 Yuri Astrakhan @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,19 +18,21 @@ * * 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" ); } /** * A query module to list all wiki links on a given set of pages. - * - * @addtogroup API + * + * @ingroup API */ class ApiQueryLinks extends ApiQueryGeneratorBase { @@ -40,134 +41,200 @@ class ApiQueryLinks extends ApiQueryGeneratorBase { private $table, $prefix, $description; - public function __construct($query, $moduleName) { - - 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'; break; - case self::TEMPLATES : + case self::TEMPLATES: $this->table = 'templatelinks'; $this->prefix = 'tl'; $this->description = 'template'; + $this->titlesParam = 'templates'; 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) + 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']); - $this->addOption('ORDER BY', str_replace('pl_', $this->prefix . '_', 'pl_from, pl_namespace, pl_title')); - - $db = $this->getDB(); - $res = $this->select(__METHOD__); - - if (is_null($resultPageSet)) { - - $data = array(); - $lastId = 0; // database has no ID 0 - while ($row = $db->fetchObject($res)) { - if ($lastId != $row->pl_from) { - if($lastId != 0) { - $this->addPageSubItems($lastId, $data); - $data = array(); - } - $lastId = $row->pl_from; + $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 ); } - - $title = Title :: makeTitle($row->pl_namespace, $row->pl_title); - $vals = array(); - ApiQueryBase :: addTitleInfo($vals, $title, true); - $data[] = $vals; } + $cond = $lb->constructSet( $this->prefix, $this->getDB() ); + if ( $cond ) { + $this->addWhere( $cond ); + } + } - if($lastId != 0) { - $this->addPageSubItems($lastId, $data); + 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')))" + ); + } - } else { + // 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 ); + + $res = $this->select( __METHOD__ ); + + if ( is_null( $resultPageSet ) ) { + $count = 0; + 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', + "{$row->pl_from}|{$row->pl_namespace}|" . + $this->keyToTitle( $row->pl_title ) ); + break; + } + $vals = array(); + 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(); - while ($row = $db->fetchObject($res)) { - $title = Title :: makeTitle($row->pl_namespace, $row->pl_title); - if($title->userCanRead()) - $titles[] = $title; + $count = 0; + 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', + "{$row->pl_from}|{$row->pl_namespace}|" . + $this->keyToTitle( $row->pl_title ) ); + break; + } + $titles[] = Title::makeTitle( $row->pl_namespace, $row->pl_title ); } - $resultPageSet->populateFromTitles($titles); + $resultPageSet->populateFromTitles( $titles ); } - - $db->freeResult($res); } - private function addPageSubItems($pageId, $data) { - $result = $this->getResult(); - $result->setIndexedTagName($data, $this->prefix); - $result->addValue(array ('query', 'pages', intval($pageId)), - $this->getModuleName(), - $data); - } - - protected function getAllowedParams() - { + public function getAllowedParams() { return array( - 'namespace' => array( - ApiBase :: PARAM_TYPE => 'namespace', - ApiBase :: PARAM_ISMULTI => true - ) - ); + '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, + ), + ); } - protected function getParamDescription() - { - return array( - 'namespace' => "Show {$this->description}s in this namespace(s) only" - ); + public function getParamDescription() { + $desc = $this->description; + $arr = 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', + ); + 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; } - protected function getDescription() { + public function getDescription() { 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" - ); + 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 getVersion() { return __CLASS__ . ': $Id$'; } } -