Class ilAuthShibbolethSettingsGUI. More...

Collaboration diagram for ilAuthShibbolethSettingsGUI:

Public Member Functions
	__construct (private int $ref_id)

	executeCommand ()

	settings ()

	save ()

	addRoleAutoCompleteObject ()

Protected Member Functions
	roleAssignment ()

	parseRulesTable ()

	confirmDeleteRules ()

	deleteRules ()

	initFormRoleAssignment (string $a_mode='default')

	addRoleAssignmentRule ()

	editRoleAssignment ()

	updateRoleAssignmentRule ()

	setSubTabs ()

Private Member Functions
	loadRule (int $a_rule_id=0)

	getRuleValues ()

	checkInput (int $a_rule_id=0)

	prepareRoleSelect ()

Private Attributes
const	PARAM_RULE_ID = 'rule_id'

ilAccessHandler	$access

ilComponentRepository	$component_repository

ilCtrl	$ctrl

ilPropertyFormGUI	$form = null

ilSetting	$global_settings

ilLanguage	$lng

RBACServices	$rbac

ilRbacReview	$rbac_review

Refinery	$refinery

ilShibbolethRoleAssignmentRule	$rule = null

ilShibbolethSettings	$shib_settings

ilTabsGUI	$tabs_gui

ilGlobalTemplateInterface	$tpl

WrapperFactory	$wrapper

Detailed Description

Class ilAuthShibbolethSettingsGUI.

Author: Stefan Meyer meyer.nosp@m.@lei.nosp@m.fos.c.nosp@m.om; Fabian Schmid fabia.nosp@m.n.sc.nosp@m.hmid@.nosp@m.ilub.nosp@m..unib.nosp@m.e.ch

Version: $Id$

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

Constructor & Destructor Documentation

◆ __construct()

ilAuthShibbolethSettingsGUI::__construct ( private int $ref_id )

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

    {
        global $DIC;
 
        $this->access = $DIC->access();
        $this->component_repository = $DIC["component.repository"];
        $this->ctrl = $DIC->ctrl();
        $this->global_settings = $DIC->settings();
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('shib');
        $this->rbac = $DIC->rbac();
        $this->rbac_review = $DIC->rbac()->review();
        $this->refinery = $DIC->refinery();
        $this->shib_settings = new ilShibbolethSettings();
        $this->tabs_gui = $DIC->tabs();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->wrapper = $DIC->http()->wrapper();
    }

References $DIC, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ILIAS\Repository\rbac(), and ILIAS\Repository\refinery().

Here is the call graph for this function:

Member Function Documentation

◆ addRoleAssignmentRule()

ilAuthShibbolethSettingsGUI::addRoleAssignmentRule ( )

protected

Exceptions

ilCtrlException

Definition at line 305 of file class.ilAuthShibbolethSettingsGUI.php.

                                              : bool
    {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->roleAssignment();
 
            return false;
        }
        $this->initFormRoleAssignment();
        if (!$this->form->checkInput() || ($err = $this->checkInput())) {
            if (isset($err)) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt($err));
            }
            $this->tabs_gui->activateSubTab('shib_role_assignment');
            $this->form->setValuesByPost();
            $this->tpl->addBlockFile(
                'ADM_CONTENT',
                'adm_content',
                'tpl.shib_role_assignment.html',
                'components/ILIAS/AuthShibboleth'
            );
            $this->tpl->setVariable('NEW_RULE_TABLE', $this->form->getHTML());
            if (($html = $this->parseRulesTable()) !== '') {
                $this->tpl->setVariable('RULE_TABLE', $html);
            }
 
            return true;
        }
        $this->rule->add();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
        $this->roleAssignment();
 
        return true;
    }

References ILIAS\Repository\access(), ILIAS\Repository\form(), initFormRoleAssignment(), ILIAS\Repository\lng(), parseRulesTable(), and roleAssignment().

Here is the call graph for this function:

◆ addRoleAutoCompleteObject()

ilAuthShibbolethSettingsGUI::addRoleAutoCompleteObject ( )

Definition at line 297 of file class.ilAuthShibbolethSettingsGUI.php.

                                               : void
    {
        ilRoleAutoCompleteInputGUI::echoAutoCompleteList();
    }

References ilRoleAutoCompleteInputGUI\echoAutoCompleteList().

Here is the call graph for this function:

◆ checkInput()

ilAuthShibbolethSettingsGUI::checkInput ( int $a_rule_id = 0 )

