Add support for datetime fields

We add support for FoxPro datetime fields, which store an exact
timestamp in two binary dwords, representing the Julian day number and
the number of milliseconds since midnight, respectively. These are
represented in userland as strings with the format "YYYYMMDDhhmmss.uuu",
which conforms to ISO-8601.

According to the current handling of date fields, the validity of input
and output is not checked, i.e. it is possible to store invalid datetime
values in the database. If necessary, respective checks have to be made
by the programmer.

To avoid reinventing the wheel, but also not to rely on ext/calendar, we
add the respective functionality and adapt the names to avoid build
conflicts.

git-svn-id: http://svn.php.net/repository/pecl/dbase/trunk@340796 c90b9560-bf6c-de11-be94-00142212c4b1

Author: cmb69

config.m4

@@ -7,5 +7,5 @@ PHP_ARG_ENABLE(dbase,whether to enable dbase support,
 
 if test "$PHP_DBASE" = "yes"; then
   AC_DEFINE(DBASE,1,[ ])
-  PHP_NEW_EXTENSION(dbase, dbf_head.c dbf_rec.c dbf_misc.c dbf_ndx.c dbase.c, $ext_shared)
+  PHP_NEW_EXTENSION(dbase, dbf_head.c dbf_rec.c dbf_misc.c dbf_ndx.c dbase.c gregor.c, $ext_shared)
 fi

config.w32

@@ -4,7 +4,7 @@
 ARG_ENABLE("dbase", "Enable the bundled dbase library", "no");
 
 if (PHP_DBASE != "no") {
-	EXTENSION("dbase", "dbase.c dbf_head.c dbf_misc.c dbf_ndx.c dbf_rec.c");
+	EXTENSION("dbase", "dbase.c dbf_head.c dbf_misc.c dbf_ndx.c dbf_rec.c gregor.c");
 	AC_DEFINE('HAVE_DBASE', 1, 'dbase support');
 	ADD_FLAG("CFLAGS_DBASE", "/D DBASE=1");
 }

dbase.c

@@ -244,7 +244,20 @@ static void php_dbase_put_record(INTERNAL_FUNCTION_PARAMETERS, int replace)
 		}
 
 		convert_to_string(field);
-		snprintf(t_cp, cur_f->db_flen+1, cur_f->db_format, Z_STRVAL_P(field));
+
+		switch (cur_f->db_type) {
+			case 'T':
+				{
+					int jdn, msecs;
+
+					db_get_timestamp(Z_STRVAL_P(field), &jdn, &msecs);
+					put_long(t_cp, jdn);
+					put_long(t_cp + 4, msecs);
+				}
+				break;
+			default:
+				snprintf(t_cp, cur_f->db_flen+1, cur_f->db_format, Z_STRVAL_P(field));
+		}
 
 		t_cp += cur_f->db_flen;
 	}
@@ -355,7 +368,11 @@ static void php_dbase_get_record(INTERNAL_FUNCTION_PARAMETERS, int assoc)
 			cursize = cur_f->db_flen + 1;
 			fnp = erealloc(fnp, cursize);
 		}
