3 # Copyright 2007 Liblime ltd
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 use Text::CSV::Encoded;
23 use Encode qw( decode );
26 use C4::Reports::Guided qw( delete_report get_report_areas convert_sql update_sql get_saved_reports get_results ValidateSQLParameters format_results get_report_types get_columns get_from_dictionary get_criteria build_query save_report execute_query nb_rows get_report_groups );
28 use C4::Auth qw( get_template_and_user get_session );
29 use C4::Output qw( pagination_bar output_html_with_http_headers );
32 use C4::Log qw( logaction );
33 use Koha::AuthorisedValue;
34 use Koha::AuthorisedValues;
35 use Koha::BiblioFrameworks;
37 use Koha::Patron::Categories;
38 use Koha::SharedContent;
39 use Koha::Util::OpenDocument qw( generate_ods );
40 use C4::ClassSource qw( GetClassSources );
48 Script to control the guided report creation
53 my $usecache = Koha::Caches->get_instance->memcached_cache;
55 my $phase = $input->param('phase') // '';
57 if ( ( $phase eq 'Build new' ) || ( $phase eq 'Create report from SQL' ) || ( $phase eq 'Edit SQL' )
58 || ( $phase eq 'Build new from existing' ) ) {
59 $flagsrequired = 'create_reports';
61 elsif ( $phase eq 'Use saved' ) {
62 $flagsrequired = 'execute_reports';
64 elsif ( $phase eq 'Delete Saved' ) {
65 $flagsrequired = 'delete_reports';
71 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
73 template_name => "reports/guided_reports_start.tt",
76 flagsrequired => { reports => $flagsrequired },
79 my $session_id = $input->cookie('CGISESSID');
80 my $session = $session_id ? get_session($session_id) : undef;
83 if ( $input->param("filter_set") or $input->param('clear_filters') ) {
85 $filter->{$_} = $input->param("filter_$_") foreach qw/date author keyword group subgroup/;
86 $session->param('report_filter', $filter) if $session;
87 $template->param( 'filter_set' => 1 );
89 elsif ($session and not $input->param('clear_filters')) {
90 $filter = $session->param('report_filter');
93 my $op = $input->param('op') || q||;
97 $template->param( 'start' => 1 );
100 elsif ( $phase eq 'Build new' ) {
102 $template->param( 'build1' => 1 );
104 'areas' => get_report_areas(),
105 'usecache' => $usecache,
106 'cache_expiry' => 300,
109 } elsif ( $phase eq 'Use saved' ) {
111 if ( $op eq 'convert' ) {
112 my $report_id = $input->param('report_id');
113 my $report = Koha::Reports->find($report_id);
115 my $updated_sql = C4::Reports::Guided::convert_sql( $report->savedsql );
116 C4::Reports::Guided::update_sql(
120 name => $report->report_name,
121 group => $report->report_group,
122 subgroup => $report->report_subgroup,
123 notes => $report->notes,
124 public => $report->public,
125 cache_expiry => $report->cache_expiry,
128 $template->param( report_converted => $report->report_name );
133 # get list of reports and display them
134 my $group = $input->param('group');
135 my $subgroup = $input->param('subgroup');
136 $filter->{group} = $group;
137 $filter->{subgroup} = $subgroup;
138 my $reports = get_saved_reports($filter);
139 my $has_obsolete_reports;
140 for my $report ( @$reports ) {
141 $report->{results} = C4::Reports::Guided::get_results( $report->{id} );
142 if ( $report->{savedsql} =~ m|biblioitems| and $report->{savedsql} =~ m|marcxml| ) {
143 $report->{seems_obsolete} = 1;
144 $has_obsolete_reports++;
148 'manamsg' => $input->param('manamsg') || '',
150 'savedreports' => $reports,
151 'usecache' => $usecache,
152 'groups_with_subgroups' => groups_with_subgroups( $group, $subgroup ),
154 has_obsolete_reports => $has_obsolete_reports,
158 elsif ( $phase eq 'Delete Multiple') {
159 my @ids = $input->multi_param('ids');
160 delete_report( @ids );
161 print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
165 elsif ( $phase eq 'Delete Saved') {
167 # delete a report from the saved reports list
168 my $ids = $input->param('reports');
170 print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
174 elsif ( $phase eq 'Show SQL'){
176 my $id = $input->param('reports');
177 my $report = Koha::Reports->find($id);
180 'reportname' => $report->report_name,
181 'notes' => $report->notes,
182 'sql' => $report->savedsql,
184 'mana_success' => scalar $input->param('mana_success'),
185 'mana_id' => $report->{mana_id},
186 'mana_comments' => $report->{comments}
190 elsif ( $phase eq 'Edit SQL'){
191 my $id = $input->param('reports');
192 my $report = Koha::Reports->find($id);
193 my $group = $report->report_group;
194 my $subgroup = $report->report_subgroup;
196 'sql' => $report->savedsql,
197 'reportname' => $report->report_name,
198 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
199 'notes' => $report->notes,
201 'cache_expiry' => $report->cache_expiry,
202 'public' => $report->public,
203 'usecache' => $usecache,
205 'mana_id' => $report->{mana_id},
206 'mana_comments' => $report->{comments}
210 elsif ( $phase eq 'Update SQL'){
211 my $id = $input->param('id');
212 my $sql = $input->param('sql');
213 my $reportname = $input->param('reportname');
214 my $group = $input->param('group');
215 my $subgroup = $input->param('subgroup');
216 my $notes = $input->param('notes');
217 my $cache_expiry = $input->param('cache_expiry');
218 my $cache_expiry_units = $input->param('cache_expiry_units');
219 my $public = $input->param('public');
220 my $save_anyway = $input->param('save_anyway');
223 # if we have the units, then we came from creating a report from SQL and thus need to handle converting units
224 if( $cache_expiry_units ){
225 if( $cache_expiry_units eq "minutes" ){
227 } elsif( $cache_expiry_units eq "hours" ){
228 $cache_expiry *= 3600; # 60 * 60
229 } elsif( $cache_expiry_units eq "days" ){
230 $cache_expiry *= 86400; # 60 * 60 * 24
233 # check $cache_expiry isn't too large, Memcached::set requires it to be less than 30 days or it will be treated as if it were an absolute time stamp
234 if( $cache_expiry >= 2592000 ){
235 push @errors, {cache_expiry => $cache_expiry};
238 create_non_existing_group_and_subgroup($input, $group, $subgroup);
240 my ( $is_sql_valid, $validation_errors ) = Koha::Report->new({ savedsql => $sql })->is_sql_valid;
241 push(@errors, @$validation_errors) unless $is_sql_valid;
245 'errors' => \@errors,
250 # Check defined SQL parameters for authorised value validity
251 my $problematic_authvals = ValidateSQLParameters($sql);
253 if ( scalar @$problematic_authvals > 0 && not $save_anyway ) {
254 # There's at least one problematic parameter, report to the
255 # GUI and provide all user input for further actions
259 'reportname' => $reportname,
261 'subgroup' => $subgroup,
264 'problematic_authvals' => $problematic_authvals,
265 'warn_authval_problem' => 1,
270 # No params problem found or asked to save anyway
275 subgroup => $subgroup,
278 cache_expiry => $cache_expiry,
281 'save_successful' => 1,
282 'reportname' => $reportname,
286 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
288 'cache_expiry' => $cache_expiry,
290 'usecache' => $usecache,
292 logaction( "REPORTS", "MODIFY", $id, "$reportname | $sql" ) if C4::Context->preference("ReportsLog");
296 cache_expiry => $cache_expiry,
297 cache_expiry_units => $cache_expiry_units,
303 elsif ($phase eq 'retrieve results') {
304 my $id = $input->param('id');
305 my $result = format_results( $id );
307 report_name => $result->{report_name},
308 notes => $result->{notes},
309 saved_results => $result->{results},
310 date_run => $result->{date_run},
314 elsif ( $phase eq 'Report on this Area' ) {
315 my $cache_expiry_units = $input->param('cache_expiry_units'),
316 my $cache_expiry = $input->param('cache_expiry');
318 # we need to handle converting units
319 if( $cache_expiry_units eq "minutes" ){
321 } elsif( $cache_expiry_units eq "hours" ){
322 $cache_expiry *= 3600; # 60 * 60
323 } elsif( $cache_expiry_units eq "days" ){
324 $cache_expiry *= 86400; # 60 * 60 * 24
326 # check $cache_expiry isn't too large, Memcached::set requires it to be less than 30 days or it will be treated as if it were an absolute time stamp
327 if( $cache_expiry >= 2592000 ){ # oops, over the limit of 30 days
328 # report error to user
332 'areas' => get_report_areas(),
333 'cache_expiry' => $cache_expiry,
334 'usecache' => $usecache,
335 'public' => scalar $input->param('public'),
338 # they have chosen a new report and the area to report on
341 'area' => scalar $input->param('area'),
342 'types' => get_report_types(),
343 'cache_expiry' => $cache_expiry,
344 'public' => scalar $input->param('public'),
349 elsif ( $phase eq 'Choose this type' ) {
350 # they have chosen type and area
351 # get area and type and pass them to the template
352 my $area = $input->param('area');
353 my $type = $input->param('types');
358 columns => get_columns($area,$input),
359 'cache_expiry' => scalar $input->param('cache_expiry'),
360 'public' => scalar $input->param('public'),
364 elsif ( $phase eq 'Choose these columns' ) {
365 # we now know type, area, and columns
366 # next step is the constraints
367 my $area = $input->param('area');
368 my $type = $input->param('type');
369 my @columns = $input->multi_param('columns');
370 my $column = join( ',', @columns );
377 definitions => get_from_dictionary($area),
378 criteria => get_criteria($area,$input),
379 'public' => scalar $input->param('public'),
383 cache_expiry => scalar $input->param('cache_expiry'),
384 cache_expiry_units => scalar $input->param('cache_expiry_units'),
390 elsif ( $phase eq 'Choose these criteria' ) {
391 my $area = $input->param('area');
392 my $type = $input->param('type');
393 my $column = $input->param('column');
394 my @definitions = $input->multi_param('definition');
395 my $definition = join (',',@definitions);
396 my @criteria = $input->multi_param('criteria_column');
398 foreach my $crit (@criteria) {
399 my $value = $input->param( $crit . "_value" );
401 # If value is not defined, then it may be range values
402 if (!defined $value) {
403 my $fromvalue = $input->param( "from_" . $crit . "_value" );
404 my $tovalue = $input->param( "to_" . $crit . "_value" );
406 if ($fromvalue && $tovalue) {
407 $query_criteria .= " AND $crit >= '$fromvalue' AND $crit <= '$tovalue'";
410 # don't escape runtime parameters, they'll be at runtime
411 if ($value =~ /<<.*>>/) {
412 $query_criteria .= " AND $crit=$value";
414 $query_criteria .= " AND $crit='$value'";
423 'definition' => $definition,
424 'criteriastring' => $query_criteria,
425 'public' => scalar $input->param('public'),
429 cache_expiry => scalar $input->param('cache_expiry'),
430 cache_expiry_units => scalar $input->param('cache_expiry_units'),
435 my @columns = split( ',', $column );
438 # build structue for use by tmpl_loop to choose columns to order by
439 # need to do something about the order of the order :)
440 # we also want to use the %columns hash to get the plain english names
441 foreach my $col (@columns) {
442 my %total = (name => $col);
443 my @selects = map {+{ value => $_ }} (qw(sum min max avg count));
444 $total{'select'} = \@selects;
445 push @total_by, \%total;
448 $template->param( 'total_by' => \@total_by );
451 elsif ( $phase eq 'Choose these operations' ) {
452 my $area = $input->param('area');
453 my $type = $input->param('type');
454 my $column = $input->param('column');
455 my $criteria = $input->param('criteria');
456 my $definition = $input->param('definition');
457 my @total_by = $input->multi_param('total_by');
459 foreach my $total (@total_by) {
460 my $value = $input->param( $total . "_tvalue" );
461 $totals .= "$value($total),";
469 'criteriastring' => $criteria,
471 'definition' => $definition,
472 'cache_expiry' => scalar $input->param('cache_expiry'),
473 'public' => scalar $input->param('public'),
477 my @columns = split( ',', $column );
480 # build structue for use by tmpl_loop to choose columns to order by
481 # need to do something about the order of the order :)
482 foreach my $col (@columns) {
483 my %order = (name => $col);
484 my @selects = map {+{ value => $_ }} (qw(asc desc));
485 $order{'select'} = \@selects;
486 push @order_by, \%order;
489 $template->param( 'order_by' => \@order_by );
492 elsif ( $phase eq 'Build report' ) {
494 # now we have all the info we need and can build the sql
495 my $area = $input->param('area');
496 my $type = $input->param('type');
497 my $column = $input->param('column');
498 my $crit = $input->param('criteria');
499 my $totals = $input->param('totals');
500 my $definition = $input->param('definition');
501 my $query_criteria=$crit;
502 # split the columns up by ,
503 my @columns = split( ',', $column );
504 my @order_by = $input->multi_param('order_by');
507 foreach my $order (@order_by) {
508 my $value = $input->param( $order . "_ovalue" );
509 if ($query_orderby) {
510 $query_orderby .= ",$order $value";
513 $query_orderby = " ORDER BY $order $value";
519 build_query( \@columns, $query_criteria, $query_orderby, $area, $totals, $definition );
525 'cache_expiry' => scalar $input->param('cache_expiry'),
526 'public' => scalar $input->param('public'),
530 elsif ( $phase eq 'Save' ) {
531 # Save the report that has just been built
532 my $area = $input->param('area');
533 my $sql = $input->param('sql');
534 my $type = $input->param('type');
540 'cache_expiry' => scalar $input->param('cache_expiry'),
541 'public' => scalar $input->param('public'),
542 'groups_with_subgroups' => groups_with_subgroups($area), # in case we have a report group that matches area
546 elsif ( $phase eq 'Save Report' ) {
547 # save the sql pasted in by a user
548 my $area = $input->param('area');
549 my $group = $input->param('group');
550 my $subgroup = $input->param('subgroup');
551 my $sql = $input->param('sql');
552 my $name = $input->param('reportname');
553 my $type = $input->param('types');
554 my $notes = $input->param('notes');
555 my $cache_expiry = $input->param('cache_expiry');
556 my $cache_expiry_units = $input->param('cache_expiry_units');
557 my $public = $input->param('public');
558 my $save_anyway = $input->param('save_anyway');
561 # if we have the units, then we came from creating a report from SQL and thus need to handle converting units
562 if( $cache_expiry_units ){
563 if( $cache_expiry_units eq "minutes" ){
565 } elsif( $cache_expiry_units eq "hours" ){
566 $cache_expiry *= 3600; # 60 * 60
567 } elsif( $cache_expiry_units eq "days" ){
568 $cache_expiry *= 86400; # 60 * 60 * 24
571 # check $cache_expiry isn't too large, Memcached::set requires it to be less than 30 days or it will be treated as if it were an absolute time stamp
572 if( $cache_expiry && $cache_expiry >= 2592000 ){
573 push @errors, {cache_expiry => $cache_expiry};
576 create_non_existing_group_and_subgroup($input, $group, $subgroup);
577 ## FIXME this is AFTER entering a name to save the report under
578 my ( $is_sql_valid, $validation_errors ) = Koha::Report->new({ savedsql => $sql })->is_sql_valid;
579 push(@errors, @$validation_errors) unless $is_sql_valid;
583 'errors' => \@errors,
585 'reportname'=> $name,
588 'cache_expiry' => $cache_expiry,
592 # Check defined SQL parameters for authorised value validity
593 my $problematic_authvals = ValidateSQLParameters($sql);
595 if ( scalar @$problematic_authvals > 0 && not $save_anyway ) {
596 # There's at least one problematic parameter, report to the
597 # GUI and provide all user input for further actions
601 'subgroup' => $subgroup,
603 'reportname' => $name,
607 'problematic_authvals' => $problematic_authvals,
608 'warn_authval_problem' => 1,
613 cache_expiry => $cache_expiry,
614 cache_expiry_units => $cache_expiry_units,
618 # No params problem found or asked to save anyway
619 my $id = save_report( {
620 borrowernumber => $borrowernumber,
625 subgroup => $subgroup,
628 cache_expiry => $cache_expiry,
631 logaction( "REPORTS", "ADD", $id, "$name | $sql" ) if C4::Context->preference("ReportsLog");
633 'save_successful' => 1,
634 'reportname' => $name,
638 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
640 'cache_expiry' => $cache_expiry,
642 'usecache' => $usecache,
648 elsif ($phase eq 'Share'){
649 my $lang = $input->param('mana_language') || '';
650 my $reportid = $input->param('reportid');
651 my $result = Koha::SharedContent::send_entity($lang, $borrowernumber, $reportid, 'report');
653 print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved&manamsg=".$result->{msg});
655 print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved&manamsg=noanswer");
658 elsif ($phase eq 'Run this report'){
659 # execute a saved report
660 my $limit = $input->param('limit') || 20;
662 my $report_id = $input->param('reports');
663 my @sql_params = $input->multi_param('sql_params');
664 my @param_names = $input->multi_param('param_name');
665 my $want_full_chart = $input->param('want_full_chart') || 0;
668 if ($input->param('page')) {
669 $offset = ($input->param('page') - 1) * $limit;
674 'report_id' => $report_id,
677 my ( $sql, $original_sql, $type, $name, $notes );
678 if (my $report = Koha::Reports->find($report_id)) {
679 $sql = $original_sql = $report->savedsql;
680 $name = $report->report_name;
681 $notes = $report->notes;
685 # if we have at least 1 parameter, and it's not filled, then don't execute but ask for parameters
686 if ($sql =~ /<</ && !@sql_params) {
687 # split on ??. Each odd (2,4,6,...) entry should be a parameter to fill
688 my @split = split /<<|>>/,$sql;
692 for(my $i=0;$i<($#split/2);$i++) {
693 my ($text,$authorised_value_all) = split /\|/,$split[$i*2+1];
694 my $sep = $authorised_value_all ? "|" : "";
695 if( defined $uniq_params{$text.$sep.$authorised_value_all} ){
697 } else { $uniq_params{$text.$sep.$authorised_value_all} = "$i"; }
698 my ($authorised_value, $all) = split /:/, $authorised_value_all;
701 if ( not defined $authorised_value ) {
702 # no authorised value input, provide a text box
704 } elsif ( $authorised_value eq "date" ) {
705 # require a date, provide a date picker
707 } elsif ( $authorised_value eq "list" ) {
708 # require a list, provide a textarea
711 # defined $authorised_value, and not 'date'
712 my $dbh=C4::Context->dbh;
713 my @authorised_values;
715 # builds list, depending on authorised value...
716 if ( $authorised_value eq "branches" ) {
717 my $libraries = Koha::Libraries->search( {}, { order_by => ['branchname'] } );
718 while ( my $library = $libraries->next ) {
719 push @authorised_values, $library->branchcode;
720 $authorised_lib{$library->branchcode} = $library->branchname;
723 elsif ( $authorised_value eq "itemtypes" ) {
724 my $sth = $dbh->prepare("SELECT itemtype,description FROM itemtypes ORDER BY description");
726 while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
727 push @authorised_values, $itemtype;
728 $authorised_lib{$itemtype} = $description;
731 elsif ( $authorised_value eq "biblio_framework" ) {
732 my @frameworks = Koha::BiblioFrameworks->search({}, { order_by => ['frameworktext'] })->as_list;
733 my $default_source = '';
734 push @authorised_values,$default_source;
735 $authorised_lib{$default_source} = 'Default';
736 foreach my $framework (@frameworks) {
737 push @authorised_values, $framework->frameworkcode;
738 $authorised_lib{$framework->frameworkcode} = $framework->frameworktext;
741 elsif ( $authorised_value eq "cn_source" ) {
742 my $class_sources = GetClassSources();
743 my $default_source = C4::Context->preference("DefaultClassificationSource");
744 foreach my $class_source (sort keys %$class_sources) {
745 next unless $class_sources->{$class_source}->{'used'} or
746 ($class_source eq $default_source);
747 push @authorised_values, $class_source;
748 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
751 elsif ( $authorised_value eq "categorycode" ) {
752 my @patron_categories = Koha::Patron::Categories->search({}, { order_by => ['description']})->as_list;
753 %authorised_lib = map { $_->categorycode => $_->description } @patron_categories;
754 push @authorised_values, $_->categorycode for @patron_categories;
756 elsif ( $authorised_value eq "cash_registers" ) {
757 my $sth = $dbh->prepare("SELECT id, name FROM cash_registers ORDER BY description");
759 while ( my ( $id, $name ) = $sth->fetchrow_array ) {
760 push @authorised_values, $id;
761 $authorised_lib{$id} = $name;
764 elsif ( $authorised_value eq "debit_types" ) {
765 my $sth = $dbh->prepare("SELECT code, description FROM account_debit_types ORDER BY code");
767 while ( my ( $code, $description ) = $sth->fetchrow_array ) {
768 push @authorised_values, $code;
769 $authorised_lib{$code} = $description;
772 elsif ( $authorised_value eq "credit_types" ) {
773 my $sth = $dbh->prepare("SELECT code, description FROM account_credit_types ORDER BY code");
775 while ( my ( $code, $description ) = $sth->fetchrow_array ) {
776 push @authorised_values, $code;
777 $authorised_lib{$code} = $description;
781 if ( Koha::AuthorisedValues->search({ category => $authorised_value })->count ) {
783 SELECT authorised_value,lib
784 FROM authorised_values
788 my $authorised_values_sth = $dbh->prepare($query);
789 $authorised_values_sth->execute( $authorised_value);
791 while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
792 push @authorised_values, $value;
793 $authorised_lib{$value} = $lib;
794 # For item location, we show the code and the libelle
795 $authorised_lib{$value} = $lib;
798 # not exists $authorised_value_categories{$authorised_value})
799 push @authval_errors, {'entry' => $text,
800 'auth_val' => $authorised_value };
801 # tell the template there's an error
802 $template->param( auth_val_error => 1 );
803 # skip scrolling list creation and params push
810 name => "sql_params",
811 id => "sql_params_".$labelid,
812 values => \@authorised_values,
813 labels => \%authorised_lib,
817 push @tmpl_parameters, {'entry' => $text, 'input' => $input, 'labelid' => $labelid, 'name' => $text.$sep.$authorised_value_all, 'include_all' => $all };
819 $template->param('sql' => $sql,
821 'sql_params' => \@tmpl_parameters,
822 'auth_val_errors' => \@authval_errors,
824 'reports' => $report_id,
827 my ($sql,$header_types) = $report->prep_report( \@param_names, \@sql_params );
828 $template->param(header_types => $header_types);
829 my ( $sth, $errors ) = execute_query(
834 report_id => $report_id,
839 die "execute_query failed to return sth for report $report_id: $sql";
840 } elsif ( !$errors ) {
841 $total = nb_rows($sql) || 0;
842 my $headers = header_cell_loop($sth);
843 $template->param(header_row => $headers);
844 while (my $row = $sth->fetchrow_arrayref()) {
845 my @cells = map { +{ cell => $_ } } @$row;
846 push @rows, { cells => \@cells };
848 if( $want_full_chart ){
849 my ( $sth2, $errors2 ) = execute_query( { sql => $sql, report_id => $report_id } );
850 while (my $row = $sth2->fetchrow_arrayref()) {
851 my @cells = map { +{ cell => $_ } } @$row;
852 push @allrows, { cells => \@cells };
856 my $totpages = int($total/$limit) + (($total % $limit) > 0 ? 1 : 0);
857 my $url = "/cgi-bin/koha/reports/guided_reports.pl?reports=$report_id&phase=Run%20this%20report&limit=$limit&want_full_chart=$want_full_chart";
859 $url = join('&param_name=', $url, map { URI::Escape::uri_escape_utf8($_) } @param_names);
862 $url = join('&sql_params=', $url, map { URI::Escape::uri_escape_utf8($_) } @sql_params);
867 'allresults' => \@allrows,
868 'pagination_bar' => pagination_bar($url, $totpages, scalar $input->param('page')),
869 'unlimited_total' => $total,
874 original_sql => $original_sql,
879 'errors' => defined($errors) ? [$errors] : undef,
880 'sql_params' => \@sql_params,
881 'param_names' => \@param_names,
886 push @errors, { no_sql_for_id => $report_id };
890 elsif ($phase eq 'Export'){
892 # export results to tab separated text or CSV
893 my $report_id = $input->param('report_id');
894 my $report = Koha::Reports->find($report_id);
895 my $sql = $report->savedsql;
896 my @param_names = $input->multi_param('param_name');
897 my @sql_params = $input->multi_param('sql_params');
898 my $format = $input->param('format');
899 my $reportname = $input->param('reportname');
900 my $reportfilename = $reportname ? "$reportname-reportresults.$format" : "reportresults.$format" ;
902 ($sql, undef) = $report->prep_report( \@param_names, \@sql_params );
903 my ( $sth, $q_errors ) = execute_query( { sql => $sql, report_id => $report_id } );
904 unless ($q_errors and @$q_errors) {
905 my ( $type, $content );
906 if ($format eq 'tab') {
907 $type = 'application/octet-stream';
908 $content .= join("\t", header_cell_values($sth)) . "\n";
909 $content = Encode::decode('UTF-8', $content);
910 while (my $row = $sth->fetchrow_arrayref()) {
911 $content .= join("\t", map { $_ // '' } @$row) . "\n";
914 if ( $format eq 'csv' ) {
915 my $delimiter = C4::Context->csv_delimiter;
916 $type = 'application/csv';
917 my $csv = Text::CSV::Encoded->new({ encoding_out => 'UTF-8', sep_char => $delimiter});
918 $csv or die "Text::CSV::Encoded->new({binary => 1}) FAILED: " . Text::CSV::Encoded->error_diag();
919 if ($csv->combine(header_cell_values($sth))) {
920 $content .= Encode::decode('UTF-8', $csv->string()) . "\n";
922 push @$q_errors, { combine => 'HEADER ROW: ' . $csv->error_diag() } ;
924 while (my $row = $sth->fetchrow_arrayref()) {
925 if ($csv->combine(@$row)) {
926 $content .= $csv->string() . "\n";
928 push @$q_errors, { combine => $csv->error_diag() } ;
932 elsif ( $format eq 'ods' ) {
933 $type = 'application/vnd.oasis.opendocument.spreadsheet';
934 my $ods_fh = File::Temp->new( UNLINK => 0 );
935 my $ods_filepath = $ods_fh->filename;
938 # First line is headers
939 my @headers = header_cell_values($sth);
940 push @$ods_content, \@headers;
942 # Other line in Unicode
943 my $sql_rows = $sth->fetchall_arrayref();
944 foreach my $sql_row ( @$sql_rows ) {
946 foreach my $sql_cell ( @$sql_row ) {
947 push @content_row, Encode::encode( 'UTF8', $sql_cell );
949 push @$ods_content, \@content_row;
953 generate_ods($ods_filepath, $ods_content);
957 open $ods_fh, '<', $ods_filepath;
958 $content .= $_ while <$ods_fh>;
959 unlink $ods_filepath;
962 print $input->header(
964 -attachment=> $reportfilename
968 foreach my $err (@$q_errors, @errors) {
969 print "# ERROR: " . (map {$_ . ": " . $err->{$_}} keys %$err) . "\n";
970 } # here we print all the non-fatal errors at the end. Not super smooth, but better than nothing.
976 'name' => 'Error exporting report!',
978 'errors' => $q_errors,
982 elsif ( $phase eq 'Create report from SQL' || $phase eq 'Create report from existing' ) {
984 my ($group, $subgroup, $sql, $reportname, $notes);
985 if ( $input->param('sql') ) {
986 $group = $input->param('report_group');
987 $subgroup = $input->param('report_subgroup');
988 $sql = $input->param('sql') // '';
989 $reportname = $input->param('reportname') // '';
990 $notes = $input->param('notes') // '';
992 elsif ( my $report_id = $input->param('report_id') ) {
993 my $report = Koha::Reports->find($report_id);
994 $group = $report->report_group;
995 $subgroup = $report->report_subgroup;
996 $sql = $report->savedsql // '';
997 $reportname = $report->report_name // '';
998 $notes = $report->notes // '';
1003 reportname => $reportname,
1006 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
1008 'cache_expiry' => 300,
1009 'usecache' => $usecache,
1014 # pass $sth, get back an array of names for the column headers
1015 sub header_cell_values {
1016 my $sth = shift or return ();
1017 return '' unless ($sth->{NAME});
1018 return @{$sth->{NAME}};
1021 # pass $sth, get back a TMPL_LOOP-able set of names for the column headers
1022 sub header_cell_loop {
1023 my @headers = map { +{ cell => decode('UTF-8',$_) } } header_cell_values (shift);
1028 $template->{VARS}->{'build' . $_} and last;
1030 $template->param( 'referer' => $input->referer(),
1033 output_html_with_http_headers $input, $cookie, $template->output;
1035 sub groups_with_subgroups {
1036 my ($group, $subgroup) = @_;
1038 my $groups_with_subgroups = get_report_groups();
1040 my @sorted_keys = sort {
1041 $groups_with_subgroups->{$a}->{name} cmp $groups_with_subgroups->{$b}->{name}
1042 } keys %$groups_with_subgroups;
1043 foreach my $g_id (@sorted_keys) {
1044 my $v = $groups_with_subgroups->{$g_id};
1046 if (my $sg = $v->{subgroups}) {
1047 foreach my $sg_id (sort { $sg->{$a} cmp $sg->{$b} } keys %$sg) {
1050 name => $sg->{$sg_id},
1051 selected => ($group && $g_id eq $group && $subgroup && $sg_id eq $subgroup ),
1058 selected => ($group && $g_id eq $group),
1059 subgroups => \@subgroups,
1065 sub create_non_existing_group_and_subgroup {
1066 my ($input, $group, $subgroup) = @_;
1067 if (defined $group and $group ne '') {
1068 my $report_groups = C4::Reports::Guided::get_report_groups;
1069 if (not exists $report_groups->{$group}) {
1070 my $groupdesc = $input->param('groupdesc') // $group;
1071 Koha::AuthorisedValue->new({
1072 category => 'REPORT_GROUP',
1073 authorised_value => $group,
1076 my $cache_key = "AuthorisedValues-REPORT_GROUP-0-".C4::Context->userenv->{"branch"};
1077 my $cache = Koha::Caches->get_instance();
1078 my $result = $cache->clear_from_cache($cache_key);
1080 if (defined $subgroup and $subgroup ne '') {
1081 if (not exists $report_groups->{$group}->{subgroups}->{$subgroup}) {
1082 my $subgroupdesc = $input->param('subgroupdesc') // $subgroup;
1083 Koha::AuthorisedValue->new({
1084 category => 'REPORT_SUBGROUP',
1085 authorised_value => $subgroup,
1086 lib => $subgroupdesc,
1089 my $cache_key = "AuthorisedValues-REPORT_SUBGROUP-0-".C4::Context->userenv->{"branch"};
1090 my $cache = Koha::Caches->get_instance();
1091 my $result = $cache->clear_from_cache($cache_key);