ilSamlSettingsGUI Class Reference

Class ilSamlSettingsGUI. More...

Collaboration diagram for ilSamlSettingsGUI:

Public Member Functions
	__construct (private readonly int $ref_id)
	getRefId ()
	executeCommand ()

Data Fields
const	DEFAULT_CMD = 'listIdps'

Private Member Functions
	ensureAccess (string $operation)
	ensureWriteAccess ()
	ensureReadAccess ()
	getIdpIdOrZero ()
	initIdp ()
	listIdps ()
	deactivateIdp ()
	activateIdp ()
	setSubTabs (int $a_view_mode)
	initUserAttributeMapping ()
	getUserAttributeMappingForm ()
	addAttributeRuleFieldToForm (ilPropertyFormGUI $form, string $field_label, string $field_name)
	saveUserAttributeMapping ()
	showUserAttributeMappingForm (ilPropertyFormGUI $form=null)
	getSettingsForm ()
	prepareRoleSelection ()
	saveSettings ()
	showSettings (ilPropertyFormGUI $form=null)
	getIdpSettingsForm ()
	showIdpSettings (ilPropertyFormGUI $form=null)
	saveIdpSettings ()
	getIdpForm ()
	saveNewIdp ()
	showNewIdpForm (ilPropertyFormGUI $form=null)
	addMetadataElement (ilPropertyFormGUI $form)
	populateWithMetadata (ilSamlIdp $idp, array &$data)
	storeMetadata (ilSamlIdp $idp, string $metadata)
	confirmDeleteIdp ()
	deleteIdp ()

Private Attributes
const	VIEW_MODE_GLOBAL = 1
const	VIEW_MODE_SINGLE = 2
const	PERMISSION_WRITE = 'write'
const	REQUEST_PARAM_SAML_IDP_ID = 'saml_idp_id'
const	MESSAGE_TYPE_FAILURE = 'failure'
const	MESSAGE_TYPE_SUCCESS = 'success'
const	LNG_SAVED_SUCCESSFULLY = 'saved_successfully'
const	LNG_AUTH_SAML_USER_MAPPING = 'auth_saml_user_mapping'
const	LNG_LOGIN_FORM = 'login_form'
const	LNG_CANCEL = 'cancel'
const	CMD_SAVE_NEW_IDP = 'saveNewIdp'
const	CMD_SAVE_SETTINGS = 'saveSettings'
const	CMD_SHOW_IDP_SETTINGS = 'showIdpSettings'
const	CMT_SAVE_IDP_SETTINGS = 'saveIdpSettings'
const	CMD_SAVE = 'save'
const	CMD_SAVE_USER_ATTRIBUTE_MAPPING = 'saveUserAttributeMapping'
const	PROP_UPDATE_SUFFIX = '_update'
const	METADATA_STORAGE_KEY = 'metadata'
const	GLOBAL_COMMANDS
const	GLOBAL_ENTITY_COMMANDS
const	IGNORED_USER_FIELDS
readonly ilCtrlInterface	$ctrl
readonly ilLanguage	$lng
readonly ilGlobalTemplateInterface	$tpl
readonly ilAccessHandler	$access
readonly RBACServices	$rbac
readonly ilErrorHandling	$error_handler
readonly ilTabsGUI	$tabs
readonly ilToolbarGUI	$toolbar
readonly GlobalHttpState	$httpState
readonly Refinery	$refinery
readonly ilHelpGUI	$help
ilExternalAuthUserAttributeMapping	$mapping = null
ilSamlIdp	$idp = null
ilSamlAuth	$samlAuth = null
readonly ILIAS UI Factory	$ui_factory
readonly ILIAS UI Renderer	$ui_renderer

Detailed Description

Class ilSamlSettingsGUI.

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

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

Constructor & Destructor Documentation

__construct()

ilSamlSettingsGUI::__construct

(

private readonly int

$ref_id

)

Definition at line 122 of file class.ilSamlSettingsGUI.php.

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

    {
        global $DIC;

        $this->ctrl = $DIC->ctrl();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->lng = $DIC->language();
        $this->access = $DIC->access();
        $this->rbac = $DIC->rbac();
        $this->error_handler = $DIC['ilErr'];
        $this->tabs = $DIC->tabs();
        $this->toolbar = $DIC['ilToolbar'];
        $this->help = $DIC['ilHelp'];
        $this->httpState = $DIC->http();
        $this->refinery = $DIC->refinery();
        $this->ui_factory = $DIC->ui()->factory();
        $this->ui_renderer = $DIC->ui()->renderer();

        $this->lng->loadLanguageModule('auth');
    }

Here is the call graph for this function:

Member Function Documentation

activateIdp()

ilSamlSettingsGUI::activateIdp ( )

private

Definition at line 267 of file class.ilSamlSettingsGUI.php.

