Return an error if localtime_r() fails within one of the date/time functions. Fix for [bd484a090c].

FossilOrigin-Name: 76ae8257efc1df6e20ce5718d4824adbbde423ec

manifest

@@ -1,5 +1,5 @@
-C Add\sa\snew\sAWK\sscript\sin\sthe\stool/\sfolder\sfor\sconverting\stext\sfiles\sinto\nC\sstring\sliterals.\s\sUse\sit\sfor\sbuilding\ssqlite3_analyzer.
+C Return\san\serror\sif\slocaltime_r()\sfails\swithin\sone\sof\sthe\sdate/time\sfunctions.\sFix\sfor\s[bd484a090c].
-D 2011-06-21T03:36:06.406
+D 2011-06-21T12:47:30.109
 F Makefile.arm-wince-mingw32ce-gcc d6df77f1f48d690bd73162294bbba7f59507c72f
 F Makefile.in c1d7a7f4fd8da6b1815032efca950e3d5125407e
 F Makefile.linux-gcc 91d710bdc4998cb015f39edf3cb314ec4f4d7e23
@@ -131,7 +131,7 @@ F src/build.c 5a428625d21ad409514afb40ad083bee25dd957a
 F src/callback.c 0425c6320730e6d3981acfb9202c1bed9016ad1a
 F src/complete.c dc1d136c0feee03c2f7550bafc0d29075e36deac
 F src/ctime.c 7deec4534f3b5a0c3b4a4cbadf809d321f64f9c4
-F src/date.c 1548fdac51377e4e7833251de878b4058c148e1b
+F src/date.c 1b23db78863495e7ef2f670f6929de43e025d32c
 F src/delete.c cecc926c70783452f3e8eb452c728291ce1a0b21
 F src/expr.c ab46ab0f0c44979a8164ca31728d7d10ae5e8106
 F src/fault.c 160a0c015b6c2629d3899ed2daf63d75754a32bb
@@ -146,7 +146,7 @@ F src/journal.c 552839e54d1bf76fb8f7abe51868b66acacf6a0e
 F src/legacy.c a199d7683d60cef73089e892409113e69c23a99f
 F src/lempar.c 7f026423f4d71d989e719a743f98a1cbd4e6d99e
 F src/loadext.c 3ae0d52da013a6326310655be6473fd472347b85
-F src/main.c d67ea48933e4d63abba00578224a3319e6fbcbe1
+F src/main.c fa654e1802e14a5f6c09c37971c3b69c1001d9c8
 F src/malloc.c 591aedb20ae40813f1045f2ef253438a334775d9
 F src/mem0.c 6a55ebe57c46ca1a7d98da93aaa07f99f1059645
 F src/mem1.c 00bd8265c81abb665c48fea1e0c234eb3b922206
@@ -181,14 +181,14 @@ F src/resolve.c 1c0f32b64f8e3f555fe1f732f9d6f501a7f05706
 F src/rowset.c 69afa95a97c524ba6faf3805e717b5b7ae85a697
 F src/select.c d9d440809025a58547e39f4f268c2a296bfb56ff
 F src/shell.c 0e0173b3e79d956368013e759f084caa7995ecb1
-F src/sqlite.h.in a4d0baabe4f86b3ab9cf56eda23dfd9d022ece0a
+F src/sqlite.h.in 4b7255c10d39c5faf089dbd29cde7c367ff39f1f
 F src/sqlite3ext.h c90bd5507099f62043832d73f6425d8d5c5da754
-F src/sqliteInt.h 7b7ec2394b94fc4516930cd9dae37af0f9312215
+F src/sqliteInt.h a9248d3b0d2b1cf428d8642320fb13044a8888e0
 F src/sqliteLimit.h 164b0e6749d31e0daa1a4589a169d31c0dec7b3d
 F src/status.c 7ac64842c86cec2fc1a1d0e5c16d3beb8ad332bf
 F src/table.c 2cd62736f845d82200acfa1287e33feb3c15d62e
 F src/tclsqlite.c 5db825be61708b1a2b3f8f6e185e9b753829acef
-F src/test1.c efca486a25fb894988e7a82e84579a4e57388a02
+F src/test1.c ce2fab9e36932f5771c35291539366c9af229df3
 F src/test2.c 80d323d11e909cf0eb1b6fbb4ac22276483bcf31
 F src/test3.c 124ff9735fb6bb7d41de180d6bac90e7b1509432
 F src/test4.c d1e5a5e904d4b444cf572391fdcb017638e36ff7
@@ -729,6 +729,7 @@ F test/tkt-94c04eaadb.test be5ea61cb04dfdc047d19b5c5a9e75fa3da67a7f
 F test/tkt-9d68c883.test 458f7d82a523d7644b54b497c986378a7d8c8b67
 F test/tkt-b351d95f9.test d14a503c414c5c58fdde3e80f9a3cfef986498c0
 F test/tkt-b72787b1.test e6b62b2b2785c04d0d698d6a603507e384165049