private

Definition at line 458 of file class.ilAuthShibbolethSettingsGUI.php.

                                                   : string
    {
        $this->loadRule($a_rule_id);
 
        return $this->rule->validate();
    }

References loadRule().

Here is the call graph for this function:

◆ confirmDeleteRules()

ilAuthShibbolethSettingsGUI::confirmDeleteRules ( )

protected

Exceptions

ilCtrlException

Definition at line 168 of file class.ilAuthShibbolethSettingsGUI.php.

                                           : bool
    {
        if (!$this->wrapper->post()->has('rule_ids')) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_one'));
            $this->roleAssignment();
 
            return false;
        }
        $this->tabs_gui->activateTab('shib_role_assignment');
        $c_gui = new ilConfirmationGUI();
        // set confirm/cancel commands
        $c_gui->setFormAction($this->ctrl->getFormAction($this, "deleteRules"));
        $c_gui->setHeaderText($this->lng->txt("shib_confirm_del_role_ass"));
        $c_gui->setCancel($this->lng->txt("cancel"), "roleAssignment");
        $c_gui->setConfirm($this->lng->txt("confirm"), "deleteRules");
 
        $rule_ids = $this->wrapper->post()->retrieve(
            'rule_ids',
            $this->refinery->to()->listOf($this->refinery->kindlyTo()->int())
        );
        foreach ($rule_ids as $rule_id) {
            $rule = new ilShibbolethRoleAssignmentRule($rule_id);
            $info = ilObject::_lookupTitle($rule->getRoleId());
            $info .= " (";
            $info .= $rule->conditionToString();
            $info .= ')';
            $c_gui->addItem('rule_ids[]', $rule_id, $info);
        }
        $this->tpl->setContent($c_gui->getHTML());
        return true;
    }

References $info, $rule, ilObject\_lookupTitle(), ilShibbolethRoleAssignmentRule\conditionToString(), ILIAS\Repository\ctrl(), ilShibbolethRoleAssignmentRule\getRoleId(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and roleAssignment().

Here is the call graph for this function:

◆ deleteRules()

ilAuthShibbolethSettingsGUI::deleteRules ( )

protected

Exceptions

ilCtrlException

Definition at line 203 of file class.ilAuthShibbolethSettingsGUI.php.

                                    : bool
    {
        if (!$this->wrapper->post()->has('rule_ids')) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('select_once'));
            $this->roleAssignment();
 
            return false;
        }
        $rule_ids = $this->wrapper->post()->retrieve(
            'rule_ids',
            $this->refinery->to()->listOf($this->refinery->kindlyTo()->int())
        );
        foreach ($rule_ids as $rule_id) {
            $rule = new ilShibbolethRoleAssignmentRule($rule_id);
            $rule->delete();
        }
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('shib_deleted_rule'));
        $this->roleAssignment();
 
        return true;
    }

References $rule, ilShibbolethRoleAssignmentRule\delete(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and roleAssignment().

Here is the call graph for this function:

◆ editRoleAssignment()

ilAuthShibbolethSettingsGUI::editRoleAssignment ( )

protected

Exceptions

ilCtrlException

Definition at line 343 of file class.ilAuthShibbolethSettingsGUI.php.

                                           : bool
    {
        $this->ctrl->saveParameter($this, self::PARAM_RULE_ID);
        $this->tabs_gui->activateSubTab('shib_role_assignment');
        $this->initFormRoleAssignment('update');
        $this->getRuleValues();
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.shib_role_assignment.html',
            'components/ILIAS/AuthShibboleth'
        );
        $this->tpl->setVariable('NEW_RULE_TABLE', $this->form->getHTML());
 
        return true;
    }

References ILIAS\Repository\ctrl(), ILIAS\Repository\form(), getRuleValues(), and initFormRoleAssignment().

Here is the call graph for this function:

◆ executeCommand()

ilAuthShibbolethSettingsGUI::executeCommand ( )

Exceptions

ilCtrlException
ilException

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

                                    : void
    {
        $cmd = $this->ctrl->getCmd();
        if (!$this->access->checkAccess('read', '', $this->ref_id)) {
            throw new ilException('Permission denied');
        }
        if ($cmd !== "settings" && !$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('msg_no_perm_write'), true);
            $this->ctrl->redirect($this, "settings");
        }
        $this->setSubTabs();
        if (!$cmd) {
            $cmd = "settings";
        }
        $this->$cmd();
    }

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

