Tiny optimisation; Object default constructor calls make_uuid.
[libdcp.git] / src / util.cc
index e26e66be421760a9b5ad1d04818b75dc62dccba8..86d1bc87d2810e0bfe7f3632e4509b586015447e 100644 (file)
 #include "util.h"
 #include "exceptions.h"
 #include "types.h"
-#include "argb_frame.h"
 #include "certificates.h"
-#include "gamma_lut.h"
-#include "xyz_frame.h"
+#include "xyz_image.h"
+#include "dcp_assert.h"
 #include "compose.hpp"
 #include "KM_util.h"
 #include "KM_fileio.h"
@@ -40,6 +39,7 @@
 #include <libxml++/document.h>
 #include <openssl/sha.h>
 #include <boost/filesystem.hpp>
+#include <boost/algorithm/string.hpp>
 #include <stdexcept>
 #include <sstream>
 #include <iostream>
@@ -54,7 +54,11 @@ using std::max;
 using std::list;
 using std::setw;
 using std::setfill;
+using std::ostream;
 using boost::shared_ptr;
+using boost::optional;
+using boost::function;
+using boost::algorithm::trim;
 using namespace dcp;
 
 /** Create a UUID.
@@ -73,12 +77,12 @@ dcp::make_uuid ()
 
 /** Create a digest for a file.
  *  @param filename File name.
- *  @param progress Pointer to a progress reporting function, or 0.  The function will be called
+ *  @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 (boost::filesystem::path filename, boost::function<void (float)>* progress)
+dcp::make_digest (boost::filesystem::path filename, function<void (float)> progress)
 {
        Kumu::FileReader reader;
        Kumu::Result_t r = reader.OpenRead (filename.string().c_str ());
@@ -107,7 +111,7 @@ dcp::make_digest (boost::filesystem::path filename, boost::function<void (float)
                SHA1_Update (&sha, read_buffer.Data(), read);
 
                if (progress) {
-                       (*progress) (float (done) / size);
+                       progress (float (done) / size);
                        done += read;
                }
        }
@@ -150,7 +154,7 @@ dcp::content_kind_to_string (ContentKind kind)
                return "advertisement";
        }
 
-       assert (false);
+       DCP_ASSERT (false);
 }
 
 /** Convert a string from a &lt;ContentKind&gt; node to a libdcp ContentKind.
@@ -185,7 +189,7 @@ dcp::content_kind_from_string (string kind)
                return ADVERTISEMENT;
        }
 
-       assert (false);
+       DCP_ASSERT (false);
 }
 
 /** Decompress a JPEG2000 image to a bitmap.
@@ -197,7 +201,7 @@ dcp::content_kind_from_string (string kind)
  *  This is useful for scaling 4K DCP images down to 2K.
  *  @return XYZ image.
  */
-shared_ptr<dcp::XYZFrame>
+shared_ptr<dcp::XYZImage>
 dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
 {
        opj_dinfo_t* decoder = opj_create_decompress (CODEC_J2K);
@@ -218,7 +222,7 @@ dcp::decompress_j2k (uint8_t* data, int64_t size, int reduce)
 
        image->x1 = rint (float(image->x1) / pow (2, reduce));
        image->y1 = rint (float(image->y1) / pow (2, reduce));
-       return shared_ptr<XYZFrame> (new XYZFrame (image));
+       return shared_ptr<XYZImage> (new XYZImage (image));
 }
 
 /** @param s A string.
@@ -271,6 +275,12 @@ bool dcp::operator!= (dcp::Size const & a, dcp::Size const & b)
        return !(a == b);
 }
 
+ostream& dcp::operator<< (ostream& s, dcp::Size const & a)
+{
+       s << a.width << "x" << a.height;
+       return s;
+}
+
 /** 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.
@@ -305,82 +315,115 @@ dcp::base64_decode (string const & in, unsigned char* out, int out_length)
        return N;
 }
 
-/** Convert a struct tm to a string of the form
- *  2014-01-26T21:39:00+01:00
- *  @param tm struct tm.
- *  @return Time as a string.
+/** @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.
  */
-string
-dcp::tm_to_string (struct tm* tm)
+FILE *
+dcp::fopen_boost (boost::filesystem::path p, string t)
 {
-       char buffer[64];
-       strftime (buffer, 64, "%Y-%m-%dT%H:%M:%S", tm);
-
-       int offset = 0;
-
-#ifdef LIBDCP_POSIX
-       offset = tm->tm_gmtoff / 60;
+#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
-       TIME_ZONE_INFORMATION tz;
-       GetTimeZoneInformation (&tz);
-       offset = tz.Bias;
+        return fopen (p.c_str(), t.c_str ());
 #endif
-       
-       return string (buffer) + utc_offset_to_string (offset);
 }
 
-/** @param b Offset from UTC to local time in minutes.
- *  @return string of the form e.g. -01:00.
- */
-string
-dcp::utc_offset_to_string (int b)
+optional<boost::filesystem::path>
+dcp::relative_to_root (boost::filesystem::path root, boost::filesystem::path file)
 {
-       bool const negative = (b < 0);
-       b = negative ? -b : b;
+       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;
+       }
 
-       int const hours = b / 60;
-       int const minutes = b % 60;
+       if (i != root.end ()) {
+               return optional<boost::filesystem::path> ();
+       }
 
-       stringstream o;
-       if (negative) {
-               o << "-";
-       } else {
-               o << "+";
+       boost::filesystem::path rel;
+       while (j != file.end ()) {
+               rel /= *j++;
        }
 
-       o << setw(2) << setfill('0') << hours << ":" << setw(2) << setfill('0') << minutes;
-       return o.str ();
+       return rel;
 }
 
-/** Convert a boost::posix_time::ptime to a string of the form
- *  2014-01-26T21:39:00+01:00.
- *  @param t boost::posix_time::ptime.
- *  @return Time as a string.
- */
-string
-dcp::ptime_to_string (boost::posix_time::ptime t)
+bool
+dcp::ids_equal (string a, string b)
 {
-       struct tm t_tm = boost::posix_time::to_tm (t);
-       return tm_to_string (&t_tm);
+       transform (a.begin(), a.end(), a.begin(), ::tolower);
+       transform (b.begin(), b.end(), b.begin(), ::tolower);
+       trim (a);
+       trim (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);
+       if (len > max_length) {
+               throw MiscError ("Unexpectedly long file");
+       }
+       
+       char* c = new char[len + 1];
+                          
+       FILE* f = fopen_boost (p, "r");
+       if (!f) {
+               return "";
+       }
+
+       fread (c, 1, len, f);
+       fclose (f);
+       c[len] = '\0';
 
-/** @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.
+       string s (c);
+       delete[] c;
+
+       return s;
+}
+
+/** @param key RSA private key in PEM format (optionally with -----BEGIN... / -----END...)
+ *  @return SHA1 fingerprint of key
  */
-FILE *
-dcp::fopen_boost (boost::filesystem::path p, string t)
+string
+dcp::private_key_fingerprint (string key)
 {
-#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
+       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;
+       }
+
+       DCP_ASSERT (i != c.end ());
+       return *i;
 }