Merge pull request #566 from apache/WW-5185-struts-resource

[WW-5185] Reintroduces proper implementation of Tiles resource to support wildcard matching of Tiles definitions

Author: yasserzamani

apps/rest-showcase/src/main/webapp/WEB-INF/web.xml

@@ -19,13 +19,14 @@
  * under the License.
  */
 -->
-<web-app id="starter" version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
+<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
+         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
+         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
+         version="3.1">
 
     <display-name>Struts 2 Rest Example</display-name>
 
-
     <!-- Filters -->
     <!-- START SNIPPET: filter -->
     <filter>

apps/showcase/src/main/webapp/WEB-INF/web.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <!--
+/*
  * 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
@@ -16,20 +17,16 @@
  * KIND, either express or implied.  See the License for the
  * specific language governing permissions and limitations
  * under the License.
+ */
 -->
-<web-app id="starter" version="2.5" xmlns="http://java.sun.com/xml/ns/javaee"
+<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
+         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee
+         http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
+         version="3.1">
 
     <display-name>Struts Showcase Application</display-name>
 
-    <context-param>
-        <param-name>org.apache.tiles.definition.DefinitionsFactory.DEFINITIONS_CONFIG</param-name>
-        <param-value>
-            /WEB-INF/tiles.xml
-        </param-value>
-    </context-param>
-
     <filter>
         <filter-name>async</filter-name>
         <filter-class>org.apache.struts2.showcase.async.AsyncFilter</filter-class>
@@ -46,11 +43,10 @@
         <filter-class>org.apache.struts2.dispatcher.filter.StrutsExecuteFilter</filter-class>
     </filter>
 
-
-   <filter>
-       <filter-name>sitemesh</filter-name>
-       <filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>
-   </filter>
+    <filter>
+        <filter-name>sitemesh</filter-name>
+        <filter-class>com.opensymphony.sitemesh.webapp.SiteMeshFilter</filter-class>
+    </filter>
 
     <filter-mapping>
         <filter-name>async</filter-name>
@@ -81,18 +77,18 @@
             org.apache.struts2.tiles.StrutsTilesListener
         </listener-class>
     </listener>
-    
+
     <!-- Chat Example in Showcase -->
     <listener>
-    	<listener-class>
-    	  org.apache.struts2.showcase.chat.ChatSessionListener
-    	</listener-class>
+        <listener-class>
+            org.apache.struts2.showcase.chat.ChatSessionListener
+        </listener-class>
     </listener>
 
     <listener>
         <listener-class>org.apache.struts2.dispatcher.listener.StrutsListener</listener-class>
     </listener>
-	
+
     <!-- SNIPPET START: dwr -->
 
     <servlet>
@@ -103,13 +99,13 @@
             <param-value>true</param-value>
         </init-param>
     </servlet>
-	<servlet>
-    	<servlet-name>JspSupportServlet</servlet-name>
-    	<servlet-class>org.apache.struts2.views.JspSupportServlet</servlet-class>
-    	<load-on-startup>1</load-on-startup>
-  	</servlet>
+    <servlet>
+        <servlet-name>JspSupportServlet</servlet-name>
+        <servlet-class>org.apache.struts2.views.JspSupportServlet</servlet-class>
+        <load-on-startup>1</load-on-startup>
+    </servlet>
 
-      <!-- Sitemesh Freemarker and Velocity Decorator Servlets. Shares configuration with Struts.-->
+    <!-- Sitemesh Freemarker and Velocity Decorator Servlets. Shares configuration with Struts.-->
     <servlet>
         <servlet-name>sitemesh-freemarker</servlet-name>
         <servlet-class>org.apache.struts2.sitemesh.FreemarkerDecoratorServlet</servlet-class>

plugins/tiles/src/main/java/org/apache/struts2/tiles/StrutsApplicationResource.java

@@ -0,0 +1,82 @@
+/*
+ * 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.struts2.tiles;
+
+import org.apache.tiles.request.locale.PostfixedApplicationResource;
+import org.apache.tiles.request.locale.URLApplicationResource;
+
+import java.io.File;
+import java.io.IOException;
+import java.io.InputStream;
+import java.net.URI;
+import java.net.URL;
+
+public class StrutsApplicationResource extends PostfixedApplicationResource {
+
+    private final URL url;
+    private final File file;
+
+    /**
+     * fixes WW-5011
+     * @return file path for "file" protocol elsewhere url path as before to keep backward-compatibility
+     * @see URLApplicationResource#getFile(URL)
+     */
+    private static String getFilePath(URL url) {
+        String path = url.getPath();
+        if (!"file".equals(url.getProtocol())) {
+            return path;
+        }
+        try {
+            // fixes WW-5011 because includes ref in path - like URLApplicationResource#getFile(URL)
+            path = (new URI(url.toExternalForm())).getSchemeSpecificPart();
+        } catch (Exception e) {
+            // fallback solution
+            if (url.getRef() != null && !new File(path).exists()) {
+                // it's like WW-5011
+                path += "#" + url.getRef();
+            }
+        }
+
+        return path;
+    }
+
+    public StrutsApplicationResource(URL url) {
+        super(getFilePath(url));
+        this.url = url;
+        this.file = new File(getFilePath(url));
+    }
+
+    @Override
+    public InputStream getInputStream() throws IOException {
+        return url.openStream();
+    }
+
+    @Override
+    public long getLastModified() throws IOException {
+        if (file.exists()) {
+            return file.lastModified();
+        }
+        return 0;
+    }
+
+    @Override
+    public String toString() {
+        return "Resource " + getLocalePath() + " at " + url.toString();
+    }
+}

plugins/tiles/src/main/java/org/apache/struts2/tiles/StrutsWildcardServletApplicationContext.java

@@ -102,7 +102,7 @@ public ApplicationResource getResource(ApplicationResource base, Locale locale)
         File localFile = new File(localePath);
         if (localFile.exists()) {
             try {
-                return new URLApplicationResource(localePath, localFile.toURI().toURL());
+                return new StrutsApplicationResource(localFile.toURI().toURL());
             } catch (MalformedURLException e) {
                 LOG.warn("Cannot access [{}]", localePath, e);
                 return null;
@@ -121,8 +121,7 @@ protected Set<ApplicationResource> findResources(String path) throws IOException
 
         for (Map.Entry<String, URL> entry : matches.entrySet()) {
             if (pattern.matcher(entry.getKey()).matches()) {
-                URL url = entry.getValue();
-                resources.add(new URLApplicationResource(url.toExternalForm(), url));
+                resources.add(new StrutsApplicationResource(entry.getValue()));
             }
         }