includes/api/ApiQueryDuplicateFiles.php

   1 <?php
   2
   3 /*
   4  * Created on Sep 27, 2008
   5  *
   6  * API for MediaWiki 1.8+
   7  *
   8  * Copyright (C) 2008 Roan Kattow <Firstname>,<Lastname>@home.nl
   9  *
  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.
  14  *
  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.
  19  *
  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  * 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
  23  * http://www.gnu.org/copyleft/gpl.html
  24  */
  25
  26 if ( !defined( 'MEDIAWIKI' ) ) {
  27         // Eclipse helper - will be ignored in production
  28         require_once ( "ApiQueryBase.php" );
  29 }
  30
  31 /**
  32  * A query module to list duplicates of the given file(s)
  33  *
  34  * @ingroup API
  35  */
  36 class ApiQueryDuplicateFiles extends ApiQueryGeneratorBase {
  37
  38         public function __construct( $query, $moduleName ) {
  39                 parent :: __construct( $query, $moduleName, 'df' );
  40         }
  41
  42         public function execute() {
  43                 $this->run();
  44         }
  45
  46         public function executeGenerator( $resultPageSet ) {
  47                 $this->run( $resultPageSet );
  48         }
  49
  50         private function run( $resultPageSet = null ) {
  51                 $params = $this->extractRequestParams();
  52                 $namespaces = $this->getPageSet()->getAllTitlesByNamespace();
  53                 if ( empty( $namespaces[NS_FILE] ) ) {
  54                         return;
  55                 }
  56                 $images = $namespaces[NS_FILE];
  57
  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'
  65                 ) );
  66
  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',
  71                 ) );
  72
  73                 if ( isset( $params['continue'] ) )
  74                 {
  75                         $cont = explode( '|', $params['continue'] );
  76                         if ( count( $cont ) != 2 )
  77                                 $this->dieUsage( "Invalid continue param. You should pass the " .
  78                                         "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] ) );
  81                         $this->addWhere( "i1.img_name > '$orig' OR " .
  82                                         "(i1.img_name = '$orig' AND " .
  83                                         "i2.img_name >= '$dup')" );
  84                 }
  85
  86                 $this->addOption( 'ORDER BY', 'i1.img_name' );
  87                 $this->addOption( 'LIMIT', $params['limit'] + 1 );
  88
  89                 $res = $this->select( __METHOD__ );
  90                 $db = $this->getDB();
  91                 $count = 0;
  92                 $titles = array();
  93                 while ( $row = $db->fetchObject( $res ) )
  94                 {
  95                         if ( ++$count > $params['limit'] )
  96                         {
  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 ) );
 102                                 break;
 103                         }
 104                         if ( !is_null( $resultPageSet ) )
 105                                 $titles[] = Title::makeTitle( NS_FILE, $row->dup_name );
 106                         else
 107                         {
 108                                 $r = array(
 109                                         'name' => $row->dup_name,
 110                                         'user' => $row->dup_user_text,
 111                                         'timestamp' => wfTimestamp( TS_ISO_8601, $row->dup_timestamp )
 112                                 );
 113                                 $fit = $this->addPageSubItem( $images[$row->orig_name], $r );
 114                                 if ( !$fit )
 115                                 {
 116                                         $this->setContinueEnumParameter( 'continue',
 117                                                         $this->keyToTitle( $row->orig_name ) . '|' .
 118                                                         $this->keyToTitle( $row->dup_name ) );
 119                                         break;
 120                                 }
 121                         }
 122                 }
 123                 if ( !is_null( $resultPageSet ) )
 124                         $resultPageSet->populateFromTitles( $titles );
 125                 $db->freeResult( $res );
 126         }
 127
 128         public function getAllowedParams() {
 129                 return array (
 130                         'limit' => array(
 131                                 ApiBase :: PARAM_DFLT => 10,
 132                                 ApiBase :: PARAM_TYPE => 'limit',
 133                                 ApiBase :: PARAM_MIN => 1,
 134                                 ApiBase :: PARAM_MAX => ApiBase :: LIMIT_BIG1,
 135                                 ApiBase :: PARAM_MAX2 => ApiBase :: LIMIT_BIG2
 136                         ),
 137                         'continue' => null,
 138                 );
 139         }
 140
 141         public function getParamDescription() {
 142                 return array (
 143                         'limit' => 'How many files to return',
 144                         'continue' => 'When more results are available, use this to continue',
 145                 );
 146         }
 147
 148         public function getDescription() {
 149                 return 'List all files that are duplicates of the given file(s).';
 150         }
 151
 152         public function getPossibleErrors() {
 153                 return array_merge( parent::getPossibleErrors(), array(
 154                         array( 'code' => '_badcontinue', 'info' => 'Invalid continue param. You should pass the original value returned by the previous query' ),
 155                 ) );
 156         }
 157
 158         protected function getExamples() {
 159                 return array (  'api.php?action=query&titles=File:Albert_Einstein_Head.jpg&prop=duplicatefiles',
 160                                 'api.php?action=query&generator=allimages&prop=duplicatefiles',
 161                         );
 162         }
 163
 164         public function getVersion() {
 165                 return __CLASS__ . ': $Id$';
 166         }
 167 }