+F test/tkt-bd484a090c.test 6db2d385ad47004e091bdda0d7da083365bb10ec
 F test/tkt-cbd054fa6b.test f14f97ea43662e6f70c9e63287081e8be5d9d589
 F test/tkt-d11f09d36e.test fb44f7961aa6d4b632fb7b9768239832210b5fc7
 F test/tkt-d82e3f3721.test 731359dfdcdb36fea0559cd33fec39dd0ceae8e6
@@ -947,7 +948,7 @@ F tool/symbols.sh bc2a3709940d47c8ac8e0a1fdf17ec801f015a00
 F tool/tostr.awk 11760e1b94a5d3dcd42378f3cc18544c06cfa576
 F tool/vdbe-compress.tcl d70ea6d8a19e3571d7ab8c9b75cba86d1173ff0f
 F tool/warnings.sh 347d974d143cf132f953b565fbc03026f19fcb4d
-P e60eefc76fa5066720d76858f6cfca56365330ee
+P dcb46d3f68e219a84c67c7ffef26fd2076a0ba28
-R 6bcbb640ed0444c63b52a62d6c605768
+R 39f3065d8d058f3e7825e8ebdae8b8f0
-U drh
+U dan
-Z 23ac254af253dc4e456f23427954539d
+Z b8411c557308c2ef01e76215d689a36d

manifest.uuid

@@ -1 +1 @@
-dcb46d3f68e219a84c67c7ffef26fd2076a0ba28
+76ae8257efc1df6e20ce5718d4824adbbde423ec

src/date.c

@@ -412,12 +412,54 @@ static void clearYMD_HMS_TZ(DateTime *p){
 }
 
 #ifndef SQLITE_OMIT_LOCALTIME
+
 /*
-** Compute the difference (in milliseconds)
+** The following three functions - osLocaltime_r(), osLocaltime_s() and
-** between localtime and UTC (a.k.a. GMT)
+** osLocaltime() - are wrappers around system functions localtime_r(),
-** for the time value p where p is in UTC.
+** localtime_s() and localtime(), respectively.
+**
+** If the sqlite3GlobalConfig.bLocaltimeFault variable is true when one
+** of the following wrappers is called, it returns an error.
 */
