ilLDAPSettingsGUI Class Reference

Collaboration diagram for ilLDAPSettingsGUI:

Public Member Functions
	__construct (int $a_auth_ref_id)
	executeCommand ()
	getServer ()
	Get server settings. More...
	roleAssignments ()
	Edit role assignments. More...
	editRoleAssignment ()
	Edit role assignment. More...
	updateRoleAssignment ()
	update role assignment More...
	confirmDeleteRules ()
	Confirm delete rules. More...
	deleteRules ()
	delete role assignment rule More...
	addRoleAssignment ()
	add new role assignment More...
	deleteRoleMapping ()
	chooseMapping ()
	saveMapping ()
	setServerFormValues ()
	save ()
	addRoleAutoCompleteObject ()
	Add Member for autoComplete. More...
	roleMapping ()
	Role Mapping Tab. More...
	editRoleMapping ()
	Edit Assigments for role mapping. More...
	createRoleMapping ()
	Check add screen input and save to db. More...
	confirmDeleteRoleMapping ()
	confirm delete role mappings More...
	addServerSettings ()
	editServerSettings ()
	confirmDeleteServerSettings ()
	Confirm delete rules. More...
	deleteServerSettings ()
	userMapping ()
	Ldap User Mapping. More...
	activateServer ()
	deactivateServer ()
	addRoleMapping ()
	Add Assigments for role mapping. More...
	updateRoleMapping ()
	Check edit screen input and save to db. More...
	saveSyncronizationSettings ()
	save Syncronization Settings on Role Mapping screen More...

Protected Member Functions
	showRoleSelection ()
	show role selection More...
	saveRoleSelection ()
	Save role selection. More...
	getRoleAssignmentTable ()
	Show active role assignments. More...
	initFormRoleAssignments (string $a_mode)
	Init form table for new role assignments. More...

Private Member Functions
	checkAccess (string $a_permission)
	getAttributeMappingKeys ()
	Get all possible attribute keys for mapping ldap attribute to ilias user attributes. More...
	setValuesByArray ()
	set values of form array More...
	roleSelectionRequired ()
	checkRoleAssignmentInput (int $a_rule_id=0)
	Check role assignment input. More...
	loadRoleAssignmentRule (int $a_rule_id, bool $load_from_form=true)
	Load input from form. More...
	handleServerTableActions ()
	serverList ()
	initForm ()
	setSubTabs ()
	Set sub tabs for ldap section. More...
	initServer ()
	initAttributeMapping ()
	initRoleMapping ()
	prepareGlobalRoleSelection ()
	New implementation for InputForm. More...
	getMappingFields ()
	initUserDefinedFields ()
	prepareMappingSelect ()
	userMappingToolbar ()
	Create Toolbar. More...
	initUserMappingForm ()
	Create Property Form GUI for User Mapping. More...
	initRoleMappingForm (string $command)
	init propertyformgui for Assignment of LDAP Attributes to ILIAS User Profile More...

Private Attributes
int	$ref_id
ilLDAPServer	$server
ilLDAPAttributeMapping	$mapping
ilPropertyFormGUI	$form_gui = null
ilPropertyFormGUI	$form = null
ilCtrl	$ctrl
ilTabsGUI	$tabs_gui
ilLanguage	$lng
ilGlobalTemplateInterface	$tpl
ilErrorHandling	$ilErr
ilAccessHandler	$ilAccess
ilRbacReview	$rbacReview
ilRbacSystem	$rbacSystem
ilToolbarGUI	$toolbar
ilGlobalTemplateInterface	$main_tpl
ilComponentRepository	$component_repository
ilUserDefinedFields	$udf
ilLDAPRoleAssignmentRule	$role_mapping_rule = null
ilLDAPRoleAssignmentRule	$rule = null
ilLDAPRoleGroupMappingSettings	$role_mapping = null
array	$rule_ids = null
int	$rule_id = null
int	$role_id = null
array	$mappings = null
string	$mapping_template = null
int	$ldap_server_id = null
array	$server_ids = null
int	$mapping_id = null
string	$role_bind_user = null
string	$role_bind_pass = null
bool	$role_sync_active = false
array	$attribute_mappings = []
readonly ILIAS UI Factory	$ui_factory
readonly ILIAS UI Renderer	$ui_renderer
readonly ILIAS HTTP GlobalHttpState	$http
readonly ILIAS Refinery Factory	$refinery

Detailed Description

Author

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

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

Constructor & Destructor Documentation

__construct()

ilLDAPSettingsGUI::__construct

(

int

$a_auth_ref_id

)

Exceptions

ilCtrlException

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

References $DIC, ILIAS\Repository\ctrl(), getAttributeMappingKeys(), ILIAS\FileDelivery\http(), initServer(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), ilUtil\stripSlashes(), and ILIAS\Repository\toolbar().

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tabs_gui = $DIC->tabs();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('ldap');
        $this->lng->loadLanguageModule('ui');
        $this->ilErr = $DIC['ilErr'];
        $this->ilAccess = $DIC->access();
        $this->component_repository = $DIC["component.repository"];
        $this->rbacReview = $DIC->rbac()->review();
        $this->rbacSystem = $DIC->rbac()->system();
        $this->toolbar = $DIC->toolbar();
        $this->main_tpl = $DIC->ui()->mainTemplate();
        $this->http = $DIC->http();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();
        $this->refinery = $DIC->refinery();

        $this->tpl = $DIC->ui()->mainTemplate();

        if ($this->ctrl->getCmd() !== "addServerSettings") {
            $this->ctrl->saveParameter($this, 'ldap_server_id');
        }

        $http_wrapper = $DIC->http()->wrapper();
        $is_post_request = $DIC->http()->request()->getMethod() === "POST";
        $refinery = $DIC->refinery();
        if ($http_wrapper->query()->has("rule_id")) {
            $this->rule_id = $http_wrapper->query()->retrieve(
                "rule_id",
                $refinery->kindlyTo()->int()
            );
        }

        if ($http_wrapper->query()->has('ldap_server_id')) {
            $this->ldap_server_id = $http_wrapper->query()->retrieve(
                'ldap_server_id',
                $refinery->kindlyTo()->int()
            );
        } elseif ($http_wrapper->query()->has('ldap_servers_server_id')) {
            $this->ldap_server_id = $http_wrapper->query()->retrieve(
                'ldap_servers_server_id',
                $this->refinery->in()->series([
                    $refinery->kindlyTo()->listOf(
                        $refinery->kindlyTo()->int()
                    ),
                    $this->refinery->custom()->constraint(
                        fn($value): bool => count($value) === 1,
                        $this->lng->txt('select_one')
                    ),
                    $this->refinery->custom()->transformation(
                        fn($value): int => $value[0]
                    )
                ])
            );
        }

        if ($http_wrapper->query()->has("mapping_id")) {
            $this->mapping_id = $http_wrapper->query()->retrieve(
                "mapping_id",
                $refinery->kindlyTo()->int()
            );
        }
        if ($is_post_request) {
            if ($http_wrapper->post()->has('rule_ids')) {
                $this->rule_ids = $http_wrapper->post()->retrieve(
                    'rule_ids',
                    $refinery->kindlyTo()->listOf($refinery->kindlyTo()->int())
                );
            }
            if ($http_wrapper->post()->has('role_id')) {
                $this->role_id = $http_wrapper->post()->retrieve(
                    'role_id',
                    $refinery->kindlyTo()->int()
                );
            }
            if ($http_wrapper->post()->has('mappings')) {
                $this->mappings = $http_wrapper->post()->retrieve(
                    'mappings',
                    $refinery->kindlyTo()->listOf($refinery->kindlyTo()->int())
                );
            }
            if ($http_wrapper->post()->has('server_ids')) {
                $this->server_ids = $http_wrapper->post()->retrieve(
                    'server_ids',
                    $refinery->kindlyTo()->listOf($refinery->kindlyTo()->int())
                );
            }
            if ($http_wrapper->post()->has('mapping_template')) {
                $this->mapping_template = $http_wrapper->post()->retrieve(
                    'mapping_template',
                    $refinery->kindlyTo()->string()
                );
            }
            if ($http_wrapper->post()->has('role_bind_user')) {
                $this->role_bind_user = ilUtil::stripSlashes($http_wrapper->post()->retrieve(
                    'role_bind_user',
                    $refinery->kindlyTo()->string()
                ));
            }
            if ($http_wrapper->post()->has('role_bind_pass')) {
                $this->role_bind_pass = ilUtil::stripSlashes($http_wrapper->post()->retrieve(
                    'role_bind_pass',
                    $refinery->kindlyTo()->string()
                ));
            }
            if ($http_wrapper->post()->has('role_sync_active')) {
                $this->role_sync_active = $http_wrapper->post()->retrieve(
                    'role_sync_active',
                    $refinery->kindlyTo()->bool()
                );
            }
            foreach ($this->getAttributeMappingKeys() as $key) {
                if ($http_wrapper->post()->has($key . '_value')) {
                    $this->attribute_mappings[$key] = [ilUtil::stripSlashes($http_wrapper->post()->retrieve(
                        $key . '_value',
                        $refinery->kindlyTo()->string()
                    )), $http_wrapper->post()->has($key . '_update')];
                } else {
                    $this->attribute_mappings[$key] = ["", false];
                }
            }
        }

        $this->ref_id = $a_auth_ref_id;


        $this->initServer();
    }

Here is the call graph for this function:

Member Function Documentation

activateServer()

ilLDAPSettingsGUI::activateServer

(

)

Definition at line 1636 of file class.ilLDAPSettingsGUI.php.

References checkAccess(), ILIAS\UI\examples\Progress\Bar\server(), and serverList().

