TaskFactory.php

Go to the documentation of this file.

<?php
 
namespace MediaWiki\Installer\Task;
 
use Wikimedia\ObjectFactory\ObjectFactory;
 
class TaskFactory {
    public const PROFILE_INSTALLER = 'installer';
    public const PROFILE_ADD_WIKI = 'installPreConfigured';
    public const PROFILE_WEB_UPGRADE = 'web-upgrade';
 
    private const CORE_SPECS = [
        [ 'class' => ExtensionsProvider::class, 'profile' => self::PROFILE_INSTALLER ],
        [ 'class' => CreateDatabaseTask::class, 'db' => 'mysql' ],
        [ 'class' => MysqlCreateUserTask::class, 'db' => 'mysql' ],
        [ 'class' => CreateDatabaseTask::class, 'db' => 'postgres' ],
        [ 'class' => PostgresCreateUserTask::class, 'db' => 'postgres' ],
        [ 'class' => PostgresPlTask::class, 'db' => 'postgres' ],
        [ 'class' => PostgresCreateSchemaTask::class, 'db' => 'postgres' ],
        [ 'class' => SqliteCreateDatabaseTask::class, 'db' => 'sqlite' ],
        [ 'class' => SqliteCreateSearchIndexTask::class, 'db' => 'sqlite' ],
        [ 'class' => CreateTablesTask::class ],
        [ 'class' => PopulateSiteStatsTask::class ],
        [ 'class' => PopulateInterwikiTask::class ],
        [ 'class' => InsertUpdateKeysTask::class ],
        [ 'class' => RestoredServicesProvider::class, 'profile' => self::PROFILE_INSTALLER ],
        [ 'class' => AddWikiRestoredServicesProvider::class, 'profile' => self::PROFILE_ADD_WIKI ],
        [ 'class' => CreateExternalDomainsTask::class, 'profile' => self::PROFILE_ADD_WIKI ],
        [ 'class' => ExtensionTablesTask::class ],
        [ 'class' => InitialContentTask::class ],
        [ 'class' => CreateSysopTask::class, 'profile' => self::PROFILE_INSTALLER ],
        [ 'class' => MailingListSubscribeTask::class, 'profile' => self::PROFILE_INSTALLER ],
    ];
 
    private const WEB_UPGRADE_SPECS = [
        [ 'class' => WebUpgradeExtensionsProvider::class ],
        [ 'class' => RestoredServicesProvider::class ],
        [ 'class' => WebUpgradeTask::class ],
    ];
 
    private $objectFactory;
    private $context;
 
    public function __construct( ObjectFactory $objectFactory, ITaskContext $context ) {
        $this->objectFactory = $objectFactory;
        $this->context = $context;
    }
 
    public function registerMainTasks( TaskList $list, string $profile ) {
        $this->registerTasks( $list, $profile, self::CORE_SPECS );
    }
 
    public function registerExtensionTasks( TaskList $list, string $profile ) {
        $specs = $this->context->getProvision( 'ExtensionTaskSpecs' );
        if ( !is_array( $specs ) ) {
            throw new \RuntimeException( 'Invalid value for ExtensionTaskSpecs' );
        }
        $this->registerTasks( $list, $profile, $specs );
    }
 
    public function registerWebUpgradeTasks( TaskList $list ) {
        $this->registerTasks( $list, self::PROFILE_WEB_UPGRADE, self::WEB_UPGRADE_SPECS );
    }
 
    private function registerTasks( TaskList $list, string $profile, array $specs ) {
        $dbType = $this->context->getDbType();
        foreach ( $specs as $spec ) {
            if ( isset( $spec['db'] ) && $spec['db'] !== $dbType ) {
                continue;
            }
            if ( isset( $spec['profile'] ) && $spec['profile'] !== $profile ) {
                continue;
            }
            $list->add( $this->create( $spec ) );
        }
    }
 
    public function create( array $spec ): Task {
        if ( isset( $spec['callback'] ) ) {
            $task = new CallbackTask( $spec );
        } else {
            $allowedParamNames = [ 'factory', 'class', 'args' ];
            $factorySpec = array_intersect_key( $spec, array_fill_keys( $allowedParamNames, true ) );
            $task = $this->objectFactory->createObject( $factorySpec );
            if ( !( $task instanceof Task ) ) {
                throw new \RuntimeException( 'Invalid task type' );
            }
        }
 
        $schemaBasePath = $spec['schemaBasePath'] ?? $this->getCoreSchemaBasePath();
 
        $task->initBase(
            $this->context,
            $schemaBasePath,
        );
        return $task;
    }
 
    private function getCoreSchemaBasePath() {
        return MW_INSTALL_PATH . '/sql';
    }
}