Skip to content

OF-3137: setup page: select locale from browser #3050

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
stokito wants to merge 7 commits into
base: main
Choose a base branch
from
+114 −287
Open

OF-3137: setup page: select locale from browser #3050

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
eb972eb
OF-3137: Don't assume English as a server version
stokito Oct 13, 2025
1b89af5
OF-3137: Remove unused usingPreset
stokito Oct 13, 2025
ddca9c2
OF-3137: Setup locale: set page context locale early
stokito Oct 13, 2025
58fc08a
OF-3137: locale selectors: remove zh-Hans image
stokito Oct 13, 2025
8d62f31
OF-3137: Setup locale: render locales from list
stokito Oct 13, 2025
89b02a2
OF-3137: setup language pre-select locale to user's browser locale
stokito Oct 14, 2025
3718b94
LocaleUtils: micro optimizations
stokito Oct 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion distribution/src/conf/openfire.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
<securePort>9091</securePort>
</adminConsole>

<locale>en</locale>
<locale></locale>

<!-- Network settings. By default, Openfire will bind to all network interfaces.
Alternatively, you can specify a specific network interfaces that the server
Expand Down
72 changes: 70 additions & 2 deletions xmppserver/src/main/java/org/jivesoftware/util/LocaleUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,8 @@
import java.util.*;
import java.util.concurrent.ConcurrentHashMap;

import static org.apache.commons.lang3.StringUtils.substringBefore;

/**
* A set of methods for retrieving and converting locale specific strings and numbers.
*
Expand Down Expand Up @@ -159,7 +161,7 @@ public static Locale localeCodeToLocale(String localeCode) {
};

// A mapping from the supported timezone ids to friendly english names.
private static final Map<String, String> nameMap = new HashMap<>();
private static final Map<String, String> nameMap = new HashMap<>(75);

static {
nameMap.put(timeZoneIds[0], "International Date Line West");
Expand Down Expand Up @@ -239,6 +241,72 @@ public static Locale localeCodeToLocale(String localeCode) {
nameMap.put(timeZoneIds[74], "Nuku'alofa");
}

private static final Map<String, String> supportedLocales = new LinkedHashMap<>(20);
static {
supportedLocales.put("cs_CZ", "Czech");
supportedLocales.put("de", "Deutsch");
supportedLocales.put("en", "English");
supportedLocales.put("es", "Español");
supportedLocales.put("fa_IR", "فارسی");
supportedLocales.put("fr", "Français");
supportedLocales.put("he", "עברית");
supportedLocales.put("it_IT", "Italiano");
supportedLocales.put("ja_JP", "日本語");
supportedLocales.put("nl", "Nederlands");
supportedLocales.put("pl_PL", "Polski");
supportedLocales.put("pt_PT", "Português Portugal");
supportedLocales.put("pt_BR", "Português Brasileiro");
supportedLocales.put("ru_RU", "Русский");
supportedLocales.put("sk", "Slovenčina");
supportedLocales.put("sv", "Svenska");
supportedLocales.put("tr_TR", "Türkçe");
supportedLocales.put("uk_UA", "Українська");
supportedLocales.put("zh_CN", "中文简体");
}

/**
* Get list of locales (code: name) that the web admin has translations for.
*/
public static Map<String, String> getSupportedLocales() {
return supportedLocales;
}

/**
* Find the preferred locale from user browser from list of supported.
*/
public static String bestMatchingSupportedLocale(Enumeration<Locale> requestLocales) {
// build lang codes haystack "pt_BR pt_PT pt_ "
String localesList = "";
while (requestLocales.hasMoreElements()){
Locale locale = requestLocales.nextElement();
localesList += locale.getLanguage() + "_" + locale.getCountry() + " ";
}
int bestMatchPos = Integer.MAX_VALUE;
String matchedLocale = null;
for (Map.Entry<String, String> entry : supportedLocales.entrySet()) {
// first match by lang and country, if no then try to match by only language
String localeCode = entry.getKey(); // e.g. pt_BR
int matchPos = localesList.indexOf(localeCode + " ");
if (matchPos < 0) {
// match by lang only i.e, no country
String lang = substringBefore(localeCode, "_");
matchPos = localesList.indexOf(lang + "_ ");
if (matchPos < 0) {
continue;
}
}
if (matchPos < bestMatchPos) {
bestMatchPos = matchPos;
matchedLocale = localeCode;
}
}
if (matchedLocale != null) {
return matchedLocale;
}
// if no match then take server default locale
return JiveGlobals.getLocale().toString();
}

