MovePage.php

Go to the documentation of this file.

<?php

use MediaWiki\MediaWikiServices;

class MovePage {

    protected $oldTitle;

    protected $newTitle;

    public function __construct( Title $oldTitle, Title $newTitle ) {
        $this->oldTitle = $oldTitle;
        $this->newTitle = $newTitle;
    }

    public function checkPermissions( User $user, $reason ) {
        $status = new Status();

        $errors = wfMergeErrorArrays(
            $this->oldTitle->getUserPermissionsErrors( 'move', $user ),
            $this->oldTitle->getUserPermissionsErrors( 'edit', $user ),
            $this->newTitle->getUserPermissionsErrors( 'move-target', $user ),
            $this->newTitle->getUserPermissionsErrors( 'edit', $user )
        );

        // Convert into a Status object
        if ( $errors ) {
            foreach ( $errors as $error ) {
                call_user_func_array( [ $status, 'fatal' ], $error );
            }
        }

        if ( EditPage::matchSummarySpamRegex( $reason ) !== false ) {
            // This is kind of lame, won't display nice
            $status->fatal( 'spamprotectiontext' );
        }

        $tp = $this->newTitle->getTitleProtection();
        if ( $tp !== false && !$user->isAllowed( $tp['permission'] ) ) {
                $status->fatal( 'cantmove-titleprotected' );
        }

        Hooks::run( 'MovePageCheckPermissions',
            [ $this->oldTitle, $this->newTitle, $user, $reason, $status ]
        );

        return $status;
    }

    public function isValidMove() {
        global $wgContentHandlerUseDB;
        $status = new Status();

        if ( $this->oldTitle->equals( $this->newTitle ) ) {
            $status->fatal( 'selfmove' );
        }
        if ( !$this->oldTitle->isMovable() ) {
            $status->fatal( 'immobile-source-namespace', $this->oldTitle->getNsText() );
        }
        if ( $this->newTitle->isExternal() ) {
            $status->fatal( 'immobile-target-namespace-iw' );
        }
        if ( !$this->newTitle->isMovable() ) {
            $status->fatal( 'immobile-target-namespace', $this->newTitle->getNsText() );
        }

        $oldid = $this->oldTitle->getArticleID();

        if ( strlen( $this->newTitle->getDBkey() ) < 1 ) {
            $status->fatal( 'articleexists' );
        }
        if (
            ( $this->oldTitle->getDBkey() == '' ) ||
            ( !$oldid ) ||
            ( $this->newTitle->getDBkey() == '' )
        ) {
            $status->fatal( 'badarticleerror' );
        }

        # The move is allowed only if (1) the target doesn't exist, or
        # (2) the target is a redirect to the source, and has no history
        # (so we can undo bad moves right after they're done).
        if ( $this->newTitle->getArticleID() && !$this->isValidMoveTarget() ) {
            $status->fatal( 'articleexists' );
        }

        // Content model checks
        if ( !$wgContentHandlerUseDB &&
            $this->oldTitle->getContentModel() !== $this->newTitle->getContentModel() ) {
            // can't move a page if that would change the page's content model
            $status->fatal(
                'bad-target-model',
                ContentHandler::getLocalizedName( $this->oldTitle->getContentModel() ),
                ContentHandler::getLocalizedName( $this->newTitle->getContentModel() )
            );
        } elseif (
            !ContentHandler::getForTitle( $this->oldTitle )->canBeUsedOn( $this->newTitle )
        ) {
            $status->fatal(
                'content-not-allowed-here',
                ContentHandler::getLocalizedName( $this->oldTitle->getContentModel() ),
                $this->newTitle->getPrefixedText()
            );
        }

        // Image-specific checks
        if ( $this->oldTitle->inNamespace( NS_FILE ) ) {
            $status->merge( $this->isValidFileMove() );
        }

        if ( $this->newTitle->inNamespace( NS_FILE ) && !$this->oldTitle->inNamespace( NS_FILE ) ) {
            $status->fatal( 'nonfile-cannot-move-to-file' );
        }

        // Hook for extensions to say a title can't be moved for technical reasons
        Hooks::run( 'MovePageIsValidMove', [ $this->oldTitle, $this->newTitle, $status ] );

        return $status;
    }

