[ofbiz-framework] branch trunk updated: Improved: Mark as deprecated ofbiz.locale.default and locale.properties.fallback properties (OFBIZ-11962)

This is an automated email from the ASF dual-hosted git repository.

jleroux pushed a commit to branch trunk
in repository https://gitbox.apache.org/repos/asf/ofbiz-framework.git


The following commit(s) were added to refs/heads/trunk by this push:
     new b80fc90  Improved: Mark as deprecated ofbiz.locale.default and locale.properties.fallback properties (OFBIZ-11962)
b80fc90 is described below

commit b80fc9075c2c3ed5ea6013325bd70a1e9148b3ec
Author: Jacques Le Roux <[hidden email]>
AuthorDate: Tue Aug 18 11:42:55 2020 +0200

    Improved: Mark as deprecated ofbiz.locale.default and locale.properties.fallback properties (OFBIZ-11962)
   
    It follows this dev thread: https://markmail.org/message/fzg7qrxgnxgbn65o
   
    Also removes deprecation for EntityUtilProperties::getFallbackLocale
    It was copied from UtilProperties::getFallbackLocale I guess
    UtilProperties::getFallbackLocale is not deprecated and used in some place
---
 framework/common/config/general.properties                    |  3 +++
 .../resources/org/apache/ofbiz/base/start/start.properties    | 11 ++++++++++-
 2 files changed, 13 insertions(+), 1 deletion(-)

diff --git a/framework/common/config/general.properties b/framework/common/config/general.properties
index a4706cc..e2c8fce 100644
--- a/framework/common/config/general.properties
+++ b/framework/common/config/general.properties
@@ -29,10 +29,13 @@ ORGANIZATION_PARTY=Company
 # ID of the VisualTheme to use if there is no VISUAL_THEME UserPreference record for the current user (ie default value)
 VISUAL_THEME=RAINBOWSTONE_SAPHIR
 
+# -- DEPRECATED See documentation in ofbiz.locale.default in start.properties
+# -- It though still used in some places in code (mostly in content component)
 # -- Properties fallback locale. Change this setting with caution. If you
 #    start getting "resource not found" exceptions, then there are
 #    properties missing in the locale you specified. This property does not
 #    control the default locale - the default locale is set in start.properties.
+#    
 locale.properties.fallback=en
 
 # -- Locales made available, separated by commas. This property controls
diff --git a/framework/start/src/main/resources/org/apache/ofbiz/base/start/start.properties b/framework/start/src/main/resources/org/apache/ofbiz/base/start/start.properties
index e1bf39d..8d3db5c 100644
--- a/framework/start/src/main/resources/org/apache/ofbiz/base/start/start.properties
+++ b/framework/start/src/main/resources/org/apache/ofbiz/base/start/start.properties
@@ -55,7 +55,16 @@ ofbiz.admin.key=so3du5kasd5dn
 # --- Tells AWT to not require a head (X11). Default is true
 #java.awt.headless=false
 
-# -- The locale for this OFBiz instance. Default is en
+# -- DEPRECATED
+# -- ofbiz.locale.default was used in old days where you had to set the user.language system property manually from CLI when launching OFBiz to set the default language.
+# -- This is no longer true for a while. The language used by default is taken from the browser*:
+# -- This is done by UtilHttp::getLocale which ultimately uses:
+# --    Locale javax.servlet.ServletRequest.getLocale()
+# --    Returns the preferred Locale that the client will accept content in, based on the Accept-Language header.
+# --    If the client request doesn't provide an Accept-Language header, this method returns the default locale for the server.
+# --    Returns: the preferred Locale for the client
+# -- We also use initialLocaleComplete in the screens for JavaScript part.
+# -- It though may be still used by jobs pending that run before any UI interactions.
 #ofbiz.locale.default=en_US
 
 # -- The time zone for this OFBiz instance. Default depends on JVM environment