MediaWiki  REL1_31
SpecialFileDuplicateSearch.php
Go to the documentation of this file.
1 <?php
3 
34  protected $hash = '', $filename = '';
35 
39  protected $file = null;
40 
41  function __construct( $name = 'FileDuplicateSearch' ) {
42  parent::__construct( $name );
43  }
44 
45  function isSyndicated() {
46  return false;
47  }
48 
49  function isCacheable() {
50  return false;
51  }
52 
53  public function isCached() {
54  return false;
55  }
56 
57  function linkParameters() {
58  return [ 'filename' => $this->filename ];
59  }
60 
66  function getDupes() {
67  return RepoGroup::singleton()->findBySha1( $this->hash );
68  }
69 
74  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 !== null ? $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 = wfFindFile( $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  'value' => $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->setSubmitProgressive();
135  $htmlForm->setSubmitTextMsg( $this->msg( 'fileduplicatesearch-submit' ) );
136 
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 );
140 
141  if ( $this->file ) {
142  $this->hash = $this->file->getSha1();
143  } elseif ( $this->filename !== '' ) {
144  $out->wrapWikiMsg(
145  "<p class='mw-fileduplicatesearch-noresults'>\n$1\n</p>",
146  [ 'fileduplicatesearch-noresults', wfEscapeWikiText( $this->filename ) ]
147  );
148  }
149 
150  if ( $this->hash != '' ) {
151  # Show a thumbnail of the file
152  $img = $this->file;
153  if ( $img ) {
154  $thumb = $img->transform( [ 'width' => 120, 'height' => 120 ] );
155  if ( $thumb ) {
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() .
163  '</div>' );
164  }
165  }
166 
167  $dupes = $this->getDupes();
168  $numRows = count( $dupes );
169 
170  # Show a short summary
171  if ( $numRows == 1 ) {
172  $out->wrapWikiMsg(
173  "<p class='mw-fileduplicatesearch-result-1'>\n$1\n</p>",
174  [ 'fileduplicatesearch-result-1', wfEscapeWikiText( $this->filename ) ]
175  );
176  } elseif ( $numRows ) {
177  $out->wrapWikiMsg(
178  "<p class='mw-fileduplicatesearch-result-n'>\n$1\n</p>",
179  [ 'fileduplicatesearch-result-n', wfEscapeWikiText( $this->filename ),
180  $this->getLanguage()->formatNum( $numRows - 1 ) ]
181  );
182  }
183 
184  $this->doBatchLookups( $dupes );
185  $this->showList( $dupes );
186  }
187  }
188 
189  function doBatchLookups( $list ) {
190  $batch = new LinkBatch();
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 );
198  }
199  }
200 
201  $batch->execute();
202  }
203 
210  function formatResult( $skin, $result ) {
212 
213  $linkRenderer = $this->getLinkRenderer();
214  $nt = $result->getTitle();
215  $text = $wgContLang->convert( $nt->getText() );
216  $plink = $linkRenderer->makeLink(
217  $nt,
218  $text
219  );
220 
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 );
227  $user .= '</span>';
228  } else {
229  $user = htmlspecialchars( $userText );
230  }
231 
232  $time = htmlspecialchars( $this->getLanguage()->userTimeAndDate(
233  $result->getTimestamp(), $this->getUser() ) );
234 
235  return "$plink . . $user . . $time";
236  }
237 
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
250  return [];
251  }
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 );
257 
258  return array_map( function ( Title $t ) {
259  // Remove namespace in search suggestion
260  return $t->getText();
261  }, $result );
262  }
263 
264  protected function getGroupName() {
265  return 'media';
266  }
267 }
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1795
$user
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a account $user
Definition: hooks.txt:247
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:675
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:273
FileDuplicateSearchPage\isSyndicated
isSyndicated()
Sometime we don't want to build rss / atom feeds.
Definition: SpecialFileDuplicateSearch.php:45
FileDuplicateSearchPage\linkParameters
linkParameters()
If using extra form wheely-dealies, return a set of parameters here as an associative array.
Definition: SpecialFileDuplicateSearch.php:57
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:59
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
FileDuplicateSearchPage
Searches the database for files of the requested hash, comparing this with the 'img_sha1' field in th...
Definition: SpecialFileDuplicateSearch.php:33
$html
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses & $html
Definition: hooks.txt:2013
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:34
FileDuplicateSearchPage\showList
showList( $dupes)
Definition: SpecialFileDuplicateSearch.php:74
Linker\userLink
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:893
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
FileDuplicateSearchPage\$hash
$hash
Definition: SpecialFileDuplicateSearch.php:34
FileDuplicateSearchPage\prefixSearchSubpages
prefixSearchSubpages( $search, $limit, $offset)
Return an array of subpages beginning with $search that this special page will accept.
Definition: SpecialFileDuplicateSearch.php:246
FileDuplicateSearchPage\isCached
isCached()
Whether or not the output of the page in question is retrieved from the database cache.
Definition: SpecialFileDuplicateSearch.php:53
$out
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition: hooks.txt:864
NS_FILE
const NS_FILE
Definition: Defines.php:80
QueryPage\openList
openList( $offset)
Definition: QueryPage.php:740
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:752
FileDuplicateSearchPage\$filename
$filename
Definition: SpecialFileDuplicateSearch.php:34
$result
The index of the header message $result[1]=The index of the body text message $result[2 through n]=Parameters passed to body text message. Please note the header message cannot receive/use parameters. 'ImgAuthModifyHeaders':Executed just before a file is streamed to a user via img_auth.php, allowing headers to be modified beforehand. $title:LinkTarget object & $headers:HTTP headers(name=> value, names are case insensitive). Two headers get special handling:If-Modified-Since(value must be a valid HTTP date) and Range(must be of the form "bytes=(\d*-\d*)") will be honored when streaming the file. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. Return false to stop further processing of the tag $reader:XMLReader object $logInfo:Array of information 'ImportHandlePageXMLTag':When parsing a XML tag in a page. Return false to stop further processing of the tag $reader:XMLReader object & $pageInfo:Array of information 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. Return false to stop further processing of the tag $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. Return false to stop further processing of the tag $reader:XMLReader object 'ImportHandleUnknownUser':When a user doesn 't exist locally, this hook is called to give extensions an opportunity to auto-create it. If the auto-creation is successful, return false. $name:User name 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. Return false to stop further processing of the tag $reader:XMLReader object $revisionInfo:Array of information 'ImportLogInterwikiLink':Hook to change the interwiki link used in log entries and edit summaries for transwiki imports. & $fullInterwikiPrefix:Interwiki prefix, may contain colons. & $pageTitle:String that contains page title. 'ImportSources':Called when reading from the $wgImportSources configuration variable. Can be used to lazy-load the import sources list. & $importSources:The value of $wgImportSources. Modify as necessary. See the comment in DefaultSettings.php for the detail of how to structure this array. 'InfoAction':When building information to display on the action=info page. $context:IContextSource object & $pageInfo:Array of information 'InitializeArticleMaybeRedirect':MediaWiki check to see if title is a redirect. & $title:Title object for the current page & $request:WebRequest & $ignoreRedirect:boolean to skip redirect check & $target:Title/string of redirect target & $article:Article object 'InternalParseBeforeLinks':during Parser 's internalParse method before links but after nowiki/noinclude/includeonly/onlyinclude and other processings. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InternalParseBeforeSanitize':during Parser 's internalParse method just before the parser removes unwanted/dangerous HTML tags and after nowiki/noinclude/includeonly/onlyinclude and other processings. Ideal for syntax-extensions after template/parser function execution which respect nowiki and HTML-comments. & $parser:Parser object & $text:string containing partially parsed text & $stripState:Parser 's internal StripState object 'InterwikiLoadPrefix':When resolving if a given prefix is an interwiki or not. Return true without providing an interwiki to continue interwiki search. $prefix:interwiki prefix we are looking for. & $iwData:output array describing the interwiki with keys iw_url, iw_local, iw_trans and optionally iw_api and iw_wikiid. 'InvalidateEmailComplete':Called after a user 's email has been invalidated successfully. $user:user(object) whose email is being invalidated 'IRCLineURL':When constructing the URL to use in an IRC notification. Callee may modify $url and $query, URL will be constructed as $url . $query & $url:URL to index.php & $query:Query string $rc:RecentChange object that triggered url generation 'IsFileCacheable':Override the result of Article::isFileCacheable()(if true) & $article:article(object) being checked 'IsTrustedProxy':Override the result of IP::isTrustedProxy() & $ip:IP being check & $result:Change this value to override the result of IP::isTrustedProxy() 'IsUploadAllowedFromUrl':Override the result of UploadFromUrl::isAllowedUrl() $url:URL used to upload from & $allowed:Boolean indicating if uploading is allowed for given URL 'isValidEmailAddr':Override the result of Sanitizer::validateEmail(), for instance to return false if the domain name doesn 't match your organization. $addr:The e-mail address entered by the user & $result:Set this and return false to override the internal checks 'isValidPassword':Override the result of User::isValidPassword() $password:The password entered by the user & $result:Set this and return false to override the internal checks $user:User the password is being validated for 'Language::getMessagesFileName':$code:The language code or the language we 're looking for a messages file for & $file:The messages file path, you can override this to change the location. 'LanguageGetMagic':DEPRECATED! Use $magicWords in a file listed in $wgExtensionMessagesFiles instead. Use this to define synonyms of magic words depending of the language & $magicExtensions:associative array of magic words synonyms $lang:language code(string) 'LanguageGetNamespaces':Provide custom ordering for namespaces or remove namespaces. Do not use this hook to add namespaces. Use CanonicalNamespaces for that. & $namespaces:Array of namespaces indexed by their numbers 'LanguageGetSpecialPageAliases':DEPRECATED! Use $specialPageAliases in a file listed in $wgExtensionMessagesFiles instead. Use to define aliases of special pages names depending of the language & $specialPageAliases:associative array of magic words synonyms $lang:language code(string) 'LanguageGetTranslatedLanguageNames':Provide translated language names. & $names:array of language code=> language name $code:language of the preferred translations 'LanguageLinks':Manipulate a page 's language links. This is called in various places to allow extensions to define the effective language links for a page. $title:The page 's Title. & $links:Array with elements of the form "language:title" in the order that they will be output. & $linkFlags:Associative array mapping prefixed links to arrays of flags. Currently unused, but planned to provide support for marking individual language links in the UI, e.g. for featured articles. 'LanguageSelector':Hook to change the language selector available on a page. $out:The output page. $cssClassName:CSS class name of the language selector. 'LinkBegin':DEPRECATED! Use HtmlPageLinkRendererBegin instead. Used when generating internal and interwiki links in Linker::link(), before processing starts. Return false to skip default processing and return $ret. See documentation for Linker::link() for details on the expected meanings of parameters. $skin:the Skin object $target:the Title that the link is pointing to & $html:the contents that the< a > tag should have(raw HTML) $result
Definition: hooks.txt:1993
FileDuplicateSearchPage\formatResult
formatResult( $skin, $result)
Definition: SpecialFileDuplicateSearch.php:210
FileDuplicateSearchPage\doBatchLookups
doBatchLookups( $list)
Definition: SpecialFileDuplicateSearch.php:189
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:34
QueryPage\$offset
int $offset
The offset and limit in use, as passed to the query() function.
Definition: QueryPage.php:39
php
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:37
QueryPage\$limit
int $limit
Definition: QueryPage.php:42
file
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:106
QueryPage\closeList
closeList()
Definition: QueryPage.php:747
FileDuplicateSearchPage\execute
execute( $par)
This is the actual workhorse.
Definition: SpecialFileDuplicateSearch.php:102
wfScript
wfScript( $script='index')
Get the path to a specified script file, respecting file extensions; this is a wrapper around $wgScri...
Definition: GlobalFunctions.php:2890
HTMLForm\factory
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:279
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:527
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:95
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:695
FileDuplicateSearchPage\getQueryInfo
getQueryInfo()
Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s...
Definition: SpecialFileDuplicateSearch.php:87
$line
$line
Definition: cdb.php:59
FileDuplicateSearchPage\getDupes
getDupes()
Fetch dupes from all connected file repositories.
Definition: SpecialFileDuplicateSearch.php:66
NS_USER_TALK
const NS_USER_TALK
Definition: Defines.php:77
Linker\userToolLinks
static userToolLinks( $userId, $userText, $redContribsWhenNoEdits=false, $flags=0, $edits=null)
Generate standard user tool links (talk, contributions, block link, etc.)
Definition: Linker.php:931
FileDuplicateSearchPage\isCacheable
isCacheable()
Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode a...
Definition: SpecialFileDuplicateSearch.php:49
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:1643
FileDuplicateSearchPage\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialFileDuplicateSearch.php:264
wfFindFile
wfFindFile( $title, $options=[])
Find a file.
Definition: GlobalFunctions.php:2853
$skin
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned $skin
Definition: hooks.txt:2011
SpecialPage\getLinkRenderer
getLinkRenderer()
Definition: SpecialPage.php:907
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:243
Title
Represents a title within MediaWiki.
Definition: Title.php:39
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
FileDuplicateSearchPage\__construct
__construct( $name='FileDuplicateSearch')
Definition: SpecialFileDuplicateSearch.php:41
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
NS_USER
const NS_USER
Definition: Defines.php:76
$batch
$batch
Definition: linkcache.txt:23
$t
$t
Definition: testCompression.php:69
FileDuplicateSearchPage\$file
$file
Definition: SpecialFileDuplicateSearch.php:39
SpecialPage\$linkRenderer
MediaWiki Linker LinkRenderer null $linkRenderer
Definition: SpecialPage.php:66
MediaWikiServices
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:25
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:629
$wgContLang
this class mediates it Skin Encapsulates a look and feel for the wiki All of the functions that render HTML and make choices about how to render it are here and are called from various other places when and is meant to be subclassed with other skins that may override some of its functions The User object contains a reference to a and so rather than having a global skin object we just rely on the global User and get the skin with $wgUser and also has some character encoding functions and other locale stuff The current user interface language is instantiated as and the content language as $wgContLang
Definition: design.txt:57
QueryPage\$numRows
$numRows
The number of rows returned by the query.
Definition: QueryPage.php:49