Use local context to get messages
[lhc/web/wiklou.git] / includes / specials / SpecialFileDuplicateSearch.php
index bf4b3d2..18d19db 100644 (file)
 <?php
 /**
- * A special page to search for files by hash value as defined in the
- * img_sha1 field in the image table
+ * Implements Special:FileDuplicateSearch
+ *
+ * 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.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
  *
  * @file
  * @ingroup SpecialPage
- *
  * @author Raimond Spekking, based on Special:MIMESearch by Ævar Arnfjörð Bjarmason
- * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  */
 
 /**
  * Searches the database for files of the requested hash, comparing this with the
  * 'img_sha1' field in the image table.
+ *
  * @ingroup SpecialPage
  */
 class FileDuplicateSearchPage extends QueryPage {
-       var $hash, $filename;
+       protected $hash = '', $filename = '';
 
-       function FileDuplicateSearchPage( $hash, $filename ) {
-               $this->hash = $hash;
-               $this->filename = $filename;
+       /**
+        * @var File $file selected reference file, if present
+        */
+       protected $file = null;
+
+       function __construct( $name = 'FileDuplicateSearch' ) {
+               parent::__construct( $name );
        }
 
-       function getName() { return 'FileDuplicateSearch'; }
-       function isExpensive() { return false; }
        function isSyndicated() { return false; }
+       function isCacheable() { return false; }
+       function isCached() { return false; }
 
        function linkParameters() {
                return array( 'filename' => $this->filename );
        }
 
-       function getSQL() {
-               $dbr = wfGetDB( DB_SLAVE );
-               $image = $dbr->tableName( 'image' );
-               $hash = $dbr->addQuotes( $this->hash );
-
-               return "SELECT 'FileDuplicateSearch' AS type,
-                               img_name AS title,
-                               img_sha1 AS value,
-                               img_user_text,
-                               img_timestamp
-                       FROM $image
-                       WHERE img_sha1 = $hash
-                       ";
+       /**
+        * Fetch dupes from all connected file repositories.
+        *
+        * @return Array of File objects
+        */
+       function getDupes() {
+               return RepoGroup::singleton()->findBySha1( $this->hash );
        }
 
-       function formatResult( $skin, $result ) {
-               global $wgContLang, $wgLang;
-
-               $nt = Title::makeTitle( NS_IMAGE, $result->title );
-               $text = $wgContLang->convert( $nt->getText() );
-               $plink = $skin->makeLink( $nt->getPrefixedText(), $text );
+       /**
+        *
+        * @param $dupes Array of File objects
+        */
+       function showList( $dupes ) {
+               $html = array();
+               $html[] = $this->openList( 0 );
+
+               foreach ( $dupes as $dupe ) {
+                       $line = $this->formatResult( null, $dupe );
+                       $html[] = "<li>" . $line . "</li>";
+               }
+               $html[] = $this->closeList();
 
-               $user = $skin->makeLinkObj( Title::makeTitle( NS_USER, $result->img_user_text ), $result->img_user_text );
-               $time = $wgLang->timeanddate( $result->img_timestamp );
+               $this->getOutput()->addHtml( implode( "\n", $html ) );
+       }
 
-               return "$plink . . $user . . $time";
+       function getQueryInfo() {
+               return array(
+                       'tables' => array( 'image' ),
+                       'fields' => array(
+                               'img_name AS title',
+                               'img_sha1 AS value',
+                               'img_user_text',
+                               'img_timestamp'
+                       ),
+                       'conds' => array( 'img_sha1' => $this->hash )
+               );
        }
-}
 
-/**
- * Output the HTML search form, and constructs the FileDuplicateSearch object.
- */
-function wfSpecialFileDuplicateSearch( $par = null ) {
-       global $wgRequest, $wgTitle, $wgOut, $wgLang, $wgContLang;
-
-       $hash = '';
-       $filename =  isset( $par ) ?  $par : $wgRequest->getText( 'filename' );
-
-       $title = Title::newFromText( $filename );
-       if( $title && $title->getText() != '' ) {
-               $dbr = wfGetDB( DB_SLAVE );
-               $image = $dbr->tableName( 'image' );
-               $encFilename = $dbr->addQuotes( htmlspecialchars( $title->getDBKey() ) );
-               $sql = "SELECT img_sha1 from $image where img_name = $encFilename";
-               $res = $dbr->query( $sql );
-               $row = $dbr->fetchRow( $res );
-               if( $row !== false ) {
-                       $hash = $row[0];
+       function execute( $par ) {
+               global $wgScript;
+
+               $this->setHeaders();
+               $this->outputHeader();
+
+               $this->filename =  isset( $par ) ?  $par : $this->getRequest()->getText( 'filename' );
+               $this->file = null;
+               $this->hash = '';
+               $title = Title::newFromText( $this->filename, NS_FILE );
+               if( $title && $title->getText() != '' ) {
+                       $this->file = wfFindFile( $title );
                }
-               $dbr->freeResult( $res );
-       }
 
-       # Create the input form
-       $wgOut->addHTML(
-               Xml::openElement( 'form', array( 'id' => 'fileduplicatesearch', 'method' => 'get', 'action' => $wgTitle->getLocalUrl() ) ) .
-               Xml::openElement( 'fieldset' ) .
-               Xml::element( 'legend', null, wfMsg( 'fileduplicatesearch-legend' ) ) .
-               Xml::inputLabel( wfMsg( 'fileduplicatesearch-filename' ), 'filename', 'filename', 50, $filename ) . ' ' .
-               Xml::submitButton( wfMsg( 'fileduplicatesearch-submit' ) ) .
-               Xml::closeElement( 'fieldset' ) .
-               Xml::closeElement( 'form' )
-       );
-
-       if( $hash != '' ) {
-               $align = $wgContLang->isRtl() ? 'left' : 'right';
-
-               # Show a thumbnail of the file
-               $img = wfFindFile( $title );
-               if ( $img ) {
-                       $thumb = $img->transform( array( 'width' => 120, 'height' => 120 ) );
-                       if( $thumb ) {
-                               $wgOut->addHTML( '<div style="float:' . $align . '" id="mw-fileduplicatesearch-icon">' .
-                                       $thumb->toHtml( array( 'desc-link' => false ) ) . '<br />' .
-                                       wfMsgExt( 'fileduplicatesearch-info', array( 'parse' ),
-                                               $wgLang->formatNum( $img->getWidth() ),
-                                               $wgLang->formatNum( $img->getHeight() ),
-                                               $wgLang->formatSize( $img->getSize() ),
-                                               $img->getMimeType()
-                                       ) .
-                                       '</div>' );
-                       }
+               $out = $this->getOutput();
+
+               # Create the input form
+               $out->addHTML(
+                       Xml::openElement( 'form', array( 'id' => 'fileduplicatesearch', 'method' => 'get', 'action' => $wgScript ) ) .
+                       Html::hidden( 'title', $this->getTitle()->getPrefixedDbKey() ) .
+                       Xml::openElement( 'fieldset' ) .
+                       Xml::element( 'legend', null, $this->msg( 'fileduplicatesearch-legend' )->text() ) .
+                       Xml::inputLabel( $this->msg( 'fileduplicatesearch-filename' )->text(), 'filename', 'filename', 50, $this->filename ) . ' ' .
+                       Xml::submitButton( $this->msg( 'fileduplicatesearch-submit' )->text() ) .
+                       Xml::closeElement( 'fieldset' ) .
+                       Xml::closeElement( 'form' )
+               );
+
+               if( $this->file ) {
+                       $this->hash = $this->file->getSha1();
+               } elseif( $this->filename !== '' ) {
+                       $out->wrapWikiMsg(
+                               "<p class='mw-fileduplicatesearch-noresults'>\n$1\n</p>",
+                               array( 'fileduplicatesearch-noresults', wfEscapeWikiText( $this->filename ) )
+                       );
                }
 
-               # Do the query
-               $wpp = new FileDuplicateSearchPage( $hash, $filename );
-               list( $limit, $offset ) = wfCheckLimits();
-               $count = $wpp->doQuery( $offset, $limit );
+               if( $this->hash != '' ) {
+                       # Show a thumbnail of the file
+                       $img = $this->file;
+                       if ( $img ) {
+                               $thumb = $img->transform( array( 'width' => 120, 'height' => 120 ) );
+                               if( $thumb ) {
+                                       $out->addHTML( '<div id="mw-fileduplicatesearch-icon">' .
+                                               $thumb->toHtml( array( 'desc-link' => false ) ) . '<br />' .
+                                               $this->msg( 'fileduplicatesearch-info' )->numParams(
+                                                       $img->getWidth(), $img->getHeight() )->params(
+                                                       $this->getLanguage()->formatSize( $img->getSize() ),
+                                                       $img->getMimeType() )->parseAsBlock() .
+                                               '</div>' );
+                               }
+                       }
+
+                       $dupes = $this->getDupes();
+                       $numRows = count( $dupes );
+
+                       # Show a short summary
+                       if( $numRows == 1 ) {
+                               $out->wrapWikiMsg(
+                                       "<p class='mw-fileduplicatesearch-result-1'>\n$1\n</p>",
+                                       array( 'fileduplicatesearch-result-1', wfEscapeWikiText( $this->filename ) )
+                               );
+                       } elseif ( $numRows ) {
+                               $out->wrapWikiMsg(
+                                       "<p class='mw-fileduplicatesearch-result-n'>\n$1\n</p>",
+                                       array( 'fileduplicatesearch-result-n', wfEscapeWikiText( $this->filename ),
+                                               $this->getLanguage()->formatNum( $numRows - 1 ) )
+                               );
+                       }
 
-               # Show a short summary
-               if( $count == 1 ) {
-                       $wgOut->addHTML( '<p class="mw-fileduplicatesearch-result-1">' .
-                               wfMsgHtml( 'fileduplicatesearch-result-1', $filename ) .
-                               '</p>'
-                       );
-               } elseif ( $count > 1 ) {
-                       $wgOut->addHTML( '<p class="mw-fileduplicatesearch-result-n">' .
-                               wfMsgExt( 'fileduplicatesearch-result-n', array( 'parseinline' ), $filename, $wgLang->formatNum( $count - 1 ) ) .
-                               '</p>'
-                       );
+                       $this->showList( $dupes );
                }
        }
+
+       /**
+        *
+        * @param Skin $skin
+        * @param File $result
+        * @return string
+        */
+       function formatResult( $skin, $result ) {
+               global $wgContLang;
+
+               $nt = $result->getTitle();
+               $text = $wgContLang->convert( $nt->getText() );
+               $plink = Linker::link(
+                       Title::newFromText( $nt->getPrefixedText() ),
+                       $text
+               );
+
+               $userText = $result->getUser( 'text' );
+               $user = Linker::link( Title::makeTitle( NS_USER, $userText ), $userText );
+               $time = $this->getLanguage()->userTimeAndDate( $result->getTimestamp(), $this->getUser() );
+
+               return "$plink . . $user . . $time";
+       }
 }