class.ilPersonalProfileGUI.php

Go to the documentation of this file.

<?php
/* Copyright (c) 1998-2009 ILIAS open source, Extended GPL, see docs/LICENSE */

class ilPersonalProfileGUI
{
    public $tpl;
    public $lng;
    public $ilias;
    public $ctrl;

    public $user_defined_fields = null;

    protected $tabs;

    protected $termsOfServiceEvaluation;

    public function __construct(
        \ilTermsOfServiceDocumentEvaluation $termsOfServiceEvaluation = null
    ) {
        global $DIC;

        $ilias = $DIC['ilias'];
        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $this->tabs = $DIC->tabs();

        if ($termsOfServiceEvaluation === null) {
            $termsOfServiceEvaluation = $DIC['tos.document.evaluator'];
        }
        $this->termsOfServiceEvaluation = $termsOfServiceEvaluation;

        include_once './Services/User/classes/class.ilUserDefinedFields.php';
        $this->user_defined_fields = &ilUserDefinedFields::_getInstance();

        $this->tpl = $tpl;
        $this->lng = $lng;
        $this->ilias = $ilias;
        $this->ctrl = $ilCtrl;
        $this->settings = $ilias->getAllSettings();
        $lng->loadLanguageModule("jsmath");
        $lng->loadLanguageModule("pd");
        $this->upload_error = "";
        $this->password_error = "";
        $lng->loadLanguageModule("user");
        $ilCtrl->saveParameter($this, "prompted");
        // $ilCtrl->saveParameter($this, "user_page");
    }

    public function executeCommand()
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $ilTabs = $DIC['ilTabs'];
        $lng = $DIC['lng'];
        
        $next_class = $this->ctrl->getNextClass();

