includes/SiteStats.php

   1 <?php
   2 /**
   3  * Accessors and mutators for the site-wide statistics.
   4  *
   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.
   9  *
  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.
  14  *
  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
  19  *
  20  * @file
  21  */
  22
  23 /**
  24  * Static accessor class for site_stats and related things
  25  */
  26 class SiteStats {
  27         static $row, $loaded = false;
  28         static $jobs;
  29         static $pageCount = array();
  30         static $groupMemberCounts = array();
  31
  32         static function recache() {
  33                 self::load( true );
  34         }
  35
  36         /**
  37          * @param $recache bool
  38          */
  39         static function load( $recache = false ) {
  40                 if ( self::$loaded && !$recache ) {
  41                         return;
  42                 }
  43
  44                 self::$row = self::loadAndLazyInit();
  45
  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 ) {
  48                         # Update schema
  49                         $u = new SiteStatsUpdate( 0, 0, 0 );
  50                         $u->doUpdate();
  51                         self::$row = self::doLoad( wfGetDB( DB_SLAVE ) );
  52                 }
  53
  54                 self::$loaded = true;
  55         }
  56
  57         /**
  58          * @return Bool|ResultWrapper
  59          */
  60         static function loadAndLazyInit() {
  61                 wfDebug( __METHOD__ . ": reading site_stats from slave\n" );
  62                 $row = self::doLoad( wfGetDB( DB_SLAVE ) );
  63
  64                 if ( !self::isSane( $row ) ) {
  65                         // Might have just been initialized during this request? Underflow?
  66                         wfDebug( __METHOD__ . ": site_stats damaged or missing on slave\n" );
  67                         $row = self::doLoad( wfGetDB( DB_MASTER ) );
  68                 }
  69
  70                 if ( !self::isSane( $row ) ) {
  71                         // Normally the site_stats table is initialized at install time.
  72                         // Some manual construction scenarios may leave the table empty or
  73                         // broken, however, for instance when importing from a dump into a
  74                         // clean schema with mwdumper.
  75                         wfDebug( __METHOD__ . ": initializing damaged or missing site_stats\n" );
  76
  77                         SiteStatsInit::doAllAndCommit( wfGetDB( DB_SLAVE ) );
  78
  79                         $row = self::doLoad( wfGetDB( DB_MASTER ) );
  80                 }
  81
  82                 if ( !self::isSane( $row ) ) {
  83                         wfDebug( __METHOD__ . ": site_stats persistently nonsensical o_O\n" );
  84                 }
  85                 return $row;
  86         }
  87
  88         /**
  89          * @param $db DatabaseBase
  90          * @return Bool|ResultWrapper
  91          */
  92         static function doLoad( $db ) {
  93                 return $db->selectRow( 'site_stats', array(
  94                                 'ss_row_id',
  95                                 'ss_total_views',
  96                                 'ss_total_edits',
  97                                 'ss_good_articles',
  98                                 'ss_total_pages',
  99                                 'ss_users',
 100                                 'ss_active_users',
 101                                 'ss_images',
 102                         ), false, __METHOD__ );
 103         }
 104
 105         /**
 106          * @return int
 107          */
 108         static function views() {
 109                 self::load();
 110                 return self::$row->ss_total_views;
 111         }
 112
 113         /**
 114          * @return int
 115          */
 116         static function edits() {
 117                 self::load();
 118                 return self::$row->ss_total_edits;
 119         }
 120
 121         /**
 122          * @return int
 123          */
 124         static function articles() {
 125                 self::load();
 126                 return self::$row->ss_good_articles;
 127         }
 128
 129         /**
 130          * @return int
 131          */
 132         static function pages() {
 133                 self::load();
 134                 return self::$row->ss_total_pages;
 135         }
 136
 137         /**
 138          * @return int
 139          */
 140         static function users() {
 141                 self::load();
 142                 return self::$row->ss_users;
 143         }
 144
 145         /**
 146          * @return int
 147          */
 148         static function activeUsers() {
 149                 self::load();
 150                 return self::$row->ss_active_users;
 151         }
 152
 153         /**
 154          * @return int
 155          */
 156         static function images() {
 157                 self::load();
 158                 return self::$row->ss_images;
 159         }
 160
 161         /**
 162          * Find the number of users in a given user group.
 163          * @param string $group name of group
 164          * @return Integer
 165          */
 166         static function numberingroup( $group ) {
 167                 if ( !isset( self::$groupMemberCounts[$group] ) ) {
 168                         global $wgMemc;
 169                         $key = wfMemcKey( 'SiteStats', 'groupcounts', $group );
 170                         $hit = $wgMemc->get( $key );
 171                         if ( !$hit ) {
 172                                 $dbr = wfGetDB( DB_SLAVE );
 173                                 $hit = $dbr->selectField(
 174                                         'user_groups',
 175                                         'COUNT(*)',
 176                                         array( 'ug_group' => $group ),
 177                                         __METHOD__
 178                                 );
 179                                 $wgMemc->set( $key, $hit, 3600 );
 180                         }
 181                         self::$groupMemberCounts[$group] = $hit;
 182                 }
 183                 return self::$groupMemberCounts[$group];
 184         }
 185
 186         /**
 187          * @return int
 188          */
 189         static function jobs() {
 190                 if ( !isset( self::$jobs ) ) {
 191                         $dbr = wfGetDB( DB_SLAVE );
 192                         self::$jobs = $dbr->estimateRowCount( 'job' );
 193                         /* Zero rows still do single row read for row that doesn't exist, but people are annoyed by that */
 194                         if ( self::$jobs == 1 ) {
 195                                 self::$jobs = 0;
 196                         }
 197                 }
 198                 return self::$jobs;
 199         }
 200
 201         /**
 202          * @param $ns int
 203          *
 204          * @return int
 205          */
 206         static function pagesInNs( $ns ) {
 207                 wfProfileIn( __METHOD__ );
 208                 if ( !isset( self::$pageCount[$ns] ) ) {
 209                         $dbr = wfGetDB( DB_SLAVE );
 210                         self::$pageCount[$ns] = (int)$dbr->selectField(
 211                                 'page',
 212                                 'COUNT(*)',
 213                                 array( 'page_namespace' => $ns ),
 214                                 __METHOD__
 215                         );
 216                 }
 217                 wfProfileOut( __METHOD__ );
 218                 return self::$pageCount[$ns];
 219         }
 220
 221         /**
 222          * Is the provided row of site stats sane, or should it be regenerated?
 223          *
 224          * @param $row
 225          *
 226          * @return bool
 227          */
 228         private static function isSane( $row ) {
 229                 if (
 230                         $row === false
 231                         || $row->ss_total_pages < $row->ss_good_articles
 232                         || $row->ss_total_edits < $row->ss_total_pages
 233                 ) {
 234                         return false;
 235                 }
 236                 // Now check for underflow/overflow
 237                 foreach ( array( 'total_views', 'total_edits', 'good_articles',
 238                 'total_pages', 'users', 'images' ) as $member ) {
 239                         if (
 240                                 $row->{"ss_$member"} > 2000000000
 241                                 || $row->{"ss_$member"} < 0
 242                         ) {
 243                                 return false;
 244                         }
 245                 }
 246                 return true;
 247         }
 248 }
 249
 250 /**
 251  * Class for handling updates to the site_stats table
 252  */
 253 class SiteStatsUpdate implements DeferrableUpdate {
 254         protected $views = 0;
 255         protected $edits = 0;
 256         protected $pages = 0;
 257         protected $articles = 0;
 258         protected $users = 0;
 259         protected $images = 0;
 260
 261         // @todo deprecate this constructor
 262         function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) {
 263                 $this->views = $views;
 264                 $this->edits = $edits;
 265                 $this->articles = $good;
 266                 $this->pages = $pages;
 267                 $this->users = $users;
 268         }
 269
 270         /**
 271          * @param $deltas Array
 272          * @return SiteStatsUpdate
 273          */
 274         public static function factory( array $deltas ) {
 275                 $update = new self( 0, 0, 0 );
 276
 277                 $fields = array( 'views', 'edits', 'pages', 'articles', 'users', 'images' );
 278                 foreach ( $fields as $field ) {
 279                         if ( isset( $deltas[$field] ) && $deltas[$field] ) {
 280                                 $update->$field = $deltas[$field];
 281                         }
 282                 }
 283
 284                 return $update;
 285         }
 286
 287         public function doUpdate() {
 288                 global $wgSiteStatsAsyncFactor;
 289
 290                 $rate = $wgSiteStatsAsyncFactor; // convenience
 291                 // If set to do so, only do actual DB updates 1 every $rate times.
 292                 // The other times, just update "pending delta" values in memcached.
 293                 if ( $rate && ( $rate < 0 || mt_rand( 0, $rate - 1 ) != 0 ) ) {
 294                         $this->doUpdatePendingDeltas();
 295                 } else {
 296                         $dbw = wfGetDB( DB_MASTER );
 297
 298                         $lockKey = wfMemcKey( 'site_stats' ); // prepend wiki ID
 299                         if ( $rate ) {
 300                                 // Lock the table so we don't have double DB/memcached updates
 301                                 if ( !$dbw->lockIsFree( $lockKey, __METHOD__ )
 302                                         || !$dbw->lock( $lockKey, __METHOD__, 1 ) // 1 sec timeout
 303                                 ) {
 304                                         $this->doUpdatePendingDeltas();
 305                                         return;
 306                                 }
 307                                 $pd = $this->getPendingDeltas();
 308                                 // Piggy-back the async deltas onto those of this stats update....
 309                                 $this->views += ( $pd['ss_total_views']['+'] - $pd['ss_total_views']['-'] );
 310                                 $this->edits += ( $pd['ss_total_edits']['+'] - $pd['ss_total_edits']['-'] );
 311                                 $this->articles += ( $pd['ss_good_articles']['+'] - $pd['ss_good_articles']['-'] );
 312                                 $this->pages += ( $pd['ss_total_pages']['+'] - $pd['ss_total_pages']['-'] );
 313                                 $this->users += ( $pd['ss_users']['+'] - $pd['ss_users']['-'] );
 314                                 $this->images += ( $pd['ss_images']['+'] - $pd['ss_images']['-'] );
 315                         }
 316
 317                         // Need a separate transaction because this a global lock
 318                         $dbw->begin( __METHOD__ );
 319
 320                         // Build up an SQL query of deltas and apply them...
 321                         $updates = '';
 322                         $this->appendUpdate( $updates, 'ss_total_views', $this->views );
 323                         $this->appendUpdate( $updates, 'ss_total_edits', $this->edits );
 324                         $this->appendUpdate( $updates, 'ss_good_articles', $this->articles );
 325                         $this->appendUpdate( $updates, 'ss_total_pages', $this->pages );
 326                         $this->appendUpdate( $updates, 'ss_users', $this->users );
 327                         $this->appendUpdate( $updates, 'ss_images', $this->images );
 328                         if ( $updates != '' ) {
 329                                 $dbw->update( 'site_stats', array( $updates ), array(), __METHOD__ );
 330                         }
 331
 332                         if ( $rate ) {
 333                                 // Decrement the async deltas now that we applied them
 334                                 $this->removePendingDeltas( $pd );
 335                                 // Commit the updates and unlock the table
 336                                 $dbw->unlock( $lockKey, __METHOD__ );
 337                         }
 338
 339                         $dbw->commit( __METHOD__ );
 340                 }
 341         }
 342
 343         /**
 344          * @param $dbw DatabaseBase
 345          * @return bool|mixed
 346          */
 347         public static function cacheUpdate( $dbw ) {
 348                 global $wgActiveUserDays;
 349                 $dbr = wfGetDB( DB_SLAVE, array( 'SpecialStatistics', 'vslow' ) );
 350                 # Get non-bot users than did some recent action other than making accounts.
 351                 # If account creation is included, the number gets inflated ~20+ fold on enwiki.
 352                 $activeUsers = $dbr->selectField(
 353                         'recentchanges',
 354                         'COUNT( DISTINCT rc_user_text )',
 355                         array(
 356                                 'rc_user != 0',
 357                                 'rc_bot' => 0,
 358                                 'rc_log_type != ' . $dbr->addQuotes( 'newusers' ) . ' OR rc_log_type IS NULL',
 359                                 'rc_timestamp >= ' . $dbr->addQuotes( $dbr->timestamp( wfTimestamp( TS_UNIX ) - $wgActiveUserDays * 24 * 3600 ) ),
 360                         ),
 361                         __METHOD__
 362                 );
 363                 $dbw->update(
 364                         'site_stats',
 365                         array( 'ss_active_users' => intval( $activeUsers ) ),
 366                         array( 'ss_row_id' => 1 ),
 367                         __METHOD__
 368                 );
 369                 return $activeUsers;
 370         }
 371
 372         protected function doUpdatePendingDeltas() {
 373                 $this->adjustPending( 'ss_total_views', $this->views );
 374                 $this->adjustPending( 'ss_total_edits', $this->edits );
 375                 $this->adjustPending( 'ss_good_articles', $this->articles );
 376                 $this->adjustPending( 'ss_total_pages', $this->pages );
 377                 $this->adjustPending( 'ss_users', $this->users );
 378                 $this->adjustPending( 'ss_images', $this->images );
 379         }
 380
 381         /**
 382          * @param $sql string
 383          * @param $field string
 384          * @param $delta integer
 385          */
 386         protected function appendUpdate( &$sql, $field, $delta ) {
 387                 if ( $delta ) {
 388                         if ( $sql ) {
 389                                 $sql .= ',';
 390                         }
 391                         if ( $delta < 0 ) {
 392                                 $sql .= "$field=$field-" . abs( $delta );
 393                         } else {
 394                                 $sql .= "$field=$field+" . abs( $delta );
 395                         }
 396                 }
 397         }
 398
 399         /**
 400          * @param $type string
 401          * @param string $sign ('+' or '-')
 402          * @return string
 403          */
 404         private function getTypeCacheKey( $type, $sign ) {
 405                 return wfMemcKey( 'sitestatsupdate', 'pendingdelta', $type, $sign );
 406         }
 407
 408         /**
 409          * Adjust the pending deltas for a stat type.
 410          * Each stat type has two pending counters, one for increments and decrements
 411          * @param $type string
 412          * @param $delta integer Delta (positive or negative)
 413          * @return void
 414          */
 415         protected function adjustPending( $type, $delta ) {
 416                 global $wgMemc;
 417
 418                 if ( $delta < 0 ) { // decrement
 419                         $key = $this->getTypeCacheKey( $type, '-' );
 420                 } else { // increment
 421                         $key = $this->getTypeCacheKey( $type, '+' );
 422                 }
 423
 424                 $magnitude = abs( $delta );
 425                 if ( !$wgMemc->incr( $key, $magnitude ) ) { // not there?
 426                         if ( !$wgMemc->add( $key, $magnitude ) ) { // race?
 427                                 $wgMemc->incr( $key, $magnitude );
 428                         }
 429                 }
 430         }
 431
 432         /**
 433          * Get pending delta counters for each stat type
 434          * @return Array Positive and negative deltas for each type
 435          * @return void
 436          */
 437         protected function getPendingDeltas() {
 438                 global $wgMemc;
 439
 440                 $pending = array();
 441                 foreach ( array( 'ss_total_views', 'ss_total_edits',
 442                         'ss_good_articles', 'ss_total_pages', 'ss_users', 'ss_images' ) as $type )
 443                 {
 444                         // Get pending increments and pending decrements
 445                         $pending[$type]['+'] = (int)$wgMemc->get( $this->getTypeCacheKey( $type, '+' ) );
 446                         $pending[$type]['-'] = (int)$wgMemc->get( $this->getTypeCacheKey( $type, '-' ) );
 447                 }
 448
 449                 return $pending;
 450         }
 451
 452         /**
 453          * Reduce pending delta counters after updates have been applied
 454          * @param array $pd Result of getPendingDeltas(), used for DB update
 455          * @return void
 456          */
 457         protected function removePendingDeltas( array $pd ) {
 458                 global $wgMemc;
 459
 460                 foreach ( $pd as $type => $deltas ) {
 461                         foreach ( $deltas as $sign => $magnitude ) {
 462                                 // Lower the pending counter now that we applied these changes
 463                                 $wgMemc->decr( $this->getTypeCacheKey( $type, $sign ), $magnitude );
 464                         }
 465                 }
 466         }
 467 }
 468
 469 /**
 470  * Class designed for counting of stats.
 471  */
 472 class SiteStatsInit {
 473
 474         // Database connection
 475         private $db;
 476
 477         // Various stats
 478         private $mEdits, $mArticles, $mPages, $mUsers, $mViews, $mFiles = 0;
 479
 480         /**
 481          * Constructor
 482          * @param $database Boolean or DatabaseBase:
 483          * - Boolean: whether to use the master DB
 484          * - DatabaseBase: database connection to use
 485          */
 486         public function __construct( $database = false ) {
 487                 if ( $database instanceof DatabaseBase ) {
 488                         $this->db = $database;
 489                 } else {
 490                         $this->db = wfGetDB( $database ? DB_MASTER : DB_SLAVE );
 491                 }
 492         }
 493
 494         /**
 495          * Count the total number of edits
 496          * @return Integer
 497          */
 498         public function edits() {
 499                 $this->mEdits = $this->db->selectField( 'revision', 'COUNT(*)', '', __METHOD__ );
 500                 $this->mEdits += $this->db->selectField( 'archive', 'COUNT(*)', '', __METHOD__ );
 501                 return $this->mEdits;
 502         }
 503
 504         /**
 505          * Count pages in article space(s)
 506          * @return Integer
 507          */
 508         public function articles() {
 509                 global $wgArticleCountMethod;
 510
 511                 $tables = array( 'page' );
 512                 $conds = array(
 513                         'page_namespace' => MWNamespace::getContentNamespaces(),
 514                         'page_is_redirect' => 0,
 515                 );
 516
 517                 if ( $wgArticleCountMethod == 'link' ) {
 518                         $tables[] = 'pagelinks';
 519                         $conds[] = 'pl_from=page_id';
 520                 } elseif ( $wgArticleCountMethod == 'comma' ) {
 521                         // To make a correct check for this, we would need, for each page,
 522                         // to load the text, maybe uncompress it, maybe decode it and then
 523                         // check if there's one comma.
 524                         // But one thing we are sure is that if the page is empty, it can't
 525                         // contain a comma :)
 526                         $conds[] = 'page_len > 0';
 527                 }
 528
 529                 $this->mArticles = $this->db->selectField( $tables, 'COUNT(DISTINCT page_id)',
 530                         $conds, __METHOD__ );
 531                 return $this->mArticles;
 532         }
 533
 534         /**
 535          * Count total pages
 536          * @return Integer
 537          */
 538         public function pages() {
 539                 $this->mPages = $this->db->selectField( 'page', 'COUNT(*)', '', __METHOD__ );
 540                 return $this->mPages;
 541         }
 542
 543         /**
 544          * Count total users
 545          * @return Integer
 546          */
 547         public function users() {
 548                 $this->mUsers = $this->db->selectField( 'user', 'COUNT(*)', '', __METHOD__ );
 549                 return $this->mUsers;
 550         }
 551
 552         /**
 553          * Count views
 554          * @return Integer
 555          */
 556         public function views() {
 557                 $this->mViews = $this->db->selectField( 'page', 'SUM(page_counter)', '', __METHOD__ );
 558                 return $this->mViews;
 559         }
 560
 561         /**
 562          * Count total files
 563          * @return Integer
 564          */
 565         public function files() {
 566                 $this->mFiles = $this->db->selectField( 'image', 'COUNT(*)', '', __METHOD__ );
 567                 return $this->mFiles;
 568         }
 569
 570         /**
 571          * Do all updates and commit them. More or less a replacement
 572          * for the original initStats, but without output.
 573          *
 574          * @param $database DatabaseBase|bool
 575          * - Boolean: whether to use the master DB
 576          * - DatabaseBase: database connection to use
 577          * @param array $options of options, may contain the following values
 578          * - update Boolean: whether to update the current stats (true) or write fresh (false) (default: false)
 579          * - views Boolean: when true, do not update the number of page views (default: true)
 580          * - activeUsers Boolean: whether to update the number of active users (default: false)
 581          */
 582         public static function doAllAndCommit( $database, array $options = array() ) {
 583                 $options += array( 'update' => false, 'views' => true, 'activeUsers' => false );
 584
 585                 // Grab the object and count everything
 586                 $counter = new SiteStatsInit( $database );
 587
 588                 $counter->edits();
 589                 $counter->articles();
 590                 $counter->pages();
 591                 $counter->users();
 592                 $counter->files();
 593
 594                 // Only do views if we don't want to not count them
 595                 if ( $options['views'] ) {
 596                         $counter->views();
 597                 }
 598
 599                 // Update/refresh
 600                 if ( $options['update'] ) {
 601                         $counter->update();
 602                 } else {
 603                         $counter->refresh();
 604                 }
 605
 606                 // Count active users if need be
 607                 if ( $options['activeUsers'] ) {
 608                         SiteStatsUpdate::cacheUpdate( wfGetDB( DB_MASTER ) );
 609                 }
 610         }
 611
 612         /**
 613          * Update the current row with the selected values
 614          */
 615         public function update() {
 616                 list( $values, $conds ) = $this->getDbParams();
 617                 $dbw = wfGetDB( DB_MASTER );
 618                 $dbw->update( 'site_stats', $values, $conds, __METHOD__ );
 619         }
 620
 621         /**
 622          * Refresh site_stats. Erase the current record and save all
 623          * the new values.
 624          */
 625         public function refresh() {
 626                 list( $values, $conds, $views ) = $this->getDbParams();
 627                 $dbw = wfGetDB( DB_MASTER );
 628                 $dbw->delete( 'site_stats', $conds, __METHOD__ );
 629                 $dbw->insert( 'site_stats', array_merge( $values, $conds, $views ), __METHOD__ );
 630         }
 631
 632         /**
 633          * Return three arrays of params for the db queries
 634          * @return Array
 635          */
 636         private function getDbParams() {
 637                 $values = array(
 638                         'ss_total_edits' => $this->mEdits,
 639                         'ss_good_articles' => $this->mArticles,
 640                         'ss_total_pages' => $this->mPages,
 641                         'ss_users' => $this->mUsers,
 642                         'ss_images' => $this->mFiles
 643                 );
 644                 $conds = array( 'ss_row_id' => 1 );
 645                 $views = array( 'ss_total_views' => $this->mViews );
 646                 return array( $values, $conds, $views );
 647         }
 648 }