MediaWiki  REL1_31
ImportReporter.php
Go to the documentation of this file.
1 <?php
22 
28  private $reason = false;
29  private $logTags = [];
30  private $mOriginalLogCallback = null;
31  private $mOriginalPageOutCallback = 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()
129  . $this->reason;
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 }
use
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Definition: APACHE-LICENSE-2.0.txt:10
Xml\tags
static tags( $element, $attribs=null, $contents)
Same as Xml::element(), but does not escape contents.
Definition: Xml.php:131
array
the array() calling protocol came about after MediaWiki 1.4rc1.
text
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
ContextSource\msg
msg( $key)
Get a Message object with context set Parameters are the same as wfMessage()
Definition: ContextSource.php:168
ImportReporter\$mOriginalPageOutCallback
$mOriginalPageOutCallback
Definition: ImportReporter.php:31
$out
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:864
StatusValue\newFatal
static newFatal( $message)
Factory function for fatal errors.
Definition: StatusValue.php:68
$params
$params
Definition: styleTest.css.php:40
ImportReporter
Reporting callback.
Definition: ImportReporter.php:27
$linkRenderer
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:2056
ContextSource\getUser
getUser()
Definition: ContextSource.php:120
php
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:37
WikiPage\factory
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
ImportReporter\$logTags
$logTags
Definition: ImportReporter.php:29
ImportReporter\reportLogItem
reportLogItem()
Definition: ImportReporter.php:72
ImportReporter\reportPage
reportPage( $title, $foreignTitle, $revisionCount, $successCount, $pageInfo)
Definition: ImportReporter.php:87
wfGetDB
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Definition: GlobalFunctions.php:2812
ContextSource\getOutput
getOutput()
Definition: ContextSource.php:112
ContextSource
The simplest way of implementing IContextSource is to hold a RequestContext as a member variable and ...
Definition: ContextSource.php:29
ImportReporter\__construct
__construct( $importer, $upload, $interwiki, $reason=false)
Definition: ImportReporter.php:40
$title
namespace and then decline to actually register it file or subcat img or subcat $title
Definition: hooks.txt:964
DB_MASTER
const DB_MASTER
Definition: defines.php:26
ImportReporter\$mOriginalLogCallback
$mOriginalLogCallback
Definition: ImportReporter.php:30
ImportReporter\reportNotice
reportNotice( $msg, array $params)
Definition: ImportReporter.php:66
StatusValue\newGood
static newGood( $value=null)
Factory function for good results.
Definition: StatusValue.php:81
ImportReporter\close
close()
Definition: ImportReporter.php:176
ImportReporter\$reason
$reason
Definition: ImportReporter.php:28
ImportReporter\$mLogItemCount
$mLogItemCount
Definition: ImportReporter.php:32
$args
if( $line===false) $args
Definition: cdb.php:64
ImportReporter\setChangeTags
setChangeTags(array $tags)
Sets change tags to apply to the import log entry and null revision.
Definition: ImportReporter.php:58
ManualLogEntry
Class for creating log entries manually, to inject them into the database.
Definition: LogEntry.php:432
Revision\newNullRevision
static newNullRevision( $dbw, $pageId, $summary, $minor, $user=null)
Create a new null-revision for insertion into a page's history.
Definition: Revision.php:1159
ImportReporter\open
open()
Definition: ImportReporter.php:62
Html\element
static element( $element, $attribs=[], $contents='')
Identical to rawElement(), but HTML-escapes $contents (like Xml::element()).
Definition: Html.php:231
MediaWikiServices
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:25
Hooks\run
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:203