Collaboration diagram for ilOpenIdConnectSettingsGUI:

Public Member Functions
	__construct (int $a_ref_id)

	executeCommand ()

Private Member Functions
	checkAccess (string $a_permission)

	checkAccessBool (string $a_permission)

	settings (?ilPropertyFormGUI $form=null)

	initSettingsForm ()

	saveSettings ()

	saveImageFromHttpRequest ()

	prepareRoleSelection (bool $a_with_select_option=true)

	profile ()

	scopes ()

	discoverScopesFromServer ()

	buildScopeSelection (array $ui_container)

	saveScopes ()

	validateDiscoveryUrl (int $type, ?string $url, array $scopes)

	saveProfileMapping ()

	updateProfileMappingFieldValue (string $field)

	roles (?ilPropertyFormGUI $form=null)

	initRolesForm ()

	saveRoles ()

	setSubTabs (string $active_tab)

	chooseMapping ()

	showInfoMessage ()

	initAttributeMapping ()

	buildUserMappingInputFormUDF ($definition, array $ui_container)

	buildUserMappingInputForUserData (string $lang, string $mapping, array $ui_container)

	initUserDefinedFields ()

	userMapping ()

	redirectToSettingsScreenIfNoURLIsConfigured ()

	saniziteArrayElementsTrafo ()

	trimIfStringTrafo ()

Private Attributes
const	STAB_SETTINGS = 'settings'

const	STAB_SCOPES = 'scopes'

const	STAB_PROFILE = 'profile'

const	STAB_ROLES = 'roles'

const	VALUE_STRING = '_value'

const	UPDATE_STRING = '_update'

const	UDF_STRING = 'udf_'

const	DEFAULT_CMD = 'settings'

const	DEFAULT_VALUES = 1

const	SAVED_VALUES = 2

const	POST_VALUE = 'Mode'

const	VIEW_TAB_PRE_FILED = 1

const	VIEW_TAB_EFFECTIVE_MAPPING = 2

const	URL_VALIDATION_PROVIDER_STRING = '/.well-known/openid-configuration'

const	EFFECTIVE_ATTRIBUTE_MAPPING_TAB = 2

int	$ref_id

	$body

readonly ilOpenIdConnectSettings	$settings

readonly ilLanguage	$lng

readonly ilCtrl	$ctrl

readonly ilLogger	$logger

readonly ilAccessHandler	$access

readonly ilRbacReview	$review

readonly ilErrorHandling	$error

readonly ilGlobalTemplateInterface	$mainTemplate

readonly ilTabsGUI	$tabs

readonly FileUpload	$upload

readonly Profile	$profile

ilToolbarGUI	$toolbar

array	$user_defined_fields = null

ilGlobalTemplateInterface	$tpl

int	$mapping_template = self::VIEW_TAB_EFFECTIVE_MAPPING

ServerRequestInterface	$request

ilOpenIdAttributeMappingTemplate	$attribute_mapping_template

Factory	$ui

Renderer	$renderer

Services	$http

Factory	$factory

ILIAS Refinery Factory	$refinery

string	$failed_validation_messages = ''

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilOpenIdConnectSettingsGUI::__construct ( int $a_ref_id )

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

    {
        global $DIC;
 
        $this->ref_id = $a_ref_id;
 
        $this->lng = $DIC->language();
        $this->lng->loadLanguageModule('auth');
 
        $this->mainTemplate = $DIC->ui()->mainTemplate();
        $this->tabs = $DIC->tabs();
        $this->ctrl = $DIC->ctrl();
        $this->logger = $DIC->logger()->auth();
        $this->access = $DIC->access();
        $this->review = $DIC->rbac()->review();
        $this->error = $DIC['ilErr'];
        $this->upload = $DIC->upload();
        $this->body = $DIC->http()->request()->getParsedBody();
        $this->settings = ilOpenIdConnectSettings::getInstance();
        $http_wrapper = $DIC->http()->wrapper();
        $this->toolbar = $DIC->toolbar();
        $refinery = $DIC->refinery();
        $this->tpl = $DIC->ui()->mainTemplate();
        $this->http = $DIC->http();
        $this->ui = $DIC->ui()->factory();
        $this->renderer = $DIC->ui()->renderer();
        $this->refinery = $DIC->refinery();
        $this->factory = $DIC->ui()->factory();
        $this->request = $DIC->http()->request();
        $this->profile = $DIC['user']->getProfile();
        $this->attribute_mapping_template = new ilOpenIdAttributeMappingTemplate();
 
        if ($http_wrapper->query()->has(self::POST_VALUE) && $http_wrapper->query()->retrieve(
            self::POST_VALUE,
            $refinery->kindlyTo()->int()
        )) {
            $this->mapping_template = $http_wrapper->query()->retrieve(self::POST_VALUE, $refinery->kindlyTo()->int());
        }
    }

References $DIC, $refinery, ILIAS\Repository\access(), ILIAS\Repository\ctrl(), error(), factory(), ilOpenIdConnectSettings\getInstance(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), mainTemplate(), profile(), ILIAS\Repository\refinery(), renderer(), settings(), ILIAS\Repository\tabs(), ILIAS\Repository\toolbar(), ILIAS\Repository\ui(), and ILIAS\Repository\upload().

Here is the call graph for this function:

Member Function Documentation

◆ buildScopeSelection()

ilOpenIdConnectSettingsGUI::buildScopeSelection ( array $ui_container )

private

Parameters

list<FormInput> $ui_container

