includes/specials/SpecialEditWatchlist.php

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