BasicTaskManager.php

Go to the documentation of this file.

<?php

namespace ILIAS\BackgroundTasks\Implementation\TaskManager;

use ILIAS\BackgroundTasks\Task\Job;
use ILIAS\BackgroundTasks\Task\UserInteraction;
use ILIAS\BackgroundTasks\Bucket;
use ILIAS\BackgroundTasks\Exceptions\Exception;
use ILIAS\BackgroundTasks\Implementation\Bucket\State;
use ILIAS\BackgroundTasks\Implementation\Tasks\UserInteraction\UserInteractionRequiredException;
use ILIAS\BackgroundTasks\Implementation\Tasks\UserInteraction\UserInteractionSkippedException;
use ILIAS\BackgroundTasks\Implementation\Values\ThunkValue;
use ILIAS\BackgroundTasks\Observer;
use ILIAS\BackgroundTasks\Persistence;
use ILIAS\BackgroundTasks\Task;
use ILIAS\BackgroundTasks\Task\UserInteraction\Option;
use ILIAS\BackgroundTasks\TaskManager;
use ILIAS\BackgroundTasks\Value;

abstract class BasicTaskManager implements TaskManager
{
    public function __construct(protected Persistence $persistence)
    {
    }

    public function executeTask(Task $task, Observer $observer): Value
    {
        $observer->notifyState(State::RUNNING);
        $values = $task->getInput();
        $final_values = [];
        $replace_thunk_values = false;
        foreach ($values as $value) {
            if ($value instanceof ThunkValue) {
                $value = $this->executeTask($value->getParentTask(), $observer);
                $replace_thunk_values = true;
            }
            $final_values[] = $value;
        }

        if ($replace_thunk_values) {
            $task->setInput($final_values);
        }

        if ($task instanceof Job) {
            $job = $task;
            $observer->notifyCurrentTask($job);
            $value = $job->run($final_values, $observer);
            if (!$value->getType()->isExtensionOf($job->getOutputType())) {
                throw new Exception("The job " . $job->getType()
                    . " did state to output a value of type "
                    . $job->getOutputType() . " but outputted a value of type "
                    . $value->getType());
            }
            $observer->notifyPercentage($job, 100);

            return $value;
        }

        if ($task instanceof UserInteraction) {
            $user_interaction = $task;

            if ($user_interaction->canBeSkipped($final_values)) {
                if ($task->isFinal()) {
                    throw new UserInteractionSkippedException('Final interaction skipped');
                }
                return $task->getSkippedValue($task->getInput());
            }

            $observer->notifyCurrentTask($user_interaction);
            $observer->notifyState(State::USER_INTERACTION);
            throw new UserInteractionRequiredException("User interaction required.");
        }

        throw new Exception("You need to execute a Job or a UserInteraction.");
    }

    public function continueTask(Bucket $bucket, Option $option): void
    {
        // We do the user interaction
        $bucket->userInteraction($option);
        if ($bucket->getState() != State::FINISHED) { // The job is not done after the user interaction, so we continue to run it.
            $this->run($bucket);
        } else {
            $this->persistence->deleteBucket($bucket);
        }
    }

    public function quitBucket(Bucket $bucket): void
    {
        $this->persistence->deleteBucket($bucket);
    }
}