19 package org.sleuthkit.autopsy.casemodule;
21 import java.io.BufferedWriter;
22 import java.io.FileOutputStream;
23 import java.io.IOException;
24 import java.io.OutputStreamWriter;
25 import java.io.StringWriter;
26 import java.nio.file.Path;
27 import java.nio.file.Paths;
28 import java.text.DateFormat;
29 import java.text.SimpleDateFormat;
30 import java.util.Date;
31 import javax.xml.parsers.DocumentBuilder;
32 import javax.xml.parsers.DocumentBuilderFactory;
33 import javax.xml.parsers.ParserConfigurationException;
34 import javax.xml.transform.OutputKeys;
35 import javax.xml.transform.Result;
36 import javax.xml.transform.Source;
37 import javax.xml.transform.Transformer;
38 import javax.xml.transform.TransformerException;
39 import javax.xml.transform.TransformerFactory;
40 import javax.xml.transform.dom.DOMSource;
41 import javax.xml.transform.stream.StreamResult;
44 import org.w3c.dom.Document;
45 import org.w3c.dom.Element;
46 import org.w3c.dom.NodeList;
47 import org.xml.sax.SAXException;
55 private static final DateFormat
DATE_FORMAT =
new SimpleDateFormat(
"yyyy/MM/dd HH:mm:ss (z)");
131 metadataFilePath = Paths.get(caseDirectory, caseDisplayName + FILE_EXTENSION);
137 caseDatabaseName =
"";
138 caseDatabasePath =
"";
173 return metadataFilePath.getParent().toString();
215 }
catch (CaseMetadataException ex) {
216 this.caseDisplayName = oldCaseDisplayName;
260 }
catch (CaseMetadataException ex) {
261 this.caseDatabaseName = oldCaseDatabaseName;
281 String getCreatedDate() {
293 void setCreatedDate(String createdDate)
throws CaseMetadataException {
298 }
catch (CaseMetadataException ex) {
299 this.createdDate = oldCreatedDate;
309 String getCreatedByVersion() {
321 void setCreatedByVersion(String buildVersion)
throws CaseMetadataException {
323 this.createdByVersion = buildVersion;
326 }
catch (CaseMetadataException ex) {
327 this.createdByVersion = oldCreatedByVersion;
350 Source source =
new DOMSource(doc);
351 StringWriter stringWriter =
new StringWriter();
352 Result streamResult =
new StreamResult(stringWriter);
353 Transformer transformer = TransformerFactory.newInstance().newTransformer();
354 transformer.setOutputProperty(OutputKeys.INDENT,
"yes");
355 transformer.setOutputProperty(
"{http://xml.apache.org/xslt}indent-amount",
"2");
356 transformer.transform(source, streamResult);
361 try (BufferedWriter fileWriter =
new BufferedWriter(
new OutputStreamWriter(
new FileOutputStream(metadataFilePath.toFile())))) {
362 fileWriter.write(stringWriter.toString());
366 }
catch (ParserConfigurationException | TransformerException | IOException ex) {
367 throw new CaseMetadataException(String.format(
"Error writing to case metadata file %s", metadataFilePath), ex);
378 Element rootElement = doc.createElement(ROOT_ELEMENT_NAME);
379 doc.appendChild(rootElement);
380 createChildElement(doc, rootElement, SCHEMA_VERSION_ELEMENT_NAME, CURRENT_SCHEMA_VERSION);
382 createChildElement(doc, rootElement, MODIFIED_DATE_ELEMENT_NAME, DATE_FORMAT.format(
new Date()));
383 createChildElement(doc, rootElement, AUTOPSY_CREATED_BY_ELEMENT_NAME, createdByVersion);
385 Element caseElement = doc.createElement(CASE_ELEMENT_NAME);
386 rootElement.appendChild(caseElement);
392 createChildElement(doc, caseElement, CASE_DISPLAY_NAME_ELEMENT_NAME, caseDisplayName);
396 createChildElement(doc, caseElement, CASE_DB_ABSOLUTE_PATH_ELEMENT_NAME, caseDatabasePath);
397 createChildElement(doc, caseElement, CASE_DB_NAME_RELATIVE_ELEMENT_NAME, caseDatabaseName);
410 private void createChildElement(Document doc, Element parentElement, String elementName, String elementContent) {
411 Element element = doc.createElement(elementName);
412 element.appendChild(doc.createTextNode(elementContent));
413 parentElement.appendChild(element);
427 DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
428 Document doc = builder.parse(this.getFilePath().toFile());
429 doc.getDocumentElement().normalize();
430 Element rootElement = doc.getDocumentElement();
431 if (!rootElement.getNodeName().equals(ROOT_ELEMENT_NAME)) {
432 throw new CaseMetadataException(
"Case metadata file corrupted");
440 if (schemaVersion.equals(SCHEMA_VERSION_ONE)) {
449 NodeList caseElements = doc.getElementsByTagName(CASE_ELEMENT_NAME);
450 if (caseElements.getLength() == 0) {
451 throw new CaseMetadataException(
"Case metadata file corrupted");
453 Element caseElement = (Element) caseElements.item(0);
455 if (schemaVersion.equals(SCHEMA_VERSION_ONE) || schemaVersion.equals(SCHEMA_VERSION_TWO)) {
464 throw new CaseMetadataException(
"Case metadata file corrupted");
466 switch (schemaVersion) {
467 case SCHEMA_VERSION_ONE:
471 case SCHEMA_VERSION_TWO:
472 this.caseDatabaseName =
getElementTextContent(caseElement, CASE_DB_ABSOLUTE_PATH_ELEMENT_NAME,
true);
476 this.caseDatabaseName =
getElementTextContent(caseElement, CASE_DB_NAME_RELATIVE_ELEMENT_NAME,
true);
487 Path possibleAbsoluteCaseDbPath = Paths.get(this.caseDatabaseName);
489 if (possibleAbsoluteCaseDbPath.getNameCount() > 1) {
491 this.caseDatabaseName = caseDirectoryPath.relativize(possibleAbsoluteCaseDbPath).toString();
493 this.caseDatabasePath = caseDirectoryPath.resolve(caseDatabaseName).toAbsolutePath().toString();
496 }
catch (ParserConfigurationException | SAXException | IOException ex) {
497 throw new CaseMetadataException(String.format(
"Error reading from case metadata file %s", metadataFilePath), ex);
514 NodeList elementsList = parentElement.getElementsByTagName(elementName);
515 if (elementsList.getLength() == 0) {
516 throw new CaseMetadataException(String.format(
"Missing %s element from case metadata file %s", elementName, metadataFilePath));
518 String textContent = elementsList.item(0).getTextContent();
519 if (textContent.isEmpty() && contentIsRequired) {
520 throw new CaseMetadataException(String.format(
"Empty %s element in case metadata file %s", elementName, metadataFilePath));
538 super(message, cause);
556 throw new UnsupportedOperationException();
static CaseType fromString(String typeName)
static Document createDocument()
static String getVersion()