mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-10-29 15:21:53 +00:00
7dd2291753
107541: Merged 5.0.N (5.0.3) to HEAD-BUG-FIX (5.1/Cloud) (PARTIAL MERGE)
107413: Merged DEV to 5.0.N (5.0.3)
106858 : MNT-13545: JavaDoc : Inconsistencies between the Java doc and the actual code
- Cleaning of Javadoc,
107565: MNT-13545 Fix compilation after merge of Javadoc
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@107633 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
544 lines
22 KiB
Java
544 lines
22 KiB
Java
/*
|
|
* Copyright (C) 2005-2013 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.thumbnail;
|
|
|
|
import java.util.ArrayList;
|
|
import java.util.HashMap;
|
|
import java.util.List;
|
|
import java.util.Map;
|
|
|
|
import org.alfresco.repo.content.transform.ContentTransformer;
|
|
import org.alfresco.repo.content.transform.TransformerDebug;
|
|
import org.alfresco.repo.security.authentication.AuthenticationUtil;
|
|
import org.alfresco.repo.security.authentication.AuthenticationUtil.RunAsWork;
|
|
import org.alfresco.repo.tenant.Tenant;
|
|
import org.alfresco.repo.tenant.TenantAdminService;
|
|
import org.alfresco.repo.transaction.RetryingTransactionHelper;
|
|
import org.alfresco.service.cmr.rendition.RenditionDefinition;
|
|
import org.alfresco.service.cmr.rendition.RenditionService;
|
|
import org.alfresco.service.cmr.repository.ContentService;
|
|
import org.alfresco.service.cmr.repository.NodeRef;
|
|
import org.alfresco.service.cmr.repository.TransformationOptions;
|
|
import org.alfresco.service.cmr.thumbnail.ThumbnailException;
|
|
import org.alfresco.service.transaction.TransactionService;
|
|
import org.apache.commons.logging.Log;
|
|
import org.apache.commons.logging.LogFactory;
|
|
import org.springframework.beans.BeansException;
|
|
import org.springframework.context.ApplicationContext;
|
|
import org.springframework.context.ApplicationContextAware;
|
|
import org.springframework.context.ApplicationEvent;
|
|
import org.springframework.context.ApplicationListener;
|
|
import org.springframework.context.event.ApplicationContextEvent;
|
|
import org.springframework.extensions.surf.util.AbstractLifecycleBean;
|
|
|
|
/**
|
|
* Registry of all the thumbnail details available
|
|
*
|
|
* @author Roy Wetherall
|
|
* @author Neil McErlean
|
|
*/
|
|
public class ThumbnailRegistry implements ApplicationContextAware, ApplicationListener<ApplicationContextEvent>
|
|
{
|
|
/** Logger */
|
|
private static Log logger = LogFactory.getLog(ThumbnailRegistry.class);
|
|
|
|
/** Content service */
|
|
private ContentService contentService;
|
|
|
|
/** Transaction service */
|
|
protected TransactionService transactionService;
|
|
|
|
/** Rendition service */
|
|
protected RenditionService renditionService;
|
|
|
|
protected TenantAdminService tenantAdminService;
|
|
|
|
private boolean redeployStaticDefsOnStartup;
|
|
|
|
/** Map of thumbnail definition */
|
|
private Map<String, ThumbnailDefinition> thumbnailDefinitions = new HashMap<String, ThumbnailDefinition>();
|
|
|
|
/** Cache to store mimetype to thumbnailDefinition mapping with max size limit */
|
|
private Map<String, List<ThumbnailDefinitionLimits>> mimetypeMap = new HashMap<String, List<ThumbnailDefinitionLimits>>(17);
|
|
|
|
private ThumbnailRenditionConvertor thumbnailRenditionConvertor;
|
|
|
|
private RegistryLifecycle lifecycle = new RegistryLifecycle();
|
|
|
|
public void setThumbnailRenditionConvertor(
|
|
ThumbnailRenditionConvertor thumbnailRenditionConvertor)
|
|
{
|
|
this.thumbnailRenditionConvertor = thumbnailRenditionConvertor;
|
|
}
|
|
|
|
public ThumbnailRenditionConvertor getThumbnailRenditionConvertor()
|
|
{
|
|
return thumbnailRenditionConvertor;
|
|
}
|
|
|
|
/**
|
|
* Content service
|
|
*
|
|
* @param contentService content service
|
|
*/
|
|
public void setContentService(ContentService contentService)
|
|
{
|
|
this.contentService = contentService;
|
|
}
|
|
|
|
/**
|
|
* Transaction service
|
|
*
|
|
* @param transactionService transaction service
|
|
*/
|
|
public void setTransactionService(TransactionService transactionService)
|
|
{
|
|
this.transactionService = transactionService;
|
|
}
|
|
|
|
/**
|
|
* Rendition service
|
|
*
|
|
* @param renditionService rendition service
|
|
*/
|
|
public void setRenditionService(RenditionService renditionService)
|
|
{
|
|
this.renditionService = renditionService;
|
|
}
|
|
|
|
public void setTenantAdminService(TenantAdminService tenantAdminService)
|
|
{
|
|
this.tenantAdminService = tenantAdminService;
|
|
}
|
|
|
|
public void setRedeployStaticDefsOnStartup(boolean redeployStaticDefsOnStartup)
|
|
{
|
|
this.redeployStaticDefsOnStartup = redeployStaticDefsOnStartup;
|
|
}
|
|
|
|
/**
|
|
* This method is used to inject the thumbnail definitions.
|
|
* @param thumbnailDefinitions List<ThumbnailDefinition>
|
|
*/
|
|
public void setThumbnailDefinitions(final List<ThumbnailDefinition> thumbnailDefinitions)
|
|
{
|
|
for (ThumbnailDefinition td : thumbnailDefinitions)
|
|
{
|
|
String thumbnailName = td.getName();
|
|
if (thumbnailName == null)
|
|
{
|
|
throw new ThumbnailException("When adding a thumbnail details object make sure the name is set.");
|
|
}
|
|
td.getTransformationOptions().setUse(thumbnailName);
|
|
this.thumbnailDefinitions.put(thumbnailName, td);
|
|
}
|
|
}
|
|
|
|
// Otherwise we should go ahead and persist the thumbnail definitions.
|
|
// This is done during system startup. It needs to be done as the system user (see callers) to ensure the thumbnail definitions get saved
|
|
// and also needs to be done within a transaction in order to support concurrent startup. See ALF-6271 for details.
|
|
public void initThumbnailDefinitions()
|
|
{
|
|
RetryingTransactionHelper transactionHelper = transactionService.getRetryingTransactionHelper();
|
|
transactionHelper.doInTransaction(new RetryingTransactionHelper.RetryingTransactionCallback<Void>()
|
|
{
|
|
@Override
|
|
public Void execute() throws Throwable
|
|
{
|
|
for (String thumbnailDefName : thumbnailDefinitions.keySet())
|
|
{
|
|
final ThumbnailDefinition thumbnailDefinition = thumbnailDefinitions.get(thumbnailDefName);
|
|
|
|
// Built-in thumbnailDefinitions do not provide any non-standard values
|
|
// for the ThumbnailParentAssociationDetails object. Hence the null
|
|
RenditionDefinition renditionDef = thumbnailRenditionConvertor.convert(thumbnailDefinition, null);
|
|
|
|
// Thumbnail definitions are saved into the repository as actions
|
|
renditionService.saveRenditionDefinition(renditionDef);
|
|
}
|
|
return null;
|
|
}
|
|
});
|
|
}
|
|
|
|
/**
|
|
* Get a list of all the thumbnail definitions
|
|
*
|
|
* @return Collection<ThumbnailDefinition> collection of thumbnail definitions
|
|
*/
|
|
public List<ThumbnailDefinition> getThumbnailDefinitions()
|
|
{
|
|
return new ArrayList<ThumbnailDefinition>(this.thumbnailDefinitions.values());
|
|
}
|
|
|
|
/**
|
|
* @deprecated use overloaded version with sourceSize parameter.
|
|
*/
|
|
public List<ThumbnailDefinition> getThumbnailDefinitions(String mimetype)
|
|
{
|
|
return getThumbnailDefinitions(mimetype, -1);
|
|
}
|
|
|
|
public List<ThumbnailDefinition> getThumbnailDefinitions(String mimetype, long sourceSize)
|
|
{
|
|
List<ThumbnailDefinitionLimits> thumbnailDefinitionsLimitsForMimetype = this.mimetypeMap.get(mimetype);
|
|
|
|
if (thumbnailDefinitionsLimitsForMimetype == null)
|
|
{
|
|
boolean foundAtLeastOneTransformer = false;
|
|
thumbnailDefinitionsLimitsForMimetype = new ArrayList<ThumbnailDefinitionLimits>(7);
|
|
|
|
for (ThumbnailDefinition thumbnailDefinition : this.thumbnailDefinitions.values())
|
|
{
|
|
long maxSourceSizeBytes = getMaxSourceSizeBytes(mimetype, thumbnailDefinition);
|
|
if (maxSourceSizeBytes != 0)
|
|
{
|
|
thumbnailDefinitionsLimitsForMimetype.add(new ThumbnailDefinitionLimits(thumbnailDefinition, maxSourceSizeBytes));
|
|
foundAtLeastOneTransformer = true;
|
|
}
|
|
}
|
|
|
|
// If we have found no transformers for the given MIME type then we do
|
|
// not cache the empty list. We prevent this because we want to allow for
|
|
// transformers only coming online *during* system operation - as opposed
|
|
// to coming online during startup.
|
|
//
|
|
// An example of such a transient transformer would be those that use OpenOffice.org.
|
|
// It is possible that the system might start without OOo-based transformers
|
|
// being available. Therefore we must not cache an empty list for the relevant
|
|
// MIME types - otherwise this class would hide the fact that OOo (soffice) has
|
|
// been launched and that new transformers are available.
|
|
if (foundAtLeastOneTransformer)
|
|
{
|
|
this.mimetypeMap.put(mimetype, thumbnailDefinitionsLimitsForMimetype);
|
|
}
|
|
}
|
|
|
|
// Only return ThumbnailDefinition for this specific source - may be limited on size.
|
|
List<ThumbnailDefinition> result = new ArrayList<ThumbnailDefinition>(thumbnailDefinitionsLimitsForMimetype.size());
|
|
for (ThumbnailDefinitionLimits thumbnailDefinitionLimits: thumbnailDefinitionsLimitsForMimetype)
|
|
{
|
|
long maxSourceSizeBytes = thumbnailDefinitionLimits.getMaxSourceSizeBytes();
|
|
if (sourceSize <= 0 || maxSourceSizeBytes < 0 || maxSourceSizeBytes >= sourceSize)
|
|
{
|
|
result.add(thumbnailDefinitionLimits.getThumbnailDefinition());
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
public List<ThumbnailDefinition> getThumbnailDefinitions(String sourceUrl, String mimetype, long sourceSize)
|
|
{
|
|
List<ThumbnailDefinitionLimits> thumbnailDefinitionsLimitsForMimetype = this.mimetypeMap.get(mimetype);
|
|
|
|
if (thumbnailDefinitionsLimitsForMimetype == null)
|
|
{
|
|
boolean foundAtLeastOneTransformer = false;
|
|
thumbnailDefinitionsLimitsForMimetype = new ArrayList<ThumbnailDefinitionLimits>(7);
|
|
|
|
for (ThumbnailDefinition thumbnailDefinition : this.thumbnailDefinitions.values())
|
|
{
|
|
if (isThumbnailDefinitionAvailable(sourceUrl, mimetype, sourceSize, thumbnailDefinition))
|
|
{
|
|
long maxSourceSizeBytes = getMaxSourceSizeBytes(mimetype, thumbnailDefinition);
|
|
if (maxSourceSizeBytes != 0)
|
|
{
|
|
thumbnailDefinitionsLimitsForMimetype.add(new ThumbnailDefinitionLimits(thumbnailDefinition, maxSourceSizeBytes));
|
|
foundAtLeastOneTransformer = true;
|
|
}
|
|
}
|
|
}
|
|
|
|
// If we have found no transformers for the given MIME type then we do
|
|
// not cache the empty list. We prevent this because we want to allow for
|
|
// transformers only coming online *during* system operation - as opposed
|
|
// to coming online during startup.
|
|
//
|
|
// An example of such a transient transformer would be those that use OpenOffice.org.
|
|
// It is possible that the system might start without OOo-based transformers
|
|
// being available. Therefore we must not cache an empty list for the relevant
|
|
// MIME types - otherwise this class would hide the fact that OOo (soffice) has
|
|
// been launched and that new transformers are available.
|
|
if (foundAtLeastOneTransformer)
|
|
{
|
|
this.mimetypeMap.put(mimetype, thumbnailDefinitionsLimitsForMimetype);
|
|
}
|
|
}
|
|
|
|
// Only return ThumbnailDefinition for this specific source - may be limited on size.
|
|
List<ThumbnailDefinition> result = new ArrayList<ThumbnailDefinition>(thumbnailDefinitionsLimitsForMimetype.size());
|
|
for (ThumbnailDefinitionLimits thumbnailDefinitionLimits: thumbnailDefinitionsLimitsForMimetype)
|
|
{
|
|
long maxSourceSizeBytes = thumbnailDefinitionLimits.getMaxSourceSizeBytes();
|
|
if (sourceSize <= 0 || maxSourceSizeBytes < 0 || maxSourceSizeBytes >= sourceSize)
|
|
{
|
|
result.add(thumbnailDefinitionLimits.getThumbnailDefinition());
|
|
}
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
*
|
|
* @param mimetype String
|
|
* @return List<ThumbnailDefinition>
|
|
* @deprecated Use {@link #getThumbnailDefinitions(String)} instead.
|
|
*/
|
|
@Deprecated
|
|
public List<ThumbnailDefinition> getThumnailDefintions(String mimetype)
|
|
{
|
|
return this.getThumbnailDefinitions(mimetype);
|
|
}
|
|
|
|
/**
|
|
* Checks to see if at this moment in time, the specified {@link ThumbnailDefinition}
|
|
* is able to thumbnail the source mimetype. Typically used with Thumbnail Definitions
|
|
* retrieved by name, and/or when dealing with transient {@link ContentTransformer}s.
|
|
* @param sourceUrl The URL of the source (optional)
|
|
* @param sourceMimetype The source mimetype
|
|
* @param sourceSize the size (in bytes) of the source. Use -1 if unknown.
|
|
* @param sourceNodeRef which is set in a copy of the thumbnailDefinition transformation options,
|
|
* so that it may be used by transformers and debug.
|
|
* @param thumbnailDefinition The {@link ThumbnailDefinition} to check for
|
|
*/
|
|
public boolean isThumbnailDefinitionAvailable(String sourceUrl, String sourceMimetype, long sourceSize, NodeRef sourceNodeRef, ThumbnailDefinition thumbnailDefinition)
|
|
{
|
|
// Copy the thumbnail's TransformationOptions and set the sourceNodeRef, for use by transformers and debug.
|
|
TransformationOptions options = thumbnailDefinition.getTransformationOptions().deepCopy();
|
|
options.setSourceNodeRef(sourceNodeRef);
|
|
|
|
// Log the following getTransform() as trace so we can see the wood for the trees
|
|
boolean orig = TransformerDebug.setDebugOutput(false);
|
|
try
|
|
{
|
|
return this.contentService.getTransformer(
|
|
sourceUrl,
|
|
sourceMimetype,
|
|
sourceSize,
|
|
thumbnailDefinition.getMimetype(), options
|
|
) != null;
|
|
}
|
|
finally
|
|
{
|
|
TransformerDebug.setDebugOutput(orig);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Checks to see if at this moment in time, the specified {@link ThumbnailDefinition}
|
|
* is able to thumbnail the source mimetype. Typically used with Thumbnail Definitions
|
|
* retrieved by name, and/or when dealing with transient {@link ContentTransformer}s.
|
|
* @param sourceUrl The URL of the source (optional)
|
|
* @param sourceMimeType The source mimetype
|
|
* @param sourceSize the size (in bytes) of the source. Use -1 if unknown.
|
|
* @param thumbnailDefinition The {@link ThumbnailDefinition} to check for
|
|
*/
|
|
public boolean isThumbnailDefinitionAvailable(String sourceUrl, String sourceMimeType, long sourceSize, ThumbnailDefinition thumbnailDefinition)
|
|
{
|
|
// Log the following getTransform() as trace so we can see the wood for the trees
|
|
boolean orig = TransformerDebug.setDebugOutput(false);
|
|
try
|
|
{
|
|
return this.contentService.getTransformer(
|
|
sourceUrl,
|
|
sourceMimeType,
|
|
sourceSize,
|
|
thumbnailDefinition.getMimetype(), thumbnailDefinition.getTransformationOptions()
|
|
) != null;
|
|
}
|
|
finally
|
|
{
|
|
TransformerDebug.setDebugOutput(orig);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns the maximum source size of any content that may transformed between the supplied
|
|
* sourceMimetype and thumbnailDefinition's targetMimetype using its transformation options.
|
|
* @param sourceMimetype String
|
|
* @param thumbnailDefinition ThumbnailDefinition
|
|
* @return 0 if there are no transformers, -1 if there is no limit or if positive the size in bytes.
|
|
*/
|
|
public long getMaxSourceSizeBytes(String sourceMimetype, ThumbnailDefinition thumbnailDefinition)
|
|
{
|
|
// Log the following getTransform() as trace so we can see the wood for the trees
|
|
boolean orig = TransformerDebug.setDebugOutput(false);
|
|
try
|
|
{
|
|
return contentService.getMaxSourceSizeBytes(sourceMimetype,
|
|
thumbnailDefinition.getMimetype(), thumbnailDefinition.getTransformationOptions());
|
|
}
|
|
finally
|
|
{
|
|
TransformerDebug.setDebugOutput(orig);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Add a thumbnail details
|
|
*
|
|
* @param thumbnailDetails thumbnail details
|
|
*/
|
|
public void addThumbnailDefinition(ThumbnailDefinition thumbnailDetails)
|
|
{
|
|
String thumbnailName = thumbnailDetails.getName();
|
|
if (thumbnailName == null)
|
|
{
|
|
throw new ThumbnailException("When adding a thumbnail details object make sure the name is set.");
|
|
}
|
|
|
|
this.thumbnailDefinitions.put(thumbnailName, thumbnailDetails);
|
|
}
|
|
|
|
/**
|
|
* Get the definition of a named thumbnail
|
|
*
|
|
* @param thumbnailName the thumbnail name
|
|
* @return ThumbnailDetails the details of the thumbnail
|
|
*/
|
|
public ThumbnailDefinition getThumbnailDefinition(String thumbnailName)
|
|
{
|
|
return this.thumbnailDefinitions.get(thumbnailName);
|
|
}
|
|
|
|
/* (non-Javadoc)
|
|
* @see org.springframework.context.ApplicationContextAware#setApplicationContext(org.springframework.context.ApplicationContext)
|
|
*/
|
|
public void setApplicationContext(ApplicationContext applicationContext) throws BeansException
|
|
{
|
|
lifecycle.setApplicationContext(applicationContext);
|
|
}
|
|
|
|
/* (non-Javadoc)
|
|
* @see org.springframework.context.ApplicationListener#onApplicationEvent(org.springframework.context.ApplicationEvent)
|
|
*/
|
|
public void onApplicationEvent(ApplicationContextEvent event)
|
|
{
|
|
lifecycle.onApplicationEvent(event);
|
|
}
|
|
|
|
protected boolean redeploy()
|
|
{
|
|
return AuthenticationUtil.runAs(new RunAsWork<Boolean>()
|
|
{
|
|
public Boolean doWork() throws Exception
|
|
{
|
|
return ((getThumbnailDefinitions().size() > 0) && (redeployStaticDefsOnStartup || renditionService.loadRenditionDefinitions().size() == 0));
|
|
}
|
|
}, AuthenticationUtil.getSystemUserName());
|
|
}
|
|
|
|
/**
|
|
* This class hooks in to the spring application lifecycle and ensures that any
|
|
* ThumbnailDefinitions injected by spring are converted to RenditionDefinitions
|
|
* and saved.
|
|
*/
|
|
protected class RegistryLifecycle extends AbstractLifecycleBean
|
|
{
|
|
/* (non-Javadoc)
|
|
* @see org.alfresco.util.AbstractLifecycleBean#onBootstrap(org.springframework.context.ApplicationEvent)
|
|
*/
|
|
@Override
|
|
protected void onBootstrap(ApplicationEvent event)
|
|
{
|
|
if (redeploy())
|
|
{
|
|
long start = System.currentTimeMillis();
|
|
|
|
// If the database is in read-only mode, then do not persist the thumbnail definitions.
|
|
if (transactionService.isReadOnly())
|
|
{
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("TransactionService is in read-only mode. Therefore no thumbnail definitions have been initialised.");
|
|
}
|
|
return;
|
|
}
|
|
|
|
AuthenticationUtil.runAs(new RunAsWork<Object>()
|
|
{
|
|
public Object doWork() throws Exception
|
|
{
|
|
initThumbnailDefinitions();
|
|
return null;
|
|
}
|
|
}, AuthenticationUtil.getSystemUserName());
|
|
|
|
if (tenantAdminService.isEnabled())
|
|
{
|
|
List<Tenant> tenants = tenantAdminService.getAllTenants();
|
|
for (Tenant tenant : tenants)
|
|
{
|
|
AuthenticationUtil.runAs(new RunAsWork<Object>()
|
|
{
|
|
public Object doWork() throws Exception
|
|
{
|
|
initThumbnailDefinitions();
|
|
return null;
|
|
}
|
|
}, tenantAdminService.getDomainUser(AuthenticationUtil.getSystemUserName(), tenant.getTenantDomain()));
|
|
}
|
|
}
|
|
|
|
if (logger.isInfoEnabled())
|
|
{
|
|
logger.info("Init'ed thumbnail defs in "+(System.currentTimeMillis()-start)+" ms");
|
|
}
|
|
}
|
|
}
|
|
|
|
/* (non-Javadoc)
|
|
* @see org.alfresco.util.AbstractLifecycleBean#onShutdown(org.springframework.context.ApplicationEvent)
|
|
*/
|
|
@Override
|
|
protected void onShutdown(ApplicationEvent event)
|
|
{
|
|
// Intentionally empty
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Links transformer limits (such as maximum size) to a ThumbnailDefinition.
|
|
*
|
|
*/
|
|
private class ThumbnailDefinitionLimits
|
|
{
|
|
private ThumbnailDefinition thumbnailDefinition;
|
|
private long maxSourceSizeBytes;
|
|
|
|
public ThumbnailDefinitionLimits(ThumbnailDefinition thumbnailDefinition, long maxSourceSizeBytes)
|
|
{
|
|
this.thumbnailDefinition = thumbnailDefinition;
|
|
this.maxSourceSizeBytes = maxSourceSizeBytes;
|
|
}
|
|
|
|
public ThumbnailDefinition getThumbnailDefinition()
|
|
{
|
|
return thumbnailDefinition;
|
|
}
|
|
|
|
public long getMaxSourceSizeBytes()
|
|
{
|
|
return maxSourceSizeBytes;
|
|
}
|
|
}
|
|
}
|