ilLDAPServer Class Reference

Collaboration diagram for ilLDAPServer:

Public Member Functions
	__construct ($a_server_id=0)
	rotateFallbacks ()
	Rotate fallback urls in case of connect timeouts. More...
	getServerId ()
	enableAuthentication ($a_status)
	Enable authentication for this ldap server. More...
	isAuthenticationEnabled ()
	Check if authentication is enabled. More...
	setAuthenticationMapping ($a_map)
	Set mapped authentication mapping. More...
	getAuthenticationMapping ()
	Get authentication mode that is mapped. More...
	getAuthenticationMappingKey ()
	Get authentication mapping key Default is ldap. More...
	toggleActive ($a_status)
	isActive ()
	getUrl ()
	setUrl ($a_url)
	getUrlString ()
	doConnectionCheck ()
	Check ldap connection and do a fallback to the next server if no connection is possible. More...
	getName ()
	setName ($a_name)
	getVersion ()
	setVersion ($a_version)
	getBaseDN ()
	setBaseDN ($a_base_dn)
	isActiveReferrer ()
	toggleReferrer ($a_status)
	isActiveTLS ()
	toggleTLS ($a_status)
	getBindingType ()
	setBindingType ($a_type)
	getBindUser ()
	setBindUser ($a_user)
	getBindPassword ()
	setBindPassword ($a_password)
	getSearchBase ()
	setSearchBase ($a_search_base)
	getUserAttribute ()
	setUserAttribute ($a_user_attr)
	getFilter ()
	setFilter ($a_filter)
	getGroupDN ()
	setGroupDN ($a_value)
	getGroupFilter ()
	setGroupFilter ($a_value)
	getGroupMember ()
	setGroupMember ($a_value)
	getGroupName ()
	setGroupName ($a_value)
	getGroupNames ()
	Get group names as array. More...
	getGroupAttribute ()
	setGroupAttribute ($a_value)
	toggleMembershipOptional ($a_status)
	isMembershipOptional ()
	setGroupUserFilter ($a_filter)
	getGroupUserFilter ()
	enabledGroupMemberIsDN ()
	enableGroupMemberIsDN ($a_value)
	setGroupScope ($a_value)
	getGroupScope ()
	setUserScope ($a_value)
	getUserScope ()
	enabledSyncOnLogin ()
	enableSyncOnLogin ($a_value)
	enabledSyncPerCron ()
	enableSyncPerCron ($a_value)
	setGlobalRole ($a_role)
	getRoleBindDN ()
	setRoleBindDN ($a_value)
	getRoleBindPassword ()
	setRoleBindPassword ($a_value)
	enabledRoleSynchronization ()
	enableRoleSynchronization ($a_value)
	getUsernameFilter ()
	setUsernameFilter ($a_value)
	enableEscapeDN (bool $a_value)
	enabledEscapeDN ()
	enableAccountMigration ($a_status)
	Enable account migration. More...
	isAccountMigrationEnabled ()
	enabled account migration More...
	validate ()
	Validate user input. More...
	create ()
	update ()
	delete ()
	delete More...
	toPearAuthArray ()
	Creates an array of options compatible to PEAR Auth. More...

Static Public Member Functions
static	getInstanceByServerId ($a_server_id)
	Get instance by server id. More...
static	checkLDAPLib ()
	Check if ldap module is installed. More...
static	_getActiveServerList ()
	Get active server list. More...
static	_getCronServerIds ()
	Get list of acticve servers with option 'SyncCron'. More...
static	_getRoleSyncServerIds ()
	Check whether there if there is an active server with option role_sync_active. More...
static	_getPasswordServers ()
	Checks whether password synchronistation is enabled for an user. More...
static	_getFirstActiveServer ()
	Get first active server. More...
static	_getServerList ()
	Get list of all configured servers. More...
static	getServerIds ()
	Get all server ids ilDB $ilDB. More...
static	_getAllServer ()
	Get list of all configured servers. More...
static	_getFirstServer ()
static	getAvailableDataSources ($a_auth_mode)
static	isDataSourceActive ($a_auth_mode)
	Check if a data source is active for a specific auth mode ilDB $ilDB. More...
static	getDataSource ($a_auth_mode)
static	disableDataSourceForAuthMode ($a_authmode)
	Disable data source. More...
static	toggleDataSource ($a_ldap_server_id, $a_auth_mode, $a_status)
	Toggle Data Source. More...
static	isAuthModeLDAP ($a_auth_mode)
	Check if user auth mode is LDAP. More...
static	getServerIdByAuthMode ($a_auth_mode)
	Get auth id by auth mode. More...
static	getAuthModeByKey ($a_auth_key)
	get auth mode by key More...
static	getKeyByAuthMode ($a_auth_mode)
	Get auth id by auth mode. More...

Data Fields
const	DEBUG = false
const	DEFAULT_VERSION = 3
const	DEFAULT_NETWORK_TIMEOUT = 5

Private Member Functions
	prepareFilter ($a_filter)
	Create brackets for filters if they do not exist. More...
	getPearAtributeArray ()
	Get attribute array for pear auth data. More...
	read ()
	Read server settings. More...

Private Attributes
	$role_bind_dn = ''
	$role_bind_pass = ''
	$role_sync_active = 0
	$server_id = null
	$fallback_urls = array()
	$enabled_authentication = true
	$authentication_mapping = 0
	$escape_dn = false

Static Private Attributes
static	$instances = array()

Detailed Description

Author

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

Version

$Id$

Definition at line 24 of file class.ilLDAPServer.php.

Constructor & Destructor Documentation

__construct()

ilLDAPServer::__construct

(

$a_server_id = 0

)

Definition at line 43 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $lng, and read().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $lng = $DIC['lng'];

        $this->db = $ilDB;
        $this->lng = $lng;
        $this->server_id = $a_server_id;
        
        $this->read();
    }

Here is the call graph for this function:

Member Function Documentation

_getActiveServerList()

static ilLDAPServer::_getActiveServerList ( )

static

Get active server list.

Returns

array server ids of active ldap server

Definition at line 109 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, and $row.

Referenced by ilAuthUtils\_getActiveAuthModes(), _getFirstActiveServer(), ilAuthUtils\_getMultipleAuthModeOptions(), _getPasswordServers(), ilAuthUtils\_hasMultipleAuthenticationMethods(), ilAuthUtils\_isExternalAccountEnabled(), ilUserImportParser\importBeginTag(), ilAuthModeDetermination\read(), and ilUserImportParser\verifyBeginTag().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT server_id FROM ldap_server_settings " .
            "WHERE active = 1 AND authentication = 1 " .
            "ORDER BY name ";
        $res = $ilDB->query($query);
        $server_ids = array();
        while ($row = $ilDB->fetchObject($res)) {
            $server_ids[] = $row->server_id;
        }
        return $server_ids;
    }

Here is the caller graph for this function:

_getAllServer()

static ilLDAPServer::_getAllServer ( )

static

Get list of all configured servers.

Returns

array list of server

Definition at line 249 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, $row, and $server.

