Inheritance diagram for ILIAS\FileDelivery\Setup\DeliveryMethodObjective:

Collaboration diagram for ILIAS\FileDelivery\Setup\DeliveryMethodObjective:

Public Member Functions
	getArtifactName ()

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

	build ()

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

Public Member Functions inherited from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective
	getArtifactName ()

	build ()

	buildIn (Environment $env)

	getPreconditions (Environment $environment)
	Objectives might depend on other objectives. 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...

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

	isApplicable (Environment $environment)
	Get to know whether the objective is applicable. 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...

Data Fields
const	SETTINGS = 'delivery_method'

const	SETTINGS_EXTERNAL_DATA_DIR = 'ext_data_dir'

const	XSENDFILE = 'xsendfile'

const	XACCEL = 'xaccel'

const	PHP = 'php'

Private Member Functions
	isModXSendFileLoaded ()

Private Attributes
string	$ext_data_dir = null

IOWrapper	$io = null

Additional Inherited Members
Static Public Member Functions inherited from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective
static	PATH ()

Protected Member Functions inherited from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective
	getPath ()

	makeDirectoryFor (string $path)

Static Protected Member Functions inherited from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective
static	saveName (string $name)

Detailed Description

Author: Fabian Schmid fabia.nosp@m.n@sr.nosp@m..solu.nosp@m.tion.nosp@m.s

Definition at line 32 of file DeliveryMethodObjective.php.

Member Function Documentation

◆ build()

ILIAS\FileDelivery\Setup\DeliveryMethodObjective::build ( )

Reimplemented from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective.

Definition at line 78 of file DeliveryMethodObjective.php.

                           : Artifact
    {
        $delivery_method = self::PHP;
 
        if (file_exists(self::PATH())) {
            $settings = (@include self::PATH()) ?? [];
            $delivery_method = $settings[self::SETTINGS] ?? self::PHP;
        }
 
        if ($this->isModXSendFileLoaded()) {
            $delivery_method = self::XSENDFILE;
        }
 
        return new ArrayArtifact(array_filter([
            self::SETTINGS => $delivery_method,
            self::SETTINGS_EXTERNAL_DATA_DIR => $this->ext_data_dir
        ]));
    }

References ILIAS\FileDelivery\Setup\DeliveryMethodObjective\isModXSendFileLoaded(), ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\PATH(), ILIAS\FileDelivery\Setup\DeliveryMethodObjective\PHP, ILIAS\FileDelivery\Setup\DeliveryMethodObjective\SETTINGS, and ILIAS\FileDelivery\Setup\DeliveryMethodObjective\XSENDFILE.

Here is the call graph for this function:

◆ getArtifactName()

ILIAS\FileDelivery\Setup\DeliveryMethodObjective::getArtifactName ( )

Reimplemented from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective.

Definition at line 43 of file DeliveryMethodObjective.php.

                                     : string
    {
        return 'delivery_method';
    }

◆ getPreconditions()

ILIAS\FileDelivery\Setup\DeliveryMethodObjective::getPreconditions ( Environment $environment )

Objectives might depend on other objectives.

Exceptions

UnachievableException if the objective is not achievable

Returns: Objective[]

Reimplemented from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective.

Definition at line 48 of file DeliveryMethodObjective.php.

                                                              : array
    {
        return array_merge(
            parent::getPreconditions($environment),
            [
                new \ilIniFilesPopulatedObjective()
            ]
        );
    }

◆ isApplicable()

ILIAS\FileDelivery\Setup\DeliveryMethodObjective::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.

Reimplemented from ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective.

Definition at line 123 of file DeliveryMethodObjective.php.

                                                          : bool
    {
        return true;
    }

◆ isModXSendFileLoaded()

ILIAS\FileDelivery\Setup\DeliveryMethodObjective::isModXSendFileLoaded ( )

private

Definition at line 97 of file DeliveryMethodObjective.php.

                                           : bool
    {
        if (\function_exists('apache_get_modules') && \in_array('mod_xsendfile', apache_get_modules(), true)) {
            return true;
        }
 
        try {
            $command_exists = shell_exec('which apache2ctl');
            if (empty($command_exists)) {
                return false;
            }
 
            $loaded_modules = array_map(
                static fn(string $module): string => explode(' ', trim($module))[0] ?? '',
                explode("\n", shell_exec('apache2ctl -M 2>/dev/null') ?? '')
            );
        } catch (\Throwable $e) {
            $this->io?->error($e->getMessage());
            $this->io?->error($e->getTraceAsString());
            $loaded_modules = [];
        }
 
        return \in_array('xsendfile_module', $loaded_modules, true);
    }