ApiMergeHistory.php

Go to the documentation of this file.

<?php
use MediaWiki\Page\MergeHistoryFactory;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Status\Status;
use MediaWiki\Title\Title;
use Wikimedia\ParamValidator\ParamValidator;
 
class ApiMergeHistory extends ApiBase {
 
    private MergeHistoryFactory $mergeHistoryFactory;
 
    public function __construct(
        ApiMain $mainModule,
        $moduleName,
        MergeHistoryFactory $mergeHistoryFactory
    ) {
        parent::__construct( $mainModule, $moduleName );
        $this->mergeHistoryFactory = $mergeHistoryFactory;
    }
 
    public function execute() {
        $this->useTransactionalTimeLimit();
 
        $params = $this->extractRequestParams();
 
        $this->requireOnlyOneParameter( $params, 'from', 'fromid' );
        $this->requireOnlyOneParameter( $params, 'to', 'toid' );
 
        // Get page objects (nonexistent pages get caught in MergeHistory::isValidMerge())
        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'] ] );
            }
        }
 
        if ( isset( $params['to'] ) ) {
            $toTitle = Title::newFromText( $params['to'] );
            if ( !$toTitle || $toTitle->isExternal() ) {
                $this->dieWithError( [ 'apierror-invalidtitle', wfEscapeWikiText( $params['to'] ) ] );
            }
        } elseif ( isset( $params['toid'] ) ) {
            $toTitle = Title::newFromID( $params['toid'] );
            if ( !$toTitle ) {
                $this->dieWithError( [ 'apierror-nosuchpageid', $params['toid'] ] );
            }
        }
 
        $reason = $params['reason'];
        $timestamp = $params['timestamp'];
 
        // Merge!
        // @phan-suppress-next-line PhanTypeMismatchArgumentNullable,PhanPossiblyUndeclaredVariable T240141
        $status = $this->merge( $fromTitle, $toTitle, $timestamp, $reason );
        if ( !$status->isOK() ) {
            $this->dieStatus( $status );
        }
 
        $r = [
            // @phan-suppress-next-line PhanPossiblyUndeclaredVariable T240141
            'from' => $fromTitle->getPrefixedText(),
            // @phan-suppress-next-line PhanPossiblyUndeclaredVariable T240141
            'to' => $toTitle->getPrefixedText(),
            'timestamp' => wfTimestamp( TS_ISO_8601, $params['timestamp'] ),
            'reason' => $params['reason']
        ];
        $result = $this->getResult();
 
        $result->addValue( null, $this->getModuleName(), $r );
    }
 
    protected function merge( PageIdentity $from, PageIdentity $to, $timestamp, $reason ) {
        $mh = $this->mergeHistoryFactory->newMergeHistory( $from, $to, $timestamp );
 
        return $mh->merge( $this->getAuthority(), $reason );
    }
 
    public function mustBePosted() {
        return true;
    }
 
    public function isWriteMode() {
        return true;
    }
 
    public function getAllowedParams() {
        return [
            'from' => null,
            'fromid' => [
                ParamValidator::PARAM_TYPE => 'integer'
            ],
            'to' => null,
            'toid' => [
                ParamValidator::PARAM_TYPE => 'integer'
            ],
            'timestamp' => [
                ParamValidator::PARAM_TYPE => 'timestamp'
            ],
            'reason' => '',
        ];
    }
 
    public function needsToken() {
        return 'csrf';
    }
 
    protected function getExamplesMessages() {
        return [
            'action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&' .
            'reason=Reason'
            => 'apihelp-mergehistory-example-merge',
            'action=mergehistory&from=Oldpage&to=Newpage&token=123ABC&' .
            'reason=Reason&timestamp=2015-12-31T04%3A37%3A41Z' // TODO
            => 'apihelp-mergehistory-example-merge-timestamp',
        ];
    }
 
    public function getHelpUrls() {
        return 'https://www.mediawiki.org/wiki/Special:MyLanguage/API:Mergehistory';
    }
}