SpecialRevisiondelete.php

Go to the documentation of this file.

<?php
class SpecialRevisionDelete extends UnlistedSpecialPage {
        var $submitClicked;

        var $ids;

        var $archiveName;

        var $token;

        var $targetObj;

        var $typeName;

        var $checks;

        var $typeInfo;

        var $list;

        static $allowedTypes = array(
                'revision' => array(
                        'check-label'   => 'revdelete-hide-text',
                        'deletion-bits' => Revision::DELETED_TEXT,
                        'success'               => 'revdelete-success',
                        'failure'               => 'revdelete-failure',
                        'list-class'    => 'RevDel_RevisionList',
                ),
                'archive' => array(
                        'check-label'   => 'revdelete-hide-text',
                        'deletion-bits' => Revision::DELETED_TEXT,
                        'success'               => 'revdelete-success',
                        'failure'               => 'revdelete-failure',
                        'list-class'    => 'RevDel_ArchiveList',
                ),
                'oldimage'=> array(
                        'check-label'   => 'revdelete-hide-image',
                        'deletion-bits' => File::DELETED_FILE,
                        'success'               => 'revdelete-success',
                        'failure'               => 'revdelete-failure',
                        'list-class'    => 'RevDel_FileList',
                ),
                'filearchive' => array(
                        'check-label'   => 'revdelete-hide-image',
                        'deletion-bits' => File::DELETED_FILE,
                        'success'               => 'revdelete-success',
                        'failure'               => 'revdelete-failure',
                        'list-class'    => 'RevDel_ArchivedFileList',
                ),
                'logging' => array(
                        'check-label'   => 'revdelete-hide-name',
                        'deletion-bits' => LogPage::DELETED_ACTION,
                        'success'               => 'logdelete-success',
                        'failure'               => 'logdelete-failure',
                        'list-class'    => 'RevDel_LogList',
                ),
        );

        static $deprecatedTypeMap = array(
                'oldid' => 'revision',
                'artimestamp' => 'archive',
                'oldimage' => 'oldimage',
                'fileid' => 'filearchive',
                'logid' => 'logging',
        );

        public function __construct() {
                parent::__construct( 'Revisiondelete', 'deletedhistory' );
        }

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

                $output = $this->getOutput();
                $user = $this->getUser();

                $this->mIsAllowed = $user->isAllowed('deleterevision'); // for changes
                $this->setHeaders();
                $this->outputHeader();
                $request = $this->getRequest();
                $this->submitClicked = $request->wasPosted() && $request->getBool( 'wpSubmit' );
                # Handle our many different possible input types.
                $ids = $request->getVal( 'ids' );
                if ( !is_null( $ids ) ) {
                        # Allow CSV, for backwards compatibility, or a single ID for show/hide links
                        $this->ids = explode( ',', $ids );
                } else {
                        # Array input
                        $this->ids = array_keys( $request->getArray('ids',array()) );
                }
                // $this->ids = array_map( 'intval', $this->ids );
                $this->ids = array_unique( array_filter( $this->ids ) );

                if ( $request->getVal( 'action' ) == 'historysubmit' || $request->getVal( 'action' ) == 'revisiondelete' ) {
                        // For show/hide form submission from history page
                        // Since we are access through index.php?title=XXX&action=historysubmit
                        // getFullTitle() will contain the target title and not our title
                        $this->targetObj = $this->getFullTitle();
                        $this->typeName = 'revision';
                } else {
                        $this->typeName = $request->getVal( 'type' );
                        $this->targetObj = Title::newFromText( $request->getText( 'target' ) );
                }

                # For reviewing deleted files...
                $this->archiveName = $request->getVal( 'file' );
                $this->token = $request->getVal( 'token' );
                if ( $this->archiveName && $this->targetObj ) {
                        $this->tryShowFile( $this->archiveName );
                        return;
                }

                if ( isset( self::$deprecatedTypeMap[$this->typeName] ) ) {
                        $this->typeName = self::$deprecatedTypeMap[$this->typeName];
                }

