TodosController.java
package edu.ucsb.cs156.example.controllers;
import edu.ucsb.cs156.example.entities.Todo;
import edu.ucsb.cs156.example.entities.User;
import edu.ucsb.cs156.example.errors.EntityNotFoundException;
import edu.ucsb.cs156.example.models.CurrentUser;
import edu.ucsb.cs156.example.repositories.TodoRepository;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.PutMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
import jakarta.validation.Valid;
/**
* This is a REST controller for Todos
*/
@Tag(name = "Todos")
@RequestMapping("/api/todos")
@RestController
@Slf4j
public class TodosController extends ApiController {
@Autowired
TodoRepository todoRepository;
/**
* This method returns a list of all todos. Accessible only to users with the role "ROLE_ADMIN".
* @return a list of all todos
*/
@Operation(summary = "List all todos")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@GetMapping("/admin/all")
public Iterable<Todo> allUsersTodos() {
Iterable<Todo> todos = todoRepository.findAll();
return todos;
}
/**
* This method returns a list of all todos owned by the current user.
* @return a list of all todos owned by the current user
*/
@Operation(summary = "List this user's todos")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("/all")
public Iterable<Todo> thisUsersTodos() {
CurrentUser currentUser = getCurrentUser();
Iterable<Todo> todos = todoRepository.findAllByUserId(currentUser.getUser().getId());
return todos;
}
/**
* This method returns a single todo owned by the current user.
* @param id id of the todo to get
* @return a single todo owned by the current user
*/
@Operation(summary = "Get a single todo (if it belongs to current user)")
@PreAuthorize("hasRole('ROLE_USER')")
@GetMapping("")
public Todo getTodoById(
@Parameter(name="id") @RequestParam Long id) {
User currentUser = getCurrentUser().getUser();
Todo todo = todoRepository.findByIdAndUser(id, currentUser)
.orElseThrow(() -> new EntityNotFoundException(Todo.class, id));
return todo;
}
/**
* This method returns a single todo regardless of ownership. Accessible only to users with the role "ROLE_ADMIN".
* @param id id of the todo to get
* @return a single todo regardless of ownership
*/
@Operation(summary = "Get a single todo (no matter who it belongs to, admin only)")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@GetMapping("/admin")
public Todo getTodoById_admin(
@Parameter(name="id") @RequestParam Long id) {
Todo todo = todoRepository.findById(id)
.orElseThrow(() -> new EntityNotFoundException(Todo.class, id));
return todo;
}
/**
* This method creates a new todo owned by the current user.
* @param title title of the todo
* @param details details of the todo
* @param done whether the todo has been done or not
* @return the saved todo (with it's id field set by the database)
*/
@Operation(summary = "Create a new Todo")
@PreAuthorize("hasRole('ROLE_USER')")
@PostMapping("/post")
public Todo postTodo(
@Parameter(name="title") @RequestParam String title,
@Parameter(name="details") @RequestParam String details,
@Parameter(name="done") @RequestParam Boolean done) {
CurrentUser currentUser = getCurrentUser();
log.info("currentUser={}", currentUser);
Todo todo = new Todo();
todo.setUser(currentUser.getUser());
todo.setTitle(title);
todo.setDetails(details);
todo.setDone(done);
Todo savedTodo = todoRepository.save(todo);
return savedTodo;
}
/**
* Delete a Todo owned by this user
* @param id id of the todo to delete
* @return a message indicating the todo was deleted
*/
@Operation(summary = "Delete a Todo owned by this user")
@PreAuthorize("hasRole('ROLE_USER')")
@DeleteMapping("")
public Object deleteTodo(
@Parameter(name="id") @RequestParam Long id) {
User currentUser = getCurrentUser().getUser();
Todo todo = todoRepository.findByIdAndUser(id, currentUser)
.orElseThrow(() -> new EntityNotFoundException(Todo.class, id));
todoRepository.delete(todo);
return genericMessage("Todo with id %s deleted".formatted(id));
}
/**
* Delete a Todo regardless of ownership, admin only
* @param id id of the todo to delete
* @return a message indicating the todo was deleted
*/
@Operation(summary = "Delete another user's todo")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@DeleteMapping("/admin")
public Object deleteTodo_Admin(
@Parameter(name="id") @RequestParam Long id) {
Todo todo = todoRepository.findById(id)
.orElseThrow(() -> new EntityNotFoundException(Todo.class, id));
todoRepository.delete(todo);
return genericMessage("Todo with id %s deleted".formatted(id));
}
/**
* Update a single todo (if it belongs to current user)
* @param id id of the todo to update
* @param incomingTodo the new todo contents
* @return the updated todo object
*/
@Operation(summary = "Update a single todo (if it belongs to current user)")
@PreAuthorize("hasRole('ROLE_USER')")
@PutMapping("")
public Todo putTodoById(
@Parameter(name="id") @RequestParam Long id,
@RequestBody @Valid Todo incomingTodo) {
User currentUser = getCurrentUser().getUser();
Todo todo = todoRepository.findByIdAndUser(id, currentUser)
.orElseThrow(() -> new EntityNotFoundException(Todo.class, id));
todo.setTitle(incomingTodo.getTitle());
todo.setDetails(incomingTodo.getDetails());
todo.setDone(incomingTodo.isDone());
todoRepository.save(todo);
return todo;
}
/**
* Update a single todo (regardless of ownership, admin only, can't change ownership)
* @param id id of the todo to update
* @param incomingTodo the new todo contents
* @return the updated todo object
*/
@Operation(summary = "Update a single todo (regardless of ownership, admin only, can't change ownership)")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@PutMapping("/admin")
public Todo putTodoById_admin(
@Parameter(name="id") @RequestParam Long id,
@RequestBody @Valid Todo incomingTodo) {
Todo todo = todoRepository.findById(id)
.orElseThrow(() -> new EntityNotFoundException(Todo.class, id));
todo.setTitle(incomingTodo.getTitle());
todo.setDetails(incomingTodo.getDetails());
todo.setDone(incomingTodo.isDone());
todoRepository.save(todo);
return todo;
}
}