MediaWiki/includes/SiteStatsInit.php

<?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
 */
use Wikimedia\Rdbms\IDatabase;
use MediaWiki\MediaWikiServices;

/**
 * Class designed for counting of stats.
 */
class SiteStatsInit {
	/* @var IDatabase */
	private $dbr;
	/** @var int */
	private $edits;
	/** @var int */
	private $articles;
	/** @var int */
	private $pages;
	/** @var int */
	private $users;
	/** @var int */
	private $files;

	/**
	 * @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->dbr = $database;
		} elseif ( $database ) {
			$this->dbr = self::getDB( DB_MASTER );
		} else {
			$this->dbr = self::getDB( DB_REPLICA, 'vslow' );
		}
	}

	/**
	 * Count the total number of edits
	 * @return int
	 */
	public function edits() {
		$this->edits = $this->dbr->selectField( 'revision', 'COUNT(*)', '', __METHOD__ );
		$this->edits += $this->dbr->selectField( 'archive', 'COUNT(*)', '', __METHOD__ );

		return $this->edits;
	}

	/**
	 * Count pages in article space(s)
	 * @return int
	 */
	public function articles() {
		$config = MediaWikiServices::getInstance()->getMainConfig();

		$tables = [ 'page' ];
		$conds = [
			'page_namespace' => MWNamespace::getContentNamespaces(),
			'page_is_redirect' => 0,
		];

		if ( $config->get( 'ArticleCountMethod' ) == 'link' ) {
			$tables[] = 'pagelinks';
			$conds[] = 'pl_from=page_id';
		}

		$this->articles = $this->dbr->selectField(
			$tables,
			'COUNT(DISTINCT page_id)',
			$conds,
			__METHOD__
		);

		return $this->articles;
	}

	/**
	 * Count total pages
	 * @return int
	 */
	public function pages() {
		$this->pages = $this->dbr->selectField( 'page', 'COUNT(*)', '', __METHOD__ );

		return $this->pages;
	}

	/**
	 * Count total users
	 * @return int
	 */
	public function users() {
		$this->users = $this->dbr->selectField( 'user', 'COUNT(*)', '', __METHOD__ );

		return $this->users;
	}

	/**
	 * Count total files
	 * @return int
	 */
	public function files() {
		$this->files = $this->dbr->selectField( 'image', 'COUNT(*)', '', __METHOD__ );

		return $this->files;
	}

	/**
	 * 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 ];

		// Grab the object and count everything
		$counter = new self( $database );

		$counter->edits();
		$counter->articles();
		$counter->pages();
		$counter->users();
		$counter->files();

		$counter->refresh();

		// Count active users if need be
		if ( $options['activeUsers'] ) {
			SiteStatsUpdate::cacheUpdate( self::getDB( DB_MASTER ) );
		}
	}

	/**
	 * Insert a dummy row with all zeroes if no row is present
	 */
	public static function doPlaceholderInit() {
		$dbw = self::getDB( DB_MASTER );
		$exists = $dbw->selectField( 'site_stats', '1', [ 'ss_row_id' => 1 ],  __METHOD__ );
		if ( $exists === false ) {
			$dbw->insert(
				'site_stats',
				[ 'ss_row_id' => 1 ] + array_fill_keys( SiteStats::selectFields(), 0 ),
				__METHOD__,
				[ 'IGNORE' ]
			);
		}
	}

	/**
	 * Refresh site_stats
	 */
	public function refresh() {
		$values = [
			'ss_row_id' => 1,
			'ss_total_edits' => $this->edits === null ? $this->edits() : $this->edits,
			'ss_good_articles' => $this->articles === null ? $this->articles() : $this->articles,
			'ss_total_pages' => $this->pages === null ? $this->pages() : $this->pages,
			'ss_users' => $this->users === null ? $this->users() : $this->users,
			'ss_images' => $this->files === null ? $this->files() : $this->files,
		];

		self::getDB( DB_MASTER )->upsert(
			'site_stats',
			$values,
			[ 'ss_row_id' ],
			$values,
			__METHOD__
		);
	}

	/**
	 * @param int $index
	 * @param string[] $groups
	 * @return IDatabase
	 */
	private static function getDB( $index, $groups = [] ) {
		$lb = MediaWikiServices::getInstance()->getDBLoadBalancer();

		return $lb->getConnection( $index, $groups );
	}
}