From 59c9846734226e6cc03a1b57669805125742e0f5 Mon Sep 17 00:00:00 2001 From: Trevor Gerhardt Date: Sat, 28 Oct 2023 15:10:30 +0800 Subject: [PATCH] Rename methods for clarity --- .../controllers/BundleController.java | 4 +-- .../OpportunityDatasetController.java | 2 +- .../datasource/DataSourceUploadAction.java | 2 +- .../com/conveyal/analysis/util/HttpUtils.java | 28 +++++++++++-------- .../java/com/conveyal/file/FileUtils.java | 2 +- 5 files changed, 22 insertions(+), 16 deletions(-) diff --git a/src/main/java/com/conveyal/analysis/controllers/BundleController.java b/src/main/java/com/conveyal/analysis/controllers/BundleController.java index e38464c83..ef9111285 100644 --- a/src/main/java/com/conveyal/analysis/controllers/BundleController.java +++ b/src/main/java/com/conveyal/analysis/controllers/BundleController.java @@ -119,7 +119,7 @@ private Bundle create (Request req, Response res) { throw AnalysisServerException.badRequest("Selected OSM does not exist."); } } else { - osmPbfFile = HttpUtils.storeFileItem(files.get("osm").get(0)); + osmPbfFile = HttpUtils.saveFileItemLocally(files.get("osm").get(0)); } if (files.get("feedGroupId") != null) { @@ -139,7 +139,7 @@ private Bundle create (Request req, Response res) { bundle.feedsComplete = bundleWithFeed.feedsComplete; bundle.totalFeeds = bundleWithFeed.totalFeeds; } else { - gtfsZipFiles = HttpUtils.storeFileItems(files.get("feedGroup")); + gtfsZipFiles = HttpUtils.saveFileItemsLocally(files.get("feedGroup")); } UserPermissions userPermissions = UserPermissions.from(req); bundle.accessGroup = userPermissions.accessGroup; diff --git a/src/main/java/com/conveyal/analysis/controllers/OpportunityDatasetController.java b/src/main/java/com/conveyal/analysis/controllers/OpportunityDatasetController.java index 9a061b348..bcd1143b4 100644 --- a/src/main/java/com/conveyal/analysis/controllers/OpportunityDatasetController.java +++ b/src/main/java/com/conveyal/analysis/controllers/OpportunityDatasetController.java @@ -333,7 +333,7 @@ private OpportunityDatasetUploadStatus createOpportunityDataset(Request req, Res try { // Validate inputs and parameters, which will throw an exception if there's anything wrong with them. // Call remove() rather than get() so that subsequent code will see only string parameters, not the files. - files = HttpUtils.storeFileItemsAndUnzip(formFields.remove("files")); + files = HttpUtils.extractFilesFromFileItemsAndUnzip(formFields.remove("files")); uploadFormat = DataSourceUtil.detectUploadFormatAndValidate(files); parameters = extractStringParameters(formFields); } catch (Exception e) { diff --git a/src/main/java/com/conveyal/analysis/datasource/DataSourceUploadAction.java b/src/main/java/com/conveyal/analysis/datasource/DataSourceUploadAction.java index 4e3dd3b31..28028f861 100644 --- a/src/main/java/com/conveyal/analysis/datasource/DataSourceUploadAction.java +++ b/src/main/java/com/conveyal/analysis/datasource/DataSourceUploadAction.java @@ -121,7 +121,7 @@ public static DataSourceUploadAction forFormFields ( // Extract required parameters. Throws AnalysisServerException on failure, e.g. if a field is missing. final String sourceName = getFormField(formFields, "sourceName", true); final String regionId = getFormField(formFields, "regionId", true); - final List files = HttpUtils.storeFileItemsAndUnzip(formFields.get("sourceFiles")); + final List files = HttpUtils.extractFilesFromFileItemsAndUnzip(formFields.get("sourceFiles")); FileStorageFormat format = DataSourceUtil.detectUploadFormatAndValidate(files); DataSourceIngester ingester = DataSourceIngester.forFormat(format); diff --git a/src/main/java/com/conveyal/analysis/util/HttpUtils.java b/src/main/java/com/conveyal/analysis/util/HttpUtils.java index fc1c5aa70..978dd3f52 100644 --- a/src/main/java/com/conveyal/analysis/util/HttpUtils.java +++ b/src/main/java/com/conveyal/analysis/util/HttpUtils.java @@ -71,17 +71,17 @@ public static String getFormField(Map> formFields, String } /** - * Convert `FileItem`s into `File`s and move them into a temp directory. Automatically unzip files. Return the list - * of new `File` handles. + * Extracts `FileItem`s contents locally in a temp directory. Automatically unzip files. Return the list of new + * `File` handles. */ - public static List storeFileItemsAndUnzip(List fileItems) { + public static List extractFilesFromFileItemsAndUnzip(List fileItems) { File directory = FileUtils.createScratchDirectory(); List files = new ArrayList<>(); for (FileItem fi : fileItems) { - File file = storeFileItemInDirectory(fi, directory); + File file = moveFileItemIntoDirectory(fi, directory); String name = file.getName(); if (name.toLowerCase().endsWith(".zip")) { - files.addAll(FileUtils.unZipFileIntoDirectory(file, directory)); + files.addAll(FileUtils.unzipFileIntoDirectory(file, directory)); } else { files.add(file); } @@ -90,22 +90,28 @@ public static List storeFileItemsAndUnzip(List fileItems) { } /** - * Convert `FileItem`s into `File`s and move them into a temporary directory. Return the list of new `File` handles. + * Move `FileItem`s contents into a temporary directory. Return the list of new `File` handles. */ - public static List storeFileItems(List fileItems) { + public static List saveFileItemsLocally(List fileItems) { File directory = FileUtils.createScratchDirectory(); List files = new ArrayList<>(); for (FileItem fileItem : fileItems) { - files.add(storeFileItemInDirectory(fileItem, directory)); + files.add(moveFileItemIntoDirectory(fileItem, directory)); } return files; } - public static File storeFileItem(FileItem fileItem) { - return storeFileItemInDirectory(fileItem, FileUtils.createScratchDirectory()); + /** + * Save the contents of a `FileItem` in a temporary directory and return the `File`. + */ + public static File saveFileItemLocally(FileItem fileItem) { + return moveFileItemIntoDirectory(fileItem, FileUtils.createScratchDirectory()); } - public static File storeFileItemInDirectory(FileItem fileItem, File directory) { + /** + * Move the contents of a `FileItem` to the given directory by calling `renameTo`. + */ + public static File moveFileItemIntoDirectory(FileItem fileItem, File directory) { File file = new File(directory, fileItem.getName()); boolean renameSuccessful = ((DiskFileItem) fileItem).getStoreLocation().renameTo(file); if (!renameSuccessful) { diff --git a/src/main/java/com/conveyal/file/FileUtils.java b/src/main/java/com/conveyal/file/FileUtils.java index 704fc2e07..5890d18bd 100644 --- a/src/main/java/com/conveyal/file/FileUtils.java +++ b/src/main/java/com/conveyal/file/FileUtils.java @@ -123,7 +123,7 @@ public static boolean isGzip (File file) { /** * Extract the files inside a zipped file into a given directory and return the `File` handles to the new files. */ - public static List unZipFileIntoDirectory(File zipFile, File directory) { + public static List unzipFileIntoDirectory(File zipFile, File directory) { List files = new ArrayList<>(); ZipInputStream zis = new ZipInputStream(FileUtils.getInputStream(zipFile)); ZipEntry zipEntry;