5 * Copyright © 2004 Brion Vibber <brion@pobox.com>
6 * https://www.mediawiki.org/
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.
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.
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
27 use MediaWiki\MediaWikiServices
;
30 * Search engine hook base class for Oracle (ConText).
33 class SearchOracle
extends SearchDatabase
{
34 private $reservedWords = [
64 * Perform a full text search query and return a result set.
66 * @param string $term Raw search term
67 * @return SqlSearchResultSet
69 protected function doSearchTextInDB( $term ) {
71 return new SqlSearchResultSet( false, '' );
74 $resultSet = $this->db
->query( $this->getQuery( $this->filter( $term ), true ) );
75 return new SqlSearchResultSet( $resultSet, $this->searchTerms
);
79 * Perform a title-only search query and return a result set.
81 * @param string $term Raw search term
82 * @return SqlSearchResultSet
84 protected function doSearchTitleInDB( $term ) {
86 return new SqlSearchResultSet( false, '' );
89 $resultSet = $this->db
->query( $this->getQuery( $this->filter( $term ), false ) );
90 return new SqlSearchResultSet( $resultSet, $this->searchTerms
);
94 * Return a partial WHERE clause to limit the search to the given namespaces
97 private function queryNamespaces() {
98 if ( is_null( $this->namespaces
) ) {
101 if ( $this->namespaces
=== [] ) {
104 $namespaces = $this->db
->makeList( $this->namespaces
);
106 return 'AND page_namespace IN (' . $namespaces . ')';
110 * Return a LIMIT clause to limit results on the query.
116 private function queryLimit( $sql ) {
117 return $this->db
->limitResult( $sql, $this->limit
, $this->offset
);
121 * Does not do anything for generic search engine
122 * subclasses may define this though
124 * @param string $filteredTerm
125 * @param bool $fulltext
128 function queryRanking( $filteredTerm, $fulltext ) {
129 return ' ORDER BY score(1)';
133 * Construct the full SQL query to do the search.
134 * The guts shoulds be constructed in queryMain()
135 * @param string $filteredTerm
136 * @param bool $fulltext
139 private function getQuery( $filteredTerm, $fulltext ) {
140 return $this->queryLimit( $this->queryMain( $filteredTerm, $fulltext ) . ' ' .
141 $this->queryNamespaces() . ' ' .
142 $this->queryRanking( $filteredTerm, $fulltext ) . ' ' );
146 * Picks which field to index on, depending on what type of query.
147 * @param bool $fulltext
150 private function getIndexField( $fulltext ) {
151 return $fulltext ?
'si_text' : 'si_title';
155 * Get the base part of the search query.
157 * @param string $filteredTerm
158 * @param bool $fulltext
161 function queryMain( $filteredTerm, $fulltext ) {
162 $match = $this->parseQuery( $filteredTerm, $fulltext );
163 $page = $this->db
->tableName( 'page' );
164 $searchindex = $this->db
->tableName( 'searchindex' );
165 return 'SELECT page_id, page_namespace, page_title ' .
166 "FROM $page,$searchindex " .
167 'WHERE page_id=si_page AND ' . $match;
171 * Parse a user input search string, and return an SQL fragment to be used
172 * as part of a WHERE clause
173 * @param string $filteredText
174 * @param bool $fulltext
177 private function parseQuery( $filteredText, $fulltext ) {
178 $lc = $this->legalSearchChars( self
::CHARS_NO_SYNTAX
);
179 $this->searchTerms
= [];
181 # @todo FIXME: This doesn't handle parenthetical expressions.
184 if ( preg_match_all( '/([-+<>~]?)(([' . $lc . ']+)(\*?)|"[^"]*")/',
185 $filteredText, $m, PREG_SET_ORDER
) ) {
186 foreach ( $m as $terms ) {
187 // Search terms in all variant forms, only
188 // apply on wiki with LanguageConverter
189 $temp_terms = MediaWikiServices
::getInstance()->getContentLanguage()->
190 autoConvertToAllVariants( $terms[2] );
191 if ( is_array( $temp_terms ) ) {
192 $temp_terms = array_unique( array_values( $temp_terms ) );
193 foreach ( $temp_terms as $t ) {
194 $searchon .= ( $terms[1] == '-' ?
' ~' : ' & ' ) . $this->escapeTerm( $t );
197 $searchon .= ( $terms[1] == '-' ?
' ~' : ' & ' ) . $this->escapeTerm( $terms[2] );
199 if ( !empty( $terms[3] ) ) {
200 $regexp = preg_quote( $terms[3], '/' );
202 $regexp .= "[0-9A-Za-z_]+";
205 $regexp = preg_quote( str_replace( '"', '', $terms[2] ), '/' );
207 $this->searchTerms
[] = $regexp;
211 $searchon = $this->db
->addQuotes( ltrim( $searchon, ' &' ) );
212 $field = $this->getIndexField( $fulltext );
213 return " CONTAINS($field, $searchon, 1) > 0 ";
216 private function escapeTerm( $t ) {
217 $t = MediaWikiServices
::getInstance()->getContentLanguage()->normalizeForSearch( $t );
218 $t = isset( $this->reservedWords
[strtoupper( $t )] ) ?
'{' . $t . '}' : $t;
219 $t = preg_replace( '/^"(.*)"$/', '($1)', $t );
220 $t = preg_replace( '/([-&|])/', '\\\\$1', $t );
225 * Create or update the search index record for the given page.
226 * Title and text should be pre-processed.
229 * @param string $title
230 * @param string $text
232 function update( $id, $title, $text ) {
233 $dbw = wfGetDB( DB_MASTER
);
234 $dbw->replace( 'searchindex',
238 'si_title' => $title,
240 ], 'SearchOracle::update' );
243 // We need to specify the DB name (i.e. user/schema) here so that
244 // it can work from the installer, where
245 // ALTER SESSION SET CURRENT_SCHEMA = ...
247 $dbw->query( "CALL ctx_ddl.sync_index(" .
248 $dbw->addQuotes( $dbw->getDBname() . '.' . $dbw->tableName( 'si_text_idx', 'raw' ) ) . ")" );
249 $dbw->query( "CALL ctx_ddl.sync_index(" .
250 $dbw->addQuotes( $dbw->getDBname() . '.' . $dbw->tableName( 'si_title_idx', 'raw' ) ) . ")" );
254 * Update a search index record's title only.
255 * Title should be pre-processed.
258 * @param string $title
260 function updateTitle( $id, $title ) {
261 $dbw = wfGetDB( DB_MASTER
);
263 $dbw->update( 'searchindex',
264 [ 'si_title' => $title ],
265 [ 'si_page' => $id ],
266 'SearchOracle::updateTitle',
270 public static function legalSearchChars( $type = self
::CHARS_ALL
) {
271 $searchChars = parent
::legalSearchChars( $type );
272 if ( $type === self
::CHARS_ALL
) {
273 $searchChars = "\"" . $searchChars;