References ensureWriteAccess(), listIdps(), and ILIAS\Repository\lng().

                                  : void
    {
        $this->ensureWriteAccess();

        $this->idp->setActive(true);
        $this->idp->persist();

        $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY));
        $this->listIdps();
    }

Here is the call graph for this function:

addAttributeRuleFieldToForm()

ilSamlSettingsGUI::addAttributeRuleFieldToForm ( ilPropertyFormGUI  $form, string  $field_label, string  $field_name  )

private

Definition at line 356 of file class.ilSamlSettingsGUI.php.

References ilPropertyFormGUI\addItem(), and ILIAS\Repository\lng().

Referenced by getUserAttributeMappingForm().

     : void {
        $field = new ilTextInputGUI($field_label, $field_name);
        $form->addItem($field);

        $update_automatically = new ilCheckboxInputGUI('', $field_name . self::PROP_UPDATE_SUFFIX);
        $update_automatically->setOptionTitle($this->lng->txt('auth_saml_update_field_info'));
        $update_automatically->setValue('1');
        $form->addItem($update_automatically);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addMetadataElement()

ilSamlSettingsGUI::addMetadataElement ( ilPropertyFormGUI  $form )

private

Definition at line 633 of file class.ilSamlSettingsGUI.php.

References ilPropertyFormGUI\addItem(), ILIAS\Repository\lng(), and ilFormPropertyGUI\setInfo().

Referenced by getIdpForm(), and getIdpSettingsForm().

                                                                : void
    {
        $metadata = new ilSamlIdpMetadataInputGUI(
            $this->lng->txt('auth_saml_add_idp_md_label'),
            self::METADATA_STORAGE_KEY,
            new ilSamlIdpXmlMetadataParser(
                new Factory(),
                new ilSamlIdpXmlMetadataErrorFormatter()
            )
        );
        $metadata->setInfo($this->lng->txt('auth_saml_add_idp_md_info'));
        $metadata->setRows(20);
        $metadata->setRequired(true);

        $purifier = new ilHtmlPurifierComposite();
        $purifier->addPurifier(new ilSamlIdpMetadataPurifier());

        $metadata->setPurifier($purifier);
        $metadata->usePurifier(true);
        $form->addItem($metadata);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

confirmDeleteIdp()

ilSamlSettingsGUI::confirmDeleteIdp ( )

private

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

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

                                       : void
    {
        $this->ensureWriteAccess();

        $confirmation = new ilConfirmationGUI();
        $confirmation->setFormAction($this->ctrl->getFormAction($this, 'deleteIdp'));
        $confirmation->setConfirm($this->lng->txt('confirm'), 'deleteIdp');
        $confirmation->setCancel($this->lng->txt(self::LNG_CANCEL), self::DEFAULT_CMD);
        $confirmation->setHeaderText($this->lng->txt('auth_saml_sure_delete_idp'));
        $confirmation->addItem('saml_idp_ids', (string) $this->idp->getIdpId(), $this->idp->getEntityId());

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

Here is the call graph for this function:

deactivateIdp()

ilSamlSettingsGUI::deactivateIdp ( )

private

Definition at line 256 of file class.ilSamlSettingsGUI.php.

References ensureWriteAccess(), listIdps(), and ILIAS\Repository\lng().

                                    : void
    {
        $this->ensureWriteAccess();

        $this->idp->setActive(false);
        $this->idp->persist();

        $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY));
        $this->listIdps();
    }

Here is the call graph for this function:

deleteIdp()

ilSamlSettingsGUI::deleteIdp ( )

private

Definition at line 682 of file class.ilSamlSettingsGUI.php.

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

                                : void
    {
        $this->ensureWriteAccess();

        $idpDisco = $this->samlAuth->getIdpDiscovery();
        $idpDisco->deleteIdpMetadata($this->idp->getIdpId());

        $this->idp->delete();

        $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt('auth_saml_deleted_idp'), true);

        $this->ctrl->setParameter($this, self::REQUEST_PARAM_SAML_IDP_ID, null);
        $this->ctrl->redirect($this, self::DEFAULT_CMD);
    }

Here is the call graph for this function:

ensureAccess()

ilSamlSettingsGUI::ensureAccess ( string  $operation )

private

Definition at line 143 of file class.ilSamlSettingsGUI.php.

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

