SpecialMergeHistory.php

Go to the documentation of this file.

<?php
class SpecialMergeHistory extends SpecialPage {
        var $mAction, $mTarget, $mDest, $mTimestamp, $mTargetID, $mDestID, $mComment;

        var $mTargetObj, $mDestObj;

        public function __construct() {
                parent::__construct( 'MergeHistory', 'mergehistory' );
        }

        private function loadRequestParams() {
                $request = $this->getRequest();
                $this->mAction = $request->getVal( 'action' );
                $this->mTarget = $request->getVal( 'target' );
                $this->mDest = $request->getVal( 'dest' );
                $this->mSubmitted = $request->getBool( 'submitted' );

                $this->mTargetID = intval( $request->getVal( 'targetID' ) );
                $this->mDestID = intval( $request->getVal( 'destID' ) );
                $this->mTimestamp = $request->getVal( 'mergepoint' );
                if( !preg_match( '/[0-9]{14}/', $this->mTimestamp ) ) {
                        $this->mTimestamp = '';
                }
                $this->mComment = $request->getText( 'wpComment' );

                $this->mMerge = $request->wasPosted() && $this->getUser()->matchEditToken( $request->getVal( 'wpEditToken' ) );
                // target page
                if( $this->mSubmitted ) {
                        $this->mTargetObj = Title::newFromURL( $this->mTarget );
                        $this->mDestObj = Title::newFromURL( $this->mDest );
                } else {
                        $this->mTargetObj = null;
                        $this->mDestObj = null;
                }
                $this->preCacheMessages();
        }

        function preCacheMessages() {
                // Precache various messages
                if( !isset( $this->message ) ) {
                        $this->message['last'] = $this->msg( 'last' )->escaped();
                }
        }

        public function execute( $par ) {
                $this->checkPermissions();
                $this->checkReadOnly();

                $this->loadRequestParams();

                $this->setHeaders();
                $this->outputHeader();

                if( $this->mTargetID && $this->mDestID && $this->mAction == 'submit' && $this->mMerge ) {
                        $this->merge();
                        return;
                }

                if ( !$this->mSubmitted ) {
                        $this->showMergeForm();
                        return;
                }

                $errors = array();
                if ( !$this->mTargetObj instanceof Title ) {
                        $errors[] = $this->msg( 'mergehistory-invalid-source' )->parseAsBlock();
                } elseif( !$this->mTargetObj->exists() ) {
                        $errors[] = $this->msg( 'mergehistory-no-source', array( 'parse' ),
                                wfEscapeWikiText( $this->mTargetObj->getPrefixedText() )
                        )->parseAsBlock();
                }

                if ( !$this->mDestObj instanceof Title ) {
                        $errors[] = $this->msg( 'mergehistory-invalid-destination' )->parseAsBlock();
                } elseif( !$this->mDestObj->exists() ) {
                        $errors[] = $this->msg( 'mergehistory-no-destination', array( 'parse' ),
                                wfEscapeWikiText( $this->mDestObj->getPrefixedText() )
                        )->parseAsBlock();
                }

                if ( $this->mTargetObj && $this->mDestObj && $this->mTargetObj->equals( $this->mDestObj ) ) {
                        $errors[] = $this->msg( 'mergehistory-same-destination' )->parseAsBlock();
                }

                if ( count( $errors ) ) {
                        $this->showMergeForm();
                        $this->getOutput()->addHTML( implode( "\n", $errors ) );
                } else {
                        $this->showHistory();
                }

        }

        function showMergeForm() {
                global $wgScript;

                $this->getOutput()->addWikiMsg( 'mergehistory-header' );

                $this->getOutput()->addHTML(
                        Xml::openElement( 'form', array(
                                'method' => 'get',
                                'action' => $wgScript ) ) .
                        '<fieldset>' .
                        Xml::element( 'legend', array(),
                                $this->msg( 'mergehistory-box' )->text() ) .
                        Html::hidden( 'title', $this->getTitle()->getPrefixedDbKey() ) .
                        Html::hidden( 'submitted', '1' ) .
                        Html::hidden( 'mergepoint', $this->mTimestamp ) .
                        Xml::openElement( 'table' ) .
                        '<tr>
                                <td>' . Xml::label( $this->msg( 'mergehistory-from' )->text(), 'target' ) . '</td>
                                <td>' . Xml::input( 'target', 30, $this->mTarget, array( 'id' => 'target' ) ) . '</td>
                        </tr><tr>
                                <td>' . Xml::label( $this->msg( 'mergehistory-into' )->text(), 'dest' ) . '</td>
                                <td>' . Xml::input( 'dest', 30, $this->mDest, array( 'id' => 'dest' ) ) . '</td>
                        </tr><tr><td>' .
                        Xml::submitButton( $this->msg( 'mergehistory-go' )->text() ) .
                        '</td></tr>' .
                        Xml::closeElement( 'table' ) .
                        '</fieldset>' .
                        '</form>'
                );
        }

