]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/specials/SpecialFileDuplicateSearch.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / includes / specials / SpecialFileDuplicateSearch.php
index 172e92adf70fce506465d20ccdb58feed624e042..8021bc2c3af751b57d1e98bb5d05ca0a8db72c74 100644 (file)
@@ -1,4 +1,6 @@
 <?php
+use MediaWiki\MediaWikiServices;
+
 /**
  * Implements Special:FileDuplicateSearch
  *
  * @ingroup SpecialPage
  */
 class FileDuplicateSearchPage extends QueryPage {
-       var $hash, $filename;
+       protected $hash = '', $filename = '';
+
+       /**
+        * @var File $file selected reference file, if present
+        */
+       protected $file = null;
+
+       function __construct( $name = 'FileDuplicateSearch' ) {
+               parent::__construct( $name );
+       }
 
-       function __construct( $hash, $filename ) {
-               $this->hash = $hash;
-               $this->filename = $filename;
+       function isSyndicated() {
+               return false;
        }
 
-       function getName() { return 'FileDuplicateSearch'; }
-       function isExpensive() { return false; }
-       function isSyndicated() { return false; }
+       function isCacheable() {
+               return false;
+       }
+
+       public function isCached() {
+               return false;
+       }
 
        function linkParameters() {
-               return array( 'filename' => $this->filename );
+               return [ '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 Array of File objects
+        */
+       function getDupes() {
+               return RepoGroup::singleton()->findBySha1( $this->hash );
        }
 
-       function formatResult( $skin, $result ) {
-               global $wgContLang, $wgLang;
+       /**
+        *
+        * @param array $dupes Array of File objects
+        */
+       function showList( $dupes ) {
+               $html = [];
+               $html[] = $this->openList( 0 );
 
-               $nt = Title::makeTitle( NS_FILE, $result->title );
-               $text = $wgContLang->convert( $nt->getText() );
-               $plink = $skin->link(
-                       Title::newFromText( $nt->getPrefixedText() ),
-                       $text
-               );
+               foreach ( $dupes as $dupe ) {
+                       $line = $this->formatResult( null, $dupe );
+                       $html[] = "<li>" . $line . "</li>";
+               }
+               $html[] = $this->closeList();
 
-               $user = $skin->link( 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";
+       public function getQueryInfo() {
+               return [
+                       'tables' => [ 'image' ],
+                       'fields' => [
+                               'title' => 'img_name',
+                               'value' => 'img_sha1',
+                               'img_user_text',
+                               'img_timestamp'
+                       ],
+                       'conds' => [ 'img_sha1' => $this->hash ]
+               ];
        }
-}
 
-/**
- * Output the HTML search form, and constructs the FileDuplicateSearch object.
- */
-function wfSpecialFileDuplicateSearch( $par = null ) {
-       global $wgRequest, $wgOut, $wgLang, $wgContLang, $wgScript;
-
-       $hash = '';
-       $filename =  isset( $par ) ?  $par : $wgRequest->getText( 'filename' );
-
-       $title = Title::makeTitleSafe( NS_FILE, $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];
+       public function execute( $par ) {
+               $this->setHeaders();
+               $this->outputHeader();
+
+               $this->filename = $par !== null ? $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 );
+               }
+
+               $out = $this->getOutput();
+
+               # Create the input form
+               $formFields = [
+                       'filename' => [
+                               'type' => 'text',
+                               'name' => 'filename',
+                               'label-message' => 'fileduplicatesearch-filename',
+                               'id' => 'filename',
+                               'size' => 50,
+                               'value' => $this->filename,
+                       ],
+               ];
+               $hiddenFields = [
+                       'title' => $this->getPageTitle()->getPrefixedDBkey(),
+               ];
+               $htmlForm = HTMLForm::factory( 'ooui', $formFields, $this->getContext() );
+               $htmlForm->addHiddenFields( $hiddenFields );
+               $htmlForm->setAction( wfScript() );
+               $htmlForm->setMethod( 'get' );
+               $htmlForm->setSubmitProgressive();
+               $htmlForm->setSubmitTextMsg( $this->msg( 'fileduplicatesearch-submit' ) );
+
+               // The form should be visible always, even if it was submitted (e.g. to perform another action).
+               // To bypass the callback validation of HTMLForm, use prepareForm() and displayForm().
+               $htmlForm->prepareForm()->displayForm( false );
+
+               if ( $this->file ) {
+                       $this->hash = $this->file->getSha1();
+               } elseif ( $this->filename !== '' ) {
+                       $out->wrapWikiMsg(
+                               "<p class='mw-fileduplicatesearch-noresults'>\n$1\n</p>",
+                               [ 'fileduplicatesearch-noresults', wfEscapeWikiText( $this->filename ) ]
+                       );
+               }
+
+               if ( $this->hash != '' ) {
+                       # Show a thumbnail of the file
+                       $img = $this->file;
+                       if ( $img ) {
+                               $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
+                               if ( $thumb ) {
+                                       $out->addModuleStyles( 'mediawiki.special' );
+                                       $out->addHTML( '<div id="mw-fileduplicatesearch-icon">' .
+                                               $thumb->toHtml( [ '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>",
+                                       [ 'fileduplicatesearch-result-1', wfEscapeWikiText( $this->filename ) ]
+                               );
+                       } elseif ( $numRows ) {
+                               $out->wrapWikiMsg(
+                                       "<p class='mw-fileduplicatesearch-result-n'>\n$1\n</p>",
+                                       [ 'fileduplicatesearch-result-n', wfEscapeWikiText( $this->filename ),
+                                               $this->getLanguage()->formatNum( $numRows - 1 ) ]
+                               );
+                       }
+
+                       $this->doBatchLookups( $dupes );
+                       $this->showList( $dupes );
                }
        }
 
-       # Create the input form
-       $wgOut->addHTML(
-               Xml::openElement( 'form', array( 'id' => 'fileduplicatesearch', 'method' => 'get', 'action' => $wgScript ) ) .
-               Html::hidden( 'title', SpecialPage::getTitleFor( 'FileDuplicateSearch' )->getPrefixedDbKey() ) .
-               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->alignEnd();
-
-               # 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>' );
+       function doBatchLookups( $list ) {
+               $batch = new LinkBatch();
+               /** @var File $file */
+               foreach ( $list as $file ) {
+                       $batch->addObj( $file->getTitle() );
+                       if ( $file->isLocal() ) {
+                               $userName = $file->getUser( 'text' );
+                               $batch->add( NS_USER, $userName );
+                               $batch->add( NS_USER_TALK, $userName );
                        }
                }
 
-               # Do the query
-               $wpp = new FileDuplicateSearchPage( $hash, $filename );
-               list( $limit, $offset ) = wfCheckLimits();
-               $count = $wpp->doQuery( $offset, $limit );
+               $batch->execute();
+       }
 
-               # Show a short summary
-               if( $count == 1 ) {
-                       $wgOut->wrapWikiMsg(
-                               "<p class='mw-fileduplicatesearch-result-1'>\n$1\n</p>",
-                               array( 'fileduplicatesearch-result-1', $filename )
-                       );
-               } elseif ( $count > 1 ) {
-                       $wgOut->wrapWikiMsg(
-                               "<p class='mw-fileduplicatesearch-result-n'>\n$1\n</p>",
-                               array( 'fileduplicatesearch-result-n', $filename, $wgLang->formatNum( $count - 1 ) )
-                       );
+       /**
+        *
+        * @param Skin $skin
+        * @param File $result
+        * @return string HTML
+        */
+       function formatResult( $skin, $result ) {
+               global $wgContLang;
+
+               $linkRenderer = $this->getLinkRenderer();
+               $nt = $result->getTitle();
+               $text = $wgContLang->convert( $nt->getText() );
+               $plink = $linkRenderer->makeLink(
+                       $nt,
+                       $text
+               );
+
+               $userText = $result->getUser( 'text' );
+               if ( $result->isLocal() ) {
+                       $userId = $result->getUser( 'id' );
+                       $user = Linker::userLink( $userId, $userText );
+                       $user .= '<span style="white-space: nowrap;">';
+                       $user .= Linker::userToolLinks( $userId, $userText );
+                       $user .= '</span>';
+               } else {
+                       $user = htmlspecialchars( $userText );
+               }
+
+               $time = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
+                       $result->getTimestamp(), $this->getUser() ) );
+
+               return "$plink . . $user . . $time";
+       }
+
+       /**
+        * Return an array of subpages beginning with $search that this special page will accept.
+        *
+        * @param string $search Prefix to search for
+        * @param int $limit Maximum number of results to return (usually 10)
+        * @param int $offset Number of results to skip (usually 0)
+        * @return string[] Matching subpages
+        */
+       public function prefixSearchSubpages( $search, $limit, $offset ) {
+               $title = Title::newFromText( $search, NS_FILE );
+               if ( !$title || $title->getNamespace() !== NS_FILE ) {
+                       // No prefix suggestion outside of file namespace
+                       return [];
                }
+               $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
+               $searchEngine->setLimitOffset( $limit, $offset );
+               // Autocomplete subpage the same as a normal search, but just for files
+               $searchEngine->setNamespaces( [ NS_FILE ] );
+               $result = $searchEngine->defaultPrefixSearch( $search );
+
+               return array_map( function ( Title $t ) {
+                       // Remove namespace in search suggestion
+                       return $t->getText();
+               }, $result );
+       }
+
+       protected function getGroupName() {
+               return 'media';
        }
 }