class.shibUser.php

Go to the documentation of this file.

<?php

use ILIAS\Refinery\String\UTFNormal;

class shibUser extends ilObjUser
{
    protected shibServerData $shibServerData;


    public static function buildInstance(shibServerData $shibServerData): shibUser
    {
        $shibUser = new self();
        $shibUser->setLastPasswordChangeToNow();
        $shibUser->shibServerData = $shibServerData;
        $ext_id = $shibUser->shibServerData->getLogin();
        $shibUser->setExternalAccount($ext_id);
        $existing_usr_id = self::getUsrIdByExtId($ext_id);
        if ($existing_usr_id !== null) {
            $shibUser->setId($existing_usr_id);
            $shibUser->read();
        }
        $shibUser->setAuthMode('shibboleth');

        return $shibUser;
    }

    public function updateFields(): void
    {
        $shibConfig = shibConfig::getInstance();
        if ($shibConfig->getUpdateFirstname()) {
            $this->setFirstname($this->shibServerData->getFirstname());
        }
        if ($shibConfig->getUpdateLastname()) {
            $this->setLastname($this->shibServerData->getLastname());
        }
        if ($shibConfig->getUpdateGender()) {
            $this->setGender($this->shibServerData->getGender());
        }
        if ($shibConfig->getUpdateTitle()) {
            $this->setUTitle($this->shibServerData->getTitle());
        }
        if ($shibConfig->getUpdateInstitution()) {
            $this->setInstitution($this->shibServerData->getInstitution());
        }
        if ($shibConfig->getUpdateDepartment()) {
            $this->setDepartment($this->shibServerData->getDepartment());
        }
        if ($shibConfig->getUpdateStreet()) {
            $this->setStreet($this->shibServerData->getStreet());
        }
        if ($shibConfig->getUpdateZipcode()) {
            $this->setZipcode($this->shibServerData->getZipcode());
        }
        if ($shibConfig->getUpdateCountry()) {
            $this->setCountry($this->shibServerData->getCountry());
        }
        if ($shibConfig->getUpdatePhoneOffice()) {
            $this->setPhoneOffice($this->shibServerData->getPhoneOffice());
        }
        if ($shibConfig->getUpdatePhoneHome()) {
            $this->setPhoneHome($this->shibServerData->getPhoneHome());
        }
        if ($shibConfig->getUpdatePhoneMobile()) {
            $this->setPhoneMobile($this->shibServerData->getPhoneMobile());
        }
        if ($shibConfig->getUpdateFax()) {
            $this->setFax($this->shibServerData->getFax());
        }
        if ($shibConfig->getUpdateMatriculation()) {
            $this->setMatriculation($this->shibServerData->getMatriculation());
        }
        if ($shibConfig->getUpdateEmail()) {
            $this->setEmail($this->shibServerData->getEmail());
        }
        if ($shibConfig->getUpdateHobby()) {
            $this->setHobby($this->shibServerData->getHobby());
        }
        if ($shibConfig->getUpdateLanguage()) {
            $this->setLanguage($this->shibServerData->getLanguage());
        }
        $this->setDescription($this->getEmail());
    }

    public function createFields(): void
    {
        $this->setFirstname($this->shibServerData->getFirstname());
        $this->setLastname($this->shibServerData->getLastname());
        $this->setLogin($this->returnNewLoginName());
        $array = ilSecuritySettingsChecker::generatePasswords(1);
        $this->setPasswd(md5((string) end($array)), ilObjUser::PASSWD_CRYPTED);
        $this->setGender($this->shibServerData->getGender());
        $this->setExternalAccount($this->shibServerData->getLogin());
        $this->setUTitle($this->shibServerData->getTitle());
        $this->setInstitution($this->shibServerData->getInstitution());
        $this->setDepartment($this->shibServerData->getDepartment());
        $this->setStreet($this->shibServerData->getStreet());
        $this->setZipcode($this->shibServerData->getZipcode());
        $this->setCountry($this->shibServerData->getCountry());
        $this->setPhoneOffice($this->shibServerData->getPhoneOffice());
        $this->setPhoneHome($this->shibServerData->getPhoneHome());
        $this->setPhoneMobile($this->shibServerData->getPhoneMobile());
        $this->setFax($this->shibServerData->getFax());
        $this->setMatriculation($this->shibServerData->getMatriculation());
        $this->setEmail($this->shibServerData->getEmail());
        $this->setHobby($this->shibServerData->getHobby());
        $this->setTitle($this->getFullname());
        $this->setDescription($this->getEmail());
        $this->setLanguage($this->shibServerData->getLanguage());
        $this->setTimeLimitOwner(7);
        $this->setTimeLimitUnlimited(1);
        $this->setTimeLimitFrom(time());
        $this->setTimeLimitUntil(time());
        $this->setActive(true);
    }

    public function create(): int
    {
        $c = shibConfig::getInstance();
        $registration_settings = new ilRegistrationSettings();
        $recipients = array_filter($registration_settings->getApproveRecipients(), fn($v): bool => is_int($v));
        if ($c->isActivateNew() && $recipients !== []) {
            $this->setActive(false);
            $mail = new ilRegistrationMailNotification();
            $mail->setType(ilRegistrationMailNotification::TYPE_NOTIFICATION_CONFIRMATION);
            $mail->setRecipients($registration_settings->getApproveRecipients());
            $mail->setAdditionalInformation(['usr' => $this]);
            $mail->send();
        }

        if ($this->getLogin() !== '' && $this->getLogin() !== '.') {
            return parent::create();
        }

        throw new ilUserException('No Login-name created');
    }

    protected function returnNewLoginName(): ?string
    {
        $login = substr($this->cleanName($this->getFirstname()), 0, 1) . '.' . self::cleanName($this->getLastname());
        //remove whitespaces see mantis 0023123: https://www.ilias.de/mantis/view.php?id=23123
        $login = preg_replace('/\s+/', '', $login);
        $appendix = null;
        $login_tmp = $login;
        while ($this->loginExists($login, $this->getId())) {
            $login = $login_tmp . $appendix;
            $appendix++;
        }

        return $login;
    }

    public function isNew(): bool
    {
        return $this->getId() === 0;
    }

    protected function cleanName(string $name): string
    {
        $umlaut_map = [
            'ä' => 'ae', 'ö' => 'oe', 'ü' => 'ue',
            'Ä' => 'Ae', 'Ö' => 'Oe', 'Ü' => 'Ue',
            'ß' => 'ss'
        ];
        $name = strtr($name, $umlaut_map);

        $form_d = new UTFNormal();
        $name = $form_d->formD()->transform($name);
        $name = iconv('UTF-8', 'ASCII//TRANSLIT//IGNORE', (string) $name);

        return strtolower((string) preg_replace('/[^a-zA-Z0-9\s]/', '', $name));
    }

    private function loginExists(string $login, int $usr_id): bool
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT usr_id FROM usr_data WHERE login = ' . $ilDB->quote($login, 'text');
        $query .= ' AND usr_id != ' . $ilDB->quote($usr_id, 'integer');

        return $ilDB->numRows($ilDB->query($query)) > 0;
    }

    protected static function getUsrIdByExtId(string $ext_id): ?int
    {
        global $DIC;

        $ilDB = $DIC->database();

        $query = 'SELECT usr_id FROM usr_data WHERE ext_account = ' . $ilDB->quote($ext_id, 'text');
        $a_set = $ilDB->query($query);
        if ($ilDB->numRows($a_set) === 0) {
            return null;
        }

        $usr = $ilDB->fetchObject($a_set);

        return isset($usr->usr_id) ? (int) $usr->usr_id : null;
    }
}