Page MenuHomeWickedGov Phorge
Files F1429086

SearchDatabase.php
No OneTemporary
Actions

Size
3 KB
Referenced Files
None
Subscribers
None

SearchDatabase.php
View Options

<?php
/**
* Database search engine
*
* 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
*/
use MediaWiki\Status\Status;
use Wikimedia\Rdbms\DBQueryError;
use Wikimedia\Rdbms\IConnectionProvider;
/**
* Base search engine base class for database-backed searches
* @stable to extend
* @ingroup Search
* @since 1.23
*/
abstract class SearchDatabase extends SearchEngine {
/**
* @var string[] search terms
*/
protected $searchTerms = [];
protected IConnectionProvider $dbProvider;
/**
* @param IConnectionProvider $dbProvider
*/
public function __construct( IConnectionProvider $dbProvider ) {
$this->dbProvider = $dbProvider;
}
/**
* @param string $term
* @return ISearchResultSet|Status|null
*/
final public function doSearchText( $term ) {
return $this->doSearchTextInDB( $this->extractNamespacePrefix( $term ) );
}
/**
* Perform a full text search query and return a result set.
*
* @param string $term Raw search term
* @return SqlSearchResultSet|null
*/
abstract protected function doSearchTextInDB( $term );
/**
* @param string $term
* @return ISearchResultSet|null
*/
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;
}
}
}
/**
* Perform a title-only search query and return a result set.
*
* @param string $term Raw search term
* @return SqlSearchResultSet|null
*/
abstract protected function doSearchTitleInDB( $term );
/**
* Return a 'cleaned up' search string
*
* @param string $text
* @return string
*/
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 ) );
}
/**
* Extract the optional namespace prefix and set self::namespaces
* accordingly and return the query string
* @param string $term
* @return string the query string without any namespace prefix
*/
final protected function extractNamespacePrefix( $term ) {
$queryAndNs = self::parseNamespacePrefixes( $term );
if ( $queryAndNs === false ) {
return $term;
}
$this->namespaces = $queryAndNs[1];
return $queryAndNs[0];
}
}

File Metadata

Mime Type
text/x-php
Expires
Sat, May 16, 17:02 (10 h, 11 m)
Storage Engine
local-disk
Storage Format
Raw Data
Storage Handle
2b/de/d2323967a5b46eea5176cdcfc679
Default Alt Text
SearchDatabase.php (3 KB)

Event Timeline