ImportReporter.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Specials\Helpers;
 
use MediaWiki\Context\ContextSource;
use MediaWiki\Context\IContextSource;
use MediaWiki\HookContainer\ProtectedHookAccessorTrait;
use MediaWiki\Html\Html;
use MediaWiki\Import\WikiImporter;
use MediaWiki\Logging\ManualLogEntry;
use MediaWiki\MediaWikiServices;
use MediaWiki\Page\PageIdentity;
use MediaWiki\Status\Status;
use MediaWiki\Storage\PageUpdater;
use MediaWiki\Title\ForeignTitle;
use Wikimedia\Message\MessageParam;
use Wikimedia\Message\MessageSpecifier;
 
class ImportReporter extends ContextSource {
    use ProtectedHookAccessorTrait;
 
    private $reason;
    private $logTags = [];
    private $mOriginalLogCallback;
    private $mOriginalPageOutCallback;
    private $mLogItemCount = 0;
    private $mPageCount = 0;
 
    public function __construct(
        WikiImporter $importer,
        private readonly bool $mIsUpload,
        private readonly ?string $mInterwiki,
        string|bool|null $reason = "",
        ?IContextSource $context = null,
    ) {
        if ( $context ) {
            $this->setContext( $context );
        } else {
            wfDeprecated( __METHOD__ . ' without $context', '1.42' );
        }
        $this->mOriginalPageOutCallback =
            $importer->setPageOutCallback( $this->reportPage( ... ) );
        $this->mOriginalLogCallback =
            $importer->setLogItemCallback( $this->reportLogItem( ... ) );
        $importer->setNoticeCallback( $this->reportNotice( ... ) );
        $this->reason = is_string( $reason ) ? $reason : "";
    }
 
    public function setChangeTags( array $tags ) {
        $this->logTags = $tags;
    }
 
    public function open() {
        $this->getOutput()->addHTML( "<ul>\n" );
    }
 
    public function reportNotice( $msg, array $params ) {
        $this->getOutput()->addHTML(
            Html::element( 'li', [], $this->msg( $msg, $params )->text() )
        );
    }
 
    public function reportLogItem( ...$args ) {
        $this->mLogItemCount++;
        if ( is_callable( $this->mOriginalLogCallback ) ) {
            ( $this->mOriginalLogCallback )( ...$args );
        }
    }
 
    public function reportPage( ?PageIdentity $pageIdentity, $foreignTitle, $revisionCount,
            $successCount, $pageInfo ) {
        ( $this->mOriginalPageOutCallback )( $pageIdentity, $foreignTitle, $revisionCount, $successCount, $pageInfo );
 
        if ( $pageIdentity === null ) {
            # Invalid or non-importable title; a notice is already displayed
            return;
        }
 
        $this->mPageCount++;
        $services = MediaWikiServices::getInstance();
        $linkRenderer = $services->getLinkRenderer();
        if ( $successCount > 0 ) {
            // <bdi> prevents jumbling of the versions count
            // in RTL wikis in case the page title is LTR
            $this->getOutput()->addHTML(
                "<li>" . $linkRenderer->makeLink( $pageIdentity ) . " " .
                "<bdi>" .
                $this->msg( 'import-revision-count' )->numParams( $successCount )->escaped() .
                "</bdi>" .
                "</li>\n"
            );
 
            $logParams = [ '4:number:count' => $successCount ];
            if ( $this->mIsUpload ) {
                $detail = $this->msg( 'import-logentry-upload-detail' )->numParams(
                    $successCount )->inContentLanguage()->text();
                $action = 'upload';
            } else {
                $pageTitle = $foreignTitle->getFullText();
                $fullInterwikiPrefix = (string)$this->mInterwiki;
                $this->getHookRunner()->onImportLogInterwikiLink(
                    $fullInterwikiPrefix, $pageTitle );
 
                $interwikiTitleStr = $fullInterwikiPrefix . ':' . $pageTitle;
                $interwiki = '[[:' . $interwikiTitleStr . ']]';
                $detail = $this->msg( 'import-logentry-interwiki-detail' )->numParams(
                    $successCount )->params( $interwiki )->inContentLanguage()->text();
                $action = 'interwiki';
                $logParams['5:title-link:interwiki'] = $interwikiTitleStr;
            }
            if ( $this->reason ) {
                $detail .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
                    . $this->reason;
            }
 
            $wikiPage = $services->getWikiPageFactory()->newFromTitle( $pageIdentity );
            $dummyRevRecord = $wikiPage->newPageUpdater( $this->getUser() )
                ->setCause( PageUpdater::CAUSE_IMPORT )
                ->saveDummyRevision( $detail, EDIT_SILENT | EDIT_MINOR );
 
            // Create the import log entry
            $logEntry = new ManualLogEntry( 'import', $action );
            $logEntry->setTarget( $pageIdentity );
            $logEntry->setComment( $this->reason );
            $logEntry->setPerformer( $this->getUser() );
            $logEntry->setParameters( $logParams );
            // Make sure the dummy revision will be tagged as well
            $logEntry->setAssociatedRevId( $dummyRevRecord->getId() );
            if ( count( $this->logTags ) ) {
                $logEntry->addTags( $this->logTags );
            }
            $logid = $logEntry->insert();
            $logEntry->publish( $logid );
        } else {
            $this->getOutput()->addHTML( "<li>" . $linkRenderer->makeKnownLink( $pageIdentity ) . " " .
                $this->msg( 'import-nonewrevisions' )->escaped() . "</li>\n" );
        }
    }
 
    public function close(): Status {
        $out = $this->getOutput();
        if ( $this->mLogItemCount > 0 ) {
            $msg = $this->msg( 'imported-log-entries' )->numParams( $this->mLogItemCount )->parse();
            $out->addHTML( Html::rawElement( 'li', [], $msg ) );
        } elseif ( $this->mPageCount == 0 && $this->mLogItemCount == 0 ) {
            $out->addHTML( "</ul>\n" );
 
            return Status::newFatal( 'importnopages' );
        }
        $out->addHTML( "</ul>\n" );
 
        return Status::newGood( $this->mPageCount );
    }
}
 
class_alias( ImportReporter::class, 'ImportReporter' );