HTML-755: UIFR to expose time zones support API.

api/src/main/java/org/openmrs/ui/framework/FormatterImpl.java

@@ -1,18 +1,17 @@
 package org.openmrs.ui.framework;
 
 import java.text.DateFormat;
-import java.util.ArrayList;
-import java.util.Calendar;
 import java.util.Date;
 import java.util.HashMap;
-import java.util.List;
 import java.util.Locale;
-import java.util.Map;
+import java.util. Map;
+import java.util. Calendar;
+import java.util. List;
+import java.util. ArrayList;
 
 import org.apache.commons.beanutils.BeanUtils;
 import org.apache.commons.beanutils.MethodUtils;
 import org.apache.commons.lang.StringUtils;
-import org.apache.commons.lang.time.DateFormatUtils;
 import org.openmrs.Concept;
 import org.openmrs.ConceptName;
 import org.openmrs.ConceptNumeric;
@@ -34,6 +33,8 @@
 import org.openmrs.ui.framework.formatter.FormatterService;
 import org.springframework.context.MessageSource;
 
+import static org.openmrs.util.TimeZoneUtil.toRFC3339;
+
 /**
  * Contains default formatting for most OpenMRS classes, which can be override with {@link FormatterFactory} instances.
  * Do not construct this class directly, but rather use {@link FormatterService#getFormatter()}.
@@ -42,6 +43,15 @@ public class FormatterImpl implements Formatter {
 
     private MessageSource messageSource;
     private AdministrationService administrationService;
+    private UiUtils ui = new BasicUiUtils();
+
+    public UiUtils getUi() {
+        return ui;
+    }
+
+    public void setUi(UiUtils ui) {
+        this.ui = ui;
+    }
 
     /**
      * Map from fully-qualified classname, to the formatter to use for this class
@@ -113,6 +123,9 @@ private boolean wholeNumber(Number n) {
 
     private String format(Date d, Locale locale) {
         DateFormat df;
+        if(ui.handleTimeZones()){
+            return (toRFC3339(d));
+        }
         if (hasTimeComponent(d)) {
             df = UiFrameworkUtil.getDateTimeFormat(administrationService, locale);
         } else {

api/src/main/java/org/openmrs/ui/framework/UiFrameworkConstants.java

@@ -24,7 +24,8 @@ public class UiFrameworkConstants {
     public static final String GP_FORMATTER_TIME_FORMAT = "uiframework.formatter.timeFormat";
     public static final String GP_FORMATTER_JS_DATETIME_FORMAT = "uiframework.formatter.JSdateAndTimeFormat";
     public static final String GP_FORMATTER_JS_DATE_FORMAT = "uiframework.formatter.JSdateFormat";
-
+    public final static String GP_HANDLE_TIMEZONES = "uiframework.handleTimezones";
+
     public static final String MAP_RESOURCE_EXTENSION_POINT_ID = "org.openmrs.ui.framework.mapResource";
 
 

api/src/main/java/org/openmrs/ui/framework/UiUtils.java

@@ -586,4 +586,30 @@ public Locale getLocale() {
 	public void setLocale(Locale locale) {
 		this.locale = locale;
 	}
+
+	/**
+	 * @return the value of the Global Propriety Handle Timezones 
+	 */
+	public boolean handleTimeZones(){
+		return  Boolean.parseBoolean(
+				Context.getAdministrationService().getGlobalProperty(UiFrameworkConstants.GP_HANDLE_TIMEZONES));
+	}
+
+	public String getJSDatetimeFormat(){
+		return Context.getAdministrationService().getGlobalProperty(UiFrameworkConstants.GP_FORMATTER_JS_DATETIME_FORMAT);
+	}
+	public String getJSDateFormat(){
+		return Context.getAdministrationService().getGlobalProperty(UiFrameworkConstants.GP_FORMATTER_JS_DATE_FORMAT);
+	}
+	public String getDatetimeFormat(){
+		return	Context.getAdministrationService().getGlobalProperty(UiFrameworkConstants.GP_FORMATTER_DATETIME_FORMAT);
+	}
+	public String getDateFormat(){
+		return  Context.getAdministrationService().getGlobalProperty(UiFrameworkConstants.GP_FORMATTER_DATE_FORMAT);
+	}
+
+	public String getTimeFormat(){
+		return  Context.getAdministrationService().getGlobalProperty(UiFrameworkConstants.GP_FORMATTER_TIME_FORMAT);
+	}
+
 }

api/src/main/java/org/openmrs/ui/framework/converter/StringToDateConverter.java

@@ -5,6 +5,7 @@
 import java.util.Date;
 
 import org.openmrs.ui.framework.WebConstants;
+import org.openmrs.util.TimeZoneUtil;
 import org.springframework.core.convert.ConversionFailedException;
 import org.springframework.core.convert.TypeDescriptor;
 import org.springframework.core.convert.converter.Converter;
