diff options
Diffstat (limited to 'www/wiki/includes/specials/helpers/ImportReporter.php')
-rw-r--r-- | www/wiki/includes/specials/helpers/ImportReporter.php | 190 |
1 files changed, 190 insertions, 0 deletions
diff --git a/www/wiki/includes/specials/helpers/ImportReporter.php b/www/wiki/includes/specials/helpers/ImportReporter.php new file mode 100644 index 00000000..63addb87 --- /dev/null +++ b/www/wiki/includes/specials/helpers/ImportReporter.php @@ -0,0 +1,190 @@ +<?php +/** + * This program is free software; you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation; either version 2 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License along + * with this program; if not, write to the Free Software Foundation, Inc., + * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. + * http://www.gnu.org/copyleft/gpl.html + * + * @file + */ + +use MediaWiki\MediaWikiServices; + +/** + * Reporting callback + * @ingroup SpecialPage + */ +class ImportReporter extends ContextSource { + private $reason = false; + private $logTags = []; + private $mOriginalLogCallback = null; + private $mOriginalPageOutCallback = null; + private $mLogItemCount = 0; + + /** + * @param WikiImporter $importer + * @param bool $upload + * @param string $interwiki + * @param string|bool $reason + */ + function __construct( $importer, $upload, $interwiki, $reason = false ) { + $this->mOriginalPageOutCallback = + $importer->setPageOutCallback( [ $this, 'reportPage' ] ); + $this->mOriginalLogCallback = + $importer->setLogItemCallback( [ $this, 'reportLogItem' ] ); + $importer->setNoticeCallback( [ $this, 'reportNotice' ] ); + $this->mPageCount = 0; + $this->mIsUpload = $upload; + $this->mInterwiki = $interwiki; + $this->reason = $reason; + } + + /** + * Sets change tags to apply to the import log entry and null revision. + * + * @param array $tags + * @since 1.29 + */ + public function setChangeTags( array $tags ) { + $this->logTags = $tags; + } + + function open() { + $this->getOutput()->addHTML( "<ul>\n" ); + } + + function reportNotice( $msg, array $params ) { + $this->getOutput()->addHTML( + Html::element( 'li', [], $this->msg( $msg, $params )->text() ) + ); + } + + function reportLogItem( /* ... */ ) { + $this->mLogItemCount++; + if ( is_callable( $this->mOriginalLogCallback ) ) { + call_user_func_array( $this->mOriginalLogCallback, func_get_args() ); + } + } + + /** + * @param Title $title + * @param ForeignTitle $foreignTitle + * @param int $revisionCount + * @param int $successCount + * @param array $pageInfo + * @return void + */ + public function reportPage( $title, $foreignTitle, $revisionCount, + $successCount, $pageInfo ) { + $args = func_get_args(); + call_user_func_array( $this->mOriginalPageOutCallback, $args ); + + if ( $title === null ) { + # Invalid or non-importable title; a notice is already displayed + return; + } + + $this->mPageCount++; + $linkRenderer = MediaWikiServices::getInstance()->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( $title ) . " " . + "<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 = $this->mInterwiki; + Hooks::run( 'ImportLogInterwikiLink', [ &$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; + } + + $comment = $detail; // quick + $dbw = wfGetDB( DB_MASTER ); + $latest = $title->getLatestRevID(); + $nullRevision = Revision::newNullRevision( + $dbw, + $title->getArticleID(), + $comment, + true, + $this->getUser() + ); + + $nullRevId = null; + if ( !is_null( $nullRevision ) ) { + $nullRevId = $nullRevision->insertOn( $dbw ); + $page = WikiPage::factory( $title ); + # Update page record + $page->updateRevisionOn( $dbw, $nullRevision ); + Hooks::run( + 'NewRevisionFromEditComplete', + [ $page, $nullRevision, $latest, $this->getUser() ] + ); + } + + // Create the import log entry + $logEntry = new ManualLogEntry( 'import', $action ); + $logEntry->setTarget( $title ); + $logEntry->setComment( $this->reason ); + $logEntry->setPerformer( $this->getUser() ); + $logEntry->setParameters( $logParams ); + $logid = $logEntry->insert(); + if ( count( $this->logTags ) ) { + $logEntry->setTags( $this->logTags ); + } + // Make sure the null revision will be tagged as well + $logEntry->setAssociatedRevId( $nullRevId ); + + $logEntry->publish( $logid ); + + } else { + $this->getOutput()->addHTML( "<li>" . $linkRenderer->makeKnownLink( $title ) . " " . + $this->msg( 'import-nonewrevisions' )->escaped() . "</li>\n" ); + } + } + + function close() { + $out = $this->getOutput(); + if ( $this->mLogItemCount > 0 ) { + $msg = $this->msg( 'imported-log-entries' )->numParams( $this->mLogItemCount )->parse(); + $out->addHTML( Xml::tags( 'li', null, $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 ); + } +} |