Referenced by ensureReadAccess(), and ensureWriteAccess().

                                                    : void
    {
        if (!$this->rbac->system()->checkAccess($operation, $this->ref_id)) {
            $this->error_handler->raiseError($this->lng->txt('msg_no_perm_read'), $this->error_handler->WARNING);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ensureReadAccess()

ilSamlSettingsGUI::ensureReadAccess ( )

private

Definition at line 155 of file class.ilSamlSettingsGUI.php.

References ensureAccess().

Referenced by executeCommand().

                                       : void
    {
        $this->ensureAccess('read');
    }

Here is the call graph for this function:

Here is the caller graph for this function:

ensureWriteAccess()

ilSamlSettingsGUI::ensureWriteAccess ( )

private

Definition at line 150 of file class.ilSamlSettingsGUI.php.

References ensureAccess().

Referenced by activateIdp(), confirmDeleteIdp(), deactivateIdp(), deleteIdp(), saveIdpSettings(), saveNewIdp(), saveSettings(), saveUserAttributeMapping(), and showNewIdpForm().

                                        : void
    {
        $this->ensureAccess(self::PERMISSION_WRITE);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

executeCommand()

ilSamlSettingsGUI::executeCommand

(

)

Definition at line 194 of file class.ilSamlSettingsGUI.php.

References Vendor\Package\$e, ILIAS\Repository\ctrl(), ensureReadAccess(), getIdpIdOrZero(), ILIAS\Repository\help(), initIdp(), initUserAttributeMapping(), ILIAS\Repository\lng(), and setSubTabs().

                                    : void
    {
        $this->ensureReadAccess();

        try {
            $factory = new ilSamlAuthFactory();
            $this->samlAuth = $factory->auth();
        } catch (Throwable $e) {
            if ('Database error: could not find driver' === $e->getMessage()) {
                $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_FAILURE, $this->lng->txt('auth_saml_err_sqlite_driver'));
            } else {
                $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_FAILURE, $e->getMessage());
            }
        }

        $this->help->setScreenIdComponent('auth');
        $cmd = $this->ctrl->getCmd();
        if ($cmd === null || $cmd === '' || !method_exists($this, $cmd)) {
            $cmd = self::DEFAULT_CMD;
        }
        $ipdId = $this->getIdpIdOrZero();
        if ($ipdId > 0) {
            $this->ctrl->saveParameter($this, self::REQUEST_PARAM_SAML_IDP_ID);
        }
        if (!in_array(strtolower($cmd), array_map('strtolower', self::GLOBAL_COMMANDS), true)) {
            if (0 === $ipdId) {
                $this->ctrl->redirect($this, self::DEFAULT_CMD);
            }

            $this->initIdp();
            $this->initUserAttributeMapping();
        }
        if (
            in_array(strtolower($cmd), array_map('strtolower', self::GLOBAL_COMMANDS), true) ||
            in_array(strtolower($cmd), array_map('strtolower', self::GLOBAL_ENTITY_COMMANDS), true)
        ) {
            $this->setSubTabs(self::VIEW_MODE_GLOBAL);
        } else {
            $this->setSubTabs(self::VIEW_MODE_SINGLE);
        }
        $this->$cmd();
    }

Here is the call graph for this function:

getIdpForm()

ilSamlSettingsGUI::getIdpForm ( )

private

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

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

Referenced by saveNewIdp(), and showNewIdpForm().

                                 : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, self::CMD_SAVE_NEW_IDP));
        $form->setTitle($this->lng->txt('auth_saml_add_idp_btn'));

        $this->addMetadataElement($form);

        $form->addCommandButton(self::CMD_SAVE_NEW_IDP, $this->lng->txt(self::CMD_SAVE));
        $form->addCommandButton('listIdps', $this->lng->txt(self::LNG_CANCEL));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIdpIdOrZero()

ilSamlSettingsGUI::getIdpIdOrZero ( )

private

Definition at line 165 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\int(), and ILIAS\Repository\refinery().

