From 9d0bc570b0b94348359c41d9612e03d33ea165af Mon Sep 17 00:00:00 2001
From: Eileen McNaughton <emcnaughton@wikimedia.org>
Date: Thu, 27 Jan 2022 12:00:19 +1300
Subject: [PATCH] dev/core#2866 Generate text version of message at send time
 if not present

---
 CRM/Utils/Mail.php               | 18 ++++++++++++------
 tests/phpunit/api/v3/JobTest.php | 28 ++++++++++++----------------
 2 files changed, 24 insertions(+), 22 deletions(-)

diff --git a/CRM/Utils/Mail.php b/CRM/Utils/Mail.php
index 019283dacf..beb0ad3263 100644
--- a/CRM/Utils/Mail.php
+++ b/CRM/Utils/Mail.php
@@ -184,14 +184,20 @@ class CRM_Utils_Mail {
       return FALSE;
     }
 
-    $textMessage = $params['text'] ?? NULL;
-    $htmlMessage = $params['html'] ?? NULL;
-    $attachments = $params['attachments'] ?? NULL;
-
-    // CRM-6224
-    if (trim(CRM_Utils_String::htmlToText($htmlMessage)) == '') {
+    $htmlMessage = $params['html'] ?? FALSE;
+    if (trim(CRM_Utils_String::htmlToText((string) $htmlMessage)) === '') {
       $htmlMessage = FALSE;
     }
+    $attachments = $params['attachments'] ?? NULL;
+    if (!empty($params['text'])) {
+      $textMessage = $params['text'];
+    }
+    else {
+      $textMessage = CRM_Utils_String::htmlToText($htmlMessage);
+      // Render the &amp; entities in text mode, so that the links work.
+      // This is copied from the Action Schedule send code.
+      $textMessage = str_replace('&amp;', '&', $textMessage);
+    }
 
     $headers = [];
     // CRM-10699 support custom email headers
diff --git a/tests/phpunit/api/v3/JobTest.php b/tests/phpunit/api/v3/JobTest.php
index 8df77c3508..b144372b35 100644
--- a/tests/phpunit/api/v3/JobTest.php
+++ b/tests/phpunit/api/v3/JobTest.php
@@ -2356,8 +2356,8 @@ class api_v3_JobTest extends CiviUnitTestCase {
     $this->assertEquals('reportperson@example.com', $message->to[0]->email);
 
     $parts = $message->fetchParts(NULL, TRUE);
-    $this->assertCount(1, $parts);
-    $this->assertStringContainsString('test report', $parts[0]->text);
+    $this->assertCount(2, $parts);
+    $this->assertStringContainsString('test report', $parts[1]->text);
 
     $mut->clearMessages();
     $mut->stop();
@@ -2371,7 +2371,6 @@ class api_v3_JobTest extends CiviUnitTestCase {
    * the email was sent and it more or less looks like an email we'd expect.
    *
    * @throws \CRM_Core_Exception
-   * @throws \CRM_Core_Exception
    */
   public function testMailReportForPdf(): void {
     $mut = new CiviMailUtils($this, TRUE);
@@ -2392,12 +2391,12 @@ class api_v3_JobTest extends CiviUnitTestCase {
     $this->assertEquals('reportperson@example.com', $message->to[0]->email);
 
     $parts = $message->fetchParts(NULL, TRUE);
-    $this->assertCount(2, $parts);
-    $this->assertStringContainsString('<title>CiviCRM Report</title>', $parts[0]->text);
-    $this->assertEquals(ezcMailFilePart::CONTENT_TYPE_APPLICATION, $parts[1]->contentType);
-    $this->assertEquals('pdf', $parts[1]->mimeType);
-    $this->assertEquals(ezcMailFilePart::DISPLAY_ATTACHMENT, $parts[1]->dispositionType);
-    $this->assertGreaterThan(0, filesize($parts[1]->fileName));
+    $this->assertCount(3, $parts);
+    $this->assertStringContainsString('<title>CiviCRM Report</title>', $parts[1]->text);
+    $this->assertEquals(ezcMailFilePart::CONTENT_TYPE_APPLICATION, $parts[2]->contentType);
+    $this->assertEquals('pdf', $parts[2]->mimeType);
+    $this->assertEquals(ezcMailFilePart::DISPLAY_ATTACHMENT, $parts[2]->dispositionType);
+    $this->assertGreaterThan(0, filesize($parts[2]->fileName));
 
     $mut->clearMessages();
     $mut->stop();
@@ -2411,7 +2410,6 @@ class api_v3_JobTest extends CiviUnitTestCase {
    * but since it's csv we can easily check the output.
    *
    * @throws \CRM_Core_Exception
-   * @throws \CiviCRM_API3_Exception
    */
   public function testMailReportForCsv(): void {
     // Create many contacts, in particular so that the report would be more
@@ -2438,9 +2436,9 @@ class api_v3_JobTest extends CiviUnitTestCase {
     $this->assertEquals('reportperson@example.com', $message->to[0]->email);
 
     $parts = $message->fetchParts(NULL, TRUE);
-    $this->assertCount(2, $parts);
-    $this->assertStringContainsString('<title>CiviCRM Report</title>', $parts[0]->text);
-    $this->assertEquals('csv', $parts[1]->subType);
+    $this->assertCount(3, $parts);
+    $this->assertStringContainsString('<title>CiviCRM Report</title>', $parts[1]->text);
+    $this->assertEquals('csv', $parts[2]->subType);
 
     // Pull all the contacts to get our expected output.
     $contacts = $this->callAPISuccess('Contact', 'get', [
@@ -2465,7 +2463,7 @@ class api_v3_JobTest extends CiviUnitTestCase {
 
     $this->assertEquals(
       CRM_Report_Utils_Report::makeCsv($fakeForm, $rows),
-      $parts[1]->text
+      $parts[2]->text
     );
 
     $mut->clearMessages();
@@ -2474,8 +2472,6 @@ class api_v3_JobTest extends CiviUnitTestCase {
 
   /**
    * Helper to create a report instance of the contact summary report.
-   *
-   * @throws \CRM_Core_Exception
    */
   private function createReportInstance() {
     return $this->callAPISuccess('ReportInstance', 'create', [
-- 
2.25.1