populateChangeTagDef.php

Go to the documentation of this file.

<?php
require_once __DIR__ . '/Maintenance.php';
 
class PopulateChangeTagDef extends LoggedUpdateMaintenance {
    protected $lbFactory;
 
    public function __construct() {
        parent::__construct();
        $this->addDescription( 'Populate and improve accuracy of change_tag_def statistics' );
        $this->addOption( 'dry-run', 'Print debug info instead of actually deleting' );
        $this->setBatchSize( 1000 );
        $this->addOption(
            'sleep',
            'Sleep time (in seconds) between every batch, defaults to zero',
            false,
            true
        );
        $this->addOption( 'populate-only', 'Do not update change_tag_def table' );
        $this->addOption( 'set-user-tags-only', 'Only update ctd_user_defined from valid_tag table' );
    }
 
    public function execute() {
        global $wgChangeTagsSchemaMigrationStage;
        if ( $wgChangeTagsSchemaMigrationStage === MIGRATION_OLD ) {
            // Return "success", but don't flag it as done so the next run will retry
            $this->output( '... Not run, $wgChangeTagsSchemaMigrationStage === MIGRATION_OLD' . "\n" );
            return true;
        }
        return parent::execute();
    }
 
    protected function doDBUpdates() {
        $this->lbFactory = MediaWiki\MediaWikiServices::getInstance()->getDBLoadBalancerFactory();
        $this->setBatchSize( $this->getOption( 'batch-size', $this->getBatchSize() ) );
 
        if ( $this->lbFactory->getMainLB()->getConnection( DB_REPLICA )->fieldExists(
                'change_tag',
                'ct_tag',
                __METHOD__
            )
        ) {
            if ( $this->hasOption( 'set-user-tags-only' ) ) {
                $this->setUserDefinedTags();
                return true;
            }
            if ( !$this->hasOption( 'populate-only' ) ) {
                $this->updateCountTag();
            }
            $this->backpopulateChangeTagId();
            $this->setUserDefinedTags();
        } else {
            $this->updateCountTagId();
        }
 
        // TODO: Implement
        // $this->cleanZeroCountRows();
 
        return true;
    }
 
    private function setUserDefinedTags() {
        $dbr = $this->lbFactory->getMainLB()->getConnection( DB_REPLICA );
 
        $userTags = $dbr->selectFieldValues(
            'valid_tag',
            'vt_tag',
            [],
            __METHOD__
        );
 
        if ( empty( $userTags ) ) {
            $this->output( "No user defined tags to set, moving on...\n" );
            return;
        }
 
        if ( $this->hasOption( 'dry-run' ) ) {
            $this->output(
                'These tags will have ctd_user_defined=1 : ' . implode( ', ', $userTags ) . "\n"
            );
            return;
        }
 
        $dbw = $this->lbFactory->getMainLB()->getConnection( DB_MASTER );
 
        $dbw->update(
            'change_tag_def',
            [ 'ctd_user_defined' => 1 ],
            [ 'ctd_name' => $userTags ],
            __METHOD__
        );
        $this->lbFactory->waitForReplication();
        $this->output( "Finished setting user defined tags in change_tag_def table\n" );
    }
 
    private function updateCountTagId() {
        $dbr = $this->lbFactory->getMainLB()->getConnection( DB_REPLICA );
 
        // This query can be pretty expensive, don't run it on master
        $res = $dbr->select(
            'change_tag',
            [ 'ct_tag_id', 'hitcount' => 'count(*)' ],
            [],
            __METHOD__,
            [ 'GROUP BY' => 'ct_tag_id' ]
        );
 
        $dbw = $this->lbFactory->getMainLB()->getConnection( DB_MASTER );
 
        foreach ( $res as $row ) {
            if ( !$row->ct_tag_id ) {
                continue;
            }
 
            if ( $this->hasOption( 'dry-run' ) ) {
                $this->output( 'This row will be updated: ' . implode( ', ', $row ) . "\n" );
                continue;
            }
 
            $dbw->update(
                'change_tag_def',
                [ 'ctd_count' => $row->hitcount ],
                [ 'ctd_id' => $row->ct_tag_id ],
                __METHOD__
            );
        }
        $this->lbFactory->waitForReplication();
    }
 
