includes/specials/SpecialRevisiondelete.php

   1 <?php
   2 /**
   3  * Implements Special:Revisiondelete
   4  *
   5  * This program is free software; you can redistribute it and/or modify
   6  * it under the terms of the GNU General Public License as published by
   7  * the Free Software Foundation; either version 2 of the License, or
   8  * (at your option) any later version.
   9  *
  10  * This program is distributed in the hope that it will be useful,
  11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  13  * GNU General Public License for more details.
  14  *
  15  * You should have received a copy of the GNU General Public License along
  16  * with this program; if not, write to the Free Software Foundation, Inc.,
  17  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  18  * http://www.gnu.org/copyleft/gpl.html
  19  *
  20  * @file
  21  * @ingroup SpecialPage
  22  */
  23
  24 /**
  25  * Special page allowing users with the appropriate permissions to view
  26  * and hide revisions. Log items can also be hidden.
  27  *
  28  * @ingroup SpecialPage
  29  */
  30 class SpecialRevisionDelete extends UnlistedSpecialPage {
  31         /** @var bool Was the DB modified in this request */
  32         protected $wasSaved = false;
  33
  34         /** @var bool True if the submit button was clicked, and the form was posted */
  35         private $submitClicked;
  36
  37         /** @var array Target ID list */
  38         private $ids;
  39
  40         /** @var string Archive name, for reviewing deleted files */
  41         private $archiveName;
  42
  43         /** @var string Edit token for securing image views against XSS */
  44         private $token;
  45
  46         /** @var Title Title object for target parameter */
  47         private $targetObj;
  48
  49         /** @var string Deletion type, may be revision, archive, oldimage, filearchive, logging. */
  50         private $typeName;
  51
  52         /** @var array Array of checkbox specs (message, name, deletion bits) */
  53         private $checks;
  54
  55         /** @var array UI Labels about the current type */
  56         private $typeLabels;
  57
  58         /** @var RevDelList RevDelList object, storing the list of items to be deleted/undeleted */
  59         private $revDelList;
  60
  61         /** @var bool Whether user is allowed to perform the action */
  62         private $mIsAllowed;
  63
  64         /** @var string */
  65         private $otherReason;
  66
  67         /**
  68          * UI labels for each type.
  69          */
  70         private static $UILabels = [
  71                 'revision' => [
  72                         'check-label' => 'revdelete-hide-text',
  73                         'success' => 'revdelete-success',
  74                         'failure' => 'revdelete-failure',
  75                         'text' => 'revdelete-text-text',
  76                         'selected' => 'revdelete-selected-text',
  77                 ],
  78                 'archive' => [
  79                         'check-label' => 'revdelete-hide-text',
  80                         'success' => 'revdelete-success',
  81                         'failure' => 'revdelete-failure',
  82                         'text' => 'revdelete-text-text',
  83                         'selected' => 'revdelete-selected-text',
  84                 ],
  85                 'oldimage' => [
  86                         'check-label' => 'revdelete-hide-image',
  87                         'success' => 'revdelete-success',
  88                         'failure' => 'revdelete-failure',
  89                         'text' => 'revdelete-text-file',
  90                         'selected' => 'revdelete-selected-file',
  91                 ],
  92                 'filearchive' => [
  93                         'check-label' => 'revdelete-hide-image',
  94                         'success' => 'revdelete-success',
  95                         'failure' => 'revdelete-failure',
  96                         'text' => 'revdelete-text-file',
  97                         'selected' => 'revdelete-selected-file',
  98                 ],
  99                 'logging' => [
 100                         'check-label' => 'revdelete-hide-name',
 101                         'success' => 'logdelete-success',
 102                         'failure' => 'logdelete-failure',
 103                         'text' => 'logdelete-text',
 104                         'selected' => 'logdelete-selected',
 105                 ],
 106         ];
 107
 108         public function __construct() {
 109                 parent::__construct( 'Revisiondelete', 'deleterevision' );
 110         }
 111
 112         public function doesWrites() {
 113                 return true;
 114         }
 115
 116         public function execute( $par ) {
 117                 $this->useTransactionalTimeLimit();
 118
 119                 $this->checkPermissions();
 120                 $this->checkReadOnly();
 121
 122                 $output = $this->getOutput();
 123                 $user = $this->getUser();
 124
 125                 // Check blocks
 126                 if ( $user->isBlocked() ) {
 127                         throw new UserBlockedError( $user->getBlock() );
 128                 }
 129
 130                 $this->setHeaders();
 131                 $this->outputHeader();
 132                 $request = $this->getRequest();
 133                 $this->submitClicked = $request->wasPosted() && $request->getBool( 'wpSubmit' );
 134                 # Handle our many different possible input types.
 135                 $ids = $request->getVal( 'ids' );
 136                 if ( !is_null( $ids ) ) {
 137                         # Allow CSV, for backwards compatibility, or a single ID for show/hide links
 138                         $this->ids = explode( ',', $ids );
 139                 } else {
 140                         # Array input
 141                         $this->ids = array_keys( $request->getArray( 'ids', [] ) );
 142                 }
 143                 // $this->ids = array_map( 'intval', $this->ids );
 144                 $this->ids = array_unique( array_filter( $this->ids ) );
 145
 146                 $this->typeName = $request->getVal( 'type' );
 147                 $this->targetObj = Title::newFromText( $request->getText( 'target' ) );
 148
 149                 # For reviewing deleted files...
 150                 $this->archiveName = $request->getVal( 'file' );
 151                 $this->token = $request->getVal( 'token' );
 152                 if ( $this->archiveName && $this->targetObj ) {
 153                         $this->tryShowFile( $this->archiveName );
 154
 155                         return;
 156                 }
 157
 158                 $this->typeName = RevisionDeleter::getCanonicalTypeName( $this->typeName );
 159
 160                 # No targets?
 161                 if ( !$this->typeName || count( $this->ids ) == 0 ) {
 162                         throw new ErrorPageError( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
 163                 }
 164
 165                 # Allow the list type to adjust the passed target
 166                 $this->targetObj = RevisionDeleter::suggestTarget(
 167                         $this->typeName,
 168                         $this->targetObj,
 169                         $this->ids
 170                 );
 171
 172                 # We need a target page!
 173                 if ( $this->targetObj === null ) {
 174                         $output->addWikiMsg( 'undelete-header' );
 175
 176                         return;
 177                 }
 178
 179                 $this->typeLabels = self::$UILabels[$this->typeName];
 180                 $list = $this->getList();
 181                 $list->reset();
 182                 $this->mIsAllowed = $user->isAllowed( RevisionDeleter::getRestriction( $this->typeName ) );
 183                 $canViewSuppressedOnly = $this->getUser()->isAllowed( 'viewsuppressed' ) &&
 184                         !$this->getUser()->isAllowed( 'suppressrevision' );
 185                 $pageIsSuppressed = $list->areAnySuppressed();
 186                 $this->mIsAllowed = $this->mIsAllowed && !( $canViewSuppressedOnly && $pageIsSuppressed );
 187
 188                 $this->otherReason = $request->getVal( 'wpReason' );
 189                 # Give a link to the logs/hist for this page
 190                 $this->showConvenienceLinks();
 191
 192                 # Initialise checkboxes
 193                 $this->checks = [
 194                         # Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name
 195                         [ $this->typeLabels['check-label'], 'wpHidePrimary',
 196                                 RevisionDeleter::getRevdelConstant( $this->typeName )
 197                         ],
 198                         [ 'revdelete-hide-comment', 'wpHideComment', Revision::DELETED_COMMENT ],
 199                         [ 'revdelete-hide-user', 'wpHideUser', Revision::DELETED_USER ]
 200                 ];
 201                 if ( $user->isAllowed( 'suppressrevision' ) ) {
 202                         $this->checks[] = [ 'revdelete-hide-restricted',
 203                                 'wpHideRestricted', Revision::DELETED_RESTRICTED ];
 204                 }
 205
 206                 # Either submit or create our form
 207                 if ( $this->mIsAllowed && $this->submitClicked ) {
 208                         $this->submit( $request );
 209                 } else {
 210                         $this->showForm();
 211                 }
 212
 213                 if ( $user->isAllowed( 'deletedhistory' ) ) {
 214                         $qc = $this->getLogQueryCond();
 215                         # Show relevant lines from the deletion log
 216                         $deleteLogPage = new LogPage( 'delete' );
 217                         $output->addHTML( "<h2>" . $deleteLogPage->getName()->escaped() . "</h2>\n" );
 218                         LogEventsList::showLogExtract(
 219                                 $output,
 220                                 'delete',
 221                                 $this->targetObj,
 222                                 '', /* user */
 223                                 [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
 224                         );
 225                 }
 226                 # Show relevant lines from the suppression log
 227                 if ( $user->isAllowed( 'suppressionlog' ) ) {
 228                         $suppressLogPage = new LogPage( 'suppress' );
 229                         $output->addHTML( "<h2>" . $suppressLogPage->getName()->escaped() . "</h2>\n" );
 230                         LogEventsList::showLogExtract(
 231                                 $output,
 232                                 'suppress',
 233                                 $this->targetObj,
 234                                 '',
 235                                 [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
 236                         );
 237                 }
 238         }
 239
 240         /**
 241          * Show some useful links in the subtitle
 242          */
 243         protected function showConvenienceLinks() {
 244                 $linkRenderer = $this->getLinkRenderer();
 245                 # Give a link to the logs/hist for this page
 246                 if ( $this->targetObj ) {
 247                         // Also set header tabs to be for the target.
 248                         $this->getSkin()->setRelevantTitle( $this->targetObj );
 249
 250                         $links = [];
 251                         $links[] = $linkRenderer->makeKnownLink(
 252                                 SpecialPage::getTitleFor( 'Log' ),
 253                                 $this->msg( 'viewpagelogs' )->text(),
 254                                 [],
 255                                 [ 'page' => $this->targetObj->getPrefixedText() ]
 256                         );
 257                         if ( !$this->targetObj->isSpecialPage() ) {
 258                                 # Give a link to the page history
 259                                 $links[] = $linkRenderer->makeKnownLink(
 260                                         $this->targetObj,
 261                                         $this->msg( 'pagehist' )->text(),
 262                                         [],
 263                                         [ 'action' => 'history' ]
 264                                 );
 265                                 # Link to deleted edits
 266                                 if ( $this->getUser()->isAllowed( 'undelete' ) ) {
 267                                         $undelete = SpecialPage::getTitleFor( 'Undelete' );
 268                                         $links[] = $linkRenderer->makeKnownLink(
 269                                                 $undelete,
 270                                                 $this->msg( 'deletedhist' )->text(),
 271                                                 [],
 272                                                 [ 'target' => $this->targetObj->getPrefixedDBkey() ]
 273                                         );
 274                                 }
 275                         }
 276                         # Logs themselves don't have histories or archived revisions
 277                         $this->getOutput()->addSubtitle( $this->getLanguage()->pipeList( $links ) );
 278                 }
 279         }
 280
 281         /**
 282          * Get the condition used for fetching log snippets
 283          * @return array
 284          */
 285         protected function getLogQueryCond() {
 286                 $conds = [];
 287                 // Revision delete logs for these item
 288                 $conds['log_type'] = [ 'delete', 'suppress' ];
 289                 $conds['log_action'] = $this->getList()->getLogAction();
 290                 $conds['ls_field'] = RevisionDeleter::getRelationType( $this->typeName );
 291                 $conds['ls_value'] = $this->ids;
 292
 293                 return $conds;
 294         }
 295
 296         /**
 297          * Show a deleted file version requested by the visitor.
 298          * @todo Mostly copied from Special:Undelete. Refactor.
 299          * @param string $archiveName
 300          * @throws MWException
 301          * @throws PermissionsError
 302          */
 303         protected function tryShowFile( $archiveName ) {
 304                 $repo = RepoGroup::singleton()->getLocalRepo();
 305                 $oimage = $repo->newFromArchiveName( $this->targetObj, $archiveName );
 306                 $oimage->load();
 307                 // Check if user is allowed to see this file
 308                 if ( !$oimage->exists() ) {
 309                         $this->getOutput()->addWikiMsg( 'revdelete-no-file' );
 310
 311                         return;
 312                 }
 313                 $user = $this->getUser();
 314                 if ( !$oimage->userCan( File::DELETED_FILE, $user ) ) {
 315                         if ( $oimage->isDeleted( File::DELETED_RESTRICTED ) ) {
 316                                 throw new PermissionsError( 'suppressrevision' );
 317                         } else {
 318                                 throw new PermissionsError( 'deletedtext' );
 319                         }
 320                 }
 321                 if ( !$user->matchEditToken( $this->token, $archiveName ) ) {
 322                         $lang = $this->getLanguage();
 323                         $this->getOutput()->addWikiMsg( 'revdelete-show-file-confirm',
 324                                 $this->targetObj->getText(),
 325                                 $lang->userDate( $oimage->getTimestamp(), $user ),
 326                                 $lang->userTime( $oimage->getTimestamp(), $user ) );
 327                         $this->getOutput()->addHTML(
 328                                 Xml::openElement( 'form', [
 329                                         'method' => 'POST',
 330                                         'action' => $this->getPageTitle()->getLocalURL( [
 331                                                         'target' => $this->targetObj->getPrefixedDBkey(),
 332                                                         'file' => $archiveName,
 333                                                         'token' => $user->getEditToken( $archiveName ),
 334                                                 ] )
 335                                         ]
 336                                 ) .
 337                                 Xml::submitButton( $this->msg( 'revdelete-show-file-submit' )->text() ) .
 338                                 '</form>'
 339                         );
 340
 341                         return;
 342                 }
 343                 $this->getOutput()->disable();
 344                 # We mustn't allow the output to be CDN cached, otherwise
 345                 # if an admin previews a deleted image, and it's cached, then
 346                 # a user without appropriate permissions can toddle off and
 347                 # nab the image, and CDN will serve it
 348                 $this->getRequest()->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
 349                 $this->getRequest()->response()->header(
 350                         'Cache-Control: no-cache, no-store, max-age=0, must-revalidate'
 351                 );
 352                 $this->getRequest()->response()->header( 'Pragma: no-cache' );
 353
 354                 $key = $oimage->getStorageKey();
 355                 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
 356                 $repo->streamFile( $path );
 357         }
 358
 359         /**
 360          * Get the list object for this request
 361          * @return RevDelList
 362          */
 363         protected function getList() {
 364                 if ( is_null( $this->revDelList ) ) {
 365                         $this->revDelList = RevisionDeleter::createList(
 366                                 $this->typeName, $this->getContext(), $this->targetObj, $this->ids
 367                         );
 368                 }
 369
 370                 return $this->revDelList;
 371         }
 372
 373         /**
 374          * Show a list of items that we will operate on, and show a form with checkboxes
 375          * which will allow the user to choose new visibility settings.
 376          */
 377         protected function showForm() {
 378                 $userAllowed = true;
 379
 380                 // Messages: revdelete-selected-text, revdelete-selected-file, logdelete-selected
 381                 $out = $this->getOutput();
 382                 $out->wrapWikiMsg( "<strong>$1</strong>", [ $this->typeLabels['selected'],
 383                         $this->getLanguage()->formatNum( count( $this->ids ) ), $this->targetObj->getPrefixedText() ] );
 384
 385                 $this->addHelpLink( 'Help:RevisionDelete' );
 386                 $out->addHTML( "<ul>" );
 387
 388                 $numRevisions = 0;
 389                 // Live revisions...
 390                 $list = $this->getList();
 391                 // @codingStandardsIgnoreStart Generic.CodeAnalysis.ForLoopWithTestFunctionCall.NotAllowed
 392                 for ( $list->reset(); $list->current(); $list->next() ) {
 393                         // @codingStandardsIgnoreEnd
 394                         $item = $list->current();
 395
 396                         if ( !$item->canView() ) {
 397                                 if ( !$this->submitClicked ) {
 398                                         throw new PermissionsError( 'suppressrevision' );
 399                                 }
 400                                 $userAllowed = false;
 401                         }
 402
 403                         $numRevisions++;
 404                         $out->addHTML( $item->getHTML() );
 405                 }
 406
 407                 if ( !$numRevisions ) {
 408                         throw new ErrorPageError( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
 409                 }
 410
 411                 $out->addHTML( "</ul>" );
 412                 // Explanation text
 413                 $this->addUsageText();
 414
 415                 // Normal sysops can always see what they did, but can't always change it
 416                 if ( !$userAllowed ) {
 417                         return;
 418                 }
 419
 420                 // Show form if the user can submit
 421                 if ( $this->mIsAllowed ) {
 422                         $out->addModuleStyles( 'mediawiki.special' );
 423
 424                         $form = Xml::openElement( 'form', [ 'method' => 'post',
 425                                         'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ),
 426                                         'id' => 'mw-revdel-form-revisions' ] ) .
 427                                 Xml::fieldset( $this->msg( 'revdelete-legend' )->text() ) .
 428                                 $this->buildCheckBoxes() .
 429                                 Xml::openElement( 'table' ) .
 430                                 "<tr>\n" .
 431                                         '<td class="mw-label">' .
 432                                                 Xml::label( $this->msg( 'revdelete-log' )->text(), 'wpRevDeleteReasonList' ) .
 433                                         '</td>' .
 434                                         '<td class="mw-input">' .
 435                                                 Xml::listDropDown( 'wpRevDeleteReasonList',
 436                                                         $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->text(),
 437                                                         $this->msg( 'revdelete-reasonotherlist' )->inContentLanguage()->text(),
 438                                                         $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' ), 'wpReasonDropDown'
 439                                                 ) .
 440                                         '</td>' .
 441                                 "</tr><tr>\n" .
 442                                         '<td class="mw-label">' .
 443                                                 Xml::label( $this->msg( 'revdelete-otherreason' )->text(), 'wpReason' ) .
 444                                         '</td>' .
 445                                         '<td class="mw-input">' .
 446                                                 Xml::input(
 447                                                         'wpReason',
 448                                                         60,
 449                                                         $this->otherReason,
 450                                                         [ 'id' => 'wpReason', 'maxlength' => 100 ]
 451                                                 ) .
 452                                         '</td>' .
 453                                 "</tr><tr>\n" .
 454                                         '<td></td>' .
 455                                         '<td class="mw-submit">' .
 456                                                 Xml::submitButton( $this->msg( 'revdelete-submit', $numRevisions )->text(),
 457                                                         [ 'name' => 'wpSubmit' ] ) .
 458                                         '</td>' .
 459                                 "</tr>\n" .
 460                                 Xml::closeElement( 'table' ) .
 461                                 Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() ) .
 462                                 Html::hidden( 'target', $this->targetObj->getPrefixedText() ) .
 463                                 Html::hidden( 'type', $this->typeName ) .
 464                                 Html::hidden( 'ids', implode( ',', $this->ids ) ) .
 465                                 Xml::closeElement( 'fieldset' ) . "\n" .
 466                                 Xml::closeElement( 'form' ) . "\n";
 467                         // Show link to edit the dropdown reasons
 468                         if ( $this->getUser()->isAllowed( 'editinterface' ) ) {
 469                                 $link = $this->getLinkRenderer()->makeKnownLink(
 470                                         $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->getTitle(),
 471                                         $this->msg( 'revdelete-edit-reasonlist' )->text(),
 472                                         [],
 473                                         [ 'action' => 'edit' ]
 474                                 );
 475                                 $form .= Xml::tags( 'p', [ 'class' => 'mw-revdel-editreasons' ], $link ) . "\n";
 476                         }
 477                 } else {
 478                         $form = '';
 479                 }
 480                 $out->addHTML( $form );
 481         }
 482
 483         /**
 484          * Show some introductory text
 485          * @todo FIXME: Wikimedia-specific policy text
 486          */
 487         protected function addUsageText() {
 488                 // Messages: revdelete-text-text, revdelete-text-file, logdelete-text
 489                 $this->getOutput()->wrapWikiMsg(
 490                         "<strong>$1</strong>\n$2", $this->typeLabels['text'],
 491                         'revdelete-text-others'
 492                 );
 493
 494                 if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
 495                         $this->getOutput()->addWikiMsg( 'revdelete-suppress-text' );
 496                 }
 497
 498                 if ( $this->mIsAllowed ) {
 499                         $this->getOutput()->addWikiMsg( 'revdelete-confirm' );
 500                 }
 501         }
 502
 503         /**
 504          * @return string HTML
 505          */
 506         protected function buildCheckBoxes() {
 507                 $html = '<table>';
 508                 // If there is just one item, use checkboxes
 509                 $list = $this->getList();
 510                 if ( $list->length() == 1 ) {
 511                         $list->reset();
 512                         $bitfield = $list->current()->getBits(); // existing field
 513
 514                         if ( $this->submitClicked ) {
 515                                 $bitfield = RevisionDeleter::extractBitfield( $this->extractBitParams(), $bitfield );
 516                         }
 517
 518                         foreach ( $this->checks as $item ) {
 519                                 // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
 520                                 // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
 521                                 list( $message, $name, $field ) = $item;
 522                                 $innerHTML = Xml::checkLabel(
 523                                         $this->msg( $message )->text(),
 524                                         $name,
 525                                         $name,
 526                                         $bitfield & $field
 527                                 );
 528
 529                                 if ( $field == Revision::DELETED_RESTRICTED ) {
 530                                         $innerHTML = "<b>$innerHTML</b>";
 531                                 }
 532
 533                                 $line = Xml::tags( 'td', [ 'class' => 'mw-input' ], $innerHTML );
 534                                 $html .= "<tr>$line</tr>\n";
 535                         }
 536                 } else {
 537                         // Otherwise, use tri-state radios
 538                         $html .= '<tr>';
 539                         $html .= '<th class="mw-revdel-checkbox">'
 540                                 . $this->msg( 'revdelete-radio-same' )->escaped() . '</th>';
 541                         $html .= '<th class="mw-revdel-checkbox">'
 542                                 . $this->msg( 'revdelete-radio-unset' )->escaped() . '</th>';
 543                         $html .= '<th class="mw-revdel-checkbox">'
 544                                 . $this->msg( 'revdelete-radio-set' )->escaped() . '</th>';
 545                         $html .= "<th></th></tr>\n";
 546                         foreach ( $this->checks as $item ) {
 547                                 // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
 548                                 // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
 549                                 list( $message, $name, $field ) = $item;
 550                                 // If there are several items, use third state by default...
 551                                 if ( $this->submitClicked ) {
 552                                         $selected = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
 553                                 } else {
 554                                         $selected = -1; // use existing field
 555                                 }
 556                                 $line = '<td class="mw-revdel-checkbox">' . Xml::radio( $name, -1, $selected == -1 ) . '</td>';
 557                                 $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 0, $selected == 0 ) . '</td>';
 558                                 $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 1, $selected == 1 ) . '</td>';
 559                                 $label = $this->msg( $message )->escaped();
 560                                 if ( $field == Revision::DELETED_RESTRICTED ) {
 561                                         $label = "<b>$label</b>";
 562                                 }
 563                                 $line .= "<td>$label</td>";
 564                                 $html .= "<tr>$line</tr>\n";
 565                         }
 566                 }
 567
 568                 $html .= '</table>';
 569
 570                 return $html;
 571         }
 572
 573         /**
 574          * UI entry point for form submission.
 575          * @throws PermissionsError
 576          * @return bool
 577          */
 578         protected function submit() {
 579                 # Check edit token on submission
 580                 $token = $this->getRequest()->getVal( 'wpEditToken' );
 581                 if ( $this->submitClicked && !$this->getUser()->matchEditToken( $token ) ) {
 582                         $this->getOutput()->addWikiMsg( 'sessionfailure' );
 583
 584                         return false;
 585                 }
 586                 $bitParams = $this->extractBitParams();
 587                 // from dropdown
 588                 $listReason = $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' );
 589                 $comment = $listReason;
 590                 if ( $comment === 'other' ) {
 591                         $comment = $this->otherReason;
 592                 } elseif ( $this->otherReason !== '' ) {
 593                         // Entry from drop down menu + additional comment
 594                         $comment .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
 595                                 . $this->otherReason;
 596                 }
 597                 # Can the user set this field?
 598                 if ( $bitParams[Revision::DELETED_RESTRICTED] == 1
 599                         && !$this->getUser()->isAllowed( 'suppressrevision' )
 600                 ) {
 601                         throw new PermissionsError( 'suppressrevision' );
 602                 }
 603                 # If the save went through, go to success message...
 604                 $status = $this->save( $bitParams, $comment );
 605                 if ( $status->isGood() ) {
 606                         $this->success();
 607
 608                         return true;
 609                 } else {
 610                         # ...otherwise, bounce back to form...
 611                         $this->failure( $status );
 612                 }
 613
 614                 return false;
 615         }
 616
 617         /**
 618          * Report that the submit operation succeeded
 619          */
 620         protected function success() {
 621                 // Messages: revdelete-success, logdelete-success
 622                 $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
 623                 $this->getOutput()->wrapWikiMsg(
 624                         "<div class=\"successbox\">\n$1\n</div>",
 625                         $this->typeLabels['success']
 626                 );
 627                 $this->wasSaved = true;
 628                 $this->revDelList->reloadFromMaster();
 629                 $this->showForm();
 630         }
 631
 632         /**
 633          * Report that the submit operation failed
 634          * @param Status $status
 635          */
 636         protected function failure( $status ) {
 637                 // Messages: revdelete-failure, logdelete-failure
 638                 $this->getOutput()->setPageTitle( $this->msg( 'actionfailed' ) );
 639                 $this->getOutput()->addWikiText( '<div class="errorbox">' .
 640                         $status->getWikiText( $this->typeLabels['failure'] ) .
 641                         '</div>'
 642                 );
 643                 $this->showForm();
 644         }
 645
 646         /**
 647          * Put together an array that contains -1, 0, or the *_deleted const for each bit
 648          *
 649          * @return array
 650          */
 651         protected function extractBitParams() {
 652                 $bitfield = [];
 653                 foreach ( $this->checks as $item ) {
 654                         list( /* message */, $name, $field ) = $item;
 655                         $val = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
 656                         if ( $val < -1 || $val > 1 ) {
 657                                 $val = -1; // -1 for existing value
 658                         }
 659                         $bitfield[$field] = $val;
 660                 }
 661                 if ( !isset( $bitfield[Revision::DELETED_RESTRICTED] ) ) {
 662                         $bitfield[Revision::DELETED_RESTRICTED] = 0;
 663                 }
 664
 665                 return $bitfield;
 666         }
 667
 668         /**
 669          * Do the write operations. Simple wrapper for RevDel*List::setVisibility().
 670          * @param array $bitPars ExtractBitParams() bitfield array
 671          * @param string $reason
 672          * @return Status
 673          */
 674         protected function save( array $bitPars, $reason ) {
 675                 return $this->getList()->setVisibility(
 676                         [ 'value' => $bitPars, 'comment' => $reason ]
 677                 );
 678         }
 679
 680         protected function getGroupName() {
 681                 return 'pagetools';
 682         }
 683 }