jdk/src/java.base/share/classes/sun/util/cldr/CLDRTimeZoneNameProviderImpl.java
2024-09-16 20:03:00 +00:00

306 lines
11 KiB
Java

/*
* Copyright (c) 2018, 2024, 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.time.Duration;
import java.time.Instant;
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 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[] namesSuper = super.getDisplayNameArray(id, locale);
if (namesSuper == null) {
// try canonical id instead
namesSuper = super.getDisplayNameArray(
TimeZoneNameUtility.canonicalTZID(id).orElse(id),
locale);
}
if (namesSuper != null) {
// CLDR's resource bundle has a translated entry for this id.
// Fix up names if needed, either missing or no-inheritance
namesSuper[INDEX_TZID] = id;
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,
TimeZone.getTimeZone(id).toZoneId().getRules().isFixedOffset());
break;
case NO_INHERITANCE_MARKER:
// CLDR's "no inheritance marker"
namesSuper[i] = toGMTFormat(id, i == INDEX_DST_LONG || i == INDEX_DST_SHORT,
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) {
String[][] ret = super.getZoneStrings(locale);
// Fill in for the empty names.
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) {
boolean noDST = TimeZone.getTimeZone(names[0]).toZoneId().getRules().isFixedOffset();
for (int i = INDEX_STD_LONG; i <= INDEX_GEN_SHORT; i++) {
deriveFallbackName(names, i, locale, noDST);
}
}
private void deriveFallbackName(String[] names, int index, Locale locale, boolean noDST) {
String id = names[INDEX_TZID];
if (exists(names, index)) {
if (names[index].equals(NO_INHERITANCE_MARKER)) {
// CLDR's "no inheritance marker"
names[index] = toGMTFormat(id,
index == INDEX_DST_LONG || index == INDEX_DST_SHORT,
locale);
}
return;
}
// Check parent locales first
if (!exists(names, index)) {
var cands = ((CLDRLocaleProviderAdapter)LocaleProviderAdapter.forType(Type.CLDR))
.getCandidateLocales("", locale);
for (int i = 1; i < cands.size() ; i++) {
var loc = cands.get(i);
String[] parentNames = super.getDisplayNameArray(id, loc);
if (parentNames != null && !parentNames[index].isEmpty()) {
// Long names in ROOT locale should not be copied, as they can be generated
// with the fallback mechanisms below
if (!loc.equals(Locale.ROOT) || index % 2 == 0) {
names[index] = parentNames[index];
return;
}
}
}
}
// Type Fallback
if (noDST && typeFallback(names, index)) {
return;
}
// Region Fallback
if (regionFormatFallback(names, index, locale)) {
return;
}
// last resort
names[index] = toGMTFormat(id,
index == INDEX_DST_LONG || index == INDEX_DST_SHORT,
locale);
// aliases of "GMT" timezone.
if ((exists(names, INDEX_STD_LONG)) && (id.startsWith("Etc/")
|| id.startsWith("GMT") || id.startsWith("Greenwich"))) {
switch (id) {
case "Etc/GMT":
case "Etc/GMT-0":
case "Etc/GMT+0":
case "Etc/GMT0":
case "GMT+0":
case "GMT-0":
case "GMT0":
case "Greenwich":
names[INDEX_DST_LONG] = names[INDEX_GEN_LONG] = names[INDEX_STD_LONG];
break;
}
}
}
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[genIndex].startsWith("GMT")) {
names[index] = names[genIndex];
} else {
// check standard
int stdIndex = INDEX_STD_SHORT - index % 2;
if (!exists(names, index) && exists(names, stdIndex) && !names[stdIndex].startsWith("GMT")) {
names[index] = names[stdIndex];
}
}
return exists(names, index);
}
private boolean regionFormatFallback(String[] names, int index, Locale l) {
if (index % 2 == 0) {
// ignore short names
return false;
}
String id = names[INDEX_TZID];
LocaleResources lr = LocaleProviderAdapter.forType(Type.CLDR).getLocaleResources(l);
ResourceBundle fd = lr.getJavaTimeFormatData();
id = TimeZoneNameUtility.canonicalTZID(id).orElse(id);
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, Locale l) {
LocaleResources lr = LocaleProviderAdapter.forType(Type.CLDR).getLocaleResources(l);
ResourceBundle fd = lr.getJavaTimeFormatData();
var zi = ZoneInfoFile.getZoneInfo(id);
if (zi == null) {
return fd.getString("timezone.gmtZeroFormat");
}
var zr = zi.toZoneId().getRules();
var now = Instant.now();
var saving = zr.getTransitions().reversed().stream()
.dropWhile(zot -> zot.getInstant().isAfter(now))
.filter(zot -> zr.isDaylightSavings(zot.getInstant()))
.findFirst()
.map(zot -> zr.getDaylightSavings(zot.getInstant()))
.map(Duration::getSeconds)
.map(Long::intValue)
.orElse(0);
int offset = (zr.getStandardOffset(now).getTotalSeconds() +
(daylight ? saving : 0)) / 60;
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+", "\\%1\\$02d")
.replaceFirst("m+", "\\%2\\$02d");
return MessageFormat.format(gmtFormat,
String.format(l, hourFormat, offset / 60, offset % 60));
}
}
}