-static sqlite3_int64 localtimeOffset(DateTime *p){
+#ifndef SQLITE_OMIT_BUILTIN_TEST
+
+#ifdef HAVE_LOCALTIME_R
+static struct tm * osLocaltime_r(time_t *t, struct tm *pTm){
+  if( sqlite3GlobalConfig.bLocaltimeFault ) return 0;
+  return localtime_r(t);
+}
+#elif defined(HAVE_LOCALTIME_S) && HAVE_LOCALTIME_S
+static int osLocaltime_s(time_t *t, struct tm *pTm){
+  if( sqlite3GlobalConfig.bLocaltimeFault ) return 1;
+  return (int)localtime_s(t, pTm);
+}
+#else
+static struct tm * osLocaltime(time_t *t){
+  if( sqlite3GlobalConfig.bLocaltimeFault ) return 0;
+  return localtime(t);
+}
+#endif
+
+#else
+# define osLocaltime_r(x,y) localtime_r(x,y)
+# define osLocaltime_s(x,y) localtime_s(x,y)
+# define osLocaltime(x)     localtime(x)
+#endif
+
+
+/*
+** Compute the difference (in milliseconds) between localtime and UTC
+** (a.k.a. GMT) for the time value p where p is in UTC. If no error occurs,
+** return this value and set *pRc to SQLITE_OK. 
+**
+** Or, if an error does occur, set *pRc to SQLITE_ERROR. The returned value
+** is undefined in this case.
+*/
+static sqlite3_int64 localtimeOffset(
+  DateTime *p,                    /* Date at which to calculate offset */
+  sqlite3_context *pCtx,          /* Write error here if one occurs */
+  int *pRc                        /* OUT: Error code. SQLITE_OK or ERROR */
+){
   DateTime x, y;
   time_t t;
   x = *p;
@@ -440,7 +482,11 @@ static sqlite3_int64 localtimeOffset(DateTime *p){
 #ifdef HAVE_LOCALTIME_R
   {
     struct tm sLocal;
-    localtime_r(&t, &sLocal);
+    if( 0==osLocaltime_r(&t, &sLocal) ){
+      sqlite3_result_error(pCtx, "error in localtime_r()", -1);
+      *pRc = SQLITE_ERROR;
+      return 0;
+    }
     y.Y = sLocal.tm_year + 1900;
     y.M = sLocal.tm_mon + 1;
     y.D = sLocal.tm_mday;
@@ -451,7 +497,11 @@ static sqlite3_int64 localtimeOffset(DateTime *p){
 #elif defined(HAVE_LOCALTIME_S) && HAVE_LOCALTIME_S
   {
     struct tm sLocal;
-    localtime_s(&sLocal, &t);
+    if( 0!=osLocaltime_s(&t, &sLocal) ){
+      sqlite3_result_error(pCtx, "error in localtime_s()", -1);
+      *pRc = SQLITE_ERROR;
+      return 0;
+    }
     y.Y = sLocal.tm_year + 1900;
     y.M = sLocal.tm_mon + 1;
     y.D = sLocal.tm_mday;
@@ -463,14 +513,21 @@ static sqlite3_int64 localtimeOffset(DateTime *p){
   {
     struct tm *pTm;
     sqlite3_mutex_enter(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
-    pTm = localtime(&t);
+    pTm = osLocaltime(&t);
-    y.Y = pTm->tm_year + 1900;
+    if( pTm ){
-    y.M = pTm->tm_mon + 1;
+      y.Y = pTm->tm_year + 1900;
-    y.D = pTm->tm_mday;
+      y.M = pTm->tm_mon + 1;
-    y.h = pTm->tm_hour;
+      y.D = pTm->tm_mday;
-    y.m = pTm->tm_min;
+      y.h = pTm->tm_hour;
-    y.s = pTm->tm_sec;
+      y.m = pTm->tm_min;
+      y.s = pTm->tm_sec;
+    }
     sqlite3_mutex_leave(sqlite3MutexAlloc(SQLITE_MUTEX_STATIC_MASTER));
+    if( !pTm ){
+      sqlite3_result_error(pCtx, "error in localtime()", -1);
+      *pRc = SQLITE_ERROR;
+      return 0;
+    }
   }
 #endif
   y.validYMD = 1;
@@ -478,6 +535,7 @@ static sqlite3_int64 localtimeOffset(DateTime *p){
   y.validJD = 0;
   y.validTZ = 0;
   computeJD(&y);
+  *pRc = SQLITE_OK;
   return y.iJD - x.iJD;
 }
 #endif /* SQLITE_OMIT_LOCALTIME */
@@ -501,9 +559,12 @@ static sqlite3_int64 localtimeOffset(DateTime *p){
 **     localtime
 **     utc
 **
-** Return 0 on success and 1 if there is any kind of error.
+** Return 0 on success and 1 if there is any kind of error. If the error
+** is in a system call (i.e. localtime()), then an error message is written
+** to context pCtx. If the error is an unrecognized modifier, no error is
+** written to pCtx.
 */
-static int parseModifier(const char *zMod, DateTime *p){
+static int parseModifier(sqlite3_context *pCtx, const char *zMod, DateTime *p){
   int rc = 1;
   int n;
   double r;
@@ -523,9 +584,8 @@ static int parseModifier(const char *zMod, DateTime *p){
       */
       if( strcmp(z, "localtime")==0 ){
         computeJD(p);
-        p->iJD += localtimeOffset(p);
+        p->iJD += localtimeOffset(p, pCtx, &rc);
         clearYMD_HMS_TZ(p);
-        rc = 0;
       }
       break;
     }
@@ -546,11 +606,12 @@ static int parseModifier(const char *zMod, DateTime *p){
       else if( strcmp(z, "utc")==0 ){
         sqlite3_int64 c1;
         computeJD(p);
-        c1 = localtimeOffset(p);
+        c1 = localtimeOffset(p, pCtx, &rc);
-        p->iJD -= c1;
+        if( rc==SQLITE_OK ){
-        clearYMD_HMS_TZ(p);
+          p->iJD -= c1;
-        p->iJD += c1 - localtimeOffset(p);
+          clearYMD_HMS_TZ(p);
-        rc = 0;
+          p->iJD += c1 - localtimeOffset(p, pCtx, &rc);
+        }
       }
 #endif
       break;
@@ -731,9 +792,8 @@ static int isDate(
     }
   }
   for(i=1; i<argc; i++){
-    if( (z = sqlite3_value_text(argv[i]))==0 || parseModifier((char*)z, p) ){
+    z = sqlite3_value_text(argv[i]);
-      return 1;
+    if( z==0 || parseModifier(context, (char*)z, p) ) return 1;
-    }
   }
   return 0;
 }

src/main.c

@@ -2903,6 +2903,17 @@ int sqlite3_test_control(int op, ...){
       break;
     }
 
+    /*   sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, int onoff);
+    **
+    ** If parameter onoff is non-zero, configure the wrappers so that all
+    ** subsequent calls to localtime() and variants fail. If onoff is zero,
+    ** undo this setting.
+    */
+    case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
+      sqlite3GlobalConfig.bLocaltimeFault = va_arg(ap, int);
+      break;
+    }
+
   }
   va_end(ap);
 #endif /* SQLITE_OMIT_BUILTIN_TEST */

src/sqlite.h.in

@@ -5573,7 +5573,8 @@ int sqlite3_test_control(int op, ...);
 #define SQLITE_TESTCTRL_ISKEYWORD               16
 #define SQLITE_TESTCTRL_PGHDRSZ                 17
 #define SQLITE_TESTCTRL_SCRATCHMALLOC           18
-#define SQLITE_TESTCTRL_LAST                    18
+#define SQLITE_TESTCTRL_LOCALTIME_FAULT         19
+#define SQLITE_TESTCTRL_LAST                    19
 
 /*
 ** CAPI3REF: SQLite Runtime Status

src/sqliteInt.h

@@ -2452,6 +2452,7 @@ struct Sqlite3Config {
   int nRefInitMutex;                /* Number of users of pInitMutex */
   void (*xLog)(void*,int,const char*); /* Function for logging */
   void *pLogArg;                       /* First argument to xLog() */
+  int bLocaltimeFault;              /* True to fail localtime() calls */
 };
 
 /*

src/test1.c

@@ -5522,6 +5522,54 @@ static int test_print_eqp(
 }
 #endif /* SQLITE_OMIT_EXPLAIN */
 
+/*
+** sqlite3_test_control VERB ARGS...
+*/
+static int test_test_control(
+  void * clientData,
+  Tcl_Interp *interp,
+  int objc,
+  Tcl_Obj *CONST objv[]
+){
+  struct Verb {
+    const char *zName;
+    int i;
+  } aVerb[] = {
+    { "SQLITE_TESTCTRL_LOCALTIME_FAULT", SQLITE_TESTCTRL_LOCALTIME_FAULT }, 
+  };
+  int iVerb;
+  int iFlag;
+  int rc;
+
+  if( objc<2 ){
+    Tcl_WrongNumArgs(interp, 1, objv, "VERB ARGS...");
+    return TCL_ERROR;
+  }
+
+  rc = Tcl_GetIndexFromObjStruct(
+      interp, objv[1], aVerb, sizeof(aVerb[0]), "VERB", 0, &iVerb
+  );
+  if( rc!=TCL_OK ) return rc;
+
+  iFlag = aVerb[iVerb].i;
+  switch( iFlag ){
+    case SQLITE_TESTCTRL_LOCALTIME_FAULT: {
+      int val;
+      if( objc!=3 ){
+        Tcl_WrongNumArgs(interp, 2, objv, "ONOFF");
+        return TCL_ERROR;
+      }
+      if( Tcl_GetBooleanFromObj(interp, objv[2], &val) ) return TCL_ERROR;
+      sqlite3_test_control(SQLITE_TESTCTRL_LOCALTIME_FAULT, val);
+      break;
+    }
+  }
+
+  Tcl_ResetResult(interp);
+  return TCL_OK;
+}
+
+
 /*
 **      optimization_control DB OPT BOOLEAN
 **
@@ -5785,6 +5833,7 @@ int Sqlitetest1_Init(Tcl_Interp *interp){
 #ifndef SQLITE_OMIT_EXPLAIN
      { "print_explain_query_plan", test_print_eqp, 0  },
 #endif
+     { "sqlite3_test_control", test_test_control },
   };
   static int bitmask_size = sizeof(Bitmask)*8;
   int i;

test/tkt-bd484a090c.test

@@ -0,0 +1,42 @@
+# 2011 June 21
+#
+#    May you do good and not evil.
+#    May you find forgiveness for yourself and forgive others.
+#    May you share freely, never taking more than you give.
+#
+#***********************************************************************
+#
+# This file contains tests for SQLite. Specifically, it tests that SQLite
+# does not crash and an error is returned if localhost() fails. This 
+# is the problem reported by ticket bd484a090c.
+#
+
+set testdir [file dirname $argv0]
+source $testdir/tester.tcl
+
+set testprefix tkt-bd484a090c
+
+
+do_test 1.1 {
+  lindex [catchsql { SELECT datetime('now', 'localtime') }] 0
+} {0}
+do_test 1.2 {
+  lindex [catchsql { SELECT datetime('now', 'utc') }] 0
+} {0}
+
+sqlite3_test_control SQLITE_TESTCTRL_LOCALTIME_FAULT 1
+
+do_test 2.1 {
+  foreach {rc msg} [catchsql { SELECT datetime('now', 'localtime') }] {}
+  set res [string match {error in localtime*()} $msg]
+  list $rc $res
+} {1 1}
+do_test 2.2 {
+  foreach {rc msg} [catchsql { SELECT datetime('now', 'utc') }] {}
+  set res [string match {error in localtime*()} $msg]
+  list $rc $res
+} {1 1}
+
+sqlite3_test_control SQLITE_TESTCTRL_LOCALTIME_FAULT 0
+
+finish_test