# 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;
'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',
$self->set_options(@_) if (@_);
- $self->_init_escaped_strings_map();
-
return $self;
}
-sub _init_escaped_strings_map {
- my $self = shift;
-
- $self->{escaped_strings_map} = {
- 'ä' => 'ä',
- 'ö' => 'ö',
- 'ü' => 'ü',
- 'Ä' => 'Ä',
- 'Ö' => 'Ö',
- 'Ü' => 'Ü',
- 'ß' => 'ß',
- '>' => '>',
- '<' => '<',
- '"' => '"',
- };
-
- 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 = @_;
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 {
my $self = shift;
my $value = shift;
- $value = $self->{form}->quote_html($value);
+ $value = $main::locale->quote_special_chars('HTML', $value);
$value =~ s/\r//g;
$value =~ s/\n/<br>/g;
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};
eval { require PDF::API2; require PDF::Table; };
$allow_pdf_export |= 1 if (! $@);
my $myconfig = $self->{myconfig};
my $opts = $self->{options};
- my $params = $opts->{pdf_export};
+ my $pdfopts = $opts->{pdf_export};
my (@data, @column_props, @cell_props);
push @cell_props, $cell_props_row;
foreach (0 .. $num_columns - 1) {
- push @{ $cell_props_row }, { 'background_color' => '#000000',
- 'font_color' => '#ffffff', };
+ push @{ $cell_props_row }, { 'background_color' => '#666666',
+ 'font_color' => '#ffffff',
+ 'colspan' => $_ == 0 ? -1 : undef, };
}
}
next;
my %supported_fonts = map { $_ => 1 } qw(courier georgia helvetica times verdana);
- my $paper_size = defined $params->{paper_size} && defined $papersizes->{lc $params->{paper_size}} ? lc $params->{paper_size} : 'a4';
+ my $paper_size = defined $pdfopts->{paper_size} && defined $papersizes->{lc $pdfopts->{paper_size}} ? lc $pdfopts->{paper_size} : 'a4';
my ($paper_width, $paper_height);
- if (lc $params->{orientation} eq 'landscape') {
+ 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($params->{margin_top} || 1.5);
- my $margin_bottom = _cm2bp($params->{margin_bottom} || 1.5);
- my $margin_left = _cm2bp($params->{margin_left} || 1.5);
- my $margin_right = _cm2bp($params->{margin_right} || 1.5);
+ 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();
$pdf->mediabox($paper_width, $paper_height);
- my $font = $pdf->corefont(defined $params->{font_name} && $supported_fonts{lc $params->{font_name}} ? ucfirst $params->{font_name} : 'Verdana',
+ my $font = $pdf->corefont(defined $pdfopts->{font_name} && $supported_fonts{lc $pdfopts->{font_name}} ? ucfirst $pdfopts->{font_name} : 'Verdana',
'-encoding' => $main::dbcharset || 'ISO-8859-15');
- my $font_size = $params->{font_size} || 7;
+ 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;
my $header_height = 2 * $title_font_height if ($opts->{title});
- my $footer_height = 2 * $font_height if ($params->{number});
+ my $footer_height = 2 * $font_height if ($pdfopts->{number});
my $top_text_height = 0;
foreach my $page_num (1..$pdf->pages()) {
my $curpage = $pdf->openpage($page_num);
- if ($params->{number}) {
+ if ($pdfopts->{number}) {
my $label = $main::locale->text("Page #1/#2", $page_num, $pdf->pages());
my $text_obj = $curpage->text();
}
}
- my $filename = $self->get_attachment_basename();
-
- print qq|content-type: application/pdf\n|;
- print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
-
- print $pdf->stringify();
-}
-
-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 letter legal);
-
- return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
-}
-
-sub render_pdf_with_html2ps {
- 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};
- }
- paper {
- type: ${opt_paper_size};
- }
- 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;
-}
-
-BODY {
- font-family: Helvetica;
- font-size: $opt->{font_size}pt;
-}
-
-END
- ;
+ my $content = $pdf->stringify();
my $printer_command;
- if ($opt->{print} && $opt->{printer_id}) {
- $form->{printer_id} = $opt->{printer_id};
+ if ($pdfopts->{print} && $pdfopts->{printer_id}) {
+ $form->{printer_id} = $pdfopts->{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.'));
+ if ($printer_command) {
+ $self->_print_content('printer_command' => $printer_command,
+ 'content' => $content,
+ 'copies' => $pdfopts->{copies});
+ $form->{report_generator_printed} = 1;
- $cfg_file->print($html2ps_config);
- $cfg_file->close();
+ } else {
+ my $filename = $self->get_attachment_basename();
- my $html_file_name = Common::tmpname() . '.html';
- my $html_file = IO::File->new($html_file_name, 'w');
+ print qq|content-type: application/pdf\n|;
+ print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
- if (!$html_file) {
- unlink $cfg_file_name;
- $form->error($locale->text('Could not write the temporary HTML file.'));
+ print $content;
}
+}
- $html_file->print($form->parse_html_template($self->{options}->{pdf_template}, $variables));
- $html_file->close();
-
- 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) {
- 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;
- }
- }
+sub verify_paper_size {
+ my $self = shift;
+ my $requested_paper_size = lc shift;
+ my $default_paper_size = shift;
- $gs->close();
- unlink $cfg_file_name, $html_file_name;
+ my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 a5 letter legal);
- 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();
- }
+ return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
+}
- $form->{report_generator_printed} = 1;
- }
+sub _print_content {
+ my $self = shift;
+ my %params = @_;
- } else {
- unlink $cfg_file_name, $html_file_name;
- $form->error($locale->text('Could not spawn html2ps or GhostScript.'));
+ 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();
}
}
eval { require PDF::API2; require PDF::Table; };
- if ($@) {
- return $self->render_pdf_with_html2ps(@_);
- } else {
- return $self->render_pdf_with_pdf_api2(@_);
- }
+ return $self->render_pdf_with_pdf_api2(@_);
}
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;
- }
+ my $self = shift;
+ my $text = shift;
+ my $iconv = $main::locale->{iconv};
- $text =~ s/\Q&\E/&/g;
+ $text = $main::locale->unquote_special_chars('HTML', $text);
+ $text = $main::locale->{iconv}->convert($text) if ($main::locale->{iconv});
return $text;
}
}
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 '<br>'. 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. The PDF button is hidden if neither the Perl module PDF::API2 nor the external applications html2ps and Ghostscript are available regardless of this parameter's value.
+
+=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<Template.pm>
+
+=head1 MODULE AUTHORS
+
+Moritz Bunkus E<lt>mbunkus@linet-services.deE<gt>
+
+L<http://linet-services.de>
projects / kivitendo-erp.git / blobdiff