characterEditStats.php

Go to the documentation of this file.

<?php
// Standard boilerplate to define $IP
use MediaWiki\Extension\Translate\MessageLoading\MessageHandle;
use MediaWiki\Extension\Translate\SystemUsers\FuzzyBot;
use MediaWiki\MediaWikiServices;
use MediaWiki\Title\Title;
 
if ( getenv( 'MW_INSTALL_PATH' ) !== false ) {
    $IP = getenv( 'MW_INSTALL_PATH' );
} else {
    $dir = __DIR__;
    $IP = "$dir/../../..";
}
require_once "$IP/maintenance/Maintenance.php";
 
class CharacterEditStats extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Script to show number of characters translated .' );
        $this->addOption(
            'top',
            '(optional) Show given number of language codes (default: show all)',
            false, /*required*/
            true /*has arg*/
        );
        $this->addOption(
            'days',
            '(optional) Calculate for given number of days (default: 30)',
            false, /*required*/
            true /*has arg*/
        );
        $this->addOption(
            'ns',
            '(optional) Comma separated list of namespace IDs',
            false, /*required*/
            true /*has arg*/
        );
        $this->requireExtension( 'Translate' );
    }
 
    public function execute() {
        global $wgSitename, $wgTranslateMessageNamespaces;
 
        $days = (int)$this->getOption( 'days', 30 );
        $top = (int)$this->getOption( 'top', -1 );
 
        $namespaces = [];
        if ( $this->hasOption( 'ns' ) ) {
            $input = explode( ',', $this->getOption( 'ns' ) );
 
            foreach ( $input as $namespace ) {
                if ( is_numeric( $namespace ) ) {
                    $namespaces[] = $namespace;
                }
            }
        } else {
            $namespaces = $wgTranslateMessageNamespaces;
        }
 
        // Select set of edits to report on
        $rows = $this->getRevisionsFromHistory( $days, $namespaces );
 
        // Get counts for edits per language code after filtering out edits by FuzzyBot
        $codes = [];
 
        foreach ( $rows as $_ ) {
            // Filter out edits by FuzzyBot
            if ( $_->user_text === FuzzyBot::getName() ) {
                continue;
            }
 
            $handle = new MessageHandle( Title::newFromText( $_->title ) );
            $code = $handle->getCode();
 
            if ( !isset( $codes[$code] ) ) {
                $codes[$code] = 0;
            }
 
            $codes[$code] += $_->length;
        }
 
        // Sort counts and report descending up to $top rows.
        arsort( $codes );
        $i = 0;
        $total = 0;
        $this->output( "Character edit stats for last $days days in $wgSitename\n" );
        $this->output( "code\tname\tedit\n" );
        $this->output( "-----------------------\n" );
        $languageNameUtils = MediaWikiServices::getInstance()->getLanguageNameUtils();
        foreach ( $codes as $code => $num ) {
            if ( $i++ === $top ) {
                break;
            }
            $language = $languageNameUtils->getLanguageName( $code );
            if ( !$language ) {
                // this will be very rare, but avoid division by zero in next line
                continue;
            }
            $charRatio = mb_strlen( $language, 'UTF-8' ) / strlen( $language );
            $num = (int)( $num * $charRatio );
            $total += $num;
            $this->output( "$code\t$language\t$num\n" );
        }
        $this->output( "-----------------------\n" );
        $this->output( "Total\t\t$total\n" );
    }
 
    private function getRevisionsFromHistory( $days, array $namespaces ) {
        $dbr = MediaWikiServices::getInstance()->getDBLoadBalancer()->getConnection( DB_REPLICA );
        $cutoff = $dbr->addQuotes( $dbr->timestamp( time() - $days * 24 * 3600 ) );
 
        $revisionStore = MediaWikiServices::getInstance()->getRevisionStore();
        $result = $revisionStore->newSelectQueryBuilder( $dbr )
            ->select(
                [
                    'title' => 'page_title',
                    'user_text' => 'actor_rev_user.actor_name',
                    'length' => 'rev_len',
                ]
            )
            ->joinPage()
            ->where( [
                "rev_timestamp > $cutoff",
                'page_namespace' => $namespaces,
            ] )
            ->caller( __METHOD__ )
            ->fetchResultSet();
        return iterator_to_array( $result );
    }
}
 
$maintClass = CharacterEditStats::class;
require_once RUN_MAINTENANCE_IF_MAIN;