BasicBucket.php

Go to the documentation of this file.

<?php

namespace ILIAS\BackgroundTasks\Implementation\Bucket;

use ILIAS\BackgroundTasks\Exceptions\Exception;
use ILIAS\BackgroundTasks\Implementation\Values\ThunkValue;
use ILIAS\BackgroundTasks\Bucket;
use ILIAS\BackgroundTasks\Task;
use ILIAS\BackgroundTasks\Task\UserInteraction\Option;
use ILIAS\BackgroundTasks\Value;

class BasicBucket implements Bucket
{

    protected $userId;
    protected $rootTask;
    protected $currentTask;
    protected $tasks;
    protected $state;
    protected $totalNumberOfTasks;
    protected $percentages = [];
    protected $title = "";
    protected $description = "";
    protected $percentage = 0;
    protected $lastHeartbeat = 0;


    public function getUserId()
    {
        return $this->userId;
    }


    public function setUserId($user_id)
    {
        $this->userId = $user_id;

        return $this;
    }


    public function setPercentage(Task $task, $percentage)
    {
        $this->percentages[spl_object_hash($task)] = $percentage;
        $this->calculateOverallPercentage();
    }


    public function setOverallPercentage($percentage)
    {
        $this->percentage = $percentage;
    }


    public function setCurrentTask($task)
    {
        $this->currentTask = $task;
    }


    public function setTask(Task $task)
    {
        $this->tasks = $task->unfoldTask();
        $this->totalNumberOfTasks = count($this->tasks);
        $this->rootTask = $task;
        foreach ($this->tasks as $subTask) {
            $this->percentages[spl_object_hash($subTask)] = 0;
        }
    }


    public function calculateOverallPercentage()
    {
        $countable_tasks = 0;
        foreach ($this->tasks as $task) {
            switch (true) {
                case ($task instanceof Task\Job):
                    $countable_tasks++;
                    break;
            }
        }

        $this->percentage = array_sum($this->percentages) / $countable_tasks;
    }


    public function getOverallPercentage()
    {
        return $this->percentage;
    }


    public function setState($state)
    {
        $this->state = $state;
    }


    public function getCurrentTask()
    {
        return $this->currentTask;
    }


    public function getTask()
    {
        return $this->rootTask;
    }


    public function getState()
    {
        return $this->state;
    }


    public function checkIntegrity()
    {
        if (!$this->getUserId()) {
            foreach ($this->getTask()->unfoldTask() as $task) {
                if ($task instanceof Task\UserInteraction) {
                    throw new Exception("Your task contains user interactions and thus needs a user that observes the task.");
                }
            }
        }

        return true;
    }


    public function userInteraction(Option $option)
    {
        $currentTask = $this->getCurrentTask();

        if ($this->getState() != State::USER_INTERACTION) {
            throw new Exception("Cannot continue a task that is not in the state 'user interaction'");
        }
        if (!$currentTask instanceof Task\UserInteraction) {
            // TODO: Maybe cleanup task?
            throw new Exception("Observer is in an invalid state! state: userInteraction but current task is not a user interaction!");
        }

        // From the current task we do the interaction.
        $inputs = $currentTask->getInput();
        $resulting_value = $currentTask->interaction($inputs, $option, $this);

        if ($currentTask === $this->rootTask) {
            // If this user interaction was the last thing to do, we set the state to finished. We can throw away the resulting value.
            $this->setState(State::FINISHED);
        } else {
            // Then we replace the thunk value with the resulting value.
            $this->replaceThunkValue($currentTask, $resulting_value);
        }
    }


    protected function replaceThunkValue(Task $currentTask, Value $resulting_value)
    {
        $tasks = $this->getTask()->unfoldTask();

        foreach ($tasks as $task) {
            $newInputs = [];
            foreach ($task->getInput() as $input) {
                if ($input instanceof ThunkValue && $input->getParentTask() === $currentTask) {
                    $newInputs[] = $resulting_value;
                } else {
                    $newInputs[] = $input;
                }
            }
            $task->setInput($newInputs);
        }
    }


    public function getTitle()
    {
        return $this->title;
    }


    public function setTitle($title)
    {
        $this->title = $title;
    }


    public function getDescription()
    {
        return $this->description;
    }


    public function setDescription($description)
    {
        $this->description = $description;
    }


    public function heartbeat()
    {
        $timezone_identifier = ini_get('date.timezone');
        date_default_timezone_set($timezone_identifier ? $timezone_identifier : 'UTC');
        $now = new \DateTime();
        $this->lastHeartbeat = $now->getTimestamp();
    }


    public function setLastHeartbeat($timestamp)
    {
        $this->lastHeartbeat = $timestamp;
    }


    public function getLastHeartbeat()
    {
        return $this->lastHeartbeat;
    }
}