MediaWiki  1.23.1
SpecialFileDuplicateSearch.php
Go to the documentation of this file.
1 <?php
32  protected $hash = '', $filename = '';
33 
37  protected $file = null;
38 
39  function __construct( $name = 'FileDuplicateSearch' ) {
40  parent::__construct( $name );
41  }
42 
43  function isSyndicated() {
44  return false;
45  }
46 
47  function isCacheable() {
48  return false;
49  }
50 
51  function isCached() {
52  return false;
53  }
54 
55  function linkParameters() {
56  return array( 'filename' => $this->filename );
57  }
58 
64  function getDupes() {
65  return RepoGroup::singleton()->findBySha1( $this->hash );
66  }
67 
72  function showList( $dupes ) {
73  $html = array();
74  $html[] = $this->openList( 0 );
75 
76  foreach ( $dupes as $dupe ) {
77  $line = $this->formatResult( null, $dupe );
78  $html[] = "<li>" . $line . "</li>";
79  }
80  $html[] = $this->closeList();
81 
82  $this->getOutput()->addHtml( implode( "\n", $html ) );
83  }
84 
85  function getQueryInfo() {
86  return array(
87  'tables' => array( 'image' ),
88  'fields' => array(
89  'title' => 'img_name',
90  'value' => 'img_sha1',
91  'img_user_text',
92  'img_timestamp'
93  ),
94  'conds' => array( 'img_sha1' => $this->hash )
95  );
96  }
97 
98  function execute( $par ) {
99  global $wgScript;
100 
101  $this->setHeaders();
102  $this->outputHeader();
103 
104  $this->filename = isset( $par ) ? $par : $this->getRequest()->getText( 'filename' );
105  $this->file = null;
106  $this->hash = '';
107  $title = Title::newFromText( $this->filename, NS_FILE );
108  if ( $title && $title->getText() != '' ) {
109  $this->file = wfFindFile( $title );
110  }
111 
112  $out = $this->getOutput();
113 
114  # Create the input form
115  $out->addHTML(
117  'form',
118  array( 'id' => 'fileduplicatesearch', 'method' => 'get', 'action' => $wgScript )
119  ) . "\n" .
120  Html::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) . "\n" .
121  Html::openElement( 'fieldset' ) . "\n" .
122  Html::element( 'legend', null, $this->msg( 'fileduplicatesearch-legend' )->text() ) . "\n" .
124  $this->msg( 'fileduplicatesearch-filename' )->text(),
125  'filename',
126  'filename',
127  50,
128  $this->filename
129  ) . "\n" .
130  Xml::submitButton( $this->msg( 'fileduplicatesearch-submit' )->text() ) . "\n" .
131  Html::closeElement( 'fieldset' ) . "\n" .
132  Html::closeElement( 'form' )
133  );
134 
135  if ( $this->file ) {
136  $this->hash = $this->file->getSha1();
137  } elseif ( $this->filename !== '' ) {
138  $out->wrapWikiMsg(
139  "<p class='mw-fileduplicatesearch-noresults'>\n$1\n</p>",
140  array( 'fileduplicatesearch-noresults', wfEscapeWikiText( $this->filename ) )
141  );
142  }
143 
144  if ( $this->hash != '' ) {
145  # Show a thumbnail of the file
146  $img = $this->file;
147  if ( $img ) {
148  $thumb = $img->transform( array( 'width' => 120, 'height' => 120 ) );
149  if ( $thumb ) {
150  $out->addHTML( '<div id="mw-fileduplicatesearch-icon">' .
151  $thumb->toHtml( array( 'desc-link' => false ) ) . '<br />' .
152  $this->msg( 'fileduplicatesearch-info' )->numParams(
153  $img->getWidth(), $img->getHeight() )->params(
154  $this->getLanguage()->formatSize( $img->getSize() ),
155  $img->getMimeType() )->parseAsBlock() .
156  '</div>' );
157  }
158  }
159 
160  $dupes = $this->getDupes();
161  $numRows = count( $dupes );
162 
163  # Show a short summary
164  if ( $numRows == 1 ) {
165  $out->wrapWikiMsg(
166  "<p class='mw-fileduplicatesearch-result-1'>\n$1\n</p>",
167  array( 'fileduplicatesearch-result-1', wfEscapeWikiText( $this->filename ) )
168  );
169  } elseif ( $numRows ) {
170  $out->wrapWikiMsg(
171  "<p class='mw-fileduplicatesearch-result-n'>\n$1\n</p>",
172  array( 'fileduplicatesearch-result-n', wfEscapeWikiText( $this->filename ),
173  $this->getLanguage()->formatNum( $numRows - 1 ) )
174  );
175  }
176 
177  $this->doBatchLookups( $dupes );
178  $this->showList( $dupes );
179  }
180  }
181 
182  function doBatchLookups( $list ) {
183  $batch = new LinkBatch();
185  foreach ( $list as $file ) {
186  $batch->addObj( $file->getTitle() );
187  if ( $file->isLocal() ) {
188  $userName = $file->getUser( 'text' );
189  $batch->add( NS_USER, $userName );
190  $batch->add( NS_USER_TALK, $userName );
191  }
192  }
193 
194  $batch->execute();
195  }
196 
203  function formatResult( $skin, $result ) {
205 
206  $nt = $result->getTitle();
207  $text = $wgContLang->convert( $nt->getText() );
208  $plink = Linker::link(
209  Title::newFromText( $nt->getPrefixedText() ),
210  $text
211  );
212 
213  $userText = $result->getUser( 'text' );
214  if ( $result->isLocal() ) {
215  $userId = $result->getUser( 'id' );
216  $user = Linker::userLink( $userId, $userText );
217  $user .= $this->getContext()->msg( 'word-separator' )->plain();
218  $user .= '<span style="white-space: nowrap;">';
219  $user .= Linker::userToolLinks( $userId, $userText );
220  $user .= '</span>';
221  } else {
222  $user = htmlspecialchars( $userText );
223  }
224 
225  $time = $this->getLanguage()->userTimeAndDate( $result->getTimestamp(), $this->getUser() );
226 
227  return "$plink . . $user . . $time";
228  }
229 
230  protected function getGroupName() {
231  return 'media';
232  }
233 }
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:488
$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. 'ImportHandleLogItemXMLTag':When parsing a XML tag in a log item. $reader:XMLReader object $logInfo:Array of information Return false to stop further processing of the tag 'ImportHandlePageXMLTag':When parsing a XML tag in a page. $reader:XMLReader object $pageInfo:Array of information Return false to stop further processing of the tag 'ImportHandleRevisionXMLTag':When parsing a XML tag in a page revision. $reader:XMLReader object $pageInfo:Array of page information $revisionInfo:Array of revision information Return false to stop further processing of the tag 'ImportHandleToplevelXMLTag':When parsing a top level XML tag. $reader:XMLReader object Return false to stop further processing of the tag 'ImportHandleUploadXMLTag':When parsing a XML tag in a file upload. $reader:XMLReader object $revisionInfo:Array of information Return false to stop further processing of the tag '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 '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. '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 '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 '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 wfIsTrustedProxy() $ip:IP being check $result:Change this value to override the result of wfIsTrustedProxy() '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 User::isValidEmailAddr(), 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. '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 '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) '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:Associative array mapping language codes to prefixed links of the form "language:title". & $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. 'LinkBegin':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:1528
$time
see documentation in includes Linker php for Linker::makeImageLink & $time
Definition: hooks.txt:1358
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:189
FileDuplicateSearchPage\isSyndicated
isSyndicated()
Sometime we don't want to build rss / atom feeds.
Definition: SpecialFileDuplicateSearch.php:42
FileDuplicateSearchPage\linkParameters
linkParameters()
If using extra form wheely-dealies, return a set of parameters here as an associative array.
Definition: SpecialFileDuplicateSearch.php:54
RepoGroup\singleton
static singleton()
Get a RepoGroup instance.
Definition: RepoGroup.php:53
php
skin txt MediaWiki includes four core it has been set as the default in MediaWiki since the replacing Monobook it had been been the default skin since before being replaced by Vector largely rewritten in while keeping its appearance Several legacy skins were removed in the as the burden of supporting them became too heavy to bear Those in etc for skin dependent CSS etc for skin dependent JavaScript These can also be customised on a per user by etc This feature has led to a wide variety of user styles becoming that gallery is a good place to ending in php
Definition: skin.txt:62
FileDuplicateSearchPage
Searches the database for files of the requested hash, comparing this with the 'img_sha1' field in th...
Definition: SpecialFileDuplicateSearch.php:31
$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:1530
LinkBatch
Class representing a list of titles The execute() method checks them all for existence and adds them ...
Definition: LinkBatch.php:30
FileDuplicateSearchPage\showList
showList( $dupes)
Definition: SpecialFileDuplicateSearch.php:71
Linker\userLink
static userLink( $userId, $userName, $altUserName=false)
Make user link (or user contributions for unregistered users)
Definition: Linker.php:1072
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:535
FileDuplicateSearchPage\$hash
$hash
Definition: SpecialFileDuplicateSearch.php:32
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:12
FileDuplicateSearchPage\isCached
isCached()
Whether or not the output of the page in question is retrieved from the database cache.
Definition: SpecialFileDuplicateSearch.php:50
File\getUser
getUser( $type='text')
Returns ID or name of user who uploaded the file STUB.
Definition: File.php:448
NS_FILE
const NS_FILE
Definition: Defines.php:85
QueryPage\openList
openList( $offset)
Definition: QueryPage.php:652
Html\hidden
static hidden( $name, $value, $attribs=array())
Convenience function to produce an input element with type=hidden.
Definition: Html.php:662
$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:56
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:578
FileDuplicateSearchPage\$filename
$filename
Definition: SpecialFileDuplicateSearch.php:32
FileDuplicateSearchPage\formatResult
formatResult( $skin, $result)
Definition: SpecialFileDuplicateSearch.php:202
ContextSource\getTitle
getTitle()
Get the Title object.
Definition: ContextSource.php:87
FileDuplicateSearchPage\doBatchLookups
doBatchLookups( $list)
Definition: SpecialFileDuplicateSearch.php:181
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:30
Linker\link
static link( $target, $html=null, $customAttribs=array(), $query=array(), $options=array())
This function returns an HTML link to the given target.
Definition: Linker.php:192
Html\closeElement
static closeElement( $element)
Returns "</$element>", except if $wgWellFormedXml is off, in which case it returns the empty string w...
Definition: Html.php:235
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:93
QueryPage\closeList
closeList()
Definition: QueryPage.php:659
Html\openElement
static openElement( $element, $attribs=array())
Identical to rawElement(), but has no third parameter and omits the end tag (and the self-closing '/'...
Definition: Html.php:166
File
Implements some public methods and some protected utility functions which are required by multiple ch...
Definition: File.php:50
$out
$out
Definition: UtfNormalGenerate.php:167
FileDuplicateSearchPage\execute
execute( $par)
This is the actual workhorse.
Definition: SpecialFileDuplicateSearch.php:97
Html\element
static element( $element, $attribs=array(), $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:148
array
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
SpecialPage\setHeaders
setHeaders()
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:352
SpecialPage\getUser
getUser()
Shortcut to get the User executing this instance.
Definition: SpecialPage.php:545
Xml\inputLabel
static inputLabel( $label, $name, $id, $size=false, $value=false, $attribs=array())
Convenience function to build an HTML text input field with a label.
Definition: Xml.php:398
global
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:508
FileDuplicateSearchPage\getQueryInfo
getQueryInfo()
Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s...
Definition: SpecialFileDuplicateSearch.php:84
$line
$line
Definition: cdb.php:57
FileDuplicateSearchPage\getDupes
getDupes()
Fetch dupes from all connected file repositories.
Definition: SpecialFileDuplicateSearch.php:63
$title
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
NS_USER_TALK
const NS_USER_TALK
Definition: Defines.php:82
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
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:1100
SpecialPage\msg
msg()
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:609
FileDuplicateSearchPage\isCacheable
isCacheable()
Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode a...
Definition: SpecialFileDuplicateSearch.php:46
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:525
wfEscapeWikiText
wfEscapeWikiText( $text)
Escapes the given text so that it may be output using addWikiText() without any linking,...
Definition: GlobalFunctions.php:2077
FileDuplicateSearchPage\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialFileDuplicateSearch.php:229
$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:237
$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:1530
File\transform
transform( $params, $flags=0)
Transform a media file.
Definition: File.php:929
File\getTitle
getTitle()
Return the associated title object.
Definition: File.php:302
FileDuplicateSearchPage\$file
File $file
$file selected reference file, if present
Definition: SpecialFileDuplicateSearch.php:36
FileDuplicateSearchPage\__construct
__construct( $name='FileDuplicateSearch')
Definition: SpecialFileDuplicateSearch.php:38
File\isLocal
isLocal()
Returns true if the file comes from the local file repository.
Definition: File.php:1548
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:9
wfFindFile
wfFindFile( $title, $options=array())
Find a file.
Definition: GlobalFunctions.php:3693
NS_USER
const NS_USER
Definition: Defines.php:81
$batch
$batch
Definition: linkcache.txt:23
Xml\submitButton
static submitButton( $value, $attribs=array())
Convenience function to build an HTML submit button.
Definition: Xml.php:463
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:443
QueryPage\$numRows
$numRows
The number of rows returned by the query.
Definition: QueryPage.php:49