converting aem page to pdf

[bk028]

Hi, 

we have a requirement to convert aem page which is assembled using content fragments to PDF.

I have followed this approach but it isnt working.

http://experience-aem.blogspot.com/2019/06/aem-65-workflow-step-to-generate-pdf-of-sites-page-during...

[Nitin_laad]

@bk028 Can you share more information on your query, such as exception/error stack trace, AEM version etc. 

[bk028]

Hi nitinjl,

I am running on 6.5 instance with SP 11.

For this below code I am getting error like "org.apache.commons.exec.ExecuteException: Process exited with an error: 1 (Exit value: 1)" for this code " exec.execute(commandLine);"

I have followed same steps which are mentioned in the link provided in prev post.

import com.adobe.granite.workflow.PayloadMap;
import com.day.cq.commons.jcr.JcrUtil;
import com.day.cq.dam.api.Asset;
import com.day.cq.dam.api.AssetManager;
import com.day.cq.dam.commons.util.DamUtil;
import com.day.cq.replication.Agent;
import com.day.cq.replication.AgentManager;
import com.day.cq.wcm.api.Page;
import com.day.cq.wcm.api.PageManager;
import com.day.cq.workflow.exec.WorkflowData;
import com.day.cq.workflow.metadata.MetaDataMap;
import org.apache.commons.exec.*;
import org.apache.commons.io.FileUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.apache.sling.api.resource.*;
import com.day.cq.workflow.WorkflowException;
import com.day.cq.workflow.WorkflowSession;
import com.day.cq.workflow.exec.WorkItem;
import com.day.cq.workflow.exec.WorkflowProcess;
import org.apache.sling.jcr.resource.api.JcrResourceConstants;
import org.osgi.service.component.annotations.Component;
import org.osgi.service.component.annotations.Reference;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.jcr.Node;
import javax.jcr.Session;
import java.io.File;
import java.io.FileInputStream;
import java.text.SimpleDateFormat;
import java.util.*;

