includes/deferred/SiteStatsUpdate.php

   1 <?php
   2 /**
   3  * This program is free software; you can redistribute it and/or modify
   4  * it under the terms of the GNU General Public License as published by
   5  * the Free Software Foundation; either version 2 of the License, or
   6  * (at your option) any later version.
   7  *
   8  * This program is distributed in the hope that it will be useful,
   9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  11  * GNU General Public License for more details.
  12  *
  13  * You should have received a copy of the GNU General Public License along
  14  * with this program; if not, write to the Free Software Foundation, Inc.,
  15  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
  16  * http://www.gnu.org/copyleft/gpl.html
  17  *
  18  * @file
  19  */
  20 use MediaWiki\MediaWikiServices;
  21 use Wikimedia\Assert\Assert;
  22 use Wikimedia\Rdbms\IDatabase;
  23
  24 /**
  25  * Class for handling updates to the site_stats table
  26  */
  27 class SiteStatsUpdate implements DeferrableUpdate, MergeableUpdate {
  28         /** @var BagOStuff */
  29         protected $stash;
  30         /** @var int */
  31         protected $edits = 0;
  32         /** @var int */
  33         protected $pages = 0;
  34         /** @var int */
  35         protected $articles = 0;
  36         /** @var int */
  37         protected $users = 0;
  38         /** @var int */
  39         protected $images = 0;
  40
  41         private static $counters = [ 'edits', 'pages', 'articles', 'users', 'images' ];
  42
  43         // @todo deprecate this constructor
  44         function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) {
  45                 $this->edits = $edits;
  46                 $this->articles = $good;
  47                 $this->pages = $pages;
  48                 $this->users = $users;
  49
  50                 $this->stash = MediaWikiServices::getInstance()->getMainObjectStash();
  51         }
  52
  53         public function merge( MergeableUpdate $update ) {
  54                 /** @var SiteStatsUpdate $update */
  55                 Assert::parameterType( __CLASS__, $update, '$update' );
  56
  57                 foreach ( self::$counters as $field ) {
  58                         $this->$field += $update->$field;
  59                 }
  60         }
  61
  62         /**
  63          * @param array $deltas
  64          * @return SiteStatsUpdate
  65          */
  66         public static function factory( array $deltas ) {
  67                 $update = new self( 0, 0, 0 );
  68
  69                 foreach ( self::$counters as $field ) {
  70                         if ( isset( $deltas[$field] ) && $deltas[$field] ) {
  71                                 $update->$field = $deltas[$field];
  72                         }
  73                 }
  74
  75                 return $update;
  76         }
  77
  78         public function doUpdate() {
  79                 $this->doUpdateContextStats();
  80
  81                 $rate = MediaWikiServices::getInstance()->getMainConfig()->get( 'SiteStatsAsyncFactor' );
  82                 // If set to do so, only do actual DB updates 1 every $rate times.
  83                 // The other times, just update "pending delta" values in memcached.
  84                 if ( $rate && ( $rate < 0 || mt_rand( 0, $rate - 1 ) != 0 ) ) {
  85                         $this->doUpdatePendingDeltas();
  86                 } else {
  87                         // Need a separate transaction because this a global lock
  88                         DeferredUpdates::addCallableUpdate( [ $this, 'tryDBUpdateInternal' ] );
  89                 }
  90         }
  91
  92         /**
  93          * Do not call this outside of SiteStatsUpdate
  94          */
  95         public function tryDBUpdateInternal() {
  96                 $services = MediaWikiServices::getInstance();
  97                 $config = $services->getMainConfig();
  98
  99                 $dbw = $services->getDBLoadBalancer()->getConnection( DB_MASTER );
 100                 $lockKey = $dbw->getDomainID() . ':site_stats'; // prepend wiki ID
 101                 $pd = [];
 102                 if ( $config->get( 'SiteStatsAsyncFactor' ) ) {
 103                         // Lock the table so we don't have double DB/memcached updates
 104                         if ( !$dbw->lockIsFree( $lockKey, __METHOD__ )
 105                                 || !$dbw->lock( $lockKey, __METHOD__, 1 ) // 1 sec timeout
 106                         ) {
 107                                 $this->doUpdatePendingDeltas();
 108
 109                                 return;
 110                         }
 111                         $pd = $this->getPendingDeltas();
 112                         // Piggy-back the async deltas onto those of this stats update....
 113                         $this->edits += ( $pd['ss_total_edits']['+'] - $pd['ss_total_edits']['-'] );
 114                         $this->articles += ( $pd['ss_good_articles']['+'] - $pd['ss_good_articles']['-'] );
 115                         $this->pages += ( $pd['ss_total_pages']['+'] - $pd['ss_total_pages']['-'] );
 116                         $this->users += ( $pd['ss_users']['+'] - $pd['ss_users']['-'] );
 117                         $this->images += ( $pd['ss_images']['+'] - $pd['ss_images']['-'] );
 118                 }
 119
 120                 // Build up an SQL query of deltas and apply them...
 121                 $updates = '';
 122                 $this->appendUpdate( $updates, 'ss_total_edits', $this->edits );
 123                 $this->appendUpdate( $updates, 'ss_good_articles', $this->articles );
 124                 $this->appendUpdate( $updates, 'ss_total_pages', $this->pages );
 125                 $this->appendUpdate( $updates, 'ss_users', $this->users );
 126                 $this->appendUpdate( $updates, 'ss_images', $this->images );
 127                 if ( $updates != '' ) {
 128                         $dbw->update( 'site_stats', [ $updates ], [], __METHOD__ );
 129                 }
 130
 131                 if ( $config->get( 'SiteStatsAsyncFactor' ) ) {
 132                         // Decrement the async deltas now that we applied them
 133                         $this->removePendingDeltas( $pd );
 134                         // Commit the updates and unlock the table
 135                         $dbw->unlock( $lockKey, __METHOD__ );
 136                 }
 137
 138                 // Invalid cache used by parser functions
 139                 SiteStats::unload();
 140         }
 141
 142         /**
 143          * @param IDatabase $dbw
 144          * @return bool|mixed
 145          */
 146         public static function cacheUpdate( IDatabase $dbw ) {
 147                 $services = MediaWikiServices::getInstance();
 148                 $config = $services->getMainConfig();
 149
 150                 $dbr = $services->getDBLoadBalancer()->getConnection( DB_REPLICA, 'vslow' );
 151                 # Get non-bot users than did some recent action other than making accounts.
 152                 # If account creation is included, the number gets inflated ~20+ fold on enwiki.
 153                 $activeUsers = $dbr->selectField(
 154                         'recentchanges',
 155                         'COUNT( DISTINCT rc_user_text )',
 156                         [
 157                                 'rc_type != ' . $dbr->addQuotes( RC_EXTERNAL ), // Exclude external (Wikidata)
 158                                 'rc_user != 0',
 159                                 'rc_bot' => 0,
 160                                 'rc_log_type != ' . $dbr->addQuotes( 'newusers' ) . ' OR rc_log_type IS NULL',
 161                                 'rc_timestamp >= ' . $dbr->addQuotes(
 162                                         $dbr->timestamp( time() - $config->get( 'ActiveUserDays' ) * 24 * 3600 ) ),
 163                         ],
 164                         __METHOD__
 165                 );
 166                 $dbw->update(
 167                         'site_stats',
 168                         [ 'ss_active_users' => intval( $activeUsers ) ],
 169                         [ 'ss_row_id' => 1 ],
 170                         __METHOD__
 171                 );
 172
 173                 // Invalid cache used by parser functions
 174                 SiteStats::unload();
 175
 176                 return $activeUsers;
 177         }
 178
 179         protected function doUpdateContextStats() {
 180                 $stats = MediaWikiServices::getInstance()->getStatsdDataFactory();
 181                 foreach ( [ 'edits', 'articles', 'pages', 'users', 'images' ] as $type ) {
 182                         $delta = $this->$type;
 183                         if ( $delta !== 0 ) {
 184                                 $stats->updateCount( "site.$type", $delta );
 185                         }
 186                 }
 187         }
 188
 189         protected function doUpdatePendingDeltas() {
 190                 $this->adjustPending( 'ss_total_edits', $this->edits );
 191                 $this->adjustPending( 'ss_good_articles', $this->articles );
 192                 $this->adjustPending( 'ss_total_pages', $this->pages );
 193                 $this->adjustPending( 'ss_users', $this->users );
 194                 $this->adjustPending( 'ss_images', $this->images );
 195         }
 196
 197         /**
 198          * @param string &$sql
 199          * @param string $field
 200          * @param int $delta
 201          */
 202         protected function appendUpdate( &$sql, $field, $delta ) {
 203                 if ( $delta ) {
 204                         if ( $sql ) {
 205                                 $sql .= ',';
 206                         }
 207                         if ( $delta < 0 ) {
 208                                 $sql .= "$field=$field-" . abs( $delta );
 209                         } else {
 210                                 $sql .= "$field=$field+" . abs( $delta );
 211                         }
 212                 }
 213         }
 214
 215         /**
 216          * @param BagOStuff $stash
 217          * @param string $type
 218          * @param string $sign ('+' or '-')
 219          * @return string
 220          */
 221         private function getTypeCacheKey( BagOStuff $stash, $type, $sign ) {
 222                 return $stash->makeKey( 'sitestatsupdate', 'pendingdelta', $type, $sign );
 223         }
 224
 225         /**
 226          * Adjust the pending deltas for a stat type.
 227          * Each stat type has two pending counters, one for increments and decrements
 228          * @param string $type
 229          * @param int $delta Delta (positive or negative)
 230          */
 231         protected function adjustPending( $type, $delta ) {
 232                 if ( $delta < 0 ) { // decrement
 233                         $key = $this->getTypeCacheKey( $this->stash, $type, '-' );
 234                 } else { // increment
 235                         $key = $this->getTypeCacheKey( $this->stash, $type, '+' );
 236                 }
 237
 238                 $magnitude = abs( $delta );
 239                 $this->stash->incrWithInit( $key, 0, $magnitude, $magnitude );
 240         }
 241
 242         /**
 243          * Get pending delta counters for each stat type
 244          * @return array Positive and negative deltas for each type
 245          */
 246         protected function getPendingDeltas() {
 247                 $pending = [];
 248                 foreach ( [ 'ss_total_edits',
 249                         'ss_good_articles', 'ss_total_pages', 'ss_users', 'ss_images' ] as $type
 250                 ) {
 251                         // Get pending increments and pending decrements
 252                         $flg = BagOStuff::READ_LATEST;
 253                         $pending[$type]['+'] = (int)$this->stash->get(
 254                                 $this->getTypeCacheKey( $this->stash, $type, '+' ),
 255                                 $flg
 256                         );
 257                         $pending[$type]['-'] = (int)$this->stash->get(
 258                                 $this->getTypeCacheKey( $this->stash, $type, '-' ),
 259                                 $flg
 260                         );
 261                 }
 262
 263                 return $pending;
 264         }
 265
 266         /**
 267          * Reduce pending delta counters after updates have been applied
 268          * @param array $pd Result of getPendingDeltas(), used for DB update
 269          */
 270         protected function removePendingDeltas( array $pd ) {
 271                 foreach ( $pd as $type => $deltas ) {
 272                         foreach ( $deltas as $sign => $magnitude ) {
 273                                 // Lower the pending counter now that we applied these changes
 274                                 $key = $this->getTypeCacheKey( $this->stash, $type, $sign );
 275                                 $this->stash->decr( $key, $magnitude );
 276                         }
 277                 }
 278         }
 279 }