Skip to content

Default-HTML-Frame for Mail in System Style (3/3) #9566

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
kjansen2608 wants to merge 1 commit into
base: trunk
Choose a base branch
from
Open

Default-HTML-Frame for Mail in System Style (3/3) #9566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions components/ILIAS/Mail/Mail.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@

namespace ILIAS;

use ILIAS\Component\Resource\ComponentCSS;

class Mail implements Component\Component
{
public function init(
Expand All @@ -38,6 +40,8 @@ public function init(
);
$contribute[Component\Resource\PublicAsset::class] = fn() =>
new Component\Resource\ComponentJS($this, "ilMailComposeFunctions.js");
$contribute[Component\Resource\PublicAsset::class] = fn() =>
new ComponentCSS($this, '/../../../../templates/default/mail.css');
$contribute[User\Settings\UserSettings::class] = fn() =>
new Mail\UserSettings\Settings();
$contribute[User\Profile\ChangeListeners\UserFieldAttributesChangeListener::class] = fn() =>
Expand Down
128 changes: 87 additions & 41 deletions components/ILIAS/Mail/classes/class.ilMimeMail.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,17 @@

declare(strict_types=1);

use ILIAS\Data\Factory;
use ILIAS\Refinery\Factory as Refinery;

class ilMimeMail
{
final public const string MAIL_SUBJECT_PREFIX = '[ILIAS]';
private const string SKIN_LOGO_PATH = '/public/Customizing/skin/%s/images/logo';
private const string SKIN_CSS_PATH = '/public/Customizing/skin/%s/mail.css';
private const string MAIL_CSS_PATH = 'assets/css/mail.css';
private const string MAIL_LOGO_PATH = '/components/ILIAS/Mail/templates/default/img/ilias_logo.jpg';
private const string ROOT_DIR_IDENTIFICATION_FILE = '/ilias_version.php';

protected static ?ilMailMimeTransport $default_transport = null;

Expand All @@ -39,7 +45,7 @@ class ilMimeMail
protected array $acc = [];
/** @var string[] */
protected array $abcc = [];
/** @var array<string, array{path: string, cid: string, name: string}> */
/** @var array<string, array{path: string, cid: string, name: string, as_logo: bool}> */
protected array $images = [];
/** @var string[] */
protected array $aattach = [];
Expand Down Expand Up @@ -238,8 +244,22 @@ protected function build(): void
$skin = $DIC['ilClientIniFile']->readVariable('layout', 'skin');
$style = $DIC['ilClientIniFile']->readVariable('layout', 'style');

$this->buildBodyMultiParts($skin, $style);
$this->buildHtmlInlineImages($skin, $style);
$data_factory = new Factory();
$factory = $DIC->ui()->factory();
$renderer = $DIC->ui()->renderer();

$this->prepareHTMLBody();

$page = $factory->layout()->page()->mail(
$this->getStyleSheetPath($skin, $style),
'cid:' . $this->getLogoCid($skin, $style),
ilObjSystemFolder::_getHeaderTitle(),
$factory->legacy()->content($this->body),
$data_factory->link(ilUtil::_getHttpPath(), $data_factory->uri(ilUtil::_getHttpPath())),
);

$this->final_body = $renderer->render($page);
$this->final_body_alt = $this->removeHtmlTags($this->body);
} else {
$this->final_body = $this->removeHtmlTags($this->body);
}
Expand All @@ -252,7 +272,22 @@ private function removeHtmlTags(string $maybe_html): string
return html_entity_decode(strip_tags($maybe_html), ENT_QUOTES);
}

protected function buildBodyMultiParts(string $skin, string $style): void
private function getPathToRootDirectory(): string
{
$current_dir = realpath(__DIR__);

while ($current_dir !== '.') {
if (file_exists($current_dir . self::ROOT_DIR_IDENTIFICATION_FILE)) {
break;
}

$current_dir = dirname($current_dir);
}

return $current_dir;
}

private function prepareHTMLBody(): void
{
if ($this->body === '') {
$this->body = ' ';
Expand All @@ -263,16 +298,9 @@ protected function buildBodyMultiParts(string $skin, string $style): void
$this->final_body_alt = strip_tags(str_ireplace(['<br />', '<br>', '<br/>'], "\n", $this->body));
} else {
$this->final_body_alt = strip_tags($this->body);
$this->body = nl2br($this->body);
}

$body_with_clickable_urls = $this->refinery->string()->makeClickable()->transform($this->body);

$this->final_body = str_replace(
'{PLACEHOLDER}',
$body_with_clickable_urls,
$this->getHtmlEnvelope($skin, $style)
);
$this->body = $this->refinery->string()->makeClickable()->transform(nl2br($this->body));
}

private function containsHtmlBlockElementsOrLineBreaks(string $email_body): bool
Expand All @@ -290,54 +318,65 @@ private function containsHtmlBlockElementsOrLineBreaks(string $email_body): bool
return strip_tags($email_body, '<b><u><i><a>') !== $email_body;
}