Referenced by executeCommand(), and initIdp().

                                     : int
    {
        $idpId = 0;
        if ($this->httpState->wrapper()->query()->has(self::REQUEST_PARAM_SAML_IDP_ID)) {
            $idpId = (int) $this->httpState->wrapper()->query()->retrieve(
                self::REQUEST_PARAM_SAML_IDP_ID,
                $this->refinery->kindlyTo()->int()
            );
        } elseif ($this->httpState->wrapper()->post()->has(self::REQUEST_PARAM_SAML_IDP_ID)) {
            $idpId = (int) $this->httpState->wrapper()->post()->retrieve(
                self::REQUEST_PARAM_SAML_IDP_ID,
                $this->refinery->kindlyTo()->int()
            );
        }

        return $idpId;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getIdpSettingsForm()

ilSamlSettingsGUI::getIdpSettingsForm ( )

private

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

References ILIAS\Repository\access(), addMetadataElement(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), prepareRoleSelection(), and ilSelectInputGUI\setOptions().

Referenced by saveIdpSettings(), and showIdpSettings().

                                         : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, self::CMT_SAVE_IDP_SETTINGS));
        $form->setTitle(sprintf($this->lng->txt('auth_saml_configure_idp'), $this->idp->getEntityId()));

        $idp = new ilTextInputGUI($this->lng->txt('auth_saml_idp'), 'entity_id');
        $idp->setDisabled(true);
        $form->addItem($idp);

        $this->addMetadataElement($form);

        $local = new ilCheckboxInputGUI($this->lng->txt('auth_allow_local'), 'allow_local_auth');
        $local->setValue('1');
        $local->setInfo($this->lng->txt('auth_allow_local_info'));
        $form->addItem($local);

        $uid_claim = new ilTextInputGUI($this->lng->txt('auth_saml_uid_claim'), 'uid_claim');
        $uid_claim->setInfo($this->lng->txt('auth_saml_uid_claim_info'));
        $uid_claim->setRequired(true);
        $form->addItem($uid_claim);

        $sync = new ilCheckboxInputGUI($this->lng->txt('auth_saml_sync'), 'sync_status');
        $sync->setInfo($this->lng->txt('auth_saml_sync_info'));
        $sync->setValue('1');

        $username_claim = new ilTextInputGUI($this->lng->txt('auth_saml_username_claim'), 'login_claim');
        $username_claim->setInfo($this->lng->txt('auth_saml_username_claim_info'));
        $username_claim->setRequired(true);
        $sync->addSubItem($username_claim);

        $role = new ilSelectInputGUI($this->lng->txt('auth_saml_role_select'), 'default_role_id');
        $role->setOptions($this->prepareRoleSelection());
        $role->setRequired(true);
        $sync->addSubItem($role);

        $migr = new ilCheckboxInputGUI($this->lng->txt('auth_saml_migration'), 'account_migr_status');
        $migr->setInfo($this->lng->txt('auth_saml_migration_info'));
        $migr->setValue('1');
        $sync->addSubItem($migr);
        $form->addItem($sync);

        if (!$this->access->checkAccess(self::PERMISSION_WRITE, '', $this->ref_id)) {
            foreach ($form->getItems() as $item) {
                $item->setDisabled(true);
            }
        } else {
            $form->addCommandButton(self::CMT_SAVE_IDP_SETTINGS, $this->lng->txt(self::CMD_SAVE));
        }
        $form->addCommandButton(self::DEFAULT_CMD, $this->lng->txt(self::LNG_CANCEL));

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefId()

ilSamlSettingsGUI::getRefId

(

)

Definition at line 160 of file class.ilSamlSettingsGUI.php.

References $ref_id.

                              : int
    {
        return $this->ref_id;
    }

getSettingsForm()

ilSamlSettingsGUI::getSettingsForm ( )

private

Definition at line 426 of file class.ilSamlSettingsGUI.php.

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

Referenced by saveSettings(), and showSettings().

                                      : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, self::CMD_SAVE_SETTINGS));
        $form->setTitle($this->lng->txt('auth_saml_configure'));

        $show_login_form = new ilCheckboxInputGUI($this->lng->txt('auth_saml_login_form'), self::LNG_LOGIN_FORM);
        $show_login_form->setInfo($this->lng->txt('auth_saml_login_form_info'));
        $show_login_form->setValue('1');
        $form->addItem($show_login_form);

        if (!$this->access->checkAccess(self::PERMISSION_WRITE, '', $this->ref_id)) {
            foreach ($form->getItems() as $item) {
                $item->setDisabled(true);
            }
        } else {
            $form->addCommandButton(self::CMD_SAVE_SETTINGS, $this->lng->txt(self::CMD_SAVE));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getUserAttributeMappingForm()

ilSamlSettingsGUI::getUserAttributeMappingForm ( )

private

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

References $id, ilUserDefinedFields\_getInstance(), ILIAS\Repository\access(), addAttributeRuleFieldToForm(), ILIAS\Repository\ctrl(), and ILIAS\Repository\lng().

Referenced by saveUserAttributeMapping(), and showUserAttributeMappingForm().

                                                  : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setFormAction($this->ctrl->getFormAction($this, self::CMD_SAVE_USER_ATTRIBUTE_MAPPING));
        $form->setTitle($this->lng->txt(self::LNG_AUTH_SAML_USER_MAPPING));

        $usr_profile = new ilUserProfile();
        foreach (array_keys($usr_profile->getStandardFields()) as $id) {
            if (in_array($id, self::IGNORED_USER_FIELDS, true)) {
                continue;
            }

            $this->addAttributeRuleFieldToForm($form, $this->lng->txt($id), $id);
        }

        foreach (ilUserDefinedFields::_getInstance()->getDefinitions() as $definition) {
            $this->addAttributeRuleFieldToForm($form, $definition['field_name'], 'udf_' . $definition['field_id']);
        }

        if (!$this->access->checkAccess(self::PERMISSION_WRITE, '', $this->ref_id)) {
            foreach ($form->getItems() as $item) {
                $item->setDisabled(true);
            }
        } else {
            $form->addCommandButton(self::CMD_SAVE_USER_ATTRIBUTE_MAPPING, $this->lng->txt(self::CMD_SAVE));
        }

        return $form;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initIdp()

ilSamlSettingsGUI::initIdp ( )

private

Definition at line 183 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), getIdpIdOrZero(), ilSamlIdp\getInstanceByIdpId(), and ILIAS\Repository\lng().