Referenced by ilLDAPServerTableGUI\importData().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT * FROM ldap_server_settings ORDER BY name";
        
        $server = array();
        
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchAssoc($res)) {
            $server[] = $row;
        }
        return $server;
    }

Here is the caller graph for this function:

_getCronServerIds()

static ilLDAPServer::_getCronServerIds ( )

static

Get list of acticve servers with option 'SyncCron'.

Returns

array server ids of active ldap server

Definition at line 131 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, and $row.

Referenced by ilLDAPCronSynchronization\run().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT server_id FROM ldap_server_settings " .
            "WHERE active = 1 " .
            "AND sync_per_cron = 1 " .
            "ORDER BY name";
            
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $server_ids[] = $row->server_id;
        }
        return $server_ids ? $server_ids : array();
    }

Here is the caller graph for this function:

_getFirstActiveServer()

static ilLDAPServer::_getFirstActiveServer ( )

static

Get first active server.

Returns

int first active server

Definition at line 192 of file class.ilLDAPServer.php.

References _getActiveServerList().

Referenced by ilECSCmsCourseMemberCommandQueueHandler\createMember(), and ilAuthLoginPageEditorGUI\initLoginForm().

    {
        $servers = ilLDAPServer::_getActiveServerList();
        if (count($servers)) {
            return $servers[0];
        }
        return 0;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getFirstServer()

static ilLDAPServer::_getFirstServer ( )

static

Definition at line 271 of file class.ilLDAPServer.php.

References _getServerList().

    {
        $servers = ilLDAPServer::_getServerList();
        
        if (count($servers)) {
            return $servers[0];
        }
        return 0;
    }

Here is the call graph for this function:

_getPasswordServers()

static ilLDAPServer::_getPasswordServers ( )

static

Checks whether password synchronistation is enabled for an user.

public

Parameters

int

user_id

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

References _getActiveServerList().

    {
        return ilLDAPServer::_getActiveServerList();
    }

Here is the call graph for this function:

_getRoleSyncServerIds()

static ilLDAPServer::_getRoleSyncServerIds ( )

static

Check whether there if there is an active server with option role_sync_active.

public

Parameters

Definition at line 156 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, and $row.

Referenced by ilLDAPRoleGroupMapping\initServers().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT server_id FROM ldap_server_settings " .
            "WHERE active = 1 " .
            "AND role_sync_active = 1 ";
            
        $res = $ilDB->query($query);
        $server_ids = array();
        while ($row = $ilDB->fetchObject($res)) {
            $server_ids[] = $row->server_id;
        }
        return $server_ids;
    }

Here is the caller graph for this function:

_getServerList()

static ilLDAPServer::_getServerList ( )

static

Get list of all configured servers.

Returns

array list of server ids

Definition at line 206 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, and $row.

Referenced by ilAuthUtils\_getAllAuthModes(), _getFirstServer(), and ilLDAPSettingsGUI\setSubTabs().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT server_id FROM ldap_server_settings ORDER BY name";
        
        $res = $ilDB->query($query);
        while ($row = $ilDB->fetchObject($res)) {
            $server_ids[] = $row->server_id;
        }
        return $server_ids ? $server_ids : array();
    }

Here is the caller graph for this function:

checkLDAPLib()

static ilLDAPServer::checkLDAPLib ( )

static

Check if ldap module is installed.

Returns

Definition at line 99 of file class.ilLDAPServer.php.

Referenced by ilLDAPSettingsGUI\serverList().

    {
        return function_exists('ldap_bind');
    }

Here is the caller graph for this function:

create()

ilLDAPServer::create

(

)

Definition at line 872 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, enabledEscapeDN(), enabledGroupMemberIsDN(), enabledRoleSynchronization(), enabledSyncOnLogin(), enabledSyncPerCron(), getAuthenticationMapping(), getBaseDN(), getBindingType(), getBindPassword(), getBindUser(), getFilter(), getGroupAttribute(), getGroupDN(), getGroupFilter(), getGroupMember(), getGroupName(), getGroupScope(), getGroupUserFilter(), getName(), getRoleBindDN(), getRoleBindPassword(), getSearchBase(), getUrlString(), getUserAttribute(), getUsernameFilter(), getUserScope(), getVersion(), isAccountMigrationEnabled(), isActive(), isActiveReferrer(), isActiveTLS(), isAuthenticationEnabled(), and isMembershipOptional().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        $next_id = $ilDB->nextId('ldap_server_settings');
        
        $query = 'INSERT INTO ldap_server_settings (server_id,active,name,url,version,base_dn,referrals,tls,bind_type,bind_user,bind_pass,' .
            'search_base,user_scope,user_attribute,filter,group_dn,group_scope,group_filter,group_member,group_memberisdn,group_name,' .
            'group_attribute,group_optional,group_user_filter,sync_on_login,sync_per_cron,role_sync_active,role_bind_dn,role_bind_pass,migration, ' .
            'authentication,authentication_type,username_filter, escape_dn) ' .
            'VALUES (%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s,%s)';
        $res = $ilDB->queryF(
            $query,
            array(
                'integer','integer','text','text','integer','text','integer','integer','integer','text','text','text','integer',
                'text','text','text','integer','text','text','integer','text','text','integer','text','integer','integer','integer',
                'text','text', 'integer','integer','integer',"text", 'integer'),
            array(
                $next_id,
                $this->isActive(),
                $this->getName(),
                $this->getUrlString(),
                $this->getVersion(),
                $this->getBaseDN(),
                $this->isActiveReferrer(),
                $this->isActiveTLS(),
                $this->getBindingType(),
                $this->getBindUser(),
                $this->getBindPassword(),
                $this->getSearchBase(),
                $this->getUserScope(),
                $this->getUserAttribute(),
                $this->getFilter(),
                $this->getGroupDN(),
                $this->getGroupScope(),
                $this->getGroupFilter(),
                $this->getGroupMember(),
                $this->enabledGroupMemberIsDN(),
                $this->getGroupName(),
                $this->getGroupAttribute(),
                $this->isMembershipOptional(),
                $this->getGroupUserFilter(),
                $this->enabledSyncOnLogin(),
                $this->enabledSyncPerCron(),
                $this->enabledRoleSynchronization(),
                $this->getRoleBindDN(),
                $this->getRoleBindPassword(),
                $this->isAccountMigrationEnabled(),
                $this->isAuthenticationEnabled(),
                $this->getAuthenticationMapping(),
                $this->getUsernameFilter(),
                (int) $this->enabledEscapeDN()
            )
        );
        // end Patch Name Filter
        $this->server_id = $next_id;
        return $next_id;
    }

Here is the call graph for this function:

delete()

ilLDAPServer::delete

(

)

delete

Definition at line 981 of file class.ilLDAPServer.php.

