Implement ability to add additional images to series.

Author: php-coder

src/main/config/checkstyle-suppressions.xml

@@ -8,7 +8,7 @@
 	<suppress checks="LineLength" files="AbstractPage.java" lines="44,45" />
 	<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="73" />
+	<suppress checks="LineLength" files="Url.java" lines="71" />
 	<suppress checks="LineLength" files="ErrorController.java" lines="73" />
 	<suppress checks="LineLength" files="SecurityConfig.java" lines="35,36,40" />
 	<suppress checks="LineLength" files="JdbcSeriesDaoImpl.java" lines="123" />

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

@@ -20,8 +20,6 @@
 import java.util.HashMap;
 import java.util.Map;
 
-import ru.mystamps.web.service.ImageService;
-
 /**
  * Holds path to site and all URLs.
  *
@@ -59,7 +57,7 @@ public final class Url {
 
 	public static final String INFO_COLLECTION_PAGE  = "/collection/{id}/{slug}";
 
-	public static final String GET_IMAGE_PAGE        = ImageService.GET_IMAGE_PAGE;
+	public static final String GET_IMAGE_PAGE        = "/image/{id}";
 
 	public static final String UNAUTHORIZED_PAGE     = "/error/401";
 	public static final String FORBIDDEN_PAGE        = "/error/403";
@@ -97,6 +95,7 @@ public static Map<String, String> asMap() {
 		map.put("ADD_COUNTRY_PAGE", ADD_COUNTRY_PAGE);
 		map.put("INFO_COUNTRY_PAGE", INFO_COUNTRY_PAGE);
 		map.put("INFO_COLLECTION_PAGE", INFO_COLLECTION_PAGE);
+		map.put("GET_IMAGE_PAGE", GET_IMAGE_PAGE);
 		map.put("FAVICON_ICO", FAVICON_ICO);
 		map.put("MAIN_CSS", MAIN_CSS);
 		map.put("BOOTSTRAP_CSS", BOOTSTRAP_CSS);

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

@@ -45,6 +45,7 @@
 import ru.mystamps.web.Url;
 import ru.mystamps.web.entity.Collection;
 import ru.mystamps.web.entity.User;
+import ru.mystamps.web.model.AddImageForm;
 import ru.mystamps.web.model.AddSeriesForm;
 import ru.mystamps.web.model.AddSeriesForm.ScottCatalogChecks;
 import ru.mystamps.web.model.AddSeriesForm.GibbonsCatalogChecks;
@@ -151,6 +152,7 @@ public String showInfo(@PathVariable("id") Series series, Model model, User curr
 			throw new NotFoundException();
 		}
 
+		model.addAttribute("addImageForm", new AddImageForm());
 		model.addAttribute("series", series);
 		model.addAttribute("michelNumbers", CatalogUtils.toShortForm(series.getMichel()));
 		model.addAttribute("scottNumbers", CatalogUtils.toShortForm(series.getScott()));
@@ -165,6 +167,40 @@ public String showInfo(@PathVariable("id") Series series, Model model, User curr
 		return "series/info";
 	}
 
+	@RequestMapping(value = Url.INFO_SERIES_PAGE, method = RequestMethod.POST)
+	public String processImage(
+			@Validated({ Default.class, AddImageForm.ImageChecks.class }) AddImageForm form,
+			BindingResult result,
+			@PathVariable("id") Series series,
+			Model model,
+			User currentUser) {
+		
+		model.addAttribute("series", series);
+		model.addAttribute("michelNumbers", CatalogUtils.toShortForm(series.getMichel()));
+		model.addAttribute("scottNumbers", CatalogUtils.toShortForm(series.getScott()));
+		model.addAttribute("yvertNumbers", CatalogUtils.toShortForm(series.getYvert()));
+		model.addAttribute("gibbonsNumbers", CatalogUtils.toShortForm(series.getGibbons()));
+		
+		model.addAttribute(
+			"isSeriesInCollection",
+			collectionService.isSeriesInCollection(currentUser, series)
+		);
+		
+		if (result.hasErrors()) {
+			// don't try to re-display file upload field
+			form.setImage(null);
+			return "series/info";
+		}
+		
+		if (series == null) {
+			throw new NotFoundException();
+		}
+		
+		seriesService.addImageToSeries(form, series);
+		
+		return "series/info";
+	}
+	
 	@RequestMapping(
 		value = Url.INFO_SERIES_PAGE,
 		method = RequestMethod.POST,

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

@@ -17,6 +17,7 @@
  */
 package ru.mystamps.web.entity;
 
+import java.util.LinkedHashSet;
 import java.util.Set;
 
 import javax.persistence.AttributeOverride;
@@ -28,8 +29,11 @@
 import javax.persistence.FetchType;
 import javax.persistence.GeneratedValue;
 import javax.persistence.Id;
