001
014
015 package com.liferay.portal.kernel.util;
016
017 import com.liferay.portal.kernel.language.LanguageUtil;
018 import com.liferay.portal.kernel.log.Log;
019 import com.liferay.portal.kernel.log.LogFactoryUtil;
020 import com.liferay.portal.kernel.security.pacl.permission.PortalRuntimePermission;
021
022 import java.util.Collection;
023 import java.util.HashMap;
024 import java.util.List;
025 import java.util.Locale;
026 import java.util.Map;
027 import java.util.Set;
028 import java.util.TreeMap;
029
030
035 public class LocaleUtil {
036
037 public static final Locale BRAZIL = new Locale("pt", "BR");
038
039 public static final Locale CANADA = Locale.CANADA;
040
041 public static final Locale CANADA_FRENCH = Locale.CANADA_FRENCH;
042
043 public static final Locale CHINA = Locale.CHINA;
044
045 public static final Locale CHINESE = Locale.CHINESE;
046
047 public static final Locale ENGLISH = Locale.ENGLISH;
048
049 public static final Locale FRANCE = Locale.FRANCE;
050
051 public static final Locale FRENCH = Locale.FRENCH;
052
053 public static final Locale GERMAN = Locale.GERMAN;
054
055 public static final Locale GERMANY = Locale.GERMANY;
056
057 public static final Locale HUNGARY = new Locale("hu", "HU");
058
059 public static final Locale ITALIAN = Locale.ITALIAN;
060
061 public static final Locale ITALY = Locale.ITALY;
062
063 public static final Locale JAPAN = Locale.JAPAN;
064
065 public static final Locale JAPANESE = Locale.JAPANESE;
066
067 public static final Locale KOREA = Locale.KOREA;
068
069 public static final Locale KOREAN = Locale.KOREAN;
070
071 public static final Locale NETHERLANDS = new Locale("nl", "NL");
072
073 public static final Locale PORTUGAL = new Locale("pt", "PT");
074
075 public static final Locale PRC = Locale.PRC;
076
077 public static final Locale ROOT = Locale.ROOT;
078
079 public static final Locale SIMPLIFIED_CHINESE = Locale.SIMPLIFIED_CHINESE;
080
081 public static final Locale SPAIN = new Locale("es", "ES");
082
083 public static final Locale TAIWAN = Locale.TAIWAN;
084
085 public static final Locale TRADITIONAL_CHINESE = Locale.TRADITIONAL_CHINESE;
086
087 public static final Locale UK = Locale.UK;
088
089 public static final Locale US = Locale.US;
090
091 public static boolean equals(Locale locale1, Locale locale2) {
092 return getInstance()._equals(locale1, locale2);
093 }
094
095 public static Locale fromLanguageId(String languageId) {
096 return getInstance()._fromLanguageId(languageId, true);
097 }
098
099 public static Locale fromLanguageId(String languageId, boolean validate) {
100 return getInstance()._fromLanguageId(languageId, validate);
101 }
102
103 public static Locale fromLanguageId(
104 String languageId, boolean validate, boolean useDefault) {
105
106 return getInstance()._fromLanguageId(languageId, validate, useDefault);
107 }
108
109 public static Locale[] fromLanguageIds(List<String> languageIds) {
110 return getInstance()._fromLanguageIds(languageIds);
111 }
112
113 public static Locale[] fromLanguageIds(String[] languageIds) {
114 return getInstance()._fromLanguageIds(languageIds);
115 }
116
117 public static Locale getDefault() {
118 return getInstance()._getDefault();
119 }
120
121 public static LocaleUtil getInstance() {
122 PortalRuntimePermission.checkGetBeanProperty(LocaleUtil.class);
123
124 return _instance;
125 }
126
127 public static Map<String, String> getISOLanguages(Locale locale) {
128 return getInstance()._getISOLanguages(locale);
129 }
130
131 public static String getLongDisplayName(
132 Locale locale, Set<String> duplicateLanguages) {
133
134 return getInstance()._getLongDisplayName(locale, duplicateLanguages);
135 }
136
137 public static Locale getMostRelevantLocale() {
138 return getInstance()._getMostRelevantLocale();
139 }
140
141 public static String getShortDisplayName(
142 Locale locale, Set<String> duplicateLanguages) {
143
144 return getInstance()._getShortDisplayName(locale, duplicateLanguages);
145 }
146
147 public static Locale getSiteDefault() {
148 return getInstance()._getSiteDefault();
149 }
150
151 public static void setDefault(
152 String userLanguage, String userCountry, String userVariant) {
153
154 getInstance()._setDefault(userLanguage, userCountry, userVariant);
155 }
156
157 public static String toBCP47LanguageId(Locale locale) {
158 return getInstance()._toBCP47LanguageId(locale);
159 }
160
161 public static String toBCP47LanguageId(String languageId) {
162 return getInstance()._toBCP47LanguageId(languageId);
163 }
164
165 public static String[] toBCP47LanguageIds(Locale[] locales) {
166 return getInstance()._toBCP47LanguageIds(locales);
167 }
168
169 public static String[] toBCP47LanguageIds(String[] languageIds) {
170 return getInstance()._toBCP47LanguageIds(languageIds);
171 }
172
173 public static String[] toDisplayNames(
174 Collection<Locale> locales, Locale locale) {
175
176 return getInstance()._toDisplayNames(locales, locale);
177 }
178
179 public static String toLanguageId(Locale locale) {
180 return getInstance()._toLanguageId(locale);
181 }
182
183 public static String[] toLanguageIds(Collection<Locale> locales) {
184 return getInstance()._toLanguageIds(locales);
185 }
186
187 public static String[] toLanguageIds(Locale[] locales) {
188 return getInstance()._toLanguageIds(locales);
189 }
190
191 public static String toW3cLanguageId(Locale locale) {
192 return getInstance()._toW3cLanguageId(locale);
193 }
194
195 public static String toW3cLanguageId(String languageId) {
196 return getInstance()._toW3cLanguageId(languageId);
197 }
198
199 public static String[] toW3cLanguageIds(Locale[] locales) {
200 return getInstance()._toW3cLanguageIds(locales);
201 }
202
203 public static String[] toW3cLanguageIds(String[] languageIds) {
204 return getInstance()._toW3cLanguageIds(languageIds);
205 }
206
207 private LocaleUtil() {
208 _locale = new Locale("en", "US");
209 }
210
211 private boolean _equals(Locale locale1, Locale locale2) {
212 String languageId1 = _toLanguageId(locale1);
213 String languageId2 = _toLanguageId(locale2);
214
215 return StringUtil.equalsIgnoreCase(languageId1, languageId2);
216 }
217
218 private Locale _fromLanguageId(String languageId, boolean validate) {
219 return _fromLanguageId(languageId, validate, true);
220 }
221
222 private Locale _fromLanguageId(
223 String languageId, boolean validate, boolean useDefault) {
224
225 if (languageId == null) {
226 if (useDefault) {
227 return _locale;
228 }
229 else {
230 return null;
231 }
232 }
233
234 Locale locale = _locales.get(languageId);
235
236 if (locale != null) {
237 return locale;
238 }
239
240 try {
241 int pos = languageId.indexOf(CharPool.UNDERLINE);
242
243 if (pos == -1) {
244 locale = new Locale(languageId);
245 }
246 else {
247 String[] languageIdParts = StringUtil.split(
248 languageId, CharPool.UNDERLINE);
249
250 String languageCode = languageIdParts[0];
251 String countryCode = languageIdParts[1];
252
253 String variant = null;
254
255 if (languageIdParts.length > 2) {
256 variant = languageIdParts[2];
257 }
258
259 if (Validator.isNotNull(variant)) {
260 locale = new Locale(languageCode, countryCode, variant);
261 }
262 else {
263 locale = new Locale(languageCode, countryCode);
264 }
265 }
266
267 if (validate && !LanguageUtil.isAvailableLocale(locale)) {
268 throw new IllegalArgumentException("Invalid locale " + locale);
269 }
270
271 _locales.put(languageId, locale);
272 }
273 catch (Exception e) {
274 locale = null;
275
276 if (_log.isWarnEnabled()) {
277 _log.warn(languageId + " is not a valid language id");
278 }
279 }
280
281 if ((locale == null) && useDefault) {
282 locale = _locale;
283 }
284
285 return locale;
286 }
287
288 private Locale[] _fromLanguageIds(List<String> languageIds) {
289 Locale[] locales = new Locale[languageIds.size()];
290
291 for (int i = 0; i < languageIds.size(); i++) {
292 locales[i] = _fromLanguageId(languageIds.get(i), true);
293 }
294
295 return locales;
296 }
297
298 private Locale[] _fromLanguageIds(String[] languageIds) {
299 Locale[] locales = new Locale[languageIds.length];
300
301 for (int i = 0; i < languageIds.length; i++) {
302 locales[i] = _fromLanguageId(languageIds[i], true);
303 }
304
305 return locales;
306 }
307
308 private Locale _getDefault() {
309 Locale locale = LocaleThreadLocal.getDefaultLocale();
310
311 if (locale != null) {
312 return locale;
313 }
314
315 return _locale;
316 }
317
318 private String _getDisplayName(
319 String language, String country, Locale locale,
320 Set<String> duplicateLanguages) {
321
322 String displayName = null;
323
324 if (duplicateLanguages.contains(locale.getLanguage())) {
325 displayName = StringUtil.appendParentheticalSuffix(
326 language, country);
327 }
328 else {
329 displayName = language;
330 }
331
332 if (LanguageUtil.isBetaLocale(locale)) {
333 displayName = displayName.concat(_BETA_SUFFIX);
334 }
335
336 return displayName;
337 }
338
339 private Map<String, String> _getISOLanguages(Locale locale) {
340 Map<String, String> isoLanguages = new TreeMap<>(
341 String.CASE_INSENSITIVE_ORDER);
342
343 for (String isoLanguageId : Locale.getISOLanguages()) {
344 Locale isoLocale = _fromLanguageId(isoLanguageId, true);
345
346 isoLanguages.put(
347 isoLocale.getDisplayLanguage(locale), isoLanguageId);
348 }
349
350 return isoLanguages;
351 }
352
353 private String _getLongDisplayName(
354 Locale locale, Set<String> duplicateLanguages) {
355
356 return _getDisplayName(
357 locale.getDisplayLanguage(locale), locale.getDisplayCountry(locale),
358 locale, duplicateLanguages);
359 }
360
361 private Locale _getMostRelevantLocale() {
362 Locale locale = LocaleThreadLocal.getThemeDisplayLocale();
363
364 if (locale == null) {
365 locale = _getDefault();
366 }
367
368 return locale;
369 }
370
371 private String _getShortDisplayName(
372 Locale locale, Set<String> duplicateLanguages) {
373
374 String language = locale.getDisplayLanguage(locale);
375
376 if (language.length() > 3) {
377 language = locale.getLanguage();
378 language = StringUtil.toUpperCase(language);
379 }
380
381 String country = locale.getCountry();
382
383 return _getDisplayName(
384 language, StringUtil.toUpperCase(country), locale,
385 duplicateLanguages);
386 }
387
388 private Locale _getSiteDefault() {
389 Locale locale = LocaleThreadLocal.getSiteDefaultLocale();
390
391 if (locale != null) {
392 return locale;
393 }
394
395 return _getDefault();
396 }
397
398 private void _setDefault(
399 String userLanguage, String userCountry, String userVariant) {
400
401 PortalRuntimePermission.checkSetBeanProperty(getClass());
402
403 if (Validator.isNotNull(userLanguage) &&
404 Validator.isNull(userCountry) && Validator.isNull(userVariant)) {
405
406 _locale = new Locale(userLanguage);
407 }
408 else if (Validator.isNotNull(userLanguage) &&
409 Validator.isNotNull(userCountry) &&
410 Validator.isNull(userVariant)) {
411
412 _locale = new Locale(userLanguage, userCountry);
413 }
414 else if (Validator.isNotNull(userLanguage) &&
415 Validator.isNotNull(userCountry) &&
416 Validator.isNotNull(userVariant)) {
417
418 _locale = new Locale(userLanguage, userCountry, userVariant);
419 }
420
421 LocaleThreadLocal.setDefaultLocale(_locale);
422 }
423
424 private String _toBCP47LanguageId(Locale locale) {
425 return _toBCP47LanguageId(_toLanguageId(locale));
426 }
427
428 private String _toBCP47LanguageId(String languageId) {
429 if (languageId.equals("zh_CN")) {
430 return "zh-Hans-CN";
431 }
432 else if (languageId.equals("zh_TW")) {
433 return "zh-Hant-TW";
434 }
435 else {
436 return StringUtil.replace(
437 languageId, CharPool.UNDERLINE, CharPool.MINUS);
438 }
439 }
440
441 private String[] _toBCP47LanguageIds(Locale[] locales) {
442 return _toBCP47LanguageIds(_toLanguageIds(locales));
443 }
444
445 private String[] _toBCP47LanguageIds(String[] languageIds) {
446 String[] bcp47LanguageIds = new String[languageIds.length];
447
448 for (int i = 0; i < languageIds.length; i++) {
449 bcp47LanguageIds[i] = _toBCP47LanguageId(languageIds[i]);
450 }
451
452 return bcp47LanguageIds;
453 }
454
455 private String[] _toDisplayNames(
456 Collection<Locale> locales, Locale locale) {
457
458 String[] displayNames = new String[locales.size()];
459
460 int i = 0;
461
462 for (Locale curLocale : locales) {
463 displayNames[i++] = curLocale.getDisplayName(locale);
464 }
465
466 return displayNames;
467 }
468
469 private String _toLanguageId(Locale locale) {
470 if (locale == null) {
471 locale = _locale;
472 }
473
474 String country = locale.getCountry();
475
476 boolean hasCountry = false;
477
478 if (country.length() != 0) {
479 hasCountry = true;
480 }
481
482 String variant = locale.getVariant();
483
484 boolean hasVariant = false;
485
486 if (variant.length() != 0) {
487 hasVariant = true;
488 }
489
490 if (!hasCountry && !hasVariant) {
491 return locale.getLanguage();
492 }
493
494 int length = 3;
495
496 if (hasCountry && hasVariant) {
497 length = 5;
498 }
499
500 StringBundler sb = new StringBundler(length);
501
502 sb.append(locale.getLanguage());
503
504 if (hasCountry) {
505 sb.append(StringPool.UNDERLINE);
506 sb.append(country);
507 }
508
509 if (hasVariant) {
510 sb.append(StringPool.UNDERLINE);
511 sb.append(variant);
512 }
513
514 return sb.toString();
515 }
516
517 private String[] _toLanguageIds(Collection<Locale> locales) {
518 String[] languageIds = new String[locales.size()];
519
520 int i = 0;
521
522 for (Locale locale : locales) {
523 languageIds[i++] = _toLanguageId(locale);
524 }
525
526 return languageIds;
527 }
528
529 private String[] _toLanguageIds(Locale[] locales) {
530 String[] languageIds = new String[locales.length];
531
532 for (int i = 0; i < locales.length; i++) {
533 languageIds[i] = _toLanguageId(locales[i]);
534 }
535
536 return languageIds;
537 }
538
539 private String _toW3cLanguageId(Locale locale) {
540 return _toW3cLanguageId(_toLanguageId(locale));
541 }
542
543 private String _toW3cLanguageId(String languageId) {
544 return StringUtil.replace(
545 languageId, CharPool.UNDERLINE, CharPool.MINUS);
546 }
547
548 private String[] _toW3cLanguageIds(Locale[] locales) {
549 return _toW3cLanguageIds(_toLanguageIds(locales));
550 }
551
552 private String[] _toW3cLanguageIds(String[] languageIds) {
553 String[] w3cLanguageIds = new String[languageIds.length];
554
555 for (int i = 0; i < languageIds.length; i++) {
556 w3cLanguageIds[i] = _toW3cLanguageId(languageIds[i]);
557 }
558
559 return w3cLanguageIds;
560 }
561
562 private static final String _BETA_SUFFIX = " [Beta]";
563
564 private static final Log _log = LogFactoryUtil.getLog(LocaleUtil.class);
565
566 private static final LocaleUtil _instance = new LocaleUtil();
567
568 private Locale _locale;
569 private final Map<String, Locale> _locales = new HashMap<>();
570
571 }