Inheritance diagram for ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective:

Collaboration diagram for ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective:

Public Member Functions
	__construct ()

	getHash ()
	Get a hash for this objective.The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same. More...

	getLabel ()
	Get a label that describes this objective. More...

	isNotable ()
	Get to know if this is an interesting objective for a human. More...

	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...

	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

	achieve (Environment $environment)
	Objectives can be achieved. More...

Public Member Functions inherited from ILIAS\Setup\Objective\AdminConfirmedObjective
	__construct (string $message)

	getHash ()
	Get a hash for this objective.The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same. More...

	getLabel ()
	Get a label that describes this objective. More...

	isNotable ()
	Get to know if this is an interesting objective for a human. More...

	getPreconditions (Setup\Environment $environment)

	achieve (Setup\Environment $environment)

	isApplicable (Setup\Environment $environment)
	@inheritDoc More...

	getHash ()
	Get a hash for this objective. More...

	getLabel ()
	Get a label that describes this objective. More...

	isNotable ()
	Get to know if this is an interesting objective for a human. More...

	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. More...

	achieve (Environment $environment)
	Objectives can be achieved. More...

	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. More...

Private Member Functions
	inform (string $text, bool $force=false)

	error (string $text)

	getCurlConnection (ilSetting $settings, string $url)

Private Attributes
IOWrapper	$io = null

Container	$old_DIC = null

ilSetting	$old_settings = null

Additional Inherited Members
Protected Attributes inherited from ILIAS\Setup\Objective\AdminConfirmedObjective
string	$message

Detailed Description

Definition at line 39 of file BackgoundWorkerObjective.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::__construct ( )

Definition at line 45 of file BackgoundWorkerObjective.php.

    {
        parent::__construct(
            "This will start a Background-Worker\n" .
            'Continue?'
        );
    }

References ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ achieve()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::achieve ( Environment $environment )

Objectives can be achieved.

They might add resources to the environment when they have been achieved.

This method needs to be idempotent for a given environment. That means: if this is executed a second time, nothing new should happen. Or the other way round: if the environment already looks like desired, the objective should not take any further actions when this is called.

Exceptions

LogicException if there are unfullfilled preconditions.

Exceptions

RuntimeException if there are missing resources.

Implements ILIAS\Setup\Objective.

Definition at line 89 of file BackgoundWorkerObjective.php.

                                                     : Environment
    {
        $environment = parent::achieve($environment);
        $io = $environment->getResource(Environment::RESOURCE_ADMIN_INTERACTION);
        $settings_factory = $environment->getResource(Environment::RESOURCE_SETTINGS_FACTORY);
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
 
        if ($io instanceof IOWrapper) {
            $this->io = $io;
        }
 
        $settings = $settings_factory->settingsFor('common');
 
        try {
            $internal_path = $settings->get('soap_internal_wsdl_path');
            if ($internal_path) {
                $uri = (new \ILIAS\Data\URI($internal_path));
                parse_str($uri->getQuery() ?? '', $query);
                $uri = (string) (isset($query['wsdl']) ?
                    $uri :
                    $uri->withQuery(http_build_query(array_merge($query, ['wsdl' => '']))));
            } elseif (trim($settings->get('soap_wsdl_path', '')) !== '') {
                $uri = $settings->get('soap_wsdl_path', '');
            } else {
                $uri = ilUtil::_getHttpPath() . '/public/soap/server.php?wsdl';
            }
            $this->inform('Trying to call webserver by using WSDL: ' . $uri);
            $soap_client = new SoapClient($uri, ['exceptions' => true, 'trace' => true, 'connection_timeout' => 10]);
            $this->inform('SOAP client initialized');
 
            $client_id = defined('CLIENT_ID') ? CLIENT_ID : $environment->getResource(Environment::RESOURCE_CLIENT_ID);
            if ($client_id === null) {
                throw new RuntimeException('CLIENT_ID is not defined.');
            }
 
            $url = $ini->readVariable('server', 'http_path');
            $session_url = rtrim($url, '/') . '/goto.php';
            $curl = $this->getCurlConnection($settings, $session_url);
            $result = $curl->exec();
            $header_array = $curl->getResponseHeaderArray();
            $session_id = null;
            if (isset($header_array['set-cookie'])) {
                $set_cookie = $header_array['set-cookie'];
                $cookies = is_array($set_cookie) ? $set_cookie : [$set_cookie];
                foreach ($cookies as $cookie) {
                    if (preg_match('/PHPSESSID=([^;]+)/i', $cookie, $matches)) {
                        $session_id = $matches[1];
                        break;
                    }
                }
            }
 
            if ($session_id === null) {
                throw new RuntimeException('Could not extract session ID from server response.');
            }
 
            if (!$result) {
                throw new RuntimeException('Could not retrieve session ID from server.');
            }
 
            $this->inform('Obtained session ID: ' . substr($session_id, 0, 40));
            $session_string = $session_id ? ($session_id . '::' . $client_id) : ('::' . $client_id);
            $this->inform('Calling startBackgroundTaskWorker with session: ' . ($session_id ? substr($session_id, 0, 40) : 'empty') . ', client: ' . $client_id);
 
            $result = $soap_client->__call('startBackgroundTaskWorker', [
                $session_string,
            ]);
            if ($result) {
                $this->inform('Calling webserver successful.');
            } else {
                throw new RuntimeException('Calling webserver failed.');
            }
        } catch (Throwable $t) {
            $this->error($t->getMessage());
            $this->error('Calling webserver failed');
            $this->error('Stack trace: ' . $t->getTraceAsString());
        }
 
        return $environment;
    }

