includes/search/SearchIBM_DB2.php

   1 <?php
   2 /**
   3  * IBM DB2 search engine
   4  *
   5  * Copyright © 2004 Brion Vibber <brion@pobox.com>
   6  * http://www.mediawiki.org/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License as published by
  10  * the Free Software Foundation; either version 2 of the License, or
  11  * (at your option) any later version.
  12  *
  13  * This program is distributed in the hope that it will be useful,
  14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16  * GNU General Public License for more details.
  17  *
  18  * You should have received a copy of the GNU General Public License along
  19  * with this program; if not, write to the Free Software Foundation, Inc.,
  20  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  21  * http://www.gnu.org/copyleft/gpl.html
  22  *
  23  * @file
  24  * @ingroup Search
  25  */
  26
  27 /**
  28  * Search engine hook base class for IBM DB2
  29  * @ingroup Search
  30  */
  31 class SearchIBM_DB2 extends SearchEngine {
  32
  33         /**
  34          * Creates an instance of this class
  35          * @param $db DatabaseIbm_db2: database object
  36          */
  37         function __construct($db) {
  38                 parent::__construct( $db );
  39         }
  40
  41         /**
  42          * Perform a full text search query and return a result set.
  43          *
  44          * @param $term String: raw search term
  45          * @return SqlSearchResultSet
  46          */
  47         function searchText( $term ) {
  48                 $resultSet = $this->db->resultObject($this->db->query($this->getQuery($this->filter($term), true)));
  49                 return new SqlSearchResultSet($resultSet, $this->searchTerms);
  50         }
  51
  52         /**
  53          * Perform a title-only search query and return a result set.
  54          *
  55          * @param $term String: taw search term
  56          * @return SqlSearchResultSet
  57          */
  58         function searchTitle($term) {
  59                 $resultSet = $this->db->resultObject($this->db->query($this->getQuery($this->filter($term), false)));
  60                 return new SqlSearchResultSet($resultSet, $this->searchTerms);
  61         }
  62
  63
  64         /**
  65          * Return a partial WHERE clause to exclude redirects, if so set
  66          * @return String
  67          */
  68         function queryRedirect() {
  69                 if ($this->showRedirects) {
  70                         return '';
  71                 } else {
  72                         return 'AND page_is_redirect=0';
  73                 }
  74         }
  75
  76         /**
  77          * Return a partial WHERE clause to limit the search to the given namespaces
  78          * @return String
  79          */
  80         function queryNamespaces() {
  81                 if( is_null($this->namespaces) )
  82                         return '';
  83                 $namespaces = implode(',', $this->namespaces);
  84                 if ($namespaces == '') {
  85                         $namespaces = '0';
  86                 }
  87                 return 'AND page_namespace IN (' . $namespaces . ')';
  88         }
  89
  90         /**
  91          * Return a LIMIT clause to limit results on the query.
  92          * @return String
  93          */
  94         function queryLimit( $sql ) {
  95                 return $this->db->limitResult($sql, $this->limit, $this->offset);
  96         }
  97
  98         /**
  99          * Does not do anything for generic search engine
 100          * subclasses may define this though
 101          * @return String
 102          */
 103         function queryRanking($filteredTerm, $fulltext) {
 104                 // requires Net Search Extender or equivalent
 105                 // return ' ORDER BY score(1)';
 106                 return '';
 107         }
 108
 109         /**
 110          * Construct the full SQL query to do the search.
 111          * The guts shoulds be constructed in queryMain()
 112          * @param $filteredTerm String
 113          * @param $fulltext Boolean
 114          * @return String
 115          */
 116         function getQuery( $filteredTerm, $fulltext ) {
 117                 return $this->queryLimit($this->queryMain($filteredTerm, $fulltext) . ' ' .
 118                         $this->queryRedirect() . ' ' .
 119                         $this->queryNamespaces() . ' ' .
 120                         $this->queryRanking( $filteredTerm, $fulltext ) . ' ');
 121         }
 122
 123
 124         /**
 125          * Picks which field to index on, depending on what type of query.
 126          * @param $fulltext Boolean
 127          * @return String
 128          */
 129         function getIndexField($fulltext) {
 130                 return $fulltext ? 'si_text' : 'si_title';
 131         }
 132
 133         /**
 134          * Get the base part of the search query.
 135          *
 136          * @param $filteredTerm String
 137          * @param $fulltext Boolean
 138          * @return String
 139          */
 140         function queryMain( $filteredTerm, $fulltext ) {
 141                 $match = $this->parseQuery($filteredTerm, $fulltext);
 142                 $page        = $this->db->tableName('page');
 143                 $searchindex = $this->db->tableName('searchindex');
 144                 return 'SELECT page_id, page_namespace, page_title ' .
 145                         "FROM $page,$searchindex " .
 146                         'WHERE page_id=si_page AND ' . $match;
 147         }
 148
 149         /** @todo document
 150          * @return string
 151          */
 152         function parseQuery($filteredText, $fulltext) {
 153                 global $wgContLang;
 154                 $lc = SearchEngine::legalSearchChars();
 155                 $this->searchTerms = array();
 156
 157                 # @todo FIXME: This doesn't handle parenthetical expressions.
 158                 $m = array();
 159                 $q = array();
 160
 161                 if (preg_match_all('/([-+<>~]?)(([' . $lc . ']+)(\*?)|"[^"]*")/',
 162                           $filteredText, $m, PREG_SET_ORDER)) {
 163                         foreach($m as $terms) {
 164
 165                                 // Search terms in all variant forms, only
 166                                 // apply on wiki with LanguageConverter
 167                                 $temp_terms = $wgContLang->autoConvertToAllVariants( $terms[2] );
 168                                 if( is_array( $temp_terms )) {
 169                                         $temp_terms = array_unique( array_values( $temp_terms ));
 170                                         foreach( $temp_terms as $t )
 171                                                 $q[] = $terms[1] . $wgContLang->normalizeForSearch( $t );
 172                                 }
 173                                 else
 174                                         $q[] = $terms[1] . $wgContLang->normalizeForSearch( $terms[2] );
 175
 176                                 if (!empty($terms[3])) {
 177                                         $regexp = preg_quote( $terms[3], '/' );
 178                                         if ($terms[4])
 179                                                 $regexp .= "[0-9A-Za-z_]+";
 180                                 } else {
 181                                         $regexp = preg_quote(str_replace('"', '', $terms[2]), '/');
 182                                 }
 183                                 $this->searchTerms[] = $regexp;
 184                         }
 185                 }
 186
 187                 $searchon = $this->db->strencode(join(',', $q));
 188                 $field = $this->getIndexField($fulltext);
 189
 190                 // requires Net Search Extender or equivalent
 191                 //return " CONTAINS($field, '$searchon') > 0 ";
 192
 193                 return " lcase($field) LIKE lcase('%$searchon%')";
 194         }
 195
 196         /**
 197          * Create or update the search index record for the given page.
 198          * Title and text should be pre-processed.
 199          *
 200          * @param $id Integer
 201          * @param $title String
 202          * @param $text String
 203          */
 204         function update($id, $title, $text) {
 205                 $dbw = wfGetDB(DB_MASTER);
 206                 $dbw->replace('searchindex',
 207                         array('si_page'),
 208                         array(
 209                                 'si_page' => $id,
 210                                 'si_title' => $title,
 211                                 'si_text' => $text
 212                         ), 'SearchIBM_DB2::update' );
 213                 // ?
 214                 //$dbw->query("CALL ctx_ddl.sync_index('si_text_idx')");
 215                 //$dbw->query("CALL ctx_ddl.sync_index('si_title_idx')");
 216         }
 217
 218         /**
 219          * Update a search index record's title only.
 220          * Title should be pre-processed.
 221          *
 222          * @param $id Integer
 223          * @param $title String
 224          */
 225         function updateTitle($id, $title) {
 226                 $dbw = wfGetDB(DB_MASTER);
 227
 228                 $dbw->update('searchindex',
 229                         array('si_title' => $title),
 230                         array('si_page'  => $id),
 231                         'SearchIBM_DB2::updateTitle',
 232                         array());
 233         }
 234 }