Fix erroneous reports of unresolved assets when checking OV/VF pairs.
[libdcp.git] / src / local_time.cc
index 2388825cea4fdddb7be9c7946a52c222b2d3ae8f..5030500efdc8b7a255b0eb618854e2440bf16d88 100644 (file)
@@ -1,31 +1,53 @@
 /*
-    Copyright (C) 2014 Carl Hetherington <cth@carlh.net>
+    Copyright (C) 2014-2019 Carl Hetherington <cth@carlh.net>
 
-    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 <http://www.gnu.org/licenses/>.
+
+    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/local_time.cc
+ *  @brief LocalTime class.
+ */
+
 #include "local_time.h"
 #include "exceptions.h"
+#include "dcp_assert.h"
 #include <boost/lexical_cast.hpp>
+#include <boost/date_time/c_local_time_adjustor.hpp>
 #include <cstdio>
 
 using std::string;
+using std::ostream;
 using boost::lexical_cast;
 using namespace dcp;
 
+/** Construct a LocalTime from the current time */
 LocalTime::LocalTime ()
 {
        time_t now = time (0);
@@ -33,14 +55,18 @@ LocalTime::LocalTime ()
 
        _year = tm->tm_year + 1900;
        _month = tm->tm_mon + 1;
-       _day = tm->tm_mday + 1;
+       _day = tm->tm_mday;
        _hour = tm->tm_hour;
        _minute = tm->tm_min;
        _second = tm->tm_sec;
+       _millisecond = 0;
 
        set_local_time_zone ();
 }
 
+/** Construct a LocalTime from a boost::posix_time::ptime using the local
+ *  time zone.
+ */
 LocalTime::LocalTime (boost::posix_time::ptime t)
 {
        _year = t.date().year ();
@@ -49,80 +75,115 @@ LocalTime::LocalTime (boost::posix_time::ptime t)
        _hour = t.time_of_day().hours ();
        _minute = t.time_of_day().minutes ();
        _second = t.time_of_day().seconds ();
+       _millisecond = t.time_of_day().fractional_seconds () / 1000;
+       DCP_ASSERT (_millisecond < 1000);
 
        set_local_time_zone ();
 }
 
-void
-LocalTime::set_local_time_zone ()
+/** Construct a LocalTime from a boost::posix_time::ptime and a time zone offset.
+ *  @param tz_minute Offset from UTC in minutes; if the timezone is behind UTC this may be negative,
+ *  e.g. -04:30 would have tz_hour=-1 and tz_minute=-30.
+ */
+LocalTime::LocalTime (boost::posix_time::ptime t, int tz_hour, int tz_minute)
 {
-       time_t now = time (0);
-       struct tm* tm = localtime (&now);
-
-       int offset = 0;
-       
-#ifdef LIBDCP_POSIX
-       offset = tm->tm_gmtoff / 60;
-#else
-       TIME_ZONE_INFORMATION tz;
-       GetTimeZoneInformation (&tz);
-       offset = tz.Bias;
-#endif
+       _year = t.date().year ();
+       _month = t.date().month ();
+       _day = t.date().day ();
+       _hour = t.time_of_day().hours ();
+       _minute = t.time_of_day().minutes ();
+       _second = t.time_of_day().seconds ();
+       _millisecond = t.time_of_day().fractional_seconds () / 1000;
+       DCP_ASSERT (_millisecond < 1000);
 
-       bool const negative = offset < 0;
-       offset = negative ? -offset : offset;
+       _tz_hour = tz_hour;
+       _tz_minute = tz_minute;
+}
 
-       _tz_hour = offset / 60;
-       _tz_minute = offset % 60;
+/** Set our UTC offset to be according to the local time zone */
+void
+LocalTime::set_local_time_zone ()
+{
+       boost::posix_time::ptime const utc_now = boost::posix_time::second_clock::universal_time ();
+       boost::posix_time::ptime const now = boost::date_time::c_local_adjustor<boost::posix_time::ptime>::utc_to_local (utc_now);
+       boost::posix_time::time_duration offset = now - utc_now;
 
-       if (negative) {
-               _tz_hour = -_tz_hour;
-       }
+       _tz_hour = offset.hours ();
+       _tz_minute = offset.minutes ();
 }
 