                # No targets?
                if( !isset( self::$allowedTypes[$this->typeName] ) || count( $this->ids ) == 0 ) {
                        $output->showErrorPage( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
                        return;
                }
                $this->typeInfo = self::$allowedTypes[$this->typeName];

                # If we have revisions, get the title from the first one
                # since they should all be from the same page. This allows
                # for more flexibility with page moves...
                if( $this->typeName == 'revision' ) {
                        $rev = Revision::newFromId( $this->ids[0] );
                        $this->targetObj = $rev ? $rev->getTitle() : $this->targetObj;
                }

                $this->otherReason = $request->getVal( 'wpReason' );
                # We need a target page!
                if( is_null($this->targetObj) ) {
                        $output->addWikiMsg( 'undelete-header' );
                        return;
                }
                # Give a link to the logs/hist for this page
                $this->showConvenienceLinks();

                # Initialise checkboxes
                $this->checks = array(
                        array( $this->typeInfo['check-label'], 'wpHidePrimary', $this->typeInfo['deletion-bits'] ),
                        array( 'revdelete-hide-comment', 'wpHideComment', Revision::DELETED_COMMENT ),
                        array( 'revdelete-hide-user', 'wpHideUser', Revision::DELETED_USER )
                );
                if( $user->isAllowed('suppressrevision') ) {
                        $this->checks[] = array( 'revdelete-hide-restricted',
                                'wpHideRestricted', Revision::DELETED_RESTRICTED );
                }

                # Either submit or create our form
                if( $this->mIsAllowed && $this->submitClicked ) {
                        $this->submit( $request );
                } else {
                        $this->showForm();
                }

                $qc = $this->getLogQueryCond();
                # Show relevant lines from the deletion log
                $output->addHTML( "<h2>" . htmlspecialchars( LogPage::logName( 'delete' ) ) . "</h2>\n" );
                LogEventsList::showLogExtract( $output, 'delete',
                        $this->targetObj, '', array( 'lim' => 25, 'conds' => $qc ) );
                # Show relevant lines from the suppression log
                if( $user->isAllowed( 'suppressionlog' ) ) {
                        $output->addHTML( "<h2>" . htmlspecialchars( LogPage::logName( 'suppress' ) ) . "</h2>\n" );
                        LogEventsList::showLogExtract( $output, 'suppress',
                                $this->targetObj, '', array( 'lim' => 25, 'conds' => $qc ) );
                }
        }

        protected function showConvenienceLinks() {
                # Give a link to the logs/hist for this page
                if( $this->targetObj ) {
                        $links = array();
                        $links[] = Linker::linkKnown(
                                SpecialPage::getTitleFor( 'Log' ),
                                wfMsgHtml( 'viewpagelogs' ),
                                array(),
                                array( 'page' => $this->targetObj->getPrefixedText() )
                        );
                        if ( !$this->targetObj->isSpecialPage() ) {
                                # Give a link to the page history
                                $links[] = Linker::linkKnown(
                                        $this->targetObj,
                                        wfMsgHtml( 'pagehist' ),
                                        array(),
                                        array( 'action' => 'history' )
                                );
                                # Link to deleted edits
                                if( $this->getUser()->isAllowed('undelete') ) {
                                        $undelete = SpecialPage::getTitleFor( 'Undelete' );
                                        $links[] = Linker::linkKnown(
                                                $undelete,
                                                wfMsgHtml( 'deletedhist' ),
                                                array(),
                                                array( 'target' => $this->targetObj->getPrefixedDBkey() )
                                        );
                                }
                        }
                        # Logs themselves don't have histories or archived revisions
                        $this->getOutput()->addSubtitle( $this->getLanguage()->pipeList( $links ) );
                }
        }

        protected function getLogQueryCond() {
                $conds = array();
                // Revision delete logs for these item
                $conds['log_type'] = array( 'delete', 'suppress' );
                $conds['log_action'] = $this->getList()->getLogAction();
                $conds['ls_field'] = RevisionDeleter::getRelationType( $this->typeName );
                $conds['ls_value'] = $this->ids;
                return $conds;
        }

