Merge pull request #3696 from davecivicrm/CRM-15002

[civicrm-core.git] / CRM / Case / XMLRepository.php

diff --git a/CRM/Case/XMLRepository.php b/CRM/Case/XMLRepository.php
index 698393eb569bed467b366c9a62f7eb0ca742369c..5193f468c6ea024a317c58006e90ceec38333478 100644 (file)
--- a/CRM/Case/XMLRepository.php
+++ b/CRM/Case/XMLRepository.php
@@ -77,15 +77,58 @@ class CRM_Case_XMLRepository {
    * @return SimpleXMLElement|FALSE
    */
   public function retrieve($caseType) {
-    $caseType = CRM_Case_XMLProcessor::mungeCaseType($caseType);
+    // check if xml definition is defined in db
+    $definition = CRM_Core_DAO::getFieldValue('CRM_Case_DAO_CaseType', $caseType, 'definition', 'name');
+
+    if (!empty($definition)) {
+      return simplexml_load_string($definition);
+    }
+
+    if (!CRM_Case_BAO_CaseType::isValidName($caseType)) {
+      // perhaps caller provider a the label instead of the name?
+      throw new CRM_Core_Exception("Cannot load caseType with malformed name [$caseType]");
+    }
 
     if (!CRM_Utils_Array::value($caseType, $this->xml)) {
-      // first check custom templates directory
-      $fileName = NULL;
+      // Search for a file based directly on the $caseType name
+      $fileName = $this->findXmlFile($caseType);
+
+      // For backward compatibility, also search for double-mungd file names
+      // TODO In 4.6 or 5.0, remove support for loading double-munged file names
+      if (!$fileName || !file_exists($fileName)) {
+        $fileName = $this->findXmlFile(CRM_Case_XMLProcessor::mungeCaseType($caseType));
+      }
+
+      if (!$fileName || !file_exists($fileName)) {
+        return FALSE;
+      }
+
+      // read xml file
+      $dom = new DomDocument();
+      $dom->load($fileName);
+      $dom->xinclude();
+      $this->xml[$caseType] = simplexml_import_dom($dom);
+    }
+    return $this->xml[$caseType];
+  }
+
+  /**
+   * @param string $caseType
+   * @return null|string file path
+   */
+  public function findXmlFile($caseType) { // first check custom templates directory
+    $fileName = NULL;
+
+    if (!$fileName || !file_exists($fileName)) {
+      $caseTypesViaHook = $this->getCaseTypesViaHook();
+      if (isset($caseTypesViaHook[$caseType], $caseTypesViaHook[$caseType]['file'])) {
+        $fileName = $caseTypesViaHook[$caseType]['file'];
+      }
+    }
+
+    if (!$fileName || !file_exists($fileName)) {
       $config = CRM_Core_Config::singleton();
-      if (isset($config->customTemplateDir) &&
-        $config->customTemplateDir
-      ) {
+      if (isset($config->customTemplateDir) && $config->customTemplateDir) {
         // check if the file exists in the custom templates directory
         $fileName = implode(DIRECTORY_SEPARATOR,
           array(
@@ -98,10 +141,10 @@ class CRM_Case_XMLRepository {
           )
         );
       }
+    }
 
-      if (!$fileName ||
-        !file_exists($fileName)
-      ) {
+    if (!$fileName || !file_exists($fileName)) {
+      if (!file_exists($fileName)) {
         // check if file exists locally
         $fileName = implode(DIRECTORY_SEPARATOR,
           array(
@@ -111,38 +154,21 @@ class CRM_Case_XMLRepository {
             "$caseType.xml",
           )
         );
-
-        if (!file_exists($fileName)) {
-          // check if file exists locally
-          $fileName = implode(DIRECTORY_SEPARATOR,
-            array(
-              dirname(__FILE__),
-              'xml',
-              'configuration.sample',
-              "$caseType.xml",
-            )
-          );
-        }
-
-        if (!file_exists($fileName)) {
-          $caseTypesViaHook = $this->getCaseTypesViaHook();
-          if (isset($caseTypesViaHook[$caseType], $caseTypesViaHook[$caseType]['file'])) {
-            $fileName = $caseTypesViaHook[$caseType]['file'];
-          }
-        }
-
-        if (!file_exists($fileName)) {
-          return FALSE;
-        }
       }
 
-      // read xml file
-      $dom = new DomDocument();
-      $dom->load($fileName);
-      $dom->xinclude();
-      $this->xml[$caseType] = simplexml_import_dom($dom);
+      if (!file_exists($fileName)) {
+        // check if file exists locally
+        $fileName = implode(DIRECTORY_SEPARATOR,
+          array(
+            dirname(__FILE__),
+            'xml',
+            'configuration.sample',
+            "$caseType.xml",
+          )
+        );
+      }
     }
-    return $this->xml[$caseType];
+    return file_exists($fileName) ? $fileName : NULL;
   }
 
   /**