Referenced by executeCommand().

                              : void
    {
        try {
            $this->idp = ilSamlIdp::getInstanceByIdpId($this->getIdpIdOrZero());
        } catch (Exception) {
            $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_FAILURE, $this->lng->txt('auth_saml_unknow_idp'), true);
            $this->ctrl->setParameter($this, self::REQUEST_PARAM_SAML_IDP_ID, null);
            $this->ctrl->redirect($this, self::DEFAULT_CMD);
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

initUserAttributeMapping()

ilSamlSettingsGUI::initUserAttributeMapping ( )

private

Definition at line 321 of file class.ilSamlSettingsGUI.php.

Referenced by executeCommand().

                                               : void
    {
        $this->mapping = new ilExternalAuthUserAttributeMapping('saml', $this->idp->getIdpId());
    }

Here is the caller graph for this function:

listIdps()

ilSamlSettingsGUI::listIdps ( )

private

Definition at line 237 of file class.ilSamlSettingsGUI.php.

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

Referenced by activateIdp(), and deactivateIdp().

                               : void
    {
        if ($this->samlAuth && $this->rbac->system()->checkAccess(self::PERMISSION_WRITE, $this->ref_id)) {
            $this->toolbar->addStickyItem($this->ui_factory->button()->standard(
                $this->lng->txt('auth_saml_add_idp_btn'),
                $this->ctrl->getLinkTarget($this, 'showNewIdpForm')
            ));
        }

        $table = new ilSamlIdpTableGUI(
            $this,
            $this->ui_factory,
            $this->ui_renderer,
            self::DEFAULT_CMD,
            $this->rbac->system()->checkAccess(self::PERMISSION_WRITE, $this->ref_id)
        );
        $this->tpl->setContent($table->getHTML());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

populateWithMetadata()

ilSamlSettingsGUI::populateWithMetadata ( ilSamlIdp  $idp, array &  $data  )

private

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

References ilSamlIdp\getIdpId().

Referenced by showIdpSettings().

                                                                       : void
    {
        $idpDisco = $this->samlAuth->getIdpDiscovery();

        $data[self::METADATA_STORAGE_KEY] = $idpDisco->fetchIdpMetadata($idp->getIdpId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

prepareRoleSelection()

ilSamlSettingsGUI::prepareRoleSelection ( )

private

Returns

array<int, string>

Definition at line 451 of file class.ilSamlSettingsGUI.php.

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

Referenced by getIdpSettingsForm().

                                           : array
    {
        $select = [];
        $global_roles = array_map('intval', 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;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

saveIdpSettings()

ilSamlSettingsGUI::saveIdpSettings ( )

private

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

References ensureWriteAccess(), getIdpSettingsForm(), ILIAS\Repository\lng(), showIdpSettings(), and storeMetadata().

                                      : void
    {
        $this->ensureWriteAccess();

        $form = $this->getIdpSettingsForm();
        if ($form->checkInput()) {
            $this->idp->bindForm($form);
            $this->idp->persist();
            $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY));

            $this->storeMetadata($this->idp, $form->getInput(self::METADATA_STORAGE_KEY));
        }

        $this->showIdpSettings($form);
    }

Here is the call graph for this function:

saveNewIdp()

ilSamlSettingsGUI::saveNewIdp ( )

private

Definition at line 598 of file class.ilSamlSettingsGUI.php.

References ILIAS\Repository\ctrl(), ensureWriteAccess(), getIdpForm(), ilSamlIdp\getIdpId(), ILIAS\Repository\lng(), ilSamlIdp\persist(), showNewIdpForm(), and storeMetadata().

                                 : void
    {
        $this->ensureWriteAccess();

        $form = $this->getIdpForm();
        if ($form->checkInput()) {
            $idp = new ilSamlIdp();
            $idp->bindForm($form);
            $idp->persist();

            $this->storeMetadata($idp, $form->getInput(self::METADATA_STORAGE_KEY));

            $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY), true);
            $this->ctrl->setParameter($this, self::REQUEST_PARAM_SAML_IDP_ID, $idp->getIdpId());
            $this->ctrl->redirect($this, self::CMD_SHOW_IDP_SETTINGS);
        }

        $this->showNewIdpForm($form);
    }

Here is the call graph for this function:

saveSettings()

ilSamlSettingsGUI::saveSettings ( )

private

Definition at line 469 of file class.ilSamlSettingsGUI.php.

References ensureWriteAccess(), ilSamlSettings\getInstance(), getSettingsForm(), ILIAS\Repository\lng(), and showSettings().

                                   : void
    {
        $this->ensureWriteAccess();

        $form = $this->getSettingsForm();
        if ($form->checkInput()) {
            ilSamlSettings::getInstance()->setLoginFormStatus((bool) $form->getInput(self::LNG_LOGIN_FORM));
            $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY));
        }

        $form->setValuesByPost();

        $this->showSettings($form);
    }

