4 * Created on Sep 27, 2008
6 * API for MediaWiki 1.8+
8 * Copyright © 2008 Roan Kattow <Firstname>,<Lastname>@home.nl
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License as published by
12 * the Free Software Foundation; either version 2 of the License, or
13 * (at your option) any later version.
15 * This program is distributed in the hope that it will be useful,
16 * but WITHOUT ANY WARRANTY; without even the implied warranty of
17 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18 * GNU General Public License for more details.
20 * You should have received a copy of the GNU General Public License along
21 * with this program; if not, write to the Free Software Foundation, Inc.,
22 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
23 * http://www.gnu.org/copyleft/gpl.html
26 if ( !defined( 'MEDIAWIKI' ) ) {
27 // Eclipse helper - will be ignored in production
28 require_once( "ApiQueryBase.php" );
32 * A query module to list duplicates of the given file(s)
36 class ApiQueryDuplicateFiles
extends ApiQueryGeneratorBase
{
38 public function __construct( $query, $moduleName ) {
39 parent
::__construct( $query, $moduleName, 'df' );
42 public function execute() {
46 public function executeGenerator( $resultPageSet ) {
47 $this->run( $resultPageSet );
50 private function run( $resultPageSet = null ) {
51 $params = $this->extractRequestParams();
52 $namespaces = $this->getPageSet()->getAllTitlesByNamespace();
53 if ( empty( $namespaces[NS_FILE
] ) ) {
56 $images = $namespaces[NS_FILE
];
58 $this->addTables( 'image', 'i1' );
59 $this->addTables( 'image', 'i2' );
60 $this->addFields( array(
61 'i1.img_name AS orig_name',
62 'i2.img_name AS dup_name',
63 'i2.img_user_text AS dup_user_text',
64 'i2.img_timestamp AS dup_timestamp'
67 $this->addWhere( array(
68 'i1.img_name' => array_keys( $images ),
69 'i1.img_sha1 = i2.img_sha1',
70 'i1.img_name != i2.img_name',
73 if ( isset( $params['continue'] ) ) {
74 $cont = explode( '|', $params['continue'] );
75 if ( count( $cont ) != 2 ) {
76 $this->dieUsage( 'Invalid continue param. You should pass the ' .
77 'original value returned by the previous query', '_badcontinue' );
79 $orig = $this->getDB()->strencode( $this->titleTokey( $cont[0] ) );
80 $dup = $this->getDB()->strencode( $this->titleToKey( $cont[1] ) );
82 "i1.img_name > '$orig' OR " .
83 "(i1.img_name = '$orig' AND " .
84 "i2.img_name >= '$dup')"
88 $this->addOption( 'ORDER BY', 'i1.img_name' );
89 $this->addOption( 'LIMIT', $params['limit'] +
1 );
91 $res = $this->select( __METHOD__
);
95 foreach ( $res as $row ) {
96 if ( ++
$count > $params['limit'] ) {
97 // We've reached the one extra which shows that
98 // there are additional pages to be had. Stop here...
99 $this->setContinueEnumParameter( 'continue',
100 $this->keyToTitle( $row->orig_name
) . '|' .
101 $this->keyToTitle( $row->dup_name
) );
104 if ( !is_null( $resultPageSet ) ) {
105 $titles[] = Title
::makeTitle( NS_FILE
, $row->dup_name
);
108 'name' => $row->dup_name
,
109 'user' => $row->dup_user_text
,
110 'timestamp' => wfTimestamp( TS_ISO_8601
, $row->dup_timestamp
)
112 $fit = $this->addPageSubItem( $images[$row->orig_name
], $r );
114 $this->setContinueEnumParameter( 'continue',
115 $this->keyToTitle( $row->orig_name
) . '|' .
116 $this->keyToTitle( $row->dup_name
) );
121 if ( !is_null( $resultPageSet ) ) {
122 $resultPageSet->populateFromTitles( $titles );
126 public function getAllowedParams() {
129 ApiBase
::PARAM_DFLT
=> 10,
130 ApiBase
::PARAM_TYPE
=> 'limit',
131 ApiBase
::PARAM_MIN
=> 1,
132 ApiBase
::PARAM_MAX
=> ApiBase
::LIMIT_BIG1
,
133 ApiBase
::PARAM_MAX2
=> ApiBase
::LIMIT_BIG2
139 public function getParamDescription() {
141 'limit' => 'How many files to return',
142 'continue' => 'When more results are available, use this to continue',
146 public function getDescription() {
147 return 'List all files that are duplicates of the given file(s)';
150 public function getPossibleErrors() {
151 return array_merge( parent
::getPossibleErrors(), array(
152 array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
156 protected function getExamples() {
158 'api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles',
159 'api.php?action=query&generator=allimages&prop=duplicatefiles',
163 public function getVersion() {
164 return __CLASS__
. ': $Id$';