Collaboration diagram for ilAccountRegistrationGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	displayForm ()

	saveForm ()

	login ()

Protected Member Functions
	__initForm ()

	__distributeMails ($password)

	doProfileAutoComplete ()

Protected Attributes
	$registration_settings

	$code_enabled

	$code_was_used

	$userObj

	$termsOfServiceEvaluation

	$recommended_content_manager

Detailed Description

Class ilAccountRegistrationGUI.

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

Version: $Id$

ilAccountRegistrationGUI:

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

Constructor & Destructor Documentation

◆ __construct()

ilAccountRegistrationGUI::__construct ( )

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

References $DIC, $ilCtrl, $lng, and $tpl.

     {
         global $DIC;
 
         $ilCtrl = $DIC->ctrl();
         $tpl = $DIC['tpl'];
         $lng = $DIC->language();
 
         $this->tpl = &$tpl;
 
         $this->ctrl = &$ilCtrl;
         $this->ctrl->saveParameter($this, 'lang');
 
         $this->lng = &$lng;
         $this->lng->loadLanguageModule('registration');
 
         $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();
     }

Member Function Documentation

◆ __distributeMails()

ilAccountRegistrationGUI::__distributeMails ( $password )

protected

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

References $code_was_used, $password, ilLoggerFactory\getLogger(), IL_REG_ACTIVATION, IL_REG_APPROVE, ilRegistrationMimeMailNotification\TYPE_NOTIFICATION_ACTIVATION, ilRegistrationMailNotification\TYPE_NOTIFICATION_APPROVERS, and ilRegistrationMailNotification\TYPE_NOTIFICATION_CONFIRMATION.

