3 * @defgroup Watchlist Users watchlist handling
7 * Implements Special:EditWatchlist
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.
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.
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
25 * @ingroup SpecialPage
30 * Provides the UI through which users can perform editing
31 * operations on their watchlist
33 * @ingroup SpecialPage
35 * @author Rob Church <robchur@gmail.com>
37 class SpecialEditWatchlist
extends UnlistedSpecialPage
{
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.
44 const EDIT_NORMAL
= 3;
46 protected $successMessage;
50 private $badItems = [];
52 public function __construct() {
53 parent
::__construct( 'EditWatchlist', 'editmywatchlist' );
56 public function doesWrites() {
61 * Main execution point
65 public function execute( $mode ) {
68 # Anons don't get a watchlist
69 $this->requireLogin( 'watchlistanontext' );
71 $out = $this->getOutput();
73 $this->checkPermissions();
74 $this->checkReadOnly();
76 $this->outputHeader();
77 $this->outputSubtitle();
78 $out->addModuleStyles( 'mediawiki.special' );
80 # B/C: $mode used to be waaay down the parameter list, and the first parameter
82 if ( $mode instanceof User
) {
83 $args = func_get_args();
84 if ( count( $args ) >= 4 ) {
88 $mode = self
::getMode( $this->getRequest(), $mode );
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' ) );
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' ) );
108 case self
::EDIT_NORMAL
:
110 $this->executeViewEditWatchlist();
116 * Renders a subheader on the watchlist page.
118 protected function outputSubtitle() {
119 $out = $this->getOutput();
120 $out->addSubtitle( $this->msg( 'watchlistfor2', $this->getUser()->getName() )
121 ->rawParams( SpecialEditWatchlist
::buildTools( null ) ) );
125 * Executes an edit mode for the watchlist view, from which you can manage your watchlist
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' );
142 * Return an array of subpages that this special page will accept.
144 * @see also SpecialWatchlist::getSubpagesForPrefixSearch
145 * @return string[] subpages
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
157 * Extract a list of titles from a blob of text, returning
158 * (prefixed) strings; unwatchable titles are ignored
160 * @param string $list
163 private function extractTitles( $list ) {
164 $list = explode( "\n", trim( $list ) );
165 if ( !is_array( $list ) ) {
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() ) {
181 GenderCache
::singleton()->doTitlesArray( $titles );
184 /** @var Title $title */
185 foreach ( $titles as $title ) {
186 $list[] = $title->getPrefixedText();
189 return array_unique( $list );
192 public function submitRaw( $data ) {
193 $wanted = $this->extractTitles( $data['Titles'] );
194 $current = $this->getWatchlist();
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();
203 if ( count( $toWatch ) > 0 ||
count( $toUnwatch ) > 0 ) {
204 $this->successMessage
= $this->msg( 'watchlistedit-raw-done' )->parse();
209 if ( count( $toWatch ) > 0 ) {
210 $this->successMessage
.= ' ' . $this->msg( 'watchlistedit-raw-added' )
211 ->numParams( count( $toWatch ) )->parse();
212 $this->showTitles( $toWatch, $this->successMessage
);
215 if ( count( $toUnwatch ) > 0 ) {
216 $this->successMessage
.= ' ' . $this->msg( 'watchlistedit-raw-removed' )
217 ->numParams( count( $toUnwatch ) )->parse();
218 $this->showTitles( $toUnwatch, $this->successMessage
);
221 $this->clearWatchlist();
222 $this->getUser()->invalidateCache();
224 if ( count( $current ) > 0 ) {
225 $this->successMessage
= $this->msg( 'watchlistedit-raw-done' )->parse();
230 $this->successMessage
.= ' ' . $this->msg( 'watchlistedit-raw-removed' )
231 ->numParams( count( $current ) )->parse();
232 $this->showTitles( $current, $this->successMessage
);
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
);
251 * Print out a list of linked titles
253 * $titles can be an array of strings or Title objects; the former
254 * is preferred, since Titles are very memory-heavy
256 * @param array $titles Array of strings, or Title objects
257 * @param string $output
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();
267 foreach ( $titles as $title ) {
268 if ( !$title instanceof Title
) {
269 $title = Title
::newFromText( $title );
272 if ( $title instanceof Title
) {
273 $batch->addObj( $title );
274 $batch->addObj( $title->getTalkPage() );
280 // Print out the list
283 foreach ( $titles as $title ) {
284 if ( !$title instanceof Title
) {
285 $title = Title
::newFromText( $title );
288 if ( $title instanceof Title
) {
290 Linker
::link( $title ) . ' ' .
291 $this->msg( 'parentheses' )->rawParams(
292 Linker
::link( $title->getTalkPage(), $talk )
298 $output .= "</ul>\n";
302 * Prepare a list of titles on a user's watchlist (excluding talk pages)
303 * and return an array of (prefixed) strings
307 private function getWatchlist() {
310 $watchedItems = WatchedItemStore
::getDefaultInstance()->getWatchedItemsForUser(
312 [ 'forWrite' => $this->getRequest()->wasPosted() ]
315 if ( $watchedItems ) {
316 /** @var Title[] $titles */
318 foreach ( $watchedItems as $watchedItem ) {
319 $namespace = $watchedItem->getLinkTarget()->getNamespace();
320 $dbKey = $watchedItem->getLinkTarget()->getDBkey();
321 $title = Title
::makeTitleSafe( $namespace, $dbKey );
323 if ( $this->checkTitle( $title, $namespace, $dbKey )
324 && !$title->isTalkPage()
330 GenderCache
::singleton()->doTitlesArray( $titles );
332 foreach ( $titles as $title ) {
333 $list[] = $title->getPrefixedText();
337 $this->cleanupWatchlist();
343 * Get a list of titles on a user's watchlist, excluding talk pages,
344 * and return as a two-dimensional array with namespace and title.
348 protected function getWatchlistInfo() {
351 $watchedItems = WatchedItemStore
::getDefaultInstance()
352 ->getWatchedItemsForUser( $this->getUser(), [ 'sort' => WatchedItemStore
::SORT_ASC
] );
354 $lb = new LinkBatch();
356 foreach ( $watchedItems as $watchedItem ) {
357 $namespace = $watchedItem->getLinkTarget()->getNamespace();
358 $dbKey = $watchedItem->getLinkTarget()->getDBkey();
359 $lb->add( $namespace, $dbKey );
360 if ( !MWNamespace
::isTalk( $namespace ) ) {
361 $titles[$namespace][$dbKey] = 1;
371 * Validates watchlist entry
373 * @param Title $title
374 * @param int $namespace
375 * @param string $dbKey
376 * @return bool Whether this item is valid
378 private function checkTitle( $title, $namespace, $dbKey ) {
380 && ( $title->isExternal()
381 ||
$title->getNamespace() < 0
384 $title = false; // unrecoverable
388 ||
$title->getNamespace() != $namespace
389 ||
$title->getDBkey() != $dbKey
391 $this->badItems
[] = [ $title, $namespace, $dbKey ];
398 * Attempts to clean up broken items
400 private function cleanupWatchlist() {
401 if ( !count( $this->badItems
) ) {
402 return; // nothing to do
405 $user = $this->getUser();
406 $store = WatchedItemStore
::getDefaultInstance();
408 foreach ( $this->badItems
as $row ) {
409 list( $title, $namespace, $dbKey ) = $row;
410 $action = $title ?
'cleaning up' : 'deleting';
411 wfDebug( "User {$user->getName()} has broken watchlist item ns($namespace):$dbKey, $action.\n" );
413 $store->removeWatch( $user, new TitleValue( (int)$namespace, $dbKey ) );
415 // Can't just do an UPDATE instead of DELETE/INSERT due to unique index
417 $user->addWatch( $title );
423 * Remove all titles from a user's watchlist
425 private function clearWatchlist() {
426 $dbw = wfGetDB( DB_MASTER
);
429 [ 'wl_user' => $this->getUser()->getId() ],
435 * Add a list of titles to a user's watchlist
437 * $titles can be an array of strings or Title objects; the former
438 * is preferred, since Titles are very memory-heavy
440 * @param array $titles Array of strings, or Title objects
442 private function watchTitles( $titles ) {
443 $dbw = wfGetDB( DB_MASTER
);
446 foreach ( $titles as $title ) {
447 if ( !$title instanceof Title
) {
448 $title = Title
::newFromText( $title );
451 if ( $title instanceof Title
) {
453 'wl_user' => $this->getUser()->getId(),
454 'wl_namespace' => MWNamespace
::getSubject( $title->getNamespace() ),
455 'wl_title' => $title->getDBkey(),
456 'wl_notificationtimestamp' => null,
459 'wl_user' => $this->getUser()->getId(),
460 'wl_namespace' => MWNamespace
::getTalk( $title->getNamespace() ),
461 'wl_title' => $title->getDBkey(),
462 'wl_notificationtimestamp' => null,
467 $dbw->insert( 'watchlist', $rows, __METHOD__
, 'IGNORE' );
471 * Remove a list of titles from a user's watchlist
473 * $titles can be an array of strings or Title objects; the former
474 * is preferred, since Titles are very memory-heavy
476 * @param array $titles Array of strings, or Title objects
478 private function unwatchTitles( $titles ) {
479 $store = WatchedItemStore
::getDefaultInstance();
481 foreach ( $titles as $title ) {
482 if ( !$title instanceof Title
) {
483 $title = Title
::newFromText( $title );
486 if ( $title instanceof Title
) {
487 $store->removeWatch( $this->getUser(), $title->getSubjectPage() );
488 $store->removeWatch( $this->getUser(), $title->getTalkPage() );
490 $page = WikiPage
::factory( $title );
491 Hooks
::run( 'UnwatchArticleComplete', [ $this->getUser(), &$page ] );
496 public function submitNormal( $data ) {
499 foreach ( $data as $titles ) {
500 $this->unwatchTitles( $titles );
501 $removed = array_merge( $removed, $titles );
504 if ( count( $removed ) > 0 ) {
505 $this->successMessage
= $this->msg( 'watchlistedit-normal-done'
506 )->numParams( count( $removed ) )->parse();
507 $this->showTitles( $removed, $this->successMessage
);
516 * Get the standard watchlist editing form
520 protected function getNormalForm() {
526 // Allow subscribers to manipulate the list of watched pages (or use it
527 // to preload lots of details at once)
528 $watchlistInfo = $this->getWatchlistInfo();
530 'WatchlistEditorBeforeFormRender',
534 foreach ( $watchlistInfo as $namespace => $pages ) {
537 foreach ( array_keys( $pages ) as $dbkey ) {
538 $title = Title
::makeTitleSafe( $namespace, $dbkey );
540 if ( $this->checkTitle( $title, $namespace, $dbkey ) ) {
541 $text = $this->buildRemoveLine( $title );
542 $options[$text] = $title->getPrefixedText();
547 // checkTitle can filter some options out, avoid empty sections
548 if ( count( $options ) > 0 ) {
549 $fields['TitlesNs' . $namespace] = [
550 'class' => 'EditWatchlistCheckboxSeriesField',
551 'options' => $options,
552 'section' => "ns$namespace",
556 $this->cleanupWatchlist();
558 if ( count( $fields ) > 1 && $count > 30 ) {
559 $this->toc
= Linker
::tocIndent();
562 foreach ( $fields as $data ) {
563 # strip out the 'ns' prefix from the section name:
564 $ns = substr( $data['section'], 2 );
566 $nsText = ( $ns == NS_MAIN
)
567 ?
$this->msg( 'blanknamespace' )->escaped()
568 : htmlspecialchars( $wgContLang->getFormattedNsText( $ns ) );
569 $this->toc
.= Linker
::tocLine( "editwatchlist-{$data['section']}", $nsText,
570 $this->getLanguage()->formatNum( ++
$tocLength ), 1 ) . Linker
::tocLineEnd();
573 $this->toc
= Linker
::tocList( $this->toc
);
578 $context = new DerivativeContext( $this->getContext() );
579 $context->setTitle( $this->getPageTitle() ); // Remove subpage
580 $form = new EditWatchlistNormalHTMLForm( $fields, $context );
581 $form->setSubmitTextMsg( 'watchlistedit-normal-submit' );
582 $form->setSubmitDestructive();
584 # 'accesskey-watchlistedit-normal-submit', 'tooltip-watchlistedit-normal-submit'
585 $form->setSubmitTooltip( 'watchlistedit-normal-submit' );
586 $form->setWrapperLegendMsg( 'watchlistedit-normal-legend' );
587 $form->addHeaderText( $this->msg( 'watchlistedit-normal-explain' )->parse() );
588 $form->setSubmitCallback( [ $this, 'submitNormal' ] );
594 * Build the label for a checkbox, with a link to the title, and various additional bits
596 * @param Title $title
599 private function buildRemoveLine( $title ) {
600 $link = Linker
::link( $title );
602 $tools['talk'] = Linker
::link(
603 $title->getTalkPage(),
604 $this->msg( 'talkpagelinktext' )->escaped()
607 if ( $title->exists() ) {
608 $tools['history'] = Linker
::linkKnown(
610 $this->msg( 'history_short' )->escaped(),
612 [ 'action' => 'history' ]
616 if ( $title->getNamespace() == NS_USER
&& !$title->isSubpage() ) {
617 $tools['contributions'] = Linker
::linkKnown(
618 SpecialPage
::getTitleFor( 'Contributions', $title->getText() ),
619 $this->msg( 'contributions' )->escaped()
624 'WatchlistEditorBuildRemoveLine',
625 [ &$tools, $title, $title->isRedirect(), $this->getSkin(), &$link ]
628 if ( $title->isRedirect() ) {
629 // Linker already makes class mw-redirect, so this is redundant
630 $link = '<span class="watchlistredir">' . $link . '</span>';
634 $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList( $tools ) )->escaped();
638 * Get a form for editing the watchlist in "raw" mode
642 protected function getRawForm() {
643 $titles = implode( $this->getWatchlist(), "\n" );
646 'type' => 'textarea',
647 'label-message' => 'watchlistedit-raw-titles',
648 'default' => $titles,
651 $context = new DerivativeContext( $this->getContext() );
652 $context->setTitle( $this->getPageTitle( 'raw' ) ); // Reset subpage
653 $form = new HTMLForm( $fields, $context );
654 $form->setSubmitTextMsg( 'watchlistedit-raw-submit' );
655 # Used message keys: 'accesskey-watchlistedit-raw-submit', 'tooltip-watchlistedit-raw-submit'
656 $form->setSubmitTooltip( 'watchlistedit-raw-submit' );
657 $form->setWrapperLegendMsg( 'watchlistedit-raw-legend' );
658 $form->addHeaderText( $this->msg( 'watchlistedit-raw-explain' )->parse() );
659 $form->setSubmitCallback( [ $this, 'submitRaw' ] );
665 * Get a form for clearing the watchlist
669 protected function getClearForm() {
670 $context = new DerivativeContext( $this->getContext() );
671 $context->setTitle( $this->getPageTitle( 'clear' ) ); // Reset subpage
672 $form = new HTMLForm( [], $context );
673 $form->setSubmitTextMsg( 'watchlistedit-clear-submit' );
674 # Used message keys: 'accesskey-watchlistedit-clear-submit', 'tooltip-watchlistedit-clear-submit'
675 $form->setSubmitTooltip( 'watchlistedit-clear-submit' );
676 $form->setWrapperLegendMsg( 'watchlistedit-clear-legend' );
677 $form->addHeaderText( $this->msg( 'watchlistedit-clear-explain' )->parse() );
678 $form->setSubmitCallback( [ $this, 'submitClear' ] );
679 $form->setSubmitDestructive();
685 * Determine whether we are editing the watchlist, and if so, what
686 * kind of editing operation
688 * @param WebRequest $request
692 public static function getMode( $request, $par ) {
693 $mode = strtolower( $request->getVal( 'action', $par ) );
697 case self
::EDIT_CLEAR
:
698 return self
::EDIT_CLEAR
;
701 return self
::EDIT_RAW
;
703 case self
::EDIT_NORMAL
:
704 return self
::EDIT_NORMAL
;
711 * Build a set of links for convenient navigation
712 * between watchlist viewing and editing modes
714 * @param null $unused
717 public static function buildTools( $unused ) {
722 'view' => [ 'Watchlist', false ],
723 'edit' => [ 'EditWatchlist', false ],
724 'raw' => [ 'EditWatchlist', 'raw' ],
725 'clear' => [ 'EditWatchlist', 'clear' ],
728 foreach ( $modes as $mode => $arr ) {
729 // can use messages 'watchlisttools-view', 'watchlisttools-edit', 'watchlisttools-raw'
730 $tools[] = Linker
::linkKnown(
731 SpecialPage
::getTitleFor( $arr[0], $arr[1] ),
732 wfMessage( "watchlisttools-{$mode}" )->escaped()
736 return Html
::rawElement(
738 [ 'class' => 'mw-watchlist-toollinks' ],
739 wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $tools ) )->escaped()
745 * Extend HTMLForm purely so we can have a more sane way of getting the section headers
747 class EditWatchlistNormalHTMLForm
extends HTMLForm
{
748 public function getLegend( $namespace ) {
749 $namespace = substr( $namespace, 2 );
751 return $namespace == NS_MAIN
752 ?
$this->msg( 'blanknamespace' )->escaped()
753 : htmlspecialchars( $this->getContext()->getLanguage()->getFormattedNsText( $namespace ) );
756 public function getBody() {
757 return $this->displaySection( $this->mFieldTree
, '', 'editwatchlist-' );
761 class EditWatchlistCheckboxSeriesField
extends HTMLMultiSelectField
{
763 * HTMLMultiSelectField throws validation errors if we get input data
764 * that doesn't match the data set in the form setup. This causes
765 * problems if something gets removed from the watchlist while the
766 * form is open (bug 32126), but we know that invalid items will
767 * be harmless so we can override it here.
769 * @param string $value The value the field was submitted with
770 * @param array $alldata The data collected from the form
771 * @return bool|string Bool true on success, or String error to display.
773 function validate( $value, $alldata ) {
774 // Need to call into grandparent to be a good citizen. :)
775 return HTMLFormField
::validate( $value, $alldata );