org.opencms.gwt.A_CmsClientMessageBundle Maven / Gradle / Ivy
Show all versions of opencms-test Show documentation
/*
* This library is part of OpenCms -
* the Open Source Content Management System
*
* Copyright (c) Alkacon Software GmbH & Co. KG (http://www.alkacon.com)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* For further information about Alkacon Software GmbH & Co. KG, please see the
* company website: http://www.alkacon.com
*
* For further information about OpenCms, please see the
* project website: http://www.opencms.org
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
*/
package org.opencms.gwt;
import org.opencms.file.CmsObject;
import org.opencms.flex.CmsFlexController;
import org.opencms.i18n.CmsLocaleManager;
import org.opencms.i18n.CmsResourceBundleLoader;
import org.opencms.i18n.I_CmsMessageBundle;
import org.opencms.json.JSONException;
import org.opencms.json.JSONObject;
import org.opencms.main.CmsLog;
import org.opencms.main.OpenCms;
import java.lang.reflect.Method;
import java.util.Enumeration;
import java.util.Locale;
import java.util.ResourceBundle;
import javax.servlet.http.HttpServletRequest;
import org.apache.commons.logging.Log;
/**
* Convenience class to access the localized messages of this OpenCms package.
*
* Intended only for test cases.
*
* @since 8.0.0
*/
public abstract class A_CmsClientMessageBundle implements I_CmsClientMessageBundle {
/** Prefix for imported message values. */
public static final String IMPORT_PREFIX = "@@import:";
/** Static reference to the log. */
private static final Log LOG = CmsLog.getLog(A_CmsClientMessageBundle.class);
/**
* Hides the public constructor for this utility class.
*/
protected A_CmsClientMessageBundle() {
// empty
}
/**
* @see org.opencms.gwt.I_CmsClientMessageBundle#export(javax.servlet.http.HttpServletRequest)
*/
public String export(HttpServletRequest request) {
CmsObject cms = CmsFlexController.getCmsObject(request);
return export(OpenCms.getWorkplaceManager().getWorkplaceLocale(cms));
}
/**
* @see org.opencms.gwt.I_CmsClientMessageBundle#export(java.util.Locale)
*/
public String export(Locale locale) {
return export(locale, true);
}
/**
* @see org.opencms.gwt.I_CmsClientMessageBundle#export(java.util.Locale, boolean)
*/
public String export(Locale locale, boolean wrapScript) {
JSONObject keys = new JSONObject();
try {
ResourceBundle resourceBundle = CmsResourceBundleLoader.getBundle(getBundleName(), locale);
Enumeration bundleKeys = resourceBundle.getKeys();
while (bundleKeys.hasMoreElements()) {
String bundleKey = bundleKeys.nextElement();
String value = resourceBundle.getString(bundleKey);
if (value.startsWith(IMPORT_PREFIX)) {
String importKey = value.replace(IMPORT_PREFIX, "");
String importedValue = importMessage(importKey, locale);
if (importedValue != null) {
value = importedValue;
}
}
keys.put(bundleKey, value);
}
} catch (Throwable e) {
LOG.error(e.getLocalizedMessage(), e);
try {
keys.put("error", e.getLocalizedMessage());
} catch (JSONException e1) {
// ignore, should never happen
LOG.error(e1.getLocalizedMessage(), e1);
}
}
StringBuffer sb = new StringBuffer();
String script = getBundleName().replace('.', '_') + "=" + keys.toString() + ";";
if (wrapScript) {
script = CmsGwtActionElement.wrapScript(script);
}
sb.append(script);
return sb.toString();
}
/**
* @see org.opencms.gwt.I_CmsClientMessageBundle#export(java.lang.String)
*/
public String export(String localeName) {
return export(CmsLocaleManager.getLocale(localeName));
}
/**
* @see org.opencms.gwt.I_CmsClientMessageBundle#getBundleName()
*/
public String getBundleName() {
return getClass().getPackage().getName() + ".clientmessages";
}
/**
* @see org.opencms.gwt.I_CmsClientMessageBundle#getClientImpl()
*/
public Class getClientImpl() throws Exception {
return Class.forName(getClass().getPackage().getName() + ".client.Messages");
}
/**
* Imports a message from another bundle.
*
* @param key a key of the form classname#MESSAGE_FIELD_NAME
* @param locale the locale for which to import the message
*
* @return the imported message string
*/
public String importMessage(String key, Locale locale) {
key = key.trim();
String[] tokens = key.split("#");
if (tokens.length != 2) {
return null;
}
String className = tokens[0];
String messageName = tokens[1];
try {
Method messagesGet = Class.forName(className).getMethod("get");
I_CmsMessageBundle bundle = (I_CmsMessageBundle)(messagesGet.invoke(null));
return bundle.getBundle(locale).key(messageName);
} catch (Exception e) {
LOG.error(e.getLocalizedMessage(), e);
return null;
}
}
}