Merge remote-tracking branch 'remotes/origin/release/V3.0' into merge-3.1/MNT-20740_BinDuplicationHotFix

rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/content-context.xml

@@ -18,6 +18,7 @@
       <property name="nodeService" ref="nodeService" />
       <property name="behaviourFilter" ref="policyBehaviourFilter" />
       <property name="cleansingEnabled" value="${rm.content.cleansing.enabled}" />
+      <property name="contentBinDuplicationUtility" ref="contentBinDuplicationUtility"/>
    </bean>
 
    <!--  extended eager content store cleaner -->

rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/log4j.properties

@@ -56,4 +56,5 @@ log4j.logger.org.alfresco.module.org_alfresco_module_rm.patch=info
 # Job debug
 #
 #log4j.logger.org.alfresco.module.org_alfresco_module_rm.job=debug
-log4j.logger.org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet=info
+log4j.logger.org.alfresco.repo.web.scripts.roles.DynamicAuthoritiesGet=info
+log4j.logger.org.alfresco.module.org_alfresco_module_rm.query.RecordsManagementQueryDAOImpl=info

rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/module-context.xml

@@ -250,6 +250,8 @@
 
    <bean name="contentBinDuplicationUtility" class="org.alfresco.module.org_alfresco_module_rm.util.ContentBinDuplicationUtility" parent="baseService">
       <property name="behaviourFilter" ref="policyBehaviourFilter"/>
+      <property name="contentService" ref="contentService"/>
+      <property name="recordsManagementQueryDAO" ref="recordsManagementQueryDAO"/>
    </bean>
 
    <!--  Prevent ghosted records being renditioned -->

rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/query/rm-common-SqlMap.xml

@@ -7,6 +7,10 @@
         <parameter property="qnameId" jdbcType="BIGINT" javaType="java.lang.Long"/>
         <parameter property="idValue" jdbcType="BIGINT" javaType="java.lang.String"/>
     </parameterMap>
+
+    <resultMap id="result_NodeIds" type="java.lang.Long">
+        <result property="node.id" column="node_id" jdbcType="BIGINT" javaType="java.lang.Long"/>
+    </resultMap>
     
     <select id="select_CountRMIndentifier" parameterMap="parameter_CountRMIndentifier" resultType="java.lang.Integer">
         select
@@ -35,6 +39,21 @@
 
    </select>
 
+    <!-- Get list of node ids which reference given content url -->
+    <select id="select_NodeIdsWhichReferenceContentUrl"
+            parameterType="ContentUrl"
+            resultMap="result_NodeIds">
+      select
+         p.node_id
+      from
+         alf_content_url cu
+      LEFT OUTER JOIN alf_content_data cd ON (cd.content_url_id = cu.id)
+      LEFT OUTER JOIN alf_node_properties p ON (p.long_value = cd.id)
+      WHERE
+         content_url_short = #{contentUrlShort} and
+         content_url_crc = #{contentUrlCrc}
+
+   </select>
 
 
 </mapper>

rm-community/rm-community-repo/config/alfresco/module/org_alfresco_module_rm/query/rm-common-SqlMapConfig.xml

@@ -2,6 +2,11 @@
 <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd">
 <configuration>
 
+    <typeAliases>
+        <!-- Content -->
+        <typeAlias alias="ContentUrl" type="org.alfresco.repo.domain.contentdata.ContentUrlEntity"/>
+    </typeAliases>
+
     <typeHandlers>
         <typeHandler javaType="java.io.Serializable" handler="org.alfresco.ibatis.SerializableTypeHandler"/>
     </typeHandlers>

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/content/ContentDestructionComponent.java

@@ -33,6 +33,7 @@ import java.util.Set;
 
 import org.alfresco.model.ContentModel;
 import org.alfresco.model.RenditionModel;
+import org.alfresco.module.org_alfresco_module_rm.util.ContentBinDuplicationUtility;
 import org.alfresco.repo.policy.BehaviourFilter;
 import org.alfresco.repo.policy.annotation.BehaviourBean;
 import org.alfresco.service.cmr.dictionary.DictionaryService;
@@ -63,6 +64,9 @@ public class ContentDestructionComponent
     /** behaviour filter */
     private BehaviourFilter behaviourFilter;
 
