/*******************************************************************************
* 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.webapp.view;
import java.io.IOException;
import java.io.InputStream;
import java.util.Map;
import javax.servlet.ServletContext;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import net.sf.jasperreports.engine.JRDataSource;
import net.sf.jasperreports.engine.JREmptyDataSource;
import net.sf.jasperreports.engine.JasperCompileManager;
import net.sf.jasperreports.engine.JasperFillManager;
import net.sf.jasperreports.engine.JasperPrint;
import net.sf.jasperreports.engine.JasperReport;
import net.sf.jasperreports.engine.export.JRXlsExporter;
import net.sf.jasperreports.engine.export.JRXlsExporterParameter;
import org.ofbiz.base.util.Debug;
import org.ofbiz.base.util.UtilHttp;
import org.ofbiz.base.util.cache.UtilCache;
import org.ofbiz.webapp.control.ContextFilter;
import org.ofbiz.webapp.view.AbstractViewHandler;
import org.ofbiz.entity.Delegator;
import org.ofbiz.entity.jdbc.ConnectionFactory;
/**
* Handles JasperReports PoiXls view rendering
*/
public class JasperReportsPoiXlsViewHandler extends AbstractViewHandler {
public static final String module = JasperReportsPoiXlsViewHandler.class.getName();
protected ServletContext context;
public static UtilCache jasperReportsCompiledCache = UtilCache.createUtilCache("webapp.JasperReportsCompiled");
public void init(ServletContext context) throws ViewHandlerException {
this.context = context;
}
public void render(String name, String page, String info, String contentType, String encoding, HttpServletRequest request, HttpServletResponse response) throws ViewHandlerException {
// some containers call filters on EVERY request, even forwarded ones,
// so let it know that it came from the control servlet
if (request == null) {
throw new ViewHandlerException("The HttpServletRequest object was null, how did that happen?");
}
if (UtilValidate.isEmpty(page)) {
throw new ViewHandlerException("View page was null or empty, but must be specified");
}
if (UtilValidate.isEmpty(info)) {
Debug.logInfo("View info string was null or empty, (optionally used to specify an Entity that is mapped to the Entity Engine datasource that the report will use).", module);
}
// tell the ContextFilter we are forwarding
request.setAttribute(ContextFilter.FORWARDED_FROM_SERVLET, Boolean.valueOf(true));
Delegator delegator = (Delegator) request.getAttribute("delegator");
if (delegator == null) {
throw new ViewHandlerException("The delegator object was null, how did that happen?");
}
try {
JasperReport report = (JasperReport) jasperReportsCompiledCache.get(page);
if (report == null) {
synchronized (this) {
report = (JasperReport) jasperReportsCompiledCache.get(page);
if (report == null) {
InputStream is = context.getResourceAsStream(page);
report = JasperCompileManager.compileReport(is);
jasperReportsCompiledCache.put(page, report);
}
}
}
response.setContentType("application/xls");
Map parameters = (Map) request.getAttribute("jrParameters");
if (parameters == null) {
parameters = UtilHttp.getParameterMap(request);
}
JRDataSource jrDataSource = (JRDataSource) request.getAttribute("jrDataSource");
JasperPrint jp = null;
if (jrDataSource == null) {
String datasourceName = delegator.getEntityHelperName(info);
if (UtilValidate.isNotEmpty(datasourceName)) {
Debug.logInfo("Filling report with connection from datasource: " + datasourceName, module);
jp = JasperFillManager.fillReport(report, parameters, ConnectionFactory.getConnection(datasourceName));
} else {
Debug.logInfo("Filling report with an empty JR datasource", module);
jp = JasperFillManager.fillReport(report, parameters, new JREmptyDataSource());
}
} else {
Debug.logInfo("Filling report with a passed in jrDataSource", module);
jp = JasperFillManager.fillReport(report, parameters, jrDataSource);
}
if (jp.getPages().size() < 1) {
throw new ViewHandlerException("Report is Empty (no results?)");
} else {
Debug.logInfo("Got report, there are " + jp.getPages().size() + " pages.", module);
}
JRXlsExporter exporter = new JRXlsExporter();
exporter.setParameter(JRXlsExporterParameter.JASPER_PRINT, jp);
exporter.setParameter(JRXlsExporterParameter.OUTPUT_STREAM, response.getOutputStream());
exporter.setParameter(JRXlsExporterParameter.IS_ONE_PAGE_PER_SHEET, Boolean.FALSE);
exporter.exportReport();
} catch (IOException ie) {
throw new ViewHandlerException("IO Error in report", ie);
} catch (java.sql.SQLException e) {
throw new ViewHandlerException("Database error while running report", e);
} catch (Exception e) {
throw new ViewHandlerException("Error in report", e);
// } catch (ServletException se) {
// throw new ViewHandlerException("Error in region", se.getRootCause());
}
}
}