Read-only configuration of the IRSS User Content Isolation feature. More...

Collaboration diagram for ILIAS\FileDelivery\Isolation\IsolationConfig:

Public Member Functions
	__construct (private bool $activated, private ?string $content_domain, private ?string $ilias_domain,)

	isActivated ()

	getContentDomain ()

	getIliasDomain ()

	getContentHost ()

	getIliasHost ()

	toArray ()

Static Public Member Functions
static	fromArray (array $data)

static	disabled ()

static	fromArtefact (?string $path=null)
	Load the configuration from the static artefact written by the setup. More...

static	normalizeOrigin (mixed $value)
	Validate and normalize a configured domain to a bare origin ("scheme://host[:port]"), or null if it is not a usable http/https origin. More...

static	originFromUrl (mixed $value)
	Reduce a (trusted) application URL to its bare origin "scheme://host[:port]". More...

Data Fields
const	KEY_ACTIVATED = 'activated'

const	KEY_CONTENT_DOMAIN = 'content_domain'

const	KEY_ILIAS_DOMAIN = 'ilias_domain'

Private Member Functions
	extractHost (?string $url)

Static Private Member Functions
static	normalizeUrl (mixed $value)
	Normalize the configured value to a bare origin: "scheme://host[:port]". More...

Detailed Description

Read-only configuration of the IRSS User Content Isolation feature.

Loaded from a static PHP artefact written by the setup so that the FileDelivery service can decide whether to deliver content via a dedicated content domain — without any DB dependency.

Both the content domain (admin-configured) and the ILIAS domain (derived from the installed http_path at setup time) are baked into the artefact. The runtime therefore never has to read ilias.ini.php to learn either value.

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

Definition at line 38 of file IsolationConfig.php.

Constructor & Destructor Documentation

◆ __construct()

ILIAS\FileDelivery\Isolation\IsolationConfig::__construct	(	private bool	$activated,
		private ?string	$content_domain,
		private ?string	$ilias_domain
	)

Definition at line 44 of file IsolationConfig.php.

48 {

49 }

Member Function Documentation

◆ disabled()

static ILIAS\FileDelivery\Isolation\IsolationConfig::disabled ( )

static

Definition at line 69 of file IsolationConfig.php.

                                     : self
    {
        return new self(false, null, null);
    }

Here is the caller graph for this function:

◆ extractHost()

ILIAS\FileDelivery\Isolation\IsolationConfig::extractHost ( ?string $url )

private

Definition at line 132 of file IsolationConfig.php.

                                              : ?string
    {
        if ($url === null) {
            return null;
        }
        $host = parse_url($url, PHP_URL_HOST);
        return is_string($host) && $host !== '' ? $host : null;
    }

Referenced by ILIAS\FileDelivery\Isolation\IsolationConfig\getContentHost(), and ILIAS\FileDelivery\Isolation\IsolationConfig\getIliasHost().

Here is the caller graph for this function:

◆ fromArray()

static ILIAS\FileDelivery\Isolation\IsolationConfig::fromArray ( array $data )

static

Parameters

array<string,mixed> $data

Definition at line 54 of file IsolationConfig.php.

                                                 : self
    {
        $activated = (bool) ($data[self::KEY_ACTIVATED] ?? false);
        $content = self::normalizeUrl($data[self::KEY_CONTENT_DOMAIN] ?? null);
        $ilias = self::normalizeUrl($data[self::KEY_ILIAS_DOMAIN] ?? null);
 
        // Only the content domain is mandatory for isolation; without a separate
        // origin to deliver from there is nothing to isolate, so it stays off.
        if ($activated && $content === null) {
            $activated = false;
        }
 
        return new self($activated, $content, $ilias);
    }

References $data, and ILIAS\FileDelivery\Isolation\IsolationConfig\normalizeUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fromArtefact()

static ILIAS\FileDelivery\Isolation\IsolationConfig::fromArtefact ( ?string $path = null )

static

Load the configuration from the static artefact written by the setup.

A missing, unreadable or malformed artefact keeps the feature off, so an installation that never ran the FileDelivery setup behaves as before.

Parameters

string | null $path only passed in tests; defaults to the artefact location the setup writes to

Definition at line 83 of file IsolationConfig.php.

                                                             : self
    {
        $path ??= IsolationObjective::PATH();
        if (!is_file($path)) {
            return self::disabled();
        }
 
        $data = @include $path;
 
        return self::fromArray(is_array($data) ? $data : []);
    }