+    /** Utility class for duplicating content */
+    private ContentBinDuplicationUtility contentBinDuplicationUtility;
+
     /** indicates whether cleansing is enabled or not */
     private boolean cleansingEnabled = false;
 
@@ -138,6 +142,15 @@ public class ContentDestructionComponent
         this.behaviourFilter = behaviourFilter;
     }
 
+    /**
+     * Setter for content duplication utility class
+     * @param contentBinDuplicationUtility ContentBinDuplicationUtility
+     */
+    public void setContentBinDuplicationUtility(ContentBinDuplicationUtility contentBinDuplicationUtility)
+    {
+        this.contentBinDuplicationUtility = contentBinDuplicationUtility;
+    }
+
     /**
      * @param cleansingEnabled  true if cleansing enabled, false otherwise
      */
@@ -214,16 +227,19 @@ public class ContentDestructionComponent
                 // get content data
                 ContentData dataContent = (ContentData)entry.getValue();
 
-                // if enabled cleanse content
+                if (!contentBinDuplicationUtility.hasAtLeastOneOtherReference(nodeRef))
-                if (isCleansingEnabled())
                 {
-                    // register for cleanse then immediate destruction
+                    // if enabled cleanse content
-                    getEagerContentStoreCleaner().registerOrphanedContentUrlForCleansing(dataContent.getContentUrl());
+                    if (isCleansingEnabled())
-                }
+                    {
-                else
+                        // register for cleanse then immediate destruction
-                {
+                        getEagerContentStoreCleaner().registerOrphanedContentUrlForCleansing(dataContent.getContentUrl());
-                    // register for immediate destruction
+                    }
-                    getEagerContentStoreCleaner().registerOrphanedContentUrl(dataContent.getContentUrl(), true);
+                    else
+                    {
+                        // register for immediate destruction
+                        getEagerContentStoreCleaner().registerOrphanedContentUrl(dataContent.getContentUrl(), true);
+                    }
                 }
 
                 // clear the property

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/query/RecordsManagementQueryDAO.java

@@ -61,4 +61,10 @@ public interface RecordsManagementQueryDAO
      * @return list of distinct property values
      */
     public Set<String> getChildrenStringPropertyValues(NodeRef parent, QName property);
+
+    /**
+     * @param contentUrl     the URL of the content url entity
+     * @return Set<NodeRef>  a set of nodes that reference the given content url
+     */
+    Set<NodeRef> getNodeRefsWhichReferenceContentUrl(String contentUrl);
 }

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/query/RecordsManagementQueryDAOImpl.java

@@ -30,17 +30,22 @@ package org.alfresco.module.org_alfresco_module_rm.query;
 import java.util.Collections;
 import java.util.HashMap;
 import java.util.HashSet;
+import java.util.List;
 import java.util.Map;
 import java.util.Set;
 
 import org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel;
+import org.alfresco.repo.domain.contentdata.ContentUrlEntity;
 import org.alfresco.repo.domain.node.NodeDAO;
 import org.alfresco.repo.domain.qname.QNameDAO;
 import org.alfresco.repo.tenant.TenantService;
+import org.alfresco.repo.version.Version2Model;
 import org.alfresco.service.cmr.repository.InvalidNodeRefException;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.namespace.QName;
 import org.alfresco.util.Pair;
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
 import org.mybatis.spring.SqlSessionTemplate;
 
 /**
@@ -51,8 +56,14 @@ import org.mybatis.spring.SqlSessionTemplate;
  */
 public class RecordsManagementQueryDAOImpl implements RecordsManagementQueryDAO, RecordsManagementModel
 {
+    /** logger */
+    @SuppressWarnings ("unused")
+    private static final Log logger = LogFactory.getLog(RecordsManagementQueryDAOImpl.class);
+
+    /** query names */
     private static final String COUNT_IDENTIFIER = "alfresco.query.rm.select_CountRMIndentifier";
     private static final String GET_CHILDREN_PROPERTY_VALUES = "select_GetStringPropertyValuesOfChildren";
+    private static final String SELECT_NODE_IDS_WHICH_REFERENCE_CONTENT_URL = "select_NodeIdsWhichReferenceContentUrl";
 
     /** SQL session template */
     protected SqlSessionTemplate template;
@@ -143,4 +154,90 @@ public class RecordsManagementQueryDAOImpl implements RecordsManagementQueryDAO,
         return new HashSet<>(template.selectList(GET_CHILDREN_PROPERTY_VALUES, queryParams));
 
     }
