3 * Special page allowing users with the appropriate permissions to
4 * merge article histories, with some restrictions
13 function wfSpecialMergehistory( $par ) {
16 $form = new MergehistoryForm( $wgRequest, $par );
21 * The HTML form for Special:MergeHistory, which allows users with the appropriate
22 * permissions to view and restore deleted content.
23 * @ingroup SpecialPage
25 class MergehistoryForm
{
26 var $mAction, $mTarget, $mDest, $mTimestamp, $mTargetID, $mDestID, $mComment;
27 var $mTargetObj, $mDestObj;
29 function MergehistoryForm( $request, $par = "" ) {
32 $this->mAction
= $request->getVal( 'action' );
33 $this->mTarget
= $request->getVal( 'target' );
34 $this->mDest
= $request->getVal( 'dest' );
35 $this->mSubmitted
= $request->getBool( 'submitted' );
37 $this->mTargetID
= intval( $request->getVal( 'targetID' ) );
38 $this->mDestID
= intval( $request->getVal( 'destID' ) );
39 $this->mTimestamp
= $request->getVal( 'mergepoint' );
40 if( !preg_match("/[0-9]{14}/",$this->mTimestamp
) ) {
41 $this->mTimestamp
= '';
43 $this->mComment
= $request->getText( 'wpComment' );
45 $this->mMerge
= $request->wasPosted() && $wgUser->matchEditToken( $request->getVal( 'wpEditToken' ) );
47 if( $this->mSubmitted
) {
48 $this->mTargetObj
= Title
::newFromURL( $this->mTarget
);
49 $this->mDestObj
= Title
::newFromURL( $this->mDest
);
51 $this->mTargetObj
= null;
52 $this->mDestObj
= null;
55 $this->preCacheMessages();
59 * As we use the same small set of messages in various methods and that
60 * they are called often, we call them once and save them in $this->message
62 function preCacheMessages() {
63 // Precache various messages
64 if( !isset( $this->message
) ) {
65 $this->message
['last'] = wfMsgExt( 'last', array( 'escape') );
70 global $wgOut, $wgUser;
72 $wgOut->setPagetitle( wfMsgHtml( "mergehistory" ) );
74 if( $this->mTargetID
&& $this->mDestID
&& $this->mAction
=="submit" && $this->mMerge
) {
75 return $this->merge();
78 if ( !$this->mSubmitted
) {
79 $this->showMergeForm();
84 if ( !$this->mTargetObj
instanceof Title
) {
85 $errors[] = wfMsgExt( 'mergehistory-invalid-source', array( 'parse' ) );
86 } elseif( !$this->mTargetObj
->exists() ) {
87 $errors[] = wfMsgExt( 'mergehistory-no-source', array( 'parse' ),
88 wfEscapeWikiText( $this->mTargetObj
->getPrefixedText() )
92 if ( !$this->mDestObj
instanceof Title
) {
93 $errors[] = wfMsgExt( 'mergehistory-invalid-destination', array( 'parse' ) );
94 } elseif( !$this->mDestObj
->exists() ) {
95 $errors[] = wfMsgExt( 'mergehistory-no-destination', array( 'parse' ),
96 wfEscapeWikiText( $this->mDestObj
->getPrefixedText() )
100 // TODO: warn about target = dest?
102 if ( count( $errors ) ) {
103 $this->showMergeForm();
104 $wgOut->addHTML( implode( "\n", $errors ) );
106 $this->showHistory();
111 function showMergeForm() {
112 global $wgOut, $wgScript;
114 $wgOut->addWikiMsg( 'mergehistory-header' );
117 Xml
::openElement( 'form', array(
119 'action' => $wgScript ) ) .
121 Xml
::element( 'legend', array(),
122 wfMsg( 'mergehistory-box' ) ) .
123 Xml
::hidden( 'title',
124 SpecialPage
::getTitleFor( 'Mergehistory' )->getPrefixedDbKey() ) .
125 Xml
::hidden( 'submitted', '1' ) .
126 Xml
::hidden( 'mergepoint', $this->mTimestamp
) .
127 Xml
::openElement( 'table' ) .
129 <td>".Xml
::label( wfMsg( 'mergehistory-from' ), 'target' )."</td>
130 <td>".Xml
::input( 'target', 30, $this->mTarget
, array('id'=>'target') )."</td>
132 <td>".Xml
::label( wfMsg( 'mergehistory-into' ), 'dest' )."</td>
133 <td>".Xml
::input( 'dest', 30, $this->mDest
, array('id'=>'dest') )."</td>
135 Xml
::submitButton( wfMsg( 'mergehistory-go' ) ) .
137 Xml
::closeElement( 'table' ) .
142 private function showHistory() {
143 global $wgLang, $wgContLang, $wgUser, $wgOut;
145 $this->sk
= $wgUser->getSkin();
147 $wgOut->setPagetitle( wfMsg( "mergehistory" ) );
149 $this->showMergeForm();
151 # List all stored revisions
152 $revisions = new MergeHistoryPager( $this, array(), $this->mTargetObj
, $this->mDestObj
);
153 $haveRevisions = $revisions && $revisions->getNumRows() > 0;
155 $titleObj = SpecialPage
::getTitleFor( "Mergehistory" );
156 $action = $titleObj->getLocalURL( "action=submit" );
157 # Start the form here
158 $top = Xml
::openElement( 'form', array( 'method' => 'post', 'action' => $action, 'id' => 'merge' ) );
159 $wgOut->addHtml( $top );
161 if( $haveRevisions ) {
162 # Format the user-visible controls (comment field, submission button)
163 # in a nice little table
164 $align = $wgContLang->isRtl() ?
'left' : 'right';
166 Xml
::openElement( 'fieldset' ) .
167 Xml
::openElement( 'table' ) .
170 wfMsgExt( 'mergehistory-merge', array('parseinline'),
171 $this->mTargetObj
->getPrefixedText(), $this->mDestObj
->getPrefixedText() ) .
175 <td align='$align'>" .
176 Xml
::label( wfMsg( 'undeletecomment' ), 'wpComment' ) .
179 Xml
::input( 'wpComment', 50, $this->mComment
) .
185 Xml
::submitButton( wfMsg( 'mergehistory-submit' ), array( 'name' => 'merge', 'id' => 'mw-merge-submit' ) ) .
188 Xml
::closeElement( 'table' ) .
189 Xml
::closeElement( 'fieldset' );
191 $wgOut->addHtml( $table );
194 $wgOut->addHTML( "<h2 id=\"mw-mergehistory\">" . wfMsgHtml( "mergehistory-list" ) . "</h2>\n" );
196 if( $haveRevisions ) {
197 $wgOut->addHTML( $revisions->getNavigationBar() );
198 $wgOut->addHTML( "<ul>" );
199 $wgOut->addHTML( $revisions->getBody() );
200 $wgOut->addHTML( "</ul>" );
201 $wgOut->addHTML( $revisions->getNavigationBar() );
203 $wgOut->addWikiMsg( "mergehistory-empty" );
206 # Show relevant lines from the deletion log:
207 $wgOut->addHTML( "<h2>" . htmlspecialchars( LogPage
::logName( 'merge' ) ) . "</h2>\n" );
208 LogEventsList
::showLogExtract( $wgOut, 'merge', $this->mTargetObj
->getPrefixedText() );
210 # When we submit, go by page ID to avoid some nasty but unlikely collisions.
211 # Such would happen if a page was renamed after the form loaded, but before submit
212 $misc = Xml
::hidden( 'targetID', $this->mTargetObj
->getArticleID() );
213 $misc .= Xml
::hidden( 'destID', $this->mDestObj
->getArticleID() );
214 $misc .= Xml
::hidden( 'target', $this->mTarget
);
215 $misc .= Xml
::hidden( 'dest', $this->mDest
);
216 $misc .= Xml
::hidden( 'wpEditToken', $wgUser->editToken() );
217 $misc .= Xml
::closeElement( 'form' );
218 $wgOut->addHtml( $misc );
223 function formatRevisionRow( $row ) {
224 global $wgUser, $wgLang;
226 $rev = new Revision( $row );
229 $last = $this->message
['last'];
231 $ts = wfTimestamp( TS_MW
, $row->rev_timestamp
);
232 $checkBox = wfRadio( "mergepoint", $ts, false );
234 $pageLink = $this->sk
->makeKnownLinkObj( $rev->getTitle(),
235 htmlspecialchars( $wgLang->timeanddate( $ts ) ), 'oldid=' . $rev->getId() );
236 if( $rev->isDeleted( Revision
::DELETED_TEXT
) ) {
237 $pageLink = '<span class="history-deleted">' . $pageLink . '</span>';
241 if( !$rev->userCan( Revision
::DELETED_TEXT
) )
242 $last = $this->message
['last'];
243 else if( isset($this->prevId
[$row->rev_id
]) )
244 $last = $this->sk
->makeKnownLinkObj( $rev->getTitle(), $this->message
['last'],
245 "diff=" . $row->rev_id
. "&oldid=" . $this->prevId
[$row->rev_id
] );
247 $userLink = $this->sk
->revUserTools( $rev );
249 if(!is_null($size = $row->rev_len
)) {
251 $stxt = wfMsgHtml('historyempty');
253 $stxt = wfMsgHtml('historysize', $wgLang->formatNum( $size ) );
255 $comment = $this->sk
->revComment( $rev );
257 return "<li>$checkBox ($last) $pageLink . . $userLink $stxt $comment</li>";
261 * Fetch revision text link if it's available to all users
264 function getPageLink( $row, $titleObj, $ts, $target ) {
267 if( !$this->userCan($row, Revision
::DELETED_TEXT
) ) {
268 return '<span class="history-deleted">' . $wgLang->timeanddate( $ts, true ) . '</span>';
270 $link = $this->sk
->makeKnownLinkObj( $titleObj,
271 $wgLang->timeanddate( $ts, true ), "target=$target×tamp=$ts" );
272 if( $this->isDeleted($row, Revision
::DELETED_TEXT
) )
273 $link = '<span class="history-deleted">' . $link . '</span>';
279 global $wgOut, $wgUser;
280 # Get the titles directly from the IDs, in case the target page params
281 # were spoofed. The queries are done based on the IDs, so it's best to
282 # keep it consistent...
283 $targetTitle = Title
::newFromID( $this->mTargetID
);
284 $destTitle = Title
::newFromID( $this->mDestID
);
285 if( is_null($targetTitle) ||
is_null($destTitle) )
286 return false; // validate these
287 if( $targetTitle->getArticleId() == $destTitle->getArticleId() )
289 # Verify that this timestamp is valid
290 # Must be older than the destination page
291 $dbw = wfGetDB( DB_MASTER
);
292 # Get timestamp into DB format
293 $this->mTimestamp
= $this->mTimestamp ?
$dbw->timestamp($this->mTimestamp
) : '';
294 # Max timestamp should be min of destination page
295 $maxtimestamp = $dbw->selectField( 'revision', 'MIN(rev_timestamp)',
296 array('rev_page' => $this->mDestID
),
298 # Destination page must exist with revisions
299 if( !$maxtimestamp ) {
300 $wgOut->addWikiMsg('mergehistory-fail');
303 # Get the latest timestamp of the source
304 $lasttimestamp = $dbw->selectField( array('page','revision'),
306 array('page_id' => $this->mTargetID
, 'page_latest = rev_id' ),
308 # $this->mTimestamp must be older than $maxtimestamp
309 if( $this->mTimestamp
>= $maxtimestamp ) {
310 $wgOut->addWikiMsg('mergehistory-fail');
313 # Update the revisions
314 if( $this->mTimestamp
) {
315 $timewhere = "rev_timestamp <= {$this->mTimestamp}";
316 $TimestampLimit = wfTimestamp(TS_MW
,$this->mTimestamp
);
318 $timewhere = "rev_timestamp <= {$maxtimestamp}";
319 $TimestampLimit = wfTimestamp(TS_MW
,$lasttimestamp);
322 $dbw->update( 'revision',
323 array( 'rev_page' => $this->mDestID
),
324 array( 'rev_page' => $this->mTargetID
,
328 $count = $dbw->affectedRows();
329 # Make the source page a redirect if no revisions are left
330 $haveRevisions = $dbw->selectField( 'revision',
332 array( 'rev_page' => $this->mTargetID
),
334 array( 'FOR UPDATE' ) );
335 if( !$haveRevisions ) {
336 if( $this->mComment
) {
337 $comment = wfMsgForContent( 'mergehistory-comment', $targetTitle->getPrefixedText(),
338 $destTitle->getPrefixedText(), $this->mComment
);
340 $comment = wfMsgForContent( 'mergehistory-autocomment', $targetTitle->getPrefixedText(),
341 $destTitle->getPrefixedText() );
343 $mwRedir = MagicWord
::get( 'redirect' );
344 $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $destTitle->getPrefixedText() . "]]\n";
345 $redirectArticle = new Article( $targetTitle );
346 $redirectRevision = new Revision( array(
347 'page' => $this->mTargetID
,
348 'comment' => $comment,
349 'text' => $redirectText ) );
350 $redirectRevision->insertOn( $dbw );
351 $redirectArticle->updateRevisionOn( $dbw, $redirectRevision );
353 # Now, we record the link from the redirect to the new title.
354 # It should have no other outgoing links...
355 $dbw->delete( 'pagelinks', array( 'pl_from' => $this->mDestID
), __METHOD__
);
356 $dbw->insert( 'pagelinks',
358 'pl_from' => $this->mDestID
,
359 'pl_namespace' => $destTitle->getNamespace(),
360 'pl_title' => $destTitle->getDBkey() ),
363 $targetTitle->invalidateCache(); // update histories
365 $destTitle->invalidateCache(); // update histories
366 # Check if this did anything
368 $wgOut->addWikiMsg('mergehistory-fail');
372 $log = new LogPage( 'merge' );
373 $log->addEntry( 'merge', $targetTitle, $this->mComment
,
374 array($destTitle->getPrefixedText(),$TimestampLimit) );
376 $wgOut->addHtml( wfMsgExt( 'mergehistory-success', array('parseinline'),
377 $targetTitle->getPrefixedText(), $destTitle->getPrefixedText(), $count ) );
379 wfRunHooks( 'ArticleMergeComplete', array( $targetTitle, $destTitle ) );
385 class MergeHistoryPager
extends ReverseChronologicalPager
{
386 public $mForm, $mConds;
388 function __construct( $form, $conds = array(), $source, $dest ) {
389 $this->mForm
= $form;
390 $this->mConds
= $conds;
391 $this->title
= $source;
392 $this->articleID
= $source->getArticleID();
394 $dbr = wfGetDB( DB_SLAVE
);
395 $maxtimestamp = $dbr->selectField( 'revision', 'MIN(rev_timestamp)',
396 array('rev_page' => $dest->getArticleID() ),
398 $this->maxTimestamp
= $maxtimestamp;
400 parent
::__construct();
403 function getStartBody() {
404 wfProfileIn( __METHOD__
);
405 # Do a link batch query
406 $this->mResult
->seek( 0 );
407 $batch = new LinkBatch();
408 # Give some pointers to make (last) links
409 $this->mForm
->prevId
= array();
410 while( $row = $this->mResult
->fetchObject() ) {
411 $batch->addObj( Title
::makeTitleSafe( NS_USER
, $row->rev_user_text
) );
412 $batch->addObj( Title
::makeTitleSafe( NS_USER_TALK
, $row->rev_user_text
) );
414 $rev_id = isset($rev_id) ?
$rev_id : $row->rev_id
;
415 if( $rev_id > $row->rev_id
)
416 $this->mForm
->prevId
[$rev_id] = $row->rev_id
;
417 else if( $rev_id < $row->rev_id
)
418 $this->mForm
->prevId
[$row->rev_id
] = $rev_id;
420 $rev_id = $row->rev_id
;
424 $this->mResult
->seek( 0 );
426 wfProfileOut( __METHOD__
);
430 function formatRow( $row ) {
432 return $this->mForm
->formatRevisionRow( $row );
435 function getQueryInfo() {
436 $conds = $this->mConds
;
437 $conds['rev_page'] = $this->articleID
;
438 $conds[] = "rev_timestamp < {$this->maxTimestamp}";
441 'tables' => array('revision'),
442 'fields' => array( 'rev_minor_edit', 'rev_timestamp', 'rev_user', 'rev_user_text', 'rev_comment',
443 'rev_id', 'rev_page', 'rev_text_id', 'rev_len', 'rev_deleted' ),
448 function getIndexField() {
449 return 'rev_timestamp';