X-Git-Url: https://main.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Futil.cc;h=2aaeddb57e5501ee9c01769c302a08b96ddf7da3;hb=a65c9be7a5c455111b44b24690fe162413268b9f;hp=18fa1b173d556b2c856b528a4e8afd576353629a;hpb=532c59e443d110d3a04a25194bae8a13548ee599;p=libdcp.git diff --git a/src/util.cc b/src/util.cc index 18fa1b17..2aaeddb5 100644 --- a/src/util.cc +++ b/src/util.cc @@ -1,63 +1,93 @@ /* - Copyright (C) 2012 Carl Hetherington + Copyright (C) 2012-2020 Carl Hetherington - 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 . + + 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/util.cc * @brief Utility methods. */ -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include -#include "KM_util.h" -#include "KM_fileio.h" -#include "AS_DCP.h" #include "util.h" +#include "language_tag.h" #include "exceptions.h" #include "types.h" -#include "argb_frame.h" -#include "certificates.h" -#include "gamma_lut.h" +#include "certificate.h" +#include "openjpeg_image.h" +#include "dcp_assert.h" +#include "compose.hpp" +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include using std::string; +using std::wstring; using std::cout; -using std::stringstream; using std::min; using std::max; -using std::list; -using boost::shared_ptr; -using boost::lexical_cast; -using namespace libdcp; +using std::setw; +using std::setfill; +using std::ostream; +using std::shared_ptr; +using std::vector; +using boost::shared_array; +using boost::optional; +using boost::function; +using boost::algorithm::trim; +using namespace dcp; + + +/* Some ASDCP objects store this as a *&, for reasons which are not + * at all clear, so we have to keep this around forever. + */ +ASDCP::Dictionary const* dcp::asdcp_smpte_dict = 0; + /** Create a UUID. * @return UUID. */ string -libdcp::make_uuid () +dcp::make_uuid () { char buffer[64]; Kumu::UUID id; @@ -66,369 +96,374 @@ libdcp::make_uuid () return string (buffer); } +string +dcp::make_digest (ArrayData data) +{ + SHA_CTX sha; + SHA1_Init (&sha); + SHA1_Update (&sha, data.data(), data.size()); + byte_t byte_buffer[SHA_DIGEST_LENGTH]; + SHA1_Final (byte_buffer, &sha); + char digest[64]; + return Kumu::base64encode (byte_buffer, SHA_DIGEST_LENGTH, digest, 64); +} /** Create a digest for a file. * @param filename File name. + * @param progress Optional progress reporting function. The function will be called + * with a progress value between 0 and 1. * @return Digest. */ string -libdcp::make_digest (string filename) +dcp::make_digest (boost::filesystem::path filename, function progress) { Kumu::FileReader reader; - if (ASDCP_FAILURE (reader.OpenRead (filename.c_str ()))) { - boost::throw_exception (FileError ("could not open file to compute digest", filename)); + Kumu::Result_t r = reader.OpenRead (filename.string().c_str ()); + if (ASDCP_FAILURE (r)) { + boost::throw_exception (FileError ("could not open file to compute digest", filename, r)); } - + SHA_CTX sha; SHA1_Init (&sha); - - Kumu::ByteString read_buffer (65536); - int done = 0; + + int const buffer_size = 65536; + Kumu::ByteString read_buffer (buffer_size); + + Kumu::fsize_t done = 0; + Kumu::fsize_t const size = reader.Size (); while (1) { ui32_t read = 0; Kumu::Result_t r = reader.Read (read_buffer.Data(), read_buffer.Capacity(), &read); - + if (r == Kumu::RESULT_ENDOFFILE) { break; } else if (ASDCP_FAILURE (r)) { - boost::throw_exception (FileError ("could not read file to compute digest", filename)); + boost::throw_exception (FileError ("could not read file to compute digest", filename, r)); } - + SHA1_Update (&sha, read_buffer.Data(), read); - done += read; + + if (progress) { + progress (float (done) / size); + done += read; + } } - byte_t byte_buffer[20]; + byte_t byte_buffer[SHA_DIGEST_LENGTH]; SHA1_Final (byte_buffer, &sha); char digest[64]; - return Kumu::base64encode (byte_buffer, 20, digest, 64); + return Kumu::base64encode (byte_buffer, SHA_DIGEST_LENGTH, digest, 64); } -/** Convert a content kind to a string which can be used in a - * node. - * @param kind ContentKind. - * @return string. +/** @param s A string. + * @return true if the string contains only space, newline or tab characters, or is empty. */ -string -libdcp::content_kind_to_string (ContentKind kind) +bool +dcp::empty_or_white_space (string s) { - switch (kind) { - case FEATURE: - return "feature"; - case SHORT: - return "short"; - case TRAILER: - return "trailer"; - case TEST: - return "test"; - case TRANSITIONAL: - return "transitional"; - case RATING: - return "rating"; - case TEASER: - return "teaser"; - case POLICY: - return "policy"; - case PUBLIC_SERVICE_ANNOUNCEMENT: - return "psa"; - case ADVERTISEMENT: - return "advertisement"; + for (size_t i = 0; i < s.length(); ++i) { + if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') { + return false; + } } - assert (false); + return true; } -/** Convert a string from a node to a libdcp ContentKind. - * Reasonably tolerant about varying case. - * @param type Content kind string. - * @return libdcp ContentKind. +/** Set up various bits that the library needs. Should be called once + * by client applications. + * + * @param tags_directory Path to a copy of the tags directory from the source code; + * if none is specified libdcp will look for a tags directory inside the environment + * variable LIBDCP_SHARE_PREFIX or the LIBDCP_SHARE_PREFIX #defined during the build. */ -libdcp::ContentKind -libdcp::content_kind_from_string (string type) +void +dcp::init (optional tags_directory) { - /* XXX: should probably just convert type to lower-case and have done with it */ - - if (type == "feature") { - return FEATURE; - } else if (type == "short") { - return SHORT; - } else if (type == "trailer" || type == "Trailer") { - return TRAILER; - } else if (type == "test") { - return TEST; - } else if (type == "transitional") { - return TRANSITIONAL; - } else if (type == "rating") { - return RATING; - } else if (type == "teaser" || type == "Teaser") { - return TEASER; - } else if (type == "policy") { - return POLICY; - } else if (type == "psa") { - return PUBLIC_SERVICE_ANNOUNCEMENT; - } else if (type == "advertisement") { - return ADVERTISEMENT; + if (xmlSecInit() < 0) { + throw MiscError ("could not initialise xmlsec"); } - assert (false); -} +#ifdef XMLSEC_CRYPTO_DYNAMIC_LOADING + if (xmlSecCryptoDLLoadLibrary(BAD_CAST "openssl") < 0) { + throw MiscError ("unable to load openssl xmlsec-crypto library"); + } +#endif -/** Decompress a JPEG2000 image to a bitmap. - * @param data JPEG2000 data. - * @param size Size of data in bytes. - * @param reduce A power of 2 by which to reduce the size of the decoded image; - * e.g. 0 reduces by (2^0 == 1), ie keeping the same size. - * 1 reduces by (2^1 == 2), ie halving the size of the image. - * This is useful for scaling 4K DCP images down to 2K. - * @return openjpeg image, which the caller must call opj_image_destroy() on. - */ -opj_image_t * -libdcp::decompress_j2k (uint8_t* data, int64_t size, int reduce) -{ - opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K); - opj_dparameters_t parameters; - opj_set_default_decoder_parameters (¶meters); - parameters.cp_reduce = reduce; - opj_setup_decoder (decoder, ¶meters); - opj_cio_t* cio = opj_cio_open ((opj_common_ptr) decoder, data, size); - opj_image_t* image = opj_decode (decoder, cio); - if (!image) { - opj_destroy_decompress (decoder); - opj_cio_close (cio); - boost::throw_exception (DCPReadError ("could not decode JPEG2000 codestream of " + lexical_cast (size) + " bytes.")); + if (xmlSecCryptoAppInit(0) < 0) { + throw MiscError ("could not initialise crypto"); } - opj_cio_close (cio); + if (xmlSecCryptoInit() < 0) { + throw MiscError ("could not initialise xmlsec-crypto"); + } + + OpenSSL_add_all_algorithms(); + + asdcp_smpte_dict = &ASDCP::DefaultSMPTEDict(); + + if (!tags_directory) { + char* prefix = getenv("LIBDCP_SHARE_PREFIX"); + if (prefix) { + tags_directory = boost::filesystem::path(prefix) / "tags"; + } else { + tags_directory = LIBDCP_SHARE_PREFIX "/tags"; + } + } - image->x1 = rint (float(image->x1) / pow (2, reduce)); - image->y1 = rint (float(image->y1) / pow (2, reduce)); - return image; + load_language_tag_lists (*tags_directory); } -/** Convert an openjpeg XYZ image to RGB. - * @param xyz_frame Frame in XYZ. - * @return RGB image. +/** Decode a base64 string. The base64 decode routine in KM_util.cpp + * gives different values to both this and the command-line base64 + * for some inputs. Not sure why. + * + * @param in base64-encoded string. + * @param out Output buffer. + * @param out_length Length of output buffer. + * @return Number of characters written to the output buffer. */ -shared_ptr -libdcp::xyz_to_rgb (opj_image_t* xyz_frame, shared_ptr lut_in, shared_ptr lut_out) +int +dcp::base64_decode (string const & in, unsigned char* out, int out_length) { - float const dci_coefficient = 48.0 / 52.37; - - /* sRGB color matrix for XYZ -> RGB. This is the same as the one used by the Fraunhofer - EasyDCP player, I think. - */ - - float const colour_matrix[3][3] = { - { 3.24096989631653, -1.5373831987381, -0.498610764741898 }, - { -0.96924364566803, 1.87596750259399, 0.0415550582110882 }, - { 0.0556300804018974, -0.203976958990097, 1.05697154998779 } - }; - - int const max_colour = pow (2, lut_out->bit_depth()) - 1; - - struct { - double x, y, z; - } s; - - struct { - double r, g, b; - } d; - - int* xyz_x = xyz_frame->comps[0].data; - int* xyz_y = xyz_frame->comps[1].data; - int* xyz_z = xyz_frame->comps[2].data; - - shared_ptr argb_frame (new ARGBFrame (Size (xyz_frame->x1, xyz_frame->y1))); - - uint8_t* argb = argb_frame->data (); - - for (int y = 0; y < xyz_frame->y1; ++y) { - uint8_t* argb_line = argb; - for (int x = 0; x < xyz_frame->x1; ++x) { - - assert (*xyz_x >= 0 && *xyz_y >= 0 && *xyz_z >= 0 && *xyz_x < 4096 && *xyz_x < 4096 && *xyz_z < 4096); - - /* In gamma LUT */ - s.x = lut_in->lut()[*xyz_x++]; - s.y = lut_in->lut()[*xyz_y++]; - s.z = lut_in->lut()[*xyz_z++]; - - /* DCI companding */ - s.x /= dci_coefficient; - s.y /= dci_coefficient; - s.z /= dci_coefficient; - - /* XYZ to RGB */ - d.r = ((s.x * colour_matrix[0][0]) + (s.y * colour_matrix[0][1]) + (s.z * colour_matrix[0][2])); - d.g = ((s.x * colour_matrix[1][0]) + (s.y * colour_matrix[1][1]) + (s.z * colour_matrix[1][2])); - d.b = ((s.x * colour_matrix[2][0]) + (s.y * colour_matrix[2][1]) + (s.z * colour_matrix[2][2])); - - d.r = min (d.r, 1.0); - d.r = max (d.r, 0.0); - - d.g = min (d.g, 1.0); - d.g = max (d.g, 0.0); - - d.b = min (d.b, 1.0); - d.b = max (d.b, 0.0); - - /* Out gamma LUT */ - *argb_line++ = lut_out->lut()[(int) (d.b * max_colour)] * 0xff; - *argb_line++ = lut_out->lut()[(int) (d.g * max_colour)] * 0xff; - *argb_line++ = lut_out->lut()[(int) (d.r * max_colour)] * 0xff; - *argb_line++ = 0xff; + BIO* b64 = BIO_new (BIO_f_base64 ()); + + /* This means the input should have no newlines */ + BIO_set_flags (b64, BIO_FLAGS_BASE64_NO_NL); + + /* Copy our input string, removing newlines */ + char in_buffer[in.size() + 1]; + char* p = in_buffer; + for (size_t i = 0; i < in.size(); ++i) { + if (in[i] != '\n' && in[i] != '\r') { + *p++ = in[i]; } - - argb += argb_frame->stride (); } - return argb_frame; + BIO* bmem = BIO_new_mem_buf (in_buffer, p - in_buffer); + bmem = BIO_push (b64, bmem); + int const N = BIO_read (bmem, out, out_length); + BIO_free_all (bmem); + + return N; } -/** @param s A string. - * @return true if the string contains only space, newline or tab characters, or is empty. +/** @param p Path to open. + * @param t mode flags, as for fopen(3). + * @return FILE pointer or 0 on error. + * + * Apparently there is no way to create an ofstream using a UTF-8 + * filename under Windows. We are hence reduced to using fopen + * with this wrapper. */ -bool -libdcp::empty_or_white_space (string s) +FILE * +dcp::fopen_boost (boost::filesystem::path p, string t) { - for (size_t i = 0; i < s.length(); ++i) { - if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') { - return false; - } +#ifdef LIBDCP_WINDOWS + wstring w (t.begin(), t.end()); + /* c_str() here should give a UTF-16 string */ + return _wfopen (p.c_str(), w.c_str ()); +#else + return fopen (p.c_str(), t.c_str ()); +#endif +} + +optional +dcp::relative_to_root (boost::filesystem::path root, boost::filesystem::path file) +{ + boost::filesystem::path::const_iterator i = root.begin (); + boost::filesystem::path::const_iterator j = file.begin (); + + while (i != root.end() && j != file.end() && *i == *j) { + ++i; + ++j; } - return true; + if (i != root.end ()) { + return optional (); + } + + boost::filesystem::path rel; + while (j != file.end ()) { + rel /= *j++; + } + + return rel; } -void -libdcp::init () +bool +dcp::ids_equal (string a, string b) { - if (xmlSecInit() < 0) { - throw MiscError ("could not initialise xmlsec"); - } + transform (a.begin(), a.end(), a.begin(), ::tolower); + transform (b.begin(), b.end(), b.begin(), ::tolower); + trim (a); + trim (b); + return a == b; } -void -libdcp::add_signature_value (xmlpp::Element* parent, CertificateChain const & certificates, string const & signer_key, string const & ns) +string +dcp::file_to_string (boost::filesystem::path p, uintmax_t max_length) { - parent->add_child("SignatureValue", ns); - - xmlpp::Element* key_info = parent->add_child("KeyInfo", ns); - list > c = certificates.leaf_to_root (); - for (list >::iterator i = c.begin(); i != c.end(); ++i) { - xmlpp::Element* data = key_info->add_child("X509Data", ns); - - { - xmlpp::Element* serial = data->add_child("X509IssuerSerial", ns); - serial->add_child("X509IssuerName", ns)->add_child_text((*i)->issuer ()); - serial->add_child("X509SerialNumber", ns)->add_child_text((*i)->serial ()); - } - - data->add_child("X509Certificate", ns)->add_child_text((*i)->certificate()); + uintmax_t len = boost::filesystem::file_size (p); + if (len > max_length) { + throw MiscError (String::compose ("Unexpectedly long file (%1)", p.string())); } - xmlSecKeysMngrPtr keys_manager = xmlSecKeysMngrCreate(); - if (!keys_manager) { - throw MiscError ("could not create keys manager"); + FILE* f = fopen_boost (p, "r"); + if (!f) { + throw FileError ("could not open file", p, errno); } - - xmlSecDSigCtx signature_context; - - if (xmlSecDSigCtxInitialize (&signature_context, keys_manager) < 0) { - throw MiscError ("could not initialise XMLSEC context"); - } - - if (xmlSecDSigCtxSign (&signature_context, parent->cobj()) < 0) { - throw MiscError ("could not sign"); + + char* c = new char[len]; + /* This may read less than `len' if we are on Windows and we have CRLF in the file */ + int const N = fread (c, 1, len, f); + fclose (f); + + string s (c, N); + delete[] c; + + return s; +} + +/** @param key RSA private key in PEM format (optionally with -----BEGIN... / -----END...) + * @return SHA1 fingerprint of key + */ +string +dcp::private_key_fingerprint (string key) +{ + boost::replace_all (key, "-----BEGIN RSA PRIVATE KEY-----\n", ""); + boost::replace_all (key, "\n-----END RSA PRIVATE KEY-----\n", ""); + + unsigned char buffer[4096]; + int const N = base64_decode (key, buffer, sizeof (buffer)); + + SHA_CTX sha; + SHA1_Init (&sha); + SHA1_Update (&sha, buffer, N); + uint8_t digest[20]; + SHA1_Final (digest, &sha); + + char digest_base64[64]; + return Kumu::base64encode (digest, 20, digest_base64, 64); +} + +xmlpp::Node * +dcp::find_child (xmlpp::Node const * node, string name) +{ + xmlpp::Node::NodeList c = node->get_children (); + xmlpp::Node::NodeList::iterator i = c.begin(); + while (i != c.end() && (*i)->get_name() != name) { + ++i; } - - xmlSecDSigCtxFinalize (&signature_context); - xmlSecKeysMngrDestroy (keys_manager); + + DCP_ASSERT (i != c.end ()); + return *i; } +string +dcp::remove_urn_uuid (string raw) +{ + DCP_ASSERT (raw.substr(0, 9) == "urn:uuid:"); + return raw.substr (9); +} -void -libdcp::add_signer (xmlpp::Element* parent, CertificateChain const & certificates, string const & ns) +string +dcp::openjpeg_version () { - xmlpp::Element* signer = parent->add_child("Signer"); - - { - xmlpp::Element* data = signer->add_child("X509Data", ns); - - { - xmlpp::Element* serial_element = data->add_child("X509IssuerSerial", ns); - serial_element->add_child("X509IssuerName", ns)->add_child_text (certificates.leaf()->issuer()); - serial_element->add_child("X509SerialNumber", ns)->add_child_text (certificates.leaf()->serial()); - } - - data->add_child("X509SubjectName", ns)->add_child_text (certificates.leaf()->subject()); + return opj_version (); +} + +string +dcp::spaces (int n) +{ + string s = ""; + for (int i = 0; i < n; ++i) { + s += " "; } + return s; } void -libdcp::sign (xmlpp::Element* parent, CertificateChain const & certificates, string const & signer_key) +dcp::indent (xmlpp::Element* element, int initial) { - add_signer (parent, certificates, "dsig"); - - xmlpp::Element* signature = parent->add_child("Signature", "dsig"); - - { - xmlpp::Element* signed_info = signature->add_child ("SignedInfo", "dsig"); - signed_info->add_child("CanonicalizationMethod", "dsig")->set_attribute ("Algorithm", "http://www.w3.org/TR/2001/REC-xml-c14n-20010315"); - signed_info->add_child("SignatureMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2001/04/xmldsig-more#rsa-sha256"); - { - xmlpp::Element* reference = signed_info->add_child("Reference", "dsig"); - reference->set_attribute ("URI", ""); - { - xmlpp::Element* transforms = reference->add_child("Transforms", "dsig"); - transforms->add_child("Transform", "dsig")->set_attribute ( - "Algorithm", "http://www.w3.org/2000/09/xmldsig#enveloped-signature" - ); - } - reference->add_child("DigestMethod", "dsig")->set_attribute("Algorithm", "http://www.w3.org/2000/09/xmldsig#sha1"); - /* This will be filled in by the signing later */ - reference->add_child("DigestValue", "dsig"); + xmlpp::Node* last = 0; + for (auto n: element->get_children()) { + auto e = dynamic_cast(n); + if (e) { + element->add_child_text_before (e, "\n" + spaces(initial + 2)); + indent (e, initial + 2); + last = n; } } - - add_signature_value (signature, certificates, signer_key, "dsig"); + if (last) { + element->add_child_text (last, "\n" + spaces(initial)); + } } -bool libdcp::operator== (libdcp::Size const & a, libdcp::Size const & b) +/** @return true if the day represented by \ref a is less than or + * equal to the one represented by \ref b, ignoring the time parts. + */ +bool +dcp::day_less_than_or_equal (LocalTime a, LocalTime b) { - return (a.width == b.width && a.height == b.height); -} + if (a.year() != b.year()) { + return a.year() < b.year(); + } -bool libdcp::operator!= (libdcp::Size const & a, libdcp::Size const & b) -{ - return !(a == b); + if (a.month() != b.month()) { + return a.month() < b.month(); + } + + return a.day() <= b.day(); } -/** The base64 decode routine in KM_util.cpp gives different values to both - * this and the command-line base64 for some inputs. Not sure why. +/** @return true if the day represented by \ref a is greater than or + * equal to the one represented by \ref b, ignoring the time parts. */ -int -libdcp::base64_decode (string const & in, unsigned char* out, int out_length) +bool +dcp::day_greater_than_or_equal (LocalTime a, LocalTime b) { - BIO* b64 = BIO_new (BIO_f_base64 ()); + if (a.year() != b.year()) { + return a.year() > b.year(); + } - /* This means the input should have no newlines */ - BIO_set_flags (b64, BIO_FLAGS_BASE64_NO_NL); + if (a.month() != b.month()) { + return a.month() > b.month(); + } - /* Copy our input string, removing newlines */ - char in_buffer[in.size() + 1]; - char* p = in_buffer; - for (size_t i = 0; i < in.size(); ++i) { - if (in[i] != '\n' && in[i] != '\r') { - *p++ = in[i]; + return a.day() >= b.day(); +} + +/** Try quite hard to find a string which starts with \ref base and is + * not in \ref existing. + */ +string +dcp::unique_string (vector existing, string base) +{ + int const max_tries = existing.size() + 1; + for (int i = 0; i < max_tries; ++i) { + string trial = String::compose("%1%2", base, i); + if (find(existing.begin(), existing.end(), trial) == existing.end()) { + return trial; } } - - BIO* bmem = BIO_new_mem_buf (in_buffer, p - in_buffer); - bmem = BIO_push (b64, bmem); - int const N = BIO_read (bmem, out, out_length); - BIO_free_all (bmem); - return N; + DCP_ASSERT (false); +} + + +ASDCPErrorSuspender::ASDCPErrorSuspender () + : _old (Kumu::DefaultLogSink()) +{ + _sink = new Kumu::EntryListLogSink(_log); + Kumu::SetDefaultLogSink (_sink); } + + +ASDCPErrorSuspender::~ASDCPErrorSuspender () +{ + Kumu::SetDefaultLogSink (&_old); + delete _sink; +} +