ReplaceTextSearch.php

Go to the documentation of this file.

<?php
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\IResultWrapper;
 
class ReplaceTextSearch {
 
    public static function doSearchQuery(
        $search, $namespaces, $category, $prefix, $use_regex = false
    ) {
        $dbr = wfGetDB( DB_REPLICA );
        $tables = [ 'page', 'revision', 'text' ];
        $vars = [ 'page_id', 'page_namespace', 'page_title', 'old_text' ];
        if ( $use_regex ) {
            $comparisonCond = self::regexCond( $dbr, 'old_text', $search );
        } else {
            $any = $dbr->anyString();
            $comparisonCond = 'old_text ' . $dbr->buildLike( $any, $search, $any );
        }
        $conds = [
            $comparisonCond,
            'page_namespace' => $namespaces,
            'rev_id = page_latest',
            'rev_text_id = old_id'
        ];
 
        self::categoryCondition( $category, $tables, $conds );
        self::prefixCondition( $prefix, $conds );
        $options = [
            'ORDER BY' => 'page_namespace, page_title',
            // 250 seems like a reasonable limit for one screen.
            // @TODO - should probably be a setting.
            'LIMIT' => 250
        ];
 
        return $dbr->select( $tables, $vars, $conds, __METHOD__, $options );
    }
 
    public static function categoryCondition( $category, &$tables, &$conds ) {
        if ( strval( $category ) !== '' ) {
            $category = Title::newFromText( $category )->getDbKey();
            $tables[] = 'categorylinks';
            $conds[] = 'page_id = cl_from';
            $conds['cl_to'] = $category;
        }
    }
 
    public static function prefixCondition( $prefix, &$conds ) {
        if ( strval( $prefix ) === '' ) {
            return;
        }
 
        $dbr = wfGetDB( DB_REPLICA );
        $title = Title::newFromText( $prefix );
        if ( !is_null( $title ) ) {
            $prefix = $title->getDbKey();
        }
        $any = $dbr->anyString();
        $conds[] = 'page_title ' . $dbr->buildLike( $prefix, $any );
    }
 
    public static function regexCond( $dbr, $column, $regex ) {
        if ( $dbr->getType() == 'postgres' ) {
            $op = '~';
        } else {
            $op = 'REGEXP';
        }
        return "$column $op " . $dbr->addQuotes( $regex );
    }
 
    public static function getMatchingTitles(
        $str,
        $namespaces,
        $category,
        $prefix,
        $use_regex = false
    ) {
        $dbr = wfGetDB( DB_REPLICA );
 
        $tables = [ 'page' ];
        $vars = [ 'page_title', 'page_namespace' ];
 
        $str = str_replace( ' ', '_', $str );
        if ( $use_regex ) {
            $comparisonCond = self::regexCond( $dbr, 'page_title', $str );
        } else {
            $any = $dbr->anyString();
            $comparisonCond = 'page_title ' . $dbr->buildLike( $any, $str, $any );
        }
        $conds = [
            $comparisonCond,
            'page_namespace' => $namespaces,
        ];
 
        self::categoryCondition( $category, $tables, $conds );
        self::prefixCondition( $prefix, $conds );
        $sort = [ 'ORDER BY' => 'page_namespace, page_title' ];
 
        return $dbr->select( $tables, $vars, $conds, __METHOD__, $sort );
    }
 
    public static function getReplacedText( $text, $search, $replacement, $regex ) {
        if ( $regex ) {
            $escapedSearch = addcslashes( $search, '/' );
            return preg_replace( "/$escapedSearch/Uu", $replacement, $text );
        } else {
            return str_replace( $search, $replacement, $text );
        }
    }
 
    public static function getReplacedTitle( Title $title, $search, $replacement, $regex ) {
        $oldTitleText = $title->getText();
        $newTitleText = self::getReplacedText( $oldTitleText, $search, $replacement, $regex );
        return Title::makeTitleSafe( $title->getNamespace(), $newTitleText );
    }
}