src/pkl.h

   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 #ifndef LIBDCP_PKL_H
  41 #define LIBDCP_PKL_H
  42
  43
  44 #include "asset_list.h"
  45 #include "object.h"
  46 #include "util.h"
  47 #include "certificate_chain.h"
  48 #include <libcxml/cxml.h>
  49 #include <boost/filesystem.hpp>
  50
  51
  52 namespace dcp {
  53
  54
  55 class PKL : public Object, public AssetList
  56 {
  57 public:
  58         PKL (Standard standard, boost::optional<std::string> annotation_text, std::string issue_date, std::string issuer, std::string creator)
  59                 : AssetList(standard, annotation_text, issue_date, issuer, creator)
  60         {}
  61
  62         explicit PKL (boost::filesystem::path file);
  63
  64         boost::optional<std::string> hash (std::string id) const;
  65         boost::optional<std::string> type (std::string id) const;
  66
  67         void clear_assets();
  68         void add_asset(std::string id, boost::optional<std::string> annotation_text, std::string hash, int64_t size, std::string type, std::string original_filename);
  69         void write_xml (boost::filesystem::path file, std::shared_ptr<const CertificateChain> signer) const;
  70
  71         /** @return the most recent disk file used to read or write this PKL, if there is one */
  72         boost::optional<boost::filesystem::path> file () const {
  73                 return _file;
  74         }
  75
  76         class Asset : public Object
  77         {
  78         public:
  79                 Asset (cxml::ConstNodePtr node)
  80                         : Object (remove_urn_uuid(node->string_child("Id")))
  81                         , _annotation_text (node->optional_string_child("AnnotationText"))
  82                         , _hash (node->string_child("Hash"))
  83                         , _size (node->number_child<int64_t>("Size"))
  84                         , _type (node->string_child("Type"))
  85                         , _original_filename(node->optional_string_child("OriginalFileName"))
  86                 {}
  87
  88                 Asset(std::string id, boost::optional<std::string> annotation_text, std::string hash, int64_t size, std::string type, std::string original_filename)
  89                         : Object (id)
  90                         , _annotation_text (annotation_text)
  91                         , _hash (hash)
  92                         , _size (size)
  93                         , _type (type)
  94                         , _original_filename(original_filename)
  95                 {}
  96
  97                 boost::optional<std::string> annotation_text () const {
  98                         return _annotation_text;
  99                 }
 100
 101                 std::string hash () const {
 102                         return _hash;
 103                 }
 104
 105                 int64_t size () const {
 106                         return _size;
 107                 }
 108
 109                 std::string type () const {
 110                         return _type;
 111                 }
 112
 113                 boost::optional<std::string> original_filename() const {
 114                         return _original_filename;
 115                 }
 116
 117         private:
 118                 boost::optional<std::string> _annotation_text;
 119                 std::string _hash;
 120                 int64_t _size = 0;
 121                 std::string _type;
 122                 boost::optional<std::string> _original_filename;
 123         };
 124
 125         std::vector<std::shared_ptr<Asset>> assets() const {
 126                 return _assets;
 127         }
 128
 129 private:
 130         std::vector<std::shared_ptr<Asset>> _assets;
 131         /** The most recent disk file used to read or write this PKL */
 132         mutable boost::optional<boost::filesystem::path> _file;
 133 };
 134
 135
 136 }
 137
 138
 139 #endif