Here is the call graph for this function:

◆ getRuleValues()

ilAuthShibbolethSettingsGUI::getRuleValues ( )

private

Definition at line 430 of file class.ilAuthShibbolethSettingsGUI.php.

                                    : void
    {
        $rule_id = $this->wrapper->query()->has(self::PARAM_RULE_ID)
            ? $this->wrapper->query()->retrieve(self::PARAM_RULE_ID, $this->refinery->kindlyTo()->int())
            : 0;
 
        $rule = new ilShibbolethRoleAssignmentRule($rule_id);
        $role = $rule->getRoleId();
        if ($this->rbac->review()->isGlobalRole($role)) {
            $values['role_name'] = 0;
            $values['role_id'] = $role;
        } else {
            $values['role_name'] = 1;
            $values['role_search'] = ilObject::_lookupTitle($role);
        }
        $values['add_missing'] = (int) $rule->isAddOnUpdateEnabled();
        $values['remove_deprecated'] = (int) $rule->isRemoveOnUpdateEnabled();
        $values['attr_name'] = $rule->getName();
        $values['attr_value'] = $rule->getValue();
        if (!$rule->isPluginActive()) {
            $values['kind'] = 1;
        } else {
            $values['kind'] = 2;
            $values['plugin_id'] = $rule->getPluginId();
        }
        $this->form->setValuesByArray($values);
    }

References $rule, ilObject\_lookupTitle(), ILIAS\Repository\form(), ilShibbolethRoleAssignmentRule\getName(), ilShibbolethRoleAssignmentRule\getPluginId(), ilShibbolethRoleAssignmentRule\getRoleId(), ilShibbolethRoleAssignmentRule\getValue(), ILIAS\Repository\int(), ilShibbolethRoleAssignmentRule\isAddOnUpdateEnabled(), ilShibbolethRoleAssignmentRule\isPluginActive(), ilShibbolethRoleAssignmentRule\isRemoveOnUpdateEnabled(), ILIAS\Repository\rbac(), and ILIAS\Repository\refinery().

Referenced by editRoleAssignment().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initFormRoleAssignment()

ilAuthShibbolethSettingsGUI::initFormRoleAssignment ( string $a_mode = 'default' )

protected

Exceptions

ilCtrlException

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

                                                                         : void
    {
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this, 'cancel'));
        $this->form->setTitle($this->lng->txt('shib_role_ass_table'));
        if ($a_mode === 'default') {
            $this->form->setTitle($this->lng->txt('shib_role_ass_table'));
            $this->form->addCommandButton('addRoleAssignmentRule', $this->lng->txt('shib_new_rule'));
            $this->form->addCommandButton('settings', $this->lng->txt('cancel'));
        } else {
            $this->form->setTitle($this->lng->txt('shib_update_role_ass_table'));
            $this->form->addCommandButton('updateRoleAssignmentRule', $this->lng->txt('save'));
            $this->form->addCommandButton('roleAssignment', $this->lng->txt('cancel'));
        }
        // Role selection
        $role = new ilRadioGroupInputGUI($this->lng->txt('shib_role_name'), 'role_name');
        $role->setRequired(true);
        $global = new ilRadioOption($this->lng->txt('shib_global_role'), 0);
        $role->addOption($global);
        $role_select = new ilSelectInputGUI('', 'role_id');
        $role_select->setOptions($this->prepareRoleSelect());
        $global->addSubItem($role_select);
        $local = new ilRadioOption($this->lng->txt('shib_local_role'), 1);
        $role->addOption($local);
        $role_search = new ilRoleAutoCompleteInputGUI('', 'role_search', self::class, 'addRoleAutoCompleteObject');
        $role_search->setSize(40);
        $local->addSubItem($role_search);
        $role->setInfo($this->lng->txt('shib_role_name_info'));
        $this->form->addItem($role);
        // Update options
        $update = new ilNonEditableValueGUI($this->lng->txt('shib_update_roles'), 'update_roles');
        $update->setValue($this->lng->txt('shib_check_role_assignment'));
        $add = new ilCheckboxInputGUI('', 'add_missing');
        $add->setOptionTitle($this->lng->txt('shib_add_missing'));
        $add->setValue(1);
        $update->addSubItem($add);
        $remove = new ilCheckboxInputGUI('', 'remove_deprecated');
        $remove->setOptionTitle($this->lng->txt('shib_remove_deprecated'));
        $remove->setValue(1);
        $update->addSubItem($remove);
        $this->form->addItem($update);
        // Assignment type
        $kind = new ilRadioGroupInputGUI($this->lng->txt('shib_assignment_type'), 'kind');
        $kind->setValue(1);
        $kind->setRequired(true);
        $attr = new ilRadioOption($this->lng->txt('shib_attribute'), 1);
        $attr->setInfo($this->lng->txt('shib_attr_info'));
        $name = new ilTextInputGUI($this->lng->txt('shib_attribute_name'), 'attr_name');
        $name->setSize(32);
        $attr->addSubItem($name);
        $value = new ilTextInputGUI($this->lng->txt('shib_attribute_value'), 'attr_value');
        $value->setSize(32);
        $attr->addSubItem($value);
        $kind->addOption($attr);
        $pl_active = $this->component_repository->getPluginSlotById('shibhk')->hasActivePlugins();
        $pl = new ilRadioOption($this->lng->txt('shib_plugin'), 2);
        $pl->setInfo($this->lng->txt('shib_plugin_info'));
        $pl->setDisabled(!$pl_active);
        $id = new ilNumberInputGUI($this->lng->txt('shib_plugin_id'), 'plugin_id');
        $id->setDisabled(!$pl_active);
        $id->setSize(3);
        $id->setMaxLength(3);
        $id->setMaxValue(999);
        $id->setMinValue(1);
        $pl->addSubItem($id);
        $kind->addOption($pl);
        $this->form->addItem($kind);
    }