Returns: list<FormInput>

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

                                                             : array
    {
        $disabled_input = $this->ui
            ->input()
            ->field()
            ->text($this->lng->txt('auth_oidc_settings_default_scopes'), '')
            ->withAdditionalTransformation($this->trimIfStringTrafo())
            ->withValue(ilOpenIdConnectSettings::DEFAULT_SCOPE)
            ->withDedicatedName('default_scope')
            ->withDisabled(true);
 
        $scopeValues = $this->settings->getAdditionalScopes();
 
        $tag_input = $this->ui
            ->input()
            ->field()
            ->tag(
                $this->lng->txt('auth_oidc_settings_additional_scopes'),
                $scopeValues
            )->withValue($scopeValues)
            ->withDedicatedName('custom_scope')
            ->withByline($this->lng->txt('auth_oidc_settings_additional_scopes_info'));
        $group1 = $this->ui->input()->field()->group(
            [],
            $this->lng->txt('auth_oidc_settings_validate_scope_default')
        );
        $group2 = $this->ui->input()->field()->group(
            [
                $this->lng->txt('auth_oidc_settings_discovery_url') => $this->ui
                    ->input()
                    ->field()
                    ->text(
                        $this->lng->txt('auth_oidc_settings_discovery_url')
                    )
                    ->withAdditionalTransformation($this->trimIfStringTrafo())
                    ->withValue(
                        $this->settings->getCustomDiscoveryUrl() ?? ''
                    )
            ],
            $this->lng->txt('auth_oidc_settings_validate_scope_custom')
        );
        $group3 = $this->ui->input()->field()->group(
            [],
            $this->lng->txt('auth_oidc_settings_validate_scope_none')
        );
        $url_validation = $this->ui->input()->field()->switchableGroup(
            [
                (string) ilOpenIdConnectSettings::URL_VALIDATION_PROVIDER => $group1,
                (string) ilOpenIdConnectSettings::URL_VALIDATION_CUSTOM => $group2,
                (string) ilOpenIdConnectSettings::URL_VALIDATION_NONE => $group3,
            ],
            $this->lng->txt('auth_oidc_settings_validate_scopes')
        )->withDedicatedName('validate_scopes')->withValue($this->settings->getValidateScopes());
        $group = $this->ui->input()->field()->group(
            [$disabled_input, $tag_input, $url_validation]
        );
        $ui_container[] = $group;
 
        return $ui_container;
    }

References ilOpenIdConnectSettings\DEFAULT_SCOPE, ILIAS\Repository\lng(), settings(), trimIfStringTrafo(), ILIAS\Repository\ui(), ilOpenIdConnectSettings\URL_VALIDATION_CUSTOM, ilOpenIdConnectSettings\URL_VALIDATION_NONE, and ilOpenIdConnectSettings\URL_VALIDATION_PROVIDER.

Here is the call graph for this function:

◆ buildUserMappingInputFormUDF()

ilOpenIdConnectSettingsGUI::buildUserMappingInputFormUDF	(		$definition,
		array	$ui_container
	)

private

Parameters

array{"field_id"	int, "field_name": string} $definition
list<FormInput>	$ui_container

Returns: list<FormInput>

Definition at line 953 of file class.ilOpenIdConnectSettingsGUI.php.

                                                                                   : array
    {
        $value = $this->settings->getProfileMappingFieldValue(self::UDF_STRING . $definition->getIdentifier());
        $update = $this->settings->getProfileMappingFieldUpdate(self::UDF_STRING . $definition->getIdentifier());
 
        $text_input = $this->ui
            ->input()
            ->field()
            ->text($definition->getLabel(), '')
            ->withAdditionalTransformation($this->trimIfStringTrafo())
            ->withValue($value)
            ->withDedicatedName(self::UDF_STRING . $definition->getIdentifier() . self::VALUE_STRING);
        $checkbox_input = $this->ui
            ->input()
            ->field()->checkbox('', $this->lng->txt('auth_oidc_update_field_info'))
            ->withValue($update)
            ->withDedicatedName(
                self::UDF_STRING . $definition->getIdentifier() . self::UPDATE_STRING
            );
        $group = $this->ui->input()->field()->group(
            [$text_input, $checkbox_input]
        );
        $ui_container[] = $group;
 
        return $ui_container;
    }

