src/pkl.cc

   1 /*
   2     Copyright (C) 2018-2021 Carl Hetherington <cth@carlh.net>
   3
   4     This file is part of libdcp.
   5
   6     libdcp is free software; you can redistribute it and/or modify
   7     it under the terms of the GNU General Public License as published by
   8     the Free Software Foundation; either version 2 of the License, or
   9     (at your option) any later version.
  10
  11     libdcp is distributed in the hope that it will be useful,
  12     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14     GNU General Public License for more details.
  15
  16     You should have received a copy of the GNU General Public License
  17     along with libdcp.  If not, see <http://www.gnu.org/licenses/>.
  18
  19     In addition, as a special exception, the copyright holders give
  20     permission to link the code of portions of this program with the
  21     OpenSSL library under certain conditions as described in each
  22     individual source file, and distribute linked combinations
  23     including the two.
  24
  25     You must obey the GNU General Public License in all respects
  26     for all of the code used other than OpenSSL.  If you modify
  27     file(s) with this exception, you may extend this exception to your
  28     version of the file(s), but you are not obligated to do so.  If you
  29     do not wish to do so, delete this exception statement from your
  30     version.  If you delete this exception statement from all source
  31     files in the program, then also delete it here.
  32 */
  33
  34
  35 /** @file  src/pkl.cc
  36  *  @brief PKL class
  37  */
  38
  39
  40 #include "dcp_assert.h"
  41 #include "exceptions.h"
  42 #include "pkl.h"
  43 #include "raw_convert.h"
  44 #include "util.h"
  45 #include "warnings.h"
  46 LIBDCP_DISABLE_WARNINGS
  47 #include <libxml++/libxml++.h>
  48 LIBDCP_ENABLE_WARNINGS
  49 #include <iostream>
  50
  51
  52 using std::string;
  53 using std::shared_ptr;
  54 using std::make_shared;
  55 using boost::optional;
  56 using namespace dcp;
  57
  58
  59 static string const pkl_interop_ns = "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#";
  60 static string const pkl_smpte_ns   = "http://www.smpte-ra.org/schemas/429-8/2007/PKL";
  61
  62
  63 PKL::PKL (boost::filesystem::path file)
  64         : _file (file)
  65 {
  66         cxml::Document pkl ("PackingList");
  67         pkl.read_file (file);
  68
  69         if (pkl.namespace_uri() == pkl_interop_ns) {
  70                 _standard = Standard::INTEROP;
  71         } else if (pkl.namespace_uri() == pkl_smpte_ns) {
  72                 _standard = Standard::SMPTE;
  73         } else {
  74                 boost::throw_exception(XMLError("Unrecognised packing list namespace " + pkl.namespace_uri()));
  75         }
  76
  77         _id = remove_urn_uuid (pkl.string_child ("Id"));
  78         _annotation_text = pkl.optional_string_child ("AnnotationText");
  79         _issue_date = pkl.string_child ("IssueDate");
  80         _issuer = pkl.string_child ("Issuer");
  81         _creator = pkl.string_child ("Creator");
  82
  83         for (auto i: pkl.node_child("AssetList")->node_children("Asset")) {
  84                 _assets.push_back(make_shared<Asset>(i));
  85         }
  86 }
  87
  88
  89 void
  90 PKL::add_asset(std::string id, boost::optional<std::string> annotation_text, std::string hash, int64_t size, std::string type, std::string original_filename)
  91 {
  92         _assets.push_back(make_shared<Asset>(id, annotation_text, hash, size, type, original_filename));
  93 }
  94
  95
  96 void
  97 PKL::write_xml (boost::filesystem::path file, shared_ptr<const CertificateChain> signer) const
  98 {
  99         xmlpp::Document doc;
 100         xmlpp::Element* pkl;
 101         if (_standard == Standard::INTEROP) {
 102                 pkl = doc.create_root_node("PackingList", pkl_interop_ns);
 103         } else {
 104                 pkl = doc.create_root_node("PackingList", pkl_smpte_ns);
 105         }
 106
 107         pkl->add_child("Id")->add_child_text ("urn:uuid:" + _id);
 108         if (_annotation_text) {
 109                 pkl->add_child("AnnotationText")->add_child_text (*_annotation_text);
 110         }
 111         pkl->add_child("IssueDate")->add_child_text (_issue_date);
 112         pkl->add_child("Issuer")->add_child_text (_issuer);
 113         pkl->add_child("Creator")->add_child_text (_creator);
 114
 115         auto asset_list = pkl->add_child("AssetList");
 116         for (auto i: _assets) {
 117                 auto asset = asset_list->add_child("Asset");
 118                 asset->add_child("Id")->add_child_text ("urn:uuid:" + i->id());
 119                 if (i->annotation_text()) {
 120                         asset->add_child("AnnotationText")->add_child_text (*i->annotation_text());
 121                 }
 122                 asset->add_child("Hash")->add_child_text (i->hash());
 123                 asset->add_child("Size")->add_child_text (raw_convert<string>(i->size()));
 124                 asset->add_child("Type")->add_child_text (i->type());
 125                 if (auto filename = i->original_filename()) {
 126                         asset->add_child("OriginalFileName")->add_child_text(*filename);
 127                 }
 128         }
 129
 130         indent (pkl, 0);
 131
 132         if (signer) {
 133                 signer->sign (pkl, _standard);
 134         }
 135
 136         doc.write_to_file_formatted (file.string(), "UTF-8");
 137         _file = file;
 138 }
 139
 140
 141 optional<string>
 142 PKL::hash (string id) const
 143 {
 144         for (auto i: _assets) {
 145                 if (i->id() == id) {
 146                         return i->hash();
 147                 }
 148         }
 149
 150         return {};
 151 }
 152
 153
 154 optional<string>
 155 PKL::type (string id) const
 156 {
 157         for (auto i: _assets) {
 158                 if (i->id() == id) {
 159                         return i->type();
 160                 }
 161         }
 162
 163         return {};
 164 }
 165
 166
 167 void
 168 PKL::clear_assets()
 169 {
 170         _assets.clear();
 171 }