wikimedia/mediawiki-core

<?php
/**
 * 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
 */

namespace MediaWiki\Deferred;

use MediaWiki\MainConfigNames;
use MediaWiki\MediaWikiServices;
use MediaWiki\SiteStats\SiteStats;
use UnexpectedValueException;
use Wikimedia\Assert\Assert;
use Wikimedia\Rdbms\IDatabase;
use Wikimedia\Rdbms\RawSQLValue;

/**
 * Class for handling updates to the site_stats table
 */
class SiteStatsUpdate implements DeferrableUpdate, MergeableUpdate {
    /** @var int */
    protected $edits = 0;
    /** @var int */
    protected $pages = 0;
    /** @var int */
    protected $articles = 0;
    /** @var int */
    protected $users = 0;
    /** @var int */
    protected $images = 0;

    private const SHARDS_OFF = 1;
    public const SHARDS_ON = 10;

    /** @var string[] Map of (table column => counter type) */
    private const COUNTERS = [
        'ss_total_edits'   => 'edits',
        'ss_total_pages'   => 'pages',
        'ss_good_articles' => 'articles',
        'ss_users'         => 'users',
        'ss_images'        => 'images'
    ];

    /**
     * @deprecated since 1.39 Use SiteStatsUpdate::factory() instead.
     */
    public function __construct( $views, $edits, $good, $pages = 0, $users = 0 ) {
        $this->edits = $edits;
        $this->articles = $good;
        $this->pages = $pages;
        $this->users = $users;
    }

    public function merge( MergeableUpdate $update ) {
        /** @var SiteStatsUpdate $update */
        Assert::parameterType( __CLASS__, $update, '$update' );
        '@phan-var SiteStatsUpdate $update';

        foreach ( self::COUNTERS as $field ) {
            $this->$field += $update->$field;
        }
    }

    /**
     * @param int[] $deltas Map of (counter type => integer delta) e.g.
     *         ```
     *         SiteStatsUpdate::factory( [
     *            'edits'    => 10,
     *            'articles' => 2,
     *            'pages'    => 7,
     *            'users'    => 5,
     *        ] );
     *         ```
     * @return SiteStatsUpdate
     * @throws UnexpectedValueException
     */
    public static function factory( array $deltas ) {
        $update = new self( 0, 0, 0 );

        foreach ( $deltas as $name => $unused ) {
            if ( !in_array( $name, self::COUNTERS ) ) { // T187585
                throw new UnexpectedValueException( __METHOD__ . ": no field called '$name'" );
            }
        }

        foreach ( self::COUNTERS as $field ) {
            $update->$field = $deltas[$field] ?? 0;
        }

        return $update;
    }

    public function doUpdate() {
        $services = MediaWikiServices::getInstance();
        $metric = $services->getStatsFactory()->getCounter( 'site_stats_total' );
        $shards = $services->getMainConfig()->get( MainConfigNames::MultiShardSiteStats ) ?
            self::SHARDS_ON : self::SHARDS_OFF;

        $deltaByType = [];
        foreach ( self::COUNTERS as $type ) {
            $delta = $this->$type;
            if ( $delta !== 0 ) {
                $metric->setLabel( 'engagement', $type )
                    ->copyToStatsdAt( "site.$type" )
                    ->incrementBy( $delta );
            }
            $deltaByType[$type] = $delta;
        }

        ( new AutoCommitUpdate(
            $services->getConnectionProvider()->getPrimaryDatabase(),
            __METHOD__,
            static function ( IDatabase $dbw, $fname ) use ( $deltaByType, $shards ) {
                $set = [];
                $initValues = [];
                if ( $shards > 1 ) {
                    $shard = mt_rand( 1, $shards );
                } else {
                    $shard = 1;
                }

                $hasNegativeDelta = false;
                foreach ( self::COUNTERS as $field => $type ) {
                    $delta = (int)$deltaByType[$type];
                    $initValues[$field] = $delta;
                    if ( $delta > 0 ) {
                        $set[$field] = new RawSQLValue( $dbw->buildGreatest(
                            [ $field => $dbw->addIdentifierQuotes( $field ) . '+' . abs( $delta ) ],
                            0
                        ) );
                    } elseif ( $delta < 0 ) {
                        $hasNegativeDelta = true;
                        $set[$field] = new RawSQLValue( $dbw->buildGreatest(
                            [ 'new' => $dbw->addIdentifierQuotes( $field ) . '-' . abs( $delta ) ],
                            0
                        ) );
                    }
                }

                if ( $set ) {
                    if ( $hasNegativeDelta ) {
                        $dbw->newUpdateQueryBuilder()
                            ->update( 'site_stats' )
                            ->set( $set )
                            ->where( [ 'ss_row_id' => $shard ] )
                            ->caller( $fname )->execute();
                    } else {
                        $dbw->newInsertQueryBuilder()
                            ->insertInto( 'site_stats' )
                            ->row( array_merge( [ 'ss_row_id' => $shard ], $initValues ) )
                            ->onDuplicateKeyUpdate()
                            ->uniqueIndexFields( [ 'ss_row_id' ] )
                            ->set( $set )
                            ->caller( $fname )->execute();
                    }
                }
            }
        ) )->doUpdate();

        // Invalidate cache used by parser functions
        SiteStats::unload();
    }

    /**
     * @param IDatabase $dbw
     * @return bool|mixed
     */
    public static function cacheUpdate( IDatabase $dbw ) {
        $services = MediaWikiServices::getInstance();
        $config = $services->getMainConfig();

        $dbr = $services->getConnectionProvider()->getReplicaDatabase( false, 'vslow' );
        # Get non-bot users than did some recent action other than making accounts.
        # If account creation is included, the number gets inflated ~20+ fold on enwiki.
        $activeUsers = $dbr->newSelectQueryBuilder()
            ->select( 'COUNT(DISTINCT rc_actor)' )
            ->from( 'recentchanges' )
            ->join( 'actor', 'actor', 'actor_id=rc_actor' )
            ->where( [
                $dbr->expr( 'rc_type', '!=', RC_EXTERNAL ), // Exclude external (Wikidata)
                $dbr->expr( 'actor_user', '!=', null ),
                $dbr->expr( 'rc_bot', '=', 0 ),
                $dbr->expr( 'rc_log_type', '!=', 'newusers' )->or( 'rc_log_type', '=', null ),
                $dbr->expr( 'rc_timestamp', '>=',
                    $dbr->timestamp( time() - $config->get( MainConfigNames::ActiveUserDays ) * 24 * 3600 ) )
            ] )
            ->caller( __METHOD__ )
            ->fetchField();
        $dbw->newUpdateQueryBuilder()
            ->update( 'site_stats' )
            ->set( [ 'ss_active_users' => intval( $activeUsers ) ] )
            ->where( [ 'ss_row_id' => 1 ] )
            ->caller( __METHOD__ )->execute();

        // Invalid cache used by parser functions
        SiteStats::unload();

        return $activeUsers;
    }
}

/** @deprecated class alias since 1.42 */
class_alias( SiteStatsUpdate::class, 'SiteStatsUpdate' );