mirror of
				https://github.com/Alfresco/alfresco-community-repo.git
				synced 2025-10-29 15:21:53 +00:00 
			
		
		
		
	Compare commits
	
		
			71 Commits
		
	
	
		
			17.169
			...
			APPS-1821-
		
	
	| Author | SHA1 | Date | |
|---|---|---|---|
| 
						 | 
					06871bce8a | ||
| 
						 | 
					58e595ce13 | ||
| 
						 | 
					333a7dca98 | ||
| 
						 | 
					0c810f5e80 | ||
| 
						 | 
					4d930a6f18 | ||
| 
						 | 
					ff68f92455 | ||
| 
						 | 
					c88353ccb7 | ||
| 
						 | 
					6b94ee41d4 | ||
| 
						 | 
					a414aa3064 | ||
| 
						 | 
					7914e87f77 | ||
| 
						 | 
					4f63b3871e | ||
| 
						 | 
					876962db57 | ||
| 
						 | 
					5e2ff120ae | ||
| 
						 | 
					2d95ccc754 | ||
| 
						 | 
					3de741a78e | ||
| 
						 | 
					8993ec9d5c | ||
| 
						 | 
					428a82c195 | ||
| 
						 | 
					519ef19c83 | ||
| 
						 | 
					f19849b547 | ||
| 
						 | 
					d956a4f4aa | ||
| 
						 | 
					71f649d1bd | ||
| 
						 | 
					55faedde51 | ||
| 
						 | 
					32a524eb1f | ||
| 
						 | 
					105702bf09 | ||
| 
						 | 
					9e2e00c4a8 | ||
| 
						 | 
					e79eac4fd8 | ||
| 
						 | 
					20f9cfc42d | ||
| 
						 | 
					5baee04dcc | ||
| 
						 | 
					f821756021 | ||
| 
						 | 
					ae68b517f1 | ||
| 
						 | 
					24b249d93d | ||
| 
						 | 
					5d9b11d121 | ||
| 
						 | 
					902f3b5275 | ||
| 
						 | 
					3801ed4d99 | ||
| 
						 | 
					382a4799ae | ||
| 
						 | 
					67c44a934d | ||
| 
						 | 
					35a364beaa | ||
| 
						 | 
					68ed04cc6d | ||
| 
						 | 
					dc52bc107d | ||
| 
						 | 
					ff110af9b3 | ||
| 
						 | 
					87b2e0f060 | ||
| 
						 | 
					fd9d47826e | ||
| 
						 | 
					6e31f713f0 | ||
| 
						 | 
					7a70b40cc0 | ||
| 
						 | 
					96c437e6a4 | ||
| 
						 | 
					6e4a7c1866 | ||
| 
						 | 
					b72cf6f267 | ||
| 
						 | 
					f65fc31601 | ||
| 
						 | 
					4697e7bac2 | ||
| 
						 | 
					50455c8730 | ||
| 
						 | 
					2fac4d8a9b | ||
| 
						 | 
					7a300dc9c9 | ||
| 
						 | 
					a996cf1842 | ||
| 
						 | 
					1d9d6ad0bb | ||
| 
						 | 
					8ba67497e1 | ||
| 
						 | 
					fd889628c6 | ||
| 
						 | 
					50b9f5c612 | ||
| 
						 | 
					e6bdd5738c | ||
| 
						 | 
					4bf29ca69c | ||
| 
						 | 
					f4f5fd4182 | ||
| 
						 | 
					dfb6f50056 | ||
| 
						 | 
					c7227d19c4 | ||
| 
						 | 
					9b779facd9 | ||
| 
						 | 
					f64d0a1b59 | ||
| 
						 | 
					8974845671 | ||
| 
						 | 
					a7ae83bbee | ||
| 
						 | 
					ee1ac25bf6 | ||
| 
						 | 
					8757f0ff2b | ||
| 
						 | 
					37f5b637dd | ||
| 
						 | 
					b369538a61 | ||
| 
						 | 
					1f844ce199 | 
@@ -7,7 +7,7 @@
 | 
			
		||||
   <parent>
 | 
			
		||||
      <groupId>org.alfresco</groupId>
 | 
			
		||||
      <artifactId>alfresco-community-repo-amps</artifactId>
 | 
			
		||||
      <version>17.169</version>
 | 
			
		||||
      <version>18.8-SNAPSHOT</version>
 | 
			
		||||
   </parent>
 | 
			
		||||
 | 
			
		||||
   <modules>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
   <parent>
 | 
			
		||||
      <groupId>org.alfresco</groupId>
 | 
			
		||||
      <artifactId>alfresco-governance-services-community-parent</artifactId>
 | 
			
		||||
      <version>17.169</version>
 | 
			
		||||
      <version>18.8-SNAPSHOT</version>
 | 
			
		||||
   </parent>
 | 
			
		||||
 | 
			
		||||
   <modules>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
   <parent>
 | 
			
		||||
      <groupId>org.alfresco</groupId>
 | 
			
		||||
      <artifactId>alfresco-governance-services-automation-community-repo</artifactId>
 | 
			
		||||
      <version>17.169</version>
 | 
			
		||||
      <version>18.8-SNAPSHOT</version>
 | 
			
		||||
   </parent>
 | 
			
		||||
 | 
			
		||||
   <build>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
   <parent>
 | 
			
		||||
      <groupId>org.alfresco</groupId>
 | 
			
		||||
      <artifactId>alfresco-governance-services-community-parent</artifactId>
 | 
			
		||||
      <version>17.169</version>
 | 
			
		||||
      <version>18.8-SNAPSHOT</version>
 | 
			
		||||
   </parent>
 | 
			
		||||
 | 
			
		||||
   <modules>
 | 
			
		||||
 
 | 
			
		||||
@@ -1,3 +1,3 @@
 | 
			
		||||
SOLR6_TAG=2.0.5-A2
 | 
			
		||||
SOLR6_TAG=2.0.5
 | 
			
		||||
POSTGRES_TAG=14.4
 | 
			
		||||
ACTIVEMQ_TAG=5.17.1-jre11-rockylinux8
 | 
			
		||||
 
 | 
			
		||||
@@ -8,7 +8,7 @@
 | 
			
		||||
   <parent>
 | 
			
		||||
      <groupId>org.alfresco</groupId>
 | 
			
		||||
      <artifactId>alfresco-governance-services-community-repo-parent</artifactId>
 | 
			
		||||
      <version>17.169</version>
 | 
			
		||||
      <version>18.8-SNAPSHOT</version>
 | 
			
		||||
   </parent>
 | 
			
		||||
 | 
			
		||||
   <properties>
 | 
			
		||||
 
 | 
			
		||||
@@ -5,7 +5,7 @@
 | 
			
		||||
# Version label
 | 
			
		||||
version.major=7
 | 
			
		||||
version.minor=3
 | 
			
		||||
version.revision=0
 | 
			
		||||
version.revision=1
 | 
			
		||||
version.label=
 | 
			
		||||
 | 
			
		||||
# Edition label
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-governance-services-community-repo-parent</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <build>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <modules>
 | 
			
		||||
 
 | 
			
		||||
@@ -8,7 +8,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-amps</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <properties>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
   <parent>
 | 
			
		||||
      <groupId>org.alfresco</groupId>
 | 
			
		||||
      <artifactId>alfresco-community-repo</artifactId>
 | 
			
		||||
      <version>17.169</version>
 | 
			
		||||
      <version>18.8-SNAPSHOT</version>
 | 
			
		||||
   </parent>
 | 
			
		||||
 | 
			
		||||
   <dependencies>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <properties>
 | 
			
		||||
 
 | 
			
		||||
@@ -346,7 +346,7 @@ public class FTSQueryParser
 | 
			
		||||
            }
 | 
			
		||||
            constraints.add(constraint);
 | 
			
		||||
        }
 | 
			
		||||
        if (constraints.size() == 1)
 | 
			
		||||
        if (constraints.size() == 1 && Occur.EXCLUDE != constraints.get(0).getOccur())
 | 
			
		||||
        {
 | 
			
		||||
            return constraints.get(0);
 | 
			
		||||
        }
 | 
			
		||||
 
 | 
			
		||||
