X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FReportGenerator.pm;h=e965e442294fe964e441e8059f98df04d54f48bd;hb=99bbf349b825fc48cdb71288e0979ab687770227;hp=050984aa30693dbf10fd8ac7fe2361e14edd2dd7;hpb=d43904e8740303c640001b7362eac01d7df019c6;p=kivitendo-erp.git
diff --git a/SL/ReportGenerator.pm b/SL/ReportGenerator.pm
index 050984aa3..e965e4422 100644
--- a/SL/ReportGenerator.pm
+++ b/SL/ReportGenerator.pm
@@ -1,14 +1,12 @@
package SL::ReportGenerator;
-use Encode;
-use IO::Wrap;
+use Data::Dumper;
use List::Util qw(max);
use Text::CSV_XS;
-use Text::Iconv;
-use PDF::API2;
-use PDF::Table;
+#use PDF::API2; # these two eat up to .75s on startup. only load them if we actually need them
+#use PDF::Table;
-use SL::Form;
+use strict;
# Cause locales.pl to parse these files:
# parse_html_template('report_generator/html_report')
@@ -25,6 +23,7 @@ sub new {
$self->{options} = {
'std_column_visibility' => 0,
'output_format' => 'HTML',
+ 'controller_class ' => '',
'allow_pdf_export' => 1,
'allow_csv_export' => 1,
'html_template' => 'report_generator/html_report',
@@ -74,6 +73,12 @@ sub set_columns {
$column->{visible} = $self->{options}->{std_column_visibility} unless defined $column->{visible};
}
+ if( $::form->{report_generator_csv_options_for_import} ) {
+ foreach my $key (keys %{ $self->{columns} }) {
+ $self->{columns}{$key}{text} = $key;
+ }
+ }
+
$self->set_column_order(sort keys %{ $self->{columns} });
}
@@ -205,14 +210,17 @@ sub set_custom_headers {
sub get_attachment_basename {
my $self = shift;
my $filename = $self->{options}->{attachment_basename} || 'report';
+
+ # FIXME: this is bonkers. add a real sluggify method somewhere or import one.
$filename =~ s|.*\\||;
$filename =~ s|.*/||;
+ $filename =~ s| |_|g;
return $filename;
}
sub generate_with_headers {
- my $self = shift;
+ my ($self, %params) = @_;
my $format = lc $self->{options}->{output_format};
my $form = $self->{form};
@@ -223,16 +231,19 @@ sub generate_with_headers {
if ($format eq 'html') {
my $title = $form->{title};
$form->{title} = $self->{title} if ($self->{title});
- $form->header();
+ $form->header(no_layout => $params{no_layout});
$form->{title} = $title;
print $self->generate_html_content();
} elsif ($format eq 'csv') {
+ # FIXME: don't do mini http in here
my $filename = $self->get_attachment_basename();
print qq|content-type: text/csv\n|;
print qq|content-disposition: attachment; filename=${filename}.csv\n\n|;
- $self->generate_csv_content();
+ $::locale->with_raw_io(\*STDOUT, sub {
+ $self->generate_csv_content();
+ });
} elsif ($format eq 'pdf') {
$self->generate_pdf_content();
@@ -334,11 +345,11 @@ sub prepare_html_content {
next;
}
- my $col = $row->{$col_name};
+ my $col = $row->{$col_name} || { data => [] };
$col->{CELL_ROWS} = [ ];
foreach my $i (0 .. scalar(@{ $col->{data} }) - 1) {
push @{ $col->{CELL_ROWS} }, {
- 'data' => $self->html_format($col->{data}->[$i]),
+ 'data' => '' . $self->html_format($col->{data}->[$i]),
'link' => $col->{link}->[$i],
};
}
@@ -389,6 +400,7 @@ sub prepare_html_content {
'EXPORT_VARIABLE_LIST' => join(' ', @{ $self->{export}->{variable_list} }),
'EXPORT_NEXTSUB' => $self->{export}->{nextsub},
'DATA_PRESENT' => $self->{data_present},
+ 'CONTROLLER_DISPATCH' => $opts->{controller_class},
};
return $variables;
@@ -398,7 +410,8 @@ sub generate_html_content {
my $self = shift;
my $variables = $self->prepare_html_content();
- return $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
+ my $stuff = $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
+ return $stuff;
}
sub _cm2bp {
@@ -407,15 +420,6 @@ sub _cm2bp {
return $_[0] * 72 / 2.54;
}
-sub _decode_text {
- my $self = shift;
- my $text = shift;
-
- $text = decode('UTF-8', $text) if ($self->{text_is_utf8});
-
- return $text;
-}
-
sub generate_pdf_content {
eval {
require PDF::API2;
@@ -433,14 +437,13 @@ sub generate_pdf_content {
my (@data, @column_props, @cell_props);
my ($data_row, $cell_props_row);
- my @visible_columns = $self->get_visible_columns('HTML');
+ my @visible_columns = $self->get_visible_columns('PDF');
my $num_columns = scalar @visible_columns;
my $num_header_rows = 1;
- my $font_encoding = $main::dbcharset || 'ISO-8859-15';
- $self->{text_is_utf8} = $font_encoding =~ m/^utf-?8$/i;
+ my $font_encoding = 'UTF-8';
- foreach $name (@visible_columns) {
+ foreach my $name (@visible_columns) {
push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };
}
@@ -450,10 +453,10 @@ sub generate_pdf_content {
push @data, $data_row;
push @cell_props, $cell_props_row;
- foreach $name (@visible_columns) {
- $column = $self->{columns}->{$name};
+ foreach my $name (@visible_columns) {
+ my $column = $self->{columns}->{$name};
- push @{ $data_row }, $self->_decode_text($column->{text});
+ push @{ $data_row }, $column->{text};
push @{ $cell_props_row }, {};
}
@@ -467,7 +470,7 @@ sub generate_pdf_content {
push @cell_props, $cell_props_row;
foreach my $custom_header_col (@{ $custom_header_row }) {
- push @{ $data_row }, $self->_decode_text($custom_header_col->{text});
+ push @{ $data_row }, $custom_header_col->{text};
my $num_output = ($custom_header_col->{colspan} * 1 > 1) ? $custom_header_col->{colspan} : 1;
if ($num_output > 1) {
@@ -485,7 +488,7 @@ sub generate_pdf_content {
foreach my $row_set (@{ $self->{data} }) {
if ('HASH' eq ref $row_set) {
if ($row_set->{type} eq 'colspan_data') {
- push @data, [ $self->_decode_text($row_set->{data}) ];
+ push @data, [ $row_set->{data} ];
$cell_props_row = [];
push @cell_props, $cell_props_row;
@@ -509,7 +512,7 @@ sub generate_pdf_content {
my $col_idx = 0;
foreach my $col_name (@visible_columns) {
my $col = $row->{$col_name};
- push @{ $data_row }, $self->_decode_text(join("\n", @{ $col->{data} }));
+ push @{ $data_row }, join("\n", @{ $col->{data} || [] });
$column_props[$col_idx]->{justify} = 'right' if ($col->{align} eq 'right');
@@ -574,13 +577,13 @@ sub generate_pdf_content {
my $font_height = $font_size + 2 * $padding;
my $title_font_height = $font_size + 2 * $padding;
- my $header_height = 2 * $title_font_height if ($opts->{title});
- my $footer_height = 2 * $font_height if ($pdfopts->{number});
+ my $header_height = $opts->{title} ? 2 * $title_font_height : undef;
+ my $footer_height = $pdfopts->{number} ? 2 * $font_height : undef;
my $top_text_height = 0;
if ($self->{options}->{top_info_text}) {
- my $top_text = $self->_decode_text($self->{options}->{top_info_text});
+ my $top_text = $self->{options}->{top_info_text};
$top_text =~ s/\r//g;
$top_text =~ s/\n+$//;
@@ -621,13 +624,14 @@ sub generate_pdf_content {
'column_props' => \@column_props,
'cell_props' => \@cell_props,
'max_word_length' => 60,
+ 'border' => 0.5,
);
foreach my $page_num (1..$pdf->pages()) {
my $curpage = $pdf->openpage($page_num);
if ($pdfopts->{number}) {
- my $label = $self->_decode_text($main::locale->text("Page #1/#2", $page_num, $pdf->pages()));
+ my $label = $main::locale->text("Page #1/#2", $page_num, $pdf->pages());
my $text_obj = $curpage->text();
$text_obj->font($font, $font_size);
@@ -636,7 +640,7 @@ sub generate_pdf_content {
}
if ($opts->{title}) {
- my $title = $self->_decode_text($opts->{title});
+ my $title = $opts->{title};
my $text_obj = $curpage->text();
$text_obj->font($font, $title_font_size);
@@ -667,7 +671,9 @@ sub generate_pdf_content {
print qq|content-type: application/pdf\n|;
print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
- print $content;
+ $::locale->with_raw_io(\*STDOUT, sub {
+ print $content;
+ });
}
}
@@ -693,19 +699,26 @@ sub _print_content {
}
}
-sub unescape_string {
- my $self = shift;
- my $text = shift;
- my $iconv = $main::locale->{iconv};
+sub _handle_quoting_and_encoding {
+ my ($self, $text, $do_unquote) = @_;
- $text = $main::locale->unquote_special_chars('HTML', $text);
- $text = $main::locale->{iconv}->convert($text) if ($main::locale->{iconv});
+ $text = $main::locale->unquote_special_chars('HTML', $text) if $do_unquote;
+ $text = Encode::encode('UTF-8', $text);
return $text;
}
sub generate_csv_content {
- my $self = shift;
+ my $self = shift;
+ my $stdout = ($::dispatcher->get_standard_filehandles)[1];
+
+ # Text::CSV_XS seems to downgrade to bytes already (see
+ # SL/FCGIFixes.pm). Therefore don't let FCGI do that again.
+ $::locale->with_raw_io($stdout, sub { $self->_generate_csv_content($stdout) });
+}
+
+sub _generate_csv_content {
+ my ($self, $stdout) = @_;
my %valid_sep_chars = (';' => ';', ',' => ',', ':' => ':', 'TAB' => "\t");
my %valid_escape_chars = ('"' => 1, "'" => 1);
@@ -725,12 +738,11 @@ sub generate_csv_content {
'quote_char' => $quote_char,
'eol' => $eol, });
- my $stdout = wraphandle(\*STDOUT);
my @visible_columns = $self->get_visible_columns('CSV');
if ($opts->{headers}) {
if (!$self->{custom_headers}) {
- $csv->print($stdout, [ map { $self->unescape_string($self->{columns}->{$_}->{text}) } @visible_columns ]);
+ $csv->print($stdout, [ map { $self->_handle_quoting_and_encoding($self->{columns}->{$_}->{text}, 1) } @visible_columns ]);
} else {
foreach my $row (@{ $self->{custom_headers} }) {
@@ -738,7 +750,7 @@ sub generate_csv_content {
foreach my $col (@{ $row }) {
my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1;
- push @{ $fields }, ($self->unescape_string($col->{text})) x $num_output;
+ push @{ $fields }, ($self->_handle_quoting_and_encoding($col->{text}, 1)) x $num_output;
}
$csv->print($stdout, $fields);
@@ -757,10 +769,10 @@ sub generate_csv_content {
next;
}
- my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1;
+ my $num_output = ($row->{$col}{colspan} && ($row->{$col}->{colspan} > 1)) ? $row->{$col}->{colspan} : 1;
$skip_next = $num_output - 1;
- push @data, join($eol, map { s/\r?\n/$eol/g; $_ } @{ $row->{$col}->{data} });
+ push @data, join($eol, map { s/\r?\n/$eol/g; $self->_handle_quoting_and_encoding($_, 0) } @{ $row->{$col}->{data} });
push @data, ('') x $skip_next if ($skip_next);
}
@@ -769,13 +781,17 @@ sub generate_csv_content {
}
}
+sub check_for_pdf_api {
+ return eval { require PDF::API2; 1; } ? 1 : 0;
+}
+
1;
__END__
=head1 NAME
-SL::ReportGenerator.pm: the Lx-Office way of getting data in shape
+SL::ReportGenerator.pm: the kivitendo way of getting data in shape
=head1 SYNOPSIS
@@ -786,7 +802,7 @@ SL::ReportGenerator.pm: the Lx-Office way of getting data in shape
$report->add_data($row1, $row2, @more_rows);
$report->generate_with_headers();
-This creates a report object, sets a few columns, adds some data and generates a standard report.
+This creates a report object, sets a few columns, adds some data and generates a standard report.
Sorting of columns will be alphabetic, and options will be set to their defaults.
The report will be printed including table headers, html headers and http headers.
@@ -799,8 +815,8 @@ Then there are some options made by the user, such as hidden columns. You add mo
Then it lacks usability. You want it to be able to sort the data. You add code for that.
Then there are too many results, you need pagination, you want to print or export that data..... and so on.
-The ReportGenerator class was designed because this exact scenario happened about half a dozen times in Lx-Office.
-It's purpose is to manage all those formating, culling, sorting, and templating.
+The ReportGenerator class was designed because this exact scenario happened about half a dozen times in kivitendo.
+It's purpose is to manage all those formating, culling, sorting, and templating.
Which makes it almost as complicated to use as doing the work for yourself.
=head1 FUNCTIONS
@@ -828,8 +844,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 the rows have to be already sorted.
+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 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
@@ -839,7 +855,7 @@ Adds a separator line to the report.
=item add_control \%data
Adds a control element to the data. Control elements are an experimental feature to add functionality to a report the regular data cannot.
-Every control element needs to set IS_CONTROL_DATA, in order to be recongnized by the template.
+Every control element needs to set IS_CONTROL_DATA, in order to be recongnized by the template.
Currently the only control element is a colspan element, which can be used as a mini header further down the report.
=item clear_data
@@ -864,7 +880,7 @@ Returns the set attachment_basename option, or 'report' if nothing was set. See
=item generate_with_headers
-Parses the report, adds headers and prints it out. Headers depend on the option 'output_format',
+Parses the report, adds headers and prints it out. Headers depend on the option 'output_format',
for example 'HTML' will add proper table headers, html headers and http headers. See configuration for this option.
=item get_visible_columns $format
@@ -877,29 +893,21 @@ Escapes HTML characters in $value and substitutes newlines with '
'. Returns
=item prepare_html_content $column,$name,@column_headers
-Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked.
+Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked.
Should not be called extrenally, since all render and generate functions invoke it anyway.
-
+
=item generate_html_content
The html generation function. Is invoked by generate_with_headers.
=item generate_pdf_content
-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.
+The PDF generation function. It is invoked by generate_with_headers and renders the PDF with the PDF::API2 library.
=item generate_csv_content
The CSV generation function. Uses XS_CSV to parse the information into csv.
-=item render_pdf_with_pdf_api2
-
-PDF render function using the Perl module PDF::API2.
-
-=item render_pdf_with_html2ps
-
-PDF render function using the external application html2ps.
-
=back
=head1 CONFIGURATION
@@ -930,6 +938,12 @@ 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 controller_class
+
+If this is used from a C based controller class, pass the
+class name here and make sure C is
+used in the controller. That way the exports stay functional.
+
=back
=head2 PDF Options
@@ -944,7 +958,7 @@ Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and lega
Landscape or portrait. Default is landscape.
-=item font_name
+=item font_name
Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2.