nextcloud / server

apps/dav/lib/CalDAV/Reminder/NotificationProvider/EmailProvider.php

Indentation +409 added lines, -409 removed lines

@@ -51,413 +51,413 @@
  * @package OCA\DAV\CalDAV\Reminder\NotificationProvider
  */
 class EmailProvider extends AbstractProvider {
-	/** @var string */
-	public const NOTIFICATION_TYPE = 'EMAIL';
-
-	private IMailer $mailer;
-
-	public function __construct(IConfig $config,
-								IMailer $mailer,
-								LoggerInterface $logger,
-								L10NFactory $l10nFactory,
-								IURLGenerator $urlGenerator) {
-		parent::__construct($logger, $l10nFactory, $urlGenerator, $config);
-		$this->mailer = $mailer;
-	}
-
-	/**
-	 * Send out notification via email
-	 *
-	 * @param VEvent $vevent
-	 * @param string $calendarDisplayName
-	 * @param string[] $principalEmailAddresses
-	 * @param array $users
-	 * @throws \Exception
-	 */
-	public function send(VEvent $vevent,
-						 string $calendarDisplayName,
-						 array $principalEmailAddresses,
-						 array $users = []):void {
-		$fallbackLanguage = $this->getFallbackLanguage();
-
-		$organizerEmailAddress = null;
-		if (isset($vevent->ORGANIZER)) {
-			$organizerEmailAddress = $this->getEMailAddressOfAttendee($vevent->ORGANIZER);
-		}
-
-		$emailAddressesOfSharees = $this->getEMailAddressesOfAllUsersWithWriteAccessToCalendar($users);
-		$emailAddressesOfAttendees = [];
-		if (count($principalEmailAddresses) === 0
-			|| ($organizerEmailAddress && in_array($organizerEmailAddress, $principalEmailAddresses, true))
-		) {
-			$emailAddressesOfAttendees = $this->getAllEMailAddressesFromEvent($vevent);
-		}
-
-		// Quote from php.net:
-		// If the input arrays have the same string keys, then the later value for that key will overwrite the previous one.
-		// => if there are duplicate email addresses, it will always take the system value
-		$emailAddresses = array_merge(
-			$emailAddressesOfAttendees,
-			$emailAddressesOfSharees
-		);
-
-		$sortedByLanguage = $this->sortEMailAddressesByLanguage($emailAddresses, $fallbackLanguage);
-		$organizer = $this->getOrganizerEMailAndNameFromEvent($vevent);
-
-		foreach ($sortedByLanguage as $lang => $emailAddresses) {
-			if (!$this->hasL10NForLang($lang)) {
-				$lang = $fallbackLanguage;
-			}
-			$l10n = $this->getL10NForLang($lang);
-			$fromEMail = \OCP\Util::getDefaultEmailAddress('reminders-noreply');
-
-			$template = $this->mailer->createEMailTemplate('dav.calendarReminder');
-			$template->addHeader();
-			$this->addSubjectAndHeading($template, $l10n, $vevent);
-			$this->addBulletList($template, $l10n, $calendarDisplayName, $vevent);
-			$template->addFooter();
-
-			foreach ($emailAddresses as $emailAddress) {
-				if (!$this->mailer->validateMailAddress($emailAddress)) {
-					$this->logger->error('Email address {address} for reminder notification is incorrect', ['app' => 'dav', 'address' => $emailAddress]);
-					continue;
-				}
-
-				$message = $this->mailer->createMessage();
-				$message->setFrom([$fromEMail]);
-				if ($organizer) {
-					$message->setReplyTo($organizer);
-				}
-				$message->setTo([$emailAddress]);
-				$message->useTemplate($template);
-
-				try {
-					$failed = $this->mailer->send($message);
-					if ($failed) {
-						$this->logger->error('Unable to deliver message to {failed}', ['app' => 'dav', 'failed' => implode(', ', $failed)]);
-					}
-				} catch (\Exception $ex) {
-					$this->logger->error($ex->getMessage(), ['app' => 'dav', 'exception' => $ex]);
-				}
-			}
-		}
-	}
-
-	/**
-	 * @param IEMailTemplate $template
-	 * @param IL10N $l10n
-	 * @param VEvent $vevent
-	 */
-	private function addSubjectAndHeading(IEMailTemplate $template, IL10N $l10n, VEvent $vevent):void {
-		$template->setSubject('Notification: ' . $this->getTitleFromVEvent($vevent, $l10n));
-		$template->addHeading($this->getTitleFromVEvent($vevent, $l10n));
-	}
-
-	/**
-	 * @param IEMailTemplate $template
-	 * @param IL10N $l10n
-	 * @param string $calendarDisplayName
-	 * @param array $eventData
-	 */
-	private function addBulletList(IEMailTemplate $template,
-								   IL10N $l10n,
-								   string $calendarDisplayName,
-								   VEvent $vevent):void {
-		$template->addBodyListItem($calendarDisplayName, $l10n->t('Calendar:'),
-			$this->getAbsoluteImagePath('actions/info.png'));
-
-		$template->addBodyListItem($this->generateDateString($l10n, $vevent), $l10n->t('Date:'),
-			$this->getAbsoluteImagePath('places/calendar.png'));
-
-		if (isset($vevent->LOCATION)) {
-			$template->addBodyListItem((string) $vevent->LOCATION, $l10n->t('Where:'),
-				$this->getAbsoluteImagePath('actions/address.png'));
-		}
-		if (isset($vevent->DESCRIPTION)) {
-			$template->addBodyListItem((string) $vevent->DESCRIPTION, $l10n->t('Description:'),
-				$this->getAbsoluteImagePath('actions/more.png'));
-		}
-	}
-
-	private function getAbsoluteImagePath(string $path):string {
-		return $this->urlGenerator->getAbsoluteURL(
-			$this->urlGenerator->imagePath('core', $path)
-		);
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return array|null
-	 */
-	private function getOrganizerEMailAndNameFromEvent(VEvent $vevent):?array {
-		if (!$vevent->ORGANIZER) {
-			return null;
-		}
-
-		$organizer = $vevent->ORGANIZER;
-		if (strcasecmp($organizer->getValue(), 'mailto:') !== 0) {
-			return null;
-		}
-
-		$organizerEMail = substr($organizer->getValue(), 7);
-
-		if (!$this->mailer->validateMailAddress($organizerEMail)) {
-			return null;
-		}
-
-		$name = $organizer->offsetGet('CN');
-		if ($name instanceof Parameter) {
-			return [$organizerEMail => $name];
-		}
-
-		return [$organizerEMail];
-	}
-
-	/**
-	 * @param array<string, array{LANG?: string}> $emails
-	 * @return array<string, string[]>
-	 */
-	private function sortEMailAddressesByLanguage(array $emails,
-												  string $defaultLanguage):array {
-		$sortedByLanguage = [];
-
-		foreach ($emails as $emailAddress => $parameters) {
-			if (isset($parameters['LANG'])) {
-				$lang = $parameters['LANG'];
-			} else {
-				$lang = $defaultLanguage;
-			}
-
-			if (!isset($sortedByLanguage[$lang])) {
-				$sortedByLanguage[$lang] = [];
-			}
-
-			$sortedByLanguage[$lang][] = $emailAddress;
-		}
-
-		return $sortedByLanguage;
-	}
-
-	/**
-	 * @param VEvent $vevent
-	 * @return array<string, array{LANG?: string}>
-	 */
-	private function getAllEMailAddressesFromEvent(VEvent $vevent):array {
-		$emailAddresses = [];
-
-		if (isset($vevent->ATTENDEE)) {
-			foreach ($vevent->ATTENDEE as $attendee) {
-				if (!($attendee instanceof VObject\Property)) {
-					continue;
-				}
-
-				$cuType = $this->getCUTypeOfAttendee($attendee);
-				if (\in_array($cuType, ['RESOURCE', 'ROOM', 'UNKNOWN'])) {
-					// Don't send emails to things
-					continue;
-				}
-
-				$partstat = $this->getPartstatOfAttendee($attendee);
-				if ($partstat === 'DECLINED') {
-					// Don't send out emails to people who declined
-					continue;
-				}
-				if ($partstat === 'DELEGATED') {
-					$delegates = $attendee->offsetGet('DELEGATED-TO');
-					if (!($delegates instanceof VObject\Parameter)) {
-						continue;
-					}
-
-					$emailAddressesOfDelegates = $delegates->getParts();
-					foreach ($emailAddressesOfDelegates as $addressesOfDelegate) {
-						if (strcasecmp($addressesOfDelegate, 'mailto:') === 0) {
-							$delegateEmail = substr($addressesOfDelegate, 7);
-							if ($this->mailer->validateMailAddress($delegateEmail)) {
-								$emailAddresses[$delegateEmail] = [];
-							}
-						}
-					}
-
-					continue;
-				}
-
-				$emailAddressOfAttendee = $this->getEMailAddressOfAttendee($attendee);
-				if ($emailAddressOfAttendee !== null) {
-					$properties = [];
-
-					$langProp = $attendee->offsetGet('LANG');
-					if ($langProp instanceof VObject\Parameter && $langProp->getValue() !== null) {
-						$properties['LANG'] = $langProp->getValue();
-					}
-
-					$emailAddresses[$emailAddressOfAttendee] = $properties;
-				}
-			}
-		}
-
-		if (isset($vevent->ORGANIZER) && $this->hasAttendeeMailURI($vevent->ORGANIZER)) {
-			$organizerEmailAddress = $this->getEMailAddressOfAttendee($vevent->ORGANIZER);
-			if ($organizerEmailAddress !== null) {
-				$emailAddresses[$organizerEmailAddress] = [];
-			}
-		}
-
-		return $emailAddresses;
-	}
-
-	private function getCUTypeOfAttendee(VObject\Property $attendee):string {
-		$cuType = $attendee->offsetGet('CUTYPE');
-		if ($cuType instanceof VObject\Parameter) {
-			return strtoupper($cuType->getValue());
-		}
-
-		return 'INDIVIDUAL';
-	}
-
-	private function getPartstatOfAttendee(VObject\Property $attendee):string {
-		$partstat = $attendee->offsetGet('PARTSTAT');
-		if ($partstat instanceof VObject\Parameter) {
-			return strtoupper($partstat->getValue());
-		}
-
-		return 'NEEDS-ACTION';
-	}
-
-	private function hasAttendeeMailURI(VObject\Property $attendee): bool {
-		return stripos($attendee->getValue(), 'mailto:') === 0;
-	}
-
-	private function getEMailAddressOfAttendee(VObject\Property $attendee): ?string {
-		if (!$this->hasAttendeeMailURI($attendee)) {
-			return null;
-		}
-		$attendeeEMail = substr($attendee->getValue(), 7);
-		if (!$this->mailer->validateMailAddress($attendeeEMail)) {
-			return null;
-		}
-
-		return $attendeeEMail;
-	}
-
-	/**
-	 * @param IUser[] $users
-	 * @return array<string, array{LANG?: string}>
-	 */
-	private function getEMailAddressesOfAllUsersWithWriteAccessToCalendar(array $users):array {
-		$emailAddresses = [];
-
-		foreach ($users as $user) {
-			$emailAddress = $user->getEMailAddress();
-			if ($emailAddress) {
-				$lang = $this->l10nFactory->getUserLanguage($user);
-				if ($lang) {
-					$emailAddresses[$emailAddress] = [
-						'LANG' => $lang,
-					];
-				} else {
-					$emailAddresses[$emailAddress] = [];
-				}
-			}
-		}
-
-		return $emailAddresses;
-	}
-
-	/**
-	 * @throws \Exception
-	 */
-	private function generateDateString(IL10N $l10n, VEvent $vevent): string {
-		$isAllDay = $vevent->DTSTART instanceof Property\ICalendar\Date;
-
-		/** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtstart */
-		/** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtend */
-		/** @var \DateTimeImmutable $dtstartDt */
-		$dtstartDt = $vevent->DTSTART->getDateTime();
-		/** @var \DateTimeImmutable $dtendDt */
-		$dtendDt = $this->getDTEndFromEvent($vevent)->getDateTime();
-
-		$diff = $dtstartDt->diff($dtendDt);
-
-		$dtstartDt = new \DateTime($dtstartDt->format(\DateTimeInterface::ATOM));
-		$dtendDt = new \DateTime($dtendDt->format(\DateTimeInterface::ATOM));
-
-		if ($isAllDay) {
-			// One day event
-			if ($diff->days === 1) {
-				return $this->getDateString($l10n, $dtstartDt);
-			}
-
-			return implode(' - ', [
-				$this->getDateString($l10n, $dtstartDt),
-				$this->getDateString($l10n, $dtendDt),
-			]);
-		}
-
-		$startTimezone = $endTimezone = null;
-		if (!$vevent->DTSTART->isFloating()) {
-			$startTimezone = $vevent->DTSTART->getDateTime()->getTimezone()->getName();
-			$endTimezone = $this->getDTEndFromEvent($vevent)->getDateTime()->getTimezone()->getName();
-		}
-
-		$localeStart = implode(', ', [
-			$this->getWeekDayName($l10n, $dtstartDt),
-			$this->getDateTimeString($l10n, $dtstartDt)
-		]);
-
-		// always show full date with timezone if timezones are different
-		if ($startTimezone !== $endTimezone) {
-			$localeEnd = implode(', ', [
-				$this->getWeekDayName($l10n, $dtendDt),
-				$this->getDateTimeString($l10n, $dtendDt)
-			]);
-
-			return $localeStart
-				. ' (' . $startTimezone . ') '
-				. ' - '
-				. $localeEnd
-				. ' (' . $endTimezone . ')';
-		}
-
-		// Show only the time if the day is the same
-		$localeEnd = $this->isDayEqual($dtstartDt, $dtendDt)
-			? $this->getTimeString($l10n, $dtendDt)
-			: implode(', ', [
-				$this->getWeekDayName($l10n, $dtendDt),
-				$this->getDateTimeString($l10n, $dtendDt)
-			]);
-
-		return $localeStart
-			. ' - '
-			. $localeEnd
-			. ' (' . $startTimezone . ')';
-	}
-
-	private function isDayEqual(DateTime $dtStart,
-								DateTime $dtEnd):bool {
-		return $dtStart->format('Y-m-d') === $dtEnd->format('Y-m-d');
-	}
-
-	private function getWeekDayName(IL10N $l10n, DateTime $dt):string {
-		return (string)$l10n->l('weekdayName', $dt, ['width' => 'abbreviated']);
-	}
-
-	private function getDateString(IL10N $l10n, DateTime $dt):string {
-		return (string)$l10n->l('date', $dt, ['width' => 'medium']);
-	}
-
-	private function getDateTimeString(IL10N $l10n, DateTime $dt):string {
-		return (string)$l10n->l('datetime', $dt, ['width' => 'medium|short']);
-	}
-
-	private function getTimeString(IL10N $l10n, DateTime $dt):string {
-		return (string)$l10n->l('time', $dt, ['width' => 'short']);
-	}
-
-	private function getTitleFromVEvent(VEvent $vevent, IL10N $l10n):string {
-		if (isset($vevent->SUMMARY)) {
-			return (string)$vevent->SUMMARY;
-		}
-
-		return $l10n->t('Untitled event');
-	}
+    /** @var string */
+    public const NOTIFICATION_TYPE = 'EMAIL';
+
+    private IMailer $mailer;
+
+    public function __construct(IConfig $config,
+                                IMailer $mailer,
+                                LoggerInterface $logger,
+                                L10NFactory $l10nFactory,
+                                IURLGenerator $urlGenerator) {
+        parent::__construct($logger, $l10nFactory, $urlGenerator, $config);
+        $this->mailer = $mailer;
+    }
+
+    /**
+     * Send out notification via email
+     *
+     * @param VEvent $vevent
+     * @param string $calendarDisplayName
+     * @param string[] $principalEmailAddresses
+     * @param array $users
+     * @throws \Exception
+     */
+    public function send(VEvent $vevent,
+                            string $calendarDisplayName,
+                            array $principalEmailAddresses,
+                            array $users = []):void {
+        $fallbackLanguage = $this->getFallbackLanguage();
+
+        $organizerEmailAddress = null;
+        if (isset($vevent->ORGANIZER)) {
+            $organizerEmailAddress = $this->getEMailAddressOfAttendee($vevent->ORGANIZER);
+        }
+
+        $emailAddressesOfSharees = $this->getEMailAddressesOfAllUsersWithWriteAccessToCalendar($users);
+        $emailAddressesOfAttendees = [];
+        if (count($principalEmailAddresses) === 0
+            || ($organizerEmailAddress && in_array($organizerEmailAddress, $principalEmailAddresses, true))
+        ) {
+            $emailAddressesOfAttendees = $this->getAllEMailAddressesFromEvent($vevent);
+        }
+
+        // Quote from php.net:
+        // If the input arrays have the same string keys, then the later value for that key will overwrite the previous one.
+        // => if there are duplicate email addresses, it will always take the system value
+        $emailAddresses = array_merge(
+            $emailAddressesOfAttendees,
+            $emailAddressesOfSharees
+        );
+
+        $sortedByLanguage = $this->sortEMailAddressesByLanguage($emailAddresses, $fallbackLanguage);
+        $organizer = $this->getOrganizerEMailAndNameFromEvent($vevent);
+
+        foreach ($sortedByLanguage as $lang => $emailAddresses) {
+            if (!$this->hasL10NForLang($lang)) {
+                $lang = $fallbackLanguage;
+            }
+            $l10n = $this->getL10NForLang($lang);
+            $fromEMail = \OCP\Util::getDefaultEmailAddress('reminders-noreply');
+
+            $template = $this->mailer->createEMailTemplate('dav.calendarReminder');
+            $template->addHeader();
+            $this->addSubjectAndHeading($template, $l10n, $vevent);
+            $this->addBulletList($template, $l10n, $calendarDisplayName, $vevent);
+            $template->addFooter();
+
+            foreach ($emailAddresses as $emailAddress) {
+                if (!$this->mailer->validateMailAddress($emailAddress)) {
+                    $this->logger->error('Email address {address} for reminder notification is incorrect', ['app' => 'dav', 'address' => $emailAddress]);
+                    continue;
+                }
+
+                $message = $this->mailer->createMessage();
+                $message->setFrom([$fromEMail]);
+                if ($organizer) {
+                    $message->setReplyTo($organizer);
+                }
+                $message->setTo([$emailAddress]);
+                $message->useTemplate($template);
+
+                try {
+                    $failed = $this->mailer->send($message);
+                    if ($failed) {
+                        $this->logger->error('Unable to deliver message to {failed}', ['app' => 'dav', 'failed' => implode(', ', $failed)]);
+                    }
+                } catch (\Exception $ex) {
+                    $this->logger->error($ex->getMessage(), ['app' => 'dav', 'exception' => $ex]);
+                }
+            }
+        }
+    }
+
+    /**
+     * @param IEMailTemplate $template
+     * @param IL10N $l10n
+     * @param VEvent $vevent
+     */
+    private function addSubjectAndHeading(IEMailTemplate $template, IL10N $l10n, VEvent $vevent):void {
+        $template->setSubject('Notification: ' . $this->getTitleFromVEvent($vevent, $l10n));
+        $template->addHeading($this->getTitleFromVEvent($vevent, $l10n));
+    }
+
+    /**
+     * @param IEMailTemplate $template
+     * @param IL10N $l10n
+     * @param string $calendarDisplayName
+     * @param array $eventData
+     */
+    private function addBulletList(IEMailTemplate $template,
+                                    IL10N $l10n,
+                                    string $calendarDisplayName,
+                                    VEvent $vevent):void {
+        $template->addBodyListItem($calendarDisplayName, $l10n->t('Calendar:'),
+            $this->getAbsoluteImagePath('actions/info.png'));
+
+        $template->addBodyListItem($this->generateDateString($l10n, $vevent), $l10n->t('Date:'),
+            $this->getAbsoluteImagePath('places/calendar.png'));
+
+        if (isset($vevent->LOCATION)) {
+            $template->addBodyListItem((string) $vevent->LOCATION, $l10n->t('Where:'),
+                $this->getAbsoluteImagePath('actions/address.png'));
+        }
+        if (isset($vevent->DESCRIPTION)) {
+            $template->addBodyListItem((string) $vevent->DESCRIPTION, $l10n->t('Description:'),
+                $this->getAbsoluteImagePath('actions/more.png'));
+        }
+    }
+
+    private function getAbsoluteImagePath(string $path):string {
+        return $this->urlGenerator->getAbsoluteURL(
+            $this->urlGenerator->imagePath('core', $path)
+        );
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return array|null
+     */
+    private function getOrganizerEMailAndNameFromEvent(VEvent $vevent):?array {
+        if (!$vevent->ORGANIZER) {
+            return null;
+        }
+
+        $organizer = $vevent->ORGANIZER;
+        if (strcasecmp($organizer->getValue(), 'mailto:') !== 0) {
+            return null;
+        }
+
+        $organizerEMail = substr($organizer->getValue(), 7);
+
+        if (!$this->mailer->validateMailAddress($organizerEMail)) {
+            return null;
+        }
+
+        $name = $organizer->offsetGet('CN');
+        if ($name instanceof Parameter) {
+            return [$organizerEMail => $name];
+        }
+
+        return [$organizerEMail];
+    }
+
+    /**
+     * @param array<string, array{LANG?: string}> $emails
+     * @return array<string, string[]>
+     */
+    private function sortEMailAddressesByLanguage(array $emails,
+                                                    string $defaultLanguage):array {
+        $sortedByLanguage = [];
+
+        foreach ($emails as $emailAddress => $parameters) {
+            if (isset($parameters['LANG'])) {
+                $lang = $parameters['LANG'];
+            } else {
+                $lang = $defaultLanguage;
+            }
+
+            if (!isset($sortedByLanguage[$lang])) {
+                $sortedByLanguage[$lang] = [];
+            }
+
+            $sortedByLanguage[$lang][] = $emailAddress;
+        }
+
+        return $sortedByLanguage;
+    }
+
+    /**
+     * @param VEvent $vevent
+     * @return array<string, array{LANG?: string}>
+     */
+    private function getAllEMailAddressesFromEvent(VEvent $vevent):array {
+        $emailAddresses = [];
+
+        if (isset($vevent->ATTENDEE)) {
+            foreach ($vevent->ATTENDEE as $attendee) {
+                if (!($attendee instanceof VObject\Property)) {
+                    continue;
+                }
+
+                $cuType = $this->getCUTypeOfAttendee($attendee);
+                if (\in_array($cuType, ['RESOURCE', 'ROOM', 'UNKNOWN'])) {
+                    // Don't send emails to things
+                    continue;
+                }
+
+                $partstat = $this->getPartstatOfAttendee($attendee);
+                if ($partstat === 'DECLINED') {
+                    // Don't send out emails to people who declined
+                    continue;
+                }
+                if ($partstat === 'DELEGATED') {
+                    $delegates = $attendee->offsetGet('DELEGATED-TO');
+                    if (!($delegates instanceof VObject\Parameter)) {
+                        continue;
+                    }
+
+                    $emailAddressesOfDelegates = $delegates->getParts();
+                    foreach ($emailAddressesOfDelegates as $addressesOfDelegate) {
+                        if (strcasecmp($addressesOfDelegate, 'mailto:') === 0) {
+                            $delegateEmail = substr($addressesOfDelegate, 7);
+                            if ($this->mailer->validateMailAddress($delegateEmail)) {
+                                $emailAddresses[$delegateEmail] = [];
+                            }
+                        }
+                    }
+
+                    continue;
+                }
+
+                $emailAddressOfAttendee = $this->getEMailAddressOfAttendee($attendee);
+                if ($emailAddressOfAttendee !== null) {
+                    $properties = [];
+
+                    $langProp = $attendee->offsetGet('LANG');
+                    if ($langProp instanceof VObject\Parameter && $langProp->getValue() !== null) {
+                        $properties['LANG'] = $langProp->getValue();
+                    }
+
+                    $emailAddresses[$emailAddressOfAttendee] = $properties;
+                }
+            }
+        }
+
+        if (isset($vevent->ORGANIZER) && $this->hasAttendeeMailURI($vevent->ORGANIZER)) {
+            $organizerEmailAddress = $this->getEMailAddressOfAttendee($vevent->ORGANIZER);
+            if ($organizerEmailAddress !== null) {
+                $emailAddresses[$organizerEmailAddress] = [];
+            }
+        }
+
+        return $emailAddresses;
+    }
+
+    private function getCUTypeOfAttendee(VObject\Property $attendee):string {
+        $cuType = $attendee->offsetGet('CUTYPE');
+        if ($cuType instanceof VObject\Parameter) {
+            return strtoupper($cuType->getValue());
+        }
+
+        return 'INDIVIDUAL';
+    }
+
+    private function getPartstatOfAttendee(VObject\Property $attendee):string {
+        $partstat = $attendee->offsetGet('PARTSTAT');
+        if ($partstat instanceof VObject\Parameter) {
+            return strtoupper($partstat->getValue());
+        }
+
+        return 'NEEDS-ACTION';
+    }
+
+    private function hasAttendeeMailURI(VObject\Property $attendee): bool {
+        return stripos($attendee->getValue(), 'mailto:') === 0;
+    }
+
+    private function getEMailAddressOfAttendee(VObject\Property $attendee): ?string {
+        if (!$this->hasAttendeeMailURI($attendee)) {
+            return null;
+        }
+        $attendeeEMail = substr($attendee->getValue(), 7);
+        if (!$this->mailer->validateMailAddress($attendeeEMail)) {
+            return null;
+        }
+
+        return $attendeeEMail;
+    }
+
+    /**
+     * @param IUser[] $users
+     * @return array<string, array{LANG?: string}>
+     */
+    private function getEMailAddressesOfAllUsersWithWriteAccessToCalendar(array $users):array {
+        $emailAddresses = [];
+
+        foreach ($users as $user) {
+            $emailAddress = $user->getEMailAddress();
+            if ($emailAddress) {
+                $lang = $this->l10nFactory->getUserLanguage($user);
+                if ($lang) {
+                    $emailAddresses[$emailAddress] = [
+                        'LANG' => $lang,
+                    ];
+                } else {
+                    $emailAddresses[$emailAddress] = [];
+                }
+            }
+        }
+
+        return $emailAddresses;
+    }
+
+    /**
+     * @throws \Exception
+     */
+    private function generateDateString(IL10N $l10n, VEvent $vevent): string {
+        $isAllDay = $vevent->DTSTART instanceof Property\ICalendar\Date;
+
+        /** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtstart */
+        /** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtend */
+        /** @var \DateTimeImmutable $dtstartDt */
+        $dtstartDt = $vevent->DTSTART->getDateTime();
+        /** @var \DateTimeImmutable $dtendDt */
+        $dtendDt = $this->getDTEndFromEvent($vevent)->getDateTime();
+
+        $diff = $dtstartDt->diff($dtendDt);
+
+        $dtstartDt = new \DateTime($dtstartDt->format(\DateTimeInterface::ATOM));
+        $dtendDt = new \DateTime($dtendDt->format(\DateTimeInterface::ATOM));
+
+        if ($isAllDay) {
+            // One day event
+            if ($diff->days === 1) {
+                return $this->getDateString($l10n, $dtstartDt);
+            }
+
+            return implode(' - ', [
+                $this->getDateString($l10n, $dtstartDt),
+                $this->getDateString($l10n, $dtendDt),
+            ]);
+        }
+
+        $startTimezone = $endTimezone = null;
+        if (!$vevent->DTSTART->isFloating()) {
+            $startTimezone = $vevent->DTSTART->getDateTime()->getTimezone()->getName();
+            $endTimezone = $this->getDTEndFromEvent($vevent)->getDateTime()->getTimezone()->getName();
+        }
+
+        $localeStart = implode(', ', [
+            $this->getWeekDayName($l10n, $dtstartDt),
+            $this->getDateTimeString($l10n, $dtstartDt)
+        ]);
+
+        // always show full date with timezone if timezones are different
+        if ($startTimezone !== $endTimezone) {
+            $localeEnd = implode(', ', [
+                $this->getWeekDayName($l10n, $dtendDt),
+                $this->getDateTimeString($l10n, $dtendDt)
+            ]);
+
+            return $localeStart
+                . ' (' . $startTimezone . ') '
+                . ' - '
+                . $localeEnd
+                . ' (' . $endTimezone . ')';
+        }
+
+        // Show only the time if the day is the same
+        $localeEnd = $this->isDayEqual($dtstartDt, $dtendDt)
+            ? $this->getTimeString($l10n, $dtendDt)
+            : implode(', ', [
+                $this->getWeekDayName($l10n, $dtendDt),
+                $this->getDateTimeString($l10n, $dtendDt)
+            ]);
+
+        return $localeStart
+            . ' - '
+            . $localeEnd
+            . ' (' . $startTimezone . ')';
+    }
+
+    private function isDayEqual(DateTime $dtStart,
+                                DateTime $dtEnd):bool {
+        return $dtStart->format('Y-m-d') === $dtEnd->format('Y-m-d');
+    }
+
+    private function getWeekDayName(IL10N $l10n, DateTime $dt):string {
+        return (string)$l10n->l('weekdayName', $dt, ['width' => 'abbreviated']);
+    }
+
+    private function getDateString(IL10N $l10n, DateTime $dt):string {
+        return (string)$l10n->l('date', $dt, ['width' => 'medium']);
+    }
+
+    private function getDateTimeString(IL10N $l10n, DateTime $dt):string {
+        return (string)$l10n->l('datetime', $dt, ['width' => 'medium|short']);
+    }
+
+    private function getTimeString(IL10N $l10n, DateTime $dt):string {
+        return (string)$l10n->l('time', $dt, ['width' => 'short']);
+    }
+
+    private function getTitleFromVEvent(VEvent $vevent, IL10N $l10n):string {
+        if (isset($vevent->SUMMARY)) {
+            return (string)$vevent->SUMMARY;
+        }
+
+        return $l10n->t('Untitled event');
+    }
 }

apps/dav/lib/CalDAV/Schedule/IMipPlugin.php

Indentation +614 added lines, -614 removed lines

@@ -71,171 +71,171 @@ 
  * @license http://sabre.io/license/ Modified BSD License
  */
 class IMipPlugin extends SabreIMipPlugin {
-	/** @var string */
-	private $userId;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var IMailer */
-	private $mailer;
-
-	private LoggerInterface $logger;
-
-	/** @var ITimeFactory */
-	private $timeFactory;
-
-	/** @var L10NFactory */
-	private $l10nFactory;
-
-	/** @var IURLGenerator */
-	private $urlGenerator;
-
-	/** @var ISecureRandom */
-	private $random;
-
-	/** @var IDBConnection */
-	private $db;
-
-	/** @var Defaults */
-	private $defaults;
-
-	/** @var IUserManager */
-	private $userManager;
-
-	public const MAX_DATE = '2038-01-01';
-
-	public const METHOD_REQUEST = 'request';
-	public const METHOD_REPLY = 'reply';
-	public const METHOD_CANCEL = 'cancel';
-	public const IMIP_INDENT = 15; // Enough for the length of all body bullet items, in all languages
-
-	public function __construct(IConfig $config, IMailer $mailer,
-								LoggerInterface $logger,
-								ITimeFactory $timeFactory, L10NFactory $l10nFactory,
-								IURLGenerator $urlGenerator, Defaults $defaults,
-								ISecureRandom $random, IDBConnection $db, IUserManager $userManager,
-								$userId) {
-		parent::__construct('');
-		$this->userId = $userId;
-		$this->config = $config;
-		$this->mailer = $mailer;
-		$this->logger = $logger;
-		$this->timeFactory = $timeFactory;
-		$this->l10nFactory = $l10nFactory;
-		$this->urlGenerator = $urlGenerator;
-		$this->random = $random;
-		$this->db = $db;
-		$this->defaults = $defaults;
-		$this->userManager = $userManager;
-	}
-
-	/**
-	 * Event handler for the 'schedule' event.
-	 *
-	 * @param Message $iTipMessage
-	 * @return void
-	 */
-	public function schedule(Message $iTipMessage) {
-		// Not sending any emails if the system considers the update
-		// insignificant.
-		if (!$iTipMessage->significantChange) {
-			if (!$iTipMessage->scheduleStatus) {
-				$iTipMessage->scheduleStatus = '1.0;We got the message, but it\'s not significant enough to warrant an email';
-			}
-			return;
-		}
-
-		$summary = $iTipMessage->message->VEVENT->SUMMARY;
-
-		if (parse_url($iTipMessage->sender, PHP_URL_SCHEME) !== 'mailto') {
-			return;
-		}
-
-		if (parse_url($iTipMessage->recipient, PHP_URL_SCHEME) !== 'mailto') {
-			return;
-		}
-
-		// don't send out mails for events that already took place
-		$lastOccurrence = $this->getLastOccurrence($iTipMessage->message);
-		$currentTime = $this->timeFactory->getTime();
-		if ($lastOccurrence < $currentTime) {
-			return;
-		}
-
-		// Strip off mailto:
-		$sender = substr($iTipMessage->sender, 7);
-		$recipient = substr($iTipMessage->recipient, 7);
-		if (!$this->mailer->validateMailAddress($recipient)) {
-			// Nothing to send if the recipient doesn't have a valid email address
-			$iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
-			return;
-		}
-
-		$senderName = $iTipMessage->senderName ?: null;
-		$recipientName = $iTipMessage->recipientName ?: null;
-
-		if ($senderName === null || empty(trim($senderName))) {
-			$senderName = $this->userManager->getDisplayName($this->userId);
-		}
-
-		/** @var VEvent $vevent */
-		$vevent = $iTipMessage->message->VEVENT;
-
-		$attendee = $this->getCurrentAttendee($iTipMessage);
-		$defaultLang = $this->l10nFactory->findGenericLanguage();
-		$lang = $this->getAttendeeLangOrDefault($defaultLang, $attendee);
-		$l10n = $this->l10nFactory->get('dav', $lang);
-
-		$meetingAttendeeName = $recipientName ?: $recipient;
-		$meetingInviteeName = $senderName ?: $sender;
-
-		$meetingTitle = $vevent->SUMMARY;
-		$meetingDescription = $vevent->DESCRIPTION;
-
-
-		$meetingUrl = $vevent->URL;
-		$meetingLocation = $vevent->LOCATION;
-
-		$defaultVal = '--';
-
-		$method = self::METHOD_REQUEST;
-		switch (strtolower($iTipMessage->method)) {
-			case self::METHOD_REPLY:
-				$method = self::METHOD_REPLY;
-				break;
-			case self::METHOD_CANCEL:
-				$method = self::METHOD_CANCEL;
-				break;
-		}
-
-		$data = [
-			'attendee_name' => (string)$meetingAttendeeName ?: $defaultVal,
-			'invitee_name' => (string)$meetingInviteeName ?: $defaultVal,
-			'meeting_title' => (string)$meetingTitle ?: $defaultVal,
-			'meeting_description' => (string)$meetingDescription ?: $defaultVal,
-			'meeting_url' => (string)$meetingUrl ?: $defaultVal,
-		];
-
-		$fromEMail = Util::getDefaultEmailAddress('invitations-noreply');
-		$fromName = $l10n->t('%1$s via %2$s', [$senderName ?? $this->userId, $this->defaults->getName()]);
-
-		$message = $this->mailer->createMessage()
-			->setFrom([$fromEMail => $fromName])
-			->setTo([$recipient => $recipientName])
-			->setReplyTo([$sender => $senderName]);
-
-		$template = $this->mailer->createEMailTemplate('dav.calendarInvite.' . $method, $data);
-		$template->addHeader();
-
-		$summary = ((string) $summary !== '') ? (string) $summary : $l10n->t('Untitled event');
-
-		$this->addSubjectAndHeading($template, $l10n, $method, $summary);
-		$this->addBulletList($template, $l10n, $vevent);
-
-		// Only add response buttons to invitation requests: Fix Issue #11230
-		if (($method == self::METHOD_REQUEST) && $this->getAttendeeRsvpOrReqForParticipant($attendee)) {
-			/*
+    /** @var string */
+    private $userId;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var IMailer */
+    private $mailer;
+
+    private LoggerInterface $logger;
+
+    /** @var ITimeFactory */
+    private $timeFactory;
+
+    /** @var L10NFactory */
+    private $l10nFactory;
+
+    /** @var IURLGenerator */
+    private $urlGenerator;
+
+    /** @var ISecureRandom */
+    private $random;
+
+    /** @var IDBConnection */
+    private $db;
+
+    /** @var Defaults */
+    private $defaults;
+
+    /** @var IUserManager */
+    private $userManager;
+
+    public const MAX_DATE = '2038-01-01';
+
+    public const METHOD_REQUEST = 'request';
+    public const METHOD_REPLY = 'reply';
+    public const METHOD_CANCEL = 'cancel';
+    public const IMIP_INDENT = 15; // Enough for the length of all body bullet items, in all languages
+
+    public function __construct(IConfig $config, IMailer $mailer,
+                                LoggerInterface $logger,
+                                ITimeFactory $timeFactory, L10NFactory $l10nFactory,
+                                IURLGenerator $urlGenerator, Defaults $defaults,
+                                ISecureRandom $random, IDBConnection $db, IUserManager $userManager,
+                                $userId) {
+        parent::__construct('');
+        $this->userId = $userId;
+        $this->config = $config;
+        $this->mailer = $mailer;
+        $this->logger = $logger;
+        $this->timeFactory = $timeFactory;
+        $this->l10nFactory = $l10nFactory;
+        $this->urlGenerator = $urlGenerator;
+        $this->random = $random;
+        $this->db = $db;
+        $this->defaults = $defaults;
+        $this->userManager = $userManager;
+    }
+
+    /**
+     * Event handler for the 'schedule' event.
+     *
+     * @param Message $iTipMessage
+     * @return void
+     */
+    public function schedule(Message $iTipMessage) {
+        // Not sending any emails if the system considers the update
+        // insignificant.
+        if (!$iTipMessage->significantChange) {
+            if (!$iTipMessage->scheduleStatus) {
+                $iTipMessage->scheduleStatus = '1.0;We got the message, but it\'s not significant enough to warrant an email';
+            }
+            return;
+        }
+
+        $summary = $iTipMessage->message->VEVENT->SUMMARY;
+
+        if (parse_url($iTipMessage->sender, PHP_URL_SCHEME) !== 'mailto') {
+            return;
+        }
+
+        if (parse_url($iTipMessage->recipient, PHP_URL_SCHEME) !== 'mailto') {
+            return;
+        }
+
+        // don't send out mails for events that already took place
+        $lastOccurrence = $this->getLastOccurrence($iTipMessage->message);
+        $currentTime = $this->timeFactory->getTime();
+        if ($lastOccurrence < $currentTime) {
+            return;
+        }
+
+        // Strip off mailto:
+        $sender = substr($iTipMessage->sender, 7);
+        $recipient = substr($iTipMessage->recipient, 7);
+        if (!$this->mailer->validateMailAddress($recipient)) {
+            // Nothing to send if the recipient doesn't have a valid email address
+            $iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
+            return;
+        }
+
+        $senderName = $iTipMessage->senderName ?: null;
+        $recipientName = $iTipMessage->recipientName ?: null;
+
+        if ($senderName === null || empty(trim($senderName))) {
+            $senderName = $this->userManager->getDisplayName($this->userId);
+        }
+
+        /** @var VEvent $vevent */
+        $vevent = $iTipMessage->message->VEVENT;
+
+        $attendee = $this->getCurrentAttendee($iTipMessage);
+        $defaultLang = $this->l10nFactory->findGenericLanguage();
+        $lang = $this->getAttendeeLangOrDefault($defaultLang, $attendee);
+        $l10n = $this->l10nFactory->get('dav', $lang);
+
+        $meetingAttendeeName = $recipientName ?: $recipient;
+        $meetingInviteeName = $senderName ?: $sender;
+
+        $meetingTitle = $vevent->SUMMARY;
+        $meetingDescription = $vevent->DESCRIPTION;
+
+
+        $meetingUrl = $vevent->URL;
+        $meetingLocation = $vevent->LOCATION;
+
+        $defaultVal = '--';
+
+        $method = self::METHOD_REQUEST;
+        switch (strtolower($iTipMessage->method)) {
+            case self::METHOD_REPLY:
+                $method = self::METHOD_REPLY;
+                break;
+            case self::METHOD_CANCEL:
+                $method = self::METHOD_CANCEL;
+                break;
+        }
+
+        $data = [
+            'attendee_name' => (string)$meetingAttendeeName ?: $defaultVal,
+            'invitee_name' => (string)$meetingInviteeName ?: $defaultVal,
+            'meeting_title' => (string)$meetingTitle ?: $defaultVal,
+            'meeting_description' => (string)$meetingDescription ?: $defaultVal,
+            'meeting_url' => (string)$meetingUrl ?: $defaultVal,
+        ];
+
+        $fromEMail = Util::getDefaultEmailAddress('invitations-noreply');
+        $fromName = $l10n->t('%1$s via %2$s', [$senderName ?? $this->userId, $this->defaults->getName()]);
+
+        $message = $this->mailer->createMessage()
+            ->setFrom([$fromEMail => $fromName])
+            ->setTo([$recipient => $recipientName])
+            ->setReplyTo([$sender => $senderName]);
+
+        $template = $this->mailer->createEMailTemplate('dav.calendarInvite.' . $method, $data);
+        $template->addHeader();
+
+        $summary = ((string) $summary !== '') ? (string) $summary : $l10n->t('Untitled event');
+
+        $this->addSubjectAndHeading($template, $l10n, $method, $summary);
+        $this->addBulletList($template, $l10n, $vevent);
+
+        // Only add response buttons to invitation requests: Fix Issue #11230
+        if (($method == self::METHOD_REQUEST) && $this->getAttendeeRsvpOrReqForParticipant($attendee)) {
+            /*
 			** Only offer invitation accept/reject buttons, which link back to the
 			** nextcloud server, to recipients who can access the nextcloud server via
 			** their internet/intranet.  Issue #12156
@@ -254,453 +254,453 @@ 
 			** To suppress URLs entirely, set invitation_link_recipients to boolean "no".
 			*/
 
-			$recipientDomain = substr(strrchr($recipient, "@"), 1);
-			$invitationLinkRecipients = explode(',', preg_replace('/\s+/', '', strtolower($this->config->getAppValue('dav', 'invitation_link_recipients', 'yes'))));
-
-			if (strcmp('yes', $invitationLinkRecipients[0]) === 0
-				 || in_array(strtolower($recipient), $invitationLinkRecipients)
-				 || in_array(strtolower($recipientDomain), $invitationLinkRecipients)) {
-				$this->addResponseButtons($template, $l10n, $iTipMessage, $lastOccurrence);
-			}
-		}
-
-		$template->addFooter();
-
-		$message->useTemplate($template);
-
-		$attachment = $this->mailer->createAttachment(
-			$iTipMessage->message->serialize(),
-			'event.ics',// TODO(leon): Make file name unique, e.g. add event id
-			'text/calendar; method=' . $iTipMessage->method
-		);
-		$message->attach($attachment);
-
-		try {
-			$failed = $this->mailer->send($message);
-			$iTipMessage->scheduleStatus = '1.1; Scheduling message is sent via iMip';
-			if ($failed) {
-				$this->logger->error('Unable to deliver message to {failed}', ['app' => 'dav', 'failed' => implode(', ', $failed)]);
-				$iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
-			}
-		} catch (\Exception $ex) {
-			$this->logger->error($ex->getMessage(), ['app' => 'dav', 'exception' => $ex]);
-			$iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
-		}
-	}
-
-	/**
-	 * check if event took place in the past already
-	 * @param VCalendar $vObject
-	 * @return int
-	 */
-	private function getLastOccurrence(VCalendar $vObject) {
-		/** @var VEvent $component */
-		$component = $vObject->VEVENT;
-
-		$firstOccurrence = $component->DTSTART->getDateTime()->getTimeStamp();
-		// Finding the last occurrence is a bit harder
-		if (!isset($component->RRULE)) {
-			if (isset($component->DTEND)) {
-				$lastOccurrence = $component->DTEND->getDateTime()->getTimeStamp();
-			} elseif (isset($component->DURATION)) {
-				/** @var \DateTime $endDate */
-				$endDate = clone $component->DTSTART->getDateTime();
-				// $component->DTEND->getDateTime() returns DateTimeImmutable
-				$endDate = $endDate->add(DateTimeParser::parse($component->DURATION->getValue()));
-				$lastOccurrence = $endDate->getTimestamp();
-			} elseif (!$component->DTSTART->hasTime()) {
-				/** @var \DateTime $endDate */
-				$endDate = clone $component->DTSTART->getDateTime();
-				// $component->DTSTART->getDateTime() returns DateTimeImmutable
-				$endDate = $endDate->modify('+1 day');
-				$lastOccurrence = $endDate->getTimestamp();
-			} else {
-				$lastOccurrence = $firstOccurrence;
-			}
-		} else {
-			$it = new EventIterator($vObject, (string)$component->UID);
-			$maxDate = new \DateTime(self::MAX_DATE);
-			if ($it->isInfinite()) {
-				$lastOccurrence = $maxDate->getTimestamp();
-			} else {
-				$end = $it->getDtEnd();
-				while ($it->valid() && $end < $maxDate) {
-					$end = $it->getDtEnd();
-					$it->next();
-				}
-				$lastOccurrence = $end->getTimestamp();
-			}
-		}
-
-		return $lastOccurrence;
-	}
-
-	/**
-	 * @param Message $iTipMessage
-	 * @return null|Property
-	 */
-	private function getCurrentAttendee(Message $iTipMessage) {
-		/** @var VEvent $vevent */
-		$vevent = $iTipMessage->message->VEVENT;
-		$attendees = $vevent->select('ATTENDEE');
-		foreach ($attendees as $attendee) {
-			/** @var Property $attendee */
-			if (strcasecmp($attendee->getValue(), $iTipMessage->recipient) === 0) {
-				return $attendee;
-			}
-		}
-		return null;
-	}
-
-	/**
-	 * @param string $default
-	 * @param Property|null $attendee
-	 * @return string
-	 */
-	private function getAttendeeLangOrDefault($default, Property $attendee = null) {
-		if ($attendee !== null) {
-			$lang = $attendee->offsetGet('LANGUAGE');
-			if ($lang instanceof Parameter) {
-				return $lang->getValue();
-			}
-		}
-		return $default;
-	}
-
-	/**
-	 * @param Property|null $attendee
-	 * @return bool
-	 */
-	private function getAttendeeRsvpOrReqForParticipant(Property $attendee = null) {
-		if ($attendee !== null) {
-			$rsvp = $attendee->offsetGet('RSVP');
-			if (($rsvp instanceof Parameter) && (strcasecmp($rsvp->getValue(), 'TRUE') === 0)) {
-				return true;
-			}
-			$role = $attendee->offsetGet('ROLE');
-			// @see https://datatracker.ietf.org/doc/html/rfc5545#section-3.2.16
-			// Attendees without a role are assumed required and should receive an invitation link even if they have no RSVP set
-			if ($role === null
-				|| (($role instanceof Parameter) && (strcasecmp($role->getValue(), 'REQ-PARTICIPANT') === 0))
-				|| (($role instanceof Parameter) && (strcasecmp($role->getValue(), 'OPT-PARTICIPANT') === 0))
-			) {
-				return true;
-			}
-		}
-		// RFC 5545 3.2.17: default RSVP is false
-		return false;
-	}
-
-	/**
-	 * @param IL10N $l10n
-	 * @param VEvent $vevent
-	 */
-	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 = $dtend->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 = $dtend->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 */
-		/** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtend */
-		/** @var \DateTimeImmutable $dtstartDt */
-		$dtstartDt = $dtstart->getDateTime();
-		/** @var \DateTimeImmutable $dtendDt */
-		$dtendDt = $dtend->getDateTime();
-
-		$diff = $dtstartDt->diff($dtendDt);
-
-		$dtstartDt = new \DateTime($dtstartDt->format(\DateTimeInterface::ATOM));
-		$dtendDt = new \DateTime($dtendDt->format(\DateTimeInterface::ATOM));
-
-		if ($isAllDay) {
-			// One day event
-			if ($diff->days === 1) {
-				return $l10n->l('date', $dtstartDt, ['width' => 'medium']);
-			}
-
-			// DTEND is exclusive, so if the ics data says 2020-01-01 to 2020-01-05,
-			// the email should show 2020-01-01 to 2020-01-04.
-			$dtendDt->modify('-1 day');
-
-			//event that spans over multiple days
-			$localeStart = $l10n->l('date', $dtstartDt, ['width' => 'medium']);
-			$localeEnd = $l10n->l('date', $dtendDt, ['width' => 'medium']);
-
-			return $localeStart . ' - ' . $localeEnd;
-		}
-
-		/** @var Property\ICalendar\DateTime $dtstart */
-		/** @var Property\ICalendar\DateTime $dtend */
-		$isFloating = $dtstart->isFloating();
-		$startTimezone = $endTimezone = null;
-		if (!$isFloating) {
-			$prop = $dtstart->offsetGet('TZID');
-			if ($prop instanceof Parameter) {
-				$startTimezone = $prop->getValue();
-			}
-
-			$prop = $dtend->offsetGet('TZID');
-			if ($prop instanceof Parameter) {
-				$endTimezone = $prop->getValue();
-			}
-		}
-
-		$localeStart = $l10n->l('weekdayName', $dtstartDt, ['width' => 'abbreviated']) . ', ' .
-			$l10n->l('datetime', $dtstartDt, ['width' => 'medium|short']);
-
-		// always show full date with timezone if timezones are different
-		if ($startTimezone !== $endTimezone) {
-			$localeEnd = $l10n->l('datetime', $dtendDt, ['width' => 'medium|short']);
-
-			return $localeStart . ' (' . $startTimezone . ') - ' .
-				$localeEnd . ' (' . $endTimezone . ')';
-		}
-
-		// show only end time if date is the same
-		if ($this->isDayEqual($dtstartDt, $dtendDt)) {
-			$localeEnd = $l10n->l('time', $dtendDt, ['width' => 'short']);
-		} else {
-			$localeEnd = $l10n->l('weekdayName', $dtendDt, ['width' => 'abbreviated']) . ', ' .
-				$l10n->l('datetime', $dtendDt, ['width' => 'medium|short']);
-		}
-
-		return  $localeStart . ' - ' . $localeEnd . ' (' . $startTimezone . ')';
-	}
-
-	/**
-	 * @param \DateTime $dtStart
-	 * @param \DateTime $dtEnd
-	 * @return bool
-	 */
-	private function isDayEqual(\DateTime $dtStart, \DateTime $dtEnd) {
-		return $dtStart->format('Y-m-d') === $dtEnd->format('Y-m-d');
-	}
-
-	/**
-	 * @param IEMailTemplate $template
-	 * @param IL10N $l10n
-	 * @param string $method
-	 * @param string $summary
-	 */
-	private function addSubjectAndHeading(IEMailTemplate $template, IL10N $l10n,
-										  $method, $summary) {
-		if ($method === self::METHOD_CANCEL) {
-			// TRANSLATORS Subject for email, when an invitation is cancelled. Ex: "Cancelled: {{Event Name}}"
-			$template->setSubject($l10n->t('Cancelled: %1$s', [$summary]));
-			$template->addHeading($l10n->t('Invitation canceled'));
-		} elseif ($method === self::METHOD_REPLY) {
-			// TRANSLATORS Subject for email, when an invitation is updated. Ex: "Re: {{Event Name}}"
-			$template->setSubject($l10n->t('Re: %1$s', [$summary]));
-			$template->addHeading($l10n->t('Invitation updated'));
-		} else {
-			// TRANSLATORS Subject for email, when an invitation is sent. Ex: "Invitation: {{Event Name}}"
-			$template->setSubject($l10n->t('Invitation: %1$s', [$summary]));
-			$template->addHeading($l10n->t('Invitation'));
-		}
-	}
-
-	/**
-	 * @param IEMailTemplate $template
-	 * @param IL10N $l10n
-	 * @param VEVENT $vevent
-	 */
-	private function addBulletList(IEMailTemplate $template, IL10N $l10n, $vevent) {
-		if ($vevent->SUMMARY) {
-			$template->addBodyListItem($vevent->SUMMARY, $l10n->t('Title:'),
-				$this->getAbsoluteImagePath('caldav/title.png'), '', '', self::IMIP_INDENT);
-		}
-		$meetingWhen = $this->generateWhenString($l10n, $vevent);
-		if ($meetingWhen) {
-			$template->addBodyListItem($meetingWhen, $l10n->t('Time:'),
-				$this->getAbsoluteImagePath('caldav/time.png'), '', '', self::IMIP_INDENT);
-		}
-		if ($vevent->LOCATION) {
-			$template->addBodyListItem($vevent->LOCATION, $l10n->t('Location:'),
-				$this->getAbsoluteImagePath('caldav/location.png'), '', '', self::IMIP_INDENT);
-		}
-		if ($vevent->URL) {
-			$url = $vevent->URL->getValue();
-			$template->addBodyListItem(sprintf('<a href="%s">%s</a>',
-				htmlspecialchars($url),
-				htmlspecialchars($url)),
-				$l10n->t('Link:'),
-				$this->getAbsoluteImagePath('caldav/link.png'),
-				$url, '', self::IMIP_INDENT);
-		}
-
-		$this->addAttendees($template, $l10n, $vevent);
-
-		/* Put description last, like an email body, since it can be arbitrarily long */
-		if ($vevent->DESCRIPTION) {
-			$template->addBodyListItem($vevent->DESCRIPTION->getValue(), $l10n->t('Description:'),
-				$this->getAbsoluteImagePath('caldav/description.png'), '', '', self::IMIP_INDENT);
-		}
-	}
-
-	/**
-	 * addAttendees: add organizer and attendee names/emails to iMip mail.
-	 *
-	 * Enable with DAV setting: invitation_list_attendees (default: no)
-	 *
-	 * The default is 'no', which matches old behavior, and is privacy preserving.
-	 *
-	 * To enable including attendees in invitation emails:
-	 *   % php occ config:app:set dav invitation_list_attendees --value yes
-	 *
-	 * @param IEMailTemplate $template
-	 * @param IL10N $l10n
-	 * @param Message $iTipMessage
-	 * @param int $lastOccurrence
-	 * @author brad2014 on github.com
-	 */
-
-	private function addAttendees(IEMailTemplate $template, IL10N $l10n, VEvent $vevent) {
-		if ($this->config->getAppValue('dav', 'invitation_list_attendees', 'no') === 'no') {
-			return;
-		}
-
-		if (isset($vevent->ORGANIZER)) {
-			/** @var Property\ICalendar\CalAddress $organizer */
-			$organizer = $vevent->ORGANIZER;
-			$organizerURI = $organizer->getNormalizedValue();
-			[$scheme,$organizerEmail] = explode(':', $organizerURI, 2); # strip off scheme mailto:
-			/** @var string|null $organizerName */
-			$organizerName = isset($organizer['CN']) ? $organizer['CN'] : null;
-			$organizerHTML = sprintf('<a href="%s">%s</a>',
-				htmlspecialchars($organizerURI),
-				htmlspecialchars($organizerName ?: $organizerEmail));
-			$organizerText = sprintf('%s <%s>', $organizerName, $organizerEmail);
-			if (isset($organizer['PARTSTAT'])) {
-				/** @var Parameter $partstat */
-				$partstat = $organizer['PARTSTAT'];
-				if (strcasecmp($partstat->getValue(), 'ACCEPTED') === 0) {
-					$organizerHTML .= ' ✔︎';
-					$organizerText .= ' ✔︎';
-				}
-			}
-			$template->addBodyListItem($organizerHTML, $l10n->t('Organizer:'),
-				$this->getAbsoluteImagePath('caldav/organizer.png'),
-				$organizerText, '', self::IMIP_INDENT);
-		}
-
-		$attendees = $vevent->select('ATTENDEE');
-		if (count($attendees) === 0) {
-			return;
-		}
-
-		$attendeesHTML = [];
-		$attendeesText = [];
-		foreach ($attendees as $attendee) {
-			$attendeeURI = $attendee->getNormalizedValue();
-			[$scheme,$attendeeEmail] = explode(':', $attendeeURI, 2); # strip off scheme mailto:
-			$attendeeName = isset($attendee['CN']) ? $attendee['CN'] : null;
-			$attendeeHTML = sprintf('<a href="%s">%s</a>',
-				htmlspecialchars($attendeeURI),
-				htmlspecialchars($attendeeName ?: $attendeeEmail));
-			$attendeeText = sprintf('%s <%s>', $attendeeName, $attendeeEmail);
-			if (isset($attendee['PARTSTAT'])
-				&& strcasecmp($attendee['PARTSTAT'], 'ACCEPTED') === 0) {
-				$attendeeHTML .= ' ✔︎';
-				$attendeeText .= ' ✔︎';
-			}
-			array_push($attendeesHTML, $attendeeHTML);
-			array_push($attendeesText, $attendeeText);
-		}
-
-		$template->addBodyListItem(implode('<br/>', $attendeesHTML), $l10n->t('Attendees:'),
-			$this->getAbsoluteImagePath('caldav/attendees.png'),
-			implode("\n", $attendeesText), '', self::IMIP_INDENT);
-	}
-
-	/**
-	 * @param IEMailTemplate $template
-	 * @param IL10N $l10n
-	 * @param Message $iTipMessage
-	 * @param int $lastOccurrence
-	 */
-	private function addResponseButtons(IEMailTemplate $template, IL10N $l10n,
-										Message $iTipMessage, $lastOccurrence) {
-		$token = $this->createInvitationToken($iTipMessage, $lastOccurrence);
-
-		$template->addBodyButtonGroup(
-			$l10n->t('Accept'),
-			$this->urlGenerator->linkToRouteAbsolute('dav.invitation_response.accept', [
-				'token' => $token,
-			]),
-			$l10n->t('Decline'),
-			$this->urlGenerator->linkToRouteAbsolute('dav.invitation_response.decline', [
-				'token' => $token,
-			])
-		);
-
-		$moreOptionsURL = $this->urlGenerator->linkToRouteAbsolute('dav.invitation_response.options', [
-			'token' => $token,
-		]);
-		$html = vsprintf('<small><a href="%s">%s</a></small>', [
-			$moreOptionsURL, $l10n->t('More options …')
-		]);
-		$text = $l10n->t('More options at %s', [$moreOptionsURL]);
-
-		$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
-	 * @return string
-	 */
-	private function createInvitationToken(Message $iTipMessage, $lastOccurrence):string {
-		$token = $this->random->generate(60, ISecureRandom::CHAR_ALPHANUMERIC);
-
-		/** @var VEvent $vevent */
-		$vevent = $iTipMessage->message->VEVENT;
-		$attendee = $iTipMessage->recipient;
-		$organizer = $iTipMessage->sender;
-		$sequence = $iTipMessage->sequence;
-		$recurrenceId = isset($vevent->{'RECURRENCE-ID'}) ?
-			$vevent->{'RECURRENCE-ID'}->serialize() : null;
-		$uid = $vevent->{'UID'};
-
-		$query = $this->db->getQueryBuilder();
-		$query->insert('calendar_invitations')
-			->values([
-				'token' => $query->createNamedParameter($token),
-				'attendee' => $query->createNamedParameter($attendee),
-				'organizer' => $query->createNamedParameter($organizer),
-				'sequence' => $query->createNamedParameter($sequence),
-				'recurrenceid' => $query->createNamedParameter($recurrenceId),
-				'expiration' => $query->createNamedParameter($lastOccurrence),
-				'uid' => $query->createNamedParameter($uid)
-			])
-			->execute();
-
-		return $token;
-	}
+            $recipientDomain = substr(strrchr($recipient, "@"), 1);
+            $invitationLinkRecipients = explode(',', preg_replace('/\s+/', '', strtolower($this->config->getAppValue('dav', 'invitation_link_recipients', 'yes'))));
+
+            if (strcmp('yes', $invitationLinkRecipients[0]) === 0
+                 || in_array(strtolower($recipient), $invitationLinkRecipients)
+                 || in_array(strtolower($recipientDomain), $invitationLinkRecipients)) {
+                $this->addResponseButtons($template, $l10n, $iTipMessage, $lastOccurrence);
+            }
+        }
+
+        $template->addFooter();
+
+        $message->useTemplate($template);
+
+        $attachment = $this->mailer->createAttachment(
+            $iTipMessage->message->serialize(),
+            'event.ics',// TODO(leon): Make file name unique, e.g. add event id
+            'text/calendar; method=' . $iTipMessage->method
+        );
+        $message->attach($attachment);
+
+        try {
+            $failed = $this->mailer->send($message);
+            $iTipMessage->scheduleStatus = '1.1; Scheduling message is sent via iMip';
+            if ($failed) {
+                $this->logger->error('Unable to deliver message to {failed}', ['app' => 'dav', 'failed' => implode(', ', $failed)]);
+                $iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
+            }
+        } catch (\Exception $ex) {
+            $this->logger->error($ex->getMessage(), ['app' => 'dav', 'exception' => $ex]);
+            $iTipMessage->scheduleStatus = '5.0; EMail delivery failed';
+        }
+    }
+
+    /**
+     * check if event took place in the past already
+     * @param VCalendar $vObject
+     * @return int
+     */
+    private function getLastOccurrence(VCalendar $vObject) {
+        /** @var VEvent $component */
+        $component = $vObject->VEVENT;
+
+        $firstOccurrence = $component->DTSTART->getDateTime()->getTimeStamp();
+        // Finding the last occurrence is a bit harder
+        if (!isset($component->RRULE)) {
+            if (isset($component->DTEND)) {
+                $lastOccurrence = $component->DTEND->getDateTime()->getTimeStamp();
+            } elseif (isset($component->DURATION)) {
+                /** @var \DateTime $endDate */
+                $endDate = clone $component->DTSTART->getDateTime();
+                // $component->DTEND->getDateTime() returns DateTimeImmutable
+                $endDate = $endDate->add(DateTimeParser::parse($component->DURATION->getValue()));
+                $lastOccurrence = $endDate->getTimestamp();
+            } elseif (!$component->DTSTART->hasTime()) {
+                /** @var \DateTime $endDate */
+                $endDate = clone $component->DTSTART->getDateTime();
+                // $component->DTSTART->getDateTime() returns DateTimeImmutable
+                $endDate = $endDate->modify('+1 day');
+                $lastOccurrence = $endDate->getTimestamp();
+            } else {
+                $lastOccurrence = $firstOccurrence;
+            }
+        } else {
+            $it = new EventIterator($vObject, (string)$component->UID);
+            $maxDate = new \DateTime(self::MAX_DATE);
+            if ($it->isInfinite()) {
+                $lastOccurrence = $maxDate->getTimestamp();
+            } else {
+                $end = $it->getDtEnd();
+                while ($it->valid() && $end < $maxDate) {
+                    $end = $it->getDtEnd();
+                    $it->next();
+                }
+                $lastOccurrence = $end->getTimestamp();
+            }
+        }
+
+        return $lastOccurrence;
+    }
+
+    /**
+     * @param Message $iTipMessage
+     * @return null|Property
+     */
+    private function getCurrentAttendee(Message $iTipMessage) {
+        /** @var VEvent $vevent */
+        $vevent = $iTipMessage->message->VEVENT;
+        $attendees = $vevent->select('ATTENDEE');
+        foreach ($attendees as $attendee) {
+            /** @var Property $attendee */
+            if (strcasecmp($attendee->getValue(), $iTipMessage->recipient) === 0) {
+                return $attendee;
+            }
+        }
+        return null;
+    }
+
+    /**
+     * @param string $default
+     * @param Property|null $attendee
+     * @return string
+     */
+    private function getAttendeeLangOrDefault($default, Property $attendee = null) {
+        if ($attendee !== null) {
+            $lang = $attendee->offsetGet('LANGUAGE');
+            if ($lang instanceof Parameter) {
+                return $lang->getValue();
+            }
+        }
+        return $default;
+    }
+
+    /**
+     * @param Property|null $attendee
+     * @return bool
+     */
+    private function getAttendeeRsvpOrReqForParticipant(Property $attendee = null) {
+        if ($attendee !== null) {
+            $rsvp = $attendee->offsetGet('RSVP');
+            if (($rsvp instanceof Parameter) && (strcasecmp($rsvp->getValue(), 'TRUE') === 0)) {
+                return true;
+            }
+            $role = $attendee->offsetGet('ROLE');
+            // @see https://datatracker.ietf.org/doc/html/rfc5545#section-3.2.16
+            // Attendees without a role are assumed required and should receive an invitation link even if they have no RSVP set
+            if ($role === null
+                || (($role instanceof Parameter) && (strcasecmp($role->getValue(), 'REQ-PARTICIPANT') === 0))
+                || (($role instanceof Parameter) && (strcasecmp($role->getValue(), 'OPT-PARTICIPANT') === 0))
+            ) {
+                return true;
+            }
+        }
+        // RFC 5545 3.2.17: default RSVP is false
+        return false;
+    }
+
+    /**
+     * @param IL10N $l10n
+     * @param VEvent $vevent
+     */
+    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 = $dtend->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 = $dtend->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 */
+        /** @var Property\ICalendar\Date | Property\ICalendar\DateTime $dtend */
+        /** @var \DateTimeImmutable $dtstartDt */
+        $dtstartDt = $dtstart->getDateTime();
+        /** @var \DateTimeImmutable $dtendDt */
+        $dtendDt = $dtend->getDateTime();
+
+        $diff = $dtstartDt->diff($dtendDt);
+
+        $dtstartDt = new \DateTime($dtstartDt->format(\DateTimeInterface::ATOM));
+        $dtendDt = new \DateTime($dtendDt->format(\DateTimeInterface::ATOM));
+
+        if ($isAllDay) {
+            // One day event
+            if ($diff->days === 1) {
+                return $l10n->l('date', $dtstartDt, ['width' => 'medium']);
+            }
+
+            // DTEND is exclusive, so if the ics data says 2020-01-01 to 2020-01-05,
+            // the email should show 2020-01-01 to 2020-01-04.
+            $dtendDt->modify('-1 day');
+
+            //event that spans over multiple days
+            $localeStart = $l10n->l('date', $dtstartDt, ['width' => 'medium']);
+            $localeEnd = $l10n->l('date', $dtendDt, ['width' => 'medium']);
+
+            return $localeStart . ' - ' . $localeEnd;
+        }
+
+        /** @var Property\ICalendar\DateTime $dtstart */
+        /** @var Property\ICalendar\DateTime $dtend */
+        $isFloating = $dtstart->isFloating();
+        $startTimezone = $endTimezone = null;
+        if (!$isFloating) {
+            $prop = $dtstart->offsetGet('TZID');
+            if ($prop instanceof Parameter) {
+                $startTimezone = $prop->getValue();
+            }
+
+            $prop = $dtend->offsetGet('TZID');
+            if ($prop instanceof Parameter) {
+                $endTimezone = $prop->getValue();
+            }
+        }
+
+        $localeStart = $l10n->l('weekdayName', $dtstartDt, ['width' => 'abbreviated']) . ', ' .
+            $l10n->l('datetime', $dtstartDt, ['width' => 'medium|short']);
+
+        // always show full date with timezone if timezones are different
+        if ($startTimezone !== $endTimezone) {
+            $localeEnd = $l10n->l('datetime', $dtendDt, ['width' => 'medium|short']);
+
+            return $localeStart . ' (' . $startTimezone . ') - ' .
+                $localeEnd . ' (' . $endTimezone . ')';
+        }
+
+        // show only end time if date is the same
+        if ($this->isDayEqual($dtstartDt, $dtendDt)) {
+            $localeEnd = $l10n->l('time', $dtendDt, ['width' => 'short']);
+        } else {
+            $localeEnd = $l10n->l('weekdayName', $dtendDt, ['width' => 'abbreviated']) . ', ' .
+                $l10n->l('datetime', $dtendDt, ['width' => 'medium|short']);
+        }
+
+        return  $localeStart . ' - ' . $localeEnd . ' (' . $startTimezone . ')';
+    }
+
+    /**
+     * @param \DateTime $dtStart
+     * @param \DateTime $dtEnd
+     * @return bool
+     */
+    private function isDayEqual(\DateTime $dtStart, \DateTime $dtEnd) {
+        return $dtStart->format('Y-m-d') === $dtEnd->format('Y-m-d');
+    }
+
+    /**
+     * @param IEMailTemplate $template
+     * @param IL10N $l10n
+     * @param string $method
+     * @param string $summary
+     */
+    private function addSubjectAndHeading(IEMailTemplate $template, IL10N $l10n,
+                                            $method, $summary) {
+        if ($method === self::METHOD_CANCEL) {
+            // TRANSLATORS Subject for email, when an invitation is cancelled. Ex: "Cancelled: {{Event Name}}"
+            $template->setSubject($l10n->t('Cancelled: %1$s', [$summary]));
+            $template->addHeading($l10n->t('Invitation canceled'));
+        } elseif ($method === self::METHOD_REPLY) {
+            // TRANSLATORS Subject for email, when an invitation is updated. Ex: "Re: {{Event Name}}"
+            $template->setSubject($l10n->t('Re: %1$s', [$summary]));
+            $template->addHeading($l10n->t('Invitation updated'));
+        } else {
+            // TRANSLATORS Subject for email, when an invitation is sent. Ex: "Invitation: {{Event Name}}"
+            $template->setSubject($l10n->t('Invitation: %1$s', [$summary]));
+            $template->addHeading($l10n->t('Invitation'));
+        }
+    }
+
+    /**
+     * @param IEMailTemplate $template
+     * @param IL10N $l10n
+     * @param VEVENT $vevent
+     */
+    private function addBulletList(IEMailTemplate $template, IL10N $l10n, $vevent) {
+        if ($vevent->SUMMARY) {
+            $template->addBodyListItem($vevent->SUMMARY, $l10n->t('Title:'),
+                $this->getAbsoluteImagePath('caldav/title.png'), '', '', self::IMIP_INDENT);
+        }
+        $meetingWhen = $this->generateWhenString($l10n, $vevent);
+        if ($meetingWhen) {
+            $template->addBodyListItem($meetingWhen, $l10n->t('Time:'),
+                $this->getAbsoluteImagePath('caldav/time.png'), '', '', self::IMIP_INDENT);
+        }
+        if ($vevent->LOCATION) {
+            $template->addBodyListItem($vevent->LOCATION, $l10n->t('Location:'),
+                $this->getAbsoluteImagePath('caldav/location.png'), '', '', self::IMIP_INDENT);
+        }
+        if ($vevent->URL) {
+            $url = $vevent->URL->getValue();
+            $template->addBodyListItem(sprintf('<a href="%s">%s</a>',
+                htmlspecialchars($url),
+                htmlspecialchars($url)),
+                $l10n->t('Link:'),
+                $this->getAbsoluteImagePath('caldav/link.png'),
+                $url, '', self::IMIP_INDENT);
+        }
+
+        $this->addAttendees($template, $l10n, $vevent);
+
+        /* Put description last, like an email body, since it can be arbitrarily long */
+        if ($vevent->DESCRIPTION) {
+            $template->addBodyListItem($vevent->DESCRIPTION->getValue(), $l10n->t('Description:'),
+                $this->getAbsoluteImagePath('caldav/description.png'), '', '', self::IMIP_INDENT);
+        }
+    }
+
+    /**
+     * addAttendees: add organizer and attendee names/emails to iMip mail.
+     *
+     * Enable with DAV setting: invitation_list_attendees (default: no)
+     *
+     * The default is 'no', which matches old behavior, and is privacy preserving.
+     *
+     * To enable including attendees in invitation emails:
+     *   % php occ config:app:set dav invitation_list_attendees --value yes
+     *
+     * @param IEMailTemplate $template
+     * @param IL10N $l10n
+     * @param Message $iTipMessage
+     * @param int $lastOccurrence
+     * @author brad2014 on github.com
+     */
+
+    private function addAttendees(IEMailTemplate $template, IL10N $l10n, VEvent $vevent) {
+        if ($this->config->getAppValue('dav', 'invitation_list_attendees', 'no') === 'no') {
+            return;
+        }
+
+        if (isset($vevent->ORGANIZER)) {
+            /** @var Property\ICalendar\CalAddress $organizer */
+            $organizer = $vevent->ORGANIZER;
+            $organizerURI = $organizer->getNormalizedValue();
+            [$scheme,$organizerEmail] = explode(':', $organizerURI, 2); # strip off scheme mailto:
+            /** @var string|null $organizerName */
+            $organizerName = isset($organizer['CN']) ? $organizer['CN'] : null;
+            $organizerHTML = sprintf('<a href="%s">%s</a>',
+                htmlspecialchars($organizerURI),
+                htmlspecialchars($organizerName ?: $organizerEmail));
+            $organizerText = sprintf('%s <%s>', $organizerName, $organizerEmail);
+            if (isset($organizer['PARTSTAT'])) {
+                /** @var Parameter $partstat */
+                $partstat = $organizer['PARTSTAT'];
+                if (strcasecmp($partstat->getValue(), 'ACCEPTED') === 0) {
+                    $organizerHTML .= ' ✔︎';
+                    $organizerText .= ' ✔︎';
+                }
+            }
+            $template->addBodyListItem($organizerHTML, $l10n->t('Organizer:'),
+                $this->getAbsoluteImagePath('caldav/organizer.png'),
+                $organizerText, '', self::IMIP_INDENT);
+        }
+
+        $attendees = $vevent->select('ATTENDEE');
+        if (count($attendees) === 0) {
+            return;
+        }
+
+        $attendeesHTML = [];
+        $attendeesText = [];
+        foreach ($attendees as $attendee) {
+            $attendeeURI = $attendee->getNormalizedValue();
+            [$scheme,$attendeeEmail] = explode(':', $attendeeURI, 2); # strip off scheme mailto:
+            $attendeeName = isset($attendee['CN']) ? $attendee['CN'] : null;
+            $attendeeHTML = sprintf('<a href="%s">%s</a>',
+                htmlspecialchars($attendeeURI),
+                htmlspecialchars($attendeeName ?: $attendeeEmail));
+            $attendeeText = sprintf('%s <%s>', $attendeeName, $attendeeEmail);
+            if (isset($attendee['PARTSTAT'])
+                && strcasecmp($attendee['PARTSTAT'], 'ACCEPTED') === 0) {
+                $attendeeHTML .= ' ✔︎';
+                $attendeeText .= ' ✔︎';
+            }
+            array_push($attendeesHTML, $attendeeHTML);
+            array_push($attendeesText, $attendeeText);
+        }
+
+        $template->addBodyListItem(implode('<br/>', $attendeesHTML), $l10n->t('Attendees:'),
+            $this->getAbsoluteImagePath('caldav/attendees.png'),
+            implode("\n", $attendeesText), '', self::IMIP_INDENT);
+    }
+
+    /**
+     * @param IEMailTemplate $template
+     * @param IL10N $l10n
+     * @param Message $iTipMessage
+     * @param int $lastOccurrence
+     */
+    private function addResponseButtons(IEMailTemplate $template, IL10N $l10n,
+                                        Message $iTipMessage, $lastOccurrence) {
+        $token = $this->createInvitationToken($iTipMessage, $lastOccurrence);
+
+        $template->addBodyButtonGroup(
+            $l10n->t('Accept'),
+            $this->urlGenerator->linkToRouteAbsolute('dav.invitation_response.accept', [
+                'token' => $token,
+            ]),
+            $l10n->t('Decline'),
+            $this->urlGenerator->linkToRouteAbsolute('dav.invitation_response.decline', [
+                'token' => $token,
+            ])
+        );
+
+        $moreOptionsURL = $this->urlGenerator->linkToRouteAbsolute('dav.invitation_response.options', [
+            'token' => $token,
+        ]);
+        $html = vsprintf('<small><a href="%s">%s</a></small>', [
+            $moreOptionsURL, $l10n->t('More options …')
+        ]);
+        $text = $l10n->t('More options at %s', [$moreOptionsURL]);
+
+        $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
+     * @return string
+     */
+    private function createInvitationToken(Message $iTipMessage, $lastOccurrence):string {
+        $token = $this->random->generate(60, ISecureRandom::CHAR_ALPHANUMERIC);
+
+        /** @var VEvent $vevent */
+        $vevent = $iTipMessage->message->VEVENT;
+        $attendee = $iTipMessage->recipient;
+        $organizer = $iTipMessage->sender;
+        $sequence = $iTipMessage->sequence;
+        $recurrenceId = isset($vevent->{'RECURRENCE-ID'}) ?
+            $vevent->{'RECURRENCE-ID'}->serialize() : null;
+        $uid = $vevent->{'UID'};
+
+        $query = $this->db->getQueryBuilder();
+        $query->insert('calendar_invitations')
+            ->values([
+                'token' => $query->createNamedParameter($token),
+                'attendee' => $query->createNamedParameter($attendee),
+                'organizer' => $query->createNamedParameter($organizer),
+                'sequence' => $query->createNamedParameter($sequence),
+                'recurrenceid' => $query->createNamedParameter($recurrenceId),
+                'expiration' => $query->createNamedParameter($lastOccurrence),
+                'uid' => $query->createNamedParameter($uid)
+            ])
+            ->execute();
+
+        return $token;
+    }
 }

Spacing +17 added lines, -17 removed lines

@@ -210,11 +210,11 @@ 
 		}
 
 		$data = [
-			'attendee_name' => (string)$meetingAttendeeName ?: $defaultVal,
-			'invitee_name' => (string)$meetingInviteeName ?: $defaultVal,
-			'meeting_title' => (string)$meetingTitle ?: $defaultVal,
-			'meeting_description' => (string)$meetingDescription ?: $defaultVal,
-			'meeting_url' => (string)$meetingUrl ?: $defaultVal,
+			'attendee_name' => (string) $meetingAttendeeName ?: $defaultVal,
+			'invitee_name' => (string) $meetingInviteeName ?: $defaultVal,
+			'meeting_title' => (string) $meetingTitle ?: $defaultVal,
+			'meeting_description' => (string) $meetingDescription ?: $defaultVal,
+			'meeting_url' => (string) $meetingUrl ?: $defaultVal,
 		];
 
 		$fromEMail = Util::getDefaultEmailAddress('invitations-noreply');
@@ -225,7 +225,7 @@ 
 			->setTo([$recipient => $recipientName])
 			->setReplyTo([$sender => $senderName]);
 
-		$template = $this->mailer->createEMailTemplate('dav.calendarInvite.' . $method, $data);
+		$template = $this->mailer->createEMailTemplate('dav.calendarInvite.'.$method, $data);
 		$template->addHeader();
 
 		$summary = ((string) $summary !== '') ? (string) $summary : $l10n->t('Untitled event');
@@ -270,8 +270,8 @@ 
 
 		$attachment = $this->mailer->createAttachment(
 			$iTipMessage->message->serialize(),
-			'event.ics',// TODO(leon): Make file name unique, e.g. add event id
-			'text/calendar; method=' . $iTipMessage->method
+			'event.ics', // TODO(leon): Make file name unique, e.g. add event id
+			'text/calendar; method='.$iTipMessage->method
 		);
 		$message->attach($attachment);
 
@@ -318,7 +318,7 @@ 
 				$lastOccurrence = $firstOccurrence;
 			}
 		} else {
-			$it = new EventIterator($vObject, (string)$component->UID);
+			$it = new EventIterator($vObject, (string) $component->UID);
 			$maxDate = new \DateTime(self::MAX_DATE);
 			if ($it->isInfinite()) {
 				$lastOccurrence = $maxDate->getTimestamp();
@@ -443,7 +443,7 @@ 
 			$localeStart = $l10n->l('date', $dtstartDt, ['width' => 'medium']);
 			$localeEnd = $l10n->l('date', $dtendDt, ['width' => 'medium']);
 
-			return $localeStart . ' - ' . $localeEnd;
+			return $localeStart.' - '.$localeEnd;
 		}
 
 		/** @var Property\ICalendar\DateTime $dtstart */
@@ -462,26 +462,26 @@ 
 			}
 		}
 
