From 0d87c2730cbd5ca90b191851de1ea5ebeb1e6a0b Mon Sep 17 00:00:00 2001
From: Aron Roberts <aron@socrates.berkeley.edu>
Date: Wed, 20 Nov 2013 18:08:34 -0800
Subject: [PATCH] CSPACE-6277: On import, allow dollar sign characters to be
 included in authority item refName display names.

---
 .../import-locationitem-dollarsign.xml        | 16 ++++++
 .../test-data/xmlreplay/imports/imports.xml   | 49 +++++++++++++++++++
 .../import-locationitem-dollarsign.res.xml    | 21 ++++++++
 .../services/imports/TemplateExpander.java    |  3 +-
 4 files changed, 87 insertions(+), 2 deletions(-)
 create mode 100644 services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/import-locationitem-dollarsign.xml
 create mode 100644 services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem-dollarsign.res.xml

diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/import-locationitem-dollarsign.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/import-locationitem-dollarsign.xml
new file mode 100644
index 000000000..1f926ec70
--- /dev/null
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/import-locationitem-dollarsign.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="utf-8"?>
+<imports>
+    <import service="Locations" type="Locationitem" CSID="${recordCSID}">
+        <schema xmlns:locations_common="http://collectionspace.org/services/location" 
+                name="locations_common">
+            <locTermGroupList>
+                <locTermGroup>
+                    <termDisplayName>${termDisplayNameValue}</termDisplayName>
+                </locTermGroup>
+            </locTermGroupList>
+            <shortIdentifier>${shortIdentifierValue}</shortIdentifier>
+            <refName>urn:cspace:core.collectionspace.org:locationauthorities:name(${shortIdentifierValue})'${termDisplayNameValue}'</refName>
+            <inAuthority>${inAuthorityValue}</inAuthority>
+        </schema>
+    </import>
+</imports>
\ No newline at end of file
diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/imports.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/imports.xml
index d242b11f6..5ecea8223 100644
--- a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/imports.xml
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/imports.xml
@@ -328,6 +328,55 @@
             <uri>/cspace-services/locationauthorities/${importLocationAuthorityWithGeneratedRefName.recordCSID}</uri>
         </test>
         
+        <!--
+            Import an authority item record containing a dollar sign character in the display name part of its refName.
+        -->
+        <test ID="importLocationItemWithDollarSignInRefName">
+            <expectedCodes>200</expectedCodes>
+            <method>POST</method>
+            <uri>/cspace-services/imports</uri>
+            <filename>imports/import-locationitem-dollarsign.xml</filename>
+            <vars>
+                <var ID="recordCSID">ec1b0f42-70ef-4ab3-b81e-d73cadbc25f5</var>
+                <var ID="shortIdentifierValue">afistfulofdollars</var>
+                <var ID="inAuthorityValue">${importLocationAuthorityWithVarExpansion.recordCSID}</var>
+                <var ID="termDisplayNameValue">A Fistful of $$$ Dollars</var>
+            </vars>
+            <response>
+                <expected level="TEXT" />
+                <filename>imports/res/import-locationitem-dollarsign.res.xml</filename>
+            </response>
+        </test>
+        <!-- Verify values in the collectionspace_core schema as well as in locations_common -->
+        <test ID="verifyLocationItemWithDollarSignInRefName">
+            <expectedCodes>200</expectedCodes>
+            <method>GET</method>
+            <uri>/cspace-services/locationauthorities/${importLocationAuthorityWithVarExpansion.recordCSID}/items/${importLocationItemWithDollarSignInRefName.recordCSID}</uri>
+            <response>
+                <filename>imports/res/import-locationitem-dollarsign.res.xml</filename>
+                <expected level="ADDOK" />
+                <parts>
+                    <part>
+                        <label>collectionspace_core</label>
+                    </part>
+                    <part>
+                        <label>locations_common</label>
+                    </part>
+                </parts>
+                <vars>
+                    <var ID="shortIdentifierValue">${importLocationItemWithDollarSignInRefName.shortIdentifierValue}</var>
+                    <var ID="inAuthorityValue">${importLocationItemWithDollarSignInRefName.inAuthorityValue}</var>
+                    <var ID="termDisplayNameValue">${importLocationItemWithDollarSignInRefName.termDisplayNameValue}</var>
+                    <var ID="uriValue">/locationauthorities/${importLocationAuthorityWithVarExpansion.recordCSID}/items/${importLocationItemWithDollarSignInRefName.recordCSID}</var>
+                </vars>
+            </response>
+        </test>
+        <test ID="deleteLocationItemWithDollarSignInRefName">
+            <expectedCodes>200</expectedCodes>
+            <method>DELETE</method>
+            <uri>/cspace-services/locationauthorities/${importLocationAuthorityWithVarExpansion.recordCSID}/items/${importLocationItemWithDollarSignInRefName.recordCSID}</uri>
+        </test>
+        
                 
         <!--
             Import a record containing dollar sign and backslash character(s).
diff --git a/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem-dollarsign.res.xml b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem-dollarsign.res.xml
new file mode 100644
index 000000000..5c5e75427
--- /dev/null
+++ b/services/IntegrationTests/src/test/resources/test-data/xmlreplay/imports/res/import-locationitem-dollarsign.res.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<document name="locations">
+    <ns2:locations_common
+        xmlns:ns2="http://collectionspace.org/services/location">
+        <locTermGroupList>
+            <locTermGroup>
+                <termDisplayName>${termDisplayNameValue}</termDisplayName>
+            </locTermGroup>
+        </locTermGroupList>
+        <shortIdentifier>${shortIdentifierValue}</shortIdentifier>
+        <inAuthority>${inAuthorityValue}</inAuthority>
+    </ns2:locations_common>
+    <ns2:collectionspace_core xmlns:ns2="http://collectionspace.org/collectionspace_core/"
+                              xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+        <!-- Note: This test may fail if the identifier for the core tenant changes. -->
+        <tenantId>1</tenantId>
+        <uri>${uriValue}</uri>
+        <refName>urn:cspace:core.collectionspace.org:locationauthorities:name(${shortIdentifierValue})'${termDisplayNameValue}'</refName>
+    </ns2:collectionspace_core>
+</document>
+
diff --git a/services/imports/service/src/main/java/org/collectionspace/services/imports/TemplateExpander.java b/services/imports/service/src/main/java/org/collectionspace/services/imports/TemplateExpander.java
index c3e340590..223cab207 100644
--- a/services/imports/service/src/main/java/org/collectionspace/services/imports/TemplateExpander.java
+++ b/services/imports/service/src/main/java/org/collectionspace/services/imports/TemplateExpander.java
@@ -177,8 +177,7 @@ public class TemplateExpander {
         wrapperTmpl = Tools.searchAndReplace(wrapperTmpl, var("uri"),
                 getDocUri(tenantId, SERVICE_TYPE, docID, partTmpl));
         wrapperTmpl = Tools.searchAndReplace(wrapperTmpl, var("refName"),
-                getRefName(tenantId, SERVICE_TYPE, docID, partTmpl).replace("&", "&amp;"));
-
+                getRefName(tenantId, SERVICE_TYPE, docID, partTmpl).replace("&", "&amp;").replace("$", "&#x0024;"));
 
         String serviceDir = outDir + '/' + docID;
         FileTools.saveFile(serviceDir, "document.xml", wrapperTmpl, FileTools.FORCE_CREATE_PARENT_DIRS);
-- 
2.47.3