Collaboration diagram for ilAccountRegistrationGUI:

Public Member Functions
	__construct ()

	executeCommand ()

	saveForm ()

Protected Member Functions
	__initForm ()

	__distributeMails ($password)

	doProfileAutoComplete ()

Protected Attributes
	$registration_settings

	$code_enabled

	$code_was_used

	$userObj

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 24 of file class.ilAccountRegistrationGUI.php.

Constructor & Destructor Documentation

◆ __construct()

ilAccountRegistrationGUI::__construct ( )

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

References $ilCtrl, $lng, and $tpl.

     {
         global $ilCtrl,$tpl,$lng;
 
         $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());
     }

Member Function Documentation

◆ __distributeMails()

ilAccountRegistrationGUI::__distributeMails ( $password )

protected

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

References $_GET, $action, $code_was_used, $GLOBALS, $ilSetting, $lng, $password, array, ilSession\get(), ilLoggerFactory\getLogger(), IL_REG_ACTIVATION, IL_REG_APPROVE, IL_REG_CODES, IL_REG_DIRECT, ilSession\set(), ilUtil\stripSlashes(), ilRegistrationMimeMailNotification\TYPE_NOTIFICATION_ACTIVATION, ilRegistrationMailNotification\TYPE_NOTIFICATION_APPROVERS, and ilRegistrationMailNotification\TYPE_NOTIFICATION_CONFIRMATION.

