Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
0.00% covered (danger)
0.00%
0 / 34
0.00% covered (danger)
0.00%
0 / 1
CRAP
0.00% covered (danger)
0.00%
0 / 1
PurgeJobUtils
0.00% covered (danger)
0.00%
0 / 34
0.00% covered (danger)
0.00%
0 / 1
30
0.00% covered (danger)
0.00%
0 / 1
 invalidatePages
0.00% covered (danger)
0.00%
0 / 34
0.00% covered (danger)
0.00%
0 / 1
30
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 */
20use MediaWiki\Deferred\AutoCommitUpdate;
21use MediaWiki\Deferred\DeferredUpdates;
22use MediaWiki\MainConfigNames;
23use MediaWiki\MediaWikiServices;
24use Wikimedia\Rdbms\IDatabase;
25
26/**
27 * Helper for a Job that writes data derived from page content to the database.
28 *
29 * Used by RefreshLinksJob via LinksUpdate.
30 *
31 * @ingroup JobQueue
32 */
33class PurgeJobUtils {
34    /**
35     * Invalidate the cache of a list of pages from a single namespace.
36     * This is intended for use by subclasses.
37     *
38     * @param IDatabase $dbw
39     * @param int $namespace Namespace number
40     * @param string[] $dbkeys
41     */
42    public static function invalidatePages( IDatabase $dbw, $namespace, array $dbkeys ) {
43        if ( $dbkeys === [] ) {
44            return;
45        }
46        $fname = __METHOD__;
47
48        DeferredUpdates::addUpdate( new AutoCommitUpdate(
49            $dbw,
50            __METHOD__,
51            static function () use ( $dbw, $namespace, $dbkeys, $fname ) {
52                $services = MediaWikiServices::getInstance();
53                $dbProvider = $services->getConnectionProvider();
54                // Determine which pages need to be updated.
55                // This is necessary to prevent the job queue from smashing the DB with
56                // large numbers of concurrent invalidations of the same page.
57                $now = $dbw->timestamp();
58                $ids = $dbw->newSelectQueryBuilder()
59                    ->select( 'page_id' )
60                    ->from( 'page' )
61                    ->where( [ 'page_namespace' => $namespace ] )
62                    ->andWhere( [ 'page_title' => $dbkeys ] )
63                    ->andWhere( $dbw->expr( 'page_touched', '<', $now ) )
64                    ->caller( $fname )->fetchFieldValues();
65
66                if ( !$ids ) {
67                    return;
68                }
69
70                $batchSize =
71                    $services->getMainConfig()->get( MainConfigNames::UpdateRowsPerQuery );
72                $ticket = $dbProvider->getEmptyTransactionTicket( $fname );
73                $idBatches = array_chunk( $ids, $batchSize );
74                foreach ( $idBatches as $idBatch ) {
75                    $dbw->newUpdateQueryBuilder()
76                        ->update( 'page' )
77                        ->set( [ 'page_touched' => $now ] )
78                        ->where( [ 'page_id' => $idBatch ] )
79                        ->andWhere( $dbw->expr( 'page_touched', '<', $now ) ) // handle races
80                        ->caller( $fname )->execute();
81                    if ( count( $idBatches ) > 1 ) {
82                        $dbProvider->commitAndWaitForReplication( $fname, $ticket );
83                    }
84                }
85            }
86        ) );
87    }
88}