/*
* 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 .
*/
package org.alfresco.repo.rendition.executer;
import java.io.Serializable;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;
import org.alfresco.model.ContentModel;
import org.alfresco.repo.action.ParameterDefinitionImpl;
import org.alfresco.repo.rendition.RenditionLocation;
import org.alfresco.service.cmr.action.ParameterDefinition;
import org.alfresco.service.cmr.dictionary.DataTypeDefinition;
import org.alfresco.service.cmr.dictionary.DictionaryService;
import org.alfresco.service.cmr.rendition.RenditionServiceException;
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.namespace.QName;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
/**
* This class provides a way to turn documents supported by the
* {@link ContentService} standard transformers into basic, clean
* HTML.
*
* The HTML that is produced probably isn't going to be suitable
* for direct web publishing, as it's likely going to be too
* basic. Instead, it should be simple and clean HTML, suitable
* for being the basis of some web-friendly HTML once edited
* / further transformed.
*
* @author Nick Burch
* @since 3.4
*/
public class HTMLRenderingEngine extends AbstractRenderingEngine
{
private static Log logger = LogFactory.getLog(HTMLRenderingEngine.class);
/*
* Action constants
*/
public static final String NAME = "htmlRenderingEngine";
protected static final QName PRIMARY_IMAGE = QName.createQName(
"http://www.alfresco.org/model/website/1.0", "primaryImage");
protected static final QName SECONDARY_IMAGE = QName.createQName(
"http://www.alfresco.org/model/website/1.0", "secondaryImage");
private DictionaryService dictionaryService;
public void setDictionaryService(DictionaryService dictionaryService) {
this.dictionaryService = dictionaryService;
}
/*
* (non-Javadoc)
* @see org.alfresco.repo.rendition.executer.AbstractRenderingEngine#render(org.alfresco.repo.rendition.executer.AbstractRenderingEngine.RenderingContext)
*/
@Override
protected void render(RenderingContext context)
{
ContentReader contentReader = context.makeContentReader();
String sourceMimeType = contentReader.getMimetype();
String targetMimeType = "text/html";
// Check that Tika supports it
// TODO
// Make the HTML Version
ContentWriter contentWriter = context.makeContentWriter();
// TODO
contentWriter.putContent(
"\n" +
"Test!
"
);
// Extract out any images
// TODO
boolean hasImages = true; // TODO
if(hasImages)
{
Map properties = new HashMap();
NodeRef imgFolder = null;
// Extract into it
boolean donePrimary = false;
for(String fakeContent : new String[] {"Test1","Test2"})
{
if(imgFolder == null)
imgFolder = createImagesDirectory(context);
// Create the node
properties.clear();
properties.put(ContentModel.PROP_NAME, fakeContent);
NodeRef img = nodeService.createNode(
imgFolder,
ContentModel.ASSOC_CONTAINS,
QName.createQName(fakeContent),
ContentModel.TYPE_CONTENT,
properties
).getChildRef();
// If we can, associate it with the rendered HTML, so
// that they're properly linked
QName assocType = SECONDARY_IMAGE;
if(!donePrimary)
{
assocType = PRIMARY_IMAGE;
donePrimary = true;
}
if(dictionaryService.getAssociation(assocType) != null)
{
nodeService.createAssociation(
context.getDestinationNode(), img, assocType
);
}
// Put the image into the node
ContentWriter writer = contentService.getWriter(
img, ContentModel.PROP_CONTENT, true
);
writer.putContent(fakeContent);
}
}
}
/**
* Creates a directory to store the images in.
* The directory will be a sibling of the rendered
* HTML, and named similar to it.
*/
private NodeRef createImagesDirectory(RenderingContext context)
{
// It should be a sibling of the HTML in it's eventual location
// (not it's current temporary one!)
RenditionLocation location = resolveRenditionLocation(
context.getSourceNode(), context.getDefinition(), context.getDestinationNode()
);
NodeRef parent = location.getParentRef();
// Figure out what to call it, based on the HTML node
String folderName = nodeService.getProperty(
context.getSourceNode(),
ContentModel.PROP_NAME
).toString();
if(folderName.lastIndexOf('.') > -1)
{
folderName = folderName.substring(0, folderName.lastIndexOf('.'));
}
folderName = folderName + "_files";
// Create the directory
Map properties = new HashMap();
properties.put(ContentModel.PROP_NAME, folderName);
NodeRef imgFolder = nodeService.createNode(
parent,
ContentModel.ASSOC_CONTAINS,
QName.createQName(folderName),
ContentModel.TYPE_FOLDER,
properties
).getChildRef();
return imgFolder;
}
}