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
1259 lines
43 KiB
Java
1259 lines
43 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.IOException;
|
|
import java.util.List;
|
|
import java.util.Locale;
|
|
import java.util.Map;
|
|
import java.util.Properties;
|
|
import java.util.ResourceBundle;
|
|
|
|
import javax.faces.context.FacesContext;
|
|
import javax.servlet.ServletContext;
|
|
import javax.servlet.ServletException;
|
|
import javax.servlet.http.HttpServletRequest;
|
|
import javax.servlet.http.HttpServletResponse;
|
|
import javax.servlet.http.HttpSession;
|
|
|
|
import org.alfresco.repo.SessionUser;
|
|
import org.alfresco.repo.content.MimetypeMap;
|
|
import org.alfresco.repo.importer.ImporterBootstrap;
|
|
import org.alfresco.service.cmr.repository.StoreRef;
|
|
import org.alfresco.service.cmr.security.AuthenticationService;
|
|
import org.alfresco.web.app.portlet.AlfrescoFacesPortlet;
|
|
import org.alfresco.web.app.servlet.AuthenticationHelper;
|
|
import org.alfresco.web.app.servlet.FacesHelper;
|
|
import org.alfresco.web.bean.ErrorBean;
|
|
import org.alfresco.web.bean.SidebarBean;
|
|
import org.alfresco.web.bean.dashboard.DashboardManager;
|
|
import org.alfresco.web.bean.dialog.DialogManager;
|
|
import org.alfresco.web.bean.repository.PreferencesService;
|
|
import org.alfresco.web.bean.repository.Repository;
|
|
import org.alfresco.web.bean.repository.User;
|
|
import org.alfresco.web.bean.users.UserPreferencesBean;
|
|
import org.alfresco.web.bean.wizard.WizardManager;
|
|
import org.alfresco.web.config.ClientConfigElement;
|
|
import org.alfresco.web.config.LanguagesConfigElement;
|
|
import org.apache.commons.logging.Log;
|
|
import org.springframework.context.ApplicationContext;
|
|
import org.springframework.extensions.config.Config;
|
|
import org.springframework.extensions.config.ConfigService;
|
|
import org.springframework.extensions.surf.util.I18NUtil;
|
|
import org.springframework.web.context.WebApplicationContext;
|
|
import org.springframework.web.context.support.WebApplicationContextUtils;
|
|
import org.springframework.web.jsf.FacesContextUtils;
|
|
|
|
/**
|
|
* Utilities class
|
|
*
|
|
* @author gavinc
|
|
*/
|
|
public class Application
|
|
{
|
|
private static final String LOCALE = "locale";
|
|
private static final String USE_SESSION_LOCALE = "USE_SESSION_LOCALE";
|
|
|
|
public static final String BEAN_CONFIG_SERVICE = "webClientConfigService";
|
|
public static final String BEAN_DATA_DICTIONARY = "dataDictionary";
|
|
public static final String BEAN_IMPORTER_BOOTSTRAP = "spacesBootstrap";
|
|
private static final String BEAN_UNPROTECTED_AUTH_SERVICE = "authenticationService";
|
|
|
|
public static final String MESSAGE_BUNDLE = "alfresco.messages.webclient";
|
|
|
|
private static ThreadLocal<Boolean> inPortalServer = new ThreadLocal<Boolean>();
|
|
private static StoreRef repoStoreRef;
|
|
private static String rootPath;
|
|
private static String companyRootId;
|
|
private static String glossaryFolderName;
|
|
private static String spaceTemplatesFolderName;
|
|
private static String contentTemplatesFolderName;
|
|
private static String emailTemplatesFolderName;
|
|
private static String inviteEmailTemplatesFolderName;
|
|
private static String notifyEmailTemplatesFolderName;
|
|
private static String rssTemplatesFolderName;
|
|
private static String savedSearchesFolderName;
|
|
private static String scriptsFolderName;
|
|
private static String guestHomeFolderName;
|
|
private static String websitesFolderName;
|
|
private static String webContentFormsFolderName;
|
|
private static String contentFormsFolderName;
|
|
private static String projectsFolderName;
|
|
|
|
private static Boolean isDynamicConfig = null;
|
|
|
|
|
|
/**
|
|
* Private constructor to prevent instantiation of this class
|
|
*/
|
|
private Application()
|
|
{
|
|
}
|
|
|
|
/**
|
|
* Sets whether this application is running inside a portal server
|
|
*
|
|
* @param inPortal true to indicate the application is running as a portlet
|
|
*/
|
|
public static void setInPortalServer(boolean inPortal)
|
|
{
|
|
inPortalServer.set(inPortal ? Boolean.TRUE : null);
|
|
}
|
|
|
|
/**
|
|
* Determines whether the server is running in a portal
|
|
*
|
|
* @return true if we are running inside a portal server
|
|
*/
|
|
public static boolean inPortalServer()
|
|
{
|
|
Boolean result = inPortalServer.get();
|
|
return result == null ? false : result;
|
|
}
|
|
|
|
/**
|
|
* Handles errors thrown from servlets
|
|
*
|
|
* @param servletContext The servlet context
|
|
* @param request The HTTP request
|
|
* @param response The HTTP response
|
|
* @param error The exception
|
|
* @param logger The logger
|
|
*/
|
|
public static void handleServletError(ServletContext servletContext, HttpServletRequest request,
|
|
HttpServletResponse response, Throwable error, Log logger, String returnPage)
|
|
throws IOException, ServletException
|
|
{
|
|
// get the error bean from the session and set the error that occurred.
|
|
HttpSession session = request.getSession();
|
|
ErrorBean errorBean = (ErrorBean)session.getAttribute(ErrorBean.ERROR_BEAN_NAME);
|
|
if (errorBean == null)
|
|
{
|
|
errorBean = new ErrorBean();
|
|
session.setAttribute(ErrorBean.ERROR_BEAN_NAME, errorBean);
|
|
}
|
|
errorBean.setLastError(error);
|
|
errorBean.setReturnPage(returnPage);
|
|
|
|
// try and find the configured error page
|
|
boolean errorShown = false;
|
|
String errorPage = getErrorPage(servletContext);
|
|
|
|
if (errorPage != null)
|
|
{
|
|
if (logger.isDebugEnabled())
|
|
logger.debug("An error has occurred, redirecting to error page: " + errorPage);
|
|
|
|
if (response.isCommitted() == false)
|
|
{
|
|
errorShown = true;
|
|
response.sendRedirect(request.getContextPath() + errorPage);
|
|
}
|
|
else
|
|
{
|
|
if (logger.isDebugEnabled())
|
|
logger.debug("Response is already committed, re-throwing error");
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (logger.isDebugEnabled())
|
|
logger.debug("No error page defined, re-throwing error");
|
|
}
|
|
|
|
// if we could not show the error page for whatever reason, re-throw the error
|
|
if (!errorShown)
|
|
{
|
|
if (error instanceof IOException)
|
|
{
|
|
throw (IOException)error;
|
|
}
|
|
else if (error instanceof ServletException)
|
|
{
|
|
throw (ServletException)error;
|
|
}
|
|
else
|
|
{
|
|
throw new ServletException(error);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Handles error conditions detected by servlets.
|
|
*
|
|
* @param servletContext
|
|
* The servlet context
|
|
* @param request
|
|
* The HTTP request
|
|
* @param response
|
|
* The HTTP response
|
|
* @param messageKey
|
|
* the resource bundle key for the error mesage
|
|
* @param statusCode
|
|
* the status code to set on the response
|
|
* @param logger
|
|
* The logger
|
|
* @throws IOException
|
|
* Signals that an I/O exception has occurred.
|
|
* @throws ServletException
|
|
* the servlet exception
|
|
*/
|
|
public static void handleSystemError(ServletContext servletContext, HttpServletRequest request,
|
|
HttpServletResponse response, String messageKey, int statusCode, Log logger)
|
|
throws IOException, ServletException
|
|
{
|
|
// get the error bean from the session and set the error that occurred.
|
|
HttpSession session = request.getSession();
|
|
ErrorBean errorBean = (ErrorBean)session.getAttribute(ErrorBean.ERROR_BEAN_NAME);
|
|
if (errorBean == null)
|
|
{
|
|
errorBean = new ErrorBean();
|
|
session.setAttribute(ErrorBean.ERROR_BEAN_NAME, errorBean);
|
|
}
|
|
errorBean.setErrorMessageKey(messageKey);
|
|
errorBean.setReturnPage(null);
|
|
|
|
// try and find the configured error page
|
|
boolean errorShown = false;
|
|
String errorPage = getErrorPage(servletContext);
|
|
|
|
if (errorPage != null)
|
|
{
|
|
if (logger.isDebugEnabled())
|
|
logger.debug("An error has occurred, forwarding to error page: " + errorPage);
|
|
|
|
if (!response.isCommitted())
|
|
{
|
|
errorShown = true;
|
|
response.reset();
|
|
response.setStatus(statusCode);
|
|
response.setContentType(MimetypeMap.MIMETYPE_HTML);
|
|
response.setCharacterEncoding("utf-8");
|
|
servletContext.getRequestDispatcher(errorPage).include(request, response);
|
|
}
|
|
else
|
|
{
|
|
if (logger.isDebugEnabled())
|
|
logger.debug("Response is already committed, re-throwing error");
|
|
}
|
|
}
|
|
else
|
|
{
|
|
if (logger.isDebugEnabled())
|
|
logger.debug("No error page defined, re-throwing error");
|
|
}
|
|
|
|
// if we could not show the error page for whatever reason, re-throw the error
|
|
if (!errorShown)
|
|
{
|
|
throw new ServletException(getMessage(session, messageKey));
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieves the DialogManager managed bean
|
|
*
|
|
* @return DialogManager bean
|
|
*/
|
|
public static DialogManager getDialogManager()
|
|
{
|
|
return (DialogManager)FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), DialogManager.BEAN_NAME);
|
|
}
|
|
|
|
/**
|
|
* Retrieves the WizardManager managed bean
|
|
*
|
|
* @return WizardManager bean
|
|
*/
|
|
public static WizardManager getWizardManager()
|
|
{
|
|
return (WizardManager)FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), WizardManager.BEAN_NAME);
|
|
}
|
|
|
|
/**
|
|
* Retrieves the DashboardManager managed bean
|
|
*
|
|
* @return DashboardManager bean
|
|
*/
|
|
public static DashboardManager getDashboardManager()
|
|
{
|
|
return (DashboardManager)FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), DashboardManager.BEAN_NAME);
|
|
}
|
|
|
|
/**
|
|
* Retrieves the SidebarBean
|
|
*
|
|
* @return SidebarBean bean
|
|
*/
|
|
public static SidebarBean getSidebarBean()
|
|
{
|
|
return (SidebarBean)FacesHelper.getManagedBean(FacesContext.getCurrentInstance(), "SidebarBean");
|
|
}
|
|
|
|
/**
|
|
* Retrieves the configured error page for the application
|
|
*
|
|
* @param servletContext The servlet context
|
|
* @return The configured error page or null if the configuration is missing
|
|
*/
|
|
public static String getErrorPage(ServletContext servletContext)
|
|
{
|
|
return getErrorPage(WebApplicationContextUtils.getRequiredWebApplicationContext(servletContext));
|
|
}
|
|
|
|
/**
|
|
* Retrieves the configured login page for the application
|
|
*
|
|
* @param servletContext The servlet context
|
|
* @return The configured login page or null if the configuration is missing
|
|
*/
|
|
public static String getLoginPage(ServletContext servletContext)
|
|
{
|
|
return getLoginPage(WebApplicationContextUtils.getRequiredWebApplicationContext(servletContext));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the User object representing the currently logged in user
|
|
*/
|
|
public static User getCurrentUser(HttpSession session)
|
|
{
|
|
return (User)session.getAttribute(AuthenticationHelper.AUTHENTICATION_USER);
|
|
}
|
|
|
|
/**
|
|
* @return Returns the User object representing the currently logged in user
|
|
*/
|
|
public static User getCurrentUser(FacesContext context)
|
|
{
|
|
if (inPortalServer())
|
|
{
|
|
User user = (User) AlfrescoFacesPortlet.getPortletSessionAttribute(context,
|
|
AuthenticationHelper.AUTHENTICATION_USER, true);
|
|
if (user != null)
|
|
{
|
|
return user;
|
|
}
|
|
}
|
|
return (User) context.getExternalContext().getSessionMap().get(AuthenticationHelper.AUTHENTICATION_USER);
|
|
}
|
|
|
|
public static void setCurrentUser(FacesContext context, User user)
|
|
{
|
|
if (inPortalServer())
|
|
{
|
|
AlfrescoFacesPortlet.setPortletSessionAttribute(context, AuthenticationHelper.AUTHENTICATION_USER, user, true);
|
|
}
|
|
else
|
|
{
|
|
context.getExternalContext().getSessionMap().put(AuthenticationHelper.AUTHENTICATION_USER, user);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Invalidate Alfresco ticket and Web/Portlet session and clear the Security context for this thread.
|
|
* @param context
|
|
*/
|
|
public static void logOut(FacesContext context)
|
|
{
|
|
String ticket = null;
|
|
if (Application.inPortalServer())
|
|
{
|
|
ticket = AlfrescoFacesPortlet.onLogOut(context.getExternalContext().getRequest());
|
|
}
|
|
else
|
|
{
|
|
SessionUser user = getCurrentUser(context);
|
|
if (user != null)
|
|
{
|
|
ticket = user.getTicket();
|
|
}
|
|
HttpServletRequest request = (HttpServletRequest) context.getExternalContext().getRequest();
|
|
HttpSession session = request.getSession(false);
|
|
if (session != null)
|
|
{
|
|
session.invalidate();
|
|
}
|
|
}
|
|
|
|
// Explicitly invalidate the Alfresco ticket. This no longer happens on session expiry to allow for ticket
|
|
// 'sharing'
|
|
WebApplicationContext wc = FacesContextUtils.getRequiredWebApplicationContext(context);
|
|
AuthenticationService unprotAuthService = (AuthenticationService) wc.getBean(BEAN_UNPROTECTED_AUTH_SERVICE);
|
|
if (ticket != null)
|
|
{
|
|
unprotAuthService.invalidateTicket(ticket);
|
|
}
|
|
unprotAuthService.clearCurrentSecurityContext();
|
|
}
|
|
|
|
/**
|
|
* @return Returns the repository store URL (retrieved from config service)
|
|
*/
|
|
public static StoreRef getRepositoryStoreRef(ServletContext context)
|
|
{
|
|
return getRepositoryStoreRef(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the repository store URL (retrieved from config service)
|
|
*/
|
|
public static StoreRef getRepositoryStoreRef(FacesContext context)
|
|
{
|
|
return getRepositoryStoreRef(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns id of the company root
|
|
*
|
|
* @deprecated Replace with user-context-specific getCompanyRootId (e.g. could be tenant-specific)
|
|
*/
|
|
public static String getCompanyRootId()
|
|
{
|
|
return companyRootId;
|
|
}
|
|
|
|
/**
|
|
* Sets the company root id. This is setup by the ContextListener.
|
|
*
|
|
* @param id The company root id
|
|
*
|
|
* @deprecated Replace with user-context-specific getCompanyRootId (e.g. could be tenant-specific)
|
|
*/
|
|
public static void setCompanyRootId(String id)
|
|
{
|
|
companyRootId = id;
|
|
}
|
|
|
|
/**
|
|
* @return Returns id of the company root
|
|
*/
|
|
public static String getCompanyRootId(FacesContext context)
|
|
{
|
|
User user = Application.getCurrentUser(context);
|
|
if (user != null)
|
|
{
|
|
String userCompanyRootId = user.getCompanyRootId();
|
|
if (userCompanyRootId == null)
|
|
{
|
|
userCompanyRootId = Repository.getCompanyRoot(context).getId();
|
|
user.setCompanyRootId(userCompanyRootId);
|
|
}
|
|
|
|
return userCompanyRootId;
|
|
}
|
|
else
|
|
{
|
|
return null;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @return Returns the root path for the application
|
|
*/
|
|
public static String getRootPath(ServletContext context)
|
|
{
|
|
return getRootPath(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the root path for the application
|
|
*/
|
|
public static String getRootPath(FacesContext context)
|
|
{
|
|
return getRootPath(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the glossary folder name
|
|
*/
|
|
public static String getGlossaryFolderName(ServletContext context)
|
|
{
|
|
return getGlossaryFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the glossary folder name
|
|
*/
|
|
public static String getGlossaryFolderName(FacesContext context)
|
|
{
|
|
return getGlossaryFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Space templates folder name
|
|
*/
|
|
public static String getSpaceTemplatesFolderName(ServletContext context)
|
|
{
|
|
return getSpaceTemplatesFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Space templates folder name
|
|
*/
|
|
public static String getSpaceTemplatesFolderName(FacesContext context)
|
|
{
|
|
return getSpaceTemplatesFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Content templates folder name
|
|
*/
|
|
public static String getContentTemplatesFolderName(ServletContext context)
|
|
{
|
|
return getContentTemplatesFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Content templates folder name
|
|
*/
|
|
public static String getContentTemplatesFolderName(FacesContext context)
|
|
{
|
|
return getContentTemplatesFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Invite Email Templates folder name
|
|
*/
|
|
public static String getInviteEmailTemplatesFolderName(ServletContext context)
|
|
{
|
|
return getInviteEmailTemplatesFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Invite Email Templates folder name
|
|
*/
|
|
public static String getInviteEmailTemplatesFolderName(FacesContext context)
|
|
{
|
|
return getInviteEmailTemplatesFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Notify Email Templates folder name
|
|
*/
|
|
public static String getNotifyEmailTemplatesFolderName(ServletContext context)
|
|
{
|
|
return getNotifyEmailTemplatesFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Notify Email Templates folder name
|
|
*/
|
|
public static String getNotifyEmailTemplatesFolderName(FacesContext context)
|
|
{
|
|
return getNotifyEmailTemplatesFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Email templates folder name
|
|
*/
|
|
public static String getEmailTemplatesFolderName(ServletContext context)
|
|
{
|
|
return getEmailTemplatesFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the Email templates folder name
|
|
*/
|
|
public static String getEmailTemplatesFolderName(FacesContext context)
|
|
{
|
|
return getEmailTemplatesFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the RSS templates folder name
|
|
*/
|
|
public static String getRSSTemplatesFolderName(ServletContext context)
|
|
{
|
|
return getRSSTemplatesFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Returns the RSS templates folder name
|
|
*/
|
|
public static String getRSSTemplatesFolderName(FacesContext context)
|
|
{
|
|
return getRSSTemplatesFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Return the Saved Searches folder name
|
|
*/
|
|
public static String getSavedSearchesFolderName(ServletContext context)
|
|
{
|
|
return getSavedSearchesFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Return the Saved Searches folder name
|
|
*/
|
|
public static String getSavedSearchesFolderName(FacesContext context)
|
|
{
|
|
return getSavedSearchesFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Return the JavaScript scripts folder name
|
|
*/
|
|
public static String getScriptsFolderName(ServletContext context)
|
|
{
|
|
return getScriptsFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Return the JavaScript scripts folder name
|
|
*/
|
|
public static String getScriptsFolderName(FacesContext context)
|
|
{
|
|
return getScriptsFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Return the Guest Home folder name
|
|
*/
|
|
public static String getGuestHomeFolderName(ServletContext context)
|
|
{
|
|
return getGuestHomeFolderName(WebApplicationContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
/**
|
|
* @return Return the Guest Home folder name
|
|
*/
|
|
public static String getGuestHomeFolderName(FacesContext context)
|
|
{
|
|
return getGuestHomeFolderName(FacesContextUtils.getRequiredWebApplicationContext(context));
|
|
}
|
|
|
|
|
|
/**
|
|
* Set the language locale for the current user context
|
|
*
|
|
* @param context FacesContext for current user
|
|
* @param code The ISO locale code to set
|
|
*/
|
|
@SuppressWarnings("unchecked")
|
|
public static void setLanguage(FacesContext context, String code)
|
|
{
|
|
Locale locale = I18NUtil.parseLocale(code);
|
|
|
|
// set locale for JSF framework usage
|
|
context.getViewRoot().setLocale(locale);
|
|
|
|
// set locale for our framework usage
|
|
context.getExternalContext().getSessionMap().put(LOCALE, locale);
|
|
|
|
// clear the current message bundle - so it's reloaded with new locale
|
|
context.getExternalContext().getSessionMap().remove(MESSAGE_BUNDLE);
|
|
context.getExternalContext().getSessionMap().put(USE_SESSION_LOCALE, Boolean.TRUE);
|
|
|
|
// Set the current locale in the server thread
|
|
I18NUtil.setLocale(locale);
|
|
}
|
|
|
|
/**
|
|
* Set the language locale for the current user session.
|
|
*
|
|
* @param session HttpSession for current user
|
|
* @param code The ISO locale code to set
|
|
*/
|
|
@Deprecated
|
|
public static void setLanguage(HttpSession session, String code)
|
|
{
|
|
Locale locale = I18NUtil.parseLocale(code);
|
|
|
|
session.setAttribute(LOCALE, locale);
|
|
session.removeAttribute(MESSAGE_BUNDLE);
|
|
session.setAttribute(USE_SESSION_LOCALE, Boolean.TRUE);
|
|
|
|
// Set the current locale in the server thread
|
|
I18NUtil.setLocale(locale);
|
|
}
|
|
|
|
/**
|
|
* Return the language Locale for the current user context
|
|
*
|
|
* @param fc FacesContext for the current user
|
|
*
|
|
* @return Current language Locale set or the VM default if none set - never null
|
|
*/
|
|
public static Locale getLanguage(FacesContext fc)
|
|
{
|
|
boolean useInterfaceLanguage = Application.getClientConfig(fc).isLanguageSelect();
|
|
Map sessionMap = fc.getExternalContext().getSessionMap();
|
|
Boolean useSessionLocale = (Boolean)sessionMap.get(USE_SESSION_LOCALE);
|
|
if (useSessionLocale == null)
|
|
{
|
|
useSessionLocale = Boolean.TRUE;
|
|
sessionMap.put(USE_SESSION_LOCALE, useSessionLocale);
|
|
}
|
|
Locale locale = (Locale)sessionMap.get(LOCALE);
|
|
if (locale == null || (!locale.equals(I18NUtil.getLocale()) && !useInterfaceLanguage))
|
|
{
|
|
if (useSessionLocale && useInterfaceLanguage)
|
|
{
|
|
// first check saved user preferences
|
|
String strLocale = null;
|
|
if (getCurrentUser(fc) != null)
|
|
{
|
|
strLocale = (String)PreferencesService.getPreferences(fc).getValue(
|
|
UserPreferencesBean.PREF_INTERFACELANGUAGE);
|
|
if (strLocale != null)
|
|
{
|
|
locale = I18NUtil.parseLocale(strLocale);
|
|
}
|
|
else
|
|
{
|
|
// failing that, use the server default locale
|
|
locale = Locale.getDefault();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// else get from web-client config - the first item in the configured list of languages
|
|
Config config = Application.getConfigService(fc).getConfig("Languages");
|
|
LanguagesConfigElement langConfig = (LanguagesConfigElement)config.getConfigElement(
|
|
LanguagesConfigElement.CONFIG_ELEMENT_ID);
|
|
List<String> languages = langConfig.getLanguages();
|
|
if (languages != null && languages.size() != 0)
|
|
{
|
|
locale = I18NUtil.parseLocale(languages.get(0));
|
|
}
|
|
else
|
|
{
|
|
// failing that, use the server default locale
|
|
locale = Locale.getDefault();
|
|
}
|
|
}
|
|
// save in user session
|
|
sessionMap.put(LOCALE, locale);
|
|
}
|
|
else
|
|
{
|
|
// Get the request default, already decoded from the request headers
|
|
locale = I18NUtil.getLocale();
|
|
}
|
|
}
|
|
return locale;
|
|
}
|
|
|
|
/**
|
|
* Return the language Locale for the current user Session.
|
|
*
|
|
* @param session
|
|
* HttpSession for the current user
|
|
* @param useInterfaceLanguage
|
|
* If the session language hasn't been established yet, should we base it on user preferences?
|
|
* @return Current language Locale set or the VM default if none set - never null
|
|
*/
|
|
public static Locale getLanguage(HttpSession session, boolean useInterfaceLanguage)
|
|
{
|
|
Boolean useSessionLocale = (Boolean)session.getAttribute(USE_SESSION_LOCALE);
|
|
if (useSessionLocale == null)
|
|
{
|
|
useSessionLocale = useInterfaceLanguage;
|
|
session.setAttribute(USE_SESSION_LOCALE, useSessionLocale);
|
|
}
|
|
Locale locale = (Locale)session.getAttribute(LOCALE);
|
|
if (locale == null || (!locale.equals(I18NUtil.getLocale()) && !useInterfaceLanguage))
|
|
{
|
|
if (useSessionLocale && useInterfaceLanguage)
|
|
{
|
|
// first check saved user preferences
|
|
String strLocale = null;
|
|
if (getCurrentUser(session) != null)
|
|
{
|
|
strLocale = (String) PreferencesService.getPreferences(session).getValue(
|
|
UserPreferencesBean.PREF_INTERFACELANGUAGE);
|
|
if (strLocale != null)
|
|
{
|
|
locale = I18NUtil.parseLocale(strLocale);
|
|
}
|
|
else
|
|
{
|
|
// failing that, use the server default locale
|
|
locale = Locale.getDefault();
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// else get from web-client config - the first item in the configured list of languages
|
|
locale = getLanguage(WebApplicationContextUtils.getRequiredWebApplicationContext(session
|
|
.getServletContext()));
|
|
|
|
}
|
|
|
|
// This is an interface session - the same locale will be used for the rest of the session
|
|
session.setAttribute(LOCALE, locale);
|
|
}
|
|
else
|
|
{
|
|
// Get the request default, already decoded from the request headers
|
|
locale = I18NUtil.getLocale();
|
|
}
|
|
}
|
|
return locale;
|
|
}
|
|
|
|
/**
|
|
* Return the configured language Locale for the application context
|
|
*
|
|
* @param ctx
|
|
* the application context
|
|
* @return Current language Locale set or the VM default if none set - never null
|
|
*/
|
|
public static Locale getLanguage(ApplicationContext ctx)
|
|
{
|
|
// get from web-client config - the first item in the configured list of languages
|
|
Config config = ((ConfigService) ctx.getBean(Application.BEAN_CONFIG_SERVICE)).getConfig("Languages");
|
|
LanguagesConfigElement langConfig = (LanguagesConfigElement) config
|
|
.getConfigElement(LanguagesConfigElement.CONFIG_ELEMENT_ID);
|
|
List<String> languages = langConfig.getLanguages();
|
|
if (languages != null && languages.size() != 0)
|
|
{
|
|
return I18NUtil.parseLocale(languages.get(0));
|
|
}
|
|
else
|
|
{
|
|
// failing that, use the server default locale
|
|
return Locale.getDefault();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get the specified I18N message string from the default message bundle for this user
|
|
*
|
|
* @param context FacesContext
|
|
* @param msg Message ID
|
|
*
|
|
* @return String from message bundle or $$msg$$ if not found
|
|
*/
|
|
public static String getMessage(FacesContext context, String msg)
|
|
{
|
|
return getBundle(context).getString(msg);
|
|
}
|
|
|
|
/**
|
|
* Get the specified I18N message string from the default message bundle for this user
|
|
*
|
|
* @param session HttpSession
|
|
* @param msg Message ID
|
|
*
|
|
* @return String from message bundle or $$msg$$ if not found
|
|
*/
|
|
public static String getMessage(HttpSession session, String msg)
|
|
{
|
|
return getBundle(session).getString(msg);
|
|
}
|
|
|
|
/**
|
|
* Get the specified the default message bundle for this user
|
|
*
|
|
* @param session HttpSession
|
|
*
|
|
* @return ResourceBundle for this user
|
|
*/
|
|
public static ResourceBundle getBundle(HttpSession session)
|
|
{
|
|
ResourceBundle bundle = (ResourceBundle)session.getAttribute(MESSAGE_BUNDLE);
|
|
if (bundle == null)
|
|
{
|
|
// get Locale from language selected by each user on login
|
|
Locale locale = (Locale)session.getAttribute(LOCALE);
|
|
if (locale == null)
|
|
{
|
|
bundle = ResourceBundleWrapper.getResourceBundle(MESSAGE_BUNDLE, I18NUtil.getLocale());
|
|
}
|
|
else
|
|
{
|
|
// Only cache the bundle if/when we have a session locale
|
|
bundle = ResourceBundleWrapper.getResourceBundle(MESSAGE_BUNDLE, locale);
|
|
session.setAttribute(MESSAGE_BUNDLE, bundle);
|
|
}
|
|
}
|
|
|
|
return bundle;
|
|
}
|
|
|
|
/**
|
|
* Get the specified the default message bundle for this user
|
|
*
|
|
* @param context FacesContext
|
|
*
|
|
* @return ResourceBundle for this user
|
|
*/
|
|
@SuppressWarnings("unchecked")
|
|
public static ResourceBundle getBundle(FacesContext context)
|
|
{
|
|
// get the resource bundle for the current locale
|
|
// we store the bundle in the users session
|
|
// this makes it easy to add a locale per user support later
|
|
Map session = context.getExternalContext().getSessionMap();
|
|
ResourceBundle bundle = (ResourceBundle)session.get(MESSAGE_BUNDLE);
|
|
if (bundle == null)
|
|
{
|
|
// get Locale from language selected by each user on login
|
|
Locale locale = (Locale)session.get(LOCALE);
|
|
if (locale == null)
|
|
{
|
|
bundle = ResourceBundleWrapper.getResourceBundle(MESSAGE_BUNDLE, I18NUtil.getLocale());
|
|
}
|
|
else
|
|
{
|
|
// Only cache the bundle if/when we have a session locale
|
|
bundle = ResourceBundleWrapper.getResourceBundle(MESSAGE_BUNDLE, locale);
|
|
session.put(MESSAGE_BUNDLE, bundle);
|
|
}
|
|
}
|
|
|
|
return bundle;
|
|
}
|
|
|
|
/**
|
|
* Helper to get the ConfigService instance
|
|
*
|
|
* @param context FacesContext
|
|
*
|
|
* @return ConfigService
|
|
*/
|
|
public static ConfigService getConfigService(FacesContext context)
|
|
{
|
|
return (ConfigService)FacesContextUtils.getRequiredWebApplicationContext(context).getBean(
|
|
Application.BEAN_CONFIG_SERVICE);
|
|
}
|
|
|
|
/**
|
|
* Helper to get the ConfigService instance
|
|
*
|
|
* @param context ServletContext
|
|
*
|
|
* @return ConfigService
|
|
*/
|
|
public static ConfigService getConfigService(ServletContext context)
|
|
{
|
|
return (ConfigService)WebApplicationContextUtils.getRequiredWebApplicationContext(context).getBean(
|
|
Application.BEAN_CONFIG_SERVICE);
|
|
}
|
|
|
|
/**
|
|
* Helper to get the client config element from the config service
|
|
*
|
|
* @param context FacesContext
|
|
* @return The ClientConfigElement
|
|
*/
|
|
public static ClientConfigElement getClientConfig(FacesContext context)
|
|
{
|
|
return (ClientConfigElement)getConfigService(context).getGlobalConfig().
|
|
getConfigElement(ClientConfigElement.CONFIG_ELEMENT_ID);
|
|
}
|
|
|
|
/**
|
|
* Helper to get the client config element from the config service
|
|
*
|
|
* @param context ServletContext
|
|
* @return The ClientConfigElement
|
|
*/
|
|
public static ClientConfigElement getClientConfig(ServletContext context)
|
|
{
|
|
return (ClientConfigElement)getConfigService(context).getGlobalConfig().
|
|
getConfigElement(ClientConfigElement.CONFIG_ELEMENT_ID);
|
|
}
|
|
|
|
/**
|
|
* Returns the repository store URL
|
|
*
|
|
* @param context The spring context
|
|
* @return The repository store URL to use
|
|
*/
|
|
private static StoreRef getRepositoryStoreRef(WebApplicationContext context)
|
|
{
|
|
if (repoStoreRef == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
repoStoreRef = bootstrap.getStoreRef();
|
|
}
|
|
|
|
return repoStoreRef;
|
|
}
|
|
|
|
/**
|
|
* Returns the root path for the application
|
|
*
|
|
* @param context The spring context
|
|
* @return The application root path
|
|
*/
|
|
private static String getRootPath(WebApplicationContext context)
|
|
{
|
|
if (rootPath == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
rootPath = configuration.getProperty("spaces.company_home.childname");
|
|
}
|
|
|
|
return rootPath;
|
|
}
|
|
|
|
/**
|
|
* Returns the glossary folder name
|
|
*
|
|
* @param context The spring context
|
|
* @return The glossary folder name
|
|
*/
|
|
private static String getGlossaryFolderName(WebApplicationContext context)
|
|
{
|
|
if (glossaryFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
glossaryFolderName = configuration.getProperty("spaces.dictionary.childname");
|
|
}
|
|
|
|
return glossaryFolderName;
|
|
}
|
|
|
|
/**
|
|
* Returns the Space Templates folder name
|
|
*
|
|
* @param context The spring context
|
|
* @return The templates folder name
|
|
*/
|
|
private static String getSpaceTemplatesFolderName(WebApplicationContext context)
|
|
{
|
|
if (spaceTemplatesFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
spaceTemplatesFolderName = configuration.getProperty("spaces.templates.childname");
|
|
}
|
|
|
|
return spaceTemplatesFolderName;
|
|
}
|
|
|
|
/**
|
|
* Returns the Content Templates folder name
|
|
*
|
|
* @param context The spring context
|
|
* @return The templates folder name
|
|
*/
|
|
private static String getContentTemplatesFolderName(WebApplicationContext context)
|
|
{
|
|
if (contentTemplatesFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
contentTemplatesFolderName = configuration.getProperty("spaces.templates.content.childname");
|
|
}
|
|
|
|
return contentTemplatesFolderName;
|
|
}
|
|
|
|
/**
|
|
* Returns the Email Templates folder name
|
|
*
|
|
* @param context The spring context
|
|
* @return The email folder name
|
|
*/
|
|
private static String getEmailTemplatesFolderName(WebApplicationContext context)
|
|
{
|
|
if (emailTemplatesFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
emailTemplatesFolderName = configuration.getProperty("spaces.templates.email.childname");
|
|
}
|
|
|
|
return emailTemplatesFolderName;
|
|
}
|
|
|
|
/**
|
|
* Returns the Invite Email Templates folder name
|
|
*
|
|
* @param context The spring context
|
|
* @return The invite email folder name
|
|
*/
|
|
private static String getInviteEmailTemplatesFolderName(WebApplicationContext context)
|
|
{
|
|
if (inviteEmailTemplatesFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap) context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
inviteEmailTemplatesFolderName = configuration.getProperty("spaces.templates.email.invite1.childname");
|
|
}
|
|
|
|
return inviteEmailTemplatesFolderName;
|
|
}
|
|
|
|
/**
|
|
* Returns the Notify Email Templates folder name
|
|
*
|
|
* @param context The spring context
|
|
* @return The notify email folder name
|
|
*/
|
|
private static String getNotifyEmailTemplatesFolderName(WebApplicationContext context)
|
|
{
|
|
if (notifyEmailTemplatesFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap) context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
notifyEmailTemplatesFolderName = configuration.getProperty("spaces.templates.email.notify.childname");
|
|
}
|
|
|
|
return notifyEmailTemplatesFolderName;
|
|
}
|
|
|
|
/**
|
|
* Returns the RSS Templates folder name
|
|
*
|
|
* @param context The spring context
|
|
* @return The RSS folder name
|
|
*/
|
|
private static String getRSSTemplatesFolderName(WebApplicationContext context)
|
|
{
|
|
if (rssTemplatesFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
rssTemplatesFolderName = configuration.getProperty("spaces.templates.rss.childname");
|
|
}
|
|
|
|
return rssTemplatesFolderName;
|
|
}
|
|
|
|
/**
|
|
* Returns the Saved Searches folder name
|
|
*
|
|
* @param context The spring context
|
|
* @return The saved searches folder name
|
|
*/
|
|
private static String getSavedSearchesFolderName(WebApplicationContext context)
|
|
{
|
|
/*
|
|
* This lookup is duplicated in a patch. If this logic changes, investigate the changes
|
|
* required for the patch(es).
|
|
*/
|
|
|
|
if (savedSearchesFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
savedSearchesFolderName = configuration.getProperty("spaces.savedsearches.childname");
|
|
}
|
|
|
|
return savedSearchesFolderName;
|
|
}
|
|
|
|
/**
|
|
* Returns the JavaScript scripts folder name
|
|
*
|
|
* @param context The spring context
|
|
* @return The scripts folder name
|
|
*/
|
|
private static String getScriptsFolderName(WebApplicationContext context)
|
|
{
|
|
if (scriptsFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
scriptsFolderName = configuration.getProperty("spaces.scripts.childname");
|
|
}
|
|
|
|
return scriptsFolderName;
|
|
}
|
|
|
|
/**
|
|
* Returns the Guest Home folder name name
|
|
*
|
|
* @param context The spring context
|
|
* @return The Guest Home folder name
|
|
*/
|
|
private static String getGuestHomeFolderName(WebApplicationContext context)
|
|
{
|
|
if (guestHomeFolderName == null)
|
|
{
|
|
ImporterBootstrap bootstrap = (ImporterBootstrap)context.getBean(BEAN_IMPORTER_BOOTSTRAP);
|
|
Properties configuration = bootstrap.getConfiguration();
|
|
guestHomeFolderName = configuration.getProperty("spaces.guest_home.childname");
|
|
}
|
|
|
|
return guestHomeFolderName;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the configured error page for the application
|
|
*
|
|
* @param context The Spring context
|
|
* @return The configured error page or null if the configuration is missing
|
|
*/
|
|
public static String getErrorPage(ApplicationContext context)
|
|
{
|
|
String errorPage = null;
|
|
|
|
ConfigService svc = (ConfigService)context.getBean(BEAN_CONFIG_SERVICE);
|
|
ClientConfigElement clientConfig = (ClientConfigElement)svc.getGlobalConfig().
|
|
getConfigElement(ClientConfigElement.CONFIG_ELEMENT_ID);
|
|
|
|
if (clientConfig != null)
|
|
{
|
|
errorPage = clientConfig.getErrorPage();
|
|
}
|
|
|
|
return errorPage;
|
|
}
|
|
|
|
/**
|
|
* Retrieves the configured login page for the application
|
|
*
|
|
* @param context The Spring contexr
|
|
* @return The configured login page or null if the configuration is missing
|
|
*/
|
|
public static String getLoginPage(ApplicationContext context)
|
|
{
|
|
String loginPage = null;
|
|
|
|
ConfigService svc = (ConfigService)context.getBean(BEAN_CONFIG_SERVICE);
|
|
ClientConfigElement clientConfig = (ClientConfigElement)svc.getGlobalConfig().
|
|
getConfigElement(ClientConfigElement.CONFIG_ELEMENT_ID);
|
|
|
|
if (clientConfig != null)
|
|
{
|
|
loginPage = clientConfig.getLoginPage();
|
|
}
|
|
|
|
return loginPage;
|
|
}
|
|
|
|
public static boolean isDynamicConfig(FacesContext context)
|
|
{
|
|
if (isDynamicConfig == null)
|
|
{
|
|
String dynamicConfigParam = FacesContextUtils.getRequiredWebApplicationContext(context).getServletContext().getInitParameter("org.alfresco.webclient.dynamicConfig");
|
|
isDynamicConfig = new Boolean(((dynamicConfigParam == null) || (new Boolean(dynamicConfigParam).booleanValue() == true)));
|
|
}
|
|
|
|
return isDynamicConfig.booleanValue();
|
|
}
|
|
}
|