Add asset_hashes_can_differ option to the equality checks.

[libdcp.git] / src / asset.cc

diff --git a/src/asset.cc b/src/asset.cc
index 7d3a9813aa81b8a5be5546a63527eb782d69059f..330bd653082fcb1ff6441322b06c640ee76f7ca7 100644 (file)
--- a/src/asset.cc
+++ b/src/asset.cc
@@ -1,5 +1,5 @@
 /*
-    Copyright (C) 2014-2015 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
 
     This file is part of libdcp.
 
@@ -31,58 +31,64 @@
     files in the program, then also delete it here.
 */
 
+
 /** @file  src/asset.cc
- *  @brief Asset class.
+ *  @brief Asset class
  */
 
-#include "raw_convert.h"
+
 #include "asset.h"
-#include "util.h"
-#include "exceptions.h"
-#include "dcp_assert.h"
+#include "asset_map.h"
 #include "compose.hpp"
+#include "dcp_assert.h"
+#include "exceptions.h"
+#include "pkl.h"
+#include "raw_convert.h"
+#include "util.h"
+#include "warnings.h"
+LIBDCP_DISABLE_WARNINGS
 #include <libxml++/libxml++.h>
+LIBDCP_ENABLE_WARNINGS
 #include <boost/algorithm/string.hpp>
 
+
 using std::string;
 using boost::function;
+using std::shared_ptr;
 using boost::optional;
+using namespace boost::filesystem;
 using namespace dcp;
 
-/** Create an Asset with a randomly-generated ID */
+
 Asset::Asset ()
 {
 
 }
 
-/** Create an Asset from a given file.
- *  @param file File name.
- */
-Asset::Asset (boost::filesystem::path file)
+
+Asset::Asset (path file)
        : _file (file)
 {
 
 }
 
-/** Create an Asset from a given file with a known ID.
- *  @param file File name.
- *  @param id ID.
- */
-Asset::Asset (string id, boost::filesystem::path file)
+
+Asset::Asset (string id, path file)
        : Object (id)
        , _file (file)
 {
 
 }
 
+
 void
-Asset::write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard standard) const
+Asset::add_to_pkl (shared_ptr<PKL> pkl, path root) const
 {
        DCP_ASSERT (_file);
 
-       optional<boost::filesystem::path> path = relative_to_root (
-               boost::filesystem::canonical (root),
-               boost::filesystem::canonical (_file.get())
+       auto path = relative_to_root (
+               canonical(root),
+               canonical(_file.get())
                );
 
        if (!path) {
@@ -92,22 +98,24 @@ Asset::write_to_pkl (xmlpp::Node* node, boost::filesystem::path root, Standard s
                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.get())));
-       asset->add_child("Type")->add_child_text (pkl_type (standard));
+       pkl->add_asset(_id, _id, hash(), file_size(_file.get()), pkl_type(pkl->standard()), _file->filename().string());
 }
 
+
 void
-Asset::write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const
+Asset::add_to_assetmap (AssetMap& asset_map, path root) const
 {
        DCP_ASSERT (_file);
+       add_file_to_assetmap (asset_map, root, _file.get(), _id);
+}
+
 
-       optional<boost::filesystem::path> path = relative_to_root (
-               boost::filesystem::canonical (root),
-               boost::filesystem::canonical (_file.get())
+void
+Asset::add_file_to_assetmap (AssetMap& asset_map, path root, path file, string id)
+{
+       auto path = relative_to_root (
+               canonical(root),
+               canonical(file)
                );
 
        if (!path) {
@@ -117,17 +125,10 @@ Asset::write_to_assetmap (xmlpp::Node* node, boost::filesystem::path root) const
                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.get())));
+       asset_map.add_asset(id, file, false);
 }
 
+
 string
 Asset::hash (function<void (float)> progress) const
 {
@@ -140,32 +141,55 @@ Asset::hash (function<void (float)> progress) const
        return _hash.get();
 }
 
+
 bool
-Asset::equals (boost::shared_ptr<const Asset> other, EqualityOptions, NoteHandler note) const
+Asset::equals(std::shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
 {
        if (_hash != other->_hash) {
-               note (DCP_ERROR, "Asset: hashes differ");
-               return false;
+               if (!opt.asset_hashes_can_differ) {
+                       note(NoteType::ERROR, "Asset: hashes differ");
+                       return false;
+               } else {
+                       note(NoteType::NOTE, "Asset: hashes differ");
+               }
        }
 
        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 (path file) const
+{
+       _file = absolute (file);
+       _hash = optional<string>();
+}
+
+
+void
+Asset::set_file_preserving_hash(path file) const
+{
+       _file = absolute(file);
+}
+
+
 void
-Asset::set_file (boost::filesystem::path file) const
+Asset::rename_file(path file)
 {
-       _file = boost::filesystem::absolute (file);
-       _hash = optional<string> ();
+       _file = absolute(file);
 }
 
+
 void
 Asset::set_hash (string hash)
 {
        _hash = hash;
 }
+
+
+void
+Asset::unset_hash()
+{
+       _hash = optional<string>();
+}
+