ApiMove.php

Go to the documentation of this file.

<?php
use MediaWiki\MainConfigNames;
use MediaWiki\Page\MovePageFactory;
use MediaWiki\User\UserOptionsLookup;
use MediaWiki\Watchlist\WatchlistManager;
use Wikimedia\ParamValidator\ParamValidator;
 
class ApiMove extends ApiBase {
 
    use ApiWatchlistTrait;
 
    private $movePageFactory;
 
    private $repoGroup;
 
    public function __construct(
        ApiMain $mainModule,
        $moduleName,
        MovePageFactory $movePageFactory,
        RepoGroup $repoGroup,
        WatchlistManager $watchlistManager,
        UserOptionsLookup $userOptionsLookup
    ) {
        parent::__construct( $mainModule, $moduleName );
 
        $this->movePageFactory = $movePageFactory;
        $this->repoGroup = $repoGroup;
 
        // Variables needed in ApiWatchlistTrait trait
        $this->watchlistExpiryEnabled = $this->getConfig()->get( MainConfigNames::WatchlistExpiry );
        $this->watchlistMaxDuration =
            $this->getConfig()->get( MainConfigNames::WatchlistExpiryMaxDuration );
        $this->watchlistManager = $watchlistManager;
        $this->userOptionsLookup = $userOptionsLookup;
    }
 
