From 9f3b3539ba399030dde0246d80c9015aad3212a0 Mon Sep 17 00:00:00 2001 From: Oliver Spohngellert Date: Fri, 20 May 2016 16:20:06 -0400 Subject: [PATCH 01/10] Fixed image gallery help link. --- .../sleuthkit/autopsy/imagegallery/actions/OpenHelpAction.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/ImageGallery/src/org/sleuthkit/autopsy/imagegallery/actions/OpenHelpAction.java b/ImageGallery/src/org/sleuthkit/autopsy/imagegallery/actions/OpenHelpAction.java index 265412146f..360ee70bb1 100644 --- a/ImageGallery/src/org/sleuthkit/autopsy/imagegallery/actions/OpenHelpAction.java +++ b/ImageGallery/src/org/sleuthkit/autopsy/imagegallery/actions/OpenHelpAction.java @@ -44,7 +44,7 @@ public final class OpenHelpAction implements ActionListener { @Override public void actionPerformed(ActionEvent e) { try { - Desktop.getDesktop().browse(URI.create("http://sleuthkit.org/autopsy/docs/user-docs/4.0/image_gallery_page.html")); //NON-NLS + Desktop.getDesktop().browse(URI.create("http://sleuthkit.org/autopsy/docs/user-docs/4.1/image_gallery_page.html")); //NON-NLS } catch (IOException ex) { Logger.getLogger(OpenHelpAction.class.getName()).log(Level.SEVERE, "failed to open help page", ex); //NON-NLS } From ec68fa3b288033c814a61b0fbb745669b17a7305 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Wed, 18 May 2016 12:51:31 -0400 Subject: [PATCH 02/10] Partial cleanup of FileManager --- .../casemodule/services/Bundle.properties | 13 - .../casemodule/services/Bundle_ja.properties | 13 - .../casemodule/services/FileManager.java | 653 ++++++++---------- .../autopsy/casemodule/services/Services.java | 17 +- 4 files changed, 322 insertions(+), 374 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle.properties b/Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle.properties index 9353ca914b..1a3be9454f 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle.properties +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle.properties @@ -1,16 +1,3 @@ -FileManager.findFiles.exception.msg=Attempted to use FileManager after it was closed. -FileManager.findFiles2.exception.msg=Attempted to use FileManager after it was closed. -FileManager.findFiles3.exception.msg=Attempted to use FileManager after it was closed. -FileManager.openFiles.exception.msg=Attempted to use FileManager after it was closed. -FileManager.addDerivedFile.exception.msg=Attempted to use FileManager after it was closed. -FileManager.addCarvedFile.exception.msg=Attempted to use FileManager after it was closed. -FileManager.addLocalFilesDirs.exception.notReadable.msg=One of the local files/dirs to add is not readable\: {0}, aborting the process before any files added -FileManager.addLocalFilesDirs.exception.cantAdd.msg=One of the local files/dirs could not be added\: {0} -FileManager.addLocalFileSetRootDir.exception.errCreateDir.msg=Error creating local file set dir\: {0} -FileManager.addLocalDirInt.exception.closed.msg=Attempted to use FileManager after it was closed. -FileManager.addLocalDirInt.exception.doesntExist.msg=Attempted to add a local dir that does not exist\: {0} -FileManager.addLocalDirInt.exception.notReadable.msg=Attempted to add a local dir that is not readable\: {0} -FileManager.addLocalDirInt2.exception.closed.msg=Attempted to use FileManager after it was closed. TagsManager.addContentTag.exception.beginByteOffsetOOR.msg=beginByteOffset \= {0} out of content size range (0 - {1}) TagsManager.addContentTag.exception.endByteOffsetOOR.msg=endByteOffset \= {0} out of content size range (0 - {1}) TagsManager.addContentTag.exception.endLTbegin.msg=endByteOffset < beginByteOffset diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle_ja.properties b/Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle_ja.properties index 956a5e6169..ca8ed3431a 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle_ja.properties +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle_ja.properties @@ -1,16 +1,3 @@ -FileManager.findFiles.exception.msg=FileManager\u3092\u9589\u3058\u305f\u5f8c\u306b\u4f7f\u7528\u3092\u8a66\u307f\u307e\u3057\u305f\u3002 -FileManager.findFiles2.exception.msg=FileManager\u3092\u9589\u3058\u305f\u5f8c\u306b\u4f7f\u7528\u3092\u8a66\u307f\u307e\u3057\u305f\u3002 -FileManager.findFiles3.exception.msg=FileManager\u3092\u9589\u3058\u305f\u5f8c\u306b\u4f7f\u7528\u3092\u8a66\u307f\u307e\u3057\u305f\u3002 -FileManager.openFiles.exception.msg=FileManager\u3092\u9589\u3058\u305f\u5f8c\u306b\u4f7f\u7528\u3092\u8a66\u307f\u307e\u3057\u305f\u3002 -FileManager.addDerivedFile.exception.msg=FileManager\u3092\u9589\u3058\u305f\u5f8c\u306b\u4f7f\u7528\u3092\u8a66\u307f\u307e\u3057\u305f\u3002 -FileManager.addCarvedFile.exception.msg=FileManager\u3092\u9589\u3058\u305f\u5f8c\u306b\u4f7f\u7528\u3092\u8a66\u307f\u307e\u3057\u305f\u3002 -FileManager.addLocalFilesDirs.exception.notReadable.msg=\u8ffd\u52a0\u3059\u308b\u30ed\u30fc\u30ab\u30eb\u30d5\u30a1\u30a4\u30eb\uff0f\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u306e\u4e2d\u306b\u8aad\u307f\u53d6\u308c\u306a\u3044\u3082\u306e\u304c\uff11\u500b\u3042\u308a\u307e\u3059\uff1a{0}\u3001\u30d5\u30a1\u30a4\u30eb\u304c\u8ffd\u52a0\u3055\u308c\u308b\u524d\u306b\u51e6\u7406\u3092\u4e2d\u6b62\u3057\u307e\u3059 -FileManager.addLocalFilesDirs.exception.cantAdd.msg=\u30ed\u30fc\u30ab\u30eb\u30d5\u30a1\u30a4\u30eb\uff0f\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u306e\uff11\u500b\u306f\u8ffd\u52a0\u3067\u304d\u307e\u305b\u3093\u3067\u3057\u305f\uff1a{0} -FileManager.addLocalFileSetRootDir.exception.errCreateDir.msg=\u30ed\u30fc\u30ab\u30eb\u30d5\u30a1\u30a4\u30eb\u30bb\u30c3\u30c8\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u3092\u4f5c\u6210\u4e2d\u306b\u30a8\u30e9\u30fc\u304c\u8d77\u3053\u308a\u307e\u3057\u305f\uff1a {0} -FileManager.addLocalDirInt.exception.closed.msg=FileManager\u3092\u9589\u3058\u305f\u5f8c\u306b\u4f7f\u7528\u3092\u8a66\u307f\u307e\u3057\u305f\u3002 -FileManager.addLocalDirInt.exception.doesntExist.msg=\u5b58\u5728\u3057\u306a\u3044\u30ed\u30fc\u30ab\u30eb\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u306e\u8ffd\u52a0\u3092\u8a66\u307f\u307e\u3057\u305f\: {0} -FileManager.addLocalDirInt.exception.notReadable.msg=\u8aad\u307f\u53d6\u308a\u3067\u304d\u306a\u3044\u30ed\u30fc\u30ab\u30eb\u30c7\u30a3\u30ec\u30af\u30c8\u30ea\u306e\u8ffd\u52a0\u3092\u8a66\u307f\u307e\u3057\u305f\: {0} -FileManager.addLocalDirInt2.exception.closed.msg=FileManager\u3092\u9589\u3058\u305f\u5f8c\u306b\u4f7f\u7528\u3092\u8a66\u307f\u307e\u3057\u305f\u3002 TagsManager.addContentTag.exception.beginByteOffsetOOR.msg=beginByteOffset \= {0} \u30b3\u30f3\u30c6\u30f3\u30c4\u30b5\u30a4\u30ba\u7bc4\u56f2(0 - {1})\u306e\u5916\u3067\u3059 TagsManager.addContentTag.exception.endByteOffsetOOR.msg=endByteOffset \= {0} \u30b3\u30f3\u30c6\u30f3\u30c4\u30b5\u30a4\u30ba\u7bc4\u56f2(0 - {1})\u306e\u5916\u3067\u3059 TagsManager.addContentTag.exception.endLTbegin.msg=endByteOffset < beginByteOffset diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/FileManager.java b/Core/src/org/sleuthkit/autopsy/casemodule/services/FileManager.java index 5b958cd5a7..336e97742b 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/FileManager.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/FileManager.java @@ -1,19 +1,19 @@ /* * * Autopsy Forensic Browser - * + * * Copyright 2011-2016 Basis Technology Corp. - * + * * Copyright 2012 42six Solutions. * Contact: aebadirad 42six com * Project Contact/Architect: carrier sleuthkit org - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -28,6 +28,7 @@ import java.util.ArrayList; import java.util.List; import java.util.logging.Level; import org.openide.util.NbBundle; +import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.autopsy.coreutils.Logger; import org.sleuthkit.autopsy.datamodel.VirtualDirectoryNode; import org.sleuthkit.autopsy.ingest.IngestServices; @@ -47,56 +48,75 @@ import org.sleuthkit.datamodel.LocalFilesDataSource; import org.sleuthkit.datamodel.TskDataException; /** - * Abstraction to facilitate access to localFiles and directories. + * A case-level service that provides methods for retrieving files associated + * with the case and for adding local files, carved files, and derived files to + * the case. */ public class FileManager implements Closeable { - private SleuthkitCase tskCase; private static final Logger logger = Logger.getLogger(FileManager.class.getName()); - private volatile int curNumFileSets; //current number of filesets (root virt dir objects) + private SleuthkitCase caseDb; - public FileManager(SleuthkitCase tskCase) { - this.tskCase = tskCase; - init(); + /* + * TODO (AUT-1905): Although this counter is guarded by the monitor of the + * FileManager, this does not guarantee unique default file set names for + * multi-user cases where multiple nodes can be running FileManagers for the + * same case. + */ + private int localFileDataSourcesCounter; + + /** + * Constructs a case-level service that provides methods for retrieving + * files associated with the case and for adding local files, carved files, + * and derived files to the case. + */ + FileManager(Case currentCase, SleuthkitCase caseDb) throws TskCoreException { + this.caseDb = caseDb; + initializeLocalFileDataSourcesCounter(); } /** - * initialize the file manager for the case + * Initialize the counter for the number of logical/local file sets that is + * used to generate the default logical/local file data source names. */ - private synchronized void init() { - //get the number of local file sets in db - List virtRoots; - curNumFileSets = 0; + private void initializeLocalFileDataSourcesCounter() { + /* + * TODO (AUT-1905): Although the counter is guarded by the monitor of + * the FileManager, this does not guarantee unique default file set + * names for multi-user cases where multiple nodes can be running + * FileManagers for the same case. + */ + localFileDataSourcesCounter = 0; try { - virtRoots = tskCase.getVirtualDirectoryRoots(); - for (VirtualDirectory vd : virtRoots) { + List localFileDataSources = caseDb.getVirtualDirectoryRoots(); + for (VirtualDirectory vd : localFileDataSources) { if (vd.getName().startsWith(VirtualDirectoryNode.LOGICAL_FILE_SET_PREFIX)) { - ++curNumFileSets; + ++localFileDataSourcesCounter; } } } catch (TskCoreException ex) { - logger.log(Level.SEVERE, "Error initializing FileManager and getting number of local file sets"); //NON-NLS + logger.log(Level.SEVERE, "Error initializing logical files counter", ex); //NON-NLS } - } /** - * Finds a set of localFiles that meets the name criteria in all data - * sources in the current case. + * Finds all files and directories with a given file name. The name search + * is for full or partial matches and is case insensitive (a case + * insensitive SQL LIKE clause is used to query the case database). * - * @param fileName Pattern of the name of the file or directory to match - * (case insensitive, used in LIKE SQL statement). + * @param fileName The full or partial file name. * - * @return a list of AbstractFile for localFiles/directories whose name - * matches the given fileName + * @return The matching files and directories. + * + * @throws TskCoreException if there is a problem querying the case + * database. */ public synchronized List findFiles(String fileName) throws TskCoreException { - List result = new ArrayList<>(); - - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles.exception.msg")); + if (null == caseDb) { + throw new TskCoreException("FileManager closed"); } - List dataSources = tskCase.getRootObjects(); + List result = new ArrayList<>(); + List dataSources = caseDb.getRootObjects(); for (Content dataSource : dataSources) { result.addAll(findFiles(dataSource, fileName)); } @@ -104,113 +124,113 @@ public class FileManager implements Closeable { } /** - * Finds a set of localFiles that meets the name criteria in all data - * sources in the current case. + * Finds all files and directories with a given file name and parent file or + * directory name. The name searches are for full or partial matches and are + * case insensitive (a case insensitive SQL LIKE clause is used to query the + * case database). * - * @param fileName Pattern of the name of the file or directory to match - * (case insensitive, used in LIKE SQL statement). - * @param dirName Pattern of the name of the parent directory to use as the - * root of the search (case insensitive, used in LIKE SQL - * statement). + * @param fileName The full or partial file name. + * @param parentName The full or partial parent file or directory name. * - * @return a list of AbstractFile for localFiles/directories whose name - * matches fileName and whose parent directory contains dirName. + * @return The matching files and directories. + * + * @throws TskCoreException if there is a problem querying the case + * database. */ - public synchronized List findFiles(String fileName, String dirName) throws TskCoreException { - List result = new ArrayList<>(); - - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles2.exception.msg")); + public synchronized List findFiles(String fileName, String parentName) throws TskCoreException { + if (null == caseDb) { + throw new TskCoreException("FileManager closed"); } - List dataSources = tskCase.getRootObjects(); + List result = new ArrayList<>(); + List dataSources = caseDb.getRootObjects(); for (Content dataSource : dataSources) { - result.addAll(findFiles(dataSource, fileName, dirName)); + result.addAll(findFiles(dataSource, fileName, parentName)); } return result; } /** - * Finds a set of localFiles that meets the name criteria in all data - * sources in the current case. + * Finds all files and directories with a given file name and parent file or + * directory. The name search is for full or partial matches and is case + * insensitive (a case insensitive SQL LIKE clause is used to query the case + * database). * - * @param fileName Pattern of the name of the file or directory to match - * (case insensitive, used in LIKE SQL statement). - * @param parentFile Object of root/parent directory to restrict search to. + * @param fileName The full or partial file name. + * @param parent The parent file or directory. * - * @return a list of AbstractFile for localFiles/directories whose name - * matches fileName and that were inside a directory described by - * parentFsContent. + * @return The matching files and directories. + * + * @throws TskCoreException if there is a problem querying the case + * database. */ - public synchronized List findFiles(String fileName, AbstractFile parentFile) throws TskCoreException { - List result = new ArrayList<>(); - - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles3.exception.msg")); + public synchronized List findFiles(String fileName, AbstractFile parent) throws TskCoreException { + if (null == caseDb) { + throw new TskCoreException("FileManager closed"); } - List dataSources = tskCase.getRootObjects(); + List result = new ArrayList<>(); + List dataSources = caseDb.getRootObjects(); for (Content dataSource : dataSources) { - result.addAll(findFiles(dataSource, fileName, parentFile)); + result.addAll(findFiles(dataSource, fileName, parent)); } return result; } /** - * Finds a set of localFiles that meets the name criteria. + * Finds all files and directories with a given file name in a given data + * source (image, local/logical files set, etc.). The name search is for + * full or partial matches and is case insensitive (a case insensitive SQL + * LIKE clause is used to query the case database). * - * @param dataSource Root data source to limit search results to (Image, - * VirtualDirectory, etc.). - * @param fileName Pattern of the name of the file or directory to match - * (case insensitive, used in LIKE SQL statement). + * @param dataSource The data source. + * @param fileName The full or partial file name. * - * @return a list of AbstractFile for localFiles/directories whose name - * matches the given fileName + * @return The matching files and directories. + * + * @throws TskCoreException if there is a problem querying the case + * database. */ public synchronized List findFiles(Content dataSource, String fileName) throws TskCoreException { - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles.exception.msg")); - } - return tskCase.findFiles(dataSource, fileName); + return caseDb.findFiles(dataSource, fileName); } /** - * Finds a set of localFiles that meets the name criteria. + * Finds all files and directories with a given file name and parent file or + * directory name in a given data source (image, local/logical files set, + * etc.). The name searches are for full or partial matches and are case + * insensitive (a case insensitive SQL LIKE clause is used to query the case + * database). * - * @param dataSource Root data source to limit search results to (Image, - * VirtualDirectory, etc.). - * @param fileName Pattern of the name of the file or directory to match - * (case insensitive, used in LIKE SQL statement). - * @param dirName Pattern of the name of the parent directory to use as - * the root of the search (case insensitive, used in LIKE - * SQL statement). + * @param dataSource The data source. + * @param fileName The full or partial file name. + * @param parentName The full or partial parent file or directory name. * - * @return a list of AbstractFile for localFiles/directories whose name - * matches fileName and whose parent directory contains dirName. + * @return The matching files and directories. + * + * @throws TskCoreException if there is a problem querying the case + * database. */ - public synchronized List findFiles(Content dataSource, String fileName, String dirName) throws TskCoreException { - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles2.exception.msg")); - } - return tskCase.findFiles(dataSource, fileName, dirName); + public synchronized List findFiles(Content dataSource, String fileName, String parentName) throws TskCoreException { + return caseDb.findFiles(dataSource, fileName, parentName); } /** - * Finds a set of localFiles that meets the name criteria. + * Finds all files and directories with a given file name and given parent + * file or directory in a given data source (image, local/logical files set, + * etc.). The name search is for full or partial matches and is case + * insensitive (a case insensitive SQL LIKE clause is used to query the case + * database). * - * @param dataSource Root data source to limit search results to (Image, - * VirtualDirectory, etc.). - * @param fileName Pattern of the name of the file or directory to match - * (case insensitive, used in LIKE SQL statement). - * @param parentFile Object of root/parent directory to restrict search to. + * @param dataSource The data source. + * @param fileName The full or partial file name. + * @param parent The parent file or directory. * - * @return a list of AbstractFile for localFiles/directories whose name - * matches fileName and that were inside a directory described by - * parentFsContent. + * @return The matching files and directories. + * + * @throws TskCoreException if there is a problem querying the case + * database. */ - public synchronized List findFiles(Content dataSource, String fileName, AbstractFile parentFile) throws TskCoreException { - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles3.exception.msg")); - } - return findFiles(dataSource, fileName, parentFile.getName()); + public synchronized List findFiles(Content dataSource, String fileName, AbstractFile parent) throws TskCoreException { + return findFiles(dataSource, fileName, parent.getName()); } /** @@ -221,175 +241,120 @@ public class FileManager implements Closeable { * * @return a list of AbstractFile that have the given file path. */ + /** + * Finds all files and directories with a given file name and path in a + * given data source (image, local/logical files set, etc.). The name search + * is for full or partial matches and is case insensitive (a case + * insensitive SQL LIKE clause is used to query the case database). Any path + * components at the volume level and above are removed for the search. + * + * @param dataSource The data source. + * @param fileName The full or partial file name. + * @param filePath The file path (path components volume at the volume + * level or above will be removed). + * + * @return The matching files and directories. + * + * @throws TskCoreException if there is a problem querying the case + * database. + */ public synchronized List openFiles(Content dataSource, String filePath) throws TskCoreException { - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.openFiles.exception.msg")); + if (null == caseDb) { + throw new TskCoreException("FileManager closed"); } - return tskCase.openFiles(dataSource, filePath); + return caseDb.openFiles(dataSource, filePath); } /** - * Creates a derived file, adds it to the database and returns it. + * Adds a derived file to the case. * - * @param fileName file name the derived file - * @param localPath local path of the derived file, including the file - * name. The path is relative to the case folder. - * @param size size of the derived file in bytes - * @param ctime - * @param crtime - * @param atime - * @param mtime - * @param isFile whether a file or directory, true if a file - * @param parentFile the parent file object this the new file was - * derived from, either a fs file or parent derived - * file/dikr\\r - * @param rederiveDetails details needed to re-derive file (will be specific - * to the derivation method), currently unused - * @param toolName name of derivation method/tool, currently unused - * @param toolVersion version of derivation method/tool, currently - * unused - * @param otherDetails details of derivation method/tool, currently - * unused + * @param fileName The name of the file. + * @param localPath The local path of the file, relative to the case + * folder and including the file name. + * @param size The size of the file in bytes. + * @param ctime The change time of the file. + * @param crtime The create time of the file + * @param atime The accessed time of the file. + * @param mtime The modified time of the file. + * @param isFile True if a file, false if a directory. + * @param parentFile The parent file from which the file was derived. + * @param rederiveDetails The details needed to re-derive file (will be + * specific to the derivation method), currently + * unused. + * @param toolName The name of the derivation method or tool, + * currently unused. + * @param toolVersion The version of the derivation method or tool, + * currently unused. + * @param otherDetails Other details of the derivation method or tool, + * currently unused. * - * @return newly created derived file object added to the database - * - * @throws TskCoreException exception thrown if the object creation failed - * due to a critical system error or of the file - * manager has already been closed + * @return A DerivedFile object representing the derived file. * + * @throws TskCoreException if there is a problem adding the file to the + * case database. */ - public synchronized DerivedFile addDerivedFile(String fileName, String localPath, long size, + public synchronized DerivedFile addDerivedFile(String fileName, + String localPath, + long size, long ctime, long crtime, long atime, long mtime, - boolean isFile, AbstractFile parentFile, + boolean isFile, + AbstractFile parentFile, String rederiveDetails, String toolName, String toolVersion, String otherDetails) throws TskCoreException { - - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.addDerivedFile.exception.msg")); - } - - return tskCase.addDerivedFile(fileName, localPath, size, + return caseDb.addDerivedFile(fileName, localPath, size, ctime, crtime, atime, mtime, isFile, parentFile, rederiveDetails, toolName, toolVersion, otherDetails); } /** - * Adds a carved file to the VirtualDirectory '$CarvedFiles' in the volume - * or image given by systemId. + * Adds a carved file to the '$CarvedFiles' virtual directory of a data + * source, volume or file system. * - * @param carvedFileName the name of the carved file (containing appropriate - * extension) - * @param carvedFileSize size of the carved file to add - * @param systemId the ID of the parent volume or file system - * @param sectors a list of SectorGroups giving this sectors that - * make up this carved file. + * @param fileName The name of the file. + * @param fileSize The size of the file. + * @param parentObjId The object id of the parent data source, volume or + * file system. + * @param layout A list of the offsets and sizes that gives the layout + * of the file within its parent. * - * @throws TskCoreException exception thrown when critical tsk error - * occurred and carved file could not be added + * @return A LayoutFile object representing the carved file. + * + * @throws TskCoreException if there is a problem adding the file to the + * case database. */ - public synchronized LayoutFile addCarvedFile(String carvedFileName, long carvedFileSize, - long systemId, List sectors) throws TskCoreException { - - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.addCarvedFile.exception.msg")); - } - - return tskCase.addCarvedFile(carvedFileName, carvedFileSize, systemId, sectors); + public synchronized LayoutFile addCarvedFile(String fileName, long fileSize, long parentObjId, List layout) throws TskCoreException { + return caseDb.addCarvedFile(fileName, fileSize, parentObjId, layout); } /** - * Adds a collection of carved localFiles to the VirtualDirectory - * '$CarvedFiles' in the volume or image given by systemId. Creates - * $CarvedFiles if it does not exist already. + * Adds a collection of carved files to the '$CarvedFiles' virtual directory + * of a data source, volume or file system. * - * @param filesToAdd a list of CarvedFileContainer localFiles to add as - * carved localFiles + * @param A collection of CarvedFileContainer objects, one per carved file, + * all of which must have the same parent object id. * - * @return List This is a list of the localFiles added to the - * database + * @return A collection of LayoutFile object representing the carved files. * - * @throws org.sleuthkit.datamodel.TskCoreException + * @throws TskCoreException if there is a problem adding the files to the + * case database. */ public List addCarvedFiles(List filesToAdd) throws TskCoreException { - if (tskCase == null) { - throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.addCarvedFile.exception.msg")); - } else { - return tskCase.addCarvedFiles(filesToAdd); - } + return caseDb.addCarvedFiles(filesToAdd); } /** - * - * Interface for receiving notifications on folders being added via a - * callback + * Interface for receiving a notification for each file or directory added + * to the case database by a FileManager add files operation. */ public interface FileAddProgressUpdater { /** - * Called when new folders has been added + * Called after a file or directory is added to the case database. * - * @param newFile the file/folder added to the Case + * @param An AbstractFile represeting the added file or directory. */ public void fileAdded(AbstractFile newFile); } - /** - * Add a set of local/logical localFiles and dirs. - * - * @param localAbsPaths list of absolute paths to local localFiles and - * dirs - * @param addProgressUpdater notifier to receive progress notifications on - * folders added, or null if not used - * - * @return file set root VirtualDirectory contained containing all - * AbstractFile objects added - * - * @throws TskCoreException exception thrown if the object creation failed - * due to a critical system error or of the file - * manager has already been closed. There is no - * "revert" logic if one of the additions fails. - * The addition stops with the first error - * encountered. - */ - public synchronized VirtualDirectory addLocalFilesDirs(List localAbsPaths, FileAddProgressUpdater addProgressUpdater) throws TskCoreException { - List rootsToAdd; - try { - rootsToAdd = getFilesAndDirectories(localAbsPaths); - } catch (TskDataException ex) { - throw new TskCoreException(ex.getLocalizedMessage(), ex); - } - - CaseDbTransaction trans = tskCase.beginTransaction(); - // make a virtual top-level directory for this set of localFiles/dirs - final VirtualDirectory fileSetRootDir = addLocalFileSetRootDir(trans); - - try { - // recursively add each item in the set - for (java.io.File localRootToAdd : rootsToAdd) { - AbstractFile localFileAdded = addLocalDirInt(trans, fileSetRootDir, localRootToAdd, addProgressUpdater); - - if (localFileAdded == null) { - String msg = NbBundle - .getMessage(this.getClass(), "FileManager.addLocalFilesDirs.exception.cantAdd.msg", - localRootToAdd.getAbsolutePath()); - logger.log(Level.SEVERE, msg); - throw new TskCoreException(msg); - } else { - //added.add(localFileAdded); - //send new content event - //for now reusing ingest events, in future this will be replaced by datamodel / observer sending out events - // @@@ Is this the right place for this? A directory tree refresh will be triggered, so this may be creating a race condition - // since the transaction is not yet committed. - IngestServices.getInstance().fireModuleContentEvent(new ModuleContentEvent(localFileAdded)); - } - } - - trans.commit(); - } catch (TskCoreException ex) { - trans.rollback(); - } - return fileSetRootDir; - } - /** * Adds a set of local/logical files and/or directories to the case database * as data source. @@ -419,20 +384,33 @@ public class FileManager implements Closeable { * directory that does not exist or cannot be read. */ public synchronized LocalFilesDataSource addLocalFilesDataSource(String deviceId, String rootVirtualDirectoryName, String timeZone, List localFilePaths, FileAddProgressUpdater progressUpdater) throws TskCoreException, TskDataException { + /* + * Convert the local/logical file paths into File objects. + */ List localFiles = getFilesAndDirectories(localFilePaths); CaseDbTransaction trans = null; try { + /* + * Generate a name for the root virtual directory for the data + * source, if a name was not supplied, and increment the counter + * used to generate the default names. + */ + int newLocalFilesSetCount = localFileDataSourcesCounter + 1; String rootDirectoryName = rootVirtualDirectoryName; - int newLocalFilesSetCount = curNumFileSets + 1; if (rootVirtualDirectoryName.isEmpty()) { rootDirectoryName = VirtualDirectoryNode.LOGICAL_FILE_SET_PREFIX + newLocalFilesSetCount; } - trans = tskCase.beginTransaction(); - LocalFilesDataSource dataSource = tskCase.addLocalFilesDataSource(deviceId, rootDirectoryName, timeZone, trans); + + /* + * Add the root virtual directory and its local/logical file + * chioldren to the case database. + */ + trans = caseDb.beginTransaction(); + LocalFilesDataSource dataSource = caseDb.addLocalFilesDataSource(deviceId, rootDirectoryName, timeZone, trans); VirtualDirectory rootDirectory = dataSource.getRootDirectory(); List filesAdded = new ArrayList<>(); for (java.io.File localFile : localFiles) { - AbstractFile fileAdded = addLocalDirInt(trans, rootDirectory, localFile, progressUpdater); + AbstractFile fileAdded = addLocalFile(trans, rootDirectory, localFile, progressUpdater); if (null != fileAdded) { filesAdded.add(fileAdded); } else { @@ -440,13 +418,28 @@ public class FileManager implements Closeable { } } trans.commit(); + + /* + * Update the counter used to generate the default names. + * + * TODO (AUT-1905): Although the counter is guarded by the monitor + * of the FileManager, this does not guarantee unique default file + * set names for multi-user cases where multiple nodes can be + * running FileManagers for the same case. + */ if (rootVirtualDirectoryName.isEmpty()) { - curNumFileSets = newLocalFilesSetCount; + localFileDataSourcesCounter = newLocalFilesSetCount; } + + /* + * Publish content added events for the added files and directories. + */ for (AbstractFile fileAdded : filesAdded) { IngestServices.getInstance().fireModuleContentEvent(new ModuleContentEvent(fileAdded)); } + return dataSource; + } catch (TskCoreException ex) { if (null != trans) { trans.rollback(); @@ -472,7 +465,7 @@ public class FileManager implements Closeable { for (String path : localFilePaths) { java.io.File localFile = new java.io.File(path); if (!localFile.exists() || !localFile.canRead()) { - throw new TskDataException(NbBundle.getMessage(this.getClass(), "FileManager.addLocalFilesDirs.exception.notReadable.msg", localFile.getAbsolutePath())); + throw new TskDataException(String.format("File at %s does not exist or cannot be read", localFile.getAbsolutePath())); } localFiles.add(localFile); } @@ -480,130 +473,96 @@ public class FileManager implements Closeable { } /** - * Adds a new virtual directory root object with FileSet X name and - * consecutive sequence number characteristic to every add operation - * - * @return the virtual dir root container created - * - * @throws TskCoreException - */ - private VirtualDirectory addLocalFileSetRootDir(CaseDbTransaction trans) throws TskCoreException { - - VirtualDirectory created = null; - - int newFileSetCount = curNumFileSets + 1; - final String fileSetName = VirtualDirectoryNode.LOGICAL_FILE_SET_PREFIX + newFileSetCount; - - try { - created = tskCase.addVirtualDirectory(0, fileSetName, trans); - curNumFileSets = newFileSetCount; - } catch (TskCoreException ex) { - String msg = NbBundle - .getMessage(this.getClass(), "FileManager.addLocalFileSetRootDir.exception.errCreateDir.msg", - fileSetName); - logger.log(Level.SEVERE, msg, ex); - throw new TskCoreException(msg, ex); - } - - return created; - } - - /** - * Helper (internal) method to recursively add contents of a folder. Node - * passed in can be a file or directory. Children of directories are added. + * Adds a file or directory of logical/local files data source to the case + * database, recursively adding the contents of directories. * * @param trans A case database transaction. - * @param parentVd Dir that is the parent of localFile - * @param localFile File/Dir that we are adding + * @param parentDirectory The root virtual direcotry of the data source. + * @param localFile The local/logical file or directory. * @param addProgressUpdater notifier to receive progress notifications on * folders added, or null if not used * * @returns File object of file added or new virtualdirectory for the * directory. - * @throws TskCoreException + * @param progressUpdater Called after each file/directory is added to + * the case database. + * + * @return An AbstractFile representation of the local/logical file. + * + * @throws TskCoreException If there is a problem completing a database + * operation. */ - private AbstractFile addLocalDirInt(CaseDbTransaction trans, VirtualDirectory parentVd, - java.io.File localFile, FileAddProgressUpdater addProgressUpdater) throws TskCoreException { - - if (tskCase == null) { - throw new TskCoreException( - NbBundle.getMessage(this.getClass(), "FileManager.addLocalDirInt.exception.closed.msg")); - } - - //final String localName = localDir.getName(); - if (!localFile.exists()) { - throw new TskCoreException( - NbBundle.getMessage(this.getClass(), "FileManager.addLocalDirInt.exception.doesntExist.msg", - localFile.getAbsolutePath())); - } - if (!localFile.canRead()) { - throw new TskCoreException( - NbBundle.getMessage(this.getClass(), "FileManager.addLocalDirInt.exception.notReadable.msg", - localFile.getAbsolutePath())); - } - + private AbstractFile addLocalFile(CaseDbTransaction trans, VirtualDirectory parentDirectory, java.io.File localFile, FileAddProgressUpdater progressUpdater) throws TskCoreException { if (localFile.isDirectory()) { - //create virtual folder (we don't have a notion of a 'local folder') - final VirtualDirectory childVd = tskCase.addVirtualDirectory(parentVd.getId(), localFile.getName(), trans); - if (childVd != null && addProgressUpdater != null) { - addProgressUpdater.fileAdded(childVd); - } - //add children recursively - final java.io.File[] childrenFiles = localFile.listFiles(); - if (childrenFiles != null) { - for (java.io.File childFile : childrenFiles) { - addLocalDirInt(trans, childVd, childFile, addProgressUpdater); + /* + * Add the directory as a virtual directory. + */ + VirtualDirectory virtualDirectory = caseDb.addVirtualDirectory(parentDirectory.getId(), localFile.getName(), trans); + progressUpdater.fileAdded(virtualDirectory); + + /* + * Add its children, if any. + */ + final java.io.File[] childFiles = localFile.listFiles(); + if (childFiles != null && childFiles.length > 0) { + for (java.io.File childFile : childFiles) { + addLocalFile(trans, virtualDirectory, childFile, progressUpdater); } } - return childVd; + + return virtualDirectory; } else { - //add leaf file, base case - return this.addLocalFileInt(parentVd, localFile, trans); + return caseDb.addLocalFile(localFile.getName(), localFile.getAbsolutePath(), localFile.length(), + 0, 0, 0, 0, + localFile.isFile(), parentDirectory, trans); } } - /** - * Adds a single local/logical file to the case. Adds it to the database. - * Does not refresh the views of data. Assumes that the local file exists - * and can be read. This checking is done by addLocalDirInt(). - * - * @param parentFile parent file object container (such as virtual - * directory, another local file, or fscontent File), - * @param localFile File that we are adding - * @param trans A case database transaction. - * - * @return newly created local file object added to the database - * - * @throws TskCoreException exception thrown if the object creation failed - * due to a critical system error or of the file - * manager has already been closed - */ - private synchronized LocalFile addLocalFileInt(AbstractFile parentFile, java.io.File localFile, CaseDbTransaction trans) throws TskCoreException { - - if (tskCase == null) { - throw new TskCoreException( - NbBundle.getMessage(this.getClass(), "FileManager.addLocalDirInt2.exception.closed.msg")); - } - - long size = localFile.length(); - boolean isFile = localFile.isFile(); - - long ctime = 0; - long crtime = 0; - long atime = 0; - long mtime = 0; - - String fileName = localFile.getName(); - - LocalFile lf = tskCase.addLocalFile(fileName, localFile.getAbsolutePath(), size, - ctime, crtime, atime, mtime, - isFile, parentFile, trans); - - return lf; - } - @Override public synchronized void close() throws IOException { - tskCase = null; + caseDb = null; } + + /** + * Contructs a case-level service that provides management of files within + * the data sources added to a case and the local files associated with a + * case. + * + * @param tskCase The case database. + * + * @deprecated Use Case.getCurrentCase().getServices().getFileManager() + * instead. + */ + @Deprecated + public FileManager(SleuthkitCase tskCase) { + this(); + } + + /** + * Adds a set of local/logical files and/or directories to the case database + * as data source. + * + * @param localFilePaths A list of local/logical file and/or directory + * localFilePaths. + * @param progressUpdater Called after each file/directory is added to the + * case database. + * + * @return The root virtual directory for the local/logical files data + * source. + * + * @throws TskCoreException If any of the local file paths is for a file or + * directory that does not exist or cannot be read, + * or there is a problem completing a database + * operation. + * @deprecated Use addLocalFilesDataSource instead. + */ + @Deprecated + public synchronized VirtualDirectory addLocalFilesDirs(List localFilePaths, FileAddProgressUpdater progressUpdater) throws TskCoreException { + try { + return addLocalFilesDataSource("", "", "", localFilePaths, progressUpdater).getRootDirectory(); + } catch (TskDataException ex) { + throw new TskCoreException(ex.getLocalizedMessage(), ex); + } + } + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java b/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java index 880bc8008e..3106d7c3f7 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java @@ -2,7 +2,7 @@ * * Autopsy Forensic Browser * - * Copyright 2012-2015 Basis Technology Corp. + * Copyright 2012-2016 Basis Technology Corp. * * Copyright 2012 42six Solutions. * Contact: aebadirad 42six com @@ -29,6 +29,7 @@ import java.util.List; import org.openide.util.Lookup; import org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService; import org.sleuthkit.datamodel.SleuthkitCase; +import org.sleuthkit.autopsy.casemodule.Case; /** * A class to manage various services. @@ -41,6 +42,20 @@ public class Services implements Closeable { private final KeywordSearchService keywordSearchService; private final Blackboard blackboard; + Services(Case currentCase, SleuthkitCase caseDb) { + fileManager = new FileManager(currentCase, caseDb); + services.add(fileManager); + + tagsManager = new TagsManager(caseDb); + services.add(tagsManager); + + keywordSearchService = Lookup.getDefault().lookup(KeywordSearchService.class); + services.add(keywordSearchService); + + blackboard = new Blackboard(); + services.add(blackboard); + } + public Services(SleuthkitCase tskCase) { fileManager = new FileManager(tskCase); services.add(fileManager); From 915f5f82481a6c7e35daada20e35839ecb2829c8 Mon Sep 17 00:00:00 2001 From: Oliver Spohngellert Date: Tue, 24 May 2016 11:07:45 -0400 Subject: [PATCH 03/10] Fixed poor enabling of extension only. --- .../autopsy/modules/interestingitems/FilesSetRulePanel.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Core/src/org/sleuthkit/autopsy/modules/interestingitems/FilesSetRulePanel.java b/Core/src/org/sleuthkit/autopsy/modules/interestingitems/FilesSetRulePanel.java index 4709a3986b..79c9bd842e 100755 --- a/Core/src/org/sleuthkit/autopsy/modules/interestingitems/FilesSetRulePanel.java +++ b/Core/src/org/sleuthkit/autopsy/modules/interestingitems/FilesSetRulePanel.java @@ -543,7 +543,9 @@ final class FilesSetRulePanel extends javax.swing.JPanel { this.mimeCheck.setSelected(false); } else { - this.extensionRadioButton.setEnabled(true); + if (this.nameCheck.isSelected()) { + this.extensionRadioButton.setEnabled(true); + } this.fileSizeCheck.setEnabled(true); this.mimeCheck.setEnabled(true); } From 3d1767f43c2d85a2cc2a8473b607ed4013d79e32 Mon Sep 17 00:00:00 2001 From: Oliver Spohngellert Date: Tue, 24 May 2016 15:31:58 -0400 Subject: [PATCH 04/10] Made file search types enabled based on whether they were checked. --- .../autopsy/filesearch/Bundle.properties | 2 +- .../autopsy/filesearch/DateSearchPanel.form | 3 ++ .../autopsy/filesearch/DateSearchPanel.java | 27 +++++++++++ .../filesearch/KnownStatusSearchPanel.form | 3 ++ .../filesearch/KnownStatusSearchPanel.java | 17 +++++++ .../autopsy/filesearch/MimeTypePanel.form | 17 ++++--- .../autopsy/filesearch/MimeTypePanel.java | 47 ++++++++++++------- .../autopsy/filesearch/NameSearchPanel.form | 3 ++ .../autopsy/filesearch/NameSearchPanel.java | 18 ++++++- .../autopsy/filesearch/SizeSearchPanel.form | 3 ++ .../autopsy/filesearch/SizeSearchPanel.java | 31 ++++++++---- 11 files changed, 137 insertions(+), 34 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/Bundle.properties b/Core/src/org/sleuthkit/autopsy/filesearch/Bundle.properties index d946e2f9c2..c5fd4d48e4 100644 --- a/Core/src/org/sleuthkit/autopsy/filesearch/Bundle.properties +++ b/Core/src/org/sleuthkit/autopsy/filesearch/Bundle.properties @@ -53,6 +53,6 @@ SearchNode.getName.text=Search Result SizeSearchPanel.sizeCompareComboBox.equalTo=equal to SizeSearchPanel.sizeCompareComboBox.greaterThan=greater than SizeSearchPanel.sizeCompareComboBox.lessThan=less than -MimeTypePanel.jCheckBox1.text=MIME Type: MimeTypePanel.jLabel1.text=*Note: Multiple MIME types can be selected FileSearchPanel.searchButton.text=Search +MimeTypePanel.mimeTypeCheckBox.text=MIME Type: diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/DateSearchPanel.form b/Core/src/org/sleuthkit/autopsy/filesearch/DateSearchPanel.form index 4b253ff1e6..2d09e16507 100644 --- a/Core/src/org/sleuthkit/autopsy/filesearch/DateSearchPanel.form +++ b/Core/src/org/sleuthkit/autopsy/filesearch/DateSearchPanel.form @@ -180,6 +180,9 @@ + + + diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/DateSearchPanel.java b/Core/src/org/sleuthkit/autopsy/filesearch/DateSearchPanel.java index b2bb6d295c..ea3642a65d 100644 --- a/Core/src/org/sleuthkit/autopsy/filesearch/DateSearchPanel.java +++ b/Core/src/org/sleuthkit/autopsy/filesearch/DateSearchPanel.java @@ -74,6 +74,7 @@ class DateSearchPanel extends javax.swing.JPanel { copyMenuItem.addActionListener(actList); pasteMenuItem.addActionListener(actList); selectAllMenuItem.addActionListener(actList); + this.setComponentsEnabled(); } JCheckBox getAccessedCheckBox() { @@ -116,6 +117,23 @@ class DateSearchPanel extends javax.swing.JPanel { } } + private void setComponentsEnabled() { + boolean enable = this.dateCheckBox.isSelected(); + this.dateFromTextField.setEnabled(enable); + this.dateFromButtonCalendar.setEnabled(enable); + this.jLabel1.setEnabled(enable); + this.dateToTextField.setEnabled(enable); + this.dateToButtonCalendar.setEnabled(enable); + this.jLabel2.setEnabled(enable); + this.jLabel3.setEnabled(enable); + this.jLabel4.setEnabled(enable); + this.timeZoneComboBox.setEnabled(enable); + this.modifiedCheckBox.setEnabled(enable); + this.accessedCheckBox.setEnabled(enable); + this.changedCheckBox.setEnabled(enable); + this.createdCheckBox.setEnabled(enable); + } + /** * This method is called from within the constructor to initialize the form. * WARNING: Do NOT modify this code. The content of this method is always @@ -170,6 +188,11 @@ class DateSearchPanel extends javax.swing.JPanel { jLabel4.setText(org.openide.util.NbBundle.getMessage(DateSearchPanel.class, "DateSearchPanel.jLabel4.text")); // NOI18N dateCheckBox.setText(org.openide.util.NbBundle.getMessage(DateSearchPanel.class, "DateSearchPanel.dateCheckBox.text")); // NOI18N + dateCheckBox.addActionListener(new java.awt.event.ActionListener() { + public void actionPerformed(java.awt.event.ActionEvent evt) { + dateCheckBoxActionPerformed(evt); + } + }); jLabel3.setFont(new java.awt.Font("Tahoma", 0, 10)); // NOI18N jLabel3.setText(org.openide.util.NbBundle.getMessage(DateSearchPanel.class, "DateSearchPanel.jLabel3.text")); // NOI18N @@ -324,6 +347,10 @@ class DateSearchPanel extends javax.swing.JPanel { } }//GEN-LAST:event_dateToPopupChanged + private void dateCheckBoxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_dateCheckBoxActionPerformed + this.setComponentsEnabled(); + }//GEN-LAST:event_dateCheckBoxActionPerformed + /** * Validate and set the datetime field on the screen given a datetime * string. diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/KnownStatusSearchPanel.form b/Core/src/org/sleuthkit/autopsy/filesearch/KnownStatusSearchPanel.form index 3de5bd4680..beb7227419 100644 --- a/Core/src/org/sleuthkit/autopsy/filesearch/KnownStatusSearchPanel.form +++ b/Core/src/org/sleuthkit/autopsy/filesearch/KnownStatusSearchPanel.form @@ -53,6 +53,9 @@ + + + diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/KnownStatusSearchPanel.java b/Core/src/org/sleuthkit/autopsy/filesearch/KnownStatusSearchPanel.java index 9a564fcdbc..291ced32e7 100644 --- a/Core/src/org/sleuthkit/autopsy/filesearch/KnownStatusSearchPanel.java +++ b/Core/src/org/sleuthkit/autopsy/filesearch/KnownStatusSearchPanel.java @@ -37,6 +37,7 @@ class KnownStatusSearchPanel extends javax.swing.JPanel { */ KnownStatusSearchPanel() { initComponents(); + setComponentsEnabled(); } JCheckBox getKnownCheckBox() { @@ -54,6 +55,13 @@ class KnownStatusSearchPanel extends javax.swing.JPanel { JCheckBox getUnknownOptionCheckBox() { return unknownOptionCheckBox; } + + private void setComponentsEnabled() { + boolean enabled = this.knownCheckBox.isSelected(); + this.unknownOptionCheckBox.setEnabled(enabled); + this.knownOptionCheckBox.setEnabled(enabled); + this.knownBadOptionCheckBox.setEnabled(enabled); + } /** * This method is called from within the constructor to initialize the form. @@ -70,6 +78,11 @@ class KnownStatusSearchPanel extends javax.swing.JPanel { knownBadOptionCheckBox = new javax.swing.JCheckBox(); knownCheckBox.setText(org.openide.util.NbBundle.getMessage(KnownStatusSearchPanel.class, "KnownStatusSearchPanel.knownCheckBox.text")); // NOI18N + knownCheckBox.addActionListener(new java.awt.event.ActionListener() { + public void actionPerformed(java.awt.event.ActionEvent evt) { + knownCheckBoxActionPerformed(evt); + } + }); unknownOptionCheckBox.setSelected(true); unknownOptionCheckBox.setText(org.openide.util.NbBundle.getMessage(KnownStatusSearchPanel.class, "KnownStatusSearchPanel.unknownOptionCheckBox.text")); // NOI18N @@ -117,6 +130,10 @@ class KnownStatusSearchPanel extends javax.swing.JPanel { // TODO add your handling code here: }//GEN-LAST:event_knownOptionCheckBoxActionPerformed + private void knownCheckBoxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_knownCheckBoxActionPerformed + setComponentsEnabled(); + }//GEN-LAST:event_knownCheckBoxActionPerformed + // Variables declaration - do not modify//GEN-BEGIN:variables private javax.swing.JCheckBox knownBadOptionCheckBox; private javax.swing.JCheckBox knownCheckBox; diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/MimeTypePanel.form b/Core/src/org/sleuthkit/autopsy/filesearch/MimeTypePanel.form index 9221d39633..a8c7fa65f9 100755 --- a/Core/src/org/sleuthkit/autopsy/filesearch/MimeTypePanel.form +++ b/Core/src/org/sleuthkit/autopsy/filesearch/MimeTypePanel.form @@ -25,13 +25,13 @@ - + - + @@ -44,12 +44,12 @@ - + - + @@ -62,7 +62,7 @@ - + @@ -77,12 +77,15 @@ - + - + + + + diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/MimeTypePanel.java b/Core/src/org/sleuthkit/autopsy/filesearch/MimeTypePanel.java index 8a90761946..b4172354a4 100755 --- a/Core/src/org/sleuthkit/autopsy/filesearch/MimeTypePanel.java +++ b/Core/src/org/sleuthkit/autopsy/filesearch/MimeTypePanel.java @@ -5,17 +5,16 @@ */ package org.sleuthkit.autopsy.filesearch; -import java.awt.event.ActionListener; import java.util.ArrayList; import java.util.HashSet; import java.util.List; import java.util.Set; import java.util.SortedSet; import java.util.logging.Level; -import org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector; import org.apache.tika.mime.MediaType; import org.apache.tika.mime.MimeTypes; import org.sleuthkit.autopsy.coreutils.Logger; +import org.sleuthkit.autopsy.modules.filetypeid.FileTypeDetector; /** * @@ -32,6 +31,7 @@ public class MimeTypePanel extends javax.swing.JPanel { */ public MimeTypePanel() { initComponents(); + setComponentsEnabled(); } private String[] getMimeTypeArray() { @@ -63,11 +63,17 @@ public class MimeTypePanel extends javax.swing.JPanel { } List getMimeTypesSelected() { - return this.jList1.getSelectedValuesList(); + return this.mimeTypeList.getSelectedValuesList(); } boolean isSelected() { - return this.jCheckBox1.isSelected(); + return this.mimeTypeCheckBox.isSelected(); + } + + void setComponentsEnabled() { + boolean enabled = this.isSelected(); + this.mimeTypeList.setEnabled(enabled); + this.jLabel1.setEnabled(enabled); } /** @@ -80,22 +86,27 @@ public class MimeTypePanel extends javax.swing.JPanel { private void initComponents() { jScrollPane1 = new javax.swing.JScrollPane(); - jList1 = new javax.swing.JList(); - jCheckBox1 = new javax.swing.JCheckBox(); + mimeTypeList = new javax.swing.JList<>(); + mimeTypeCheckBox = new javax.swing.JCheckBox(); jLabel1 = new javax.swing.JLabel(); setMinimumSize(new java.awt.Dimension(150, 150)); setPreferredSize(new java.awt.Dimension(100, 100)); - jList1.setModel(new javax.swing.AbstractListModel() { + mimeTypeList.setModel(new javax.swing.AbstractListModel() { String[] strings = getMimeTypeArray(); public int getSize() { return strings.length; } public String getElementAt(int i) { return strings[i]; } }); - jList1.setMinimumSize(new java.awt.Dimension(0, 200)); - jScrollPane1.setViewportView(jList1); + mimeTypeList.setMinimumSize(new java.awt.Dimension(0, 200)); + jScrollPane1.setViewportView(mimeTypeList); - org.openide.awt.Mnemonics.setLocalizedText(jCheckBox1, org.openide.util.NbBundle.getMessage(MimeTypePanel.class, "MimeTypePanel.jCheckBox1.text")); // NOI18N + org.openide.awt.Mnemonics.setLocalizedText(mimeTypeCheckBox, org.openide.util.NbBundle.getMessage(MimeTypePanel.class, "MimeTypePanel.mimeTypeCheckBox.text")); // NOI18N + mimeTypeCheckBox.addActionListener(new java.awt.event.ActionListener() { + public void actionPerformed(java.awt.event.ActionEvent evt) { + mimeTypeCheckBoxActionPerformed(evt); + } + }); jLabel1.setFont(new java.awt.Font("Tahoma", 0, 10)); // NOI18N org.openide.awt.Mnemonics.setLocalizedText(jLabel1, org.openide.util.NbBundle.getMessage(MimeTypePanel.class, "MimeTypePanel.jLabel1.text")); // NOI18N @@ -105,12 +116,12 @@ public class MimeTypePanel extends javax.swing.JPanel { layout.setHorizontalGroup( layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING) .addGroup(layout.createSequentialGroup() - .addComponent(jCheckBox1) + .addComponent(mimeTypeCheckBox) .addGap(0, 0, Short.MAX_VALUE)) .addGroup(layout.createSequentialGroup() .addContainerGap() .addGroup(layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING) - .addComponent(jScrollPane1, javax.swing.GroupLayout.PREFERRED_SIZE, 0, Short.MAX_VALUE) + .addComponent(jScrollPane1, javax.swing.GroupLayout.DEFAULT_SIZE, 298, Short.MAX_VALUE) .addGroup(layout.createSequentialGroup() .addComponent(jLabel1, javax.swing.GroupLayout.PREFERRED_SIZE, 246, javax.swing.GroupLayout.PREFERRED_SIZE) .addGap(0, 0, Short.MAX_VALUE))) @@ -119,20 +130,24 @@ public class MimeTypePanel extends javax.swing.JPanel { layout.setVerticalGroup( layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING) .addGroup(javax.swing.GroupLayout.Alignment.TRAILING, layout.createSequentialGroup() - .addComponent(jCheckBox1) + .addComponent(mimeTypeCheckBox) .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED) .addComponent(jScrollPane1, javax.swing.GroupLayout.DEFAULT_SIZE, 106, Short.MAX_VALUE) .addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED) .addComponent(jLabel1) - .addGap(0, 0, 0)) + .addContainerGap()) ); }// //GEN-END:initComponents + private void mimeTypeCheckBoxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_mimeTypeCheckBoxActionPerformed + setComponentsEnabled(); + }//GEN-LAST:event_mimeTypeCheckBoxActionPerformed + // Variables declaration - do not modify//GEN-BEGIN:variables - private javax.swing.JCheckBox jCheckBox1; private javax.swing.JLabel jLabel1; - private javax.swing.JList jList1; private javax.swing.JScrollPane jScrollPane1; + private javax.swing.JCheckBox mimeTypeCheckBox; + private javax.swing.JList mimeTypeList; // End of variables declaration//GEN-END:variables } diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/NameSearchPanel.form b/Core/src/org/sleuthkit/autopsy/filesearch/NameSearchPanel.form index 7b5e61f5e1..2dfc5af1c3 100644 --- a/Core/src/org/sleuthkit/autopsy/filesearch/NameSearchPanel.form +++ b/Core/src/org/sleuthkit/autopsy/filesearch/NameSearchPanel.form @@ -94,6 +94,9 @@ + + + diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/NameSearchPanel.java b/Core/src/org/sleuthkit/autopsy/filesearch/NameSearchPanel.java index dc68c320de..1ae2842947 100644 --- a/Core/src/org/sleuthkit/autopsy/filesearch/NameSearchPanel.java +++ b/Core/src/org/sleuthkit/autopsy/filesearch/NameSearchPanel.java @@ -24,7 +24,6 @@ */ package org.sleuthkit.autopsy.filesearch; -import java.awt.*; import java.awt.event.ActionEvent; import java.awt.event.ActionListener; import javax.swing.JCheckBox; @@ -43,6 +42,7 @@ class NameSearchPanel extends javax.swing.JPanel { NameSearchPanel() { initComponents(); customizeComponents(); + setComponentsEnabled(); } private void customizeComponents() { @@ -77,6 +77,12 @@ class NameSearchPanel extends javax.swing.JPanel { JTextField getSearchTextField() { return searchTextField; } + + void setComponentsEnabled() { + boolean enabled = nameCheckBox.isSelected(); + this.searchTextField.setEnabled(enabled); + this.noteNameLabel.setEnabled(enabled); + } /** * This method is called from within the constructor to initialize the form. @@ -110,6 +116,11 @@ class NameSearchPanel extends javax.swing.JPanel { nameCheckBox.setFont(nameCheckBox.getFont().deriveFont(nameCheckBox.getFont().getStyle() & ~java.awt.Font.BOLD, 11)); nameCheckBox.setText(org.openide.util.NbBundle.getMessage(NameSearchPanel.class, "NameSearchPanel.nameCheckBox.text")); // NOI18N + nameCheckBox.addActionListener(new java.awt.event.ActionListener() { + public void actionPerformed(java.awt.event.ActionEvent evt) { + nameCheckBoxActionPerformed(evt); + } + }); searchTextField.setFont(searchTextField.getFont().deriveFont(searchTextField.getFont().getStyle() & ~java.awt.Font.BOLD, 11)); searchTextField.setText(org.openide.util.NbBundle.getMessage(NameSearchPanel.class, "NameSearchPanel.searchTextField.text")); // NOI18N @@ -154,6 +165,11 @@ class NameSearchPanel extends javax.swing.JPanel { private void searchTextFieldMouseClicked(java.awt.event.MouseEvent evt) {//GEN-FIRST:event_searchTextFieldMouseClicked this.nameCheckBox.setSelected(true); }//GEN-LAST:event_searchTextFieldMouseClicked + + private void nameCheckBoxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_nameCheckBoxActionPerformed + setComponentsEnabled(); + }//GEN-LAST:event_nameCheckBoxActionPerformed + // Variables declaration - do not modify//GEN-BEGIN:variables private javax.swing.JMenuItem copyMenuItem; private javax.swing.JMenuItem cutMenuItem; diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/SizeSearchPanel.form b/Core/src/org/sleuthkit/autopsy/filesearch/SizeSearchPanel.form index 26a8e904bc..7987a8a031 100644 --- a/Core/src/org/sleuthkit/autopsy/filesearch/SizeSearchPanel.form +++ b/Core/src/org/sleuthkit/autopsy/filesearch/SizeSearchPanel.form @@ -116,6 +116,9 @@ + + + diff --git a/Core/src/org/sleuthkit/autopsy/filesearch/SizeSearchPanel.java b/Core/src/org/sleuthkit/autopsy/filesearch/SizeSearchPanel.java index e530ba7b42..4a0bc91d5e 100644 --- a/Core/src/org/sleuthkit/autopsy/filesearch/SizeSearchPanel.java +++ b/Core/src/org/sleuthkit/autopsy/filesearch/SizeSearchPanel.java @@ -18,8 +18,6 @@ */ package org.sleuthkit.autopsy.filesearch; -import org.openide.util.NbBundle; - import java.awt.event.ActionEvent; import java.awt.event.ActionListener; import java.text.NumberFormat; @@ -40,6 +38,7 @@ class SizeSearchPanel extends javax.swing.JPanel { SizeSearchPanel() { initComponents(); customizeComponents(); + setComponentsEnabled(); } private void customizeComponents() { @@ -82,6 +81,13 @@ class SizeSearchPanel extends javax.swing.JPanel { JComboBox getSizeUnitComboBox() { return sizeUnitComboBox; } + + void setComponentsEnabled() { + boolean enabled = this.sizeCheckBox.isSelected(); + this.sizeCompareComboBox.setEnabled(enabled); + this.sizeUnitComboBox.setEnabled(enabled); + this.sizeTextField.setEnabled(enabled); + } /** * This method is called from within the constructor to initialize the form. @@ -97,9 +103,9 @@ class SizeSearchPanel extends javax.swing.JPanel { copyMenuItem = new javax.swing.JMenuItem(); pasteMenuItem = new javax.swing.JMenuItem(); selectAllMenuItem = new javax.swing.JMenuItem(); - sizeUnitComboBox = new javax.swing.JComboBox(); + sizeUnitComboBox = new javax.swing.JComboBox<>(); sizeTextField = new JFormattedTextField(NumberFormat.getIntegerInstance()); - sizeCompareComboBox = new javax.swing.JComboBox(); + sizeCompareComboBox = new javax.swing.JComboBox<>(); sizeCheckBox = new javax.swing.JCheckBox(); cutMenuItem.setText(org.openide.util.NbBundle.getMessage(SizeSearchPanel.class, "SizeSearchPanel.cutMenuItem.text")); // NOI18N @@ -114,7 +120,7 @@ class SizeSearchPanel extends javax.swing.JPanel { selectAllMenuItem.setText(org.openide.util.NbBundle.getMessage(SizeSearchPanel.class, "SizeSearchPanel.selectAllMenuItem.text")); // NOI18N rightClickMenu.add(selectAllMenuItem); - sizeUnitComboBox.setModel(new javax.swing.DefaultComboBoxModel(new String[] { "Byte(s)", "KB", "MB", "GB", "TB" })); //NON-NLS + sizeUnitComboBox.setModel(new javax.swing.DefaultComboBoxModel(new String[] { "Byte(s)", "KB", "MB", "GB", "TB" })); sizeTextField.setValue(0); sizeTextField.addMouseListener(new java.awt.event.MouseAdapter() { @@ -123,12 +129,14 @@ class SizeSearchPanel extends javax.swing.JPanel { } }); - sizeCompareComboBox.setModel(new javax.swing.DefaultComboBoxModel(new String[] { - NbBundle.getMessage(this.getClass(), "SizeSearchPanel.sizeCompareComboBox.equalTo"), - NbBundle.getMessage(this.getClass(), "SizeSearchPanel.sizeCompareComboBox.greaterThan"), - NbBundle.getMessage(this.getClass(), "SizeSearchPanel.sizeCompareComboBox.lessThan") })); + sizeCompareComboBox.setModel(new javax.swing.DefaultComboBoxModel(new String[] { "equal to", "greater than", "less than" })); sizeCheckBox.setText(org.openide.util.NbBundle.getMessage(SizeSearchPanel.class, "SizeSearchPanel.sizeCheckBox.text")); // NOI18N + sizeCheckBox.addActionListener(new java.awt.event.ActionListener() { + public void actionPerformed(java.awt.event.ActionEvent evt) { + sizeCheckBoxActionPerformed(evt); + } + }); javax.swing.GroupLayout layout = new javax.swing.GroupLayout(this); this.setLayout(layout); @@ -157,6 +165,11 @@ class SizeSearchPanel extends javax.swing.JPanel { this.sizeCheckBox.setSelected(true); this.sizeTextField.selectAll(); // select all so user can change it easily }//GEN-LAST:event_sizeTextFieldMouseClicked + + private void sizeCheckBoxActionPerformed(java.awt.event.ActionEvent evt) {//GEN-FIRST:event_sizeCheckBoxActionPerformed + setComponentsEnabled(); + }//GEN-LAST:event_sizeCheckBoxActionPerformed + // Variables declaration - do not modify//GEN-BEGIN:variables private javax.swing.JMenuItem copyMenuItem; private javax.swing.JMenuItem cutMenuItem; From 549d033a471d967ef1120a74c689b27643f62cb4 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Tue, 24 May 2016 18:36:53 -0400 Subject: [PATCH 05/10] Improve indexed text content viewer behavior --- .../autopsy/keywordsearch/Bundle.properties | 1 - .../keywordsearch/Bundle_ja.properties | 1 - .../keywordsearch/ExtractedContentViewer.java | 129 ++++++++++++------ .../autopsy/keywordsearch/RawText.java | 37 +++-- 4 files changed, 117 insertions(+), 51 deletions(-) diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/Bundle.properties b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/Bundle.properties index 2029e61e61..8b1f465b6a 100644 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/Bundle.properties +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/Bundle.properties @@ -59,7 +59,6 @@ AbstractKeywordSearchPerformer.search.emptyKeywordErrorBody=Keyword list is empt AbstractKeywordSearchPerformer.search.noFilesInIdxMsg=No files are in index yet.
Try again later. Index is updated every {0} minutes. AbstractKeywordSearchPerformer.search.noFilesIdxdMsg=No files were indexed.
Re-ingest the image with the Keyword Search Module enabled. ExtractedContentPanel.setMarkup.panelTxt=Loading text... Please wait -ExtractedContentViewer.toString=Extracted Text ExtractedContentViewer.toolTip=Displays extracted text from files and keyword-search results. Requires Keyword Search ingest to be run on a file to activate this viewer. ExtractedContentViewer.getTitle=Indexed Text ExtractedContentViewer.getSolrContent.knownFileMsg=

{0} is a known file (based on MD5 hash) and does not have text in the index.

diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/Bundle_ja.properties b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/Bundle_ja.properties index 598798eb63..6230a04153 100644 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/Bundle_ja.properties +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/Bundle_ja.properties @@ -47,7 +47,6 @@ AbstractKeywordSearchPerformer.search.emptyKeywordErrorBody=\u30ad\u30fc\u30ef\u AbstractKeywordSearchPerformer.search.noFilesInIdxMsg=\u30a4\u30f3\u30c7\u30c3\u30af\u30b9\u306b\u307e\u3060\u30d5\u30a1\u30a4\u30eb\u304c\u3042\u308a\u307e\u305b\u3093\u3002
\u3057\u3070\u3089\u304f\u3057\u3066\u304b\u3089\u518d\u5ea6\u5b9f\u884c\u3057\u3066\u304f\u3060\u3055\u3044\u3002\u30a4\u30f3\u30c7\u30c3\u30af\u30b9\u306f{0}\u5206\u3054\u3068\u306b\u66f4\u65b0\u3055\u308c\u307e\u3059\u3002 AbstractKeywordSearchPerformer.search.noFilesIdxdMsg=\u30a4\u30f3\u30c7\u30c3\u30af\u30b9\u5316\u3055\u308c\u305f\u30d5\u30a1\u30a4\u30eb\u304c\u3042\u308a\u307e\u305b\u3093\u3002
\u30ad\u30fc\u30ef\u30fc\u30c9\u691c\u7d22\u30e2\u30b8\u30e5\u30fc\u30eb\u3092\u6709\u52b9\u5316\u3057\u3066\u30a4\u30e1\u30fc\u30b8\u3092\u518d\u5ea6\u30a4\u30f3\u30b8\u30a7\u30b9\u30c8\u3002 ExtractedContentPanel.setMarkup.panelTxt=\u30c6\u30ad\u30b9\u30c8\u30ed\u30fc\u30c9\u4e2d...\u3057\u3070\u3089\u304f\u304a\u5f85\u3061\u304f\u3060\u3055\u3044\u3002 -ExtractedContentViewer.toString=\u62bd\u51fa\u3055\u308c\u305f\u30c6\u30ad\u30b9\u30c8 ExtractedContentViewer.toolTip=\u30d5\u30a1\u30a4\u30eb\u3084\u30ad\u30fc\u30ef\u30fc\u30c9\u691c\u7d22\u7d50\u679c\u304b\u3089\u62bd\u51fa\u3055\u308c\u305f\u30c6\u30ad\u30b9\u30c8\u3092\u8868\u793a\u3002\u3053\u306e\u30d3\u30e5\u30fc\u30a2\u3092\u6709\u52b9\u5316\u3059\u308b\u306b\u306f\u3001\u30d5\u30a1\u30a4\u30eb\u306b\u5bfe\u3057\u3066\u30ad\u30fc\u30ef\u30fc\u30c9\u691c\u7d22\u30a4\u30f3\u30b8\u30a7\u30b9\u30c8\u3092\u5b9f\u884c\u3059\u308b\u5fc5\u8981\u304c\u3042\u308a\u307e\u3059\u3002 ExtractedContentViewer.getTitle=\u30a4\u30f3\u30c7\u30c3\u30af\u30b9\u5316\u3055\u308c\u305f\u30c6\u30ad\u30b9\u30c8 ExtractedContentViewer.getSolrContent.knownFileMsg=

{0}\u306f\u65e2\u77e5\u30d5\u30a1\u30a4\u30eb\u3067\u3059\uff08MDS\u30cf\u30c3\u30b7\u30e5\u306b\u57fa\u3065\u304f\u3068\uff09\u3002\u30a4\u30f3\u30c7\u30c3\u30af\u30b9\u306b\u30c6\u30ad\u30b9\u30c8\u304c\u3042\u308a\u307e\u305b\u3093\u3002

diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/ExtractedContentViewer.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/ExtractedContentViewer.java index 0d360b4431..687014d91e 100644 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/ExtractedContentViewer.java +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/ExtractedContentViewer.java @@ -1,7 +1,7 @@ /* * Autopsy Forensic Browser * - * Copyright 2011-2015 Basis Technology Corp. + * Copyright 2011-2016 Basis Technology Corp. * Contact: carrier sleuthkit org * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -26,7 +26,6 @@ import java.util.ArrayList; import java.util.Collection; import java.util.List; import java.util.logging.Level; - import org.openide.util.NbBundle; import org.sleuthkit.autopsy.coreutils.Logger; import org.openide.nodes.Node; @@ -40,8 +39,8 @@ import org.sleuthkit.datamodel.TskCoreException; import org.sleuthkit.datamodel.BlackboardAttribute; /** - * Displays the indexed text associated with a file or a blackboard artifact, - * possibly marked up with HTML to highlight keyword hits. + * A content viewer that displays the indexed text associated with a file or an + * artifact, possibly marked up with HTML to highlight keyword hits. */ @ServiceProvider(service = DataContentViewer.class, position = 4) public class ExtractedContentViewer implements DataContentViewer { @@ -51,17 +50,26 @@ public class ExtractedContentViewer implements DataContentViewer { private ExtractedContentPanel panel; private volatile Node currentNode = null; private IndexedText currentSource = null; - private final IsDirVisitor isDirVisitor = new IsDirVisitor(); + /** + * Constructs a content viewer that displays the indexed text associated + * with a file or an artifact, possibly marked up with HTML to highlight + * keyword hits. + */ public ExtractedContentViewer() { } + /** + * Sets the node displayed by the content viewer. + * + * @param node The node to display + */ @Override - public void setNode(final Node selectedNode) { + public void setNode(final Node node) { /* * Clear the viewer. */ - if (selectedNode == null) { + if (node == null) { currentNode = null; resetComponent(); return; @@ -71,51 +79,90 @@ public class ExtractedContentViewer implements DataContentViewer { * This deals with the known bug with an unknown cause where setNode is * sometimes called twice for the same node. */ - if (selectedNode == currentNode) { + if (node == currentNode) { return; } else { - currentNode = selectedNode; + currentNode = node; } /* - * Assemble a collection of all of the "sources" of extracted and - * indexed text to present in a paged display. First look for the text - * marked up with HTML to highlight keyword hits that will be present if - * the node is a keyword hit blakcboard artifact. + * Assemble a collection of all of the indexed text "sources" associated + * with the node. */ - final List sources = new ArrayList<>(); - sources.addAll(selectedNode.getLookup().lookupAll(IndexedText.class)); + IndexedText highlightedHitText = null; + IndexedText rawContentText = null; + IndexedText rawArtifactText = null; + List sources = new ArrayList<>(); /* - * Now look for the "raw" extracted text if this is a node for another - * type of artifact or for content. + * First add the text marked up with HTML to highlight keyword hits that + * will be present in the selected node's lookup if the node is for a + * keyword hit artifact. */ - long documentID = getDocumentId(currentNode); - if (INVALID_DOCUMENT_ID == documentID) { - setPanel(sources); - return; + sources.addAll(node.getLookup().lookupAll(IndexedText.class)); + if (!sources.isEmpty()) { + highlightedHitText = sources.get(0); } - IndexedText rawSource; - if (documentID > INVALID_DOCUMENT_ID) { - // Add a content item - Content content = currentNode.getLookup().lookup(Content.class); - rawSource = new RawText(content, content.getId()); + + /* + * Next, add the "raw" (not highlighted) text, if any, for any content + * associated with the node. + */ + Content content = currentNode.getLookup().lookup(Content.class); + if (null != content && solrHasContent(content.getId())) { + rawContentText = new RawText(content, content.getId()); + sources.add(rawContentText); + int currentPage = rawContentText.getCurrentPage(); + if (currentPage == 0 && rawContentText.hasNextPage()) { + rawContentText.nextPage(); + } + } + + /* + * Finally, add the "raw" (not highlighted) text, if any, for any + * artifact associated with the node. + */ + BlackboardArtifact artifact = node.getLookup().lookup(BlackboardArtifact.class); + if (null != artifact) { + if (artifact.getArtifactTypeID() != BlackboardArtifact.ARTIFACT_TYPE.TSK_KEYWORD_HIT.getTypeID()) { + rawArtifactText = new RawText(artifact, artifact.getArtifactID()); + sources.add(rawArtifactText); + } else { + try { + // Get the associated artifact attribute and return its value as the ID + BlackboardAttribute attribute = artifact.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_ASSOCIATED_ARTIFACT)); + if (attribute != null) { + rawArtifactText = new RawText(artifact, attribute.getValueLong()); // RJCTODO: The artifact is just a flag for RawText, that's why this works + sources.add(rawArtifactText); + } + } catch (TskCoreException ex) { + logger.log(Level.SEVERE, "Error getting associated artifact attributes", ex); //NON-NLS + } + } + } + + /* + * Now set the default text to be displayed. RJCTODO: Correct this. + */ + if (null != highlightedHitText) { + /* + * Default to highlight hit text, if present. + */ + currentSource = highlightedHitText; + } else if (null != rawContentText) { + /* + * Default to the raw content text for content nodes and artifact + * nodes that are not keyword hits. + */ + currentSource = rawContentText; } else { - // Add an artifact item - BlackboardArtifact blackboardArtifact = currentNode.getLookup().lookup(BlackboardArtifact.class); - rawSource = new RawText(blackboardArtifact, documentID); + /* + * Handle the artifacts associated with a data source, for which + * there is no content text. + */ + currentSource = rawArtifactText; } - currentSource = rawSource; - sources.add(rawSource); - /* - * Initialize the pages for the sources. The first source in the list - * of sources will be displayed. - */ - int currentPage = currentSource.getCurrentPage(); - if (currentPage == 0 && currentSource.hasNextPage()) { - currentSource.nextPage(); - } updatePageControls(); setPanel(sources); } @@ -288,8 +335,8 @@ public class ExtractedContentViewer implements DataContentViewer { /* * For keyword search hit artifact nodes and all other nodes, the * document ID for the extracted text is the ID of the associated - * content, if any, unless there is an associated artifact, which - * is handled above. + * content, if any, unless there is an associated artifact, which is + * handled above. */ Content content = node.getLookup().lookup(Content.class); if (content != null) { diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/RawText.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/RawText.java index ed4347fe4f..8aa4687a93 100755 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/RawText.java +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/RawText.java @@ -1,7 +1,7 @@ /* * Autopsy Forensic Browser * - * Copyright 2011-2015 Basis Technology Corp. + * Copyright 2011-2016 Basis Technology Corp. * Contact: carrier sleuthkit org * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -30,8 +30,8 @@ import org.sleuthkit.datamodel.Content; import org.sleuthkit.datamodel.TskData; /** - * Display content with just raw text - * + * A "source" for the extracted content viewer that displays "raw" (not + * highlighted) indexed text for a file or an artifact. */ class RawText implements IndexedText { @@ -151,17 +151,24 @@ class RawText implements IndexedText { if (this.content != null) { return getContentText(currentPage, hasChunks); } else if (this.blackboardArtifact != null) { - return KeywordSearch.getServer().getSolrContent(this.objectId, 1); + return getArtifactText(); } - } catch (SolrServerException | NoOpenCoreException ex) { - logger.log(Level.WARNING, "Couldn't get extracted content.", ex); //NON-NLS + } catch (SolrServerException ex) { + logger.log(Level.SEVERE, "Couldn't get extracted content", ex); //NON-NLS } return NbBundle.getMessage(this.getClass(), "RawText.getText.error.msg"); } + @NbBundle.Messages({ + "RawText.FileText=File Text", + "RawText.ResultText=Result Text"}) @Override public String toString() { - return NbBundle.getMessage(this.getClass(), "ExtractedContentViewer.toString"); + if (null != content) { + return Bundle.RawText_FileText(); + } else { + return Bundle.RawText_ResultText(); + } } @Override @@ -267,9 +274,23 @@ class RawText implements IndexedText { cachedString = sb.toString(); cachedChunk = chunkId; } catch (NoOpenCoreException ex) { - logger.log(Level.WARNING, "Couldn't get text content.", ex); //NON-NLS + logger.log(Level.SEVERE, "No open core", ex); //NON-NLS return ""; } return cachedString; } + + private String getArtifactText() throws SolrServerException{ + try { + String indexedText = KeywordSearch.getServer().getSolrContent(this.objectId, 1); + indexedText = EscapeUtil.escapeHtml(indexedText).trim(); + StringBuilder sb = new StringBuilder(indexedText.length() + 20); + sb.append("
").append(indexedText).append("
"); //NON-NLS + return sb.toString(); + } catch (NoOpenCoreException ex) { + logger.log(Level.SEVERE, "No open core", ex); //NON-NLS + return ""; + } + } + } From 7bf7a3cfd84cc48596a7e6c6469b975eaffc7cd0 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Wed, 25 May 2016 12:08:52 -0400 Subject: [PATCH 06/10] Further improve indexed text content viewer behavior --- .../keywordsearch/ExtractedContentViewer.java | 38 +++++++++---------- 1 file changed, 19 insertions(+), 19 deletions(-) diff --git a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/ExtractedContentViewer.java b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/ExtractedContentViewer.java index 687014d91e..01db29ab19 100644 --- a/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/ExtractedContentViewer.java +++ b/KeywordSearch/src/org/sleuthkit/autopsy/keywordsearch/ExtractedContentViewer.java @@ -30,6 +30,7 @@ import org.openide.util.NbBundle; import org.sleuthkit.autopsy.coreutils.Logger; import org.openide.nodes.Node; import org.openide.util.lookup.ServiceProvider; +import org.sleuthkit.autopsy.casemodule.Case; import org.sleuthkit.autopsy.corecomponentinterfaces.DataContentViewer; import org.sleuthkit.datamodel.BlackboardArtifact; import org.sleuthkit.datamodel.Content; @@ -112,10 +113,6 @@ public class ExtractedContentViewer implements DataContentViewer { if (null != content && solrHasContent(content.getId())) { rawContentText = new RawText(content, content.getId()); sources.add(rawContentText); - int currentPage = rawContentText.getCurrentPage(); - if (currentPage == 0 && rawContentText.hasNextPage()) { - rawContentText.nextPage(); - } } /* @@ -124,17 +121,22 @@ public class ExtractedContentViewer implements DataContentViewer { */ BlackboardArtifact artifact = node.getLookup().lookup(BlackboardArtifact.class); if (null != artifact) { + /* + * For keyword hit artifacts, add the text of the artifact that hit, + * not the hit artifact; otherwise add the text for the artifact. + */ if (artifact.getArtifactTypeID() != BlackboardArtifact.ARTIFACT_TYPE.TSK_KEYWORD_HIT.getTypeID()) { rawArtifactText = new RawText(artifact, artifact.getArtifactID()); sources.add(rawArtifactText); } else { try { - // Get the associated artifact attribute and return its value as the ID BlackboardAttribute attribute = artifact.getAttribute(new BlackboardAttribute.Type(BlackboardAttribute.ATTRIBUTE_TYPE.TSK_ASSOCIATED_ARTIFACT)); if (attribute != null) { - rawArtifactText = new RawText(artifact, attribute.getValueLong()); // RJCTODO: The artifact is just a flag for RawText, that's why this works + long artifactId = attribute.getValueLong(); + BlackboardArtifact associatedArtifact = Case.getCurrentCase().getSleuthkitCase().getBlackboardArtifact(artifactId); + rawArtifactText = new RawText(associatedArtifact, associatedArtifact.getArtifactID()); sources.add(rawArtifactText); - } + } } catch (TskCoreException ex) { logger.log(Level.SEVERE, "Error getting associated artifact attributes", ex); //NON-NLS } @@ -142,27 +144,25 @@ public class ExtractedContentViewer implements DataContentViewer { } /* - * Now set the default text to be displayed. RJCTODO: Correct this. + * Now set the default source to be displayed. */ if (null != highlightedHitText) { - /* - * Default to highlight hit text, if present. - */ currentSource = highlightedHitText; } else if (null != rawContentText) { - /* - * Default to the raw content text for content nodes and artifact - * nodes that are not keyword hits. - */ currentSource = rawContentText; } else { - /* - * Handle the artifacts associated with a data source, for which - * there is no content text. - */ currentSource = rawArtifactText; } + /* + * Push the text sources into the panel. + */ + for (IndexedText source : sources) { + int currentPage = source.getCurrentPage(); + if (currentPage == 0 && source.hasNextPage()) { + source.nextPage(); + } + } updatePageControls(); setPanel(sources); } From 140863fca922dd6f0e21979353bc123b01d83569 Mon Sep 17 00:00:00 2001 From: Oliver Spohngellert Date: Wed, 25 May 2016 13:21:48 -0400 Subject: [PATCH 07/10] Finished fixing behavior. --- .../autopsy/modules/interestingitems/FilesSetRulePanel.java | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/Core/src/org/sleuthkit/autopsy/modules/interestingitems/FilesSetRulePanel.java b/Core/src/org/sleuthkit/autopsy/modules/interestingitems/FilesSetRulePanel.java index 79c9bd842e..9ee7f1a172 100755 --- a/Core/src/org/sleuthkit/autopsy/modules/interestingitems/FilesSetRulePanel.java +++ b/Core/src/org/sleuthkit/autopsy/modules/interestingitems/FilesSetRulePanel.java @@ -816,7 +816,9 @@ final class FilesSetRulePanel extends javax.swing.JPanel { } else { this.nameTextField.setEnabled(true); this.fullNameRadioButton.setEnabled(true); - this.extensionRadioButton.setEnabled(true); + if (this.filesRadioButton.isSelected()) { + this.extensionRadioButton.setEnabled(true); + } this.nameRegexCheckbox.setEnabled(true); } this.setOkButton(); From 99f75f7f61db05023b1e38821e8886b7e2a0c1d0 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Wed, 25 May 2016 13:28:30 -0400 Subject: [PATCH 08/10] Correct error regarding gstreamer in BUILDING.txt --- BUILDING.txt | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/BUILDING.txt b/BUILDING.txt index 6a53ff870a..1f928252e6 100644 --- a/BUILDING.txt +++ b/BUILDING.txt @@ -58,7 +58,7 @@ the needed places (i.e. '/usr/local'). 3) For 32-bit targets, get GStreamer Setup. GStreamer is used to view video files. You can either download it and install it or manually by unzipping the version that is included in the 'thirdparty/gstreamer' folder. You -will need the 'bin' and 'lib/gstreamer-1.0' folders to be in your +will need the 'bin' and 'lib/gstreamer-0.10' folders to be in your Windows PATH environment variable. NOTE: This has not been fully tested in non-Windows environments From f746f455c85f23d9aa7d7b5d4b4253ed6ec16f99 Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Fri, 27 May 2016 12:53:10 -0400 Subject: [PATCH 09/10] Complete docs/deprecation for FileManager API --- .../sleuthkit/autopsy/casemodule/Case.java | 2 + .../casemodule/services/Blackboard.java | 7 +- .../casemodule/services/FileManager.java | 211 ++++++++---------- .../autopsy/casemodule/services/Services.java | 78 ++++--- .../casemodule/services/TagsManager.java | 56 ++--- .../KeywordSearchService.java | 8 +- 6 files changed, 178 insertions(+), 184 deletions(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java index 7677b5be68..ecd67d2052 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/Case.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/Case.java @@ -282,6 +282,7 @@ public class Case implements SleuthkitCase.ErrorObserver { /** * Constructor for the Case class */ + @SuppressWarnings("deprecation") private Case(CaseMetadata caseMetadata, SleuthkitCase db) { this.caseMetadata = caseMetadata; this.db = db; @@ -835,6 +836,7 @@ public class Case implements SleuthkitCase.ErrorObserver { /** * Closes this case. This methods close the xml and clear all the fields. */ + @SuppressWarnings("deprecation") public void closeCase() throws CaseActionException { changeCase(null); try { diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java b/Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java index d5064e3b4e..1f2f4b252b 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java @@ -109,10 +109,13 @@ public final class Blackboard implements Closeable { } /** - * Cloese this blackboard and releases any resources associated with it. - * @throws IOException + * Closes the blackboard. + * + * @throws IOException If there is a problem closing the blackboard. + * @deprecated File manager clients should not close the blackboard. */ @Override + @Deprecated public void close() throws IOException { } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/FileManager.java b/Core/src/org/sleuthkit/autopsy/casemodule/services/FileManager.java index 336e97742b..5bf85602d4 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/FileManager.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/FileManager.java @@ -26,10 +26,8 @@ import java.io.Closeable; import java.io.IOException; import java.util.ArrayList; import java.util.List; -import java.util.logging.Level; import org.openide.util.NbBundle; import org.sleuthkit.autopsy.casemodule.Case; -import org.sleuthkit.autopsy.coreutils.Logger; import org.sleuthkit.autopsy.datamodel.VirtualDirectoryNode; import org.sleuthkit.autopsy.ingest.IngestServices; import org.sleuthkit.autopsy.ingest.ModuleContentEvent; @@ -37,7 +35,6 @@ import org.sleuthkit.datamodel.AbstractFile; import org.sleuthkit.datamodel.Content; import org.sleuthkit.datamodel.DerivedFile; import org.sleuthkit.datamodel.LayoutFile; -import org.sleuthkit.datamodel.LocalFile; import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction; import org.sleuthkit.datamodel.TskCoreException; @@ -48,55 +45,19 @@ import org.sleuthkit.datamodel.LocalFilesDataSource; import org.sleuthkit.datamodel.TskDataException; /** - * A case-level service that provides methods for retrieving files associated - * with the case and for adding local files, carved files, and derived files to - * the case. + * A manager that provides methods for retrieving files from the current case + * and for adding local files, carved files, and derived files to the current + * case. */ public class FileManager implements Closeable { - private static final Logger logger = Logger.getLogger(FileManager.class.getName()); - private SleuthkitCase caseDb; - - /* - * TODO (AUT-1905): Although this counter is guarded by the monitor of the - * FileManager, this does not guarantee unique default file set names for - * multi-user cases where multiple nodes can be running FileManagers for the - * same case. - */ - private int localFileDataSourcesCounter; - /** - * Constructs a case-level service that provides methods for retrieving - * files associated with the case and for adding local files, carved files, - * and derived files to the case. + * Constructs a manager that provides methods for retrieving files from the + * current case and for adding local files, carved files, and derived files + * to the current case. + * */ - FileManager(Case currentCase, SleuthkitCase caseDb) throws TskCoreException { - this.caseDb = caseDb; - initializeLocalFileDataSourcesCounter(); - } - - /** - * Initialize the counter for the number of logical/local file sets that is - * used to generate the default logical/local file data source names. - */ - private void initializeLocalFileDataSourcesCounter() { - /* - * TODO (AUT-1905): Although the counter is guarded by the monitor of - * the FileManager, this does not guarantee unique default file set - * names for multi-user cases where multiple nodes can be running - * FileManagers for the same case. - */ - localFileDataSourcesCounter = 0; - try { - List localFileDataSources = caseDb.getVirtualDirectoryRoots(); - for (VirtualDirectory vd : localFileDataSources) { - if (vd.getName().startsWith(VirtualDirectoryNode.LOGICAL_FILE_SET_PREFIX)) { - ++localFileDataSourcesCounter; - } - } - } catch (TskCoreException ex) { - logger.log(Level.SEVERE, "Error initializing logical files counter", ex); //NON-NLS - } + FileManager() { } /** @@ -111,12 +72,9 @@ public class FileManager implements Closeable { * @throws TskCoreException if there is a problem querying the case * database. */ - public synchronized List findFiles(String fileName) throws TskCoreException { - if (null == caseDb) { - throw new TskCoreException("FileManager closed"); - } + public List findFiles(String fileName) throws TskCoreException { List result = new ArrayList<>(); - List dataSources = caseDb.getRootObjects(); + List dataSources = Case.getCurrentCase().getSleuthkitCase().getRootObjects(); for (Content dataSource : dataSources) { result.addAll(findFiles(dataSource, fileName)); } @@ -137,12 +95,9 @@ public class FileManager implements Closeable { * @throws TskCoreException if there is a problem querying the case * database. */ - public synchronized List findFiles(String fileName, String parentName) throws TskCoreException { - if (null == caseDb) { - throw new TskCoreException("FileManager closed"); - } + public List findFiles(String fileName, String parentName) throws TskCoreException { List result = new ArrayList<>(); - List dataSources = caseDb.getRootObjects(); + List dataSources = Case.getCurrentCase().getSleuthkitCase().getRootObjects(); for (Content dataSource : dataSources) { result.addAll(findFiles(dataSource, fileName, parentName)); } @@ -163,12 +118,9 @@ public class FileManager implements Closeable { * @throws TskCoreException if there is a problem querying the case * database. */ - public synchronized List findFiles(String fileName, AbstractFile parent) throws TskCoreException { - if (null == caseDb) { - throw new TskCoreException("FileManager closed"); - } + public List findFiles(String fileName, AbstractFile parent) throws TskCoreException { List result = new ArrayList<>(); - List dataSources = caseDb.getRootObjects(); + List dataSources = Case.getCurrentCase().getSleuthkitCase().getRootObjects(); for (Content dataSource : dataSources) { result.addAll(findFiles(dataSource, fileName, parent)); } @@ -189,8 +141,8 @@ public class FileManager implements Closeable { * @throws TskCoreException if there is a problem querying the case * database. */ - public synchronized List findFiles(Content dataSource, String fileName) throws TskCoreException { - return caseDb.findFiles(dataSource, fileName); + public List findFiles(Content dataSource, String fileName) throws TskCoreException { + return Case.getCurrentCase().getSleuthkitCase().findFiles(dataSource, fileName); } /** @@ -209,8 +161,8 @@ public class FileManager implements Closeable { * @throws TskCoreException if there is a problem querying the case * database. */ - public synchronized List findFiles(Content dataSource, String fileName, String parentName) throws TskCoreException { - return caseDb.findFiles(dataSource, fileName, parentName); + public List findFiles(Content dataSource, String fileName, String parentName) throws TskCoreException { + return Case.getCurrentCase().getSleuthkitCase().findFiles(dataSource, fileName, parentName); } /** @@ -229,7 +181,7 @@ public class FileManager implements Closeable { * @throws TskCoreException if there is a problem querying the case * database. */ - public synchronized List findFiles(Content dataSource, String fileName, AbstractFile parent) throws TskCoreException { + public List findFiles(Content dataSource, String fileName, AbstractFile parent) throws TskCoreException { return findFiles(dataSource, fileName, parent.getName()); } @@ -258,11 +210,8 @@ public class FileManager implements Closeable { * @throws TskCoreException if there is a problem querying the case * database. */ - public synchronized List openFiles(Content dataSource, String filePath) throws TskCoreException { - if (null == caseDb) { - throw new TskCoreException("FileManager closed"); - } - return caseDb.openFiles(dataSource, filePath); + public List openFiles(Content dataSource, String filePath) throws TskCoreException { + return Case.getCurrentCase().getSleuthkitCase().openFiles(dataSource, filePath); } /** @@ -293,14 +242,15 @@ public class FileManager implements Closeable { * @throws TskCoreException if there is a problem adding the file to the * case database. */ - public synchronized DerivedFile addDerivedFile(String fileName, + public DerivedFile addDerivedFile(String fileName, String localPath, long size, long ctime, long crtime, long atime, long mtime, boolean isFile, AbstractFile parentFile, String rederiveDetails, String toolName, String toolVersion, String otherDetails) throws TskCoreException { - return caseDb.addDerivedFile(fileName, localPath, size, + + return Case.getCurrentCase().getSleuthkitCase().addDerivedFile(fileName, localPath, size, ctime, crtime, atime, mtime, isFile, parentFile, rederiveDetails, toolName, toolVersion, otherDetails); } @@ -322,7 +272,7 @@ public class FileManager implements Closeable { * case database. */ public synchronized LayoutFile addCarvedFile(String fileName, long fileSize, long parentObjId, List layout) throws TskCoreException { - return caseDb.addCarvedFile(fileName, fileSize, parentObjId, layout); + return Case.getCurrentCase().getSleuthkitCase().addCarvedFile(fileName, fileSize, parentObjId, layout); } /** @@ -338,7 +288,7 @@ public class FileManager implements Closeable { * case database. */ public List addCarvedFiles(List filesToAdd) throws TskCoreException { - return caseDb.addCarvedFiles(filesToAdd); + return Case.getCurrentCase().getSleuthkitCase().addCarvedFiles(filesToAdd); } /** @@ -352,7 +302,7 @@ public class FileManager implements Closeable { * * @param An AbstractFile represeting the added file or directory. */ - public void fileAdded(AbstractFile newFile); + void fileAdded(AbstractFile newFile); } /** @@ -384,27 +334,19 @@ public class FileManager implements Closeable { * directory that does not exist or cannot be read. */ public synchronized LocalFilesDataSource addLocalFilesDataSource(String deviceId, String rootVirtualDirectoryName, String timeZone, List localFilePaths, FileAddProgressUpdater progressUpdater) throws TskCoreException, TskDataException { - /* - * Convert the local/logical file paths into File objects. - */ List localFiles = getFilesAndDirectories(localFilePaths); CaseDbTransaction trans = null; try { - /* - * Generate a name for the root virtual directory for the data - * source, if a name was not supplied, and increment the counter - * used to generate the default names. - */ - int newLocalFilesSetCount = localFileDataSourcesCounter + 1; String rootDirectoryName = rootVirtualDirectoryName; - if (rootVirtualDirectoryName.isEmpty()) { - rootDirectoryName = VirtualDirectoryNode.LOGICAL_FILE_SET_PREFIX + newLocalFilesSetCount; + if (rootDirectoryName.isEmpty()) { + rootDirectoryName = generateFilesDataSourceName(); } /* * Add the root virtual directory and its local/logical file - * chioldren to the case database. + * children to the case database. */ + SleuthkitCase caseDb = Case.getCurrentCase().getSleuthkitCase(); trans = caseDb.beginTransaction(); LocalFilesDataSource dataSource = caseDb.addLocalFilesDataSource(deviceId, rootDirectoryName, timeZone, trans); VirtualDirectory rootDirectory = dataSource.getRootDirectory(); @@ -419,18 +361,6 @@ public class FileManager implements Closeable { } trans.commit(); - /* - * Update the counter used to generate the default names. - * - * TODO (AUT-1905): Although the counter is guarded by the monitor - * of the FileManager, this does not guarantee unique default file - * set names for multi-user cases where multiple nodes can be - * running FileManagers for the same case. - */ - if (rootVirtualDirectoryName.isEmpty()) { - localFileDataSourcesCounter = newLocalFilesSetCount; - } - /* * Publish content added events for the added files and directories. */ @@ -448,6 +378,34 @@ public class FileManager implements Closeable { } } + /** + * Generates a name for the root virtual directory for the data source. + * + * NOTE: Although this method is guarded by the file manager's monitor, + * there is currently a minimal chance of default name duplication for + * multi-user cases with multiple FileManagers running on different nodes. + * + * @return A default name for a local/logical files data source of the form: + * LogicalFileSet[N]. + * + * @throws TskCoreException If there is a problem querying the case + * database. + */ + private synchronized String generateFilesDataSourceName() throws TskCoreException { + int localFileDataSourcesCounter = 0; + try { + List localFileDataSources = Case.getCurrentCase().getSleuthkitCase().getVirtualDirectoryRoots(); + for (VirtualDirectory vd : localFileDataSources) { + if (vd.getName().startsWith(VirtualDirectoryNode.LOGICAL_FILE_SET_PREFIX)) { + ++localFileDataSourcesCounter; + } + } + return VirtualDirectoryNode.LOGICAL_FILE_SET_PREFIX + (localFileDataSourcesCounter + 1); + } catch (TskCoreException ex) { + throw new TskCoreException("Error querying for existing local file data sources with defualt names", ex); + } + } + /** * Converts a list of local/logical file and/or directory paths to a list of * file objects. @@ -497,7 +455,7 @@ public class FileManager implements Closeable { /* * Add the directory as a virtual directory. */ - VirtualDirectory virtualDirectory = caseDb.addVirtualDirectory(parentDirectory.getId(), localFile.getName(), trans); + VirtualDirectory virtualDirectory = Case.getCurrentCase().getSleuthkitCase().addVirtualDirectory(parentDirectory.getId(), localFile.getName(), trans); progressUpdater.fileAdded(virtualDirectory); /* @@ -512,32 +470,12 @@ public class FileManager implements Closeable { return virtualDirectory; } else { - return caseDb.addLocalFile(localFile.getName(), localFile.getAbsolutePath(), localFile.length(), + return Case.getCurrentCase().getSleuthkitCase().addLocalFile(localFile.getName(), localFile.getAbsolutePath(), localFile.length(), 0, 0, 0, 0, localFile.isFile(), parentDirectory, trans); } } - @Override - public synchronized void close() throws IOException { - caseDb = null; - } - - /** - * Contructs a case-level service that provides management of files within - * the data sources added to a case and the local files associated with a - * case. - * - * @param tskCase The case database. - * - * @deprecated Use Case.getCurrentCase().getServices().getFileManager() - * instead. - */ - @Deprecated - public FileManager(SleuthkitCase tskCase) { - this(); - } - /** * Adds a set of local/logical files and/or directories to the case database * as data source. @@ -557,7 +495,7 @@ public class FileManager implements Closeable { * @deprecated Use addLocalFilesDataSource instead. */ @Deprecated - public synchronized VirtualDirectory addLocalFilesDirs(List localFilePaths, FileAddProgressUpdater progressUpdater) throws TskCoreException { + public VirtualDirectory addLocalFilesDirs(List localFilePaths, FileAddProgressUpdater progressUpdater) throws TskCoreException { try { return addLocalFilesDataSource("", "", "", localFilePaths, progressUpdater).getRootDirectory(); } catch (TskDataException ex) { @@ -565,4 +503,29 @@ public class FileManager implements Closeable { } } + /** + * Constructs a manager that provides methods for retrieving files from the + * current case and for adding local files, carved files, and derived files + * to the current case. + * + * @param caseDb The case database. + * + * @deprecated Use Case.getCurrentCase().getServices().getFileManager() + * instead. + */ + @Deprecated + public FileManager(SleuthkitCase caseDb) { + } + + /** + * Closes the file manager. + * + * @throws IOException If there is a problem closing the file manager. + * @deprecated File manager clients should not close the file manager. + */ + @Override + @Deprecated + public void close() throws IOException { + } + } diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java b/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java index 3106d7c3f7..1dbae18d68 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java @@ -1,19 +1,18 @@ /* * * Autopsy Forensic Browser - * - * Copyright 2012-2016 Basis Technology Corp. - * + * + * Copyright 2011-2016 Basis Technology Corp. + * Contact: carrier sleuthkit org * Copyright 2012 42six Solutions. * Contact: aebadirad 42six com - * Project Contact/Architect: carrier sleuthkit org - * + * * Licensed under the Apache License, Version 2.0 (the "License"); * you may not use this file except in compliance with the License. * You may obtain a copy of the License at - * + * * http://www.apache.org/licenses/LICENSE-2.0 - * + * * Unless required by applicable law or agreed to in writing, software * distributed under the License is distributed on an "AS IS" BASIS, * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. @@ -29,10 +28,10 @@ import java.util.List; import org.openide.util.Lookup; import org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService; import org.sleuthkit.datamodel.SleuthkitCase; -import org.sleuthkit.autopsy.casemodule.Case; /** - * A class to manage various services. + * A collection of case-level services (e.g., file manager, tags manager, + * keyword search, blackboard). */ public class Services implements Closeable { @@ -42,51 +41,76 @@ public class Services implements Closeable { private final KeywordSearchService keywordSearchService; private final Blackboard blackboard; - Services(Case currentCase, SleuthkitCase caseDb) { - fileManager = new FileManager(currentCase, caseDb); + /** + * Constructs a collection of case-level services (e.g., file manager, tags + * manager, keyword search, blackboard). + * + * @param caseDb The case database for the current case. + * + * @deprecated Use Case.getCurrentCase().getServices() instead. + * + * TODO (AUT-2158): Prevent public construction of the Services class. + */ + @Deprecated + public Services(SleuthkitCase caseDb) { + fileManager = new FileManager(); services.add(fileManager); - tagsManager = new TagsManager(caseDb); + tagsManager = new TagsManager(); services.add(tagsManager); keywordSearchService = Lookup.getDefault().lookup(KeywordSearchService.class); services.add(keywordSearchService); - - blackboard = new Blackboard(); - services.add(blackboard); - } - - public Services(SleuthkitCase tskCase) { - fileManager = new FileManager(tskCase); - services.add(fileManager); - tagsManager = new TagsManager(tskCase); - services.add(tagsManager); - - keywordSearchService = Lookup.getDefault().lookup(KeywordSearchService.class); - services.add(keywordSearchService); - blackboard = new Blackboard(); services.add(blackboard); } + /** + * Gets the file manager service for the current case. + * + * @return The file manager service for the current case. + */ public FileManager getFileManager() { return fileManager; } + /** + * Gets the tags manager service for the current case. + * + * @return The tags manager service for the current case. + */ public TagsManager getTagsManager() { return tagsManager; } + /** + * Gets the keyword search service for the current case. + * + * @return The keyword search service for the current case. + */ public KeywordSearchService getKeywordSearchService() { return keywordSearchService; } - + + /** + * Gets the blackboard service for the current case. + * + * @return The blackboard service for the current case. + */ public Blackboard getBlackboard() { return blackboard; } + /** + * Closes the services for the current case. + * + * @throws IOException if there is a problem closing the services. + * @deprecated Services clients other than the case should not close the + * services. + */ @Override + @Deprecated public void close() throws IOException { for (Closeable service : services) { service.close(); diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/TagsManager.java b/Core/src/org/sleuthkit/autopsy/casemodule/services/TagsManager.java index 963f54e51f..9da5e9fcbc 100755 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/TagsManager.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/TagsManager.java @@ -32,7 +32,6 @@ import org.sleuthkit.datamodel.BlackboardArtifact; import org.sleuthkit.datamodel.BlackboardArtifactTag; import org.sleuthkit.datamodel.Content; import org.sleuthkit.datamodel.ContentTag; -import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.TagName; import org.sleuthkit.datamodel.TskCoreException; @@ -45,7 +44,6 @@ public class TagsManager implements Closeable { private static final Logger logger = Logger.getLogger(TagsManager.class.getName()); private static final String TAGS_SETTINGS_NAME = "Tags"; //NON-NLS private static final String TAG_NAMES_SETTING_KEY = "TagNames"; //NON-NLS - private final SleuthkitCase caseDb; private final HashMap uniqueTagNames = new HashMap<>(); private boolean tagNamesLoaded = false; @@ -53,11 +51,8 @@ public class TagsManager implements Closeable { * Constructs a per case Autopsy service that manages the creation, * updating, and deletion of tags applied to content and blackboard * artifacts by users. - * - * @param caseDb The case database for the current case. */ - TagsManager(SleuthkitCase caseDb) { - this.caseDb = caseDb; + TagsManager() { } /** @@ -71,7 +66,7 @@ public class TagsManager implements Closeable { */ public synchronized List getAllTagNames() throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getAllTagNames(); + return Case.getCurrentCase().getSleuthkitCase().getAllTagNames(); } /** @@ -85,7 +80,7 @@ public class TagsManager implements Closeable { */ public synchronized List getTagNamesInUse() throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getTagNamesInUse(); + return Case.getCurrentCase().getSleuthkitCase().getTagNamesInUse(); } /** @@ -159,7 +154,7 @@ public class TagsManager implements Closeable { /* * Add the tag name to the case. */ - TagName newTagName = caseDb.addTagName(displayName, description, color); + TagName newTagName = Case.getCurrentCase().getSleuthkitCase().addTagName(displayName, description, color); /* * Add the tag name to the tags settings. @@ -245,7 +240,7 @@ public class TagsManager implements Closeable { } } - tag = caseDb.addContentTag(content, tagName, comment, beginByteOffset, endByteOffset); + tag = Case.getCurrentCase().getSleuthkitCase().addContentTag(content, tagName, comment, beginByteOffset, endByteOffset); } try { @@ -267,7 +262,7 @@ public class TagsManager implements Closeable { public void deleteContentTag(ContentTag tag) throws TskCoreException { synchronized (this) { lazyLoadExistingTagNames(); - caseDb.deleteContentTag(tag); + Case.getCurrentCase().getSleuthkitCase().deleteContentTag(tag); } try { @@ -287,7 +282,7 @@ public class TagsManager implements Closeable { */ public synchronized List getAllContentTags() throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getAllContentTags(); + return Case.getCurrentCase().getSleuthkitCase().getAllContentTags(); } /** @@ -302,7 +297,7 @@ public class TagsManager implements Closeable { */ public synchronized long getContentTagsCountByTagName(TagName tagName) throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getContentTagsCountByTagName(tagName); + return Case.getCurrentCase().getSleuthkitCase().getContentTagsCountByTagName(tagName); } /** @@ -317,7 +312,7 @@ public class TagsManager implements Closeable { */ public synchronized ContentTag getContentTagByTagID(long tagID) throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getContentTagByID(tagID); + return Case.getCurrentCase().getSleuthkitCase().getContentTagByID(tagID); } /** @@ -333,7 +328,7 @@ public class TagsManager implements Closeable { */ public synchronized List getContentTagsByTagName(TagName tagName) throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getContentTagsByTagName(tagName); + return Case.getCurrentCase().getSleuthkitCase().getContentTagsByTagName(tagName); } /** @@ -349,7 +344,7 @@ public class TagsManager implements Closeable { */ public synchronized List getContentTagsByContent(Content content) throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getContentTagsByContent(content); + return Case.getCurrentCase().getSleuthkitCase().getContentTagsByContent(content); } /** @@ -387,8 +382,8 @@ public class TagsManager implements Closeable { lazyLoadExistingTagNames(); if (null == comment) { throw new IllegalArgumentException("Passed null comment argument"); - } - tag = caseDb.addBlackboardArtifactTag(artifact, tagName, comment); + } + tag = Case.getCurrentCase().getSleuthkitCase().addBlackboardArtifactTag(artifact, tagName, comment); } try { @@ -410,7 +405,7 @@ public class TagsManager implements Closeable { public void deleteBlackboardArtifactTag(BlackboardArtifactTag tag) throws TskCoreException { synchronized (this) { lazyLoadExistingTagNames(); - caseDb.deleteBlackboardArtifactTag(tag); + Case.getCurrentCase().getSleuthkitCase().deleteBlackboardArtifactTag(tag); } try { @@ -430,7 +425,7 @@ public class TagsManager implements Closeable { */ public synchronized List getAllBlackboardArtifactTags() throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getAllBlackboardArtifactTags(); + return Case.getCurrentCase().getSleuthkitCase().getAllBlackboardArtifactTags(); } /** @@ -446,7 +441,7 @@ public class TagsManager implements Closeable { */ public synchronized long getBlackboardArtifactTagsCountByTagName(TagName tagName) throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getBlackboardArtifactTagsCountByTagName(tagName); + return Case.getCurrentCase().getSleuthkitCase().getBlackboardArtifactTagsCountByTagName(tagName); } /** @@ -461,7 +456,7 @@ public class TagsManager implements Closeable { */ public synchronized BlackboardArtifactTag getBlackboardArtifactTagByTagID(long tagID) throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getBlackboardArtifactTagByID(tagID); + return Case.getCurrentCase().getSleuthkitCase().getBlackboardArtifactTagByID(tagID); } /** @@ -477,7 +472,7 @@ public class TagsManager implements Closeable { */ public synchronized List getBlackboardArtifactTagsByTagName(TagName tagName) throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getBlackboardArtifactTagsByTagName(tagName); + return Case.getCurrentCase().getSleuthkitCase().getBlackboardArtifactTagsByTagName(tagName); } /** @@ -493,13 +488,18 @@ public class TagsManager implements Closeable { */ public synchronized List getBlackboardArtifactTagsByArtifact(BlackboardArtifact artifact) throws TskCoreException { lazyLoadExistingTagNames(); - return caseDb.getBlackboardArtifactTagsByArtifact(artifact); + return Case.getCurrentCase().getSleuthkitCase().getBlackboardArtifactTagsByArtifact(artifact); } /** - * Saves the avaialble tag names to secondary storage. + * Closes the tags manager, saving the avaialble tag names to secondary + * storage. + * + * @throws IOException If there is a problem closing the tags manager. + * @deprecated Tags manager clients should not close the tags manager. */ @Override + @Deprecated public synchronized void close() throws IOException { saveTagNamesToTagsSettings(); } @@ -524,7 +524,7 @@ public class TagsManager implements Closeable { */ private void addTagNamesFromCurrentCase() { try { - List currentTagNames = caseDb.getAllTagNames(); + List currentTagNames = Case.getCurrentCase().getSleuthkitCase().getAllTagNames(); for (TagName tagName : currentTagNames) { uniqueTagNames.put(tagName.getDisplayName(), tagName); } @@ -550,7 +550,7 @@ public class TagsManager implements Closeable { String[] tagNameAttributes = tagNameTuple.split(","); if (!uniqueTagNames.containsKey(tagNameAttributes[0])) { try { - TagName tagName = caseDb.addTagName(tagNameAttributes[0], tagNameAttributes[1], TagName.HTML_COLOR.getColorByName(tagNameAttributes[2])); + TagName tagName = Case.getCurrentCase().getSleuthkitCase().addTagName(tagNameAttributes[0], tagNameAttributes[1], TagName.HTML_COLOR.getColorByName(tagNameAttributes[2])); uniqueTagNames.put(tagName.getDisplayName(), tagName); } catch (TskCoreException ex) { Logger.getLogger(TagsManager.class.getName()).log(Level.SEVERE, "Failed to add saved tag name " + tagNameAttributes[0], ex); //NON-NLS @@ -566,7 +566,7 @@ public class TagsManager implements Closeable { private void addPredefinedTagNames() { if (!uniqueTagNames.containsKey(NbBundle.getMessage(this.getClass(), "TagsManager.predefTagNames.bookmark.text"))) { try { - TagName tagName = caseDb.addTagName( + TagName tagName = Case.getCurrentCase().getSleuthkitCase().addTagName( NbBundle.getMessage(this.getClass(), "TagsManager.predefTagNames.bookmark.text"), "", TagName.HTML_COLOR.NONE); uniqueTagNames.put(tagName.getDisplayName(), tagName); } catch (TskCoreException ex) { diff --git a/Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java b/Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java index 69b7c57f4f..af43facec9 100644 --- a/Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java +++ b/Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java @@ -1,7 +1,7 @@ /* * Autopsy Forensic Browser * - * Copyright 2014 Basis Technology Corp. + * Copyright 2011-2016 Basis Technology Corp. * Contact: carrier sleuthkit org * * Licensed under the Apache License, Version 2.0 (the "License"); @@ -23,7 +23,9 @@ import org.sleuthkit.datamodel.BlackboardArtifact; import org.sleuthkit.datamodel.TskCoreException; /** - * + * An implementation of a keyword search service. + * + * TODO (AUT-2158: This interface should not extend Closeable. */ public interface KeywordSearchService extends Closeable { @@ -49,4 +51,4 @@ public interface KeywordSearchService extends Closeable { */ public void tryConnect(String host, int port) throws KeywordSearchServiceException; - } +} From 1e50ff8c982d7af361cdd43e3c45235001d2b46d Mon Sep 17 00:00:00 2001 From: Richard Cordovano Date: Fri, 27 May 2016 13:01:29 -0400 Subject: [PATCH 10/10] Correct documentation for Blackboard class --- .../org/sleuthkit/autopsy/casemodule/services/Blackboard.java | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java b/Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java index 1f2f4b252b..0b8b9aa8e1 100644 --- a/Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java +++ b/Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java @@ -112,7 +112,7 @@ public final class Blackboard implements Closeable { * Closes the blackboard. * * @throws IOException If there is a problem closing the blackboard. - * @deprecated File manager clients should not close the blackboard. + * @deprecated blackboard clients should not close the blackboard. */ @Override @Deprecated