class.ilMailFormCall.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilMailFormCall
{
    final public const SESSION_KEY = 'mail_transport';
    final public const REFERER_KEY = 'r';
    final public const SIGNATURE_KEY = 'sig';
    final public const CONTEXT_PREFIX = 'ctx';
    final public const CONTEXT_KEY = 'ctx_template';

    public static function getLinkTarget(
        $gui,
        string $cmd,
        array $gui_params = [],
        array $mail_params = [],
        array $context_params = []
    ): string {
        return self::getTargetUrl('&', $gui, $cmd, $gui_params, $mail_params, $context_params);
    }

    public static function getRedirectTarget(
        $gui,
        string $cmd,
        array $gui_params = [],
        array $mail_params = [],
        array $context_params = []
    ): string {
        return self::getTargetUrl('&', $gui, $cmd, $gui_params, $mail_params, $context_params);
    }

    protected static function getTargetUrl(
        string $argument_separator,
        $gui,
        string $cmd,
        array $gui_params = [],
        array $mail_params = [],
        array $context_params = []
    ): string {
        global $DIC;

        $mparams = '';
        $referer = '';

        foreach ($mail_params as $key => $value) {
            $mparams .= $argument_separator . $key . '=' . urlencode((string) $value);
        }

        foreach ($context_params as $key => $value) {
            if ($key === self::CONTEXT_KEY) {
                $mparams .= $argument_separator . $key . '=' . urlencode((string) $value);
            } else {
                $mparams .= $argument_separator . self::CONTEXT_PREFIX . '_' . $key . '=' . urlencode((string) $value);
            }
        }

        if (is_object($gui)) {
            $ilCtrlTmp = clone $DIC->ctrl();
            foreach ($gui_params as $key => $value) {
                $ilCtrlTmp->setParameter($gui, $key, $value);
            }
            $referer = $ilCtrlTmp->getLinkTarget($gui, $cmd, '');
        } elseif (is_string($gui)) {
            $referer = $gui;
        }

        $referer = $argument_separator . self::REFERER_KEY . '=' . rawurlencode(base64_encode($referer));

        return 'ilias.php?baseClass=ilMailGUI' . $referer . $mparams;
    }

    public static function storeReferer(array $queryParameters): void
    {
        $session = ilSession::get(self::SESSION_KEY);

        if (isset($queryParameters[self::REFERER_KEY])) {
            $session[self::REFERER_KEY] = base64_decode(rawurldecode($queryParameters[self::REFERER_KEY]));
            $session[self::SIGNATURE_KEY] = base64_decode(
                rawurldecode(
                    $queryParameters[self::SIGNATURE_KEY] ?? ''
                )
            );

            $contextParameters = [];
            foreach ($queryParameters as $key => $value) {
                $prefix = substr($key, 0, strlen(self::CONTEXT_PREFIX));
                if ($prefix === self::CONTEXT_PREFIX) {
                    if ($key === self::CONTEXT_KEY) {
                        $contextParameters[$key] = $value;
                    } else {
                        $contextParameters[substr($key, strlen(self::CONTEXT_PREFIX . '_'))] = $value;
                    }
                }
            }
            $session[self::CONTEXT_PREFIX] = $contextParameters;
        } else {
            if (isset($session[self::REFERER_KEY])) {
                unset($session[self::REFERER_KEY]);
            }
            if (isset($session[self::SIGNATURE_KEY])) {
                unset($session[self::SIGNATURE_KEY]);
            }
            if (isset($session[self::CONTEXT_PREFIX])) {
                unset($session[self::CONTEXT_PREFIX]);
            }
        }

        ilSession::set(self::SESSION_KEY, $session);
    }

    public static function getSignature(): string
    {
        $sig = '';
        $session = ilSession::get(self::SESSION_KEY);

        if (isset($session[self::SIGNATURE_KEY])) {
            $sig = $session[self::SIGNATURE_KEY];

            unset($session[self::SIGNATURE_KEY]);
            ilSession::set(self::SESSION_KEY, $session);
        }

        return $sig;
    }

    public static function getRefererRedirectUrl(): string
    {
        $url = '';
        $session = ilSession::get(self::SESSION_KEY);

        if (isset($session[self::REFERER_KEY])) {
            $url = $session[self::REFERER_KEY];
            if (is_string($url) && $url !== '') {
                $parts = parse_url($url);
                if (isset($parts['query']) && $parts['query'] !== '') {
                    $url .= '&returned_from_mail=1';
                } else {
                    $url .= '?returned_from_mail=1';
                }

                $ilias_url_parts = parse_url(ilUtil::_getHttpPath());
                if (isset($parts['host']) && $ilias_url_parts['host'] !== $parts['host']) {
                    $url = 'ilias.php?baseClass=ilMailGUI';
                }
            }

            unset($session[self::REFERER_KEY]);
            ilSession::set(self::SESSION_KEY, $session);
        }

        return $url;
    }

    public static function isRefererStored(): bool
    {
        $session = ilSession::get(self::SESSION_KEY);

        return (
            isset($session[self::REFERER_KEY]) &&
            is_string($session[self::REFERER_KEY]) &&
            $session[self::REFERER_KEY] !== ''
        );
    }

    public static function getContextId(): ?string
    {
        $session = ilSession::get(self::SESSION_KEY);
        return (
            isset($session[self::CONTEXT_PREFIX][self::CONTEXT_KEY]) &&
            is_string($session[self::CONTEXT_PREFIX][self::CONTEXT_KEY]) ?
            $session[self::CONTEXT_PREFIX][self::CONTEXT_KEY] : null
        );
    }

    public static function setContextId(?string $id): void
    {
        $session = ilSession::get(self::SESSION_KEY);
        $session[self::CONTEXT_KEY] = $id;
        ilSession::set(self::SESSION_KEY, $session);
    }

    public static function getContextParameters(): array
    {
        $session = ilSession::get(self::SESSION_KEY);
        if (isset($session[self::CONTEXT_PREFIX]) && is_array($session[self::CONTEXT_PREFIX])) {
            return $session[self::CONTEXT_PREFIX];
        }

        return [];
    }

    public static function setContextParameters(array $parameters): void
    {
        $session = ilSession::get(self::SESSION_KEY);
        $session[self::CONTEXT_PREFIX] = $parameters;
        ilSession::set(self::SESSION_KEY, $session);
    }

    public static function setRecipients(array $recipients, string $type = 'to'): void
    {
        $session = ilSession::get(self::SESSION_KEY) ?? [];
        $session['rcp_' . $type] = array_map('strval', array_values($recipients));
        ilSession::set(self::SESSION_KEY, $session);
    }

    public static function getRecipients(string $type = 'to'): array
    {
        $session = ilSession::get(self::SESSION_KEY) ?? [];
        $key = 'rcp_' . $type;
        if (isset($session[$key]) && is_array($session[$key])) {
            return array_map('strval', array_values($session[$key]));
        }

        return [];
    }
}