        private function showHistory() {
                $this->showMergeForm();

                # List all stored revisions
                $revisions = new MergeHistoryPager(
                        $this, array(), $this->mTargetObj, $this->mDestObj
                );
                $haveRevisions = $revisions && $revisions->getNumRows() > 0;

                $out = $this->getOutput();
                $titleObj = $this->getTitle();
                $action = $titleObj->getLocalURL( array( 'action' => 'submit' ) );
                # Start the form here
                $top = Xml::openElement(
                        'form',
                        array(
                                'method' => 'post',
                                'action' => $action,
                                'id' => 'merge'
                        )
                );
                $out->addHTML( $top );

                if( $haveRevisions ) {
                        # Format the user-visible controls (comment field, submission button)
                        # in a nice little table
                        $table =
                                Xml::openElement( 'fieldset' ) .
                                $this->msg( 'mergehistory-merge', $this->mTargetObj->getPrefixedText(),
                                        $this->mDestObj->getPrefixedText() )->parse() .
                                Xml::openElement( 'table', array( 'id' => 'mw-mergehistory-table' ) ) .
                                        '<tr>
                                                <td class="mw-label">' .
                                                        Xml::label( $this->msg( 'mergehistory-reason' )->text(), 'wpComment' ) .
                                                '</td>
                                                <td class="mw-input">' .
                                                        Xml::input( 'wpComment', 50, $this->mComment, array( 'id' => 'wpComment' ) ) .
                                                '</td>
                                        </tr>
                                        <tr>
                                                <td>&#160;</td>
                                                <td class="mw-submit">' .
                                                        Xml::submitButton( $this->msg( 'mergehistory-submit' )->text(), array( 'name' => 'merge', 'id' => 'mw-merge-submit' ) ) .
                                                '</td>
                                        </tr>' .
                                Xml::closeElement( 'table' ) .
                                Xml::closeElement( 'fieldset' );

                        $out->addHTML( $table );
                }

                $out->addHTML(
                        '<h2 id="mw-mergehistory">' .
                        $this->msg( 'mergehistory-list' )->escaped() . "</h2>\n"
                );

                if( $haveRevisions ) {
                        $out->addHTML( $revisions->getNavigationBar() );
                        $out->addHTML( '<ul>' );
                        $out->addHTML( $revisions->getBody() );
                        $out->addHTML( '</ul>' );
                        $out->addHTML( $revisions->getNavigationBar() );
                } else {
                        $out->addWikiMsg( 'mergehistory-empty' );
                }

                # Show relevant lines from the merge log:
                $mergeLogPage = new LogPage( 'merge' );
                $out->addHTML( '<h2>' . $mergeLogPage->getName()->escaped() . "</h2>\n" );
                LogEventsList::showLogExtract( $out, 'merge', $this->mTargetObj );

                # When we submit, go by page ID to avoid some nasty but unlikely collisions.
                # Such would happen if a page was renamed after the form loaded, but before submit
                $misc = Html::hidden( 'targetID', $this->mTargetObj->getArticleID() );
                $misc .= Html::hidden( 'destID', $this->mDestObj->getArticleID() );
                $misc .= Html::hidden( 'target', $this->mTarget );
                $misc .= Html::hidden( 'dest', $this->mDest );
                $misc .= Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() );
                $misc .= Xml::closeElement( 'form' );
                $out->addHTML( $misc );

