Add csv export

src/api/Controllers/BoreholeController.cs

@@ -1,10 +1,12 @@
 using BDMS.Authentication;
 using BDMS.Models;
+using CsvHelper;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.EntityFrameworkCore;
 using NetTopologySuite.Geometries;
 using System.ComponentModel.DataAnnotations;
+using System.Globalization;
 
 namespace BDMS.Controllers;
 
@@ -77,7 +79,7 @@ public async override Task<ActionResult<Borehole>> EditAsync(Borehole entity)
     /// <param name="pageSize">The page size for pagination.</param>
     [HttpGet]
     [Authorize(Policy = PolicyNames.Viewer)]
-    public async Task<ActionResult<PaginatedBoreholeResponse>> GetAllAsync([FromQuery][MaxLength(MaxPageSize)] IEnumerable<int>? ids = null, [FromQuery][Range(1, int.MaxValue)] int pageNumber = 1, [FromQuery] [Range(1, MaxPageSize)] int pageSize = 100)
+    public async Task<ActionResult<PaginatedBoreholeResponse>> GetAllAsync([FromQuery][MaxLength(MaxPageSize)] IEnumerable<int>? ids = null, [FromQuery][Range(1, int.MaxValue)] int pageNumber = 1, [FromQuery][Range(1, MaxPageSize)] int pageSize = 100)
     {
         pageSize = Math.Min(MaxPageSize, Math.Max(1, pageSize));
 
@@ -142,6 +144,71 @@ private IQueryable<Borehole> GetBoreholesWithIncludes()
             .Include(b => b.UpdatedBy);
     }
 
+    /// <summary>
+    /// Exports the details of up to 100 boreholes as a CSV file. Filters the boreholes based on the provided list of IDs.
+    /// </summary>
+    /// <param name="ids">The list of IDs for the boreholes to be exported.</param>
+    /// <returns>A CSV file containing the details of up to 100 specified boreholes.</returns>
+    [HttpGet("export-csv")]
+    [Authorize(Policy = PolicyNames.Viewer)]
+    public async Task<IActionResult> DownloadCsv([FromQuery] IEnumerable<int> ids)
+    {
+        if (!ids.Any())
+        {
+            return BadRequest("The list of IDs must not be empty.");
+        }
+        Logger.LogInformation("Export borehole(s) with ids <{Ids}>.", string.Join(", ", ids));
+
+        var boreholes = await Context.Boreholes
+                                    .Where(borehole => ids.Contains(borehole.Id))
+                                    .Take(100)
+                                    .Select(b => new
+                                    {
+                                        b.Id,
+                                        b.OriginalName,
+                                        b.ProjectName,
+                                        b.AlternateName,
+                                        b.RestrictionId,
+                                        b.RestrictionUntil,
+                                        b.NationalInterest,
+                                        b.LocationX,
+                                        b.LocationY,
+                                        b.LocationPrecisionId,
+                                        b.ElevationZ,
+                                        b.ElevationPrecisionId,
+                                        b.ReferenceElevation,
+                                        b.ReferenceElevationTypeId,
+                                        b.QtReferenceElevationId,
+                                        b.HrsId,
+                                        b.TypeId,
+                                        b.PurposeId,
+                                        b.StatusId,
+                                        b.Remarks,
+                                        b.TotalDepth,
+                                        b.QtDepthId,
+                                        b.TopBedrockFreshMd,
+                                        b.TopBedrockWeatheredMd,
+                                        b.HasGroundwater,
+                                        b.LithologyTopBedrockId,
+                                        b.ChronostratigraphyId,
+                                        b.LithostratigraphyId,
+
+                                    })
+                                .ToListAsync()
+                                .ConfigureAwait(false);
+
+        var stream = new MemoryStream();
+        using (var writer = new StreamWriter(stream, leaveOpen: true))
+        using (var csvWriter = new CsvWriter(writer, CultureInfo.InvariantCulture))
+        {
+            csvWriter.WriteRecords(boreholes);
+        }
+
+        stream.Position = 0;
+
+        return File(stream.ToArray(), "text/csv", "boreholes_export.csv");
+    }
+
     /// <summary>
     /// Asynchronously copies a <see cref="Borehole"/>.
     /// </summary>
