MediaWiki  1.28.0
MergeHistory.php
Go to the documentation of this file.
1 <?php
2 
34 class MergeHistory {
35 
37  const REVISION_LIMIT = 5000;
38 
40  protected $source;
41 
43  protected $dest;
44 
46  protected $dbw;
47 
49  protected $maxTimestamp;
50 
52  protected $timeWhere;
53 
55  protected $timestampLimit;
56 
58  protected $revisionsMerged;
59 
66  public function __construct( Title $source, Title $dest, $timestamp = false ) {
67  // Save the parameters
68  $this->source = $source;
69  $this->dest = $dest;
70 
71  // Get the database
72  $this->dbw = wfGetDB( DB_MASTER );
73 
74  // Max timestamp should be min of destination page
75  $firstDestTimestamp = $this->dbw->selectField(
76  'revision',
77  'MIN(rev_timestamp)',
78  [ 'rev_page' => $this->dest->getArticleID() ],
79  __METHOD__
80  );
81  $this->maxTimestamp = new MWTimestamp( $firstDestTimestamp );
82 
83  // Get the timestamp pivot condition
84  try {
85  if ( $timestamp ) {
86  // If we have a requested timestamp, use the
87  // latest revision up to that point as the insertion point
88  $mwTimestamp = new MWTimestamp( $timestamp );
89  $lastWorkingTimestamp = $this->dbw->selectField(
90  'revision',
91  'MAX(rev_timestamp)',
92  [
93  'rev_timestamp <= ' .
94  $this->dbw->addQuotes( $this->dbw->timestamp( $mwTimestamp ) ),
95  'rev_page' => $this->source->getArticleID()
96  ],
97  __METHOD__
98  );
99  $mwLastWorkingTimestamp = new MWTimestamp( $lastWorkingTimestamp );
100 
101  $timeInsert = $mwLastWorkingTimestamp;
102  $this->timestampLimit = $mwLastWorkingTimestamp;
103  } else {
104  // If we don't, merge entire source page history into the
105  // beginning of destination page history
106 
107  // Get the latest timestamp of the source
108  $lastSourceTimestamp = $this->dbw->selectField(
109  [ 'page', 'revision' ],
110  'rev_timestamp',
111  [ 'page_id' => $this->source->getArticleID(),
112  'page_latest = rev_id'
113  ],
114  __METHOD__
115  );
116  $lasttimestamp = new MWTimestamp( $lastSourceTimestamp );
117 
118  $timeInsert = $this->maxTimestamp;
119  $this->timestampLimit = $lasttimestamp;
120  }
121 
122  $this->timeWhere = "rev_timestamp <= " .
123  $this->dbw->addQuotes( $this->dbw->timestamp( $timeInsert ) );
124  } catch ( TimestampException $ex ) {
125  // The timestamp we got is screwed up and merge cannot continue
126  // This should be detected by $this->isValidMerge()
127  $this->timestampLimit = false;
128  }
129  }
130 
135  public function getRevisionCount() {
136  $count = $this->dbw->selectRowCount( 'revision', '1',
137  [ 'rev_page' => $this->source->getArticleID(), $this->timeWhere ],
138  __METHOD__,
139  [ 'LIMIT' => self::REVISION_LIMIT + 1 ]
140  );
141 
142  return $count;
143  }
144 
150  public function getMergedRevisionCount() {
151  return $this->revisionsMerged;
152  }
153 
160  public function checkPermissions( User $user, $reason ) {
161  $status = new Status();
162 
163  // Check if user can edit both pages
164  $errors = wfMergeErrorArrays(
165  $this->source->getUserPermissionsErrors( 'edit', $user ),
166  $this->dest->getUserPermissionsErrors( 'edit', $user )
167  );
168 
169  // Convert into a Status object
170  if ( $errors ) {
171  foreach ( $errors as $error ) {
172  call_user_func_array( [ $status, 'fatal' ], $error );
173  }
174  }
175 
176  // Anti-spam
177  if ( EditPage::matchSummarySpamRegex( $reason ) !== false ) {
178  // This is kind of lame, won't display nice
179  $status->fatal( 'spamprotectiontext' );
180  }
181 
182  // Check mergehistory permission
183  if ( !$user->isAllowed( 'mergehistory' ) ) {
184  // User doesn't have the right to merge histories
185  $status->fatal( 'mergehistory-fail-permission' );
186  }
187 
188  return $status;
189  }
190 
198  public function isValidMerge() {
199  $status = new Status();
200 
201  // If either article ID is 0, then revisions cannot be reliably selected
202  if ( $this->source->getArticleID() === 0 ) {
203  $status->fatal( 'mergehistory-fail-invalid-source' );
204  }
205  if ( $this->dest->getArticleID() === 0 ) {
206  $status->fatal( 'mergehistory-fail-invalid-dest' );
207  }
208 
209  // Make sure page aren't the same
210  if ( $this->source->equals( $this->dest ) ) {
211  $status->fatal( 'mergehistory-fail-self-merge' );
212  }
213 
214  // Make sure the timestamp is valid
215  if ( !$this->timestampLimit ) {
216  $status->fatal( 'mergehistory-fail-bad-timestamp' );
217  }
218 
219  // $this->timestampLimit must be older than $this->maxTimestamp
220  if ( $this->timestampLimit > $this->maxTimestamp ) {
221  $status->fatal( 'mergehistory-fail-timestamps-overlap' );
222  }
223 
224  // Check that there are not too many revisions to move
225  if ( $this->timestampLimit && $this->getRevisionCount() > self::REVISION_LIMIT ) {
226  $status->fatal( 'mergehistory-fail-toobig', Message::numParam( self::REVISION_LIMIT ) );
227  }
228 
229  return $status;
230  }
231 
246  public function merge( User $user, $reason = '' ) {
247  $status = new Status();
248 
249  // Check validity and permissions required for merge
250  $validCheck = $this->isValidMerge(); // Check this first to check for null pages
251  if ( !$validCheck->isOK() ) {
252  return $validCheck;
253  }
254  $permCheck = $this->checkPermissions( $user, $reason );
255  if ( !$permCheck->isOK() ) {
256  return $permCheck;
257  }
258 
259  $this->dbw->update(
260  'revision',
261  [ 'rev_page' => $this->dest->getArticleID() ],
262  [ 'rev_page' => $this->source->getArticleID(), $this->timeWhere ],
263  __METHOD__
264  );
265 
266  // Check if this did anything
267  $this->revisionsMerged = $this->dbw->affectedRows();
268  if ( $this->revisionsMerged < 1 ) {
269  $status->fatal( 'mergehistory-fail-no-change' );
270  return $status;
271  }
272 
273  // Make the source page a redirect if no revisions are left
274  $haveRevisions = $this->dbw->selectField(
275  'revision',
276  'rev_timestamp',
277  [ 'rev_page' => $this->source->getArticleID() ],
278  __METHOD__,
279  [ 'FOR UPDATE' ]
280  );
281  if ( !$haveRevisions ) {
282  if ( $reason ) {
283  $reason = wfMessage(
284  'mergehistory-comment',
285  $this->source->getPrefixedText(),
286  $this->dest->getPrefixedText(),
287  $reason
288  )->inContentLanguage()->text();
289  } else {
290  $reason = wfMessage(
291  'mergehistory-autocomment',
292  $this->source->getPrefixedText(),
293  $this->dest->getPrefixedText()
294  )->inContentLanguage()->text();
295  }
296 
297  $contentHandler = ContentHandler::getForTitle( $this->source );
298  $redirectContent = $contentHandler->makeRedirectContent(
299  $this->dest,
300  wfMessage( 'mergehistory-redirect-text' )->inContentLanguage()->plain()
301  );
302 
303  if ( $redirectContent ) {
304  $redirectPage = WikiPage::factory( $this->source );
305  $redirectRevision = new Revision( [
306  'title' => $this->source,
307  'page' => $this->source->getArticleID(),
308  'comment' => $reason,
309  'content' => $redirectContent ] );
310  $redirectRevision->insertOn( $this->dbw );
311  $redirectPage->updateRevisionOn( $this->dbw, $redirectRevision );
312 
313  // Now, we record the link from the redirect to the new title.
314  // It should have no other outgoing links...
315  $this->dbw->delete(
316  'pagelinks',
317  [ 'pl_from' => $this->dest->getArticleID() ],
318  __METHOD__
319  );
320  $this->dbw->insert( 'pagelinks',
321  [
322  'pl_from' => $this->dest->getArticleID(),
323  'pl_from_namespace' => $this->dest->getNamespace(),
324  'pl_namespace' => $this->dest->getNamespace(),
325  'pl_title' => $this->dest->getDBkey() ],
326  __METHOD__
327  );
328  } else {
329  // Warning if we couldn't create the redirect
330  $status->warning( 'mergehistory-warning-redirect-not-created' );
331  }
332  } else {
333  $this->source->invalidateCache(); // update histories
334  }
335  $this->dest->invalidateCache(); // update histories
336 
337  // Update our logs
338  $logEntry = new ManualLogEntry( 'merge', 'merge' );
339  $logEntry->setPerformer( $user );
340  $logEntry->setComment( $reason );
341  $logEntry->setTarget( $this->source );
342  $logEntry->setParameters( [
343  '4::dest' => $this->dest->getPrefixedText(),
344  '5::mergepoint' => $this->timestampLimit->getTimestamp( TS_MW )
345  ] );
346  $logId = $logEntry->insert();
347  $logEntry->publish( $logId );
348 
349  Hooks::run( 'ArticleMergeComplete', [ $this->source, $this->dest ] );
350 
351  return $status;
352  }
353 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:115
wfGetDB($db, $groups=[], $wiki=false)
Get a Database object.
either a plain
Definition: hooks.txt:1987
Title $dest
Page to which history will be merged.
Title $source
Page from which history will be merged.
const REVISION_LIMIT
int Maximum number of revisions that can be merged at once
merge(User $user, $reason= '')
Actually attempt the history move.
const DB_MASTER
Definition: defines.php:23
static matchSummarySpamRegex($text)
Check given input text against $wgSummarySpamRegex, and return the text of the first match...
Definition: EditPage.php:2304
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
isAllowed($action= '')
Internal mechanics of testing a permission.
Definition: User.php:3443
either a unescaped string or a HtmlArmor object after in associative array form externallinks including delete and has completed for all link tables whether this was an auto creation default is conds Array Extra conditions for the No matching items in log is displayed if loglist is empty msgKey Array If you want a nice box with a set this to the key of the message First element is the message additional optional elements are parameters for the key that are processed with wfMessage() -> params() ->parseAsBlock()-offset Set to overwrite offset parameter in $wgRequest set to ''to unsetoffset-wrap String Wrap the message in html(usually something like"&lt
if($limit) $timestamp
__construct(Title $source, Title $dest, $timestamp=false)
MergeHistory constructor.
getMergedRevisionCount()
Get the number of revisions that were moved Used in the SpecialMergeHistory success message...
const TS_MW
MediaWiki concatenated string timestamp (YYYYMMDDHHMMSS)
Definition: defines.php:11
integer $revisionsMerged
Number of revisions merged (for Special:MergeHistory success message)
static run($event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:131
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:9
please add to it if you re going to add events to the MediaWiki code where normally authentication against an external auth plugin would be creating a local account $user
Definition: hooks.txt:242
MWTimestamp $maxTimestamp
Maximum timestamp that we can use (oldest timestamp of dest)
MWTimestamp bool $timestampLimit
Timestamp upto which history from the source will be merged.
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
Class for creating log entries manually, to inject them into the database.
Definition: LogEntry.php:394
insertOn($dbw)
Insert a new revision into the database, returning the new revision ID number on success and dies hor...
Definition: Revision.php:1396
static numParam($num)
Definition: Message.php:996
null for the local wiki Added should default to null in handler for backwards compatibility add a value to it if you want to add a cookie that have to vary cache options can modify prev or next refreshes the diff cache allow viewing deleted revs difference engine object to be used for diff source
Definition: hooks.txt:1606
string $timeWhere
SQL WHERE condition that selects source revisions to insert into destination.
isValidMerge()
Does various sanity checks that the merge is valid.
getRevisionCount()
Get the number of revisions that will be moved.
this hook is for auditing only RecentChangesLinked and Watchlist RecentChangesLinked and Watchlist e g Watchlist removed from all revisions and log entries to which it was applied This gives extensions a chance to take it off their books as the deletion has already been partly carried out by this point or something similar the user will be unable to create the tag set $status
Definition: hooks.txt:1046
$count
Handles the backend logic of merging the histories of two pages.
IDatabase $dbw
Database that we are using.
Library for creating and parsing MW-style timestamps.
Definition: MWTimestamp.php:31
checkPermissions(User $user, $reason)
Check if the merge is possible.