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 = array_sum( JobQueueGroup::singleton()->getQueueSizes() );
 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 ( $row === false
 230                         || $row->ss_total_pages < $row->ss_good_articles
 231                         || $row->ss_total_edits < $row->ss_total_pages
 232                         || $row->ss_users < $row->ss_active_users
 233                 ) {
 234                         return false;
 235                 }
 236                 // Now check for underflow/overflow
 237                 foreach ( array(
 238                         'ss_total_views',
 239                         'ss_total_edits',
 240                         'ss_good_articles',
 241                         'ss_total_pages',
 242                         'ss_users',
 243                         'ss_active_users',
 244                         'ss_images',
 245                 ) as $member ) {
 246                         if ( $row->$member > 2000000000 || $row->$member < 0 ) {
 247                                 return false;
 248                         }
 249                 }
 250                 return true;
 251         }
 252 }
 253
 254 /**
 255  * Class designed for counting of stats.
 256  */
 257 class SiteStatsInit {
 258
 259         // Database connection
 260         private $db;
 261
 262         // Various stats
 263         private $mEdits, $mArticles, $mPages, $mUsers, $mViews, $mFiles = 0;
 264
 265         /**
 266          * Constructor
 267          * @param $database Boolean or DatabaseBase:
 268          * - Boolean: whether to use the master DB
 269          * - DatabaseBase: database connection to use
 270          */
 271         public function __construct( $database = false ) {
 272                 if ( $database instanceof DatabaseBase ) {
 273                         $this->db = $database;
 274                 } else {
 275                         $this->db = wfGetDB( $database ? DB_MASTER : DB_SLAVE );
 276                 }
 277         }
 278
 279         /**
 280          * Count the total number of edits
 281          * @return Integer
 282          */
 283         public function edits() {
 284                 $this->mEdits = $this->db->selectField( 'revision', 'COUNT(*)', '', __METHOD__ );
 285                 $this->mEdits += $this->db->selectField( 'archive', 'COUNT(*)', '', __METHOD__ );
 286                 return $this->mEdits;
 287         }
 288
 289         /**
 290          * Count pages in article space(s)
 291          * @return Integer
 292          */
 293         public function articles() {
 294                 global $wgArticleCountMethod;
 295
 296                 $tables = array( 'page' );
 297                 $conds = array(
 298                         'page_namespace' => MWNamespace::getContentNamespaces(),
 299                         'page_is_redirect' => 0,
 300                 );
 301
 302                 if ( $wgArticleCountMethod == 'link' ) {
 303                         $tables[] = 'pagelinks';
 304                         $conds[] = 'pl_from=page_id';
 305                 } elseif ( $wgArticleCountMethod == 'comma' ) {
 306                         // To make a correct check for this, we would need, for each page,
 307                         // to load the text, maybe uncompress it, maybe decode it and then
 308                         // check if there's one comma.
 309                         // But one thing we are sure is that if the page is empty, it can't
 310                         // contain a comma :)
 311                         $conds[] = 'page_len > 0';
 312                 }
 313
 314                 $this->mArticles = $this->db->selectField( $tables, 'COUNT(DISTINCT page_id)',
 315                         $conds, __METHOD__ );
 316                 return $this->mArticles;
 317         }
 318
 319         /**
 320          * Count total pages
 321          * @return Integer
 322          */
 323         public function pages() {
 324                 $this->mPages = $this->db->selectField( 'page', 'COUNT(*)', '', __METHOD__ );
 325                 return $this->mPages;
 326         }
 327
 328         /**
 329          * Count total users
 330          * @return Integer
 331          */
 332         public function users() {
 333                 $this->mUsers = $this->db->selectField( 'user', 'COUNT(*)', '', __METHOD__ );
 334                 return $this->mUsers;
 335         }
 336
 337         /**
 338          * Count views
 339          * @return Integer
 340          */
 341         public function views() {
 342                 $this->mViews = $this->db->selectField( 'page', 'SUM(page_counter)', '', __METHOD__ );
 343                 return $this->mViews;
 344         }
 345
 346         /**
 347          * Count total files
 348          * @return Integer
 349          */
 350         public function files() {
 351                 $this->mFiles = $this->db->selectField( 'image', 'COUNT(*)', '', __METHOD__ );
 352                 return $this->mFiles;
 353         }
 354
 355         /**
 356          * Do all updates and commit them. More or less a replacement
 357          * for the original initStats, but without output.
 358          *
 359          * @param $database DatabaseBase|bool
 360          * - Boolean: whether to use the master DB
 361          * - DatabaseBase: database connection to use
 362          * @param array $options of options, may contain the following values
 363          * - update Boolean: whether to update the current stats (true) or write fresh (false) (default: false)
 364          * - views Boolean: when true, do not update the number of page views (default: true)
 365          * - activeUsers Boolean: whether to update the number of active users (default: false)
 366          */
 367         public static function doAllAndCommit( $database, array $options = array() ) {
 368                 $options += array( 'update' => false, 'views' => true, 'activeUsers' => false );
 369
 370                 // Grab the object and count everything
 371                 $counter = new SiteStatsInit( $database );
 372
 373                 $counter->edits();
 374                 $counter->articles();
 375                 $counter->pages();
 376                 $counter->users();
 377                 $counter->files();
 378
 379                 // Only do views if we don't want to not count them
 380                 if ( $options['views'] ) {
 381                         $counter->views();
 382                 }
 383
 384                 // Update/refresh
 385                 if ( $options['update'] ) {
 386                         $counter->update();
 387                 } else {
 388                         $counter->refresh();
 389                 }
 390
 391                 // Count active users if need be
 392                 if ( $options['activeUsers'] ) {
 393                         SiteStatsUpdate::cacheUpdate( wfGetDB( DB_MASTER ) );
 394                 }
 395         }
 396
 397         /**
 398          * Update the current row with the selected values
 399          */
 400         public function update() {
 401                 list( $values, $conds ) = $this->getDbParams();
 402                 $dbw = wfGetDB( DB_MASTER );
 403                 $dbw->update( 'site_stats', $values, $conds, __METHOD__ );
 404         }
 405
 406         /**
 407          * Refresh site_stats. Erase the current record and save all
 408          * the new values.
 409          */
 410         public function refresh() {
 411                 list( $values, $conds, $views ) = $this->getDbParams();
 412                 $dbw = wfGetDB( DB_MASTER );
 413                 $dbw->delete( 'site_stats', $conds, __METHOD__ );
 414                 $dbw->insert( 'site_stats', array_merge( $values, $conds, $views ), __METHOD__ );
 415         }
 416
 417         /**
 418          * Return three arrays of params for the db queries
 419          * @return Array
 420          */
 421         private function getDbParams() {
 422                 $values = array(
 423                         'ss_total_edits' => $this->mEdits,
 424                         'ss_good_articles' => $this->mArticles,
 425                         'ss_total_pages' => $this->mPages,
 426                         'ss_users' => $this->mUsers,
 427                         'ss_images' => $this->mFiles
 428                 );
 429                 $conds = array( 'ss_row_id' => 1 );
 430                 $views = array( 'ss_total_views' => $this->mViews );
 431                 return array( $values, $conds, $views );
 432         }
 433 }