References ILIAS\Repository\lng(), settings(), trimIfStringTrafo(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ buildUserMappingInputForUserData()

ilOpenIdConnectSettingsGUI::buildUserMappingInputForUserData	(	string	$lang,
		string	$mapping,
		array	$ui_container
	)

private

Parameters

list<FormInput> $ui_container

Returns: list<FormInput>

Definition at line 984 of file class.ilOpenIdConnectSettingsGUI.php.

                                                                                                         : array
    {
        $value = $this->settings->getProfileMappingFieldValue($mapping);
        $update = $this->settings->getProfileMappingFieldUpdate($mapping);
 
        $text_input = $this->ui
            ->input()
            ->field()
            ->text($lang, '')
            ->withAdditionalTransformation($this->trimIfStringTrafo())
            ->withValue($value)
            ->withDedicatedName($mapping . self::VALUE_STRING);
        $checkbox_input = $this->ui
            ->input()
            ->field()
            ->checkbox('', $this->lng->txt('auth_oidc_update_field_info'))
            ->withValue($update)
            ->withDedicatedName($mapping . self::UPDATE_STRING);
        $group = $this->ui->input()->field()->group(
            [
                $text_input,
                $checkbox_input
            ]
        );
        $ui_container[] = $group;
 
        return $ui_container;
    }

References ILIAS\Repository\lng(), settings(), trimIfStringTrafo(), and ILIAS\Repository\ui().

Here is the call graph for this function:

◆ checkAccess()

ilOpenIdConnectSettingsGUI::checkAccess ( string $a_permission )

private

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

                                                      : void
    {
        if (!$this->checkAccessBool($a_permission)) {
            $this->error->raiseError($this->lng->txt('msg_no_perm_read'), $this->error->WARNING);
        }
    }

References checkAccessBool(), error(), and ILIAS\Repository\lng().

Referenced by executeCommand(), profile(), roles(), saveRoles(), saveScopes(), saveSettings(), scopes(), and settings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ checkAccessBool()

ilOpenIdConnectSettingsGUI::checkAccessBool ( string $a_permission )

private

Definition at line 125 of file class.ilOpenIdConnectSettingsGUI.php.

                                                          : bool
    {
        return $this->access->checkAccess($a_permission, '', $this->ref_id);
    }

References ILIAS\Repository\access().

Referenced by checkAccess(), initRolesForm(), initSettingsForm(), and saveProfileMapping().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ chooseMapping()

ilOpenIdConnectSettingsGUI::chooseMapping ( )

private

Definition at line 858 of file class.ilOpenIdConnectSettingsGUI.php.

                                    : void
    {
        $this->showInfoMessage();
 
        $this->setSubTabs(self::STAB_PROFILE);
 
        if ((int) $this->mapping_template === self::VIEW_TAB_EFFECTIVE_MAPPING) {
            $this->userMapping();
            return;
        }
 
        $this->initAttributeMapping();
    }

References initAttributeMapping(), setSubTabs(), showInfoMessage(), and userMapping().

Referenced by profile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ discoverScopesFromServer()

ilOpenIdConnectSettingsGUI::discoverScopesFromServer ( )

private

Definition at line 472 of file class.ilOpenIdConnectSettingsGUI.php.

                                               : void
    {
        $url = '';
        $type = $this->settings->getValidateScopes();
        if ($type === ilOpenIdConnectSettings::URL_VALIDATION_PROVIDER) {
            $url = $this->settings->getProvider() . self::URL_VALIDATION_PROVIDER_STRING;
        } elseif ($type === ilOpenIdConnectSettings::URL_VALIDATION_CUSTOM) {
            $url = $this->settings->getCustomDiscoveryUrl();
        }
 
        if ($url !== '') {
            $found_scopes = $this->settings->getSupportedScopesFromUrl($url);
            if ($found_scopes === true) {
                $this->mainTemplate->setOnScreenMessage('success', $this->lng->txt('auth_oidc_discover_scopes_info'));
            }
        }
 
        $this->scopes();
    }

References $url, ILIAS\Repository\lng(), mainTemplate(), scopes(), settings(), ilOpenIdConnectSettings\URL_VALIDATION_CUSTOM, ilOpenIdConnectSettings\URL_VALIDATION_PROVIDER, and URL_VALIDATION_PROVIDER_STRING.

Here is the call graph for this function:

◆ executeCommand()

ilOpenIdConnectSettingsGUI::executeCommand ( )

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

                                    : void
    {
        $this->checkAccess('read');
 
        switch ($this->ctrl->getNextClass()) {
            default:
                $cmd = $this->ctrl->getCmd(self::DEFAULT_CMD);
                $this->$cmd();
                break;
        }
    }

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

Here is the call graph for this function:

◆ initAttributeMapping()

ilOpenIdConnectSettingsGUI::initAttributeMapping ( )

private

Definition at line 896 of file class.ilOpenIdConnectSettingsGUI.php.

                                           : void
    {
        $mapping = $this->attribute_mapping_template->getMappingRulesByAdditionalScopes(
            $this->settings->getAdditionalScopes()
        );
 
        if (count($mapping) > 0) {
            $this->settings->clearProfileMaps();
        }
 
        foreach ($mapping as $field => $item) {
            $this->settings->setProfileMappingFieldValue(
                $field,
                $item
            );
        }
 
        $this->userMapping();
    }

References settings(), and userMapping().

Referenced by chooseMapping().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initRolesForm()

ilOpenIdConnectSettingsGUI::initRolesForm ( )

private

Definition at line 743 of file class.ilOpenIdConnectSettingsGUI.php.

                                    : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt('auth_oidc_role_mapping_table'));
        $form->setFormAction($this->ctrl->getFormAction($this, self::STAB_ROLES));
 
        foreach ($this->prepareRoleSelection(false) as $role_id => $role_title) {
            $role_map = new ilTextInputGUI(
                $role_title,
                'role_map_' . $role_id
            );
            $role_map->setInfo($this->lng->txt('auth_oidc_role_info'));
            $role_map->setValue($this->settings->getRoleMappingValueForId((int) $role_id));
            $form->addItem($role_map);
 
            $update = new ilCheckboxInputGUI(
                '',
                'role_map_update_' . $role_id
            );
            $update->setOptionTitle($this->lng->txt('auth_oidc_update_role_info'));
            $update->setValue('1');
            $update->setChecked(!$this->settings->getRoleMappingUpdateForId((int) $role_id));
            $form->addItem($update);
        }
 
        if ($this->checkAccessBool('write')) {
            $form->addCommandButton('saveRoles', $this->lng->txt('save'));
        }
 
        return $form;
    }

References checkAccessBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), prepareRoleSelection(), and settings().

Referenced by roles(), and saveRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initSettingsForm()

ilOpenIdConnectSettingsGUI::initSettingsForm ( )

