includes/api/ApiQueryDuplicateFiles.php

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