]> scripts.mit.edu Git - autoinstallsdev/mediawiki.git/blobdiff - includes/SiteStats.php
MediaWiki 1.30.2
[autoinstallsdev/mediawiki.git] / includes / SiteStats.php
index d7b9161ab03de0b9ec78e0e730ecbb4aa52ae7b8..ce87596a5fbd298386b9a89bc0d66ac0b0e16073 100644 (file)
@@ -1,17 +1,53 @@
 <?php
+/**
+ * Accessors and mutators for the site-wide statistics.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with this program; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ * http://www.gnu.org/copyleft/gpl.html
+ *
+ * @file
+ */
+
+use Wikimedia\Rdbms\Database;
+use Wikimedia\Rdbms\IDatabase;
+use MediaWiki\MediaWikiServices;
 
 /**
  * Static accessor class for site_stats and related things
  */
 class SiteStats {
-       static $row, $loaded = false;
-       static $admins, $jobs;
-       static $pageCount = array();
+       /** @var bool|stdClass */
+       private static $row;
+
+       /** @var bool */
+       private static $loaded = false;
+
+       /** @var int[] */
+       private static $pageCount = [];
+
+       static function unload() {
+               self::$loaded = false;
+       }
 
        static function recache() {
                self::load( true );
        }
 
+       /**
+        * @param bool $recache
+        */
        static function load( $recache = false ) {
                if ( self::$loaded && !$recache ) {
                        return;
@@ -24,127 +60,219 @@ class SiteStats {
                        # Update schema
                        $u = new SiteStatsUpdate( 0, 0, 0 );
                        $u->doUpdate();
-                       $dbr = wfGetDB( DB_SLAVE );
-                       self::$row = $dbr->selectRow( 'site_stats', '*', false, __METHOD__ );
+                       self::$row = self::doLoad( wfGetDB( DB_REPLICA ) );
                }
-               
+
                self::$loaded = true;
        }
-       
+
+       /**
+        * @return bool|stdClass
+        */
        static function loadAndLazyInit() {
-               wfDebug( __METHOD__ . ": reading site_stats from slave\n" );
-               $row = self::doLoad( wfGetDB( DB_SLAVE ) );
+               global $wgMiserMode;
 
-               if( !self::isSane( $row ) ) {
-                       // Might have just been initialized during this request? Underflow?
-                       wfDebug( __METHOD__ . ": site_stats damaged or missing on slave\n" );
-                       $row = self::doLoad( wfGetDB( DB_MASTER ) );
+               wfDebug( __METHOD__ . ": reading site_stats from replica DB\n" );
+               $row = self::doLoad( wfGetDB( DB_REPLICA ) );
+
+               if ( !self::isSane( $row ) ) {
+                       $lb = MediaWikiServices::getInstance()->getDBLoadBalancer();
+                       if ( $lb->hasOrMadeRecentMasterChanges() ) {
+                               // Might have just been initialized during this request? Underflow?
+                               wfDebug( __METHOD__ . ": site_stats damaged or missing on replica DB\n" );
+                               $row = self::doLoad( wfGetDB( DB_MASTER ) );
+                       }
                }
-               
-               if( !self::isSane( $row ) ) {
+
+               if ( !$wgMiserMode && !self::isSane( $row ) ) {
                        // Normally the site_stats table is initialized at install time.
                        // Some manual construction scenarios may leave the table empty or
                        // broken, however, for instance when importing from a dump into a
                        // clean schema with mwdumper.
                        wfDebug( __METHOD__ . ": initializing damaged or missing site_stats\n" );
-                       
-                       global $IP;
-                       require_once "$IP/maintenance/initStats.inc";
-                       
-                       ob_start();
-                       wfInitStats();
-                       ob_end_clean();
-                       
+
+                       SiteStatsInit::doAllAndCommit( wfGetDB( DB_REPLICA ) );
+
                        $row = self::doLoad( wfGetDB( DB_MASTER ) );
                }
-               
-               if( !self::isSane( $row ) ) {
+
+               if ( !self::isSane( $row ) ) {
                        wfDebug( __METHOD__ . ": site_stats persistently nonsensical o_O\n" );
                }
+
                return $row;
        }
 
+       /**
+        * @param IDatabase $db
+        * @return bool|stdClass
+        */
        static function doLoad( $db ) {
-               return $db->selectRow( 'site_stats', '*', false, __METHOD__ );
+               return $db->selectRow( 'site_stats', [
+                               'ss_row_id',
+                               'ss_total_edits',
+                               'ss_good_articles',
+                               'ss_total_pages',
+                               'ss_users',
+                               'ss_active_users',
+                               'ss_images',
+                       ], [], __METHOD__ );
        }
 
+       /**
+        * Return the total number of page views. Except we don't track those anymore.
+        * Stop calling this function, it will be removed some time in the future. It's
+        * kept here simply to prevent fatal errors.
+        *
+        * @deprecated since 1.25
+        * @return int
+        */
        static function views() {
-               self::load();
-               return self::$row->ss_total_views;
+               wfDeprecated( __METHOD__, '1.25' );
+               return 0;
        }
 
+       /**
+        * @return int
+        */
        static function edits() {
                self::load();
                return self::$row->ss_total_edits;
        }
 
+       /**
+        * @return int
+        */
        static function articles() {
                self::load();
                return self::$row->ss_good_articles;
        }
 
+       /**
+        * @return int
+        */
        static function pages() {
                self::load();
                return self::$row->ss_total_pages;
        }
 
+       /**
+        * @return int
+        */
        static function users() {
                self::load();
                return self::$row->ss_users;
        }
-       
+
+       /**
+        * @return int
+        */
+       static function activeUsers() {
+               self::load();
+               return self::$row->ss_active_users;
+       }
+
+       /**
+        * @return int
+        */
        static function images() {
                self::load();
                return self::$row->ss_images;
        }
 
-       static function admins() {
-               if ( !isset( self::$admins ) ) {
-                       $dbr = wfGetDB( DB_SLAVE );
-                       self::$admins = $dbr->selectField( 'user_groups', 'COUNT(*)', array( 'ug_group' => 'sysop' ), __METHOD__ );
-               }
-               return self::$admins;
+       /**
+        * Find the number of users in a given user group.
+        * @param string $group Name of group
+        * @return int
+        */
+       static function numberingroup( $group ) {
+               $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
+               return $cache->getWithSetCallback(
+                       $cache->makeKey( 'SiteStats', 'groupcounts', $group ),
+                       $cache::TTL_HOUR,
+                       function ( $oldValue, &$ttl, array &$setOpts ) use ( $group ) {
+                               $dbr = wfGetDB( DB_REPLICA );
+
+                               $setOpts += Database::getCacheSetOptions( $dbr );
+
+                               return $dbr->selectField(
+                                       'user_groups',
+                                       'COUNT(*)',
+                                       [
+                                               'ug_group' => $group,
+                                               'ug_expiry IS NULL OR ug_expiry >= ' . $dbr->addQuotes( $dbr->timestamp() )
+                                       ],
+                                       __METHOD__
+                               );
+                       },
+                       [ 'pcTTL' => $cache::TTL_PROC_LONG ]
+               );
        }
 
+       /**
+        * Total number of jobs in the job queue.
+        * @return int
+        */
        static function jobs() {
-               if ( !isset( self::$jobs ) ) {
-                       $dbr = wfGetDB( DB_SLAVE );
-                       self::$jobs = $dbr->estimateRowCount('job');
-                       /* 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;
-                       }
-               }
-               return self::$jobs;
+               $cache = MediaWikiServices::getInstance()->getMainWANObjectCache();
+               return $cache->getWithSetCallback(
+                       $cache->makeKey( 'SiteStats', 'jobscount' ),
+                       $cache::TTL_MINUTE,
+                       function ( $oldValue, &$ttl, array &$setOpts ) {
+                               try{
+                                       $jobs = array_sum( JobQueueGroup::singleton()->getQueueSizes() );
+                               } catch ( JobQueueError $e ) {
+                                       $jobs = 0;
+                               }
+                               return $jobs;
+                       },
+                       [ 'pcTTL' => $cache::TTL_PROC_LONG ]
+               );
        }
-       
+
+       /**
+        * @param int $ns
+        *
+        * @return int
+        */
        static function pagesInNs( $ns ) {
-               wfProfileIn( __METHOD__ );
-               if( !isset( self::$pageCount[$ns] ) ) {
-                       $dbr = wfGetDB( DB_SLAVE );
-                       $pageCount[$ns] = (int)$dbr->selectField( 'page', 'COUNT(*)', array( 'page_namespace' => $ns ), __METHOD__ );
+               if ( !isset( self::$pageCount[$ns] ) ) {
+                       $dbr = wfGetDB( DB_REPLICA );
+                       self::$pageCount[$ns] = (int)$dbr->selectField(
+                               'page',
+                               'COUNT(*)',
+                               [ 'page_namespace' => $ns ],
+                               __METHOD__
+                       );
                }
-               wfProfileOut( __METHOD__ );
-               return $pageCount[$ns];
+               return self::$pageCount[$ns];
        }
 
-       /** Is the provided row of site stats sane, or should it be regenerated? */
+       /**
+        * Is the provided row of site stats sane, or should it be regenerated?
+        *
+        * Checks only fields which are filled by SiteStatsInit::refresh.
+        *
+        * @param bool|object $row
+        *
+        * @return bool
+        */
        private static function isSane( $row ) {
-               if(
-                       $row === false
-                       or $row->ss_total_pages < $row->ss_good_articles
-                       or $row->ss_total_edits < $row->ss_total_pages
-                       or $row->ss_users       < $row->ss_admins
+               if ( $row === false
+                       || $row->ss_total_pages < $row->ss_good_articles
+                       || $row->ss_total_edits < $row->ss_total_pages
                ) {
                        return false;
                }
                // Now check for underflow/overflow
-               foreach( array( 'total_views', 'total_edits', 'good_articles',
-               'total_pages', 'users', 'admins', 'images' ) as $member ) {
-                       if(
-                                  $row->{"ss_$member"} > 2000000000
-                               or $row->{"ss_$member"} < 0
-                       ) {
+               foreach ( [
+                       'ss_total_edits',
+                       'ss_good_articles',
+                       'ss_total_pages',
+                       'ss_users',
+                       'ss_images',
+               ] as $member ) {
+                       if ( $row->$member > 2000000000 || $row->$member < 0 ) {
                                return false;
                        }
                }
@@ -152,88 +280,144 @@ class SiteStats {
        }
 }
 
-
 /**
- *
+ * Class designed for counting of stats.
  */
-class SiteStatsUpdate {
+class SiteStatsInit {
 
-       var $mViews, $mEdits, $mGood, $mPages, $mUsers;
+       // Database connection
+       private $db;
 
-       function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) {
-               $this->mViews = $views;
-               $this->mEdits = $edits;
-               $this->mGood = $good;
-               $this->mPages = $pages;
-               $this->mUsers = $users;
+       // Various stats
+       private $mEdits = null, $mArticles = null, $mPages = null;
+       private $mUsers = null, $mFiles = null;
+
+       /**
+        * @param bool|IDatabase $database
+        * - bool: Whether to use the master DB
+        * - IDatabase: Database connection to use
+        */
+       public function __construct( $database = false ) {
+               if ( $database instanceof IDatabase ) {
+                       $this->db = $database;
+               } elseif ( $database ) {
+                       $this->db = wfGetDB( DB_MASTER );
+               } else {
+                       $this->db = wfGetDB( DB_REPLICA, 'vslow' );
+               }
        }
 
-       function appendUpdate( &$sql, $field, $delta ) {
-               if ( $delta ) {
-                       if ( $sql ) {
-                               $sql .= ',';
-                       }
-                       if ( $delta < 0 ) {
-                               $sql .= "$field=$field-1";
-                       } else {
-                               $sql .= "$field=$field+1";
-                       }
+       /**
+        * Count the total number of edits
+        * @return int
+        */
+       public function edits() {
+               $this->mEdits = $this->db->selectField( 'revision', 'COUNT(*)', '', __METHOD__ );
+               $this->mEdits += $this->db->selectField( 'archive', 'COUNT(*)', '', __METHOD__ );
+               return $this->mEdits;
+       }
+
+       /**
+        * Count pages in article space(s)
+        * @return int
+        */
+       public function articles() {
+               global $wgArticleCountMethod;
+
+               $tables = [ 'page' ];
+               $conds = [
+                       'page_namespace' => MWNamespace::getContentNamespaces(),
+                       'page_is_redirect' => 0,
+               ];
+
+               if ( $wgArticleCountMethod == 'link' ) {
+                       $tables[] = 'pagelinks';
+                       $conds[] = 'pl_from=page_id';
+               } elseif ( $wgArticleCountMethod == 'comma' ) {
+                       // To make a correct check for this, we would need, for each page,
+                       // to load the text, maybe uncompress it, maybe decode it and then
+                       // check if there's one comma.
+                       // But one thing we are sure is that if the page is empty, it can't
+                       // contain a comma :)
+                       $conds[] = 'page_len > 0';
                }
+
+               $this->mArticles = $this->db->selectField( $tables, 'COUNT(DISTINCT page_id)',
+                       $conds, __METHOD__ );
+               return $this->mArticles;
        }
 
-       function doUpdate() {
-               $fname = 'SiteStatsUpdate::doUpdate';
-               $dbw = wfGetDB( DB_MASTER );
+       /**
+        * Count total pages
+        * @return int
+        */
+       public function pages() {
+               $this->mPages = $this->db->selectField( 'page', 'COUNT(*)', '', __METHOD__ );
+               return $this->mPages;
+       }
 
-               # First retrieve the row just to find out which schema we're in
-               $row = $dbw->selectRow( 'site_stats', '*', false, $fname );
+       /**
+        * Count total users
+        * @return int
+        */
+       public function users() {
+               $this->mUsers = $this->db->selectField( 'user', 'COUNT(*)', '', __METHOD__ );
+               return $this->mUsers;
+       }
 
-               $updates = '';
+       /**
+        * Count total files
+        * @return int
+        */
+       public function files() {
+               $this->mFiles = $this->db->selectField( 'image', 'COUNT(*)', '', __METHOD__ );
+               return $this->mFiles;
+       }
 
-               $this->appendUpdate( $updates, 'ss_total_views', $this->mViews );
-               $this->appendUpdate( $updates, 'ss_total_edits', $this->mEdits );
-               $this->appendUpdate( $updates, 'ss_good_articles', $this->mGood );
+       /**
+        * Do all updates and commit them. More or less a replacement
+        * for the original initStats, but without output.
+        *
+        * @param IDatabase|bool $database
+        * - bool: Whether to use the master DB
+        * - IDatabase: Database connection to use
+        * @param array $options Array of options, may contain the following values
+        * - activeUsers bool: Whether to update the number of active users (default: false)
+        */
+       public static function doAllAndCommit( $database, array $options = [] ) {
+               $options += [ 'update' => false, 'activeUsers' => false ];
 
-               if ( isset( $row->ss_total_pages ) ) {
-                       # Update schema if required
-                       if ( $row->ss_total_pages == -1 && !$this->mViews ) {
-                               $dbr = wfGetDB( DB_SLAVE, array( 'SpecialStatistics', 'vslow') );
-                               list( $page, $user ) = $dbr->tableNamesN( 'page', 'user' );
+               // Grab the object and count everything
+               $counter = new SiteStatsInit( $database );
 
-                               $sql = "SELECT COUNT(page_namespace) AS total FROM $page";
-                               $res = $dbr->query( $sql, $fname );
-                               $pageRow = $dbr->fetchObject( $res );
-                               $pages = $pageRow->total + $this->mPages;
+               $counter->edits();
+               $counter->articles();
+               $counter->pages();
+               $counter->users();
+               $counter->files();
 
-                               $sql = "SELECT COUNT(user_id) AS total FROM $user";
-                               $res = $dbr->query( $sql, $fname );
-                               $userRow = $dbr->fetchObject( $res );
-                               $users = $userRow->total + $this->mUsers;
+               $counter->refresh();
 
-                               if ( $updates ) {
-                                       $updates .= ',';
-                               }
-                               $updates .= "ss_total_pages=$pages, ss_users=$users";
-                       } else {
-                               $this->appendUpdate( $updates, 'ss_total_pages', $this->mPages );
-                               $this->appendUpdate( $updates, 'ss_users', $this->mUsers );
-                       }
-               }
-               if ( $updates ) {
-                       $site_stats = $dbw->tableName( 'site_stats' );
-                       $sql = $dbw->limitResultForUpdate("UPDATE $site_stats SET $updates", 1);
-                       $dbw->begin();
-                       $dbw->query( $sql, $fname );
-                       $dbw->commit();
+               // Count active users if need be
+               if ( $options['activeUsers'] ) {
+                       SiteStatsUpdate::cacheUpdate( wfGetDB( DB_MASTER ) );
                }
+       }
 
-               /*
-               global $wgDBname, $wgTitle;
-               if ( $this->mGood && $wgDBname == 'enwiki' ) {
-                       $good = $dbw->selectField( 'site_stats', 'ss_good_articles', '', $fname );
-                       error_log( $good . ' ' . $wgTitle->getPrefixedDBkey() . "\n", 3, '/home/wikipedia/logs/million.log' );
-               }
-               */
+       /**
+        * Refresh site_stats
+        */
+       public function refresh() {
+               $values = [
+                       '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 ),
+               ];
+
+               $dbw = wfGetDB( DB_MASTER );
+               $dbw->upsert( 'site_stats', $values, [ 'ss_row_id' ], $values, __METHOD__ );
        }
 }
-