1 /*
   2  * Copyright (c) 2012, Oracle and/or its affiliates. All rights reserved.
   3  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
   4  *
   5  * This code is free software; you can redistribute it and/or modify it
   6  * under the terms of the GNU General Public License version 2 only, as
   7  * published by the Free Software Foundation.  Oracle designates this
   8  * particular file as subject to the "Classpath" exception as provided
   9  * by Oracle in the LICENSE file that accompanied this code.
  10  *
  11  * This code is distributed in the hope that it will be useful, but WITHOUT
  12  * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13  * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14  * version 2 for more details (a copy is included in the LICENSE file that
  15  * accompanied this code).
  16  *
  17  * You should have received a copy of the GNU General Public License version
  18  * 2 along with this work; if not, write to the Free Software Foundation,
  19  * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
  20  *
  21  * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
  22  * or visit www.oracle.com if you need additional information or have any
  23  * questions.
  24  */
  25 
  26 package sun.util.locale.provider;
  27 
  28 import java.security.AccessController;
  29 import java.text.spi.BreakIteratorProvider;
  30 import java.text.spi.CollatorProvider;
  31 import java.text.spi.DateFormatProvider;
  32 import java.text.spi.DateFormatSymbolsProvider;
  33 import java.text.spi.DecimalFormatSymbolsProvider;
  34 import java.text.spi.NumberFormatProvider;
  35 import java.util.ArrayList;
  36 import java.util.List;
  37 import java.util.Locale;
  38 import java.util.ResourceBundle;
  39 import java.util.Set;
  40 import java.util.spi.CalendarDataProvider;
  41 import java.util.spi.CurrencyNameProvider;
  42 import java.util.spi.LocaleNameProvider;
  43 import java.util.spi.LocaleServiceProvider;
  44 import java.util.spi.TimeZoneNameProvider;
  45 import sun.util.cldr.CLDRLocaleProviderAdapter;
  46 import sun.util.resources.LocaleData;
  47 
  48 /**
  49  * The LocaleProviderAdapter abstract class.
  50  *
  51  * @author Naoto Sato
  52  * @author Masayoshi Okutsu
  53  */
  54 public abstract class LocaleProviderAdapter {
  55     /**
  56      * Adapter type.
  57      */
  58     public static enum Type {
  59         JRE("sun.util.resources", "sun.text.resources"),
  60         CLDR("sun.util.resources.cldr", "sun.text.resources.cldr"),
  61         SPI,
  62         HOST,
  63         FALLBACK("sun.util.resources", "sun.text.resources");
  64 
  65         private final String UTIL_RESOURCES_PACKAGE;
  66         private final String TEXT_RESOURCES_PACKAGE;
  67 
  68         private Type() {
  69             this(null, null);
  70         }
  71 
  72         private Type(String util, String text) {
  73             UTIL_RESOURCES_PACKAGE = util;
  74             TEXT_RESOURCES_PACKAGE = text;
  75         }
  76 
  77         public String getUtilResourcesPackage() {
  78             return UTIL_RESOURCES_PACKAGE;
  79         }
  80 
  81         public String getTextResourcesPackage() {
  82             return TEXT_RESOURCES_PACKAGE;
  83         }
  84     }
  85 
  86     /**
  87      * LocaleProviderAdapter preference list. The default list is intended
  88      * to behave the same manner in JDK7.
  89      */
  90     private static Type[] adapterPreference = {
  91         Type.JRE,
  92         Type.SPI,
  93     };
  94 
  95     /**
  96      * JRE Locale Data Adapter instance
  97      */
  98     private static LocaleProviderAdapter jreLocaleProviderAdapter = new JRELocaleProviderAdapter();
  99 
 100     /**
 101      * SPI Locale Data Adapter instance
 102      */
 103     private static LocaleProviderAdapter spiLocaleProviderAdapter = new SPILocaleProviderAdapter();
 104 
 105     /**
 106      * CLDR Locale Data Adapter instance, if any.
 107      */
 108     private static LocaleProviderAdapter cldrLocaleProviderAdapter = null;
 109 
 110     /**
 111      * HOST Locale Data Adapter instance, if any.
 112      */
 113     private static LocaleProviderAdapter hostLocaleProviderAdapter = null;
 114 
 115     /**
 116      * FALLBACK Locale Data Adapter instance. It's basically the same with JRE, but only kicks
 117      * in for the root locale.
 118      */
 119     private static LocaleProviderAdapter fallbackLocaleProviderAdapter = null;
 120 
 121     static {
 122         String order = AccessController.doPrivileged(
 123                            new sun.security.action.GetPropertyAction("java.locale.providers"));
 124         // Override adapterPreference with the properties one
 125         if (order != null && order.length() != 0) {
 126             String[] types = order.split(",");
 127             List<Type> typeList = new ArrayList<>();
 128             for (String type : types) {
 129                 try {
 130                     Type aType = Type.valueOf(type.trim().toUpperCase(Locale.ROOT));
 131 
 132                     // load adapter if necessary
 133                     switch (aType) {
 134                         case CLDR:
 135                             cldrLocaleProviderAdapter = new CLDRLocaleProviderAdapter();
 136                             break;
 137                         case HOST:
 138                             hostLocaleProviderAdapter = new HostLocaleProviderAdapter();
 139                             break;
 140                     }
 141                     typeList.add(aType);
 142                 } catch (IllegalArgumentException | UnsupportedOperationException e) {
 143                     // could be caused by the user specifying wrong
 144                     // provider name or format in the system property
 145                     LocaleServiceProviderPool.config(LocaleProviderAdapter.class, e.toString());
 146                 }
 147             }
 148 
 149             if (!typeList.contains(Type.JRE)) {
 150                 // Append FALLBACK as the last resort.
 151                 fallbackLocaleProviderAdapter = new FallbackLocaleProviderAdapter();
 152                 typeList.add(Type.FALLBACK);
 153             }
 154             adapterPreference = typeList.toArray(new Type[0]);
 155         }
 156     }
 157 
 158 
 159     /**
 160      * Returns the singleton instance for each adapter type
 161      */
 162     public static LocaleProviderAdapter forType(Type type) {
 163         switch (type) {
 164         case JRE:
 165             return jreLocaleProviderAdapter;
 166         case CLDR:
 167             return cldrLocaleProviderAdapter;
 168         case SPI:
 169             return spiLocaleProviderAdapter;
 170         case HOST:
 171             return hostLocaleProviderAdapter;
 172         case FALLBACK:
 173             return fallbackLocaleProviderAdapter;
 174         default:
 175             throw new InternalError("unknown locale data adapter type");
 176         }
 177     }
 178 
 179     public static LocaleProviderAdapter forJRE() {
 180         return jreLocaleProviderAdapter;
 181     }
 182 
 183     public static LocaleProviderAdapter getResourceBundleBased() {
 184         for (Type type : getAdapterPreference()) {
 185             if (type == Type.JRE || type == Type.CLDR || type == Type.FALLBACK) {
 186                 return forType(type);
 187             }
 188         }
 189         // Shouldn't happen.
 190         throw new InternalError();
 191     }
 192     /**
 193      * Returns the preference order of LocaleProviderAdapter.Type
 194      */
 195     public static Type[] getAdapterPreference() {
 196         return adapterPreference;
 197     }
 198 
 199     /**
 200      * Returns a LocaleProviderAdapter for the given locale service provider that
 201      * best matches the given locale. This method returns the LocaleProviderAdapter
 202      * for JRE if none is found for the given locale.
 203      *
 204      * @param providerClass the class for the locale service provider
 205      * @param locale the desired locale.
 206      * @return a LocaleProviderAdapter
 207      */
 208     public static LocaleProviderAdapter getAdapter(Class<? extends LocaleServiceProvider> providerClass,
 209                                                Locale locale) {
 210         // Fast look-up for the given locale
 211         LocaleProviderAdapter adapter = findAdapter(providerClass, locale);
 212         if (adapter != null) {
 213             return adapter;
 214         }
 215 
 216         // Try finding an adapter in the normal candidate locales path of the given locale.
 217         List<Locale> lookupLocales = ResourceBundle.Control.getControl(ResourceBundle.Control.FORMAT_DEFAULT)
 218                                         .getCandidateLocales("", locale);
 219         for (Locale loc : lookupLocales) {
 220             if (loc.equals(locale)) {
 221                 // We've already done with this loc.
 222                 continue;
 223             }
 224             adapter = findAdapter(providerClass, loc);
 225             if (adapter != null) {
 226                 return adapter;
 227             }
 228         }
 229 
 230         // returns the adapter for FALLBACK as the last resort
 231         if (fallbackLocaleProviderAdapter == null) {
 232             fallbackLocaleProviderAdapter = new FallbackLocaleProviderAdapter();
 233         }
 234         return fallbackLocaleProviderAdapter;
 235     }
 236 
 237     private static LocaleProviderAdapter findAdapter(Class<? extends LocaleServiceProvider> providerClass,
 238                                                  Locale locale) {
 239         for (Type type : getAdapterPreference()) {
 240             LocaleProviderAdapter adapter = forType(type);
 241             LocaleServiceProvider provider = adapter.getLocaleServiceProvider(providerClass);
 242             if (provider != null) {
 243                 if (provider.isSupportedLocale(locale)) {
 244                     return adapter;
 245                 }
 246             }
 247         }
 248         return null;
 249     }
 250 
 251     /**
 252      * A utility method for implementing the default LocaleServiceProvider.isSupportedLocale
 253      * for the JRE, CLDR, and FALLBACK adapters.
 254      */
 255     static boolean isSupportedLocale(Locale locale, LocaleProviderAdapter.Type type, Set<String> langtags) {
 256         assert type == Type.JRE || type == Type.CLDR || type == Type.FALLBACK;
 257         if (locale == Locale.ROOT) {
 258             return true;
 259         }
 260 
 261         if (type == Type.FALLBACK) {
 262             // no other locales except ROOT are supported for FALLBACK
 263             return false;
 264         }
 265 
 266         locale = locale.stripExtensions();
 267         if (langtags.contains(locale.toLanguageTag())) {
 268             return true;
 269         }
 270         if (type == Type.JRE) {
 271             String oldname = locale.toString().replace('_', '-');
 272             return langtags.contains(oldname);
 273         }
 274         return false;
 275     }
 276 
 277     public static Locale[] toLocaleArray(Set<String> tags) {
 278         Locale[] locs = new Locale[tags.size() + 1];
 279         int index = 0;
 280         locs[index++] = Locale.ROOT;
 281         for (String tag : tags) {
 282             switch (tag) {
 283             case "ja-JP-JP":
 284                 locs[index++] = JRELocaleConstants.JA_JP_JP;
 285                 break;
 286             case "th-TH-TH":
 287                 locs[index++] = JRELocaleConstants.TH_TH_TH;
 288                 break;
 289             default:
 290                 locs[index++] = Locale.forLanguageTag(tag);
 291                 break;
 292             }
 293         }
 294         return locs;
 295     }
 296 
 297     /**
 298      * Returns the type of this LocaleProviderAdapter
 299      */
 300     public abstract LocaleProviderAdapter.Type getAdapterType();
 301 
 302     /**
 303      * Getter method for Locale Service Providers.
 304      */
 305     public abstract <P extends LocaleServiceProvider> P getLocaleServiceProvider(Class<P> c);
 306 
 307     /**
 308      * Returns a BreakIteratorProvider for this LocaleProviderAdapter, or null if no
 309      * BreakIteratorProvider is available.
 310      *
 311      * @return a BreakIteratorProvider
 312      */
 313     public abstract BreakIteratorProvider getBreakIteratorProvider();
 314 
 315     /**
 316      * Returns a ollatorProvider for this LocaleProviderAdapter, or null if no
 317      * ollatorProvider is available.
 318      *
 319      * @return a ollatorProvider
 320      */
 321     public abstract CollatorProvider getCollatorProvider();
 322 
 323     /**
 324      * Returns a DateFormatProvider for this LocaleProviderAdapter, or null if no
 325      * DateFormatProvider is available.
 326      *
 327      * @return a DateFormatProvider
 328      */
 329     public abstract DateFormatProvider getDateFormatProvider();
 330 
 331     /**
 332      * Returns a DateFormatSymbolsProvider for this LocaleProviderAdapter, or null if no
 333      * DateFormatSymbolsProvider is available.
 334      *
 335      * @return a DateFormatSymbolsProvider
 336      */
 337     public abstract DateFormatSymbolsProvider getDateFormatSymbolsProvider();
 338 
 339     /**
 340      * Returns a DecimalFormatSymbolsProvider for this LocaleProviderAdapter, or null if no
 341      * DecimalFormatSymbolsProvider is available.
 342      *
 343      * @return a DecimalFormatSymbolsProvider
 344      */
 345     public abstract DecimalFormatSymbolsProvider getDecimalFormatSymbolsProvider();
 346 
 347     /**
 348      * Returns a NumberFormatProvider for this LocaleProviderAdapter, or null if no
 349      * NumberFormatProvider is available.
 350      *
 351      * @return a NumberFormatProvider
 352      */
 353     public abstract NumberFormatProvider getNumberFormatProvider();
 354 
 355     /*
 356      * Getter methods for java.util.spi.* providers
 357      */
 358 
 359     /**
 360      * Returns a CurrencyNameProvider for this LocaleProviderAdapter, or null if no
 361      * CurrencyNameProvider is available.
 362      *
 363      * @return a CurrencyNameProvider
 364      */
 365     public abstract CurrencyNameProvider getCurrencyNameProvider();
 366 
 367     /**
 368      * Returns a LocaleNameProvider for this LocaleProviderAdapter, or null if no
 369      * LocaleNameProvider is available.
 370      *
 371      * @return a LocaleNameProvider
 372      */
 373     public abstract LocaleNameProvider getLocaleNameProvider();
 374 
 375     /**
 376      * Returns a TimeZoneNameProvider for this LocaleProviderAdapter, or null if no
 377      * TimeZoneNameProvider is available.
 378      *
 379      * @return a TimeZoneNameProvider
 380      */
 381     public abstract TimeZoneNameProvider getTimeZoneNameProvider();
 382 
 383     /**
 384      * Returns a CalendarDataProvider for this LocaleProviderAdapter, or null if no
 385      * CalendarDataProvider is available.
 386      *
 387      * @return a CalendarDataProvider
 388      */
 389     public abstract CalendarDataProvider getCalendarDataProvider();
 390 
 391     public abstract LocaleResources getLocaleResources(Locale locale);
 392 
 393     public abstract LocaleData getLocaleData();
 394 
 395     public abstract Locale[] getAvailableLocales();
 396 }