private

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

                                       : ilPropertyFormGUI
    {
        $form = new ilPropertyFormGUI();
        $form->setTitle($this->lng->txt('auth_oidc_settings_title'));
        $form->setFormAction($this->ctrl->getFormAction($this));
 
        $activation = new ilCheckboxInputGUI(
            $this->lng->txt('auth_oidc_settings_activation'),
            'activation'
        );
        $activation->setChecked($this->settings->getActive());
        $form->addItem($activation);
 
        $provider = new ilTextInputGUI(
            $this->lng->txt('auth_oidc_settings_provider'),
            'provider'
        );
        $provider->setRequired(true);
        $provider->setValue($this->settings->getProvider());
        $form->addItem($provider);
 
        $client_id = new ilTextInputGUI(
            $this->lng->txt('auth_oidc_settings_client_id'),
            'client_id'
        );
        $client_id->setRequired(true);
        $client_id->setValue($this->settings->getClientId());
        $form->addItem($client_id);
 
        $secret = new ilPasswordInputGUI(
            $this->lng->txt('auth_oidc_settings_secret'),
            'secret'
        );
        $secret->setSkipSyntaxCheck(true);
        $secret->setRetype(false);
        $secret->setRequired(false);
        if ($this->settings->getSecret() !== '') {
            $secret->setValue('******');
        }
        $form->addItem($secret);
 
        $login_element = new ilRadioGroupInputGUI(
            $this->lng->txt('auth_oidc_settings_le'),
            'le'
        );
        $login_element->setRequired(true);
        $login_element->setValue((string) $this->settings->getLoginElementType());
        $form->addItem($login_element);
 
        $text_option = new ilRadioOption(
            $this->lng->txt('auth_oidc_settings_txt'),
            (string) ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_TXT
        );
        $login_element->addOption($text_option);
 
        $text = new ilTextInputGUI(
            '',
            'le_text'
        );
        $text->setValue($this->settings->getLoginElemenText());
        $text->setMaxLength(120);
        $text->setInfo($this->lng->txt('auth_oidc_settings_txt_val_info'));
        $text_option->addSubItem($text);
 
        $img_option = new ilRadioOption(
            $this->lng->txt('auth_oidc_settings_img'),
            (string) ilOpenIdConnectSettings::LOGIN_ELEMENT_TYPE_IMG
        );
        $login_element->addOption($img_option);
 
        $image = new ilImageFileInputGUI(
            '',
            'le_img'
        );
        $image->setAllowDeletion(false);
 
        if ($this->settings->hasImageFile()) {
            $image->setImage($this->settings->getImageFilePath());
        }
        $image->setInfo($this->lng->txt('auth_oidc_settings_img_file_info'));
        $img_option->addSubItem($image);
 
        $login_options = new ilRadioGroupInputGUI(
            $this->lng->txt('auth_oidc_settings_login_options'),
            'login_prompt'
        );
        $login_options->setValue((string) $this->settings->getLoginPromptType());
 
        $enforce = new ilRadioOption(
            $this->lng->txt('auth_oidc_settings_login_option_enforce'),
            (string) ilOpenIdConnectSettings::LOGIN_ENFORCE
        );
        $enforce->setInfo($this->lng->txt('auth_oidc_settings_login_option_enforce_info'));
        $login_options->addOption($enforce);
 
        $default = new ilRadioOption(
            $this->lng->txt('auth_oidc_settings_login_option_default'),
            (string) ilOpenIdConnectSettings::LOGIN_STANDARD
        );
        $default->setInfo($this->lng->txt('auth_oidc_settings_login_option_default_info'));
        $login_options->addOption($default);
 
        $form->addItem($login_options);
 
        $logout_scope = new ilRadioGroupInputGUI(
            $this->lng->txt('auth_oidc_settings_logout_scope'),
            'logout_scope'
        );
        $logout_scope->setValue((string) $this->settings->getLogoutScope());
 
        $global_scope = new ilRadioOption(
            $this->lng->txt('auth_oidc_settings_logout_scope_global'),
            (string) ilOpenIdConnectSettings::LOGOUT_SCOPE_GLOBAL
        );
        $global_scope->setInfo($this->lng->txt('auth_oidc_settings_logout_scope_global_info'));
        $logout_scope->addOption($global_scope);
 
        $ilias_scope = new ilRadioOption(
            $this->lng->txt('auth_oidc_settings_logout_scope_local'),
            (string) ilOpenIdConnectSettings::LOGOUT_SCOPE_LOCAL
        );
        $ilias_scope->setInfo($this->lng->txt('auth_oidc_settings_logout_scope_local_info'));
        $logout_scope->addOption($ilias_scope);
 
        $form->addItem($logout_scope);
 
        $use_custom_session = new ilCheckboxInputGUI(
            $this->lng->txt('auth_oidc_settings_custom_session_duration_type'),
            'custom_session'
        );
        $use_custom_session->setOptionTitle(
            $this->lng->txt('auth_oidc_settings_custom_session_duration_option')
        );
        $use_custom_session->setChecked($this->settings->isCustomSession());
        $form->addItem($use_custom_session);
 
        $session = new ilNumberInputGUI(
            $this->lng->txt('auth_oidc_settings_session_duration'),
            'session_duration'
        );
        $session->setValue((string) $this->settings->getSessionDuration());
        $session->setSuffix($this->lng->txt('minutes'));
        $session->setMinValue(5);
        $session->setMaxValue(1440);
        $session->setRequired(true);
        $use_custom_session->addSubItem($session);
 
        if ($this->checkAccessBool('write')) {
            $form->addCommandButton('saveSettings', $this->lng->txt('save'));
        }
 
        $user_sync = new ilFormSectionHeaderGUI();
        $user_sync->setTitle($this->lng->txt('auth_oidc_settings_section_user_sync'));
        $form->addItem($user_sync);
 
        $sync = new ilCheckboxInputGUI(
            $this->lng->txt('auth_oidc_settings_user_sync'),
            'sync'
        );
        $sync->setChecked($this->settings->isSyncAllowed());
        $sync->setInfo($this->lng->txt('auth_oidc_settings_user_sync_info'));
        $sync->setValue('1');
        $form->addItem($sync);
 
        $roles = new ilSelectInputGUI(
            $this->lng->txt('auth_oidc_settings_default_role'),
            'role'
        );
        $roles->setValue((string) $this->settings->getRole());
        $roles->setInfo($this->lng->txt('auth_oidc_settings_default_role_info'));
        $roles->setOptions($this->prepareRoleSelection());
        $roles->setRequired(true);
        $sync->addSubItem($roles);
 
        $user_attr = new ilTextInputGUI(
            $this->lng->txt('auth_oidc_settings_user_attr'),
            'username'
        );
        $user_attr->setValue($this->settings->getUidField());
        $user_attr->setRequired(true);
        $form->addItem($user_attr);
 
        return $form;
    }

