Collaboration diagram for ilAccountRegistrationGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	displayForm ()

	saveForm ()

	login ()

Protected Member Functions
	initForm ()

	distributeMails (string $password)

	doProfileAutoComplete ()

Protected Attributes
ilRegistrationSettings	$registration_settings

bool	$code_enabled = false

bool	$code_was_used

ilTermsOfServiceDocumentEvaluation	$termsOfServiceEvaluation

ilRecommendedContentManager	$recommended_content_manager

ilPropertyFormGUI	$form = null

ilGlobalTemplateInterface	$tpl

ilCtrlInterface	$ctrl

ilLanguage	$lng

ilErrorHandling	$error

ilObjUser	$userObj = null

ilObjUser	$globalUser

ilSetting	$settings

ilRbacReview	$rbacreview

ilRbacAdmin	$rbacadmin

ILIAS UI Factory	$ui_factory

ILIAS UI Renderer	$ui_renderer

ILIAS Refinery Factory	$refinery

ILIAS HTTP Services	$http

Detailed Description

Class ilAccountRegistrationGUI.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e ilAccountRegistrationGUI:

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

Constructor & Destructor Documentation

◆ __construct()

ilAccountRegistrationGUI::__construct ( )

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

References $DIC, ILIAS\Repository\ctrl(), ILIAS\FileDelivery\http(), ILIAS\Repository\lng(), ILIAS\Repository\refinery(), and ILIAS\Repository\settings().

     {
         global $DIC;
 
         $this->tpl = $DIC->ui()->mainTemplate();
 
         $this->ctrl = $DIC->ctrl();
         $this->ctrl->saveParameter($this, 'lang');
         $this->lng = $DIC->language();
         $this->lng->loadLanguageModule('registration');
         $this->error = $DIC['ilErr'];
         $this->settings = $DIC->settings();
         $this->globalUser = $DIC->user();
         $this->rbacreview = $DIC->rbac()->review();
         $this->rbacadmin = $DIC->rbac()->admin();
         $this->ui_factory = $DIC->ui()->factory();
         $this->ui_renderer = $DIC->ui()->renderer();
 
         $this->registration_settings = new ilRegistrationSettings();
         $this->code_enabled = ($this->registration_settings->registrationCodeRequired() ||
             $this->registration_settings->getAllowCodes());
 
         $this->termsOfServiceEvaluation = $DIC['tos.document.evaluator'];
         $this->recommended_content_manager = new ilRecommendedContentManager();
 
         $this->http = $DIC->http();
         $this->refinery = $DIC->refinery();
     }

Here is the call graph for this function:

Member Function Documentation

◆ displayForm()

ilAccountRegistrationGUI::displayForm ( )

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

References $tpl, ILIAS\Repository\form(), initForm(), ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setVariable().

Referenced by executeCommand(), and saveForm().

                                  : ilGlobalTemplateInterface
     {
         $tpl = ilStartUpGUI::initStartUpTemplate(['tpl.usr_registration.html', 'Services/Registration'], true);
         $tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('registration'));
 
         if (!$this->form) {
             $this->initForm();
         }
         $tpl->setVariable('FORM', $this->form->getHTML());
         return $tpl;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ distributeMails()

ilAccountRegistrationGUI::distributeMails ( string $password )

protected

Definition at line 606 of file class.ilAccountRegistrationGUI.php.

References ilLoggerFactory\getLogger(), ilRegistrationSettings\IL_REG_ACTIVATION, ilRegistrationSettings\IL_REG_APPROVE, ILIAS\Repository\lng(), ilRegistrationMimeMailNotification\TYPE_NOTIFICATION_ACTIVATION, ilRegistrationMailNotification\TYPE_NOTIFICATION_APPROVERS, and ilRegistrationMailNotification\TYPE_NOTIFICATION_CONFIRMATION.