Referenced by saveForm().

     {
 
         // Always send mail to approvers
         if ($this->registration_settings->getRegistrationType() == IL_REG_APPROVE && !$this->code_was_used) {
             $mail = new ilRegistrationMailNotification();
             $mail->setType(ilRegistrationMailNotification::TYPE_NOTIFICATION_CONFIRMATION);
             $mail->setRecipients($this->registration_settings->getApproveRecipients());
             $mail->setAdditionalInformation(array('usr' => $this->userObj));
             $mail->send();
         } else {
             $mail = new ilRegistrationMailNotification();
             $mail->setType(ilRegistrationMailNotification::TYPE_NOTIFICATION_APPROVERS);
             $mail->setRecipients($this->registration_settings->getApproveRecipients());
             $mail->setAdditionalInformation(array('usr' => $this->userObj));
             $mail->send();
         }
 
         // Send mail to new user
         // Registration with confirmation link ist enabled
         if ($this->registration_settings->getRegistrationType() == IL_REG_ACTIVATION && !$this->code_was_used) {
 
             $mail = new ilRegistrationMimeMailNotification();
             $mail->setType(ilRegistrationMimeMailNotification::TYPE_NOTIFICATION_ACTIVATION);
             $mail->setRecipients(array($this->userObj));
             $mail->setAdditionalInformation(
                 array(
                      '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:

◆ __initForm()

ilAccountRegistrationGUI::__initForm ( )

protected

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

References $DIC, $ilUser, ilUserDefinedFields\_getInstance(), ilRegistrationCode\CODE_LENGTH, ilCustomUserFieldsHelper\getInstance(), IL_REG_ACTIVATION, iljQueryUtil\initjQuery(), ilTermsOfServiceHelper\isEnabled(), ilUserProfile\MODE_REGISTRATION, and ilFormPropertyGUI\setRequired().

Referenced by displayForm(), and saveForm().

     {
         global $DIC;
 
         $ilUser = $DIC->user();
 
         $ilUser->setLanguage($this->lng->getLangKey());
         $ilUser->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 ((bool) $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 = $ilUser->getUserDefinedData();
 
         $user_defined_fields = ilUserDefinedFields::_getInstance();
         $custom_fields = array();
         
         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
         $up = new ilUserProfile();
         $up->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 = array();
         foreach ($this->registration_settings->getAllowedDomains() as $item) {
             if (trim($item)) {
                 $domains[] = $item;
             }
         }
         if (sizeof($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() == 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);
         }
 
 
         if (ilCaptchaUtil::isActiveForRegistration()) {
             $captcha = new ilCaptchaInputGUI($this->lng->txt("captcha_code"), 'captcha_code');
             $captcha->setRequired(true);
             $this->form->addItem($captcha);
         }
 
         $this->form->addCommandButton("saveForm", $this->lng->txt("register"));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ displayForm()

ilAccountRegistrationGUI::displayForm ( )

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

References $tpl, and __initForm().

Referenced by executeCommand(), and saveForm().

     {
 
         $tpl = ilStartUpGUI::initStartUpTemplate(array('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:

◆ doProfileAutoComplete()

ilAccountRegistrationGUI::doProfileAutoComplete ( )

protected

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

References $result, ilJsonUtil\encode(), exit, and ilPublicUserProfileGUI\getAutocompleteResult().

     {
         $field_id = (string) $_REQUEST["f"];
         $term = (string) $_REQUEST["term"];
 
         $result = ilPublicUserProfileGUI::getAutocompleteResult($field_id, $term);
         if (sizeof($result)) {
             echo ilJsonUtil::encode($result);
         }
         
         exit();
     }

Here is the call graph for this function:

◆ executeCommand()

ilAccountRegistrationGUI::executeCommand ( )

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

References $DIC, $ilErr, $tpl, displayForm(), IL_REG_DISABLED, and ilStartUpGUI\printToGlobalTemplate().

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

Here is the call graph for this function:

◆ login()

ilAccountRegistrationGUI::login ( )

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

References $code_was_used, $DIC, Vendor\Package\$f, $tpl, IL_REG_ACTIVATION, IL_REG_APPROVE, IL_REG_CODES, IL_REG_DIRECT, and ilInitialisation\initUserAccount().

Referenced by saveForm().

     {
         global $DIC;
         $f = $DIC->ui()->factory();
         $renderer = $DIC->ui()->renderer();
 
         $tpl = ilStartUpGUI::initStartUpTemplate(array('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() == IL_REG_DIRECT ||
                 $this->registration_settings->getRegistrationType() == IL_REG_CODES ||
                 $this->code_was_used
             ) &&
             !$this->registration_settings->passwordGenerationEnabled()
         ) {
             $tpl->setVariable('TXT_REGISTERED', $this->lng->txt('txt_registered'));
 
             $login_link = $renderer->render($f->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() == IL_REG_APPROVE) {
             $tpl->setVariable('TXT_REGISTERED', $this->lng->txt('txt_submitted'));
         } elseif ($this->registration_settings->getRegistrationType() == 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 235 of file class.ilAccountRegistrationGUI.php.

References $_GET, $_POST, $_SERVER, $code_was_used, $DIC, $email, Vendor\Package\$f, $GLOBALS, $ilSetting, $login, $password, __distributeMails(), __initForm(), ilObjUser\_doesLoginnameExistInHistory(), ilObject\_getAllReferences(), ilUserDefinedFields\_getInstance(), ilObjUser\_loginExists(), ilObjRole\_lookupAllowRegister(), ilObject\_lookupType(), ilUserCreationContext\CONTEXT_REGISTRATION, displayForm(), ilUtil\generatePasswords(), ilRegistrationCode\getCodeData(), ilRegistrationCode\getCodeRole(), ilUserCreationContext\getInstance(), ilSystemSupportContacts\getMailsToAddress(), IL_REG_ACTIVATION, IL_REG_CODES, IL_REG_DIRECT, ilTermsOfServiceHelper\isEnabled(), ilUtil\isLogin(), ilUtil\isPasswordValidForUserContext(), ilRegistrationCode\isValidRegistrationCode(), login(), ilUserProfile\MODE_REGISTRATION, ilUtil\prepareFormOutput(), ilUtil\sendFailure(), ilUtil\sendInfo(), ilUtil\stripSlashes(), and ilRegistrationCode\useCode().

     {
         global $DIC;
 
         $ilSetting = $DIC->settings();
         $rbacreview = $DIC->rbac()->review();
 
         $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 (
                 $this->registration_settings->registrationCodeRequired() ||
                 strlen($code)
             ) {
                 // 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 = (int) ilRegistrationCode::getCodeRole($code);
                     if ($role_id && $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 = array();
                 foreach ($this->registration_settings->getAllowedDomains() as $item) {
                     if (trim($item)) {
                         $domains[] = $item;
                     }
                 }
                 if (sizeof($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() &&
             !ilUtil::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($selected_role)) {
                     $valid_role = (int) $selected_role;
                 }
             }
             // assign by email
             else {
                 $registration_role_assignments = new ilRegistrationRoleAssignments();
                 $valid_role = (int) $registration_role_assignments->getRoleByEmail($this->form->getInput("usr_email"));
             }
         }
 
         // no valid role could be determined
         if (!$valid_role) {
             ilUtil::sendInfo($this->lng->txt("registration_no_valid_role"));
             $form_valid = false;
         }
 
         // validate username
         $login_obj = $this->form->getItemByPostVar('username');
         $login = $this->form->getInput("username");
         $captcha = $this->form->getItemByPostVar("captcha_code");
         if (!ilUtil::isLogin($login)) {
             $login_obj->setAlert($this->lng->txt("login_invalid"));
             $form_valid = false;
         }
 
         if ($form_valid) {
             if (ilObjUser::_loginExists($login)) {
                 if (empty($captcha) || empty($captcha->getAlert())) {
                     $login_obj->setAlert($this->lng->txt("login_exists"));
                 }
                 $form_valid = false;
             } elseif ((int) $ilSetting->get('allow_change_loginname') &&
                 (int) $ilSetting->get('reuse_of_loginnames') == 0 &&
                 ilObjUser::_doesLoginnameExistInHistory($login)) {
                 if (empty($captcha) || empty($captcha->getAlert())) {
                     $login_obj->setAlert($this->lng->txt("login_exists"));
                 }
                 $form_valid = false;
             }
         }
 
         if (!$form_valid) {
             ilUtil::sendFailure($this->lng->txt('form_input_not_valid'));
         } elseif ($showGlobalTermsOfServieFailure) {
             $this->lng->loadLanguageModule('tos');
             \ilUtil::sendFailure(sprintf(
                 $this->lng->txt('tos_account_reg_not_possible'),
                 'mailto:' . ilUtil::prepareFormOutput(ilSystemSupportContacts::getMailsToAddress())
             ));
         } else {
             $password = $this->__createUser($valid_role);
             $this->__distributeMails($password);
             return $this->login();
         }
         $this->form->setValuesByPost();
         return $this->displayForm();
     }