Tiles 2 support back for Spring 4.3 (to be eventually removed for 5.0 now)

Issue: SPR-13229

Author: jhoeller

build.gradle

@@ -71,6 +71,7 @@ configure(allprojects) { project ->
 	ext.snakeyamlVersion     = "1.16"
 	ext.snifferVersion       = "1.14"
 	ext.testngVersion        = "6.9.10"
+	ext.tiles2Version        = "2.2.2"
 	ext.tiles3Version        = "3.0.5"
 	ext.tomcatVersion        = "8.0.30"
 	ext.tyrusVersion         = "1.3.5"  // constrained by WebLogic 12.1.3 support
@@ -945,6 +946,38 @@ project("spring-webmvc") {
 	}
 }
 
+project("spring-webmvc-tiles2") {
+	description = "Spring Framework Tiles2 Integration"
+	merge.into = project(":spring-webmvc")
+
+	dependencies {
+		provided(project(":spring-context"))
+		provided(project(":spring-web"))
+		provided("javax.servlet:javax.servlet-api:3.0.1")
+		optional("javax.servlet.jsp:javax.servlet.jsp-api:2.2.1")
+		optional("javax.servlet.jsp.jstl:javax.servlet.jsp.jstl-api:1.2.1")
+		optional("org.apache.tiles:tiles-api:${tiles2Version}")
+		optional("org.apache.tiles:tiles-core:${tiles2Version}") {
+			exclude group: "org.slf4j", module: "jcl-over-slf4j"
+		}
+		optional("org.apache.tiles:tiles-servlet:${tiles2Version}") {
+			exclude group: "org.slf4j", module: "jcl-over-slf4j"
+		}
+		optional("org.apache.tiles:tiles-jsp:${tiles2Version}") {
+			exclude group: "org.slf4j", module: "jcl-over-slf4j"
+		}
+		optional("org.apache.tiles:tiles-el:${tiles2Version}") {
+			exclude group: "org.slf4j", module: "jcl-over-slf4j"
+		}
+		optional("org.apache.tiles:tiles-extras:${tiles2Version}") {
+			exclude group: "org.slf4j", module: "jcl-over-slf4j"
+			exclude group: "org.apache.velocity", module: "velocity-tools"
+			exclude group: "org.springframework", module: "spring-web"
+		}
+		testCompile("org.slf4j:slf4j-jcl:${slf4jVersion}")
+	}
+}
+
 project("spring-webmvc-portlet") {
 	description = "Spring Web Portlet"
 

settings.gradle

@@ -22,6 +22,7 @@ include "spring-tx"
 include "spring-web"
 include "spring-webmvc"
 include "spring-webmvc-portlet"
+include "spring-webmvc-tiles2"
 include "spring-websocket"
 include "spring-framework-bom"
 

spring-webmvc-tiles2/src/main/java/org/springframework/web/servlet/view/tiles2/AbstractSpringPreparerFactory.java

@@ -0,0 +1,69 @@
+/*
+ * Copyright 2002-2012 the original author or authors.
+ *
+ * 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.
+ */
+
+package org.springframework.web.servlet.view.tiles2;
+
+import org.apache.tiles.TilesException;
+import org.apache.tiles.context.TilesRequestContext;
+import org.apache.tiles.preparer.PreparerFactory;
+import org.apache.tiles.preparer.ViewPreparer;
+
+import org.springframework.web.context.WebApplicationContext;
+import org.springframework.web.servlet.DispatcherServlet;
+
+/**
+ * Abstract implementation of the Tiles {@link org.apache.tiles.preparer.PreparerFactory}
+ * interface, obtaining the current Spring WebApplicationContext and delegating to
+ * {@link #getPreparer(String, org.springframework.web.context.WebApplicationContext)}.
+ *
+ * <p><b>NOTE: Tiles 2 support is deprecated in favor of Tiles 3 and will be removed
+ * as of Spring Framework 5.0.</b>.
+ *
+ * @author Juergen Hoeller
+ * @since 2.5
+ * @see #getPreparer(String, org.springframework.web.context.WebApplicationContext)
+ * @see SimpleSpringPreparerFactory
+ * @see SpringBeanPreparerFactory
+ * @deprecated as of Spring 4.2, in favor of Tiles 3
+ */
+@Deprecated
+public abstract class AbstractSpringPreparerFactory implements PreparerFactory {
+
+	@Override
+	public ViewPreparer getPreparer(String name, TilesRequestContext context) throws TilesException {
+		WebApplicationContext webApplicationContext = (WebApplicationContext) context.getRequestScope().get(
+				DispatcherServlet.WEB_APPLICATION_CONTEXT_ATTRIBUTE);
+		if (webApplicationContext == null) {
+			webApplicationContext = (WebApplicationContext) context.getApplicationContext().getApplicationScope().get(
+					WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE);
+			if (webApplicationContext == null) {
+				throw new IllegalStateException("No WebApplicationContext found: no ContextLoaderListener registered?");
+			}
+		}
+		return getPreparer(name, webApplicationContext);
+	}
+
+	/**
+	 * Obtain a preparer instance for the given preparer name,
+	 * based on the given Spring WebApplicationContext.
+	 * @param name the name of the preparer
+	 * @param context the current Spring WebApplicationContext
+	 * @return the preparer instance
+	 * @throws TilesException in case of failure
+	 */
+	protected abstract ViewPreparer getPreparer(String name, WebApplicationContext context) throws TilesException;
+
+}

spring-webmvc-tiles2/src/main/java/org/springframework/web/servlet/view/tiles2/SimpleSpringPreparerFactory.java

@@ -0,0 +1,76 @@
+/*
+ * Copyright 2002-2012 the original author or authors.
+ *
+ * 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.
+ */
+
+package org.springframework.web.servlet.view.tiles2;
+
+import java.util.Map;
+import java.util.concurrent.ConcurrentHashMap;
+
+import org.apache.tiles.TilesException;
+import org.apache.tiles.preparer.NoSuchPreparerException;
+import org.apache.tiles.preparer.PreparerException;
+import org.apache.tiles.preparer.ViewPreparer;
+
+import org.springframework.web.context.WebApplicationContext;
+
+/**
+ * Tiles {@link org.apache.tiles.preparer.PreparerFactory} implementation
+ * that expects preparer class names and builds preparer instances for those,
+ * creating them through the Spring ApplicationContext in order to apply
+ * Spring container callbacks and configured Spring BeanPostProcessors.
+ *
+ * <p><b>NOTE: Tiles 2 support is deprecated in favor of Tiles 3 and will be removed
+ * as of Spring Framework 5.0.</b>.
+ *
+ * @author Juergen Hoeller
+ * @since 2.5
+ * @see SpringBeanPreparerFactory
+ * @deprecated as of Spring 4.2, in favor of Tiles 3
+ */
+@Deprecated
+public class SimpleSpringPreparerFactory extends AbstractSpringPreparerFactory {
+
+	/** Cache of shared ViewPreparer instances: bean name -> bean instance */
+	private final Map<String, ViewPreparer> sharedPreparers = new ConcurrentHashMap<String, ViewPreparer>(16);
+
+
+	@Override
+	protected ViewPreparer getPreparer(String name, WebApplicationContext context) throws TilesException {
+		// Quick check on the concurrent map first, with minimal locking.
+		ViewPreparer preparer = this.sharedPreparers.get(name);
+		if (preparer == null) {
+			synchronized (this.sharedPreparers) {
+				preparer = this.sharedPreparers.get(name);
+				if (preparer == null) {
+					try {
+						Class<?> beanClass = context.getClassLoader().loadClass(name);
+						if (!ViewPreparer.class.isAssignableFrom(beanClass)) {
+							throw new PreparerException(
+									"Invalid preparer class [" + name + "]: does not implement ViewPreparer interface");
+						}
+						preparer = (ViewPreparer) context.getAutowireCapableBeanFactory().createBean(beanClass);
+						this.sharedPreparers.put(name, preparer);
+					}
+					catch (ClassNotFoundException ex) {
+						throw new NoSuchPreparerException("Preparer class [" + name + "] not found", ex);
+					}
+				}
+			}
+		}
+		return preparer;
+	}
+
+}

spring-webmvc-tiles2/src/main/java/org/springframework/web/servlet/view/tiles2/SpringBeanPreparerFactory.java

@@ -0,0 +1,47 @@
+/*
+ * Copyright 2002-2009 the original author or authors.
+ *
+ * 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.
+ */
+
+package org.springframework.web.servlet.view.tiles2;
+
+import org.apache.tiles.TilesException;
+import org.apache.tiles.preparer.ViewPreparer;
+
+import org.springframework.web.context.WebApplicationContext;
+
+/**
+ * Tiles {@link org.apache.tiles.preparer.PreparerFactory} implementation
+ * that expects preparer bean names and obtains preparer beans from the
+ * Spring ApplicationContext. The full bean creation process will be in
+ * the control of the Spring application context in this case, allowing
+ * for the use of scoped beans etc.
+ *
+ * <p><b>NOTE: Tiles 2 support is deprecated in favor of Tiles 3 and will be removed
+ * as of Spring Framework 5.0.</b>.
+ *
+ * @author Juergen Hoeller
+ * @since 2.5
+ * @see SimpleSpringPreparerFactory
+ * @deprecated as of Spring 4.2, in favor of Tiles 3
+ */
+@Deprecated
+public class SpringBeanPreparerFactory extends AbstractSpringPreparerFactory {
+
+	@Override
+	protected ViewPreparer getPreparer(String name, WebApplicationContext context) throws TilesException {
+		return context.getBean(name, ViewPreparer.class);
+	}
+
+}

spring-webmvc-tiles2/src/main/java/org/springframework/web/servlet/view/tiles2/SpringLocaleResolver.java

@@ -0,0 +1,65 @@
+/*
+ * Copyright 2002-2009 the original author or authors.
+ *
+ * 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.
+ */
+
+package org.springframework.web.servlet.view.tiles2;
+
+import java.util.Locale;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.jsp.PageContext;
+
+import org.apache.tiles.context.TilesRequestContext;
+import org.apache.tiles.jsp.context.JspTilesRequestContext;
+import org.apache.tiles.locale.impl.DefaultLocaleResolver;
+import org.apache.tiles.servlet.context.ServletTilesRequestContext;
+
+import org.springframework.web.servlet.support.RequestContextUtils;
+
+/**
+ * Tiles LocaleResolver adapter that delegates to a Spring
+ * {@link org.springframework.web.servlet.LocaleResolver},
+ * exposing the DispatcherServlet-managed locale.
+ *
+ * <p>This adapter gets automatically registered by {@link TilesConfigurer}.
+ * If you are using standard Tiles bootstrap, specify the name of this class
+ * as value for the init-param "org.apache.tiles.locale.LocaleResolver".
+ *
+ * <p><b>NOTE: Tiles 2 support is deprecated in favor of Tiles 3 and will be removed
+ * as of Spring Framework 5.0.</b>.
+ *
+ * @author Juergen Hoeller
+ * @since 2.5
+ * @see org.apache.tiles.definition.UrlDefinitionsFactory#LOCALE_RESOLVER_IMPL_PROPERTY
+ * @deprecated as of Spring 4.2, in favor of Tiles 3
+ */
+@Deprecated
+public class SpringLocaleResolver extends DefaultLocaleResolver {
+
+	@Override
+	public Locale resolveLocale(TilesRequestContext context) {
+		if (context instanceof JspTilesRequestContext) {
+			PageContext pc = ((JspTilesRequestContext) context).getPageContext();
+			return RequestContextUtils.getLocale((HttpServletRequest) pc.getRequest());
+		}
+		else if (context instanceof ServletTilesRequestContext) {
+			HttpServletRequest request = ((ServletTilesRequestContext) context).getRequest();
+			if (request != null) {
+				return RequestContextUtils.getLocale(request);
+			}
+		}
+		return super.resolveLocale(context);
+	}
+
+}

spring-webmvc-tiles2/src/main/java/org/springframework/web/servlet/view/tiles2/SpringWildcardServletTilesApplicationContext.java

@@ -0,0 +1,77 @@
+/*
+ * Copyright 2002-2014 the original author or authors.
+ *
+ * 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.
+ */
+
+package org.springframework.web.servlet.view.tiles2;
+
+import java.io.IOException;
+import java.net.URL;
+import java.util.LinkedHashSet;
+import java.util.Set;
+import javax.servlet.ServletContext;
+
+import org.apache.tiles.servlet.context.ServletTilesApplicationContext;
+
+import org.springframework.core.io.Resource;
+import org.springframework.core.io.support.ResourcePatternResolver;
+import org.springframework.util.CollectionUtils;
+import org.springframework.util.ObjectUtils;
+import org.springframework.web.context.support.ServletContextResourcePatternResolver;
+
+/**
+ * Spring-specific subclass of the Tiles ServletTilesApplicationContext.
+ *
+ * <p><b>NOTE: Tiles 2 support is deprecated in favor of Tiles 3 and will be removed
+ * as of Spring Framework 5.0.</b>.
+ *
+ * @author Juergen Hoeller
+ * @since 4.0.1
+ * @deprecated as of Spring 4.2, in favor of Tiles 3
+ */
+@Deprecated
+public class SpringWildcardServletTilesApplicationContext extends ServletTilesApplicationContext {
+
+	private final ResourcePatternResolver resolver;
+
+
+	public SpringWildcardServletTilesApplicationContext(ServletContext servletContext) {
+		super(servletContext);
+		this.resolver = new ServletContextResourcePatternResolver(servletContext);
+	}
+
+
+	@Override
+	public URL getResource(String path) throws IOException {
+		Set<URL> urlSet = getResources(path);
+		if (!CollectionUtils.isEmpty(urlSet)) {
+			return urlSet.iterator().next();
+		}
+		return null;
+	}
+
+	@Override
+	public Set<URL> getResources(String path) throws IOException {
+		Set<URL> urlSet = null;
+		Resource[] resources = this.resolver.getResources(path);
+		if (!ObjectUtils.isEmpty(resources)) {
+			urlSet = new LinkedHashSet<URL>(resources.length);
+			for (Resource resource : resources) {
+				urlSet.add(resource.getURL());
+			}
+		}
+		return urlSet;
+	}
+
+}