-		snprintf(str_value, cursize, cur_f->db_format, get_field_val(data, cur_f, fnp));
+		if (*cur_f->db_format) {
+			snprintf(str_value, cursize, cur_f->db_format, get_field_val(data, cur_f, fnp));
+		} else {
+			memcpy(str_value, get_binary_field_val(data, cur_f, fnp), cur_f->db_flen);
+		}
 
 		/* now convert it to the right php internal type */
 		switch (cur_f->db_type) {
@@ -423,6 +440,18 @@ static void php_dbase_get_record(INTERNAL_FUNCTION_PARAMETERS, int assoc)
 			case 'M':
 				/* this is a memo field. don't know how to deal with this yet */
 				break;
+			case 'T':
+				{
+					char buf[19];
+
+					db_set_timestamp(buf, get_long(str_value), get_long(str_value + 4));
+					if (!assoc) {
+						add_next_index_string(return_value, buf);
+					} else {
+						add_assoc_string(return_value, cur_f->db_fname, buf);
+					}
+				}
+				break;
 			default:
 				/* should deal with this in some way */
 				break;
@@ -571,6 +600,7 @@ PHP_FUNCTION(dbase_create)
 			/* should create the memo file here, probably */
 			break;
 		case 'D':
+		case 'T':
 			cur_f->db_flen = 8;
 			break;
 		case 'F':
@@ -734,14 +764,15 @@ PHP_FUNCTION(dbase_get_header_info)
 
 		/* field type */
 		switch (cur_f->db_type) {
-			case 'C': add_assoc_string(&row, "type", "character");	break;
-			case 'D': add_assoc_string(&row, "type", "date"); 		break;
-			case 'I': add_assoc_string(&row, "type", "integer"); 		break;
-			case 'N': add_assoc_string(&row, "type", "number"); 		break;
-			case 'L': add_assoc_string(&row, "type", "boolean");		break;
-			case 'M': add_assoc_string(&row, "type", "memo");			break;
+			case 'C': add_assoc_string(&row, "type", "character"); break;
+			case 'D': add_assoc_string(&row, "type", "date");      break;
+			case 'T': add_assoc_string(&row, "type", "datetime");  break;
+			case 'I': add_assoc_string(&row, "type", "integer");   break;
+			case 'N': add_assoc_string(&row, "type", "number");    break;
+			case 'L': add_assoc_string(&row, "type", "boolean");   break;
+			case 'M': add_assoc_string(&row, "type", "memo");      break;
 			case 'F': add_assoc_string(&row, "type", "float");     break;
-			default:  add_assoc_string(&row, "type", "unknown");		break;
+			default:  add_assoc_string(&row, "type", "unknown");   break;
 		}
 
 		/* length of field */

dbf_head.c

@@ -165,6 +165,7 @@ int get_dbf_field(dbhead_t *dbh, dbfield_t *dbf)
 			dbf->db_flen = 1;
 			break;
 	    case 'D':
+	    case 'T':
 			dbf->db_flen = 8;
 			break;
 	    default:
@@ -257,6 +258,9 @@ char *get_dbf_f_fmt(dbfield_t *dbf)
 	   case 'M':
 		strlcpy(format, "%s", sizeof(format));
 		break;
+	   case 'T':
+		format[0] = '\0';
+		break;
 	   default:
 		return NULL;
 	}

dbf_misc.c

@@ -8,6 +8,7 @@
 #include <sys/types.h>
 
 #include "dbf_misc.h"
+#include "dbf_sdncal.h"
 
 #include "php_reentrancy.h"
 
@@ -144,6 +145,33 @@ int db_date_day(char *cp)
 	return day;
 }
 
+void db_set_timestamp(char *cp, int jdn, int msecs)
+{
+	int year, month, day, hour, minute, second, millis;
+
+	db_sdn_to_gregorian(jdn, &year, &month, &day);
+
+	millis = msecs % 1000;
+	msecs /= 1000;
+	second = msecs % 60;
+	msecs /= 60;
+	minute = msecs % 60;
+	msecs /= 60;
+	hour = msecs;
+
+	snprintf(cp, 19, "%04d%02d%02d%02d%02d%02d.%03d", year, month, day, hour, minute, second, millis);
+}
+
+void db_get_timestamp(char *cp, int *jdn, int *msecs)
+{
+	int year, month, day, hour, minute, second, millis;
+
+	sscanf(cp, "%04d%02d%02d%02d%02d%02d.%03d", &year, &month, &day, &hour, &minute, &second, &millis);
+
+	*jdn = db_gregorian_to_sdn(year, month, day);
+	*msecs = (hour * 60 * 60 * 1000) + (minute * 60 * 1000) + (second * 1000) + millis;
+}
+
 #include <time.h>
 
 char *db_cur_date(char *cp)

dbf_misc.h

@@ -11,3 +11,5 @@ extern int db_date_year(char *cp);
 extern int db_date_month(char *cp);
 extern int db_date_day(char *cp);
 extern char *db_cur_date(char *cp);
+void db_set_timestamp(char *cp, int jdn, int msecs);
+void db_get_timestamp(char *cp, int *jdn, int *msecs);

dbf_rec.c

@@ -170,6 +170,16 @@ char *get_field_val(char *rp, dbfield_t *fldp, char *cp)
 	return cp;
 }
 
