Deletes unused endpoints and refactors app accordingly

Author: diego-guerrero

backend/src/main/java/es/codeurjc/vscode4teaching/controllers/CommentController.java

@@ -40,14 +40,6 @@ public CourseController(CourseService courseService, JWTTokenUtil jwtTokenUtil)
         this.jwtTokenUtil = jwtTokenUtil;
     }
 
-    @GetMapping("/courses")
-    @JsonView(CourseViews.CreatorView.class)
-    public ResponseEntity<List<Course>> getAllCourses() {
-        logger.info("Request to GET '/api/courses'");
-        List<Course> courses = courseService.getAllCourses();
-        return !courses.isEmpty() ? ResponseEntity.ok(courses) : ResponseEntity.noContent().build();
-    }
-
     @GetMapping("/courses/{courseId}")
     @JsonView(CourseViews.CreatorView.class)
     public ResponseEntity<Course> getCourse(@PathVariable @Min(1) Long courseId) {
@@ -56,13 +48,6 @@ public ResponseEntity<Course> getCourse(@PathVariable @Min(1) Long courseId) {
         return course.map(ResponseEntity::ok).orElseGet(() -> ResponseEntity.noContent().build());
     }
 
-    @GetMapping("/courses/{courseId}/creator")
-    @JsonView(UserViews.GeneralView.class)
-    public ResponseEntity<User> getCreator(@PathVariable @Min(1) Long courseId) throws CourseNotFoundException {
-        logger.info("Request to GET '/api/courses/{}/creator'", courseId);
-        return ResponseEntity.ok(courseService.getCreator(courseId));
-    }
-
     @PostMapping("/courses")
     @JsonView(CourseViews.CreatorView.class)
     public ResponseEntity<Course> addCourse(HttpServletRequest request, @Valid @RequestBody CourseDTO courseDTO)
@@ -129,21 +114,12 @@ public ResponseEntity<Course> removeUsersFromCourse(@PathVariable @Min(1) Long c
 
     @GetMapping("/courses/{courseId}/code")
     public ResponseEntity<String> getCode(@PathVariable Long courseId, HttpServletRequest request)
-            throws UserNotFoundException, CourseNotFoundException, NotInCourseException {
+            throws CourseNotFoundException, NotInCourseException {
         logger.info("Request to GET '/api/courses/{}/code'", courseId);
         return ResponseEntity.ok(courseService.getCourseCode(courseId, jwtTokenUtil.getUsernameFromAuthenticatedRequest(request)));
     }
 
-    @Deprecated // VERSION 2.1 AND LATER ARE NOT USING THIS METHOD, READ DOCS FOR FURTHER INFORMATION
     @GetMapping("/courses/code/{courseCode}")
-    @JsonView(CourseViews.ExercisesView.class)
-    public ResponseEntity<Course> getExercisesWithCode(HttpServletRequest request, @PathVariable String courseCode)
-            throws CourseNotFoundException, UserNotFoundException {
-        logger.info("Request to GET '/api/courses/code/{}' (deprecated API endpoint)", courseCode);
-        return ResponseEntity.ok(courseService.joinCourseWithSharingCode(courseCode, jwtTokenUtil.getUsernameFromAuthenticatedRequest(request)));
-    }
-
-    @GetMapping("/v2/courses/code/{courseCode}")
     @JsonView(CourseViews.CreatorView.class)
     public ResponseEntity<Course> getCourseInformationBySharingCode(@PathVariable String courseCode)
             throws CourseNotFoundException {

backend/src/main/java/es/codeurjc/vscode4teaching/controllers/CourseController.java

@@ -19,10 +19,9 @@
 import org.springframework.web.bind.annotation.*;
 
 import jakarta.servlet.http.HttpServletRequest;
-import jakarta.transaction.Transactional;
 import jakarta.validation.Valid;
 import jakarta.validation.constraints.Min;
-import java.util.ArrayList;
+
 import java.util.List;
 
 @RestController
@@ -53,33 +52,17 @@ public ResponseEntity<List<Exercise>> getExercises(HttpServletRequest request, @
         return exercises.isEmpty() ? ResponseEntity.noContent().build() : ResponseEntity.ok(exercises);
     }
 
-    @Deprecated
     @PostMapping("/courses/{courseId}/exercises")
     @JsonView(ExerciseViews.CourseView.class)
     public ResponseEntity<Exercise> addExercise(HttpServletRequest request, @PathVariable @Min(1) Long courseId,
                                                 @Valid @RequestBody ExerciseDTO exerciseDTO) throws CourseNotFoundException, NotInCourseException {
-        logger.info("Request to POST '/api/courses/{}/exercises' with body '{}' (deprecated API endpoint)", courseId, exerciseDTO);
+        logger.info("Request to POST '/api/courses/{}/exercises' with body '{}'", courseId, exerciseDTO);
         Exercise exercise = new Exercise(exerciseDTO.name);
-        Exercise savedExercise = courseService.addExerciseToCourse(courseId, exercise,
-                jwtTokenUtil.getUsernameFromAuthenticatedRequest(request));
-        return new ResponseEntity<>(savedExercise, HttpStatus.CREATED);
-    }
-
-    @PostMapping("/v2/courses/{courseId}/exercises")
-    @JsonView(ExerciseViews.CourseView.class)
-    @Transactional
-    public ResponseEntity<List<Exercise>> addExercises(HttpServletRequest request, @PathVariable @Min(1) Long courseId,
-                                                       @Valid @RequestBody ExerciseDTO[] exercisesDTO) throws CourseNotFoundException, NotInCourseException {
-        logger.info("Request to POST '/api/v2/courses/{}/exercises' with body '{}'", courseId, exercisesDTO);
-        ArrayList<Exercise> savedExercises = new ArrayList<>();
-        for (ExerciseDTO exerciseDTO : exercisesDTO) {
-            Exercise exercise = new Exercise(exerciseDTO.name);
-            exercise.setIncludesTeacherSolution(exerciseDTO.includesTeacherSolution);
-            exercise.setSolutionIsPublic(exerciseDTO.solutionIsPublic);
-            exercise.setAllowEditionAfterSolutionDownloaded(exerciseDTO.allowEditionAfterSolutionDownloaded);
-            savedExercises.add(courseService.addExerciseToCourse(courseId, exercise, jwtTokenUtil.getUsernameFromAuthenticatedRequest(request)));
-        }
-        return new ResponseEntity<>(savedExercises, HttpStatus.CREATED);
+        exercise.setIncludesTeacherSolution(exerciseDTO.includesTeacherSolution);
+        exercise.setSolutionIsPublic(exerciseDTO.solutionIsPublic);
+        exercise.setAllowEditionAfterSolutionDownloaded(exerciseDTO.allowEditionAfterSolutionDownloaded);
+        exercise = courseService.addExerciseToCourse(courseId, exercise, jwtTokenUtil.getUsernameFromAuthenticatedRequest(request));
+        return new ResponseEntity<>(exercise, HttpStatus.CREATED);
     }
 
     @GetMapping("/exercises/{exerciseId}")
@@ -110,13 +93,6 @@ public ResponseEntity<Void> deleteExercise(HttpServletRequest request, @PathVari
         return ResponseEntity.noContent().build();
     }
 
-    @GetMapping("/exercises/{exerciseId}/code")
-    public ResponseEntity<String> getCode(@PathVariable Long exerciseId, HttpServletRequest request)
-            throws UserNotFoundException, ExerciseNotFoundException, NotInCourseException {
-        logger.info("Request to GET '/api/exercises/{}/code'", exerciseId);
-        return ResponseEntity.ok(courseService.getExerciseCode(exerciseId, jwtTokenUtil.getUsernameFromAuthenticatedRequest(request)));
-    }
-
     @GetMapping("/exercises/{exerciseId}/info")
     @JsonView(ExerciseUserInfoViews.GeneralView.class)
     public ResponseEntity<ExerciseUserInfo> getExerciseUserInfo(@PathVariable Long exerciseId, HttpServletRequest request) throws NotFoundException {

backend/src/main/java/es/codeurjc/vscode4teaching/controllers/ExerciseController.java

@@ -24,13 +24,10 @@
 @Validated
 @RequestMapping("/api")
 public class ExerciseSingleFileController {
-    private static final String templateFolderName = "template";
-    private static final String solutionFolderName = "solution";
-
     private final ExerciseSingleFileService exerciseSingleFileService;
     private final JWTTokenUtil jwtTokenUtil;
 
-    private final Logger logger = LoggerFactory.getLogger(ExerciseZipFileController.class);
+    private final Logger logger = LoggerFactory.getLogger(ExerciseSingleFileController.class);
 
     public ExerciseSingleFileController(ExerciseSingleFileService exerciseSingleFileService,
                                         JWTTokenUtil jwtTokenUtil) {

backend/src/main/java/es/codeurjc/vscode4teaching/controllers/ExerciseSingleFileController.java

@@ -1,10 +1,7 @@
 package es.codeurjc.vscode4teaching.controllers;
 
-import com.fasterxml.jackson.annotation.JsonView;
 import es.codeurjc.vscode4teaching.controllers.dtos.UploadFileResponse;
 import es.codeurjc.vscode4teaching.model.Exercise;
-import es.codeurjc.vscode4teaching.model.ExerciseFile;
-import es.codeurjc.vscode4teaching.model.views.FileViews;
 import es.codeurjc.vscode4teaching.security.jwt.JWTTokenUtil;
 import es.codeurjc.vscode4teaching.services.ExerciseZipFileService;
 import es.codeurjc.vscode4teaching.services.exceptions.*;
@@ -133,15 +130,6 @@ public void getAllStudentsFiles(@PathVariable Long id, HttpServletRequest reques
         exportToZipAllStudents(response, files, exerciseDirectory);
     }
 
-    @JsonView(FileViews.GeneralView.class)
-    @GetMapping("/users/{username}/exercises/{exerciseId}/files")
-    public ResponseEntity<List<ExerciseFile>> getFileInfoByOwnerAndExercise(@PathVariable String username,
-                                                                            @PathVariable Long exerciseId) throws NotFoundException {
-        logger.info("Request to GET '/api/users/{}/exercises/{}/files'", username, exerciseId);
-        List<ExerciseFile> files = exerciseZipFileService.getFileIdsByExerciseAndId(exerciseId, username);
-        return files.isEmpty() ? ResponseEntity.noContent().build() : ResponseEntity.ok(files);
-    }
-
     private String[] headerFilename(String filename) {
         String[] headerElements = new String[2];
         headerElements[0] = "Content-Disposition";
@@ -172,16 +160,14 @@ private void exportToZipAllStudents(HttpServletResponse response, List<File> fil
 
 
     // POST endpoint
-
-    @PostMapping(value = {"/exercises/{id}/files", "/exercises/{id}/files/{type:template|solution}"})
+    @PostMapping("/exercises/{id}/files/{type:template|solution}")
     public ResponseEntity<List<UploadFileResponse>> uploadFiles(@PathVariable Long id, @PathVariable(required = false) String type,
                                                                 @RequestParam("file") MultipartFile zip, HttpServletRequest request)
-            throws NotFoundException, NotInCourseException, IOException, ExerciseFinishedException {
+            throws NotFoundException, NotInCourseException, IOException {
         logger.info("Request to POST '/api/exercises/{}/files/{}' with a MultipartFile (ZIP) as body", id, type);
 
         // Stage 1: All the information necessary to execute the process is obtained and files are saved using
         // filesService specific methods. This process distinguishes between the different possible cases:
-        // - Uploading of individual files for each student's exercise
         // - Uploading of an exercise template.
         // - Uploading of the proposed solution to an exercise (if existing).
         String username = jwtTokenUtil.getUsernameFromAuthenticatedRequest(request);
@@ -196,8 +182,7 @@ public ResponseEntity<List<UploadFileResponse>> uploadFiles(@PathVariable Long i
             filesMap = exerciseZipFileService.saveExerciseSolution(id, zip, username);
             pattern = fileSeparatorPattern + ExerciseZipFileController.solutionFolderName + fileSeparatorPattern;
         } else {
-            filesMap = exerciseZipFileService.saveExerciseFiles(id, zip, username);
-            pattern = fileSeparatorPattern + "student_[0-9]*" + fileSeparatorPattern;
+            return ResponseEntity.badRequest().build();
         }
 
         // Stage 2: saved files in previous stage are now collected and response is prepared and sent.

backend/src/main/java/es/codeurjc/vscode4teaching/controllers/ExerciseZipFileController.java

@@ -51,40 +51,23 @@ public JWTLoginController(AuthenticationManager authenticationManager, JWTTokenU
     public ResponseEntity<JWTResponse> generateLoginToken(@Valid @RequestBody JWTRequest loginRequest, HttpServletResponse response) {
         logger.info("Request to POST '/api/login'");
         String username = loginRequest.getUsername();
-        login(username, loginRequest.getPassword());
+        authenticationManager.authenticate(new UsernamePasswordAuthenticationToken(username, loginRequest.getPassword()));
         final UserDetails userDetails = userDetailsService.loadUserByUsername(username);
         final String token = jwtTokenUtil.generateToken(userDetails);
 
         return ResponseEntity.ok(new JWTResponse(token, jwtTokenUtil.encryptToken(token)));
     }
 
-    private void login(String username, String password) {
-        authenticationManager.authenticate(new UsernamePasswordAuthenticationToken(username, password));
-    }
-
     @PostMapping("/register")
     @JsonView(UserViews.EmailView.class)
     public ResponseEntity<User> saveUser(@Valid @RequestBody UserDTO userDto) {
         logger.info("Request to POST '/api/register' with body '{}'", userDto);
         String encodedPassword = bCryptPasswordEncoder.encode(userDto.getPassword());
-        User user = new User(userDto.getEmail(), userDto.getUsername(), encodedPassword, userDto.getName(),
-                userDto.getLastName());
+        User user = new User(userDto.getEmail(), userDto.getUsername(), encodedPassword, userDto.getName(), userDto.getLastName());
         User saveduser = userDetailsService.save(user, false);
         return new ResponseEntity<>(saveduser, HttpStatus.CREATED);
     }
 
-    @Deprecated // VERSION 2.1 AND LATER ARE NOT USING THIS METHOD, READ DOCS FOR FURTHER INFORMATION
-    @PostMapping("/teachers/register")
-    @JsonView(UserViews.EmailView.class)
-    public ResponseEntity<User> saveTeacher(@Valid @RequestBody UserDTO userDto) {
-        logger.info("Request to POST '/api/teachers/register' with body '{}' (deprecated API endpoint)", userDto);
-        String encodedPassword = bCryptPasswordEncoder.encode(userDto.getPassword());
-        User user = new User(userDto.getEmail(), userDto.getUsername(), encodedPassword, userDto.getName(),
-                userDto.getLastName());
-        User savedUser = userDetailsService.save(user, true);
-        return new ResponseEntity<>(savedUser, HttpStatus.CREATED);
-    }
-
     @PostMapping("/teachers/invitation")
     public ResponseEntity<UserDTO> saveTeacherInvitation(@RequestBody UserDTO userDto) {
         logger.info("Request to POST '/api/teachers/invitation' with body '{}'", userDto);
@@ -105,11 +88,6 @@ public ResponseEntity<User> getCurrentUser(HttpServletRequest request) throws No
         return ResponseEntity.ok(user);
     }
 
-    @GetMapping("/csrf")
-    public ResponseEntity<Void> getCsrfToken() {
-        return ResponseEntity.ok().build();
-    }
-
     @GetMapping("/users")
     @JsonView(UserViews.GeneralView.class)
     public ResponseEntity<List<User>> getAllUsers() {