+import javax.persistence.JoinColumn;
+import javax.persistence.JoinTable;
 import javax.persistence.ManyToMany;
 import javax.persistence.ManyToOne;
+import javax.persistence.OneToMany;
 import javax.persistence.OrderBy;
 import javax.persistence.Table;
 
@@ -47,8 +51,7 @@
 @SuppressWarnings("PMD.TooManyFields")
 public class Series {
 
-	public static final int IMAGE_URL_LENGTH = 255;
-	public static final int COMMENT_LENGTH   = 255;
+	public static final int COMMENT_LENGTH = 255;
 
 	@Id
 	@GeneratedValue
@@ -143,8 +146,9 @@ public class Series {
 	})
 	private Price gibbonsPrice;
 
-	@Column(name = "image_url", length = IMAGE_URL_LENGTH)
-	private String imageUrl;
+	@OneToMany(fetch = FetchType.EAGER)
+	@JoinTable(inverseJoinColumns = @JoinColumn(name = "image_id"))
+	private Set<Image> images;
 
 	@Column(length = COMMENT_LENGTH)
 	private String comment;
@@ -156,4 +160,12 @@ public Series() {
 		metaInfo = new MetaInfo();
 	}
 
+	public void addImage(Image image) {
+		if (images == null) {
+			images = new LinkedHashSet<>();
+		}
+		
+		images.add(image);
+	}
+	
 }

src/main/java/ru/mystamps/web/model/AddImageForm.java

@@ -0,0 +1,54 @@
+/*
+ * Copyright (C) 2009-2015 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.model;
+
+import javax.validation.GroupSequence;
+import javax.validation.constraints.NotNull;
+
+import org.springframework.web.multipart.MultipartFile;
+
+import lombok.Getter;
+import lombok.Setter;
+
+import ru.mystamps.web.service.dto.AddImageDto;
+import ru.mystamps.web.validation.jsr303.NotEmptyFile;
+import ru.mystamps.web.validation.jsr303.NotEmptyFilename;
+
+@Getter
+@Setter
+public class AddImageForm implements AddImageDto {
+	
+	@NotNull
+	@NotEmptyFilename(groups = Image1Checks.class)
+	@NotEmptyFile(groups = Image2Checks.class)
+	private MultipartFile image;
+	
+	@GroupSequence({
+		Image1Checks.class,
+		Image2Checks.class
+	})
+	public interface ImageChecks {
+	}
+	
+	public interface Image1Checks {
+	}
+	
+	public interface Image2Checks {
+	}
+	
+}

src/main/java/ru/mystamps/web/service/ImageService.java

@@ -19,11 +19,10 @@
 
 import org.springframework.web.multipart.MultipartFile;
 
+import ru.mystamps.web.entity.Image;
 import ru.mystamps.web.service.dto.ImageDto;
 
 public interface ImageService {
-	String GET_IMAGE_PAGE = "/image/{id}";
-	
-	String save(MultipartFile file);
+	Image save(MultipartFile file);
 	ImageDto get(Integer imageId);
 }

src/main/java/ru/mystamps/web/service/ImageServiceImpl.java

@@ -46,7 +46,7 @@ public class ImageServiceImpl implements ImageService {
 
 	@Override
 	@Transactional
-	public String save(MultipartFile file) {
+	public Image save(MultipartFile file) {
 		Validate.isTrue(file != null, "File should be non null");
 		Validate.isTrue(file.getSize() > 0, "Image size must be greater than zero");
 
@@ -72,7 +72,7 @@ public String save(MultipartFile file) {
 
 		imagePersistenceStrategy.save(file, entity);
 
-		return GET_IMAGE_PAGE.replace("{id}", String.valueOf(entity.getId()));
+		return entity;
 	}
 
 	@Override

src/main/java/ru/mystamps/web/service/SeriesService.java

@@ -20,7 +20,9 @@
 import ru.mystamps.web.entity.Category;
 import ru.mystamps.web.entity.Collection;
 import ru.mystamps.web.entity.Country;
+import ru.mystamps.web.entity.Series;
 import ru.mystamps.web.entity.User;
+import ru.mystamps.web.service.dto.AddImageDto;
 import ru.mystamps.web.service.dto.AddSeriesDto;
 import ru.mystamps.web.service.dto.SeriesInfoDto;
 import ru.mystamps.web.service.dto.SitemapInfoDto;
@@ -29,6 +31,7 @@
 @SuppressWarnings("PMD.TooManyMethods")
 public interface SeriesService {
 	Integer add(AddSeriesDto dto, User user, boolean userCanAddComments);
+	void addImageToSeries(AddImageDto dto, Series series);
 	long countAll();
 	long countAllStamps();
 	long countSeriesOf(Collection collection);

src/main/java/ru/mystamps/web/service/SeriesServiceImpl.java

@@ -17,6 +17,7 @@
  */
 package ru.mystamps.web.service;
 
+import java.util.Collections;
 import java.util.Date;
 import java.util.Set;
 
