19 package org.sleuthkit.autopsy.casemodule;
21 import java.io.BufferedWriter;
23 import java.io.FileOutputStream;
24 import java.io.IOException;
25 import java.io.OutputStreamWriter;
26 import java.io.StringWriter;
27 import java.nio.charset.StandardCharsets;
28 import java.nio.file.Path;
29 import java.nio.file.Paths;
30 import java.text.DateFormat;
31 import java.text.SimpleDateFormat;
32 import java.util.Date;
33 import java.util.Locale;
34 import javax.xml.parsers.DocumentBuilder;
35 import javax.xml.parsers.DocumentBuilderFactory;
36 import javax.xml.parsers.ParserConfigurationException;
37 import javax.xml.transform.OutputKeys;
38 import javax.xml.transform.Result;
39 import javax.xml.transform.Source;
40 import javax.xml.transform.Transformer;
41 import javax.xml.transform.TransformerException;
42 import javax.xml.transform.TransformerFactory;
43 import javax.xml.transform.dom.DOMSource;
44 import javax.xml.transform.stream.StreamResult;
45 import org.apache.commons.lang3.StringUtils;
48 import org.w3c.dom.Document;
49 import org.w3c.dom.Element;
50 import org.w3c.dom.NodeList;
51 import org.xml.sax.SAXException;
60 private static final DateFormat
DATE_FORMAT =
new SimpleDateFormat(DATE_FORMAT_STRING, Locale.US);
149 return new SimpleDateFormat(DATE_FORMAT_STRING, Locale.US);
177 CaseMetadata(Case.CaseType
caseType, String caseDirectory, String caseName, CaseDetails caseDetails, CaseMetadata originalMetadata) {
178 metadataFilePath = Paths.get(caseDirectory, caseDetails.getCaseDisplayName() +
FILE_EXTENSION);
182 caseDatabaseName =
"";
183 caseDatabasePath =
"";
185 createdByVersion = Version.getVersion();
186 createdDate = CaseMetadata.DATE_FORMAT.format(
new Date());
188 this.contentProviderName = originalMetadata == null ? null : originalMetadata.
contentProviderName;
214 final File[] files = directoryPath.toFile().listFiles();
216 for (File file : files) {
217 final String fileName = file.getName().toLowerCase();
219 return file.toPath();
249 return StringUtils.isBlank(this.caseDatabasePath)
250 ? metadataFilePath.getParent().toString()
251 : Paths.get(this.caseDatabasePath).getParent().toString();
287 return caseDetails.getCaseDisplayName();
292 this.caseDetails = newCaseDetails;
295 }
catch (CaseMetadataException ex) {
296 this.caseDetails = oldCaseDetails;
307 return caseDetails.getCaseNumber();
316 return caseDetails.getExaminerName();
320 return caseDetails.getExaminerPhone();
324 return caseDetails.getExaminerEmail();
328 return caseDetails.getCaseNotes();
352 }
catch (CaseMetadataException ex) {
353 this.caseDatabaseName = oldCaseDatabaseName;
390 }
catch (CaseMetadataException ex) {
391 this.createdDate = oldCreatedDate;
401 String getCreatedByVersion() {
413 void setCreatedByVersion(String buildVersion)
throws CaseMetadataException {
415 this.createdByVersion = buildVersion;
418 }
catch (CaseMetadataException ex) {
419 this.createdByVersion = oldCreatedByVersion;
430 void writeToFile() throws CaseMetadataException {
435 Document doc = XMLUtil.createDocument();
442 Source source =
new DOMSource(doc);
443 StringWriter stringWriter =
new StringWriter();
444 Result streamResult =
new StreamResult(stringWriter);
445 Transformer transformer = TransformerFactory.newInstance().newTransformer();
446 transformer.setOutputProperty(OutputKeys.INDENT,
"yes");
447 transformer.setOutputProperty(
"{http://xml.apache.org/xslt}indent-amount",
"2");
448 transformer.transform(source, streamResult);
454 try (BufferedWriter fileWriter =
new BufferedWriter(
new OutputStreamWriter(
new FileOutputStream(metadataFilePath.toFile()), StandardCharsets.UTF_8))) {
455 fileWriter.write(stringWriter.toString());
459 }
catch (ParserConfigurationException | TransformerException | IOException ex) {
460 throw new CaseMetadataException(String.format(
"Error writing to case metadata file %s", metadataFilePath), ex);
471 Element rootElement = doc.createElement(ROOT_ELEMENT_NAME);
472 doc.appendChild(rootElement);
473 createChildElement(doc, rootElement, SCHEMA_VERSION_ELEMENT_NAME, CURRENT_SCHEMA_VERSION);
475 createChildElement(doc, rootElement, MODIFIED_DATE_ELEMENT_NAME, DATE_FORMAT.format(
new Date()));
476 createChildElement(doc, rootElement, AUTOPSY_CREATED_BY_ELEMENT_NAME, createdByVersion);
478 Element caseElement = doc.createElement(CASE_ELEMENT_NAME);
479 rootElement.appendChild(caseElement);
481 Element contentProviderEl = doc.createElement(CONTENT_PROVIDER_ELEMENT_NAME);
482 rootElement.appendChild(contentProviderEl);
484 Element contentProviderNameEl = doc.createElement(CONTENT_PROVIDER_NAME_ELEMENT_NAME);
485 if (this.contentProviderName != null) {
486 contentProviderNameEl.setTextContent(this.contentProviderName);
488 contentProviderEl.appendChild(contentProviderNameEl);
498 Element originalCaseElement = doc.createElement(ORIGINAL_CASE_ELEMENT_NAME);
499 rootElement.appendChild(originalCaseElement);
500 if (originalMetadata != null) {
501 createChildElement(doc, originalCaseElement, CREATED_DATE_ELEMENT_NAME, originalMetadata.createdDate);
502 Element originalCaseDetailsElement = doc.createElement(CASE_ELEMENT_NAME);
503 originalCaseElement.appendChild(originalCaseDetailsElement);
540 private void createChildElement(Document doc, Element parentElement, String elementName, String elementContent) {
541 Element element = doc.createElement(elementName);
542 element.appendChild(doc.createTextNode(elementContent));
543 parentElement.appendChild(element);
557 DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
558 Document doc = builder.parse(this.
getFilePath().toFile());
559 doc.getDocumentElement().normalize();
560 Element rootElement = doc.getDocumentElement();
561 if (!rootElement.getNodeName().equals(ROOT_ELEMENT_NAME)) {
562 throw new CaseMetadataException(
"Case metadata file corrupted");
570 if (schemaVersion.equals(SCHEMA_VERSION_ONE)) {
576 Element contentProviderEl =
getChildElOrNull(rootElement, CONTENT_PROVIDER_ELEMENT_NAME);
577 if (contentProviderEl != null) {
578 Element contentProviderNameEl =
getChildElOrNull(contentProviderEl, CONTENT_PROVIDER_NAME_ELEMENT_NAME);
579 this.contentProviderName = contentProviderNameEl != null ? contentProviderNameEl.getTextContent() : null;
581 this.contentProviderName = null;
587 NodeList caseElements = doc.getElementsByTagName(CASE_ELEMENT_NAME);
588 if (caseElements.getLength() == 0) {
589 throw new CaseMetadataException(
"Case metadata file corrupted");
591 Element caseElement = (Element) caseElements.item(0);
593 String caseDisplayName;
595 if (schemaVersion.equals(SCHEMA_VERSION_ONE) || schemaVersion.equals(SCHEMA_VERSION_TWO)) {
602 String examinerPhone;
603 String examinerEmail;
605 if (schemaVersion.equals(SCHEMA_VERSION_ONE) || schemaVersion.equals(SCHEMA_VERSION_TWO) || schemaVersion.equals(SCHEMA_VERSION_THREE)) {
615 this.caseDetails =
new CaseDetails(caseDisplayName, caseNumber, examinerName, examinerPhone, examinerEmail, caseNotes);
618 throw new CaseMetadataException(
"Case metadata file corrupted");
620 switch (schemaVersion) {
621 case SCHEMA_VERSION_ONE:
625 case SCHEMA_VERSION_TWO:
626 this.caseDatabaseName =
getElementTextContent(caseElement, CASE_DB_ABSOLUTE_PATH_ELEMENT_NAME,
true);
630 this.caseDatabasePath =
getElementTextContent(caseElement, CASE_DB_ABSOLUTE_PATH_ELEMENT_NAME,
false);
631 this.caseDatabaseName =
getElementTextContent(caseElement, CASE_DB_NAME_RELATIVE_ELEMENT_NAME,
true);
642 Path possibleAbsoluteCaseDbPath = Paths.get(this.caseDatabaseName);
644 if (possibleAbsoluteCaseDbPath.toFile().isAbsolute()) {
646 this.caseDatabaseName = caseDirectoryPath.relativize(possibleAbsoluteCaseDbPath).toString();
649 }
catch (ParserConfigurationException | SAXException | IOException ex) {
650 throw new CaseMetadataException(String.format(
"Error reading from case metadata file %s", metadataFilePath), ex);
655 NodeList nl = parent.getElementsByTagName(childTag);
656 if (nl != null && nl.getLength() > 0 && nl.item(0) instanceof Element) {
657 return (Element) nl.item(0);
675 private String
getElementTextContent(Element parentElement, String elementName,
boolean contentIsRequired)
throws CaseMetadataException {
676 NodeList elementsList = parentElement.getElementsByTagName(elementName);
677 if (elementsList.getLength() == 0) {
678 throw new CaseMetadataException(String.format(
"Missing %s element from case metadata file %s", elementName, metadataFilePath));
680 String textContent = elementsList.item(0).getTextContent();
681 if (textContent.isEmpty() && contentIsRequired) {
682 throw new CaseMetadataException(String.format(
"Empty %s element in case metadata file %s", elementName, metadataFilePath));
691 public final static class CaseMetadataException
extends Exception {
700 super(message, cause);
714 return StringUtils.isBlank(this.caseDatabasePath)
715 ? this.metadataFilePath.getParent().resolve(this.caseDatabaseName).toString()
718 throw new UnsupportedOperationException();
static CaseType fromString(String typeName)
String getExaminerPhone()
String getCaseDisplayName()
static String getVersion()
String getExaminerEmail()