Cleanup admins

Cleans up the AdminController, AdminService, FirstYearStudent, and FirstYearMentorGroup classes with documentation and RoomCreate and RoomPatch DTOs. Changes the HTML for editing rooms to look a little cleaner.

src/main/java/nl/tudelft/ewi/queue/controller/AdminController.java

@@ -18,16 +18,21 @@
 package nl.tudelft.ewi.queue.controller;
 
 import java.io.IOException;
+import java.nio.file.Paths;
 
+import javax.transaction.Transactional;
 import javax.validation.Valid;
 
 import nl.tudelft.ewi.queue.csv.EmptyCsvException;
 import nl.tudelft.ewi.queue.csv.InvalidCsvException;
+import nl.tudelft.ewi.queue.dto.create.RoomCreateDTO;
+import nl.tudelft.ewi.queue.dto.patch.RoomPatchDTO;
 import nl.tudelft.ewi.queue.model.Room;
 import nl.tudelft.ewi.queue.repository.FirstYearMentorGroupRepository;
 import nl.tudelft.ewi.queue.repository.RoomRepository;
 import nl.tudelft.ewi.queue.service.AdminService;
 
+import org.modelmapper.ModelMapper;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.security.access.prepost.PreAuthorize;
 import org.springframework.stereotype.Controller;
@@ -37,38 +42,80 @@ import org.springframework.web.bind.annotation.*;
 import org.springframework.web.multipart.MultipartFile;
 import org.springframework.web.servlet.mvc.support.RedirectAttributes;
 
+/**
+ * Controller for actions only permitted to be done by admins.
+ *
+ * This entire controller is pre-authorized using the defauls role of admin for a user. If a user has this
+ * role, they can access every method in the AdminController.
+ *
+ * Admins have the right to create mentor group settings and change the available rooms. The page templates
+ * associated to these actions are located in the templates/admin directory. The methods (URLs) to get to
+ * these pages are all prefixed with {@code /admin}
+ */
 @Controller
 @PreAuthorize("@permissionService.isAdmin(principal)")
