Dave Ward ee8081b663 Merged V4.1-BUG-FIX to HEAD
41035: Fix for ALF-15225 - qt.length not performing as expected in search.lib.js
   41047: RUSSIAN: Translation updates based on EN r40961
   41049: GERMAN: Translation updates based on EN r41033. Fixes ALF-15749 and ALF-15720.
   41050: SPANISH: Translation updates based on EN r41033. Fixes ALF-15749 and ALF-15720.
   41051: FRENCH: Translation updates based on EN r41033. Fixes ALF-15749 and ALF-15720.
   41052: ITALIAN: Translation updates based on EN r41033. Fixes ALF-15749 and ALF-15720.
   41053: JAPANESE: Translation updates based on EN r41033. Fixes ALF-15749 and ALF-15720.
   41054: DUTCH: Translation updates based on EN r41033. Fixes ALF-15749 and ALF-15720.
   41055: RUSSIAN: Translation updates based on EN r41033. Fixes ALF-15749 and ALF-15720.
   41061: ALF-11214 - IMAP subsystem is not successfully restarted after incorrect modification of IMAP properties via Admin Console
   41063: RUSSIAN: Translation updates based on EN r41033 (encoding fixes)
   41064: CHINESE: Translation updates based on EN r41033
   41073: ALF-15760: Merged V4.0 to V4.1-BUG-FIX (another lost meta-inf revision)
      34416: ALF-12992: Updated weblogic DD for SOLR
   41074: ALF-15419 / ALF-14438: Merged V3.4-BUG-FIX to V4.1-BUG-FIX (PARTIAL)
      37373: Merged PATCHES/V3.4.6 to V3.4-BUG-FIX
         36821: ALF-13827 / ALF-14402: Make replicated caches recover from temporary comms failures by flushing when a change in peers is detected
         - We do not flush caches who replicate via copy (e.g. tickets cache) as these may not be recoverable
         37122: ALF-13919 / ALF-14403: Merged DEV to PATCHES/V3.4.6
         - Rework of Dmitry's implementation
         - Uses dynamic HQL query to retrieve JBPM workflow instances by specified query criteria
         - WorkflowInstancesGet web script no longer has to iterate over every workflow instance in the database!
         - DB index added to enable efficient querying by string variable
         - Hibernate tastic!
         37188: ALF-13919 / ALF-14403: Worked around HQL polymorphism issues by using explicit variable subclass names in from clause
         37204: ALF-13919 / ALF-14403: Fix to date range handling by Dmitry
   41077: ALF-10730: Fixed object finder drop-down tree to show parent icon type when icon type not available
   41089: ALF-13998: 'No items' error is highlighted in red, even that is not sever error.
   41109: Part fix for ALF-11297 Disabled test: test-system-build-test has been removed from the test target dependency list
   41118: Fixes: ALF-15765 and related issue ALF-15476: 
      - Corrects merge of r34405 and r40159
      - Adds people api to cloud proxy config
      - Cloud/Global Folder picker sites list now universally shows only those sites the user is a member of.
   41119: ALF-15419 / ALF-14438: Merged DEV to V4.1-BUG-FIX
      41117: ALF-15419 : CLONE Remove JBPM indexes present from upgrades
         The schema reference files were updated to contain JBPM_VARIABLEINSTANCE.IDX_VARINST_STRVAL index.
   41130: ALF-15590: FSTR transfer of custom content type with parent cm:content fails
   - Fix by Dmitry
   41131: ALF-15714: Bitrock Uninstaller: Uninstaller doesn't remove all files and folders in *nix
   - Fix provided by Bitrock
   41132: Fix for ALF-14388 - Edit Online option is not supported for '.docm', 'dotm', '.xlsm' files
    - corrected mimetypes to be lower-case
   41150: ALF-13287 Added the handling of UTC represented by "Z" within comparator
   41154: Check for authentication errors when validating a ticket, if an error occurs re-authenticate. ALF-15394
   41155: ALF-15569: User with '@' symbol in username cannot invite
   - note: since Ent 4.0.2(+) by default MT is pre-configured but not enabled
   41173: Merged V4.1 to V4.1-BUG-FIX
      41121: Merged BRANCHES/DEV/FEATURES/CLOUD1_CLOUDSYNC to BRANCHES/V4.1:
         41003: CloudSync: ALF-15734 - force unsync (of last SSMN) on target causes repeating pull errors to appear in both logs
         41026: CloudSync: ALF-15734 - force unsync (of last SSMN) on target causes repeating pull errors to appear in both logs
         41039: CloudSync: ALF-15734 - force unsync (of last SSMN) on target causes repeating pull errors to appear in both logs
         41086: CloudSync: ALF-15734 - force unsync (of last SSMN) on target causes repeating pull errors to appear in both logs
      41123: Merged BRANCHES/DEV/FEATURES/CLOUD1_CLOUDSYNC to BRANCHES/V4.1:
         41115: CloudSync: ALF-15734 - force unsync (of last SSMN) on target causes repeating pull errors to appear in both logs
   41176: Attempt to debug unit test failure
   41181: Store leak in AVMServiceTest.test_ETWOTWO_570() causing unit test failure
   41184: ALF-15610: Copy Thai analyzer settings to its many SOLR locations
   41194: ALF-11297: re-enable system build tests
   41195: ALF-11297 ALF-15807: update activities system build tests after correction of ALF-4832
   41201: Fix for ALF-15767 Group query using cm:authorityName
   41202: Additional unit tests related to ALF-15731  TYPE:"..." queries no longer work for Lucene on 4.X
   41203: Part 1 for ALF-15811 SOLR query increases DocBitSet inefficiently
   - check it makes any difference
   41204: Merged BRANCHES/DEV/BELARUS/V4.1-BUG-FIX-2012_08_15 to BRANCHES/DEV/V4.1-BUG-FIX: (note: merging as-is ... refactor + unit test fix to follow in next commit)
      40926: ALF-12586: Admin Console shows usage as zero - if user is deleted and then re-created (eg. re-synchronized via LDAP or manually)
      40974: ALF-12586: Admin Console shows usage as zero - if user is deleted and then re-created (eg. re-synchronized via LDAP or manually)
   41205: ALF-12586: Admin Console shows usage as zero - if user is deleted and then re-created (eg. re-synchronized via LDAP or manually)
   - review and refactor the proposed/merged fix (see previous commit)
   - fix unit test so that it accounts for previous content (as per the original issue)
   - also: add missing test to suite and fix that test to work with the new fix (ie. cleanup previous content, else need to account for it)
   41210: Part 2:  ALF-14861 SOLR to scale for non-admin users in 100k sites and a subgroup of each of 1000 independent groupings with 1000 subgroups
   - do not expand authorities for thoses with the ADMINISTRATOR_ROLE as they can read all anyway
   41216: ALF-11297: system build tests need a database cleanup before running
   41222: ALF-15740, ALF-14744: Update rule firing broken for content created in Explorer
   - Old code lurking around that used to use the inline editable aspect to detect events handled by the CreateNodeRuleTrigger was removed from OnContentUpdateRuleTrigger and replaced with a check for ASPECT_NO_CONTENT
   41223: Added missing swf.languagedir setting to enterprise alfresco-global.properties
   41230: GERMAN: Translation updates based on EN rev41099.
   41232: SPANISH: Translation updates based on EN rev41099.
   41233: FRENCH: Translation updates based on EN rev41099.
   41234: ITALIAN: Translation updates based on EN rev41099.
   41235: JAPANESE: Translation updates based on EN rev41099.
   41236: DUTCH: Translation updates based on EN rev41099.
   41237: RUSSIAN: Translation updates based on EN rev41099.
   41239: CHINESE: Translation updates based on EN rev41099.
   41254: ALF-15628: Avoid edit online (SPP, WRITE_LOCK) clashing with edit offline (CheckOutCheckInService, READ_ONLY_LOCK)
   - Rationalization of work by Alex Malinovsky
   - WebDAVMethod.checkNode() now properly checks whether nodes without WebDAV lock info are writeable
   - CheckOutCheckInService won't allow checkout of a node with an existing WRITE_LOCK by the same user - they must unlock first
   - Propagation of correct status codes
   41264: ALF-15628: Fix CheckOutCheckInService test failures
   41265: ALF-15699: Reverse merged the following, thus downgrading us back to swftools 0.9.1
      40208: ALF-12831: Upgrade to swftools 0.9.2
   41266: Rush'n in some translation updates from Gloria
   41267: ALF-15628: Fix compilation problem
   41269: Merged V3.4-BUG-FIX to V4.1-BUG-FIX (RECORD ONLY)
      41224: ALF-14856: Merged V4.1-BUG-FIX to V3.4-BUG-FIX
      41268: ALF-15459: Merged PATCHES/V4.0.2 to V3.4-BUG-FIX
         Merged V4.1-BUG-FIX to V3.4-BUG-FIX
   41274: ALF-15608: Merged V3.4-BUG-FIX to V4.1-BUG-FIX
      41272: ALF-15567: Allow links to be followed through WebDAV on port 80 using basic auth on XP
   41277: ALF-12586: Admin Console shows usage as zero - if user is deleted and then re-created (eg. re-synchronized via LDAP or manually) 
   - fix test fallout after merge/fix (note: failed for PostgreSQL but not MySQL - although fix was not DB-specific)
   41278: ALF-15840 Error logged when "No thumbnail present in file" even though this is normal 
   41284: ALF-14875: Serialize direct permissions after inherited permissions so that they take precedence in any lookups in permission dialogs
   41290: JAPANESE: Translation updates based on EN r41099 Fixes: ALF-14565
   41296: ALF-15251	CIFS: Checked out document is not marked as locked in CIFS
   41299: ALF-15714: Bitrock Uninstaller: Uninstaller doesn't remove all files and folders in *nix
   - Additional fix provided by Bitrock
   41303: Fix for ALF-15799 Under high concurrency load balanced Solr throws an Antlr related NPE
   - do not skip IO Exceptions
   41306: Incremented version revision for 4.1.2
   41309: ALF-15827: Added FORMACTION, FORMMETHOD and ACTION  HTML attributes to grey list to close security hole (updated Surf libs r1136)
   41318: ALF-15857: Lucene FTS indexer opens streams to all documents to be indexed in a transaction simultaneously
   - Now stream opening is delayed until the point where the document is being written to the index
   41322: Fix for ALF-15858 SOLR ACL tracking can stall or miss acls during tracking
   41323: Chemistry client java to create test data for ALF-15858, ALF-15782, CLOUD-596, ALF-15753 etc
   41326: ALF-15234: IE 8 or IE9 Download .pps as .ppt 
      -Switched the order of the filename headers to better support non-conforming browsers (rfc 5987).
   41330: ALF-14875: Reversed r41284 because it didn't solve the problem in the UI. Kev reviewing.
   41332: ALF-10688: Can't deactivate an account when alfrescoNtlm follows another authentication subsystem in the authentication chain
   - Now, if a account is known to be 'mutable' then the enabled flag is read from the mutable authentication service
   41337: Merged V3.4-BUG-FIX (3.4.11) to V4.1-BUG-FIX (4.1.2)
      41336: TransformerDebug: Use debug rather than trace when there are transformers but they are all unavailable.
   41339: ALF-15840 Error logged when "No thumbnail present in file" even though this is normal
      - Found some more cases where this is logged as an ERROR
   41342: ALF-11087 (Missing icon file: components\images\filetypes\generic-tag-32.png)
   41344: ALF-15863 (* search values): Merged HEAD to V4.1-BUG-FIX (4.1.2)
      40849: ALF-12839 "Share - Inconsistency in adding a user or a group into a group" part 2
      - Making the users console stop "*" searches, just like the groups console when the min search length is set to larger than 0.
   41346: ALF-15237 - REST API Group children lists username for fullName and displayName
   41350: Merge V3.4-BUG-FIX to V4.1-BUG-FIX:
   41065: Disconnect existing CIFS sessions from the same client when a virtual circuit zero session is opened. ALF-13815
   41280: Moved session cleanup config into the base authenticator, added support to passthru/base authentication. ALF-13815
   41351: Ported database filesystem changes to fix session disconnect, from V3.4.
   41352: Merge V3.4-BUG-FIX to V4.1-BUG-FIX:
   41067: Added session disconnect support to the Alfresco CIFS authenticator. ALF-13815.
   41281: Added session cleanup support to passthru authenticator, session cleanup config moved to base class. ALF-13815 
   41353: Update svn:mergeinfo
   41355: Fix for ALF-15869 - "Site Content" dashlet shows all documents from all the sites in Alfresco Share
    - mistakenly did a record-only merge of this from 4.1->4.1.1
   41363: Fix for ALF-14875 - Manage permissions shows the permission 'No privileges' for All Other Users
    - reworked the permissions dialog and permissions panels to correctly handle multiple permissions on a special permissions group such as GROUP_EVERYONE
    - now correctly gets/sets permissions for GROUP_EVERYONE
    - this also fixes ALF-12014 - in that it allows custom SiteXYZ permissions to work correctly again also (will need manual backport for 3.4.X though)
    - removed hacks related to previous attempts to fix the above issue
    - added lots of comments around relevant sections to add in future refactoring or understanding
   41371: Merged BRANCHES/DEV/V3.4-BUG-FIX to BRANCHES/DEV/V4.1-BUG-FIX (RECORD ONLY)
      41370: Fix for ALF-12014 - Share - Custom role causes incorrect display of permissions
   Manual merge of changes to 4.1.2
   41399: ALF-13438: java.lang.OutOfMemoryError appears in alfresco log when trying to create few thousands of sites consistently. 
   - The v4.0 parent assocs cache used to store every verion of every node's parent assocs, so as we added a node to 60,000 sites, we retained all previous versions of the user's parent association map
   - After creating 10,000 sites, the cache size was about 4GB, containing about 2 million parents
   - Now we use a specialized class that allows an upper limit to be set on the total number of cached parents as well as children.
   - Because the cache is keyed by node transaction ID, the cache can be non-clustered and non-transactional
   - Once the average number of parents is more than 8, the cache will drop its oldest entries
   - ParentAssocsInfo also now uses a compact TreeMap instead of a HashMap
   41401: ALF-13438: Small correction
   41406: ALF-13438: Fix failing unit tests
   - Removed unused node.parentAssocsSharedCache and corrected node.childByNameCache not to reference it!
   - Because parent assocs are cached by transaction ID, we must always invalidate them on an in-transaction version increment
   41409: Logging of unexepected errors on FTP
   41411: Fix possible FTP data session leak if client mixes PORT and PASV commands. ALF-15126
   41412: ALF-15845 : Clone for Hotfix: Word document on Windows via CIFS becomes locked (Read Only) when network drops temporarily
   41415: Fixes: ALF-15649: Removes country locale from files with it hard coded.
   41419: ALF-14599: Removed ftp.ipv6.enabled from enterprise overlay and bundles
   41426: ALF-15845 Clone for Hotfix: Word document on Windows via CIFS becomes locked (Read Only) when network drops temporarily
     Roll back changes to DiskDriver interface in favour of hacking NetworkFile.
   41440: JAPANESE: Translation update based on EN r41099
   41446: ALF-13091: Remove unecessary bean post processors from sub ssytem context and remove CXF's Jsr250BeanPostProcessor.
   41458: RUSSIAN: Further translation updates following linguistic review.
   41459: ALF-15897: Revert revision 41446, an attempted fix for ALF-13091
   41487: Fix for ALF-15910 SOLR - Add index warming and filter pointless entries from the filter cache
   Fix for ALF-15851
   Too many live instances of SolrIndexSearcher at one time resulting in OOM - Alfresco 4.1.1 - build 151
   41506: Merged DEV to V4.1-BUG-FIX
      41505: ALF-15879: PostgreSQL: upgrade 2.2.8 (577) -> 3.4.10 (703) -> 4.1.1 (159) failed.
             - Make dropping "store_id" index and "alf_node_store_id_key" constraint optional in 4.1.1 upgrade script
               because clean 3.4 has "store_id" index and doesn't have "alf_node_store_id_key" constraint,
               but 3.4 upgraded from 2.2  has "alf_node_store_id_key" constraint and doesn't have "store_id" index.
   41531: Fixed ALF-15687, so that any user (except for Admin) won’t be able to retrieve any other user’s preferences via REST API. Also, updated the preferences controllers for the Post and Delete.
   41539: ALF-15899: Inbound email does not support multiple recipient folders
   - Fix by Dmitry Vaserin
   41540: Merged V3.4-BUG-FIX to V4.1-BUG-FIX
      40794: Merged DEV to V3.4-BUG-FIX
         40793: ALF-13752 Saving Word (mac 2011) documents via CIFS into a folder with Versionable rules on Mac OS X Lion (Fix for 3.4)
            In ContentDiskDriver.renameFile() was added a check whether a node in the archive.
      40806: Fix for ALF-9787 - Hiding sites in Share with permissionsDefinitions.xml [creates a permissions error in the blog portion of the site]
      40922: Merged DEV to V3.4-BUG-FIX (reviewed by Frederik)
         40488: ALF-13357 : Empty outcome when a timer is invoked
            A check for transitionName was added to AlfrescoTimer to support custom transitions.
      40940: ALF-15696: Remove svnkit.jar - makes the build fail if the version of installed command line svn is 1.7. Using commandline binding for <svn> Ant task to be consistent with other parts of the build.
      41066: Various fixes to the database filesystem for session disconnect cleanup.
      41068: Updates to the Alfresco filesystem for session cleanup. ALF-13815
      41301: Merged PATCHES/V3.4.9 to V3.4-BUG-FIX
         40966: ALF-15846 / ALF-15709: OOM on cascading reindex
         - Avoid buffering of all the affected PATH documents in memory - used the set of 'visited' paths to delay generation to the final flush.
         41044: ALF-15847 / ALF-15748: Lucene indexer can make sub-optimal cascade reindex decisions during an LDAP sync.
         - When a user in 6 groups was removed from a massive group, the massive group was getting cascade reindexed rather than the user
         - Logic adjusted as follows:
            For nodes with 5 or less parents, we always cascade reindex the child node. For nodes with more than 5 parents, we cascade reindex the parent node if it has less children than the child has parents.
      41395: ALF-15715: Unable to edit properties whilst transformation in progress
         - Delayed all changes that would potentially lock the parent node row while the thumbnail is generating.
         - Reorganized RenditionContext to lazily instantiate its destination node.
         - Changed render destination to use temporary ContentWriter until render is complete.
      41396: ALF-15715: Fix for failing unit tests.
      41413: Fix for issue where user calendar remote api was generating invalid date searches for user dashlet calendar.
      41509: Merged DEV to V3.4-BUG-FIX
         41507: ALF-12833: Issues installing Alfresco on WebSphere when the server doesn't have internet access
            Context-param which Sets "http://apache.org/xml/features/nonvalidating/load-external-dtd" feature on the SAXParser to false if this parameter is false 
      41510: ALF-15171: After addition of a secondary parent association to a container, not all index paths were being regenerated due to a logic error
      41512: ALF-15919: Merged PATCHES/V3.4.10 to V3.4-BUG-FIX
         41091: ALF-15723:  Merged DEV to PATCHES/V3.4.10
            26579: Switch the transformer to use Tika


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@41543 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
2012-09-12 19:10:54 +00:00

