Dave Ward 890d3795ce Merged V3.3 to HEAD
20440: RM: CapabilitiesTest.testDestroyRecordsCapability (MS SQL Server build) - use non-public nodeService
   20441: Include virtual tomcat in installers
   20442: Change bitrock builder version to use.
   20443: Merged BRANCHES/DEV/V3.3-BUG-FIX to BRANCHES/V3.3: (Fixed tabs and removed 'svn:executable' and 'svn:eol-style')
      20384: Merged BRANCHES/DEV/BELARUS/HEAD-2010_04_28 to BRANCHES/DEV/V3.3-BUG-FIX:
         20271: ALF-803: Asset Service Improvements
      20386: Merged V2.2 to V3.3-BUG-FIX
         20385: Merged DEV/BELARUS/V2.2-2010_04_06 to V2.2
            20379: V2.2-ALF-1888 AssociationQuery was corrected to filter ...
      20387: Version Migrator (ALF-1000) - approx x3 boost (policies ignore version2 store)
      20388: Merged BRANCHES/DEV/BELARUS/HEAD-2010_04_28 to BRANCHES/DEV/V3.3-BUG-FIX:
         20372: ALF-897: It is impossible to create content when default value selected in ContentHeadlineBackground field for intranet_rssi_landing_template web-form (also fixes ALF-2798 & ALF-791)
      20389: Merged BRANCHES/DEV/BELARUS/HEAD-2010_04_28 to BRANCHES/DEV/V3.3-BUG-FIX:
         20374: ALF-2723: WCM - Http 500 creating content via webform
      20394: Fix for ALF-2257 - It's impossible to find and add group at Records Manage Permissions page
      20396: Fixed ALF-2956 "XSS attack is made when a rule is being deleted"
      20397: Fix for ALF-922: Mysql does not support unique keys that contain nulls as one would expect
      20402: ALF-2186 : Rules not being fired on datalist items - because it's a zero byte file?
      20404: Fixed ALF-2109 "Rule doesn't apply to the files in sub-folders when 'Run rule for this folder and its subfolders' action was performed"
      20406: Fix for ALF-2985 - Share document library throws error if document modifier or creator is deleted from Alfresco
      20409: Improved FormServiceImplTest, added more content related tests and some edge case tests using the FDK model (this test needs to be manually enabled though as the FDK model is not available by default)
      20414: Merged DEV/BELARUS/HEAD-2010_04_28 to DEV/V3.3-BUG-FIX
         20401: ALF-2616: Serious Web Form layout performance issues on IE8. This fix contains:
      20427: Merged DEV/BELARUS/HEAD-2010_04_28 to DEV/V3.3-BUG-FIX
         20042: ALF-1523: Failed Kerberos SSO auth doesn't fail through, simply returns a blank page
         20323: ALF-1523: Failed Kerberos SSO auth doesn't fail through, simply returns a blank page
      20428: Merged DEV/BELARUS/HEAD-2010_04_28 to DEV/V3.3-BUG-FIX
         20417: ALF-736: WebDAV Folder Renaming fails on Mac but works on Windows.
      20430: Fix for ALF-2313 - Accessing a Doclib folder in Share which has a link to a deleted node fails
      20431: Version Migrator (ALF-1000) - migrate 1st batch independently
      20432: Fix for ALF-2327 - Can not have more than one Transfer Step in a disposal schedule
      20438: ALF-479: Merged DEV/BELARUS/V3.2-2010_01_11 to DEV/V3.3-BUG-FIX
         18448: ETHREEOH-4044: External Authentication Subsystem does not perform user mapping for WebDAV requests
   20444: Fix for ConcurrentModificationException in file server quota manager. ALF-2970.
   20445: Merged HEAD to BRANCHES/V3.3: (RECORD ONLY)
      20413: Added clean of quickr project
   20446: Changed version to 3.3.1dev
   20447: Merged V3.3-BUG-FIX to V3.3
      20294: Fixes: ALF-1020 & ALF-1013 for all views except agenda.
   20451: Merged V2.2 to V3.3
      20450: Merged DEV/BELARUS/V2.2-2010_04_06 to V2.2
         20412: ALF-1887: too easy to break alfresco - one can remove the guest user and recreate it but then access to RSS is broken
            - PersonServiceImpl.beforeDeleteNode prohibits attempts to delete a guest user.
   20452: Fix for transaction error from NFS server file expiry thread. ALF-3016.
   20458: ALF-2729 - rationalise (and deprecate) VersionLabelComparator
   20460: Fix for ALF-2430
      - AVM nodes are not checked for exclusion - the default ACLEntryVoter will always vote for AVM
      - avoids embedded AVM permission checks for getType/getAspect and anything else that may be added
      - seems AVM read is not checked upon "lookup" for the last node in the PATH (getType should have failed too)
   20466: Merged V2.2 to V3.3
      20243: (RECORD ONLY) ALF-2814: Merged V3.2 to V2.2
         17891: Merged DEV_TEMPORARY to V3.2
            17873: ETHREEOH-3810: WCM - Recursion detector erroring
   20467: Merged V3.1 to V3.3 (RECORD ONLY)
      20276: Incremented version label
      20275: ALF-2845: Merged V3.2 to V3.1
         17768: Merged DEV/BELARUS/V3.2-2009_11_24 to V3.2
            17758: ETHREEOH-3757: Oracle upgrade issue: failed "inviteEmailTemplate" patch - also causes subsequent patches to not be applied
      19573: Merged V3.2 to V3.1
         19539: Merged HEAD to V3.2
            19538: Build fix - fix build speed
   20468: Merged PATCHES/V3.2.r to V3.3 (RECORD ONLY)
      20357: Merged PATCHES/V3.2.0 to PATCHES/V3.2.r
         20349: Merged V3.3 to PATCHES/V3.2.0
            20346: ALF-2839: Node pre-loading generates needless resultset rows
               - Added missing Criteria.list() call
      20339: Incremented version label
      20338: Merged PATCHES/V3.2.0 to PATCHES/V3.2.r
         20280: Fixed ALF-2839: Node pre-loading generates needless resultset rows
            - Split Criteria query to retrieve properties and aspects separately
         20272: Backports to help fix ALF-2839: Node pre-loading generates needless resultset rows
            Merged BRANCHES/V3.2 to PATCHES/V3.2.0:
               18490: Added cache for alf_content_data
            Merged BRANCHES/DEV/V3.3-BUG-FIX to PATCHES/V3.2.0:
               20231: Fixed ALF-2784: Degradation of performance between 3.1.1 and 3.2x (observed in JSF)
         20266: Test reproduction of ALF-2839 failure: Node pre-loading generates needless resultset rows
   20469: Merged PATCHES/V3.1.2 to V3.3 (RECORD ONLY)
      20393: Eclipse classpath fix to avoid problems in JBoss
      20309: ALF-2777: PrimaryChildAssocCopyBehaviour from MOB-388 corrupts cm:name attributes of copied child nodes
         - Folded example behaviours from previous AMP into repository
         - Fixed PrimaryChildAssocCopyBehaviour to back-up and set the cm:name property on copied children
   20470: Merged PATCHES/V3.2.0 to V3.3 (RECORD ONLY)
      20465: Incremented version label
      20464: ALF-3060: Merged V3.2 to PATCHES/V3.2.0
         19920: Merged HEAD to BRANCHES/V3.2:
            19918: Fix ALF-2499 (Deleting a web project also deletes similarly named web projects - Potential Data Loss)
      20448: Merged DEV/V3.3-BUG-FIX to PATCHES/V3.2.0
         20414: Merged DEV/BELARUS/HEAD-2010_04_28 to DEV/V3.3-BUG-FIX
            20401: ALF-2616: Serious Web Form layout performance issues on IE8. This fix contains:
               a) X-UA-Compatible head tag with IE=EmulateIE7 value
               b) alfresco.ieVersion and alfresco.ieEngine in common.js
               c) recurseOnChildren in _updateDisplay
               d) Some performance modifications in xforms.js
      20350: Increment version label
      20349: Merged V3.3 to PATCHES/V3.2.0
         20346: ALF-2839: Node pre-loading generates needless resultset rows
            - Added missing Criteria.list() call
   20471: Fix for offline sync losing metadata properties, due to rename/delete of original file. ALF-575.
   20478: Merged HEAD to BRANCHES/V3.3: (RECORD ONLY)
      20477: Fix ALF-3086: CMIS checkin of a non-versionable document should make it versionable
   20479: ALF-2110: Make it possible to determine which person properties are synced via LDAP and hence immutable
      - Added Set<QName> UserRegistrySynchronizer.getPersonMappedProperties(String username)
      - UI/Services Fix to follow
   20481: Latest SpringSurf libs:
      - Fix for ALF-1518 - Added support for HTTP and HTTPS proxies for Surf application remote api calls - via the standard JVM cmd line properties such as -Dhttp.proxyHost=...
   20484: ALF-2886: LDAP sync defaults display names incorrectly and can't cope with DNs containing escaped trailing whitespace.
      - Had to work around a JDK bug in LDAP RDN parsing
   20486: Added case sensitive flag to the file state cache. Part of ALF-570.
   20487: Fix for copy/rename of folders causing file exists errors in some cases. ALF-570.
   20488: Fix ALF-680: Previously valid content models now fail with CMISAbstractDictionaryService$DictionaryRegistry exception
   20489: Uploaded correct version of spring source jars and reunited them with 3rd-party/.classpath
   20490: Fix for cannot delete folders via CIFS from Mac OSX, due to desktop actions. ALF-2553.
   20491: Merged DEV/TEMPORARY to V3.3 (With corrections)
      20485: ALF-2290: a HTTP GET request of a document redirects to the Home Location when using NTLM SSO
         The logic related to ADB-61 in NTLMAuthenticationFilter clears previous location and redirects request to default home location. NTLMAuthenticationFilter was changed to process GET requests to documents correctly. Now, fix to ADB-61 processes only “/faces” requests and GET requests to documents are processed correctly.
         The same fix was made to KerberosAuthenticationFilter
   20492: Fix ALF-680: Previously valid content models now fail with CMISAbstractDictionaryService$DictionaryRegistry exception
      - missing remove directory
   20493: Fix ALF-2837: ClassCastException in getProperties()
   20498: Fix for ALF-2818: Failure to close index writer under certain conditions.
      - fix for index writer to close indexes when stopped by exceptions during FTS
      - fix FTS job to handle exceptions better
      - debug for FTS background operations
   20499: ALF-3094: In ticket authenticate method in AuthenticationHelper, invalidate the current session if its cached ticket doesn't match
   20500: Fix for ALF-2858 "Zero KB sized bin files will be created in the contentstore when new sites are created" (RECORD ONLY)
   20503: AVMTestSuite: minor fixes to cleanup ctx usage (avoid re-loading)
   20505: Merged BRANCHES/V2.2 to BRANCHES/V3.3 (record-only)
      13859: (record-only) Removed dev from version label
      14003: (record-only) Updated version to 2.2.5dev
      14566: (record-only) ETWOTWO-1239 - remove workflow interpreter/console bootstrap
      14572: (record-only) ETWOTWO-1239 - fix PersonTest to fix JBPMEngineTest (part-sourced from r13247)
      14776: (record-only) Merged V3.1 to V2.2
         14748: ETHREEOH-2225 - WCM upgrade (performance improvements for MySQL)
   20506: NFS ReadDir/ReadDirPlus skips some folder entries. JLAN-98. 
   20507: Fixed issue with folder search resume id being reset to the wrong value during NFS folder search. Part of JLAN-98.
   20508: Merged BRANCHES/V3.2 to BRANCHES/V3.3:
      18319: Merged BRANCHES/DEV/BELARUS/V3.2-2010_01_11 to V3.2
         18273: ETHREEOH-3834: WCM: An extral .xml.html file is created when editing newly created content
      19182: Merged V3.1 to V3.2
         18423: ETHREEOH-3850 - Content Manager unable to edit content items if there is a lock on a generated rendition
         18432: (RECORD ONLY) Added FTP data port range configuration via <dataPorts>n:n</dataPorts> config value. ETHREEOH-4103.
         18451: (RECORD ONLY) Fixed incorrect FTP debug level name.
         18577: (RECORD ONLY) Fix for ETHREEOH-4117, based on CHK-11154
         18792: Fix ETHREEOH-2729:  Import of property with @ symbol in name fails with "start tag unexpected character @ "
      19570: ALF-192 / ALF-1750:  System Error if user trying submit web content based on web form which was deleted
      19583: Merged DEV/BELARUS/V3.2-2010_03_17 to V3.2
         19545: ALF-1954: Regression: same item can be submitted multiple times to workflow
      19725: AVMStoreDescriptor - fix minor typo (for debugging)
      19917: (RECORD ONLY) Merged HEAD to BRANCHES/V3.2:
         19880: Fix ALF-898 - WCM: Deleting a file leads to error (only if RM/DOD installed)
      19920: (RECORD ONLY) Merged HEAD to BRANCHES/V3.2:
         19918: Fix ALF-2499 (Deleting a web project also deletes similarly named web projects - Potential Data Loss)
   20509: Merged BRANCHES/V3.2 to BRANCHES/V3.3 (RECORD ONLY):
      19825: (RECORD ONLY) Merged PATCHES/V3.2.r to BRANCHES/V3.2: 
         19804: Merged PATCHES/V3.2.0 to PATCHES/V3.2.r 
            Merged HEAD to V3.2.0 
            ...
   20510: Merged BRANCHES/V3.1 to BRANCHES/V3.3 (RECORD ONLY)
      17482: (RECORD ONLY) Merged V3.2 to V3.1
         17478: Fix ETHREEOH-3340 - WCM - Revert to snapshot failure (fix AVM getListing -> AVMSync compare -> WCM revertSnapshot)
      18783: (RECORD ONLY) MT: ensure group (EMAIL_CONTRIBUTORS) bootstraps tenant admin user (when creating tenant)
   20513: Added port change example for remote Alfresco server to share-config-custom.xml.sample
   20518: ALF-657 Created tests to check that the 'runas' functionality works in the AlfrescoJavaScript action handler. Also modified the handler to run as the System user if no Authentication is currently set, as may occur if the action handler is being executed asynchronously.
   20519: ALF-657 Created tests to check that the 'runas' functionality works in the AlfrescoJavaScript action handler. Also modified the handler to run as the System user if no Authentication is currently set, as may occur if the action handler is being executed asynchronously.
   20520: Removed dev version.label
   20522: ALF-3129: Map cm:organization property in LDAP as well as cm:organizationId, since cm:organization is what shows up in JSF and Share. Needed by ALF-2110.
   20523: First part of fix for ALF-2110:
      - Appropriate Person and webframework metadata APIs now return information on immutability of Person properties (as some properties are immutable when synced to LDAP etc.)
      - Share client  now correctly disables profile fields in User Profile and Admin User Console as appropriate based on individual user property mutability
      - Change Password button now correctly enabled/disabled based on account mutability
   20524: VersionMigrator - option to run as scheduled job (ALF-1000)
   20525: Fix for various IE6 CSS issues:
      ALF-3047 - It's impossible to destinate any action with data list item (IE6 specific)
      ALF-3049 - Incorrect layout of Manage aspects page
      ALF-3050 - Incorrect layout of Assign Workflow form
   20526: Fix for ALF-2915 - Select > None feature for Data Lists not working across multiple pages in IE
      Closed ALF-2846 - DataList UI not fully I18Ned [Old prototype code]
   20527: Fix for ALF-3082 - There is no Edit Offline action at Details page in Share site
   20528: Fix various script errors due to typo:
      ALF-3088 - Script error occurs on creating duplicated record seria
      ALF-3012 - Incorrect behaviour on creating duplicating folders
      ALF-3004 - Script error when submitting an item with long data in Prioprity field
   20529: Fix for ALF-3006 - Selected Items > Copy to... and Move to actions not working in Document Library
   20530: Dynamic Models - fix test(s)
      - fix concurrency test for Oracle build (retry if txn lock cannot be acquired)
      - when getting deployed models, skip if invalid (eg. cannot be parsed)
   20536: Remove @Override (ALF-657)
   20537: Activities - (minor) fix NPE for Oracle build/test
   20543: Final part of ALF-2110 - Appropriate person properties disabled for editing in Explorer Client if external mapped sync such as LDAP is used.
      Fixed issue with Change Password option being disabled incorrectly.
   20544: Follow-up fix to r20528
   20546: Fix for ALF-3151 - Freemarker causes NPE while deploying 3.3 enterprise onto WebSphere 7.0.0.7
      - NOTE: will need to submit patch to freemarker.org
   20552: Merged BRANCHES/V3.2 to BRANCHES/V3.3 (RECORD ONLY)
      20551: (RECORD ONLY) Merged BRANCHES/V3.3 to BRANCHES/V3.2:
         20090: Dynamic models: minor improvements to DictionaryModelType
   20553: Fix for escalated issue ALF-2856: Space returns to browse view after completing Add Content dialog; need a way to return to custom view (applied patch provided by customer).
   20554: Improvement to model delete validation (investigating intermittent failure of RepoAdminServiceImplTest.testSimpleDynamicModelViaNodeService)
   20558: Merged DEV/BELARUS/V3.3-2010_06_08 to V3.3
      20550: ALF-922: Mysql does not support unique keys that contain nulls as one would expect ...... duplicates in the alf_access_control_entry table
   20562: ALF-3177 - security fix.
   20563: Merged BRANCHES/V3.2 to BRANCHES/V3.3:
      19412: Fix for ALF-865 "WCM / Cluster: unexpected error when concurrently submitting content"
         ALF-862 "WCM submit execution will require locking in a clustered WCM authoring env"
   20564: Merged BRANCHES/V3.1 to BRANCHES/V3.3:
      20542: Fixed ALF-3152: ImporterComponent transaction retry settings can cause IllegalArgumentException
   20568: Follow-up on fix ALF-3152.  Fix jobLockService's retryWaitIncrementMs


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@20572 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2010-06-09 14:53:24 +00:00

