net.fckeditor.localization.LocalizedMessages Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of java-core Show documentation
This Java library enables the FCKeditor to be used in a Servlet/J2EE environment. It provides JSP tags for creating a FCKeditor instance and a Servlet handling server-side user files and folders.
The newest version!
/*
 * FCKeditor - The text editor for Internet - http://www.fckeditor.net
 * Copyright (C) 2004-2010 Frederico Caldeira Knabben
 * 
 * == BEGIN LICENSE ==
 * 
 * Licensed under the terms of any of the following licenses at your
 * choice:
 * 
 *  - GNU General Public License Version 2 or later (the "GPL")
 *    http://www.gnu.org/licenses/gpl.html
 * 
 *  - GNU Lesser General Public License Version 2.1 or later (the "LGPL")
 *    http://www.gnu.org/licenses/lgpl.html
 * 
 *  - Mozilla Public License Version 1.1 or later (the "MPL")
 *    http://www.mozilla.org/MPL/MPL-1.1.html
 * 
 * == END LICENSE ==
 */
package net.fckeditor.localization;

import java.io.BufferedInputStream;
import java.io.InputStream;
import java.text.MessageFormat;
import java.util.Collections;
import java.util.Enumeration;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.Properties;
import java.util.ResourceBundle;

import javax.servlet.http.HttpServletRequest;

import net.fckeditor.handlers.PropertiesLoader;
import net.fckeditor.tool.Utils;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Provides access to localized messages (properties).
 * 
 * Localized messages are loaded for a particular locale from a HTTP request.
 * The locale is resolved by the current {@link LocaleResolver}
 * instance/singleton. If a locale or a bundle for a locale cannot be found,
 * default messages are used.
 * 
 * 
 * Note: Loaded messages are cached per locale, any subsequent call of the same
 * locale will be served by the cache instead of another resource bundle
 * retrieval.
 * 
 * 
 * @version $Id: LocalizedMessages.java 4785 2009-12-21 20:10:28Z mosipov $
 */
public class LocalizedMessages {

	private static final Map prototypes = Collections
			.synchronizedMap(new HashMap());
	private static final String DEFAULT_FILENAME = "default_messages.properties"; //$NON-NLS-1$
	private static final String LOCAL_PROPERTIES = "fckeditor_messages"; //$NON-NLS-1$
	private static final Properties defaultProperties = new Properties();
	
	private Properties properties;
	private static LocaleResolver localeResolver;
	private static final Locale NEUTRAL = new Locale(Utils.EMPTY_STRING); //$NON-NLS-1$
	private static final Logger logger = LoggerFactory
			.getLogger(LocalizedMessages.class);

	static {

		InputStream in = LocalizedMessages.class
				.getResourceAsStream(DEFAULT_FILENAME);

		if (in == null) {
			logger.error("{} not found", DEFAULT_FILENAME); //$NON-NLS-1$
			throw new RuntimeException(DEFAULT_FILENAME + " not found"); //$NON-NLS-1$
		} else {
			if (!(in instanceof BufferedInputStream))
				in = new BufferedInputStream(in);

			try {
				defaultProperties.load(in);
				in.close();
				logger.debug("{} loaded", DEFAULT_FILENAME); //$NON-NLS-1$
			} catch (Exception e) {
				logger.error("Error while loading {}", DEFAULT_FILENAME); //$NON-NLS-1$
				throw new RuntimeException(
						"Error while loading " + DEFAULT_FILENAME, e); //$NON-NLS-1$
			}
		}
	}

	/**
	 * Returns an instance of LocalizedMessages for a given
	 * request. This method automatically determines the locale of this request
	 * and loads the appropriate bundle. If locale is null or not available,
	 * the default locale will be used.
	 * 
	 * @param request
	 *            the current request instance
	 * @return instance with localized messages
	 */
	public static LocalizedMessages getInstance(HttpServletRequest request) {

		if (request == null)
			throw new NullPointerException("the request cannot be null");
		
		Locale locale = getLocaleResolverInstance().resolveLocale(request);
		
		if (locale == null)
			locale = NEUTRAL;
		
		synchronized (LocalizedMessages.class) {
			if (!prototypes.containsKey(locale))
				prototypes.put(locale, new LocalizedMessages(locale));
		}
		
		// for now we don't need any cloning since the values are accessed
		// read-only
		return prototypes.get(locale);

	}

	/**
	 * Returns the locale resolver instance. The implementation class name is
	 * provided by {@link PropertiesLoader#getLocaleResolverImpl()}.
	 * 
	 * @return the locale resolver instance
	 */
	private synchronized static LocaleResolver getLocaleResolverInstance() {

		if (localeResolver == null) {
			String className = PropertiesLoader.getLocaleResolverImpl();

			if (Utils.isEmpty(className))
				logger.error("Empty LocaleResolver implementation class name provided"); //$NON-NLS-1$
			else
				try {
					Class clazz = Class.forName(className);
					localeResolver = (LocaleResolver) clazz.newInstance();
					logger.info("LocaleResolver initialized to {}", className); //$NON-NLS-1$
				} catch (Throwable e) {
					logger.error("LocaleResolver implementation {} could not be instantiated", className); //$NON-NLS-1$
					throw new RuntimeException("LocaleResolver implementation " + className + " could not be instantiated", e); //$NON-NLS-1$
				}
		}

		return localeResolver;
	}

