Add asset_hashes_can_differ option to the equality checks.
[libdcp.git] / src / asset.cc
index 43db41e30cbb669f3b4b98c34eebdea5c9974648..330bd653082fcb1ff6441322b06c640ee76f7ca7 100644 (file)
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2021 Carl Hetherington <cth@carlh.net>
 
-    This program is free software; you can redistribute it and/or modify
+    This file is part of libdcp.
+
+    libdcp is free software; you can redistribute it and/or modify
     it under the terms of the GNU General Public License as published by
     the Free Software Foundation; either version 2 of the License, or
     (at your option) any later version.
 
-    This program is distributed in the hope that it will be useful,
+    libdcp is distributed in the hope that it will be useful,
     but WITHOUT ANY WARRANTY; without even the implied warranty of
     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
     GNU General Public License for more details.
 
     You should have received a copy of the GNU General Public License
-    along with this program; if not, write to the Free Software
-    Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
-
+    along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
+
+    In addition, as a special exception, the copyright holders give
+    permission to link the code of portions of this program with the
+    OpenSSL library under certain conditions as described in each
+    individual source file, and distribute linked combinations
+    including the two.
+
+    You must obey the GNU General Public License in all respects
+    for all of the code used other than OpenSSL.  If you modify
+    file(s) with this exception, you may extend this exception to your
+    version of the file(s), but you are not obligated to do so.  If you
+    do not wish to do so, delete this exception statement from your
+    version.  If you delete this exception statement from all source
+    files in the program, then also delete it here.
 */
 
+
 /** @file  src/asset.cc
- *  @brief Asset class.
+ *  @brief Asset class
  */
 
+
 #include "asset.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>
-#include <boost/lexical_cast.hpp>
+LIBDCP_ENABLE_WARNINGS
+#include <boost/algorithm/string.hpp>
+
 
 using std::string;
-using boost::lexical_cast;
 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.  The ID will
- *  be extracted from the file.
- *  @param file File name.
- */
-Asset::Asset (boost::filesystem::path file)
+
+Asset::Asset (path file)
        : _file (file)
 {
 
 }
 
-/** Create an Asset with a specified ID.
- *  @param id ID to use.
- */
-Asset::Asset (string id)
+
+Asset::Asset (string id, path file)
        : Object (id)
+       , _file (file)
 {
 
 }
 
+
 void
-Asset::write_to_pkl (xmlpp::Node* node) const
+Asset::add_to_pkl (shared_ptr<PKL> pkl, path root) const
 {
-       assert (!_file.empty ());
-       
-       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 (lexical_cast<string> (boost::filesystem::file_size (_file)));
-       asset->add_child("Type")->add_child_text (pkl_type ());
+       DCP_ASSERT (_file);
+
+       auto path = relative_to_root (
+               canonical(root),
+               canonical(_file.get())
+               );
+
+       if (!path) {
+               /* The path of this asset is not within our DCP, so we assume it's an external
+                  (referenced) one.
+               */
+               return;
+       }
+
+       pkl->add_asset(_id, _id, hash(), file_size(_file.get()), pkl_type(pkl->standard()), _file->filename().string());
 }
 
+
+void
+Asset::add_to_assetmap (AssetMap& asset_map, path root) const
+{
+       DCP_ASSERT (_file);
+       add_file_to_assetmap (asset_map, root, _file.get(), _id);
+}
+
+
 void
-Asset::write_to_assetmap (xmlpp::Node* node) const
+Asset::add_file_to_assetmap (AssetMap& asset_map, path root, path file, string id)
 {
-       assert (!_file.empty ());
-
-       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 (_file.string ());
-       chunk->add_child("VolumeIndex")->add_child_text ("1");
-       chunk->add_child("Offset")->add_child_text ("0");
-       chunk->add_child("Length")->add_child_text (lexical_cast<string> (boost::filesystem::file_size (_file)));
+       auto path = relative_to_root (
+               canonical(root),
+               canonical(file)
+               );
+
+       if (!path) {
+               /* The path of this asset is not within our DCP, so we assume it's an external
+                  (referenced) one.
+               */
+               return;
+       }
+
+       asset_map.add_asset(id, file, false);
 }
 
+
 string
-Asset::hash () const
+Asset::hash (function<void (float)> progress) const
 {
-       assert (!_file.empty ());
-               
-       if (!_hash.empty ()) {
-               _hash = make_digest (_file, 0);
+       DCP_ASSERT (_file);
+
+       if (!_hash) {
+               _hash = make_digest (_file.get(), progress);
        }
 
-       return _hash;
+       return _hash.get();
 }
 
+
 bool
-Asset::equals (boost::shared_ptr<const Asset> other, EqualityOptions, function<void (NoteType, string)> note) const
+Asset::equals(std::shared_ptr<const Asset> other, EqualityOptions opt, NoteHandler note) const
 {
        if (_hash != other->_hash) {
-               note (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;
 }
+
+
+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::rename_file(path file)
+{
+       _file = absolute(file);
+}
+
+
+void
+Asset::set_hash (string hash)
+{
+       _hash = hash;
+}
+
+
+void
+Asset::unset_hash()
+{
+       _hash = optional<string>();
+}
+