class.ilAccountMail.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

use ILIAS\HTTP\GlobalHttpState;
use ILIAS\Refinery\Factory as Refinery;

class ilAccountMail
{
    private readonly ilSetting $settings;
    private readonly ilTree $repositoryTree;
    private readonly ilMailMimeSenderFactory $senderFactory;
    public string $u_password = '';
    public ?ilObjUser $user = null;
    private bool $lang_variables_as_fallback = false;
    private array $attachments = [];
    private bool $attachConfiguredFiles = false;
    private array $amail = [];
    private ?string $permanent_link_target = null;

    public function __construct()
    {
        global $DIC;
        $this->settings = $DIC->settings();
        $this->repositoryTree = $DIC->repositoryTree();
        $this->senderFactory = $DIC->mail()->mime()->senderFactory();
    }

    public function useLangVariablesAsFallback(bool $a_status): void
    {
        $this->lang_variables_as_fallback = $a_status;
    }

    public function areLangVariablesUsedAsFallback(): bool
    {
        return $this->lang_variables_as_fallback;
    }

    public function shouldAttachConfiguredFiles(): bool
    {
        return $this->attachConfiguredFiles;
    }

    public function setAttachConfiguredFiles(bool $attachConfiguredFiles): void
    {
        $this->attachConfiguredFiles = $attachConfiguredFiles;
    }

    public function setUserPassword(string $a_pwd): void
    {
        $this->u_password = $a_pwd;
    }

    public function getUserPassword(): string
    {
        return $this->u_password;
    }

    public function setUser(ilObjUser $a_user): void
    {
        if (
            $this->user instanceof ilObjUser &&
            $a_user->getId() !== $this->user->getId()
        ) {
            $this->attachments = [];
        }

        $this->user = $a_user;
    }

    public function setPermanentLinkTarget(?string $permanent_link_target): void
    {
        if ($permanent_link_target === '') {
            throw new InvalidArgumentException(
                'Permanent link target must not be empty'
            );
        }

        $this->permanent_link_target = $permanent_link_target;
    }

    public function getUser(): ?ilObjUser
    {
        return $this->user;
    }

    public function reset(): void
    {
        $this->user = null;
        $this->u_password = '';
        $this->permanent_link_target = null;
    }

    private function ensureValidMailDataShape(array $mailData): array
    {
        foreach (['lang', 'subject', 'body', 'sal_f', 'sal_g', 'sal_m', 'type'] as $key) {
            if (!isset($mailData[$key])) {
                $mailData[$key] = '';
            }
        }

        $mailData['subject'] = trim($mailData['subject']);
        $mailData['body'] = trim($mailData['body']);

        return $mailData;
    }

    private function readAccountMail(string $a_lang): array
    {
        if (!isset($this->amail[$a_lang]) || !is_array($this->amail[$a_lang])) {
            $this->amail[$a_lang] = $this->ensureValidMailDataShape(
                ilObjUserFolder::_lookupNewAccountMail($a_lang)
            );
        }

        return $this->amail[$a_lang];
    }

    private function addAttachments(array $mailData): void
    {
        if (isset($mailData['att_file']) && $this->shouldAttachConfiguredFiles()) {
            $fs = new ilFSStorageUserFolder(USER_FOLDER_ID);
            $fs->create();

            $pathToFile = '/' . implode('/', array_map(static function (string $pathPart): string {
                return trim($pathPart, '/');
            }, [
                $fs->getAbsolutePath(),
                $mailData['lang'],
            ]));

            $this->addAttachment($pathToFile, $mailData['att_file']);
        }
    }

    public function send(): bool
    {
        $user = $this->getUser();
        if (!$user instanceof ilObjUser) {
            throw new RuntimeException('A user instance must be passed when sending emails');
        }

        if ($user->getEmail() === '') {
            return false;
        }

        // determine language and get account mail data
        // fall back to default language if acccount mail data is not given for user language.
        $amail = $this->readAccountMail($user->getLanguage());
        $lang = $user->getLanguage();
        if ($amail['body'] === '' || $amail['subject'] === '') {
            $fallback_language = 'en';
            $amail = $this->readAccountMail($this->settings->get('language', $fallback_language));
            $lang = $this->settings->get('language', $fallback_language);
        }

        // fallback if mail data is still not given
        if (($amail['body'] === '' || $amail['subject'] === '') && $this->areLangVariablesUsedAsFallback()) {
            $lang = $user->getLanguage();
            $tmp_lang = new ilLanguage($lang);

            $mail_subject = $tmp_lang->txt('reg_mail_subject');

            $timelimit = '';
            if (!$user->checkTimeLimit()) {
                $tmp_lang->loadLanguageModule('registration');

                // #6098
                $timelimit_from = new ilDateTime($user->getTimeLimitFrom(), IL_CAL_UNIX);
                $timelimit_until = new ilDateTime($user->getTimeLimitUntil(), IL_CAL_UNIX);
                $timelimit = ilDatePresentation::formatPeriod($timelimit_from, $timelimit_until);
                $timelimit = "\n" . sprintf($tmp_lang->txt('reg_mail_body_timelimit'), $timelimit) . "\n\n";
            }

            // mail body
            $mail_body = $tmp_lang->txt('reg_mail_body_salutation') . ' ' . $user->getFullname() . ",\n\n" .
                $tmp_lang->txt('reg_mail_body_text1') . "\n\n" .
                $tmp_lang->txt('reg_mail_body_text2') . "\n" .
                ILIAS_HTTP_PATH . '/login.php?client_id=' . CLIENT_ID . "\n";
            $mail_body .= $tmp_lang->txt('login') . ': ' . $user->getLogin() . "\n";
            $mail_body .= $tmp_lang->txt('passwd') . ': ' . $this->u_password . "\n";
            $mail_body .= "\n" . $timelimit;
            $mail_body .= $tmp_lang->txt('reg_mail_body_text3') . "\n\r";
            $mail_body .= $user->getProfileAsString($tmp_lang);
        } else {
            $this->addAttachments($amail);

            // replace placeholders
            $mail_subject = $this->replacePlaceholders($amail['subject'], $user, $amail, $lang);
            $mail_body = $this->replacePlaceholders($amail['body'], $user, $amail, $lang);
        }

        $mmail = new ilMimeMail();
        $mmail->From($this->senderFactory->system());
        $mmail->Subject($mail_subject, true);
        $mmail->To($user->getEmail());
        $mmail->Body($mail_body);

        foreach ($this->attachments as $filename => $display_name) {
            $mmail->Attach($filename, '', 'attachment', $display_name);
        }

        $mmail->Send();

        return true;
    }

