MediaWiki REL1_30
ImportReporter.php
Go to the documentation of this file.
1<?php
22
28 private $reason = false;
29 private $logTags = [];
30 private $mOriginalLogCallback = null;
32 private $mLogItemCount = 0;
33
40 function __construct( $importer, $upload, $interwiki, $reason = false ) {
41 $this->mOriginalPageOutCallback =
42 $importer->setPageOutCallback( [ $this, 'reportPage' ] );
43 $this->mOriginalLogCallback =
44 $importer->setLogItemCallback( [ $this, 'reportLogItem' ] );
45 $importer->setNoticeCallback( [ $this, 'reportNotice' ] );
46 $this->mPageCount = 0;
47 $this->mIsUpload = $upload;
48 $this->mInterwiki = $interwiki;
49 $this->reason = $reason;
50 }
51
58 public function setChangeTags( array $tags ) {
59 $this->logTags = $tags;
60 }
61
62 function open() {
63 $this->getOutput()->addHTML( "<ul>\n" );
64 }
65
66 function reportNotice( $msg, array $params ) {
67 $this->getOutput()->addHTML(
68 Html::element( 'li', [], $this->msg( $msg, $params )->text() )
69 );
70 }
71
72 function reportLogItem( /* ... */ ) {
73 $this->mLogItemCount++;
74 if ( is_callable( $this->mOriginalLogCallback ) ) {
75 call_user_func_array( $this->mOriginalLogCallback, func_get_args() );
76 }
77 }
78
87 public function reportPage( $title, $foreignTitle, $revisionCount,
88 $successCount, $pageInfo ) {
89 $args = func_get_args();
90 call_user_func_array( $this->mOriginalPageOutCallback, $args );
91
92 if ( $title === null ) {
93 # Invalid or non-importable title; a notice is already displayed
94 return;
95 }
96
97 $this->mPageCount++;
98 $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
99 if ( $successCount > 0 ) {
100 // <bdi> prevents jumbling of the versions count
101 // in RTL wikis in case the page title is LTR
102 $this->getOutput()->addHTML(
103 "<li>" . $linkRenderer->makeLink( $title ) . " " .
104 "<bdi>" .
105 $this->msg( 'import-revision-count' )->numParams( $successCount )->escaped() .
106 "</bdi>" .
107 "</li>\n"
108 );
109
110 $logParams = [ '4:number:count' => $successCount ];
111 if ( $this->mIsUpload ) {
112 $detail = $this->msg( 'import-logentry-upload-detail' )->numParams(
113 $successCount )->inContentLanguage()->text();
114 $action = 'upload';
115 } else {
116 $pageTitle = $foreignTitle->getFullText();
117 $fullInterwikiPrefix = $this->mInterwiki;
118 Hooks::run( 'ImportLogInterwikiLink', [ &$fullInterwikiPrefix, &$pageTitle ] );
119
120 $interwikiTitleStr = $fullInterwikiPrefix . ':' . $pageTitle;
121 $interwiki = '[[:' . $interwikiTitleStr . ']]';
122 $detail = $this->msg( 'import-logentry-interwiki-detail' )->numParams(
123 $successCount )->params( $interwiki )->inContentLanguage()->text();
124 $action = 'interwiki';
125 $logParams['5:title-link:interwiki'] = $interwikiTitleStr;
126 }
127 if ( $this->reason ) {
128 $detail .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
130 }
131
132 $comment = $detail; // quick
133 $dbw = wfGetDB( DB_MASTER );
134 $latest = $title->getLatestRevID();
135 $nullRevision = Revision::newNullRevision(
136 $dbw,
137 $title->getArticleID(),
138 $comment,
139 true,
140 $this->getUser()
141 );
142
143 $nullRevId = null;
144 if ( !is_null( $nullRevision ) ) {
145 $nullRevId = $nullRevision->insertOn( $dbw );
146 $page = WikiPage::factory( $title );
147 # Update page record
148 $page->updateRevisionOn( $dbw, $nullRevision );
149 Hooks::run(
150 'NewRevisionFromEditComplete',
151 [ $page, $nullRevision, $latest, $this->getUser() ]
152 );
153 }
154
155 // Create the import log entry
156 $logEntry = new ManualLogEntry( 'import', $action );
157 $logEntry->setTarget( $title );
158 $logEntry->setComment( $this->reason );
159 $logEntry->setPerformer( $this->getUser() );
160 $logEntry->setParameters( $logParams );
161 $logid = $logEntry->insert();
162 if ( count( $this->logTags ) ) {
163 $logEntry->setTags( $this->logTags );
164 }
165 // Make sure the null revision will be tagged as well
166 $logEntry->setAssociatedRevId( $nullRevId );
167
168 $logEntry->publish( $logid );
169
170 } else {
171 $this->getOutput()->addHTML( "<li>" . $linkRenderer->makeKnownLink( $title ) . " " .
172 $this->msg( 'import-nonewrevisions' )->escaped() . "</li>\n" );
173 }
174 }
175
176 function close() {
177 $out = $this->getOutput();
178 if ( $this->mLogItemCount > 0 ) {
179 $msg = $this->msg( 'imported-log-entries' )->numParams( $this->mLogItemCount )->parse();
180 $out->addHTML( Xml::tags( 'li', null, $msg ) );
181 } elseif ( $this->mPageCount == 0 && $this->mLogItemCount == 0 ) {
182 $out->addHTML( "</ul>\n" );
183
184 return Status::newFatal( 'importnopages' );
185 }
186 $out->addHTML( "</ul>\n" );
187
188 return Status::newGood( $this->mPageCount );
189 }
190}
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
if( $line===false) $args
Definition cdb.php:63
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
getUser()
Get the User object.
getOutput()
Get the OutputPage object.
Reporting callback.
reportNotice( $msg, array $params)
reportPage( $title, $foreignTitle, $revisionCount, $successCount, $pageInfo)
__construct( $importer, $upload, $interwiki, $reason=false)
setChangeTags(array $tags)
Sets change tags to apply to the import log entry and null revision.
Class for creating log entries manually, to inject them into the database.
Definition LogEntry.php:400
MediaWikiServices is the service locator for the application scope of MediaWiki.
static newNullRevision( $dbw, $pageId, $summary, $minor, $user=null)
Create a new null-revision for insertion into a page's history.
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition WikiPage.php:121
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition design.txt:18
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that probably a stub it is not rendered in wiki pages or galleries in category pages allow injecting custom HTML after the section Any uses of the hook need to handle escaping see BaseTemplate::getToolbox and BaseTemplate::makeListItem for details on the format of individual items inside of this array or by returning and letting standard HTTP rendering take place modifiable or by returning false and taking over the output $out
Definition hooks.txt:862
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return an< a > element with HTML attributes $attribs and contents $html will be returned If you return $ret will be returned and may include noclasses after processing after in associative array form before processing starts Return false to skip default processing and return $ret $linkRenderer
Definition hooks.txt:2026
const DB_MASTER
Definition defines.php:26
$params