	/**
	 * Loads the localized messages for the given locale. This constructor loads
	 * the resource bundle for this locale and only for this, in other words it
	 * short-circuits the default resource bundle load mechanism in order to
	 * prevent the loading of the system default locale which may result in a
	 * completely different resource bundle.
	 * 
	 * @param locale
	 *            the locale of the new localized messages
	 */
	private LocalizedMessages(Locale locale) {

		properties = new Properties(defaultProperties);

		ResourceBundle localized = null;
		try {
			localized = ResourceBundle.getBundle(LOCAL_PROPERTIES, locale,
					Thread.currentThread().getContextClassLoader());
		} catch (Exception e) {
			; // do nothing
		}

		if (localized != null
				&& localized.getLocale().getLanguage().equals(
						locale.getLanguage())) {
			Enumeration keys = localized.getKeys();

			while (keys.hasMoreElements()) {
				String key = keys.nextElement();
				properties.setProperty(key, localized.getString(key));
			}

			logger.debug("Resource bundle for locale '{}' loaded", locale); //$NON-NLS-1$
		} else {
			logger.debug("No resource bundle for locale '{}' found, loading default bundle", locale); //$NON-NLS-1$

			ResourceBundle base = null;
			try {
				base = ResourceBundle.getBundle(LOCAL_PROPERTIES, NEUTRAL,
						Thread.currentThread().getContextClassLoader());
			} catch (Exception e) {
				; // do nothing
			}

			if (base != null && base.getLocale().equals(NEUTRAL)) {
				Enumeration keys = base.getKeys();

				while (keys.hasMoreElements()) {
					String key = keys.nextElement();
					properties.setProperty(key, base.getString(key));
				}
			}

		}

	}

	/**
	 * Searches for the message with the specified key in this message list.
	 * 
	 * @see Properties#getProperty(String)
	 */
	private String getMessage(String key) {
		return properties.getProperty(key);
	}

	/** Returns localized editor.compatibleBrowser.yes property. */
	public String getCompatibleBrowserYes() {
		return getMessage("editor.compatibleBrowser.yes"); //$NON-NLS-1$
	}

	/** Returns localized editor.compatibleBrowser.no property. */
	public String getCompatibleBrowserNo() {
		return getMessage("editor.compatibleBrowser.no"); //$NON-NLS-1$
	}

	/** Returns localized connector.fileUpload.enabled property. */
	public String getFileUploadEnabled() {
		return getMessage("connector.fileUpload.enabled"); //$NON-NLS-1$
	}

	/** Returns localized connector.fileUpload.disabled property. */
	public String getFileUploadDisabled() {
		return getMessage("connector.fileUpload.disabled"); //$NON-NLS-1$
	}

	/**
	 * Returns localized connector.file_renamed_warning property.
	 * 
	 * @param newFileName
	 *            the new filename of the warning
	 * @return localized message with new filename
	 */
	public String getFileRenamedWarning(String newFileName) {
		return MessageFormat.format(getMessage("connector.fileUpload.file_renamed_warning"), newFileName); //$NON-NLS-1$
	}

	/** Returns localized connector.fileUpload.invalid_file_type_specified property. */
	public String getInvalidFileTypeSpecified() {
		return getMessage("connector.fileUpload.invalid_file_type_specified"); //$NON-NLS-1$
	}

	/** Returns localized connector.fileUpload.write_error property. */
	public String getFileUploadWriteError() {
		return getMessage("connector.fileUpload.write_error"); //$NON-NLS-1$
	}

	/** Returns localized connector.getResources.enabled property. */
	public String getGetResourcesEnabled() {
		return getMessage("connector.getResources.enabled"); //$NON-NLS-1$
	}

	/** Returns localized connector.getResources.disabled property. */
	public String getGetResourcesDisabled() {
		return getMessage("connector.getResources.disabled"); //$NON-NLS-1$
	}

	/** Returns localized connector.getResources.read_error property. */
	public String getGetResourcesReadError() {
		return getMessage("connector.getResources.read_error"); //$NON-NLS-1$
	}

	/** Returns localized connector.createFolder.enabled property. */
	public String getCreateFolderEnabled() {
		return getMessage("connector.createFolder.enabled"); //$NON-NLS-1$
	}

	/** Returns localized connector.createFolder.disabled property. */
	public String getCreateFolderDisabled() {
		return getMessage("connector.createFolder.disabled"); //$NON-NLS-1$
	}

	/** Returns localized connector.invalid_command_specified property. */
	public String getInvalidCommandSpecified() {
		return getMessage("connector.invalid_command_specified"); //$NON-NLS-1$
	}

	/** Returns localized connector.createFolder.folder_already_exists_error property. */
	public String getFolderAlreadyExistsError() {
		return getMessage("connector.createFolder.folder_already_exists_error"); //$NON-NLS-1$
	}

	/** Returns localized connector.createFolder.invalid_new_folder_name_specified property. */
	public String getInvalidNewFolderNameSpecified() {
		return getMessage("connector.createFolder.invalid_new_folder_name_specified"); //$NON-NLS-1$
	}

	/** Returns localized connector.createFolder.write_error property. */
	public String getCreateFolderWriteError() {
		return getMessage("connector.createFolder.write_error"); //$NON-NLS-1$
	}

	/** Returns localized connector.invalid_resource_type_specified property. */
	public String getInvalidResouceTypeSpecified() {
		return getMessage("connector.invalid_resource_type_specified"); //$NON-NLS-1$
	}

	/** Returns localized connector.invalid_current_folder_specified property. */
	public String getInvalidCurrentFolderSpecified() {
		return getMessage("connector.invalid_current_folder_specified"); //$NON-NLS-1$
	}

}