blob: dcec9c7cc1033d53753213e8252c7a5d426817c8 [file] [log] [blame]
drh7014aff2003-11-01 01:53:53 +00001/*
2** 2003 October 31
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
10**
11*************************************************************************
12** This file contains the C functions that implement date and time
13** functions for SQLite.
14**
15** There is only one exported symbol in this file - the function
danielk19774adee202004-05-08 08:23:19 +000016** sqlite3RegisterDateTimeFunctions() found at the bottom of the file.
drh7014aff2003-11-01 01:53:53 +000017** All other code has file scope.
18**
drh86a11b82014-11-07 13:24:29 +000019** SQLite processes all times and dates as julian day numbers. The
drh7014aff2003-11-01 01:53:53 +000020** dates and times are stored as the number of days since noon
21** in Greenwich on November 24, 4714 B.C. according to the Gregorian
drh7f986a62006-09-25 18:05:04 +000022** calendar system.
drh7014aff2003-11-01 01:53:53 +000023**
24** 1970-01-01 00:00:00 is JD 2440587.5
25** 2000-01-01 00:00:00 is JD 2451544.5
26**
peter.d.reid60ec9142014-09-06 16:39:46 +000027** This implementation requires years to be expressed as a 4-digit number
drh7014aff2003-11-01 01:53:53 +000028** which means that only dates between 0000-01-01 and 9999-12-31 can
29** be represented, even though julian day numbers allow a much wider
30** range of dates.
31**
32** The Gregorian calendar system is used for all dates and times,
33** even those that predate the Gregorian calendar. Historians usually
drh86a11b82014-11-07 13:24:29 +000034** use the julian calendar for dates prior to 1582-10-15 and for some
drh7014aff2003-11-01 01:53:53 +000035** dates afterwards, depending on locale. Beware of this difference.
36**
37** The conversion algorithms are implemented based on descriptions
38** in the following text:
39**
40** Jean Meeus
41** Astronomical Algorithms, 2nd Edition, 1998
mistachkina0951d82017-12-07 22:04:53 +000042** ISBN 0-943396-61-1
drh7014aff2003-11-01 01:53:53 +000043** Willmann-Bell, Inc
44** Richmond, Virginia (USA)
45*/
dougcurrieae534182003-12-24 01:41:19 +000046#include "sqliteInt.h"
drh7014aff2003-11-01 01:53:53 +000047#include <stdlib.h>
48#include <assert.h>
drh7091cb02003-12-23 16:22:18 +000049#include <time.h>
drh7014aff2003-11-01 01:53:53 +000050
drh4bc05852004-02-10 13:19:35 +000051#ifndef SQLITE_OMIT_DATETIME_FUNCS
52
mistachkin0cedb962016-04-11 22:45:45 +000053/*
mistachkin8366ddf2016-04-12 16:11:52 +000054** The MSVC CRT on Windows CE may not have a localtime() function.
55** So declare a substitute. The substitute function itself is
56** defined in "os_win.c".
mistachkin0cedb962016-04-11 22:45:45 +000057*/
58#if !defined(SQLITE_OMIT_LOCALTIME) && defined(_WIN32_WCE) && \
59 (!defined(SQLITE_MSVC_LOCALTIME_API) || !SQLITE_MSVC_LOCALTIME_API)
60struct tm *__cdecl localtime(const time_t *);
61#endif
shaneb8109ad2008-05-27 19:49:21 +000062
63/*
drh7014aff2003-11-01 01:53:53 +000064** A structure for holding a single date and time.
65*/
66typedef struct DateTime DateTime;
67struct DateTime {
drhb5489b82016-11-30 04:07:57 +000068 sqlite3_int64 iJD; /* The julian day number times 86400000 */
drhd76a9022016-11-30 00:48:28 +000069 int Y, M, D; /* Year, month, and day */
70 int h, m; /* Hour and minutes */
71 int tz; /* Timezone offset in minutes */
72 double s; /* Seconds */
drh861a5682016-12-02 17:08:27 +000073 char validJD; /* True (1) if iJD is valid */
74 char rawS; /* Raw numeric value stored in s */
drhd76a9022016-11-30 00:48:28 +000075 char validYMD; /* True (1) if Y,M,D are valid */
76 char validHMS; /* True (1) if h,m,s are valid */
drhd76a9022016-11-30 00:48:28 +000077 char validTZ; /* True (1) if tz is valid */
78 char tzSet; /* Timezone was set explicitly */
79 char isError; /* An overflow has occurred */
drh7014aff2003-11-01 01:53:53 +000080};
81
82
83/*
drh33496202016-01-14 19:32:46 +000084** Convert zDate into one or more integers according to the conversion
85** specifier zFormat.
drheb9a9e82004-02-22 17:49:32 +000086**
drh33496202016-01-14 19:32:46 +000087** zFormat[] contains 4 characters for each integer converted, except for
88** the last integer which is specified by three characters. The meaning
89** of a four-character format specifiers ABCD is:
drheb9a9e82004-02-22 17:49:32 +000090**
drh33496202016-01-14 19:32:46 +000091** A: number of digits to convert. Always "2" or "4".
92** B: minimum value. Always "0" or "1".
93** C: maximum value, decoded as:
94** a: 12
95** b: 14
96** c: 24
97** d: 31
98** e: 59
99** f: 9999
100** D: the separator character, or \000 to indicate this is the
101** last number to convert.
102**
103** Example: To translate an ISO-8601 date YYYY-MM-DD, the format would
104** be "40f-21a-20c". The "40f-" indicates the 4-digit year followed by "-".
105** The "21a-" indicates the 2-digit month followed by "-". The "20c" indicates
106** the 2-digit day which is the last integer in the set.
107**
drheb9a9e82004-02-22 17:49:32 +0000108** The function returns the number of successful conversions.
drh7014aff2003-11-01 01:53:53 +0000109*/
drh33496202016-01-14 19:32:46 +0000110static int getDigits(const char *zDate, const char *zFormat, ...){
111 /* The aMx[] array translates the 3rd character of each format
112 ** spec into a max size: a b c d e f */
113 static const u16 aMx[] = { 12, 14, 24, 31, 59, 9999 };
drheb9a9e82004-02-22 17:49:32 +0000114 va_list ap;
drheb9a9e82004-02-22 17:49:32 +0000115 int cnt = 0;
drh33496202016-01-14 19:32:46 +0000116 char nextC;
117 va_start(ap, zFormat);
drheb9a9e82004-02-22 17:49:32 +0000118 do{
drh33496202016-01-14 19:32:46 +0000119 char N = zFormat[0] - '0';
120 char min = zFormat[1] - '0';
121 int val = 0;
122 u16 max;
123
124 assert( zFormat[2]>='a' && zFormat[2]<='f' );
125 max = aMx[zFormat[2] - 'a'];
126 nextC = zFormat[3];
drheb9a9e82004-02-22 17:49:32 +0000127 val = 0;
128 while( N-- ){
danielk197778ca0e72009-01-20 16:53:39 +0000129 if( !sqlite3Isdigit(*zDate) ){
drh029b44b2006-01-15 00:13:15 +0000130 goto end_getDigits;
drheb9a9e82004-02-22 17:49:32 +0000131 }
132 val = val*10 + *zDate - '0';
133 zDate++;
134 }
drh33496202016-01-14 19:32:46 +0000135 if( val<(int)min || val>(int)max || (nextC!=0 && nextC!=*zDate) ){
drh029b44b2006-01-15 00:13:15 +0000136 goto end_getDigits;
drheb9a9e82004-02-22 17:49:32 +0000137 }
drh33496202016-01-14 19:32:46 +0000138 *va_arg(ap,int*) = val;
drh7014aff2003-11-01 01:53:53 +0000139 zDate++;
drheb9a9e82004-02-22 17:49:32 +0000140 cnt++;
drh33496202016-01-14 19:32:46 +0000141 zFormat += 4;
drheb9a9e82004-02-22 17:49:32 +0000142 }while( nextC );
drh029b44b2006-01-15 00:13:15 +0000143end_getDigits:
drh15b9a152006-01-31 20:49:13 +0000144 va_end(ap);
drheb9a9e82004-02-22 17:49:32 +0000145 return cnt;
drh7014aff2003-11-01 01:53:53 +0000146}
147
148/*
drh7014aff2003-11-01 01:53:53 +0000149** Parse a timezone extension on the end of a date-time.
150** The extension is of the form:
151**
152** (+/-)HH:MM
153**
drh1cfdc902008-02-21 20:40:43 +0000154** Or the "zulu" notation:
155**
156** Z
157**
drh7014aff2003-11-01 01:53:53 +0000158** If the parse is successful, write the number of minutes
drh1cfdc902008-02-21 20:40:43 +0000159** of change in p->tz and return 0. If a parser error occurs,
160** return non-zero.
drh7014aff2003-11-01 01:53:53 +0000161**
162** A missing specifier is not considered an error.
163*/
164static int parseTimezone(const char *zDate, DateTime *p){
165 int sgn = 0;
166 int nHr, nMn;
drh1cfdc902008-02-21 20:40:43 +0000167 int c;
danielk197778ca0e72009-01-20 16:53:39 +0000168 while( sqlite3Isspace(*zDate) ){ zDate++; }
drh7014aff2003-11-01 01:53:53 +0000169 p->tz = 0;
drh1cfdc902008-02-21 20:40:43 +0000170 c = *zDate;
171 if( c=='-' ){
drh7014aff2003-11-01 01:53:53 +0000172 sgn = -1;
drh1cfdc902008-02-21 20:40:43 +0000173 }else if( c=='+' ){
drh7014aff2003-11-01 01:53:53 +0000174 sgn = +1;
drh1cfdc902008-02-21 20:40:43 +0000175 }else if( c=='Z' || c=='z' ){
176 zDate++;
177 goto zulu_time;
drh7014aff2003-11-01 01:53:53 +0000178 }else{
drh1cfdc902008-02-21 20:40:43 +0000179 return c!=0;
drh7014aff2003-11-01 01:53:53 +0000180 }
181 zDate++;
drh33496202016-01-14 19:32:46 +0000182 if( getDigits(zDate, "20b:20e", &nHr, &nMn)!=2 ){
drheb9a9e82004-02-22 17:49:32 +0000183 return 1;
184 }
185 zDate += 5;
drh7014aff2003-11-01 01:53:53 +0000186 p->tz = sgn*(nMn + nHr*60);
drh1cfdc902008-02-21 20:40:43 +0000187zulu_time:
danielk197778ca0e72009-01-20 16:53:39 +0000188 while( sqlite3Isspace(*zDate) ){ zDate++; }
drhcaeca512015-12-23 10:54:48 +0000189 p->tzSet = 1;
drh7014aff2003-11-01 01:53:53 +0000190 return *zDate!=0;
191}
192
193/*
194** Parse times of the form HH:MM or HH:MM:SS or HH:MM:SS.FFFF.
195** The HH, MM, and SS must each be exactly 2 digits. The
196** fractional seconds FFFF can be one or more digits.
197**
198** Return 1 if there is a parsing error and 0 on success.
199*/
200static int parseHhMmSs(const char *zDate, DateTime *p){
201 int h, m, s;
202 double ms = 0.0;
drh33496202016-01-14 19:32:46 +0000203 if( getDigits(zDate, "20c:20e", &h, &m)!=2 ){
drheb9a9e82004-02-22 17:49:32 +0000204 return 1;
205 }
206 zDate += 5;
drh7014aff2003-11-01 01:53:53 +0000207 if( *zDate==':' ){
drheb9a9e82004-02-22 17:49:32 +0000208 zDate++;
drh33496202016-01-14 19:32:46 +0000209 if( getDigits(zDate, "20e", &s)!=1 ){
drheb9a9e82004-02-22 17:49:32 +0000210 return 1;
211 }
212 zDate += 2;
danielk197778ca0e72009-01-20 16:53:39 +0000213 if( *zDate=='.' && sqlite3Isdigit(zDate[1]) ){
drh7014aff2003-11-01 01:53:53 +0000214 double rScale = 1.0;
215 zDate++;
danielk197778ca0e72009-01-20 16:53:39 +0000216 while( sqlite3Isdigit(*zDate) ){
drh7014aff2003-11-01 01:53:53 +0000217 ms = ms*10.0 + *zDate - '0';
218 rScale *= 10.0;
219 zDate++;
220 }
221 ms /= rScale;
222 }
223 }else{
224 s = 0;
225 }
226 p->validJD = 0;
drh861a5682016-12-02 17:08:27 +0000227 p->rawS = 0;
drh7014aff2003-11-01 01:53:53 +0000228 p->validHMS = 1;
229 p->h = h;
230 p->m = m;
231 p->s = s + ms;
232 if( parseTimezone(zDate, p) ) return 1;
shaneaef3af52008-12-09 04:59:00 +0000233 p->validTZ = (p->tz!=0)?1:0;
drh7014aff2003-11-01 01:53:53 +0000234 return 0;
235}
236
237/*
drhd76a9022016-11-30 00:48:28 +0000238** Put the DateTime object into its error state.
239*/
240static void datetimeError(DateTime *p){
241 memset(p, 0, sizeof(*p));
242 p->isError = 1;
243}
244
245/*
drh7014aff2003-11-01 01:53:53 +0000246** Convert from YYYY-MM-DD HH:MM:SS to julian day. We always assume
247** that the YYYY-MM-DD is according to the Gregorian calendar.
248**
249** Reference: Meeus page 61
250*/
251static void computeJD(DateTime *p){
252 int Y, M, D, A, B, X1, X2;
253
254 if( p->validJD ) return;
255 if( p->validYMD ){
256 Y = p->Y;
257 M = p->M;
258 D = p->D;
259 }else{
drhba212562004-01-08 02:17:31 +0000260 Y = 2000; /* If no YMD specified, assume 2000-Jan-01 */
drh7014aff2003-11-01 01:53:53 +0000261 M = 1;
262 D = 1;
263 }
drh861a5682016-12-02 17:08:27 +0000264 if( Y<-4713 || Y>9999 || p->rawS ){
drhd76a9022016-11-30 00:48:28 +0000265 datetimeError(p);
266 return;
267 }
drh7014aff2003-11-01 01:53:53 +0000268 if( M<=2 ){
269 Y--;
270 M += 12;
271 }
272 A = Y/100;
273 B = 2 - A + (A/4);
shaneaef3af52008-12-09 04:59:00 +0000274 X1 = 36525*(Y+4716)/100;
275 X2 = 306001*(M+1)/10000;
276 p->iJD = (sqlite3_int64)((X1 + X2 + D + B - 1524.5 ) * 86400000);
drh7014aff2003-11-01 01:53:53 +0000277 p->validJD = 1;
drh7014aff2003-11-01 01:53:53 +0000278 if( p->validHMS ){
shaneaef3af52008-12-09 04:59:00 +0000279 p->iJD += p->h*3600000 + p->m*60000 + (sqlite3_int64)(p->s*1000);
drh7014aff2003-11-01 01:53:53 +0000280 if( p->validTZ ){
drh85f477a2008-06-12 16:35:38 +0000281 p->iJD -= p->tz*60000;
drhf11c34d2006-09-08 12:27:36 +0000282 p->validYMD = 0;
drh7014aff2003-11-01 01:53:53 +0000283 p->validHMS = 0;
284 p->validTZ = 0;
285 }
286 }
287}
288
289/*
290** Parse dates of the form
291**
292** YYYY-MM-DD HH:MM:SS.FFF
293** YYYY-MM-DD HH:MM:SS
294** YYYY-MM-DD HH:MM
295** YYYY-MM-DD
296**
297** Write the result into the DateTime structure and return 0
298** on success and 1 if the input string is not a well-formed
299** date.
300*/
301static int parseYyyyMmDd(const char *zDate, DateTime *p){
drh8eb2cce2004-02-21 03:28:18 +0000302 int Y, M, D, neg;
drh7014aff2003-11-01 01:53:53 +0000303
drh8eb2cce2004-02-21 03:28:18 +0000304 if( zDate[0]=='-' ){
305 zDate++;
306 neg = 1;
307 }else{
308 neg = 0;
309 }
drh33496202016-01-14 19:32:46 +0000310 if( getDigits(zDate, "40f-21a-21d", &Y, &M, &D)!=3 ){
drheb9a9e82004-02-22 17:49:32 +0000311 return 1;
312 }
313 zDate += 10;
danielk197778ca0e72009-01-20 16:53:39 +0000314 while( sqlite3Isspace(*zDate) || 'T'==*(u8*)zDate ){ zDate++; }
drheb9a9e82004-02-22 17:49:32 +0000315 if( parseHhMmSs(zDate, p)==0 ){
316 /* We got the time */
drh7014aff2003-11-01 01:53:53 +0000317 }else if( *zDate==0 ){
318 p->validHMS = 0;
319 }else{
320 return 1;
321 }
322 p->validJD = 0;
323 p->validYMD = 1;
drh8eb2cce2004-02-21 03:28:18 +0000324 p->Y = neg ? -Y : Y;
drh7014aff2003-11-01 01:53:53 +0000325 p->M = M;
326 p->D = D;
327 if( p->validTZ ){
328 computeJD(p);
329 }
330 return 0;
331}
332
333/*
drh31702252011-10-12 23:13:43 +0000334** Set the time to the current time reported by the VFS.
335**
336** Return the number of errors.
drh3af5d682008-06-12 13:50:00 +0000337*/
drh31702252011-10-12 23:13:43 +0000338static int setDateTimeToCurrent(sqlite3_context *context, DateTime *p){
drh95a7b3e2013-09-16 12:57:19 +0000339 p->iJD = sqlite3StmtCurrentTime(context);
340 if( p->iJD>0 ){
drh31702252011-10-12 23:13:43 +0000341 p->validJD = 1;
342 return 0;
343 }else{
344 return 1;
345 }
drh3af5d682008-06-12 13:50:00 +0000346}
347
348/*
drh861a5682016-12-02 17:08:27 +0000349** Input "r" is a numeric quantity which might be a julian day number,
350** or the number of seconds since 1970. If the value if r is within
351** range of a julian day number, install it as such and set validJD.
352** If the value is a valid unix timestamp, put it in p->s and set p->rawS.
353*/
354static void setRawDateNumber(DateTime *p, double r){
355 p->s = r;
356 p->rawS = 1;
357 if( r>=0.0 && r<5373484.5 ){
358 p->iJD = (sqlite3_int64)(r*86400000.0 + 0.5);
359 p->validJD = 1;
360 }
361}
362
363/*
drh86a11b82014-11-07 13:24:29 +0000364** Attempt to parse the given string into a julian day number. Return
drh7014aff2003-11-01 01:53:53 +0000365** the number of errors.
366**
367** The following are acceptable forms for the input string:
368**
369** YYYY-MM-DD HH:MM:SS.FFF +/-HH:MM
370** DDDD.DD
371** now
372**
373** In the first form, the +/-HH:MM is always optional. The fractional
374** seconds extension (the ".FFF") is optional. The seconds portion
375** (":SS.FFF") is option. The year and date can be omitted as long
376** as there is a time string. The time string can be omitted as long
377** as there is a year and date.
378*/
danielk1977fee2d252007-08-18 10:59:19 +0000379static int parseDateOrTime(
380 sqlite3_context *context,
381 const char *zDate,
382 DateTime *p
383){
drh9339da12010-09-30 00:50:49 +0000384 double r;
drh8eb2cce2004-02-21 03:28:18 +0000385 if( parseYyyyMmDd(zDate,p)==0 ){
drh7014aff2003-11-01 01:53:53 +0000386 return 0;
drh8eb2cce2004-02-21 03:28:18 +0000387 }else if( parseHhMmSs(zDate, p)==0 ){
388 return 0;
drh6e97f8e2017-07-20 13:17:08 +0000389 }else if( sqlite3StrICmp(zDate,"now")==0 && sqlite3NotPureFunc(context) ){
drh31702252011-10-12 23:13:43 +0000390 return setDateTimeToCurrent(context, p);
drh9a278222019-06-07 22:26:08 +0000391 }else if( sqlite3AtoF(zDate, &r, sqlite3Strlen30(zDate), SQLITE_UTF8)>0 ){
drh861a5682016-12-02 17:08:27 +0000392 setRawDateNumber(p, r);
drh7014aff2003-11-01 01:53:53 +0000393 return 0;
394 }
395 return 1;
396}
397
drhfb4e3a32016-12-30 00:09:14 +0000398/* The julian day number for 9999-12-31 23:59:59.999 is 5373484.4999999.
399** Multiplying this by 86400000 gives 464269060799999 as the maximum value
400** for DateTime.iJD.
401**
402** But some older compilers (ex: gcc 4.2.1 on older Macs) cannot deal with
403** such a large integer literal, so we have to encode it.
404*/
405#define INT_464269060799999 ((((i64)0x1a640)<<32)|0x1072fdff)
406
drh7014aff2003-11-01 01:53:53 +0000407/*
drh3edb1572016-11-29 20:39:48 +0000408** Return TRUE if the given julian day number is within range.
409**
410** The input is the JulianDay times 86400000.
411*/
412static int validJulianDay(sqlite3_int64 iJD){
drhfb4e3a32016-12-30 00:09:14 +0000413 return iJD>=0 && iJD<=INT_464269060799999;
drh3edb1572016-11-29 20:39:48 +0000414}
415
416/*
drh7014aff2003-11-01 01:53:53 +0000417** Compute the Year, Month, and Day from the julian day number.
418*/
419static void computeYMD(DateTime *p){
420 int Z, A, B, C, D, E, X1;
421 if( p->validYMD ) return;
drh33a9ad22004-02-29 00:40:32 +0000422 if( !p->validJD ){
423 p->Y = 2000;
424 p->M = 1;
425 p->D = 1;
drh0c3233b2017-04-22 00:20:49 +0000426 }else if( !validJulianDay(p->iJD) ){
427 datetimeError(p);
428 return;
drh33a9ad22004-02-29 00:40:32 +0000429 }else{
shaneaef3af52008-12-09 04:59:00 +0000430 Z = (int)((p->iJD + 43200000)/86400000);
431 A = (int)((Z - 1867216.25)/36524.25);
drh33a9ad22004-02-29 00:40:32 +0000432 A = Z + 1 + A - (A/4);
433 B = A + 1524;
shaneaef3af52008-12-09 04:59:00 +0000434 C = (int)((B - 122.1)/365.25);
drh618ee612015-07-15 18:04:48 +0000435 D = (36525*(C&32767))/100;
shaneaef3af52008-12-09 04:59:00 +0000436 E = (int)((B-D)/30.6001);
437 X1 = (int)(30.6001*E);
drh33a9ad22004-02-29 00:40:32 +0000438 p->D = B - D - X1;
439 p->M = E<14 ? E-1 : E-13;
440 p->Y = p->M>2 ? C - 4716 : C - 4715;
441 }
drh7014aff2003-11-01 01:53:53 +0000442 p->validYMD = 1;
443}
444
445/*
446** Compute the Hour, Minute, and Seconds from the julian day number.
447*/
448static void computeHMS(DateTime *p){
drh85f477a2008-06-12 16:35:38 +0000449 int s;
drh7014aff2003-11-01 01:53:53 +0000450 if( p->validHMS ) return;
drhf11c34d2006-09-08 12:27:36 +0000451 computeJD(p);
shaneaef3af52008-12-09 04:59:00 +0000452 s = (int)((p->iJD + 43200000) % 86400000);
drh85f477a2008-06-12 16:35:38 +0000453 p->s = s/1000.0;
shaneaef3af52008-12-09 04:59:00 +0000454 s = (int)p->s;
drh7014aff2003-11-01 01:53:53 +0000455 p->s -= s;
456 p->h = s/3600;
457 s -= p->h*3600;
458 p->m = s/60;
459 p->s += s - p->m*60;
drh861a5682016-12-02 17:08:27 +0000460 p->rawS = 0;
drh7014aff2003-11-01 01:53:53 +0000461 p->validHMS = 1;
462}
463
464/*
drhba212562004-01-08 02:17:31 +0000465** Compute both YMD and HMS
466*/
467static void computeYMD_HMS(DateTime *p){
468 computeYMD(p);
469 computeHMS(p);
470}
471
472/*
473** Clear the YMD and HMS and the TZ
474*/
475static void clearYMD_HMS_TZ(DateTime *p){
476 p->validYMD = 0;
477 p->validHMS = 0;
478 p->validTZ = 0;
479}
480
mistachkin6cc16fc2016-01-23 01:54:15 +0000481#ifndef SQLITE_OMIT_LOCALTIME
drha924aca2011-06-21 15:01:25 +0000482/*
483** On recent Windows platforms, the localtime_s() function is available
484** as part of the "Secure CRT". It is essentially equivalent to
485** localtime_r() available under most POSIX platforms, except that the
486** order of the parameters is reversed.
487**
488** See http://msdn.microsoft.com/en-us/library/a442x3ye(VS.80).aspx.
489**
490** If the user has not indicated to use localtime_r() or localtime_s()
491** already, check for an MSVC build environment that provides
492** localtime_s().
493*/
drh0ede9eb2015-01-10 16:49:23 +0000494#if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S \
495 && defined(_MSC_VER) && defined(_CRT_INSECURE_DEPRECATE)
496#undef HAVE_LOCALTIME_S
drha924aca2011-06-21 15:01:25 +0000497#define HAVE_LOCALTIME_S 1
498#endif
499
drhba212562004-01-08 02:17:31 +0000500/*
drh8720aeb2011-06-21 14:35:30 +0000501** The following routine implements the rough equivalent of localtime_r()
502** using whatever operating-system specific localtime facility that
503** is available. This routine returns 0 on success and
504** non-zero on any kind of error.
danc17d6962011-06-21 12:47:30 +0000505**
drh8720aeb2011-06-21 14:35:30 +0000506** If the sqlite3GlobalConfig.bLocaltimeFault variable is true then this
507** routine will always fail.
drhe4bf4f02013-10-11 20:14:37 +0000508**
509** EVIDENCE-OF: R-62172-00036 In this implementation, the standard C
510** library function localtime_r() is used to assist in the calculation of
511** local time.
drh7091cb02003-12-23 16:22:18 +0000512*/
drh1f93a082011-06-21 15:54:24 +0000513static int osLocaltime(time_t *t, struct tm *pTm){
drh8720aeb2011-06-21 14:35:30 +0000514 int rc;
drh0ede9eb2015-01-10 16:49:23 +0000515#if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S
drha924aca2011-06-21 15:01:25 +0000516 struct tm *pX;
drhdf3aa162011-06-24 11:29:51 +0000517#if SQLITE_THREADSAFE>0
drhccb21132020-06-19 11:34:57 +0000518 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN);
drhdf3aa162011-06-24 11:29:51 +0000519#endif
drha924aca2011-06-21 15:01:25 +0000520 sqlite3_mutex_enter(mutex);
521 pX = localtime(t);
drhd12602a2016-12-07 15:49:02 +0000522#ifndef SQLITE_UNTESTABLE
drha924aca2011-06-21 15:01:25 +0000523 if( sqlite3GlobalConfig.bLocaltimeFault ) pX = 0;
524#endif
525 if( pX ) *pTm = *pX;
526 sqlite3_mutex_leave(mutex);
527 rc = pX==0;
528#else
drhd12602a2016-12-07 15:49:02 +0000529#ifndef SQLITE_UNTESTABLE
danc17d6962011-06-21 12:47:30 +0000530 if( sqlite3GlobalConfig.bLocaltimeFault ) return 1;
danc17d6962011-06-21 12:47:30 +0000531#endif
drh0ede9eb2015-01-10 16:49:23 +0000532#if HAVE_LOCALTIME_R
drh8720aeb2011-06-21 14:35:30 +0000533 rc = localtime_r(t, pTm)==0;
danc17d6962011-06-21 12:47:30 +0000534#else
drha924aca2011-06-21 15:01:25 +0000535 rc = localtime_s(pTm, t);
536#endif /* HAVE_LOCALTIME_R */
537#endif /* HAVE_LOCALTIME_R || HAVE_LOCALTIME_S */
drh8720aeb2011-06-21 14:35:30 +0000538 return rc;
539}
540#endif /* SQLITE_OMIT_LOCALTIME */
danc17d6962011-06-21 12:47:30 +0000541
542
drh8720aeb2011-06-21 14:35:30 +0000543#ifndef SQLITE_OMIT_LOCALTIME
danc17d6962011-06-21 12:47:30 +0000544/*
545** Compute the difference (in milliseconds) between localtime and UTC
546** (a.k.a. GMT) for the time value p where p is in UTC. If no error occurs,
547** return this value and set *pRc to SQLITE_OK.
548**
549** Or, if an error does occur, set *pRc to SQLITE_ERROR. The returned value
550** is undefined in this case.
551*/
552static sqlite3_int64 localtimeOffset(
553 DateTime *p, /* Date at which to calculate offset */
554 sqlite3_context *pCtx, /* Write error here if one occurs */
555 int *pRc /* OUT: Error code. SQLITE_OK or ERROR */
556){
drh7091cb02003-12-23 16:22:18 +0000557 DateTime x, y;
558 time_t t;
drh8720aeb2011-06-21 14:35:30 +0000559 struct tm sLocal;
560
dan0d37f582011-06-21 15:38:05 +0000561 /* Initialize the contents of sLocal to avoid a compiler warning. */
562 memset(&sLocal, 0, sizeof(sLocal));
563
drh7091cb02003-12-23 16:22:18 +0000564 x = *p;
drhba212562004-01-08 02:17:31 +0000565 computeYMD_HMS(&x);
drh7091cb02003-12-23 16:22:18 +0000566 if( x.Y<1971 || x.Y>=2038 ){
drhe4bf4f02013-10-11 20:14:37 +0000567 /* EVIDENCE-OF: R-55269-29598 The localtime_r() C function normally only
568 ** works for years between 1970 and 2037. For dates outside this range,
569 ** SQLite attempts to map the year into an equivalent year within this
570 ** range, do the calculation, then map the year back.
571 */
drh7091cb02003-12-23 16:22:18 +0000572 x.Y = 2000;
573 x.M = 1;
574 x.D = 1;
575 x.h = 0;
576 x.m = 0;
577 x.s = 0.0;
578 } else {
shaneaef3af52008-12-09 04:59:00 +0000579 int s = (int)(x.s + 0.5);
drh7091cb02003-12-23 16:22:18 +0000580 x.s = s;
581 }
582 x.tz = 0;
583 x.validJD = 0;
584 computeJD(&x);
shane11bb41f2009-09-10 20:23:30 +0000585 t = (time_t)(x.iJD/1000 - 21086676*(i64)10000);
drh8720aeb2011-06-21 14:35:30 +0000586 if( osLocaltime(&t, &sLocal) ){
587 sqlite3_result_error(pCtx, "local time unavailable", -1);
588 *pRc = SQLITE_ERROR;
589 return 0;
drh87595762006-09-08 12:49:43 +0000590 }
drh8720aeb2011-06-21 14:35:30 +0000591 y.Y = sLocal.tm_year + 1900;
592 y.M = sLocal.tm_mon + 1;
593 y.D = sLocal.tm_mday;
594 y.h = sLocal.tm_hour;
595 y.m = sLocal.tm_min;
596 y.s = sLocal.tm_sec;
drh7091cb02003-12-23 16:22:18 +0000597 y.validYMD = 1;
598 y.validHMS = 1;
599 y.validJD = 0;
drh861a5682016-12-02 17:08:27 +0000600 y.rawS = 0;
drh7091cb02003-12-23 16:22:18 +0000601 y.validTZ = 0;
drh861a5682016-12-02 17:08:27 +0000602 y.isError = 0;
drh7091cb02003-12-23 16:22:18 +0000603 computeJD(&y);
danc17d6962011-06-21 12:47:30 +0000604 *pRc = SQLITE_OK;
drh85f477a2008-06-12 16:35:38 +0000605 return y.iJD - x.iJD;
drh7091cb02003-12-23 16:22:18 +0000606}
drh66147c92008-06-12 12:51:37 +0000607#endif /* SQLITE_OMIT_LOCALTIME */
drh7091cb02003-12-23 16:22:18 +0000608
609/*
drh6d4e9c32016-12-02 19:07:03 +0000610** The following table defines various date transformations of the form
611**
612** 'NNN days'
613**
614** Where NNN is an arbitrary floating-point number and "days" can be one
615** of several units of time.
616*/
617static const struct {
618 u8 eType; /* Transformation type code */
619 u8 nName; /* Length of th name */
620 char *zName; /* Name of the transformation */
621 double rLimit; /* Maximum NNN value for this transform */
622 double rXform; /* Constant used for this transform */
623} aXformType[] = {
drhb1243a62020-03-28 12:01:25 +0000624 { 0, 6, "second", 464269060800.0, 1000.0 },
625 { 0, 6, "minute", 7737817680.0, 60000.0 },
626 { 0, 4, "hour", 128963628.0, 3600000.0 },
627 { 0, 3, "day", 5373485.0, 86400000.0 },
628 { 1, 5, "month", 176546.0, 2592000000.0 },
629 { 2, 4, "year", 14713.0, 31536000000.0 },
drh6d4e9c32016-12-02 19:07:03 +0000630};
631
632/*
drh7014aff2003-11-01 01:53:53 +0000633** Process a modifier to a date-time stamp. The modifiers are
634** as follows:
635**
636** NNN days
637** NNN hours
638** NNN minutes
639** NNN.NNNN seconds
640** NNN months
641** NNN years
642** start of month
643** start of year
644** start of week
645** start of day
646** weekday N
647** unixepoch
drh7091cb02003-12-23 16:22:18 +0000648** localtime
649** utc
drh7014aff2003-11-01 01:53:53 +0000650**
danc17d6962011-06-21 12:47:30 +0000651** Return 0 on success and 1 if there is any kind of error. If the error
652** is in a system call (i.e. localtime()), then an error message is written
653** to context pCtx. If the error is an unrecognized modifier, no error is
654** written to pCtx.
drh7014aff2003-11-01 01:53:53 +0000655*/
drh6d4e9c32016-12-02 19:07:03 +0000656static int parseModifier(
657 sqlite3_context *pCtx, /* Function context */
658 const char *z, /* The text of the modifier */
659 int n, /* Length of zMod in bytes */
660 DateTime *p /* The date/time value to be modified */
661){
drh7014aff2003-11-01 01:53:53 +0000662 int rc = 1;
drh7014aff2003-11-01 01:53:53 +0000663 double r;
drh6d4e9c32016-12-02 19:07:03 +0000664 switch(sqlite3UpperToLower[(u8)z[0]] ){
drh1312a9c2021-11-29 17:23:27 +0000665 case 'a': {
666 /*
667 ** auto
668 **
669 ** If rawS is available, then interpret as a julian day number, or
670 ** a unix timestamp, depending on its magnitude.
671 */
672 if( sqlite3_stricmp(z, "auto")==0 ){
673 if( !p->rawS || p->validJD ){
674 rc = 0;
675 p->rawS = 0;
676 }else if( p->s>=-210866760000 && p->s<=253402300799 ){
677 r = p->s*1000.0 + 210866760000000.0;
678 clearYMD_HMS_TZ(p);
679 p->iJD = (sqlite3_int64)(r + 0.5);
680 p->validJD = 1;
681 p->rawS = 0;
682 rc = 0;
683 }
684 }
685 break;
686 }
687 case 'j': {
688 /*
689 ** julianday
690 **
691 ** Always interpret the prior number as a julian-day value. If this
692 ** is not the first modifier, or if the prior argument is not a numeric
693 ** value in the allowed range of julian day numbers understood by
694 ** SQLite (0..5373484.5) then the result will be NULL.
695 */
696 if( sqlite3_stricmp(z, "julianday")==0 ){
697 if( p->validJD && p->rawS ){
698 rc = 0;
699 p->rawS = 0;
700 }
701 }
702 break;
703 }
drh66147c92008-06-12 12:51:37 +0000704#ifndef SQLITE_OMIT_LOCALTIME
drh7091cb02003-12-23 16:22:18 +0000705 case 'l': {
706 /* localtime
707 **
708 ** Assuming the current time value is UTC (a.k.a. GMT), shift it to
709 ** show local time.
710 */
drh6e97f8e2017-07-20 13:17:08 +0000711 if( sqlite3_stricmp(z, "localtime")==0 && sqlite3NotPureFunc(pCtx) ){
drh7091cb02003-12-23 16:22:18 +0000712 computeJD(p);
danc17d6962011-06-21 12:47:30 +0000713 p->iJD += localtimeOffset(p, pCtx, &rc);
drhba212562004-01-08 02:17:31 +0000714 clearYMD_HMS_TZ(p);
drh7091cb02003-12-23 16:22:18 +0000715 }
716 break;
717 }
drh66147c92008-06-12 12:51:37 +0000718#endif
drh7014aff2003-11-01 01:53:53 +0000719 case 'u': {
720 /*
721 ** unixepoch
722 **
drh861a5682016-12-02 17:08:27 +0000723 ** Treat the current value of p->s as the number of
drh7014aff2003-11-01 01:53:53 +0000724 ** seconds since 1970. Convert to a real julian day number.
725 */
drh6d4e9c32016-12-02 19:07:03 +0000726 if( sqlite3_stricmp(z, "unixepoch")==0 && p->rawS ){
drhe6ad1712016-12-05 20:16:04 +0000727 r = p->s*1000.0 + 210866760000000.0;
drh861a5682016-12-02 17:08:27 +0000728 if( r>=0.0 && r<464269060800000.0 ){
729 clearYMD_HMS_TZ(p);
drh915530d2020-01-17 16:47:07 +0000730 p->iJD = (sqlite3_int64)(r + 0.5);
drh861a5682016-12-02 17:08:27 +0000731 p->validJD = 1;
732 p->rawS = 0;
733 rc = 0;
734 }
drh66cccd92008-07-25 16:39:24 +0000735 }
736#ifndef SQLITE_OMIT_LOCALTIME
drh6e97f8e2017-07-20 13:17:08 +0000737 else if( sqlite3_stricmp(z, "utc")==0 && sqlite3NotPureFunc(pCtx) ){
drhcaeca512015-12-23 10:54:48 +0000738 if( p->tzSet==0 ){
739 sqlite3_int64 c1;
740 computeJD(p);
741 c1 = localtimeOffset(p, pCtx, &rc);
742 if( rc==SQLITE_OK ){
743 p->iJD -= c1;
744 clearYMD_HMS_TZ(p);
745 p->iJD += c1 - localtimeOffset(p, pCtx, &rc);
746 }
747 p->tzSet = 1;
748 }else{
749 rc = SQLITE_OK;
danc17d6962011-06-21 12:47:30 +0000750 }
drh7014aff2003-11-01 01:53:53 +0000751 }
drh66cccd92008-07-25 16:39:24 +0000752#endif
drh7014aff2003-11-01 01:53:53 +0000753 break;
754 }
755 case 'w': {
756 /*
757 ** weekday N
758 **
drh181fc992004-08-17 10:42:54 +0000759 ** Move the date to the same time on the next occurrence of
drh7014aff2003-11-01 01:53:53 +0000760 ** weekday N where 0==Sunday, 1==Monday, and so forth. If the
drhc5dd9fa2004-01-07 03:29:16 +0000761 ** date is already on the appropriate weekday, this is a no-op.
drh7014aff2003-11-01 01:53:53 +0000762 */
drh6d4e9c32016-12-02 19:07:03 +0000763 if( sqlite3_strnicmp(z, "weekday ", 8)==0
drh9a278222019-06-07 22:26:08 +0000764 && sqlite3AtoF(&z[8], &r, sqlite3Strlen30(&z[8]), SQLITE_UTF8)>0
drh9339da12010-09-30 00:50:49 +0000765 && (n=(int)r)==r && n>=0 && r<7 ){
drh85f477a2008-06-12 16:35:38 +0000766 sqlite3_int64 Z;
drhba212562004-01-08 02:17:31 +0000767 computeYMD_HMS(p);
drh7014aff2003-11-01 01:53:53 +0000768 p->validTZ = 0;
769 p->validJD = 0;
770 computeJD(p);
drh85f477a2008-06-12 16:35:38 +0000771 Z = ((p->iJD + 129600000)/86400000) % 7;
drh7014aff2003-11-01 01:53:53 +0000772 if( Z>n ) Z -= 7;
drh85f477a2008-06-12 16:35:38 +0000773 p->iJD += (n - Z)*86400000;
drhba212562004-01-08 02:17:31 +0000774 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000775 rc = 0;
776 }
777 break;
778 }
779 case 's': {
780 /*
781 ** start of TTTTT
782 **
783 ** Move the date backwards to the beginning of the current day,
784 ** or month or year.
785 */
drh6d4e9c32016-12-02 19:07:03 +0000786 if( sqlite3_strnicmp(z, "start of ", 9)!=0 ) break;
drh35a09252017-03-03 20:43:43 +0000787 if( !p->validJD && !p->validYMD && !p->validHMS ) break;
drh4d5b8362004-01-17 01:16:21 +0000788 z += 9;
drh7014aff2003-11-01 01:53:53 +0000789 computeYMD(p);
790 p->validHMS = 1;
791 p->h = p->m = 0;
792 p->s = 0.0;
drh9715f7f2017-03-02 23:40:21 +0000793 p->rawS = 0;
drh7014aff2003-11-01 01:53:53 +0000794 p->validTZ = 0;
795 p->validJD = 0;
drh6d4e9c32016-12-02 19:07:03 +0000796 if( sqlite3_stricmp(z,"month")==0 ){
drh7014aff2003-11-01 01:53:53 +0000797 p->D = 1;
798 rc = 0;
drh6d4e9c32016-12-02 19:07:03 +0000799 }else if( sqlite3_stricmp(z,"year")==0 ){
drh7014aff2003-11-01 01:53:53 +0000800 p->M = 1;
801 p->D = 1;
802 rc = 0;
drh6d4e9c32016-12-02 19:07:03 +0000803 }else if( sqlite3_stricmp(z,"day")==0 ){
drh7014aff2003-11-01 01:53:53 +0000804 rc = 0;
805 }
806 break;
807 }
808 case '+':
809 case '-':
810 case '0':
811 case '1':
812 case '2':
813 case '3':
814 case '4':
815 case '5':
816 case '6':
817 case '7':
818 case '8':
819 case '9': {
drhc531a222009-01-30 17:27:44 +0000820 double rRounder;
drh6d4e9c32016-12-02 19:07:03 +0000821 int i;
drh9339da12010-09-30 00:50:49 +0000822 for(n=1; z[n] && z[n]!=':' && !sqlite3Isspace(z[n]); n++){}
drh9a278222019-06-07 22:26:08 +0000823 if( sqlite3AtoF(z, &r, n, SQLITE_UTF8)<=0 ){
drh9339da12010-09-30 00:50:49 +0000824 rc = 1;
825 break;
826 }
drh33a9ad22004-02-29 00:40:32 +0000827 if( z[n]==':' ){
828 /* A modifier of the form (+|-)HH:MM:SS.FFF adds (or subtracts) the
829 ** specified number of hours, minutes, seconds, and fractional seconds
830 ** to the time. The ".FFF" may be omitted. The ":SS.FFF" may be
831 ** omitted.
832 */
833 const char *z2 = z;
834 DateTime tx;
drh85f477a2008-06-12 16:35:38 +0000835 sqlite3_int64 day;
danielk197778ca0e72009-01-20 16:53:39 +0000836 if( !sqlite3Isdigit(*z2) ) z2++;
drh33a9ad22004-02-29 00:40:32 +0000837 memset(&tx, 0, sizeof(tx));
838 if( parseHhMmSs(z2, &tx) ) break;
839 computeJD(&tx);
drh85f477a2008-06-12 16:35:38 +0000840 tx.iJD -= 43200000;
841 day = tx.iJD/86400000;
842 tx.iJD -= day*86400000;
843 if( z[0]=='-' ) tx.iJD = -tx.iJD;
drh0d131ab2004-02-29 01:08:17 +0000844 computeJD(p);
845 clearYMD_HMS_TZ(p);
drh85f477a2008-06-12 16:35:38 +0000846 p->iJD += tx.iJD;
drh33a9ad22004-02-29 00:40:32 +0000847 rc = 0;
848 break;
849 }
drh6d4e9c32016-12-02 19:07:03 +0000850
851 /* If control reaches this point, it means the transformation is
852 ** one of the forms like "+NNN days". */
drh4d5b8362004-01-17 01:16:21 +0000853 z += n;
danielk197778ca0e72009-01-20 16:53:39 +0000854 while( sqlite3Isspace(*z) ) z++;
drhea678832008-12-10 19:26:22 +0000855 n = sqlite3Strlen30(z);
drh7014aff2003-11-01 01:53:53 +0000856 if( n>10 || n<3 ) break;
drh6d4e9c32016-12-02 19:07:03 +0000857 if( sqlite3UpperToLower[(u8)z[n-1]]=='s' ) n--;
drh7014aff2003-11-01 01:53:53 +0000858 computeJD(p);
drh6d4e9c32016-12-02 19:07:03 +0000859 rc = 1;
drhc531a222009-01-30 17:27:44 +0000860 rRounder = r<0 ? -0.5 : +0.5;
drh6d4e9c32016-12-02 19:07:03 +0000861 for(i=0; i<ArraySize(aXformType); i++){
862 if( aXformType[i].nName==n
863 && sqlite3_strnicmp(aXformType[i].zName, z, n)==0
864 && r>-aXformType[i].rLimit && r<aXformType[i].rLimit
865 ){
866 switch( aXformType[i].eType ){
867 case 1: { /* Special processing to add months */
868 int x;
869 computeYMD_HMS(p);
870 p->M += (int)r;
871 x = p->M>0 ? (p->M-1)/12 : (p->M-12)/12;
872 p->Y += x;
873 p->M -= x*12;
874 p->validJD = 0;
875 r -= (int)r;
876 break;
877 }
878 case 2: { /* Special processing to add years */
879 int y = (int)r;
880 computeYMD_HMS(p);
881 p->Y += y;
882 p->validJD = 0;
883 r -= (int)r;
884 break;
885 }
886 }
887 computeJD(p);
888 p->iJD += (sqlite3_int64)(r*aXformType[i].rXform + rRounder);
889 rc = 0;
890 break;
drh7014aff2003-11-01 01:53:53 +0000891 }
drh7014aff2003-11-01 01:53:53 +0000892 }
drhba212562004-01-08 02:17:31 +0000893 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000894 break;
895 }
896 default: {
897 break;
898 }
899 }
900 return rc;
901}
902
903/*
904** Process time function arguments. argv[0] is a date-time stamp.
905** argv[1] and following are modifiers. Parse them all and write
906** the resulting time into the DateTime structure p. Return 0
907** on success and 1 if there are any errors.
drh008e4762008-01-17 22:27:53 +0000908**
909** If there are zero parameters (if even argv[0] is undefined)
910** then assume a default value of "now" for argv[0].
drh7014aff2003-11-01 01:53:53 +0000911*/
danielk1977fee2d252007-08-18 10:59:19 +0000912static int isDate(
913 sqlite3_context *context,
914 int argc,
915 sqlite3_value **argv,
916 DateTime *p
917){
drh6d4e9c32016-12-02 19:07:03 +0000918 int i, n;
drh7a521cf2007-04-25 18:23:52 +0000919 const unsigned char *z;
drh85f477a2008-06-12 16:35:38 +0000920 int eType;
drh3af5d682008-06-12 13:50:00 +0000921 memset(p, 0, sizeof(*p));
drh008e4762008-01-17 22:27:53 +0000922 if( argc==0 ){
drha7d8d4a2021-03-16 18:41:20 +0000923 if( !sqlite3NotPureFunc(context) ) return 1;
drh31702252011-10-12 23:13:43 +0000924 return setDateTimeToCurrent(context, p);
925 }
926 if( (eType = sqlite3_value_type(argv[0]))==SQLITE_FLOAT
drh85f477a2008-06-12 16:35:38 +0000927 || eType==SQLITE_INTEGER ){
drh861a5682016-12-02 17:08:27 +0000928 setRawDateNumber(p, sqlite3_value_double(argv[0]));
drh008e4762008-01-17 22:27:53 +0000929 }else{
930 z = sqlite3_value_text(argv[0]);
drh3af5d682008-06-12 13:50:00 +0000931 if( !z || parseDateOrTime(context, (char*)z, p) ){
932 return 1;
933 }
drh7a521cf2007-04-25 18:23:52 +0000934 }
drh7014aff2003-11-01 01:53:53 +0000935 for(i=1; i<argc; i++){
danc17d6962011-06-21 12:47:30 +0000936 z = sqlite3_value_text(argv[i]);
drh6d4e9c32016-12-02 19:07:03 +0000937 n = sqlite3_value_bytes(argv[i]);
938 if( z==0 || parseModifier(context, (char*)z, n, p) ) return 1;
drh7014aff2003-11-01 01:53:53 +0000939 }
drhb5489b82016-11-30 04:07:57 +0000940 computeJD(p);
941 if( p->isError || !validJulianDay(p->iJD) ) return 1;
drh7014aff2003-11-01 01:53:53 +0000942 return 0;
943}
944
945
946/*
947** The following routines implement the various date and time functions
948** of SQLite.
949*/
950
951/*
952** julianday( TIMESTRING, MOD, MOD, ...)
953**
954** Return the julian day number of the date specified in the arguments
955*/
drhf9b596e2004-05-26 16:54:42 +0000956static void juliandayFunc(
957 sqlite3_context *context,
958 int argc,
959 sqlite3_value **argv
960){
drh7014aff2003-11-01 01:53:53 +0000961 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000962 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000963 computeJD(&x);
drh85f477a2008-06-12 16:35:38 +0000964 sqlite3_result_double(context, x.iJD/86400000.0);
drh7014aff2003-11-01 01:53:53 +0000965 }
966}
967
968/*
drh1312a9c2021-11-29 17:23:27 +0000969** unixepoch( TIMESTRING, MOD, MOD, ...)
970**
971** Return the number of seconds (including fractional seconds) since
972** the unix epoch of 1970-01-01 00:00:00 GMT.
973*/
974static void unixepochFunc(
975 sqlite3_context *context,
976 int argc,
977 sqlite3_value **argv
978){
979 DateTime x;
980 if( isDate(context, argc, argv, &x)==0 ){
981 computeJD(&x);
982 sqlite3_result_int64(context, x.iJD/1000 - 21086676*(i64)10000);
983 }
984}
985
986/*
drh7014aff2003-11-01 01:53:53 +0000987** datetime( TIMESTRING, MOD, MOD, ...)
988**
989** Return YYYY-MM-DD HH:MM:SS
990*/
drhf9b596e2004-05-26 16:54:42 +0000991static void datetimeFunc(
992 sqlite3_context *context,
993 int argc,
994 sqlite3_value **argv
995){
drh7014aff2003-11-01 01:53:53 +0000996 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000997 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000998 char zBuf[100];
drhba212562004-01-08 02:17:31 +0000999 computeYMD_HMS(&x);
drh5bb3eb92007-05-04 13:15:55 +00001000 sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d %02d:%02d:%02d",
1001 x.Y, x.M, x.D, x.h, x.m, (int)(x.s));
danielk1977d8123362004-06-12 09:25:12 +00001002 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +00001003 }
1004}
1005
1006/*
1007** time( TIMESTRING, MOD, MOD, ...)
1008**
1009** Return HH:MM:SS
1010*/
drhf9b596e2004-05-26 16:54:42 +00001011static void timeFunc(
1012 sqlite3_context *context,
1013 int argc,
1014 sqlite3_value **argv
1015){
drh7014aff2003-11-01 01:53:53 +00001016 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +00001017 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +00001018 char zBuf[100];
1019 computeHMS(&x);
drh5bb3eb92007-05-04 13:15:55 +00001020 sqlite3_snprintf(sizeof(zBuf), zBuf, "%02d:%02d:%02d", x.h, x.m, (int)x.s);
danielk1977d8123362004-06-12 09:25:12 +00001021 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +00001022 }
1023}
1024
1025/*
1026** date( TIMESTRING, MOD, MOD, ...)
1027**
1028** Return YYYY-MM-DD
1029*/
drhf9b596e2004-05-26 16:54:42 +00001030static void dateFunc(
1031 sqlite3_context *context,
1032 int argc,
1033 sqlite3_value **argv
1034){
drh7014aff2003-11-01 01:53:53 +00001035 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +00001036 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +00001037 char zBuf[100];
1038 computeYMD(&x);
drh5bb3eb92007-05-04 13:15:55 +00001039 sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d", x.Y, x.M, x.D);
danielk1977d8123362004-06-12 09:25:12 +00001040 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +00001041 }
1042}
1043
1044/*
1045** strftime( FORMAT, TIMESTRING, MOD, MOD, ...)
1046**
1047** Return a string described by FORMAT. Conversions as follows:
1048**
1049** %d day of month
1050** %f ** fractional seconds SS.SSS
1051** %H hour 00-24
1052** %j day of year 000-366
drh86a11b82014-11-07 13:24:29 +00001053** %J ** julian day number
drh7014aff2003-11-01 01:53:53 +00001054** %m month 01-12
1055** %M minute 00-59
1056** %s seconds since 1970-01-01
1057** %S seconds 00-59
1058** %w day of week 0-6 sunday==0
1059** %W week of year 00-53
1060** %Y year 0000-9999
1061** %% %
1062*/
drhf9b596e2004-05-26 16:54:42 +00001063static void strftimeFunc(
1064 sqlite3_context *context,
1065 int argc,
1066 sqlite3_value **argv
1067){
drh7014aff2003-11-01 01:53:53 +00001068 DateTime x;
shaneaef3af52008-12-09 04:59:00 +00001069 size_t i,j;
drh633e6d52008-07-28 19:34:53 +00001070 sqlite3 *db;
drh655814d2015-01-09 01:27:29 +00001071 const char *zFmt;
drh5bf47152021-10-03 00:12:43 +00001072 sqlite3_str sRes;
1073
1074
drh655814d2015-01-09 01:27:29 +00001075 if( argc==0 ) return;
1076 zFmt = (const char*)sqlite3_value_text(argv[0]);
danielk1977fee2d252007-08-18 10:59:19 +00001077 if( zFmt==0 || isDate(context, argc-1, argv+1, &x) ) return;
drh633e6d52008-07-28 19:34:53 +00001078 db = sqlite3_context_db_handle(context);
drh5bf47152021-10-03 00:12:43 +00001079 sqlite3StrAccumInit(&sRes, 0, 0, 0, db->aLimit[SQLITE_LIMIT_LENGTH]);
1080
drh7014aff2003-11-01 01:53:53 +00001081 computeJD(&x);
drhba212562004-01-08 02:17:31 +00001082 computeYMD_HMS(&x);
drh7014aff2003-11-01 01:53:53 +00001083 for(i=j=0; zFmt[i]; i++){
drh5bf47152021-10-03 00:12:43 +00001084 if( zFmt[i]!='%' ) continue;
drh13ca72d2021-10-05 18:59:05 +00001085 if( j<i ) sqlite3_str_append(&sRes, zFmt+j, (int)(i-j));
drh5bf47152021-10-03 00:12:43 +00001086 i++;
1087 j = i + 1;
1088 switch( zFmt[i] ){
1089 case 'd': {
1090 sqlite3_str_appendf(&sRes, "%02d", x.D);
1091 break;
1092 }
1093 case 'f': {
1094 double s = x.s;
1095 if( s>59.999 ) s = 59.999;
1096 sqlite3_str_appendf(&sRes, "%06.3f", s);
1097 break;
1098 }
1099 case 'H': {
1100 sqlite3_str_appendf(&sRes, "%02d", x.h);
1101 break;
1102 }
1103 case 'W': /* Fall thru */
1104 case 'j': {
1105 int nDay; /* Number of days since 1st day of year */
1106 DateTime y = x;
1107 y.validJD = 0;
1108 y.M = 1;
1109 y.D = 1;
1110 computeJD(&y);
1111 nDay = (int)((x.iJD-y.iJD+43200000)/86400000);
1112 if( zFmt[i]=='W' ){
1113 int wd; /* 0=Monday, 1=Tuesday, ... 6=Sunday */
1114 wd = (int)(((x.iJD+43200000)/86400000)%7);
1115 sqlite3_str_appendf(&sRes,"%02d",(nDay+7-wd)/7);
1116 }else{
1117 sqlite3_str_appendf(&sRes,"%03d",nDay+1);
drh7014aff2003-11-01 01:53:53 +00001118 }
drh5bf47152021-10-03 00:12:43 +00001119 break;
1120 }
1121 case 'J': {
1122 sqlite3_str_appendf(&sRes,"%.16g",x.iJD/86400000.0);
1123 break;
1124 }
1125 case 'm': {
1126 sqlite3_str_appendf(&sRes,"%02d",x.M);
1127 break;
1128 }
1129 case 'M': {
1130 sqlite3_str_appendf(&sRes,"%02d",x.m);
1131 break;
1132 }
1133 case 's': {
1134 i64 iS = (i64)(x.iJD/1000 - 21086676*(i64)10000);
1135 sqlite3_str_appendf(&sRes,"%lld",iS);
1136 break;
1137 }
1138 case 'S': {
1139 sqlite3_str_appendf(&sRes,"%02d",(int)x.s);
1140 break;
1141 }
1142 case 'w': {
1143 sqlite3_str_appendchar(&sRes, 1,
1144 (char)(((x.iJD+129600000)/86400000) % 7) + '0');
1145 break;
1146 }
1147 case 'Y': {
1148 sqlite3_str_appendf(&sRes,"%04d",x.Y);
1149 break;
1150 }
1151 case '%': {
1152 sqlite3_str_appendchar(&sRes, 1, '%');
1153 break;
1154 }
1155 default: {
1156 sqlite3_str_reset(&sRes);
1157 return;
drh7014aff2003-11-01 01:53:53 +00001158 }
1159 }
1160 }
drh13ca72d2021-10-05 18:59:05 +00001161 if( j<i ) sqlite3_str_append(&sRes, zFmt+j, (int)(i-j));
drh5bf47152021-10-03 00:12:43 +00001162 sqlite3ResultStrAccum(context, &sRes);
drh7014aff2003-11-01 01:53:53 +00001163}
1164
danielk19777977a172004-11-09 12:44:37 +00001165/*
1166** current_time()
1167**
1168** This function returns the same value as time('now').
1169*/
1170static void ctimeFunc(
1171 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001172 int NotUsed,
1173 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001174){
danielk197762c14b32008-11-19 09:05:26 +00001175 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001176 timeFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001177}
drh7014aff2003-11-01 01:53:53 +00001178
danielk19777977a172004-11-09 12:44:37 +00001179/*
1180** current_date()
1181**
1182** This function returns the same value as date('now').
1183*/
1184static void cdateFunc(
1185 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001186 int NotUsed,
1187 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001188){
danielk197762c14b32008-11-19 09:05:26 +00001189 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001190 dateFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001191}
1192
1193/*
1194** current_timestamp()
1195**
1196** This function returns the same value as datetime('now').
1197*/
1198static void ctimestampFunc(
1199 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001200 int NotUsed,
1201 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001202){
danielk197762c14b32008-11-19 09:05:26 +00001203 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001204 datetimeFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001205}
drh7014aff2003-11-01 01:53:53 +00001206#endif /* !defined(SQLITE_OMIT_DATETIME_FUNCS) */
1207
danielk1977752e6792004-11-09 16:13:33 +00001208#ifdef SQLITE_OMIT_DATETIME_FUNCS
1209/*
1210** If the library is compiled to omit the full-scale date and time
1211** handling (to get a smaller binary), the following minimal version
1212** of the functions current_time(), current_date() and current_timestamp()
1213** are included instead. This is to support column declarations that
1214** include "DEFAULT CURRENT_TIME" etc.
1215**
danielk19772df9fab2004-11-11 01:50:30 +00001216** This function uses the C-library functions time(), gmtime()
danielk1977752e6792004-11-09 16:13:33 +00001217** and strftime(). The format string to pass to strftime() is supplied
1218** as the user-data for the function.
1219*/
danielk1977752e6792004-11-09 16:13:33 +00001220static void currentTimeFunc(
1221 sqlite3_context *context,
1222 int argc,
1223 sqlite3_value **argv
1224){
1225 time_t t;
1226 char *zFormat = (char *)sqlite3_user_data(context);
drhb7e8ea22010-05-03 14:32:30 +00001227 sqlite3_int64 iT;
drh31702252011-10-12 23:13:43 +00001228 struct tm *pTm;
1229 struct tm sNow;
danielk1977752e6792004-11-09 16:13:33 +00001230 char zBuf[20];
danielk1977752e6792004-11-09 16:13:33 +00001231
shanefbd60f82009-02-04 03:59:25 +00001232 UNUSED_PARAMETER(argc);
1233 UNUSED_PARAMETER(argv);
1234
drh95a7b3e2013-09-16 12:57:19 +00001235 iT = sqlite3StmtCurrentTime(context);
1236 if( iT<=0 ) return;
drhd5e6e402010-05-03 19:17:01 +00001237 t = iT/1000 - 10000*(sqlite3_int64)21086676;
drh0ede9eb2015-01-10 16:49:23 +00001238#if HAVE_GMTIME_R
drh31702252011-10-12 23:13:43 +00001239 pTm = gmtime_r(&t, &sNow);
drh87595762006-09-08 12:49:43 +00001240#else
drhccb21132020-06-19 11:34:57 +00001241 sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN));
drh31702252011-10-12 23:13:43 +00001242 pTm = gmtime(&t);
1243 if( pTm ) memcpy(&sNow, pTm, sizeof(sNow));
drhccb21132020-06-19 11:34:57 +00001244 sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MAIN));
drh87595762006-09-08 12:49:43 +00001245#endif
drh31702252011-10-12 23:13:43 +00001246 if( pTm ){
1247 strftime(zBuf, 20, zFormat, &sNow);
1248 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
1249 }
danielk1977752e6792004-11-09 16:13:33 +00001250}
1251#endif
1252
drh7014aff2003-11-01 01:53:53 +00001253/*
1254** This function registered all of the above C functions as SQL
1255** functions. This should be the only routine in this file with
1256** external linkage.
1257*/
drh777c5382008-08-21 20:21:34 +00001258void sqlite3RegisterDateTimeFunctions(void){
drh80738d92016-02-15 00:34:16 +00001259 static FuncDef aDateTimeFuncs[] = {
drhfd1f3942004-07-20 00:39:14 +00001260#ifndef SQLITE_OMIT_DATETIME_FUNCS
drh3e34eab2017-07-19 19:48:40 +00001261 PURE_DATE(julianday, -1, 0, 0, juliandayFunc ),
drh1312a9c2021-11-29 17:23:27 +00001262 PURE_DATE(unixepoch, -1, 0, 0, unixepochFunc ),
drh3e34eab2017-07-19 19:48:40 +00001263 PURE_DATE(date, -1, 0, 0, dateFunc ),
1264 PURE_DATE(time, -1, 0, 0, timeFunc ),
1265 PURE_DATE(datetime, -1, 0, 0, datetimeFunc ),
1266 PURE_DATE(strftime, -1, 0, 0, strftimeFunc ),
drh1d85e402015-08-31 17:34:41 +00001267 DFUNCTION(current_time, 0, 0, 0, ctimeFunc ),
1268 DFUNCTION(current_timestamp, 0, 0, 0, ctimestampFunc),
1269 DFUNCTION(current_date, 0, 0, 0, cdateFunc ),
danielk1977752e6792004-11-09 16:13:33 +00001270#else
drh21717ed2008-10-13 15:35:08 +00001271 STR_FUNCTION(current_time, 0, "%H:%M:%S", 0, currentTimeFunc),
drh2b1e6902010-01-12 19:28:20 +00001272 STR_FUNCTION(current_date, 0, "%Y-%m-%d", 0, currentTimeFunc),
1273 STR_FUNCTION(current_timestamp, 0, "%Y-%m-%d %H:%M:%S", 0, currentTimeFunc),
drh777c5382008-08-21 20:21:34 +00001274#endif
danielk1977752e6792004-11-09 16:13:33 +00001275 };
drh80738d92016-02-15 00:34:16 +00001276 sqlite3InsertBuiltinFuncs(aDateTimeFuncs, ArraySize(aDateTimeFuncs));
drh7014aff2003-11-01 01:53:53 +00001277}