-		$localeStart = $l10n->l('weekdayName', $dtstartDt, ['width' => 'abbreviated']) . ', ' .
+		$localeStart = $l10n->l('weekdayName', $dtstartDt, ['width' => 'abbreviated']).', '.
 			$l10n->l('datetime', $dtstartDt, ['width' => 'medium|short']);
 
 		// always show full date with timezone if timezones are different
 		if ($startTimezone !== $endTimezone) {
 			$localeEnd = $l10n->l('datetime', $dtendDt, ['width' => 'medium|short']);
 
-			return $localeStart . ' (' . $startTimezone . ') - ' .
-				$localeEnd . ' (' . $endTimezone . ')';
+			return $localeStart.' ('.$startTimezone.') - '.
+				$localeEnd.' ('.$endTimezone.')';
 		}
 
 		// show only end time if date is the same
 		if ($this->isDayEqual($dtstartDt, $dtendDt)) {
 			$localeEnd = $l10n->l('time', $dtendDt, ['width' => 'short']);
 		} else {
-			$localeEnd = $l10n->l('weekdayName', $dtendDt, ['width' => 'abbreviated']) . ', ' .
+			$localeEnd = $l10n->l('weekdayName', $dtendDt, ['width' => 'abbreviated']).', '.
 				$l10n->l('datetime', $dtendDt, ['width' => 'medium|short']);
 		}
 
