3 * Accessors and mutators for the site-wide statistics.
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.
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.
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
23 use Wikimedia\Rdbms\Database
;
24 use Wikimedia\Rdbms\IDatabase
;
25 use MediaWiki\MediaWikiServices
;
28 * Static accessor class for site_stats and related things
31 /** @var bool|stdClass */
35 private static $loaded = false;
37 private static $pageCount = [];
39 static function unload() {
40 self
::$loaded = false;
43 static function recache() {
48 * @param bool $recache
50 static function load( $recache = false ) {
51 if ( self
::$loaded && !$recache ) {
55 self
::$row = self
::loadAndLazyInit();
61 * @return bool|stdClass
63 static function loadAndLazyInit() {
66 wfDebug( __METHOD__
. ": reading site_stats from replica DB\n" );
67 $row = self
::doLoad( wfGetDB( DB_REPLICA
) );
69 if ( !self
::isSane( $row ) ) {
70 $lb = MediaWikiServices
::getInstance()->getDBLoadBalancer();
71 if ( $lb->hasOrMadeRecentMasterChanges() ) {
72 // Might have just been initialized during this request? Underflow?
73 wfDebug( __METHOD__
. ": site_stats damaged or missing on replica DB\n" );
74 $row = self
::doLoad( wfGetDB( DB_MASTER
) );
78 if ( !self
::isSane( $row ) ) {
80 // Start off with all zeroes, assuming that this is a new wiki or any
81 // repopulations where done manually via script.
82 SiteStatsInit
::doPlaceholderInit();
84 // Normally the site_stats table is initialized at install time.
85 // Some manual construction scenarios may leave the table empty or
86 // broken, however, for instance when importing from a dump into a
87 // clean schema with mwdumper.
88 wfDebug( __METHOD__
. ": initializing damaged or missing site_stats\n" );
89 SiteStatsInit
::doAllAndCommit( wfGetDB( DB_REPLICA
) );
92 $row = self
::doLoad( wfGetDB( DB_MASTER
) );
95 if ( !self
::isSane( $row ) ) {
96 wfDebug( __METHOD__
. ": site_stats persistently nonsensical o_O\n" );
98 $row = (object)array_fill_keys( self
::selectFields(), 0 );
105 * @param IDatabase $db
106 * @return bool|stdClass
108 static function doLoad( $db ) {
109 return $db->selectRow( 'site_stats', self
::selectFields(), [], __METHOD__
);
113 * Return the total number of page views. Except we don't track those anymore.
114 * Stop calling this function, it will be removed some time in the future. It's
115 * kept here simply to prevent fatal errors.
117 * @deprecated since 1.25
120 static function views() {
121 wfDeprecated( __METHOD__
, '1.25' );
128 static function edits() {
130 return self
::$row->ss_total_edits
;
136 static function articles() {
138 return self
::$row->ss_good_articles
;
144 static function pages() {
146 return self
::$row->ss_total_pages
;
152 static function users() {
154 return self
::$row->ss_users
;
160 static function activeUsers() {
162 return self
::$row->ss_active_users
;
168 static function images() {
170 return self
::$row->ss_images
;
174 * Find the number of users in a given user group.
175 * @param string $group Name of group
178 static function numberingroup( $group ) {
179 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
180 return $cache->getWithSetCallback(
181 $cache->makeKey( 'SiteStats', 'groupcounts', $group ),
183 function ( $oldValue, &$ttl, array &$setOpts ) use ( $group ) {
184 $dbr = wfGetDB( DB_REPLICA
);
186 $setOpts +
= Database
::getCacheSetOptions( $dbr );
188 return $dbr->selectField(
192 'ug_group' => $group,
193 'ug_expiry IS NULL OR ug_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() )
198 [ 'pcTTL' => $cache::TTL_PROC_LONG
]
203 * Total number of jobs in the job queue.
206 static function jobs() {
207 $cache = MediaWikiServices
::getInstance()->getMainWANObjectCache();
208 return $cache->getWithSetCallback(
209 $cache->makeKey( 'SiteStats', 'jobscount' ),
211 function ( $oldValue, &$ttl, array &$setOpts ) {
213 $jobs = array_sum( JobQueueGroup
::singleton()->getQueueSizes() );
214 } catch ( JobQueueError
$e ) {
219 [ 'pcTTL' => $cache::TTL_PROC_LONG
]
228 static function pagesInNs( $ns ) {
229 if ( !isset( self
::$pageCount[$ns] ) ) {
230 $dbr = wfGetDB( DB_REPLICA
);
231 self
::$pageCount[$ns] = (int)$dbr->selectField(
234 [ 'page_namespace' => $ns ],
238 return self
::$pageCount[$ns];
244 public static function selectFields() {
257 * Is the provided row of site stats sane, or should it be regenerated?
259 * Checks only fields which are filled by SiteStatsInit::refresh.
261 * @param bool|object $row
265 private static function isSane( $row ) {
267 ||
$row->ss_total_pages
< $row->ss_good_articles
268 ||
$row->ss_total_edits
< $row->ss_total_pages
272 // Now check for underflow/overflow
280 if ( $row->$member > 2000000000 ||
$row->$member < 0 ) {
289 * Class designed for counting of stats.
291 class SiteStatsInit
{
293 // Database connection
297 private $mEdits = null, $mArticles = null, $mPages = null;
298 private $mUsers = null, $mFiles = null;
301 * @param bool|IDatabase $database
302 * - bool: Whether to use the master DB
303 * - IDatabase: Database connection to use
305 public function __construct( $database = false ) {
306 if ( $database instanceof IDatabase
) {
307 $this->db
= $database;
308 } elseif ( $database ) {
309 $this->db
= wfGetDB( DB_MASTER
);
311 $this->db
= wfGetDB( DB_REPLICA
, 'vslow' );
316 * Count the total number of edits
319 public function edits() {
320 $this->mEdits
= $this->db
->selectField( 'revision', 'COUNT(*)', '', __METHOD__
);
321 $this->mEdits +
= $this->db
->selectField( 'archive', 'COUNT(*)', '', __METHOD__
);
322 return $this->mEdits
;
326 * Count pages in article space(s)
329 public function articles() {
330 global $wgArticleCountMethod;
332 $tables = [ 'page' ];
334 'page_namespace' => MWNamespace
::getContentNamespaces(),
335 'page_is_redirect' => 0,
338 if ( $wgArticleCountMethod == 'link' ) {
339 $tables[] = 'pagelinks';
340 $conds[] = 'pl_from=page_id';
341 } elseif ( $wgArticleCountMethod == 'comma' ) {
342 // To make a correct check for this, we would need, for each page,
343 // to load the text, maybe uncompress it, maybe decode it and then
344 // check if there's one comma.
345 // But one thing we are sure is that if the page is empty, it can't
346 // contain a comma :)
347 $conds[] = 'page_len > 0';
350 $this->mArticles
= $this->db
->selectField( $tables, 'COUNT(DISTINCT page_id)',
351 $conds, __METHOD__
);
352 return $this->mArticles
;
359 public function pages() {
360 $this->mPages
= $this->db
->selectField( 'page', 'COUNT(*)', '', __METHOD__
);
361 return $this->mPages
;
368 public function users() {
369 $this->mUsers
= $this->db
->selectField( 'user', 'COUNT(*)', '', __METHOD__
);
370 return $this->mUsers
;
377 public function files() {
378 $this->mFiles
= $this->db
->selectField( 'image', 'COUNT(*)', '', __METHOD__
);
379 return $this->mFiles
;
383 * Do all updates and commit them. More or less a replacement
384 * for the original initStats, but without output.
386 * @param IDatabase|bool $database
387 * - bool: Whether to use the master DB
388 * - IDatabase: Database connection to use
389 * @param array $options Array of options, may contain the following values
390 * - activeUsers bool: Whether to update the number of active users (default: false)
392 public static function doAllAndCommit( $database, array $options = [] ) {
393 $options +
= [ 'update' => false, 'activeUsers' => false ];
395 // Grab the object and count everything
396 $counter = new SiteStatsInit( $database );
399 $counter->articles();
406 // Count active users if need be
407 if ( $options['activeUsers'] ) {
408 SiteStatsUpdate
::cacheUpdate( wfGetDB( DB_MASTER
) );
413 * Insert a dummy row with all zeroes if no row is present
415 public static function doPlaceholderInit() {
416 $dbw = wfGetDB( DB_MASTER
);
417 if ( $dbw->selectRow( 'site_stats', '1', [], __METHOD__
) === false ) {
420 array_fill_keys( SiteStats
::selectFields(), 0 ),
430 public function refresh() {
433 'ss_total_edits' => ( $this->mEdits
=== null ?
$this->edits() : $this->mEdits
),
434 'ss_good_articles' => ( $this->mArticles
=== null ?
$this->articles() : $this->mArticles
),
435 'ss_total_pages' => ( $this->mPages
=== null ?
$this->pages() : $this->mPages
),
436 'ss_users' => ( $this->mUsers
=== null ?
$this->users() : $this->mUsers
),
437 'ss_images' => ( $this->mFiles
=== null ?
$this->files() : $this->mFiles
),
440 $dbw = wfGetDB( DB_MASTER
);
441 $dbw->upsert( 'site_stats', $values, [ 'ss_row_id' ], $values, __METHOD__
);