blob: 19733702806fffaa75f650fcfcf21131fba2602c [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
42** ISBM 0-943396-61-1
43** 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 */
73 char validYMD; /* True (1) if Y,M,D are valid */
74 char validHMS; /* True (1) if h,m,s are valid */
75 char validJD; /* True (1) if iJD is valid */
76 char validTZ; /* True (1) if tz is valid */
77 char tzSet; /* Timezone was set explicitly */
78 char isError; /* An overflow has occurred */
drh7014aff2003-11-01 01:53:53 +000079};
80
81
82/*
drh33496202016-01-14 19:32:46 +000083** Convert zDate into one or more integers according to the conversion
84** specifier zFormat.
drheb9a9e82004-02-22 17:49:32 +000085**
drh33496202016-01-14 19:32:46 +000086** zFormat[] contains 4 characters for each integer converted, except for
87** the last integer which is specified by three characters. The meaning
88** of a four-character format specifiers ABCD is:
drheb9a9e82004-02-22 17:49:32 +000089**
drh33496202016-01-14 19:32:46 +000090** A: number of digits to convert. Always "2" or "4".
91** B: minimum value. Always "0" or "1".
92** C: maximum value, decoded as:
93** a: 12
94** b: 14
95** c: 24
96** d: 31
97** e: 59
98** f: 9999
99** D: the separator character, or \000 to indicate this is the
100** last number to convert.
101**
102** Example: To translate an ISO-8601 date YYYY-MM-DD, the format would
103** be "40f-21a-20c". The "40f-" indicates the 4-digit year followed by "-".
104** The "21a-" indicates the 2-digit month followed by "-". The "20c" indicates
105** the 2-digit day which is the last integer in the set.
106**
drheb9a9e82004-02-22 17:49:32 +0000107** The function returns the number of successful conversions.
drh7014aff2003-11-01 01:53:53 +0000108*/
drh33496202016-01-14 19:32:46 +0000109static int getDigits(const char *zDate, const char *zFormat, ...){
110 /* The aMx[] array translates the 3rd character of each format
111 ** spec into a max size: a b c d e f */
112 static const u16 aMx[] = { 12, 14, 24, 31, 59, 9999 };
drheb9a9e82004-02-22 17:49:32 +0000113 va_list ap;
drheb9a9e82004-02-22 17:49:32 +0000114 int cnt = 0;
drh33496202016-01-14 19:32:46 +0000115 char nextC;
116 va_start(ap, zFormat);
drheb9a9e82004-02-22 17:49:32 +0000117 do{
drh33496202016-01-14 19:32:46 +0000118 char N = zFormat[0] - '0';
119 char min = zFormat[1] - '0';
120 int val = 0;
121 u16 max;
122
123 assert( zFormat[2]>='a' && zFormat[2]<='f' );
124 max = aMx[zFormat[2] - 'a'];
125 nextC = zFormat[3];
drheb9a9e82004-02-22 17:49:32 +0000126 val = 0;
127 while( N-- ){
danielk197778ca0e72009-01-20 16:53:39 +0000128 if( !sqlite3Isdigit(*zDate) ){
drh029b44b2006-01-15 00:13:15 +0000129 goto end_getDigits;
drheb9a9e82004-02-22 17:49:32 +0000130 }
131 val = val*10 + *zDate - '0';
132 zDate++;
133 }
drh33496202016-01-14 19:32:46 +0000134 if( val<(int)min || val>(int)max || (nextC!=0 && nextC!=*zDate) ){
drh029b44b2006-01-15 00:13:15 +0000135 goto end_getDigits;
drheb9a9e82004-02-22 17:49:32 +0000136 }
drh33496202016-01-14 19:32:46 +0000137 *va_arg(ap,int*) = val;
drh7014aff2003-11-01 01:53:53 +0000138 zDate++;
drheb9a9e82004-02-22 17:49:32 +0000139 cnt++;
drh33496202016-01-14 19:32:46 +0000140 zFormat += 4;
drheb9a9e82004-02-22 17:49:32 +0000141 }while( nextC );
drh029b44b2006-01-15 00:13:15 +0000142end_getDigits:
drh15b9a152006-01-31 20:49:13 +0000143 va_end(ap);
drheb9a9e82004-02-22 17:49:32 +0000144 return cnt;
drh7014aff2003-11-01 01:53:53 +0000145}
146
147/*
drh7014aff2003-11-01 01:53:53 +0000148** Parse a timezone extension on the end of a date-time.
149** The extension is of the form:
150**
151** (+/-)HH:MM
152**
drh1cfdc902008-02-21 20:40:43 +0000153** Or the "zulu" notation:
154**
155** Z
156**
drh7014aff2003-11-01 01:53:53 +0000157** If the parse is successful, write the number of minutes
drh1cfdc902008-02-21 20:40:43 +0000158** of change in p->tz and return 0. If a parser error occurs,
159** return non-zero.
drh7014aff2003-11-01 01:53:53 +0000160**
161** A missing specifier is not considered an error.
162*/
163static int parseTimezone(const char *zDate, DateTime *p){
164 int sgn = 0;
165 int nHr, nMn;
drh1cfdc902008-02-21 20:40:43 +0000166 int c;
danielk197778ca0e72009-01-20 16:53:39 +0000167 while( sqlite3Isspace(*zDate) ){ zDate++; }
drh7014aff2003-11-01 01:53:53 +0000168 p->tz = 0;
drh1cfdc902008-02-21 20:40:43 +0000169 c = *zDate;
170 if( c=='-' ){
drh7014aff2003-11-01 01:53:53 +0000171 sgn = -1;
drh1cfdc902008-02-21 20:40:43 +0000172 }else if( c=='+' ){
drh7014aff2003-11-01 01:53:53 +0000173 sgn = +1;
drh1cfdc902008-02-21 20:40:43 +0000174 }else if( c=='Z' || c=='z' ){
175 zDate++;
176 goto zulu_time;
drh7014aff2003-11-01 01:53:53 +0000177 }else{
drh1cfdc902008-02-21 20:40:43 +0000178 return c!=0;
drh7014aff2003-11-01 01:53:53 +0000179 }
180 zDate++;
drh33496202016-01-14 19:32:46 +0000181 if( getDigits(zDate, "20b:20e", &nHr, &nMn)!=2 ){
drheb9a9e82004-02-22 17:49:32 +0000182 return 1;
183 }
184 zDate += 5;
drh7014aff2003-11-01 01:53:53 +0000185 p->tz = sgn*(nMn + nHr*60);
drh1cfdc902008-02-21 20:40:43 +0000186zulu_time:
danielk197778ca0e72009-01-20 16:53:39 +0000187 while( sqlite3Isspace(*zDate) ){ zDate++; }
drhcaeca512015-12-23 10:54:48 +0000188 p->tzSet = 1;
drh7014aff2003-11-01 01:53:53 +0000189 return *zDate!=0;
190}
191
192/*
193** Parse times of the form HH:MM or HH:MM:SS or HH:MM:SS.FFFF.
194** The HH, MM, and SS must each be exactly 2 digits. The
195** fractional seconds FFFF can be one or more digits.
196**
197** Return 1 if there is a parsing error and 0 on success.
198*/
199static int parseHhMmSs(const char *zDate, DateTime *p){
200 int h, m, s;
201 double ms = 0.0;
drh33496202016-01-14 19:32:46 +0000202 if( getDigits(zDate, "20c:20e", &h, &m)!=2 ){
drheb9a9e82004-02-22 17:49:32 +0000203 return 1;
204 }
205 zDate += 5;
drh7014aff2003-11-01 01:53:53 +0000206 if( *zDate==':' ){
drheb9a9e82004-02-22 17:49:32 +0000207 zDate++;
drh33496202016-01-14 19:32:46 +0000208 if( getDigits(zDate, "20e", &s)!=1 ){
drheb9a9e82004-02-22 17:49:32 +0000209 return 1;
210 }
211 zDate += 2;
danielk197778ca0e72009-01-20 16:53:39 +0000212 if( *zDate=='.' && sqlite3Isdigit(zDate[1]) ){
drh7014aff2003-11-01 01:53:53 +0000213 double rScale = 1.0;
214 zDate++;
danielk197778ca0e72009-01-20 16:53:39 +0000215 while( sqlite3Isdigit(*zDate) ){
drh7014aff2003-11-01 01:53:53 +0000216 ms = ms*10.0 + *zDate - '0';
217 rScale *= 10.0;
218 zDate++;
219 }
220 ms /= rScale;
221 }
222 }else{
223 s = 0;
224 }
225 p->validJD = 0;
226 p->validHMS = 1;
227 p->h = h;
228 p->m = m;
229 p->s = s + ms;
230 if( parseTimezone(zDate, p) ) return 1;
shaneaef3af52008-12-09 04:59:00 +0000231 p->validTZ = (p->tz!=0)?1:0;
drh7014aff2003-11-01 01:53:53 +0000232 return 0;
233}
234
235/*
drhd76a9022016-11-30 00:48:28 +0000236** Put the DateTime object into its error state.
237*/
238static void datetimeError(DateTime *p){
239 memset(p, 0, sizeof(*p));
240 p->isError = 1;
241}
242
243/*
drh7014aff2003-11-01 01:53:53 +0000244** Convert from YYYY-MM-DD HH:MM:SS to julian day. We always assume
245** that the YYYY-MM-DD is according to the Gregorian calendar.
246**
247** Reference: Meeus page 61
248*/
249static void computeJD(DateTime *p){
250 int Y, M, D, A, B, X1, X2;
251
252 if( p->validJD ) return;
253 if( p->validYMD ){
254 Y = p->Y;
255 M = p->M;
256 D = p->D;
257 }else{
drhba212562004-01-08 02:17:31 +0000258 Y = 2000; /* If no YMD specified, assume 2000-Jan-01 */
drh7014aff2003-11-01 01:53:53 +0000259 M = 1;
260 D = 1;
261 }
drhd76a9022016-11-30 00:48:28 +0000262 if( Y<-4713 || Y>9999 ){
263 datetimeError(p);
264 return;
265 }
drh7014aff2003-11-01 01:53:53 +0000266 if( M<=2 ){
267 Y--;
268 M += 12;
269 }
270 A = Y/100;
271 B = 2 - A + (A/4);
shaneaef3af52008-12-09 04:59:00 +0000272 X1 = 36525*(Y+4716)/100;
273 X2 = 306001*(M+1)/10000;
274 p->iJD = (sqlite3_int64)((X1 + X2 + D + B - 1524.5 ) * 86400000);
drh7014aff2003-11-01 01:53:53 +0000275 p->validJD = 1;
drh7014aff2003-11-01 01:53:53 +0000276 if( p->validHMS ){
shaneaef3af52008-12-09 04:59:00 +0000277 p->iJD += p->h*3600000 + p->m*60000 + (sqlite3_int64)(p->s*1000);
drh7014aff2003-11-01 01:53:53 +0000278 if( p->validTZ ){
drh85f477a2008-06-12 16:35:38 +0000279 p->iJD -= p->tz*60000;
drhf11c34d2006-09-08 12:27:36 +0000280 p->validYMD = 0;
drh7014aff2003-11-01 01:53:53 +0000281 p->validHMS = 0;
282 p->validTZ = 0;
283 }
284 }
285}
286
287/*
288** Parse dates of the form
289**
290** YYYY-MM-DD HH:MM:SS.FFF
291** YYYY-MM-DD HH:MM:SS
292** YYYY-MM-DD HH:MM
293** YYYY-MM-DD
294**
295** Write the result into the DateTime structure and return 0
296** on success and 1 if the input string is not a well-formed
297** date.
298*/
299static int parseYyyyMmDd(const char *zDate, DateTime *p){
drh8eb2cce2004-02-21 03:28:18 +0000300 int Y, M, D, neg;
drh7014aff2003-11-01 01:53:53 +0000301
drh8eb2cce2004-02-21 03:28:18 +0000302 if( zDate[0]=='-' ){
303 zDate++;
304 neg = 1;
305 }else{
306 neg = 0;
307 }
drh33496202016-01-14 19:32:46 +0000308 if( getDigits(zDate, "40f-21a-21d", &Y, &M, &D)!=3 ){
drheb9a9e82004-02-22 17:49:32 +0000309 return 1;
310 }
311 zDate += 10;
danielk197778ca0e72009-01-20 16:53:39 +0000312 while( sqlite3Isspace(*zDate) || 'T'==*(u8*)zDate ){ zDate++; }
drheb9a9e82004-02-22 17:49:32 +0000313 if( parseHhMmSs(zDate, p)==0 ){
314 /* We got the time */
drh7014aff2003-11-01 01:53:53 +0000315 }else if( *zDate==0 ){
316 p->validHMS = 0;
317 }else{
318 return 1;
319 }
320 p->validJD = 0;
321 p->validYMD = 1;
drh8eb2cce2004-02-21 03:28:18 +0000322 p->Y = neg ? -Y : Y;
drh7014aff2003-11-01 01:53:53 +0000323 p->M = M;
324 p->D = D;
325 if( p->validTZ ){
326 computeJD(p);
327 }
328 return 0;
329}
330
331/*
drh31702252011-10-12 23:13:43 +0000332** Set the time to the current time reported by the VFS.
333**
334** Return the number of errors.
drh3af5d682008-06-12 13:50:00 +0000335*/
drh31702252011-10-12 23:13:43 +0000336static int setDateTimeToCurrent(sqlite3_context *context, DateTime *p){
drh95a7b3e2013-09-16 12:57:19 +0000337 p->iJD = sqlite3StmtCurrentTime(context);
338 if( p->iJD>0 ){
drh31702252011-10-12 23:13:43 +0000339 p->validJD = 1;
340 return 0;
341 }else{
342 return 1;
343 }
drh3af5d682008-06-12 13:50:00 +0000344}
345
346/*
drh86a11b82014-11-07 13:24:29 +0000347** Attempt to parse the given string into a julian day number. Return
drh7014aff2003-11-01 01:53:53 +0000348** the number of errors.
349**
350** The following are acceptable forms for the input string:
351**
352** YYYY-MM-DD HH:MM:SS.FFF +/-HH:MM
353** DDDD.DD
354** now
355**
356** In the first form, the +/-HH:MM is always optional. The fractional
357** seconds extension (the ".FFF") is optional. The seconds portion
358** (":SS.FFF") is option. The year and date can be omitted as long
359** as there is a time string. The time string can be omitted as long
360** as there is a year and date.
361*/
danielk1977fee2d252007-08-18 10:59:19 +0000362static int parseDateOrTime(
363 sqlite3_context *context,
364 const char *zDate,
365 DateTime *p
366){
drh9339da12010-09-30 00:50:49 +0000367 double r;
drh8eb2cce2004-02-21 03:28:18 +0000368 if( parseYyyyMmDd(zDate,p)==0 ){
drh7014aff2003-11-01 01:53:53 +0000369 return 0;
drh8eb2cce2004-02-21 03:28:18 +0000370 }else if( parseHhMmSs(zDate, p)==0 ){
371 return 0;
danielk19774adee202004-05-08 08:23:19 +0000372 }else if( sqlite3StrICmp(zDate,"now")==0){
drh31702252011-10-12 23:13:43 +0000373 return setDateTimeToCurrent(context, p);
drh9339da12010-09-30 00:50:49 +0000374 }else if( sqlite3AtoF(zDate, &r, sqlite3Strlen30(zDate), SQLITE_UTF8) ){
drh85f477a2008-06-12 16:35:38 +0000375 p->iJD = (sqlite3_int64)(r*86400000.0 + 0.5);
drh7014aff2003-11-01 01:53:53 +0000376 p->validJD = 1;
377 return 0;
378 }
379 return 1;
380}
381
382/*
drh3edb1572016-11-29 20:39:48 +0000383** Return TRUE if the given julian day number is within range.
384**
385** The input is the JulianDay times 86400000.
386*/
387static int validJulianDay(sqlite3_int64 iJD){
drhd76a9022016-11-30 00:48:28 +0000388 return iJD>=0 && iJD<=464269060799999;
drh3edb1572016-11-29 20:39:48 +0000389}
390
391/*
drh7014aff2003-11-01 01:53:53 +0000392** Compute the Year, Month, and Day from the julian day number.
393*/
394static void computeYMD(DateTime *p){
395 int Z, A, B, C, D, E, X1;
396 if( p->validYMD ) return;
drh33a9ad22004-02-29 00:40:32 +0000397 if( !p->validJD ){
398 p->Y = 2000;
399 p->M = 1;
400 p->D = 1;
drh3edb1572016-11-29 20:39:48 +0000401 }else if( !validJulianDay(p->iJD) ){
drhd76a9022016-11-30 00:48:28 +0000402 datetimeError(p);
drh3edb1572016-11-29 20:39:48 +0000403 return;
drh33a9ad22004-02-29 00:40:32 +0000404 }else{
shaneaef3af52008-12-09 04:59:00 +0000405 Z = (int)((p->iJD + 43200000)/86400000);
406 A = (int)((Z - 1867216.25)/36524.25);
drh33a9ad22004-02-29 00:40:32 +0000407 A = Z + 1 + A - (A/4);
408 B = A + 1524;
shaneaef3af52008-12-09 04:59:00 +0000409 C = (int)((B - 122.1)/365.25);
drh618ee612015-07-15 18:04:48 +0000410 D = (36525*(C&32767))/100;
shaneaef3af52008-12-09 04:59:00 +0000411 E = (int)((B-D)/30.6001);
412 X1 = (int)(30.6001*E);
drh33a9ad22004-02-29 00:40:32 +0000413 p->D = B - D - X1;
414 p->M = E<14 ? E-1 : E-13;
415 p->Y = p->M>2 ? C - 4716 : C - 4715;
416 }
drh7014aff2003-11-01 01:53:53 +0000417 p->validYMD = 1;
418}
419
420/*
421** Compute the Hour, Minute, and Seconds from the julian day number.
422*/
423static void computeHMS(DateTime *p){
drh85f477a2008-06-12 16:35:38 +0000424 int s;
drh7014aff2003-11-01 01:53:53 +0000425 if( p->validHMS ) return;
drhf11c34d2006-09-08 12:27:36 +0000426 computeJD(p);
shaneaef3af52008-12-09 04:59:00 +0000427 s = (int)((p->iJD + 43200000) % 86400000);
drh85f477a2008-06-12 16:35:38 +0000428 p->s = s/1000.0;
shaneaef3af52008-12-09 04:59:00 +0000429 s = (int)p->s;
drh7014aff2003-11-01 01:53:53 +0000430 p->s -= s;
431 p->h = s/3600;
432 s -= p->h*3600;
433 p->m = s/60;
434 p->s += s - p->m*60;
435 p->validHMS = 1;
436}
437
438/*
drhba212562004-01-08 02:17:31 +0000439** Compute both YMD and HMS
440*/
441static void computeYMD_HMS(DateTime *p){
442 computeYMD(p);
443 computeHMS(p);
444}
445
446/*
447** Clear the YMD and HMS and the TZ
448*/
449static void clearYMD_HMS_TZ(DateTime *p){
450 p->validYMD = 0;
451 p->validHMS = 0;
452 p->validTZ = 0;
453}
454
mistachkin6cc16fc2016-01-23 01:54:15 +0000455#ifndef SQLITE_OMIT_LOCALTIME
drha924aca2011-06-21 15:01:25 +0000456/*
457** On recent Windows platforms, the localtime_s() function is available
458** as part of the "Secure CRT". It is essentially equivalent to
459** localtime_r() available under most POSIX platforms, except that the
460** order of the parameters is reversed.
461**
462** See http://msdn.microsoft.com/en-us/library/a442x3ye(VS.80).aspx.
463**
464** If the user has not indicated to use localtime_r() or localtime_s()
465** already, check for an MSVC build environment that provides
466** localtime_s().
467*/
drh0ede9eb2015-01-10 16:49:23 +0000468#if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S \
469 && defined(_MSC_VER) && defined(_CRT_INSECURE_DEPRECATE)
470#undef HAVE_LOCALTIME_S
drha924aca2011-06-21 15:01:25 +0000471#define HAVE_LOCALTIME_S 1
472#endif
473
drhba212562004-01-08 02:17:31 +0000474/*
drh8720aeb2011-06-21 14:35:30 +0000475** The following routine implements the rough equivalent of localtime_r()
476** using whatever operating-system specific localtime facility that
477** is available. This routine returns 0 on success and
478** non-zero on any kind of error.
danc17d6962011-06-21 12:47:30 +0000479**
drh8720aeb2011-06-21 14:35:30 +0000480** If the sqlite3GlobalConfig.bLocaltimeFault variable is true then this
481** routine will always fail.
drhe4bf4f02013-10-11 20:14:37 +0000482**
483** EVIDENCE-OF: R-62172-00036 In this implementation, the standard C
484** library function localtime_r() is used to assist in the calculation of
485** local time.
drh7091cb02003-12-23 16:22:18 +0000486*/
drh1f93a082011-06-21 15:54:24 +0000487static int osLocaltime(time_t *t, struct tm *pTm){
drh8720aeb2011-06-21 14:35:30 +0000488 int rc;
drh0ede9eb2015-01-10 16:49:23 +0000489#if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S
drha924aca2011-06-21 15:01:25 +0000490 struct tm *pX;
drhdf3aa162011-06-24 11:29:51 +0000491#if SQLITE_THREADSAFE>0
drha924aca2011-06-21 15:01:25 +0000492 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhdf3aa162011-06-24 11:29:51 +0000493#endif
drha924aca2011-06-21 15:01:25 +0000494 sqlite3_mutex_enter(mutex);
495 pX = localtime(t);
496#ifndef SQLITE_OMIT_BUILTIN_TEST
497 if( sqlite3GlobalConfig.bLocaltimeFault ) pX = 0;
498#endif
499 if( pX ) *pTm = *pX;
500 sqlite3_mutex_leave(mutex);
501 rc = pX==0;
502#else
danc17d6962011-06-21 12:47:30 +0000503#ifndef SQLITE_OMIT_BUILTIN_TEST
danc17d6962011-06-21 12:47:30 +0000504 if( sqlite3GlobalConfig.bLocaltimeFault ) return 1;
danc17d6962011-06-21 12:47:30 +0000505#endif
drh0ede9eb2015-01-10 16:49:23 +0000506#if HAVE_LOCALTIME_R
drh8720aeb2011-06-21 14:35:30 +0000507 rc = localtime_r(t, pTm)==0;
danc17d6962011-06-21 12:47:30 +0000508#else
drha924aca2011-06-21 15:01:25 +0000509 rc = localtime_s(pTm, t);
510#endif /* HAVE_LOCALTIME_R */
511#endif /* HAVE_LOCALTIME_R || HAVE_LOCALTIME_S */
drh8720aeb2011-06-21 14:35:30 +0000512 return rc;
513}
514#endif /* SQLITE_OMIT_LOCALTIME */
danc17d6962011-06-21 12:47:30 +0000515
516
drh8720aeb2011-06-21 14:35:30 +0000517#ifndef SQLITE_OMIT_LOCALTIME
danc17d6962011-06-21 12:47:30 +0000518/*
519** Compute the difference (in milliseconds) between localtime and UTC
520** (a.k.a. GMT) for the time value p where p is in UTC. If no error occurs,
521** return this value and set *pRc to SQLITE_OK.
522**
523** Or, if an error does occur, set *pRc to SQLITE_ERROR. The returned value
524** is undefined in this case.
525*/
526static sqlite3_int64 localtimeOffset(
527 DateTime *p, /* Date at which to calculate offset */
528 sqlite3_context *pCtx, /* Write error here if one occurs */
529 int *pRc /* OUT: Error code. SQLITE_OK or ERROR */
530){
drh7091cb02003-12-23 16:22:18 +0000531 DateTime x, y;
532 time_t t;
drh8720aeb2011-06-21 14:35:30 +0000533 struct tm sLocal;
534
dan0d37f582011-06-21 15:38:05 +0000535 /* Initialize the contents of sLocal to avoid a compiler warning. */
536 memset(&sLocal, 0, sizeof(sLocal));
537
drh7091cb02003-12-23 16:22:18 +0000538 x = *p;
drhba212562004-01-08 02:17:31 +0000539 computeYMD_HMS(&x);
drh7091cb02003-12-23 16:22:18 +0000540 if( x.Y<1971 || x.Y>=2038 ){
drhe4bf4f02013-10-11 20:14:37 +0000541 /* EVIDENCE-OF: R-55269-29598 The localtime_r() C function normally only
542 ** works for years between 1970 and 2037. For dates outside this range,
543 ** SQLite attempts to map the year into an equivalent year within this
544 ** range, do the calculation, then map the year back.
545 */
drh7091cb02003-12-23 16:22:18 +0000546 x.Y = 2000;
547 x.M = 1;
548 x.D = 1;
549 x.h = 0;
550 x.m = 0;
551 x.s = 0.0;
552 } else {
shaneaef3af52008-12-09 04:59:00 +0000553 int s = (int)(x.s + 0.5);
drh7091cb02003-12-23 16:22:18 +0000554 x.s = s;
555 }
556 x.tz = 0;
557 x.validJD = 0;
558 computeJD(&x);
shane11bb41f2009-09-10 20:23:30 +0000559 t = (time_t)(x.iJD/1000 - 21086676*(i64)10000);
drh8720aeb2011-06-21 14:35:30 +0000560 if( osLocaltime(&t, &sLocal) ){
561 sqlite3_result_error(pCtx, "local time unavailable", -1);
562 *pRc = SQLITE_ERROR;
563 return 0;
drh87595762006-09-08 12:49:43 +0000564 }
drh8720aeb2011-06-21 14:35:30 +0000565 y.Y = sLocal.tm_year + 1900;
566 y.M = sLocal.tm_mon + 1;
567 y.D = sLocal.tm_mday;
568 y.h = sLocal.tm_hour;
569 y.m = sLocal.tm_min;
570 y.s = sLocal.tm_sec;
drh7091cb02003-12-23 16:22:18 +0000571 y.validYMD = 1;
572 y.validHMS = 1;
573 y.validJD = 0;
574 y.validTZ = 0;
575 computeJD(&y);
danc17d6962011-06-21 12:47:30 +0000576 *pRc = SQLITE_OK;
drh85f477a2008-06-12 16:35:38 +0000577 return y.iJD - x.iJD;
drh7091cb02003-12-23 16:22:18 +0000578}
drh66147c92008-06-12 12:51:37 +0000579#endif /* SQLITE_OMIT_LOCALTIME */
drh7091cb02003-12-23 16:22:18 +0000580
581/*
drh7014aff2003-11-01 01:53:53 +0000582** Process a modifier to a date-time stamp. The modifiers are
583** as follows:
584**
585** NNN days
586** NNN hours
587** NNN minutes
588** NNN.NNNN seconds
589** NNN months
590** NNN years
591** start of month
592** start of year
593** start of week
594** start of day
595** weekday N
596** unixepoch
drh7091cb02003-12-23 16:22:18 +0000597** localtime
598** utc
drh7014aff2003-11-01 01:53:53 +0000599**
danc17d6962011-06-21 12:47:30 +0000600** Return 0 on success and 1 if there is any kind of error. If the error
601** is in a system call (i.e. localtime()), then an error message is written
602** to context pCtx. If the error is an unrecognized modifier, no error is
603** written to pCtx.
drh7014aff2003-11-01 01:53:53 +0000604*/
danc17d6962011-06-21 12:47:30 +0000605static int parseModifier(sqlite3_context *pCtx, const char *zMod, DateTime *p){
drh7014aff2003-11-01 01:53:53 +0000606 int rc = 1;
607 int n;
608 double r;
drh4d5b8362004-01-17 01:16:21 +0000609 char *z, zBuf[30];
610 z = zBuf;
danielk197700e13612008-11-17 19:18:54 +0000611 for(n=0; n<ArraySize(zBuf)-1 && zMod[n]; n++){
drh1bd10f82008-12-10 21:19:56 +0000612 z[n] = (char)sqlite3UpperToLower[(u8)zMod[n]];
drh7014aff2003-11-01 01:53:53 +0000613 }
614 z[n] = 0;
615 switch( z[0] ){
drh66147c92008-06-12 12:51:37 +0000616#ifndef SQLITE_OMIT_LOCALTIME
drh7091cb02003-12-23 16:22:18 +0000617 case 'l': {
618 /* localtime
619 **
620 ** Assuming the current time value is UTC (a.k.a. GMT), shift it to
621 ** show local time.
622 */
623 if( strcmp(z, "localtime")==0 ){
624 computeJD(p);
danc17d6962011-06-21 12:47:30 +0000625 p->iJD += localtimeOffset(p, pCtx, &rc);
drhba212562004-01-08 02:17:31 +0000626 clearYMD_HMS_TZ(p);
drh7091cb02003-12-23 16:22:18 +0000627 }
628 break;
629 }
drh66147c92008-06-12 12:51:37 +0000630#endif
drh7014aff2003-11-01 01:53:53 +0000631 case 'u': {
632 /*
633 ** unixepoch
634 **
drh85f477a2008-06-12 16:35:38 +0000635 ** Treat the current value of p->iJD as the number of
drh7014aff2003-11-01 01:53:53 +0000636 ** seconds since 1970. Convert to a real julian day number.
637 */
638 if( strcmp(z, "unixepoch")==0 && p->validJD ){
drh7fee3602009-04-16 12:58:03 +0000639 p->iJD = (p->iJD + 43200)/86400 + 21086676*(i64)10000000;
drhba212562004-01-08 02:17:31 +0000640 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000641 rc = 0;
drh66cccd92008-07-25 16:39:24 +0000642 }
643#ifndef SQLITE_OMIT_LOCALTIME
644 else if( strcmp(z, "utc")==0 ){
drhcaeca512015-12-23 10:54:48 +0000645 if( p->tzSet==0 ){
646 sqlite3_int64 c1;
647 computeJD(p);
648 c1 = localtimeOffset(p, pCtx, &rc);
649 if( rc==SQLITE_OK ){
650 p->iJD -= c1;
651 clearYMD_HMS_TZ(p);
652 p->iJD += c1 - localtimeOffset(p, pCtx, &rc);
653 }
654 p->tzSet = 1;
655 }else{
656 rc = SQLITE_OK;
danc17d6962011-06-21 12:47:30 +0000657 }
drh7014aff2003-11-01 01:53:53 +0000658 }
drh66cccd92008-07-25 16:39:24 +0000659#endif
drh7014aff2003-11-01 01:53:53 +0000660 break;
661 }
662 case 'w': {
663 /*
664 ** weekday N
665 **
drh181fc992004-08-17 10:42:54 +0000666 ** Move the date to the same time on the next occurrence of
drh7014aff2003-11-01 01:53:53 +0000667 ** weekday N where 0==Sunday, 1==Monday, and so forth. If the
drhc5dd9fa2004-01-07 03:29:16 +0000668 ** date is already on the appropriate weekday, this is a no-op.
drh7014aff2003-11-01 01:53:53 +0000669 */
drh9339da12010-09-30 00:50:49 +0000670 if( strncmp(z, "weekday ", 8)==0
671 && sqlite3AtoF(&z[8], &r, sqlite3Strlen30(&z[8]), SQLITE_UTF8)
672 && (n=(int)r)==r && n>=0 && r<7 ){
drh85f477a2008-06-12 16:35:38 +0000673 sqlite3_int64 Z;
drhba212562004-01-08 02:17:31 +0000674 computeYMD_HMS(p);
drh7014aff2003-11-01 01:53:53 +0000675 p->validTZ = 0;
676 p->validJD = 0;
677 computeJD(p);
drh85f477a2008-06-12 16:35:38 +0000678 Z = ((p->iJD + 129600000)/86400000) % 7;
drh7014aff2003-11-01 01:53:53 +0000679 if( Z>n ) Z -= 7;
drh85f477a2008-06-12 16:35:38 +0000680 p->iJD += (n - Z)*86400000;
drhba212562004-01-08 02:17:31 +0000681 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000682 rc = 0;
683 }
684 break;
685 }
686 case 's': {
687 /*
688 ** start of TTTTT
689 **
690 ** Move the date backwards to the beginning of the current day,
691 ** or month or year.
692 */
693 if( strncmp(z, "start of ", 9)!=0 ) break;
drh4d5b8362004-01-17 01:16:21 +0000694 z += 9;
drh7014aff2003-11-01 01:53:53 +0000695 computeYMD(p);
696 p->validHMS = 1;
697 p->h = p->m = 0;
698 p->s = 0.0;
699 p->validTZ = 0;
700 p->validJD = 0;
drh4d5b8362004-01-17 01:16:21 +0000701 if( strcmp(z,"month")==0 ){
drh7014aff2003-11-01 01:53:53 +0000702 p->D = 1;
703 rc = 0;
drh4d5b8362004-01-17 01:16:21 +0000704 }else if( strcmp(z,"year")==0 ){
drh7014aff2003-11-01 01:53:53 +0000705 computeYMD(p);
706 p->M = 1;
707 p->D = 1;
708 rc = 0;
drh4d5b8362004-01-17 01:16:21 +0000709 }else if( strcmp(z,"day")==0 ){
drh7014aff2003-11-01 01:53:53 +0000710 rc = 0;
711 }
712 break;
713 }
714 case '+':
715 case '-':
716 case '0':
717 case '1':
718 case '2':
719 case '3':
720 case '4':
721 case '5':
722 case '6':
723 case '7':
724 case '8':
725 case '9': {
drhc531a222009-01-30 17:27:44 +0000726 double rRounder;
drhd76a9022016-11-30 00:48:28 +0000727 double rAbs;
drh9339da12010-09-30 00:50:49 +0000728 for(n=1; z[n] && z[n]!=':' && !sqlite3Isspace(z[n]); n++){}
729 if( !sqlite3AtoF(z, &r, n, SQLITE_UTF8) ){
730 rc = 1;
731 break;
732 }
drh33a9ad22004-02-29 00:40:32 +0000733 if( z[n]==':' ){
734 /* A modifier of the form (+|-)HH:MM:SS.FFF adds (or subtracts) the
735 ** specified number of hours, minutes, seconds, and fractional seconds
736 ** to the time. The ".FFF" may be omitted. The ":SS.FFF" may be
737 ** omitted.
738 */
739 const char *z2 = z;
740 DateTime tx;
drh85f477a2008-06-12 16:35:38 +0000741 sqlite3_int64 day;
danielk197778ca0e72009-01-20 16:53:39 +0000742 if( !sqlite3Isdigit(*z2) ) z2++;
drh33a9ad22004-02-29 00:40:32 +0000743 memset(&tx, 0, sizeof(tx));
744 if( parseHhMmSs(z2, &tx) ) break;
745 computeJD(&tx);
drh85f477a2008-06-12 16:35:38 +0000746 tx.iJD -= 43200000;
747 day = tx.iJD/86400000;
748 tx.iJD -= day*86400000;
749 if( z[0]=='-' ) tx.iJD = -tx.iJD;
drh0d131ab2004-02-29 01:08:17 +0000750 computeJD(p);
751 clearYMD_HMS_TZ(p);
drh85f477a2008-06-12 16:35:38 +0000752 p->iJD += tx.iJD;
drh33a9ad22004-02-29 00:40:32 +0000753 rc = 0;
754 break;
755 }
drh4d5b8362004-01-17 01:16:21 +0000756 z += n;
danielk197778ca0e72009-01-20 16:53:39 +0000757 while( sqlite3Isspace(*z) ) z++;
drhea678832008-12-10 19:26:22 +0000758 n = sqlite3Strlen30(z);
drh7014aff2003-11-01 01:53:53 +0000759 if( n>10 || n<3 ) break;
drh7014aff2003-11-01 01:53:53 +0000760 if( z[n-1]=='s' ){ z[n-1] = 0; n--; }
761 computeJD(p);
762 rc = 0;
drhc531a222009-01-30 17:27:44 +0000763 rRounder = r<0 ? -0.5 : +0.5;
drhd76a9022016-11-30 00:48:28 +0000764 rAbs = r<0 ? -r : r;
765 if( n==3 && strcmp(z,"day")==0 && rAbs<5373485.0 ){
drhc531a222009-01-30 17:27:44 +0000766 p->iJD += (sqlite3_int64)(r*86400000.0 + rRounder);
drhd76a9022016-11-30 00:48:28 +0000767 }else if( n==4 && strcmp(z,"hour")==0 && rAbs<128963628.0 ){
drhc531a222009-01-30 17:27:44 +0000768 p->iJD += (sqlite3_int64)(r*(86400000.0/24.0) + rRounder);
drhd76a9022016-11-30 00:48:28 +0000769 }else if( n==6 && strcmp(z,"minute")==0 && rAbs<7737817680.0 ){
drhc531a222009-01-30 17:27:44 +0000770 p->iJD += (sqlite3_int64)(r*(86400000.0/(24.0*60.0)) + rRounder);
drhd76a9022016-11-30 00:48:28 +0000771 }else if( n==6 && strcmp(z,"second")==0 && rAbs<464269060800.0 ){
drhc531a222009-01-30 17:27:44 +0000772 p->iJD += (sqlite3_int64)(r*(86400000.0/(24.0*60.0*60.0)) + rRounder);
drhd76a9022016-11-30 00:48:28 +0000773 }else if( n==5 && strcmp(z,"month")==0 && rAbs<176546.0 ){
drh7014aff2003-11-01 01:53:53 +0000774 int x, y;
drhba212562004-01-08 02:17:31 +0000775 computeYMD_HMS(p);
shaneaef3af52008-12-09 04:59:00 +0000776 p->M += (int)r;
drh7014aff2003-11-01 01:53:53 +0000777 x = p->M>0 ? (p->M-1)/12 : (p->M-12)/12;
778 p->Y += x;
779 p->M -= x*12;
780 p->validJD = 0;
781 computeJD(p);
shaneaef3af52008-12-09 04:59:00 +0000782 y = (int)r;
drh7014aff2003-11-01 01:53:53 +0000783 if( y!=r ){
drhc531a222009-01-30 17:27:44 +0000784 p->iJD += (sqlite3_int64)((r - y)*30.0*86400000.0 + rRounder);
drh7014aff2003-11-01 01:53:53 +0000785 }
drhd76a9022016-11-30 00:48:28 +0000786 }else if( n==4 && strcmp(z,"year")==0 && rAbs<14713.0 ){
drhc531a222009-01-30 17:27:44 +0000787 int y = (int)r;
drhba212562004-01-08 02:17:31 +0000788 computeYMD_HMS(p);
drhc531a222009-01-30 17:27:44 +0000789 p->Y += y;
drh7014aff2003-11-01 01:53:53 +0000790 p->validJD = 0;
791 computeJD(p);
drhc531a222009-01-30 17:27:44 +0000792 if( y!=r ){
793 p->iJD += (sqlite3_int64)((r - y)*365.0*86400000.0 + rRounder);
794 }
drh7014aff2003-11-01 01:53:53 +0000795 }else{
796 rc = 1;
797 }
drhba212562004-01-08 02:17:31 +0000798 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000799 break;
800 }
801 default: {
802 break;
803 }
804 }
805 return rc;
806}
807
808/*
809** Process time function arguments. argv[0] is a date-time stamp.
810** argv[1] and following are modifiers. Parse them all and write
811** the resulting time into the DateTime structure p. Return 0
812** on success and 1 if there are any errors.
drh008e4762008-01-17 22:27:53 +0000813**
814** If there are zero parameters (if even argv[0] is undefined)
815** then assume a default value of "now" for argv[0].
drh7014aff2003-11-01 01:53:53 +0000816*/
danielk1977fee2d252007-08-18 10:59:19 +0000817static int isDate(
818 sqlite3_context *context,
819 int argc,
820 sqlite3_value **argv,
821 DateTime *p
822){
drh7014aff2003-11-01 01:53:53 +0000823 int i;
drh7a521cf2007-04-25 18:23:52 +0000824 const unsigned char *z;
drh85f477a2008-06-12 16:35:38 +0000825 int eType;
drh3af5d682008-06-12 13:50:00 +0000826 memset(p, 0, sizeof(*p));
drh008e4762008-01-17 22:27:53 +0000827 if( argc==0 ){
drh31702252011-10-12 23:13:43 +0000828 return setDateTimeToCurrent(context, p);
829 }
830 if( (eType = sqlite3_value_type(argv[0]))==SQLITE_FLOAT
drh85f477a2008-06-12 16:35:38 +0000831 || eType==SQLITE_INTEGER ){
drhb5489b82016-11-30 04:07:57 +0000832 double r = sqlite3_value_double(argv[0]);
833 if( r>106751991167.0 || r<-106751991167.0 ) return 1;
834 p->iJD = (sqlite3_int64)(r*86400000.0 + 0.5);
drh3af5d682008-06-12 13:50:00 +0000835 p->validJD = 1;
drh008e4762008-01-17 22:27:53 +0000836 }else{
837 z = sqlite3_value_text(argv[0]);
drh3af5d682008-06-12 13:50:00 +0000838 if( !z || parseDateOrTime(context, (char*)z, p) ){
839 return 1;
840 }
drh7a521cf2007-04-25 18:23:52 +0000841 }
drh7014aff2003-11-01 01:53:53 +0000842 for(i=1; i<argc; i++){
danc17d6962011-06-21 12:47:30 +0000843 z = sqlite3_value_text(argv[i]);
drh208cac12016-12-02 14:15:13 +0000844 if( z==0 ) return 1;
845 if( p->validJD && !validJulianDay(p->iJD)
846 && strcmp((const char*)z,"unixepoch")!=0
847 ){
848 return 1;
849 }
850 if( parseModifier(context, (char*)z, p) ) return 1;
drh7014aff2003-11-01 01:53:53 +0000851 }
drhb5489b82016-11-30 04:07:57 +0000852 computeJD(p);
853 if( p->isError || !validJulianDay(p->iJD) ) return 1;
drh7014aff2003-11-01 01:53:53 +0000854 return 0;
855}
856
857
858/*
859** The following routines implement the various date and time functions
860** of SQLite.
861*/
862
863/*
864** julianday( TIMESTRING, MOD, MOD, ...)
865**
866** Return the julian day number of the date specified in the arguments
867*/
drhf9b596e2004-05-26 16:54:42 +0000868static void juliandayFunc(
869 sqlite3_context *context,
870 int argc,
871 sqlite3_value **argv
872){
drh7014aff2003-11-01 01:53:53 +0000873 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000874 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000875 computeJD(&x);
drh85f477a2008-06-12 16:35:38 +0000876 sqlite3_result_double(context, x.iJD/86400000.0);
drh7014aff2003-11-01 01:53:53 +0000877 }
878}
879
880/*
881** datetime( TIMESTRING, MOD, MOD, ...)
882**
883** Return YYYY-MM-DD HH:MM:SS
884*/
drhf9b596e2004-05-26 16:54:42 +0000885static void datetimeFunc(
886 sqlite3_context *context,
887 int argc,
888 sqlite3_value **argv
889){
drh7014aff2003-11-01 01:53:53 +0000890 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000891 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000892 char zBuf[100];
drhba212562004-01-08 02:17:31 +0000893 computeYMD_HMS(&x);
drh5bb3eb92007-05-04 13:15:55 +0000894 sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d %02d:%02d:%02d",
895 x.Y, x.M, x.D, x.h, x.m, (int)(x.s));
danielk1977d8123362004-06-12 09:25:12 +0000896 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +0000897 }
898}
899
900/*
901** time( TIMESTRING, MOD, MOD, ...)
902**
903** Return HH:MM:SS
904*/
drhf9b596e2004-05-26 16:54:42 +0000905static void timeFunc(
906 sqlite3_context *context,
907 int argc,
908 sqlite3_value **argv
909){
drh7014aff2003-11-01 01:53:53 +0000910 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000911 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000912 char zBuf[100];
913 computeHMS(&x);
drh5bb3eb92007-05-04 13:15:55 +0000914 sqlite3_snprintf(sizeof(zBuf), zBuf, "%02d:%02d:%02d", x.h, x.m, (int)x.s);
danielk1977d8123362004-06-12 09:25:12 +0000915 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +0000916 }
917}
918
919/*
920** date( TIMESTRING, MOD, MOD, ...)
921**
922** Return YYYY-MM-DD
923*/
drhf9b596e2004-05-26 16:54:42 +0000924static void dateFunc(
925 sqlite3_context *context,
926 int argc,
927 sqlite3_value **argv
928){
drh7014aff2003-11-01 01:53:53 +0000929 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000930 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000931 char zBuf[100];
932 computeYMD(&x);
drh5bb3eb92007-05-04 13:15:55 +0000933 sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d", x.Y, x.M, x.D);
danielk1977d8123362004-06-12 09:25:12 +0000934 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +0000935 }
936}
937
938/*
939** strftime( FORMAT, TIMESTRING, MOD, MOD, ...)
940**
941** Return a string described by FORMAT. Conversions as follows:
942**
943** %d day of month
944** %f ** fractional seconds SS.SSS
945** %H hour 00-24
946** %j day of year 000-366
drh86a11b82014-11-07 13:24:29 +0000947** %J ** julian day number
drh7014aff2003-11-01 01:53:53 +0000948** %m month 01-12
949** %M minute 00-59
950** %s seconds since 1970-01-01
951** %S seconds 00-59
952** %w day of week 0-6 sunday==0
953** %W week of year 00-53
954** %Y year 0000-9999
955** %% %
956*/
drhf9b596e2004-05-26 16:54:42 +0000957static void strftimeFunc(
958 sqlite3_context *context,
959 int argc,
960 sqlite3_value **argv
961){
drh7014aff2003-11-01 01:53:53 +0000962 DateTime x;
drha0206bc2007-05-08 15:15:02 +0000963 u64 n;
shaneaef3af52008-12-09 04:59:00 +0000964 size_t i,j;
drh7014aff2003-11-01 01:53:53 +0000965 char *z;
drh633e6d52008-07-28 19:34:53 +0000966 sqlite3 *db;
drh655814d2015-01-09 01:27:29 +0000967 const char *zFmt;
drh7014aff2003-11-01 01:53:53 +0000968 char zBuf[100];
drh655814d2015-01-09 01:27:29 +0000969 if( argc==0 ) return;
970 zFmt = (const char*)sqlite3_value_text(argv[0]);
danielk1977fee2d252007-08-18 10:59:19 +0000971 if( zFmt==0 || isDate(context, argc-1, argv+1, &x) ) return;
drh633e6d52008-07-28 19:34:53 +0000972 db = sqlite3_context_db_handle(context);
drh7014aff2003-11-01 01:53:53 +0000973 for(i=0, n=1; zFmt[i]; i++, n++){
974 if( zFmt[i]=='%' ){
975 switch( zFmt[i+1] ){
976 case 'd':
977 case 'H':
978 case 'm':
979 case 'M':
980 case 'S':
981 case 'W':
982 n++;
983 /* fall thru */
984 case 'w':
985 case '%':
986 break;
987 case 'f':
988 n += 8;
989 break;
990 case 'j':
991 n += 3;
992 break;
993 case 'Y':
994 n += 8;
995 break;
996 case 's':
997 case 'J':
998 n += 50;
999 break;
1000 default:
1001 return; /* ERROR. return a NULL */
1002 }
1003 i++;
1004 }
1005 }
drh67110022009-01-28 02:55:28 +00001006 testcase( n==sizeof(zBuf)-1 );
1007 testcase( n==sizeof(zBuf) );
1008 testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH]+1 );
1009 testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH] );
drh7014aff2003-11-01 01:53:53 +00001010 if( n<sizeof(zBuf) ){
1011 z = zBuf;
danielk197700e13612008-11-17 19:18:54 +00001012 }else if( n>(u64)db->aLimit[SQLITE_LIMIT_LENGTH] ){
drha0206bc2007-05-08 15:15:02 +00001013 sqlite3_result_error_toobig(context);
1014 return;
drh7014aff2003-11-01 01:53:53 +00001015 }else{
drh575fad62016-02-05 13:38:36 +00001016 z = sqlite3DbMallocRawNN(db, (int)n);
drh3334e942008-01-17 20:26:46 +00001017 if( z==0 ){
1018 sqlite3_result_error_nomem(context);
1019 return;
1020 }
drh7014aff2003-11-01 01:53:53 +00001021 }
1022 computeJD(&x);
drhba212562004-01-08 02:17:31 +00001023 computeYMD_HMS(&x);
drh7014aff2003-11-01 01:53:53 +00001024 for(i=j=0; zFmt[i]; i++){
1025 if( zFmt[i]!='%' ){
1026 z[j++] = zFmt[i];
1027 }else{
1028 i++;
1029 switch( zFmt[i] ){
drh5bb3eb92007-05-04 13:15:55 +00001030 case 'd': sqlite3_snprintf(3, &z[j],"%02d",x.D); j+=2; break;
drh7014aff2003-11-01 01:53:53 +00001031 case 'f': {
drhb1f1e6e2006-09-25 18:01:31 +00001032 double s = x.s;
1033 if( s>59.999 ) s = 59.999;
drh2ecad3b2007-03-29 17:57:21 +00001034 sqlite3_snprintf(7, &z[j],"%06.3f", s);
drhea678832008-12-10 19:26:22 +00001035 j += sqlite3Strlen30(&z[j]);
drh7014aff2003-11-01 01:53:53 +00001036 break;
1037 }
drh5bb3eb92007-05-04 13:15:55 +00001038 case 'H': sqlite3_snprintf(3, &z[j],"%02d",x.h); j+=2; break;
drh7014aff2003-11-01 01:53:53 +00001039 case 'W': /* Fall thru */
1040 case 'j': {
danielk1977f0113002006-01-24 12:09:17 +00001041 int nDay; /* Number of days since 1st day of year */
drh7014aff2003-11-01 01:53:53 +00001042 DateTime y = x;
1043 y.validJD = 0;
1044 y.M = 1;
1045 y.D = 1;
1046 computeJD(&y);
shaneaef3af52008-12-09 04:59:00 +00001047 nDay = (int)((x.iJD-y.iJD+43200000)/86400000);
drh7014aff2003-11-01 01:53:53 +00001048 if( zFmt[i]=='W' ){
drh1020d492004-07-18 22:22:43 +00001049 int wd; /* 0=Monday, 1=Tuesday, ... 6=Sunday */
shaneaef3af52008-12-09 04:59:00 +00001050 wd = (int)(((x.iJD+43200000)/86400000)%7);
drh5bb3eb92007-05-04 13:15:55 +00001051 sqlite3_snprintf(3, &z[j],"%02d",(nDay+7-wd)/7);
drh7014aff2003-11-01 01:53:53 +00001052 j += 2;
1053 }else{
drh5bb3eb92007-05-04 13:15:55 +00001054 sqlite3_snprintf(4, &z[j],"%03d",nDay+1);
drh7014aff2003-11-01 01:53:53 +00001055 j += 3;
1056 }
1057 break;
1058 }
drh5bb3eb92007-05-04 13:15:55 +00001059 case 'J': {
drh85f477a2008-06-12 16:35:38 +00001060 sqlite3_snprintf(20, &z[j],"%.16g",x.iJD/86400000.0);
drhea678832008-12-10 19:26:22 +00001061 j+=sqlite3Strlen30(&z[j]);
drh5bb3eb92007-05-04 13:15:55 +00001062 break;
1063 }
1064 case 'm': sqlite3_snprintf(3, &z[j],"%02d",x.M); j+=2; break;
1065 case 'M': sqlite3_snprintf(3, &z[j],"%02d",x.m); j+=2; break;
drh7014aff2003-11-01 01:53:53 +00001066 case 's': {
drh6eb41522009-04-01 20:44:13 +00001067 sqlite3_snprintf(30,&z[j],"%lld",
drh07758962009-04-03 12:04:36 +00001068 (i64)(x.iJD/1000 - 21086676*(i64)10000));
drhea678832008-12-10 19:26:22 +00001069 j += sqlite3Strlen30(&z[j]);
drh7014aff2003-11-01 01:53:53 +00001070 break;
1071 }
drh5bb3eb92007-05-04 13:15:55 +00001072 case 'S': sqlite3_snprintf(3,&z[j],"%02d",(int)x.s); j+=2; break;
drhea678832008-12-10 19:26:22 +00001073 case 'w': {
1074 z[j++] = (char)(((x.iJD+129600000)/86400000) % 7) + '0';
1075 break;
1076 }
1077 case 'Y': {
1078 sqlite3_snprintf(5,&z[j],"%04d",x.Y); j+=sqlite3Strlen30(&z[j]);
1079 break;
1080 }
drh008e4762008-01-17 22:27:53 +00001081 default: z[j++] = '%'; break;
drh7014aff2003-11-01 01:53:53 +00001082 }
1083 }
1084 }
1085 z[j] = 0;
drh3334e942008-01-17 20:26:46 +00001086 sqlite3_result_text(context, z, -1,
drh633e6d52008-07-28 19:34:53 +00001087 z==zBuf ? SQLITE_TRANSIENT : SQLITE_DYNAMIC);
drh7014aff2003-11-01 01:53:53 +00001088}
1089
danielk19777977a172004-11-09 12:44:37 +00001090/*
1091** current_time()
1092**
1093** This function returns the same value as time('now').
1094*/
1095static void ctimeFunc(
1096 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001097 int NotUsed,
1098 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001099){
danielk197762c14b32008-11-19 09:05:26 +00001100 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001101 timeFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001102}
drh7014aff2003-11-01 01:53:53 +00001103
danielk19777977a172004-11-09 12:44:37 +00001104/*
1105** current_date()
1106**
1107** This function returns the same value as date('now').
1108*/
1109static void cdateFunc(
1110 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001111 int NotUsed,
1112 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001113){
danielk197762c14b32008-11-19 09:05:26 +00001114 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001115 dateFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001116}
1117
1118/*
1119** current_timestamp()
1120**
1121** This function returns the same value as datetime('now').
1122*/
1123static void ctimestampFunc(
1124 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001125 int NotUsed,
1126 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001127){
danielk197762c14b32008-11-19 09:05:26 +00001128 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001129 datetimeFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001130}
drh7014aff2003-11-01 01:53:53 +00001131#endif /* !defined(SQLITE_OMIT_DATETIME_FUNCS) */
1132
danielk1977752e6792004-11-09 16:13:33 +00001133#ifdef SQLITE_OMIT_DATETIME_FUNCS
1134/*
1135** If the library is compiled to omit the full-scale date and time
1136** handling (to get a smaller binary), the following minimal version
1137** of the functions current_time(), current_date() and current_timestamp()
1138** are included instead. This is to support column declarations that
1139** include "DEFAULT CURRENT_TIME" etc.
1140**
danielk19772df9fab2004-11-11 01:50:30 +00001141** This function uses the C-library functions time(), gmtime()
danielk1977752e6792004-11-09 16:13:33 +00001142** and strftime(). The format string to pass to strftime() is supplied
1143** as the user-data for the function.
1144*/
danielk1977752e6792004-11-09 16:13:33 +00001145static void currentTimeFunc(
1146 sqlite3_context *context,
1147 int argc,
1148 sqlite3_value **argv
1149){
1150 time_t t;
1151 char *zFormat = (char *)sqlite3_user_data(context);
drhb7e8ea22010-05-03 14:32:30 +00001152 sqlite3_int64 iT;
drh31702252011-10-12 23:13:43 +00001153 struct tm *pTm;
1154 struct tm sNow;
danielk1977752e6792004-11-09 16:13:33 +00001155 char zBuf[20];
danielk1977752e6792004-11-09 16:13:33 +00001156
shanefbd60f82009-02-04 03:59:25 +00001157 UNUSED_PARAMETER(argc);
1158 UNUSED_PARAMETER(argv);
1159
drh95a7b3e2013-09-16 12:57:19 +00001160 iT = sqlite3StmtCurrentTime(context);
1161 if( iT<=0 ) return;
drhd5e6e402010-05-03 19:17:01 +00001162 t = iT/1000 - 10000*(sqlite3_int64)21086676;
drh0ede9eb2015-01-10 16:49:23 +00001163#if HAVE_GMTIME_R
drh31702252011-10-12 23:13:43 +00001164 pTm = gmtime_r(&t, &sNow);
drh87595762006-09-08 12:49:43 +00001165#else
drh31702252011-10-12 23:13:43 +00001166 sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
1167 pTm = gmtime(&t);
1168 if( pTm ) memcpy(&sNow, pTm, sizeof(sNow));
1169 sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
drh87595762006-09-08 12:49:43 +00001170#endif
drh31702252011-10-12 23:13:43 +00001171 if( pTm ){
1172 strftime(zBuf, 20, zFormat, &sNow);
1173 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
1174 }
danielk1977752e6792004-11-09 16:13:33 +00001175}
1176#endif
1177
drh7014aff2003-11-01 01:53:53 +00001178/*
1179** This function registered all of the above C functions as SQL
1180** functions. This should be the only routine in this file with
1181** external linkage.
1182*/
drh777c5382008-08-21 20:21:34 +00001183void sqlite3RegisterDateTimeFunctions(void){
drh80738d92016-02-15 00:34:16 +00001184 static FuncDef aDateTimeFuncs[] = {
drhfd1f3942004-07-20 00:39:14 +00001185#ifndef SQLITE_OMIT_DATETIME_FUNCS
drh1d85e402015-08-31 17:34:41 +00001186 DFUNCTION(julianday, -1, 0, 0, juliandayFunc ),
1187 DFUNCTION(date, -1, 0, 0, dateFunc ),
1188 DFUNCTION(time, -1, 0, 0, timeFunc ),
1189 DFUNCTION(datetime, -1, 0, 0, datetimeFunc ),
1190 DFUNCTION(strftime, -1, 0, 0, strftimeFunc ),
1191 DFUNCTION(current_time, 0, 0, 0, ctimeFunc ),
1192 DFUNCTION(current_timestamp, 0, 0, 0, ctimestampFunc),
1193 DFUNCTION(current_date, 0, 0, 0, cdateFunc ),
danielk1977752e6792004-11-09 16:13:33 +00001194#else
drh21717ed2008-10-13 15:35:08 +00001195 STR_FUNCTION(current_time, 0, "%H:%M:%S", 0, currentTimeFunc),
drh2b1e6902010-01-12 19:28:20 +00001196 STR_FUNCTION(current_date, 0, "%Y-%m-%d", 0, currentTimeFunc),
1197 STR_FUNCTION(current_timestamp, 0, "%Y-%m-%d %H:%M:%S", 0, currentTimeFunc),
drh777c5382008-08-21 20:21:34 +00001198#endif
danielk1977752e6792004-11-09 16:13:33 +00001199 };
drh80738d92016-02-15 00:34:16 +00001200 sqlite3InsertBuiltinFuncs(aDateTimeFuncs, ArraySize(aDateTimeFuncs));
drh7014aff2003-11-01 01:53:53 +00001201}