+@RequestMapping("/admin")
 @Validated
 public class AdminController {
+	private static final String MAPS_DIR = "static/maps";
 
 	@Autowired
 	private FirstYearMentorGroupRepository firstYearMentorGroupRepository;
 
+	@Autowired
+	private ModelMapper mapper;
+
 	@Autowired
 	private RoomRepository roomRepository;
 
 	@Autowired
 	private AdminService adminService;
 
+	/**
+	 * Adds a model attribute to every template resolution for recognizing the type of page we are in. For
+	 * this controller all pages will be in the "admin"-area.
+	 *
+	 * @return The generic page name: "admin".
+	 */
 	@ModelAttribute("page")
 	public static String page() {
 		return "admin";
 	}
 
-	@RequestMapping(value = "/admin", method = RequestMethod.GET)
-	public String index(Model model) {
+	/**
+	 * @return A redirect to the index page (currently /admin/mentor).
+	 */
+	@GetMapping()
+	public String index() {
 		return "redirect:/admin/mentor";
 	}
 
-	@RequestMapping(value = "/admin/mentor", method = RequestMethod.GET)
+	/**
+	 * Gets the page for viewing mentor groups.
+	 *
+	 * @param  model The model to fill out for template resolution.
+	 * @return       The template to load.
+	 */
+	@GetMapping("/mentor")
 	public String mentorGroups(Model model) {
 		model.addAttribute("groups", firstYearMentorGroupRepository.findAllByActiveIsTrue());
 
-		return "admin/mentor/groups.html";
+		return "admin/mentor/groups";
 	}
 
-	@RequestMapping(value = "/admin/mentor/upload", method = RequestMethod.POST)
+	/**
+	 * Processes a POST request for setting the mentor groups for Queue through an input CSV.
+	 *
+	 * @param  model              The model to fill out for template resolution.
+	 * @param  csv                The CSV file to import as a MultipartFile object.
+	 * @param  redirectAttributes Attributes that can be filled out on a redirect, for the next method to
+	 *                            resolve.
+	 * @return                    A redirect to /admin/mentor in the case of success or the original
+	 *                            admin/mentor/groups page in case of an error.
+	 * @throws IOException        when something went wrong with reading the file outside of a CSV parsing
+	 *                            exception.
+	 */
+	@PostMapping("/mentor/upload")
 	public String uploadMentorCsv(Model model,
 			@RequestParam("file") MultipartFile csv,
 			RedirectAttributes redirectAttributes)
@@ -86,51 +133,99 @@ public class AdminController {
 		return "admin/mentor/groups";
 	}
 
-	@RequestMapping(value = "/admin/rooms", method = RequestMethod.GET)
+	/**
+	 * Gets the page for viewing the current list of rooms and for navigating to a page to edit a room.
+	 *
+	 * @param  model The model to fill out for template resolution.
+	 * @return       The template to load.
+	 */
+	@GetMapping("/rooms")
 	public String rooms(Model model) {
 		model.addAttribute("rooms", roomRepository.findAllByOrderByNameAsc());
-
-		return "admin/rooms.html";
+		return "admin/rooms";
 	}
 
-	@RequestMapping(value = "/admin/rooms", method = RequestMethod.POST)
-	public String createRoom(Model model, @Valid Room room, RedirectAttributes redirectAttributes) {
-		roomRepository.save(room);
+	/**
+	 * Processes a POST request for adding a room to the global list of rooms. This method takes a DTO
+	 * containing the information for creating a new room and uses it to create this room.
+	 *
+	 * @param  dto                The DTO containing the information to create a new room.
+	 * @param  redirectAttributes Attributes that can be filled out on a redirect, for the next method to
+	 *                            resolve.
+	 * @return                    A redirect to the room overview.
+	 */
+	@Transactional
+	@PostMapping("/rooms")
+	public String createRoom(@Valid RoomCreateDTO dto, RedirectAttributes redirectAttributes) {
+		roomRepository.save(mapper.map(dto, Room.class));
+
 		redirectAttributes.addFlashAttribute("message", "Room has been created.");
 		return "redirect:/admin/rooms";
 	}
 
-	@RequestMapping(value = "/admin/room/edit/{id}", method = RequestMethod.GET)
+	/**
+	 * Gets the page for editing a room with the id given through the path of the /admin/room/edit/{id}
+	 * request.
+	 *
+	 * @param  model The model to fill out for template resolution.
+	 * @param  id    The id of the room to edit.
+	 * @return       The template to load.
+	 */
+	@GetMapping("/room/edit/{id}")
 	public String editRoom(Model model, @PathVariable("id") Long id) {
 		Room room = roomRepository.findById(id).orElseThrow();
 		model.addAttribute("room", room);
 
-		return "admin/rooms/edit.html";
+		return "admin/rooms/edit";
 	}
 
-	@RequestMapping(value = "/admin/room/edit/{id}", method = RequestMethod.POST)
+	/**
+	 * Processes a POST request to change the information available about a room. This method uses the given
+	 * RoomPatchDTO to patch an existing room in the database.
+	 *
+	 * If the update contains a map file, the map file is added to the directory of all map files, and the
+	 * name of the file is saved for the edited room.
+	 *
+	 * @param  id                 The id of the room to edit.
+	 * @param  map                The map file that is to be associated with the room.
+	 * @param  dto                The DTO containing the information about the patch.
+	 * @param  redirectAttributes Attributes that can be filled out on a redirect, for the next method to
+	 *                            resolve.
+	 * @return                    A redirect to the room overview.
+	 * @throws IOException        when something goes wrong saving the map file.
+	 */
+	@Transactional
+	@PostMapping("/room/edit/{id}")
 	public String saveRoom(@PathVariable("id") Long id,
 			@RequestParam("map") MultipartFile map,
-			Room room, RedirectAttributes redirectAttributes)
+			RoomPatchDTO dto, RedirectAttributes redirectAttributes)
 			throws IOException {
-		Room objRoom = roomRepository.findById(id).orElseThrow();
-		objRoom.setName(room.getName());
-		objRoom.setPlaceholder(room.isPlaceholder());
-		if (!map.getOriginalFilename().isEmpty()) {
-			String filePath = adminService.uploadFile(map, "static/maps/");
-			objRoom.setMapFilePath(filePath);
+		Room room = roomRepository.findById(id).orElseThrow();
+		dto.apply(room);
+
+		if (map != null && !map.getOriginalFilename().isEmpty()) {
+			adminService.uploadFile(map);
+			room.setMapFilePath(Paths.get(MAPS_DIR, map.getOriginalFilename()).toString());
 		}
-		roomRepository.save(objRoom);
+
 		redirectAttributes.addFlashAttribute("message", "Room has been saved.");
 		return "redirect:/admin/rooms";
 	}
 
-	@RequestMapping(value = "/admin/room/delete", method = RequestMethod.POST)
-	public String deleteRoom(Model model,
-			@RequestParam(value = "id") Long id,
+	/**
+	 * Processes a request to delete an existing room. The existing room is identified with the given id.
+	 *
+	 * @param  id                 The id of the room to delete.
+	 * @param  redirectAttributes Attributes that can be filled out on a redirect, for the next method to
+	 *                            resolve.
+	 * @return                    A redirect to the room overview.
+	 */
+	@PostMapping("/room/delete")
+	public String deleteRoom(@RequestParam(value = "id") Long id,
 			RedirectAttributes redirectAttributes) {
-		Room objRoom = roomRepository.findById(id).orElseThrow();
-		roomRepository.delete(objRoom);
+		Room room = roomRepository.findById(id).orElseThrow();
+		roomRepository.delete(room);
+
 		redirectAttributes.addFlashAttribute("message", "Room has been deleted.");
 		return "redirect:/admin/rooms";
 	}