References $data, ILIAS\FileDelivery\Isolation\IsolationConfig\disabled(), ILIAS\FileDelivery\Isolation\IsolationConfig\fromArray(), and ILIAS\FileDelivery\Setup\BuildStaticConfigStoredObjective\PATH().

Referenced by ILIAS\FileDelivery\Setup\Agent\buildIsolationObjective(), ILIAS\Tests\FileDelivery\Isolation\IsolationConfigTest\testFromArtefactReadsTheStoredSettings(), ILIAS\Tests\FileDelivery\Isolation\IsolationConfigTest\testFromArtefactWithNonArrayContentIsDisabled(), ILIAS\Tests\FileDelivery\Isolation\IsolationConfigTest\testFromArtefactWithoutFileIsDisabled(), and ILIAS\Tests\FileDelivery\Isolation\IsolationConfigTest\testFromArtefactWithoutReturnValueIsDisabled().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getContentDomain()

ILIAS\FileDelivery\Isolation\IsolationConfig::getContentDomain ( )

Definition at line 112 of file IsolationConfig.php.

                                      : ?string
    {
        return $this->content_domain;
    }

◆ getContentHost()

ILIAS\FileDelivery\Isolation\IsolationConfig::getContentHost ( )

Definition at line 122 of file IsolationConfig.php.

                                    : ?string
    {
        return $this->extractHost($this->content_domain);
    }

References ILIAS\FileDelivery\Isolation\IsolationConfig\extractHost().

Here is the call graph for this function:

◆ getIliasDomain()

ILIAS\FileDelivery\Isolation\IsolationConfig::getIliasDomain ( )

Definition at line 117 of file IsolationConfig.php.

                                    : ?string
    {
        return $this->ilias_domain;
    }

◆ getIliasHost()

ILIAS\FileDelivery\Isolation\IsolationConfig::getIliasHost ( )

Definition at line 127 of file IsolationConfig.php.

                                  : ?string
    {
        return $this->extractHost($this->ilias_domain);
    }

References ILIAS\FileDelivery\Isolation\IsolationConfig\extractHost().

Here is the call graph for this function:

◆ isActivated()

ILIAS\FileDelivery\Isolation\IsolationConfig::isActivated ( )

Definition at line 107 of file IsolationConfig.php.

                                 : bool
    {
        return $this->activated;
    }

◆ normalizeOrigin()

static ILIAS\FileDelivery\Isolation\IsolationConfig::normalizeOrigin ( mixed $value )

static

Validate and normalize a configured domain to a bare origin ("scheme://host[:port]"), or null if it is not a usable http/https origin.

Shared with the setup layer so that the setup and the runtime enforce one identical set of rules for what a content/ILIAS domain may look like.

Definition at line 102 of file IsolationConfig.php.

                                                        : ?string
    {
        return self::normalizeUrl($value);
    }

References ILIAS\FileDelivery\Isolation\IsolationConfig\normalizeUrl().

Referenced by ILIAS\FileDelivery\Setup\FileDeliverySetupConfig\__construct().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ normalizeUrl()

static ILIAS\FileDelivery\Isolation\IsolationConfig::normalizeUrl ( mixed $value )

staticprivate

Normalize the configured value to a bare origin: "scheme://host[:port]".

Security: the result is used both as the base for asset URLs and as the value of the Access-Control-Allow-Origin response header. It must therefore be a clean origin only — any scheme other than http/https, and any userinfo, path, query or fragment, makes the value unusable (returns null, which keeps isolation disabled). The setup layer rejects such input loudly; this is the runtime safety net.

Definition at line 163 of file IsolationConfig.php.

                                                      : ?string
    {
        if (!is_string($value)) {
            return null;
        }
        $value = trim($value);
        if ($value === '') {
            return null;
        }
        // accept either a full URL ("https://host[:port]") or a bare hostname ("host.example.org")
        if (!preg_match('#^[a-z][a-z0-9+.\-]*://#i', $value)) {
            $value = 'https://' . ltrim($value, '/');
        }
 
        $parts = parse_url($value);
        if (!is_array($parts) || !isset($parts['host']) || $parts['host'] === '') {
            return null;
        }
 
        $scheme = strtolower($parts['scheme'] ?? '');
        if ($scheme !== 'http' && $scheme !== 'https') {
            return null;
        }
 
        // reject anything that is more than a bare origin
        if (isset($parts['user']) || isset($parts['pass'])
            || isset($parts['query']) || isset($parts['fragment'])
            || (isset($parts['path']) && $parts['path'] !== '' && $parts['path'] !== '/')
        ) {
            return null;
        }
 
        $origin = $scheme . '://' . strtolower($parts['host']);
        if (isset($parts['port'])) {
            $origin .= ':' . $parts['port'];
        }
 
        return $origin;
    }