References $query, $res, ilLDAPAttributeMapping\_delete(), ilLDAPRoleGroupMappingSettings\_deleteByServerId(), ilLDAPRoleAssignmentRule\_getRules(), and getServerId().

    {
        if (!$this->getServerId()) {
            return false;
        }
        
        include_once 'Services/LDAP/classes/class.ilLDAPAttributeMapping.php';
        ilLDAPAttributeMapping::_delete($this->getServerId());
        
        include_once 'Services/LDAP/classes/class.ilLDAPRoleAssignmentRule.php';
        $rules = ilLDAPRoleAssignmentRule::_getRules($this->getServerId());
        
        foreach ($rules as $ruleAssigment) {
            $ruleAssigment->delete();
        }
        
        include_once 'Services/LDAP/classes/class.ilLDAPRoleGroupMappingSettings.php';
        ilLDAPRoleGroupMappingSettings::_deleteByServerId($this->getServerId());
        
        $query = "DELETE FROM ldap_server_settings " .
            "WHERE server_id = " . $this->db->quote($this->getServerId(), 'integer');
        $res = $this->db->manipulate($query);
    }

Here is the call graph for this function:

disableDataSourceForAuthMode()

static ilLDAPServer::disableDataSourceForAuthMode (   $a_authmode )

static

Disable data source.

Definition at line 342 of file class.ilLDAPServer.php.

References $DIC, $ilDB, and $query.

Referenced by ilRadiusSettingsGUI\save(), and ilCASSettingsGUI\save().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = 'UPDATE ldap_server_settings ' .
            'SET authentication_type = ' . $ilDB->quote(0, 'integer') . ' ' .
            'WHERE authentication_type = ' . $ilDB->quote($a_authmode, 'integer');
        $ilDB->manipulate($query);
        return true;
    }

Here is the caller graph for this function:

doConnectionCheck()

ilLDAPServer::doConnectionCheck

(

)

Check ldap connection and do a fallback to the next server if no connection is possible.

public

Definition at line 537 of file class.ilLDAPServer.php.

References $query, $url, ilLoggerFactory\getLogger(), IL_LDAP_BIND_TEST, and rotateFallbacks().

    {
        include_once('Services/LDAP/classes/class.ilLDAPQuery.php');
        
        foreach (array_merge(array(0 => $this->url), $this->fallback_urls) as $url) {
            try {
                ilLoggerFactory::getLogger('auth')->debug('Using url: ' . $url);
                // Need to do a full bind, since openldap return valid connection links for invalid hosts
                $query = new ilLDAPQuery($this, $url);
                $query->bind(IL_LDAP_BIND_TEST);
                $this->url = $url;
                return true;
            } catch (ilLDAPQueryException $exc) {
                $this->rotateFallbacks();
                ilLoggerFactory::getLogger('auth')->error('Cannot connect to LDAP server: ' . $url . ' ' . $exc->getCode() . ' ' . $exc->getMessage());
            }
        }
        ilLoggerFactory::getLogger('auth')->warning('No valid LDAP server found');
        return false;
    }

Here is the call graph for this function:

enableAccountMigration()

ilLDAPServer::enableAccountMigration

(

$a_status

)

Enable account migration.

public

Parameters

bool

status

Definition at line 821 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->account_migration = $a_status;
    }

Here is the caller graph for this function:

enableAuthentication()

ilLDAPServer::enableAuthentication

(

$a_status

)

Enable authentication for this ldap server.

Parameters

bool

$a_status

Definition at line 448 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->enabled_authentication = (bool) $a_status;
    }

Here is the caller graph for this function:

enabledEscapeDN()

ilLDAPServer::enabledEscapeDN

(

)

Definition at line 809 of file class.ilLDAPServer.php.

References $escape_dn.

Referenced by create(), toPearAuthArray(), and update().

                                      : bool
    {
        return $this->escape_dn;
    }

Here is the caller graph for this function:

enabledGroupMemberIsDN()

ilLDAPServer::enabledGroupMemberIsDN

(

)

Definition at line 726 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), and update().

    {
        return (bool) $this->memberisdn;
    }

Here is the caller graph for this function:

enabledRoleSynchronization()

ilLDAPServer::enabledRoleSynchronization

(

)

Definition at line 786 of file class.ilLDAPServer.php.

References $role_sync_active.

Referenced by create(), and update().

    {
        return $this->role_sync_active;
    }

Here is the caller graph for this function:

enabledSyncOnLogin()

ilLDAPServer::enabledSyncOnLogin

(

)

Definition at line 750 of file class.ilLDAPServer.php.

Referenced by create(), getPearAtributeArray(), update(), and validate().

    {
        return $this->sync_on_login;
    }

Here is the caller graph for this function:

enabledSyncPerCron()

ilLDAPServer::enabledSyncPerCron

(

)

Definition at line 758 of file class.ilLDAPServer.php.

Referenced by create(), update(), and validate().

    {
        return $this->sync_per_cron;
    }

Here is the caller graph for this function:

enableEscapeDN()

ilLDAPServer::enableEscapeDN

(

bool

$a_value

)

Definition at line 804 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->escape_dn = $a_value;
    }

Here is the caller graph for this function:

enableGroupMemberIsDN()

ilLDAPServer::enableGroupMemberIsDN

(

$a_value

)

Definition at line 730 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->memberisdn = (bool) $a_value;
    }

Here is the caller graph for this function:

enableRoleSynchronization()

ilLDAPServer::enableRoleSynchronization

(

$a_value

)

Definition at line 790 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->role_sync_active = $a_value;
    }

Here is the caller graph for this function:

enableSyncOnLogin()

ilLDAPServer::enableSyncOnLogin

(

$a_value

)

Definition at line 754 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->sync_on_login = (int) $a_value;
    }

Here is the caller graph for this function:

enableSyncPerCron()

ilLDAPServer::enableSyncPerCron

(

$a_value

)

Definition at line 762 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->sync_per_cron = (int) $a_value;
    }

Here is the caller graph for this function:

getAuthenticationMapping()

ilLDAPServer::getAuthenticationMapping

(

)

Get authentication mode that is mapped.

Returns

int

Definition at line 475 of file class.ilLDAPServer.php.

References $authentication_mapping.

Referenced by create(), getAuthenticationMappingKey(), and update().

    {
        return $this->authentication_mapping;
    }

Here is the caller graph for this function:

getAuthenticationMappingKey()

ilLDAPServer::getAuthenticationMappingKey

(

)

Get authentication mapping key Default is ldap.

Returns

string

Definition at line 485 of file class.ilLDAPServer.php.

References ilAuthUtils\_getAuthModeName(), getAuthenticationMapping(), getServerId(), and isAuthenticationEnabled().

Referenced by ilLDAPCronSynchronization\deactivateUsers().

    {
        if ($this->isAuthenticationEnabled() or !$this->getAuthenticationMapping()) {
            // begin-patch ldap_multiple
            return 'ldap_' . $this->getServerId();
            #return 'ldap';
            // end-patch ldap_multiple
        }
        return ilAuthUtils::_getAuthModeName($this->getAuthenticationMapping());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAuthModeByKey()

static ilLDAPServer::getAuthModeByKey (   $a_auth_key )

static

get auth mode by key

Parameters

type

$a_auth_key

Definition at line 413 of file class.ilLDAPServer.php.

Referenced by ilAuthUtils\_getAuthModeName().

    {
        $auth_arr = explode('_', $a_auth_key);
        if (count((array) $auth_arr) > 1) {
            return 'ldap_' . $auth_arr[1];
        }
        return 'ldap';
    }

Here is the caller graph for this function:

getAvailableDataSources()

static ilLDAPServer::getAvailableDataSources (   $a_auth_mode )

static

Definition at line 282 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilCASSettingsGUI\initFormSettings(), and ilRadiusSettingsGUI\settings().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT server_id FROM ldap_server_settings " .
            "WHERE active = " . $ilDB->quote(1, 'integer') . " " .
            "AND authentication = " . $ilDB->quote(0, 'integer') . " " .
            "AND ( authentication_type = " . $ilDB->quote($a_auth_mode, 'integer') . " " .
            "OR authentication_type = " . $ilDB->quote(0, 'integer') . ")";
        $res = $ilDB->query($query);

        $server_ids = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $server_ids[] = $row->server_id;
        }
        return $server_ids;
    }