Here is the call graph for this function:

saveUserAttributeMapping()

ilSamlSettingsGUI::saveUserAttributeMapping ( )

private

Definition at line 370 of file class.ilSamlSettingsGUI.php.

References $id, ilUserDefinedFields\_getInstance(), ensureWriteAccess(), getUserAttributeMappingForm(), ILIAS\Repository\lng(), and showUserAttributeMappingForm().

                                               : void
    {
        $this->ensureWriteAccess();

        $form = $this->getUserAttributeMappingForm();
        if ($form->checkInput()) {
            $this->mapping->delete();

            $usr_profile = new ilUserProfile();
            foreach (array_keys($usr_profile->getStandardFields()) as $id) {
                if (in_array($id, self::IGNORED_USER_FIELDS, true)) {
                    continue;
                }

                $rule = $this->mapping->getEmptyRule();
                $rule->setAttribute($id);
                $rule->setExternalAttribute((string) $form->getInput($rule->getAttribute()));
                $rule->updateAutomatically((bool) $form->getInput($rule->getAttribute() . self::PROP_UPDATE_SUFFIX));
                $this->mapping[$rule->getAttribute()] = $rule;
            }

            foreach (ilUserDefinedFields::_getInstance()->getDefinitions() as $definition) {
                $rule = $this->mapping->getEmptyRule();
                $rule->setAttribute('udf_' . $definition['field_id']);
                $rule->setExternalAttribute((string) $form->getInput($rule->getAttribute()));
                $rule->updateAutomatically((bool) $form->getInput($rule->getAttribute() . self::PROP_UPDATE_SUFFIX));
                $this->mapping[$rule->getAttribute()] = $rule;
            }

            $this->mapping->save();

            $this->tpl->setOnScreenMessage(self::MESSAGE_TYPE_SUCCESS, $this->lng->txt(self::LNG_SAVED_SUCCESSFULLY));
        }

        $form->setValuesByPost();

        $this->showUserAttributeMappingForm($form);
    }

Here is the call graph for this function:

setSubTabs()

ilSamlSettingsGUI::setSubTabs ( int  $a_view_mode )

private

Definition at line 278 of file class.ilSamlSettingsGUI.php.

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

