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                 // @TODO Use PermissionManager::isBlockedFrom() instead.
 127                 $block = $user->getBlock();
 128                 if ( $block ) {
 129                         throw new UserBlockedError( $block );
 130                 }
 131
 132                 $this->setHeaders();
 133                 $this->outputHeader();
 134                 $request = $this->getRequest();
 135                 $this->submitClicked = $request->wasPosted() && $request->getBool( 'wpSubmit' );
 136                 # Handle our many different possible input types.
 137                 $ids = $request->getVal( 'ids' );
 138                 if ( !is_null( $ids ) ) {
 139                         # Allow CSV, for backwards compatibility, or a single ID for show/hide links
 140                         $this->ids = explode( ',', $ids );
 141                 } else {
 142                         # Array input
 143                         $this->ids = array_keys( $request->getArray( 'ids', [] ) );
 144                 }
 145                 // $this->ids = array_map( 'intval', $this->ids );
 146                 $this->ids = array_unique( array_filter( $this->ids ) );
 147
 148                 $this->typeName = $request->getVal( 'type' );
 149                 $this->targetObj = Title::newFromText( $request->getText( 'target' ) );
 150
 151                 # For reviewing deleted files...
 152                 $this->archiveName = $request->getVal( 'file' );
 153                 $this->token = $request->getVal( 'token' );
 154                 if ( $this->archiveName && $this->targetObj ) {
 155                         $this->tryShowFile( $this->archiveName );
 156
 157                         return;
 158                 }
 159
 160                 $this->typeName = RevisionDeleter::getCanonicalTypeName( $this->typeName );
 161
 162                 # No targets?
 163                 if ( !$this->typeName || count( $this->ids ) == 0 ) {
 164                         throw new ErrorPageError( 'revdelete-nooldid-title', 'revdelete-nooldid-text' );
 165                 }
 166
 167                 # Allow the list type to adjust the passed target
 168                 $this->targetObj = RevisionDeleter::suggestTarget(
 169                         $this->typeName,
 170                         $this->targetObj,
 171                         $this->ids
 172                 );
 173
 174                 # We need a target page!
 175                 if ( $this->targetObj === null ) {
 176                         $output->addWikiMsg( 'undelete-header' );
 177
 178                         return;
 179                 }
 180
 181                 $this->typeLabels = self::$UILabels[$this->typeName];
 182                 $list = $this->getList();
 183                 $list->reset();
 184                 $this->mIsAllowed = $user->isAllowed( RevisionDeleter::getRestriction( $this->typeName ) );
 185                 $canViewSuppressedOnly = $this->getUser()->isAllowed( 'viewsuppressed' ) &&
 186                         !$this->getUser()->isAllowed( 'suppressrevision' );
 187                 $pageIsSuppressed = $list->areAnySuppressed();
 188                 $this->mIsAllowed = $this->mIsAllowed && !( $canViewSuppressedOnly && $pageIsSuppressed );
 189
 190                 $this->otherReason = $request->getVal( 'wpReason' );
 191                 # Give a link to the logs/hist for this page
 192                 $this->showConvenienceLinks();
 193
 194                 # Initialise checkboxes
 195                 $this->checks = [
 196                         # Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name
 197                         [ $this->typeLabels['check-label'], 'wpHidePrimary',
 198                                 RevisionDeleter::getRevdelConstant( $this->typeName )
 199                         ],
 200                         [ 'revdelete-hide-comment', 'wpHideComment', Revision::DELETED_COMMENT ],
 201                         [ 'revdelete-hide-user', 'wpHideUser', Revision::DELETED_USER ]
 202                 ];
 203                 if ( $user->isAllowed( 'suppressrevision' ) ) {
 204                         $this->checks[] = [ 'revdelete-hide-restricted',
 205                                 'wpHideRestricted', Revision::DELETED_RESTRICTED ];
 206                 }
 207
 208                 # Either submit or create our form
 209                 if ( $this->mIsAllowed && $this->submitClicked ) {
 210                         $this->submit();
 211                 } else {
 212                         $this->showForm();
 213                 }
 214
 215                 if ( $user->isAllowed( 'deletedhistory' ) ) {
 216                         $qc = $this->getLogQueryCond();
 217                         # Show relevant lines from the deletion log
 218                         $deleteLogPage = new LogPage( 'delete' );
 219                         $output->addHTML( "<h2>" . $deleteLogPage->getName()->escaped() . "</h2>\n" );
 220                         LogEventsList::showLogExtract(
 221                                 $output,
 222                                 'delete',
 223                                 $this->targetObj,
 224                                 '', /* user */
 225                                 [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
 226                         );
 227                 }
 228                 # Show relevant lines from the suppression log
 229                 if ( $user->isAllowed( 'suppressionlog' ) ) {
 230                         $suppressLogPage = new LogPage( 'suppress' );
 231                         $output->addHTML( "<h2>" . $suppressLogPage->getName()->escaped() . "</h2>\n" );
 232                         LogEventsList::showLogExtract(
 233                                 $output,
 234                                 'suppress',
 235                                 $this->targetObj,
 236                                 '',
 237                                 [ 'lim' => 25, 'conds' => $qc, 'useMaster' => $this->wasSaved ]
 238                         );
 239                 }
 240         }
 241
 242         /**
 243          * Show some useful links in the subtitle
 244          */
 245         protected function showConvenienceLinks() {
 246                 $linkRenderer = $this->getLinkRenderer();
 247                 # Give a link to the logs/hist for this page
 248                 if ( $this->targetObj ) {
 249                         // Also set header tabs to be for the target.
 250                         $this->getSkin()->setRelevantTitle( $this->targetObj );
 251
 252                         $links = [];
 253                         $links[] = $linkRenderer->makeKnownLink(
 254                                 SpecialPage::getTitleFor( 'Log' ),
 255                                 $this->msg( 'viewpagelogs' )->text(),
 256                                 [],
 257                                 [ 'page' => $this->targetObj->getPrefixedText() ]
 258                         );
 259                         if ( !$this->targetObj->isSpecialPage() ) {
 260                                 # Give a link to the page history
 261                                 $links[] = $linkRenderer->makeKnownLink(
 262                                         $this->targetObj,
 263                                         $this->msg( 'pagehist' )->text(),
 264                                         [],
 265                                         [ 'action' => 'history' ]
 266                                 );
 267                                 # Link to deleted edits
 268                                 if ( $this->getUser()->isAllowed( 'undelete' ) ) {
 269                                         $undelete = SpecialPage::getTitleFor( 'Undelete' );
 270                                         $links[] = $linkRenderer->makeKnownLink(
 271                                                 $undelete,
 272                                                 $this->msg( 'deletedhist' )->text(),
 273                                                 [],
 274                                                 [ 'target' => $this->targetObj->getPrefixedDBkey() ]
 275                                         );
 276                                 }
 277                         }
 278                         # Logs themselves don't have histories or archived revisions
 279                         $this->getOutput()->addSubtitle( $this->getLanguage()->pipeList( $links ) );
 280                 }
 281         }
 282
 283         /**
 284          * Get the condition used for fetching log snippets
 285          * @return array
 286          */
 287         protected function getLogQueryCond() {
 288                 $conds = [];
 289                 // Revision delete logs for these item
 290                 $conds['log_type'] = [ 'delete', 'suppress' ];
 291                 $conds['log_action'] = $this->getList()->getLogAction();
 292                 $conds['ls_field'] = RevisionDeleter::getRelationType( $this->typeName );
 293                 $conds['ls_value'] = $this->ids;
 294
 295                 return $conds;
 296         }
 297
 298         /**
 299          * Show a deleted file version requested by the visitor.
 300          * @todo Mostly copied from Special:Undelete. Refactor.
 301          * @param string $archiveName
 302          * @throws MWException
 303          * @throws PermissionsError
 304          */
 305         protected function tryShowFile( $archiveName ) {
 306                 $repo = RepoGroup::singleton()->getLocalRepo();
 307                 $oimage = $repo->newFromArchiveName( $this->targetObj, $archiveName );
 308                 $oimage->load();
 309                 // Check if user is allowed to see this file
 310                 if ( !$oimage->exists() ) {
 311                         $this->getOutput()->addWikiMsg( 'revdelete-no-file' );
 312
 313                         return;
 314                 }
 315                 $user = $this->getUser();
 316                 if ( !$oimage->userCan( File::DELETED_FILE, $user ) ) {
 317                         if ( $oimage->isDeleted( File::DELETED_RESTRICTED ) ) {
 318                                 throw new PermissionsError( 'suppressrevision' );
 319                         } else {
 320                                 throw new PermissionsError( 'deletedtext' );
 321                         }
 322                 }
 323                 if ( !$user->matchEditToken( $this->token, $archiveName ) ) {
 324                         $lang = $this->getLanguage();
 325                         $this->getOutput()->addWikiMsg( 'revdelete-show-file-confirm',
 326                                 $this->targetObj->getText(),
 327                                 $lang->userDate( $oimage->getTimestamp(), $user ),
 328                                 $lang->userTime( $oimage->getTimestamp(), $user ) );
 329                         $this->getOutput()->addHTML(
 330                                 Xml::openElement( 'form', [
 331                                         'method' => 'POST',
 332                                         'action' => $this->getPageTitle()->getLocalURL( [
 333                                                         'target' => $this->targetObj->getPrefixedDBkey(),
 334                                                         'file' => $archiveName,
 335                                                         'token' => $user->getEditToken( $archiveName ),
 336                                                 ] )
 337                                         ]
 338                                 ) .
 339                                 Xml::submitButton( $this->msg( 'revdelete-show-file-submit' )->text() ) .
 340                                 '</form>'
 341                         );
 342
 343                         return;
 344                 }
 345                 $this->getOutput()->disable();
 346                 # We mustn't allow the output to be CDN cached, otherwise
 347                 # if an admin previews a deleted image, and it's cached, then
 348                 # a user without appropriate permissions can toddle off and
 349                 # nab the image, and CDN will serve it
 350                 $this->getRequest()->response()->header( 'Expires: ' . gmdate( 'D, d M Y H:i:s', 0 ) . ' GMT' );
 351                 $this->getRequest()->response()->header(
 352                         'Cache-Control: no-cache, no-store, max-age=0, must-revalidate'
 353                 );
 354                 $this->getRequest()->response()->header( 'Pragma: no-cache' );
 355
 356                 $key = $oimage->getStorageKey();
 357                 $path = $repo->getZonePath( 'deleted' ) . '/' . $repo->getDeletedHashPath( $key ) . $key;
 358                 $repo->streamFileWithStatus( $path );
 359         }
 360
 361         /**
 362          * Get the list object for this request
 363          * @return RevDelList
 364          */
 365         protected function getList() {
 366                 if ( is_null( $this->revDelList ) ) {
 367                         $this->revDelList = RevisionDeleter::createList(
 368                                 $this->typeName, $this->getContext(), $this->targetObj, $this->ids
 369                         );
 370                 }
 371
 372                 return $this->revDelList;
 373         }
 374
 375         /**
 376          * Show a list of items that we will operate on, and show a form with checkboxes
 377          * which will allow the user to choose new visibility settings.
 378          */
 379         protected function showForm() {
 380                 $userAllowed = true;
 381
 382                 // Messages: revdelete-selected-text, revdelete-selected-file, logdelete-selected
 383                 $out = $this->getOutput();
 384                 $out->wrapWikiMsg( "<strong>$1</strong>", [ $this->typeLabels['selected'],
 385                         $this->getLanguage()->formatNum( count( $this->ids ) ), $this->targetObj->getPrefixedText() ] );
 386
 387                 $this->addHelpLink( 'Help:RevisionDelete' );
 388                 $out->addHTML( "<ul>" );
 389
 390                 $numRevisions = 0;
 391                 // Live revisions...
 392                 $list = $this->getList();
 393                 for ( $list->reset(); $list->current(); $list->next() ) {
 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->addModules( [ 'mediawiki.special.revisionDelete' ] );
 423                         $out->addModuleStyles( [ 'mediawiki.special',
 424                                 'mediawiki.interface.helpers.styles' ] );
 425
 426                         $form = Xml::openElement( 'form', [ 'method' => 'post',
 427                                         'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ),
 428                                         'id' => 'mw-revdel-form-revisions' ] ) .
 429                                 Xml::fieldset( $this->msg( 'revdelete-legend' )->text() ) .
 430                                 $this->buildCheckBoxes() .
 431                                 Xml::openElement( 'table' ) .
 432                                 "<tr>\n" .
 433                                         '<td class="mw-label">' .
 434                                                 Xml::label( $this->msg( 'revdelete-log' )->text(), 'wpRevDeleteReasonList' ) .
 435                                         '</td>' .
 436                                         '<td class="mw-input">' .
 437                                                 Xml::listDropDown( 'wpRevDeleteReasonList',
 438                                                         $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->text(),
 439                                                         $this->msg( 'revdelete-reasonotherlist' )->inContentLanguage()->text(),
 440                                                         $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' ), 'wpReasonDropDown'
 441                                                 ) .
 442                                         '</td>' .
 443                                 "</tr><tr>\n" .
 444                                         '<td class="mw-label">' .
 445                                                 Xml::label( $this->msg( 'revdelete-otherreason' )->text(), 'wpReason' ) .
 446                                         '</td>' .
 447                                         '<td class="mw-input">' .
 448                                                 Xml::input( 'wpReason', 60, $this->otherReason, [
 449                                                         'id' => 'wpReason',
 450                                                         // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
 451                                                         // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
 452                                                         // Unicode codepoints.
 453                                                         // "- 155" is to leave room for the 'wpRevDeleteReasonList' value.
 454                                                         'maxlength' => CommentStore::COMMENT_CHARACTER_LIMIT - 155,
 455                                                 ] ) .
 456                                         '</td>' .
 457                                 "</tr><tr>\n" .
 458                                         '<td></td>' .
 459                                         '<td class="mw-submit">' .
 460                                                 Xml::submitButton( $this->msg( 'revdelete-submit', $numRevisions )->text(),
 461                                                         [ 'name' => 'wpSubmit' ] ) .
 462                                         '</td>' .
 463                                 "</tr>\n" .
 464                                 Xml::closeElement( 'table' ) .
 465                                 Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() ) .
 466                                 Html::hidden( 'target', $this->targetObj->getPrefixedText() ) .
 467                                 Html::hidden( 'type', $this->typeName ) .
 468                                 Html::hidden( 'ids', implode( ',', $this->ids ) ) .
 469                                 Xml::closeElement( 'fieldset' ) . "\n" .
 470                                 Xml::closeElement( 'form' ) . "\n";
 471                         // Show link to edit the dropdown reasons
 472                         if ( $this->getUser()->isAllowed( 'editinterface' ) ) {
 473                                 $link = $this->getLinkRenderer()->makeKnownLink(
 474                                         $this->msg( 'revdelete-reason-dropdown' )->inContentLanguage()->getTitle(),
 475                                         $this->msg( 'revdelete-edit-reasonlist' )->text(),
 476                                         [],
 477                                         [ 'action' => 'edit' ]
 478                                 );
 479                                 $form .= Xml::tags( 'p', [ 'class' => 'mw-revdel-editreasons' ], $link ) . "\n";
 480                         }
 481                 } else {
 482                         $form = '';
 483                 }
 484                 $out->addHTML( $form );
 485         }
 486
 487         /**
 488          * Show some introductory text
 489          * @todo FIXME: Wikimedia-specific policy text
 490          */
 491         protected function addUsageText() {
 492                 // Messages: revdelete-text-text, revdelete-text-file, logdelete-text
 493                 $this->getOutput()->wrapWikiMsg(
 494                         "<strong>$1</strong>\n$2", $this->typeLabels['text'],
 495                         'revdelete-text-others'
 496                 );
 497
 498                 if ( $this->getUser()->isAllowed( 'suppressrevision' ) ) {
 499                         $this->getOutput()->addWikiMsg( 'revdelete-suppress-text' );
 500                 }
 501
 502                 if ( $this->mIsAllowed ) {
 503                         $this->getOutput()->addWikiMsg( 'revdelete-confirm' );
 504                 }
 505         }
 506
 507         /**
 508          * @return string HTML
 509          */
 510         protected function buildCheckBoxes() {
 511                 $html = '<table>';
 512                 // If there is just one item, use checkboxes
 513                 $list = $this->getList();
 514                 if ( $list->length() == 1 ) {
 515                         $list->reset();
 516                         $bitfield = $list->current()->getBits(); // existing field
 517
 518                         if ( $this->submitClicked ) {
 519                                 $bitfield = RevisionDeleter::extractBitfield( $this->extractBitParams(), $bitfield );
 520                         }
 521
 522                         foreach ( $this->checks as $item ) {
 523                                 // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
 524                                 // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
 525                                 list( $message, $name, $field ) = $item;
 526                                 $innerHTML = Xml::checkLabel(
 527                                         $this->msg( $message )->text(),
 528                                         $name,
 529                                         $name,
 530                                         $bitfield & $field
 531                                 );
 532
 533                                 if ( $field == Revision::DELETED_RESTRICTED ) {
 534                                         $innerHTML = "<b>$innerHTML</b>";
 535                                 }
 536
 537                                 $line = Xml::tags( 'td', [ 'class' => 'mw-input' ], $innerHTML );
 538                                 $html .= "<tr>$line</tr>\n";
 539                         }
 540                 } else {
 541                         // Otherwise, use tri-state radios
 542                         $html .= '<tr>';
 543                         $html .= '<th class="mw-revdel-checkbox">'
 544                                 . $this->msg( 'revdelete-radio-same' )->escaped() . '</th>';
 545                         $html .= '<th class="mw-revdel-checkbox">'
 546                                 . $this->msg( 'revdelete-radio-unset' )->escaped() . '</th>';
 547                         $html .= '<th class="mw-revdel-checkbox">'
 548                                 . $this->msg( 'revdelete-radio-set' )->escaped() . '</th>';
 549                         $html .= "<th></th></tr>\n";
 550                         foreach ( $this->checks as $item ) {
 551                                 // Messages: revdelete-hide-text, revdelete-hide-image, revdelete-hide-name,
 552                                 // revdelete-hide-comment, revdelete-hide-user, revdelete-hide-restricted
 553                                 list( $message, $name, $field ) = $item;
 554                                 // If there are several items, use third state by default...
 555                                 if ( $this->submitClicked ) {
 556                                         $selected = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
 557                                 } else {
 558                                         $selected = -1; // use existing field
 559                                 }
 560                                 $line = '<td class="mw-revdel-checkbox">' . Xml::radio( $name, -1, $selected == -1 ) . '</td>';
 561                                 $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 0, $selected == 0 ) . '</td>';
 562                                 $line .= '<td class="mw-revdel-checkbox">' . Xml::radio( $name, 1, $selected == 1 ) . '</td>';
 563                                 $label = $this->msg( $message )->escaped();
 564                                 if ( $field == Revision::DELETED_RESTRICTED ) {
 565                                         $label = "<b>$label</b>";
 566                                 }
 567                                 $line .= "<td>$label</td>";
 568                                 $html .= "<tr>$line</tr>\n";
 569                         }
 570                 }
 571
 572                 $html .= '</table>';
 573
 574                 return $html;
 575         }
 576
 577         /**
 578          * UI entry point for form submission.
 579          * @throws PermissionsError
 580          * @return bool
 581          */
 582         protected function submit() {
 583                 # Check edit token on submission
 584                 $token = $this->getRequest()->getVal( 'wpEditToken' );
 585                 if ( $this->submitClicked && !$this->getUser()->matchEditToken( $token ) ) {
 586                         $this->getOutput()->addWikiMsg( 'sessionfailure' );
 587
 588                         return false;
 589                 }
 590                 $bitParams = $this->extractBitParams();
 591                 // from dropdown
 592                 $listReason = $this->getRequest()->getText( 'wpRevDeleteReasonList', 'other' );
 593                 $comment = $listReason;
 594                 if ( $comment === 'other' ) {
 595                         $comment = $this->otherReason;
 596                 } elseif ( $this->otherReason !== '' ) {
 597                         // Entry from drop down menu + additional comment
 598                         $comment .= $this->msg( 'colon-separator' )->inContentLanguage()->text()
 599                                 . $this->otherReason;
 600                 }
 601                 # Can the user set this field?
 602                 if ( $bitParams[Revision::DELETED_RESTRICTED] == 1
 603                         && !$this->getUser()->isAllowed( 'suppressrevision' )
 604                 ) {
 605                         throw new PermissionsError( 'suppressrevision' );
 606                 }
 607                 # If the save went through, go to success message...
 608                 $status = $this->save( $bitParams, $comment );
 609                 if ( $status->isGood() ) {
 610                         $this->success();
 611
 612                         return true;
 613                 } else {
 614                         # ...otherwise, bounce back to form...
 615                         $this->failure( $status );
 616                 }
 617
 618                 return false;
 619         }
 620
 621         /**
 622          * Report that the submit operation succeeded
 623          */
 624         protected function success() {
 625                 // Messages: revdelete-success, logdelete-success
 626                 $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
 627                 $this->getOutput()->wrapWikiMsg(
 628                         "<div class=\"successbox\">\n$1\n</div>",
 629                         $this->typeLabels['success']
 630                 );
 631                 $this->wasSaved = true;
 632                 $this->revDelList->reloadFromMaster();
 633                 $this->showForm();
 634         }
 635
 636         /**
 637          * Report that the submit operation failed
 638          * @param Status $status
 639          */
 640         protected function failure( $status ) {
 641                 // Messages: revdelete-failure, logdelete-failure
 642                 $this->getOutput()->setPageTitle( $this->msg( 'actionfailed' ) );
 643                 $this->getOutput()->wrapWikiTextAsInterface(
 644                         'errorbox',
 645                         $status->getWikiText( $this->typeLabels['failure'] )
 646                 );
 647                 $this->showForm();
 648         }
 649
 650         /**
 651          * Put together an array that contains -1, 0, or the *_deleted const for each bit
 652          *
 653          * @return array
 654          */
 655         protected function extractBitParams() {
 656                 $bitfield = [];
 657                 foreach ( $this->checks as $item ) {
 658                         list( /* message */, $name, $field ) = $item;
 659                         $val = $this->getRequest()->getInt( $name, 0 /* unchecked */ );
 660                         if ( $val < -1 || $val > 1 ) {
 661                                 $val = -1; // -1 for existing value
 662                         }
 663                         $bitfield[$field] = $val;
 664                 }
 665                 if ( !isset( $bitfield[Revision::DELETED_RESTRICTED] ) ) {
 666                         $bitfield[Revision::DELETED_RESTRICTED] = 0;
 667                 }
 668
 669                 return $bitfield;
 670         }
 671
 672         /**
 673          * Do the write operations. Simple wrapper for RevDel*List::setVisibility().
 674          * @param array $bitPars ExtractBitParams() bitfield array
 675          * @param string $reason
 676          * @return Status
 677          */
 678         protected function save( array $bitPars, $reason ) {
 679                 return $this->getList()->setVisibility(
 680                         [ 'value' => $bitPars, 'comment' => $reason ]
 681                 );
 682         }
 683
 684         protected function getGroupName() {
 685                 return 'pagetools';
 686         }
 687 }