Minor cleanup: php-cs-fixer, tests, interface consistency

IMipPlugin.php Removed blank lines to make php-cs-fixer happy.
Minor cleanup:  bugs found by Psalm static checker
IEMailTemplate: The public interface to addBodyListItem also needs to include the new plainIndent parameter.
IMipPlugin: Fixes an undefined variable for events that do not have DTEND.  Also use explicit string conversion for parameters and properties in several places.

The new email template adds an additional blank line before "button" links in plain text, so the tests were fixed to include that additional blank line.

Signed-off-by: Brad Rubenstein <brad@wbr.tech>

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

@@ -3,7 +3,6 @@
  * @copyright Copyright (c) 2016, ownCloud, Inc.
  * @copyright Copyright (c) 2017, Georg Ehrke
  *
- * @author brad2014 <brad2014@users.noreply.github.com>
  * @author Brad Rubenstein <brad@wbr.tech>
  * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  * @author Georg Ehrke <oc.list@georgehrke.com>
@@ -242,8 +241,7 @@ class IMipPlugin extends SabreIMipPlugin {
 
 		$summary = ((string) $summary !== '') ? (string) $summary : $l10n->t('Untitled event');
 
-		$this->addSubjectAndHeading($template, $l10n, $method, $summary,
-			$meetingAttendeeName, $meetingInviteeName);
+		$this->addSubjectAndHeading($template, $l10n, $method, $summary);
 		$this->addBulletList($template, $l10n, $vevent);
 
 
@@ -402,20 +400,19 @@ class IMipPlugin extends SabreIMipPlugin {
 	 * @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 = $end->getDateTime();
+			$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 = $end->getDateTime();
+			$endDateTime = $dtend->getDateTime();
 			$endDateTime = $endDateTime->modify('+1 day');
 			$dtend->setDateTime($endDateTime, $isFloating);
 		} else {
@@ -526,7 +523,6 @@ class IMipPlugin extends SabreIMipPlugin {
 	 * @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.svg'),'','',self::IMIP_INDENT);
@@ -541,19 +537,20 @@ class IMipPlugin extends SabreIMipPlugin {
 				$this->getAbsoluteImagePath('caldav/location.svg'),'','',self::IMIP_INDENT);
 		}
 		if ($vevent->URL) {
+			$url = $vevent->URL->getValue();
 			$template->addBodyListItem(sprintf('<a href="%s">%s</a>',
-					htmlspecialchars($vevent->URL),
-					htmlspecialchars($vevent->URL)),
+					htmlspecialchars($url),
+					htmlspecialchars($url)),
 				$l10n->t('Link:'),
 				$this->getAbsoluteImagePath('caldav/link.svg'),
-				$vevent->URL,'',self::IMIP_INDENT);
+				$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, $l10n->t('Description:'),
+			$template->addBodyListItem($vevent->DESCRIPTION->getValue(), $l10n->t('Description:'),
 				$this->getAbsoluteImagePath('caldav/description.svg'),'','',self::IMIP_INDENT);
 		}
 	}
