3 use MediaWiki\MediaWikiServices
;
6 * Implements Special:FileDuplicateSearch
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License along
19 * with this program; if not, write to the Free Software Foundation, Inc.,
20 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
21 * http://www.gnu.org/copyleft/gpl.html
24 * @ingroup SpecialPage
25 * @author Raimond Spekking, based on Special:MIMESearch by Ævar Arnfjörð Bjarmason
29 * Searches the database for files of the requested hash, comparing this with the
30 * 'img_sha1' field in the image table.
32 * @ingroup SpecialPage
34 class SpecialFileDuplicateSearch
extends QueryPage
{
35 protected $hash = '', $filename = '';
38 * @var File $file selected reference file, if present
40 protected $file = null;
42 function __construct( $name = 'FileDuplicateSearch' ) {
43 parent
::__construct( $name );
46 function isSyndicated() {
50 function isCacheable() {
54 public function isCached() {
58 function linkParameters() {
59 return [ 'filename' => $this->filename
];
63 * Fetch dupes from all connected file repositories.
65 * @return array Array of File objects
68 return RepoGroup
::singleton()->findBySha1( $this->hash
);
73 * @param array $dupes Array of File objects
75 function showList( $dupes ) {
77 $html[] = $this->openList( 0 );
79 foreach ( $dupes as $dupe ) {
80 $line = $this->formatResult( null, $dupe );
81 $html[] = "<li>" . $line . "</li>";
83 $html[] = $this->closeList();
85 $this->getOutput()->addHTML( implode( "\n", $html ) );
88 public function getQueryInfo() {
89 $imgQuery = LocalFile
::getQueryInfo();
91 'tables' => $imgQuery['tables'],
93 'title' => 'img_name',
94 'value' => 'img_sha1',
95 'img_user_text' => $imgQuery['fields']['img_user_text'],
98 'conds' => [ 'img_sha1' => $this->hash
],
99 'join_conds' => $imgQuery['joins'],
103 public function execute( $par ) {
105 $this->outputHeader();
107 $this->filename
= $par ??
$this->getRequest()->getText( 'filename' );
110 $title = Title
::newFromText( $this->filename
, NS_FILE
);
111 if ( $title && $title->getText() != '' ) {
112 $this->file
= MediaWikiServices
::getInstance()->getRepoGroup()->findFile( $title );
115 $out = $this->getOutput();
117 # Create the input form
121 'name' => 'filename',
122 'label-message' => 'fileduplicatesearch-filename',
125 'default' => $this->filename
,
129 'title' => $this->getPageTitle()->getPrefixedDBkey(),
131 $htmlForm = HTMLForm
::factory( 'ooui', $formFields, $this->getContext() );
132 $htmlForm->addHiddenFields( $hiddenFields );
133 $htmlForm->setAction( wfScript() );
134 $htmlForm->setMethod( 'get' );
135 $htmlForm->setSubmitTextMsg( $this->msg( 'fileduplicatesearch-submit' ) );
137 // The form should be visible always, even if it was submitted (e.g. to perform another action).
138 // To bypass the callback validation of HTMLForm, use prepareForm() and displayForm().
139 $htmlForm->prepareForm()->displayForm( false );
142 $this->hash
= $this->file
->getSha1();
143 } elseif ( $this->filename
!== '' ) {
145 "<p class='mw-fileduplicatesearch-noresults'>\n$1\n</p>",
146 [ 'fileduplicatesearch-noresults', wfEscapeWikiText( $this->filename
) ]
150 if ( $this->hash
!= '' ) {
151 # Show a thumbnail of the file
154 $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
156 $out->addModuleStyles( 'mediawiki.special' );
157 $out->addHTML( '<div id="mw-fileduplicatesearch-icon">' .
158 $thumb->toHtml( [ 'desc-link' => false ] ) . '<br />' .
159 $this->msg( 'fileduplicatesearch-info' )->numParams(
160 $img->getWidth(), $img->getHeight() )->params(
161 $this->getLanguage()->formatSize( $img->getSize() ),
162 $img->getMimeType() )->parseAsBlock() .
167 $dupes = $this->getDupes();
168 $numRows = count( $dupes );
170 # Show a short summary
171 if ( $numRows == 1 ) {
173 "<p class='mw-fileduplicatesearch-result-1'>\n$1\n</p>",
174 [ 'fileduplicatesearch-result-1', wfEscapeWikiText( $this->filename
) ]
176 } elseif ( $numRows ) {
178 "<p class='mw-fileduplicatesearch-result-n'>\n$1\n</p>",
179 [ 'fileduplicatesearch-result-n', wfEscapeWikiText( $this->filename
),
180 $this->getLanguage()->formatNum( $numRows - 1 ) ]
184 $this->doBatchLookups( $dupes );
185 $this->showList( $dupes );
189 function doBatchLookups( $list ) {
190 $batch = new LinkBatch();
191 /** @var File $file */
192 foreach ( $list as $file ) {
193 $batch->addObj( $file->getTitle() );
194 if ( $file->isLocal() ) {
195 $userName = $file->getUser( 'text' );
196 $batch->add( NS_USER
, $userName );
197 $batch->add( NS_USER_TALK
, $userName );
207 * @param File $result
208 * @return string HTML
210 function formatResult( $skin, $result ) {
211 $linkRenderer = $this->getLinkRenderer();
212 $nt = $result->getTitle();
213 $text = MediaWikiServices
::getInstance()->getContentLanguage()->convert(
214 htmlspecialchars( $nt->getText() )
216 $plink = $linkRenderer->makeLink(
218 new HtmlArmor( $text )
221 $userText = $result->getUser( 'text' );
222 if ( $result->isLocal() ) {
223 $userId = $result->getUser( 'id' );
224 $user = Linker
::userLink( $userId, $userText );
225 $user .= '<span style="white-space: nowrap;">';
226 $user .= Linker
::userToolLinks( $userId, $userText );
229 $user = htmlspecialchars( $userText );
232 $time = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
233 $result->getTimestamp(), $this->getUser() ) );
235 return "$plink . . $user . . $time";
239 * Return an array of subpages beginning with $search that this special page will accept.
241 * @param string $search Prefix to search for
242 * @param int $limit Maximum number of results to return (usually 10)
243 * @param int $offset Number of results to skip (usually 0)
244 * @return string[] Matching subpages
246 public function prefixSearchSubpages( $search, $limit, $offset ) {
247 $title = Title
::newFromText( $search, NS_FILE
);
248 if ( !$title ||
$title->getNamespace() !== NS_FILE
) {
249 // No prefix suggestion outside of file namespace
252 $searchEngine = MediaWikiServices
::getInstance()->newSearchEngine();
253 $searchEngine->setLimitOffset( $limit, $offset );
254 // Autocomplete subpage the same as a normal search, but just for files
255 $searchEngine->setNamespaces( [ NS_FILE
] );
256 $result = $searchEngine->defaultPrefixSearch( $search );
258 return array_map( function ( Title
$t ) {
259 // Remove namespace in search suggestion
260 return $t->getText();
264 protected function getGroupName() {