blob: ef05d44086118bcd8a752eb058c122a12d675a3b [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
shaneb8109ad2008-05-27 19:49:21 +000053
54/*
drh7014aff2003-11-01 01:53:53 +000055** A structure for holding a single date and time.
56*/
57typedef struct DateTime DateTime;
58struct DateTime {
drh85f477a2008-06-12 16:35:38 +000059 sqlite3_int64 iJD; /* The julian day number times 86400000 */
60 int Y, M, D; /* Year, month, and day */
61 int h, m; /* Hour and minutes */
62 int tz; /* Timezone offset in minutes */
63 double s; /* Seconds */
shaneaef3af52008-12-09 04:59:00 +000064 char validYMD; /* True (1) if Y,M,D are valid */
65 char validHMS; /* True (1) if h,m,s are valid */
66 char validJD; /* True (1) if iJD is valid */
67 char validTZ; /* True (1) if tz is valid */
drhcaeca512015-12-23 10:54:48 +000068 char tzSet; /* Timezone was set explicitly */
drh7014aff2003-11-01 01:53:53 +000069};
70
71
72/*
drh33496202016-01-14 19:32:46 +000073** Convert zDate into one or more integers according to the conversion
74** specifier zFormat.
drheb9a9e82004-02-22 17:49:32 +000075**
drh33496202016-01-14 19:32:46 +000076** zFormat[] contains 4 characters for each integer converted, except for
77** the last integer which is specified by three characters. The meaning
78** of a four-character format specifiers ABCD is:
drheb9a9e82004-02-22 17:49:32 +000079**
drh33496202016-01-14 19:32:46 +000080** A: number of digits to convert. Always "2" or "4".
81** B: minimum value. Always "0" or "1".
82** C: maximum value, decoded as:
83** a: 12
84** b: 14
85** c: 24
86** d: 31
87** e: 59
88** f: 9999
89** D: the separator character, or \000 to indicate this is the
90** last number to convert.
91**
92** Example: To translate an ISO-8601 date YYYY-MM-DD, the format would
93** be "40f-21a-20c". The "40f-" indicates the 4-digit year followed by "-".
94** The "21a-" indicates the 2-digit month followed by "-". The "20c" indicates
95** the 2-digit day which is the last integer in the set.
96**
drheb9a9e82004-02-22 17:49:32 +000097** The function returns the number of successful conversions.
drh7014aff2003-11-01 01:53:53 +000098*/
drh33496202016-01-14 19:32:46 +000099static int getDigits(const char *zDate, const char *zFormat, ...){
100 /* The aMx[] array translates the 3rd character of each format
101 ** spec into a max size: a b c d e f */
102 static const u16 aMx[] = { 12, 14, 24, 31, 59, 9999 };
drheb9a9e82004-02-22 17:49:32 +0000103 va_list ap;
drheb9a9e82004-02-22 17:49:32 +0000104 int cnt = 0;
drh33496202016-01-14 19:32:46 +0000105 char nextC;
106 va_start(ap, zFormat);
drheb9a9e82004-02-22 17:49:32 +0000107 do{
drh33496202016-01-14 19:32:46 +0000108 char N = zFormat[0] - '0';
109 char min = zFormat[1] - '0';
110 int val = 0;
111 u16 max;
112
113 assert( zFormat[2]>='a' && zFormat[2]<='f' );
114 max = aMx[zFormat[2] - 'a'];
115 nextC = zFormat[3];
drheb9a9e82004-02-22 17:49:32 +0000116 val = 0;
117 while( N-- ){
danielk197778ca0e72009-01-20 16:53:39 +0000118 if( !sqlite3Isdigit(*zDate) ){
drh029b44b2006-01-15 00:13:15 +0000119 goto end_getDigits;
drheb9a9e82004-02-22 17:49:32 +0000120 }
121 val = val*10 + *zDate - '0';
122 zDate++;
123 }
drh33496202016-01-14 19:32:46 +0000124 if( val<(int)min || val>(int)max || (nextC!=0 && nextC!=*zDate) ){
drh029b44b2006-01-15 00:13:15 +0000125 goto end_getDigits;
drheb9a9e82004-02-22 17:49:32 +0000126 }
drh33496202016-01-14 19:32:46 +0000127 *va_arg(ap,int*) = val;
drh7014aff2003-11-01 01:53:53 +0000128 zDate++;
drheb9a9e82004-02-22 17:49:32 +0000129 cnt++;
drh33496202016-01-14 19:32:46 +0000130 zFormat += 4;
drheb9a9e82004-02-22 17:49:32 +0000131 }while( nextC );
drh029b44b2006-01-15 00:13:15 +0000132end_getDigits:
drh15b9a152006-01-31 20:49:13 +0000133 va_end(ap);
drheb9a9e82004-02-22 17:49:32 +0000134 return cnt;
drh7014aff2003-11-01 01:53:53 +0000135}
136
137/*
drh7014aff2003-11-01 01:53:53 +0000138** Parse a timezone extension on the end of a date-time.
139** The extension is of the form:
140**
141** (+/-)HH:MM
142**
drh1cfdc902008-02-21 20:40:43 +0000143** Or the "zulu" notation:
144**
145** Z
146**
drh7014aff2003-11-01 01:53:53 +0000147** If the parse is successful, write the number of minutes
drh1cfdc902008-02-21 20:40:43 +0000148** of change in p->tz and return 0. If a parser error occurs,
149** return non-zero.
drh7014aff2003-11-01 01:53:53 +0000150**
151** A missing specifier is not considered an error.
152*/
153static int parseTimezone(const char *zDate, DateTime *p){
154 int sgn = 0;
155 int nHr, nMn;
drh1cfdc902008-02-21 20:40:43 +0000156 int c;
danielk197778ca0e72009-01-20 16:53:39 +0000157 while( sqlite3Isspace(*zDate) ){ zDate++; }
drh7014aff2003-11-01 01:53:53 +0000158 p->tz = 0;
drh1cfdc902008-02-21 20:40:43 +0000159 c = *zDate;
160 if( c=='-' ){
drh7014aff2003-11-01 01:53:53 +0000161 sgn = -1;
drh1cfdc902008-02-21 20:40:43 +0000162 }else if( c=='+' ){
drh7014aff2003-11-01 01:53:53 +0000163 sgn = +1;
drh1cfdc902008-02-21 20:40:43 +0000164 }else if( c=='Z' || c=='z' ){
165 zDate++;
166 goto zulu_time;
drh7014aff2003-11-01 01:53:53 +0000167 }else{
drh1cfdc902008-02-21 20:40:43 +0000168 return c!=0;
drh7014aff2003-11-01 01:53:53 +0000169 }
170 zDate++;
drh33496202016-01-14 19:32:46 +0000171 if( getDigits(zDate, "20b:20e", &nHr, &nMn)!=2 ){
drheb9a9e82004-02-22 17:49:32 +0000172 return 1;
173 }
174 zDate += 5;
drh7014aff2003-11-01 01:53:53 +0000175 p->tz = sgn*(nMn + nHr*60);
drh1cfdc902008-02-21 20:40:43 +0000176zulu_time:
danielk197778ca0e72009-01-20 16:53:39 +0000177 while( sqlite3Isspace(*zDate) ){ zDate++; }
drhcaeca512015-12-23 10:54:48 +0000178 p->tzSet = 1;
drh7014aff2003-11-01 01:53:53 +0000179 return *zDate!=0;
180}
181
182/*
183** Parse times of the form HH:MM or HH:MM:SS or HH:MM:SS.FFFF.
184** The HH, MM, and SS must each be exactly 2 digits. The
185** fractional seconds FFFF can be one or more digits.
186**
187** Return 1 if there is a parsing error and 0 on success.
188*/
189static int parseHhMmSs(const char *zDate, DateTime *p){
190 int h, m, s;
191 double ms = 0.0;
drh33496202016-01-14 19:32:46 +0000192 if( getDigits(zDate, "20c:20e", &h, &m)!=2 ){
drheb9a9e82004-02-22 17:49:32 +0000193 return 1;
194 }
195 zDate += 5;
drh7014aff2003-11-01 01:53:53 +0000196 if( *zDate==':' ){
drheb9a9e82004-02-22 17:49:32 +0000197 zDate++;
drh33496202016-01-14 19:32:46 +0000198 if( getDigits(zDate, "20e", &s)!=1 ){
drheb9a9e82004-02-22 17:49:32 +0000199 return 1;
200 }
201 zDate += 2;
danielk197778ca0e72009-01-20 16:53:39 +0000202 if( *zDate=='.' && sqlite3Isdigit(zDate[1]) ){
drh7014aff2003-11-01 01:53:53 +0000203 double rScale = 1.0;
204 zDate++;
danielk197778ca0e72009-01-20 16:53:39 +0000205 while( sqlite3Isdigit(*zDate) ){
drh7014aff2003-11-01 01:53:53 +0000206 ms = ms*10.0 + *zDate - '0';
207 rScale *= 10.0;
208 zDate++;
209 }
210 ms /= rScale;
211 }
212 }else{
213 s = 0;
214 }
215 p->validJD = 0;
216 p->validHMS = 1;
217 p->h = h;
218 p->m = m;
219 p->s = s + ms;
220 if( parseTimezone(zDate, p) ) return 1;
shaneaef3af52008-12-09 04:59:00 +0000221 p->validTZ = (p->tz!=0)?1:0;
drh7014aff2003-11-01 01:53:53 +0000222 return 0;
223}
224
225/*
226** Convert from YYYY-MM-DD HH:MM:SS to julian day. We always assume
227** that the YYYY-MM-DD is according to the Gregorian calendar.
228**
229** Reference: Meeus page 61
230*/
231static void computeJD(DateTime *p){
232 int Y, M, D, A, B, X1, X2;
233
234 if( p->validJD ) return;
235 if( p->validYMD ){
236 Y = p->Y;
237 M = p->M;
238 D = p->D;
239 }else{
drhba212562004-01-08 02:17:31 +0000240 Y = 2000; /* If no YMD specified, assume 2000-Jan-01 */
drh7014aff2003-11-01 01:53:53 +0000241 M = 1;
242 D = 1;
243 }
244 if( M<=2 ){
245 Y--;
246 M += 12;
247 }
248 A = Y/100;
249 B = 2 - A + (A/4);
shaneaef3af52008-12-09 04:59:00 +0000250 X1 = 36525*(Y+4716)/100;
251 X2 = 306001*(M+1)/10000;
252 p->iJD = (sqlite3_int64)((X1 + X2 + D + B - 1524.5 ) * 86400000);
drh7014aff2003-11-01 01:53:53 +0000253 p->validJD = 1;
drh7014aff2003-11-01 01:53:53 +0000254 if( p->validHMS ){
shaneaef3af52008-12-09 04:59:00 +0000255 p->iJD += p->h*3600000 + p->m*60000 + (sqlite3_int64)(p->s*1000);
drh7014aff2003-11-01 01:53:53 +0000256 if( p->validTZ ){
drh85f477a2008-06-12 16:35:38 +0000257 p->iJD -= p->tz*60000;
drhf11c34d2006-09-08 12:27:36 +0000258 p->validYMD = 0;
drh7014aff2003-11-01 01:53:53 +0000259 p->validHMS = 0;
260 p->validTZ = 0;
261 }
262 }
263}
264
265/*
266** Parse dates of the form
267**
268** YYYY-MM-DD HH:MM:SS.FFF
269** YYYY-MM-DD HH:MM:SS
270** YYYY-MM-DD HH:MM
271** YYYY-MM-DD
272**
273** Write the result into the DateTime structure and return 0
274** on success and 1 if the input string is not a well-formed
275** date.
276*/
277static int parseYyyyMmDd(const char *zDate, DateTime *p){
drh8eb2cce2004-02-21 03:28:18 +0000278 int Y, M, D, neg;
drh7014aff2003-11-01 01:53:53 +0000279
drh8eb2cce2004-02-21 03:28:18 +0000280 if( zDate[0]=='-' ){
281 zDate++;
282 neg = 1;
283 }else{
284 neg = 0;
285 }
drh33496202016-01-14 19:32:46 +0000286 if( getDigits(zDate, "40f-21a-21d", &Y, &M, &D)!=3 ){
drheb9a9e82004-02-22 17:49:32 +0000287 return 1;
288 }
289 zDate += 10;
danielk197778ca0e72009-01-20 16:53:39 +0000290 while( sqlite3Isspace(*zDate) || 'T'==*(u8*)zDate ){ zDate++; }
drheb9a9e82004-02-22 17:49:32 +0000291 if( parseHhMmSs(zDate, p)==0 ){
292 /* We got the time */
drh7014aff2003-11-01 01:53:53 +0000293 }else if( *zDate==0 ){
294 p->validHMS = 0;
295 }else{
296 return 1;
297 }
298 p->validJD = 0;
299 p->validYMD = 1;
drh8eb2cce2004-02-21 03:28:18 +0000300 p->Y = neg ? -Y : Y;
drh7014aff2003-11-01 01:53:53 +0000301 p->M = M;
302 p->D = D;
303 if( p->validTZ ){
304 computeJD(p);
305 }
306 return 0;
307}
308
309/*
drh31702252011-10-12 23:13:43 +0000310** Set the time to the current time reported by the VFS.
311**
312** Return the number of errors.
drh3af5d682008-06-12 13:50:00 +0000313*/
drh31702252011-10-12 23:13:43 +0000314static int setDateTimeToCurrent(sqlite3_context *context, DateTime *p){
drh95a7b3e2013-09-16 12:57:19 +0000315 p->iJD = sqlite3StmtCurrentTime(context);
316 if( p->iJD>0 ){
drh31702252011-10-12 23:13:43 +0000317 p->validJD = 1;
318 return 0;
319 }else{
320 return 1;
321 }
drh3af5d682008-06-12 13:50:00 +0000322}
323
324/*
drh86a11b82014-11-07 13:24:29 +0000325** Attempt to parse the given string into a julian day number. Return
drh7014aff2003-11-01 01:53:53 +0000326** the number of errors.
327**
328** The following are acceptable forms for the input string:
329**
330** YYYY-MM-DD HH:MM:SS.FFF +/-HH:MM
331** DDDD.DD
332** now
333**
334** In the first form, the +/-HH:MM is always optional. The fractional
335** seconds extension (the ".FFF") is optional. The seconds portion
336** (":SS.FFF") is option. The year and date can be omitted as long
337** as there is a time string. The time string can be omitted as long
338** as there is a year and date.
339*/
danielk1977fee2d252007-08-18 10:59:19 +0000340static int parseDateOrTime(
341 sqlite3_context *context,
342 const char *zDate,
343 DateTime *p
344){
drh9339da12010-09-30 00:50:49 +0000345 double r;
drh8eb2cce2004-02-21 03:28:18 +0000346 if( parseYyyyMmDd(zDate,p)==0 ){
drh7014aff2003-11-01 01:53:53 +0000347 return 0;
drh8eb2cce2004-02-21 03:28:18 +0000348 }else if( parseHhMmSs(zDate, p)==0 ){
349 return 0;
danielk19774adee202004-05-08 08:23:19 +0000350 }else if( sqlite3StrICmp(zDate,"now")==0){
drh31702252011-10-12 23:13:43 +0000351 return setDateTimeToCurrent(context, p);
drh9339da12010-09-30 00:50:49 +0000352 }else if( sqlite3AtoF(zDate, &r, sqlite3Strlen30(zDate), SQLITE_UTF8) ){
drh85f477a2008-06-12 16:35:38 +0000353 p->iJD = (sqlite3_int64)(r*86400000.0 + 0.5);
drh7014aff2003-11-01 01:53:53 +0000354 p->validJD = 1;
355 return 0;
356 }
357 return 1;
358}
359
360/*
361** Compute the Year, Month, and Day from the julian day number.
362*/
363static void computeYMD(DateTime *p){
364 int Z, A, B, C, D, E, X1;
365 if( p->validYMD ) return;
drh33a9ad22004-02-29 00:40:32 +0000366 if( !p->validJD ){
367 p->Y = 2000;
368 p->M = 1;
369 p->D = 1;
370 }else{
shaneaef3af52008-12-09 04:59:00 +0000371 Z = (int)((p->iJD + 43200000)/86400000);
372 A = (int)((Z - 1867216.25)/36524.25);
drh33a9ad22004-02-29 00:40:32 +0000373 A = Z + 1 + A - (A/4);
374 B = A + 1524;
shaneaef3af52008-12-09 04:59:00 +0000375 C = (int)((B - 122.1)/365.25);
drh618ee612015-07-15 18:04:48 +0000376 D = (36525*(C&32767))/100;
shaneaef3af52008-12-09 04:59:00 +0000377 E = (int)((B-D)/30.6001);
378 X1 = (int)(30.6001*E);
drh33a9ad22004-02-29 00:40:32 +0000379 p->D = B - D - X1;
380 p->M = E<14 ? E-1 : E-13;
381 p->Y = p->M>2 ? C - 4716 : C - 4715;
382 }
drh7014aff2003-11-01 01:53:53 +0000383 p->validYMD = 1;
384}
385
386/*
387** Compute the Hour, Minute, and Seconds from the julian day number.
388*/
389static void computeHMS(DateTime *p){
drh85f477a2008-06-12 16:35:38 +0000390 int s;
drh7014aff2003-11-01 01:53:53 +0000391 if( p->validHMS ) return;
drhf11c34d2006-09-08 12:27:36 +0000392 computeJD(p);
shaneaef3af52008-12-09 04:59:00 +0000393 s = (int)((p->iJD + 43200000) % 86400000);
drh85f477a2008-06-12 16:35:38 +0000394 p->s = s/1000.0;
shaneaef3af52008-12-09 04:59:00 +0000395 s = (int)p->s;
drh7014aff2003-11-01 01:53:53 +0000396 p->s -= s;
397 p->h = s/3600;
398 s -= p->h*3600;
399 p->m = s/60;
400 p->s += s - p->m*60;
401 p->validHMS = 1;
402}
403
404/*
drhba212562004-01-08 02:17:31 +0000405** Compute both YMD and HMS
406*/
407static void computeYMD_HMS(DateTime *p){
408 computeYMD(p);
409 computeHMS(p);
410}
411
412/*
413** Clear the YMD and HMS and the TZ
414*/
415static void clearYMD_HMS_TZ(DateTime *p){
416 p->validYMD = 0;
417 p->validHMS = 0;
418 p->validTZ = 0;
419}
420
drha924aca2011-06-21 15:01:25 +0000421/*
422** On recent Windows platforms, the localtime_s() function is available
423** as part of the "Secure CRT". It is essentially equivalent to
424** localtime_r() available under most POSIX platforms, except that the
425** order of the parameters is reversed.
426**
427** See http://msdn.microsoft.com/en-us/library/a442x3ye(VS.80).aspx.
428**
429** If the user has not indicated to use localtime_r() or localtime_s()
430** already, check for an MSVC build environment that provides
431** localtime_s().
432*/
drh0ede9eb2015-01-10 16:49:23 +0000433#if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S \
434 && defined(_MSC_VER) && defined(_CRT_INSECURE_DEPRECATE)
435#undef HAVE_LOCALTIME_S
drha924aca2011-06-21 15:01:25 +0000436#define HAVE_LOCALTIME_S 1
437#endif
438
drh66147c92008-06-12 12:51:37 +0000439#ifndef SQLITE_OMIT_LOCALTIME
drhba212562004-01-08 02:17:31 +0000440/*
drh8720aeb2011-06-21 14:35:30 +0000441** The following routine implements the rough equivalent of localtime_r()
442** using whatever operating-system specific localtime facility that
443** is available. This routine returns 0 on success and
444** non-zero on any kind of error.
danc17d6962011-06-21 12:47:30 +0000445**
drh8720aeb2011-06-21 14:35:30 +0000446** If the sqlite3GlobalConfig.bLocaltimeFault variable is true then this
447** routine will always fail.
drhe4bf4f02013-10-11 20:14:37 +0000448**
449** EVIDENCE-OF: R-62172-00036 In this implementation, the standard C
450** library function localtime_r() is used to assist in the calculation of
451** local time.
drh7091cb02003-12-23 16:22:18 +0000452*/
drh1f93a082011-06-21 15:54:24 +0000453static int osLocaltime(time_t *t, struct tm *pTm){
drh8720aeb2011-06-21 14:35:30 +0000454 int rc;
drh0ede9eb2015-01-10 16:49:23 +0000455#if !HAVE_LOCALTIME_R && !HAVE_LOCALTIME_S
drha924aca2011-06-21 15:01:25 +0000456 struct tm *pX;
drhdf3aa162011-06-24 11:29:51 +0000457#if SQLITE_THREADSAFE>0
drha924aca2011-06-21 15:01:25 +0000458 sqlite3_mutex *mutex = sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER);
drhdf3aa162011-06-24 11:29:51 +0000459#endif
drha924aca2011-06-21 15:01:25 +0000460 sqlite3_mutex_enter(mutex);
461 pX = localtime(t);
462#ifndef SQLITE_OMIT_BUILTIN_TEST
463 if( sqlite3GlobalConfig.bLocaltimeFault ) pX = 0;
464#endif
465 if( pX ) *pTm = *pX;
466 sqlite3_mutex_leave(mutex);
467 rc = pX==0;
468#else
danc17d6962011-06-21 12:47:30 +0000469#ifndef SQLITE_OMIT_BUILTIN_TEST
danc17d6962011-06-21 12:47:30 +0000470 if( sqlite3GlobalConfig.bLocaltimeFault ) return 1;
danc17d6962011-06-21 12:47:30 +0000471#endif
drh0ede9eb2015-01-10 16:49:23 +0000472#if HAVE_LOCALTIME_R
drh8720aeb2011-06-21 14:35:30 +0000473 rc = localtime_r(t, pTm)==0;
danc17d6962011-06-21 12:47:30 +0000474#else
drha924aca2011-06-21 15:01:25 +0000475 rc = localtime_s(pTm, t);
476#endif /* HAVE_LOCALTIME_R */
477#endif /* HAVE_LOCALTIME_R || HAVE_LOCALTIME_S */
drh8720aeb2011-06-21 14:35:30 +0000478 return rc;
479}
480#endif /* SQLITE_OMIT_LOCALTIME */
danc17d6962011-06-21 12:47:30 +0000481
482
drh8720aeb2011-06-21 14:35:30 +0000483#ifndef SQLITE_OMIT_LOCALTIME
danc17d6962011-06-21 12:47:30 +0000484/*
485** Compute the difference (in milliseconds) between localtime and UTC
486** (a.k.a. GMT) for the time value p where p is in UTC. If no error occurs,
487** return this value and set *pRc to SQLITE_OK.
488**
489** Or, if an error does occur, set *pRc to SQLITE_ERROR. The returned value
490** is undefined in this case.
491*/
492static sqlite3_int64 localtimeOffset(
493 DateTime *p, /* Date at which to calculate offset */
494 sqlite3_context *pCtx, /* Write error here if one occurs */
495 int *pRc /* OUT: Error code. SQLITE_OK or ERROR */
496){
drh7091cb02003-12-23 16:22:18 +0000497 DateTime x, y;
498 time_t t;
drh8720aeb2011-06-21 14:35:30 +0000499 struct tm sLocal;
500
dan0d37f582011-06-21 15:38:05 +0000501 /* Initialize the contents of sLocal to avoid a compiler warning. */
502 memset(&sLocal, 0, sizeof(sLocal));
503
drh7091cb02003-12-23 16:22:18 +0000504 x = *p;
drhba212562004-01-08 02:17:31 +0000505 computeYMD_HMS(&x);
drh7091cb02003-12-23 16:22:18 +0000506 if( x.Y<1971 || x.Y>=2038 ){
drhe4bf4f02013-10-11 20:14:37 +0000507 /* EVIDENCE-OF: R-55269-29598 The localtime_r() C function normally only
508 ** works for years between 1970 and 2037. For dates outside this range,
509 ** SQLite attempts to map the year into an equivalent year within this
510 ** range, do the calculation, then map the year back.
511 */
drh7091cb02003-12-23 16:22:18 +0000512 x.Y = 2000;
513 x.M = 1;
514 x.D = 1;
515 x.h = 0;
516 x.m = 0;
517 x.s = 0.0;
518 } else {
shaneaef3af52008-12-09 04:59:00 +0000519 int s = (int)(x.s + 0.5);
drh7091cb02003-12-23 16:22:18 +0000520 x.s = s;
521 }
522 x.tz = 0;
523 x.validJD = 0;
524 computeJD(&x);
shane11bb41f2009-09-10 20:23:30 +0000525 t = (time_t)(x.iJD/1000 - 21086676*(i64)10000);
drh8720aeb2011-06-21 14:35:30 +0000526 if( osLocaltime(&t, &sLocal) ){
527 sqlite3_result_error(pCtx, "local time unavailable", -1);
528 *pRc = SQLITE_ERROR;
529 return 0;
drh87595762006-09-08 12:49:43 +0000530 }
drh8720aeb2011-06-21 14:35:30 +0000531 y.Y = sLocal.tm_year + 1900;
532 y.M = sLocal.tm_mon + 1;
533 y.D = sLocal.tm_mday;
534 y.h = sLocal.tm_hour;
535 y.m = sLocal.tm_min;
536 y.s = sLocal.tm_sec;
drh7091cb02003-12-23 16:22:18 +0000537 y.validYMD = 1;
538 y.validHMS = 1;
539 y.validJD = 0;
540 y.validTZ = 0;
541 computeJD(&y);
danc17d6962011-06-21 12:47:30 +0000542 *pRc = SQLITE_OK;
drh85f477a2008-06-12 16:35:38 +0000543 return y.iJD - x.iJD;
drh7091cb02003-12-23 16:22:18 +0000544}
drh66147c92008-06-12 12:51:37 +0000545#endif /* SQLITE_OMIT_LOCALTIME */
drh7091cb02003-12-23 16:22:18 +0000546
547/*
drh7014aff2003-11-01 01:53:53 +0000548** Process a modifier to a date-time stamp. The modifiers are
549** as follows:
550**
551** NNN days
552** NNN hours
553** NNN minutes
554** NNN.NNNN seconds
555** NNN months
556** NNN years
557** start of month
558** start of year
559** start of week
560** start of day
561** weekday N
562** unixepoch
drh7091cb02003-12-23 16:22:18 +0000563** localtime
564** utc
drh7014aff2003-11-01 01:53:53 +0000565**
danc17d6962011-06-21 12:47:30 +0000566** Return 0 on success and 1 if there is any kind of error. If the error
567** is in a system call (i.e. localtime()), then an error message is written
568** to context pCtx. If the error is an unrecognized modifier, no error is
569** written to pCtx.
drh7014aff2003-11-01 01:53:53 +0000570*/
danc17d6962011-06-21 12:47:30 +0000571static int parseModifier(sqlite3_context *pCtx, const char *zMod, DateTime *p){
drh7014aff2003-11-01 01:53:53 +0000572 int rc = 1;
573 int n;
574 double r;
drh4d5b8362004-01-17 01:16:21 +0000575 char *z, zBuf[30];
576 z = zBuf;
danielk197700e13612008-11-17 19:18:54 +0000577 for(n=0; n<ArraySize(zBuf)-1 && zMod[n]; n++){
drh1bd10f82008-12-10 21:19:56 +0000578 z[n] = (char)sqlite3UpperToLower[(u8)zMod[n]];
drh7014aff2003-11-01 01:53:53 +0000579 }
580 z[n] = 0;
581 switch( z[0] ){
drh66147c92008-06-12 12:51:37 +0000582#ifndef SQLITE_OMIT_LOCALTIME
drh7091cb02003-12-23 16:22:18 +0000583 case 'l': {
584 /* localtime
585 **
586 ** Assuming the current time value is UTC (a.k.a. GMT), shift it to
587 ** show local time.
588 */
589 if( strcmp(z, "localtime")==0 ){
590 computeJD(p);
danc17d6962011-06-21 12:47:30 +0000591 p->iJD += localtimeOffset(p, pCtx, &rc);
drhba212562004-01-08 02:17:31 +0000592 clearYMD_HMS_TZ(p);
drh7091cb02003-12-23 16:22:18 +0000593 }
594 break;
595 }
drh66147c92008-06-12 12:51:37 +0000596#endif
drh7014aff2003-11-01 01:53:53 +0000597 case 'u': {
598 /*
599 ** unixepoch
600 **
drh85f477a2008-06-12 16:35:38 +0000601 ** Treat the current value of p->iJD as the number of
drh7014aff2003-11-01 01:53:53 +0000602 ** seconds since 1970. Convert to a real julian day number.
603 */
604 if( strcmp(z, "unixepoch")==0 && p->validJD ){
drh7fee3602009-04-16 12:58:03 +0000605 p->iJD = (p->iJD + 43200)/86400 + 21086676*(i64)10000000;
drhba212562004-01-08 02:17:31 +0000606 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000607 rc = 0;
drh66cccd92008-07-25 16:39:24 +0000608 }
609#ifndef SQLITE_OMIT_LOCALTIME
610 else if( strcmp(z, "utc")==0 ){
drhcaeca512015-12-23 10:54:48 +0000611 if( p->tzSet==0 ){
612 sqlite3_int64 c1;
613 computeJD(p);
614 c1 = localtimeOffset(p, pCtx, &rc);
615 if( rc==SQLITE_OK ){
616 p->iJD -= c1;
617 clearYMD_HMS_TZ(p);
618 p->iJD += c1 - localtimeOffset(p, pCtx, &rc);
619 }
620 p->tzSet = 1;
621 }else{
622 rc = SQLITE_OK;
danc17d6962011-06-21 12:47:30 +0000623 }
drh7014aff2003-11-01 01:53:53 +0000624 }
drh66cccd92008-07-25 16:39:24 +0000625#endif
drh7014aff2003-11-01 01:53:53 +0000626 break;
627 }
628 case 'w': {
629 /*
630 ** weekday N
631 **
drh181fc992004-08-17 10:42:54 +0000632 ** Move the date to the same time on the next occurrence of
drh7014aff2003-11-01 01:53:53 +0000633 ** weekday N where 0==Sunday, 1==Monday, and so forth. If the
drhc5dd9fa2004-01-07 03:29:16 +0000634 ** date is already on the appropriate weekday, this is a no-op.
drh7014aff2003-11-01 01:53:53 +0000635 */
drh9339da12010-09-30 00:50:49 +0000636 if( strncmp(z, "weekday ", 8)==0
637 && sqlite3AtoF(&z[8], &r, sqlite3Strlen30(&z[8]), SQLITE_UTF8)
638 && (n=(int)r)==r && n>=0 && r<7 ){
drh85f477a2008-06-12 16:35:38 +0000639 sqlite3_int64 Z;
drhba212562004-01-08 02:17:31 +0000640 computeYMD_HMS(p);
drh7014aff2003-11-01 01:53:53 +0000641 p->validTZ = 0;
642 p->validJD = 0;
643 computeJD(p);
drh85f477a2008-06-12 16:35:38 +0000644 Z = ((p->iJD + 129600000)/86400000) % 7;
drh7014aff2003-11-01 01:53:53 +0000645 if( Z>n ) Z -= 7;
drh85f477a2008-06-12 16:35:38 +0000646 p->iJD += (n - Z)*86400000;
drhba212562004-01-08 02:17:31 +0000647 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000648 rc = 0;
649 }
650 break;
651 }
652 case 's': {
653 /*
654 ** start of TTTTT
655 **
656 ** Move the date backwards to the beginning of the current day,
657 ** or month or year.
658 */
659 if( strncmp(z, "start of ", 9)!=0 ) break;
drh4d5b8362004-01-17 01:16:21 +0000660 z += 9;
drh7014aff2003-11-01 01:53:53 +0000661 computeYMD(p);
662 p->validHMS = 1;
663 p->h = p->m = 0;
664 p->s = 0.0;
665 p->validTZ = 0;
666 p->validJD = 0;
drh4d5b8362004-01-17 01:16:21 +0000667 if( strcmp(z,"month")==0 ){
drh7014aff2003-11-01 01:53:53 +0000668 p->D = 1;
669 rc = 0;
drh4d5b8362004-01-17 01:16:21 +0000670 }else if( strcmp(z,"year")==0 ){
drh7014aff2003-11-01 01:53:53 +0000671 computeYMD(p);
672 p->M = 1;
673 p->D = 1;
674 rc = 0;
drh4d5b8362004-01-17 01:16:21 +0000675 }else if( strcmp(z,"day")==0 ){
drh7014aff2003-11-01 01:53:53 +0000676 rc = 0;
677 }
678 break;
679 }
680 case '+':
681 case '-':
682 case '0':
683 case '1':
684 case '2':
685 case '3':
686 case '4':
687 case '5':
688 case '6':
689 case '7':
690 case '8':
691 case '9': {
drhc531a222009-01-30 17:27:44 +0000692 double rRounder;
drh9339da12010-09-30 00:50:49 +0000693 for(n=1; z[n] && z[n]!=':' && !sqlite3Isspace(z[n]); n++){}
694 if( !sqlite3AtoF(z, &r, n, SQLITE_UTF8) ){
695 rc = 1;
696 break;
697 }
drh33a9ad22004-02-29 00:40:32 +0000698 if( z[n]==':' ){
699 /* A modifier of the form (+|-)HH:MM:SS.FFF adds (or subtracts) the
700 ** specified number of hours, minutes, seconds, and fractional seconds
701 ** to the time. The ".FFF" may be omitted. The ":SS.FFF" may be
702 ** omitted.
703 */
704 const char *z2 = z;
705 DateTime tx;
drh85f477a2008-06-12 16:35:38 +0000706 sqlite3_int64 day;
danielk197778ca0e72009-01-20 16:53:39 +0000707 if( !sqlite3Isdigit(*z2) ) z2++;
drh33a9ad22004-02-29 00:40:32 +0000708 memset(&tx, 0, sizeof(tx));
709 if( parseHhMmSs(z2, &tx) ) break;
710 computeJD(&tx);
drh85f477a2008-06-12 16:35:38 +0000711 tx.iJD -= 43200000;
712 day = tx.iJD/86400000;
713 tx.iJD -= day*86400000;
714 if( z[0]=='-' ) tx.iJD = -tx.iJD;
drh0d131ab2004-02-29 01:08:17 +0000715 computeJD(p);
716 clearYMD_HMS_TZ(p);
drh85f477a2008-06-12 16:35:38 +0000717 p->iJD += tx.iJD;
drh33a9ad22004-02-29 00:40:32 +0000718 rc = 0;
719 break;
720 }
drh4d5b8362004-01-17 01:16:21 +0000721 z += n;
danielk197778ca0e72009-01-20 16:53:39 +0000722 while( sqlite3Isspace(*z) ) z++;
drhea678832008-12-10 19:26:22 +0000723 n = sqlite3Strlen30(z);
drh7014aff2003-11-01 01:53:53 +0000724 if( n>10 || n<3 ) break;
drh7014aff2003-11-01 01:53:53 +0000725 if( z[n-1]=='s' ){ z[n-1] = 0; n--; }
726 computeJD(p);
727 rc = 0;
drhc531a222009-01-30 17:27:44 +0000728 rRounder = r<0 ? -0.5 : +0.5;
drh7014aff2003-11-01 01:53:53 +0000729 if( n==3 && strcmp(z,"day")==0 ){
drhc531a222009-01-30 17:27:44 +0000730 p->iJD += (sqlite3_int64)(r*86400000.0 + rRounder);
drh7014aff2003-11-01 01:53:53 +0000731 }else if( n==4 && strcmp(z,"hour")==0 ){
drhc531a222009-01-30 17:27:44 +0000732 p->iJD += (sqlite3_int64)(r*(86400000.0/24.0) + rRounder);
drh7014aff2003-11-01 01:53:53 +0000733 }else if( n==6 && strcmp(z,"minute")==0 ){
drhc531a222009-01-30 17:27:44 +0000734 p->iJD += (sqlite3_int64)(r*(86400000.0/(24.0*60.0)) + rRounder);
drh7014aff2003-11-01 01:53:53 +0000735 }else if( n==6 && strcmp(z,"second")==0 ){
drhc531a222009-01-30 17:27:44 +0000736 p->iJD += (sqlite3_int64)(r*(86400000.0/(24.0*60.0*60.0)) + rRounder);
drh7014aff2003-11-01 01:53:53 +0000737 }else if( n==5 && strcmp(z,"month")==0 ){
738 int x, y;
drhba212562004-01-08 02:17:31 +0000739 computeYMD_HMS(p);
shaneaef3af52008-12-09 04:59:00 +0000740 p->M += (int)r;
drh7014aff2003-11-01 01:53:53 +0000741 x = p->M>0 ? (p->M-1)/12 : (p->M-12)/12;
742 p->Y += x;
743 p->M -= x*12;
744 p->validJD = 0;
745 computeJD(p);
shaneaef3af52008-12-09 04:59:00 +0000746 y = (int)r;
drh7014aff2003-11-01 01:53:53 +0000747 if( y!=r ){
drhc531a222009-01-30 17:27:44 +0000748 p->iJD += (sqlite3_int64)((r - y)*30.0*86400000.0 + rRounder);
drh7014aff2003-11-01 01:53:53 +0000749 }
750 }else if( n==4 && strcmp(z,"year")==0 ){
drhc531a222009-01-30 17:27:44 +0000751 int y = (int)r;
drhba212562004-01-08 02:17:31 +0000752 computeYMD_HMS(p);
drhc531a222009-01-30 17:27:44 +0000753 p->Y += y;
drh7014aff2003-11-01 01:53:53 +0000754 p->validJD = 0;
755 computeJD(p);
drhc531a222009-01-30 17:27:44 +0000756 if( y!=r ){
757 p->iJD += (sqlite3_int64)((r - y)*365.0*86400000.0 + rRounder);
758 }
drh7014aff2003-11-01 01:53:53 +0000759 }else{
760 rc = 1;
761 }
drhba212562004-01-08 02:17:31 +0000762 clearYMD_HMS_TZ(p);
drh7014aff2003-11-01 01:53:53 +0000763 break;
764 }
765 default: {
766 break;
767 }
768 }
769 return rc;
770}
771
772/*
773** Process time function arguments. argv[0] is a date-time stamp.
774** argv[1] and following are modifiers. Parse them all and write
775** the resulting time into the DateTime structure p. Return 0
776** on success and 1 if there are any errors.
drh008e4762008-01-17 22:27:53 +0000777**
778** If there are zero parameters (if even argv[0] is undefined)
779** then assume a default value of "now" for argv[0].
drh7014aff2003-11-01 01:53:53 +0000780*/
danielk1977fee2d252007-08-18 10:59:19 +0000781static int isDate(
782 sqlite3_context *context,
783 int argc,
784 sqlite3_value **argv,
785 DateTime *p
786){
drh7014aff2003-11-01 01:53:53 +0000787 int i;
drh7a521cf2007-04-25 18:23:52 +0000788 const unsigned char *z;
drh85f477a2008-06-12 16:35:38 +0000789 int eType;
drh3af5d682008-06-12 13:50:00 +0000790 memset(p, 0, sizeof(*p));
drh008e4762008-01-17 22:27:53 +0000791 if( argc==0 ){
drh31702252011-10-12 23:13:43 +0000792 return setDateTimeToCurrent(context, p);
793 }
794 if( (eType = sqlite3_value_type(argv[0]))==SQLITE_FLOAT
drh85f477a2008-06-12 16:35:38 +0000795 || eType==SQLITE_INTEGER ){
shaneaef3af52008-12-09 04:59:00 +0000796 p->iJD = (sqlite3_int64)(sqlite3_value_double(argv[0])*86400000.0 + 0.5);
drh3af5d682008-06-12 13:50:00 +0000797 p->validJD = 1;
drh008e4762008-01-17 22:27:53 +0000798 }else{
799 z = sqlite3_value_text(argv[0]);
drh3af5d682008-06-12 13:50:00 +0000800 if( !z || parseDateOrTime(context, (char*)z, p) ){
801 return 1;
802 }
drh7a521cf2007-04-25 18:23:52 +0000803 }
drh7014aff2003-11-01 01:53:53 +0000804 for(i=1; i<argc; i++){
danc17d6962011-06-21 12:47:30 +0000805 z = sqlite3_value_text(argv[i]);
806 if( z==0 || parseModifier(context, (char*)z, p) ) return 1;
drh7014aff2003-11-01 01:53:53 +0000807 }
808 return 0;
809}
810
811
812/*
813** The following routines implement the various date and time functions
814** of SQLite.
815*/
816
817/*
818** julianday( TIMESTRING, MOD, MOD, ...)
819**
820** Return the julian day number of the date specified in the arguments
821*/
drhf9b596e2004-05-26 16:54:42 +0000822static void juliandayFunc(
823 sqlite3_context *context,
824 int argc,
825 sqlite3_value **argv
826){
drh7014aff2003-11-01 01:53:53 +0000827 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000828 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000829 computeJD(&x);
drh85f477a2008-06-12 16:35:38 +0000830 sqlite3_result_double(context, x.iJD/86400000.0);
drh7014aff2003-11-01 01:53:53 +0000831 }
832}
833
834/*
835** datetime( TIMESTRING, MOD, MOD, ...)
836**
837** Return YYYY-MM-DD HH:MM:SS
838*/
drhf9b596e2004-05-26 16:54:42 +0000839static void datetimeFunc(
840 sqlite3_context *context,
841 int argc,
842 sqlite3_value **argv
843){
drh7014aff2003-11-01 01:53:53 +0000844 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000845 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000846 char zBuf[100];
drhba212562004-01-08 02:17:31 +0000847 computeYMD_HMS(&x);
drh5bb3eb92007-05-04 13:15:55 +0000848 sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d %02d:%02d:%02d",
849 x.Y, x.M, x.D, x.h, x.m, (int)(x.s));
danielk1977d8123362004-06-12 09:25:12 +0000850 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +0000851 }
852}
853
854/*
855** time( TIMESTRING, MOD, MOD, ...)
856**
857** Return HH:MM:SS
858*/
drhf9b596e2004-05-26 16:54:42 +0000859static void timeFunc(
860 sqlite3_context *context,
861 int argc,
862 sqlite3_value **argv
863){
drh7014aff2003-11-01 01:53:53 +0000864 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000865 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000866 char zBuf[100];
867 computeHMS(&x);
drh5bb3eb92007-05-04 13:15:55 +0000868 sqlite3_snprintf(sizeof(zBuf), zBuf, "%02d:%02d:%02d", x.h, x.m, (int)x.s);
danielk1977d8123362004-06-12 09:25:12 +0000869 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +0000870 }
871}
872
873/*
874** date( TIMESTRING, MOD, MOD, ...)
875**
876** Return YYYY-MM-DD
877*/
drhf9b596e2004-05-26 16:54:42 +0000878static void dateFunc(
879 sqlite3_context *context,
880 int argc,
881 sqlite3_value **argv
882){
drh7014aff2003-11-01 01:53:53 +0000883 DateTime x;
danielk1977fee2d252007-08-18 10:59:19 +0000884 if( isDate(context, argc, argv, &x)==0 ){
drh7014aff2003-11-01 01:53:53 +0000885 char zBuf[100];
886 computeYMD(&x);
drh5bb3eb92007-05-04 13:15:55 +0000887 sqlite3_snprintf(sizeof(zBuf), zBuf, "%04d-%02d-%02d", x.Y, x.M, x.D);
danielk1977d8123362004-06-12 09:25:12 +0000888 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
drh7014aff2003-11-01 01:53:53 +0000889 }
890}
891
892/*
893** strftime( FORMAT, TIMESTRING, MOD, MOD, ...)
894**
895** Return a string described by FORMAT. Conversions as follows:
896**
897** %d day of month
898** %f ** fractional seconds SS.SSS
899** %H hour 00-24
900** %j day of year 000-366
drh86a11b82014-11-07 13:24:29 +0000901** %J ** julian day number
drh7014aff2003-11-01 01:53:53 +0000902** %m month 01-12
903** %M minute 00-59
904** %s seconds since 1970-01-01
905** %S seconds 00-59
906** %w day of week 0-6 sunday==0
907** %W week of year 00-53
908** %Y year 0000-9999
909** %% %
910*/
drhf9b596e2004-05-26 16:54:42 +0000911static void strftimeFunc(
912 sqlite3_context *context,
913 int argc,
914 sqlite3_value **argv
915){
drh7014aff2003-11-01 01:53:53 +0000916 DateTime x;
drha0206bc2007-05-08 15:15:02 +0000917 u64 n;
shaneaef3af52008-12-09 04:59:00 +0000918 size_t i,j;
drh7014aff2003-11-01 01:53:53 +0000919 char *z;
drh633e6d52008-07-28 19:34:53 +0000920 sqlite3 *db;
drh655814d2015-01-09 01:27:29 +0000921 const char *zFmt;
drh7014aff2003-11-01 01:53:53 +0000922 char zBuf[100];
drh655814d2015-01-09 01:27:29 +0000923 if( argc==0 ) return;
924 zFmt = (const char*)sqlite3_value_text(argv[0]);
danielk1977fee2d252007-08-18 10:59:19 +0000925 if( zFmt==0 || isDate(context, argc-1, argv+1, &x) ) return;
drh633e6d52008-07-28 19:34:53 +0000926 db = sqlite3_context_db_handle(context);
drh7014aff2003-11-01 01:53:53 +0000927 for(i=0, n=1; zFmt[i]; i++, n++){
928 if( zFmt[i]=='%' ){
929 switch( zFmt[i+1] ){
930 case 'd':
931 case 'H':
932 case 'm':
933 case 'M':
934 case 'S':
935 case 'W':
936 n++;
937 /* fall thru */
938 case 'w':
939 case '%':
940 break;
941 case 'f':
942 n += 8;
943 break;
944 case 'j':
945 n += 3;
946 break;
947 case 'Y':
948 n += 8;
949 break;
950 case 's':
951 case 'J':
952 n += 50;
953 break;
954 default:
955 return; /* ERROR. return a NULL */
956 }
957 i++;
958 }
959 }
drh67110022009-01-28 02:55:28 +0000960 testcase( n==sizeof(zBuf)-1 );
961 testcase( n==sizeof(zBuf) );
962 testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH]+1 );
963 testcase( n==(u64)db->aLimit[SQLITE_LIMIT_LENGTH] );
drh7014aff2003-11-01 01:53:53 +0000964 if( n<sizeof(zBuf) ){
965 z = zBuf;
danielk197700e13612008-11-17 19:18:54 +0000966 }else if( n>(u64)db->aLimit[SQLITE_LIMIT_LENGTH] ){
drha0206bc2007-05-08 15:15:02 +0000967 sqlite3_result_error_toobig(context);
968 return;
drh7014aff2003-11-01 01:53:53 +0000969 }else{
drh575fad62016-02-05 13:38:36 +0000970 z = sqlite3DbMallocRawNN(db, (int)n);
drh3334e942008-01-17 20:26:46 +0000971 if( z==0 ){
972 sqlite3_result_error_nomem(context);
973 return;
974 }
drh7014aff2003-11-01 01:53:53 +0000975 }
976 computeJD(&x);
drhba212562004-01-08 02:17:31 +0000977 computeYMD_HMS(&x);
drh7014aff2003-11-01 01:53:53 +0000978 for(i=j=0; zFmt[i]; i++){
979 if( zFmt[i]!='%' ){
980 z[j++] = zFmt[i];
981 }else{
982 i++;
983 switch( zFmt[i] ){
drh5bb3eb92007-05-04 13:15:55 +0000984 case 'd': sqlite3_snprintf(3, &z[j],"%02d",x.D); j+=2; break;
drh7014aff2003-11-01 01:53:53 +0000985 case 'f': {
drhb1f1e6e2006-09-25 18:01:31 +0000986 double s = x.s;
987 if( s>59.999 ) s = 59.999;
drh2ecad3b2007-03-29 17:57:21 +0000988 sqlite3_snprintf(7, &z[j],"%06.3f", s);
drhea678832008-12-10 19:26:22 +0000989 j += sqlite3Strlen30(&z[j]);
drh7014aff2003-11-01 01:53:53 +0000990 break;
991 }
drh5bb3eb92007-05-04 13:15:55 +0000992 case 'H': sqlite3_snprintf(3, &z[j],"%02d",x.h); j+=2; break;
drh7014aff2003-11-01 01:53:53 +0000993 case 'W': /* Fall thru */
994 case 'j': {
danielk1977f0113002006-01-24 12:09:17 +0000995 int nDay; /* Number of days since 1st day of year */
drh7014aff2003-11-01 01:53:53 +0000996 DateTime y = x;
997 y.validJD = 0;
998 y.M = 1;
999 y.D = 1;
1000 computeJD(&y);
shaneaef3af52008-12-09 04:59:00 +00001001 nDay = (int)((x.iJD-y.iJD+43200000)/86400000);
drh7014aff2003-11-01 01:53:53 +00001002 if( zFmt[i]=='W' ){
drh1020d492004-07-18 22:22:43 +00001003 int wd; /* 0=Monday, 1=Tuesday, ... 6=Sunday */
shaneaef3af52008-12-09 04:59:00 +00001004 wd = (int)(((x.iJD+43200000)/86400000)%7);
drh5bb3eb92007-05-04 13:15:55 +00001005 sqlite3_snprintf(3, &z[j],"%02d",(nDay+7-wd)/7);
drh7014aff2003-11-01 01:53:53 +00001006 j += 2;
1007 }else{
drh5bb3eb92007-05-04 13:15:55 +00001008 sqlite3_snprintf(4, &z[j],"%03d",nDay+1);
drh7014aff2003-11-01 01:53:53 +00001009 j += 3;
1010 }
1011 break;
1012 }
drh5bb3eb92007-05-04 13:15:55 +00001013 case 'J': {
drh85f477a2008-06-12 16:35:38 +00001014 sqlite3_snprintf(20, &z[j],"%.16g",x.iJD/86400000.0);
drhea678832008-12-10 19:26:22 +00001015 j+=sqlite3Strlen30(&z[j]);
drh5bb3eb92007-05-04 13:15:55 +00001016 break;
1017 }
1018 case 'm': sqlite3_snprintf(3, &z[j],"%02d",x.M); j+=2; break;
1019 case 'M': sqlite3_snprintf(3, &z[j],"%02d",x.m); j+=2; break;
drh7014aff2003-11-01 01:53:53 +00001020 case 's': {
drh6eb41522009-04-01 20:44:13 +00001021 sqlite3_snprintf(30,&z[j],"%lld",
drh07758962009-04-03 12:04:36 +00001022 (i64)(x.iJD/1000 - 21086676*(i64)10000));
drhea678832008-12-10 19:26:22 +00001023 j += sqlite3Strlen30(&z[j]);
drh7014aff2003-11-01 01:53:53 +00001024 break;
1025 }
drh5bb3eb92007-05-04 13:15:55 +00001026 case 'S': sqlite3_snprintf(3,&z[j],"%02d",(int)x.s); j+=2; break;
drhea678832008-12-10 19:26:22 +00001027 case 'w': {
1028 z[j++] = (char)(((x.iJD+129600000)/86400000) % 7) + '0';
1029 break;
1030 }
1031 case 'Y': {
1032 sqlite3_snprintf(5,&z[j],"%04d",x.Y); j+=sqlite3Strlen30(&z[j]);
1033 break;
1034 }
drh008e4762008-01-17 22:27:53 +00001035 default: z[j++] = '%'; break;
drh7014aff2003-11-01 01:53:53 +00001036 }
1037 }
1038 }
1039 z[j] = 0;
drh3334e942008-01-17 20:26:46 +00001040 sqlite3_result_text(context, z, -1,
drh633e6d52008-07-28 19:34:53 +00001041 z==zBuf ? SQLITE_TRANSIENT : SQLITE_DYNAMIC);
drh7014aff2003-11-01 01:53:53 +00001042}
1043
danielk19777977a172004-11-09 12:44:37 +00001044/*
1045** current_time()
1046**
1047** This function returns the same value as time('now').
1048*/
1049static void ctimeFunc(
1050 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001051 int NotUsed,
1052 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001053){
danielk197762c14b32008-11-19 09:05:26 +00001054 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001055 timeFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001056}
drh7014aff2003-11-01 01:53:53 +00001057
danielk19777977a172004-11-09 12:44:37 +00001058/*
1059** current_date()
1060**
1061** This function returns the same value as date('now').
1062*/
1063static void cdateFunc(
1064 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001065 int NotUsed,
1066 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001067){
danielk197762c14b32008-11-19 09:05:26 +00001068 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001069 dateFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001070}
1071
1072/*
1073** current_timestamp()
1074**
1075** This function returns the same value as datetime('now').
1076*/
1077static void ctimestampFunc(
1078 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +00001079 int NotUsed,
1080 sqlite3_value **NotUsed2
danielk19777977a172004-11-09 12:44:37 +00001081){
danielk197762c14b32008-11-19 09:05:26 +00001082 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh008e4762008-01-17 22:27:53 +00001083 datetimeFunc(context, 0, 0);
danielk19777977a172004-11-09 12:44:37 +00001084}
drh7014aff2003-11-01 01:53:53 +00001085#endif /* !defined(SQLITE_OMIT_DATETIME_FUNCS) */
1086
danielk1977752e6792004-11-09 16:13:33 +00001087#ifdef SQLITE_OMIT_DATETIME_FUNCS
1088/*
1089** If the library is compiled to omit the full-scale date and time
1090** handling (to get a smaller binary), the following minimal version
1091** of the functions current_time(), current_date() and current_timestamp()
1092** are included instead. This is to support column declarations that
1093** include "DEFAULT CURRENT_TIME" etc.
1094**
danielk19772df9fab2004-11-11 01:50:30 +00001095** This function uses the C-library functions time(), gmtime()
danielk1977752e6792004-11-09 16:13:33 +00001096** and strftime(). The format string to pass to strftime() is supplied
1097** as the user-data for the function.
1098*/
danielk1977752e6792004-11-09 16:13:33 +00001099static void currentTimeFunc(
1100 sqlite3_context *context,
1101 int argc,
1102 sqlite3_value **argv
1103){
1104 time_t t;
1105 char *zFormat = (char *)sqlite3_user_data(context);
drhfa4a4b92008-03-19 21:45:51 +00001106 sqlite3 *db;
drhb7e8ea22010-05-03 14:32:30 +00001107 sqlite3_int64 iT;
drh31702252011-10-12 23:13:43 +00001108 struct tm *pTm;
1109 struct tm sNow;
danielk1977752e6792004-11-09 16:13:33 +00001110 char zBuf[20];
danielk1977752e6792004-11-09 16:13:33 +00001111
shanefbd60f82009-02-04 03:59:25 +00001112 UNUSED_PARAMETER(argc);
1113 UNUSED_PARAMETER(argv);
1114
drh95a7b3e2013-09-16 12:57:19 +00001115 iT = sqlite3StmtCurrentTime(context);
1116 if( iT<=0 ) return;
drhd5e6e402010-05-03 19:17:01 +00001117 t = iT/1000 - 10000*(sqlite3_int64)21086676;
drh0ede9eb2015-01-10 16:49:23 +00001118#if HAVE_GMTIME_R
drh31702252011-10-12 23:13:43 +00001119 pTm = gmtime_r(&t, &sNow);
drh87595762006-09-08 12:49:43 +00001120#else
drh31702252011-10-12 23:13:43 +00001121 sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
1122 pTm = gmtime(&t);
1123 if( pTm ) memcpy(&sNow, pTm, sizeof(sNow));
1124 sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
drh87595762006-09-08 12:49:43 +00001125#endif
drh31702252011-10-12 23:13:43 +00001126 if( pTm ){
1127 strftime(zBuf, 20, zFormat, &sNow);
1128 sqlite3_result_text(context, zBuf, -1, SQLITE_TRANSIENT);
1129 }
danielk1977752e6792004-11-09 16:13:33 +00001130}
1131#endif
1132
drh7014aff2003-11-01 01:53:53 +00001133/*
1134** This function registered all of the above C functions as SQL
1135** functions. This should be the only routine in this file with
1136** external linkage.
1137*/
drh777c5382008-08-21 20:21:34 +00001138void sqlite3RegisterDateTimeFunctions(void){
drh80738d92016-02-15 00:34:16 +00001139 static FuncDef aDateTimeFuncs[] = {
drhfd1f3942004-07-20 00:39:14 +00001140#ifndef SQLITE_OMIT_DATETIME_FUNCS
drh1d85e402015-08-31 17:34:41 +00001141 DFUNCTION(julianday, -1, 0, 0, juliandayFunc ),
1142 DFUNCTION(date, -1, 0, 0, dateFunc ),
1143 DFUNCTION(time, -1, 0, 0, timeFunc ),
1144 DFUNCTION(datetime, -1, 0, 0, datetimeFunc ),
1145 DFUNCTION(strftime, -1, 0, 0, strftimeFunc ),
1146 DFUNCTION(current_time, 0, 0, 0, ctimeFunc ),
1147 DFUNCTION(current_timestamp, 0, 0, 0, ctimestampFunc),
1148 DFUNCTION(current_date, 0, 0, 0, cdateFunc ),
danielk1977752e6792004-11-09 16:13:33 +00001149#else
drh21717ed2008-10-13 15:35:08 +00001150 STR_FUNCTION(current_time, 0, "%H:%M:%S", 0, currentTimeFunc),
drh2b1e6902010-01-12 19:28:20 +00001151 STR_FUNCTION(current_date, 0, "%Y-%m-%d", 0, currentTimeFunc),
1152 STR_FUNCTION(current_timestamp, 0, "%Y-%m-%d %H:%M:%S", 0, currentTimeFunc),
drh777c5382008-08-21 20:21:34 +00001153#endif
danielk1977752e6792004-11-09 16:13:33 +00001154 };
drh80738d92016-02-15 00:34:16 +00001155 sqlite3InsertBuiltinFuncs(aDateTimeFuncs, ArraySize(aDateTimeFuncs));
drh7014aff2003-11-01 01:53:53 +00001156}