Referenced by handleServerTableActions().

                                    : void
    {
        $this->checkAccess("write");

        $this->server->toggleActive(true);
        $this->server->update();
        $this->serverList();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addRoleAssignment()

ilLDAPSettingsGUI::addRoleAssignment

(

)

add new role assignment

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

References checkRoleAssignmentInput(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getRoleAssignmentTable(), initFormRoleAssignments(), ILIAS\Repository\lng(), roleAssignments(), roleSelectionRequired(), and setSubTabs().

                                       : bool
    {
        if (!$this->ilAccess->checkAccess('write', '', $this->ref_id)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->roleAssignments();
            return false;
        }
        $this->setSubTabs();
        $this->initFormRoleAssignments('create');
        $formWithoutErrors = $this->form->checkInput();
        $roleErrorMessage = $this->checkRoleAssignmentInput();
        if (!$formWithoutErrors || $roleErrorMessage !== '') {
            if ($roleErrorMessage !== '') {
                $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt($roleErrorMessage));
            }

            $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.ldap_role_assignments.html', 'components/ILIAS/LDAP');

            // DONE: wrap this
            $this->form->setValuesByPost();
            $this->tpl->setVariable('NEW_ASSIGNMENT_TBL', $this->form->getHTML());
            $this->tpl->setVariable('RULES_TBL', $this->getRoleAssignmentTable());
            $this->tabs_gui->activateSubTab('role_assignments');
            return true;
        }

        if ($this->roleSelectionRequired()) {
            $this->ctrl->redirect($this, 'showRoleSelection');
        } else {
            $this->rule->create();
            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
            $this->ctrl->redirect($this, 'roleAssignments');
        }
        return true;
    }

Here is the call graph for this function:

addRoleAutoCompleteObject()

ilLDAPSettingsGUI::addRoleAutoCompleteObject

(

)

Add Member for autoComplete.

Definition at line 1324 of file class.ilLDAPSettingsGUI.php.

References ilRoleAutoCompleteInputGUI\echoAutoCompleteList().

                                               : void
    {
        ilRoleAutoCompleteInputGUI::echoAutoCompleteList();
    }

Here is the call graph for this function:

addRoleMapping()

ilLDAPSettingsGUI::addRoleMapping

(

)

Add Assigments for role mapping.

Definition at line 1733 of file class.ilLDAPSettingsGUI.php.

References initRoleMappingForm(), ilLDAPAttributeMapping\read(), and ILIAS\UI\examples\Progress\Bar\server().

                                    : void
    {
        $propertie_form = $this->initRoleMappingForm("createRoleMapping");
        if ($propertie_form->getItemByPostVar("url")) {
            $propertie_form->getItemByPostVar("url")->setValue($this->server->getUrl());
        }
        if ($this->mapping_id) {
            $mapping = new ilLDAPRoleGroupMappingSetting($this->mapping_id);
            $mapping->read();
            if ($propertie_form->getItemByPostVar("url")) {
                $propertie_form->getItemByPostVar("url")->setValue($mapping->getURL());
            }
            if ($propertie_form->getItemByPostVar("dn")) {
                $propertie_form->getItemByPostVar("dn")->setValue($mapping->getDN());
            }
            if ($propertie_form->getItemByPostVar("member")) {
                $propertie_form->getItemByPostVar("member")->setValue($mapping->getMemberAttribute());
            }
            if ($propertie_form->getItemByPostVar("memberisdn")) {
                $propertie_form->getItemByPostVar("memberisdn")->setChecked($mapping->getMemberISDN());
            }
            if ($propertie_form->getItemByPostVar("role")) {
                $propertie_form->getItemByPostVar("role")->setValue($mapping->getRoleName());
            }
            if ($propertie_form->getItemByPostVar("info")) {
                $propertie_form->getItemByPostVar("info")->setValue($mapping->getMappingInfo());
            }
            if ($propertie_form->getItemByPostVar("info_type")) {
                $propertie_form->getItemByPostVar("info_type")->setChecked($mapping->getMappingInfoType());
            }
        }

        $this->tpl->setContent($propertie_form->getHTML());
    }

Here is the call graph for this function:

addServerSettings()

ilLDAPSettingsGUI::addServerSettings

(

)

Definition at line 1548 of file class.ilLDAPSettingsGUI.php.

References checkAccess(), ILIAS\Repository\ctrl(), and initForm().

                                       : void
    {
        $this->checkAccess("write");

        $this->ctrl->clearParameters($this);

        $this->initForm();
        $this->tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

checkAccess()

ilLDAPSettingsGUI::checkAccess ( string  $a_permission )

private

Definition at line 228 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\lng().

Referenced by activateServer(), addServerSettings(), confirmDeleteRules(), confirmDeleteServerSettings(), deactivateServer(), and editServerSettings().

                                                      : void
    {
        if (!$this->ilAccess->checkAccess($a_permission, '', $this->ref_id)) {
            $this->ilErr->raiseError($this->lng->txt('msg_no_perm_read'), $this->ilErr->WARNING);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

checkRoleAssignmentInput()

ilLDAPSettingsGUI::checkRoleAssignmentInput ( int  $a_rule_id = 0 )

private

Check role assignment input.

Definition at line 553 of file class.ilLDAPSettingsGUI.php.

References loadRoleAssignmentRule().

Referenced by addRoleAssignment(), and updateRoleAssignment().

                                                                 : string
    {
        $this->loadRoleAssignmentRule($a_rule_id);
        $this->rule->validate();
        return $this->ilErr->getMessage();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

chooseMapping()

ilLDAPSettingsGUI::chooseMapping

(

)

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

References ilLDAPAttributeMappingUtils\_getMappingRulesByClass(), initAttributeMapping(), and userMapping().

                                   : void
    {
        if (!$this->mapping_template) {
            $this->userMapping();
            return;
        }

        $this->initAttributeMapping();
        $this->mapping->clearRules();

        foreach (ilLDAPAttributeMappingUtils::_getMappingRulesByClass($this->mapping_template) as $key => $value) {
            $this->mapping->setRule($key, $value, false);
        }
        $this->userMapping();
    }

Here is the call graph for this function:

confirmDeleteRoleMapping()

ilLDAPSettingsGUI::confirmDeleteRoleMapping

(

)

confirm delete role mappings

Definition at line 1519 of file class.ilLDAPSettingsGUI.php.

References $id, $txt, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ilLDAPAttributeMapping\read().

                                              : void
    {
        if (!$this->mappings) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'), true);
            $this->ctrl->redirect($this, "roleMapping");
            return;
        }

        $c_gui = new ilConfirmationGUI();

        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "deleteRoleMapping"));
        $c_gui->setHeaderText($this->lng->txt("ldap_confirm_del_role_ass"));
        $c_gui->setCancel($this->lng->txt("cancel"), "roleMapping");
        $c_gui->setConfirm($this->lng->txt("confirm"), "deleteRoleMapping");

        foreach ($this->mappings as $id) {
            $mapping = new ilLDAPRoleGroupMappingSetting($id);
            $mapping->read();
            $txt = $this->lng->txt('obj_role') . ": " . $mapping->getRoleName() . ", ";
            $txt .= $this->lng->txt('ldap_group_dn') . ": " . $mapping->getDN() . ", ";
            $txt .= $this->lng->txt('ldap_server_short') . " " . $mapping->getURL() . ", ";
            $txt .= $this->lng->txt('ldap_group_member_short') . " " . $mapping->getMemberAttribute();

            $c_gui->addItem("mappings[]", (string) $id, $txt);
        }
        $this->tpl->setContent($c_gui->getHTML());
    }

Here is the call graph for this function:

confirmDeleteRules()

ilLDAPSettingsGUI::confirmDeleteRules

(

)

Confirm delete rules.

Exceptions

ilCtrlException

Definition at line 378 of file class.ilLDAPSettingsGUI.php.

References ilLDAPRoleAssignmentRule\_getInstanceByRuleId(), checkAccess(), ilLDAPRoleAssignmentRule\conditionToString(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), roleAssignments(), and setSubTabs().

                                        : void
    {
        $this->checkAccess("write");

        if (!$this->rule_ids) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->roleAssignments();
            return;
        }
        $this->setSubTabs();
        $this->tabs_gui->activateTab('role_assignments');

        $c_gui = new ilConfirmationGUI();

        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "deleteRules"));
        $c_gui->setHeaderText($this->lng->txt("ldap_confirm_del_role_ass"));
        $c_gui->setCancel($this->lng->txt("cancel"), "roleAssignments");
        $c_gui->setConfirm($this->lng->txt("confirm"), "deleteRules");

        // add items to delete
        foreach ($this->rule_ids as $rule_id) {
            $rule = ilLDAPRoleAssignmentRule::_getInstanceByRuleId($rule_id);
            $c_gui->addItem('rule_ids[]', (string) $rule_id, $rule->conditionToString());
        }
        $this->tpl->setContent($c_gui->getHTML());
    }

Here is the call graph for this function:

confirmDeleteServerSettings()

ilLDAPSettingsGUI::confirmDeleteServerSettings

(

)

Confirm delete rules.

Definition at line 1574 of file class.ilLDAPSettingsGUI.php.

References checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and serverList().

Referenced by handleServerTableActions().

                                                 : void
    {
        $this->checkAccess("write");

        if (!$this->ldap_server_id) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->serverList();
            return;
        }

        $c_gui = new ilConfirmationGUI();

        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "deleteServerSettings"));
        $c_gui->setHeaderText($this->lng->txt("ldap_confirm_del_server_settings"));
        $c_gui->setCancel($this->lng->txt("cancel"), "serverList");
        $c_gui->setConfirm($this->lng->txt("confirm"), "deleteServerSettings");

        // add items to delete
        $setting = new ilLDAPServer($this->ldap_server_id);
        $c_gui->addItem('server_ids[]', (string) $setting->getServerId(), $setting->getName());

        $this->tpl->setContent($c_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

createRoleMapping()

ilLDAPSettingsGUI::createRoleMapping

(

)

Check add screen input and save to db.

Definition at line 1488 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\ctrl(), initRoleMappingForm(), ILIAS\Repository\lng(), ilLDAPAttributeMapping\save(), and ILIAS\UI\examples\Progress\Bar\server().

                                       : void
    {
        $propertie_form = $this->initRoleMappingForm("createRoleMapping");

        if ($propertie_form->checkInput() && $this->rbacReview->roleExists($propertie_form->getInput("role"))) {
            $mapping = new ilLDAPRoleGroupMappingSetting(0);
            $mapping->setServerId($this->server->getServerId());
            $mapping->setURL($propertie_form->getInput("url"));
            $mapping->setDN($propertie_form->getInput("dn"));
            $mapping->setMemberAttribute($propertie_form->getInput("member"));
            $mapping->setMemberISDN((bool) $propertie_form->getInput("memberisdn"));
            $mapping->setRoleByName($propertie_form->getInput("role"));
            $mapping->setMappingInfo($propertie_form->getInput("info"));
            $mapping->setMappingInfoType((bool) $propertie_form->getInput("info_type"));
            $mapping->save();

            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, "roleMapping");
        } else {
            if (!$this->rbacReview->roleExists($propertie_form->getInput("role"))) {
                $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt("ldap_role_not_exists") . " " .
                        $propertie_form->getInput("role"));
            }
            $propertie_form->setValuesByPost();
            $this->tpl->setContent($propertie_form->getHTML());
        }
    }

Here is the call graph for this function:

deactivateServer()

ilLDAPSettingsGUI::deactivateServer

(

)

Definition at line 1645 of file class.ilLDAPSettingsGUI.php.

References checkAccess(), ILIAS\UI\examples\Progress\Bar\server(), and serverList().

Referenced by handleServerTableActions().

                                      : void
    {
        $this->checkAccess("write");

        $this->server->toggleActive(false);
        $this->server->update();
        $this->serverList();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteRoleMapping()

ilLDAPSettingsGUI::deleteRoleMapping

(

)

Definition at line 642 of file class.ilLDAPSettingsGUI.php.

References initRoleMapping(), ILIAS\Repository\lng(), and roleMapping().

                                       : bool
    {
        if (!$this->mappings) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->roleMapping();
            return false;
        }

        $this->initRoleMapping();

        foreach ($this->mappings as $mapping_id) {
            $this->role_mapping->delete($mapping_id);
        }
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('ldap_deleted_role_mapping'));
        $this->roleMapping();
        return true;
    }

Here is the call graph for this function:

deleteRules()

ilLDAPSettingsGUI::deleteRules

(

)

delete role assignment rule

Definition at line 409 of file class.ilLDAPSettingsGUI.php.

