Additional report endpoints

1 files changed, 154 insertions, 67 deletions

diff --git a/src/main/java/org/traccar/api/resource/ReportResource.java b/src/main/java/org/traccar/api/resource/ReportResource.java
index 3955f1d20..6176013c1 100644
--- a/src/main/java/org/traccar/api/resource/ReportResource.java
+++ b/src/main/java/org/traccar/api/resource/ReportResource.java
@@ -16,26 +16,6 @@
  */
 package org.traccar.api.resource;
 
-import java.io.ByteArrayOutputStream;
-import java.io.IOException;
-import java.util.Collection;
-import java.util.Date;
-import java.util.List;
-
-import javax.activation.DataHandler;
-import javax.inject.Inject;
-import javax.mail.MessagingException;
-import javax.mail.internet.MimeBodyPart;
-import javax.mail.util.ByteArrayDataSource;
-import javax.ws.rs.Consumes;
-import javax.ws.rs.GET;
-import javax.ws.rs.Path;
-import javax.ws.rs.Produces;
-import javax.ws.rs.QueryParam;
-import javax.ws.rs.core.HttpHeaders;
-import javax.ws.rs.core.MediaType;
-import javax.ws.rs.core.Response;
-
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 import org.traccar.api.BaseResource;
@@ -46,15 +26,38 @@ import org.traccar.model.Position;
 import org.traccar.model.User;
 import org.traccar.model.UserRestrictions;
 import org.traccar.reports.EventsReportProvider;
+import org.traccar.reports.RouteReportProvider;
+import org.traccar.reports.StopsReportProvider;
 import org.traccar.reports.SummaryReportProvider;
 import org.traccar.reports.TripsReportProvider;
 import org.traccar.reports.model.StopReportItem;
 import org.traccar.reports.model.SummaryReportItem;
 import org.traccar.reports.model.TripReportItem;
-import org.traccar.reports.RouteReportProvider;
-import org.traccar.reports.StopsReportProvider;
 import org.traccar.storage.StorageException;
 
+import javax.activation.DataHandler;
+import javax.inject.Inject;
+import javax.mail.MessagingException;
+import javax.mail.internet.MimeBodyPart;
+import javax.mail.util.ByteArrayDataSource;
+import javax.ws.rs.Consumes;
+import javax.ws.rs.GET;
+import javax.ws.rs.Path;
+import javax.ws.rs.PathParam;
+import javax.ws.rs.Produces;
+import javax.ws.rs.QueryParam;
+import javax.ws.rs.WebApplicationException;
+import javax.ws.rs.core.HttpHeaders;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.StreamingOutput;
+import java.io.ByteArrayOutputStream;
+import java.io.IOException;
+import java.io.OutputStream;
+import java.util.Collection;
+import java.util.Date;
+import java.util.List;
+
 @Path("reports")
 @Produces(MediaType.APPLICATION_JSON)
 @Consumes(MediaType.APPLICATION_JSON)
