X-Git-Url: https://git.carlh.net/gitweb/?a=blobdiff_plain;f=src%2Futil.cc;h=bbfcd30ebbfb9606d8f238b3545dcf89bbddd7a7;hb=refs%2Fheads%2Ftidy-eq-options;hp=15b833a1b01f7fff5dc6cbda54342845570832d0;hpb=e02bf26f284c6efc72593e6b4a251301144e5d0b;p=libdcp.git diff --git a/src/util.cc b/src/util.cc index 15b833a1..bbfcd30e 100644 --- a/src/util.cc +++ b/src/util.cc @@ -1,5 +1,5 @@ /* - Copyright (C) 2012-2014 Carl Hetherington + Copyright (C) 2012-2021 Carl Hetherington This file is part of libdcp. @@ -31,17 +31,23 @@ files in the program, then also delete it here. */ + /** @file src/util.cc - * @brief Utility methods. + * @brief Utility methods and classes */ -#include "util.h" -#include "exceptions.h" -#include "types.h" + #include "certificate.h" -#include "openjpeg_image.h" -#include "dcp_assert.h" #include "compose.hpp" +#include "dcp_assert.h" +#include "exceptions.h" +#include "file.h" +#include "language_tag.h" +#include "openjpeg_image.h" +#include "rating.h" +#include "types.h" +#include "util.h" +#include #include #include #include @@ -52,31 +58,39 @@ #include #include #include -#include #include +#if BOOST_VERSION >= 106100 +#include +#endif +#include #include #include #include + using std::string; using std::wstring; using std::cout; using std::min; using std::max; -using std::list; using std::setw; using std::setfill; using std::ostream; -using boost::shared_ptr; +using std::shared_ptr; +using std::vector; using boost::shared_array; using boost::optional; using boost::function; using boost::algorithm::trim; using namespace dcp; -/** Create a UUID. - * @return UUID. + +/* 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 = nullptr; + + string dcp::make_uuid () { @@ -88,19 +102,26 @@ dcp::make_uuid () } -/** 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 +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); +} + + string dcp::make_digest (boost::filesystem::path filename, function progress) { Kumu::FileReader reader; - 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)); + auto 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; @@ -111,14 +132,14 @@ dcp::make_digest (boost::filesystem::path filename, function progr Kumu::fsize_t done = 0; Kumu::fsize_t const size = reader.Size (); - while (1) { + while (true) { ui32_t read = 0; - Kumu::Result_t r = reader.Read (read_buffer.Data(), read_buffer.Capacity(), &read); + auto 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, r)); + boost::throw_exception (FileError("could not read file to compute digest", filename, r)); } SHA1_Update (&sha, read_buffer.Data(), read); @@ -136,103 +157,17 @@ dcp::make_digest (boost::filesystem::path filename, function progr return Kumu::base64encode (byte_buffer, SHA_DIGEST_LENGTH, digest, 64); } -/** Convert a content kind to a string which can be used in a - * <ContentKind> node. - * @param kind ContentKind. - * @return string. - */ -string -dcp::content_kind_to_string (ContentKind kind) -{ - 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"; - } - - DCP_ASSERT (false); -} - -/** Convert a string from a <ContentKind> node to a libdcp ContentKind. - * Reasonably tolerant about varying case. - * @param kind Content kind string. - * @return libdcp ContentKind. - */ -dcp::ContentKind -dcp::content_kind_from_string (string kind) -{ - transform (kind.begin(), kind.end(), kind.begin(), ::tolower); - - if (kind == "feature") { - return FEATURE; - } else if (kind == "short") { - return SHORT; - } else if (kind == "trailer") { - return TRAILER; - } else if (kind == "test") { - return TEST; - } else if (kind == "transitional") { - return TRANSITIONAL; - } else if (kind == "rating") { - return RATING; - } else if (kind == "teaser") { - return TEASER; - } else if (kind == "policy") { - return POLICY; - } else if (kind == "psa") { - return PUBLIC_SERVICE_ANNOUNCEMENT; - } else if (kind == "advertisement") { - return ADVERTISEMENT; - } - - DCP_ASSERT (false); -} -/** @param s A string. - * @return true if the string contains only space, newline or tab characters, or is empty. - */ -bool -dcp::empty_or_white_space (string s) -{ - for (size_t i = 0; i < s.length(); ++i) { - if (s[i] != ' ' && s[i] != '\n' && s[i] != '\t') { - return false; - } - } - - return true; -} - -/** Set up various bits that the library needs. Should be called one - * by client applications. - */ void -dcp::init () +dcp::init (optional given_resources_directory) { if (xmlSecInit() < 0) { throw MiscError ("could not initialise xmlsec"); } #ifdef XMLSEC_CRYPTO_DYNAMIC_LOADING - if (xmlSecCryptoDLLoadLibrary(BAD_CAST XMLSEC_CRYPTO) < 0) { - throw MiscError ("unable to load default xmlsec-crypto library"); + if (xmlSecCryptoDLLoadLibrary(BAD_CAST "openssl") < 0) { + throw MiscError ("unable to load openssl xmlsec-crypto library"); } #endif @@ -243,37 +178,22 @@ dcp::init () if (xmlSecCryptoInit() < 0) { throw MiscError ("could not initialise xmlsec-crypto"); } -} -bool dcp::operator== (dcp::Size const & a, dcp::Size const & b) -{ - return (a.width == b.width && a.height == b.height); -} + OpenSSL_add_all_algorithms(); -bool dcp::operator!= (dcp::Size const & a, dcp::Size const & b) -{ - return !(a == b); -} + asdcp_smpte_dict = &ASDCP::DefaultSMPTEDict(); -ostream& dcp::operator<< (ostream& s, dcp::Size const & a) -{ - s << a.width << "x" << a.height; - return s; + auto res = given_resources_directory.get_value_or(resources_directory()); + + load_language_tag_lists (res / "tags"); + load_rating_list (res / "ratings"); } -/** 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. - */ + int dcp::base64_decode (string const & in, unsigned char* out, int out_length) { - BIO* b64 = BIO_new (BIO_f_base64 ()); + auto b64 = BIO_new (BIO_f_base64()); /* This means the input should have no newlines */ BIO_set_flags (b64, BIO_FLAGS_BASE64_NO_NL); @@ -287,7 +207,7 @@ dcp::base64_decode (string const & in, unsigned char* out, int out_length) } } - BIO* bmem = BIO_new_mem_buf (in_buffer, p - in_buffer); + auto 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); @@ -295,49 +215,31 @@ dcp::base64_decode (string const & in, unsigned char* out, int out_length) return N; } -/** @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. - */ -FILE * -dcp::fopen_boost (boost::filesystem::path p, string t) -{ -#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 (); + auto i = root.begin (); + auto j = file.begin (); while (i != root.end() && j != file.end() && *i == *j) { ++i; ++j; } - if (i != root.end ()) { - return optional (); + if (i != root.end()) { + return {}; } boost::filesystem::path rel; - while (j != file.end ()) { + while (j != file.end()) { rel /= *j++; } return rel; } + bool dcp::ids_equal (string a, string b) { @@ -348,23 +250,23 @@ dcp::ids_equal (string a, string b) return a == b; } + string dcp::file_to_string (boost::filesystem::path p, uintmax_t max_length) { - uintmax_t len = boost::filesystem::file_size (p); + auto len = boost::filesystem::file_size (p); if (len > max_length) { - throw MiscError (String::compose ("Unexpectedly long file (%1)", p.string())); + throw MiscError (String::compose("Unexpectedly long file (%1)", p.string())); } - FILE* f = fopen_boost (p, "r"); + File f(p, "r"); if (!f) { throw FileError ("could not open file", p, errno); } 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); + int const N = f.read(c, 1, len); string s (c, N); delete[] c; @@ -372,14 +274,14 @@ dcp::file_to_string (boost::filesystem::path p, uintmax_t max_length) 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", ""); + boost::replace_all (key, "-----BEGIN PRIVATE KEY-----\n", ""); + boost::replace_all (key, "\n-----END PRIVATE KEY-----\n", ""); unsigned char buffer[4096]; int const N = base64_decode (key, buffer, sizeof (buffer)); @@ -394,11 +296,12 @@ dcp::private_key_fingerprint (string key) 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(); + auto c = node->get_children (); + auto i = c.begin(); while (i != c.end() && (*i)->get_name() != name) { ++i; } @@ -407,9 +310,141 @@ dcp::find_child (xmlpp::Node const * node, string name) return *i; } + string dcp::remove_urn_uuid (string raw) { - DCP_ASSERT (raw.substr(0, 9) == "urn:uuid:"); + if (raw.substr(0, 9) != "urn:uuid:") { + throw BadURNUUIDError(raw); + } + return raw.substr (9); } + + +string +dcp::openjpeg_version () +{ + return opj_version (); +} + + +string +dcp::spaces (int n) +{ + string s = ""; + for (int i = 0; i < n; ++i) { + s += " "; + } + return s; +} + + +void +dcp::indent (xmlpp::Element* element, int initial) +{ + xmlpp::Node* last = nullptr; + 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; + } + } + if (last) { + element->add_child_text (last, "\n" + spaces(initial)); + } +} + + +bool +dcp::day_less_than_or_equal (LocalTime a, LocalTime b) +{ + if (a.year() != b.year()) { + return a.year() < b.year(); + } + + if (a.month() != b.month()) { + return a.month() < b.month(); + } + + return a.day() <= b.day(); +} + + +bool +dcp::day_greater_than_or_equal (LocalTime a, LocalTime b) +{ + if (a.year() != b.year()) { + return a.year() > b.year(); + } + + if (a.month() != b.month()) { + return a.month() > b.month(); + } + + return a.day() >= b.day(); +} + + +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; + } + } + + DCP_ASSERT (false); +} + + +ASDCPErrorSuspender::ASDCPErrorSuspender () + : _old (Kumu::DefaultLogSink()) +{ + _sink = new Kumu::EntryListLogSink(_log); + Kumu::SetDefaultLogSink (_sink); +} + + +ASDCPErrorSuspender::~ASDCPErrorSuspender () +{ + Kumu::SetDefaultLogSink (&_old); + delete _sink; +} + + +boost::filesystem::path dcp::directory_containing_executable () +{ +#if BOOST_VERSION >= 106100 + return boost::filesystem::canonical(boost::dll::program_location().parent_path()); +#else + char buffer[PATH_MAX]; + ssize_t N = readlink ("/proc/self/exe", buffer, PATH_MAX); + return boost::filesystem::path(string(buffer, N)).parent_path(); +#endif +} + + +boost::filesystem::path dcp::resources_directory () +{ + /* We need a way to specify the tags directory for running un-installed binaries */ + char* prefix = getenv("LIBDCP_RESOURCES"); + if (prefix) { + return prefix; + } + +#if defined(LIBDCP_OSX) + return directory_containing_executable().parent_path() / "Resources"; +#elif defined(LIBDCP_WINDOWS) + return directory_containing_executable().parent_path(); +#else + return directory_containing_executable().parent_path() / "share" / "libdcp"; +#endif +} + +