UpdateCommand.php

Go to the documentation of this file.

<?php
/* Copyright (c) 2016 Richard Klees <richard.klees@concepts-and-training.de> Extended GPL, see docs/LICENSE */

namespace ILIAS\Setup\CLI;

use ILIAS\Setup\Agent;
use ILIAS\Setup\AgentCollection;
use ILIAS\Setup\ArrayEnvironment;
use ILIAS\Setup\Config;
use ILIAS\Setup\Environment;
use ILIAS\Setup\Objective;
use ILIAS\Setup\ObjectiveCollection;
use ILIAS\Setup\AchievementTracker;
use Symfony\Component\Console\Input\InputInterface;
use Symfony\Component\Console\Output\OutputInterface;
use Symfony\Component\Console\Input\InputOption;

class UpdateCommand extends BaseCommand
{
    protected static $defaultName = "update";

    public function configure()
    {
        parent::configure();
        $this
            ->setDescription("Updates an existing ILIAS installation")
            ->addOption("ignore-db-update-messages", null, InputOption::VALUE_NONE, "Ignore messages from the database update steps.");
    }

    protected function printIntroMessage(IOWrapper $io)
    {
        $io->title("Updating ILIAS");
    }

    protected function printOutroMessage(IOWrapper $io)
    {
        $io->success("Update complete. Thanks and have fun!");
    }

    protected function buildEnvironment(Agent $agent, ?Config $config, IOWrapper $io) : Environment
    {
        $environment = new ArrayEnvironment([
            Environment::RESOURCE_ADMIN_INTERACTION => $io,
            // TODO: This needs to be implemented correctly...
            Environment::RESOURCE_ACHIEVEMENT_TRACKER => new class implements AchievementTracker {
                public function trackAchievementOf(Objective $objective) : void
                {
                }
                public function isAchieved(Objective $objective) : bool
                {
                    return false;
                }
            }
        ]);

        if ($agent instanceof AgentCollection && $config) {
            foreach ($config->getKeys() as $k) {
                $environment = $environment->withConfigFor($k, $config->getConfig($k));
            }
        }

        return $environment;
    }

    public function execute(InputInterface $input, OutputInterface $output)
    {
        // ATTENTION: This is a hack to get around the usage of the echo/exit pattern in
        // the setup for the command line version of the setup. Do not use this.
        if ($input->hasOption("ignore-db-update-messages") && $input->getOption("ignore-db-update-messages")) {
            define("ILIAS_SETUP_IGNORE_DB_UPDATE_STEP_MESSAGES", true);
        }
        return parent::execute($input, $output);
    }

    protected function getObjective(Agent $agent, ?Config $config) : Objective
    {
        return new ObjectiveCollection(
            "Update ILIAS",
            false,
            $agent->getUpdateObjective($config)
        );
    }
}