Referenced by ILIAS\FileDelivery\Isolation\IsolationConfig\fromArray(), and ILIAS\FileDelivery\Isolation\IsolationConfig\normalizeOrigin().

Here is the caller graph for this function:

◆ originFromUrl()

static ILIAS\FileDelivery\Isolation\IsolationConfig::originFromUrl ( mixed $value )

static

Reduce a (trusted) application URL to its bare origin "scheme://host[:port]".

Unlike {

See also: self::normalizeOrigin()} this tolerates a path/query/fragment and simply discards them, because the source is the internally configured ILIAS http_path (which may carry a sub-directory) rather than admin-provided config. The result is only ever used as a CORS allow-origin, which must be an origin.

Used by the setup layer to derive the ILIAS domain from http_path at build time so the value can be baked into the artefact.

Definition at line 214 of file IsolationConfig.php.

                                                      : ?string
    {
        if (!is_string($value)) {
            return null;
        }
        $value = trim($value);
        if ($value === '') {
            return null;
        }
        if (!preg_match('#^[a-z][a-z0-9+.\-]*://#i', $value)) {
            $value = 'https://' . ltrim($value, '/');
        }
 
        $parts = parse_url($value);
        if (!is_array($parts) || !isset($parts['host']) || $parts['host'] === '') {
            return null;
        }
 
        $scheme = strtolower($parts['scheme'] ?? '');
        if ($scheme !== 'http' && $scheme !== 'https') {
            return null;
        }
 
        $origin = $scheme . '://' . strtolower($parts['host']);
        if (isset($parts['port'])) {
            $origin .= ':' . $parts['port'];
        }
 
        return $origin;
    }

Referenced by ILIAS\FileDelivery\Setup\IsolationObjective\readIliasDomain(), and ILIAS\Tests\FileDelivery\Isolation\IsolationConfigTest\testOriginFromUrlReducesTrustedAppUrlToBareOrigin().

Here is the caller graph for this function:

◆ toArray()

ILIAS\FileDelivery\Isolation\IsolationConfig::toArray ( )

Returns: array<string, mixed>

Definition at line 144 of file IsolationConfig.php.

                             : array
    {
        return [
            self::KEY_ACTIVATED => $this->activated,
            self::KEY_CONTENT_DOMAIN => $this->content_domain,
            self::KEY_ILIAS_DOMAIN => $this->ilias_domain,
        ];
    }

Field Documentation

◆ KEY_ACTIVATED

const ILIAS\FileDelivery\Isolation\IsolationConfig::KEY_ACTIVATED = 'activated'

Definition at line 40 of file IsolationConfig.php.

◆ KEY_CONTENT_DOMAIN

const ILIAS\FileDelivery\Isolation\IsolationConfig::KEY_CONTENT_DOMAIN = 'content_domain'

Definition at line 41 of file IsolationConfig.php.

◆ KEY_ILIAS_DOMAIN

const ILIAS\FileDelivery\Isolation\IsolationConfig::KEY_ILIAS_DOMAIN = 'ilias_domain'

Definition at line 42 of file IsolationConfig.php.

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

components/ILIAS/FileDelivery/src/Isolation/IsolationConfig.php

Public Member Functions

Static Public Member Functions

Data Fields

Private Member Functions

Static Private Member Functions

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ disabled()

◆ extractHost()

◆ fromArray()

◆ fromArtefact()

◆ getContentDomain()

◆ getContentHost()

◆ getIliasDomain()

◆ getIliasHost()

◆ isActivated()

◆ normalizeOrigin()

◆ normalizeUrl()

◆ originFromUrl()

◆ toArray()

Field Documentation

◆ KEY_ACTIVATED

◆ KEY_CONTENT_DOMAIN

◆ KEY_ILIAS_DOMAIN