wikimedia/mediawiki-extensions-Wikibase

<?php

declare( strict_types=1 );

namespace Wikibase;

use MediaWiki\Maintenance\Maintenance;
use Onoi\MessageReporter\CallbackMessageReporter;
use Wikibase\Client\Store\Sql\BulkSubscriptionUpdater;
use Wikibase\Client\WikibaseClient;
use Wikibase\DataModel\Entity\EntityIdParsingException;
use Wikibase\Lib\WikibaseSettings;

$basePath = getenv( 'MW_INSTALL_PATH' ) !== false
    ? getenv( 'MW_INSTALL_PATH' )
    : __DIR__ . '/../../../..';

require_once $basePath . '/maintenance/Maintenance.php';

/**
 * Maintenance script for inserting subscriptions into wb_changes_subscription based on the
 * wbc_entity_usage table.
 *
 * @license GPL-2.0-or-later
 * @author Daniel Kinzler
 */
class UpdateSubscriptions extends Maintenance {

    public function __construct() {
        parent::__construct();

        $this->addDescription( 'Updates the repo\'s wb_changes_subscription table based on entries'
            . ' in wbc_entity_usage.' );

        $this->addOption( 'start-item', "The entity ID to start from.", false, true );
        $this->addOption(
            'purge',
            'Purge subscriptions first. If not given, subscriptions are only added, not removed.',
            false,
            false
        );

        $this->setBatchSize( 1000 );
    }

    /**
     * @see Maintenance::execute
     *
     * @throws EntityIdParsingException
     */
    public function execute(): bool {
        if ( !WikibaseSettings::isClientEnabled() ) {
            $this->fatalError(
                'You need to have WikibaseClient enabled in order to use this maintenance script!'
            );
        }

        $settings = WikibaseClient::getSettings();
        $clientId = $settings->getSetting( 'siteGlobalID' );

        $idParser = WikibaseClient::getEntityIdParser();
        $startItemOption = $this->getOption( 'start-item' );

        $startItem = $startItemOption === null ? null : $idParser->parse( $startItemOption );

        $reporter = new CallbackMessageReporter( [ $this, 'report' ] );

        $clientDb = WikibaseClient::getClientDomainDbFactory()->newLocalDb();
        $repoDb = WikibaseClient::getRepoDomainDbFactory()->newRepoDb();
        $updater = new BulkSubscriptionUpdater(
            $clientDb,
            $repoDb,
            $clientId,
            $this->mBatchSize
        );

        $updater->setProgressReporter( $reporter );

        if ( $this->getOption( 'purge' ) ) {
            $updater->purgeSubscriptions( $startItem );
        }

        $updater->updateSubscriptions( $startItem );
        return true;
    }

    /**
     * Outputs a message vis the output() method.
     */
    public function report( string $msg ) {
        $this->output( "$msg\n" );
    }

}

$maintClass = UpdateSubscriptions::class;
require_once RUN_MAINTENANCE_IF_MAIN;