Adds CSV generation and transmission

.gitignore

@@ -38,4 +38,6 @@ out/
 .vscode/
 
 ### Mac OS ###
-.DS_Store
+.DS_Store
+
+*.log

build.gradle

@@ -34,12 +34,15 @@ def useLocalLibrary = System.getenv('USE_LOCAL_LIBRARY')
 dependencies {
     implementation 'org.springframework.boot:spring-boot-starter-thymeleaf'
     implementation 'org.springframework.boot:spring-boot-starter-web'
+    implementation 'com.jcraft:jsch:0.1.55'
+    implementation 'org.springframework.shell:spring-shell-starter:3.0.4'
     implementation 'org.springframework.boot:spring-boot-starter-actuator'
     implementation("com.mixpanel:mixpanel-java:1.5.2")
     implementation group: 'ch.qos.logback', name: 'logback-classic', version: '1.4.14'
     implementation group: 'ch.qos.logback.contrib', name: 'logback-json-classic', version: '0.1.5'
     implementation group: 'ch.qos.logback.contrib', name: 'logback-jackson', version: '0.1.5'
     implementation group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.16.0'
+    implementation 'com.opencsv:opencsv:5.7.0'
 
     if (profile == 'dev' || useLocalLibrary == 'true') {
         implementation fileTree(dir: "$rootDir/../form-flow/build/libs", include: '*.jar')
@@ -53,9 +56,11 @@ dependencies {
     testImplementation 'org.projectlombok:lombok:1.18.30'
 
     implementation 'io.sentry:sentry-spring-boot-starter-jakarta:7.0.0'
-
     implementation 'io.sentry:sentry-logback:7.0.0'
 
+    testImplementation 'junit:junit:4.13.1'
+
+
     compileOnly 'org.projectlombok:lombok'
 
     developmentOnly 'org.springframework.boot:spring-boot-devtools'
@@ -81,6 +86,12 @@ springBoot {
     buildInfo()
 }
 
+dependencyManagement {
+    imports {
+        mavenBom "org.springframework.shell:spring-shell-dependencies:3.0.4"
+    }
+}
+
 test {
     useJUnitPlatform {
         JUnitPlatformOptions options ->

scripts/generate_migration.sh

@@ -0,0 +1,22 @@
+#!/bin/bash
+set -euo pipefail
+
+migrations_path="$(dirname $0)/../src/main/resources/db/migration"
+
+if [ ! -d "$migrations_path" ]; then
+  echo "Migration directory '$migrations_path' does not exist. Creating..."
+  mkdir -p "$migrations_path"
+fi
+
+migrations_path=$(realpath "$migrations_path")
+
+printf "Generating migration file. \nEnter Description (e.g. 'Create admin users'): "
+read description
+
+filename="V$(date +%Y.%m.%d.%H.%M.%S)__$(echo "$description" | sed -E 's/[^A-Z]+/_/ig').sql"
+echo "Creating ${filename}."
+touch "$migrations_path/$filename"
+
+echo "Hit enter to open."
+read
+open -a "IntelliJ IDEA.app" "$migrations_path/$filename"

src/main/java/org/ladocuploader/app/FileExportController.java

@@ -0,0 +1,157 @@
+package org.ladocuploader.app;
+
+
+
+import com.opencsv.exceptions.CsvDataTypeMismatchException;
+import com.opencsv.exceptions.CsvRequiredFieldEmptyException;
+
+
+import formflow.library.config.FlowConfiguration;
+import formflow.library.data.Submission;
+import formflow.library.data.SubmissionRepositoryService;
+import jakarta.servlet.http.HttpServletRequest;
+import jakarta.servlet.http.HttpSession;
+
+
+import java.io.IOException;
+import java.util.*;
+
+import lombok.extern.slf4j.Slf4j;
+import org.apache.commons.text.StringEscapeUtils;
+import org.ladocuploader.app.csv.CsvDocument;
+import org.ladocuploader.app.csv.CsvService;
+import org.ladocuploader.app.csv.enums.CsvType;
+
+import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
+import org.springframework.context.MessageSource;
+import org.springframework.http.HttpHeaders;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.MediaType;
+import org.springframework.http.ResponseEntity;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.GetMapping;
+import org.springframework.web.bind.annotation.PathVariable;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.server.ResponseStatusException;
+
+import static formflow.library.FormFlowController.getSubmissionIdForFlow;
+
+@Controller
+@EnableAutoConfiguration
+@Slf4j
+@RequestMapping("/download-csv")
+public class FileExportController {
+
+    private final MessageSource messageSource;
+
+    private final SubmissionRepositoryService submissionRepositoryService;
+
+    private final List<FlowConfiguration> flowConfigurations;
+
+    private final CsvService csvService;
+
+    public FileExportController(MessageSource messageSource,
+        SubmissionRepositoryService submissionRepositoryService,
+        List<FlowConfiguration> flowConfigurations, CsvService csvService) {
+
+        this.submissionRepositoryService = submissionRepositoryService;
+        this.flowConfigurations = flowConfigurations;
+        this.messageSource = messageSource;
+        this.csvService = csvService;
+    }
+
+
+    @GetMapping("{flow}/pg/{submissionId}")
+    ResponseEntity<?> downloadPGCsv(
+        @PathVariable String flow,
+        @PathVariable String submissionId,
+        HttpSession httpSession,
+        HttpServletRequest request,
+        Locale locale
+    ) throws IOException, CsvRequiredFieldEmptyException, CsvDataTypeMismatchException {
+
+        String cleanedFlow = StringEscapeUtils.escapeHtml4(flow);
+        String cleanedSubmissionId = StringEscapeUtils.escapeHtml4(submissionId);
+
+        log.info("GET downloadCSV ParentGuardian (url: {}): flow: {}, submissionId: {}", request.getRequestURI().toLowerCase(),
+            cleanedFlow, cleanedSubmissionId);
+
+        return handleCsvGeneration(cleanedFlow, cleanedSubmissionId, httpSession, locale, CsvType.PARENT_GUARDIAN);
+    }
+
+    @GetMapping("{flow}/student/{submissionId}")
+    ResponseEntity<?> downloadStudentCsv(
+        @PathVariable String flow,
+        @PathVariable String submissionId,
+        HttpSession httpSession,
+        HttpServletRequest request,
+        Locale locale
+    ) throws IOException, CsvRequiredFieldEmptyException, CsvDataTypeMismatchException {
+
+        String cleanedFlow = StringEscapeUtils.escapeHtml4(flow);
+        String cleanedSubmissionId = StringEscapeUtils.escapeHtml4(submissionId);
+
+        log.info("GET downloadCSV Student (url: {}): flow: {}, submissionId: {}", request.getRequestURI().toLowerCase(),
+            cleanedFlow, cleanedSubmissionId);
+
+        return handleCsvGeneration(cleanedFlow, cleanedSubmissionId, httpSession, locale, CsvType.STUDENT);
+    }
+
+    @GetMapping("{flow}/rel/{submissionId}")
+    ResponseEntity<?> downloadRelCsv(
+        @PathVariable String flow,
+        @PathVariable String submissionId,
+        HttpSession httpSession,
+        HttpServletRequest request,
+        Locale locale
+    ) throws IOException, CsvRequiredFieldEmptyException, CsvDataTypeMismatchException {
+
+        String cleanedFlow = StringEscapeUtils.escapeHtml4(flow);
+        String cleanedSubmissionId = StringEscapeUtils.escapeHtml4(submissionId);
+
+        log.info("GET downloadCSV Relationship (url: {}): flow: {}, submissionId: {}", request.getRequestURI().toLowerCase(),
+            cleanedFlow, cleanedSubmissionId);
+
+        return handleCsvGeneration(cleanedFlow, cleanedSubmissionId, httpSession, locale, CsvType.RELATIONSHIP);
+    }
+
+    protected static void throwNotFoundError(String flow, String message) {
+        throw new ResponseStatusException(HttpStatus.NOT_FOUND,
+                String.format("There was a problem with the request during CSV Generation (flow: %s): %s",
+                        flow, message));
+
+    }
+
+    protected Boolean doesFlowExist(String flow) {
+        return flowConfigurations.stream().anyMatch(
+                flowConfiguration -> flowConfiguration.getName().equals(flow)
+        );
+    }
+
+    private ResponseEntity handleCsvGeneration(String flow, String submissionId, HttpSession httpSession,
+        Locale locale, CsvType csvType) throws CsvRequiredFieldEmptyException, CsvDataTypeMismatchException, IOException {
+
+        if (!doesFlowExist(flow)) {
+            throwNotFoundError(flow, String.format("Could not find flow %s in your application's flow configuration.", flow));
+        }
+        // TODO: get list of submissions based on another column - like transmission?
+        Optional<Submission> maybeSubmission = submissionRepositoryService.findById(UUID.fromString(submissionId));
+        if (getSubmissionIdForFlow(httpSession, flow).toString().equals(submissionId) && maybeSubmission.isPresent()) {
+            log.info("Generating CSV with submission_id: " + submissionId);
+            Submission submission = maybeSubmission.get();
+            CsvDocument csvDoc = csvService.generateCsvFormattedData(List.of(submission), csvType);
+            HttpHeaders headers = new HttpHeaders();
+            headers.add(HttpHeaders.CONTENT_DISPOSITION,
+                    "attachment; filename=%s".formatted(csvService.generateCsvName(submission.getFlow(), csvType)));
+            return ResponseEntity
+                    .ok()
+                    .contentType(MediaType.APPLICATION_OCTET_STREAM)
+                    .headers(headers)
+                    .body(csvDoc.getCsvData());
+        } else {
+            log.error("Attempted to download PDF with submission_id: " + submissionId + " but session_id was: "
+                    + httpSession.getAttribute("id"));
+            return ResponseEntity.status(HttpStatus.FORBIDDEN).body(messageSource.getMessage("error.forbidden", null, locale));
+        }
+    }
+}

src/main/java/org/ladocuploader/app/LaDocUploader.java

@@ -2,9 +2,11 @@
 
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
+import org.springframework.boot.autoconfigure.domain.EntityScan;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 
 @SpringBootApplication(scanBasePackages = {"org.ladocuploader.app", "formflow.library"})
+@EntityScan(basePackages = {"org.ladocuploader.app", "formflow.library"})
 @EnableConfigurationProperties
 public class LaDocUploader {
 

src/main/java/org/ladocuploader/app/cli/MockSftpClientImpl.java

@@ -0,0 +1,17 @@
+package org.ladocuploader.app.cli;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Component;
+
+@Slf4j
+@Component
+@Profile("!production")
+public class MockSftpClientImpl implements SftpClient {
+
+  @Override
+  public void uploadFile(String zipFilename, String filePath) {
+    // Do nothing
+    log.info("Mock uploading file " + zipFilename);
+  }
+}

src/main/java/org/ladocuploader/app/cli/SftpClient.java

@@ -0,0 +1,10 @@
+package org.ladocuploader.app.cli;
+import com.jcraft.jsch.JSchException;
+import com.jcraft.jsch.SftpException;
+
+public interface SftpClient {
+
+
+    void uploadFile(String zipFilename, String filePath) throws JSchException, SftpException;
+
+}

src/main/java/org/ladocuploader/app/cli/SftpClientImpl.java

@@ -0,0 +1,56 @@
+package org.ladocuploader.app.cli;
+
+import com.jcraft.jsch.Channel;
+import com.jcraft.jsch.ChannelSftp;
+import com.jcraft.jsch.JSch;
+import com.jcraft.jsch.JSchException;
+import com.jcraft.jsch.Session;
+import com.jcraft.jsch.SftpException;
+
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.beans.factory.annotation.Value;
+import org.springframework.context.annotation.Profile;
+import org.springframework.stereotype.Component;
+
+import java.util.List;
+
+@Component
+@Slf4j
+@Profile("production")
+public class SftpClientImpl implements SftpClient {
+
+    String username;
+    String password;
+    String uploadUrl;
+
+    String environmentPath;
+
+    public SftpClientImpl(@Value("${sftp.username:}") String username, @Value("${sftp.password:}") String password, @Value("${sftp.upload-url:}") String uploadUrl,
+    @Value("${sftp.environment-path:}") String environmentPath) {
+        this.username = username;
+        this.password = password;
+        this.uploadUrl = uploadUrl;
+        this.environmentPath = environmentPath;
+    }
+
+    @Override
+    public void uploadFile(String zipFilename, String filePath) throws JSchException, SftpException {
+        JSch jsch = new JSch();
+        jsch.setKnownHosts("src/main/resources/known_hosts");
+        Session jschSession = jsch.getSession(username, uploadUrl);
+        jschSession.setPassword(password);
+        jschSession.connect(10000);
+
+        Channel sftp = jschSession.openChannel("sftp");
+        sftp.connect(5000);
+
+        ChannelSftp channelSftp = (ChannelSftp) sftp;
+        String destinationFilePath = String.join("/", List.of(filePath + "-" + this.environmentPath, zipFilename));
+        log.info(destinationFilePath);
+
+        channelSftp.put(zipFilename, destinationFilePath );
+
+        channelSftp.exit();
+    }
+}
+