SearchDatabase.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Search;
 
use MediaWiki\MediaWikiServices;
use MediaWiki\Status\Status;
use Wikimedia\Rdbms\DBQueryError;
use Wikimedia\Rdbms\IConnectionProvider;
 
abstract class SearchDatabase extends SearchEngine {
    protected $searchTerms = [];
    protected IConnectionProvider $dbProvider;
 
    public function __construct( IConnectionProvider $dbProvider ) {
        $this->dbProvider = $dbProvider;
    }
 
    final public function doSearchText( $term ) {
        return $this->doSearchTextInDB( $this->extractNamespacePrefix( $term ) );
    }
 
    abstract protected function doSearchTextInDB( $term );
 
    final public function doSearchTitle( $term ) {
        try {
            return $this->doSearchTitleInDB( $this->extractNamespacePrefix( $term ) );
        } catch ( DBQueryError $dqe ) {
            if ( $dqe->errno == 1064 ) {
                throw new DBQueryError(
                    $dqe->db,
                    "Query incompatible with database engine. For more information: " .
                    "https://bugs.mysql.com/bug.php?id=78485 https://jira.mariadb.org/browse/MDEV-21750 / " .
                    "https://phabricator.wikimedia.org/T355096",
                    1064, $dqe->sql, __METHOD__
                    );
            } else {
                throw $dqe;
            }
        }
    }
 
    abstract protected function doSearchTitleInDB( $term );
 
    protected function filter( $text ) {
        // List of chars allowed in the search query.
        // This must include chars used in the search syntax.
        // Usually " (phrase) or * (wildcards) if supported by the engine
        $lc = $this->legalSearchChars( self::CHARS_ALL );
        return trim( preg_replace( "/[^{$lc}]/", " ", $text ) );
    }
 
    final protected function extractNamespacePrefix( $term ) {
        $queryAndNs = self::parseNamespacePrefixes( $term );
        if ( $queryAndNs === false ) {
            return $term;
        }
        $this->namespaces = $queryAndNs[1];
        return $queryAndNs[0];
    }
 
    protected function regexTerm( string $string, ?string $wildcard = null ): string {
        $regex = preg_quote( $string, '/' );
        if ( MediaWikiServices::getInstance()->getContentLanguage()->hasWordBreaks() ) {
            if ( $wildcard ) {
                // Don't cut off the final bit!
                $regex = "\b$regex";
            } else {
                $regex = "\b$regex\b";
            }
        } else {
            // For Chinese, words may legitimately abut other words in the text literal.
            // Don't add \b boundary checks... note this could cause false positives
            // for Latin chars.
        }
        return $regex;
    }
}
 
class_alias( SearchDatabase::class, 'SearchDatabase' );