Referenced by saveForm().

     {
         global $ilSetting;
 
         include_once './Services/Language/classes/class.ilLanguage.php';
         include_once './Services/User/classes/class.ilObjUser.php';
         include_once "Services/Mail/classes/class.ilFormatMail.php";
         include_once './Services/Registration/classes/class.ilRegistrationMailNotification.php';
 
         // 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) {
             include_once './Services/Registration/classes/class.ilRegistrationMimeMailNotification.php';
 
             $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 94 of file class.ilAccountRegistrationGUI.php.

References $code, $ilUser, $lng, $options, ilUserDefinedFields\_getInstance(), array, ilRegistrationCode\CODE_LENGTH, ilTermsOfServiceSignableDocumentFactory\getByLanguageObject(), IL_REG_ACTIVATION, iljQueryUtil\initjQuery(), ilTermsOfServiceHelper\isEnabled(), ilUserProfile\MODE_REGISTRATION, ilFormPropertyGUI\setRequired(), UDF_TYPE_SELECT, UDF_TYPE_TEXT, and UDF_TYPE_WYSIWYG.

Referenced by executeCommand(), and saveForm().

     {
         global $lng, $ilUser;
         
         // needed for multi-text-fields (interests)
         include_once 'Services/jQuery/classes/class.iljQueryUtil.php';
         iljQueryUtil::initjQuery();
         
         include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
         $this->form = new ilPropertyFormGUI();
         $this->form->setFormAction($this->ctrl->getFormAction($this));
         
         
         // code handling
         
         if ($this->code_enabled) {
             include_once 'Services/Registration/classes/class.ilRegistrationCode.php';
             $code = new ilTextInputGUI($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($lng->txt("registration_code_required_info"));
             } else {
                 $code->setInfo($lng->txt("registration_code_optional_info"));
             }
             $this->form->addItem($code);
         }
         
 
         // user defined fields
 
         $user_defined_data = $ilUser->getUserDefinedData();
 
         include_once './Services/User/classes/class.ilUserDefinedFields.php';
         $user_defined_fields =&ilUserDefinedFields::_getInstance();
         $custom_fields = array();
         foreach ($user_defined_fields->getRegistrationDefinitions() as $field_id => $definition) {
             if ($definition['field_type'] == UDF_TYPE_TEXT) {
                 $custom_fields["udf_" . $definition['field_id']] =
                     new ilTextInputGUI($definition['field_name'], "udf_" . $definition['field_id']);
                 $custom_fields["udf_" . $definition['field_id']]->setValue($user_defined_data["f_" . $field_id]);
                 $custom_fields["udf_" . $definition['field_id']]->setMaxLength(255);
                 $custom_fields["udf_" . $definition['field_id']]->setSize(40);
             } elseif ($definition['field_type'] == UDF_TYPE_WYSIWYG) {
                 $custom_fields["udf_" . $definition['field_id']] =
                     new ilTextAreaInputGUI($definition['field_name'], "udf_" . $definition['field_id']);
                 $custom_fields["udf_" . $definition['field_id']]->setValue($user_defined_data["f_" . $field_id]);
                 $custom_fields["udf_" . $definition['field_id']]->setUseRte(true);
             } else {
                 $custom_fields["udf_" . $definition['field_id']] =
                     new ilSelectInputGUI($definition['field_name'], "udf_" . $definition['field_id']);
                 $custom_fields["udf_" . $definition['field_id']]->setValue($user_defined_data["f_" . $field_id]);
                 $custom_fields["udf_" . $definition['field_id']]->setOptions(
                     $user_defined_fields->fieldValuesToSelectArray($definition['field_values'])
                 );
             }
             if ($definition['required']) {
                 $custom_fields["udf_" . $definition['field_id']]->setRequired(true);
             }
 
             if ($definition['field_type'] == UDF_TYPE_SELECT && !$user_defined_data["f_" . $field_id]) {
                 $options = $custom_fields["udf_" . $definition['field_id']]->getOptions();
                 $custom_fields["udf_" . $definition['field_id']]->setOptions($options);
             }
         }
 
         // standard fields
         include_once("./Services/User/classes/class.ilUserProfile.php");
         $up = new ilUserProfile();
         $up->setMode(ilUserProfile::MODE_REGISTRATION);
         $up->skipGroup("preferences");
         
         $up->setAjaxCallback(
             $this->ctrl->getLinkTarget($this, 'doProfileAutoComplete', '', true)
         );
 
         $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($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($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(
                 $lng->txt("reg_email_domains"),
                 implode(", ", $domains)
             ) . "<br />" .
                 ($this->code_enabled ? $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);
             }
         }
 
         require_once 'Services/TermsOfService/classes/class.ilTermsOfServiceSignableDocumentFactory.php';
         $document = ilTermsOfServiceSignableDocumentFactory::getByLanguageObject($lng);
         if (ilTermsOfServiceHelper::isEnabled() && $document->exists()) {
             $field = new ilFormSectionHeaderGUI();
             $field->setTitle($lng->txt('usr_agreement'));
             $this->form->addItem($field);
 
             $field = new ilCustomInputGUI();
             $field->setHTML('<div id="agreement">' . $document->getContent() . '</div>');
             $this->form->addItem($field);
 
             $field = new ilCheckboxInputGUI($lng->txt('accept_usr_agreement'), 'accept_terms_of_service');
             $field->setRequired(true);
             $field->setValue(1);
             $this->form->addItem($field);
         }
 
         require_once 'Services/Captcha/classes/class.ilCaptchaUtil.php';
         if (ilCaptchaUtil::isActiveForRegistration()) {
             require_once 'Services/Captcha/classes/class.ilCaptchaInputGUI.php';
             $captcha = new ilCaptchaInputGUI($lng->txt("captcha_code"), 'captcha_code');
             $captcha->setRequired(true);
             $this->form->addItem($captcha);
         }
 
         $this->form->addCommandButton("saveForm", $lng->txt("register"));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doProfileAutoComplete()

ilAccountRegistrationGUI::doProfileAutoComplete ( )

protected

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

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

     {
         $field_id = (string) $_REQUEST["f"];
         $term = (string) $_REQUEST["term"];
                 
         include_once "Services/User/classes/class.ilPublicUserProfileGUI.php";
         $result = ilPublicUserProfileGUI::getAutocompleteResult($field_id, $term);
         if (sizeof($result)) {
             include_once 'Services/JSON/classes/class.ilJsonUtil.php';
             echo ilJsonUtil::encode($result);
         }
         
         exit();
     }

Here is the call graph for this function:

◆ executeCommand()

ilAccountRegistrationGUI::executeCommand ( )

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

References $ilErr, $lng, $tpl, __initForm(), array, and IL_REG_DISABLED.

     {
         global $ilErr, $tpl;
 
         if ($this->registration_settings->getRegistrationType() == IL_REG_DISABLED) {
             $ilErr->raiseError($this->lng->txt('reg_disabled'), $ilErr->FATAL);
         }
 
         $next_class = $this->ctrl->getNextClass($this);
         $cmd = $this->ctrl->getCmd();
 
         switch ($next_class) {
             default:
                 if ($cmd) {
                     $this->$cmd();
                 } else {
                     $this->displayForm();
                 }
                 break;
         }
         $tpl->setPermanentLink('usr', null, 'registration');
         $tpl->show();
         return true;
     }

Here is the call graph for this function:

◆ saveForm()

ilAccountRegistrationGUI::saveForm ( )

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

References $_GET, $_POST, $_SERVER, $code, $code_was_used, $domain, $email, $GLOBALS, $ilSetting, $lng, $password, __distributeMails(), __initForm(), ilObjUser\_addDesktopItem(), ilObjUser\_doesLoginnameExistInHistory(), ilObject\_getAllReferences(), ilUserDefinedFields\_getInstance(), ilObjUser\_loginExists(), ilObjRole\_lookupAllowRegister(), ilObject\_lookupType(), array, ilUserCreationContext\CONTEXT_REGISTRATION, ilUtil\generatePasswords(), ilTermsOfServiceSignableDocumentFactory\getByLanguageObject(), ilRegistrationCode\getCodeData(), ilRegistrationCode\getCodeRole(), ilUserCreationContext\getInstance(), IL_REG_ACTIVATION, IL_REG_CODES, IL_REG_DIRECT, ilTermsOfServiceHelper\isEnabled(), ilUtil\isLogin(), ilUtil\isPasswordValidForUserContext(), ilRegistrationCode\isValidRegistrationCode(), ilUserProfile\MODE_REGISTRATION, ilUtil\sendFailure(), ilUtil\sendInfo(), ilUtil\stripSlashes(), time, ilTermsOfServiceHelper\trackAcceptance(), and ilRegistrationCode\useCode().

     {
         global $lng, $ilSetting, $rbacreview;
 
         $this->__initForm();
         $form_valid = $this->form->checkInput();
         
         require_once 'Services/User/classes/class.ilObjUser.php';
         
         // 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
                 include_once './Services/Registration/classes/class.ilRegistrationCode.php';
                 if (!ilRegistrationCode::isValidRegistrationCode($code)) {
                     $code_obj = $this->form->getItemByPostVar('usr_registration_code');
                     $code_obj->setAlert($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(
                             $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($lng->txt($error_lng_var));
             $form_valid = 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($lng->txt('force_accept_usr_agreement'));
             } else {
                 ilUtil::sendFailure($lng->txt('force_accept_usr_agreement'));
             }
             $form_valid = false;
         }
 
         // no need if role is attached to code
         if (!$valid_role) {
             // manual selection
             if ($this->registration_settings->roleSelectionEnabled()) {
                 include_once "./Services/AccessControl/classes/class.ilObjRole.php";
                 $selected_role = $this->form->getInput("usr_roles");
                 if ($selected_role && ilObjRole::_lookupAllowRegister($selected_role)) {
                     $valid_role = (int) $selected_role;
                 }
             }
             // assign by email
             else {
                 include_once 'Services/Registration/classes/class.ilRegistrationEmailRoleAssignments.php';
                 $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($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($lng->txt("login_invalid"));
             $form_valid = false;
         } elseif (ilObjUser::_loginExists($login)) {
             if(!empty($captcha) && empty($captcha->getAlert()) || empty($captcha)) {
                 $login_obj->setAlert($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()) || empty($captcha)) {
                 $login_obj->setAlert($lng->txt("login_exists"));
             }
             $form_valid = false;
         }
 
         if (!$form_valid) {
             ilUtil::sendFailure($lng->txt('form_input_not_valid'));
         } else {
             $password = $this->__createUser($valid_role);
             $this->__distributeMails($password);
             $this->login($password);
             return true;
         }
 
         $this->form->setValuesByPost();
         $this->displayForm();
         return false;
     }