MediaWiki  master
SpecialFileDuplicateSearch.php
Go to the documentation of this file.
1 <?php
2 
4 
35  protected $hash = '', $filename = '';
36 
40  protected $file = null;
41 
42  public function __construct( $name = 'FileDuplicateSearch' ) {
43  parent::__construct( $name );
44  }
45 
46  public function isSyndicated() {
47  return false;
48  }
49 
50  public function isCacheable() {
51  return false;
52  }
53 
54  public function isCached() {
55  return false;
56  }
57 
58  protected function linkParameters() {
59  return [ 'filename' => $this->filename ];
60  }
61 
67  private function getDupes() {
68  return MediaWikiServices::getInstance()->getRepoGroup()->findBySha1( $this->hash );
69  }
70 
74  private function showList( $dupes ) {
75  $html = [];
76  $html[] = $this->openList( 0 );
77 
78  foreach ( $dupes as $dupe ) {
79  $line = $this->formatResult( null, $dupe );
80  $html[] = "<li>" . $line . "</li>";
81  }
82  $html[] = $this->closeList();
83 
84  $this->getOutput()->addHTML( implode( "\n", $html ) );
85  }
86 
87  public function getQueryInfo() {
88  $imgQuery = LocalFile::getQueryInfo();
89  return [
90  'tables' => $imgQuery['tables'],
91  'fields' => [
92  'title' => 'img_name',
93  'value' => 'img_sha1',
94  'img_user_text' => $imgQuery['fields']['img_user_text'],
95  'img_timestamp'
96  ],
97  'conds' => [ 'img_sha1' => $this->hash ],
98  'join_conds' => $imgQuery['joins'],
99  ];
100  }
101 
102  public function execute( $par ) {
103  $this->setHeaders();
104  $this->outputHeader();
105 
106  $this->filename = $par ?? $this->getRequest()->getText( 'filename' );
107  $this->file = null;
108  $this->hash = '';
109  $title = Title::newFromText( $this->filename, NS_FILE );
110  if ( $title && $title->getText() != '' ) {
111  $this->file = MediaWikiServices::getInstance()->getRepoGroup()->findFile( $title );
112  }
113 
114  $out = $this->getOutput();
115 
116  # Create the input form
117  $formFields = [
118  'filename' => [
119  'type' => 'text',
120  'name' => 'filename',
121  'label-message' => 'fileduplicatesearch-filename',
122  'id' => 'filename',
123  'size' => 50,
124  'default' => $this->filename,
125  ],
126  ];
127  $hiddenFields = [
128  'title' => $this->getPageTitle()->getPrefixedDBkey(),
129  ];
130  $htmlForm = HTMLForm::factory( 'ooui', $formFields, $this->getContext() );
131  $htmlForm->addHiddenFields( $hiddenFields );
132  $htmlForm->setAction( wfScript() );
133  $htmlForm->setMethod( 'get' );
134  $htmlForm->setSubmitTextMsg( $this->msg( 'fileduplicatesearch-submit' ) );
135 
136  // The form should be visible always, even if it was submitted (e.g. to perform another action).
137  // To bypass the callback validation of HTMLForm, use prepareForm() and displayForm().
138  $htmlForm->prepareForm()->displayForm( false );
139 
140  if ( $this->file ) {
141  $this->hash = $this->file->getSha1();
142  } elseif ( $this->filename !== '' ) {
143  $out->wrapWikiMsg(
144  "<p class='mw-fileduplicatesearch-noresults'>\n$1\n</p>",
145  [ 'fileduplicatesearch-noresults', wfEscapeWikiText( $this->filename ) ]
146  );
147  }
148 
149  if ( $this->hash != '' ) {
150  # Show a thumbnail of the file
151  $img = $this->file;
152  if ( $img ) {
153  $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
154  if ( $thumb ) {
155  $out->addModuleStyles( 'mediawiki.special' );
156  $out->addHTML( '<div id="mw-fileduplicatesearch-icon">' .
157  $thumb->toHtml( [ 'desc-link' => false ] ) . '<br />' .
158  $this->msg( 'fileduplicatesearch-info' )->numParams(
159  $img->getWidth(), $img->getHeight() )->params(
160  $this->getLanguage()->formatSize( $img->getSize() ),
161  $img->getMimeType() )->parseAsBlock() .
162  '</div>' );
163  }
164  }
165 
166  $dupes = $this->getDupes();
167  $numRows = count( $dupes );
168 
169  # Show a short summary
170  if ( $numRows == 1 ) {
171  $out->wrapWikiMsg(
172  "<p class='mw-fileduplicatesearch-result-1'>\n$1\n</p>",
173  [ 'fileduplicatesearch-result-1', wfEscapeWikiText( $this->filename ) ]
174  );
175  } elseif ( $numRows ) {
176  $out->wrapWikiMsg(
177  "<p class='mw-fileduplicatesearch-result-n'>\n$1\n</p>",
178  [ 'fileduplicatesearch-result-n', wfEscapeWikiText( $this->filename ),
179  $this->getLanguage()->formatNum( $numRows - 1 ) ]
180  );
181  }
182 
183  $this->doBatchLookups( $dupes );
184  $this->showList( $dupes );
185  }
186  }
187 
188  private function doBatchLookups( $list ) {
189  $batch = new LinkBatch();
191  foreach ( $list as $file ) {
192  $batch->addObj( $file->getTitle() );
193  if ( $file->isLocal() ) {
194  $userName = $file->getUser( 'text' );
195  $batch->add( NS_USER, $userName );
196  $batch->add( NS_USER_TALK, $userName );
197  }
198  }
199 
200  $batch->execute();
201  }
202 
208  public function formatResult( $skin, $result ) {
209  $linkRenderer = $this->getLinkRenderer();
210  $nt = $result->getTitle();
211  $text = MediaWikiServices::getInstance()->getContentLanguage()->convert(
212  htmlspecialchars( $nt->getText() )
213  );
214  $plink = $linkRenderer->makeLink(
215  $nt,
216  new HtmlArmor( $text )
217  );
218 
219  $userText = $result->getUser( 'text' );
220  if ( $result->isLocal() ) {
221  $userId = $result->getUser( 'id' );
222  $user = Linker::userLink( $userId, $userText );
223  $user .= '<span style="white-space: nowrap;">';
224  $user .= Linker::userToolLinks( $userId, $userText );
225  $user .= '</span>';
226  } else {
227  $user = htmlspecialchars( $userText );
228  }
229 
230  $time = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
231  $result->getTimestamp(), $this->getUser() ) );
232 
233  return "$plink . . $user . . $time";
234  }
235 
244  public function prefixSearchSubpages( $search, $limit, $offset ) {
245  $title = Title::newFromText( $search, NS_FILE );
246  if ( !$title || $title->getNamespace() !== NS_FILE ) {
247  // No prefix suggestion outside of file namespace
248  return [];
249  }
250  $searchEngine = MediaWikiServices::getInstance()->newSearchEngine();
251  $searchEngine->setLimitOffset( $limit, $offset );
252  // Autocomplete subpage the same as a normal search, but just for files
253  $searchEngine->setNamespaces( [ NS_FILE ] );
254  $result = $searchEngine->defaultPrefixSearch( $search );
255 
256  return array_map( function ( Title $t ) {
257  // Remove namespace in search suggestion
258  return $t->getText();
259  }, $result );
260  }
261 
262  protected function getGroupName() {
263  return 'media';
264  }
265 }
SpecialFileDuplicateSearch\getDupes
getDupes()
Fetch dupes from all connected file repositories.
Definition: SpecialFileDuplicateSearch.php:67
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:669
SpecialPage\msg
msg( $key,... $params)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:800
SpecialFileDuplicateSearch\formatResult
formatResult( $skin, $result)
Definition: SpecialFileDuplicateSearch.php:208
Title\newFromText
static newFromText( $text, $defaultNamespace=NS_MAIN)
Create a new Title from text, such as what one would find in a link.
Definition: Title.php:332
HtmlArmor
Marks HTML that shouldn't be escaped.
Definition: HtmlArmor.php:28
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:35
Linker\userLink
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:896
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:716
MediaWiki\MediaWikiServices
MediaWikiServices is the service locator for the application scope of MediaWiki.
Definition: MediaWikiServices.php:146
Linker\userToolLinks
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null, $useParentheses=true)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:941
File\getUser
getUser( $type='text')
Returns ID or name of user who uploaded the file STUB.
Definition: File.php:585
SpecialFileDuplicateSearch\isCached
isCached()
Whether or not the output of the page in question is retrieved from the database cache.
Definition: SpecialFileDuplicateSearch.php:54
NS_FILE
const NS_FILE
Definition: Defines.php:75
QueryPage\openList
openList( $offset)
Definition: QueryPage.php:772
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:746
SpecialFileDuplicateSearch\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialFileDuplicateSearch.php:262
QueryPage
This is a class for doing query pages; since they're almost all the same, we factor out some of the f...
Definition: QueryPage.php:36
SpecialFileDuplicateSearch
Searches the database for files of the requested hash, comparing this with the 'img_sha1' field in th...
Definition: SpecialFileDuplicateSearch.php:34
QueryPage\$offset
int $offset
The offset and limit in use, as passed to the query() function.
Definition: QueryPage.php:41
QueryPage\$limit
int $limit
Definition: QueryPage.php:44
QueryPage\closeList
closeList()
Definition: QueryPage.php:779
File
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:62
SpecialFileDuplicateSearch\linkParameters
linkParameters()
If using extra form wheely-dealies, return a set of parameters here as an associative array.
Definition: SpecialFileDuplicateSearch.php:58
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2530
SpecialFileDuplicateSearch\execute
execute( $par)
This is the actual workhorse.
Definition: SpecialFileDuplicateSearch.php:102
$title
$title
Definition: testCompression.php:38
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:551
SpecialFileDuplicateSearch\$filename
$filename
Definition: SpecialFileDuplicateSearch.php:35
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:689
QueryPage\$numRows
int $numRows
The number of rows returned by the query.
Definition: QueryPage.php:53
NS_USER_TALK
const NS_USER_TALK
Definition: Defines.php:72
SpecialFileDuplicateSearch\__construct
__construct( $name='FileDuplicateSearch')
Definition: SpecialFileDuplicateSearch.php:42
$line
$line
Definition: mcc.php:119
SpecialFileDuplicateSearch\getQueryInfo
getQueryInfo()
Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s...
Definition: SpecialFileDuplicateSearch.php:87
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:706
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1485
SpecialFileDuplicateSearch\isSyndicated
isSyndicated()
Sometime we don't want to build rss / atom feeds.
Definition: SpecialFileDuplicateSearch.php:46
SpecialFileDuplicateSearch\showList
showList( $dupes)
Definition: SpecialFileDuplicateSearch.php:74
File\transform
transform( $params, $flags=0)
Transform a media file.
Definition: File.php:1100
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:912
File\getTitle
getTitle()
Return the associated title object.
Definition: File.php:339
LocalFile\getQueryInfo
static getQueryInfo(array $options=[])
Return the tables, fields, and join conditions to be selected to create a new localfile object.
Definition: LocalFile.php:216
Title
Represents a title within MediaWiki.
Definition: Title.php:42
SpecialFileDuplicateSearch\$file
File $file
selected reference file, if present
Definition: SpecialFileDuplicateSearch.php:40
SpecialFileDuplicateSearch\prefixSearchSubpages
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
Definition: SpecialFileDuplicateSearch.php:244
File\isLocal
isLocal()
Returns true if the file comes from the local file repository.
Definition: File.php:1903
SpecialFileDuplicateSearch\isCacheable
isCacheable()
Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode a...
Definition: SpecialFileDuplicateSearch.php:50
NS_USER
const NS_USER
Definition: Defines.php:71
SpecialFileDuplicateSearch\$hash
$hash
Definition: SpecialFileDuplicateSearch.php:35
$t
$t
Definition: testCompression.php:74
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:69
SpecialFileDuplicateSearch\doBatchLookups
doBatchLookups( $list)
Definition: SpecialFileDuplicateSearch.php:188
HTMLForm\factory
static factory( $displayFormat,... $arguments)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:311
SpecialPage\outputHeader
outputHeader( $summaryMessageKey='')
Outputs a summary message on top of special pages Per default the message key is the canonical name o...
Definition: SpecialPage.php:636