    public function replacePlaceholders(string $a_string, ilObjUser $a_user, array $a_amail, string $a_lang): string
    {
        global $DIC;
        $tree = $DIC->repositoryTree();
        $ilSetting = $DIC->settings();
        $mustache_factory = $DIC->mail()->mustacheFactory();

        $replacements = [];

        // determine salutation
        $replacements['MAIL_SALUTATION'] = $mustache_factory->getBasicEngine()->render(
            match ($a_user->getGender()) {
                'f' => trim((string) $a_amail['sal_f']),
                'm' => trim((string) $a_amail['sal_m']),
                default => trim((string) $a_amail['sal_g']),
            },
            [
                'FIRST_NAME' => $a_user->getFirstname(),
                'LAST_NAME' => $a_user->getLastname(),
                'LOGIN' => $a_user->getLogin(),
            ]
        );
        $replacements['LOGIN'] = $a_user->getLogin();
        $replacements['FIRST_NAME'] = $a_user->getFirstname();
        $replacements['LAST_NAME'] = $a_user->getLastname();
        // BEGIN Mail Include E-Mail Address in account mail
        $replacements['EMAIL'] = $a_user->getEmail();
        // END Mail Include E-Mail Address in account mail
        $replacements['PASSWORD'] = $this->getUserPassword();
        $replacements['ILIAS_URL'] = ILIAS_HTTP_PATH . '/login.php?client_id=' . CLIENT_ID;
        $replacements['CLIENT_NAME'] = CLIENT_NAME;
        $replacements['ADMIN_MAIL'] = $ilSetting->get('admin_email');
        $replacements['IF_PASSWORD'] = $this->getUserPassword() != '';
        $replacements['IF_NO_PASSWORD'] = $this->getUserPassword() == '';

        // #13346
        if (!$a_user->getTimeLimitUnlimited()) {
            // #6098
            $replacements['IF_TIMELIMIT'] = !$a_user->getTimeLimitUnlimited();
            $timelimit_from = new ilDateTime($a_user->getTimeLimitFrom(), IL_CAL_UNIX);
            $timelimit_until = new ilDateTime($a_user->getTimeLimitUntil(), IL_CAL_UNIX);
            $timelimit = ilDatePresentation::formatPeriod($timelimit_from, $timelimit_until);
            $replacements['TIMELIMIT'] = $timelimit;
        }

        // target
        $replacements['IF_TARGET'] = false;
        if ($this->permanent_link_target !== null) {
            $tarr = explode('_', $this->permanent_link_target);
            if ($this->repositoryTree->isInTree((int) $tarr[1])) {
                $obj_id = ilObject::_lookupObjId((int) $tarr[1]);
                $type = ilObject::_lookupType($obj_id);
                if ($type === $tarr[0]) {
                    $replacements['TARGET_TITLE'] = ilObject::_lookupTitle($obj_id);
                    $replacements['TARGET'] = ILIAS_HTTP_PATH . '/goto.php?client_id=' . CLIENT_ID . '&target=' . $this->permanent_link_target;

                    // this looks complicated, but we may have no initilised $lng object here
                    // if mail is send during user creation in authentication
                    $replacements['TARGET_TYPE'] = ilLanguage::_lookupEntry($a_lang, 'common', 'obj_' . $tarr[0]);
                    $replacements['IF_TARGET'] = true;
                }
            }
        }

        return $mustache_factory->getBasicEngine()->render($a_string, $replacements);
    }

    public function addAttachment(string $a_filename, string $a_display_name): void
    {
        $this->attachments[$a_filename] = $a_display_name;
    }
}