All Downloads are FREE. Search and download functionalities are using the official Maven repository.

net.sf.jasperreports.web.servlets.ReportServlet Maven / Gradle / Ivy

There is a newer version: 6.21.3
Show newest version
/*
 * JasperReports - Free Java Reporting Library.
 * Copyright (C) 2001 - 2014 TIBCO Software Inc. All rights reserved.
 * http://www.jaspersoft.com
 *
 * Unless you have purchased a commercial license agreement from Jaspersoft,
 * the following license terms apply:
 *
 * This program is part of JasperReports.
 *
 * JasperReports 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.
 *
 * JasperReports 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 JasperReports. If not, see .
 */
package net.sf.jasperreports.web.servlets;

import java.io.IOException;
import java.io.PrintWriter;
import java.util.HashMap;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;

import javax.servlet.ServletException;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import net.sf.jasperreports.engine.JRConstants;
import net.sf.jasperreports.engine.JRException;
import net.sf.jasperreports.engine.JRExporterParameter;
import net.sf.jasperreports.engine.JRParameter;
import net.sf.jasperreports.engine.JRRuntimeException;
import net.sf.jasperreports.engine.ReportContext;
import net.sf.jasperreports.engine.export.HtmlExporter;
import net.sf.jasperreports.engine.export.JRHtmlExporterParameter;
import net.sf.jasperreports.web.JRInteractiveException;
import net.sf.jasperreports.web.WebReportContext;
import net.sf.jasperreports.web.actions.AbstractAction;
import net.sf.jasperreports.web.actions.Action;
import net.sf.jasperreports.web.actions.MultiAction;
import net.sf.jasperreports.web.util.JacksonUtil;
import net.sf.jasperreports.web.util.ReportExecutionHyperlinkProducerFactory;
import net.sf.jasperreports.web.util.VelocityUtil;
import net.sf.jasperreports.web.util.WebUtil;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;


/**
 * @deprecated Replaced by {@link ReportOutputServlet}.
 * @author Teodor Danciu ([email protected])
 */
public class ReportServlet extends AbstractServlet
{
	private static final long serialVersionUID = JRConstants.SERIAL_VERSION_UID;
	
	private static final Log log = LogFactory.getLog(ReportServlet.class);
		
	private static final String TEMPLATE_HEADER= "net/sf/jasperreports/web/servlets/resources/templates/HeaderTemplate.vm";
	private static final String TEMPLATE_BETWEEN_PAGES= "net/sf/jasperreports/web/servlets/resources/templates/BetweenPagesTemplate.vm";
	private static final String TEMPLATE_FOOTER= "net/sf/jasperreports/web/servlets/resources/templates/FooterTemplate.vm";
	
	private static final String TEMPLATE_HEADER_NOPAGES = "net/sf/jasperreports/web/servlets/resources/templates/HeaderTemplateNoPages.vm";
	private static final String TEMPLATE_FOOTER_NOPAGES = "net/sf/jasperreports/web/servlets/resources/templates/FooterTemplateNoPages.vm";
	
	private static final String REQUEST_PARAMETER_IGNORE_PAGINATION = "jr_ignrpg";
	private static final String REQUEST_PARAMETER_ACTION = "jr_action";

	

