getUser()->isAllowed( 'replacetext' ) ) {
throw new PermissionsError( 'replacetext' );
}
$out = $this->getOutput();
// Replace Text can't be run with certain settings, due to the
// changes they make to the DB storage setup.
if ( $wgCompressRevisions ) {
$errorMsg = "Error: text replacements cannot be run if \$wgCompressRevisions is set to true.";
$out->addWikiTextAsContent( "$errorMsg
" );
return;
}
if ( !empty( $wgExternalStores ) ) {
$errorMsg = "Error: text replacements cannot be run if \$wgExternalStores is non-empty.";
$out->addWikiTextAsContent( "$errorMsg
" );
return;
}
$this->setHeaders();
if ( $out->getResourceLoader()->getModule( 'mediawiki.special' ) !== null ) {
$out->addModuleStyles( 'mediawiki.special' );
}
$this->doSpecialReplaceText();
}
/**
* @return array namespaces selected for search
*/
function getSelectedNamespaces() {
if ( class_exists( MediaWikiServices::class ) ) {
// MW 1.27+
$all_namespaces = MediaWikiServices::getInstance()->getSearchEngineConfig()
->searchableNamespaces();
} else {
/** @phan-suppress-next-line PhanUndeclaredStaticMethod */
$all_namespaces = SearchEngine::searchableNamespaces();
}
$selected_namespaces = [];
foreach ( $all_namespaces as $ns => $name ) {
if ( $this->getRequest()->getCheck( 'ns' . $ns ) ) {
$selected_namespaces[] = $ns;
}
}
return $selected_namespaces;
}
/**
* Do the actual display and logic of Special:ReplaceText.
*/
function doSpecialReplaceText() {
$out = $this->getOutput();
$request = $this->getRequest();
$this->target = $request->getText( 'target' );
$this->replacement = $request->getText( 'replacement' );
$this->use_regex = $request->getBool( 'use_regex' );
$this->category = $request->getText( 'category' );
$this->prefix = $request->getText( 'prefix' );
$this->edit_pages = $request->getBool( 'edit_pages' );
$this->move_pages = $request->getBool( 'move_pages' );
$this->doAnnounce = $request->getBool( 'doAnnounce' );
$this->selected_namespaces = $this->getSelectedNamespaces();
if ( $request->getCheck( 'continue' ) && $this->target === '' ) {
$this->showForm( 'replacetext_givetarget' );
return;
}
if ( $request->getCheck( 'replace' ) ) {
// check for CSRF
$user = $this->getUser();
if ( !$user->matchEditToken( $request->getVal( 'token' ) ) ) {
$out->addWikiMsg( 'sessionfailure' );
return;
}
$jobs = $this->createJobsForTextReplacements();
JobQueueGroup::singleton()->push( $jobs );
$count = $this->getLanguage()->formatNum( count( $jobs ) );
$out->addWikiMsg(
'replacetext_success',
"{$this->target} {$this->replacement} {$this->target} {$this->target} ' .
ReplaceTextUtils::link(
$this->getPageTitle(),
$this->msg( 'replacetext_return' )->text()
)
. '
'
);
} else {
$warning_msg = $this->getAnyWarningMessageBeforeReplace( $titles_for_edit, $titles_for_move );
if ( $warning_msg !== null ) {
$out->addWikiTextAsContent(
"$warning_msg
{$this->replacement} \n$1\n
' );
$out->addWikiMsg( 'replacetext_originaltext' );
$out->addHTML( ' ' );
// 'width: auto' style is needed to override MediaWiki's
// normal 'width: 100%', which causes the textarea to get
// zero width in IE
$out->addHTML(
Xml::textarea( 'target', $this->target, 100, 5, [ 'style' => 'width: auto;' ] )
);
$out->addHTML( ' ' );
$out->addWikiMsg( 'replacetext_replacementtext' );
$out->addHTML( ' ' );
$out->addHTML(
Xml::textarea( 'replacement', $this->replacement, 100, 5, [ 'style' => 'width: auto;' ] )
);
$out->addHTML( '
' );
// MSSQL/SQLServer and SQLite unfortunately lack a REGEXP
// function or operator by default, so disable regex(p)
// searches for both these DB types.
$dbr = wfGetDB( DB_REPLICA );
if ( $dbr->getType() != 'sqlite' && $dbr->getType() != 'mssql' ) {
$out->addHTML( Xml::tags( 'p', null,
Xml::checkLabel(
$this->msg( 'replacetext_useregex' )->text(),
'use_regex', 'use_regex'
)
) . "\n" .
Xml::element( 'p',
[ 'style' => 'font-style: italic' ],
$this->msg( 'replacetext_regexdocu' )->text()
)
);
}
// The interface is heavily based on the one in Special:Search.
if ( class_exists( MediaWikiServices::class ) ) {
// MW 1.27+
$namespaces = MediaWikiServices::getInstance()->getSearchEngineConfig()
->searchableNamespaces();
} else {
/** @phan-suppress-next-line PhanUndeclaredStaticMethod */
$namespaces = SearchEngine::searchableNamespaces();
}
$tables = $this->namespaceTables( $namespaces );
$out->addHTML(
"\n" .
"\n" .
Xml::tags( 'h4', null, $this->msg( 'powersearch-ns' )->parse() )
);
// The ability to select/unselect groups of namespaces in the
// search interface exists only in some skins, like Vector -
// check for the presence of the 'powersearch-togglelabel'
// message to see if we can use this functionality here.
if ( $this->msg( 'powersearch-togglelabel' )->isDisabled() ) {
// do nothing
} else {
$out->addHTML(
Html::element(
'div',
[ 'id' => 'mw-search-togglebox' ]
)
);
}
$out->addHTML(
Xml::element( 'div', [ 'class' => 'divider' ], '', false ) .
"$tables\n "
);
// @todo FIXME: raw html messages
$category_search_label = $this->msg( 'replacetext_categorysearch' )->escaped();
$prefix_search_label = $this->msg( 'replacetext_prefixsearch' )->escaped();
$rcPage = SpecialPage::getTitleFor( 'Recentchanges' );
$rcPageName = $rcPage->getPrefixedText();
$out->addHTML(
"\n" .
Xml::tags( 'h4', null, $this->msg( 'replacetext_optionalfilters' )->parse() ) .
Xml::element( 'div', [ 'class' => 'divider' ], '', false ) .
"$category_search_label\n" .
Xml::input( 'category', 20, $this->category, [ 'type' => 'text' ] ) . '
' .
"$prefix_search_label\n" .
Xml::input( 'prefix', 20, $this->prefix, [ 'type' => 'text' ] ) . '
' .
" \n" .
"\n" .
Xml::checkLabel(
$this->msg( 'replacetext_editpages' )->text(), 'edit_pages', 'edit_pages', true
) . '
\n" .
Xml::submitButton( $this->msg( 'replacetext_continue' )->text() ) .
Xml::closeElement( 'form' )
);
$out->addModules( 'ext.ReplaceText' );
}
/**
* Copied almost exactly from MediaWiki's SpecialSearch class, i.e.
* the search page
* @param string[] $namespaces
* @param int $rowsPerTable
* @return string HTML
*/
function namespaceTables( $namespaces, $rowsPerTable = 3 ) {
global $wgContLang;
// Group namespaces into rows according to subject.
// Try not to make too many assumptions about namespace numbering.
$rows = [];
$tables = "";
foreach ( $namespaces as $ns => $name ) {
$subj = MWNamespace::getSubject( $ns );
if ( !array_key_exists( $subj, $rows ) ) {
$rows[$subj] = "";
}
$name = str_replace( '_', ' ', $name );
if ( '' == $name ) {
$name = $this->msg( 'blanknamespace' )->text();
}
$rows[$subj] .= Xml::openElement( 'td', [ 'style' => 'white-space: nowrap' ] ) .
Xml::checkLabel( $name, "ns{$ns}", "mw-search-ns{$ns}", in_array( $ns, $namespaces ) ) .
Xml::closeElement( 'td' ) . "\n";
}
$rows = array_values( $rows );
$numRows = count( $rows );
// Lay out namespaces in multiple floating two-column tables so they'll
// be arranged nicely while still accommodating different screen widths
// Float to the right on RTL wikis
$tableStyle = $wgContLang->isRTL() ?
'float: right; margin: 0 0 0em 1em' : 'float: left; margin: 0 1em 0em 0';
// Build the final HTML table...
for ( $i = 0; $i < $numRows; $i += $rowsPerTable ) {
$tables .= Xml::openElement( 'table', [ 'style' => $tableStyle ] );
for ( $j = $i; $j < $i + $rowsPerTable && $j < $numRows; $j++ ) {
$tables .= "\n" . $rows[$j] . " ";
}
$tables .= Xml::closeElement( 'table' ) . "\n";
}
return $tables;
}
/**
* @param array $titles_for_edit
* @param array $titles_for_move
* @param array $unmoveable_titles
*/
function pageListForm( $titles_for_edit, $titles_for_move, $unmoveable_titles ) {
global $wgLang;
$out = $this->getOutput();
$formOpts = [
'id' => 'choose_pages',
'method' => 'post',
'action' => $this->getPageTitle()->getFullUrl()
];
$out->addHTML(
Xml::openElement( 'form', $formOpts ) . "\n" .
Html::hidden( 'title', $this->getPageTitle()->getPrefixedText() ) .
Html::hidden( 'target', $this->target ) .
Html::hidden( 'replacement', $this->replacement ) .
Html::hidden( 'use_regex', $this->use_regex ) .
Html::hidden( 'move_pages', $this->move_pages ) .
Html::hidden( 'edit_pages', $this->edit_pages ) .
Html::hidden( 'doAnnounce', $this->doAnnounce ) .
Html::hidden( 'replace', 1 ) .
Html::hidden( 'token', $out->getUser()->getEditToken() )
);
foreach ( $this->selected_namespaces as $ns ) {
$out->addHTML( Html::hidden( 'ns' . $ns, 1 ) );
}
$out->addModules( "ext.ReplaceText" );
$out->addModuleStyles( "ext.ReplaceTextStyles" );
// Needed for bolding of search term.
$out->addModuleStyles( "mediawiki.special.search.styles" );
if ( count( $titles_for_edit ) > 0 ) {
$out->addWikiMsg(
'replacetext_choosepagesforedit',
"{$this->target} {$this->replacement} $context \n";
foreach ( $unmoveable_titles as $title ) {
$text .= "" . ReplaceTextUtils::link( $title ) . " \n";
$out->addHTML( $text );
}
}
/**
* Extract context and highlights search text
*
* @todo The bolding needs to be fixed for regular expressions.
* @param string $text
* @param string $target
* @param bool $use_regex
* @return string
*/
function extractContext( $text, $target, $use_regex = false ) {
global $wgLang;
$cw = $this->getUser()->getOption( 'contextchars', 40 );
// Get all indexes
if ( $use_regex ) {
preg_match_all( "/$target/Uu", $text, $matches, PREG_OFFSET_CAPTURE );
} else {
$targetq = preg_quote( $target, '/' );
preg_match_all( "/$targetq/", $text, $matches, PREG_OFFSET_CAPTURE );
}
$poss = [];
foreach ( $matches[0] as $_ ) {
$poss[] = $_[1];
}
$cuts = [];
// @codingStandardsIgnoreStart
for ( $i = 0; $i < count( $poss ); $i++ ) {
// @codingStandardsIgnoreEnd
$index = $poss[$i];
$len = strlen( $target );
// Merge to the next if possible
while ( isset( $poss[$i + 1] ) ) {
if ( $poss[$i + 1] < $index + $len + $cw * 2 ) {
$len += $poss[$i + 1] - $poss[$i];
$i++;
} else {
// Can't merge, exit the inner loop
break;
}
}
$cuts[] = [ $index, $len ];
}
$context = '';
foreach ( $cuts as $_ ) {
list( $index, $len, ) = $_;
$contextBefore = substr( $text, 0, $index );
$contextAfter = substr( $text, $index + $len );
if ( !is_callable( [ $wgLang, 'truncateForDatabase' ] ) ) {
// Backwards compatibility code; remove once MW 1.30 is
// no longer supported.
$contextBefore =
// @phan-suppress-next-line PhanUndeclaredMethod
$wgLang->truncate( $contextBefore, - $cw, '...', false );
$contextAfter =
// @phan-suppress-next-line PhanUndeclaredMethod
$wgLang->truncate( $contextAfter, $cw, '...', false );
} else {
$contextBefore =
$wgLang->truncateForDatabase( $contextBefore, - $cw, '...', false );
$contextAfter =
$wgLang->truncateForDatabase( $contextAfter, $cw, '...', false );
}
// @phan-suppress-next-line SecurityCheck-DoubleEscaped
$context .= $this->convertWhiteSpaceToHTML( $contextBefore );
$snippet = $this->convertWhiteSpaceToHTML( substr( $text, $index, $len ) );
if ( $use_regex ) {
$targetStr = "/$target/Uu";
} else {
$targetq = preg_quote( $this->convertWhiteSpaceToHTML( $target ), '/' );
$targetStr = "/$targetq/i";
}
$context .= preg_replace( $targetStr, '\0 ', $snippet );
// @phan-suppress-next-line SecurityCheck-DoubleEscaped
$context .= $this->convertWhiteSpaceToHTML( $contextAfter );
}
return $context;
}
private function convertWhiteSpaceToHTML( $message ) {
$msg = htmlspecialchars( $message );
$msg = preg_replace( '/^ /m', ' ', $msg );
$msg = preg_replace( '/ $/m', ' ', $msg );
$msg = preg_replace( '/ /', ' ', $msg );
# $msg = str_replace( "\n", '