Den Test, ob ein Artikel noch nicht benutzt wurde und deshalb gelöscht werden kann...

[kivitendo-erp.git] / SL / ReportGenerator.pm

diff --git a/SL/ReportGenerator.pm b/SL/ReportGenerator.pm
index 6a78c5370261988f4aac2788348b86e70bae16f1..29e2d9480c89938d08f131abc57d0aed58e300ac 100644 (file)
--- a/SL/ReportGenerator.pm
+++ b/SL/ReportGenerator.pm
@@ -1,7 +1,9 @@
 package SL::ReportGenerator;
 
 use IO::Wrap;
 package SL::ReportGenerator;
 
 use IO::Wrap;

+use List::Util qw(max);

 use Text::CSV_XS;
 use Text::CSV_XS;

+use Text::Iconv;

 
 use SL::Form;
 
 
 use SL::Form;
 


@@ -28,12 +30,15 @@ sub new {
       'margin_bottom'       => 1.5,
       'margin_right'        => 1.5,
       'number'              => 1,
       'margin_bottom'       => 1.5,
       'margin_right'        => 1.5,
       'number'              => 1,

+      'print'               => 0,
+      'printer_id'          => 0,
+      'copies'              => 1,

     },
     'csv_export'            => {
       'quote_char'          => '"',
       'sep_char'            => ';',
       'escape_char'         => '"',
     },
     'csv_export'            => {
       'quote_char'          => '"',
       'sep_char'            => ';',
       'escape_char'         => '"',

-      'eol_style'           => 'DOS',
+      'eol_style'           => 'Unix',

       'headers'             => 1,
     },
   };
       'headers'             => 1,
     },
   };


@@ -42,9 +47,38 @@ sub new {
     'variable_list' => '',
   };
 
     'variable_list' => '',
   };
 

+  $self->{data_present} = 0;
+
+  bless $self, $type;
+

   $self->set_options(@_) if (@_);
 
   $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 {
 }
 
 sub set_columns {


@@ -89,18 +123,35 @@ sub add_data {
   my $last_row_set;
 
   while (my $arg = shift) {
   my $last_row_set;
 
   while (my $arg = shift) {

+    my $row_set;
+

     if ('ARRAY' eq ref $arg) {
     if ('ARRAY' eq ref $arg) {

-      push @{ $self->{data} }, $arg;
-      $last_row_set = $arg;
+      $row_set = $arg;

 
     } elsif ('HASH' eq ref $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');
     }
 
     } 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;
   }
 
   return $last_row_set;


@@ -112,10 +163,18 @@ sub add_separator {
   push @{ $self->{data} }, { 'type' => '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;
 
 sub clear_data {
   my $self = shift;
 

-  $self->{data} = [];
+  $self->{data}         = [];
+  $self->{data_present} = 0;

 }
 
 sub set_options {
 }
 
 sub set_options {


@@ -154,57 +213,43 @@ sub set_export_options {
   };
 }
 
   };
 }
 

-sub generate_content {
-  my $self   = shift;
-  my $format = lc $self->{options}->{output_format};
-
-  if (!$self->{columns}) {
-    $self->{form}->error('Incorrect usage -- no columns specified');
-  }
-
-  if ($format eq 'html') {
-    return $self->generate_html_content();
-
-  } elsif ($format eq 'csv') {
-    return $self->generate_csv_content();
-
-  } elsif ($format eq 'pdf') {
-    return $self->generate_pdf_content();
+sub get_attachment_basename {
+  my $self     = shift;
+  my $filename =  $self->{options}->{attachment_basename} || 'report';
+  $filename    =~ s|.*\\||;
+  $filename    =~ s|.*/||;

 
 

-  } else {
-    $self->{form}->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
-  }
+  return $filename;

 }
 
 sub generate_with_headers {
   my $self   = shift;
   my $format = lc $self->{options}->{output_format};
 }
 
 sub generate_with_headers {
   my $self   = shift;
   my $format = lc $self->{options}->{output_format};

+  my $form   = $self->{form};

 
   if (!$self->{columns}) {
 
   if (!$self->{columns}) {

-    $self->{form}->error('Incorrect usage -- no columns specified');
+    $form->error('Incorrect usage -- no columns specified');

   }
 
   }
 

-  my $filename =  $self->{options}->{attachment_basename} || 'report';
-  $filename    =~ s|.*\\||;
-  $filename    =~ s|.*/||;
-

   if ($format eq 'html') {
   if ($format eq 'html') {

-    $self->{form}->{title} = $self->{title};
-    $self->{form}->header();
+    my $title      = $form->{title};
+    $form->{title} = $self->{title} if ($self->{title});
+    $form->header();
+    $form->{title} = $title;
+

     print $self->generate_html_content();
 
   } elsif ($format eq 'csv') {
     print $self->generate_html_content();
 
   } elsif ($format eq 'csv') {

+    my $filename = $self->get_attachment_basename();

     print qq|content-type: text/csv\n|;
     print qq|content-disposition: attachment; filename=${filename}.csv\n\n|;
     $self->generate_csv_content();
 
   } elsif ($format eq 'pdf') {
     print qq|content-type: text/csv\n|;
     print qq|content-disposition: attachment; filename=${filename}.csv\n\n|;
     $self->generate_csv_content();
 
   } elsif ($format eq 'pdf') {

-    print qq|content-type: application/pdf\n|;
-    print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;

     $self->generate_pdf_content();
 
   } else {
     $self->generate_pdf_content();
 
   } else {

-    $self->{form}->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
+    $form->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');

   }
 }
 
   }
 }
 


@@ -212,7 +257,7 @@ sub get_visible_columns {
   my $self   = shift;
   my $format = shift;
 
   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 {
 }
 
 sub html_format {


@@ -249,18 +294,33 @@ sub prepare_html_content {
   }
 
   my ($outer_idx, $inner_idx) = (0, 0);
   }
 
   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) {
   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 = {
       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;
 
       };
 
       push @rows, $row_data;
 

+      $next_border_top = 0;
+

       next;
     }
 
       next;
     }
 


@@ -269,16 +329,36 @@ sub prepare_html_content {
     foreach my $row (@{ $row_set }) {
       $inner_idx++;
 
     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} }) && !$col->{CELL_ROWS}->[0]->{data}) {
+          $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,
 
       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;
       };
 
       push @rows, $row_data;

