8181157: CLDR Timezone name fallback implementation

Reviewed-by: sherman, scolebourne
This commit is contained in:
Naoto Sato 2018-04-26 12:39:15 -07:00
parent 3105e04e1b
commit fafd844bc6
22 changed files with 639 additions and 155 deletions

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -55,6 +55,7 @@ import java.util.concurrent.ConcurrentMap;
import sun.util.calendar.CalendarUtils;
import sun.util.calendar.ZoneInfoFile;
import sun.util.locale.provider.LocaleProviderAdapter;
import sun.util.locale.provider.TimeZoneNameUtility;
/**
* <code>SimpleDateFormat</code> is a concrete class for formatting and
@ -1691,6 +1692,12 @@ public class SimpleDateFormat extends DateFormat {
// Checking long and short zones [1 & 2],
// and long and short daylight [3 & 4].
String zoneName = zoneNames[i];
if (zoneName.isEmpty()) {
// fill in by retrieving single name
zoneName = TimeZoneNameUtility.retrieveDisplayName(
zoneNames[0], i >= 3, i % 2, locale);
zoneNames[i] = zoneName;
}
if (text.regionMatches(true, start,
zoneName, 0, zoneName.length())) {
return i;

View file

@ -2189,9 +2189,9 @@ public final class Locale implements Cloneable, Serializable {
}
break;
case "tz":
displayType = TimeZoneNameUtility.retrieveGenericDisplayName(
TimeZoneNameUtility.convertLDMLShortID(type).orElse(type),
TimeZone.LONG, inLocale);
displayType = TimeZoneNameUtility.convertLDMLShortID(type)
.map(id -> TimeZoneNameUtility.retrieveGenericDisplayName(id, TimeZone.LONG, inLocale))
.orElse(type);
break;
}
ret = MessageFormat.format(lr.getLocaleName("ListKeyTypePattern"),

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -45,6 +45,7 @@ import java.util.Set;
import java.util.StringTokenizer;
import java.util.concurrent.ConcurrentHashMap;
import java.util.spi.CalendarDataProvider;
import java.util.spi.TimeZoneNameProvider;
import sun.util.locale.provider.JRELocaleProviderAdapter;
import sun.util.locale.provider.LocaleDataMetaInfo;
import sun.util.locale.provider.LocaleProviderAdapter;
@ -130,6 +131,24 @@ public class CLDRLocaleProviderAdapter extends JRELocaleProviderAdapter {
return null;
}
@Override
public TimeZoneNameProvider getTimeZoneNameProvider() {
if (timeZoneNameProvider == null) {
TimeZoneNameProvider provider = AccessController.doPrivileged(
(PrivilegedAction<TimeZoneNameProvider>) () ->
new CLDRTimeZoneNameProviderImpl(
getAdapterType(),
getLanguageTagSet("TimeZoneNames")));
synchronized (this) {
if (timeZoneNameProvider == null) {
timeZoneNameProvider = provider;
}
}
}
return timeZoneNameProvider;
}
@Override
public Locale[] getAvailableLocales() {
Set<String> all = createLanguageTagSet("AvailableLocales");
@ -246,9 +265,9 @@ public class CLDRLocaleProviderAdapter extends JRELocaleProviderAdapter {
}
/**
* Returns the time zone ID from an LDML's short ID
* Returns the canonical ID for the given ID
*/
public Optional<String> getTimeZoneID(String shortID) {
return Optional.ofNullable(baseMetaInfo.tzShortIDs().get(shortID));
public Optional<String> canonicalTZID(String id) {
return Optional.ofNullable(baseMetaInfo.tzCanonicalIDs().get(id));
}
}

View file

