SpecialRevisiondelete.php

Go to the documentation of this file.

<?php
class SpecialRevisionDelete extends UnlistedSpecialPage {
    protected $wasSaved = false;

    private $submitClicked;

    private $ids;

    private $archiveName;

    private $token;

    private $targetObj;

    private $typeName;

    private $checks;

    private $typeLabels;

    private $revDelList;

    private $mIsAllowed;

    private $otherReason;

    private static $UILabels = [
        'revision' => [
            'check-label' => 'revdelete-hide-text',
            'success' => 'revdelete-success',
            'failure' => 'revdelete-failure',
            'text' => 'revdelete-text-text',
            'selected'=> 'revdelete-selected-text',
        ],
        'archive' => [
            'check-label' => 'revdelete-hide-text',
            'success' => 'revdelete-success',
            'failure' => 'revdelete-failure',
            'text' => 'revdelete-text-text',
            'selected'=> 'revdelete-selected-text',
        ],
        'oldimage' => [
            'check-label' => 'revdelete-hide-image',
            'success' => 'revdelete-success',
            'failure' => 'revdelete-failure',
            'text' => 'revdelete-text-file',
            'selected'=> 'revdelete-selected-file',
        ],
        'filearchive' => [
            'check-label' => 'revdelete-hide-image',
            'success' => 'revdelete-success',
            'failure' => 'revdelete-failure',
            'text' => 'revdelete-text-file',
            'selected'=> 'revdelete-selected-file',
        ],
        'logging' => [
            'check-label' => 'revdelete-hide-name',
            'success' => 'logdelete-success',
            'failure' => 'logdelete-failure',
            'text' => 'logdelete-text',
            'selected' => 'logdelete-selected',
        ],
    ];

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

    public function doesWrites() {
        return true;
    }

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

        $this->checkPermissions();
        $this->checkReadOnly();

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

        // Check blocks
        if ( $user->isBlocked() ) {
            throw new UserBlockedError( $user->getBlock() );
        }

