includes/specials/SpecialTags.php

   1 <?php
   2 /**
   3  * Implements Special:Tags
   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  * A special page that lists tags for edits
  26  *
  27  * @ingroup SpecialPage
  28  */
  29 class SpecialTags extends SpecialPage {
  30
  31         /**
  32          * @var array List of explicitly defined tags
  33          */
  34         protected $explicitlyDefinedTags;
  35
  36         /**
  37          * @var array List of extension defined tags
  38          */
  39         protected $extensionDefinedTags;
  40
  41         /**
  42          * @var array List of extension activated tags
  43          */
  44         protected $extensionActivatedTags;
  45
  46         function __construct() {
  47                 parent::__construct( 'Tags' );
  48         }
  49
  50         function execute( $par ) {
  51                 $this->setHeaders();
  52                 $this->outputHeader();
  53
  54                 $request = $this->getRequest();
  55                 switch ( $par ) {
  56                         case 'delete':
  57                                 $this->showDeleteTagForm( $request->getVal( 'tag' ) );
  58                                 break;
  59                         case 'activate':
  60                                 $this->showActivateDeactivateForm( $request->getVal( 'tag' ), true );
  61                                 break;
  62                         case 'deactivate':
  63                                 $this->showActivateDeactivateForm( $request->getVal( 'tag' ), false );
  64                                 break;
  65                         case 'create':
  66                                 // fall through, thanks to HTMLForm's logic
  67                         default:
  68                                 $this->showTagList();
  69                                 break;
  70                 }
  71         }
  72
  73         function showTagList() {
  74                 $out = $this->getOutput();
  75                 $out->setPageTitle( $this->msg( 'tags-title' ) );
  76                 $out->wrapWikiMsg( "<div class='mw-tags-intro'>\n$1\n</div>", 'tags-intro' );
  77
  78                 $user = $this->getUser();
  79                 $userCanManage = $user->isAllowed( 'managechangetags' );
  80                 $userCanDelete = $user->isAllowed( 'deletechangetags' );
  81                 $userCanEditInterface = $user->isAllowed( 'editinterface' );
  82
  83                 // Show form to create a tag
  84                 if ( $userCanManage ) {
  85                         $fields = [
  86                                 'Tag' => [
  87                                         'type' => 'text',
  88                                         'label' => $this->msg( 'tags-create-tag-name' )->plain(),
  89                                         'required' => true,
  90                                 ],
  91                                 'Reason' => [
  92                                         'type' => 'text',
  93                                         'label' => $this->msg( 'tags-create-reason' )->plain(),
  94                                         'size' => 50,
  95                                 ],
  96                                 'IgnoreWarnings' => [
  97                                         'type' => 'hidden',
  98                                 ],
  99                         ];
 100
 101                         $form = new HTMLForm( $fields, $this->getContext() );
 102                         $form->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
 103                         $form->setWrapperLegendMsg( 'tags-create-heading' );
 104                         $form->setHeaderText( $this->msg( 'tags-create-explanation' )->parseAsBlock() );
 105                         $form->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
 106                         $form->setSubmitTextMsg( 'tags-create-submit' );
 107                         $form->show();
 108
 109                         // If processCreateTagForm generated a redirect, there's no point
 110                         // continuing with this, as the user is just going to end up getting sent
 111                         // somewhere else. Additionally, if we keep going here, we end up
 112                         // populating the memcache of tag data (see ChangeTags::listDefinedTags)
 113                         // with out-of-date data from the slave, because the slave hasn't caught
 114                         // up to the fact that a new tag has been created as part of an implicit,
 115                         // as yet uncommitted transaction on master.
 116                         if ( $out->getRedirect() !== '' ) {
 117                                 return;
 118                         }
 119                 }
 120
 121                 // Used to get hitcounts for #doTagRow()
 122                 $tagStats = ChangeTags::tagUsageStatistics();
 123
 124                 // Used in #doTagRow()
 125                 $this->explicitlyDefinedTags = array_fill_keys(
 126                         ChangeTags::listExplicitlyDefinedTags(), true );
 127                 $this->extensionDefinedTags = array_fill_keys(
 128                         ChangeTags::listExtensionDefinedTags(), true );
 129
 130                 // List all defined tags, even if they were never applied
 131                 $definedTags = array_keys( array_merge(
 132                         $this->explicitlyDefinedTags, $this->extensionDefinedTags ) );
 133
 134                 // Show header only if there exists atleast one tag
 135                 if ( !$tagStats && !$definedTags ) {
 136                         return;
 137                 }
 138
 139                 // Write the headers
 140                 $html = Xml::tags( 'tr', null, Xml::tags( 'th', null, $this->msg( 'tags-tag' )->parse() ) .
 141                         Xml::tags( 'th', null, $this->msg( 'tags-display-header' )->parse() ) .
 142                         Xml::tags( 'th', null, $this->msg( 'tags-description-header' )->parse() ) .
 143                         Xml::tags( 'th', null, $this->msg( 'tags-source-header' )->parse() ) .
 144                         Xml::tags( 'th', null, $this->msg( 'tags-active-header' )->parse() ) .
 145                         Xml::tags( 'th', null, $this->msg( 'tags-hitcount-header' )->parse() ) .
 146                         ( $userCanManage ?
 147                                 Xml::tags( 'th', [ 'class' => 'unsortable' ],
 148                                         $this->msg( 'tags-actions-header' )->parse() ) :
 149                                 '' )
 150                 );
 151
 152                 // Used in #doTagRow()
 153                 $this->extensionActivatedTags = array_fill_keys(
 154                         ChangeTags::listExtensionActivatedTags(), true );
 155
 156                 // Insert tags that have been applied at least once
 157                 foreach ( $tagStats as $tag => $hitcount ) {
 158                         $html .= $this->doTagRow( $tag, $hitcount, $userCanManage,
 159                                 $userCanDelete, $userCanEditInterface );
 160                 }
 161                 // Insert tags defined somewhere but never applied
 162                 foreach ( $definedTags as $tag ) {
 163                         if ( !isset( $tagStats[$tag] ) ) {
 164                                 $html .= $this->doTagRow( $tag, 0, $userCanManage, $userCanDelete, $userCanEditInterface );
 165                         }
 166                 }
 167
 168                 $out->addHTML( Xml::tags(
 169                         'table',
 170                         [ 'class' => 'mw-datatable sortable mw-tags-table' ],
 171                         $html
 172                 ) );
 173         }
 174
 175         function doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks ) {
 176                 $newRow = '';
 177                 $newRow .= Xml::tags( 'td', null, Xml::element( 'code', null, $tag ) );
 178
 179                 $disp = ChangeTags::tagDescription( $tag );
 180                 if ( $showEditLinks ) {
 181                         $disp .= ' ';
 182                         $editLink = Linker::link(
 183                                 $this->msg( "tag-$tag" )->inContentLanguage()->getTitle(),
 184                                 $this->msg( 'tags-edit' )->escaped()
 185                         );
 186                         $disp .= $this->msg( 'parentheses' )->rawParams( $editLink )->escaped();
 187                 }
 188                 $newRow .= Xml::tags( 'td', null, $disp );
 189
 190                 $msg = $this->msg( "tag-$tag-description" );
 191                 $desc = !$msg->exists() ? '' : $msg->parse();
 192                 if ( $showEditLinks ) {
 193                         $desc .= ' ';
 194                         $editDescLink = Linker::link(
 195                                 $this->msg( "tag-$tag-description" )->inContentLanguage()->getTitle(),
 196                                 $this->msg( 'tags-edit' )->escaped()
 197                         );
 198                         $desc .= $this->msg( 'parentheses' )->rawParams( $editDescLink )->escaped();
 199                 }
 200                 $newRow .= Xml::tags( 'td', null, $desc );
 201
 202                 $sourceMsgs = [];
 203                 $isExtension = isset( $this->extensionDefinedTags[$tag] );
 204                 $isExplicit = isset( $this->explicitlyDefinedTags[$tag] );
 205                 if ( $isExtension ) {
 206                         $sourceMsgs[] = $this->msg( 'tags-source-extension' )->escaped();
 207                 }
 208                 if ( $isExplicit ) {
 209                         $sourceMsgs[] = $this->msg( 'tags-source-manual' )->escaped();
 210                 }
 211                 if ( !$sourceMsgs ) {
 212                         $sourceMsgs[] = $this->msg( 'tags-source-none' )->escaped();
 213                 }
 214                 $newRow .= Xml::tags( 'td', null, implode( Xml::element( 'br' ), $sourceMsgs ) );
 215
 216                 $isActive = $isExplicit || isset( $this->extensionActivatedTags[$tag] );
 217                 $activeMsg = ( $isActive ? 'tags-active-yes' : 'tags-active-no' );
 218                 $newRow .= Xml::tags( 'td', null, $this->msg( $activeMsg )->escaped() );
 219
 220                 $hitcountLabel = $this->msg( 'tags-hitcount' )->numParams( $hitcount )->escaped();
 221                 if ( $this->getConfig()->get( 'UseTagFilter' ) ) {
 222                         $hitcountLabel = Linker::link(
 223                                 SpecialPage::getTitleFor( 'Recentchanges' ),
 224                                 $hitcountLabel,
 225                                 [],
 226                                 [ 'tagfilter' => $tag ]
 227                         );
 228                 }
 229
 230                 // add raw $hitcount for sorting, because tags-hitcount contains numbers and letters
 231                 $newRow .= Xml::tags( 'td', [ 'data-sort-value' => $hitcount ], $hitcountLabel );
 232
 233                 // actions
 234                 $actionLinks = [];
 235
 236                 // delete
 237                 if ( $showDeleteActions && ChangeTags::canDeleteTag( $tag )->isOK() ) {
 238                         $actionLinks[] = Linker::linkKnown( $this->getPageTitle( 'delete' ),
 239                                 $this->msg( 'tags-delete' )->escaped(),
 240                                 [],
 241                                 [ 'tag' => $tag ] );
 242                 }
 243
 244                 if ( $showManageActions ) { // we've already checked that the user had the requisite userright
 245
 246                         // activate
 247                         if ( ChangeTags::canActivateTag( $tag )->isOK() ) {
 248                                 $actionLinks[] = Linker::linkKnown( $this->getPageTitle( 'activate' ),
 249                                         $this->msg( 'tags-activate' )->escaped(),
 250                                         [],
 251                                         [ 'tag' => $tag ] );
 252                         }
 253
 254                         // deactivate
 255                         if ( ChangeTags::canDeactivateTag( $tag )->isOK() ) {
 256                                 $actionLinks[] = Linker::linkKnown( $this->getPageTitle( 'deactivate' ),
 257                                         $this->msg( 'tags-deactivate' )->escaped(),
 258                                         [],
 259                                         [ 'tag' => $tag ] );
 260                         }
 261
 262                 }
 263
 264                 if ( $actionLinks ) {
 265                         $newRow .= Xml::tags( 'td', null, $this->getLanguage()->pipeList( $actionLinks ) );
 266                 }
 267
 268                 return Xml::tags( 'tr', null, $newRow ) . "\n";
 269         }
 270
 271         public function processCreateTagForm( array $data, HTMLForm $form ) {
 272                 $context = $form->getContext();
 273                 $out = $context->getOutput();
 274
 275                 $tag = trim( strval( $data['Tag'] ) );
 276                 $ignoreWarnings = isset( $data['IgnoreWarnings'] ) && $data['IgnoreWarnings'] === '1';
 277                 $status = ChangeTags::createTagWithChecks( $tag, $data['Reason'],
 278                         $context->getUser(), $ignoreWarnings );
 279
 280                 if ( $status->isGood() ) {
 281                         $out->redirect( $this->getPageTitle()->getLocalURL() );
 282                         return true;
 283                 } elseif ( $status->isOK() ) {
 284                         // we have some warnings, so we show a confirmation form
 285                         $fields = [
 286                                 'Tag' => [
 287                                         'type' => 'hidden',
 288                                         'default' => $data['Tag'],
 289                                 ],
 290                                 'Reason' => [
 291                                         'type' => 'hidden',
 292                                         'default' => $data['Reason'],
 293                                 ],
 294                                 'IgnoreWarnings' => [
 295                                         'type' => 'hidden',
 296                                         'default' => '1',
 297                                 ],
 298                         ];
 299
 300                         // fool HTMLForm into thinking the form hasn't been submitted yet. Otherwise
 301                         // we get into an infinite loop!
 302                         $context->getRequest()->unsetVal( 'wpEditToken' );
 303
 304                         $headerText = $this->msg( 'tags-create-warnings-above', $tag,
 305                                 count( $status->getWarningsArray() ) )->parseAsBlock() .
 306                                 $out->parse( $status->getWikiText() ) .
 307                                 $this->msg( 'tags-create-warnings-below' )->parseAsBlock();
 308
 309                         $subform = new HTMLForm( $fields, $this->getContext() );
 310                         $subform->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
 311                         $subform->setWrapperLegendMsg( 'tags-create-heading' );
 312                         $subform->setHeaderText( $headerText );
 313                         $subform->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
 314                         $subform->setSubmitTextMsg( 'htmlform-yes' );
 315                         $subform->show();
 316
 317                         $out->addBacklinkSubtitle( $this->getPageTitle() );
 318                         return true;
 319                 } else {
 320                         $out->addWikiText( "<div class=\"error\">\n" . $status->getWikiText() .
 321                                 "\n</div>" );
 322                         return false;
 323                 }
 324         }
 325
 326         protected function showDeleteTagForm( $tag ) {
 327                 $user = $this->getUser();
 328                 if ( !$user->isAllowed( 'deletechangetags' ) ) {
 329                         throw new PermissionsError( 'deletechangetags' );
 330                 }
 331
 332                 $out = $this->getOutput();
 333                 $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
 334                 $out->addBacklinkSubtitle( $this->getPageTitle() );
 335
 336                 // is the tag actually able to be deleted?
 337                 $canDeleteResult = ChangeTags::canDeleteTag( $tag, $user );
 338                 if ( !$canDeleteResult->isGood() ) {
 339                         $out->addWikiText( "<div class=\"error\">\n" . $canDeleteResult->getWikiText() .
 340                                 "\n</div>" );
 341                         if ( !$canDeleteResult->isOK() ) {
 342                                 return;
 343                         }
 344                 }
 345
 346                 $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
 347                 $tagUsage = ChangeTags::tagUsageStatistics();
 348                 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
 349                         $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
 350                                 $tagUsage[$tag] )->parseAsBlock();
 351                 }
 352                 $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
 353
 354                 // see if the tag is in use
 355                 $this->extensionActivatedTags = array_fill_keys(
 356                         ChangeTags::listExtensionActivatedTags(), true );
 357                 if ( isset( $this->extensionActivatedTags[$tag] ) ) {
 358                         $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
 359                 }
 360
 361                 $fields = [];
 362                 $fields['Reason'] = [
 363                         'type' => 'text',
 364                         'label' => $this->msg( 'tags-delete-reason' )->plain(),
 365                         'size' => 50,
 366                 ];
 367                 $fields['HiddenTag'] = [
 368                         'type' => 'hidden',
 369                         'name' => 'tag',
 370                         'default' => $tag,
 371                         'required' => true,
 372                 ];
 373
 374                 $form = new HTMLForm( $fields, $this->getContext() );
 375                 $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
 376                 $form->tagAction = 'delete'; // custom property on HTMLForm object
 377                 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
 378                 $form->setSubmitTextMsg( 'tags-delete-submit' );
 379                 $form->setSubmitDestructive(); // nasty!
 380                 $form->addPreText( $preText );
 381                 $form->show();
 382         }
 383
 384         protected function showActivateDeactivateForm( $tag, $activate ) {
 385                 $actionStr = $activate ? 'activate' : 'deactivate';
 386
 387                 $user = $this->getUser();
 388                 if ( !$user->isAllowed( 'managechangetags' ) ) {
 389                         throw new PermissionsError( 'managechangetags' );
 390                 }
 391
 392                 $out = $this->getOutput();
 393                 // tags-activate-title, tags-deactivate-title
 394                 $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
 395                 $out->addBacklinkSubtitle( $this->getPageTitle() );
 396
 397                 // is it possible to do this?
 398                 $func = $activate ? 'canActivateTag' : 'canDeactivateTag';
 399                 $result = ChangeTags::$func( $tag, $user );
 400                 if ( !$result->isGood() ) {
 401                         $out->addWikiText( "<div class=\"error\">\n" . $result->getWikiText() .
 402                                 "\n</div>" );
 403                         if ( !$result->isOK() ) {
 404                                 return;
 405                         }
 406                 }
 407
 408                 // tags-activate-question, tags-deactivate-question
 409                 $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
 410
 411                 $fields = [];
 412                 // tags-activate-reason, tags-deactivate-reason
 413                 $fields['Reason'] = [
 414                         'type' => 'text',
 415                         'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
 416                         'size' => 50,
 417                 ];
 418                 $fields['HiddenTag'] = [
 419                         'type' => 'hidden',
 420                         'name' => 'tag',
 421                         'default' => $tag,
 422                         'required' => true,
 423                 ];
 424
 425                 $form = new HTMLForm( $fields, $this->getContext() );
 426                 $form->setAction( $this->getPageTitle( $actionStr )->getLocalURL() );
 427                 $form->tagAction = $actionStr;
 428                 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
 429                 // tags-activate-submit, tags-deactivate-submit
 430                 $form->setSubmitTextMsg( "tags-$actionStr-submit" );
 431                 $form->addPreText( $preText );
 432                 $form->show();
 433         }
 434
 435         public function processTagForm( array $data, HTMLForm $form ) {
 436                 $context = $form->getContext();
 437                 $out = $context->getOutput();
 438
 439                 $tag = $data['HiddenTag'];
 440                 $status = call_user_func( [ 'ChangeTags', "{$form->tagAction}TagWithChecks" ],
 441                         $tag, $data['Reason'], $context->getUser(), true );
 442
 443                 if ( $status->isGood() ) {
 444                         $out->redirect( $this->getPageTitle()->getLocalURL() );
 445                         return true;
 446                 } elseif ( $status->isOK() && $form->tagAction === 'delete' ) {
 447                         // deletion succeeded, but hooks raised a warning
 448                         $out->addWikiText( $this->msg( 'tags-delete-warnings-after-delete', $tag,
 449                                 count( $status->getWarningsArray() ) )->text() . "\n" .
 450                                 $status->getWikitext() );
 451                         $out->addReturnTo( $this->getPageTitle() );
 452                         return true;
 453                 } else {
 454                         $out->addWikiText( "<div class=\"error\">\n" . $status->getWikitext() .
 455                                 "\n</div>" );
 456                         return false;
 457                 }
 458         }
 459
 460         /**
 461          * Return an array of subpages that this special page will accept.
 462          *
 463          * @return string[] subpages
 464          */
 465         public function getSubpagesForPrefixSearch() {
 466                 // The subpages does not have an own form, so not listing it at the moment
 467                 return [
 468                         // 'delete',
 469                         // 'activate',
 470                         // 'deactivate',
 471                         // 'create',
 472                 ];
 473         }
 474
 475         protected function getGroupName() {
 476                 return 'changes';
 477         }
 478 }