@@ -36,13 +37,15 @@
 import ru.mystamps.web.entity.Country;
 import ru.mystamps.web.entity.Collection;
 import ru.mystamps.web.entity.GibbonsCatalog;
+import ru.mystamps.web.entity.Image;
 import ru.mystamps.web.entity.MichelCatalog;
 import ru.mystamps.web.entity.Price;
 import ru.mystamps.web.entity.ScottCatalog;
 import ru.mystamps.web.entity.Series;
 import ru.mystamps.web.entity.StampsCatalog;
 import ru.mystamps.web.entity.User;
 import ru.mystamps.web.entity.YvertCatalog;
+import ru.mystamps.web.service.dto.AddImageDto;
 import ru.mystamps.web.service.dto.AddSeriesDto;
 import ru.mystamps.web.service.dto.SeriesInfoDto;
 import ru.mystamps.web.service.dto.SitemapInfoDto;
@@ -95,11 +98,8 @@ public Integer add(AddSeriesDto dto, User user, boolean userCanAddComments) {
 		series.setGibbons(getCatalogNumbersOrNull(dto.getGibbonsNumbers(), GibbonsCatalog.class));
 		series.setGibbonsPrice(Price.valueOf(dto.getGibbonsPrice(), dto.getGibbonsCurrency()));
 
-		String imageUrl = imageService.save(dto.getImage());
-		Validate.validState(imageUrl != null, "Image url must be non null");
-		Validate.validState(imageUrl.length() <= Series.IMAGE_URL_LENGTH, "Too long image path");
-		
-		series.setImageUrl(imageUrl);
+		Image image = imageService.save(dto.getImage());
+		series.setImages(Collections.singleton(image));
 
 		if (userCanAddComments && dto.getComment() != null) {
 			Validate.isTrue(
@@ -122,6 +122,19 @@ public Integer add(AddSeriesDto dto, User user, boolean userCanAddComments) {
 
 		return entity.getId();
 	}
+
+	@Override
+	@Transactional
+	public void addImageToSeries(AddImageDto dto, Series series) {
+		Validate.isTrue(dto != null, "DTO must be non null");
+		Validate.isTrue(series != null, "DTO must be non null");
+		
+		Image image = imageService.save(dto.getImage());
+		
+		series.addImage(image);
+		
+		seriesDao.save(series);
+	}
 
 	@Override
 	@Transactional(readOnly = true)

src/main/java/ru/mystamps/web/service/dto/AddImageDto.java

@@ -0,0 +1,24 @@
+/*
+ * Copyright (C) 2009-2015 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.service.dto;
+
+import org.springframework.web.multipart.MultipartFile;
+
+public interface AddImageDto {
+	MultipartFile getImage();
+}

src/main/resources/liquibase/version/0.4.xml

@@ -6,5 +6,6 @@
 		http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.0.xsd">
 
 	<include file="0.4/2014-10-28--decimal_price.xml" relativeToChangelogFile="true" />
+	<include file="0.4/2015-07-22--image_url.xml" relativeToChangelogFile="true" />
 
 </databaseChangeLog>

src/main/resources/liquibase/version/0.4/2015-07-22--image_url.xml

@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<databaseChangeLog
+		xmlns="http://www.liquibase.org/xml/ns/dbchangelog"
+		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+		xsi:schemaLocation="http://www.liquibase.org/xml/ns/dbchangelog
+		http://www.liquibase.org/xml/ns/dbchangelog/dbchangelog-3.0.xsd">
+	
+	<changeSet id="create-series_images-table" author="php-coder" context="scheme">
+		<comment>Creates series_images table</comment>
+		
+		<createTable tableName="series_images">
+			<column name="series_id" type="INTEGER">
+				<constraints nullable="false" references="series(id)" foreignKeyName="fk_series_images_series_id" />
+			</column>
+			<column name="image_id" type="INTEGER">
+				<constraints nullable="false" references="images(id)" foreignKeyName="fk_series_images_image_id" />
+			</column>
+		</createTable>
+		
+		<modifySql dbms="mysql">
+			<append value=" ENGINE=InnoDB" />
+		</modifySql>
+		
+	</changeSet>
+	
+</databaseChangeLog>

src/main/resources/ru/mystamps/i18n/Messages.properties

@@ -90,6 +90,7 @@ t_yvert = Yvert
 t_sg = Gibbons
 t_comment = Comment
 t_image = Image
+t_add_more_images_hint = Later you will be able to add additional images
 
 # series/info.html
 t_series_info = Info about series
@@ -101,6 +102,7 @@ t_add_to_collection = Add to collection
 t_remove_from_collection = Remove from collection
 t_need_authentication_to_add_series_to_collection = \
 In order to add this series to your collection you should <a href="{0}">register</a> or <a href="{1}">pass authentication</a>.
+t_add_image = Add image
 
 # category/add.html
 t_create_category_ucfirst = Add category