Here is the caller graph for this function:

getBaseDN()

ilLDAPServer::getBaseDN

(

)

Definition at line 575 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), update(), and validate().

    {
        return $this->base_dn;
    }

Here is the caller graph for this function:

getBindingType()

ilLDAPServer::getBindingType

(

)

Definition at line 599 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), update(), and validate().

    {
        return $this->binding_type;
    }

Here is the caller graph for this function:

getBindPassword()

ilLDAPServer::getBindPassword

(

)

Definition at line 619 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), update(), and validate().

    {
        return $this->bind_password;
    }

Here is the caller graph for this function:

getBindUser()

ilLDAPServer::getBindUser

(

)

Definition at line 611 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), update(), and validate().

    {
        return $this->bind_user;
    }

Here is the caller graph for this function:

getDataSource()

static ilLDAPServer::getDataSource (   $a_auth_mode )

static

Definition at line 324 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjAuthSettingsGUI\getApacheAuthSettingsForm(), ilAuthProviderCAS\handleLDAPDataSource(), ilAuthContainerCAS\handleLDAPDataSource(), ilCASSettingsGUI\initFormSettings(), and ilRadiusSettingsGUI\settings().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT server_id FROM ldap_server_settings " .
            "WHERE authentication_type = " . $ilDB->quote($a_auth_mode, 'integer') . " ";
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return $row->server_id;
        }
        return 0;
    }

Here is the caller graph for this function:

getFilter()

ilLDAPServer::getFilter

(

)

Definition at line 643 of file class.ilLDAPServer.php.

References prepareFilter().

Referenced by create(), toPearAuthArray(), and update().

    {
        return $this->prepareFilter($this->filter);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGroupAttribute()

ilLDAPServer::getGroupAttribute

(

)

Definition at line 700 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), and update().

    {
        return $this->group_attribute;
    }

Here is the caller graph for this function:

getGroupDN()

ilLDAPServer::getGroupDN

(

)

Definition at line 651 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), and update().

    {
        return $this->group_dn;
    }

Here is the caller graph for this function:

getGroupFilter()

ilLDAPServer::getGroupFilter

(

)

Definition at line 659 of file class.ilLDAPServer.php.

References prepareFilter().

Referenced by create(), toPearAuthArray(), and update().

    {
        return $this->prepareFilter($this->group_filter);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getGroupMember()

ilLDAPServer::getGroupMember

(

)

Definition at line 667 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), and update().

    {
        return $this->group_member;
    }

Here is the caller graph for this function:

getGroupName()

ilLDAPServer::getGroupName

(

)

Definition at line 675 of file class.ilLDAPServer.php.

Referenced by create(), getGroupNames(), toPearAuthArray(), and update().

    {
        return $this->group_name;
    }

Here is the caller graph for this function:

getGroupNames()

ilLDAPServer::getGroupNames

(

)

Get group names as array.

Returns

string[]

Definition at line 688 of file class.ilLDAPServer.php.

References getGroupName().

    {
        $names = explode(',', $this->getGroupName());

        if (!is_array($names)) {
            return array();
        }

        return array_filter(array_map('trim', $names));
    }

Here is the call graph for this function:

getGroupScope()

ilLDAPServer::getGroupScope

(

)

Definition at line 738 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), and update().

    {
        return $this->group_scope;
    }

Here is the caller graph for this function:

getGroupUserFilter()

ilLDAPServer::getGroupUserFilter

(

)

Definition at line 721 of file class.ilLDAPServer.php.

Referenced by create(), and update().

    {
        return $this->group_user_filter;
    }

Here is the caller graph for this function:

getInstanceByServerId()

static ilLDAPServer::getInstanceByServerId (   $a_server_id )

static

Get instance by server id.

Parameters

type

$a_server_id

Returns

ilLDAPServer

Definition at line 62 of file class.ilLDAPServer.php.

Referenced by ilAuthUtils\_getMultipleAuthModeOptions(), ilObjAuthSettingsGUI\authSettingsObject(), ilECSCmsCourseMemberCommandQueueHandler\createMember(), ilECSMappingUtils\getAuthModeSelection(), ilAuthModeDetermination\getAuthModeSequence(), ilAuthUtils\getAuthModeTranslation(), ilAuthProviderCAS\handleLDAPDataSource(), ilAuthContainerCAS\handleLDAPDataSource(), ilAuthProviderApache\handleLDAPDataSource(), ilObjAuthSettingsGUI\initAuthModeDetermination(), ilLDAPUserSynchronisation\initServer(), ilLDAPRoleAssignmentRule\isGroupMember(), and ilAuthModeDetermination\read().

    {
        if (isset(self::$instances[$a_server_id])) {
            return self::$instances[$a_server_id];
        }
        return self::$instances[$a_server_id] = new ilLDAPServer($a_server_id);
    }

Here is the caller graph for this function:

getKeyByAuthMode()

static ilLDAPServer::getKeyByAuthMode (   $a_auth_mode )

static

Get auth id by auth mode.

Parameters

string

$a_auth_mode

Returns

int auth_mode

Definition at line 427 of file class.ilLDAPServer.php.

References AUTH_LDAP.

Referenced by ilAuthUtils\_getAuthMode().

    {
        $auth_arr = explode('_', $a_auth_mode);
        if (count((array) $auth_arr) > 1) {
            return AUTH_LDAP . '_' . $auth_arr[1];
        }
        return AUTH_LDAP;
    }

Here is the caller graph for this function:

getName()

ilLDAPServer::getName

(

)

Definition at line 559 of file class.ilLDAPServer.php.

References $name.

Referenced by create(), update(), and validate().

    {
        return $this->name;
    }

Here is the caller graph for this function:

getPearAtributeArray()

ilLDAPServer::getPearAtributeArray ( )

private

Get attribute array for pear auth data.

private

Parameters

Definition at line 1097 of file class.ilLDAPServer.php.

References ilLDAPAttributeMapping\_getInstanceByServerId(), enabledSyncOnLogin(), ilLDAPRoleAssignmentRules\getAttributeNames(), getServerId(), and getUserAttribute().

