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\IDatabase
;
26 * Static accessor class for site_stats and related things
29 /** @var bool|stdClass */
33 private static $loaded = false;
39 private static $pageCount = [];
41 static function unload() {
42 self
::$loaded = false;
45 static function recache() {
50 * @param bool $recache
52 static function load( $recache = false ) {
53 if ( self
::$loaded && !$recache ) {
57 self
::$row = self
::loadAndLazyInit();
59 # This code is somewhat schema-agnostic, because I'm changing it in a minor release -- TS
60 if ( !isset( self
::$row->ss_total_pages
) && self
::$row->ss_total_pages
== -1 ) {
62 $u = new SiteStatsUpdate( 0, 0, 0 );
64 self
::$row = self
::doLoad( wfGetDB( DB_REPLICA
) );
71 * @return bool|stdClass
73 static function loadAndLazyInit() {
76 wfDebug( __METHOD__
. ": reading site_stats from replica DB\n" );
77 $row = self
::doLoad( wfGetDB( DB_REPLICA
) );
79 if ( !self
::isSane( $row ) ) {
80 // Might have just been initialized during this request? Underflow?
81 wfDebug( __METHOD__
. ": site_stats damaged or missing on replica DB\n" );
82 $row = self
::doLoad( wfGetDB( DB_MASTER
) );
85 if ( !$wgMiserMode && !self
::isSane( $row ) ) {
86 // Normally the site_stats table is initialized at install time.
87 // Some manual construction scenarios may leave the table empty or
88 // broken, however, for instance when importing from a dump into a
89 // clean schema with mwdumper.
90 wfDebug( __METHOD__
. ": initializing damaged or missing site_stats\n" );
92 SiteStatsInit
::doAllAndCommit( wfGetDB( DB_REPLICA
) );
94 $row = self
::doLoad( wfGetDB( DB_MASTER
) );
97 if ( !self
::isSane( $row ) ) {
98 wfDebug( __METHOD__
. ": site_stats persistently nonsensical o_O\n" );
104 * @param IDatabase $db
105 * @return bool|stdClass
107 static function doLoad( $db ) {
108 return $db->selectRow( 'site_stats', [
120 * Return the total number of page views. Except we don't track those anymore.
121 * Stop calling this function, it will be removed some time in the future. It's
122 * kept here simply to prevent fatal errors.
124 * @deprecated since 1.25
127 static function views() {
128 wfDeprecated( __METHOD__
, '1.25' );
135 static function edits() {
137 return self
::$row->ss_total_edits
;
143 static function articles() {
145 return self
::$row->ss_good_articles
;
151 static function pages() {
153 return self
::$row->ss_total_pages
;
159 static function users() {
161 return self
::$row->ss_users
;
167 static function activeUsers() {
169 return self
::$row->ss_active_users
;
175 static function images() {
177 return self
::$row->ss_images
;
181 * Find the number of users in a given user group.
182 * @param string $group Name of group
185 static function numberingroup( $group ) {
186 $cache = ObjectCache
::getMainWANInstance();
187 return $cache->getWithSetCallback(
188 wfMemcKey( 'SiteStats', 'groupcounts', $group ),
190 function ( $oldValue, &$ttl, array &$setOpts ) use ( $group ) {
191 global $wgDisableUserGroupExpiry;
192 $dbr = wfGetDB( DB_REPLICA
);
194 $setOpts +
= Database
::getCacheSetOptions( $dbr );
196 return $dbr->selectField(
200 'ug_group' => $group,
201 $wgDisableUserGroupExpiry ?
203 'ug_expiry IS NULL OR ug_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() )
208 [ 'pcTTL' => $cache::TTL_PROC_LONG
]
215 static function jobs() {
216 if ( !isset( self
::$jobs ) ) {
218 self
::$jobs = array_sum( JobQueueGroup
::singleton()->getQueueSizes() );
219 } catch ( JobQueueError
$e ) {
223 * Zero rows still do single row read for row that doesn't exist,
224 * but people are annoyed by that
226 if ( self
::$jobs == 1 ) {
238 static function pagesInNs( $ns ) {
239 if ( !isset( self
::$pageCount[$ns] ) ) {
240 $dbr = wfGetDB( DB_REPLICA
);
241 self
::$pageCount[$ns] = (int)$dbr->selectField(
244 [ 'page_namespace' => $ns ],
248 return self
::$pageCount[$ns];
252 * Is the provided row of site stats sane, or should it be regenerated?
254 * Checks only fields which are filled by SiteStatsInit::refresh.
256 * @param bool|object $row
260 private static function isSane( $row ) {
262 ||
$row->ss_total_pages
< $row->ss_good_articles
263 ||
$row->ss_total_edits
< $row->ss_total_pages
267 // Now check for underflow/overflow
275 if ( $row->$member > 2000000000 ||
$row->$member < 0 ) {
284 * Class designed for counting of stats.
286 class SiteStatsInit
{
288 // Database connection
292 private $mEdits = null, $mArticles = null, $mPages = null;
293 private $mUsers = null, $mFiles = null;
297 * @param bool|IDatabase $database
298 * - boolean: Whether to use the master DB
299 * - IDatabase: Database connection to use
301 public function __construct( $database = false ) {
302 if ( $database instanceof IDatabase
) {
303 $this->db
= $database;
304 } elseif ( $database ) {
305 $this->db
= wfGetDB( DB_MASTER
);
307 $this->db
= wfGetDB( DB_REPLICA
, 'vslow' );
312 * Count the total number of edits
315 public function edits() {
316 $this->mEdits
= $this->db
->selectField( 'revision', 'COUNT(*)', '', __METHOD__
);
317 $this->mEdits +
= $this->db
->selectField( 'archive', 'COUNT(*)', '', __METHOD__
);
318 return $this->mEdits
;
322 * Count pages in article space(s)
325 public function articles() {
326 global $wgArticleCountMethod;
328 $tables = [ 'page' ];
330 'page_namespace' => MWNamespace
::getContentNamespaces(),
331 'page_is_redirect' => 0,
334 if ( $wgArticleCountMethod == 'link' ) {
335 $tables[] = 'pagelinks';
336 $conds[] = 'pl_from=page_id';
337 } elseif ( $wgArticleCountMethod == 'comma' ) {
338 // To make a correct check for this, we would need, for each page,
339 // to load the text, maybe uncompress it, maybe decode it and then
340 // check if there's one comma.
341 // But one thing we are sure is that if the page is empty, it can't
342 // contain a comma :)
343 $conds[] = 'page_len > 0';
346 $this->mArticles
= $this->db
->selectField( $tables, 'COUNT(DISTINCT page_id)',
347 $conds, __METHOD__
);
348 return $this->mArticles
;
355 public function pages() {
356 $this->mPages
= $this->db
->selectField( 'page', 'COUNT(*)', '', __METHOD__
);
357 return $this->mPages
;
364 public function users() {
365 $this->mUsers
= $this->db
->selectField( 'user', 'COUNT(*)', '', __METHOD__
);
366 return $this->mUsers
;
373 public function files() {
374 $this->mFiles
= $this->db
->selectField( 'image', 'COUNT(*)', '', __METHOD__
);
375 return $this->mFiles
;
379 * Do all updates and commit them. More or less a replacement
380 * for the original initStats, but without output.
382 * @param IDatabase|bool $database
383 * - boolean: Whether to use the master DB
384 * - IDatabase: Database connection to use
385 * @param array $options Array of options, may contain the following values
386 * - activeUsers boolean: Whether to update the number of active users (default: false)
388 public static function doAllAndCommit( $database, array $options = [] ) {
389 $options +
= [ 'update' => false, 'activeUsers' => false ];
391 // Grab the object and count everything
392 $counter = new SiteStatsInit( $database );
395 $counter->articles();
402 // Count active users if need be
403 if ( $options['activeUsers'] ) {
404 SiteStatsUpdate
::cacheUpdate( wfGetDB( DB_MASTER
) );
411 public function refresh() {
414 'ss_total_edits' => ( $this->mEdits
=== null ?
$this->edits() : $this->mEdits
),
415 'ss_good_articles' => ( $this->mArticles
=== null ?
$this->articles() : $this->mArticles
),
416 'ss_total_pages' => ( $this->mPages
=== null ?
$this->pages() : $this->mPages
),
417 'ss_users' => ( $this->mUsers
=== null ?
$this->users() : $this->mUsers
),
418 'ss_images' => ( $this->mFiles
=== null ?
$this->files() : $this->mFiles
),
421 $dbw = wfGetDB( DB_MASTER
);
422 $dbw->upsert( 'site_stats', $values, [ 'ss_row_id' ], $values, __METHOD__
);