From 005faacf20b0a61b45f108b0f88ba44eb823602a Mon Sep 17 00:00:00 2001
From: Tim Otten <totten@civicrm.org>
Date: Tue, 30 Nov 2021 14:26:23 -0800
Subject: [PATCH] mixin/case-xml - Import

---
 .../example/tests/mixin/CaseTypeTest.php      | 46 ++++++++++++
 .../case-xml@1/example/xml/case/DuckDance.xml | 73 +++++++++++++++++++
 mixin/case-xml@1/mixin.php                    | 41 +++++++++++
 3 files changed, 160 insertions(+)
 create mode 100644 mixin/case-xml@1/example/tests/mixin/CaseTypeTest.php
 create mode 100644 mixin/case-xml@1/example/xml/case/DuckDance.xml
 create mode 100644 mixin/case-xml@1/mixin.php

diff --git a/mixin/case-xml@1/example/tests/mixin/CaseTypeTest.php b/mixin/case-xml@1/example/tests/mixin/CaseTypeTest.php
new file mode 100644
index 0000000000..326a083c9b
--- /dev/null
+++ b/mixin/case-xml@1/example/tests/mixin/CaseTypeTest.php
@@ -0,0 +1,46 @@
+<?php
+
+namespace Civi\Shimmy\Mixins;
+
+/**
+ * Assert that the case-type XML mixin is working properly.
+ *
+ * This class defines the assertions to run when installing or uninstalling the extension.
+ * It use called as part of E2E_Shimmy_LifecycleTest.
+ *
+ * @see E2E_Shimmy_LifecycleTest
+ */
+class CaseTypeTest extends \PHPUnit\Framework\Assert {
+
+  public function testPreConditions($cv) {
+    $this->assertFileExists(static::getPath('/xml/case/DuckDance.xml'), 'The shimmy extension must have a Case XML file.');
+  }
+
+  public function testInstalled($cv) {
+    $items = $cv->api4('CaseType', 'get', ['where' => [['name', '=', 'DuckDance']]]);
+    $this->assertEquals('The mysterious case of the dancing duck', $items[0]['description']);
+    $this->assertEquals('DuckDance', $items[0]['name']);
+    $this->assertEquals('Duck Dance Case', $items[0]['title']);
+    $this->assertEquals(TRUE, $items[0]['is_active']);
+    $this->assertEquals(1, count($items));
+  }
+
+  public function testDisabled($cv) {
+    $items = $cv->api4('CaseType', 'get', ['where' => [['name', '=', 'DuckDance']]]);
+    $this->assertEquals('The mysterious case of the dancing duck', $items[0]['description']);
+    $this->assertEquals('DuckDance', $items[0]['name']);
+    $this->assertEquals('Duck Dance Case', $items[0]['title']);
+    $this->assertEquals(FALSE, $items[0]['is_active']);
+    $this->assertEquals(1, count($items));
+  }
+
+  public function testUninstalled($cv) {
+    $items = $cv->api4('CaseType', 'get', ['where' => [['name', '=', 'DuckDance']]]);
+    $this->assertEquals(0, count($items));
+  }
+
+  protected static function getPath($suffix = ''): string {
+    return dirname(__DIR__, 2) . $suffix;
+  }
+
+}
diff --git a/mixin/case-xml@1/example/xml/case/DuckDance.xml b/mixin/case-xml@1/example/xml/case/DuckDance.xml
new file mode 100644
index 0000000000..7bbf178371
--- /dev/null
+++ b/mixin/case-xml@1/example/xml/case/DuckDance.xml
@@ -0,0 +1,73 @@
+<?xml version="1.0" encoding="iso-8859-1" ?><CaseType>
+  <name>Duck Dance Case</name>
+  <description>The mysterious case of the dancing duck</description>
+
+  <ActivityTypes>
+
+    <!-- Standard case-management activities -->
+    <ActivityType>
+      <name>Open Case</name>
+      <max_instances>1</max_instances>
+    </ActivityType>
+    <ActivityType>
+      <name>Follow up</name>
+    </ActivityType>
+    <ActivityType>
+      <name>Change Case Type</name>
+    </ActivityType>
+    <ActivityType>
+      <name>Change Case Status</name>
+    </ActivityType>
+    <ActivityType>
+      <name>Change Case Start Date</name>
+    </ActivityType>
+    <ActivityType>
+      <name>Link Cases</name>
+    </ActivityType>
+
+    <!-- Configurable activities -->
+    <ActivityType>
+      <name>Email</name>
+    </ActivityType>
+    <ActivityType>
+      <name>Meeting</name>
+    </ActivityType>
+    <ActivityType>
+      <name>Phone Call</name>
+    </ActivityType>
+
+  </ActivityTypes>
+
+  <ActivitySets>
+    <ActivitySet>
+      <name>standard_timeline</name>
+      <label>Standard Timeline</label>
+      <timeline>true</timeline>
+      <ActivityTypes>
+        <ActivityType>
+          <name>Open Case</name>
+          <status>Completed</status>
+        </ActivityType>
+        <ActivityType>
+          <name>Phone Call</name>
+          <reference_offset>1</reference_offset>
+          <reference_select>newest</reference_select>
+        </ActivityType>
+        <ActivityType>
+          <name>Follow up</name>
+          <reference_offset>7</reference_offset>
+          <reference_select>newest</reference_select>
+        </ActivityType>
+      </ActivityTypes>
+    </ActivitySet>
+  </ActivitySets>
+
+  <CaseRoles>
+    <RelationshipType>
+      <name>Case Coordinator</name>
+      <creator>1</creator>
+      <manager>1</manager>
+    </RelationshipType>
+  </CaseRoles>
+
+</CaseType>
diff --git a/mixin/case-xml@1/mixin.php b/mixin/case-xml@1/mixin.php
new file mode 100644
index 0000000000..649c51e3c6
--- /dev/null
+++ b/mixin/case-xml@1/mixin.php
@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * Auto-register "xml/case/*.xml" files.
+ *
+ * @mixinName case-xml
+ * @mixinVersion 1.0.0
+ *
+ * @param CRM_Extension_MixInfo $mixInfo
+ *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
+ * @param \CRM_Extension_BootCache $bootCache
+ *   On newer deployments, this will be an instance of MixInfo. On older deployments, Civix may polyfill with a work-a-like.
+ */
+return function ($mixInfo, $bootCache) {
+
+  /**
+   * @param \Civi\Core\Event\GenericHookEvent $e
+   * @see CRM_Utils_Hook::caseTypes()
+   */
+  Civi::dispatcher()->addListener('hook_civicrm_caseTypes', function ($e) use ($mixInfo) {
+    // When deactivating on a polyfill/pre-mixin system, listeners may not cleanup automatically.
+
+    if (!$mixInfo->isActive() || !is_dir($mixInfo->getPath('xml/case'))) {
+      return;
+    }
+
+    foreach ((array) glob($mixInfo->getPath('xml/case/*.xml')) as $file) {
+      $name = preg_replace('/\.xml$/', '', basename($file));
+      if ($name != CRM_Case_XMLProcessor::mungeCaseType($name)) {
+        $errorMessage = sprintf("Case-type file name is malformed (%s vs %s)", $name, CRM_Case_XMLProcessor::mungeCaseType($name));
+        throw new CRM_Core_Exception($errorMessage);
+      }
+      $e->caseTypes[$name] = [
+        'module' => $mixInfo->longName,
+        'name' => $name,
+        'file' => $file,
+      ];
+    }
+  });
+
+};
-- 
2.25.1