X-Git-Url: http://wagnertech.de/git?a=blobdiff_plain;f=SL%2FReportGenerator.pm;h=f390db058092e7632c1373f9235c6a450cfedf08;hb=ea707efcb3b6f5cda6ccf12fb86c4659b9db079f;hp=35a3d83e80d1a26dfb6f1eeca25611963adc71a3;hpb=a939b72794643b5ad273886ff6d66b782eecb601;p=kivitendo-erp.git
diff --git a/SL/ReportGenerator.pm b/SL/ReportGenerator.pm
index 35a3d83e8..f390db058 100644
--- a/SL/ReportGenerator.pm
+++ b/SL/ReportGenerator.pm
@@ -1,10 +1,20 @@
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;
+# Cause locales.pl to parse these files:
+# parse_html_template('report_generator/html_report')
+
sub new {
my $type = shift;
@@ -19,32 +29,41 @@ sub new {
'output_format' => 'HTML',
'allow_pdf_export' => 1,
'allow_csv_export' => 1,
+ 'html_template' => 'report_generator/html_report',
'pdf_export' => {
- 'paper_size' => 'A4',
+ 'paper_size' => 'a4',
'orientation' => 'landscape',
- 'font_size' => '10',
+ 'font_name' => 'Verdana',
+ 'font_size' => '7',
'margin_top' => 1.5,
'margin_left' => 1.5,
'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' => '"',
- 'eol_style' => 'DOS',
+ 'eol_style' => 'Unix',
'headers' => 1,
},
};
$self->{export} = {
'nextsub' => '',
- 'variable_list' => '',
+ 'variable_list' => [],
};
+ $self->{data_present} = 0;
+
+ bless $self, $type;
+
$self->set_options(@_) if (@_);
- return bless $self, $type;
+ return $self;
}
sub set_columns {
@@ -62,18 +81,8 @@ sub set_columns {
sub set_column_order {
my $self = shift;
-
- my $order = 0;
- my %columns = map { $order++; ($_, $order) } @_;
-
- foreach my $column (sort keys %{ $self->{columns} }) {
- next if $columns{$column};
-
- $order++;
- $columns{$column} = $order;
- }
-
- $self->{column_order} = [ sort { $columns{$a} <=> $columns{$b} } keys %columns ];
+ my %seen;
+ $self->{column_order} = [ grep { !$seen{$_}++ } @_, sort keys %{ $self->{columns} } ];
}
sub set_sort_indicator {
@@ -86,30 +95,74 @@ sub set_sort_indicator {
sub add_data {
my $self = shift;
+ my $last_row_set;
+
while (my $arg = shift) {
+ my $row_set;
+
if ('ARRAY' eq ref $arg) {
- push @{ $self->{data} }, $arg;
+ $row_set = $arg;
} elsif ('HASH' eq ref $arg) {
- push @{ $self->{data} }, [ $arg ];
+ $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;
+}
+
+sub add_separator {
+ my $self = shift;
+
+ 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 {
my $self = shift;
my %options = @_;
- map { $self->{options}->{$_} = $options{$_} } keys %options;
+ while (my ($key, $value) = each %options) {
+ if ($key eq 'pdf_export') {
+ map { $self->{options}->{pdf_export}->{$_} = $value->{$_} } keys %{ $value };
+ } else {
+ $self->{options}->{$key} = $value;
+ }
+ }
}
sub set_options_from_form {
@@ -137,61 +190,57 @@ sub set_export_options {
$self->{export} = {
'nextsub' => shift,
- 'variable_list' => join(" ", @_),
+ 'variable_list' => [ @_ ],
};
}
-sub generate_content {
- my $self = shift;
- my $format = lc $self->{options}->{output_format};
+sub set_custom_headers {
+ my $self = shift;
- if (!$self->{columns}) {
- $self->{form}->error('Incorrect usage -- no columns specified');
+ if (@_) {
+ $self->{custom_headers} = [ @_ ];
+ } else {
+ delete $self->{custom_headers};
}
+}
- 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};
+ my $form = $self->{form};
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') {
- $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 qq|content-type: text/plain\n\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|;
$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->{form}->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
+ $form->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
}
}
@@ -199,7 +248,18 @@ 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 {
+ my $self = shift;
+ my $value = shift;
+
+ $value = $main::locale->quote_special_chars('HTML', $value);
+ $value =~ s/\r//g;
+ $value =~ s/\n/
/g;
+
+ return $value;
}
sub prepare_html_content {
@@ -215,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},
@@ -224,48 +285,112 @@ sub prepare_html_content {
push @column_headers, $header;
}
+ my $header_rows;
+ if ($self->{custom_headers}) {
+ $header_rows = $self->{custom_headers};
+ } else {
+ $header_rows = [ \@column_headers ];
+ }
+
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_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;
+ }
+
$outer_idx++;
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) {
+ push @{ $col->{CELL_ROWS} }, {
+ 'data' => $self->html_format($col->{data}->[$i]),
+ 'link' => $col->{link}->[$i],
+ };
+ }
+
+ # Force at least a 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' => ' ' };
+ } 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,
+ '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);
+ my $allow_pdf_export = $opts->{allow_pdf_export};
my $variables = {
'TITLE' => $opts->{title},
- 'TOP_INFO_TEXT' => $opts->{top_info_text},
+ 'TOP_INFO_TEXT' => $self->html_format($opts->{top_info_text}),
'RAW_TOP_INFO_TEXT' => $opts->{raw_top_info_text},
- 'BOTTOM_INFO_TEXT' => $opts->{bottom_info_text},
+ 'BOTTOM_INFO_TEXT' => $self->html_format($opts->{bottom_info_text}),
'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},
- 'COLUMN_HEADERS' => \@column_headers,
+ 'SHOW_EXPORT_BUTTONS' => ($allow_pdf_export || $opts->{allow_csv_export}) && $self->{data_present},
+ 'HEADER_ROWS' => $header_rows,
'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;
@@ -275,93 +400,312 @@ 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 {
- my $self = shift;
- my $requested_paper_size = lc shift;
- my $default_paper_size = shift;
+sub _cm2bp {
+ # 1 bp = 1/72 in
+ # 1 in = 2.54 cm
+ return $_[0] * 72 / 2.54;
+}
- my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 letter legal);
+sub _decode_text {
+ my $self = shift;
+ my $text = shift;
- return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
+ $text = decode('UTF-8', $text) if ($self->{text_is_utf8});
+
+ return $text;
}
sub generate_pdf_content {
- my $self = shift;
- my $variables = $self->prepare_html_content();
- my $form = $self->{form};
- my $myconfig = $self->{myconfig};
- my $opt = $self->{options}->{pdf_export};
-
- my $opt_number = $opt->{number} ? 'number : 1' : '';
- my $opt_landscape = $opt->{orientation} eq 'landscape' ? 'landscape : 1' : '';
-
- my $opt_paper_size = $self->verify_paper_size($opt->{paper_size}, 'a4');
-
- my $html2ps_config = <<"END"
-\@html2ps {
- option {
- titlepage: 0;
- hyphenate: 0;
- colour: 1;
- ${opt_landscape};
- ${opt_number};
+ eval {
+ require PDF::API2;
+ require PDF::Table;
+ };
+
+ my $self = shift;
+ my $variables = $self->prepare_html_content();
+ my $form = $self->{form};
+ my $myconfig = $self->{myconfig};
+
+ my $opts = $self->{options};
+ my $pdfopts = $opts->{pdf_export};
+
+ my (@data, @column_props, @cell_props);
+
+ my ($data_row, $cell_props_row);
+ my @visible_columns = $self->get_visible_columns('HTML');
+ my $num_columns = scalar @visible_columns;
+ my $num_header_rows = 1;
+
+ 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' };
}
- paper {
- type: ${opt_paper_size};
+
+ if (!$self->{custom_headers}) {
+ $data_row = [];
+ $cell_props_row = [];
+ push @data, $data_row;
+ push @cell_props, $cell_props_row;
+
+ foreach my $name (@visible_columns) {
+ my $column = $self->{columns}->{$name};
+
+ push @{ $data_row }, $self->_decode_text($column->{text});
+ push @{ $cell_props_row }, {};
+ }
+
+ } else {
+ $num_header_rows = scalar @{ $self->{custom_headers} };
+
+ foreach my $custom_header_row (@{ $self->{custom_headers} }) {
+ $data_row = [];
+ $cell_props_row = [];
+ push @data, $data_row;
+ push @cell_props, $cell_props_row;
+
+ foreach my $custom_header_col (@{ $custom_header_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 }, {};
+ }
+ }
+ }
}
- break-table: 1;
-}
-\@page {
- margin-top: $opt->{margin_top}cm;
- margin-left: $opt->{margin_left}cm;
- margin-bottom: $opt->{margin_bottom}cm;
- margin-right: $opt->{margin_right}cm;
-}
+ foreach my $row_set (@{ $self->{data} }) {
+ if ('HASH' eq ref $row_set) {
+ if ($row_set->{type} eq 'colspan_data') {
+ push @data, [ $self->_decode_text($row_set->{data}) ];
+
+ $cell_props_row = [];
+ push @cell_props, $cell_props_row;
+
+ foreach (0 .. $num_columns - 1) {
+ push @{ $cell_props_row }, { 'background_color' => '#666666',
+ 'font_color' => '#ffffff',
+ 'colspan' => $_ == 0 ? -1 : undef, };
+ }
+ }
+ next;
+ }
-BODY {
- font-family: Helvetica;
- font-size: $opt->{font_size}pt;
-}
+ foreach my $row (@{ $row_set }) {
+ $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 }, $self->_decode_text(join("\n", @{ $col->{data} }));
+
+ $column_props[$col_idx]->{justify} = 'right' if ($col->{align} eq 'right');
+
+ my $cell_props = { };
+ push @{ $cell_props_row }, $cell_props;
+
+ if ($col->{colspan} && $col->{colspan} > 1) {
+ $cell_props->{colspan} = $col->{colspan};
+ }
+
+ $col_idx++;
+ }
+ }
+ }
+
+ foreach my $i (0 .. scalar(@data) - 1) {
+ my $aref = $data[$i];
+ my $num_columns_here = scalar @{ $aref };
+
+ if ($num_columns_here < $num_columns) {
+ push @{ $aref }, ('') x ($num_columns - $num_columns_here);
+ } elsif ($num_columns_here > $num_columns) {
+ splice @{ $aref }, $num_columns;
+ }
+ }
+
+ my $papersizes = {
+ 'a3' => [ 842, 1190 ],
+ 'a4' => [ 595, 842 ],
+ 'a5' => [ 420, 595 ],
+ 'letter' => [ 612, 792 ],
+ 'legal' => [ 612, 1008 ],
+ };
+
+ my %supported_fonts = map { $_ => 1 } qw(courier georgia helvetica times verdana);
+
+ my $paper_size = defined $pdfopts->{paper_size} && defined $papersizes->{lc $pdfopts->{paper_size}} ? lc $pdfopts->{paper_size} : 'a4';
+ my ($paper_width, $paper_height);
-END
- ;
+ if (lc $pdfopts->{orientation} eq 'landscape') {
+ ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[1, 0];
+ } else {
+ ($paper_width, $paper_height) = @{$papersizes->{$paper_size}}[0, 1];
+ }
+
+ my $margin_top = _cm2bp($pdfopts->{margin_top} || 1.5);
+ my $margin_bottom = _cm2bp($pdfopts->{margin_bottom} || 1.5);
+ my $margin_left = _cm2bp($pdfopts->{margin_left} || 1.5);
+ my $margin_right = _cm2bp($pdfopts->{margin_right} || 1.5);
+
+ my $table = PDF::Table->new();
+ my $pdf = PDF::API2->new();
+ my $page = $pdf->page();
+
+ $pdf->mediabox($paper_width, $paper_height);
- 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 $font = $pdf->corefont(defined $pdfopts->{font_name} && $supported_fonts{lc $pdfopts->{font_name}} ? ucfirst $pdfopts->{font_name} : 'Verdana',
+ '-encoding' => $font_encoding);
+ my $font_size = $pdfopts->{font_size} || 7;
+ my $title_font_size = $font_size + 1;
+ my $padding = 1;
+ my $font_height = $font_size + 2 * $padding;
+ my $title_font_height = $font_size + 2 * $padding;
- $cfg_file->print($html2ps_config);
- $cfg_file->close();
+ my $header_height = 2 * $title_font_height if ($opts->{title});
+ my $footer_height = 2 * $font_height if ($pdfopts->{number});
- my $html_file_name = Common::tmpname() . '.html';
- my $html_file = IO::File->new($html_file_name, 'w');
+ my $top_text_height = 0;
- if (!$html_file) {
- unlink $cfg_file_name;
- $form->error($locale->text('Could not write the temporary HTML file.'));
+ if ($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+$//;
+
+ my @lines = split m/\n/, $top_text;
+ $top_text_height = $font_height * scalar @lines;
+
+ foreach my $line_no (0 .. scalar(@lines) - 1) {
+ my $y_pos = $paper_height - $margin_top - $header_height - $line_no * $font_height;
+ my $text_obj = $page->text();
+
+ $text_obj->font($font, $font_size);
+ $text_obj->translate($margin_left, $y_pos);
+ $text_obj->text($lines[$line_no]);
+ }
}
- $html_file->print($form->parse_html_template('report_generator/pdf_report', $variables));
- $html_file->close();
+ $table->table($pdf,
+ $page,
+ \@data,
+ 'x' => $margin_left,
+ 'w' => $paper_width - $margin_left - $margin_right,
+ 'start_y' => $paper_height - $margin_top - $header_height - $top_text_height,
+ 'next_y' => $paper_height - $margin_top - $header_height,
+ 'start_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height - $top_text_height,
+ 'next_h' => $paper_height - $margin_top - $margin_bottom - $header_height - $footer_height,
+ 'padding' => 1,
+ 'background_color_odd' => '#ffffff',
+ 'background_color_even' => '#eeeeee',
+ 'font' => $font,
+ 'font_size' => $font_size,
+ 'font_color' => '#000000',
+ 'num_header_rows' => $num_header_rows,
+ 'header_props' => {
+ 'bg_color' => '#ffffff',
+ 'repeat' => 1,
+ 'font_color' => '#000000',
+ },
+ '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 = $self->_decode_text($main::locale->text("Page #1/#2", $page_num, $pdf->pages()));
+ my $text_obj = $curpage->text();
+
+ $text_obj->font($font, $font_size);
+ $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($label) / 2, $margin_bottom);
+ $text_obj->text($label);
+ }
+
+ if ($opts->{title}) {
+ my $title = $self->_decode_text($opts->{title});
+ my $text_obj = $curpage->text();
- 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 - |");
- if ($gs) {
- while (my $line = <$gs>) {
- print $line;
+ $text_obj->font($font, $title_font_size);
+ $text_obj->translate(($paper_width - $margin_left - $margin_right) / 2 + $margin_left - $text_obj->advancewidth($title) / 2,
+ $paper_height - $margin_top);
+ $text_obj->text($title, '-underline' => 1);
}
- $gs->close();
- unlink $cfg_file_name, $html_file_name;
+ }
+
+ my $content = $pdf->stringify();
+
+ my $printer_command;
+ if ($pdfopts->{print} && $pdfopts->{printer_id}) {
+ $form->{printer_id} = $pdfopts->{printer_id};
+ $form->get_printer_code($myconfig);
+ $printer_command = $form->{printer_command};
+ }
+
+ if ($printer_command) {
+ $self->_print_content('printer_command' => $printer_command,
+ 'content' => $content,
+ 'copies' => $pdfopts->{copies});
+ $form->{report_generator_printed} = 1;
} else {
- unlink $cfg_file_name, $html_file_name;
- $form->error($locale->text('Could not spawn html2ps or GhostScript.'));
+ my $filename = $self->get_attachment_basename();
+
+ print qq|content-type: application/pdf\n|;
+ print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
+
+ print $content;
+ }
+}
+
+sub verify_paper_size {
+ my $self = shift;
+ my $requested_paper_size = lc shift;
+ my $default_paper_size = shift;
+
+ my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 a5 letter legal);
+
+ return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
+}
+
+sub _print_content {
+ my $self = shift;
+ my %params = @_;
+
+ foreach my $i (1 .. max $params{copies}, 1) {
+ my $printer = IO::File->new("| $params{printer_command}");
+ $main::form->error($main::locale->text('Could not spawn the printer command.')) if (!$printer);
+ $printer->print($params{content});
+ $printer->close();
}
}
+sub unescape_string {
+ my $self = shift;
+ my $text = shift;
+ my $iconv = $main::locale->{iconv};
+
+ $text = $main::locale->unquote_special_chars('HTML', $text);
+ $text = $main::locale->{iconv}->convert($text) if ($main::locale->{iconv});
+
+ return $text;
+}
+
sub generate_csv_content {
my $self = shift;
@@ -387,14 +731,289 @@ sub generate_csv_content {
my @visible_columns = $self->get_visible_columns('CSV');
if ($opts->{headers}) {
- $csv->print($stdout, [ map { $self->{columns}->{$_}->{text} } @visible_columns ]);
+ if (!$self->{custom_headers}) {
+ $csv->print($stdout, [ map { $self->unescape_string($self->{columns}->{$_}->{text}) } @visible_columns ]);
+
+ } else {
+ 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);
+ }
+ }
}
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;
+ 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);
}
}
}
1;
+
+__END__
+
+=head1 NAME
+
+SL::ReportGenerator.pm: the Lx-Office way of getting data in shape
+
+=head1 SYNOPSIS
+
+ my $report = SL::ReportGenerator->new(\%myconfig, $form);
+ $report->set_options(%options); # optional
+ $report->set_columns(%column_defs);
+ $report->set_sort_indicator($column, $direction); # optional
+ $report->add_data($row1, $row2, @more_rows);
+ $report->generate_with_headers();
+
+This creates a report object, sets a few columns, adds some data and generates a standard report.
+Sorting of columns will be alphabetic, and options will be set to their defaults.
+The report will be printed including table headers, html headers and http headers.
+
+=head1 DESCRIPTION
+
+Imagine the following scenario:
+There's a simple form, which loads some data from the database, and needs to print it out. You write a template for it.
+Then there may be more than one line. You add a loop in the template.
+Then there are some options made by the user, such as hidden columns. You add more to the template.
+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.
+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.
+
+=head1 FUNCTIONS
+
+=over 4
+
+=item new \%myconfig,$form,%options
+
+Creates a new ReportGenerator object, sets all given options, and returns it.
+
+=item set_columns %columns
+
+Sets the columns available to this report.
+
+=item set_column_order @columns
+
+Sets the order of columns. Any columns not present here are appended in alphabetic order.
+
+=item set_sort_indicator $column,$direction
+
+Sets sorting ot the table by specifying a column and a direction, where the direction will be evaluated to ascending if true.
+Note that this is only for displaying. The data has to be presented already sorted.
+
+=item add_data \@data
+
+=item add_data \%data
+
+Adds data to the report. A given hash_ref is interpreted as a single line of data, every array_ref as a collection of lines.
+Every line will be expected to be in a kay => value format. Note that the rows have to be already sorted.
+ReportGenerator does only colum sorting on its own, and provides links to sorting and visual cue as to which column was sorted by.
+
+=item add_separator
+
+Adds a separator line to the report.
+
+=item add_control \%data
+
+Adds a control element to the data. Control elements are an experimental feature to add functionality to a report the regular data cannot.
+Every control element needs to set IS_CONTROL_DATA, in order to be recongnized by the template.
+Currently the only control element is a colspan element, which can be used as a mini header further down the report.
+
+=item clear_data
+
+Deletes all data filled into the report, but keeps options set.
+
+=item set_options %options
+
+Sets options. For an incomplete list of options, see section configuration.
+
+=item set_options_from_form
+
+Tries to import options from the $form object given at creation
+
+=item set_export_options $next_sub,@variable_list
+
+Sets next_sub and additional variables needed for export.
+
+=item get_attachment_basename
+
+Returns the set attachment_basename option, or 'report' if nothing was set. See configuration for the option.
+
+=item generate_with_headers
+
+Parses the report, adds headers and prints it out. Headers depend on the option 'output_format',
+for example 'HTML' will add proper table headers, html headers and http headers. See configuration for this option.
+
+=item get_visible_columns $format
+
+Returns a list of columns that will be visible in the report after considering all options or match the given format.
+
+=item html_format $value
+
+Escapes HTML characters in $value and substitutes newlines with '
'. Returns the escaped $value.
+
+=item prepare_html_content $column,$name,@column_headers
+
+Parses the data, and sets internal data needed for certain output format. Must be called once before the template is invoked.
+Should not be called extrenally, since all render and generate functions invoke it anyway.
+
+=item generate_html_content
+
+The html generation function. Is invoked by generate_with_headers.
+
+=item generate_pdf_content
+
+The PDF generation function. It is invoked by generate_with_headers, tests whether or not the Perl module PDF::API2 is installed and calls render_pdf_with_pdf_api2 if it is and render_pdf_with_html2ps otherwise.
+
+=item generate_csv_content
+
+The CSV generation function. Uses XS_CSV to parse the information into csv.
+
+=item render_pdf_with_pdf_api2
+
+PDF render function using the Perl module PDF::API2.
+
+=item render_pdf_with_html2ps
+
+PDF render function using the external application html2ps.
+
+=back
+
+=head1 CONFIGURATION
+
+These are known options and their defaults. Options for pdf export and csv export need to be set as a hashref inside the export option.
+
+=head2 General Options
+
+=over 4
+
+=item std_column_visibility
+
+Standard column visibility. Used if no visibility is set. Use this to save the trouble of enabling every column. Default is no.
+
+=item output_format
+
+Output format. Used by generate_with_headers to determine the format. Supported options are HTML, CSV, and PDF. Default is HTML.
+
+=item allow_pdf_export
+
+Used to determine if a button for PDF export should be displayed. Default is yes.
+
+=item allow_csv_export
+
+Used to determine if a button for CSV export should be displayed. Default is yes.
+
+=item html_template
+
+The template to be used for HTML reports. Default is 'report_generator/html_report'.
+
+=back
+
+=head2 PDF Options
+
+=over 4
+
+=item paper_size
+
+Paper size. Default is a4. Supported paper sizes are a3, a4, a5, letter and legal.
+
+=item orientation (landscape)
+
+Landscape or portrait. Default is landscape.
+
+=item font_name
+
+Default is Verdana. Supported font names are Courier, Georgia, Helvetica, Times and Verdana. This option only affects the rendering with PDF::API2.
+
+=item font_size
+
+Default is 7. This option only affects the rendering with PDF::API2.
+
+=item margin_top
+
+=item margin_left
+
+=item margin_bottom
+
+=item margin_right
+
+The paper margins in cm. They all default to 1.5.
+
+=item number
+
+Set to a true value if the pages should be numbered. Default is 1.
+
+=item print
+
+If set then the resulting PDF will be output to a printer. If not it will be downloaded by the user. Default is no.
+
+=item printer_id
+
+Default 0.
+
+=item copies
+
+Default 1.
+
+=back
+
+=head2 CSV Options
+
+=over 4
+
+=item quote_char
+
+Character to enclose entries. Default is double quote (").
+
+=item sep_char
+
+Character to separate entries. Default is semicolon (;).
+
+=item escape_char
+
+Character to escape the quote_char. Default is double quote (").
+
+=item eol_style
+
+End of line style. Default is Unix.
+
+=item headers
+
+Include headers? Default is yes.
+
+=back
+
+=head1 SEE ALO
+
+C
+
+=head1 MODULE AUTHORS
+
+Moritz Bunkus Embunkus@linet-services.deE
+
+L