MediaWiki  1.23.8
Go to the documentation of this file.
1 <?php
29 class LinkSearchPage extends QueryPage {
34  protected $linkRenderer = null;
36  function setParams( $params ) {
37  $this->mQuery = $params['query'];
38  $this->mNs = $params['namespace'];
39  $this->mProt = $params['protocol'];
40  }
42  function __construct( $name = 'LinkSearch' ) {
43  parent::__construct( $name );
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  }
58  public function setPageLinkRenderer(
60  ) {
61  $this->linkRenderer = $linkRenderer;
62  }
68  private function initServices() {
69  if ( !$this->linkRenderer ) {
70  $lang = $this->getContext()->getLanguage();
71  $titleFormatter = new MediaWikiTitleCodec( $lang, GenderCache::singleton() );
72  $this->linkRenderer = new MediaWikiPageLinkRenderer( $titleFormatter );
73  }
74  }
76  function isCacheable() {
77  return false;
78  }
80  function execute( $par ) {
81  global $wgUrlProtocols, $wgMiserMode, $wgScript;
83  $this->initServices();
85  $this->setHeaders();
86  $this->outputHeader();
88  $out = $this->getOutput();
89  $out->allowClickjacking();
91  $request = $this->getRequest();
92  $target = $request->getVal( 'target', $par );
93  $namespace = $request->getIntorNull( 'namespace', null );
95  $protocols_list = array();
96  foreach ( $wgUrlProtocols as $prot ) {
97  if ( $prot !== '//' ) {
98  $protocols_list[] = $prot;
99  }
100  }
102  $target2 = $target;
103  // Get protocol, default is http://
104  $protocol = 'http://';
105  $bits = wfParseUrl( $target );
106  if ( isset( $bits['scheme'] ) && isset( $bits['delimiter'] ) ) {
107  $protocol = $bits['scheme'] . $bits['delimiter'];
108  // Make sure wfParseUrl() didn't make some well-intended correction in the
109  // protocol
110  if ( strcasecmp( $protocol, substr( $target, 0, strlen( $protocol ) ) ) === 0 ) {
111  $target2 = substr( $target, strlen( $protocol ) );
112  } else {
113  // If it did, let LinkFilter::makeLikeArray() handle this
114  $protocol = '';
115  }
116  }
118  $out->addWikiMsg(
119  'linksearch-text',
120  '<nowiki>' . $this->getLanguage()->commaList( $protocols_list ) . '</nowiki>',
121  count( $protocols_list )
122  );
124  'form',
125  array( 'id' => 'mw-linksearch-form', 'method' => 'get', 'action' => $wgScript )
126  ) . "\n" .
127  Html::hidden( 'title', $this->getPageTitle()->getPrefixedDBkey() ) . "\n" .
128  Html::openElement( 'fieldset' ) . "\n" .
129  Html::element( 'legend', array(), $this->msg( 'linksearch' )->text() ) . "\n" .
131  $this->msg( 'linksearch-pat' )->text(),
132  'target',
133  'target',
134  50,
135  $target
136  ) . "\n";
138  if ( !$wgMiserMode ) {
140  array(
141  'selected' => $namespace,
142  'all' => '',
143  'label' => $this->msg( 'linksearch-ns' )->text()
144  ), array(
145  'name' => 'namespace',
146  'id' => 'namespace',
147  'class' => 'namespaceselector',
148  )
149  );
150  }
152  $s .= Xml::submitButton( $this->msg( 'linksearch-ok' )->text() ) . "\n" .
153  Html::closeElement( 'fieldset' ) . "\n" .
154  Html::closeElement( 'form' ) . "\n";
155  $out->addHTML( $s );
157  if ( $target != '' ) {
158  $this->setParams( array(
159  'query' => $target2,
160  'namespace' => $namespace,
161  'protocol' => $protocol ) );
162  parent::execute( $par );
163  if ( $this->mMungedQuery === false ) {
164  $out->addWikiMsg( 'linksearch-error' );
165  }
166  }
167  }
173  function isSyndicated() {
174  return false;
175  }
185  static function mungeQuery( $query, $prot ) {
186  $field = 'el_index';
187  $dbr = wfGetDB( DB_SLAVE );
189  if ( $query === '*' && $prot !== '' ) {
190  // Allow queries like 'ftp://*' to find all ftp links
191  $rv = array( $prot, $dbr->anyString() );
192  } else {
193  $rv = LinkFilter::makeLikeArray( $query, $prot );
194  }
196  if ( $rv === false ) {
197  // LinkFilter doesn't handle wildcard in IP, so we'll have to munge here.
198  $pattern = '/^(:?[0-9]{1,3}\.)+\*\s*$|^(:?[0-9]{1,3}\.){3}[0-9]{1,3}:[0-9]*\*\s*$/';
199  if ( preg_match( $pattern, $query ) ) {
200  $rv = array( $prot . rtrim( $query, " \t*" ), $dbr->anyString() );
201  $field = 'el_to';
202  }
203  }
205  return array( $rv, $field );
206  }
208  function linkParameters() {
209  global $wgMiserMode;
210  $params = array();
211  $params['target'] = $this->mProt . $this->mQuery;
212  if ( isset( $this->mNs ) && !$wgMiserMode ) {
213  $params['namespace'] = $this->mNs;
214  }
216  return $params;
217  }
219  function getQueryInfo() {
220  global $wgMiserMode;
221  $dbr = wfGetDB( DB_SLAVE );
222  // strip everything past first wildcard, so that
223  // index-based-only lookup would be done
224  list( $this->mMungedQuery, $clause ) = self::mungeQuery( $this->mQuery, $this->mProt );
225  if ( $this->mMungedQuery === false ) {
226  // Invalid query; return no results
227  return array( 'tables' => 'page', 'fields' => 'page_id', 'conds' => '0=1' );
228  }
230  $stripped = LinkFilter::keepOneWildcard( $this->mMungedQuery );
231  $like = $dbr->buildLike( $stripped );
232  $retval = array(
233  'tables' => array( 'page', 'externallinks' ),
234  'fields' => array(
235  'namespace' => 'page_namespace',
236  'title' => 'page_title',
237  'value' => 'el_index',
238  'url' => 'el_to'
239  ),
240  'conds' => array(
241  'page_id = el_from',
242  "$clause $like"
243  ),
244  'options' => array( 'USE INDEX' => $clause )
245  );
247  if ( isset( $this->mNs ) && !$wgMiserMode ) {
248  $retval['conds']['page_namespace'] = $this->mNs;
249  }
251  return $retval;
252  }
259  function formatResult( $skin, $result ) {
260  $title = new TitleValue( (int)$result->namespace, $result->title );
261  $pageLink = $this->linkRenderer->renderHtmlLink( $title );
263  $url = $result->url;
264  $urlLink = Linker::makeExternalLink( $url, $url );
266  return $this->msg( 'linksearch-line' )->rawParams( $urlLink, $pageLink )->escaped();
267  }
275  function doQuery( $offset = false, $limit = false ) {
276  list( $this->mMungedQuery, ) = LinkSearchPage::mungeQuery( $this->mQuery, $this->mProt );
277  if ( $this->mMungedQuery === false ) {
278  $this->getOutput()->addWikiMsg( 'linksearch-error' );
279  } else {
280  // For debugging
281  // Generates invalid xhtml with patterns that contain --
282  //$this->getOutput()->addHTML( "\n<!-- " . htmlspecialchars( $this->mMungedQuery ) . " -->\n" );
283  parent::doQuery( $offset, $limit );
284  }
285  }
294  function getOrderFields() {
295  return array();
296  }
298  protected function getGroupName() {
299  return 'redirects';
300  }
301 }
static singleton()
Definition: GenderCache.php:39
getPageTitle( $subpage=false)
Get a self-referential title object.
Definition: SpecialPage.php:488
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
A codec for MediaWiki page titles.
Definition: MediaWikiTitleCodec.php:35
formatResult( $skin, $result)
Definition: SpecialLinkSearch.php:258
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
Under which header this special page is listed in Special:SpecialPages See messages 'specialpages-gro...
Definition: SpecialLinkSearch.php:297
Get the OutputPage being used for this instance.
Definition: SpecialPage.php:535
& wfGetDB( $db, $groups=array(), $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:3659
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
If using extra form wheely-dealies, return a set of parameters here as an associative array.
Definition: SpecialLinkSearch.php:207
PageLinkRenderer $linkRenderer
Definition: SpecialLinkSearch.php:33
static keepOneWildcard( $arr)
Filters an array returned by makeLikeArray(), removing everything past first pattern placeholder.
Definition: LinkFilter.php:177
Definition: styleTest.css.php:40
Initialize any services we'll need (unless it has already been provided via a setter).
Definition: SpecialLinkSearch.php:67
Definition: mergeMessageFileList.php:156
static hidden( $name, $value, $attribs=array())
Convenience function to produce an input element with type=hidden.
Definition: Html.php:662
Shortcut to get user's language.
Definition: SpecialPage.php:578
Disable RSS/Atom feeds.
Definition: SpecialLinkSearch.php:172
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
static makeExternalLink( $url, $text, $escape=true, $linktype='', $attribs=array(), $title=null)
Make an external link.
Definition: Linker.php:1034
int $offset
The offset and limit in use, as passed to the query() function.
Definition: QueryPage.php:41
static mungeQuery( $query, $prot)
Return an appropriately formatted LIKE query and the clause.
Definition: SpecialLinkSearch.php:184
Definition: testCompression.php:48
static closeElement( $element)
Returns "</$element>", except if $wgWellFormedXml is off, in which case it returns the empty string w...
Definition: Html.php:235
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
wfParseUrl( $url)
parse_url() work-alike, but non-broken.
Definition: GlobalFunctions.php:755
Definition: UtfNormalGenerate.php:167
static element( $element, $attribs=array(), $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:148
Represents a link rendering service for MediaWiki.
Definition: PageLinkRenderer.php:33
static makeLikeArray( $filterEntry, $protocol='http://')
Make an array to be used for calls to DatabaseBase::buildLike(), which will match the specified strin...
Definition: LinkFilter.php:94
Special:LinkSearch to search the external-links table.
Definition: SpecialLinkSearch.php:29
the array() calling protocol came about after MediaWiki 1.4rc1.
List of Api Query prop modules.
Sets headers - this should be called from the execute() method of all derived classes!
Definition: SpecialPage.php:352
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
when a variable name is used in a it is silently declared as a new masking the global
Definition: design.txt:93
execute( $par)
This is the actual workhorse.
Definition: SpecialLinkSearch.php:79
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
Gets the context this SpecialPage is executed in.
Definition: SpecialPage.php:508
$batch execute()
presenting them properly to the user as errors is done by the caller $title
Definition: hooks.txt:1324
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:336
Wrapper around wfMessage that sets the current context.
Definition: SpecialPage.php:609
setPageLinkRenderer(PageLinkRenderer $linkRenderer)
Initialize or override the PageLinkRenderer LinkSearchPage collaborates with.
Definition: SpecialLinkSearch.php:57
Get the WebRequest being used for this instance.
Definition: SpecialPage.php:525
__construct( $name='LinkSearch')
Definition: SpecialLinkSearch.php:41
Definition: QueryPage.php:42
doQuery( $offset=false, $limit=false)
Override to check query validity.
Definition: SpecialLinkSearch.php:274
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
Is the output of this query cacheable? Non-cacheable expensive pages will be disabled in miser mode a...
Definition: SpecialLinkSearch.php:75
const DB_SLAVE
Definition: Defines.php:55
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
static namespaceSelector(array $params=array(), array $selectAttribs=array())
Build a drop-down box for selecting a namespace.
Definition: Html.php:707
static submitButton( $value, $attribs=array())
Convenience function to build an HTML submit button.
Definition: Xml.php:463
Subclasses return an SQL query here, formatted as an array with the following keys: tables => Table(s...
Definition: SpecialLinkSearch.php:218
return true to allow those checks to and false if checking is done use this to change the tables headers temp or archived zone change it to an object instance and return false override the list derivative used the name of the old file when set the default code will be skipped add a value to it if you want to add a cookie that have to vary cache options can modify $query
Definition: hooks.txt:1105
Override to squash the ORDER BY.
Definition: SpecialLinkSearch.php:293
setParams( $params)
Definition: SpecialLinkSearch.php:35
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:237
A service for generating links from page titles.
Definition: MediaWikiPageLinkRenderer.php:30
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
Represents a page (or page fragment) title within MediaWiki.
Definition: TitleValue.php:36