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
27 * Special:LinkSearch to search the external-links table.
28 * @ingroup SpecialPage
30 class LinkSearchPage
extends QueryPage
{
31 function setParams( $params ) {
32 $this->mQuery
= $params['query'];
33 $this->mNs
= $params['namespace'];
34 $this->mProt
= $params['protocol'];
37 function __construct( $name = 'LinkSearch' ) {
38 parent
::__construct( $name );
41 function isCacheable() {
45 function execute( $par ) {
46 global $wgOut, $wgRequest, $wgUrlProtocols, $wgMiserMode, $wgLang;
48 $wgOut->allowClickjacking();
50 $target = $wgRequest->getVal( 'target', $par );
51 $namespace = $wgRequest->getIntorNull( 'namespace', null );
53 $protocols_list[] = '';
54 foreach( $wgUrlProtocols as $prot ) {
55 $protocols_list[] = $prot;
60 $pr_sl = strpos($target2, '//' );
61 $pr_cl = strpos($target2, ':' );
63 // For protocols with '//'
64 $protocol = substr( $target2, 0 , $pr_sl+
2 );
65 $target2 = substr( $target2, $pr_sl+
2 );
66 } elseif ( !$pr_sl && $pr_cl ) {
67 // For protocols without '//' like 'mailto:'
68 $protocol = substr( $target2, 0 , $pr_cl+
1 );
69 $target2 = substr( $target2, $pr_cl+
1 );
70 } elseif ( $protocol == '' && $target2 != '' ) {
72 $protocol = 'http://';
74 if ( !in_array( $protocol, $protocols_list ) ) {
75 // unsupported protocol, show original search request
80 $self = $this->getTitle();
82 $wgOut->addWikiMsg( 'linksearch-text', '<nowiki>' . $wgLang->commaList( $wgUrlProtocols ) . '</nowiki>' );
83 $s = Xml
::openElement( 'form', array( 'id' => 'mw-linksearch-form', 'method' => 'get', 'action' => $GLOBALS['wgScript'] ) ) .
84 Html
::hidden( 'title', $self->getPrefixedDbKey() ) .
86 Xml
::element( 'legend', array(), wfMsg( 'linksearch' ) ) .
87 Xml
::inputLabel( wfMsg( 'linksearch-pat' ), 'target', 'target', 50, $target ) . ' ';
88 if ( !$wgMiserMode ) {
89 $s .= Xml
::label( wfMsg( 'linksearch-ns' ), 'namespace' ) . ' ' .
90 Xml
::namespaceSelector( $namespace, '' );
92 $s .= Xml
::submitButton( wfMsg( 'linksearch-ok' ) ) .
94 Xml
::closeElement( 'form' );
95 $wgOut->addHTML( $s );
98 $this->setParams( array(
100 'namespace' => $namespace,
101 'protocol' => $protocol ) );
102 parent
::execute( $par );
103 if( $this->mMungedQuery
=== false )
104 $wgOut->addWikiMsg( 'linksearch-error' );
109 * Disable RSS/Atom feeds
111 function isSyndicated() {
116 * Return an appropriately formatted LIKE query and the clause
118 static function mungeQuery( $query, $prot ) {
120 $rv = LinkFilter
::makeLikeArray( $query , $prot );
121 if ( $rv === false ) {
122 // LinkFilter doesn't handle wildcard in IP, so we'll have to munge here.
123 if (preg_match('/^(:?[0-9]{1,3}\.)+\*\s*$|^(:?[0-9]{1,3}\.){3}[0-9]{1,3}:[0-9]*\*\s*$/', $query)) {
124 $dbr = wfGetDB( DB_SLAVE
);
125 $rv = array( $prot . rtrim( $query, " \t*" ), $dbr->anyString() );
129 return array( $rv, $field );
132 function linkParameters() {
135 $params['target'] = $this->mProt
. $this->mQuery
;
136 if( isset( $this->mNs
) && !$wgMiserMode ) {
137 $params['namespace'] = $this->mNs
;
142 function getQueryInfo() {
144 $dbr = wfGetDB( DB_SLAVE
);
145 // strip everything past first wildcard, so that
146 // index-based-only lookup would be done
147 list( $this->mMungedQuery
, $clause ) = self
::mungeQuery(
148 $this->mQuery
, $this->mProt
);
149 if( $this->mMungedQuery
=== false )
150 // Invalid query; return no results
151 return array( 'tables' => 'page', 'fields' => 'page_id', 'conds' => '0=1' );
153 $stripped = LinkFilter
::keepOneWildcard( $this->mMungedQuery
);
154 $like = $dbr->buildLike( $stripped );
156 'tables' => array ( 'page', 'externallinks' ),
157 'fields' => array ( 'page_namespace AS namespace',
158 'page_title AS title',
159 'el_index AS value', 'el_to AS url' ),
160 'conds' => array ( 'page_id = el_from',
162 'options' => array( 'USE INDEX' => $clause )
164 if ( isset( $this->mNs
) && !$wgMiserMode ) {
165 $retval['conds']['page_namespace'] = $this->mNs
;
170 function formatResult( $skin, $result ) {
171 $title = Title
::makeTitle( $result->namespace, $result->title
);
173 $pageLink = $skin->linkKnown( $title );
174 $urlLink = $skin->makeExternalLink( $url, $url );
176 return wfMsgHtml( 'linksearch-line', $urlLink, $pageLink );
180 * Override to check query validity.
182 function doQuery( $offset = false, $limit = false ) {
184 list( $this->mMungedQuery
, ) = LinkSearchPage
::mungeQuery( $this->mQuery
, $this->mProt
);
185 if( $this->mMungedQuery
=== false ) {
186 $wgOut->addWikiMsg( 'linksearch-error' );
189 // Generates invalid xhtml with patterns that contain --
190 //$wgOut->addHTML( "\n<!-- " . htmlspecialchars( $this->mMungedQuery ) . " -->\n" );
191 parent
::doQuery( $offset, $limit );
196 * Override to squash the ORDER BY.
197 * We do a truncated index search, so the optimizer won't trust
198 * it as good enough for optimizing sort. The implicit ordering
199 * from the scan will usually do well enough for our needs.
201 function getOrderFields() {