posaune

[mfinanz.git] / SL / ReportGenerator.pm

diff --git a/SL/ReportGenerator.pm b/SL/ReportGenerator.pm
index afae8633302b43e72d4495d14a8288a167bcd78e..6fc50e98f9384db85df8900630d1761f67e6cccf 100644 (file)
--- a/SL/ReportGenerator.pm
+++ b/SL/ReportGenerator.pm
@@ -1,7 +1,6 @@
 package SL::ReportGenerator;
 
 use Data::Dumper;
 package SL::ReportGenerator;
 
 use Data::Dumper;

-use IO::Wrap;

 use List::Util qw(max);
 use Text::CSV_XS;
 #use PDF::API2;    # these two eat up to .75s on startup. only load them if we actually need them
 use List::Util qw(max);
 use Text::CSV_XS;
 #use PDF::API2;    # these two eat up to .75s on startup. only load them if we actually need them


@@ -24,6 +23,7 @@ sub new {
   $self->{options}  = {
     'std_column_visibility' => 0,
     'output_format'         => 'HTML',
   $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',
     'allow_pdf_export'      => 1,
     'allow_csv_export'      => 1,
     'html_template'         => 'report_generator/html_report',


@@ -73,6 +73,12 @@ sub set_columns {
     $column->{visible} = $self->{options}->{std_column_visibility} unless defined $column->{visible};
   }
 
     $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} });
 }
 
   $self->set_column_order(sort keys %{ $self->{columns} });
 }
 


@@ -115,7 +121,7 @@ sub add_data {
         $row->{$column}->{align}   = $self->{columns}->{$column}->{align} unless (defined $row->{$column}->{align});
       }
 
         $row->{$column}->{align}   = $self->{columns}->{$column}->{align} unless (defined $row->{$column}->{align});
       }
 

-      foreach my $field (qw(data link)) {
+      foreach my $field (qw(data link link_class)) {

         map { $row->{$_}->{$field} = [ $row->{$_}->{$field} ] if (ref $row->{$_}->{$field} ne 'ARRAY') } keys %{ $row };
       }
     }
         map { $row->{$_}->{$field} = [ $row->{$_}->{$field} ] if (ref $row->{$_}->{$field} ne 'ARRAY') } keys %{ $row };
       }
     }


@@ -204,14 +210,17 @@ sub set_custom_headers {
 sub get_attachment_basename {
   my $self     = shift;
   my $filename =  $self->{options}->{attachment_basename} || 'report';
 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|.*\\||;
   $filename    =~ s|.*/||;

+  $filename    =~ s| |_|g;

 
   return $filename;
 }
 
 sub generate_with_headers {
 
   return $filename;
 }
 
 sub generate_with_headers {

-  my $self   = shift;
+  my ($self, %params) = @_;

   my $format = lc $self->{options}->{output_format};
   my $form   = $self->{form};
 
   my $format = lc $self->{options}->{output_format};
   my $form   = $self->{form};
 


@@ -222,12 +231,13 @@ sub generate_with_headers {
   if ($format eq 'html') {
     my $title      = $form->{title};
     $form->{title} = $self->{title} if ($self->{title});
   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') {
     $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|;
     my $filename = $self->get_attachment_basename();
     print qq|content-type: text/csv\n|;
     print qq|content-disposition: attachment; filename=${filename}.csv\n\n|;


@@ -339,8 +349,9 @@ sub prepare_html_content {
         $col->{CELL_ROWS} = [ ];
         foreach my $i (0 .. scalar(@{ $col->{data} }) - 1) {
           push @{ $col->{CELL_ROWS} }, {
         $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],
             'link' => $col->{link}->[$i],

+            link_class => $col->{link_class}->[$i],

           };
         }
 
           };
         }
 


@@ -390,6 +401,8 @@ sub prepare_html_content {
     'EXPORT_VARIABLE_LIST' => join(' ', @{ $self->{export}->{variable_list} }),
     'EXPORT_NEXTSUB'       => $self->{export}->{nextsub},
     'DATA_PRESENT'         => $self->{data_present},
     'EXPORT_VARIABLE_LIST' => join(' ', @{ $self->{export}->{variable_list} }),
     'EXPORT_NEXTSUB'       => $self->{export}->{nextsub},
     'DATA_PRESENT'         => $self->{data_present},

+    'CONTROLLER_DISPATCH'  => $opts->{controller_class},
+    'TABLE_CLASS'          => $opts->{table_class},

   };
 
   return $variables;
   };
 
   return $variables;


@@ -399,7 +412,8 @@ sub generate_html_content {
   my $self      = shift;
   my $variables = $self->prepare_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 {
 }
 
 sub _cm2bp {


@@ -425,11 +439,11 @@ sub generate_pdf_content {
   my (@data, @column_props, @cell_props);
 
   my ($data_row, $cell_props_row);
   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 $num_columns     = scalar @visible_columns;
   my $num_header_rows = 1;
 

-  my $font_encoding   = $main::dbcharset || 'ISO-8859-15';
+  my $font_encoding   = 'UTF-8';

 
   foreach my $name (@visible_columns) {
     push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };
 
   foreach my $name (@visible_columns) {
     push @column_props, { 'justify' => $self->{columns}->{$name}->{align} eq 'right' ? 'right' : 'left' };


@@ -565,8 +579,8 @@ sub generate_pdf_content {
   my $font_height       = $font_size + 2 * $padding;
   my $title_font_height = $font_size + 2 * $padding;
 
   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;
 
 
   my $top_text_height   = 0;
 


@@ -687,18 +701,26 @@ sub _print_content {
   }
 }
 
   }
 }
 

-sub unescape_string {
-  my $self  = shift;
-  my $text  = shift;
+sub _handle_quoting_and_encoding {
+  my ($self, $text, $do_unquote) = @_;

 
 

-  $text     = $main::locale->unquote_special_chars('HTML', $text);
-  $text     = $::locale->{iconv}->convert($text);
+  $text = $main::locale->unquote_special_chars('HTML', $text) if $do_unquote;
+  $text = Encode::encode('UTF-8', $text);

 
   return $text;
 }
 
 sub generate_csv_content {
 
   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);
 
   my %valid_sep_chars    = (';' => ';', ',' => ',', ':' => ':', 'TAB' => "\t");
   my %valid_escape_chars = ('"' => 1, "'" => 1);


@@ -718,12 +740,11 @@ sub generate_csv_content {
                                 'quote_char'  => $quote_char,
                                 'eol'         => $eol, });
 
                                 '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}) {
   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} }) {
 
     } else {
       foreach my $row (@{ $self->{custom_headers} }) {


@@ -731,7 +752,7 @@ sub generate_csv_content {
 
         foreach my $col (@{ $row }) {
           my $num_output = ($col->{colspan} && ($col->{colspan} > 1)) ? $col->{colspan} : 1;
 
         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);
         }
 
         $csv->print($stdout, $fields);


@@ -753,7 +774,7 @@ sub generate_csv_content {
         my $num_output = ($row->{$col}{colspan} && ($row->{$col}->{colspan} > 1)) ? $row->{$col}->{colspan} : 1;
         $skip_next     = $num_output - 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);
       }
 
         push @data, ('') x $skip_next if ($skip_next);
       }
 


@@ -762,13 +783,17 @@ sub generate_csv_content {
   }
 }
 
   }
 }
 

+sub check_for_pdf_api {
+  return eval { require PDF::API2; 1; } ? 1 : 0;
+}
+

 1;
 
 __END__
 
 =head1 NAME
 
 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
 
 
 =head1 SYNOPSIS
 


@@ -792,7 +817,7 @@ 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.
 
 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.
+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.
 
 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.
 


@@ -915,6 +940,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'.
 
 
 The template to be used for HTML reports. Default is 'report_generator/html_report'.
 

+=item controller_class
+
+If this is used from a C<SL::Controller::Base> based controller class, pass the
+class name here and make sure C<SL::Controller::Helper::ReportGenerator> is
+used in the controller. That way the exports stay functional.
+

 =back
 
 =head2 PDF Options
 =back
 
 =head2 PDF Options