3 * Implements Special:Watchlist
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License as published by
7 * the Free Software Foundation; either version 2 of the License, or
8 * (at your option) any later version.
10 * This program is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License along
16 * with this program; if not, write to the Free Software Foundation, Inc.,
17 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18 * http://www.gnu.org/copyleft/gpl.html
21 * @ingroup SpecialPage
25 * A special page that lists last changes made to the wiki,
26 * limited to user-defined list of titles.
28 * @ingroup SpecialPage
30 class SpecialWatchlist
extends ChangesListSpecialPage
{
34 public function __construct( $page = 'Watchlist', $restriction = 'viewmywatchlist' ) {
35 parent
::__construct( $page, $restriction );
39 * Main execution point
41 * @param string $subpage
43 function execute( $subpage ) {
44 global $wgEnotifWatchlist, $wgShowUpdatedMarker;
46 // Anons don't get a watchlist
47 $this->requireLogin( 'watchlistanontext' );
49 $output = $this->getOutput();
50 $request = $this->getRequest();
52 $mode = SpecialEditWatchlist
::getMode( $request, $subpage );
53 if ( $mode !== false ) {
54 if ( $mode === SpecialEditWatchlist
::EDIT_RAW
) {
55 $title = SpecialPage
::getTitleFor( 'EditWatchlist', 'raw' );
57 $title = SpecialPage
::getTitleFor( 'EditWatchlist' );
60 $output->redirect( $title->getLocalURL() );
65 $this->checkPermissions();
67 $user = $this->getUser();
68 $opts = $this->getOptions();
70 if ( ( $wgEnotifWatchlist ||
$wgShowUpdatedMarker )
71 && $request->getVal( 'reset' )
72 && $request->wasPosted()
74 $user->clearAllNotifications();
75 $output->redirect( $this->getPageTitle()->getFullURL( $opts->getChangedValues() ) );
80 parent
::execute( $subpage );
84 * Get a FormOptions object containing the default options
88 public function getDefaultOptions() {
89 $opts = parent
::getDefaultOptions();
90 $user = $this->getUser();
92 $opts->add( 'days', $user->getOption( 'watchlistdays' ), FormOptions
::FLOAT );
94 $opts->add( 'hideminor', $user->getBoolOption( 'watchlisthideminor' ) );
95 $opts->add( 'hidebots', $user->getBoolOption( 'watchlisthidebots' ) );
96 $opts->add( 'hideanons', $user->getBoolOption( 'watchlisthideanons' ) );
97 $opts->add( 'hideliu', $user->getBoolOption( 'watchlisthideliu' ) );
98 $opts->add( 'hidepatrolled', $user->getBoolOption( 'watchlisthidepatrolled' ) );
99 $opts->add( 'hidemyself', $user->getBoolOption( 'watchlisthideown' ) );
101 $opts->add( 'extended', $user->getBoolOption( 'extendwatchlist' ) );
107 * Get custom show/hide filters
109 * @return array Map of filter URL param names to properties (msg/default)
111 protected function getCustomFilters() {
112 if ( $this->customFilters
=== null ) {
113 $this->customFilters
= array();
114 wfRunHooks( 'SpecialWatchlistFilters', array( $this, &$this->customFilters
) );
117 return $this->customFilters
;
121 * Fetch values for a FormOptions object from the WebRequest associated with this instance.
123 * Maps old pre-1.23 request parameters Watchlist used to use (different from Recentchanges' ones)
124 * to the current ones.
126 * @param FormOptions $parameters
127 * @return FormOptions
129 protected function fetchOptionsFromRequest( $opts ) {
130 static $compatibilityMap = array(
131 'hideMinor' => 'hideminor',
132 'hideBots' => 'hidebots',
133 'hideAnons' => 'hideanons',
134 'hideLiu' => 'hideliu',
135 'hidePatrolled' => 'hidepatrolled',
136 'hideOwn' => 'hidemyself',
139 $params = $this->getRequest()->getValues();
140 foreach ( $compatibilityMap as $from => $to ) {
141 if ( isset( $params[$from] ) ) {
142 $params[$to] = $params[$from];
143 unset( $params[$from] );
147 // Not the prettiest way to achieve this… FormOptions internally depends on data sanitization
148 // methods defined on WebRequest and removing this dependency would cause some code duplication.
149 $request = new DerivativeRequest( $this->getRequest(), $params );
150 $opts->fetchValuesFromRequest( $request );
156 * Return an array of conditions depending of options set in $opts
158 * @param FormOptions $opts
161 public function buildMainQueryConds( FormOptions
$opts ) {
162 $dbr = $this->getDB();
163 $conds = parent
::buildMainQueryConds( $opts );
166 if ( $opts['days'] > 0 ) {
167 $conds[] = 'rc_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( time() - intval( $opts['days'] * 86400 ) ) );
176 * @param array $conds
177 * @param FormOptions $opts
178 * @return bool|ResultWrapper Result or false (for Recentchangeslinked only)
180 public function doMainQuery( $conds, $opts ) {
181 global $wgShowUpdatedMarker;
183 $dbr = $this->getDB();
184 $user = $this->getUser();
186 # Toggle watchlist content (all recent edits or just the latest)
187 if ( $opts['extended'] ) {
188 $limitWatchlist = $user->getIntOption( 'wllimit' );
191 # Top log Ids for a page are not stored
192 $nonRevisionTypes = array( RC_LOG
);
193 wfRunHooks( 'SpecialWatchlistGetNonRevisionTypes', array( &$nonRevisionTypes ) );
194 if ( $nonRevisionTypes ) {
195 $conds[] = $dbr->makeList(
197 'rc_this_oldid=page_latest',
198 'rc_type' => $nonRevisionTypes,
207 $tables = array( 'recentchanges', 'watchlist' );
208 $fields = RecentChange
::selectFields();
209 $query_options = array( 'ORDER BY' => 'rc_timestamp DESC' );
211 'watchlist' => array(
214 'wl_user' => $user->getId(),
215 'wl_namespace=rc_namespace',
221 if ( $wgShowUpdatedMarker ) {
222 $fields[] = 'wl_notificationtimestamp';
224 if ( $limitWatchlist ) {
225 $query_options['LIMIT'] = $limitWatchlist;
228 $rollbacker = $user->isAllowed( 'rollback' );
229 if ( $usePage ||
$rollbacker ) {
231 $join_conds['page'] = array( 'LEFT JOIN', 'rc_cur_id=page_id' );
233 $fields[] = 'page_latest';
237 // Log entries with DELETED_ACTION must not show up unless the user has
238 // the necessary rights.
239 if ( !$user->isAllowed( 'deletedhistory' ) ) {
240 $bitmask = LogPage
::DELETED_ACTION
;
241 } elseif ( !$user->isAllowed( 'suppressrevision' ) ) {
242 $bitmask = LogPage
::DELETED_ACTION | LogPage
::DELETED_RESTRICTED
;
247 $conds[] = $dbr->makeList( array(
248 'rc_type != ' . RC_LOG
,
249 $dbr->bitAnd( 'rc_deleted', $bitmask ) . " != $bitmask",
253 ChangeTags
::modifyDisplayQuery(
262 wfRunHooks( 'SpecialWatchlistQuery',
263 array( &$conds, &$tables, &$join_conds, &$fields, $opts ) );
276 * Return a DatabaseBase object for reading
278 * @return DatabaseBase
280 protected function getDB() {
281 return wfGetDB( DB_SLAVE
, 'watchlist' );
287 public function outputFeedLinks() {
288 $user = $this->getUser();
289 $wlToken = $user->getTokenFromOption( 'watchlisttoken' );
291 $this->addFeedLinks( array(
292 'action' => 'feedwatchlist',
294 'wlowner' => $user->getName(),
295 'wltoken' => $wlToken,
301 * Build and output the actual changes list.
303 * @param ResultWrapper $rows Database rows
304 * @param FormOptions $opts
306 public function outputChangesList( $rows, $opts ) {
307 global $wgShowUpdatedMarker, $wgRCShowWatchingUsers;
309 $dbr = $this->getDB();
310 $user = $this->getUser();
311 $output = $this->getOutput();
313 # Show a message about slave lag, if applicable
314 $lag = wfGetLB()->safeGetLag( $dbr );
316 $output->showLagWarning( $lag );
319 $dbr->dataSeek( $rows, 0 );
321 $list = ChangesList
::newFromContext( $this->getContext() );
322 $list->setWatchlistDivs();
324 $s = $list->beginRecentChangesList();
326 foreach ( $rows as $obj ) {
328 $rc = RecentChange
::newFromRow( $obj );
329 $rc->counter
= $counter++
;
331 if ( $wgShowUpdatedMarker ) {
332 $updated = $obj->wl_notificationtimestamp
;
337 if ( $wgRCShowWatchingUsers && $user->getOption( 'shownumberswatching' ) ) {
338 $rc->numberofWatchingusers
= $dbr->selectField( 'watchlist',
341 'wl_namespace' => $obj->rc_namespace
,
342 'wl_title' => $obj->rc_title
,
346 $rc->numberofWatchingusers
= 0;
349 $changeLine = $list->recentChangesLine( $rc, $updated, $counter );
350 if ( $changeLine !== false ) {
354 $s .= $list->endRecentChangesList();
356 if ( $rows->numRows() == 0 ) {
357 $output->wrapWikiMsg(
358 "<div class='mw-changeslist-empty'>\n$1\n</div>", 'recentchanges-noresult'
361 $output->addHTML( $s );
366 * Return the text to be displayed above the changes
368 * @param FormOptions $opts
369 * @return string XHTML
371 public function doHeader( $opts ) {
372 $user = $this->getUser();
374 $this->getOutput()->addSubtitle(
375 $this->msg( 'watchlistfor2', $user->getName() )
376 ->rawParams( SpecialEditWatchlist
::buildTools( null ) )
379 $this->setTopText( $opts );
381 $lang = $this->getLanguage();
383 if ( $opts['days'] > 0 ) {
384 $timestamp = wfTimestampNow();
385 $wlInfo = $this->msg( 'wlnote2' )->numParams( round( $opts['days'] * 24 ) )->params(
386 $lang->userDate( $timestamp, $user ), $lang->userTime( $timestamp, $user )
387 )->parse() . "<br />\n";
390 $nondefaults = $opts->getChangedValues();
391 $cutofflinks = $this->cutoffLinks( $opts['days'], $nondefaults ) . "<br />\n";
393 # Spit out some control panel links
395 'hideminor' => 'rcshowhideminor',
396 'hidebots' => 'rcshowhidebots',
397 'hideanons' => 'rcshowhideanons',
398 'hideliu' => 'rcshowhideliu',
399 'hidemyself' => 'rcshowhidemine',
400 'hidepatrolled' => 'rcshowhidepatr'
402 foreach ( $this->getCustomFilters() as $key => $params ) {
403 $filters[$key] = $params['msg'];
405 // Disable some if needed
406 if ( !$user->useNPPatrol() ) {
407 unset( $filters['hidepatrolled'] );
411 foreach ( $filters as $name => $msg ) {
412 $links[] = $this->showHideLink( $nondefaults, $msg, $name, $opts[$name] );
415 $hiddenFields = $nondefaults;
416 unset( $hiddenFields['namespace'] );
417 unset( $hiddenFields['invert'] );
418 unset( $hiddenFields['associated'] );
423 # Namespace filter and put the whole form together.
425 $form .= $cutofflinks;
426 $form .= $lang->pipeList( $links ) . "\n";
427 $form .= "<hr />\n<p>";
428 $form .= Html
::namespaceSelector(
430 'selected' => $opts['namespace'],
432 'label' => $this->msg( 'namespace' )->text()
434 'name' => 'namespace',
436 'class' => 'namespaceselector',
439 $form .= Xml
::checkLabel(
440 $this->msg( 'invert' )->text(),
444 array( 'title' => $this->msg( 'tooltip-invert' )->text() )
446 $form .= Xml
::checkLabel(
447 $this->msg( 'namespace_association' )->text(),
451 array( 'title' => $this->msg( 'tooltip-namespace_association' )->text() )
453 $form .= Xml
::submitButton( $this->msg( 'allpagessubmit' )->text() ) . "</p>\n";
454 foreach ( $hiddenFields as $key => $value ) {
455 $form .= Html
::hidden( $key, $value ) . "\n";
457 $form .= Xml
::closeElement( 'fieldset' ) . "\n";
458 $form .= Xml
::closeElement( 'form' ) . "\n";
459 $this->getOutput()->addHTML( $form );
461 $this->setBottomText( $opts );
464 function setTopText( FormOptions
$opts ) {
465 global $wgEnotifWatchlist, $wgShowUpdatedMarker;
467 $nondefaults = $opts->getChangedValues();
469 $user = $this->getUser();
471 $dbr = $this->getDB();
472 $numItems = $this->countItems( $dbr );
474 // Show watchlist header
476 if ( $numItems == 0 ) {
477 $form .= $this->msg( 'nowatchlist' )->parse() . "\n";
479 $form .= $this->msg( 'watchlist-details' )->numParams( $numItems )->parse() . "\n";
480 if ( $wgEnotifWatchlist && $user->getOption( 'enotifwatchlistpages' ) ) {
481 $form .= $this->msg( 'wlheader-enotif' )->parse() . "\n";
483 if ( $wgShowUpdatedMarker ) {
484 $form .= $this->msg( 'wlheader-showupdated' )->parse() . "\n";
489 if ( $numItems > 0 && $wgShowUpdatedMarker ) {
490 $form .= Xml
::openElement( 'form', array( 'method' => 'post',
491 'action' => $this->getPageTitle()->getLocalURL(),
492 'id' => 'mw-watchlist-resetbutton' ) ) . "\n" .
493 Xml
::submitButton( $this->msg( 'enotif_reset' )->text(), array( 'name' => 'dummy' ) ) . "\n" .
494 Html
::hidden( 'reset', 'all' ) . "\n";
495 foreach ( $nondefaults as $key => $value ) {
496 $form .= Html
::hidden( $key, $value ) . "\n";
498 $form .= Xml
::closeElement( 'form' ) . "\n";
501 $form .= Xml
::openElement( 'form', array(
503 'action' => $this->getPageTitle()->getLocalURL(),
504 'id' => 'mw-watchlist-form'
506 $form .= Xml
::fieldset(
507 $this->msg( 'watchlist-options' )->text(),
509 array( 'id' => 'mw-watchlist-options' )
512 $form .= SpecialRecentChanges
::makeLegend( $this->getContext() );
514 $this->getOutput()->addHTML( $form );
517 protected function showHideLink( $options, $message, $name, $value ) {
518 $label = $this->msg( $value ?
'show' : 'hide' )->escaped();
519 $options[$name] = 1 - (int)$value;
521 return $this->msg( $message )->rawParams( Linker
::linkKnown( $this->getPageTitle(), $label, array(), $options ) )->escaped();
524 protected function hoursLink( $h, $options = array() ) {
525 $options['days'] = ( $h / 24.0 );
527 return Linker
::linkKnown(
528 $this->getPageTitle(),
529 $this->getLanguage()->formatNum( $h ),
535 protected function daysLink( $d, $options = array() ) {
536 $options['days'] = $d;
537 $message = ( $d ?
$this->getLanguage()->formatNum( $d ) : $this->msg( 'watchlistall2' )->escaped() );
539 return Linker
::linkKnown(
540 $this->getPageTitle(),
550 * @param int $days This gets overwritten, so is not used
551 * @param array $options Query parameters for URL
554 protected function cutoffLinks( $days, $options = array() ) {
555 $hours = array( 1, 2, 6, 12 );
556 $days = array( 1, 3, 7 );
558 foreach ( $hours as $h ) {
559 $hours[$i++
] = $this->hoursLink( $h, $options );
562 foreach ( $days as $d ) {
563 $days[$i++
] = $this->daysLink( $d, $options );
566 return $this->msg( 'wlshowlast' )->rawParams(
567 $this->getLanguage()->pipeList( $hours ),
568 $this->getLanguage()->pipeList( $days ),
569 $this->daysLink( 0, $options ) )->parse();
573 * Count the number of items on a user's watchlist
575 * @param DatabaseBase $dbr A database connection
578 protected function countItems( $dbr ) {
579 # Fetch the raw count
580 $rows = $dbr->select( 'watchlist', array( 'count' => 'COUNT(*)' ),
581 array( 'wl_user' => $this->getUser()->getId() ), __METHOD__
);
582 $row = $dbr->fetchObject( $rows );
583 $count = $row->count
;
585 return floor( $count / 2 );