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() {
350 $dbr = wfGetDB( DB_SLAVE
);
354 [ 'wl_namespace', 'wl_title' ],
355 [ 'wl_user' => $this->getUser()->getId() ],
357 [ 'ORDER BY' => [ 'wl_namespace', 'wl_title' ] ]
360 $lb = new LinkBatch();
362 foreach ( $res as $row ) {
363 $lb->add( $row->wl_namespace
, $row->wl_title
);
364 if ( !MWNamespace
::isTalk( $row->wl_namespace
) ) {
365 $titles[$row->wl_namespace
][$row->wl_title
] = 1;
375 * Validates watchlist entry
377 * @param Title $title
378 * @param int $namespace
379 * @param string $dbKey
380 * @return bool Whether this item is valid
382 private function checkTitle( $title, $namespace, $dbKey ) {
384 && ( $title->isExternal()
385 ||
$title->getNamespace() < 0
388 $title = false; // unrecoverable
392 ||
$title->getNamespace() != $namespace
393 ||
$title->getDBkey() != $dbKey
395 $this->badItems
[] = [ $title, $namespace, $dbKey ];
402 * Attempts to clean up broken items
404 private function cleanupWatchlist() {
405 if ( !count( $this->badItems
) ) {
406 return; // nothing to do
409 $user = $this->getUser();
410 $store = WatchedItemStore
::getDefaultInstance();
412 foreach ( $this->badItems
as $row ) {
413 list( $title, $namespace, $dbKey ) = $row;
414 $action = $title ?
'cleaning up' : 'deleting';
415 wfDebug( "User {$user->getName()} has broken watchlist item ns($namespace):$dbKey, $action.\n" );
417 $store->removeWatch( $user, new TitleValue( (int)$namespace, $dbKey ) );
419 // Can't just do an UPDATE instead of DELETE/INSERT due to unique index
421 $user->addWatch( $title );
427 * Remove all titles from a user's watchlist
429 private function clearWatchlist() {
430 $dbw = wfGetDB( DB_MASTER
);
433 [ 'wl_user' => $this->getUser()->getId() ],
439 * Add a list of titles to a user's watchlist
441 * $titles can be an array of strings or Title objects; the former
442 * is preferred, since Titles are very memory-heavy
444 * @param array $titles Array of strings, or Title objects
446 private function watchTitles( $titles ) {
447 $dbw = wfGetDB( DB_MASTER
);
450 foreach ( $titles as $title ) {
451 if ( !$title instanceof Title
) {
452 $title = Title
::newFromText( $title );
455 if ( $title instanceof Title
) {
457 'wl_user' => $this->getUser()->getId(),
458 'wl_namespace' => MWNamespace
::getSubject( $title->getNamespace() ),
459 'wl_title' => $title->getDBkey(),
460 'wl_notificationtimestamp' => null,
463 'wl_user' => $this->getUser()->getId(),
464 'wl_namespace' => MWNamespace
::getTalk( $title->getNamespace() ),
465 'wl_title' => $title->getDBkey(),
466 'wl_notificationtimestamp' => null,
471 $dbw->insert( 'watchlist', $rows, __METHOD__
, 'IGNORE' );
475 * Remove a list of titles from a user's watchlist
477 * $titles can be an array of strings or Title objects; the former
478 * is preferred, since Titles are very memory-heavy
480 * @param array $titles Array of strings, or Title objects
482 private function unwatchTitles( $titles ) {
483 $store = WatchedItemStore
::getDefaultInstance();
485 foreach ( $titles as $title ) {
486 if ( !$title instanceof Title
) {
487 $title = Title
::newFromText( $title );
490 if ( $title instanceof Title
) {
491 $store->removeWatch( $this->getUser(), $title->getSubjectPage() );
492 $store->removeWatch( $this->getUser(), $title->getTalkPage() );
494 $page = WikiPage
::factory( $title );
495 Hooks
::run( 'UnwatchArticleComplete', [ $this->getUser(), &$page ] );
500 public function submitNormal( $data ) {
503 foreach ( $data as $titles ) {
504 $this->unwatchTitles( $titles );
505 $removed = array_merge( $removed, $titles );
508 if ( count( $removed ) > 0 ) {
509 $this->successMessage
= $this->msg( 'watchlistedit-normal-done'
510 )->numParams( count( $removed ) )->parse();
511 $this->showTitles( $removed, $this->successMessage
);
520 * Get the standard watchlist editing form
524 protected function getNormalForm() {
530 // Allow subscribers to manipulate the list of watched pages (or use it
531 // to preload lots of details at once)
532 $watchlistInfo = $this->getWatchlistInfo();
534 'WatchlistEditorBeforeFormRender',
538 foreach ( $watchlistInfo as $namespace => $pages ) {
541 foreach ( array_keys( $pages ) as $dbkey ) {
542 $title = Title
::makeTitleSafe( $namespace, $dbkey );
544 if ( $this->checkTitle( $title, $namespace, $dbkey ) ) {
545 $text = $this->buildRemoveLine( $title );
546 $options[$text] = $title->getPrefixedText();
551 // checkTitle can filter some options out, avoid empty sections
552 if ( count( $options ) > 0 ) {
553 $fields['TitlesNs' . $namespace] = [
554 'class' => 'EditWatchlistCheckboxSeriesField',
555 'options' => $options,
556 'section' => "ns$namespace",
560 $this->cleanupWatchlist();
562 if ( count( $fields ) > 1 && $count > 30 ) {
563 $this->toc
= Linker
::tocIndent();
566 foreach ( $fields as $data ) {
567 # strip out the 'ns' prefix from the section name:
568 $ns = substr( $data['section'], 2 );
570 $nsText = ( $ns == NS_MAIN
)
571 ?
$this->msg( 'blanknamespace' )->escaped()
572 : htmlspecialchars( $wgContLang->getFormattedNsText( $ns ) );
573 $this->toc
.= Linker
::tocLine( "editwatchlist-{$data['section']}", $nsText,
574 $this->getLanguage()->formatNum( ++
$tocLength ), 1 ) . Linker
::tocLineEnd();
577 $this->toc
= Linker
::tocList( $this->toc
);
582 $context = new DerivativeContext( $this->getContext() );
583 $context->setTitle( $this->getPageTitle() ); // Remove subpage
584 $form = new EditWatchlistNormalHTMLForm( $fields, $context );
585 $form->setSubmitTextMsg( 'watchlistedit-normal-submit' );
586 $form->setSubmitDestructive();
588 # 'accesskey-watchlistedit-normal-submit', 'tooltip-watchlistedit-normal-submit'
589 $form->setSubmitTooltip( 'watchlistedit-normal-submit' );
590 $form->setWrapperLegendMsg( 'watchlistedit-normal-legend' );
591 $form->addHeaderText( $this->msg( 'watchlistedit-normal-explain' )->parse() );
592 $form->setSubmitCallback( [ $this, 'submitNormal' ] );
598 * Build the label for a checkbox, with a link to the title, and various additional bits
600 * @param Title $title
603 private function buildRemoveLine( $title ) {
604 $link = Linker
::link( $title );
606 $tools['talk'] = Linker
::link(
607 $title->getTalkPage(),
608 $this->msg( 'talkpagelinktext' )->escaped()
611 if ( $title->exists() ) {
612 $tools['history'] = Linker
::linkKnown(
614 $this->msg( 'history_short' )->escaped(),
616 [ 'action' => 'history' ]
620 if ( $title->getNamespace() == NS_USER
&& !$title->isSubpage() ) {
621 $tools['contributions'] = Linker
::linkKnown(
622 SpecialPage
::getTitleFor( 'Contributions', $title->getText() ),
623 $this->msg( 'contributions' )->escaped()
628 'WatchlistEditorBuildRemoveLine',
629 [ &$tools, $title, $title->isRedirect(), $this->getSkin(), &$link ]
632 if ( $title->isRedirect() ) {
633 // Linker already makes class mw-redirect, so this is redundant
634 $link = '<span class="watchlistredir">' . $link . '</span>';
638 $this->msg( 'parentheses' )->rawParams( $this->getLanguage()->pipeList( $tools ) )->escaped();
642 * Get a form for editing the watchlist in "raw" mode
646 protected function getRawForm() {
647 $titles = implode( $this->getWatchlist(), "\n" );
650 'type' => 'textarea',
651 'label-message' => 'watchlistedit-raw-titles',
652 'default' => $titles,
655 $context = new DerivativeContext( $this->getContext() );
656 $context->setTitle( $this->getPageTitle( 'raw' ) ); // Reset subpage
657 $form = new HTMLForm( $fields, $context );
658 $form->setSubmitTextMsg( 'watchlistedit-raw-submit' );
659 # Used message keys: 'accesskey-watchlistedit-raw-submit', 'tooltip-watchlistedit-raw-submit'
660 $form->setSubmitTooltip( 'watchlistedit-raw-submit' );
661 $form->setWrapperLegendMsg( 'watchlistedit-raw-legend' );
662 $form->addHeaderText( $this->msg( 'watchlistedit-raw-explain' )->parse() );
663 $form->setSubmitCallback( [ $this, 'submitRaw' ] );
669 * Get a form for clearing the watchlist
673 protected function getClearForm() {
674 $context = new DerivativeContext( $this->getContext() );
675 $context->setTitle( $this->getPageTitle( 'clear' ) ); // Reset subpage
676 $form = new HTMLForm( [], $context );
677 $form->setSubmitTextMsg( 'watchlistedit-clear-submit' );
678 # Used message keys: 'accesskey-watchlistedit-clear-submit', 'tooltip-watchlistedit-clear-submit'
679 $form->setSubmitTooltip( 'watchlistedit-clear-submit' );
680 $form->setWrapperLegendMsg( 'watchlistedit-clear-legend' );
681 $form->addHeaderText( $this->msg( 'watchlistedit-clear-explain' )->parse() );
682 $form->setSubmitCallback( [ $this, 'submitClear' ] );
683 $form->setSubmitDestructive();
689 * Determine whether we are editing the watchlist, and if so, what
690 * kind of editing operation
692 * @param WebRequest $request
696 public static function getMode( $request, $par ) {
697 $mode = strtolower( $request->getVal( 'action', $par ) );
701 case self
::EDIT_CLEAR
:
702 return self
::EDIT_CLEAR
;
705 return self
::EDIT_RAW
;
707 case self
::EDIT_NORMAL
:
708 return self
::EDIT_NORMAL
;
715 * Build a set of links for convenient navigation
716 * between watchlist viewing and editing modes
718 * @param null $unused
721 public static function buildTools( $unused ) {
726 'view' => [ 'Watchlist', false ],
727 'edit' => [ 'EditWatchlist', false ],
728 'raw' => [ 'EditWatchlist', 'raw' ],
729 'clear' => [ 'EditWatchlist', 'clear' ],
732 foreach ( $modes as $mode => $arr ) {
733 // can use messages 'watchlisttools-view', 'watchlisttools-edit', 'watchlisttools-raw'
734 $tools[] = Linker
::linkKnown(
735 SpecialPage
::getTitleFor( $arr[0], $arr[1] ),
736 wfMessage( "watchlisttools-{$mode}" )->escaped()
740 return Html
::rawElement(
742 [ 'class' => 'mw-watchlist-toollinks' ],
743 wfMessage( 'parentheses' )->rawParams( $wgLang->pipeList( $tools ) )->escaped()
749 * Extend HTMLForm purely so we can have a more sane way of getting the section headers
751 class EditWatchlistNormalHTMLForm
extends HTMLForm
{
752 public function getLegend( $namespace ) {
753 $namespace = substr( $namespace, 2 );
755 return $namespace == NS_MAIN
756 ?
$this->msg( 'blanknamespace' )->escaped()
757 : htmlspecialchars( $this->getContext()->getLanguage()->getFormattedNsText( $namespace ) );
760 public function getBody() {
761 return $this->displaySection( $this->mFieldTree
, '', 'editwatchlist-' );
765 class EditWatchlistCheckboxSeriesField
extends HTMLMultiSelectField
{
767 * HTMLMultiSelectField throws validation errors if we get input data
768 * that doesn't match the data set in the form setup. This causes
769 * problems if something gets removed from the watchlist while the
770 * form is open (bug 32126), but we know that invalid items will
771 * be harmless so we can override it here.
773 * @param string $value The value the field was submitted with
774 * @param array $alldata The data collected from the form
775 * @return bool|string Bool true on success, or String error to display.
777 function validate( $value, $alldata ) {
778 // Need to call into grandparent to be a good citizen. :)
779 return HTMLFormField
::validate( $value, $alldata );