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
24 * Static accessor class for site_stats and related things
27 static $row, $loaded = false;
29 static $pageCount = array();
30 static $groupMemberCounts = array();
32 static function recache() {
37 * @param $recache bool
39 static function load( $recache = false ) {
40 if ( self
::$loaded && !$recache ) {
44 self
::$row = self
::loadAndLazyInit();
46 # This code is somewhat schema-agnostic, because I'm changing it in a minor release -- TS
47 if ( !isset( self
::$row->ss_total_pages
) && self
::$row->ss_total_pages
== -1 ) {
49 $u = new SiteStatsUpdate( 0, 0, 0 );
51 $dbr = wfGetDB( DB_SLAVE
);
52 self
::$row = $dbr->selectRow( 'site_stats', '*', false, __METHOD__
);
59 * @return Bool|ResultWrapper
61 static function loadAndLazyInit() {
62 wfDebug( __METHOD__
. ": reading site_stats from slave\n" );
63 $row = self
::doLoad( wfGetDB( DB_SLAVE
) );
65 if( !self
::isSane( $row ) ) {
66 // Might have just been initialized during this request? Underflow?
67 wfDebug( __METHOD__
. ": site_stats damaged or missing on slave\n" );
68 $row = self
::doLoad( wfGetDB( DB_MASTER
) );
71 if( !self
::isSane( $row ) ) {
72 // Normally the site_stats table is initialized at install time.
73 // Some manual construction scenarios may leave the table empty or
74 // broken, however, for instance when importing from a dump into a
75 // clean schema with mwdumper.
76 wfDebug( __METHOD__
. ": initializing damaged or missing site_stats\n" );
78 SiteStatsInit
::doAllAndCommit( wfGetDB( DB_SLAVE
) );
80 $row = self
::doLoad( wfGetDB( DB_MASTER
) );
83 if( !self
::isSane( $row ) ) {
84 wfDebug( __METHOD__
. ": site_stats persistently nonsensical o_O\n" );
90 * @param $db DatabaseBase
91 * @return Bool|ResultWrapper
93 static function doLoad( $db ) {
94 return $db->selectRow( 'site_stats', '*', false, __METHOD__
);
100 static function views() {
102 return self
::$row->ss_total_views
;
108 static function edits() {
110 return self
::$row->ss_total_edits
;
116 static function articles() {
118 return self
::$row->ss_good_articles
;
124 static function pages() {
126 return self
::$row->ss_total_pages
;
132 static function users() {
134 return self
::$row->ss_users
;
140 static function activeUsers() {
142 return self
::$row->ss_active_users
;
148 static function images() {
150 return self
::$row->ss_images
;
154 * Find the number of users in a given user group.
155 * @param $group String: name of group
158 static function numberingroup( $group ) {
159 if ( !isset( self
::$groupMemberCounts[$group] ) ) {
161 $key = wfMemcKey( 'SiteStats', 'groupcounts', $group );
162 $hit = $wgMemc->get( $key );
164 $dbr = wfGetDB( DB_SLAVE
);
165 $hit = $dbr->selectField(
168 array( 'ug_group' => $group ),
171 $wgMemc->set( $key, $hit, 3600 );
173 self
::$groupMemberCounts[$group] = $hit;
175 return self
::$groupMemberCounts[$group];
181 static function jobs() {
182 if ( !isset( self
::$jobs ) ) {
183 $dbr = wfGetDB( DB_SLAVE
);
184 self
::$jobs = $dbr->estimateRowCount( 'job' );
185 /* Zero rows still do single row read for row that doesn't exist, but people are annoyed by that */
186 if ( self
::$jobs == 1 ) {
198 static function pagesInNs( $ns ) {
199 wfProfileIn( __METHOD__
);
200 if( !isset( self
::$pageCount[$ns] ) ) {
201 $dbr = wfGetDB( DB_SLAVE
);
202 self
::$pageCount[$ns] = (int)$dbr->selectField(
205 array( 'page_namespace' => $ns ),
209 wfProfileOut( __METHOD__
);
210 return self
::$pageCount[$ns];
214 * Is the provided row of site stats sane, or should it be regenerated?
220 private static function isSane( $row ) {
223 ||
$row->ss_total_pages
< $row->ss_good_articles
224 ||
$row->ss_total_edits
< $row->ss_total_pages
228 // Now check for underflow/overflow
229 foreach( array( 'total_views', 'total_edits', 'good_articles',
230 'total_pages', 'users', 'images' ) as $member ) {
232 $row->{"ss_$member"} > 2000000000
233 ||
$row->{"ss_$member"} < 0
243 * Class for handling updates to the site_stats table
245 class SiteStatsUpdate
implements DeferrableUpdate
{
246 protected $views = 0;
247 protected $edits = 0;
248 protected $pages = 0;
249 protected $articles = 0;
250 protected $users = 0;
251 protected $images = 0;
253 // @TODO: deprecate this constructor
254 function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) {
255 $this->views
= $views;
256 $this->edits
= $edits;
257 $this->articles
= $good;
258 $this->pages
= $pages;
259 $this->users
= $users;
263 * @param $deltas Array
264 * @return SiteStatsUpdate
266 public static function factory( array $deltas ) {
267 $update = new self( 0, 0, 0 );
269 $fields = array( 'views', 'edits', 'pages', 'articles', 'users', 'images' );
270 foreach ( $fields as $field ) {
271 if ( isset( $deltas[$field] ) && $deltas[$field] ) {
272 $update->$field = $deltas[$field];
279 public function doUpdate() {
280 global $wgSiteStatsAsyncFactor;
282 $rate = $wgSiteStatsAsyncFactor; // convenience
283 // If set to do so, only do actual DB updates 1 every $rate times.
284 // The other times, just update "pending delta" values in memcached.
285 if ( $rate && ( $rate < 0 ||
mt_rand( 0, $rate - 1 ) != 0 ) ) {
286 $this->doUpdatePendingDeltas();
288 $dbw = wfGetDB( DB_MASTER
);
289 // Need a separate transaction because this a global lock
290 $dbw->begin( __METHOD__
);
292 $lockKey = wfMemcKey( 'site_stats' ); // prepend wiki ID
294 // Lock the table so we don't have double DB/memcached updates
295 if ( !$dbw->lockIsFree( $lockKey, __METHOD__
)
296 ||
!$dbw->lock( $lockKey, __METHOD__
, 1 ) // 1 sec timeout
298 $this->doUpdatePendingDeltas();
301 $pd = $this->getPendingDeltas();
302 // Piggy-back the async deltas onto those of this stats update....
303 $this->views +
= ( $pd['ss_total_views']['+'] - $pd['ss_total_views']['-'] );
304 $this->edits +
= ( $pd['ss_total_edits']['+'] - $pd['ss_total_edits']['-'] );
305 $this->articles +
= ( $pd['ss_good_articles']['+'] - $pd['ss_good_articles']['-'] );
306 $this->pages +
= ( $pd['ss_total_pages']['+'] - $pd['ss_total_pages']['-'] );
307 $this->users +
= ( $pd['ss_users']['+'] - $pd['ss_users']['-'] );
308 $this->images +
= ( $pd['ss_images']['+'] - $pd['ss_images']['-'] );
311 // Build up an SQL query of deltas and apply them...
313 $this->appendUpdate( $updates, 'ss_total_views', $this->views
);
314 $this->appendUpdate( $updates, 'ss_total_edits', $this->edits
);
315 $this->appendUpdate( $updates, 'ss_good_articles', $this->articles
);
316 $this->appendUpdate( $updates, 'ss_total_pages', $this->pages
);
317 $this->appendUpdate( $updates, 'ss_users', $this->users
);
318 $this->appendUpdate( $updates, 'ss_images', $this->images
);
319 if ( $updates != '' ) {
320 $dbw->update( 'site_stats', array( $updates ), array(), __METHOD__
);
324 // Decrement the async deltas now that we applied them
325 $this->removePendingDeltas( $pd );
326 // Commit the updates and unlock the table
327 $dbw->unlock( $lockKey, __METHOD__
);
330 $dbw->commit( __METHOD__
);
335 * @param $dbw DatabaseBase
338 public static function cacheUpdate( $dbw ) {
339 global $wgActiveUserDays;
340 $dbr = wfGetDB( DB_SLAVE
, array( 'SpecialStatistics', 'vslow' ) );
341 # Get non-bot users than did some recent action other than making accounts.
342 # If account creation is included, the number gets inflated ~20+ fold on enwiki.
343 $activeUsers = $dbr->selectField(
345 'COUNT( DISTINCT rc_user_text )',
349 'rc_log_type != ' . $dbr->addQuotes( 'newusers' ) . ' OR rc_log_type IS NULL',
350 'rc_timestamp >= ' . $dbr->addQuotes( $dbr->timestamp( wfTimestamp( TS_UNIX
) - $wgActiveUserDays*24*3600 ) ),
356 array( 'ss_active_users' => intval( $activeUsers ) ),
357 array( 'ss_row_id' => 1 ),
363 protected function doUpdatePendingDeltas() {
364 $this->adjustPending( 'ss_total_views', $this->views
);
365 $this->adjustPending( 'ss_total_edits', $this->edits
);
366 $this->adjustPending( 'ss_good_articles', $this->articles
);
367 $this->adjustPending( 'ss_total_pages', $this->pages
);
368 $this->adjustPending( 'ss_users', $this->users
);
369 $this->adjustPending( 'ss_images', $this->images
);
374 * @param $field string
375 * @param $delta integer
377 protected function appendUpdate( &$sql, $field, $delta ) {
383 $sql .= "$field=$field-" . abs( $delta );
385 $sql .= "$field=$field+" . abs( $delta );
391 * @param $type string
392 * @param $sign string ('+' or '-')
395 private function getTypeCacheKey( $type, $sign ) {
396 return wfMemcKey( 'sitestatsupdate', 'pendingdelta', $type, $sign );
400 * Adjust the pending deltas for a stat type.
401 * Each stat type has two pending counters, one for increments and decrements
402 * @param $type string
403 * @param $delta integer Delta (positive or negative)
406 protected function adjustPending( $type, $delta ) {
409 if ( $delta < 0 ) { // decrement
410 $key = $this->getTypeCacheKey( $type, '-' );
411 } else { // increment
412 $key = $this->getTypeCacheKey( $type, '+' );
415 $magnitude = abs( $delta );
416 if ( !$wgMemc->incr( $key, $magnitude ) ) { // not there?
417 if ( !$wgMemc->add( $key, $magnitude ) ) { // race?
418 $wgMemc->incr( $key, $magnitude );
424 * Get pending delta counters for each stat type
425 * @return Array Positive and negative deltas for each type
428 protected function getPendingDeltas() {
432 foreach ( array( 'ss_total_views', 'ss_total_edits',
433 'ss_good_articles', 'ss_total_pages', 'ss_users', 'ss_images' ) as $type )
435 // Get pending increments and pending decrements
436 $pending[$type]['+'] = (int)$wgMemc->get( $this->getTypeCacheKey( $type, '+' ) );
437 $pending[$type]['-'] = (int)$wgMemc->get( $this->getTypeCacheKey( $type, '-' ) );
444 * Reduce pending delta counters after updates have been applied
445 * @param Array $pd Result of getPendingDeltas(), used for DB update
448 protected function removePendingDeltas( array $pd ) {
451 foreach ( $pd as $type => $deltas ) {
452 foreach ( $deltas as $sign => $magnitude ) {
453 // Lower the pending counter now that we applied these changes
454 $wgMemc->decr( $this->getTypeCacheKey( $type, $sign ), $magnitude );
461 * Class designed for counting of stats.
463 class SiteStatsInit
{
465 // Database connection
469 private $mEdits, $mArticles, $mPages, $mUsers, $mViews, $mFiles = 0;
473 * @param $database Boolean or DatabaseBase:
474 * - Boolean: whether to use the master DB
475 * - DatabaseBase: database connection to use
477 public function __construct( $database = false ) {
478 if ( $database instanceof DatabaseBase
) {
479 $this->db
= $database;
481 $this->db
= wfGetDB( $database ? DB_MASTER
: DB_SLAVE
);
486 * Count the total number of edits
489 public function edits() {
490 $this->mEdits
= $this->db
->selectField( 'revision', 'COUNT(*)', '', __METHOD__
);
491 $this->mEdits +
= $this->db
->selectField( 'archive', 'COUNT(*)', '', __METHOD__
);
492 return $this->mEdits
;
496 * Count pages in article space(s)
499 public function articles() {
500 global $wgArticleCountMethod;
502 $tables = array( 'page' );
504 'page_namespace' => MWNamespace
::getContentNamespaces(),
505 'page_is_redirect' => 0,
508 if ( $wgArticleCountMethod == 'link' ) {
509 $tables[] = 'pagelinks';
510 $conds[] = 'pl_from=page_id';
511 } elseif ( $wgArticleCountMethod == 'comma' ) {
512 // To make a correct check for this, we would need, for each page,
513 // to load the text, maybe uncompress it, maybe decode it and then
514 // check if there's one comma.
515 // But one thing we are sure is that if the page is empty, it can't
516 // contain a comma :)
517 $conds[] = 'page_len > 0';
520 $this->mArticles
= $this->db
->selectField( $tables, 'COUNT(DISTINCT page_id)',
521 $conds, __METHOD__
);
522 return $this->mArticles
;
529 public function pages() {
530 $this->mPages
= $this->db
->selectField( 'page', 'COUNT(*)', '', __METHOD__
);
531 return $this->mPages
;
538 public function users() {
539 $this->mUsers
= $this->db
->selectField( 'user', 'COUNT(*)', '', __METHOD__
);
540 return $this->mUsers
;
547 public function views() {
548 $this->mViews
= $this->db
->selectField( 'page', 'SUM(page_counter)', '', __METHOD__
);
549 return $this->mViews
;
556 public function files() {
557 $this->mFiles
= $this->db
->selectField( 'image', 'COUNT(*)', '', __METHOD__
);
558 return $this->mFiles
;
562 * Do all updates and commit them. More or less a replacement
563 * for the original initStats, but without output.
565 * @param $database DatabaseBase|bool
566 * - Boolean: whether to use the master DB
567 * - DatabaseBase: database connection to use
568 * @param $options Array of options, may contain the following values
569 * - update Boolean: whether to update the current stats (true) or write fresh (false) (default: false)
570 * - views Boolean: when true, do not update the number of page views (default: true)
571 * - activeUsers Boolean: whether to update the number of active users (default: false)
573 public static function doAllAndCommit( $database, array $options = array() ) {
574 $options +
= array( 'update' => false, 'views' => true, 'activeUsers' => false );
576 // Grab the object and count everything
577 $counter = new SiteStatsInit( $database );
580 $counter->articles();
585 // Only do views if we don't want to not count them
586 if( $options['views'] ) {
591 if( $options['update'] ) {
597 // Count active users if need be
598 if( $options['activeUsers'] ) {
599 SiteStatsUpdate
::cacheUpdate( wfGetDB( DB_MASTER
) );
604 * Update the current row with the selected values
606 public function update() {
607 list( $values, $conds ) = $this->getDbParams();
608 $dbw = wfGetDB( DB_MASTER
);
609 $dbw->update( 'site_stats', $values, $conds, __METHOD__
);
613 * Refresh site_stats. Erase the current record and save all
616 public function refresh() {
617 list( $values, $conds, $views ) = $this->getDbParams();
618 $dbw = wfGetDB( DB_MASTER
);
619 $dbw->delete( 'site_stats', $conds, __METHOD__
);
620 $dbw->insert( 'site_stats', array_merge( $values, $conds, $views ), __METHOD__
);
624 * Return three arrays of params for the db queries
627 private function getDbParams() {
629 'ss_total_edits' => $this->mEdits
,
630 'ss_good_articles' => $this->mArticles
,
631 'ss_total_pages' => $this->mPages
,
632 'ss_users' => $this->mUsers
,
633 'ss_images' => $this->mFiles
635 $conds = array( 'ss_row_id' => 1 );
636 $views = array( 'ss_total_views' => $this->mViews
);
637 return array( $values, $conds, $views );