        protected function tryShowFile( $archiveName ) {
                $repo = RepoGroup::singleton()->getLocalRepo();
                $oimage = $repo->newFromArchiveName( $this->targetObj, $archiveName );
                $oimage->load();
                // Check if user is allowed to see this file
                if ( !$oimage->exists() ) {
                        $this->getOutput()->addWikiMsg( 'revdelete-no-file' );
                        return;
                }
                if( !$oimage->userCan( File::DELETED_FILE, $this->getUser() ) ) {
                        if( $oimage->isDeleted( File::DELETED_RESTRICTED ) ) {
                                $this->getOutput()->permissionRequired( 'suppressrevision' );
                        } else {
                                $this->getOutput()->permissionRequired( 'deletedtext' );
                        }
                        return;
                }
                if ( !$this->getUser()->matchEditToken( $this->token, $archiveName ) ) {
                        $this->getOutput()->addWikiMsg( 'revdelete-show-file-confirm',
                                $this->targetObj->getText(),
                                $this->getLanguage()->date( $oimage->getTimestamp() ),
                                $this->getLanguage()->time( $oimage->getTimestamp() ) );
                        $this->getOutput()->addHTML(
                                Xml::openElement( 'form', array(
                                        'method' => 'POST',
                                        'action' => $this->getTitle()->getLocalUrl(
                                                'target=' . urlencode( $oimage->getName() ) .
                                                '&file=' . urlencode( $archiveName ) .
                                                '&token=' . urlencode( $this->getUser()->getEditToken( $archiveName ) ) )
                                        )
                                ) .
                                Xml::submitButton( wfMsg( 'revdelete-show-file-submit' ) ) .
                                '</form>'
                        );
                        return;
                }
                $this->getOutput()->disable();
                # We mustn't allow the output to be Squid cached, otherwise
                # if an admin previews a deleted image, and it's cached, then
                # a user without appropriate permissions can toddle off and
                # nab the image, and Squid will serve it
                $this->getRequest()->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
                $this->getRequest()->response()->header( 'Cache-Control: no-cache, no-store, max-age=0, must-revalidate' );
                $this->getRequest()->response()->header( 'Pragma: no-cache' );

                $key = $oimage->getStorageKey();
                $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
                $repo->streamFile( $path );
        }

        protected function getList() {
                if ( is_null( $this->list ) ) {
                        $class = $this->typeInfo['list-class'];
                        $this->list = new $class( $this->getContext(), $this->targetObj, $this->ids );
                }
                return $this->list;
        }