@ -0,0 +1,272 @@
/*
* Copyright (c) 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
* under the terms of the GNU General Public License version 2 only, as
* published by the Free Software Foundation. Oracle designates this
* particular file as subject to the "Classpath" exception as provided
* by Oracle in the LICENSE file that accompanied this code.
*
* This code is distributed in the hope that it will be useful, but WITHOUT
* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
* FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
* version 2 for more details (a copy is included in the LICENSE file that
* accompanied this code).
*
* You should have received a copy of the GNU General Public License version
* 2 along with this work; if not, write to the Free Software Foundation,
* Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
* Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
* or visit www.oracle.com if you need additional information or have any
* questions.
*/
package sun.util.cldr;
import static sun.util.locale.provider.LocaleProviderAdapter.Type;
import java.text.MessageFormat;
import java.util.Arrays;
import java.util.Locale;
import java.util.Objects;
import java.util.ResourceBundle;
import java.util.Set;
import java.util.TimeZone;
import java.util.stream.Collectors;
import sun.util.calendar.ZoneInfoFile;
import sun.util.locale.provider.LocaleProviderAdapter;
import sun.util.locale.provider.LocaleResources;
import sun.util.locale.provider.TimeZoneNameProviderImpl;
import sun.util.locale.provider.TimeZoneNameUtility;
/**
* Concrete implementation of the
* {@link java.util.spi.TimeZoneNameProvider TimeZoneNameProvider} class
* for the CLDR LocaleProviderAdapter.
*
* @author Naoto Sato
*/
public class CLDRTimeZoneNameProviderImpl extends TimeZoneNameProviderImpl {
private static final String NO_INHERITANCE_MARKER = "\u2205\u2205\u2205";
private static class AVAILABLE_IDS {
static final String[] INSTANCE =
Arrays.stream(ZoneInfoFile.getZoneIds())
.sorted()
.toArray(String[]::new);
}
// display name array indexes
private static final int INDEX_TZID = 0;
private static final int INDEX_STD_LONG = 1;
private static final int INDEX_STD_SHORT = 2;
private static final int INDEX_DST_LONG = 3;
private static final int INDEX_DST_SHORT = 4;
private static final int INDEX_GEN_LONG = 5;
private static final int INDEX_GEN_SHORT = 6;
public CLDRTimeZoneNameProviderImpl(Type type, Set<String> langtags) {
super(type, langtags);
}
@Override
protected String[] getDisplayNameArray(String id, Locale locale) {
String tzid = TimeZoneNameUtility.canonicalTZID(id).orElse(id);
String[] namesSuper = super.getDisplayNameArray(tzid, locale);
if (Objects.nonNull(namesSuper)) {
// CLDR's resource bundle has an translated entry for this id.
// Fix up names if needed, either missing or no-inheritance
namesSuper[INDEX_TZID] = id;
// Check if standard long name exists. If not, try to retrieve the name
// from language only locale resources. E.g., "Europe/London"
// for en-GB only contains DST names
if (!exists(namesSuper, INDEX_STD_LONG) && !locale.getCountry().isEmpty()) {
String[] names =
getDisplayNameArray(id, Locale.forLanguageTag(locale.getLanguage()));
if (exists(names, INDEX_STD_LONG)) {
namesSuper[INDEX_STD_LONG] = names[INDEX_STD_LONG];
}
}
for(int i = INDEX_STD_LONG; i < namesSuper.length; i++) { // index 0 is the 'id' itself
switch (namesSuper[i]) {
case "":
// Fill in empty elements
deriveFallbackName(namesSuper, i, locale,
namesSuper[INDEX_DST_LONG].isEmpty());
break;
case NO_INHERITANCE_MARKER:
// CLDR's "no inheritance marker"
namesSuper[i] = toGMTFormat(id, i == INDEX_DST_LONG || i == INDEX_DST_SHORT,
i % 2 != 0, locale);
break;
default:
break;
}
}
return namesSuper;
} else {
// Derive the names for this id. Validate the id first.
if (Arrays.binarySearch(AVAILABLE_IDS.INSTANCE, id) >= 0) {
String[] names = new String[INDEX_GEN_SHORT + 1];
names[INDEX_TZID] = id;
deriveFallbackNames(names, locale);
return names;
}
}
return null;
}
@Override
protected String[][] getZoneStrings(Locale locale) {
// Use English for the ROOT locale
locale = locale.equals(Locale.ROOT) ? Locale.ENGLISH : locale;
String[][] ret = super.getZoneStrings(locale);
// Fill in for the empty names.
// English names are prefilled for performance.
if (locale.getLanguage() != "en") {
for (int zoneIndex = 0; zoneIndex < ret.length; zoneIndex++) {
deriveFallbackNames(ret[zoneIndex], locale);
}
}
return ret;
}
// Derive fallback time zone name according to LDML's logic
private void deriveFallbackNames(String[] names, Locale locale) {
for (int i = INDEX_STD_LONG; i <= INDEX_GEN_SHORT; i++) {
deriveFallbackName(names, i, locale, false);
}
}
private void deriveFallbackName(String[] names, int index, Locale locale, boolean noDST) {
if (exists(names, index)) {
return;
}
// Check if COMPAT can substitute the name
if (LocaleProviderAdapter.getAdapterPreference().contains(Type.JRE)) {
String[] compatNames = (String[])LocaleProviderAdapter.forJRE()
.getLocaleResources(locale)
.getTimeZoneNames(names[INDEX_TZID]);
if (compatNames != null) {
for (int i = INDEX_STD_LONG; i <= INDEX_GEN_SHORT; i++) {
// Assumes COMPAT has no empty slots
if (i == index || !exists(names, i)) {
names[i] = compatNames[i];
}
}
return;
}
}
// Type Fallback
if (noDST && typeFallback(names, index)) {
return;
}
// Region Fallback
if (regionFormatFallback(names, index, locale)) {
return;
}
// last resort
String id = names[INDEX_TZID].toUpperCase(Locale.ROOT);
if (!id.startsWith("ETC/GMT") &&
!id.startsWith("GMT") &&
!id.startsWith("UT")) {
names[index] = toGMTFormat(names[INDEX_TZID],
index == INDEX_DST_LONG || index == INDEX_DST_SHORT,
index % 2 != 0,
locale);
}
}
private boolean exists(String[] names, int index) {
return Objects.nonNull(names)
&& Objects.nonNull(names[index])
&& !names[index].isEmpty();
}
private boolean typeFallback(String[] names, int index) {
// check generic
int genIndex = INDEX_GEN_SHORT - index % 2;
if (!exists(names, index) && exists(names, genIndex)) {
names[index] = names[genIndex];
} else {
// check standard
int stdIndex = INDEX_STD_SHORT - index % 2;
if (!exists(names, index) && exists(names, stdIndex)) {
names[index] = names[stdIndex];
}
}
return exists(names, index);
}
private boolean regionFormatFallback(String[] names, int index, Locale l) {
String id = names[INDEX_TZID];
LocaleResources lr = LocaleProviderAdapter.forType(Type.CLDR).getLocaleResources(l);
ResourceBundle fd = lr.getJavaTimeFormatData();
String rgn = (String) lr.getTimeZoneNames("timezone.excity." + id);
if (rgn == null && !id.startsWith("Etc") && !id.startsWith("SystemV")) {
int slash = id.lastIndexOf('/');
if (slash > 0) {
rgn = id.substring(slash + 1).replaceAll("_", " ");
}
}
if (rgn != null) {
String fmt = "";
switch (index) {
case INDEX_STD_LONG:
fmt = fd.getString("timezone.regionFormat.standard");
break;
case INDEX_DST_LONG:
fmt = fd.getString("timezone.regionFormat.daylight");
break;
case INDEX_GEN_LONG:
fmt = fd.getString("timezone.regionFormat");
break;
}
if (!fmt.isEmpty()) {
names[index] = MessageFormat.format(fmt, rgn);
}
}
return exists(names, index);
}
private String toGMTFormat(String id, boolean daylight, boolean isShort, Locale l) {
TimeZone tz = ZoneInfoFile.getZoneInfo(id);
int offset = (tz.getRawOffset() + (daylight ? tz.getDSTSavings() : 0)) / 60000;
LocaleResources lr = LocaleProviderAdapter.forType(Type.CLDR).getLocaleResources(l);
ResourceBundle fd = lr.getJavaTimeFormatData();
if (offset == 0) {
return fd.getString("timezone.gmtZeroFormat");
} else {
String gmtFormat = fd.getString("timezone.gmtFormat");
String hourFormat = fd.getString("timezone.hourFormat");
if (offset > 0) {
hourFormat = hourFormat.substring(0, hourFormat.indexOf(";"));
} else {
hourFormat = hourFormat.substring(hourFormat.indexOf(";") + 1);
offset = -offset;
}
hourFormat = hourFormat
.replaceFirst("H+", (isShort ? "\\%1\\$d" : "\\%1\\$02d"))
.replaceFirst("m+", "\\%2\\$02d");
return MessageFormat.format(gmtFormat,
String.format(hourFormat, offset / 60, offset % 60));
}
}
}

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -129,7 +129,7 @@ public class JRELocaleProviderAdapter extends LocaleProviderAdapter implements R
private volatile CurrencyNameProvider currencyNameProvider;
private volatile LocaleNameProvider localeNameProvider;
private volatile TimeZoneNameProvider timeZoneNameProvider;
protected volatile TimeZoneNameProvider timeZoneNameProvider;
protected volatile CalendarDataProvider calendarDataProvider;
private volatile CalendarNameProvider calendarNameProvider;

