[% IF ( CAN_user_reports_execute_reports || CAN_user_reports_create_reports ) %]
-
[% END %]
Reports dictionary
diff --git a/reports/guided_reports.pl b/reports/guided_reports.pl
index 7a06585697..a6b9bcf248 100755
--- a/reports/guided_reports.pl
+++ b/reports/guided_reports.pl
@@ -54,16 +54,16 @@ Script to control the guided report creation
my $input = CGI->new;
my $usecache = Koha::Caches->get_instance->memcached_cache;
-my $phase = $input->param('phase') // '';
+my $op = $input->param('op') // '';
my $flagsrequired;
-if ( ( $phase eq 'Build new' ) || ( $phase eq 'Create report from SQL' ) || ( $phase eq 'Edit SQL' )
- || ( $phase eq 'Build new from existing' ) ) {
+if ( ( $op eq 'add_form' ) || ( $op eq 'add_form_sql' ) || ( $op eq 'edit_form' )
+ || ( $op eq 'duplicate' ) ) {
$flagsrequired = 'create_reports';
}
-elsif ( $phase eq 'Use saved' ) {
+elsif ( $op eq 'list' ) {
$flagsrequired = 'execute_reports';
}
-elsif ( $phase eq 'Delete Saved' ) {
+elsif ( $op eq 'delete' ) {
$flagsrequired = 'delete_reports';
}
else {
@@ -94,14 +94,12 @@ elsif ($session and not $input->param('clear_filters')) {
$filter = $session->param('report_filter');
}
-my $op = $input->param('op') || q||;
-
my @errors = ();
-if ( !$phase ) {
+if ( !$op ) {
$template->param( 'start' => 1 );
# show welcome page
}
-elsif ( $phase eq 'Build new' ) {
+elsif ( $op eq 'add_form' ) {
# build a new report
$template->param( 'build1' => 1 );
$template->param(
@@ -110,74 +108,16 @@ elsif ( $phase eq 'Build new' ) {
'cache_expiry' => 300,
'public' => '0',
);
-} elsif ( $phase eq 'Use saved' ) {
-
- if ( $op eq 'convert' ) {
- my $report_id = $input->param('report_id');
- my $report = Koha::Reports->find($report_id);
- if ($report) {
- my $updated_sql = C4::Reports::Guided::convert_sql( $report->savedsql );
- C4::Reports::Guided::update_sql(
- $report_id,
- {
- sql => $updated_sql,
- name => $report->report_name,
- group => $report->report_group,
- subgroup => $report->report_subgroup,
- notes => $report->notes,
- public => $report->public,
- cache_expiry => $report->cache_expiry,
- }
- );
- $template->param( report_converted => $report->report_name );
- }
- }
-
- # use a saved report
- # get list of reports and display them
- my $group = $input->param('group');
- my $subgroup = $input->param('subgroup');
- $filter->{group} = $group;
- $filter->{subgroup} = $subgroup;
- my $reports = get_saved_reports($filter);
- my $has_obsolete_reports;
- for my $report ( @$reports ) {
- $report->{results} = C4::Reports::Guided::get_results( $report->{id} );
- if ( $report->{savedsql} =~ m|biblioitems| and $report->{savedsql} =~ m|marcxml| ) {
- $report->{seems_obsolete} = 1;
- $has_obsolete_reports++;
- }
- }
- $template->param(
- 'manamsg' => $input->param('manamsg') || '',
- 'saved1' => 1,
- 'savedreports' => $reports,
- 'usecache' => $usecache,
- 'groups_with_subgroups' => groups_with_subgroups( $group, $subgroup ),
- filters => $filter,
- has_obsolete_reports => $has_obsolete_reports,
- );
}
-
-elsif ( $phase eq 'Delete Multiple') {
- my @ids = $input->multi_param('ids');
+elsif ( $op eq 'cud-delete') {
+ my @ids = $input->multi_param('id');
delete_report( @ids );
- print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
- exit;
+ $op = 'list';
}
-elsif ( $phase eq 'Delete Saved') {
+elsif ( $op eq 'show'){
- # delete a report from the saved reports list
- my $ids = $input->param('reports');
- delete_report($ids);
- print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
- exit;
-}
-
-elsif ( $phase eq 'Show SQL'){
-
- my $id = $input->param('reports');
+ my $id = $input->param('id');
my $report = Koha::Reports->find($id);
$template->param(
'id' => $id,
@@ -191,8 +131,8 @@ elsif ( $phase eq 'Show SQL'){
);
}
-elsif ( $phase eq 'Edit SQL'){
- my $id = $input->param('reports');
+elsif ( $op eq 'edit_form'){
+ my $id = $input->param('id');
my $report = Koha::Reports->find($id);
my $group = $report->report_group;
my $subgroup = $report->report_subgroup;
@@ -213,7 +153,7 @@ elsif ( $phase eq 'Edit SQL'){
);
}
-elsif ( $phase eq 'update_sql' || $phase eq 'update_and_run_sql' ){
+elsif ( $op eq 'cud-update_sql' || $op eq 'cud-update_and_run_sql' ){
my $id = $input->param('id');
my $sql = $input->param('sql');
my $reportname = $input->param('reportname');
@@ -305,13 +245,13 @@ elsif ( $phase eq 'update_sql' || $phase eq 'update_and_run_sql' ){
cache_expiry_units => $cache_expiry_units,
);
}
- if ( $phase eq 'update_and_run_sql' ) {
- print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?reports=$id&phase=Run%20this%20report");
+ if ( $op eq 'cud-update_and_run_sql' ) {
+ $op = 'cud-run';
}
}
}
-elsif ($phase eq 'retrieve results') {
+elsif ($op eq 'retrieve_results') {
my $id = $input->param('id');
my $result = format_results( $id );
$template->param(
@@ -322,7 +262,7 @@ elsif ($phase eq 'retrieve results') {
);
}
-elsif ( $phase eq 'Report on this Area' ) {
+elsif ( $op eq 'cud-report' ) {
my $cache_expiry_units = $input->param('cache_expiry_units'),
my $cache_expiry = $input->param('cache_expiry');
@@ -357,7 +297,7 @@ elsif ( $phase eq 'Report on this Area' ) {
}
}
-elsif ( $phase eq 'Choose this type' ) {
+elsif ( $op eq 'cud-choose_type' ) {
# they have chosen type and area
# get area and type and pass them to the template
my $area = $input->param('area');
@@ -372,7 +312,7 @@ elsif ( $phase eq 'Choose this type' ) {
);
}
-elsif ( $phase eq 'Choose these columns' ) {
+elsif ( $op eq 'cud-choose_columns' ) {
# we now know type, area, and columns
# next step is the constraints
my $area = $input->param('area');
@@ -398,7 +338,7 @@ elsif ( $phase eq 'Choose these columns' ) {
}
-elsif ( $phase eq 'Choose these criteria' ) {
+elsif ( $op eq 'cud-choose_criteria' ) {
my $area = $input->param('area');
my $type = $input->param('type');
my $column = $input->param('column');
@@ -452,14 +392,14 @@ elsif ( $phase eq 'Choose these criteria' ) {
foreach my $col (@columns) {
my %total = (name => $col);
my @selects = map {+{ value => $_ }} (qw(sum min max avg count));
- $total{'cud-select'} = \@selects;
+ $total{'select'} = \@selects;
push @total_by, \%total;
}
$template->param( 'total_by' => \@total_by );
}
-elsif ( $phase eq 'Choose these operations' ) {
+elsif ( $op eq 'cud-choose_operations' ) {
my $area = $input->param('area');
my $type = $input->param('type');
my $column = $input->param('column');
@@ -493,14 +433,14 @@ elsif ( $phase eq 'Choose these operations' ) {
foreach my $col (@columns) {
my %order = (name => $col);
my @selects = map {+{ value => $_ }} (qw(asc desc));
- $order{'cud-select'} = \@selects;
+ $order{'select'} = \@selects;
push @order_by, \%order;
}
$template->param( 'order_by' => \@order_by );
}
-elsif ( $phase eq 'Build report' ) {
+elsif ( $op eq 'cud-build_report' ) {
# now we have all the info we need and can build the sql
my $area = $input->param('area');
@@ -538,13 +478,13 @@ elsif ( $phase eq 'Build report' ) {
);
}
-elsif ( $phase eq 'Save' ) {
+elsif ( $op eq 'save' ) {
# Save the report that has just been built
my $area = $input->param('area');
my $sql = $input->param('sql');
my $type = $input->param('type');
$template->param(
- 'cud-save' => 1,
+ 'save' => 1,
'area' => $area,
'sql' => $sql,
'type' => $type,
@@ -554,7 +494,7 @@ elsif ( $phase eq 'Save' ) {
);
}
-elsif ( $phase eq 'Save Report' ) {
+elsif ( $op eq 'cud-save' ) {
# save the sql pasted in by a user
my $area = $input->param('area');
my $group = $input->param('group');
@@ -658,21 +598,169 @@ elsif ( $phase eq 'Save Report' ) {
}
}
-elsif ($phase eq 'Share'){
+elsif ($op eq 'share'){
my $lang = $input->param('mana_language') || '';
my $reportid = $input->param('reportid');
my $result = Koha::SharedContent::send_entity($lang, $borrowernumber, $reportid, 'report');
if ( $result ) {
- print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved&manamsg=".$result->{msg});
+ print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?op=listmanamsg=".$result->{msg});
}else{
- print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved&manamsg=noanswer");
+ print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?op=list&manamsg=noanswer");
}
}
-elsif ($phase eq 'Run this report'){
+
+elsif ($op eq 'export'){
+
+ # export results to tab separated text or CSV
+ my $report_id = $input->param('id');
+ my $report = Koha::Reports->find($report_id);
+ my $sql = $report->savedsql;
+ my @param_names = $input->multi_param('param_name');
+ my @sql_params = $input->multi_param('sql_params');
+ my $format = $input->param('format');
+ my $reportname = $input->param('reportname');
+ my $reportfilename = $reportname ? "$reportname-reportresults.$format" : "reportresults.$format" ;
+
+ ($sql, undef) = $report->prep_report( \@param_names, \@sql_params );
+ my ( $sth, $q_errors ) = execute_query( { sql => $sql, report_id => $report_id } );
+ unless ($q_errors and @$q_errors) {
+ my ( $type, $content );
+ if ($format eq 'tab') {
+ $type = 'application/octet-stream';
+ $content .= join("\t", header_cell_values($sth)) . "\n";
+ $content = Encode::decode('UTF-8', $content);
+ while (my $row = $sth->fetchrow_arrayref()) {
+ $content .= join("\t", map { $_ // '' } @$row) . "\n";
+ }
+ } else {
+ if ( $format eq 'csv' ) {
+ my $delimiter = C4::Context->csv_delimiter;
+ $type = 'application/csv';
+ my $csv = Text::CSV::Encoded->new({ encoding_out => 'UTF-8', sep_char => $delimiter});
+ $csv or die "Text::CSV::Encoded->new({binary => 1}) FAILED: " . Text::CSV::Encoded->error_diag();
+ if ($csv->combine(header_cell_values($sth))) {
+ $content .= Encode::decode('UTF-8', $csv->string()) . "\n";
+ } else {
+ push @$q_errors, { combine => 'HEADER ROW: ' . $csv->error_diag() } ;
+ }
+ while (my $row = $sth->fetchrow_arrayref()) {
+ if ($csv->combine(@$row)) {
+ $content .= $csv->string() . "\n";
+ } else {
+ push @$q_errors, { combine => $csv->error_diag() } ;
+ }
+ }
+ }
+ elsif ( $format eq 'ods' ) {
+ $type = 'application/vnd.oasis.opendocument.spreadsheet';
+ my $ods_fh = File::Temp->new( UNLINK => 0 );
+ my $ods_filepath = $ods_fh->filename;
+ my $ods_content;
+
+ # First line is headers
+ my @headers = header_cell_values($sth);
+ push @$ods_content, \@headers;
+
+ # Other line in Unicode
+ my $sql_rows = $sth->fetchall_arrayref();
+ foreach my $sql_row ( @$sql_rows ) {
+ my @content_row;
+ foreach my $sql_cell ( @$sql_row ) {
+ push @content_row, Encode::encode( 'UTF8', $sql_cell );
+ }
+ push @$ods_content, \@content_row;
+ }
+
+ # Process
+ generate_ods($ods_filepath, $ods_content);
+
+ # Output
+ binmode(STDOUT);
+ open $ods_fh, '<', $ods_filepath;
+ $content .= $_ while <$ods_fh>;
+ unlink $ods_filepath;
+ }
+ elsif ( $format eq 'template' ) {
+ my $template_id = $input->param('template');
+ my $notice_template = Koha::Notice::Templates->find($template_id);
+ my $data = $sth->fetchall_arrayref( {} );
+ $content = process_tt(
+ $notice_template->content,
+ {
+ data => $data,
+ report_id => $report_id,
+ for_download => 1,
+ }
+ );
+ $reportfilename = process_tt(
+ $notice_template->title,
+ {
+ data => $data,
+ report_id => $report_id,
+ }
+ );
+ }
+ }
+ print $input->header(
+ -type => $type,
+ -attachment=> $reportfilename
+ );
+ print $content;
+
+ foreach my $err (@$q_errors, @errors) {
+ print "# ERROR: " . (map {$_ . ": " . $err->{$_}} keys %$err) . "\n";
+ } # here we print all the non-fatal errors at the end. Not super smooth, but better than nothing.
+ exit;
+ }
+ $template->param(
+ 'sql' => $sql,
+ 'execute' => 1,
+ 'name' => 'Error exporting report!',
+ 'notes' => '',
+ 'errors' => $q_errors,
+ );
+}
+
+elsif ( $op eq 'add_form_sql' || $op eq 'duplicate' ) {
+
+ my ($group, $subgroup, $sql, $reportname, $notes);
+ if ( $input->param('sql') ) {
+ $group = $input->param('report_group');
+ $subgroup = $input->param('report_subgroup');
+ $sql = $input->param('sql') // '';
+ $reportname = $input->param('reportname') // '';
+ $notes = $input->param('notes') // '';
+ }
+ elsif ( my $report_id = $input->param('id') ) {
+ my $report = Koha::Reports->find($report_id);
+ $group = $report->report_group;
+ $subgroup = $report->report_subgroup;
+ $sql = $report->savedsql // '';
+ $reportname = $report->report_name // '';
+ $notes = $report->notes // '';
+ }
+
+ my $tables = get_tables();
+
+ $template->param(
+ sql => $sql,
+ reportname => $reportname,
+ notes => $notes,
+ 'create' => 1,
+ 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
+ 'public' => '0',
+ 'cache_expiry' => 300,
+ 'usecache' => $usecache,
+ 'tables' => $tables,
+
+ );
+}
+
+if ($op eq 'cud-run'){
# execute a saved report
my $limit = $input->param('limit') || 20;
my $offset = 0;
- my $report_id = $input->param('reports');
+ my $report_id = $input->param('id');
my @sql_params = $input->multi_param('sql_params');
my @param_names = $input->multi_param('param_name');
my $template_id = $input->param('template');
@@ -685,8 +773,8 @@ elsif ($phase eq 'Run this report'){
}
$template->param(
- 'limit' => $limit,
- 'report_id' => $report_id,
+ 'limit' => $limit,
+ 'id' => $report_id,
);
my ( $sql, $original_sql, $type, $name, $notes );
@@ -837,7 +925,7 @@ elsif ($phase eq 'Run this report'){
'sql_params' => \@tmpl_parameters,
'auth_val_errors' => \@authval_errors,
'enter_params' => 1,
- 'reports' => $report_id,
+ 'id' => $report_id,
);
} else {
my ($sql,$header_types) = $report->prep_report( \@param_names, \@sql_params );
@@ -870,7 +958,7 @@ elsif ($phase eq 'Run this report'){
}
my $totpages = int($total/$limit) + (($total % $limit) > 0 ? 1 : 0);
- my $url = "/cgi-bin/koha/reports/guided_reports.pl?reports=$report_id&phase=Run%20this%20report&limit=$limit&want_full_chart=$want_full_chart";
+ my $url = "/cgi-bin/koha/reports/guided_reports.pl?id=$report_id&op=run&limit=$limit&want_full_chart=$want_full_chart";
if (@param_names) {
$url = join('¶m_name=', $url, map { URI::Escape::uri_escape_utf8($_) } @param_names);
}
@@ -918,153 +1006,54 @@ elsif ($phase eq 'Run this report'){
}
}
-elsif ($phase eq 'Export'){
+if ( $op eq 'list' || $op eq 'convert') {
- # export results to tab separated text or CSV
- my $report_id = $input->param('report_id');
- my $report = Koha::Reports->find($report_id);
- my $sql = $report->savedsql;
- my @param_names = $input->multi_param('param_name');
- my @sql_params = $input->multi_param('sql_params');
- my $format = $input->param('format');
- my $reportname = $input->param('reportname');
- my $reportfilename = $reportname ? "$reportname-reportresults.$format" : "reportresults.$format" ;
-
- ($sql, undef) = $report->prep_report( \@param_names, \@sql_params );
- my ( $sth, $q_errors ) = execute_query( { sql => $sql, report_id => $report_id } );
- unless ($q_errors and @$q_errors) {
- my ( $type, $content );
- if ($format eq 'tab') {
- $type = 'application/octet-stream';
- $content .= join("\t", header_cell_values($sth)) . "\n";
- $content = Encode::decode('UTF-8', $content);
- while (my $row = $sth->fetchrow_arrayref()) {
- $content .= join("\t", map { $_ // '' } @$row) . "\n";
- }
- } else {
- if ( $format eq 'csv' ) {
- my $delimiter = C4::Context->csv_delimiter;
- $type = 'application/csv';
- my $csv = Text::CSV::Encoded->new({ encoding_out => 'UTF-8', sep_char => $delimiter});
- $csv or die "Text::CSV::Encoded->new({binary => 1}) FAILED: " . Text::CSV::Encoded->error_diag();
- if ($csv->combine(header_cell_values($sth))) {
- $content .= Encode::decode('UTF-8', $csv->string()) . "\n";
- } else {
- push @$q_errors, { combine => 'HEADER ROW: ' . $csv->error_diag() } ;
+ if ( $op eq 'convert' ) {
+ my $report_id = $input->param('id');
+ my $report = Koha::Reports->find($report_id);
+ if ($report) {
+ my $updated_sql = C4::Reports::Guided::convert_sql( $report->savedsql );
+ C4::Reports::Guided::update_sql(
+ $report_id,
+ {
+ sql => $updated_sql,
+ name => $report->report_name,
+ group => $report->report_group,
+ subgroup => $report->report_subgroup,
+ notes => $report->notes,
+ public => $report->public,
+ cache_expiry => $report->cache_expiry,
}
- while (my $row = $sth->fetchrow_arrayref()) {
- if ($csv->combine(@$row)) {
- $content .= $csv->string() . "\n";
- } else {
- push @$q_errors, { combine => $csv->error_diag() } ;
- }
- }
- }
- elsif ( $format eq 'ods' ) {
- $type = 'application/vnd.oasis.opendocument.spreadsheet';
- my $ods_fh = File::Temp->new( UNLINK => 0 );
- my $ods_filepath = $ods_fh->filename;
- my $ods_content;
-
- # First line is headers
- my @headers = header_cell_values($sth);
- push @$ods_content, \@headers;
-
- # Other line in Unicode
- my $sql_rows = $sth->fetchall_arrayref();
- foreach my $sql_row ( @$sql_rows ) {
- my @content_row;
- foreach my $sql_cell ( @$sql_row ) {
- push @content_row, Encode::encode( 'UTF8', $sql_cell );
- }
- push @$ods_content, \@content_row;
- }
-
- # Process
- generate_ods($ods_filepath, $ods_content);
-
- # Output
- binmode(STDOUT);
- open $ods_fh, '<', $ods_filepath;
- $content .= $_ while <$ods_fh>;
- unlink $ods_filepath;
- }
- elsif ( $format eq 'template' ) {
- my $template_id = $input->param('template');
- my $notice_template = Koha::Notice::Templates->find($template_id);
- my $data = $sth->fetchall_arrayref( {} );
- $content = process_tt(
- $notice_template->content,
- {
- data => $data,
- report_id => $report_id,
- for_download => 1,
- }
- );
- $reportfilename = process_tt(
- $notice_template->title,
- {
- data => $data,
- report_id => $report_id,
- }
- );
- }
+ );
+ $template->param( report_converted => $report->report_name );
}
- print $input->header(
- -type => $type,
- -attachment=> $reportfilename
- );
- print $content;
+ }
- foreach my $err (@$q_errors, @errors) {
- print "# ERROR: " . (map {$_ . ": " . $err->{$_}} keys %$err) . "\n";
- } # here we print all the non-fatal errors at the end. Not super smooth, but better than nothing.
- exit;
+ # use a saved report
+ # get list of reports and display them
+ my $group = $input->param('group');
+ my $subgroup = $input->param('subgroup');
+ $filter->{group} = $group;
+ $filter->{subgroup} = $subgroup;
+ my $reports = get_saved_reports($filter);
+ my $has_obsolete_reports;
+ for my $report ( @$reports ) {
+ $report->{results} = C4::Reports::Guided::get_results( $report->{id} );
+ if ( $report->{savedsql} =~ m|biblioitems| and $report->{savedsql} =~ m|marcxml| ) {
+ $report->{seems_obsolete} = 1;
+ $has_obsolete_reports++;
+ }
}
$template->param(
- 'sql' => $sql,
- 'execute' => 1,
- 'name' => 'Error exporting report!',
- 'notes' => '',
- 'errors' => $q_errors,
+ 'manamsg' => $input->param('manamsg') || '',
+ 'saved1' => 1,
+ 'savedreports' => $reports,
+ 'usecache' => $usecache,
+ 'groups_with_subgroups' => groups_with_subgroups( $group, $subgroup ),
+ filters => $filter,
+ has_obsolete_reports => $has_obsolete_reports,
);
}
-
-elsif ( $phase eq 'Create report from SQL' || $phase eq 'Create report from existing' ) {
-
- my ($group, $subgroup, $sql, $reportname, $notes);
- if ( $input->param('sql') ) {
- $group = $input->param('report_group');
- $subgroup = $input->param('report_subgroup');
- $sql = $input->param('sql') // '';
- $reportname = $input->param('reportname') // '';
- $notes = $input->param('notes') // '';
- }
- elsif ( my $report_id = $input->param('report_id') ) {
- my $report = Koha::Reports->find($report_id);
- $group = $report->report_group;
- $subgroup = $report->report_subgroup;
- $sql = $report->savedsql // '';
- $reportname = $report->report_name // '';
- $notes = $report->notes // '';
- }
-
- my $tables = get_tables();
-
- $template->param(
- sql => $sql,
- reportname => $reportname,
- notes => $notes,
- 'create' => 1,
- 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
- 'public' => '0',
- 'cache_expiry' => 300,
- 'usecache' => $usecache,
- 'tables' => $tables,
-
- );
-}
-
# pass $sth, get back an array of names for the column headers
sub header_cell_values {
my $sth = shift or return ();
diff --git a/svc/convert_report b/svc/convert_report
index b2779212d4..e88ae648cd 100755
--- a/svc/convert_report
+++ b/svc/convert_report
@@ -26,7 +26,7 @@ use C4::Output qw( output_html_with_http_headers );
use CGI qw ( -utf8 );
my $query = CGI->new();
-my $report_id = $query->param('report_id');
+my $report_id = $query->param('id');
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{