References $client_id, $provider, checkAccessBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), ilOpenIdConnectSettings\LOGIN_ELEMENT_TYPE_IMG, ilOpenIdConnectSettings\LOGIN_ELEMENT_TYPE_TXT, ilOpenIdConnectSettings\LOGIN_ENFORCE, ilOpenIdConnectSettings\LOGIN_STANDARD, ilOpenIdConnectSettings\LOGOUT_SCOPE_GLOBAL, ilOpenIdConnectSettings\LOGOUT_SCOPE_LOCAL, prepareRoleSelection(), and settings().

Referenced by saveSettings(), and settings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initUserDefinedFields()

ilOpenIdConnectSettingsGUI::initUserDefinedFields ( )

private

Definition at line 1013 of file class.ilOpenIdConnectSettingsGUI.php.

                                            : void
    {
        if ($this->user_defined_fields === null) {
            $this->user_defined_fields = $this->profile->getAllUserDefinedFields();
        }
    }

References profile().

Here is the call graph for this function:

◆ prepareRoleSelection()

ilOpenIdConnectSettingsGUI::prepareRoleSelection ( bool $a_with_select_option = true )

private

Returns: array<string, string>

Definition at line 406 of file class.ilOpenIdConnectSettingsGUI.php.

                                                                            : array
    {
        $global_roles = ilUtil::_sortIds(
            $this->review->getGlobalRoles(),
            'object_data',
            'title',
            'obj_id'
        );
 
        $select = [];
        if ($a_with_select_option) {
            $select[0] = $this->lng->txt('links_select_one');
        }
        foreach ($global_roles as $role_id) {
            if ($role_id === ANONYMOUS_ROLE_ID) {
                continue;
            }
            $select[(string) $role_id] = ilObject::_lookupTitle((int) $role_id);
        }
 
        return $select;
    }

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

Referenced by initRolesForm(), initSettingsForm(), and saveRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ profile()

ilOpenIdConnectSettingsGUI::profile ( )

private

Definition at line 429 of file class.ilOpenIdConnectSettingsGUI.php.

                              : void
    {
        $this->checkAccess('read');
 
        $this->redirectToSettingsScreenIfNoURLIsConfigured();
 
        $this->chooseMapping();
        $this->userMapping();
    }

References checkAccess(), chooseMapping(), redirectToSettingsScreenIfNoURLIsConfigured(), and userMapping().

Referenced by __construct(), initUserDefinedFields(), and saveProfileMapping().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ redirectToSettingsScreenIfNoURLIsConfigured()

ilOpenIdConnectSettingsGUI::redirectToSettingsScreenIfNoURLIsConfigured ( )

private

Definition at line 1052 of file class.ilOpenIdConnectSettingsGUI.php.

                                                                  : void
    {
        $url = $this->settings->getProvider();
        if ($url === '') {
            $this->tpl->setOnScreenMessage(
                $this->tpl::MESSAGE_TYPE_FAILURE,
                $this->lng->txt('permission_denied'),
                true
            );
            $this->ctrl->redirect($this, 'settings');
        }
    }

References $url, ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), and settings().

Referenced by profile(), roles(), and scopes().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ roles()

ilOpenIdConnectSettingsGUI::roles ( ?ilPropertyFormGUI $form = null )

private

Definition at line 728 of file class.ilOpenIdConnectSettingsGUI.php.

                                                           : void
    {
        $this->checkAccess('read');
 
        $this->redirectToSettingsScreenIfNoURLIsConfigured();
 
        $this->setSubTabs(self::STAB_ROLES);
 
        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->initRolesForm();
        }
 
        $this->mainTemplate->setContent($form->getHTML());
    }

References checkAccess(), initRolesForm(), mainTemplate(), redirectToSettingsScreenIfNoURLIsConfigured(), and setSubTabs().

Referenced by saveRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saniziteArrayElementsTrafo()

ilOpenIdConnectSettingsGUI::saniziteArrayElementsTrafo ( )

private

Definition at line 1065 of file class.ilOpenIdConnectSettingsGUI.php.

                                                 : \ILIAS\Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(static function (array $values): array {
            return ilArrayUtil::stripSlashesRecursive($values);
        });
    }

References ILIAS\Repository\refinery(), and ilArrayUtil\stripSlashesRecursive().

Here is the call graph for this function:

◆ saveImageFromHttpRequest()

ilOpenIdConnectSettingsGUI::saveImageFromHttpRequest ( )

private

Definition at line 381 of file class.ilOpenIdConnectSettingsGUI.php.

                                               : void
    {
        try {
            if (!$this->upload->hasBeenProcessed()) {
                $this->upload->process();
            }
 
            foreach ($this->upload->getResults() as $single_file_upload) {
                if ($single_file_upload->isOK()) {
                    $this->settings->deleteImageFile();
                    $this->upload->moveFilesTo(
                        ilOpenIdConnectSettings::FILE_STORAGE,
                        \ILIAS\FileUpload\Location::WEB
                    );
                    $this->settings->setLoginElementImage($single_file_upload->getName());
                }
            }
        } catch (\ILIAS\Filesystem\Exception\IllegalStateException $e) {
            $this->logger->warning('Upload failed with message: ' . $e->getMessage());
        }
    }

References Vendor\Package\$e, ilOpenIdConnectSettings\FILE_STORAGE, ILIAS\Repository\logger(), settings(), and ILIAS\Repository\upload().

Referenced by saveSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveProfileMapping()

ilOpenIdConnectSettingsGUI::saveProfileMapping ( )

private

