Skip to content
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

Jump to bottom

WIP: Redesign iMIP email to better format both HTML and plain text. #17195

Closed
wants to merge 2 commits into from
Closed

WIP: Redesign iMIP email to better format both HTML and plain text. #17195

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
975ef55
Redesign iMIP email to better format both HTML and plain text.
brad2014 Sep 18, 2019
7b8e069
In iMIP event tables, put CSS inline.
brad2014 Sep 18, 2019
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
171 changes: 107 additions & 64 deletions apps/dav/lib/CalDAV/Schedule/IMipPlugin.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,34 +175,12 @@ public function schedule(Message $iTipMessage) {
$l10n = $this->l10nFactory->get('dav', $lang);

$meetingAttendeeName = $recipientName ?: $recipient;
$meetingInviteeName = $senderName ?: $sender;
$meetingOrganizerName = $senderName ?: $sender;

$meetingTitle = $vevent->SUMMARY;
$meetingDescription = $vevent->DESCRIPTION;

$start = $vevent->DTSTART;
if (isset($vevent->DTEND)) {
$end = $vevent->DTEND;
} elseif (isset($vevent->DURATION)) {
$isFloating = $vevent->DTSTART->isFloating();
$end = clone $vevent->DTSTART;
$endDateTime = $end->getDateTime();
$endDateTime = $endDateTime->add(DateTimeParser::parse($vevent->DURATION->getValue()));
$end->setDateTime($endDateTime, $isFloating);
} elseif (!$vevent->DTSTART->hasTime()) {
$isFloating = $vevent->DTSTART->isFloating();
$end = clone $vevent->DTSTART;
$endDateTime = $end->getDateTime();
$endDateTime = $endDateTime->modify('+1 day');
$end->setDateTime($endDateTime, $isFloating);
} else {
$end = clone $vevent->DTSTART;
}

$meetingWhen = $this->generateWhenString($l10n, $start, $end);

$meetingUrl = $vevent->URL;
$meetingLocation = $vevent->LOCATION;

$defaultVal = '--';

Expand All @@ -218,7 +196,7 @@ public function schedule(Message $iTipMessage) {

$data = array(
'attendee_name' => (string)$meetingAttendeeName ?: $defaultVal,
'invitee_name' => (string)$meetingInviteeName ?: $defaultVal,
'invitee_name' => (string)$meetingOrganizerName ?: $defaultVal,
'meeting_title' => (string)$meetingTitle ?: $defaultVal,
'meeting_description' => (string)$meetingDescription ?: $defaultVal,
'meeting_url' => (string)$meetingUrl ?: $defaultVal,
Expand All @@ -236,9 +214,8 @@ public function schedule(Message $iTipMessage) {
$template->addHeader();

$this->addSubjectAndHeading($template, $l10n, $method, $summary,
$meetingAttendeeName, $meetingInviteeName);
$this->addBulletList($template, $l10n, $meetingWhen, $meetingLocation,
$meetingDescription, $meetingUrl);
$meetingAttendeeName, $meetingOrganizerName);
$this->addEventTable($template, $l10n, $vevent);


// Only add response buttons to invitation requests: Fix Issue #11230
Expand Down Expand Up @@ -269,7 +246,7 @@ public function schedule(Message $iTipMessage) {
if (strcmp('yes', $invitationLinkRecipients[0]) === 0
|| in_array(strtolower($recipient), $invitationLinkRecipients)
|| in_array(strtolower($recipientDomain), $invitationLinkRecipients)) {
$this->addResponseButtons($template, $l10n, $iTipMessage, $lastOccurrence);
$this->addResponseButtons($template, $l10n, $iTipMessage, $lastOccurrence);
}
}

Expand Down Expand Up @@ -395,10 +372,29 @@ private function getAttendeeRSVP(Property $attendee = null) {

/**
* @param IL10N $l10n
* @param Property $dtstart
* @param Property $dtend
* @param VEvent $vevent
*/
private function generateWhenString(IL10N $l10n, Property $dtstart, Property $dtend) {
private function generateWhenString(IL10N $l10n, VEvent $vevent) {

$dtstart = $vevent->DTSTART;
if (isset($vevent->DTEND)) {
$dtend = $vevent->DTEND;
} elseif (isset($vevent->DURATION)) {
$isFloating = $vevent->DTSTART->isFloating();
$dtend = clone $vevent->DTSTART;
$endDateTime = $end->getDateTime();
$endDateTime = $endDateTime->add(DateTimeParser::parse($vevent->DURATION->getValue()));
$dtend->setDateTime($endDateTime, $isFloating);
} elseif (!$vevent->DTSTART->hasTime()) {
$isFloating = $vevent->DTSTART->isFloating();
$dtend = clone $vevent->DTSTART;
$endDateTime = $end->getDateTime();
$endDateTime = $endDateTime->modify('+1 day');
$dtend->setDateTime($endDateTime, $isFloating);
} else {
$dtend = clone $vevent->DTSTART;
}

$isAllDay = $dtstart instanceof Property\ICalendar\Date;

/** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtstart */
Expand Down Expand Up @@ -482,45 +478,102 @@ private function isDayEqual(\DateTime $dtStart, \DateTime $dtEnd) {
* @param string $inviteeName
*/
private function addSubjectAndHeading(IEMailTemplate $template, IL10N $l10n,
$method, $summary, $attendeeName, $inviteeName) {
$method, $summary) {
if ($method === self::METHOD_CANCEL) {
$template->setSubject('Cancelled: ' . $summary);
$template->addHeading($l10n->t('Invitation canceled'), $l10n->t('Hello %s,', [$attendeeName]));
$template->addBodyText($l10n->t('The meeting »%1$s« with %2$s was canceled.', [$summary, $inviteeName]));
$template->setSubject('Canceled: ' . $summary);
$template->addHeading($l10n->t('Invitation canceled'));
} else if ($method === self::METHOD_REPLY) {
$template->setSubject('Re: ' . $summary);
$template->addHeading($l10n->t('Invitation updated'), $l10n->t('Hello %s,', [$attendeeName]));
$template->addBodyText($l10n->t('The meeting »%1$s« with %2$s was updated.', [$summary, $inviteeName]));
$template->addHeading($l10n->t('Invitation updated'));
} else {
$template->setSubject('Invitation: ' . $summary);
$template->addHeading($l10n->t('%1$s invited you to »%2$s«', [$inviteeName, $summary]), $l10n->t('Hello %s,', [$attendeeName]));
$template->addHeading($l10n->t('Invitation'));
}
}

/**
* @param IEMailTemplate $template
* @param IL10N $l10n
* @param string $time
* @param string $location
* @param string $description
* @param string $url
* @param VEvent $vevent
*/
private function addBulletList(IEMailTemplate $template, IL10N $l10n, $time, $location, $description, $url) {
$template->addBodyListItem($time, $l10n->t('When:'),
$this->getAbsoluteImagePath('filetypes/text-calendar.svg'));
private function addEventTable(IEMailTemplate $template, IL10N $l10n, VEvent $vevent) {
$plainText = '';
$htmlText = vsprintf('<table style="%s">',[
"border: 2px solid black; border-collapse: collapse;"
]);
/* TODO [brad2014]: should tdHeadStyle background be a theme color? */
$trHtml = vsprintf('<tr style="%s"><td style="%s">%%s</td><td style="%s">%%s</td></tr>',
[
"vertical-align:top;",
"padding:3px .5em;background:#8cf;font-weight:bold;text-align:right;",
"padding:3px .5em;"
]);
if ($vevent->SUMMARY) {
$htmlText .= vsprintf($trHtml, [
htmlspecialchars($l10n->t('Title:')), htmlspecialchars($vevent->SUMMARY)
]);
$plainText .= vsprintf("%15s %s\n", [$l10n->t('Title:'), $vevent->SUMMARY]);
}
if ($vevent->LOCATION) {
$htmlText .= vsprintf($trHtml, [
htmlspecialchars($l10n->t('Location:')), htmlspecialchars($vevent->LOCATION)
]);
$plainText .= vsprintf("%15s %s\n", [$l10n->t('Location:'), $vevent->LOCATION]);
}
if ($vevent->URL) {
$htmlText .= vsprintf($trHtml, [
htmlspecialchars($l10n->t('Link:')), htmlspecialchars($vevent->URL)
]);
$plainText .= vsprintf("%15s %s\n", [$l10n->t('Link:'), $vevent->URL]);
}
if (true) {
$meetingWhen = $this->generateWhenString($l10n, $vevent);

if ($location) {
$template->addBodyListItem($location, $l10n->t('Where:'),
$this->getAbsoluteImagePath('filetypes/location.svg'));
$htmlText .= vsprintf($trHtml, [
htmlspecialchars($l10n->t('Time:')), htmlspecialchars($meetingWhen)
]);
$plainText .= vsprintf("%15s %s\n", [$l10n->t('Time:'), $meetingWhen]);
}
if ($description) {
$template->addBodyListItem((string)$description, $l10n->t('Description:'),
$this->getAbsoluteImagePath('filetypes/text.svg'));
if ($vevent->ORGANIZER) {
$organizer = $vevent->ORGANIZER;
$organizerName = substr($organizer->getValue(),7); // strip off mailto:
$partStat = $organizer->offsetGet('PARTSTAT');
if (($partStat instanceof Parameter) && (strcasecmp($partStat->getValue(), 'ACCEPTED') === 0)) {
$organizerName .= ' ✔︎';
}

$htmlText .= vsprintf($trHtml, [
htmlspecialchars($l10n->t('Organizer:')), htmlspecialchars($organizerName)
]);
$plainText .= vsprintf("%15s %s\n", [$l10n->t('Organizer:'), $organizerName]);
}
if ($url) {
$template->addBodyListItem((string)$url, $l10n->t('Link:'),
$this->getAbsoluteImagePath('filetypes/link.svg'));
if ($vevent->DESCRIPTION) {
$htmlText .= vsprintf($trHtml, [
htmlspecialchars($l10n->t('Description:')), str_replace(PHP_EOL,'<br/>', htmlspecialchars($vevent->DESCRIPTION))
]);
$plainText .= vsprintf("%15s %s\n", [
$l10n->t('Description:'),
str_replace(PHP_EOL, PHP_EOL.str_repeat(' ',16), $vevent->DESCRIPTION)]);
}
$attendees = $vevent->select('ATTENDEE');
$attendeeNames = [];
if (count($attendees)) {
foreach ($attendees as $attendee) {
$attendeeName = substr($attendee->getValue(),7); // strip off mailto:
$partStat = $attendee->offsetGet('PARTSTAT');
if (($partStat instanceof Parameter) && (strcasecmp($partStat->getValue(), 'ACCEPTED') === 0)) {
$attendeeName .= ' ✔︎';
}
array_push($attendeeNames, $attendeeName);
}
$htmlText .= vsprintf($trHtml, [
htmlspecialchars($l10n->t('Attendees:')), implode('<br/>',$attendeeNames)
]);
$plainText .= vsprintf("%15s %s\n", [$l10n->t('Attendees:'), implode(PHP_EOL.str_repeat(' ',16),$attendeeNames)]);
}
$htmlText .= '</table>';
$plainText .= PHP_EOL;
$template->addBodyText($htmlText, $plainText);
}

/**
Expand Down Expand Up @@ -555,16 +608,6 @@ private function addResponseButtons(IEMailTemplate $template, IL10N $l10n,
$template->addBodyText($html, $text);
}

/**
* @param string $path
* @return string
*/
private function getAbsoluteImagePath($path) {
return $this->urlGenerator->getAbsoluteURL(
$this->urlGenerator->imagePath('core', $path)
);
}

/**
* @param Message $iTipMessage
* @param int $lastOccurrence
Expand Down