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 software defined tags
  38          */
  39         protected $softwareDefinedTags;
  40
  41         /**
  42          * @var array List of software activated tags
  43          */
  44         protected $softwareActivatedTags;
  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 = HTMLForm::factory( 'ooui', $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 replica DB, because the replica DB 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->softwareDefinedTags = array_fill_keys(
 128                         ChangeTags::listSoftwareDefinedTags(), true );
 129
 130                 // List all defined tags, even if they were never applied
 131                 $definedTags = array_keys( $this->explicitlyDefinedTags + $this->softwareDefinedTags );
 132
 133                 // Show header only if there exists atleast one tag
 134                 if ( !$tagStats && !$definedTags ) {
 135                         return;
 136                 }
 137
 138                 // Write the headers
 139                 $thead = Xml::tags( 'tr', null, Xml::tags( 'th', null, $this->msg( 'tags-tag' )->parse() ) .
 140                         Xml::tags( 'th', null, $this->msg( 'tags-display-header' )->parse() ) .
 141                         Xml::tags( 'th', null, $this->msg( 'tags-description-header' )->parse() ) .
 142                         Xml::tags( 'th', null, $this->msg( 'tags-source-header' )->parse() ) .
 143                         Xml::tags( 'th', null, $this->msg( 'tags-active-header' )->parse() ) .
 144                         Xml::tags( 'th', null, $this->msg( 'tags-hitcount-header' )->parse() ) .
 145                         ( ( $userCanManage || $userCanDelete ) ?
 146                                 Xml::tags( 'th', [ 'class' => 'unsortable' ],
 147                                         $this->msg( 'tags-actions-header' )->parse() ) :
 148                                 '' )
 149                 );
 150
 151                 $tbody = '';
 152                 // Used in #doTagRow()
 153                 $this->softwareActivatedTags = array_fill_keys(
 154                         ChangeTags::listSoftwareActivatedTags(), true );
 155
 156                 // Insert tags that have been applied at least once
 157                 foreach ( $tagStats as $tag => $hitcount ) {
 158                         $tbody .= $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                                 $tbody .= $this->doTagRow( $tag, 0, $userCanManage, $userCanDelete, $userCanEditInterface );
 165                         }
 166                 }
 167
 168                 $out->addModuleStyles( 'jquery.tablesorter.styles' );
 169                 $out->addModules( 'jquery.tablesorter' );
 170                 $out->addHTML( Xml::tags(
 171                         'table',
 172                         [ 'class' => 'mw-datatable sortable mw-tags-table' ],
 173                         Xml::tags( 'thead', null, $thead ) .
 174                         Xml::tags( 'tbody', null, $tbody )
 175                 ) );
 176         }
 177
 178         function doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks ) {
 179                 $newRow = '';
 180                 $newRow .= Xml::tags( 'td', null, Xml::element( 'code', null, $tag ) );
 181
 182                 $linkRenderer = $this->getLinkRenderer();
 183                 $disp = ChangeTags::tagDescription( $tag, $this->getContext() );
 184                 if ( $showEditLinks ) {
 185                         $disp .= ' ';
 186                         $editLink = $linkRenderer->makeLink(
 187                                 $this->msg( "tag-$tag" )->inContentLanguage()->getTitle(),
 188                                 $this->msg( 'tags-edit' )->text()
 189                         );
 190                         $disp .= $this->msg( 'parentheses' )->rawParams( $editLink )->escaped();
 191                 }
 192                 $newRow .= Xml::tags( 'td', null, $disp );
 193
 194                 $msg = $this->msg( "tag-$tag-description" );
 195                 $desc = !$msg->exists() ? '' : $msg->parse();
 196                 if ( $showEditLinks ) {
 197                         $desc .= ' ';
 198                         $editDescLink = $linkRenderer->makeLink(
 199                                 $this->msg( "tag-$tag-description" )->inContentLanguage()->getTitle(),
 200                                 $this->msg( 'tags-edit' )->text()
 201                         );
 202                         $desc .= $this->msg( 'parentheses' )->rawParams( $editDescLink )->escaped();
 203                 }
 204                 $newRow .= Xml::tags( 'td', null, $desc );
 205
 206                 $sourceMsgs = [];
 207                 $isSoftware = isset( $this->softwareDefinedTags[$tag] );
 208                 $isExplicit = isset( $this->explicitlyDefinedTags[$tag] );
 209                 if ( $isSoftware ) {
 210                         // TODO: Rename this message
 211                         $sourceMsgs[] = $this->msg( 'tags-source-extension' )->escaped();
 212                 }
 213                 if ( $isExplicit ) {
 214                         $sourceMsgs[] = $this->msg( 'tags-source-manual' )->escaped();
 215                 }
 216                 if ( !$sourceMsgs ) {
 217                         $sourceMsgs[] = $this->msg( 'tags-source-none' )->escaped();
 218                 }
 219                 $newRow .= Xml::tags( 'td', null, implode( Xml::element( 'br' ), $sourceMsgs ) );
 220
 221                 $isActive = $isExplicit || isset( $this->softwareActivatedTags[$tag] );
 222                 $activeMsg = ( $isActive ? 'tags-active-yes' : 'tags-active-no' );
 223                 $newRow .= Xml::tags( 'td', null, $this->msg( $activeMsg )->escaped() );
 224
 225                 $hitcountLabelMsg = $this->msg( 'tags-hitcount' )->numParams( $hitcount );
 226                 if ( $this->getConfig()->get( 'UseTagFilter' ) ) {
 227                         $hitcountLabel = $linkRenderer->makeLink(
 228                                 SpecialPage::getTitleFor( 'Recentchanges' ),
 229                                 $hitcountLabelMsg->text(),
 230                                 [],
 231                                 [ 'tagfilter' => $tag ]
 232                         );
 233                 } else {
 234                         $hitcountLabel = $hitcountLabelMsg->escaped();
 235                 }
 236
 237                 // add raw $hitcount for sorting, because tags-hitcount contains numbers and letters
 238                 $newRow .= Xml::tags( 'td', [ 'data-sort-value' => $hitcount ], $hitcountLabel );
 239
 240                 $actionLinks = [];
 241
 242                 if ( $showDeleteActions && ChangeTags::canDeleteTag( $tag )->isOK() ) {
 243                         $actionLinks[] = $linkRenderer->makeKnownLink(
 244                                 $this->getPageTitle( 'delete' ),
 245                                 $this->msg( 'tags-delete' )->text(),
 246                                 [],
 247                                 [ 'tag' => $tag ] );
 248                 }
 249
 250                 if ( $showManageActions ) { // we've already checked that the user had the requisite userright
 251                         if ( ChangeTags::canActivateTag( $tag )->isOK() ) {
 252                                 $actionLinks[] = $linkRenderer->makeKnownLink(
 253                                         $this->getPageTitle( 'activate' ),
 254                                         $this->msg( 'tags-activate' )->text(),
 255                                         [],
 256                                         [ 'tag' => $tag ] );
 257                         }
 258
 259                         if ( ChangeTags::canDeactivateTag( $tag )->isOK() ) {
 260                                 $actionLinks[] = $linkRenderer->makeKnownLink(
 261                                         $this->getPageTitle( 'deactivate' ),
 262                                         $this->msg( 'tags-deactivate' )->text(),
 263                                         [],
 264                                         [ 'tag' => $tag ] );
 265                         }
 266                 }
 267
 268                 if ( $showDeleteActions || $showManageActions ) {
 269                         $newRow .= Xml::tags( 'td', null, $this->getLanguage()->pipeList( $actionLinks ) );
 270                 }
 271
 272                 return Xml::tags( 'tr', null, $newRow ) . "\n";
 273         }
 274
 275         public function processCreateTagForm( array $data, HTMLForm $form ) {
 276                 $context = $form->getContext();
 277                 $out = $context->getOutput();
 278
 279                 $tag = trim( strval( $data['Tag'] ) );
 280                 $ignoreWarnings = isset( $data['IgnoreWarnings'] ) && $data['IgnoreWarnings'] === '1';
 281                 $status = ChangeTags::createTagWithChecks( $tag, $data['Reason'],
 282                         $context->getUser(), $ignoreWarnings );
 283
 284                 if ( $status->isGood() ) {
 285                         $out->redirect( $this->getPageTitle()->getLocalURL() );
 286                         return true;
 287                 } elseif ( $status->isOK() ) {
 288                         // we have some warnings, so we show a confirmation form
 289                         $fields = [
 290                                 'Tag' => [
 291                                         'type' => 'hidden',
 292                                         'default' => $data['Tag'],
 293                                 ],
 294                                 'Reason' => [
 295                                         'type' => 'hidden',
 296                                         'default' => $data['Reason'],
 297                                 ],
 298                                 'IgnoreWarnings' => [
 299                                         'type' => 'hidden',
 300                                         'default' => '1',
 301                                 ],
 302                         ];
 303
 304                         // fool HTMLForm into thinking the form hasn't been submitted yet. Otherwise
 305                         // we get into an infinite loop!
 306                         $context->getRequest()->unsetVal( 'wpEditToken' );
 307
 308                         $headerText = $this->msg( 'tags-create-warnings-above', $tag,
 309                                 count( $status->getWarningsArray() ) )->parseAsBlock() .
 310                                 $out->parseAsInterface( $status->getWikiText() ) .
 311                                 $this->msg( 'tags-create-warnings-below' )->parseAsBlock();
 312
 313                         $subform = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
 314                         $subform->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
 315                         $subform->setWrapperLegendMsg( 'tags-create-heading' );
 316                         $subform->setHeaderText( $headerText );
 317                         $subform->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
 318                         $subform->setSubmitTextMsg( 'htmlform-yes' );
 319                         $subform->show();
 320
 321                         $out->addBacklinkSubtitle( $this->getPageTitle() );
 322                         return true;
 323                 } else {
 324                         $out->wrapWikiTextAsInterface( 'error', $status->getWikiText() );
 325                         return false;
 326                 }
 327         }
 328
 329         protected function showDeleteTagForm( $tag ) {
 330                 $user = $this->getUser();
 331                 if ( !$user->isAllowed( 'deletechangetags' ) ) {
 332                         throw new PermissionsError( 'deletechangetags' );
 333                 }
 334
 335                 $out = $this->getOutput();
 336                 $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
 337                 $out->addBacklinkSubtitle( $this->getPageTitle() );
 338
 339                 // is the tag actually able to be deleted?
 340                 $canDeleteResult = ChangeTags::canDeleteTag( $tag, $user );
 341                 if ( !$canDeleteResult->isGood() ) {
 342                         $out->wrapWikiTextAsInterface( 'error', $canDeleteResult->getWikiText() );
 343                         if ( !$canDeleteResult->isOK() ) {
 344                                 return;
 345                         }
 346                 }
 347
 348                 $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
 349                 $tagUsage = ChangeTags::tagUsageStatistics();
 350                 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
 351                         $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
 352                                 $tagUsage[$tag] )->parseAsBlock();
 353                 }
 354                 $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
 355
 356                 // see if the tag is in use
 357                 $this->softwareActivatedTags = array_fill_keys(
 358                         ChangeTags::listSoftwareActivatedTags(), true );
 359                 if ( isset( $this->softwareActivatedTags[$tag] ) ) {
 360                         $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
 361                 }
 362
 363                 $fields = [];
 364                 $fields['Reason'] = [
 365                         'type' => 'text',
 366                         'label' => $this->msg( 'tags-delete-reason' )->plain(),
 367                         'size' => 50,
 368                 ];
 369                 $fields['HiddenTag'] = [
 370                         'type' => 'hidden',
 371                         'name' => 'tag',
 372                         'default' => $tag,
 373                         'required' => true,
 374                 ];
 375
 376                 $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
 377                 $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
 378                 $form->tagAction = 'delete'; // custom property on HTMLForm object
 379                 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
 380                 $form->setSubmitTextMsg( 'tags-delete-submit' );
 381                 $form->setSubmitDestructive(); // nasty!
 382                 $form->addPreText( $preText );
 383                 $form->show();
 384         }
 385
 386         protected function showActivateDeactivateForm( $tag, $activate ) {
 387                 $actionStr = $activate ? 'activate' : 'deactivate';
 388
 389                 $user = $this->getUser();
 390                 if ( !$user->isAllowed( 'managechangetags' ) ) {
 391                         throw new PermissionsError( 'managechangetags' );
 392                 }
 393
 394                 $out = $this->getOutput();
 395                 // tags-activate-title, tags-deactivate-title
 396                 $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
 397                 $out->addBacklinkSubtitle( $this->getPageTitle() );
 398
 399                 // is it possible to do this?
 400                 $func = $activate ? 'canActivateTag' : 'canDeactivateTag';
 401                 $result = ChangeTags::$func( $tag, $user );
 402                 if ( !$result->isGood() ) {
 403                         $out->wrapWikiTextAsInterface( 'error', $result->getWikiText() );
 404                         if ( !$result->isOK() ) {
 405                                 return;
 406                         }
 407                 }
 408
 409                 // tags-activate-question, tags-deactivate-question
 410                 $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
 411
 412                 $fields = [];
 413                 // tags-activate-reason, tags-deactivate-reason
 414                 $fields['Reason'] = [
 415                         'type' => 'text',
 416                         'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
 417                         'size' => 50,
 418                 ];
 419                 $fields['HiddenTag'] = [
 420                         'type' => 'hidden',
 421                         'name' => 'tag',
 422                         'default' => $tag,
 423                         'required' => true,
 424                 ];
 425
 426                 $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
 427                 $form->setAction( $this->getPageTitle( $actionStr )->getLocalURL() );
 428                 $form->tagAction = $actionStr;
 429                 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
 430                 // tags-activate-submit, tags-deactivate-submit
 431                 $form->setSubmitTextMsg( "tags-$actionStr-submit" );
 432                 $form->addPreText( $preText );
 433                 $form->show();
 434         }
 435
 436         public function processTagForm( array $data, HTMLForm $form ) {
 437                 $context = $form->getContext();
 438                 $out = $context->getOutput();
 439
 440                 $tag = $data['HiddenTag'];
 441                 $status = call_user_func( [ ChangeTags::class, "{$form->tagAction}TagWithChecks" ],
 442                         $tag, $data['Reason'], $context->getUser(), true );
 443
 444                 if ( $status->isGood() ) {
 445                         $out->redirect( $this->getPageTitle()->getLocalURL() );
 446                         return true;
 447                 } elseif ( $status->isOK() && $form->tagAction === 'delete' ) {
 448                         // deletion succeeded, but hooks raised a warning
 449                         $out->addWikiTextAsInterface( $this->msg( 'tags-delete-warnings-after-delete', $tag,
 450                                 count( $status->getWarningsArray() ) )->text() . "\n" .
 451                                 $status->getWikitext() );
 452                         $out->addReturnTo( $this->getPageTitle() );
 453                         return true;
 454                 } else {
 455                         $out->wrapWikiTextAsInterface( 'error', $status->getWikitext() );
 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 }