Merge pull request #30498 from colemanw/msgTplRevert

MessageTemplate - Add Api4.revert action
civicrm · Jun 19, 2024 · ad6b5a6 · ad6b5a6
2 parents f0e2d0f + 73ee3f0
commit ad6b5a6
Show file tree

Hide file tree

Showing 4 changed files with 84 additions and 16 deletions.
diff --git a/CRM/Utils/API/HTMLInputCoder.php b/CRM/Utils/API/HTMLInputCoder.php
@@ -62,6 +62,8 @@ public function getSkipFields() {
         'html_message',
         'body_html',
         'msg_html',
+        // MessageTemplate subject might contain the < character in a smarty tag
+        'msg_subject',
         'description',
         'intro',
         'thankyou_text',

diff --git a/Civi/Api4/Action/MessageTemplate/Revert.php b/Civi/Api4/Action/MessageTemplate/Revert.php
@@ -0,0 +1,39 @@
+<?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\Api4\Action\MessageTemplate;
+
+use Civi\Api4\Generic\Result;
+use Civi\Api4\MessageTemplate;
+
+/**
+ * Reverts a MessageTemplate subject and message to the contents of the master
+ */
+class Revert extends \Civi\Api4\Generic\BasicBatchAction {
+
+  protected function processBatch(Result $result, array $items) {
+    $revertable = MessageTemplate::get($this->getCheckPermissions())
+      ->addSelect('id', 'master_id', 'master_id.msg_subject', 'master_id.msg_html')
+      ->addWhere('id', 'IN', array_column($items, 'id'))
+      ->execute();
+    foreach ($revertable as $item) {
+      if (!empty($item['master_id'])) {
+        MessageTemplate::update(FALSE)
+          ->addWhere('id', '=', $item['id'])
+          ->addValue('msg_subject', $item['master_id.msg_subject'])
+          ->addValue('msg_html', $item['master_id.msg_html'])
+          ->execute();
+      }
+    }
+  }
+
+}
diff --git a/Civi/Api4/MessageTemplate.php b/Civi/Api4/MessageTemplate.php
@@ -20,4 +20,13 @@
  */
 class MessageTemplate extends Generic\DAOEntity {
 
+  /**
+   * @param bool $checkPermissions
+   * @return Action\MessageTemplate\Revert
+   */
+  public static function revert($checkPermissions = TRUE) {
+    return (new Action\MessageTemplate\Revert('MessageTemplate', __FUNCTION__))
+      ->setCheckPermissions($checkPermissions);
+  }
+
 }
diff --git a/tests/phpunit/api/v4/Entity/MessageTemplateTest.php b/tests/phpunit/api/v4/Entity/MessageTemplateTest.php
@@ -143,31 +143,34 @@ public function testMessageTemplateMasterID(): void {
     \CRM_Core_Transaction::create(TRUE)->run(function(\CRM_Core_Transaction $tx) {
       $tx->rollback();
 
-      $messageTemplateID = MessageTemplate::get()
+      MessageTemplate::update(FALSE)
+        ->addWhere('workflow_name', '=', 'contribution_offline_receipt')
+        ->addValue('msg_subject', 'Subject test {if 1 > 2} smarty{/if}')
+        ->addValue('msg_html', '<p>Body test {if 1 > 2} markup{/if}</p>')
+        ->execute();
+
+      $originalTemplate = MessageTemplate::get()
         ->addWhere('is_default', '=', 1)
         ->addWhere('workflow_name', '=', 'contribution_offline_receipt')
-        ->addSelect('id')
-        ->execute()->first()['id'];
-      $messageTemplateIDReserved = MessageTemplate::get()
+        ->addSelect('id', 'msg_subject', 'msg_html', 'master_id', 'master_id.msg_subject')
+        ->execute()->first();
+      $messageTemplateID = $originalTemplate['id'];
+      $reservedTemplate = MessageTemplate::get()
         ->addWhere('is_reserved', '=', 1)
         ->addWhere('workflow_name', '=', 'contribution_offline_receipt')
-        ->addSelect('id')
-        ->execute()->first()['id'];
-      $msgTpl = MessageTemplate::get()
-        ->addSelect('msg_subject', 'master_id', 'master_id.msg_subject')
-        ->addWhere('id', '=', $messageTemplateID)
+        ->addSelect('id', 'msg_subject', 'msg_html')
         ->execute()->first();
-      // confirm subject is set
-      $this->assertNotNull($msgTpl['msg_subject']);
-      // message is unchanged from original so both of these should be null
-      $this->assertNull($msgTpl['master_id']);
-      $this->assertNull($msgTpl['master_id.msg_subject']);
+      $messageTemplateIDReserved = $reservedTemplate['id'];
+
+      $this->assertEquals('Subject test {if 1 > 2} smarty{/if}', $originalTemplate['msg_subject']);
+      $this->assertEquals('<p>Body test {if 1 > 2} markup{/if}</p>', $originalTemplate['msg_html']);
+      $this->assertNull($originalTemplate['master_id']);
+      $this->assertNull($originalTemplate['master_id.msg_subject']);
 
       MessageTemplate::update()
         ->addWhere('id', '=', $messageTemplateID)
         ->setValues([
           'msg_subject' => 'Hello world',
-          'msg_text' => 'Hello world',
           'msg_html' => '<p>Hello world</p>',
         ])
         ->execute();
@@ -176,13 +179,28 @@ public function testMessageTemplateMasterID(): void {
         ->addWhere('id', '=', $messageTemplateID)
         ->execute()->first();
       // confirm subject is set
-      $this->assertNotNull($msgTpl['msg_subject']);
+      $this->assertEquals('Hello world', $msgTpl['msg_subject']);
       // message is changed so both of these should be set
       $this->assertEquals($msgTpl['master_id'], $messageTemplateIDReserved);
       $this->assertNotNull($msgTpl['master_id.msg_subject']);
       // these should be different
       $this->assertNotEquals($msgTpl['msg_subject'], $msgTpl['master_id.msg_subject']);
 
+      // Now revert it
+      MessageTemplate::revert(FALSE)
+        ->addWhere('id', '=', $messageTemplateID)
+        ->execute();
+
+      $msgTpl = MessageTemplate::get()
+        ->addSelect('msg_subject', 'msg_html', 'master_id', 'master_id.msg_subject')
+        ->addWhere('id', '=', $messageTemplateID)
+        ->execute()->first();
+      // confirm subject is reverted
+      $this->assertEquals($originalTemplate['msg_subject'], $msgTpl['msg_subject']);
+      $this->assertEquals($originalTemplate['msg_html'], $msgTpl['msg_html']);
+      // message is unchanged from original so both of these should be null
+      $this->assertNull($msgTpl['master_id']);
+      $this->assertNull($msgTpl['master_id.msg_subject']);
     });
   }