+
+    /**
+     * Get a set of node reference which reference the provided content URL
+     *
+     * @return Set<NodeRef>	set of nodes that reference the provided content URL
+     * @param    String        contentUrl	content URL
+     */
+    @Override
+    public Set<NodeRef> getNodeRefsWhichReferenceContentUrl(String contentUrl)
+    {
+        if (logger.isDebugEnabled())
+        {
+            logger.debug("Getting nodes that reference content URL = " + contentUrl);
+        }
+
+        // create the content URL entity used to query for nodes
+        ContentUrlEntity contentUrlEntity = new ContentUrlEntity();
+        contentUrlEntity.setContentUrl(contentUrl.toLowerCase());
+
+        if (logger.isDebugEnabled())
+        {
+            logger.debug("Executing query " + SELECT_NODE_IDS_WHICH_REFERENCE_CONTENT_URL);
+        }
+
+        // Get all the node ids which reference the given content url
+        List<Long> nodeIds = template.selectList(SELECT_NODE_IDS_WHICH_REFERENCE_CONTENT_URL, contentUrlEntity);
+
+        if (logger.isDebugEnabled())
+        {
+            logger.debug("Query " + SELECT_NODE_IDS_WHICH_REFERENCE_CONTENT_URL + " returned " + nodeIds.size() + " results");
+        }
+
+        // create a set of uuids which reference the content url
+        Set<NodeRef> nodesReferencingContentUrl = new HashSet<NodeRef>(nodeIds.size());
+        for (Long nodeId : nodeIds)
+        {
+            StringBuilder logMessage = null;
+            NodeRef nodeRefToAdd;
+
+            if (nodeId != null && nodeDAO.exists(nodeId))
+            {
+                if (logger.isDebugEnabled())
+                {
+                    logMessage = new StringBuilder("Adding noderef ");
+                }
+
+                // if the referencing node is a version2Store reference to the content url, add the version 2 frozen node ref
+                NodeRef version2FrozenNodeRef = (NodeRef) nodeDAO.getNodeProperty(nodeId, Version2Model.PROP_QNAME_FROZEN_NODE_REF);
+                if (version2FrozenNodeRef != null && nodeDAO.exists(version2FrozenNodeRef))
+                {
+                    nodeRefToAdd = version2FrozenNodeRef;
+
+                    if (logger.isDebugEnabled())
+                    {
+                        logMessage.append(nodeRefToAdd).append(" (from version)");
+                    }
+                }
+
+                // add the node ref of the referencing node
+                else
+                {
+                    nodeRefToAdd = nodeDAO.getNodeIdStatus(nodeId).getNodeRef();
+                    if (logger.isDebugEnabled())
+                    {
+                        logMessage.append(nodeRefToAdd);
+                    }
+                }
+
+                nodesReferencingContentUrl.add(nodeRefToAdd);
+
+                if (logger.isDebugEnabled())
+                {
+                    logger.debug(logMessage.toString());
+                }
+            }
+            else
+            {
+                if (logger.isDebugEnabled())
+                {
+                    logger.debug("Not adding " + nodeId + " (exist==false)");
+                }
+            }
+        }
+
+        return nodesReferencingContentUrl;
+    }
 }

rm-community/rm-community-repo/source/java/org/alfresco/module/org_alfresco_module_rm/util/ContentBinDuplicationUtility.java

@@ -27,11 +27,15 @@
 package org.alfresco.module.org_alfresco_module_rm.util;
 
 import org.alfresco.model.ContentModel;
+import org.alfresco.module.org_alfresco_module_rm.query.RecordsManagementQueryDAO;
 import org.alfresco.repo.policy.BehaviourFilter;
 import org.alfresco.service.cmr.repository.ContentReader;
+import org.alfresco.service.cmr.repository.ContentService;
 import org.alfresco.service.cmr.repository.ContentWriter;
 import org.alfresco.service.cmr.repository.NodeRef;
 
+import java.util.Set;
+
 /**
  * Utility class to duplicate the content of a node without triggering the audit or versioning behaviours
  * @author Ross Gale
@@ -44,6 +48,14 @@ public class ContentBinDuplicationUtility extends ServiceBaseImpl
      */
     private BehaviourFilter behaviourFilter;
 
