mirror of
https://github.com/Alfresco/alfresco-community-repo.git
synced 2025-08-07 17:49:17 +00:00
4fef0c0ef4
125788 rmunteanu: Merged 5.1.N (5.1.2) to 5.2.N (5.2.1)
125606 rmunteanu: Merged 5.1.1 (5.1.1) to 5.1.N (5.1.2)
125515 slanglois: MNT-16155 Update source headers - add new Copyrights for Java and JSP source files + automatic check in the build
git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@127810 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
328 lines
10 KiB
Java
328 lines
10 KiB
Java
/*
|
|
* #%L
|
|
* Alfresco Repository WAR Community
|
|
* %%
|
|
* Copyright (C) 2005 - 2016 Alfresco Software Limited
|
|
* %%
|
|
* This file is part of the Alfresco software.
|
|
* If the software was purchased under a paid Alfresco license, the terms of
|
|
* the paid license agreement will prevail. Otherwise, the software is
|
|
* provided under the following open source license terms:
|
|
*
|
|
* Alfresco 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 3 of the License, or
|
|
* (at your option) any later version.
|
|
*
|
|
* Alfresco 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.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License
|
|
* along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
|
|
* #L%
|
|
*/
|
|
package org.alfresco.web.app;
|
|
|
|
import java.io.Serializable;
|
|
import java.util.ArrayList;
|
|
import java.util.Enumeration;
|
|
import java.util.List;
|
|
import java.util.Locale;
|
|
import java.util.MissingResourceException;
|
|
import java.util.ResourceBundle;
|
|
import java.util.Vector;
|
|
|
|
import javax.faces.context.FacesContext;
|
|
|
|
import org.alfresco.repo.i18n.MessageService;
|
|
import org.alfresco.service.cmr.repository.StoreRef;
|
|
import org.alfresco.web.bean.repository.Repository;
|
|
import org.apache.commons.logging.Log;
|
|
import org.apache.commons.logging.LogFactory;
|
|
import org.springframework.web.jsf.FacesContextUtils;
|
|
|
|
|
|
/**
|
|
* Wrapper around Alfresco Resource Bundle objects. Used to catch and handle missing
|
|
* resource exception to help identify missing I18N strings in client apps.
|
|
* Also used to look for the requested string in a custom resource bundle.
|
|
*
|
|
* @author Kevin Roast
|
|
*/
|
|
public final class ResourceBundleWrapper extends ResourceBundle implements Serializable
|
|
{
|
|
private static final long serialVersionUID = -3230653664902689948L;
|
|
private static Log logger = LogFactory.getLog(ResourceBundleWrapper.class);
|
|
|
|
/** List of custom bundle names */
|
|
private static List<String> addedBundleNames = new ArrayList<String>(10);
|
|
|
|
/** Serializable details of the resource bundles being wrapped */
|
|
final private Locale locale;
|
|
final private String bundleName;
|
|
|
|
/** List of delegate resource bundles */
|
|
transient private List<ResourceBundle> delegates;
|
|
|
|
/** Message service */
|
|
transient private MessageService messageService;
|
|
|
|
public static final String BEAN_RESOURCE_MESSAGE_SERVICE = "messageService";
|
|
public static final String PATH = "app:company_home/app:dictionary/app:webclient_extension";
|
|
|
|
/**
|
|
* Constructor
|
|
*
|
|
* @param locale the locale
|
|
* @param bundleName the bundle name
|
|
*/
|
|
private ResourceBundleWrapper(Locale locale, String bundleName)
|
|
{
|
|
this.locale = locale;
|
|
this.bundleName = bundleName;
|
|
}
|
|
|
|
/**
|
|
* Get the message service
|
|
*
|
|
* @return MessageService message service
|
|
*/
|
|
private MessageService getMessageService()
|
|
{
|
|
if (this.messageService == null && FacesContext.getCurrentInstance() != null)
|
|
{
|
|
this.messageService = (MessageService)FacesContextUtils.getRequiredWebApplicationContext(
|
|
FacesContext.getCurrentInstance()).getBean(BEAN_RESOURCE_MESSAGE_SERVICE);
|
|
}
|
|
return this.messageService;
|
|
}
|
|
|
|
/**
|
|
* Get a list of the delegate resource bundles
|
|
*
|
|
* @return List<ResourceBundle> list of delegate resource bundles
|
|
*/
|
|
private List<ResourceBundle> getDelegates()
|
|
{
|
|
if (this.delegates == null)
|
|
{
|
|
this.delegates = new ArrayList<ResourceBundle>(ResourceBundleWrapper.addedBundleNames.size() + 2);
|
|
|
|
// Check for custom bundle (if any) - first try in the repo otherwise try the classpath
|
|
ResourceBundle customBundle = null;
|
|
|
|
if (getMessageService() != null)
|
|
{
|
|
StoreRef storeRef = null;
|
|
String path = null;
|
|
|
|
try
|
|
{
|
|
String customName = null;
|
|
int idx = this.bundleName.lastIndexOf(".");
|
|
if (idx != -1)
|
|
{
|
|
customName = this.bundleName.substring(idx+1, this.bundleName.length());
|
|
}
|
|
else
|
|
{
|
|
customName = this.bundleName;
|
|
}
|
|
|
|
storeRef = Repository.getStoreRef();
|
|
|
|
// TODO - make path configurable in one place ...
|
|
// Note: path here is XPath for selectNodes query
|
|
path = PATH + "/cm:" + customName;
|
|
customBundle = getMessageService().getRepoResourceBundle(Repository.getStoreRef(), path, locale);
|
|
}
|
|
catch (Throwable t)
|
|
{
|
|
// for now ... ignore the error, cannot be found or read from repo
|
|
logger.debug("Custom Web Client properties not found: " + storeRef + path);
|
|
}
|
|
}
|
|
|
|
if (customBundle == null)
|
|
{
|
|
// also look up the custom version of the bundle in the extension package
|
|
String customName = determineCustomBundleName(this.bundleName);
|
|
customBundle = getResourceBundle(locale, customName);
|
|
}
|
|
|
|
// Add the custom bundle (if any) - add first to allow override (eg. in MT/dynamic web client env)
|
|
if (customBundle != null)
|
|
{
|
|
this.delegates.add(customBundle);
|
|
}
|
|
|
|
// Add the normal bundle
|
|
ResourceBundle normalBundle = getResourceBundle(locale, this.bundleName);
|
|
if (normalBundle != null)
|
|
{
|
|
this.delegates.add(normalBundle);
|
|
}
|
|
else
|
|
{
|
|
if (logger.isWarnEnabled())
|
|
{
|
|
logger.warn("Resource bundle missing : " + this.bundleName + ", locale : " + locale);
|
|
}
|
|
}
|
|
|
|
// Add the added bundles
|
|
for (String addedBundleName : ResourceBundleWrapper.addedBundleNames)
|
|
{
|
|
this.delegates.add(getResourceBundle(locale, addedBundleName));
|
|
}
|
|
}
|
|
return this.delegates;
|
|
}
|
|
|
|
/**
|
|
* Given a local and name, gets the resource bundle
|
|
*
|
|
* @param locale locale
|
|
* @param bundleName bundle name
|
|
* @return ResourceBundle resource bundle
|
|
*/
|
|
private ResourceBundle getResourceBundle(Locale locale, String bundleName)
|
|
{
|
|
ResourceBundle bundle = null;
|
|
try
|
|
{
|
|
// Load the bundle
|
|
bundle = ResourceBundle.getBundle(bundleName, locale);
|
|
this.delegates.add(bundle);
|
|
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Located and loaded bundle " + bundleName);
|
|
}
|
|
}
|
|
catch (MissingResourceException mre)
|
|
{
|
|
// ignore the error, just log some debug info
|
|
if (logger.isDebugEnabled())
|
|
{
|
|
logger.debug("Unable to load bundle " + bundleName);
|
|
}
|
|
}
|
|
return bundle;
|
|
}
|
|
|
|
/**
|
|
* @see java.util.ResourceBundle#getKeys()
|
|
*/
|
|
public Enumeration<String> getKeys()
|
|
{
|
|
if (getDelegates().size() == 1)
|
|
{
|
|
return getDelegates().get(0).getKeys();
|
|
}
|
|
else
|
|
{
|
|
Vector<String> allKeys = new Vector<String>(100, 2);
|
|
for (ResourceBundle delegate : getDelegates())
|
|
{
|
|
Enumeration<String> keys = delegate.getKeys();
|
|
while(keys.hasMoreElements() == true)
|
|
{
|
|
allKeys.add(keys.nextElement());
|
|
}
|
|
}
|
|
|
|
return allKeys.elements();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @see java.util.ResourceBundle#handleGetObject(java.lang.String)
|
|
*/
|
|
protected Object handleGetObject(String key)
|
|
{
|
|
Object result = null;
|
|
|
|
for (ResourceBundle delegate : getDelegates())
|
|
{
|
|
try
|
|
{
|
|
// Try and lookup the key from the resource bundle
|
|
result = delegate.getObject(key);
|
|
if (result != null)
|
|
{
|
|
break;
|
|
}
|
|
}
|
|
catch (MissingResourceException mre)
|
|
{
|
|
// ignore as this means the key was not present
|
|
}
|
|
}
|
|
|
|
// if the key was not found return a default string
|
|
if (result == null)
|
|
{
|
|
if (logger.isWarnEnabled() == true)
|
|
{
|
|
logger.warn("Failed to find I18N message key: " + key + " for locale: " + locale.toString());
|
|
}
|
|
|
|
result = "$$" + key + "$$";
|
|
}
|
|
|
|
return result;
|
|
}
|
|
|
|
/**
|
|
* Factory method to get a named wrapped resource bundle for a particular locale.
|
|
*
|
|
* @param name Bundle name
|
|
* @param locale Locale to retrieve bundle for
|
|
*
|
|
* @return Wrapped ResourceBundle instance for specified locale
|
|
*/
|
|
public static ResourceBundle getResourceBundle(String name, Locale locale)
|
|
{
|
|
return new ResourceBundleWrapper(locale, name);
|
|
}
|
|
|
|
/**
|
|
* Adds a resource bundle to the collection of custom bundles available
|
|
*
|
|
* @param name the name of the resource bundle
|
|
*/
|
|
public static void addResourceBundle(String name)
|
|
{
|
|
ResourceBundleWrapper.addedBundleNames.add(name);
|
|
}
|
|
|
|
/**
|
|
* Determines the name for the custom bundle to lookup based on the given
|
|
* bundle name
|
|
*
|
|
* @param bundleName The standard bundle
|
|
* @return The name of the custom bundle (in the alfresco.extension package)
|
|
*/
|
|
protected static String determineCustomBundleName(String bundleName)
|
|
{
|
|
String extensionPackage = "alfresco.extension.";
|
|
String customBundleName = null;
|
|
|
|
int idx = bundleName.lastIndexOf(".");
|
|
if (idx == -1)
|
|
{
|
|
customBundleName = extensionPackage + bundleName;
|
|
}
|
|
else
|
|
{
|
|
customBundleName = extensionPackage +
|
|
bundleName.substring(idx+1, bundleName.length());
|
|
}
|
|
|
|
return customBundleName;
|
|
}
|
|
}
|