References ilLDAPRoleAssignmentRule\_getInstanceByRuleId(), ILIAS\Repository\ctrl(), ilLDAPRoleAssignmentRule\delete(), ILIAS\Repository\lng(), and roleAssignments().

                                 : void
    {
        if (!$this->rule_ids) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_once'));
            $this->roleAssignments();
            return;
        }
        foreach ($this->rule_ids as $rule_id) {
            $rule = ilLDAPRoleAssignmentRule::_getInstanceByRuleId($rule_id);
            $rule->delete();
        }
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('ldap_deleted_rule'));
        $this->ctrl->redirect($this, 'roleAssignments');
    }

Here is the call graph for this function:

deleteServerSettings()

ilLDAPSettingsGUI::deleteServerSettings

(

)

Definition at line 1602 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and serverList().

                                          : void
    {
        if (!$this->server_ids) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->serverList();
            return;
        }

        foreach ($this->server_ids as $server_id) {
            $setting = new ilLDAPServer($server_id);
            $setting->delete();
        }
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('deleted'));
        $this->ctrl->redirect($this, "serverlist");
    }

Here is the call graph for this function:

editRoleAssignment()

ilLDAPSettingsGUI::editRoleAssignment

(

)

Edit role assignment.

Exceptions

ilCtrlException

Definition at line 289 of file class.ilLDAPSettingsGUI.php.

References ilLDAPRoleAssignmentRule\_getInstanceByRuleId(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), initFormRoleAssignments(), ILIAS\Repository\lng(), roleAssignments(), setSubTabs(), and setValuesByArray().

                                        : void
    {
        if (!$this->rule_id) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->roleAssignments();
            return;
        }
        $this->setSubTabs();
        $this->tabs_gui->activateTab('role_assignments');

        $this->ctrl->saveParameter($this, 'rule_id');
        $this->initFormRoleAssignments(
            'edit'
        );
        $this->role_mapping_rule = ilLDAPRoleAssignmentRule::_getInstanceByRuleId($this->rule_id);
        $this->setValuesByArray();
        $this->tpl->setContent($this->form->getHTML());
    }

Here is the call graph for this function:

editRoleMapping()

ilLDAPSettingsGUI::editRoleMapping

(

)

Edit Assigments for role mapping.

Definition at line 1451 of file class.ilLDAPSettingsGUI.php.

References initRoleMappingForm(), ILIAS\Repository\lng(), and ilLDAPAttributeMapping\read().

                                     : void
    {
        $mapping = new ilLDAPRoleGroupMappingSetting($this->mapping_id);
        $mapping->read();

        $propertie_form = $this->initRoleMappingForm("updateRoleMapping");
        $propertie_form->setTitle($this->lng->txt('ldap_edit_role_assignment'));
        if ($propertie_form->getItemByPostVar("url")) {
            $propertie_form->getItemByPostVar("url")->setValue($mapping->getURL());
        }
        if ($propertie_form->getItemByPostVar("dn")) {
            $propertie_form->getItemByPostVar("dn")->setValue($mapping->getDN());
        }
        if ($propertie_form->getItemByPostVar("member")) {
            $propertie_form->getItemByPostVar("member")->setValue($mapping->getMemberAttribute());
        }
        if ($propertie_form->getItemByPostVar("memberisdn")) {
            $propertie_form->getItemByPostVar("memberisdn")->setChecked($mapping->getMemberISDN());
        }
        if ($propertie_form->getItemByPostVar("role")) {
            $propertie_form->getItemByPostVar("role")->setValue($mapping->getRoleName());
        }
        if ($propertie_form->getItemByPostVar("info")) {
            $propertie_form->getItemByPostVar("info")->setValue($mapping->getMappingInfo());
        }
        if ($propertie_form->getItemByPostVar("info_type")) {
            $propertie_form->getItemByPostVar("info_type")->setChecked($mapping->getMappingInfoType());
        }

        $this->tpl->setContent($propertie_form->getHTML());
    }

Here is the call graph for this function:

editServerSettings()

ilLDAPSettingsGUI::editServerSettings

(

)

Definition at line 1558 of file class.ilLDAPSettingsGUI.php.

References checkAccess(), initForm(), setServerFormValues(), and setSubTabs().

