ilSessionMaxIdleIsSetObjective Class Reference

Inheritance diagram for ilSessionMaxIdleIsSetObjective:

Collaboration diagram for ilSessionMaxIdleIsSetObjective:

Public Member Functions
	__construct (protected Setup\Config $config)
	getHash ()
	getLabel ()
	isNotable ()
	getPreconditions (Setup\Environment $environment)

Private Member Functions
	generateServerInfoFile (string $filename, string $token)
	getCurlConnection (ilSetting $settings, string $url, ?string $token=null)
	getPHPIniValuesByFileGetContents (string $url, ?string $token=null)
	infoNoConnection (Setup\CLI\IOWrapper $io)

Detailed Description

Definition at line 23 of file class.ilSessionMaxIdleIsSetObjective.php.

Constructor & Destructor Documentation

__construct()

ilSessionMaxIdleIsSetObjective::__construct

(

protected Setup\Config

$config

)

Definition at line 25 of file class.ilSessionMaxIdleIsSetObjective.php.

      {
    }

Member Function Documentation

generateServerInfoFile()

ilSessionMaxIdleIsSetObjective::generateServerInfoFile ( string  $filename, string  $token  )

private

Definition at line 181 of file class.ilSessionMaxIdleIsSetObjective.php.

References $_GET.

Referenced by getPreconditions().

                                                                            : void
    {
        $content = <<<TEXT
<?php
if (!isset(\$_GET['token'])) {
    return "";
}

if (\$_GET['token'] !== "$token") {
    return "";
}

\$scl = ini_get('session.cookie_lifetime');
\$smlt = ini_get('session.gc_maxlifetime');

echo \$scl . "&" . \$smlt;
TEXT;

        file_put_contents("public/$filename", $content);
    }

Here is the caller graph for this function:

getCurlConnection()

ilSessionMaxIdleIsSetObjective::getCurlConnection ( ilSetting  $settings, string  $url, ?string  $token = null  )

private

Exceptions

ilCurlConnectionException

Definition at line 205 of file class.ilSessionMaxIdleIsSetObjective.php.

References $token.

Referenced by getPreconditions().

                                                                                               : ilCurlConnection
    {
        if (!is_null($token)) {
            $url = $url . "?token=" . $token;
        }

        $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;
    }

Here is the caller graph for this function:

getHash()

ilSessionMaxIdleIsSetObjective::getHash

(

)

Definition at line 30 of file class.ilSessionMaxIdleIsSetObjective.php.

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

getLabel()

ilSessionMaxIdleIsSetObjective::getLabel

(

)

Definition at line 35 of file class.ilSessionMaxIdleIsSetObjective.php.

                              : string
    {
        return "Ensures 'session_max_idle' is set properly";
    }

getPHPIniValuesByFileGetContents()

ilSessionMaxIdleIsSetObjective::getPHPIniValuesByFileGetContents ( string  $url, ?string  $token = null  )

private

Exceptions

ErrorException

Definition at line 228 of file class.ilSessionMaxIdleIsSetObjective.php.

References Vendor\Package\$e, and $token.

Referenced by getPreconditions().

                                                                                         : string
    {
        set_error_handler(static function (int $severity, string $message, string $file, int $line): never {
            throw new ErrorException($message, $severity, $severity, $file, $line);
        });

        if (!is_null($token)) {
            $url = $url . "?token=" . $token;
        }

        try {
            return file_get_contents($url);
        } catch (ErrorException $e) {
            restore_error_handler();
            throw $e;
        }
    }

Here is the caller graph for this function:

getPreconditions()

ilSessionMaxIdleIsSetObjective::getPreconditions

(

Setup\Environment

$environment

)

Definition at line 45 of file class.ilSessionMaxIdleIsSetObjective.php.

References Vendor\Package\$e, $filename, $ini, $token, $url, ilCurlConnection\_isCurlExtensionLoaded(), generateServerInfoFile(), getCurlConnection(), getPHPIniValuesByFileGetContents(), and infoNoConnection().

                                                                    : array
    {
        $http_config = $environment->getConfigFor('http');

        return [
            new ilIniFilesPopulatedObjective(),
            new ilDatabaseInitializedObjective(),
            new ilSettingsFactoryExistsObjective(),
            new ilHttpConfigStoredObjective($http_config)
        ];
    }

Here is the call graph for this function:

infoNoConnection()

ilSessionMaxIdleIsSetObjective::infoNoConnection ( Setup\CLI\IOWrapper  $io )

private

Definition at line 246 of file class.ilSessionMaxIdleIsSetObjective.php.

Referenced by getPreconditions().

                                                              : void
    {
        $message =
            "ilSessionMaxIdleIsSetObjective:\n" .
            "Cannot establish proper connection to webserver.\n" .
            "In the event of an installation the value for session expire\n" .
            "will be the default value.\n" .
            "In the event of an update, the current value for session expire\n" .
            "is retained."
        ;

        $io->inform($message);
    }

Here is the caller graph for this function:

isNotable()

ilSessionMaxIdleIsSetObjective::isNotable

(

)

Definition at line 40 of file class.ilSessionMaxIdleIsSetObjective.php.

                               : bool
    {
        return false;
    }

---

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

• components/ILIAS/Authentication/classes/Setup/class.ilSessionMaxIdleIsSetObjective.php