+
+      $next_border_top = 0;

     }
   }
 
     }
   }
 


@@ -297,13 +377,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},
     '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_NEXTSUB'       => $self->{export}->{nextsub},
     'COLUMN_HEADERS'       => \@column_headers,
     'NUM_COLUMNS'          => scalar @column_headers,
     'ROWS'                 => \@rows,
     'EXPORT_VARIABLES'     => \@export_variables,
     'EXPORT_VARIABLE_LIST' => $self->{export}->{variable_list},
     'EXPORT_NEXTSUB'       => $self->{export}->{nextsub},

+    'DATA_PRESENT'         => $self->{data_present},

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


@@ -368,6 +449,13 @@ BODY {
 END
   ;
 
 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.'));
 
   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.'));
 


@@ -385,21 +473,64 @@ END
   $html_file->print($form->parse_html_template('report_generator/pdf_report', $variables));
   $html_file->close();
 
   $html_file->print($form->parse_html_template('report_generator/pdf_report', $variables));
   $html_file->close();
 

-  my $gs = IO::File->new("\"${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 $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) {
   if ($gs) {

-    while (my $line = <$gs>) {
-      print $line;
+    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;
 
     $gs->close();
     unlink $cfg_file_name, $html_file_name;
 

+    if ($printer_command && $content) {
+      foreach my $i (1 .. max $opt->{copies}, 1) {
+        my $printer = IO::File->new("| ${printer_command}");
+        if (!$printer) {
+          $form->error($locale->text('Could not spawn the printer command.'));
+        }
+        $printer->print($content);
+        $printer->close();
+      }
+
+      $form->{report_generator_printed} = 1;
+    }
+

   } else {
     unlink $cfg_file_name, $html_file_name;
     $form->error($locale->text('Could not spawn html2ps or GhostScript.'));
   }
 }
 
   } else {
     unlink $cfg_file_name, $html_file_name;
     $form->error($locale->text('Could not spawn html2ps or GhostScript.'));
   }
 }
 

+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;
 
 sub generate_csv_content {
   my $self = shift;
 


@@ -425,13 +556,17 @@ sub generate_csv_content {
   my @visible_columns = $self->get_visible_columns('CSV');
 
   if ($opts->{headers}) {
   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 }) {
   }
 
   foreach my $row_set (@{ $self->{data} }) {
     next if ('ARRAY' ne ref $row_set);
     foreach my $row (@{ $row_set }) {

-      $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);

     }
   }
 }
     }
   }
 }