includes/jobqueue/jobs/ClearWatchlistNotificationsJob.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  * @ingroup JobQueue
  20  */
  21
  22 use MediaWiki\MediaWikiServices;
  23
  24 /**
  25  * Job for clearing all of the "last viewed" timestamps for a user's watchlist
  26  *
  27  * Job parameters include:
  28  *   - userId: affected user ID [required]
  29  *   - casTime: UNIX timestamp of the event that triggered this job [required]
  30  *
  31  * @ingroup JobQueue
  32  * @since 1.31
  33  */
  34 class ClearWatchlistNotificationsJob extends Job {
  35         function __construct( Title $title, array $params ) {
  36                 parent::__construct( 'clearWatchlistNotifications', $title, $params );
  37
  38                 static $required = [ 'userId', 'casTime' ];
  39                 $missing = implode( ', ', array_diff( $required, array_keys( $this->params ) ) );
  40                 if ( $missing != '' ) {
  41                         throw new InvalidArgumentException( "Missing paramter(s) $missing" );
  42                 }
  43
  44                 $this->removeDuplicates = true;
  45         }
  46
  47         public function run() {
  48                 $services = MediaWikiServices::getInstance();
  49                 $lbFactory = $services->getDBLoadBalancerFactory();
  50                 $rowsPerQuery = $services->getMainConfig()->get( 'UpdateRowsPerQuery' );
  51
  52                 $dbw = $lbFactory->getMainLB()->getConnection( DB_MASTER );
  53                 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
  54
  55                 $asOfTimes = array_unique( $dbw->selectFieldValues(
  56                         'watchlist',
  57                         'wl_notificationtimestamp',
  58                         [ 'wl_user' => $this->params['userId'], 'wl_notificationtimestamp IS NOT NULL' ],
  59                         __METHOD__,
  60                         [ 'ORDER BY' => 'wl_notificationtimestamp DESC' ]
  61                 ) );
  62
  63                 foreach ( array_chunk( $asOfTimes, $rowsPerQuery ) as $asOfTimeBatch ) {
  64                         $dbw->update(
  65                                 'watchlist',
  66                                 [ 'wl_notificationtimestamp' => null ],
  67                                 [
  68                                         'wl_user' => $this->params['userId'],
  69                                         'wl_notificationtimestamp' => $asOfTimeBatch,
  70                                         // New notifications since the reset should not be cleared
  71                                         'wl_notificationtimestamp < ' .
  72                                                 $dbw->addQuotes( $dbw->timestamp( $this->params['casTime'] ) )
  73                                 ],
  74                                 __METHOD__
  75                         );
  76                         $lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
  77                 }
  78         }
  79 }