class.ilHttpMetricsCollectedObjective.php

Go to the documentation of this file.

<?php

use ILIAS\Setup;

class ilHttpMetricsCollectedObjective extends Setup\Metrics\CollectedObjective
{
    public function getTentativePreconditions(Setup\Environment $environment): array
    {
        return [
            new ilIniFilesLoadedObjective(),
            new \ilSettingsFactoryExistsObjective()
        ];
    }

    public function collectFrom(Setup\Environment $environment, Setup\Metrics\Storage $storage): void
    {
        $ilias_ini = $environment->getResource(Setup\Environment::RESOURCE_ILIAS_INI);

        if ($ilias_ini) {
            $storage->storeConfigText(
                "http_path",
                $ilias_ini->readVariable("server", "http_path"),
                "URL of the server."
            );
            $storage->storeConfigText(
                "https forced",
                $ilias_ini->readVariable("https", "forced"),
                ""
            );

            if ($ilias_ini->readVariable("https", "auto_https_detect_enabled")) {
                $header_name = new Setup\Metrics\Metric(
                    Setup\Metrics\Metric::STABILITY_CONFIG,
                    Setup\Metrics\Metric::TYPE_TEXT,
                    $ilias_ini->readVariable("https", "auto_https_detect_header_name"),
                    "The name of the header used for https detection in requests."
                );
                $header_value = new Setup\Metrics\Metric(
                    Setup\Metrics\Metric::STABILITY_CONFIG,
                    Setup\Metrics\Metric::TYPE_TEXT,
                    $ilias_ini->readVariable("https", "auto_https_detect_header_value"),
                    "The value in the named header that indicates usage of https in requests."
                );
                $https_metrics = new Setup\Metrics\Metric(
                    Setup\Metrics\Metric::STABILITY_CONFIG,
                    Setup\Metrics\Metric::TYPE_COLLECTION,
                    [
                        "header_name" => $header_name,
                        "header_value" => $header_value
                    ],
                    "The properties of a request used for https detection."
                );
                $storage->store("https_autodetection", $https_metrics);
            } else {
                $storage->storeConfigBool(
                    "https_autodetection",
                    false,
                    "Does the server attempt to detect https in incoming requests?"
                );
            }
        }

        $factory = $environment->getResource(Setup\Environment::RESOURCE_SETTINGS_FACTORY);
        if (!$factory) {
            return;
        }
        $settings = $factory->settingsFor("common");

        if ($settings->get("proxy_status")) {
            $host = new Setup\Metrics\Metric(
                Setup\Metrics\Metric::STABILITY_CONFIG,
                Setup\Metrics\Metric::TYPE_TEXT,
                $settings->get("proxy_host"),
                "The host of the proxy."
            );
            $port = new Setup\Metrics\Metric(
                Setup\Metrics\Metric::STABILITY_CONFIG,
                Setup\Metrics\Metric::TYPE_TEXT,
                $settings->get("proxy_port"),
                "The port of the proxy."
            );
            $proxy = new Setup\Metrics\Metric(
                Setup\Metrics\Metric::STABILITY_CONFIG,
                Setup\Metrics\Metric::TYPE_COLLECTION,
                [
                    "host" => $host,
                    "port" => $port
                ],
                "The proxy that is used for outgoing connections."
            );
            $storage->store("proxy", $proxy);
        } else {
            $storage->storeConfigBool(
                "proxy",
                false,
                "Does the server use a proxy for outgoing connections?"
            );
        }

        if ($settings->get('allowed_hosts')) {
            $storage->store(
                'allowed_hosts',
                new Setup\Metrics\Metric(
                    Setup\Metrics\Metric::STABILITY_CONFIG,
                    Setup\Metrics\Metric::TYPE_COLLECTION,
                    array_map(
                        static fn(string $host) => new Setup\Metrics\Metric(
                            Setup\Metrics\Metric::STABILITY_CONFIG,
                            Setup\Metrics\Metric::TYPE_TEXT,
                            $host
                        ),
                        explode(',', $settings->get('allowed_hosts'))
                    ),
                    'Collection of configured allowed hosts.'
                )
            );
        }
    }
}