Views has been ported from JSP to Thymeleaf.

Fix GH #17

Author: php-coder

NEWS.txt

@@ -1,4 +1,6 @@
 0.3 (not released yet)
+- views has been ported from JSP to Thymeleaf
+- rejection of Apache Tiles
 - implemented sending of mail with activation key
 - started using feature flags with Togglz
 - added localization support for countries

pom.xml

@@ -26,13 +26,13 @@
 		<javax.mail.version>1.5.2</javax.mail.version>
 		<javax.persistence.version>1.0.1.Final</javax.persistence.version>
 		<servlet.api.version>3.0.20100224</servlet.api.version>
-		<jstl.version>1.2</jstl.version>
 		<commons.lang.version>3.3.2</commons.lang.version>
 		<commons.beanutils.version>1.9.2</commons.beanutils.version>
 		<commons.io.version>2.4</commons.io.version>
 		<commons.collections.version>3.2.1</commons.collections.version>
 		<commons.dbcp.version>1.4</commons.dbcp.version>
-		<tiles.version>2.2.2</tiles.version>
+		<thymeleaf.version>2.1.3.RELEASE</thymeleaf.version>
+		<thymeleaf.security.version>2.1.1.RELEASE</thymeleaf.security.version>
 		<liquibase.version>3.2.0</liquibase.version>
 		<liquibase.slf4j.version>1.2.1</liquibase.slf4j.version>
 		<togglz.version>2.0.1.Final</togglz.version>
@@ -86,13 +86,6 @@
 			<scope>provided</scope>
 		</dependency>
 
-		<dependency>
-			<groupId>javax.servlet</groupId>
-			<artifactId>jstl</artifactId>
-			<version>${jstl.version}</version>
-			<scope>runtime</scope>
-		</dependency>
-		
 		<!-- @Inject -->
 		<dependency>
 			<groupId>javax.inject</groupId>
@@ -183,13 +176,6 @@
 			<scope>runtime</scope>
 		</dependency>
 
-		<dependency>
-			<groupId>org.springframework.security</groupId>
-			<artifactId>spring-security-taglibs</artifactId>
-			<version>${spring.security.version}</version>
-			<scope>runtime</scope>
-		</dependency>
-		
 		<dependency>
 			<groupId>org.hibernate</groupId>
 			<artifactId>hibernate-core</artifactId>
@@ -238,14 +224,18 @@
 			<scope>test</scope>
 		</dependency>
 
-		<!-- For Tiles template engine -->
 		<dependency>
-			<groupId>org.apache.tiles</groupId>
-			<artifactId>tiles-jsp</artifactId>
-			<version>${tiles.version}</version>
-			<scope>runtime</scope>
+			<groupId>org.thymeleaf</groupId>
+			<artifactId>thymeleaf-spring3</artifactId>
+			<version>${thymeleaf.version}</version>
 		</dependency>
 
+		<dependency>
+			<groupId>org.thymeleaf.extras</groupId>
+			<artifactId>thymeleaf-extras-springsecurity3</artifactId>
+			<version>${thymeleaf.security.version}</version>
+		</dependency>
+				
 		<!-- For running database migration during application's startup time -->
 		<dependency>
 			<groupId>org.liquibase</groupId>

src/main/config/checkstyle-suppressions.xml

@@ -7,6 +7,7 @@
 
 	<suppress checks="LineLength" files="AbstractPageWithForm.java" lines="27,28,33" />
 	<suppress checks="LineLength" files="Form.java" lines="31,32,37" />
+	<suppress checks="LineLength" files="Url.java" lines="70" />
 
 	<!-- false positives due to Lombok usage -->
 	<suppress checks="HideUtilityClassConstructor" files="ru.mystamps.web.model" />

src/main/config/pmd.xml

@@ -9,7 +9,6 @@
 
 	<!-- For rules description see http://pmd.sourceforge.net/rules/index.html -->
 
-	<rule ref="rulesets/jsp/basic.xml" />
 	<rule ref="rulesets/java/design.xml">
 		<exclude name="ImmutableField" />
 	</rule>

src/main/config/test-override-web.xml

@@ -12,16 +12,6 @@
 		<param-value>test</param-value>
 	</context-param>
 