        protected function showForm() {
                $UserAllowed = true;

                if ( $this->typeName == 'logging' ) {
                        $this->getOutput()->addWikiMsg( 'logdelete-selected', $this->getLanguage()->formatNum( count($this->ids) ) );
                } else {
                        $this->getOutput()->addWikiMsg( 'revdelete-selected',
                                $this->targetObj->getPrefixedText(), count( $this->ids ) );
                }

                $this->getOutput()->addHTML( "<ul>" );

                $numRevisions = 0;
                // Live revisions...
                $list = $this->getList();
                for ( $list->reset(); $list->current(); $list->next() ) {
                        $item = $list->current();
                        if ( !$item->canView() ) {
                                if( !$this->submitClicked ) {
                                        $this->getOutput()->permissionRequired( 'suppressrevision' );
                                        return;
                                }
                                $UserAllowed = false;
                        }
                        $numRevisions++;
                        $this->getOutput()->addHTML( $item->getHTML() );
                }

                if( !$numRevisions ) {
                        $this->getOutput()->showErrorPage( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
                        return;
                }

                $this->getOutput()->addHTML( "</ul>" );
                // Explanation text
                $this->addUsageText();

                // Normal sysops can always see what they did, but can't always change it
                if( !$UserAllowed ) return;

                // Show form if the user can submit
                if( $this->mIsAllowed ) {
                        $out = Xml::openElement( 'form', array( 'method' => 'post',
                                        'action' => $this->getTitle()->getLocalUrl( array( 'action' => 'submit' ) ),
                                        'id' => 'mw-revdel-form-revisions' ) ) .
                                Xml::fieldset( wfMsg( 'revdelete-legend' ) ) .
                                $this->buildCheckBoxes() .
                                Xml::openElement( 'table' ) .
                                "<tr>\n" .
                                        '<td class="mw-label">' .
                                                Xml::label( wfMsg( 'revdelete-log' ), 'wpRevDeleteReasonList' ) .
                                        '</td>' .
                                        '<td class="mw-input">' .
                                                Xml::listDropDown( 'wpRevDeleteReasonList',
                                                        wfMsgForContent( 'revdelete-reason-dropdown' ),
                                                        wfMsgForContent( 'revdelete-reasonotherlist' ), '', 'wpReasonDropDown', 1
                                                ) .
                                        '</td>' .
                                "</tr><tr>\n" .
                                        '<td class="mw-label">' .
                                                Xml::label( wfMsg( 'revdelete-otherreason' ), 'wpReason' ) .
                                        '</td>' .
                                        '<td class="mw-input">' .
                                                Xml::input( 'wpReason', 60, $this->otherReason, array( 'id' => 'wpReason', 'maxlength' => 100 ) ) .
                                        '</td>' .
                                "</tr><tr>\n" .
                                        '<td></td>' .
                                        '<td class="mw-submit">' .
                                                Xml::submitButton( wfMsgExt('revdelete-submit','parsemag',$numRevisions),
                                                        array( 'name' => 'wpSubmit' ) ) .
                                        '</td>' .
                                "</tr>\n" .
                                Xml::closeElement( 'table' ) .
                                Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() ) .
                                Html::hidden( 'target', $this->targetObj->getPrefixedText() ) .
                                Html::hidden( 'type', $this->typeName ) .
                                Html::hidden( 'ids', implode( ',', $this->ids ) ) .
                                Xml::closeElement( 'fieldset' ) . "\n";
                } else {
                        $out = '';
                }
                if( $this->mIsAllowed ) {
                        $out .= Xml::closeElement( 'form' ) . "\n";
                        // Show link to edit the dropdown reasons
                        if( $this->getUser()->isAllowed( 'editinterface' ) ) {
                                $title = Title::makeTitle( NS_MEDIAWIKI, 'revdelete-reason-dropdown' );
                                $link = Linker::link(
                                        $title,
                                        wfMsgHtml( 'revdelete-edit-reasonlist' ),
                                        array(),
                                        array( 'action' => 'edit' )
                                );
                                $out .= Xml::tags( 'p', array( 'class' => 'mw-revdel-editreasons' ), $link ) . "\n";
                        }
                }
                $this->getOutput()->addHTML( $out );
        }

        protected function addUsageText() {
                $this->getOutput()->addWikiMsg( 'revdelete-text' );
                if( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
                        $this->getOutput()->addWikiMsg( 'revdelete-suppress-text' );
                }
                if( $this->mIsAllowed ) {
                        $this->getOutput()->addWikiMsg( 'revdelete-confirm' );
                }
        }

