Add RequestDataValueProcessor in spring-web-reactive

rstoyanchev · rstoyanchev · commit 4a380b840192 · 2016-12-27T17:42:01.000-05:00
Issue: SPR-15001
diff --git a/spring-web-reactive/src/main/java/org/springframework/web/reactive/result/view/AbstractView.java b/spring-web-reactive/src/main/java/org/springframework/web/reactive/result/view/AbstractView.java
@@ -41,6 +41,10 @@
  */
 public abstract class AbstractView implements View, ApplicationContextAware {
 
+	/** Well-known name for the RequestDataValueProcessor in the bean factory. */
+	public static final String REQUEST_DATA_VALUE_PROCESSOR_BEAN_NAME = "requestDataValueProcessor";
+
+
 	/** Logger that is available to subclasses */
 	protected final Log logger = LogFactory.getLog(getClass());
 
@@ -179,7 +183,21 @@ protected Map<String, Object> getModelAttributes(Map<String, ?> model, ServerWeb
 	 * @see #setRequestContextAttribute
 	 */
 	protected RequestContext createRequestContext(ServerWebExchange exchange, Map<String, Object> model) {
-		return new RequestContext(exchange, model, this.applicationContext);
+		return new RequestContext(exchange, model, getApplicationContext(), getRequestDataValueProcessor());
+	}
+
+	/**
+	 * Return the {@link RequestDataValueProcessor} to use.
+	 * <p>The default implementation looks in the {@link #getApplicationContext()
+	 * Spring configuration} for a {@code RequestDataValueProcessor} bean with
+	 * the name {@link #REQUEST_DATA_VALUE_PROCESSOR_BEAN_NAME}.
+	 */
+	protected RequestDataValueProcessor getRequestDataValueProcessor() {
+		if (getApplicationContext() != null) {
+			String beanName = REQUEST_DATA_VALUE_PROCESSOR_BEAN_NAME;
+			return getApplicationContext().getBean(beanName, RequestDataValueProcessor.class);
+		}
+		return null;
 	}
 
 	/**
diff --git a/spring-web-reactive/src/main/java/org/springframework/web/reactive/result/view/RedirectView.java b/spring-web-reactive/src/main/java/org/springframework/web/reactive/result/view/RedirectView.java
@@ -186,8 +186,10 @@ protected Mono<Void> renderInternal(Map<String, Object> model, MediaType content
 	}
 
 	/**
-	 * Create the target URL if necessary pre-pending the contextPath, expanding
-	 * URI template variables, and appending the current request query.
+	 * Create the target URL and, if necessary, pre-pend the contextPath, expand
+	 * URI template variables, append the current request query, and apply the
+	 * configured {@link #getRequestDataValueProcessor()
+	 * RequestDataValueProcessor}.
 	 */
 	protected final String createTargetUrl(Map<String, Object> model, ServerWebExchange exchange) {
 
@@ -206,7 +208,10 @@ protected final String createTargetUrl(Map<String, Object> model, ServerWebExcha
 			targetUrl = appendCurrentRequestQuery(targetUrl.toString(), exchange.getRequest());
 		}
 
-		return targetUrl.toString();
+		String result = targetUrl.toString();
+
+		RequestDataValueProcessor processor = getRequestDataValueProcessor();
+		return (processor != null ? processor.processUrl(exchange, result) : result);
 	}
 
 	@SuppressWarnings("unchecked")
diff --git a/spring-web-reactive/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java b/spring-web-reactive/src/main/java/org/springframework/web/reactive/result/view/RequestContext.java
@@ -57,29 +57,37 @@ public class RequestContext {
 
 	private final MessageSource messageSource;
 
+	private Locale locale;
+
+	private TimeZone timeZone;
+
 	private Boolean defaultHtmlEscape;
 
 	private Map<String, Errors> errorsMap;
 
-	private Locale locale;
+	private RequestDataValueProcessor dataValueProcessor;
 
-	private TimeZone timeZone;
 
+	public RequestContext(ServerWebExchange exchange, Map<String, Object> model, MessageSource messageSource) {
+		this(exchange, model, messageSource, null);
+	}
 
-	public RequestContext(ServerWebExchange exchange, Map<String, Object> model,
-			MessageSource messageSource) {
+	public RequestContext(ServerWebExchange exchange, Map<String, Object> model, MessageSource messageSource,
+			RequestDataValueProcessor dataValueProcessor) {
 
 		Assert.notNull(exchange, "'exchange' is required");
 		Assert.notNull(model, "'model' is required");
 		Assert.notNull(messageSource, "'messageSource' is required");
 		this.exchange = exchange;
 		this.model = model;
 		this.messageSource = messageSource;
-		this.defaultHtmlEscape = null; // TODO
 
 		Locale acceptLocale = exchange.getRequest().getHeaders().getAcceptLanguageAsLocale();
 		this.locale = acceptLocale != null ? acceptLocale : Locale.getDefault();
 		this.timeZone = TimeZone.getDefault(); // TODO
+
+		this.defaultHtmlEscape = null; // TODO
+		this.dataValueProcessor = dataValueProcessor;
 	}
 
 
@@ -158,6 +166,14 @@ public Boolean getDefaultHtmlEscape() {
 		return this.defaultHtmlEscape;
 	}
 
+	/**
+	 * Return the {@link RequestDataValueProcessor} instance to apply to in form
+	 * tag libraries and to redirect URLs.
+	 */
+	public Optional<RequestDataValueProcessor> getRequestDataValueProcessor() {
+		return Optional.ofNullable(this.dataValueProcessor);
+	}
+
 	/**
 	 * Return the context path of the the current web application. This is
 	 * useful for building links to other resources within the application.
diff --git a/spring-web-reactive/src/main/java/org/springframework/web/reactive/result/view/RequestDataValueProcessor.java b/spring-web-reactive/src/main/java/org/springframework/web/reactive/result/view/RequestDataValueProcessor.java
@@ -0,0 +1,74 @@
+/*
+ * Copyright 2002-2016 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.reactive.result.view;
+
+import java.util.Map;
+
+import org.springframework.web.server.ServerWebExchange;
+
+/**
+ * A contract for inspecting and potentially modifying request data values such
+ * as URL query parameters or form field values before they are rendered by a
+ * view or before a redirect.
+ *
+ * <p>Implementations may use this contract for example as part of a solution
+ * to provide data integrity, confidentiality, protection against cross-site
+ * request forgery (CSRF), and others or for other tasks such as automatically
+ * adding a hidden field to all forms and URLs.
+ *
+ * <p>View technologies that support this contract can obtain an instance to
+ * delegate to via {@link RequestContext#getRequestDataValueProcessor()}.
+ *
+ * @author Rossen Stoyanchev
+ * @since 5.0
+ */
+public interface RequestDataValueProcessor {
+
+	/**
+	 * Invoked when a new form action is rendered.
+	 * @param exchange the current exchange
+	 * @param action the form action
+	 * @param httpMethod the form HTTP method
+	 * @return the action to use, possibly modified
+	 */
+	String processAction(ServerWebExchange exchange, String action, String httpMethod);
+
+	/**
+	 * Invoked when a form field value is rendered.
+	 * @param exchange the current exchange
+	 * @param name the form field name
+	 * @param value the form field value
+	 * @param type the form field type ("text", "hidden", etc.)
+	 * @return the form field value to use, possibly modified
+	 */
+	String processFormFieldValue(ServerWebExchange exchange, String name, String value, String type);
+
+	/**
+	 * Invoked after all form fields have been rendered.
+	 * @param exchange the current exchange
+	 * @return additional hidden form fields to be added, or {@code null}
+	 */
+	Map<String, String> getExtraHiddenFields(ServerWebExchange exchange);
+
+	/**
+	 * Invoked when a URL is about to be rendered or redirected to.
+	 * @param exchange the current exchange
+	 * @param url the URL value
+	 * @return the URL to use, possibly modified
+	 */
+	String processUrl(ServerWebExchange exchange, String url);
+
+}
