use Data::Dumper;
use List::Util qw(max);
+use Scalar::Util qw(blessed);
use Text::CSV_XS;
#use PDF::API2; # these two eat up to .75s on startup. only load them if we actually need them
#use PDF::Table;
use strict;
use SL::Helper::GlAttachments qw(append_gl_pdf_attachments);
use SL::Helper::CreatePDF qw(merge_pdfs);
+use SL::JSON qw(to_json);
# Cause locales.pl to parse these files:
# parse_html_template('report_generator/html_report')
'controller_class ' => '',
'allow_pdf_export' => 1,
'allow_csv_export' => 1,
+ 'allow_chart_export' => 1,
'html_template' => 'report_generator/html_report',
'pdf_export' => {
'paper_size' => 'a4',
'headers' => 1,
'encoding' => 'UTF-8',
},
+ 'chart_export' => {
+ 'assignment_x' => '',
+ 'assignments_y' => [],
+ },
};
$self->{export} = {
'nextsub' => '',
while (my ($key, $value) = each %options) {
if ($key eq 'pdf_export') {
- map { $self->{options}->{pdf_export}->{$_} = $value->{$_} } keys %{ $value };
+ $self->{options}->{pdf_export}->{$_} = $value->{$_} for keys %{ $value };
+ } elsif ($key eq 'csv_export') {
+ $self->{options}->{csv_export}->{$_} = $value->{$_} for keys %{ $value };
+ } elsif ($key eq 'chart_export') {
+ $self->{options}->{chart_export}->{$_} = $value->{$_} for keys %{ $value };
} else {
$self->{options}->{$key} = $value;
}
$self->{options}->{$key} = $form->{$full_key} if (defined $form->{$full_key});
}
- foreach my $format (qw(pdf csv)) {
+ foreach my $format (qw(pdf csv chart)) {
my $opts = $self->{options}->{"${format}_export"};
foreach my $key (keys %{ $opts }) {
my $full_key = "report_generator_${format}_options_${key}";
}
if ($format eq 'html') {
+ my $content = $self->generate_html_content(%params);
my $title = $form->{title};
$form->{title} = $self->{title} if ($self->{title});
$form->header(no_layout => $params{no_layout});
$form->{title} = $title;
- print $self->generate_html_content();
+ print $content;
} elsif ($format eq 'csv') {
# FIXME: don't do mini http in here
} elsif ($format eq 'pdf') {
$self->generate_pdf_content();
+ } elsif ($format eq 'chart') {
+ $self->generate_chart_content();
+
} else {
- $form->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF)');
+ $form->error('Incorrect usage -- unknown format (supported are HTML, CSV, PDF, Chart)');
}
}
}
sub prepare_html_content {
- my $self = shift;
+ my ($self, %params) = @_;
my ($column, $name, @column_headers);
'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}) && $self->{data_present},
+ 'ALLOW_CHART_EXPORT' => $opts->{allow_chart_export},
+ 'SHOW_EXPORT_BUTTONS' => ($allow_pdf_export || $opts->{allow_csv_export} || $opts->{allow_chart_export}) && $self->{data_present},
'HEADER_ROWS' => $header_rows,
'NUM_COLUMNS' => scalar @column_headers,
'ROWS' => \@rows,
'DATA_PRESENT' => $self->{data_present},
'CONTROLLER_DISPATCH' => $opts->{controller_class},
'TABLE_CLASS' => $opts->{table_class},
+ 'SKIP_BUTTONS' => !!$params{action_bar},
};
return $variables;
}
+sub create_action_bar_actions {
+ my ($self, $variables, %params) = @_;
+
+ my @actions;
+ foreach my $type (qw(pdf csv chart)) {
+ next unless $variables->{"ALLOW_" . uc($type) . "_EXPORT"};
+
+ my $key = $variables->{CONTROLLER_DISPATCH} ? 'action' : 'report_generator_dispatch_to';
+ my $value = "report_generator_export_as_${type}";
+ $value = $variables->{CONTROLLER_DISPATCH} . "/${value}" if $variables->{CONTROLLER_DISPATCH};
+
+ push @actions, action => [
+ $type eq 'pdf' ? $::locale->text('PDF export') : $type eq 'csv' ? $::locale->text('CSV export') : $::locale->text('Chart export'),
+ submit => [ '#report_generator_form', {(
+ $key => $value,
+ defined $params{action_bar_additional_submit_values}
+ ? %{$params{action_bar_additional_submit_values}}
+ : undef
+ )} ],
+ ];
+ }
+
+ if (scalar(@actions) > 1) {
+ @actions = (
+ combobox => [
+ action => [ $::locale->text('Export') ],
+ @actions,
+ ],
+ );
+ }
+
+ return @actions;
+}
+
+sub setup_action_bar {
+ my ($self, $variables, %params) = @_;
+
+ my @actions = $self->create_action_bar_actions($variables, %params);
+
+ if ($params{action_bar_setup_hook}) {
+ $params{action_bar_setup_hook}->(@actions);
+
+ } elsif (@actions) {
+ my $action_bar = blessed($params{action_bar}) ? $params{action_bar} : ($::request->layout->get('actionbar'))[0];
+ $action_bar->add(@actions);
+ }
+}
+
sub generate_html_content {
- my $self = shift;
- my $variables = $self->prepare_html_content();
+ my ($self, %params) = @_;
+
+ $params{action_bar} //= 1;
+
+ my $variables = $self->prepare_html_content(%params);
+ $self->setup_action_bar($variables, %params) if $params{action_bar};
my $stuff = $self->{form}->parse_html_template($self->{options}->{html_template}, $variables);
return $stuff;
};
my $self = shift;
+ my %params = @_;
my $variables = $self->prepare_html_content();
my $form = $self->{form};
my $myconfig = $self->{myconfig};
foreach (0 .. $num_columns - 1) {
push @{ $cell_props_row }, { 'background_color' => '#666666',
- 'font_color' => '#ffffff',
+ # BUG PDF:Table -> 0.9.12:
+ # font_color is used in next row, so dont set font_color
+ # 'font_color' => '#ffffff',
'colspan' => $_ == 0 ? -1 : undef, };
}
}
my $content = $pdf->stringify();
$main::lxdebug->message(LXDebug->DEBUG2(),"addattachments ?? =".$form->{report_generator_addattachments}." GL=".$form->{GL});
- if ( $form->{report_generator_addattachments} eq 'yes' && $form->{GL}) {
+ if ($form->{report_generator_addattachments} && $form->{GL}) {
$content = $self->append_gl_pdf_attachments($form,$content);
}
+ # 1. check if we return the report as binary pdf
+ if ($params{want_binary_pdf}) {
+ return $content;
+ }
+ # 2. check if we want and can directly print the report
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,
$form->{report_generator_printed} = 1;
} else {
+ # 3. default: redirect http with file attached
my $filename = $self->get_attachment_basename();
print qq|content-type: application/pdf\n|;
}
}
+sub generate_chart_content {
+ my ($self, %params) = @_;
+
+ $params{action_bar} //= 1;
+
+ my $opts = $self->{options};
+
+ my $assignment_x = $opts->{chart_export}->{assignment_x};
+ my $assignments_y = $opts->{chart_export}->{assignments_y};
+
+ my @labels;
+ my @datasets;
+ foreach my $row_set (@{ $self->{data} }) {
+ next if ('ARRAY' ne ref $row_set);
+ foreach my $row (@{ $row_set }) {
+ my $label = $row->{$assignment_x}->{data}->[0];
+ if ($label) {
+ push @labels, $label;
+
+ my @set;
+ foreach my $assignment_y (@$assignments_y) {
+ my $y = $row->{$assignment_y}->{data}->[0];
+ push @set, $y;
+ }
+ push @datasets, \@set;
+ }
+ }
+ }
+
+ my $variables = {
+ 'TITLE' => $opts->{title},
+ 'TOP_INFO_TEXT' => $self->html_format($opts->{top_info_text}),
+ 'RAW_TOP_INFO_TEXT' => $opts->{raw_top_info_text},
+ 'BOTTOM_INFO_TEXT' => $self->html_format($opts->{bottom_info_text}),
+ 'RAW_BOTTOM_INFO_TEXT' => $opts->{raw_bottom_info_text},
+ '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},
+ 'SKIP_BUTTONS' => !!$params{action_bar},
+ };
+
+ $::request->layout->add_javascripts('chart.js', 'kivi.ChartReport.js');
+
+ $::form->header;
+ print $::form->parse_html_template('report_generator/chart_report',
+ {
+ labels => to_json(\@labels),
+ datasets => to_json(\@datasets),
+ data_labels => to_json($assignments_y),
+ %$variables,
+ }
+ );
+}
+
sub check_for_pdf_api {
return eval { require PDF::API2; 1; } ? 1 : 0;
}
The PDF generation function. It is invoked by generate_with_headers and renders the PDF with the PDF::API2 library.
+If the param want_binary_pdf is set, the binary pdf stream will be returned.
+If $pdfopts->{print} && $pdfopts->{printer_id} are set, the pdf will be printed (output is directed to print command).
+
+Otherwise and the default a html form with a downloadable file is returned.
+
=item generate_csv_content
The CSV generation function. Uses XS_CSV to parse the information into csv.