MediaWiki  master
MergeHistory.php
Go to the documentation of this file.
1 <?php
2 
26 
33 class MergeHistory {
34 
36  const REVISION_LIMIT = 5000;
37 
39  protected $source;
40 
42  protected $dest;
43 
45  protected $dbw;
46 
48  protected $maxTimestamp;
49 
51  protected $timeWhere;
52 
54  protected $timestampLimit;
55 
57  protected $revisionsMerged;
58 
64  public function __construct( Title $source, Title $dest, $timestamp = false ) {
65  // Save the parameters
66  $this->source = $source;
67  $this->dest = $dest;
68 
69  // Get the database
70  $this->dbw = wfGetDB( DB_MASTER );
71 
72  // Max timestamp should be min of destination page
73  $firstDestTimestamp = $this->dbw->selectField(
74  'revision',
75  'MIN(rev_timestamp)',
76  [ 'rev_page' => $this->dest->getArticleID() ],
77  __METHOD__
78  );
79  $this->maxTimestamp = new MWTimestamp( $firstDestTimestamp );
80 
81  // Get the timestamp pivot condition
82  try {
83  if ( $timestamp ) {
84  // If we have a requested timestamp, use the
85  // latest revision up to that point as the insertion point
86  $mwTimestamp = new MWTimestamp( $timestamp );
87  $lastWorkingTimestamp = $this->dbw->selectField(
88  'revision',
89  'MAX(rev_timestamp)',
90  [
91  'rev_timestamp <= ' .
92  $this->dbw->addQuotes( $this->dbw->timestamp( $mwTimestamp ) ),
93  'rev_page' => $this->source->getArticleID()
94  ],
95  __METHOD__
96  );
97  $mwLastWorkingTimestamp = new MWTimestamp( $lastWorkingTimestamp );
98 
99  $timeInsert = $mwLastWorkingTimestamp;
100  $this->timestampLimit = $mwLastWorkingTimestamp;
101  } else {
102  // If we don't, merge entire source page history into the
103  // beginning of destination page history
104 
105  // Get the latest timestamp of the source
106  $lastSourceTimestamp = $this->dbw->selectField(
107  [ 'page', 'revision' ],
108  'rev_timestamp',
109  [ 'page_id' => $this->source->getArticleID(),
110  'page_latest = rev_id'
111  ],
112  __METHOD__
113  );
114  $lasttimestamp = new MWTimestamp( $lastSourceTimestamp );
115 
116  $timeInsert = $this->maxTimestamp;
117  $this->timestampLimit = $lasttimestamp;
118  }
119 
120  $this->timeWhere = "rev_timestamp <= " .
121  $this->dbw->addQuotes( $this->dbw->timestamp( $timeInsert ) );
122  } catch ( TimestampException $ex ) {
123  // The timestamp we got is screwed up and merge cannot continue
124  // This should be detected by $this->isValidMerge()
125  $this->timestampLimit = false;
126  }
127  }
128 
133  public function getRevisionCount() {
134  $count = $this->dbw->selectRowCount( 'revision', '1',
135  [ 'rev_page' => $this->source->getArticleID(), $this->timeWhere ],
136  __METHOD__,
137  [ 'LIMIT' => self::REVISION_LIMIT + 1 ]
138  );
139 
140  return $count;
141  }
142 
148  public function getMergedRevisionCount() {
149  return $this->revisionsMerged;
150  }
151 
158  public function checkPermissions( User $user, $reason ) {
159  $status = new Status();
160 
161  // Check if user can edit both pages
162  $errors = wfMergeErrorArrays(
163  $this->source->getUserPermissionsErrors( 'edit', $user ),
164  $this->dest->getUserPermissionsErrors( 'edit', $user )
165  );
166 
167  // Convert into a Status object
168  if ( $errors ) {
169  foreach ( $errors as $error ) {
170  $status->fatal( ...$error );
171  }
172  }
173 
174  // Anti-spam
175  if ( EditPage::matchSummarySpamRegex( $reason ) !== false ) {
176  // This is kind of lame, won't display nice
177  $status->fatal( 'spamprotectiontext' );
178  }
179 
180  // Check mergehistory permission
181  if ( !$user->isAllowed( 'mergehistory' ) ) {
182  // User doesn't have the right to merge histories
183  $status->fatal( 'mergehistory-fail-permission' );
184  }
185 
186  return $status;
187  }
188 
196  public function isValidMerge() {
197  $status = new Status();
198 
199  // If either article ID is 0, then revisions cannot be reliably selected
200  if ( $this->source->getArticleID() === 0 ) {
201  $status->fatal( 'mergehistory-fail-invalid-source' );
202  }
203  if ( $this->dest->getArticleID() === 0 ) {
204  $status->fatal( 'mergehistory-fail-invalid-dest' );
205  }
206 
207  // Make sure page aren't the same
208  if ( $this->source->equals( $this->dest ) ) {
209  $status->fatal( 'mergehistory-fail-self-merge' );
210  }
211 
212  // Make sure the timestamp is valid
213  if ( !$this->timestampLimit ) {
214  $status->fatal( 'mergehistory-fail-bad-timestamp' );
215  }
216 
217  // $this->timestampLimit must be older than $this->maxTimestamp
218  if ( $this->timestampLimit > $this->maxTimestamp ) {
219  $status->fatal( 'mergehistory-fail-timestamps-overlap' );
220  }
221 
222  // Check that there are not too many revisions to move
223  if ( $this->timestampLimit && $this->getRevisionCount() > self::REVISION_LIMIT ) {
224  $status->fatal( 'mergehistory-fail-toobig', Message::numParam( self::REVISION_LIMIT ) );
225  }
226 
227  return $status;
228  }
229 
244  public function merge( User $user, $reason = '' ) {
245  $status = new Status();
246 
247  // Check validity and permissions required for merge
248  $validCheck = $this->isValidMerge(); // Check this first to check for null pages
249  if ( !$validCheck->isOK() ) {
250  return $validCheck;
251  }
252  $permCheck = $this->checkPermissions( $user, $reason );
253  if ( !$permCheck->isOK() ) {
254  return $permCheck;
255  }
256 
257  $this->dbw->startAtomic( __METHOD__ );
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  $this->dbw->endAtomic( __METHOD__ );
270  $status->fatal( 'mergehistory-fail-no-change' );
271 
272  return $status;
273  }
274 
275  // Make the source page a redirect if no revisions are left
276  $haveRevisions = $this->dbw->lockForUpdate(
277  'revision',
278  [ 'rev_page' => $this->source->getArticleID() ],
279  __METHOD__
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  // Duplicate watchers of the old article to the new article on history merge
338  $store = MediaWikiServices::getInstance()->getWatchedItemStore();
339  $store->duplicateAllAssociatedEntries( $this->source, $this->dest );
340 
341  // Update our logs
342  $logEntry = new ManualLogEntry( 'merge', 'merge' );
343  $logEntry->setPerformer( $user );
344  $logEntry->setComment( $reason );
345  $logEntry->setTarget( $this->source );
346  $logEntry->setParameters( [
347  '4::dest' => $this->dest->getPrefixedText(),
348  '5::mergepoint' => $this->timestampLimit->getTimestamp( TS_MW )
349  ] );
350  $logId = $logEntry->insert();
351  $logEntry->publish( $logId );
352 
353  Hooks::run( 'ArticleMergeComplete', [ $this->source, $this->dest ] );
354 
355  $this->dbw->endAtomic( __METHOD__ );
356 
357  return $status;
358  }
359 }
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition: WikiPage.php:138
either a plain
Definition: hooks.txt:2043
Apache License January AND DISTRIBUTION Definitions License shall mean the terms and conditions for use
Title $dest
Page to which history will be merged.
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
Title $source
Page from which history will be merged.
const REVISION_LIMIT
Maximum number of revisions that can be merged at once.
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
int $revisionsMerged
Number of revisions merged (for Special:MergeHistory success message)
static numParam( $num)
Definition: Message.php:1049
const DB_MASTER
Definition: defines.php:26
The User object encapsulates all of the user-specific settings (user_id, name, rights, email address, options, last login time).
Definition: User.php:48
Status::newGood()` to allow deletion, and then `return false` from the hook function. Ensure you consume the 'ChangeTagAfterDelete' hook to carry out custom deletion actions. $tag:name of the tag $user:user initiating the action & $status:Status object. See above. 'ChangeTagsListActive':Allows you to nominate which of the tags your extension uses are in active use. & $tags:list of all active tags. Append to this array. 'ChangeTagsAfterUpdateTags':Called after tags have been updated with the ChangeTags::updateTags function. Params:$addedTags:tags effectively added in the update $removedTags:tags effectively removed in the update $prevTags:tags that were present prior to the update $rc_id:recentchanges table id $rev_id:revision table id $log_id:logging table id $params:tag params $rc:RecentChange being tagged when the tagging accompanies the action, or null $user:User who performed the tagging when the tagging is subsequent to the action, or null 'ChangeTagsAllowedAdd':Called when checking if a user can add tags to a change. & $allowedTags:List of all the tags the user is allowed to add. Any tags the user wants to add( $addTags) that are not in this array will cause it to fail. You may add or remove tags to this array as required. $addTags:List of tags user intends to add. $user:User who is adding the tags. 'ChangeUserGroups':Called before user groups are changed. $performer:The User who will perform the change $user:The User whose groups will be changed & $add:The groups that will be added & $remove:The groups that will be removed 'Collation::factory':Called if $wgCategoryCollation is an unknown collation. $collationName:Name of the collation in question & $collationObject:Null. Replace with a subclass of the Collation class that implements the collation given in $collationName. 'ConfirmEmailComplete':Called after a user 's email has been confirmed successfully. $user:user(object) whose email is being confirmed 'ContentAlterParserOutput':Modify parser output for a given content object. Called by Content::getParserOutput after parsing has finished. Can be used for changes that depend on the result of the parsing but have to be done before LinksUpdate is called(such as adding tracking categories based on the rendered HTML). $content:The Content to render $title:Title of the page, as context $parserOutput:ParserOutput to manipulate 'ContentGetParserOutput':Customize parser output for a given content object, called by AbstractContent::getParserOutput. May be used to override the normal model-specific rendering of page content. $content:The Content to render $title:Title of the page, as context $revId:The revision ID, as context $options:ParserOptions for rendering. To avoid confusing the parser cache, the output can only depend on parameters provided to this hook function, not on global state. $generateHtml:boolean, indicating whether full HTML should be generated. If false, generation of HTML may be skipped, but other information should still be present in the ParserOutput object. & $output:ParserOutput, to manipulate or replace 'ContentHandlerDefaultModelFor':Called when the default content model is determined for a given title. May be used to assign a different model for that title. $title:the Title in question & $model:the model name. Use with CONTENT_MODEL_XXX constants. 'ContentHandlerForModelID':Called when a ContentHandler is requested for a given content model name, but no entry for that model exists in $wgContentHandlers. Note:if your extension implements additional models via this hook, please use GetContentModels hook to make them known to core. $modeName:the requested content model name & $handler:set this to a ContentHandler object, if desired. 'ContentModelCanBeUsedOn':Called to determine whether that content model can be used on a given page. This is especially useful to prevent some content models to be used in some special location. $contentModel:ID of the content model in question $title:the Title in question. & $ok:Output parameter, whether it is OK to use $contentModel on $title. Handler functions that modify $ok should generally return false to prevent further hooks from further modifying $ok. 'ContribsPager::getQueryInfo':Before the contributions query is about to run & $pager:Pager object for contributions & $queryInfo:The query for the contribs Pager 'ContribsPager::reallyDoQuery':Called before really executing the query for My Contributions & $data:an array of results of all contribs queries $pager:The ContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'ContributionsLineEnding':Called before a contributions HTML line is finished $page:SpecialPage object for contributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'ContributionsToolLinks':Change tool links above Special:Contributions $id:User identifier $title:User page title & $tools:Array of tool links $specialPage:SpecialPage instance for context and services. Can be either SpecialContributions or DeletedContributionsPage. Extensions should type hint against a generic SpecialPage though. 'ConvertContent':Called by AbstractContent::convert when a conversion to another content model is requested. Handler functions that modify $result should generally return false to disable further attempts at conversion. $content:The Content object to be converted. $toModel:The ID of the content model to convert to. $lossy:boolean indicating whether lossy conversion is allowed. & $result:Output parameter, in case the handler function wants to provide a converted Content object. Note that $result->getContentModel() must return $toModel. 'ContentSecurityPolicyDefaultSource':Modify the allowed CSP load sources. This affects all directives except for the script directive. If you want to add a script source, see ContentSecurityPolicyScriptSource hook. & $defaultSrc:Array of Content-Security-Policy allowed sources $policyConfig:Current configuration for the Content-Security-Policy header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyDirectives':Modify the content security policy directives. Use this only if ContentSecurityPolicyDefaultSource and ContentSecurityPolicyScriptSource do not meet your needs. & $directives:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'ContentSecurityPolicyScriptSource':Modify the allowed CSP script sources. Note that you also have to use ContentSecurityPolicyDefaultSource if you want non-script sources to be loaded from whatever you add. & $scriptSrc:Array of CSP directives $policyConfig:Current configuration for the CSP header $mode:ContentSecurityPolicy::REPORT_ONLY_MODE or ContentSecurityPolicy::FULL_MODE depending on type of header 'CustomEditor':When invoking the page editor Return true to allow the normal editor to be used, or false if implementing a custom editor, e.g. for a special namespace, etc. $article:Article being edited $user:User performing the edit 'DeletedContribsPager::reallyDoQuery':Called before really executing the query for Special:DeletedContributions Similar to ContribsPager::reallyDoQuery & $data:an array of results of all contribs queries $pager:The DeletedContribsPager object hooked into $offset:Index offset, inclusive $limit:Exact query limit $descending:Query direction, false for ascending, true for descending 'DeletedContributionsLineEnding':Called before a DeletedContributions HTML line is finished. Similar to ContributionsLineEnding $page:SpecialPage object for DeletedContributions & $ret:the HTML line $row:the DB row for this line & $classes:the classes to add to the surrounding< li > & $attribs:associative array of other HTML attributes for the< li > element. Currently only data attributes reserved to MediaWiki are allowed(see Sanitizer::isReservedDataAttribute). 'DeleteUnknownPreferences':Called by the cleanupPreferences.php maintenance script to build a WHERE clause with which to delete preferences that are not known about. This hook is used by extensions that have dynamically-named preferences that should not be deleted in the usual cleanup process. For example, the Gadgets extension creates preferences prefixed with 'gadget-', and so anything with that prefix is excluded from the deletion. &where:An array that will be passed as the $cond parameter to IDatabase::select() to determine what will be deleted from the user_properties table. $db:The IDatabase object, useful for accessing $db->buildLike() etc. 'DifferenceEngineAfterLoadNewText':called in DifferenceEngine::loadNewText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before returning true from this function. $differenceEngine:DifferenceEngine object 'DifferenceEngineLoadTextAfterNewContentIsLoaded':called in DifferenceEngine::loadText() after the new revision 's content has been loaded into the class member variable $differenceEngine->mNewContent but before checking if the variable 's value is null. This hook can be used to inject content into said class member variable. $differenceEngine:DifferenceEngine object 'DifferenceEngineMarkPatrolledLink':Allows extensions to change the "mark as patrolled" link which is shown both on the diff header as well as on the bottom of a page, usually wrapped in a span element which has class="patrollink". $differenceEngine:DifferenceEngine object & $markAsPatrolledLink:The "mark as patrolled" link HTML(string) $rcid:Recent change ID(rc_id) for this change(int) 'DifferenceEngineMarkPatrolledRCID':Allows extensions to possibly change the rcid parameter. For example the rcid might be set to zero due to the user being the same as the performer of the change but an extension might still want to show it under certain conditions. & $rcid:rc_id(int) of the change or 0 $differenceEngine:DifferenceEngine object $change:RecentChange object $user:User object representing the current user 'DifferenceEngineNewHeader':Allows extensions to change the $newHeader variable, which contains information about the new revision, such as the revision 's author, whether the revision was marked as a minor edit or not, etc. $differenceEngine:DifferenceEngine object & $newHeader:The string containing the various #mw-diff-otitle[1-5] divs, which include things like revision author info, revision comment, RevisionDelete link and more $formattedRevisionTools:Array containing revision tools, some of which may have been injected with the DiffRevisionTools hook $nextlink:String containing the link to the next revision(if any) $status
Definition: hooks.txt:1263
wfMergeErrorArrays(... $args)
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
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 use $formDescriptor instead 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 unset offset - wrap String Wrap the message in html(usually something like "&lt
__construct(Title $source, Title $dest, $timestamp=false)
getMergedRevisionCount()
Get the number of revisions that were moved Used in the SpecialMergeHistory success message...
isAllowed( $action='')
Internal mechanics of testing a permission.
Definition: User.php:3850
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
merge(User $user, $reason='')
Actually attempt the history move.
MWTimestamp $maxTimestamp
Maximum timestamp that we can use (oldest timestamp of dest)
insertOn( $dbw)
Insert a new revision into the database, returning the new revision ID number on success and dies hor...
Definition: Revision.php:1152
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 as strings Extensions should add to this list prev or next refreshes the diff cache allow viewing deleted revs source
Definition: hooks.txt:1637
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
static matchSummarySpamRegex( $text)
Check given input text against $wgSummarySpamRegex, and return the text of the first match...
Definition: EditPage.php:2469
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.
Handles the backend logic of merging the histories of two pages.
IDatabase $dbw
Database that we are using.
return true to allow those checks to and false if checking is done & $user
Definition: hooks.txt:1473
static run( $event, array $args=[], $deprecatedVersion=null)
Call hook functions defined in Hooks::register and $wgHooks.
Definition: Hooks.php:200
checkPermissions(User $user, $reason)
Check if the merge is possible.