Referenced by handleServerTableActions().

                                        : void
    {
        $this->checkAccess("write");

        $this->setSubTabs();
        $this->tabs_gui->setTabActive('settings');

        $this->initForm();
        $this->setServerFormValues();
        $this->tpl->setContent($this->form_gui->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilLDAPSettingsGUI::executeCommand

(

)

Exceptions

ilCtrlException

Definition at line 208 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

                                    : bool
    {
        $next_class = $this->ctrl->getNextClass($this);
        $cmd = $this->ctrl->getCmd();

        if ($cmd !== "serverList" && !$this->rbacSystem->checkAccess("visible,read", $this->ref_id)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_write'), true);
            $this->ctrl->redirect($this, "serverList");
        }
        switch ($next_class) {
            default:
                if (!$cmd) {
                    $cmd = "serverList";
                }
                $this->$cmd();
                break;
        }
        return true;
    }

Here is the call graph for this function:

getAttributeMappingKeys()

ilLDAPSettingsGUI::getAttributeMappingKeys ( )

private

Get all possible attribute keys for mapping ldap attribute to ilias user attributes.

Returns

string[]

Definition at line 239 of file class.ilLDAPSettingsGUI.php.

References ilUserDefinedFields\_getInstance(), and getMappingFields().

Referenced by __construct().

                                              : array
    {
        $keys = [];
        foreach (array_keys($this->getMappingFields()) as $key) {
            $keys[] = $key;
        }
        foreach (ilUserDefinedFields::_getInstance()->getDefinitions() as $definition) {
            $keys[] = 'udf_' . $definition['field_id'];
        }
        return $keys;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMappingFields()

ilLDAPSettingsGUI::getMappingFields ( )

private

Definition at line 1149 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\lng().

Referenced by getAttributeMappingKeys(), initUserMappingForm(), and saveMapping().

                                       : array
    {
        return array('gender' => $this->lng->txt('gender'),
                'firstname' => $this->lng->txt('firstname'),
                'lastname' => $this->lng->txt('lastname'),
                'title' => $this->lng->txt('person_title'),
                'institution' => $this->lng->txt('institution'),
                'department' => $this->lng->txt('department'),
                'street' => $this->lng->txt('street'),
                'city' => $this->lng->txt('city'),
                'zipcode' => $this->lng->txt('zipcode'),
                'country' => $this->lng->txt('country'),
                'phone_office' => $this->lng->txt('phone_office'),
                'phone_home' => $this->lng->txt('phone_home'),
                'phone_mobile' => $this->lng->txt('phone_mobile'),
                'fax' => $this->lng->txt('fax'),
                'email' => $this->lng->txt('email'),
                'second_email' => $this->lng->txt('second_email'),
                'hobby' => $this->lng->txt('hobby'),
                'matriculation' => $this->lng->txt('matriculation'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRoleAssignmentTable()

ilLDAPSettingsGUI::getRoleAssignmentTable ( )

protected

Show active role assignments.

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

References ilLDAPRoleAssignmentRule\_getRules(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Progress\Bar\server().

Referenced by addRoleAssignment().

                                               : string
    {
        if (count($rules = ilLDAPRoleAssignmentRule::_getRules($this->server->getServerId()))) {
            $table_gui = new ilLDAPRoleAssignmentTableGUI($this, 'roleAssignments');
            $table_gui->setTitle($this->lng->txt("ldap_tbl_role_ass"));
            $table_gui->parse($rules);
            $table_gui->addMultiCommand("confirmDeleteRules", $this->lng->txt("delete"));
            $table_gui->setSelectAllCheckbox("rule_id");
            return $table_gui->getHTML();
        }
        return '';
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getServer()

ilLDAPSettingsGUI::getServer

(

)

Get server settings.

Definition at line 255 of file class.ilLDAPSettingsGUI.php.

References $server.

Referenced by initAttributeMapping(), initRoleMapping(), loadRoleAssignmentRule(), and roleSelectionRequired().

                               : ilLDAPServer
    {
        return $this->server;
    }

Here is the caller graph for this function:

handleServerTableActions()

ilLDAPSettingsGUI::handleServerTableActions ( )

private

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

References activateServer(), confirmDeleteServerSettings(), ILIAS\Repository\ctrl(), deactivateServer(), editServerSettings(), ILIAS\FileDelivery\http(), and ILIAS\Repository\refinery().

                                               : void
    {
        $action = $this->http->wrapper()->query()->retrieve(
            'ldap_servers_table_action',
            $this->refinery->byTrying([
                $this->refinery->kindlyTo()->string(),
                $this->refinery->always('')
            ])
        );
        match ($action) {
            'editServerSettings' => $this->editServerSettings(),
            'activateServer' => $this->activateServer(),
            'deactivateServer' => $this->deactivateServer(),
            'confirmDeleteServerSettings' => $this->confirmDeleteServerSettings(),
            default => $this->ctrl->redirect($this, 'serverList'),
        };
    }

Here is the call graph for this function:

initAttributeMapping()

ilLDAPSettingsGUI::initAttributeMapping ( )

private

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

References ilLDAPAttributeMapping\_getInstanceByServerId(), and getServer().

Referenced by chooseMapping(), save(), saveMapping(), and userMapping().

                                           : void
    {
        $this->mapping = ilLDAPAttributeMapping::_getInstanceByServerId($this->getServer()->getServerId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initForm()

ilLDAPSettingsGUI::initForm ( )

private

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

References $version, ilAdministrationSettingsFormHandler\addFieldsToForm(), ilSubEnabledFormPropertyGUI\addSubItem(), ILIAS\Repository\ctrl(), ilAdministrationSettingsFormHandler\FORM_LDAP, ilAdministrationSettingsFormHandler\getSettingsGUIInstance(), ilLDAPServer\LDAP_BIND_ANONYMOUS, ilLDAPServer\LDAP_BIND_USER, ilLDAPServer\LDAP_SCOPE_ONE, ilLDAPServer\LDAP_SCOPE_SUB, ILIAS\Repository\lng(), prepareGlobalRoleSelection(), ilSelectInputGUI\setOptions(), and ilPasswordInputGUI\setSkipSyntaxCheck().

Referenced by addServerSettings(), editServerSettings(), and save().

                               : void
    {
        $this->form_gui = new ilPropertyFormGUI();
        $this->form_gui->setFormAction($this->ctrl->getFormAction($this, 'save'));
        $this->form_gui->setTitle($this->lng->txt('ldap_configure'));

        $active = new ilCheckboxInputGUI($this->lng->txt('auth_ldap_enable'), 'active');
        $active->setValue("1");
        $this->form_gui->addItem($active);

        $ds = new ilCheckboxInputGUI($this->lng->txt('ldap_as_ds'), 'ds');
        $ds->setValue("1");
        $ds->setInfo($this->lng->txt('ldap_as_ds_info'));
        $this->form_gui->addItem($ds);

        $servername = new ilTextInputGUI($this->lng->txt('ldap_server_name'), 'server_name');
        $servername->setRequired(true);
        $servername->setInfo($this->lng->txt('ldap_server_name_info'));
        $servername->setSize(32);
        $servername->setMaxLength(32);
        $this->form_gui->addItem($servername);

        // start Patch Name Filter
        $namefilter = new ilTextInputGUI($this->lng->txt('ldap_username_filter'), "name_filter");//ADD LANG VAR
        $namefilter->setInfo($this->lng->txt("ldap_username_filter_info"));
        $namefilter->setSize(64);
        $namefilter->setMaxLength(255);
        $this->form_gui->addItem($namefilter);
        // end Patch Name Filter

        $serverurl = new ilTextInputGUI($this->lng->txt('ldap_server'), 'server_url');
        $serverurl->setRequired(true);
        $serverurl->setInfo($this->lng->txt('ldap_server_url_info'));
        $serverurl->setSize(64);
        $serverurl->setMaxLength(255);
        $this->form_gui->addItem($serverurl);

        $version = new ilSelectInputGUI($this->lng->txt('ldap_version'), 'version');
        $version->setOptions(array(2 => 2, 3 => 3));
        $version->setInfo($this->lng->txt('ldap_server_version_info'));
        $this->form_gui->addItem($version);

        $basedsn = new ilTextInputGUI($this->lng->txt('basedn'), 'base_dn');
        $basedsn->setRequired(true);
        $basedsn->setSize(64);
        $basedsn->setMaxLength(255);
        $this->form_gui->addItem($basedsn);

        $referrals = new ilCheckboxInputGUI($this->lng->txt('ldap_referrals'), 'referrals');
        $referrals->setValue("1");
        $referrals->setInfo($this->lng->txt('ldap_referrals_info'));
        $this->form_gui->addItem($referrals);

        $section_security = new ilFormSectionHeaderGUI();
        $section_security->setTitle($this->lng->txt('ldap_server_security_settings'));
        $this->form_gui->addItem($section_security);

        $tls = new ilCheckboxInputGUI($this->lng->txt('ldap_tls'), 'tls');
        $tls->setValue("1");
        $this->form_gui->addItem($tls);

        $binding = new ilRadioGroupInputGUI($this->lng->txt('ldap_server_binding'), 'binding_type');
        $anonymous = new ilRadioOption($this->lng->txt('ldap_bind_anonymous'), (string) ilLDAPServer::LDAP_BIND_ANONYMOUS);
        $binding->addOption($anonymous);
        $user = new ilRadioOption($this->lng->txt('ldap_bind_user'), (string) ilLDAPServer::LDAP_BIND_USER);
        $dn = new ilTextInputGUI($this->lng->txt('ldap_server_bind_dn'), 'bind_dn');
        $dn->setSize(64);
        $dn->setMaxLength(255);
        $user->addSubItem($dn);
        $pass = new ilPasswordInputGUI($this->lng->txt('ldap_server_bind_pass'), 'bind_pass');
        $pass->setSkipSyntaxCheck(true);
        $pass->setSize(12);
        $pass->setMaxLength(100);
        $user->addSubItem($pass);
        $binding->addOption($user);
        $this->form_gui->addItem($binding);

        $section_auth = new ilFormSectionHeaderGUI();
        $section_auth->setTitle($this->lng->txt('ldap_authentication_settings'));
        $this->form_gui->addItem($section_auth);

        $search_base = new ilTextInputGUI($this->lng->txt('ldap_user_dn'), 'search_base');
        $search_base->setInfo($this->lng->txt('ldap_search_base_info'));
        $search_base->setSize(64);
        $search_base->setMaxLength(255);
        $this->form_gui->addItem($search_base);

        $user_scope = new ilSelectInputGUI($this->lng->txt('ldap_user_scope'), 'user_scope');
        $user_scope->setOptions(array(ilLDAPServer::LDAP_SCOPE_ONE => $this->lng->txt('ldap_scope_one'),
            ilLDAPServer::LDAP_SCOPE_SUB => $this->lng->txt('ldap_scope_sub')));
        $user_scope->setInfo($this->lng->txt('ldap_user_scope_info'));
        $this->form_gui->addItem($user_scope);

        $user_attribute = new ilTextInputGUI($this->lng->txt('ldap_user_attribute'), 'user_attribute');
        $user_attribute->setSize(16);
        $user_attribute->setMaxLength(64);
        $user_attribute->setRequired(true);
        $this->form_gui->addItem($user_attribute);

        $filter = new ilTextInputGUI($this->lng->txt('ldap_search_filter'), 'filter');
        $filter->setInfo($this->lng->txt('ldap_filter_info'));
        $filter->setSize(64);
        $filter->setMaxLength(512);
        $this->form_gui->addItem($filter);

        $section_restrictions = new ilFormSectionHeaderGUI();
        $section_restrictions->setTitle($this->lng->txt('ldap_group_restrictions'));
        $this->form_gui->addItem($section_restrictions);

        $group_dn = new ilTextInputGUI($this->lng->txt('ldap_group_search_base'), 'group_dn');
        $group_dn->setInfo($this->lng->txt('ldap_group_dn_info'));
        $group_dn->setSize(64);
        $group_dn->setMaxLength(255);
        $this->form_gui->addItem($group_dn);

        $group_scope = new ilSelectInputGUI($this->lng->txt('ldap_group_scope'), 'group_scope');
        $group_scope->setOptions(array(ilLDAPServer::LDAP_SCOPE_ONE => $this->lng->txt('ldap_scope_one'),
            ilLDAPServer::LDAP_SCOPE_SUB => $this->lng->txt('ldap_scope_sub')));
        $group_scope->setInfo($this->lng->txt('ldap_group_scope_info'));
        $this->form_gui->addItem($group_scope);

        $group_filter = new ilTextInputGUI($this->lng->txt('ldap_group_filter'), 'group_filter');
        $group_filter->setInfo($this->lng->txt('ldap_group_filter_info'));
        $group_filter->setSize(64);
        $group_filter->setMaxLength(255);
        $this->form_gui->addItem($group_filter);

        $group_member = new ilTextInputGUI($this->lng->txt('ldap_group_member'), 'group_member');
        $group_member->setInfo($this->lng->txt('ldap_group_member_info'));
        $group_member->setSize(32);
        $group_member->setMaxLength(255);
        $this->form_gui->addItem($group_member);


        $group_member_isdn = new ilCheckboxInputGUI($this->lng->txt('ldap_memberisdn'), 'memberisdn');
        #$group_member_isdn->setInfo($this->lng->txt('ldap_group_member_info'));
        $this->form_gui->addItem($group_member_isdn);
        #$group_member->addSubItem($group_member_isdn);

        $escapedn = new ilCheckboxInputGUI($this->lng->txt('ldap_escapedn'), 'escape_dn');
        $escapedn->setValue("1");
        $escapedn->setInfo($this->lng->txt('ldap_escapedn_info'));
        $this->form_gui->addItem($escapedn);

        $group = new ilTextInputGUI($this->lng->txt('ldap_group_name'), 'group');
        $group->setInfo($this->lng->txt('ldap_group_name_info'));
        $group->setSize(32);
        $group->setMaxLength(255);
        $this->form_gui->addItem($group);

        $group_atrr = new ilTextInputGUI($this->lng->txt('ldap_group_attribute'), 'group_attribute');
        $group_atrr->setInfo($this->lng->txt('ldap_group_attribute_info'));
        $group_atrr->setSize(16);
        $group_atrr->setMaxLength(64);
        $this->form_gui->addItem($group_atrr);

        $group_optional = new ilCheckboxInputGUI($this->lng->txt('ldap_group_membership'), 'group_optional');
        $group_optional->setOptionTitle($this->lng->txt('ldap_group_member_optional'));
        $group_optional->setInfo($this->lng->txt('ldap_group_optional_info'));
        $group_optional->setValue("1");
        $group_user_filter = new ilTextInputGUI($this->lng->txt('ldap_group_user_filter'), 'group_user_filter');
        $group_user_filter->setSize(64);
        $group_user_filter->setMaxLength(255);
        $group_optional->addSubItem($group_user_filter);
        $this->form_gui->addItem($group_optional);

        $section_sync = new ilFormSectionHeaderGUI();
        $section_sync->setTitle($this->lng->txt('ldap_user_sync'));
        $this->form_gui->addItem($section_sync);

        $ci_gui = new ilCustomInputGUI($this->lng->txt('ldap_moment_sync'));
        $sync_on_login = new ilCheckboxInputGUI($this->lng->txt('ldap_sync_login'), 'sync_on_login');
        $sync_on_login->setValue("1");
        $ci_gui->addSubItem($sync_on_login);
        $sync_per_cron = new ilCheckboxInputGUI($this->lng->txt('ldap_sync_cron'), 'sync_per_cron');
        $sync_per_cron->setValue("1");
        $ci_gui->addSubItem($sync_per_cron);
        $ci_gui->setInfo($this->lng->txt('ldap_user_sync_info'));
        $this->form_gui->addItem($ci_gui);

        $global_role = new ilSelectInputGUI($this->lng->txt('ldap_global_role_assignment'), 'global_role');
        $global_role->setOptions($this->prepareGlobalRoleSelection());
        $global_role->setInfo($this->lng->txt('ldap_global_role_info'));
        $this->form_gui->addItem($global_role);

        $migr = new ilCheckboxInputGUI($this->lng->txt('auth_ldap_migration'), 'migration');
        $migr->setInfo($this->lng->txt('auth_ldap_migration_info'));
        $migr->setValue("1");
        $this->form_gui->addItem($migr);

        ilAdministrationSettingsFormHandler::addFieldsToForm(
            ilAdministrationSettingsFormHandler::FORM_LDAP,
            $this->form_gui,
            ilAdministrationSettingsFormHandler::getSettingsGUIInstance("auth")
        );

        $this->form_gui->addCommandButton('save', $this->lng->txt('save'));
        if ($this->ctrl->getCmd() === "addServerSettings") {
            $this->form_gui->addCommandButton('serverList', $this->lng->txt('cancel'));
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initFormRoleAssignments()

ilLDAPSettingsGUI::initFormRoleAssignments ( string  $a_mode )

protected

Init form table for new role assignments.

Parameters

string

mode edit | create

Definition at line 1197 of file class.ilLDAPSettingsGUI.php.

References $id, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), prepareGlobalRoleSelection(), ilRadioOption\setInfo(), ilFormPropertyGUI\setRequired(), ilLDAPRoleAssignmentRule\TYPE_ATTRIBUTE, and ilLDAPRoleAssignmentRule\TYPE_GROUP.

Referenced by addRoleAssignment(), editRoleAssignment(), roleAssignments(), and updateRoleAssignment().

                                                              : void
    {
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this));

        switch ($a_mode) {
            case 'edit':
                $this->form->setTitle($this->lng->txt('ldap_edit_role_ass_rule'));
                $this->form->addCommandButton('updateRoleAssignment', $this->lng->txt('save'));
                //$this->form->addCommandButton('roleAssignments',$this->lng->txt('cancel'));
                break;
            case 'create':
                $this->form->setTitle($this->lng->txt('ldap_add_role_ass_rule'));
                $this->form->addCommandButton('addRoleAssignment', $this->lng->txt('ldap_btn_add_role_ass'));
                //$this->form->addCommandButton('roleAssignments',$this->lng->txt('cancel'));
                break;
        }

        // Role Selection
        $role = new ilRadioGroupInputGUI($this->lng->txt('ldap_ilias_role'), 'role_name');
        $role->setRequired(true);

        $global = new ilRadioOption($this->lng->txt('ldap_global_role'), "0");

        $role->addOption($global);

        $role_select = new ilSelectInputGUI('', 'role_id');
        $role_select->setOptions($this->prepareGlobalRoleSelection());
        $global->addSubItem($role_select);

        $local = new ilRadioOption($this->lng->txt('ldap_local_role'), "1");

        $role->addOption($local);

        $role_search = new ilRoleAutoCompleteInputGUI('', 'role_search', $this, 'addRoleAutoCompleteObject');
        $role_search->setSize(40);
        $local->addSubItem($role_search);

        $role->setInfo($this->lng->txt('ldap_role_name_info'));
        $this->form->addItem($role);

        // Update options
        $update = new ilNonEditableValueGUI($this->lng->txt('ldap_update_roles'), 'update_roles');
        $update->setValue($this->lng->txt('ldap_check_role_assignment'));

        $add = new ilCheckboxInputGUI('', 'add_missing');
        $add->setOptionTitle($this->lng->txt('ldap_add_missing'));
        $update->addSubItem($add);

        $remove = new ilCheckboxInputGUI('', 'remove_deprecated');
        $remove->setOptionTitle($this->lng->txt('ldap_remove_deprecated'));
        $update->addSubItem($remove);

        $this->form->addItem($update);



        // Assignment Type
        $group = new ilRadioGroupInputGUI($this->lng->txt('ldap_assignment_type'), 'type');
        #$group->setValue($current_rule->getType());
        $group->setRequired(true);

        // Option by group
        $radio_group = new ilRadioOption($this->lng->txt('ldap_role_by_group'), (string) ilLDAPRoleAssignmentRule::TYPE_GROUP);

        $dn = new ilTextInputGUI($this->lng->txt('ldap_group_dn'), 'dn');
        #$dn->setValue($current_rule->getDN());
        $dn->setSize(32);
        $dn->setMaxLength(512);
        $dn->setInfo($this->lng->txt('ldap_role_grp_dn_info'));
        $radio_group->addSubItem($dn);
        $at = new ilTextInputGUI($this->lng->txt('ldap_role_grp_at'), 'at');
        #$at->setValue($current_rule->getMemberAttribute());
        $at->setSize(16);
        $at->setMaxLength(128);
        $radio_group->addSubItem($at);
        $isdn = new ilCheckboxInputGUI($this->lng->txt('ldap_role_grp_isdn'), 'isdn');
        #$isdn->setChecked($current_rule->isMemberAttributeDN());
        $isdn->setInfo($this->lng->txt('ldap_group_member_info'));
        $radio_group->addSubItem($isdn);
        $radio_group->setInfo($this->lng->txt('ldap_role_grp_info'));

        $group->addOption($radio_group);

        // Option by Attribute
        $radio_attribute = new ilRadioOption($this->lng->txt('ldap_role_by_attribute'), (string) ilLDAPRoleAssignmentRule::TYPE_ATTRIBUTE);
        $name = new ilTextInputGUI($this->lng->txt('ldap_role_at_name'), 'name');
        #$name->setValue($current_rule->getAttributeName());
        $name->setSize(32);
        $name->setMaxLength(128);
        #$name->setInfo($this->lng->txt('ldap_role_at_name_info'));
        $radio_attribute->addSubItem($name);

        // Radio Attribute
        $val = new ilTextInputGUI($this->lng->txt('ldap_role_at_value'), 'value');
        #$val->setValue($current_rule->getAttributeValue());
        $val->setSize(32);
        $val->setMaxLength(128);
        #$val->setInfo($this->lng->txt('ldap_role_at_value_info'));
        $radio_attribute->addSubItem($val);
        $radio_attribute->setInfo($this->lng->txt('ldap_role_at_info'));

        $group->addOption($radio_attribute);

        // Option by Plugin
        $pl_active = $this->component_repository->getPluginSlotById("ldaphk")->hasActivePlugins();
        $pl = new ilRadioOption($this->lng->txt('ldap_plugin'), "3");

        $pl->setInfo($this->lng->txt('ldap_plugin_info'));
        $pl->setDisabled(!$pl_active);

        $id = new ilNumberInputGUI($this->lng->txt('ldap_plugin_id'), 'plugin_id');
        $id->setDisabled(!$pl_active);
        $id->setSize(3);
        $id->setMaxLength(3);
        $id->setMaxValue(999);
        $id->setMinValue(1);
        $pl->addSubItem($id);

        $group->addOption($pl);
        $this->form->addItem($group);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initRoleMapping()

ilLDAPSettingsGUI::initRoleMapping ( )

private

Definition at line 1125 of file class.ilLDAPSettingsGUI.php.

References ilLDAPRoleGroupMappingSettings\_getInstanceByServerId(), and getServer().

Referenced by deleteRoleMapping().

                                      : void
    {
        $this->role_mapping = ilLDAPRoleGroupMappingSettings::_getInstanceByServerId($this->getServer()->getServerId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initRoleMappingForm()

ilLDAPSettingsGUI::initRoleMappingForm ( string  $command )

private

init propertyformgui for Assignment of LDAP Attributes to ILIAS User Profile

Parameters

string

$command

command methode

Definition at line 1661 of file class.ilLDAPSettingsGUI.php.

References $url, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilFormPropertyGUI\setPostVar(), and setSubTabs().

Referenced by addRoleMapping(), createRoleMapping(), editRoleMapping(), and updateRoleMapping().

                                                         : ilPropertyFormGUI
    {
        $this->setSubTabs();
        $this->tabs_gui->activateTab('role_mapping');

        if ($this->mapping_id) {
            $this->ctrl->setParameter($this, 'mapping_id', $this->mapping_id);
        }

        $propertie_form = new ilPropertyFormGUI();
        $propertie_form->setTitle($this->lng->txt('ldap_mapping_table'));
        $propertie_form->setFormAction($this->ctrl->getFormAction($this, $command));
        $propertie_form->addCommandButton($command, $this->lng->txt('save'));
        $propertie_form->addCommandButton("roleMapping", $this->lng->txt('cancel'));

        $url = new ilTextInputGUI($this->lng->txt('ldap_server'));
        $url->setPostVar("url");
        $url->setSize(50);
        $url->setMaxLength(255);
        $url->setRequired(true);

        $group_dn = new ilTextInputGUI($this->lng->txt('ldap_group_dn'));
        $group_dn->setPostVar("dn");
        $group_dn->setSize(50);
        $group_dn->setMaxLength(255);
        $group_dn->setInfo($this->lng->txt('ldap_dn_info'));
        $group_dn->setRequired(true);

        $member = new ilTextInputGUI($this->lng->txt('ldap_group_member'));
        $member->setPostVar("member");
        $member->setSize(32);
        $member->setMaxLength(255);
        $member->setInfo($this->lng->txt('ldap_member_info'));
        $member->setRequired(true);

        $member_isdn = new ilCheckboxInputGUI("");
        $member_isdn->setPostVar("memberisdn");
        $member_isdn->setOptionTitle($this->lng->txt('ldap_memberisdn'));

        $role = new ilTextInputGUI($this->lng->txt('ldap_ilias_role'));
        $role->setPostVar("role");
        $role->setSize(32);
        $role->setMaxLength(255);
        $role->setInfo($this->lng->txt('ldap_role_info'));
        $role->setRequired(true);

        $info = new ilTextAreaInputGUI($this->lng->txt('ldap_info_text'));
        $info->setPostVar("info");
        $info->setCols(50);
        $info->setRows(3);
        $info->setInfo($this->lng->txt('ldap_info_text_info'));

        $info_type = new ilCheckboxInputGUI("");
        $info_type->setPostVar("info_type");
        $info_type->setOptionTitle($this->lng->txt('ldap_mapping_info_type'));

        $propertie_form->addItem($url);
        $propertie_form->addItem($group_dn);
        $propertie_form->addItem($member);
        $propertie_form->addItem($member_isdn);
        $propertie_form->addItem($role);
        $propertie_form->addItem($info);
        $propertie_form->addItem($info_type);

        return $propertie_form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initServer()

ilLDAPSettingsGUI::initServer ( )

private

Definition at line 1109 of file class.ilLDAPSettingsGUI.php.

References $ldap_server_id, and ILIAS\UI\examples\Progress\Bar\server().

Referenced by __construct().

                                 : void
    {
        $server_id = 0;
        if ($this->ldap_server_id) {
            $server_id = $this->ldap_server_id;
        }


        $this->server = new ilLDAPServer($server_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initUserDefinedFields()

ilLDAPSettingsGUI::initUserDefinedFields ( )

private

Definition at line 1171 of file class.ilLDAPSettingsGUI.php.

References ilUserDefinedFields\_getInstance().

Referenced by initUserMappingForm(), and saveMapping().

                                            : void
    {
        $this->udf = ilUserDefinedFields::_getInstance();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initUserMappingForm()

ilLDAPSettingsGUI::initUserMappingForm ( )

private

Create Property Form GUI for User Mapping.

Definition at line 1353 of file class.ilLDAPSettingsGUI.php.

References $lang, ILIAS\Repository\ctrl(), getMappingFields(), initUserDefinedFields(), and ILIAS\Repository\lng().

Referenced by userMapping().

                                          : ilPropertyFormGUI
    {
        $propertie_form = new ilPropertyFormGUI();
        $propertie_form->setTitle($this->lng->txt('ldap_mapping_table'));
        $propertie_form->setFormAction($this->ctrl->getFormAction($this, 'saveMapping'));
        $propertie_form->addCommandButton('saveMapping', $this->lng->txt('save'));

        foreach ($this->getMappingFields() as $mapping => $lang) {
            $text_form = new ilTextInputGUI($lang);
            $text_form->setPostVar($mapping . "_value");
            $text_form->setValue($this->mapping->getValue($mapping));
            $text_form->setSize(32);
            $text_form->setMaxLength(255);
            $propertie_form->addItem($text_form);

            $checkbox_form = new ilCheckboxInputGUI("");
            $checkbox_form->setPostVar($mapping . "_update");
            $checkbox_form->setChecked($this->mapping->enabledUpdate($mapping));
            $checkbox_form->setOptionTitle($this->lng->txt('ldap_update_field_info'));
            $propertie_form->addItem($checkbox_form);
        }

        $this->initUserDefinedFields();
        foreach ($this->udf->getDefinitions() as $definition) {
            $text_form = new ilTextInputGUI($definition['field_name']);
            $text_form->setPostVar('udf_' . $definition['field_id'] . '_value');
            $text_form->setValue($this->mapping->getValue('udf_' . $definition['field_id']));
            $text_form->setSize(32);
            $text_form->setMaxLength(255);
            $propertie_form->addItem($text_form);

            $checkbox_form = new ilCheckboxInputGUI("");
            $checkbox_form->setPostVar('udf_' . $definition['field_id'] . '_update');
            $checkbox_form->setChecked($this->mapping->enabledUpdate('udf_' . $definition['field_id']));
            $checkbox_form->setOptionTitle($this->lng->txt('ldap_update_field_info'));
            $propertie_form->addItem($checkbox_form);
        }

        return $propertie_form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

loadRoleAssignmentRule()

ilLDAPSettingsGUI::loadRoleAssignmentRule ( int  $a_rule_id, bool  $load_from_form = true  )

private

Load input from form.

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

References $res, ilLDAPRoleAssignmentRule\_getInstanceByRuleId(), ILIAS\Repository\form(), ilSession\get(), getServer(), ilQueryParser\QP_COMBINATION_AND, ilQueryParser\setMinWordLength(), ilUtil\stripSlashes(), and ilLDAPRoleAssignmentRule\TYPE_ATTRIBUTE.

Referenced by checkRoleAssignmentInput(), and saveRoleSelection().

                                                                                        : void
    {
        if (is_object($this->rule)) {
            return;
        }

        $this->rule = ilLDAPRoleAssignmentRule::_getInstanceByRuleId($a_rule_id);

        if ($load_from_form) {
            if ($this->form->getInput('role_name') === '0') {
                $this->rule->setRoleId((int) $this->form->getInput('role_id'));
            } elseif ($this->form->getInput('role_search')) {
                $parser = new ilQueryParser('"' . $this->form->getInput('role_search') . '"');

                // TODO: Handle minWordLength
                $parser->setMinWordLength(1);
                $parser->setCombination(ilQueryParser::QP_COMBINATION_AND);
                $parser->parse();

                $object_search = new ilLikeObjectSearch($parser);
                $object_search->setFilter(array('role'));
                $res = $object_search->performSearch();

                $entries = $res->getEntries();
                if (count($entries) === 1) {
                    $role = current($entries);
                    $this->rule->setRoleId($role['obj_id']);
                } elseif (count($entries) > 1) {
                    $this->rule->setRoleId(-1);
                }
            }

            $this->rule->setAttributeName($this->form->getInput('name'));
            $this->rule->setAttributeValue($this->form->getInput('value'));
            $this->rule->setDN($this->form->getInput('dn'));
            $this->rule->setMemberAttribute($this->form->getInput('at'));
            $this->rule->setMemberIsDN((bool) $this->form->getInput('isdn'));
            $this->rule->enableAddOnUpdate((bool) $this->form->getInput('add_missing'));
            $this->rule->enableRemoveOnUpdate((bool) $this->form->getInput('remove_deprecated'));
            $this->rule->setPluginId((int) $this->form->getInput('plugin_id'));
            $this->rule->setType((int) $this->form->getInput('type'));
            $this->rule->setServerId($this->getServer()->getServerId());
            return;
        }

        // LOAD from session
        $this->rule->setServerId($this->getServer()->getServerId());
        $rule = unserialize(ilSession::get('ldap_role_ass'), ["allowed_classes" => false]);

        $this->rule->enableAddOnUpdate((bool) ($rule['add_on_update'] ?? false));
        $this->rule->enableRemoveOnUpdate((bool) ($rule['remove_on_update'] ?? false));
        $this->rule->setType((int) ilUtil::stripSlashes(
            $rule['type'] ?? (string) ilLDAPRoleAssignmentRule::TYPE_ATTRIBUTE
        ));
        $this->rule->setDN(ilUtil::stripSlashes($rule['dn'] ?? ''));
        $this->rule->setMemberAttribute(ilUtil::stripSlashes($rule['at'] ?? ''));
        $this->rule->setMemberIsDN((bool) (ilUtil::stripSlashes($rule['isdn'] ?? false)));
        $this->rule->setAttributeName(ilUtil::stripSlashes($rule['name'] ?? ''));
        $this->rule->setAttributeValue(ilUtil::stripSlashes($rule['value'] ?? ''));
        $this->rule->setPluginId((int) ilUtil::stripSlashes($rule['plugin'] ?? '0'));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareGlobalRoleSelection()

ilLDAPSettingsGUI::prepareGlobalRoleSelection ( )

private

New implementation for InputForm.

Definition at line 1133 of file class.ilLDAPSettingsGUI.php.

References $role_id, ilObject\_lookupTitle(), ilUtil\_sortIds(), and ILIAS\Repository\lng().

Referenced by initForm(), and initFormRoleAssignments().

                                                 : array
    {
        $global_roles = ilUtil::_sortIds(
            $this->rbacReview->getGlobalRoles(),
            'object_data',
            'title',
            'obj_id'
        );

        $select[0] = $this->lng->txt('links_select_one');
        foreach ($global_roles as $role_id) {
            $select[$role_id] = ilObject::_lookupTitle((int) $role_id);
        }
        return $select;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareMappingSelect()

ilLDAPSettingsGUI::prepareMappingSelect ( )

private

Definition at line 1176 of file class.ilLDAPSettingsGUI.php.

References ilLegacyFormElementsUtil\formSelect(), and ILIAS\Repository\lng().

                                           : string
    {
        return ilLegacyFormElementsUtil::formSelect(
            $this->mapping_template,
            'mapping_template',
            [0 => $this->lng->txt('ldap_mapping_template'),
             "inetOrgPerson" => 'inetOrgPerson',
             "organizationalPerson" => 'organizationalPerson',
             "person" => 'person',
             "ad_2003" => 'Active Directory (Win 2003)'
            ],
            false,
            true
        );
    }

Here is the call graph for this function:

roleAssignments()

ilLDAPSettingsGUI::roleAssignments

(

)

Edit role assignments.

Definition at line 263 of file class.ilLDAPSettingsGUI.php.

References ilLDAPRoleAssignmentRule\_getInstanceByRuleId(), ilLDAPRoleAssignmentRule\_getRules(), ILIAS\Repository\form(), initFormRoleAssignments(), ILIAS\Repository\lng(), ILIAS\UI\examples\Progress\Bar\server(), and setSubTabs().

Referenced by addRoleAssignment(), confirmDeleteRules(), deleteRules(), editRoleAssignment(), saveRoleSelection(), and updateRoleAssignment().

                                     : void
    {
        $this->setSubTabs();
        $this->tabs_gui->activateTab('role_assignments');

        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.ldap_role_assignments.html', 'components/ILIAS/LDAP');

        $this->initFormRoleAssignments('create');
        $this->role_mapping_rule = ilLDAPRoleAssignmentRule::_getInstanceByRuleId(0);
        $this->tpl->setVariable('NEW_ASSIGNMENT_TBL', $this->form->getHTML());


        if (count($rules = ilLDAPRoleAssignmentRule::_getRules($this->server->getServerId()))) {
            $table_gui = new ilLDAPRoleAssignmentTableGUI($this, 'roleAssignments');
            $table_gui->setTitle($this->lng->txt("ldap_tbl_role_ass"));
            $table_gui->parse($rules);
            $table_gui->addMultiCommand("confirmDeleteRules", $this->lng->txt("delete"));
            $table_gui->setSelectAllCheckbox("rule_id");
            $this->tpl->setVariable('RULES_TBL', $table_gui->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

roleMapping()

ilLDAPSettingsGUI::roleMapping

(

)

Role Mapping Tab.

Definition at line 1397 of file class.ilLDAPSettingsGUI.php.

References ilLDAPRoleGroupMappingSettings\_getInstanceByServerId(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\UI\examples\Progress\Bar\server(), ilFormPropertyGUI\setInfo(), setSubTabs(), ilTable2GUI\setTitle(), and ILIAS\Repository\toolbar().

Referenced by deleteRoleMapping().

                                 : void
    {
        $this->setSubTabs();
        $this->tabs_gui->setTabActive('role_mapping');
        $this->toolbar->addButton(
            $this->lng->txt("ldap_new_role_assignment"),
            $this->ctrl->getLinkTarget($this, 'addRoleMapping')
        );

        //Set propertyform for synchronization settings
        $propertie_form = new ilPropertyFormGUI();
        $propertie_form->setTitle($this->lng->txt('ldap_role_settings'));
        $propertie_form->setFormAction($this->ctrl->getFormAction($this, "saveSyncronizationSettings"));
        $propertie_form->addCommandButton("saveSyncronizationSettings", $this->lng->txt('save'));
        $role_active = new ilCheckboxInputGUI($this->lng->txt('ldap_role_active'));
        $role_active->setPostVar('role_sync_active');
        $role_active->setChecked($this->server->enabledRoleSynchronization());
        $propertie_form->addItem($role_active);
        $binding = new ilCombinationInputGUI($this->lng->txt('ldap_server_binding'));
        $binding->setInfo($this->lng->txt('ldap_role_bind_user_info'));
        $user = new ilTextInputGUI("");
        $user->setPostVar("role_bind_user");
        $user->setValue($this->server->getRoleBindDN());
        $user->setSize(50);
        $user->setMaxLength(255);
        $binding->addCombinationItem("0", $user, $this->lng->txt('ldap_role_bind_user'));

        $pass = new ilPasswordInputGUI("");
        $pass->setPostVar("role_bind_pass");
        $pass->setValue($this->server->getRoleBindPassword());
        $pass->setSize(12);
        $pass->setMaxLength(100);
        $pass->setRetype(false);
        $binding->addCombinationItem("1", $pass, $this->lng->txt('ldap_role_bind_pass'));

        $propertie_form->addItem($binding);

        $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.ldap_role_mappings.html', 'components/ILIAS/LDAP');
        $this->tpl->setVariable("NEW_ASSIGNMENT_TBL", $propertie_form->getHTML());

        //Set Group Assignments Table if mappings exist
        $mapping_instance = ilLDAPRoleGroupMappingSettings::_getInstanceByServerId($this->server->getServerId());
        $mappings = $mapping_instance->getMappings();
        if (count($mappings)) {
            $table_gui = new ilLDAPRoleMappingTableGUI($this, $this->server->getServerId());
            $table_gui->setTitle($this->lng->txt('ldap_role_group_assignments'));
            $table_gui->setData($mappings);
            $this->tpl->setVariable("RULES_TBL", $table_gui->getHTML());
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

roleSelectionRequired()

ilLDAPSettingsGUI::roleSelectionRequired ( )

private

Definition at line 463 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getServer(), and ilSession\set().

Referenced by addRoleAssignment(), and updateRoleAssignment().

                                            : bool
    {
        if ($this->rule->getRoleId() > 0) {
            return false;
        }
        $rule = [];
        $rule['server_id'] = $this->getServer()->getServerId();
        $rule['rule_id'] = $this->rule_id ?: 0;
        $rule['role_search'] = $this->form->getInput('role_search');
        $rule['add_on_update'] = $this->form->getInput('add_missing');
        $rule['remove_on_update'] = $this->form->getInput('remove_deprecated');
        $rule['type'] = $this->form->getInput('type');
        $rule['dn'] = $this->form->getInput('dn');
        $rule['at'] = $this->form->getInput('at');
        $rule['isdn'] = $this->form->getInput('isdn');
        $rule['name'] = $this->form->getInput('name');
        $rule['value'] = $this->form->getInput('value');
        $rule['plugin'] = $this->form->getInput('plugin_id');
        ilSession::set("ldap_role_ass", serialize($rule));
        $this->ctrl->saveParameter($this, 'rule_id');
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

save()

ilLDAPSettingsGUI::save

(

)

Definition at line 997 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\ctrl(), initAttributeMapping(), initForm(), ILIAS\Repository\lng(), ILIAS\UI\examples\Progress\Bar\server(), and setSubTabs().

                          : bool
    {
        $this->setSubTabs();
        $this->tabs_gui->setTabActive('settings');

        $this->initForm();
        if ($this->form_gui->checkInput()) {
            $this->server->toggleActive((bool) $this->form_gui->getInput('active'));
            $this->server->enableAuthentication(!(bool) $this->form_gui->getInput('ds'));
            $this->server->setName($this->form_gui->getInput('server_name'));
            $this->server->setUrl($this->form_gui->getInput('server_url'));
            $this->server->setVersion((int) $this->form_gui->getInput('version'));
            $this->server->setBaseDN($this->form_gui->getInput('base_dn'));
            $this->server->toggleReferrer((bool) $this->form_gui->getInput('referrals'));
            $this->server->toggleTLS((bool) $this->form_gui->getInput('tls'));
            $this->server->setBindingType((int) $this->form_gui->getInput('binding_type'));
            $this->server->setBindUser($this->form_gui->getInput('bind_dn'));
            $this->server->setBindPassword($this->form_gui->getInput('bind_pass'));
            $this->server->setSearchBase($this->form_gui->getInput('search_base'));
            $this->server->setUserScope((int) $this->form_gui->getInput('user_scope'));
            $this->server->setUserAttribute($this->form_gui->getInput('user_attribute'));
            $this->server->setFilter($this->form_gui->getInput('filter'));
            $this->server->setGroupDN($this->form_gui->getInput('group_dn'));
            $this->server->setGroupScope((int) $this->form_gui->getInput('group_scope'));
            $this->server->setGroupFilter($this->form_gui->getInput('group_filter'));
            $this->server->setGroupMember($this->form_gui->getInput('group_member'));
            $this->server->enableGroupMemberIsDN((bool) $this->form_gui->getInput('memberisdn'));
            $this->server->setGroupName($this->form_gui->getInput('group'));
            $this->server->setGroupAttribute($this->form_gui->getInput('group_attribute'));
            $this->server->setGroupUserFilter($this->form_gui->getInput('group_user_filter'));
            $this->server->toggleMembershipOptional((bool) $this->form_gui->getInput('group_optional'));
            $this->server->enableSyncOnLogin((bool) $this->form_gui->getInput('sync_on_login'));
            $this->server->enableSyncPerCron((bool) $this->form_gui->getInput('sync_per_cron'));
            $this->server->setGlobalRole((int) $this->form_gui->getInput('global_role'));
            $this->server->enableAccountMigration((bool) $this->form_gui->getInput('migration'));
            $this->server->setUsernameFilter($this->form_gui->getInput("name_filter"));
            $this->server->enableEscapeDN((bool) $this->form_gui->getInput('escape_dn'));
            if (!$this->server->validate()) {
                $this->main_tpl->setOnScreenMessage('failure', $this->ilErr->getMessage());
                $this->form_gui->setValuesByPost();
                $this->tpl->setContent($this->form_gui->getHTML());
                return false;
            }

            // Update or create
            if ($this->server->getServerId()) {
                $this->server->update();
            } else {
                $this->server->create();
            }

            // Now server_id exists => update LDAP attribute mapping
            $this->initAttributeMapping();
            $this->mapping->setRule('global_role', (string) $this->form_gui->getInput('global_role'), false);
            $this->mapping->save();

            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'serverList');
            return true;
        }

        $this->form_gui->setValuesByPost();
        $this->tpl->setContent($this->form_gui->getHTML());
        return true;
    }

Here is the call graph for this function:

saveMapping()

ilLDAPSettingsGUI::saveMapping

(

)

Definition at line 676 of file class.ilLDAPSettingsGUI.php.

References getMappingFields(), initAttributeMapping(), initUserDefinedFields(), ILIAS\Repository\lng(), and userMapping().

                                 : void
    {
        $this->initAttributeMapping();
        $this->tabs_gui->activateTab('role_mapping');

        foreach (array_keys($this->getMappingFields()) as $key) {
            $this->mapping->setRule(
                $key,
                $this->attribute_mappings[$key][0],
                $this->attribute_mappings[$key][1]
            );
        }
        $this->initUserDefinedFields();
        foreach ($this->udf->getDefinitions() as $definition) {
            $key = 'udf_' . $definition['field_id'];
            $this->mapping->setRule(
                $key,
                $this->attribute_mappings[$key][0],
                $this->attribute_mappings[$key][1]
            );
        }

        $this->mapping->save();
        $this->userMapping();

        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
    }

Here is the call graph for this function:

saveRoleSelection()

ilLDAPSettingsGUI::saveRoleSelection ( )

protected

Save role selection.

Returns

Definition at line 521 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\lng(), loadRoleAssignmentRule(), roleAssignments(), and showRoleSelection().

                                          : bool
    {
        if (!$this->ilAccess->checkAccess('write', '', $this->ref_id)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->roleAssignments();
            return false;
        }

        if (!$this->role_id) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->showRoleSelection();
            return false;
        }

        $this->loadRoleAssignmentRule($this->rule_id ?? 0, false);
        $this->rule->setRoleId($this->role_id);

        if ($this->rule_id) {
            $this->rule->update();
        } else {
            $this->rule->create();
        }

        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
        $this->roleAssignments();
        return true;
    }

Here is the call graph for this function:

saveSyncronizationSettings()

ilLDAPSettingsGUI::saveSyncronizationSettings

(

)

save Syncronization Settings on Role Mapping screen

Definition at line 1803 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Progress\Bar\server().

                                                : void
    {
        $this->server->setRoleBindDN($this->role_bind_user);
        $this->server->setRoleBindPassword($this->role_bind_pass);
        $this->server->enableRoleSynchronization($this->role_sync_active);

        // Update or create
        if ($this->server->getServerId()) {
            $this->server->update();
        }
        $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, "roleMapping");
    }

Here is the call graph for this function:

serverList()

ilLDAPSettingsGUI::serverList ( )

private

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

References ilLDAPServer\_getAllServer(), ilLDAPServer\checkLDAPLib(), ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\UI\examples\Progress\Bar\server(), and ILIAS\Repository\toolbar().

Referenced by activateServer(), confirmDeleteServerSettings(), deactivateServer(), and deleteServerSettings().

                                 : void
    {
        if (!$this->rbacSystem->checkAccess('visible,read', $this->ref_id)) {
            $this->ilErr->raiseError($this->lng->txt('msg_no_perm_read'), $this->ilErr->WARNING);
        }

        if (!ilLDAPServer::checkLDAPLib() && $this->server->isActive()) {
            $this->main_tpl->setOnScreenMessage('failure', 'Missing LDAP libraries. Please ensure that the PHP LDAP module is installed on your server.');
        }

        if ($this->rbacSystem->checkAccess('write', $this->ref_id)) {
            $this->toolbar->addButton(
                $this->lng->txt('add_ldap_server'),
                $this->ctrl->getLinkTarget($this, 'addServerSettings')
            );
        }

        $table = new \ILIAS\LDAP\Server\UI\ServerTable(
            ilLDAPServer::_getAllServer(),
            $this,
            $this->ui_factory,
            $this->ui_renderer,
            $this->lng,
            $this->ctrl,
            $this->http->request(),
            new \ILIAS\Data\Factory(),
            'handleServerTableActions',
            $this->rbacSystem->checkAccess('write', $this->ref_id)
        );

        $this->tpl->setContent($this->ui_renderer->render($table->getComponent()));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setServerFormValues()

ilLDAPSettingsGUI::setServerFormValues

(

)

Definition at line 755 of file class.ilLDAPSettingsGUI.php.

References ilLDAPAttributeMapping\_lookupGlobalRole(), and ILIAS\UI\examples\Progress\Bar\server().

Referenced by editServerSettings().

                                         : void
    {
        $this->form_gui->setValuesByArray(array(
            'active' => $this->server->isActive(),
            'ds' => !$this->server->isAuthenticationEnabled(),
            'server_name' => $this->server->getName(),
            'server_url' => $this->server->getUrlString(),
            'version' => $this->server->getVersion(),
            'base_dn' => $this->server->getBaseDN(),
            'referrals' => $this->server->isActiveReferrer(),
            'tls' => $this->server->isActiveTLS(),
            'binding_type' => $this->server->getBindingType(),
            'bind_dn' => $this->server->getBindUser(),
            'bind_pass' => $this->server->getBindPassword(),
            'bind_pass_retype' => $this->server->getBindPassword(),
            'search_base' => $this->server->getSearchBase(),
            'user_scope' => $this->server->getUserScope(),
            'user_attribute' => $this->server->getUserAttribute(),
            'filter' => $this->server->getFilter(),
            'group_dn' => $this->server->getGroupDN(),
            'group_scope' => $this->server->getGroupScope(),
            'group_filter' => $this->server->getGroupFilter(),
            'group_member' => $this->server->getGroupMember(),
            'memberisdn' => $this->server->enabledGroupMemberIsDN(),
            'group' => $this->server->getGroupName(),
            'group_attribute' => $this->server->getGroupAttribute(),
            'group_optional' => $this->server->isMembershipOptional(),
            'group_user_filter' => $this->server->getGroupUserFilter(),
            'sync_on_login' => $this->server->enabledSyncOnLogin(),
            'sync_per_cron' => $this->server->enabledSyncPerCron(),
            'global_role' => ilLDAPAttributeMapping::_lookupGlobalRole($this->server->getServerId()),
            'migration' => (int) $this->server->isAccountMigrationEnabled(),
            "name_filter" => $this->server->getUsernameFilter(),
            'escape_dn' => $this->server->enabledEscapeDN()
        ));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setSubTabs()

ilLDAPSettingsGUI::setSubTabs ( )

private

Set sub tabs for ldap section.

Definition at line 1068 of file class.ilLDAPSettingsGUI.php.

References ilLDAPServer\_getServerList(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by addRoleAssignment(), confirmDeleteRules(), editRoleAssignment(), editServerSettings(), initRoleMappingForm(), roleAssignments(), roleMapping(), save(), showRoleSelection(), and userMapping().

                                 : void
    {
        $this->tabs_gui->clearTargets();

        $this->tabs_gui->setBackTarget(
            $this->lng->txt("back"),
            $this->ctrl->getLinkTarget($this, 'serverList')
        );


        $this->tabs_gui->addTab(
            "settings",
            $this->lng->txt("ldap_settings"),
            $this->ctrl->getLinkTarget($this, 'editServerSettings')
        );

        // Disable all other tabs, if server hasn't been configured.
        if (!count(ilLDAPServer::_getServerList())) {
            return;
        }

        $this->tabs_gui->addTab(
            "user_mapping",
            $this->lng->txt("ldap_user_mapping"),
            $this->ctrl->getLinkTarget($this, 'userMapping')
        );

        $this->tabs_gui->addTab(
            "role_assignments",
            $this->lng->txt('ldap_role_assignments'),
            $this->ctrl->getLinkTarget($this, 'roleAssignments')
        );

        $this->tabs_gui->addTab(
            "role_mapping",
            $this->lng->txt("ldap_role_mapping"),
            $this->ctrl->getLinkTarget($this, 'roleMapping')
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setValuesByArray()

ilLDAPSettingsGUI::setValuesByArray ( )

private

set values of form array

Definition at line 312 of file class.ilLDAPSettingsGUI.php.

References $role_id, ilObject\_lookupTitle(), ILIAS\Repository\form(), and ILIAS\Repository\int().

Referenced by editRoleAssignment().

                                       : void
    {
        $role_id = $this->role_mapping_rule->getRoleId();
        if ($this->rbacReview->isGlobalRole($role_id)) {
            $val['role_name'] = 0;
            $val['role_id'] = $role_id;
        } else {
            $val['role_name'] = 1;
            $val['role_search'] = ilObject::_lookupTitle($role_id);
        }
        $val['add_missing'] = (int) $this->role_mapping_rule->isAddOnUpdateEnabled();
        $val['remove_deprecated'] = (int) $this->role_mapping_rule->isRemoveOnUpdateEnabled();
        $val['type'] = $this->role_mapping_rule->getType();
        $val['dn'] = $this->role_mapping_rule->getDN();
        $val['at'] = $this->role_mapping_rule->getMemberAttribute();
        $val['isdn'] = $this->role_mapping_rule->isMemberAttributeDN();
        $val['name'] = $this->role_mapping_rule->getAttributeName();
        $val['value'] = $this->role_mapping_rule->getAttributeValue();
        $val['plugin_id'] = $this->role_mapping_rule->getPluginId();

        $this->form->setValuesByArray($val);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showRoleSelection()

ilLDAPSettingsGUI::showRoleSelection ( )

protected

show role selection

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

References $res, ILIAS\Repository\ctrl(), ilSession\get(), ILIAS\Repository\lng(), ilQueryParser\QP_COMBINATION_AND, and setSubTabs().

Referenced by saveRoleSelection().

                                          : bool
    {
        $this->setSubTabs();
        $this->tabs_gui->activateTab('role_assignment');
        $this->ctrl->saveParameter($this, 'rule_id');

        $parser = new ilQueryParser(unserialize(ilSession::get('ldap_role_ass'), ["allowed_classes" => false])['role_search']);
        $parser->setMinWordLength(1);
        $parser->setCombination(ilQueryParser::QP_COMBINATION_AND);
        $parser->parse();

        $object_search = new ilLikeObjectSearch($parser);
        $object_search->setFilter(array('role'));
        $res = $object_search->performSearch();

        $entries = $res->getEntries();

        $table = new ilRoleSelectionTableGUI($this, 'showRoleSelection');
        $table->setTitle($this->lng->txt('ldap_role_selection'));
        $table->addMultiCommand('saveRoleSelection', $this->lng->txt('ldap_choose_role'));
        $table->parse($entries);

        $this->tpl->setContent($table->getHTML());
        return true;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateRoleAssignment()

ilLDAPSettingsGUI::updateRoleAssignment

(

)

update role assignment

Definition at line 338 of file class.ilLDAPSettingsGUI.php.

References checkRoleAssignmentInput(), ILIAS\Repository\ctrl(), ILIAS\Repository\form(), initFormRoleAssignments(), ILIAS\Repository\lng(), roleAssignments(), and roleSelectionRequired().

                                          : bool
    {
        if (!$this->ilAccess->checkAccess('write', '', $this->ref_id)) {
            $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->roleAssignments();
            return false;
        }

        $this->initFormRoleAssignments('edit');

        $formWithoutErrors = $this->form->checkInput();
        $roleErrorMessage = $this->checkRoleAssignmentInput($this->rule_id);
        if (!$formWithoutErrors || $roleErrorMessage !== '') {
            if ($roleErrorMessage !== '') {
                $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt($roleErrorMessage));
            }

            $this->tpl->addBlockFile('ADM_CONTENT', 'adm_content', 'tpl.ldap_role_assignments.html', 'components/ILIAS/LDAP');

            $this->form->setValuesByPost();
            $this->tpl->setVariable('NEW_ASSIGNMENT_TBL', $this->form->getHTML());
            $this->tabs_gui->activateSubTab('role_assignments');
            return true;
        }

        // Might redirect
        if ($this->roleSelectionRequired()) {
            $this->ctrl->redirect($this, 'showRoleSelection');
        } else {
            $this->rule->update();
            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
            $this->roleAssignments();
        }
        return true;
    }

Here is the call graph for this function:

updateRoleMapping()

ilLDAPSettingsGUI::updateRoleMapping

(

)

Check edit screen input and save to db.

Definition at line 1772 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\ctrl(), initRoleMappingForm(), ILIAS\Repository\lng(), and ILIAS\UI\examples\Progress\Bar\server().

                                       : void
    {
        $propertie_form = $this->initRoleMappingForm("updateRoleMapping");

        if ($propertie_form->checkInput() && $this->rbacReview->roleExists($propertie_form->getInput("role"))) {
            $mapping = new ilLDAPRoleGroupMappingSetting($this->mapping_id);
            $mapping->setServerId($this->server->getServerId());
            $mapping->setURL($propertie_form->getInput("url"));
            $mapping->setDN($propertie_form->getInput("dn"));
            $mapping->setMemberAttribute($propertie_form->getInput("member"));
            $mapping->setMemberISDN((bool) $propertie_form->getInput("memberisdn"));
            $mapping->setRoleByName($propertie_form->getInput("role"));
            $mapping->setMappingInfo($propertie_form->getInput("info"));
            $mapping->setMappingInfoType((bool) $propertie_form->getInput("info_type"));
            $mapping->update();

            $this->main_tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, "roleMapping");
        } else {
            if (!$this->rbacReview->roleExists($propertie_form->getInput("role"))) {
                $this->main_tpl->setOnScreenMessage('failure', $this->lng->txt("ldap_role_not_exists") . " " .
                        $propertie_form->getInput("role"));
            }
            $propertie_form->setValuesByPost();
            $this->tpl->setContent($propertie_form->getHTML());
        }
    }

Here is the call graph for this function:

userMapping()

ilLDAPSettingsGUI::userMapping

(

)

Ldap User Mapping.

Definition at line 1621 of file class.ilLDAPSettingsGUI.php.

References initAttributeMapping(), initUserMappingForm(), setSubTabs(), and userMappingToolbar().

Referenced by chooseMapping(), and saveMapping().

                                 : void
    {
        $this->initAttributeMapping();

        $this->setSubTabs();
        $this->tabs_gui->activateTab('user_mapping');
        $this->userMappingToolbar();

        $propertie_form = $this->initUserMappingForm();

        $this->tpl->setContent($propertie_form->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

userMappingToolbar()

ilLDAPSettingsGUI::userMappingToolbar ( )

private

Create Toolbar.

Definition at line 1332 of file class.ilLDAPSettingsGUI.php.

References ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and ILIAS\Repository\toolbar().

Referenced by userMapping().

                                         : void
    {
        $select_form = new ilSelectInputGUI("mapping_template");
        $select_form->setPostVar("mapping_template");
        $options = array(
                        "" => $this->lng->txt('ldap_mapping_template'),
                        "inetOrgPerson" => 'inetOrgPerson',
                        "organizationalPerson" => 'organizationalPerson',
                        "person" => 'person',
                        "ad_2003" => 'Active Directory (Win 2003)');
        $select_form->setOptions($options);
        $select_form->setValue($this->mapping_template);

        $this->toolbar->addInputItem($select_form);
        $this->toolbar->addFormButton($this->lng->txt('show'), "chooseMapping");
        $this->toolbar->setFormAction($this->ctrl->getFormAction($this, "chooseMapping"));
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$attribute_mappings

array ilLDAPSettingsGUI::$attribute_mappings = []

private

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

$component_repository

ilComponentRepository ilLDAPSettingsGUI::$component_repository

private

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

$ctrl

ilCtrl ilLDAPSettingsGUI::$ctrl

private

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

$form

ilPropertyFormGUI ilLDAPSettingsGUI::$form = null

private

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

$form_gui

ilPropertyFormGUI ilLDAPSettingsGUI::$form_gui = null

private

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

$http

readonly ILIAS HTTP GlobalHttpState ilLDAPSettingsGUI::$http

private

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

$ilAccess

ilAccessHandler ilLDAPSettingsGUI::$ilAccess

private

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

$ilErr

ilErrorHandling ilLDAPSettingsGUI::$ilErr

private

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

$ldap_server_id

int ilLDAPSettingsGUI::$ldap_server_id = null

private

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

Referenced by initServer().

$lng

ilLanguage ilLDAPSettingsGUI::$lng

private

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

$main_tpl

ilGlobalTemplateInterface ilLDAPSettingsGUI::$main_tpl

private

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

$mapping

ilLDAPAttributeMapping ilLDAPSettingsGUI::$mapping

private

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

$mapping_id

int ilLDAPSettingsGUI::$mapping_id = null

private

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

$mapping_template

string ilLDAPSettingsGUI::$mapping_template = null

private

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

$mappings

array ilLDAPSettingsGUI::$mappings = null

private

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

$rbacReview

ilRbacReview ilLDAPSettingsGUI::$rbacReview

private

Definition at line 38 of file class.ilLDAPSettingsGUI.php.

$rbacSystem

ilRbacSystem ilLDAPSettingsGUI::$rbacSystem

private

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

$ref_id

int ilLDAPSettingsGUI::$ref_id

private

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

$refinery

readonly ILIAS Refinery Factory ilLDAPSettingsGUI::$refinery

private

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

$role_bind_pass

string ilLDAPSettingsGUI::$role_bind_pass = null

private

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

$role_bind_user

string ilLDAPSettingsGUI::$role_bind_user = null

private

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

$role_id

int ilLDAPSettingsGUI::$role_id = null

private

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

Referenced by prepareGlobalRoleSelection(), and setValuesByArray().

$role_mapping

ilLDAPRoleGroupMappingSettings ilLDAPSettingsGUI::$role_mapping = null

private

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

$role_mapping_rule

ilLDAPRoleAssignmentRule ilLDAPSettingsGUI::$role_mapping_rule = null

private

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

$role_sync_active

bool ilLDAPSettingsGUI::$role_sync_active = false

private

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

$rule

ilLDAPRoleAssignmentRule ilLDAPSettingsGUI::$rule = null

private

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

$rule_id

int ilLDAPSettingsGUI::$rule_id = null

private

Definition at line 51 of file class.ilLDAPSettingsGUI.php.

$rule_ids

array ilLDAPSettingsGUI::$rule_ids = null

private

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

$server

ilLDAPServer ilLDAPSettingsGUI::$server

private

Definition at line 27 of file class.ilLDAPSettingsGUI.php.

Referenced by getServer().

$server_ids

array ilLDAPSettingsGUI::$server_ids = null

private

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

$tabs_gui

ilTabsGUI ilLDAPSettingsGUI::$tabs_gui

private

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

$toolbar

ilToolbarGUI ilLDAPSettingsGUI::$toolbar

private

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

$tpl

ilGlobalTemplateInterface ilLDAPSettingsGUI::$tpl

private

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

$udf

ilUserDefinedFields ilLDAPSettingsGUI::$udf

private

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

$ui_factory

readonly ILIAS UI Factory ilLDAPSettingsGUI::$ui_factory

private

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

$ui_renderer

readonly ILIAS UI Renderer ilLDAPSettingsGUI::$ui_renderer

private

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

---

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

• components/ILIAS/LDAP/classes/class.ilLDAPSettingsGUI.php