Conversations/src/main/java/eu/siacs/conversations/xml/LocalizedContent.java

58 lines
2.2 KiB
Java
Raw Normal View History

show language in message bubble if multiple language variants were received XML and by inheritence XMPP has the feature of transmitting multiple language variants for the same content. This can be really useful if, for example, you are talking to an automated system. A chat bot could greet you in your own language. On the wire this will usually look like this: ```xml <message to="you"> <body>Good morning</body> <body xml:lang="de">Guten Morgen</body> </message> ``` However receiving such a message in a group chat can be very confusing and potentially dangerous if the sender puts conflicting information in there and different people get shown different strings. Disabeling support for localization entirely isn’t an ideal solution as on principle it is still a good feature; and other clients might still show a localization even if Conversations would always show the default language. So instead Conversations now shows the displayed language in a corner of the message bubble if more than one translation has been received. If multiple languages are received Conversations will attempt to find one in the language the operating system is set to. If no such translation can be found it will attempt to display the English string. If English can not be found either (for example a message that only has ru and fr on a phone that is set to de) it will display what ever language came first. Furthermore Conversations will discard (not show at all) messages with with multiple bodies of the same language. (This is considered an invalid message) The lanuage tag will not be shown if Conversations received a single body in a language not understood by the user. (For example operating system set to 'de' and message received with one body in 'ru' will just display that body as usual.) As a guide line to the user: If you are reading a message where it is important that this message is not interpreted differently by different people (like a vote (+1 / -1) in a chat room) make sure it has *no* language tag.
2019-09-12 10:12:47 +02:00
package eu.siacs.conversations.xml;
import com.google.common.collect.Iterables;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
public class LocalizedContent {
public static final String STREAM_LANGUAGE = "en";
public final String content;
public final String language;
public final int count;
private LocalizedContent(String content, String language, int count) {
this.content = content;
this.language = language;
this.count = count;
}
public static LocalizedContent get(final Element element, String name) {
final HashMap<String, String> contents = new HashMap<>();
for(Element child : element.children) {
if (name.equals(child.getName())) {
final String namespace = child.getNamespace();
final String lang = child.getAttribute("xml:lang");
final String content = child.getContent();
if (content != null && (namespace == null || "jabber:client".equals(namespace))) {
if (contents.put(lang, content) != null) {
//anything that has multiple contents for the same language is invalid
return null;
}
}
}
}
if (contents.size() == 0) {
return null;
}
final String userLanguage = Locale.getDefault().getLanguage();
final String localized = contents.get(userLanguage);
if (localized != null) {
return new LocalizedContent(localized, userLanguage, contents.size());
}
final String defaultLanguageContent = contents.get(null);
if (defaultLanguageContent != null) {
return new LocalizedContent(defaultLanguageContent, STREAM_LANGUAGE, contents.size());
}
final String streamLanguageContent = contents.get(STREAM_LANGUAGE);
if (streamLanguageContent != null) {
return new LocalizedContent(streamLanguageContent, STREAM_LANGUAGE, contents.size());
}
final Map.Entry<String, String> first = Iterables.get(contents.entrySet(), 0);
return new LocalizedContent(first.getValue(), first.getKey(), contents.size());
}
}