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;
27 use C4::Auth qw/:DEFAULT get_session/;
33 use Koha::DateUtils qw/dt_from_string output_pref/;
34 use Koha::AuthorisedValue;
35 use Koha::AuthorisedValues;
36 use Koha::BiblioFrameworks;
38 use Koha::Patron::Categories;
39 use Koha::Util::OpenDocument;
47 Script to control the guided report creation
52 my $usecache = Koha::Caches->get_instance->memcached_cache;
54 my $phase = $input->param('phase') // '';
56 if ( ( $phase eq 'Build new' ) || ( $phase eq 'Create report from SQL' ) || ( $phase eq 'Edit SQL' ) ){
57 $flagsrequired = 'create_reports';
59 elsif ( $phase eq 'Use saved' ) {
60 $flagsrequired = 'execute_reports';
62 elsif ( $phase eq 'Delete Saved' ) {
63 $flagsrequired = 'delete_reports';
69 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
71 template_name => "reports/guided_reports_start.tt",
75 flagsrequired => { reports => $flagsrequired },
79 my $session = $cookie ? get_session($cookie->value) : undef;
82 if ( $input->param("filter_set") or $input->param('clear_filters') ) {
84 $filter->{$_} = $input->param("filter_$_") foreach qw/date author keyword group subgroup/;
85 $session->param('report_filter', $filter) if $session;
86 $template->param( 'filter_set' => 1 );
88 elsif ($session and not $input->param('clear_filters')) {
89 $filter = $session->param('report_filter');
92 my $op = $input->param('op') || q||;
96 $template->param( 'start' => 1 );
99 elsif ( $phase eq 'Build new' ) {
101 $template->param( 'build1' => 1 );
103 'areas' => get_report_areas(),
104 'usecache' => $usecache,
105 'cache_expiry' => 300,
108 } elsif ( $phase eq 'Use saved' ) {
110 if ( $op eq 'convert' ) {
111 my $report_id = $input->param('report_id');
112 my $report = C4::Reports::Guided::get_saved_report($report_id);
114 my $updated_sql = C4::Reports::Guided::convert_sql( $report->{savedsql} );
115 C4::Reports::Guided::update_sql(
119 name => $report->{report_name},
120 group => $report->{report_group},
121 subgroup => $report->{report_subgroup},
122 notes => $report->{notes},
123 public => $report->{public},
124 cache_expiry => $report->{cache_expiry},
127 $template->param( report_converted => $report->{report_name} );
132 # get list of reports and display them
133 my $group = $input->param('group');
134 my $subgroup = $input->param('subgroup');
135 $filter->{group} = $group;
136 $filter->{subgroup} = $subgroup;
137 my $reports = get_saved_reports($filter);
138 my $has_obsolete_reports;
139 for my $report ( @$reports ) {
140 $report->{results} = C4::Reports::Guided::get_results( $report->{id} );
141 if ( $report->{savedsql} =~ m|biblioitems| and $report->{savedsql} =~ m|marcxml| ) {
142 $report->{seems_obsolete} = 1;
143 $has_obsolete_reports++;
148 'savedreports' => $reports,
149 'usecache' => $usecache,
150 'groups_with_subgroups' => groups_with_subgroups( $group, $subgroup ),
152 has_obsolete_reports => $has_obsolete_reports,
156 elsif ( $phase eq 'Delete Multiple') {
157 my @ids = $input->multi_param('ids');
158 delete_report( @ids );
159 print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
163 elsif ( $phase eq 'Delete Saved') {
165 # delete a report from the saved reports list
166 my $ids = $input->param('reports');
168 print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
172 elsif ( $phase eq 'Show SQL'){
174 my $id = $input->param('reports');
175 my $report = get_saved_report($id);
178 'reportname' => $report->{report_name},
179 'notes' => $report->{notes},
180 'sql' => $report->{savedsql},
185 elsif ( $phase eq 'Edit SQL'){
186 my $id = $input->param('reports');
187 my $report = get_saved_report($id);
188 my $group = $report->{report_group};
189 my $subgroup = $report->{report_subgroup};
191 'sql' => $report->{savedsql},
192 'reportname' => $report->{report_name},
193 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
194 'notes' => $report->{notes},
196 'cache_expiry' => $report->{cache_expiry},
197 'public' => $report->{public},
198 'usecache' => $usecache,
203 elsif ( $phase eq 'Update SQL'){
204 my $id = $input->param('id');
205 my $sql = $input->param('sql');
206 my $reportname = $input->param('reportname');
207 my $group = $input->param('group');
208 my $subgroup = $input->param('subgroup');
209 my $notes = $input->param('notes');
210 my $cache_expiry = $input->param('cache_expiry');
211 my $cache_expiry_units = $input->param('cache_expiry_units');
212 my $public = $input->param('public');
213 my $save_anyway = $input->param('save_anyway');
217 # if we have the units, then we came from creating a report from SQL and thus need to handle converting units
218 if( $cache_expiry_units ){
219 if( $cache_expiry_units eq "minutes" ){
221 } elsif( $cache_expiry_units eq "hours" ){
222 $cache_expiry *= 3600; # 60 * 60
223 } elsif( $cache_expiry_units eq "days" ){
224 $cache_expiry *= 86400; # 60 * 60 * 24
227 # 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
228 if( $cache_expiry >= 2592000 ){
229 push @errors, {cache_expiry => $cache_expiry};
232 create_non_existing_group_and_subgroup($input, $group, $subgroup);
234 if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
235 push @errors, {sqlerr => $1};
237 elsif ($sql !~ /^(SELECT)/i) {
238 push @errors, {queryerr => "No SELECT"};
243 'errors' => \@errors,
248 # Check defined SQL parameters for authorised value validity
249 my $problematic_authvals = ValidateSQLParameters($sql);
251 if ( scalar @$problematic_authvals > 0 && not $save_anyway ) {
252 # There's at least one problematic parameter, report to the
253 # GUI and provide all user input for further actions
257 'reportname' => $reportname,
259 'subgroup' => $subgroup,
262 'problematic_authvals' => $problematic_authvals,
263 'warn_authval_problem' => 1,
268 # No params problem found or asked to save anyway
273 subgroup => $subgroup,
276 cache_expiry => $cache_expiry,
279 'save_successful' => 1,
280 'reportname' => $reportname,
284 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
286 'cache_expiry' => $cache_expiry,
288 'usecache' => $usecache,
290 logaction( "REPORTS", "MODIFY", $id, "$reportname | $sql" ) if C4::Context->preference("ReportsLog");
294 cache_expiry => $cache_expiry,
295 cache_expiry_units => $cache_expiry_units,
301 elsif ($phase eq 'retrieve results') {
302 my $id = $input->param('id');
303 my $result = format_results( $id );
305 report_name => $result->{report_name},
306 notes => $result->{notes},
307 saved_results => $result->{results},
308 date_run => $result->{date_run},
312 elsif ( $phase eq 'Report on this Area' ) {
313 my $cache_expiry_units = $input->param('cache_expiry_units'),
314 my $cache_expiry = $input->param('cache_expiry');
316 # we need to handle converting units
317 if( $cache_expiry_units eq "minutes" ){
319 } elsif( $cache_expiry_units eq "hours" ){
320 $cache_expiry *= 3600; # 60 * 60
321 } elsif( $cache_expiry_units eq "days" ){
322 $cache_expiry *= 86400; # 60 * 60 * 24
324 # 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
325 if( $cache_expiry >= 2592000 ){ # oops, over the limit of 30 days
326 # report error to user
330 'areas' => get_report_areas(),
331 'cache_expiry' => $cache_expiry,
332 'usecache' => $usecache,
333 'public' => scalar $input->param('public'),
336 # they have chosen a new report and the area to report on
339 'area' => scalar $input->param('area'),
340 'types' => get_report_types(),
341 'cache_expiry' => $cache_expiry,
342 'public' => scalar $input->param('public'),
347 elsif ( $phase eq 'Choose this type' ) {
348 # they have chosen type and area
349 # get area and type and pass them to the template
350 my $area = $input->param('area');
351 my $type = $input->param('types');
356 columns => get_columns($area,$input),
357 'cache_expiry' => scalar $input->param('cache_expiry'),
358 'public' => scalar $input->param('public'),
362 elsif ( $phase eq 'Choose these columns' ) {
363 # we now know type, area, and columns
364 # next step is the constraints
365 my $area = $input->param('area');
366 my $type = $input->param('type');
367 my @columns = $input->multi_param('columns');
368 my $column = join( ',', @columns );
375 definitions => get_from_dictionary($area),
376 criteria => get_criteria($area,$input),
377 'public' => scalar $input->param('public'),
381 cache_expiry => scalar $input->param('cache_expiry'),
382 cache_expiry_units => scalar $input->param('cache_expiry_units'),
388 elsif ( $phase eq 'Choose these criteria' ) {
389 my $area = $input->param('area');
390 my $type = $input->param('type');
391 my $column = $input->param('column');
392 my @definitions = $input->multi_param('definition');
393 my $definition = join (',',@definitions);
394 my @criteria = $input->multi_param('criteria_column');
396 foreach my $crit (@criteria) {
397 my $value = $input->param( $crit . "_value" );
399 # If value is not defined, then it may be range values
400 if (!defined $value) {
402 my $fromvalue = $input->param( "from_" . $crit . "_value" );
403 my $tovalue = $input->param( "to_" . $crit . "_value" );
405 # If the range values are dates
407 $fromvalue_dt = eval { dt_from_string( $fromvalue ); } if ( $fromvalue );
409 $tovalue_dt = eval { dt_from_string( $tovalue ); } if ($tovalue);
410 if ( $fromvalue_dt && $tovalue_dt ) {
411 $fromvalue = output_pref( { dt => dt_from_string( $fromvalue_dt ), dateonly => 1, dateformat => 'iso' } );
412 $tovalue = output_pref( { dt => dt_from_string( $tovalue_dt ), dateonly => 1, dateformat => 'iso' } );
415 if ($fromvalue && $tovalue) {
416 $query_criteria .= " AND $crit >= '$fromvalue' AND $crit <= '$tovalue'";
423 $value_dt = eval { dt_from_string( $value ); } if ( $value );
425 $value = output_pref( { dt => dt_from_string( $value_dt ), dateonly => 1, dateformat => 'iso' } );
427 # don't escape runtime parameters, they'll be at runtime
428 if ($value =~ /<<.*>>/) {
429 $query_criteria .= " AND $crit=$value";
431 $query_criteria .= " AND $crit='$value'";
440 'definition' => $definition,
441 'criteriastring' => $query_criteria,
442 'public' => scalar $input->param('public'),
446 cache_expiry => scalar $input->param('cache_expiry'),
447 cache_expiry_units => scalar $input->param('cache_expiry_units'),
452 my @columns = split( ',', $column );
455 # build structue for use by tmpl_loop to choose columns to order by
456 # need to do something about the order of the order :)
457 # we also want to use the %columns hash to get the plain english names
458 foreach my $col (@columns) {
459 my %total = (name => $col);
460 my @selects = map {+{ value => $_ }} (qw(sum min max avg count));
461 $total{'select'} = \@selects;
462 push @total_by, \%total;
465 $template->param( 'total_by' => \@total_by );
468 elsif ( $phase eq 'Choose these operations' ) {
469 my $area = $input->param('area');
470 my $type = $input->param('type');
471 my $column = $input->param('column');
472 my $criteria = $input->param('criteria');
473 my $definition = $input->param('definition');
474 my @total_by = $input->multi_param('total_by');
476 foreach my $total (@total_by) {
477 my $value = $input->param( $total . "_tvalue" );
478 $totals .= "$value($total),";
486 'criteriastring' => $criteria,
488 'definition' => $definition,
489 'cache_expiry' => scalar $input->param('cache_expiry'),
490 'public' => scalar $input->param('public'),
494 my @columns = split( ',', $column );
497 # build structue for use by tmpl_loop to choose columns to order by
498 # need to do something about the order of the order :)
499 foreach my $col (@columns) {
500 my %order = (name => $col);
501 my @selects = map {+{ value => $_ }} (qw(asc desc));
502 $order{'select'} = \@selects;
503 push @order_by, \%order;
506 $template->param( 'order_by' => \@order_by );
509 elsif ( $phase eq 'Build report' ) {
511 # now we have all the info we need and can build the sql
512 my $area = $input->param('area');
513 my $type = $input->param('type');
514 my $column = $input->param('column');
515 my $crit = $input->param('criteria');
516 my $totals = $input->param('totals');
517 my $definition = $input->param('definition');
518 my $query_criteria=$crit;
519 # split the columns up by ,
520 my @columns = split( ',', $column );
521 my @order_by = $input->multi_param('order_by');
524 foreach my $order (@order_by) {
525 my $value = $input->param( $order . "_ovalue" );
526 if ($query_orderby) {
527 $query_orderby .= ",$order $value";
530 $query_orderby = " ORDER BY $order $value";
536 build_query( \@columns, $query_criteria, $query_orderby, $area, $totals, $definition );
542 'cache_expiry' => scalar $input->param('cache_expiry'),
543 'public' => scalar $input->param('public'),
547 elsif ( $phase eq 'Save' ) {
548 # Save the report that has just been built
549 my $area = $input->param('area');
550 my $sql = $input->param('sql');
551 my $type = $input->param('type');
557 'cache_expiry' => scalar $input->param('cache_expiry'),
558 'public' => scalar $input->param('public'),
559 'groups_with_subgroups' => groups_with_subgroups($area), # in case we have a report group that matches area
563 elsif ( $phase eq 'Save Report' ) {
564 # save the sql pasted in by a user
565 my $area = $input->param('area');
566 my $group = $input->param('group');
567 my $subgroup = $input->param('subgroup');
568 my $sql = $input->param('sql');
569 my $name = $input->param('reportname');
570 my $type = $input->param('types');
571 my $notes = $input->param('notes');
572 my $cache_expiry = $input->param('cache_expiry');
573 my $cache_expiry_units = $input->param('cache_expiry_units');
574 my $public = $input->param('public');
575 my $save_anyway = $input->param('save_anyway');
578 # if we have the units, then we came from creating a report from SQL and thus need to handle converting units
579 if( $cache_expiry_units ){
580 if( $cache_expiry_units eq "minutes" ){
582 } elsif( $cache_expiry_units eq "hours" ){
583 $cache_expiry *= 3600; # 60 * 60
584 } elsif( $cache_expiry_units eq "days" ){
585 $cache_expiry *= 86400; # 60 * 60 * 24
588 # 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
589 if( $cache_expiry && $cache_expiry >= 2592000 ){
590 push @errors, {cache_expiry => $cache_expiry};
593 create_non_existing_group_and_subgroup($input, $group, $subgroup);
594 ## FIXME this is AFTER entering a name to save the report under
595 if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
596 push @errors, {sqlerr => $1};
598 elsif ($sql !~ /^(SELECT)/i) {
599 push @errors, {queryerr => "No SELECT"};
604 'errors' => \@errors,
606 'reportname'=> $name,
609 'cache_expiry' => $cache_expiry,
613 # Check defined SQL parameters for authorised value validity
614 my $problematic_authvals = ValidateSQLParameters($sql);
616 if ( scalar @$problematic_authvals > 0 && not $save_anyway ) {
617 # There's at least one problematic parameter, report to the
618 # GUI and provide all user input for further actions
622 'subgroup' => $subgroup,
624 'reportname' => $name,
628 'problematic_authvals' => $problematic_authvals,
629 'warn_authval_problem' => 1,
634 cache_expiry => $cache_expiry,
635 cache_expiry_units => $cache_expiry_units,
639 # No params problem found or asked to save anyway
640 my $id = save_report( {
641 borrowernumber => $borrowernumber,
646 subgroup => $subgroup,
649 cache_expiry => $cache_expiry,
652 logaction( "REPORTS", "ADD", $id, "$name | $sql" ) if C4::Context->preference("ReportsLog");
654 'save_successful' => 1,
655 'reportname' => $name,
659 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
661 'cache_expiry' => $cache_expiry,
663 'usecache' => $usecache,
669 elsif ($phase eq 'Run this report'){
670 # execute a saved report
671 my $limit = $input->param('limit') || 20;
673 my $report_id = $input->param('reports');
674 my @sql_params = $input->multi_param('sql_params');
675 my @param_names = $input->multi_param('param_name');
678 if ($input->param('page')) {
679 $offset = ($input->param('page') - 1) * $limit;
684 'report_id' => $report_id,
687 my ( $sql, $original_sql, $type, $name, $notes );
688 if (my $report = get_saved_report($report_id)) {
689 $sql = $original_sql = $report->{savedsql};
690 $name = $report->{report_name};
691 $notes = $report->{notes};
694 # if we have at least 1 parameter, and it's not filled, then don't execute but ask for parameters
695 if ($sql =~ /<</ && !@sql_params) {
696 # split on ??. Each odd (2,4,6,...) entry should be a parameter to fill
697 my @split = split /<<|>>/,$sql;
701 for(my $i=0;$i<($#split/2);$i++) {
702 my ($text,$authorised_value) = split /\|/,$split[$i*2+1];
703 my $sep = $authorised_value ? "|" : "";
704 if( defined $uniq_params{$text.$sep.$authorised_value} ){
706 } else { $uniq_params{$text.$sep.$authorised_value} = "$i"; }
709 if ( not defined $authorised_value ) {
710 # no authorised value input, provide a text box
712 } elsif ( $authorised_value eq "date" ) {
713 # require a date, provide a date picker
716 # defined $authorised_value, and not 'date'
717 my $dbh=C4::Context->dbh;
718 my @authorised_values;
720 # builds list, depending on authorised value...
721 if ( $authorised_value eq "branches" ) {
722 my $libraries = Koha::Libraries->search( {}, { order_by => ['branchname'] } );
723 while ( my $library = $libraries->next ) {
724 push @authorised_values, $library->branchcode;
725 $authorised_lib{$library->branchcode} = $library->branchname;
728 elsif ( $authorised_value eq "itemtypes" ) {
729 my $sth = $dbh->prepare("SELECT itemtype,description FROM itemtypes ORDER BY description");
731 while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
732 push @authorised_values, $itemtype;
733 $authorised_lib{$itemtype} = $description;
736 elsif ( $authorised_value eq "biblio_framework" ) {
737 my @frameworks = Koha::BiblioFrameworks->search({}, { order_by => ['frameworktext'] });
738 my $default_source = '';
739 push @authorised_values,$default_source;
740 $authorised_lib{$default_source} = 'Default';
741 foreach my $framework (@frameworks) {
742 push @authorised_values, $framework->frameworkcode;
743 $authorised_lib{$framework->frameworkcode} = $framework->frameworktext;
746 elsif ( $authorised_value eq "cn_source" ) {
747 my $class_sources = GetClassSources();
748 my $default_source = C4::Context->preference("DefaultClassificationSource");
749 foreach my $class_source (sort keys %$class_sources) {
750 next unless $class_sources->{$class_source}->{'used'} or
751 ($class_source eq $default_source);
752 push @authorised_values, $class_source;
753 $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
756 elsif ( $authorised_value eq "categorycode" ) {
757 my @patron_categories = Koha::Patron::Categories->search({}, { order_by => ['description']});
758 %authorised_lib = map { $_->categorycode => $_->description } @patron_categories;
759 push @authorised_values, $_->categorycode for @patron_categories;
762 if ( Koha::AuthorisedValues->search({ category => $authorised_value })->count ) {
764 SELECT authorised_value,lib
765 FROM authorised_values
769 my $authorised_values_sth = $dbh->prepare($query);
770 $authorised_values_sth->execute( $authorised_value);
772 while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
773 push @authorised_values, $value;
774 $authorised_lib{$value} = $lib;
775 # For item location, we show the code and the libelle
776 $authorised_lib{$value} = $lib;
779 # not exists $authorised_value_categories{$authorised_value})
780 push @authval_errors, {'entry' => $text,
781 'auth_val' => $authorised_value };
782 # tell the template there's an error
783 $template->param( auth_val_error => 1 );
784 # skip scrolling list creation and params push
791 name => "sql_params",
792 id => "sql_params_".$labelid,
793 values => \@authorised_values,
794 labels => \%authorised_lib,
798 push @tmpl_parameters, {'entry' => $text, 'input' => $input, 'labelid' => $labelid, 'name' => $text.$sep.$authorised_value };
800 $template->param('sql' => $sql,
802 'sql_params' => \@tmpl_parameters,
803 'auth_val_errors' => \@authval_errors,
805 'reports' => $report_id,
808 my $sql = get_prepped_report( $sql, \@param_names, \@sql_params);
809 my ( $sth, $errors ) = execute_query( $sql, $offset, $limit, undef, $report_id );
810 my $total = nb_rows($sql) || 0;
812 die "execute_query failed to return sth for report $report_id: $sql";
814 my $headers = header_cell_loop($sth);
815 $template->param(header_row => $headers);
816 while (my $row = $sth->fetchrow_arrayref()) {
817 my @cells = map { +{ cell => $_ } } @$row;
818 push @rows, { cells => \@cells };
822 my $totpages = int($total/$limit) + (($total % $limit) > 0 ? 1 : 0);
823 my $url = "/cgi-bin/koha/reports/guided_reports.pl?reports=$report_id&phase=Run%20this%20report&limit=$limit";
825 $url = join('&param_name=', $url, map { URI::Escape::uri_escape_utf8($_) } @param_names);
828 $url = join('&sql_params=', $url, map { URI::Escape::uri_escape_utf8($_) } @sql_params);
834 original_sql => $original_sql,
839 'errors' => defined($errors) ? [ $errors ] : undef,
840 'pagination_bar' => pagination_bar($url, $totpages, scalar $input->param('page')),
841 'unlimited_total' => $total,
842 'sql_params' => \@sql_params,
843 'param_names' => \@param_names,
848 push @errors, { no_sql_for_id => $report_id };
852 elsif ($phase eq 'Export'){
854 # export results to tab separated text or CSV
855 my $report_id = $input->param('report_id');
856 my $report = get_saved_report($report_id);
857 my $sql = $report->{savedsql};
858 my @param_names = $input->multi_param('param_name');
859 my @sql_params = $input->multi_param('sql_params');
860 my $format = $input->param('format');
861 my $reportname = $input->param('reportname');
862 my $reportfilename = $reportname ? "$reportname-reportresults.$format" : "reportresults.$format" ;
864 $sql = get_prepped_report( $sql, \@param_names, \@sql_params );
865 my ($sth, $q_errors) = execute_query($sql);
866 unless ($q_errors and @$q_errors) {
867 my ( $type, $content );
868 if ($format eq 'tab') {
869 $type = 'application/octet-stream';
870 $content .= join("\t", header_cell_values($sth)) . "\n";
871 $content = Encode::decode('UTF-8', $content);
872 while (my $row = $sth->fetchrow_arrayref()) {
873 $content .= join("\t", @$row) . "\n";
876 my $delimiter = C4::Context->preference('delimiter') || ',';
877 if ( $format eq 'csv' ) {
878 $delimiter = "\t" if $delimiter eq 'tabulation';
879 $type = 'application/csv';
880 my $csv = Text::CSV::Encoded->new({ encoding_out => 'UTF-8', sep_char => $delimiter});
881 $csv or die "Text::CSV::Encoded->new({binary => 1}) FAILED: " . Text::CSV::Encoded->error_diag();
882 if ($csv->combine(header_cell_values($sth))) {
883 $content .= Encode::decode('UTF-8', $csv->string()) . "\n";
885 push @$q_errors, { combine => 'HEADER ROW: ' . $csv->error_diag() } ;
887 while (my $row = $sth->fetchrow_arrayref()) {
888 if ($csv->combine(@$row)) {
889 $content .= $csv->string() . "\n";
891 push @$q_errors, { combine => $csv->error_diag() } ;
895 elsif ( $format eq 'ods' ) {
896 $type = 'application/vnd.oasis.opendocument.spreadsheet';
897 my $ods_fh = File::Temp->new( UNLINK => 0 );
898 my $ods_filepath = $ods_fh->filename;
901 # First line is headers
902 my @headers = header_cell_values($sth);
903 push @$ods_content, \@headers;
905 # Other line in Unicode
906 my $sql_rows = $sth->fetchall_arrayref();
907 foreach my $sql_row ( @$sql_rows ) {
909 foreach my $sql_cell ( @$sql_row ) {
910 push @content_row, Encode::encode( 'UTF8', $sql_cell );
912 push @$ods_content, \@content_row;
916 generate_ods($ods_filepath, $ods_content);
920 open $ods_fh, '<', $ods_filepath;
921 $content .= $_ while <$ods_fh>;
922 unlink $ods_filepath;
925 print $input->header(
927 -attachment=> $reportfilename
931 foreach my $err (@$q_errors, @errors) {
932 print "# ERROR: " . (map {$_ . ": " . $err->{$_}} keys %$err) . "\n";
933 } # here we print all the non-fatal errors at the end. Not super smooth, but better than nothing.
939 'name' => 'Error exporting report!',
941 'errors' => $q_errors,
945 elsif ( $phase eq 'Create report from SQL' ) {
947 my ($group, $subgroup);
948 # allow the user to paste in sql
949 if ( $input->param('sql') ) {
950 $group = $input->param('report_group');
951 $subgroup = $input->param('report_subgroup');
953 'sql' => scalar $input->param('sql') // '',
954 'reportname' => scalar $input->param('reportname') // '',
955 'notes' => scalar $input->param('notes') // '',
960 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
962 'cache_expiry' => 300,
963 'usecache' => $usecache,
967 # pass $sth, get back an array of names for the column headers
968 sub header_cell_values {
969 my $sth = shift or return ();
970 return '' unless ($sth->{NAME});
971 return @{$sth->{NAME}};
974 # pass $sth, get back a TMPL_LOOP-able set of names for the column headers
975 sub header_cell_loop {
976 my @headers = map { +{ cell => decode('UTF-8',$_) } } header_cell_values (shift);
981 $template->{VARS}->{'build' . $_} and last;
983 $template->param( 'referer' => $input->referer(),
986 output_html_with_http_headers $input, $cookie, $template->output;
988 sub groups_with_subgroups {
989 my ($group, $subgroup) = @_;
991 my $groups_with_subgroups = get_report_groups();
993 my @sorted_keys = sort {
994 $groups_with_subgroups->{$a}->{name} cmp $groups_with_subgroups->{$b}->{name}
995 } keys %$groups_with_subgroups;
996 foreach my $g_id (@sorted_keys) {
997 my $v = $groups_with_subgroups->{$g_id};
999 if (my $sg = $v->{subgroups}) {
1000 foreach my $sg_id (sort { $sg->{$a} cmp $sg->{$b} } keys %$sg) {
1003 name => $sg->{$sg_id},
1004 selected => ($group && $g_id eq $group && $subgroup && $sg_id eq $subgroup ),
1011 selected => ($group && $g_id eq $group),
1012 subgroups => \@subgroups,
1018 sub create_non_existing_group_and_subgroup {
1019 my ($input, $group, $subgroup) = @_;
1020 if (defined $group and $group ne '') {
1021 my $report_groups = C4::Reports::Guided::get_report_groups;
1022 if (not exists $report_groups->{$group}) {
1023 my $groupdesc = $input->param('groupdesc') // $group;
1024 Koha::AuthorisedValue->new({
1025 category => 'REPORT_GROUP',
1026 authorised_value => $group,
1029 my $cache_key = "AuthorisedValues-REPORT_GROUP-0-".C4::Context->userenv->{"branch"};
1030 my $cache = Koha::Caches->get_instance();
1031 my $result = $cache->clear_from_cache($cache_key);
1033 if (defined $subgroup and $subgroup ne '') {
1034 if (not exists $report_groups->{$group}->{subgroups}->{$subgroup}) {
1035 my $subgroupdesc = $input->param('subgroupdesc') // $subgroup;
1036 Koha::AuthorisedValue->new({
1037 category => 'REPORT_SUBGROUP',
1038 authorised_value => $subgroup,
1039 lib => $subgroupdesc,
1042 my $cache_key = "AuthorisedValues-REPORT_SUBGROUP-0-".C4::Context->userenv->{"branch"};
1043 my $cache = Koha::Caches->get_instance();
1044 my $result = $cache->clear_from_cache($cache_key);
1050 # pass $sth and sql_params, get back an executable query
1051 sub get_prepped_report {
1052 my ($sql, $param_names, $sql_params ) = @_;
1054 @lookup{@$param_names} = @$sql_params;
1055 my @split = split /<<|>>/,$sql;
1056 my @tmpl_parameters;
1057 for(my $i=0;$i<$#split/2;$i++) {
1058 my $quoted = @$param_names ? $lookup{ $split[$i*2+1] } : @$sql_params[$i];
1059 # if there are special regexp chars, we must \ them
1060 $split[$i*2+1] =~ s/(\||\?|\.|\*|\(|\)|\%)/\\$1/g;
1061 if ($split[$i*2+1] =~ /\|\s*date\s*$/) {
1062 $quoted = output_pref({ dt => dt_from_string($quoted), dateformat => 'iso', dateonly => 1 }) if $quoted;
1064 $quoted = C4::Context->dbh->quote($quoted);
1065 $sql =~ s/<<$split[$i*2+1]>>/$quoted/;