3 * @defgroup Watchlist Users watchlist handling
5 use MediaWiki\Linker\LinkTarget
;
8 * Implements Special:EditWatchlist
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.
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.
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
26 * @ingroup SpecialPage
31 * Provides the UI through which users can perform editing
32 * operations on their watchlist
34 * @ingroup SpecialPage
36 * @author Rob Church <robchur@gmail.com>
38 class SpecialEditWatchlist
extends UnlistedSpecialPage
{
40 * Editing modes. EDIT_CLEAR is no longer used; the "Clear" link scared people
41 * too much. Now it's passed on to the raw editor, from which it's very easy to clear.
45 const EDIT_NORMAL
= 3;
47 protected $successMessage;
51 private $badItems = [];
58 public function __construct() {
59 parent
::__construct( 'EditWatchlist', 'editmywatchlist' );
63 * Initialize any services we'll need (unless it has already been provided via a setter).
64 * This allows for dependency injection even though we don't control object creation.
66 private function initServices() {
67 if ( !$this->titleParser
) {
68 $lang = $this->getContext()->getLanguage();
69 $this->titleParser
= new MediaWikiTitleCodec( $lang, GenderCache
::singleton() );
73 public function doesWrites() {
78 * Main execution point
82 public function execute( $mode ) {
83 $this->initServices();
86 # Anons don't get a watchlist
87 $this->requireLogin( 'watchlistanontext' );
89 $out = $this->getOutput();
91 $this->checkPermissions();
92 $this->checkReadOnly();
94 $this->outputHeader();
95 $this->outputSubtitle();
96 $out->addModuleStyles( 'mediawiki.special' );
98 # B/C: $mode used to be waaay down the parameter list, and the first parameter
100 if ( $mode instanceof User
) {
101 $args = func_get_args();
102 if ( count( $args ) >= 4 ) {
106 $mode = self
::getMode( $this->getRequest(), $mode );
110 $out->setPageTitle( $this->msg( 'watchlistedit-raw-title' ) );
111 $form = $this->getRawForm();
112 if ( $form->show() ) {
113 $out->addHTML( $this->successMessage
);
114 $out->addReturnTo( SpecialPage
::getTitleFor( 'Watchlist' ) );
117 case self
::EDIT_CLEAR
:
118 $out->setPageTitle( $this->msg( 'watchlistedit-clear-title' ) );
119 $form = $this->getClearForm();
120 if ( $form->show() ) {
121 $out->addHTML( $this->successMessage
);
122 $out->addReturnTo( SpecialPage
::getTitleFor( 'Watchlist' ) );
126 case self
::EDIT_NORMAL
:
128 $this->executeViewEditWatchlist();
134 * Renders a subheader on the watchlist page.
136 protected function outputSubtitle() {
137 $out = $this->getOutput();
138 $out->addSubtitle( $this->msg( 'watchlistfor2', $this->getUser()->getName() )
139 ->rawParams( SpecialEditWatchlist
::buildTools( null ) ) );
143 * Executes an edit mode for the watchlist view, from which you can manage your watchlist
146 protected function executeViewEditWatchlist() {
147 $out = $this->getOutput();
148 $out->setPageTitle( $this->msg( 'watchlistedit-normal-title' ) );
149 $form = $this->getNormalForm();
150 if ( $form->show() ) {
151 $out->addHTML( $this->successMessage
);
152 $out->addReturnTo( SpecialPage
::getTitleFor( 'Watchlist' ) );
153 } elseif ( $this->toc
!== false ) {
154 $out->prependHTML( $this->toc
);
155 $out->addModules( 'mediawiki.toc' );
160 * Return an array of subpages that this special page will accept.
162 * @see also SpecialWatchlist::getSubpagesForPrefixSearch
163 * @return string[] subpages
165 public function getSubpagesForPrefixSearch() {
166 // SpecialWatchlist uses SpecialEditWatchlist::getMode, so new types should be added
167 // here and there - no 'edit' here, because that the default for this page
175 * Extract a list of titles from a blob of text, returning
176 * (prefixed) strings; unwatchable titles are ignored
178 * @param string $list
181 private function extractTitles( $list ) {
182 $list = explode( "\n", trim( $list ) );
183 if ( !is_array( $list ) ) {
189 foreach ( $list as $text ) {
190 $text = trim( $text );
191 if ( strlen( $text ) > 0 ) {
192 $title = Title
::newFromText( $text );
193 if ( $title instanceof Title
&& $title->isWatchable() ) {
199 GenderCache
::singleton()->doTitlesArray( $titles );
202 /** @var Title $title */
203 foreach ( $titles as $title ) {
204 $list[] = $title->getPrefixedText();
207 return array_unique( $list );
210 public function submitRaw( $data ) {
211 $wanted = $this->extractTitles( $data['Titles'] );
212 $current = $this->getWatchlist();
214 if ( count( $wanted ) > 0 ) {
215 $toWatch = array_diff( $wanted, $current );
216 $toUnwatch = array_diff( $current, $wanted );
217 $this->watchTitles( $toWatch );
218 $this->unwatchTitles( $toUnwatch );
219 $this->getUser()->invalidateCache();
221 if ( count( $toWatch ) > 0 ||
count( $toUnwatch ) > 0 ) {
222 $this->successMessage
= $this->msg( 'watchlistedit-raw-done' )->parse();
227 if ( count( $toWatch ) > 0 ) {
228 $this->successMessage
.= ' ' . $this->msg( 'watchlistedit-raw-added' )
229 ->numParams( count( $toWatch ) )->parse();
230 $this->showTitles( $toWatch, $this->successMessage
);
233 if ( count( $toUnwatch ) > 0 ) {
234 $this->successMessage
.= ' ' . $this->msg( 'watchlistedit-raw-removed' )
235 ->numParams( count( $toUnwatch ) )->parse();
236 $this->showTitles( $toUnwatch, $this->successMessage
);
239 $this->clearWatchlist();
240 $this->getUser()->invalidateCache();
242 if ( count( $current ) > 0 ) {
243 $this->successMessage
= $this->msg( 'watchlistedit-raw-done' )->parse();
248 $this->successMessage
.= ' ' . $this->msg( 'watchlistedit-raw-removed' )
249 ->numParams( count( $current ) )->parse();
250 $this->showTitles( $current, $this->successMessage
);
256 public function submitClear( $data ) {
257 $current = $this->getWatchlist();
258 $this->clearWatchlist();
259 $this->getUser()->invalidateCache();
260 $this->successMessage
= $this->msg( 'watchlistedit-clear-done' )->parse();
261 $this->successMessage
.= ' ' . $this->msg( 'watchlistedit-clear-removed' )
262 ->numParams( count( $current ) )->parse();
263 $this->showTitles( $current, $this->successMessage
);
269 * Print out a list of linked titles
271 * $titles can be an array of strings or Title objects; the former
272 * is preferred, since Titles are very memory-heavy
274 * @param array $titles Array of strings, or Title objects
275 * @param string $output
277 private function showTitles( $titles, &$output ) {
278 $talk = $this->msg( 'talkpagelinktext' )->escaped();
279 // Do a batch existence check
280 $batch = new LinkBatch();
281 if ( count( $titles ) >= 100 ) {
282 $output = $this->msg( 'watchlistedit-too-many' )->parse();
285 foreach ( $titles as $title ) {
286 if ( !$title instanceof Title
) {
287 $title = Title
::newFromText( $title );
290 if ( $title instanceof Title
) {
291 $batch->addObj( $title );
292 $batch->addObj( $title->getTalkPage() );
298 // Print out the list
301 foreach ( $titles as $title ) {
302 if ( !$title instanceof Title
) {
303 $title = Title
::newFromText( $title );
306 if ( $title instanceof Title
) {
308 Linker
::link( $title ) . ' ' .
309 $this->msg( 'parentheses' )->rawParams(
310 Linker
::link( $title->getTalkPage(), $talk )
316 $output .= "</ul>\n";
320 * Prepare a list of titles on a user's watchlist (excluding talk pages)
321 * and return an array of (prefixed) strings
325 private function getWatchlist() {
328 $watchedItems = WatchedItemStore
::getDefaultInstance()->getWatchedItemsForUser(
330 [ 'forWrite' => $this->getRequest()->wasPosted() ]
333 if ( $watchedItems ) {
334 /** @var Title[] $titles */
336 foreach ( $watchedItems as $watchedItem ) {
337 $namespace = $watchedItem->getLinkTarget()->getNamespace();
338 $dbKey = $watchedItem->getLinkTarget()->getDBkey();
339 $title = Title
::makeTitleSafe( $namespace, $dbKey );
341 if ( $this->checkTitle( $title, $namespace, $dbKey )
342 && !$title->isTalkPage()
348 GenderCache
::singleton()->doTitlesArray( $titles );
350 foreach ( $titles as $title ) {
351 $list[] = $title->getPrefixedText();
355 $this->cleanupWatchlist();
361 * Get a list of titles on a user's watchlist, excluding talk pages,
362 * and return as a two-dimensional array with namespace and title.
366 protected function getWatchlistInfo() {
369 $watchedItems = WatchedItemStore
::getDefaultInstance()
370 ->getWatchedItemsForUser( $this->getUser(), [ 'sort' => WatchedItemStore
::SORT_ASC
] );
372 $lb = new LinkBatch();
374 foreach ( $watchedItems as $watchedItem ) {
375 $namespace = $watchedItem->getLinkTarget()->getNamespace();
376 $dbKey = $watchedItem->getLinkTarget()->getDBkey();
377 $lb->add( $namespace, $dbKey );
378 if ( !MWNamespace
::isTalk( $namespace ) ) {
379 $titles[$namespace][$dbKey] = 1;
389 * Validates watchlist entry
391 * @param Title $title
392 * @param int $namespace
393 * @param string $dbKey
394 * @return bool Whether this item is valid
396 private function checkTitle( $title, $namespace, $dbKey ) {
398 && ( $title->isExternal()
399 ||
$title->getNamespace() < 0
402 $title = false; // unrecoverable
406 ||
$title->getNamespace() != $namespace
407 ||
$title->getDBkey() != $dbKey
409 $this->badItems
[] = [ $title, $namespace, $dbKey ];
416 * Attempts to clean up broken items
418 private function cleanupWatchlist() {
419 if ( !count( $this->badItems
) ) {
420 return; // nothing to do
423 $user = $this->getUser();
424 $store = WatchedItemStore
::getDefaultInstance();
426 foreach ( $this->badItems
as $row ) {
427 list( $title, $namespace, $dbKey ) = $row;
428 $action = $title ?
'cleaning up' : 'deleting';
429 wfDebug( "User {$user->getName()} has broken watchlist item ns($namespace):$dbKey, $action.\n" );
431 $store->removeWatch( $user, new TitleValue( (int)$namespace, $dbKey ) );
433 // Can't just do an UPDATE instead of DELETE/INSERT due to unique index
435 $user->addWatch( $title );
441 * Remove all titles from a user's watchlist
443 private function clearWatchlist() {
444 $dbw = wfGetDB( DB_MASTER
);
447 [ 'wl_user' => $this->getUser()->getId() ],
453 * Add a list of targets to a user's watchlist
455 * @param string[]|LinkTarget[] $targets
457 private function watchTitles( $targets ) {
458 $expandedTargets = [];
459 foreach ( $targets as $target ) {
460 if ( !$target instanceof LinkTarget
) {
462 $target = $this->titleParser
->parseTitle( $target, NS_MAIN
);
464 catch ( MalformedTitleException
$e ) {
469 $ns = $target->getNamespace();
470 $dbKey = $target->getDBkey();
471 $expandedTargets[] = new TitleValue( MWNamespace
::getSubject( $ns ), $dbKey );
472 $expandedTargets[] = new TitleValue( MWNamespace
::getTalk( $ns ), $dbKey );
475 WatchedItemStore
::getDefaultInstance()->addWatchBatchForUser(
482 * Remove a list of titles from a user's watchlist
484 * $titles can be an array of strings or Title objects; the former
485 * is preferred, since Titles are very memory-heavy
487 * @param array $titles Array of strings, or Title objects
489 private function unwatchTitles( $titles ) {
490 $store = WatchedItemStore
::getDefaultInstance();
492 foreach ( $titles as $title ) {
493 if ( !$title instanceof Title
) {
494 $title = Title
::newFromText( $title );
497 if ( $title instanceof Title
) {
498 $store->removeWatch( $this->getUser(), $title->getSubjectPage() );
499 $store->removeWatch( $this->getUser(), $title->getTalkPage() );
501 $page = WikiPage
::factory( $title );
502 Hooks
::run( 'UnwatchArticleComplete', [ $this->getUser(), &$page ] );
507 public function submitNormal( $data ) {
510 foreach ( $data as $titles ) {
511 $this->unwatchTitles( $titles );
512 $removed = array_merge( $removed, $titles );
515 if ( count( $removed ) > 0 ) {
516 $this->successMessage
= $this->msg( 'watchlistedit-normal-done'
517 )->numParams( count( $removed ) )->parse();
518 $this->showTitles( $removed, $this->successMessage
);
527 * Get the standard watchlist editing form
531 protected function getNormalForm() {
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();
541 'WatchlistEditorBeforeFormRender',
545 foreach ( $watchlistInfo as $namespace => $pages ) {
548 foreach ( array_keys( $pages ) as $dbkey ) {
549 $title = Title
::makeTitleSafe( $namespace, $dbkey );
551 if ( $this->checkTitle( $title, $namespace, $dbkey ) ) {
552 $text = $this->buildRemoveLine( $title );
553 $options[$text] = $title->getPrefixedText();
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",
567 $this->cleanupWatchlist();
569 if ( count( $fields ) > 1 && $count > 30 ) {
570 $this->toc
= Linker
::tocIndent();
573 foreach ( $fields as $data ) {
574 # strip out the 'ns' prefix from the section name:
575 $ns = substr( $data['section'], 2 );
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();
584 $this->toc
= Linker
::tocList( $this->toc
);
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();
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' ] );
605 * Build the label for a checkbox, with a link to the title, and various additional bits
607 * @param Title $title
610 private function buildRemoveLine( $title ) {
611 $link = Linker
::link( $title );
613 $tools['talk'] = Linker
::link(
614 $title->getTalkPage(),
615 $this->msg( 'talkpagelinktext' )->escaped()
618 if ( $title->exists() ) {
619 $tools['history'] = Linker
::linkKnown(
621 $this->msg( 'history_short' )->escaped(),
623 [ 'action' => 'history' ]
627 if ( $title->getNamespace() == NS_USER
&& !$title->isSubpage() ) {
628 $tools['contributions'] = Linker
::linkKnown(
629 SpecialPage
::getTitleFor( 'Contributions', $title->getText() ),
630 $this->msg( 'contributions' )->escaped()
635 'WatchlistEditorBuildRemoveLine',
636 [ &$tools, $title, $title->isRedirect(), $this->getSkin(), &$link ]
639 if ( $title->isRedirect() ) {
640 // Linker already makes class mw-redirect, so this is redundant
641 $link = '<span class="watchlistredir">' . $link . '</span>';
645 $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList( $tools ) )->escaped();
649 * Get a form for editing the watchlist in "raw" mode
653 protected function getRawForm() {
654 $titles = implode( $this->getWatchlist(), "\n" );
657 'type' => 'textarea',
658 'label-message' => 'watchlistedit-raw-titles',
659 'default' => $titles,
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' ] );
676 * Get a form for clearing the watchlist
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();
696 * Determine whether we are editing the watchlist, and if so, what
697 * kind of editing operation
699 * @param WebRequest $request
703 public static function getMode( $request, $par ) {
704 $mode = strtolower( $request->getVal( 'action', $par ) );
708 case self
::EDIT_CLEAR
:
709 return self
::EDIT_CLEAR
;
712 return self
::EDIT_RAW
;
714 case self
::EDIT_NORMAL
:
715 return self
::EDIT_NORMAL
;
722 * Build a set of links for convenient navigation
723 * between watchlist viewing and editing modes
725 * @param null $unused
728 public static function buildTools( $unused ) {
733 'view' => [ 'Watchlist', false ],
734 'edit' => [ 'EditWatchlist', false ],
735 'raw' => [ 'EditWatchlist', 'raw' ],
736 'clear' => [ 'EditWatchlist', 'clear' ],
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()
747 return Html
::rawElement(
749 [ 'class' => 'mw-watchlist-toollinks' ],
750 wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $tools ) )->escaped()
756 * Extend HTMLForm purely so we can have a more sane way of getting the section headers
758 class EditWatchlistNormalHTMLForm
extends HTMLForm
{
759 public function getLegend( $namespace ) {
760 $namespace = substr( $namespace, 2 );
762 return $namespace == NS_MAIN
763 ?
$this->msg( 'blanknamespace' )->escaped()
764 : htmlspecialchars( $this->getContext()->getLanguage()->getFormattedNsText( $namespace ) );
767 public function getBody() {
768 return $this->displaySection( $this->mFieldTree
, '', 'editwatchlist-' );
772 class EditWatchlistCheckboxSeriesField
extends HTMLMultiSelectField
{
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.
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.
784 function validate( $value, $alldata ) {
785 // Need to call into grandparent to be a good citizen. :)
786 return HTMLFormField
::validate( $value, $alldata );