Merge pull request #6793 from FirebirdSQL/work/gh-6788

Improvement #6788 - Extend EXTRACT to extract time zone strings.

doc/sql.extensions/README.keywords

@@ -372,6 +372,7 @@ Firebird 4.0
     SQL (1)
     SYSTEM (1)
     TIES
+    TIMEZONE_NAME *
     TOTALORDER *
     TRAPS *
     ZONE

doc/sql.extensions/README.time_zone.md

@@ -298,6 +298,7 @@ select timestamp '2018-01-01 12:00 GMT' at local
 Two new `EXTRACT` expressions has been added:
 - `TIMEZONE_HOUR`: extracts the time zone hours displacement
 - `TIMEZONE_MINUTE`: extracts the time zone minutes displacement
+- `TIMEZONE_NAME`: extracts the time zone region or displacement string
 
 #### Examples
 
@@ -307,6 +308,9 @@ select extract(timezone_hour from current_time)
 
 select extract(timezone_minute from current_timestamp)
   from rdb$database;
+
+select extract(timezone_name from current_timestamp)
+  from rdb$database;
 ```
 
 ### `LOCALTIME` expression

src/common/keywords.cpp

@@ -492,6 +492,7 @@ static const TOK tokens[] =
 	{TOK_TIMEOUT, "TIMEOUT", true},
 	{TOK_TIMEZONE_HOUR, "TIMEZONE_HOUR", false},
 	{TOK_TIMEZONE_MINUTE, "TIMEZONE_MINUTE", false},
+	{TOK_TIMEZONE_NAME, "TIMEZONE_NAME", true},
 	{TOK_TO, "TO", false},
 	{TOK_TOTALORDER, "TOTALORDER", true},
 	{TOK_TRAILING, "TRAILING", false},

src/dsql/ExprNodes.cpp

@@ -5334,6 +5334,7 @@ ValueExprNode* ExtractNode::dsqlPass(DsqlCompilerScratch* dsqlScratch)
 
 		case blr_extract_timezone_hour:
 		case blr_extract_timezone_minute:
+		case blr_extract_timezone_name:
 			if (!nodeIs<NullNode>(sub1) &&
 				!sub1->getDsqlDesc().isTime() &&
 				!sub1->getDsqlDesc().isTimeStamp())
@@ -5385,6 +5386,10 @@ void ExtractNode::make(DsqlCompilerScratch* dsqlScratch, dsc* desc)
 			desc->makeLong(ISC_TIME_SECONDS_PRECISION_SCALE + 3);
 			break;
 
+		case blr_extract_timezone_name:
+			desc->makeVarying(TimeZoneUtil::MAX_LEN, ttype_ascii);
+			break;
+
 		default:
 			desc->makeShort(0);
 			break;
@@ -5406,6 +5411,10 @@ void ExtractNode::getDesc(thread_db* /*tdbb*/, CompilerScratch* /*csb*/, dsc* de
 			desc->makeLong(ISC_TIME_SECONDS_PRECISION_SCALE + 3);
 			break;
 
+		case blr_extract_timezone_name:
+			desc->makeVarying(TimeZoneUtil::MAX_LEN, ttype_ascii);
+			break;
+
 		default:
 			desc->makeShort(0);
 			break;
@@ -5484,6 +5493,7 @@ dsc* ExtractNode::execute(thread_db* tdbb, jrd_req* request) const
 
 				case blr_extract_timezone_hour:
 				case blr_extract_timezone_minute:
+				case blr_extract_timezone_name:
 				{
 					ISC_TIME_TZ timeTz = TimeZoneUtil::timeToTimeTz(
 						*(ISC_TIME*) value->dsc_address, &EngineCallbacks::instance);
@@ -5512,6 +5522,7 @@ dsc* ExtractNode::execute(thread_db* tdbb, jrd_req* request) const
 
 				case blr_extract_timezone_hour:
 				case blr_extract_timezone_minute:
+				case blr_extract_timezone_name:
 					timeStampTz.utc_timestamp.timestamp_date = TimeZoneUtil::TIME_TZ_BASE_DATE;
 					timeStampTz.utc_timestamp.timestamp_time = ((ISC_TIME_TZ*) value->dsc_address)->utc_time;
 					timeStampTz.time_zone = ((ISC_TIME_TZ*) value->dsc_address)->time_zone;
@@ -5532,6 +5543,7 @@ dsc* ExtractNode::execute(thread_db* tdbb, jrd_req* request) const
 				case blr_extract_millisecond:
 				case blr_extract_timezone_hour:
 				case blr_extract_timezone_minute:
+				case blr_extract_timezone_name:
 					ERR_post(Arg::Gds(isc_expression_eval_err) <<
 							 Arg::Gds(isc_invalid_extractpart_date));
 					break;
@@ -5546,6 +5558,7 @@ dsc* ExtractNode::execute(thread_db* tdbb, jrd_req* request) const
 			{
 				case blr_extract_timezone_hour:
 				case blr_extract_timezone_minute:
+				case blr_extract_timezone_name:
 				{
 					dsc tempDsc;
 					tempDsc.makeTimestampTz(&timeStampTz);
@@ -5563,6 +5576,7 @@ dsc* ExtractNode::execute(thread_db* tdbb, jrd_req* request) const
 			{
 				case blr_extract_timezone_hour:
 				case blr_extract_timezone_minute:
+				case blr_extract_timezone_name:
 					timeStampTz = *(ISC_TIMESTAMP_TZ*) value->dsc_address;
 					break;
 
@@ -5578,7 +5592,12 @@ dsc* ExtractNode::execute(thread_db* tdbb, jrd_req* request) const
 			break;
 	}
 
-	if (blrSubOp == blr_extract_timezone_hour || blrSubOp == blr_extract_timezone_minute)
+	USHORT part;
+
+	switch (blrSubOp)
+	{
+		case blr_extract_timezone_hour:
+		case blr_extract_timezone_minute:
 		{
 			int tzSign;
 			unsigned tzh, tzm;
@@ -5594,12 +5613,20 @@ dsc* ExtractNode::execute(thread_db* tdbb, jrd_req* request) const
 					*(SSHORT*) impure->vlu_desc.dsc_address = tzSign * int(tzm);
 					return &impure->vlu_desc;
 			}
+
+			break;
 		}
 
-	USHORT part;
-
-	switch (blrSubOp)
+		case blr_extract_timezone_name:
 		{
+			char timeZoneBuffer[TimeZoneUtil::MAX_SIZE];
+			const auto len = TimeZoneUtil::format(timeZoneBuffer, sizeof(timeZoneBuffer), timeStampTz.time_zone);
+
+			impure->vlu_desc.makeText(len, ttype_ascii, (UCHAR*) timeZoneBuffer);
+			EVL_make_value(tdbb, &impure->vlu_desc, impure);
+			return &impure->vlu_desc;
+		}
+
 		case blr_extract_year:
 			part = times.tm_year + 1900;
 			break;

src/dsql/parse.y

@@ -8586,6 +8586,7 @@ timestamp_part
 	| MILLISECOND	{ $$ = blr_extract_millisecond; }
 	| TIMEZONE_HOUR	{ $$ = blr_extract_timezone_hour; }
 	| TIMEZONE_MINUTE	{ $$ = blr_extract_timezone_minute; }
+	| TIMEZONE_NAME	{ $$ = blr_extract_timezone_name; }
 	| WEEK			{ $$ = blr_extract_week; }
 	| WEEKDAY		{ $$ = blr_extract_weekday; }
 	| YEARDAY		{ $$ = blr_extract_yearday; }
@@ -9044,6 +9045,7 @@ non_reserved_word
 	| SQL
 	| SYSTEM
 	| TIES
+	| TIMEZONE_NAME
 	| TOTALORDER
 	| TRAPS
 	| ZONE

src/include/firebird/impl/blr.h

@@ -288,6 +288,7 @@
 #define blr_extract_week		(unsigned char)9
 #define blr_extract_timezone_hour	(unsigned char)10
 #define blr_extract_timezone_minute	(unsigned char)11
+#define blr_extract_timezone_name	(unsigned char)12
 
 #define blr_current_date	(unsigned char)160
 #define blr_current_timestamp	(unsigned char)161