2017-04-28 20:04:45 +00:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License along
|
|
|
|
* with this program; if not, write to the Free Software Foundation, Inc.,
|
|
|
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* http://www.gnu.org/copyleft/gpl.html
|
|
|
|
*
|
|
|
|
* @file
|
|
|
|
*/
|
|
|
|
|
|
|
|
namespace MediaWiki\Linter;
|
|
|
|
|
2024-04-02 21:12:24 +00:00
|
|
|
use MediaWiki\MediaWikiServices;
|
|
|
|
use MediaWiki\WikiMap\WikiMap;
|
2017-04-28 20:04:45 +00:00
|
|
|
use WANObjectCache;
|
|
|
|
use Wikimedia\Rdbms\Database as MWDatabase;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Lookup to find and cache the total amount of
|
|
|
|
* lint errors in each category
|
|
|
|
*/
|
|
|
|
class TotalsLookup {
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var WANObjectCache
|
|
|
|
*/
|
|
|
|
private $cache;
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @var CategoryManager
|
|
|
|
*/
|
|
|
|
private $catManager;
|
|
|
|
|
2024-04-02 21:12:24 +00:00
|
|
|
/**
|
|
|
|
* @var Database
|
|
|
|
*/
|
|
|
|
private $db;
|
|
|
|
|
2021-04-06 16:54:41 +00:00
|
|
|
/**
|
|
|
|
* @param CategoryManager $catManager
|
|
|
|
* @param WANObjectCache $cache
|
2024-04-02 21:12:24 +00:00
|
|
|
* @param Database $db
|
2021-04-06 16:54:41 +00:00
|
|
|
*/
|
2024-04-02 21:12:24 +00:00
|
|
|
public function __construct(
|
|
|
|
CategoryManager $catManager, WANObjectCache $cache, Database $db
|
|
|
|
) {
|
2017-04-28 20:04:45 +00:00
|
|
|
$this->cache = $cache;
|
|
|
|
$this->catManager = $catManager;
|
2024-04-02 21:12:24 +00:00
|
|
|
$this->db = $db;
|
2017-04-28 20:04:45 +00:00
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param string $cat
|
|
|
|
* @return string
|
|
|
|
*/
|
|
|
|
private function makeKey( $cat ) {
|
|
|
|
return $this->cache->makeKey( 'linter', 'total', $cat );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Get the totals for every category in the database
|
|
|
|
*
|
|
|
|
* @return array
|
|
|
|
*/
|
|
|
|
public function getTotals() {
|
|
|
|
$cats = $this->catManager->getVisibleCategories();
|
2024-04-02 21:12:24 +00:00
|
|
|
$db = $this->db;
|
2017-04-28 20:04:45 +00:00
|
|
|
$fetchedTotals = false;
|
|
|
|
$totals = [];
|
|
|
|
foreach ( $cats as $cat ) {
|
|
|
|
$totals[$cat] = $this->cache->getWithSetCallback(
|
|
|
|
$this->makeKey( $cat ),
|
|
|
|
WANObjectCache::TTL_INDEFINITE,
|
2024-04-02 21:12:24 +00:00
|
|
|
static function ( $oldValue, &$ttl, &$setOpts, $oldAsOf ) use ( $cat, $db, &$fetchedTotals ) {
|
2022-08-02 18:34:16 +00:00
|
|
|
$setOpts += MWDatabase::getCacheSetOptions(
|
|
|
|
Database::getDBConnectionRef( DB_REPLICA )
|
|
|
|
);
|
2017-04-28 20:04:45 +00:00
|
|
|
if ( $fetchedTotals === false ) {
|
2024-04-02 21:12:24 +00:00
|
|
|
$fetchedTotals = $db->getTotals();
|
2017-04-28 20:04:45 +00:00
|
|
|
}
|
|
|
|
return $fetchedTotals[$cat];
|
|
|
|
},
|
|
|
|
[
|
|
|
|
'checkKeys' => [
|
|
|
|
$this->cache->makeKey( 'linter', 'totals' ),
|
|
|
|
$this->makeKey( $cat ),
|
|
|
|
],
|
|
|
|
'lockTSE' => 30,
|
|
|
|
]
|
|
|
|
);
|
|
|
|
}
|
|
|
|
|
|
|
|
return $totals;
|
|
|
|
}
|
|
|
|
|
2024-04-02 21:12:24 +00:00
|
|
|
/**
|
|
|
|
* Send stats to statsd and update totals cache
|
|
|
|
*
|
|
|
|
* @param array $changes
|
|
|
|
*/
|
|
|
|
public function updateStats( array $changes ) {
|
|
|
|
$mwServices = MediaWikiServices::getInstance();
|
|
|
|
$linterStatsdSampleFactor = $mwServices->getMainConfig()->get( 'LinterStatsdSampleFactor' );
|
|
|
|
|
|
|
|
if ( $linterStatsdSampleFactor === false ) {
|
|
|
|
// Don't send to statsd, but update cache with $changes
|
|
|
|
$raw = $changes['added'];
|
|
|
|
foreach ( $changes['deleted'] as $cat => $count ) {
|
|
|
|
if ( isset( $raw[$cat] ) ) {
|
|
|
|
$raw[$cat] -= $count;
|
|
|
|
} else {
|
|
|
|
// Negative value
|
|
|
|
$raw[$cat] = 0 - $count;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
foreach ( $raw as $cat => $count ) {
|
|
|
|
if ( $count != 0 ) {
|
|
|
|
// There was a change in counts, invalidate the cache
|
|
|
|
$this->touchCategoryCache( $cat );
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return;
|
|
|
|
} elseif ( mt_rand( 1, $linterStatsdSampleFactor ) != 1 ) {
|
|
|
|
return;
|
|
|
|
}
|
|
|
|
|
|
|
|
$totals = $this->db->getTotals();
|
|
|
|
$wiki = WikiMap::getCurrentWikiId();
|
|
|
|
$stats = $mwServices->getStatsdDataFactory();
|
|
|
|
foreach ( $totals as $name => $count ) {
|
|
|
|
$stats->gauge( "linter.category.$name.$wiki", $count );
|
|
|
|
}
|
|
|
|
$stats->gauge( "linter.totals.$wiki", array_sum( $totals ) );
|
|
|
|
|
|
|
|
$this->touchAllCategoriesCache();
|
|
|
|
}
|
|
|
|
|
2017-04-28 20:04:45 +00:00
|
|
|
/**
|
|
|
|
* Have a single category be recalculated
|
|
|
|
*
|
|
|
|
* @param string $cat category name
|
|
|
|
*/
|
|
|
|
public function touchCategoryCache( $cat ) {
|
|
|
|
$this->cache->touchCheckKey( $this->makeKey( $cat ) );
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Have all categories be recalculated
|
|
|
|
*/
|
|
|
|
public function touchAllCategoriesCache() {
|
|
|
|
$this->cache->touchCheckKey( $this->cache->makeKey( 'linter', 'totals' ) );
|
|
|
|
}
|
|
|
|
}
|