Add OK note when PKL and CPL annotation texts match.
[libdcp.git] / src / dcp.cc
index 5da4bbd6b1c862636347c5ea6bd300ccd36522e5..2906d575a73b1a167037184cae76b09c3a2a5b82 100644 (file)
@@ -47,6 +47,7 @@
 #include "decrypted_kdm.h"
 #include "decrypted_kdm_key.h"
 #include "exceptions.h"
+#include "filesystem.h"
 #include "font_asset.h"
 #include "interop_subtitle_asset.h"
 #include "metadata.h"
@@ -71,7 +72,6 @@ LIBDCP_DISABLE_WARNINGS
 #include <libxml++/libxml++.h>
 LIBDCP_ENABLE_WARNINGS
 #include <boost/algorithm/string.hpp>
-#include <boost/filesystem.hpp>
 #include <numeric>
 
 
@@ -98,11 +98,40 @@ static string const volindex_smpte_ns   = "http://www.smpte-ra.org/schemas/429-9
 DCP::DCP (boost::filesystem::path directory)
        : _directory (directory)
 {
-       if (!boost::filesystem::exists (directory)) {
-               boost::filesystem::create_directories (directory);
+       if (!filesystem::exists(directory)) {
+               filesystem::create_directories(directory);
        }
 
-       _directory = boost::filesystem::canonical (_directory);
+       _directory = filesystem::canonical(_directory);
+}
+
+
+DCP::DCP(DCP&& other)
+       : _directory(std::move(other._directory))
+       , _cpls(std::move(other._cpls))
+       , _pkls(std::move(other._pkls))
+       , _asset_map(std::move(other._asset_map))
+       , _new_issuer(std::move(other._new_issuer))
+       , _new_creator(std::move(other._new_creator))
+       , _new_issue_date(std::move(other._new_issue_date))
+       , _new_annotation_text(std::move(other._new_annotation_text))
+{
+
+}
+
+
+DCP&
+DCP::operator=(DCP&& other)
+{
+       _directory = std::move(other._directory);
+       _cpls = std::move(other._cpls);
+       _pkls = std::move(other._pkls);
+       _asset_map = std::move(other._asset_map);
+       _new_issuer = std::move(other._new_issuer);
+       _new_creator = std::move(other._new_creator);
+       _new_issue_date = std::move(other._new_issue_date);
+       _new_annotation_text = std::move(other._new_annotation_text);
+       return *this;
 }
 
 
@@ -112,9 +141,9 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
        /* Read the ASSETMAP and PKL */
 
        boost::filesystem::path asset_map_path;
-       if (boost::filesystem::exists(_directory / "ASSETMAP")) {
+       if (filesystem::exists(_directory / "ASSETMAP")) {
                asset_map_path = _directory / "ASSETMAP";
-       } else if (boost::filesystem::exists(_directory / "ASSETMAP.xml")) {
+       } else if (filesystem::exists(_directory / "ASSETMAP.xml")) {
                asset_map_path = _directory / "ASSETMAP.xml";
        } else {
                boost::throw_exception(MissingAssetmapError(_directory));
@@ -145,8 +174,9 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
        vector<shared_ptr<Asset>> other_assets;
 
        auto ids_and_paths = _asset_map->asset_ids_and_paths();
-       for (auto i: ids_and_paths) {
-               auto path = i.second;
+       for (auto id_and_path: ids_and_paths) {
+               auto const id = id_and_path.first;
+               auto const path = id_and_path.second;
 
                if (path == _directory) {
                        /* I can't see how this is valid, but it's
@@ -159,7 +189,7 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
                        continue;
                }
 
-               if (!boost::filesystem::exists(path)) {
+               if (!filesystem::exists(path)) {
                        if (notes) {
                                notes->push_back ({VerificationNote::Type::ERROR, VerificationNote::Code::MISSING_ASSET, path});
                        }
@@ -169,7 +199,7 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
                /* Find the <Type> for this asset from the PKL that contains the asset */
                optional<string> pkl_type;
                for (auto j: _pkls) {
-                       pkl_type = j->type(i.first);
+                       pkl_type = j->type(id);
                        if (pkl_type) {
                                break;
                        }
@@ -194,7 +224,7 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
                        pkl_type == remove_parameters(InteropSubtitleAsset::static_pkl_type(standard))) {
                        auto p = new xmlpp::DomParser;
                        try {
-                               p->parse_file (path.string());
+                               p->parse_file(dcp::filesystem::fix_long_path(path).string());
                        } catch (std::exception& e) {
                                delete p;
                                throw ReadError(String::compose("XML error in %1", path.string()), e.what());
@@ -223,12 +253,16 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
                        ) {
 
                        bool found_threed_marked_as_twod = false;
-                       other_assets.push_back (asset_factory(path, ignore_incorrect_picture_mxf_type, &found_threed_marked_as_twod));
+                       auto asset = asset_factory(path, ignore_incorrect_picture_mxf_type, &found_threed_marked_as_twod);
+                       if (asset->id() != id) {
+                               notes->push_back(VerificationNote(VerificationNote::Type::ERROR, VerificationNote::Code::MISMATCHED_ASSET_MAP_ID).set_id(id).set_other_id(asset->id()));
+                       }
+                       other_assets.push_back(asset);
                        if (found_threed_marked_as_twod && notes) {
                                notes->push_back ({VerificationNote::Type::WARNING, VerificationNote::Code::THREED_ASSET_MARKED_AS_TWOD, path});
                        }
                } else if (*pkl_type == remove_parameters(FontAsset::static_pkl_type(standard))) {
-                       other_assets.push_back (make_shared<FontAsset>(i.first, path));
+                       other_assets.push_back(make_shared<FontAsset>(id, path));
                } else if (*pkl_type == "image/png") {
                        /* It's an Interop PNG subtitle; let it go */
                } else {
@@ -236,6 +270,48 @@ DCP::read (vector<dcp::VerificationNote>* notes, bool ignore_incorrect_picture_m
                }
        }
 
+       /* Set hashes for assets where we have an idea of what the hash should be in either a CPL or PKL.
+        * This means that when the hash is later read from these objects the result will be the one that
+        * it should be, rather the one that it currently is.  This should prevent errors being concealed
+        * when an asset is corrupted - the hash from the CPL/PKL will disagree with the actual hash of the
+        * file, revealing the problem.
+        */
+
+       auto hash_from_pkl = [this](string id) -> optional<string> {
+               for (auto pkl: _pkls) {
+                       if (auto pkl_hash = pkl->hash(id)) {
+                               return pkl_hash;
+                       }
+               }
+
+               return {};
+       };
+
+       auto hash_from_cpl_or_pkl = [this, &hash_from_pkl](string id) -> optional<string> {
+               for (auto cpl: cpls()) {
+                       for (auto reel_file_asset: cpl->reel_file_assets()) {
+                               if (reel_file_asset->asset_ref().id() == id && reel_file_asset->hash()) {
+                                       return reel_file_asset->hash();
+                               }
+                       }
+               }
+
+               return hash_from_pkl(id);
+       };
+
+       for (auto asset: other_assets) {
+               if (auto hash = hash_from_cpl_or_pkl(asset->id())) {
+                       asset->set_hash(*hash);
+               }
+       }
+
+       for (auto cpl: cpls()) {
+               if (auto hash = hash_from_pkl(cpl->id())) {
+                       cpl->set_hash(*hash);
+               }
+       }
+
+       /* Resolve references */
        resolve_refs (other_assets);
 
        /* While we've got the ASSETMAP lets look and see if this DCP refers to things that are not in its ASSETMAP */
@@ -261,7 +337,7 @@ DCP::resolve_refs (vector<shared_ptr<Asset>> assets)
 
 
 bool
-DCP::equals (DCP const & other, EqualityOptions opt, NoteHandler note) const
+DCP::equals(DCP const & other, EqualityOptions const& opt, NoteHandler note) const
 {
        auto a = cpls ();
        auto b = other.cpls ();
@@ -365,20 +441,13 @@ DCP::write_volindex (Standard standard) const
                DCP_ASSERT (false);
        }
 
-       root->add_child("Index")->add_child_text ("1");
-       doc.write_to_file_formatted (p.string (), "UTF-8");
+       cxml::add_text_child(root, "Index", "1");
+       doc.write_to_file_formatted(dcp::filesystem::fix_long_path(p).string(), "UTF-8");
 }
 
 
 void
-DCP::write_xml (
-       string issuer,
-       string creator,
-       string issue_date,
-       string annotation_text,
-       shared_ptr<const CertificateChain> signer,
-       NameFormat name_format
-       )
+DCP::write_xml(shared_ptr<const CertificateChain> signer, bool include_mca_subdescriptors, NameFormat name_format)
 {
        if (_cpls.empty()) {
                throw MiscError ("Cannot write DCP with no CPLs.");
@@ -397,28 +466,42 @@ DCP::write_xml (
        for (auto i: cpls()) {
                NameFormat::Map values;
                values['t'] = "cpl";
-               i->write_xml (_directory / (name_format.get(values, "_" + i->id() + ".xml")), signer);
+               i->write_xml(_directory / (name_format.get(values, "_" + i->id() + ".xml")), signer, include_mca_subdescriptors);
        }
 
-       shared_ptr<PKL> pkl;
-
        if (_pkls.empty()) {
-               pkl = make_shared<PKL>(standard, annotation_text, issue_date, issuer, creator);
-               _pkls.push_back (pkl);
-               for (auto i: assets()) {
-                       i->add_to_pkl (pkl, _directory);
-               }
-        } else {
-               pkl = _pkls.front ();
+               _pkls.push_back(
+                       make_shared<PKL>(
+                               standard,
+                               _new_annotation_text.get_value_or(String::compose("Created by libdcp %1", dcp::version)),
+                               _new_issue_date.get_value_or(LocalTime().as_string()),
+                               _new_issuer.get_value_or(String::compose("libdcp %1", dcp::version)),
+                               _new_creator.get_value_or(String::compose("libdcp %1", dcp::version))
+                               )
+                       );
+       }
+
+       auto pkl = _pkls.front();
+
+       /* The assets may have changed since we read the PKL, so re-add them */
+       pkl->clear_assets();
+       for (auto asset: assets()) {
+               asset->add_to_pkl(pkl, _directory);
        }
 
        NameFormat::Map values;
        values['t'] = "pkl";
        auto pkl_path = _directory / name_format.get(values, "_" + pkl->id() + ".xml");
-       pkl->write (pkl_path, signer);
+       pkl->write_xml (pkl_path, signer);
 
        if (!_asset_map) {
-               _asset_map = AssetMap(standard, annotation_text, issue_date, issuer, creator);
+               _asset_map = AssetMap(
+                       standard,
+                       _new_annotation_text.get_value_or(String::compose("Created by libdcp %1", dcp::version)),
+                       _new_issue_date.get_value_or(LocalTime().as_string()),
+                       _new_issuer.get_value_or(String::compose("libdcp %1", dcp::version)),
+                       _new_creator.get_value_or(String::compose("libdcp %1", dcp::version))
+                       );
        }
 
        /* The assets may have changed since we read the asset map, so re-add them */
@@ -455,20 +538,13 @@ DCP::assets (bool ignore_unresolved) const
                        }
 
                        auto const id = j->asset_ref().id();
-                       auto already_got = false;
-                       for (auto k: assets) {
-                               if (k->id() == id) {
-                                       already_got = true;
-                               }
-                       }
-
-                       if (!already_got) {
+                       if (std::find_if(assets.begin(), assets.end(), [id](shared_ptr<Asset> asset) { return asset->id() == id; }) == assets.end()) {
                                auto o = j->asset_ref().asset();
                                assets.push_back (o);
                                /* More Interop special-casing */
                                auto sub = dynamic_pointer_cast<InteropSubtitleAsset>(o);
                                if (sub) {
-                                       sub->add_font_assets (assets);
+                                       add_to_container(assets, sub->font_assets());
                                }
                        }
                }
@@ -490,3 +566,56 @@ DCP::directories_from_files (vector<boost::filesystem::path> files)
        }
        return d;
 }
+
+
+void
+DCP::set_issuer(string issuer)
+{
+       for (auto pkl: _pkls) {
+               pkl->set_issuer(issuer);
+       }
+       if (_asset_map) {
+               _asset_map->set_issuer(issuer);
+       }
+       _new_issuer = issuer;
+}
+
+
+void
+DCP::set_creator(string creator)
+{
+       for (auto pkl: _pkls) {
+               pkl->set_creator(creator);
+       }
+       if (_asset_map) {
+               _asset_map->set_creator(creator);
+       }
+       _new_creator = creator;
+}
+
+
+void
+DCP::set_issue_date(string issue_date)
+{
+       for (auto pkl: _pkls) {
+               pkl->set_issue_date(issue_date);
+       }
+       if (_asset_map) {
+               _asset_map->set_issue_date(issue_date);
+       }
+       _new_issue_date = issue_date;
+}
+
+
+void
+DCP::set_annotation_text(string annotation_text)
+{
+       for (auto pkl: _pkls) {
+               pkl->set_annotation_text(annotation_text);
+       }
+       if (_asset_map) {
+               _asset_map->set_annotation_text(annotation_text);
+       }
+       _new_annotation_text = annotation_text;
+}
+