3 * Implements Special:LinkSearch
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
22 * @author Brion Vibber
26 * Special:LinkSearch to search the external-links table.
27 * @ingroup SpecialPage
29 class LinkSearchPage
extends QueryPage
{
30 function setParams( $params ) {
31 $this->mQuery
= $params['query'];
32 $this->mNs
= $params['namespace'];
33 $this->mProt
= $params['protocol'];
36 function __construct( $name = 'LinkSearch' ) {
37 parent
::__construct( $name );
40 function isCacheable() {
44 function execute( $par ) {
45 global $wgUrlProtocols, $wgMiserMode, $wgScript;
48 $this->outputHeader();
50 $out = $this->getOutput();
51 $out->allowClickjacking();
53 $request = $this->getRequest();
54 $target = $request->getVal( 'target', $par );
55 $namespace = $request->getIntorNull( 'namespace', null );
57 $protocols_list = array();
58 foreach ( $wgUrlProtocols as $prot ) {
59 if ( $prot !== '//' ) {
60 $protocols_list[] = $prot;
65 // Get protocol, default is http://
66 $protocol = 'http://';
67 $bits = wfParseUrl( $target );
68 if ( isset( $bits['scheme'] ) && isset( $bits['delimiter'] ) ) {
69 $protocol = $bits['scheme'] . $bits['delimiter'];
70 // Make sure wfParseUrl() didn't make some well-intended correction in the
72 if ( strcasecmp( $protocol, substr( $target, 0, strlen( $protocol ) ) ) === 0 ) {
73 $target2 = substr( $target, strlen( $protocol ) );
75 // If it did, let LinkFilter::makeLikeArray() handle this
82 '<nowiki>' . $this->getLanguage()->commaList( $protocols_list ) . '</nowiki>',
83 count( $protocols_list )
85 $s = Html
::openElement(
87 array( 'id' => 'mw-linksearch-form', 'method' => 'get', 'action' => $wgScript )
89 Html
::hidden( 'title', $this->getTitle()->getPrefixedDBkey() ) . "\n" .
90 Html
::openElement( 'fieldset' ) . "\n" .
91 Html
::element( 'legend', array(), $this->msg( 'linksearch' )->text() ) . "\n" .
93 $this->msg( 'linksearch-pat' )->text(),
100 if ( !$wgMiserMode ) {
101 $s .= Html
::namespaceSelector(
103 'selected' => $namespace,
105 'label' => $this->msg( 'linksearch-ns' )->text()
107 'name' => 'namespace',
109 'class' => 'namespaceselector',
114 $s .= Xml
::submitButton( $this->msg( 'linksearch-ok' )->text() ) . "\n" .
115 Html
::closeElement( 'fieldset' ) . "\n" .
116 Html
::closeElement( 'form' ) . "\n";
119 if ( $target != '' ) {
120 $this->setParams( array(
122 'namespace' => $namespace,
123 'protocol' => $protocol ) );
124 parent
::execute( $par );
125 if ( $this->mMungedQuery
=== false ) {
126 $out->addWikiMsg( 'linksearch-error' );
132 * Disable RSS/Atom feeds
135 function isSyndicated() {
140 * Return an appropriately formatted LIKE query and the clause
142 * @param String $query Search pattern to search for
143 * @param String $prot Protocol, e.g. 'http://'
147 static function mungeQuery( $query, $prot ) {
149 $dbr = wfGetDB( DB_SLAVE
);
151 if ( $query === '*' && $prot !== '' ) {
152 // Allow queries like 'ftp://*' to find all ftp links
153 $rv = array( $prot, $dbr->anyString() );
155 $rv = LinkFilter
::makeLikeArray( $query, $prot );
158 if ( $rv === false ) {
159 // LinkFilter doesn't handle wildcard in IP, so we'll have to munge here.
160 $pattern = '/^(:?[0-9]{1,3}\.)+\*\s*$|^(:?[0-9]{1,3}\.){3}[0-9]{1,3}:[0-9]*\*\s*$/';
161 if ( preg_match( $pattern, $query ) ) {
162 $rv = array( $prot . rtrim( $query, " \t*" ), $dbr->anyString() );
167 return array( $rv, $field );
170 function linkParameters() {
173 $params['target'] = $this->mProt
. $this->mQuery
;
174 if ( isset( $this->mNs
) && !$wgMiserMode ) {
175 $params['namespace'] = $this->mNs
;
181 function getQueryInfo() {
183 $dbr = wfGetDB( DB_SLAVE
);
184 // strip everything past first wildcard, so that
185 // index-based-only lookup would be done
186 list( $this->mMungedQuery
, $clause ) = self
::mungeQuery( $this->mQuery
, $this->mProt
);
187 if ( $this->mMungedQuery
=== false ) {
188 // Invalid query; return no results
189 return array( 'tables' => 'page', 'fields' => 'page_id', 'conds' => '0=1' );
192 $stripped = LinkFilter
::keepOneWildcard( $this->mMungedQuery
);
193 $like = $dbr->buildLike( $stripped );
195 'tables' => array( 'page', 'externallinks' ),
197 'namespace' => 'page_namespace',
198 'title' => 'page_title',
199 'value' => 'el_index',
206 'options' => array( 'USE INDEX' => $clause )
209 if ( isset( $this->mNs
) && !$wgMiserMode ) {
210 $retval['conds']['page_namespace'] = $this->mNs
;
218 * @param object $result Result row
221 function formatResult( $skin, $result ) {
222 $title = Title
::makeTitle( $result->namespace, $result->title
);
224 $pageLink = Linker
::linkKnown( $title );
225 $urlLink = Linker
::makeExternalLink( $url, $url );
227 return $this->msg( 'linksearch-line' )->rawParams( $urlLink, $pageLink )->escaped();
231 * Override to check query validity.
233 * @param mixed $offset Numerical offset or false for no offset
234 * @param mixed $limit Numerical limit or false for no limit
236 function doQuery( $offset = false, $limit = false ) {
237 list( $this->mMungedQuery
, ) = LinkSearchPage
::mungeQuery( $this->mQuery
, $this->mProt
);
238 if ( $this->mMungedQuery
=== false ) {
239 $this->getOutput()->addWikiMsg( 'linksearch-error' );
242 // Generates invalid xhtml with patterns that contain --
243 //$this->getOutput()->addHTML( "\n<!-- " . htmlspecialchars( $this->mMungedQuery ) . " -->\n" );
244 parent
::doQuery( $offset, $limit );
249 * Override to squash the ORDER BY.
250 * We do a truncated index search, so the optimizer won't trust
251 * it as good enough for optimizing sort. The implicit ordering
252 * from the scan will usually do well enough for our needs.
255 function getOrderFields() {
259 protected function getGroupName() {