References $id, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ILIAS\Repository\lng(), and prepareRoleSelect().

Referenced by addRoleAssignmentRule(), editRoleAssignment(), roleAssignment(), and updateRoleAssignmentRule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadRule()

ilAuthShibbolethSettingsGUI::loadRule ( int $a_rule_id = 0 )

private

Definition at line 398 of file class.ilAuthShibbolethSettingsGUI.php.

                                                 : ilShibbolethRoleAssignmentRule
    {
        $this->rule = new ilShibbolethRoleAssignmentRule($a_rule_id);
        if ((int) $this->form->getInput('role_name') === 0) {
            $this->rule->setRoleId($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(['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->setName($this->form->getInput('attr_name'));
        $this->rule->setValue($this->form->getInput('attr_value'));
        $this->rule->enableAddOnUpdate($this->form->getInput('add_missing'));
        $this->rule->enableRemoveOnUpdate($this->form->getInput('remove_deprecated'));
        $this->rule->enablePlugin((int) $this->form->getInput('kind') === 2);
        $this->rule->setPluginId($this->form->getInput('plugin_id'));
 
        return $this->rule;
    }

References $res, $rule, ILIAS\Repository\form(), and ilQueryParser\QP_COMBINATION_AND.

Referenced by checkInput().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ parseRulesTable()

ilAuthShibbolethSettingsGUI::parseRulesTable ( )

protected

Exceptions

ilCtrlException

Definition at line 151 of file class.ilAuthShibbolethSettingsGUI.php.

                                        : string
    {
        if (ilShibbolethRoleAssignmentRules::getCountRules() === 0) {
            return '';
        }
        $rules_table = new ilShibbolethRoleAssignmentTableGUI($this, 'roleAssignment');
        $rules_table->setTitle($this->lng->txt('shib_rules_tables'));
        $rules_table->parse(ilShibbolethRoleAssignmentRules::getAllRules());
        $rules_table->addMultiCommand("confirmDeleteRules", $this->lng->txt("delete"));
        $rules_table->setSelectAllCheckbox(self::PARAM_RULE_ID);
 
        return $rules_table->getHTML();
    }

References ilShibbolethRoleAssignmentRules\getCountRules(), and ILIAS\Repository\lng().

Referenced by addRoleAssignmentRule(), and roleAssignment().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ prepareRoleSelect()

ilAuthShibbolethSettingsGUI::prepareRoleSelect ( )

private

Returns: array<int|string, string>

Definition at line 468 of file class.ilAuthShibbolethSettingsGUI.php.

                                        : array
    {
        $global_roles = ilUtil::_sortIds($this->rbac_review->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($role_id);
        }
 
        return $select;
    }

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

Referenced by initFormRoleAssignment().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ roleAssignment()

ilAuthShibbolethSettingsGUI::roleAssignment ( )

protected

Exceptions

ilCtrlException

Definition at line 130 of file class.ilAuthShibbolethSettingsGUI.php.

                                       : bool
    {
        $this->tabs_gui->activateSubTab('shib_role_assignment');
        $this->initFormRoleAssignment();
        $this->tpl->addBlockFile(
            'ADM_CONTENT',
            'adm_content',
            'tpl.shib_role_assignment.html',
            'components/ILIAS/AuthShibboleth'
        );
        $this->tpl->setVariable('NEW_RULE_TABLE', $this->form->getHTML());
        if (($html = $this->parseRulesTable()) !== '') {
            $this->tpl->setVariable('RULE_TABLE', $html);
        }
 
        return true;
    }

References ILIAS\Repository\form(), initFormRoleAssignment(), and parseRulesTable().

Referenced by addRoleAssignmentRule(), confirmDeleteRules(), deleteRules(), and updateRoleAssignmentRule().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ save()

ilAuthShibbolethSettingsGUI::save ( )

Exceptions

ilCtrlException

Definition at line 113 of file class.ilAuthShibbolethSettingsGUI.php.

                          : void
    {
        $form = new ilShibbolethSettingsForm(
            $this->shib_settings,
            $this->ctrl->getLinkTarget($this, 'save')
        );
        $form->setValuesByPost();
        if ($form->saveObject()) {
            $this->tpl->setOnScreenMessage('success', $this->lng->txt("shib_settings_saved"), true);
            $this->ctrl->redirect($this, 'settings');
        }
        $this->tpl->setContent($form->getHTML());
    }

References $form, ILIAS\Repository\ctrl(), ilPropertyFormGUI\getHTML(), ILIAS\Repository\lng(), and ilPropertyFormGUI\setValuesByPost().

Here is the call graph for this function:

◆ setSubTabs()

ilAuthShibbolethSettingsGUI::setSubTabs ( )

protected

Exceptions

ilCtrlException

Definition at line 482 of file class.ilAuthShibbolethSettingsGUI.php.

                                   : bool
    {
        if (!$this->global_settings->get('shib_active', '0')) {
            return false;
        }
        $this->tabs_gui->addSubTabTarget('shib_settings', $this->ctrl->getLinkTarget($this, 'settings'));
        $this->tabs_gui->addSubTabTarget('shib_role_assignment', $this->ctrl->getLinkTarget($this, 'roleAssignment'));
 
        return true;
    }

References ILIAS\Repository\ctrl().

Referenced by executeCommand().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settings()

ilAuthShibbolethSettingsGUI::settings ( )

Exceptions

ilCtrlException

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

                              : void
    {
        $this->tabs_gui->activateSubTab('shib_settings');
        $form = new ilShibbolethSettingsForm(
            $this->shib_settings,
            $this->ctrl->getLinkTarget($this, 'save')
        );
 
        $this->tpl->setContent($form->getHTML());
    }

References $form, ILIAS\Repository\ctrl(), and ilPropertyFormGUI\getHTML().

Here is the call graph for this function:

◆ updateRoleAssignmentRule()

ilAuthShibbolethSettingsGUI::updateRoleAssignmentRule ( )

protected

Exceptions

ilCtrlException

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

                                                 : bool
    {
        if (!$this->access->checkAccess('write', '', $this->ref_id)) {
            $this->tpl->setOnScreenMessage('failure', $this->lng->txt('permission_denied'), true);
            $this->roleAssignment();
 
            return false;
        }
        $this->initFormRoleAssignment();
        $err = false;
        $role_id = $this->wrapper->query()->retrieve(self::PARAM_RULE_ID, $this->refinery->kindlyTo()->int());
 
        if (!$this->form->checkInput() || $err = $this->checkInput($role_id)) {
            if ($err) {
                $this->tpl->setOnScreenMessage('failure', $this->lng->txt($err));
            }
            $this->tabs_gui->activateSubTab('shib_role_assignment');
            $this->form->setValuesByPost();
            $this->tpl->addBlockFile(
                'ADM_CONTENT',
                'adm_content',
                'tpl.shib_role_assignment.html',
                'components/ILIAS/AuthShibboleth'
            );
            $this->tpl->setVariable('NEW_RULE_TABLE', $this->form->getHTML());
 
            return true;
        }
        $this->rule->update();
        $this->tpl->setOnScreenMessage('success', $this->lng->txt('settings_saved'));
        $this->roleAssignment();
 
        return true;
    }