@@ -581,18 +578,23 @@ class IMipPlugin extends SabreIMipPlugin {
 		}
 
 		if (isset($vevent->ORGANIZER)) {
+			/** @var Property\ICalendar\CalAddress $organizer */
 			$organizer = $vevent->ORGANIZER;
 			$organizerURI = $organizer->getNormalizedValue();
 			list($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'])
-				&& strcasecmp($organizer['PARTSTAT'], 'ACCEPTED') === 0) {
-				$organizerHTML .= ' ✔︎';
-				$organizerText .= ' ✔︎';
+			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.svg'),

apps/dav/tests/unit/CalDAV/Schedule/IMipPluginTest.php

@@ -136,6 +136,7 @@ class IMipPluginTest extends TestCase {
 
 	public function testDelivery() {
 		$this->config
+	  ->expects($this->at(1))
 			->method('getAppValue')
 			->with('dav', 'invitation_link_recipients', 'yes')
 			->willReturn('yes');
@@ -148,6 +149,7 @@ class IMipPluginTest extends TestCase {
 
 	public function testFailedDelivery() {
 		$this->config
+	  ->expects($this->at(1))
 			->method('getAppValue')
 			->with('dav', 'invitation_link_recipients', 'yes')
 			->willReturn('yes');
@@ -163,6 +165,7 @@ class IMipPluginTest extends TestCase {
 
 	public function testDeliveryWithNoCommonName() {
 		$this->config
+	  ->expects($this->at(1))
 			->method('getAppValue')
 			->with('dav', 'invitation_link_recipients', 'yes')
 			->willReturn('yes');
@@ -188,9 +191,8 @@ class IMipPluginTest extends TestCase {
 	 */
 	public function testNoMessageSendForPastEvents(array $veventParams, bool $expectsMail) {
 		$this->config
-			->method('getAppValue')
-			->with('dav', 'invitation_link_recipients', 'yes')
-			->willReturn('yes');
+	  ->method('getAppValue')
+	  ->willReturn('yes');
 
 		$message = $this->_testMessage($veventParams);
 
@@ -228,6 +230,7 @@ class IMipPluginTest extends TestCase {
 
 		$this->_expectSend($recipient, true, $has_buttons);
 		$this->config
+	  ->expects($this->at(1))
 			->method('getAppValue')
 			->with('dav', 'invitation_link_recipients', 'yes')
 			->willReturn($config_setting);
@@ -252,14 +255,13 @@ class IMipPluginTest extends TestCase {
 	public function testMessageSendWhenEventWithoutName() {
 		$this->config
 			->method('getAppValue')
-			->with('dav', 'invitation_link_recipients', 'yes')
 			->willReturn('yes');
 
 		$message = $this->_testMessage(['SUMMARY' => '']);
 		$this->_expectSend('frodo@hobb.it', true, true,'Invitation: Untitled event');
 		$this->emailTemplate->expects($this->once())
 			->method('addHeading')
-			->with('Mr. Wizard invited you to »Untitled event«');
+			->with('Invitation');
 		$this->plugin->schedule($message);
 		$this->assertEquals('1.1', $message->getScheduleStatus());
 	}

apps/settings/tests/Mailer/NewUserMailHelperTest.php

@@ -599,6 +599,7 @@ Welcome to your TestCloud account, you can add, protect, and share your data.
 
 Your username is: john
 
+
 Go to TestCloud: https://example.com/
 Install Client: https://nextcloud.com/install/#install-clients
 
@@ -817,6 +818,7 @@ Welcome aboard John Doe
 
 Welcome to your TestCloud account, you can add, protect, and share your data.
 
+
 Go to TestCloud: https://example.com/
 Install Client: https://nextcloud.com/install/#install-clients
 

lib/private/Mail/EMailTemplate.php

@@ -447,21 +447,21 @@ EOF;
 	 * @param string $metaInfo Note: When $plainMetaInfo falls back to this, HTML is automatically escaped in the HTML email
 	 * @param string $icon Absolute path, must be 16*16 pixels
 	 * @param string|bool $plainText Text that is used in the plain text email
-	 *   if empty the $text is used, if false none will be used
+	 *   if empty or true the $text is used, if false none will be used
 	 * @param string|bool $plainMetaInfo Meta info that is used in the plain text email
-	 *   if empty the $metaInfo is used, if false none will be used
+	 *   if empty or true the $metaInfo is used, if false none will be used
 	 * @param integer plainIndent If > 0, Indent plainText by this amount.
 	 * @since 12.0.0
 	 */
 	public function addBodyListItem(string $text, string $metaInfo = '', string $icon = '', $plainText = '', $plainMetaInfo = '', $plainIndent = 0) {
 		$this->ensureBodyListOpened();
 
-		if ($plainText === '') {
+		if ($plainText === '' || $plainText === true) {
 			$plainText = $text;
 			$text = htmlspecialchars($text);
 			$text = str_replace("\n", "<br/>", $text); // convert newlines to HTML breaks
 		}
-		if ($plainMetaInfo === '') {
+		if ($plainMetaInfo === '' || $plainMetaInfo === true) {
 			$plainMetaInfo = $metaInfo;
 			$metaInfo = htmlspecialchars($metaInfo);
 		}
@@ -494,8 +494,10 @@ EOF;
 				 * "plainIndent". Multilines after the first are indented plainIndent+1
 				 * (to account for space after label).  Fixes: #12391
 				 */
+				/** @var string $label */
+				$label = ($plainMetaInfo !== false)? $plainMetaInfo : '';
 				$this->plainBody .= sprintf("%${plainIndent}s %s\n",
-					$plainMetaInfo,
+					$label,
 					str_replace("\n", "\n" . str_repeat(' ', $plainIndent+1), $plainText));
 			}
 		}

lib/public/Mail/IEMailTemplate.php

@@ -106,9 +106,10 @@ interface IEMailTemplate {
 	 *   if empty the $text is used, if false none will be used
 	 * @param string|bool $plainMetaInfo Meta info that is used in the plain text email
 	 *   if empty the $metaInfo is used, if false none will be used
+	 * @param integer plainIndent If > 0, Indent plainText by this amount.
 	 * @since 12.0.0
 	 */
-	public function addBodyListItem(string $text, string $metaInfo = '', string $icon = '', $plainText = '', $plainMetaInfo = '');
+	public function addBodyListItem(string $text, string $metaInfo = '', string $icon = '', $plainText = '', $plainMetaInfo = '', $plainIndent = 0);
 
 	/**
 	 * Adds a button group of two buttons to the body of the email

tests/data/emails/new-account-email-custom-text-alternative.txt

@@ -4,6 +4,7 @@ Welcome to your Nextcloud account, you can add, protect, and share your data. -
 
 Your username is: abc
 
+
 Set your password - text: https://example.org/resetPassword/123
 Install Client - text: https://nextcloud.com/install/#install-clients
 

tests/data/emails/new-account-email-custom.txt

@@ -4,6 +4,7 @@ Welcome to your Nextcloud account, you can add, protect, and share your data.
 
 Your username is: abc
 
+
 Set your password: https://example.org/resetPassword/123
 Install Client: https://nextcloud.com/install/#install-clients
 

tests/data/emails/new-account-email.txt

@@ -4,6 +4,7 @@ Welcome to your Nextcloud account, you can add, protect, and share your data.
 
 Your username is: abc
 
+
 Set your password: https://example.org/resetPassword/123
 Install Client: https://nextcloud.com/install/#install-clients