Referenced by toPearAuthArray().

    {
        if ($this->enabledSyncOnLogin()) {
            include_once('Services/LDAP/classes/class.ilLDAPAttributeMapping.php');
            include_once('Services/LDAP/classes/class.ilLDAPRoleAssignmentRules.php');
            $mapping = ilLDAPAttributeMapping::_getInstanceByServerId($this->getServerId());
            return array_merge(
                array($this->getUserAttribute()),
                $mapping->getFields(),
                array('dn'),
                ilLDAPRoleAssignmentRules::getAttributeNames($this->getServerId())
            );
        } else {
            return array($this->getUserAttribute());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRoleBindDN()

ilLDAPServer::getRoleBindDN

(

)

Definition at line 770 of file class.ilLDAPServer.php.

References $role_bind_dn.

Referenced by create(), and update().

    {
        return $this->role_bind_dn;
    }

Here is the caller graph for this function:

getRoleBindPassword()

ilLDAPServer::getRoleBindPassword

(

)

Definition at line 778 of file class.ilLDAPServer.php.

References $role_bind_pass.

Referenced by create(), and update().

    {
        return $this->role_bind_pass;
    }

Here is the caller graph for this function:

getSearchBase()

ilLDAPServer::getSearchBase

(

)

Definition at line 627 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), and update().

    {
        return $this->search_base;
    }

Here is the caller graph for this function:

getServerId()

ilLDAPServer::getServerId

(

)

Definition at line 439 of file class.ilLDAPServer.php.

References $server_id.

Referenced by delete(), getAuthenticationMappingKey(), getPearAtributeArray(), rotateFallbacks(), and update().

    {
        return $this->server_id;
    }

Here is the caller graph for this function:

getServerIdByAuthMode()

static ilLDAPServer::getServerIdByAuthMode (   $a_auth_mode )

static

Get auth id by auth mode.

Parameters

type

$a_auth_mode

Returns

null

Definition at line 400 of file class.ilLDAPServer.php.

Referenced by ilObjAuthSettingsGUI\authSettingsObject(), ilAuthModeDetermination\getAuthModeSequence(), ilAuthUtils\getAuthModeTranslation(), ilObjAuthSettingsGUI\initAuthModeDetermination(), and ilAuthModeDetermination\read().

    {
        if (self::isAuthModeLDAP($a_auth_mode)) {
            $auth_arr = explode('_', $a_auth_mode);
            return $auth_arr[1];
        }
        return null;
    }

Here is the caller graph for this function:

getServerIds()

static ilLDAPServer::getServerIds ( )

static

Get all server ids ilDB $ilDB.

Returns

array int

Definition at line 226 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, $row, $server, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilObjAuthSettingsGUI\getApacheAuthSettingsForm(), and ilECSMappingUtils\getAuthModeSelection().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        $query = "SELECT server_id FROM ldap_server_settings ORDER BY name";
        
        
        $res = $ilDB->query($query);

        $server = array();
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $server[] = $row->server_id;
        }
        return $server;
    }

Here is the caller graph for this function:

getUrl()

ilLDAPServer::getUrl

(

)

Definition at line 504 of file class.ilLDAPServer.php.

References $url.

Referenced by rotateFallbacks(), toPearAuthArray(), and validate().

    {
        return $this->url;
    }

Here is the caller graph for this function:

getUrlString()

ilLDAPServer::getUrlString

(

)

Definition at line 525 of file class.ilLDAPServer.php.

Referenced by create(), and update().

    {
        return $this->url_string;
    }

Here is the caller graph for this function:

getUserAttribute()

ilLDAPServer::getUserAttribute

(

)

Definition at line 635 of file class.ilLDAPServer.php.

Referenced by create(), getPearAtributeArray(), toPearAuthArray(), update(), and validate().

    {
        return $this->user_attribute;
    }

Here is the caller graph for this function:

getUsernameFilter()

ilLDAPServer::getUsernameFilter

(

)

Definition at line 795 of file class.ilLDAPServer.php.

Referenced by create(), and update().

    {
        return $this->username_filter;
    }

Here is the caller graph for this function:

getUserScope()

ilLDAPServer::getUserScope

(

)

Definition at line 746 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), and update().

    {
        return $this->user_scope;
    }

Here is the caller graph for this function:

getVersion()

ilLDAPServer::getVersion

(

)

Definition at line 567 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), update(), and validate().

    {
        return $this->version ? $this->version : self::DEFAULT_VERSION;
    }

Here is the caller graph for this function:

isAccountMigrationEnabled()

ilLDAPServer::isAccountMigrationEnabled

(

)

enabled account migration

public

Definition at line 832 of file class.ilLDAPServer.php.

Referenced by create(), and update().

    {
        return $this->account_migration ? true : false;
    }

Here is the caller graph for this function:

isActive()

ilLDAPServer::isActive

(

)

Definition at line 500 of file class.ilLDAPServer.php.

Referenced by create(), and update().

    {
        return $this->active;
    }

Here is the caller graph for this function:

isActiveReferrer()

ilLDAPServer::isActiveReferrer

(

)

Definition at line 583 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), and update().

    {
        return $this->referrals ? true : false;
    }

Here is the caller graph for this function:

isActiveTLS()

ilLDAPServer::isActiveTLS

(

)

Definition at line 591 of file class.ilLDAPServer.php.

Referenced by create(), toPearAuthArray(), update(), and validate().

    {
        return $this->tls ? true : false;
    }

Here is the caller graph for this function:

isAuthenticationEnabled()

ilLDAPServer::isAuthenticationEnabled

(

)

Check if authentication is enabled.

Returns

bool

Definition at line 457 of file class.ilLDAPServer.php.

References $enabled_authentication.

Referenced by create(), getAuthenticationMappingKey(), and update().

    {
        return (bool) $this->enabled_authentication;
    }

Here is the caller graph for this function:

isAuthModeLDAP()

static ilLDAPServer::isAuthModeLDAP (   $a_auth_mode )

static

Check if user auth mode is LDAP.

Parameters

type

$a_auth_mode

Definition at line 385 of file class.ilLDAPServer.php.

References $GLOBALS, and AUTH_LDAP.

Referenced by ilObjAuthSettingsGUI\authSettingsObject(), and ilObjAuthSettingsGUI\initAuthModeDetermination().

    {
        if (!$a_auth_mode) {
            $GLOBALS['DIC']['ilLog']->write(__METHOD__ . ': No auth mode given..............');
            return false;
        }
        $auth_arr = explode('_', $a_auth_mode);
        return ($auth_arr[0] == AUTH_LDAP) and $auth_arr[1];
    }

Here is the caller graph for this function:

isDataSourceActive()

static ilLDAPServer::isDataSourceActive (   $a_auth_mode )

static

Check if a data source is active for a specific auth mode ilDB $ilDB.

Parameters

int

$a_auth_mode

Returns

bool

Definition at line 308 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, $row, and ilDBConstants\FETCHMODE_OBJECT.

Referenced by ilAuthProviderCAS\doAuthentication(), ilCASSettingsGUI\initFormSettings(), ilAuthContainerCAS\loginObserver(), and ilRadiusSettingsGUI\settings().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT server_id FROM ldap_server_settings " .
            "WHERE authentication_type = " . $ilDB->quote($a_auth_mode, 'integer') . " " .
            "AND authentication = " . $ilDB->quote(0, 'integer');
        $res = $ilDB->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

isMembershipOptional()

ilLDAPServer::isMembershipOptional

