Reportgenerator strict
[kivitendo-erp.git] / SL / ReportGenerator.pm
index cd9caea..f390db0 100644 (file)
@@ -1,9 +1,14 @@
 package SL::ReportGenerator;
 
+use strict;
+
+use Encode;
 use IO::Wrap;
 use List::Util qw(max);
 use Text::CSV_XS;
 use Text::Iconv;
+#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;
 
@@ -270,6 +275,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},
@@ -322,7 +328,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) {
@@ -339,10 +352,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,
@@ -359,9 +375,6 @@ sub prepare_html_content {
 
   my $allow_pdf_export = $opts->{allow_pdf_export};
 
-  eval { require PDF::API2; require PDF::Table; };
-  $allow_pdf_export |= 1 if (! $@);
-
   my $variables = {
     'TITLE'                => $opts->{title},
     'TOP_INFO_TEXT'        => $self->html_format($opts->{top_info_text}),
@@ -396,7 +409,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};
@@ -412,7 +439,10 @@ sub render_pdf_with_pdf_api2 {
   my $num_columns     = scalar @visible_columns;
   my $num_header_rows = 1;
 
-  foreach $name (@visible_columns) {
+  my $font_encoding     = $main::dbcharset || 'ISO-8859-15';
+  $self->{text_is_utf8} = $font_encoding =~ m/^utf-?8$/i;
+
+  foreach my $name (@visible_columns) {
     push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };
   }
 
@@ -422,10 +452,10 @@ sub render_pdf_with_pdf_api2 {
     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 },       $column->{text};
+      push @{ $data_row },       $self->_decode_text($column->{text});
       push @{ $cell_props_row }, {};
     }
 
@@ -439,8 +469,17 @@ sub render_pdf_with_pdf_api2 {
       push @cell_props, $cell_props_row;
 
       foreach my $custom_header_col (@{ $custom_header_row }) {
-        push @{ $data_row },       $custom_header_col->{text};
-        push @{ $cell_props_row }, {};
+        push @{ $data_row }, $self->_decode_text($custom_header_col->{text});
+
+        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 }, {};
+        }
       }
     }
   }
@@ -448,7 +487,7 @@ sub render_pdf_with_pdf_api2 {
   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;
@@ -463,24 +502,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++;
       }
     }
   }
@@ -527,7 +569,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;
@@ -540,7 +582,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+$//;
 
@@ -580,13 +622,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);
@@ -595,12 +638,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);
     }
   }
 
@@ -651,14 +695,6 @@ sub _print_content {
   }
 }
 
-sub generate_pdf_content {
-  my $self = shift;
-
-  eval { require PDF::API2; require PDF::Table; };
-
-  return $self->render_pdf_with_pdf_api2(@_);
-}
-
 sub unescape_string {
   my $self  = shift;
   my $text  = shift;
@@ -699,8 +735,15 @@ sub generate_csv_content {
       $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 (@{ $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);
       }
     }
   }
@@ -709,9 +752,20 @@ sub generate_csv_content {
     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);
     }
   }
@@ -868,7 +922,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. 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.
+Used to determine if a button for PDF export should be displayed. Default is yes.
 
 =item allow_csv_export