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 #include "pkl.h"
  36 #include "exceptions.h"
  37 #include "util.h"
  38 #include "raw_convert.h"
  39 #include "dcp_assert.h"
  40 #include <libxml++/libxml++.h>
  41 #include <iostream>
  42
  43
  44 using std::string;
  45 using std::shared_ptr;
  46 using std::make_shared;
  47 using boost::optional;
  48 using namespace dcp;
  49
  50
  51 static string const pkl_interop_ns = "http://www.digicine.com/PROTO-ASDCP-PKL-20040311#";
  52 static string const pkl_smpte_ns   = "http://www.smpte-ra.org/schemas/429-8/2007/PKL";
  53
  54
  55 PKL::PKL (boost::filesystem::path file)
  56         : _file (file)
  57 {
  58         cxml::Document pkl ("PackingList");
  59         pkl.read_file (file);
  60
  61         if (pkl.namespace_uri() == pkl_interop_ns) {
  62                 _standard = Standard::INTEROP;
  63         } else if (pkl.namespace_uri() == pkl_smpte_ns) {
  64                 _standard = Standard::SMPTE;
  65         } else {
  66                 boost::throw_exception (XMLError ("Unrecognised packing list namesapce " + pkl.namespace_uri()));
  67         }
  68
  69         _id = remove_urn_uuid (pkl.string_child ("Id"));
  70         _annotation_text = pkl.optional_string_child ("AnnotationText");
  71         _issue_date = pkl.string_child ("IssueDate");
  72         _issuer = pkl.string_child ("Issuer");
  73         _creator = pkl.string_child ("Creator");
  74
  75         for (auto i: pkl.node_child("AssetList")->node_children("Asset")) {
  76                 _asset_list.push_back (make_shared<Asset>(i));
  77         }
  78 }
  79
  80
  81 void
  82 PKL::add_asset (std::string id, boost::optional<std::string> annotation_text, std::string hash, int64_t size, std::string type)
  83 {
  84         _asset_list.push_back (make_shared<Asset>(id, annotation_text, hash, size, type));
  85 }
  86
  87
  88 void
  89 PKL::write (boost::filesystem::path file, shared_ptr<const CertificateChain> signer) const
  90 {
  91         xmlpp::Document doc;
  92         xmlpp::Element* pkl;
  93         if (_standard == Standard::INTEROP) {
  94                 pkl = doc.create_root_node("PackingList", pkl_interop_ns);
  95         } else {
  96                 pkl = doc.create_root_node("PackingList", pkl_smpte_ns);
  97         }
  98
  99         pkl->add_child("Id")->add_child_text ("urn:uuid:" + _id);
 100         if (_annotation_text) {
 101                 pkl->add_child("AnnotationText")->add_child_text (*_annotation_text);
 102         }
 103         pkl->add_child("IssueDate")->add_child_text (_issue_date);
 104         pkl->add_child("Issuer")->add_child_text (_issuer);
 105         pkl->add_child("Creator")->add_child_text (_creator);
 106
 107         auto asset_list = pkl->add_child("AssetList");
 108         for (auto i: _asset_list) {
 109                 auto asset = asset_list->add_child("Asset");
 110                 asset->add_child("Id")->add_child_text ("urn:uuid:" + i->id());
 111                 if (i->annotation_text()) {
 112                         asset->add_child("AnnotationText")->add_child_text (*i->annotation_text());
 113                 }
 114                 asset->add_child("Hash")->add_child_text (i->hash());
 115                 asset->add_child("Size")->add_child_text (raw_convert<string>(i->size()));
 116                 asset->add_child("Type")->add_child_text (i->type());
 117         }
 118
 119         indent (pkl, 0);
 120
 121         if (signer) {
 122                 signer->sign (pkl, _standard);
 123         }
 124
 125         doc.write_to_file_formatted (file.string(), "UTF-8");
 126         _file = file;
 127 }
 128
 129
 130 optional<string>
 131 PKL::hash (string id) const
 132 {
 133         for (auto i: _asset_list) {
 134                 if (i->id() == id) {
 135                         return i->hash();
 136                 }
 137         }
 138
 139         return {};
 140 }
 141
 142
 143 optional<string>
 144 PKL::type (string id) const
 145 {
 146         for (auto i: _asset_list) {
 147                 if (i->id() == id) {
 148                         return i->type();
 149                 }
 150         }
 151
 152         return {};
 153 }