SearchOracle.php

Go to the documentation of this file.

<?php
use MediaWiki\MediaWikiServices;
 
class SearchOracle extends SearchDatabase {
    private $reservedWords = [
        'ABOUT' => 1,
        'ACCUM' => 1,
        'AND' => 1,
        'BT' => 1,
        'BTG' => 1,
        'BTI' => 1,
        'BTP' => 1,
        'FUZZY' => 1,
        'HASPATH' => 1,
        'INPATH' => 1,
        'MINUS' => 1,
        'NEAR' => 1,
        'NOT' => 1,
        'NT' => 1,
        'NTG' => 1,
        'NTI' => 1,
        'NTP' => 1,
        'OR' => 1,
        'PT' => 1,
        'RT' => 1,
        'SQE' => 1,
        'SYN' => 1,
        'TR' => 1,
        'TRSYN' => 1,
        'TT' => 1,
        'WITHIN' => 1,
    ];
 
    protected function doSearchTextInDB( $term ) {
        if ( $term == '' ) {
            return new SqlSearchResultSet( false, '' );
        }
 
        $resultSet = $this->db->query( $this->getQuery( $this->filter( $term ), true ) );
        return new SqlSearchResultSet( $resultSet, $this->searchTerms );
    }
 
    protected function doSearchTitleInDB( $term ) {
        if ( $term == '' ) {
            return new SqlSearchResultSet( false, '' );
        }
 
        $resultSet = $this->db->query( $this->getQuery( $this->filter( $term ), false ) );
        return new SqlSearchResultSet( $resultSet, $this->searchTerms );
    }
 
    private function queryNamespaces() {
        if ( is_null( $this->namespaces ) ) {
            return '';
        }
        if ( $this->namespaces === [] ) {
            $namespaces = '0';
        } else {
            $namespaces = $this->db->makeList( $this->namespaces );
        }
        return 'AND page_namespace IN (' . $namespaces . ')';
    }
 
    private function queryLimit( $sql ) {
        return $this->db->limitResult( $sql, $this->limit, $this->offset );
    }
 
    function queryRanking( $filteredTerm, $fulltext ) {
        return ' ORDER BY score(1)';
    }
 
    private function getQuery( $filteredTerm, $fulltext ) {
        return $this->queryLimit( $this->queryMain( $filteredTerm, $fulltext ) . ' ' .
            $this->queryNamespaces() . ' ' .
            $this->queryRanking( $filteredTerm, $fulltext ) . ' ' );
    }
 
    private function getIndexField( $fulltext ) {
        return $fulltext ? 'si_text' : 'si_title';
    }
 
    function queryMain( $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;
    }
 
    private function parseQuery( $filteredText, $fulltext ) {
        $lc = $this->legalSearchChars( self::CHARS_NO_SYNTAX );
        $this->searchTerms = [];
 
        # @todo FIXME: This doesn't handle parenthetical expressions.
        $m = [];
        $searchon = '';
        if ( preg_match_all( '/([-+<>~]?)(([' . $lc . ']+)(\*?)|"[^"]*")/',
                $filteredText, $m, PREG_SET_ORDER ) ) {
            foreach ( $m as $terms ) {
                // Search terms in all variant forms, only
                // apply on wiki with LanguageConverter
                $temp_terms = MediaWikiServices::getInstance()->getContentLanguage()->
                    autoConvertToAllVariants( $terms[2] );
                if ( is_array( $temp_terms ) ) {
                    $temp_terms = array_unique( array_values( $temp_terms ) );
                    foreach ( $temp_terms as $t ) {
                        $searchon .= ( $terms[1] == '-' ? ' ~' : ' & ' ) . $this->escapeTerm( $t );
                    }
                } else {
                    $searchon .= ( $terms[1] == '-' ? ' ~' : ' & ' ) . $this->escapeTerm( $terms[2] );
                }
                if ( !empty( $terms[3] ) ) {
                    $regexp = preg_quote( $terms[3], '/' );
                    if ( $terms[4] ) {
                        $regexp .= "[0-9A-Za-z_]+";
                    }
                } else {
                    $regexp = preg_quote( str_replace( '"', '', $terms[2] ), '/' );
                }
                $this->searchTerms[] = $regexp;
            }
        }
 
        $searchon = $this->db->addQuotes( ltrim( $searchon, ' &' ) );
        $field = $this->getIndexField( $fulltext );
        return " CONTAINS($field, $searchon, 1) > 0 ";
    }
 
    private function escapeTerm( $t ) {
        $t = MediaWikiServices::getInstance()->getContentLanguage()->normalizeForSearch( $t );
        $t = isset( $this->reservedWords[strtoupper( $t )] ) ? '{' . $t . '}' : $t;
        $t = preg_replace( '/^"(.*)"$/', '($1)', $t );
        $t = preg_replace( '/([-&|])/', '\\\\$1', $t );
        return $t;
    }
 
    function update( $id, $title, $text ) {
        $dbw = wfGetDB( DB_MASTER );
        $dbw->replace( 'searchindex',
            [ 'si_page' ],
            [
                'si_page' => $id,
                'si_title' => $title,
                'si_text' => $text
            ], 'SearchOracle::update' );
 
        // Sync the index
        // We need to specify the DB name (i.e. user/schema) here so that
        // it can work from the installer, where
        //     ALTER SESSION SET CURRENT_SCHEMA = ...
        // was used.
        $dbw->query( "CALL ctx_ddl.sync_index(" .
            $dbw->addQuotes( $dbw->getDBname() . '.' . $dbw->tableName( 'si_text_idx', 'raw' ) ) . ")" );
        $dbw->query( "CALL ctx_ddl.sync_index(" .
            $dbw->addQuotes( $dbw->getDBname() . '.' . $dbw->tableName( 'si_title_idx', 'raw' ) ) . ")" );
    }
 
    function updateTitle( $id, $title ) {
        $dbw = wfGetDB( DB_MASTER );
 
        $dbw->update( 'searchindex',
            [ 'si_title' => $title ],
            [ 'si_page' => $id ],
            'SearchOracle::updateTitle',
            [] );
    }
 
    public static function legalSearchChars( $type = self::CHARS_ALL ) {
        $searchChars = parent::legalSearchChars( $type );
        if ( $type === self::CHARS_ALL ) {
            $searchChars = "\"" . $searchChars;
        }
        return $searchChars;
    }
}