From 718486dd80537200e61363491b6cbf32e1903cd2 Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Thu, 22 Jun 2023 20:58:03 -0700
Subject: [PATCH] (REF) Extract TestBanner as listener

To r-run this, I used the following procedure:

* Take an arbitrary `Contribution` from example DB (eg id=100)
* Update in SQL (`SET is_test=1 WHERE id=100`)
* Send mailing with `cv api Contribution.sendconfirmation id=100`
* Check email log
---
 CRM/Core/BAO/MessageTemplate.php    | 14 +-------
 Civi/WorkflowMessage/TestBanner.php | 56 +++++++++++++++++++++++++++++
 2 files changed, 57 insertions(+), 13 deletions(-)
 create mode 100644 Civi/WorkflowMessage/TestBanner.php

diff --git a/CRM/Core/BAO/MessageTemplate.php b/CRM/Core/BAO/MessageTemplate.php
index 282d2ad796..87ab6c292c 100644
--- a/CRM/Core/BAO/MessageTemplate.php
+++ b/CRM/Core/BAO/MessageTemplate.php
@@ -531,23 +531,11 @@ class CRM_Core_BAO_MessageTemplate extends CRM_Core_DAO_MessageTemplate implemen
       // https://github.com/civicrm/civicrm-core/pull/17180
       'groupName' => $groupName,
       'workflow' => $workflowName,
+      'isTest' => $isTest,
     ];
 
     CRM_Utils_Hook::alterMailContent($mailContent);
 
-    // add the test banner (if requested)
-    if ($isTest) {
-      $testText = MessageTemplate::get(FALSE)
-        ->setSelect(['msg_subject', 'msg_text', 'msg_html'])
-        ->addWhere('workflow_name', '=', 'test_preview')
-        ->addWhere('is_default', '=', TRUE)
-        ->execute()->first();
-
-      $mailContent['subject'] = $testText['msg_subject'] . $mailContent['subject'];
-      $mailContent['text'] = $testText['msg_text'] . $mailContent['text'];
-      $mailContent['html'] = preg_replace('/<body(.*)$/im', "<body\\1\n{$testText['msg_html']}", $mailContent['html']);
-    }
-
     if (!empty($subjectOverride)) {
       CRM_Core_Error::deprecatedWarning('CRM_Core_BAO_MessageTemplate: $params[subject] is deprecated. Use $params[messageTemplate][msg_subject] instead.');
       $mailContent['subject'] = $subjectOverride;
diff --git a/Civi/WorkflowMessage/TestBanner.php b/Civi/WorkflowMessage/TestBanner.php
new file mode 100644
index 0000000000..9480b3c22c
--- /dev/null
+++ b/Civi/WorkflowMessage/TestBanner.php
@@ -0,0 +1,56 @@
+<?php
+
+/*
+ +--------------------------------------------------------------------+
+ | Copyright CiviCRM LLC. All rights reserved.                        |
+ |                                                                    |
+ | This work is published under the GNU AGPLv3 license with some      |
+ | permitted exceptions and without any warranty. For full license    |
+ | and copyright information, see https://civicrm.org/licensing       |
+ +--------------------------------------------------------------------+
+ */
+
+namespace Civi\WorkflowMessage;
+
+use Civi\Api4\MessageTemplate;
+use Civi\Core\Service\AutoService;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+/**
+ * If someone sends an automated message for a test record (e.g. Contribution with `is_test=1`),
+ * then we add a banner to the automated message.
+ *
+ * @service
+ * @internal
+ */
+class TestBanner extends AutoService implements EventSubscriberInterface {
+
+  public static function getSubscribedEvents() {
+    return [
+      '&hook_civicrm_alterMailContent' => ['onAlterMailContent', -1000],
+    ];
+  }
+
+  public function onAlterMailContent(array &$mailContent): void {
+    // Only alter workflow-messages -- not CiviMail messages
+    if (!empty($mailContent['mailingID'])) {
+      return;
+    }
+
+    // Only alter test messages
+    if (empty($mailContent['isTest'])) {
+      return;
+    }
+
+    $testText = MessageTemplate::get(FALSE)
+      ->setSelect(['msg_subject', 'msg_text', 'msg_html'])
+      ->addWhere('workflow_name', '=', 'test_preview')
+      ->addWhere('is_default', '=', TRUE)
+      ->execute()->first();
+
+    $mailContent['subject'] = $testText['msg_subject'] . $mailContent['subject'];
+    $mailContent['text'] = $testText['msg_text'] . $mailContent['text'];
+    $mailContent['html'] = preg_replace('/<body(.*)$/im', "<body\\1\n{$testText['msg_html']}", $mailContent['html']);
+  }
+
+}
-- 
2.25.1