-	<servlet id="jsp">
-		<servlet-name>jsp</servlet-name>
-		<servlet-class>org.apache.jasper.servlet.JspServlet</servlet-class>
-		<!-- Check for JSP modification on every access -->
-		<init-param>
-			<param-name>development</param-name>
-			<param-value>true</param-value>
-		</init-param>
-	</servlet>
-	
 	<!--
 		Web console for managing H2 database.
 		

src/main/java/ru/mystamps/web/Url.java

@@ -17,6 +17,9 @@
  */
 package ru.mystamps.web;
 
+import java.util.HashMap;
+import java.util.Map;
+
 import ru.mystamps.web.service.ImageService;
 
 /**
@@ -60,7 +63,40 @@ public final class Url {
 	public static final String UNAUTHORIZED_PAGE     = "/error/401";
 	public static final String NOT_FOUND_PAGE        = "/error/404";
 
+	// resources
+	public static final String FAVICON_ICO            = "/favicon.ico";
+	public static final String MAIN_CSS               = "/static/styles/main.css";
+	public static final String BOOTSTRAP_CSS          = "/public/bootstrap/css/bootstrap.min.css";
+	public static final String BOOTSTRAP_RESPONSIVE_CSS = "/public/bootstrap/css/bootstrap-responsive.min.css";
+	public static final String BOOTSTRAP_JS           = "/public/bootstrap/js/bootstrap.min.js";
+	public static final String JQUERY_JS              = "/public/jquery/jquery.min.js";
+	public static final String CATALOG_UTILS_JS       = "/public/js/CatalogUtils.js";
+	
 	private Url() {
 	}
 
+	public static Map<String, String> asMap() {
+		// There is not all urls but only those which used on views
+		Map<String, String> map = new HashMap<>();
+		map.put("AUTHENTICATION_PAGE", AUTHENTICATION_PAGE);
+		map.put("LOGIN_PAGE", LOGIN_PAGE);
+		map.put("LOGOUT_PAGE", LOGOUT_PAGE);
+		map.put("ACTIVATE_ACCOUNT_PAGE", ACTIVATE_ACCOUNT_PAGE);
+		map.put("REGISTRATION_PAGE", REGISTRATION_PAGE);
+		map.put("ADD_SERIES_PAGE", ADD_SERIES_PAGE);
+		map.put("INFO_SERIES_PAGE", INFO_SERIES_PAGE);
+		map.put("ADD_CATEGORY_PAGE", ADD_CATEGORY_PAGE);
+		map.put("INFO_CATEGORY_PAGE", INFO_CATEGORY_PAGE);
+		map.put("ADD_COUNTRY_PAGE", ADD_COUNTRY_PAGE);
+		map.put("INFO_COUNTRY_PAGE", INFO_COUNTRY_PAGE);
+		map.put("FAVICON_ICO", FAVICON_ICO);
+		map.put("MAIN_CSS", MAIN_CSS);
+		map.put("BOOTSTRAP_CSS", BOOTSTRAP_CSS);
+		map.put("BOOTSTRAP_RESPONSIVE_CSS", BOOTSTRAP_RESPONSIVE_CSS);
+		map.put("BOOTSTRAP_JS", BOOTSTRAP_JS);
+		map.put("JQUERY_JS", JQUERY_JS);
+		map.put("CATALOG_UTILS_JS", CATALOG_UTILS_JS);
+		return map;
+	}
+	
 }

src/main/java/ru/mystamps/web/config/ControllersConfig.java

@@ -61,6 +61,11 @@ public NotFoundErrorController getNotFoundErrorController() {
 		return new NotFoundErrorController(servicesConfig.getSiteService());
 	}
 
+	@Bean
+	public RobotsTxtController getRobotsTxtController() {
+		return new RobotsTxtController();
+	}
+	
 	@Bean
 	public SeriesController getSeriesController() {
 		return new SeriesController(

src/main/java/ru/mystamps/web/config/MvcConfig.java

@@ -26,6 +26,7 @@
 import org.springframework.context.annotation.Import;
 import org.springframework.context.MessageSource;
 import org.springframework.context.support.ReloadableResourceBundleMessageSource;
+import org.springframework.core.env.Environment;
 import org.springframework.data.repository.support.DomainClassConverter;
 import org.springframework.format.support.FormattingConversionService;
 import org.springframework.scheduling.annotation.EnableScheduling;
@@ -40,9 +41,13 @@
 import org.springframework.web.servlet.config.annotation.ViewControllerRegistry;
 import org.springframework.web.servlet.config.annotation.WebMvcConfigurerAdapter;
 import org.springframework.web.servlet.ViewResolver;
-import org.springframework.web.servlet.view.tiles2.TilesConfigurer;
-import org.springframework.web.servlet.view.UrlBasedViewResolver;
-import org.springframework.web.servlet.view.tiles2.TilesView;
+
+import org.thymeleaf.extras.springsecurity3.dialect.SpringSecurityDialect;
+import org.thymeleaf.spring3.SpringTemplateEngine;
+import org.thymeleaf.spring3.view.ThymeleafView;
+import org.thymeleaf.spring3.view.ThymeleafViewResolver;
+import org.thymeleaf.templateresolver.ServletContextTemplateResolver;
+import org.thymeleaf.templateresolver.TemplateResolver;
 
 import ru.mystamps.web.support.spring.security.CustomUserDetailsArgumentResolver;
 import ru.mystamps.web.Url;
@@ -54,14 +59,16 @@
 @Import(ControllersConfig.class)
 public class MvcConfig extends WebMvcConfigurerAdapter {
 
+	@Inject
+	private Environment env;
+	
 	@Override
 	public void configureDefaultServletHandling(DefaultServletHandlerConfigurer configurer) {
 		configurer.enable();
 	}
 
 	@Override
 	public void addViewControllers(ViewControllerRegistry registry) {
-		registry.addViewController(Url.ROBOTS_TXT).setViewName("site/robots");
 		registry.addViewController(Url.AUTHENTICATION_PAGE);
 		registry.addViewController(Url.UNAUTHORIZED_PAGE);
 	}
@@ -103,21 +110,26 @@ public Validator getValidator() {
 	}
 
 	@Bean
-	public TilesConfigurer getTilesConfigurer() {
-		TilesConfigurer configurer = new TilesConfigurer();
-		
-		configurer.setDefinitions(new String[]{
-			"/WEB-INF/tiles/tiles.xml"
-		});
-		
-		return configurer;
-	}
-	
-	@Bean
-	public ViewResolver getViewResolver() {
-		UrlBasedViewResolver viewResolver = new UrlBasedViewResolver();
+	@SuppressWarnings("PMD.SignatureDeclareThrowsException")
+	public ViewResolver getThymeleafViewResolver() throws Exception {
+		TemplateResolver templateResolver = new ServletContextTemplateResolver();
+		templateResolver.setTemplateMode("HTML5");
+		templateResolver.setPrefix("/WEB-INF/views/");
+		templateResolver.setSuffix(".html");
+		templateResolver.setCharacterEncoding("UTF-8");
+		templateResolver.setCacheable(env.acceptsProfiles("prod"));
+
+		SpringTemplateEngine templateEngine = new SpringTemplateEngine();
+		templateEngine.setTemplateResolver(templateResolver);
+		templateEngine.setTemplateEngineMessageSource(getMessageSource());
+		templateEngine.addDialect(new SpringSecurityDialect());
+		templateEngine.afterPropertiesSet();
 
-		viewResolver.setViewClass(TilesView.class);
+		ThymeleafViewResolver viewResolver = new ThymeleafViewResolver();
+		viewResolver.setTemplateEngine(templateEngine);
+		viewResolver.setContentType("text/html; charset=UTF-8");
+		viewResolver.setStaticVariables(Url.asMap());
+		viewResolver.setViewClass(ThymeleafView.class);
 
 		return viewResolver;
 	}

src/main/java/ru/mystamps/web/controller/RobotsTxtController.java

@@ -0,0 +1,64 @@
+/*
+ * Copyright (C) 2009-2014 Slava Semushin <[email protected]>
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
+ */
+package ru.mystamps.web.controller;
+
+import java.io.IOException;
+import java.io.PrintWriter;
+
+import javax.servlet.http.HttpServletResponse;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+
+import ru.mystamps.web.Url;
+
+@Controller
+public class RobotsTxtController {
+	private static final Logger LOG = LoggerFactory.getLogger(RobotsTxtController.class);
+	
+	@RequestMapping(value = Url.ROBOTS_TXT, method = RequestMethod.GET)
+	@SuppressWarnings("PMD.AvoidDuplicateLiterals")
+	public void getRobotsText(HttpServletResponse response) {
+		response.setContentType("text/plain");
+		response.setCharacterEncoding("UTF-8");
+		
+		try {
+			PrintWriter writer = response.getWriter();
+			
+			writer.println("# robots.txt for " + Url.PUBLIC_URL);
+			writer.println("User-Agent: *");
+			writer.println("Disallow: " + Url.REGISTRATION_PAGE);
+			writer.println("Disallow: " + Url.ACTIVATE_ACCOUNT_PAGE);
+			writer.println("Disallow: " + Url.AUTHENTICATION_PAGE);
+			writer.println("Disallow: " + Url.LOGIN_PAGE);
+			writer.println("Disallow: " + Url.ADD_COUNTRY_PAGE);
+			writer.println("Disallow: " + Url.ADD_SERIES_PAGE);
+			writer.println("Disallow: " + Url.ADD_CATEGORY_PAGE);
+			writer.println("Disallow: " + Url.UNAUTHORIZED_PAGE);
+			writer.println("Disallow: " + Url.NOT_FOUND_PAGE);
+		} catch (IOException ex) {
+			LOG.error("Can't return robots.txt: {}", ex.getMessage());
+		}
+	}
+	
+}
+

