org.broadleafcommerce.common.web.processor.ResourceBundleProcessor Maven / Gradle / Ivy
/*
* #%L
* BroadleafCommerce Common Libraries
* %%
* Copyright (C) 2009 - 2013 Broadleaf Commerce
* %%
* Licensed 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.
* #L%
*/
package org.broadleafcommerce.common.web.processor;
import org.apache.commons.lang3.StringUtils;
import org.broadleafcommerce.common.resource.service.ResourceBundlingService;
import org.broadleafcommerce.common.resource.service.ResourceMinificationService;
import org.broadleafcommerce.common.util.BLCSystemProperty;
import org.broadleafcommerce.common.web.BroadleafRequestContext;
import org.broadleafcommerce.common.web.resource.BroadleafResourceHttpRequestHandler;
import org.broadleafcommerce.common.web.util.ProcessorUtils;
import org.thymeleaf.Arguments;
import org.thymeleaf.dom.Element;
import org.thymeleaf.dom.NestableNode;
import org.thymeleaf.processor.ProcessorResult;
import org.thymeleaf.processor.element.AbstractElementProcessor;
import org.thymeleaf.standard.expression.Expression;
import org.thymeleaf.standard.expression.StandardExpressions;
import java.io.IOException;
import java.util.ArrayList;
import java.util.List;
import javax.annotation.Resource;
/**
*
* Takes a list of resources and optionally minifies (using the Yahoo YUI minifier) and combines them together to present a
* single file in the response. This will also automatically version the file name when minifying so that changes to bundles
* will not be cached by the browser. Most of the heavy lifting of this processor is done in {@link ResourceBundlingService}
* which uses {@link ResourceMinificationService}.
*
*
* The operation of this processor is dependent upon the {@code bundle.enabled} system property. If bundling is disabled
* via this system property then each file is individually linked in the HTML source
*
*
* For example, given this bundle:
*
*
* {@code
*
*
*
* With bundling enabled this will turn into:
*
*
* {@code
*
* }
*
*
*
* Where lib-123412.js is the result of minifying and combining all of the referenced files together.
*
*
* With bundling disabled this turns into:
*
*
* {@code
*
*
*
*
* }
*
*
*
* The files are presented without any additional processing done on them. This is beneficial for development when things
* like Javascript debugging is necessary.
*
*
* As of 3.1.9-GA, this also supports producing the 'async' and 'defer' attributes for Javascript files. For instance:
*
*
* {@code
*
*
*
* If bundling is turned on, the single output file contains the 'async' and 'defer' name-only attributes. When bundling is
* turned off, then those name-only attributes are applied to each individual file reference.
*
*
* This processor only supports files that end in .js and .css
*
* @param name (required) the final name of the minified bundle
* @param mapping-prefix (required) the prefix appended to the final tag output whether that be the list of files
* or the single minified file
* @param files (required) a comma-separated list of files that should be bundled together
*
* @author apazzolini
* @see {@link ResourceBundlingService}
* @see {@link ResourceMinificationService}
*/
public class ResourceBundleProcessor extends AbstractElementProcessor {
@Resource(name = "blResourceBundlingService")
protected ResourceBundlingService bundlingService;
protected boolean getBundleEnabled() {
BroadleafRequestContext brc = BroadleafRequestContext.getBroadleafRequestContext();
return BLCSystemProperty.resolveBooleanSystemProperty("bundle.enabled") && (brc.getSandBox() == null || brc.getAdmin());
}
public ResourceBundleProcessor() {
super("bundle");
}
@Override
public int getPrecedence() {
return 10000;
}
@Override
protected ProcessorResult processElement(Arguments arguments, Element element) {
String name = element.getAttributeValue("name");
String mappingPrefix = element.getAttributeValue("mapping-prefix");
boolean async = element.hasAttribute("async");
boolean defer = element.hasAttribute("defer");
NestableNode parent = element.getParent();
List files = new ArrayList();
for (String file : element.getAttributeValue("files").split(",")) {
files.add(file.trim());
}
if (getBundleEnabled()) {
String versionedBundle = bundlingService.getVersionedBundleName(name);
if (StringUtils.isBlank(versionedBundle)) {
BroadleafResourceHttpRequestHandler reqHandler = getRequestHandler(name, arguments);
try {
versionedBundle = bundlingService.registerBundle(name, files, reqHandler);
} catch (IOException e) {
throw new RuntimeException(e);
}
}
Expression expression = (Expression) StandardExpressions.getExpressionParser(arguments.getConfiguration())
.parseExpression(arguments.getConfiguration(), arguments, "@{'" + mappingPrefix + versionedBundle + "'}");
String value = (String) expression.execute(arguments.getConfiguration(), arguments);
Element e = getElement(value, async, defer);
parent.insertAfter(element, e);
} else {
List additionalBundleFiles = bundlingService.getAdditionalBundleFiles(name);
if (additionalBundleFiles != null) {
files.addAll(additionalBundleFiles);
}
for (String file : files) {
file = file.trim();
Expression expression = (Expression) StandardExpressions.getExpressionParser(arguments.getConfiguration())
.parseExpression(arguments.getConfiguration(), arguments, "@{'" + mappingPrefix + file + "'}");
String value = (String) expression.execute(arguments.getConfiguration(), arguments);
Element e = getElement(value, async, defer);
parent.insertBefore(element, e);
}
}
parent.removeChild(element);
return ProcessorResult.OK;
}
/**
* @deprecated use {@link #getScriptElement(String, boolean, boolean)} instead
*/
@Deprecated
protected Element getScriptElement(String src) {
return getScriptElement(src, false, false);
}
protected Element getScriptElement(String src, boolean async, boolean defer) {
Element e = new Element("script");
e.setAttribute("type", "text/javascript");
e.setAttribute("src", src);
if (async) {
e.setAttribute("async", true, null);
}
if (defer) {
e.setAttribute("defer", true, null);
}
return e;
}
protected Element getLinkElement(String src) {
Element e = new Element("link");
e.setAttribute("rel", "stylesheet");
e.setAttribute("href", src);
return e;
}
/**
* @deprecated use {@link #getElement(String, boolean, boolean)} instead
*/
@Deprecated
protected Element getElement(String src) {
return getElement(src, false, false);
}
protected Element getElement(String src, boolean async, boolean defer) {
if (src.contains(";")) {
src = src.substring(0, src.indexOf(';'));
}
if (src.endsWith(".js")) {
return getScriptElement(src, async, defer);
} else if (src.endsWith(".css")) {
return getLinkElement(src);
} else {
throw new IllegalArgumentException("Unknown extension for: " + src + " - only .js and .css are supported");
}
}
protected BroadleafResourceHttpRequestHandler getRequestHandler(String name, Arguments arguments) {
BroadleafResourceHttpRequestHandler handler = null;
if (name.endsWith(".js")) {
handler = ProcessorUtils.getJsRequestHandler(arguments);
} else if (name.endsWith(".css")) {
handler = ProcessorUtils.getCssRequestHandler(arguments);
}
if (handler == null) {
throw new IllegalArgumentException("Unknown extension for: " + name + " - only .js and .css are supported");
}
return handler;
}
}