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->addHTML( Xml::tags(
 169                         'table',
 170                         [ 'class' => 'mw-datatable sortable mw-tags-table' ],
 171                         Xml::tags( 'thead', null, $thead ) .
 172                         Xml::tags( 'tbody', null, $tbody )
 173                 ) );
 174         }
 175
 176         function doTagRow( $tag, $hitcount, $showManageActions, $showDeleteActions, $showEditLinks ) {
 177                 $newRow = '';
 178                 $newRow .= Xml::tags( 'td', null, Xml::element( 'code', null, $tag ) );
 179
 180                 $linkRenderer = $this->getLinkRenderer();
 181                 $disp = ChangeTags::tagDescription( $tag, $this->getContext() );
 182                 if ( $showEditLinks ) {
 183                         $disp .= ' ';
 184                         $editLink = $linkRenderer->makeLink(
 185                                 $this->msg( "tag-$tag" )->inContentLanguage()->getTitle(),
 186                                 $this->msg( 'tags-edit' )->text()
 187                         );
 188                         $disp .= $this->msg( 'parentheses' )->rawParams( $editLink )->escaped();
 189                 }
 190                 $newRow .= Xml::tags( 'td', null, $disp );
 191
 192                 $msg = $this->msg( "tag-$tag-description" );
 193                 $desc = !$msg->exists() ? '' : $msg->parse();
 194                 if ( $showEditLinks ) {
 195                         $desc .= ' ';
 196                         $editDescLink = $linkRenderer->makeLink(
 197                                 $this->msg( "tag-$tag-description" )->inContentLanguage()->getTitle(),
 198                                 $this->msg( 'tags-edit' )->text()
 199                         );
 200                         $desc .= $this->msg( 'parentheses' )->rawParams( $editDescLink )->escaped();
 201                 }
 202                 $newRow .= Xml::tags( 'td', null, $desc );
 203
 204                 $sourceMsgs = [];
 205                 $isSoftware = isset( $this->softwareDefinedTags[$tag] );
 206                 $isExplicit = isset( $this->explicitlyDefinedTags[$tag] );
 207                 if ( $isSoftware ) {
 208                         // TODO: Rename this message
 209                         $sourceMsgs[] = $this->msg( 'tags-source-extension' )->escaped();
 210                 }
 211                 if ( $isExplicit ) {
 212                         $sourceMsgs[] = $this->msg( 'tags-source-manual' )->escaped();
 213                 }
 214                 if ( !$sourceMsgs ) {
 215                         $sourceMsgs[] = $this->msg( 'tags-source-none' )->escaped();
 216                 }
 217                 $newRow .= Xml::tags( 'td', null, implode( Xml::element( 'br' ), $sourceMsgs ) );
 218
 219                 $isActive = $isExplicit || isset( $this->softwareActivatedTags[$tag] );
 220                 $activeMsg = ( $isActive ? 'tags-active-yes' : 'tags-active-no' );
 221                 $newRow .= Xml::tags( 'td', null, $this->msg( $activeMsg )->escaped() );
 222
 223                 $hitcountLabelMsg = $this->msg( 'tags-hitcount' )->numParams( $hitcount );
 224                 if ( $this->getConfig()->get( 'UseTagFilter' ) ) {
 225                         $hitcountLabel = $linkRenderer->makeLink(
 226                                 SpecialPage::getTitleFor( 'Recentchanges' ),
 227                                 $hitcountLabelMsg->text(),
 228                                 [],
 229                                 [ 'tagfilter' => $tag ]
 230                         );
 231                 } else {
 232                         $hitcountLabel = $hitcountLabelMsg->escaped();
 233                 }
 234
 235                 // add raw $hitcount for sorting, because tags-hitcount contains numbers and letters
 236                 $newRow .= Xml::tags( 'td', [ 'data-sort-value' => $hitcount ], $hitcountLabel );
 237
 238                 // actions
 239                 $actionLinks = [];
 240
 241                 // delete
 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                         // activate
 252                         if ( ChangeTags::canActivateTag( $tag )->isOK() ) {
 253                                 $actionLinks[] = $linkRenderer->makeKnownLink(
 254                                         $this->getPageTitle( 'activate' ),
 255                                         $this->msg( 'tags-activate' )->text(),
 256                                         [],
 257                                         [ 'tag' => $tag ] );
 258                         }
 259
 260                         // deactivate
 261                         if ( ChangeTags::canDeactivateTag( $tag )->isOK() ) {
 262                                 $actionLinks[] = $linkRenderer->makeKnownLink(
 263                                         $this->getPageTitle( 'deactivate' ),
 264                                         $this->msg( 'tags-deactivate' )->text(),
 265                                         [],
 266                                         [ 'tag' => $tag ] );
 267                         }
 268                 }
 269
 270                 if ( $showDeleteActions || $showManageActions ) {
 271                         $newRow .= Xml::tags( 'td', null, $this->getLanguage()->pipeList( $actionLinks ) );
 272                 }
 273
 274                 return Xml::tags( 'tr', null, $newRow ) . "\n";
 275         }
 276
 277         public function processCreateTagForm( array $data, HTMLForm $form ) {
 278                 $context = $form->getContext();
 279                 $out = $context->getOutput();
 280
 281                 $tag = trim( strval( $data['Tag'] ) );
 282                 $ignoreWarnings = isset( $data['IgnoreWarnings'] ) && $data['IgnoreWarnings'] === '1';
 283                 $status = ChangeTags::createTagWithChecks( $tag, $data['Reason'],
 284                         $context->getUser(), $ignoreWarnings );
 285
 286                 if ( $status->isGood() ) {
 287                         $out->redirect( $this->getPageTitle()->getLocalURL() );
 288                         return true;
 289                 } elseif ( $status->isOK() ) {
 290                         // we have some warnings, so we show a confirmation form
 291                         $fields = [
 292                                 'Tag' => [
 293                                         'type' => 'hidden',
 294                                         'default' => $data['Tag'],
 295                                 ],
 296                                 'Reason' => [
 297                                         'type' => 'hidden',
 298                                         'default' => $data['Reason'],
 299                                 ],
 300                                 'IgnoreWarnings' => [
 301                                         'type' => 'hidden',
 302                                         'default' => '1',
 303                                 ],
 304                         ];
 305
 306                         // fool HTMLForm into thinking the form hasn't been submitted yet. Otherwise
 307                         // we get into an infinite loop!
 308                         $context->getRequest()->unsetVal( 'wpEditToken' );
 309
 310                         $headerText = $this->msg( 'tags-create-warnings-above', $tag,
 311                                 count( $status->getWarningsArray() ) )->parseAsBlock() .
 312                                 $out->parseAsInterface( $status->getWikiText() ) .
 313                                 $this->msg( 'tags-create-warnings-below' )->parseAsBlock();
 314
 315                         $subform = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
 316                         $subform->setAction( $this->getPageTitle( 'create' )->getLocalURL() );
 317                         $subform->setWrapperLegendMsg( 'tags-create-heading' );
 318                         $subform->setHeaderText( $headerText );
 319                         $subform->setSubmitCallback( [ $this, 'processCreateTagForm' ] );
 320                         $subform->setSubmitTextMsg( 'htmlform-yes' );
 321                         $subform->show();
 322
 323                         $out->addBacklinkSubtitle( $this->getPageTitle() );
 324                         return true;
 325                 } else {
 326                         $out->wrapWikiTextAsInterface( 'error', $status->getWikiText() );
 327                         return false;
 328                 }
 329         }
 330
 331         protected function showDeleteTagForm( $tag ) {
 332                 $user = $this->getUser();
 333                 if ( !$user->isAllowed( 'deletechangetags' ) ) {
 334                         throw new PermissionsError( 'deletechangetags' );
 335                 }
 336
 337                 $out = $this->getOutput();
 338                 $out->setPageTitle( $this->msg( 'tags-delete-title' ) );
 339                 $out->addBacklinkSubtitle( $this->getPageTitle() );
 340
 341                 // is the tag actually able to be deleted?
 342                 $canDeleteResult = ChangeTags::canDeleteTag( $tag, $user );
 343                 if ( !$canDeleteResult->isGood() ) {
 344                         $out->wrapWikiTextAsInterface( 'error', $canDeleteResult->getWikiText() );
 345                         if ( !$canDeleteResult->isOK() ) {
 346                                 return;
 347                         }
 348                 }
 349
 350                 $preText = $this->msg( 'tags-delete-explanation-initial', $tag )->parseAsBlock();
 351                 $tagUsage = ChangeTags::tagUsageStatistics();
 352                 if ( isset( $tagUsage[$tag] ) && $tagUsage[$tag] > 0 ) {
 353                         $preText .= $this->msg( 'tags-delete-explanation-in-use', $tag,
 354                                 $tagUsage[$tag] )->parseAsBlock();
 355                 }
 356                 $preText .= $this->msg( 'tags-delete-explanation-warning', $tag )->parseAsBlock();
 357
 358                 // see if the tag is in use
 359                 $this->softwareActivatedTags = array_fill_keys(
 360                         ChangeTags::listSoftwareActivatedTags(), true );
 361                 if ( isset( $this->softwareActivatedTags[$tag] ) ) {
 362                         $preText .= $this->msg( 'tags-delete-explanation-active', $tag )->parseAsBlock();
 363                 }
 364
 365                 $fields = [];
 366                 $fields['Reason'] = [
 367                         'type' => 'text',
 368                         'label' => $this->msg( 'tags-delete-reason' )->plain(),
 369                         'size' => 50,
 370                 ];
 371                 $fields['HiddenTag'] = [
 372                         'type' => 'hidden',
 373                         'name' => 'tag',
 374                         'default' => $tag,
 375                         'required' => true,
 376                 ];
 377
 378                 $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
 379                 $form->setAction( $this->getPageTitle( 'delete' )->getLocalURL() );
 380                 $form->tagAction = 'delete'; // custom property on HTMLForm object
 381                 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
 382                 $form->setSubmitTextMsg( 'tags-delete-submit' );
 383                 $form->setSubmitDestructive(); // nasty!
 384                 $form->addPreText( $preText );
 385                 $form->show();
 386         }
 387
 388         protected function showActivateDeactivateForm( $tag, $activate ) {
 389                 $actionStr = $activate ? 'activate' : 'deactivate';
 390
 391                 $user = $this->getUser();
 392                 if ( !$user->isAllowed( 'managechangetags' ) ) {
 393                         throw new PermissionsError( 'managechangetags' );
 394                 }
 395
 396                 $out = $this->getOutput();
 397                 // tags-activate-title, tags-deactivate-title
 398                 $out->setPageTitle( $this->msg( "tags-$actionStr-title" ) );
 399                 $out->addBacklinkSubtitle( $this->getPageTitle() );
 400
 401                 // is it possible to do this?
 402                 $func = $activate ? 'canActivateTag' : 'canDeactivateTag';
 403                 $result = ChangeTags::$func( $tag, $user );
 404                 if ( !$result->isGood() ) {
 405                         $out->wrapWikiTextAsInterface( 'error', $result->getWikiText() );
 406                         if ( !$result->isOK() ) {
 407                                 return;
 408                         }
 409                 }
 410
 411                 // tags-activate-question, tags-deactivate-question
 412                 $preText = $this->msg( "tags-$actionStr-question", $tag )->parseAsBlock();
 413
 414                 $fields = [];
 415                 // tags-activate-reason, tags-deactivate-reason
 416                 $fields['Reason'] = [
 417                         'type' => 'text',
 418                         'label' => $this->msg( "tags-$actionStr-reason" )->plain(),
 419                         'size' => 50,
 420                 ];
 421                 $fields['HiddenTag'] = [
 422                         'type' => 'hidden',
 423                         'name' => 'tag',
 424                         'default' => $tag,
 425                         'required' => true,
 426                 ];
 427
 428                 $form = HTMLForm::factory( 'ooui', $fields, $this->getContext() );
 429                 $form->setAction( $this->getPageTitle( $actionStr )->getLocalURL() );
 430                 $form->tagAction = $actionStr;
 431                 $form->setSubmitCallback( [ $this, 'processTagForm' ] );
 432                 // tags-activate-submit, tags-deactivate-submit
 433                 $form->setSubmitTextMsg( "tags-$actionStr-submit" );
 434                 $form->addPreText( $preText );
 435                 $form->show();
 436         }
 437
 438         public function processTagForm( array $data, HTMLForm $form ) {
 439                 $context = $form->getContext();
 440                 $out = $context->getOutput();
 441
 442                 $tag = $data['HiddenTag'];
 443                 $status = call_user_func( [ ChangeTags::class, "{$form->tagAction}TagWithChecks" ],
 444                         $tag, $data['Reason'], $context->getUser(), true );
 445
 446                 if ( $status->isGood() ) {
 447                         $out->redirect( $this->getPageTitle()->getLocalURL() );
 448                         return true;
 449                 } elseif ( $status->isOK() && $form->tagAction === 'delete' ) {
 450                         // deletion succeeded, but hooks raised a warning
 451                         $out->addWikiTextAsInterface( $this->msg( 'tags-delete-warnings-after-delete', $tag,
 452                                 count( $status->getWarningsArray() ) )->text() . "\n" .
 453                                 $status->getWikitext() );
 454                         $out->addReturnTo( $this->getPageTitle() );
 455                         return true;
 456                 } else {
 457                         $out->wrapWikiTextAsInterface( 'error', $status->getWikitext() );
 458                         return false;
 459                 }
 460         }
 461
 462         /**
 463          * Return an array of subpages that this special page will accept.
 464          *
 465          * @return string[] subpages
 466          */
 467         public function getSubpagesForPrefixSearch() {
 468                 // The subpages does not have an own form, so not listing it at the moment
 469                 return [
 470                         // 'delete',
 471                         // 'activate',
 472                         // 'deactivate',
 473                         // 'create',
 474                 ];
 475         }
 476
 477         protected function getGroupName() {
 478                 return 'changes';
 479         }
 480 }