SiteStats.php

Go to the documentation of this file.

<?php
use Wikimedia\Rdbms\Database;
use Wikimedia\Rdbms\IDatabase;
use MediaWiki\MediaWikiServices;
 
class SiteStats {
    private static $row;
 
    private static $loaded = false;
 
    private static $pageCount = [];
 
    static function unload() {
        self::$loaded = false;
    }
 
    static function recache() {
        self::load( true );
    }
 
    static function load( $recache = false ) {
        if ( self::$loaded && !$recache ) {
            return;
        }
 
        self::$row = self::loadAndLazyInit();
 
        # This code is somewhat schema-agnostic, because I'm changing it in a minor release -- TS
        if ( !isset( self::$row->ss_total_pages ) && self::$row->ss_total_pages == -1 ) {
            # Update schema
            $u = new SiteStatsUpdate( 0, 0, 0 );
            $u->doUpdate();
            self::$row = self::doLoad( wfGetDB( DB_REPLICA ) );
        }
 
        self::$loaded = true;
    }
 
    static function loadAndLazyInit() {
        global $wgMiserMode;
 
        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 ( !$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" );
 
            SiteStatsInit::doAllAndCommit( wfGetDB( DB_REPLICA ) );
 
            $row = self::doLoad( wfGetDB( DB_MASTER ) );
        }
 
        if ( !self::isSane( $row ) ) {
            wfDebug( __METHOD__ . ": site_stats persistently nonsensical o_O\n" );
        }
 
        return $row;
    }
 
    static function doLoad( $db ) {
        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__ );
    }
 
    static function views() {
        wfDeprecated( __METHOD__, '1.25' );
        return 0;
    }
 
    static function edits() {
        self::load();
        return self::$row->ss_total_edits;
    }
 
    static function articles() {
        self::load();
        return self::$row->ss_good_articles;
    }
 
    static function pages() {
        self::load();
        return self::$row->ss_total_pages;
    }
 
    static function users() {
        self::load();
        return self::$row->ss_users;
    }
 
    static function activeUsers() {
        self::load();
        return self::$row->ss_active_users;
    }
 
    static function images() {
        self::load();
        return self::$row->ss_images;
    }
 
    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 ]
        );
    }
 
    static function 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 ]
        );
    }
 
    static function pagesInNs( $ns ) {
        if ( !isset( self::$pageCount[$ns] ) ) {
            $dbr = wfGetDB( DB_REPLICA );
            self::$pageCount[$ns] = (int)$dbr->selectField(
                'page',
                'COUNT(*)',
                [ 'page_namespace' => $ns ],
                __METHOD__
            );
        }
        return self::$pageCount[$ns];
    }
 
    private static function isSane( $row ) {
        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 ( [
            'ss_total_edits',
            'ss_good_articles',
            'ss_total_pages',
            'ss_users',
            'ss_images',
        ] as $member ) {
            if ( $row->$member > 2000000000 || $row->$member < 0 ) {
                return false;
            }
        }
        return true;
    }
}
 
class SiteStatsInit {
 
    // Database connection
    private $db;
 
    // Various stats
    private $mEdits = null, $mArticles = null, $mPages = null;
    private $mUsers = null, $mFiles = null;
 
    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' );
        }
    }
 
    public function edits() {
        $this->mEdits = $this->db->selectField( 'revision', 'COUNT(*)', '', __METHOD__ );
        $this->mEdits += $this->db->selectField( 'archive', 'COUNT(*)', '', __METHOD__ );
        return $this->mEdits;
    }
 
    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;
    }
 
    public function pages() {
        $this->mPages = $this->db->selectField( 'page', 'COUNT(*)', '', __METHOD__ );
        return $this->mPages;
    }
 
    public function users() {
        $this->mUsers = $this->db->selectField( 'user', 'COUNT(*)', '', __METHOD__ );
        return $this->mUsers;
    }
 
    public function files() {
        $this->mFiles = $this->db->selectField( 'image', 'COUNT(*)', '', __METHOD__ );
        return $this->mFiles;
    }
 
    public static function doAllAndCommit( $database, array $options = [] ) {
        $options += [ 'update' => false, 'activeUsers' => false ];
 
        // Grab the object and count everything
        $counter = new SiteStatsInit( $database );
 
        $counter->edits();
        $counter->articles();
        $counter->pages();
        $counter->users();
        $counter->files();
 
        $counter->refresh();
 
        // Count active users if need be
        if ( $options['activeUsers'] ) {
            SiteStatsUpdate::cacheUpdate( wfGetDB( DB_MASTER ) );
        }
    }
 
    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__ );
    }
}