mstoeck3/autopsy-flatpak
1
0
Fork 0
mirror of https://github.com/overcuriousity/autopsy-flatpak.git synced 2025-07-17 18:17:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #2190 from sleuthkit/new-file-mamager-api-1737

Browse Source 
New file manager API prep
This commit is contained in:
Richard Cordovano 2016-05-27 13:05:03 -04:00
commit c2633c43e0
8 changed files with 377 additions and 435 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Core/src/org/sleuthkit/autopsy/casemodule/Case.java
View File

@ -282,6 +282,7 @@ public class Case implements SleuthkitCase.ErrorObserver {
/** /**
* Constructor for the Case class * Constructor for the Case class
*/ */
@SuppressWarnings("deprecation")
private Case(CaseMetadata caseMetadata, SleuthkitCase db) { private Case(CaseMetadata caseMetadata, SleuthkitCase db) {
this.caseMetadata = caseMetadata; this.caseMetadata = caseMetadata;
this.db = db; 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. * Closes this case. This methods close the xml and clear all the fields.
*/ */
@SuppressWarnings("deprecation")
public void closeCase() throws CaseActionException { public void closeCase() throws CaseActionException {
changeCase(null); changeCase(null);
try { try {

7
Core/src/org/sleuthkit/autopsy/casemodule/services/Blackboard.java
View File

@ -109,10 +109,13 @@ public final class Blackboard implements Closeable {
} }
/** /**
* Cloese this blackboard and releases any resources associated with it. * Closes the blackboard.
* @throws IOException *
* @throws IOException If there is a problem closing the blackboard.
* @deprecated blackboard clients should not close the blackboard.
*/ */
@Override @Override
@Deprecated
public void close() throws IOException { public void close() throws IOException {
} }

13
Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle.properties
View File

@ -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.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.endByteOffsetOOR.msg=endByteOffset \= {0} out of content size range (0 - {1})
TagsManager.addContentTag.exception.endLTbegin.msg=endByteOffset < beginByteOffset TagsManager.addContentTag.exception.endLTbegin.msg=endByteOffset < beginByteOffset

13
Core/src/org/sleuthkit/autopsy/casemodule/services/Bundle_ja.properties
View File

@ -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.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.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 TagsManager.addContentTag.exception.endLTbegin.msg=endByteOffset < beginByteOffset

648
Core/src/org/sleuthkit/autopsy/casemodule/services/FileManager.java
View File

@ -1,19 +1,19 @@
/* /*
* *
* Autopsy Forensic Browser * Autopsy Forensic Browser
* *
* Copyright 2011-2016 Basis Technology Corp. * Copyright 2011-2016 Basis Technology Corp.
* *
* Copyright 2012 42six Solutions. * Copyright 2012 42six Solutions.
* Contact: aebadirad <at> 42six <dot> com * Contact: aebadirad <at> 42six <dot> com
* Project Contact/Architect: carrier <at> sleuthkit <dot> org * Project Contact/Architect: carrier <at> sleuthkit <dot> org
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* http://www.apache.org/licenses/LICENSE-2.0 * http://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -26,9 +26,8 @@ import java.io.Closeable;
import java.io.IOException; import java.io.IOException;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.logging.Level;
import org.openide.util.NbBundle; import org.openide.util.NbBundle;
import org.sleuthkit.autopsy.coreutils.Logger; import org.sleuthkit.autopsy.casemodule.Case;
import org.sleuthkit.autopsy.datamodel.VirtualDirectoryNode; import org.sleuthkit.autopsy.datamodel.VirtualDirectoryNode;
import org.sleuthkit.autopsy.ingest.IngestServices; import org.sleuthkit.autopsy.ingest.IngestServices;
import org.sleuthkit.autopsy.ingest.ModuleContentEvent; import org.sleuthkit.autopsy.ingest.ModuleContentEvent;
@ -36,7 +35,6 @@ import org.sleuthkit.datamodel.AbstractFile;
import org.sleuthkit.datamodel.Content; import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.DerivedFile; import org.sleuthkit.datamodel.DerivedFile;
import org.sleuthkit.datamodel.LayoutFile; import org.sleuthkit.datamodel.LayoutFile;
import org.sleuthkit.datamodel.LocalFile;
import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction; import org.sleuthkit.datamodel.SleuthkitCase.CaseDbTransaction;
import org.sleuthkit.datamodel.TskCoreException; import org.sleuthkit.datamodel.TskCoreException;
@ -47,56 +45,36 @@ import org.sleuthkit.datamodel.LocalFilesDataSource;
import org.sleuthkit.datamodel.TskDataException; import org.sleuthkit.datamodel.TskDataException;
/** /**
* Abstraction to facilitate access to localFiles and directories. * 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 { public class FileManager implements Closeable {
private SleuthkitCase tskCase; /**
private static final Logger logger = Logger.getLogger(FileManager.class.getName()); * Constructs a manager that provides methods for retrieving files from the
private volatile int curNumFileSets; //current number of filesets (root virt dir objects) * current case and for adding local files, carved files, and derived files
* to the current case.
public FileManager(SleuthkitCase tskCase) { *
this.tskCase = tskCase; */
init(); FileManager() {
} }
/** /**
* initialize the file manager for the 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
private synchronized void init() { * insensitive SQL LIKE clause is used to query the case database).
//get the number of local file sets in db
List<VirtualDirectory> virtRoots;
curNumFileSets = 0;
try {
virtRoots = tskCase.getVirtualDirectoryRoots();
for (VirtualDirectory vd : virtRoots) {
if (vd.getName().startsWith(VirtualDirectoryNode.LOGICAL_FILE_SET_PREFIX)) {
++curNumFileSets;
}
}
} catch (TskCoreException ex) {
logger.log(Level.SEVERE, "Error initializing FileManager and getting number of local file sets"); //NON-NLS
}
}
/**
* Finds a set of localFiles that meets the name criteria in all data
* sources in the current case.
* *
* @param fileName Pattern of the name of the file or directory to match * @param fileName The full or partial file name.
* (case insensitive, used in LIKE SQL statement).
* *
* @return a list of AbstractFile for localFiles/directories whose name * @return The matching files and directories.
* matches the given fileName *
* @throws TskCoreException if there is a problem querying the case
* database.
*/ */
public synchronized List<AbstractFile> findFiles(String fileName) throws TskCoreException { public List<AbstractFile> findFiles(String fileName) throws TskCoreException {
List<AbstractFile> result = new ArrayList<>(); List<AbstractFile> result = new ArrayList<>();
List<Content> dataSources = Case.getCurrentCase().getSleuthkitCase().getRootObjects();
if (tskCase == null) {
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles.exception.msg"));
}
List<Content> dataSources = tskCase.getRootObjects();
for (Content dataSource : dataSources) { for (Content dataSource : dataSources) {
result.addAll(findFiles(dataSource, fileName)); result.addAll(findFiles(dataSource, fileName));
} }
@ -104,113 +82,107 @@ public class FileManager implements Closeable {
} }
/** /**
* Finds a set of localFiles that meets the name criteria in all data * Finds all files and directories with a given file name and parent file or
* sources in the current case. * 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 * @param fileName The full or partial file name.
* (case insensitive, used in LIKE SQL statement). * @param parentName The full or partial parent file or directory name.
* @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).
* *
* @return a list of AbstractFile for localFiles/directories whose name * @return The matching files and directories.
* matches fileName and whose parent directory contains dirName. *
* @throws TskCoreException if there is a problem querying the case
* database.
*/ */
public synchronized List<AbstractFile> findFiles(String fileName, String dirName) throws TskCoreException { public List<AbstractFile> findFiles(String fileName, String parentName) throws TskCoreException {
List<AbstractFile> result = new ArrayList<>(); List<AbstractFile> result = new ArrayList<>();
List<Content> dataSources = Case.getCurrentCase().getSleuthkitCase().getRootObjects();
if (tskCase == null) {
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles2.exception.msg"));
}
List<Content> dataSources = tskCase.getRootObjects();
for (Content dataSource : dataSources) { for (Content dataSource : dataSources) {
result.addAll(findFiles(dataSource, fileName, dirName)); result.addAll(findFiles(dataSource, fileName, parentName));
} }
return result; return result;
} }
/** /**
* Finds a set of localFiles that meets the name criteria in all data * Finds all files and directories with a given file name and parent file or
* sources in the current case. * 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 * @param fileName The full or partial file name.
* (case insensitive, used in LIKE SQL statement). * @param parent The parent file or directory.
* @param parentFile Object of root/parent directory to restrict search to.
* *
* @return a list of AbstractFile for localFiles/directories whose name * @return The matching files and directories.
* matches fileName and that were inside a directory described by *
* parentFsContent. * @throws TskCoreException if there is a problem querying the case
* database.
*/ */
public synchronized List<AbstractFile> findFiles(String fileName, AbstractFile parentFile) throws TskCoreException { public List<AbstractFile> findFiles(String fileName, AbstractFile parent) throws TskCoreException {
List<AbstractFile> result = new ArrayList<>(); List<AbstractFile> result = new ArrayList<>();
List<Content> dataSources = Case.getCurrentCase().getSleuthkitCase().getRootObjects();
if (tskCase == null) {
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles3.exception.msg"));
}
List<Content> dataSources = tskCase.getRootObjects();
for (Content dataSource : dataSources) { for (Content dataSource : dataSources) {
result.addAll(findFiles(dataSource, fileName, parentFile)); result.addAll(findFiles(dataSource, fileName, parent));
} }
return result; 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, * @param dataSource The data source.
* VirtualDirectory, etc.). * @param fileName The full or partial file name.
* @param fileName Pattern of the name of the file or directory to match
* (case insensitive, used in LIKE SQL statement).
* *
* @return a list of AbstractFile for localFiles/directories whose name * @return The matching files and directories.
* matches the given fileName *
* @throws TskCoreException if there is a problem querying the case
* database.
*/ */
public synchronized List<AbstractFile> findFiles(Content dataSource, String fileName) throws TskCoreException { public List<AbstractFile> findFiles(Content dataSource, String fileName) throws TskCoreException {
if (tskCase == null) { return Case.getCurrentCase().getSleuthkitCase().findFiles(dataSource, fileName);
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles.exception.msg"));
}
return tskCase.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, * @param dataSource The data source.
* VirtualDirectory, etc.). * @param fileName The full or partial file name.
* @param fileName Pattern of the name of the file or directory to match * @param parentName The full or partial parent file or directory name.
* (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).
* *
* @return a list of AbstractFile for localFiles/directories whose name * @return The matching files and directories.
* matches fileName and whose parent directory contains dirName. *
* @throws TskCoreException if there is a problem querying the case
* database.
*/ */
public synchronized List<AbstractFile> findFiles(Content dataSource, String fileName, String dirName) throws TskCoreException { public List<AbstractFile> findFiles(Content dataSource, String fileName, String parentName) throws TskCoreException {
if (tskCase == null) { return Case.getCurrentCase().getSleuthkitCase().findFiles(dataSource, fileName, parentName);
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles2.exception.msg"));
}
return tskCase.findFiles(dataSource, fileName, dirName);
} }
/** /**
* 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, * @param dataSource The data source.
* VirtualDirectory, etc.). * @param fileName The full or partial file name.
* @param fileName Pattern of the name of the file or directory to match * @param parent The parent file or directory.
* (case insensitive, used in LIKE SQL statement).
* @param parentFile Object of root/parent directory to restrict search to.
* *
* @return a list of AbstractFile for localFiles/directories whose name * @return The matching files and directories.
* matches fileName and that were inside a directory described by *
* parentFsContent. * @throws TskCoreException if there is a problem querying the case
* database.
*/ */
public synchronized List<AbstractFile> findFiles(Content dataSource, String fileName, AbstractFile parentFile) throws TskCoreException { public List<AbstractFile> findFiles(Content dataSource, String fileName, AbstractFile parent) throws TskCoreException {
if (tskCase == null) { return findFiles(dataSource, fileName, parent.getName());
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.findFiles3.exception.msg"));
}
return findFiles(dataSource, fileName, parentFile.getName());
} }
/** /**
@ -221,173 +193,116 @@ public class FileManager implements Closeable {
* *
* @return a list of AbstractFile that have the given file path. * @return a list of AbstractFile that have the given file path.
*/ */
public synchronized List<AbstractFile> openFiles(Content dataSource, String filePath) throws TskCoreException { /**
if (tskCase == null) { * Finds all files and directories with a given file name and path in a
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.openFiles.exception.msg")); * given data source (image, local/logical files set, etc.). The name search
} * is for full or partial matches and is case insensitive (a case
return tskCase.openFiles(dataSource, filePath); * 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 List<AbstractFile> openFiles(Content dataSource, String filePath) throws TskCoreException {
return Case.getCurrentCase().getSleuthkitCase().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 fileName The name of the file.
* @param localPath local path of the derived file, including the file * @param localPath The local path of the file, relative to the case
* name. The path is relative to the case folder. * folder and including the file name.
* @param size size of the derived file in bytes * @param size The size of the file in bytes.
* @param ctime * @param ctime The change time of the file.
* @param crtime * @param crtime The create time of the file
* @param atime * @param atime The accessed time of the file.
* @param mtime * @param mtime The modified time of the file.
* @param isFile whether a file or directory, true if a file * @param isFile True if a file, false if a directory.
* @param parentFile the parent file object this the new file was * @param parentFile The parent file from which the file was derived.
* derived from, either a fs file or parent derived * @param rederiveDetails The details needed to re-derive file (will be
* file/dikr\\r * specific to the derivation method), currently
* @param rederiveDetails details needed to re-derive file (will be specific * unused.
* to the derivation method), currently unused * @param toolName The name of the derivation method or tool,
* @param toolName name of derivation method/tool, currently unused * currently unused.
* @param toolVersion version of derivation method/tool, currently * @param toolVersion The version of the derivation method or tool,
* unused * currently unused.
* @param otherDetails details of derivation method/tool, currently * @param otherDetails Other details of the derivation method or tool,
* unused * currently unused.
* *
* @return newly created derived file object added to the database * @return A DerivedFile object representing the derived file.
*
* @throws TskCoreException exception thrown if the object creation failed
* due to a critical system error or of the file
* manager has already been closed
* *
* @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 DerivedFile addDerivedFile(String fileName,
String localPath,
long size,
long ctime, long crtime, long atime, long mtime, 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 { String rederiveDetails, String toolName, String toolVersion, String otherDetails) throws TskCoreException {
if (tskCase == null) { return Case.getCurrentCase().getSleuthkitCase().addDerivedFile(fileName, localPath, size,
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.addDerivedFile.exception.msg"));
}
return tskCase.addDerivedFile(fileName, localPath, size,
ctime, crtime, atime, mtime, ctime, crtime, atime, mtime,
isFile, parentFile, rederiveDetails, toolName, toolVersion, otherDetails); isFile, parentFile, rederiveDetails, toolName, toolVersion, otherDetails);
} }
/** /**
* Adds a carved file to the VirtualDirectory '$CarvedFiles' in the volume * Adds a carved file to the '$CarvedFiles' virtual directory of a data
* or image given by systemId. * source, volume or file system.
* *
* @param carvedFileName the name of the carved file (containing appropriate * @param fileName The name of the file.
* extension) * @param fileSize The size of the file.
* @param carvedFileSize size of the carved file to add * @param parentObjId The object id of the parent data source, volume or
* @param systemId the ID of the parent volume or file system * file system.
* @param sectors a list of SectorGroups giving this sectors that * @param layout A list of the offsets and sizes that gives the layout
* make up this carved file. * of the file within its parent.
* *
* @throws TskCoreException exception thrown when critical tsk error * @return A LayoutFile object representing the carved file.
* occurred and carved file could not be added *
* @throws TskCoreException if there is a problem adding the file to the
* case database.
*/ */
public synchronized LayoutFile addCarvedFile(String carvedFileName, long carvedFileSize, public synchronized LayoutFile addCarvedFile(String fileName, long fileSize, long parentObjId, List<TskFileRange> layout) throws TskCoreException {
long systemId, List<TskFileRange> sectors) throws TskCoreException { return Case.getCurrentCase().getSleuthkitCase().addCarvedFile(fileName, fileSize, parentObjId, layout);
if (tskCase == null) {
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.addCarvedFile.exception.msg"));
}
return tskCase.addCarvedFile(carvedFileName, carvedFileSize, systemId, sectors);
} }
/** /**
* Adds a collection of carved localFiles to the VirtualDirectory * Adds a collection of carved files to the '$CarvedFiles' virtual directory
* '$CarvedFiles' in the volume or image given by systemId. Creates * of a data source, volume or file system.
* $CarvedFiles if it does not exist already.
* *
* @param filesToAdd a list of CarvedFileContainer localFiles to add as * @param A collection of CarvedFileContainer objects, one per carved file,
* carved localFiles * all of which must have the same parent object id.
* *
* @return List<LayoutFile> This is a list of the localFiles added to the * @return A collection of LayoutFile object representing the carved files.
* database
* *
* @throws org.sleuthkit.datamodel.TskCoreException * @throws TskCoreException if there is a problem adding the files to the
* case database.
*/ */
public List<LayoutFile> addCarvedFiles(List<CarvedFileContainer> filesToAdd) throws TskCoreException { public List<LayoutFile> addCarvedFiles(List<CarvedFileContainer> filesToAdd) throws TskCoreException {
if (tskCase == null) { return Case.getCurrentCase().getSleuthkitCase().addCarvedFiles(filesToAdd);
throw new TskCoreException(NbBundle.getMessage(this.getClass(), "FileManager.addCarvedFile.exception.msg"));
} else {
return tskCase.addCarvedFiles(filesToAdd);
}
} }
/** /**
* * Interface for receiving a notification for each file or directory added
* Interface for receiving notifications on folders being added via a * to the case database by a FileManager add files operation.
* callback
*/ */
public interface FileAddProgressUpdater { 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); 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<String> localAbsPaths, FileAddProgressUpdater addProgressUpdater) throws TskCoreException {
List<java.io.File> 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;
} }
/** /**
@ -423,16 +338,21 @@ public class FileManager implements Closeable {
CaseDbTransaction trans = null; CaseDbTransaction trans = null;
try { try {
String rootDirectoryName = rootVirtualDirectoryName; String rootDirectoryName = rootVirtualDirectoryName;
int newLocalFilesSetCount = curNumFileSets + 1; if (rootDirectoryName.isEmpty()) {
if (rootVirtualDirectoryName.isEmpty()) { rootDirectoryName = generateFilesDataSourceName();
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
* 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(); VirtualDirectory rootDirectory = dataSource.getRootDirectory();
List<AbstractFile> filesAdded = new ArrayList<>(); List<AbstractFile> filesAdded = new ArrayList<>();
for (java.io.File localFile : localFiles) { for (java.io.File localFile : localFiles) {
AbstractFile fileAdded = addLocalDirInt(trans, rootDirectory, localFile, progressUpdater); AbstractFile fileAdded = addLocalFile(trans, rootDirectory, localFile, progressUpdater);
if (null != fileAdded) { if (null != fileAdded) {
filesAdded.add(fileAdded); filesAdded.add(fileAdded);
} else { } else {
@ -440,13 +360,16 @@ public class FileManager implements Closeable {
} }
} }
trans.commit(); trans.commit();
if (rootVirtualDirectoryName.isEmpty()) {
curNumFileSets = newLocalFilesSetCount; /*
} * Publish content added events for the added files and directories.
*/
for (AbstractFile fileAdded : filesAdded) { for (AbstractFile fileAdded : filesAdded) {
IngestServices.getInstance().fireModuleContentEvent(new ModuleContentEvent(fileAdded)); IngestServices.getInstance().fireModuleContentEvent(new ModuleContentEvent(fileAdded));
} }
return dataSource; return dataSource;
} catch (TskCoreException ex) { } catch (TskCoreException ex) {
if (null != trans) { if (null != trans) {
trans.rollback(); trans.rollback();
@ -455,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<VirtualDirectory> 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 * Converts a list of local/logical file and/or directory paths to a list of
* file objects. * file objects.
@ -472,7 +423,7 @@ public class FileManager implements Closeable {
for (String path : localFilePaths) { for (String path : localFilePaths) {
java.io.File localFile = new java.io.File(path); java.io.File localFile = new java.io.File(path);
if (!localFile.exists() || !localFile.canRead()) { 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); localFiles.add(localFile);
} }
@ -480,130 +431,101 @@ public class FileManager implements Closeable {
} }
/** /**
* Adds a new virtual directory root object with FileSet X name and * Adds a file or directory of logical/local files data source to the case
* consecutive sequence number characteristic to every add operation * database, recursively adding the contents of directories.
*
* @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.
* *
* @param trans A case database transaction. * @param trans A case database transaction.
* @param parentVd Dir that is the parent of localFile * @param parentDirectory The root virtual direcotry of the data source.
* @param localFile File/Dir that we are adding * @param localFile The local/logical file or directory.
* @param addProgressUpdater notifier to receive progress notifications on * @param addProgressUpdater notifier to receive progress notifications on
* folders added, or null if not used * folders added, or null if not used
* *
* @returns File object of file added or new virtualdirectory for the * @returns File object of file added or new virtualdirectory for the
* directory. * 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, private AbstractFile addLocalFile(CaseDbTransaction trans, VirtualDirectory parentDirectory, java.io.File localFile, FileAddProgressUpdater progressUpdater) throws TskCoreException {
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()));
}
if (localFile.isDirectory()) { 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); * Add the directory as a virtual directory.
if (childVd != null && addProgressUpdater != null) { */
addProgressUpdater.fileAdded(childVd); VirtualDirectory virtualDirectory = Case.getCurrentCase().getSleuthkitCase().addVirtualDirectory(parentDirectory.getId(), localFile.getName(), trans);
} progressUpdater.fileAdded(virtualDirectory);
//add children recursively
final java.io.File[] childrenFiles = localFile.listFiles(); /*
if (childrenFiles != null) { * Add its children, if any.
for (java.io.File childFile : childrenFiles) { */
addLocalDirInt(trans, childVd, childFile, addProgressUpdater); 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 { } else {
//add leaf file, base case return Case.getCurrentCase().getSleuthkitCase().addLocalFile(localFile.getName(), localFile.getAbsolutePath(), localFile.length(),
return this.addLocalFileInt(parentVd, localFile, trans); 0, 0, 0, 0,
localFile.isFile(), parentDirectory, trans);
} }
} }
/** /**
* Adds a single local/logical file to the case. Adds it to the database. * Adds a set of local/logical files and/or directories to the case database
* Does not refresh the views of data. Assumes that the local file exists * as data source.
* and can be read. This checking is done by addLocalDirInt().
* *
* @param parentFile parent file object container (such as virtual * @param localFilePaths A list of local/logical file and/or directory
* directory, another local file, or fscontent File), * localFilePaths.
* @param localFile File that we are adding * @param progressUpdater Called after each file/directory is added to the
* @param trans A case database transaction. * case database.
* *
* @return newly created local file object added to the database * @return The root virtual directory for the local/logical files data
* source.
* *
* @throws TskCoreException exception thrown if the object creation failed * @throws TskCoreException If any of the local file paths is for a file or
* due to a critical system error or of the file * directory that does not exist or cannot be read,
* manager has already been closed * or there is a problem completing a database
* operation.
* @deprecated Use addLocalFilesDataSource instead.
*/ */
private synchronized LocalFile addLocalFileInt(AbstractFile parentFile, java.io.File localFile, CaseDbTransaction trans) throws TskCoreException { @Deprecated
public VirtualDirectory addLocalFilesDirs(List<String> localFilePaths, FileAddProgressUpdater progressUpdater) throws TskCoreException {
if (tskCase == null) { try {
throw new TskCoreException( return addLocalFilesDataSource("", "", "", localFilePaths, progressUpdater).getRootDirectory();
NbBundle.getMessage(this.getClass(), "FileManager.addLocalDirInt2.exception.closed.msg")); } catch (TskDataException ex) {
throw new TskCoreException(ex.getLocalizedMessage(), ex);
} }
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;
} }
/**
* 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 @Override
public synchronized void close() throws IOException { @Deprecated
tskCase = null; public void close() throws IOException {
} }
} }

65
Core/src/org/sleuthkit/autopsy/casemodule/services/Services.java
View File

@ -1,19 +1,18 @@
/* /*
* *
* Autopsy Forensic Browser * Autopsy Forensic Browser
* *
* Copyright 2012-2015 Basis Technology Corp. * Copyright 2011-2016 Basis Technology Corp.
* * Contact: carrier <at> sleuthkit <dot> org
* Copyright 2012 42six Solutions. * Copyright 2012 42six Solutions.
* Contact: aebadirad <at> 42six <dot> com * Contact: aebadirad <at> 42six <dot> com
* Project Contact/Architect: carrier <at> sleuthkit <dot> org *
*
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
* You may obtain a copy of the License at * You may obtain a copy of the License at
* *
* http://www.apache.org/licenses/LICENSE-2.0 * http://www.apache.org/licenses/LICENSE-2.0
* *
* Unless required by applicable law or agreed to in writing, software * Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS, * distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
@ -31,7 +30,8 @@ import org.sleuthkit.autopsy.keywordsearchservice.KeywordSearchService;
import org.sleuthkit.datamodel.SleuthkitCase; import org.sleuthkit.datamodel.SleuthkitCase;
/** /**
* 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 { public class Services implements Closeable {
@ -41,37 +41,76 @@ public class Services implements Closeable {
private final KeywordSearchService keywordSearchService; private final KeywordSearchService keywordSearchService;
private final Blackboard blackboard; private final Blackboard blackboard;
public Services(SleuthkitCase tskCase) { /**
fileManager = new FileManager(tskCase); * 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); services.add(fileManager);
tagsManager = new TagsManager(tskCase); tagsManager = new TagsManager();
services.add(tagsManager); services.add(tagsManager);
keywordSearchService = Lookup.getDefault().lookup(KeywordSearchService.class); keywordSearchService = Lookup.getDefault().lookup(KeywordSearchService.class);
services.add(keywordSearchService); services.add(keywordSearchService);
blackboard = new Blackboard(); blackboard = new Blackboard();
services.add(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() { public FileManager getFileManager() {
return fileManager; return fileManager;
} }
/**
* Gets the tags manager service for the current case.
*
* @return The tags manager service for the current case.
*/
public TagsManager getTagsManager() { public TagsManager getTagsManager() {
return tagsManager; return tagsManager;
} }
/**
* Gets the keyword search service for the current case.
*
* @return The keyword search service for the current case.
*/
public KeywordSearchService getKeywordSearchService() { public KeywordSearchService getKeywordSearchService() {
return keywordSearchService; return keywordSearchService;
} }
/**
* Gets the blackboard service for the current case.
*
* @return The blackboard service for the current case.
*/
public Blackboard getBlackboard() { public Blackboard getBlackboard() {
return blackboard; 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 @Override
@Deprecated
public void close() throws IOException { public void close() throws IOException {
for (Closeable service : services) { for (Closeable service : services) {
service.close(); service.close();

56
Core/src/org/sleuthkit/autopsy/casemodule/services/TagsManager.java
View File

@ -32,7 +32,6 @@ import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.BlackboardArtifactTag; import org.sleuthkit.datamodel.BlackboardArtifactTag;
import org.sleuthkit.datamodel.Content; import org.sleuthkit.datamodel.Content;
import org.sleuthkit.datamodel.ContentTag; import org.sleuthkit.datamodel.ContentTag;
import org.sleuthkit.datamodel.SleuthkitCase;
import org.sleuthkit.datamodel.TagName; import org.sleuthkit.datamodel.TagName;
import org.sleuthkit.datamodel.TskCoreException; 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 Logger logger = Logger.getLogger(TagsManager.class.getName());
private static final String TAGS_SETTINGS_NAME = "Tags"; //NON-NLS private static final String TAGS_SETTINGS_NAME = "Tags"; //NON-NLS
private static final String TAG_NAMES_SETTING_KEY = "TagNames"; //NON-NLS private static final String TAG_NAMES_SETTING_KEY = "TagNames"; //NON-NLS
private final SleuthkitCase caseDb;
private final HashMap<String, TagName> uniqueTagNames = new HashMap<>(); private final HashMap<String, TagName> uniqueTagNames = new HashMap<>();
private boolean tagNamesLoaded = false; private boolean tagNamesLoaded = false;
@ -53,11 +51,8 @@ public class TagsManager implements Closeable {
* Constructs a per case Autopsy service that manages the creation, * Constructs a per case Autopsy service that manages the creation,
* updating, and deletion of tags applied to content and blackboard * updating, and deletion of tags applied to content and blackboard
* artifacts by users. * artifacts by users.
*
* @param caseDb The case database for the current case.
*/ */
TagsManager(SleuthkitCase caseDb) { TagsManager() {
this.caseDb = caseDb;
} }
/** /**
@ -71,7 +66,7 @@ public class TagsManager implements Closeable {
*/ */
public synchronized List<TagName> getAllTagNames() throws TskCoreException { public synchronized List<TagName> getAllTagNames() throws TskCoreException {
lazyLoadExistingTagNames(); lazyLoadExistingTagNames();
return caseDb.getAllTagNames(); return Case.getCurrentCase().getSleuthkitCase().getAllTagNames();
} }
/** /**
@ -85,7 +80,7 @@ public class TagsManager implements Closeable {
*/ */
public synchronized List<TagName> getTagNamesInUse() throws TskCoreException { public synchronized List<TagName> getTagNamesInUse() throws TskCoreException {
lazyLoadExistingTagNames(); 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. * 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. * 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 { try {
@ -267,7 +262,7 @@ public class TagsManager implements Closeable {
public void deleteContentTag(ContentTag tag) throws TskCoreException { public void deleteContentTag(ContentTag tag) throws TskCoreException {
synchronized (this) { synchronized (this) {
lazyLoadExistingTagNames(); lazyLoadExistingTagNames();
caseDb.deleteContentTag(tag); Case.getCurrentCase().getSleuthkitCase().deleteContentTag(tag);
} }
try { try {
@ -287,7 +282,7 @@ public class TagsManager implements Closeable {
*/ */
public synchronized List<ContentTag> getAllContentTags() throws TskCoreException { public synchronized List<ContentTag> getAllContentTags() throws TskCoreException {
lazyLoadExistingTagNames(); 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 { public synchronized long getContentTagsCountByTagName(TagName tagName) throws TskCoreException {
lazyLoadExistingTagNames(); 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 { public synchronized ContentTag getContentTagByTagID(long tagID) throws TskCoreException {
lazyLoadExistingTagNames(); lazyLoadExistingTagNames();
return caseDb.getContentTagByID(tagID); return Case.getCurrentCase().getSleuthkitCase().getContentTagByID(tagID);
} }
/** /**
@ -333,7 +328,7 @@ public class TagsManager implements Closeable {
*/ */
public synchronized List<ContentTag> getContentTagsByTagName(TagName tagName) throws TskCoreException { public synchronized List<ContentTag> getContentTagsByTagName(TagName tagName) throws TskCoreException {
lazyLoadExistingTagNames(); lazyLoadExistingTagNames();
return caseDb.getContentTagsByTagName(tagName); return Case.getCurrentCase().getSleuthkitCase().getContentTagsByTagName(tagName);
} }
/** /**
@ -349,7 +344,7 @@ public class TagsManager implements Closeable {
*/ */
public synchronized List<ContentTag> getContentTagsByContent(Content content) throws TskCoreException { public synchronized List<ContentTag> getContentTagsByContent(Content content) throws TskCoreException {
lazyLoadExistingTagNames(); lazyLoadExistingTagNames();
return caseDb.getContentTagsByContent(content); return Case.getCurrentCase().getSleuthkitCase().getContentTagsByContent(content);
} }
/** /**
@ -387,8 +382,8 @@ public class TagsManager implements Closeable {
lazyLoadExistingTagNames(); lazyLoadExistingTagNames();
if (null == comment) { if (null == comment) {
throw new IllegalArgumentException("Passed null comment argument"); throw new IllegalArgumentException("Passed null comment argument");
} }
tag = caseDb.addBlackboardArtifactTag(artifact, tagName, comment); tag = Case.getCurrentCase().getSleuthkitCase().addBlackboardArtifactTag(artifact, tagName, comment);
} }
try { try {
@ -410,7 +405,7 @@ public class TagsManager implements Closeable {
public void deleteBlackboardArtifactTag(BlackboardArtifactTag tag) throws TskCoreException { public void deleteBlackboardArtifactTag(BlackboardArtifactTag tag) throws TskCoreException {
synchronized (this) { synchronized (this) {
lazyLoadExistingTagNames(); lazyLoadExistingTagNames();
caseDb.deleteBlackboardArtifactTag(tag); Case.getCurrentCase().getSleuthkitCase().deleteBlackboardArtifactTag(tag);
} }
try { try {
@ -430,7 +425,7 @@ public class TagsManager implements Closeable {
*/ */
public synchronized List<BlackboardArtifactTag> getAllBlackboardArtifactTags() throws TskCoreException { public synchronized List<BlackboardArtifactTag> getAllBlackboardArtifactTags() throws TskCoreException {
lazyLoadExistingTagNames(); 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 { public synchronized long getBlackboardArtifactTagsCountByTagName(TagName tagName) throws TskCoreException {
lazyLoadExistingTagNames(); 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 { public synchronized BlackboardArtifactTag getBlackboardArtifactTagByTagID(long tagID) throws TskCoreException {
lazyLoadExistingTagNames(); lazyLoadExistingTagNames();
return caseDb.getBlackboardArtifactTagByID(tagID); return Case.getCurrentCase().getSleuthkitCase().getBlackboardArtifactTagByID(tagID);
} }
/** /**
@ -477,7 +472,7 @@ public class TagsManager implements Closeable {
*/ */
public synchronized List<BlackboardArtifactTag> getBlackboardArtifactTagsByTagName(TagName tagName) throws TskCoreException { public synchronized List<BlackboardArtifactTag> getBlackboardArtifactTagsByTagName(TagName tagName) throws TskCoreException {
lazyLoadExistingTagNames(); lazyLoadExistingTagNames();
return caseDb.getBlackboardArtifactTagsByTagName(tagName); return Case.getCurrentCase().getSleuthkitCase().getBlackboardArtifactTagsByTagName(tagName);
} }
/** /**
@ -493,13 +488,18 @@ public class TagsManager implements Closeable {
*/ */
public synchronized List<BlackboardArtifactTag> getBlackboardArtifactTagsByArtifact(BlackboardArtifact artifact) throws TskCoreException { public synchronized List<BlackboardArtifactTag> getBlackboardArtifactTagsByArtifact(BlackboardArtifact artifact) throws TskCoreException {
lazyLoadExistingTagNames(); 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 @Override
@Deprecated
public synchronized void close() throws IOException { public synchronized void close() throws IOException {
saveTagNamesToTagsSettings(); saveTagNamesToTagsSettings();
} }
@ -524,7 +524,7 @@ public class TagsManager implements Closeable {
*/ */
private void addTagNamesFromCurrentCase() { private void addTagNamesFromCurrentCase() {
try { try {
List<TagName> currentTagNames = caseDb.getAllTagNames(); List<TagName> currentTagNames = Case.getCurrentCase().getSleuthkitCase().getAllTagNames();
for (TagName tagName : currentTagNames) { for (TagName tagName : currentTagNames) {
uniqueTagNames.put(tagName.getDisplayName(), tagName); uniqueTagNames.put(tagName.getDisplayName(), tagName);
} }
@ -550,7 +550,7 @@ public class TagsManager implements Closeable {
String[] tagNameAttributes = tagNameTuple.split(","); String[] tagNameAttributes = tagNameTuple.split(",");
if (!uniqueTagNames.containsKey(tagNameAttributes[0])) { if (!uniqueTagNames.containsKey(tagNameAttributes[0])) {
try { 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); uniqueTagNames.put(tagName.getDisplayName(), tagName);
} catch (TskCoreException ex) { } catch (TskCoreException ex) {
Logger.getLogger(TagsManager.class.getName()).log(Level.SEVERE, "Failed to add saved tag name " + tagNameAttributes[0], ex); //NON-NLS 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() { private void addPredefinedTagNames() {
if (!uniqueTagNames.containsKey(NbBundle.getMessage(this.getClass(), "TagsManager.predefTagNames.bookmark.text"))) { if (!uniqueTagNames.containsKey(NbBundle.getMessage(this.getClass(), "TagsManager.predefTagNames.bookmark.text"))) {
try { try {
TagName tagName = caseDb.addTagName( TagName tagName = Case.getCurrentCase().getSleuthkitCase().addTagName(
NbBundle.getMessage(this.getClass(), "TagsManager.predefTagNames.bookmark.text"), "", TagName.HTML_COLOR.NONE); NbBundle.getMessage(this.getClass(), "TagsManager.predefTagNames.bookmark.text"), "", TagName.HTML_COLOR.NONE);
uniqueTagNames.put(tagName.getDisplayName(), tagName); uniqueTagNames.put(tagName.getDisplayName(), tagName);
} catch (TskCoreException ex) { } catch (TskCoreException ex) {

8
Core/src/org/sleuthkit/autopsy/keywordsearchservice/KeywordSearchService.java
View File

@ -1,7 +1,7 @@
/* /*
* Autopsy Forensic Browser * Autopsy Forensic Browser
* *
* Copyright 2014 Basis Technology Corp. * Copyright 2011-2016 Basis Technology Corp.
* Contact: carrier <at> sleuthkit <dot> org * Contact: carrier <at> sleuthkit <dot> org
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
@ -23,7 +23,9 @@ import org.sleuthkit.datamodel.BlackboardArtifact;
import org.sleuthkit.datamodel.TskCoreException; 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 { public interface KeywordSearchService extends Closeable {
@ -49,4 +51,4 @@ public interface KeywordSearchService extends Closeable {
*/ */
public void tryConnect(String host, int port) throws KeywordSearchServiceException; public void tryConnect(String host, int port) throws KeywordSearchServiceException;
} }