ReportsController.java
package edu.ucsb.cs156.happiercows.controllers;
import edu.ucsb.cs156.happiercows.entities.Report;
import edu.ucsb.cs156.happiercows.entities.ReportLine;
import edu.ucsb.cs156.happiercows.errors.EntityNotFoundException;
import edu.ucsb.cs156.happiercows.helpers.ReportCSVHelper;
import edu.ucsb.cs156.happiercows.repositories.GameRepository;
import edu.ucsb.cs156.happiercows.repositories.ReportLineRepository;
import edu.ucsb.cs156.happiercows.repositories.ReportRepository;
import edu.ucsb.cs156.happiercows.repositories.FarmerRepository;
import io.swagger.v3.oas.annotations.tags.Tag;
import io.swagger.v3.oas.annotations.Operation;
import io.swagger.v3.oas.annotations.Parameter;
import org.springframework.data.domain.Sort.Order;
import org.springframework.http.HttpHeaders;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import java.io.ByteArrayInputStream;
import java.io.IOException;
import java.util.List;
import java.util.Optional;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.core.io.InputStreamResource;
import org.springframework.core.io.Resource;
import org.springframework.data.domain.Sort;
import org.springframework.security.access.prepost.PreAuthorize;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.bind.annotation.DeleteMapping;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;
@Tag(name = "Reports")
@RequestMapping("/api/reports")
@RestController
public class ReportsController extends ApiController {
@Autowired
GameRepository gameRepository;
@Autowired
FarmerRepository farmerRepository;
@Autowired
ReportRepository reportRepository;
@Autowired
ReportLineRepository reportLineRepository;
@Operation(summary = "Get all report headers")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@GetMapping("")
public Iterable<Report> allReports() {
Iterable<Report> reports = reportRepository.findAll(
Sort.by(List.of(
new Order(Sort.Direction.ASC, "gameId"),
new Order(Sort.Direction.DESC, "id"))));
return reports;
}
@Operation(summary = "Get report headers for a given report")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@GetMapping("/byReportId")
public Optional<Report> findByReportId(
@Parameter(name = "reportId") @RequestParam Long reportId) {
Optional<Report> reports = reportRepository.findById(reportId);
return reports;
}
@Operation(summary = "Get report headers for a given user game")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@GetMapping("/headers")
public Iterable<Report> allReportsByGameId(
@Parameter(name = "gameId") @RequestParam Long gameId) {
Iterable<Report> reports = reportRepository.findAllByGameId(gameId);
return reports;
}
@Operation(summary = "Get report lines for a report id")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@GetMapping("/lines")
public Iterable<ReportLine> allLinesByReportId(
@Parameter(name = "reportId") @RequestParam Long reportId) {
Iterable<ReportLine> reportLines = reportLineRepository.findAllByReportId(reportId);
return reportLines;
}
@Operation(summary = "Get report lines for a report id and user game id")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@GetMapping("/download")
public ResponseEntity<Resource> getLinesCSV(
@Parameter(name = "reportId") @RequestParam Long reportId) throws IOException {
Iterable<ReportLine> reportLines = reportLineRepository.findAllByReportId(reportId);
String filename = String.format("report%05d.csv",reportId);
ByteArrayInputStream bais = ReportCSVHelper.toCSV(reportLines);
InputStreamResource isr = new InputStreamResource(bais);
return ResponseEntity.ok()
.header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=" + filename)
.contentType(MediaType.parseMediaType("application/csv"))
.body(isr);
}
// Spring Data's derived deleteAllByReportId query (unlike save()/delete())
// requires an active transaction to run; without @Transactional here this
// throws TransactionRequiredException, since open-in-view is disabled and
// each repository call would otherwise get its own short-lived context.
@Operation(summary = "Delete a report, along with all of its detail rows")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@DeleteMapping("")
@Transactional
public Object deleteReport(
@Parameter(name = "reportId") @RequestParam Long reportId) {
Report report = reportRepository.findById(reportId)
.orElseThrow(() -> new EntityNotFoundException(Report.class, reportId));
reportLineRepository.deleteAllByReportId(reportId);
reportRepository.delete(report);
return genericMessage("Report with id %s deleted".formatted(reportId));
}
// "Older" means an earlier createDate than the given report - not a lower
// id, and not scoped to the given report's game. See the comment on
// deleteReport above re: why @Transactional is required.
@Operation(summary = "Purge all reports (and their detail rows) with an earlier creation date than a given report")
@PreAuthorize("hasRole('ROLE_ADMIN')")
@DeleteMapping("/purge")
@Transactional
public Object purgeOlderReports(
@Parameter(name = "reportId") @RequestParam Long reportId) {
Report report = reportRepository.findById(reportId)
.orElseThrow(() -> new EntityNotFoundException(Report.class, reportId));
Iterable<Report> olderReports = reportRepository.findAllByCreateDateLessThan(report.getCreateDate());
int count = 0;
for (Report olderReport : olderReports) {
reportLineRepository.deleteAllByReportId(olderReport.getId());
reportRepository.delete(olderReport);
count++;
}
return genericMessage("Purged %d report(s) older than report with id %s".formatted(count, reportId));
}
}