feat: export observations from Observations list

StefanFl · StefanFl · commit f8a86e71d3b8 · 2026-02-22T19:32:21.000Z
diff --git a/backend/application/commons/services/export.py b/backend/application/commons/services/export.py
@@ -12,6 +12,7 @@
 
 logger = logging.getLogger("secobserve.commons")
 
+
 def export_excel(objects: QuerySet, title: str, excludes: list[str], foreign_keys: list[str]) -> Workbook:
     workbook = Workbook()
     workbook.iso_dates = True
@@ -45,7 +46,7 @@ def export_excel(objects: QuerySet, title: str, excludes: list[str], foreign_key
                     try:
                         worksheet.cell(row=row_num, column=col_num, value=value)
                     except Exception as e:
-                        logger.warning(f"Cannot set cell with type {type(value)}")
+                        logger.warning("Cannot set cell with type %s", type(value))
                         logger.warning(str(e))
                     col_num += 1
         row_num += 1
diff --git a/backend/application/core/api/views.py b/backend/application/core/api/views.py
@@ -133,7 +133,9 @@
 )
 from application.core.services.export_observations import (
     export_observations_csv,
+    export_observations_csv_for_product,
     export_observations_excel,
+    export_observations_excel_for_product,
 )
 from application.core.services.observations_bulk_actions import (
     observation_logs_bulk_approval,
@@ -230,7 +232,7 @@ def export_observations_excel(self, request: Request, pk: int) -> HttpResponse:
             if status and (status, status) not in Status.STATUS_CHOICES:
                 raise ValidationError(f"Status {status} is not a valid choice")
 
-        workbook = export_observations_excel(product, statuses)
+        workbook = export_observations_excel_for_product(product, statuses)
 
         with NamedTemporaryFile() as tmp:
             workbook.save(tmp.name)  # nosemgrep: python.lang.correctness.tempfile.flush.tempfile-without-flush
@@ -265,7 +267,7 @@ def export_observations_csv(self, request: Request, pk: int) -> HttpResponse:
         response = HttpResponse(content_type="text/csv")
         response["Content-Disposition"] = "attachment; filename=observations.csv"
 
-        export_observations_csv(response, product, statuses)
+        export_observations_csv_for_product(response, product, statuses)
 
         return response
 
@@ -678,6 +680,47 @@ def count_reviews(self, request: Request) -> Response:
         count = get_observations().filter(current_status=Status.STATUS_IN_REVIEW).count()
         return Response(status=HTTP_200_OK, data={"count": count})
 
+    @extend_schema(
+        methods=["GET"],
+        responses={200: None},
+    )
+    @action(detail=False, methods=["get"])
+    def export_excel(self, request: Request) -> HttpResponse:
+        queryset = self._filter_queryset(request)
+        workbook = export_observations_excel(queryset)
+
+        with NamedTemporaryFile() as tmp:
+            workbook.save(tmp.name)  # nosemgrep: python.lang.correctness.tempfile.flush.tempfile-without-flush
+            # export works fine without .flush()
+            tmp.seek(0)
+            stream = tmp.read()
+
+        response = HttpResponse(
+            content=stream,
+            content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet",
+        )
+        response["Content-Disposition"] = "attachment; filename=observations.xlsx"
+        return response
+
+    @extend_schema(
+        methods=["GET"],
+        responses={200: None},
+        parameters=[],
+    )
+    @action(detail=False, methods=["get"])
+    def export_csv(self, request: Request) -> HttpResponse:
+        queryset = self._filter_queryset(request)
+        response = HttpResponse(content_type="text/csv")
+        response["Content-Disposition"] = "attachment; filename=observations.csv"
+        export_observations_csv(response, queryset)
+        return response
+
+    def _filter_queryset(self, request: Request) -> QuerySet:
+        queryset = self.get_queryset()
+        for backend in self.filter_backends:
+            queryset = backend().filter_queryset(request, queryset, self)
+        return queryset
+
 
 class ObservationTitleViewSet(GenericViewSet, ListModelMixin, RetrieveModelMixin):
     serializer_class = ObservationTitleSerializer
diff --git a/backend/application/core/services/export_observations.py b/backend/application/core/services/export_observations.py
@@ -8,19 +8,22 @@
 from application.core.models import Observation, Product
 
 
-def export_observations_excel(product: Product, status: Optional[list[str]]) -> Workbook:
-    observations = _get_observations(product, status)
+def export_observations_excel(observations: QuerySet) -> Workbook:
     return export_excel(observations, "Observations", _get_excludes(), _get_foreign_keys())
 
 
-def export_observations_csv(response: HttpResponse, product: Product, status: Optional[list[str]]) -> None:
+def export_observations_excel_for_product(product: Product, status: Optional[list[str]]) -> Workbook:
+    observations = _get_observations(product, status)
+    return export_observations_excel(observations)
+
+
+def export_observations_csv(response: HttpResponse, observations: QuerySet) -> None:
+    export_csv(response, observations, _get_excludes(), _get_foreign_keys())
+
+
+def export_observations_csv_for_product(response: HttpResponse, product: Product, status: Optional[list[str]]) -> None:
     observations = _get_observations(product, status)
-    export_csv(
-        response,
-        observations,
-        _get_excludes(),
-        _get_foreign_keys(),
-    )
+    export_observations_csv(response, observations)
 
 
 def _get_observations(product: Product, status: Optional[list[str]]) -> QuerySet:
diff --git a/frontend/src/core/observations/ExportMenu.tsx b/frontend/src/core/observations/ExportMenu.tsx
@@ -0,0 +1,131 @@
+import { faFileCsv, faFileExcel } from "@fortawesome/free-solid-svg-icons";
+import { FontAwesomeIcon } from "@fortawesome/react-fontawesome";
+import DownloadIcon from "@mui/icons-material/Download";
+import { ListItemIcon } from "@mui/material";
+import Button from "@mui/material/Button";
+import Menu from "@mui/material/Menu";
+import MenuItem from "@mui/material/MenuItem";
+import queryString from "query-string";
+import { Fragment, MouseEvent, useState } from "react";
+import { useListContext, useNotify } from "react-admin";
+
+import axios_instance from "../../access_control/auth_provider/axios_instance";
+import { getIconAndFontColor } from "../../commons/functions";
+
+const ExportMenu = () => {
+    const notify = useNotify();
+    const [anchorEl, setAnchorEl] = useState<null | HTMLElement>(null);
+    const open = Boolean(anchorEl);
+    const { filterValues, sort } = useListContext();
+    const handleClick = (event: MouseEvent<HTMLButtonElement>) => {
+        setAnchorEl(event.currentTarget);
+    };
+    const handleClose = () => {
+        setAnchorEl(null);
+    };
+
+    const exportDataCsv = async (url: string, filename: string, message: string) => {
+        axios_instance
+            .get(url)
+            .then(function (response) {
+                const blob = new Blob([response.data], { type: "text/csv" });
+                const url = window.URL.createObjectURL(blob);
+                const link = document.createElement("a");
+                link.href = url;
+                link.download = filename;
+                link.click();
+
+                notify(message + " downloaded", {
+                    type: "success",
+                });
+            })
+            .catch(function (error) {
+                notify(error.message, {
+                    type: "warning",
+                });
+            });
+        handleClose();
+    };
+
+    const exportDataExcel = async (url: string, filename: string, message: string) => {
+        axios_instance
+            .get(url, {
+                responseType: "arraybuffer",
+                headers: { Accept: "*/*" },
+            })
+            .then(function (response) {
+                const blob = new Blob([response.data], {
+                    type: "application/zip",
+                });
+                const url = window.URL.createObjectURL(blob);
+                const link = document.createElement("a");
+                link.href = url;
+                link.download = filename;
+                link.click();
+
+                notify(message + " downloaded", {
+                    type: "success",
+                });
+            })
+            .catch(function (error) {
+                notify(error.message, {
+                    type: "warning",
+                });
+            });
+        handleClose();
+    };
+
+    const exportObservationsExcel = async () => {
+        exportDataExcel("/observations/export_excel/?" + queryParams(), "open_observations.xlsx", "Observations");
+    };
+
+    const exportObservationsCsv = async () => {
+        exportDataCsv("/observations/export_csv/?" + queryParams(), "open_observations.csv", "Observations");
+    };
+
+    const queryParams = () => {
+        const query = { ...filterValues, ...sort };
+        return queryString.stringify(query);
+    };
+
+    return (
+        <Fragment>
+            <Button
+                id="export-button"
+                aria-controls={open ? "export-menu" : undefined}
+                aria-haspopup="true"
+                aria-expanded={open ? "true" : undefined}
+                onClick={handleClick}
+                size="small"
+                sx={{ paddingTop: 0, paddingBottom: 0, paddingLeft: "5px", paddingRight: "5px" }}
+                startIcon={<DownloadIcon />}
+            >
+                Export
+            </Button>
+            <Menu
+                id="basic-menu"
+                anchorEl={anchorEl}
+                open={open}
+                onClose={handleClose}
+                MenuListProps={{
+                    "aria-labelledby": "basic-button",
+                }}
+            >
+                <MenuItem onClick={exportObservationsExcel}>
+                    <ListItemIcon>
+                        <FontAwesomeIcon icon={faFileExcel} color={getIconAndFontColor()} />
+                    </ListItemIcon>
+                    Observations / Excel
+                </MenuItem>
+                <MenuItem onClick={exportObservationsCsv}>
+                    <ListItemIcon>
+                        <FontAwesomeIcon icon={faFileCsv} color={getIconAndFontColor()} />
+                    </ListItemIcon>
+                    Observations / CSV
+                </MenuItem>
+            </Menu>
+        </Fragment>
+    );
+};
+
+export default ExportMenu;
diff --git a/frontend/src/core/observations/ObservationList.tsx b/frontend/src/core/observations/ObservationList.tsx
@@ -32,6 +32,7 @@ import {
     Observation,
     PURL_TYPE_CHOICES,
 } from "../types";
+import ExportMenu from "./ExportMenu";
 import ObservationBulkAssessment from "./ObservationBulkAssessment";
 import ObservationExpand from "./ObservationExpand";
 import { IDENTIFIER_OBSERVATION_LIST, setListIdentifier } from "./functions";
@@ -91,6 +92,7 @@ function listFilters() {
 
 const ListActions = () => (
     <TopToolbar>
+        <ExportMenu />
         <FilterButton />
     </TopToolbar>
 );
diff --git a/frontend/src/rules/functions.tsx b/frontend/src/rules/functions.tsx
@@ -95,8 +95,6 @@ export const validateRuleForm = (values: any) => {
         }
     }
 
-    console.log(errors);
-
     return errors;
 };
 

Original file line number	Diff line number	Diff line change
`@@ -95,8 +95,6 @@ export const validateRuleForm = (values: any) => {`
`95`	`95`	`}`
`96`	`96`	`}`
`97`	`97`
`98`		`- console.log(errors);`
`99`		`-`
`100`	`98`	`return errors;`
`101`	`99`	`};`
`102`	`100`