(

)

Definition at line 713 of file class.ilLDAPServer.php.

Referenced by create(), and update().

    {
        return (bool) $this->group_optional;
    }

Here is the caller graph for this function:

prepareFilter()

ilLDAPServer::prepareFilter (   $a_filter )

private

Create brackets for filters if they do not exist.

private

Parameters

string

filter

Definition at line 1073 of file class.ilLDAPServer.php.

Referenced by getFilter(), and getGroupFilter().

    {
        $filter = trim($a_filter);
        
        if (!strlen($filter)) {
            return $filter;
        }
        
        if (strpos($filter, '(') !== 0) {
            $filter = ('(' . $filter);
        }
        if (substr($filter, -1) != ')') {
            $filter = ($filter . ')');
        }
        return $filter;
    }

Here is the caller graph for this function:

read()

ilLDAPServer::read ( )

private

Read server settings.

Definition at line 1120 of file class.ilLDAPServer.php.

References $query, $res, $row, enableAccountMigration(), enableAuthentication(), enableEscapeDN(), enableGroupMemberIsDN(), enableRoleSynchronization(), enableSyncOnLogin(), enableSyncPerCron(), ilDBConstants\FETCHMODE_OBJECT, setAuthenticationMapping(), setBaseDN(), setBindingType(), setBindPassword(), setBindUser(), setFilter(), setGroupAttribute(), setGroupDN(), setGroupFilter(), setGroupMember(), setGroupName(), setGroupScope(), setGroupUserFilter(), setName(), setRoleBindDN(), setRoleBindPassword(), setSearchBase(), setUrl(), setUserAttribute(), setUsernameFilter(), setUserScope(), setVersion(), toggleActive(), toggleMembershipOptional(), toggleReferrer(), and toggleTLS().

Referenced by __construct().

    {
        if (!$this->server_id) {
            return true;
        }
        $query = "SELECT * FROM ldap_server_settings WHERE server_id = " . $this->db->quote($this->server_id) . "";
        
        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->toggleActive($row->active);
            $this->setName($row->name);
            $this->setUrl($row->url);
            $this->setVersion($row->version);
            $this->setBaseDN($row->base_dn);
            $this->toggleReferrer($row->referrals);
            $this->toggleTLS($row->tls);
            $this->setBindingType($row->bind_type);
            $this->setBindUser($row->bind_user);
            $this->setBindPassword($row->bind_pass);
            $this->setSearchBase($row->search_base);
            $this->setUserScope($row->user_scope);
            $this->setUserAttribute($row->user_attribute);
            $this->setFilter($row->filter);
            $this->setGroupDN($row->group_dn);
            $this->setGroupScope($row->group_scope);
            $this->setGroupFilter($row->group_filter);
            $this->setGroupMember($row->group_member);
            $this->setGroupAttribute($row->group_attribute);
            $this->toggleMembershipOptional($row->group_optional);
            $this->setGroupUserFilter($row->group_user_filter);
            $this->enableGroupMemberIsDN($row->group_memberisdn);
            $this->setGroupName($row->group_name);
            $this->enableSyncOnLogin($row->sync_on_login);
            $this->enableSyncPerCron($row->sync_per_cron);
            $this->enableRoleSynchronization($row->role_sync_active);
            $this->setRoleBindDN($row->role_bind_dn);
            $this->setRoleBindPassword($row->role_bind_pass);
            $this->enableAccountMigration($row->migration);
            $this->enableAuthentication($row->authentication);
            $this->setAuthenticationMapping($row->authentication_type);
            $this->setUsernameFilter($row->username_filter);
            $this->enableEscapeDN($row->escape_dn);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

rotateFallbacks()

ilLDAPServer::rotateFallbacks

(

)

Rotate fallback urls in case of connect timeouts.

Returns

boolean

Definition at line 74 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, getServerId(), and getUrl().

Referenced by doConnectionCheck().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        if (!$this->fallback_urls) {
            return false;
        }
        
        $all_urls = array_merge($this->fallback_urls);
        $all_urls[] = $this->getUrl();
        
        $query = 'UPDATE ldap_server_settings SET ' .
                'url = ' . $ilDB->quote(implode(',', $all_urls), 'text') . ' ' .
                'WHERE server_id = ' . $ilDB->quote($this->getServerId(), 'integer');
        $ilDB->manipulate($query);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAuthenticationMapping()

ilLDAPServer::setAuthenticationMapping

(

$a_map

)

Set mapped authentication mapping.

Parameters

int

$a_map

Definition at line 466 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->authentication_mapping = $a_map;
    }

Here is the caller graph for this function:

setBaseDN()

ilLDAPServer::setBaseDN

(

$a_base_dn

)

Definition at line 579 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->base_dn = $a_base_dn;
    }

Here is the caller graph for this function:

setBindingType()

ilLDAPServer::setBindingType

(

$a_type

)

Definition at line 603 of file class.ilLDAPServer.php.

References $a_type, IL_LDAP_BIND_ANONYMOUS, and IL_LDAP_BIND_USER.

Referenced by read().

    {
        if ($a_type == IL_LDAP_BIND_USER) {
            $this->binding_type = IL_LDAP_BIND_USER;
        } else {
            $this->binding_type = IL_LDAP_BIND_ANONYMOUS;
        }
    }

Here is the caller graph for this function:

setBindPassword()

ilLDAPServer::setBindPassword

(

$a_password

)

Definition at line 623 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->bind_password = $a_password;
    }

Here is the caller graph for this function:

setBindUser()

ilLDAPServer::setBindUser

(

$a_user

)

Definition at line 615 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->bind_user = $a_user;
    }

Here is the caller graph for this function:

setFilter()

ilLDAPServer::setFilter

(

$a_filter

)

Definition at line 647 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->filter = $a_filter;
    }

Here is the caller graph for this function:

setGlobalRole()

ilLDAPServer::setGlobalRole

(

$a_role

)

Definition at line 766 of file class.ilLDAPServer.php.

    {
        $this->global_role = $a_role;
    }

setGroupAttribute()

ilLDAPServer::setGroupAttribute

(

$a_value

)

Definition at line 704 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->group_attribute = $a_value;
    }

Here is the caller graph for this function:

setGroupDN()

ilLDAPServer::setGroupDN

(

$a_value

)

Definition at line 655 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->group_dn = $a_value;
    }

Here is the caller graph for this function:

setGroupFilter()

ilLDAPServer::setGroupFilter

(

$a_value

)

Definition at line 663 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->group_filter = $a_value;
    }

Here is the caller graph for this function:

setGroupMember()

ilLDAPServer::setGroupMember

(

$a_value

)

Definition at line 671 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->group_member = $a_value;
    }

Here is the caller graph for this function:

setGroupName()

ilLDAPServer::setGroupName

(

$a_value

)

Definition at line 679 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->group_name = $a_value;
    }

Here is the caller graph for this function:

setGroupScope()

ilLDAPServer::setGroupScope

(

$a_value

)

Definition at line 734 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->group_scope = $a_value;
    }

Here is the caller graph for this function:

setGroupUserFilter()

ilLDAPServer::setGroupUserFilter

