And even more documentation in various files
[lhc/web/wiklou.git] / includes / search / SearchMySQL.php
index a0ec927..a2c27ba 100644 (file)
@@ -1,23 +1,25 @@
 <?php
-# Copyright (C) 2004 Brion Vibber <brion@pobox.com>
-# http://www.mediawiki.org/
-#
-# 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
-
 /**
+ * MySQL search engine
+ *
+ * Copyright (C) 2004 Brion Vibber <brion@pobox.com>
+ * http://www.mediawiki.org/
+ *
+ * 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 Search
  */
  */
 class SearchMySQL extends SearchEngine {
        var $strictMatching = true;
+       static $mMinSearchLength;
 
-       /** @todo document */
+       /**
+        * Creates an instance of this class
+        * @param $db DatabaseMysql: database object
+        */
        function __construct( $db ) {
-               $this->db = $db;
+               parent::__construct( $db );
        }
 
        /** 
         * Parse the user's query and transform it into an SQL fragment which will 
         * become part of a WHERE clause
+        *
+        * @param $filteredText string
+        * @param $fullText string
+        *
+        * @return string
         */
        function parseQuery( $filteredText, $fulltext ) {
                global $wgContLang;
@@ -44,13 +55,13 @@ class SearchMySQL extends SearchEngine {
                $searchon = '';
                $this->searchTerms = array();
 
-               # FIXME: This doesn't handle parenthetical expressions.
+               # @todo FIXME: This doesn't handle parenthetical expressions.
                $m = array();
                if( preg_match_all( '/([-+<>~]?)(([' . $lc . ']+)(\*?)|"[^"]*")/',
                          $filteredText, $m, PREG_SET_ORDER ) ) {
                        foreach( $m as $bits ) {
                                @list( /* all */, $modifier, $term, $nonQuoted, $wildcard ) = $bits;
-                               
+
                                if( $nonQuoted != '' ) {
                                        $term = $nonQuoted;
                                        $quote = '';
@@ -58,13 +69,13 @@ class SearchMySQL extends SearchEngine {
                                        $term = str_replace( '"', '', $term );
                                        $quote = '"';
                                }
-                       
+
                                if( $searchon !== '' ) $searchon .= ' ';
                                if( $this->strictMatching && ($modifier == '') ) {
                                        // If we leave this out, boolean op defaults to OR which is rarely helpful.
                                        $modifier = '+';
                                }
-                               
+
                                // Some languages such as Serbian store the input form in the search index,
                                // so we may need to search for matches in multiple writing system variants.
                                $convertedVariants = $wgContLang->autoConvertToAllVariants( $term );
@@ -73,27 +84,28 @@ class SearchMySQL extends SearchEngine {
                                } else {
                                        $variants = array( $term );
                                }
-                               
+
                                // The low-level search index does some processing on input to work
                                // around problems with minimum lengths and encoding in MySQL's
                                // fulltext engine.
                                // For Chinese this also inserts spaces between adjacent Han characters.
                                $strippedVariants = array_map(
-                                       array( $wgContLang, 'stripForSearch' ),
+                                       array( $wgContLang, 'normalizeForSearch' ),
                                        $variants );
-                               
+
                                // Some languages such as Chinese force all variants to a canonical
                                // form when stripping to the low-level search index, so to be sure
                                // let's check our variants list for unique items after stripping.
                                $strippedVariants = array_unique( $strippedVariants );
-                               
+
                                $searchon .= $modifier;
                                if( count( $strippedVariants) > 1 )
                                        $searchon .= '(';
                                foreach( $strippedVariants as $stripped ) {
+                                       $stripped = $this->normalizeText( $stripped );
                                        if( $nonQuoted && strpos( $stripped, ' ' ) !== false ) {
                                                // Hack for Chinese: we need to toss in quotes for
-                                               // multiple-character phrases since stripForSearch()
+                                               // multiple-character phrases since normalizeForSearch()
                                                // added spaces between them to make word breaks.
                                                $stripped = '"' . trim( $stripped ) . '"';
                                        }
@@ -101,7 +113,7 @@ class SearchMySQL extends SearchEngine {
                                }
                                if( count( $strippedVariants) > 1 )
                                        $searchon .= ')';
-                               
+
                                // Match individual terms or quoted phrase in result highlighting...
                                // Note that variants will be introduced in a later stage for highlighting!
                                $regexp = $this->regexTerm( $term, $wildcard );
@@ -117,10 +129,10 @@ class SearchMySQL extends SearchEngine {
                $field = $this->getIndexField( $fulltext );
                return " MATCH($field) AGAINST('$searchon' IN BOOLEAN MODE) ";
        }
-       
+
        function regexTerm( $string, $wildcard ) {
                global $wgContLang;
-               
+
                $regex = preg_quote( $string, '/' );
                if( $wgContLang->hasWordBreaks() ) {
                        if( $wildcard ) {
@@ -160,85 +172,112 @@ class SearchMySQL extends SearchEngine {
        function searchTitle( $term ) {
                return $this->searchInternal( $term, false );
        }
-       
+
        protected function searchInternal( $term, $fulltext ) {
-               global $wgSearchMySQLTotalHits;
-               
+               global $wgCountTotalSearchHits;
+
+               // This seems out of place, why is this called with empty term?
+               if ( trim( $term ) === '' ) return null;
+
                $filteredTerm = $this->filter( $term );
-               $resultSet = $this->db->query( $this->getQuery( $filteredTerm, $fulltext ) );
-               
+               $query = $this->getQuery( $filteredTerm, $fulltext );
+               $resultSet = $this->db->select(
+                       $query['tables'], $query['fields'], $query['conds'],
+                       __METHOD__, $query['options'], $query['joins']
+               );
+
                $total = null;
-               if( $wgSearchMySQLTotalHits ) {
-                       $totalResult = $this->db->query( $this->getCountQuery( $filteredTerm, $fulltext ) );
+               if( $wgCountTotalSearchHits ) {
+                       $query = $this->getCountQuery( $filteredTerm, $fulltext );
+                       $totalResult = $this->db->select(
+                               $query['tables'], $query['fields'], $query['conds'],
+                               __METHOD__, $query['options'], $query['joins']
+                       );
+
                        $row = $totalResult->fetchObject();
                        if( $row ) {
                                $total = intval( $row->c );
                        }
                        $totalResult->free();
                }
-               
+
                return new MySQLSearchResultSet( $resultSet, $this->searchTerms, $total );
        }
 
-
-       /**
-        * Return a partial WHERE clause to exclude redirects, if so set
-        * @return String
-        */
-       function queryRedirect() {
-               if( $this->showRedirects ) {
-                       return '';
-               } else {
-                       return 'AND page_is_redirect=0';
+       public function supports( $feature ) {
+               switch( $feature ) {
+               case 'list-redirects':
+               case 'title-suffix-filter':
+                       return true;
+               default:
+                       return false;
                }
        }
 
        /**
-        * Return a partial WHERE clause to limit the search to the given namespaces
-        * @return String
+        * Add special conditions
+        * @param $query Array
+        * @since 1.18
         */
-       function queryNamespaces() {
-               if( is_null($this->namespaces) )
-                       return '';  # search all
-               if ( !count( $this->namespaces ) ) {
-                       $namespaces = '0';
-               } else {
-                       $namespaces = $this->db->makeList( $this->namespaces );
+       protected function queryFeatures( &$query ) {
+               foreach ( $this->features as $feature => $value ) {
+                       if ( $feature ===  'list-redirects' && !$value ) {
+                               $query['conds']['page_is_redirect'] = 0;
+                       } elseif( $feature === 'title-suffix-filter' && $value ) {
+                               $query['conds'][] = 'page_title' . $this->db->buildLike( $this->db->anyString(), $value );
+                       }
                }
-               return 'AND page_namespace IN (' . $namespaces . ')';
        }
 
        /**
-        * Return a LIMIT clause to limit results on the query.
-        * @return String
+        * Add namespace conditions
+        * @param $query Array
+        * @since 1.18 (changed)
         */
-       function queryLimit() {
-               return $this->db->limitResult( '', $this->limit, $this->offset );
+       function queryNamespaces( &$query ) {
+               if ( is_array( $this->namespaces ) ) {
+                       if ( count( $this->namespaces ) === 0 ) {
+                               $this->namespaces[] = '0';
+                       }
+                       $query['conds']['page_namespace'] = $this->namespaces;
+               }
        }
 
        /**
-        * Does not do anything for generic search engine
-        * subclasses may define this though
-        * @return String
+        * Add limit options
+        * @param $query Array
+        * @since 1.18
         */
-       function queryRanking( $filteredTerm, $fulltext ) {
-               return '';
+       protected function limitResult( &$query ) {
+               $query['options']['LIMIT'] = $this->limit;
+               $query['options']['OFFSET'] = $this->offset;
        }
 
        /**
-        * Construct the full SQL query to do the search.
+        * Construct the SQL query to do the search.
         * The guts shoulds be constructed in queryMain()
         * @param $filteredTerm String
         * @param $fulltext Boolean
+        * @return Array
+        * @since 1.18 (changed)
         */
        function getQuery( $filteredTerm, $fulltext ) {
-               return $this->queryMain( $filteredTerm, $fulltext ) . ' ' .
-                       $this->queryRedirect() . ' ' .
-                       $this->queryNamespaces() . ' ' .
-                       $this->queryRanking( $filteredTerm, $fulltext ) . ' ' .
-                       $this->queryLimit();
+               $query = array(
+                       'tables' => array(),
+                       'fields' => array(),
+                       'conds' => array(),
+                       'options' => array(),
+                       'joins' => array(),
+               );
+
+               $this->queryMain( $query, $filteredTerm, $fulltext );
+               $this->queryFeatures( $query );
+               $this->queryNamespaces( $query );
+               $this->limitResult( $query );
+
+               return $query;
        }
-       
+
        /**
         * Picks which field to index on, depending on what type of query.
         * @param $fulltext Boolean
@@ -250,32 +289,40 @@ class SearchMySQL extends SearchEngine {
 
        /**
         * Get the base part of the search query.
-        * The actual match syntax will depend on the server
-        * version; MySQL 3 and MySQL 4 have different capabilities
-        * in their fulltext search indexes.
         *
         * @param $filteredTerm String
         * @param $fulltext Boolean
-        * @return String
+        * @since 1.18 (changed)
         */
-       function queryMain( $filteredTerm, $fulltext ) {
+       function queryMain( &$query, $filteredTerm, $fulltext ) {
                $match = $this->parseQuery( $filteredTerm, $fulltext );
-               $page        = $this->db->tableName( 'page' );
-               $searchindex = $this->db->tableName( 'searchindex' );
-               return 'SELECT page_id, page_namespace, page_title ' .
-                       "FROM $page,$searchindex " .
-                       'WHERE page_id=si_page AND ' . $match;
+               $query['tables'][] = 'page';
+               $query['tables'][] = 'searchindex';
+               $query['fields'][] = 'page_id';
+               $query['fields'][] = 'page_namespace';
+               $query['fields'][] = 'page_title';
+               $query['conds'][] = 'page_id=si_page';
+               $query['conds'][] = $match;
        }
 
+       /**
+        * @since 1.18 (changed)
+        */
        function getCountQuery( $filteredTerm, $fulltext ) {
                $match = $this->parseQuery( $filteredTerm, $fulltext );
-               $page        = $this->db->tableName( 'page' );
-               $searchindex = $this->db->tableName( 'searchindex' );
-               return "SELECT COUNT(*) AS c " .
-                       "FROM $page,$searchindex " .
-                       'WHERE page_id=si_page AND ' . $match .
-                       $this->queryRedirect() . ' ' .
-                       $this->queryNamespaces();
+
+               $query = array(
+                       'tables' => array( 'page', 'searchindex' ),
+                       'fields' => array( 'COUNT(*) as c' ),
+                       'conds' => array( 'page_id=si_page', $match ),
+                       'options' => array(),
+                       'joins' => array(),
+               );
+
+               $this->queryFeatures( $query );
+               $this->queryNamespaces( $query );
+
+               return $query;
        }
 
        /**
@@ -292,8 +339,8 @@ class SearchMySQL extends SearchEngine {
                        array( 'si_page' ),
                        array(
                                'si_page' => $id,
-                               'si_title' => $title,
-                               'si_text' => $text
+                               'si_title' => $this->normalizeText( $title ),
+                               'si_text' => $this->normalizeText( $text )
                        ), __METHOD__ );
        }
 
@@ -304,50 +351,106 @@ class SearchMySQL extends SearchEngine {
         * @param $id Integer
         * @param $title String
         */
-    function updateTitle( $id, $title ) {
+       function updateTitle( $id, $title ) {
                $dbw = wfGetDB( DB_MASTER );
 
                $dbw->update( 'searchindex',
-                       array( 'si_title' => $title ),
+                       array( 'si_title' => $this->normalizeText( $title ) ),
                        array( 'si_page'  => $id ),
                        __METHOD__,
                        array( $dbw->lowPriorityOption() ) );
        }
-}
 
-/**
- * @ingroup Search
- */
-class MySQLSearchResultSet extends SearchResultSet {
-       function MySQLSearchResultSet( $resultSet, $terms, $totalHits=null ) {
-               $this->mResultSet = $resultSet;
-               $this->mTerms = $terms;
-               $this->mTotalHits = $totalHits;
-       }
+       /**
+        * Converts some characters for MySQL's indexing to grok it correctly,
+        * and pads short words to overcome limitations.
+        */
+       function normalizeText( $string ) {
+               global $wgContLang;
+
+               wfProfileIn( __METHOD__ );
+
+               $out = parent::normalizeText( $string );
+
+               // MySQL fulltext index doesn't grok utf-8, so we
+               // need to fold cases and convert to hex
+               $out = preg_replace_callback(
+                       "/([\\xc0-\\xff][\\x80-\\xbf]*)/",
+                       array( $this, 'stripForSearchCallback' ),
+                       $wgContLang->lc( $out ) );
+
+               // And to add insult to injury, the default indexing
+               // ignores short words... Pad them so we can pass them
+               // through without reconfiguring the server...
+               $minLength = $this->minSearchLength();
+               if( $minLength > 1 ) {
+                       $n = $minLength - 1;
+                       $out = preg_replace(
+                               "/\b(\w{1,$n})\b/",
+                               "$1u800",
+                               $out );
+               }
 
-       function termMatches() {
-               return $this->mTerms;
+               // Periods within things like hostnames and IP addresses
+               // are also important -- we want a search for "example.com"
+               // or "192.168.1.1" to work sanely.
+               //
+               // MySQL's search seems to ignore them, so you'd match on
+               // "example.wikipedia.com" and "192.168.83.1" as well.
+               $out = preg_replace(
+                       "/(\w)\.(\w|\*)/u",
+                       "$1u82e$2",
+                       $out );
+
+               wfProfileOut( __METHOD__ );
+
+               return $out;
        }
 
-       function numRows() {
-               return $this->mResultSet->numRows();
+       /**
+        * Armor a case-folded UTF-8 string to get through MySQL's
+        * fulltext search without being mucked up by funny charset
+        * settings or anything else of the sort.
+        */
+       protected function stripForSearchCallback( $matches ) {
+               return 'u8' . bin2hex( $matches[1] );
        }
 
-       function next() {
-               $row = $this->mResultSet->fetchObject();
-               if( $row === false ) {
-                       return false;
-               } else {
-                       return new SearchResult( $row );
+       /**
+        * Check MySQL server's ft_min_word_len setting so we know
+        * if we need to pad short words...
+        * 
+        * @return int
+        */
+       protected function minSearchLength() {
+               if( is_null( self::$mMinSearchLength ) ) {
+                       $sql = "SHOW GLOBAL VARIABLES LIKE 'ft\\_min\\_word\\_len'";
+
+                       $dbr = wfGetDB( DB_SLAVE );
+                       $result = $dbr->query( $sql );
+                       $row = $result->fetchObject();
+                       $result->free();
+
+                       if( $row && $row->Variable_name == 'ft_min_word_len' ) {
+                               self::$mMinSearchLength = intval( $row->Value );
+                       } else {
+                               self::$mMinSearchLength = 0;
+                       }
                }
+               return self::$mMinSearchLength;
        }
+}
 
-       function free() {
-               $this->mResultSet->free();
+/**
+ * @ingroup Search
+ */
+class MySQLSearchResultSet extends SqlSearchResultSet {
+       function __construct( $resultSet, $terms, $totalHits=null ) {
+               parent::__construct( $resultSet, $terms );
+               $this->mTotalHits = $totalHits;
        }
 
-       
        function getTotalHits() {
                return $this->mTotalHits;
        }
-}
\ No newline at end of file
+}