MediaWiki REL1_37
SpecialFileDuplicateSearch Class Reference

Searches the database for files of the requested hash, comparing this with the 'img_sha1' field in the image table. More...

Inheritance diagram for SpecialFileDuplicateSearch:
Collaboration diagram for SpecialFileDuplicateSearch:

Public Member Functions

 __construct (LinkBatchFactory $linkBatchFactory, RepoGroup $repoGroup, SearchEngineFactory $searchEngineFactory, LanguageConverterFactory $languageConverterFactory)
 
 execute ( $par)
 Default execute method Checks user permissions.
 
 prefixSearchSubpages ( $search, $limit, $offset)
 Return an array of subpages beginning with $search that this special page will accept.
 
- Public Member Functions inherited from SpecialPage
 __construct ( $name='', $restriction='', $listed=true, $function=false, $file='', $includable=false)
 Default constructor for special pages Derivative classes should call this from their constructor Note that if the user does not have the required level, an error message will be displayed by the default execute() method, without the global function ever being called.
 
 addHelpLink ( $to, $overrideBaseUrl=false)
 Adds help link with an icon via page indicators.
 
 checkPermissions ()
 Checks if userCanExecute, and if not throws a PermissionsError.
 
 checkReadOnly ()
 If the wiki is currently in readonly mode, throws a ReadOnlyError.
 
 doesWrites ()
 Indicates whether this special page may perform database writes.
 
 getAuthority ()
 Shortcut to get the Authority executing this instance.
 
 getConfig ()
 Shortcut to get main config object.
 
 getContentLanguage ()
 Shortcut to get content language.
 
 getContext ()
 Gets the context this SpecialPage is executed in.
 
 getDescription ()
 Returns the name that goes in the \<h1\> in the special page itself, and also the name that will be listed in Special:Specialpages.
 
 getFinalGroupName ()
 Get the group that the special page belongs in on Special:SpecialPage Use this method, instead of getGroupName to allow customization of the group name from the wiki side.
 
 getFullTitle ()
 Return the full title, including $par.
 
 getLanguage ()
 Shortcut to get user's language.
 
 getLinkRenderer ()
 
 getLocalName ()
 Get the localised name of the special page.
 
 getName ()
 Get the name of this Special Page.
 
 getOutput ()
 Get the OutputPage being used for this instance.
 
 getPageTitle ( $subpage=false)
 Get a self-referential title object.
 
 getRequest ()
 Get the WebRequest being used for this instance.
 
 getRestriction ()
 Get the permission that a user must have to execute this page.
 
 getSkin ()
 Shortcut to get the skin being used for this instance.
 
 getUser ()
 Shortcut to get the User executing this instance.
 
 including ( $x=null)
 Whether the special page is being evaluated via transclusion.
 
 isCached ()
 Is this page cached? Expensive pages are cached or disabled in miser mode.
 
 isExpensive ()
 Is this page expensive (for some definition of expensive)? Expensive pages are disabled or cached in miser mode.
 
 isIncludable ()
 Whether it's allowed to transclude the special page via {{Special:Foo/params}}.
 
 isListed ()
 Whether this special page is listed in Special:SpecialPages.
 
 isRestricted ()
 Can be overridden by subclasses with more complicated permissions schemes.
 
 listed ( $x=null)
 Get or set whether this special page is listed in Special:SpecialPages.
 
 maxIncludeCacheTime ()
 How long to cache page when it is being included.
 
 msg ( $key,... $params)
 Wrapper around wfMessage that sets the current context.
 
 requireLogin ( $reasonMsg='exception-nologin-text', $titleMsg='exception-nologin')
 If the user is not logged in, throws UserNotLoggedIn error.
 
 run ( $subPage)
 Entry point.
 
 setContentLanguage (Language $contentLanguage)
 Set content language.
 
 setContext ( $context)
 Sets the context this SpecialPage is executed in.
 
 setHookContainer (HookContainer $hookContainer)
 
 setLinkRenderer (LinkRenderer $linkRenderer)
 
 setListed ( $listed)
 Set whether this page is listed in Special:Specialpages, at run-time.
 
 setSpecialPageFactory (SpecialPageFactory $specialPageFactory)
 
 userCanExecute (User $user)
 Checks if the given user (identified by an object) can execute this special page (as defined by $mRestriction).
 