                return true;
        }

        function formatRevisionRow( $row ) {
                $rev = new Revision( $row );

                $stxt = '';
                $last = $this->message['last'];

                $ts = wfTimestamp( TS_MW, $row->rev_timestamp );
                $checkBox = Xml::radio( 'mergepoint', $ts, false );

                $user = $this->getUser();

                $pageLink = Linker::linkKnown(
                        $rev->getTitle(),
                        htmlspecialchars( $this->getLanguage()->userTimeAndDate( $ts, $user ) ),
                        array(),
                        array( 'oldid' => $rev->getId() )
                );
                if( $rev->isDeleted( Revision::DELETED_TEXT ) ) {
                        $pageLink = '<span class="history-deleted">' . $pageLink . '</span>';
                }

                # Last link
                if( !$rev->userCan( Revision::DELETED_TEXT, $user ) ) {
                        $last = $this->message['last'];
                } elseif( isset( $this->prevId[$row->rev_id] ) ) {
                        $last = Linker::linkKnown(
                                $rev->getTitle(),
                                $this->message['last'],
                                array(),
                                array(
                                        'diff' => $row->rev_id,
                                        'oldid' => $this->prevId[$row->rev_id]
                                )
                        );
                }

                $userLink = Linker::revUserTools( $rev );

                $size = $row->rev_len;
                if( !is_null( $size ) ) {
                        $stxt = Linker::formatRevisionSize( $size );
                }
                $comment = Linker::revComment( $rev );

                return Html::rawElement( 'li', array(),
                        $this->msg( 'mergehistory-revisionrow' )->rawParams( $checkBox, $last, $pageLink, $userLink, $stxt, $comment )->escaped() );
        }

        function merge() {
                # Get the titles directly from the IDs, in case the target page params
                # were spoofed. The queries are done based on the IDs, so it's best to
                # keep it consistent...
                $targetTitle = Title::newFromID( $this->mTargetID );
                $destTitle = Title::newFromID( $this->mDestID );
                if( is_null( $targetTitle ) || is_null( $destTitle ) ) {
                        return false; // validate these
                }
                if( $targetTitle->getArticleID() == $destTitle->getArticleID() ) {
                        return false;
                }
                # Verify that this timestamp is valid
                # Must be older than the destination page
                $dbw = wfGetDB( DB_MASTER );
                # Get timestamp into DB format
                $this->mTimestamp = $this->mTimestamp ? $dbw->timestamp( $this->mTimestamp ) : '';
                # Max timestamp should be min of destination page
                $maxtimestamp = $dbw->selectField(
                        'revision',
                        'MIN(rev_timestamp)',
                        array( 'rev_page' => $this->mDestID ),
                        __METHOD__
                );
                # Destination page must exist with revisions
                if( !$maxtimestamp ) {
                        $this->getOutput()->addWikiMsg( 'mergehistory-fail' );
                        return false;
                }
                # Get the latest timestamp of the source
                $lasttimestamp = $dbw->selectField(
                        array( 'page', 'revision' ),
                        'rev_timestamp',
                        array( 'page_id' => $this->mTargetID, 'page_latest = rev_id' ),
                        __METHOD__
                );
                # $this->mTimestamp must be older than $maxtimestamp
                if( $this->mTimestamp >= $maxtimestamp ) {
                        $this->getOutput()->addWikiMsg( 'mergehistory-fail' );
                        return false;
                }
                # Update the revisions
                if( $this->mTimestamp ) {
                        $timewhere = "rev_timestamp <= {$this->mTimestamp}";
                        $timestampLimit = wfTimestamp( TS_MW, $this->mTimestamp );
                } else {
                        $timewhere = "rev_timestamp <= {$maxtimestamp}";
                        $timestampLimit = wfTimestamp( TS_MW, $lasttimestamp );
                }
                # Do the moving...
                $dbw->update(
                        'revision',
                        array( 'rev_page' => $this->mDestID ),
                        array( 'rev_page' => $this->mTargetID, $timewhere ),
                        __METHOD__
                );

                $count = $dbw->affectedRows();
                # Make the source page a redirect if no revisions are left
                $haveRevisions = $dbw->selectField(
                        'revision',
                        'rev_timestamp',
                        array( 'rev_page' => $this->mTargetID  ),
                        __METHOD__,
                        array( 'FOR UPDATE' )
                );
                if( !$haveRevisions ) {
                        if( $this->mComment ) {
                                $comment = $this->msg(
                                        'mergehistory-comment',
                                        $targetTitle->getPrefixedText(),
                                        $destTitle->getPrefixedText(),
                                        $this->mComment
                                )->inContentLanguage()->text();
                        } else {
                                $comment = $this->msg(
                                        'mergehistory-autocomment',
                                        $targetTitle->getPrefixedText(),
                                        $destTitle->getPrefixedText()
                                )->inContentLanguage()->text();
                        }
                        $mwRedir = MagicWord::get( 'redirect' );
                        $redirectText = $mwRedir->getSynonym( 0 ) . ' [[' . $destTitle->getPrefixedText() . "]]\n";
                        $redirectPage = WikiPage::factory( $targetTitle );
                        $redirectRevision = new Revision( array(
                                'page'    => $this->mTargetID,
                                'comment' => $comment,
                                'text'    => $redirectText ) );
                        $redirectRevision->insertOn( $dbw );
                        $redirectPage->updateRevisionOn( $dbw, $redirectRevision );

                        # Now, we record the link from the redirect to the new title.
                        # It should have no other outgoing links...
                        $dbw->delete( 'pagelinks', array( 'pl_from' => $this->mDestID ), __METHOD__ );
                        $dbw->insert( 'pagelinks',
                                array(
                                        'pl_from'      => $this->mDestID,
                                        'pl_namespace' => $destTitle->getNamespace(),
                                        'pl_title'     => $destTitle->getDBkey() ),
                                __METHOD__
                        );
                } else {
                        $targetTitle->invalidateCache(); // update histories
                }
                $destTitle->invalidateCache(); // update histories
                # Check if this did anything
                if( !$count ) {
                        $this->getOutput()->addWikiMsg( 'mergehistory-fail' );
                        return false;
                }
                # Update our logs
                $log = new LogPage( 'merge' );
                $log->addEntry(
                        'merge', $targetTitle, $this->mComment,
                        array( $destTitle->getPrefixedText(), $timestampLimit )
                );

                $this->getOutput()->addWikiMsg( 'mergehistory-success',
                        $targetTitle->getPrefixedText(), $destTitle->getPrefixedText(), $count );

                wfRunHooks( 'ArticleMergeComplete', array( $targetTitle, $destTitle ) );

                return true;
        }
}