View file

@ -50,11 +50,12 @@ public interface LocaleDataMetaInfo {
public String availableLanguageTags(String category);
/**
* Returns a map for short time zone ids in BCP47 Unicode extension and
* the long time zone ids.
* @return map of short id to long ids, separated by a space.
* Returns a map for time zone ids to their canonical ids.
* The map key is either an LDML's short id, or a valid
* TZDB zone id.
* @return map of ids to their canonical ids.
*/
default public Map<String, String> tzShortIDs() {
default public Map<String, String> tzCanonicalIDs() {
return null;
}
}

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -52,6 +52,7 @@ import java.util.ResourceBundle;
import java.util.Set;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import sun.security.action.GetPropertyAction;
import sun.util.calendar.ZoneInfo;
import sun.util.resources.LocaleData;
import sun.util.resources.OpenListResourceBundle;
@ -87,6 +88,9 @@ public class LocaleResources {
private static final String NUMBER_PATTERNS_CACHEKEY = "NP";
private static final String DATE_TIME_PATTERN = "DTP.";
// TimeZoneNamesBundle exemplar city prefix
private static final String TZNB_EXCITY_PREFIX = "timezone.excity.";
// null singleton cache value
private static final Object NULLOBJECT = new Object();
@ -254,23 +258,32 @@ public class LocaleResources {
return (String) localeName;
}
String[] getTimeZoneNames(String key) {
String[] names = null;
String cacheKey = TIME_ZONE_NAMES + '.' + key;
public Object getTimeZoneNames(String key) {
Object val = null;
String cacheKey = TIME_ZONE_NAMES + key;
removeEmptyReferences();
ResourceReference data = cache.get(cacheKey);
if (Objects.isNull(data) || Objects.isNull((names = (String[]) data.get()))) {
if (Objects.isNull(data) || Objects.isNull(val = data.get())) {
TimeZoneNamesBundle tznb = localeData.getTimeZoneNames(locale);
if (tznb.containsKey(key)) {
names = tznb.getStringArray(key);
if (key.startsWith(TZNB_EXCITY_PREFIX)) {
val = tznb.getString(key);
assert val instanceof String;
trace("tznb: %s key: %s, val: %s\n", tznb, key, val);
} else {
String[] names = tznb.getStringArray(key);
trace("tznb: %s key: %s, names: %s, %s, %s, %s, %s, %s, %s\n", tznb, key,
names[0], names[1], names[2], names[3], names[4], names[5], names[6]);
val = names;
}
cache.put(cacheKey,
new ResourceReference(cacheKey, (Object) names, referenceQueue));
new ResourceReference(cacheKey, val, referenceQueue));
}
}
return names;
return val;
}
@SuppressWarnings("unchecked")
@ -296,7 +309,9 @@ public class LocaleResources {
// Use a LinkedHashSet to preseve the order
Set<String[]> value = new LinkedHashSet<>();
for (String key : keyset) {
value.add(rb.getStringArray(key));
if (!key.startsWith(TZNB_EXCITY_PREFIX)) {
value.add(rb.getStringArray(key));
}
}
// Add aliases data for CLDR
@ -514,4 +529,13 @@ public class LocaleResources {
return cacheKey;
}
}
private static final boolean TRACE_ON = Boolean.valueOf(
GetPropertyAction.privilegedGetProperty("locale.resources.debug", "false"));
public static void trace(String format, Object... params) {
if (TRACE_ON) {
System.out.format(format, params);
}
}
}

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2012, 2015, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2012, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -30,7 +30,6 @@ import java.util.Objects;
import java.util.Set;
import java.util.TimeZone;
import java.util.spi.TimeZoneNameProvider;
import sun.util.calendar.ZoneInfoFile;
/**
* Concrete implementation of the
@ -43,9 +42,8 @@ import sun.util.calendar.ZoneInfoFile;
public class TimeZoneNameProviderImpl extends TimeZoneNameProvider {
private final LocaleProviderAdapter.Type type;
private final Set<String> langtags;
private static final String CLDR_NO_INHERITANCE_MARKER = "\u2205\u2205\u2205";
TimeZoneNameProviderImpl(LocaleProviderAdapter.Type type, Set<String> langtags) {
protected TimeZoneNameProviderImpl(LocaleProviderAdapter.Type type, Set<String> langtags) {
this.type = type;
this.langtags = langtags;
}
@ -120,41 +118,23 @@ public class TimeZoneNameProviderImpl extends TimeZoneNameProvider {
return null;
}
private String[] getDisplayNameArray(String id, Locale locale) {
protected String[] getDisplayNameArray(String id, Locale locale) {
Objects.requireNonNull(id);
Objects.requireNonNull(locale);
String[] ret =
LocaleProviderAdapter.forType(type).getLocaleResources(locale).getTimeZoneNames(id);
if (Objects.nonNull(ret) && type == LocaleProviderAdapter.Type.CLDR) {
// check for CLDR's "no inheritance marker"
for (int index = 0; index < ret.length; index++) {
TimeZone tz = null;
if (CLDR_NO_INHERITANCE_MARKER.equals(ret[index])) {
if (Objects.isNull(tz)) {
tz = TimeZone.getTimeZone(id);
}
int offset = tz.getRawOffset();
if (index == 3 || index == 4) { // daylight
offset += tz.getDSTSavings();
}
ret[index] = ZoneInfoFile.toCustomID(offset);
}
}
}
return ret;
return (String []) LocaleProviderAdapter.forType(type)
.getLocaleResources(locale)
.getTimeZoneNames(id);
}
/**
* Returns a String[][] as the DateFormatSymbols.getZoneStrings() value for
* the given locale. This method is package private.
* the given locale.
*
* @param locale a Locale for time zone names
* @return an array of time zone names arrays
*/
String[][] getZoneStrings(Locale locale) {
protected String[][] getZoneStrings(Locale locale) {
return LocaleProviderAdapter.forType(type).getLocaleResources(locale).getZoneStrings();
}
}

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2017, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -162,9 +162,15 @@ public final class TimeZoneNameUtility {
* @return the tzdb's time zone ID
*/
public static Optional<String> convertLDMLShortID(String shortID) {
return canonicalTZID(shortID);
}
/**
* Returns the canonical ID for the given ID
*/
public static Optional<String> canonicalTZID(String id) {
return ((CLDRLocaleProviderAdapter)LocaleProviderAdapter.forType(Type.CLDR))
.getTimeZoneID(shortID)
.map(id -> id.replaceAll("\\s.*", ""));
.canonicalTZID(id);
}
private static String[] retrieveDisplayNamesImpl(String id, Locale locale) {

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 1996, 2016, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 1996, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -275,11 +275,6 @@ public class LocaleData {
}
}
}
// Force fallback to Locale.ENGLISH for CLDR time zone names support
if (locale.getLanguage() != "en"
&& type == CLDR && category.equals("TimeZoneNames")) {
candidates.add(candidates.size() - 1, Locale.ENGLISH);
}
CANDIDATES_MAP.putIfAbsent(key, candidates);
}
return candidates;

View file

@ -1,5 +1,5 @@
/*
* Copyright (c) 2005, 2012, Oracle and/or its affiliates. All rights reserved.
* Copyright (c) 2005, 2018, Oracle and/or its affiliates. All rights reserved.
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
*
* This code is free software; you can redistribute it and/or modify it
@ -79,15 +79,16 @@ public abstract class TimeZoneNamesBundle extends OpenListResourceBundle {
*/
@Override
public Object handleGetObject(String key) {
String[] contents = (String[]) super.handleGetObject(key);
if (Objects.isNull(contents)) {
return null;
Object val = super.handleGetObject(key);
if (val instanceof String[]) {
String[] contents = (String[]) val;
int clen = contents.length;
String[] tmpobj = new String[7];
tmpobj[0] = key;
System.arraycopy(contents, 0, tmpobj, 1, clen);
return tmpobj;
}
int clen = contents.length;
String[] tmpobj = new String[7];
tmpobj[0] = key;
System.arraycopy(contents, 0, tmpobj, 1, clen);
return tmpobj;
return val;
}
/**