Übergabe des Templates an den ReportGenerator nicht über $form, sondern über ReportGe...
[kivitendo-erp.git] / SL / ReportGenerator.pm
index 8f18385..23dd508 100644 (file)
@@ -3,9 +3,14 @@ package SL::ReportGenerator;
 use IO::Wrap;
 use List::Util qw(max);
 use Text::CSV_XS;
+use Text::Iconv;
 
 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;
 
@@ -20,6 +25,8 @@ sub new {
     'output_format'         => 'HTML',
     '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',
@@ -43,12 +50,41 @@ sub new {
   };
   $self->{export}   = {
     'nextsub'       => '',
-    'variable_list' => '',
+    'variable_list' => [],
   };
 
+  $self->{data_present} = 0;
+
+  bless $self, $type;
+
   $self->set_options(@_) if (@_);
 
-  return bless $self, $type;
+  $self->_init_escaped_strings_map();
+
+  return $self;
+}
+
+sub _init_escaped_strings_map {
+  my $self = shift;
+
+  $self->{escaped_strings_map} = {
+    'ä'  => 'ä',
+    'ö'  => 'ö',
+    'ü'  => 'ü',
+    'Ä'  => 'Ä',
+    'Ö'  => 'Ö',
+    'Ü'  => 'Ü',
+    'ß' => 'ß',
+    '>'    => '>',
+     '&lt;'    => '<',
+    '&quot;'  => '"',
+  };
+
+  my $iconv = $main::locale->{iconv_iso8859};
+
+  if ($iconv) {
+    map { $self->{escaped_strings_map}->{$_} = $iconv->convert($self->{escaped_strings_map}->{$_}) } keys %{ $self->{escaped_strings_map} };
+  }
 }
 
 sub set_columns {
@@ -93,18 +129,35 @@ sub add_data {
   my $last_row_set;
 
   while (my $arg = shift) {
+    my $row_set;
+
     if ('ARRAY' eq ref $arg) {
-      push @{ $self->{data} }, $arg;
-      $last_row_set = $arg;
+      $row_set = $arg;
 
     } elsif ('HASH' eq ref $arg) {
-      my $row_set = [ $arg ];
-      push @{ $self->{data} }, $row_set;
-      $last_row_set = $row_set;
+      $row_set = [ $arg ];
 
     } else {
       $self->{form}->error('Incorrect usage -- expecting hash or array ref');
     }
+
+    my @columns_with_default_alignment = grep { defined $self->{columns}->{$_}->{align} } keys %{ $self->{columns} };
+
+    foreach my $row (@{ $row_set }) {
+      foreach my $column (@columns_with_default_alignment) {
+        $row->{$column}          ||= { };
+        $row->{$column}->{align}   = $self->{columns}->{$column}->{align} unless (defined $row->{$column}->{align});
+      }
+
+      foreach my $field (qw(data link)) {
+        map { $row->{$_}->{$field} = [ $row->{$_}->{$field} ] if (ref $row->{$_}->{$field} ne 'ARRAY') } keys %{ $row };
+      }
+    }
+
+    push @{ $self->{data} }, $row_set;
+    $last_row_set = $row_set;
+
+    $self->{data_present} = 1;
   }
 
   return $last_row_set;
@@ -116,10 +169,18 @@ sub add_separator {
   push @{ $self->{data} }, { 'type' => 'separator' };
 }
 
+sub add_control {
+  my $self = shift;
+  my $data = shift;
+
+  push @{ $self->{data} }, $data;
+}
+
 sub clear_data {
   my $self = shift;
 
-  $self->{data} = [];
+  $self->{data}         = [];
+  $self->{data_present} = 0;
 }
 
 sub set_options {
@@ -154,7 +215,7 @@ sub set_export_options {
 
   $self->{export} = {
     'nextsub'       => shift,
-    'variable_list' => join(" ", @_),
+    'variable_list' => [ @_ ],
   };
 }
 
@@ -202,7 +263,7 @@ sub get_visible_columns {
   my $self   = shift;
   my $format = shift;
 
-  return grep { my $c = $self->{columns}->{$_}; $c && $c->{visible} && (($c->{visible} == 1) || ($c->{visible} =~ /${format}/i)) } @{ $self->{column_order} };
+  return grep { my $c = $self->{columns}->{$_}; $c && $c->{visible} && (($c->{visible} == 1) || ($c->{visible} =~ /\Q${format}\E/i)) } @{ $self->{column_order} };
 }
 
 sub html_format {
@@ -239,18 +300,33 @@ sub prepare_html_content {
   }
 
   my ($outer_idx, $inner_idx) = (0, 0);
+  my $next_border_top;
   my @rows;
 
   foreach my $row_set (@{ $self->{data} }) {
     if ('HASH' eq ref $row_set) {
+      if ($row_set->{type} eq 'separator') {
+        if (! scalar @rows) {
+          $next_border_top = 1;
+        } else {
+          $rows[-1]->{BORDER_BOTTOM} = 1;
+        }
+
+        next;
+      }
+
       my $row_data = {
-        'IS_CONTROL'    => 1,
-        'IS_SEPARATOR'  => $row_set->{type} eq 'separator',
-        'NUM_COLUMNS'   => scalar @visible_columns,
+        'IS_CONTROL'      => 1,
+        'IS_COLSPAN_DATA' => $row_set->{type} eq 'colspan_data',
+        'NUM_COLUMNS'     => scalar @visible_columns,
+        'BORDER_TOP'      => $next_border_top,
+        'data'            => $row_set->{data},
       };
 
       push @rows, $row_data;
 
+      $next_border_top = 0;
+
       next;
     }
 
@@ -259,23 +335,40 @@ sub prepare_html_content {
     foreach my $row (@{ $row_set }) {
       $inner_idx++;
 
-      map { $row->{$_}->{data} = $self->html_format($row->{$_}->{data}) } @visible_columns;
+      foreach my $col_name (@visible_columns) {
+        my $col = $row->{$col_name};
+        $col->{CELL_ROWS} = [ ];
+        foreach my $i (0 .. scalar(@{ $col->{data} }) - 1) {
+          push @{ $col->{CELL_ROWS} }, {
+            'data' => $self->html_format($col->{data}->[$i]),
+            'link' => $col->{link}->[$i],
+          };
+        }
+
+        # Force at least a &nbsp; to be displayed so that browsers
+        # will format the table cell (e.g. borders etc).
+        if (!scalar @{ $col->{CELL_ROWS} }) {
+          push @{ $col->{CELL_ROWS} }, { 'data' => '&nbsp;' };
+        } elsif ((1 == scalar @{ $col->{CELL_ROWS} }) && (!defined $col->{CELL_ROWS}->[0]->{data} || ($col->{CELL_ROWS}->[0]->{data} eq ''))) {
+          $col->{CELL_ROWS}->[0]->{data} = '&nbsp;';
+        }
+      }
 
       my $row_data = {
         'COLUMNS'       => [ map { $row->{$_} } @visible_columns ],
         'outer_idx'     => $outer_idx,
         'outer_idx_odd' => $outer_idx % 2,
         'inner_idx'     => $inner_idx,
+        'BORDER_TOP'    => $next_border_top,
       };
 
       push @rows, $row_data;
+
+      $next_border_top = 0;
     }
   }
 
-  my @export_variables;
-  foreach my $key (split m/ +/, $self->{export}->{variable_list}) {
-    push @export_variables, { 'key' => $key, 'value' => $self->{form}->{$key} };
-  }
+  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);
 
@@ -287,13 +380,14 @@ sub prepare_html_content {
     'RAW_BOTTOM_INFO_TEXT' => $opts->{raw_bottom_info_text},
     'ALLOW_PDF_EXPORT'     => $allow_pdf_export,
     'ALLOW_CSV_EXPORT'     => $opts->{allow_csv_export},
-    'SHOW_EXPORT_BUTTONS'  => $allow_pdf_export || $opts->{allow_csv_export},
+    'SHOW_EXPORT_BUTTONS'  => ($allow_pdf_export || $opts->{allow_csv_export}) && $self->{data_present},
     'COLUMN_HEADERS'       => \@column_headers,
     'NUM_COLUMNS'          => scalar @column_headers,
     'ROWS'                 => \@rows,
     'EXPORT_VARIABLES'     => \@export_variables,
-    'EXPORT_VARIABLE_LIST' => $self->{export}->{variable_list},
+    'EXPORT_VARIABLE_LIST' => join(' ', @{ $self->{export}->{variable_list} }),
     'EXPORT_NEXTSUB'       => $self->{export}->{nextsub},
+    'DATA_PRESENT'         => $self->{data_present},
   };
 
   return $variables;
@@ -303,7 +397,7 @@ sub generate_html_content {
   my $self      = shift;
   my $variables = $self->prepare_html_content();
 
-  return $self->{form}->parse_html_template('report_generator/html_report', $variables);
+  return $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
 }
 
 sub verify_paper_size {
@@ -379,7 +473,7 @@ END
     $form->error($locale->text('Could not write the temporary HTML file.'));
   }
 
-  $html_file->print($form->parse_html_template('report_generator/pdf_report', $variables));
+  $html_file->print($form->parse_html_template($self->{options}->{pdf_template}, $variables));
   $html_file->close();
 
   my $cmdline =
@@ -427,6 +521,19 @@ END
   }
 }
 
+sub unescape_string {
+  my $self = shift;
+  my $text = shift;
+
+  foreach my $key (keys %{ $self->{escaped_strings_map} }) {
+    $text =~ s/\Q$key\E/$self->{escaped_strings_map}->{$key}/g;
+  }
+
+  $text =~ s/\Q&amp;\E/&/g;
+
+  return $text;
+}
+
 sub generate_csv_content {
   my $self = shift;
 
@@ -452,14 +559,17 @@ sub generate_csv_content {
   my @visible_columns = $self->get_visible_columns('CSV');
 
   if ($opts->{headers}) {
-    $csv->print($stdout, [ map { $self->{columns}->{$_}->{text} } @visible_columns ]);
+    $csv->print($stdout, [ map { $self->unescape_string($self->{columns}->{$_}->{text}) } @visible_columns ]);
   }
 
   foreach my $row_set (@{ $self->{data} }) {
     next if ('ARRAY' ne ref $row_set);
     foreach my $row (@{ $row_set }) {
-      map { $row->{$_}->{data} =~ s/\r?\n/$eol/g } @visible_columns;
-      $csv->print($stdout, [ map { $row->{$_}->{data} } @visible_columns ]);
+      my @data;
+      foreach my $col (@visible_columns) {
+        push @data, join($eol, map { s/\r?\n/$eol/g; $_ } @{ $row->{$col}->{data} });
+      }
+      $csv->print($stdout, \@data);
     }
   }
 }