+char *get_binary_field_val(char *rp, dbfield_t *fldp, char *cp)
+{
+	int flen = fldp->db_flen;
+
+	if ( !cp )
+		cp = (char *)emalloc(flen);
+	memcpy(cp, &rp[fldp->db_foffset], flen);
+	return cp;
+}
+
 void put_field_val(char *rp, dbfield_t *fldp, char *cp)
 {
 	strncpy(&rp[fldp->db_foffset], cp, fldp->db_flen);

dbf_rec.h

@@ -5,6 +5,7 @@ extern int put_dbf_eof_marker(dbhead_t *dbh);
 extern int del_dbf_record(dbhead_t *dbh, long rec_num);
 int pack_dbf(dbhead_t *dbh);
 extern char *get_field_val(char *rp, dbfield_t *fldp, char *cp);
+char *get_binary_field_val(char *rp, dbfield_t *fldp, char *cp);
 void put_field_val(char *rp, dbfield_t *fldp, char *cp);
 void out_rec(dbhead_t *dbh, dbfield_t *dbf, char *cp);
 extern int is_valid_rec(char *cp);

dbf_sdncal.h

@@ -0,0 +1,76 @@
+#ifndef DBF_SDNCAL_H
+#define DBF_SDNCAL_H
+/*
+ * This code has been modified for use with PHP
+ * by Shane Caraveo [email protected]
+ * see below for more details
+ *
+ * This code has been adapted for the dbase extension
+ * by Christoph M. Becker <[email protected]> *
+ */
+
+/* $selId: sdncal.h,v 2.0 1995/10/24 01:13:06 lees Exp $
+ * Copyright 1993-1995, Scott E. Lee, all rights reserved.
+ * Permission granted to use, copy, modify, distribute and sell so long as
+ * the above copyright and this permission statement are retained in all
+ * copies.  THERE IS NO WARRANTY - USE AT YOUR OWN RISK.
+ */
+
+/**************************************************************************
+ *
+ * This package defines a set of routines that convert calendar dates to
+ * and from a serial day number (SDN).  The SDN is a serial numbering of
+ * days where SDN 1 is November 25, 4714 BC in the Gregorian calendar and
+ * SDN 2447893 is January 1, 1990.  This system of day numbering is
+ * sometimes referred to as Julian days, but to avoid confusion with the
+ * Julian calendar, it is referred to as serial day numbers here.  The term
+ * Julian days is also used to mean the number of days since the beginning
+ * of the current year.
+ *
+ * The SDN can be used as an intermediate step in converting from one
+ * calendar system to another (such as Gregorian to Jewish).  It can also
+ * be used for date computations such as easily comparing two dates,
+ * determining the day of the week, finding the date of yesterday or
+ * calculating the number of days between two dates.
+ *
+ * When using this software on 16 bit systems, be careful to store SDNs in
+ * a long int, because it will not fit in the 16 bits that some systems
+ * allocate to an int.
+ *
+ * For each calendar, there are two routines provided.  One converts dates
+ * in that calendar to SDN and the other converts SDN to calendar dates.
+ * The routines are named SdnTo<CALENDAR>() and <CALENDAR>ToSdn(), where
+ * <CALENDAR> is the name of the calendar system.
+ *
+ * SDN values less than one are not supported.  If a conversion routine
+ * returns an SDN of zero, this means that the date given is either invalid
+ * or is outside the supported range for that calendar.
+ *
+ * At least some validity checks are performed on input dates.  For
+ * example, a negative month number will result in the return of zero for
+ * the SDN.  A returned SDN greater than one does not necessarily mean that
+ * the input date was valid.  To determine if the date is valid, convert it
+ * to SDN, and if the SDN is greater than zero, convert it back to a date
+ * and compare to the original.  For example:
+ *
+ *    int y1, m1, d1;
+ *    int y2, m2, d2;
+ *    zend_long sdn;
+ *    ...
+ *    sdn = GregorianToSdn(y1, m1, d1);
+ *    if (sdn > 0) {
+ *        SdnToGregorian(sdn, &y2, &m2, &d2);
+ *        if (y1 == y2 && m1 == m2 && d1 == d2) {
+ *            ... date is valid ...
+ *        }
+ *    }
+ *
+ **************************************************************************/
+
+#include "php.h"
+
+/* Gregorian calendar conversions. */
+void db_sdn_to_gregorian(zend_long sdn, int *pYear, int *pMonth, int *pDay);
+zend_long db_gregorian_to_sdn(int year, int month, int day);
+
+#endif /* DBF_SDNCAL_H */