Übergabe des Templates an den ReportGenerator nicht über $form, sondern über ReportGe...
[kivitendo-erp.git] / SL / ReportGenerator.pm
index b02ab35..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,7 +50,7 @@ sub new {
   };
   $self->{export}   = {
     'nextsub'       => '',
-    'variable_list' => '',
+    'variable_list' => [],
   };
 
   $self->{data_present} = 0;
@@ -52,9 +59,34 @@ sub new {
 
   $self->set_options(@_) if (@_);
 
+  $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 {
   my $self    = shift;
   my %columns = @_;
@@ -183,7 +215,7 @@ sub set_export_options {
 
   $self->{export} = {
     'nextsub'       => shift,
-    'variable_list' => join(" ", @_),
+    'variable_list' => [ @_ ],
   };
 }
 
@@ -268,20 +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',
         '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;
     }
 
@@ -298,7 +343,15 @@ sub prepare_html_content {
             '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 = {
@@ -306,16 +359,16 @@ sub prepare_html_content {
         '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);
 
@@ -332,7 +385,7 @@ sub prepare_html_content {
     '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},
   };
@@ -344,7 +397,7 @@ sub generate_html_content {
   my $self      = shift;
   my $variables = $self->prepare_html_content();
 
-  return $self->{form}->parse_html_template2('report_generator/html_report', $variables);
+  return $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
 }
 
 sub verify_paper_size {
@@ -420,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 =
@@ -468,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;
 
@@ -493,7 +559,7 @@ 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} }) {