X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FReportGenerator.pm;h=050984aa30693dbf10fd8ac7fe2361e14edd2dd7;hb=58b90d2d1159a4564f4ef0533669a506442e88eb;hp=67010cfc353836d3a1cbc419f96ad5f53224866b;hpb=d94065013163172158ea04a4c7ff323e98a211e6;p=kivitendo-erp.git diff --git a/SL/ReportGenerator.pm b/SL/ReportGenerator.pm index 67010cfc3..050984aa3 100644 --- a/SL/ReportGenerator.pm +++ b/SL/ReportGenerator.pm @@ -1,15 +1,17 @@ package SL::ReportGenerator; +use Encode; use IO::Wrap; use List::Util qw(max); use Text::CSV_XS; use Text::Iconv; +use PDF::API2; +use PDF::Table; 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 +28,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 +192,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'; @@ -262,6 +273,7 @@ sub prepare_html_content { my $header = { 'name' => $name, + 'align' => $column->{align}, 'link' => $column->{link}, 'text' => $column->{text}, 'show_sort_indicator' => $name eq $opts->{sort_indicator_column}, @@ -271,6 +283,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; @@ -307,7 +326,14 @@ sub prepare_html_content { foreach my $row (@{ $row_set }) { $inner_idx++; + my $output_columns = [ ]; + my $skip_next = 0; foreach my $col_name (@visible_columns) { + if ($skip_next) { + $skip_next--; + next; + } + my $col = $row->{$col_name}; $col->{CELL_ROWS} = [ ]; foreach my $i (0 .. scalar(@{ $col->{data} }) - 1) { @@ -324,10 +350,13 @@ sub prepare_html_content { } elsif ((1 == scalar @{ $col->{CELL_ROWS} }) && (!defined $col->{CELL_ROWS}->[0]->{data} || ($col->{CELL_ROWS}->[0]->{data} eq ''))) { $col->{CELL_ROWS}->[0]->{data} = ' '; } + + push @{ $output_columns }, $col; + $skip_next = $col->{colspan} ? $col->{colspan} - 1 : 0; } my $row_data = { - 'COLUMNS' => [ map { $row->{$_} } @visible_columns ], + 'COLUMNS' => $output_columns, 'outer_idx' => $outer_idx, 'outer_idx_odd' => $outer_idx % 2, 'inner_idx' => $inner_idx, @@ -342,10 +371,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); - - eval { require PDF::API2; require PDF::Table; }; - $allow_pdf_export |= 1 if (! $@); + my $allow_pdf_export = $opts->{allow_pdf_export}; my $variables = { 'TITLE' => $opts->{title}, @@ -356,7 +382,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, @@ -381,7 +407,21 @@ sub _cm2bp { return $_[0] * 72 / 2.54; } -sub render_pdf_with_pdf_api2 { +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; + require PDF::Table; + }; + my $self = shift; my $variables = $self->prepare_html_content(); my $form = $self->{form}; @@ -392,27 +432,60 @@ 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}; + my $font_encoding = $main::dbcharset || 'ISO-8859-15'; + $self->{text_is_utf8} = $font_encoding =~ m/^utf-?8$/i; - push @{ $data_row }, $column->{text}; - push @{ $cell_props_row }, {}; - push @column_props, { 'justify' => $column->{align} eq 'right' ? 'right' : 'left' }; + foreach $name (@visible_columns) { + 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 }, $self->_decode_text($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; + + foreach my $custom_header_col (@{ $custom_header_row }) { + push @{ $data_row }, $self->_decode_text($custom_header_col->{text}); - my $num_columns = scalar @column_props; + my $num_output = ($custom_header_col->{colspan} * 1 > 1) ? $custom_header_col->{colspan} : 1; + if ($num_output > 1) { + push @{ $data_row }, ('') x ($num_output - 1); + push @{ $cell_props_row }, { 'colspan' => $num_output }; + push @{ $cell_props_row }, ({ }) x ($num_output - 1); + + } else { + push @{ $cell_props_row }, {}; + } + } + } + } foreach my $row_set (@{ $self->{data} }) { if ('HASH' eq ref $row_set) { if ($row_set->{type} eq 'colspan_data') { - push @data, [ $row_set->{data} ]; + push @data, [ $self->_decode_text($row_set->{data}) ]; $cell_props_row = []; push @cell_props, $cell_props_row; @@ -427,24 +500,27 @@ sub render_pdf_with_pdf_api2 { } foreach my $row (@{ $row_set }) { - $data_row = []; - push @data, $data_row; + $data_row = []; + $cell_props_row = []; + + push @data, $data_row; + push @cell_props, $cell_props_row; my $col_idx = 0; foreach my $col_name (@visible_columns) { my $col = $row->{$col_name}; - push @{ $data_row }, join("\n", @{ $col->{data} }); + push @{ $data_row }, $self->_decode_text(join("\n", @{ $col->{data} })); $column_props[$col_idx]->{justify} = 'right' if ($col->{align} eq 'right'); - $col_idx++; - } + my $cell_props = { }; + push @{ $cell_props_row }, $cell_props; - $cell_props_row = []; - push @cell_props, $cell_props_row; + if ($col->{colspan} && $col->{colspan} > 1) { + $cell_props->{colspan} = $col->{colspan}; + } - foreach (0 .. $num_columns - 1) { - push @{ $cell_props_row }, { }; + $col_idx++; } } } @@ -491,7 +567,7 @@ sub render_pdf_with_pdf_api2 { $pdf->mediabox($paper_width, $paper_height); my $font = $pdf->corefont(defined $pdfopts->{font_name} && $supported_fonts{lc $pdfopts->{font_name}} ? ucfirst $pdfopts->{font_name} : 'Verdana', - '-encoding' => $main::dbcharset || 'ISO-8859-15'); + '-encoding' => $font_encoding); my $font_size = $pdfopts->{font_size} || 7; my $title_font_size = $font_size + 1; my $padding = 1; @@ -504,7 +580,7 @@ sub render_pdf_with_pdf_api2 { my $top_text_height = 0; if ($self->{options}->{top_info_text}) { - my $top_text = $self->{options}->{top_info_text}; + my $top_text = $self->_decode_text($self->{options}->{top_info_text}); $top_text =~ s/\r//g; $top_text =~ s/\n+$//; @@ -536,6 +612,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, @@ -543,13 +620,14 @@ sub render_pdf_with_pdf_api2 { }, 'column_props' => \@column_props, 'cell_props' => \@cell_props, + 'max_word_length' => 60, ); foreach my $page_num (1..$pdf->pages()) { my $curpage = $pdf->openpage($page_num); if ($pdfopts->{number}) { - my $label = $main::locale->text("Page #1/#2", $page_num, $pdf->pages()); + my $label = $self->_decode_text($main::locale->text("Page #1/#2", $page_num, $pdf->pages())); my $text_obj = $curpage->text(); $text_obj->font($font, $font_size); @@ -558,12 +636,13 @@ sub render_pdf_with_pdf_api2 { } if ($opts->{title}) { + my $title = $self->_decode_text($opts->{title}); my $text_obj = $curpage->text(); $text_obj->font($font, $title_font_size); - $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($opts->{title}) / 2, + $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($title) / 2, $paper_height - $margin_top); - $text_obj->text($opts->{title}, '-underline' => 1); + $text_obj->text($title, '-underline' => 1); } } @@ -602,111 +681,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 = @_; @@ -719,18 +693,6 @@ sub _print_content { } } -sub generate_pdf_content { - my $self = shift; - - eval { require PDF::API2; require PDF::Table; }; - - if ($@) { - return $self->render_pdf_with_html2ps(@_); - } else { - return $self->render_pdf_with_pdf_api2(@_); - } -} - sub unescape_string { my $self = shift; my $text = shift; @@ -767,16 +729,41 @@ 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 $row (@{ $self->{custom_headers} }) { + my $fields = [ ]; + + 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; + } + + $csv->print($stdout, $fields); + } + } } foreach my $row_set (@{ $self->{data} }) { next if ('ARRAY' ne ref $row_set); foreach my $row (@{ $row_set }) { my @data; + my $skip_next = 0; foreach my $col (@visible_columns) { + if ($skip_next) { + $skip_next--; + next; + } + + my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1; + $skip_next = $num_output - 1; + push @data, join($eol, map { s/\r?\n/$eol/g; $_ } @{ $row->{$col}->{data} }); + push @data, ('') x $skip_next if ($skip_next); } + $csv->print($stdout, \@data); } } @@ -899,7 +886,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 +894,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 @@ -943,10 +930,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 +938,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 +946,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 +960,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 +994,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