	/**
	 *
	 */
	public void service(
		HttpServletRequest request,
		HttpServletResponse response
		) throws IOException, ServletException
	{
		response.setContentType("text/html; charset=UTF-8");
		
		// Set to expire far in the past.
		response.setHeader("Expires", "Sat, 6 May 1995 12:00:00 GMT");
		// Set standard HTTP/1.1 no-cache headers.
		response.setHeader("Cache-Control", "no-store, no-cache, must-revalidate");
		// Set IE extended HTTP/1.1 no-cache headers (use addHeader).
		response.addHeader("Cache-Control", "post-check=0, pre-check=0");
		// Set standard HTTP/1.0 no-cache header.
		response.setHeader("Pragma", "no-cache");

		PrintWriter out = response.getWriter();

		WebReportContext webReportContext = WebReportContext.getInstance(request);

		try
		{
			if (request.getParameterMap().containsKey(WebUtil.REQUEST_PARAMETER_PAGE_UPDATE))
			{
				//FIXME move this to a different servlet
				pageUpdate(request, response, webReportContext);
			}
			else
			{
				runReport(request, webReportContext);
				render(request, webReportContext, out);
			}
		}
		catch (JRInteractiveException e) 
		{
			log.error("Jasper Interactive error", e);
			
			out.println("
");
			if (e.getMessage() != null && e.getMessage().indexOf(AbstractAction.ERR_CONCAT_STRING) != -1) {
				String[] tokens = e.getMessage().split(AbstractAction.ERR_CONCAT_STRING);
				for (String token: tokens) {
					out.println(token);
				}
				
			} else {
				out.println(e.getMessage());
			}
			out.println("
"); } catch (Exception e) { log.error("Error on report execution", e); response.setContentType("application/json; charset=UTF-8"); response.setStatus(404); out.println("{"); out.println("\"msg\": \"JasperReports encountered an error!\""); out.println("}"); /* out.println("");//FIXMEJIVE do we need to render this? or should this be done by the viewer? out.println(""); out.println("JasperReports - Web Application Sample"); out.println(""); out.println(""); out.println("JasperReports encountered this error :"); out.println("
");
			e.printStackTrace(out);
			out.println("
"); out.println(""); out.println(""); */ } } /** * @throws JRInteractiveException * */ public void runReport( HttpServletRequest request, //FIXMEJIVE put request in report context, maybe as a thread local? WebReportContext webReportContext ) throws JRException, JRInteractiveException //IOException, ServletException { JasperPrintAccessor jasperPrintAccessor = (JasperPrintAccessor) webReportContext.getParameterValue( WebReportContext.REPORT_CONTEXT_PARAMETER_JASPER_PRINT_ACCESSOR ); String runReport = request.getParameter(WebUtil.REQUEST_PARAMETER_RUN_REPORT); if (jasperPrintAccessor == null || Boolean.valueOf(runReport)) { String reportUri = request.getParameter(WebUtil.REQUEST_PARAMETER_REPORT_URI); if (reportUri != null) { webReportContext.setParameterValue(WebUtil.REQUEST_PARAMETER_REPORT_URI, reportUri); } Boolean isIgnorePagination = Boolean.valueOf(request.getParameter(REQUEST_PARAMETER_IGNORE_PAGINATION)); if (isIgnorePagination != null) { webReportContext.setParameterValue(JRParameter.IS_IGNORE_PAGINATION, isIgnorePagination); } String async = request.getParameter(WebUtil.REQUEST_PARAMETER_ASYNC_REPORT); if (async != null) { webReportContext.setParameterValue(WebUtil.REQUEST_PARAMETER_ASYNC_REPORT, Boolean.valueOf(async)); } Action action = getAction(webReportContext, WebUtil.decodeUrl(request.getParameter(REQUEST_PARAMETER_ACTION))); Controller controller = new Controller(getJasperReportsContext()); controller.runReport(webReportContext, action); } } /** * */ public void render( HttpServletRequest request, WebReportContext webReportContext, PrintWriter writer ) throws JRException //IOException, ServletException { JasperPrintAccessor jasperPrintAccessor = (JasperPrintAccessor) webReportContext.getParameterValue( WebReportContext.REPORT_CONTEXT_PARAMETER_JASPER_PRINT_ACCESSOR); ReportExecutionStatus reportStatus = jasperPrintAccessor.getReportStatus(); if (reportStatus.getStatus() == ReportExecutionStatus.Status.ERROR) { throw new JRRuntimeException("Error occurred during report generation", reportStatus.getError()); } //Integer pageCount = reportStatus.getTotalPageCount(); // if the page count is null, it means that the fill is not yet done but there is at least a page //boolean hasPages = pageCount == null || pageCount > 0;//FIXMEJIVE we should call pageStatus here boolean hasPages = jasperPrintAccessor.pageStatus(0, null).pageExists(); // JRXhtmlExporter exporter = new JRXhtmlExporter(getJasperReportsContext()); HtmlExporter exporter = new HtmlExporter(getJasperReportsContext()); ReportPageStatus pageStatus; if (hasPages) { String reportPage = request.getParameter(WebUtil.REQUEST_PARAMETER_PAGE); int pageIdx = reportPage == null ? 0 : Integer.parseInt(reportPage); String pageTimestamp = request.getParameter(WebUtil.REQUEST_PARAMETER_PAGE_TIMESTAMP); Long timestamp = pageTimestamp == null ? null : Long.valueOf(pageTimestamp); pageStatus = jasperPrintAccessor.pageStatus(pageIdx, timestamp); if (!pageStatus.pageExists()) { throw new JRRuntimeException("Page " + pageIdx + " not found in report"); } exporter.setParameter(JRExporterParameter.PAGE_INDEX, pageIdx); } else { pageStatus = ReportPageStatus.PAGE_FINAL; } exporter.setReportContext(webReportContext); exporter.setParameter(JRExporterParameter.JASPER_PRINT, jasperPrintAccessor.getJasperPrint()); exporter.setParameter(JRExporterParameter.OUTPUT_WRITER, writer); exporter.setParameter(JRHtmlExporterParameter.IMAGES_URI, "image?" + WebReportContext.REQUEST_PARAMETER_REPORT_CONTEXT_ID + "=" + webReportContext.getId() + "&image="); exporter.setParameter(JRHtmlExporterParameter.HTML_HEADER, getHeader(request, webReportContext, hasPages, pageStatus)); exporter.setParameter(JRHtmlExporterParameter.BETWEEN_PAGES_HTML, getBetweenPages(request, webReportContext)); exporter.setParameter(JRHtmlExporterParameter.HTML_FOOTER, getFooter(request, webReportContext, hasPages, pageStatus)); exporter.setParameter( JRHtmlExporterParameter.HYPERLINK_PRODUCER_FACTORY, ReportExecutionHyperlinkProducerFactory.getInstance(getJasperReportsContext(), request) ); exporter.exportReport(); } /** * */ protected String getHeader(HttpServletRequest request, WebReportContext webReportContext, boolean hasPages, ReportPageStatus pageStatus) { Map contextMap = new HashMap(); JasperPrintAccessor jasperPrintAccessor = (JasperPrintAccessor) webReportContext.getParameterValue( WebReportContext.REPORT_CONTEXT_PARAMETER_JASPER_PRINT_ACCESSOR); contextMap.put("totalPages", jasperPrintAccessor.getReportStatus().getTotalPageCount()); String reportPage = request.getParameter(WebUtil.REQUEST_PARAMETER_PAGE); contextMap.put("currentPage", (reportPage != null ? reportPage : "0")); if (!pageStatus.isPageFinal()) { contextMap.put("pageTimestamp", String.valueOf(pageStatus.getTimestamp())); } if (hasPages) { return VelocityUtil.processTemplate(TEMPLATE_HEADER, contextMap); } else { return VelocityUtil.processTemplate(TEMPLATE_HEADER_NOPAGES, contextMap); } } /** * */ protected String getBetweenPages(HttpServletRequest request, WebReportContext webReportContext) { return VelocityUtil.processTemplate(TEMPLATE_BETWEEN_PAGES, new HashMap()); } /** * */ protected String getFooter(HttpServletRequest request, WebReportContext webReportContext, boolean hasPages, ReportPageStatus pageStatus) { Map contextMap = new HashMap(); if (hasPages) { return VelocityUtil.processTemplate(TEMPLATE_FOOTER, contextMap); } else { return VelocityUtil.processTemplate(TEMPLATE_FOOTER_NOPAGES, contextMap); } } /** * */ private Action getAction(ReportContext webReportContext, String jsonData) { Action result = null; List actions = JacksonUtil.getInstance(getJasperReportsContext()).loadAsList(jsonData, AbstractAction.class); if (actions != null) { if (actions.size() == 1) { result = actions.get(0); } else if (actions.size() > 1){ result = new MultiAction(actions); } ((AbstractAction)result).init(getJasperReportsContext(), webReportContext); } return result; } protected void pageUpdate(HttpServletRequest request, HttpServletResponse response, WebReportContext webReportContext) throws JRException, IOException { JasperPrintAccessor jasperPrintAccessor = (JasperPrintAccessor) webReportContext.getParameterValue( WebReportContext.REPORT_CONTEXT_PARAMETER_JASPER_PRINT_ACCESSOR); if (jasperPrintAccessor == null) { throw new JRRuntimeException("Did not find the report on the session."); } String pageIdxParam = request.getParameter(WebUtil.REQUEST_PARAMETER_PAGE); Integer pageIndex = pageIdxParam == null ? null : Integer.valueOf(pageIdxParam); String pageTimestampParam = request.getParameter(WebUtil.REQUEST_PARAMETER_PAGE_TIMESTAMP); Long pageTimestamp = pageTimestampParam == null ? null : Long.valueOf(pageTimestampParam); if (log.isDebugEnabled()) { log.debug("report page update check for pageIndex: " + pageIndex + ", pageTimestamp: " + pageTimestamp); } LinkedHashMap result = new LinkedHashMap(); putReportStatusResult(response, jasperPrintAccessor, result); if (pageIndex != null && pageTimestamp != null) { ReportPageStatus pageStatus = jasperPrintAccessor.pageStatus(pageIndex, pageTimestamp); boolean modified = pageStatus.hasModified(); result.put("pageModified", modified); if (log.isDebugEnabled()) { log.debug("page " + pageIndex + " modified " + modified); } } String resultString = JacksonUtil.getInstance(getJasperReportsContext()).getJsonString(result); response.setContentType("application/json"); PrintWriter out = response.getWriter(); out.write(resultString); out.flush(); } protected void putReportStatusResult(HttpServletResponse response, JasperPrintAccessor printAccessor, LinkedHashMap result) throws JRException { ReportExecutionStatus reportStatus = printAccessor.getReportStatus(); result.put("partialPageCount", reportStatus.getCurrentPageCount()); String status; switch (reportStatus.getStatus()) { case FINISHED: status = "finished"; Integer totalPageCount = reportStatus.getTotalPageCount(); result.put("totalPages", totalPageCount); if (log.isDebugEnabled()) { log.debug("report finished " + totalPageCount + " pages"); } break; case ERROR: status = "error"; handleReportUpdateError(response, reportStatus); break; case CANCELED: status = "canceled"; if (log.isDebugEnabled()) { log.debug("report canceled"); } break; case RUNNING: default: status = "running"; if (log.isDebugEnabled()) { log.debug("report running"); } break; } result.put("status", status); } protected void handleReportUpdateError(HttpServletResponse response, ReportExecutionStatus reportStatus) throws JRException { Throwable error = reportStatus.getError(); if (log.isDebugEnabled()) { log.debug("report error " + error);// only message } // set a header so that the UI knows it's a report execution error response.setHeader("reportError", "true"); // set as a header because we don't have other way to pass it response.setHeader("lastPartialPageIndex", Integer.toString(reportStatus.getCurrentPageCount() - 1)); // throw an exception to get to the error page if (error instanceof JRException) { throw (JRException) error; } if (error instanceof JRRuntimeException) { throw (JRRuntimeException) error; } throw new JRRuntimeException("Error generating report", error); } }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy