org.zkoss.web.util.resource.dir"
m (correct highlight (via JWB)) |
|||
| Line 16: | Line 16: | ||
[Since 5.0.0] | [Since 5.0.0] | ||
| − | It specifies a directory, where ZK will load the so-called Class-Web Resources (CWR), in addition to the class path. CWR includes JavaScript files, CSS files, and other resources that are specified in the form of < | + | It specifies a directory, where ZK will load the so-called Class-Web Resources (CWR), in addition to the class path. CWR includes JavaScript files, CSS files, and other resources that are specified in the form of <code>~./xxx</code>. |
By default, ZK only searches the class path for the required CWR. By specifying a directory here, ZK will search the directory first and then the class path. This implies that a developer can override the default behavior by providing a file with the same name. | By default, ZK only searches the class path for the required CWR. By specifying a directory here, ZK will search the directory first and then the class path. This implies that a developer can override the default behavior by providing a file with the same name. | ||
| Line 22: | Line 22: | ||
Notice: never put security sensitive files in the directory specified here, since they can be accessed externally. | Notice: never put security sensitive files in the directory specified here, since they can be accessed externally. | ||
| − | For example, assuming that we have a JavaScript package called < | + | For example, assuming that we have a JavaScript package called <code>foo.great</code> and we want to put it to <code>WEB-INF/cwr</code>, we have to specify the following in <code>WEB-INF/zk.xml</code>: |
<source lang="xml"> | <source lang="xml"> | ||
| Line 31: | Line 31: | ||
</source> | </source> | ||
| − | You can place < | + | You can place <code>zk.wpd</code> and the required JavaScript files under the <code>WEB-INF/cwr/js/foo/great</code> directory. |
= Overriding JavaScript Files in a JAR= | = Overriding JavaScript Files in a JAR= | ||
| Line 47: | Line 47: | ||
== Overriding with Classpath Web Resource Path == | == Overriding with Classpath Web Resource Path == | ||
| − | ZK loads the source file under the classpath web resource path, '''< | + | ZK loads the source file under the classpath web resource path, '''<code>WEB-INF/classes/web/js</code>''', as the first priority. So that you can put javascript files here to override the files in a jar under the corresponding path. The picture below demonstrates to override javascript files under <code>zkcharts.jar/web/js/chart/ext</code>: |
[[File:overrideByClasspathWebResourcePath.png | center]] | [[File:overrideByClasspathWebResourcePath.png | center]] | ||
{{ZKConfigurationReferencePageFooter}} | {{ZKConfigurationReferencePageFooter}} | ||
Revision as of 10:19, 19 January 2022
IMPORTANT
Before enabling this feature upgrade to the latest available versions (older versions contain a critical security vulnerability).
The latest versions containing a fix are:
- for CE users 8.0.2.2 or later downloads
- for PE/EE users 6.5.8.2, 7.0.8.1, 8.0.2.2, 8.0.3.1 or later premium downloads
Property:
org.zkoss.web.util.resource.dir
Applicable:globally in zk.xml via <library-property>
not as <custom-attribute>
Default: none [Since 5.0.0]
It specifies a directory, where ZK will load the so-called Class-Web Resources (CWR), in addition to the class path. CWR includes JavaScript files, CSS files, and other resources that are specified in the form of ~./xxx.
By default, ZK only searches the class path for the required CWR. By specifying a directory here, ZK will search the directory first and then the class path. This implies that a developer can override the default behavior by providing a file with the same name.
Notice: never put security sensitive files in the directory specified here, since they can be accessed externally.
For example, assuming that we have a JavaScript package called foo.great and we want to put it to WEB-INF/cwr, we have to specify the following in WEB-INF/zk.xml:
<library-property>
<name>org.zkoss.web.util.resource.dir</name>
<value>/WEB-INF/cwr</value>
</library-property>
You can place zk.wpd and the required JavaScript files under the WEB-INF/cwr/js/foo/great directory.
Overriding JavaScript Files in a JAR
Though rarely needed, sometimes you might need to override a JavaScript file of a JAR file with this option. One example is that you don't have to re-package zul.jar when replacing zul/inp/Textbox.js that is part of zul.jar.
Rather, you could specify this library property as described above, and place the modified version of Textbox.js under the /WEB-INF/cwr/js/zul/inp directory. Then, ZK will load /WEB-INF/cwr/js/zul/inp/Textbox.js you placed rather than the default one in zul.jar.
debug-js enabled
Notice that if debug-js is turned on, ZK will actually look for Textbox.src.js rather than Textbox.js in the above example. Thus, it is suggested to put both files:
Textbox.src.jsTextbox.js
into the /WEB-INF/cwr/js/zul/inp directories. In addition, Textbox.src.js is suggested to be the readable one (for debugging purpose), while Textbox.js is the compressed one (for production purpose).
Overriding with Classpath Web Resource Path
ZK loads the source file under the classpath web resource path, WEB-INF/classes/web/js, as the first priority. So that you can put javascript files here to override the files in a jar under the corresponding path. The picture below demonstrates to override javascript files under zkcharts.jar/web/js/chart/ext:
