From: Roan Kattouw Date: Sat, 27 Sep 2008 11:42:28 +0000 (+0000) Subject: (bug 15653) Add prop=duplicatefiles to the API X-Git-Tag: 1.31.0-rc.0~45069 X-Git-Url: http://git.cyclocoop.org/%24action?a=commitdiff_plain;h=f7748d570bd9a01a203d6cbff388d0ab4c258b6a;p=lhc%2Fweb%2Fwiklou.git (bug 15653) Add prop=duplicatefiles to the API --- diff --git a/RELEASE-NOTES b/RELEASE-NOTES index 30609b30b7..47a24d6153 100644 --- a/RELEASE-NOTES +++ b/RELEASE-NOTES @@ -281,6 +281,7 @@ The following extensions are migrated into MediaWiki 1.14: * (bug 15609) Add inprop=url and inprop=readable to prop=info * Add ApiDisabled and ApiQueryDisabled classes so individual modules can be disabled in LocalSettings.php +* (bug 15653) Add prop=duplicatefiles === Languages updated in 1.14 === diff --git a/includes/AutoLoader.php b/includes/AutoLoader.php index e7210736e8..7349bde9ec 100644 --- a/includes/AutoLoader.php +++ b/includes/AutoLoader.php @@ -259,6 +259,7 @@ $wgAutoloadLocalClasses = array( 'ApiQueryContributions' => 'includes/api/ApiQueryUserContributions.php', 'ApiQueryDeletedrevs' => 'includes/api/ApiQueryDeletedrevs.php', 'ApiQueryDisabled' => 'includes/api/ApiQueryDisabled.php', + 'ApiQueryDuplicateFiles' => 'includes/api/ApiQueryDuplicateFiles.php', 'ApiQueryExtLinksUsage' => 'includes/api/ApiQueryExtLinksUsage.php', 'ApiQueryExternalLinks' => 'includes/api/ApiQueryExternalLinks.php', 'ApiQueryGeneratorBase' => 'includes/api/ApiQueryBase.php', diff --git a/includes/api/ApiQuery.php b/includes/api/ApiQuery.php index 3494f0ad97..dc7a3dc7ed 100644 --- a/includes/api/ApiQuery.php +++ b/includes/api/ApiQuery.php @@ -56,6 +56,7 @@ class ApiQuery extends ApiBase { 'categories' => 'ApiQueryCategories', 'extlinks' => 'ApiQueryExternalLinks', 'categoryinfo' => 'ApiQueryCategoryInfo', + 'duplicatefiles' => 'ApiQueryDuplicateFiles', ); private $mQueryListModules = array ( diff --git a/includes/api/ApiQueryDuplicateFiles.php b/includes/api/ApiQueryDuplicateFiles.php new file mode 100644 index 0000000000..fdd4bccdb7 --- /dev/null +++ b/includes/api/ApiQueryDuplicateFiles.php @@ -0,0 +1,163 @@ +,@home.nl + * + * 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 + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * 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. + * http://www.gnu.org/copyleft/gpl.html + */ + +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) + * + * @ingroup API + */ +class ApiQueryDuplicateFiles extends ApiQueryGeneratorBase { + + public function __construct($query, $moduleName) { + parent :: __construct($query, $moduleName, 'df'); + } + + public function execute() { + $this->run(); + } + + public function executeGenerator($resultPageSet) { + $this->run($resultPageSet); + } + + private function run($resultPageSet = null) { + $params = $this->extractRequestParams(); + $namespaces = $this->getPageSet()->getAllTitlesByNamespace(); + $images = $namespaces[NS_IMAGE]; + if(empty($images)) + return; + + $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), + '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')"); + } + $this->addOption('ORDER BY', 'i1.img_name'); + $this->addOption('LIMIT', $params['limit'] + 1); + + $res = $this->select(__METHOD__); + $db = $this->getDB(); + $count = 0; + $data = array(); + $titles = array(); + $lastName = ''; + while($row = $db->fetchObject($res)) + { + 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)); + 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( + 'name' => $row->dup_name, + 'user' => $row->dup_user_text, + 'timestamp' => wfTimestamp(TS_ISO_8601, $row->dup_timestamp) + ); + } + } + if(!is_null($resultPageSet)) + $resultPageSet->populateFromTitles($titles); + else if($lastName != '') + $this->addPageSubItems($images[$lastName], $data); + $db->freeResult($res); + } + + public function getAllowedParams() { + 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 + ), + 'continue' => null, + ); + } + + public function getParamDescription() { + return array ( + 'limit' => 'How many files to return', + 'continue' => 'When more results are available, use this to continue', + ); + } + + public function getDescription() { + return 'List all files that are duplicates of the given file(s).'; + } + + protected function getExamples() { + return array ( + // TODO + ); + } + + public function getVersion() { + return __CLASS__ . ': $Id$'; + } +}