StringUtils#parseLocaleString(String) does not work for empty locale [SPR-6562]

[spring-projects-issues]

Cédrik LIME opened SPR-6562 and commented

StringUtils#parseLocaleString(String) is supposed to be the exact inverse operation to Locale.toString().
This is not the case for new Locale("", "", ""), which String representation is "", but which comes back as null from StringUtils.parseLocaleString("").
The parseLocaleString() method should be:

public static Locale parseLocaleString(String localeString) {
	if (localeString == null) {
		return null;
	}
	String[] parts = tokenizeToStringArray(localeString, "_ ", false, false);
	String language = (parts.length > 0 ? parts[0] : "");
	String country = (parts.length > 1 ? parts[1] : "");
	String variant = "";
	if (parts.length >= 2) {
		// There is definitely a variant, and it is everything after the country
		// code sans the separator between the country code and the variant.
		int endIndexOfCountryCode = localeString.indexOf(country) + country.length();
		// Strip off any leading '_' and whitespace, what's left is the variant.
		variant = trimLeadingWhitespace(localeString.substring(endIndexOfCountryCode));
		if (variant.startsWith("_")) {
			variant = trimLeadingCharacter(variant, '_');
		}
	}
	return new Locale(language, country, variant);
}

---

Affects: 2.5.6

Issue Links:

• LocaleEditor does not work with some locale strings [SPR-8099] #12754 LocaleEditor does not work with some locale strings
• Revise StringUtils.parseLocale(String) for proper handling of corner cases [SPR-16651] #21192 Revise StringUtils.parseLocale(String) for proper handling of corner cases
• StringUtils#parseLocaleString(String) with Variant when no Country [SPR-7598] #12254 StringUtils#parseLocaleString(String) with Variant when no Country ("is superseded by")

1 votes, 3 watchers

[spring-projects-issues]

Ivan commented

This function also doesn't correctly parses locales without country code.
For example code

Locale locale0 = new Locale("en", "", "var");
Locale locale = org.springframework.util.StringUtils.parseLocaleString(locale0.toString()); //parsing "en__var"
System.out.println(locale.equals(locale0));

will print 'false' ("VAR" will become language code after parsing) and it turns out that this is not a reverse function to java.util.Locale.toString();

I think this function must be completely reviewed.

[spring-projects-issues]

Antonio Mota commented

Yes, same here, I just solved this by using my own parseLocaleString

private Locale parseLocaleString(String localeString) {
	String[] parts = localeString.split("_",3);
	String language = (parts.length > 0 ? parts[0] : "");
	String country = (parts.length > 1 ? parts[1] : "");
	String variant = (parts.length > 2 ? parts[2] : "");
	return new Locale(language, country, variant);
}

doesn't work with ' ' as separator though but is easy to change it.

[spring-projects-issues]

Antonio Mota commented

Sorry about the mess...

 
	private Locale parseLocaleString(String localeString) {
		String[] parts = localeString.split("_",3);
		String language = (parts.length > 0 ? parts[0] : "");
		String country = (parts.length > 1 ? parts[1] : "");
		String variant = (parts.length > 2 ? parts[2] : "");
		return new Locale(language, country, variant);
	}

Maybe this should be enhanced to conform to the spec, that doesn't allow a variant without Country or Language.

[spring-projects-issues]

Antonio Mota commented

I just opened a new Jira, #12254 about this problem with the Variant with no Language or Country.

[spring-projects-issues]

David Mas commented

Related : https://jira.springsource.org/browse/SPR-8099

[spring-projects-issues]

Juergen Hoeller commented

As part of the current overhaul of the related StringUtils.parseLocale in #21192, it turns out that we do want to retain the null semantics for an empty locale, in particular since "empty" may also mean "invalid" in Locale.forLanguageTag which we're using by default now.