reportrunaction.java

The ability to create groups of reports, and grant users access to reports by group. The ability to

/*
 * Copyright (C) 2002 Erik Swenson - [e-mail]
 * 
 * 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 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, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA
 * 02111-1307, USA.
 *  
 */

package org.efs.openreports.actions;

import java.io.File;
import java.util.*;

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

import com.opensymphony.webwork.ServletActionContext;
import com.opensymphony.xwork.ActionContext;
import com.opensymphony.xwork.ActionSupport;

import org.apache.log4j.Logger;
import org.efs.openreports.ORStatics;
import org.efs.openreports.objects.*;
import org.efs.openreports.providers.*;
import org.efs.openreports.util.LocalStrings;

import net.sf.jasperreports.engine.JasperExportManager;
import net.sf.jasperreports.engine.JasperPrint;

public class ReportRunAction
	extends ActionSupport
	implements ReportWriteProviderAware, ReportLogProviderAware, DirectoryProviderAware, ChartProviderAware
{
	protected static Logger log = Logger.getLogger(ReportRunAction.class);

	private ReportWriteProvider reportWriteProvider;
	private ReportLogProvider reportLogProvider;
	private DirectoryProvider directoryProvider;
	private ChartProvider chartProvider;
	
	private int pageIndex = 1;
	private int pageCount = 0;
	private float zoom = 1.0f;		

	public String execute()
	{
		ReportUser user =
			(ReportUser) ActionContext.getContext().getSession().get(ORStatics.REPORT_USER);

		Report report = (Report) ActionContext.getContext().getSession().get(ORStatics.REPORT);

		int exportType =
			Integer.parseInt(
				(String) ActionContext.getContext().getSession().get(ORStatics.EXPORT_TYPE));

		Map reportParameters = getReportParameterMap(user, report);
		Map imagesMap = getImagesMap();

		HttpServletRequest request = ServletActionContext.getRequest();
		HttpServletResponse response = ServletActionContext.getResponse();

		// set headers to disable caching
		response.setHeader("Cache-Control", "no-store, no-cache, must-revalidate");
		response.setHeader("Pragma", "no-cache");
		response.setHeader("Expires", "0");

		ReportLog reportLog = new ReportLog(user, report, new Date());

		try
		{
			JasperPrint jasperPrint = null;

			// user can choose between default two step PDF export and single step PDF export			
			if (exportType == ReportWriteProvider.EXPORT_PDF)
			{
				exportType = user.getPdfExportType();
			}

			/*
			 * Workaround for problem with PDF reports running twice. First request (referer not null)
			 * fill report and set content type to PDF... Second request (referer is null) export
			 * report...
			 */

			if (exportType == ReportWriteProvider.EXPORT_PDF
				&& request.getHeader("referer") != null)
			{
				log.debug("Filling PDF report: " + report.getName());

				reportLogProvider.insertReportLog(reportLog);

				// add any charts
				if (report.getReportChart() != null)
				{
					log.debug("Adding chart: " + report.getReportChart().getName());
					chartProvider.addCharts(report, reportParameters);
				}

				jasperPrint = reportWriteProvider.fillReport(report, reportParameters);

				log.debug(
					"Report filled - "
						+ report.getName()
						+ " : size = "
						+ jasperPrint.getPages().size());

				ActionContext.getContext().getSession().put(ORStatics.REPORT_LOG, reportLog);

				ActionContext.getContext().getSession().put(ORStatics.JASPERPRINT, jasperPrint);

				response.setContentType("application/pdf");

				response.setHeader(
					"Content-disposition",
					"inline; filename=" + report.getName() + ".pdf");

				response.setContentLength(0);

				ServletOutputStream outputStream = response.getOutputStream();
				outputStream.close();

				return NONE;
			}

			if (exportType == ReportWriteProvider.EXPORT_PDF
				&& request.getHeader("referer") == null)
			{
				log.debug("Getting PDF from session: " + report.getName());

				reportLog = (ReportLog) ActionContext.getContext().getSession().remove("reportLog");

				jasperPrint =
					(JasperPrint) ActionContext.getContext().getSession().remove("jasperPrint");
			}
			else if (pageCount < 1)
			{
				log.debug("Filling report: " + report.getName());

				reportLogProvider.insertReportLog(reportLog);

				// add any charts
				if (report.getReportChart() != null)
				{
					log.debug("Adding chart: " + report.getReportChart().getName());
					chartProvider.addCharts(report, reportParameters);
				}

				jasperPrint = reportWriteProvider.fillReport(report, reportParameters);

				log.debug(
					"Report filled - "
						+ report.getName()
						+ " : size = "
						+ jasperPrint.getPages().size());
			}

			log.debug("Exporting report: " + report.getName());

			if (exportType == ReportWriteProvider.EXPORT_XLS)
			{
				response.setContentType("application/vnd.ms-excel");

				ServletOutputStream out = response.getOutputStream();

				reportWriteProvider.sendReportToStream(jasperPrint, out, exportType);
			}
			else if (exportType == ReportWriteProvider.EXPORT_HTML)
			{
				response.setContentType("text/html");

				ServletOutputStream out = response.getOutputStream();

				reportWriteProvider.sendReportToStream(jasperPrint, imagesMap, out, exportType);
			}
			else if (exportType == ReportWriteProvider.EXPORT_CSV)
			{
				response.setContentType("text/comma-separated-values");
				response.setHeader(
					"Content-disposition",
					"inline; filename=" + report.getName() + ".csv");

				ServletOutputStream out = response.getOutputStream();

				reportWriteProvider.sendReportToStream(jasperPrint, out, exportType);
			}
			else if (exportType == ReportWriteProvider.EXPORT_IMAGE)
			{
				if (jasperPrint != null)
				{
					pageCount = jasperPrint.getPages().size();
					ActionContext.getContext().getSession().put(ORStatics.JASPERPRINT, jasperPrint);
				}
			}
			else
			{
				byte[] pdfByteArray = JasperExportManager.exportReportToPdf(jasperPrint);

				response.setContentType("application/pdf");

				response.setHeader(
					"Content-disposition",
					"inline; filename=" + report.getName() + ".pdf");

				response.setContentLength(pdfByteArray.length);

				ServletOutputStream out = response.getOutputStream();

				reportWriteProvider.sendPDFToStream(pdfByteArray, out);
			}

			reportLog.setEndTime(new Date());
			reportLog.setStatus(ReportLog.STATUS_SUCCESS);
			
			if (pageCount < 1)
			{
				reportLogProvider.updateReportLog(reportLog);
			}

			log.debug("Finished report: " + report.getName());
		}
		catch (Exception e)
		{
			if (e.getMessage() != null && e.getMessage().indexOf("Empty") > 0)
			{
				addActionError(LocalStrings.getString(LocalStrings.ERROR_REPORT_EMPTY));
				reportLog.setStatus(ReportLog.STATUS_EMPTY);
			}
			else
			{
				addActionError(e.getMessage());

				log.error(e.getMessage());

				reportLog.setMessage(e.getMessage());
				reportLog.setStatus(ReportLog.STATUS_FAILURE);
			}

			reportLog.setEndTime(new Date());

			try
			{
				reportLogProvider.updateReportLog(reportLog);
			}
			catch (Exception ex)
			{
				log.error("Unable to create ReportLog: " + ex.getMessage());
			}

			return ERROR;
		}
		
		if (exportType == ReportWriteProvider.EXPORT_IMAGE) return SUCCESS;
		
		return NONE;
	}

	protected Map getReportParameterMap(ReportUser user, Report report)
	{
		Map reportParameters = new HashMap();
		if (ActionContext.getContext().getSession().get(ORStatics.REPORT_PARAMETERS) != null)
		{
			reportParameters =
				(Map) ActionContext.getContext().getSession().get(ORStatics.REPORT_PARAMETERS);
		}
		
		reportParameters.put(
			ORStatics.IMAGE_DIR,
			new File(directoryProvider.getReportImageDirectory()));

		return reportParameters;
	}

	protected Map getImagesMap()
	{
		// used by JasperReports HTML export
		// see ImageLoaderAction for more information
		Map imagesMap = null;
		if (ActionContext.getContext().getSession().get(ORStatics.IMAGES_MAP) != null)
		{
			imagesMap = (Map) ActionContext.getContext().getSession().get(ORStatics.IMAGES_MAP);
		}
		else
		{
			imagesMap = new HashMap();
			ActionContext.getContext().getSession().put(ORStatics.IMAGES_MAP, imagesMap);
		}

		return imagesMap;
	}

	public void setReportWriteProvider(ReportWriteProvider reportWriteProvider)
	{
		this.reportWriteProvider = reportWriteProvider;
	}

	public void setReportLogProvider(ReportLogProvider reportLogProvider)
	{
		this.reportLogProvider = reportLogProvider;
	}

	public void setDirectoryProvider(DirectoryProvider directoryProvider)
	{
		this.directoryProvider = directoryProvider;
	}

	public void setChartProvider(ChartProvider chartProvider)
	{
		this.chartProvider = chartProvider;
	}

	public int getPageCount()
	{
		return pageCount;
	}
	
	public void setPageCount(int pageCount)
	{
		this.pageCount = pageCount;
	}
	
	public int getPageIndex()
	{
		return pageIndex;
	}
	
	public void setPageIndex(int pageIndex)
	{
		this.pageIndex = pageIndex;
	}
	
	public float getZoom()
	{
		return zoom;
	}
	
	public void setZoom(float zoom)
	{
		this.zoom = zoom;
	}
}