-		return  $localeStart . ' - ' . $localeEnd . ' (' . $startTimezone . ')';
+		return  $localeStart.' - '.$localeEnd.' ('.$startTimezone.')';
 	}
 
 	/**
@@ -580,7 +580,7 @@ 
 			/** @var Property\ICalendar\CalAddress $organizer */
 			$organizer = $vevent->ORGANIZER;
 			$organizerURI = $organizer->getNormalizedValue();
-			[$scheme,$organizerEmail] = explode(':', $organizerURI, 2); # strip off scheme mailto:
+			[$scheme, $organizerEmail] = explode(':', $organizerURI, 2); # strip off scheme mailto:
 			/** @var string|null $organizerName */
 			$organizerName = isset($organizer['CN']) ? $organizer['CN'] : null;
 			$organizerHTML = sprintf('<a href="%s">%s</a>',
@@ -609,7 +609,7 @@ 
 		$attendeesText = [];
 		foreach ($attendees as $attendee) {
 			$attendeeURI = $attendee->getNormalizedValue();
-			[$scheme,$attendeeEmail] = explode(':', $attendeeURI, 2); # strip off scheme mailto:
+			[$scheme, $attendeeEmail] = explode(':', $attendeeURI, 2); # strip off scheme mailto:
 			$attendeeName = isset($attendee['CN']) ? $attendee['CN'] : null;
 			$attendeeHTML = sprintf('<a href="%s">%s</a>',
 				htmlspecialchars($attendeeURI),

apps/encryption/lib/Crypto/Crypt.php

Indentation +697 added lines, -697 removed lines

@@ -56,701 +56,701 @@
  * @package OCA\Encryption\Crypto
  */
 class Crypt {
-	public const SUPPORTED_CIPHERS_AND_KEY_SIZE = [
-		'AES-256-CTR' => 32,
-		'AES-128-CTR' => 16,
-		'AES-256-CFB' => 32,
-		'AES-128-CFB' => 16,
-	];
-	// one out of SUPPORTED_CIPHERS_AND_KEY_SIZE
-	public const DEFAULT_CIPHER = 'AES-256-CTR';
-	// default cipher from old Nextcloud versions
-	public const LEGACY_CIPHER = 'AES-128-CFB';
-
-	public const SUPPORTED_KEY_FORMATS = ['hash', 'password'];
-	// one out of SUPPORTED_KEY_FORMATS
-	public const DEFAULT_KEY_FORMAT = 'hash';
-	// default key format, old Nextcloud version encrypted the private key directly
-	// with the user password
-	public const LEGACY_KEY_FORMAT = 'password';
-
-	public const HEADER_START = 'HBEGIN';
-	public const HEADER_END = 'HEND';
-
-	// default encoding format, old Nextcloud versions used base64
-	public const BINARY_ENCODING_FORMAT = 'binary';
-
-	/** @var ILogger */
-	private $logger;
-
-	/** @var string */
-	private $user;
-
-	/** @var IConfig */
-	private $config;
-
-	/** @var IL10N */
-	private $l;
-
-	/** @var string|null */
-	private $currentCipher;
-
-	/** @var bool */
-	private $supportLegacy;
-
-	/**
-	 * Use the legacy base64 encoding instead of the more space-efficient binary encoding.
-	 */
-	private bool $useLegacyBase64Encoding;
-
-	/**
-	 * @param ILogger $logger
-	 * @param IUserSession $userSession
-	 * @param IConfig $config
-	 * @param IL10N $l
-	 */
-	public function __construct(ILogger $logger, IUserSession $userSession, IConfig $config, IL10N $l) {
-		$this->logger = $logger;
-		$this->user = $userSession && $userSession->isLoggedIn() ? $userSession->getUser()->getUID() : '"no user given"';
-		$this->config = $config;
-		$this->l = $l;
-		$this->supportLegacy = $this->config->getSystemValueBool('encryption.legacy_format_support', false);
-		$this->useLegacyBase64Encoding = $this->config->getSystemValueBool('encryption.use_legacy_base64_encoding', false);
-	}
-
-	/**
-	 * create new private/public key-pair for user
-	 *
-	 * @return array|bool
-	 */
-	public function createKeyPair() {
-		$log = $this->logger;
-		$res = $this->getOpenSSLPKey();
-
-		if (!$res) {
-			$log->error("Encryption Library couldn't generate users key-pair for {$this->user}",
-				['app' => 'encryption']);
-
-			if (openssl_error_string()) {
-				$log->error('Encryption library openssl_pkey_new() fails: ' . openssl_error_string(),
-					['app' => 'encryption']);
-			}
-		} elseif (openssl_pkey_export($res,
-			$privateKey,
-			null,
-			$this->getOpenSSLConfig())) {
-			$keyDetails = openssl_pkey_get_details($res);
-			$publicKey = $keyDetails['key'];
-
-			return [
-				'publicKey' => $publicKey,
-				'privateKey' => $privateKey
-			];
-		}
-		$log->error('Encryption library couldn\'t export users private key, please check your servers OpenSSL configuration.' . $this->user,
-			['app' => 'encryption']);
-		if (openssl_error_string()) {
-			$log->error('Encryption Library:' . openssl_error_string(),
-				['app' => 'encryption']);
-		}
-
-		return false;
-	}
-
-	/**
-	 * Generates a new private key
-	 *
-	 * @return \OpenSSLAsymmetricKey|false
-	 */
-	public function getOpenSSLPKey() {
-		$config = $this->getOpenSSLConfig();
-		return openssl_pkey_new($config);
-	}
-
-	/**
-	 * get openSSL Config
-	 *
-	 * @return array
-	 */
-	private function getOpenSSLConfig() {
-		$config = ['private_key_bits' => 4096];
-		$config = array_merge(
-			$config,
-			$this->config->getSystemValue('openssl', [])
-		);
-		return $config;
-	}
-
-	/**
-	 * @param string $plainContent
-	 * @param string $passPhrase
-	 * @param int $version
-	 * @param int $position
-	 * @return false|string
-	 * @throws EncryptionFailedException
-	 */
-	public function symmetricEncryptFileContent($plainContent, $passPhrase, $version, $position) {
-		if (!$plainContent) {
-			$this->logger->error('Encryption Library, symmetrical encryption failed no content given',
-				['app' => 'encryption']);
-			return false;
-		}
-
-		$iv = $this->generateIv();
-
-		$encryptedContent = $this->encrypt($plainContent,
-			$iv,
-			$passPhrase,
-			$this->getCipher());
-
-		// Create a signature based on the key as well as the current version
-		$sig = $this->createSignature($encryptedContent, $passPhrase.'_'.$version.'_'.$position);
-
-		// combine content to encrypt the IV identifier and actual IV
-		$catFile = $this->concatIV($encryptedContent, $iv);
-		$catFile = $this->concatSig($catFile, $sig);
-		return $this->addPadding($catFile);
-	}
-
-	/**
-	 * generate header for encrypted file
-	 *
-	 * @param string $keyFormat see SUPPORTED_KEY_FORMATS
-	 * @return string
-	 * @throws \InvalidArgumentException
-	 */
-	public function generateHeader($keyFormat = self::DEFAULT_KEY_FORMAT) {
-		if (in_array($keyFormat, self::SUPPORTED_KEY_FORMATS, true) === false) {
-			throw new \InvalidArgumentException('key format "' . $keyFormat . '" is not supported');
-		}
-
-		$header = self::HEADER_START
-			. ':cipher:' . $this->getCipher()
-			. ':keyFormat:' . $keyFormat;
-
-		if ($this->useLegacyBase64Encoding !== true) {
-			$header .= ':encoding:' . self::BINARY_ENCODING_FORMAT;
-		}
-
-		$header .= ':' . self::HEADER_END;
-
-		return $header;
-	}
-
-	/**
-	 * @param string $plainContent
-	 * @param string $iv
-	 * @param string $passPhrase
-	 * @param string $cipher
-	 * @return string
-	 * @throws EncryptionFailedException
-	 */
-	private function encrypt($plainContent, $iv, $passPhrase = '', $cipher = self::DEFAULT_CIPHER) {
-		$options = $this->useLegacyBase64Encoding ? 0 : OPENSSL_RAW_DATA;
-		$encryptedContent = openssl_encrypt($plainContent,
-			$cipher,
-			$passPhrase,
-			$options,
-			$iv);
-
-		if (!$encryptedContent) {
-			$error = 'Encryption (symmetric) of content failed';
-			$this->logger->error($error . openssl_error_string(),
-				['app' => 'encryption']);
-			throw new EncryptionFailedException($error);
-		}
-
-		return $encryptedContent;
-	}
-
-	/**
-	 * return cipher either from config.php or the default cipher defined in
-	 * this class
-	 *
-	 * @return string
-	 */
-	private function getCachedCipher() {
-		if (isset($this->currentCipher)) {
-			return $this->currentCipher;
-		}
-
-		// Get cipher either from config.php or the default cipher defined in this class
-		$cipher = $this->config->getSystemValueString('cipher', self::DEFAULT_CIPHER);
-		if (!isset(self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher])) {
-			$this->logger->warning(
-				sprintf(
-					'Unsupported cipher (%s) defined in config.php supported. Falling back to %s',
-					$cipher,
-					self::DEFAULT_CIPHER
-				),
-				['app' => 'encryption']
-			);
-			$cipher = self::DEFAULT_CIPHER;
-		}
-
-		// Remember current cipher to avoid frequent lookups
-		$this->currentCipher = $cipher;
-		return $this->currentCipher;
-	}
-
-	/**
-	 * return current encryption cipher
-	 *
-	 * @return string
-	 */
-	public function getCipher() {
-		return $this->getCachedCipher();
-	}
-
-	/**
-	 * get key size depending on the cipher
-	 *
-	 * @param string $cipher
-	 * @return int
-	 * @throws \InvalidArgumentException
-	 */
-	protected function getKeySize($cipher) {
-		if (isset(self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher])) {
-			return self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher];
-		}
-
-		throw new \InvalidArgumentException(
-			sprintf(
-					'Unsupported cipher (%s) defined.',
-					$cipher
-			)
-		);
-	}
-
-	/**
-	 * get legacy cipher
-	 *
-	 * @return string
-	 */
-	public function getLegacyCipher() {
-		if (!$this->supportLegacy) {
-			throw new ServerNotAvailableException('Legacy cipher is no longer supported!');
-		}
-
-		return self::LEGACY_CIPHER;
-	}
-
-	/**
-	 * @param string $encryptedContent
-	 * @param string $iv
-	 * @return string
-	 */
-	private function concatIV($encryptedContent, $iv) {
-		return $encryptedContent . '00iv00' . $iv;
-	}
-
-	/**
-	 * @param string $encryptedContent
-	 * @param string $signature
-	 * @return string
-	 */
-	private function concatSig($encryptedContent, $signature) {
-		return $encryptedContent . '00sig00' . $signature;
-	}
-
-	/**
-	 * Note: This is _NOT_ a padding used for encryption purposes. It is solely
-	 * used to achieve the PHP stream size. It has _NOTHING_ to do with the
-	 * encrypted content and is not used in any crypto primitive.
-	 *
-	 * @param string $data
-	 * @return string
-	 */
-	private function addPadding($data) {
-		return $data . 'xxx';
-	}
-
-	/**
-	 * generate password hash used to encrypt the users private key
-	 *
-	 * @param string $password
-	 * @param string $cipher
-	 * @param string $uid only used for user keys
-	 * @return string
-	 */
-	protected function generatePasswordHash($password, $cipher, $uid = '') {
-		$instanceId = $this->config->getSystemValue('instanceid');
-		$instanceSecret = $this->config->getSystemValue('secret');
-		$salt = hash('sha256', $uid . $instanceId . $instanceSecret, true);
-		$keySize = $this->getKeySize($cipher);
-
-		$hash = hash_pbkdf2(
-			'sha256',
-			$password,
-			$salt,
-			100000,
-			$keySize,
-			true
-		);
-
-		return $hash;
-	}
-
-	/**
-	 * encrypt private key
-	 *
-	 * @param string $privateKey
-	 * @param string $password
-	 * @param string $uid for regular users, empty for system keys
-	 * @return false|string
-	 */
-	public function encryptPrivateKey($privateKey, $password, $uid = '') {
-		$cipher = $this->getCipher();
-		$hash = $this->generatePasswordHash($password, $cipher, $uid);
-		$encryptedKey = $this->symmetricEncryptFileContent(
-			$privateKey,
-			$hash,
-			0,
-			0
-		);
-
-		return $encryptedKey;
-	}
-
-	/**
-	 * @param string $privateKey
-	 * @param string $password
-	 * @param string $uid for regular users, empty for system keys
-	 * @return false|string
-	 */
-	public function decryptPrivateKey($privateKey, $password = '', $uid = '') {
-		$header = $this->parseHeader($privateKey);
-
-		if (isset($header['cipher'])) {
-			$cipher = $header['cipher'];
-		} else {
-			$cipher = $this->getLegacyCipher();
-		}
-
-		if (isset($header['keyFormat'])) {
-			$keyFormat = $header['keyFormat'];
-		} else {
-			$keyFormat = self::LEGACY_KEY_FORMAT;
-		}
-
-		if ($keyFormat === self::DEFAULT_KEY_FORMAT) {
-			$password = $this->generatePasswordHash($password, $cipher, $uid);
-		}
-
-		$binaryEncoding = isset($header['encoding']) && $header['encoding'] === self::BINARY_ENCODING_FORMAT;
-
-		// If we found a header we need to remove it from the key we want to decrypt
-		if (!empty($header)) {
-			$privateKey = substr($privateKey,
-				strpos($privateKey,
-					self::HEADER_END) + strlen(self::HEADER_END));
-		}
-
-		$plainKey = $this->symmetricDecryptFileContent(
-			$privateKey,
-			$password,
-			$cipher,
-			0,
-			0,
-			$binaryEncoding
-		);
-
-		if ($this->isValidPrivateKey($plainKey) === false) {
-			return false;
-		}
-
-		return $plainKey;
-	}
-
-	/**
-	 * check if it is a valid private key
-	 *
-	 * @param string $plainKey
-	 * @return bool
-	 */
-	protected function isValidPrivateKey($plainKey) {
-		$res = openssl_get_privatekey($plainKey);
-		// TODO: remove resource check one php7.4 is not longer supported
-		if (is_resource($res) || (is_object($res) && get_class($res) === 'OpenSSLAsymmetricKey')) {
-			$sslInfo = openssl_pkey_get_details($res);
-			if (isset($sslInfo['key'])) {
-				return true;
-			}
-		}
-
-		return false;
-	}
-
-	/**
-	 * @param string $keyFileContents
-	 * @param string $passPhrase
-	 * @param string $cipher
-	 * @param int $version
-	 * @param int|string $position
-	 * @param boolean $binaryEncoding
-	 * @return string
-	 * @throws DecryptionFailedException
-	 */
-	public function symmetricDecryptFileContent($keyFileContents, $passPhrase, $cipher = self::DEFAULT_CIPHER, $version = 0, $position = 0, bool $binaryEncoding = false) {
-		if ($keyFileContents == '') {
-			return '';
-		}
-
-		$catFile = $this->splitMetaData($keyFileContents, $cipher);
-
-		if ($catFile['signature'] !== false) {
-			try {
-				// First try the new format
-				$this->checkSignature($catFile['encrypted'], $passPhrase . '_' . $version . '_' . $position, $catFile['signature']);
-			} catch (GenericEncryptionException $e) {
-				// For compatibility with old files check the version without _
-				$this->checkSignature($catFile['encrypted'], $passPhrase . $version . $position, $catFile['signature']);
-			}
-		}
-
-		return $this->decrypt($catFile['encrypted'],
-			$catFile['iv'],
-			$passPhrase,
-			$cipher,
-			$binaryEncoding);
-	}
-
-	/**
-	 * check for valid signature
-	 *
-	 * @param string $data
-	 * @param string $passPhrase
-	 * @param string $expectedSignature
-	 * @throws GenericEncryptionException
-	 */
-	private function checkSignature($data, $passPhrase, $expectedSignature) {
-		$enforceSignature = !$this->config->getSystemValueBool('encryption_skip_signature_check', false);
-
-		$signature = $this->createSignature($data, $passPhrase);
-		$isCorrectHash = hash_equals($expectedSignature, $signature);
-
-		if (!$isCorrectHash && $enforceSignature) {
-			throw new GenericEncryptionException('Bad Signature', $this->l->t('Bad Signature'));
-		} elseif (!$isCorrectHash && !$enforceSignature) {
-			$this->logger->info("Signature check skipped", ['app' => 'encryption']);
-		}
-	}
-
-	/**
-	 * create signature
-	 *
-	 * @param string $data
-	 * @param string $passPhrase
-	 * @return string
-	 */
-	private function createSignature($data, $passPhrase) {
-		$passPhrase = hash('sha512', $passPhrase . 'a', true);
-		return hash_hmac('sha256', $data, $passPhrase);
-	}
-
-
-	/**
-	 * remove padding
-	 *
-	 * @param string $padded
-	 * @param bool $hasSignature did the block contain a signature, in this case we use a different padding
-	 * @return string|false
-	 */
-	private function removePadding($padded, $hasSignature = false) {
-		if ($hasSignature === false && substr($padded, -2) === 'xx') {
-			return substr($padded, 0, -2);
-		} elseif ($hasSignature === true && substr($padded, -3) === 'xxx') {
-			return substr($padded, 0, -3);
-		}
-		return false;
-	}
-
-	/**
-	 * split meta data from encrypted file
-	 * Note: for now, we assume that the meta data always start with the iv
-	 *       followed by the signature, if available
-	 *
-	 * @param string $catFile
-	 * @param string $cipher
-	 * @return array
-	 */
-	private function splitMetaData($catFile, $cipher) {
-		if ($this->hasSignature($catFile, $cipher)) {
-			$catFile = $this->removePadding($catFile, true);
-			$meta = substr($catFile, -93);
-			$iv = substr($meta, strlen('00iv00'), 16);
-			$sig = substr($meta, 22 + strlen('00sig00'));
-			$encrypted = substr($catFile, 0, -93);
-		} else {
-			$catFile = $this->removePadding($catFile);
-			$meta = substr($catFile, -22);
-			$iv = substr($meta, -16);
-			$sig = false;
-			$encrypted = substr($catFile, 0, -22);
-		}
-
-		return [
-			'encrypted' => $encrypted,
-			'iv' => $iv,
-			'signature' => $sig
-		];
-	}
-
-	/**
-	 * check if encrypted block is signed
-	 *
-	 * @param string $catFile
-	 * @param string $cipher
-	 * @return bool
-	 * @throws GenericEncryptionException
-	 */
-	private function hasSignature($catFile, $cipher) {
-		$skipSignatureCheck = $this->config->getSystemValueBool('encryption_skip_signature_check', false);
-
-		$meta = substr($catFile, -93);
-		$signaturePosition = strpos($meta, '00sig00');
-
-		// If we no longer support the legacy format then everything needs a signature
-		if (!$skipSignatureCheck && !$this->supportLegacy && $signaturePosition === false) {
-			throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature'));
-		}
-
-		// Enforce signature for the new 'CTR' ciphers
-		if (!$skipSignatureCheck && $signaturePosition === false && stripos($cipher, 'ctr') !== false) {
-			throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature'));
-		}
-
-		return ($signaturePosition !== false);
-	}
-
-
-	/**
-	 * @param string $encryptedContent
-	 * @param string $iv
-	 * @param string $passPhrase
-	 * @param string $cipher
-	 * @param boolean $binaryEncoding
-	 * @return string
-	 * @throws DecryptionFailedException
-	 */
-	private function decrypt(string $encryptedContent, string $iv, string $passPhrase = '', string $cipher = self::DEFAULT_CIPHER, bool $binaryEncoding = false): string {
-		$options = $binaryEncoding === true ? OPENSSL_RAW_DATA : 0;
-		$plainContent = openssl_decrypt($encryptedContent,
-			$cipher,
-			$passPhrase,
-			$options,
-			$iv);
-
-		if ($plainContent) {
-			return $plainContent;
-		} else {
-			throw new DecryptionFailedException('Encryption library: Decryption (symmetric) of content failed: ' . openssl_error_string());
-		}
-	}
-
-	/**
-	 * @param string $data
-	 * @return array
-	 */
-	protected function parseHeader($data) {
-		$result = [];
-
-		if (substr($data, 0, strlen(self::HEADER_START)) === self::HEADER_START) {
-			$endAt = strpos($data, self::HEADER_END);
-			$header = substr($data, 0, $endAt + strlen(self::HEADER_END));
-
-			// +1 not to start with an ':' which would result in empty element at the beginning
-			$exploded = explode(':',
-				substr($header, strlen(self::HEADER_START) + 1));
-
-			$element = array_shift($exploded);
-
-			while ($element !== self::HEADER_END) {
-				$result[$element] = array_shift($exploded);
-				$element = array_shift($exploded);
-			}
-		}
-
-		return $result;
-	}
-
-	/**
-	 * generate initialization vector
-	 *
-	 * @return string
-	 * @throws GenericEncryptionException
-	 */
-	private function generateIv() {
-		return random_bytes(16);
-	}
-
-	/**
-	 * Generate a cryptographically secure pseudo-random 256-bit ASCII key, used
-	 * as file key
-	 *
-	 * @return string
-	 * @throws \Exception
-	 */
-	public function generateFileKey() {
-		return random_bytes(32);
-	}
-
-	/**
-	 * @param $encKeyFile
-	 * @param $shareKey
-	 * @param $privateKey
-	 * @return string
-	 * @throws MultiKeyDecryptException
-	 */
-	public function multiKeyDecrypt($encKeyFile, $shareKey, $privateKey) {
-		if (!$encKeyFile) {
-			throw new MultiKeyDecryptException('Cannot multikey decrypt empty plain content');
-		}
-
-		if (openssl_open($encKeyFile, $plainContent, $shareKey, $privateKey, 'RC4')) {
-			return $plainContent;
-		} else {
-			throw new MultiKeyDecryptException('multikeydecrypt with share key failed:' . openssl_error_string());
-		}
-	}
-
-	/**
-	 * @param string $plainContent
-	 * @param array $keyFiles
-	 * @return array
-	 * @throws MultiKeyEncryptException
-	 */
-	public function multiKeyEncrypt($plainContent, array $keyFiles) {
-		// openssl_seal returns false without errors if plaincontent is empty
-		// so trigger our own error
-		if (empty($plainContent)) {
-			throw new MultiKeyEncryptException('Cannot multikeyencrypt empty plain content');
-		}
-
-		// Set empty vars to be set by openssl by reference
-		$sealed = '';
-		$shareKeys = [];
-		$mappedShareKeys = [];
-
-		if (openssl_seal($plainContent, $sealed, $shareKeys, $keyFiles, 'RC4')) {
-			$i = 0;
-
-			// Ensure each shareKey is labelled with its corresponding key id
-			foreach ($keyFiles as $userId => $publicKey) {
-				$mappedShareKeys[$userId] = $shareKeys[$i];
-				$i++;
-			}
-
-			return [
-				'keys' => $mappedShareKeys,
-				'data' => $sealed
-			];
-		} else {
-			throw new MultiKeyEncryptException('multikeyencryption failed ' . openssl_error_string());
-		}
-	}
-
-	public function useLegacyBase64Encoding(): bool {
-		return $this->useLegacyBase64Encoding;
-	}
+    public const SUPPORTED_CIPHERS_AND_KEY_SIZE = [
+        'AES-256-CTR' => 32,
+        'AES-128-CTR' => 16,
+        'AES-256-CFB' => 32,
+        'AES-128-CFB' => 16,
+    ];
+    // one out of SUPPORTED_CIPHERS_AND_KEY_SIZE
+    public const DEFAULT_CIPHER = 'AES-256-CTR';
+    // default cipher from old Nextcloud versions
+    public const LEGACY_CIPHER = 'AES-128-CFB';
+
+    public const SUPPORTED_KEY_FORMATS = ['hash', 'password'];
+    // one out of SUPPORTED_KEY_FORMATS
+    public const DEFAULT_KEY_FORMAT = 'hash';
+    // default key format, old Nextcloud version encrypted the private key directly
+    // with the user password
+    public const LEGACY_KEY_FORMAT = 'password';
+
+    public const HEADER_START = 'HBEGIN';
+    public const HEADER_END = 'HEND';
+
+    // default encoding format, old Nextcloud versions used base64
+    public const BINARY_ENCODING_FORMAT = 'binary';
+
+    /** @var ILogger */
+    private $logger;
+
+    /** @var string */
+    private $user;
+
+    /** @var IConfig */
+    private $config;
+
+    /** @var IL10N */
+    private $l;
+
+    /** @var string|null */
+    private $currentCipher;
+
+    /** @var bool */
+    private $supportLegacy;
+
+    /**
+     * Use the legacy base64 encoding instead of the more space-efficient binary encoding.
+     */
+    private bool $useLegacyBase64Encoding;
+
+    /**
+     * @param ILogger $logger
+     * @param IUserSession $userSession
+     * @param IConfig $config
+     * @param IL10N $l
+     */
+    public function __construct(ILogger $logger, IUserSession $userSession, IConfig $config, IL10N $l) {
+        $this->logger = $logger;
+        $this->user = $userSession && $userSession->isLoggedIn() ? $userSession->getUser()->getUID() : '"no user given"';
+        $this->config = $config;
+        $this->l = $l;
+        $this->supportLegacy = $this->config->getSystemValueBool('encryption.legacy_format_support', false);
+        $this->useLegacyBase64Encoding = $this->config->getSystemValueBool('encryption.use_legacy_base64_encoding', false);
+    }
+
+    /**
+     * create new private/public key-pair for user
+     *
+     * @return array|bool
+     */
+    public function createKeyPair() {
+        $log = $this->logger;
+        $res = $this->getOpenSSLPKey();
+
+        if (!$res) {
+            $log->error("Encryption Library couldn't generate users key-pair for {$this->user}",
+                ['app' => 'encryption']);
+
+            if (openssl_error_string()) {
+                $log->error('Encryption library openssl_pkey_new() fails: ' . openssl_error_string(),
+                    ['app' => 'encryption']);
+            }
+        } elseif (openssl_pkey_export($res,
+            $privateKey,
+            null,
+            $this->getOpenSSLConfig())) {
+            $keyDetails = openssl_pkey_get_details($res);
+            $publicKey = $keyDetails['key'];
+
+            return [
+                'publicKey' => $publicKey,
+                'privateKey' => $privateKey
+            ];
+        }
+        $log->error('Encryption library couldn\'t export users private key, please check your servers OpenSSL configuration.' . $this->user,
+            ['app' => 'encryption']);
+        if (openssl_error_string()) {
+            $log->error('Encryption Library:' . openssl_error_string(),
+                ['app' => 'encryption']);
+        }
+
+        return false;
+    }
+
+    /**
+     * Generates a new private key
+     *
+     * @return \OpenSSLAsymmetricKey|false
+     */
+    public function getOpenSSLPKey() {
+        $config = $this->getOpenSSLConfig();
+        return openssl_pkey_new($config);
+    }
+
+    /**
+     * get openSSL Config
+     *
+     * @return array
+     */
+    private function getOpenSSLConfig() {
+        $config = ['private_key_bits' => 4096];
+        $config = array_merge(
+            $config,
+            $this->config->getSystemValue('openssl', [])
+        );
+        return $config;
+    }
+
+    /**
+     * @param string $plainContent
+     * @param string $passPhrase
+     * @param int $version
+     * @param int $position
+     * @return false|string
+     * @throws EncryptionFailedException
+     */
+    public function symmetricEncryptFileContent($plainContent, $passPhrase, $version, $position) {
+        if (!$plainContent) {
+            $this->logger->error('Encryption Library, symmetrical encryption failed no content given',
+                ['app' => 'encryption']);
+            return false;
+        }
+
+        $iv = $this->generateIv();
+
+        $encryptedContent = $this->encrypt($plainContent,
+            $iv,
+            $passPhrase,
+            $this->getCipher());
+
+        // Create a signature based on the key as well as the current version
+        $sig = $this->createSignature($encryptedContent, $passPhrase.'_'.$version.'_'.$position);
+
+        // combine content to encrypt the IV identifier and actual IV
+        $catFile = $this->concatIV($encryptedContent, $iv);
+        $catFile = $this->concatSig($catFile, $sig);
+        return $this->addPadding($catFile);
+    }
+
+    /**
+     * generate header for encrypted file
+     *
+     * @param string $keyFormat see SUPPORTED_KEY_FORMATS
+     * @return string
+     * @throws \InvalidArgumentException
+     */
+    public function generateHeader($keyFormat = self::DEFAULT_KEY_FORMAT) {
+        if (in_array($keyFormat, self::SUPPORTED_KEY_FORMATS, true) === false) {
+            throw new \InvalidArgumentException('key format "' . $keyFormat . '" is not supported');
+        }
+
+        $header = self::HEADER_START
+            . ':cipher:' . $this->getCipher()
+            . ':keyFormat:' . $keyFormat;
+
+        if ($this->useLegacyBase64Encoding !== true) {
+            $header .= ':encoding:' . self::BINARY_ENCODING_FORMAT;
+        }
+
+        $header .= ':' . self::HEADER_END;
+
+        return $header;
+    }
+
+    /**
+     * @param string $plainContent
+     * @param string $iv
+     * @param string $passPhrase
+     * @param string $cipher
+     * @return string
+     * @throws EncryptionFailedException
+     */
+    private function encrypt($plainContent, $iv, $passPhrase = '', $cipher = self::DEFAULT_CIPHER) {
+        $options = $this->useLegacyBase64Encoding ? 0 : OPENSSL_RAW_DATA;
+        $encryptedContent = openssl_encrypt($plainContent,
+            $cipher,
+            $passPhrase,
+            $options,
+            $iv);
+
+        if (!$encryptedContent) {
+            $error = 'Encryption (symmetric) of content failed';
+            $this->logger->error($error . openssl_error_string(),
+                ['app' => 'encryption']);
+            throw new EncryptionFailedException($error);
+        }
+
+        return $encryptedContent;
+    }
+
+    /**
+     * return cipher either from config.php or the default cipher defined in
+     * this class
+     *
+     * @return string
+     */
+    private function getCachedCipher() {
+        if (isset($this->currentCipher)) {
+            return $this->currentCipher;
+        }
+
+        // Get cipher either from config.php or the default cipher defined in this class
+        $cipher = $this->config->getSystemValueString('cipher', self::DEFAULT_CIPHER);
+        if (!isset(self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher])) {
+            $this->logger->warning(
+                sprintf(
+                    'Unsupported cipher (%s) defined in config.php supported. Falling back to %s',
+                    $cipher,
+                    self::DEFAULT_CIPHER
+                ),
+                ['app' => 'encryption']
+            );
+            $cipher = self::DEFAULT_CIPHER;
+        }
+
+        // Remember current cipher to avoid frequent lookups
+        $this->currentCipher = $cipher;
+        return $this->currentCipher;
+    }
+
+    /**
+     * return current encryption cipher
+     *
+     * @return string
+     */
+    public function getCipher() {
+        return $this->getCachedCipher();
+    }
+
+    /**
+     * get key size depending on the cipher
+     *
+     * @param string $cipher
+     * @return int
+     * @throws \InvalidArgumentException
+     */
+    protected function getKeySize($cipher) {
+        if (isset(self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher])) {
+            return self::SUPPORTED_CIPHERS_AND_KEY_SIZE[$cipher];
+        }
+
+        throw new \InvalidArgumentException(
+            sprintf(
+                    'Unsupported cipher (%s) defined.',
+                    $cipher
+            )
+        );
+    }
+
+    /**
+     * get legacy cipher
+     *
+     * @return string
+     */
+    public function getLegacyCipher() {
+        if (!$this->supportLegacy) {
+            throw new ServerNotAvailableException('Legacy cipher is no longer supported!');
+        }
+
+        return self::LEGACY_CIPHER;
+    }
+
+    /**
+     * @param string $encryptedContent
+     * @param string $iv
+     * @return string
+     */
+    private function concatIV($encryptedContent, $iv) {
+        return $encryptedContent . '00iv00' . $iv;
+    }
+
+    /**
+     * @param string $encryptedContent
+     * @param string $signature
+     * @return string
+     */
+    private function concatSig($encryptedContent, $signature) {
+        return $encryptedContent . '00sig00' . $signature;
+    }
+
+    /**
+     * Note: This is _NOT_ a padding used for encryption purposes. It is solely
+     * used to achieve the PHP stream size. It has _NOTHING_ to do with the
+     * encrypted content and is not used in any crypto primitive.
+     *
+     * @param string $data
+     * @return string
+     */
+    private function addPadding($data) {
+        return $data . 'xxx';
+    }
+
+    /**
+     * generate password hash used to encrypt the users private key
+     *
+     * @param string $password
+     * @param string $cipher
+     * @param string $uid only used for user keys
+     * @return string
+     */
+    protected function generatePasswordHash($password, $cipher, $uid = '') {
+        $instanceId = $this->config->getSystemValue('instanceid');
+        $instanceSecret = $this->config->getSystemValue('secret');
+        $salt = hash('sha256', $uid . $instanceId . $instanceSecret, true);
+        $keySize = $this->getKeySize($cipher);
+
+        $hash = hash_pbkdf2(
+            'sha256',
+            $password,
+            $salt,
+            100000,
+            $keySize,
+            true
+        );
+
+        return $hash;
+    }
+
+    /**
+     * encrypt private key
+     *
+     * @param string $privateKey
+     * @param string $password
+     * @param string $uid for regular users, empty for system keys
+     * @return false|string
+     */
+    public function encryptPrivateKey($privateKey, $password, $uid = '') {
+        $cipher = $this->getCipher();
+        $hash = $this->generatePasswordHash($password, $cipher, $uid);
+        $encryptedKey = $this->symmetricEncryptFileContent(
+            $privateKey,
+            $hash,
+            0,
+            0
+        );
+
+        return $encryptedKey;
+    }
+
+    /**
+     * @param string $privateKey
+     * @param string $password
+     * @param string $uid for regular users, empty for system keys
+     * @return false|string
+     */
+    public function decryptPrivateKey($privateKey, $password = '', $uid = '') {
+        $header = $this->parseHeader($privateKey);
+
+        if (isset($header['cipher'])) {
+            $cipher = $header['cipher'];
+        } else {
+            $cipher = $this->getLegacyCipher();
+        }
+
+        if (isset($header['keyFormat'])) {
+            $keyFormat = $header['keyFormat'];
+        } else {
+            $keyFormat = self::LEGACY_KEY_FORMAT;
+        }
+
+        if ($keyFormat === self::DEFAULT_KEY_FORMAT) {
+            $password = $this->generatePasswordHash($password, $cipher, $uid);
+        }
+
+        $binaryEncoding = isset($header['encoding']) && $header['encoding'] === self::BINARY_ENCODING_FORMAT;
+
+        // If we found a header we need to remove it from the key we want to decrypt
+        if (!empty($header)) {
+            $privateKey = substr($privateKey,
+                strpos($privateKey,
+                    self::HEADER_END) + strlen(self::HEADER_END));
+        }
+
+        $plainKey = $this->symmetricDecryptFileContent(
+            $privateKey,
+            $password,
+            $cipher,
+            0,
+            0,
+            $binaryEncoding
+        );
+
+        if ($this->isValidPrivateKey($plainKey) === false) {
+            return false;
+        }
+
+        return $plainKey;
+    }
+
+    /**
+     * check if it is a valid private key
+     *
+     * @param string $plainKey
+     * @return bool
+     */
+    protected function isValidPrivateKey($plainKey) {
+        $res = openssl_get_privatekey($plainKey);
+        // TODO: remove resource check one php7.4 is not longer supported
+        if (is_resource($res) || (is_object($res) && get_class($res) === 'OpenSSLAsymmetricKey')) {
+            $sslInfo = openssl_pkey_get_details($res);
+            if (isset($sslInfo['key'])) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * @param string $keyFileContents
+     * @param string $passPhrase
+     * @param string $cipher
+     * @param int $version
+     * @param int|string $position
+     * @param boolean $binaryEncoding
+     * @return string
+     * @throws DecryptionFailedException
+     */
+    public function symmetricDecryptFileContent($keyFileContents, $passPhrase, $cipher = self::DEFAULT_CIPHER, $version = 0, $position = 0, bool $binaryEncoding = false) {
+        if ($keyFileContents == '') {
+            return '';
+        }
+
+        $catFile = $this->splitMetaData($keyFileContents, $cipher);
+
+        if ($catFile['signature'] !== false) {
+            try {
+                // First try the new format
+                $this->checkSignature($catFile['encrypted'], $passPhrase . '_' . $version . '_' . $position, $catFile['signature']);
+            } catch (GenericEncryptionException $e) {
+                // For compatibility with old files check the version without _
+                $this->checkSignature($catFile['encrypted'], $passPhrase . $version . $position, $catFile['signature']);
+            }
+        }
+
+        return $this->decrypt($catFile['encrypted'],
+            $catFile['iv'],
+            $passPhrase,
+            $cipher,
+            $binaryEncoding);
+    }
+
+    /**
+     * check for valid signature
+     *
+     * @param string $data
+     * @param string $passPhrase
+     * @param string $expectedSignature
+     * @throws GenericEncryptionException
+     */
+    private function checkSignature($data, $passPhrase, $expectedSignature) {
+        $enforceSignature = !$this->config->getSystemValueBool('encryption_skip_signature_check', false);
+
+        $signature = $this->createSignature($data, $passPhrase);
+        $isCorrectHash = hash_equals($expectedSignature, $signature);
+
+        if (!$isCorrectHash && $enforceSignature) {
+            throw new GenericEncryptionException('Bad Signature', $this->l->t('Bad Signature'));
+        } elseif (!$isCorrectHash && !$enforceSignature) {
+            $this->logger->info("Signature check skipped", ['app' => 'encryption']);
+        }
+    }
+
+    /**
+     * create signature
+     *
+     * @param string $data
+     * @param string $passPhrase
+     * @return string
+     */
+    private function createSignature($data, $passPhrase) {
+        $passPhrase = hash('sha512', $passPhrase . 'a', true);
+        return hash_hmac('sha256', $data, $passPhrase);
+    }
+
+
+    /**
+     * remove padding
+     *
+     * @param string $padded
+     * @param bool $hasSignature did the block contain a signature, in this case we use a different padding
+     * @return string|false
+     */
+    private function removePadding($padded, $hasSignature = false) {
+        if ($hasSignature === false && substr($padded, -2) === 'xx') {
+            return substr($padded, 0, -2);
+        } elseif ($hasSignature === true && substr($padded, -3) === 'xxx') {
+            return substr($padded, 0, -3);
+        }
+        return false;
+    }
+
+    /**
+     * split meta data from encrypted file
+     * Note: for now, we assume that the meta data always start with the iv
+     *       followed by the signature, if available
+     *
+     * @param string $catFile
+     * @param string $cipher
+     * @return array
+     */
+    private function splitMetaData($catFile, $cipher) {
+        if ($this->hasSignature($catFile, $cipher)) {
+            $catFile = $this->removePadding($catFile, true);
+            $meta = substr($catFile, -93);
+            $iv = substr($meta, strlen('00iv00'), 16);
+            $sig = substr($meta, 22 + strlen('00sig00'));
+            $encrypted = substr($catFile, 0, -93);
+        } else {
+            $catFile = $this->removePadding($catFile);
+            $meta = substr($catFile, -22);
+            $iv = substr($meta, -16);
+            $sig = false;
+            $encrypted = substr($catFile, 0, -22);
+        }
+
+        return [
+            'encrypted' => $encrypted,
+            'iv' => $iv,
+            'signature' => $sig
+        ];
+    }
+
+    /**
+     * check if encrypted block is signed
+     *
+     * @param string $catFile
+     * @param string $cipher
+     * @return bool
+     * @throws GenericEncryptionException
+     */
+    private function hasSignature($catFile, $cipher) {
+        $skipSignatureCheck = $this->config->getSystemValueBool('encryption_skip_signature_check', false);
+
+        $meta = substr($catFile, -93);
+        $signaturePosition = strpos($meta, '00sig00');
+
+        // If we no longer support the legacy format then everything needs a signature
+        if (!$skipSignatureCheck && !$this->supportLegacy && $signaturePosition === false) {
+            throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature'));
+        }
+
+        // Enforce signature for the new 'CTR' ciphers
+        if (!$skipSignatureCheck && $signaturePosition === false && stripos($cipher, 'ctr') !== false) {
+            throw new GenericEncryptionException('Missing Signature', $this->l->t('Missing Signature'));
+        }
+
+        return ($signaturePosition !== false);
+    }
+
+
+    /**
+     * @param string $encryptedContent
+     * @param string $iv
+     * @param string $passPhrase
+     * @param string $cipher
+     * @param boolean $binaryEncoding
+     * @return string
+     * @throws DecryptionFailedException
+     */
+    private function decrypt(string $encryptedContent, string $iv, string $passPhrase = '', string $cipher = self::DEFAULT_CIPHER, bool $binaryEncoding = false): string {
+        $options = $binaryEncoding === true ? OPENSSL_RAW_DATA : 0;
+        $plainContent = openssl_decrypt($encryptedContent,
+            $cipher,
+            $passPhrase,
+            $options,
+            $iv);
+
+        if ($plainContent) {
+            return $plainContent;
+        } else {
+            throw new DecryptionFailedException('Encryption library: Decryption (symmetric) of content failed: ' . openssl_error_string());
+        }
+    }
+
+    /**
+     * @param string $data
+     * @return array
+     */
+    protected function parseHeader($data) {
+        $result = [];
+
+        if (substr($data, 0, strlen(self::HEADER_START)) === self::HEADER_START) {
+            $endAt = strpos($data, self::HEADER_END);
+            $header = substr($data, 0, $endAt + strlen(self::HEADER_END));
+
+            // +1 not to start with an ':' which would result in empty element at the beginning
+            $exploded = explode(':',
+                substr($header, strlen(self::HEADER_START) + 1));
+
+            $element = array_shift($exploded);
+
+            while ($element !== self::HEADER_END) {
+                $result[$element] = array_shift($exploded);
+                $element = array_shift($exploded);
+            }
+        }
+
+        return $result;
+    }
+
+    /**
+     * generate initialization vector
+     *
+     * @return string
+     * @throws GenericEncryptionException
+     */
+    private function generateIv() {
+        return random_bytes(16);
+    }
+
+    /**
+     * Generate a cryptographically secure pseudo-random 256-bit ASCII key, used
+     * as file key
+     *
+     * @return string
+     * @throws \Exception
+     */
+    public function generateFileKey() {
+        return random_bytes(32);
+    }
+
+    /**
+     * @param $encKeyFile
+     * @param $shareKey
+     * @param $privateKey
+     * @return string
+     * @throws MultiKeyDecryptException
+     */
+    public function multiKeyDecrypt($encKeyFile, $shareKey, $privateKey) {
+        if (!$encKeyFile) {
+            throw new MultiKeyDecryptException('Cannot multikey decrypt empty plain content');
+        }
+
+        if (openssl_open($encKeyFile, $plainContent, $shareKey, $privateKey, 'RC4')) {
+            return $plainContent;
+        } else {
+            throw new MultiKeyDecryptException('multikeydecrypt with share key failed:' . openssl_error_string());
+        }
+    }
+
+    /**
+     * @param string $plainContent
+     * @param array $keyFiles
+     * @return array
+     * @throws MultiKeyEncryptException
+     */
+    public function multiKeyEncrypt($plainContent, array $keyFiles) {
+        // openssl_seal returns false without errors if plaincontent is empty
+        // so trigger our own error
+        if (empty($plainContent)) {
+            throw new MultiKeyEncryptException('Cannot multikeyencrypt empty plain content');
+        }
+
+        // Set empty vars to be set by openssl by reference
+        $sealed = '';
+        $shareKeys = [];
+        $mappedShareKeys = [];
+
+        if (openssl_seal($plainContent, $sealed, $shareKeys, $keyFiles, 'RC4')) {
+            $i = 0;
+
+            // Ensure each shareKey is labelled with its corresponding key id
+            foreach ($keyFiles as $userId => $publicKey) {
+                $mappedShareKeys[$userId] = $shareKeys[$i];
+                $i++;
+            }
+
+            return [
+                'keys' => $mappedShareKeys,
+                'data' => $sealed
+            ];
+        } else {
+            throw new MultiKeyEncryptException('multikeyencryption failed ' . openssl_error_string());
+        }
+    }
+
+    public function useLegacyBase64Encoding(): bool {
+        return $this->useLegacyBase64Encoding;
+    }
 }

apps/files_external/lib/Lib/Storage/SFTPReadStream.php

Indentation +170 added lines, -170 removed lines

@@ -30,174 +30,174 @@
 use phpseclib\Net\SSH2;
 
 class SFTPReadStream implements File {
-	/** @var resource */
-	public $context;
-
-	/** @var \phpseclib\Net\SFTP */
-	private $sftp;
-
-	/** @var string */
-	private $handle;
-
-	/** @var int */
-	private $internalPosition = 0;
-
-	/** @var int */
-	private $readPosition = 0;
-
-	/** @var bool */
-	private $eof = false;
-
-	private $buffer = '';
-
-	public static function register($protocol = 'sftpread') {
-		if (in_array($protocol, stream_get_wrappers(), true)) {
-			return false;
-		}
-		return stream_wrapper_register($protocol, get_called_class());
-	}
-
-	/**
-	 * Load the source from the stream context and return the context options
-	 *
-	 * @param string $name
-	 * @throws \BadMethodCallException
-	 */
-	protected function loadContext($name) {
-		$context = stream_context_get_options($this->context);
-		if (isset($context[$name])) {
-			$context = $context[$name];
-		} else {
-			throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
-		}
-		if (isset($context['session']) and $context['session'] instanceof \phpseclib\Net\SFTP) {
-			$this->sftp = $context['session'];
-		} else {
-			throw new \BadMethodCallException('Invalid context, session not set');
-		}
-		return $context;
-	}
-
-	public function stream_open($path, $mode, $options, &$opened_path) {
-		[, $path] = explode('://', $path);
-		$path = '/' . ltrim($path);
-		$path = str_replace('//', '/', $path);
-
-		$this->loadContext('sftp');
-
-		if (!($this->sftp->bitmap & SSH2::MASK_LOGIN)) {
-			return false;
-		}
-
-		$remote_file = $this->sftp->_realpath($path);
-		if ($remote_file === false) {
-			return false;
-		}
-
-		$packet = pack('Na*N2', strlen($remote_file), $remote_file, NET_SFTP_OPEN_READ, 0);
-		if (!$this->sftp->_send_sftp_packet(NET_SFTP_OPEN, $packet)) {
-			return false;
-		}
-
-		$response = $this->sftp->_get_sftp_packet();
-		switch ($this->sftp->packet_type) {
-			case NET_SFTP_HANDLE:
-				$this->handle = substr($response, 4);
-				break;
-			case NET_SFTP_STATUS: // presumably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
-				$this->sftp->_logError($response);
-				return false;
-			default:
-				user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
-				return false;
-		}
-
-		$this->request_chunk(256 * 1024);
-
-		return true;
-	}
-
-	public function stream_seek($offset, $whence = SEEK_SET) {
-		return false;
-	}
-
-	public function stream_tell() {
-		return $this->readPosition;
-	}
-
-	public function stream_read($count) {
-		if (!$this->eof && strlen($this->buffer) < $count) {
-			$chunk = $this->read_chunk();
-			$this->buffer .= $chunk;
-			if (!$this->eof) {
-				$this->request_chunk(256 * 1024);
-			}
-		}
-
-		$data = substr($this->buffer, 0, $count);
-		$this->buffer = substr($this->buffer, $count);
-		$this->readPosition += strlen($data);
-
-		return $data;
-	}
-
-	private function request_chunk($size) {
-		$packet = pack('Na*N3', strlen($this->handle), $this->handle, $this->internalPosition / 4294967296, $this->internalPosition, $size);
-		return $this->sftp->_send_sftp_packet(NET_SFTP_READ, $packet);
-	}
-
-	private function read_chunk() {
-		$response = $this->sftp->_get_sftp_packet();
-
-		switch ($this->sftp->packet_type) {
-			case NET_SFTP_DATA:
-				$temp = substr($response, 4);
-				$len = strlen($temp);
-				$this->internalPosition += $len;
-				return $temp;
-			case NET_SFTP_STATUS:
-				[1 => $status] = unpack('N', substr($response, 0, 4));
-				if ($status == NET_SFTP_STATUS_EOF) {
-					$this->eof = true;
-				}
-				return '';
-			default:
-				return '';
-		}
-	}
-
-	public function stream_write($data) {
-		return false;
-	}
-
-	public function stream_set_option($option, $arg1, $arg2) {
-		return false;
-	}
-
-	public function stream_truncate($size) {
-		return false;
-	}
-
-	public function stream_stat() {
-		return false;
-	}
-
-	public function stream_lock($operation) {
-		return false;
-	}
-
-	public function stream_flush() {
-		return false;
-	}
-
-	public function stream_eof() {
-		return $this->eof;
-	}
-
-	public function stream_close() {
-		if (!$this->sftp->_close_handle($this->handle)) {
-			return false;
-		}
-		return true;
-	}
+    /** @var resource */
+    public $context;
+
+    /** @var \phpseclib\Net\SFTP */
+    private $sftp;
+
+    /** @var string */
+    private $handle;
+
+    /** @var int */
+    private $internalPosition = 0;
+
+    /** @var int */
+    private $readPosition = 0;
+
+    /** @var bool */
+    private $eof = false;
+
+    private $buffer = '';
+
+    public static function register($protocol = 'sftpread') {
+        if (in_array($protocol, stream_get_wrappers(), true)) {
+            return false;
+        }
+        return stream_wrapper_register($protocol, get_called_class());
+    }
+
+    /**
+     * Load the source from the stream context and return the context options
+     *
+     * @param string $name
+     * @throws \BadMethodCallException
+     */
+    protected function loadContext($name) {
+        $context = stream_context_get_options($this->context);
+        if (isset($context[$name])) {
+            $context = $context[$name];
+        } else {
+            throw new \BadMethodCallException('Invalid context, "' . $name . '" options not set');
+        }
+        if (isset($context['session']) and $context['session'] instanceof \phpseclib\Net\SFTP) {
+            $this->sftp = $context['session'];
+        } else {
+            throw new \BadMethodCallException('Invalid context, session not set');
+        }
+        return $context;
+    }
+
+    public function stream_open($path, $mode, $options, &$opened_path) {
+        [, $path] = explode('://', $path);
+        $path = '/' . ltrim($path);
+        $path = str_replace('//', '/', $path);
+
+        $this->loadContext('sftp');
+
+        if (!($this->sftp->bitmap & SSH2::MASK_LOGIN)) {
+            return false;
+        }
+
+        $remote_file = $this->sftp->_realpath($path);
+        if ($remote_file === false) {
+            return false;
+        }
+
+        $packet = pack('Na*N2', strlen($remote_file), $remote_file, NET_SFTP_OPEN_READ, 0);
+        if (!$this->sftp->_send_sftp_packet(NET_SFTP_OPEN, $packet)) {
+            return false;
+        }
+
+        $response = $this->sftp->_get_sftp_packet();
+        switch ($this->sftp->packet_type) {
+            case NET_SFTP_HANDLE:
+                $this->handle = substr($response, 4);
+                break;
+            case NET_SFTP_STATUS: // presumably SSH_FX_NO_SUCH_FILE or SSH_FX_PERMISSION_DENIED
+                $this->sftp->_logError($response);
+                return false;
+            default:
+                user_error('Expected SSH_FXP_HANDLE or SSH_FXP_STATUS');
+                return false;
+        }
+
+        $this->request_chunk(256 * 1024);
+
+        return true;
+    }
+
+    public function stream_seek($offset, $whence = SEEK_SET) {
+        return false;
+    }
+
+    public function stream_tell() {
+        return $this->readPosition;
+    }
+
+    public function stream_read($count) {
+        if (!$this->eof && strlen($this->buffer) < $count) {
+            $chunk = $this->read_chunk();
+            $this->buffer .= $chunk;
+            if (!$this->eof) {
+                $this->request_chunk(256 * 1024);
+            }
+        }
+
+        $data = substr($this->buffer, 0, $count);
+        $this->buffer = substr($this->buffer, $count);
+        $this->readPosition += strlen($data);
+
+        return $data;
+    }
+
+    private function request_chunk($size) {
+        $packet = pack('Na*N3', strlen($this->handle), $this->handle, $this->internalPosition / 4294967296, $this->internalPosition, $size);
+        return $this->sftp->_send_sftp_packet(NET_SFTP_READ, $packet);
+    }
+
+    private function read_chunk() {
+        $response = $this->sftp->_get_sftp_packet();
+
+        switch ($this->sftp->packet_type) {
+            case NET_SFTP_DATA:
+                $temp = substr($response, 4);
+                $len = strlen($temp);
+                $this->internalPosition += $len;
+                return $temp;
+            case NET_SFTP_STATUS:
+                [1 => $status] = unpack('N', substr($response, 0, 4));
+                if ($status == NET_SFTP_STATUS_EOF) {
+                    $this->eof = true;
+                }
+                return '';
+            default:
+                return '';
+        }
+    }
+
+    public function stream_write($data) {
+        return false;
+    }
+
+    public function stream_set_option($option, $arg1, $arg2) {
+        return false;
+    }
+
+    public function stream_truncate($size) {
+        return false;
+    }
+
+    public function stream_stat() {
+        return false;
+    }
+
+    public function stream_lock($operation) {
+        return false;
+    }
+
+    public function stream_flush() {
+        return false;
+    }
+
+    public function stream_eof() {
+        return $this->eof;
+    }
+
+    public function stream_close() {
+        if (!$this->sftp->_close_handle($this->handle)) {
+            return false;
+        }
+        return true;
+    }
 }

core/Command/Log/Manage.php

Indentation +167 added lines, -167 removed lines

@@ -35,171 +35,171 @@
 use Symfony\Component\Console\Output\OutputInterface;
 
 class Manage extends Command implements CompletionAwareInterface {
-	public const DEFAULT_BACKEND = 'file';
-	public const DEFAULT_LOG_LEVEL = 2;
-	public const DEFAULT_TIMEZONE = 'UTC';
-
-	protected IConfig $config;
-
-	public function __construct(IConfig $config) {
-		$this->config = $config;
-		parent::__construct();
-	}
-
-	protected function configure() {
-		$this
-			->setName('log:manage')
-			->setDescription('manage logging configuration')
-			->addOption(
-				'backend',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'set the logging backend [file, syslog, errorlog, systemd]'
-			)
-			->addOption(
-				'level',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'set the log level [debug, info, warning, error, fatal]'
-			)
-			->addOption(
-				'timezone',
-				null,
-				InputOption::VALUE_REQUIRED,
-				'set the logging timezone'
-			)
-		;
-	}
-
-	protected function execute(InputInterface $input, OutputInterface $output): int {
-		// collate config setting to the end, to avoid partial configuration
-		$toBeSet = [];
-
-		if ($backend = $input->getOption('backend')) {
-			$this->validateBackend($backend);
-			$toBeSet['log_type'] = $backend;
-		}
-
-		$level = $input->getOption('level');
-		if ($level !== null) {
-			if (is_numeric($level)) {
-				$levelNum = $level;
-				// sanity check
-				$this->convertLevelNumber($levelNum);
-			} else {
-				$levelNum = $this->convertLevelString($level);
-			}
-			$toBeSet['loglevel'] = $levelNum;
-		}
-
-		if ($timezone = $input->getOption('timezone')) {
-			$this->validateTimezone($timezone);
-			$toBeSet['logtimezone'] = $timezone;
-		}
-
-		// set config
-		foreach ($toBeSet as $option => $value) {
-			$this->config->setSystemValue($option, $value);
-		}
-
-		// display configuration
-		$backend = $this->config->getSystemValue('log_type', self::DEFAULT_BACKEND);
-		$output->writeln('Enabled logging backend: '.$backend);
-
-		$levelNum = $this->config->getSystemValue('loglevel', self::DEFAULT_LOG_LEVEL);
-		$level = $this->convertLevelNumber($levelNum);
-		$output->writeln('Log level: '.$level.' ('.$levelNum.')');
-
-		$timezone = $this->config->getSystemValue('logtimezone', self::DEFAULT_TIMEZONE);
-		$output->writeln('Log timezone: '.$timezone);
-		return 0;
-	}
-
-	/**
-	 * @param string $backend
-	 * @throws \InvalidArgumentException
-	 */
-	protected function validateBackend($backend) {
-		if (!class_exists('OC\\Log\\'.ucfirst($backend))) {
-			throw new \InvalidArgumentException('Invalid backend');
-		}
-	}
-
-	/**
-	 * @param string $timezone
-	 * @throws \Exception
-	 */
-	protected function validateTimezone($timezone) {
-		new \DateTimeZone($timezone);
-	}
-
-	/**
-	 * @param string $level
-	 * @return int
-	 * @throws \InvalidArgumentException
-	 */
-	protected function convertLevelString($level) {
-		$level = strtolower($level);
-		switch ($level) {
-			case 'debug':
-				return 0;
-			case 'info':
-				return 1;
-			case 'warning':
-			case 'warn':
-				return 2;
-			case 'error':
-			case 'err':
-				return 3;
-			case 'fatal':
-				return 4;
-		}
-		throw new \InvalidArgumentException('Invalid log level string');
-	}
-
-	/**
-	 * @param int $levelNum
-	 * @return string
-	 * @throws \InvalidArgumentException
-	 */
-	protected function convertLevelNumber($levelNum) {
-		switch ($levelNum) {
-			case 0:
-				return 'Debug';
-			case 1:
-				return 'Info';
-			case 2:
-				return 'Warning';
-			case 3:
-				return 'Error';
-			case 4:
-				return 'Fatal';
-		}
-		throw new \InvalidArgumentException('Invalid log level number');
-	}
-
-	/**
-	 * @param string $optionName
-	 * @param CompletionContext $context
-	 * @return string[]
-	 */
-	public function completeOptionValues($optionName, CompletionContext $context) {
-		if ($optionName === 'backend') {
-			return ['file', 'syslog', 'errorlog', 'systemd'];
-		} elseif ($optionName === 'level') {
-			return ['debug', 'info', 'warning', 'error', 'fatal'];
-		} elseif ($optionName === 'timezone') {
-			return \DateTimeZone::listIdentifiers();
-		}
-		return [];
-	}
-
-	/**
-	 * @param string $argumentName
-	 * @param CompletionContext $context
-	 * @return string[]
-	 */
-	public function completeArgumentValues($argumentName, CompletionContext $context) {
-		return [];
-	}
+    public const DEFAULT_BACKEND = 'file';
+    public const DEFAULT_LOG_LEVEL = 2;
+    public const DEFAULT_TIMEZONE = 'UTC';
+
+    protected IConfig $config;
+
+    public function __construct(IConfig $config) {
+        $this->config = $config;
+        parent::__construct();
+    }
+
+    protected function configure() {
+        $this
+            ->setName('log:manage')
+            ->setDescription('manage logging configuration')
+            ->addOption(
+                'backend',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'set the logging backend [file, syslog, errorlog, systemd]'
+            )
+            ->addOption(
+                'level',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'set the log level [debug, info, warning, error, fatal]'
+            )
+            ->addOption(
+                'timezone',
+                null,
+                InputOption::VALUE_REQUIRED,
+                'set the logging timezone'
+            )
+        ;
+    }
+
+    protected function execute(InputInterface $input, OutputInterface $output): int {
+        // collate config setting to the end, to avoid partial configuration
+        $toBeSet = [];
+
+        if ($backend = $input->getOption('backend')) {
+            $this->validateBackend($backend);
+            $toBeSet['log_type'] = $backend;
+        }
+
+        $level = $input->getOption('level');
+        if ($level !== null) {
+            if (is_numeric($level)) {
+                $levelNum = $level;
+                // sanity check
+                $this->convertLevelNumber($levelNum);
+            } else {
+                $levelNum = $this->convertLevelString($level);
+            }
+            $toBeSet['loglevel'] = $levelNum;
+        }
+
+        if ($timezone = $input->getOption('timezone')) {
+            $this->validateTimezone($timezone);
+            $toBeSet['logtimezone'] = $timezone;
+        }
+
+        // set config
+        foreach ($toBeSet as $option => $value) {
+            $this->config->setSystemValue($option, $value);
+        }
+
+        // display configuration
+        $backend = $this->config->getSystemValue('log_type', self::DEFAULT_BACKEND);
+        $output->writeln('Enabled logging backend: '.$backend);
+
+        $levelNum = $this->config->getSystemValue('loglevel', self::DEFAULT_LOG_LEVEL);
+        $level = $this->convertLevelNumber($levelNum);
+        $output->writeln('Log level: '.$level.' ('.$levelNum.')');
+
+        $timezone = $this->config->getSystemValue('logtimezone', self::DEFAULT_TIMEZONE);
+        $output->writeln('Log timezone: '.$timezone);
+        return 0;
+    }
+
+    /**
+     * @param string $backend
+     * @throws \InvalidArgumentException
+     */
+    protected function validateBackend($backend) {
+        if (!class_exists('OC\\Log\\'.ucfirst($backend))) {
+            throw new \InvalidArgumentException('Invalid backend');
+        }
+    }
+
+    /**
+     * @param string $timezone
+     * @throws \Exception
+     */
+    protected function validateTimezone($timezone) {
+        new \DateTimeZone($timezone);
+    }
+
+    /**
+     * @param string $level
+     * @return int
+     * @throws \InvalidArgumentException
+     */
+    protected function convertLevelString($level) {
+        $level = strtolower($level);
+        switch ($level) {
+            case 'debug':
+                return 0;
+            case 'info':
+                return 1;
+            case 'warning':
+            case 'warn':
+                return 2;
+            case 'error':
+            case 'err':
+                return 3;
+            case 'fatal':
+                return 4;
+        }
+        throw new \InvalidArgumentException('Invalid log level string');
+    }
+
+    /**
+     * @param int $levelNum
+     * @return string
+     * @throws \InvalidArgumentException
+     */
+    protected function convertLevelNumber($levelNum) {
+        switch ($levelNum) {
+            case 0:
+                return 'Debug';
+            case 1:
+                return 'Info';
+            case 2:
+                return 'Warning';
+            case 3:
+                return 'Error';
+            case 4:
+                return 'Fatal';
+        }
+        throw new \InvalidArgumentException('Invalid log level number');
+    }
+
+    /**
+     * @param string $optionName
+     * @param CompletionContext $context
+     * @return string[]
+     */
+    public function completeOptionValues($optionName, CompletionContext $context) {
+        if ($optionName === 'backend') {
+            return ['file', 'syslog', 'errorlog', 'systemd'];
+        } elseif ($optionName === 'level') {
+            return ['debug', 'info', 'warning', 'error', 'fatal'];
+        } elseif ($optionName === 'timezone') {
+            return \DateTimeZone::listIdentifiers();
+        }
+        return [];
+    }
+
+    /**
+     * @param string $argumentName
+     * @param CompletionContext $context
+     * @return string[]
+     */
+    public function completeArgumentValues($argumentName, CompletionContext $context) {
+        return [];
+    }
 }