@@ -17,7 +18,13 @@ public Date convert(String ymdhmsms) {
 		if (ymdhmsms.isEmpty()) {
 			return null;
 		}
-
+
+		//try to parse date with format ISO 8601
+		try {
+			return TimeZoneUtil.fromISO8601(ymdhmsms);
+		}
+		catch (Exception ex) {}
+
 		try {
 			SimpleDateFormat sdf = new SimpleDateFormat(WebConstants.DATE_FORMAT_TIMESTAMP);
 			return sdf.parse(ymdhmsms);

api/src/main/java/org/openmrs/util/TimeZoneUtil.java

@@ -0,0 +1,63 @@
+/**
+ * This Source Code Form is subject to the terms of the Mozilla Public License,
+ * v. 2.0. If a copy of the MPL was not distributed with this file, You can
+ * obtain one at http://mozilla.org/MPL/2.0/. OpenMRS is also distributed under
+ * the terms of the Healthcare Disclaimer located at http://openmrs.org/license.
+ *
+ * Copyright (C) OpenMRS Inc. OpenMRS is a registered trademark and the OpenMRS
+ * graphic logo is a trademark of OpenMRS Inc.
+ */
+package org.openmrs.util;
+
+import org.joda.time.DateTime;
+import org.joda.time.format.ISODateTimeFormat;
+
+import java.util.Calendar;
+import java.util.Date;
+
+import static org.joda.time.DateTimeZone.UTC;
+
+/**
+ * Helps provide tools to support recommended OpenMRS time zones conventions.
+ * 
+ * @see https://wiki.openmrs.org/display/docs/Time+Zones+Conventions
+ */
+public class TimeZoneUtil {
+
+	/**
+	 * Formats a date as its RFC 3339 string representation.
+	 * 
+	 * @param date The date.
+	 * @return The date formated as RFC 3339.
+	 */
+	public static String toRFC3339(Date date) {
+		return ISODateTimeFormat.dateTime().print(new DateTime(date.getTime(), UTC));
+	}
+
+	/**
+	 * Gets the Calendar instance for the date set in UTC. This always returns a GregorianCalendar
+	 * subclass.
+	 * 
+	 * @param date The date.
+	 * @return The GregorianCalendar set in UTC for the date.
+	 */
+	public static Calendar toUTCCalendar(Date date) {
+		return new DateTime(date.getTime(), UTC).toGregorianCalendar();
+	}
+
+
+	/**
+	 * Get a Date out of its ISO 8601 string representation.
+	 *
+	 * @param s A date formatted as ISO 8601.
+	 * @return The Date object.
+	 * @Throws IllegalArgumentException – if string parameter does not conform to lexical value space
+	 */
+	public static Date fromISO8601(String s) throws
+			IllegalArgumentException {
+		return javax.xml.bind.DatatypeConverter.parseDateTime(s).getTime();
+	}
+
+}
+
+

api/src/test/java/org/openmrs/ui/framework/FormatterImplTest.java

@@ -40,14 +40,14 @@ public class FormatterImplTest {
 
     AdministrationService administrationService;
     MockMessageSource messageSource;
-
+    UiUtils ui;
     FormatterImpl formatter;
 
     @Before
     public void setUp() {
         administrationService = mock(AdministrationService.class);
         messageSource = new MockMessageSource();
-
+        ui = mock(UiUtils.class);
         formatter = new FormatterImpl(messageSource, administrationService);
     }
 
@@ -139,6 +139,8 @@ public void testFormattingRoleWithOverriddenMetadataName()  throws Exception {
     @Test
     public void testFormattingADateWithNoTime() throws Exception {
         when(administrationService.getGlobalProperty(UiFrameworkConstants.GP_FORMATTER_DATE_FORMAT, "dd.MMM.yyyy")).thenReturn("dd.MMM.yyyy");
+        formatter.setUi(ui);
+        when(ui.handleTimeZones()).thenReturn(false);
 
         Locale locale = Locale.ENGLISH;
         Date date = new SimpleDateFormat("yyyy-MM-dd").parse("2003-02-01");
@@ -150,6 +152,8 @@ public void testFormattingADateWithNoTime() throws Exception {
     @Test
     public void testFormattingADateWithATime() throws Exception {
         when(administrationService.getGlobalProperty(UiFrameworkConstants.GP_FORMATTER_DATETIME_FORMAT, "dd.MMM.yyyy, HH:mm:ss")).thenReturn("dd.MMM.yyyy, HH:mm:ss");
+        formatter.setUi(ui);
+        when(ui.handleTimeZones()).thenReturn(false);
 
         Locale locale = Locale.ENGLISH;
         Date date = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss.SSS").parse("2003-02-01 14:25:07.123");

omod/src/main/resources/config.xml

@@ -89,6 +89,13 @@
 			Format used by Javascript functions for dates that have a time component
 		</description>
 	</globalProperty>
+
+	<globalProperty>
+		<property>uiframework.handleTimezones</property>
+		<defaultValue>true</defaultValue>
+		<description>When set to true dates are sent from the server to the client as UTC dates and parsed from the client to the server as holding the client timezone information.
+		</description>
+	</globalProperty>
 
 	<servlet>
 		<servlet-name>resource</servlet-name>

pom.xml

@@ -61,6 +61,16 @@
             <version>3.19.0-GA</version>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>joda-time</groupId>
+            <artifactId>joda-time</artifactId>
+            <version>2.9.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.joda</groupId>
+            <artifactId>joda-convert</artifactId>
+            <version>1.2</version>
+        </dependency>
     </dependencies>
 
     <dependencyManagement>