private function getPathToRootDirectory(): string
private function getStyleSheetPath(string $skin, string $style): string
{
return realpath(dirname(__DIR__, 4) . '/');
}

protected function getHtmlEnvelope(string $skin, string $style): string
{
$bracket_path = $this->getPathToRootDirectory() . '/components/ILIAS/Mail/templates/default/tpl.html_mail_template.html';
if ($skin !== 'default') {
$locations = [
$skin,
$skin . '/' . $style
];

foreach ($locations as $location) {
$custom_path = $this->getPathToRootDirectory(
) . '/public/Customizing/skin/' . $location . '/components/ILIAS/Mail/tpl.html_mail_template.html';
$custom_path = $this->getPathToRootDirectory() . sprintf(self::SKIN_CSS_PATH, $location);
if (is_file($custom_path)) {
$bracket_path = $custom_path;
break;
return $custom_path;
}
}
}

return file_get_contents($bracket_path);
return self::MAIL_CSS_PATH;
}

protected function buildHtmlInlineImages(string $skin, string $style): void
private function getLogoCid(string $skin, string $style): string
{
$this->gatherImagesFromDirectory(
$this->getPathToRootDirectory() . '/components/ILIAS/Mail/templates/default/img'
);

if ($skin !== 'default') {
$locations = [
$skin,
$skin . '/' . $style
];

foreach ($locations as $location) {
$custom_directory = $this->getPathToRootDirectory(
) . '/public/Customizing/skin/' . $location . '/components/ILIAS/Mail/img';
$custom_directory = $this->getPathToRootDirectory() . sprintf(self::SKIN_LOGO_PATH, $location);
if (is_dir($custom_directory) && is_readable($custom_directory)) {
$this->gatherImagesFromDirectory($custom_directory, true);
break;
$this->gatherImagesFromDirectory($custom_directory);
}
}
} else {
$path = $this->getPathToRootDirectory() . self::MAIL_LOGO_PATH;
if (is_file($path) && is_readable($path)) {
return $this->addImage(new SplFileInfo($path), true);
}
}

foreach ($this->images as $image) {
if ($image['as_logo']) {
return $image['cid'];
}
}

$logo_cid = current($this->images)['cid'];

foreach ($this->images as $cid => $image) {
$file_name = basename($image['path'], '.' . pathinfo($image['path'], PATHINFO_EXTENSION));
if (in_array(strtolower($file_name), ['logo', 'headericon'], true)) {
$logo_cid = $cid;
break;
}
}

$this->images[$logo_cid]['as_logo'] = true;

return $logo_cid;
}

protected function gatherImagesFromDirectory(string $directory, bool $clear_previous = false): void
Expand All @@ -350,17 +389,24 @@ protected function gatherImagesFromDirectory(string $directory, bool $clear_prev
new DirectoryIterator($directory),
'/\.(jpg|jpeg|gif|svg|png)$/i'
) as $file) {
/** @var SplFileInfo $file */
$cid = 'img/' . $file->getFilename();

$this->images[$cid] = [
'path' => $file->getPathname(),
'cid' => $cid,
'name' => $file->getFilename()
];
$this->addImage($file);
}
}

private function addImage(SplFileInfo $file, bool $as_logo = false): string
{
$cid = 'img/' . $file->getFilename();

$this->images[$cid] = [
'path' => $file->getPathname(),
'cid' => $cid,
'name' => $file->getFilename(),
'as_logo' => $as_logo
];

return $cid;
}

public function Send(?ilMailMimeTransport $transport = null): bool
{
if (!($transport instanceof ilMailMimeTransport)) {
Expand Down