protected void doExecute()

in plugins/jasperreports/src/main/java/org/apache/struts2/views/jasperreports/JasperReportsResult.java [260:437]


    protected void doExecute(String finalLocation, ActionInvocation invocation) throws Exception {
        // Will throw a runtime exception if no "datasource" property. TODO Best place for that is...?
        initializeProperties(invocation);

        LOG.debug("Creating JasperReport for dataSource = {}, format = {}", dataSource, format);

        HttpServletRequest request = invocation.getInvocationContext().getServletRequest();
        HttpServletResponse response = invocation.getInvocationContext().getServletResponse();

        // Handle IE special case: it sends a "contype" request first.
        // TODO Set content type to config settings?
        if ("contype".equals(request.getHeader("User-Agent"))) {
            try (OutputStream outputStream = response.getOutputStream()) {
                response.setContentType("application/pdf");
                response.setContentLength(0);
            } catch (IOException e) {
                LOG.error("Error writing report output", e);
                throw new ServletException(e.getMessage(), e);
            }
            return;
        }

        // Construct the data source for the report.
        ValueStack stack = invocation.getStack();
        ValueStackDataSource stackDataSource = null;

        Connection conn = (Connection) stack.findValue(connection);
        if (conn == null) {
            boolean evaluated = parsedDataSource != null && !parsedDataSource.equals(dataSource);
            boolean reevaluate = !evaluated || isAcceptableExpression(parsedDataSource);
            if (reevaluate) {
                stackDataSource = new ValueStackDataSource(stack, parsedDataSource, wrapField);
            } else {
                throw new ServletException(String.format("Error building dataSource for excluded or not accepted [%s]",
                        parsedDataSource));
            }
        }

        if ("https".equalsIgnoreCase(request.getScheme())) {
            // set the the HTTP Header to work around IE SSL weirdness
            response.setHeader("CACHE-CONTROL", "PRIVATE");
            response.setHeader("Cache-Control", "maxage=3600");
            response.setHeader("Pragma", "public");
            response.setHeader("Accept-Ranges", "none");
        }

        // Determine the directory that the report file is in and set the reportDirectory parameter
        // For WW 2.1.7:
        //  ServletContext servletContext = ((ServletConfig) invocation.getInvocationContext().get(ServletActionContext.SERVLET_CONFIG)).getServletContext();
        ServletContext servletContext = invocation.getInvocationContext().getServletContext();
        String systemId = servletContext.getRealPath(finalLocation);
        Map<String, Object> parameters = new ValueStackShadowMap(stack);
        File directory = new File(systemId.substring(0, systemId.lastIndexOf(File.separator)));
        parameters.put("reportDirectory", directory);
        parameters.put(JRParameter.REPORT_LOCALE, invocation.getInvocationContext().getLocale());

        // put timezone in jasper report parameter
        if (timeZone != null) {
            timeZone = conditionalParse(timeZone, invocation);
            final TimeZone tz = TimeZone.getTimeZone(timeZone);
            if (tz != null) {
                // put the report time zone
                parameters.put(JRParameter.REPORT_TIME_ZONE, tz);
            }
        }

        // Add any report parameters from action to param map.
        boolean evaluated = parsedReportParameters != null && !parsedReportParameters.equals(reportParameters);
        boolean reevaluate = !evaluated || isAcceptableExpression(parsedReportParameters);
        Map reportParams = reevaluate ? (Map) stack.findValue(parsedReportParameters) : null;
        if (reportParams != null) {
            LOG.debug("Found report parameters; adding to parameters...");
            parameters.putAll(reportParams);
        }

        ByteArrayOutputStream output;
        JasperPrint jasperPrint;

        // Fill the report and produce a print object
        try {
            JasperReport jasperReport = (JasperReport) JRLoader.loadObject(new File(systemId));
            if (conn == null) {
                jasperPrint = JasperFillManager.fillReport(jasperReport, parameters, stackDataSource);
            } else {
                jasperPrint = JasperFillManager.fillReport(jasperReport, parameters, conn);
            }
        } catch (JRException e) {
            LOG.error("Error building report for uri {}", systemId, e);
            throw new ServletException(e.getMessage(), e);
        }

        // Export the print object to the desired output format
        try {
            if (contentDisposition != null || documentName != null) {
                final StringBuilder tmp = new StringBuilder();
                tmp.append((contentDisposition == null) ? "inline" : contentDisposition);

                if (documentName != null) {
                    tmp.append("; filename=");
                    tmp.append(documentName);
                    tmp.append(".");
                    tmp.append(format.toLowerCase());
                }

                response.setHeader("Content-disposition", tmp.toString());
            }

            //TODO: replace deprecated logic
            JRExporter exporter;

            switch (format) {
                case FORMAT_PDF:
                    response.setContentType("application/pdf");
                    exporter = new JRPdfExporter();
                    break;
                case FORMAT_CSV:
                    response.setContentType("text/csv");
                    exporter = new JRCsvExporter();
                    break;
                case FORMAT_HTML:
                    response.setContentType("text/html");

                    // IMAGES_MAPS seems to be only supported as "backward compatible" from JasperReports 1.1.0

                    Map imagesMap = new HashMap();
                    request.getSession(true).setAttribute("IMAGES_MAP", imagesMap);

                    exporter = new HtmlExporter();
                    exporter.setParameter(JRHtmlExporterParameter.IMAGES_MAP, imagesMap);
                    exporter.setParameter(JRHtmlExporterParameter.IMAGES_URI, request.getContextPath() + imageServletUrl);

                    // Needed to support chart images:
                    exporter.setParameter(JRExporterParameter.JASPER_PRINT, jasperPrint);
                    request.getSession().setAttribute("net.sf.jasperreports.j2ee.jasper_print", jasperPrint);
                    break;
                case FORMAT_XLS:
                    response.setContentType("application/vnd.ms-excel");
                    exporter = new JRXlsExporter();
                    break;
                case FORMAT_XML:
                    response.setContentType("text/xml");
                    exporter = new JRXmlExporter();
                    break;
                case FORMAT_RTF:
                    response.setContentType("application/rtf");
                    exporter = new JRRtfExporter();
                    break;
                default:
                    throw new ServletException("Unknown report format: " + format);
            }

            evaluated = parsedExportParameters != null && !parsedExportParameters.equals(exportParameters);
            reevaluate = !evaluated || isAcceptableExpression(parsedExportParameters);
            Map exportParams = reevaluate ? (Map) stack.findValue(parsedExportParameters) : null;
            if (exportParams != null) {
                LOG.debug("Found export parameters; adding to exporter parameters...");
                exporter.getParameters().putAll(exportParams);
            }

            output = exportReportToBytes(jasperPrint, exporter);
        } catch (JRException e) {
            LOG.error("Error producing {} report for uri {}", format, systemId, e);
            throw new ServletException(e.getMessage(), e);
        } finally {
            try {
                if (conn != null) {
                    // avoid NPE if connection was not used for the report
                    conn.close();
                }
            } catch (Exception e) {
                LOG.warn("Could not close db connection properly", e);
            }
        }

        response.setContentLength(output.size());
        // Will throw ServletException on IOException.
        writeReport(response, output);
    }