+    /**
+     * Provides methods for accessing and transforming content.
+     */
+    private ContentService contentService;
+
+    /** Records Management Query DAO */
+    private RecordsManagementQueryDAO recordsManagementQueryDAO;
+
     /**
      * Setter for behaviour filter
      * @param behaviourFilter BehaviourFilter
@@ -53,6 +65,44 @@ public class ContentBinDuplicationUtility extends ServiceBaseImpl
         this.behaviourFilter = behaviourFilter;
     }
 
+    /**
+     * Setter for content service
+     * @param contentService ContentService
+     */
+    public void setContentService(ContentService contentService)
+    {
+        this.contentService = contentService;
+    }
+
+    /**
+     * Setter for the Records Management QueryDAO
+     *
+     * @param recordsManagementQueryDAO The RM query DAO to set
+     */
+    public void setRecordsManagementQueryDAO(RecordsManagementQueryDAO recordsManagementQueryDAO)
+    {
+        this.recordsManagementQueryDAO = recordsManagementQueryDAO;
+    }
+
+    /**
+     * Determines whether the bin file for a given node has at least one other reference to it
+     * Will return true if the binary exists and is referenced by at least one other node
+     * @param nodeRef Node with the binary in question
+     * @return boolean for if the bin has at least one other reference to it
+     */
+    public boolean hasAtLeastOneOtherReference(NodeRef nodeRef)
+    {
+        boolean hasAtLeastOneOtherReference = false;
+        String contentUrl = contentService.getReader(nodeRef, ContentModel.PROP_CONTENT).getContentUrl();
+
+        Set<NodeRef> referencesToContentNode = recordsManagementQueryDAO.getNodeRefsWhichReferenceContentUrl(contentUrl);
+        if (referencesToContentNode.size() > 1)
+        {
+            hasAtLeastOneOtherReference = true;
+        }
+        return hasAtLeastOneOtherReference;
+    }
+
     /**
      * Duplicate the content of a node without triggering the audit or versioning behaviours
      *

rm-community/rm-community-repo/unit-test/java/org/alfresco/module/org_alfresco_module_rm/util/ContentBinDuplicationUtilityUnitTest.java

@@ -28,11 +28,18 @@
 package org.alfresco.module.org_alfresco_module_rm.util;
 
 import static org.alfresco.module.org_alfresco_module_rm.model.RecordsManagementModel.ASPECT_ARCHIVED;
+import static org.junit.Assert.assertFalse;
+import static org.junit.Assert.assertTrue;
 import static org.mockito.Mockito.times;
 import static org.mockito.Mockito.verify;
 import static org.mockito.Mockito.when;
 
+import java.util.Collections;
+import java.util.HashSet;
+import java.util.Set;
+
 import org.alfresco.model.ContentModel;
+import org.alfresco.module.org_alfresco_module_rm.query.RecordsManagementQueryDAO;
 import org.alfresco.repo.policy.BehaviourFilter;
 import org.alfresco.service.cmr.repository.ContentReader;
 import org.alfresco.service.cmr.repository.ContentService;
@@ -52,6 +59,9 @@ import org.mockito.MockitoAnnotations;
  */
 public class ContentBinDuplicationUtilityUnitTest
 {
+    private final static NodeRef NODE_REF = new NodeRef("some://test/noderef");
+    private final static NodeRef NODE_REF2 = new NodeRef("some://test/anothernoderef");
+    private final static String CONTENT_URL = "someContentUrl";
 
     @Mock
     private ContentService mockContentService;
@@ -67,6 +77,9 @@ public class ContentBinDuplicationUtilityUnitTest
     @Mock
     private NodeService mockNodeService;
 
+    @Mock
+    private RecordsManagementQueryDAO recordsManagementQueryDAO;
+
     @InjectMocks
     private ContentBinDuplicationUtility contentBinDuplicationUtility;
 
@@ -82,10 +95,9 @@ public class ContentBinDuplicationUtilityUnitTest
     @Test
     public void testContentUrlIsUpdated()
     {
-        NodeRef nodeRef = new NodeRef("some://test/noderef");
+        when(mockContentService.getReader(NODE_REF, ContentModel.PROP_CONTENT)).thenReturn(mockContentReader);
-        when(mockContentService.getReader(nodeRef, ContentModel.PROP_CONTENT)).thenReturn(mockContentReader);
+        when(mockContentService.getWriter(NODE_REF, ContentModel.PROP_CONTENT, true)).thenReturn(mockContentWriter);
-        when(mockContentService.getWriter(nodeRef, ContentModel.PROP_CONTENT, true)).thenReturn(mockContentWriter);
+        contentBinDuplicationUtility.duplicate(NODE_REF);
-        contentBinDuplicationUtility.duplicate(nodeRef);
         verify(mockContentWriter, times(1)).putContent(mockContentReader);
         checkBehaviours(1);
     }
@@ -96,9 +108,8 @@ public class ContentBinDuplicationUtilityUnitTest
     @Test
     public void testDuplicationDoesntHappenWithNoContent()
     {
-        NodeRef nodeRef = new NodeRef("some://test/noderef");
+        when(mockContentService.getReader(NODE_REF, ContentModel.PROP_CONTENT)).thenReturn(null);
-        when(mockContentService.getReader(nodeRef, ContentModel.PROP_CONTENT)).thenReturn(null);
+        contentBinDuplicationUtility.duplicate(NODE_REF);
-        contentBinDuplicationUtility.duplicate(nodeRef);
         verify(mockContentWriter, times(0)).putContent(mockContentReader);
         checkBehaviours(1);
     }
@@ -118,6 +129,52 @@ public class ContentBinDuplicationUtilityUnitTest
         verify(mockContentReader, times(0)).getReader();
         checkBehaviours(0);
     }
