Follow-up r84814: revert redundant summary message addition.
[lhc/web/wiklou.git] / includes / specials / SpecialLinkSearch.php
index b8ff479..623504d 100644 (file)
 <?php
 /**
+ * Implements Special:LinkSearch
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
  * @file
  * @ingroup SpecialPage
- *
  * @author Brion Vibber
- * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
  */
 
+
 /**
  * Special:LinkSearch to search the external-links table.
  * @ingroup SpecialPage
  */
-
-function wfSpecialLinkSearch( $par ) {
-
-       list( $limit, $offset ) = wfCheckLimits();
-       global $wgOut, $wgRequest, $wgUrlProtocols, $wgMiserMode;
-       $target = $GLOBALS['wgRequest']->getVal( 'target', $par );
-       $namespace = $GLOBALS['wgRequest']->getIntorNull( 'namespace', null );
-
-       $protocols_list[] = '';
-       foreach( $wgUrlProtocols as $prot ) {
-               $protocols_list[] = $prot;
+class LinkSearchPage extends QueryPage {
+       function setParams( $params ) {
+               $this->mQuery = $params['query'];
+               $this->mNs = $params['namespace'];
+               $this->mProt = $params['protocol'];
        }
 
-       $target2 = $target;
-       $protocol = '';
-       $pr_sl = strpos($target2, '//' );
-       $pr_cl = strpos($target2, ':' );
-       if ( $pr_sl ) {
-               // For protocols with '//'
-               $protocol = substr( $target2, 0 , $pr_sl+2 );
-               $target2 = substr( $target2, $pr_sl+2 );
-       } elseif ( !$pr_sl && $pr_cl ) {
-               // For protocols without '//' like 'mailto:'
-               $protocol = substr( $target2, 0 , $pr_cl+1 );
-               $target2 = substr( $target2, $pr_cl+1 );
-       } elseif ( $protocol == '' && $target2 != '' ) {
-               // default
-               $protocol = 'http://';
-       }
-       if ( !in_array( $protocol, $protocols_list ) ) {
-               // unsupported protocol, show original search request
-               $target2 = $target;
-               $protocol = '';
+       function __construct( $name = 'LinkSearch' ) {
+               parent::__construct( $name );
        }
 
-       $self = Title::makeTitle( NS_SPECIAL, 'Linksearch' );
-
-       $wgOut->addWikiText( wfMsg( 'linksearch-text', '<nowiki>' . implode( ', ',  $wgUrlProtocols) . '</nowiki>' ) );
-       $s =    Xml::openElement( 'form', array( 'id' => 'mw-linksearch-form', 'method' => 'get', 'action' => $GLOBALS['wgScript'] ) ) .
-               Xml::hidden( 'title', $self->getPrefixedDbKey() ) .
-               '<fieldset>' .
-               Xml::element( 'legend', array(), wfMsg( 'linksearch' ) ) .
-               Xml::inputLabel( wfMsg( 'linksearch-pat' ), 'target', 'target', 50, $target ) . ' ';
-       if ( !$wgMiserMode ) {
-               $s .= Xml::label( wfMsg( 'linksearch-ns' ), 'namespace' ) . ' ' .
-                       XML::namespaceSelector( $namespace, '' );
-       }
-       $s .=   Xml::submitButton( wfMsg( 'linksearch-ok' ) ) .
-               '</fieldset>' .
-               Xml::closeElement( 'form' );
-       $wgOut->addHtml( $s );
-
-       if( $target != '' ) {
-               $searcher = new LinkSearchPage( $target2, $namespace, $protocol );
-               $searcher->doQuery( $offset, $limit );
+       function isCacheable() {
+               return false;
        }
-}
 
-class LinkSearchPage extends QueryPage {
+       function execute( $par ) {
+               global $wgOut, $wgRequest, $wgUrlProtocols, $wgMiserMode, $wgLang;
+               $this->setHeaders();
+               $wgOut->allowClickjacking();
 
-       function __construct( $query, $ns, $prot ) {
-               $this->mQuery = $query;
-               $this->mNs = $ns;
-               $this->mProt = $prot;
-       }
+               $target = $wgRequest->getVal( 'target', $par );
+               $namespace = $wgRequest->getIntorNull( 'namespace', null );
+
+               $protocols_list[] = '';
+               foreach( $wgUrlProtocols as $prot ) {
+                       $protocols_list[] = $prot;
+               }
+
+               $target2 = $target;
+               $protocol = '';
+               $pr_sl = strpos($target2, '//' );
+               $pr_cl = strpos($target2, ':' );
+               if ( $pr_sl ) {
+                       // For protocols with '//'
+                       $protocol = substr( $target2, 0 , $pr_sl+2 );
+                       $target2 = substr( $target2, $pr_sl+2 );
+               } elseif ( !$pr_sl && $pr_cl ) {
+                       // For protocols without '//' like 'mailto:'
+                       $protocol = substr( $target2, 0 , $pr_cl+1 );
+                       $target2 = substr( $target2, $pr_cl+1 );
+               } elseif ( $protocol == '' && $target2 != '' ) {
+                       // default
+                       $protocol = 'http://';
+               }
+               if ( !in_array( $protocol, $protocols_list ) ) {
+                       // unsupported protocol, show original search request
+                       $target2 = $target;
+                       $protocol = '';
+               }
 
-       function getName() {
-               return 'LinkSearch';
+               $self = $this->getTitle();
+
+               $wgOut->addWikiMsg( 'linksearch-text', '<nowiki>' . $wgLang->commaList( $wgUrlProtocols ) . '</nowiki>' );
+               $s = Xml::openElement( 'form', array( 'id' => 'mw-linksearch-form', 'method' => 'get', 'action' => $GLOBALS['wgScript'] ) ) .
+                       Html::hidden( 'title', $self->getPrefixedDbKey() ) .
+                       '<fieldset>' .
+                       Xml::element( 'legend', array(), wfMsg( 'linksearch' ) ) .
+                       Xml::inputLabel( wfMsg( 'linksearch-pat' ), 'target', 'target', 50, $target ) . ' ';
+               if ( !$wgMiserMode ) {
+                       $s .= Xml::label( wfMsg( 'linksearch-ns' ), 'namespace' ) . ' ' .
+                               Xml::namespaceSelector( $namespace, '' );
+               }
+               $s .=   Xml::submitButton( wfMsg( 'linksearch-ok' ) ) .
+                       '</fieldset>' .
+                       Xml::closeElement( 'form' );
+               $wgOut->addHTML( $s );
+
+               if( $target != '' ) {
+                       $this->setParams( array(
+                               'query' => $target2,
+                               'namespace' => $namespace,
+                               'protocol' => $protocol ) );
+                       parent::execute( $par );
+                       if( $this->mMungedQuery === false )
+                               $wgOut->addWikiMsg( 'linksearch-error' );
+               }
        }
 
        /**
@@ -91,13 +115,14 @@ class LinkSearchPage extends QueryPage {
        /**
         * Return an appropriately formatted LIKE query and the clause
         */
-       static function mungeQuery( $query , $prot ) {
+       static function mungeQuery( $query, $prot ) {
                $field = 'el_index';
-               $rv = LinkFilter::makeLike( $query , $prot );
-               if ($rv === false) {
-                       //makeLike doesn't handle wildcard in IP, so we'll have to munge here.
+               $rv = LinkFilter::makeLikeArray( $query , $prot );
+               if ( $rv === false ) {
+                       // LinkFilter doesn't handle wildcard in IP, so we'll have to munge here.
                        if (preg_match('/^(:?[0-9]{1,3}\.)+\*\s*$|^(:?[0-9]{1,3}\.){3}[0-9]{1,3}:[0-9]*\*\s*$/', $query)) {
-                               $rv = $prot . rtrim($query, " \t*") . '%';
+                               $dbr = wfGetDB( DB_SLAVE );
+                               $rv = array( $prot . rtrim( $query, " \t*" ), $dbr->anyString() );
                                $field = 'el_to';
                        }
                }
@@ -114,41 +139,38 @@ class LinkSearchPage extends QueryPage {
                return $params;
        }
 
-       function getSQL() {
+       function getQueryInfo() {
                global $wgMiserMode;
                $dbr = wfGetDB( DB_SLAVE );
-               $page = $dbr->tableName( 'page' );
-               $externallinks = $dbr->tableName( 'externallinks' );
-
-               /* strip everything past first wildcard, so that index-based-only lookup would be done */
-               list( $munged, $clause ) = self::mungeQuery( $this->mQuery, $this->mProt );
-               $stripped = substr($munged,0,strpos($munged,'%')+1);
-               $encSearch = $dbr->addQuotes( $stripped );
-
-               $encSQL = '';
-               if ( isset ($this->mNs) && !$wgMiserMode )
-                       $encSQL = 'AND page_namespace=' . $dbr->addQuotes( $this->mNs );
-
-               $use_index = $dbr->useIndexClause( $clause );
-               return
-                       "SELECT
-                               page_namespace AS namespace,
-                               page_title AS title,
-                               el_index AS value,
-                               el_to AS url
-                       FROM
-                               $page,
-                               $externallinks $use_index
-                       WHERE
-                               page_id=el_from
-                               AND $clause LIKE $encSearch
-                               $encSQL";
+               // strip everything past first wildcard, so that
+               // index-based-only lookup would be done
+               list( $this->mMungedQuery, $clause ) = self::mungeQuery(
+                               $this->mQuery, $this->mProt );
+               if( $this->mMungedQuery === false )
+                       // Invalid query; return no results
+                       return array( 'tables' => 'page', 'fields' => 'page_id', 'conds' => '0=1' );
+
+               $stripped = LinkFilter::keepOneWildcard( $this->mMungedQuery );
+               $like = $dbr->buildLike( $stripped );
+               $retval = array (
+                       'tables' => array ( 'page', 'externallinks' ),
+                       'fields' => array ( 'page_namespace AS namespace',
+                                       'page_title AS title',
+                                       'el_index AS value', 'el_to AS url' ),
+                       'conds' => array ( 'page_id = el_from',
+                                       "$clause $like" ),
+                       'options' => array( 'USE INDEX' => $clause )
+               );
+               if ( isset( $this->mNs ) && !$wgMiserMode ) {
+                       $retval['conds']['page_namespace'] = $this->mNs;
+               }
+               return $retval;
        }
 
        function formatResult( $skin, $result ) {
                $title = Title::makeTitle( $result->namespace, $result->title );
                $url = $result->url;
-               $pageLink = $skin->makeKnownLinkObj( $title );
+               $pageLink = $skin->linkKnown( $title );
                $urlLink = $skin->makeExternalLink( $url, $url );
 
                return wfMsgHtml( 'linksearch-line', $urlLink, $pageLink );
@@ -157,16 +179,16 @@ class LinkSearchPage extends QueryPage {
        /**
         * Override to check query validity.
         */
-       function doQuery( $offset, $limit, $shownavigation=true ) {
+       function doQuery( $offset = false, $limit = false ) {
                global $wgOut;
-               list( $this->mMungedQuery, $clause ) = LinkSearchPage::mungeQuery( $this->mQuery, $this->mProt );
+               list( $this->mMungedQuery,  ) = LinkSearchPage::mungeQuery( $this->mQuery, $this->mProt );
                if( $this->mMungedQuery === false ) {
-                       $wgOut->addWikiText( wfMsg( 'linksearch-error' ) );
+                       $wgOut->addWikiMsg( 'linksearch-error' );
                } else {
                        // For debugging
                        // Generates invalid xhtml with patterns that contain --
-                       //$wgOut->addHtml( "\n<!-- " . htmlspecialchars( $this->mMungedQuery ) . " -->\n" );
-                       parent::doQuery( $offset, $limit, $shownavigation );
+                       //$wgOut->addHTML( "\n<!-- " . htmlspecialchars( $this->mMungedQuery ) . " -->\n" );
+                       parent::doQuery( $offset, $limit );
                }
        }
 
@@ -176,7 +198,7 @@ class LinkSearchPage extends QueryPage {
         * it as good enough for optimizing sort. The implicit ordering
         * from the scan will usually do well enough for our needs.
         */
-       function getOrder() {
-               return '';
+       function getOrderFields() {
+               return array();
        }
 }