@component(
immediate = true,
service = {WorkflowProcess.class},
property = {
"process.label = Pdf service 1801"
}
)
public class PdfService implements WorkflowProcess {
protected final Logger log = LoggerFactory.getLogger(this.getClass());

private static String ARG_COMMAND = "COMMAND";
private static Integer CMD_TIME_OUT = 300000; // 5 minutes
private static SimpleDateFormat PDF_DATE_FORMAT = new SimpleDateFormat("yyyy-MM-dd-HH-mm-ss");
private static String AGENT_PUBLISH = "publish";
private static String DAM_FOLDER_PREFIX = "/content/dam";
private static int RETRIES = 20;
private static int SLEEP_TIME = 5000; // wait 5 secs

@reference
private ResourceResolverFactory resolverFactory;

@reference
private AgentManager agentMgr = null;

@Override
public void execute(WorkItem workItem, WorkflowSession wfSession, MetaDataMap args) throws WorkflowException {
File tmpDir = null;

try {
Session session = wfSession.getSession();
WorkflowData wfData = workItem.getWorkflowData();

String pagePath = null;
String payLoadType = wfData.getPayloadType();

if(payLoadType.equals("JCR_PATH") && wfData.getPayload() != null) {
if(session.itemExists((String)wfData.getPayload())) {
pagePath = (String)wfData.getPayload();
}
} else if( (wfData.getPayload() != null) && payLoadType.equals("JCR_UUID")) {
Node metaDataMap = session.getNodeByUUID((String)wfData.getPayload());
pagePath = metaDataMap.getPath();
}

if(StringUtils.isEmpty(pagePath)){
log.warn("Page path - " + wfData.getPayload() + ", does not exist");
return;
}

ResourceResolver resolver = getResourceResolver(session);
Resource pageResource = resolver.getResource(pagePath);

tmpDir = File.createTempFile("eaem", null);
tmpDir.delete();
tmpDir.mkdir();

File tmpFile = new File(tmpDir, pageResource.getName() + "-" + PDF_DATE_FORMAT.format(new Date()) + ".pdf");
CommandLine commandLine = getCommandLine(pagePath, args, tmpFile);
int count = RETRIES;

do{
Thread.sleep(SLEEP_TIME);

/* if( !wasPageReplicatedRecently(pageResource) ){
log.debug("Page - " + pageResource.getPath() + ", not replicated, skipping PDF generation");
continue;
}*/

executeCommand(commandLine);

createAssetInDAM(pagePath, tmpFile, resolver);

session.save();

break;
}while(count-- > 0);
} catch (Exception e) {
log.error("Failed to create PDF of page", e);
}finally{
if(tmpDir != null){
try { FileUtils.deleteDirectory(tmpDir); } catch(Exception ignore){}
}
}
}

private boolean wasPageReplicatedRecently(Resource pageResource){
ValueMap valueMap = pageResource.getChild("jcr:content").getValueMap();
Date lastReplicated = valueMap.get("cq:lastReplicated", Date.class);

if(lastReplicated == null){
return false;
}

Calendar cal = Calendar.getInstance();
cal.setTime(new Date());
cal.add(Calendar.HOUR, -1);

Date oneHourBack = cal.getTime();

//check if the page was replicated in last 60 minutes
return lastReplicated.getTime() > oneHourBack.getTime();
}

private void createAssetInDAM(String pagePath, File tmpFile, ResourceResolver resolver)throws Exception{
String rootPath = DAM_FOLDER_PREFIX + pagePath;
String assetPath = rootPath + "/" + tmpFile.getName();

JcrUtil.createPath(DAM_FOLDER_PREFIX + pagePath, "sling:Folder", "sling:Folder",
resolver.adaptTo(Session.class), true);

AssetManager assetManager = resolver.adaptTo(AssetManager.class);

FileInputStream fileIn = new FileInputStream(tmpFile);

Asset asset = assetManager.createAsset(assetPath, fileIn, "application/pdf", false);

log.info("Created asset - " + asset.getPath() + ", for published page - " + pagePath);

IOUtils.closeQuietly(fileIn);
}

private CommandLine getCommandLine(String pagePath, MetaDataMap args, File tmpFile) throws Exception{
String processArgs = args.get("PROCESS_ARGS", String.class);

if(StringUtils.isEmpty(processArgs)){
throw new RuntimeException("No command available in process args");
}

String[] arguments = processArgs.split(",");
String command = null;

for(String argument : arguments){
String[] params = argument.split("=");

if(params[0].trim().equals(ARG_COMMAND)){
command = params[1].trim();
break;
}
}

if(StringUtils.isEmpty(command)){
throw new RuntimeException("No command available in process args");
}

HashMap<String, String> parameters = new HashMap<String, String>();
parameters.put("publishPagePath", pagePath);
parameters.put("timeStampedPDFInAssets", tmpFile.getAbsolutePath());

return CommandLine.parse(command, parameters);
}

private String getPublishPath(String pagePath){
Agent publishAgent = agentMgr.getAgents().get(AGENT_PUBLISH);

String transportURI = publishAgent.getConfiguration().getTransportURI();

String hostName = transportURI.substring(0, transportURI.indexOf("/bin/receive"));

return ( hostName + pagePath + ".html");
}

private void executeCommand(CommandLine commandLine) throws Exception{
DefaultExecutor exec = new DefaultExecutor();
ExecuteWatchdog watchDog = new ExecuteWatchdog(CMD_TIME_OUT);

exec.setWatchdog(watchDog);
exec.setStreamHandler(new PumpStreamHandler(System.out, System.err));
exec.setProcessDestroyer(new ShutdownHookProcessDestroyer());

int exitValue = exec.execute(commandLine);

if(exec.isFailure(exitValue)){
throw new RuntimeException("Error creating PDF, command returned - " + exitValue);
}
}

private ResourceResolver getResourceResolver(final Session session) throws LoginException {
return resolverFactory.getResourceResolver( Collections.<String, Object>
singletonMap(JcrResourceConstants.AUTHENTICATION_INFO_SESSION, session));
}
}

[Nitin_laad]

@bk028 Questions-

1. are you able to generate pdf file from html using the command prompt?

ex:

wkhtmltopdf http://google.com google.pdf

2. are you getting all required parameters in process args?

[bk028]

I am actually unable to run this, its getting closed immediately.

and for the 2nd question yes required details are passed into process args.

[Nitin_laad]

Try to execute the same from command prompt, 

ref:

wkhtmltopdf

[bk028]

yes from same site I have downloaded and installed this. 

Are u telling different than this?

[Nitin_laad]

Yes, after installation did you get a chance to validate it, you should execute wkhtmltopdf command in windows command prompt passing required parameter (html file or google url as given in example) and see if it converts html into pdf, to make sure given utility installed and configured as required. 

[bk028]

Thank u .

I am able to generate pdf for this page

But for aem page its taking login page content 

[Nitin_laad]

Great, htmltopdf conversion utility seems to be working fine. 

Are you still getting the same error while executing the workflow process on wknd page. 

Can you pass sample html as payload to workflow and see if you can convert it in pdf. 

Do you have read/write permission on given path?

Can you share the complete stack trace.. 

java - Apache commons command line execute method is returning exit code -1 when running in tomcat a...

[bk028]

Hi nitinlj,

Thank you.

Yes now workflow also working fine. It was not working earlier because the application was installed in C:program files because of which it was adding comma and flow was breaking.

after changing the location , its working but not useful in our case  because it requires login to aem application and this has to be done on publish instance.

So some other approach has to be tried.