MediaWiki  REL1_31
SpecialLinkSearch.php
Go to the documentation of this file.
1 <?php
27 
32 class LinkSearchPage extends QueryPage {
34  private $mungedQuery = false;
35 
36  function setParams( $params ) {
37  $this->mQuery = $params['query'];
38  $this->mNs = $params['namespace'];
39  $this->mProt = $params['protocol'];
40  }
41 
42  function __construct( $name = 'LinkSearch' ) {
43  parent::__construct( $name );
44 
45  // Since we don't control the constructor parameters, we can't inject services that way.
46  // Instead, we initialize services in the execute() method, and allow them to be overridden
47  // using the setServices() method.
48  }
49 
50  function isCacheable() {
51  return false;
52  }
53 
54  public function execute( $par ) {
55  $this->setHeaders();
56  $this->outputHeader();
57 
58  $out = $this->getOutput();
59  $out->allowClickjacking();
60 
61  $request = $this->getRequest();
62  $target = $request->getVal( 'target', $par );
63  $namespace = $request->getIntOrNull( 'namespace' );
64 
65  $protocols_list = [];
66  foreach ( $this->getConfig()->get( 'UrlProtocols' ) as $prot ) {
67  if ( $prot !== '//' ) {
68  $protocols_list[] = $prot;
69  }
70  }
71 
72  $target2 = $target;
73  // Get protocol, default is http://
74  $protocol = 'http://';
75  $bits = wfParseUrl( $target );
76  if ( isset( $bits['scheme'] ) && isset( $bits['delimiter'] ) ) {
77  $protocol = $bits['scheme'] . $bits['delimiter'];
78  // Make sure wfParseUrl() didn't make some well-intended correction in the
79  // protocol
80  if ( strcasecmp( $protocol, substr( $target, 0, strlen( $protocol ) ) ) === 0 ) {
81  $target2 = substr( $target, strlen( $protocol ) );
82  } else {
83  // If it did, let LinkFilter::makeLikeArray() handle this
84  $protocol = '';
85  }
86  }
87 
88  $out->addWikiMsg(
89  'linksearch-text',
90  '<nowiki>' . $this->getLanguage()->commaList( $protocols_list ) . '</nowiki>',
91  count( $protocols_list )
92  );
93  $fields = [
94  'target' => [
95  'type' => 'text',
96  'name' => 'target',
97  'id' => 'target',
98  'size' => 50,
99  'label-message' => 'linksearch-pat',
100  'default' => $target,
101  'dir' => 'ltr',
102  ]
103  ];
104  if ( !$this->getConfig()->get( 'MiserMode' ) ) {
105  $fields += [
106  'namespace' => [
107  'type' => 'namespaceselect',
108  'name' => 'namespace',
109  'label-message' => 'linksearch-ns',
110  'default' => $namespace,
111  'id' => 'namespace',
112  'all' => '',
113  'cssclass' => 'namespaceselector',
114  ],
115  ];
116  }
117  $hiddenFields = [
118  'title' => $this->getPageTitle()->getPrefixedDBkey(),
119  ];
120  $htmlForm = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
121  $htmlForm->addHiddenFields( $hiddenFields );
122  $htmlForm->setSubmitTextMsg( 'linksearch-ok' );
123  $htmlForm->setWrapperLegendMsg( 'linksearch' );
124  $htmlForm->setAction( wfScript() );
125  $htmlForm->setMethod( 'get' );
126  $htmlForm->prepareForm()->displayForm( false );
127  $this->addHelpLink( 'Help:Linksearch' );
128 
129  if ( $target != '' ) {
130  $this->setParams( [
131  'query' => Parser::normalizeLinkUrl( $target2 ),
132  'namespace' => $namespace,
133  'protocol' => $protocol ] );
134  parent::execute( $par );
135  if ( $this->mungedQuery === false ) {
136  $out->addWikiMsg( 'linksearch-error' );
137  }
138  }
139  }
140 
145  function isSyndicated() {
146  return false;
147  }
148 
157  static function mungeQuery( $query, $prot ) {
158  $field = 'el_index';
159  $dbr = wfGetDB( DB_REPLICA );
160 
161  if ( $query === '*' && $prot !== '' ) {
162  // Allow queries like 'ftp://*' to find all ftp links
163  $rv = [ $prot, $dbr->anyString() ];
164  } else {
165  $rv = LinkFilter::makeLikeArray( $query, $prot );
166  }
167 
168  if ( $rv === false ) {
169  // LinkFilter doesn't handle wildcard in IP, so we'll have to munge here.
170  $pattern = '/^(:?[0-9]{1,3}\.)+\*\s*$|^(:?[0-9]{1,3}\.){3}[0-9]{1,3}:[0-9]*\*\s*$/';
171  if ( preg_match( $pattern, $query ) ) {
172  $rv = [ $prot . rtrim( $query, " \t*" ), $dbr->anyString() ];
173  $field = 'el_to';
174  }
175  }
176 
177  return [ $rv, $field ];
178  }
179 
180  function linkParameters() {
181  $params = [];
182  $params['target'] = $this->mProt . $this->mQuery;
183  if ( $this->mNs !== null && !$this->getConfig()->get( 'MiserMode' ) ) {
184  $params['namespace'] = $this->mNs;
185  }
186 
187  return $params;
188  }
189 
190  public function getQueryInfo() {
191  $dbr = wfGetDB( DB_REPLICA );
192  // strip everything past first wildcard, so that
193  // index-based-only lookup would be done
194  list( $this->mungedQuery, $clause ) = self::mungeQuery( $this->mQuery, $this->mProt );
195  if ( $this->mungedQuery === false ) {
196  // Invalid query; return no results
197  return [ 'tables' => 'page', 'fields' => 'page_id', 'conds' => '0=1' ];
198  }
199 
200  $stripped = LinkFilter::keepOneWildcard( $this->mungedQuery );
201  $like = $dbr->buildLike( $stripped );
202  $retval = [
203  'tables' => [ 'page', 'externallinks' ],
204  'fields' => [
205  'namespace' => 'page_namespace',
206  'title' => 'page_title',
207  'value' => 'el_index',
208  'url' => 'el_to'
209  ],
210  'conds' => [
211  'page_id = el_from',
212  "$clause $like"
213  ],
214  'options' => [ 'USE INDEX' => $clause ]
215  ];
216 
217  if ( $this->mNs !== null && !$this->getConfig()->get( 'MiserMode' ) ) {
218  $retval['conds']['page_namespace'] = $this->mNs;
219  }
220 
221  return $retval;
222  }
223 
230  function preprocessResults( $db, $res ) {
232  }
233 
239  function formatResult( $skin, $result ) {
240  $title = new TitleValue( (int)$result->namespace, $result->title );
241  $pageLink = $this->getLinkRenderer()->makeLink( $title );
242 
243  $url = $result->url;
244  $urlLink = Linker::makeExternalLink( $url, $url );
245 
246  return $this->msg( 'linksearch-line' )->rawParams( $urlLink, $pageLink )->escaped();
247  }
248 
256  function getOrderFields() {
257  return [];
258  }
259 
260  protected function getGroupName() {
261  return 'redirects';
262  }
263 
271  protected function getMaxResults() {
272  return max( parent::getMaxResults(), 60000 );
273  }
274 }
SpecialPage\getPageTitle
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:675
SpecialPage\msg
msg( $key)
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:793
LinkSearchPage\formatResult
formatResult( $skin, $result)
Definition: SpecialLinkSearch.php:239
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
LinkSearchPage\getGroupName
getGroupName()
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialLinkSearch.php:260
SpecialPage\getOutput
getOutput()
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:722
array
the array() calling protocol came about after MediaWiki 1.4rc1.
LinkSearchPage\linkParameters
linkParameters()
If using extra form wheely-dealies, return a set of parameters here as an associative array.
Definition: SpecialLinkSearch.php:180
LinkFilter\keepOneWildcard
static keepOneWildcard( $arr)
Filters an array returned by makeLikeArray(), removing everything past first pattern placeholder.
Definition: LinkFilter.php:178
$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
$params
$params
Definition: styleTest.css.php:40
$res
$res
Definition: database.txt:21
SpecialPage\getLanguage
getLanguage()
Shortcut to get user's language.
Definition: SpecialPage.php:752
$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
LinkSearchPage\isSyndicated
isSyndicated()
Disable RSS/Atom feeds.
Definition: SpecialLinkSearch.php:145
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\executeLBFromResultWrapper
executeLBFromResultWrapper(IResultWrapper $res, $ns=null)
Creates a new LinkBatch object, adds all pages from the passed ResultWrapper (MUST include title and ...
Definition: QueryPage.php:861
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
LinkSearchPage\mungeQuery
static mungeQuery( $query, $prot)
Return an appropriately formatted LIKE query and the clause.
Definition: SpecialLinkSearch.php:157
Wikimedia\Rdbms\IDatabase
Basic database interface for live and lazy-loaded relation database handles.
Definition: IDatabase.php:38
$dbr
$dbr
Definition: testCompression.php:50
SpecialPage\addHelpLink
addHelpLink( $to, $overrideBaseUrl=false)
Adds help link with an icon via page indicators.
Definition: SpecialPage.php:832
wfParseUrl
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:801
SpecialPage\getConfig
getConfig()
Shortcut to get main config object.
Definition: SpecialPage.php:761
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
Wikimedia\Rdbms\IResultWrapper
Result wrapper for grabbing data queried from an IDatabase object.
Definition: IResultWrapper.php:24
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
HTMLForm\factory
static factory( $displayFormat)
Construct a HTMLForm object for given display type.
Definition: HTMLForm.php:279
LinkFilter\makeLikeArray
static makeLikeArray( $filterEntry, $protocol='http://')
Make an array to be used for calls to Database::buildLike(), which will match the specified string.
Definition: LinkFilter.php:95
LinkSearchPage
Special:LinkSearch to search the external-links table.
Definition: SpecialLinkSearch.php:32
LinkSearchPage\getMaxResults
getMaxResults()
enwiki complained about low limits on this special page
Definition: SpecialLinkSearch.php:271
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
Linker\makeExternalLink
static makeExternalLink( $url, $text, $escape=true, $linktype='', $attribs=[], $title=null)
Make an external link.
Definition: Linker.php:843
DB_REPLICA
const DB_REPLICA
Definition: defines.php:25
LinkSearchPage\execute
execute( $par)
This is the actual workhorse.
Definition: SpecialLinkSearch.php:54
list
deferred txt A few of the database updates required by various functions here can be deferred until after the result page is displayed to the user For updating the view updating the linked to tables after a etc PHP does not yet have any way to tell the server to actually return and disconnect while still running these but it might have such a feature in the future We handle these by creating a deferred update object and putting those objects on a global list
Definition: deferred.txt:11
SpecialPage\getContext
getContext()
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:695
execute
$batch execute()
SpecialPage\getRequest
getRequest()
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:712
LinkSearchPage\__construct
__construct( $name='LinkSearch')
Definition: SpecialLinkSearch.php:42
$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
LinkSearchPage\isCacheable
isCacheable()
Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode a...
Definition: SpecialLinkSearch.php:50
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
Parser\normalizeLinkUrl
static normalizeLinkUrl( $url)
Replace unusual escape codes in a URL with their equivalent characters.
Definition: Parser.php:1972
LinkSearchPage\preprocessResults
preprocessResults( $db, $res)
Pre-fill the link cache.
Definition: SpecialLinkSearch.php:230
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
$request
do that in ParserLimitReportFormat instead use this to modify the parameters of the image all existing parser cache entries will be invalid To avoid you ll need to handle that somehow(e.g. with the RejectParserCacheValue hook) because MediaWiki won 't do it for you. & $defaults also a ContextSource after deleting those rows but within the same transaction you ll probably need to make sure the header is varied on $request
Definition: hooks.txt:2806
LinkSearchPage\getQueryInfo
getQueryInfo()
Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s...
Definition: SpecialLinkSearch.php:190
$query
null for the wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1620
LinkSearchPage\getOrderFields
getOrderFields()
Override to squash the ORDER BY.
Definition: SpecialLinkSearch.php:256
LinkSearchPage\setParams
setParams( $params)
Definition: SpecialLinkSearch.php:36
$retval
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 incomplete not yet checked for validity & $retval
Definition: hooks.txt:266
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
LinkSearchPage\$mungedQuery
array bool $mungedQuery
Definition: SpecialLinkSearch.php:34
TitleValue
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:35