(

$a_filter

)

Definition at line 717 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->group_user_filter = $a_filter;
    }

Here is the caller graph for this function:

setName()

ilLDAPServer::setName

(

$a_name

)

Definition at line 563 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->name = $a_name;
    }

Here is the caller graph for this function:

setRoleBindDN()

ilLDAPServer::setRoleBindDN

(

$a_value

)

Definition at line 774 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->role_bind_dn = $a_value;
    }

Here is the caller graph for this function:

setRoleBindPassword()

ilLDAPServer::setRoleBindPassword

(

$a_value

)

Definition at line 782 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->role_bind_pass = $a_value;
    }

Here is the caller graph for this function:

setSearchBase()

ilLDAPServer::setSearchBase

(

$a_search_base

)

Definition at line 631 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->search_base = $a_search_base;
    }

Here is the caller graph for this function:

setUrl()

ilLDAPServer::setUrl

(

$a_url

)

Definition at line 508 of file class.ilLDAPServer.php.

References $url, and $urls.

Referenced by read().

    {
        $this->url_string = $a_url;
        
        // Maybe there are more than one url's (comma seperated).
        $urls = explode(',', $a_url);
        
        $counter = 0;
        foreach ($urls as $url) {
            $url = trim($url);
            if (!$counter++) {
                $this->url = $url;
            } else {
                $this->fallback_urls[] = $url;
            }
        }
    }

Here is the caller graph for this function:

setUserAttribute()

ilLDAPServer::setUserAttribute

(

$a_user_attr

)

Definition at line 639 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->user_attribute = $a_user_attr;
    }

Here is the caller graph for this function:

setUsernameFilter()

ilLDAPServer::setUsernameFilter

(

$a_value

)

Definition at line 799 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->username_filter = $a_value;
    }

Here is the caller graph for this function:

setUserScope()

ilLDAPServer::setUserScope

(

$a_value

)

Definition at line 742 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->user_scope = $a_value;
    }

Here is the caller graph for this function:

setVersion()

ilLDAPServer::setVersion

(

$a_version

)

Definition at line 571 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->version = $a_version;
    }

Here is the caller graph for this function:

toggleActive()

ilLDAPServer::toggleActive

(

$a_status

)

Definition at line 496 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->active = $a_status;
    }

Here is the caller graph for this function:

toggleDataSource()

static ilLDAPServer::toggleDataSource (   $a_ldap_server_id,   $a_auth_mode,   $a_status  )

static

Toggle Data Source.

Todo:

handle multiple ldap servers

Parameters

int	$a_auth_mode
int	$a_status

Definition at line 363 of file class.ilLDAPServer.php.

References $DIC, $ilDB, and $query.

Referenced by ilRadiusSettingsGUI\save(), and ilCASSettingsGUI\save().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];
        
        self::disableDataSourceForAuthMode($a_auth_mode);
        
        if ($a_status) {
            $query = "UPDATE ldap_server_settings " .
                'SET authentication_type = ' . $ilDB->quote($a_auth_mode, 'integer') . " " .
                'WHERE server_id = ' . $ilDB->quote($a_ldap_server_id, 'integer');
            $ilDB->manipulate($query);
        }
        return true;
    }

Here is the caller graph for this function:

toggleMembershipOptional()

ilLDAPServer::toggleMembershipOptional

(

$a_status

)

Definition at line 709 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->group_optional = (bool) $a_status;
    }

Here is the caller graph for this function:

toggleReferrer()

ilLDAPServer::toggleReferrer

(

$a_status

)

Definition at line 587 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->referrals = $a_status;
    }

Here is the caller graph for this function:

toggleTLS()

ilLDAPServer::toggleTLS

(

$a_status

)

Definition at line 595 of file class.ilLDAPServer.php.

Referenced by read().

    {
        $this->tls = $a_status;
    }

Here is the caller graph for this function:

toPearAuthArray()

ilLDAPServer::toPearAuthArray

(

)

Creates an array of options compatible to PEAR Auth.

Returns

array auth settings

Definition at line 1010 of file class.ilLDAPServer.php.

References PHPMailer\PHPMailer\$options, DEBUG, enabledEscapeDN(), enabledGroupMemberIsDN(), getBaseDN(), getBindingType(), getBindPassword(), getBindUser(), getFilter(), getGroupAttribute(), getGroupDN(), getGroupFilter(), getGroupMember(), getGroupName(), getGroupScope(), getPearAtributeArray(), getSearchBase(), getUrl(), getUserAttribute(), getUserScope(), getVersion(), IL_LDAP_BIND_USER, IL_LDAP_SCOPE_BASE, IL_LDAP_SCOPE_ONE, isActiveReferrer(), and isActiveTLS().

    {
        $options = array(
            'url' => $this->getUrl(),
            'version' => (int) $this->getVersion(),
            'referrals' => (bool) $this->isActiveReferrer());
        
        if ($this->getBindingType() == IL_LDAP_BIND_USER) {
            $options['binddn'] = $this->getBindUser();
            $options['bindpw'] = $this->getBindPassword();
        }
        $options['basedn'] = $this->getBaseDN();
        $options['start_tls'] = (bool) $this->isActiveTLS();
        $options['userdn'] = $this->getSearchBase();
        switch ($this->getUserScope()) {
            case IL_LDAP_SCOPE_ONE:
                $options['userscope'] = 'one';
                break;
            default:
                $options['userscope'] = 'sub';
                break;
        }
        
        $options['userattr'] = $this->getUserAttribute();
        $options['userfilter'] = $this->getFilter();
        $options['attributes'] = $this->getPearAtributeArray();
        $options['debug'] = self::DEBUG;
        
        if (@include_once('Log.php')) {
            if (@include_once('Log/observer.php')) {
                $options['enableLogging'] = true;
            }
        }
        switch ($this->getGroupScope()) {
            case IL_LDAP_SCOPE_BASE:
                $options['groupscope'] = 'base';
                break;
            case IL_LDAP_SCOPE_ONE:
                $options['groupscope'] = 'one';
                break;
            default:
                $options['groupscope'] = 'sub';
                break;
        }
        $options['escape_dn'] = $this->enabledEscapeDN();
        $options['groupdn'] = $this->getGroupDN();
        $options['groupattr'] = $this->getGroupAttribute();
        $options['groupfilter'] = $this->getGroupFilter();
        $options['memberattr'] = $this->getGroupMember();
        $options['memberisdn'] = $this->enabledGroupMemberIsDN();
        $options['group'] = $this->getGroupName();
        
        
        return $options;
    }

Here is the call graph for this function:

update()

ilLDAPServer::update

(

)

Definition at line 932 of file class.ilLDAPServer.php.

