ilLDAPServer Class Reference

Collaboration diagram for ilLDAPServer:

Public Member Functions
	__construct (int $a_server_id=0)
	rotateFallbacks ()
	Rotate fallback urls in case of connect timeouts. More...
	getServerId ()
	enableAuthentication (bool $a_status)
	Enable authentication for this ldap server. More...
	isAuthenticationEnabled ()
	Check if authentication is enabled. More...
	setAuthenticationMapping (int $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 (bool $a_status)
	isActive ()
	getUrl ()
	setUrl (string $a_url)
	getUrlString ()
	doConnectionCheck ()
	Check ldap connection and do a fallback to the next server if no connection is possible. More...
	getName ()
	setName (string $a_name)
	getVersion ()
	setVersion (int $a_version)
	getBaseDN ()
	setBaseDN (string $a_base_dn)
	isActiveReferrer ()
	toggleReferrer (bool $a_status)
	isActiveTLS ()
	toggleTLS (bool $a_status)
	getBindingType ()
	setBindingType (int $a_type)
	getBindUser ()
	setBindUser (string $a_user)
	getBindPassword ()
	setBindPassword (string $a_password)
	getSearchBase ()
	setSearchBase (string $a_search_base)
	getUserAttribute ()
	setUserAttribute (string $a_user_attr)
	getFilter ()
	setFilter (string $a_filter)
	getGroupDN ()
	setGroupDN (string $a_value)
	getGroupFilter ()
	setGroupFilter (string $a_value)
	getGroupMember ()
	setGroupMember (string $a_value)
	getGroupName ()
	setGroupName (string $a_value)
	getGroupNames ()
	Get group names as array. More...
	getGroupAttribute ()
	setGroupAttribute (string $a_value)
	toggleMembershipOptional (bool $a_status)
	isMembershipOptional ()
	setGroupUserFilter (string $a_filter)
	getGroupUserFilter ()
	enabledGroupMemberIsDN ()
	enableGroupMemberIsDN (bool $a_value)
	setGroupScope (int $a_value)
	getGroupScope ()
	setUserScope (int $a_value)
	getUserScope ()
	enabledSyncOnLogin ()
	enableSyncOnLogin (bool $a_value)
	enabledSyncPerCron ()
	enableSyncPerCron (bool $a_value)
	setGlobalRole (int $a_role)
	getRoleBindDN ()
	setRoleBindDN (string $a_value)
	getRoleBindPassword ()
	setRoleBindPassword (string $a_value)
	enabledRoleSynchronization ()
	enableRoleSynchronization (bool $a_value)
	getUsernameFilter ()
	setUsernameFilter (string $a_value)
	enableEscapeDN (bool $a_value)
	enabledEscapeDN ()
	enableAccountMigration (bool $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 (int $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	_getFirstActiveServer ()
	Get first active server. More...
static	_getServerList ()
	Get list of all configured servers. More...
static	getServerIds ()
	Get all server ids. More...
static	_getAllServer ()
	Get list of all configured servers. More...
static	getAvailableDataSources (int $a_auth_mode)
static	isDataSourceActive (int $a_auth_mode)
	Check if a data source is active for a specific auth mode. More...
static	getDataSource (int $a_auth_mode)
static	disableDataSourceForAuthMode (int $a_authmode)
	Disable data source. More...
static	toggleDataSource (int $a_ldap_server_id, int $a_auth_mode, int $a_status)
	Toggle Data Source. More...
static	isAuthModeLDAP (string $a_auth_mode)
	Check if user auth mode is LDAP. More...
static	getServerIdByAuthMode (string $a_auth_mode)
	Get auth id by auth mode. More...
static	getAuthModeByKey (string $a_auth_key)
	get auth mode by key More...
static	getKeyByAuthMode (string $a_auth_mode)
	Get auth id by auth mode. More...

Data Fields
const	LDAP_BIND_ANONYMOUS = 0
const	LDAP_BIND_USER = 1
const	LDAP_SCOPE_SUB = 0
const	LDAP_SCOPE_ONE = 1
const	LDAP_SCOPE_BASE = 2
const	DEFAULT_NETWORK_TIMEOUT = 5

Private Member Functions
	prepareFilter (string $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
const	DEBUG = false
const	DEFAULT_VERSION = 3
string	$role_bind_dn = ''
string	$role_bind_pass = ''
bool	$role_sync_active = false
int	$server_id
array	$fallback_urls = array()
string	$url = ''
string	$url_string = ''
bool	$enabled_authentication = true
int	$authentication_mapping = 0
bool	$escape_dn = false
bool	$active = false
string	$name = ''
int	$version = self::DEFAULT_VERSION
string	$base_dn = ''
bool	$referrals = false
bool	$tls = false
int	$binding_type = self::LDAP_BIND_ANONYMOUS
string	$bind_user = ''
string	$bind_password = ''
string	$search_base = ''
string	$user_attribute = ''
int	$user_scope = self::LDAP_SCOPE_ONE
string	$group_filter = ''
string	$filter = ''
string	$group_dn = ''
string	$group_member = ''
int	$group_scope = self::LDAP_SCOPE_ONE
string	$group_name = ''
bool	$memberisdn = false
string	$group_attribute = ''
bool	$group_optional = true
string	$group_user_filter = ''
bool	$sync_on_login = false
bool	$sync_per_cron = false
bool	$account_migration = false
string	$username_filter = ''
int	$global_role = 0
ilDBInterface	$db
ilLanguage	$lng
ilErrorHandling	$ilErr

Static Private Attributes
static array	$instances = []

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilLDAPServer::__construct

(

int

$a_server_id = 0

)

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

References $DIC, ILIAS\Repository\lng(), and read().

    {
        global $DIC;

        $this->db = $DIC->database();
        $this->lng = $DIC->language();
        $this->ilErr = $DIC['ilErr'];

        $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

int[] server ids of active ldap server

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

References $DIC, $ilDB, $query, $res, and ILIAS\Repository\int().

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

                                                 : array
    {
        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 = [];

        while ($row = $ilDB->fetchObject($res)) {
            $server_ids[] = (int) $row->server_id;
        }
        return $server_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getAllServer()

static ilLDAPServer::_getAllServer ( )

static

Get list of all configured servers.

Returns

int[] list of server

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

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

Referenced by ilLDAPServerTableGUI\importData().

                                          : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT * FROM ldap_server_settings ORDER BY name";

        $server = [];

        $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

int[] server ids of active ldap server

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

References $DIC, $ilDB, $query, $res, and ILIAS\Repository\int().

Referenced by ilLDAPCronSynchronization\run().

                                              : array
    {
        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);

        $server_ids = [];

        while ($row = $ilDB->fetchObject($res)) {
            $server_ids[] = (int) $row->server_id;
        }
        return $server_ids;
    }

Here is the call graph for this function:

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 213 of file class.ilLDAPServer.php.

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

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

Here is the caller graph for this function:

_getRoleSyncServerIds()

static ilLDAPServer::_getRoleSyncServerIds ( )

static

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

Returns

int[]

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

References $DIC, $ilDB, $query, $res, and ILIAS\Repository\int().

Referenced by ilLDAPRoleGroupMapping\initServers().

                                                  : array
    {
        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 = [];

        while ($row = $ilDB->fetchObject($res)) {
            $server_ids[] = (int) $row->server_id;
        }
        return $server_ids;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

_getServerList()

static ilLDAPServer::_getServerList ( )

static

Get list of all configured servers.

Returns

int[] list of server ids

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

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

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

                                           : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

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

        $server_ids = [];

        while ($row = $ilDB->fetchObject($res)) {
            $server_ids[] = $row->server_id;
        }
        return $server_ids;
    }

Here is the caller graph for this function:

checkLDAPLib()

static ilLDAPServer::checkLDAPLib ( )

static

Check if ldap module is installed.

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

Referenced by ilLDAPSettingsGUI\serverList().

                                         : bool
    {
        return function_exists('ldap_bind');
    }

Here is the caller graph for this function:

create()

ilLDAPServer::create

(

)

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

References $query, 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().

                            : int
    {
        $next_id = $this->db->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)';
        $this->db->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 949 of file class.ilLDAPServer.php.

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

                            : void
    {
        if (!$this->getServerId()) {
            //TODO check if we need return false
            return;
        }

        ilLDAPAttributeMapping::_delete($this->getServerId());

        $rules = ilLDAPRoleAssignmentRule::_getRules($this->getServerId());

        foreach ($rules as $ruleAssigment) {
            $ruleAssigment->delete();
        }

        ilLDAPRoleGroupMappingSettings::_deleteByServerId($this->getServerId());

        $query = "DELETE FROM ldap_server_settings " .
            "WHERE server_id = " . $this->db->quote($this->getServerId(), 'integer');
        $this->db->manipulate($query);
    }

Here is the call graph for this function:

disableDataSourceForAuthMode()

static ilLDAPServer::disableDataSourceForAuthMode ( int  $a_authmode )

static

Disable data source.

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

References $DIC, $ilDB, and $query.

Referenced by ilCASSettingsGUI\save().

                                                                        : bool
    {
        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 528 of file class.ilLDAPServer.php.

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

                                       : bool
    {
        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(ilLDAPQuery::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

(

bool

$a_status

)

Enable account migration.

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

Referenced by read().

                                                          : void
    {
        $this->account_migration = $a_status;
    }

Here is the caller graph for this function:

enableAuthentication()

ilLDAPServer::enableAuthentication

(

bool

$a_status

)

Enable authentication for this ldap server.

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

Referenced by read().

                                                        : void
    {
        $this->enabled_authentication = $a_status;
    }

Here is the caller graph for this function:

enabledEscapeDN()

ilLDAPServer::enabledEscapeDN

(

)

Definition at line 797 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 714 of file class.ilLDAPServer.php.

References $memberisdn.

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

                                            : bool
    {
        return $this->memberisdn;
    }

Here is the caller graph for this function:

enabledRoleSynchronization()

ilLDAPServer::enabledRoleSynchronization

(

)

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

References $role_sync_active.

Referenced by create(), and update().

                                                : bool
    {
        return $this->role_sync_active;
    }

Here is the caller graph for this function:

enabledSyncOnLogin()

ilLDAPServer::enabledSyncOnLogin

(

)

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

References $sync_on_login.

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

                                        : bool
    {
        return $this->sync_on_login;
    }

Here is the caller graph for this function:

enabledSyncPerCron()

ilLDAPServer::enabledSyncPerCron

(

)

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

References $sync_per_cron.

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

                                        : bool
    {
        return $this->sync_per_cron;
    }

Here is the caller graph for this function:

enableEscapeDN()

ilLDAPServer::enableEscapeDN

(

bool

$a_value

)

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

Referenced by read().

                                                 : void
    {
        $this->escape_dn = $a_value;
    }

Here is the caller graph for this function:

enableGroupMemberIsDN()

ilLDAPServer::enableGroupMemberIsDN

(

bool

$a_value

)

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

Referenced by read().

                                                        : void
    {
        $this->memberisdn = $a_value;
    }

Here is the caller graph for this function:

enableRoleSynchronization()

ilLDAPServer::enableRoleSynchronization

(

bool

$a_value

)

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

Referenced by read().

                                                            : void
    {
        $this->role_sync_active = $a_value;
    }

Here is the caller graph for this function:

enableSyncOnLogin()

ilLDAPServer::enableSyncOnLogin

(

bool

$a_value

)

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

Referenced by read().

                                                    : void
    {
        $this->sync_on_login = $a_value;
    }

Here is the caller graph for this function:

enableSyncPerCron()

ilLDAPServer::enableSyncPerCron

(

bool

$a_value

)

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

Referenced by read().

                                                    : void
    {
        $this->sync_per_cron = $a_value;
    }

Here is the caller graph for this function:

getAuthenticationMapping()

ilLDAPServer::getAuthenticationMapping

(

)

Get authentication mode that is mapped.

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

References $authentication_mapping.

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

                                              : int
    {
        return $this->authentication_mapping;
    }

Here is the caller graph for this function:

getAuthenticationMappingKey()

ilLDAPServer::getAuthenticationMappingKey

(

)

Get authentication mapping key Default is ldap.

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

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

Referenced by ilLDAPCronSynchronization\deactivateUsers().

                                                 : string
    {
        if ($this->isAuthenticationEnabled() || !$this->getAuthenticationMapping()) {
            return 'ldap_' . $this->getServerId();
        }
        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 ( string  $a_auth_key )

static

get auth mode by key

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

Referenced by ilAuthUtils\_getAuthModeName().

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

Here is the caller graph for this function:

getAvailableDataSources()

static ilLDAPServer::getAvailableDataSources ( int  $a_auth_mode )

static

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

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

Referenced by ilCASSettingsGUI\initFormSettings().

                                                                    : array
    {
        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 564 of file class.ilLDAPServer.php.

References $base_dn.

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

                               : string
    {
        return $this->base_dn;
    }

Here is the caller graph for this function:

getBindingType()

ilLDAPServer::getBindingType

(

)

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

References $binding_type.

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

                                    : int
    {
        return $this->binding_type;
    }

Here is the caller graph for this function:

getBindPassword()

ilLDAPServer::getBindPassword

(

)

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

References $bind_password.

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

                                     : string
    {
        return $this->bind_password;
    }

Here is the caller graph for this function:

getBindUser()

ilLDAPServer::getBindUser

(

)

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

References $bind_user.

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

                                 : string
    {
        return $this->bind_user;
    }

Here is the caller graph for this function:

getDataSource()

static ilLDAPServer::getDataSource ( int  $a_auth_mode )

static

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

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

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

                                                          : int
    {
        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);
        if ($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 632 of file class.ilLDAPServer.php.

References ILIAS\UI\examples\Symbol\Glyph\Filter\filter(), and prepareFilter().

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

                               : string
    {
        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 689 of file class.ilLDAPServer.php.

References $group_attribute.

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

                                       : string
    {
        return $this->group_attribute;
    }

Here is the caller graph for this function:

getGroupDN()

ilLDAPServer::getGroupDN

(

)

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

References $group_dn.

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

                                : string
    {
        return $this->group_dn;
    }

Here is the caller graph for this function:

getGroupFilter()

ilLDAPServer::getGroupFilter

(

)

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

References prepareFilter().

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

                                    : string
    {
        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 656 of file class.ilLDAPServer.php.

References $group_member.

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

                                    : string
    {
        return $this->group_member;
    }

Here is the caller graph for this function:

getGroupName()

ilLDAPServer::getGroupName

(

)

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

References $group_name.

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

                                  : string
    {
        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 677 of file class.ilLDAPServer.php.

References getGroupName().

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

        if (!is_array($names)) {
            return [];
        }

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

Here is the call graph for this function:

getGroupScope()

ilLDAPServer::getGroupScope

(

)

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

References $group_scope.

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

                                   : int
    {
        return $this->group_scope;
    }

Here is the caller graph for this function:

getGroupUserFilter()

ilLDAPServer::getGroupUserFilter

(

)

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

References $group_user_filter.

Referenced by create(), and update().

                                        : string
    {
        return $this->group_user_filter;
    }

Here is the caller graph for this function:

getInstanceByServerId()

static ilLDAPServer::getInstanceByServerId ( int  $a_server_id )

static

Get instance by server id.

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

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

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

Here is the caller graph for this function:

getKeyByAuthMode()

static ilLDAPServer::getKeyByAuthMode ( string  $a_auth_mode )

static

Get auth id by auth mode.

Returns

int|string auth_mode

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

References ilAuthUtils\AUTH_LDAP.

Referenced by ilAuthUtils\_getAuthMode().

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

Here is the caller graph for this function:

getName()

ilLDAPServer::getName

(

)

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

References $name.

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

                             : string
    {
        return $this->name;
    }

Here is the caller graph for this function:

getPearAtributeArray()

ilLDAPServer::getPearAtributeArray ( )

private

Get attribute array for pear auth data.

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

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

Referenced by toPearAuthArray().

                                           : array
    {
        if ($this->enabledSyncOnLogin()) {
            $mapping = ilLDAPAttributeMapping::_getInstanceByServerId($this->getServerId());
            return array_merge(
                array($this->getUserAttribute()),
                $mapping->getFields(),
                array('dn'),
                ilLDAPRoleAssignmentRules::getAttributeNames($this->getServerId())
            );
        }

        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 758 of file class.ilLDAPServer.php.

References $role_bind_dn.

Referenced by create(), and update().

                                   : string
    {
        return $this->role_bind_dn;
    }

Here is the caller graph for this function:

getRoleBindPassword()

ilLDAPServer::getRoleBindPassword

(

)

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

References $role_bind_pass.

Referenced by create(), and update().

                                         : string
    {
        return $this->role_bind_pass;
    }

Here is the caller graph for this function:

getSearchBase()

ilLDAPServer::getSearchBase

(

)

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

References $search_base.

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

                                   : string
    {
        return $this->search_base;
    }

Here is the caller graph for this function:

getServerId()

ilLDAPServer::getServerId

(

)

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

References $server_id.

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

                                 : int
    {
        return $this->server_id;
    }

Here is the caller graph for this function:

getServerIdByAuthMode()

static ilLDAPServer::getServerIdByAuthMode ( string  $a_auth_mode )

static

Get auth id by auth mode.

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

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

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

        return null;
    }

Here is the caller graph for this function:

getServerIds()

static ilLDAPServer::getServerIds ( )

static

Get all server ids.

Returns

int[]

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

References $DIC, $ilDB, $query, $res, $server, ilDBConstants\FETCHMODE_OBJECT, and ILIAS\Repository\int().

Referenced by ilObjAuthSettingsGUI\getApacheAuthSettingsForm(), and ilECSParticipantSettingsGUI\parseAvailableAuthModes().

                                         : array
    {
        global $DIC;

        $ilDB = $DIC['ilDB'];

        $query = "SELECT server_id FROM ldap_server_settings ORDER BY name";

        $res = $ilDB->query($query);

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

Here is the call graph for this function:

Here is the caller graph for this function:

getUrl()

ilLDAPServer::getUrl

(

)

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

References $url.

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

                            : string
    {
        return $this->url;
    }

Here is the caller graph for this function:

getUrlString()

ilLDAPServer::getUrlString

(

)

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

References $url_string.

Referenced by create(), and update().

                                  : string
    {
        return $this->url_string;
    }

Here is the caller graph for this function:

getUserAttribute()

ilLDAPServer::getUserAttribute

(

)

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

References $user_attribute.

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

                                      : string
    {
        return $this->user_attribute;
    }

Here is the caller graph for this function:

getUsernameFilter()

ilLDAPServer::getUsernameFilter

(

)

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

References $username_filter.

Referenced by create(), and update().

                                       : string
    {
        return $this->username_filter;
    }

Here is the caller graph for this function:

getUserScope()

ilLDAPServer::getUserScope

(

)

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

References $user_scope.

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

                                  : int
    {
        return $this->user_scope;
    }

Here is the caller graph for this function:

getVersion()

ilLDAPServer::getVersion

(

)

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

References $version.

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

                                : int
    {
        return $this->version;
    }

Here is the caller graph for this function:

isAccountMigrationEnabled()

ilLDAPServer::isAccountMigrationEnabled

(

)

enabled account migration

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

References $account_migration.

Referenced by create(), and update().

                                               : bool
    {
        return $this->account_migration;
    }

Here is the caller graph for this function:

isActive()

ilLDAPServer::isActive

(

)

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

References $active.

Referenced by create(), and update().

                              : bool
    {
        return $this->active;
    }

Here is the caller graph for this function:

isActiveReferrer()

ilLDAPServer::isActiveReferrer

(

)

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

References $referrals.

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

                                      : bool
    {
        return $this->referrals;
    }

Here is the caller graph for this function:

isActiveTLS()

ilLDAPServer::isActiveTLS

(

)

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

References $tls.

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

                                 : bool
    {
        return $this->tls;
    }

Here is the caller graph for this function:

isAuthenticationEnabled()

ilLDAPServer::isAuthenticationEnabled

(

)

Check if authentication is enabled.

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

References $enabled_authentication.

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

                                             : bool
    {
        return $this->enabled_authentication;
    }

Here is the caller graph for this function:

isAuthModeLDAP()

static ilLDAPServer::isAuthModeLDAP ( string  $a_auth_mode )

static

Check if user auth mode is LDAP.

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

References $DIC, and ilAuthUtils\AUTH_LDAP.

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

                                                              : bool
    {
        global $DIC;

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

        if ($a_auth_mode === '') {
            $logger->error(__METHOD__ . ': No auth mode given..............');
            return false;
        }

        $auth_arr = explode('_', $a_auth_mode);

        return ((int) $auth_arr[0] === ilAuthUtils::AUTH_LDAP) && (isset($auth_arr[1]) && $auth_arr[1]);
    }

Here is the caller graph for this function:

isDataSourceActive()

static ilLDAPServer::isDataSourceActive ( int  $a_auth_mode )

static

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

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

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

Referenced by ilAuthProviderCAS\doAuthentication(), and ilCASSettingsGUI\initFormSettings().

                                                               : bool
    {
        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);
        if ($res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            return true;
        }
        return false;
    }

Here is the caller graph for this function:

isMembershipOptional()

ilLDAPServer::isMembershipOptional

(

)

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

References $group_optional.

Referenced by create(), and update().

                                          : bool
    {
        return $this->group_optional;
    }

Here is the caller graph for this function:

prepareFilter()

ilLDAPServer::prepareFilter ( string  $a_filter )

private

Create brackets for filters if they do not exist.

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

References $filter.

Referenced by getFilter(), and getGroupFilter().

                                                    : string
    {
        $filter = trim($a_filter);

        if ($filter === '') {
            return $filter;
        }

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

Here is the caller graph for this function:

read()

ilLDAPServer::read ( )

private

Read server settings.

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

References $query, $res, 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(), ilDBConstants\T_INTEGER, toggleActive(), toggleMembershipOptional(), toggleReferrer(), and toggleTLS().

Referenced by __construct().

                           : void
    {
        if (!$this->server_id) {
            return;
        }
        $query = "SELECT * FROM ldap_server_settings WHERE server_id = " . $this->db->quote($this->server_id, ilDBConstants::T_INTEGER);

        $res = $this->db->query($query);
        while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
            $this->toggleActive((bool) $row->active);
            $this->setName($row->name ?? '');
            $this->setUrl($row->url ?? '');
            $this->setVersion((int) $row->version);
            $this->setBaseDN($row->base_dn ?? '');
            $this->toggleReferrer((bool) $row->referrals);
            $this->toggleTLS((bool) $row->tls);
            $this->setBindingType((int) $row->bind_type);
            $this->setBindUser($row->bind_user ?? '');
            $this->setBindPassword($row->bind_pass ?? '');
            $this->setSearchBase($row->search_base ?? '');
            $this->setUserScope((int) $row->user_scope);
            $this->setUserAttribute($row->user_attribute ?? '');
            $this->setFilter($row->filter ?? '');
            $this->setGroupDN($row->group_dn ?? '');
            $this->setGroupScope((int) $row->group_scope);
            $this->setGroupFilter($row->group_filter ?? '');
            $this->setGroupMember($row->group_member ?? '');
            $this->setGroupAttribute($row->group_attribute ?? '');
            $this->toggleMembershipOptional((bool) $row->group_optional);
            $this->setGroupUserFilter($row->group_user_filter ?? '');
            $this->enableGroupMemberIsDN((bool) $row->group_memberisdn);
            $this->setGroupName($row->group_name ?? '');
            $this->enableSyncOnLogin((bool) $row->sync_on_login);
            $this->enableSyncPerCron((bool) $row->sync_per_cron);
            $this->enableRoleSynchronization((bool) $row->role_sync_active);
            $this->setRoleBindDN($row->role_bind_dn ?? '');
            $this->setRoleBindPassword($row->role_bind_pass ?? '');
            $this->enableAccountMigration((bool) $row->migration);
            $this->enableAuthentication((bool) $row->authentication);
            $this->setAuthenticationMapping((int) $row->authentication_type);
            $this->setUsernameFilter($row->username_filter ?? '');
            $this->enableEscapeDN((bool) $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.

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

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

Referenced by doConnectionCheck().

                                     : bool
    {
        if (!$this->fallback_urls) {
            return false;
        }

        $all_urls = array_merge($this->fallback_urls);
        $all_urls[] = $this->getUrl();

        $query = 'UPDATE ldap_server_settings SET ' .
                'url = ' . $this->db->quote(implode(',', $all_urls), 'text') . ' ' .
                'WHERE server_id = ' . $this->db->quote($this->getServerId(), 'integer');
        $this->db->manipulate($query);
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAuthenticationMapping()

ilLDAPServer::setAuthenticationMapping

(

int

$a_map

)

Set mapped authentication mapping.

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

Referenced by read().

                                                        : void
    {
        $this->authentication_mapping = $a_map;
    }

Here is the caller graph for this function:

setBaseDN()

ilLDAPServer::setBaseDN

(

string

$a_base_dn

)

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

Referenced by read().

                                                : void
    {
        $this->base_dn = $a_base_dn;
    }

Here is the caller graph for this function:

setBindingType()

ilLDAPServer::setBindingType

(

int

$a_type

)

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

Referenced by read().

                                               : void
    {
        if ($a_type === self::LDAP_BIND_USER) {
            $this->binding_type = self::LDAP_BIND_USER;
        } else {
            $this->binding_type = self::LDAP_BIND_ANONYMOUS;
        }
    }

Here is the caller graph for this function:

setBindPassword()

ilLDAPServer::setBindPassword

(

string

$a_password

)

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

Referenced by read().

                                                       : void
    {
        $this->bind_password = $a_password;
    }

Here is the caller graph for this function:

setBindUser()

ilLDAPServer::setBindUser

(

string

$a_user

)

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

Referenced by read().

                                               : void
    {
        $this->bind_user = $a_user;
    }

Here is the caller graph for this function:

setFilter()

ilLDAPServer::setFilter

(

string

$a_filter

)

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

References ILIAS\UI\examples\Symbol\Glyph\Filter\filter().

Referenced by read().

                                               : void
    {
        $this->filter = $a_filter;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setGlobalRole()

ilLDAPServer::setGlobalRole

(

int

$a_role

)

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

                                              : void
    {
        $this->global_role = $a_role;
    }

setGroupAttribute()

ilLDAPServer::setGroupAttribute

(

string

$a_value

)

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

Referenced by read().

                                                      : void
    {
        $this->group_attribute = $a_value;
    }

Here is the caller graph for this function:

setGroupDN()

ilLDAPServer::setGroupDN

(

string

$a_value

)

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

Referenced by read().

                                               : void
    {
        $this->group_dn = $a_value;
    }

Here is the caller graph for this function:

setGroupFilter()

ilLDAPServer::setGroupFilter

(

string

$a_value

)

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

Referenced by read().

                                                   : void
    {
        $this->group_filter = $a_value;
    }

Here is the caller graph for this function:

setGroupMember()

ilLDAPServer::setGroupMember

(

string

$a_value

)

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

Referenced by read().

                                                   : void
    {
        $this->group_member = $a_value;
    }

Here is the caller graph for this function:

setGroupName()

ilLDAPServer::setGroupName

(

string

$a_value

)

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

Referenced by read().

                                                 : void
    {
        $this->group_name = $a_value;
    }

Here is the caller graph for this function:

setGroupScope()

ilLDAPServer::setGroupScope

(

int

$a_value

)

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

Referenced by read().

                                               : void
    {
        $this->group_scope = $a_value;
    }

Here is the caller graph for this function:

setGroupUserFilter()

ilLDAPServer::setGroupUserFilter

(

string

$a_filter

)

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

Referenced by read().

                                                        : void
    {
        $this->group_user_filter = $a_filter;
    }

Here is the caller graph for this function:

setName()

ilLDAPServer::setName

(

string

$a_name

)

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

Referenced by read().

                                           : void
    {
        $this->name = $a_name;
    }

Here is the caller graph for this function:

setRoleBindDN()

ilLDAPServer::setRoleBindDN

(

string

$a_value

)

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

Referenced by read().

                                                  : void
    {
        $this->role_bind_dn = $a_value;
    }

Here is the caller graph for this function:

setRoleBindPassword()

ilLDAPServer::setRoleBindPassword

(

string

$a_value

)

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

Referenced by read().

                                                        : void
    {
        $this->role_bind_pass = $a_value;
    }

Here is the caller graph for this function:

setSearchBase()

ilLDAPServer::setSearchBase

(

string

$a_search_base

)

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

Referenced by read().

                                                        : void
    {
        $this->search_base = $a_search_base;
    }

Here is the caller graph for this function:

setUrl()

ilLDAPServer::setUrl

(

string

$a_url

)

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

References $url.

Referenced by read().

                                         : void
    {
        $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

(

string

$a_user_attr

)

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

Referenced by read().

                                                         : void
    {
        $this->user_attribute = $a_user_attr;
    }

Here is the caller graph for this function:

setUsernameFilter()

ilLDAPServer::setUsernameFilter

(

string

$a_value

)

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

Referenced by read().

                                                      : void
    {
        $this->username_filter = $a_value;
    }

Here is the caller graph for this function:

setUserScope()

ilLDAPServer::setUserScope

(

int

$a_value

)

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

Referenced by read().

                                              : void
    {
        $this->user_scope = $a_value;
    }

Here is the caller graph for this function:

setVersion()

ilLDAPServer::setVersion

(

int

$a_version

)

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

Referenced by read().

                                              : void
    {
        $this->version = $a_version;
    }

Here is the caller graph for this function:

toggleActive()

ilLDAPServer::toggleActive

(

bool

$a_status

)

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

Referenced by read().

                                                : void
    {
        $this->active = $a_status;
    }

Here is the caller graph for this function:

toggleDataSource()

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

static

Toggle Data Source.

Todo:

handle multiple ldap servers

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

References $DIC, $ilDB, and $query.

Referenced by ilCASSettingsGUI\save().

                                                                                                   : bool
    {
        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

(

bool

$a_status

)

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

Referenced by read().

                                                            : void
    {
        $this->group_optional = $a_status;
    }

Here is the caller graph for this function:

toggleReferrer()

ilLDAPServer::toggleReferrer

(

bool

$a_status

)

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

Referenced by read().

                                                  : void
    {
        $this->referrals = $a_status;
    }

Here is the caller graph for this function:

toggleTLS()

ilLDAPServer::toggleTLS

(

bool

$a_status

)

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

Referenced by read().

                                             : void
    {
        $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 977 of file class.ilLDAPServer.php.

References enabledEscapeDN(), enabledGroupMemberIsDN(), getBaseDN(), getBindingType(), getBindPassword(), getBindUser(), getFilter(), getGroupAttribute(), getGroupDN(), getGroupFilter(), getGroupMember(), getGroupName(), getGroupScope(), getPearAtributeArray(), getSearchBase(), getUrl(), getUserAttribute(), getUserScope(), getVersion(), isActiveReferrer(), and isActiveTLS().

                                     : array
    {
        $options = array(
            'url' => $this->getUrl(),
            'version' => $this->getVersion(),
            'referrals' => $this->isActiveReferrer());

        if ($this->getBindingType() === self::LDAP_BIND_USER) {
            $options['binddn'] = $this->getBindUser();
            $options['bindpw'] = $this->getBindPassword();
        }
        $options['basedn'] = $this->getBaseDN();
        $options['start_tls'] = $this->isActiveTLS();
        $options['userdn'] = $this->getSearchBase();
        if ($this->getUserScope() === self::LDAP_SCOPE_ONE) {
            $options['userscope'] = 'one';
        } else {
            $options['userscope'] = 'sub';
        }

        $options['userattr'] = $this->getUserAttribute();
        $options['userfilter'] = $this->getFilter();
        $options['attributes'] = $this->getPearAtributeArray();
        $options['debug'] = self::DEBUG;


        $options['enableLogging'] = true;

        switch ($this->getGroupScope()) {
            case self::LDAP_SCOPE_BASE:
                $options['groupscope'] = 'base';
                break;
            case self::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 904 of file class.ilLDAPServer.php.

References $query, 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().

                            : bool
    {
        $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($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');

        $this->db->manipulate($query);
        return true;
    }

Here is the call graph for this function:

validate()

ilLDAPServer::validate

(

)

Validate user input.

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

References enabledSyncOnLogin(), enabledSyncPerCron(), getBaseDN(), getBindingType(), getBindPassword(), getBindUser(), getName(), getUrl(), getUserAttribute(), getVersion(), isActiveTLS(), and ILIAS\Repository\lng().

                              : bool
    {
        $this->ilErr->setMessage('');
        if ($this->getName() === '' ||
            $this->getUrl() === '' ||
            $this->getBaseDN() === '' ||
            $this->getUserAttribute() === '') {
            $this->ilErr->setMessage($this->lng->txt('fill_out_all_required_fields'));
        }

        if ($this->getBindingType() === self::LDAP_BIND_USER
            && ($this->getBindUser() === '' || $this->getBindPassword() === '')) {
            $this->ilErr->appendMessage($this->lng->txt('ldap_missing_bind_user'));
        }

        if (!$this->global_role && ($this->enabledSyncPerCron() || $this->enabledSyncOnLogin())) {
            $this->ilErr->appendMessage($this->lng->txt('ldap_missing_role_assignment'));
        }
        if ($this->getVersion() === 2 && $this->isActiveTLS()) {
            $this->ilErr->appendMessage($this->lng->txt('ldap_tls_conflict'));
        }

        return $this->ilErr->getMessage() === '';
    }

Here is the call graph for this function:

Field Documentation

$account_migration

bool ilLDAPServer::$account_migration = false

private

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

Referenced by isAccountMigrationEnabled().

$active

bool ilLDAPServer::$active = false

private

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

Referenced by isActive().

$authentication_mapping

int ilLDAPServer::$authentication_mapping = 0

private

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

Referenced by getAuthenticationMapping().

$base_dn

string ilLDAPServer::$base_dn = ''

private

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

Referenced by getBaseDN().

$bind_password

string ilLDAPServer::$bind_password = ''

private

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

Referenced by getBindPassword().

$bind_user

string ilLDAPServer::$bind_user = ''

private

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

Referenced by getBindUser().

$binding_type

int ilLDAPServer::$binding_type = self::LDAP_BIND_ANONYMOUS

private

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

Referenced by getBindingType().

$db

ilDBInterface ilLDAPServer::$db

private

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

$enabled_authentication

bool ilLDAPServer::$enabled_authentication = true

private

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

Referenced by isAuthenticationEnabled().

$escape_dn

bool ilLDAPServer::$escape_dn = false

private

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

Referenced by enabledEscapeDN().

$fallback_urls

array ilLDAPServer::$fallback_urls = array()

private

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

$filter

string ilLDAPServer::$filter = ''

private

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

Referenced by prepareFilter().

$global_role

int ilLDAPServer::$global_role = 0

private

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

$group_attribute

string ilLDAPServer::$group_attribute = ''

private

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

Referenced by getGroupAttribute().

$group_dn

string ilLDAPServer::$group_dn = ''

private

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

Referenced by getGroupDN().

$group_filter

string ilLDAPServer::$group_filter = ''

private

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

$group_member

string ilLDAPServer::$group_member = ''

private

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

Referenced by getGroupMember().

$group_name

string ilLDAPServer::$group_name = ''

private

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

Referenced by getGroupName().

$group_optional

bool ilLDAPServer::$group_optional = true

private

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

Referenced by isMembershipOptional().

$group_scope

int ilLDAPServer::$group_scope = self::LDAP_SCOPE_ONE

private

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

Referenced by getGroupScope().

$group_user_filter

string ilLDAPServer::$group_user_filter = ''

private

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

Referenced by getGroupUserFilter().

$ilErr

ilErrorHandling ilLDAPServer::$ilErr

private

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

$instances

array ilLDAPServer::$instances = []

staticprivate

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

$lng

ilLanguage ilLDAPServer::$lng

private

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

$memberisdn

bool ilLDAPServer::$memberisdn = false

private

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

Referenced by enabledGroupMemberIsDN().

$name

string ilLDAPServer::$name = ''

private

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

Referenced by getName().

$referrals

bool ilLDAPServer::$referrals = false

private

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

Referenced by isActiveReferrer().

$role_bind_dn

string ilLDAPServer::$role_bind_dn = ''

private

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

Referenced by getRoleBindDN().

$role_bind_pass

string ilLDAPServer::$role_bind_pass = ''

private

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

Referenced by getRoleBindPassword().

$role_sync_active

bool ilLDAPServer::$role_sync_active = false

private

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

Referenced by enabledRoleSynchronization().

$search_base

string ilLDAPServer::$search_base = ''

private

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

Referenced by getSearchBase().

$server_id

int ilLDAPServer::$server_id

private

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

Referenced by getServerId().

$sync_on_login

bool ilLDAPServer::$sync_on_login = false

private

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

Referenced by enabledSyncOnLogin().

$sync_per_cron

bool ilLDAPServer::$sync_per_cron = false

private

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

Referenced by enabledSyncPerCron().

$tls

bool ilLDAPServer::$tls = false

private

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

Referenced by isActiveTLS().

$url

string ilLDAPServer::$url = ''

private

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

Referenced by doConnectionCheck(), getUrl(), and setUrl().

$url_string

string ilLDAPServer::$url_string = ''

private

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

Referenced by getUrlString().

$user_attribute

string ilLDAPServer::$user_attribute = ''

private

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

Referenced by getUserAttribute().

$user_scope

int ilLDAPServer::$user_scope = self::LDAP_SCOPE_ONE

private

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

Referenced by getUserScope().

$username_filter

string ilLDAPServer::$username_filter = ''

private

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

Referenced by getUsernameFilter().

$version

int ilLDAPServer::$version = self::DEFAULT_VERSION

private

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

Referenced by getVersion().

DEBUG

const ilLDAPServer::DEBUG = false

private

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

DEFAULT_NETWORK_TIMEOUT

const ilLDAPServer::DEFAULT_NETWORK_TIMEOUT = 5

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

Referenced by ilLDAPQuery\bind().

DEFAULT_VERSION

const ilLDAPServer::DEFAULT_VERSION = 3

private

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

LDAP_BIND_ANONYMOUS

const ilLDAPServer::LDAP_BIND_ANONYMOUS = 0

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

Referenced by ilLDAPSettingsGUI\initForm().

LDAP_BIND_USER

const ilLDAPServer::LDAP_BIND_USER = 1

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

Referenced by ilLDAPQuery\bind(), and ilLDAPSettingsGUI\initForm().

LDAP_SCOPE_BASE

const ilLDAPServer::LDAP_SCOPE_BASE = 2

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

Referenced by ilLDAPRoleAssignmentRule\isGroupMember(), ilLDAPQuery\queryByScope(), and ilLDAPQuery\readUserData().

LDAP_SCOPE_ONE

const ilLDAPServer::LDAP_SCOPE_ONE = 1

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

Referenced by ilLDAPSettingsGUI\initForm(), and ilLDAPQuery\queryByScope().

LDAP_SCOPE_SUB

const ilLDAPServer::LDAP_SCOPE_SUB = 0

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

Referenced by ilLDAPSettingsGUI\initForm(), and ilLDAPQuery\queryByScope().

---

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

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