MediaWiki  master
ImportReporter.php
Go to the documentation of this file.
1 <?php
22 
28  private $reason = false;
29  private $logTags = [];
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( ...$args ) {
73  $this->mLogItemCount++;
74  if ( is_callable( $this->mOriginalLogCallback ) ) {
75  call_user_func_array( $this->mOriginalLogCallback, $args );
76  }
77  }
78 
87  public function reportPage( $title, $foreignTitle, $revisionCount,
88  $successCount, $pageInfo ) {
89  call_user_func_array( $this->mOriginalPageOutCallback, func_get_args() );
90 
91  if ( $title === null ) {
92  # Invalid or non-importable title; a notice is already displayed
93  return;
94  }
95 
96  $this->mPageCount++;
97  $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
98  if ( $successCount > 0 ) {
99  // <bdi> prevents jumbling of the versions count
100  // in RTL wikis in case the page title is LTR
101  $this->getOutput()->addHTML(
102  "<li>" . $linkRenderer->makeLink( $title ) . " " .
103  "<bdi>" .
104  $this->msg( 'import-revision-count' )->numParams( $successCount )->escaped() .
105  "</bdi>" .
106  "</li>\n"
107  );
108 
109  $logParams = [ '4:number:count' => $successCount ];
110  if ( $this->mIsUpload ) {
111  $detail = $this->msg( 'import-logentry-upload-detail' )->numParams(
112  $successCount )->inContentLanguage()->text();
113  $action = 'upload';
114  } else {
115  $pageTitle = $foreignTitle->getFullText();
116  $fullInterwikiPrefix = $this->mInterwiki;
117  Hooks::run( 'ImportLogInterwikiLink', [ &$fullInterwikiPrefix, &$pageTitle ] );
118 
119  $interwikiTitleStr = $fullInterwikiPrefix . ':' . $pageTitle;
120  $interwiki = '[[:' . $interwikiTitleStr . ']]';
121  $detail = $this->msg( 'import-logentry-interwiki-detail' )->numParams(
122  $successCount )->params( $interwiki )->inContentLanguage()->text();
123  $action = 'interwiki';
124  $logParams['5:title-link:interwiki'] = $interwikiTitleStr;
125  }
126  if ( $this->reason ) {
127  $detail .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
128  . $this->reason;
129  }
130 
131  $comment = $detail; // quick
132  $dbw = wfGetDB( DB_MASTER );
133  $latest = $title->getLatestRevID();
134  $nullRevision = Revision::newNullRevision(
135  $dbw,
136  $title->getArticleID(),
137  $comment,
138  true,
139  $this->getUser()
140  );
141 
142  $nullRevId = null;
143  if ( !is_null( $nullRevision ) ) {
144  $nullRevId = $nullRevision->insertOn( $dbw );
145  $page = WikiPage::factory( $title );
146  # Update page record
147  $page->updateRevisionOn( $dbw, $nullRevision );
148  Hooks::run(
149  'NewRevisionFromEditComplete',
150  [ $page, $nullRevision, $latest, $this->getUser() ]
151  );
152  }
153 
154  // Create the import log entry
155  $logEntry = new ManualLogEntry( 'import', $action );
156  $logEntry->setTarget( $title );
157  $logEntry->setComment( $this->reason );
158  $logEntry->setPerformer( $this->getUser() );
159  $logEntry->setParameters( $logParams );
160  // Make sure the null revision will be tagged as well
161  $logEntry->setAssociatedRevId( $nullRevId );
162  if ( count( $this->logTags ) ) {
163  $logEntry->setTags( $this->logTags );
164  }
165  $logid = $logEntry->insert();
166  $logEntry->publish( $logid );
167  } else {
168  $this->getOutput()->addHTML( "<li>" . $linkRenderer->makeKnownLink( $title ) . " " .
169  $this->msg( 'import-nonewrevisions' )->escaped() . "</li>\n" );
170  }
171  }
172 
173  function close() {
174  $out = $this->getOutput();
175  if ( $this->mLogItemCount > 0 ) {
176  $msg = $this->msg( 'imported-log-entries' )->numParams( $this->mLogItemCount )->parse();
177  $out->addHTML( Xml::tags( 'li', null, $msg ) );
178  } elseif ( $this->mPageCount == 0 && $this->mLogItemCount == 0 ) {
179  $out->addHTML( "</ul>\n" );
180 
181  return Status::newFatal( 'importnopages' );
182  }
183  $out->addHTML( "</ul>\n" );
184 
185  return Status::newGood( $this->mPageCount );
186  }
187 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
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:1971
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
setChangeTags(array $tags)
Sets change tags to apply to the import log entry and null revision.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency MediaWikiServices
Definition: injection.txt:23
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
This list may contain false positives That usually means there is additional text with links below the first Each row contains links to the first and second as well as the first line of the second redirect text
const DB_MASTER
Definition: defines.php:26
__construct( $importer, $upload, $interwiki, $reason=false)
if( $line===false) $args
Definition: cdb.php:64
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not it can be in the form of< username >< more info > e g for bot passwords intended to be added to log contexts Fields it might only if the login was with a bot password 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:767
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
$params
static tags( $element, $attribs, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:130
reportNotice( $msg, array $params)
this hook is for auditing only or null if authentication failed before getting that far or null if we can t even determine that When $user is not null
Definition: hooks.txt:767
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:912
injection txt This is an overview of how MediaWiki makes use of dependency injection The design described here grew from the discussion of RFC T384 The term dependency this means that anything an object needs to operate should be injected from the the object itself should only know narrow no concrete implementation of the logic it relies on The requirement to inject everything typically results in an architecture that based on two main types of and essentially stateless service objects that use other service objects to operate on the value objects As of the beginning MediaWiki is only starting to use the DI approach Much of the code still relies on global state or direct resulting in a highly cyclical dependency which acts as the top level factory for services in MediaWiki which can be used to gain access to default instances of various services MediaWikiServices however also allows new services to be defined and default services to be redefined Services are defined or redefined by providing a callback the instantiator that will return a new instance of the service When it will create an instance of MediaWikiServices and populate it with the services defined in the files listed by thereby bootstrapping the DI framework Per $wgServiceWiringFiles lists includes ServiceWiring php
Definition: injection.txt:35
reportLogItem(... $args)
Reporting callback.
reportPage( $title, $foreignTitle, $revisionCount, $successCount, $pageInfo)
static newNullRevision( $dbw, $pageId, $summary, $minor, $user=null)
Create a new null-revision for insertion into a page&#39;s history.
Definition: Revision.php:1196
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200