summaryrefslogtreecommitdiff
path: root/includes/SiteStats.php
diff options
context:
space:
mode:
Diffstat (limited to 'includes/SiteStats.php')
-rw-r--r--includes/SiteStats.php340
1 files changed, 53 insertions, 287 deletions
diff --git a/includes/SiteStats.php b/includes/SiteStats.php
index 355993c6..3dc17933 100644
--- a/includes/SiteStats.php
+++ b/includes/SiteStats.php
@@ -24,17 +24,27 @@
* Static accessor class for site_stats and related things
*/
class SiteStats {
- static $row, $loaded = false;
- static $jobs;
- static $pageCount = array();
- static $groupMemberCounts = array();
+ /** @var bool|ResultWrapper */
+ private static $row;
+
+ /** @var bool */
+ private static $loaded = false;
+
+ /** @var int */
+ private static $jobs;
+
+ /** @var int[] */
+ private static $pageCount = array();
+
+ /** @var int[] */
+ private static $groupMemberCounts = array();
static function recache() {
self::load( true );
}
/**
- * @param $recache bool
+ * @param bool $recache
*/
static function load( $recache = false ) {
if ( self::$loaded && !$recache ) {
@@ -55,7 +65,7 @@ class SiteStats {
}
/**
- * @return Bool|ResultWrapper
+ * @return bool|ResultWrapper
*/
static function loadAndLazyInit() {
wfDebug( __METHOD__ . ": reading site_stats from slave\n" );
@@ -86,8 +96,8 @@ class SiteStats {
}
/**
- * @param $db DatabaseBase
- * @return Bool|ResultWrapper
+ * @param DatabaseBase $db
+ * @return bool|ResultWrapper
*/
static function doLoad( $db ) {
return $db->selectRow( 'site_stats', array(
@@ -160,8 +170,8 @@ class SiteStats {
/**
* Find the number of users in a given user group.
- * @param string $group name of group
- * @return Integer
+ * @param string $group Name of group
+ * @return int
*/
static function numberingroup( $group ) {
if ( !isset( self::$groupMemberCounts[$group] ) ) {
@@ -190,7 +200,10 @@ class SiteStats {
if ( !isset( self::$jobs ) ) {
$dbr = wfGetDB( DB_SLAVE );
self::$jobs = array_sum( JobQueueGroup::singleton()->getQueueSizes() );
- /* Zero rows still do single row read for row that doesn't exist, but people are annoyed by that */
+ /**
+ * Zero rows still do single row read for row that doesn't exist,
+ * but people are annoyed by that
+ */
if ( self::$jobs == 1 ) {
self::$jobs = 0;
}
@@ -199,7 +212,7 @@ class SiteStats {
}
/**
- * @param $ns int
+ * @param int $ns
*
* @return int
*/
@@ -221,7 +234,9 @@ class SiteStats {
/**
* Is the provided row of site stats sane, or should it be regenerated?
*
- * @param $row
+ * Checks only fields which are filled by SiteStatsInit::refresh.
+ *
+ * @param bool|object $row
*
* @return bool
*/
@@ -229,7 +244,6 @@ class SiteStats {
if ( $row === false
|| $row->ss_total_pages < $row->ss_good_articles
|| $row->ss_total_edits < $row->ss_total_pages
- || $row->ss_users < $row->ss_active_users
) {
return false;
}
@@ -240,7 +254,6 @@ class SiteStats {
'ss_good_articles',
'ss_total_pages',
'ss_users',
- 'ss_active_users',
'ss_images',
) as $member ) {
if ( $row->$member > 2000000000 || $row->$member < 0 ) {
@@ -252,231 +265,6 @@ class SiteStats {
}
/**
- * Class for handling updates to the site_stats table
- */
-class SiteStatsUpdate implements DeferrableUpdate {
- protected $views = 0;
- protected $edits = 0;
- protected $pages = 0;
- protected $articles = 0;
- protected $users = 0;
- protected $images = 0;
-
- // @todo deprecate this constructor
- function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) {
- $this->views = $views;
- $this->edits = $edits;
- $this->articles = $good;
- $this->pages = $pages;
- $this->users = $users;
- }
-
- /**
- * @param $deltas Array
- * @return SiteStatsUpdate
- */
- public static function factory( array $deltas ) {
- $update = new self( 0, 0, 0 );
-
- $fields = array( 'views', 'edits', 'pages', 'articles', 'users', 'images' );
- foreach ( $fields as $field ) {
- if ( isset( $deltas[$field] ) && $deltas[$field] ) {
- $update->$field = $deltas[$field];
- }
- }
-
- return $update;
- }
-
- public function doUpdate() {
- global $wgSiteStatsAsyncFactor;
-
- $rate = $wgSiteStatsAsyncFactor; // convenience
- // If set to do so, only do actual DB updates 1 every $rate times.
- // The other times, just update "pending delta" values in memcached.
- if ( $rate && ( $rate < 0 || mt_rand( 0, $rate - 1 ) != 0 ) ) {
- $this->doUpdatePendingDeltas();
- } else {
- // Need a separate transaction because this a global lock
- wfGetDB( DB_MASTER )->onTransactionIdle( array( $this, 'tryDBUpdateInternal' ) );
- }
- }
-
- /**
- * Do not call this outside of SiteStatsUpdate
- *
- * @return void
- */
- public function tryDBUpdateInternal() {
- global $wgSiteStatsAsyncFactor;
-
- $dbw = wfGetDB( DB_MASTER );
- $lockKey = wfMemcKey( 'site_stats' ); // prepend wiki ID
- if ( $wgSiteStatsAsyncFactor ) {
- // Lock the table so we don't have double DB/memcached updates
- if ( !$dbw->lockIsFree( $lockKey, __METHOD__ )
- || !$dbw->lock( $lockKey, __METHOD__, 1 ) // 1 sec timeout
- ) {
- $this->doUpdatePendingDeltas();
- return;
- }
- $pd = $this->getPendingDeltas();
- // Piggy-back the async deltas onto those of this stats update....
- $this->views += ( $pd['ss_total_views']['+'] - $pd['ss_total_views']['-'] );
- $this->edits += ( $pd['ss_total_edits']['+'] - $pd['ss_total_edits']['-'] );
- $this->articles += ( $pd['ss_good_articles']['+'] - $pd['ss_good_articles']['-'] );
- $this->pages += ( $pd['ss_total_pages']['+'] - $pd['ss_total_pages']['-'] );
- $this->users += ( $pd['ss_users']['+'] - $pd['ss_users']['-'] );
- $this->images += ( $pd['ss_images']['+'] - $pd['ss_images']['-'] );
- }
-
- // Build up an SQL query of deltas and apply them...
- $updates = '';
- $this->appendUpdate( $updates, 'ss_total_views', $this->views );
- $this->appendUpdate( $updates, 'ss_total_edits', $this->edits );
- $this->appendUpdate( $updates, 'ss_good_articles', $this->articles );
- $this->appendUpdate( $updates, 'ss_total_pages', $this->pages );
- $this->appendUpdate( $updates, 'ss_users', $this->users );
- $this->appendUpdate( $updates, 'ss_images', $this->images );
- if ( $updates != '' ) {
- $dbw->update( 'site_stats', array( $updates ), array(), __METHOD__ );
- }
-
- if ( $wgSiteStatsAsyncFactor ) {
- // Decrement the async deltas now that we applied them
- $this->removePendingDeltas( $pd );
- // Commit the updates and unlock the table
- $dbw->unlock( $lockKey, __METHOD__ );
- }
- }
-
- /**
- * @param $dbw DatabaseBase
- * @return bool|mixed
- */
- public static function cacheUpdate( $dbw ) {
- global $wgActiveUserDays;
- $dbr = wfGetDB( DB_SLAVE, array( 'SpecialStatistics', 'vslow' ) );
- # Get non-bot users than did some recent action other than making accounts.
- # If account creation is included, the number gets inflated ~20+ fold on enwiki.
- $activeUsers = $dbr->selectField(
- 'recentchanges',
- 'COUNT( DISTINCT rc_user_text )',
- array(
- 'rc_user != 0',
- 'rc_bot' => 0,
- 'rc_log_type != ' . $dbr->addQuotes( 'newusers' ) . ' OR rc_log_type IS NULL',
- 'rc_timestamp >= ' . $dbr->addQuotes( $dbr->timestamp( wfTimestamp( TS_UNIX ) - $wgActiveUserDays * 24 * 3600 ) ),
- ),
- __METHOD__
- );
- $dbw->update(
- 'site_stats',
- array( 'ss_active_users' => intval( $activeUsers ) ),
- array( 'ss_row_id' => 1 ),
- __METHOD__
- );
- return $activeUsers;
- }
-
- protected function doUpdatePendingDeltas() {
- $this->adjustPending( 'ss_total_views', $this->views );
- $this->adjustPending( 'ss_total_edits', $this->edits );
- $this->adjustPending( 'ss_good_articles', $this->articles );
- $this->adjustPending( 'ss_total_pages', $this->pages );
- $this->adjustPending( 'ss_users', $this->users );
- $this->adjustPending( 'ss_images', $this->images );
- }
-
- /**
- * @param $sql string
- * @param $field string
- * @param $delta integer
- */
- protected function appendUpdate( &$sql, $field, $delta ) {
- if ( $delta ) {
- if ( $sql ) {
- $sql .= ',';
- }
- if ( $delta < 0 ) {
- $sql .= "$field=$field-" . abs( $delta );
- } else {
- $sql .= "$field=$field+" . abs( $delta );
- }
- }
- }
-
- /**
- * @param $type string
- * @param string $sign ('+' or '-')
- * @return string
- */
- private function getTypeCacheKey( $type, $sign ) {
- return wfMemcKey( 'sitestatsupdate', 'pendingdelta', $type, $sign );
- }
-
- /**
- * Adjust the pending deltas for a stat type.
- * Each stat type has two pending counters, one for increments and decrements
- * @param $type string
- * @param $delta integer Delta (positive or negative)
- * @return void
- */
- protected function adjustPending( $type, $delta ) {
- global $wgMemc;
-
- if ( $delta < 0 ) { // decrement
- $key = $this->getTypeCacheKey( $type, '-' );
- } else { // increment
- $key = $this->getTypeCacheKey( $type, '+' );
- }
-
- $magnitude = abs( $delta );
- if ( !$wgMemc->incr( $key, $magnitude ) ) { // not there?
- if ( !$wgMemc->add( $key, $magnitude ) ) { // race?
- $wgMemc->incr( $key, $magnitude );
- }
- }
- }
-
- /**
- * Get pending delta counters for each stat type
- * @return Array Positive and negative deltas for each type
- * @return void
- */
- protected function getPendingDeltas() {
- global $wgMemc;
-
- $pending = array();
- foreach ( array( 'ss_total_views', 'ss_total_edits',
- 'ss_good_articles', 'ss_total_pages', 'ss_users', 'ss_images' ) as $type )
- {
- // Get pending increments and pending decrements
- $pending[$type]['+'] = (int)$wgMemc->get( $this->getTypeCacheKey( $type, '+' ) );
- $pending[$type]['-'] = (int)$wgMemc->get( $this->getTypeCacheKey( $type, '-' ) );
- }
-
- return $pending;
- }
-
- /**
- * Reduce pending delta counters after updates have been applied
- * @param array $pd Result of getPendingDeltas(), used for DB update
- * @return void
- */
- protected function removePendingDeltas( array $pd ) {
- global $wgMemc;
-
- foreach ( $pd as $type => $deltas ) {
- foreach ( $deltas as $sign => $magnitude ) {
- // Lower the pending counter now that we applied these changes
- $wgMemc->decr( $this->getTypeCacheKey( $type, $sign ), $magnitude );
- }
- }
- }
-}
-
-/**
* Class designed for counting of stats.
*/
class SiteStatsInit {
@@ -485,11 +273,12 @@ class SiteStatsInit {
private $db;
// Various stats
- private $mEdits, $mArticles, $mPages, $mUsers, $mViews, $mFiles = 0;
+ private $mEdits = null, $mArticles = null, $mPages = null;
+ private $mUsers = null, $mViews = null, $mFiles = null;
/**
* Constructor
- * @param $database Boolean or DatabaseBase:
+ * @param bool|DatabaseBase $database
* - Boolean: whether to use the master DB
* - DatabaseBase: database connection to use
*/
@@ -503,7 +292,7 @@ class SiteStatsInit {
/**
* Count the total number of edits
- * @return Integer
+ * @return int
*/
public function edits() {
$this->mEdits = $this->db->selectField( 'revision', 'COUNT(*)', '', __METHOD__ );
@@ -513,7 +302,7 @@ class SiteStatsInit {
/**
* Count pages in article space(s)
- * @return Integer
+ * @return int
*/
public function articles() {
global $wgArticleCountMethod;
@@ -543,7 +332,7 @@ class SiteStatsInit {
/**
* Count total pages
- * @return Integer
+ * @return int
*/
public function pages() {
$this->mPages = $this->db->selectField( 'page', 'COUNT(*)', '', __METHOD__ );
@@ -552,7 +341,7 @@ class SiteStatsInit {
/**
* Count total users
- * @return Integer
+ * @return int
*/
public function users() {
$this->mUsers = $this->db->selectField( 'user', 'COUNT(*)', '', __METHOD__ );
@@ -561,7 +350,7 @@ class SiteStatsInit {
/**
* Count views
- * @return Integer
+ * @return int
*/
public function views() {
$this->mViews = $this->db->selectField( 'page', 'SUM(page_counter)', '', __METHOD__ );
@@ -570,7 +359,7 @@ class SiteStatsInit {
/**
* Count total files
- * @return Integer
+ * @return int
*/
public function files() {
$this->mFiles = $this->db->selectField( 'image', 'COUNT(*)', '', __METHOD__ );
@@ -581,11 +370,10 @@ class SiteStatsInit {
* Do all updates and commit them. More or less a replacement
* for the original initStats, but without output.
*
- * @param $database DatabaseBase|bool
+ * @param DatabaseBase|bool $database
* - Boolean: whether to use the master DB
* - DatabaseBase: database connection to use
- * @param array $options of options, may contain the following values
- * - update Boolean: whether to update the current stats (true) or write fresh (false) (default: false)
+ * @param array $options Array of options, may contain the following values
* - views Boolean: when true, do not update the number of page views (default: true)
* - activeUsers Boolean: whether to update the number of active users (default: false)
*/
@@ -606,12 +394,7 @@ class SiteStatsInit {
$counter->views();
}
- // Update/refresh
- if ( $options['update'] ) {
- $counter->update();
- } else {
- $counter->refresh();
- }
+ $counter->refresh();
// Count active users if need be
if ( $options['activeUsers'] ) {
@@ -620,39 +403,22 @@ class SiteStatsInit {
}
/**
- * Update the current row with the selected values
- */
- public function update() {
- list( $values, $conds ) = $this->getDbParams();
- $dbw = wfGetDB( DB_MASTER );
- $dbw->update( 'site_stats', $values, $conds, __METHOD__ );
- }
-
- /**
- * Refresh site_stats. Erase the current record and save all
- * the new values.
+ * Refresh site_stats. If you want ss_total_views to be updated, be sure to
+ * call views() first.
*/
public function refresh() {
- list( $values, $conds, $views ) = $this->getDbParams();
- $dbw = wfGetDB( DB_MASTER );
- $dbw->delete( 'site_stats', $conds, __METHOD__ );
- $dbw->insert( 'site_stats', array_merge( $values, $conds, $views ), __METHOD__ );
- }
-
- /**
- * Return three arrays of params for the db queries
- * @return Array
- */
- private function getDbParams() {
$values = array(
- 'ss_total_edits' => $this->mEdits,
- 'ss_good_articles' => $this->mArticles,
- 'ss_total_pages' => $this->mPages,
- 'ss_users' => $this->mUsers,
- 'ss_images' => $this->mFiles
+ 'ss_row_id' => 1,
+ 'ss_total_edits' => ( $this->mEdits === null ? $this->edits() : $this->mEdits ),
+ 'ss_good_articles' => ( $this->mArticles === null ? $this->articles() : $this->mArticles ),
+ 'ss_total_pages' => ( $this->mPages === null ? $this->pages() : $this->mPages ),
+ 'ss_users' => ( $this->mUsers === null ? $this->users() : $this->mUsers ),
+ 'ss_images' => ( $this->mFiles === null ? $this->files() : $this->mFiles ),
+ ) + (
+ $this->mViews ? array( 'ss_total_views' => $this->mViews ) : array()
);
- $conds = array( 'ss_row_id' => 1 );
- $views = array( 'ss_total_views' => $this->mViews );
- return array( $values, $conds, $views );
+
+ $dbw = wfGetDB( DB_MASTER );
+ $dbw->upsert( 'site_stats', $values, array( 'ss_row_id' ), $values, __METHOD__ );
}
}