MediaWiki REL1_30
MergeHistory.php
Go to the documentation of this file.
1<?php
2
27use Wikimedia\Timestamp\TimestampException;
29
37
39 const REVISION_LIMIT = 5000;
40
42 protected $source;
43
45 protected $dest;
46
48 protected $dbw;
49
51 protected $maxTimestamp;
52
54 protected $timeWhere;
55
57 protected $timestampLimit;
58
61
67 public function __construct( Title $source, Title $dest, $timestamp = false ) {
68 // Save the parameters
69 $this->source = $source;
70 $this->dest = $dest;
71
72 // Get the database
73 $this->dbw = wfGetDB( DB_MASTER );
74
75 // Max timestamp should be min of destination page
76 $firstDestTimestamp = $this->dbw->selectField(
77 'revision',
78 'MIN(rev_timestamp)',
79 [ 'rev_page' => $this->dest->getArticleID() ],
80 __METHOD__
81 );
82 $this->maxTimestamp = new MWTimestamp( $firstDestTimestamp );
83
84 // Get the timestamp pivot condition
85 try {
86 if ( $timestamp ) {
87 // If we have a requested timestamp, use the
88 // latest revision up to that point as the insertion point
89 $mwTimestamp = new MWTimestamp( $timestamp );
90 $lastWorkingTimestamp = $this->dbw->selectField(
91 'revision',
92 'MAX(rev_timestamp)',
93 [
94 'rev_timestamp <= ' .
95 $this->dbw->addQuotes( $this->dbw->timestamp( $mwTimestamp ) ),
96 'rev_page' => $this->source->getArticleID()
97 ],
98 __METHOD__
99 );
100 $mwLastWorkingTimestamp = new MWTimestamp( $lastWorkingTimestamp );
101
102 $timeInsert = $mwLastWorkingTimestamp;
103 $this->timestampLimit = $mwLastWorkingTimestamp;
104 } else {
105 // If we don't, merge entire source page history into the
106 // beginning of destination page history
107
108 // Get the latest timestamp of the source
109 $lastSourceTimestamp = $this->dbw->selectField(
110 [ 'page', 'revision' ],
111 'rev_timestamp',
112 [ 'page_id' => $this->source->getArticleID(),
113 'page_latest = rev_id'
114 ],
115 __METHOD__
116 );
117 $lasttimestamp = new MWTimestamp( $lastSourceTimestamp );
118
119 $timeInsert = $this->maxTimestamp;
120 $this->timestampLimit = $lasttimestamp;
121 }
122
123 $this->timeWhere = "rev_timestamp <= " .
124 $this->dbw->addQuotes( $this->dbw->timestamp( $timeInsert ) );
125 } catch ( TimestampException $ex ) {
126 // The timestamp we got is screwed up and merge cannot continue
127 // This should be detected by $this->isValidMerge()
128 $this->timestampLimit = false;
129 }
130 }
131
136 public function getRevisionCount() {
137 $count = $this->dbw->selectRowCount( 'revision', '1',
138 [ 'rev_page' => $this->source->getArticleID(), $this->timeWhere ],
139 __METHOD__,
140 [ 'LIMIT' => self::REVISION_LIMIT + 1 ]
141 );
142
143 return $count;
144 }
145
151 public function getMergedRevisionCount() {
153 }
154
161 public function checkPermissions( User $user, $reason ) {
162 $status = new Status();
163
164 // Check if user can edit both pages
165 $errors = wfMergeErrorArrays(
166 $this->source->getUserPermissionsErrors( 'edit', $user ),
167 $this->dest->getUserPermissionsErrors( 'edit', $user )
168 );
169
170 // Convert into a Status object
171 if ( $errors ) {
172 foreach ( $errors as $error ) {
173 call_user_func_array( [ $status, 'fatal' ], $error );
174 }
175 }
176
177 // Anti-spam
178 if ( EditPage::matchSummarySpamRegex( $reason ) !== false ) {
179 // This is kind of lame, won't display nice
180 $status->fatal( 'spamprotectiontext' );
181 }
182
183 // Check mergehistory permission
184 if ( !$user->isAllowed( 'mergehistory' ) ) {
185 // User doesn't have the right to merge histories
186 $status->fatal( 'mergehistory-fail-permission' );
187 }
188
189 return $status;
190 }
191
199 public function isValidMerge() {
200 $status = new Status();
201
202 // If either article ID is 0, then revisions cannot be reliably selected
203 if ( $this->source->getArticleID() === 0 ) {
204 $status->fatal( 'mergehistory-fail-invalid-source' );
205 }
206 if ( $this->dest->getArticleID() === 0 ) {
207 $status->fatal( 'mergehistory-fail-invalid-dest' );
208 }
209
210 // Make sure page aren't the same
211 if ( $this->source->equals( $this->dest ) ) {
212 $status->fatal( 'mergehistory-fail-self-merge' );
213 }
214
215 // Make sure the timestamp is valid
216 if ( !$this->timestampLimit ) {
217 $status->fatal( 'mergehistory-fail-bad-timestamp' );
218 }
219
220 // $this->timestampLimit must be older than $this->maxTimestamp
221 if ( $this->timestampLimit > $this->maxTimestamp ) {
222 $status->fatal( 'mergehistory-fail-timestamps-overlap' );
223 }
224
225 // Check that there are not too many revisions to move
226 if ( $this->timestampLimit && $this->getRevisionCount() > self::REVISION_LIMIT ) {
227 $status->fatal( 'mergehistory-fail-toobig', Message::numParam( self::REVISION_LIMIT ) );
228 }
229
230 return $status;
231 }
232
247 public function merge( User $user, $reason = '' ) {
248 $status = new Status();
249
250 // Check validity and permissions required for merge
251 $validCheck = $this->isValidMerge(); // Check this first to check for null pages
252 if ( !$validCheck->isOK() ) {
253 return $validCheck;
254 }
255 $permCheck = $this->checkPermissions( $user, $reason );
256 if ( !$permCheck->isOK() ) {
257 return $permCheck;
258 }
259
260 $this->dbw->update(
261 'revision',
262 [ 'rev_page' => $this->dest->getArticleID() ],
263 [ 'rev_page' => $this->source->getArticleID(), $this->timeWhere ],
264 __METHOD__
265 );
266
267 // Check if this did anything
268 $this->revisionsMerged = $this->dbw->affectedRows();
269 if ( $this->revisionsMerged < 1 ) {
270 $status->fatal( 'mergehistory-fail-no-change' );
271 return $status;
272 }
273
274 // Make the source page a redirect if no revisions are left
275 $haveRevisions = $this->dbw->selectField(
276 'revision',
277 'rev_timestamp',
278 [ 'rev_page' => $this->source->getArticleID() ],
279 __METHOD__,
280 [ 'FOR UPDATE' ]
281 );
282 if ( !$haveRevisions ) {
283 if ( $reason ) {
284 $reason = wfMessage(
285 'mergehistory-comment',
286 $this->source->getPrefixedText(),
287 $this->dest->getPrefixedText(),
288 $reason
289 )->inContentLanguage()->text();
290 } else {
291 $reason = wfMessage(
292 'mergehistory-autocomment',
293 $this->source->getPrefixedText(),
294 $this->dest->getPrefixedText()
295 )->inContentLanguage()->text();
296 }
297
298 $contentHandler = ContentHandler::getForTitle( $this->source );
299 $redirectContent = $contentHandler->makeRedirectContent(
300 $this->dest,
301 wfMessage( 'mergehistory-redirect-text' )->inContentLanguage()->plain()
302 );
303
304 if ( $redirectContent ) {
305 $redirectPage = WikiPage::factory( $this->source );
306 $redirectRevision = new Revision( [
307 'title' => $this->source,
308 'page' => $this->source->getArticleID(),
309 'comment' => $reason,
310 'content' => $redirectContent ] );
311 $redirectRevision->insertOn( $this->dbw );
312 $redirectPage->updateRevisionOn( $this->dbw, $redirectRevision );
313
314 // Now, we record the link from the redirect to the new title.
315 // It should have no other outgoing links...
316 $this->dbw->delete(
317 'pagelinks',
318 [ 'pl_from' => $this->dest->getArticleID() ],
319 __METHOD__
320 );
321 $this->dbw->insert( 'pagelinks',
322 [
323 'pl_from' => $this->dest->getArticleID(),
324 'pl_from_namespace' => $this->dest->getNamespace(),
325 'pl_namespace' => $this->dest->getNamespace(),
326 'pl_title' => $this->dest->getDBkey() ],
327 __METHOD__
328 );
329 } else {
330 // Warning if we couldn't create the redirect
331 $status->warning( 'mergehistory-warning-redirect-not-created' );
332 }
333 } else {
334 $this->source->invalidateCache(); // update histories
335 }
336 $this->dest->invalidateCache(); // update histories
337
338 // Update our logs
339 $logEntry = new ManualLogEntry( 'merge', 'merge' );
340 $logEntry->setPerformer( $user );
341 $logEntry->setComment( $reason );
342 $logEntry->setTarget( $this->source );
343 $logEntry->setParameters( [
344 '4::dest' => $this->dest->getPrefixedText(),
345 '5::mergepoint' => $this->timestampLimit->getTimestamp( TS_MW )
346 ] );
347 $logId = $logEntry->insert();
348 $logEntry->publish( $logId );
349
350 Hooks::run( 'ArticleMergeComplete', [ $this->source, $this->dest ] );
351
352 return $status;
353 }
354}
wfGetDB( $db, $groups=[], $wiki=false)
Get a Database object.
wfMergeErrorArrays()
Merge arrays in the style of getUserPermissionsErrors, with duplicate removal e.g.
static getForTitle(Title $title)
Returns the appropriate ContentHandler singleton for the given title.
static matchSummarySpamRegex( $text)
Check given input text against $wgSummarySpamRegex, and return the text of the first match.
Library for creating and parsing MW-style timestamps.
Class for creating log entries manually, to inject them into the database.
Definition LogEntry.php:400
Handles the backend logic of merging the histories of two pages.
getMergedRevisionCount()
Get the number of revisions that were moved Used in the SpecialMergeHistory success message.
Title $source
Page from which history will be merged.
MWTimestamp $maxTimestamp
Maximum timestamp that we can use (oldest timestamp of dest)
merge(User $user, $reason='')
Actually attempt the history move.
int $revisionsMerged
Number of revisions merged (for Special:MergeHistory success message)
Title $dest
Page to which history will be merged.
MWTimestamp bool $timestampLimit
Timestamp upto which history from the source will be merged.
IDatabase $dbw
Database that we are using.
getRevisionCount()
Get the number of revisions that will be moved.
string $timeWhere
SQL WHERE condition that selects source revisions to insert into destination.
const REVISION_LIMIT
@const int Maximum number of revisions that can be merged at once
__construct(Title $source, Title $dest, $timestamp=false)
isValidMerge()
Does various sanity checks that the merge is valid.
checkPermissions(User $user, $reason)
Check if the merge is possible.
Generic operation result class Has warning/error list, boolean status and arbitrary value.
Definition Status.php:40
Represents a title within MediaWiki.
Definition Title.php:39
The User object encapsulates all of the user-specific settings (user_id, name, rights,...
Definition User.php:51
static factory(Title $title)
Create a WikiPage object of the appropriate class for the given title.
Definition WikiPage.php:121
either a plain
Definition hooks.txt:2026
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 unset offset - wrap String Wrap the message in html(usually something like "&lt;div ...>$1&lt;/div>"). - flags Integer display flags(NO_ACTION_LINK, NO_EXTRA_USER_LINKS) 'LogException':Called before an exception(or PHP error) is logged. This is meant for integration with external error aggregation services
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. '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 'DatabaseOraclePostInit':Called after initialising an Oracle database $db:the DatabaseOracle object '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). '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:1049
Basic database interface for live and lazy-loaded relation database handles.
Definition IDatabase.php:40
const DB_MASTER
Definition defines.php:26