Definition at line 672 of file class.ilOpenIdConnectSettingsGUI.php.

                                         : void
    {
        $this->checkAccessBool('write');
 
        $form = $this->initUserMappingForm();
        if ($this->request->getMethod() === 'POST' &&
            $this->request->getQueryParams()['opic'] === 'opic_user_data_mapping') {
            $request_form = $form->withRequest($this->request);
            $result = $request_form->getData();
            if ($result === null) {
                $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
                $this->profile();
                return;
            }
 
            foreach ($this->settings->getProfileMappingFields() as $field => $lng_key) {
                $this->updateProfileMappingFieldValue($field);
            }
 
            foreach ($this->user_defined_fields as $field) {
                $field = self::UDF_STRING . $field->getIdentifier();
                $this->updateProfileMappingFieldValue($field->getIdentifier());
            }
        }
 
        $this->settings->save();
 
        $this->mainTemplate->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, self::STAB_PROFILE);
    }

References checkAccessBool(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), mainTemplate(), profile(), settings(), and updateProfileMappingFieldValue().

Here is the call graph for this function:

◆ saveRoles()

ilOpenIdConnectSettingsGUI::saveRoles ( )

private

Definition at line 775 of file class.ilOpenIdConnectSettingsGUI.php.

                                : void
    {
        $this->checkAccess('write');
 
        $form = $this->initRolesForm();
        if ($form->checkInput()) {
            $this->logger->dump($this->body, ilLogLevel::DEBUG);
 
            $role_settings = [];
            $role_valid = true;
            foreach ($this->prepareRoleSelection(false) as $role_id => $role_title) {
                $role_settings[(int) $role_id]['update'] = !$form->getInput('role_map_update_' . $role_id);
                $role_settings[(int) $role_id]['value'] = '';
 
                $input_role = trim($form->getInput('role_map_' . $role_id));
                if ($input_role === '') {
                    continue;
                }
 
                $role_params = explode('::', $input_role);
                $this->logger->dump($role_params, ilLogLevel::DEBUG);
 
                if (count($role_params) !== 2) {
                    if ($form->getItemByPostVar('role_map_' . $role_id)) {
                        $form->getItemByPostVar('role_map_' . $role_id)->setAlert($this->lng->txt('msg_wrong_format'));
                    }
                    $role_valid = false;
                    continue;
                }
                $role_settings[(int) $role_id]['value'] = $input_role;
            }
 
            if (!$role_valid) {
                $form->setValuesByPost();
                $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
                $this->roles($form);
                return;
            }
 
            $this->settings->setRoleMappings($role_settings);
            $this->settings->save();
            $this->mainTemplate->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'roles');
        }
 
        $form->setValuesByPost();
 
        $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
 
        $this->roles($form);
    }

References checkAccess(), ILIAS\Repository\ctrl(), ilLogLevel\DEBUG, initRolesForm(), ILIAS\Repository\int(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), mainTemplate(), prepareRoleSelection(), roles(), and settings().

Here is the call graph for this function:

◆ saveScopes()

ilOpenIdConnectSettingsGUI::saveScopes ( )

private

Definition at line 557 of file class.ilOpenIdConnectSettingsGUI.php.

                                 : void
    {
        $this->checkAccess('write');
 
        $validation = false;
        $type = null;
        $url = null;
        $custom_scopes = [];
 
        $form = $this->initScopesForm();
        if ($this->request->getMethod() === 'POST') {
            $request_form = $form->withRequest($this->request);
            $result = $request_form->getData();
            if ($result === null) {
                $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
                $this->scopes();
                return;
            }
 
            foreach ($form->getInputs() as $group => $groups) {
                foreach ($groups->getInputs() as $key => $input) {
                    $dedicated_name = $input->getDedicatedName();
                    $result_data = $result[$group][$key];
                    if ($dedicated_name === 'validate_scopes') {
                        $type = (int) $result_data[0];
                        $url = array_pop($result_data[1]);
                    } elseif ($dedicated_name === 'custom_scope') {
                        $custom_scopes = $result_data;
                    }
                }
            }
 
            if ($url === null && $type === ilOpenIdConnectSettings::URL_VALIDATION_PROVIDER) {
                $url = $this->settings->getProvider();
            }
            $validation = $this->validateDiscoveryUrl($type, $url, $custom_scopes);
        }
 
        if ($validation) {
            $this->settings->setAdditionalScopes((array) $custom_scopes);
            $this->settings->setValidateScopes((int) $type);
            if (ilOpenIdConnectSettings::URL_VALIDATION_CUSTOM === $this->settings->getValidateScopes()) {
                $this->settings->setCustomDiscoveryUrl($url);
            }
            $this->settings->save();
            $this->mainTemplate->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
            $this->ctrl->redirect($this, 'scopes');
        }
 
        if ($this->failed_validation_messages !== '') {
            $this->failed_validation_messages = $this->lng->txt(
                'err_check_input'
            ) . '<br/>' . $this->failed_validation_messages;
        } else {
            $this->failed_validation_messages = $this->lng->txt('err_check_input');
        }
 
        $this->mainTemplate->setOnScreenMessage('failure', $this->failed_validation_messages, true);
        $this->ctrl->redirect($this, 'scopes');
    }

References $failed_validation_messages, $url, checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\int(), ILIAS\Repository\lng(), mainTemplate(), scopes(), settings(), ilOpenIdConnectSettings\URL_VALIDATION_CUSTOM, ilOpenIdConnectSettings\URL_VALIDATION_PROVIDER, and validateDiscoveryUrl().

Here is the call graph for this function:

◆ saveSettings()

ilOpenIdConnectSettingsGUI::saveSettings ( )

private

