/**
* Copyright (C) 2012 BonitaSoft S.A.
* BonitaSoft, 32 rue Gustave Eiffel - 38000 Grenoble
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 2.0 of the License, or
* (at your option) any later version.
* This program 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 General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
package org.bonitasoft.forms.server;
import java.io.IOException;
import java.io.OutputStream;
import java.net.URLEncoder;
import java.util.Date;
import java.util.HashMap;
import java.util.Locale;
import java.util.Map;
import java.util.logging.Level;
import java.util.logging.Logger;
import javax.servlet.ServletException;
import javax.servlet.http.Cookie;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.apache.commons.lang3.CharEncoding;
import org.bonitasoft.console.common.server.utils.SessionUtil;
import org.bonitasoft.engine.session.APISession;
import org.bonitasoft.forms.server.accessor.impl.util.FormCacheUtilFactory;
import org.bonitasoft.forms.server.api.FormAPIFactory;
import org.bonitasoft.forms.server.api.IFormDefinitionAPI;
import org.bonitasoft.forms.server.provider.FormServiceProvider;
import org.bonitasoft.forms.server.provider.impl.util.FormServiceProviderFactory;
import org.bonitasoft.forms.server.provider.impl.util.FormServiceProviderUtil;
import org.bonitasoft.forms.server.util.LocaleUtil;
import org.bonitasoft.web.rest.model.user.User;
import org.w3c.dom.Document;
/**
* Servlet allowing to download the forms layout
*
* @author Julien Mege
*/
public class FormLayoutDownloadServlet extends HttpServlet {
/**
* UID
*/
private static final long serialVersionUID = 5209516978177786895L;
/**
* Body content ID
*/
public static final String BODY_CONTENT_ID = "bodyContentId";
public static final String IS_PAGE_LAYOUT = "isPageLayout";
/**
* Logger
*/
private static final Logger LOGGER = Logger.getLogger(FormLayoutDownloadServlet.class.getName());
/**
* {@inheritDoc}
*/
@Override
protected void doGet(final HttpServletRequest request, final HttpServletResponse response) throws ServletException {
final APISession apiSession = (APISession) request.getSession().getAttribute(SessionUtil.API_SESSION_PARAM_KEY);
final String bodyContentId = request.getParameter(BODY_CONTENT_ID);
final Map<String, Object> urlContext = buildUrlContext(request);
final Map<String, Object> context = new HashMap<String, Object>();
context.put(SessionUtil.API_SESSION_PARAM_KEY, apiSession);
context.put(FormServiceProviderUtil.URL_CONTEXT, urlContext);
context.put(FormServiceProviderUtil.LOCALE, resolveLocale(getLocale(request)));
final String bodyContent = getBodyContent(request, apiSession, bodyContentId, context);
response.setContentType("text/plain");
response.setCharacterEncoding("UTF-8");
try {
final String encodedfileName = URLEncoder.encode("bodyContent", "UTF-8");
final String userAgent = request.getHeader("User-Agent");
if (userAgent != null && userAgent.contains("Firefox")) {
response.setHeader("Content-Disposition", "attachment; filename*=UTF-8''" + encodedfileName.replace("+", "%20"));
} else {
response.setHeader("Content-Disposition", "attachment; filename=\"" + encodedfileName.replaceAll("\\+", " ") + "\"; filename*=UTF-8''"
+ encodedfileName.replace("+", "%20"));
}
final OutputStream out = response.getOutputStream();
if (bodyContent == null) {
response.setContentLength(0);
} else {
final byte[] bodyContentbytes = bodyContent.getBytes(CharEncoding.UTF_8);
response.setContentLength(bodyContentbytes.length);
out.write(bodyContentbytes);
}
out.close();
} catch (final IOException e) {
if (LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.log(Level.SEVERE, "Error while generating the response.", e);
}
throw new ServletException(e.getMessage(), e);
}
}
@SuppressWarnings("unchecked")
private Map<String, Object> buildUrlContext(final HttpServletRequest request) {
final Map<String, Object> urlContext = new HashMap<String, Object>();
for (final Map.Entry<String, String[]> param : ((Map<String, String[]>) request.getParameterMap()).entrySet()) {
urlContext.put(param.getKey(), param.getValue()[0]);
}
return urlContext;
}
private String getBodyContent(final HttpServletRequest request, final APISession apiSession, final String bodyContentId,
final Map<String, Object> context) throws ServletException {
String bodyContent = null;
if (bodyContentId != null) {
try {
String rawBodyContent = null;
final String isPageLayOutParam = request.getParameter(IS_PAGE_LAYOUT);
final Boolean isPageLayout = Boolean.parseBoolean(isPageLayOutParam);
if (isPageLayout) {
rawBodyContent = FormCacheUtilFactory.getTenantFormCacheUtil(apiSession.getTenantId()).getPageLayoutContent(bodyContentId);
} else {
rawBodyContent = FormCacheUtilFactory.getTenantFormCacheUtil(apiSession.getTenantId()).getApplicationLayoutContent(bodyContentId);
}
final FormServiceProvider formServiceProvider = FormServiceProviderFactory.getFormServiceProvider(apiSession.getTenantId());
final Map<String, String> activityAttributes = formServiceProvider.getAttributesToInsert(context);
if (activityAttributes != null) {
final Locale userLocale = (Locale) context.get(FormServiceProviderUtil.LOCALE);
final Document document = formServiceProvider.getFormDefinitionDocument(context);
final Date deployementDate = formServiceProvider.getDeployementDate(context);
final String localeStr = getLocale(request);
final IFormDefinitionAPI definitionAPI = FormAPIFactory
.getFormDefinitionAPI(apiSession.getTenantId(), document, deployementDate, localeStr);
bodyContent = definitionAPI.applicationAttributes(rawBodyContent, activityAttributes, userLocale);
} else {
bodyContent = rawBodyContent;
}
} catch (final Exception e) {
if (LOGGER.isLoggable(Level.SEVERE)) {
LOGGER.log(Level.SEVERE, "Error while retrieving the body content.", e);
}
throw new ServletException(e.getMessage(), e);
}
}
return bodyContent;
}
/**
* @return the user's locale as a String
*/
protected String getLocale(final HttpServletRequest request) {
String localeStr = null;
final HttpSession session = request.getSession();
final User user = (User) session.getAttribute(SessionUtil.USER_SESSION_PARAM_KEY);
if (user != null) {
localeStr = getFormLocale(request);
}
if (localeStr == null && user != null) {
localeStr = user.getLocale();
}
if (localeStr == null) {
localeStr = request.getLocale().toString();
}
return localeStr;
}
protected String getFormLocale(final HttpServletRequest request) {
String userLocaleStr = null;
final String theLocaleCookieName = LocaleUtil.FORM_LOCALE_COOKIE_NAME;
final Cookie theCookies[] = request.getCookies();
Cookie theCookie = null;
if (theCookies != null) {
for (int i = 0; i < theCookies.length; i++) {
if (theCookies[i].getName().equals(theLocaleCookieName)) {
theCookie = theCookies[i];
userLocaleStr = theCookie.getValue().toString();
break;
}
}
}
return userLocaleStr;
}
/**
* @param localeStr
* the user's locale as a string
* @return the user's {@link Locale}
*/
protected Locale resolveLocale(final String localeStr) {
final String[] localeParams = localeStr.split("_");
final String language = localeParams[0];
Locale userLocale = null;
if (localeParams.length > 1) {
final String country = localeParams[1];
userLocale = new Locale(language, country);
} else {
userLocale = new Locale(language);
}
return userLocale;
}
}