ReplaceTextJob.php

Go to the documentation of this file.

<?php
use Wikimedia\ScopedCallback;
 
class ReplaceTextJob extends Job {
    function __construct( $title, $params = '' ) {
        parent::__construct( 'replaceText', $title, $params );
    }
 
    function run() {
        if ( isset( $this->params['session'] ) ) {
            $callback = RequestContext::importScopedSession( $this->params['session'] );
            $this->addTeardownCallback( function () use ( &$callback ) {
                ScopedCallback::consume( $callback );
            } );
        }
 
        if ( is_null( $this->title ) ) {
            $this->error = "replaceText: Invalid title";
            return false;
        }
 
        if ( array_key_exists( 'move_page', $this->params ) ) {
            $current_user = User::newFromId( $this->params['user_id'] );
            $new_title = ReplaceTextSearch::getReplacedTitle(
                $this->title,
                $this->params['target_str'],
                $this->params['replacement_str'],
                $this->params['use_regex']
            );
 
            if ( is_null( $new_title ) ) {
                $this->error = "replaceText: Invalid new title - " . $this->params['replacement_str'];
                return false;
            }
 
            $reason = $this->params['edit_summary'];
            $create_redirect = $this->params['create_redirect'];
            $mvPage = new MovePage( $this->title, $new_title );
            $mvStatus = $mvPage->move( $current_user, $reason, $create_redirect );
            if ( !$mvStatus->isOK() ) {
                $this->error = "replaceText: error while moving: " . $this->title->getPrefixedDBkey() .
                    ". Errors: " . $mvStatus->getWikiText();
                return false;
            }
 
            if ( $this->params['watch_page'] ) {
                WatchAction::doWatch( $new_title, $current_user );
            }
        } else {
            if ( $this->title->getContentModel() !== CONTENT_MODEL_WIKITEXT ) {
                $this->error = 'replaceText: Wiki page "' .
                    $this->title->getPrefixedDBkey() . '" does not hold regular wikitext.';
                return false;
            }
            $wikiPage = new WikiPage( $this->title );
            // Is this check necessary?
            if ( !$wikiPage ) {
                $this->error =
                    'replaceText: Wiki page not found for "' . $this->title->getPrefixedDBkey() . '."';
                return false;
            }
            $wikiPageContent = $wikiPage->getContent();
            if ( is_null( $wikiPageContent ) ) {
                $this->error =
                    'replaceText: No contents found for wiki page at "' . $this->title->getPrefixedDBkey() . '."';
                return false;
            }
            $article_text = $wikiPageContent->getNativeData();
 
            $target_str = $this->params['target_str'];
            $replacement_str = $this->params['replacement_str'];
            $num_matches = 0;
 
            if ( $this->params['use_regex'] ) {
                $new_text =
                    preg_replace( '/' . $target_str . '/Uu', $replacement_str, $article_text, -1, $num_matches );
            } else {
                $new_text = str_replace( $target_str, $replacement_str, $article_text, $num_matches );
            }
 
            // If there's at least one replacement, modify the page,
            // using the passed-in edit summary.
            if ( $num_matches > 0 ) {
                // Change global $wgUser variable to the one
                // specified by the job only for the extent of
                // this replacement.
                global $wgUser;
                $actual_user = $wgUser;
                $wgUser = User::newFromId( $this->params['user_id'] );
                $edit_summary = $this->params['edit_summary'];
                $flags = EDIT_MINOR;
                if ( $wgUser->isAllowed( 'bot' ) ) {
                    $flags |= EDIT_FORCE_BOT;
                }
                if ( isset( $this->params['doAnnounce'] ) &&
                     !$this->params['doAnnounce'] ) {
                    $flags |= EDIT_SUPPRESS_RC;
                    # fixme log this action
                }
                $new_content = new WikitextContent( $new_text );
                $wikiPage->doEditContent( $new_content, $edit_summary, $flags );
                $wgUser = $actual_user;
            }
        }
        return true;
    }
}