inteligr8/alfresco-community-repo
1
0
Fork 0
mirror of https://github.com/Alfresco/alfresco-community-repo.git synced 2025-07-24 17:32:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

Thumbnail Service: support for asyn creation of thumbnails (unit test's included)

Browse Source 
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@9428 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Roy Wetherall
2008-06-09 10:10:16 +00:00
parent 997b5c0ab5
commit 5e60154bf5
7 changed files with 259 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

13
config/alfresco/thumbnail-service-context.xml
View File

@@ -82,4 +82,17 @@
</property>
</bean>
<!-- Create Thumbnail Action -->
<bean id="create-thumbnail" class="org.alfresco.repo.thumbnail.CreateThumbnailActionExecuter" parent="action-executer">
<property name="publicAction">
<value>false</value>
</property>
<property name="nodeService">
<ref bean="NodeService" />
</property>
<property name="thumbnailService">
<ref bean="ThumbnailService" />
</property>
</bean>
</beans>

45
source/java/org/alfresco/repo/jscript/ScriptNode.java
View File

@@ -40,11 +40,14 @@ import org.alfresco.model.ContentModel;
import org.alfresco.repo.action.executer.TransformActionExecuter;
import org.alfresco.repo.content.transform.magick.ImageTransformationOptions;
import org.alfresco.repo.search.QueryParameterDefImpl;
import org.alfresco.repo.thumbnail.CreateThumbnailActionExecuter;
import org.alfresco.repo.thumbnail.ThumbnailDetails;
import org.alfresco.repo.thumbnail.ThumbnailRegistry;
import org.alfresco.repo.thumbnail.script.ScriptThumbnail;
import org.alfresco.repo.version.VersionModel;
import org.alfresco.scripts.ScriptException;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.lock.LockStatus;
@@ -1905,14 +1908,38 @@ public class ScriptNode implements Serializable, Scopeable
*/
public ScriptThumbnail createThumbnail(String thumbnailName)
{
return createThumbnail(thumbnailName, false);
}
/**
* Creates a thumbnail for the content property of the node.
*
* The thumbnail name correspionds to pre-set thumbnail details stored in the
* repository.
*
* If the thumbnail is created asynchronously then the result will be null and creation
* of the thumbnail will occure at some point in the background.
*
* @param thumbnailName the name of the thumbnail
* @param async indicates whether the thumbnail is create asynchronously or not
* @return ScriptThumbnail the newly create thumbnail node or null if async creation occures
*/
public ScriptThumbnail createThumbnail(String thumbnailName, boolean async)
{
ScriptThumbnail result = null;
// Use the thumbnail registy to get the details of the thumbail
ThumbnailRegistry registry = this.services.getThumbnailService().getThumbnailRegistry();
ThumbnailDetails details = registry.getThumbnailDetails(thumbnailName);
if (details == null)
{
// Throw exception
throw new ScriptException("The thumbnail name '" + thumbnailName + "' is not registered");
}
if (async == false)
{
// Create the thumbnail
NodeRef thumbnailNodeRef = this.services.getThumbnailService().createThumbnail(
this.nodeRef,
ContentModel.PROP_CONTENT,
@@ -1920,8 +1947,18 @@ public class ScriptNode implements Serializable, Scopeable
details.getTransformationOptions(),
details.getName());
// Return thumbnail
return new ScriptThumbnail(thumbnailNodeRef, this.services, this.scope);
// Create the thumbnail script object
result = new ScriptThumbnail(thumbnailNodeRef, this.services, this.scope);
}
else
{
// Queue async creation of thumbnail
Action action = this.services.getActionService().createAction(CreateThumbnailActionExecuter.NAME);
action.setParameterValue(CreateThumbnailActionExecuter.PARAM_THUMBANIL_NAME, thumbnailName);
this.services.getActionService().executeAction(action, this.nodeRef, false, true);
}
return result;
}
/**
@@ -1944,6 +1981,10 @@ public class ScriptNode implements Serializable, Scopeable
return result;
}
/**
*
* @return
*/
public ScriptableHashMap<String, ScriptThumbnail> getThumbnails()
{
return null;

123
source/java/org/alfresco/repo/thumbnail/CreateThumbnailActionExecuter.java Normal file
View File

@@ -0,0 +1,123 @@
/*
* 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.util.List;
import org.alfresco.error.AlfrescoRuntimeException;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.action.ParameterDefinitionImpl;
import org.alfresco.repo.action.executer.ActionExecuterAbstractBase;
import org.alfresco.service.cmr.action.Action;
import org.alfresco.service.cmr.action.ParameterDefinition;
import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.cmr.thumbnail.ThumbnailService;
import org.alfresco.service.namespace.QName;
/**
* Create thumbnail action executer.
*
* NOTE: This action is used to facilitate the async creation of thumbnails. It is not intended for genereral useage.
*
* @author Roy Wetherall
*/
public class CreateThumbnailActionExecuter extends ActionExecuterAbstractBase
{
/** Thumbnail Service */
private ThumbnailService thumbnailService;
/** Node Service */
private NodeService nodeService;
/** Action name and parameters */
public static final String NAME = "create-thumbnail";
public static final String PARAM_CONTENT_PROPERTY = "content-property";
public static final String PARAM_THUMBANIL_NAME = "thumbnail-name";
/**
* Set the thumbnail service
*
* @param thumbnailService the thumbnail service
*/
public void setThumbnailService(ThumbnailService thumbnailService)
{
this.thumbnailService = thumbnailService;
}
/**
* Set the node service
*
* @param nodeService node service
*/
public void setNodeService(NodeService nodeService)
{
this.nodeService = nodeService;
}
/**
* @see org.alfresco.repo.action.executer.ActionExecuterAbstractBase#executeImpl(org.alfresco.service.cmr.action.Action, org.alfresco.service.cmr.repository.NodeRef)
*/
@Override
protected void executeImpl(Action action, NodeRef actionedUponNodeRef)
{
if (this.nodeService.exists(actionedUponNodeRef) == true)
{
// Get the thumbnail Name
String thumbnailName = (String)action.getParameterValue(PARAM_THUMBANIL_NAME);
// Get the details of the thumbnail
ThumbnailRegistry registry = this.thumbnailService.getThumbnailRegistry();
ThumbnailDetails details = registry.getThumbnailDetails(thumbnailName);
if (details == null)
{
// Throw exception
throw new AlfrescoRuntimeException("The thumbnail name '" + thumbnailName + "' is not registered");
}
// Get the content property
QName contentProperty = (QName)action.getParameterValue(PARAM_CONTENT_PROPERTY);
if (contentProperty == null)
{
contentProperty = ContentModel.PROP_CONTENT;
}
// Create the thumbnail
this.thumbnailService.createThumbnail(actionedUponNodeRef, contentProperty, details.getMimetype(), details.getTransformationOptions(), thumbnailName, null);
}
}
/**
* @see org.alfresco.repo.action.ParameterizedItemAbstractBase#addParameterDefinitions(java.util.List)
*/
@Override
protected void addParameterDefinitions(List<ParameterDefinition> paramList)
{
paramList.add(new ParameterDefinitionImpl(PARAM_THUMBANIL_NAME, DataTypeDefinition.TEXT, true, getParamDisplayLabel(PARAM_THUMBANIL_NAME)));
paramList.add(new ParameterDefinitionImpl(PARAM_CONTENT_PROPERTY, DataTypeDefinition.QNAME, false, getParamDisplayLabel(PARAM_CONTENT_PROPERTY)));
}
}

25
source/java/org/alfresco/repo/thumbnail/ThumbnailRegistry.java
View File

@@ -77,29 +77,4 @@ public class ThumbnailRegistry
{
return this.thumbnailDetails.get(thumbnailName);
}
// /**
// *
// * @param node
// * @param contentProperty
// * @param thumbnailName
// * @return
// */
// public NodeRef createThumbnail(NodeRef node, QName contentProperty, String thumbnailName)
// {
// // Check to see if we have details of the thumbnail in our list
// ThumbnailDetails details = getThumbnailDetails(thumbnailName);
// if (details == null)
// {
// throw new ThumbnailException("The thumbnail name '" + thumbnailName + "' is not recognised");
// }
//
// // Create the thumbnail
// return this.thumbnailService.createThumbnail(
// node,
// contentProperty,
// details.getMimetype(),
// details.getTransformationOptions(),
// thumbnailName);
// }
}

20
source/java/org/alfresco/repo/thumbnail/ThumbnailServiceImplTest.java
View File

@@ -36,10 +36,13 @@ import org.alfresco.repo.content.MimetypeMap;
import org.alfresco.repo.content.transform.AbstractContentTransformerTest;
import org.alfresco.repo.content.transform.magick.ImageResizeOptions;
import org.alfresco.repo.content.transform.magick.ImageTransformationOptions;
import org.alfresco.repo.jscript.ClasspathScriptLocation;
import org.alfresco.service.cmr.repository.ChildAssociationRef;
import org.alfresco.service.cmr.repository.ContentReader;
import org.alfresco.service.cmr.repository.ContentWriter;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.ScriptLocation;
import org.alfresco.service.cmr.repository.ScriptService;
import org.alfresco.service.cmr.repository.TransformationOptions;
import org.alfresco.service.cmr.thumbnail.ThumbnailException;
import org.alfresco.service.cmr.thumbnail.ThumbnailService;
@@ -56,6 +59,7 @@ import org.alfresco.util.BaseAlfrescoSpringTest;
public class ThumbnailServiceImplTest extends BaseAlfrescoSpringTest
{
private ThumbnailService thumbnailService;
private ScriptService scriptService;
private MimetypeMap mimetypeMap;
private NodeRef folder;
@@ -69,6 +73,7 @@ public class ThumbnailServiceImplTest extends BaseAlfrescoSpringTest
// Get the required services
this.thumbnailService = (ThumbnailService)this.applicationContext.getBean("ThumbnailService");
this.mimetypeMap = (MimetypeMap)this.applicationContext.getBean("mimetypeService");
this.scriptService = (ScriptService)this.applicationContext.getBean("ScriptService");
// Create a folder and some content
Map<QName, Serializable> folderProps = new HashMap<QName, Serializable>(1);
@@ -341,4 +346,19 @@ public class ThumbnailServiceImplTest extends BaseAlfrescoSpringTest
return node;
}
// == Test the JavaScript API ==
public void testJSAPI() throws Exception
{
NodeRef jpgOrig = createOrigionalContent(this.folder, MimetypeMap.MIMETYPE_IMAGE_JPEG);
NodeRef gifOrig = createOrigionalContent(this.folder, MimetypeMap.MIMETYPE_IMAGE_GIF);
Map<String, Object> model = new HashMap<String, Object>(2);
model.put("jpgOrig", jpgOrig);
model.put("gifOrig", gifOrig);
ScriptLocation location = new ClasspathScriptLocation("org/alfresco/repo/thumbnail/script/test_thumbnailAPI.js");
this.scriptService.executeScript(location, model);
}
}