        switch ($next_class) {
            case "ilpublicuserprofilegui":
                include_once("./Services/User/classes/class.ilPublicUserProfileGUI.php");
                $_GET["user_id"] = $ilUser->getId();
                $pub_profile_gui = new ilPublicUserProfileGUI($_GET["user_id"]);
                $pub_profile_gui->setBackUrl($ilCtrl->getLinkTarget($this, "showPersonalData"));
                $ilCtrl->forwardCommand($pub_profile_gui);
                $tpl->show();
                break;

            case 'ilcertificatemigrationgui':
                $migrationGui = new \ilCertificateMigrationGUI();
                $resultMessageString = $ilCtrl->forwardCommand($migrationGui);
                $tpl->setMessage(\ilTemplate::MESSAGE_TYPE_SUCCESS, $resultMessageString, true);
                $this->setTabs();
                $this->showPersonalData(false, true);
                break;
            
            default:
                $this->setTabs();
                $cmd = $this->ctrl->getCmd("showPersonalData");
                $this->$cmd();
                break;
        }
        return true;
    }


    public function workWithUserSetting($setting)
    {
        $result = true;
        if ($this->settings["usr_settings_hide_" . $setting] == 1) {
            $result = false;
        }
        if ($this->settings["usr_settings_disable_" . $setting] == 1) {
            $result = false;
        }
        return $result;
    }

    public function userSettingVisible($setting)
    {
        $result = true;
        if (isset($this->settings["usr_settings_hide_" . $setting]) &&
            $this->settings["usr_settings_hide_" . $setting] == 1) {
            $result = false;
        }
        return $result;
    }

    public function userSettingEnabled($setting)
    {
        $result = true;
        if ($this->settings["usr_settings_disable_" . $setting] == 1) {
            $result = false;
        }
        return $result;
    }

    public function uploadUserPicture()
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];

        if ($this->workWithUserSetting("upload")) {
            if (!$this->form->hasFileUpload("userfile")) {
                if ($this->form->getItemByPostVar("userfile")->getDeletionFlag()) {
                    $ilUser->removeUserPicture();
                }
                return;
            } else {
                $webspace_dir = ilUtil::getWebspaceDir();
                $image_dir = $webspace_dir . "/usr_images";
                $store_file = "usr_" . $ilUser->getID() . "." . "jpg";

                // store filename
                $ilUser->setPref("profile_image", $store_file);
                $ilUser->update();

                // move uploaded file

                $pi = pathinfo($_FILES["userfile"]["name"]);
                $uploaded_file = $this->form->moveFileUpload(
                    $image_dir,
                    "userfile",
                    "upload_" . $ilUser->getId() . "." . $pi["extension"]
                );
                if (!$uploaded_file) {
                    ilUtil::sendFailure($this->lng->txt("upload_error", true));
                    $this->ctrl->redirect($this, "showProfile");
                }
                chmod($uploaded_file, 0770);

                // take quality 100 to avoid jpeg artefacts when uploading jpeg files
                // taking only frame [0] to avoid problems with animated gifs
                $show_file = "$image_dir/usr_" . $ilUser->getId() . ".jpg";
                $thumb_file = "$image_dir/usr_" . $ilUser->getId() . "_small.jpg";
                $xthumb_file = "$image_dir/usr_" . $ilUser->getId() . "_xsmall.jpg";
                $xxthumb_file = "$image_dir/usr_" . $ilUser->getId() . "_xxsmall.jpg";
                $uploaded_file = ilUtil::escapeShellArg($uploaded_file);
                $show_file = ilUtil::escapeShellArg($show_file);
                $thumb_file = ilUtil::escapeShellArg($thumb_file);
                $xthumb_file = ilUtil::escapeShellArg($xthumb_file);
                $xxthumb_file = ilUtil::escapeShellArg($xxthumb_file);
                
                if (ilUtil::isConvertVersionAtLeast("6.3.8-3")) {
                    ilUtil::execConvert($uploaded_file . "[0] -geometry 200x200^ -gravity center -extent 200x200 -quality 100 JPEG:" . $show_file);
                    ilUtil::execConvert($uploaded_file . "[0] -geometry 100x100^ -gravity center -extent 100x100 -quality 100 JPEG:" . $thumb_file);
                    ilUtil::execConvert($uploaded_file . "[0] -geometry 75x75^ -gravity center -extent 75x75 -quality 100 JPEG:" . $xthumb_file);
                    ilUtil::execConvert($uploaded_file . "[0] -geometry 30x30^ -gravity center -extent 30x30 -quality 100 JPEG:" . $xxthumb_file);
                } else {
                    ilUtil::execConvert($uploaded_file . "[0] -geometry 200x200 -quality 100 JPEG:" . $show_file);
                    ilUtil::execConvert($uploaded_file . "[0] -geometry 100x100 -quality 100 JPEG:" . $thumb_file);
                    ilUtil::execConvert($uploaded_file . "[0] -geometry 75x75 -quality 100 JPEG:" . $xthumb_file);
                    ilUtil::execConvert($uploaded_file . "[0] -geometry 30x30 -quality 100 JPEG:" . $xxthumb_file);
                }
            }
        }

        //              $this->saveProfile();
    }

    public function removeUserPicture()
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];

        $ilUser->removeUserPicture();

        $this->saveProfile();
    }



    public function saveProfile()
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $ilSetting = $DIC['ilSetting'];

        //init checking var
        $form_valid = true;

        // testing by ratana ty:
        // if people check on check box it will
        // write some datata to table usr_pref
        // if check on Public Profile
        if (($_POST["chk_pub"]) == "on") {
            $ilUser->setPref("public_profile", "y");
        } else {
            $ilUser->setPref("public_profile", "n");
        }

        // if check on Institute
        $val_array = array("institution", "department", "upload", "street",
            "zip", "city", "country", "phone_office", "phone_home", "phone_mobile",
            "fax", "email", "second_email", "hobby", "matriculation");

        // set public profile preferences
        foreach ($val_array as $key => $value) {
            if (($_POST["chk_" . $value]) == "on") {
                $ilUser->setPref("public_" . $value, "y");
            } else {
                $ilUser->setPref("public_" . $value, "n");
            }
        }

        // check dynamically required fields
        foreach ($this->settings as $key => $val) {
            if (substr($key, 0, 8) == "require_") {
                $require_keys[] = substr($key, 8);
            }
        }

        foreach ($require_keys as $key => $val) {
            // exclude required system and registration-only fields
            $system_fields = array("login", "default_role", "passwd", "passwd2");
            if (!in_array($val, $system_fields)) {
                if ($this->workWithUserSetting($val)) {
                    if (isset($this->settings["require_" . $val]) && $this->settings["require_" . $val]) {
                        if (empty($_POST["usr_" . $val])) {
                            ilUtil::sendFailure($this->lng->txt("fill_out_all_required_fields") . ": " . $this->lng->txt($val));
                            $form_valid = false;
                        }
                    }
                }
            }
        }

        // Check user defined required fields
        if ($form_valid and !$this->__checkUserDefinedRequiredFields()) {
            ilUtil::sendFailure($this->lng->txt("fill_out_all_required_fields"));
            $form_valid = false;
        }

        // check email
        if ($this->workWithUserSetting("email")) {
            if (!ilUtil::is_email($_POST["usr_email"]) and !empty($_POST["usr_email"]) and $form_valid) {
                ilUtil::sendFailure($this->lng->txt("email_not_valid"));
                $form_valid = false;
            }
        }
        // check second email
        if ($this->workWithUserSetting("second_email")) {
            if (!ilUtil::is_email($_POST["usr_second_email"]) and !empty($_POST["usr_second_email"]) and $form_valid) {
                ilUtil::sendFailure($this->lng->txt("second_email_not_valid"));
                $form_valid = false;
            }
        }

        //update user data (not saving!)
        if ($this->workWithUserSetting("firstname")) {
            $ilUser->setFirstName(ilUtil::stripSlashes($_POST["usr_firstname"]));
        }
        if ($this->workWithUserSetting("lastname")) {
            $ilUser->setLastName(ilUtil::stripSlashes($_POST["usr_lastname"]));
        }
        if ($this->workWithUserSetting("gender")) {
            $ilUser->setGender($_POST["usr_gender"]);
        }
        if ($this->workWithUserSetting("title")) {
            $ilUser->setUTitle(ilUtil::stripSlashes($_POST["usr_title"]));
        }
        $ilUser->setFullname();
        if ($this->workWithUserSetting("institution")) {
            $ilUser->setInstitution(ilUtil::stripSlashes($_POST["usr_institution"]));
        }
        if ($this->workWithUserSetting("department")) {
            $ilUser->setDepartment(ilUtil::stripSlashes($_POST["usr_department"]));
        }
        if ($this->workWithUserSetting("street")) {
            $ilUser->setStreet(ilUtil::stripSlashes($_POST["usr_street"]));
        }
        if ($this->workWithUserSetting("zipcode")) {
            $ilUser->setZipcode(ilUtil::stripSlashes($_POST["usr_zipcode"]));
        }
        if ($this->workWithUserSetting("city")) {
            $ilUser->setCity(ilUtil::stripSlashes($_POST["usr_city"]));
        }
        if ($this->workWithUserSetting("country")) {
            $ilUser->setCountry(ilUtil::stripSlashes($_POST["usr_country"]));
        }
        if ($this->workWithUserSetting("phone_office")) {
            $ilUser->setPhoneOffice(ilUtil::stripSlashes($_POST["usr_phone_office"]));
        }
        if ($this->workWithUserSetting("phone_home")) {
            $ilUser->setPhoneHome(ilUtil::stripSlashes($_POST["usr_phone_home"]));
        }
        if ($this->workWithUserSetting("phone_mobile")) {
            $ilUser->setPhoneMobile(ilUtil::stripSlashes($_POST["usr_phone_mobile"]));
        }
        if ($this->workWithUserSetting("fax")) {
            $ilUser->setFax(ilUtil::stripSlashes($_POST["usr_fax"]));
        }
        if ($this->workWithUserSetting("email")) {
            $ilUser->setEmail(ilUtil::stripSlashes($_POST["usr_email"]));
        }
        if ($this->workWithUserSetting("second_email")) {
            $ilUser->setSecondEmail(ilUtil::stripSlashes($_POST["usr_second_email"]));
        }
        if ($this->workWithUserSetting("hobby")) {
            $ilUser->setHobby(ilUtil::stripSlashes($_POST["usr_hobby"]));
        }
        if ($this->workWithUserSetting("referral_comment")) {
            $ilUser->setComment(ilUtil::stripSlashes($_POST["usr_referral_comment"]));
        }
        if ($this->workWithUserSetting("matriculation")) {
            $ilUser->setMatriculation(ilUtil::stripSlashes($_POST["usr_matriculation"]));
        }

        // Set user defined data
        $ilUser->setUserDefinedData($_POST['udf']);

        // everthing's ok. save form data
        if ($form_valid) {
            // init reload var. page should only be reloaded if skin or style were changed
            $reload = false;

            if ($this->workWithUserSetting("skin_style")) {
                //set user skin and style
                if ($_POST["usr_skin_style"] != "") {
                    $sknst = explode(":", $_POST["usr_skin_style"]);

                    if ($ilUser->getPref("style") != $sknst[1] ||
                        $ilUser->getPref("skin") != $sknst[0]) {
                        $ilUser->setPref("skin", $sknst[0]);
                        $ilUser->setPref("style", $sknst[1]);
                        $reload = true;
                    }
                }
            }

            if ($this->workWithUserSetting("language")) {
                // reload page if language was changed
                //if ($_POST["usr_language"] != "" and $_POST["usr_language"] != $_SESSION['lang'])
                // (this didn't work as expected, alex)
                if ($_POST["usr_language"] != $ilUser->getLanguage()) {
                    $reload = true;
                }

                // set user language
                $ilUser->setLanguage($_POST["usr_language"]);
            }
            if ($this->workWithUserSetting("hits_per_page")) {
                // set user hits per page
                if ($_POST["hits_per_page"] != "") {
                    $ilUser->setPref("hits_per_page", $_POST["hits_per_page"]);
                }
            }

            // set show users online
            /*if ($this->workWithUserSetting("show_users_online"))
            {
                $ilUser->setPref("show_users_online", $_POST["show_users_online"]);
            }*/

            // set hide own online_status
            if ($this->workWithUserSetting("hide_own_online_status")) {
                if ($_POST["chk_hide_own_online_status"] != "") {
                    $ilUser->setPref("hide_own_online_status", "y");
                } else {
                    $ilUser->setPref("hide_own_online_status", "n");
                }
            }

            // personal desktop items in news block
            /* Subscription Concept is abandonded for now, we show all news of pd items (Alex)
                        if ($_POST["pd_items_news"] != "")
                        {
                            $ilUser->setPref("pd_items_news","y");
                        }
                        else
                        {
                            $ilUser->setPref("pd_items_news","n");
                        }
            */

            // profile ok
            $ilUser->setProfileIncomplete(false);

            // save user data & object_data
            $ilUser->setTitle($ilUser->getFullname());
            $ilUser->setDescription($ilUser->getEmail());

            $ilUser->update();
            
            // update lucene index
            include_once './Services/Search/classes/Lucene/class.ilLuceneIndexer.php';
            ilLuceneIndexer::updateLuceneIndex(array($GLOBALS['DIC']['ilUser']->getId()));
            

            // reload page only if skin or style were changed
            // feedback
            if (!empty($this->password_error)) {
                ilUtil::sendFailure($this->password_error, true);
            } elseif (!empty($this->upload_error)) {
                ilUtil::sendFailure($this->upload_error, true);
            } elseif ($reload) {
                // feedback
                ilUtil::sendSuccess($this->lng->txt("saved_successfully"), true);
                $this->ctrl->redirect($this, "");
            } else {
                ilUtil::sendSuccess($this->lng->txt("saved_successfully"), true);
            }
        }

        $this->showProfile();
    }
    
    public function showProfile()
    {
        $this->showPersonalData();
    }
    
    protected function showUserAgreement()
    {
        $this->tabs->clearTargets();
        $this->tabs->clearSubTabs();

        $tpl = new \ilTemplate('tpl.view_terms_of_service.html', true, true, 'Services/Init');

        $this->tpl->setTitle($this->lng->txt('usr_agreement'));

        $handleDocument = \ilTermsOfServiceHelper::isEnabled() && $this->termsOfServiceEvaluation->hasDocument();
        if ($handleDocument) {
            $document = $this->termsOfServiceEvaluation->document();
            $tpl->setVariable('TERMS_OF_SERVICE_CONTENT', $document->content());
        } else {
            $tpl->setVariable(
                'TERMS_OF_SERVICE_CONTENT',
                sprintf(
                    $this->lng->txt('no_agreement_description'),
                    'mailto:' . ilUtil::prepareFormOutput(ilSystemSupportContacts::getMailToAddress())
                )
            );
        }

        $this->tpl->setContent($tpl->get());
        $this->tpl->setPermanentLink('usr', null, 'agreement');
        $this->tpl->show();
    }
    
    public function addLocationToForm(ilPropertyFormGUI $a_form, ilObjUser $a_user)
    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];

        // check map activation
        include_once("./Services/Maps/classes/class.ilMapUtil.php");
        if (!ilMapUtil::isActivated()) {
            return;
        }
        
        // Don't really know if this is still necessary...
        $this->lng->loadLanguageModule("maps");

        // Get user settings
        $latitude = $a_user->getLatitude();
        $longitude = $a_user->getLongitude();
        $zoom = $a_user->getLocationZoom();
        
        // Get Default settings, when nothing is set
        if ($latitude == 0 && $longitude == 0 && $zoom == 0) {
            $def = ilMapUtil::getDefaultSettings();
            $latitude = $def["latitude"];
            $longitude = $def["longitude"];
            $zoom = $def["zoom"];
        }
        
        $street = $a_user->getStreet();
        if (!$street) {
            $street = $this->lng->txt("street");
        }
        $city = $a_user->getCity();
        if (!$city) {
            $city = $this->lng->txt("city");
        }
        $country = $a_user->getCountry();
        if (!$country) {
            $country = $this->lng->txt("country");
        }
        
        // location property
        $loc_prop = new ilLocationInputGUI(
            $this->lng->txt("location"),
            "location"
        );
        $loc_prop->setLatitude($latitude);
        $loc_prop->setLongitude($longitude);
        $loc_prop->setZoom($zoom);
        $loc_prop->setAddress($street . "," . $city . "," . $country);
        
        $a_form->addItem($loc_prop);
    }

    // init sub tabs
    public function setTabs()
    {
        global $DIC;

        $ilTabs = $DIC['ilTabs'];
        $ilUser = $DIC['ilUser'];
        $ilHelp = $DIC['ilHelp'];

        $ilHelp->setScreenIdComponent("user");
        
        // personal data
        $ilTabs->addTab(
            "personal_data",
            $this->lng->txt("personal_data"),
            $this->ctrl->getLinkTarget($this, "showPersonalData")
        );
        
        // public profile
        $ilTabs->addTab(
            "public_profile",
            $this->lng->txt("public_profile"),
            $this->ctrl->getLinkTarget($this, "showPublicProfile")
        );

        // export
        $ilTabs->addTab(
            "export",
            $this->lng->txt("export") . "/" . $this->lng->txt("import"),
            $this->ctrl->getLinkTarget($this, "showExportImport")
        );

        // #17570
        if (($ilUser->getPref("public_profile") &&
            $ilUser->getPref("public_profile") != "n") ||
            $this->getProfilePortfolio()) {
            // profile preview
            $ilTabs->addNonTabbedLink(
                "profile_preview",
                $this->lng->txt("user_profile_preview"),
                $this->ctrl->getLinkTargetByClass("ilpublicuserprofilegui", "view")
            );
        }
    }


    public function __showOtherInformations()
    {
        $d_set = new ilSetting("delicous");
        if ($this->userSettingVisible("matriculation") or count($this->user_defined_fields->getVisibleDefinitions())
            or $d_set->get("user_profile") == "1") {
            return true;
        }
        return false;
    }

    public function __showUserDefinedFields()
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];

        $user_defined_data = $ilUser->getUserDefinedData();
        foreach ($this->user_defined_fields->getVisibleDefinitions() as $field_id => $definition) {
            if ($definition['field_type'] == UDF_TYPE_TEXT) {
                $this->tpl->setCurrentBlock("field_text");
                $this->tpl->setVariable("FIELD_VALUE", ilUtil::prepareFormOutput($user_defined_data[$field_id]));
                if (!$definition['changeable']) {
                    $this->tpl->setVariable("DISABLED_FIELD", 'disabled=\"disabled\"');
                    $this->tpl->setVariable("FIELD_NAME", 'udf[' . $definition['field_id'] . ']');
                } else {
                    $this->tpl->setVariable("FIELD_NAME", 'udf[' . $definition['field_id'] . ']');
                }
                $this->tpl->parseCurrentBlock();
            } else {
                if ($definition['changeable']) {
                    $name = 'udf[' . $definition['field_id'] . ']';
                    $disabled = false;
                } else {
                    $name = '';
                    $disabled = true;
                }
                $this->tpl->setCurrentBlock("field_select");
                $this->tpl->setVariable("SELECT_BOX", ilUtil::formSelect(
                    $user_defined_data[$field_id],
                    $name,
                    $this->user_defined_fields->fieldValuesToSelectArray(
                        $definition['field_values']
                    ),
                    false,
                    true,
                    0,
                    '',
                    '',
                    $disabled
                ));
                $this->tpl->parseCurrentBlock();
            }
            $this->tpl->setCurrentBlock("user_defined");

            if ($definition['required']) {
                $name = $definition['field_name'] . "<span class=\"asterisk\">*</span>";
            } else {
                $name = $definition['field_name'];
            }
            $this->tpl->setVariable("TXT_FIELD_NAME", $name);
            $this->tpl->parseCurrentBlock();
        }
        return true;
    }

    public function __checkUserDefinedRequiredFields()
    {
        foreach ($this->user_defined_fields->getVisibleDefinitions() as $definition) {
            $field_id = $definition['field_id'];
            if ($definition['required'] and !strlen($_POST['udf'][$field_id])) {
                return false;
            }
        }
        return true;
    }

    public function setHeader()
    {
        $this->tpl->setTitle($this->lng->txt('personal_profile'));
    }

    //
    //
    //  PERSONAL DATA FORM
    //
    //
    
    public function showPersonalData($a_no_init = false, $a_migration_started = false)
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        $ilTabs = $DIC['ilTabs'];
        $prompt_service = new ilUserProfilePromptService();

        $ilTabs->activateTab("personal_data");
        $ctrl = $DIC->ctrl();

        $setting = new ilSetting("user");
        $it = "";
        if ($_GET["prompted"] == 1) {
            $it = $prompt_service->data()->getSettings()->getPromptText($ilUser->getLanguage());
        }
        if ($it == "") {
            $it = $prompt_service->data()->getSettings()->getInfoText($ilUser->getLanguage());
        }
        if (trim($it) != "") {
            $pub_prof = in_array($ilUser->prefs["public_profile"], array("y", "n", "g"))
                ? $ilUser->prefs["public_profile"]
                : "n";
            if ($pub_prof == "n") {
                $button = $DIC->ui()->factory()->button()->shy(
                    "» " . $lng->txt("user_make_profile_public"),
                    $ctrl->getLinkTarget($this, "showPublicProfile")
                );
                $it .= "<br><br>" . $DIC->ui()->renderer()->render($button);
            }
            
            ilUtil::sendInfo(nl2br($it));
        }

        $this->setHeader();

        if (!$a_no_init) {
            $this->initPersonalDataForm();
            // catch feedback message
            if ($ilUser->getProfileIncomplete()) {
                ilUtil::sendInfo($lng->txt("profile_incomplete"));
            }
        }

        $this->renderCertificateMigration($ilUser, $a_migration_started);

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

        $this->tpl->show();
    }

    public function initPersonalDataForm()
    {
        global $DIC;

        $ilSetting = $DIC['ilSetting'];
        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];
        $styleDefinition = $DIC['styleDefinition'];
        $rbacreview = $DIC['rbacreview'];

        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->form = new ilPropertyFormGUI();
        $this->form->setFormAction($this->ctrl->getFormAction($this));
        
        // user defined fields
        $user_defined_data = $ilUser->getUserDefinedData();

        
        foreach ($this->user_defined_fields->getVisibleDefinitions() as $field_id => $definition) {
            $value = $user_defined_data["f_" . $field_id];
            
            include_once './Services/User/classes/class.ilCustomUserFieldsHelper.php';
            $fprop = ilCustomUserFieldsHelper::getInstance()->getFormPropertyForDefinition(
                $definition,
                $definition['changeable'],
                $value
            );
            if ($fprop instanceof ilFormPropertyGUI) {
                $this->input['udf_' . $definition['field_id']] = $fprop;
            }
        }
        
        // standard fields
        include_once("./Services/User/classes/class.ilUserProfile.php");
        $up = new ilUserProfile();
        $up->skipField("password");
        $up->skipGroup("settings");
        $up->skipGroup("preferences");
        
        $up->setAjaxCallback(
            $this->ctrl->getLinkTargetByClass('ilPublicUserProfileGUI', 'doProfileAutoComplete', '', true)
        );
        
        // standard fields
        $up->addStandardFieldsToForm($this->form, $ilUser, $this->input);
        
        $this->addLocationToForm($this->form, $ilUser);

        $this->form->addCommandButton("savePersonalData", $lng->txt("save"));
    }

    public function savePersonalData()
    {
        global $DIC;

        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilUser = $DIC['ilUser'];
        $ilSetting = $DIC['ilSetting'];
    
        $this->initPersonalDataForm();
        if ($this->form->checkInput()) {
            $form_valid = true;
            
            // if form field name differs from setter
            $map = array(
                "firstname" => "FirstName",
                "lastname" => "LastName",
                "title" => "UTitle",
                "sel_country" => "SelectedCountry",
                "phone_office" => "PhoneOffice",
                "phone_home" => "PhoneHome",
                "phone_mobile" => "PhoneMobile",
                "referral_comment" => "Comment",
                "interests_general" => "GeneralInterests",
                "interests_help_offered" => "OfferingHelp",
                "interests_help_looking" => "LookingForHelp"
            );
            include_once("./Services/User/classes/class.ilUserProfile.php");
            $up = new ilUserProfile();
            foreach ($up->getStandardFields() as $f => $p) {
                // if item is part of form, it is currently valid (if not disabled)
                $item = $this->form->getItemByPostVar("usr_" . $f);
                if ($item && !$item->getDisabled()) {
                    $value = $this->form->getInput("usr_" . $f);
                    switch ($f) {
                        case "birthday":
                            $value = $item->getDate();
                            $ilUser->setBirthday($value
                                ? $value->get(IL_CAL_DATE)
                                : "");
                            break;
                        case "second_email":
                            $ilUser->setSecondEmail($value);
                            break;
                        default:
                            $m = ucfirst($f);
                            if (isset($map[$f])) {
                                $m = $map[$f];
                            }
                            $ilUser->{"set" . $m}($value);
                            break;
                    }
                }
            }
            $ilUser->setFullname();

            // check map activation
            include_once("./Services/Maps/classes/class.ilMapUtil.php");
            if (ilMapUtil::isActivated()) {
                // #17619 - proper escaping
                $location = $this->form->getInput("location");
                $lat = ilUtil::stripSlashes($location["latitude"]);
                $long = ilUtil::stripSlashes($location["longitude"]);
                $zoom = ilUtil::stripSlashes($location["zoom"]);
                $ilUser->setLatitude(is_numeric($lat) ? $lat : null);
                $ilUser->setLongitude(is_numeric($long) ? $long : null);
                $ilUser->setLocationZoom(is_numeric($zoom) ? $zoom : null);
            }
            
            // Set user defined data
            $defs = $this->user_defined_fields->getVisibleDefinitions();
            $udf = array();
            foreach ($defs as $definition) {
                $f = "udf_" . $definition['field_id'];
                $item = $this->form->getItemByPostVar($f);
                if ($item && !$item->getDisabled()) {
                    $udf[$definition['field_id']] = $this->form->getInput($f);
                }
            }
            $ilUser->setUserDefinedData($udf);
        
            // if loginname is changeable -> validate
            $un = $this->form->getInput('username');
            if ((int) $ilSetting->get('allow_change_loginname') &&
               $un != $ilUser->getLogin()) {
                if (!strlen($un) || !ilUtil::isLogin($un)) {
                    ilUtil::sendFailure($lng->txt('form_input_not_valid'));
                    $this->form->getItemByPostVar('username')->setAlert($this->lng->txt('login_invalid'));
                    $form_valid = false;
                } elseif (ilObjUser::_loginExists($un, $ilUser->getId())) {
                    ilUtil::sendFailure($lng->txt('form_input_not_valid'));
                    $this->form->getItemByPostVar('username')->setAlert($this->lng->txt('loginname_already_exists'));
                    $form_valid = false;
                } else {
                    $ilUser->setLogin($un);
                    
                    try {
                        $ilUser->updateLogin($ilUser->getLogin());
                    } catch (ilUserException $e) {
                        ilUtil::sendFailure($lng->txt('form_input_not_valid'));
                        $this->form->getItemByPostVar('username')->setAlert($e->getMessage());
                        $form_valid = false;
                    }
                }
            }

            // everthing's ok. save form data
            if ($form_valid) {
                $this->uploadUserPicture();
                
                // profile ok
                $ilUser->setProfileIncomplete(false);
    
                // save user data & object_data
                $ilUser->setTitle($ilUser->getFullname());
                $ilUser->setDescription($ilUser->getEmail());
    
                $ilUser->update();
                
                ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);

                $ilCtrl->redirect($this, "showPublicProfile");
            }
        }
        
        $this->form->setValuesByPost();
        $this->showPersonalData(true);
    }
    
    //
    //
    //  PUBLIC PROFILE FORM
    //
    //
    
    public function showPublicProfile($a_no_init = false)
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $lng = $DIC['lng'];
        $ilSetting = $DIC['ilSetting'];
        $ilTabs = $DIC['ilTabs'];
        
        $ilTabs->activateTab("public_profile");

        $this->setHeader();

        if (!$a_no_init) {
            $this->initPublicProfileForm();
        }
        
        $ptpl = new ilTemplate("tpl.edit_personal_profile.html", true, true, "Services/User");
        $ptpl->setVariable("FORM", $this->form->getHTML());
        include_once("./Services/User/classes/class.ilPublicUserProfileGUI.php");
        $pub_profile = new ilPublicUserProfileGUI($ilUser->getId());
        $ptpl->setVariable("PREVIEW", $pub_profile->getEmbeddable());
        $this->tpl->setContent($ptpl->get());
        $this->tpl->show();
    }
    
    protected function getProfilePortfolio()
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $ilSetting = $DIC['ilSetting'];
        
        if ($ilSetting->get('user_portfolios')) {
            include_once "Modules/Portfolio/classes/class.ilObjPortfolio.php";
            return ilObjPortfolio::getDefaultPortfolio($ilUser->getId());
        }
    }

    public function initPublicProfileForm()
    {
        global $DIC;

        $lng = $DIC['lng'];
        $ilUser = $DIC['ilUser'];
        $ilSetting = $DIC['ilSetting'];
        
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->form = new ilPropertyFormGUI();
        
        $this->form->setTitle($lng->txt("public_profile"));
        $this->form->setDescription($lng->txt("user_public_profile_info"));
        $this->form->setFormAction($this->ctrl->getFormAction($this));
        
        $portfolio_id = $this->getProfilePortfolio();
    
        if (!$portfolio_id) {
            // Activate public profile
            $radg = new ilRadioGroupInputGUI($lng->txt("user_activate_public_profile"), "public_profile");
            $info = $this->lng->txt("user_activate_public_profile_info");
            $pub_prof = in_array($ilUser->prefs["public_profile"], array("y", "n", "g"))
                ? $ilUser->prefs["public_profile"]
                : "n";
            if (!$ilSetting->get('enable_global_profiles') && $pub_prof == "g") {
                $pub_prof = "y";
            }
            $radg->setValue($pub_prof);
            $op1 = new ilRadioOption($lng->txt("usr_public_profile_disabled"), "n", $lng->txt("usr_public_profile_disabled_info"));
            $radg->addOption($op1);
            $op2 = new ilRadioOption($lng->txt("usr_public_profile_logged_in"), "y");
            $radg->addOption($op2);
            if ($ilSetting->get('enable_global_profiles')) {
                $op3 = new ilRadioOption($lng->txt("usr_public_profile_global"), "g");
                $radg->addOption($op3);
            }
            $this->form->addItem($radg);
            
            // #11773
            if ($ilSetting->get('user_portfolios')) {
                // #10826
                $prtf = "<br />" . $lng->txt("user_profile_portfolio");
                $prtf .= "<br /><a href=\"ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToPortfolio\">&raquo; " .
                    $lng->txt("user_portfolios") . "</a>";
                $info .= $prtf;
            }
            
            $radg->setInfo($info);
        } else {
            $prtf = $lng->txt("user_profile_portfolio_selected");
            $prtf .= "<br /><a href=\"ilias.php?baseClass=ilPersonalDesktopGUI&cmd=jumpToPortfolio&prt_id=" . $portfolio_id . "\">&raquo; " .
                $lng->txt("portfolio") . "</a>";
            
            $info = new ilCustomInputGUI($lng->txt("user_activate_public_profile"));
            $info->setHTML($prtf);
            $this->form->addItem($info);
        }
        
        $this->showPublicProfileFields($this->form, $ilUser->prefs);
        
        $this->form->addCommandButton("savePublicProfile", $lng->txt("save"));
    }

    public function showPublicProfileFields(ilPropertyformGUI $form, array $prefs, $parent = null, $anonymized = false)
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        $birthday = $ilUser->getBirthday();
        if ($birthday) {
            $birthday = ilDatePresentation::formatDate(new ilDate($birthday, IL_CAL_DATE));
        }
        $gender = $ilUser->getGender();
        if ($gender) {
            $gender = $this->lng->txt("gender_" . $gender);
        }

        if ($ilUser->getSelectedCountry() != "") {
            $this->lng->loadLanguageModule("meta");
            $txt_sel_country = $this->lng->txt("meta_c_" . $ilUser->getSelectedCountry());
        }
        
        // profile picture
        $pic = ilObjUser::_getPersonalPicturePath($ilUser->getId(), "xsmall", true, true);
        if ($pic) {
            $pic = "<img src=\"" . $pic . "\" />";
        }

        // personal data
        $val_array = array(
            "title" => $ilUser->getUTitle(),
            "birthday" => $birthday,
            "gender" => $gender,
            "upload" => $pic,
            "interests_general" => $ilUser->getGeneralInterestsAsText(),
            "interests_help_offered" => $ilUser->getOfferingHelpAsText(),
            "interests_help_looking" => $ilUser->getLookingForHelpAsText(),
            "org_units" => $ilUser->getOrgUnitsRepresentation(),
            "institution" => $ilUser->getInstitution(),
            "department" => $ilUser->getDepartment(),
            "street" => $ilUser->getStreet(),
            "zipcode" => $ilUser->getZipcode(),
            "city" => $ilUser->getCity(),
            "country" => $ilUser->getCountry(),
            "sel_country" => $txt_sel_country,
            "phone_office" => $ilUser->getPhoneOffice(),
            "phone_home" => $ilUser->getPhoneHome(),
            "phone_mobile" => $ilUser->getPhoneMobile(),
            "fax" => $ilUser->getFax(),
            "email" => $ilUser->getEmail(),
            "second_email" => $ilUser->getSecondEmail(),
            "hobby" => $ilUser->getHobby(),
            "matriculation" => $ilUser->getMatriculation()
        );
        
        // location
        include_once("./Services/Maps/classes/class.ilMapUtil.php");
        if (ilMapUtil::isActivated()) {
            $val_array["location"] = "";
        }
        
        foreach ($val_array as $key => $value) {
            if ($anonymized) {
                $value = null;
            }
            
            if ($this->userSettingVisible($key)) {
                // #18795 - we should use ilUserProfile
                switch ($key) {
                    case "upload":
                        $caption = "personal_picture";
                        break;
                    
                    case "title":
                        $caption = "person_title";
                        break;
                    
                    default:
                        $caption = $key;
                }
                $cb = new ilCheckboxInputGUI($this->lng->txt($caption), "chk_" . $key);
                if ($prefs["public_" . $key] == "y") {
                    $cb->setChecked(true);
                }
                //$cb->setInfo($value);
                $cb->setOptionTitle($value);

                if (!$parent) {
                    $form->addItem($cb);
                } else {
                    $parent->addSubItem($cb);
                }
            }
        }

        // additional defined user data fields
        $user_defined_data = array();
        if (!$anonymized) {
            $user_defined_data = $ilUser->getUserDefinedData();
        }
        foreach ($this->user_defined_fields->getVisibleDefinitions() as $field_id => $definition) {
            // public setting
            $cb = new ilCheckboxInputGUI($definition["field_name"], "chk_udf_" . $definition["field_id"]);
            $cb->setOptionTitle($user_defined_data["f_" . $definition["field_id"]]);
            if ($prefs["public_udf_" . $definition["field_id"]] == "y") {
                $cb->setChecked(true);
            }

            if (!$parent) {
                $form->addItem($cb);
            } else {
                $parent->addSubItem($cb);
            }
        }
        
        // :TODO: badges
        if (!$anonymized) {
            include_once "Services/Badge/classes/class.ilBadgeHandler.php";
            $handler = ilBadgeHandler::getInstance();
            if ($handler->isActive()) {
                $badge_options = array();

                include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                include_once "Services/Badge/classes/class.ilBadge.php";
                foreach (ilBadgeAssignment::getInstancesByUserId($ilUser->getId()) as $ass) {
                    // only active
                    if ($ass->getPosition()) {
                        $badge = new ilBadge($ass->getBadgeId());
                        $badge_options[] = $badge->getTitle();
                    }
                }

                if (sizeof($badge_options) > 1) {
                    $badge_order = new ilNonEditableValueGUI($this->lng->txt("obj_bdga"), "bpos");
                    $badge_order->setMultiValues($badge_options);
                    $badge_order->setValue(array_shift($badge_options));
                    $badge_order->setMulti(true, true, false);

                    if (!$parent) {
                        $form->addItem($badge_order);
                    } else {
                        $parent->addSubItem($badge_order);
                    }
                }
            }
        }
    }
    
    public function savePublicProfile()
    {
        global $DIC;

        $tpl = $DIC['tpl'];
        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $ilUser = $DIC['ilUser'];
    
        $this->initPublicProfileForm();
        if ($this->form->checkInput()) {
            // with active portfolio no options are presented
            if (isset($_POST["public_profile"])) {
                $ilUser->setPref("public_profile", $_POST["public_profile"]);
            }

            // if check on Institute
            $val_array = array("title", "birthday", "gender", "org_units", "institution", "department", "upload",
                "street", "zipcode", "city", "country", "sel_country", "phone_office", "phone_home", "phone_mobile",
                "fax", "email", "second_email", "hobby", "matriculation", "location",
                "interests_general", "interests_help_offered", "interests_help_looking");
    
            // set public profile preferences
            foreach ($val_array as $key => $value) {
                if (($_POST["chk_" . $value])) {
                    $ilUser->setPref("public_" . $value, "y");
                } else {
                    $ilUser->setPref("public_" . $value, "n");
                }
            }
    
            // additional defined user data fields
            foreach ($this->user_defined_fields->getVisibleDefinitions() as $field_id => $definition) {
                if (($_POST["chk_udf_" . $definition["field_id"]])) {
                    $ilUser->setPref("public_udf_" . $definition["field_id"], "y");
                } else {
                    $ilUser->setPref("public_udf_" . $definition["field_id"], "n");
                }
            }

            $ilUser->update();
            
            // :TODO: badges
            include_once "Services/Badge/classes/class.ilBadgeHandler.php";
            $handler = ilBadgeHandler::getInstance();
            if ($handler->isActive()) {
                $badgePositions = [];
                if (isset($_POST["bpos"]) && is_array($_POST["bpos"])) {
                    $badgePositions = $_POST["bpos"];
                }

                if (count($badgePositions) > 0) {
                    include_once "Services/Badge/classes/class.ilBadgeAssignment.php";
                    ilBadgeAssignment::updatePositions($ilUser->getId(), $badgePositions);
                }
            }
            
            // update lucene index
            include_once './Services/Search/classes/Lucene/class.ilLuceneIndexer.php';
            ilLuceneIndexer::updateLuceneIndex(array((int) $GLOBALS['DIC']['ilUser']->getId()));
            
            ilUtil::sendSuccess($lng->txt("msg_obj_modified"), true);

            if (ilSession::get('orig_request_target')) {
                $target = ilSession::get('orig_request_target');
                ilSession::set('orig_request_target', '');
                ilUtil::redirect($target);
            } elseif ($redirect = $_SESSION['profile_complete_redirect']) {
                unset($_SESSION['profile_complete_redirect']);
                ilUtil::redirect($redirect);
            } else {
                $ilCtrl->redirect($this, "showPublicProfile");
            }
        }
        $this->form->setValuesByPost();
        $tpl->showPublicProfile(true);
    }
    
    public function showExportImport()
    {
        global $DIC;

        $ilToolbar = $DIC['ilToolbar'];
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $ilTabs = $DIC['ilTabs'];
        $ilUser = $DIC['ilUser'];
        
        $ilTabs->activateTab("export");
        $this->setHeader();
        
        include_once "Services/UIComponent/Button/classes/class.ilLinkButton.php";
        $button = ilLinkButton::getInstance();
        $button->setCaption("pd_export_profile");
        $button->setUrl($ilCtrl->getLinkTarget($this, "exportPersonalData"));
        $ilToolbar->addStickyItem($button);
                
        $exp_file = $ilUser->getPersonalDataExportFile();
        if ($exp_file != "") {
            $ilToolbar->addSeparator();
            $ilToolbar->addButton(
                $this->lng->txt("pd_download_last_export_file"),
                $ilCtrl->getLinkTarget($this, "downloadPersonalData")
            );
        }

        $ilToolbar->addSeparator();
        $ilToolbar->addButton(
            $this->lng->txt("pd_import_personal_data"),
            $ilCtrl->getLinkTarget($this, "importPersonalDataSelection")
        );
        
        $tpl->show();
    }
    
    
    public function exportPersonalData()
    {
        global $DIC;

        $ilCtrl = $DIC['ilCtrl'];
        $ilUser = $DIC['ilUser'];

        $ilUser->exportPersonalData();
        $ilUser->sendPersonalDataFile();
        $ilCtrl->redirect($this, "showExportImport");
    }
    
    public function downloadPersonalData()
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        
        $ilUser->sendPersonalDataFile();
    }
    
    public function importPersonalDataSelection()
    {
        global $DIC;

        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $ilTabs = $DIC['ilTabs'];
    
        $ilTabs->activateTab("export");
        $this->setHeader();
        
        $this->initPersonalDataImportForm();
        
        $tpl->setContent($this->form->getHTML());
        $tpl->show();
    }
    
    public function initPersonalDataImportForm()
    {
        global $DIC;

        $lng = $DIC['lng'];
        $ilCtrl = $DIC['ilCtrl'];
        
        include_once("Services/Form/classes/class.ilPropertyFormGUI.php");
        $this->form = new ilPropertyFormGUI();
        
        // input file
        $fi = new ilFileInputGUI($lng->txt("file"), "file");
        $fi->setRequired(true);
        $fi->setSuffixes(array("zip"));
        $this->form->addItem($fi);

        // profile data
        $cb = new ilCheckboxInputGUI($this->lng->txt("pd_profile_data"), "profile_data");
        $this->form->addItem($cb);
        
        // settings
        $cb = new ilCheckboxInputGUI($this->lng->txt("settings"), "settings");
        $this->form->addItem($cb);
        
        // bookmarks
        $cb = new ilCheckboxInputGUI($this->lng->txt("pd_bookmarks"), "bookmarks");
        $this->form->addItem($cb);
        
        // personal notes
        $cb = new ilCheckboxInputGUI($this->lng->txt("pd_notes"), "notes");
        $this->form->addItem($cb);
        
        // calendar entries
        $cb = new ilCheckboxInputGUI($this->lng->txt("pd_private_calendars"), "calendar");
        $this->form->addItem($cb);

        $this->form->addCommandButton("importPersonalData", $lng->txt("import"));
        $this->form->addCommandButton("showExportImport", $lng->txt("cancel"));
                    
        $this->form->setTitle($lng->txt("pd_import_personal_data"));
        $this->form->setFormAction($ilCtrl->getFormAction($this));
    }
    
    
    public function importPersonalData()
    {
        global $DIC;

        $ilUser = $DIC['ilUser'];
        $ilCtrl = $DIC['ilCtrl'];
        $tpl = $DIC['tpl'];
        $ilTabs = $DIC['ilTabs'];
        
        $this->initPersonalDataImportForm();
        if ($this->form->checkInput()) {
            $ilUser->importPersonalData(
                $_FILES["file"],
                (int) $_POST["profile_data"],
                (int) $_POST["settings"],
                (int) $_POST["bookmarks"],
                (int) $_POST["notes"],
                (int) $_POST["calendar"]
            );
            ilUtil::sendSuccess($this->lng->txt("msg_obj_modified"), true);
            $ilCtrl->redirect($this, "");
        } else {
            $ilTabs->activateTab("export");
            $this->setHeader();
            $this->form->setValuesByPost();
            $tpl->setContent($this->form->getHtml());
            $tpl->show();
        }
    }

    protected function renderCertificateMigration(\ilObjUser $user, bool $migrationIsStartedInRequest)
    {
        $migrationVisibleValidator = new ilCertificateMigrationValidator(new \ilSetting('certificate'));

        $showMigrationBox = $migrationVisibleValidator->isMigrationAvailable(
            $user,
            new \ilCertificateMigration($user->getId())
        );
        if (!$migrationIsStartedInRequest && true === $showMigrationBox) {
            $migrationUiEl = new \ilCertificateMigrationUIElements();

            $startMigrationCommand = $this->ctrl->getLinkTargetByClass(
                ['ilCertificateMigrationGUI'],
                'startMigrationAndReturnMessage',
                false,
                true,
                false
            );
            $messageBoxHtml = $migrationUiEl->getMigrationMessageBox($startMigrationCommand);

            $this->tpl->setCurrentBlock('mess');
            $this->tpl->setVariable('MESSAGE', $messageBoxHtml);
            $this->tpl->parseCurrentBlock('mess');
        }
    }
}