zk/src/main/java/org/zkoss/zk/ui/http/WpdExtendlet.java
/* WpdExtendlet.java
Purpose:
Description:
History:
Mon Oct 6 10:47:11 2008, Created by tomyeh
Copyright (C) 2008 Potix Corporation. All Rights Reserved.
This program is distributed under LGPL Version 2.1 in the hope that
it will be useful, but WITHOUT ANY WARRANTY.
*/
package org.zkoss.zk.ui.http;
import java.io.ByteArrayInputStream;
import java.io.ByteArrayOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.Iterator;
import java.util.LinkedHashMap;
import java.util.LinkedList;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import javax.servlet.ServletContext;
import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.zkoss.html.HTMLs;
import org.zkoss.idom.Element;
import org.zkoss.idom.input.SAXBuilder;
import org.zkoss.idom.util.IDOMs;
import org.zkoss.io.Files;
import org.zkoss.json.JSONArray;
import org.zkoss.json.JSONObject;
import org.zkoss.lang.Classes;
import org.zkoss.lang.Exceptions;
import org.zkoss.lang.Library;
import org.zkoss.lang.Strings;
import org.zkoss.web.servlet.Servlets;
import org.zkoss.web.servlet.http.Encodes;
import org.zkoss.web.servlet.http.Https;
import org.zkoss.web.util.resource.ClassWebResource;
import org.zkoss.web.util.resource.ExtendletConfig;
import org.zkoss.web.util.resource.ExtendletContext;
import org.zkoss.web.util.resource.ExtendletLoader;
import org.zkoss.xml.XMLs;
import org.zkoss.zk.device.Device;
import org.zkoss.zk.device.Devices;
import org.zkoss.zk.ui.UiException;
import org.zkoss.zk.ui.WebApp;
import org.zkoss.zk.ui.WebApps;
import org.zkoss.zk.ui.metainfo.LanguageDefinition;
import org.zkoss.zk.ui.metainfo.WidgetDefinition;
import org.zkoss.zk.ui.util.Configuration;
import org.zkoss.zk.ui.util.URIInfo;
/**
* The extendlet to handle WPD (Widget Package Descriptor).
*
* <p>Note: it assumes all JavaScript files are encoded in UTF-8.
*
* <h3>Bootstrapping</h3>
*
* <p>In additions to loading, WPD allows to bootstrap a JavaScript codes
* by specifying a parameter called main. For example, the following link
*
*<pre><code><script type="text/javascript" src="/zkdemo/zkau/web/js/zk.wpd?main=foo.Go&what=12&more=xy" charset="UTF-8">
</script></code></pre>
*
* will cause the following to be executed
*
*<pre><code>zk.load('foo', function() {foo.Go.main({what: '123', more: 'xy'})});</code></pre>
*
* In other words, it loads the package called <code>foo</code>, and then
* invoke the <code>main</code> method of the <code>foo.Go</code> class.
*
* @author tomyeh
* @since 5.0.0
*/
public class WpdExtendlet extends AbstractExtendlet<Object> {
//source map
public static final String SOURCE_MAP_JAVASCRIPT_PATH = "$zk$sourcemapJsPath"; // for HtmlPageRenders
private static final String SOURCE_MAP_DIVIDED_WPDS = "$zk$dividedWPDs";
private static final String SOURCE_MAP_DIVIDED_WPDS_NUMBER = "$zk$dividedWPDsNum";
private ConcurrentMap<String, List<Element>> _dividedWpds = new ConcurrentHashMap<>(1); // store xml node for later parsing (ex. zk1 -> <script> ...)
private ConcurrentMap<String, Integer> _dividedPackageCnt = new ConcurrentHashMap<>(1); // store package count for dependency (ex. zul.wgt -> 2)
private Set<String> _lastDynamicWpds = ConcurrentHashMap.newKeySet(1); // store last dynamic wpd for not setting loaded
public void init(ExtendletConfig config) {
init(config, new WpdLoader());
if (!isDebugJS()) {
config.addCompressExtension("wpd");
}
}
public void service(HttpServletRequest request, HttpServletResponse response, String path)
throws ServletException, IOException {
byte[] data = retrieve(request, response, path);
if (data == null)
return;
response.setContentType("text/javascript;charset=UTF-8");
if (_webctx.shallCompress(request, "wpd") && data.length > 200) {
byte[] bs = Https.gzip(request, response, null, data);
if (bs != null)
data = bs; //yes, browser support compress
}
response.setContentLength(data.length);
response.getOutputStream().write(data);
response.flushBuffer();
}
/** Retrieves the content of the given path.
* @since 5.0.4
*/
protected byte[] retrieve(HttpServletRequest request, HttpServletResponse response, String path)
throws ServletException, IOException {
byte[] data;
String pkg = null;
boolean sourceMapEnabled = sourceMapEnabled();
if (path.endsWith(".map")) {
if (sourceMapEnabled) { // try to get *.js.map
if (path.endsWith("js/index.js.map")) { // special case, inside zk
path = path.replace("js/index.js.map", "js/zk/index.js.map");
}
InputStream resourceAsStream = _webctx.getResourceAsStream(path);
if (resourceAsStream != null) {
return resourceAsStream.readAllBytes();
}
}
response.sendError(HttpServletResponse.SC_NOT_FOUND, path);
return null;
}
/* 2011/4/27 Tony:
* Here we don't use "org.zkoss.web.classWebResource.cache" directly,
* since some of our users might want to clear the cache for their css.dsp ,
* and still cache the wpd js resource.
*
* So we add on a new config to clear the widget source .
* @see bug 2898413
*/
String resourceCache = Library.getProperty("org.zkoss.zk.WPD.cache");
if (resourceCache != null && "false".equalsIgnoreCase(resourceCache))
_cache.clear();
List<Element> dividedElements;
if (sourceMapEnabled && !path.endsWith("lang.wpd")) {
boolean pkgStart = path.endsWith("0.wpd");
boolean pkgEnd = path.endsWith("$.wpd");
int lastPartIndex = path.lastIndexOf("/") + 1;
String lastPart = path.substring(lastPartIndex);
String pkgName = lastPart.replaceAll("[\\d]{1,2}\\.wpd", "");
if (pkgStart || pkgEnd) {
if (pkgStart) {
return ("(function(){zk._p=zkpi('" + pkgName + "');})()").getBytes();
} else {
return ("(function(){zk.setLoaded('" + lastPart.replace("$.wpd", "") + "');})()").getBytes();
}
} else {
dividedElements = _dividedWpds.get(lastPart);
if (dividedElements == null) { // dynamic
try {
byte[] dynamicContent = processDynamicWpdWithSourceMapIfAny(request, response, pkgName, path);
if (dynamicContent != null) {
return dynamicContent;
} else {
dividedElements = _dividedWpds.get(lastPart);
}
} catch (Exception e) {
log.error("fail to process source for source map", e);
return new byte[]{};
}
}
request.setAttribute(SOURCE_MAP_DIVIDED_WPDS, dividedElements);
Integer packagePartsCnt = _dividedPackageCnt.get(pkgName);
if (packagePartsCnt != null && packagePartsCnt >= 1) {
int num = Integer.parseInt(lastPart.replace(pkgName, "").replace(".wpd", ""));
request.setAttribute(SOURCE_MAP_DIVIDED_WPDS_NUMBER, num);
}
}
path = path.substring(0, lastPartIndex) + (pkgName.endsWith("wpd") ? pkgName : (pkgName + ".wpd")); // original wpd path
}
final Content content = (Content) _cache.get(path);
Content latestContent = null; // for source map to prevent cached
boolean retrievingLastContent = sourceMapEnabled && !(content._cnt instanceof SourceInfo); // if parsed content cached, get latest one.
if (retrievingLastContent) {
try {
latestContent = (Content) _cache.getLoader().load(path);
} catch (Exception e) {
log.error("Failed to load the resource: " + path);
throw new UiException("Failed to load the resource: " + path, e);
}
}
if (content == null || (retrievingLastContent && latestContent == null)) {
if (Servlets.isIncluded(request)) {
log.error("Failed to load the resource: " + path);
//It might be eaten, so log the error
throw new java.io.FileNotFoundException("Failed to load the resource: " + path);
//have the includer to handle it
}
response.sendError(response.SC_NOT_FOUND, HTMLs.encodeJavaScript(XMLs.escapeXML(path)));
return null;
}
final boolean cacheable;
final RequestContext reqctx = new RequestContext(this, request, response);
synchronized (content) {
// if source map is enabled, always not using cache
final Object rawdata = sourceMapEnabled ? new Content((SourceInfo) (latestContent == null ? content : latestContent)._cnt).parse(reqctx) : content.parse(reqctx);
if (rawdata instanceof ByteContent) {
final ByteContent bc = (ByteContent) rawdata;
data = bc.content;
cacheable = bc.cacheable;
} else {
final WpdContent wc = (WpdContent) rawdata;
data = wc.toByteArray(reqctx);
pkg = wc.name;
cacheable = wc.cacheable;
}
}
if (cacheable) {
boolean isNotModified = org.zkoss.zk.fn.JspFns.setCacheControl(getServletContext(), request, response, "org.zkoss.web.classWebResource.cache", 8760);
if (isNotModified) return null;
}
return pkg != null && !sourceMapEnabled ? mergeJavaScript(request, response, pkg, data) : data;
}
/** Returns the device type for this WpdExtendlet.
* <p>Default: ajax.
* The derived class might override it to implement a Wpd extendlet
* for other devices.
* @since 5.0.4
*/
protected String getDeviceType() {
return "ajax";
}
/** Merges the JavaScript code of the mergeable packages defined in
* {@link LanguageDefinition#getMergedJavaScriptPackages}.
* @since 5.0.4.
*/
protected byte[] mergeJavaScript(HttpServletRequest request, HttpServletResponse response, String pkgTo,
byte[] data) throws ServletException, IOException {
ByteArrayOutputStream out = null;
Device device = null;
final String deviceType = getDeviceType();
for (LanguageDefinition langdef : LanguageDefinition.getByDeviceType(deviceType)) {
for (String pkg : langdef.getMergedJavaScriptPackages(pkgTo)) {
if (out == null) {
out = new ByteArrayOutputStream(1024 * 100);
out.write(data);
device = Devices.getDevice(deviceType);
}
final String path = device.packageToPath(pkg);
data = retrieve(request, response, path);
if (data != null) {
out.write(data);
} else log.error("Failed to load the resource: " + path);
}
}
return out != null ? out.toByteArray() : data;
}
private Object parse(RequestContext reqctx, InputStream is, String path) throws Exception {
final Element root = new SAXBuilder(true, false, true).build(is).getRootElement();
final String name = IDOMs.getRequiredAttributeValue(root, "name");
if (name.length() == 0)
throw new UiException("The name attribute must be specified, " + root.getLocator() + ", " + path);
final boolean zk = "zk".equals(name), aaas = "zk.aaas".equals(name);
final String lang = root.getAttributeValue("language");
final LanguageDefinition langdef = //optional
lang != null ? LanguageDefinition.lookup(lang) : null;
final String dir = path.substring(0, path.lastIndexOf('/') + 1);
final boolean cacheable = !"false".equals(root.getAttributeValue("cacheable"));
final WpdContent wc = zk || aaas || !cacheable || isWpdContentRequired(name, root)
? new WpdContent(name, dir, cacheable) : null;
final ByteArrayOutputStream out = new ByteArrayOutputStream(1024 * 16);
String depends = null;
List<Element> partialElements = (List<Element>) reqctx.request.getAttribute(SOURCE_MAP_DIVIDED_WPDS); // elements divided by source map
boolean processingPartial = partialElements != null;
Integer partialNum = (Integer) reqctx.request.getAttribute(SOURCE_MAP_DIVIDED_WPDS_NUMBER);
if (partialNum == null) {
partialNum = 0;
}
Integer totalPartialCount = _dividedPackageCnt.get(name);
if (totalPartialCount == null) {
totalPartialCount = 0;
}
if (zk) {
if (!processingPartial) { // not source map
write(out, "if(!window.zk){\n");
}
//may be loaded multiple times because specified in lang.xml
} else if (!aaas) {
depends = root.getAttributeValue("depends");
if (depends != null && depends.length() == 0) depends = null;
if (depends != null) {
write(out, "zk.load('");
if (processingPartial && partialNum > 1 && totalPartialCount > 1) {
write(out, name + (partialNum - 1));
} else {
write(out, depends);
}
write(out, "',");
} else if (!processingPartial) {
write(out, '(');
}
if (depends != null || !processingPartial) {
write(out, "function(){");
if (processingPartial && totalPartialCount > 1) {
String[] pkgs = name.split("\\.");
String pkgParts = "";
for (int i = 0, l = pkgs.length; i < (l - 1); i++) {
pkgParts += pkgs[i];
write(out, "if(!window." + pkgParts + ")window." + pkgParts + "={};");
pkgParts += ".";
}
write(out, "if(!window." + name + ")window." + name + "={};");
}
write(out, "if(zk._p=zkpi('");
if (processingPartial && totalPartialCount > 1) {
write(out, name + partialNum);
} else {
write(out, name);
}
write(out, '\'');
if (reqctx.getResource(dir + "wv/zk.wpd") != null) write(out, ",true");
write(out, "))try{\n");
}
}
final Map<String, String[]> moldInfos = new HashMap<>();
List<Element> elements = processingPartial ? partialElements : root.getElements();
boolean processingSourceMapScript = false;
for (Iterator it = elements.iterator(); it.hasNext();) {
final Element el = (Element) it.next();
final String elnm = el.getName();
if ("widget".equals(elnm)) {
final String wgtnm = IDOMs.getRequiredAttributeValue(el, "name");
final boolean moldOnly = "true".equals(el.getAttributeValue("moldOnly"));
if (!moldOnly) {
final String jspath = wgtnm + ".js"; //eg: /js/zul/wgt/Div.js
if (!writeResource(reqctx, out, jspath, dir, false)) {
log.error("Widget " + wgtnm + ": " + jspath + " not found, " + el.getLocator() + ", " + path);
continue;
}
}
final String wgtflnm = name + "." + wgtnm;
write(out, "zkreg('");
write(out, wgtflnm);
write(out, "'");
WidgetDefinition wgtdef = langdef != null ? langdef.getWidgetDefinitionIfAny(wgtflnm) : null;
if (wgtdef != null && wgtdef.isBlankPreserved()) {
write(out, ",true");
}
write(out, ");\n");
if (wgtdef == null) {
continue;
}
try {
boolean first = true;
for (Iterator e = wgtdef.getMoldNames().iterator(); e.hasNext();) {
final String mold = (String) e.next();
final String uri = wgtdef.getMoldURI(mold);
if (uri == null) continue;
if (first) {
first = false;
write(out, "zk._m={};\n");
}
write(out, "zk._m['");
write(out, mold);
write(out, "']=");
String[] info = (String[]) moldInfos.get(uri);
if (info != null) { //reuse
write(out, "[");
write(out, name);
write(out, ".");
write(out, info[0]);
write(out, ",'");
write(out, info[1]);
write(out, "'];\n");
} else {
moldInfos.put(uri, new String[]{wgtnm, mold});
if (!writeResource(reqctx, out, uri, dir, true)) {
write(out, "zk.$void;zk.error('");
write(out, uri);
write(out, " not found')");
log.error("Failed to load mold " + mold + " for widget " + wgtflnm + ": " + uri + " not found");
}
write(out, ';');
}
}
if (!first) {
write(out, "zkmld(");
if (zk) {
write(out, "zk.");
} else {
write(out, name);
write(out, ".");
}
write(out, wgtnm);
write(out, ",zk._m);\n");
}
} catch (Throwable ex) {
log.error("Failed to load molds for widget " + wgtflnm + ".\nCause: " + Exceptions.getMessage(ex));
}
} else if ("script".equals(elnm)) {
String browser = el.getAttributeValue("browser");
String jspath = el.getAttributeValue("src");
if (jspath != null && jspath.length() > 0) {
if (!zk && "true".equals(el.getAttribute("sourceMap")) && depends != null && processingPartial) {
processingSourceMapScript = true;
write(out, "var script=document.createElement('script');");
write(out, "script.type='text/javascript';");
write(out, "script.onload=function(){\n");
write(out, "zk.setLoaded('");
if (totalPartialCount > 1 && partialNum < totalPartialCount) {
write(out, name + partialNum);
} else {
write(out, name);
}
write(out, "');");
String requestURI = reqctx.request.getRequestURI();
String prefixURI = requestURI.substring(0, requestURI.lastIndexOf("/js"));
write(out, "};script.src='" + prefixURI + findResourcePath(reqctx, out, jspath, dir, true, false));
write(out, "';\ndocument.getElementsByTagName('head')[0].appendChild(script);");
} else {
if (wc != null && (browser != null || jspath.indexOf('*') >= 0)) {
move(wc, out);
wc.add(jspath, browser);
} else {
if (browser != null && (!Servlets.isBrowser(reqctx.request, browser)
// F70-ZK-1956: Check whether the script should be loaded or ignored.
|| getScriptManager().isScriptIgnored(reqctx.request, jspath))) {
continue;
}
if (!writeResource(reqctx, out, jspath, dir, true)) {
log.error(jspath + " not found, " + el.getLocator() + ", " + path);
}
}
}
}
String s = el.getText(true);
if (s != null && s.length() > 0) {
write(out, s);
write(out, '\n'); //might terminate with //
}
} else if ("function".equals(elnm)) {
final MethodInfo mtd = getMethodInfo(el);
if (mtd != null) if (wc != null) {
move(wc, out);
wc.add(mtd);
} else {
write(reqctx, out, mtd);
}
} else {
log.warn("Unknown element " + elnm + ", " + el.getLocator() + ", " + path);
}
}
if (zk) { // not source map
if (!processingPartial || Objects.equals(partialNum,
totalPartialCount)) {
final WebApp wapp = getWebApp();
if (wapp != null) {
writeAppInfo(reqctx, out, wapp);
}
if (!processingPartial) {
write(out, '}'); //end of if(window.zk)
}
writeHost(wc, out, wapp, reqctx);
}
} else if (aaas) {
writeHost(wc, out, getWebApp(), reqctx);
} else {
if (depends != null || !processingPartial) {
write(out, "\n}catch(error){console.error(error);}finally{");
if (!processingSourceMapScript) {
write(out, "zk.setLoaded(zk._p.n);");
if (processingPartial && Objects.equals(partialNum,
totalPartialCount)) {
write(out, "zk.setLoaded('");
write(out, name);
write(out, "');");
}
}
write(out, "}");
}
if (depends != null) {
write(out, "});");
if (!processingPartial || !_lastDynamicWpds.contains(name + partialNum + ".wpd")) {
write(out, "zk.setLoaded('");
if (processingPartial && totalPartialCount > 1 && partialNum < totalPartialCount) {
write(out, name + partialNum);
} else {
write(out, name);
}
write(out, "',1);");
}
} else if (!processingPartial) {
write(out, "})();");
}
}
if (wc != null) {
move(wc, out);
return wc;
}
return new ByteContent(out.toByteArray(), cacheable);
}
// https://en.wikipedia.org/wiki/Initialization-on-demand_holder_idiom
private static class ScriptManagerHolder {
private static final ScriptManager INSTANCE = initializeScriptManager();
private static ScriptManager initializeScriptManager() {
String clsnm = Library.getProperty("org.zkoss.zk.ui.http.ScriptManager.class");
ScriptManager manager = null;
if (clsnm != null) {
try {
manager = (ScriptManager) Classes.newInstanceByThread(clsnm);
} catch (Throwable ex) {
log.error("Unable to instantiate " + clsnm, ex);
}
}
if (manager == null) manager = new ScriptManagerImpl();
return manager;
}
}
public ScriptManager getScriptManager() {
return ScriptManagerHolder.INSTANCE;
}
private boolean isWpdContentRequired(String pkg, Element root) {
for (LanguageDefinition langdef : LanguageDefinition.getByDeviceType(getDeviceType()))
if (langdef.getJavaScriptPackagesWithMerges().contains(pkg)) return true;
for (Iterator it = root.getElements("script").iterator(); it.hasNext();) {
final Element el = (Element) it.next();
if (el.getAttributeValue("browser") != null) return true;
}
return false;
}
private void writeHost(WpdContent wc, ByteArrayOutputStream out, WebApp wapp, RequestContext reqctx) throws ServletException, IOException {
if (wapp != null) {
final String[] pkgs = wapp.getConfiguration().getClientPackages();
if (pkgs.length > 0) {
move(wc, out);
wc.addHost(wapp, JSONArray.toJSONString(pkgs));
}
}
}
private String findResourcePath(RequestContext reqctx, OutputStream out, String path, String dir, boolean locate, boolean write) throws ServletException, IOException {
if (path.startsWith("~./")) path = path.substring(2);
else if (path.charAt(0) != '/') path = Files.normalize(dir, path);
//source map browser issue and check source map file is available or not
String originalPath = "";
if (isDebugJS() && !sourceMapEnabled()) {
if ("js".equals(Servlets.getExtension(path)) && !path.endsWith(".src.js")) {
originalPath = path; //if .src.js not exist -> roll back
path = path.substring(0, path.length() - 3) + ".src.js";
}
}
InputStream is = reqctx.getResourceAsStream(path, locate);
while (is == null) {
if (Strings.isEmpty(originalPath)) {
write(out, "zk.log('");
write(out, path);
write(out, " not found');");
return null;
} else {
path = originalPath;
is = reqctx.getResourceAsStream(path, locate);
originalPath = null;
}
}
if (write) {
Files.copy(out, is);
Files.close(is);
write(out, '\n'); //might terminate with //
}
return path;
}
private boolean writeResource(RequestContext reqctx, OutputStream out, String path, String dir, boolean locate) throws IOException, ServletException {
return findResourcePath(reqctx, out, path, dir, locate, true) != null;
}
private int countLines(String js) {
int line = 0;
for (int i = 0; i < js.length(); i++) {
if (js.charAt(i) == '\n') {
line++;
}
}
return line;
}
private void write(OutputStream out, String s) throws IOException {
if (s != null) {
final byte[] bs = s.getBytes("UTF-8");
out.write(bs, 0, bs.length);
}
}
private void write(OutputStream out, char cc) throws IOException {
assert cc < 128;
final byte[] bs = new byte[] { (byte) cc };
out.write(bs, 0, 1);
}
//return result, only for sourcemap
private String write(RequestContext reqctx, OutputStream out, MethodInfo mtd) throws IOException {
try {
String result = invoke(reqctx, mtd);
write(out, result);
return result;
} catch (IOException ex) {
throw ex;
}
}
/*private static void write(OutputStream out, StringBuffer sb)
throws IOException {
final byte[] bs = sb.toString().getBytes("UTF-8");
out.write(bs, 0, bs.length);
sb.setLength(0);
}*/
private void writeln(OutputStream out) throws IOException {
write(out, '\n');
}
private void move(WpdContent wc, ByteArrayOutputStream out) {
final byte[] bs = out.toByteArray();
if (bs.length > 0) {
wc.add(bs);
out.reset();
}
}
private void writeAppInfo(RequestContext reqctx, OutputStream out, WebApp wapp) throws IOException, ServletException {
final String verInfoEnabled = Library.getProperty("org.zkoss.zk.ui.versionInfo.enabled", "true");
final boolean exposeVer = "true".equals(verInfoEnabled);
final StringBuffer sb = new StringBuffer(256);
if (exposeVer)
sb.append("\nzkver('").append(wapp.getVersion()).append("','");
else
sb.append("\nzkver('','");
String build = wapp.getBuild();
sb.append(exposeVer ? build : Utils.obfuscateHashWithSalt(build, verInfoEnabled));
final ServletContext ctx = getServletContext();
String s = Encodes.encodeURL(ctx, reqctx.request, reqctx.response, "/");
int j = s.lastIndexOf('/'); //might have jsessionid=...
if (j >= 0)
s = s.substring(0, j) + s.substring(j + 1);
sb.append("','").append(s).append("','")
.append(Encodes.encodeURL(ctx, reqctx.request, reqctx.response, wapp.getUpdateURI(false)));
sb.append("',{");
for (Iterator it = LanguageDefinition.getByDeviceType(getDeviceType()).iterator(); it.hasNext();) {
final LanguageDefinition langdef = (LanguageDefinition) it.next();
for (Iterator e = langdef.getJavaScriptModules().entrySet().iterator(); e.hasNext();) {
final Map.Entry me = (Map.Entry) e.next();
Object value = me.getValue();
sb.append('\'').append(me.getKey()).append("':'")
.append(exposeVer ? value : Utils.obfuscateHashWithSalt(value, verInfoEnabled)).append("',");
}
removeLast(sb, ',');
}
sb.append("},{");
if (WebApps.getFeature("ee"))
sb.append("ed:'e',");
else if (WebApps.getFeature("pe"))
sb.append("ed:'p',");
final Configuration config = wapp.getConfiguration();
int v = config.getProcessingPromptDelay();
if (v != 900)
sb.append("pd:").append(v).append(',');
v = config.getTooltipDelay();
if (v != 800)
sb.append("td:").append(v).append(',');
v = config.getAutoResendTimeout();
if (v != 200)
sb.append("art:").append(v).append(',');
if (config.isTimerKeepAlive())
sb.append("ta:1,");
if (config.isDebugJS())
sb.append("dj:1,");
if (config.isSendClientErrors())
sb.append("sce:1,");
if (config.isKeepDesktopAcrossVisits())
sb.append("kd:1,");
if (config.getPerformanceMeter() != null)
sb.append("pf:1,");
if (!config.isHistoryStateEnabled())
sb.append("hs:0,");
final String deviceType = getDeviceType();
Object[][] infs = config.getClientErrorReloads(deviceType, null);
if (infs != null) {
sb.append("eu:{");
outErrReloads(reqctx, config, sb, infs);
sb.append("},");
}
infs = config.getClientErrorReloads(deviceType, "server-push");
if (infs != null) {
sb.append("eup:{");
outErrReloads(reqctx, config, sb, infs);
sb.append("},");
}
//ZK-4564
sb.append("resURI:'").append(Encodes.encodeURL(ctx, reqctx.request, reqctx.response, wapp.getResourceURI(false))).append("'").append("});");
write(out, sb.toString());
}
private void outErrReloads(RequestContext reqctx, Configuration config, StringBuffer sb, Object[][] infs) {
for (int j = 0; j < infs.length; ++j) {
if (j > 0)
sb.append(',');
sb.append('\'').append(infs[j][0]).append("':'");
String uri = ((URIInfo) infs[j][1]).uri;
if (uri.length() > 0)
try {
uri = Encodes.encodeURL(getServletContext(), reqctx.request, reqctx.response, uri);
} catch (javax.servlet.ServletException ex) {
throw new UiException("Unable to encode " + uri, ex);
}
sb.append(Strings.escape(uri, "'\\")).append('\'');
}
}
private static void removeLast(StringBuffer sb, char cc) {
if (sb.charAt(sb.length() - 1) == cc)
sb.setLength(sb.length() - 1); //remove last comma
}
private static String outMain(String main, Map<String, String[]> params) {
final StringBuffer sb = new StringBuffer("\nzkamn('");
final int j = main.lastIndexOf('.');
if (j >= 0)
sb.append(main.substring(0, j));
sb.append("',function(){\n").append(main).append(".main(");
final Map<String, Object> ms = new LinkedHashMap<String, Object>();
for (Map.Entry<String, String[]> me : params.entrySet()) {
final String nm = me.getKey();
if (!"main".equals(nm)) {
final String[] vals = me.getValue();
ms.put(nm, vals.length == 0 ? null : vals.length == 1 ? vals[0] : vals);
}
}
sb.append(JSONObject.toJSONString(ms)).append(")\n})");
return sb.toString();
}
private static String outHost(HttpServletRequest request, WebApp wapp, String clientPackages) {
final StringBuffer sb = new StringBuffer().append("zk.setHost('").append(request.getScheme()).append("://")
.append(request.getServerName());
if (request.getServerPort() != 80)
sb.append(':').append(request.getServerPort());
String uri = request.getContextPath();
if (uri != null && uri.length() > 0) {
if (uri.charAt(0) != '/')
sb.append('/');
sb.append(uri);
removeLast(sb, '/');
}
return sb.append("','").append(wapp.getResourceURI(false)).append("',").append(clientPackages).append(");")
.toString();
}
/** Loader used with ResourceCache. */
private class WpdLoader extends ExtendletLoader<Object> {
private WpdLoader() {
}
//-- super --//
protected Object parse(InputStream is, String path, String orgpath) throws Exception {
return new Content(new SourceInfo(is, path));
}
protected ExtendletContext getExtendletContext() {
return _webctx;
}
protected String getRealPath(String path) {
if (path.endsWith("map")) { // source map
return path;
}
final int j = path.lastIndexOf(".wpd");
return path.substring(0, j).replace('.', '/') + "/zk" + path.substring(j);
}
}
private static class Content {
private Object _cnt;
private Content(SourceInfo si) {
_cnt = si;
}
private Object parse(RequestContext reqctx) throws ServletException, IOException {
if (_cnt instanceof SourceInfo)
try {
_cnt = ((SourceInfo) _cnt).parse(reqctx);
} catch (IOException ex) {
throw ex;
} catch (ServletException ex) {
throw ex;
} catch (Exception ex) {
throw UiException.Aide.wrap(ex);
}
return _cnt;
}
}
private class SourceInfo {
private final byte[] _raw;
private final String _path;
private SourceInfo(InputStream input, String path) throws IOException {
_raw = Files.readAll(input);
_path = path;
}
private Object parse(RequestContext reqctx) throws Exception {
return WpdExtendlet.this.parse(reqctx, new ByteArrayInputStream(_raw), _path);
}
}
private static class ByteContent {
private final byte[] content;
private final boolean cacheable;
private ByteContent(byte[] cnt, boolean cacheable) {
this.content = cnt;
this.cacheable = cacheable;
}
}
private class WpdContent {
/** The package name*/
private final String name;
private final String _dir;
private final List<Object> _cnt = new LinkedList<Object>();
/** Whether it is cacheable. */
private final boolean cacheable;
private WpdContent(String name, String dir, boolean cacheable) {
this.name = name;
_dir = dir;
this.cacheable = cacheable;
}
private void add(byte[] bs) {
_cnt.add(bs);
}
private void add(MethodInfo mtd) {
_cnt.add(mtd);
}
private void add(String jspath, String browser) {
_cnt.add(new String[] { jspath, browser });
}
private void addHost(WebApp wapp, String clientPackages) {
_cnt.add(new Object[] { wapp, clientPackages });
}
@SuppressWarnings("unchecked")
private byte[] toByteArray(RequestContext reqctx) throws ServletException, IOException {
final ByteArrayOutputStream out = new ByteArrayOutputStream();
final HttpServletRequest request = reqctx.request;
final String main = request != null ? request.getParameter("main") : null;
//for source map
List<String> resultList = new ArrayList<String>(16);
for (Object o : _cnt) {
String result = "";
if (o instanceof byte[]) {
out.write((byte[]) o);
} else if (o instanceof MethodInfo) {
result = write(reqctx, out, (MethodInfo) o);
resultList.add(result);
} else if (o instanceof String[]) {
resultList.add("$skipped$");
final String[] inf = (String[]) o;
if (inf[1] != null && request != null) {
if (!Servlets.isBrowser(request, inf[1])
// F70-ZK-1956: Check whether the script should be loaded or ignored.
|| getScriptManager().isScriptIgnored(reqctx.request, inf[0]))
continue;
}
if (!writeResource(reqctx, out, inf[0], _dir, true)) {
log.error(inf[0] + " not found");
}
} else if (o instanceof Object[]) { //host
if (main != null) {
final Object[] inf = (Object[]) o;
result = outHost(request, (WebApp) inf[0], (String) inf[1]);
resultList.add(result);
write(out, result);
}
}
}
if (main != null && main.length() > 0)
write(out, outMain(main, request.getParameterMap()));
return out.toByteArray();
}
}
private boolean sourceMapEnabled() {
return getWebApp().getConfiguration().isSourceMapEnabled();
}
/**
* Internal use only (since 10.0.0)
*/
public List<String> splitSourceMapJsPathIfAny(String path) throws Exception {
String originalPath = path;
if (path.startsWith("~.")) {
path = path.replace("~.", "");
}
int pathPrefixIndex = path.indexOf(ClassWebResource.PATH_PREFIX);
if (pathPrefixIndex != -1) {
path = path.substring(ClassWebResource.PATH_PREFIX.length());
}
List<String> paths = new LinkedList<>();
ClassWebResource cwr = WebManager.getWebManager(getWebApp()).getClassWebResource();
path = cwr.modifyPath(path);
String originalPathPrefix = originalPath.substring(0, originalPath.lastIndexOf(path));
String packageName = processWpdForSourcemapIfAny(paths, originalPathPrefix, cwr.modifyPath(path));
final String deviceType = getDeviceType();
Device device = Devices.getDevice(deviceType);
// process "merge=true"
for (LanguageDefinition langdef : LanguageDefinition.getByDeviceType(deviceType)) {
for (String pkg : langdef.getMergedJavaScriptPackages(packageName)) {
final String packageToPath = device.packageToPath(pkg);
processWpdForSourcemapIfAny(paths, originalPathPrefix, cwr.modifyPath(packageToPath));
}
}
return paths;
}
// return package name
private String processWpdForSourcemapIfAny(List<String> paths, String originalPathPrefix, String path) throws Exception {
final Content content = (Content) _cache.get(path);
if (content == null) {
log.error("Failed to load the resource: " + path);
throw new java.io.FileNotFoundException("Failed to load the resource: " + path);
}
ByteArrayInputStream is = new ByteArrayInputStream(((SourceInfo) content._cnt)._raw);
final Element root = new SAXBuilder(true, false, true).build(is).getRootElement();
final String name = IDOMs.getRequiredAttributeValue(root, "name");
if (name.length() == 0) {
throw new UiException("The name attribute must be specified, " + root.getLocator() + ", " + path);
}
boolean sourceMapProcessed = false;
int dividedNum = 1;
int pathStartIndex = paths.size();
List<Element> elements = new LinkedList<>();
for (Iterator it = root.getElements().iterator(); it.hasNext();) {
final Element el = (Element) it.next();
final String elnm = el.getName();
if ("widget".equals(elnm)) {
elements.add(el);
} else if ("script".equals(elnm)) {
String sourcemap = el.getAttribute("sourceMap");
if (sourcemap != null && "true".equals(sourcemap)) {
String dividedPath = originalPathPrefix + path.replace(name, name + dividedNum);
if (elements.size() != 0) {
paths.add(dividedPath);
_dividedWpds.put(dividedPath.substring(dividedPath.lastIndexOf("/") + 1), elements);
dividedNum++;
dividedPath = originalPathPrefix + path.replace(name, name + dividedNum);
elements = new LinkedList<>();
}
elements.add(el);
_dividedWpds.put(dividedPath.substring(dividedPath.lastIndexOf("/") + 1), elements);
paths.add(dividedPath);
dividedNum++;
elements = new LinkedList<>(); // clear
sourceMapProcessed = true;
} else {
elements.add(el);
}
} else if ("function".equals(elnm)) {
elements.add(el);
} else {
log.warn("Unknown element " + elnm + ", " + el.getLocator() + ", " + path);
}
}
if (elements.size() != 0) { // any after sourcemap
String dividedPath = originalPathPrefix + path.replace(name, name + dividedNum);
paths.add(dividedPath);
_dividedWpds.put(dividedPath.substring(dividedPath.lastIndexOf("/") + 1), elements);
_dividedPackageCnt.put(name, dividedNum);
} else {
_dividedPackageCnt.put(name, dividedNum - 1);
}
String depends = root.getAttributeValue("depends");
if (depends != null && depends.length() == 0) {
depends = null;
}
if (!"zk".equals(name) && depends == null && sourceMapProcessed) { // handle zkpi isssue (if no depends)
paths.add(pathStartIndex, originalPathPrefix + path.replace(name, name + 0));
paths.add(originalPathPrefix + path.replace(name, name + "$"));
}
return name;
}
private byte[] processDynamicWpdWithSourceMapIfAny(HttpServletRequest request, HttpServletResponse response, String pkgWpd, String path) throws Exception {
List<String> dividedPaths = splitSourceMapJsPathIfAny(path);
StringBuilder sb = new StringBuilder();
int index = 0;
String lastWpd = null;
if (dividedPaths.size() == 0) {
throw new UiException("Failed to load the resource: " + path);
} else if (dividedPaths.size() == 1) {
return null; // only one. just add it.
}
for (String dividedPath : dividedPaths) {
String scriptVariableName = "script" + index++;
sb.append("var ").append(scriptVariableName).append("=document.createElement('script');");
sb.append(scriptVariableName).append(".type='text/javascript';");
String url;
try {
url = Encodes.encodeURL(getServletContext(), request, response, "~." + dividedPath);
} catch (javax.servlet.ServletException ex) {
throw new UiException(ex);
}
sb.append(scriptVariableName).append(".src='").append(url).append("';");
sb.append("\ndocument.getElementsByTagName('head')[0].appendChild(").append(scriptVariableName).append(");");
lastWpd = dividedPath.substring(dividedPath.lastIndexOf("/") + 1);
}
if (!Strings.isEmpty(lastWpd)) {
_lastDynamicWpds.add(lastWpd);
// mark loading
sb.append("\nzk.setLoaded('").append(pkgWpd.replace(".wpd", "")).append("',1);");
}
return sb.toString().getBytes();
}
}