3 use DateTime::TimeZone;
7 use Test::More tests => 83;
11 use Time::HiRes qw/ gettimeofday /;
14 use Koha::DateUtils qw( dt_from_string output_pref format_sqldatetime flatpickr_date_format );
18 t::lib::Mocks::mock_preference('dateformat', 'us');
19 t::lib::Mocks::mock_preference('TimeFormat', 'This_is_not_used_but_called');
21 my $tz = C4::Context->tz;
23 isa_ok( $tz, 'DateTime::TimeZone', 'Context returns timezone object' );
25 my $testdate_iso = '2011-06-16'; # Bloomsday 2011
26 my $dt = dt_from_string( $testdate_iso, 'iso' );
28 isa_ok( $dt, 'DateTime', 'dt_from_string returns a DateTime object' );
30 cmp_ok( $dt->ymd(), 'eq', $testdate_iso, 'Returned object matches input' );
37 my $dateformat = C4::Context->preference('dateformat');
38 cmp_ok output_pref({ dt => $dt, dateformat => $dateformat }),
41 'output_pref gives an hashref or a dt';
43 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => '24hr' });
44 cmp_ok $date_string, 'eq', '2011-06-16 12:00', 'iso output';
46 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => '12hr' });
47 cmp_ok $date_string, 'eq', '2011-06-16 12:00 PM', 'iso output 12hr';
49 $date_string = output_pref({ dt => $dt, dateformat => 'rfc3339' });
50 like($date_string, qr/2011-06-16T12:00:00\+|-\d\d:\d\d/, 'RFC3339 output');
52 $date_string = output_pref({ dt => $dt, dateformat => 'rfc3339', dateonly => 1 });
53 is($date_string, '2011-06-16', 'RFC3339 output');
55 # "notime" doesn't actually mean anything in this context, but we
56 # can't pass undef or output_pref will try to access the database
57 $date_string = output_pref({ dt => $dt, dateformat => 'iso', timeformat => 'notime', dateonly => 1 });
58 cmp_ok $date_string, 'eq', '2011-06-16', 'iso output (date only)';
60 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '24hr' });
61 cmp_ok $date_string, 'eq', '06/16/2011 12:00', 'us output';
63 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '12hr' });
64 cmp_ok $date_string, 'eq', '06/16/2011 12:00 PM', 'us output 12hr';
66 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => 'notime', dateonly => 1 });
67 cmp_ok $date_string, 'eq', '06/16/2011', 'us output (date only)';
69 # metric should return the French Revolutionary Calendar Really
70 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr' });
71 cmp_ok $date_string, 'eq', '16/06/2011 12:00', 'metric output';
73 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => 'notime', dateonly => 1 });
74 cmp_ok $date_string, 'eq', '16/06/2011', 'metric output (date only)';
76 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr' });
77 cmp_ok $date_string, 'eq', '16/06/2011 12:00',
78 'output_pref preserves non midnight HH:SS';
80 my $dear_dirty_dublin = DateTime::TimeZone->new( name => 'Europe/Dublin' );
81 my $new_dt = dt_from_string( '16/06/2011', 'metric', $dear_dirty_dublin );
82 isa_ok( $new_dt, 'DateTime', 'Create DateTime with different timezone' );
83 cmp_ok( $new_dt->ymd(), 'eq', $testdate_iso,
84 'Returned Dublin object matches input' );
87 skip "Don't test execution time of dt_from_string on slow servers", 6 if $ENV{SLOW_SERVER};
88 for ( qw/ 2014-01-01 2100-01-01 9999-01-01 / ) {
89 my $duration = gettimeofday();
90 $new_dt = dt_from_string($_, 'iso', $dear_dirty_dublin);
91 $duration = gettimeofday() - $duration;
92 cmp_ok $duration, '<', 1, "Create DateTime with dt_from_string() for $_ with TZ in less than 1s";
93 $duration = gettimeofday();
94 output_pref( { dt => $new_dt } );
95 $duration = gettimeofday() - $duration;
96 cmp_ok $duration, '<', 1, "Create DateTime with output_pref() for $_ with TZ in less than 1s";
100 $new_dt = dt_from_string( '2011-06-16 12:00', 'sql' );
101 isa_ok( $new_dt, 'DateTime', 'Create DateTime from (mysql) sql' );
102 cmp_ok( $new_dt->ymd(), 'eq', $testdate_iso, 'sql returns correct date' );
104 $new_dt = dt_from_string( $dt, 'iso' );
105 isa_ok( $new_dt, 'DateTime', 'Passed a DateTime dt_from_string returns it' );
107 my $ymd = '2012-01-01';
108 my $dt0 = dt_from_string( '00/01/2012', 'metric' );
109 isa_ok( $dt0, 'DateTime',
110 'dt_from_string returns a DateTime object passed a zero metric day' );
111 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects metric day 0' );
113 $dt0 = dt_from_string( '01/00/2012', 'us' );
114 isa_ok( $dt0, 'DateTime',
115 'dt_from_string returns a DateTime object passed a zero us day' );
116 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects us day 0' );
118 $dt0 = dt_from_string( '2012-01-00', 'iso' );
119 isa_ok( $dt0, 'DateTime',
120 'dt_from_string returns a DateTime object passed a zero iso day' );
121 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects iso day 0' );
123 $dt0 = dt_from_string( '2012-01-00T12:00:00Z', 'rfc3339' );
124 isa_ok( $dt0, 'DateTime',
125 'dt_from_string returns a DateTime object passed a zero rfc3339 day' );
126 cmp_ok( $dt0->ymd(), 'eq', $ymd, 'Returned object corrects rfc3339 day 0' );
128 $dt0 = dt_from_string( '2012-01-01T23:59:00.0Z', 'rfc3339' );
129 cmp_ok( $dt0->epoch(), 'eq', '1325462340', 'dt_from_string handles seconds with 1 decimal place' );
131 $dt0 = dt_from_string( '2012-01-01T23:59:00.00Z', 'rfc3339' );
132 cmp_ok( $dt0->epoch(), 'eq', '1325462340', 'dt_from_string handles seconds with 2 decimal places' );
134 $dt0 = dt_from_string( '2012-01-01t23:59:59.999z', 'rfc3339' );
135 cmp_ok( $dt0->epoch(), 'eq', '1325462399', 'dt_from_string handles seconds with 3 decimal places' );
137 $dt0 = dt_from_string( '2012-01-01T23:59:59.999+02:00', 'rfc3339' );
138 cmp_ok( $dt0->epoch(), 'eq', '1325455199', 'dt_from_string handles seconds with 3 decimal places and a timezone' );
141 $dt0 = dt_from_string( '2012-01-01T23:59:59.999Z+02:00', 'rfc3339' ); # Do not combine Z with +02 !
143 like( $@, qr/.*does not match the date format \(rfc3339\).*/, 'dt_from_string should die when passed a bad rfc3339 date string' );
146 $dt0 = dt_from_string('2021-11-03T10:16:59Z+00:00', 'iso'); # Z and +00 are the same, but should not be together
148 like( $@, qr/.*does not match the date format \(iso\).*/, 'dt_from_string should die when passed a bad iso date string' );
151 subtest 'dt_from_string - iso format' => sub {
154 my $module_context = Test::MockModule->new('C4::Context');
155 $module_context->mock(
158 return DateTime::TimeZone->new( name => 'Europe/Paris' );
163 my $dt_iso = dt_from_string( '2012-01-01', 'iso' );
164 cmp_ok( $dt_iso->epoch(), 'eq', '1325372400', 'dt_from_string handles dateonly string' );
165 # Saturday December 31, 2011 23:00:00 (UTC) == Sunday January 01, 2012 00:00:00 Europe/Paris (CET/+01:00)
168 $dt_iso = dt_from_string( '2012-01-32', 'iso' );
170 like( $@, qr/^Validation failed/, 'Fail on invalid dateonly string');
173 $dt_iso = dt_from_string( '2012-01-01T23:59:59', 'iso' );
174 cmp_ok( $dt_iso->epoch(), 'eq', '1325458799', 'dt_from_string with no offset assumes "local"' );
175 # Sunday January 01, 2012 22:59:59 (UTC) == Sunday January 01, 2012 23:59:59 Europe/Paris (CET/+01:00)
177 # Datetime with timezone
178 $dt_iso = dt_from_string( '2012-01-01T23:59:59Z', 'iso' );
179 cmp_ok( $dt_iso->epoch(), 'eq', '1325462399', 'dt_from_string with UTC prescribed as Z' );
180 # Sunday January 01, 2012 23:59:59 (UTC)
182 $dt_iso = dt_from_string( '2012-01-01T23:59:59+02:00', 'iso' );
183 cmp_ok( $dt_iso->epoch(), 'eq', '1325455199', 'dt_from_string with offset +02:00' );
184 # Sunday January 01, 2012 21:59:59 (UTC) == Sunday January 01, 2012 23:59:59 Europe/Athens (EET/+02:00)
185 # Allow +02 or +0200 too
186 $dt_iso = dt_from_string( '2012-01-01T23:59:59+02', 'iso' );
187 cmp_ok( $dt_iso->epoch(), 'eq', '1325455199', 'dt_from_string with offset +02' );
188 $dt_iso = dt_from_string( '2012-01-01T23:59:59+0200', 'iso' );
189 cmp_ok( $dt_iso->epoch(), 'eq', '1325455199', 'dt_from_string with offset +0200' );
193 # Return undef if passed mysql 0 dates
194 $dt0 = dt_from_string( '0000-00-00', 'iso' );
195 is( $dt0, undef, "undefined returned for 0 iso date" );
197 # Return undef if passed mysql 9999-* date
198 my $dt9999 = dt_from_string( '9999-12-31', 'sql' );
199 is( $dt9999->ymd(), '9999-12-31', "dt_from_string should return a DateTime object for 9999-12-31" );
201 my $formatted = format_sqldatetime( '2011-06-16 12:00:07', 'metric', '24hr' );
202 cmp_ok( $formatted, 'eq', '16/06/2011 12:00', 'format_sqldatetime conversion' );
204 $formatted = format_sqldatetime( undef, 'metric' );
205 cmp_ok( $formatted, 'eq', q{},
206 'format_sqldatetime formats undef as empty string' );
208 # Test the as_due_date parameter
216 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', as_due_date => 1 });
217 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date with hours and timeformat 24hr';
219 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', dateonly => 1, as_due_date => 1});
220 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date without hours and timeformat 24hr';
222 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '12hr', as_due_date => 1 });
223 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date with hours and timeformat 12hr';
225 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '12hr', dateonly => 1, as_due_date => 1});
226 cmp_ok $date_string, 'eq', '11/12/2013', 'as_due_date without hours and timeformat 12hr';
228 # Test as_due_date for hourly loans
236 $date_string = output_pref({ dt => $dt, dateformat => 'metric', timeformat => '24hr', as_due_date => 1 });
237 cmp_ok $date_string, 'eq', '11/12/2013 18:35', 'as_due_date with hours and timeformat 24hr (non-midnight time)';
238 $date_string = output_pref({ dt => $dt, dateformat => 'us', timeformat => '12hr', as_due_date => 1 });
239 cmp_ok $date_string, 'eq', '12/11/2013 06:35 PM', 'as_due_date with hours and timeformat 12hr (non-midnight time)';
241 my $now = DateTime->now;
242 is( dt_from_string, $now, "Without parameter, dt_from_string should return today" );
244 my $module_context = Test::MockModule->new('C4::Context');
245 $module_context->mock(
248 return DateTime::TimeZone->new( name => 'Europe/Lisbon' );
252 $dt = dt_from_string('1979-04-01');
253 isa_ok( $dt, 'DateTime', 'dt_from_string should return a DateTime object if a DST is given' );
255 $module_context->mock(
258 return DateTime::TimeZone->new( name => 'Europe/Paris' );
262 $dt = dt_from_string('2014-03-30 02:00:00');
263 isa_ok( $dt, 'DateTime', 'dt_from_string should return a DateTime object if a DST is given' );
265 # Test output_pref for invalid local time explosion
273 $module_context->mock(
276 return DateTime::TimeZone->new( name => 'Europe/London' );
279 is( output_pref( { dt => $dt, dateonly => 0 } ), '03/26/2017 01:35', 'output_pref should return even if an invalid DST time is passed' );
281 # Test dt_from_string
282 t::lib::Mocks::mock_preference('dateformat', 'metric');
283 t::lib::Mocks::mock_preference('TimeFormat', '24hr');
285 # dt_from_string should take into account the dateformat pref, or the given parameter
286 $dt = dt_from_string('31/01/2015');
287 is( ref($dt), 'DateTime', '31/01/2015 is a correct date in metric format' );
288 is( output_pref( { dt => $dt, dateonly => 1 } ), '31/01/2015' );
289 $dt = eval { dt_from_string( '31/01/2015', 'iso' ); };
290 is( ref($dt), '', '31/01/2015 is not a correct date in iso format' );
291 $dt = eval { dt_from_string( '01/01/2015', 'iso' ); };
292 is( ref($dt), '', '01/01/2015 is not a correct date in iso format' );
293 $dt = eval { dt_from_string( '01/01/2015', 'rfc3339' ); };
294 is( ref($dt), '', '01/01/2015 is not a correct date in rfc3339 format' );
295 $dt = eval { dt_from_string( '31/01/2015', 'us' ); };
296 is( ref($dt), '', '31/01/2015 is not a correct date in us format' );
297 $dt = dt_from_string( '01/01/2015', 'us' );
298 is( ref($dt), 'DateTime', '01/01/2015 is a correct date in us format' );
299 $dt = dt_from_string( '01.01.2015', 'dmydot' );
300 is( ref($dt), 'DateTime', '01.01.2015 is a correct date in dmydot format' );
303 # default value for hh and mm is 00:00
304 $dt = dt_from_string('31/01/2015');
305 is( output_pref( { dt => $dt } ), '31/01/2015 00:00', 'dt_from_string should generate a DT object with 00:00 as default hh:mm' );
307 $dt = dt_from_string('31/01/2015 12:34');
308 is( output_pref( { dt => $dt } ), '31/01/2015 12:34', 'dt_from_string should match hh:mm' );
310 $dt = dt_from_string('31/01/2015 12:34:56');
311 is( output_pref( { dt => $dt } ), '31/01/2015 12:34', 'dt_from_string should match hh:mm:ss' );
314 $dt = dt_from_string('01/01/1900');
315 is( output_pref( { dt => $dt, dateonly => 1 } ), '01/01/1900', 'dt_from_string should manage date < 1900' );
318 $dt = dt_from_string('2015-01-31 01:02:03');
319 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string should fallback to sql format' );
322 $dt = dt_from_string('2015-01-31 01:02 AM');
323 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string ' );
324 $dt = dt_from_string('2015-01-31 01:02:03 AM');
325 is( output_pref( {dt => $dt} ), '31/01/2015 01:02', 'dt_from_string ' );
326 $dt = dt_from_string('2015-01-31 01:02 PM');
327 is( output_pref( {dt => $dt} ), '31/01/2015 13:02', 'dt_from_string ' );
328 $dt = dt_from_string('2015-01-31 01:02:03 PM');
329 is( output_pref( {dt => $dt} ), '31/01/2015 13:02', 'dt_from_string ' );
330 $dt = dt_from_string('2015-01-31 12:02 AM');
331 is( output_pref( {dt => $dt} ), '31/01/2015 00:02', 'dt_from_string ' );
332 $dt = dt_from_string('2015-01-31 12:02:03 AM');
333 is( output_pref( {dt => $dt} ), '31/01/2015 00:02', 'dt_from_string ' );
335 subtest 'TimeFormat 12hr' => sub {
338 $dt = DateTime->new( year => 2020, month => 5, day => 28, hour => 12, minute => 49 );
339 t::lib::Mocks::mock_preference('TimeFormat', '12hr');
340 my $output = output_pref({ dt => $dt, dateformat => 'iso' });
341 $dt = dt_from_string( $output, 'iso' );
342 is( output_pref( {dt => $dt} ), '28/05/2020 12:49 PM', "12 NOON formatted correctly in 12hr format" );
343 t::lib::Mocks::mock_preference('TimeFormat', '24hr');
344 is( output_pref( {dt => $dt} ), '28/05/2020 12:49' , "12 NOON formatted correctly in 24hr format" );
346 $dt = DateTime->new( year => 2020, month => 5, day => 28, hour => 0, minute => 49 );
347 t::lib::Mocks::mock_preference('TimeFormat', '12hr');
348 $output = output_pref({ dt => $dt, dateformat => 'iso' });
349 $dt = dt_from_string( $output, 'iso' );
350 is( output_pref( {dt => $dt} ), '28/05/2020 12:49 AM', "12 MIDNIGHT formatted correctly in 12hr format" );
351 t::lib::Mocks::mock_preference('TimeFormat', '24hr');
352 is( output_pref( {dt => $dt} ), '28/05/2020 00:49', "12 MIDNIGHT formatted correctly in 24hr format" );
355 # output_pref with no parameters, single parameter (no hash)
356 is( output_pref(), undef, 'Call output_pref without parameters' );
358 output_pref( 'no_dt' );
359 ok( 0, 'Passed single invalid dt to output_pref' );
361 is( ref($_), 'Koha::Exceptions::WrongParameter',
362 'Passed single invalid dt to output_pref' );
365 # pass invalid dt via hash
367 output_pref({ dt => 'no_dt' });
368 ok( 0, 'Passed invalid dt in hash to output_pref' );
370 is( ref($_), 'Koha::Exceptions::WrongParameter',
371 'Passed invalid dt in hash to output_pref' );
374 # output_pref with str parameter
375 is( output_pref( { 'str' => $testdate_iso, dateformat => 'iso', dateonly => 1 } ), $testdate_iso, 'output_pref should handle correctly the iso parameter' );
376 my $output_for_invalid_date;
378 $output_for_invalid_date = output_pref({ str => 'invalid_date' });
379 ok( 0, 'Invalid date string passed to output_pref' );
381 is( ref($_), 'Koha::Exceptions::WrongParameter',
382 'Invalid date string passed to output_pref' );
384 is( $output_for_invalid_date, undef, 'No return value from output_pref' );
386 output_pref({ 'str' => $testdate_iso, dt => $dt, dateformat => 'iso', dateonly => 1 });
387 ok( 0, 'output_pref should carp if str and dt parameters are passed together' );
389 is( ref($_), 'Koha::Exceptions::WrongParameter', 'output_pref should throw an exception if str and dt parameters are passed together' );
392 subtest 'flatpickr_date_format' => sub {
395 t::lib::Mocks::mock_preference('dateformat', 'iso');
396 is( flatpickr_date_format(), 'Y-m-d', 'check fallback to pref' );
397 is( flatpickr_date_format(q{}), undef, 'empty string' );
398 is( flatpickr_date_format('metric'), 'd/m/Y', 'check valid arg' );
399 is( flatpickr_date_format('zz'), undef, 'wrong arg' );