    protected function isValidFileMove() {
        $status = new Status();
        $file = wfLocalFile( $this->oldTitle );
        $file->load( File::READ_LATEST );
        if ( $file->exists() ) {
            if ( $this->newTitle->getText() != wfStripIllegalFilenameChars( $this->newTitle->getText() ) ) {
                $status->fatal( 'imageinvalidfilename' );
            }
            if ( !File::checkExtensionCompatibility( $file, $this->newTitle->getDBkey() ) ) {
                $status->fatal( 'imagetypemismatch' );
            }
        }

        if ( !$this->newTitle->inNamespace( NS_FILE ) ) {
            $status->fatal( 'imagenocrossnamespace' );
        }

        return $status;
    }

    protected function isValidMoveTarget() {
        # Is it an existing file?
        if ( $this->newTitle->inNamespace( NS_FILE ) ) {
            $file = wfLocalFile( $this->newTitle );
            $file->load( File::READ_LATEST );
            if ( $file->exists() ) {
                wfDebug( __METHOD__ . ": file exists\n" );
                return false;
            }
        }
        # Is it a redirect with no history?
        if ( !$this->newTitle->isSingleRevRedirect() ) {
            wfDebug( __METHOD__ . ": not a one-rev redirect\n" );
            return false;
        }
        # Get the article text
        $rev = Revision::newFromTitle( $this->newTitle, false, Revision::READ_LATEST );
        if ( !is_object( $rev ) ) {
            return false;
        }
        $content = $rev->getContent();
        # Does the redirect point to the source?
        # Or is it a broken self-redirect, usually caused by namespace collisions?
        $redirTitle = $content ? $content->getRedirectTarget() : null;

        if ( $redirTitle ) {
            if ( $redirTitle->getPrefixedDBkey() !== $this->oldTitle->getPrefixedDBkey() &&
                $redirTitle->getPrefixedDBkey() !== $this->newTitle->getPrefixedDBkey() ) {
                wfDebug( __METHOD__ . ": redirect points to other page\n" );
                return false;
            } else {
                return true;
            }
        } else {
            # Fail safe (not a redirect after all. strange.)
            wfDebug( __METHOD__ . ": failsafe: database says " . $this->newTitle->getPrefixedDBkey() .
                " is a redirect, but it doesn't contain a valid redirect.\n" );
            return false;
        }
    }

