QgsDateTimeEdit: convert datetime to UTC when format string includes a Z

Fixes qgis#57262
rouault · May 19, 2024 · cf75374 · cf75374
1 parent eb879e7
commit cf75374
Show file tree

Hide file tree

Showing 4 changed files with 33 additions and 0 deletions.
diff --git a/src/gui/editorwidgets/qgsdatetimeedit.cpp b/src/gui/editorwidgets/qgsdatetimeedit.cpp
@@ -346,6 +346,9 @@ void QgsDateTimeEdit::setDateTime( const QDateTime &dateTime )
   {
     // changed emits a signal, so don't allow it to be emitted from setDateTime
     mBlockChangedSignal++;
+    // We need to set the time spec of the set datetime to the widget, otherwise
+    // the dateTime() getter would loose edit, and return local time.
+    QDateTimeEdit::setTimeSpec( dateTime.timeSpec() );
     QDateTimeEdit::setDateTime( dateTime );
     mBlockChangedSignal--;
     changed( dateTime );

diff --git a/src/gui/editorwidgets/qgsdatetimeeditconfig.cpp b/src/gui/editorwidgets/qgsdatetimeeditconfig.cpp
@@ -411,6 +411,18 @@ QgsDateTimeEditConfig::QgsDateTimeEditConfig( QgsVectorLayer *vl, int fieldIdx,
 
 void QgsDateTimeEditConfig::updateDemoWidget()
 {
+  // Use a UTC datetime if the format string includes a Z
+  if ( mDisplayFormatEdit->text().indexOf( "Z" ) > 0 )
+  {
+    mDemoDateTimeEdit->setTimeSpec( Qt::UTC );
+    mDemoDateTimeEdit->setDateTime( QDateTime::currentDateTimeUtc() );
+  }
+  else
+  {
+    mDemoDateTimeEdit->setTimeSpec( Qt::LocalTime );
+    mDemoDateTimeEdit->setDateTime( QDateTime::currentDateTime() );
+  }
+
   mDemoDateTimeEdit->setDisplayFormat( mDisplayFormatEdit->text() );
   mDemoDateTimeEdit->setCalendarPopup( mCalendarPopupCheckBox->isChecked() );
 }

diff --git a/src/gui/editorwidgets/qgsdatetimeeditwrapper.cpp b/src/gui/editorwidgets/qgsdatetimeeditwrapper.cpp
@@ -271,6 +271,12 @@ void QgsDateTimeEditWrapper::updateValues( const QVariant &value, const QVariant
 
   if ( mQgsDateTimeEdit )
   {
+    // Convert to UTC if the format string includes a Z
+    if ( mQgsDateTimeEdit->displayFormat().indexOf( "Z" ) > 0 )
+    {
+      dateTime = dateTime.toUTC();
+    }
+
     mQgsDateTimeEdit->setDateTime( dateTime );
   }
   else

diff --git a/tests/src/python/test_qgsdatetimeedit.py b/tests/src/python/test_qgsdatetimeedit.py
@@ -17,6 +17,7 @@
 start_app()
 
 DATE = QDateTime.fromString('2018-01-01 01:02:03', Qt.DateFormat.ISODate)
+DATE_Z = QDateTime.fromString('2018-01-01 01:02:03Z', Qt.DateFormat.ISODate)
 
 
 class TestQgsDateTimeEdit(QgisTestCase):
@@ -32,6 +33,17 @@ def testSettersGetters(self):
         w.setDateTime(QDateTime())
         self.assertEqual(w.dateTime(), DATE)
 
+    def testSettersGetters_DATE_Z(self):
+        """ test widget handling with Z time spec """
+        w = QgsDateTimeEdit()
+        w.setAllowNull(False)
+
+        w.setDateTime(DATE_Z)
+        self.assertEqual(w.dateTime(), DATE_Z)
+        # date should remain when setting an invalid date
+        w.setDateTime(QDateTime())
+        self.assertEqual(w.dateTime(), DATE_Z)
+
     def testNullValueHandling(self):
         """ test widget handling of null values """
         w = QgsDateTimeEdit()