blob: 4326919601023387f863f18bccc1b51e53c066f2 [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 */
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;
danielk19774adee202004-05-08 08:23:19 +0000389 }else if( sqlite3StrICmp(zDate,"now")==0){
drh31702252011-10-12 23:13:43 +0000390 return setDateTimeToCurrent(context, p);
drh9339da12010-09-30 00:50:49 +0000391 }else if( sqlite3AtoF(zDate, &r, sqlite3Strlen30(zDate), SQLITE_UTF8) ){
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
398/*
drh3edb1572016-11-29 20:39:48 +0000399** Return TRUE if the given julian day number is within range.
400**
401** The input is the JulianDay times 86400000.
402*/
403static int validJulianDay(sqlite3_int64 iJD){
drhd76a9022016-11-30 00:48:28 +0000404 return iJD>=0 && iJD<=464269060799999;
drh3edb1572016-11-29 20:39:48 +0000405}
406
407/*
drh7014aff2003-11-01 01:53:53 +0000408** Compute the Year, Month, and Day from the julian day number.
409*/
410static void computeYMD(DateTime *p){
411 int Z, A, B, C, D, E, X1;
412 if( p->validYMD ) return;
drh33a9ad22004-02-29 00:40:32 +0000413 if( !p->validJD ){
414 p->Y = 2000;
415 p->M = 1;
416 p->D = 1;
417 }else{
drh6d4e9c32016-12-02 19:07:03 +0000418 assert( validJulianDay(p->iJD) );
shaneaef3af52008-12-09 04:59:00 +0000419 Z = (int)((p->iJD + 43200000)/86400000);
420 A = (int)((Z - 1867216.25)/36524.25);
drh33a9ad22004-02-29 00:40:32 +0000421 A = Z + 1 + A - (A/4);
422 B = A + 1524;
shaneaef3af52008-12-09 04:59:00 +0000423 C = (int)((B - 122.1)/365.25);
drh618ee612015-07-15 18:04:48 +0000424 D = (36525*(C&32767))/100;
shaneaef3af52008-12-09 04:59:00 +0000425 E = (int)((B-D)/30.6001);
426 X1 = (int)(30.6001*E);
drh33a9ad22004-02-29 00:40:32 +0000427 p->D = B - D - X1;
428 p->M = E<14 ? E-1 : E-13;
429 p->Y = p->M>2 ? C - 4716 : C - 4715;
430 }
drh7014aff2003-11-01 01:53:53 +0000431 p->validYMD = 1;
432}
433
434/*
435** Compute the Hour, Minute, and Seconds from the julian day number.
436*/
437static void computeHMS(DateTime *p){
drh85f477a2008-06-12 16:35:38 +0000438 int s;
drh7014aff2003-11-01 01:53:53 +0000439 if( p->validHMS ) return;
drhf11c34d2006-09-08 12:27:36 +0000440 computeJD(p);
shaneaef3af52008-12-09 04:59:00 +0000441 s = (int)((p->iJD + 43200000) % 86400000);
drh85f477a2008-06-12 16:35:38 +0000442 p->s = s/1000.0;
shaneaef3af52008-12-09 04:59:00 +0000443 s = (int)p->s;
drh7014aff2003-11-01 01:53:53 +0000444 p->s -= s;
445 p->h = s/3600;
446 s -= p->h*3600;
447 p->m = s/60;
448 p->s += s - p->m*60;
drh861a5682016-12-02 17:08:27 +0000449 p->rawS = 0;
drh7014aff2003-11-01 01:53:53 +0000450 p->validHMS = 1;
451}
452
453/*
drhba212562004-01-08 02:17:31 +0000454** Compute both YMD and HMS
455*/
456static void computeYMD_HMS(DateTime *p){
457 computeYMD(p);
458 computeHMS(p);
459}
460
461/*
462** Clear the YMD and HMS and the TZ
463*/
464static void clearYMD_HMS_TZ(DateTime *p){
465 p->validYMD = 0;
466 p->validHMS = 0;
467 p->validTZ = 0;
468}
469
mistachkin6cc16fc2016-01-23 01:54:15 +0000470#ifndef SQLITE_OMIT_LOCALTIME
drha924aca2011-06-21 15:01:25 +0000471/*
472** On recent Windows platforms, the localtime_s() function is available
473** as part of the "Secure CRT". It is essentially equivalent to
474** localtime_r() available under most POSIX platforms, except that the
475** order of the parameters is reversed.
476**
477** See http://msdn.microsoft.com/en-us/library/a442x3ye(VS.80).aspx.
478**
479** If the user has not indicated to use localtime_r() or localtime_s()
480** already, check for an MSVC build environment that provides
481** localtime_s().
482*/
drh0ede9eb2015-01-10 16:49:23 +0000483#if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S \
484 && defined(_MSC_VER) && defined(_CRT_INSECURE_DEPRECATE)
485#undef HAVE_LOCALTIME_S
drha924aca2011-06-21 15:01:25 +0000486#define HAVE_LOCALTIME_S 1
487#endif
488
drhba212562004-01-08 02:17:31 +0000489/*
drh8720aeb2011-06-21 14:35:30 +0000490** The following routine implements the rough equivalent of localtime_r()
491** using whatever operating-system specific localtime facility that
492** is available. This routine returns 0 on success and
493** non-zero on any kind of error.
danc17d6962011-06-21 12:47:30 +0000494**
drh8720aeb2011-06-21 14:35:30 +0000495** If the sqlite3GlobalConfig.bLocaltimeFault variable is true then this
496** routine will always fail.
drhe4bf4f02013-10-11 20:14:37 +0000497**
498** EVIDENCE-OF: R-62172-00036 In this implementation, the standard C
499** library function localtime_r() is used to assist in the calculation of
500** local time.
drh7091cb02003-12-23 16:22:18 +0000501*/
drh1f93a082011-06-21 15:54:24 +0000502static int osLocaltime(time_t *t, struct tm *pTm){
drh8720aeb2011-06-21 14:35:30 +0000503 int rc;
drh0ede9eb2015-01-10 16:49:23 +0000504#if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S
drha924aca2011-06-21 15:01:25 +0000505 struct tm *pX;
drhdf3aa162011-06-24 11:29:51 +0000506#if SQLITE_THREADSAFE>0
drha924aca2011-06-21 15:01:25 +0000507 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhdf3aa162011-06-24 11:29:51 +0000508#endif
drha924aca2011-06-21 15:01:25 +0000509 sqlite3_mutex_enter(mutex);
510 pX = localtime(t);
drhd12602a2016-12-07 15:49:02 +0000511#ifndef SQLITE_UNTESTABLE
drha924aca2011-06-21 15:01:25 +0000512 if( sqlite3GlobalConfig.bLocaltimeFault ) pX = 0;
513#endif
514 if( pX ) *pTm = *pX;
515 sqlite3_mutex_leave(mutex);
516 rc = pX==0;
517#else
drhd12602a2016-12-07 15:49:02 +0000518#ifndef SQLITE_UNTESTABLE
danc17d6962011-06-21 12:47:30 +0000519 if( sqlite3GlobalConfig.bLocaltimeFault ) return 1;
danc17d6962011-06-21 12:47:30 +0000520#endif
drh0ede9eb2015-01-10 16:49:23 +0000521#if HAVE_LOCALTIME_R
drh8720aeb2011-06-21 14:35:30 +0000522 rc = localtime_r(t, pTm)==0;
danc17d6962011-06-21 12:47:30 +0000523#else
drha924aca2011-06-21 15:01:25 +0000524 rc = localtime_s(pTm, t);
525#endif /* HAVE_LOCALTIME_R */
526#endif /* HAVE_LOCALTIME_R || HAVE_LOCALTIME_S */
drh8720aeb2011-06-21 14:35:30 +0000527 return rc;
528}
529#endif /* SQLITE_OMIT_LOCALTIME */
danc17d6962011-06-21 12:47:30 +0000530
531
drh8720aeb2011-06-21 14:35:30 +0000532#ifndef SQLITE_OMIT_LOCALTIME
danc17d6962011-06-21 12:47:30 +0000533/*
534** Compute the difference (in milliseconds) between localtime and UTC
535** (a.k.a. GMT) for the time value p where p is in UTC. If no error occurs,
536** return this value and set *pRc to SQLITE_OK.
537**
538** Or, if an error does occur, set *pRc to SQLITE_ERROR. The returned value
539** is undefined in this case.
540*/
541static sqlite3_int64 localtimeOffset(
542 DateTime *p, /* Date at which to calculate offset */
543 sqlite3_context *pCtx, /* Write error here if one occurs */
544 int *pRc /* OUT: Error code. SQLITE_OK or ERROR */
545){
drh7091cb02003-12-23 16:22:18 +0000546 DateTime x, y;
547 time_t t;
drh8720aeb2011-06-21 14:35:30 +0000548 struct tm sLocal;
549
dan0d37f582011-06-21 15:38:05 +0000550 /* Initialize the contents of sLocal to avoid a compiler warning. */
551 memset(&sLocal, 0, sizeof(sLocal));
552
drh7091cb02003-12-23 16:22:18 +0000553 x = *p;
drhba212562004-01-08 02:17:31 +0000554 computeYMD_HMS(&x);
drh7091cb02003-12-23 16:22:18 +0000555 if( x.Y<1971 || x.Y>=2038 ){
drhe4bf4f02013-10-11 20:14:37 +0000556 /* EVIDENCE-OF: R-55269-29598 The localtime_r() C function normally only
557 ** works for years between 1970 and 2037. For dates outside this range,
558 ** SQLite attempts to map the year into an equivalent year within this
559 ** range, do the calculation, then map the year back.
560 */
drh7091cb02003-12-23 16:22:18 +0000561 x.Y = 2000;
562 x.M = 1;
563 x.D = 1;
564 x.h = 0;
565 x.m = 0;
566 x.s = 0.0;
567 } else {
shaneaef3af52008-12-09 04:59:00 +0000568 int s = (int)(x.s + 0.5);
drh7091cb02003-12-23 16:22:18 +0000569 x.s = s;
570 }
571 x.tz = 0;
572 x.validJD = 0;
573 computeJD(&x);
shane11bb41f2009-09-10 20:23:30 +0000574 t = (time_t)(x.iJD/1000 - 21086676*(i64)10000);
drh8720aeb2011-06-21 14:35:30 +0000575 if( osLocaltime(&t, &sLocal) ){
576 sqlite3_result_error(pCtx, "local time unavailable", -1);
577 *pRc = SQLITE_ERROR;
578 return 0;
drh87595762006-09-08 12:49:43 +0000579 }
drh8720aeb2011-06-21 14:35:30 +0000580 y.Y = sLocal.tm_year + 1900;
581 y.M = sLocal.tm_mon + 1;
582 y.D = sLocal.tm_mday;
583 y.h = sLocal.tm_hour;
584 y.m = sLocal.tm_min;
585 y.s = sLocal.tm_sec;
drh7091cb02003-12-23 16:22:18 +0000586 y.validYMD = 1;
587 y.validHMS = 1;
588 y.validJD = 0;
drh861a5682016-12-02 17:08:27 +0000589 y.rawS = 0;
drh7091cb02003-12-23 16:22:18 +0000590 y.validTZ = 0;
drh861a5682016-12-02 17:08:27 +0000591 y.isError = 0;
drh7091cb02003-12-23 16:22:18 +0000592 computeJD(&y);
danc17d6962011-06-21 12:47:30 +0000593 *pRc = SQLITE_OK;
drh85f477a2008-06-12 16:35:38 +0000594 return y.iJD - x.iJD;
drh7091cb02003-12-23 16:22:18 +0000595}
drh66147c92008-06-12 12:51:37 +0000596#endif /* SQLITE_OMIT_LOCALTIME */
drh7091cb02003-12-23 16:22:18 +0000597
598/*
drh6d4e9c32016-12-02 19:07:03 +0000599** The following table defines various date transformations of the form
600**
601** 'NNN days'
602**
603** Where NNN is an arbitrary floating-point number and "days" can be one
604** of several units of time.
605*/
606static const struct {
607 u8 eType; /* Transformation type code */
608 u8 nName; /* Length of th name */
609 char *zName; /* Name of the transformation */
610 double rLimit; /* Maximum NNN value for this transform */
611 double rXform; /* Constant used for this transform */
612} aXformType[] = {
613 { 0, 6, "second", 464269060800.0, 86400000.0/(24.0*60.0*60.0) },
614 { 0, 6, "minute", 7737817680.0, 86400000.0/(24.0*60.0) },
615 { 0, 4, "hour", 128963628.0, 86400000.0/24.0 },
616 { 0, 3, "day", 5373485.0, 86400000.0 },
617 { 1, 5, "month", 176546.0, 30.0*86400000.0 },
618 { 2, 4, "year", 14713.0, 365.0*86400000.0 },
619};
620
621/*
drh7014aff2003-11-01 01:53:53 +0000622** Process a modifier to a date-time stamp. The modifiers are
623** as follows:
624**
625** NNN days
626** NNN hours
627** NNN minutes
628** NNN.NNNN seconds
629** NNN months
630** NNN years
631** start of month
632** start of year
633** start of week
634** start of day
635** weekday N
636** unixepoch
drh7091cb02003-12-23 16:22:18 +0000637** localtime
638** utc
drh7014aff2003-11-01 01:53:53 +0000639**
danc17d6962011-06-21 12:47:30 +0000640** Return 0 on success and 1 if there is any kind of error. If the error
641** is in a system call (i.e. localtime()), then an error message is written
642** to context pCtx. If the error is an unrecognized modifier, no error is
643** written to pCtx.
drh7014aff2003-11-01 01:53:53 +0000644*/
drh6d4e9c32016-12-02 19:07:03 +0000645static int parseModifier(
646 sqlite3_context *pCtx, /* Function context */
647 const char *z, /* The text of the modifier */
648 int n, /* Length of zMod in bytes */
649 DateTime *p /* The date/time value to be modified */
650){
drh7014aff2003-11-01 01:53:53 +0000651 int rc = 1;
drh7014aff2003-11-01 01:53:53 +0000652 double r;
drh6d4e9c32016-12-02 19:07:03 +0000653 switch(sqlite3UpperToLower[(u8)z[0]] ){
drh66147c92008-06-12 12:51:37 +0000654#ifndef SQLITE_OMIT_LOCALTIME
drh7091cb02003-12-23 16:22:18 +0000655 case 'l': {
656 /* localtime
657 **
658 ** Assuming the current time value is UTC (a.k.a. GMT), shift it to
659 ** show local time.
660 */
drh6d4e9c32016-12-02 19:07:03 +0000661 if( sqlite3_stricmp(z, "localtime")==0 ){
drh7091cb02003-12-23 16:22:18 +0000662 computeJD(p);
danc17d6962011-06-21 12:47:30 +0000663 p->iJD += localtimeOffset(p, pCtx, &rc);
drhba212562004-01-08 02:17:31 +0000664 clearYMD_HMS_TZ(p);
drh7091cb02003-12-23 16:22:18 +0000665 }
666 break;
667 }
drh66147c92008-06-12 12:51:37 +0000668#endif
drh7014aff2003-11-01 01:53:53 +0000669 case 'u': {
670 /*
671 ** unixepoch
672 **
drh861a5682016-12-02 17:08:27 +0000673 ** Treat the current value of p->s as the number of
drh7014aff2003-11-01 01:53:53 +0000674 ** seconds since 1970. Convert to a real julian day number.
675 */
drh6d4e9c32016-12-02 19:07:03 +0000676 if( sqlite3_stricmp(z, "unixepoch")==0 && p->rawS ){
drhe6ad1712016-12-05 20:16:04 +0000677 r = p->s*1000.0 + 210866760000000.0;
drh861a5682016-12-02 17:08:27 +0000678 if( r>=0.0 && r<464269060800000.0 ){
679 clearYMD_HMS_TZ(p);
680 p->iJD = (sqlite3_int64)r;
681 p->validJD = 1;
682 p->rawS = 0;
683 rc = 0;
684 }
drh66cccd92008-07-25 16:39:24 +0000685 }
686#ifndef SQLITE_OMIT_LOCALTIME
drh6d4e9c32016-12-02 19:07:03 +0000687 else if( sqlite3_stricmp(z, "utc")==0 ){
drhcaeca512015-12-23 10:54:48 +0000688 if( p->tzSet==0 ){
689 sqlite3_int64 c1;
690 computeJD(p);
691 c1 = localtimeOffset(p, pCtx, &rc);
692 if( rc==SQLITE_OK ){
693 p->iJD -= c1;
694 clearYMD_HMS_TZ(p);
695 p->iJD += c1 - localtimeOffset(p, pCtx, &rc);
696 }
697 p->tzSet = 1;
698 }else{
699 rc = SQLITE_OK;
danc17d6962011-06-21 12:47:30 +0000700 }
drh7014aff2003-11-01 01:53:53 +0000701 }
drh66cccd92008-07-25 16:39:24 +0000702#endif
drh7014aff2003-11-01 01:53:53 +0000703 break;
704 }
705 case 'w': {
706 /*
707 ** weekday N
708 **
drh181fc992004-08-17 10:42:54 +0000709 ** Move the date to the same time on the next occurrence of
drh7014aff2003-11-01 01:53:53 +0000710 ** weekday N where 0==Sunday, 1==Monday, and so forth. If the
drhc5dd9fa2004-01-07 03:29:16 +0000711 ** date is already on the appropriate weekday, this is a no-op.
drh7014aff2003-11-01 01:53:53 +0000712 */
drh6d4e9c32016-12-02 19:07:03 +0000713 if( sqlite3_strnicmp(z, "weekday ", 8)==0
drh9339da12010-09-30 00:50:49 +0000714 && sqlite3AtoF(&z[8], &r, sqlite3Strlen30(&z[8]), SQLITE_UTF8)
715 && (n=(int)r)==r && n>=0 && r<7 ){
drh85f477a2008-06-12 16:35:38 +0000716 sqlite3_int64 Z;
drhba212562004-01-08 02:17:31 +0000717 computeYMD_HMS(p);
drh7014aff2003-11-01 01:53:53 +0000718 p->validTZ = 0;
719 p->validJD = 0;
720 computeJD(p);
drh85f477a2008-06-12 16:35:38 +0000721 Z = ((p->iJD + 129600000)/86400000) % 7;
drh7014aff2003-11-01 01:53:53 +0000722 if( Z>n ) Z -= 7;
drh85f477a2008-06-12 16:35:38 +0000723 p->iJD += (n - Z)*86400000;
drhba212562004-01-08 02:17:31 +0000724 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000725 rc = 0;
726 }
727 break;
728 }
729 case 's': {
730 /*
731 ** start of TTTTT
732 **
733 ** Move the date backwards to the beginning of the current day,
734 ** or month or year.
735 */
drh6d4e9c32016-12-02 19:07:03 +0000736 if( sqlite3_strnicmp(z, "start of ", 9)!=0 ) break;
drh4d5b8362004-01-17 01:16:21 +0000737 z += 9;
drh7014aff2003-11-01 01:53:53 +0000738 computeYMD(p);
739 p->validHMS = 1;
740 p->h = p->m = 0;
741 p->s = 0.0;
742 p->validTZ = 0;
743 p->validJD = 0;
drh6d4e9c32016-12-02 19:07:03 +0000744 if( sqlite3_stricmp(z,"month")==0 ){
drh7014aff2003-11-01 01:53:53 +0000745 p->D = 1;
746 rc = 0;
drh6d4e9c32016-12-02 19:07:03 +0000747 }else if( sqlite3_stricmp(z,"year")==0 ){
drh7014aff2003-11-01 01:53:53 +0000748 computeYMD(p);
749 p->M = 1;
750 p->D = 1;
751 rc = 0;
drh6d4e9c32016-12-02 19:07:03 +0000752 }else if( sqlite3_stricmp(z,"day")==0 ){
drh7014aff2003-11-01 01:53:53 +0000753 rc = 0;
754 }
755 break;
756 }
757 case '+':
758 case '-':
759 case '0':
760 case '1':
761 case '2':
762 case '3':
763 case '4':
764 case '5':
765 case '6':
766 case '7':
767 case '8':
768 case '9': {
drhc531a222009-01-30 17:27:44 +0000769 double rRounder;
drh6d4e9c32016-12-02 19:07:03 +0000770 int i;
drh9339da12010-09-30 00:50:49 +0000771 for(n=1; z[n] && z[n]!=':' && !sqlite3Isspace(z[n]); n++){}
772 if( !sqlite3AtoF(z, &r, n, SQLITE_UTF8) ){
773 rc = 1;
774 break;
775 }
drh33a9ad22004-02-29 00:40:32 +0000776 if( z[n]==':' ){
777 /* A modifier of the form (+|-)HH:MM:SS.FFF adds (or subtracts) the
778 ** specified number of hours, minutes, seconds, and fractional seconds
779 ** to the time. The ".FFF" may be omitted. The ":SS.FFF" may be
780 ** omitted.
781 */
782 const char *z2 = z;
783 DateTime tx;
drh85f477a2008-06-12 16:35:38 +0000784 sqlite3_int64 day;
danielk197778ca0e72009-01-20 16:53:39 +0000785 if( !sqlite3Isdigit(*z2) ) z2++;
drh33a9ad22004-02-29 00:40:32 +0000786 memset(&tx, 0, sizeof(tx));
787 if( parseHhMmSs(z2, &tx) ) break;
788 computeJD(&tx);
drh85f477a2008-06-12 16:35:38 +0000789 tx.iJD -= 43200000;
790 day = tx.iJD/86400000;
791 tx.iJD -= day*86400000;
792 if( z[0]=='-' ) tx.iJD = -tx.iJD;
drh0d131ab2004-02-29 01:08:17 +0000793 computeJD(p);
794 clearYMD_HMS_TZ(p);
drh85f477a2008-06-12 16:35:38 +0000795 p->iJD += tx.iJD;
drh33a9ad22004-02-29 00:40:32 +0000796 rc = 0;
797 break;
798 }
drh6d4e9c32016-12-02 19:07:03 +0000799
800 /* If control reaches this point, it means the transformation is
801 ** one of the forms like "+NNN days". */
drh4d5b8362004-01-17 01:16:21 +0000802 z += n;
danielk197778ca0e72009-01-20 16:53:39 +0000803 while( sqlite3Isspace(*z) ) z++;
drhea678832008-12-10 19:26:22 +0000804 n = sqlite3Strlen30(z);
drh7014aff2003-11-01 01:53:53 +0000805 if( n>10 || n<3 ) break;
drh6d4e9c32016-12-02 19:07:03 +0000806 if( sqlite3UpperToLower[(u8)z[n-1]]=='s' ) n--;
drh7014aff2003-11-01 01:53:53 +0000807 computeJD(p);
drh6d4e9c32016-12-02 19:07:03 +0000808 rc = 1;
drhc531a222009-01-30 17:27:44 +0000809 rRounder = r<0 ? -0.5 : +0.5;
drh6d4e9c32016-12-02 19:07:03 +0000810 for(i=0; i<ArraySize(aXformType); i++){
811 if( aXformType[i].nName==n
812 && sqlite3_strnicmp(aXformType[i].zName, z, n)==0
813 && r>-aXformType[i].rLimit && r<aXformType[i].rLimit
814 ){
815 switch( aXformType[i].eType ){
816 case 1: { /* Special processing to add months */
817 int x;
818 computeYMD_HMS(p);
819 p->M += (int)r;
820 x = p->M>0 ? (p->M-1)/12 : (p->M-12)/12;
821 p->Y += x;
822 p->M -= x*12;
823 p->validJD = 0;
824 r -= (int)r;
825 break;
826 }
827 case 2: { /* Special processing to add years */
828 int y = (int)r;
829 computeYMD_HMS(p);
830 p->Y += y;
831 p->validJD = 0;
832 r -= (int)r;
833 break;
834 }
835 }
836 computeJD(p);
837 p->iJD += (sqlite3_int64)(r*aXformType[i].rXform + rRounder);
838 rc = 0;
839 break;
drh7014aff2003-11-01 01:53:53 +0000840 }
drh7014aff2003-11-01 01:53:53 +0000841 }
drhba212562004-01-08 02:17:31 +0000842 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000843 break;
844 }
845 default: {
846 break;
847 }
848 }
849 return rc;
850}
851
852/*
853** Process time function arguments. argv[0] is a date-time stamp.
854** argv[1] and following are modifiers. Parse them all and write
855** the resulting time into the DateTime structure p. Return 0
856** on success and 1 if there are any errors.
drh008e4762008-01-17 22:27:53 +0000857**
858** If there are zero parameters (if even argv[0] is undefined)
859** then assume a default value of "now" for argv[0].
drh7014aff2003-11-01 01:53:53 +0000860*/
danielk1977fee2d252007-08-18 10:59:19 +0000861static int isDate(
862 sqlite3_context *context,
863 int argc,
864 sqlite3_value **argv,
865 DateTime *p
866){
drh6d4e9c32016-12-02 19:07:03 +0000867 int i, n;
drh7a521cf2007-04-25 18:23:52 +0000868 const unsigned char *z;
drh85f477a2008-06-12 16:35:38 +0000869 int eType;
drh3af5d682008-06-12 13:50:00 +0000870 memset(p, 0, sizeof(*p));
drh008e4762008-01-17 22:27:53 +0000871 if( argc==0 ){
drh31702252011-10-12 23:13:43 +0000872 return setDateTimeToCurrent(context, p);
873 }
874 if( (eType = sqlite3_value_type(argv[0]))==SQLITE_FLOAT
drh85f477a2008-06-12 16:35:38 +0000875 || eType==SQLITE_INTEGER ){
drh861a5682016-12-02 17:08:27 +0000876 setRawDateNumber(p, sqlite3_value_double(argv[0]));
drh008e4762008-01-17 22:27:53 +0000877 }else{
878 z = sqlite3_value_text(argv[0]);
drh3af5d682008-06-12 13:50:00 +0000879 if( !z || parseDateOrTime(context, (char*)z, p) ){
880 return 1;
881 }
drh7a521cf2007-04-25 18:23:52 +0000882 }
drh7014aff2003-11-01 01:53:53 +0000883 for(i=1; i<argc; i++){
danc17d6962011-06-21 12:47:30 +0000884 z = sqlite3_value_text(argv[i]);
drh6d4e9c32016-12-02 19:07:03 +0000885 n = sqlite3_value_bytes(argv[i]);
886 if( z==0 || parseModifier(context, (char*)z, n, p) ) return 1;
drh7014aff2003-11-01 01:53:53 +0000887 }
drhb5489b82016-11-30 04:07:57 +0000888 computeJD(p);
889 if( p->isError || !validJulianDay(p->iJD) ) return 1;
drh7014aff2003-11-01 01:53:53 +0000890 return 0;
891}
892
893
894/*
895** The following routines implement the various date and time functions
896** of SQLite.
897*/
898
899/*
900** julianday( TIMESTRING, MOD, MOD, ...)
901**
902** Return the julian day number of the date specified in the arguments
903*/
drhf9b596e2004-05-26 16:54:42 +0000904static void juliandayFunc(
905 sqlite3_context *context,
906 int argc,
907 sqlite3_value **argv
908){
drh7014aff2003-11-01 01:53:53 +0000909 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000910 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000911 computeJD(&x);
drh85f477a2008-06-12 16:35:38 +0000912 sqlite3_result_double(context, x.iJD/86400000.0);
drh7014aff2003-11-01 01:53:53 +0000913 }
914}
915
916/*
917** datetime( TIMESTRING, MOD, MOD, ...)
918**
919** Return YYYY-MM-DD HH:MM:SS
920*/
drhf9b596e2004-05-26 16:54:42 +0000921static void datetimeFunc(
922 sqlite3_context *context,
923 int argc,
924 sqlite3_value **argv
925){
drh7014aff2003-11-01 01:53:53 +0000926 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000927 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000928 char zBuf[100];
drhba212562004-01-08 02:17:31 +0000929 computeYMD_HMS(&x);
drh5bb3eb92007-05-04 13:15:55 +0000930 sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d %02d:%02d:%02d",
931 x.Y, x.M, x.D, x.h, x.m, (int)(x.s));
danielk1977d8123362004-06-12 09:25:12 +0000932 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +0000933 }
934}
935
936/*
937** time( TIMESTRING, MOD, MOD, ...)
938**
939** Return HH:MM:SS
940*/
drhf9b596e2004-05-26 16:54:42 +0000941static void timeFunc(
942 sqlite3_context *context,
943 int argc,
944 sqlite3_value **argv
945){
drh7014aff2003-11-01 01:53:53 +0000946 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000947 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000948 char zBuf[100];
949 computeHMS(&x);
drh5bb3eb92007-05-04 13:15:55 +0000950 sqlite3_snprintf(sizeof(zBuf), zBuf, "%02d:%02d:%02d", x.h, x.m, (int)x.s);
danielk1977d8123362004-06-12 09:25:12 +0000951 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +0000952 }
953}
954
955/*
956** date( TIMESTRING, MOD, MOD, ...)
957**
958** Return YYYY-MM-DD
959*/
drhf9b596e2004-05-26 16:54:42 +0000960static void dateFunc(
961 sqlite3_context *context,
962 int argc,
963 sqlite3_value **argv
964){
drh7014aff2003-11-01 01:53:53 +0000965 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000966 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000967 char zBuf[100];
968 computeYMD(&x);
drh5bb3eb92007-05-04 13:15:55 +0000969 sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d", x.Y, x.M, x.D);
danielk1977d8123362004-06-12 09:25:12 +0000970 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +0000971 }
972}
973
974/*
975** strftime( FORMAT, TIMESTRING, MOD, MOD, ...)
976**
977** Return a string described by FORMAT. Conversions as follows:
978**
979** %d day of month
980** %f ** fractional seconds SS.SSS
981** %H hour 00-24
982** %j day of year 000-366
drh86a11b82014-11-07 13:24:29 +0000983** %J ** julian day number
drh7014aff2003-11-01 01:53:53 +0000984** %m month 01-12
985** %M minute 00-59
986** %s seconds since 1970-01-01
987** %S seconds 00-59
988** %w day of week 0-6 sunday==0
989** %W week of year 00-53
990** %Y year 0000-9999
991** %% %
992*/
drhf9b596e2004-05-26 16:54:42 +0000993static void strftimeFunc(
994 sqlite3_context *context,
995 int argc,
996 sqlite3_value **argv
997){
drh7014aff2003-11-01 01:53:53 +0000998 DateTime x;
drha0206bc2007-05-08 15:15:02 +0000999 u64 n;
shaneaef3af52008-12-09 04:59:00 +00001000 size_t i,j;
drh7014aff2003-11-01 01:53:53 +00001001 char *z;
drh633e6d52008-07-28 19:34:53 +00001002 sqlite3 *db;
drh655814d2015-01-09 01:27:29 +00001003 const char *zFmt;
drh7014aff2003-11-01 01:53:53 +00001004 char zBuf[100];
drh655814d2015-01-09 01:27:29 +00001005 if( argc==0 ) return;
1006 zFmt = (const char*)sqlite3_value_text(argv[0]);
danielk1977fee2d252007-08-18 10:59:19 +00001007 if( zFmt==0 || isDate(context, argc-1, argv+1, &x) ) return;
drh633e6d52008-07-28 19:34:53 +00001008 db = sqlite3_context_db_handle(context);
drh7014aff2003-11-01 01:53:53 +00001009 for(i=0, n=1; zFmt[i]; i++, n++){
1010 if( zFmt[i]=='%' ){
1011 switch( zFmt[i+1] ){
1012 case 'd':
1013 case 'H':
1014 case 'm':
1015 case 'M':
1016 case 'S':
1017 case 'W':
1018 n++;
1019 /* fall thru */
1020 case 'w':
1021 case '%':
1022 break;
1023 case 'f':
1024 n += 8;
1025 break;
1026 case 'j':
1027 n += 3;
1028 break;
1029 case 'Y':
1030 n += 8;
1031 break;
1032 case 's':
1033 case 'J':
1034 n += 50;
1035 break;
1036 default:
1037 return; /* ERROR. return a NULL */
1038 }
1039 i++;
1040 }
1041 }
drh67110022009-01-28 02:55:28 +00001042 testcase( n==sizeof(zBuf)-1 );
1043 testcase( n==sizeof(zBuf) );
1044 testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH]+1 );
1045 testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH] );
drh7014aff2003-11-01 01:53:53 +00001046 if( n<sizeof(zBuf) ){
1047 z = zBuf;
danielk197700e13612008-11-17 19:18:54 +00001048 }else if( n>(u64)db->aLimit[SQLITE_LIMIT_LENGTH] ){
drha0206bc2007-05-08 15:15:02 +00001049 sqlite3_result_error_toobig(context);
1050 return;
drh7014aff2003-11-01 01:53:53 +00001051 }else{
drh575fad62016-02-05 13:38:36 +00001052 z = sqlite3DbMallocRawNN(db, (int)n);
drh3334e942008-01-17 20:26:46 +00001053 if( z==0 ){
1054 sqlite3_result_error_nomem(context);
1055 return;
1056 }
drh7014aff2003-11-01 01:53:53 +00001057 }
1058 computeJD(&x);
drhba212562004-01-08 02:17:31 +00001059 computeYMD_HMS(&x);
drh7014aff2003-11-01 01:53:53 +00001060 for(i=j=0; zFmt[i]; i++){
1061 if( zFmt[i]!='%' ){
1062 z[j++] = zFmt[i];
1063 }else{
1064 i++;
1065 switch( zFmt[i] ){
drh5bb3eb92007-05-04 13:15:55 +00001066 case 'd': sqlite3_snprintf(3, &z[j],"%02d",x.D); j+=2; break;
drh7014aff2003-11-01 01:53:53 +00001067 case 'f': {
drhb1f1e6e2006-09-25 18:01:31 +00001068 double s = x.s;
1069 if( s>59.999 ) s = 59.999;
drh2ecad3b2007-03-29 17:57:21 +00001070 sqlite3_snprintf(7, &z[j],"%06.3f", s);
drhea678832008-12-10 19:26:22 +00001071 j += sqlite3Strlen30(&z[j]);
drh7014aff2003-11-01 01:53:53 +00001072 break;
1073 }
drh5bb3eb92007-05-04 13:15:55 +00001074 case 'H': sqlite3_snprintf(3, &z[j],"%02d",x.h); j+=2; break;
drh7014aff2003-11-01 01:53:53 +00001075 case 'W': /* Fall thru */
1076 case 'j': {
danielk1977f0113002006-01-24 12:09:17 +00001077 int nDay; /* Number of days since 1st day of year */
drh7014aff2003-11-01 01:53:53 +00001078 DateTime y = x;
1079 y.validJD = 0;
1080 y.M = 1;
1081 y.D = 1;
1082 computeJD(&y);
shaneaef3af52008-12-09 04:59:00 +00001083 nDay = (int)((x.iJD-y.iJD+43200000)/86400000);
drh7014aff2003-11-01 01:53:53 +00001084 if( zFmt[i]=='W' ){
drh1020d492004-07-18 22:22:43 +00001085 int wd; /* 0=Monday, 1=Tuesday, ... 6=Sunday */
shaneaef3af52008-12-09 04:59:00 +00001086 wd = (int)(((x.iJD+43200000)/86400000)%7);
drh5bb3eb92007-05-04 13:15:55 +00001087 sqlite3_snprintf(3, &z[j],"%02d",(nDay+7-wd)/7);
drh7014aff2003-11-01 01:53:53 +00001088 j += 2;
1089 }else{
drh5bb3eb92007-05-04 13:15:55 +00001090 sqlite3_snprintf(4, &z[j],"%03d",nDay+1);
drh7014aff2003-11-01 01:53:53 +00001091 j += 3;
1092 }
1093 break;
1094 }
drh5bb3eb92007-05-04 13:15:55 +00001095 case 'J': {
drh85f477a2008-06-12 16:35:38 +00001096 sqlite3_snprintf(20, &z[j],"%.16g",x.iJD/86400000.0);
drhea678832008-12-10 19:26:22 +00001097 j+=sqlite3Strlen30(&z[j]);
drh5bb3eb92007-05-04 13:15:55 +00001098 break;
1099 }
1100 case 'm': sqlite3_snprintf(3, &z[j],"%02d",x.M); j+=2; break;
1101 case 'M': sqlite3_snprintf(3, &z[j],"%02d",x.m); j+=2; break;
drh7014aff2003-11-01 01:53:53 +00001102 case 's': {
drh6eb41522009-04-01 20:44:13 +00001103 sqlite3_snprintf(30,&z[j],"%lld",
drh07758962009-04-03 12:04:36 +00001104 (i64)(x.iJD/1000 - 21086676*(i64)10000));
drhea678832008-12-10 19:26:22 +00001105 j += sqlite3Strlen30(&z[j]);
drh7014aff2003-11-01 01:53:53 +00001106 break;
1107 }
drh5bb3eb92007-05-04 13:15:55 +00001108 case 'S': sqlite3_snprintf(3,&z[j],"%02d",(int)x.s); j+=2; break;
drhea678832008-12-10 19:26:22 +00001109 case 'w': {
1110 z[j++] = (char)(((x.iJD+129600000)/86400000) % 7) + '0';
1111 break;
1112 }
1113 case 'Y': {
1114 sqlite3_snprintf(5,&z[j],"%04d",x.Y); j+=sqlite3Strlen30(&z[j]);
1115 break;
1116 }
drh008e4762008-01-17 22:27:53 +00001117 default: z[j++] = '%'; break;
drh7014aff2003-11-01 01:53:53 +00001118 }
1119 }
1120 }
1121 z[j] = 0;
drh3334e942008-01-17 20:26:46 +00001122 sqlite3_result_text(context, z, -1,
drh633e6d52008-07-28 19:34:53 +00001123 z==zBuf ? SQLITE_TRANSIENT : SQLITE_DYNAMIC);
drh7014aff2003-11-01 01:53:53 +00001124}
1125
danielk19777977a172004-11-09 12:44:37 +00001126/*
1127** current_time()
1128**
1129** This function returns the same value as time('now').
1130*/
1131static void ctimeFunc(
1132 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001133 int NotUsed,
1134 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001135){
danielk197762c14b32008-11-19 09:05:26 +00001136 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001137 timeFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001138}
drh7014aff2003-11-01 01:53:53 +00001139
danielk19777977a172004-11-09 12:44:37 +00001140/*
1141** current_date()
1142**
1143** This function returns the same value as date('now').
1144*/
1145static void cdateFunc(
1146 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001147 int NotUsed,
1148 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001149){
danielk197762c14b32008-11-19 09:05:26 +00001150 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001151 dateFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001152}
1153
1154/*
1155** current_timestamp()
1156**
1157** This function returns the same value as datetime('now').
1158*/
1159static void ctimestampFunc(
1160 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001161 int NotUsed,
1162 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001163){
danielk197762c14b32008-11-19 09:05:26 +00001164 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001165 datetimeFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001166}
drh7014aff2003-11-01 01:53:53 +00001167#endif /* !defined(SQLITE_OMIT_DATETIME_FUNCS) */
1168
danielk1977752e6792004-11-09 16:13:33 +00001169#ifdef SQLITE_OMIT_DATETIME_FUNCS
1170/*
1171** If the library is compiled to omit the full-scale date and time
1172** handling (to get a smaller binary), the following minimal version
1173** of the functions current_time(), current_date() and current_timestamp()
1174** are included instead. This is to support column declarations that
1175** include "DEFAULT CURRENT_TIME" etc.
1176**
danielk19772df9fab2004-11-11 01:50:30 +00001177** This function uses the C-library functions time(), gmtime()
danielk1977752e6792004-11-09 16:13:33 +00001178** and strftime(). The format string to pass to strftime() is supplied
1179** as the user-data for the function.
1180*/
danielk1977752e6792004-11-09 16:13:33 +00001181static void currentTimeFunc(
1182 sqlite3_context *context,
1183 int argc,
1184 sqlite3_value **argv
1185){
1186 time_t t;
1187 char *zFormat = (char *)sqlite3_user_data(context);
drhb7e8ea22010-05-03 14:32:30 +00001188 sqlite3_int64 iT;
drh31702252011-10-12 23:13:43 +00001189 struct tm *pTm;
1190 struct tm sNow;
danielk1977752e6792004-11-09 16:13:33 +00001191 char zBuf[20];
danielk1977752e6792004-11-09 16:13:33 +00001192
shanefbd60f82009-02-04 03:59:25 +00001193 UNUSED_PARAMETER(argc);
1194 UNUSED_PARAMETER(argv);
1195
drh95a7b3e2013-09-16 12:57:19 +00001196 iT = sqlite3StmtCurrentTime(context);
1197 if( iT<=0 ) return;
drhd5e6e402010-05-03 19:17:01 +00001198 t = iT/1000 - 10000*(sqlite3_int64)21086676;
drh0ede9eb2015-01-10 16:49:23 +00001199#if HAVE_GMTIME_R
drh31702252011-10-12 23:13:43 +00001200 pTm = gmtime_r(&t, &sNow);
drh87595762006-09-08 12:49:43 +00001201#else
drh31702252011-10-12 23:13:43 +00001202 sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
1203 pTm = gmtime(&t);
1204 if( pTm ) memcpy(&sNow, pTm, sizeof(sNow));
1205 sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
drh87595762006-09-08 12:49:43 +00001206#endif
drh31702252011-10-12 23:13:43 +00001207 if( pTm ){
1208 strftime(zBuf, 20, zFormat, &sNow);
1209 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
1210 }
danielk1977752e6792004-11-09 16:13:33 +00001211}
1212#endif
1213
drh7014aff2003-11-01 01:53:53 +00001214/*
1215** This function registered all of the above C functions as SQL
1216** functions. This should be the only routine in this file with
1217** external linkage.
1218*/
drh777c5382008-08-21 20:21:34 +00001219void sqlite3RegisterDateTimeFunctions(void){
drh80738d92016-02-15 00:34:16 +00001220 static FuncDef aDateTimeFuncs[] = {
drhfd1f3942004-07-20 00:39:14 +00001221#ifndef SQLITE_OMIT_DATETIME_FUNCS
drh1d85e402015-08-31 17:34:41 +00001222 DFUNCTION(julianday, -1, 0, 0, juliandayFunc ),
1223 DFUNCTION(date, -1, 0, 0, dateFunc ),
1224 DFUNCTION(time, -1, 0, 0, timeFunc ),
1225 DFUNCTION(datetime, -1, 0, 0, datetimeFunc ),
1226 DFUNCTION(strftime, -1, 0, 0, strftimeFunc ),
1227 DFUNCTION(current_time, 0, 0, 0, ctimeFunc ),
1228 DFUNCTION(current_timestamp, 0, 0, 0, ctimestampFunc),
1229 DFUNCTION(current_date, 0, 0, 0, cdateFunc ),
danielk1977752e6792004-11-09 16:13:33 +00001230#else
drh21717ed2008-10-13 15:35:08 +00001231 STR_FUNCTION(current_time, 0, "%H:%M:%S", 0, currentTimeFunc),
drh2b1e6902010-01-12 19:28:20 +00001232 STR_FUNCTION(current_date, 0, "%Y-%m-%d", 0, currentTimeFunc),
1233 STR_FUNCTION(current_timestamp, 0, "%Y-%m-%d %H:%M:%S", 0, currentTimeFunc),
drh777c5382008-08-21 20:21:34 +00001234#endif
danielk1977752e6792004-11-09 16:13:33 +00001235 };
drh80738d92016-02-15 00:34:16 +00001236 sqlite3InsertBuiltinFuncs(aDateTimeFuncs, ArraySize(aDateTimeFuncs));
drh7014aff2003-11-01 01:53:53 +00001237}