Protected Member Functions

 getGroupName ()
 Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.
 
- Protected Member Functions inherited from SpecialPage
 addFeedLinks ( $params)
 Adds RSS/atom links.
 
 afterExecute ( $subPage)
 Gets called after.
 
 beforeExecute ( $subPage)
 Gets called before.
 
 buildPrevNextNavigation ( $offset, $limit, array $query=[], $atend=false, $subpage=false)
 Generate (prev x| next x) (20|50|100...) type links for paging.
 
 checkLoginSecurityLevel ( $level=null)
 Verifies that the user meets the security level, possibly reauthenticating them in the process.
 
 displayRestrictionError ()
 Output an error message telling the user what access level they have to have.
 
 getAuthManager ()
 
 getCacheTTL ()
 
 getHookContainer ()
 
 getHookRunner ()
 
 getLanguageConverter ()
 Shortcut to get language's converter.
 
 getLoginSecurityLevel ()
 Tells if the special page does something security-sensitive and needs extra defense against a stolen account (e.g.
 
 getRobotPolicy ()
 Return the robot policy.
 
 getSpecialPageFactory ()
 
 getSubpagesForPrefixSearch ()
 Return an array of subpages that this special page will accept for prefix searches.
 
 outputHeader ( $summaryMessageKey='')
 Outputs a summary message on top of special pages Per default the message key is the canonical name of the special page May be overridden, i.e.
 
 prefixSearchString ( $search, $limit, $offset, SearchEngineFactory $searchEngineFactory=null)
 Perform a regular substring search for prefixSearchSubpages.
 
 setAuthManager (AuthManager $authManager)
 Set the injected AuthManager from the special page constructor.
 
 setHeaders ()
 Sets headers - this should be called from the execute() method of all derived classes!
 
 setReauthPostData (array $data)
 Record preserved POST data after a reauthentication.
 
 useTransactionalTimeLimit ()
 Call wfTransactionalTimeLimit() if this request was POSTed.
 

Private Member Functions

 doBatchLookups ( $list)
 
 formatResult ( $result)
 
 getDupes ()
 Fetch dupes from all connected file repositories.
 
 showList ( $dupes)
 

Private Attributes

File $file = null
 selected reference file, if present
 
string $filename = ''
 The form input filename.
 
string $hash = ''
 The form input hash.
 
ILanguageConverter $languageConverter
 
LinkBatchFactory $linkBatchFactory
 
RepoGroup $repoGroup
 
SearchEngineFactory $searchEngineFactory
 

Additional Inherited Members

- Static Public Member Functions inherited from SpecialPage
static getSafeTitleFor ( $name, $subpage=false)
 Get a localised Title object for a page name with a possibly unvalidated subpage.
 
static getTitleFor ( $name, $subpage=false, $fragment='')
 Get a localised Title object for a specified special page name If you don't need a full Title object, consider using TitleValue through getTitleValueFor() below.
 
static getTitleValueFor ( $name, $subpage=false, $fragment='')
 Get a localised TitleValue object for a specified special page name.
 
- Static Protected Member Functions inherited from SpecialPage
static prefixSearchArray ( $search, $limit, array $subpages, $offset)
 Helper function for implementations of prefixSearchSubpages() that filter the values in memory (as opposed to making a query).
 
- Protected Attributes inherited from SpecialPage
IContextSource $mContext
 Current request context.
 
bool $mIncludable
 Whether the special page can be included in an article.
 
bool $mIncluding
 Whether or not this special page is being included from an article.
 
string $mName
 The canonical name of this special page Also used for the default.
 
string $mRestriction
 Minimum user level required to access this page, or "" for anyone.
 

Detailed Description

Searches the database for files of the requested hash, comparing this with the 'img_sha1' field in the image table.

Definition at line 35 of file SpecialFileDuplicateSearch.php.

Constructor & Destructor Documentation

◆ __construct()

SpecialFileDuplicateSearch::__construct ( LinkBatchFactory  $linkBatchFactory,
RepoGroup  $repoGroup,
SearchEngineFactory  $searchEngineFactory,
LanguageConverterFactory  $languageConverterFactory 
)
Parameters
LinkBatchFactory$linkBatchFactory
RepoGroup$repoGroup
SearchEngineFactory$searchEngineFactory
LanguageConverterFactory$languageConverterFactory

Definition at line 69 of file SpecialFileDuplicateSearch.php.

References $linkBatchFactory, $repoGroup, $searchEngineFactory, SpecialPage\getContentLanguage(), and MediaWiki\Languages\LanguageConverterFactory\getLanguageConverter().

Member Function Documentation

◆ doBatchLookups()

SpecialFileDuplicateSearch::doBatchLookups (   $list)
private

◆ execute()

SpecialFileDuplicateSearch::execute (   $subPage)

Default execute method Checks user permissions.

This must be overridden by subclasses; it will be made abstract in a future version

Stability: stable
to override
Parameters
string | null$subPage

Reimplemented from SpecialPage.

Definition at line 107 of file SpecialFileDuplicateSearch.php.

References $file, $filename, $title, doBatchLookups(), SpecialPage\getContext(), getDupes(), SpecialPage\getLanguage(), SpecialPage\getOutput(), SpecialPage\getPageTitle(), SpecialPage\getRequest(), SpecialPage\msg(), NS_FILE, SpecialPage\outputHeader(), SpecialPage\setHeaders(), showList(), File\transform(), wfEscapeWikiText(), and wfScript().

◆ formatResult()

SpecialFileDuplicateSearch::formatResult (   $result)
private

◆ getDupes()

SpecialFileDuplicateSearch::getDupes ( )
private

Fetch dupes from all connected file repositories.

Returns
File[]

Definition at line 87 of file SpecialFileDuplicateSearch.php.

Referenced by execute().

◆ getGroupName()

SpecialFileDuplicateSearch::getGroupName ( )
protected

Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-group-*' for valid names This method defaults to group 'other'.

Stability: stable
to override
Returns
string
Since
1.21

Reimplemented from SpecialPage.

Definition at line 270 of file SpecialFileDuplicateSearch.php.

◆ prefixSearchSubpages()

SpecialFileDuplicateSearch::prefixSearchSubpages (   $search,
  $limit,
  $offset 
)

Return an array of subpages beginning with $search that this special page will accept.

Parameters
string$searchPrefix to search for
int$limitMaximum number of results to return (usually 10)
int$offsetNumber of results to skip (usually 0)
Returns
string[] Matching subpages

Reimplemented from SpecialPage.

Definition at line 252 of file SpecialFileDuplicateSearch.php.

References $t, $title, and NS_FILE.

◆ showList()

SpecialFileDuplicateSearch::showList (   $dupes)
private
Parameters
File[]$dupes

Definition at line 94 of file SpecialFileDuplicateSearch.php.

References $line, formatResult(), and SpecialPage\getOutput().

Referenced by execute().

Member Data Documentation

◆ $file

File SpecialFileDuplicateSearch::$file = null
private

selected reference file, if present

Definition at line 49 of file SpecialFileDuplicateSearch.php.

Referenced by doBatchLookups(), and execute().

◆ $filename

string SpecialFileDuplicateSearch::$filename = ''
private

The form input filename.

Definition at line 44 of file SpecialFileDuplicateSearch.php.

Referenced by execute().

◆ $hash

string SpecialFileDuplicateSearch::$hash = ''
private

The form input hash.

Definition at line 39 of file SpecialFileDuplicateSearch.php.

◆ $languageConverter

ILanguageConverter SpecialFileDuplicateSearch::$languageConverter
private

Definition at line 61 of file SpecialFileDuplicateSearch.php.

◆ $linkBatchFactory

LinkBatchFactory SpecialFileDuplicateSearch::$linkBatchFactory
private

Definition at line 52 of file SpecialFileDuplicateSearch.php.

Referenced by __construct().

◆ $repoGroup

RepoGroup SpecialFileDuplicateSearch::$repoGroup
private

Definition at line 55 of file SpecialFileDuplicateSearch.php.

Referenced by __construct().

◆ $searchEngineFactory

SearchEngineFactory SpecialFileDuplicateSearch::$searchEngineFactory
private

Definition at line 58 of file SpecialFileDuplicateSearch.php.

Referenced by __construct().


The documentation for this class was generated from the following file: