class.ilAuthModeDetermination.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilAuthModeDetermination
{
    public const TYPE_MANUAL = 0;
    public const TYPE_AUTOMATIC = 1;

    private static ?ilAuthModeDetermination $instance = null;

    private ilLogger $logger;

    private ilSetting $settings;
    private ilSetting $commonSettings;

    private int $kind = self::TYPE_MANUAL;
    private array $position = [];


    private function __construct()
    {
        global $DIC;

        $this->logger = $DIC->logger()->auth();

        $this->commonSettings = $DIC->settings();

        $this->settings = new ilSetting("auth_mode_determination");
        $this->read();
    }

    public static function _getInstance(): ilAuthModeDetermination
    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new ilAuthModeDetermination();
    }

    public function isManualSelection(): bool
    {
        return $this->kind === self::TYPE_MANUAL;
    }

    public function getKind(): int
    {
        return $this->kind;
    }

    public function setKind(int $a_kind): void
    {
        // TODO check value range
        $this->kind = $a_kind;
    }

    public function getAuthModeSequence(string $a_username = ''): array
    {
        if ($a_username === '') {
            return $this->position ?: array();
        }
        $sorted = array();

        foreach ($this->position as $auth_key) {
            $sid = ilLDAPServer::getServerIdByAuthMode((string) $auth_key);
            if ($sid) {
                $server = ilLDAPServer::getInstanceByServerId($sid);
                $this->logger->debug('Validating username filter for ' . $server->getName());
                if ($server->getUsernameFilter() !== '') {
                    //#17731
                    $pattern = str_replace('*', '.*?', $server->getUsernameFilter());

                    foreach (ilAuthUtils::REGEX_DELIMITERS as $delimiter) {
                        $this->logger->debug('Trying pattern to match username:' . $pattern . ' => ' . $a_username);
                        set_error_handler(static function (int $severity, string $message, string $file, int $line): never {
                            throw new ErrorException($message, $severity, $severity, $file, $line);
                        });

                        try {
                            if (preg_match($delimiter . "^" . $pattern . '$' . $delimiter . 'i', $a_username) === 1) {
                                $this->logger->debug('Filter matches for ' . $a_username);
                                array_unshift($sorted, $auth_key);
                                continue 2;
                            }
                            break;
                        } catch (Exception $ex) {
                            $this->logger->warning('Error occurred in preg_match Ex.: ' . $ex->getMessage());
                        } finally {
                            restore_error_handler();
                        }
                    }

                    $this->logger->debug('Filter matches not for ' . $a_username . ' <-> ' . $server->getUsernameFilter());
                }
            }
            $sorted[] = $auth_key;
        }

        return $sorted;
    }

    public function getCountActiveAuthModes(): int
    {
        return count($this->position);
    }

    public function setAuthModeSequence(array $a_pos): void
    {
        $this->position = $a_pos;
    }

    public function save(): void
    {
        $this->settings->deleteAll();

        $this->settings->set('kind', (string) $this->getKind());

        $counter = 0;
        foreach ($this->position as $auth_mode) {
            $this->settings->set((string) $counter++, (string) $auth_mode);
        }
    }


    private function read(): void
    {
        $this->kind = (int) $this->settings->get('kind', (string) self::TYPE_MANUAL);

        $soap_active = (bool) $this->commonSettings->get('soap_auth_active', "");

        // apache settings
        $apache_settings = new ilSetting('apache_auth');
        $apache_active = $apache_settings->get('apache_enable_auth');

        // Check if active
        $i = 0;
        while (true) {
            $auth_mode = $this->settings->get((string) $i++, null);
            if ($auth_mode === null) {
                break;
            }
            if ($auth_mode) {
                switch ((int) $auth_mode) {
                    case ilAuthUtils::AUTH_LOCAL:
                        $this->position[] = (int) $auth_mode;
                        break;
                    case ilAuthUtils::AUTH_LDAP:
                        $auth_id = ilLDAPServer::getServerIdByAuthMode($auth_mode);
                        if ($auth_id === null) {
                            break;
                        }
                        $server = ilLDAPServer::getInstanceByServerId($auth_id);

                        if ($server->isActive()) {
                            $this->position[] = $auth_mode;
                        }
                        break;

                    case ilAuthUtils::AUTH_SOAP:
                        if ($soap_active) {
                            $this->position[] = (int) $auth_mode;
                        }
                        break;

                    case ilAuthUtils::AUTH_APACHE:
                        if ($apache_active) {
                            $this->position[] = (int) $auth_mode;
                        }
                        break;

                    default:
                        foreach (ilAuthUtils::getAuthPlugins() as $pl) {
                            if ($pl->isAuthActive((int) $auth_mode)) {
                                $this->position[] = $auth_mode;
                            }
                        }
                        break;
                }
            }
        }

        // Append missing active auth modes
        if (!in_array(ilAuthUtils::AUTH_LOCAL, $this->position, true)) {
            $this->position[] = ilAuthUtils::AUTH_LOCAL;
        }
        // begin-patch ldap_multiple
        foreach (ilLDAPServer::_getActiveServerList() as $sid) {
            $server = ilLDAPServer::getInstanceByServerId($sid);
            if ($server->isActive() && !in_array(ilAuthUtils::AUTH_LDAP . '_' . $sid, $this->position, true)) {
                $this->position[] = (ilAuthUtils::AUTH_LDAP . '_' . $sid);
            }
        }
        // end-patch ldap_multiple
        if ($soap_active && !in_array(ilAuthUtils::AUTH_SOAP, $this->position, true)) {
            $this->position[] = ilAuthUtils::AUTH_SOAP;
        }
        if ($apache_active && !in_array(ilAuthUtils::AUTH_APACHE, $this->position, true)) {
            $this->position[] = ilAuthUtils::AUTH_APACHE;
        }
        // begin-patch auth_plugin
        foreach (ilAuthUtils::getAuthPlugins() as $pl) {
            foreach ($pl->getAuthIds() as $auth_id) {
                if ($pl->isAuthActive($auth_id) && !in_array($auth_id, $this->position, true)) {
                    $this->position[] = $auth_id;
                }
            }
        }
        // end-patch auth_plugin
    }
}