Referenced by executeCommand().

                                                 : void
    {
        switch ($a_view_mode) {
            case self::VIEW_MODE_GLOBAL:
                $this->tabs->addSubTabTarget(
                    'auth_saml_idps',
                    $this->ctrl->getLinkTarget($this, self::DEFAULT_CMD),
                    array_merge(self::GLOBAL_ENTITY_COMMANDS, [self::DEFAULT_CMD, 'showNewIdpForm', self::CMD_SAVE_NEW_IDP]),
                    self::class
                );

                $this->tabs->addSubTabTarget(
                    'settings',
                    $this->ctrl->getLinkTarget($this, 'showSettings'),
                    ['showSettings', self::CMD_SAVE_SETTINGS],
                    self::class
                );
                break;

            case self::VIEW_MODE_SINGLE:
                $this->tabs->clearTargets();
                $this->tabs->setBackTarget(
                    $this->lng->txt('back'),
                    $this->ctrl->getLinkTarget($this, self::DEFAULT_CMD)
                );

                $this->tabs->addSubTabTarget(
                    'auth_saml_idp_settings',
                    $this->ctrl->getLinkTarget($this, self::CMD_SHOW_IDP_SETTINGS),
                    [self::CMD_SHOW_IDP_SETTINGS, self::CMT_SAVE_IDP_SETTINGS],
                    self::class
                );

                $this->tabs->addSubTabTarget(
                    self::LNG_AUTH_SAML_USER_MAPPING,
                    $this->ctrl->getLinkTarget($this, 'showUserAttributeMappingForm'),
                    ['showUserAttributeMappingForm', self::CMD_SAVE_USER_ATTRIBUTE_MAPPING],
                    self::class
                );
                break;
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

showIdpSettings()

ilSamlSettingsGUI::showIdpSettings ( ilPropertyFormGUI  $form = null )

private

Definition at line 550 of file class.ilSamlSettingsGUI.php.

References $data, getIdpSettingsForm(), ILIAS\Repository\help(), populateWithMetadata(), and ILIAS\Repository\tabs().

Referenced by saveIdpSettings().

                                                                    : void
    {
        $this->tabs->setSubTabActive('auth_saml_idp_settings');

        if (null === $form) {
            $form = $this->getIdpSettingsForm();
            $data = $this->idp->toArray();
            $this->populateWithMetadata($this->idp, $data);
            $form->setValuesByArray($data);
        } else {
            $form->setValuesByPost();
        }

        $this->help->setSubScreenId('edit_idp');

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

Here is the call graph for this function:

Here is the caller graph for this function:

showNewIdpForm()

ilSamlSettingsGUI::showNewIdpForm ( ilPropertyFormGUI  $form = null )

private

Definition at line 618 of file class.ilSamlSettingsGUI.php.

References ensureWriteAccess(), getIdpForm(), and ILIAS\Repository\help().

Referenced by saveNewIdp().

                                                                   : void
    {
        $this->ensureWriteAccess();

        if (null === $form) {
            $form = $this->getIdpForm();
        } else {
            $form->setValuesByPost();
        }

        $this->help->setSubScreenId('create_idp');

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

Here is the call graph for this function:

Here is the caller graph for this function:

showSettings()

ilSamlSettingsGUI::showSettings ( ilPropertyFormGUI  $form = null )

private

Definition at line 484 of file class.ilSamlSettingsGUI.php.

References ilSamlSettings\getInstance(), and getSettingsForm().

Referenced by saveSettings().

                                                                 : void
    {
        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getSettingsForm();
            $form->setValuesByArray([
                self::LNG_LOGIN_FORM => ilSamlSettings::getInstance()->isDisplayedOnLoginPage(),
            ]);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

showUserAttributeMappingForm()

ilSamlSettingsGUI::showUserAttributeMappingForm ( ilPropertyFormGUI  $form = null )

private

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

References $data, getUserAttributeMappingForm(), and ILIAS\Repository\tabs().

Referenced by saveUserAttributeMapping().

                                                                                 : void
    {
        $this->tabs->setSubTabActive(self::LNG_AUTH_SAML_USER_MAPPING);

        if (!($form instanceof ilPropertyFormGUI)) {
            $form = $this->getUserAttributeMappingForm();
            $data = [];
            foreach ($this->mapping as $rule) {
                $data[$rule->getAttribute()] = $rule->getExternalAttribute();
                $data[$rule->getAttribute() . self::PROP_UPDATE_SUFFIX] = $rule->isAutomaticallyUpdated();
            }
            $form->setValuesByArray($data);
        }

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

Here is the call graph for this function:

Here is the caller graph for this function:

storeMetadata()

ilSamlSettingsGUI::storeMetadata ( ilSamlIdp  $idp, string  $metadata  )

private

Definition at line 662 of file class.ilSamlSettingsGUI.php.

References ilSamlIdp\getIdpId().

Referenced by saveIdpSettings(), and saveNewIdp().

                                                                    : void
    {
        $idpDisco = $this->samlAuth->getIdpDiscovery();
        $idpDisco->storeIdpMetadata($idp->getIdpId(), $metadata);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$access

readonly ilAccessHandler ilSamlSettingsGUI::$access

private

Definition at line 108 of file class.ilSamlSettingsGUI.php.

$ctrl

readonly ilCtrlInterface ilSamlSettingsGUI::$ctrl

private

Definition at line 105 of file class.ilSamlSettingsGUI.php.

$error_handler

readonly ilErrorHandling ilSamlSettingsGUI::$error_handler

private

Definition at line 110 of file class.ilSamlSettingsGUI.php.

$help

readonly ilHelpGUI ilSamlSettingsGUI::$help

private

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

$httpState

readonly GlobalHttpState ilSamlSettingsGUI::$httpState

private

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

$idp

ilSamlIdp ilSamlSettingsGUI::$idp = null

private

Definition at line 117 of file class.ilSamlSettingsGUI.php.

$lng

readonly ilLanguage ilSamlSettingsGUI::$lng

private

Definition at line 106 of file class.ilSamlSettingsGUI.php.

$mapping

ilExternalAuthUserAttributeMapping ilSamlSettingsGUI::$mapping = null

private

Definition at line 116 of file class.ilSamlSettingsGUI.php.

$rbac

readonly RBACServices ilSamlSettingsGUI::$rbac

private

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

$refinery

readonly Refinery ilSamlSettingsGUI::$refinery

private

Definition at line 114 of file class.ilSamlSettingsGUI.php.

$samlAuth

ilSamlAuth ilSamlSettingsGUI::$samlAuth = null

private

Definition at line 118 of file class.ilSamlSettingsGUI.php.

$tabs

readonly ilTabsGUI ilSamlSettingsGUI::$tabs

private

Definition at line 111 of file class.ilSamlSettingsGUI.php.

$toolbar

readonly ilToolbarGUI ilSamlSettingsGUI::$toolbar

private

Definition at line 112 of file class.ilSamlSettingsGUI.php.

$tpl

readonly ilGlobalTemplateInterface ilSamlSettingsGUI::$tpl

private

Definition at line 107 of file class.ilSamlSettingsGUI.php.

$ui_factory

readonly ILIAS UI Factory ilSamlSettingsGUI::$ui_factory

private

Definition at line 119 of file class.ilSamlSettingsGUI.php.

$ui_renderer

readonly ILIAS UI Renderer ilSamlSettingsGUI::$ui_renderer

private

Definition at line 120 of file class.ilSamlSettingsGUI.php.

CMD_SAVE

const ilSamlSettingsGUI::CMD_SAVE = 'save'

private

Definition at line 53 of file class.ilSamlSettingsGUI.php.

CMD_SAVE_NEW_IDP

const ilSamlSettingsGUI::CMD_SAVE_NEW_IDP = 'saveNewIdp'

private

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

CMD_SAVE_SETTINGS

const ilSamlSettingsGUI::CMD_SAVE_SETTINGS = 'saveSettings'

private

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

CMD_SAVE_USER_ATTRIBUTE_MAPPING

const ilSamlSettingsGUI::CMD_SAVE_USER_ATTRIBUTE_MAPPING = 'saveUserAttributeMapping'

private

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

CMD_SHOW_IDP_SETTINGS

const ilSamlSettingsGUI::CMD_SHOW_IDP_SETTINGS = 'showIdpSettings'

private

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

CMT_SAVE_IDP_SETTINGS

const ilSamlSettingsGUI::CMT_SAVE_IDP_SETTINGS = 'saveIdpSettings'

private

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

DEFAULT_CMD

const ilSamlSettingsGUI::DEFAULT_CMD = 'listIdps'

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

Referenced by ilObjAuthSettingsGUI\getTabs().

GLOBAL_COMMANDS

const ilSamlSettingsGUI::GLOBAL_COMMANDS

private

Initial value:

= [
        self::DEFAULT_CMD,
        'showAddIdpForm',
        'showSettings',
        'saveSettings',
        'showNewIdpForm',
        'saveNewIdp',
    ]

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

GLOBAL_ENTITY_COMMANDS

const ilSamlSettingsGUI::GLOBAL_ENTITY_COMMANDS

private

Initial value:

= [
        'deactivateIdp',
        'activateIdp',
        'confirmDeleteIdp',
        'deleteIdp',
    ]

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

IGNORED_USER_FIELDS

const ilSamlSettingsGUI::IGNORED_USER_FIELDS

private

Initial value:

= [
        'mail_incoming_mail',
        'preferences',
        'hide_own_online_status',
        'show_users_online',
        'hits_per_page',
        'roles',
        'upload',
        'password',
        'username',
        'language',
        'skin_style',
        'interests_general',
        'interests_help_offered',
        'interests_help_looking',
        'bs_allow_to_contact_me',
        'chat_osc_accept_msg',
        'chat_broadcast_typing',
    ]

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

LNG_AUTH_SAML_USER_MAPPING

const ilSamlSettingsGUI::LNG_AUTH_SAML_USER_MAPPING = 'auth_saml_user_mapping'

private

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

LNG_CANCEL

const ilSamlSettingsGUI::LNG_CANCEL = 'cancel'

private

Definition at line 47 of file class.ilSamlSettingsGUI.php.

LNG_LOGIN_FORM

const ilSamlSettingsGUI::LNG_LOGIN_FORM = 'login_form'

private

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

LNG_SAVED_SUCCESSFULLY

const ilSamlSettingsGUI::LNG_SAVED_SUCCESSFULLY = 'saved_successfully'

private

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

MESSAGE_TYPE_FAILURE

const ilSamlSettingsGUI::MESSAGE_TYPE_FAILURE = 'failure'

private

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

MESSAGE_TYPE_SUCCESS

const ilSamlSettingsGUI::MESSAGE_TYPE_SUCCESS = 'success'

private

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

METADATA_STORAGE_KEY

const ilSamlSettingsGUI::METADATA_STORAGE_KEY = 'metadata'

private

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

PERMISSION_WRITE

const ilSamlSettingsGUI::PERMISSION_WRITE = 'write'

private

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

PROP_UPDATE_SUFFIX

const ilSamlSettingsGUI::PROP_UPDATE_SUFFIX = '_update'

private

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

REQUEST_PARAM_SAML_IDP_ID

const ilSamlSettingsGUI::REQUEST_PARAM_SAML_IDP_ID = 'saml_idp_id'

private

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

VIEW_MODE_GLOBAL

const ilSamlSettingsGUI::VIEW_MODE_GLOBAL = 1

private

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

VIEW_MODE_SINGLE

const ilSamlSettingsGUI::VIEW_MODE_SINGLE = 2

private

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

---

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

• Services/Saml/classes/class.ilSamlSettingsGUI.php