1489 lines
54 KiB
Java

/*
* Copyright (C) 2005-2010 Alfresco Software Limited.
*
* This file is part of Alfresco
*
* 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/>.
*/
package org.alfresco.repo.rule;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap;
import java.util.HashSet;
import java.util.List;
import java.util.Map;
import java.util.Set;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.action.ActionModel;
import org.alfresco.repo.action.RuntimeActionService;
import org.alfresco.repo.cache.NullCache;
import org.alfresco.repo.cache.SimpleCache;
import org.alfresco.repo.node.NodeServicePolicies;
import org.alfresco.repo.policy.JavaBehaviour;
import org.alfresco.repo.policy.PolicyComponent;
import org.alfresco.repo.transaction.AlfrescoTransactionSupport;
import org.alfresco.repo.transaction.TransactionListener;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.action.ActionService;
import org.alfresco.service.cmr.action.ActionServiceException;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
import org.alfresco.service.cmr.rule.Rule;
import org.alfresco.service.cmr.rule.RuleService;
import org.alfresco.service.cmr.rule.RuleServiceException;
import org.alfresco.service.cmr.rule.RuleType;
import org.alfresco.service.cmr.security.AccessStatus;
import org.alfresco.service.cmr.security.PermissionService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.service.namespace.RegexQNamePattern;
import org.alfresco.util.GUID;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.extensions.surf.util.ParameterCheck;
/**
* Rule service implementation.
* <p>
* This service automatically binds to the transaction flush hooks. It will
* therefore participate in any flushes that occur during the transaction as
* well.
*
* @author Roy Wetherall
*/
public class RuleServiceImpl
implements RuleService, RuntimeRuleService,
NodeServicePolicies.BeforeCreateChildAssociationPolicy,
NodeServicePolicies.OnCreateNodePolicy,
NodeServicePolicies.OnUpdateNodePolicy,
NodeServicePolicies.OnAddAspectPolicy
{
/** key against which to store rules pending on the current transaction */
private static final String KEY_RULES_PENDING = "RuleServiceImpl.PendingRules";
/** key against which to store executed rules on the current transaction */
private static final String KEY_RULES_EXECUTED = "RuleServiceImpl.ExecutedRules";
/** qname of assoc to rules */
private String ASSOC_NAME_RULES_PREFIX = "rules";
private RegexQNamePattern ASSOC_NAME_RULES_REGEX = new RegexQNamePattern(RuleModel.RULE_MODEL_URI, "^" + ASSOC_NAME_RULES_PREFIX + ".*");
private static Log logger = LogFactory.getLog(RuleServiceImpl.class);
private NodeService nodeService;
private NodeService runtimeNodeService;
private ActionService actionService;
private DictionaryService dictionaryService;
private PolicyComponent policyComponent;
private PermissionService permissionService;
/**
* The action service implementation which we need for some things.
*/
private RuntimeActionService runtimeActionService;
/**
* Cache of raw rules (not inherited or interpreted) for a given node
*/
private SimpleCache<NodeRef, List<Rule>> nodeRulesCache;
/**
* List of disabled node refs. The rules associated with these nodes will node be added to the pending list, and
* therefore not fired. This list is transient.
*
* TODO: (DH) Make this txn-local
*/
private Set<NodeRef> disabledNodeRefs = new HashSet<NodeRef>(5);
/**
* List of disabled rules. Any rules that appear in this list will not be added to the pending list and therefore
* not fired.
*/
private Set<Rule> disabledRules = new HashSet<Rule>(5);
/**
* All the rule type currently registered
*/
private Map<String, RuleType> ruleTypes = new HashMap<String, RuleType>();
/**
* The rule transaction listener
*/
private TransactionListener ruleTransactionListener = new RuleTransactionListener(this);
/**
* Indicates whether the rules are disabled for the current thread
*/
private ThreadLocal<Boolean> rulesDisabled = new ThreadLocal<Boolean>();
/**
* Global flag that indicates whether the
*/
private boolean globalRulesDisabled = false;
/**
* Set the permission-safe node service
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* Set the direct node service
*/
public void setRuntimeNodeService(NodeService runtimeNodeService)
{
this.runtimeNodeService = runtimeNodeService;
}
/**
* Set the action service
*/
public void setActionService(ActionService actionService)
{
this.actionService = actionService;
}
/**
* Set the runtime action service
*/
public void setRuntimeActionService(RuntimeActionService runtimeActionService)
{
this.runtimeActionService = runtimeActionService;
}
/**
* Set the dictionary service
*/
public void setDictionaryService(DictionaryService dictionaryService)
{
this.dictionaryService = dictionaryService;
}
/**
* Set the policy component to listen for various events
*/
public void setPolicyComponent(PolicyComponent policyComponent)
{
this.policyComponent = policyComponent;
}
/**
* Set the permission service
*/
public void setPermissionService(PermissionService permissionService)
{
this.permissionService = permissionService;
}
/**
* Set the cache to hold node's individual rules. This cache <b>must not be shared</b>
* across transactions.
*
* @param nodeRulesCache a cache of raw rules contained on a node
*
* @see NullCache
*/
public void setNodeRulesCache(SimpleCache<NodeRef, List<Rule>> nodeRulesCache)
{
this.nodeRulesCache = nodeRulesCache;
}
/**
* Set the global rules disabled flag
*
* @param rulesDisabled true to disable allr ules, false otherwise
*/
public void setRulesDisabled(boolean rulesDisabled)
{
this.globalRulesDisabled = rulesDisabled;
}
/**
* Registers to listen for events of interest. For instance, the creation or deletion of a rule folder
* will affect the caching of rules.
*/
public void init()
{
policyComponent.bindAssociationBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "beforeCreateChildAssociation"),
RuleModel.ASPECT_RULES,
RuleModel.ASSOC_RULE_FOLDER,
new JavaBehaviour(this, "beforeCreateChildAssociation"));
policyComponent.bindClassBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "onAddAspect"),
RuleModel.ASPECT_RULES,
new JavaBehaviour(this, "onAddAspect"));
policyComponent.bindClassBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "onUpdateNode"),
RuleModel.ASPECT_RULES,
new JavaBehaviour(this, "onUpdateNode"));
policyComponent.bindClassBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "onCreateNode"),
RuleModel.TYPE_RULE,
new JavaBehaviour(this, "onCreateNode"));
policyComponent.bindClassBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "onUpdateNode"),
RuleModel.TYPE_RULE,
new JavaBehaviour(this, "onUpdateNode"));
policyComponent.bindClassBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "onCreateNode"),
ActionModel.TYPE_ACTION_BASE,
new JavaBehaviour(this, "onCreateNode"));
policyComponent.bindClassBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "onUpdateNode"),
ActionModel.TYPE_ACTION_BASE,
new JavaBehaviour(this, "onUpdateNode"));
policyComponent.bindClassBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "onCreateNode"),
ActionModel.TYPE_ACTION_PARAMETER,
new JavaBehaviour(this, "onCreateNode"));
policyComponent.bindClassBehaviour(
QName.createQName(NamespaceService.ALFRESCO_URI, "onUpdateNode"),
ActionModel.TYPE_ACTION_PARAMETER,
new JavaBehaviour(this, "onUpdateNode"));
}
/**
* Cache invalidation
*/
public void beforeCreateChildAssociation(
NodeRef parentNodeRef,
NodeRef childNodeRef,
QName assocTypeQName,
QName assocQName,
boolean isNewNode)
{
nodeRulesCache.clear();
}
/**
* Cache invalidation
*/
public void onUpdateNode(NodeRef nodeRef)
{
nodeRulesCache.clear();
}
/**
* Cache invalidation
*/
public void onCreateNode(ChildAssociationRef childAssocRef)
{
nodeRulesCache.clear();
}
/**
* Cache invalidation
*/
public void onAddAspect(NodeRef nodeRef, QName aspectTypeQName)
{
nodeRulesCache.clear();
}
protected NodeRef getSavedRuleFolderRef(NodeRef nodeRef)
{
NodeRef result = null;
ChildAssociationRef assoc = getSavedRuleFolderAssoc(nodeRef);
if (assoc != null)
{
result = assoc.getChildRef();
}
return result;
}
/**
* Gets the saved rule folder reference
*
* @param nodeRef the node reference
* @return the node reference
*/
public ChildAssociationRef getSavedRuleFolderAssoc(NodeRef nodeRef)
{
ChildAssociationRef result = null;
List<ChildAssociationRef> assocs = this.runtimeNodeService.getChildAssocs(
nodeRef,
RuleModel.ASSOC_RULE_FOLDER,
RuleModel.ASSOC_RULE_FOLDER);
if (assocs.size() > 1)
{
throw new ActionServiceException("There is more than one rule folder, which is invalid.");
}
else if (assocs.size() == 1)
{
result = assocs.get(0);
}
return result;
}
/**
* @see org.alfresco.repo.rule.RuleService#getRuleTypes()
*/
public List<RuleType> getRuleTypes()
{
return new ArrayList<RuleType>(this.ruleTypes.values());
}
/**
* @see org.alfresco.repo.rule.RuleService#getRuleType(java.lang.String)
*/
public RuleType getRuleType(String name)
{
return this.ruleTypes.get(name);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#enableRules()
*/
public void enableRules()
{
this.rulesDisabled.remove();
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#disableRules()
*/
public void disableRules()
{
this.rulesDisabled.set(Boolean.TRUE);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#isEnabled()
*/
public boolean isEnabled()
{
return (this.globalRulesDisabled == false && this.rulesDisabled.get() == null);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#rulesEnabled(NodeRef)
*/
public boolean rulesEnabled(NodeRef nodeRef)
{
return (this.disabledNodeRefs.contains(nodeRef) == false);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#disableRules(NodeRef)
*/
public void disableRules(NodeRef nodeRef)
{
// Add the node to the set of disabled nodes
this.disabledNodeRefs.add(nodeRef);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#enableRules(NodeRef)
*/
public void enableRules(NodeRef nodeRef)
{
// Remove the node from the set of disabled nodes
this.disabledNodeRefs.remove(nodeRef);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#disableRule(org.alfresco.service.cmr.rule.Rule)
*/
public void disableRule(Rule rule)
{
this.disabledRules.add(rule);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#enableRule(org.alfresco.service.cmr.rule.Rule)
*/
public void enableRule(Rule rule)
{
this.disabledRules.remove(rule);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#hasRules(org.alfresco.repo.ref.NodeRef)
*/
public boolean hasRules(NodeRef nodeRef)
{
return getRules(nodeRef).size() != 0;
}
/**
* @see org.alfresco.repo.rule.RuleService#getRules(org.alfresco.repo.ref.NodeRef)
*/
public List<Rule> getRules(NodeRef nodeRef)
{
return getRules(nodeRef, true, null);
}
/**
* @see org.alfresco.repo.rule.RuleService#getRules(org.alfresco.repo.ref.NodeRef, boolean)
*/
public List<Rule> getRules(NodeRef nodeRef, boolean includeInherited)
{
return getRules(nodeRef, includeInherited, null);
}
/**
* @see org.alfresco.repo.rule.RuleService#getRulesByRuleType(org.alfresco.repo.ref.NodeRef, org.alfresco.repo.rule.RuleType)
*/
public List<Rule> getRules(NodeRef nodeRef, boolean includeInherited, String ruleTypeName)
{
List<Rule> rules = new ArrayList<Rule>();
if (!this.runtimeNodeService.exists(nodeRef) || !checkNodeType(nodeRef))
{
// Node has gone or is not the correct type
return rules;
}
if (includeInherited == true && this.runtimeNodeService.hasAspect(nodeRef, RuleModel.ASPECT_IGNORE_INHERITED_RULES) == false)
{
// Get any inherited rules
for (Rule rule : getInheritedRules(nodeRef, ruleTypeName, null))
{
// Ensure rules are not duplicated in the list
if (rules.contains(rule) == false)
{
rules.add(rule);
}
}
}
// Get the node's own rules and add them to the list
List<Rule> nodeRules = getRulesForNode(nodeRef);
for (Rule rule : nodeRules)
{
if ((rules.contains(rule) == false) &&
(ruleTypeName == null || rule.getRuleTypes().contains(ruleTypeName) == true))
{
rules.add(rule);
}
}
return rules;
}
private List<Rule> getRulesForNode(NodeRef nodeRef)
{
// Extra check of CONSUMER permission was added to rule selection,
// to prevent Access Denied Exception due to the bug:
// https://issues.alfresco.com/browse/ETWOTWO-438
if (!runtimeNodeService.hasAspect(nodeRef, RuleModel.ASPECT_RULES) ||
permissionService.hasPermission(nodeRef, PermissionService.READ) != AccessStatus.ALLOWED)
{
// Doesn't have the aspect or the user doesn't have access
return Collections.emptyList();
}
List<Rule> nodeRules = nodeRulesCache.get(nodeRef);
if (nodeRules != null)
{
// We have already processed this node
return nodeRules;
}
// Not in the cache, so go and get the rules
nodeRules = new ArrayList<Rule>();
NodeRef ruleFolder = getSavedRuleFolderRef(nodeRef);
if (ruleFolder != null)
{
// Get the rules for this node
List<ChildAssociationRef> ruleChildAssocRefs =
this.runtimeNodeService.getChildAssocs(ruleFolder, RegexQNamePattern.MATCH_ALL, ASSOC_NAME_RULES_REGEX);
for (ChildAssociationRef ruleChildAssocRef : ruleChildAssocRefs)
{
// Create the rule and add to the list
NodeRef ruleNodeRef = ruleChildAssocRef.getChildRef();
Rule rule = getRule(ruleNodeRef);
nodeRules.add(rule);
}
}
// Store this in the cache for later re-use
nodeRulesCache.put(nodeRef, nodeRules);
// Done
return nodeRules;
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#countRules(org.alfresco.service.cmr.repository.NodeRef)
*/
public int countRules(NodeRef nodeRef)
{
int ruleCount = 0;
if (this.runtimeNodeService.exists(nodeRef) == true && checkNodeType(nodeRef) == true)
{
if (this.runtimeNodeService.hasAspect(nodeRef, RuleModel.ASPECT_RULES) == true)
{
NodeRef ruleFolder = getSavedRuleFolderRef(nodeRef);
if (ruleFolder != null)
{
// Get the rules for this node
List<ChildAssociationRef> ruleChildAssocRefs =
this.runtimeNodeService.getChildAssocs(ruleFolder, RegexQNamePattern.MATCH_ALL, ASSOC_NAME_RULES_REGEX);
ruleCount = ruleChildAssocRefs.size();
}
}
}
return ruleCount;
}
/**
* Looks at the type of the node and indicates whether the node can have rules associated with it
*
* @param nodeRef the node reference
* @return true if the node can have rule associated with it (inherited or otherwise)
*/
private boolean checkNodeType(NodeRef nodeRef)
{
boolean result = true;
QName nodeType = this.runtimeNodeService.getType(nodeRef);
if (this.dictionaryService.isSubClass(nodeType, ContentModel.TYPE_SYSTEM_FOLDER) == true ||
this.dictionaryService.isSubClass(nodeType, ActionModel.TYPE_ACTION) == true ||
this.dictionaryService.isSubClass(nodeType, ActionModel.TYPE_ACTION_CONDITION) == true ||
this.dictionaryService.isSubClass(nodeType, ActionModel.TYPE_ACTION_PARAMETER) == true)
{
result = false;
if (logger.isDebugEnabled() == true)
{
logger.debug("A node of type " + nodeType.toString() + " was checked and can not have rules.");
}
}
return result;
}
/**
* Gets the inherited rules for a given node reference
*
* @param nodeRef the nodeRef
* @param ruleTypeName the rule type (null if all applicable)
* @return a list of inherited rules (empty if none)
*/
private List<Rule> getInheritedRules(NodeRef nodeRef, String ruleTypeName, Set<NodeRef> visitedNodeRefs)
{
List<Rule> inheritedRules = new ArrayList<Rule>();
if (this.runtimeNodeService.hasAspect(nodeRef, RuleModel.ASPECT_IGNORE_INHERITED_RULES) == false)
{
// Create the visited nodes set if it has not already been created
if (visitedNodeRefs == null)
{
visitedNodeRefs = new HashSet<NodeRef>();
}
// This check prevents stack over flow when we have a cyclic node graph
if (visitedNodeRefs.contains(nodeRef) == false)
{
visitedNodeRefs.add(nodeRef);
List<Rule> allInheritedRules = new ArrayList<Rule>();
List<ChildAssociationRef> parents = this.runtimeNodeService.getParentAssocs(nodeRef);
for (ChildAssociationRef parent : parents)
{
// Add the inherited rule first
for (Rule rule : getInheritedRules(parent.getParentRef(), ruleTypeName, visitedNodeRefs))
{
// Ensure that we don't get any rule duplication (don't use a set cos we want to preserve order)
if (allInheritedRules.contains(rule) == false)
{
allInheritedRules.add(rule);
}
}
List<Rule> rules = getRules(parent.getParentRef(), false);
for (Rule rule : rules)
{
// Add is we hanvn't already added and it should be applied to the children
if (rule.isAppliedToChildren() == true && allInheritedRules.contains(rule) == false)
{
allInheritedRules.add(rule);
}
}
}
if (ruleTypeName == null)
{
inheritedRules = allInheritedRules;
}
else
{
// Filter the rule list by rule type
for (Rule rule : allInheritedRules)
{
if (rule.getRuleTypes().contains(ruleTypeName) == true)
{
inheritedRules.add(rule);
}
}
}
}
}
return inheritedRules;
}
/**
* Create the rule object from the rule node reference
*
* @param ruleNodeRef the rule node reference
* @return the rule
*/
@SuppressWarnings("unchecked")
public Rule getRule(NodeRef ruleNodeRef)
{
// Get the rule properties
Map<QName, Serializable> props = this.runtimeNodeService.getProperties(ruleNodeRef);
// Create the rule
Rule rule = new Rule(ruleNodeRef);
// Set the title and description
String title = DefaultTypeConverter.INSTANCE.convert(String.class, props.get(ContentModel.PROP_TITLE));
String description = DefaultTypeConverter.INSTANCE.convert(String.class, props.get(ContentModel.PROP_DESCRIPTION));
rule.setTitle(title);
rule.setDescription(description);
// Set the rule types
rule.setRuleTypes((List<String>)props.get(RuleModel.PROP_RULE_TYPE));
// Set the applied to children value
boolean isAppliedToChildren = false;
Boolean value = (Boolean)props.get(RuleModel.PROP_APPLY_TO_CHILDREN);
if (value != null)
{
isAppliedToChildren = value.booleanValue();
}
rule.applyToChildren(isAppliedToChildren);
// Set the execute asynchronously value
boolean executeAsync = false;
Boolean value2 = (Boolean)props.get(RuleModel.PROP_EXECUTE_ASYNC);
if (value2 != null)
{
executeAsync = value2.booleanValue();
}
rule.setExecuteAsynchronously(executeAsync);
// Set the disabled value
boolean ruleDisabled = false;
Boolean value3 = (Boolean)props.get(RuleModel.PROP_DISABLED);
if (value3 != null)
{
ruleDisabled = value3.booleanValue();
}
rule.setRuleDisabled(ruleDisabled);
// Get the action node reference
List<ChildAssociationRef> actions = this.nodeService.getChildAssocs(ruleNodeRef, RuleModel.ASSOC_ACTION, RuleModel.ASSOC_ACTION);
if (actions.size() == 0)
{
throw new RuleServiceException("Rule exists without a specified action");
}
else if (actions.size() > 1)
{
throw new RuleServiceException("Rule exists with more than one specified action");
}
NodeRef actionNodeRef = actions.get(0).getChildRef();
// Here we need to create the action from the action node reference
Action action = runtimeActionService.createAction(actionNodeRef);
rule.setAction(action);
return rule;
}
/**
* @see org.alfresco.repo.rule.RuleService#saveRule(org.alfresco.repo.ref.NodeRef, org.alfresco.repo.rule.Rule)
*/
public void saveRule(NodeRef nodeRef, Rule rule)
{
checkForLinkedRules(nodeRef);
if (this.permissionService.hasPermission(nodeRef, PermissionService.CHANGE_PERMISSIONS) == AccessStatus.ALLOWED)
{
disableRules();
try
{
if (this.nodeService.exists(nodeRef) == false)
{
throw new RuleServiceException("The node does not exist.");
}
NodeRef ruleNodeRef = rule.getNodeRef();
if (ruleNodeRef == null)
{
if (this.nodeService.hasAspect(nodeRef, RuleModel.ASPECT_RULES) == false)
{
// Add the actionable aspect
this.nodeService.addAspect(nodeRef, RuleModel.ASPECT_RULES, null);
}
// Create the action node
ruleNodeRef = this.nodeService.createNode(
getSavedRuleFolderRef(nodeRef),
ContentModel.ASSOC_CONTAINS,
QName.createQName(RuleModel.RULE_MODEL_URI, ASSOC_NAME_RULES_PREFIX + GUID.generate()),
RuleModel.TYPE_RULE).getChildRef();
// Set the rule node reference and the owning node reference
rule.setNodeRef(ruleNodeRef);
}
// Update the properties of the rule
this.nodeService.setProperty(ruleNodeRef, ContentModel.PROP_TITLE, rule.getTitle());
this.nodeService.setProperty(ruleNodeRef, ContentModel.PROP_DESCRIPTION, rule.getDescription());
this.nodeService.setProperty(ruleNodeRef, RuleModel.PROP_RULE_TYPE, (Serializable)rule.getRuleTypes());
this.nodeService.setProperty(ruleNodeRef, RuleModel.PROP_APPLY_TO_CHILDREN, rule.isAppliedToChildren());
this.nodeService.setProperty(ruleNodeRef, RuleModel.PROP_EXECUTE_ASYNC, rule.getExecuteAsynchronously());
this.nodeService.setProperty(ruleNodeRef, RuleModel.PROP_DISABLED, rule.getRuleDisabled());
// Save the rule's action
saveAction(ruleNodeRef, rule);
}
finally
{
enableRules();
// Drop the rules from the cache
nodeRulesCache.remove(nodeRef);
}
}
else
{
throw new RuleServiceException("Insufficient permissions to save a rule.");
}
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#saveRule(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.rule.Rule, int)
*/
public void saveRule(NodeRef nodeRef, Rule rule, int index)
{
saveRule(nodeRef, rule);
setRulePosition(nodeRef, rule.getNodeRef(), index);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#setRulePosition(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, int)
*/
public void setRulePosition(NodeRef nodeRef, NodeRef ruleNodeRef, int index)
{
NodeRef ruleFolder = getSavedRuleFolderRef(nodeRef);
if (ruleFolder != null)
{
List<ChildAssociationRef> assocs = this.runtimeNodeService.getChildAssocs(ruleFolder, RegexQNamePattern.MATCH_ALL, ASSOC_NAME_RULES_REGEX);
List<ChildAssociationRef> orderedAssocs = new ArrayList<ChildAssociationRef>(assocs.size());
ChildAssociationRef movedAssoc = null;
for (ChildAssociationRef assoc : assocs)
{
NodeRef childNodeRef = assoc.getChildRef();
if (childNodeRef.equals(ruleNodeRef) == true)
{
movedAssoc = assoc;
}
else
{
orderedAssocs.add(assoc);
}
}
if (movedAssoc != null)
{
orderedAssocs.add(index, movedAssoc);
}
index = 0;
for (ChildAssociationRef orderedAssoc : orderedAssocs)
{
nodeService.setChildAssociationIndex(orderedAssoc, index);
index++;
}
}
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#setRulePosition(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.rule.Rule, int)
*/
public void setRulePosition(NodeRef nodeRef, Rule rule, int index)
{
setRulePosition(nodeRef, rule.getNodeRef(), index);
}
/**
* Save the action related to the rule.
*
* @param ruleNodeRef the node reference representing the rule
* @param rule the rule
*/
private void saveAction(NodeRef ruleNodeRef, Rule rule)
{
// Get the action definition from the rule
Action action = rule.getAction();
if (action == null)
{
throw new RuleServiceException("An action must be specified when defining a rule.");
}
// Get the current action node reference
NodeRef actionNodeRef = null;
List<ChildAssociationRef> actions = this.nodeService.getChildAssocs(ruleNodeRef, RuleModel.ASSOC_ACTION, RuleModel.ASSOC_ACTION);
if (actions.size() == 1)
{
// We need to check that the action is the same
actionNodeRef = actions.get(0).getChildRef();
if (actionNodeRef.getId().equals(action.getId()) == false)
{
// Delete the old action
this.nodeService.deleteNode(actionNodeRef);
actionNodeRef = null;
}
}
else if (actions.size() > 1)
{
throw new RuleServiceException("The rule has become corrupt. More than one action is associated with the rule.");
}
// Create the new action node reference
if (actionNodeRef == null)
{
actionNodeRef = this.runtimeActionService.createActionNodeRef(action, ruleNodeRef, RuleModel.ASSOC_ACTION, RuleModel.ASSOC_ACTION);
}
// Update the action node
this.runtimeActionService.saveActionImpl(actionNodeRef, action);
}
/**
* @see org.alfresco.repo.rule.RuleService#removeRule(org.alfresco.repo.ref.NodeRef, org.alfresco.service.cmr.rule.Rule)
*/
public void removeRule(NodeRef nodeRef, Rule rule)
{
checkForLinkedRules(nodeRef);
if (this.permissionService.hasPermission(nodeRef, PermissionService.CHANGE_PERMISSIONS) == AccessStatus.ALLOWED)
{
if (this.nodeService.exists(nodeRef) == true &&
this.nodeService.hasAspect(nodeRef, RuleModel.ASPECT_RULES) == true)
{
disableRules(nodeRef);
try
{
NodeRef ruleNodeRef = rule.getNodeRef();
if (ruleNodeRef != null)
{
this.nodeService.removeChild(getSavedRuleFolderRef(nodeRef), ruleNodeRef);
}
}
finally
{
enableRules(nodeRef);
}
}
// Drop the rules from the cache
nodeRulesCache.remove(nodeRef);
}
else
{
throw new RuleServiceException("Insufficient permissions to remove a rule.");
}
}
/**
* Checks if rules are linked and throws an exception if they are.
*
* @param nodeRef node reference of rule node
*/
private void checkForLinkedRules(NodeRef nodeRef)
{
if (isLinkedToRuleNode(nodeRef)== true)
{
throw new RuleServiceException("Can not edit rules as they are linked to another rule set.");
}
}
/**
* @see org.alfresco.repo.rule.RuleService#removeAllRules(NodeRef)
*/
public void removeAllRules(NodeRef nodeRef)
{
checkForLinkedRules(nodeRef);
if (this.permissionService.hasPermission(nodeRef, PermissionService.CHANGE_PERMISSIONS) == AccessStatus.ALLOWED)
{
if (this.nodeService.exists(nodeRef) == true &&
this.nodeService.hasAspect(nodeRef, RuleModel.ASPECT_RULES) == true)
{
NodeRef folder = getSavedRuleFolderRef(nodeRef);
if (folder != null)
{
List<ChildAssociationRef> ruleChildAssocs = this.nodeService.getChildAssocs(
folder,
RegexQNamePattern.MATCH_ALL, ASSOC_NAME_RULES_REGEX);
for (ChildAssociationRef ruleChildAssoc : ruleChildAssocs)
{
this.nodeService.removeChild(folder, ruleChildAssoc.getChildRef());
}
}
}
// Drop the rules from the cache
nodeRulesCache.remove(nodeRef);
}
else
{
throw new RuleServiceException("Insufficient permissions to remove a rule.");
}
}
/**
* @see org.alfresco.repo.rule.RuntimeRuleService#addRulePendingExecution(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.rule.Rule)
*/
public void addRulePendingExecution(NodeRef actionableNodeRef, NodeRef actionedUponNodeRef, Rule rule)
{
addRulePendingExecution(actionableNodeRef, actionedUponNodeRef, rule, false);
}
@SuppressWarnings("unchecked")
public void removeRulePendingExecution(NodeRef actionedUponNodeRef)
{
ParameterCheck.mandatory("actionedUponNodeRef", actionedUponNodeRef);
List<PendingRuleData> pendingRules = (List<PendingRuleData>) AlfrescoTransactionSupport.getResource(KEY_RULES_PENDING);
if (pendingRules != null)
{
boolean listUpdated = false;
List<PendingRuleData> temp = new ArrayList<PendingRuleData>(pendingRules);
for (PendingRuleData pendingRuleData : temp)
{
if (pendingRuleData.getActionedUponNodeRef().equals(actionedUponNodeRef) == true)
{
// Remove from the pending list
pendingRules.remove(pendingRuleData);
listUpdated = true;
}
}
if (listUpdated == true)
{
AlfrescoTransactionSupport.bindResource(KEY_RULES_PENDING, pendingRules);
AlfrescoTransactionSupport.bindListener(this.ruleTransactionListener);
}
}
}
/**
* @see org.alfresco.repo.rule.RuntimeRuleService#addRulePendingExecution(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.rule.Rule, boolean)
*/
@SuppressWarnings("unchecked")
public void addRulePendingExecution(NodeRef actionableNodeRef, NodeRef actionedUponNodeRef, Rule rule, boolean executeAtEnd)
{
ParameterCheck.mandatory("actionableNodeRef", actionableNodeRef);
ParameterCheck.mandatory("actionedUponNodeRef", actionedUponNodeRef);
// First check to see if the node has been disabled
if (this.isEnabled() == true &&
this.disabledNodeRefs.contains(this.getOwningNodeRef(rule)) == false &&
this.disabledRules.contains(rule) == false)
{
PendingRuleData pendingRuleData = new PendingRuleData(actionableNodeRef, actionedUponNodeRef, rule, executeAtEnd);
List<PendingRuleData> pendingRules =
(List<PendingRuleData>) AlfrescoTransactionSupport.getResource(KEY_RULES_PENDING);
if (pendingRules == null)
{
// bind pending rules to the current transaction
pendingRules = new ArrayList<PendingRuleData>();
AlfrescoTransactionSupport.bindResource(KEY_RULES_PENDING, pendingRules);
// bind the rule transaction listener
AlfrescoTransactionSupport.bindListener(this.ruleTransactionListener);
if (logger.isDebugEnabled() == true)
{
logger.debug("Rule '" + rule.getTitle() + "' has been added pending execution to action upon node '" + actionedUponNodeRef.getId() + "'");
}
}
// Prevent the same rule being executed more than once in the same transaction
if (pendingRules.contains(pendingRuleData) == false)
{
pendingRules.add(pendingRuleData);
}
}
else
{
if (logger.isDebugEnabled() == true)
{
logger.debug("The rule '" + rule.getTitle() + "' or the node '" + this.getOwningNodeRef(rule).getId() + "' has been disabled.");
}
}
}
/**
* @see org.alfresco.repo.rule.RuleService#executePendingRules()
*/
public void executePendingRules()
{
if (logger.isDebugEnabled() == true)
{
logger.debug("Creating the executed rules list");
}
if (AlfrescoTransactionSupport.getResource(KEY_RULES_EXECUTED) == null)
{
AlfrescoTransactionSupport.bindResource(KEY_RULES_EXECUTED, new HashSet<ExecutedRuleData>());
}
List<PendingRuleData> executeAtEndRules = new ArrayList<PendingRuleData>();
executePendingRulesImpl(executeAtEndRules);
for (PendingRuleData data : executeAtEndRules)
{
executePendingRule(data);
}
}
/**
* Executes the pending rules, iterating until all pending rules have been executed
*/
@SuppressWarnings("unchecked")
private void executePendingRulesImpl(List<PendingRuleData> executeAtEndRules)
{
// get the transaction-local rules to execute
List<PendingRuleData> pendingRules =
(List<PendingRuleData>) AlfrescoTransactionSupport.getResource(KEY_RULES_PENDING);
// only execute if there are rules present
if (pendingRules != null && !pendingRules.isEmpty())
{
PendingRuleData[] pendingRulesArr = pendingRules.toArray(new PendingRuleData[0]);
// remove all pending rules from the transaction
AlfrescoTransactionSupport.unbindResource(KEY_RULES_PENDING);
// execute each rule
for (PendingRuleData pendingRule : pendingRulesArr)
{
if (pendingRule.getExecuteAtEnd() == false)
{
executePendingRule(pendingRule);
}
else
{
executeAtEndRules.add(pendingRule);
}
}
// Run any rules that have been marked as pending during execution
executePendingRulesImpl(executeAtEndRules);
}
}
/**
* Executes a pending rule
*
* @param pendingRule the pending rule data object
*/
@SuppressWarnings("unchecked")
private void executePendingRule(PendingRuleData pendingRule)
{
Set<ExecutedRuleData> executedRules =
(Set<ExecutedRuleData>) AlfrescoTransactionSupport.getResource(KEY_RULES_EXECUTED);
NodeRef actionedUponNodeRef = pendingRule.getActionedUponNodeRef();
Rule rule = pendingRule.getRule();
if (executedRules == null || canExecuteRule(executedRules, actionedUponNodeRef, rule) == true)
{
executeRule(rule, actionedUponNodeRef, executedRules);
}
}
/**
* @see org.alfresco.repo.rule.RuntimeRuleService#executeRule(org.alfresco.service.cmr.rule.Rule, org.alfresco.service.cmr.repository.NodeRef, java.util.Set)
*/
public void executeRule(Rule rule, NodeRef actionedUponNodeRef, Set<ExecutedRuleData> executedRules)
{
// Get the action associated with the rule
Action action = rule.getAction();
if (action == null)
{
throw new RuleServiceException("Attempting to execute a rule that does not have a rule specified.");
}
// Evaluate the condition
if (this.actionService.evaluateAction(action, actionedUponNodeRef) == true)
{
if (executedRules != null)
{
// Add the rule to the executed rule list
// (do this before this is executed to prevent rules being added to the pending list)
executedRules.add(new ExecutedRuleData(actionedUponNodeRef, rule));
if (logger.isDebugEnabled() == true)
{
logger.debug(" ... Adding rule (" + rule.getTitle() + ") and nodeRef (" + actionedUponNodeRef.getId() + ") to executed list");
}
}
// Execute the rule
boolean executeAsync = rule.getExecuteAsynchronously();
this.actionService.executeAction(action, actionedUponNodeRef, true, executeAsync);
}
}
/**
* Determines whether the rule can be executed
*
* @param executedRules
* @param actionedUponNodeRef
* @param rule
* @return
*/
private boolean canExecuteRule(Set<ExecutedRuleData> executedRules, NodeRef actionedUponNodeRef, Rule rule)
{
boolean result = true;
if (logger.isDebugEnabled() == true)
{
logger.debug(" >> Current executed items count = " + executedRules.size());
}
if (executedRules != null)
{
if (executedRules.contains(new ExecutedRuleData(actionedUponNodeRef, rule)) == true)
{
if (logger.isDebugEnabled() == true)
{
logger.debug(" >> Already executed this rule (" + rule.getTitle()+ ") on this nodeRef (" + actionedUponNodeRef.getId() + ")");
}
result = false;
}
else
{
result = checkForCopy(executedRules, actionedUponNodeRef, rule);
}
}
else
{
if (logger.isDebugEnabled() == true)
{
logger.debug(" >> Executed this rule (" + rule.getTitle()+ ") on (" + actionedUponNodeRef.getId() + ") executed rule is null");
}
}
return result;
}
/**
* Checks to see if a copy exists in the executed rules list
*
* @param executedRules
* @param actionedUponNodeRef
* @param rule
* @return
*/
private boolean checkForCopy(Set<ExecutedRuleData> executedRules, NodeRef actionedUponNodeRef, Rule rule)
{
boolean result = true;
if (this.nodeService.exists(actionedUponNodeRef)
&& this.permissionService.hasPermission(actionedUponNodeRef, PermissionService.READ).equals(AccessStatus.ALLOWED)
&& this.nodeService.hasAspect(actionedUponNodeRef, ContentModel.ASPECT_COPIEDFROM) == true)
{
if (logger.isDebugEnabled() == true)
{
logger.debug(" >> Has the copied from aspect (" + actionedUponNodeRef.getId() + ")");
}
NodeRef copiedFrom = (NodeRef)this.nodeService.getProperty(actionedUponNodeRef, ContentModel.PROP_COPY_REFERENCE);
if (logger.isDebugEnabled() == true && copiedFrom != null) {logger.debug(" >> Got the copedFrom nodeRef (" + copiedFrom.getId() + ")");};
if (copiedFrom != null)
{
if (executedRules.contains(new ExecutedRuleData(copiedFrom, rule)) == true)
{
if (logger.isDebugEnabled() == true)
{
logger.debug(" >> Already executed this rule (" + rule.getTitle()+ ") on this the copied from nodeRef (" + copiedFrom.getId() + ")");
}
return false;
}
else
{
if (logger.isDebugEnabled() == true)
{
logger.debug(" >> Executed this rule (" + rule.getTitle()+ ") on (" + actionedUponNodeRef.getId() + ") copiedFrom is not is list");
logger.debug(" > Checking copy");
}
result = checkForCopy(executedRules, copiedFrom, rule);
}
}
}
else
{
if (logger.isDebugEnabled() == true)
{
logger.debug(" >> Executed this rule (" + rule.getTitle()+ ") on (" + actionedUponNodeRef.getId() + ") no copied from aspect");
}
}
return result;
}
/**
* Register the rule type
*
* @param ruleTypeAdapter the rule type adapter
*/
public void registerRuleType(RuleType ruleType)
{
this.ruleTypes.put(ruleType.getName(), ruleType);
}
/**
* Helper class to contain the information about a rule that is executed
*
* @author Roy Wetherall
*/
public class ExecutedRuleData
{
protected NodeRef actionableNodeRef;
protected Rule rule;
public ExecutedRuleData(NodeRef actionableNodeRef, Rule rule)
{
this.actionableNodeRef = actionableNodeRef;
this.rule = rule;
}
public NodeRef getActionableNodeRef()
{
return actionableNodeRef;
}
public Rule getRule()
{
return rule;
}
@Override
public int hashCode()
{
int i = actionableNodeRef.hashCode();
i = (i*37) + rule.hashCode();
return i;
}
@Override
public boolean equals(Object obj)
{
if (this == obj)
{
return true;
}
if (obj instanceof ExecutedRuleData)
{
ExecutedRuleData that = (ExecutedRuleData) obj;
return (this.actionableNodeRef.equals(that.actionableNodeRef) &&
this.rule.equals(that.rule));
}
else
{
return false;
}
}
}
/**
* Helper class to contain the information about a rule that is pending execution
*
* @author Roy Wetherall
*/
private class PendingRuleData extends ExecutedRuleData
{
private NodeRef actionedUponNodeRef;
private boolean executeAtEnd = false;
public PendingRuleData(NodeRef actionableNodeRef, NodeRef actionedUponNodeRef, Rule rule, boolean executeAtEnd)
{
super(actionableNodeRef, rule);
this.actionedUponNodeRef = actionedUponNodeRef;
this.executeAtEnd = executeAtEnd;
}
public NodeRef getActionedUponNodeRef()
{
return actionedUponNodeRef;
}
public boolean getExecuteAtEnd()
{
return this.executeAtEnd;
}
@Override
public int hashCode()
{
int i = super.hashCode();
i = (i*37) + actionedUponNodeRef.hashCode();
return i;
}
@Override
public boolean equals(Object obj)
{
if (this == obj)
{
return true;
}
if (obj instanceof PendingRuleData)
{
PendingRuleData that = (PendingRuleData) obj;
return (this.actionableNodeRef.equals(that.actionableNodeRef) &&
this.actionedUponNodeRef.equals(that.actionedUponNodeRef) &&
this.rule.equals(that.rule));
}
else
{
return false;
}
}
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#getOwningNodeRef(org.alfresco.service.cmr.rule.Rule)
*/
public NodeRef getOwningNodeRef(Rule rule)
{
NodeRef result = null;
NodeRef ruleNodeRef = rule.getNodeRef();
if (ruleNodeRef != null)
{
result = getOwningNodeRefRuleImpl(ruleNodeRef);
}
return result;
}
/**
* @param ruleNodeRef
* @return
*/
private NodeRef getOwningNodeRefRuleImpl(NodeRef ruleNodeRef)
{
// Get the system folder parent
NodeRef systemFolder = this.nodeService.getPrimaryParent(ruleNodeRef).getParentRef();
// Get the owning node ref
return this.nodeService.getPrimaryParent(systemFolder).getParentRef();
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#getOwningNodeRef(org.alfresco.service.cmr.action.Action)
*/
public NodeRef getOwningNodeRef(Action action)
{
NodeRef result = null;
NodeRef actionNodeRef = action.getNodeRef();
if (actionNodeRef != null)
{
result = getOwningNodeRefActionImpl(actionNodeRef);
}
return result;
}
/**
* @param actionNodeRef
*/
private NodeRef getOwningNodeRefActionImpl(NodeRef actionNodeRef)
{
NodeRef result = null;
NodeRef parentNodeRef = this.nodeService.getPrimaryParent(actionNodeRef).getParentRef();
if (parentNodeRef != null)
{
QName parentType = this.nodeService.getType(parentNodeRef);
if (RuleModel.TYPE_RULE.equals(parentType) == true)
{
result = getOwningNodeRefRuleImpl(parentNodeRef);
}
else if (ActionModel.TYPE_COMPOSITE_ACTION.equals(parentType) == true)
{
result = getOwningNodeRefActionImpl(parentNodeRef);
}
}
return result;
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#isLinkedToRuleNode(org.alfresco.service.cmr.repository.NodeRef)
*/
public boolean isLinkedToRuleNode(NodeRef nodeRef)
{
return (getLinkedToRuleNode(nodeRef) != null);
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#getLinkedToRuleNode(org.alfresco.service.cmr.repository.NodeRef)
*/
public NodeRef getLinkedToRuleNode(NodeRef nodeRef)
{
NodeRef result = null;
// Check whether the node reference has the rule aspect
if (nodeService.hasAspect(nodeRef, RuleModel.ASPECT_RULES) == true)
{
ChildAssociationRef assoc = getSavedRuleFolderAssoc(nodeRef);
if (assoc.isPrimary() == false)
{
result = nodeService.getPrimaryParent(assoc.getChildRef()).getParentRef();
}
}
return result;
}
/**
* @see org.alfresco.service.cmr.rule.RuleService#getLinkedFromRuleNodes(org.alfresco.service.cmr.repository.NodeRef)
*/
public List<NodeRef> getLinkedFromRuleNodes(NodeRef nodeRef)
{
List<NodeRef> result = new ArrayList<NodeRef>();
if (nodeService.hasAspect(nodeRef, RuleModel.ASPECT_RULES) == true)
{
ChildAssociationRef assoc = getSavedRuleFolderAssoc(nodeRef);
if (assoc.isPrimary() == true)
{
List<ChildAssociationRef> linkedAssocs = nodeService.getParentAssocs(assoc.getChildRef());
for (ChildAssociationRef linkAssoc : linkedAssocs)
{
if (linkAssoc.isPrimary() == false)
{
result.add(linkAssoc.getParentRef());
}
}
}
}
return result;
}
}