References $DIC, $ilDB, $query, $res, enabledEscapeDN(), enabledGroupMemberIsDN(), enabledRoleSynchronization(), enabledSyncOnLogin(), enabledSyncPerCron(), getAuthenticationMapping(), getBaseDN(), getBindingType(), getBindPassword(), getBindUser(), getFilter(), getGroupAttribute(), getGroupDN(), getGroupFilter(), getGroupMember(), getGroupName(), getGroupScope(), getGroupUserFilter(), getName(), getRoleBindDN(), getRoleBindPassword(), getSearchBase(), getServerId(), getUrlString(), getUserAttribute(), getUsernameFilter(), getUserScope(), getVersion(), isAccountMigrationEnabled(), isActive(), isActiveReferrer(), isActiveTLS(), isAuthenticationEnabled(), and isMembershipOptional().

    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "UPDATE ldap_server_settings SET " .
            "active = " . $this->db->quote($this->isActive(), 'integer') . ", " .
            "name = " . $this->db->quote($this->getName(), 'text') . ", " .
            "url = " . $this->db->quote($this->getUrlString(), 'text') . ", " .
            "version = " . $this->db->quote($this->getVersion(), 'integer') . ", " .
            "base_dn = " . $this->db->quote($this->getBaseDN(), 'text') . ", " .
            "referrals = " . $this->db->quote($this->isActiveReferrer(), 'integer') . ", " .
            "tls = " . $this->db->quote($this->isActiveTLS(), 'integer') . ", " .
            "bind_type = " . $this->db->quote($this->getBindingType(), 'integer') . ", " .
            "bind_user = " . $this->db->quote($this->getBindUser(), 'text') . ", " .
            "bind_pass = " . $this->db->quote($this->getBindPassword(), 'text') . ", " .
            "search_base = " . $this->db->quote($this->getSearchBase(), 'text') . ", " .
            "user_scope = " . $this->db->quote($this->getUserScope(), 'integer') . ", " .
            "user_attribute = " . $this->db->quote($this->getUserAttribute(), 'text') . ", " .
            "filter = " . $this->db->quote($this->getFilter(), 'text') . ", " .
            "group_dn = " . $this->db->quote($this->getGroupDN(), 'text') . ", " .
            "group_scope = " . $this->db->quote($this->getGroupScope(), 'integer') . ", " .
            "group_filter = " . $this->db->quote($this->getGroupFilter(), 'text') . ", " .
            "group_member = " . $this->db->quote($this->getGroupMember(), 'text') . ", " .
            "group_memberisdn =" . $this->db->quote((int) $this->enabledGroupMemberIsDN(), 'integer') . ", " .
            "group_name = " . $this->db->quote($this->getGroupName(), 'text') . ", " .
            "group_attribute = " . $this->db->quote($this->getGroupAttribute(), 'text') . ", " .
            "group_optional = " . $this->db->quote((int) $this->isMembershipOptional(), 'integer') . ", " .
            "group_user_filter = " . $this->db->quote($this->getGroupUserFilter(), 'text') . ", " .
            "sync_on_login = " . $this->db->quote(($this->enabledSyncOnLogin() ? 1 : 0), 'integer') . ", " .
            "sync_per_cron = " . $this->db->quote(($this->enabledSyncPerCron() ? 1 : 0), 'integer') . ", " .
            "role_sync_active = " . $this->db->quote($this->enabledRoleSynchronization(), 'integer') . ", " .
            "role_bind_dn = " . $this->db->quote($this->getRoleBindDN(), 'text') . ", " .
            "role_bind_pass = " . $this->db->quote($this->getRoleBindPassword(), 'text') . ", " .
            "migration = " . $this->db->quote((int) $this->isAccountMigrationEnabled(), 'integer') . ", " .
            'authentication = ' . $this->db->quote((int) $this->isAuthenticationEnabled(), 'integer') . ', ' .
            'authentication_type = ' . $this->db->quote((int) $this->getAuthenticationMapping(), 'integer') . ' ' .
            ", username_filter = " . $this->db->quote($this->getUsernameFilter(), "text") . " " .
            ", escape_dn = " . $this->db->quote($this->enabledEscapeDN() ? 1 : 0, 'integer') . " " .
            "WHERE server_id = " . $this->db->quote($this->getServerId(), 'integer');
            
        $res = $ilDB->manipulate($query);
        return true;
    }

Here is the call graph for this function:

validate()

ilLDAPServer::validate

(

)

Validate user input.

Parameters

Definition at line 843 of file class.ilLDAPServer.php.

References $DIC, $ilErr, enabledSyncOnLogin(), enabledSyncPerCron(), getBaseDN(), getBindingType(), getBindPassword(), getBindUser(), getName(), getUrl(), getUserAttribute(), getVersion(), IL_LDAP_BIND_USER, and isActiveTLS().

    {
        global $DIC;

        $ilErr = $DIC['ilErr'];
        
        $ilErr->setMessage('');
        if (!strlen($this->getName()) ||
            !strlen($this->getUrl()) ||
            !strlen($this->getBaseDN()) ||
            !strlen($this->getUserAttribute())) {
            $ilErr->setMessage($this->lng->txt('fill_out_all_required_fields'));
        }
        
        if ($this->getBindingType() == IL_LDAP_BIND_USER
            && (!strlen($this->getBindUser()) || !strlen($this->getBindPassword()))) {
            $ilErr->appendMessage($this->lng->txt('ldap_missing_bind_user'));
        }
        
        if (($this->enabledSyncPerCron() or $this->enabledSyncOnLogin()) and !$this->global_role) {
            $ilErr->appendMessage($this->lng->txt('ldap_missing_role_assignment'));
        }
        if ($this->getVersion() == 2 and $this->isActiveTLS()) {
            $ilErr->appendMessage($this->lng->txt('ldap_tls_conflict'));
        }
        
        return strlen($ilErr->getMessage()) ? false : true;
    }

Here is the call graph for this function:

Field Documentation

$authentication_mapping

ilLDAPServer::$authentication_mapping = 0

private

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

Referenced by getAuthenticationMapping().

$enabled_authentication

ilLDAPServer::$enabled_authentication = true

private

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

Referenced by isAuthenticationEnabled().

$escape_dn

ilLDAPServer::$escape_dn = false

private

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

Referenced by enabledEscapeDN().

$fallback_urls

ilLDAPServer::$fallback_urls = array()

private

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

$instances

ilLDAPServer::$instances = array()

staticprivate

Definition at line 26 of file class.ilLDAPServer.php.

$role_bind_dn

ilLDAPServer::$role_bind_dn = ''

private

Definition at line 32 of file class.ilLDAPServer.php.

Referenced by getRoleBindDN().

$role_bind_pass

ilLDAPServer::$role_bind_pass = ''

private

Definition at line 33 of file class.ilLDAPServer.php.

Referenced by getRoleBindPassword().

$role_sync_active

ilLDAPServer::$role_sync_active = 0

private

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

Referenced by enabledRoleSynchronization().

$server_id

ilLDAPServer::$server_id = null

private

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

Referenced by getServerId().

DEBUG

const ilLDAPServer::DEBUG = false

Definition at line 28 of file class.ilLDAPServer.php.

DEFAULT_NETWORK_TIMEOUT

const ilLDAPServer::DEFAULT_NETWORK_TIMEOUT = 5

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

Referenced by ilLDAPQuery\bind().

DEFAULT_VERSION

const ilLDAPServer::DEFAULT_VERSION = 3

Definition at line 29 of file class.ilLDAPServer.php.

---

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

• Services/LDAP/classes/class.ilLDAPServer.php