includes/specials/SpecialEditWatchlist.php

   1 <?php
   2 /**
   3  * @defgroup Watchlist Users watchlist handling
   4  */
   5
   6 /**
   7  * Implements Special:EditWatchlist
   8  *
   9  * This program is free software; you can redistribute it and/or modify
  10  * it under the terms of the GNU General Public License as published by
  11  * the Free Software Foundation; either version 2 of the License, or
  12  * (at your option) any later version.
  13  *
  14  * This program is distributed in the hope that it will be useful,
  15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17  * GNU General Public License for more details.
  18  *
  19  * You should have received a copy of the GNU General Public License along
  20  * with this program; if not, write to the Free Software Foundation, Inc.,
  21  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  22  * http://www.gnu.org/copyleft/gpl.html
  23  *
  24  * @file
  25  * @ingroup SpecialPage
  26  * @ingroup Watchlist
  27  */
  28
  29 use MediaWiki\Linker\LinkRenderer;
  30 use MediaWiki\Linker\LinkTarget;
  31 use MediaWiki\MediaWikiServices;
  32
  33 /**
  34  * Provides the UI through which users can perform editing
  35  * operations on their watchlist
  36  *
  37  * @ingroup SpecialPage
  38  * @ingroup Watchlist
  39  * @author Rob Church <robchur@gmail.com>
  40  */
  41 class SpecialEditWatchlist extends UnlistedSpecialPage {
  42         /**
  43          * Editing modes. EDIT_CLEAR is no longer used; the "Clear" link scared people
  44          * too much. Now it's passed on to the raw editor, from which it's very easy to clear.
  45          */
  46         const EDIT_CLEAR = 1;
  47         const EDIT_RAW = 2;
  48         const EDIT_NORMAL = 3;
  49
  50         protected $successMessage;
  51
  52         protected $toc;
  53
  54         private $badItems = [];
  55
  56         /**
  57          * @var TitleParser
  58          */
  59         private $titleParser;
  60
  61         public function __construct() {
  62                 parent::__construct( 'EditWatchlist', 'editmywatchlist' );
  63         }
  64
  65         /**
  66          * Initialize any services we'll need (unless it has already been provided via a setter).
  67          * This allows for dependency injection even though we don't control object creation.
  68          */
  69         private function initServices() {
  70                 if ( !$this->titleParser ) {
  71                         $this->titleParser = MediaWikiServices::getInstance()->getTitleParser();
  72                 }
  73         }
  74
  75         public function doesWrites() {
  76                 return true;
  77         }
  78
  79         /**
  80          * Main execution point
  81          *
  82          * @param int $mode
  83          */
  84         public function execute( $mode ) {
  85                 $this->initServices();
  86                 $this->setHeaders();
  87
  88                 # Anons don't get a watchlist
  89                 $this->requireLogin( 'watchlistanontext' );
  90
  91                 $out = $this->getOutput();
  92
  93                 $this->checkPermissions();
  94                 $this->checkReadOnly();
  95
  96                 $this->outputHeader();
  97                 $this->outputSubtitle();
  98                 $out->addModuleStyles( 'mediawiki.special' );
  99
 100                 # B/C: $mode used to be waaay down the parameter list, and the first parameter
 101                 # was $wgUser
 102                 if ( $mode instanceof User ) {
 103                         $args = func_get_args();
 104                         if ( count( $args ) >= 4 ) {
 105                                 $mode = $args[3];
 106                         }
 107                 }
 108                 $mode = self::getMode( $this->getRequest(), $mode );
 109
 110                 switch ( $mode ) {
 111                         case self::EDIT_RAW:
 112                                 $out->setPageTitle( $this->msg( 'watchlistedit-raw-title' ) );
 113                                 $form = $this->getRawForm();
 114                                 if ( $form->show() ) {
 115                                         $out->addHTML( $this->successMessage );
 116                                         $out->addReturnTo( SpecialPage::getTitleFor( 'Watchlist' ) );
 117                                 }
 118                                 break;
 119                         case self::EDIT_CLEAR:
 120                                 $out->setPageTitle( $this->msg( 'watchlistedit-clear-title' ) );
 121                                 $form = $this->getClearForm();
 122                                 if ( $form->show() ) {
 123                                         $out->addHTML( $this->successMessage );
 124                                         $out->addReturnTo( SpecialPage::getTitleFor( 'Watchlist' ) );
 125                                 }
 126                                 break;
 127
 128                         case self::EDIT_NORMAL:
 129                         default:
 130                                 $this->executeViewEditWatchlist();
 131                                 break;
 132                 }
 133         }
 134
 135         /**
 136          * Renders a subheader on the watchlist page.
 137          */
 138         protected function outputSubtitle() {
 139                 $out = $this->getOutput();
 140                 $out->addSubtitle( $this->msg( 'watchlistfor2', $this->getUser()->getName() )
 141                         ->rawParams(
 142                                 self::buildTools(
 143                                         $this->getLanguage(),
 144                                         $this->getLinkRenderer()
 145                                 )
 146                         )
 147                 );
 148         }
 149
 150         /**
 151          * Executes an edit mode for the watchlist view, from which you can manage your watchlist
 152          */
 153         protected function executeViewEditWatchlist() {
 154                 $out = $this->getOutput();
 155                 $out->setPageTitle( $this->msg( 'watchlistedit-normal-title' ) );
 156                 $form = $this->getNormalForm();
 157                 if ( $form->show() ) {
 158                         $out->addHTML( $this->successMessage );
 159                         $out->addReturnTo( SpecialPage::getTitleFor( 'Watchlist' ) );
 160                 } elseif ( $this->toc !== false ) {
 161                         $out->prependHTML( $this->toc );
 162                         $out->addModules( 'mediawiki.toc' );
 163                 }
 164         }
 165
 166         /**
 167          * Return an array of subpages that this special page will accept.
 168          *
 169          * @see also SpecialWatchlist::getSubpagesForPrefixSearch
 170          * @return string[] subpages
 171          */
 172         public function getSubpagesForPrefixSearch() {
 173                 // SpecialWatchlist uses SpecialEditWatchlist::getMode, so new types should be added
 174                 // here and there - no 'edit' here, because that the default for this page
 175                 return [
 176                         'clear',
 177                         'raw',
 178                 ];
 179         }
 180
 181         /**
 182          * Extract a list of titles from a blob of text, returning
 183          * (prefixed) strings; unwatchable titles are ignored
 184          *
 185          * @param string $list
 186          * @return array
 187          */
 188         private function extractTitles( $list ) {
 189                 $list = explode( "\n", trim( $list ) );
 190                 if ( !is_array( $list ) ) {
 191                         return [];
 192                 }
 193
 194                 $titles = [];
 195
 196                 foreach ( $list as $text ) {
 197                         $text = trim( $text );
 198                         if ( strlen( $text ) > 0 ) {
 199                                 $title = Title::newFromText( $text );
 200                                 if ( $title instanceof Title && $title->isWatchable() ) {
 201                                         $titles[] = $title;
 202                                 }
 203                         }
 204                 }
 205
 206                 MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray( $titles );
 207
 208                 $list = [];
 209                 /** @var Title $title */
 210                 foreach ( $titles as $title ) {
 211                         $list[] = $title->getPrefixedText();
 212                 }
 213
 214                 return array_unique( $list );
 215         }
 216
 217         public function submitRaw( $data ) {
 218                 $wanted = $this->extractTitles( $data['Titles'] );
 219                 $current = $this->getWatchlist();
 220
 221                 if ( count( $wanted ) > 0 ) {
 222                         $toWatch = array_diff( $wanted, $current );
 223                         $toUnwatch = array_diff( $current, $wanted );
 224                         $this->watchTitles( $toWatch );
 225                         $this->unwatchTitles( $toUnwatch );
 226                         $this->getUser()->invalidateCache();
 227
 228                         if ( count( $toWatch ) > 0 || count( $toUnwatch ) > 0 ) {
 229                                 $this->successMessage = $this->msg( 'watchlistedit-raw-done' )->parse();
 230                         } else {
 231                                 return false;
 232                         }
 233
 234                         if ( count( $toWatch ) > 0 ) {
 235                                 $this->successMessage .= ' ' . $this->msg( 'watchlistedit-raw-added' )
 236                                         ->numParams( count( $toWatch ) )->parse();
 237                                 $this->showTitles( $toWatch, $this->successMessage );
 238                         }
 239
 240                         if ( count( $toUnwatch ) > 0 ) {
 241                                 $this->successMessage .= ' ' . $this->msg( 'watchlistedit-raw-removed' )
 242                                         ->numParams( count( $toUnwatch ) )->parse();
 243                                 $this->showTitles( $toUnwatch, $this->successMessage );
 244                         }
 245                 } else {
 246
 247                         if ( count( $current ) === 0 ) {
 248                                 return false;
 249                         }
 250
 251                         $this->clearUserWatchedItems( $current, 'raw' );
 252                         $this->showTitles( $current, $this->successMessage );
 253                 }
 254
 255                 return true;
 256         }
 257
 258         public function submitClear( $data ) {
 259                 $current = $this->getWatchlist();
 260                 $this->clearUserWatchedItems( $current, 'clear' );
 261                 $this->showTitles( $current, $this->successMessage );
 262                 return true;
 263         }
 264
 265         /**
 266          * @param array $current
 267          * @param string $messageFor 'raw' or 'clear'
 268          */
 269         private function clearUserWatchedItems( $current, $messageFor ) {
 270                 $watchedItemStore = MediaWikiServices::getInstance()->getWatchedItemStore();
 271                 if ( $watchedItemStore->clearUserWatchedItems( $this->getUser() ) ) {
 272                         $this->successMessage = $this->msg( 'watchlistedit-' . $messageFor . '-done' )->parse();
 273                         $this->successMessage .= ' ' . $this->msg( 'watchlistedit-' . $messageFor . '-removed' )
 274                                         ->numParams( count( $current ) )->parse();
 275                         $this->getUser()->invalidateCache();
 276                 } else {
 277                         $watchedItemStore->clearUserWatchedItemsUsingJobQueue( $this->getUser() );
 278                         $this->successMessage = $this->msg( 'watchlistedit-clear-jobqueue' )->parse();
 279                 }
 280         }
 281
 282         /**
 283          * Print out a list of linked titles
 284          *
 285          * $titles can be an array of strings or Title objects; the former
 286          * is preferred, since Titles are very memory-heavy
 287          *
 288          * @param array $titles Array of strings, or Title objects
 289          * @param string $output
 290          */
 291         private function showTitles( $titles, &$output ) {
 292                 $talk = $this->msg( 'talkpagelinktext' )->text();
 293                 // Do a batch existence check
 294                 $batch = new LinkBatch();
 295                 if ( count( $titles ) >= 100 ) {
 296                         $output = $this->msg( 'watchlistedit-too-many' )->parse();
 297                         return;
 298                 }
 299                 foreach ( $titles as $title ) {
 300                         if ( !$title instanceof Title ) {
 301                                 $title = Title::newFromText( $title );
 302                         }
 303
 304                         if ( $title instanceof Title ) {
 305                                 $batch->addObj( $title );
 306                                 $batch->addObj( $title->getTalkPage() );
 307                         }
 308                 }
 309
 310                 $batch->execute();
 311
 312                 // Print out the list
 313                 $output .= "<ul>\n";
 314
 315                 $linkRenderer = $this->getLinkRenderer();
 316                 foreach ( $titles as $title ) {
 317                         if ( !$title instanceof Title ) {
 318                                 $title = Title::newFromText( $title );
 319                         }
 320
 321                         if ( $title instanceof Title ) {
 322                                 $output .= '<li>' .
 323                                         $linkRenderer->makeLink( $title ) . ' ' .
 324                                         $this->msg( 'parentheses' )->rawParams(
 325                                                 $linkRenderer->makeLink( $title->getTalkPage(), $talk )
 326                                         )->escaped() .
 327                                         "</li>\n";
 328                         }
 329                 }
 330
 331                 $output .= "</ul>\n";
 332         }
 333
 334         /**
 335          * Prepare a list of titles on a user's watchlist (excluding talk pages)
 336          * and return an array of (prefixed) strings
 337          *
 338          * @return array
 339          */
 340         private function getWatchlist() {
 341                 $list = [];
 342
 343                 $watchedItems = MediaWikiServices::getInstance()->getWatchedItemStore()->getWatchedItemsForUser(
 344                         $this->getUser(),
 345                         [ 'forWrite' => $this->getRequest()->wasPosted() ]
 346                 );
 347
 348                 if ( $watchedItems ) {
 349                         /** @var Title[] $titles */
 350                         $titles = [];
 351                         foreach ( $watchedItems as $watchedItem ) {
 352                                 $namespace = $watchedItem->getLinkTarget()->getNamespace();
 353                                 $dbKey = $watchedItem->getLinkTarget()->getDBkey();
 354                                 $title = Title::makeTitleSafe( $namespace, $dbKey );
 355
 356                                 if ( $this->checkTitle( $title, $namespace, $dbKey )
 357                                         && !$title->isTalkPage()
 358                                 ) {
 359                                         $titles[] = $title;
 360                                 }
 361                         }
 362
 363                         MediaWikiServices::getInstance()->getGenderCache()->doTitlesArray( $titles );
 364
 365                         foreach ( $titles as $title ) {
 366                                 $list[] = $title->getPrefixedText();
 367                         }
 368                 }
 369
 370                 $this->cleanupWatchlist();
 371
 372                 return $list;
 373         }
 374
 375         /**
 376          * Get a list of titles on a user's watchlist, excluding talk pages,
 377          * and return as a two-dimensional array with namespace and title.
 378          *
 379          * @return array
 380          */
 381         protected function getWatchlistInfo() {
 382                 $titles = [];
 383
 384                 $watchedItems = MediaWikiServices::getInstance()->getWatchedItemStore()
 385                         ->getWatchedItemsForUser( $this->getUser(), [ 'sort' => WatchedItemStore::SORT_ASC ] );
 386
 387                 $lb = new LinkBatch();
 388
 389                 foreach ( $watchedItems as $watchedItem ) {
 390                         $namespace = $watchedItem->getLinkTarget()->getNamespace();
 391                         $dbKey = $watchedItem->getLinkTarget()->getDBkey();
 392                         $lb->add( $namespace, $dbKey );
 393                         if ( !MWNamespace::isTalk( $namespace ) ) {
 394                                 $titles[$namespace][$dbKey] = 1;
 395                         }
 396                 }
 397
 398                 $lb->execute();
 399
 400                 return $titles;
 401         }
 402
 403         /**
 404          * Validates watchlist entry
 405          *
 406          * @param Title $title
 407          * @param int $namespace
 408          * @param string $dbKey
 409          * @return bool Whether this item is valid
 410          */
 411         private function checkTitle( $title, $namespace, $dbKey ) {
 412                 if ( $title
 413                         && ( $title->isExternal()
 414                                 || $title->getNamespace() < 0
 415                         )
 416                 ) {
 417                         $title = false; // unrecoverable
 418                 }
 419
 420                 if ( !$title
 421                         || $title->getNamespace() != $namespace
 422                         || $title->getDBkey() != $dbKey
 423                 ) {
 424                         $this->badItems[] = [ $title, $namespace, $dbKey ];
 425                 }
 426
 427                 return (bool)$title;
 428         }
 429
 430         /**
 431          * Attempts to clean up broken items
 432          */
 433         private function cleanupWatchlist() {
 434                 if ( !count( $this->badItems ) ) {
 435                         return; // nothing to do
 436                 }
 437
 438                 $user = $this->getUser();
 439                 $badItems = $this->badItems;
 440                 DeferredUpdates::addCallableUpdate( function () use ( $user, $badItems ) {
 441                         $store = MediaWikiServices::getInstance()->getWatchedItemStore();
 442                         foreach ( $badItems as $row ) {
 443                                 list( $title, $namespace, $dbKey ) = $row;
 444                                 $action = $title ? 'cleaning up' : 'deleting';
 445                                 wfDebug( "User {$user->getName()} has broken watchlist item " .
 446                                         "ns($namespace):$dbKey, $action.\n" );
 447
 448                                 $store->removeWatch( $user, new TitleValue( (int)$namespace, $dbKey ) );
 449                                 // Can't just do an UPDATE instead of DELETE/INSERT due to unique index
 450                                 if ( $title ) {
 451                                         $user->addWatch( $title );
 452                                 }
 453                         }
 454                 } );
 455         }
 456
 457         /**
 458          * Add a list of targets to a user's watchlist
 459          *
 460          * @param string[]|LinkTarget[] $targets
 461          */
 462         private function watchTitles( $targets ) {
 463                 $expandedTargets = [];
 464                 foreach ( $targets as $target ) {
 465                         if ( !$target instanceof LinkTarget ) {
 466                                 try {
 467                                         $target = $this->titleParser->parseTitle( $target, NS_MAIN );
 468                                 }
 469                                 catch ( MalformedTitleException $e ) {
 470                                         continue;
 471                                 }
 472                         }
 473
 474                         $ns = $target->getNamespace();
 475                         $dbKey = $target->getDBkey();
 476                         $expandedTargets[] = new TitleValue( MWNamespace::getSubject( $ns ), $dbKey );
 477                         $expandedTargets[] = new TitleValue( MWNamespace::getTalk( $ns ), $dbKey );
 478                 }
 479
 480                 MediaWikiServices::getInstance()->getWatchedItemStore()->addWatchBatchForUser(
 481                         $this->getUser(),
 482                         $expandedTargets
 483                 );
 484         }
 485
 486         /**
 487          * Remove a list of titles from a user's watchlist
 488          *
 489          * $titles can be an array of strings or Title objects; the former
 490          * is preferred, since Titles are very memory-heavy
 491          *
 492          * @param array $titles Array of strings, or Title objects
 493          */
 494         private function unwatchTitles( $titles ) {
 495                 $store = MediaWikiServices::getInstance()->getWatchedItemStore();
 496
 497                 foreach ( $titles as $title ) {
 498                         if ( !$title instanceof Title ) {
 499                                 $title = Title::newFromText( $title );
 500                         }
 501
 502                         if ( $title instanceof Title ) {
 503                                 $store->removeWatch( $this->getUser(), $title->getSubjectPage() );
 504                                 $store->removeWatch( $this->getUser(), $title->getTalkPage() );
 505
 506                                 $page = WikiPage::factory( $title );
 507                                 Hooks::run( 'UnwatchArticleComplete', [ $this->getUser(), &$page ] );
 508                         }
 509                 }
 510         }
 511
 512         public function submitNormal( $data ) {
 513                 $removed = [];
 514
 515                 foreach ( $data as $titles ) {
 516                         $this->unwatchTitles( $titles );
 517                         $removed = array_merge( $removed, $titles );
 518                 }
 519
 520                 if ( count( $removed ) > 0 ) {
 521                         $this->successMessage = $this->msg( 'watchlistedit-normal-done'
 522                         )->numParams( count( $removed ) )->parse();
 523                         $this->showTitles( $removed, $this->successMessage );
 524
 525                         return true;
 526                 } else {
 527                         return false;
 528                 }
 529         }
 530
 531         /**
 532          * Get the standard watchlist editing form
 533          *
 534          * @return HTMLForm
 535          */
 536         protected function getNormalForm() {
 537                 global $wgContLang;
 538
 539                 $fields = [];
 540                 $count = 0;
 541
 542                 // Allow subscribers to manipulate the list of watched pages (or use it
 543                 // to preload lots of details at once)
 544                 $watchlistInfo = $this->getWatchlistInfo();
 545                 Hooks::run(
 546                         'WatchlistEditorBeforeFormRender',
 547                         [ &$watchlistInfo ]
 548                 );
 549
 550                 foreach ( $watchlistInfo as $namespace => $pages ) {
 551                         $options = [];
 552
 553                         foreach ( array_keys( $pages ) as $dbkey ) {
 554                                 $title = Title::makeTitleSafe( $namespace, $dbkey );
 555
 556                                 if ( $this->checkTitle( $title, $namespace, $dbkey ) ) {
 557                                         $text = $this->buildRemoveLine( $title );
 558                                         $options[$text] = $title->getPrefixedText();
 559                                         $count++;
 560                                 }
 561                         }
 562
 563                         // checkTitle can filter some options out, avoid empty sections
 564                         if ( count( $options ) > 0 ) {
 565                                 $fields['TitlesNs' . $namespace] = [
 566                                         'class' => EditWatchlistCheckboxSeriesField::class,
 567                                         'options' => $options,
 568                                         'section' => "ns$namespace",
 569                                 ];
 570                         }
 571                 }
 572                 $this->cleanupWatchlist();
 573
 574                 if ( count( $fields ) > 1 && $count > 30 ) {
 575                         $this->toc = Linker::tocIndent();
 576                         $tocLength = 0;
 577
 578                         foreach ( $fields as $data ) {
 579                                 # strip out the 'ns' prefix from the section name:
 580                                 $ns = substr( $data['section'], 2 );
 581
 582                                 $nsText = ( $ns == NS_MAIN )
 583                                         ? $this->msg( 'blanknamespace' )->escaped()
 584                                         : htmlspecialchars( $wgContLang->getFormattedNsText( $ns ) );
 585                                 $this->toc .= Linker::tocLine( "editwatchlist-{$data['section']}", $nsText,
 586                                         $this->getLanguage()->formatNum( ++$tocLength ), 1 ) . Linker::tocLineEnd();
 587                         }
 588
 589                         $this->toc = Linker::tocList( $this->toc );
 590                 } else {
 591                         $this->toc = false;
 592                 }
 593
 594                 $context = new DerivativeContext( $this->getContext() );
 595                 $context->setTitle( $this->getPageTitle() ); // Remove subpage
 596                 $form = new EditWatchlistNormalHTMLForm( $fields, $context );
 597                 $form->setSubmitTextMsg( 'watchlistedit-normal-submit' );
 598                 $form->setSubmitDestructive();
 599                 # Used message keys:
 600                 # 'accesskey-watchlistedit-normal-submit', 'tooltip-watchlistedit-normal-submit'
 601                 $form->setSubmitTooltip( 'watchlistedit-normal-submit' );
 602                 $form->setWrapperLegendMsg( 'watchlistedit-normal-legend' );
 603                 $form->addHeaderText( $this->msg( 'watchlistedit-normal-explain' )->parse() );
 604                 $form->setSubmitCallback( [ $this, 'submitNormal' ] );
 605
 606                 return $form;
 607         }
 608
 609         /**
 610          * Build the label for a checkbox, with a link to the title, and various additional bits
 611          *
 612          * @param Title $title
 613          * @return string
 614          */
 615         private function buildRemoveLine( $title ) {
 616                 $linkRenderer = $this->getLinkRenderer();
 617                 $link = $linkRenderer->makeLink( $title );
 618
 619                 $tools['talk'] = $linkRenderer->makeLink(
 620                         $title->getTalkPage(),
 621                         $this->msg( 'talkpagelinktext' )->text()
 622                 );
 623
 624                 if ( $title->exists() ) {
 625                         $tools['history'] = $linkRenderer->makeKnownLink(
 626                                 $title,
 627                                 $this->msg( 'history_small' )->text(),
 628                                 [],
 629                                 [ 'action' => 'history' ]
 630                         );
 631                 }
 632
 633                 if ( $title->getNamespace() == NS_USER && !$title->isSubpage() ) {
 634                         $tools['contributions'] = $linkRenderer->makeKnownLink(
 635                                 SpecialPage::getTitleFor( 'Contributions', $title->getText() ),
 636                                 $this->msg( 'contributions' )->text()
 637                         );
 638                 }
 639
 640                 Hooks::run(
 641                         'WatchlistEditorBuildRemoveLine',
 642                         [ &$tools, $title, $title->isRedirect(), $this->getSkin(), &$link ]
 643                 );
 644
 645                 if ( $title->isRedirect() ) {
 646                         // Linker already makes class mw-redirect, so this is redundant
 647                         $link = '<span class="watchlistredir">' . $link . '</span>';
 648                 }
 649
 650                 return $link . ' ' .
 651                         $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList( $tools ) )->escaped();
 652         }
 653
 654         /**
 655          * Get a form for editing the watchlist in "raw" mode
 656          *
 657          * @return HTMLForm
 658          */
 659         protected function getRawForm() {
 660                 $titles = implode( $this->getWatchlist(), "\n" );
 661                 $fields = [
 662                         'Titles' => [
 663                                 'type' => 'textarea',
 664                                 'label-message' => 'watchlistedit-raw-titles',
 665                                 'default' => $titles,
 666                         ],
 667                 ];
 668                 $context = new DerivativeContext( $this->getContext() );
 669                 $context->setTitle( $this->getPageTitle( 'raw' ) ); // Reset subpage
 670                 $form = new HTMLForm( $fields, $context );
 671                 $form->setSubmitTextMsg( 'watchlistedit-raw-submit' );
 672                 # Used message keys: 'accesskey-watchlistedit-raw-submit', 'tooltip-watchlistedit-raw-submit'
 673                 $form->setSubmitTooltip( 'watchlistedit-raw-submit' );
 674                 $form->setWrapperLegendMsg( 'watchlistedit-raw-legend' );
 675                 $form->addHeaderText( $this->msg( 'watchlistedit-raw-explain' )->parse() );
 676                 $form->setSubmitCallback( [ $this, 'submitRaw' ] );
 677
 678                 return $form;
 679         }
 680
 681         /**
 682          * Get a form for clearing the watchlist
 683          *
 684          * @return HTMLForm
 685          */
 686         protected function getClearForm() {
 687                 $context = new DerivativeContext( $this->getContext() );
 688                 $context->setTitle( $this->getPageTitle( 'clear' ) ); // Reset subpage
 689                 $form = new HTMLForm( [], $context );
 690                 $form->setSubmitTextMsg( 'watchlistedit-clear-submit' );
 691                 # Used message keys: 'accesskey-watchlistedit-clear-submit', 'tooltip-watchlistedit-clear-submit'
 692                 $form->setSubmitTooltip( 'watchlistedit-clear-submit' );
 693                 $form->setWrapperLegendMsg( 'watchlistedit-clear-legend' );
 694                 $form->addHeaderText( $this->msg( 'watchlistedit-clear-explain' )->parse() );
 695                 $form->setSubmitCallback( [ $this, 'submitClear' ] );
 696                 $form->setSubmitDestructive();
 697
 698                 return $form;
 699         }
 700
 701         /**
 702          * Determine whether we are editing the watchlist, and if so, what
 703          * kind of editing operation
 704          *
 705          * @param WebRequest $request
 706          * @param string $par
 707          * @return int
 708          */
 709         public static function getMode( $request, $par ) {
 710                 $mode = strtolower( $request->getVal( 'action', $par ) );
 711
 712                 switch ( $mode ) {
 713                         case 'clear':
 714                         case self::EDIT_CLEAR:
 715                                 return self::EDIT_CLEAR;
 716                         case 'raw':
 717                         case self::EDIT_RAW:
 718                                 return self::EDIT_RAW;
 719                         case 'edit':
 720                         case self::EDIT_NORMAL:
 721                                 return self::EDIT_NORMAL;
 722                         default:
 723                                 return false;
 724                 }
 725         }
 726
 727         /**
 728          * Build a set of links for convenient navigation
 729          * between watchlist viewing and editing modes
 730          *
 731          * @param Language $lang
 732          * @param LinkRenderer|null $linkRenderer
 733          * @return string
 734          */
 735         public static function buildTools( $lang, LinkRenderer $linkRenderer = null ) {
 736                 if ( !$lang instanceof Language ) {
 737                         // back-compat where the first parameter was $unused
 738                         global $wgLang;
 739                         $lang = $wgLang;
 740                 }
 741                 if ( !$linkRenderer ) {
 742                         $linkRenderer = MediaWikiServices::getInstance()->getLinkRenderer();
 743                 }
 744
 745                 $tools = [];
 746                 $modes = [
 747                         'view' => [ 'Watchlist', false ],
 748                         'edit' => [ 'EditWatchlist', false ],
 749                         'raw' => [ 'EditWatchlist', 'raw' ],
 750                         'clear' => [ 'EditWatchlist', 'clear' ],
 751                 ];
 752
 753                 foreach ( $modes as $mode => $arr ) {
 754                         // can use messages 'watchlisttools-view', 'watchlisttools-edit', 'watchlisttools-raw'
 755                         $tools[] = $linkRenderer->makeKnownLink(
 756                                 SpecialPage::getTitleFor( $arr[0], $arr[1] ),
 757                                 wfMessage( "watchlisttools-{$mode}" )->text()
 758                         );
 759                 }
 760
 761                 return Html::rawElement(
 762                         'span',
 763                         [ 'class' => 'mw-watchlist-toollinks' ],
 764                         wfMessage( 'parentheses' )->rawParams( $lang->pipeList( $tools ) )->escaped()
 765                 );
 766         }
 767 }