X-Git-Url: https://git.heureux-cyclage.org/?a=blobdiff_plain;f=includes%2Fapi%2FApiQueryDuplicateFiles.php;h=beca58791572dfb6402de977b46fa1eb394515d1;hb=53f96171cccb378824f8708c3fe41cfb0fcdd62e;hp=fdd4bccdb7a16214bc391e10414754360b368b52;hpb=f7748d570bd9a01a203d6cbff388d0ab4c258b6a;p=lhc%2Fweb%2Fwiklou.git diff --git a/includes/api/ApiQueryDuplicateFiles.php b/includes/api/ApiQueryDuplicateFiles.php index fdd4bccdb7..beca587915 100644 --- a/includes/api/ApiQueryDuplicateFiles.php +++ b/includes/api/ApiQueryDuplicateFiles.php @@ -1,11 +1,10 @@ ,@home.nl + * Created on Sep 27, 2008 + * + * Copyright © 2008 Roan Kattouw .@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 duplicates of the given file(s) * @@ -35,126 +31,149 @@ if (!defined('MEDIAWIKI')) { */ class ApiQueryDuplicateFiles extends ApiQueryGeneratorBase { - public function __construct($query, $moduleName) { - parent :: __construct($query, $moduleName, 'df'); + public function __construct( $query, $moduleName ) { + parent::__construct( $query, $moduleName, 'df' ); } public function execute() { $this->run(); } - public function executeGenerator($resultPageSet) { - $this->run($resultPageSet); + public function getCacheMode( $params ) { + return 'public'; + } + + public function executeGenerator( $resultPageSet ) { + $this->run( $resultPageSet ); } - private function run($resultPageSet = null) { + /** + * @param $resultPageSet ApiPageSet + * @return + */ + private function run( $resultPageSet = null ) { $params = $this->extractRequestParams(); $namespaces = $this->getPageSet()->getAllTitlesByNamespace(); - $images = $namespaces[NS_IMAGE]; - if(empty($images)) + if ( empty( $namespaces[NS_FILE] ) ) { return; - - $this->addTables('image', 'i1'); - $this->addTables('image', 'i2'); - $this->addFields(array( + } + $images = $namespaces[NS_FILE]; + + $this->addTables( 'image', 'i1' ); + $this->addTables( 'image', 'i2' ); + $this->addFields( array( 'i1.img_name AS orig_name', 'i2.img_name AS dup_name', 'i2.img_user_text AS dup_user_text', 'i2.img_timestamp AS dup_timestamp' - )); - $this->addWhere(array( - 'i1.img_name' => array_keys($images), + ) ); + + $this->addWhere( array( + 'i1.img_name' => array_keys( $images ), 'i1.img_sha1 = i2.img_sha1', 'i1.img_name != i2.img_name', - )); - if(isset($params['continue'])) - { - $cont = explode('|', $params['continue']); - if(count($cont) != 2) - $this->dieUsage("Invalid continue param. You should pass the " . - "original value returned by the previous query", "_badcontinue"); - $orig = $this->getDB()->strencode($this->titleTokey($cont[0])); - $dup = $this->getDB()->strencode($this->titleToKey($cont[1])); - $this->addWhere("i1.img_name > '$orig' OR ". - "(i1.img_name = '$orig' AND ". - "i2.img_name >= '$dup')"); + ) ); + + if ( isset( $params['continue'] ) ) { + $cont = explode( '|', $params['continue'] ); + if ( count( $cont ) != 2 ) { + $this->dieUsage( 'Invalid continue param. You should pass the ' . + 'original value returned by the previous query', '_badcontinue' ); + } + $orig = $this->getDB()->strencode( $this->titleTokey( $cont[0] ) ); + $dup = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) ); + $this->addWhere( + "i1.img_name > '$orig' OR " . + "(i1.img_name = '$orig' AND " . + "i2.img_name >= '$dup')" + ); } - $this->addOption('ORDER BY', 'i1.img_name'); - $this->addOption('LIMIT', $params['limit'] + 1); - $res = $this->select(__METHOD__); - $db = $this->getDB(); + $dir = ( $params['dir'] == 'descending' ? ' DESC' : '' ); + $this->addOption( 'ORDER BY', 'i1.img_name' . $dir ); + $this->addOption( 'LIMIT', $params['limit'] + 1 ); + + $res = $this->select( __METHOD__ ); $count = 0; - $data = array(); $titles = array(); - $lastName = ''; - 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->keyToTitle($row->orig_name) . '|' . - $this->keyToTitle($row->dup_name)); + $this->setContinueEnumParameter( 'continue', + $this->keyToTitle( $row->orig_name ) . '|' . + $this->keyToTitle( $row->dup_name ) ); break; } - if(!is_null($resultPageSet)) - $titles[] = Title::makeTitle(NS_IMAGE, $row->dup_name); - else - { - if($row->orig_name != $lastName) - { - if($lastName != '') - { - $this->addPageSubItems($images[$lastName], $data); - $data = array(); - } - $lastName = $row->orig_name; - } - - $data[] = array( + if ( !is_null( $resultPageSet ) ) { + $titles[] = Title::makeTitle( NS_FILE, $row->dup_name ); + } else { + $r = array( 'name' => $row->dup_name, 'user' => $row->dup_user_text, - 'timestamp' => wfTimestamp(TS_ISO_8601, $row->dup_timestamp) + 'timestamp' => wfTimestamp( TS_ISO_8601, $row->dup_timestamp ) ); + $fit = $this->addPageSubItem( $images[$row->orig_name], $r ); + if ( !$fit ) { + $this->setContinueEnumParameter( 'continue', + $this->keyToTitle( $row->orig_name ) . '|' . + $this->keyToTitle( $row->dup_name ) ); + break; + } } } - if(!is_null($resultPageSet)) - $resultPageSet->populateFromTitles($titles); - else if($lastName != '') - $this->addPageSubItems($images[$lastName], $data); - $db->freeResult($res); + if ( !is_null( $resultPageSet ) ) { + $resultPageSet->populateFromTitles( $titles ); + } } public function getAllowedParams() { - return array ( + return array( '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 + 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, + 'dir' => array( + ApiBase::PARAM_DFLT => 'ascending', + ApiBase::PARAM_TYPE => array( + 'ascending', + 'descending' + ) + ), ); } public function getParamDescription() { - return array ( + return array( 'limit' => 'How many files to return', 'continue' => 'When more results are available, use this to continue', + 'dir' => 'The direction in which to list', ); } public function getDescription() { - return 'List all files that are duplicates of the given file(s).'; + return 'List all files that are duplicates of the given file(s)'; } - protected function getExamples() { - return array ( - // TODO - ); + public function getPossibleErrors() { + return array_merge( parent::getPossibleErrors(), array( + array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ), + ) ); + } + + public function getExamples() { + return array( + 'api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles', + 'api.php?action=query&generator=allimages&prop=duplicatefiles', + ); + } + + public function getHelpUrls() { + return 'https://www.mediawiki.org/wiki/API:Properties#duplicatefiles_.2F_df'; } public function getVersion() {