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, $wgScript;
49 $target = $wgRequest->getVal( 'target', $par );
50 $namespace = $wgRequest->getIntorNull( 'namespace', null );
52 $protocols_list[] = '';
53 foreach( $wgUrlProtocols as $prot ) {
54 $protocols_list[] = $prot;
59 $pr_sl = strpos($target2, '//' );
60 $pr_cl = strpos($target2, ':' );
62 // For protocols with '//'
63 $protocol = substr( $target2, 0 , $pr_sl+
2 );
64 $target2 = substr( $target2, $pr_sl+
2 );
65 } elseif ( !$pr_sl && $pr_cl ) {
66 // For protocols without '//' like 'mailto:'
67 $protocol = substr( $target2, 0 , $pr_cl+
1 );
68 $target2 = substr( $target2, $pr_cl+
1 );
69 } elseif ( $protocol == '' && $target2 != '' ) {
71 $protocol = 'http://';
73 if ( !in_array( $protocol, $protocols_list ) ) {
74 // unsupported protocol, show original search request
79 $self = $this->getTitle();
81 $wgOut->addWikiMsg( 'linksearch-text', '<nowiki>' . $wgLang->commaList( $wgUrlProtocols ) . '</nowiki>' );
82 $s = Xml
::openElement( 'form', array( 'id' => 'mw-linksearch-form', 'method' => 'get', 'action' => $GLOBALS['wgScript'] ) ) .
83 Html
::hidden( 'title', $self->getPrefixedDbKey() ) .
85 Xml
::element( 'legend', array(), wfMsg( 'linksearch' ) ) .
86 Xml
::inputLabel( wfMsg( 'linksearch-pat' ), 'target', 'target', 50, $target ) . ' ';
87 if ( !$wgMiserMode ) {
88 $s .= Xml
::label( wfMsg( 'linksearch-ns' ), 'namespace' ) . ' ' .
89 Xml
::namespaceSelector( $namespace, '' );
91 $s .= Xml
::submitButton( wfMsg( 'linksearch-ok' ) ) .
93 Xml
::closeElement( 'form' );
94 $wgOut->addHTML( $s );
97 $this->setParams( array(
99 'namespace' => $namespace,
100 'protocol' => $protocol ) );
101 parent
::execute( $par );
102 if( $this->mMungedQuery
=== false )
103 $wgOut->addWikiText( wfMsg( 'linksearch-error' ) );
108 * Disable RSS/Atom feeds
110 function isSyndicated() {
115 * Return an appropriately formatted LIKE query and the clause
117 static function mungeQuery( $query , $prot ) {
119 $rv = LinkFilter
::makeLike( $query , $prot );
120 if ( $rv === false ) {
121 // LinkFilter doesn't handle wildcard in IP, so we'll have to munge here.
122 if (preg_match('/^(:?[0-9]{1,3}\.)+\*\s*$|^(:?[0-9]{1,3}\.){3}[0-9]{1,3}:[0-9]*\*\s*$/', $query)) {
123 $rv = $prot . rtrim($query, " \t*") . '%';
127 return array( $rv, $field );
130 function linkParameters() {
133 $params['target'] = $this->mProt
. $this->mQuery
;
134 if( isset( $this->mNs
) && !$wgMiserMode ) {
135 $params['namespace'] = $this->mNs
;
140 function getQueryInfo() {
142 $dbr = wfGetDB( DB_SLAVE
);
143 // strip everything past first wildcard, so that
144 // index-based-only lookup would be done
145 list( $this->mMungedQuery
, $clause ) = self
::mungeQuery(
146 $this->mQuery
, $this->mProt
);
147 if( $this->mMungedQuery
=== false )
148 // Invalid query; return no results
149 return array( 'tables' => 'page', 'fields' => 'page_id', 'conds' => '0=1' );
151 $stripped = substr( $this->mMungedQuery
, 0, strpos( $this->mMungedQuery
, '%' ) +
1 );
152 $encSearch = $dbr->addQuotes( $stripped );
154 'tables' => array ( 'page', 'externallinks' ),
155 'fields' => array ( 'page_namespace AS namespace',
156 'page_title AS title',
157 'el_index AS value', 'el_to AS url' ),
158 'conds' => array ( 'page_id = el_from',
159 "$clause LIKE $encSearch" ),
160 'options' => array( 'USE INDEX' => $clause )
162 if ( isset( $this->mNs
) && !$wgMiserMode ) {
163 $retval['conds']['page_namespace'] = $this->mNs
;
168 function formatResult( $skin, $result ) {
169 $title = Title
::makeTitle( $result->namespace, $result->title
);
171 $pageLink = $skin->linkKnown( $title );
172 $urlLink = $skin->makeExternalLink( $url, $url );
174 return wfMsgHtml( 'linksearch-line', $urlLink, $pageLink );
178 * Override to check query validity.
180 function doQuery( $offset, $limit = false ) {
182 list( $this->mMungedQuery
, ) = LinkSearchPage
::mungeQuery( $this->mQuery
, $this->mProt
);
183 if( $this->mMungedQuery
=== false ) {
184 $wgOut->addWikiMsg( 'linksearch-error' );
187 // Generates invalid xhtml with patterns that contain --
188 //$wgOut->addHTML( "\n<!-- " . htmlspecialchars( $this->mMungedQuery ) . " -->\n" );
189 parent
::doQuery( $offset, $limit );
194 * Override to squash the ORDER BY.
195 * We do a truncated index search, so the optimizer won't trust
196 * it as good enough for optimizing sort. The implicit ordering
197 * from the scan will usually do well enough for our needs.
199 function getOrderFields() {