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 Watchlist
23 class SpecialWatchlist
extends SpecialPage
{
24 protected $customFilters;
29 public function __construct( $page = 'Watchlist' ){
30 parent
::__construct( $page );
35 * @param $par Parameter passed to the page
37 function execute( $par ) {
38 global $wgRCShowWatchingUsers, $wgEnotifWatchlist, $wgShowUpdatedMarker;
40 $user = $this->getUser();
41 $output = $this->getOutput();
43 # Anons don't get a watchlist
44 if( $user->isAnon() ) {
45 $output->setPageTitle( $this->msg( 'watchnologin' ) );
46 $output->setRobotPolicy( 'noindex,nofollow' );
47 $llink = Linker
::linkKnown(
48 SpecialPage
::getTitleFor( 'Userlogin' ),
49 $this->msg( 'loginreqlink' )->escaped(),
51 array( 'returnto' => $this->getTitle()->getPrefixedText() )
53 $output->addHTML( $this->msg( 'watchlistanontext' )->rawParams( $llink )->parse() );
58 $wlToken = $user->getOption( 'watchlisttoken' );
60 $wlToken = MWCryptRand
::generateHex( 40 );
61 $user->setOption( 'watchlisttoken', $wlToken );
62 $user->saveSettings();
65 $this->addFeedLinks( array( 'action' => 'feedwatchlist', 'allrev' => 'allrev',
66 'wlowner' => $user->getName(), 'wltoken' => $wlToken ) );
69 $this->outputHeader();
71 $output->addSubtitle( $this->msg( 'watchlistfor2', $user->getName()
72 )->rawParams( SpecialEditWatchlist
::buildTools( null ) ) );
74 $request = $this->getRequest();
76 $mode = SpecialEditWatchlist
::getMode( $request, $par );
77 if( $mode !== false ) {
80 case SpecialEditWatchlist
::EDIT_CLEAR
:
83 case SpecialEditWatchlist
::EDIT_RAW
:
89 $title = SpecialPage
::getTitleFor( 'EditWatchlist', $mode );
90 $output->redirect( $title->getLocalUrl() );
94 $nitems = $this->countItems();
96 $output->addWikiMsg( 'nowatchlist' );
100 // @TODO: use FormOptions!
102 /* float */ 'days' => floatval( $user->getOption( 'watchlistdays' ) ), /* 3.0 or 0.5, watch further below */
103 /* bool */ 'hideMinor' => (int)$user->getBoolOption( 'watchlisthideminor' ),
104 /* bool */ 'hideBots' => (int)$user->getBoolOption( 'watchlisthidebots' ),
105 /* bool */ 'hideAnons' => (int)$user->getBoolOption( 'watchlisthideanons' ),
106 /* bool */ 'hideLiu' => (int)$user->getBoolOption( 'watchlisthideliu' ),
107 /* bool */ 'hidePatrolled' => (int)$user->getBoolOption( 'watchlisthidepatrolled' ),
108 /* bool */ 'hideOwn' => (int)$user->getBoolOption( 'watchlisthideown' ),
109 /* ? */ 'namespace' => 'all',
110 /* ? */ 'invert' => false,
111 /* bool */ 'associated' => false,
113 $this->customFilters
= array();
114 wfRunHooks( 'SpecialWatchlistFilters', array( $this, &$this->customFilters
) );
115 foreach( $this->customFilters
as $key => $params ) {
116 $defaults[$key] = $params['msg'];
119 # Extract variables from the request, falling back to user preferences or
120 # other default values if these don't exist
121 $prefs['days'] = floatval( $user->getOption( 'watchlistdays' ) );
122 $prefs['hideminor'] = $user->getBoolOption( 'watchlisthideminor' );
123 $prefs['hidebots'] = $user->getBoolOption( 'watchlisthidebots' );
124 $prefs['hideanons'] = $user->getBoolOption( 'watchlisthideanons' );
125 $prefs['hideliu'] = $user->getBoolOption( 'watchlisthideliu' );
126 $prefs['hideown' ] = $user->getBoolOption( 'watchlisthideown' );
127 $prefs['hidepatrolled' ] = $user->getBoolOption( 'watchlisthidepatrolled' );
129 # Get query variables
131 $values['days'] = $request->getVal( 'days', $prefs['days'] );
132 $values['hideMinor'] = (int)$request->getBool( 'hideMinor', $prefs['hideminor'] );
133 $values['hideBots'] = (int)$request->getBool( 'hideBots' , $prefs['hidebots'] );
134 $values['hideAnons'] = (int)$request->getBool( 'hideAnons', $prefs['hideanons'] );
135 $values['hideLiu'] = (int)$request->getBool( 'hideLiu' , $prefs['hideliu'] );
136 $values['hideOwn'] = (int)$request->getBool( 'hideOwn' , $prefs['hideown'] );
137 $values['hidePatrolled'] = (int)$request->getBool( 'hidePatrolled', $prefs['hidepatrolled'] );
138 foreach( $this->customFilters
as $key => $params ) {
139 $values[$key] = (int)$request->getBool( $key );
142 # Get namespace value, if supplied, and prepare a WHERE fragment
143 $nameSpace = $request->getIntOrNull( 'namespace' );
144 $invert = $request->getBool( 'invert' );
145 $associated = $request->getBool( 'associated' );
146 if ( !is_null( $nameSpace ) ) {
147 $eq_op = $invert ?
'!=' : '=';
148 $bool_op = $invert ?
'AND' : 'OR';
149 $nameSpace = intval( $nameSpace ); // paranioa
150 if ( !$associated ) {
151 $nameSpaceClause = "rc_namespace $eq_op $nameSpace";
153 $associatedNS = MWNamespace
::getAssociated( $nameSpace );
155 "rc_namespace $eq_op $nameSpace " .
157 " rc_namespace $eq_op $associatedNS";
161 $nameSpaceClause = '';
163 $values['namespace'] = $nameSpace;
164 $values['invert'] = $invert;
165 $values['associated'] = $associated;
167 if( is_null( $values['days'] ) ||
!is_numeric( $values['days'] ) ) {
168 $big = 1000; /* The magical big */
169 if( $nitems > $big ) {
170 # Set default cutoff shorter
171 $values['days'] = $defaults['days'] = (12.0 / 24.0); # 12 hours...
173 $values['days'] = $defaults['days']; # default cutoff for shortlisters
176 $values['days'] = floatval( $values['days'] );
179 // Dump everything here
180 $nondefaults = array();
181 foreach ( $defaults as $name => $defValue ) {
182 wfAppendToArrayIfNotDefault( $name, $values[$name], $defaults, $nondefaults );
185 if( ( $wgEnotifWatchlist ||
$wgShowUpdatedMarker ) && $request->getVal( 'reset' ) &&
186 $request->wasPosted() )
188 $user->clearAllNotifications();
189 $output->redirect( $this->getTitle()->getFullUrl( $nondefaults ) );
193 $dbr = wfGetDB( DB_SLAVE
, 'watchlist' );
195 # Possible where conditions
198 if( $values['days'] > 0 ) {
199 $conds[] = "rc_timestamp > '".$dbr->timestamp( time() - intval( $values['days'] * 86400 ) )."'";
202 # If the watchlist is relatively short, it's simplest to zip
203 # down its entirety and then sort the results.
205 # If it's relatively long, it may be worth our while to zip
206 # through the time-sorted page list checking for watched items.
208 # Up estimate of watched items by 15% to compensate for talk pages...
212 if( $values['hideOwn'] ) {
213 $conds[] = 'rc_user != ' . $user->getId();
215 if( $values['hideBots'] ) {
216 $conds[] = 'rc_bot = 0';
218 if( $values['hideMinor'] ) {
219 $conds[] = 'rc_minor = 0';
221 if( $values['hideLiu'] ) {
222 $conds[] = 'rc_user = 0';
224 if( $values['hideAnons'] ) {
225 $conds[] = 'rc_user != 0';
227 if ( $user->useRCPatrol() && $values['hidePatrolled'] ) {
228 $conds[] = 'rc_patrolled != 1';
230 if ( $nameSpaceClause ) {
231 $conds[] = $nameSpaceClause;
234 # Toggle watchlist content (all recent edits or just the latest)
235 if( $user->getOption( 'extendwatchlist' ) ) {
236 $limitWatchlist = intval( $user->getOption( 'wllimit' ) );
239 # Top log Ids for a page are not stored
240 $conds[] = 'rc_this_oldid=page_latest OR rc_type=' . RC_LOG
;
245 # Show a message about slave lag, if applicable
246 $lag = wfGetLB()->safeGetLag( $dbr );
248 $output->showLagWarning( $lag );
252 $form = Xml
::fieldset( $this->msg( 'watchlist-options' )->text(), false, array( 'id' => 'mw-watchlist-options' ) );
254 # Show watchlist header
255 $form .= $this->msg( 'watchlist-details' )->numParams( $nitems )->parse();
257 if( $user->getOption( 'enotifwatchlistpages' ) && $wgEnotifWatchlist) {
258 $form .= $this->msg( 'wlheader-enotif' )->parseAsBlock() . "\n";
260 if( $wgShowUpdatedMarker ) {
261 $form .= Xml
::openElement( 'form', array( 'method' => 'post',
262 'action' => $this->getTitle()->getLocalUrl(),
263 'id' => 'mw-watchlist-resetbutton' ) ) .
264 $this->msg( 'wlheader-showupdated' )->parse() . ' ' .
265 Xml
::submitButton( $this->msg( 'enotif_reset' )->text(), array( 'name' => 'dummy' ) ) .
266 Html
::hidden( 'reset', 'all' );
267 foreach ( $nondefaults as $key => $value ) {
268 $form .= Html
::hidden( $key, $value );
270 $form .= Xml
::closeElement( 'form' );
274 $tables = array( 'recentchanges', 'watchlist' );
275 $fields = array( $dbr->tableName( 'recentchanges' ) . '.*' );
277 'watchlist' => array(
280 'wl_user' => $user->getId(),
281 'wl_namespace=rc_namespace',
286 $options = array( 'ORDER BY' => 'rc_timestamp DESC' );
287 if( $wgShowUpdatedMarker ) {
288 $fields[] = 'wl_notificationtimestamp';
290 if( $limitWatchlist ) {
291 $options['LIMIT'] = $limitWatchlist;
294 $rollbacker = $user->isAllowed('rollback');
295 if ( $usePage ||
$rollbacker ) {
297 $join_conds['page'] = array('LEFT JOIN','rc_cur_id=page_id');
299 $fields[] = 'page_latest';
303 ChangeTags
::modifyDisplayQuery( $tables, $fields, $conds, $join_conds, $options, '' );
304 wfRunHooks('SpecialWatchlistQuery', array(&$conds,&$tables,&$join_conds,&$fields) );
306 $res = $dbr->select( $tables, $fields, $conds, __METHOD__
, $options, $join_conds );
307 $numRows = $res->numRows();
309 /* Start bottom header */
311 $lang = $this->getLanguage();
313 if( $values['days'] > 0 ) {
314 $timestamp = wfTimestampNow();
315 $wlInfo = $this->msg( 'wlnote' )->numParams( $numRows, round( $values['days'] * 24 ) )->params(
316 $lang->userDate( $timestamp, $user ), $lang->userTime( $timestamp, $user ) )->parse() . '<br />';
319 $cutofflinks = "\n" . $this->cutoffLinks( $values['days'], $nondefaults ) . "<br />\n";
321 # Spit out some control panel links
323 'hideMinor' => 'rcshowhideminor',
324 'hideBots' => 'rcshowhidebots',
325 'hideAnons' => 'rcshowhideanons',
326 'hideLiu' => 'rcshowhideliu',
327 'hideOwn' => 'rcshowhidemine',
328 'hidePatrolled' => 'rcshowhidepatr'
330 foreach ( $this->customFilters
as $key => $params ) {
331 $filters[$key] = $params['msg'];
333 // Disable some if needed
334 if ( !$user->useNPPatrol() ) {
335 unset( $filters['hidePatrolled'] );
339 foreach( $filters as $name => $msg ) {
340 $links[] = $this->showHideLink( $nondefaults, $msg, $name, $values[$name] );
343 # Namespace filter and put the whole form together.
345 $form .= $cutofflinks;
346 $form .= $lang->pipeList( $links );
347 $form .= Xml
::openElement( 'form', array( 'method' => 'post', 'action' => $this->getTitle()->getLocalUrl(), 'id' => 'mw-watchlist-form-namespaceselector' ) );
348 $form .= '<hr /><p>';
349 $form .= Html
::namespaceSelector(
351 'selected' => $nameSpace,
353 'label' => $this->msg( 'namespace' )->text()
355 'name' => 'namespace',
357 'class' => 'namespaceselector',
360 $form .= Xml
::checkLabel(
361 $this->msg( 'invert' )->text(),
365 array( 'title' => $this->msg( 'tooltip-invert' )->text() )
367 $form .= Xml
::checkLabel(
368 $this->msg( 'namespace_association' )->text(),
372 array( 'title' => $this->msg( 'tooltip-namespace_association' )->text() )
374 $form .= Xml
::submitButton( $this->msg( 'allpagessubmit' )->text() ) . '</p>';
375 $form .= Html
::hidden( 'days', $values['days'] );
376 foreach ( $filters as $key => $msg ) {
377 if ( $values[$key] ) {
378 $form .= Html
::hidden( $key, 1 );
381 $form .= Xml
::closeElement( 'form' );
382 $form .= Xml
::closeElement( 'fieldset' );
383 $output->addHTML( $form );
385 # If there's nothing to show, stop here
386 if( $numRows == 0 ) {
387 $output->addWikiMsg( 'watchnochange' );
391 /* End bottom header */
393 /* Do link batch query */
394 $linkBatch = new LinkBatch
;
395 foreach ( $res as $row ) {
396 $userNameUnderscored = str_replace( ' ', '_', $row->rc_user_text
);
397 if ( $row->rc_user
!= 0 ) {
398 $linkBatch->add( NS_USER
, $userNameUnderscored );
400 $linkBatch->add( NS_USER_TALK
, $userNameUnderscored );
402 $linkBatch->add( $row->rc_namespace
, $row->rc_title
);
404 $linkBatch->execute();
405 $dbr->dataSeek( $res, 0 );
407 $list = ChangesList
::newFromContext( $this->getContext() );
408 $list->setWatchlistDivs();
410 $s = $list->beginRecentChangesList();
412 foreach ( $res as $obj ) {
414 $rc = RecentChange
::newFromRow( $obj );
415 $rc->counter
= $counter++
;
417 if ( $wgShowUpdatedMarker ) {
418 $updated = $obj->wl_notificationtimestamp
;
423 if ( $wgRCShowWatchingUsers && $user->getOption( 'shownumberswatching' ) ) {
424 $rc->numberofWatchingusers
= $dbr->selectField( 'watchlist',
427 'wl_namespace' => $obj->rc_namespace
,
428 'wl_title' => $obj->rc_title
,
432 $rc->numberofWatchingusers
= 0;
435 $s .= $list->recentChangesLine( $rc, $updated, $counter );
437 $s .= $list->endRecentChangesList();
439 $output->addHTML( $s );
442 protected function showHideLink( $options, $message, $name, $value ) {
443 $label = $this->msg( $value ?
'show' : 'hide' )->escaped();
444 $options[$name] = 1 - (int) $value;
446 return $this->msg( $message )->rawParams( Linker
::linkKnown( $this->getTitle(), $label, array(), $options ) )->escaped();
449 protected function hoursLink( $h, $options = array() ) {
450 $options['days'] = ( $h / 24.0 );
452 return Linker
::linkKnown(
454 $this->getLanguage()->formatNum( $h ),
460 protected function daysLink( $d, $options = array() ) {
461 $options['days'] = $d;
462 $message = ( $d ?
$this->getLanguage()->formatNum( $d ) : $this->msg( 'watchlistall2' )->escaped() );
464 return Linker
::linkKnown(
477 protected function cutoffLinks( $days, $options = array() ) {
478 $hours = array( 1, 2, 6, 12 );
479 $days = array( 1, 3, 7 );
481 foreach( $hours as $h ) {
482 $hours[$i++
] = $this->hoursLink( $h, $options );
485 foreach( $days as $d ) {
486 $days[$i++
] = $this->daysLink( $d, $options );
488 return $this->msg( 'wlshowlast' )->rawParams(
489 $this->getLanguage()->pipeList( $hours ),
490 $this->getLanguage()->pipeList( $days ),
491 $this->daysLink( 0, $options ) )->parse();
495 * Count the number of items on a user's watchlist
499 protected function countItems() {
500 $dbr = wfGetDB( DB_SLAVE
, 'watchlist' );
502 # Fetch the raw count
503 $res = $dbr->select( 'watchlist', 'COUNT(*) AS count',
504 array( 'wl_user' => $this->getUser()->getId() ), __METHOD__
);
505 $row = $dbr->fetchObject( $res );
506 $count = $row->count
;
508 return floor( $count / 2 );