    public function move( User $user, $reason, $createRedirect ) {
        global $wgCategoryCollation;

        Hooks::run( 'TitleMove', [ $this->oldTitle, $this->newTitle, $user ] );

        // If it is a file, move it first.
        // It is done before all other moving stuff is done because it's hard to revert.
        $dbw = wfGetDB( DB_MASTER );
        if ( $this->oldTitle->getNamespace() == NS_FILE ) {
            $file = wfLocalFile( $this->oldTitle );
            $file->load( File::READ_LATEST );
            if ( $file->exists() ) {
                $status = $file->move( $this->newTitle );
                if ( !$status->isOK() ) {
                    return $status;
                }
            }
            // Clear RepoGroup process cache
            RepoGroup::singleton()->clearCache( $this->oldTitle );
            RepoGroup::singleton()->clearCache( $this->newTitle ); # clear false negative cache
        }

        $dbw->startAtomic( __METHOD__ );

        Hooks::run( 'TitleMoveStarting', [ $this->oldTitle, $this->newTitle, $user ] );

        $pageid = $this->oldTitle->getArticleID( Title::GAID_FOR_UPDATE );
        $protected = $this->oldTitle->isProtected();

        // Do the actual move; if this fails, it will throw an MWException(!)
        $nullRevision = $this->moveToInternal( $user, $this->newTitle, $reason, $createRedirect );

        // Refresh the sortkey for this row.  Be careful to avoid resetting
        // cl_timestamp, which may disturb time-based lists on some sites.
        // @todo This block should be killed, it's duplicating code
        // from LinksUpdate::getCategoryInsertions() and friends.
        $prefixes = $dbw->select(
            'categorylinks',
            [ 'cl_sortkey_prefix', 'cl_to' ],
            [ 'cl_from' => $pageid ],
            __METHOD__
        );
        if ( $this->newTitle->getNamespace() == NS_CATEGORY ) {
            $type = 'subcat';
        } elseif ( $this->newTitle->getNamespace() == NS_FILE ) {
            $type = 'file';
        } else {
            $type = 'page';
        }
        foreach ( $prefixes as $prefixRow ) {
            $prefix = $prefixRow->cl_sortkey_prefix;
            $catTo = $prefixRow->cl_to;
            $dbw->update( 'categorylinks',
                [
                    'cl_sortkey' => Collation::singleton()->getSortKey(
                            $this->newTitle->getCategorySortkey( $prefix ) ),
                    'cl_collation' => $wgCategoryCollation,
                    'cl_type' => $type,
                    'cl_timestamp=cl_timestamp' ],
                [
                    'cl_from' => $pageid,
                    'cl_to' => $catTo ],
                __METHOD__
            );
        }

        $redirid = $this->oldTitle->getArticleID();

        if ( $protected ) {
            # Protect the redirect title as the title used to be...
            $res = $dbw->select(
                'page_restrictions',
                '*',
                [ 'pr_page' => $pageid ],
                __METHOD__,
                'FOR UPDATE'
            );
            $rowsInsert = [];
            foreach ( $res as $row ) {
                $rowsInsert[] = [
                    'pr_page' => $redirid,
                    'pr_type' => $row->pr_type,
                    'pr_level' => $row->pr_level,
                    'pr_cascade' => $row->pr_cascade,
                    'pr_user' => $row->pr_user,
                    'pr_expiry' => $row->pr_expiry
                ];
            }
            $dbw->insert( 'page_restrictions', $rowsInsert, __METHOD__, [ 'IGNORE' ] );

            // Build comment for log
            $comment = wfMessage(
                'prot_1movedto2',
                $this->oldTitle->getPrefixedText(),
                $this->newTitle->getPrefixedText()
            )->inContentLanguage()->text();
            if ( $reason ) {
                $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
            }

            // reread inserted pr_ids for log relation
            $insertedPrIds = $dbw->select(
                'page_restrictions',
                'pr_id',
                [ 'pr_page' => $redirid ],
                __METHOD__
            );
            $logRelationsValues = [];
            foreach ( $insertedPrIds as $prid ) {
                $logRelationsValues[] = $prid->pr_id;
            }

            // Update the protection log
            $logEntry = new ManualLogEntry( 'protect', 'move_prot' );
            $logEntry->setTarget( $this->newTitle );
            $logEntry->setComment( $comment );
            $logEntry->setPerformer( $user );
            $logEntry->setParameters( [
                '4::oldtitle' => $this->oldTitle->getPrefixedText(),
            ] );
            $logEntry->setRelations( [ 'pr_id' => $logRelationsValues ] );
            $logId = $logEntry->insert();
            $logEntry->publish( $logId );
        }

        // Update *_from_namespace fields as needed
        if ( $this->oldTitle->getNamespace() != $this->newTitle->getNamespace() ) {
            $dbw->update( 'pagelinks',
                [ 'pl_from_namespace' => $this->newTitle->getNamespace() ],
                [ 'pl_from' => $pageid ],
                __METHOD__
            );
            $dbw->update( 'templatelinks',
                [ 'tl_from_namespace' => $this->newTitle->getNamespace() ],
                [ 'tl_from' => $pageid ],
                __METHOD__
            );
            $dbw->update( 'imagelinks',
                [ 'il_from_namespace' => $this->newTitle->getNamespace() ],
                [ 'il_from' => $pageid ],
                __METHOD__
            );
        }

        # Update watchlists
        $oldtitle = $this->oldTitle->getDBkey();
        $newtitle = $this->newTitle->getDBkey();
        $oldsnamespace = MWNamespace::getSubject( $this->oldTitle->getNamespace() );
        $newsnamespace = MWNamespace::getSubject( $this->newTitle->getNamespace() );
        if ( $oldsnamespace != $newsnamespace || $oldtitle != $newtitle ) {
            $store = MediaWikiServices::getInstance()->getWatchedItemStore();
            $store->duplicateAllAssociatedEntries( $this->oldTitle, $this->newTitle );
        }

        Hooks::run(
            'TitleMoveCompleting',
            [ $this->oldTitle, $this->newTitle,
                $user, $pageid, $redirid, $reason, $nullRevision ]
        );

        $dbw->endAtomic( __METHOD__ );

        $params = [
            &$this->oldTitle,
            &$this->newTitle,
            &$user,
            $pageid,
            $redirid,
            $reason,
            $nullRevision
        ];
        // Keep each single hook handler atomic
        DeferredUpdates::addUpdate(
            new AtomicSectionUpdate(
                $dbw,
                __METHOD__,
                function () use ( $params ) {
                    Hooks::run( 'TitleMoveComplete', $params );
                }
            )
        );

        return Status::newGood();
    }