31
source/java/org/alfresco/repo/thumbnail/script/test_thumbnailAPI.js Normal file
View File

@@ -0,0 +1,31 @@
function testCreateThumbnail()
{
// Create a thumbnail
var thumbnail = jpgOrig.createThumbnail("medium");
test.assertNotNull(thumbnail);
// Create async thumbnail
// var thumbnail2 = gifOrig.createThumbnail("medium", true);
// test.assertNull(thumbnail2);
// Try and get the created thumbnail
// var count = 0;
// while (true)
// {
// thumbnail2 = gifOrig.getThumbnail("medium");
// if (thumbnail2 != null)
// {
// break;
// }
//else if (count > 1000)
//{
// test.fail("Async thumbanil wasn't created");
//}
// count++;
// }
}
// Execute the tests
testCreateThumbnail();

22
source/java/org/alfresco/service/cmr/thumbnail/ThumbnailService.java
View File

@@ -28,6 +28,7 @@ import java.util.List;
import org.alfresco.repo.thumbnail.ThumbnailRegistry;
import org.alfresco.service.Auditable;
import org.alfresco.service.NotAuditable;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.TransformationOptions;
import org.alfresco.service.namespace.QName;
@@ -39,6 +40,12 @@ import org.alfresco.service.namespace.QName;
*/
public interface ThumbnailService
{
/**
* Gets the thumbnail registry
*
* @return {@link ThumbnailRegistry} thumbnail registry
*/
@NotAuditable
ThumbnailRegistry getThumbnailRegistry();
/**
@@ -68,6 +75,21 @@ public interface ThumbnailService
@Auditable(key = Auditable.Key.ARG_0, parameters = {"node", "contentProperty", "mimetype", "transformationOptions", "name"})
NodeRef createThumbnail(NodeRef node, QName contentProperty, String mimetype, TransformationOptions transformationOptions, String name);
/**
* @see ThumbnailService#createThumbnail(NodeRef, QName, String, TransformationOptions, String)
*
* If parent association details are specified then the thumbnail is created as a child of the specified parent and linked
* via a non-primary association to the origional content node.
*
* @param node the source content node
* @param contentProperty the content property
* @param mimetype the thumbnail mimetype
* @param transformationOptions the thumbnail transformation options
* @param name the name of the thumbnail (optional, pass null for unnamed thumbnail)
* @param assocDetails the thumbnail parent association details
* @return NodeRef node reference to the newly created thumbnail
*/
@Auditable(key = Auditable.Key.ARG_0, parameters = {"node", "contentProperty", "mimetype", "transformationOptions", "name", "assocDetails"})
NodeRef createThumbnail(NodeRef node, QName contentProperty, String mimetype, TransformationOptions transformationOptions, String name, ThumbnailParentAssociationDetails assocDetails);
/**