includes/specials/SpecialEditTags.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup SpecialPage
  20  */
  21
  22 /**
  23  * Special page for adding and removing change tags to individual revisions.
  24  * A lot of this is copied out of SpecialRevisiondelete.
  25  *
  26  * @ingroup SpecialPage
  27  * @since 1.25
  28  */
  29 class SpecialEditTags extends UnlistedSpecialPage {
  30         /** @var bool Was the DB modified in this request */
  31         protected $wasSaved = false;
  32
  33         /** @var bool True if the submit button was clicked, and the form was posted */
  34         private $submitClicked;
  35
  36         /** @var array Target ID list */
  37         private $ids;
  38
  39         /** @var Title Title object for target parameter */
  40         private $targetObj;
  41
  42         /** @var string Deletion type, may be revision or logentry */
  43         private $typeName;
  44
  45         /** @var ChangeTagsList Storing the list of items to be tagged */
  46         private $revList;
  47
  48         /** @var bool Whether user is allowed to perform the action */
  49         private $isAllowed;
  50
  51         /** @var string */
  52         private $reason;
  53
  54         public function __construct() {
  55                 parent::__construct( 'EditTags', 'changetags' );
  56         }
  57
  58         public function doesWrites() {
  59                 return true;
  60         }
  61
  62         public function execute( $par ) {
  63                 $this->checkPermissions();
  64                 $this->checkReadOnly();
  65
  66                 $output = $this->getOutput();
  67                 $user = $this->getUser();
  68                 $request = $this->getRequest();
  69
  70                 // Check blocks
  71                 if ( $user->isBlocked() ) {
  72                         throw new UserBlockedError( $user->getBlock() );
  73                 }
  74
  75                 $this->setHeaders();
  76                 $this->outputHeader();
  77
  78                 $this->getOutput()->addModules( [ 'mediawiki.special.edittags',
  79                         'mediawiki.special' ] );
  80
  81                 $this->submitClicked = $request->wasPosted() && $request->getBool( 'wpSubmit' );
  82
  83                 // Handle our many different possible input types
  84                 $ids = $request->getVal( 'ids' );
  85                 if ( !is_null( $ids ) ) {
  86                         // Allow CSV from the form hidden field, or a single ID for show/hide links
  87                         $this->ids = explode( ',', $ids );
  88                 } else {
  89                         // Array input
  90                         $this->ids = array_keys( $request->getArray( 'ids', [] ) );
  91                 }
  92                 $this->ids = array_unique( array_filter( $this->ids ) );
  93
  94                 // No targets?
  95                 if ( count( $this->ids ) == 0 ) {
  96                         throw new ErrorPageError( 'tags-edit-nooldid-title', 'tags-edit-nooldid-text' );
  97                 }
  98
  99                 $this->typeName = $request->getVal( 'type' );
 100                 $this->targetObj = Title::newFromText( $request->getText( 'target' ) );
 101
 102                 // sanity check of parameter
 103                 switch ( $this->typeName ) {
 104                         case 'logentry':
 105                         case 'logging':
 106                                 $this->typeName = 'logentry';
 107                                 break;
 108                         default:
 109                                 $this->typeName = 'revision';
 110                                 break;
 111                 }
 112
 113                 // Allow the list type to adjust the passed target
 114                 // Yuck! Copied straight out of SpecialRevisiondelete, but it does exactly
 115                 // what we want
 116                 $this->targetObj = RevisionDeleter::suggestTarget(
 117                         $this->typeName === 'revision' ? 'revision' : 'logging',
 118                         $this->targetObj,
 119                         $this->ids
 120                 );
 121
 122                 $this->isAllowed = $user->isAllowed( 'changetags' );
 123
 124                 $this->reason = $request->getVal( 'wpReason' );
 125                 // We need a target page!
 126                 if ( is_null( $this->targetObj ) ) {
 127                         $output->addWikiMsg( 'undelete-header' );
 128                         return;
 129                 }
 130                 // Give a link to the logs/hist for this page
 131                 $this->showConvenienceLinks();
 132
 133                 // Either submit or create our form
 134                 if ( $this->isAllowed && $this->submitClicked ) {
 135                         $this->submit();
 136                 } else {
 137                         $this->showForm();
 138                 }
 139
 140                 // Show relevant lines from the tag log
 141                 $tagLogPage = new LogPage( 'tag' );
 142                 $output->addHTML( "<h2>" . $tagLogPage->getName()->escaped() . "</h2>\n" );
 143                 LogEventsList::showLogExtract(
 144                         $output,
 145                         'tag',
 146                         $this->targetObj,
 147                         '', /* user */
 148                         [ 'lim' => 25, 'conds' => [], 'useMaster' => $this->wasSaved ]
 149                 );
 150         }
 151
 152         /**
 153          * Show some useful links in the subtitle
 154          */
 155         protected function showConvenienceLinks() {
 156                 // Give a link to the logs/hist for this page
 157                 if ( $this->targetObj ) {
 158                         // Also set header tabs to be for the target.
 159                         $this->getSkin()->setRelevantTitle( $this->targetObj );
 160
 161                         $linkRenderer = $this->getLinkRenderer();
 162                         $links = [];
 163                         $links[] = $linkRenderer->makeKnownLink(
 164                                 SpecialPage::getTitleFor( 'Log' ),
 165                                 $this->msg( 'viewpagelogs' )->text(),
 166                                 [],
 167                                 [
 168                                         'page' => $this->targetObj->getPrefixedText(),
 169                                         'wpfilters' => [ 'tag' ],
 170                                 ]
 171                         );
 172                         if ( !$this->targetObj->isSpecialPage() ) {
 173                                 // Give a link to the page history
 174                                 $links[] = $linkRenderer->makeKnownLink(
 175                                         $this->targetObj,
 176                                         $this->msg( 'pagehist' )->text(),
 177                                         [],
 178                                         [ 'action' => 'history' ]
 179                                 );
 180                         }
 181                         // Link to Special:Tags
 182                         $links[] = $linkRenderer->makeKnownLink(
 183                                 SpecialPage::getTitleFor( 'Tags' ),
 184                                 $this->msg( 'tags-edit-manage-link' )->text()
 185                         );
 186                         // Logs themselves don't have histories or archived revisions
 187                         $this->getOutput()->addSubtitle( $this->getLanguage()->pipeList( $links ) );
 188                 }
 189         }
 190
 191         /**
 192          * Get the list object for this request
 193          * @return ChangeTagsList
 194          */
 195         protected function getList() {
 196                 if ( is_null( $this->revList ) ) {
 197                         $this->revList = ChangeTagsList::factory( $this->typeName, $this->getContext(),
 198                                 $this->targetObj, $this->ids );
 199                 }
 200
 201                 return $this->revList;
 202         }
 203
 204         /**
 205          * Show a list of items that we will operate on, and show a form which allows
 206          * the user to modify the tags applied to those items.
 207          */
 208         protected function showForm() {
 209                 $userAllowed = true;
 210
 211                 $out = $this->getOutput();
 212                 // Messages: tags-edit-revision-selected, tags-edit-logentry-selected
 213                 $out->wrapWikiMsg( "<strong>$1</strong>", [
 214                         "tags-edit-{$this->typeName}-selected",
 215                         $this->getLanguage()->formatNum( count( $this->ids ) ),
 216                         $this->targetObj->getPrefixedText()
 217                 ] );
 218
 219                 $this->addHelpLink( 'Help:Tags' );
 220                 $out->addHTML( "<ul>" );
 221
 222                 $numRevisions = 0;
 223                 // Live revisions...
 224                 $list = $this->getList();
 225                 for ( $list->reset(); $list->current(); $list->next() ) {
 226                         $item = $list->current();
 227                         $numRevisions++;
 228                         $out->addHTML( $item->getHTML() );
 229                 }
 230
 231                 if ( !$numRevisions ) {
 232                         throw new ErrorPageError( 'tags-edit-nooldid-title', 'tags-edit-nooldid-text' );
 233                 }
 234
 235                 $out->addHTML( "</ul>" );
 236                 // Explanation text
 237                 $out->wrapWikiMsg( '<p>$1</p>', "tags-edit-{$this->typeName}-explanation" );
 238
 239                 // Show form if the user can submit
 240                 if ( $this->isAllowed ) {
 241                         $form = Xml::openElement( 'form', [ 'method' => 'post',
 242                                         'action' => $this->getPageTitle()->getLocalURL( [ 'action' => 'submit' ] ),
 243                                         'id' => 'mw-revdel-form-revisions' ] ) .
 244                                 Xml::fieldset( $this->msg( "tags-edit-{$this->typeName}-legend",
 245                                         count( $this->ids ) )->text() ) .
 246                                 $this->buildCheckBoxes() .
 247                                 Xml::openElement( 'table' ) .
 248                                 "<tr>\n" .
 249                                         '<td class="mw-label">' .
 250                                                 Xml::label( $this->msg( 'tags-edit-reason' )->text(), 'wpReason' ) .
 251                                         '</td>' .
 252                                         '<td class="mw-input">' .
 253                                                 Xml::input( 'wpReason', 60, $this->reason, [
 254                                                         'id' => 'wpReason',
 255                                                         // HTML maxlength uses "UTF-16 code units", which means that characters outside BMP
 256                                                         // (e.g. emojis) count for two each. This limit is overridden in JS to instead count
 257                                                         // Unicode codepoints.
 258                                                         // "- 155" is to leave room for the auto-generated part of the log entry.
 259                                                         'maxlength' => CommentStore::COMMENT_CHARACTER_LIMIT - 155,
 260                                                 ] ) .
 261                                         '</td>' .
 262                                 "</tr><tr>\n" .
 263                                         '<td></td>' .
 264                                         '<td class="mw-submit">' .
 265                                                 Xml::submitButton( $this->msg( "tags-edit-{$this->typeName}-submit",
 266                                                         $numRevisions )->text(), [ 'name' => 'wpSubmit' ] ) .
 267                                         '</td>' .
 268                                 "</tr>\n" .
 269                                 Xml::closeElement( 'table' ) .
 270                                 Html::hidden( 'wpEditToken', $this->getUser()->getEditToken() ) .
 271                                 Html::hidden( 'target', $this->targetObj->getPrefixedText() ) .
 272                                 Html::hidden( 'type', $this->typeName ) .
 273                                 Html::hidden( 'ids', implode( ',', $this->ids ) ) .
 274                                 Xml::closeElement( 'fieldset' ) . "\n" .
 275                                 Xml::closeElement( 'form' ) . "\n";
 276                 } else {
 277                         $form = '';
 278                 }
 279                 $out->addHTML( $form );
 280         }
 281
 282         /**
 283          * @return string HTML
 284          */
 285         protected function buildCheckBoxes() {
 286                 // If there is just one item, provide the user with a multi-select field
 287                 $list = $this->getList();
 288                 $tags = [];
 289                 if ( $list->length() == 1 ) {
 290                         $list->reset();
 291                         $tags = $list->current()->getTags();
 292                         if ( $tags ) {
 293                                 $tags = explode( ',', $tags );
 294                         } else {
 295                                 $tags = [];
 296                         }
 297
 298                         $html = '<table id="mw-edittags-tags-selector">';
 299                         $html .= '<tr><td>' . $this->msg( 'tags-edit-existing-tags' )->escaped() .
 300                                 '</td><td>';
 301                         if ( $tags ) {
 302                                 $html .= $this->getLanguage()->commaList( array_map( 'htmlspecialchars', $tags ) );
 303                         } else {
 304                                 $html .= $this->msg( 'tags-edit-existing-tags-none' )->parse();
 305                         }
 306                         $html .= '</td></tr>';
 307                         $tagSelect = $this->getTagSelect( $tags, $this->msg( 'tags-edit-new-tags' )->plain() );
 308                         $html .= '<tr><td>' . $tagSelect[0] . '</td><td>' . $tagSelect[1];
 309                 } else {
 310                         // Otherwise, use a multi-select field for adding tags, and a list of
 311                         // checkboxes for removing them
 312
 313                         for ( $list->reset(); $list->current(); $list->next() ) {
 314                                 $currentTags = $list->current()->getTags();
 315                                 if ( $currentTags ) {
 316                                         $tags = array_merge( $tags, explode( ',', $currentTags ) );
 317                                 }
 318                         }
 319                         $tags = array_unique( $tags );
 320
 321                         $html = '<table id="mw-edittags-tags-selector-multi"><tr><td>';
 322                         $tagSelect = $this->getTagSelect( [], $this->msg( 'tags-edit-add' )->plain() );
 323                         $html .= '<p>' . $tagSelect[0] . '</p>' . $tagSelect[1] . '</td><td>';
 324                         $html .= Xml::element( 'p', null, $this->msg( 'tags-edit-remove' )->plain() );
 325                         $html .= Xml::checkLabel( $this->msg( 'tags-edit-remove-all-tags' )->plain(),
 326                                 'wpRemoveAllTags', 'mw-edittags-remove-all' );
 327                         $i = 0; // used for generating checkbox IDs only
 328                         foreach ( $tags as $tag ) {
 329                                 $html .= Xml::element( 'br' ) . "\n" . Xml::checkLabel( $tag,
 330                                         'wpTagsToRemove[]', 'mw-edittags-remove-' . $i++, false, [
 331                                                 'value' => $tag,
 332                                                 'class' => 'mw-edittags-remove-checkbox',
 333                                         ] );
 334                         }
 335                 }
 336
 337                 // also output the tags currently applied as a hidden form field, so we
 338                 // know what to remove from the revision/log entry when the form is submitted
 339                 $html .= Html::hidden( 'wpExistingTags', implode( ',', $tags ) );
 340                 $html .= '</td></tr></table>';
 341
 342                 return $html;
 343         }
 344
 345         /**
 346          * Returns a <select multiple> element with a list of change tags that can be
 347          * applied by users.
 348          *
 349          * @param array $selectedTags The tags that should be preselected in the
 350          * list. Any tags in this list, but not in the list returned by
 351          * ChangeTags::listExplicitlyDefinedTags, will be appended to the <select>
 352          * element.
 353          * @param string $label The text of a <label> to precede the <select>
 354          * @return array HTML <label> element at index 0, HTML <select> element at
 355          * index 1
 356          */
 357         protected function getTagSelect( $selectedTags, $label ) {
 358                 $result = [];
 359                 $result[0] = Xml::label( $label, 'mw-edittags-tag-list' );
 360
 361                 $select = new XmlSelect( 'wpTagList[]', 'mw-edittags-tag-list', $selectedTags );
 362                 $select->setAttribute( 'multiple', 'multiple' );
 363                 $select->setAttribute( 'size', '8' );
 364
 365                 $tags = ChangeTags::listExplicitlyDefinedTags();
 366                 $tags = array_unique( array_merge( $tags, $selectedTags ) );
 367
 368                 // Values of $tags are also used as <option> labels
 369                 $select->addOptions( array_combine( $tags, $tags ) );
 370
 371                 $result[1] = $select->getHTML();
 372                 return $result;
 373         }
 374
 375         /**
 376          * UI entry point for form submission.
 377          * @return bool
 378          */
 379         protected function submit() {
 380                 // Check edit token on submission
 381                 $request = $this->getRequest();
 382                 $token = $request->getVal( 'wpEditToken' );
 383                 if ( $this->submitClicked && !$this->getUser()->matchEditToken( $token ) ) {
 384                         $this->getOutput()->addWikiMsg( 'sessionfailure' );
 385                         return false;
 386                 }
 387
 388                 // Evaluate incoming request data
 389                 $tagList = $request->getArray( 'wpTagList' );
 390                 if ( is_null( $tagList ) ) {
 391                         $tagList = [];
 392                 }
 393                 $existingTags = $request->getVal( 'wpExistingTags' );
 394                 if ( is_null( $existingTags ) || $existingTags === '' ) {
 395                         $existingTags = [];
 396                 } else {
 397                         $existingTags = explode( ',', $existingTags );
 398                 }
 399
 400                 if ( count( $this->ids ) > 1 ) {
 401                         // multiple revisions selected
 402                         $tagsToAdd = $tagList;
 403                         if ( $request->getBool( 'wpRemoveAllTags' ) ) {
 404                                 $tagsToRemove = $existingTags;
 405                         } else {
 406                                 $tagsToRemove = $request->getArray( 'wpTagsToRemove' );
 407                         }
 408                 } else {
 409                         // single revision selected
 410                         // The user tells us which tags they want associated to the revision.
 411                         // We have to figure out which ones to add, and which to remove.
 412                         $tagsToAdd = array_diff( $tagList, $existingTags );
 413                         $tagsToRemove = array_diff( $existingTags, $tagList );
 414                 }
 415
 416                 if ( !$tagsToAdd && !$tagsToRemove ) {
 417                         $status = Status::newFatal( 'tags-edit-none-selected' );
 418                 } else {
 419                         $status = $this->getList()->updateChangeTagsOnAll( $tagsToAdd,
 420                                 $tagsToRemove, null, $this->reason, $this->getUser() );
 421                 }
 422
 423                 if ( $status->isGood() ) {
 424                         $this->success();
 425                         return true;
 426                 } else {
 427                         $this->failure( $status );
 428                         return false;
 429                 }
 430         }
 431
 432         /**
 433          * Report that the submit operation succeeded
 434          */
 435         protected function success() {
 436                 $this->getOutput()->setPageTitle( $this->msg( 'actioncomplete' ) );
 437                 $this->getOutput()->wrapWikiMsg( "<div class=\"successbox\">\n$1\n</div>",
 438                         'tags-edit-success' );
 439                 $this->wasSaved = true;
 440                 $this->revList->reloadFromMaster();
 441                 $this->reason = ''; // no need to spew the reason back at the user
 442                 $this->showForm();
 443         }
 444
 445         /**
 446          * Report that the submit operation failed
 447          * @param Status $status
 448          */
 449         protected function failure( $status ) {
 450                 $this->getOutput()->setPageTitle( $this->msg( 'actionfailed' ) );
 451                 $this->getOutput()->wrapWikiTextAsInterface(
 452                         'errorbox', $status->getWikiText( 'tags-edit-failure' )
 453                 );
 454                 $this->showForm();
 455         }
 456
 457         public function getDescription() {
 458                 return $this->msg( 'tags-edit-title' )->text();
 459         }
 460
 461         protected function getGroupName() {
 462                 return 'pagetools';
 463         }
 464 }