    private function moveToInternal( User $user, &$nt, $reason = '', $createRedirect = true ) {
        global $wgContLang;

        if ( $nt->exists() ) {
            $moveOverRedirect = true;
            $logType = 'move_redir';
        } else {
            $moveOverRedirect = false;
            $logType = 'move';
        }

        if ( $moveOverRedirect ) {
            $overwriteMessage = wfMessage(
                    'delete_and_move_reason',
                    $this->oldTitle->getPrefixedText()
                )->text();
            $newpage = WikiPage::factory( $nt );
            $errs = [];
            $status = $newpage->doDeleteArticleReal(
                $overwriteMessage,
                /* $suppress */ false,
                $nt->getArticleID(),
                /* $commit */ false,
                $errs,
                $user,
                [],
                'delete_redir'
            );

            if ( !$status->isGood() ) {
                throw new MWException( 'Failed to delete page-move revision: ' . $status );
            }

            $nt->resetArticleID( false );
        }

        if ( $createRedirect ) {
            if ( $this->oldTitle->getNamespace() == NS_CATEGORY
                && !wfMessage( 'category-move-redirect-override' )->inContentLanguage()->isDisabled()
            ) {
                $redirectContent = new WikitextContent(
                    wfMessage( 'category-move-redirect-override' )
                        ->params( $nt->getPrefixedText() )->inContentLanguage()->plain() );
            } else {
                $contentHandler = ContentHandler::getForTitle( $this->oldTitle );
                $redirectContent = $contentHandler->makeRedirectContent( $nt,
                    wfMessage( 'move-redirect-text' )->inContentLanguage()->plain() );
            }

            // NOTE: If this page's content model does not support redirects, $redirectContent will be null.
        } else {
            $redirectContent = null;
        }

        // Figure out whether the content model is no longer the default
        $oldDefault = ContentHandler::getDefaultModelFor( $this->oldTitle );
        $contentModel = $this->oldTitle->getContentModel();
        $newDefault = ContentHandler::getDefaultModelFor( $nt );
        $defaultContentModelChanging = ( $oldDefault !== $newDefault
            && $oldDefault === $contentModel );

        // bug 57084: log_page should be the ID of the *moved* page
        $oldid = $this->oldTitle->getArticleID();
        $logTitle = clone $this->oldTitle;

        $logEntry = new ManualLogEntry( 'move', $logType );
        $logEntry->setPerformer( $user );
        $logEntry->setTarget( $logTitle );
        $logEntry->setComment( $reason );
        $logEntry->setParameters( [
            '4::target' => $nt->getPrefixedText(),
            '5::noredir' => $redirectContent ? '0': '1',
        ] );

        $formatter = LogFormatter::newFromEntry( $logEntry );
        $formatter->setContext( RequestContext::newExtraneousContext( $this->oldTitle ) );
        $comment = $formatter->getPlainActionText();
        if ( $reason ) {
            $comment .= wfMessage( 'colon-separator' )->inContentLanguage()->text() . $reason;
        }
        # Truncate for whole multibyte characters.
        $comment = $wgContLang->truncate( $comment, 255 );

        $dbw = wfGetDB( DB_MASTER );

        $oldpage = WikiPage::factory( $this->oldTitle );
        $oldcountable = $oldpage->isCountable();

        $newpage = WikiPage::factory( $nt );

        # Save a null revision in the page's history notifying of the move
        $nullRevision = Revision::newNullRevision( $dbw, $oldid, $comment, true, $user );
        if ( !is_object( $nullRevision ) ) {
            throw new MWException( 'No valid null revision produced in ' . __METHOD__ );
        }

        $nullRevision->insertOn( $dbw );

        # Change the name of the target page:
        $dbw->update( 'page',
            /* SET */ [
                'page_namespace' => $nt->getNamespace(),
                'page_title' => $nt->getDBkey(),
            ],
            /* WHERE */ [ 'page_id' => $oldid ],
            __METHOD__
        );

        if ( !$redirectContent ) {
            // Clean up the old title *before* reset article id - bug 45348
            WikiPage::onArticleDelete( $this->oldTitle );
        }

        $this->oldTitle->resetArticleID( 0 ); // 0 == non existing
        $nt->resetArticleID( $oldid );
        $newpage->loadPageData( WikiPage::READ_LOCKING ); // bug 46397

        $newpage->updateRevisionOn( $dbw, $nullRevision );

        Hooks::run( 'NewRevisionFromEditComplete',
            [ $newpage, $nullRevision, $nullRevision->getParentId(), $user ] );

        $newpage->doEditUpdates( $nullRevision, $user,
            [ 'changed' => false, 'moved' => true, 'oldcountable' => $oldcountable ] );

        // If the default content model changes, we need to populate rev_content_model
        if ( $defaultContentModelChanging ) {
            $dbw->update(
                'revision',
                [ 'rev_content_model' => $contentModel ],
                [ 'rev_page' => $nt->getArticleID(), 'rev_content_model IS NULL' ],
                __METHOD__
            );
        }

        WikiPage::onArticleCreate( $nt );

        # Recreate the redirect, this time in the other direction.
        if ( $redirectContent ) {
            $redirectArticle = WikiPage::factory( $this->oldTitle );
            $redirectArticle->loadFromRow( false, WikiPage::READ_LOCKING ); // bug 46397
            $newid = $redirectArticle->insertOn( $dbw );
            if ( $newid ) { // sanity
                $this->oldTitle->resetArticleID( $newid );
                $redirectRevision = new Revision( [
                    'title' => $this->oldTitle, // for determining the default content model
                    'page' => $newid,
                    'user_text' => $user->getName(),
                    'user' => $user->getId(),
                    'comment' => $comment,
                    'content' => $redirectContent ] );
                $redirectRevision->insertOn( $dbw );
                $redirectArticle->updateRevisionOn( $dbw, $redirectRevision, 0 );

                Hooks::run( 'NewRevisionFromEditComplete',
                    [ $redirectArticle, $redirectRevision, false, $user ] );

                $redirectArticle->doEditUpdates( $redirectRevision, $user, [ 'created' => true ] );
            }
        }

        # Log the move
        $logid = $logEntry->insert();
        $logEntry->publish( $logid );

        return $nullRevision;
    }
}