LoggedUpdateMaintenance.php

Go to the documentation of this file.

<?php
namespace MediaWiki\Maintenance;
 
abstract class LoggedUpdateMaintenance extends Maintenance {
    public function __construct() {
        parent::__construct();
        $this->addOption( 'force', 'Run the update even if it was completed already' );
        $this->setBatchSize( 200 );
    }
 
    public function execute() {
        $db = $this->getPrimaryDB();
        $key = $this->getUpdateKey();
        $queryBuilder = $db->newSelectQueryBuilder()
            ->select( '1' )
            ->from( 'updatelog' )
            ->where( [ 'ul_key' => $key ] );
 
        if ( !$this->hasOption( 'force' )
            && $queryBuilder->caller( __METHOD__ )->fetchRow()
        ) {
            $this->output( "..." . $this->updateSkippedMessage() . "\n" );
 
            return true;
        }
 
        if ( !$this->doDBUpdates() ) {
            return false;
        }
 
        $db->newInsertQueryBuilder()
            ->insertInto( 'updatelog' )
            ->ignore()
            ->row( [ 'ul_key' => $key ] )
            ->caller( __METHOD__ )->execute();
 
        return true;
    }
 
    public function setForce( $forced = true ) {
        $this->setOption( 'force', $forced );
    }
 
    protected function updateSkippedMessage() {
        $key = $this->getUpdateKey();
 
        return "Update '{$key}' already logged as completed. Use --force to run it again.";
    }
 
    abstract protected function doDBUpdates();
 
    abstract protected function getUpdateKey();
}
 
class_alias( LoggedUpdateMaintenance::class, 'LoggedUpdateMaintenance' );