19 package org.sleuthkit.autopsy.casemodule.services;
21 import java.io.Closeable;
22 import java.io.IOException;
23 import java.util.ArrayList;
24 import java.util.EnumSet;
25 import java.util.HashMap;
26 import java.util.HashSet;
27 import java.util.List;
30 import java.util.logging.Level;
31 import org.openide.util.NbBundle;
60 private static final Object
lock =
new Object();
67 if (evt.getNewValue() != null) {
68 Case currentCase = (
Case) evt.getNewValue();
70 CaseDbAccessManager caseDb = currentCase.
getSleuthkitCase().getCaseDbAccessManager();
75 if (currentCase.
getSleuthkitCase().getDatabaseType().equals(DbType.SQLITE)) {
77 }
else if (currentCase.
getSleuthkitCase().getDatabaseType().equals(DbType.POSTGRESQL)) {
78 caseDb.createTable(ContentViewerTagManager.TABLE_NAME, ContentViewerTagManager.TABLE_SCHEMA_POSTGRESQL);
80 }
catch (TskCoreException ex) {
81 LOGGER.log(Level.SEVERE,
82 String.format(
"Unable to create the %s table for image tag storage.",
83 ContentViewerTagManager.TABLE_NAME), ex);
98 return (tagDisplayName.contains(
"\\")
99 || tagDisplayName.contains(
":")
100 || tagDisplayName.contains(
"*")
101 || tagDisplayName.contains(
"?")
102 || tagDisplayName.contains(
"\"")
103 || tagDisplayName.contains(
"<")
104 || tagDisplayName.contains(
">")
105 || tagDisplayName.contains(
"|")
106 || tagDisplayName.contains(
",")
107 || tagDisplayName.contains(
";"));
111 @NbBundle.Messages({
"TagsManager.notableTagEnding.text= (Notable)"})
118 return Bundle.TagsManager_notableTagEnding_text();
133 Set<String> tagDisplayNames =
new HashSet<>();
135 customNames.forEach((tagType) -> {
136 tagDisplayNames.add(tagType.getDisplayName());
141 tagDisplayNames.add(tagName.getDisplayName());
148 return tagDisplayNames;
159 List<String> tagDisplayNames =
new ArrayList<>();
161 if (tagDef.getKnownStatus() == TskData.FileKnown.BAD) {
162 tagDisplayNames.add(tagDef.getDisplayName());
169 if (tagName.getKnownStatus() == TskData.FileKnown.BAD
170 && !tagDisplayNames.contains(tagName.getDisplayName())) {
171 tagDisplayNames.add(tagName.getDisplayName());
178 }
catch (TskCoreException ex) {
179 LOGGER.log(Level.SEVERE,
"Failed to get list of TagNames from TagsManager.", ex);
181 return tagDisplayNames;
190 List<String> tagList =
new ArrayList<>();
193 tagList.add(tagNameDef.getDisplayName());
198 for (TagSet tagSet : tagSetList) {
199 if (tagSet.getName().equals(DEFAULT_TAG_SET_NAME)) {
200 for (TagName tagName : tagSet.getTagNames()) {
201 tagList.add(tagName.getDisplayName());
206 LOGGER.log(Level.SEVERE,
"Failed to get Project VIC tags from the database.", ex);
247 synchronized (
lock) {
262 TaggingManager taggingMgr = caseDb.getTaggingManager();
264 List<TagSet> setList = taggingMgr.getTagSets();
265 if (setList.isEmpty()) {
267 caseDb.addOrUpdateTagName(def.getDisplayName(), def.getDescription(), def.getColor(), def.getKnownStatus());
270 for (TagSetDefinition setDef : TagSetDefinition.readTagSetDefinitions()) {
271 List<TagName> tagNameList =
new ArrayList<>();
272 for (TagNameDefinition tagNameDef : setDef.getTagNameDefinitions()) {
273 tagNameList.add(caseDb.addOrUpdateTagName(tagNameDef.getDisplayName(), tagNameDef.getDescription(), tagNameDef.getColor(), tagNameDef.getKnownStatus()));
276 if (!tagNameList.isEmpty()) {
277 taggingMgr.addTagSet(setDef.getName(), tagNameList);
281 }
catch (TskCoreException ex) {
282 LOGGER.log(Level.SEVERE,
"Error updating standard tag name and tag set definitions", ex);
283 }
catch (IOException ex) {
284 LOGGER.log(Level.SEVERE,
"Error loading tag set JSON files", ex);
287 for (TagNameDefinition tagName : TagNameDefinition.getTagNameDefinitions()) {
288 tagName.saveToCase(caseDb);
300 return caseDb.getTaggingManager().getTagSets();
312 public TagSet
getTagSet(TagName tagName)
throws TskCoreException {
313 return caseDb.getTaggingManager().getTagSet(tagName);
327 public TagSet
addTagSet(String name, List<TagName> tagNameList)
throws TskCoreException {
328 return caseDb.getTaggingManager().addTagSet(name, tagNameList);
339 return caseDb.getAllTagNames();
351 return caseDb.getTagNamesInUse();
365 Set<TagName> tagNameSet =
new HashSet<>();
366 List<BlackboardArtifactTag> artifactTags = caseDb.getAllBlackboardArtifactTags();
367 for (BlackboardArtifactTag tag : artifactTags) {
368 if (tag.getUserName().equals(userName)) {
369 tagNameSet.add(tag.getName());
372 List<ContentTag> contentTags = caseDb.getAllContentTags();
373 for (ContentTag tag : contentTags) {
374 if (tag.getUserName().equals(userName)) {
375 tagNameSet.add(tag.getName());
378 return new ArrayList<>(tagNameSet);
394 return caseDb.getTagNamesInUse(dsObjId);
412 Set<TagName> tagNameSet =
new HashSet<>();
413 List<BlackboardArtifactTag> artifactTags = caseDb.getAllBlackboardArtifactTags();
414 for (BlackboardArtifactTag tag : artifactTags) {
415 if (tag.getUserName().equals(userName) && tag.getArtifact().getDataSource().getId() == dsObjId) {
416 tagNameSet.add(tag.getName());
419 List<ContentTag> contentTags = caseDb.getAllContentTags();
420 for (ContentTag tag : contentTags) {
421 if (tag.getUserName().equals(userName) && tag.getContent().getDataSource().getId() == dsObjId) {
422 tagNameSet.add(tag.getName());
425 return new ArrayList<>(tagNameSet);
436 Map<String, TagName> tagNames =
new HashMap<>();
437 for (TagName tagName : caseDb.getAllTagNames()) {
438 tagNames.put(tagName.getDisplayName(), tagName);
458 return addTagName(displayName,
"", TagName.HTML_COLOR.NONE, TskData.FileKnown.UNKNOWN);
476 public TagName
addTagName(String displayName, String description)
throws TagNameAlreadyExistsException, TskCoreException {
477 return addTagName(displayName, description, TagName.HTML_COLOR.NONE, TskData.FileKnown.UNKNOWN);
495 public TagName
addTagName(String displayName, String description, TagName.HTML_COLOR color) throws TagNameAlreadyExistsException, TskCoreException {
496 return addTagName(displayName, description, color, TskData.FileKnown.UNKNOWN);
516 public TagName
addTagName(String displayName, String description, TagName.HTML_COLOR color, TskData.FileKnown knownStatus) throws TagNameAlreadyExistsException, TskCoreException {
517 synchronized (
lock) {
519 TagName tagName = caseDb.addOrUpdateTagName(displayName, description, color, knownStatus);
521 customTypes.add(
new TagNameDefinition(displayName, description, color, knownStatus));
524 }
catch (TskCoreException ex) {
525 List<TagName> existingTagNames = caseDb.getAllTagNames();
526 for (TagName tagName : existingTagNames) {
527 if (tagName.getDisplayName().equals(displayName)) {
528 throw new TagNameAlreadyExistsException();
549 public ContentTag
addContentTag(Content content, TagName tagName)
throws TskCoreException {
567 public ContentTag
addContentTag(Content content, TagName tagName, String comment)
throws TskCoreException {
587 public ContentTag
addContentTag(Content content, TagName tagName, String comment,
long beginByteOffset,
long endByteOffset)
throws TskCoreException {
588 TaggingManager.ContentTagChange tagChange = caseDb.getTaggingManager().addContentTag(content, tagName, comment, beginByteOffset, endByteOffset);
592 currentCase.
notifyContentTagAdded(tagChange.getAddedTag(), tagChange.getRemovedTags().isEmpty() ? null : tagChange.getRemovedTags());
595 throw new TskCoreException(
"Added a tag to a closed case", ex);
597 return tagChange.getAddedTag();
609 caseDb.deleteContentTag(tag);
613 throw new TskCoreException(
"Deleted a tag from a closed case", ex);
626 return caseDb.getAllContentTags();
642 return caseDb.getContentTagsCountByTagName(tagName);
662 for (ContentTag tag : contentTags) {
663 if (userName.equals(tag.getUserName())) {
686 return caseDb.getContentTagsCountByTagName(tagName, dsObjId);
708 for (ContentTag tag : contentTags) {
709 if (userName.equals(tag.getUserName())) {
727 return caseDb.getContentTagByID(tagId);
742 return caseDb.getContentTagsByTagName(tagName);
759 return caseDb.getContentTagsByTagName(tagName, dsObjId);
774 return caseDb.getContentTagsByContent(content);
808 public BlackboardArtifactTag
addBlackboardArtifactTag(BlackboardArtifact artifact, TagName tagName, String comment)
throws TskCoreException {
809 TaggingManager.BlackboardArtifactTagChange tagChange = caseDb.getTaggingManager().addArtifactTag(artifact, tagName, comment);
814 throw new TskCoreException(
"Added a tag to a closed case", ex);
816 return tagChange.getAddedTag();
828 caseDb.deleteBlackboardArtifactTag(tag);
832 throw new TskCoreException(
"Deleted a tag from a closed case", ex);
845 return caseDb.getAllBlackboardArtifactTags();
861 return caseDb.getBlackboardArtifactTagsCountByTagName(tagName);
881 for (BlackboardArtifactTag tag : artifactTags) {
882 if (userName.equals(tag.getUserName())) {
904 return caseDb.getBlackboardArtifactTagsCountByTagName(tagName, dsObjId);
926 for (BlackboardArtifactTag tag : artifactTags) {
927 if (userName.equals(tag.getUserName())) {
945 return caseDb.getBlackboardArtifactTagByID(tagId);
962 return caseDb.getBlackboardArtifactTagsByTagName(tagName);
980 return caseDb.getBlackboardArtifactTagsByTagName(tagName, dsObjId);
995 return caseDb.getBlackboardArtifactTagsByArtifact(artifact);
1001 public static class TagNameAlreadyExistsException
extends Exception {
1020 return tagNames.containsKey(tagDisplayName) && (tagNames.get(tagDisplayName) != null);
1021 }
catch (TskCoreException ex) {
1022 LOGGER.log(Level.SEVERE,
"Error querying case database for tag names", ex);
1035 public void close() throws IOException {
void notifyContentTagDeleted(ContentTag deletedTag)
void notifyBlackBoardArtifactTagDeleted(BlackboardArtifactTag deletedTag)
TagsManager getTagsManager()
static final String TABLE_SCHEMA_SQLITE
static final String TABLE_NAME
SleuthkitCase getSleuthkitCase()
void notifyBlackBoardArtifactTagAdded(BlackboardArtifactTag newTag)
synchronized static Logger getLogger(String name)
static Case getCurrentCaseThrows()
static void addEventTypeSubscriber(Set< Events > eventTypes, PropertyChangeListener subscriber)
void notifyContentTagAdded(ContentTag newTag)