ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager Class Reference

Inheritance diagram for ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager:

Collaboration diagram for ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager:

Public Member Functions
	run (Bucket $bucket)
	This will add an Observer of the Task and start running the task. More...
	runAsync ()
Public Member Functions inherited from ILIAS\BackgroundTasks\Implementation\TaskManager\BasicTaskManager
	__construct (protected Persistence $persistence)
	continueTask (Bucket $bucket, Option $option)
	Continue a task with a given option. More...
	quitBucket (Bucket $bucket)
Public Member Functions inherited from ILIAS\BackgroundTasks\TaskManager
	executeTask (Task $task, Observer $observer)
	Actually executes a task. More...
	run (Bucket $bucket)
	Depending on your background task settings, executes or puts the task into the queue. More...
	continueTask (Bucket $bucket, Option $option)
	Continue a task that is the state UserInteraction with a given option. More...
	quitBucket (Bucket $bucket)
	Quits and deletes a Bucket with all it's Jobs. More...

Data Fields
const	CMD_START_WORKER = 'startBackgroundTaskWorker'

Detailed Description

Definition at line 26 of file AsyncTaskManager.php.

Member Function Documentation

run()

ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager::run

(

Bucket

$bucket

)

This will add an Observer of the Task and start running the task.

Exceptions

Definition at line 34 of file AsyncTaskManager.php.

References ILIAS\$client_id, $DIC, CLIENT_ID, ILIAS\BackgroundTasks\Bucket\getTask(), null, ILIAS\BackgroundTasks\Implementation\Bucket\State\SCHEDULED, ILIAS\BackgroundTasks\Bucket\setCurrentTask(), and ILIAS\BackgroundTasks\Bucket\setState().

                                       : void
    {
        global $DIC;

        // check this before saving the bucket state to prevent an orphaned entry with 0%
        if (!$DIC->settings()->get('soap_user_administration')) {
            $DIC->logger()->bgtk()->warning("SOAP not enabled, fallback to sync version");
            $sync_manager = new SyncTaskManager($this->persistence);
            $sync_manager->run($bucket);
            return;
        }

        $bucket->setState(State::SCHEDULED);
        $bucket->setCurrentTask($bucket->getTask());
        $DIC->backgroundTasks()->persistence()->saveBucketAndItsTasks($bucket);

        $DIC->logger()->bgtk()->info("Trying to call webserver");

        // Call SOAP-Server
        $soap_client = new \ilSoapClient();
        $soap_client->setResponseTimeout(0);
        $soap_client->enableWSDL(true);
        $soap_client->init();
        $session_id = session_id();
        $client_id = $DIC->http()->wrapper()->cookie()->retrieve(
            'ilClientId',
            $DIC->refinery()->byTrying([
                $DIC->refinery()->kindlyTo()->string(),
                $DIC->refinery()->always(
                    defined('CLIENT_ID') ? CLIENT_ID : null
                )
            ])
        );

        try {
            $soap_client->call(self::CMD_START_WORKER, [
                $session_id . '::' . $client_id,
            ]);
        } catch (\Throwable $t) {
            $DIC->logger()->bgtk()->warning($t->getMessage());
            $DIC->logger()->bgtk()->warning("Calling webserver failed, fallback to sync version");
            $sync_manager = new SyncTaskManager($this->persistence);
            $sync_manager->run($bucket);
            return;
        }
        $DIC->logger()->bgtk()->info("Calling webserver successful");
    }

Here is the call graph for this function:

runAsync()

ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager::runAsync

(

)

Returns

bool|null

Definition at line 85 of file AsyncTaskManager.php.

References $DIC, Vendor\Package\$e, $ilIliasIniFile, ILIAS\BackgroundTasks\TaskManager\executeTask(), ILIAS\BackgroundTasks\Implementation\Bucket\State\FINISHED, null, ILIAS\BackgroundTasks\Implementation\Bucket\State\RUNNING, and ILIAS\BackgroundTasks\Implementation\Bucket\State\SCHEDULED.

Referenced by ilSoapBackgroundTasksAdministration\runAsync().

                              : ?bool
    {
        global $DIC, $ilIliasIniFile;

        $n_of_tasks = $ilIliasIniFile->readVariable("background_tasks", "number_of_concurrent_tasks");
        $n_of_tasks = $n_of_tasks ?: 5;

        $DIC->logger()->bgtk()->info("Starting background job.");
        $persistence = $DIC->backgroundTasks()->persistence();

        // TODO search over all clients.
        $MAX_PARALLEL_JOBS = $n_of_tasks;
        if (count($persistence->getBucketIdsByState(State::RUNNING)) >= $MAX_PARALLEL_JOBS) {
            $DIC->logger()->bgtk()->info("Too many running jobs, worker going down.");

            return null;
        }

        while (true) {
            $ids = $persistence->getBucketIdsByState(State::SCHEDULED);
            if (count($ids) === 0) {
                break;
            }

            $bucket = $persistence->loadBucket(array_shift($ids));
            $observer = new PersistingObserver($bucket, $persistence);
            $task = $bucket->getTask();

            try {
                $this->executeTask($task, $observer);
                $bucket->setState(State::FINISHED);
                $this->persistence->updateBucket($bucket);
            } catch (UserInteractionSkippedException) {
                $bucket->setState(State::FINISHED);
                $this->persistence->deleteBucket($bucket);
            } catch (UserInteractionRequiredException) {
                // We're okay!
                $this->persistence->saveBucketAndItsTasks($bucket);
            } catch (\Exception $e) {
                $persistence->deleteBucket($bucket);
                $DIC->logger()->bgtk()->info("Exception while async computing: "
                    . $e->getMessage());
                $DIC->logger()->bgtk()->info("Stack Trace: "
                    . $e->getTraceAsString());
            }
        }

        $DIC->logger()->bgtk()->info("One worker going down because there's nothing left to do.");

        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

CMD_START_WORKER

const ILIAS\BackgroundTasks\Implementation\TaskManager\AsyncTaskManager::CMD_START_WORKER = 'startBackgroundTaskWorker'

Definition at line 28 of file AsyncTaskManager.php.

---

The documentation for this class was generated from the following file:

• components/ILIAS/BackgroundTasks/src/Implementation/TaskManager/AsyncTaskManager.php