1092 lines
43 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.rendition.executer;
import static org.alfresco.service.cmr.rendition.RenditionService.PARAM_DESTINATION_PATH_TEMPLATE;
import static org.alfresco.service.cmr.rendition.RenditionService.PARAM_IS_COMPONENT_RENDITION;
import static org.alfresco.service.cmr.rendition.RenditionService.PARAM_ORPHAN_EXISTING_RENDITION;
import static org.alfresco.service.cmr.rendition.RenditionService.PARAM_RENDITION_NODETYPE;
import java.io.Serializable;
import java.util.ArrayList;
import java.util.Collection;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel;
import org.alfresco.model.RenditionModel;
import org.alfresco.repo.action.ParameterDefinitionImpl;
import org.alfresco.repo.action.executer.ActionExecuterAbstractBase;
import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.nodelocator.NodeLocator;
import org.alfresco.repo.nodelocator.SelfNodeLocator;
import org.alfresco.repo.policy.BehaviourFilter;
import org.alfresco.repo.rendition.RenderingEngineDefinitionImpl;
import org.alfresco.repo.rendition.RenditionDefinitionImpl;
import org.alfresco.repo.rendition.RenditionLocation;
import org.alfresco.repo.rendition.RenditionLocationResolver;
import org.alfresco.repo.rendition.RenditionNodeManager;
import org.alfresco.repo.security.authentication.AuthenticationUtil;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.action.ActionDefinition;
import org.alfresco.service.cmr.action.ParameterDefinition;
import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
import org.alfresco.service.cmr.rendition.RenderCallback;
import org.alfresco.service.cmr.rendition.RenditionDefinition;
import org.alfresco.service.cmr.rendition.RenditionService;
import org.alfresco.service.cmr.rendition.RenditionServiceException;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.ContentService;
import org.alfresco.service.cmr.repository.ContentWriter;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.namespace.NamespaceException;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.GUID;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.extensions.surf.util.I18NUtil;
import com.sun.star.lang.NullPointerException;
/**
* This class adds some new behaviour to the standard ActionExecuterAbstractBase
* in order to support the RenditionService.
*
* @author Neil McErlean
* @author Nick Smith
* @since 3.3
*/
public abstract class AbstractRenderingEngine extends ActionExecuterAbstractBase
{
/** Logger */
private static Log logger = LogFactory.getLog(AbstractRenderingEngine.class);
protected static final String CONTENT_READER_NOT_FOUND_MESSAGE = "Cannot find Content Reader for document. Operation can't be performed";
private static final String DEFAULT_RUN_AS_NAME = AuthenticationUtil.getSystemUserName();
// A word on the default* fields below:
//
// RenditionExecuters can be executed with or without two optional
// parameters: "rendition node type"
// and a "rendition content property" parameter.
// These parameters can be specified on a per-action basis.
// If no value is specified, then the default is used.
// That default can be injected via Spring.
// If no default is injected via spring, then there is a "default default"
// for the two params
/**
* This is the default default node type for renditions - used if no value
* is injected from spring.
*/
private static final QName DEFAULT_DEFAULT_RENDITION_NODE_TYPE = ContentModel.TYPE_CONTENT;
/**
* This is the default default property used to specify where rendition
* content is stored - used if no value is injected from spring.
*/
private static final QName DEFAULT_DEFAULT_RENDITION_CONTENT_PROP = ContentModel.PROP_CONTENT;
private static final String DEFAULT_MIMETYPE = MimetypeMap.MIMETYPE_TEXT_PLAIN;
private static final String DEFAULT_ENCODING = "UTF-8";
/**
* This is the default node type that is used when creating rendition
* objects.
*/
private QName defaultRenditionNodeType = DEFAULT_DEFAULT_RENDITION_NODE_TYPE;
/**
* This is the default property that is used to store rendition objects'
* content.
*/
private QName defaultRenditionContentProp = DEFAULT_DEFAULT_RENDITION_CONTENT_PROP;
/**
* This is the default content property.
*/
private static final QName DEFAULT_CONTENT_PROPERTY = ContentModel.TYPE_CONTENT;
/* Injected Services */
protected ContentService contentService;
protected MimetypeMap mimetypeMap;
/* Parameter names common to all Rendering Actions */
/**
* This optional {@link String} parameter specifies the location of a
* classpath resource which can be used as a placeholder while a rendition
* is being generated. For example, this might be a simple icon to indicate
* a rendition is not yet available. This is intended to be used in
* conjunction with asynchronous generation of renditions.
*/
public static final String PARAM_PLACEHOLDER_RESOURCE_PATH = "placeHolderResourcePath";
/**
* This optional {@link QName} parameter specifies which property the
* Rendering Engine uses to read content from the source node in order to
* create a rendition. By default this property will be cm:content.
*/
public static final String PARAM_SOURCE_CONTENT_PROPERTY = "sourceContentProperty";
/**
* This optional {@link QName} parameter specifies which property the
* Rendering Engine uses to write content to the rendition node. By default
* the property used is cm:content.
*/
public static final String PARAM_TARGET_CONTENT_PROPERTY = "targetContentProperty";
/**
* This optional {@link Boolean} flag property specifies whether a rendition
* should be updated automatically if the source node changes. If set to
* <code>true</code> then the rendition will be re-rendered any time any
* property changes occur on the source node. This parameter defaults to
* <code>false</code>.
*/
public static final String PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE = "update-renditions-on-any-property-change";
/**
* This optional {@link String} parameter specifies what user permissions
* are used when creating a rendition. By default the system user is used.
*/
public static final String PARAM_RUN_AS = "runAs";
// mime-type is not a common parameter on all Rendering Actions, but it is
// common to many and is used in some common handling code in this class.
/**
* This optional {@link String} parameter specifies the mime type of the
* rendition content. This defaults to the mime type of the source node
* content.
*/
public static final String PARAM_MIME_TYPE = "mime-type";
/**
* This optional {@link String} paramter specifies the encoding used to
* create the rendition content. The derfault encoding is UTF-8.
*/
public static final String PARAM_ENCODING = "encoding";
/**
* Default {@link NodeLocator} simply returns the source node.
*/
private final static NodeLocator defaultNodeLocator = new SelfNodeLocator();
/*
* Injected beans
*/
private RenditionLocationResolver renditionLocationResolver;
protected NodeService nodeService;
private RenditionService renditionService;
private BehaviourFilter behaviourFilter;
private final NodeLocator temporaryParentNodeLocator;
private final QName temporaryRenditionLinkType;
/**
* Injects the nodeService bean.
*
* @param nodeService
* the nodeService.
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* Injects the renditionService bean.
*
* @param renditionService
*/
public void setRenditionService(RenditionService renditionService)
{
this.renditionService = renditionService;
}
/**
* @param behaviourFilter policy behaviour filter
*/
public void setBehaviourFilter(BehaviourFilter behaviourFilter)
{
this.behaviourFilter = behaviourFilter;
}
public void setRenditionLocationResolver(RenditionLocationResolver renditionLocationResolver)
{
this.renditionLocationResolver = renditionLocationResolver;
}
public AbstractRenderingEngine(NodeLocator temporaryParentNodeLocator, QName temporaryRenditionLinkType)
{
this.publicAction = false;
this.temporaryParentNodeLocator = temporaryParentNodeLocator != null ? temporaryParentNodeLocator
: defaultNodeLocator;
this.temporaryRenditionLinkType = temporaryRenditionLinkType != null ? temporaryRenditionLinkType
: RenditionModel.ASSOC_RENDITION;
}
public AbstractRenderingEngine()
{
this(null, null);
}
/**
* Sets the default rendition-node type.
*
* @param type
*/
public void setDefaultRenditionNodeType(String type)
{
QName qname;
try
{
qname = QName.createQName(type);
}
catch (NamespaceException nx)
{
if (logger.isErrorEnabled())
{
logger.error("Error when setting default rendition node type: ", nx);
}
throw nx;
}
if (logger.isInfoEnabled())
{
logger.info("Using default rendition node type: " + qname);
}
this.defaultRenditionNodeType = qname;
}
/**
* This method returns the type of the default rendition node type.
*
* @return the QName representing the type of the default rendition node
* type.
*/
protected QName getDefaultRenditionNodeType()
{
return defaultRenditionNodeType;
}
protected String getTargetMimeType(RenderingContext context)
{
return context.getParamWithDefault(PARAM_MIME_TYPE, DEFAULT_MIMETYPE);
}
protected String getTargetEncoding(RenderingContext context)
{
return context.getParamWithDefault(PARAM_ENCODING, DEFAULT_ENCODING);
}
/**
* Sets the default rendition content property.
*
* @param prop
*/
public void setDefaultRenditionContentProp(String prop)
{
QName qname;
try
{
qname = QName.createQName(prop);
}
catch (NamespaceException nx)
{
if (logger.isErrorEnabled())
{
logger.error("Error when setting default rendition content property: ", nx);
}
throw nx;
}
if (logger.isInfoEnabled())
{
logger.info("Using default rendition content property: " + qname);
}
this.defaultRenditionContentProp = qname;
}
/**
* This method returns the QName of the property that defines the location
* of the rendition content. An example would be cm:content.
*
* @return the QName the property defining the location of the rendition
* content.
*/
protected QName getDefaultRenditionContentProp()
{
return defaultRenditionContentProp;
}
/**
* Set the content service
*
* @param contentService the content service
*/
public void setContentService(ContentService contentService)
{
this.contentService = contentService;
}
public void setMimetypeMap(MimetypeMap mimetypeMap)
{
this.mimetypeMap = mimetypeMap;
}
@Override
protected ActionDefinition createActionDefinition(String definitionName)
{
return new RenderingEngineDefinitionImpl(definitionName);
}
@Override
protected void executeImpl(final Action action, final NodeRef sourceNode)
{
executeImpl( (RenditionDefinition)action, sourceNode );
}
protected void executeImpl(final RenditionDefinition renditionDef, final NodeRef sourceNode)
{
if (nodeService.exists(sourceNode) == true)
{
if (logger.isDebugEnabled())
{
StringBuilder msg = new StringBuilder();
msg.append("Rendering node ").append(sourceNode).append(" with rendition definition ").append(
renditionDef.getRenditionName());
msg.append("\n").append(" parameters:").append("\n");
if (renditionDef.getParameterValues().isEmpty() == false)
{
for (String paramKey : renditionDef.getParameterValues().keySet())
{
msg.append(" ").append(paramKey).append("=").append(renditionDef.getParameterValue(paramKey)).append("\n");
}
}
else
{
msg.append(" [None]");
}
logger.debug(msg.toString());
}
Serializable runAsParam = renditionDef.getParameterValue(AbstractRenderingEngine.PARAM_RUN_AS);
String runAsName = runAsParam == null ? DEFAULT_RUN_AS_NAME : (String) runAsParam;
// Renditions should all be created by system by default.
// When renditions are created by a user and are to be created under a
// node
// other than the source node, it is possible that the user will not
// have
// permissions to create content under that node.
// For that reason, we execute all rendition actions as system
// by default.
AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork<Void>()
{
@Override
public Void doWork() throws Exception
{
ChildAssociationRef result = null;
try
{
// Check whether this rendition is a component of a larger CompositeRendition
boolean isComponentRendition = isComponentRendition(renditionDef);
if (isComponentRendition == false)
{
// Request that the rendition is initially created
// as a child of the source node
setTemporaryRenditionProperties(sourceNode, renditionDef);
}
// Have the concrete implementation do the actual rendition
executeRenditionImpl(renditionDef, sourceNode);
//
if (isComponentRendition == false)
{
// Add renditioned aspect to the source node
tagSourceNodeAsRenditioned(renditionDef, sourceNode);
// Currently the rendition is on a temporary node, which may
// have the wrong name on it, and for path based renditions is
// in the wrong place
// So, have the correct node created, and switch everything to use it
switchToFinalRenditionNode(renditionDef, sourceNode);
}
// Grab a link to the rendition node - it's been saved as a parameter for us
// (Wait until now to fetch in case it was moved)
result = (ChildAssociationRef)renditionDef.getParameterValue(PARAM_RESULT);
} catch (Throwable t)
{
notifyCallbackOfException(renditionDef, t);
throwWrappedException(t);
}
if (result != null)
{
notifyCallbackOfResult(renditionDef, result);
}
return null;
}
}, runAsName);
}
else
{
if (logger.isDebugEnabled() == true)
{
logger.debug("Rendition has not been created, because the node no longer exitst. (sourceNode=" + sourceNode + ")");
}
}
}
/**
* Is this a standalone rendition, or is it a sub-component of
* a composite rendition?
* This is false for standalone renditions, AND ALSO false for
* the main part of a composite rendition.
* This only returns true if we're currently processing a
* component of a composite rendition.
* @param action
* @return
*/
private boolean isComponentRendition(Action action) {
Serializable s = action.getParameterValue(PARAM_IS_COMPONENT_RENDITION);
boolean result = s == null ? false : (Boolean)s;
return result;
}
protected void executeRenditionImpl(Action action, NodeRef sourceNode)
{
if (logger.isDebugEnabled())
{
StringBuilder msg = new StringBuilder();
msg.append("Executing rendering engine; name:")
.append(this.name).append(", class:")
.append(this.getClass().getName());
logger.debug(msg.toString());
}
checkParameterValues(action);
RenditionDefinition renditionDefinition = checkActionIsRenditionDefinition(action);
checkSourceNodeExists(sourceNode);
QName targetContentProp = getRenditionContentProperty(renditionDefinition);
RenderingContext context = new RenderingContext(sourceNode,
renditionDefinition,
targetContentProp);
render(context);
// This is a workaround for the fact that actions don't have return
// values.
action.getParameterValues().put(PARAM_RESULT, context.getChildAssociationRef());
}
/**
* This method can be overridden by subclasses to provide checking of parameter
* values.
* If a parameter value is illegal or inappropriate, an exception
* should be thrown.
*/
protected void checkParameterValues(Action action)
{
// Intentionally empty
}
/**
* @param renditionDefinition
* @return
*/
protected QName getRenditionContentProperty(RenditionDefinition renditionDefinition)
{
return getParamWithDefault(PARAM_TARGET_CONTENT_PROPERTY, defaultRenditionContentProp, renditionDefinition);
}
protected abstract void render(RenderingContext context);
/**
* @param actionedUponNodeRef
*/
protected void checkSourceNodeExists(NodeRef actionedUponNodeRef)
{
if (nodeService.exists(actionedUponNodeRef) == false)
{
String msg = "Cannot execute action as node does not exist: " + actionedUponNodeRef;
logger.warn(msg);
throw new RenditionServiceException(msg);
}
}
/**
* @param action
*/
protected RenditionDefinition checkActionIsRenditionDefinition(Action action)
{
if (action instanceof RenditionDefinition)
{
return (RenditionDefinition)action;
}
else
{
return new RenditionDefinitionImpl(action);
}
}
/**
* If no rendition node type is specified, then the default is used
*
* @param renditionDefinition
* @return
*/
private QName getRenditionNodeType(RenditionDefinition renditionDefinition)
{
return getParamWithDefault(PARAM_RENDITION_NODETYPE, defaultRenditionNodeType, renditionDefinition);
}
@Override
final protected void addParameterDefinitions(List<ParameterDefinition> paramList)
{
paramList.addAll(getParameterDefinitions());
}
/**
* This method gets the parameter definition display label from the properties file.
* It looks first for a property whose key has a fixed rendition service-specific
* prefix and if that gets null, it then delegates to the standard bean name-based
* approach.
*
* @param paramName the name of the parameter
* @return the display label of the parameter
*/
@Override
protected String getParamDisplayLabel(String paramName)
{
// First we try to get the message using a common prefix for all rendering engines.
final String commonPropertiesPrefix = "baseRenderingAction";
String message = I18NUtil.getMessage(commonPropertiesPrefix + "." + paramName + "." + DISPLAY_LABEL);
// And if that doesn't work we delegate to the standard bean name-based approach.
if (message == null)
{
message = super.getParamDisplayLabel(paramName);
}
return message;
}
/**
* Supplies the list of parameters required by this rendering engine.
*
* @return
*/
protected Collection<ParameterDefinition> getParameterDefinitions()
{
List<ParameterDefinition> paramList = new ArrayList<ParameterDefinition>();
paramList.add(new ParameterDefinitionImpl(RenditionDefinitionImpl.RENDITION_DEFINITION_NAME, DataTypeDefinition.QNAME, true,
getParamDisplayLabel(RenditionDefinitionImpl.RENDITION_DEFINITION_NAME)));
paramList.add(new ParameterDefinitionImpl(PARAM_RUN_AS, DataTypeDefinition.TEXT, false,
getParamDisplayLabel(PARAM_RUN_AS)));
paramList.add(new ParameterDefinitionImpl(PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE, DataTypeDefinition.BOOLEAN, false,
getParamDisplayLabel(PARAM_UPDATE_RENDITIONS_ON_ANY_PROPERTY_CHANGE)));
paramList.add(new ParameterDefinitionImpl(PARAM_RENDITION_NODETYPE, DataTypeDefinition.QNAME, false,
getParamDisplayLabel(PARAM_RENDITION_NODETYPE)));
paramList.add(new ParameterDefinitionImpl(PARAM_PLACEHOLDER_RESOURCE_PATH, DataTypeDefinition.TEXT, false,
getParamDisplayLabel(PARAM_PLACEHOLDER_RESOURCE_PATH)));
paramList.add(new ParameterDefinitionImpl(PARAM_SOURCE_CONTENT_PROPERTY, DataTypeDefinition.QNAME, false,
getParamDisplayLabel(PARAM_SOURCE_CONTENT_PROPERTY)));
paramList.add(new ParameterDefinitionImpl(PARAM_TARGET_CONTENT_PROPERTY, DataTypeDefinition.QNAME, false,
getParamDisplayLabel(PARAM_TARGET_CONTENT_PROPERTY)));
paramList.add(new ParameterDefinitionImpl(PARAM_DESTINATION_PATH_TEMPLATE, DataTypeDefinition.TEXT, false,
getParamDisplayLabel(PARAM_DESTINATION_PATH_TEMPLATE)));
paramList.add(new ParameterDefinitionImpl(PARAM_ORPHAN_EXISTING_RENDITION, DataTypeDefinition.BOOLEAN, false,
getParamDisplayLabel(PARAM_ORPHAN_EXISTING_RENDITION)));
paramList.add(new ParameterDefinitionImpl(PARAM_RESULT, DataTypeDefinition.CHILD_ASSOC_REF, false,
getParamDisplayLabel(PARAM_RESULT)));
paramList.add(new ParameterDefinitionImpl(PARAM_IS_COMPONENT_RENDITION, DataTypeDefinition.BOOLEAN, false,
getParamDisplayLabel(PARAM_IS_COMPONENT_RENDITION)));
return paramList;
}
private ChildAssociationRef createRenditionNodeAssoc(NodeRef sourceNode, RenditionDefinition renditionDefinition)
{
QName renditionName = renditionDefinition.getRenditionName();
// The ThumbnailService puts a cm:name property on its thumbnail nodes.
Map<QName, Serializable> nodeProps = new HashMap<QName, Serializable>();
nodeProps.put(ContentModel.PROP_NAME, renditionName.getLocalName());
nodeProps.put(ContentModel.PROP_CONTENT_PROPERTY_NAME, getRenditionContentProp(renditionDefinition));
QName assocName = QName.createQName(NamespaceService.RENDITION_MODEL_1_0_URI, GUID.generate());
NodeRef parentNode = renditionDefinition.getRenditionParent();
QName assocType = renditionDefinition.getRenditionAssociationType();
QName nodeType = getRenditionNodeType(renditionDefinition);
// Ensure that the creation of rendition children does not cause updates
// to the modified, modifier properties on the source node
behaviourFilter.disableBehaviour(parentNode, ContentModel.ASPECT_AUDITABLE);
ChildAssociationRef childAssoc = null;
try
{
childAssoc = nodeService.createNode(parentNode, assocType, assocName, nodeType, nodeProps);
if (logger.isDebugEnabled())
{
logger.debug("Created node " + childAssoc + " as child of " + parentNode + " with assoc-type " + assocType);
}
}
finally
{
behaviourFilter.enableBehaviour(parentNode, ContentModel.ASPECT_AUDITABLE);
}
return childAssoc;
}
private Serializable getRenditionContentProp(RenditionDefinition renditionDefinition)
{
return getParamWithDefault(PARAM_TARGET_CONTENT_PROPERTY, getDefaultRenditionContentProp(), renditionDefinition);
}
/**
* Gets the value for the named parameter. Checks the type of the parameter
* is correct and throws a {@link RenditionServiceException} if it isn't.
* Returns <code>null</code> if the parameter value is <code>null</code>
*
* @param paramName the name of the parameter being checked.
* @param clazz the expected {@link Class} of the parameter value.
* @param definition the {@link RenditionDefinition} containing the
* parameters.
* @return the parameter value or <code>null</code>.
*/
@SuppressWarnings("unchecked")
public static <T> T getCheckedParam(String paramName, Class<T> clazz, RenditionDefinition definition)
{
Serializable value = definition.getParameterValue(paramName);
if (value == null)
return null;
else
{
if(clazz == null)
throw new RenditionServiceException("The class must not be null!", new NullPointerException());
Class<? extends Serializable> valueClass = value.getClass();
if ( !valueClass.isAssignableFrom(clazz))
{
throw new RenditionServiceException("The parameter: " + paramName + " must be of type: "
+ clazz.getName() + "but was of type: " + valueClass.getName());
}
else
return (T) value;
}
}
/**
* Gets the value for the named parameter. Checks the type of the parameter
* is the same as the type of <code>defaultValue</code> and throws a
* {@link RenditionServiceException} if it isn't. Returns
* <code>defaultValue</code> if the parameter value is <code>null</code>
*
* @param <T>
* @param paramName
* @param defaultValue
* @param definition
* @return
*/
@SuppressWarnings("unchecked")
public static <T> T getParamWithDefault(String paramName, T defaultValue, RenditionDefinition definition)
{
if(defaultValue == null)
throw new RenditionServiceException("The defaultValue cannot be null!", new NullPointerException());
Class<? extends T> clazz = (Class<? extends T>) defaultValue.getClass();
T result = getCheckedParam(paramName, clazz, definition);
if (result == null)
result = defaultValue;
return result;
}
protected class RenderingContext
{
private final NodeRef sourceNode;
private final RenditionDefinition definition;
private final QName renditionContentProperty;
private ChildAssociationRef caNodeRef;
/**
* @param sourceNode
* @param destinationNode
* @param definition
* @param renditionContentProperty
*/
public RenderingContext(NodeRef sourceNode,//
RenditionDefinition definition,//
QName renditionContentProperty)
{
this.sourceNode = sourceNode;
this.definition = definition;
this.renditionContentProperty = renditionContentProperty;
}
/**
* @return the sourceNode
*/
public NodeRef getSourceNode()
{
return this.sourceNode;
}
/**
* Lazily instantiation of the ChildAssociationRef
* @return ChildAssociationRef
*/
public synchronized ChildAssociationRef getChildAssociationRef()
{
if (this.caNodeRef == null)
{
this.caNodeRef = createRenditionNodeAssoc(sourceNode, definition);
}
return this.caNodeRef;
}
/**
* @return the destinationNode
*/
public NodeRef getDestinationNode()
{
return getChildAssociationRef().getChildRef();
}
/**
* @return the definition
*/
public RenditionDefinition getDefinition()
{
return this.definition;
}
/**
* Gets the value for the named parameter from the . Checks the type of
* the parameter is correct and throws and Exception if it isn't.
* Returns <code>null</code> if the parameter value is <code>null</code>
*
* @param paramName the name of the parameter being checked.
* @param clazz the expected {@link Class} of the parameter value.
* @return the parameter value or <code>null</code>.
*/
public <T> T getCheckedParam(String paramName, Class<T> clazz)
{
return AbstractRenderingEngine.getCheckedParam(paramName, clazz, definition);
}
/**
* Gets the value for the named parameter. Checks the type of the
* parameter is the same as the type of <code>defaultValue</code> and
* throws a {@link RenditionServiceException} if it isn't. Returns
* <code>defaultValue</code> if the parameter value is <code>null</code>
*
* @param <T>
* @param paramName
* @param defaultValue
* @return
*/
public <T> T getParamWithDefault(String paramName, T defaultValue)
{
return AbstractRenderingEngine.getParamWithDefault(paramName, defaultValue, definition);
}
public ContentReader makeContentReader()
{
QName srcContentProp = getParamWithDefault(PARAM_SOURCE_CONTENT_PROPERTY, DEFAULT_CONTENT_PROPERTY);
ContentReader contentReader = contentService.getReader(sourceNode, srcContentProp);
if (contentReader == null || !contentReader.exists())
{
throw new RenditionServiceException(CONTENT_READER_NOT_FOUND_MESSAGE);
}
return contentReader;
}
public ContentWriter makeContentWriter()
{
ContentWriter contentWriter = contentService.getWriter(getDestinationNode(), renditionContentProperty, true);
String mimetype = getTargetMimeType(this);
contentWriter.setMimetype(mimetype);
String encoding = getTargetEncoding(this);
contentWriter.setEncoding(encoding);
return contentWriter;
}
public int getIntegerParam(String key, int defaultValue)
{
Serializable serializable = definition.getParameterValue(key);
if (serializable == null)
return defaultValue;
else
{
Number number = (Number) serializable;
return number.intValue();
}
}
}
protected void tagSourceNodeAsRenditioned(final RenditionDefinition renditionDef, final NodeRef actionedUponNodeRef)
{
// Adds the 'Renditioned' aspect to the source node if it
// doesn't already have it.
if (!nodeService.hasAspect(actionedUponNodeRef, RenditionModel.ASPECT_RENDITIONED))
{
if (logger.isDebugEnabled())
{
logger.debug("Applying " + RenditionModel.ASPECT_RENDITIONED + " to " + actionedUponNodeRef);
}
// Ensure we do not update the 'modifier' due to rendition addition
behaviourFilter.disableBehaviour(actionedUponNodeRef, ContentModel.ASPECT_AUDITABLE);
try
{
nodeService.addAspect(actionedUponNodeRef, RenditionModel.ASPECT_RENDITIONED, null);
}
finally
{
behaviourFilter.enableBehaviour(actionedUponNodeRef, ContentModel.ASPECT_AUDITABLE);
}
}
}
protected void switchToFinalRenditionNode(final RenditionDefinition renditionDef, final NodeRef actionedUponNodeRef)
{
ChildAssociationRef tempRendAssoc = (ChildAssociationRef)renditionDef.getParameterValue(PARAM_RESULT);
if (logger.isDebugEnabled())
{
logger.debug("Switching temporary rendition: " + tempRendAssoc);
}
ChildAssociationRef result = createOrUpdateRendition(actionedUponNodeRef, tempRendAssoc, renditionDef);
renditionDef.setParameterValue(PARAM_RESULT, result);
}
protected void notifyCallbackOfException(RenditionDefinition renditionDefinition, Throwable t)
{
// Rendition has failed. If there is a callback, it needs to be notified
if (renditionDefinition != null)
{
RenderCallback callback = renditionDefinition.getCallback();
if (callback != null)
{
callback.handleFailedRendition(t);
}
}
}
protected void throwWrappedException(Throwable t)
{
// and rethrow Exception
if (t instanceof AlfrescoRuntimeException)
{
throw (AlfrescoRuntimeException) t;
} else
{
throw new RenditionServiceException(t.getMessage(), t);
}
}
protected void notifyCallbackOfResult(RenditionDefinition renditionDefinition, ChildAssociationRef result)
{
// Rendition was successful. Notify the callback object.
if (renditionDefinition != null)
{
RenderCallback callback = renditionDefinition.getCallback();
if (callback != null)
{
callback.handleSuccessfulRendition(result);
}
}
}
/**
* This method sets the temporary rendition parent node and the rendition assocType on the
* rendition definition.
*
* @param sourceNode
* @param definition the rendition definition.
*/
private void setTemporaryRenditionProperties(NodeRef sourceNode, RenditionDefinition definition)
{
// Set the parent and assoc type for the temporary rendition to be
// created.
NodeRef parent = temporaryParentNodeLocator.getNode(sourceNode, definition.getParameterValues());
definition.setRenditionParent(parent);
definition.setRenditionAssociationType(temporaryRenditionLinkType);
if (logger.isDebugEnabled())
{
StringBuilder msg = new StringBuilder();
msg.append("Temporary rendition will have parent=").append(parent)
.append(" and assoc-type=").append(temporaryRenditionLinkType);
logger.debug(msg.toString());
}
}
/**
*
* @param sourceNode The node that has been rendered
* @param tempRendition The relationship between the node and its rendition
* @param renditionDefinition The definition of the rendition that has just been performed.
* In the case of a composite rendition, this parameter refers
* to that CompositeRendition and not to any of its component renditions.
* @return
*/
private ChildAssociationRef createOrUpdateRendition(NodeRef sourceNode, ChildAssociationRef tempRendition,
RenditionDefinition renditionDefinition)
{
NodeRef tempRenditionNode = tempRendition.getChildRef();
RenditionLocation renditionLocation = resolveRenditionLocation(sourceNode, renditionDefinition, tempRenditionNode);
QName renditionQName = renditionDefinition.getRenditionName();
RenditionNodeManager renditionNodeManager = new RenditionNodeManager(sourceNode, tempRenditionNode,
renditionLocation, renditionDefinition, nodeService, renditionService, behaviourFilter);
ChildAssociationRef renditionNode = renditionNodeManager.findOrCreateRenditionNode();
// Set the name property on the rendition if it has not already been
// set.
String renditionName = getRenditionName(tempRenditionNode, renditionLocation, renditionDefinition);
nodeService.setProperty(renditionNode.getChildRef(), ContentModel.PROP_NAME, renditionName); // to manager
// Delete the temporary rendition.
nodeService.removeChildAssociation(tempRendition);
if (logger.isDebugEnabled())
{
logger.debug("Removed temporary child-association " + tempRendition);
}
// Handle the rendition aspects
manageRenditionAspects(sourceNode, renditionNode);
// Verify that everything has gone to plan, and nothing got lost on the way!
ChildAssociationRef renditionAssoc = renditionService.getRenditionByName(sourceNode, renditionQName);
if (renditionAssoc == null)
{
String msg = "A rendition of name: " + renditionQName + " should have been created for source node: "
+ sourceNode;
throw new RenditionServiceException(msg);
}
// Return the link between the source and the new, final rendition
return renditionAssoc;
}
/**
* This method manages the <code>rn:rendition</code> aspects on the rendition node. It applies the
* correct rendition aspect based on the rendition node's location and removes any out-of-date rendition
* aspect.
*/
private void manageRenditionAspects(NodeRef sourceNode, ChildAssociationRef renditionParentAssoc)
{
NodeRef renditionNode = renditionParentAssoc.getChildRef();
NodeRef primaryParent = renditionParentAssoc.getParentRef();
// If the rendition is located directly underneath its own source node
if (primaryParent.equals(sourceNode))
{
// It should be a 'hidden' rendition.
// Ensure we do not update the 'modifier' due to rendition addition
behaviourFilter.disableBehaviour(renditionNode, ContentModel.ASPECT_AUDITABLE);
try
{
nodeService.addAspect(renditionNode, RenditionModel.ASPECT_HIDDEN_RENDITION, null);
nodeService.removeAspect(renditionNode, RenditionModel.ASPECT_VISIBLE_RENDITION);
}
finally
{
behaviourFilter.enableBehaviour(renditionNode, ContentModel.ASPECT_AUDITABLE);
}
// We remove the other aspect to cover the potential case where a
// rendition
// has been updated in a different location.
} else
{
// Renditions stored underneath any node other than their source are
// 'visible'.
behaviourFilter.disableBehaviour(renditionNode, ContentModel.ASPECT_AUDITABLE);
try
{
nodeService.addAspect(renditionNode, RenditionModel.ASPECT_VISIBLE_RENDITION, null);
nodeService.removeAspect(renditionNode, RenditionModel.ASPECT_HIDDEN_RENDITION);
}
finally
{
behaviourFilter.enableBehaviour(renditionNode, ContentModel.ASPECT_AUDITABLE);
}
}
}
/**
* This method calculates the name for a rendition node. The following approaches are attempted in
* the order given below.
* <ol>
* <li>If a name is defined in the {@link RenditionLocation} then that is used.</li>
* <li>If the temporary rendition has a <code>cm:name</code> value, then that is used.</li>
* <li>Otherwise use the rendition definition's rendition name.</li>
* </ol>
*
* @param tempRenditionNode the temporary rendition node.
* @param location a RenditionLocation struct.
* @param renditionDefinition the rendition definition.
* @return the name for the rendition.
*/
private String getRenditionName(NodeRef tempRenditionNode, RenditionLocation location,
RenditionDefinition renditionDefinition)
{
// If a location name is set then use it.
String locName = location.getChildName();
if (locName != null && locName.length() > 0)
{
return locName;
}
// Else if the temporary rendition specifies a name property use that.
Serializable tempName = nodeService.getProperty(tempRenditionNode, ContentModel.PROP_NAME);
if (tempName != null)
{
return (String) tempName;
}
// Otherwise use the rendition definition local name.
return renditionDefinition.getRenditionName().getLocalName();
}
/**
* Given a rendition definition, a source node and a temporary rendition node, this method uses a
* {@link RenditionLocationResolver} to calculate the {@link RenditionLocation} of the rendition.
*/
protected RenditionLocation resolveRenditionLocation(NodeRef sourceNode, RenditionDefinition definition,
NodeRef tempRendition)
{
return renditionLocationResolver.getRenditionLocation(sourceNode, definition, tempRendition);
}
}