Author: markt
Date: Mon Sep 16 13:11:40 2013
New Revision: 1523628
URL: http://svn.apache.org/r1523628
Log:
Create JarWarResourceSet as a copy of JarResourceSet and modify
StandardRoot to use it when appropriate.
Added:
tomcat/trunk/java/org/apache/catalina/webresources/JarWarResourceSet.java
Modified:
tomcat/trunk/java/org/apache/catalina/webresources/StandardRoot.java
Added: tomcat/trunk/java/org/apache/catalina/webresources/JarWarResourceSet.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/webresources/JarWarResourceSet.java?rev=1523628&view=auto
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/webresources/JarWarResourceSet.java
(added)
+++ tomcat/trunk/java/org/apache/catalina/webresources/JarWarResourceSet.java
Mon Sep 16 13:11:40 2013
@@ -0,0 +1,282 @@
+/*
+ * 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.apache.catalina.webresources;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.MalformedURLException;
+import java.util.ArrayList;
+import java.util.Enumeration;
+import java.util.HashMap;
+import java.util.Iterator;
+import java.util.Set;
+import java.util.jar.JarEntry;
+import java.util.jar.JarFile;
+
+import org.apache.catalina.LifecycleException;
+import org.apache.catalina.WebResource;
+import org.apache.catalina.WebResourceRoot;
+import org.apache.catalina.util.ResourceSet;
+
+/**
+ * Represents a {@link org.apache.catalina.WebResourceSet} based on a JAR file
+ * that is nested inside a packed WAR file. This is only intended for internal
+ * use within Tomcat and therefore cannot be created via configuration.
+ */
+public class JarWarResourceSet extends AbstractResourceSet {
+
+ private final String archivePath;
+ private HashMap<String,JarEntry> jarFileEntries = new HashMap<>();
+ private String baseUrl;
+
+ /**
+ * Creates a new {@link org.apache.catalina.WebResourceSet} based on a JAR
+ * file that is nested inside a WAR.
+ *
+ * @param root The {@link WebResourceRoot} this new
+ * {@link org.apache.catalina.WebResourceSet} will
+ * be added to.
+ * @param webAppMount The path within the web application at which this
+ * {@link org.apache.catalina.WebResourceSet} will
+ * be mounted.
+ * @param base The absolute path to the WAR file on the file
system
+ * in which the JAR is located.
+ * @param archivePath The path within the WAR file where the JAR file is
+ * located.
+ * @param internalPath The path within this new {@link
+ * org.apache.catalina.WebResourceSet} where
+ * resources will be served from. E.g. for a
+ * resource JAR, this would be
"META-INF/resources"
+ */
+ public JarWarResourceSet(WebResourceRoot root, String webAppMount,
+ String base, String archivePath, String internalPath)
+ throws IllegalArgumentException {
+ setRoot(root);
+ setWebAppMount(webAppMount);
+ setBase(base);
+ this.archivePath = archivePath;
+ setInternalPath(internalPath);
+
+ if (getRoot().getState().isAvailable()) {
+ try {
+ start();
+ } catch (LifecycleException e) {
+ throw new IllegalStateException(e);
+ }
+ }
+ }
+
+ @Override
+ public WebResource getResource(String path) {
+ checkPath(path);
+ String webAppMount = getWebAppMount();
+ WebResourceRoot root = getRoot();
+
+ /*
+ * Implementation notes
+ *
+ * The path parameter passed into this method always starts with '/'.
+ *
+ * The path parameter passed into this method may or may not end with a
+ * '/'. JarFile.getEntry() will return a matching directory entry
+ * whether or not the name ends in a '/'. However, if the entry is
+ * requested without the '/' subsequent calls to JarEntry.isDirectory()
+ * will return false.
+ *
+ * Paths in JARs never start with '/'. Leading '/' need to be removed
+ * before any JarFile.getEntry() call.
+ */
+
+ // If the JAR has been mounted below the web application root, return
+ // an empty resource for requests outside of the mount point.
+
+ if (path.startsWith(webAppMount)) {
+ String pathInJar = getInternalPath() + path.substring(
+ webAppMount.length(), path.length());
+ // Always strip off the leading '/' to get the JAR path
+ if (pathInJar.charAt(0) == '/') {
+ pathInJar = pathInJar.substring(1);
+ }
+ if (pathInJar.equals("")) {
+ // Special case
+ return new JarResourceRoot(root, new File(getBase()),
+ pathInJar, path);
+ } else {
+ JarEntry jarEntry = null;
+ if (!(pathInJar.charAt(pathInJar.length() - 1) == '/')) {
+ jarEntry = jarFileEntries.get(pathInJar + '/');
+ if (jarEntry != null) {
+ path = path + '/';
+ }
+ }
+ if (jarEntry == null) {
+ jarEntry = jarFileEntries.get(pathInJar);
+ }
+ if (jarEntry == null) {
+ return new EmptyResource(root, path);
+ } else {
+ return new JarResource(root, getBase(), baseUrl, jarEntry,
+ getInternalPath(), path);
+ }
+ }
+ } else {
+ return new EmptyResource(root, path);
+ }
+ }
+
+ @Override
+ public String[] list(String path) {
+ checkPath(path);
+ String webAppMount = getWebAppMount();
+
+ ArrayList<String> result = new ArrayList<>();
+ if (path.startsWith(webAppMount)) {
+ String pathInJar =
+ getInternalPath() + path.substring(webAppMount.length());
+ // Always strip off the leading '/' to get the JAR path
+ if (pathInJar.charAt(0) == '/') {
+ pathInJar = pathInJar.substring(1);
+ }
+ Iterator<String> entries = jarFileEntries.keySet().iterator();
+ while (entries.hasNext()) {
+ String name = entries.next();
+ if (name.length() > pathInJar.length() &&
+ name.startsWith(pathInJar)) {
+ if (name.charAt(name.length() - 1) == '/') {
+ name = name.substring(
+ pathInJar.length(), name.length() - 1);
+ } else {
+ name = name.substring(pathInJar.length());
+ }
+ if (name.length() == 0) {
+ continue;
+ }
+ if (name.charAt(0) == '/') {
+ name = name.substring(1);
+ }
+ if (name.length() > 0 && name.lastIndexOf('/') == -1) {
+ result.add(name);
+ }
+ }
+ }
+ } else {
+ if (!path.endsWith("/")) {
+ path = path + "/";
+ }
+ if (webAppMount.startsWith(path)) {
+ int i = webAppMount.indexOf('/', path.length());
+ if (i == -1) {
+ return new String[] {webAppMount.substring(path.length())};
+ } else {
+ return new String[] {
+ webAppMount.substring(path.length(), i)};
+ }
+ }
+ }
+ return result.toArray(new String[result.size()]);
+ }
+
+ @Override
+ public Set<String> listWebAppPaths(String path) {
+ checkPath(path);
+ String webAppMount = getWebAppMount();
+
+ ResourceSet<String> result = new ResourceSet<>();
+ if (path.startsWith(webAppMount)) {
+ String pathInJar =
+ getInternalPath() + path.substring(webAppMount.length());
+ // Always strip off the leading '/' to get the JAR path and make
+ // sure it ends in '/'
+ if (pathInJar.charAt(pathInJar.length() - 1) != '/') {
+ pathInJar = pathInJar.substring(1) + '/';
+ }
+ if (pathInJar.charAt(0) == '/') {
+ pathInJar = pathInJar.substring(1);
+ }
+
+ Iterator<String> entries = jarFileEntries.keySet().iterator();
+ while (entries.hasNext()) {
+ String name = entries.next();
+ if (name.length() > pathInJar.length() &&
+ name.startsWith(pathInJar)) {
+ int nextSlash = name.indexOf('/', pathInJar.length());
+ if (nextSlash == -1 || nextSlash == name.length() - 1) {
+ if (name.startsWith(pathInJar)) {
+ result.add(webAppMount + '/' +
+
name.substring(getInternalPath().length()));
+ }
+ }
+ }
+ }
+ } else {
+ if (!path.endsWith("/")) {
+ path = path + "/";
+ }
+ if (webAppMount.startsWith(path)) {
+ int i = webAppMount.indexOf('/', path.length());
+ if (i == -1) {
+ result.add(webAppMount + "/");
+ } else {
+ result.add(webAppMount.substring(0, i + 1));
+ }
+ }
+ }
+ result.setLocked(true);
+ return result;
+ }
+
+ @Override
+ public boolean mkdir(String path) {
+ checkPath(path);
+
+ return false;
+ }
+
+ @Override
+ public boolean write(String path, InputStream is, boolean overwrite) {
+ checkPath(path);
+
+ if (is == null) {
+ throw new NullPointerException(
+ sm.getString("dirResourceSet.writeNpe"));
+ }
+
+ return false;
+ }
+
+ //-------------------------------------------------------- Lifecycle
methods
+ @Override
+ protected void initInternal() throws LifecycleException {
+
+ try (JarFile jarFile = new JarFile(getBase())) {
+ Enumeration<JarEntry> entries = jarFile.entries();
+ while (entries.hasMoreElements()) {
+ JarEntry entry = entries.nextElement();
+ jarFileEntries.put(entry.getName(), entry);
+ }
+ } catch (IOException ioe) {
+ throw new IllegalArgumentException(ioe);
+ }
+
+ try {
+ this.baseUrl = (new File(getBase())).toURI().toURL().toString();
+ } catch (MalformedURLException e) {
+ throw new IllegalArgumentException(e);
+ }
+ }
+}
Modified: tomcat/trunk/java/org/apache/catalina/webresources/StandardRoot.java
URL:
http://svn.apache.org/viewvc/tomcat/trunk/java/org/apache/catalina/webresources/StandardRoot.java?rev=1523628&r1=1523627&r2=1523628&view=diff
==============================================================================
--- tomcat/trunk/java/org/apache/catalina/webresources/StandardRoot.java
(original)
+++ tomcat/trunk/java/org/apache/catalina/webresources/StandardRoot.java Mon
Sep 16 13:11:40 2013
@@ -264,7 +264,11 @@ public class StandardRoot extends Lifecy
File file = new File(base);
if (file.isFile()) {
- if (file.getName().toLowerCase(Locale.ENGLISH).endsWith(".jar")) {
+ if (archivePath != null) {
+ // Must be a JAR nested inside a WAR if archivePath is non-null
+ resourceSet = new JarWarResourceSet(this, webAppMount, base,
+ archivePath, internalPath);
+ } else if
(file.getName().toLowerCase(Locale.ENGLISH).endsWith(".jar")) {
resourceSet = new JarResourceSet(this, base, webAppMount,
internalPath);
} else {
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