Definition at line 340 of file class.ilOpenIdConnectSettingsGUI.php.

                                   : void
    {
        $this->checkAccess('write');
 
        $form = $this->initSettingsForm();
        if (!$form->checkInput()) {
            $this->mainTemplate->setOnScreenMessage('failure', $this->lng->txt('err_check_input'));
            $form->setValuesByPost();
            $this->settings($form);
            return;
        }
 
        $this->settings->setActive((bool) $form->getInput('activation'));
        $this->settings->setProvider((string) $form->getInput('provider'));
        $this->settings->setClientId((string) $form->getInput('client_id'));
        if ((string) $form->getInput('secret') !== '' && strcmp($form->getInput('secret'), '******') !== 0) {
            $this->settings->setSecret((string) $form->getInput('secret'));
        }
 
        $this->settings->setLoginElementType((int) $form->getInput('le'));
        $this->settings->setLoginElementText((string) $form->getInput('le_text'));
        $this->settings->setLoginPromptType((int) $form->getInput('login_prompt'));
        $this->settings->setLogoutScope((int) $form->getInput('logout_scope'));
        $this->settings->useCustomSession((bool) $form->getInput('custom_session'));
        $this->settings->setSessionDuration((int) $form->getInput('session_duration'));
        $this->settings->allowSync((bool) $form->getInput('sync'));
        $this->settings->setRole((int) $form->getInput('role'));
        $this->settings->setUidField((string) $form->getInput('username'));
 
        $fileData = (array) $form->getInput('le_img');
 
        if ((string) ($fileData['tmp_name'] ?? '') !== '') {
            $this->saveImageFromHttpRequest();
        }
 
        $this->settings->save();
 
        $this->mainTemplate->setOnScreenMessage('success', $this->lng->txt('settings_saved'), true);
        $this->ctrl->redirect($this, 'settings');
    }

References checkAccess(), ILIAS\Repository\ctrl(), initSettingsForm(), ILIAS\Repository\lng(), mainTemplate(), saveImageFromHttpRequest(), and settings().

Here is the call graph for this function:

◆ scopes()

ilOpenIdConnectSettingsGUI::scopes ( )

private

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

                             : void
    {
        $this->checkAccess('read');
 
        $this->redirectToSettingsScreenIfNoURLIsConfigured();
 
        $this->setSubTabs(self::STAB_SCOPES);
        $url = $this->settings->getProvider();
        if ($url !== '') {
            $this->toolbar->setFormAction($this->ctrl->getFormAction($this));
            $this->toolbar->addFormButton($this->lng->txt('auth_oidc_discover_scopes'), 'discoverScopesFromServer');
        }
 
        $form = $this->initScopesForm();
        $this->tpl->setContent($this->renderer->render($form));
    }

References $url, checkAccess(), ILIAS\Repository\ctrl(), ILIAS\Repository\lng(), redirectToSettingsScreenIfNoURLIsConfigured(), renderer(), setSubTabs(), settings(), and ILIAS\Repository\toolbar().

Referenced by discoverScopesFromServer(), saveScopes(), and validateDiscoveryUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSubTabs()

ilOpenIdConnectSettingsGUI::setSubTabs ( string $active_tab )

private

Definition at line 827 of file class.ilOpenIdConnectSettingsGUI.php.

                                                   : void
    {
        $this->tabs->addSubTab(
            self::STAB_SETTINGS,
            $this->lng->txt('auth_oidc_' . self::STAB_SETTINGS),
            $this->ctrl->getLinkTarget($this, self::STAB_SETTINGS)
        );
 
        $url = $this->settings->getProvider();
        if ($url !== '') {
            $this->tabs->addSubTab(
                self::STAB_SCOPES,
                $this->lng->txt('auth_oidc_' . self::STAB_SCOPES),
                $this->ctrl->getLinkTarget($this, self::STAB_SCOPES)
            );
 
            $this->tabs->addSubTab(
                self::STAB_PROFILE,
                $this->lng->txt('auth_oidc_' . self::STAB_PROFILE),
                $this->ctrl->getLinkTarget($this, self::STAB_PROFILE)
            );
            $this->tabs->addSubTab(
                self::STAB_ROLES,
                $this->lng->txt('auth_oidc_' . self::STAB_ROLES),
                $this->ctrl->getLinkTarget($this, self::STAB_ROLES)
            );
        }
 
        $this->tabs->activateSubTab($active_tab);
    }

References $url, ILIAS\Repository\lng(), settings(), and ILIAS\Repository\tabs().

Referenced by chooseMapping(), roles(), scopes(), and settings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ settings()

ilOpenIdConnectSettingsGUI::settings ( ?ilPropertyFormGUI $form = null )

private

Definition at line 142 of file class.ilOpenIdConnectSettingsGUI.php.

                                                              : void
    {
        $this->checkAccess('read');
 
        $this->setSubTabs(self::STAB_SETTINGS);
 
        if (!$form instanceof ilPropertyFormGUI) {
            $form = $this->initSettingsForm();
        }
 
        $this->mainTemplate->setContent($form->getHTML());
    }

References checkAccess(), initSettingsForm(), mainTemplate(), and setSubTabs().

Referenced by __construct(), buildScopeSelection(), buildUserMappingInputFormUDF(), buildUserMappingInputForUserData(), discoverScopesFromServer(), initAttributeMapping(), initRolesForm(), initSettingsForm(), redirectToSettingsScreenIfNoURLIsConfigured(), saveImageFromHttpRequest(), saveProfileMapping(), saveRoles(), saveScopes(), saveSettings(), scopes(), setSubTabs(), updateProfileMappingFieldValue(), and validateDiscoveryUrl().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ showInfoMessage()

ilOpenIdConnectSettingsGUI::showInfoMessage ( )

private

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

                                      : void
    {
        if ($this->mapping_template === self::VIEW_TAB_EFFECTIVE_MAPPING) {
            $url = $this->renderer->render(
                $this->factory->link()->standard(
                    $this->lng->txt('auth_oidc_here'),
                    'https://openid.net/specs/openid-connect-core-1_0.html#StandardClaims'
                )->withOpenInNewViewport(true)
            );
            $message = sprintf($this->lng->txt('auth_odic_scope_tab_info'), $url);
        } else {
            $url = $this->renderer->render(
                $this->factory->link()->standard(
                    $this->lng->txt('auth_oidc_here'),
                    $this->ctrl->getLinkTarget($this, self::STAB_SCOPES)
                )
            );
            $tab_name = $this->lng->txt('auth_oidc_configured_scopes');
            $message = sprintf($this->lng->txt('auth_odic_scope_info'), $url, $tab_name);
        }
 
        $this->mainTemplate->setOnScreenMessage('info', $message);
    }

References $message, $url, factory(), ILIAS\Repository\lng(), mainTemplate(), and renderer().

Referenced by chooseMapping().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ trimIfStringTrafo()

ilOpenIdConnectSettingsGUI::trimIfStringTrafo ( )

private

Definition at line 1072 of file class.ilOpenIdConnectSettingsGUI.php.

                                        : \ILIAS\Refinery\Transformation
    {
        return $this->refinery->custom()->transformation(static function ($value) {
            if (is_string($value)) {
                $value = trim($value);
            }
 
            return $value;
        });
    }

References ILIAS\Repository\refinery().

Referenced by buildScopeSelection(), buildUserMappingInputFormUDF(), and buildUserMappingInputForUserData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateProfileMappingFieldValue()

ilOpenIdConnectSettingsGUI::updateProfileMappingFieldValue ( string $field )

private

Definition at line 703 of file class.ilOpenIdConnectSettingsGUI.php.

                                                                  : void
    {
        $form = $this->initUserMappingForm();
        $request_form = $form->withRequest($this->request);
        $result = $request_form->getData();
        foreach ($form->getInputs() as $group => $groups) {
            foreach ($groups->getInputs() as $key => $input) {
                $dedicated_name = $input->getDedicatedName();
                $result_data = $result[$group][$key];
 
                if ($dedicated_name === $field . self::VALUE_STRING) {
                    $this->settings->setProfileMappingFieldValue(
                        $field,
                        $result_data
                    );
                } elseif ($dedicated_name === $field . self::UPDATE_STRING) {
                    $this->settings->setProfileMappingFieldUpdate(
                        $field,
                        (bool) $result_data
                    );
                }
            }
        }
    }

References settings().

Referenced by saveProfileMapping().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ userMapping()

ilOpenIdConnectSettingsGUI::userMapping ( )

private

Definition at line 1020 of file class.ilOpenIdConnectSettingsGUI.php.

                                  : void
    {
        $form = $this->initUserMappingForm();
 
        $request_wrapper = $this->http->wrapper()->query();
        $active = self::EFFECTIVE_ATTRIBUTE_MAPPING_TAB;
 
        $target = $this->http->request()->getRequestTarget();
        if ($request_wrapper->has(self::POST_VALUE) && $request_wrapper->retrieve(
            self::POST_VALUE,
            $this->refinery->kindlyTo()->int()
        )) {
            $active = $request_wrapper->retrieve(self::POST_VALUE, $this->refinery->kindlyTo()->int());
        }
 
        $actions = [
            $this->lng->txt('auth_oidc_saved_values') => "$target&" . self::POST_VALUE . '=' . self::SAVED_VALUES,
            $this->lng->txt(
                ilOpenIdAttributeMappingTemplate::OPEN_ID_CONFIGURED_SCOPES
            ) => "$target&" . self::POST_VALUE . '=' . self::DEFAULT_VALUES,
        ];
 
        $aria_label = 'change_the_currently_displayed_mode';
        $active_label = $this->lng->txt('auth_oidc_saved_values');
        if ($active !== self::EFFECTIVE_ATTRIBUTE_MAPPING_TAB) {
            $active_label = $this->lng->txt(ilOpenIdAttributeMappingTemplate::OPEN_ID_CONFIGURED_SCOPES);
        }
        $view_control = $this->factory->viewControl()->mode($actions, $aria_label)->withActive($active_label);
 
        $this->tpl->setContent($this->renderer->render([$view_control, $form]));
    }

References ILIAS\UI\examples\Layout\Page\Standard\$request_wrapper, DEFAULT_VALUES, EFFECTIVE_ATTRIBUTE_MAPPING_TAB, factory(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ilOpenIdAttributeMappingTemplate\OPEN_ID_CONFIGURED_SCOPES, ILIAS\Repository\refinery(), renderer(), and SAVED_VALUES.

Referenced by chooseMapping(), initAttributeMapping(), and profile().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ validateDiscoveryUrl()

ilOpenIdConnectSettingsGUI::validateDiscoveryUrl	(	int	$type,
		?string	$url,
		array	$scopes
	)

private

Parameters

list<string> $scopes

Definition at line 621 of file class.ilOpenIdConnectSettingsGUI.php.

                                                                                 : bool
    {
        try {
            switch ($type) {
                case ilOpenIdConnectSettings::URL_VALIDATION_PROVIDER:
                    $discoveryURL = $url . self::URL_VALIDATION_PROVIDER_STRING;
                    break;
                case ilOpenIdConnectSettings::URL_VALIDATION_CUSTOM:
                    $discoveryURL = $url;
                    break;
                default:
                    $discoveryURL = null;
                    break;
            }
 
            $validation_result = $discoveryURL !== null ? $this->settings->validateScopes(
                $discoveryURL,
                $scopes
            ) : [];
            if (!empty($validation_result)) {
                if (ilOpenIdConnectSettings::VALIDATION_ISSUE_INVALID_SCOPE === $validation_result[0]) {
                    $this->failed_validation_messages =
                        sprintf(
                            $this->lng->txt('auth_oidc_settings_invalid_scopes'),
                            implode(',', $validation_result[1])
                        );
                } else {
                    $this->failed_validation_messages = sprintf(
                        $this->lng->txt('auth_oidc_settings_discovery_error'),
                        $validation_result[1]
                    );
                }
                $this->scopes();
 
                return false;
            }
        } catch (ilCurlConnectionException $e) {
            $this->mainTemplate->setOnScreenMessage(
                'failure',
                $e->getMessage(),
                true
            );
            $this->failed_validation_messages = $e->getMessage();
            $this->scopes();
 
            return false;
        }
 
        return true;
    }