+    /**
+     * Test hasAtLeastOneOtherReference returns true when node has another reference to it
+     */
+    @Test
+    public void testHasAtLeastOneOtherReference()
+    {
+        Set<NodeRef> multipleReferences = new HashSet<>();
+        Collections.addAll(multipleReferences, NODE_REF, NODE_REF2);
+
+        when(mockContentService.getReader(NODE_REF, ContentModel.PROP_CONTENT)).thenReturn(mockContentReader);
+        when(mockContentService.getReader(NODE_REF, ContentModel.PROP_CONTENT).getContentUrl()).thenReturn(CONTENT_URL);
+        when(recordsManagementQueryDAO.getNodeRefsWhichReferenceContentUrl(CONTENT_URL)).thenReturn(multipleReferences);
+
+        assertTrue(contentBinDuplicationUtility.hasAtLeastOneOtherReference(NODE_REF));
+    }
+
+    /**
+     * Test hasAtLeastOneOtherReference returns false when node has no other reference to it other than its own content ref
+     */
+    @Test
+    public void testHasNoOtherReference()
+    {
+        Set<NodeRef> singleReference = Collections.singleton(NODE_REF);
+
+        when(mockContentService.getReader(NODE_REF, ContentModel.PROP_CONTENT)).thenReturn(mockContentReader);
+        when(mockContentService.getReader(NODE_REF, ContentModel.PROP_CONTENT).getContentUrl()).thenReturn(CONTENT_URL);
+        when(recordsManagementQueryDAO.getNodeRefsWhichReferenceContentUrl(CONTENT_URL)).thenReturn(singleReference);
+
+        assertFalse(contentBinDuplicationUtility.hasAtLeastOneOtherReference(NODE_REF));
+    }
+
+    /**
+     * Test hasAtLeastOneOtherReference returns false when node has no references to it at all
+     */
+    @Test
+    public void testHasNoReferences()
+    {
+        Set<NodeRef> noReferences = Collections.<NodeRef> emptySet();
+
+        when(mockContentService.getReader(NODE_REF, ContentModel.PROP_CONTENT)).thenReturn(mockContentReader);
+        when(mockContentService.getReader(NODE_REF, ContentModel.PROP_CONTENT).getContentUrl()).thenReturn(CONTENT_URL);
+        when(recordsManagementQueryDAO.getNodeRefsWhichReferenceContentUrl(CONTENT_URL)).thenReturn(noReferences);
+
+        assertFalse(contentBinDuplicationUtility.hasAtLeastOneOtherReference(NODE_REF));
+    }
+
     /**
      * Check that the behaviours are disabled and re-enabled the correct number of times
      * @param times the times the behaviours should be called