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