Referenced by saveForm().

                                                         : void
     {
         // Send mail to approvers, if they are defined
         if ($this->registration_settings->getApproveRecipients()) {
             $mail = new ilRegistrationMailNotification();
 
             if (!$this->code_was_used &&
                 $this->registration_settings->getRegistrationType() === ilRegistrationSettings::IL_REG_APPROVE) {
                 $mail->setType(ilRegistrationMailNotification::TYPE_NOTIFICATION_CONFIRMATION);
             } else {
                 $mail->setType(ilRegistrationMailNotification::TYPE_NOTIFICATION_APPROVERS);
             }
             $mail->setRecipients($this->registration_settings->getApproveRecipients());
             $mail->setAdditionalInformation(['usr' => $this->userObj]);
             $mail->send();
         }
         // Send mail to new user
         // Registration with confirmation link ist enabled
         if (!$this->code_was_used &&
             $this->registration_settings->getRegistrationType() === ilRegistrationSettings::IL_REG_ACTIVATION) {
             $mail = new ilRegistrationMimeMailNotification();
             $mail->setType(ilRegistrationMimeMailNotification::TYPE_NOTIFICATION_ACTIVATION);
             $mail->setRecipients([$this->userObj]);
             $mail->setAdditionalInformation(
                 [
                     'usr' => $this->userObj,
                     'hash_lifetime' => $this->registration_settings->getRegistrationHashLifetime()
                 ]
             );
             $mail->send();
         } else {
             $accountMail = new ilAccountRegistrationMail(
                 $this->registration_settings,
                 $this->lng,
                 ilLoggerFactory::getLogger('user')
             );
             $accountMail->withDirectRegistrationMode()->send($this->userObj, $password, $this->code_was_used);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doProfileAutoComplete()

ilAccountRegistrationGUI::doProfileAutoComplete ( )

protected

Definition at line 679 of file class.ilAccountRegistrationGUI.php.

References exit, and ilPublicUserProfileGUI\getAutocompleteResult().

                                               : void
     {
         $field_id = (string) $_REQUEST["f"];
         $term = (string) $_REQUEST["term"];
 
         $result = ilPublicUserProfileGUI::getAutocompleteResult($field_id, $term);
         if (count($result)) {
             echo json_encode($result, JSON_THROW_ON_ERROR);
         }
 
         exit();
     }

Here is the call graph for this function:

◆ executeCommand()

ilAccountRegistrationGUI::executeCommand ( )

Definition at line 80 of file class.ilAccountRegistrationGUI.php.

References ILIAS\Repository\ctrl(), displayForm(), ilRegistrationSettings\IL_REG_DISABLED, ILIAS\Repository\lng(), and ilStartUpGUI\printToGlobalTemplate().

                                     : void
     {
         if ($this->registration_settings->getRegistrationType() === ilRegistrationSettings::IL_REG_DISABLED) {
             $this->error->raiseError($this->lng->txt('reg_disabled'), $this->error->FATAL);
         }
 
         $cmd = $this->ctrl->getCmd();
         switch ($cmd) {
             case 'saveForm':
                 $tpl = $this->$cmd();
                 break;
             default:
                 $tpl = $this->displayForm();
         }
 
         $this->tpl->setPermanentLink('usr', null, 'registration');
         ilStartUpGUI::printToGlobalTemplate($tpl);
     }

Here is the call graph for this function:

◆ initForm()

ilAccountRegistrationGUI::initForm ( )

protected

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

References ilUserDefinedFields\_getInstance(), ANONYMOUS_USER_ID, ilRegistrationCode\CODE_LENGTH, ILIAS\Repository\ctrl(), ILIAS\Repository\form(), ilCustomUserFieldsHelper\getInstance(), ilRegistrationSettings\IL_REG_ACTIVATION, iljQueryUtil\initjQuery(), ilTermsOfServiceHelper\isEnabled(), ILIAS\Repository\lng(), ilUserProfile\MODE_REGISTRATION, ilUserProfile\setMode(), and ilFormPropertyGUI\setRequired().

Referenced by displayForm(), and saveForm().

                                  : void
     {
         $this->globalUser->setLanguage($this->lng->getLangKey());
         $this->globalUser->setId(ANONYMOUS_USER_ID);
 
         // needed for multi-text-fields (interests)
         iljQueryUtil::initjQuery();
 
         $this->form = new ilPropertyFormGUI();
         $this->form->setFormAction($this->ctrl->getFormAction($this));
 
         // code handling
         if ($this->code_enabled) {
             $field = new ilFormSectionHeaderGUI();
             $field->setTitle($this->lng->txt('registration_codes_type_reg'));
             $this->form->addItem($field);
             $code = new ilTextInputGUI($this->lng->txt("registration_code"), "usr_registration_code");
             $code->setSize(40);
             $code->setMaxLength(ilRegistrationCode::CODE_LENGTH);
             if ($this->registration_settings->registrationCodeRequired()) {
                 $code->setRequired(true);
                 $code->setInfo($this->lng->txt("registration_code_required_info"));
             } else {
                 $code->setInfo($this->lng->txt("registration_code_optional_info"));
             }
             $this->form->addItem($code);
         }
 
         // user defined fields
         $user_defined_data = $this->globalUser->getUserDefinedData();
         $user_defined_fields = ilUserDefinedFields::_getInstance();
         $custom_fields = [];
 
         foreach ($user_defined_fields->getRegistrationDefinitions() as $field_id => $definition) {
             $fprop = ilCustomUserFieldsHelper::getInstance()->getFormPropertyForDefinition(
                 $definition,
                 true,
                 $user_defined_data['f_' . $field_id] ?? ''
             );
             if ($fprop instanceof ilFormPropertyGUI) {
                 $custom_fields['udf_' . $definition['field_id']] = $fprop;
             }
         }
 
         // standard fields
         //TODO-PHP8-REVIEW please check if there is a need for this static call. It looks like of odd to me, that
         //we need a global static state variable in class that changes the behaviour of all instances.
         $up = new ilUserProfile();
         ilUserProfile::setMode(ilUserProfile::MODE_REGISTRATION);
         $up->skipGroup("preferences");
 
         $up->setAjaxCallback(
             $this->ctrl->getLinkTarget($this, 'doProfileAutoComplete', '', true)
         );
         $this->lng->loadLanguageModule("user");
         // add fields to form
         $up->addStandardFieldsToForm($this->form, null, $custom_fields);
         unset($custom_fields);
 
         // set language selection to current display language
         $flang = $this->form->getItemByPostVar("usr_language");
         if ($flang) {
             $flang->setValue($this->lng->getLangKey());
         }
 
         // add information to role selection (if not hidden)
         if ($this->code_enabled) {
             $role = $this->form->getItemByPostVar("usr_roles");
             if ($role && $role->getType() === "select") {
                 $role->setInfo($this->lng->txt("registration_code_role_info"));
             }
         }
 
         // #11407
         $domains = [];
         foreach ($this->registration_settings->getAllowedDomains() as $item) {
             if (trim($item)) {
                 $domains[] = $item;
             }
         }
         if (count($domains)) {
             $mail_obj = $this->form->getItemByPostVar('usr_email');
             $mail_obj->setInfo(sprintf(
                 $this->lng->txt("reg_email_domains"),
                 implode(", ", $domains)
             ) . "<br />" .
                 ($this->code_enabled ? $this->lng->txt("reg_email_domains_code") : ""));
         }
 
         // #14272
         if ($this->registration_settings->getRegistrationType() === ilRegistrationSettings::IL_REG_ACTIVATION) {
             $mail_obj = $this->form->getItemByPostVar('usr_email');
             if ($mail_obj) { // #16087
                 $mail_obj->setRequired(true);
             }
         }
 
         if (ilTermsOfServiceHelper::isEnabled() && $this->termsOfServiceEvaluation->hasDocument()) {
             $document = $this->termsOfServiceEvaluation->document();
 
             $field = new ilFormSectionHeaderGUI();
             $field->setTitle($this->lng->txt('usr_agreement'));
             $this->form->addItem($field);
 
             $field = new ilCustomInputGUI();
             $field->setHtml('<div id="agreement">' . $document->content() . '</div>');
             $this->form->addItem($field);
 
             $field = new ilCheckboxInputGUI($this->lng->txt('accept_usr_agreement'), 'accept_terms_of_service');
             $field->setRequired(true);
             $field->setValue('1');
             $this->form->addItem($field);
         }
 
         $this->form->addCommandButton("saveForm", $this->lng->txt("register"));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ login()

ilAccountRegistrationGUI::login ( )

Definition at line 646 of file class.ilAccountRegistrationGUI.php.

References $code_was_used, $tpl, ilRegistrationSettings\IL_REG_ACTIVATION, ilRegistrationSettings\IL_REG_APPROVE, ilRegistrationSettings\IL_REG_CODES, ilRegistrationSettings\IL_REG_DIRECT, ILIAS\Repository\lng(), and ilGlobalTemplateInterface\setVariable().

Referenced by saveForm().

                            : ilGlobalTemplateInterface
     {
         $tpl = ilStartUpGUI::initStartUpTemplate(['tpl.usr_registered.html', 'Services/Registration'], false);
         $this->tpl->setVariable('TXT_PAGEHEADLINE', $this->lng->txt('registration'));
 
         $tpl->setVariable("TXT_WELCOME", $this->lng->txt("welcome") . ", " . $this->userObj->getTitle() . "!");
         if (
             (
                 $this->registration_settings->getRegistrationType() === ilRegistrationSettings::IL_REG_DIRECT ||
                 $this->registration_settings->getRegistrationType() === ilRegistrationSettings::IL_REG_CODES ||
                 $this->code_was_used
             ) &&
             !$this->registration_settings->passwordGenerationEnabled()
         ) {
             $tpl->setVariable('TXT_REGISTERED', $this->lng->txt('txt_registered'));
 
             $login_link = $this->ui_renderer->render(
                 $this->ui_factory->link()->standard(
                     $this->lng->txt('login_to_ilias'),
                     './login.php?cmd=force_login&lang=' . $this->userObj->getLanguage()
                 )
             );
             $tpl->setVariable('LOGIN_LINK', $login_link);
         } elseif ($this->registration_settings->getRegistrationType() === ilRegistrationSettings::IL_REG_APPROVE) {
             $tpl->setVariable('TXT_REGISTERED', $this->lng->txt('txt_submitted'));
         } elseif ($this->registration_settings->getRegistrationType() === ilRegistrationSettings::IL_REG_ACTIVATION) {
             $tpl->setVariable('TXT_REGISTERED', $this->lng->txt('reg_confirmation_link_successful'));
         } else {
             $tpl->setVariable('TXT_REGISTERED', $this->lng->txt('txt_registered_passw_gen'));
         }
         return $tpl;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ saveForm()

ilAccountRegistrationGUI::saveForm ( )

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

References $_SERVER, $code_was_used, $DIC, $email, Vendor\Package\$f, $GLOBALS, ilObjUser\_doesLoginnameExistInHistory(), ilObject\_getAllReferences(), ilUserDefinedFields\_getInstance(), ilObjUser\_loginExists(), ilObjRole\_lookupAllowRegister(), ilObject\_lookupType(), ilUserCreationContext\CONTEXT_REGISTRATION, displayForm(), distributeMails(), ILIAS\Repository\form(), ilSecuritySettingsChecker\generatePasswords(), ilRegistrationCode\getCodeData(), ilRegistrationCode\getCodeRole(), ilUserCreationContext\getInstance(), ilSystemSupportContacts\getMailsToAddress(), ILIAS\FileDelivery\http(), ilRegistrationSettings\IL_REG_ACTIVATION, ilRegistrationSettings\IL_REG_CODES, ilRegistrationSettings\IL_REG_DIRECT, initForm(), ILIAS\Repository\int(), ilTermsOfServiceHelper\isEnabled(), ilUtil\isLogin(), ilSecuritySettingsChecker\isPasswordValidForUserContext(), ilRegistrationCode\isValidRegistrationCode(), ILIAS\Repository\lng(), login(), ilUserProfile\MODE_REGISTRATION, ilLegacyFormElementsUtil\prepareFormOutput(), ILIAS\Repository\refinery(), ilUserProfile\setMode(), ILIAS\Repository\settings(), and ilRegistrationCode\useCode().

                               : ilGlobalTemplateInterface
     {
         $this->initForm();
         $form_valid = $this->form->checkInput();
 
         // custom validation
         $valid_code = $valid_role = false;
 
         // code
         if ($this->code_enabled) {
             $code = $this->form->getInput('usr_registration_code');
             // could be optional
             if (
                 $code !== '' ||
                 $this->registration_settings->registrationCodeRequired()
             ) {
                 // code validation
                 if (!ilRegistrationCode::isValidRegistrationCode($code)) {
                     $code_obj = $this->form->getItemByPostVar('usr_registration_code');
                     $code_obj->setAlert($this->lng->txt('registration_code_not_valid'));
                     $form_valid = false;
                 } else {
                     $valid_code = true;
 
                     // get role from code, check if (still) valid
                     $role_id = ilRegistrationCode::getCodeRole($code);
                     if ($role_id && $this->rbacreview->isGlobalRole($role_id)) {
                         $valid_role = $role_id;
                     }
                 }
             }
         }
 
         // valid codes override email domain check
         if (!$valid_code) {
             // validate email against restricted domains
             $email = $this->form->getInput("usr_email");
             if ($email) {
                 // #10366
                 $domains = [];
                 foreach ($this->registration_settings->getAllowedDomains() as $item) {
                     if (trim($item)) {
                         $domains[] = $item;
                     }
                 }
                 if (count($domains)) {
                     $mail_valid = false;
                     foreach ($domains as $domain) {
                         $domain = str_replace("*", "~~~", $domain);
                         $domain = preg_quote($domain, '/');
                         $domain = str_replace("~~~", ".+", $domain);
                         if (preg_match("/^" . $domain . "$/", $email, $hit)) {
                             $mail_valid = true;
                             break;
                         }
                     }
                     if (!$mail_valid) {
                         $mail_obj = $this->form->getItemByPostVar('usr_email');
                         $mail_obj->setAlert(sprintf(
                             $this->lng->txt("reg_email_domains"),
                             implode(", ", $domains)
                         ));
                         $form_valid = false;
                     }
                 }
             }
         }
 
         $error_lng_var = '';
         if (
             !$this->registration_settings->passwordGenerationEnabled() &&
             !ilSecuritySettingsChecker::isPasswordValidForUserContext(
                 $this->form->getInput('usr_password'),
                 $this->form->getInput('username'),
                 $error_lng_var
             )
         ) {
             $passwd_obj = $this->form->getItemByPostVar('usr_password');
             $passwd_obj->setAlert($this->lng->txt($error_lng_var));
             $form_valid = false;
         }
 
         $showGlobalTermsOfServieFailure = false;
         if (ilTermsOfServiceHelper::isEnabled() && !$this->form->getInput('accept_terms_of_service')) {
             $agr_obj = $this->form->getItemByPostVar('accept_terms_of_service');
             if ($agr_obj) {
                 $agr_obj->setAlert($this->lng->txt('force_accept_usr_agreement'));
                 $form_valid = false;
             } else {
                 $showGlobalTermsOfServieFailure = true;
             }
         }
 
         // no need if role is attached to code
         if (!$valid_role) {
             // manual selection
             if ($this->registration_settings->roleSelectionEnabled()) {
                 $selected_role = $this->form->getInput("usr_roles");
                 if ($selected_role && ilObjRole::_lookupAllowRegister((int) $selected_role)) {
                     $valid_role = (int) $selected_role;
                 }
             } // assign by email
             else {
                 $registration_role_assignments = new ilRegistrationRoleAssignments();
                 $valid_role = $registration_role_assignments->getRoleByEmail($this->form->getInput("usr_email"));
             }
         }
 
         // no valid role could be determined
         if (!$valid_role) {
             $this->tpl->setOnScreenMessage('info', $this->lng->txt("registration_no_valid_role"));
             $form_valid = false;
         }
 
         // validate username
         $login_obj = $this->form->getItemByPostVar('username');
         $login = $this->form->getInput("username");
         if (!ilUtil::isLogin($login)) {
             $login_obj->setAlert($this->lng->txt("login_invalid"));
             $form_valid = false;
         }
 
         if ($form_valid) {
             if (ilObjUser::_loginExists($login)) {
                 $login_obj->setAlert($this->lng->txt("login_exists"));
                 $form_valid = false;
             } elseif ((int) $this->settings->get('allow_change_loginname') &&
                 (int) $this->settings->get('reuse_of_loginnames') === 0 &&
                 ilObjUser::_doesLoginnameExistInHistory($login)) {
                 $login_obj->setAlert($this->lng->txt('login_exists'));
                 $form_valid = false;
             }
         }
 
         if (!$form_valid) {
             $this->tpl->setOnScreenMessage('failure', $this->lng->txt('form_input_not_valid'));
         } elseif ($showGlobalTermsOfServieFailure) {
             $this->lng->loadLanguageModule('tos');
             $this->tpl->setOnScreenMessage('failure', sprintf(
                 $this->lng->txt('tos_account_reg_not_possible'),
                 'mailto:' . ilLegacyFormElementsUtil::prepareFormOutput(ilSystemSupportContacts::getMailsToAddress())
             ));
         } else {
             $password = $this->createUser($valid_role);
             $this->distributeMails($password);
             return $this->login();
         }
         $this->form->setValuesByPost();
         return $this->displayForm();
     }