Replace hack with use of generic_string from boost::filesystem.

[libdcp.git] / src / asset.cc

diff --git a/src/asset.cc b/src/asset.cc
index fa6947d17d0f20136a92d119157c82a1e7f60b7f..296e3bef2f00f89de63b23f05c79e5a9d8febb2c 100644 (file)
--- a/src/asset.cc
+++ b/src/asset.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2012 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
 
     This program is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
@@ -18,77 +18,130 @@
 */
 
 /** @file  src/asset.cc
- *  @brief Parent class for assets of DCPs.
+ *  @brief Asset class.
  */
 
-#include <iostream>
-#include <fstream>
-#include <boost/filesystem.hpp>
-#include <boost/lexical_cast.hpp>
-#include <libxml++/nodes/element.h>
-#include "AS_DCP.h"
-#include "KM_util.h"
+#include "raw_convert.h"
 #include "asset.h"
 #include "util.h"
-#include "metadata.h"
+#include "exceptions.h"
+#include "dcp_assert.h"
+#include "compose.hpp"
+#include <libxml++/libxml++.h>
+#include <boost/algorithm/string.hpp>
 
-using namespace std;
-using namespace boost;
-using namespace libdcp;
+using std::string;
+using boost::function;
+using boost::optional;
+using namespace dcp;
 
-Asset::Asset (string directory, string file_name)
-       : _directory (directory)
-       , _file_name (file_name)
-       , _uuid (make_uuid ())
+/** Create an Asset with a randomly-generated ID */
+Asset::Asset ()
 {
-       if (_file_name.empty ()) {
-               _file_name = _uuid + ".xml";
-       }
+
 }
 
-void
-Asset::write_to_pkl (xmlpp::Element* p) const
+/** Create an Asset from a given file.
+ *  @param file File name.
+ */
+Asset::Asset (boost::filesystem::path file)
+       : _file (file)
 {
-       xmlpp::Element* asset = p->add_child("Asset");
-       asset->add_child("Id")->add_child_text("urn:uuid:" + _uuid);
-       asset->add_child("AnnotationText")->add_child_text (_file_name);
-       asset->add_child("Hash")->add_child_text (digest());
-       asset->add_child("Size")->add_child_text (boost::lexical_cast<string> (filesystem::file_size(path())));
-       asset->add_child("Type")->add_child_text ("application/mxf");
+
+}
+
+Asset::Asset (string id, boost::filesystem::path file)
+       : Object (id)
+       , _file (file)
+{
+
 }
 
 void
-Asset::write_to_assetmap (ostream& s) const
+Asset::write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard standard) const
 {
-       s << "    <Asset>\n"
-         << "      <Id>urn:uuid:" << _uuid << "</Id>\n"
-         << "      <ChunkList>\n"
-         << "        <Chunk>\n"
-         << "          <Path>" << _file_name << "</Path>\n"
-         << "          <VolumeIndex>1</VolumeIndex>\n"
-         << "          <Offset>0</Offset>\n"
-         << "          <Length>" << filesystem::file_size(path()) << "</Length>\n"
-         << "        </Chunk>\n"
-         << "      </ChunkList>\n"
-         << "    </Asset>\n";
+       DCP_ASSERT (!_file.empty ());
+
+       optional<boost::filesystem::path> path = relative_to_root (
+               boost::filesystem::canonical (root),
+               boost::filesystem::canonical (_file)
+               );
+
+       if (!path) {
+               /* The path of this asset is not within our DCP, so we assume it's an external
+                  (referenced) one.
+               */
+               return;
+       }
+
+       xmlpp::Node* asset = node->add_child ("Asset");
+       asset->add_child("Id")->add_child_text ("urn:uuid:" + _id);
+       asset->add_child("AnnotationText")->add_child_text (_id);
+       asset->add_child("Hash")->add_child_text (hash ());
+       asset->add_child("Size")->add_child_text (raw_convert<string> (boost::filesystem::file_size (_file)));
+       asset->add_child("Type")->add_child_text (pkl_type (standard));
 }
 
-filesystem::path
-Asset::path () const
+void
+Asset::write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const
 {
-       filesystem::path p;
-       p /= _directory;
-       p /= _file_name;
-       return p;
+       DCP_ASSERT (!_file.empty ());
+
+       optional<boost::filesystem::path> path = relative_to_root (
+               boost::filesystem::canonical (root),
+               boost::filesystem::canonical (_file)
+               );
+
+       if (!path) {
+               /* The path of this asset is not within our DCP, so we assume it's an external
+                  (referenced) one.
+               */
+               return;
+       }
+
+       xmlpp::Node* asset = node->add_child ("Asset");
+       asset->add_child("Id")->add_child_text ("urn:uuid:" + _id);
+       xmlpp::Node* chunk_list = asset->add_child ("ChunkList");
+       xmlpp::Node* chunk = chunk_list->add_child ("Chunk");
+
+       chunk->add_child("Path")->add_child_text (path.get().generic_string());
+       chunk->add_child("VolumeIndex")->add_child_text ("1");
+       chunk->add_child("Offset")->add_child_text ("0");
+       chunk->add_child("Length")->add_child_text (raw_convert<string> (boost::filesystem::file_size (_file)));
 }
 
 string
-Asset::digest () const
+Asset::hash (function<void (float)> progress) const
+{
+       DCP_ASSERT (!_file.empty ());
+
+       if (_hash.empty ()) {
+               _hash = make_digest (_file, progress);
+       }
+
+       return _hash;
+}
+
+bool
+Asset::equals (boost::shared_ptr<const Asset> other, EqualityOptions, NoteHandler note) const
 {
-       if (_digest.empty ()) {
-               _digest = make_digest (path().string());
+       if (_hash != other->_hash) {
+               note (DCP_ERROR, "Asset: hashes differ");
+               return false;
        }
 
-       return _digest;
+       return true;
 }
 
+/** Set the file that holds this asset on disk.  Calling this function
+ *  clears this object's store of its hash, so you should call ::hash
+ *  after this.
+ *
+ *  @param file New file's path.
+ */
+void
+Asset::set_file (boost::filesystem::path file) const
+{
+       _file = boost::filesystem::absolute (file);
+       _hash.clear ();
+}