/*******************************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*******************************************************************************/
package org.ofbiz.birt;
import java.io.OutputStream;
import java.sql.SQLException;
import java.util.Locale;
import java.util.Map;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import javax.servlet.http.HttpSession;
import org.eclipse.birt.report.engine.api.EXCELRenderOption;
import org.eclipse.birt.report.engine.api.EngineException;
import org.eclipse.birt.report.engine.api.HTMLRenderOption;
import org.eclipse.birt.report.engine.api.HTMLServerImageHandler;
import org.eclipse.birt.report.engine.api.IPDFRenderOption;
import org.eclipse.birt.report.engine.api.IReportEngine;
import org.eclipse.birt.report.engine.api.IReportRunnable;
import org.eclipse.birt.report.engine.api.IRunAndRenderTask;
import org.eclipse.birt.report.engine.api.PDFRenderOption;
import org.eclipse.birt.report.engine.api.RenderOption;
import org.ofbiz.base.util.Debug;
import org.ofbiz.base.util.GeneralException;
import org.ofbiz.base.util.UtilGenerics;
import org.ofbiz.base.util.UtilValidate;
import org.ofbiz.entity.Delegator;
import org.ofbiz.security.Security;
import org.ofbiz.service.LocalDispatcher;
public class BirtWorker {
public final static String module = BirtWorker.class.getName();
public final static String BIRT_PARAMETERS = "birtParameters";
public final static String REPORT_ENGINE = "reportEngine";
public final static String BIRT_LOCALE = "birtLocale";
public final static String BIRT_IMAGE_DIRECTORY = "birtImageDirectory";
public final static String BIRT_CONTENT_TYPE = "birtContentType";
public final static String BIRT_OUTPUT_FILE_NAME = "birtOutputFileName";
private static HTMLServerImageHandler imageHandler = new HTMLServerImageHandler();
/**
* export report
* @param design
* @param context
* @param contentType
* @param output
* @throws EngineException
* @throws GeneralException
* @throws SQLException
*/
public static void exportReport(IReportRunnable design, Map<String, ? extends Object> context, String contentType, OutputStream output)
throws EngineException, GeneralException, SQLException {
Locale birtLocale = (Locale)context.get(BIRT_LOCALE);
String birtImageDirectory = (String)context.get(BIRT_IMAGE_DIRECTORY);
if (contentType == null) {
contentType = "text/html";
}
if (birtImageDirectory == null) {
birtImageDirectory = "/";
}
Debug.logInfo("Get report engine", module);
IReportEngine engine = BirtFactory.getReportEngine();
IRunAndRenderTask task = engine.createRunAndRenderTask(design);
if (birtLocale != null) {
Debug.logInfo("Set BIRT locale:" + birtLocale, module);
task.setLocale(birtLocale);
}
// set parameters if exists
Map<String, Object> parameters = UtilGenerics.cast(context.get(BirtWorker.BIRT_PARAMETERS));
if (parameters != null) {
Debug.logInfo("Set BIRT parameters:" + parameters, module);
task.setParameterValues(parameters);
}
// set output options
RenderOption options = new RenderOption();
if ("text/html".equalsIgnoreCase(contentType)) { // HTML
options.setOutputFormat(RenderOption.OUTPUT_FORMAT_HTML);
HTMLRenderOption htmlOptions = new HTMLRenderOption(options);
htmlOptions.setImageDirectory(birtImageDirectory);
htmlOptions.setBaseImageURL(birtImageDirectory);
options.setImageHandler(imageHandler);
} else if ("application/postscript".equalsIgnoreCase(contentType)) { // Post Script
options.setOutputFormat("postscript");
} else if ("application/pdf".equalsIgnoreCase(contentType)) { // PDF
options.setOutputFormat(RenderOption.OUTPUT_FORMAT_PDF);
PDFRenderOption pdfOptions = new PDFRenderOption(options);
pdfOptions.setOption(IPDFRenderOption.PAGE_OVERFLOW, Boolean.TRUE );
} else if ("application/vnd.ms-word".equalsIgnoreCase(contentType)) { // MS Word
options.setOutputFormat("doc");
} else if ("application/vnd.ms-excel".equalsIgnoreCase(contentType)) { // MS Excel
options.setOutputFormat("xls");
new EXCELRenderOption(options);
} else if ("application/vnd.ms-powerpoint".equalsIgnoreCase(contentType)) { // MS Power Point
options.setOutputFormat("ppt");
} else if ("application/vnd.oasis.opendocument.text".equalsIgnoreCase(contentType)) { // Open Document Text
options.setOutputFormat("odt");
} else if ("application/vnd.oasis.opendocument.spreadsheet".equalsIgnoreCase(contentType)) { // Open Document Spreadsheet
options.setOutputFormat("ods");
} else if ("application/vnd.oasis.opendocument.presentation".equalsIgnoreCase(contentType)) { // Open Document Presentation
options.setOutputFormat("odp");
} else {
throw new GeneralException("Unknown content type : " + contentType);
}
options.setOutputStream(output);
task.setRenderOption(options);
// run report
Debug.logInfo("BIRT's locale is: " + task.getLocale(), module);
Debug.logInfo("Run report's task", module);
task.run();
task.close();
}
/**
* set web context objects
* @param engine
* @param request
* @param response
*/
public static void setWebContextObjects(Map<String, Object> appContext, HttpServletRequest request, HttpServletResponse response) {
HttpSession session = request.getSession();
ServletContext servletContext = session.getServletContext();
// set delegator
Delegator delegator = (Delegator) session.getAttribute("delegator");
if (UtilValidate.isEmpty(delegator)) {
delegator = (Delegator) servletContext.getAttribute("delegator");
}
if (UtilValidate.isEmpty(delegator)) {
delegator = (Delegator) request.getAttribute("delegator");
}
if (UtilValidate.isNotEmpty(delegator)) {
appContext.put("delegator", delegator);
}
// set JDBC connection
//appContext.put("OdaJDBCDriverPassInConnection", connection);
// set dispatcher
LocalDispatcher dispatcher = (LocalDispatcher) session.getAttribute("dispatcher");
if (UtilValidate.isEmpty(dispatcher)) {
dispatcher = (LocalDispatcher) servletContext.getAttribute("dispatcher");
}
if (UtilValidate.isEmpty(dispatcher)) {
dispatcher = (LocalDispatcher) request.getAttribute("dispatcher");
}
if (UtilValidate.isNotEmpty(dispatcher)) {
appContext.put("dispatcher", dispatcher);
}
// set security
Security security = (Security) session.getAttribute("security");
if (UtilValidate.isEmpty(security)) {
security = (Security) servletContext.getAttribute("security");
}
if (UtilValidate.isEmpty(security)) {
security = (Security) request.getAttribute("security");
}
if (UtilValidate.isNotEmpty(security)) {
appContext.put("security", security);
}
}
}