/**
* Returns a list of all available time zone's as a String [][]. The first
* entry in each list item is the timeZoneID, and the second is the
Expand Down Expand Up @@ -355,7 +423,7 @@ public static boolean isLocalizedTextRTL() {
// This is obviously not something that's re-usable outside of Openfire. However, this includes all languages
// for which we provide translations.
String language = JiveGlobals.getLocale().getLanguage();
return language.equals(new Locale("he").getLanguage()) || language.equals(new Locale("fa").getLanguage());
return language.equals("he") || language.equals("fa");
}


Expand Down
Binary file removed xmppserver/src/main/webapp/images/setup_language_zh_CN.gif
View file
Open in desktop
Binary file not shown.
184 changes: 10 additions & 174 deletions xmppserver/src/main/webapp/server-locale.jsp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,7 @@
- limitations under the License.
--%>
<%@ page contentType="text/html; charset=UTF-8" %>
<%@ page import="java.util.HashMap" %>
<%@ page import="java.util.Locale" %>
<%@ page import="java.util.Map" %>
<%@ page import="java.util.TimeZone" %>
<%@ page import="java.util.*" %>
<%@ page import="org.jivesoftware.util.CookieUtils" %>
<%@ page import="org.jivesoftware.util.JiveGlobals" %>
<%@ page import="org.jivesoftware.util.LocaleUtils" %>
Expand Down Expand Up @@ -81,7 +78,9 @@
}
}

pageContext.setAttribute( "locales", LocaleUtils.getSupportedLocales() );
Locale locale = JiveGlobals.getLocale();
pageContext.setAttribute( "locale", locale.toString() );

// Get the time zone list.
String[][] timeZones = LocaleUtils.getTimeZoneList();
Expand Down Expand Up @@ -120,181 +119,18 @@
</div>
<div class="jive-contentBox">
<p>
<b><fmt:message key="locale.current" />:</b> <%= locale.getDisplayName(locale) %> /
<b><fmt:message key="locale.current" />:</b> ${locales[locale]} /
<%= LocaleUtils.getTimeZoneName(JiveGlobals.getTimeZone().getID(), locale) %>
</p>

<% boolean usingPreset;
Locale[] locales = Locale.getAvailableLocales();
for (Locale locale1 : locales) {
usingPreset = locale1.equals(locale);
if (usingPreset) {
break;
}
}
%>

<p><b><fmt:message key="language.choose" />:</b></p>

<table>
<tbody>
<tr>
<td>
<input type="radio" name="localeCode" value="cs_CZ" <%= ("cs_CZ".equals(locale.toString()) ? "checked" : "") %> id="cs_CZ" />
</td>
<td colspan="2">
<label for="cs_CZ">Czech (cs_CZ)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="de" <%= ("de".equals(locale.toString()) ? "checked" : "") %> id="de" />
</td>
<td colspan="2">
<label for="de">Deutsch (de)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="en" <%= ("en".equals(locale.toString()) ? "checked" : "") %> id="en" />
</td>
<td colspan="2">
<label for="en">English (en)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="es" <%= ("es".equals(locale.toString()) ? "checked" : "") %> id="es" />
</td>
<td colspan="2">
<label for="es">Espa&ntilde;ol (es)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="fa_IR" <%= ("fa_IR".equals(locale.toString()) ? "checked" : "") %> id="fa_IR" />
</td>
<td colspan="2">
<label for="fa_IR">فارسی (fa_IR)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="fr" <%= ("fr".equals(locale.toString()) ? "checked" : "") %> id="fr" />
</td>
<td colspan="2">
<label for="fr">Fran&ccedil;ais (fr)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="he" <%= ("he".equals(locale.toString()) ? "checked" : "") %> id="he" />
</td>
<td colspan="2">
<label for="he">עברית (he)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="it_IT" <%= ("it_IT".equals(locale.toString()) ? "checked" : "") %> id="it_IT" />
</td>
<td colspan="2">
<label for="it_IT">Italiano (it_IT)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="ja_JP" <%= ("ja_JP".equals(locale.toString()) ? "checked" : "") %> id="ja_JP" />
</td>
<td colspan="2">
<label for="ja_JP">日本語 (ja_JP)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="nl" <%= ("nl".equals(locale.toString()) ? "checked" : "") %> id="nl" />
</td>
<td colspan="2">
<label for="nl">Nederlands (nl)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="pl_PL" <%= ("pl_PL".equals(locale.toString()) ? "checked" : "") %> id="pl_PL" />
</td>
<td colspan="2">
<label for="pl_PL">Polski (pl_PL)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="pt_PT" <%= ("pt_PT".equals(locale.toString()) ? "checked" : "") %> id="pt_PT" />
</td>
<td colspan="2">
<label for="pt_PT">Portugu&ecirc;s Portugal (pt_PT)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="pt_BR" <%= ("pt_BR".equals(locale.toString()) ? "checked" : "") %> id="pt_BR" />
</td>
<td colspan="2">
<label for="pt_BR">Portugu&ecirc;s Brasileiro (pt_BR)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="ru_RU" <%= ("ru_RU".equals(locale.toString()) ? "checked" : "") %> id="ru_RU" />
</td>
<td colspan="2">
<label for="ru_RU">&#x420;&#x443;&#x441;&#x441;&#x43A;&#x438;&#x439; (ru_RU)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="sk" <%= ("sk".equals(locale.toString()) ? "checked" : "") %> id="sk" />
</td>
<td colspan="2">
<label for="sk">Sloven&#269;ina (sk)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="sv" <%= ("sv".equals(locale.toString()) ? "checked" : "") %> id="sv" />
</td>
<td colspan="2">
<label for="sv">Svenska (sv)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="tr_TR" <%= ("tr_TR".equals(locale.toString()) ? "checked" : "") %> id="tr_TR" />
</td>
<td colspan="2">
<label for="tr_TR">Türkçe (tr_TR)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="uk_UA" <%= ("uk_UA".equals(locale.toString()) ? "checked" : "") %> id="uk_UA" />
</td>
<td colspan="2">
<label for="uk_UA">Українська (uk_UA)</label>
</td>
</tr>
<tr>
<td>
<input type="radio" name="localeCode" value="zh_CN" <%= ("zh_CN".equals(locale.toString()) ? "checked" : "") %> id="zh_CN" />
</td>
<td>
<a href="#" onclick="document.sform.localeCode[1].checked=true; return false;"><img src="images/language_zh_CN.gif" alt="" /></a>
</td>
<td>
<label for="zh_CN">Simplified Chinese (zh_CN)</label>
</td>
</tr>
</tbody>
</table>
<c:forEach var="l" items="${locales}">
<label for="${l.key}">
<input type="radio" name="localeCode" value="${l.key}" ${locale eq l.key ? 'checked' : ''} id="${l.key}"/>
<b>${l.value}</b> (${l.key})
</label><br>
</c:forEach>

<br>

Expand Down
Loading
Loading