src/main/java/ru/mystamps/web/controller/SeriesController.java

@@ -57,7 +57,6 @@
 import ru.mystamps.web.support.spring.security.SecurityContextUtils;
 import ru.mystamps.web.util.CatalogUtils;
 import ru.mystamps.web.util.LocaleUtils;
-import ru.mystamps.web.validation.ValidationRules;
 
 @Controller
 @RequiredArgsConstructor
@@ -66,27 +65,13 @@ public class SeriesController {
 	private static final Integer SINCE_YEAR     = 1840;
 	private static final Integer CURRENT_YEAR   = new GregorianCalendar().get(Calendar.YEAR);
 
-	private static final Map<Integer, Integer> DAYS;
-	private static final Map<Integer, Integer> MONTHS;
 	private static final Map<Integer, Integer> YEARS;
 
 	private final CategoryService categoryService;
 	private final CountryService countryService;
 	private final SeriesService seriesService;
 
 	static {
-		DAYS = new LinkedHashMap<>(ValidationRules.MAX_DAYS_IN_MONTH);
-		for (int i = 1; i <= ValidationRules.MAX_DAYS_IN_MONTH; i++) {
-			Integer day = Integer.valueOf(i);
-			DAYS.put(day, day);
-		}
-		
-		MONTHS = new LinkedHashMap<>(ValidationRules.MAX_MONTHS_IN_YEAR);
-		for (int i = 1; i <= ValidationRules.MAX_MONTHS_IN_YEAR; i++) {
-			Integer month = Integer.valueOf(i);
-			MONTHS.put(month, month);
-		}
-		
 		YEARS = new LinkedHashMap<>();
 		for (Integer i = CURRENT_YEAR; i >= SINCE_YEAR; i--) {
 			YEARS.put(i, i);
@@ -103,16 +88,6 @@ protected void initBinder(WebDataBinder binder) {
 		binder.registerCustomEditor(String.class, "comment", new StringTrimmerEditor(true));
 	}
 
-	@ModelAttribute("days")
-	public Map<Integer, Integer> getDays() {
-		return DAYS;
-	}
-	
-	@ModelAttribute("months")
-	public Map<Integer, Integer> getMonths() {
-		return MONTHS;
-	}
-	
 	@ModelAttribute("years")
 	public Map<Integer, Integer> getYears() {
 		return YEARS;

src/main/java/ru/mystamps/web/entity/Price.java

@@ -17,6 +17,10 @@
  */
 package ru.mystamps.web.entity;
 
+import java.text.DecimalFormat;
+import java.text.NumberFormat;
+import java.util.Locale;
+
 import javax.persistence.Column;
 import javax.persistence.Embeddable;
 import javax.persistence.Enumerated;
@@ -54,5 +58,14 @@ public String toString() {
 			.append(currency)
 			.toString();
 	}
+
+	// used to emulate <fmt:formatNumber pattern="###.##" />
+	public String getFormattedValue() {
+		NumberFormat formatter = NumberFormat.getInstance(Locale.ENGLISH);
+		if (formatter instanceof DecimalFormat) {
+			((DecimalFormat)formatter).applyPattern("###.##");
+		}
+		return formatter.format(value.doubleValue());
+	}
 
 }