References ILIAS\$client_id, ILIAS\$ini, ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective\$io, $settings, ilUtil\_getHttpPath(), CLIENT_ID, ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective\error(), ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective\getCurlConnection(), ILIAS\Setup\Environment\getResource(), ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective\inform(), ILIAS\Setup\Environment\RESOURCE_ADMIN_INTERACTION, ILIAS\Setup\Environment\RESOURCE_CLIENT_ID, ILIAS\Setup\Environment\RESOURCE_ILIAS_INI, and ILIAS\Setup\Environment\RESOURCE_SETTINGS_FACTORY.

Here is the call graph for this function:

◆ error()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::error ( string $text )

private

Definition at line 179 of file BackgoundWorkerObjective.php.

                                        : void
    {
        if ($this->io === null) {
            return;
        }
 
        $this->io->error($text);
    }

References $text.

Referenced by ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective\achieve().

Here is the caller graph for this function:

◆ getCurlConnection()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::getCurlConnection	(	ilSetting	$settings,
		string	$url
	)

private

Definition at line 188 of file BackgoundWorkerObjective.php.

                                                                        : ilCurlConnection
    {
        $curl = new ilCurlConnection(
            $url,
            new ilProxySettings($settings)
        );
        $curl->init();
        $curl->setOpt(CURLOPT_SSL_VERIFYPEER, 0);
        $curl->setOpt(CURLOPT_SSL_VERIFYHOST, 0);
        $curl->setOpt(CURLOPT_RETURNTRANSFER, 1);
        $curl->setOpt(CURLOPT_FOLLOWLOCATION, 1);
        $curl->setOpt(CURLOPT_MAXREDIRS, 1);
 
        return $curl;
    }

References $settings.

Referenced by ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective\achieve().

Here is the caller graph for this function:

◆ getHash()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::getHash ( )

Get a hash for this objective.The hash of two objectives must be the same, if they are the same objective, with the same config on the same environment, i.e. if the one is achieved the other is achieved as well because they are the same.

Reimplemented from ILIAS\Setup\Objective\AdminConfirmedObjective.

Definition at line 53 of file BackgoundWorkerObjective.php.

                             : string
    {
        return hash('sha256', self::class);
    }

◆ getLabel()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::getLabel ( )

Get a label that describes this objective.

Reimplemented from ILIAS\Setup\Objective\AdminConfirmedObjective.

Definition at line 58 of file BackgoundWorkerObjective.php.

                              : string
    {
        return 'Start a Background-Worker';
    }

◆ getPreconditions()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::getPreconditions ( Environment $environment )

Objectives might depend on other objectives.

Exceptions

UnachievableException if the objective is not achievable

Returns: Objective[]

Implements ILIAS\Setup\Objective.

Definition at line 68 of file BackgoundWorkerObjective.php.

                                                              : array
    {
        return [
            new ClientIdReadObjective(),
            new ilIniFilesPopulatedObjective(),
            new ilDatabaseInitializedObjective(),
            new ilSettingsFactoryExistsObjective()
        ];
    }

◆ inform()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::inform	(	string	$text,
		bool	$force = `false`
	)

private

Definition at line 170 of file BackgoundWorkerObjective.php.

                                                              : void
    {
        if ($this->io === null || (!$force && !$this->io->isVerbose())) {
            return;
        }
 
        $this->io->inform($text);
    }

References $text.

Referenced by ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective\achieve().

Here is the caller graph for this function:

◆ isApplicable()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::isApplicable ( Environment $environment )

Get to know whether the objective is applicable.

Don't change the environment or cause changes on services in the environment. Just check if this objective needs to be achieved, either currently or at all. In case of doubt whether the objective is applicable or not return true.

Implements ILIAS\Setup\Objective.

Definition at line 78 of file BackgoundWorkerObjective.php.

                                                          : bool
    {
        $ini = $environment->getResource(Environment::RESOURCE_ILIAS_INI);
 
        if (!$ini->groupExists('background_tasks')) {
            return false;
        }
 
        return $ini->readVariable('background_tasks', 'concurrency') === SetupConfig::TYPE_ASYNCHRONOUS;
    }

References ILIAS\$ini, ILIAS\Setup\Environment\getResource(), ILIAS\Setup\Environment\RESOURCE_ILIAS_INI, and ILIAS\BackgroundTasks\Setup\SetupConfig\TYPE_ASYNCHRONOUS.

Here is the call graph for this function:

◆ isNotable()

ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::isNotable ( )

Get to know if this is an interesting objective for a human.

Reimplemented from ILIAS\Setup\Objective\AdminConfirmedObjective.

Definition at line 63 of file BackgoundWorkerObjective.php.

                               : bool
    {
        return true;
    }

Field Documentation

◆ $io

IOWrapper ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::$io = null

private

Definition at line 41 of file BackgoundWorkerObjective.php.

Referenced by ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective\achieve().

◆ $old_DIC

Container ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::$old_DIC = null

private

Definition at line 42 of file BackgoundWorkerObjective.php.

◆ $old_settings

ilSetting ILIAS\BackgroundTasks\Setup\BackgoundWorkerObjective::$old_settings = null

private

Definition at line 43 of file BackgoundWorkerObjective.php.

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

components/ILIAS/BackgroundTasks/src/Setup/BackgoundWorkerObjective.php

Public Member Functions

Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ achieve()

◆ error()

◆ getCurlConnection()

◆ getHash()

◆ getLabel()

◆ getPreconditions()

◆ inform()

◆ isApplicable()

◆ isNotable()

Field Documentation

◆ $io

◆ $old_DIC

◆ $old_settings