        protected function buildCheckBoxes() {
                $html = '<table>';
                // If there is just one item, use checkboxes
                $list = $this->getList();
                if( $list->length() == 1 ) {
                        $list->reset();
                        $bitfield = $list->current()->getBits(); // existing field
                        if( $this->submitClicked ) {
                                $bitfield = $this->extractBitfield( $this->extractBitParams(), $bitfield );
                        }
                        foreach( $this->checks as $item ) {
                                list( $message, $name, $field ) = $item;
                                $innerHTML = Xml::checkLabel( wfMsg($message), $name, $name, $bitfield & $field );
                                if( $field == Revision::DELETED_RESTRICTED )
                                        $innerHTML = "<b>$innerHTML</b>";
                                $line = Xml::tags( 'td', array( 'class' => 'mw-input' ), $innerHTML );
                                $html .= "<tr>$line</tr>\n";
                        }
                // Otherwise, use tri-state radios
                } else {
                        $html .= '<tr>';
                        $html .= '<th class="mw-revdel-checkbox">'.wfMsgHtml('revdelete-radio-same').'</th>';
                        $html .= '<th class="mw-revdel-checkbox">'.wfMsgHtml('revdelete-radio-unset').'</th>';
                        $html .= '<th class="mw-revdel-checkbox">'.wfMsgHtml('revdelete-radio-set').'</th>';
                        $html .= "<th></th></tr>\n";
                        foreach( $this->checks as $item ) {
                                list( $message, $name, $field ) = $item;
                                // If there are several items, use third state by default...
                                if( $this->submitClicked ) {
                                        $selected = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
                                } else {
                                        $selected = -1; // use existing field
                                }
                                $line = '<td class="mw-revdel-checkbox">' . Xml::radio( $name, -1, $selected == -1 ) . '</td>';
                                $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 0, $selected == 0 ) . '</td>';
                                $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 1, $selected == 1 ) . '</td>';
                                $label = wfMsgHtml($message);
                                if( $field == Revision::DELETED_RESTRICTED ) {
                                        $label = "<b>$label</b>";
                                }
                                $line .= "<td>$label</td>";
                                $html .= "<tr>$line</tr>\n";
                        }
                }

                $html .= '</table>';
                return $html;
        }

        protected function submit() {
                # Check edit token on submission
                $token = $this->getRequest()->getVal('wpEditToken');
                if( $this->submitClicked && !$this->getUser()->matchEditToken( $token ) ) {
                        $this->getOutput()->addWikiMsg( 'sessionfailure' );
                        return false;
                }
                $bitParams = $this->extractBitParams();
                $listReason = $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' ); // from dropdown
                $comment = $listReason;
                if( $comment != 'other' && $this->otherReason != '' ) {
                        // Entry from drop down menu + additional comment
                        $comment .= wfMsgForContent( 'colon-separator' ) . $this->otherReason;
                } elseif( $comment == 'other' ) {
                        $comment = $this->otherReason;
                }
                # Can the user set this field?
                if( $bitParams[Revision::DELETED_RESTRICTED]==1 && !$this->getUser()->isAllowed('suppressrevision') ) {
                        $this->getOutput()->permissionRequired( 'suppressrevision' );
                        return false;
                }
                # If the save went through, go to success message...
                $status = $this->save( $bitParams, $comment, $this->targetObj );
                if ( $status->isGood() ) {
                        $this->success();
                        return true;
                # ...otherwise, bounce back to form...
                } else {
                        $this->failure( $status );
                }
                return false;
        }

        protected function success() {
                $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
                $this->getOutput()->wrapWikiMsg( "<span class=\"success\">\n$1\n</span>", $this->typeInfo['success'] );
                $this->list->reloadFromMaster();
                $this->showForm();
        }

        protected function failure( $status ) {
                $this->getOutput()->setPageTitle( $this->msg( 'actionfailed' ) );
                $this->getOutput()->addWikiText( $status->getWikiText( $this->typeInfo['failure'] ) );
                $this->showForm();
        }

        protected function extractBitParams() {
                $bitfield = array();
                foreach( $this->checks as $item ) {
                        list( /* message */ , $name, $field ) = $item;
                        $val = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
                        if( $val < -1 || $val > 1) {
                                $val = -1; // -1 for existing value
                        }
                        $bitfield[$field] = $val;
                }
                if( !isset($bitfield[Revision::DELETED_RESTRICTED]) ) {
                        $bitfield[Revision::DELETED_RESTRICTED] = 0;
                }
                return $bitfield;
        }

        public static function extractBitfield( $bitPars, $oldfield ) {
                // Build the actual new rev_deleted bitfield
                $newBits = 0;
                foreach( $bitPars as $const => $val ) {
                        if( $val == 1 ) {
                                $newBits |= $const; // $const is the *_deleted const
                        } elseif( $val == -1 ) {
                                $newBits |= ($oldfield & $const); // use existing
                        }
                }
                return $newBits;
        }

        protected function save( $bitfield, $reason, $title ) {
                return $this->getList()->setVisibility(
                        array( 'value' => $bitfield, 'comment' => $reason )
                );
        }
}