class MergeHistoryPager extends ReverseChronologicalPager {
        public $mForm, $mConds;

        function __construct( $form, $conds = array(), $source, $dest ) {
                $this->mForm = $form;
                $this->mConds = $conds;
                $this->title = $source;
                $this->articleID = $source->getArticleID();

                $dbr = wfGetDB( DB_SLAVE );
                $maxtimestamp = $dbr->selectField(
                        'revision',
                        'MIN(rev_timestamp)',
                        array( 'rev_page' => $dest->getArticleID() ),
                        __METHOD__
                );
                $this->maxTimestamp = $maxtimestamp;

                parent::__construct( $form->getContext() );
        }

        function getStartBody() {
                wfProfileIn( __METHOD__ );
                # Do a link batch query
                $this->mResult->seek( 0 );
                $batch = new LinkBatch();
                # Give some pointers to make (last) links
                $this->mForm->prevId = array();
                foreach ( $this->mResult as $row ) {
                        $batch->addObj( Title::makeTitleSafe( NS_USER, $row->user_name ) );
                        $batch->addObj( Title::makeTitleSafe( NS_USER_TALK, $row->user_name ) );

                        $rev_id = isset( $rev_id ) ? $rev_id : $row->rev_id;
                        if( $rev_id > $row->rev_id ) {
                                $this->mForm->prevId[$rev_id] = $row->rev_id;
                        } elseif( $rev_id < $row->rev_id ) {
                                $this->mForm->prevId[$row->rev_id] = $rev_id;
                        }

                        $rev_id = $row->rev_id;
                }

                $batch->execute();
                $this->mResult->seek( 0 );

                wfProfileOut( __METHOD__ );
                return '';
        }

        function formatRow( $row ) {
                return $this->mForm->formatRevisionRow( $row );
        }

        function getQueryInfo() {
                $conds = $this->mConds;
                $conds['rev_page'] = $this->articleID;
                $conds[] = "rev_timestamp < {$this->maxTimestamp}";
                return array(
                        'tables' => array( 'revision', 'page', 'user' ),
                        'fields' => array_merge( Revision::selectFields(), Revision::selectUserFields() ),
                        'conds'  => $conds,
                        'join_conds' => array(
                                'page' => Revision::pageJoinCond(),
                                'user' => Revision::userJoinCond() )
                );
        }

        function getIndexField() {
                return 'rev_timestamp';
        }
}