/*******************************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*******************************************************************************/
package org.ofbiz.content.webapp.ftl;
import java.io.IOException;
import java.io.Writer;
import java.util.List;
import java.util.Map;
import javax.servlet.http.HttpServletRequest;
import org.ofbiz.base.util.Debug;
import org.ofbiz.base.util.UtilGenerics;
import org.ofbiz.base.util.UtilValidate;
import org.ofbiz.base.util.template.FreeMarkerWorker;
import org.ofbiz.content.content.ContentWorker;
import org.ofbiz.entity.Delegator;
import org.ofbiz.entity.GenericEntityException;
import org.ofbiz.webapp.ftl.LoopWriter;
import freemarker.core.Environment;
import freemarker.template.TemplateModelException;
import freemarker.template.TemplateTransformModel;
import freemarker.template.TransformControl;
/**
* InjectNodeTrailCsvTransform - Freemarker Transform for URLs (links)
*/
public class InjectNodeTrailCsvTransform implements TemplateTransformModel {
public static final String module = InjectNodeTrailCsvTransform.class.getName();
public static final String [] saveKeyNames = {"nodeTrailCsv","globalNodeTrail", "nodeTrail"};
public static final String [] removeKeyNames = {"nodeTrailCsv"};
/**
* @deprecated use FreeMarkerWorker.getWrappedObject()
* A wrapper for the FreeMarkerWorker version.
*/
@Deprecated
public static Object getWrappedObject(String varName, Environment env) {
return FreeMarkerWorker.getWrappedObject(varName, env);
}
/**
* @deprecated use FreeMarkerWorker.getArg()
*/
@Deprecated
public static String getArg(Map<String, ? extends Object> args, String key, Environment env) {
return FreeMarkerWorker.getArg(args, key, env);
}
/**
* @deprecated use FreeMarkerWorker.getArg()
*/
@Deprecated
public static String getArg(Map<String, ? extends Object> args, String key, Map<String, ? extends Object> ctx) {
return FreeMarkerWorker.getArg(args, key, ctx);
}
@SuppressWarnings("unchecked")
public Writer getWriter(final Writer out, Map args) {
final StringBuilder buf = new StringBuilder();
final Environment env = Environment.getCurrentEnvironment();
final Map<String, Object> templateCtx = FreeMarkerWorker.getWrappedObject("context", env);
//FreeMarkerWorker.convertContext(templateCtx);
final Delegator delegator = FreeMarkerWorker.getWrappedObject("delegator", env);
final HttpServletRequest request = FreeMarkerWorker.getWrappedObject("request", env);
//final GenericValue userLogin = FreeMarkerWorker.getWrappedObject("userLogin", env);
FreeMarkerWorker.getSiteParameters(request, templateCtx);
FreeMarkerWorker.overrideWithArgs(templateCtx, args);
return new LoopWriter(out) {
final String passedCsv = (String)templateCtx.get("nodeTrailCsv");
@Override
public void write(char cbuf[], int off, int len) {
buf.append(cbuf, off, len);
}
@Override
public void flush() throws IOException {
out.flush();
}
@Override
public int onStart() throws TemplateModelException, IOException {
String csvTrail = null;
List<Map<String, ? extends Object>> trail = UtilGenerics.checkList(templateCtx.get("globalNodeTrail"));
if (Debug.infoOn()) Debug.logInfo("in InjectNodeTrailCsv(0), trail:"+trail,module);
// This will build a nodeTrail if none exists
// Maybe only contentId or subContentId are passed in
//GenericValue currentValue = getCurrentContent(delegator, trail, userLogin, templateCtx, nullThruDatesOnly, contentAssocPredicateId);
String redo = (String)templateCtx.get("redo");
if (UtilValidate.isEmpty(trail) || (redo != null && redo.equalsIgnoreCase("true"))) {
// String thisContentId = null;
String subContentId = (String)templateCtx.get("subContentId");
if (Debug.infoOn()) Debug.logInfo("in InjectNodeTrailCsv(0), subContentId:"+subContentId,module);
String contentId = (String)templateCtx.get("contentId");
if (Debug.infoOn()) Debug.logInfo("in InjectNodeTrailCsv(0), contentId:"+contentId,module);
String contentAssocTypeId = (String)templateCtx.get("contentAssocTypeId");
if (Debug.infoOn()) Debug.logInfo("in InjectNodeTrailCsv(0), contentAssocTypeId:"+contentAssocTypeId,module);
try {
if (UtilValidate.isNotEmpty(subContentId)) {
csvTrail = ContentWorker.getContentAncestryNodeTrailCsv(delegator, subContentId, contentAssocTypeId, "to");
if (UtilValidate.isNotEmpty(csvTrail))
csvTrail += ",";
csvTrail += subContentId;
} else if (UtilValidate.isNotEmpty(contentId)) {
csvTrail = ContentWorker.getContentAncestryNodeTrailCsv(delegator, contentId, contentAssocTypeId, "to");
if (UtilValidate.isNotEmpty(csvTrail))
csvTrail += ",";
csvTrail += contentId;
}
} catch (GenericEntityException e) {
throw new RuntimeException("Error getting current content. " + e.toString());
}
if (Debug.infoOn()) Debug.logInfo("in InjectNodeTrailCsv(0), csvTrail:"+csvTrail,module);
} else {
// Build nodeTrail if one does not exist
//if (Debug.infoOn()) Debug.logInfo("in InjectNodeTrailCsv, trail:"+trail,module);
//if (Debug.infoOn()) Debug.logInfo("in InjectNodeTrailCsv, passedCsv:"+passedCsv,module);
if (UtilValidate.isNotEmpty(passedCsv)) {
csvTrail = passedCsv;
int lastComma = passedCsv.lastIndexOf(",");
String lastPassedContentId = null;
if (lastComma >= 0) {
lastPassedContentId = passedCsv.substring(lastComma + 1);
} else {
lastPassedContentId = passedCsv;
}
if (UtilValidate.isNotEmpty(lastPassedContentId)) {
if (UtilValidate.isNotEmpty(trail)) {
Map<String, ? extends Object> nd = trail.get(0);
String firstTrailContentId = (String)nd.get("contentId");
if (UtilValidate.isNotEmpty(firstTrailContentId)
&& UtilValidate.isNotEmpty(lastPassedContentId)
&& firstTrailContentId.equals(lastPassedContentId)) {
csvTrail += "," + ContentWorker.nodeTrailToCsv(trail.subList(1, trail.size()));
} else {
csvTrail += "," + ContentWorker.nodeTrailToCsv(trail);
}
}
}
} else {
csvTrail = ContentWorker.nodeTrailToCsv(trail);
}
}
//if (Debug.infoOn()) Debug.logInfo("in InjectNodeTrailCsv, csvTrail:"+csvTrail,module);
templateCtx.put("nodeTrailCsv", csvTrail);
return TransformControl.EVALUATE_BODY;
}
@Override
public void close() throws IOException {
templateCtx.put("nodeTrailCsv", passedCsv);
String wrappedContent = buf.toString();
out.write(wrappedContent);
}
};
}
}