includes/specials/SpecialWatchlist.php

   1 <?php
   2 /**
   3  * Implements Special:Watchlist
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  * @ingroup SpecialPage Watchlist
  22  */
  23 class SpecialWatchlist extends SpecialPage {
  24         protected $customFilters;
  25
  26         /**
  27          * Constructor
  28          */
  29         public function __construct( $page = 'Watchlist', $restriction = 'viewmywatchlist' ) {
  30                 parent::__construct( $page, $restriction );
  31         }
  32
  33         /**
  34          * Execute
  35          * @param $par Parameter passed to the page
  36          */
  37         function execute( $par ) {
  38                 global $wgRCShowWatchingUsers, $wgEnotifWatchlist, $wgShowUpdatedMarker;
  39
  40                 $user = $this->getUser();
  41                 $output = $this->getOutput();
  42
  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(),
  50                                 array(),
  51                                 array( 'returnto' => $this->getTitle()->getPrefixedText() )
  52                         );
  53                         $output->addHTML( $this->msg( 'watchlistanontext' )->rawParams( $llink )->parse() );
  54                         return;
  55                 }
  56
  57                 // Check permissions
  58                 $this->checkPermissions();
  59
  60                 // Add feed links
  61                 $wlToken = $user->getTokenFromOption( 'watchlisttoken' );
  62                 if ( $wlToken ) {
  63                         $this->addFeedLinks( array( 'action' => 'feedwatchlist', 'allrev' => 'allrev',
  64                                                                 'wlowner' => $user->getName(), 'wltoken' => $wlToken ) );
  65                 }
  66
  67                 $this->setHeaders();
  68                 $this->outputHeader();
  69
  70                 $output->addSubtitle( $this->msg( 'watchlistfor2', $user->getName()
  71                         )->rawParams( SpecialEditWatchlist::buildTools( null ) ) );
  72
  73                 $request = $this->getRequest();
  74
  75                 $mode = SpecialEditWatchlist::getMode( $request, $par );
  76                 if ( $mode !== false ) {
  77                         # TODO: localise?
  78                         switch ( $mode ) {
  79                                 case SpecialEditWatchlist::EDIT_CLEAR:
  80                                         $mode = 'clear';
  81                                         break;
  82                                 case SpecialEditWatchlist::EDIT_RAW:
  83                                         $mode = 'raw';
  84                                         break;
  85                                 default:
  86                                         $mode = null;
  87                         }
  88                         $title = SpecialPage::getTitleFor( 'EditWatchlist', $mode );
  89                         $output->redirect( $title->getLocalURL() );
  90                         return;
  91                 }
  92
  93                 $dbr = wfGetDB( DB_SLAVE, 'watchlist' );
  94
  95                 $nitems = $this->countItems( $dbr );
  96                 if ( $nitems == 0 ) {
  97                         $output->addWikiMsg( 'nowatchlist' );
  98                         return;
  99                 }
 100
 101                 // @todo use FormOptions!
 102                 $defaults = array(
 103                 /* float */ 'days' => floatval( $user->getOption( 'watchlistdays' ) ), /* 3.0 or 0.5, watch further below */
 104                 /* bool  */ 'hideMinor' => (int)$user->getBoolOption( 'watchlisthideminor' ),
 105                 /* bool  */ 'hideBots' => (int)$user->getBoolOption( 'watchlisthidebots' ),
 106                 /* bool  */ 'hideAnons' => (int)$user->getBoolOption( 'watchlisthideanons' ),
 107                 /* bool  */ 'hideLiu' => (int)$user->getBoolOption( 'watchlisthideliu' ),
 108                 /* bool  */ 'hidePatrolled' => (int)$user->getBoolOption( 'watchlisthidepatrolled' ),
 109                 /* bool  */ 'hideOwn' => (int)$user->getBoolOption( 'watchlisthideown' ),
 110                 /* bool  */ 'extended' => (int)$user->getBoolOption( 'extendwatchlist' ),
 111                 /* ?     */ 'namespace' => '', //means all
 112                 /* ?     */ 'invert' => false,
 113                 /* bool  */ 'associated' => false,
 114                 );
 115                 $this->customFilters = array();
 116                 wfRunHooks( 'SpecialWatchlistFilters', array( $this, &$this->customFilters ) );
 117                 foreach ( $this->customFilters as $key => $params ) {
 118                         $defaults[$key] = $params['default'];
 119                 }
 120
 121                 # Extract variables from the request, falling back to user preferences or
 122                 # other default values if these don't exist
 123                 $values = array();
 124                 $values['days'] = $request->getVal( 'days', $defaults['days'] );
 125                 $values['hideMinor'] = (int)$request->getBool( 'hideMinor', $defaults['hideMinor'] );
 126                 $values['hideBots'] = (int)$request->getBool( 'hideBots', $defaults['hideBots'] );
 127                 $values['hideAnons'] = (int)$request->getBool( 'hideAnons', $defaults['hideAnons'] );
 128                 $values['hideLiu'] = (int)$request->getBool( 'hideLiu', $defaults['hideLiu'] );
 129                 $values['hideOwn'] = (int)$request->getBool( 'hideOwn', $defaults['hideOwn'] );
 130                 $values['hidePatrolled'] = (int)$request->getBool( 'hidePatrolled', $defaults['hidePatrolled'] );
 131                 $values['extended'] = (int)$request->getBool( 'extended', $defaults['extended'] );
 132                 foreach ( $this->customFilters as $key => $params ) {
 133                         $values[$key] = (int)$request->getBool( $key, $defaults[$key] );
 134                 }
 135
 136                 # Get namespace value, if supplied, and prepare a WHERE fragment
 137                 $nameSpace = $request->getIntOrNull( 'namespace' );
 138                 $invert = $request->getBool( 'invert' );
 139                 $associated = $request->getBool( 'associated' );
 140                 if ( !is_null( $nameSpace ) ) {
 141                         $eq_op = $invert ? '!=' : '=';
 142                         $bool_op = $invert ? 'AND' : 'OR';
 143                         $nameSpace = intval( $nameSpace ); // paranioa
 144                         if ( !$associated ) {
 145                                 $nameSpaceClause = "rc_namespace $eq_op $nameSpace";
 146                         } else {
 147                                 $associatedNS = MWNamespace::getAssociated( $nameSpace );
 148                                 $nameSpaceClause =
 149                                         "rc_namespace $eq_op $nameSpace " .
 150                                         $bool_op .
 151                                         " rc_namespace $eq_op $associatedNS";
 152                         }
 153                 } else {
 154                         $nameSpace = '';
 155                         $nameSpaceClause = '';
 156                 }
 157                 $values['namespace'] = $nameSpace;
 158                 $values['invert'] = $invert;
 159                 $values['associated'] = $associated;
 160
 161                 if ( is_null( $values['days'] ) || !is_numeric( $values['days'] ) ) {
 162                         $big = 1000; /* The magical big */
 163                         if ( $nitems > $big ) {
 164                                 # Set default cutoff shorter
 165                                 $values['days'] = $defaults['days'] = ( 12.0 / 24.0 ); # 12 hours...
 166                         } else {
 167                                 $values['days'] = $defaults['days']; # default cutoff for shortlisters
 168                         }
 169                 } else {
 170                         $values['days'] = floatval( $values['days'] );
 171                 }
 172
 173                 // Dump everything here
 174                 $nondefaults = array();
 175                 foreach ( $defaults as $name => $defValue ) {
 176                         wfAppendToArrayIfNotDefault( $name, $values[$name], $defaults, $nondefaults );
 177                 }
 178
 179                 if ( ( $wgEnotifWatchlist || $wgShowUpdatedMarker ) && $request->getVal( 'reset' ) &&
 180                         $request->wasPosted() )
 181                 {
 182                         $user->clearAllNotifications();
 183                         $output->redirect( $this->getTitle()->getFullURL( $nondefaults ) );
 184                         return;
 185                 }
 186
 187                 # Possible where conditions
 188                 $conds = array();
 189
 190                 if ( $values['days'] > 0 ) {
 191                         $conds[] = 'rc_timestamp > ' . $dbr->addQuotes( $dbr->timestamp( time() - intval( $values['days'] * 86400 ) ) );
 192                 }
 193
 194                 # If the watchlist is relatively short, it's simplest to zip
 195                 # down its entirety and then sort the results.
 196
 197                 # If it's relatively long, it may be worth our while to zip
 198                 # through the time-sorted page list checking for watched items.
 199
 200                 # Up estimate of watched items by 15% to compensate for talk pages...
 201
 202                 # Toggles
 203                 if ( $values['hideOwn'] ) {
 204                         $conds[] = 'rc_user != ' . $user->getId();
 205                 }
 206                 if ( $values['hideBots'] ) {
 207                         $conds[] = 'rc_bot = 0';
 208                 }
 209                 if ( $values['hideMinor'] ) {
 210                         $conds[] = 'rc_minor = 0';
 211                 }
 212                 if ( $values['hideLiu'] ) {
 213                         $conds[] = 'rc_user = 0';
 214                 }
 215                 if ( $values['hideAnons'] ) {
 216                         $conds[] = 'rc_user != 0';
 217                 }
 218                 if ( $user->useRCPatrol() && $values['hidePatrolled'] ) {
 219                         $conds[] = 'rc_patrolled != 1';
 220                 }
 221                 if ( $nameSpaceClause ) {
 222                         $conds[] = $nameSpaceClause;
 223                 }
 224
 225                 # Toggle watchlist content (all recent edits or just the latest)
 226                 if ( $values['extended'] ) {
 227                         $limitWatchlist = $user->getIntOption( 'wllimit' );
 228                         $usePage = false;
 229                 } else {
 230                         # Top log Ids for a page are not stored
 231                         $conds[] = 'rc_this_oldid=page_latest OR rc_type=' . RC_LOG;
 232                         $limitWatchlist = 0;
 233                         $usePage = true;
 234                 }
 235
 236                 # Show a message about slave lag, if applicable
 237                 $lag = wfGetLB()->safeGetLag( $dbr );
 238                 if ( $lag > 0 ) {
 239                         $output->showLagWarning( $lag );
 240                 }
 241
 242                 # Create output
 243                 $form = '';
 244
 245                 # Show watchlist header
 246                 $form .= "<p>";
 247                 $form .= $this->msg( 'watchlist-details' )->numParams( $nitems )->parse() . "\n";
 248                 if ( $wgEnotifWatchlist && $user->getOption( 'enotifwatchlistpages' ) ) {
 249                         $form .= $this->msg( 'wlheader-enotif' )->parse() . "\n";
 250                 }
 251                 if ( $wgShowUpdatedMarker ) {
 252                         $form .= $this->msg( 'wlheader-showupdated' )->parse() . "\n";
 253                 }
 254                 $form .= "</p>";
 255
 256                 if ( $wgShowUpdatedMarker ) {
 257                         $form .= Xml::openElement( 'form', array( 'method' => 'post',
 258                                 'action' => $this->getTitle()->getLocalURL(),
 259                                 'id' => 'mw-watchlist-resetbutton' ) ) . "\n" .
 260                         Xml::submitButton( $this->msg( 'enotif_reset' )->text(), array( 'name' => 'dummy' ) ) . "\n" .
 261                         Html::hidden( 'reset', 'all' ) . "\n";
 262                         foreach ( $nondefaults as $key => $value ) {
 263                                 $form .= Html::hidden( $key, $value ) . "\n";
 264                         }
 265                         $form .= Xml::closeElement( 'form' ) . "\n";
 266                 }
 267
 268                 $form .= Xml::openElement( 'form', array(
 269                         'method' => 'post',
 270                         'action' => $this->getTitle()->getLocalURL(),
 271                         'id' => 'mw-watchlist-form'
 272                 ) );
 273                 $form .= Xml::fieldset(
 274                         $this->msg( 'watchlist-options' )->text(),
 275                         false,
 276                         array( 'id' => 'mw-watchlist-options' )
 277                 );
 278
 279                 $tables = array( 'recentchanges', 'watchlist' );
 280                 $fields = RecentChange::selectFields();
 281                 $join_conds = array(
 282                         'watchlist' => array(
 283                                 'INNER JOIN',
 284                                 array(
 285                                         'wl_user' => $user->getId(),
 286                                         'wl_namespace=rc_namespace',
 287                                         'wl_title=rc_title'
 288                                 ),
 289                         ),
 290                 );
 291                 $options = array( 'ORDER BY' => 'rc_timestamp DESC' );
 292                 if ( $wgShowUpdatedMarker ) {
 293                         $fields[] = 'wl_notificationtimestamp';
 294                 }
 295                 if ( $limitWatchlist ) {
 296                         $options['LIMIT'] = $limitWatchlist;
 297                 }
 298
 299                 $rollbacker = $user->isAllowed( 'rollback' );
 300                 if ( $usePage || $rollbacker ) {
 301                         $tables[] = 'page';
 302                         $join_conds['page'] = array( 'LEFT JOIN', 'rc_cur_id=page_id' );
 303                         if ( $rollbacker ) {
 304                                 $fields[] = 'page_latest';
 305                         }
 306                 }
 307
 308                 ChangeTags::modifyDisplayQuery( $tables, $fields, $conds, $join_conds, $options, '' );
 309                 wfRunHooks( 'SpecialWatchlistQuery', array( &$conds, &$tables, &$join_conds, &$fields, $values ) );
 310
 311                 $res = $dbr->select( $tables, $fields, $conds, __METHOD__, $options, $join_conds );
 312                 $numRows = $res->numRows();
 313
 314                 /* Start bottom header */
 315
 316                 $lang = $this->getLanguage();
 317                 $wlInfo = '';
 318                 if ( $values['days'] > 0 ) {
 319                         $timestamp = wfTimestampNow();
 320                         $wlInfo = $this->msg( 'wlnote' )->numParams( $numRows, round( $values['days'] * 24 ) )->params(
 321                                 $lang->userDate( $timestamp, $user ), $lang->userTime( $timestamp, $user ) )->parse() . "<br />\n";
 322                 }
 323
 324                 $cutofflinks = $this->cutoffLinks( $values['days'], $nondefaults ) . "<br />\n";
 325
 326                 # Spit out some control panel links
 327                 $filters = array(
 328                         'hideMinor' => 'rcshowhideminor',
 329                         'hideBots' => 'rcshowhidebots',
 330                         'hideAnons' => 'rcshowhideanons',
 331                         'hideLiu' => 'rcshowhideliu',
 332                         'hideOwn' => 'rcshowhidemine',
 333                         'hidePatrolled' => 'rcshowhidepatr'
 334                 );
 335                 foreach ( $this->customFilters as $key => $params ) {
 336                         $filters[$key] = $params['msg'];
 337                 }
 338                 // Disable some if needed
 339                 if ( !$user->useNPPatrol() ) {
 340                         unset( $filters['hidePatrolled'] );
 341                 }
 342
 343                 $links = array();
 344                 foreach ( $filters as $name => $msg ) {
 345                         $links[] = $this->showHideLink( $nondefaults, $msg, $name, $values[$name] );
 346                 }
 347
 348                 $hiddenFields = $nondefaults;
 349                 unset( $hiddenFields['namespace'] );
 350                 unset( $hiddenFields['invert'] );
 351                 unset( $hiddenFields['associated'] );
 352
 353                 # Namespace filter and put the whole form together.
 354                 $form .= $wlInfo;
 355                 $form .= $cutofflinks;
 356                 $form .= $lang->pipeList( $links ) . "\n";
 357                 $form .= "<hr />\n<p>";
 358                 $form .= Html::namespaceSelector(
 359                         array(
 360                                 'selected' => $nameSpace,
 361                                 'all' => '',
 362                                 'label' => $this->msg( 'namespace' )->text()
 363                         ), array(
 364                                 'name' => 'namespace',
 365                                 'id' => 'namespace',
 366                                 'class' => 'namespaceselector',
 367                         )
 368                 ) . '&#160;';
 369                 $form .= Xml::checkLabel(
 370                         $this->msg( 'invert' )->text(),
 371                         'invert',
 372                         'nsinvert',
 373                         $invert,
 374                         array( 'title' => $this->msg( 'tooltip-invert' )->text() )
 375                 ) . '&#160;';
 376                 $form .= Xml::checkLabel(
 377                         $this->msg( 'namespace_association' )->text(),
 378                         'associated',
 379                         'associated',
 380                         $associated,
 381                         array( 'title' => $this->msg( 'tooltip-namespace_association' )->text() )
 382                 ) . '&#160;';
 383                 $form .= Xml::submitButton( $this->msg( 'allpagessubmit' )->text() ) . "</p>\n";
 384                 foreach ( $hiddenFields as $key => $value ) {
 385                         $form .= Html::hidden( $key, $value ) . "\n";
 386                 }
 387                 $form .= Xml::closeElement( 'fieldset' ) . "\n";
 388                 $form .= Xml::closeElement( 'form' ) . "\n";
 389                 $output->addHTML( $form );
 390
 391                 # If there's nothing to show, stop here
 392                 if ( $numRows == 0 ) {
 393                         $output->wrapWikiMsg(
 394                                 "<div class='mw-changeslist-empty'>\n$1\n</div>", 'recentchanges-noresult'
 395                         );
 396                         return;
 397                 }
 398
 399                 /* End bottom header */
 400
 401                 /* Do link batch query */
 402                 $linkBatch = new LinkBatch;
 403                 foreach ( $res as $row ) {
 404                         $userNameUnderscored = str_replace( ' ', '_', $row->rc_user_text );
 405                         if ( $row->rc_user != 0 ) {
 406                                 $linkBatch->add( NS_USER, $userNameUnderscored );
 407                         }
 408                         $linkBatch->add( NS_USER_TALK, $userNameUnderscored );
 409
 410                         $linkBatch->add( $row->rc_namespace, $row->rc_title );
 411                 }
 412                 $linkBatch->execute();
 413                 $dbr->dataSeek( $res, 0 );
 414
 415                 $list = ChangesList::newFromContext( $this->getContext() );
 416                 $list->setWatchlistDivs();
 417
 418                 $s = $list->beginRecentChangesList();
 419                 $counter = 1;
 420                 foreach ( $res as $obj ) {
 421                         # Make RC entry
 422                         $rc = RecentChange::newFromRow( $obj );
 423                         $rc->counter = $counter++;
 424
 425                         if ( $wgShowUpdatedMarker ) {
 426                                 $updated = $obj->wl_notificationtimestamp;
 427                         } else {
 428                                 $updated = false;
 429                         }
 430
 431                         if ( $wgRCShowWatchingUsers && $user->getOption( 'shownumberswatching' ) ) {
 432                                 $rc->numberofWatchingusers = $dbr->selectField( 'watchlist',
 433                                         'COUNT(*)',
 434                                         array(
 435                                                 'wl_namespace' => $obj->rc_namespace,
 436                                                 'wl_title' => $obj->rc_title,
 437                                         ),
 438                                         __METHOD__ );
 439                         } else {
 440                                 $rc->numberofWatchingusers = 0;
 441                         }
 442
 443                         $changeLine = $list->recentChangesLine( $rc, $updated, $counter );
 444                         if ( $changeLine !== false ) {
 445                                 $s .= $changeLine;
 446                         }
 447                 }
 448                 $s .= $list->endRecentChangesList();
 449
 450                 $output->addHTML( $s );
 451         }
 452
 453         protected function showHideLink( $options, $message, $name, $value ) {
 454                 $label = $this->msg( $value ? 'show' : 'hide' )->escaped();
 455                 $options[$name] = 1 - (int) $value;
 456
 457                 return $this->msg( $message )->rawParams( Linker::linkKnown( $this->getTitle(), $label, array(), $options ) )->escaped();
 458         }
 459
 460         protected function hoursLink( $h, $options = array() ) {
 461                 $options['days'] = ( $h / 24.0 );
 462
 463                 return Linker::linkKnown(
 464                         $this->getTitle(),
 465                         $this->getLanguage()->formatNum( $h ),
 466                         array(),
 467                         $options
 468                 );
 469         }
 470
 471         protected function daysLink( $d, $options = array() ) {
 472                 $options['days'] = $d;
 473                 $message = ( $d ? $this->getLanguage()->formatNum( $d ) : $this->msg( 'watchlistall2' )->escaped() );
 474
 475                 return Linker::linkKnown(
 476                         $this->getTitle(),
 477                         $message,
 478                         array(),
 479                         $options
 480                 );
 481         }
 482
 483         /**
 484          * Returns html
 485          *
 486          * @param int $days This gets overwritten, so is not used
 487          * @param array $options Query parameters for URL
 488          * @return string
 489          */
 490         protected function cutoffLinks( $days, $options = array() ) {
 491                 $hours = array( 1, 2, 6, 12 );
 492                 $days = array( 1, 3, 7 );
 493                 $i = 0;
 494                 foreach ( $hours as $h ) {
 495                         $hours[$i++] = $this->hoursLink( $h, $options );
 496                 }
 497                 $i = 0;
 498                 foreach ( $days as $d ) {
 499                         $days[$i++] = $this->daysLink( $d, $options );
 500                 }
 501                 return $this->msg( 'wlshowlast' )->rawParams(
 502                         $this->getLanguage()->pipeList( $hours ),
 503                         $this->getLanguage()->pipeList( $days ),
 504                         $this->daysLink( 0, $options ) )->parse();
 505         }
 506
 507         /**
 508          * Count the number of items on a user's watchlist
 509          *
 510          * @param DatabaseBase $dbr A database connection
 511          * @return Integer
 512          */
 513         protected function countItems( $dbr ) {
 514                 # Fetch the raw count
 515                 $res = $dbr->select( 'watchlist', array( 'count' => 'COUNT(*)' ),
 516                         array( 'wl_user' => $this->getUser()->getId() ), __METHOD__ );
 517                 $row = $dbr->fetchObject( $res );
 518                 $count = $row->count;
 519
 520                 return floor( $count / 2 );
 521         }
 522
 523         protected function getGroupName() {
 524                 return 'changes';
 525         }
 526 }