includes/jobqueue/utils/PurgeJobUtils.php

   1 <?php
   2 /**
   3  * Base code for update jobs that put some secondary data extracted
   4  * from article content into the database.
   5  *
   6  * This program is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 2 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License along
  17  * with this program; if not, write to the Free Software Foundation, Inc.,
  18  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  19  * http://www.gnu.org/copyleft/gpl.html
  20  *
  21  * @file
  22  */
  23 use Wikimedia\Rdbms\IDatabase;
  24 use MediaWiki\MediaWikiServices;
  25
  26 class PurgeJobUtils {
  27         /**
  28          * Invalidate the cache of a list of pages from a single namespace.
  29          * This is intended for use by subclasses.
  30          *
  31          * @param IDatabase $dbw
  32          * @param int $namespace Namespace number
  33          * @param array $dbkeys
  34          */
  35         public static function invalidatePages( IDatabase $dbw, $namespace, array $dbkeys ) {
  36                 if ( $dbkeys === [] ) {
  37                         return;
  38                 }
  39
  40                 $dbw->onTransactionIdle(
  41                         function () use ( $dbw, $namespace, $dbkeys ) {
  42                                 $services = MediaWikiServices::getInstance();
  43                                 $lbFactory = $services->getDBLoadBalancerFactory();
  44                                 // Determine which pages need to be updated.
  45                                 // This is necessary to prevent the job queue from smashing the DB with
  46                                 // large numbers of concurrent invalidations of the same page.
  47                                 $now = $dbw->timestamp();
  48                                 $ids = $dbw->selectFieldValues(
  49                                         'page',
  50                                         'page_id',
  51                                         [
  52                                                 'page_namespace' => $namespace,
  53                                                 'page_title' => $dbkeys,
  54                                                 'page_touched < ' . $dbw->addQuotes( $now )
  55                                         ],
  56                                         __METHOD__
  57                                 );
  58
  59                                 if ( !$ids ) {
  60                                         return;
  61                                 }
  62
  63                                 $batchSize = $services->getMainConfig()->get( 'UpdateRowsPerQuery' );
  64                                 $ticket = $lbFactory->getEmptyTransactionTicket( __METHOD__ );
  65                                 foreach ( array_chunk( $ids, $batchSize ) as $idBatch ) {
  66                                         $dbw->update(
  67                                                 'page',
  68                                                 [ 'page_touched' => $now ],
  69                                                 [
  70                                                         'page_id' => $idBatch,
  71                                                         'page_touched < ' . $dbw->addQuotes( $now ) // handle races
  72                                                 ],
  73                                                 __METHOD__
  74                                         );
  75                                         $lbFactory->commitAndWaitForReplication( __METHOD__, $ticket );
  76                                 }
  77                         },
  78                         __METHOD__
  79                 );
  80         }
  81 }