@@ -62,8 +65,7 @@ public class ReportResource extends BaseResource {
 
     private static final Logger LOGGER = LoggerFactory.getLogger(ReportResource.class);
 
-    private static final String XLSX = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
-    private static final String CONTENT_DISPOSITION_VALUE_XLSX = "attachment; filename=report.xlsx";
+    private static final String EXCEL = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet";
 
     @Inject
     private EventsReportProvider eventsReportProvider;
@@ -84,19 +86,18 @@ public class ReportResource extends BaseResource {
     private MailManager mailManager;
 
     private interface ReportExecutor {
-        void execute(ByteArrayOutputStream stream) throws StorageException, IOException;
+        void execute(OutputStream stream) throws StorageException, IOException;
     }
 
     private Response executeReport(
-            long userId, boolean mail, ReportExecutor executor) throws StorageException, IOException {
-        final ByteArrayOutputStream stream = new ByteArrayOutputStream();
+            long userId, boolean mail, ReportExecutor executor) {
         if (mail) {
             new Thread(() -> {
                 try {
+                    var stream = new ByteArrayOutputStream();
                     executor.execute(stream);
 
                     MimeBodyPart attachment = new MimeBodyPart();
-
                     attachment.setFileName("report.xlsx");
                     attachment.setDataHandler(new DataHandler(new ByteArrayDataSource(
                             stream.toByteArray(), "application/octet-stream")));
@@ -109,17 +110,25 @@ public class ReportResource extends BaseResource {
             }).start();
             return Response.noContent().build();
         } else {
-            executor.execute(stream);
-            return Response.ok(stream.toByteArray())
-                    .header(HttpHeaders.CONTENT_DISPOSITION, CONTENT_DISPOSITION_VALUE_XLSX).build();
+            StreamingOutput stream = output -> {
+                try {
+                    executor.execute(output);
+                } catch (StorageException e) {
+                    throw new WebApplicationException(e);
+                }
+            };
+            return Response.ok(stream)
+                    .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename=report.xlsx").build();
         }
     }
 
     @Path("route")
     @GET
     public Collection<Position> getRoute(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("from") Date from, @QueryParam("to") Date to) throws StorageException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         LogAction.logReport(getUserId(), "route", from, to, deviceIds, groupIds);
         return routeReportProvider.getObjects(getUserId(), deviceIds, groupIds, from, to);
@@ -127,11 +136,13 @@ public class ReportResource extends BaseResource {
 
     @Path("route")
     @GET
-    @Produces(XLSX)
+    @Produces(EXCEL)
     public Response getRouteExcel(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("from") Date from, @QueryParam("to") Date to, @QueryParam("mail") boolean mail)
-            throws StorageException, IOException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @QueryParam("mail") boolean mail) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         return executeReport(getUserId(), mail, stream -> {
             LogAction.logReport(getUserId(), "route", from, to, deviceIds, groupIds);
@@ -139,12 +150,26 @@ public class ReportResource extends BaseResource {
         });
     }
 
+    @Path("route/{type:xlsx|mail}")
+    @GET
+    @Produces(EXCEL)
+    public Response getRouteExcel(
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") final List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @PathParam("type") String type) throws StorageException {
+        return getRouteExcel(deviceIds, groupIds, from, to, type.equals("mail"));
+    }
+
     @Path("events")
     @GET
     public Collection<Event> getEvents(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("type") final List<String> types,
-            @QueryParam("from") Date from, @QueryParam("to") Date to) throws StorageException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("type") List<String> types,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         LogAction.logReport(getUserId(), "events", from, to, deviceIds, groupIds);
         return eventsReportProvider.getObjects(getUserId(), deviceIds, groupIds, types, from, to);
@@ -152,12 +177,14 @@ public class ReportResource extends BaseResource {
 
     @Path("events")
     @GET
-    @Produces(XLSX)
+    @Produces(EXCEL)
     public Response getEventsExcel(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("type") final List<String> types,
-            @QueryParam("from") Date from, @QueryParam("to") Date to, @QueryParam("mail") boolean mail)
-            throws StorageException, IOException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("type") List<String> types,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @QueryParam("mail") boolean mail) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         return executeReport(getUserId(), mail, stream -> {
             LogAction.logReport(getUserId(), "events", from, to, deviceIds, groupIds);
@@ -165,12 +192,27 @@ public class ReportResource extends BaseResource {
         });
     }
 
+    @Path("events/{type:xlsx|mail}")
+    @GET
+    @Produces(EXCEL)
+    public Response getEventsExcel(
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("type") List<String> types,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @PathParam("type") String type) throws StorageException {
+        return getEventsExcel(deviceIds, groupIds, types, from, to, type.equals("mail"));
+    }
+
     @Path("summary")
     @GET
     public Collection<SummaryReportItem> getSummary(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("from") Date from, @QueryParam("to") Date to, @QueryParam("daily") boolean daily)
-            throws StorageException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @QueryParam("daily") boolean daily) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         LogAction.logReport(getUserId(), "summary", from, to, deviceIds, groupIds);
         return summaryReportProvider.getObjects(getUserId(), deviceIds, groupIds, from, to, daily);
@@ -178,12 +220,14 @@ public class ReportResource extends BaseResource {
 
     @Path("summary")
     @GET
-    @Produces(XLSX)
+    @Produces(EXCEL)
     public Response getSummaryExcel(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("from") Date from, @QueryParam("to") Date to, @QueryParam("daily") boolean daily,
-            @QueryParam("mail") boolean mail)
-            throws StorageException, IOException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @QueryParam("daily") boolean daily,
+            @QueryParam("mail") boolean mail) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         return executeReport(getUserId(), mail, stream -> {
             LogAction.logReport(getUserId(), "summary", from, to, deviceIds, groupIds);
@@ -191,12 +235,26 @@ public class ReportResource extends BaseResource {
         });
     }
 
+    @Path("summary/{type:xlsx|mail}")
+    @GET
+    @Produces(EXCEL)
+    public Response getSummaryExcel(
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @QueryParam("daily") boolean daily,
+            @PathParam("type") String type) throws StorageException {
+        return getSummaryExcel(deviceIds, groupIds, from, to, daily, type.equals("mail"));
+    }
+
     @Path("trips")
     @GET
-    @Produces(MediaType.APPLICATION_JSON)
     public Collection<TripReportItem> getTrips(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("from") Date from, @QueryParam("to") Date to) throws StorageException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         LogAction.logReport(getUserId(), "trips", from, to, deviceIds, groupIds);
         return tripsReportProvider.getObjects(getUserId(), deviceIds, groupIds, from, to);
@@ -204,11 +262,13 @@ public class ReportResource extends BaseResource {
 
     @Path("trips")
     @GET
-    @Produces(XLSX)
+    @Produces(EXCEL)
     public Response getTripsExcel(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("from") Date from, @QueryParam("to") Date to, @QueryParam("mail") boolean mail)
-            throws StorageException, IOException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @QueryParam("mail") boolean mail) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         return executeReport(getUserId(), mail, stream -> {
             LogAction.logReport(getUserId(), "trips", from, to, deviceIds, groupIds);
@@ -216,12 +276,25 @@ public class ReportResource extends BaseResource {
         });
     }
 
+    @Path("trips/{type:xlsx|mail}")
+    @GET
+    @Produces(EXCEL)
+    public Response getTripsExcel(
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @PathParam("type") String type) throws StorageException {
+        return getTripsExcel(deviceIds, groupIds, from, to, type.equals("mail"));
+    }
+
     @Path("stops")
     @GET
-    @Produces(MediaType.APPLICATION_JSON)
     public Collection<StopReportItem> getStops(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("from") Date from, @QueryParam("to") Date to) throws StorageException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         LogAction.logReport(getUserId(), "stops", from, to, deviceIds, groupIds);
         return stopsReportProvider.getObjects(getUserId(), deviceIds, groupIds, from, to);
@@ -229,11 +302,13 @@ public class ReportResource extends BaseResource {
 
     @Path("stops")
     @GET
-    @Produces(XLSX)
+    @Produces(EXCEL)
     public Response getStopsExcel(
-            @QueryParam("deviceId") final List<Long> deviceIds, @QueryParam("groupId") final List<Long> groupIds,
-            @QueryParam("from") Date from, @QueryParam("to") Date to, @QueryParam("mail") boolean mail)
-            throws StorageException, IOException {
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @QueryParam("mail") boolean mail) throws StorageException {
         permissionsService.checkRestriction(getUserId(), UserRestrictions::getDisableReports);
         return executeReport(getUserId(), mail, stream -> {
             LogAction.logReport(getUserId(), "stops", from, to, deviceIds, groupIds);
@@ -241,4 +316,16 @@ public class ReportResource extends BaseResource {
         });
     }
 
+    @Path("stops/{type:xlsx|mail}")
+    @GET
+    @Produces(EXCEL)
+    public Response getStopsExcel(
+            @QueryParam("deviceId") List<Long> deviceIds,
+            @QueryParam("groupId") List<Long> groupIds,
+            @QueryParam("from") Date from,
+            @QueryParam("to") Date to,
+            @PathParam("type") String type) throws StorageException {
+        return getStopsExcel(deviceIds, groupIds, from, to, type.equals("mail"));
+    }
+
 }