1 package SL::ReportGenerator;
13 $self->{myconfig} = shift;
14 $self->{form} = shift;
18 'std_column_visibility' => 0,
19 'output_format' => 'HTML',
20 'allow_pdf_export' => 1,
21 'allow_csv_export' => 1,
24 'orientation' => 'landscape',
28 'margin_bottom' => 1.5,
29 'margin_right' => 1.5,
42 'variable_list' => '',
45 $self->set_options(@_) if (@_);
47 return bless $self, $type;
54 $self->{columns} = \%columns;
56 foreach my $column (values %{ $self->{columns} }) {
57 $column->{visible} = $self->{options}->{std_column_visibility} unless defined $column->{visible};
60 $self->set_column_order(sort keys %{ $self->{columns} });
63 sub set_column_order {
67 my %columns = map { $order++; ($_, $order) } @_;
69 foreach my $column (sort keys %{ $self->{columns} }) {
70 next if $columns{$column};
73 $columns{$column} = $order;
76 $self->{column_order} = [ sort { $columns{$a} <=> $columns{$b} } keys %columns ];
79 sub set_sort_indicator {
82 $self->{options}->{sort_indicator_column} = shift;
83 $self->{options}->{sort_indicator_direction} = shift;
91 while (my $arg = shift) {
92 if ('ARRAY' eq ref $arg) {
93 push @{ $self->{data} }, $arg;
96 } elsif ('HASH' eq ref $arg) {
97 my $row_set = [ $arg ];
98 push @{ $self->{data} }, $row_set;
99 $last_row_set = $row_set;
102 $self->{form}->error('Incorrect usage -- expecting hash or array ref');
106 return $last_row_set;
112 push @{ $self->{data} }, { 'type' => 'separator' };
125 map { $self->{options}->{$_} = $options{$_} } keys %options;
128 sub set_options_from_form {
131 my $form = $self->{form};
132 my $myconfig = $self->{myconfig};
134 foreach my $key (qw(output_format)) {
135 my $full_key = "report_generator_${key}";
136 $self->{options}->{$key} = $form->{$full_key} if (defined $form->{$full_key});
139 foreach my $format (qw(pdf csv)) {
140 my $opts = $self->{options}->{"${format}_export"};
141 foreach my $key (keys %{ $opts }) {
142 my $full_key = "report_generator_${format}_options_${key}";
143 $opts->{$key} = $key =~ /^margin/ ? $form->parse_amount($myconfig, $form->{$full_key}) : $form->{$full_key};
148 sub set_export_options {
153 'variable_list' => join(" ", @_),
157 sub generate_content {
159 my $format = lc $self->{options}->{output_format};
161 if (!$self->{columns}) {
162 $self->{form}->error('Incorrect usage -- no columns specified');
165 if ($format eq 'html') {
166 return $self->generate_html_content();
168 } elsif ($format eq 'csv') {
169 return $self->generate_csv_content();
171 } elsif ($format eq 'pdf') {
172 return $self->generate_pdf_content();
175 $self->{form}->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
179 sub generate_with_headers {
181 my $format = lc $self->{options}->{output_format};
183 if (!$self->{columns}) {
184 $self->{form}->error('Incorrect usage -- no columns specified');
187 my $filename = $self->{options}->{attachment_basename} || 'report';
188 $filename =~ s|.*\\||;
189 $filename =~ s|.*/||;
191 if ($format eq 'html') {
192 $self->{form}->{title} = $self->{title};
193 $self->{form}->header();
194 print $self->generate_html_content();
196 } elsif ($format eq 'csv') {
197 print qq|content-type: text/csv\n|;
198 print qq|content-disposition: attachment; filename=${filename}.csv\n\n|;
199 $self->generate_csv_content();
201 } elsif ($format eq 'pdf') {
202 print qq|content-type: application/pdf\n|;
203 print qq|content-disposition: attachment; filename=${filename}.pdf\n\n|;
204 $self->generate_pdf_content();
207 $self->{form}->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
211 sub get_visible_columns {
215 return grep { my $c = $self->{columns}->{$_}; $c && $c->{visible} && (($c->{visible} == 1) || ($c->{visible} =~ /${format}/i)) } @{ $self->{column_order} };
222 $value = $self->{form}->quote_html($value);
224 $value =~ s/\n/<br>/g;
229 sub prepare_html_content {
232 my ($column, $name, @column_headers);
234 my $opts = $self->{options};
235 my @visible_columns = $self->get_visible_columns('HTML');
237 foreach $name (@visible_columns) {
238 $column = $self->{columns}->{$name};
242 'link' => $column->{link},
243 'text' => $column->{text},
244 'show_sort_indicator' => $name eq $opts->{sort_indicator_column},
245 'sort_indicator_direction' => $opts->{sort_indicator_direction},
248 push @column_headers, $header;
251 my ($outer_idx, $inner_idx) = (0, 0);
254 foreach my $row_set (@{ $self->{data} }) {
255 if ('HASH' eq ref $row_set) {
258 'IS_SEPARATOR' => $row_set->{type} eq 'separator',
259 'NUM_COLUMNS' => scalar @visible_columns,
262 push @rows, $row_data;
269 foreach my $row (@{ $row_set }) {
272 map { $row->{$_}->{data} = $self->html_format($row->{$_}->{data}) } @visible_columns;
275 'COLUMNS' => [ map { $row->{$_} } @visible_columns ],
276 'outer_idx' => $outer_idx,
277 'outer_idx_odd' => $outer_idx % 2,
278 'inner_idx' => $inner_idx,
281 push @rows, $row_data;
285 my @export_variables;
286 foreach my $key (split m/ +/, $self->{export}->{variable_list}) {
287 push @export_variables, { 'key' => $key, 'value' => $self->{form}->{$key} };
290 my $allow_pdf_export = $opts->{allow_pdf_export} && (-x $main::html2ps_bin) && (-x $main::ghostscript_bin);
293 'TITLE' => $opts->{title},
294 'TOP_INFO_TEXT' => $self->html_format($opts->{top_info_text}),
295 'RAW_TOP_INFO_TEXT' => $opts->{raw_top_info_text},
296 'BOTTOM_INFO_TEXT' => $self->html_format($opts->{bottom_info_text}),
297 'RAW_BOTTOM_INFO_TEXT' => $opts->{raw_bottom_info_text},
298 'ALLOW_PDF_EXPORT' => $allow_pdf_export,
299 'ALLOW_CSV_EXPORT' => $opts->{allow_csv_export},
300 'SHOW_EXPORT_BUTTONS' => $allow_pdf_export || $opts->{allow_csv_export},
301 'COLUMN_HEADERS' => \@column_headers,
302 'NUM_COLUMNS' => scalar @column_headers,
304 'EXPORT_VARIABLES' => \@export_variables,
305 'EXPORT_VARIABLE_LIST' => $self->{export}->{variable_list},
306 'EXPORT_NEXTSUB' => $self->{export}->{nextsub},
312 sub generate_html_content {
314 my $variables = $self->prepare_html_content();
316 return $self->{form}->parse_html_template('report_generator/html_report', $variables);
319 sub verify_paper_size {
321 my $requested_paper_size = lc shift;
322 my $default_paper_size = shift;
324 my %allowed_paper_sizes = map { $_ => 1 } qw(a3 a4 letter legal);
326 return $allowed_paper_sizes{$requested_paper_size} ? $requested_paper_size : $default_paper_size;
329 sub generate_pdf_content {
331 my $variables = $self->prepare_html_content();
332 my $form = $self->{form};
333 my $myconfig = $self->{myconfig};
334 my $opt = $self->{options}->{pdf_export};
336 my $opt_number = $opt->{number} ? 'number : 1' : '';
337 my $opt_landscape = $opt->{orientation} eq 'landscape' ? 'landscape : 1' : '';
339 my $opt_paper_size = $self->verify_paper_size($opt->{paper_size}, 'a4');
341 my $html2ps_config = <<"END"
351 type: ${opt_paper_size};
357 margin-top: $opt->{margin_top}cm;
358 margin-left: $opt->{margin_left}cm;
359 margin-bottom: $opt->{margin_bottom}cm;
360 margin-right: $opt->{margin_right}cm;
364 font-family: Helvetica;
365 font-size: $opt->{font_size}pt;
371 my $cfg_file_name = Common::tmpname() . '-html2ps-config';
372 my $cfg_file = IO::File->new($cfg_file_name, 'w') || $form->error($locale->text('Could not write the html2ps config file.'));
374 $cfg_file->print($html2ps_config);
377 my $html_file_name = Common::tmpname() . '.html';
378 my $html_file = IO::File->new($html_file_name, 'w');
381 unlink $cfg_file_name;
382 $form->error($locale->text('Could not write the temporary HTML file.'));
385 $html_file->print($form->parse_html_template('report_generator/pdf_report', $variables));
388 my $gs = IO::File->new("\"${main::html2ps_bin}\" -f \"${cfg_file_name}\" \"${html_file_name}\" | " .
389 "\"${main::ghostscript_bin}\" -q -dSAFER -dNOPAUSE -dBATCH -sDEVICE=pdfwrite -sPAPERSIZE=${opt_paper_size} -sOutputFile=- -c .setpdfwrite - |");
391 while (my $line = <$gs>) {
395 unlink $cfg_file_name, $html_file_name;
398 unlink $cfg_file_name, $html_file_name;
399 $form->error($locale->text('Could not spawn html2ps or GhostScript.'));
403 sub generate_csv_content {
406 my %valid_sep_chars = (';' => ';', ',' => ',', ':' => ':', 'TAB' => "\t");
407 my %valid_escape_chars = ('"' => 1, "'" => 1);
408 my %valid_quote_chars = ('"' => 1, "'" => 1);
410 my $opts = $self->{options}->{csv_export};
411 my $eol = $opts->{eol_style} eq 'DOS' ? "\r\n" : "\n";
412 my $sep_char = $valid_sep_chars{$opts->{sep_char}} ? $valid_sep_chars{$opts->{sep_char}} : ';';
413 my $escape_char = $valid_escape_chars{$opts->{escape_char}} ? $opts->{escape_char} : '"';
414 my $quote_char = $valid_quote_chars{$opts->{quote_char}} ? $opts->{quote_char} : '"';
416 $escape_char = $quote_char if ($opts->{escape_char} eq 'QUOTE_CHAR');
418 my $csv = Text::CSV_XS->new({ 'binary' => 1,
419 'sep_char' => $sep_char,
420 'escape_char' => $escape_char,
421 'quote_char' => $quote_char,
424 my $stdout = wraphandle(\*STDOUT);
425 my @visible_columns = $self->get_visible_columns('CSV');
427 if ($opts->{headers}) {
428 $csv->print($stdout, [ map { $self->{columns}->{$_}->{text} } @visible_columns ]);
431 foreach my $row_set (@{ $self->{data} }) {
432 next if ('ARRAY' ne ref $row_set);
433 foreach my $row (@{ $row_set }) {
434 $csv->print($stdout, [ map { $row->{$_}->{data} } @visible_columns ]);