    public function execute() {
        $this->useTransactionalTimeLimit();
 
        $user = $this->getUser();
        $params = $this->extractRequestParams();
 
        $this->requireOnlyOneParameter( $params, 'from', 'fromid' );
 
        if ( isset( $params['from'] ) ) {
            $fromTitle = Title::newFromText( $params['from'] );
            if ( !$fromTitle || $fromTitle->isExternal() ) {
                $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['from'] ) ] );
            }
        } elseif ( isset( $params['fromid'] ) ) {
            $fromTitle = Title::newFromID( $params['fromid'] );
            if ( !$fromTitle ) {
                $this->dieWithError( [ 'apierror-nosuchpageid', $params['fromid'] ] );
            }
        } else {
            throw new LogicException( 'Unreachable due to requireOnlyOneParameter' );
        }
 
        if ( !$fromTitle->exists() ) {
            $this->dieWithError( 'apierror-missingtitle' );
        }
        $fromTalk = $fromTitle->getTalkPage();
 
        $toTitle = Title::newFromText( $params['to'] );
        if ( !$toTitle || $toTitle->isExternal() ) {
            $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['to'] ) ] );
        }
        $toTalk = $toTitle->getTalkPageIfDefined();
 
        if ( $toTitle->getNamespace() === NS_FILE
            && !$this->repoGroup->getLocalRepo()->findFile( $toTitle )
            && $this->repoGroup->findFile( $toTitle )
        ) {
            if ( !$params['ignorewarnings'] &&
                $this->getAuthority()->isAllowed( 'reupload-shared' ) ) {
                $this->dieWithError( 'apierror-fileexists-sharedrepo-perm' );
            } elseif ( !$this->getAuthority()->isAllowed( 'reupload-shared' ) ) {
                $this->dieWithError( 'apierror-cantoverwrite-sharedfile' );
            }
        }
 
        // Rate limit
        if ( $user->pingLimiter( 'move' ) ) {
            $this->dieWithError( 'apierror-ratelimited' );
        }
 
        // Move the page
        $toTitleExists = $toTitle->exists();
        $mp = $this->movePageFactory->newMovePage( $fromTitle, $toTitle );
        $status = $mp->moveIfAllowed(
            $this->getAuthority(),
            $params['reason'],
            !$params['noredirect'],
            $params['tags'] ?: []
        );
        if ( !$status->isOK() ) {
            $this->dieStatus( $status );
        }
 
        $r = [
            'from' => $fromTitle->getPrefixedText(),
            'to' => $toTitle->getPrefixedText(),
            'reason' => $params['reason']
        ];
 
        // NOTE: we assume that if the old title exists, it's because it was re-created as
        // a redirect to the new title. This is not safe, but what we did before was
        // even worse: we just determined whether a redirect should have been created,
        // and reported that it was created if it should have, without any checks.
        $r['redirectcreated'] = $fromTitle->exists();
 
        $r['moveoverredirect'] = $toTitleExists;
 
        // Move the talk page
        if ( $params['movetalk'] && $toTalk && $fromTalk->exists() && !$fromTitle->isTalkPage() ) {
            $toTalkExists = $toTalk->exists();
            $mp = $this->movePageFactory->newMovePage( $fromTalk, $toTalk );
            $status = $mp->moveIfAllowed(
                $this->getAuthority(),
                $params['reason'],
                !$params['noredirect'],
                $params['tags'] ?: []
            );
            if ( $status->isOK() ) {
                $r['talkfrom'] = $fromTalk->getPrefixedText();
                $r['talkto'] = $toTalk->getPrefixedText();
                $r['talkmoveoverredirect'] = $toTalkExists;
            } else {
                // We're not going to dieWithError() on failure, since we already changed something
                $r['talkmove-errors'] = $this->getErrorFormatter()->arrayFromStatus( $status );
            }
        }
 
        $result = $this->getResult();
 
        // Move subpages
        if ( $params['movesubpages'] ) {
            $r['subpages'] = $this->moveSubpages(
                $fromTitle,
                $toTitle,
                $params['reason'],
                $params['noredirect'],
                $params['tags'] ?: []
            );
            ApiResult::setIndexedTagName( $r['subpages'], 'subpage' );
 
            if ( $params['movetalk'] && $toTalk ) {
                $r['subpages-talk'] = $this->moveSubpages(
                    $fromTalk,
                    $toTalk,
                    $params['reason'],
                    $params['noredirect'],
                    $params['tags'] ?: []
                );
                ApiResult::setIndexedTagName( $r['subpages-talk'], 'subpage' );
            }
        }
 
        $watch = $params['watchlist'] ?? 'preferences';
        $watchlistExpiry = $this->getExpiryFromParams( $params );
 
        // Watch pages
        $this->setWatch( $watch, $fromTitle, $user, 'watchmoves', $watchlistExpiry );
        $this->setWatch( $watch, $toTitle, $user, 'watchmoves', $watchlistExpiry );
 
        $result->addValue( null, $this->getModuleName(), $r );
    }
 
    public function moveSubpages( $fromTitle, $toTitle, $reason, $noredirect, $changeTags = [] ) {
        $retval = [];
 
        $mp = $this->movePageFactory->newMovePage( $fromTitle, $toTitle );
        $result =
            $mp->moveSubpagesIfAllowed( $this->getAuthority(), $reason, !$noredirect, $changeTags );
        if ( !$result->isOK() ) {
            // This means the whole thing failed
            return [ 'errors' => $this->getErrorFormatter()->arrayFromStatus( $result ) ];
        }
 
        // At least some pages could be moved
        // Report each of them separately
        foreach ( $result->getValue() as $oldTitle => $status ) {
            $r = [ 'from' => $oldTitle ];
            if ( $status->isOK() ) {
                $r['to'] = $status->getValue();
            } else {
                $r['errors'] = $this->getErrorFormatter()->arrayFromStatus( $status );
            }
            $retval[] = $r;
        }
 
        return $retval;
    }
 
    public function mustBePosted() {
        return true;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function getAllowedParams() {
        $params = [
            'from' => null,
            'fromid' => [
                ParamValidator::PARAM_TYPE => 'integer'
            ],
            'to' => [
                ParamValidator::PARAM_TYPE => 'string',
                ParamValidator::PARAM_REQUIRED => true
            ],
            'reason' => '',
            'movetalk' => false,
            'movesubpages' => false,
            'noredirect' => false,
        ];
 
        // Params appear in the docs in the order they are defined,
        // which is why this is here and not at the bottom.
        $params += $this->getWatchlistParams();
 
        return $params + [
            'ignorewarnings' => false,
            'tags' => [
                ParamValidator::PARAM_TYPE => 'tags',
                ParamValidator::PARAM_ISMULTI => true,
            ],
        ];
    }
 
    public function needsToken() {
        return 'csrf';
    }
 
    protected function getExamplesMessages() {
        return [
            'action=move&from=Badtitle&to=Goodtitle&token=123ABC&' .
                'reason=Misspelled%20title&movetalk=&noredirect='
                => 'apihelp-move-example-move',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Move';
    }
}