        $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', [] ) );
        }
        // $this->ids = array_map( 'intval', $this->ids );
        $this->ids = array_unique( array_filter( $this->ids ) );

        $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;
        }

        $this->typeName = RevisionDeleter::getCanonicalTypeName( $this->typeName );

        # No targets?
        if ( !$this->typeName || count( $this->ids ) == 0 ) {
            throw new ErrorPageError( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
        }

        # Allow the list type to adjust the passed target
        $this->targetObj = RevisionDeleter::suggestTarget(
            $this->typeName,
            $this->targetObj,
            $this->ids
        );

        # We need a target page!
        if ( $this->targetObj === null ) {
            $output->addWikiMsg( 'undelete-header' );

            return;
        }

        $this->typeLabels = self::$UILabels[$this->typeName];
        $list = $this->getList();
        $list->reset();
        $this->mIsAllowed = $user->isAllowed( RevisionDeleter::getRestriction( $this->typeName ) );
        $canViewSuppressedOnly = $this->getUser()->isAllowed( 'viewsuppressed' ) &&
            !$this->getUser()->isAllowed( 'suppressrevision' );
        $pageIsSuppressed = $list->areAnySuppressed();
        $this->mIsAllowed = $this->mIsAllowed && !( $canViewSuppressedOnly && $pageIsSuppressed );

        $this->otherReason = $request->getVal( 'wpReason' );
        # Give a link to the logs/hist for this page
        $this->showConvenienceLinks();

        # Initialise checkboxes
        $this->checks = [
            # Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name
            [ $this->typeLabels['check-label'], 'wpHidePrimary',
                RevisionDeleter::getRevdelConstant( $this->typeName )
            ],
            [ 'revdelete-hide-comment', 'wpHideComment', Revision::DELETED_COMMENT ],
            [ 'revdelete-hide-user', 'wpHideUser', Revision::DELETED_USER ]
        ];
        if ( $user->isAllowed( 'suppressrevision' ) ) {
            $this->checks[] = [ '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
        $deleteLogPage = new LogPage( 'delete' );
        $output->addHTML( "<h2>" . $deleteLogPage->getName()->escaped() . "</h2>\n" );
        LogEventsList::showLogExtract(
            $output,
            'delete',
            $this->targetObj,
            '', /* user */
            [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
        );
        # Show relevant lines from the suppression log
        if ( $user->isAllowed( 'suppressionlog' ) ) {
            $suppressLogPage = new LogPage( 'suppress' );
            $output->addHTML( "<h2>" . $suppressLogPage->getName()->escaped() . "</h2>\n" );
            LogEventsList::showLogExtract(
                $output,
                'suppress',
                $this->targetObj,
                '',
                [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
            );
        }
    }

    protected function showConvenienceLinks() {
        # Give a link to the logs/hist for this page
        if ( $this->targetObj ) {
            // Also set header tabs to be for the target.
            $this->getSkin()->setRelevantTitle( $this->targetObj );

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

    protected function getLogQueryCond() {
        $conds = [];
        // Revision delete logs for these item
        $conds['log_type'] = [ '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;
        }
        $user = $this->getUser();
        if ( !$oimage->userCan( File::DELETED_FILE, $user ) ) {
            if ( $oimage->isDeleted( File::DELETED_RESTRICTED ) ) {
                throw new PermissionsError( 'suppressrevision' );
            } else {
                throw new PermissionsError( 'deletedtext' );
            }
        }
        if ( !$user->matchEditToken( $this->token, $archiveName ) ) {
            $lang = $this->getLanguage();
            $this->getOutput()->addWikiMsg( 'revdelete-show-file-confirm',
                $this->targetObj->getText(),
                $lang->userDate( $oimage->getTimestamp(), $user ),
                $lang->userTime( $oimage->getTimestamp(), $user ) );
            $this->getOutput()->addHTML(
                Xml::openElement( 'form', [
                    'method' => 'POST',
                    'action' => $this->getPageTitle()->getLocalURL( [
                            'target' => $this->targetObj->getPrefixedDBkey(),
                            'file' => $archiveName,
                            'token' => $user->getEditToken( $archiveName ),
                        ] )
                    ]
                ) .
                Xml::submitButton( $this->msg( 'revdelete-show-file-submit' )->text() ) .
                '</form>'
            );

            return;
        }
        $this->getOutput()->disable();
        # We mustn't allow the output to be CDN 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 CDN 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->revDelList ) ) {
            $this->revDelList = RevisionDeleter::createList(
                $this->typeName, $this->getContext(), $this->targetObj, $this->ids
            );
        }

        return $this->revDelList;
    }

    protected function showForm() {
        $userAllowed = true;

        // Messages: revdelete-selected-text, revdelete-selected-file, logdelete-selected
        $out = $this->getOutput();
        $out->wrapWikiMsg( "<strong>$1</strong>", [ $this->typeLabels['selected'],
            $this->getLanguage()->formatNum( count( $this->ids ) ), $this->targetObj->getPrefixedText() ] );

        $this->addHelpLink( 'Help:RevisionDelete' );
        $out->addHTML( "<ul>" );

        $numRevisions = 0;
        // Live revisions...
        $list = $this->getList();
        // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
        for ( $list->reset(); $list->current(); $list->next() ) {
            // @codingStandardsIgnoreEnd
            $item = $list->current();

            if ( !$item->canView() ) {
                if ( !$this->submitClicked ) {
                    throw new PermissionsError( 'suppressrevision' );
                }
                $userAllowed = false;
            }

            $numRevisions++;
            $out->addHTML( $item->getHTML() );
        }

        if ( !$numRevisions ) {
            throw new ErrorPageError( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
        }

        $out->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->addModuleStyles( 'mediawiki.special' );

            $form = Xml::openElement( 'form', [ 'method' => 'post',
                    'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ),
                    'id' => 'mw-revdel-form-revisions' ] ) .
                Xml::fieldset( $this->msg( 'revdelete-legend' )->text() ) .
                $this->buildCheckBoxes() .
                Xml::openElement( 'table' ) .
                "<tr>\n" .
                    '<td class="mw-label">' .
                        Xml::label( $this->msg( 'revdelete-log' )->text(), 'wpRevDeleteReasonList' ) .
                    '</td>' .
                    '<td class="mw-input">' .
                        Xml::listDropDown( 'wpRevDeleteReasonList',
                            $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->text(),
                            $this->msg( 'revdelete-reasonotherlist' )->inContentLanguage()->text(),
                            $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' ), 'wpReasonDropDown'
                        ) .
                    '</td>' .
                "</tr><tr>\n" .
                    '<td class="mw-label">' .
                        Xml::label( $this->msg( 'revdelete-otherreason' )->text(), 'wpReason' ) .
                    '</td>' .
                    '<td class="mw-input">' .
                        Xml::input(
                            'wpReason',
                            60,
                            $this->otherReason,
                            [ 'id' => 'wpReason', 'maxlength' => 100 ]
                        ) .
                    '</td>' .
                "</tr><tr>\n" .
                    '<td></td>' .
                    '<td class="mw-submit">' .
                        Xml::submitButton( $this->msg( 'revdelete-submit', $numRevisions )->text(),
                            [ '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" .
                Xml::closeElement( 'form' ) . "\n";
            // Show link to edit the dropdown reasons
            if ( $this->getUser()->isAllowed( 'editinterface' ) ) {
                $link = Linker::linkKnown(
                    $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->getTitle(),
                    $this->msg( 'revdelete-edit-reasonlist' )->escaped(),
                    [],
                    [ 'action' => 'edit' ]
                );
                $form .= Xml::tags( 'p', [ 'class' => 'mw-revdel-editreasons' ], $link ) . "\n";
            }
        } else {
            $form = '';
        }
        $out->addHTML( $form );
    }

    protected function addUsageText() {
        // Messages: revdelete-text-text, revdelete-text-file, logdelete-text
        $this->getOutput()->wrapWikiMsg(
            "<strong>$1</strong>\n$2", $this->typeLabels['text'],
            'revdelete-text-others'
        );

        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 = RevisionDeleter::extractBitfield( $this->extractBitParams(), $bitfield );
            }

            foreach ( $this->checks as $item ) {
                // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
                // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
                list( $message, $name, $field ) = $item;
                $innerHTML = Xml::checkLabel(
                    $this->msg( $message )->text(),
                    $name,
                    $name,
                    $bitfield & $field
                );

                if ( $field == Revision::DELETED_RESTRICTED ) {
                    $innerHTML = "<b>$innerHTML</b>";
                }

                $line = Xml::tags( 'td', [ 'class' => 'mw-input' ], $innerHTML );
                $html .= "<tr>$line</tr>\n";
            }
        } else {
            // Otherwise, use tri-state radios
            $html .= '<tr>';
            $html .= '<th class="mw-revdel-checkbox">'
                . $this->msg( 'revdelete-radio-same' )->escaped() . '</th>';
            $html .= '<th class="mw-revdel-checkbox">'
                . $this->msg( 'revdelete-radio-unset' )->escaped() . '</th>';
            $html .= '<th class="mw-revdel-checkbox">'
                . $this->msg( 'revdelete-radio-set' )->escaped() . '</th>';
            $html .= "<th></th></tr>\n";
            foreach ( $this->checks as $item ) {
                // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
                // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
                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 = $this->msg( $message )->escaped();
                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();
        // from dropdown
        $listReason = $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' );
        $comment = $listReason;
        if ( $comment === 'other' ) {
            $comment = $this->otherReason;
        } elseif ( $this->otherReason !== '' ) {
            // Entry from drop down menu + additional comment
            $comment .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
                . $this->otherReason;
        }
        # Can the user set this field?
        if ( $bitParams[Revision::DELETED_RESTRICTED] == 1
            && !$this->getUser()->isAllowed( 'suppressrevision' )
        ) {
            throw new PermissionsError( 'suppressrevision' );
        }
        # If the save went through, go to success message...
        $status = $this->save( $bitParams, $comment );
        if ( $status->isGood() ) {
            $this->success();

            return true;
        } else {
            # ...otherwise, bounce back to form...
            $this->failure( $status );
        }

        return false;
    }

    protected function success() {
        // Messages: revdelete-success, logdelete-success
        $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
        $this->getOutput()->wrapWikiMsg(
            "<div class=\"successbox\">\n$1\n</div>",
            $this->typeLabels['success']
        );
        $this->wasSaved = true;
        $this->revDelList->reloadFromMaster();
        $this->showForm();
    }

    protected function failure( $status ) {
        // Messages: revdelete-failure, logdelete-failure
        $this->getOutput()->setPageTitle( $this->msg( 'actionfailed' ) );
        $this->getOutput()->addWikiText( '<div class="errorbox">' .
            $status->getWikiText( $this->typeLabels['failure'] ) .
            '</div>'
        );
        $this->showForm();
    }

    protected function extractBitParams() {
        $bitfield = [];
        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;
    }

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

    protected function getGroupName() {
        return 'pagetools';
    }
}