From 0e3c7890bc9b440f8c65cc44f10ecb3cbb2711bb Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Thu, 2 May 2019 12:40:06 -0400 Subject: [PATCH] Fix DeleteOrphanCaseNodesTask bug, make DeleteOrphanManifestNodesTask more efficient --- .../autoingest/Bundle.properties-MERGED | 7 +- .../autoingest/DeleteOrphanCaseNodesTask.java | 66 ++++++++++++------- .../DeleteOrphanManifestNodesTask.java | 34 ++++++---- 3 files changed, 70 insertions(+), 37 deletions(-) diff --git a/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/Bundle.properties-MERGED b/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/Bundle.properties-MERGED index 38d8ee47a1..d170670704 100755 --- a/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/Bundle.properties-MERGED +++ b/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/Bundle.properties-MERGED @@ -206,15 +206,20 @@ DeleteCaseTask.progress.releasingManifestLock=Releasing lock on the manifest fil DeleteCaseTask.progress.startMessage=Starting deletion... DeleteOrphanCaseNodesAction.progressDisplayName=Cleanup Case Znodes DeleteOrphanCaseNodesTask.progress.connectingToCoordSvc=Connecting to the coordination service +DeleteOrphanCaseNodesTask.progress.deletedOrphanedZnodes=Deleting orphaned case znodes # {0} - node path DeleteOrphanCaseNodesTask.progress.deletingOrphanedCaseNode=Deleting orphaned case znode {0} -DeleteOrphanCaseNodesTask.progress.gettingCaseNodesListing=Querying coordination service for case znodes +DeleteOrphanCaseNodesTask.progress.gettingCaseNodesListing=Querying coordination service for case znode paths +DeleteOrphanCaseNodesTask.progress.gettingCaseZnodes=Querying the coordination service for case znodes +DeleteOrphanCaseNodesTask.progress.lookingForOrphanedCaseNodes=Looking for orphaned case znodes +DeleteOrphanCaseNodesTask.progress.lookingForOrphanedCaseZnodes=Looking for orphaned case znodes DeleteOrphanCaseNodesTask.progress.startMessage=Starting orphaned case znode cleanup DeleteOrphanManifestNodesAction.progressDisplayName=Cleanup Manifest File Znodes DeleteOrphanManifestNodesTask.progress.connectingToCoordSvc=Connecting to the coordination service # {0} - node path DeleteOrphanManifestNodesTask.progress.deletingOrphanedManifestNode=Deleting orphaned manifest file znode {0} DeleteOrphanManifestNodesTask.progress.gettingManifestNodes=Querying the coordination service for manifest file znodes +DeleteOrphanManifestNodesTask.progress.lookingForOrphanedManifestFileZnodes=Looking for orphaned manifest file znodes DeleteOrphanManifestNodesTask.progress.startMessage=Starting orphaned manifest file znode cleanup HINT_CasesDashboardTopComponent=This is an adminstrative dashboard for multi-user cases OpenAutoIngestLogAction.deletedLogErrorMsg=The case auto ingest log has been deleted. diff --git a/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/DeleteOrphanCaseNodesTask.java b/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/DeleteOrphanCaseNodesTask.java index e06427e500..418500e9b6 100755 --- a/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/DeleteOrphanCaseNodesTask.java +++ b/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/DeleteOrphanCaseNodesTask.java @@ -20,12 +20,14 @@ package org.sleuthkit.autopsy.experimental.autoingest; import java.io.File; import java.nio.file.Path; +import java.nio.file.Paths; import java.util.List; import java.util.logging.Level; import org.openide.util.NbBundle; -import org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeData; -import org.sleuthkit.autopsy.casemodule.multiusercases.CaseNodeDataCollector; import org.sleuthkit.autopsy.casemodule.multiusercases.CoordinationServiceUtils; +import static org.sleuthkit.autopsy.casemodule.multiusercases.CoordinationServiceUtils.isCaseAutoIngestLogNodePath; +import static org.sleuthkit.autopsy.casemodule.multiusercases.CoordinationServiceUtils.isCaseNameNodePath; +import static org.sleuthkit.autopsy.casemodule.multiusercases.CoordinationServiceUtils.isCaseResourcesNodePath; import org.sleuthkit.autopsy.coordinationservice.CoordinationService; import org.sleuthkit.autopsy.coreutils.Logger; import org.sleuthkit.autopsy.progress.ProgressIndicator; @@ -38,6 +40,8 @@ final class DeleteOrphanCaseNodesTask implements Runnable { private static final Logger logger = AutoIngestDashboardLogger.getLogger(); private final ProgressIndicator progress; + private int nodesCount; + private int casesCount; /** * Constucts an instance of a task for deleting case coordination service @@ -53,7 +57,8 @@ final class DeleteOrphanCaseNodesTask implements Runnable { @NbBundle.Messages({ "DeleteOrphanCaseNodesTask.progress.startMessage=Starting orphaned case znode cleanup", "DeleteOrphanCaseNodesTask.progress.connectingToCoordSvc=Connecting to the coordination service", - "DeleteOrphanCaseNodesTask.progress.gettingCaseNodesListing=Querying coordination service for case znodes" + "DeleteOrphanCaseNodesTask.progress.gettingCaseZnodes=Querying the coordination service for case znodes", + "DeleteOrphanCaseNodesTask.progress.lookingForOrphanedCaseZnodes=Looking for orphaned case znodes" }) public void run() { progress.start(Bundle.DeleteOrphanCaseNodesTask_progress_startMessage()); @@ -68,44 +73,55 @@ final class DeleteOrphanCaseNodesTask implements Runnable { return; } - progress.progress(Bundle.DeleteOrphanCaseNodesTask_progress_gettingCaseNodesListing()); - logger.log(Level.INFO, Bundle.DeleteOrphanCaseNodesTask_progress_gettingCaseNodesListing()); - List nodeDataList; + progress.progress(Bundle.DeleteOrphanCaseNodesTask_progress_gettingCaseZnodes()); + logger.log(Level.INFO, Bundle.DeleteOrphanCaseNodesTask_progress_gettingCaseZnodes()); + List nodePaths; try { - nodeDataList = CaseNodeDataCollector.getNodeData(); + nodePaths = coordinationService.getNodeList(CoordinationService.CategoryNode.CASES); } catch (CoordinationService.CoordinationServiceException ex) { - logger.log(Level.SEVERE, "Error collecting case node data", ex); //NON-NLS + logger.log(Level.SEVERE, "Error getting case znode list", ex); //NON-NLS return; } catch (InterruptedException unused) { - logger.log(Level.WARNING, "Task cancelled while collecting case node data"); //NON-NLS + logger.log(Level.WARNING, "Task cancelled while getting case znode list"); //NON-NLS return; } - for (CaseNodeData nodeData : nodeDataList) { - final Path caseDirectoryPath = nodeData.getDirectory(); + progress.progress(Bundle.DeleteOrphanCaseNodesTask_progress_lookingForOrphanedCaseZnodes()); + logger.log(Level.INFO, Bundle.DeleteOrphanCaseNodesTask_progress_lookingForOrphanedCaseZnodes()); + for (String nodePath : nodePaths) { + if (isCaseNameNodePath(nodePath) || isCaseResourcesNodePath(nodePath) || isCaseAutoIngestLogNodePath(nodePath)) { + continue; + } + + final Path caseDirectoryPath = Paths.get(nodePath); final File caseDirectory = caseDirectoryPath.toFile(); if (!caseDirectory.exists()) { - String caseName = nodeData.getDisplayName(); - String nodePath = ""; // NON-NLS + String caseName = CoordinationServiceUtils.getCaseNameNodePath(caseDirectoryPath); + String nodeToDeletePath = ""; // NON-NLS try { - nodePath = CoordinationServiceUtils.getCaseNameNodePath(caseDirectoryPath); - deleteNode(coordinationService, caseName, nodePath); + nodeToDeletePath = CoordinationServiceUtils.getCaseNameNodePath(caseDirectoryPath); + deleteNode(coordinationService, caseName, caseName); - nodePath = CoordinationServiceUtils.getCaseResourcesNodePath(caseDirectoryPath); - deleteNode(coordinationService, caseName, nodePath); + nodeToDeletePath = CoordinationServiceUtils.getCaseResourcesNodePath(caseDirectoryPath); + deleteNode(coordinationService, caseName, nodeToDeletePath); - nodePath = CoordinationServiceUtils.getCaseAutoIngestLogNodePath(caseDirectoryPath); - deleteNode(coordinationService, caseName, nodePath); + nodeToDeletePath = CoordinationServiceUtils.getCaseAutoIngestLogNodePath(caseDirectoryPath); + deleteNode(coordinationService, caseName, nodeToDeletePath); - nodePath = CoordinationServiceUtils.getCaseDirectoryNodePath(caseDirectoryPath); - deleteNode(coordinationService, caseName, nodePath); + nodeToDeletePath = CoordinationServiceUtils.getCaseDirectoryNodePath(caseDirectoryPath); + deleteNode(coordinationService, caseName, nodeToDeletePath); + + ++casesCount; + progress.progress(Bundle.DeleteOrphanCaseNodesTask_progress_lookingForOrphanedCaseZnodes()); + logger.log(Level.INFO, Bundle.DeleteOrphanCaseNodesTask_progress_lookingForOrphanedCaseZnodes()); } catch (InterruptedException unused) { - logger.log(Level.WARNING, String.format("Task cancelled while deleting orphaned znode %s for %s", nodePath, caseName)); //NON-NLS + logger.log(Level.WARNING, String.format("Task cancelled while deleting orphaned znode %s for %s", nodeToDeletePath, caseName)); //NON-NLS return; } } } + } catch (Exception ex) { /* * This is an unexpected runtime exceptions firewall. It is here @@ -117,6 +133,7 @@ final class DeleteOrphanCaseNodesTask implements Runnable { throw ex; } finally { + logger.log(Level.INFO, String.format("Deleted %d orphaned case znodes for %d cases", nodesCount, casesCount)); progress.finish(); } } @@ -137,11 +154,12 @@ final class DeleteOrphanCaseNodesTask implements Runnable { private void deleteNode(CoordinationService coordinationService, String caseName, String nodePath) throws InterruptedException { try { progress.progress(Bundle.DeleteOrphanCaseNodesTask_progress_deletingOrphanedCaseNode(nodePath)); - logger.log(Level.INFO, String.format("Deleting orphaned case node %s for %s", nodePath, caseName)); //NON-NLS + logger.log(Level.INFO, String.format("Deleting orphaned case node %s for case %s", nodePath, caseName)); //NON-NLS coordinationService.deleteNode(CoordinationService.CategoryNode.CASES, nodePath); + ++nodesCount; } catch (CoordinationService.CoordinationServiceException ex) { if (!DeleteCaseUtils.isNoNodeException(ex)) { - logger.log(Level.SEVERE, String.format("Error deleting orphaned case node %s for %s", nodePath, caseName), ex); //NON-NLS + logger.log(Level.SEVERE, String.format("Error deleting orphaned case node %s for case %s", nodePath, caseName), ex); //NON-NLS } } } diff --git a/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/DeleteOrphanManifestNodesTask.java b/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/DeleteOrphanManifestNodesTask.java index 158a092522..204d4c9e94 100755 --- a/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/DeleteOrphanManifestNodesTask.java +++ b/Experimental/src/org/sleuthkit/autopsy/experimental/autoingest/DeleteOrphanManifestNodesTask.java @@ -20,6 +20,7 @@ package org.sleuthkit.autopsy.experimental.autoingest; import java.io.File; import java.nio.file.Path; +import java.nio.file.Paths; import java.util.List; import java.util.logging.Level; import org.openide.util.NbBundle; @@ -33,7 +34,7 @@ import org.sleuthkit.autopsy.progress.ProgressIndicator; */ final class DeleteOrphanManifestNodesTask implements Runnable { - private static final Logger logger = Logger.getLogger(DeleteOrphanManifestNodesTask.class.getName()); + private static final Logger logger = AutoIngestDashboardLogger.getLogger(); private final ProgressIndicator progress; /** @@ -51,13 +52,15 @@ final class DeleteOrphanManifestNodesTask implements Runnable { "DeleteOrphanManifestNodesTask.progress.startMessage=Starting orphaned manifest file znode cleanup", "DeleteOrphanManifestNodesTask.progress.connectingToCoordSvc=Connecting to the coordination service", "DeleteOrphanManifestNodesTask.progress.gettingManifestNodes=Querying the coordination service for manifest file znodes", + "DeleteOrphanManifestNodesTask.progress.lookingForOrphanedManifestFileZnodes=Looking for orphaned manifest file znodes", "# {0} - node path", "DeleteOrphanManifestNodesTask.progress.deletingOrphanedManifestNode=Deleting orphaned manifest file znode {0}" }) public void run() { progress.start(Bundle.DeleteOrphanManifestNodesTask_progress_startMessage()); + int nodesCount = 0; try { progress.progress(Bundle.DeleteOrphanManifestNodesTask_progress_connectingToCoordSvc()); - logger.log(Level.INFO, Bundle.DeleteOrphanManifestNodesTask_progress_connectingToCoordSvc()); + logger.log(Level.INFO, Bundle.DeleteOrphanManifestNodesTask_progress_connectingToCoordSvc()); CoordinationService coordinationService; try { coordinationService = CoordinationService.getInstance(); @@ -68,36 +71,42 @@ final class DeleteOrphanManifestNodesTask implements Runnable { progress.progress(Bundle.DeleteOrphanManifestNodesTask_progress_gettingManifestNodes()); logger.log(Level.INFO, Bundle.DeleteOrphanManifestNodesTask_progress_gettingManifestNodes()); - List nodeDataList; + List nodePaths; try { - nodeDataList = AutoIngestJobNodeDataCollector.getNodeData(); + nodePaths = coordinationService.getNodeList(CoordinationService.CategoryNode.MANIFESTS); } catch (CoordinationService.CoordinationServiceException ex) { - logger.log(Level.SEVERE, "Error collecting auto ingest job node data", ex); // NON-NLS + logger.log(Level.SEVERE, "Error getting manifest file znode list", ex); // NON-NLS return; } catch (InterruptedException unused) { - logger.log(Level.WARNING, "Task cancelled while collecting auto ingest job node data"); // NON-NLS + logger.log(Level.WARNING, "Task cancelled while getting manifest file znode list"); // NON-NLS return; } - for (AutoIngestJobNodeData nodeData : nodeDataList) { - final String caseName = nodeData.getCaseName(); - final Path manifestFilePath = nodeData.getManifestFilePath(); + progress.progress(Bundle.DeleteOrphanManifestNodesTask_progress_lookingForOrphanedManifestFileZnodes()); + logger.log(Level.INFO, Bundle.DeleteOrphanManifestNodesTask_progress_lookingForOrphanedManifestFileZnodes()); + for (String nodePath : nodePaths) { + final Path manifestFilePath = Paths.get(nodePath); final File manifestFile = manifestFilePath.toFile(); if (!manifestFile.exists()) { try { progress.progress(Bundle.DeleteOrphanManifestNodesTask_progress_deletingOrphanedManifestNode(manifestFilePath)); - logger.log(Level.INFO, String.format("Deleting orphaned manifest file znode %s for %s", manifestFilePath, caseName)); + logger.log(Level.INFO, String.format("Deleting orphaned manifest file znode %s", manifestFilePath)); coordinationService.deleteNode(CoordinationService.CategoryNode.MANIFESTS, manifestFilePath.toString()); + ++nodesCount; } catch (CoordinationService.CoordinationServiceException ex) { if (!DeleteCaseUtils.isNoNodeException(ex)) { - logger.log(Level.SEVERE, String.format("Error deleting %s znode for %s", manifestFilePath, caseName), ex); // NON-NLS + logger.log(Level.SEVERE, String.format("Error deleting orphaned manifest file %s", manifestFilePath), ex); // NON-NLS } } catch (InterruptedException unused) { - logger.log(Level.WARNING, String.format("Task cancelled while deleting %s znode for %s", manifestFilePath, caseName)); // NON-NLS + logger.log(Level.WARNING, String.format("Task cancelled while deleting orphaned manifest file %s", manifestFilePath)); // NON-NLS return; } + + progress.progress(Bundle.DeleteOrphanManifestNodesTask_progress_lookingForOrphanedManifestFileZnodes()); + logger.log(Level.INFO, Bundle.DeleteOrphanManifestNodesTask_progress_lookingForOrphanedManifestFileZnodes()); } } + } catch (Exception ex) { /* * This is an unexpected runtime exceptions firewall. It is here @@ -109,6 +118,7 @@ final class DeleteOrphanManifestNodesTask implements Runnable { throw ex; } finally { + logger.log(Level.INFO, String.format("Deleted %d orphaned manifest file znodes", nodesCount)); progress.finish(); } }