1 files changed, 140 insertions, 0 deletions
diff --git a/spring-velocity-support/src/main/java/org/apache/velocity/spring/SpringResourceLoader.java b/spring-velocity-support/src/main/java/org/apache/velocity/spring/SpringResourceLoader.java
new file mode 100644
index 00000000..befe4c5b
--- /dev/null
+++ b/spring-velocity-support/src/main/java/org/apache/velocity/spring/SpringResourceLoader.java
@@ -0,0 +1,140 @@
+/*
+ * 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
+ *
+ *      https://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.velocity.spring;
+
+import java.io.IOException;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.util.Arrays;
+
+import org.apache.velocity.exception.ResourceNotFoundException;
+import org.apache.velocity.runtime.resource.Resource;
+import org.apache.velocity.runtime.resource.loader.ResourceLoader;
+
+import org.apache.velocity.util.ExtProperties;
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.util.StringUtils;
+
+/**
+ * Velocity ResourceLoader adapter that loads via a Spring ResourceLoader.
+ * Used by VelocityEngineFactory for any resource loader path that cannot
+ * be resolved to a {@code java.io.File}.
+ *
+ * <p>Note that this loader does not allow for modification detection:
+ * Use Velocity's default FileResourceLoader for {@code java.io.File}
+ * resources.
+ *
+ * <p>Expects "spring.resource.loader" and "spring.resource.loader.path"
+ * application attributes in the Velocity runtime: the former of type
+ * {@code org.springframework.core.io.ResourceLoader}, the latter a String.
+ *
+ * @author Juergen Hoeller
+ * @author Claude Brisson
+ * @since 2020-05-29
+ * @see VelocityEngineFactory#setResourceLoaderPath
+ * @see org.springframework.core.io.ResourceLoader
+ * @see org.apache.velocity.runtime.resource.loader.FileResourceLoader
+ */
+public class SpringResourceLoader extends ResourceLoader {
+
+	public static final String NAME = "spring";
+
+	public static final String SPRING_RESOURCE_LOADER_CLASS = "spring.resource.loader.class";
+
+	public static final String SPRING_RESOURCE_LOADER_CACHE = "spring.resource.loader.cache";
+
+	public static final String SPRING_RESOURCE_LOADER = "spring.resource.loader";
+
+	public static final String SPRING_RESOURCE_LOADER_PATH = "spring.resource.loader.path";
+
+
+	protected final Logger logger = LoggerFactory.getLogger(getClass());
+
+	private org.springframework.core.io.ResourceLoader resourceLoader;
+
+	private String[] resourceLoaderPaths;
+
+
+	@Override
+	public void init(ExtProperties configuration) {
+		this.resourceLoader = (org.springframework.core.io.ResourceLoader)
+				this.rsvc.getApplicationAttribute(SPRING_RESOURCE_LOADER);
+		String resourceLoaderPath = (String) this.rsvc.getApplicationAttribute(SPRING_RESOURCE_LOADER_PATH);
+		if (this.resourceLoader == null) {
+			throw new IllegalArgumentException(
+					"'resourceLoader' application attribute must be present for SpringResourceLoader");
+		}
+		if (resourceLoaderPath == null) {
+			throw new IllegalArgumentException(
+					"'resourceLoaderPath' application attribute must be present for SpringResourceLoader");
+		}
+		this.resourceLoaderPaths = StringUtils.commaDelimitedListToStringArray(resourceLoaderPath);
+		for (int i = 0; i < this.resourceLoaderPaths.length; i++) {
+			String path = this.resourceLoaderPaths[i];
+			if (!path.endsWith("/")) {
+				this.resourceLoaderPaths[i] = path + "/";
+			}
+		}
+		if (logger.isInfoEnabled()) {
+			logger.info("SpringResourceLoader for Velocity: using resource loader [" + this.resourceLoader +
+					"] and resource loader paths " + Arrays.asList(this.resourceLoaderPaths));
+		}
+	}
+
+	/**
+	 * Get the Reader that the Runtime will parse
+	 * to create a template.
+	 *
+	 * @param source resource name
+	 * @param encoding resource encoding
+	 * @return The reader for the requested resource.
+	 * @throws ResourceNotFoundException
+	 * @since 2.0
+	 */
+	@Override
+	public Reader getResourceReader(String source, String encoding) throws ResourceNotFoundException {
+		if (logger.isDebugEnabled()) {
+			logger.debug("Looking for Velocity resource with name [" + source + "]");
+		}
+		for (String resourceLoaderPath : this.resourceLoaderPaths) {
+			org.springframework.core.io.Resource resource =
+					this.resourceLoader.getResource(resourceLoaderPath + source);
+			try {
+				return new InputStreamReader(resource.getInputStream(), encoding);
+			}
+			catch (IOException ex) {
+				if (logger.isDebugEnabled()) {
+					logger.debug("Could not find Velocity resource: " + resource);
+				}
+			}
+		}
+		throw new ResourceNotFoundException(
+				"Could not find resource [" + source + "] in Spring resource loader path");
+	}
+
+	@Override
+	public boolean isSourceModified(Resource resource) {
+		return false;
+	}
+
+	@Override
+	public long getLastModified(Resource resource) {
+		return 0;
+	}
+
+}