X-Git-Url: http://wagnertech.de/gitweb/gitweb.cgi/mfinanz.git/blobdiff_plain/ee5d63a6e2b3ba0d962d64376623c26eacd393a5..84ba8214f6f1e68de5fa317b8239a7888a4aac03:/SL/ReportGenerator.pm diff --git a/SL/ReportGenerator.pm b/SL/ReportGenerator.pm index 701dca3ec..cd9caea1c 100644 --- a/SL/ReportGenerator.pm +++ b/SL/ReportGenerator.pm @@ -9,7 +9,6 @@ use SL::Form; # Cause locales.pl to parse these files: # parse_html_template('report_generator/html_report') -# parse_html_template('report_generator/pdf_report') sub new { my $type = shift; @@ -26,7 +25,6 @@ sub new { 'allow_pdf_export' => 1, 'allow_csv_export' => 1, 'html_template' => 'report_generator/html_report', - 'pdf_template' => 'report_generator/pdf_report', 'pdf_export' => { 'paper_size' => 'a4', 'orientation' => 'landscape', @@ -191,6 +189,16 @@ sub set_export_options { }; } +sub set_custom_headers { + my $self = shift; + + if (@_) { + $self->{custom_headers} = [ @_ ]; + } else { + delete $self->{custom_headers}; + } +} + sub get_attachment_basename { my $self = shift; my $filename = $self->{options}->{attachment_basename} || 'report'; @@ -271,6 +279,13 @@ sub prepare_html_content { push @column_headers, $header; } + my $header_rows; + if ($self->{custom_headers}) { + $header_rows = $self->{custom_headers}; + } else { + $header_rows = [ \@column_headers ]; + } + my ($outer_idx, $inner_idx) = (0, 0); my $next_border_top; my @rows; @@ -342,7 +357,7 @@ sub prepare_html_content { my @export_variables = $self->{form}->flatten_variables(@{ $self->{export}->{variable_list} }); - my $allow_pdf_export = $opts->{allow_pdf_export} && (-x $main::html2ps_bin) && (-x $main::ghostscript_bin); + my $allow_pdf_export = $opts->{allow_pdf_export}; eval { require PDF::API2; require PDF::Table; }; $allow_pdf_export |= 1 if (! $@); @@ -356,7 +371,7 @@ sub prepare_html_content { 'ALLOW_PDF_EXPORT' => $allow_pdf_export, 'ALLOW_CSV_EXPORT' => $opts->{allow_csv_export}, 'SHOW_EXPORT_BUTTONS' => ($allow_pdf_export || $opts->{allow_csv_export}) && $self->{data_present}, - 'COLUMN_HEADERS' => \@column_headers, + 'HEADER_ROWS' => $header_rows, 'NUM_COLUMNS' => scalar @column_headers, 'ROWS' => \@rows, 'EXPORT_VARIABLES' => \@export_variables, @@ -392,22 +407,43 @@ sub render_pdf_with_pdf_api2 { my (@data, @column_props, @cell_props); - my $data_row = []; - my $cell_props_row = []; + my ($data_row, $cell_props_row); my @visible_columns = $self->get_visible_columns('HTML'); + my $num_columns = scalar @visible_columns; + my $num_header_rows = 1; foreach $name (@visible_columns) { - $column = $self->{columns}->{$name}; - - push @{ $data_row }, $column->{text}; - push @{ $cell_props_row }, {}; - push @column_props, { 'justify' => $column->{align} eq 'right' ? 'right' : 'left' }; + push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' }; } - push @data, $data_row; - push @cell_props, $cell_props_row; + if (!$self->{custom_headers}) { + $data_row = []; + $cell_props_row = []; + push @data, $data_row; + push @cell_props, $cell_props_row; + + foreach $name (@visible_columns) { + $column = $self->{columns}->{$name}; + + push @{ $data_row }, $column->{text}; + push @{ $cell_props_row }, {}; + } + + } else { + $num_header_rows = scalar @{ $self->{custom_headers} }; + + foreach my $custom_header_row (@{ $self->{custom_headers} }) { + $data_row = []; + $cell_props_row = []; + push @data, $data_row; + push @cell_props, $cell_props_row; - my $num_columns = scalar @column_props; + foreach my $custom_header_col (@{ $custom_header_row }) { + push @{ $data_row }, $custom_header_col->{text}; + push @{ $cell_props_row }, {}; + } + } + } foreach my $row_set (@{ $self->{data} }) { if ('HASH' eq ref $row_set) { @@ -536,6 +572,7 @@ sub render_pdf_with_pdf_api2 { 'font' => $font, 'font_size' => $font_size, 'font_color' => '#000000', + 'num_header_rows' => $num_header_rows, 'header_props' => { 'bg_color' => '#ffffff', 'repeat' => 1, @@ -602,111 +639,6 @@ sub verify_paper_size { return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size; } -sub render_pdf_with_html2ps { - my $self = shift; - my $variables = $self->prepare_html_content(); - my $form = $self->{form}; - my $myconfig = $self->{myconfig}; - my $opt = $self->{options}->{pdf_export}; - - my $opt_number = $opt->{number} ? 'number : 1' : ''; - my $opt_landscape = $opt->{orientation} eq 'landscape' ? 'landscape : 1' : ''; - - my $opt_paper_size = $self->verify_paper_size($opt->{paper_size}, 'a4'); - - my $html2ps_config = <<"END" -\@html2ps { - option { - titlepage: 0; - hyphenate: 0; - colour: 1; - ${opt_landscape}; - ${opt_number}; - } - paper { - type: ${opt_paper_size}; - } - break-table: 1; -} - -\@page { - margin-top: $opt->{margin_top}cm; - margin-left: $opt->{margin_left}cm; - margin-bottom: $opt->{margin_bottom}cm; - margin-right: $opt->{margin_right}cm; -} - -BODY { - font-family: Helvetica; - font-size: $opt->{font_size}pt; -} - -END - ; - - my $printer_command; - if ($opt->{print} && $opt->{printer_id}) { - $form->{printer_id} = $opt->{printer_id}; - $form->get_printer_code($myconfig); - $printer_command = $form->{printer_command}; - } - - my $cfg_file_name = Common::tmpname() . '-html2ps-config'; - my $cfg_file = IO::File->new($cfg_file_name, 'w') || $form->error($locale->text('Could not write the html2ps config file.')); - - $cfg_file->print($html2ps_config); - $cfg_file->close(); - - my $html_file_name = Common::tmpname() . '.html'; - my $html_file = IO::File->new($html_file_name, 'w'); - - if (!$html_file) { - unlink $cfg_file_name; - $form->error($locale->text('Could not write the temporary HTML file.')); - } - - $html_file->print($form->parse_html_template($self->{options}->{pdf_template}, $variables)); - $html_file->close(); - - my $cmdline = - "\"${main::html2ps_bin}\" -f \"${cfg_file_name}\" \"${html_file_name}\" | " . - "\"${main::ghostscript_bin}\" -q -dSAFER -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sPAPERSIZE=${opt_paper_size} -sOutputFile=- -c .setpdfwrite -"; - - my $gs = IO::File->new("${cmdline} |"); - if ($gs) { - my $content; - - if (!$printer_command) { - my $filename = $self->get_attachment_basename(); - print qq|content-type: application/pdf\n|; - print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|; - - while (my $line = <$gs>) { - print $line; - } - - } else { - while (my $line = <$gs>) { - $content .= $line; - } - } - - $gs->close(); - unlink $cfg_file_name, $html_file_name; - - if ($printer_command && $content) { - $self->_print_content('printer_command' => $printer_command, - 'content' => $content, - 'copies' => $opt->{copies}); - $form->{report_generator_printed} = 1; - } - - } else { - unlink $cfg_file_name, $html_file_name; - $form->error($locale->text('Could not spawn html2ps or GhostScript.')); - } -} - sub _print_content { my $self = shift; my %params = @_; @@ -724,11 +656,7 @@ sub generate_pdf_content { eval { require PDF::API2; require PDF::Table; }; - if ($@) { - return $self->render_pdf_with_html2ps(@_); - } else { - return $self->render_pdf_with_pdf_api2(@_); - } + return $self->render_pdf_with_pdf_api2(@_); } sub unescape_string { @@ -767,7 +695,14 @@ sub generate_csv_content { my @visible_columns = $self->get_visible_columns('CSV'); if ($opts->{headers}) { - $csv->print($stdout, [ map { $self->unescape_string($self->{columns}->{$_}->{text}) } @visible_columns ]); + if (!$self->{custom_headers}) { + $csv->print($stdout, [ map { $self->unescape_string($self->{columns}->{$_}->{text}) } @visible_columns ]); + + } else { + foreach my $custom_header_row (@{ $self->{custom_headers} }) { + $csv->print($stdout, [ map { $self->unescape_string($_->{text}) } @{ $custom_header_row } ]); + } + } } foreach my $row_set (@{ $self->{data} }) { @@ -824,7 +759,7 @@ Which makes it almost as complicated to use as doing the work for yourself. Creates a new ReportGenerator object, sets all given options, and returns it. -=item set_columns @columns +=item set_columns %columns Sets the columns available to this report. @@ -842,8 +777,8 @@ Note that this is only for displaying. The data has to be presented already sort =item add_data \%data Adds data to the report. A given hash_ref is interpreted as a single line of data, every array_ref as a collection of lines. -Every line will be expected to be in a kay => value format. Note that this data has to be already sorted. -ReportGenerator does no sorting on its own, only provides links to sorting and visual cue as to which column was sorted by. +Every line will be expected to be in a kay => value format. Note that the rows have to be already sorted. +ReportGenerator does only colum sorting on its own, and provides links to sorting and visual cue as to which column was sorted by. =item add_separator @@ -899,7 +834,7 @@ The html generation function. Is invoked by generate_with_headers. =item generate_pdf_content -The PDF generation function. Is invoked by the pdf render functions. +The PDF generation function. It is invoked by generate_with_headers, tests whether or not the Perl module PDF::API2 is installed and calls render_pdf_with_pdf_api2 if it is and render_pdf_with_html2ps otherwise. =item generate_csv_content @@ -907,11 +842,11 @@ The CSV generation function. Uses XS_CSV to parse the information into csv. =item render_pdf_with_pdf_api2 -PDF render function. Uses PDF module. +PDF render function using the Perl module PDF::API2. =item render_pdf_with_html2ps -PDF render function. Uses html2ps to render. +PDF render function using the external application html2ps. =back @@ -933,7 +868,7 @@ Output format. Used by generate_with_headers to determine the format. Supported =item allow_pdf_export -Used to determine if a button for PDF export should be displayed. Default is yes. +Used to determine if a button for PDF export should be displayed. Default is yes. The PDF button is hidden if neither the Perl module PDF::API2 nor the external applications html2ps and Ghostscript are available regardless of this parameter's value. =item allow_csv_export @@ -943,10 +878,6 @@ Used to determine if a button for CSV export should be displayed. Default is yes The template to be used for HTML reports. Default is 'report_generator/html_report'. -=item pdf_template - -The template to be used for PDF reports. Default is 'report_generator/pdf_report'. - =back =head2 PDF Options @@ -955,7 +886,7 @@ The template to be used for PDF reports. Default is 'report_generator/pdf_report =item paper_size -Paper size. Default is a4. +Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and legal. =item orientation (landscape) @@ -963,11 +894,11 @@ Landscape or portrait. Default is landscape. =item font_name -Default is Verdana. +Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2. =item font_size -Default is 7. +Default is 7. This option only affects the rendering with PDF::API2. =item margin_top @@ -977,15 +908,15 @@ Default is 7. =item margin_right -Default all to 1.5. +The paper margins in cm. They all default to 1.5. =item number -Default is 1. +Set to a true value if the pages should be numbered. Default is 1. =item print -Print or not? Default is no. +If set then the resulting PDF will be output to a printer. If not it will be downloaded by the user. Default is no. =item printer_id @@ -1011,7 +942,7 @@ Character to separate entries. Default is semicolon (;). =item escape_char -Character to escape the quote_char. Default is souble quote ("). +Character to escape the quote_char. Default is double quote ("). =item eol_style