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)");
111 metadataFilePath = Paths.get(caseDirectory, caseName + FILE_EXTENSION);
117 this.textIndexName = caseTextIndexName;
152 return metadataFilePath.getParent().toString();
184 }
catch (CaseMetadataException ex) {
185 this.caseName = oldCaseName;
217 return Paths.get(caseDatabase).getFileName().toString();
233 throw new UnsupportedOperationException();
251 String getCreatedDate() {
261 void setCreatedDate(String createdDate)
throws CaseMetadataException {
266 }
catch (CaseMetadataException ex) {
267 this.createdDate = oldCreatedDate;
277 String getCreatedByVersion() {
287 void setCreatedByVersion(String buildVersion)
throws CaseMetadataException {
289 this.createdByVersion = buildVersion;
292 }
catch (CaseMetadataException ex) {
293 this.createdByVersion = oldCreatedByVersion;
316 Source source =
new DOMSource(doc);
317 StringWriter stringWriter =
new StringWriter();
318 Result streamResult =
new StreamResult(stringWriter);
319 Transformer transformer = TransformerFactory.newInstance().newTransformer();
320 transformer.setOutputProperty(OutputKeys.INDENT,
"yes");
321 transformer.setOutputProperty(
"{http://xml.apache.org/xslt}indent-amount",
"2");
322 transformer.transform(source, streamResult);
327 try (BufferedWriter fileWriter =
new BufferedWriter(
new OutputStreamWriter(
new FileOutputStream(metadataFilePath.toFile())))) {
328 fileWriter.write(stringWriter.toString());
332 }
catch (ParserConfigurationException | TransformerException | IOException ex) {
333 throw new CaseMetadataException(String.format(
"Error writing to case metadata file %s", metadataFilePath), ex);
344 Element rootElement = doc.createElement(ROOT_ELEMENT_NAME);
345 doc.appendChild(rootElement);
346 createChildElement(doc, rootElement, SCHEMA_VERSION_ELEMENT_NAME, CURRENT_SCHEMA_VERSION);
348 createChildElement(doc, rootElement, MODIFIED_DATE_ELEMENT_NAME, DATE_FORMAT.format(
new Date()));
349 createChildElement(doc, rootElement, AUTOPSY_CREATED_BY_ELEMENT_NAME, createdByVersion);
351 Element caseElement = doc.createElement(CASE_ELEMENT_NAME);
352 rootElement.appendChild(caseElement);
374 private void createChildElement(Document doc, Element parentElement, String elementName, String elementContent) {
375 Element element = doc.createElement(elementName);
376 element.appendChild(doc.createTextNode(elementContent));
377 parentElement.appendChild(element);
391 DocumentBuilder builder = DocumentBuilderFactory.newInstance().newDocumentBuilder();
392 Document doc = builder.parse(this.getFilePath().toFile());
393 doc.getDocumentElement().normalize();
394 Element rootElement = doc.getDocumentElement();
395 if (!rootElement.getNodeName().equals(ROOT_ELEMENT_NAME)) {
396 throw new CaseMetadataException(
"Case metadata file corrupted");
404 if (schemaVersion.equals(SCHEMA_VERSION_ONE)) {
405 this.createdByVersion =
getElementTextContent(rootElement, AUTOPSY_CREATED_VERSION_ELEMENT_NAME,
true);
413 NodeList caseElements = doc.getElementsByTagName(CASE_ELEMENT_NAME);
414 if (caseElements.getLength() == 0) {
415 throw new CaseMetadataException(
"Case metadata file corrupted");
417 Element caseElement = (Element) caseElements.item(0);
423 throw new CaseMetadataException(
"Case metadata file corrupted");
425 if (schemaVersion.equals(SCHEMA_VERSION_ONE)) {
436 if (!schemaVersion.equals(CURRENT_SCHEMA_VERSION)) {
440 }
catch (ParserConfigurationException | SAXException | IOException ex) {
441 throw new CaseMetadataException(String.format(
"Error reading from case metadata file %s", metadataFilePath), ex);
458 NodeList elementsList = parentElement.getElementsByTagName(elementName);
459 if (elementsList.getLength() == 0) {
460 throw new CaseMetadataException(String.format(
"Missing %s element from case metadata file %s", elementName, metadataFilePath));
462 String textContent = elementsList.item(0).getTextContent();
463 if (textContent.isEmpty() && contentIsRequired) {
464 throw new CaseMetadataException(String.format(
"Empty %s element in case metadata file %s", elementName, metadataFilePath));
482 super(message, cause);
static CaseType fromString(String typeName)
static Document createDocument()
static String getVersion()