mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-06-16 17:55:15 +00:00
d368691efc
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@10145 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
394 lines
17 KiB
Java
394 lines
17 KiB
Java
/*
|
|
* Copyright (C) 2005-2007 Alfresco Software Limited.
|
|
*
|
|
* This program is free software; you can redistribute it and/or
|
|
* modify it under the terms of the GNU General Public License
|
|
* as published by the Free Software Foundation; either version 2
|
|
* of the License, or (at your option) any later version.
|
|
|
|
* This program 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 General Public License for more details.
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
* along with this program; if not, write to the Free Software
|
|
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
|
|
|
|
* As a special exception to the terms and conditions of version 2.0 of
|
|
* the GPL, you may redistribute this Program in connection with Free/Libre
|
|
* and Open Source Software ("FLOSS") applications as described in Alfresco's
|
|
* FLOSS exception. You should have recieved a copy of the text describing
|
|
* the FLOSS exception, and it is also available here:
|
|
* http://www.alfresco.com/legal/licensing"
|
|
*/
|
|
package org.alfresco.repo.thumbnail;
|
|
|
|
import java.io.Serializable;
|
|
import java.util.ArrayList;
|
|
import java.util.HashMap;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.model.ContentModel;
|
|
import org.alfresco.repo.content.MimetypeMap;
|
|
import org.alfresco.service.cmr.repository.ChildAssociationRef;
|
|
import org.alfresco.service.cmr.repository.ContentData;
|
|
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.cmr.repository.TransformationOptions;
|
|
import org.alfresco.service.cmr.thumbnail.ThumbnailException;
|
|
import org.alfresco.service.cmr.thumbnail.ThumbnailParentAssociationDetails;
|
|
import org.alfresco.service.cmr.thumbnail.ThumbnailService;
|
|
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.alfresco.util.ParameterCheck;
|
|
|
|
/**
|
|
* @author Roy Wetherall
|
|
*/
|
|
public class ThumbnailServiceImpl implements ThumbnailService
|
|
{
|
|
/** Error messages */
|
|
private static final String ERR_NO_CREATE = "Thumbnail could not be created as required transformation is not supported.";
|
|
private static final String ERR_DUPLICATE_NAME = "Thumbnail could not be created because of a duplicate name";
|
|
private static final String ERR_NO_PARENT = "Thumbnail has no parent so update cannot take place.";
|
|
private static final String ERR_TOO_PARENT = "Thumbnail has more than one source content node. This is invalid so update cannot take place.";
|
|
|
|
/** Node service */
|
|
private NodeService nodeService;
|
|
|
|
/** Content service */
|
|
private ContentService contentService;
|
|
|
|
/** Mimetype map */
|
|
private MimetypeMap mimetypeMap;
|
|
|
|
/** Thumbnail registry */
|
|
private ThumbnailRegistry thumbnailRegistry;
|
|
|
|
/**
|
|
* Set the node service
|
|
*
|
|
* @param nodeService node service
|
|
*/
|
|
public void setNodeService(NodeService nodeService)
|
|
{
|
|
this.nodeService = nodeService;
|
|
}
|
|
|
|
/**
|
|
* Set the content service
|
|
*
|
|
* @param contentService content service
|
|
*/
|
|
public void setContentService(ContentService contentService)
|
|
{
|
|
this.contentService = contentService;
|
|
}
|
|
|
|
/**
|
|
* Sets the mimetype map
|
|
*
|
|
* @param mimetypeMap the mimetype map
|
|
*/
|
|
public void setMimetypeMap(MimetypeMap mimetypeMap)
|
|
{
|
|
this.mimetypeMap = mimetypeMap;
|
|
}
|
|
|
|
/**
|
|
* Set thumbnail registry
|
|
*
|
|
* @param thumbnailRegistry thumbnail registry
|
|
*/
|
|
public void setThumbnailRegistry(ThumbnailRegistry thumbnailRegistry)
|
|
{
|
|
this.thumbnailRegistry = thumbnailRegistry;
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.thumbnail.ThumbnailService#getThumbnailRegistry()
|
|
*/
|
|
public ThumbnailRegistry getThumbnailRegistry()
|
|
{
|
|
return this.thumbnailRegistry;
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.thumbnail.ThumbnailService#createThumbnail(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.lang.String, org.alfresco.service.cmr.repository.TransformationOptions, java.lang.String)
|
|
*/
|
|
public NodeRef createThumbnail(NodeRef node, QName contentProperty, String mimetype, TransformationOptions transformationOptions, String thumbnailName)
|
|
{
|
|
return createThumbnail(node, contentProperty, mimetype, transformationOptions, thumbnailName, null);
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.thumbnail.ThumbnailService#createThumbnail(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.lang.String, org.alfresco.service.cmr.repository.TransformationOptions, java.lang.String, org.alfresco.service.cmr.thumbnail.ThumbnailParentAssociationDetails)
|
|
*/
|
|
public NodeRef createThumbnail(NodeRef node, QName contentProperty, String mimetype, TransformationOptions transformationOptions, String thumbnailName, ThumbnailParentAssociationDetails assocDetails)
|
|
{
|
|
// Parameter check
|
|
ParameterCheck.mandatory("node", node);
|
|
ParameterCheck.mandatory("contentProperty", contentProperty);
|
|
ParameterCheck.mandatoryString( "mimetype", mimetype);
|
|
ParameterCheck.mandatory("transformationOptions", transformationOptions);
|
|
|
|
NodeRef thumbnail = null;
|
|
|
|
// Check for duplicate names
|
|
if (thumbnailName != null && getThumbnailByName(node, contentProperty, thumbnailName) != null)
|
|
{
|
|
// We can't continue because there is already an thumnail with the given name for that content property
|
|
throw new ThumbnailException(ERR_DUPLICATE_NAME);
|
|
}
|
|
|
|
// Apply the thumbnailed aspect to the node if it doesn't already have it
|
|
if (this.nodeService.hasAspect(node, ContentModel.ASPECT_THUMBNAILED) == false)
|
|
{
|
|
this.nodeService.addAspect(node, ContentModel.ASPECT_THUMBNAILED, null);
|
|
}
|
|
|
|
// Get the name of the thumbnail and add to properties map
|
|
Map<QName, Serializable> properties = new HashMap<QName, Serializable>(2);
|
|
if (thumbnailName == null || thumbnailName.length() == 0)
|
|
{
|
|
thumbnailName = GUID.generate();
|
|
}
|
|
else
|
|
{
|
|
String thumbnailFileName = generateThumbnailFileName(thumbnailName, mimetype);
|
|
properties.put(ContentModel.PROP_NAME, thumbnailFileName);
|
|
}
|
|
properties.put(ContentModel.PROP_THUMBNAIL_NAME, thumbnailName);
|
|
|
|
// Add the name of the content property
|
|
properties.put(ContentModel.PROP_CONTENT_PROPERTY_NAME, contentProperty);
|
|
|
|
// See if parent association details have been specified for the thumbnail
|
|
if (assocDetails == null)
|
|
{
|
|
// Create the thumbnail using the thumbnails child association
|
|
thumbnail = this.nodeService.createNode(
|
|
node,
|
|
ContentModel.ASSOC_THUMBNAILS,
|
|
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, thumbnailName),
|
|
ContentModel.TYPE_THUMBNAIL,
|
|
properties).getChildRef();
|
|
}
|
|
else
|
|
{
|
|
// Create the thumbnail using the specified parent assoc details
|
|
thumbnail = this.nodeService.createNode(
|
|
assocDetails.getParent(),
|
|
assocDetails.getAssociationType(),
|
|
assocDetails.getAssociationName(),
|
|
ContentModel.TYPE_THUMBNAIL,
|
|
properties).getChildRef();
|
|
|
|
// Associate the new thumbnail to the source
|
|
this.nodeService.addChild(
|
|
node,
|
|
thumbnail,
|
|
ContentModel.ASSOC_THUMBNAILS,
|
|
QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, thumbnailName));
|
|
}
|
|
|
|
// Get the content reader and writer for content nodes
|
|
ContentReader reader = this.contentService.getReader(node, contentProperty);
|
|
ContentWriter writer = this.contentService.getWriter(thumbnail, ContentModel.PROP_CONTENT, true);
|
|
writer.setMimetype(mimetype);
|
|
writer.setEncoding(reader.getEncoding());
|
|
|
|
// Catch the failure to create the thumbnail
|
|
if (this.contentService.isTransformable(reader, writer, transformationOptions) == false)
|
|
{
|
|
// Throw exception indicating that the thumbnail could not be created
|
|
throw new ThumbnailException(ERR_NO_CREATE);
|
|
}
|
|
else
|
|
{
|
|
// Do the thumnail transformation
|
|
this.contentService.transform(reader, writer, transformationOptions);
|
|
}
|
|
|
|
// Return the created thumbnail
|
|
return thumbnail;
|
|
}
|
|
|
|
/**
|
|
* Generates the thumbnail name from the name and destination mimertype
|
|
*
|
|
* @param thumbnailName the thumbnail name
|
|
* @param destinationMimetype the destination name
|
|
* @return String the thumbnail file name
|
|
*/
|
|
private String generateThumbnailFileName(String thumbnailName, String destinationMimetype)
|
|
{
|
|
return thumbnailName + "." + this.mimetypeMap.getExtension(destinationMimetype);
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.thumbnail.ThumbnailService#updateThumbnail(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.cmr.repository.TransformationOptions)
|
|
*/
|
|
public void updateThumbnail(NodeRef thumbnail, TransformationOptions transformationOptions)
|
|
{
|
|
// First check that we are dealing with a thumbnail
|
|
if (ContentModel.TYPE_THUMBNAIL.equals(this.nodeService.getType(thumbnail)) == true)
|
|
{
|
|
// Get the node that is the source of the thumbnail
|
|
NodeRef node = null;
|
|
List<ChildAssociationRef> parents = this.nodeService.getParentAssocs(thumbnail, ContentModel.ASSOC_THUMBNAILS, RegexQNamePattern.MATCH_ALL);
|
|
if (parents.size() == 0)
|
|
{
|
|
throw new ThumbnailException(ERR_NO_PARENT);
|
|
}
|
|
// TODO
|
|
// When a node with thumbnails is checked in the assoc's get doubled up. This means we get more than one parent.
|
|
// As a work around simply take the first parent retrieved
|
|
//
|
|
//else if (parents.size() != 1)
|
|
//{
|
|
// throw new ThumbnailException(ERR_TOO_PARENT);
|
|
//}
|
|
else
|
|
{
|
|
node = parents.get(0).getParentRef();
|
|
}
|
|
|
|
// Get the content property
|
|
QName contentProperty = (QName)this.nodeService.getProperty(thumbnail, ContentModel.PROP_CONTENT_PROPERTY_NAME);
|
|
|
|
// Get the reader and writer
|
|
ContentReader reader = this.contentService.getReader(node, contentProperty);
|
|
ContentWriter writer = this.contentService.getWriter(thumbnail, ContentModel.PROP_CONTENT, true);
|
|
|
|
// Set the basic detail of the transformation options
|
|
transformationOptions.setSourceNodeRef(node);
|
|
transformationOptions.setSourceContentProperty(contentProperty);
|
|
transformationOptions.setTargetNodeRef(thumbnail);
|
|
transformationOptions.setTargetContentProperty(ContentModel.PROP_CONTENT);
|
|
|
|
// Catch the failure to create the thumbnail
|
|
if (this.contentService.isTransformable(reader, writer, transformationOptions) == false)
|
|
{
|
|
// Throw exception indicating that the thumbnail could not be created
|
|
throw new ThumbnailException(ERR_NO_CREATE);
|
|
}
|
|
else
|
|
{
|
|
// Do the thumnail transformation
|
|
this.contentService.transform(reader, writer, transformationOptions);
|
|
}
|
|
}
|
|
// TODO else should we throw an exception?
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.thumbnail.ThumbnailService#getThumbnailByName(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.lang.String)
|
|
*/
|
|
public NodeRef getThumbnailByName(NodeRef node, QName contentProperty, String thumbnailName)
|
|
{
|
|
NodeRef thumbnail = null;
|
|
|
|
//
|
|
// NOTE:
|
|
//
|
|
// Since there is not an easy alternative and for clarity the node service is being used to retrieve the thumbnails.
|
|
// If retrieval performance becomes an issue then this code can be replaced
|
|
//
|
|
|
|
// Check that the node has the thumbnailed aspect applied
|
|
if (nodeService.hasAspect(node, ContentModel.ASPECT_THUMBNAILED) == true)
|
|
{
|
|
// Get all the thumnails that match the thumbnail name
|
|
List<ChildAssociationRef> assocs = this.nodeService.getChildAssocs(node, ContentModel.ASSOC_THUMBNAILS, QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, thumbnailName));
|
|
for (ChildAssociationRef assoc : assocs)
|
|
{
|
|
// Check the child to see if it matches the content property we are concerned about.
|
|
// We can assume there will only ever be one per content property since createThumbnail enforces this.
|
|
NodeRef child = assoc.getChildRef();
|
|
if (contentProperty.equals(this.nodeService.getProperty(child, ContentModel.PROP_CONTENT_PROPERTY_NAME)) == true)
|
|
{
|
|
thumbnail = child;
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
return thumbnail;
|
|
}
|
|
|
|
/**
|
|
* @see org.alfresco.service.cmr.thumbnail.ThumbnailService#getThumbnails(org.alfresco.service.cmr.repository.NodeRef, org.alfresco.service.namespace.QName, java.lang.String, org.alfresco.service.cmr.repository.TransformationOptions)
|
|
*/
|
|
public List<NodeRef> getThumbnails(NodeRef node, QName contentProperty, String mimetype, TransformationOptions options)
|
|
{
|
|
List<NodeRef> thumbnails = new ArrayList<NodeRef>(5);
|
|
|
|
//
|
|
// NOTE:
|
|
//
|
|
// Since there is not an easy alternative and for clarity the node service is being used to retrieve the thumbnails.
|
|
// If retrieval performance becomes an issue then this code can be replaced
|
|
//
|
|
|
|
// Check that the node has the thumbnailed aspect applied
|
|
if (nodeService.hasAspect(node, ContentModel.ASPECT_THUMBNAILED) == true)
|
|
{
|
|
// Get all the thumnails that match the thumbnail name
|
|
List<ChildAssociationRef> assocs = this.nodeService.getChildAssocs(node, ContentModel.ASSOC_THUMBNAILS, RegexQNamePattern.MATCH_ALL);
|
|
for (ChildAssociationRef assoc : assocs)
|
|
{
|
|
// Check the child to see if it matches the content property we are concerned about.
|
|
// We can assume there will only ever be one per content property since createThumbnail enforces this.
|
|
NodeRef child = assoc.getChildRef();
|
|
if (contentProperty.equals(this.nodeService.getProperty(child, ContentModel.PROP_CONTENT_PROPERTY_NAME)) == true &&
|
|
matchMimetypeOptions(child, mimetype, options) == true)
|
|
{
|
|
thumbnails.add(child);
|
|
}
|
|
}
|
|
}
|
|
|
|
return thumbnails;
|
|
}
|
|
|
|
/**
|
|
* Determine whether the thumbnail meta-data matches the given mimetype and options
|
|
*
|
|
* If mimetype and transformation options are null then match is guarenteed
|
|
*
|
|
* @param thumbnail thumbnail node reference
|
|
* @param mimetype mimetype
|
|
* @param options transformation options
|
|
* @return boolean true if the mimetype and options match the thumbnail metadata, false otherwise
|
|
*/
|
|
private boolean matchMimetypeOptions(NodeRef thumbnail, String mimetype, TransformationOptions options)
|
|
{
|
|
boolean result = true;
|
|
|
|
if (mimetype != null)
|
|
{
|
|
// Check the mimetype
|
|
String thumbnailMimetype = ((ContentData)this.nodeService.getProperty(thumbnail, ContentModel.PROP_CONTENT)).getMimetype();
|
|
if (mimetype.equals(thumbnailMimetype) == false)
|
|
{
|
|
result = false;
|
|
}
|
|
}
|
|
|
|
if (result != false && options != null)
|
|
{
|
|
// TODO .. check for matching options here ...
|
|
}
|
|
|
|
return result;
|
|
}
|
|
}
|