@@ -69,20 +69,21 @@ public class LuceneDisjunction<Q, S, E extends Throwable> extends BaseDisjunctio
 | 
			
		||||
                @SuppressWarnings("unchecked")
 | 
			
		||||
                LuceneQueryBuilderComponent<Q, S, E> luceneQueryBuilderComponent = (LuceneQueryBuilderComponent<Q, S, E>) constraint;
 | 
			
		||||
                Q constraintQuery = luceneQueryBuilderComponent.addComponent(selectors, functionArgs, luceneContext, functionContext);
 | 
			
		||||
                queriestoDisjoin.add(new Pair<>(constraint, constraintQuery));
 | 
			
		||||
                queriestoDisjoin.add(new Pair<Constraint, Q>(constraint, constraintQuery));
 | 
			
		||||
                if (constraintQuery != null)
 | 
			
		||||
                {
 | 
			
		||||
                    switch (constraint.getOccur())
 | 
			
		||||
                    {
 | 
			
		||||
                    case DEFAULT:
 | 
			
		||||
                    case MANDATORY:
 | 
			
		||||
                    case OPTIONAL:
 | 
			
		||||
                        expressionBuilder.addOptional(constraintQuery, constraint.getBoost());
 | 
			
		||||
                        break;
 | 
			
		||||
                    case MANDATORY:
 | 
			
		||||
                        expressionBuilder.addRequired(constraintQuery, constraint.getBoost());
 | 
			
		||||
                        break;
 | 
			
		||||
                    case EXCLUDE:
 | 
			
		||||
                        expressionBuilder.addExcluded(constraintQuery,  constraint.getBoost());
 | 
			
		||||
                        QueryParserExpressionAdaptor<Q, E> subExpressionBuilder = luceneContext.getLuceneQueryParserAdaptor().getExpressionAdaptor();
 | 
			
		||||
                        subExpressionBuilder.addRequired(luceneContext.getLuceneQueryParserAdaptor().getMatchAllNodesQuery());
 | 
			
		||||
                        subExpressionBuilder.addExcluded(constraintQuery);
 | 
			
		||||
                        expressionBuilder.addOptional(subExpressionBuilder.getQuery(),  constraint.getBoost());
 | 
			
		||||
                        break;
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <dependencies>
 | 
			
		||||
 
 | 
			
		||||
@@ -9,6 +9,6 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-packaging</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
</project>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-packaging</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <properties>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <modules>
 | 
			
		||||
 
 | 
			
		||||
@@ -1,3 +1,3 @@
 | 
			
		||||
SOLR6_TAG=2.0.5-A2
 | 
			
		||||
SOLR6_TAG=2.0.5
 | 
			
		||||
POSTGRES_TAG=14.4
 | 
			
		||||
ACTIVEMQ_TAG=5.17.1-jre11-rockylinux8
 | 
			
		||||
 
 | 
			
		||||
@@ -6,7 +6,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-packaging</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <modules>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-tests</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <organization>
 | 
			
		||||
 
 | 
			
		||||
@@ -9,7 +9,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-tests</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <developers>
 | 
			
		||||
 
 | 
			
		||||
@@ -9,7 +9,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-tests</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <developers>
 | 
			
		||||
 
 | 
			
		||||
@@ -9,7 +9,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-tests</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <developers>
 | 
			
		||||
 
 | 
			
		||||
@@ -28,16 +28,23 @@ package org.alfresco.rest.rules;
 | 
			
		||||
import static java.util.stream.Collectors.toList;
 | 
			
		||||
 | 
			
		||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.ERROR_MESSAGE_ACCESS_RESTRICTED;
 | 
			
		||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.MAIL_ACTION;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.CHECKIN_ACTION;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.COPY_ACTION;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.ID;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.INVERTED;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.IS_SHARED;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.RULE_NAME_DEFAULT;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.RULE_SCRIPT_PARAM_ID;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.SCRIPT_ACTION;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.TEMPLATE_PARAM;
 | 
			
		||||
import static org.alfresco.utility.constants.UserRole.SiteCollaborator;
 | 
			
		||||
import static org.alfresco.utility.constants.UserRole.SiteConsumer;
 | 
			
		||||
import static org.alfresco.utility.constants.UserRole.SiteContributor;
 | 
			
		||||
import static org.alfresco.utility.constants.UserRole.SiteManager;
 | 
			
		||||
import static org.alfresco.utility.model.FileModel.getRandomFileModel;
 | 
			
		||||
import static org.alfresco.utility.model.FileType.TEXT_PLAIN;
 | 
			
		||||
import static org.alfresco.utility.model.UserModel.getRandomUserModel;
 | 
			
		||||
import static org.alfresco.utility.report.log.Step.STEP;
 | 
			
		||||
import static org.junit.Assert.assertEquals;
 | 
			
		||||
import static org.springframework.http.HttpStatus.BAD_REQUEST;
 | 
			
		||||
@@ -45,21 +52,30 @@ import static org.springframework.http.HttpStatus.CREATED;
 | 
			
		||||
import static org.springframework.http.HttpStatus.FORBIDDEN;
 | 
			
		||||
import static org.springframework.http.HttpStatus.NOT_FOUND;
 | 
			
		||||
 | 
			
		||||
import java.io.Serializable;
 | 
			
		||||
import java.util.Collections;
 | 
			
		||||
import java.util.HashMap;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.stream.IntStream;
 | 
			
		||||
 | 
			
		||||
import javax.json.Json;
 | 
			
		||||
import javax.json.JsonObject;
 | 
			
		||||
 | 
			
		||||
import org.alfresco.rest.RestTest;
 | 
			
		||||
import org.alfresco.rest.model.RestActionBodyExecTemplateModel;
 | 
			
		||||
import org.alfresco.rest.model.RestActionConstraintModel;
 | 
			
		||||
import org.alfresco.rest.model.RestCompositeConditionDefinitionModel;
 | 
			
		||||
import org.alfresco.rest.model.RestRuleModel;
 | 
			
		||||
import org.alfresco.rest.model.RestRuleModelsCollection;
 | 
			
		||||
import org.alfresco.utility.constants.UserRole;
 | 
			
		||||
import org.alfresco.utility.model.ContentModel;
 | 
			
		||||
import org.alfresco.utility.model.FileModel;
 | 
			
		||||
import org.alfresco.utility.model.FolderModel;
 | 
			
		||||
import org.alfresco.utility.model.SiteModel;
 | 
			
		||||
import org.alfresco.utility.model.TestGroup;
 | 
			
		||||
import org.alfresco.utility.model.UserModel;
 | 
			
		||||
import org.apache.chemistry.opencmis.client.api.CmisObject;
 | 
			
		||||
import org.testng.annotations.BeforeClass;
 | 
			
		||||
import org.testng.annotations.Test;
 | 
			
		||||
 | 
			
		||||
@@ -160,6 +176,7 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that a user without permission to view the folder cannot create a rule in it. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void requireReadPermissionToCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Create a user and use them to create a private site containing a folder");
 | 
			
		||||
@@ -177,7 +194,8 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        restClient.assertLastError().containsSummary("Insufficient permissions to manage rules");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that a Collaborator cannot create a rule in a private folder. */
 | 
			
		||||
    /** Check that a Collaborator cannot create a rule in a folder in a private site. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void siteCollaboratorCannotCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        testRolePermissionsWith(SiteCollaborator);
 | 
			
		||||
@@ -187,6 +205,7 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that a Contributor cannot create a rule in a private folder. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void siteContributorCannotCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        testRolePermissionsWith(SiteContributor);
 | 
			
		||||
@@ -195,7 +214,8 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        restClient.assertLastError().containsSummary("Insufficient permissions to manage rules");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that a Consumer cannot create a rule in a private folder. */
 | 
			
		||||
    /** Check that a Consumer cannot create a rule in a folder in a private site. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void siteConsumerCannotCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        testRolePermissionsWith(SiteConsumer);
 | 
			
		||||
@@ -204,7 +224,8 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        restClient.assertLastError().containsSummary("Insufficient permissions to manage rules");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that a siteManager can create a rule in a private folder. */
 | 
			
		||||
    /** Check that a siteManager can create a rule in a folder in a private site. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void siteManagerCanCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        testRolePermissionsWith(SiteManager)
 | 
			
		||||
@@ -345,7 +366,7 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        rule.assertThat().field("isShared").isNotNull();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public RestRuleModel testRolePermissionsWith(UserRole userRole)
 | 
			
		||||
    private RestRuleModel testRolePermissionsWith(UserRole userRole)
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Create a user and use them to create a private site containing a folder");
 | 
			
		||||
        SiteModel privateSite = dataSite.usingUser(user).createPrivateRandomSite();
 | 
			
		||||
@@ -359,6 +380,112 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        return restClient.authenticateUser(userWithRole).withPrivateAPI().usingNode(privateFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that the folder's owner can create rules, even if it is in a private site they aren't a member of. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void checkOwnerCanCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Use admin to create a private site.");
 | 
			
		||||
        SiteModel privateSite = dataSite.usingUser(dataUser.getAdminUser()).createPrivateRandomSite();
 | 
			
		||||
 | 
			
		||||
        STEP("Add the user to the site, let them create a folder and then evict them from the site again.");
 | 
			
		||||
        dataUser.addUserToSite(user, privateSite, SiteManager);
 | 
			
		||||
        FolderModel folder = dataContent.usingUser(user).usingSite(privateSite).createFolder();
 | 
			
		||||
        dataUser.removeUserFromSite(user, privateSite);
 | 
			
		||||
 | 
			
		||||
        STEP("Check the folder owner can create a rule.");
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(folder).usingDefaultRuleSet().createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(CREATED);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that an administrator can create a rule in a private site even if they aren't a member. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void checkAdminCanCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Use a user to create a private site with a folder.");
 | 
			
		||||
        SiteModel privateSite = dataSite.usingUser(user).createPrivateRandomSite();
 | 
			
		||||
        FolderModel folder = dataContent.usingUser(user).usingSite(privateSite).createFolder();
 | 
			
		||||
 | 
			
		||||
        STEP("Check admin can create a rule.");
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        restClient.authenticateUser(dataUser.getAdminUser()).withPrivateAPI().usingNode(folder).usingDefaultRuleSet().createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(CREATED);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that a coordinator can create rules in folders outside sites. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void checkCoordinatorCanCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Create a folder in the user's file space.");
 | 
			
		||||
        FolderModel folder = dataContent.usingUser(user).usingUserHome().createFolder();
 | 
			
		||||
 | 
			
		||||
        STEP("Create another user as a coordinator for this folder.");
 | 
			
		||||
        UserModel coordinator = dataUser.createRandomTestUser("Rules");
 | 
			
		||||
        /*
 | 
			
		||||
        Update folder node properties to add a coordinator
 | 
			
		||||
        { "permissions": { "isInheritanceEnabled": true, "locallySet": { "authorityId": "coordinator.getUsername()",
 | 
			
		||||
         "name": "Coordinator", "accessStatus":"ALLOWED" } } }
 | 
			
		||||
        */
 | 
			
		||||
        String putBody = getAddPermissionsBody(coordinator.getUsername(), "Coordinator");
 | 
			
		||||
        restClient.authenticateUser(user).withCoreAPI().usingNode(folder).updateNode(putBody);
 | 
			
		||||
 | 
			
		||||
        STEP("Check the coordinator can create a rule.");
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        restClient.authenticateUser(coordinator).withPrivateAPI().usingNode(folder).usingDefaultRuleSet().createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(CREATED);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that an editor cannot create rules in folders outside sites. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void checkEditorCannotCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Create a folder in the user's file space.");
 | 
			
		||||
        FolderModel folder = dataContent.usingUser(user).usingUserHome().createFolder();
 | 
			
		||||
 | 
			
		||||
        STEP("Create another user as a editor for this folder.");
 | 
			
		||||
        UserModel editor = dataUser.createRandomTestUser();
 | 
			
		||||
        /*
 | 
			
		||||
        Update folder node properties to add an editor
 | 
			
		||||
        { "permissions": { "isInheritanceEnabled": true, "locallySet": { "authorityId": "editor.getUsername()",
 | 
			
		||||
         "name": "Coordinator", "accessStatus":"ALLOWED" } } }
 | 
			
		||||
        */
 | 
			
		||||
        String putBody = getAddPermissionsBody(editor.getUsername(), "Editor");
 | 
			
		||||
        restClient.authenticateUser(user).withCoreAPI().usingNode(folder).updateNode(putBody);
 | 
			
		||||
 | 
			
		||||
        STEP("Check the editor can create a rule.");
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        restClient.authenticateUser(editor).withPrivateAPI().usingNode(folder).usingDefaultRuleSet().createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(FORBIDDEN);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that a collaborator cannot create rules in folders outside sites. */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void checkCollaboratorCannotCreateRule()
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Create a folder in the user's file space.");
 | 
			
		||||
        FolderModel folder = dataContent.usingUser(user).usingUserHome().createFolder();
 | 
			
		||||
 | 
			
		||||
        STEP("Create another user as a collaborator for this folder.");
 | 
			
		||||
        UserModel collaborator = dataUser.createRandomTestUser();
 | 
			
		||||
        /*
 | 
			
		||||
        Update folder node properties to add a collaborator
 | 
			
		||||
        { "permissions": { "isInheritanceEnabled": true, "locallySet": { "authorityId": "collaborator.getUsername()",
 | 
			
		||||
         "name": "Coordinator", "accessStatus":"ALLOWED" } } }
 | 
			
		||||
        */
 | 
			
		||||
        String putBody = getAddPermissionsBody(collaborator.getUsername(), "Collaborator");
 | 
			
		||||
        restClient.authenticateUser(user).withCoreAPI().usingNode(folder).updateNode(putBody);
 | 
			
		||||
 | 
			
		||||
        STEP("Check the collaborator can create a rule.");
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        restClient.authenticateUser(collaborator).withPrivateAPI().usingNode(folder).usingDefaultRuleSet().createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(FORBIDDEN);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check we can create a rule with several actions.
 | 
			
		||||
     */
 | 
			
		||||
@@ -368,10 +495,10 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        final UserModel admin = dataUser.getAdminUser();
 | 
			
		||||
 | 
			
		||||
        final RestRuleModel rule = restClient.authenticateUser(admin).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                .createSingleRule(rulesUtils.createVariousActions());
 | 
			
		||||
                .createSingleRule(rulesUtils.createRuleWithVariousActions());
 | 
			
		||||
 | 
			
		||||
        RestRuleModel expectedRuleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        expectedRuleModel.setActions(rulesUtils.createVariousActions().getActions());
 | 
			
		||||
        expectedRuleModel.setActions(rulesUtils.createRuleWithVariousActions().getActions());
 | 
			
		||||
        expectedRuleModel.setTriggers(List.of("inbound"));
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(CREATED);
 | 
			
		||||
@@ -379,8 +506,38 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
                .assertThat().field(IS_SHARED).isNull();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check get an error when creating a rule with action with empty parameter value.
 | 
			
		||||
     */
 | 
			
		||||
    @Test(groups = {TestGroup.REST_API, TestGroup.RULES})
 | 
			
		||||
    public void createRuleWithEmptyActionParameterValueShouldFail()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel checkinAction = rulesUtils.createCustomActionModel(CHECKIN_ACTION, Map.of("description", ""));
 | 
			
		||||
        ruleModel.setActions(List.of(checkinAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST).assertLastError().containsSummary("Action parameter should not have empty or null value");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check can create a rule with action without any parameters when action definition states all of them are optional.
 | 
			
		||||
     */
 | 
			
		||||
    @Test(groups = {TestGroup.REST_API, TestGroup.RULES})
 | 
			
		||||
    public void createRuleWithoutParameterWhenTheyAreOptional()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel checkinAction = rulesUtils.createCustomActionModel(CHECKIN_ACTION, null);
 | 
			
		||||
        ruleModel.setActions(List.of(checkinAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(CREATED);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that a normal user cannot create rules that use private actions. */
 | 
			
		||||
    @Test
 | 
			
		||||
    @Test(groups = {TestGroup.REST_API, TestGroup.RULES})
 | 
			
		||||
    public void createRuleWithActions_userCannotUsePrivateAction()
 | 
			
		||||
    {
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
@@ -391,7 +548,7 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check that an administrator can create rules that use private actions. */
 | 
			
		||||
    @Test
 | 
			
		||||
    @Test(groups = {TestGroup.REST_API, TestGroup.RULES})
 | 
			
		||||
    public void createRuleWithActions_adminCanUsePrivateAction()
 | 
			
		||||
    {
 | 
			
		||||
        restClient.authenticateUser(dataUser.getAdminUser()).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
@@ -400,6 +557,33 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        restClient.assertStatusCodeIs(CREATED);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check that an administrator can create rules with email (private) action with reference to an email template.
 | 
			
		||||
     */
 | 
			
		||||
    @Test(groups = {TestGroup.REST_API, TestGroup.RULES})
 | 
			
		||||
    public void createRuleWithActions_adminCanUseMailActionWithTemplate()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel mailAction = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        mailAction.setActionDefinitionId(MAIL_ACTION);
 | 
			
		||||
        final Map<String, Serializable> params = new HashMap<>();
 | 
			
		||||
        final UserModel sender = getRandomUserModel();
 | 
			
		||||
        final UserModel recipient = getRandomUserModel();
 | 
			
		||||
        params.put("from", sender.getEmailAddress());
 | 
			
		||||
        params.put("to", recipient.getEmailAddress());
 | 
			
		||||
        params.put("subject", "Test");
 | 
			
		||||
        final RestActionConstraintModel constraint = rulesUtils.getConstraintsForActionParam(user, MAIL_ACTION, TEMPLATE_PARAM);
 | 
			
		||||
        String templateScriptRef = constraint.getConstraintValues().stream().findFirst().get().getValue();
 | 
			
		||||
        params.put(TEMPLATE_PARAM, templateScriptRef);
 | 
			
		||||
        mailAction.setParams(params);
 | 
			
		||||
        ruleModel.setActions(List.of(mailAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(dataUser.getAdminUser()).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                .createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(CREATED);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check we get error when attempt to create a rule without any actions.
 | 
			
		||||
     */
 | 
			
		||||
@@ -423,17 +607,32 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
    public void createRuleWithInvalidActionsShouldFail()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        final String actionDefinitionId = "invalid-definition-value";
 | 
			
		||||
        invalidAction.setActionDefinitionId(actionDefinitionId);
 | 
			
		||||
        invalidAction.setParams(Map.of("dummy-key", "dummy-value"));
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction = rulesUtils.createCustomActionModel(actionDefinitionId, Map.of("dummy-key", "dummy-value"));
 | 
			
		||||
        ruleModel.setActions(List.of(invalidAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                .createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
        restClient.assertLastError().containsSummary(String.format("Invalid action definition requested %s", actionDefinitionId));
 | 
			
		||||
        restClient.assertLastError().containsSummary(String.format("Invalid rule action definition requested %s", actionDefinitionId));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check we get error when attempt to create a rule with an action tha is not applicable to rules.
 | 
			
		||||
     */
 | 
			
		||||
    @Test(groups = {TestGroup.REST_API, TestGroup.RULES})
 | 
			
		||||
    public void createRuleWithNotApplicableActionShouldFail()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction =
 | 
			
		||||
                rulesUtils.createCustomActionModel(RulesTestsUtils.DELETE_RENDITION_ACTION, Map.of("dummy-key", "dummy-value"));
 | 
			
		||||
        ruleModel.setActions(List.of(invalidAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet().createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
        restClient.assertLastError().containsSummary(String.format("Invalid rule action definition requested %s", RulesTestsUtils.DELETE_RENDITION_ACTION));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -443,9 +642,8 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
    public void createRuleWithMissingActionParametersShouldFail()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        final String actionDefinitionId = "copy";
 | 
			
		||||
        invalidAction.setActionDefinitionId(actionDefinitionId);
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction =
 | 
			
		||||
                rulesUtils.createCustomActionModel(RulesTestsUtils.COPY_ACTION, Collections.emptyMap());
 | 
			
		||||
        ruleModel.setActions(List.of(invalidAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
@@ -454,7 +652,7 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
        restClient.assertLastError().containsSummary(
 | 
			
		||||
                String.format("Action parameters should not be null or empty for this action. See Action Definition for action of: %s",
 | 
			
		||||
                        actionDefinitionId));
 | 
			
		||||
                        COPY_ACTION));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -464,8 +662,8 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
    public void createRuleWithActionParameterNotFulfillingConstraint()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final String actionDefinitionId = "script";
 | 
			
		||||
        final String scriptRef = "script-ref";
 | 
			
		||||
        final String actionDefinitionId = SCRIPT_ACTION;
 | 
			
		||||
        final String scriptRef = RULE_SCRIPT_PARAM_ID;
 | 
			
		||||
        final String scriptNodeId = "dummy-script-node-id";
 | 
			
		||||
        final RestActionBodyExecTemplateModel scriptAction = rulesUtils.createCustomActionModel(actionDefinitionId, Map.of(scriptRef, scriptNodeId));
 | 
			
		||||
        ruleModel.setActions(List.of(scriptAction));
 | 
			
		||||
@@ -484,14 +682,12 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
     * Check we get error when attempt to create a rule with action parameter that should not be passed.
 | 
			
		||||
     */
 | 
			
		||||
    @Test(groups = {TestGroup.REST_API, TestGroup.RULES})
 | 
			
		||||
    public void createRuleWithoutInvalidActionParameterShouldFail()
 | 
			
		||||
    public void createRuleWithInvalidActionParameterShouldFail()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        final String actionDefinitionId = "add-features";
 | 
			
		||||
        invalidAction.setActionDefinitionId(actionDefinitionId);
 | 
			
		||||
        final String invalidParameterKey = "invalidParameterKey";
 | 
			
		||||
        invalidAction.setParams(Map.of(invalidParameterKey,"dummyValue"));
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction = rulesUtils.createCustomActionModel(
 | 
			
		||||
                RulesTestsUtils.ADD_FEATURES_ACTION, Map.of(invalidParameterKey, "dummyValue"));
 | 
			
		||||
        ruleModel.setActions(List.of(invalidAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
@@ -499,7 +695,7 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
        restClient.assertLastError().containsSummary(
 | 
			
		||||
                String.format("Action of definition id: %s must not contain parameter of name: %s", actionDefinitionId, invalidParameterKey));
 | 
			
		||||
                String.format("Action of definition id: %s must not contain parameter of name: %s", RulesTestsUtils.ADD_FEATURES_ACTION, invalidParameterKey));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -509,10 +705,7 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
    public void createRuleWithoutMandatoryActionParametersShouldFail()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        final String actionDefinitionId = "copy";
 | 
			
		||||
        invalidAction.setActionDefinitionId(actionDefinitionId);
 | 
			
		||||
        invalidAction.setParams(Map.of("deep-copy",false));
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction = rulesUtils.createCustomActionModel(COPY_ACTION, Map.of("deep-copy",false));
 | 
			
		||||
        ruleModel.setActions(List.of(invalidAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
@@ -529,10 +722,8 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
    public void createRuleThatUsesNonExistentNode()
 | 
			
		||||
    {
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        String actionDefinitionId = "copy";
 | 
			
		||||
        invalidAction.setActionDefinitionId(actionDefinitionId);
 | 
			
		||||
        invalidAction.setParams(Map.of("destination-folder", "non-existent-node"));
 | 
			
		||||
        RestActionBodyExecTemplateModel invalidAction = rulesUtils.createCustomActionModel(
 | 
			
		||||
                COPY_ACTION, Map.of("destination-folder", "non-existent-node"));
 | 
			
		||||
        ruleModel.setActions(List.of(invalidAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
@@ -552,10 +743,8 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        FolderModel privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
 | 
			
		||||
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        RestActionBodyExecTemplateModel invalidAction = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        String actionDefinitionId = "copy";
 | 
			
		||||
        invalidAction.setActionDefinitionId(actionDefinitionId);
 | 
			
		||||
        invalidAction.setParams(Map.of("destination-folder", privateFolder.getNodeRef()));
 | 
			
		||||
        RestActionBodyExecTemplateModel invalidAction = rulesUtils.createCustomActionModel(
 | 
			
		||||
                COPY_ACTION, Map.of("destination-folder", privateFolder.getNodeRef()));
 | 
			
		||||
        ruleModel.setActions(List.of(invalidAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
@@ -565,6 +754,144 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        restClient.assertLastError().containsSummary("The entity with id: " + privateFolder.getNodeRef() + " was not found");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check we get error when attempting to create a rule that copies files to a folder that a user only has read permission for.
 | 
			
		||||
     */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void createRuleThatWritesToNodeWithoutPermission()
 | 
			
		||||
    {
 | 
			
		||||
        SiteModel privateSite = dataSite.usingAdmin().createPrivateRandomSite();
 | 
			
		||||
        FolderModel privateFolder = dataContent.usingAdmin().usingSite(privateSite).createFolder();
 | 
			
		||||
        dataUser.usingAdmin().addUserToSite(user, privateSite, SiteConsumer);
 | 
			
		||||
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        RestActionBodyExecTemplateModel invalidAction = rulesUtils.createCustomActionModel(
 | 
			
		||||
                COPY_ACTION, Map.of("destination-folder", privateFolder.getNodeRef()));
 | 
			
		||||
 | 
			
		||||
        ruleModel.setActions(List.of(invalidAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                  .createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(FORBIDDEN);
 | 
			
		||||
        restClient.assertLastError().containsSummary("No proper permissions for node: " + privateFolder.getNodeRef());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check we get error when attempting to create a rule that moves files to a node which is not a folder
 | 
			
		||||
     */
 | 
			
		||||
    @Test(groups = {TestGroup.REST_API, TestGroup.RULES})
 | 
			
		||||
    public void createRuleThatMovesToNodeWhichIsNotAFolderShouldFail()
 | 
			
		||||
    {
 | 
			
		||||
        final FileModel fileModel = dataContent.usingUser(user).usingSite(site).createContent(getRandomFileModel(TEXT_PLAIN));
 | 
			
		||||
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel invalidAction = rulesUtils.createCustomActionModel(
 | 
			
		||||
                RulesTestsUtils.MOVE_ACTION, Map.of("destination-folder", fileModel.getNodeRef()));
 | 
			
		||||
        ruleModel.setActions(List.of(invalidAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                .createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
        restClient.assertLastError().containsSummary("Node is not a folder " + fileModel.getNodeRef());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check we get error when attempting to create a rule with mail action defined with non-existing mail template.
 | 
			
		||||
     */
 | 
			
		||||
    @Test(groups = {TestGroup.REST_API, TestGroup.RULES})
 | 
			
		||||
    public void createRuleWithMailActionReferringToNonExistingTemplate()
 | 
			
		||||
    {
 | 
			
		||||
        final RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        final RestActionBodyExecTemplateModel mailAction = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        mailAction.setActionDefinitionId(MAIL_ACTION);
 | 
			
		||||
        final Map<String, Serializable> params = new HashMap<>();
 | 
			
		||||
        final UserModel sender = getRandomUserModel();
 | 
			
		||||
        final UserModel recipient = getRandomUserModel();
 | 
			
		||||
        params.put("from", sender.getEmailAddress());
 | 
			
		||||
        params.put("to", recipient.getEmailAddress());
 | 
			
		||||
        params.put("subject", "Test");
 | 
			
		||||
        final String mailTemplate = "non-existing-node-id";
 | 
			
		||||
        params.put(TEMPLATE_PARAM, mailTemplate);
 | 
			
		||||
        mailAction.setParams(params);
 | 
			
		||||
        ruleModel.setActions(List.of(mailAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                  .createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
        restClient.assertLastError().containsSummary("Action parameter: template has invalid value (" + mailTemplate +
 | 
			
		||||
                "). Look up possible values for constraint name ac-email-templates");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check the user can create a rule with a script.
 | 
			
		||||
     */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void checkCanUseScriptInRule()
 | 
			
		||||
    {
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        RestActionBodyExecTemplateModel scriptAction = rulesUtils.createCustomActionModel(
 | 
			
		||||
                SCRIPT_ACTION, Map.of(RULE_SCRIPT_PARAM_ID, rulesUtils.getReviewAndApproveWorkflowNode()));
 | 
			
		||||
        ruleModel.setActions(List.of(scriptAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                  .createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(CREATED);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check the script has to be stored in the scripts directory in the data dictionary.
 | 
			
		||||
     */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void checkCantUseNodeOutsideScriptsDirectory()
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Copy script to location outside data dictionary.");
 | 
			
		||||
        FolderModel folderOutsideDataDictionary = dataContent.usingUser(user).usingSite(site).createFolder();
 | 
			
		||||
        String sourceNodeId = rulesUtils.getReviewAndApproveWorkflowNode();
 | 
			
		||||
        ContentModel sourceNode = new ContentModel("/Data Dictionary/Scripts/start-pooled-review-workflow.js");
 | 
			
		||||
        sourceNode.setNodeRef("/workspace://SpacesStore/" + sourceNodeId);
 | 
			
		||||
        CmisObject scriptOutsideDataDictionary = dataContent.getContentActions().copyTo(dataUser.getAdminUser().getUsername(),
 | 
			
		||||
                dataUser.getAdminUser().getPassword(),
 | 
			
		||||
                sourceNode.getCmisLocation(),
 | 
			
		||||
                folderOutsideDataDictionary.getCmisLocation());
 | 
			
		||||
        String scriptId = scriptOutsideDataDictionary.getId().substring(0, scriptOutsideDataDictionary.getId().indexOf(";"));
 | 
			
		||||
 | 
			
		||||
        STEP("Try to use this script in rule.");
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        RestActionBodyExecTemplateModel scriptAction = rulesUtils.createCustomActionModel(
 | 
			
		||||
                SCRIPT_ACTION, Map.of(RULE_SCRIPT_PARAM_ID, scriptId));
 | 
			
		||||
        ruleModel.setActions(List.of(scriptAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                  .createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST)
 | 
			
		||||
                  .assertLastError().containsSummary("script-ref has invalid value");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check a real category needs to be supplied when linking to a category.
 | 
			
		||||
     */
 | 
			
		||||
    @Test (groups = { TestGroup.REST_API, TestGroup.RULES })
 | 
			
		||||
    public void checkLinkToCategoryNeedsRealCategory()
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Attempt to link to a category with a folder node, rather than a category node.");
 | 
			
		||||
        String nonCategoryNodeRef = ruleFolder.getNodeRef();
 | 
			
		||||
        RestRuleModel ruleModel = rulesUtils.createRuleModelWithDefaultValues();
 | 
			
		||||
        RestActionBodyExecTemplateModel categoryAction = rulesUtils.createCustomActionModel(
 | 
			
		||||
                RulesTestsUtils.LINK_CATEGORY_ACTION, Map.of("category-value", nonCategoryNodeRef));
 | 
			
		||||
        ruleModel.setActions(List.of(categoryAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                  .createSingleRule(ruleModel);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Check we can create a rule with multiple conditions
 | 
			
		||||
     */
 | 
			
		||||
@@ -623,4 +950,16 @@ public class CreateRulesTests extends RestTest
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
        restClient.assertLastError().containsSummary("Category in condition is invalid");
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private String getAddPermissionsBody(String username, String role)
 | 
			
		||||
    {
 | 
			
		||||
        JsonObject userPermission = Json.createObjectBuilder().add("permissions",
 | 
			
		||||
                Json.createObjectBuilder()
 | 
			
		||||
                        .add("isInheritanceEnabled", true)
 | 
			
		||||
                        .add("locallySet", Json.createObjectBuilder()
 | 
			
		||||
                                .add("authorityId", username)
 | 
			
		||||
                                .add("name", role).add("accessStatus", "ALLOWED")))
 | 
			
		||||
                .build();
 | 
			
		||||
        return userPermission.toString();
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -26,6 +26,7 @@
 | 
			
		||||
package org.alfresco.rest.rules;
 | 
			
		||||
 | 
			
		||||
import static org.alfresco.rest.requests.RuleSettings.IS_INHERITANCE_ENABLED;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.MOVE_ACTION;
 | 
			
		||||
import static org.alfresco.utility.report.log.Step.STEP;
 | 
			
		||||
import static org.junit.Assert.assertTrue;
 | 
			
		||||
import static org.springframework.http.HttpStatus.FORBIDDEN;
 | 
			
		||||
@@ -341,7 +342,7 @@ public class GetRuleSetsTests extends RestTest
 | 
			
		||||
        dataContent.usingAdmin().usingResource(privateFolder).setInheritPermissions(false);
 | 
			
		||||
        // Create the grandchild with user and use admin to move it under the private folder.
 | 
			
		||||
        FolderModel publicGrandchild = dataContent.usingUser(user).usingSite(siteModel).createFolder();
 | 
			
		||||
        coreAPIForAdmin().usingActions().executeAction("move", publicGrandchild, ImmutableMap.of("destination-folder", "workspace://SpacesStore/" + privateFolder.getNodeRef()));
 | 
			
		||||
        coreAPIForAdmin().usingActions().executeAction(MOVE_ACTION, publicGrandchild, ImmutableMap.of("destination-folder", "workspace://SpacesStore/" + privateFolder.getNodeRef()));
 | 
			
		||||
        // Create the non-inheriting folder.
 | 
			
		||||
        FolderModel nonInheritingFolder = dataContent.usingUser(user).usingResource(folder).createFolder();
 | 
			
		||||
        RestRuleSettingsModel nonInheriting = new RestRuleSettingsModel();
 | 
			
		||||
 
 | 
			
		||||
@@ -314,9 +314,11 @@ public class GetRulesTests extends RestTest
 | 
			
		||||
    public void getRuleActions()
 | 
			
		||||
    {
 | 
			
		||||
        STEP("Create a rule with a few actions");
 | 
			
		||||
        FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
 | 
			
		||||
        final RestRuleModel rule = restClient.authenticateUser(user).withPrivateAPI().usingNode(folder).usingDefaultRuleSet()
 | 
			
		||||
                .createSingleRule(rulesUtils.createVariousActions());
 | 
			
		||||
        final FolderModel folder = dataContent.usingUser(user).usingSite(site).createFolder();
 | 
			
		||||
        final RestRuleModel ruleWithVariousActions = rulesUtils.createRuleWithVariousActions();
 | 
			
		||||
        final UserModel admin = dataUser.getAdminUser();
 | 
			
		||||
        final RestRuleModel rule = restClient.authenticateUser(admin).withPrivateAPI().usingNode(folder).usingDefaultRuleSet()
 | 
			
		||||
                .createSingleRule(ruleWithVariousActions);
 | 
			
		||||
 | 
			
		||||
        STEP("Retrieve the created rule via the GET endpoint");
 | 
			
		||||
        final RestRuleModel getRuleBody = restClient.authenticateUser(user).withPrivateAPI().usingNode(folder).usingDefaultRuleSet().getSingleRule(rule.getId());
 | 
			
		||||
 
 | 
			
		||||
@@ -51,12 +51,11 @@ import org.alfresco.utility.data.DataUserAIS;
 | 
			
		||||
import org.alfresco.utility.model.FolderModel;
 | 
			
		||||
import org.alfresco.utility.model.SiteModel;
 | 
			
		||||
import org.alfresco.utility.model.UserModel;
 | 
			
		||||
import org.springframework.beans.factory.InitializingBean;
 | 
			
		||||
import org.springframework.beans.factory.annotation.Autowired;
 | 
			
		||||
import org.springframework.stereotype.Service;
 | 
			
		||||
 | 
			
		||||
@Service
 | 
			
		||||
public class RulesTestsUtils implements InitializingBean
 | 
			
		||||
public class RulesTestsUtils
 | 
			
		||||
{
 | 
			
		||||
    static final String RULE_NAME_DEFAULT = "ruleName";
 | 
			
		||||
    static final String RULE_DESCRIPTION_DEFAULT = "rule description";
 | 
			
		||||
@@ -64,8 +63,6 @@ public class RulesTestsUtils implements InitializingBean
 | 
			
		||||
    static final boolean RULE_CASCADE_DEFAULT = true;
 | 
			
		||||
    static final boolean RULE_ASYNC_DEFAULT = true;
 | 
			
		||||
    static final boolean RULE_SHARED_DEFAULT = false;
 | 
			
		||||
    static final String RULE_SCRIPT_ID = "script";
 | 
			
		||||
    static final String RULE_SCRIPT_PARAM_ID = "script-ref";
 | 
			
		||||
    static final String RULE_ERROR_SCRIPT_LABEL = "Start Pooled Review and Approve Workflow";
 | 
			
		||||
    static final String INBOUND = "inbound";
 | 
			
		||||
    static final String UPDATE = "update";
 | 
			
		||||
@@ -77,6 +74,15 @@ public class RulesTestsUtils implements InitializingBean
 | 
			
		||||
    static final String IS_SHARED = "isShared";
 | 
			
		||||
    static final String AUDIO_ASPECT = "audio:audio";
 | 
			
		||||
    static final String LOCKABLE_ASPECT = "cm:lockable";
 | 
			
		||||
    static final String TEMPLATE_PARAM = "template";
 | 
			
		||||
    static final String RULE_SCRIPT_PARAM_ID = "script-ref";
 | 
			
		||||
    static final String CHECKIN_ACTION = "check-in";
 | 
			
		||||
    static final String LINK_CATEGORY_ACTION = "link-category";
 | 
			
		||||
    static final String DELETE_RENDITION_ACTION = "delete-rendition";
 | 
			
		||||
    static final String COPY_ACTION = "copy";
 | 
			
		||||
    static final String ADD_FEATURES_ACTION = "add-features";
 | 
			
		||||
    static final String MOVE_ACTION = "move";
 | 
			
		||||
    static final String SCRIPT_ACTION = "script";
 | 
			
		||||
 | 
			
		||||
    @Autowired
 | 
			
		||||
    private RestWrapper restClient;
 | 
			
		||||
@@ -87,37 +93,49 @@ public class RulesTestsUtils implements InitializingBean
 | 
			
		||||
    @Autowired
 | 
			
		||||
    private DataContent dataContent;
 | 
			
		||||
 | 
			
		||||
    private SiteModel site;
 | 
			
		||||
    /** Public site used by these helper methods. This is populated by the getter and should not be accessed directly. */
 | 
			
		||||
    private SiteModel publicSite;
 | 
			
		||||
    /** Script node used by these helper methods. This is populated by the getter and should not be accessed directly. */
 | 
			
		||||
    private String reviewAndApproveWorkflowNode;
 | 
			
		||||
 | 
			
		||||
    /** Destination folder for copy action used by these helper methods. This is populated by the getter and should not be accessed directly. */
 | 
			
		||||
    private FolderModel copyDestinationFolder;
 | 
			
		||||
 | 
			
		||||
    /** Destination folder for check out action used by these helper methods. This is populated by the getter and should not be accessed directly. */
 | 
			
		||||
    private FolderModel checkOutDestinationFolder;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Initialise the util class.
 | 
			
		||||
     * Get the constraint value for a given action parameter label.
 | 
			
		||||
     *
 | 
			
		||||
     * @param user The user to use to obtain the information.
 | 
			
		||||
     * @param actionId The id of the action definition.
 | 
			
		||||
     * @param paramId The id of the parameter for the action.
 | 
			
		||||
     * @param constraintLabel The label of the desired value of the parameter.
 | 
			
		||||
     * @return The value to use for the parameter.
 | 
			
		||||
     */
 | 
			
		||||
    @Override
 | 
			
		||||
    public void afterPropertiesSet()
 | 
			
		||||
    public String findConstraintValue(UserModel user, String actionId, String paramId, String constraintLabel)
 | 
			
		||||
    {
 | 
			
		||||
        UserModel admin = dataUser.getAdminUser();
 | 
			
		||||
        // Obtain the node ref for the review and approve workflow.
 | 
			
		||||
        RestActionDefinitionModel actionDef = restClient.authenticateUser(admin).withCoreAPI().usingActions().getActionDefinitionById(RULE_SCRIPT_ID);
 | 
			
		||||
        RestParameterDefinitionModel paramDef = actionDef.getParameterDefinitions().stream().filter(param -> param.getName().equals(RULE_SCRIPT_PARAM_ID)).findFirst().get();
 | 
			
		||||
        String constraintName = paramDef.getParameterConstraintName();
 | 
			
		||||
        RestActionConstraintModel constraintDef = restClient.authenticateUser(admin).withCoreAPI().usingActions().getActionConstraintByName(constraintName);
 | 
			
		||||
        RestActionConstraintDataModel reviewAndApprove = constraintDef.getConstraintValues().stream().filter(constraintValue -> constraintValue.getLabel().equals(RULE_ERROR_SCRIPT_LABEL)).findFirst().get();
 | 
			
		||||
        reviewAndApproveWorkflowNode = reviewAndApprove.getValue();
 | 
			
		||||
 | 
			
		||||
        // Create a couple of public folders to be used as action destinations.
 | 
			
		||||
        site = dataSite.usingUser(admin).createPublicRandomSite();
 | 
			
		||||
        copyDestinationFolder = dataContent.usingUser(admin).usingSite(site).createFolder();
 | 
			
		||||
        checkOutDestinationFolder = dataContent.usingUser(admin).usingSite(site).createFolder();
 | 
			
		||||
        RestActionConstraintModel constraintDef = getConstraintsForActionParam(user, actionId, paramId);
 | 
			
		||||
        RestActionConstraintDataModel constraintDataModel = constraintDef.getConstraintValues().stream().filter(constraintValue -> constraintValue.getLabel().equals(constraintLabel)).findFirst().get();
 | 
			
		||||
        return constraintDataModel.getValue();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public RestRuleModel createRuleModelWithModifiedValues()
 | 
			
		||||
    /**
 | 
			
		||||
     * Get all constraint values for a given action parameter.
 | 
			
		||||
     *
 | 
			
		||||
     * @param user The user to use to obtain the information.
 | 
			
		||||
     * @param actionId The id of the action definition.
 | 
			
		||||
     * @param paramId The id of the parameter for the action.
 | 
			
		||||
     * @return The value to use for the parameter.
 | 
			
		||||
     */
 | 
			
		||||
    public RestActionConstraintModel getConstraintsForActionParam(UserModel user, String actionId, String paramId)
 | 
			
		||||
    {
 | 
			
		||||
        return createRuleModelWithModifiedValues(List.of(createAddAudioAspectAction()));
 | 
			
		||||
        RestActionDefinitionModel actionDef = restClient.authenticateUser(user).withCoreAPI().usingActions().getActionDefinitionById(actionId);
 | 
			
		||||
        RestParameterDefinitionModel paramDef = actionDef.getParameterDefinitions().stream().filter(param -> param.getName().equals(paramId)).findFirst().get();
 | 
			
		||||
        if (paramDef.getParameterConstraintName() == null)
 | 
			
		||||
        {
 | 
			
		||||
            throw new IllegalArgumentException("Supplied parameter " + paramId + " for action " + actionId + " does not have a defined constraint.");
 | 
			
		||||
        }
 | 
			
		||||
        String constraintName = paramDef.getParameterConstraintName();
 | 
			
		||||
        return restClient.authenticateUser(user).withCoreAPI().usingActions().getActionConstraintByName(constraintName);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
@@ -127,19 +145,49 @@ public class RulesTestsUtils implements InitializingBean
 | 
			
		||||
     */
 | 
			
		||||
    public String getReviewAndApproveWorkflowNode()
 | 
			
		||||
    {
 | 
			
		||||
        if (reviewAndApproveWorkflowNode == null)
 | 
			
		||||
        {
 | 
			
		||||
            UserModel admin = dataUser.getAdminUser();
 | 
			
		||||
            reviewAndApproveWorkflowNode = findConstraintValue(admin, SCRIPT_ACTION, RULE_SCRIPT_PARAM_ID, RULE_ERROR_SCRIPT_LABEL);
 | 
			
		||||
        }
 | 
			
		||||
        return reviewAndApproveWorkflowNode;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public SiteModel getPublicSite()
 | 
			
		||||
    {
 | 
			
		||||
        if (publicSite == null)
 | 
			
		||||
        {
 | 
			
		||||
            UserModel admin = dataUser.getAdminUser();
 | 
			
		||||
            publicSite = dataSite.usingUser(admin).createPublicRandomSite();
 | 
			
		||||
        }
 | 
			
		||||
        return publicSite;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public FolderModel getCopyDestinationFolder()
 | 
			
		||||
    {
 | 
			
		||||
        if (copyDestinationFolder == null)
 | 
			
		||||
        {
 | 
			
		||||
            UserModel admin = dataUser.getAdminUser();
 | 
			
		||||
            copyDestinationFolder = dataContent.usingUser(admin).usingSite(getPublicSite()).createFolder();
 | 
			
		||||
        }
 | 
			
		||||
        return copyDestinationFolder;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public FolderModel getCheckOutDestinationFolder()
 | 
			
		||||
    {
 | 
			
		||||
        if (checkOutDestinationFolder == null)
 | 
			
		||||
        {
 | 
			
		||||
            UserModel admin = dataUser.getAdminUser();
 | 
			
		||||
            checkOutDestinationFolder = dataContent.usingUser(admin).usingSite(getPublicSite()).createFolder();
 | 
			
		||||
        }
 | 
			
		||||
        return checkOutDestinationFolder;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public RestRuleModel createRuleModelWithModifiedValues()
 | 
			
		||||
    {
 | 
			
		||||
        return createRuleModelWithModifiedValues(List.of(createAddAudioAspectAction()));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Create a rule model filled with custom constant values.
 | 
			
		||||
     *
 | 
			
		||||
@@ -198,7 +246,7 @@ public class RulesTestsUtils implements InitializingBean
 | 
			
		||||
 | 
			
		||||
    public RestActionBodyExecTemplateModel createAddAspectAction(String aspect)
 | 
			
		||||
    {
 | 
			
		||||
        return createCustomActionModel("add-features", Map.of("aspect-name", aspect));
 | 
			
		||||
        return createCustomActionModel(ADD_FEATURES_ACTION, Map.of("aspect-name", aspect));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public RestActionBodyExecTemplateModel createCustomActionModel(String actionDefinitionId, Map<String, Serializable> params)
 | 
			
		||||
@@ -236,13 +284,13 @@ public class RulesTestsUtils implements InitializingBean
 | 
			
		||||
        ));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public RestRuleModel createVariousActions()
 | 
			
		||||
    public RestRuleModel createRuleWithVariousActions()
 | 
			
		||||
    {
 | 
			
		||||
        final Map<String, Serializable> copyParams =
 | 
			
		||||
                Map.of("destination-folder", copyDestinationFolder.getNodeRef(), "deep-copy", true);
 | 
			
		||||
        final RestActionBodyExecTemplateModel copyAction = createCustomActionModel("copy", copyParams);
 | 
			
		||||
                Map.of("destination-folder", getCopyDestinationFolder().getNodeRef(), "deep-copy", true);
 | 
			
		||||
        final RestActionBodyExecTemplateModel copyAction = createCustomActionModel(COPY_ACTION, copyParams);
 | 
			
		||||
        final Map<String, Serializable> checkOutParams =
 | 
			
		||||
                Map.of("destination-folder", checkOutDestinationFolder.getNodeRef(), "assoc-name", "cm:checkout",
 | 
			
		||||
                Map.of("destination-folder", getCheckOutDestinationFolder().getNodeRef(), "assoc-name", "cm:checkout",
 | 
			
		||||
                        "assoc-type", "cm:contains");
 | 
			
		||||
        final RestActionBodyExecTemplateModel checkOutAction = createCustomActionModel("check-out", checkOutParams);
 | 
			
		||||
        // The counter action takes no parameters, so check we can omit the "params" entry.
 | 
			
		||||
 
 | 
			
		||||
@@ -26,6 +26,8 @@
 | 
			
		||||
package org.alfresco.rest.rules;
 | 
			
		||||
 | 
			
		||||
import static org.alfresco.rest.actions.access.AccessRestrictionUtil.ERROR_MESSAGE_ACCESS_RESTRICTED;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.ADD_FEATURES_ACTION;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.COPY_ACTION;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.ID;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.INBOUND;
 | 
			
		||||
import static org.alfresco.rest.rules.RulesTestsUtils.INVERTED;
 | 
			
		||||
@@ -247,7 +249,7 @@ public class UpdateRulesTests extends RestTest
 | 
			
		||||
                .updateRule(rule.getId(), rule);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
        restClient.assertLastError().containsSummary(String.format("Invalid action definition requested %s", actionDefinitionId));
 | 
			
		||||
        restClient.assertLastError().containsSummary(String.format("Invalid rule action definition requested %s", actionDefinitionId));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /** Check we can use the POST response to create the new rule. */
 | 
			
		||||
@@ -257,7 +259,7 @@ public class UpdateRulesTests extends RestTest
 | 
			
		||||
        FolderModel destination = dataContent.usingUser(user).usingSite(site).createFolder();
 | 
			
		||||
 | 
			
		||||
        RestActionBodyExecTemplateModel copyAction = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        copyAction.setActionDefinitionId("copy");
 | 
			
		||||
        copyAction.setActionDefinitionId(COPY_ACTION);
 | 
			
		||||
        copyAction.setParams(ImmutableMap.of("destination-folder", destination.getNodeRef()));
 | 
			
		||||
        RestRuleModel rule = createAndSaveRule("Rule name", List.of(copyAction));
 | 
			
		||||
 | 
			
		||||
@@ -269,7 +271,7 @@ public class UpdateRulesTests extends RestTest
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(OK);
 | 
			
		||||
        updatedRule.assertThat().field("name").is("Updated rule name")
 | 
			
		||||
                   .assertThat().field("actions.actionDefinitionId").is(List.of("copy"))
 | 
			
		||||
                   .assertThat().field("actions.actionDefinitionId").is(List.of(COPY_ACTION))
 | 
			
		||||
                   .assertThat().field("actions.params").is(List.of(ImmutableMap.of("destination-folder", destination.getNodeRef())));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -459,12 +461,10 @@ public class UpdateRulesTests extends RestTest
 | 
			
		||||
        final RestRuleModel rule = createAndSaveRule(rulesUtils.createRuleModelWithModifiedValues());
 | 
			
		||||
 | 
			
		||||
        STEP("Try to update the rule by adding several actions");
 | 
			
		||||
        final Map<String, Serializable> copyParams =
 | 
			
		||||
                Map.of("destination-folder", rulesUtils.getCopyDestinationFolder().getNodeRef(), "deep-copy", true);
 | 
			
		||||
        final RestActionBodyExecTemplateModel copyAction = rulesUtils.createCustomActionModel("copy", copyParams);
 | 
			
		||||
        final RestActionBodyExecTemplateModel counterAction = rulesUtils.createCustomActionModel("counter", null);
 | 
			
		||||
        final Map<String, Serializable> addAspectParams = Map.of("aspect-name", "cm:taggable");
 | 
			
		||||
        final RestActionBodyExecTemplateModel addAspectAction = rulesUtils.createCustomActionModel("add-features", addAspectParams);
 | 
			
		||||
        rule.setActions(Arrays.asList(copyAction, addAspectAction));
 | 
			
		||||
        final RestActionBodyExecTemplateModel addAspectAction = rulesUtils.createCustomActionModel(ADD_FEATURES_ACTION, addAspectParams);
 | 
			
		||||
        rule.setActions(Arrays.asList(counterAction, addAspectAction));
 | 
			
		||||
 | 
			
		||||
        final RestRuleModel updatedRule = restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                .updateRule(rule.getId(), rule);
 | 
			
		||||
@@ -489,7 +489,8 @@ public class UpdateRulesTests extends RestTest
 | 
			
		||||
        final RestActionBodyExecTemplateModel checkOutAction = rulesUtils.createCustomActionModel("check-out", checkOutParams);
 | 
			
		||||
        rule.setActions(List.of(checkOutAction));
 | 
			
		||||
 | 
			
		||||
        restClient.authenticateUser(user).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
        final UserModel admin = dataUser.getAdminUser();
 | 
			
		||||
        restClient.authenticateUser(admin).withPrivateAPI().usingNode(ruleFolder).usingDefaultRuleSet()
 | 
			
		||||
                .updateRule(rule.getId(), rule);
 | 
			
		||||
 | 
			
		||||
        restClient.assertStatusCodeIs(BAD_REQUEST);
 | 
			
		||||
@@ -507,7 +508,7 @@ public class UpdateRulesTests extends RestTest
 | 
			
		||||
 | 
			
		||||
        STEP("Try to update the rule by adding action with invalid parameter (non-existing namespace in value)");
 | 
			
		||||
        final RestActionBodyExecTemplateModel action = new RestActionBodyExecTemplateModel();
 | 
			
		||||
        action.setActionDefinitionId("add-features");
 | 
			
		||||
        action.setActionDefinitionId(ADD_FEATURES_ACTION);
 | 
			
		||||
        final String aspectNameParam = "aspect-name";
 | 
			
		||||
        final String paramValue = "dummy:dummy";
 | 
			
		||||
        action.setParams(Map.of(aspectNameParam, paramValue));
 | 
			
		||||
 
 | 
			
		||||
@@ -9,7 +9,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-tests</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <developers>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo-packaging</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <properties>
 | 
			
		||||
 
 | 
			
		||||
@@ -71,7 +71,7 @@ ModuleDetails shareServicesModule = moduleService.getModule("alfresco-share-serv
 | 
			
		||||
         </div>
 | 
			
		||||
 | 
			
		||||
         <div class="index-list">
 | 
			
		||||
            <h4><%=descriptorService.getServerDescriptor().getEdition()%> - <%=descriptorService.getServerDescriptor().getVersion()%></h4>
 | 
			
		||||
            <h4><%=descriptorService.getServerDescriptor().getEdition()%></h4>
 | 
			
		||||
            <p></p>
 | 
			
		||||
            <p><a href="http://docs.alfresco.com/">Online Documentation</a></p>
 | 
			
		||||
            <p></p>
 | 
			
		||||
 
 | 
			
		||||
							
								
								
									
										18
									
								
								pom.xml
									
									
									
									
									
								
							
							
						
						
									
										18
									
								
								pom.xml
									
									
									
									
									
								
							@@ -2,7 +2,7 @@
 | 
			
		||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
 | 
			
		||||
    <modelVersion>4.0.0</modelVersion>
 | 
			
		||||
    <artifactId>alfresco-community-repo</artifactId>
 | 
			
		||||
    <version>17.169</version>
 | 
			
		||||
    <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    <packaging>pom</packaging>
 | 
			
		||||
    <name>Alfresco Community Repo Parent</name>
 | 
			
		||||
 | 
			
		||||
@@ -25,7 +25,7 @@
 | 
			
		||||
    <properties>
 | 
			
		||||
        <acs.version.major>7</acs.version.major>
 | 
			
		||||
        <acs.version.minor>3</acs.version.minor>
 | 
			
		||||
        <acs.version.revision>0</acs.version.revision>
 | 
			
		||||
        <acs.version.revision>1</acs.version.revision>
 | 
			
		||||
        <acs.version.label />
 | 
			
		||||
        <amp.min.version>${acs.version.major}.0.0</amp.min.version>
 | 
			
		||||
 | 
			
		||||
@@ -51,8 +51,8 @@
 | 
			
		||||
        <dependency.alfresco-log-sanitizer.version>0.2</dependency.alfresco-log-sanitizer.version>
 | 
			
		||||
        <dependency.activiti-engine.version>5.23.0</dependency.activiti-engine.version>
 | 
			
		||||
        <dependency.activiti.version>5.23.0</dependency.activiti.version>
 | 
			
		||||
        <dependency.alfresco-transform-service.version>2.0.0-A5</dependency.alfresco-transform-service.version>
 | 
			
		||||
        <dependency.alfresco-transform-core.version>3.0.0-A6</dependency.alfresco-transform-core.version>
 | 
			
		||||
        <dependency.alfresco-transform-service.version>2.0.0</dependency.alfresco-transform-service.version>
 | 
			
		||||
        <dependency.alfresco-transform-core.version>3.0.0</dependency.alfresco-transform-core.version>
 | 
			
		||||
        <dependency.alfresco-greenmail.version>6.4</dependency.alfresco-greenmail.version>
 | 
			
		||||
        <dependency.acs-event-model.version>0.0.16</dependency.acs-event-model.version>
 | 
			
		||||
 | 
			
		||||
@@ -61,7 +61,7 @@
 | 
			
		||||
        <dependency.jackson.version>2.14.0-rc1</dependency.jackson.version>
 | 
			
		||||
        <dependency.cxf.version>3.5.3</dependency.cxf.version>
 | 
			
		||||
        <dependency.opencmis.version>1.0.0</dependency.opencmis.version>
 | 
			
		||||
        <dependency.webscripts.version>8.32</dependency.webscripts.version>
 | 
			
		||||
        <dependency.webscripts.version>8.33</dependency.webscripts.version>
 | 
			
		||||
        <dependency.bouncycastle.version>1.70</dependency.bouncycastle.version>
 | 
			
		||||
        <dependency.mockito-core.version>4.6.1</dependency.mockito-core.version>
 | 
			
		||||
        <dependency.assertj.version>3.23.1</dependency.assertj.version>
 | 
			
		||||
@@ -109,9 +109,9 @@
 | 
			
		||||
        <dependency.jakarta-json-path.version>2.7.0</dependency.jakarta-json-path.version>
 | 
			
		||||
        <dependency.jakarta-rpc-api.version>1.1.4</dependency.jakarta-rpc-api.version>
 | 
			
		||||
 | 
			
		||||
        <alfresco.googledrive.version>3.3.0-A1</alfresco.googledrive.version>
 | 
			
		||||
        <alfresco.aos-module.version>1.4.1</alfresco.aos-module.version>
 | 
			
		||||
        <alfresco.api-explorer.version>7.3.0-A1</alfresco.api-explorer.version> <!-- Also in alfresco-enterprise-share -->
 | 
			
		||||
        <alfresco.googledrive.version>3.3.0</alfresco.googledrive.version>
 | 
			
		||||
        <alfresco.aos-module.version>1.5.0</alfresco.aos-module.version>
 | 
			
		||||
        <alfresco.api-explorer.version>7.3.0</alfresco.api-explorer.version> <!-- Also in alfresco-enterprise-share -->
 | 
			
		||||
 | 
			
		||||
        <alfresco.maven-plugin.version>2.2.0</alfresco.maven-plugin.version>
 | 
			
		||||
        <license-maven-plugin.version>2.0.1.alfresco-2</license-maven-plugin.version>
 | 
			
		||||
@@ -149,7 +149,7 @@
 | 
			
		||||
        <connection>scm:git:https://github.com/Alfresco/alfresco-community-repo.git</connection>
 | 
			
		||||
        <developerConnection>scm:git:https://github.com/Alfresco/alfresco-community-repo.git</developerConnection>
 | 
			
		||||
        <url>https://github.com/Alfresco/alfresco-community-repo</url>
 | 
			
		||||
        <tag>17.169</tag>
 | 
			
		||||
        <tag>HEAD</tag>
 | 
			
		||||
    </scm>
 | 
			
		||||
 | 
			
		||||
    <distributionManagement>
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <dependencies>
 | 
			
		||||
 
 | 
			
		||||
@@ -27,6 +27,8 @@
 | 
			
		||||
package org.alfresco.rest.api;
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
import java.util.List;
 | 
			
		||||
 | 
			
		||||
import org.alfresco.rest.api.model.Action;
 | 
			
		||||
import org.alfresco.rest.api.model.ActionDefinition;
 | 
			
		||||
import org.alfresco.rest.api.model.ActionParameterConstraint;
 | 
			
		||||
@@ -53,4 +55,6 @@ public interface Actions
 | 
			
		||||
 | 
			
		||||
    @Experimental
 | 
			
		||||
    ActionParameterConstraint getActionConstraint(String constraintName);
 | 
			
		||||
    @Experimental
 | 
			
		||||
    ActionDefinition getRuleActionDefinitionById(String actionDefinitionId);
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -26,13 +26,35 @@
 | 
			
		||||
 | 
			
		||||
package org.alfresco.rest.api.actions;
 | 
			
		||||
 | 
			
		||||
import java.util.List;
 | 
			
		||||
 | 
			
		||||
import org.alfresco.rest.api.model.rules.Action;
 | 
			
		||||
import org.alfresco.service.Experimental;
 | 
			
		||||
 | 
			
		||||
@Experimental
 | 
			
		||||
public interface ActionValidator
 | 
			
		||||
{
 | 
			
		||||
 | 
			
		||||
    String ALL_ACTIONS = "all";
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Provides validation logic for given action.
 | 
			
		||||
     */
 | 
			
		||||
    void validate(Action action);
 | 
			
		||||
 | 
			
		||||
    boolean isEnabled();
 | 
			
		||||
    /**
 | 
			
		||||
     * Returns priority of validator (applied to bulk validation in @see {@link org.alfresco.rest.api.impl.mapper.rules.RestRuleActionModelMapper})
 | 
			
		||||
     * The lower number, the higher priority is set for the validator.
 | 
			
		||||
     * @return priority expressed as int
 | 
			
		||||
     */
 | 
			
		||||
    int getPriority();
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * By default validator is applied to all actions
 | 
			
		||||
     *
 | 
			
		||||
     * @return indicator for all defined action definition ids
 | 
			
		||||
     */
 | 
			
		||||
    default List<String> getActionDefinitionIds() {
 | 
			
		||||
        return List.of(ALL_ACTIONS);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -145,21 +145,7 @@ public class ActionsImpl implements Actions
 | 
			
		||||
    private ActionDefinition getActionDefinition(
 | 
			
		||||
            org.alfresco.service.cmr.action.ActionDefinition actionDefinitionId)
 | 
			
		||||
    {
 | 
			
		||||
        List<ActionDefinition.ParameterDefinition> paramDefs =
 | 
			
		||||
                actionDefinitionId.
 | 
			
		||||
                        getParameterDefinitions().
 | 
			
		||||
                        stream().
 | 
			
		||||
                        map(this::toModel).
 | 
			
		||||
                        collect(Collectors.toList());
 | 
			
		||||
        return new ActionDefinition(
 | 
			
		||||
                actionDefinitionId.getName(), // ID is a synonym for name.
 | 
			
		||||
                actionDefinitionId.getName(),
 | 
			
		||||
                actionDefinitionId.getTitle(),
 | 
			
		||||
                actionDefinitionId.getDescription(),
 | 
			
		||||
                toShortQNames(actionDefinitionId.getApplicableTypes()),
 | 
			
		||||
                actionDefinitionId.getAdhocPropertiesAllowed(),
 | 
			
		||||
                actionDefinitionId.getTrackStatus(),
 | 
			
		||||
                paramDefs);
 | 
			
		||||
        return mapFromServiceModel(actionDefinitionId);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
@@ -215,23 +201,7 @@ public class ActionsImpl implements Actions
 | 
			
		||||
 | 
			
		||||
        List<ActionDefinition> sortedPage = actionDefinitions.
 | 
			
		||||
                stream().
 | 
			
		||||
                map(actionDefinition -> {
 | 
			
		||||
                    List<ActionDefinition.ParameterDefinition> paramDefs =
 | 
			
		||||
                            actionDefinition.
 | 
			
		||||
                                    getParameterDefinitions().
 | 
			
		||||
                                    stream().
 | 
			
		||||
                                    map(this::toModel).
 | 
			
		||||
                                    collect(Collectors.toList());
 | 
			
		||||
                    return new ActionDefinition(
 | 
			
		||||
                            actionDefinition.getName(), // ID is a synonym for name.
 | 
			
		||||
                            actionDefinition.getName(),
 | 
			
		||||
                            actionDefinition.getTitle(),
 | 
			
		||||
                            actionDefinition.getDescription(),
 | 
			
		||||
                            toShortQNames(actionDefinition.getApplicableTypes()),
 | 
			
		||||
                            actionDefinition.getAdhocPropertiesAllowed(),
 | 
			
		||||
                            actionDefinition.getTrackStatus(),
 | 
			
		||||
                            paramDefs);
 | 
			
		||||
                }).
 | 
			
		||||
                map(this::mapFromServiceModel).
 | 
			
		||||
                sorted(comparator).
 | 
			
		||||
                skip(skip).
 | 
			
		||||
                limit(maxItems).
 | 
			
		||||
@@ -246,6 +216,40 @@ public class ActionsImpl implements Actions
 | 
			
		||||
                actionDefinitions.size());
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    @Experimental
 | 
			
		||||
    public ActionDefinition getRuleActionDefinitionById(String actionDefinitionId)
 | 
			
		||||
    {
 | 
			
		||||
        if (actionDefinitionId == null)
 | 
			
		||||
        {
 | 
			
		||||
            throw new InvalidArgumentException("actionDefinitionId is null");
 | 
			
		||||
        }
 | 
			
		||||
        return actionService.getActionDefinitions().stream()
 | 
			
		||||
                .filter(a -> actionDefinitionId.equals(a.getName()))
 | 
			
		||||
                .map(this::mapFromServiceModel)
 | 
			
		||||
                .findFirst()
 | 
			
		||||
                .orElseThrow(() -> new NotFoundException(NotFoundException.DEFAULT_MESSAGE_ID, new String[] {actionDefinitionId}));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private ActionDefinition mapFromServiceModel(org.alfresco.service.cmr.action.ActionDefinition actionDefinition)
 | 
			
		||||
    {
 | 
			
		||||
        List<ActionDefinition.ParameterDefinition> paramDefs =
 | 
			
		||||
                actionDefinition.
 | 
			
		||||
                        getParameterDefinitions().
 | 
			
		||||
                        stream().
 | 
			
		||||
                        map(this::toModel).
 | 
			
		||||
                        collect(Collectors.toList());
 | 
			
		||||
        return new ActionDefinition(
 | 
			
		||||
                actionDefinition.getName(), // ID is a synonym for name.
 | 
			
		||||
                actionDefinition.getName(),
 | 
			
		||||
                actionDefinition.getTitle(),
 | 
			
		||||
                actionDefinition.getDescription(),
 | 
			
		||||
                toShortQNames(actionDefinition.getApplicableTypes()),
 | 
			
		||||
                actionDefinition.getAdhocPropertiesAllowed(),
 | 
			
		||||
                actionDefinition.getTrackStatus(),
 | 
			
		||||
                paramDefs);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public Action executeAction(Action action, Parameters parameters)
 | 
			
		||||
    {
 | 
			
		||||
 
 | 
			
		||||
@@ -295,7 +295,18 @@ public class AuditImpl implements Audit
 | 
			
		||||
        }
 | 
			
		||||
        else
 | 
			
		||||
        {
 | 
			
		||||
            totalItems = hasMoreItems ? getAuditEntriesCountByApp(auditApplication) : totalRetrievedItems;
 | 
			
		||||
            if (hasMoreItems) {
 | 
			
		||||
                if (q != null) {
 | 
			
		||||
                    // filtering via "where" clause
 | 
			
		||||
                    AuditEntryQueryWalker propertyWalker = new AuditEntryQueryWalker();
 | 
			
		||||
                    QueryHelper.walk(q, propertyWalker);
 | 
			
		||||
                    totalItems = getAuditEntriesCountByAppAndProperties(auditApplication, propertyWalker);
 | 
			
		||||
                } else {
 | 
			
		||||
                    totalItems = getAuditEntriesCountByApp(auditApplication);
 | 
			
		||||
                }
 | 
			
		||||
            } else {
 | 
			
		||||
                totalItems = totalRetrievedItems;
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        entriesAudit = (skipCount >= totalRetrievedItems)
 | 
			
		||||
@@ -895,4 +906,19 @@ public class AuditImpl implements Audit
 | 
			
		||||
        final String applicationName = auditApplication.getKey().substring(1);
 | 
			
		||||
        return auditService.getAuditEntriesCountByApp(applicationName);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public int getAuditEntriesCountByAppAndProperties(AuditService.AuditApplication auditApplication, AuditEntryQueryWalker propertyWalker)
 | 
			
		||||
    {
 | 
			
		||||
        final String applicationName = auditApplication.getKey().substring(1);
 | 
			
		||||
 | 
			
		||||
        AuditQueryParameters parameters = new AuditQueryParameters();
 | 
			
		||||
        parameters.setApplicationName(applicationName);
 | 
			
		||||
        parameters.setFromTime(propertyWalker.getFromTime());
 | 
			
		||||
        parameters.setToTime(propertyWalker.getToTime());
 | 
			
		||||
        parameters.setFromId(propertyWalker.getFromId());
 | 
			
		||||
        parameters.setToId(propertyWalker.getToId());
 | 
			
		||||
        parameters.setUser(propertyWalker.getCreatedByUser());
 | 
			
		||||
 | 
			
		||||
        return auditService.getAuditEntriesCountByAppAndProperties(applicationName, parameters);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -29,13 +29,15 @@ package org.alfresco.rest.api.impl.mapper.rules;
 | 
			
		||||
import static java.util.Collections.emptyMap;
 | 
			
		||||
 | 
			
		||||
import static org.alfresco.repo.action.access.ActionAccessRestriction.ACTION_CONTEXT_PARAM_NAME;
 | 
			
		||||
import static org.alfresco.rest.api.actions.ActionValidator.ALL_ACTIONS;
 | 
			
		||||
 | 
			
		||||
import java.io.Serializable;
 | 
			
		||||
import java.util.Collection;
 | 
			
		||||
import java.util.HashMap;
 | 
			
		||||
import java.util.Comparator;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.Optional;
 | 
			
		||||
import java.util.stream.Collectors;
 | 
			
		||||
 | 
			
		||||
import org.alfresco.repo.action.ActionImpl;
 | 
			
		||||
import org.alfresco.repo.action.CompositeActionImpl;
 | 
			
		||||
@@ -80,7 +82,7 @@ public class RestRuleActionModelMapper implements RestModelMapper<Action, org.al
 | 
			
		||||
            final Map<String, Serializable> convertedParams = actionModel.getParameterValues()
 | 
			
		||||
                    .entrySet()
 | 
			
		||||
                    .stream()
 | 
			
		||||
                    .collect(Collectors.toMap(Map.Entry::getKey, e -> parameterConverter.convertParamFromServiceModel(e.getValue())));
 | 
			
		||||
                    .collect(HashMap::new, (m, v) -> m.put(v.getKey(), parameterConverter.convertParamFromServiceModel(v.getValue())), HashMap::putAll);
 | 
			
		||||
            convertedParams.remove(ACTION_CONTEXT_PARAM_NAME);
 | 
			
		||||
            builder.params(convertedParams);
 | 
			
		||||
        }
 | 
			
		||||
@@ -116,7 +118,9 @@ public class RestRuleActionModelMapper implements RestModelMapper<Action, org.al
 | 
			
		||||
    }
 | 
			
		||||
    private void validateAction(Action action) {
 | 
			
		||||
        actionValidators.stream()
 | 
			
		||||
                .filter(ActionValidator::isEnabled)
 | 
			
		||||
                .forEach(v -> v.validate(action));
 | 
			
		||||
                .filter(v -> (v.getActionDefinitionIds().contains(action.getActionDefinitionId()) ||
 | 
			
		||||
                        v.getActionDefinitionIds().equals(List.of(ALL_ACTIONS))))
 | 
			
		||||
                .sorted(Comparator.comparing(ActionValidator::getPriority))
 | 
			
		||||
                .forEachOrdered(v -> v.validate(action));
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -34,6 +34,7 @@ import java.util.ArrayList;
 | 
			
		||||
import java.util.HashMap;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
 | 
			
		||||
import org.alfresco.rest.api.Nodes;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
 | 
			
		||||
@@ -51,6 +52,7 @@ import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
 | 
			
		||||
import org.alfresco.service.cmr.security.PermissionService;
 | 
			
		||||
import org.alfresco.service.namespace.NamespaceService;
 | 
			
		||||
import org.alfresco.service.namespace.QName;
 | 
			
		||||
import org.apache.logging.log4j.util.Strings;
 | 
			
		||||
import org.json.JSONArray;
 | 
			
		||||
import org.json.JSONException;
 | 
			
		||||
import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 | 
			
		||||
@@ -58,6 +60,8 @@ import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 | 
			
		||||
@Experimental
 | 
			
		||||
public class ActionParameterConverter
 | 
			
		||||
{
 | 
			
		||||
    static final String ACTION_PARAMETER_SHOULD_NOT_HAVE_EMPTY_OR_NULL_VALUE =
 | 
			
		||||
            "Action parameter should not have empty or null value";
 | 
			
		||||
    private final DictionaryService dictionaryService;
 | 
			
		||||
    private final ActionService actionService;
 | 
			
		||||
    private final NamespaceService namespaceService;
 | 
			
		||||
@@ -93,6 +97,9 @@ public class ActionParameterConverter
 | 
			
		||||
 | 
			
		||||
        for (Map.Entry<String, Serializable> param : params.entrySet())
 | 
			
		||||
        {
 | 
			
		||||
            if (Objects.toString(param.getValue(), Strings.EMPTY).isEmpty()) {
 | 
			
		||||
                throw new InvalidArgumentException(ACTION_PARAMETER_SHOULD_NOT_HAVE_EMPTY_OR_NULL_VALUE, new String[] {param.getKey()});
 | 
			
		||||
            }
 | 
			
		||||
            final ParameterDefinition paramDef = definition.getParameterDefintion(param.getKey());
 | 
			
		||||
            if (paramDef == null && !definition.getAdhocPropertiesAllowed())
 | 
			
		||||
            {
 | 
			
		||||
@@ -159,16 +166,17 @@ public class ActionParameterConverter
 | 
			
		||||
        }
 | 
			
		||||
        else
 | 
			
		||||
        {
 | 
			
		||||
            if (typeQName.equals(DataTypeDefinition.QNAME) && typeQName.toString().contains(":"))
 | 
			
		||||
            final String stringValue = Objects.toString(propertyValue, Strings.EMPTY);
 | 
			
		||||
            if (typeQName.isMatch(DataTypeDefinition.QNAME) && typeQName.toString().contains(":"))
 | 
			
		||||
            {
 | 
			
		||||
                value = QName.createQName(propertyValue.toString(), namespaceService);
 | 
			
		||||
                value = QName.createQName(stringValue, namespaceService);
 | 
			
		||||
            }
 | 
			
		||||
            else if (typeQName.isMatch(DataTypeDefinition.NODE_REF))
 | 
			
		||||
            {
 | 
			
		||||
                NodeRef nodeRef = nodes.validateOrLookupNode(propertyValue.toString(), null);
 | 
			
		||||
                NodeRef nodeRef = nodes.validateOrLookupNode(stringValue, null);
 | 
			
		||||
                if (permissionService.hasReadPermission(nodeRef) != ALLOWED)
 | 
			
		||||
                {
 | 
			
		||||
                    throw new EntityNotFoundException(propertyValue.toString());
 | 
			
		||||
                    throw new EntityNotFoundException(stringValue);
 | 
			
		||||
                }
 | 
			
		||||
                value = nodeRef;
 | 
			
		||||
            }
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,171 @@
 | 
			
		||||
/*
 | 
			
		||||
 * #%L
 | 
			
		||||
 * Alfresco Remote API
 | 
			
		||||
 * %%
 | 
			
		||||
 * Copyright (C) 2005 - 2022 Alfresco Software Limited
 | 
			
		||||
 * %%
 | 
			
		||||
 * This file is part of the Alfresco software.
 | 
			
		||||
 * If the software was purchased under a paid Alfresco license, the terms of
 | 
			
		||||
 * the paid license agreement will prevail.  Otherwise, the software is
 | 
			
		||||
 * provided under the following open source license terms:
 | 
			
		||||
 *
 | 
			
		||||
 * Alfresco is free software: you can redistribute it and/or modify
 | 
			
		||||
 * it under the terms of the GNU Lesser General Public License as published by
 | 
			
		||||
 * the Free Software Foundation, either version 3 of the License, or
 | 
			
		||||
 * (at your option) any later version.
 | 
			
		||||
 *
 | 
			
		||||
 * Alfresco is distributed in the hope that it will be useful,
 | 
			
		||||
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
 *  GNU Lesser General Public License for more details.
 | 
			
		||||
 *
 | 
			
		||||
 * You should have received a copy of the GNU Lesser General Public License
 | 
			
		||||
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 * #L%
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package org.alfresco.rest.api.impl.validator.actions;
 | 
			
		||||
 | 
			
		||||
import static org.alfresco.model.ContentModel.TYPE_CATEGORY;
 | 
			
		||||
import static org.alfresco.model.ContentModel.TYPE_FOLDER;
 | 
			
		||||
import static org.alfresco.service.cmr.dictionary.DataTypeDefinition.NODE_REF;
 | 
			
		||||
import static org.alfresco.service.cmr.security.AccessStatus.ALLOWED;
 | 
			
		||||
import static org.alfresco.service.cmr.security.PermissionService.WRITE;
 | 
			
		||||
 | 
			
		||||
import java.util.Collections;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
import java.util.Set;
 | 
			
		||||
import java.util.stream.Collectors;
 | 
			
		||||
 | 
			
		||||
import org.alfresco.repo.action.executer.CheckOutActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.CopyActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.ImageTransformActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.ImporterActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.LinkCategoryActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.MoveActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.SimpleWorkflowActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.TransformActionExecuter;
 | 
			
		||||
import org.alfresco.rest.api.Actions;
 | 
			
		||||
import org.alfresco.rest.api.Nodes;
 | 
			
		||||
import org.alfresco.rest.api.actions.ActionValidator;
 | 
			
		||||
import org.alfresco.rest.api.model.ActionDefinition;
 | 
			
		||||
import org.alfresco.rest.api.model.rules.Action;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.PermissionDeniedException;
 | 
			
		||||
import org.alfresco.service.cmr.repository.NodeRef;
 | 
			
		||||
import org.alfresco.service.cmr.security.PermissionService;
 | 
			
		||||
import org.alfresco.service.namespace.NamespaceService;
 | 
			
		||||
import org.apache.commons.collections.MapUtils;
 | 
			
		||||
import org.apache.logging.log4j.util.Strings;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * This class provides logic for validation of permissions for action parameters which reference node.
 | 
			
		||||
 */
 | 
			
		||||
public class ActionNodeParameterValidator implements ActionValidator
 | 
			
		||||
{
 | 
			
		||||
    /**
 | 
			
		||||
     * This list holds action parameter names which require only READ permission on a referenced node
 | 
			
		||||
     * That means, all other parameters that reference nodes will require WRITE permission
 | 
			
		||||
     */
 | 
			
		||||
    static final Map<String, List<String>> REQUIRE_READ_PERMISSION_PARAMS =
 | 
			
		||||
            Map.of(LinkCategoryActionExecuter.NAME, List.of(LinkCategoryActionExecuter.PARAM_CATEGORY_VALUE));
 | 
			
		||||
 | 
			
		||||
    static final String NO_PROPER_PERMISSIONS_FOR_NODE = "No proper permissions for node: ";
 | 
			
		||||
    static final String NOT_A_CATEGORY = "Node is not a category ";
 | 
			
		||||
    static final String NOT_A_FOLDER = "Node is not a folder ";
 | 
			
		||||
 | 
			
		||||
    private final Actions actions;
 | 
			
		||||
    private final NamespaceService namespaceService;
 | 
			
		||||
    private final Nodes nodes;
 | 
			
		||||
    private final PermissionService permissionService;
 | 
			
		||||
 | 
			
		||||
    public ActionNodeParameterValidator(Actions actions, NamespaceService namespaceService, Nodes nodes,
 | 
			
		||||
                                        PermissionService permissionService)
 | 
			
		||||
    {
 | 
			
		||||
        this.actions = actions;
 | 
			
		||||
        this.namespaceService = namespaceService;
 | 
			
		||||
        this.nodes = nodes;
 | 
			
		||||
        this.permissionService = permissionService;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Validates action parameters that reference nodes against access permissions for executing user.
 | 
			
		||||
     *
 | 
			
		||||
     * @param action Action to be validated
 | 
			
		||||
     */
 | 
			
		||||
    @Override
 | 
			
		||||
    public void validate(Action action)
 | 
			
		||||
    {
 | 
			
		||||
        final ActionDefinition actionDefinition = actions.getRuleActionDefinitionById(action.getActionDefinitionId());
 | 
			
		||||
        final List<ActionDefinition.ParameterDefinition> nodeRefParams = actionDefinition.getParameterDefinitions().stream()
 | 
			
		||||
                .filter(pd -> NODE_REF.toPrefixString(namespaceService).equals(pd.getType()))
 | 
			
		||||
                .collect(Collectors.toList());
 | 
			
		||||
        validateNodes(nodeRefParams, action);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @return List of action definitions applicable to this validator
 | 
			
		||||
     */
 | 
			
		||||
    @Override
 | 
			
		||||
    public List<String> getActionDefinitionIds()
 | 
			
		||||
    {
 | 
			
		||||
        return List.of(CopyActionExecuter.NAME, MoveActionExecuter.NAME, CheckOutActionExecuter.NAME, ImporterActionExecuter.NAME,
 | 
			
		||||
                LinkCategoryActionExecuter.NAME, SimpleWorkflowActionExecuter.NAME, TransformActionExecuter.NAME,
 | 
			
		||||
                ImageTransformActionExecuter.NAME);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public int getPriority()
 | 
			
		||||
    {
 | 
			
		||||
        return Integer.MIN_VALUE + 1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void validateNodes(final List<ActionDefinition.ParameterDefinition> nodeRefParamDefinitions,
 | 
			
		||||
                               final Action action)
 | 
			
		||||
    {
 | 
			
		||||
        if (MapUtils.isNotEmpty(action.getParams()))
 | 
			
		||||
        {
 | 
			
		||||
            nodeRefParamDefinitions.stream()
 | 
			
		||||
                    .filter(pd -> action.getParams().containsKey(pd.getName()))
 | 
			
		||||
                    .forEach(p -> {
 | 
			
		||||
                        final String nodeId = Objects.toString(action.getParams().get(p.getName()), Strings.EMPTY);
 | 
			
		||||
                        final NodeRef nodeRef = nodes.validateNode(nodeId);
 | 
			
		||||
                        validatePermission(action.getActionDefinitionId(), p.getName(), nodeRef);
 | 
			
		||||
                        validateType(action.getActionDefinitionId(), nodeRef);
 | 
			
		||||
                    });
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void validatePermission(final String actionDefinitionId, final String paramName, final NodeRef nodeRef)
 | 
			
		||||
    {
 | 
			
		||||
        if (permissionService.hasReadPermission(nodeRef) != ALLOWED)
 | 
			
		||||
        {
 | 
			
		||||
            throw new EntityNotFoundException(nodeRef.getId());
 | 
			
		||||
        }
 | 
			
		||||
        if (!REQUIRE_READ_PERMISSION_PARAMS.containsKey(actionDefinitionId) ||
 | 
			
		||||
                REQUIRE_READ_PERMISSION_PARAMS.get(actionDefinitionId).stream().noneMatch(paramName::equals))
 | 
			
		||||
        {
 | 
			
		||||
            if (permissionService.hasPermission(nodeRef, WRITE) != ALLOWED)
 | 
			
		||||
            {
 | 
			
		||||
                throw new PermissionDeniedException(NO_PROPER_PERMISSIONS_FOR_NODE + nodeRef.getId());
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void validateType(final String actionDefinitionId, final NodeRef nodeRef)
 | 
			
		||||
    {
 | 
			
		||||
        if (!LinkCategoryActionExecuter.NAME.equals(actionDefinitionId))
 | 
			
		||||
        {
 | 
			
		||||
            if (!nodes.nodeMatches(nodeRef, Set.of(TYPE_FOLDER), Collections.emptySet()))
 | 
			
		||||
            {
 | 
			
		||||
                throw new InvalidArgumentException(NOT_A_FOLDER + nodeRef.getId());
 | 
			
		||||
            }
 | 
			
		||||
        } else if (!nodes.nodeMatches(nodeRef, Set.of(TYPE_CATEGORY), Collections.emptySet()))
 | 
			
		||||
        {
 | 
			
		||||
            throw new InvalidArgumentException(NOT_A_CATEGORY + nodeRef.getId());
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -27,7 +27,11 @@
 | 
			
		||||
package org.alfresco.rest.api.impl.validator.actions;
 | 
			
		||||
 | 
			
		||||
import java.io.Serializable;
 | 
			
		||||
import java.util.Collections;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.Objects;
 | 
			
		||||
import java.util.stream.Collectors;
 | 
			
		||||
 | 
			
		||||
import org.alfresco.rest.api.Actions;
 | 
			
		||||
import org.alfresco.rest.api.actions.ActionValidator;
 | 
			
		||||
@@ -39,6 +43,7 @@ import org.alfresco.rest.framework.core.exceptions.NotFoundException;
 | 
			
		||||
import org.alfresco.service.Experimental;
 | 
			
		||||
import org.apache.commons.collections.CollectionUtils;
 | 
			
		||||
import org.apache.commons.collections.MapUtils;
 | 
			
		||||
import org.apache.logging.log4j.util.Strings;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * This class will validate all action types against action parameters definitions (mandatory parameters, parameter constraints)
 | 
			
		||||
@@ -46,14 +51,14 @@ import org.apache.commons.collections.MapUtils;
 | 
			
		||||
@Experimental
 | 
			
		||||
public class ActionParameterDefinitionValidator implements ActionValidator
 | 
			
		||||
{
 | 
			
		||||
    private static final boolean IS_ENABLED = true;
 | 
			
		||||
    static final String INVALID_PARAMETER_VALUE =
 | 
			
		||||
            "Action parameter: %s has invalid value (%s). Look up possible values for constraint name %s";
 | 
			
		||||
    static final String MISSING_PARAMETER = "Missing action's mandatory parameter: %s";
 | 
			
		||||
    static final String MUST_NOT_CONTAIN_PARAMETER = "Action of definition id: %s must not contain parameter of name: %s";
 | 
			
		||||
    static final String PARAMS_SHOULD_NOT_BE_EMPTY =
 | 
			
		||||
            "Action parameters should not be null or empty for this action. See Action Definition for action of: %s";
 | 
			
		||||
    static final String INVALID_ACTION_DEFINITION = "Invalid action definition requested %s";
 | 
			
		||||
    static final String INVALID_ACTION_DEFINITION = "Invalid rule action definition requested %s";
 | 
			
		||||
    static final String EMPTY_ACTION_DEFINITION = "Empty/null rule action definition id";
 | 
			
		||||
 | 
			
		||||
    private final Actions actions;
 | 
			
		||||
 | 
			
		||||
@@ -71,51 +76,81 @@ public class ActionParameterDefinitionValidator implements ActionValidator
 | 
			
		||||
    public void validate(Action action)
 | 
			
		||||
    {
 | 
			
		||||
        ActionDefinition actionDefinition;
 | 
			
		||||
        final String actionDefinitionId = action.getActionDefinitionId();
 | 
			
		||||
        if (Strings.isBlank(actionDefinitionId))
 | 
			
		||||
        {
 | 
			
		||||
            throw new InvalidArgumentException(EMPTY_ACTION_DEFINITION);
 | 
			
		||||
        }
 | 
			
		||||
        try
 | 
			
		||||
        {
 | 
			
		||||
            actionDefinition = actions.getActionDefinitionById(action.getActionDefinitionId());
 | 
			
		||||
        } catch (NotFoundException e) {
 | 
			
		||||
            throw new InvalidArgumentException(String.format(INVALID_ACTION_DEFINITION, action.getActionDefinitionId()));
 | 
			
		||||
            actionDefinition = actions.getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        } catch (NotFoundException e)
 | 
			
		||||
        {
 | 
			
		||||
            throw new InvalidArgumentException(String.format(INVALID_ACTION_DEFINITION, actionDefinitionId));
 | 
			
		||||
        }
 | 
			
		||||
        validateParametersSize(action.getParams(), actionDefinition);
 | 
			
		||||
        final Map<String, Serializable> params = action.getParams();
 | 
			
		||||
        if (MapUtils.isNotEmpty(params))
 | 
			
		||||
        {
 | 
			
		||||
            params.forEach((key, value) -> checkParameterShouldExist(key, actionDefinition));
 | 
			
		||||
            actionDefinition.getParameterDefinitions().forEach(p -> validateParameterDefinitions(p, params));
 | 
			
		||||
            getParameterDefinitions(actionDefinition).forEach(p -> validateParameterDefinitions(p, params));
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * This validator should be applied to all actions
 | 
			
		||||
     *
 | 
			
		||||
     * @return list of all defined action definition ids
 | 
			
		||||
     */
 | 
			
		||||
    @Override
 | 
			
		||||
    public boolean isEnabled()
 | 
			
		||||
    public List<String> getActionDefinitionIds()
 | 
			
		||||
    {
 | 
			
		||||
        return IS_ENABLED;
 | 
			
		||||
        return List.of(ALL_ACTIONS);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * This validator should have highest priority and be executed first of all (thus minimal integer is returned here).
 | 
			
		||||
     *
 | 
			
		||||
     * @return minimal integer value
 | 
			
		||||
     */
 | 
			
		||||
    @Override
 | 
			
		||||
    public int getPriority()
 | 
			
		||||
    {
 | 
			
		||||
        return Integer.MIN_VALUE;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void validateParametersSize(final Map<String, Serializable> params, final ActionDefinition actionDefinition)
 | 
			
		||||
    {
 | 
			
		||||
        if (CollectionUtils.isNotEmpty(actionDefinition.getParameterDefinitions()) && MapUtils.isEmpty(params))
 | 
			
		||||
        final List<ActionDefinition.ParameterDefinition> parameterDefinitions = getParameterDefinitions(actionDefinition);
 | 
			
		||||
        if (CollectionUtils.isNotEmpty(
 | 
			
		||||
                parameterDefinitions.stream().filter(ActionDefinition.ParameterDefinition::isMandatory).collect(Collectors.toList())) &&
 | 
			
		||||
                MapUtils.isEmpty(params))
 | 
			
		||||
        {
 | 
			
		||||
            throw new IllegalArgumentException(String.format(PARAMS_SHOULD_NOT_BE_EMPTY, actionDefinition.getName()));
 | 
			
		||||
            throw new InvalidArgumentException(String.format(PARAMS_SHOULD_NOT_BE_EMPTY, actionDefinition.getName()));
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private List<ActionDefinition.ParameterDefinition> getParameterDefinitions(ActionDefinition actionDefinition)
 | 
			
		||||
    {
 | 
			
		||||
        return actionDefinition.getParameterDefinitions() == null ? Collections.emptyList() : actionDefinition.getParameterDefinitions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void validateParameterDefinitions(final ActionDefinition.ParameterDefinition parameterDefinition,
 | 
			
		||||
                                              final Map<String, Serializable> params)
 | 
			
		||||
    {
 | 
			
		||||
        final Serializable parameterValue = params.get(parameterDefinition.getName());
 | 
			
		||||
        if (parameterDefinition.isMandatory() && parameterValue == null)
 | 
			
		||||
        {
 | 
			
		||||
            throw new IllegalArgumentException(String.format(MISSING_PARAMETER, parameterDefinition.getName()));
 | 
			
		||||
            throw new InvalidArgumentException(String.format(MISSING_PARAMETER, parameterDefinition.getName()));
 | 
			
		||||
        }
 | 
			
		||||
        if (parameterDefinition.getParameterConstraintName() != null)
 | 
			
		||||
        {
 | 
			
		||||
            final ActionParameterConstraint actionConstraint =
 | 
			
		||||
                    actions.getActionConstraint(parameterDefinition.getParameterConstraintName());
 | 
			
		||||
            if (parameterValue != null && actionConstraint.getConstraintValues().stream()
 | 
			
		||||
                    .noneMatch(constraintData -> constraintData.getValue().equals(parameterValue.toString())))
 | 
			
		||||
                    .noneMatch(constraintData -> constraintData.getValue().equals(Objects.toString(parameterValue, null))))
 | 
			
		||||
            {
 | 
			
		||||
                throw new IllegalArgumentException(String.format(INVALID_PARAMETER_VALUE, parameterDefinition.getName(), parameterValue,
 | 
			
		||||
                throw new InvalidArgumentException(String.format(INVALID_PARAMETER_VALUE, parameterDefinition.getName(), parameterValue,
 | 
			
		||||
                        actionConstraint.getConstraintName()));
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
@@ -123,11 +158,9 @@ public class ActionParameterDefinitionValidator implements ActionValidator
 | 
			
		||||
 | 
			
		||||
    private void checkParameterShouldExist(final String parameterName, final ActionDefinition actionDefinition)
 | 
			
		||||
    {
 | 
			
		||||
        if (actionDefinition.getParameterDefinitions().stream().noneMatch(pd -> parameterName.equals(pd.getName())))
 | 
			
		||||
        if (getParameterDefinitions(actionDefinition).stream().noneMatch(pd -> parameterName.equals(pd.getName())))
 | 
			
		||||
        {
 | 
			
		||||
            throw new IllegalArgumentException(String.format(MUST_NOT_CONTAIN_PARAMETER, actionDefinition.getName(), parameterName));
 | 
			
		||||
            throw new InvalidArgumentException(String.format(MUST_NOT_CONTAIN_PARAMETER, actionDefinition.getName(), parameterName));
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -593,6 +593,12 @@
 | 
			
		||||
    <bean id="actionParameterConstraintsValidator" class="org.alfresco.rest.api.impl.validator.actions.ActionParameterDefinitionValidator">
 | 
			
		||||
        <constructor-arg name="actions" ref="Actions"/>
 | 
			
		||||
    </bean>
 | 
			
		||||
    <bean id="actionNodeParameterValidator" class="org.alfresco.rest.api.impl.validator.actions.ActionNodeParameterValidator">
 | 
			
		||||
        <constructor-arg name="actions" ref="Actions"/>
 | 
			
		||||
        <constructor-arg name="namespaceService" ref="NamespaceService"/>
 | 
			
		||||
        <constructor-arg name="nodes" ref="Nodes"/>
 | 
			
		||||
        <constructor-arg name="permissionService" ref="PermissionService"/>
 | 
			
		||||
    </bean>
 | 
			
		||||
 | 
			
		||||
    <!--    action parameter validators end here-->
 | 
			
		||||
 | 
			
		||||
@@ -977,6 +983,7 @@
 | 
			
		||||
        <constructor-arg name="actionValidators">
 | 
			
		||||
            <list>
 | 
			
		||||
                <ref bean="actionParameterConstraintsValidator"/>
 | 
			
		||||
                <ref bean="actionNodeParameterValidator"/>
 | 
			
		||||
            </list>
 | 
			
		||||
        </constructor-arg>
 | 
			
		||||
    </bean>
 | 
			
		||||
 
 | 
			
		||||
@@ -3,12 +3,13 @@ function main()
 | 
			
		||||
   // Get the args
 | 
			
		||||
   var siteShortName = url.templateArgs.shortname,
 | 
			
		||||
      site = siteService.getSite(siteShortName),
 | 
			
		||||
      filter = ((args.filter != null) ? args.filter : (args.shortNameFilter != null) ? args.shortNameFilter : "" )+ " [hint:useCQ]",
 | 
			
		||||
      maxResults = (args.maxResults == null) ? 10 : parseInt(args.maxResults, 10),
 | 
			
		||||
      authorityType = args.authorityType,
 | 
			
		||||
      zone = args.zone,
 | 
			
		||||
      sortBy = args.sortBy,
 | 
			
		||||
      sortAsc = args.dir != "desc";
 | 
			
		||||
   
 | 
			
		||||
  var filter;
 | 
			
		||||
 | 
			
		||||
 | 
			
		||||
   if (authorityType != null)
 | 
			
		||||
@@ -28,6 +29,7 @@ function main()
 | 
			
		||||
 | 
			
		||||
   if (authorityType == null || authorityType == "USER")
 | 
			
		||||
   {
 | 
			
		||||
      filter = ((args.filter != null) ? args.filter : (args.shortNameFilter != null) ? args.shortNameFilter : "" )+ " [hint:useCQ]";
 | 
			
		||||
      // Get the collection of people
 | 
			
		||||
      peopleFound = sortBy != null ? people.getPeople(filter, maxResults, sortBy, sortAsc) : people.getPeople(filter, maxResults);
 | 
			
		||||
 | 
			
		||||
@@ -67,6 +69,7 @@ function main()
 | 
			
		||||
 | 
			
		||||
   if (authorityType == null || authorityType == "GROUP")
 | 
			
		||||
   {
 | 
			
		||||
      filter = (args.filter != null) ? args.filter : (args.shortNameFilter != null) ? args.shortNameFilter : "";
 | 
			
		||||
      // Get the collection of groups
 | 
			
		||||
      paging = utils.createPaging(maxResults, -1);
 | 
			
		||||
      groupsFound = groups.getGroupsInZone(filter, zone, paging, "displayName");
 | 
			
		||||
@@ -96,4 +99,4 @@ function contains(arr, value) {
 | 
			
		||||
    return false;
 | 
			
		||||
}
 | 
			
		||||
 | 
			
		||||
main();
 | 
			
		||||
main();
 | 
			
		||||
 
 | 
			
		||||
@@ -36,6 +36,8 @@ import org.alfresco.rest.api.impl.rules.NodeValidatorTest;
 | 
			
		||||
import org.alfresco.rest.api.impl.rules.RuleLoaderTest;
 | 
			
		||||
import org.alfresco.rest.api.impl.rules.RuleSetsImplTest;
 | 
			
		||||
import org.alfresco.rest.api.impl.rules.RulesImplTest;
 | 
			
		||||
import org.alfresco.rest.api.impl.validator.actions.ActionNodeParameterValidatorTest;
 | 
			
		||||
import org.alfresco.rest.api.impl.validator.actions.ActionParameterDefinitionValidatorTest;
 | 
			
		||||
import org.alfresco.rest.api.rules.NodeRuleSetsRelationTest;
 | 
			
		||||
import org.alfresco.rest.api.rules.NodeRulesRelationTest;
 | 
			
		||||
import org.alfresco.service.Experimental;
 | 
			
		||||
@@ -53,6 +55,8 @@ import org.junit.runners.Suite;
 | 
			
		||||
    RuleLoaderTest.class,
 | 
			
		||||
    ActionParameterConverterTest.class,
 | 
			
		||||
    ActionPermissionValidatorTest.class,
 | 
			
		||||
    ActionParameterDefinitionValidatorTest.class,
 | 
			
		||||
    ActionNodeParameterValidatorTest.class,
 | 
			
		||||
    RestRuleSimpleConditionModelMapperTest.class,
 | 
			
		||||
    RestRuleCompositeConditionModelMapperTest.class,
 | 
			
		||||
    RestRuleActionModelMapperTest.class,
 | 
			
		||||
 
 | 
			
		||||
@@ -76,7 +76,6 @@ public class RestRuleActionModelMapperTest
 | 
			
		||||
    @Before
 | 
			
		||||
    public void setUp() {
 | 
			
		||||
        objectUnderTest = new RestRuleActionModelMapper(parameterConverter, List.of(sampleValidatorMock));
 | 
			
		||||
        given(sampleValidatorMock.isEnabled()).willReturn(true);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
 
 | 
			
		||||
@@ -44,6 +44,7 @@ import java.io.Serializable;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
 | 
			
		||||
import com.fasterxml.jackson.core.JsonProcessingException;
 | 
			
		||||
import org.alfresco.repo.action.executer.AddFeaturesActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.CheckInActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.CheckOutActionExecuter;
 | 
			
		||||
@@ -56,6 +57,7 @@ import org.alfresco.repo.action.executer.SetPropertyValueActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.SimpleWorkflowActionExecuter;
 | 
			
		||||
import org.alfresco.rest.api.Nodes;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.NotFoundException;
 | 
			
		||||
import org.alfresco.service.Experimental;
 | 
			
		||||
import org.alfresco.service.cmr.action.ActionDefinition;
 | 
			
		||||
@@ -67,6 +69,7 @@ import org.alfresco.service.cmr.repository.NodeRef;
 | 
			
		||||
import org.alfresco.service.cmr.security.PermissionService;
 | 
			
		||||
import org.alfresco.service.namespace.NamespaceService;
 | 
			
		||||
import org.alfresco.service.namespace.QName;
 | 
			
		||||
import org.apache.logging.log4j.util.Strings;
 | 
			
		||||
import org.junit.Before;
 | 
			
		||||
import org.junit.Test;
 | 
			
		||||
import org.junit.runner.RunWith;
 | 
			
		||||
@@ -609,6 +612,28 @@ public class ActionParameterConverterTest
 | 
			
		||||
        assertThatExceptionOfType(EntityNotFoundException.class).isThrownBy(() -> objectUnderTest.getConvertedParams(params, name));
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testNullParamValue()
 | 
			
		||||
    {
 | 
			
		||||
        final String name = CheckOutActionExecuter.NAME;
 | 
			
		||||
        final String destinationFolderKey = CheckOutActionExecuter.PARAM_DESTINATION_FOLDER;
 | 
			
		||||
        final String assocNameKey = CheckOutActionExecuter.PARAM_ASSOC_QNAME;
 | 
			
		||||
        final String assocTypeKey = CheckOutActionExecuter.PARAM_ASSOC_TYPE_QNAME;
 | 
			
		||||
        final Map<String, Serializable> params =
 | 
			
		||||
                Map.of(destinationFolderKey, Strings.EMPTY, assocNameKey, Strings.EMPTY, assocTypeKey, Strings.EMPTY);
 | 
			
		||||
 | 
			
		||||
        given(actionService.getActionDefinition(name)).willReturn(actionDefinition);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThrows(InvalidArgumentException.class, () ->objectUnderTest.getConvertedParams(params, name));
 | 
			
		||||
 | 
			
		||||
        then(actionService).should().getActionDefinition(name);
 | 
			
		||||
        then(actionService).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(actionDefinition).shouldHaveNoInteractions();
 | 
			
		||||
        then(dictionaryService).shouldHaveNoInteractions();
 | 
			
		||||
        then(namespaceService).shouldHaveNoInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testInvalidActionDefinitionConversion() {
 | 
			
		||||
        final String invalidName = "dummy-definition";
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,366 @@
 | 
			
		||||
/*
 | 
			
		||||
 * #%L
 | 
			
		||||
 * Alfresco Remote API
 | 
			
		||||
 * %%
 | 
			
		||||
 * Copyright (C) 2005 - 2022 Alfresco Software Limited
 | 
			
		||||
 * %%
 | 
			
		||||
 * This file is part of the Alfresco software.
 | 
			
		||||
 * If the software was purchased under a paid Alfresco license, the terms of
 | 
			
		||||
 * the paid license agreement will prevail.  Otherwise, the software is
 | 
			
		||||
 * provided under the following open source license terms:
 | 
			
		||||
 *
 | 
			
		||||
 * Alfresco is free software: you can redistribute it and/or modify
 | 
			
		||||
 * it under the terms of the GNU Lesser General Public License as published by
 | 
			
		||||
 * the Free Software Foundation, either version 3 of the License, or
 | 
			
		||||
 * (at your option) any later version.
 | 
			
		||||
 *
 | 
			
		||||
 * Alfresco is distributed in the hope that it will be useful,
 | 
			
		||||
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
 *  GNU Lesser General Public License for more details.
 | 
			
		||||
 *
 | 
			
		||||
 * You should have received a copy of the GNU Lesser General Public License
 | 
			
		||||
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 * #L%
 | 
			
		||||
 */
 | 
			
		||||
 | 
			
		||||
package org.alfresco.rest.api.impl.validator.actions;
 | 
			
		||||
 | 
			
		||||
import static org.alfresco.model.ContentModel.TYPE_CATEGORY;
 | 
			
		||||
import static org.alfresco.model.ContentModel.TYPE_FOLDER;
 | 
			
		||||
import static org.alfresco.rest.api.impl.validator.actions.ActionNodeParameterValidator.NOT_A_CATEGORY;
 | 
			
		||||
import static org.alfresco.rest.api.impl.validator.actions.ActionNodeParameterValidator.NOT_A_FOLDER;
 | 
			
		||||
import static org.alfresco.rest.api.impl.validator.actions.ActionNodeParameterValidator.NO_PROPER_PERMISSIONS_FOR_NODE;
 | 
			
		||||
import static org.alfresco.rest.api.impl.validator.actions.ActionNodeParameterValidator.REQUIRE_READ_PERMISSION_PARAMS;
 | 
			
		||||
import static org.alfresco.service.cmr.dictionary.DataTypeDefinition.CATEGORY;
 | 
			
		||||
import static org.alfresco.service.cmr.dictionary.DataTypeDefinition.NODE_REF;
 | 
			
		||||
import static org.alfresco.service.cmr.dictionary.DataTypeDefinition.TEXT;
 | 
			
		||||
import static org.alfresco.service.cmr.repository.StoreRef.STORE_REF_WORKSPACE_SPACESSTORE;
 | 
			
		||||
import static org.alfresco.service.namespace.NamespaceService.DEFAULT_PREFIX;
 | 
			
		||||
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 | 
			
		||||
import static org.junit.Assert.assertEquals;
 | 
			
		||||
import static org.mockito.BDDMockito.given;
 | 
			
		||||
import static org.mockito.BDDMockito.then;
 | 
			
		||||
 | 
			
		||||
import java.util.Collections;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
import java.util.Map;
 | 
			
		||||
import java.util.Set;
 | 
			
		||||
 | 
			
		||||
import org.alfresco.repo.action.executer.CheckOutActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.CopyActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.ImageTransformActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.ImporterActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.LinkCategoryActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.MoveActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.SimpleWorkflowActionExecuter;
 | 
			
		||||
import org.alfresco.repo.action.executer.TransformActionExecuter;
 | 
			
		||||
import org.alfresco.rest.api.Actions;
 | 
			
		||||
import org.alfresco.rest.api.Nodes;
 | 
			
		||||
import org.alfresco.rest.api.model.ActionDefinition;
 | 
			
		||||
import org.alfresco.rest.api.model.rules.Action;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.EntityNotFoundException;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.PermissionDeniedException;
 | 
			
		||||
import org.alfresco.service.cmr.repository.NodeRef;
 | 
			
		||||
import org.alfresco.service.cmr.security.AccessStatus;
 | 
			
		||||
import org.alfresco.service.cmr.security.PermissionService;
 | 
			
		||||
import org.alfresco.service.namespace.NamespaceService;
 | 
			
		||||
import org.junit.Test;
 | 
			
		||||
import org.junit.runner.RunWith;
 | 
			
		||||
import org.mockito.InjectMocks;
 | 
			
		||||
import org.mockito.Mock;
 | 
			
		||||
import org.mockito.junit.MockitoJUnitRunner;
 | 
			
		||||
 | 
			
		||||
@RunWith(MockitoJUnitRunner.class)
 | 
			
		||||
public class ActionNodeParameterValidatorTest
 | 
			
		||||
{
 | 
			
		||||
    private static final String READ_RIGHTS_REQUIRED_DEFINITION_ID = LinkCategoryActionExecuter.NAME;
 | 
			
		||||
    private static final String CATEGORY_NODE_REF_PARAM = REQUIRE_READ_PERMISSION_PARAMS.get(READ_RIGHTS_REQUIRED_DEFINITION_ID).get(0);
 | 
			
		||||
    private static final String DESTINATION_FOLDER_PARAM = "destination-folder";
 | 
			
		||||
    private static final String NODE_ID = "node-id";
 | 
			
		||||
    private static final String COPY_ACTION = CopyActionExecuter.NAME;
 | 
			
		||||
 | 
			
		||||
    @Mock
 | 
			
		||||
    private Actions actionsMock;
 | 
			
		||||
    @Mock
 | 
			
		||||
    private NamespaceService namespaceServiceMock;
 | 
			
		||||
    @Mock
 | 
			
		||||
    private Nodes nodesMock;
 | 
			
		||||
    @Mock
 | 
			
		||||
    private PermissionService permissionServiceMock;
 | 
			
		||||
 | 
			
		||||
    @InjectMocks
 | 
			
		||||
    private ActionNodeParameterValidator objectUnderTest;
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testProperPermissionsForReadRights()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        action.setActionDefinitionId(READ_RIGHTS_REQUIRED_DEFINITION_ID);
 | 
			
		||||
        action.setParams(Map.of(CATEGORY_NODE_REF_PARAM, NODE_ID));
 | 
			
		||||
        ActionDefinition.ParameterDefinition parameterDef =
 | 
			
		||||
                new ActionDefinition.ParameterDefinition(CATEGORY_NODE_REF_PARAM, NODE_REF.toPrefixString(), false, true, null, null);
 | 
			
		||||
        final ActionDefinition actionDefinition =
 | 
			
		||||
                new ActionDefinition(COPY_ACTION, COPY_ACTION, null, null, null, false, false,
 | 
			
		||||
                        List.of(parameterDef));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(READ_RIGHTS_REQUIRED_DEFINITION_ID)).willReturn(actionDefinition);
 | 
			
		||||
        given(namespaceServiceMock.getPrefixes(NODE_REF.getNamespaceURI())).willReturn(List.of(DEFAULT_PREFIX));
 | 
			
		||||
        final NodeRef nodeRef = new NodeRef(STORE_REF_WORKSPACE_SPACESSTORE, NODE_ID);
 | 
			
		||||
        given(nodesMock.validateNode(NODE_ID)).willReturn(nodeRef);
 | 
			
		||||
        given(permissionServiceMock.hasReadPermission(nodeRef)).willReturn(AccessStatus.ALLOWED);
 | 
			
		||||
        given(nodesMock.nodeMatches(nodeRef, Set.of(TYPE_CATEGORY), Collections.emptySet())).willReturn(true);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        objectUnderTest.validate(action);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(READ_RIGHTS_REQUIRED_DEFINITION_ID);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(namespaceServiceMock).should().getPrefixes(NODE_REF.getNamespaceURI());
 | 
			
		||||
        then(namespaceServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(nodesMock).should().validateNode(NODE_ID);
 | 
			
		||||
        then(nodesMock).should().nodeMatches(nodeRef, Set.of(TYPE_CATEGORY), Collections.emptySet());
 | 
			
		||||
        then(nodesMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(permissionServiceMock).should().hasReadPermission(nodeRef);
 | 
			
		||||
        then(permissionServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testNotEnoughPermissionsForReadRights()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        action.setActionDefinitionId(COPY_ACTION);
 | 
			
		||||
        action.setParams(Map.of(DESTINATION_FOLDER_PARAM, NODE_ID));
 | 
			
		||||
        ActionDefinition.ParameterDefinition parameterDef =
 | 
			
		||||
                new ActionDefinition.ParameterDefinition(DESTINATION_FOLDER_PARAM, NODE_REF.toPrefixString(), false, true, null, null);
 | 
			
		||||
        final ActionDefinition actionDefinition =
 | 
			
		||||
                new ActionDefinition(COPY_ACTION, COPY_ACTION, null, null, null, false, false,
 | 
			
		||||
                        List.of(parameterDef));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(COPY_ACTION)).willReturn(actionDefinition);
 | 
			
		||||
        given(namespaceServiceMock.getPrefixes(NODE_REF.getNamespaceURI())).willReturn(List.of(DEFAULT_PREFIX));
 | 
			
		||||
        final NodeRef nodeRef = new NodeRef(STORE_REF_WORKSPACE_SPACESSTORE, NODE_ID);
 | 
			
		||||
        given(nodesMock.validateNode(NODE_ID)).willReturn(nodeRef);
 | 
			
		||||
        given(permissionServiceMock.hasReadPermission(nodeRef)).willReturn(AccessStatus.DENIED);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(EntityNotFoundException.class).isThrownBy(() -> objectUnderTest.validate(action));
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(COPY_ACTION);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(namespaceServiceMock).should().getPrefixes(NODE_REF.getNamespaceURI());
 | 
			
		||||
        then(namespaceServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(nodesMock).should().validateNode(NODE_ID);
 | 
			
		||||
        then(nodesMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(permissionServiceMock).should().hasReadPermission(nodeRef);
 | 
			
		||||
        then(permissionServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testValidateForNodeNotFound()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        action.setActionDefinitionId(COPY_ACTION);
 | 
			
		||||
        action.setParams(Map.of(DESTINATION_FOLDER_PARAM, NODE_ID));
 | 
			
		||||
        ActionDefinition.ParameterDefinition parameterDef =
 | 
			
		||||
                new ActionDefinition.ParameterDefinition(DESTINATION_FOLDER_PARAM, NODE_REF.toPrefixString(), false, true, null, null);
 | 
			
		||||
        final ActionDefinition actionDefinition =
 | 
			
		||||
                new ActionDefinition(COPY_ACTION, COPY_ACTION, null, null, null, false, false,
 | 
			
		||||
                        List.of(parameterDef));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(COPY_ACTION)).willReturn(actionDefinition);
 | 
			
		||||
        given(namespaceServiceMock.getPrefixes(NODE_REF.getNamespaceURI())).willReturn(List.of(DEFAULT_PREFIX));
 | 
			
		||||
        given(nodesMock.validateNode(NODE_ID)).willThrow(EntityNotFoundException.class);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(EntityNotFoundException.class).isThrownBy(() -> objectUnderTest.validate(action));
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(COPY_ACTION);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(namespaceServiceMock).should().getPrefixes(NODE_REF.getNamespaceURI());
 | 
			
		||||
        then(namespaceServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(nodesMock).should().validateNode(NODE_ID);
 | 
			
		||||
        then(nodesMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(permissionServiceMock).shouldHaveNoInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testProperPermissionsForWriteRights()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        action.setActionDefinitionId(COPY_ACTION);
 | 
			
		||||
        action.setParams(Map.of(DESTINATION_FOLDER_PARAM, NODE_ID));
 | 
			
		||||
        ActionDefinition.ParameterDefinition parameterDef =
 | 
			
		||||
                new ActionDefinition.ParameterDefinition(DESTINATION_FOLDER_PARAM, NODE_REF.toPrefixString(), false, true, null, null);
 | 
			
		||||
        final ActionDefinition actionDefinition =
 | 
			
		||||
                new ActionDefinition(COPY_ACTION, COPY_ACTION, null, null, null, false, false,
 | 
			
		||||
                        List.of(parameterDef));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(COPY_ACTION)).willReturn(actionDefinition);
 | 
			
		||||
        given(namespaceServiceMock.getPrefixes(NODE_REF.getNamespaceURI())).willReturn(List.of(DEFAULT_PREFIX));
 | 
			
		||||
        final NodeRef nodeRef = new NodeRef(STORE_REF_WORKSPACE_SPACESSTORE, NODE_ID);
 | 
			
		||||
        given(nodesMock.validateNode(NODE_ID)).willReturn(nodeRef);
 | 
			
		||||
        given(permissionServiceMock.hasReadPermission(nodeRef)).willReturn(AccessStatus.ALLOWED);
 | 
			
		||||
        given(permissionServiceMock.hasPermission(nodeRef, PermissionService.WRITE)).willReturn(AccessStatus.ALLOWED);
 | 
			
		||||
        given(nodesMock.nodeMatches(nodeRef, Set.of(TYPE_FOLDER), Collections.emptySet())).willReturn(true);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        objectUnderTest.validate(action);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(COPY_ACTION);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(namespaceServiceMock).should().getPrefixes(NODE_REF.getNamespaceURI());
 | 
			
		||||
        then(namespaceServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(nodesMock).should().validateNode(NODE_ID);
 | 
			
		||||
        then(nodesMock).should().nodeMatches(nodeRef, Set.of(TYPE_FOLDER), Collections.emptySet());
 | 
			
		||||
        then(nodesMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(permissionServiceMock).should().hasReadPermission(nodeRef);
 | 
			
		||||
        then(permissionServiceMock).should().hasPermission(nodeRef, PermissionService.WRITE);
 | 
			
		||||
        then(permissionServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testNotEnoughPermissionsForWriteRights()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        action.setActionDefinitionId(COPY_ACTION);
 | 
			
		||||
        action.setParams(Map.of(DESTINATION_FOLDER_PARAM, NODE_ID));
 | 
			
		||||
        ActionDefinition.ParameterDefinition parameterDef =
 | 
			
		||||
                new ActionDefinition.ParameterDefinition(DESTINATION_FOLDER_PARAM, NODE_REF.toPrefixString(), false, true, null, null);
 | 
			
		||||
        final ActionDefinition actionDefinition =
 | 
			
		||||
                new ActionDefinition(COPY_ACTION, COPY_ACTION, null, null, null, false, false,
 | 
			
		||||
                        List.of(parameterDef));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(COPY_ACTION)).willReturn(actionDefinition);
 | 
			
		||||
        given(namespaceServiceMock.getPrefixes(NODE_REF.getNamespaceURI())).willReturn(List.of(DEFAULT_PREFIX));
 | 
			
		||||
        final NodeRef nodeRef = new NodeRef(STORE_REF_WORKSPACE_SPACESSTORE, NODE_ID);
 | 
			
		||||
        given(nodesMock.validateNode(NODE_ID)).willReturn(nodeRef);
 | 
			
		||||
        given(permissionServiceMock.hasReadPermission(nodeRef)).willReturn(AccessStatus.ALLOWED);
 | 
			
		||||
        given(permissionServiceMock.hasPermission(nodeRef, PermissionService.WRITE)).willReturn(AccessStatus.DENIED);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(PermissionDeniedException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
                .withMessageContaining(NO_PROPER_PERMISSIONS_FOR_NODE + NODE_ID);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(COPY_ACTION);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(namespaceServiceMock).should().getPrefixes(NODE_REF.getNamespaceURI());
 | 
			
		||||
        then(namespaceServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(nodesMock).should().validateNode(NODE_ID);
 | 
			
		||||
        then(nodesMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(permissionServiceMock).should().hasReadPermission(nodeRef);
 | 
			
		||||
        then(permissionServiceMock).should().hasPermission(nodeRef, PermissionService.WRITE);
 | 
			
		||||
        then(permissionServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testNoValidationExecutedForNonNodeRefParam()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        action.setActionDefinitionId(COPY_ACTION);
 | 
			
		||||
        final String dummyParam = "dummyParam";
 | 
			
		||||
        action.setParams(Map.of(dummyParam, "dummyValue"));
 | 
			
		||||
        ActionDefinition.ParameterDefinition parameterDef =
 | 
			
		||||
                new ActionDefinition.ParameterDefinition(dummyParam, TEXT.toPrefixString(), false, true, null, null);
 | 
			
		||||
        final ActionDefinition actionDefinition =
 | 
			
		||||
                new ActionDefinition(COPY_ACTION, COPY_ACTION, null, null, null, false, false,
 | 
			
		||||
                        List.of(parameterDef));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(COPY_ACTION)).willReturn(actionDefinition);
 | 
			
		||||
        given(namespaceServiceMock.getPrefixes(NODE_REF.getNamespaceURI())).willReturn(List.of(DEFAULT_PREFIX));
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        objectUnderTest.validate(action);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(COPY_ACTION);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(namespaceServiceMock).should().getPrefixes(NODE_REF.getNamespaceURI());
 | 
			
		||||
        then(namespaceServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(nodesMock).shouldHaveNoInteractions();
 | 
			
		||||
        then(permissionServiceMock).shouldHaveNoInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testWrongTypeOfNodeWhenFolderExpected()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        action.setActionDefinitionId(COPY_ACTION);
 | 
			
		||||
        action.setParams(Map.of(DESTINATION_FOLDER_PARAM, NODE_ID));
 | 
			
		||||
        ActionDefinition.ParameterDefinition parameterDef =
 | 
			
		||||
                new ActionDefinition.ParameterDefinition(DESTINATION_FOLDER_PARAM, NODE_REF.toPrefixString(), false, true, null, null);
 | 
			
		||||
        final ActionDefinition actionDefinition =
 | 
			
		||||
                new ActionDefinition(COPY_ACTION, COPY_ACTION, null, null, null, false, false,
 | 
			
		||||
                        List.of(parameterDef));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(COPY_ACTION)).willReturn(actionDefinition);
 | 
			
		||||
        given(namespaceServiceMock.getPrefixes(NODE_REF.getNamespaceURI())).willReturn(List.of(DEFAULT_PREFIX));
 | 
			
		||||
        final NodeRef nodeRef = new NodeRef(STORE_REF_WORKSPACE_SPACESSTORE, NODE_ID);
 | 
			
		||||
        given(nodesMock.validateNode(NODE_ID)).willReturn(nodeRef);
 | 
			
		||||
        given(permissionServiceMock.hasReadPermission(nodeRef)).willReturn(AccessStatus.ALLOWED);
 | 
			
		||||
        given(permissionServiceMock.hasPermission(nodeRef, PermissionService.WRITE)).willReturn(AccessStatus.ALLOWED);
 | 
			
		||||
        given(nodesMock.nodeMatches(nodeRef, Set.of(TYPE_FOLDER), Collections.emptySet())).willReturn(false);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(InvalidArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
                .withMessageContaining(NOT_A_FOLDER + NODE_ID);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(COPY_ACTION);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(namespaceServiceMock).should().getPrefixes(NODE_REF.getNamespaceURI());
 | 
			
		||||
        then(namespaceServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(nodesMock).should().validateNode(NODE_ID);
 | 
			
		||||
        then(nodesMock).should().nodeMatches(nodeRef, Set.of(TYPE_FOLDER), Collections.emptySet());
 | 
			
		||||
        then(nodesMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(permissionServiceMock).should().hasReadPermission(nodeRef);
 | 
			
		||||
        then(permissionServiceMock).should().hasPermission(nodeRef, PermissionService.WRITE);
 | 
			
		||||
        then(permissionServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testWrongTypeOfNodeWhenCategoryExpected()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        action.setActionDefinitionId(READ_RIGHTS_REQUIRED_DEFINITION_ID);
 | 
			
		||||
        action.setParams(Map.of(CATEGORY_NODE_REF_PARAM, NODE_ID));
 | 
			
		||||
        ActionDefinition.ParameterDefinition parameterDef =
 | 
			
		||||
                new ActionDefinition.ParameterDefinition(CATEGORY_NODE_REF_PARAM, NODE_REF.toPrefixString(), false, true, null, null);
 | 
			
		||||
        final ActionDefinition actionDefinition =
 | 
			
		||||
                new ActionDefinition(READ_RIGHTS_REQUIRED_DEFINITION_ID, READ_RIGHTS_REQUIRED_DEFINITION_ID, null, null, null, false, false,
 | 
			
		||||
                        List.of(parameterDef));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(READ_RIGHTS_REQUIRED_DEFINITION_ID)).willReturn(actionDefinition);
 | 
			
		||||
        given(namespaceServiceMock.getPrefixes(NODE_REF.getNamespaceURI())).willReturn(List.of(DEFAULT_PREFIX));
 | 
			
		||||
        final NodeRef nodeRef = new NodeRef(STORE_REF_WORKSPACE_SPACESSTORE, NODE_ID);
 | 
			
		||||
        given(nodesMock.validateNode(NODE_ID)).willReturn(nodeRef);
 | 
			
		||||
        given(permissionServiceMock.hasReadPermission(nodeRef)).willReturn(AccessStatus.ALLOWED);
 | 
			
		||||
        given(nodesMock.nodeMatches(nodeRef, Set.of(TYPE_CATEGORY), Collections.emptySet())).willReturn(false);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(InvalidArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
                .withMessageContaining(NOT_A_CATEGORY + NODE_ID);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(READ_RIGHTS_REQUIRED_DEFINITION_ID);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(namespaceServiceMock).should().getPrefixes(NODE_REF.getNamespaceURI());
 | 
			
		||||
        then(namespaceServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(nodesMock).should().validateNode(NODE_ID);
 | 
			
		||||
        then(nodesMock).should().nodeMatches(nodeRef, Set.of(TYPE_CATEGORY), Collections.emptySet());
 | 
			
		||||
        then(nodesMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
        then(permissionServiceMock).should().hasReadPermission(nodeRef);
 | 
			
		||||
        then(permissionServiceMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testGetDefinitionIds()
 | 
			
		||||
    {
 | 
			
		||||
        final List<String> expectedIds =
 | 
			
		||||
                List.of(CopyActionExecuter.NAME, MoveActionExecuter.NAME, CheckOutActionExecuter.NAME, ImporterActionExecuter.NAME,
 | 
			
		||||
                        LinkCategoryActionExecuter.NAME, SimpleWorkflowActionExecuter.NAME, TransformActionExecuter.NAME,
 | 
			
		||||
                        ImageTransformActionExecuter.NAME);
 | 
			
		||||
        final List<String> actualIds = objectUnderTest.getActionDefinitionIds();
 | 
			
		||||
 | 
			
		||||
        assertEquals(expectedIds, actualIds);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testHasProperPriority()
 | 
			
		||||
    {
 | 
			
		||||
        final int expectedPriority = Integer.MIN_VALUE + 1;
 | 
			
		||||
        final int actualPriority = objectUnderTest.getPriority();
 | 
			
		||||
 | 
			
		||||
        assertEquals(expectedPriority, actualPriority);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -26,12 +26,16 @@
 | 
			
		||||
 | 
			
		||||
package org.alfresco.rest.api.impl.validator.actions;
 | 
			
		||||
 | 
			
		||||
import static org.alfresco.rest.api.impl.validator.actions.ActionParameterDefinitionValidator.EMPTY_ACTION_DEFINITION;
 | 
			
		||||
import static org.alfresco.rest.api.impl.validator.actions.ActionParameterDefinitionValidator.INVALID_ACTION_DEFINITION;
 | 
			
		||||
import static org.alfresco.rest.api.impl.validator.actions.ActionParameterDefinitionValidator.MISSING_PARAMETER;
 | 
			
		||||
import static org.alfresco.rest.api.impl.validator.actions.ActionParameterDefinitionValidator.MUST_NOT_CONTAIN_PARAMETER;
 | 
			
		||||
import static org.alfresco.rest.api.impl.validator.actions.ActionParameterDefinitionValidator.PARAMS_SHOULD_NOT_BE_EMPTY;
 | 
			
		||||
import static org.alfresco.service.cmr.dictionary.DataTypeDefinition.BOOLEAN;
 | 
			
		||||
import static org.alfresco.service.cmr.dictionary.DataTypeDefinition.TEXT;
 | 
			
		||||
import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
 | 
			
		||||
import static org.junit.Assert.assertEquals;
 | 
			
		||||
import static org.mockito.BDDMockito.given;
 | 
			
		||||
import static org.mockito.BDDMockito.then;
 | 
			
		||||
 | 
			
		||||
import java.util.Collections;
 | 
			
		||||
@@ -42,11 +46,12 @@ import java.util.Map;
 | 
			
		||||
import org.alfresco.rest.api.Actions;
 | 
			
		||||
import org.alfresco.rest.api.model.ActionDefinition;
 | 
			
		||||
import org.alfresco.rest.api.model.rules.Action;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.InvalidArgumentException;
 | 
			
		||||
import org.alfresco.rest.framework.core.exceptions.NotFoundException;
 | 
			
		||||
import org.alfresco.service.Experimental;
 | 
			
		||||
import org.alfresco.service.namespace.QName;
 | 
			
		||||
import org.junit.Test;
 | 
			
		||||
import org.junit.runner.RunWith;
 | 
			
		||||
import org.mockito.BDDMockito;
 | 
			
		||||
import org.mockito.InjectMocks;
 | 
			
		||||
import org.mockito.Mock;
 | 
			
		||||
import org.mockito.junit.MockitoJUnitRunner;
 | 
			
		||||
@@ -74,12 +79,12 @@ public class ActionParameterDefinitionValidatorTest
 | 
			
		||||
        final List<ActionDefinition.ParameterDefinition> parameterDefinitions =
 | 
			
		||||
                List.of(createParameterDefinition(MANDATORY_PARAM_KEY, TEXT, true, null));
 | 
			
		||||
        final ActionDefinition actionDefinition = createActionDefinition(actionDefinitionId, parameterDefinitions);
 | 
			
		||||
        BDDMockito.given(actionsMock.getActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        objectUnderTest.validate(action);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -90,17 +95,34 @@ public class ActionParameterDefinitionValidatorTest
 | 
			
		||||
        final String actionDefinitionId = "properActionDefinition";
 | 
			
		||||
        action.setActionDefinitionId(actionDefinitionId);
 | 
			
		||||
        final ActionDefinition actionDefinition = createActionDefinition(actionDefinitionId, null);
 | 
			
		||||
        BDDMockito.given(actionsMock.getActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        objectUnderTest.validate(action);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testValidationPassesWhenNoMandatoryParameters()
 | 
			
		||||
    public void testValidationPassesWhenNoMandatoryParametersNeeded()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        final String actionDefinitionId = "properActionDefinition";
 | 
			
		||||
        action.setActionDefinitionId(actionDefinitionId);
 | 
			
		||||
        final ActionDefinition actionDefinition =
 | 
			
		||||
                createActionDefinition(actionDefinitionId, List.of(createParameterDefinition(NON_MANDATORY_PARAM_KEY, TEXT, false, null)));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        objectUnderTest.validate(action);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testValidationPassesWhenOptionalParametersNotProvided()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        final String actionDefinitionId = "properActionDefinition";
 | 
			
		||||
@@ -110,12 +132,12 @@ public class ActionParameterDefinitionValidatorTest
 | 
			
		||||
                List.of(createParameterDefinition(MANDATORY_PARAM_KEY, TEXT, true, null),
 | 
			
		||||
                        createParameterDefinition(NON_MANDATORY_PARAM_KEY, BOOLEAN, false, null));
 | 
			
		||||
        final ActionDefinition actionDefinition = createActionDefinition(actionDefinitionId, parameterDefinitions);
 | 
			
		||||
        BDDMockito.given(actionsMock.getActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        objectUnderTest.validate(action);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -129,13 +151,13 @@ public class ActionParameterDefinitionValidatorTest
 | 
			
		||||
        final List<ActionDefinition.ParameterDefinition> parameterDefinitions =
 | 
			
		||||
                List.of(createParameterDefinition(MANDATORY_PARAM_KEY, TEXT, true, null));
 | 
			
		||||
        final ActionDefinition actionDefinition = createActionDefinition(actionDefinitionId, parameterDefinitions);
 | 
			
		||||
        BDDMockito.given(actionsMock.getActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(IllegalArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
        assertThatExceptionOfType(InvalidArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
                .withMessageContaining(String.format(MUST_NOT_CONTAIN_PARAMETER, actionDefinitionId, NON_MANDATORY_PARAM_KEY));
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -148,13 +170,13 @@ public class ActionParameterDefinitionValidatorTest
 | 
			
		||||
        final List<ActionDefinition.ParameterDefinition> parameterDefinitions =
 | 
			
		||||
                List.of(createParameterDefinition(MANDATORY_PARAM_KEY, TEXT, true, null));
 | 
			
		||||
        final ActionDefinition actionDefinition = createActionDefinition(actionDefinitionId, parameterDefinitions);
 | 
			
		||||
        BDDMockito.given(actionsMock.getActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(IllegalArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
        assertThatExceptionOfType(InvalidArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
                .withMessageContaining(String.format(PARAMS_SHOULD_NOT_BE_EMPTY, actionDefinitionId));
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -170,13 +192,13 @@ public class ActionParameterDefinitionValidatorTest
 | 
			
		||||
        final List<ActionDefinition.ParameterDefinition> parameterDefinitions =
 | 
			
		||||
                List.of(createParameterDefinition(MANDATORY_PARAM_KEY, TEXT, true, null));
 | 
			
		||||
        final ActionDefinition actionDefinition = createActionDefinition(actionDefinitionId, parameterDefinitions);
 | 
			
		||||
        BDDMockito.given(actionsMock.getActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(IllegalArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
        assertThatExceptionOfType(InvalidArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
                .withMessageContaining(String.format(MISSING_PARAMETER, MANDATORY_PARAM_KEY));
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
@@ -191,16 +213,56 @@ public class ActionParameterDefinitionValidatorTest
 | 
			
		||||
                List.of(createParameterDefinition(MANDATORY_PARAM_KEY, TEXT, true, null),
 | 
			
		||||
                        createParameterDefinition(NON_MANDATORY_PARAM_KEY, BOOLEAN, false, null));
 | 
			
		||||
        final ActionDefinition actionDefinition = createActionDefinition(actionDefinitionId, parameterDefinitions);
 | 
			
		||||
        BDDMockito.given(actionsMock.getActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(actionDefinitionId)).willReturn(actionDefinition);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(IllegalArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
        assertThatExceptionOfType(InvalidArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
                .withMessageContaining(String.format(MISSING_PARAMETER, MANDATORY_PARAM_KEY));
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testValidationFailsWhenActionWithNullActionDefinition()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        action.setActionDefinitionId(null);
 | 
			
		||||
        action.setParams(Map.of(MANDATORY_PARAM_KEY, "paramValue"));
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(InvalidArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
                .withMessageContaining(EMPTY_ACTION_DEFINITION);
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).shouldHaveNoInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testValidationFailsWhenNotApplicableActionDefinition()
 | 
			
		||||
    {
 | 
			
		||||
        final Action action = new Action();
 | 
			
		||||
        final String actionDefinitionId = "notApplicableActionDefinition";
 | 
			
		||||
        action.setActionDefinitionId(actionDefinitionId);
 | 
			
		||||
        action.setParams(Map.of(MANDATORY_PARAM_KEY, "paramValue"));
 | 
			
		||||
        given(actionsMock.getRuleActionDefinitionById(actionDefinitionId)).willThrow(NotFoundException.class);
 | 
			
		||||
 | 
			
		||||
        //when
 | 
			
		||||
        assertThatExceptionOfType(InvalidArgumentException.class).isThrownBy(() -> objectUnderTest.validate(action))
 | 
			
		||||
                .withMessageContaining(String.format(INVALID_ACTION_DEFINITION, actionDefinitionId));
 | 
			
		||||
 | 
			
		||||
        then(actionsMock).should().getRuleActionDefinitionById(actionDefinitionId);
 | 
			
		||||
        then(actionsMock).shouldHaveNoMoreInteractions();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Test
 | 
			
		||||
    public void testHasProperPriority()
 | 
			
		||||
    {
 | 
			
		||||
        final int expectedPriority = Integer.MIN_VALUE;
 | 
			
		||||
        final int actualPriority = objectUnderTest.getPriority();
 | 
			
		||||
 | 
			
		||||
        assertEquals(expectedPriority, actualPriority);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private ActionDefinition createActionDefinition(final String actionDefinitionId,
 | 
			
		||||
                                                    List<ActionDefinition.ParameterDefinition> parameterDefinitions)
 | 
			
		||||
    {
 | 
			
		||||
 
 | 
			
		||||
@@ -34,6 +34,9 @@ import static org.junit.Assert.assertTrue;
 | 
			
		||||
import static org.junit.Assert.fail;
 | 
			
		||||
 | 
			
		||||
import java.net.URL;
 | 
			
		||||
import java.time.ZonedDateTime;
 | 
			
		||||
import java.time.format.DateTimeFormatter;
 | 
			
		||||
import java.time.temporal.ChronoUnit;
 | 
			
		||||
import java.util.Date;
 | 
			
		||||
import java.util.HashMap;
 | 
			
		||||
import java.util.List;
 | 
			
		||||
@@ -386,6 +389,7 @@ public class AuditAppTest extends AbstractSingleNetworkSiteTest
 | 
			
		||||
        AuditApp auditApp = auditAppsProxy.getAuditApp("alfresco-access");
 | 
			
		||||
 | 
			
		||||
        testGetAuditEntries(auditAppsProxy, auditApp);
 | 
			
		||||
        testGetAuditEntriesWhereCreatedAt(auditAppsProxy, auditApp);
 | 
			
		||||
        testAuditEntriesSorting(auditAppsProxy, auditApp);
 | 
			
		||||
        testAuditEntriesWhereDate(auditAppsProxy, auditApp);
 | 
			
		||||
        testAuditEntriesWhereId(auditAppsProxy, auditApp);
 | 
			
		||||
@@ -396,6 +400,30 @@ public class AuditAppTest extends AbstractSingleNetworkSiteTest
 | 
			
		||||
        testDeleteAuditEntries(auditAppsProxy, auditApp);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void testGetAuditEntriesWhereCreatedAt(AuditApps auditAppsProxy, AuditApp auditApp) throws Exception
 | 
			
		||||
    {
 | 
			
		||||
        // get "totalItems" for a specific time interval
 | 
			
		||||
        Map<String, String> params = new HashMap<>();
 | 
			
		||||
 | 
			
		||||
        final ZonedDateTime beginDate = ZonedDateTime.now().minusHours(1).truncatedTo(ChronoUnit.MINUTES);
 | 
			
		||||
        final ZonedDateTime endDate = ZonedDateTime.now().truncatedTo(ChronoUnit.MINUTES);
 | 
			
		||||
        params.put("where","(createdAt BETWEEN ('"+beginDate.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME)+"' , '"+endDate.format(DateTimeFormatter.ISO_OFFSET_DATE_TIME)+"'))");
 | 
			
		||||
 | 
			
		||||
        ListResponse<AuditEntry> auditEntries = auditAppsProxy.getAuditAppEntries(auditApp.getId(), params,
 | 
			
		||||
                HttpServletResponse.SC_OK);
 | 
			
		||||
        int totalItemsWithDefaultMaxSize = auditEntries.getPaging().getTotalItems();
 | 
			
		||||
        assertTrue( totalItemsWithDefaultMaxSize > 1 );
 | 
			
		||||
 | 
			
		||||
        // get "totalItems" for a specific time internal (with maxSize=1)
 | 
			
		||||
        params.put("maxSize","1");
 | 
			
		||||
        auditEntries = auditAppsProxy.getAuditAppEntries(auditApp.getId(), params,
 | 
			
		||||
                HttpServletResponse.SC_OK);
 | 
			
		||||
        int totalItemsWithMaxSize1 = auditEntries.getPaging().getTotalItems();
 | 
			
		||||
 | 
			
		||||
        // number of "totalItems" must be the same, regardless maxSize
 | 
			
		||||
        assertEquals(totalItemsWithMaxSize1, totalItemsWithDefaultMaxSize);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void testGetAuditEntries(AuditApps auditAppsProxy, AuditApp auditApp) throws Exception 
 | 
			
		||||
    {
 | 
			
		||||
        // Positive tests
 | 
			
		||||
 
 | 
			
		||||
@@ -7,7 +7,7 @@
 | 
			
		||||
    <parent>
 | 
			
		||||
        <groupId>org.alfresco</groupId>
 | 
			
		||||
        <artifactId>alfresco-community-repo</artifactId>
 | 
			
		||||
        <version>17.169</version>
 | 
			
		||||
        <version>18.8-SNAPSHOT</version>
 | 
			
		||||
    </parent>
 | 
			
		||||
 | 
			
		||||
    <dependencies>
 | 
			
		||||
 
 | 
			
		||||
@@ -272,4 +272,16 @@ public interface AuditComponent
 | 
			
		||||
    {
 | 
			
		||||
        return -1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Issue an audit query to retrieve count of records for a given application and properties
 | 
			
		||||
     *
 | 
			
		||||
     * @param applicationName             the name of the application
 | 
			
		||||
     * @param parameters                  audit parameters provided by the <code>where</code> clause on the ReST API
 | 
			
		||||
     * @return                            a map containing min/max and the associated value
 | 
			
		||||
     */
 | 
			
		||||
    default int getAuditEntriesCountByAppAndProperties(String applicationName, AuditQueryParameters parameters)
 | 
			
		||||
    {
 | 
			
		||||
        return -1;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -955,4 +955,11 @@ public class AuditComponentImpl implements AuditComponent
 | 
			
		||||
 | 
			
		||||
        return auditDAO.getAuditEntriesCountByApp(applicationId);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override public int getAuditEntriesCountByAppAndProperties(String applicationName, AuditQueryParameters parameters)
 | 
			
		||||
    {
 | 
			
		||||
        org.alfresco.repo.domain.audit.AuditQueryParameters dbParameters = new org.alfresco.repo.domain.audit.AuditQueryParameters();
 | 
			
		||||
 | 
			
		||||
        return auditDAO.getAuditEntriesCountByAppAndProperties(applicationName, parameters);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -186,4 +186,12 @@ public class AuditServiceImpl implements AuditService
 | 
			
		||||
    {
 | 
			
		||||
        return auditComponent.getAuditEntriesCountByApp(applicationName);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * {@inheritDoc}
 | 
			
		||||
     */
 | 
			
		||||
    @Override public int getAuditEntriesCountByAppAndProperties(String applicationName, AuditQueryParameters parameters)
 | 
			
		||||
    {
 | 
			
		||||
        return auditComponent.getAuditEntriesCountByAppAndProperties(applicationName, parameters);
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -25,6 +25,10 @@
 | 
			
		||||
 */
 | 
			
		||||
package org.alfresco.repo.content.transform;
 | 
			
		||||
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
import java.io.InputStream;
 | 
			
		||||
import java.util.StringJoiner;
 | 
			
		||||
 | 
			
		||||
import org.alfresco.error.AlfrescoRuntimeException;
 | 
			
		||||
import org.alfresco.service.cmr.repository.ContentReader;
 | 
			
		||||
import org.alfresco.service.cmr.repository.ContentWriter;
 | 
			
		||||
@@ -44,9 +48,6 @@ import org.apache.http.impl.client.CloseableHttpClient;
 | 
			
		||||
import org.apache.http.impl.client.HttpClients;
 | 
			
		||||
import org.apache.http.util.EntityUtils;
 | 
			
		||||
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
import java.util.StringJoiner;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Client class that transfers content (from a ContentReader) to a remote transformation agent together with
 | 
			
		||||
 * request parameters that will be used to transform the content. The transformed content is then returned and
 | 
			
		||||
@@ -86,44 +87,33 @@ public class RemoteTransformerClient
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void request(ContentReader reader, ContentWriter writer, String sourceMimetype, String sourceExtension,
 | 
			
		||||
                        String targetExtension, long timeoutMs, Log logger, String... args)
 | 
			
		||||
            String targetExtension, long timeoutMs, Log logger, String... args)
 | 
			
		||||
    {
 | 
			
		||||
 | 
			
		||||
        if (args.length % 2 != 0)
 | 
			
		||||
        {
 | 
			
		||||
            throw new IllegalArgumentException("There should be a value for each request property");
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        StringJoiner sj = new StringJoiner(" ");
 | 
			
		||||
        HttpEntity reqEntity = getRequestEntity(reader, sourceMimetype, sourceExtension, targetExtension, timeoutMs, args, sj);
 | 
			
		||||
 | 
			
		||||
        request(logger, sourceExtension, targetExtension, reqEntity, writer, sj.toString());
 | 
			
		||||
        try (InputStream contentStream = reader.getContentInputStream())
 | 
			
		||||
        {
 | 
			
		||||
            HttpEntity reqEntity = getRequestEntity(contentStream, sourceMimetype, sourceExtension, targetExtension, timeoutMs,
 | 
			
		||||
                    args, sj);
 | 
			
		||||
 | 
			
		||||
            request(logger, sourceExtension, targetExtension, reqEntity, writer, sj.toString());
 | 
			
		||||
        }
 | 
			
		||||
        catch (IOException e)
 | 
			
		||||
        {
 | 
			
		||||
            throw new AlfrescoRuntimeException("Failed to read content from reader", e);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    HttpEntity getRequestEntity(ContentReader reader, String sourceMimetype, String sourceExtension,
 | 
			
		||||
                                        String targetExtension, long timeoutMs, String[] args, StringJoiner sj)
 | 
			
		||||
    HttpEntity getRequestEntity(ContentReader reader, String sourceMimetype, String sourceExtension, String targetExtension,
 | 
			
		||||
            long timeoutMs, String[] args, StringJoiner sj)
 | 
			
		||||
    {
 | 
			
		||||
        MultipartEntityBuilder builder = MultipartEntityBuilder.create();
 | 
			
		||||
        ContentType contentType = ContentType.create(sourceMimetype);
 | 
			
		||||
        builder.addBinaryBody("file", reader.getContentInputStream(), contentType, "tmp."+sourceExtension);
 | 
			
		||||
        builder.addTextBody("targetExtension", targetExtension);
 | 
			
		||||
        sj.add("targetExtension" + '=' + targetExtension);
 | 
			
		||||
        for (int i=0; i< args.length; i+=2)
 | 
			
		||||
        {
 | 
			
		||||
            if (args[i+1] != null)
 | 
			
		||||
            {
 | 
			
		||||
                builder.addTextBody(args[i], args[i + 1]);
 | 
			
		||||
 | 
			
		||||
                sj.add(args[i] + '=' + args[i + 1]);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (timeoutMs > 0)
 | 
			
		||||
        {
 | 
			
		||||
            String timeoutMsString = Long.toString(timeoutMs);
 | 
			
		||||
            builder.addTextBody("timeout", timeoutMsString);
 | 
			
		||||
            sj.add("timeout=" + timeoutMsString);
 | 
			
		||||
        }
 | 
			
		||||
        return builder.build();
 | 
			
		||||
        return getRequestEntity(reader.getContentInputStream(), sourceMimetype, sourceExtension, targetExtension, timeoutMs, args, sj);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    void request(Log logger, String sourceExtension, String targetExtension, HttpEntity reqEntity, ContentWriter writer, String args)
 | 
			
		||||
@@ -331,6 +321,33 @@ public class RemoteTransformerClient
 | 
			
		||||
        return httpclient.execute(httpGet);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private HttpEntity getRequestEntity(InputStream contentStream, String sourceMimetype, String sourceExtension,
 | 
			
		||||
            String targetExtension, long timeoutMs, String[] args, StringJoiner sj)
 | 
			
		||||
    {
 | 
			
		||||
        MultipartEntityBuilder builder = MultipartEntityBuilder.create();
 | 
			
		||||
        ContentType contentType = ContentType.create(sourceMimetype);
 | 
			
		||||
        builder.addBinaryBody("file", contentStream, contentType, "tmp." + sourceExtension);
 | 
			
		||||
        builder.addTextBody("targetExtension", targetExtension);
 | 
			
		||||
        sj.add("targetExtension" + '=' + targetExtension);
 | 
			
		||||
        for (int i = 0; i < args.length; i += 2)
 | 
			
		||||
        {
 | 
			
		||||
            if (args[i + 1] != null)
 | 
			
		||||
            {
 | 
			
		||||
                builder.addTextBody(args[i], args[i + 1]);
 | 
			
		||||
 | 
			
		||||
                sj.add(args[i] + '=' + args[i + 1]);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (timeoutMs > 0)
 | 
			
		||||
        {
 | 
			
		||||
            String timeoutMsString = Long.toString(timeoutMs);
 | 
			
		||||
            builder.addTextBody("timeout", timeoutMsString);
 | 
			
		||||
            sj.add("timeout=" + timeoutMsString);
 | 
			
		||||
        }
 | 
			
		||||
        return builder.build();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // Strip out just the error message in the response
 | 
			
		||||
    private String getErrorMessage(HttpEntity resEntity) throws IOException
 | 
			
		||||
    {
 | 
			
		||||
 
 | 
			
		||||
@@ -1,28 +1,28 @@
 | 
			
		||||
/*
 | 
			
		||||
 * #%L
 | 
			
		||||
 * Alfresco Repository
 | 
			
		||||
 * %%
 | 
			
		||||
 * Copyright (C) 2005 - 2016 Alfresco Software Limited
 | 
			
		||||
 * %%
 | 
			
		||||
 * This file is part of the Alfresco software. 
 | 
			
		||||
 * If the software was purchased under a paid Alfresco license, the terms of 
 | 
			
		||||
 * the paid license agreement will prevail.  Otherwise, the software is 
 | 
			
		||||
 * provided under the following open source license terms:
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is free software: you can redistribute it and/or modify
 | 
			
		||||
 * it under the terms of the GNU Lesser General Public License as published by
 | 
			
		||||
 * the Free Software Foundation, either version 3 of the License, or
 | 
			
		||||
 * (at your option) any later version.
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is distributed in the hope that it will be useful,
 | 
			
		||||
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
 * GNU Lesser General Public License for more details.
 | 
			
		||||
 * 
 | 
			
		||||
 * You should have received a copy of the GNU Lesser General Public License
 | 
			
		||||
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 * #L%
 | 
			
		||||
 */
 | 
			
		||||
/*
 | 
			
		||||
 * #%L
 | 
			
		||||
 * Alfresco Repository
 | 
			
		||||
 * %%
 | 
			
		||||
 * Copyright (C) 2005 - 2016 Alfresco Software Limited
 | 
			
		||||
 * %%
 | 
			
		||||
 * This file is part of the Alfresco software. 
 | 
			
		||||
 * If the software was purchased under a paid Alfresco license, the terms of 
 | 
			
		||||
 * the paid license agreement will prevail.  Otherwise, the software is 
 | 
			
		||||
 * provided under the following open source license terms:
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is free software: you can redistribute it and/or modify
 | 
			
		||||
 * it under the terms of the GNU Lesser General Public License as published by
 | 
			
		||||
 * the Free Software Foundation, either version 3 of the License, or
 | 
			
		||||
 * (at your option) any later version.
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is distributed in the hope that it will be useful,
 | 
			
		||||
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
 * GNU Lesser General Public License for more details.
 | 
			
		||||
 * 
 | 
			
		||||
 * You should have received a copy of the GNU Lesser General Public License
 | 
			
		||||
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 * #L%
 | 
			
		||||
 */
 | 
			
		||||
package org.alfresco.repo.domain.audit;
 | 
			
		||||
 | 
			
		||||
import java.io.IOException;
 | 
			
		||||
@@ -452,37 +452,86 @@ public abstract class AbstractAuditDAOImpl implements AuditDAO
 | 
			
		||||
            org.alfresco.service.cmr.audit.AuditQueryParameters parameters,
 | 
			
		||||
            int maxResults)
 | 
			
		||||
    {
 | 
			
		||||
        String searchKey = null;
 | 
			
		||||
        Serializable searchValue = null;
 | 
			
		||||
        if (parameters.getSearchKeyValues().size() > 0)
 | 
			
		||||
        {
 | 
			
		||||
            // Only handle one pair for now
 | 
			
		||||
            Pair<String, Serializable> searchKeyValue = parameters.getSearchKeyValues().get(0);
 | 
			
		||||
            searchKey = searchKeyValue.getFirst();
 | 
			
		||||
            searchValue = searchKeyValue.getSecond();
 | 
			
		||||
        }
 | 
			
		||||
        
 | 
			
		||||
        AuditQueryRowHandler rowHandler = new AuditQueryRowHandler(callback);
 | 
			
		||||
        findAuditEntries(
 | 
			
		||||
                rowHandler,
 | 
			
		||||
                parameters.isForward(),
 | 
			
		||||
                parameters.getApplicationName(),
 | 
			
		||||
                parameters.getUser(),
 | 
			
		||||
                parameters.getFromId(),
 | 
			
		||||
                parameters.getToId(),
 | 
			
		||||
                parameters.getFromTime(),
 | 
			
		||||
                parameters.getToTime(),
 | 
			
		||||
                maxResults,
 | 
			
		||||
                searchKey,
 | 
			
		||||
                searchValue);
 | 
			
		||||
                parameters);
 | 
			
		||||
    }
 | 
			
		||||
    
 | 
			
		||||
    protected abstract void findAuditEntries(
 | 
			
		||||
            AuditQueryRowHandler rowHandler,
 | 
			
		||||
            boolean forward,
 | 
			
		||||
            String applicationName, String user,
 | 
			
		||||
            Long fromId, Long toId,
 | 
			
		||||
            Long fromTime, Long toTime,
 | 
			
		||||
            int maxResults,
 | 
			
		||||
            String searchKey, Serializable searchValue);
 | 
			
		||||
            org.alfresco.service.cmr.audit.AuditQueryParameters restParameters);
 | 
			
		||||
 | 
			
		||||
    protected AuditQueryParameters convertFromRestAuditQueryParameters(org.alfresco.service.cmr.audit.AuditQueryParameters restParameters)
 | 
			
		||||
    {
 | 
			
		||||
        AuditQueryParameters dbParameters = new AuditQueryParameters();
 | 
			
		||||
 | 
			
		||||
        String appName = restParameters.getApplicationName();
 | 
			
		||||
        if (appName != null)
 | 
			
		||||
        {
 | 
			
		||||
            // Look up the application's ID (this is unique)
 | 
			
		||||
            Pair<Long, Serializable> appNamePair = propertyValueDAO.getPropertyValue(appName);
 | 
			
		||||
            if (appNamePair == null)
 | 
			
		||||
            {
 | 
			
		||||
                // No such value
 | 
			
		||||
                return null;
 | 
			
		||||
            }
 | 
			
		||||
            dbParameters.setAuditAppNameId(appNamePair.getFirst());
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        String user = restParameters.getUser();
 | 
			
		||||
        if (user != null)
 | 
			
		||||
        {
 | 
			
		||||
            // Look up the application's ID (this is unique)
 | 
			
		||||
            Pair<Long, Serializable> userPair = propertyValueDAO.getPropertyValue(user);
 | 
			
		||||
            if (userPair == null)
 | 
			
		||||
            {
 | 
			
		||||
                // No such value
 | 
			
		||||
                return null;
 | 
			
		||||
            }
 | 
			
		||||
            dbParameters.setAuditUserId(userPair.getFirst());
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        dbParameters.setAuditFromId(restParameters.getFromId());
 | 
			
		||||
        dbParameters.setAuditToId(restParameters.getToId());
 | 
			
		||||
        dbParameters.setAuditFromTime(restParameters.getFromTime());
 | 
			
		||||
        dbParameters.setAuditToTime(restParameters.getToTime());
 | 
			
		||||
 | 
			
		||||
        String searchKey = null;
 | 
			
		||||
        Serializable searchValue = null;
 | 
			
		||||
        if (restParameters.getSearchKeyValues().size() > 0)
 | 
			
		||||
        {
 | 
			
		||||
            // Only handle one pair for now
 | 
			
		||||
            Pair<String, Serializable> searchKeyValue = restParameters.getSearchKeyValues().get(0);
 | 
			
		||||
            searchKey = searchKeyValue.getFirst();
 | 
			
		||||
            searchValue = searchKeyValue.getSecond();
 | 
			
		||||
        }
 | 
			
		||||
        if (searchKey != null)
 | 
			
		||||
        {
 | 
			
		||||
            // Look up the ID of the search key
 | 
			
		||||
            Pair<Long, Serializable> searchKeyPair = propertyValueDAO.getPropertyValue(searchKey);
 | 
			
		||||
            if (searchKeyPair == null)
 | 
			
		||||
            {
 | 
			
		||||
                // No such value
 | 
			
		||||
                return null;
 | 
			
		||||
            }
 | 
			
		||||
            dbParameters.setSearchKeyId(searchKeyPair.getFirst());
 | 
			
		||||
        }
 | 
			
		||||
        if (searchValue != null)
 | 
			
		||||
        {
 | 
			
		||||
            // Look up the ID of the search key
 | 
			
		||||
            Pair<Long, Serializable> searchValuePair = propertyValueDAO.getPropertyValue(searchValue);
 | 
			
		||||
            if (searchValuePair == null)
 | 
			
		||||
            {
 | 
			
		||||
                // No such value
 | 
			
		||||
                return null;
 | 
			
		||||
            }
 | 
			
		||||
            dbParameters.setSearchValueId(searchValuePair.getFirst());
 | 
			
		||||
        }
 | 
			
		||||
        dbParameters.setForward(restParameters.isForward());
 | 
			
		||||
 | 
			
		||||
        return dbParameters;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -244,4 +244,16 @@ public interface AuditDAO
 | 
			
		||||
    {
 | 
			
		||||
        return -1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Issue an audit query to retrieve count of records for a given application and properties
 | 
			
		||||
     *
 | 
			
		||||
     * @param applicationName   name of the application to be queried
 | 
			
		||||
     * @param parameters        audit parameters provided by the <code>where</code> clause on the ReST API
 | 
			
		||||
     * @return                  a map containing min/max and the associated value
 | 
			
		||||
     */
 | 
			
		||||
    default int getAuditEntriesCountByAppAndProperties(String applicationName, org.alfresco.service.cmr.audit.AuditQueryParameters parameters)
 | 
			
		||||
    {
 | 
			
		||||
        return -1;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -66,6 +66,7 @@ public class AuditDAOImpl extends AbstractAuditDAOImpl
 | 
			
		||||
    private static final String INSERT_ENTRY = "alfresco.audit.insert.insert_AuditEntry";
 | 
			
		||||
    private static final String SELECT_MINMAX_ENTRY_FOR_APP = "alfresco.audit.select_MinMaxAuditEntryId";
 | 
			
		||||
    private static final String SELECT_COUNT_ENTRIES_FOR_APP = "alfresco.audit.select_CountAuditEntryId";
 | 
			
		||||
    private static final String SELECT_COUNT_ENTRIES_FOR_APP_WITH_PROPERTIES = "select_CountAuditEntryIdWithWhereClause";
 | 
			
		||||
    
 | 
			
		||||
    @SuppressWarnings("unused")
 | 
			
		||||
    private static final String SELECT_ENTRIES_SIMPLE = "alfresco.audit.select_AuditEntriesSimple";
 | 
			
		||||
@@ -235,68 +236,29 @@ public class AuditDAOImpl extends AbstractAuditDAOImpl
 | 
			
		||||
        return result;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    public int getAuditEntriesCountByAppAndProperties(String applicationName, org.alfresco.service.cmr.audit.AuditQueryParameters parameters)
 | 
			
		||||
    {
 | 
			
		||||
        AuditQueryParameters dbParameters = convertFromRestAuditQueryParameters(parameters);
 | 
			
		||||
 | 
			
		||||
        int result = template.selectOne(SELECT_COUNT_ENTRIES_FOR_APP_WITH_PROPERTIES, dbParameters);
 | 
			
		||||
 | 
			
		||||
        return result;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @SuppressWarnings("unchecked")
 | 
			
		||||
    @Override
 | 
			
		||||
    protected void findAuditEntries(
 | 
			
		||||
            final AuditQueryRowHandler rowHandler,
 | 
			
		||||
            boolean forward,
 | 
			
		||||
            String appName, String user,
 | 
			
		||||
            Long fromId, Long toId,
 | 
			
		||||
            Long fromTime, Long toTime,
 | 
			
		||||
            int maxResults,
 | 
			
		||||
            String searchKey, Serializable searchValue)
 | 
			
		||||
            org.alfresco.service.cmr.audit.AuditQueryParameters restParameters)
 | 
			
		||||
    {
 | 
			
		||||
        AuditQueryParameters params = new AuditQueryParameters();
 | 
			
		||||
        if (appName != null)
 | 
			
		||||
        AuditQueryParameters params = convertFromRestAuditQueryParameters(restParameters);
 | 
			
		||||
        if (params==null)
 | 
			
		||||
        {
 | 
			
		||||
            // Look up the application's ID (this is unique)
 | 
			
		||||
            Pair<Long, Serializable> appNamePair = propertyValueDAO.getPropertyValue(appName);
 | 
			
		||||
            if (appNamePair == null)
 | 
			
		||||
            {
 | 
			
		||||
                // No such value
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
            params.setAuditAppNameId(appNamePair.getFirst());
 | 
			
		||||
            return;
 | 
			
		||||
        }
 | 
			
		||||
        if (user != null)
 | 
			
		||||
        {
 | 
			
		||||
            // Look up the application's ID (this is unique)
 | 
			
		||||
            Pair<Long, Serializable> userPair = propertyValueDAO.getPropertyValue(user);
 | 
			
		||||
            if (userPair == null)
 | 
			
		||||
            {
 | 
			
		||||
                // No such value
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
            params.setAuditUserId(userPair.getFirst());
 | 
			
		||||
        }
 | 
			
		||||
        params.setAuditFromId(fromId);
 | 
			
		||||
        params.setAuditToId(toId);
 | 
			
		||||
        params.setAuditFromTime(fromTime);
 | 
			
		||||
        params.setAuditToTime(toTime);
 | 
			
		||||
        if (searchKey != null)
 | 
			
		||||
        {
 | 
			
		||||
            // Look up the ID of the search key
 | 
			
		||||
            Pair<Long, Serializable> searchKeyPair = propertyValueDAO.getPropertyValue(searchKey);
 | 
			
		||||
            if (searchKeyPair == null)
 | 
			
		||||
            {
 | 
			
		||||
                // No such value
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
            params.setSearchKeyId(searchKeyPair.getFirst());
 | 
			
		||||
        }
 | 
			
		||||
        if (searchValue != null)
 | 
			
		||||
        {
 | 
			
		||||
            // Look up the ID of the search key
 | 
			
		||||
            Pair<Long, Serializable> searchValuePair = propertyValueDAO.getPropertyValue(searchValue);
 | 
			
		||||
            if (searchValuePair == null)
 | 
			
		||||
            {
 | 
			
		||||
                // No such value
 | 
			
		||||
                return;
 | 
			
		||||
            }
 | 
			
		||||
            params.setSearchValueId(searchValuePair.getFirst());
 | 
			
		||||
        }
 | 
			
		||||
        params.setForward(forward);
 | 
			
		||||
        
 | 
			
		||||
 | 
			
		||||
        if (maxResults > 0)
 | 
			
		||||
        {
 | 
			
		||||
            // Query without getting the values.  We gather all the results and batch-fetch the audited
 | 
			
		||||
 
 | 
			
		||||
@@ -0,0 +1,201 @@
 | 
			
		||||
/*
 | 
			
		||||
 * #%L
 | 
			
		||||
 * Alfresco Repository
 | 
			
		||||
 * %%
 | 
			
		||||
 * Copyright (C) 2005 - 2022 Alfresco Software Limited
 | 
			
		||||
 * %%
 | 
			
		||||
 * This file is part of the Alfresco software. 
 | 
			
		||||
 * If the software was purchased under a paid Alfresco license, the terms of 
 | 
			
		||||
 * the paid license agreement will prevail.  Otherwise, the software is 
 | 
			
		||||
 * provided under the following open source license terms:
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is free software: you can redistribute it and/or modify
 | 
			
		||||
 * it under the terms of the GNU Lesser General Public License as published by
 | 
			
		||||
 * the Free Software Foundation, either version 3 of the License, or
 | 
			
		||||
 * (at your option) any later version.
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is distributed in the hope that it will be useful,
 | 
			
		||||
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
 * GNU Lesser General Public License for more details.
 | 
			
		||||
 * 
 | 
			
		||||
 * You should have received a copy of the GNU Lesser General Public License
 | 
			
		||||
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 * #L%
 | 
			
		||||
 */
 | 
			
		||||
package org.alfresco.repo.jscript;
 | 
			
		||||
 | 
			
		||||
import org.apache.commons.logging.Log;
 | 
			
		||||
import org.apache.commons.logging.LogFactory;
 | 
			
		||||
import org.mozilla.javascript.Callable;
 | 
			
		||||
import org.mozilla.javascript.Context;
 | 
			
		||||
import org.mozilla.javascript.ContextFactory;
 | 
			
		||||
import org.mozilla.javascript.Scriptable;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Custom factory that allows to apply configured limits during script executions
 | 
			
		||||
 * 
 | 
			
		||||
 * @see ContextFactory
 | 
			
		||||
 */
 | 
			
		||||
public class AlfrescoContextFactory extends ContextFactory
 | 
			
		||||
{
 | 
			
		||||
    private static final Log LOGGER = LogFactory.getLog(AlfrescoContextFactory.class);
 | 
			
		||||
 | 
			
		||||
    private int optimizationLevel = -1;
 | 
			
		||||
    private int maxScriptExecutionSeconds = -1;
 | 
			
		||||
    private int maxStackDepth = -1;
 | 
			
		||||
    private long maxMemoryUsedInBytes = -1L;
 | 
			
		||||
    private int observeInstructionCount = -1;
 | 
			
		||||
 | 
			
		||||
    private AlfrescoScriptThreadMxBeanWrapper threadMxBeanWrapper;
 | 
			
		||||
 | 
			
		||||
    private final int INTERPRETIVE_MODE = -1;
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    protected Context makeContext()
 | 
			
		||||
    {
 | 
			
		||||
        AlfrescoScriptContext context = new AlfrescoScriptContext();
 | 
			
		||||
 | 
			
		||||
        context.setOptimizationLevel(optimizationLevel);
 | 
			
		||||
 | 
			
		||||
        // Needed for both time and memory measurement
 | 
			
		||||
        if (maxScriptExecutionSeconds > 0 || maxMemoryUsedInBytes > 0L)
 | 
			
		||||
        {
 | 
			
		||||
            if (observeInstructionCount > 0)
 | 
			
		||||
            {
 | 
			
		||||
                LOGGER.info("Enabling observer count...");
 | 
			
		||||
                context.setGenerateObserverCount(true);
 | 
			
		||||
                context.setInstructionObserverThreshold(observeInstructionCount);
 | 
			
		||||
            }
 | 
			
		||||
            else
 | 
			
		||||
            {
 | 
			
		||||
                LOGGER.info("Disabling observer count...");
 | 
			
		||||
                context.setGenerateObserverCount(false);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Memory limit
 | 
			
		||||
        if (maxMemoryUsedInBytes > 0)
 | 
			
		||||
        {
 | 
			
		||||
            context.setThreadId(Thread.currentThread().getId());
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        // Max stack depth
 | 
			
		||||
        if (maxStackDepth > 0)
 | 
			
		||||
        {
 | 
			
		||||
            if (optimizationLevel != INTERPRETIVE_MODE)
 | 
			
		||||
            {
 | 
			
		||||
                LOGGER.warn("Changing optimization level from " + optimizationLevel + " to " + INTERPRETIVE_MODE);
 | 
			
		||||
            }
 | 
			
		||||
            // stack depth can only be set when no optimizations are applied
 | 
			
		||||
            context.setOptimizationLevel(INTERPRETIVE_MODE);
 | 
			
		||||
            context.setMaximumInterpreterStackDepth(maxStackDepth);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return context;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    protected void observeInstructionCount(Context cx, int instructionCount)
 | 
			
		||||
    {
 | 
			
		||||
        AlfrescoScriptContext acx = (AlfrescoScriptContext) cx;
 | 
			
		||||
 | 
			
		||||
        if (acx.isLimitsEnabled())
 | 
			
		||||
        {
 | 
			
		||||
            // Time limit
 | 
			
		||||
            if (maxScriptExecutionSeconds > 0)
 | 
			
		||||
            {
 | 
			
		||||
                long currentTime = System.currentTimeMillis();
 | 
			
		||||
                if (currentTime - acx.getStartTime() > maxScriptExecutionSeconds * 1000)
 | 
			
		||||
                {
 | 
			
		||||
                    throw new Error("Maximum script time of " + maxScriptExecutionSeconds + " seconds exceeded");
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            // Memory
 | 
			
		||||
            if (maxMemoryUsedInBytes > 0 && threadMxBeanWrapper != null && threadMxBeanWrapper.isThreadAllocatedMemorySupported())
 | 
			
		||||
            {
 | 
			
		||||
 | 
			
		||||
                if (acx.getStartMemory() <= 0)
 | 
			
		||||
                {
 | 
			
		||||
                    acx.setStartMemory(threadMxBeanWrapper.getThreadAllocatedBytes(acx.getThreadId()));
 | 
			
		||||
                }
 | 
			
		||||
                else
 | 
			
		||||
                {
 | 
			
		||||
                    long currentAllocatedBytes = threadMxBeanWrapper.getThreadAllocatedBytes(acx.getThreadId());
 | 
			
		||||
                    if (currentAllocatedBytes - acx.getStartMemory() >= maxMemoryUsedInBytes)
 | 
			
		||||
                    {
 | 
			
		||||
                        throw new Error("Memory limit of " + maxMemoryUsedInBytes + " bytes reached");
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    @Override
 | 
			
		||||
    protected Object doTopCall(Callable callable, Context cx, Scriptable scope, Scriptable thisObj, Object[] args)
 | 
			
		||||
    {
 | 
			
		||||
        AlfrescoScriptContext acx = (AlfrescoScriptContext) cx;
 | 
			
		||||
        acx.setStartTime(System.currentTimeMillis());
 | 
			
		||||
        return super.doTopCall(callable, cx, scope, thisObj, args);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public int getOptimizationLevel()
 | 
			
		||||
    {
 | 
			
		||||
        return optimizationLevel;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void setOptimizationLevel(int optimizationLevel)
 | 
			
		||||
    {
 | 
			
		||||
        this.optimizationLevel = optimizationLevel;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public int getMaxScriptExecutionSeconds()
 | 
			
		||||
    {
 | 
			
		||||
        return maxScriptExecutionSeconds;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void setMaxScriptExecutionSeconds(int maxScriptExecutionSeconds)
 | 
			
		||||
    {
 | 
			
		||||
        this.maxScriptExecutionSeconds = maxScriptExecutionSeconds;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public int getMaxStackDepth()
 | 
			
		||||
    {
 | 
			
		||||
        return maxStackDepth;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void setMaxStackDepth(int maxStackDepth)
 | 
			
		||||
    {
 | 
			
		||||
        this.maxStackDepth = maxStackDepth;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public long getMaxMemoryUsedInBytes()
 | 
			
		||||
    {
 | 
			
		||||
        return maxMemoryUsedInBytes;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void setMaxMemoryUsedInBytes(long maxMemoryUsedInBytes)
 | 
			
		||||
    {
 | 
			
		||||
        this.maxMemoryUsedInBytes = maxMemoryUsedInBytes;
 | 
			
		||||
        if (maxMemoryUsedInBytes > 0)
 | 
			
		||||
        {
 | 
			
		||||
            this.threadMxBeanWrapper = new AlfrescoScriptThreadMxBeanWrapper();
 | 
			
		||||
            if (!threadMxBeanWrapper.isThreadAllocatedMemorySupported())
 | 
			
		||||
            {
 | 
			
		||||
                LOGGER.warn("com.sun.management.ThreadMXBean was not found on the classpath. "
 | 
			
		||||
                        + "This means that the limiting the memory usage for a script will NOT work.");
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public int getObserveInstructionCount()
 | 
			
		||||
    {
 | 
			
		||||
        return observeInstructionCount;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void setObserveInstructionCount(int observeInstructionCount)
 | 
			
		||||
    {
 | 
			
		||||
        this.observeInstructionCount = observeInstructionCount;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -0,0 +1,81 @@
 | 
			
		||||
/*
 | 
			
		||||
 * #%L
 | 
			
		||||
 * Alfresco Repository
 | 
			
		||||
 * %%
 | 
			
		||||
 * Copyright (C) 2005 - 2022 Alfresco Software Limited
 | 
			
		||||
 * %%
 | 
			
		||||
 * This file is part of the Alfresco software. 
 | 
			
		||||
 * If the software was purchased under a paid Alfresco license, the terms of 
 | 
			
		||||
 * the paid license agreement will prevail.  Otherwise, the software is 
 | 
			
		||||
 * provided under the following open source license terms:
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is free software: you can redistribute it and/or modify
 | 
			
		||||
 * it under the terms of the GNU Lesser General Public License as published by
 | 
			
		||||
 * the Free Software Foundation, either version 3 of the License, or
 | 
			
		||||
 * (at your option) any later version.
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is distributed in the hope that it will be useful,
 | 
			
		||||
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
 * GNU Lesser General Public License for more details.
 | 
			
		||||
 * 
 | 
			
		||||
 * You should have received a copy of the GNU Lesser General Public License
 | 
			
		||||
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 * #L%
 | 
			
		||||
 */
 | 
			
		||||
package org.alfresco.repo.jscript;
 | 
			
		||||
 | 
			
		||||
import org.mozilla.javascript.Context;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Custom Rhino context that holds data as start time and memory
 | 
			
		||||
 * 
 | 
			
		||||
 * @see Context
 | 
			
		||||
 */
 | 
			
		||||
public class AlfrescoScriptContext extends Context
 | 
			
		||||
{
 | 
			
		||||
    private long startTime;
 | 
			
		||||
    private long threadId;
 | 
			
		||||
    private long startMemory;
 | 
			
		||||
    private boolean limitsEnabled = false;
 | 
			
		||||
 | 
			
		||||
    public long getStartTime()
 | 
			
		||||
    {
 | 
			
		||||
        return startTime;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void setStartTime(long startTime)
 | 
			
		||||
    {
 | 
			
		||||
        this.startTime = startTime;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public long getThreadId()
 | 
			
		||||
    {
 | 
			
		||||
        return threadId;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void setThreadId(long threadId)
 | 
			
		||||
    {
 | 
			
		||||
        this.threadId = threadId;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public long getStartMemory()
 | 
			
		||||
    {
 | 
			
		||||
        return startMemory;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void setStartMemory(long startMemory)
 | 
			
		||||
    {
 | 
			
		||||
        this.startMemory = startMemory;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public boolean isLimitsEnabled()
 | 
			
		||||
    {
 | 
			
		||||
        return limitsEnabled;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void setLimitsEnabled(boolean limitsEnabled)
 | 
			
		||||
    {
 | 
			
		||||
        this.limitsEnabled = limitsEnabled;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -0,0 +1,78 @@
 | 
			
		||||
/*
 | 
			
		||||
 * #%L
 | 
			
		||||
 * Alfresco Repository
 | 
			
		||||
 * %%
 | 
			
		||||
 * Copyright (C) 2005 - 2022 Alfresco Software Limited
 | 
			
		||||
 * %%
 | 
			
		||||
 * This file is part of the Alfresco software. 
 | 
			
		||||
 * If the software was purchased under a paid Alfresco license, the terms of 
 | 
			
		||||
 * the paid license agreement will prevail.  Otherwise, the software is 
 | 
			
		||||
 * provided under the following open source license terms:
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is free software: you can redistribute it and/or modify
 | 
			
		||||
 * it under the terms of the GNU Lesser General Public License as published by
 | 
			
		||||
 * the Free Software Foundation, either version 3 of the License, or
 | 
			
		||||
 * (at your option) any later version.
 | 
			
		||||
 * 
 | 
			
		||||
 * Alfresco is distributed in the hope that it will be useful,
 | 
			
		||||
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 | 
			
		||||
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 | 
			
		||||
 * GNU Lesser General Public License for more details.
 | 
			
		||||
 * 
 | 
			
		||||
 * You should have received a copy of the GNU Lesser General Public License
 | 
			
		||||
 * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
 | 
			
		||||
 * #L%
 | 
			
		||||
 */
 | 
			
		||||
package org.alfresco.repo.jscript;
 | 
			
		||||
 | 
			
		||||
import java.lang.management.ManagementFactory;
 | 
			
		||||
import java.lang.management.ThreadMXBean;
 | 
			
		||||
 | 
			
		||||
/**
 | 
			
		||||
 * Allows to monitor memory usage
 | 
			
		||||
 */
 | 
			
		||||
public class AlfrescoScriptThreadMxBeanWrapper
 | 
			
		||||
{
 | 
			
		||||
 | 
			
		||||
    private ThreadMXBean threadMXBean = null;
 | 
			
		||||
    private boolean threadAllocatedMemorySupported = false;
 | 
			
		||||
 | 
			
		||||
    private final String THREAD_MX_BEAN_SUN = "com.sun.management.ThreadMXBean";
 | 
			
		||||
 | 
			
		||||
    public AlfrescoScriptThreadMxBeanWrapper()
 | 
			
		||||
    {
 | 
			
		||||
        checkThreadAllocatedMemory();
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public long getThreadAllocatedBytes(long threadId)
 | 
			
		||||
    {
 | 
			
		||||
        if (threadMXBean != null && threadAllocatedMemorySupported)
 | 
			
		||||
        {
 | 
			
		||||
            return ((com.sun.management.ThreadMXBean) threadMXBean).getThreadAllocatedBytes(threadId);
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        return -1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public void checkThreadAllocatedMemory()
 | 
			
		||||
    {
 | 
			
		||||
        try
 | 
			
		||||
        {
 | 
			
		||||
            Class<?> clazz = Class.forName(THREAD_MX_BEAN_SUN);
 | 
			
		||||
            if (clazz != null)
 | 
			
		||||
            {
 | 
			
		||||
                this.threadAllocatedMemorySupported = true;
 | 
			
		||||
                this.threadMXBean = (com.sun.management.ThreadMXBean) ManagementFactory.getThreadMXBean();
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
        catch (Exception e)
 | 
			
		||||
        {
 | 
			
		||||
            this.threadAllocatedMemorySupported = false;
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    public boolean isThreadAllocatedMemorySupported()
 | 
			
		||||
    {
 | 
			
		||||
        return threadAllocatedMemorySupported;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -57,10 +57,12 @@ import org.alfresco.service.namespace.QName;
 | 
			
		||||
import org.apache.commons.logging.Log;
 | 
			
		||||
import org.apache.commons.logging.LogFactory;
 | 
			
		||||
import org.mozilla.javascript.Context;
 | 
			
		||||
import org.mozilla.javascript.ContextFactory;
 | 
			
		||||
import org.mozilla.javascript.ImporterTopLevel;
 | 
			
		||||
import org.mozilla.javascript.Script;
 | 
			
		||||
import org.mozilla.javascript.Scriptable;
 | 
			
		||||
import org.mozilla.javascript.ScriptableObject;
 | 
			
		||||
import org.mozilla.javascript.ScriptableObject;
 | 
			
		||||
import org.mozilla.javascript.Undefined;
 | 
			
		||||
import org.mozilla.javascript.WrapFactory;
 | 
			
		||||
import org.mozilla.javascript.WrappedException;
 | 
			
		||||
import org.springframework.beans.factory.InitializingBean;
 | 
			
		||||
@@ -108,7 +110,24 @@ public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcess
 | 
			
		||||
    /** Cache of runtime compiled script instances */
 | 
			
		||||
    private final Map<String, Script> scriptCache = new ConcurrentHashMap<String, Script>(256);
 | 
			
		||||
    
 | 
			
		||||
    
 | 
			
		||||
    /** Rhino optimization level */
 | 
			
		||||
    private int optimizationLevel = -1;
 | 
			
		||||
 | 
			
		||||
    /** Maximum seconds a script is allowed to run */
 | 
			
		||||
    private int maxScriptExecutionSeconds = -1;
 | 
			
		||||
 | 
			
		||||
    /** Maximum of call stack depth (in terms of number of call frames) */
 | 
			
		||||
    private int maxStackDepth = -1;
 | 
			
		||||
 | 
			
		||||
    /** Maximum memory (bytes) a script can use */
 | 
			
		||||
    private long maxMemoryUsedInBytes = -1L;
 | 
			
		||||
 | 
			
		||||
    /** Number of (bytecode) instructions that will trigger the observer */
 | 
			
		||||
    private int observerInstructionCount = 100;
 | 
			
		||||
 | 
			
		||||
    /** Custom context factory */
 | 
			
		||||
    public static AlfrescoContextFactory contextFactory;
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Set the default store reference
 | 
			
		||||
     * 
 | 
			
		||||
@@ -143,6 +162,51 @@ public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcess
 | 
			
		||||
    {
 | 
			
		||||
        this.shareSealedScopes = shareSealedScopes;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @param optimizationLevel
 | 
			
		||||
     *            -1 interpretive mode, 0 no optimizations, 1-9 optimizations performed
 | 
			
		||||
     */
 | 
			
		||||
    public void setOptimizationLevel(int optimizationLevel)
 | 
			
		||||
    {
 | 
			
		||||
        this.optimizationLevel = optimizationLevel;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @param maxScriptExecutionSeconds
 | 
			
		||||
     *            the number of seconds a script is allowed to run
 | 
			
		||||
     */
 | 
			
		||||
    public void setMaxScriptExecutionSeconds(int maxScriptExecutionSeconds)
 | 
			
		||||
    {
 | 
			
		||||
        this.maxScriptExecutionSeconds = maxScriptExecutionSeconds;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @param maxStackDepth
 | 
			
		||||
     *            the number of call stack depth allowed
 | 
			
		||||
     */
 | 
			
		||||
    public void setMaxStackDepth(int maxStackDepth)
 | 
			
		||||
    {
 | 
			
		||||
        this.maxStackDepth = maxStackDepth;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @param maxMemoryUsedInBytes
 | 
			
		||||
     *            the number of memory a script can use
 | 
			
		||||
     */
 | 
			
		||||
    public void setMaxMemoryUsedInBytes(long maxMemoryUsedInBytes)
 | 
			
		||||
    {
 | 
			
		||||
        this.maxMemoryUsedInBytes = maxMemoryUsedInBytes;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @param observerInstructionCount
 | 
			
		||||
     *            the number of instructions that will trigger {@link ContextFactory#observeInstructionCount}
 | 
			
		||||
     */
 | 
			
		||||
    public void setObserverInstructionCount(int observerInstructionCount)
 | 
			
		||||
    {
 | 
			
		||||
        this.observerInstructionCount = observerInstructionCount;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * @see org.alfresco.service.cmr.repository.ScriptProcessor#reset()
 | 
			
		||||
@@ -449,6 +513,8 @@ public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcess
 | 
			
		||||
    private Object executeScriptImpl(Script script, Map<String, Object> model, boolean secure, String debugScriptName)
 | 
			
		||||
        throws AlfrescoRuntimeException
 | 
			
		||||
    {
 | 
			
		||||
        Scriptable scope = null;
 | 
			
		||||
 | 
			
		||||
        long startTime = 0;
 | 
			
		||||
        if (callLogger.isDebugEnabled())
 | 
			
		||||
        {
 | 
			
		||||
@@ -465,14 +531,16 @@ public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcess
 | 
			
		||||
            // Create a thread-specific scope from one of the shared scopes.
 | 
			
		||||
            // See http://www.mozilla.org/rhino/scopes.html
 | 
			
		||||
            cx.setWrapFactory(secure ? wrapFactory : sandboxFactory);
 | 
			
		||||
            Scriptable scope;
 | 
			
		||||
 | 
			
		||||
            // Enables or disables execution limits based on secure flag
 | 
			
		||||
            enableLimits(cx, secure);
 | 
			
		||||
 | 
			
		||||
            if (this.shareSealedScopes)
 | 
			
		||||
            {
 | 
			
		||||
                Scriptable sharedScope = secure ? this.nonSecureScope : this.secureScope;
 | 
			
		||||
                scope = cx.newObject(sharedScope);
 | 
			
		||||
                scope.setPrototype(sharedScope);
 | 
			
		||||
                scope.setParentScope(null);
 | 
			
		||||
 | 
			
		||||
            }
 | 
			
		||||
            else
 | 
			
		||||
            {
 | 
			
		||||
@@ -545,7 +613,8 @@ public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcess
 | 
			
		||||
            throw new AlfrescoRuntimeException(err.getMessage(), err);
 | 
			
		||||
        }
 | 
			
		||||
        finally
 | 
			
		||||
        {
 | 
			
		||||
        {
 | 
			
		||||
            unsetScope(model, scope);
 | 
			
		||||
            Context.exit();
 | 
			
		||||
            
 | 
			
		||||
            if (callLogger.isDebugEnabled())
 | 
			
		||||
@@ -638,6 +707,9 @@ public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcess
 | 
			
		||||
     */
 | 
			
		||||
    public void afterPropertiesSet() throws Exception
 | 
			
		||||
    {
 | 
			
		||||
        // Initialize context factory
 | 
			
		||||
        initContextFactory();
 | 
			
		||||
 | 
			
		||||
        // Initialize the secure scope
 | 
			
		||||
        Context cx = Context.enter();
 | 
			
		||||
        try
 | 
			
		||||
@@ -695,4 +767,129 @@ public class RhinoScriptProcessor extends BaseProcessor implements ScriptProcess
 | 
			
		||||
        }
 | 
			
		||||
        return scope;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Clean supplied scope and unset it from any model instance where it has been injected before
 | 
			
		||||
     *
 | 
			
		||||
     * @param model
 | 
			
		||||
     *            Data model containing objects from where scope will be unset
 | 
			
		||||
     * @param scope
 | 
			
		||||
     *            The scope to clean
 | 
			
		||||
     */
 | 
			
		||||
    private void unsetScope(Map<String, Object> model, Scriptable scope)
 | 
			
		||||
    {
 | 
			
		||||
        if (scope != null)
 | 
			
		||||
        {
 | 
			
		||||
            Object[] ids = scope.getIds();
 | 
			
		||||
            if (ids != null)
 | 
			
		||||
            {
 | 
			
		||||
                for (Object id : ids)
 | 
			
		||||
                {
 | 
			
		||||
                    try
 | 
			
		||||
                    {
 | 
			
		||||
                        deleteProperty(scope, id.toString());
 | 
			
		||||
                    }
 | 
			
		||||
                    catch (Exception e)
 | 
			
		||||
                    {
 | 
			
		||||
                        logger.info("Unable to delete id: " + id, e);
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
 | 
			
		||||
        if (model != null)
 | 
			
		||||
        {
 | 
			
		||||
            for (String key : model.keySet())
 | 
			
		||||
            {
 | 
			
		||||
                try
 | 
			
		||||
                {
 | 
			
		||||
                    deleteProperty(scope, key);
 | 
			
		||||
 | 
			
		||||
                    Object obj = model.get(key);
 | 
			
		||||
                    if (obj instanceof Scopeable)
 | 
			
		||||
                    {
 | 
			
		||||
                        ((Scopeable) obj).setScope(null);
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
                catch (Exception e)
 | 
			
		||||
                {
 | 
			
		||||
                    logger.info("Unable to unset model object " + key + " : ", e);
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Deletes a property from the supplied scope, if property is not removable, then is set to null
 | 
			
		||||
     *
 | 
			
		||||
     * @param scope
 | 
			
		||||
     *            the scope object from where property will be removed
 | 
			
		||||
     * @param name
 | 
			
		||||
     *            the property name to delete
 | 
			
		||||
     */
 | 
			
		||||
    private void deleteProperty(Scriptable scope, String name)
 | 
			
		||||
    {
 | 
			
		||||
        if (scope != null && name != null)
 | 
			
		||||
        {
 | 
			
		||||
            if (!ScriptableObject.deleteProperty(scope, name))
 | 
			
		||||
            {
 | 
			
		||||
                ScriptableObject.putProperty(scope, name, null);
 | 
			
		||||
            }
 | 
			
		||||
            scope.delete(name);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Initializes the context factory with limits configuration
 | 
			
		||||
     */
 | 
			
		||||
    private synchronized void initContextFactory()
 | 
			
		||||
    {
 | 
			
		||||
        if (contextFactory == null)
 | 
			
		||||
        {
 | 
			
		||||
            contextFactory = new AlfrescoContextFactory();
 | 
			
		||||
            contextFactory.setOptimizationLevel(optimizationLevel);
 | 
			
		||||
 | 
			
		||||
            if (maxScriptExecutionSeconds > 0)
 | 
			
		||||
            {
 | 
			
		||||
                contextFactory.setMaxScriptExecutionSeconds(maxScriptExecutionSeconds);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (maxMemoryUsedInBytes > 0L)
 | 
			
		||||
            {
 | 
			
		||||
                contextFactory.setMaxMemoryUsedInBytes(maxMemoryUsedInBytes);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (maxStackDepth > 0)
 | 
			
		||||
            {
 | 
			
		||||
                contextFactory.setMaxStackDepth(maxStackDepth);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            if (maxScriptExecutionSeconds > 0 || maxMemoryUsedInBytes > 0L)
 | 
			
		||||
            {
 | 
			
		||||
                contextFactory.setObserveInstructionCount(observerInstructionCount);
 | 
			
		||||
            }
 | 
			
		||||
 | 
			
		||||
            ContextFactory.initGlobal(contextFactory);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * If script is considered secure no limits will be applied, otherwise, the limits are enabled and the script can be
 | 
			
		||||
     * interrupted in case a limit has been reached.
 | 
			
		||||
     *
 | 
			
		||||
     * @param cx
 | 
			
		||||
     *            the Rhino scope
 | 
			
		||||
     * @param secure
 | 
			
		||||
     *            true if script execution is considered secure (e.g, deployed at classpath level)
 | 
			
		||||
     */
 | 
			
		||||
    private void enableLimits(Context cx, boolean secure)
 | 
			
		||||
    {
 | 
			
		||||
        if (cx != null)
 | 
			
		||||
        {
 | 
			
		||||
            if (cx instanceof AlfrescoScriptContext)
 | 
			
		||||
            {
 | 
			
		||||
                ((AlfrescoScriptContext) cx).setLimitsEnabled(!secure);
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
@@ -267,7 +267,11 @@ public class SolrJSONResultSet implements SearchEngineResultSet {
 | 
			
		||||
                        ArrayList<Pair<String, Integer>> facetValues = new ArrayList<Pair<String, Integer>>(facetArraySize/2);
 | 
			
		||||
                        for(int i = 0; i < facetArraySize; i+=2)
 | 
			
		||||
                        {
 | 
			
		||||
                            String facetEntryName = facets.getString(i);
 | 
			
		||||
                            String facetEntryName = "Null";
 | 
			
		||||
                            if(!facets.isNull(i))
 | 
			
		||||
                            {
 | 
			
		||||
                                facetEntryName = facets.getString(i);
 | 
			
		||||
                            }
 | 
			
		||||
                            Integer facetEntryCount = Integer.valueOf(facets.getInt(i+1));
 | 
			
		||||
                            Pair<String, Integer> pair = new Pair<String, Integer>(facetEntryName, facetEntryCount);
 | 
			
		||||
                            facetValues.add(pair);
 | 
			
		||||
 
 | 
			
		||||
@@ -252,4 +252,16 @@ public interface AuditService
 | 
			
		||||
    {
 | 
			
		||||
        return -1;
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    /**
 | 
			
		||||
     * Issue an audit query to retrieve min / max audit record id for a given application and properties
 | 
			
		||||
     *
 | 
			
		||||
     * @param applicationName               the name of the application
 | 
			
		||||
     * @param parameters                    audit parameters provided by the <code>where</code> clause on the ReST API
 | 
			
		||||
     * @return                              a map containing min/max and the associated value
 | 
			
		||||
     */
 | 
			
		||||
    default int getAuditEntriesCountByAppAndProperties(String applicationName, AuditQueryParameters parameters)
 | 
			
		||||
    {
 | 
			
		||||
        return -1;
 | 
			
		||||
    }
 | 
			
		||||
}
 | 
			
		||||
 
 | 
			
		||||
@@ -50,6 +50,15 @@
 | 
			
		||||
    <!-- Parameter Maps -->
 | 
			
		||||
    <!--                -->
 | 
			
		||||
 | 
			
		||||
    <parameterMap id="parameter_AuditAppId_WhereClauseMap" type="map">
 | 
			
		||||
        <parameter property="auditAppNameId" jdbcType="BIGINT" javaType="Long"/>
 | 
			
		||||
        <parameter property="auditUserId" jdbcType="BIGINT" javaType="Long"/>
 | 
			
		||||
        <parameter property="auditFromTime" jdbcType="BIGINT" javaType="Long"/>
 | 
			
		||||
        <parameter property="auditToTime" jdbcType="BIGINT" javaType="Long"/>
 | 
			
		||||
        <parameter property="auditFromId" jdbcType="BIGINT" javaType="Long"/>
 | 
			
		||||
        <parameter property="auditToId" jdbcType="BIGINT" javaType="Long"/>
 | 
			
		||||
    </parameterMap>
 | 
			
		||||
 | 
			
		||||
    <parameterMap id="parameter_IdMap" type="map">
 | 
			
		||||
        <parameter property="id" jdbcType="BIGINT" javaType="java.lang.Long"/>
 | 
			
		||||
    </parameterMap>
 | 
			
		||||
@@ -291,6 +300,20 @@
 | 
			
		||||
        alf_audit_entry.audit_app_id = #{auditAppId}
 | 
			
		||||
    </select>
 | 
			
		||||
 | 
			
		||||
    <select id="select_CountAuditEntryIdWithWhereClause" parameterMap="parameter_AuditAppId_WhereClauseMap" resultType="int">
 | 
			
		||||
        select
 | 
			
		||||
            COUNT(entry.id)
 | 
			
		||||
        from
 | 
			
		||||
            alf_audit_entry as entry
 | 
			
		||||
        <if test="auditAppNameId != null">
 | 
			
		||||
            join alf_audit_app app on (entry.audit_app_id = app.id)
 | 
			
		||||
        </if>
 | 
			
		||||
        <if test="keyOrValueSearch == true">
 | 
			
		||||
            join alf_prop_link sp_pl on (sp_pl.root_prop_id = entry.audit_values_id)
 | 
			
		||||
        </if>
 | 
			
		||||
        <include refid="select_AuditEntriesWhereSnippet"/>
 | 
			
		||||
    </select>
 | 
			
		||||
 | 
			
		||||
    <!-- Get the maximum/minimum audit entry id for application -->
 | 
			
		||||
    <select id="select_MinMaxAuditEntryId" parameterMap="parameter_IdMinMaxMap" resultMap="result_minMaxMap">
 | 
			
		||||
        select
 | 
			
		||||
 
 | 
			
		||||
@@ -3,7 +3,7 @@
 | 
			
		||||
repository.name=Main Repository
 | 
			
		||||
 | 
			
		||||
# Schema number
 | 
			
		||||
version.schema=17000
 | 
			
		||||
version.schema=17100
 | 
			
		||||
 | 
			
		||||
# Directory configuration
 | 
			
		||||
 | 
			
		||||
@@ -1351,3 +1351,18 @@ import.zip.compressionRatioThreshold=100
 | 
			
		||||
# "zip bomb" and the import extraction process cancelled. No value (or a negative long) will be taken to mean that no
 | 
			
		||||
# limit should be applied.
 | 
			
		||||
import.zip.uncompressedBytesLimit=
 | 
			
		||||
 | 
			
		||||
# Rhino optimization level
 | 
			
		||||
scripts.execution.optimizationLevel=0
 | 
			
		||||
 | 
			
		||||
# Max seconds a script is allowed to run
 | 
			
		||||
scripts.execution.maxScriptExecutionSeconds=-1
 | 
			
		||||
 | 
			
		||||
# Max call stack depth
 | 
			
		||||
scripts.execution.maxStackDepth=-1
 | 
			
		||||
 | 
			
		||||
# Max memory (bytes) a script can use
 | 
			
		||||
scripts.execution.maxMemoryUsedInBytes=-1
 | 
			
		||||
 | 
			
		||||
# Number of instructions that will trigger the observer
 | 
			
		||||
scripts.execution.observerInstructionCount=-1
 | 
			
		||||
 
 | 
			
		||||
@@ -45,6 +45,21 @@
 | 
			
		||||
        <property name="storePath">
 | 
			
		||||
            <value>${spaces.company_home.childname}</value>
 | 
			
		||||
        </property>
 | 
			
		||||
        <property name="optimizationLevel">
 | 
			
		||||
            <value>${scripts.execution.optimizationLevel}</value>
 | 
			
		||||
        </property>
 | 
			
		||||
        <property name="maxScriptExecutionSeconds">
 | 
			
		||||
            <value>${scripts.execution.maxScriptExecutionSeconds}</value>
 | 
			
		||||
        </property>
 | 
			
		||||
        <property name="maxStackDepth">
 | 
			
		||||
            <value>${scripts.execution.maxStackDepth}</value>
 | 
			
		||||
        </property>
 | 
			
		||||
        <property name="maxMemoryUsedInBytes">
 | 
			
		||||
            <value>${scripts.execution.maxMemoryUsedInBytes}</value>
 | 
			
		||||
        </property>
 | 
			
		||||
        <property name="observerInstructionCount">
 | 
			
		||||
            <value>${scripts.execution.observerInstructionCount}</value>
 | 
			
		||||
        </property>
 | 
			
		||||
    </bean>
 | 
			
		||||
 | 
			
		||||
    <!-- base config implementation that script extension beans extend from - for auto registration
 | 
			
		||||
 
 | 
			
		||||
@@ -44,7 +44,6 @@ import org.alfresco.service.cmr.repository.ContentService;
 | 
			
		||||
import org.alfresco.service.cmr.repository.ContentWriter;
 | 
			
		||||
import org.alfresco.service.cmr.repository.NodeRef;
 | 
			
		||||
import org.alfresco.service.cmr.repository.NodeService;
 | 
			
		||||
import org.alfresco.service.cmr.repository.ScriptProcessor;
 | 
			
		||||
import org.alfresco.service.cmr.repository.ScriptService;
 | 
			
		||||
import org.alfresco.service.cmr.repository.StoreRef;
 | 
			
		||||
import org.alfresco.service.namespace.QName;
 | 
			
		||||
@@ -53,8 +52,11 @@ import org.alfresco.test_category.OwnJVMTestsCategory;
 | 
			
		||||
import org.alfresco.util.ApplicationContextHelper;
 | 
			
		||||
import org.junit.experimental.categories.Category;
 | 
			
		||||
import org.mozilla.javascript.Context;
 | 
			
		||||
import org.mozilla.javascript.ImporterTopLevel;
 | 
			
		||||
import org.mozilla.javascript.Scriptable;
 | 
			
		||||
import org.mozilla.javascript.ScriptableObject;
 | 
			
		||||
import org.mozilla.javascript.Undefined;
 | 
			
		||||
import org.mozilla.javascript.UniqueTag;
 | 
			
		||||
import org.springframework.context.ApplicationContext;
 | 
			
		||||
 | 
			
		||||
import junit.framework.TestCase;
 | 
			
		||||
@@ -445,6 +447,67 @@ public class RhinoScriptTest extends TestCase
 | 
			
		||||
        assertTrue("Script should have been executed (secure = true)", executed);
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    // MNT-23158
 | 
			
		||||
    public void testScopeData()
 | 
			
		||||
    {
 | 
			
		||||
        transactionService.getRetryingTransactionHelper().doInTransaction(
 | 
			
		||||
            new RetryingTransactionCallback<Object>()
 | 
			
		||||
            {
 | 
			
		||||
                public Object execute() throws Exception
 | 
			
		||||
                {
 | 
			
		||||
                    Context cx = Context.enter();
 | 
			
		||||
                    try
 | 
			
		||||
                    {
 | 
			
		||||
                        Scriptable sharedScope = new ImporterTopLevel(cx, true);
 | 
			
		||||
                        Scriptable scope = cx.newObject(sharedScope);
 | 
			
		||||
                        scope.setPrototype(sharedScope);
 | 
			
		||||
                        scope.setParentScope(null);
 | 
			
		||||
 | 
			
		||||
                        // Executes a first script
 | 
			
		||||
                        Object result = cx.evaluateString(scope, "var a = 10; var b = 20; var sum = a+b;", "TestJS1", 1, null);
 | 
			
		||||
                        assertTrue(Undefined.isUndefined(result));
 | 
			
		||||
 | 
			
		||||
                        // Test sum value
 | 
			
		||||
                        Object sum = scope.get("sum", scope);
 | 
			
		||||
                        assertEquals(30.0, Context.toNumber(sum));
 | 
			
		||||
 | 
			
		||||
                        // No 'sum' property should be found in the shared scope
 | 
			
		||||
                        sum = sharedScope.get("sum", sharedScope);
 | 
			
		||||
                        assertEquals(sum, UniqueTag.NOT_FOUND);
 | 
			
		||||
 | 
			
		||||
                        // No 'b' property should be found in the shared scope
 | 
			
		||||
                        Object b = ScriptableObject.getProperty(sharedScope, "b");
 | 
			
		||||
                        assertEquals(b, UniqueTag.NOT_FOUND);
 | 
			
		||||
 | 
			
		||||
                        // Cleans scope
 | 
			
		||||
                        unsetScope(scope);
 | 
			
		||||
 | 
			
		||||
                        // Executes a second script using the same scope
 | 
			
		||||
                        result = cx.evaluateString(scope, "var test = 'test';", "TestJS2", 1, null);
 | 
			
		||||
 | 
			
		||||
                        // 'sum' property should be null
 | 
			
		||||
                        sum = scope.get("sum", scope);
 | 
			
		||||
                        assertNull(sum);
 | 
			
		||||
 | 
			
		||||
                        // New scope initialization
 | 
			
		||||
                        scope = cx.newObject(sharedScope);
 | 
			
		||||
                        scope.setPrototype(sharedScope);
 | 
			
		||||
                        scope.setParentScope(null);
 | 
			
		||||
 | 
			
		||||
                        // check 'test' property
 | 
			
		||||
                        Object test = scope.get("test", scope);
 | 
			
		||||
                        assertEquals(test, UniqueTag.NOT_FOUND);
 | 
			
		||||
                    }
 | 
			
		||||
                    finally
 | 
			
		||||
                    {
 | 
			
		||||
                        Context.exit();
 | 
			
		||||
                    }
 | 
			
		||||
 | 
			
		||||
                    return null;
 | 
			
		||||
                }
 | 
			
		||||
            });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private boolean executeSecureScriptString(String script, Boolean secure)
 | 
			
		||||
    {
 | 
			
		||||
        return transactionService.getRetryingTransactionHelper().doInTransaction(new RetryingTransactionCallback<Boolean>()
 | 
			
		||||
@@ -475,6 +538,41 @@ public class RhinoScriptTest extends TestCase
 | 
			
		||||
            }
 | 
			
		||||
        });
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void unsetScope(Scriptable scope)
 | 
			
		||||
    {
 | 
			
		||||
        if (scope != null)
 | 
			
		||||
        {
 | 
			
		||||
            Object[] ids = scope.getIds();
 | 
			
		||||
 | 
			
		||||
            if (ids != null)
 | 
			
		||||
            {
 | 
			
		||||
                for (Object id : ids)
 | 
			
		||||
                {
 | 
			
		||||
                    try
 | 
			
		||||
                    {
 | 
			
		||||
                        deleteProperty(scope, id.toString());
 | 
			
		||||
                    }
 | 
			
		||||
                    catch (Exception e)
 | 
			
		||||
                    {
 | 
			
		||||
                        // Do nothing
 | 
			
		||||
                    }
 | 
			
		||||
                }
 | 
			
		||||
            }
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private void deleteProperty(Scriptable scope, String name)
 | 
			
		||||
    {
 | 
			
		||||
        if (scope != null && name != null)
 | 
			
		||||
        {
 | 
			
		||||
            if (!ScriptableObject.deleteProperty(scope, name))
 | 
			
		||||
            {
 | 
			
		||||
                ScriptableObject.putProperty(scope, name, null);
 | 
			
		||||
            }
 | 
			
		||||
            scope.delete(name);
 | 
			
		||||
        }
 | 
			
		||||
    }
 | 
			
		||||
 | 
			
		||||
    private static final String TESTSCRIPT_CLASSPATH1 = "org/alfresco/repo/jscript/test_script1.js";
 | 
			
		||||
    private static final String TESTSCRIPT_CLASSPATH2 = "org/alfresco/repo/jscript/test_script2.js";
 | 
			
		||||
 
 | 
			
		||||
		Reference in New Issue
	
	Block a user