class.ilAuthModeDetermination.php

Go to the documentation of this file.

<?php
/*
    +-----------------------------------------------------------------------------+
    | ILIAS open source                                                           |
    +-----------------------------------------------------------------------------+
    | Copyright (c) 1998-2006 ILIAS open source, University of Cologne            |
    |                                                                             |
    | This program is free software; you can redistribute it and/or               |
    | modify it under the terms of the GNU General Public License                 |
    | as published by the Free Software Foundation; either version 2              |
    | of the License, or (at your option) any later version.                      |
    |                                                                             |
    | This program is distributed in the hope that it will be useful,             |
    | but WITHOUT ANY WARRANTY; without even the implied warranty of              |
    | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the               |
    | GNU General Public License for more details.                                |
    |                                                                             |
    | You should have received a copy of the GNU General Public License           |
    | along with this program; if not, write to the Free Software                 |
    | Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA  02111-1307, USA. |
    +-----------------------------------------------------------------------------+
*/

include_once('Services/Authentication/classes/class.ilAuthUtils.php');

class ilAuthModeDetermination
{
    const TYPE_MANUAL = 0;
    const TYPE_AUTOMATIC = 1;
    
    protected static $instance = null;
    
    protected $db = null;
    protected $settings = null;
    
    protected $kind = 0;
    protected $position = array();
    

    private function __construct()
    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        $ilDB = $DIC['ilDB'];
        
        $this->db = $ilDB;

        include_once "./Services/Administration/classes/class.ilSetting.php";
        $this->settings = new ilSetting("auth_mode_determination");
        $this->read();
    }
    
    public static function _getInstance()
    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new ilAuthModeDetermination();
    }

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

    public function getKind()
    {
        return $this->kind;
    }
    
    public function setKind($a_kind)
    {
        $this->kind = $a_kind;
    }
    
    public function getAuthModeSequence($a_username = '')
    {
        if (!strlen($a_username)) {
            return $this->position ? $this->position : array();
        }
        $sorted = array();
        
        foreach ($this->position as $auth_key) {
            include_once './Services/LDAP/classes/class.ilLDAPServer.php';
            $sid = ilLDAPServer::getServerIdByAuthMode($auth_key);
            if ($sid) {
                $server = ilLDAPServer::getInstanceByServerId($sid);
                ilLoggerFactory::getLogger('auth')->debug('Validating username filter for ' . $server->getName());
                if (strlen($server->getUsernameFilter())) {
                    //#17731
                    $pattern = str_replace('*', '.*?', $server->getUsernameFilter());

                    if (preg_match('/^' . $pattern . '$/', $a_username)) {
                        ilLoggerFactory::getLogger('auth')->debug('Filter matches for ' . $a_username);
                        array_unshift($sorted, $auth_key);
                        continue;
                    }
                    ilLoggerFactory::getLogger('auth')->debug('Filter matches not for ' . $a_username . ' <-> ' . $server->getUsernameFilter());
                }
            }
            $sorted[] = $auth_key;
        }
        
        return (array) $sorted;
    }
    
    public function getCountActiveAuthModes()
    {
        return count($this->position);
    }
    
    public function setAuthModeSequence($a_pos)
    {
        $this->position = $a_pos;
    }
    
    public function save()
    {
        $this->settings->deleteAll();
        
        $this->settings->set('kind', $this->getKind());
        
        $counter = 0;
        foreach ($this->position as $auth_mode) {
            $this->settings->set((string) $counter++, $auth_mode);
        }
    }
    
    
    private function read()
    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        
        $this->kind = $this->settings->get('kind', self::TYPE_MANUAL);
        
        // begin-patch ldap_multiple
        include_once('Services/LDAP/classes/class.ilLDAPServer.php');
        // end-patch ldap_multiple
        
        include_once('Services/Radius/classes/class.ilRadiusSettings.php');
        $rad_settings = ilRadiusSettings::_getInstance();
        $rad_active = $rad_settings->isActive();
        
        $soap_active = $ilSetting->get('soap_auth_active', false);

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

        // Check if active
        // begin-patch ldap_multiple
        $i = 0;
        while (true) {
            $auth_mode = $this->settings->get((string) $i++, false);
            if ($auth_mode === false) {
                break;
            }
            if ($auth_mode) {
                // begin-patch ldap_multiple
                switch ((int) $auth_mode) {
                    case AUTH_LOCAL:
                        $this->position[] = $auth_mode;
                        break;
                    
                    case AUTH_LDAP:
                        $auth_id = ilLDAPServer::getServerIdByAuthMode($auth_mode);
                        $server = ilLDAPServer::getInstanceByServerId($auth_id);
                        
                        if ($server->isActive()) {
                            $this->position[] = $auth_mode;
                        }
                        break;
                        
                    case AUTH_RADIUS:
                        if ($rad_active) {
                            $this->position[] = $auth_mode;
                        }
                        break;
                    
                    case AUTH_SOAP:
                        if ($soap_active) {
                            $this->position[] = $auth_mode;
                        }
                        break;

                    case AUTH_APACHE:
                        if ($apache_active) {
                            $this->position[] = $auth_mode;
                        }
                        break;
                        
                    // begin-patch auth_plugin
                    default:
                        foreach (ilAuthUtils::getAuthPlugins() as $pl) {
                            if ($pl->isAuthActive($auth_mode)) {
                                $this->position[] = $auth_mode;
                            }
                        }
                        break;
                    // end-patch auth_plugin
                        
                }
            }
        }
        // end-patch ldap_multiple

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