ilAuthModeDetermination Class Reference

Collaboration diagram for ilAuthModeDetermination:

Public Member Functions
	isManualSelection ()
	is manual selection More...
	getKind ()
	get kind More...
	setKind ($a_kind)
	set kind of determination More...
	getAuthModeSequence ($a_username='')
	get auth mode sequence More...
	getCountActiveAuthModes ()
	get number of auth modes More...
	setAuthModeSequence ($a_pos)
	set auth mode sequence More...
	save ()
	Save settings. More...

Static Public Member Functions
static	_getInstance ()
	Get instance. More...

Data Fields
const	TYPE_MANUAL = 0
const	TYPE_AUTOMATIC = 1

Protected Attributes
	$db = null
	$settings = null
	$kind = 0
	$position = array()

Static Protected Attributes
static	$instance = null

Private Member Functions
	__construct ()
	Constructor (Singleton) More...
	read ()
	Read settings. More...

Detailed Description

Author

Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om

Version

$Id$

Definition at line 34 of file class.ilAuthModeDetermination.php.

Constructor & Destructor Documentation

__construct()

ilAuthModeDetermination::__construct ( )

private

Constructor (Singleton)

private

Definition at line 54 of file class.ilAuthModeDetermination.php.

References $DIC, $ilDB, $ilSetting, read(), and settings().

    {
        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();
    }

Here is the call graph for this function:

Member Function Documentation

_getInstance()

static ilAuthModeDetermination::_getInstance ( )

static

Get instance.

public

Returns

ilAuthModeDetermination

Definition at line 76 of file class.ilAuthModeDetermination.php.

Referenced by ilAuthUtils\_getAuthModeOfUser(), ilStartUpGUI\doStandardAuthentication(), ilAuthProviderFactory\getProviders(), ilObjAuthSettingsGUI\initAuthModeDetermination(), ilStartUpGUI\initStandardLoginForm(), and ilObjAuthSettingsGUI\updateAuthModeDeterminationObject().

    {
        if (self::$instance) {
            return self::$instance;
        }
        return self::$instance = new ilAuthModeDetermination();
    }

Here is the caller graph for this function:

getAuthModeSequence()

ilAuthModeDetermination::getAuthModeSequence

(

$a_username = ''

)

get auth mode sequence

public

Definition at line 126 of file class.ilAuthModeDetermination.php.

References $server, ilLDAPServer\getInstanceByServerId(), ilLoggerFactory\getLogger(), and ilLDAPServer\getServerIdByAuthMode().

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

Here is the call graph for this function:

getCountActiveAuthModes()

ilAuthModeDetermination::getCountActiveAuthModes

(

)

get number of auth modes

public

Definition at line 163 of file class.ilAuthModeDetermination.php.

    {
        return count($this->position);
    }

getKind()

ilAuthModeDetermination::getKind

(

)

get kind

public

Definition at line 103 of file class.ilAuthModeDetermination.php.

References $kind.

Referenced by save().

    {
        return $this->kind;
    }

Here is the caller graph for this function:

isManualSelection()

ilAuthModeDetermination::isManualSelection

(

)

is manual selection

public

Parameters

Definition at line 92 of file class.ilAuthModeDetermination.php.

    {
        return $this->kind == self::TYPE_MANUAL;
    }

read()

ilAuthModeDetermination::read ( )

private

Read settings.

private

Parameters

Definition at line 207 of file class.ilAuthModeDetermination.php.

References $DIC, $i, $ilSetting, $server, ilLDAPServer\_getActiveServerList(), ilRadiusSettings\_getInstance(), AUTH_APACHE, AUTH_LDAP, AUTH_LOCAL, AUTH_RADIUS, AUTH_SOAP, ilAuthUtils\getAuthPlugins(), ilLDAPServer\getInstanceByServerId(), ilLDAPServer\getServerIdByAuthMode(), and settings().

Referenced by __construct().

    {
        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
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilAuthModeDetermination::save

(

)

Save settings.

public

Parameters

Definition at line 187 of file class.ilAuthModeDetermination.php.

References getKind(), and settings().

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

Here is the call graph for this function:

setAuthModeSequence()

ilAuthModeDetermination::setAuthModeSequence

(

$a_pos

)

set auth mode sequence

public

Parameters

array

position => AUTH_MODE

Definition at line 175 of file class.ilAuthModeDetermination.php.

    {
        $this->position = $a_pos;
    }

setKind()

ilAuthModeDetermination::setKind

(

$a_kind

)

set kind of determination

public

Parameters

int	TYPE_MANUAL or TYPE_DETERMINATION

Definition at line 115 of file class.ilAuthModeDetermination.php.

    {
        $this->kind = $a_kind;
    }

Field Documentation

$db

ilAuthModeDetermination::$db = null

protected

Definition at line 41 of file class.ilAuthModeDetermination.php.

$instance

ilAuthModeDetermination::$instance = null

staticprotected

Definition at line 39 of file class.ilAuthModeDetermination.php.

$kind

ilAuthModeDetermination::$kind = 0

protected

Definition at line 44 of file class.ilAuthModeDetermination.php.

Referenced by getKind().

$position

ilAuthModeDetermination::$position = array()

protected

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

$settings

ilAuthModeDetermination::$settings = null

protected

Definition at line 42 of file class.ilAuthModeDetermination.php.

TYPE_AUTOMATIC

const ilAuthModeDetermination::TYPE_AUTOMATIC = 1

Definition at line 37 of file class.ilAuthModeDetermination.php.

TYPE_MANUAL

const ilAuthModeDetermination::TYPE_MANUAL = 0

Definition at line 36 of file class.ilAuthModeDetermination.php.

---

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

• Services/Authentication/classes/class.ilAuthModeDetermination.php