-/** @param s A string of the form 2013-01-05T18:06:59+04:00 */
+/** @param s A string of the form 2013-01-05T18:06:59[.123][+04:00] */
 LocalTime::LocalTime (string s)
 {
-       /* 2013-01-05T18:06:59+04:00 */
-        /* 0123456789012345678901234 */
-       
-       if (s.length() < 25) {
+       /* 2013-01-05T18:06:59 or 2013-01-05T18:06:59.123 or 2013-01-05T18:06:59+04:00 or 2013-01-05T18:06:59.123+04:00 */
+       /* 0123456789012345678 or 01234567890123456789012 or 0123456789012345678901234 or 01234567890123456789012345678 */
+
+       if (s.length() < 19) {
+               throw TimeFormatError (s);
+       }
+
+       bool with_millisecond = false;
+       bool with_tz = false;
+
+       switch (s.length ()) {
+       case 19:
+               break;
+       case 23:
+               with_millisecond = true;
+               break;
+       case 25:
+               with_tz = true;
+               break;
+       case 29:
+               with_millisecond = with_tz = true;
+               break;
+       default:
                throw TimeFormatError (s);
        }
 
+       int const tz_pos = with_millisecond ? 23 : 19;
+
        /* Check incidental characters */
-       if (s[4] != '-' || s[7] != '-' || s[10] != 'T' || s[13] != ':' || s[16] != ':' || s[22] != ':') {
+       if (s[4] != '-' || s[7] != '-' || s[10] != 'T' || s[13] != ':' || s[16] != ':') {
                throw TimeFormatError (s);
        }
-       
+       if (with_millisecond && s[19] != '.') {
+               throw TimeFormatError (s);
+       }
+       if (with_tz && s[tz_pos] != '+' && s[tz_pos] != '-') {
+               throw TimeFormatError (s);
+       }
+
        _year = lexical_cast<int> (s.substr (0, 4));
        _month = lexical_cast<int> (s.substr (5, 2));
        _day = lexical_cast<int> (s.substr (8, 2));
        _hour = lexical_cast<int> (s.substr (11, 2));
        _minute = lexical_cast<int> (s.substr (14, 2));
        _second = lexical_cast<int> (s.substr (17, 2));
-       _tz_hour = lexical_cast<int> (s.substr (20, 2));
-       _tz_minute = lexical_cast<int> (s.substr (23, 2));
+       _millisecond = with_millisecond ? lexical_cast<int> (s.substr (20, 3)) : 0;
+       _tz_hour = with_tz ? lexical_cast<int> (s.substr (tz_pos + 1, 2)) : 0;
+       _tz_minute = with_tz ? lexical_cast<int> (s.substr (tz_pos + 4, 2)) : 0;
 
-       if (s[19] == '-') {
+       if (with_tz && s[tz_pos] == '-') {
                _tz_hour = -_tz_hour;
-       } else if (s[19] != '+') {
-               throw TimeFormatError (s);
+               _tz_minute = -_tz_minute;
        }
 }
 
+/** @return A string of the form 2013-01-05T18:06:59+04:00 or 2013-01-05T18:06:59.123+04:00 */
 string
-LocalTime::as_string () const
+LocalTime::as_string (bool with_millisecond) const
 {
        char buffer[32];
        snprintf (
                buffer, sizeof (buffer),
                "%sT%s%s%02d:%02d",
-               date().c_str(), time_of_day().c_str(), (_tz_hour >= 0 ? "+" : "-"), abs (_tz_hour), _tz_minute
+               date().c_str(), time_of_day(true, with_millisecond).c_str(), (_tz_hour >= 0 ? "+" : "-"), abs (_tz_hour), abs(_tz_minute)
                );
        return buffer;
 }
 
+/** @return The date in the form YYYY-MM-DD */
 string
 LocalTime::date () const
 {
@@ -131,10 +192,60 @@ LocalTime::date () const
        return buffer;
 }
 
+/** @return The time in the form HH:MM:SS or HH:MM:SS.mmm */
 string
-LocalTime::time_of_day () const
+LocalTime::time_of_day (bool with_second, bool with_millisecond) const
 {
        char buffer[32];
-       snprintf (buffer, sizeof (buffer), "%02d:%02d:%02d", _hour, _minute, _second);
+       DCP_ASSERT(!(with_millisecond && !with_second));
+       if (with_millisecond) {
+               snprintf (buffer, sizeof (buffer), "%02d:%02d:%02d.%03d", _hour, _minute, _second, _millisecond);
+       } else if (with_second) {
+               snprintf (buffer, sizeof (buffer), "%02d:%02d:%02d", _hour, _minute, _second);
+       } else {
+               snprintf (buffer, sizeof (buffer), "%02d:%02d", _hour, _minute);
+       }
        return buffer;
 }
+
+bool
+LocalTime::operator== (LocalTime const & other) const
+{
+       return _year == other._year && _month == other._month && _day == other._day &&
+               _hour == other._hour && _second == other._second && _millisecond == other._millisecond &&
+               _tz_hour == other._tz_hour && _tz_minute == other._tz_minute;
+}
+
+bool
+LocalTime::operator< (LocalTime const & other) const
+{
+       if (_year != other._year) {
+               return _year < other._year;
+       }
+       if (_month != other._month) {
+               return _month < other._month;
+       }
+       if (_day != other._day) {
+               return _day < other._day;
+       }
+       if (_hour != other._hour) {
+               return _hour < other._hour;
+       }
+       if (_second != other._second) {
+               return _second < other._second;
+       }
+       return _millisecond < other._millisecond;
+}
+
+bool
+LocalTime::operator!= (LocalTime const & other) const
+{
+       return !(*this == other);
+}
+
+ostream&
+dcp::operator<< (ostream& s, LocalTime const & t)
+{
+       s << t.as_string ();
+       return s;
+}