QA#764 - Add property to not return the default value for a translated field if that value is not in the same language.

Instead, return blank.   The new property to drive this behavior is named "returnBlankTranslationForNotDefaultLocale".

This ticket also provides an overridable method in TranslationServiceImpl to exclude some fields from this logic.     In particular, the CMS lookup fields (which start with pageTemplate) needed to be excluded for the home page to render in heat-clinic.     This is because all page template fields currently go through translation provider (even fields like ID) which are not even translatable.

Relates to BroadleafCommerce/QA#764

Author: bpolster

common/src/main/java/org/broadleafcommerce/common/i18n/service/DynamicTranslationProvider.java

@@ -50,6 +50,8 @@ public static String getValue(Object obj, String field, final String defaultValu
 
             if (StringUtils.isNotBlank(translatedValue)) {
                 valueToReturn = translatedValue;
+            } else {
+                valueToReturn = translationService.getDefaultTranslationValue(obj, field, locale, defaultValue);
             }
         }
 

common/src/main/java/org/broadleafcommerce/common/i18n/service/TranslationService.java

@@ -130,4 +130,23 @@ public Translation save(String entityType, String entityId, String fieldName, St
      */
     Cache getCache();
 
+    /**
+     * Intended for use with the {@link DynamicTranslationProvider} to determine the default value when a 
+     * translation was not provided.
+     * 
+     * The default implementation of this method relies on a system property "returnBlankTranslationForNotDefaultLocale". 
+     * If this is true, the system will return blank if the language of the defaultLocale does not match the language
+     * of the passed in locale.
+     * 
+     * For example, consider the "longDescription" property and the system default locale is "en".   If this method is 
+     * called for a locale of "en_CA", the requestedDefaultValue will be returned.   If the method is called with a value
+     * of "fr_CA", blank will be returned.
+     *  
+     * @param entity
+     * @param property
+     * @param locale
+     * @param requestedDefaultValue
+     * @return
+     */
+    String getDefaultTranslationValue(Object entity, String property, Locale locale, String requestedDefaultValue);
 }

common/src/main/java/org/broadleafcommerce/common/i18n/service/TranslationServiceImpl.java

@@ -38,12 +38,15 @@
 import org.broadleafcommerce.common.i18n.domain.TranslatedEntity;
 import org.broadleafcommerce.common.i18n.domain.Translation;
 import org.broadleafcommerce.common.i18n.domain.TranslationImpl;
+import org.broadleafcommerce.common.locale.service.LocaleService;
+import org.broadleafcommerce.common.locale.util.LocaleUtil;
 import org.broadleafcommerce.common.sandbox.SandBoxHelper;
 import org.broadleafcommerce.common.web.BroadleafRequestContext;
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 
+import java.util.ArrayList;
 import java.util.HashMap;
 import java.util.List;
 import java.util.Locale;
@@ -76,6 +79,15 @@ public class TranslationServiceImpl implements TranslationService {
     @Value("${translation.thresholdForFullCache:1000}")
     protected int thresholdForFullCache;
 
+    @Value("${returnBlankTranslationForNotDefaultLocale:false}")
+    protected boolean returnBlankTranslationForNotDefaultLocale;
+
+    @Resource(name = "blTranslationExceptionProperties")
+    protected List<String> translationExceptionProperties = new ArrayList<String>();
+
+    @Resource(name = "blLocaleService")
+    protected LocaleService localeService;
+
     @Resource(name="blGenericEntityDao")
     protected GenericEntityDao genericEntityDao;
 
@@ -412,4 +424,55 @@ protected int getThresholdForFullCache() {
         }
     }
 
+    public String getDefaultTranslationValue(Object entity, String property, Locale locale,
+            String requestedDefaultValue) {
+
+        if (returnBlankTranslationForNotDefaultLocale) {
+            if (localeMatchesDefaultLocale(locale)) {
+            } else if (!propertyInDefaultLocaleExceptionList(entity, property)) {
+                return "";
+            }
+        }
+
+        return requestedDefaultValue;
+    }
+
+    /**
+     * Returns true if the passed in entity / property combination is in the defaultLocaleExceptionList
+     * 
+     * The default implementation checks the "translationExceptionProperties" list to see if the
+     * property matches one of the regularExpressions in that list.
+     * 
+     * Implementors are expected to override this method for implementation specific needs. 
+     * 
+     * @param entity
+     * @param property
+     * @return
+     */
+    protected boolean propertyInDefaultLocaleExceptionList(Object entity, String property) {
+        TranslatedEntity entityType = getEntityType(entity);
+        if (entityType != null && entityType.getFriendlyType() != null) {
+            for (String exceptionProperty : translationExceptionProperties) {
+                if (property.matches(exceptionProperty)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * Returns true if the passed in locale's language matches the Broadleaf default locale.
+     * @param locale
+     * @return
+     */
+    protected boolean localeMatchesDefaultLocale(Locale locale) {
+        String defaultLanguage = LocaleUtil.findLanguageCode(localeService.findDefaultLocale());
+
+        if (defaultLanguage != null && locale != null) {
+            return defaultLanguage.equals(locale.getLanguage());
+        }
+        return false;
+    }
+
 }

common/src/main/resources/bl-common-applicationContext.xml

@@ -377,4 +377,12 @@
             </map>
         </property>
     </bean>
+    
+    <bean id="blTranslationExceptionProperties" class="org.springframework.beans.factory.config.ListFactoryBean" >
+        <property name="sourceList">
+            <list>
+                <value>pageTemplate.*</value>
+            </list>
+        </property>
+    </bean>    
 </beans>