    private function updateCountTag() {
        $dbr = $this->lbFactory->getMainLB()->getConnection( DB_REPLICA );
 
        // This query can be pretty expensive, don't run it on master
        $res = $dbr->select(
            'change_tag',
            [ 'ct_tag', 'hitcount' => 'count(*)' ],
            [],
            __METHOD__,
            [ 'GROUP BY' => 'ct_tag' ]
        );
 
        $dbw = $this->lbFactory->getMainLB()->getConnection( DB_MASTER );
 
        foreach ( $res as $row ) {
            // Hygiene check
            if ( !$row->ct_tag ) {
                continue;
            }
 
            if ( $this->hasOption( 'dry-run' ) ) {
                $this->output( 'This row will be updated: ' . $row->ct_tag . $row->hitcount . "\n" );
                continue;
            }
 
            $dbw->upsert(
                'change_tag_def',
                [
                    'ctd_name' => $row->ct_tag,
                    'ctd_user_defined' => 0,
                    'ctd_count' => $row->hitcount
                ],
                [ 'ctd_name' ],
                [ 'ctd_count' => $row->hitcount ],
                __METHOD__
            );
        }
        $this->lbFactory->waitForReplication();
    }
 
    private function backpopulateChangeTagId() {
        $dbr = $this->lbFactory->getMainLB()->getConnection( DB_REPLICA );
        $changeTagDefs = $dbr->select(
            'change_tag_def',
            [ 'ctd_name', 'ctd_id' ],
            [],
            __METHOD__,
            [ 'ORDER BY' => 'ctd_id' ]
        );
 
        foreach ( $changeTagDefs as $row ) {
            $this->backpopulateChangeTagPerTag( $row->ctd_name, $row->ctd_id );
        }
    }
 
    private function backpopulateChangeTagPerTag( $tagName, $tagId ) {
        $dbr = $this->lbFactory->getMainLB()->getConnection( DB_REPLICA );
        $dbw = $this->lbFactory->getMainLB()->getConnection( DB_MASTER );
        $sleep = (int)$this->getOption( 'sleep', 0 );
        $lastId = 0;
        $this->output( "Starting to add ct_tag_id = {$tagId} for ct_tag = {$tagName}\n" );
        while ( true ) {
            // Given that indexes might not be there, it's better to use replica
            $ids = $dbr->selectFieldValues(
                'change_tag',
                'ct_id',
                [ 'ct_tag' => $tagName, 'ct_tag_id' => null, 'ct_id > ' . $lastId ],
                __METHOD__,
                [ 'LIMIT' => $this->getBatchSize(), 'ORDER BY' => 'ct_id' ]
            );
 
            if ( !$ids ) {
                break;
            }
            $lastId = end( $ids );
 
            if ( $this->hasOption( 'dry-run' ) ) {
                $this->output(
                    "These ids will be changed to have \"{$tagId}\" as tag id: " . implode( ', ', $ids ) . "\n"
                );
                continue;
            } else {
                $this->output( "Updating ct_tag_id = {$tagId} up to row ct_id = {$lastId}\n" );
            }
 
            $dbw->update(
                'change_tag',
                [ 'ct_tag_id' => $tagId ],
                [ 'ct_id' => $ids ],
                __METHOD__
            );
 
            $this->lbFactory->waitForReplication();
            if ( $sleep > 0 ) {
                sleep( $sleep );
            }
        }
 
        $this->output( "Finished adding ct_tag_id = {$tagId} for ct_tag = {$tagName}\n" );
    }
 
    protected function getUpdateKey() {
        return __CLASS__;
    }
}
 
$maintClass = PopulateChangeTagDef::class;
require_once RUN_MAINTENANCE_IF_MAIN;