@@ -179,7 +246,7 @@ public async Task<ActionResult<int>> CopyAsync([Required] int id, [Required] int
         {
             // Include FieldMeasurementResults and HydrotestResults separately since Entity Framework does not support casting in an Include statement
             var fieldMeasurements = borehole.Observations.OfType<FieldMeasurement>().ToList();
-           #pragma warning disable CS8603
+#pragma warning disable CS8603
             // Cannot include null test for fieldMeasurementResults and hydrotestResults since they are not yet loaded
             // if there are no fieldMeasurementResults of hydrotestResults the LoadAsync method will be called but have no effect
             foreach (var fieldMeasurement in fieldMeasurements)
@@ -193,12 +260,12 @@ await Context.Entry(fieldMeasurement)
             var hydrotests = borehole.Observations.OfType<Hydrotest>().ToList();
             foreach (var hydrotest in hydrotests)
             {
-                    await Context.Entry(hydrotest)
-                        .Collection(h => h.HydrotestResults)
-                        .LoadAsync()
-                        .ConfigureAwait(false);
+                await Context.Entry(hydrotest)
+                    .Collection(h => h.HydrotestResults)
+                    .LoadAsync()
+                    .ConfigureAwait(false);
             }
-            #pragma warning restore CS8603
+#pragma warning restore CS8603
         }
 
         // Set ids of copied entities to zero. Entities with an id of zero are added as new entities to the DB.

src/client/src/api/borehole.ts

@@ -84,3 +84,8 @@ export const getAllBoreholes = async (ids: number[] | GridRowSelectionModel, pag
   const idsQuery = ids.map(id => `ids=${id}`).join("&");
   return await fetchApiV2(`borehole?${idsQuery}&pageNumber=${pageNumber}&pageSize=${pageSize}`, "GET");
 };
+
+export const exportCSVBorehole = async (boreholeIds: GridRowSelectionModel) => {
+  const idsQuery = boreholeIds.map(id => `ids=${id}`).join("&");
+  return await fetchApiV2(`borehole/export-csv?${idsQuery}`, "GET");
+};

src/client/src/components/buttons/buttons.tsx

@@ -124,7 +124,7 @@ export const ExportButton = forwardRef<HTMLButtonElement, ButtonProps>((props, r
     <BdmsBaseButton
       ref={ref}
       {...props}
-      label="export"
+      label={props.label ?? "export"}
       variant={props.variant ?? "outlined"}
       color={props.color ?? "secondary"}
       icon={<ArrowDownToLine />}

src/client/src/pages/detail/detailHeader.tsx

@@ -5,7 +5,7 @@ import { useHistory } from "react-router-dom";
 import { Chip, Stack, Typography } from "@mui/material";
 import { Check, Trash2, X } from "lucide-react";
 import { deleteBorehole, lockBorehole, unlockBorehole } from "../../api-lib";
-import { BoreholeV2 } from "../../api/borehole.ts";
+import { BoreholeV2, exportCSVBorehole } from "../../api/borehole.ts";
 import { useAuth } from "../../auth/useBdmsAuth.tsx";
 import {
   DeleteButton,
@@ -17,6 +17,7 @@ import {
 import DateText from "../../components/legacyComponents/dateText";
 import { PromptContext } from "../../components/prompt/promptContext.tsx";
 import { DetailHeaderStack } from "../../components/styledComponents.ts";
+import { downloadData } from "../../utils.ts";
 import { useFormDirty } from "./useFormDirty.tsx";
 
 interface DetailHeaderProps {
@@ -84,18 +85,14 @@ const DetailHeader = ({
     history.push("/");
   };
 
-  const handleExport = () => {
+  const handleJsonExport = () => {
     const jsonString = JSON.stringify([borehole], null, 2);
-    const blob = new Blob([jsonString], { type: "application/json" });
-    const url = URL.createObjectURL(blob);
-    const link = document.createElement("a");
-    link.href = url;
-    const name_without_spaces = borehole.alternateName.replace(/\s/g, "_");
-    link.download = `${name_without_spaces}.json`;
-    document.body.appendChild(link);
-    link.click();
-    link.remove();
-    URL.revokeObjectURL(url);
+    downloadData(jsonString, borehole.alternateName.replace(/\s/g, "_"), "application/json");
+  };
+
+  const handleCSVExport = async () => {
+    const csvData = await exportCSVBorehole([borehole.id]);
+    downloadData(csvData, borehole.alternateName.replace(/\s/g, "_"), "text/csv");
   };
 
   return (
@@ -150,7 +147,8 @@ const DetailHeader = ({
             </>
           ) : (
             <>
-              <ExportButton onClick={handleExport} />
+              <ExportButton label="exportJson" onClick={handleJsonExport} />
+              <ExportButton label="exportCSV" onClick={handleCSVExport} />
               <EditButton onClick={startEditing} />
             </>
           ))}

src/client/src/pages/overview/boreholeTable/bottomBar.tsx

@@ -20,7 +20,8 @@ interface BottomBarProps {
   search: { filter: string };
   onDeleteMultiple: () => void;
   onCopyBorehole: () => void;
-  onExportMultiple: () => void;
+  onExportMultipleJson: () => void;
+  onExportMultipleCsv: () => void;
   workgroup: string;
   setWorkgroup: React.Dispatch<React.SetStateAction<string>>;
 }
@@ -31,7 +32,8 @@ const BottomBar = ({
   onDeleteMultiple,
   search,
   onCopyBorehole,
-  onExportMultiple,
+  onExportMultipleJson,
+  onExportMultipleCsv,
   boreholes,
   workgroup,
   setWorkgroup,
@@ -115,7 +117,8 @@ const BottomBar = ({
             <CopyButton color="secondary" onClick={() => showCopyPromptForSelectedWorkgroup()} />
           )}
           <BulkEditButton label={"bulkEditing"} onClick={bulkEditSelected} />
-          <ExportButton label={"export"} onClick={onExportMultiple} />
+          <ExportButton label={"exportJson"} onClick={onExportMultipleJson} />
+          <ExportButton label={"exportCSV"} onClick={onExportMultipleCsv} />
           <Typography variant="subtitle1"> {t("selectedCount", { count: selectionModel.length })}</Typography>
         </Stack>
       ) : (

src/client/src/pages/overview/boreholeTable/bottomBarContainer.tsx

@@ -4,7 +4,8 @@ import { useHistory } from "react-router-dom";
 import { GridRowSelectionModel, GridSortDirection, GridSortModel } from "@mui/x-data-grid";
 import { deleteBoreholes } from "../../../api-lib";
 import { Boreholes, ReduxRootState, User } from "../../../api-lib/ReduxStateInterfaces.ts";
-import { copyBorehole, getAllBoreholes } from "../../../api/borehole.ts";
+import { copyBorehole, exportCSVBorehole, getAllBoreholes } from "../../../api/borehole.ts";
+import { downloadData } from "../../../utils.ts";
 import { OverViewContext } from "../overViewContext.tsx";
 import { FilterContext } from "../sidePanelContent/filter/filterContext.tsx";
 import { BoreholeTable } from "./boreholeTable.tsx";
@@ -88,18 +89,15 @@ const BottomBarContainer = ({
     setIsBusy(false);
   };
 
-  const onExportMultiple = async () => {
+  const onExportMultipleJson = async () => {
     const paginatedResponse = await getAllBoreholes(selectionModel, 1, selectionModel.length);
     const jsonString = JSON.stringify(paginatedResponse.boreholes, null, 2);
-    const blob = new Blob([jsonString], { type: "application/json" });
-    const url = URL.createObjectURL(blob);
-    const link = document.createElement("a");
-    link.href = url;
-    link.download = `bulkexport_${new Date().toISOString().split("T")[0]}.json`;
-    document.body.appendChild(link);
-    link.click();
-    link.remove();
-    URL.revokeObjectURL(url);
+    downloadData(jsonString, `bulkexport_${new Date().toISOString().split("T")[0]}`, "application/json");
+  };
+
+  const onExportMultipleCsv = async () => {
+    const csvData = await exportCSVBorehole(selectionModel);
+    downloadData(csvData, `bulkexport__${new Date().toISOString().split("T")[0]}`, "text/csv");
   };
 
   return (
@@ -109,7 +107,8 @@ const BottomBarContainer = ({
         multipleSelected={multipleSelected}
         onCopyBorehole={onCopyBorehole}
         onDeleteMultiple={onDeleteMultiple}
-        onExportMultiple={onExportMultiple}
+        onExportMultipleJson={onExportMultipleJson}
+        onExportMultipleCsv={onExportMultipleCsv}
         search={search}
         boreholes={boreholes}
         workgroup={workgroupId}

src/client/src/utils.ts

@@ -2,3 +2,15 @@ export function capitalizeFirstLetter(text: string) {
   if (!text) return "";
   return text.charAt(0).toUpperCase() + text.slice(1);
 }
+
+export const downloadData = (dataString: string, fileName: string, type: string) => {
+  const blob = new Blob([dataString], { type: type });
+  const url = URL.createObjectURL(blob);
+  const link = document.createElement("a");
+  link.href = url;
+  link.download = fileName;
+  document.body.appendChild(link);
+  link.click();
+  link.remove();
+  URL.revokeObjectURL(url);
+};

tests/api/Controllers/BoreholeControllerTest.cs

@@ -5,6 +5,7 @@
 using Microsoft.Extensions.Logging;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 using Moq;
+using System.Text;
 using static BDMS.Helpers;
 
 namespace BDMS.Controllers;
@@ -550,4 +551,32 @@ public async Task CopyWithNonAdminUser()
         Assert.IsNotNull(copiedBoreholeId);
         Assert.IsInstanceOfType(copiedBoreholeId, typeof(int));
     }
+
+    [TestMethod]
+    public async Task DownloadCsvWithValidIdsReturnsFileResultWithMax100Boreholes()
+    {
+        var ids = Enumerable.Range(testBoreholeId, 120).ToList();
+
+        var result = await controller.DownloadCsv(ids) as FileContentResult;
+
+        Assert.IsNotNull(result);
+        Assert.AreEqual("text/csv", result.ContentType);
+        Assert.AreEqual("boreholes.csv", result.FileDownloadName);
+        var csvData = Encoding.UTF8.GetString(result.FileContents);
+        var fileLength = csvData.Split('\n').Length;
+        var recordCount = fileLength - 2; // Remove header and last line break
+        Assert.IsTrue(recordCount <= 100);
+    }
+
+    [TestMethod]
+    public async Task DownloadCsvEmptyIdsReturnsBadRequest()
+    {
+        var ids = new List<int>();
+
+        var result = await controller.DownloadCsv(ids) as BadRequestObjectResult;
+
+        Assert.IsNotNull(result);
+        Assert.AreEqual("The list of IDs must not be empty.", result.Value);
+    }
+
 }