Fix LocalTime::operator< and operator> to handle offset gracefully.
[libdcp.git] / src / local_time.cc
1 /*
2     Copyright (C) 2014-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/local_time.cc
36  *  @brief LocalTime class
37  */
38
39
40 #include "local_time.h"
41 #include "exceptions.h"
42 #include "dcp_assert.h"
43 #include <boost/lexical_cast.hpp>
44 #include <boost/date_time/posix_time/posix_time.hpp>
45 #include <boost/date_time/c_local_time_adjustor.hpp>
46 #include <boost/date_time/gregorian/gregorian.hpp>
47 #include <cstdio>
48
49
50 using std::string;
51 using std::ostream;
52 using boost::lexical_cast;
53 using namespace dcp;
54
55
56 LocalTime::LocalTime ()
57 {
58         auto now = time (0);
59         auto tm = localtime (&now);
60         set (tm);
61         set_local_time_zone ();
62 }
63
64
65 LocalTime::LocalTime (struct tm t)
66 {
67         set (&t);
68         set_local_time_zone ();
69 }
70
71
72 void
73 LocalTime::set (struct tm const * tm)
74 {
75         _year = tm->tm_year + 1900;
76         _month = tm->tm_mon + 1;
77         _day = tm->tm_mday;
78         _hour = tm->tm_hour;
79         _minute = tm->tm_min;
80         _second = tm->tm_sec;
81         _millisecond = 0;
82 }
83
84
85 LocalTime::LocalTime (boost::posix_time::ptime t)
86 {
87         set (t);
88         set_local_time_zone ();
89 }
90
91
92 void
93 LocalTime::set (boost::posix_time::ptime t)
94 {
95         _year = t.date().year ();
96         _month = t.date().month ();
97         _day = t.date().day ();
98         _hour = t.time_of_day().hours ();
99         _minute = t.time_of_day().minutes ();
100         _second = t.time_of_day().seconds ();
101         _millisecond = t.time_of_day().fractional_seconds () / 1000;
102         DCP_ASSERT (_millisecond < 1000);
103 }
104
105
106 LocalTime::LocalTime(boost::posix_time::ptime t, UTCOffset offset)
107 {
108         set (t);
109         _offset = offset;
110 }
111
112
113 /** Set our UTC offset to be according to the local time zone */
114 void
115 LocalTime::set_local_time_zone ()
116 {
117         auto const utc_now = boost::posix_time::second_clock::universal_time ();
118         auto const now = boost::date_time::c_local_adjustor<boost::posix_time::ptime>::utc_to_local (utc_now);
119         auto offset = now - utc_now;
120
121         _offset = { static_cast<int>(offset.hours()), static_cast<int>(offset.minutes()) };
122 }
123
124
125 LocalTime::LocalTime (string s)
126 {
127         /* 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 */
128         /* 0123456789012345678 or 01234567890123456789012 or 0123456789012345678901234 or 01234567890123456789012345678 */
129
130         if (s.length() < 19) {
131                 throw TimeFormatError (s);
132         }
133
134         bool with_millisecond = false;
135         bool with_tz = false;
136
137         switch (s.length ()) {
138         case 19:
139                 break;
140         case 23:
141                 with_millisecond = true;
142                 break;
143         case 25:
144                 with_tz = true;
145                 break;
146         case 29:
147                 with_millisecond = with_tz = true;
148                 break;
149         default:
150                 throw TimeFormatError (s);
151         }
152
153         int const tz_pos = with_millisecond ? 23 : 19;
154
155         /* Check incidental characters */
156         if (s[4] != '-' || s[7] != '-' || s[10] != 'T' || s[13] != ':' || s[16] != ':') {
157                 throw TimeFormatError (s);
158         }
159         if (with_millisecond && s[19] != '.') {
160                 throw TimeFormatError (s);
161         }
162         if (with_tz && s[tz_pos] != '+' && s[tz_pos] != '-') {
163                 throw TimeFormatError (s);
164         }
165
166         _year = lexical_cast<int>(s.substr(0, 4));
167         _month = lexical_cast<int>(s.substr(5, 2));
168         _day = lexical_cast<int>(s.substr(8, 2));
169         _hour = lexical_cast<int>(s.substr(11, 2));
170         _minute = lexical_cast<int>(s.substr(14, 2));
171         _second = lexical_cast<int>(s.substr(17, 2));
172         _millisecond = with_millisecond ? lexical_cast<int>(s.substr(20, 3)) : 0;
173
174         _offset.set_hour(with_tz ? lexical_cast<int>(s.substr(tz_pos + 1, 2)) : 0);
175         _offset.set_minute(with_tz ? lexical_cast<int>(s.substr(tz_pos + 4, 2)) : 0);
176
177         if (with_tz && s[tz_pos] == '-') {
178                 _offset.set_hour(-_offset.hour());
179                 _offset.set_minute(-_offset.minute());
180         }
181 }
182
183
184 string
185 LocalTime::as_string (bool with_millisecond) const
186 {
187         char buffer[32];
188         snprintf (
189                 buffer, sizeof (buffer),
190                 "%sT%s%s%02d:%02d",
191                 date().c_str(), time_of_day(true, with_millisecond).c_str(), (_offset.hour() >= 0 ? "+" : "-"), abs(_offset.hour()), abs(_offset.minute())
192                 );
193         return buffer;
194 }
195
196
197 string
198 LocalTime::date () const
199 {
200         char buffer[32];
201         snprintf (buffer, sizeof (buffer), "%04d-%02d-%02d", _year, _month, _day);
202         return buffer;
203 }
204
205
206 string
207 LocalTime::time_of_day (bool with_second, bool with_millisecond) const
208 {
209         char buffer[32];
210         DCP_ASSERT(!(with_millisecond && !with_second));
211         if (with_millisecond) {
212                 snprintf (buffer, sizeof (buffer), "%02d:%02d:%02d.%03d", _hour, _minute, _second, _millisecond);
213         } else if (with_second) {
214                 snprintf (buffer, sizeof (buffer), "%02d:%02d:%02d", _hour, _minute, _second);
215         } else {
216                 snprintf (buffer, sizeof (buffer), "%02d:%02d", _hour, _minute);
217         }
218         return buffer;
219 }
220
221
222 void
223 LocalTime::add_days (int days)
224 {
225         using namespace boost;
226
227         gregorian::date d (_year, _month, _day);
228         if (days > 0) {
229                 d += gregorian::days (days);
230         } else {
231                 d -= gregorian::days (-days);
232         }
233
234         set (posix_time::ptime(d, posix_time::time_duration(_hour, _minute, _second, _millisecond * 1000)));
235 }
236
237
238 void
239 LocalTime::add(boost::posix_time::time_duration duration)
240 {
241         using namespace boost;
242
243         posix_time::ptime t(gregorian::date(_year, _month, _day), posix_time::time_duration(_hour, _minute, _second, _millisecond * 1000));
244         t += duration;
245         set (t);
246 }
247
248
249 void
250 LocalTime::add_months (int m)
251 {
252         using namespace boost;
253
254         gregorian::date d (_year, _month, _day);
255         if (m > 0) {
256                 d += gregorian::months (m);
257         } else {
258                 d -= gregorian::months (-m);
259         }
260
261         set (posix_time::ptime(d, posix_time::time_duration(_hour, _minute, _second, _millisecond * 1000)));
262 }
263
264
265 void
266 LocalTime::add_minutes (int m)
267 {
268         add(boost::posix_time::time_duration(0, m, 0));
269 }
270
271
272 bool
273 LocalTime::operator== (LocalTime const & other) const
274 {
275         return _year == other._year && _month == other._month && _day == other._day &&
276                 _hour == other._hour && _minute == other._minute && _second == other._second && _millisecond == other._millisecond &&
277                 _offset == other._offset;
278 }
279
280
281 bool
282 LocalTime::operator< (LocalTime const & other) const
283 {
284         auto a = as_utc();
285         auto b = other.as_utc();
286
287         if (a.year() != b.year()) {
288                 return a.year() < b.year();
289         }
290         if (a.month() != b.month()) {
291                 return a.month() < b.month();
292         }
293         if (a.day() != b.day()) {
294                 return a.day() < b.day();
295         }
296         if (a.hour() != b.hour()) {
297                 return a.hour() < b.hour();
298         }
299         if (a.minute() != b.minute()) {
300                 return a.minute() < other.minute();
301         }
302         if (a.second() != b.second()) {
303                 return a.second() < b.second();
304         }
305         return a.millisecond() < b.millisecond();
306 }
307
308
309 bool
310 LocalTime::operator>(LocalTime const & other) const
311 {
312         auto a = as_utc();
313         auto b = other.as_utc();
314
315         if (a.year() != b.year()) {
316                 return a.year() > b.year();
317         }
318         if (a.month() != b.month()) {
319                 return a.month() > b.month();
320         }
321         if (a.day() != b.day()) {
322                 return a.day() > b.day();
323         }
324         if (a.hour() != b.hour()) {
325                 return a.hour() > b.hour();
326         }
327         if (a.minute() != b.minute()) {
328                 return a.minute() > b.minute();
329         }
330         if (a.second() != b.second()) {
331                 return a.second() > b.second();
332         }
333         return a.millisecond() > b.millisecond();
334 }
335
336
337 bool
338 LocalTime::operator!= (LocalTime const & other) const
339 {
340         return !(*this == other);
341 }
342
343
344 ostream&
345 dcp::operator<< (ostream& s, LocalTime const & t)
346 {
347         s << t.as_string ();
348         return s;
349 }
350
351
352 LocalTime
353 LocalTime::from_asn1_utc_time (string time)
354 {
355         LocalTime t;
356         sscanf(time.c_str(), "%2d%2d%2d%2d%2d%2d", &t._year, &t._month, &t._day, &t._hour, &t._minute, &t._second);
357
358         if (t._year < 70) {
359                 t._year += 100;
360         }
361         t._year += 1900;
362
363         t._millisecond = 0;
364         t._offset = {};
365
366         return t;
367 }
368
369
370 LocalTime
371 LocalTime::from_asn1_generalized_time (string time)
372 {
373         LocalTime t;
374         sscanf(time.c_str(), "%4d%2d%2d%2d%2d%2d", &t._year, &t._month, &t._day, &t._hour, &t._minute, &t._second);
375
376         t._millisecond = 0;
377         t._offset = {};
378
379         return t;
380 }
381
382
383 LocalTime
384 LocalTime::as_utc() const
385 {
386         auto t = *this;
387         t.add(boost::posix_time::time_duration(-_offset.hour(), -_offset.minute(), 0));
388         return t;
389 }
390