reports/guided_reports.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2007 Liblime ltd
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use Modern::Perl;
  21 use CGI qw/-utf8/;
  22 use Text::CSV::Encoded;
  23 use Encode qw( decode );
  24 use URI::Escape;
  25 use File::Temp;
  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 );
  27 use Koha::Reports;
  28 use C4::Auth qw( get_template_and_user get_session );
  29 use C4::Output qw( pagination_bar output_html_with_http_headers );
  30 use C4::Context;
  31 use Koha::Caches;
  32 use C4::Log qw( logaction );
  33 use Koha::DateUtils qw( dt_from_string output_pref );
  34 use Koha::AuthorisedValue;
  35 use Koha::AuthorisedValues;
  36 use Koha::BiblioFrameworks;
  37 use Koha::Libraries;
  38 use Koha::Patron::Categories;
  39 use Koha::SharedContent;
  40 use Koha::Util::OpenDocument qw( generate_ods );
  41 use C4::ClassSource qw( GetClassSources );
  42
  43 =head1 NAME
  44
  45 guided_reports.pl
  46
  47 =head1 DESCRIPTION
  48
  49 Script to control the guided report creation
  50
  51 =cut
  52
  53 my $input = CGI->new;
  54 my $usecache = Koha::Caches->get_instance->memcached_cache;
  55
  56 my $phase = $input->param('phase') // '';
  57 my $flagsrequired;
  58 if ( ( $phase eq 'Build new' ) || ( $phase eq 'Create report from SQL' ) || ( $phase eq 'Edit SQL' )
  59    || ( $phase eq 'Build new from existing' ) ) {
  60     $flagsrequired = 'create_reports';
  61 }
  62 elsif ( $phase eq 'Use saved' ) {
  63     $flagsrequired = 'execute_reports';
  64 }
  65 elsif ( $phase eq 'Delete Saved' ) {
  66     $flagsrequired = 'delete_reports';
  67 }
  68 else {
  69     $flagsrequired = '*';
  70 }
  71
  72 my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
  73     {
  74         template_name   => "reports/guided_reports_start.tt",
  75         query           => $input,
  76         type            => "intranet",
  77         flagsrequired   => { reports => $flagsrequired },
  78     }
  79 );
  80 my $session_id = $input->cookie('CGISESSID');
  81 my $session = $session_id ? get_session($session_id) : undef;
  82
  83 my $filter;
  84 if ( $input->param("filter_set") or $input->param('clear_filters') ) {
  85     $filter = {};
  86     $filter->{$_} = $input->param("filter_$_") foreach qw/date author keyword group subgroup/;
  87     $session->param('report_filter', $filter) if $session;
  88     $template->param( 'filter_set' => 1 );
  89 }
  90 elsif ($session and not $input->param('clear_filters')) {
  91     $filter = $session->param('report_filter');
  92 }
  93
  94 my $op = $input->param('op') || q||;
  95
  96 my @errors = ();
  97 if ( !$phase ) {
  98     $template->param( 'start' => 1 );
  99     # show welcome page
 100 }
 101 elsif ( $phase eq 'Build new' ) {
 102     # build a new report
 103     $template->param( 'build1' => 1 );
 104     $template->param(
 105         'areas'        => get_report_areas(),
 106         'usecache'     => $usecache,
 107         'cache_expiry' => 300,
 108         'public'       => '0',
 109     );
 110 } elsif ( $phase eq 'Use saved' ) {
 111
 112     if ( $op eq 'convert' ) {
 113         my $report_id = $input->param('report_id');
 114         my $report    = Koha::Reports->find($report_id);
 115         if ($report) {
 116             my $updated_sql = C4::Reports::Guided::convert_sql( $report->savedsql );
 117             C4::Reports::Guided::update_sql(
 118                 $report_id,
 119                 {
 120                     sql          => $updated_sql,
 121                     name         => $report->report_name,
 122                     group        => $report->report_group,
 123                     subgroup     => $report->report_subgroup,
 124                     notes        => $report->notes,
 125                     public       => $report->public,
 126                     cache_expiry => $report->cache_expiry,
 127                 }
 128             );
 129             $template->param( report_converted => $report->report_name );
 130         }
 131     }
 132
 133     # use a saved report
 134     # get list of reports and display them
 135     my $group = $input->param('group');
 136     my $subgroup = $input->param('subgroup');
 137     $filter->{group} = $group;
 138     $filter->{subgroup} = $subgroup;
 139     my $reports = get_saved_reports($filter);
 140     my $has_obsolete_reports;
 141     for my $report ( @$reports ) {
 142         $report->{results} = C4::Reports::Guided::get_results( $report->{id} );
 143         if ( $report->{savedsql} =~ m|biblioitems| and $report->{savedsql} =~ m|marcxml| ) {
 144             $report->{seems_obsolete} = 1;
 145             $has_obsolete_reports++;
 146         }
 147     }
 148     $template->param(
 149         'manamsg' => $input->param('manamsg') || '',
 150         'saved1'                => 1,
 151         'savedreports'          => $reports,
 152         'usecache'              => $usecache,
 153         'groups_with_subgroups' => groups_with_subgroups( $group, $subgroup ),
 154         filters                 => $filter,
 155         has_obsolete_reports    => $has_obsolete_reports,
 156     );
 157 }
 158
 159 elsif ( $phase eq 'Delete Multiple') {
 160     my @ids = $input->multi_param('ids');
 161     delete_report( @ids );
 162     print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
 163     exit;
 164 }
 165
 166 elsif ( $phase eq 'Delete Saved') {
 167
 168         # delete a report from the saved reports list
 169     my $ids = $input->param('reports');
 170     delete_report($ids);
 171     print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
 172         exit;
 173 }
 174
 175 elsif ( $phase eq 'Show SQL'){
 176
 177     my $id = $input->param('reports');
 178     my $report = Koha::Reports->find($id);
 179     $template->param(
 180         'id'      => $id,
 181         'reportname' => $report->report_name,
 182         'notes'      => $report->notes,
 183         'sql'     => $report->savedsql,
 184         'showsql' => 1,
 185         'mana_success' => scalar $input->param('mana_success'),
 186         'mana_id' => $report->{mana_id},
 187         'mana_comments' => $report->{comments}
 188     );
 189 }
 190
 191 elsif ( $phase eq 'Edit SQL'){
 192     my $id = $input->param('reports');
 193     my $report = Koha::Reports->find($id);
 194     my $group = $report->report_group;
 195     my $subgroup  = $report->report_subgroup;
 196     $template->param(
 197         'sql'        => $report->savedsql,
 198         'reportname' => $report->report_name,
 199         'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
 200         'notes'      => $report->notes,
 201         'id'         => $id,
 202         'cache_expiry' => $report->cache_expiry,
 203         'public' => $report->public,
 204         'usecache' => $usecache,
 205         'editsql'    => 1,
 206         'mana_id' => $report->{mana_id},
 207         'mana_comments' => $report->{comments}
 208     );
 209 }
 210
 211 elsif ( $phase eq 'Update SQL'){
 212     my $id         = $input->param('id');
 213     my $sql        = $input->param('sql');
 214     my $reportname = $input->param('reportname');
 215     my $group      = $input->param('group');
 216     my $subgroup   = $input->param('subgroup');
 217     my $notes      = $input->param('notes');
 218     my $cache_expiry = $input->param('cache_expiry');
 219     my $cache_expiry_units = $input->param('cache_expiry_units');
 220     my $public = $input->param('public');
 221     my $save_anyway = $input->param('save_anyway');
 222     my @errors;
 223
 224     # if we have the units, then we came from creating a report from SQL and thus need to handle converting units
 225     if( $cache_expiry_units ){
 226       if( $cache_expiry_units eq "minutes" ){
 227         $cache_expiry *= 60;
 228       } elsif( $cache_expiry_units eq "hours" ){
 229         $cache_expiry *= 3600; # 60 * 60
 230       } elsif( $cache_expiry_units eq "days" ){
 231         $cache_expiry *= 86400; # 60 * 60 * 24
 232       }
 233     }
 234     # 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
 235     if( $cache_expiry >= 2592000 ){
 236       push @errors, {cache_expiry => $cache_expiry};
 237     }
 238
 239     create_non_existing_group_and_subgroup($input, $group, $subgroup);
 240
 241     my ( $is_sql_valid, $validation_errors ) = Koha::Report->new({ savedsql => $sql })->is_sql_valid;
 242     push(@errors, @$validation_errors) unless $is_sql_valid;
 243
 244     if (@errors) {
 245         $template->param(
 246             'errors'    => \@errors,
 247             'sql'       => $sql,
 248         );
 249     } else {
 250
 251         # Check defined SQL parameters for authorised value validity
 252         my $problematic_authvals = ValidateSQLParameters($sql);
 253
 254         if ( scalar @$problematic_authvals > 0 && not $save_anyway ) {
 255             # There's at least one problematic parameter, report to the
 256             # GUI and provide all user input for further actions
 257             $template->param(
 258                 'id' => $id,
 259                 'sql' => $sql,
 260                 'reportname' => $reportname,
 261                 'group' => $group,
 262                 'subgroup' => $subgroup,
 263                 'notes' => $notes,
 264                 'public' => $public,
 265                 'problematic_authvals' => $problematic_authvals,
 266                 'warn_authval_problem' => 1,
 267                 'phase_update' => 1
 268             );
 269
 270         } else {
 271             # No params problem found or asked to save anyway
 272             update_sql( $id, {
 273                     sql => $sql,
 274                     name => $reportname,
 275                     group => $group,
 276                     subgroup => $subgroup,
 277                     notes => $notes,
 278                     public => $public,
 279                     cache_expiry => $cache_expiry,
 280                 } );
 281             $template->param(
 282                 'save_successful'       => 1,
 283                 'reportname'            => $reportname,
 284                 'id'                    => $id,
 285                 'editsql'               => 1,
 286                 'sql'                   => $sql,
 287                 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
 288                 'notes'                 => $notes,
 289                 'cache_expiry'          => $cache_expiry,
 290                 'public'                => $public,
 291                 'usecache'              => $usecache,
 292             );
 293             logaction( "REPORTS", "MODIFY", $id, "$reportname | $sql" ) if C4::Context->preference("ReportsLog");
 294         }
 295         if ( $usecache ) {
 296             $template->param(
 297                 cache_expiry => $cache_expiry,
 298                 cache_expiry_units => $cache_expiry_units,
 299             );
 300         }
 301     }
 302 }
 303
 304 elsif ($phase eq 'retrieve results') {
 305     my $id = $input->param('id');
 306     my $result = format_results( $id );
 307     $template->param(
 308         report_name   => $result->{report_name},
 309         notes         => $result->{notes},
 310         saved_results => $result->{results},
 311         date_run      => $result->{date_run},
 312     );
 313 }
 314
 315 elsif ( $phase eq 'Report on this Area' ) {
 316     my $cache_expiry_units = $input->param('cache_expiry_units'),
 317     my $cache_expiry = $input->param('cache_expiry');
 318
 319     # we need to handle converting units
 320     if( $cache_expiry_units eq "minutes" ){
 321       $cache_expiry *= 60;
 322     } elsif( $cache_expiry_units eq "hours" ){
 323       $cache_expiry *= 3600; # 60 * 60
 324     } elsif( $cache_expiry_units eq "days" ){
 325       $cache_expiry *= 86400; # 60 * 60 * 24
 326     }
 327     # 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
 328     if( $cache_expiry >= 2592000 ){ # oops, over the limit of 30 days
 329       # report error to user
 330       $template->param(
 331         'cache_error' => 1,
 332         'build1' => 1,
 333         'areas'   => get_report_areas(),
 334         'cache_expiry' => $cache_expiry,
 335         'usecache' => $usecache,
 336         'public' => scalar $input->param('public'),
 337       );
 338     } else {
 339       # they have chosen a new report and the area to report on
 340       $template->param(
 341           'build2' => 1,
 342           'area'   => scalar $input->param('area'),
 343           'types'  => get_report_types(),
 344           'cache_expiry' => $cache_expiry,
 345           'public' => scalar $input->param('public'),
 346       );
 347     }
 348 }
 349
 350 elsif ( $phase eq 'Choose this type' ) {
 351     # they have chosen type and area
 352     # get area and type and pass them to the template
 353     my $area = $input->param('area');
 354     my $type = $input->param('types');
 355     $template->param(
 356         'build3' => 1,
 357         'area'   => $area,
 358         'type'   => $type,
 359         columns  => get_columns($area,$input),
 360         'cache_expiry' => scalar $input->param('cache_expiry'),
 361         'public' => scalar $input->param('public'),
 362     );
 363 }
 364
 365 elsif ( $phase eq 'Choose these columns' ) {
 366     # we now know type, area, and columns
 367     # next step is the constraints
 368     my $area    = $input->param('area');
 369     my $type    = $input->param('type');
 370     my @columns = $input->multi_param('columns');
 371     my $column  = join( ',', @columns );
 372
 373     $template->param(
 374         'build4' => 1,
 375         'area'   => $area,
 376         'type'   => $type,
 377         'column' => $column,
 378         definitions => get_from_dictionary($area),
 379         criteria    => get_criteria($area,$input),
 380         'public' => scalar $input->param('public'),
 381     );
 382     if ( $usecache ) {
 383         $template->param(
 384             cache_expiry => scalar $input->param('cache_expiry'),
 385             cache_expiry_units => scalar $input->param('cache_expiry_units'),
 386         );
 387     }
 388
 389 }
 390
 391 elsif ( $phase eq 'Choose these criteria' ) {
 392     my $area     = $input->param('area');
 393     my $type     = $input->param('type');
 394     my $column   = $input->param('column');
 395     my @definitions = $input->multi_param('definition');
 396     my $definition = join (',',@definitions);
 397     my @criteria = $input->multi_param('criteria_column');
 398     my $query_criteria;
 399     foreach my $crit (@criteria) {
 400         my $value = $input->param( $crit . "_value" );
 401
 402         # If value is not defined, then it may be range values
 403         if (!defined $value) {
 404
 405             my $fromvalue = $input->param( "from_" . $crit . "_value" );
 406             my $tovalue   = $input->param( "to_"   . $crit . "_value" );
 407
 408             # If the range values are dates
 409             my $fromvalue_dt;
 410             $fromvalue_dt = eval { dt_from_string( $fromvalue ); } if ( $fromvalue );
 411             my $tovalue_dt;
 412             $tovalue_dt = eval { dt_from_string( $tovalue ); } if ($tovalue);
 413             if ( $fromvalue_dt && $tovalue_dt ) {
 414                 $fromvalue = output_pref( { dt => dt_from_string( $fromvalue_dt ), dateonly => 1, dateformat => 'iso' } );
 415                 $tovalue   = output_pref( { dt => dt_from_string( $tovalue_dt ), dateonly => 1, dateformat => 'iso' } );
 416             }
 417
 418             if ($fromvalue && $tovalue) {
 419                 $query_criteria .= " AND $crit >= '$fromvalue' AND $crit <= '$tovalue'";
 420             }
 421
 422         } else {
 423
 424             # If value is a date
 425             my $value_dt;
 426             $value_dt  =  eval { dt_from_string( $value ); } if ( $value );
 427             if ( $value_dt ) {
 428                 $value = output_pref( { dt => dt_from_string( $value_dt ), dateonly => 1, dateformat => 'iso' } );
 429             }
 430             # don't escape runtime parameters, they'll be at runtime
 431             if ($value =~ /<<.*>>/) {
 432                 $query_criteria .= " AND $crit=$value";
 433             } else {
 434                 $query_criteria .= " AND $crit='$value'";
 435             }
 436         }
 437     }
 438     $template->param(
 439         'build5'         => 1,
 440         'area'           => $area,
 441         'type'           => $type,
 442         'column'         => $column,
 443         'definition'     => $definition,
 444         'criteriastring' => $query_criteria,
 445         'public' => scalar $input->param('public'),
 446     );
 447     if ( $usecache ) {
 448         $template->param(
 449             cache_expiry => scalar $input->param('cache_expiry'),
 450             cache_expiry_units => scalar $input->param('cache_expiry_units'),
 451         );
 452     }
 453
 454     # get columns
 455     my @columns = split( ',', $column );
 456     my @total_by;
 457
 458     # build structue for use by tmpl_loop to choose columns to order by
 459     # need to do something about the order of the order :)
 460         # we also want to use the %columns hash to get the plain english names
 461     foreach my $col (@columns) {
 462         my %total = (name => $col);
 463         my @selects = map {+{ value => $_ }} (qw(sum min max avg count));
 464         $total{'select'} = \@selects;
 465         push @total_by, \%total;
 466     }
 467
 468     $template->param( 'total_by' => \@total_by );
 469 }
 470
 471 elsif ( $phase eq 'Choose these operations' ) {
 472     my $area     = $input->param('area');
 473     my $type     = $input->param('type');
 474     my $column   = $input->param('column');
 475     my $criteria = $input->param('criteria');
 476         my $definition = $input->param('definition');
 477     my @total_by = $input->multi_param('total_by');
 478     my $totals;
 479     foreach my $total (@total_by) {
 480         my $value = $input->param( $total . "_tvalue" );
 481         $totals .= "$value($total),";
 482     }
 483
 484     $template->param(
 485         'build6'         => 1,
 486         'area'           => $area,
 487         'type'           => $type,
 488         'column'         => $column,
 489         'criteriastring' => $criteria,
 490         'totals'         => $totals,
 491         'definition'     => $definition,
 492         'cache_expiry' => scalar $input->param('cache_expiry'),
 493         'public' => scalar $input->param('public'),
 494     );
 495
 496     # get columns
 497     my @columns = split( ',', $column );
 498     my @order_by;
 499
 500     # build structue for use by tmpl_loop to choose columns to order by
 501     # need to do something about the order of the order :)
 502     foreach my $col (@columns) {
 503         my %order = (name => $col);
 504         my @selects = map {+{ value => $_ }} (qw(asc desc));
 505         $order{'select'} = \@selects;
 506         push @order_by, \%order;
 507     }
 508
 509     $template->param( 'order_by' => \@order_by );
 510 }
 511
 512 elsif ( $phase eq 'Build report' ) {
 513
 514     # now we have all the info we need and can build the sql
 515     my $area     = $input->param('area');
 516     my $type     = $input->param('type');
 517     my $column   = $input->param('column');
 518     my $crit     = $input->param('criteria');
 519     my $totals   = $input->param('totals');
 520     my $definition = $input->param('definition');
 521     my $query_criteria=$crit;
 522     # split the columns up by ,
 523     my @columns = split( ',', $column );
 524     my @order_by = $input->multi_param('order_by');
 525
 526     my $query_orderby;
 527     foreach my $order (@order_by) {
 528         my $value = $input->param( $order . "_ovalue" );
 529         if ($query_orderby) {
 530             $query_orderby .= ",$order $value";
 531         }
 532         else {
 533             $query_orderby = " ORDER BY $order $value";
 534         }
 535     }
 536
 537     # get the sql
 538     my $sql =
 539       build_query( \@columns, $query_criteria, $query_orderby, $area, $totals, $definition );
 540     $template->param(
 541         'showreport' => 1,
 542         'area'       => $area,
 543         'sql'        => $sql,
 544         'type'       => $type,
 545         'cache_expiry' => scalar $input->param('cache_expiry'),
 546         'public' => scalar $input->param('public'),
 547     );
 548 }
 549
 550 elsif ( $phase eq 'Save' ) {
 551     # Save the report that has just been built
 552     my $area = $input->param('area');
 553     my $sql  = $input->param('sql');
 554     my $type = $input->param('type');
 555     $template->param(
 556         'save' => 1,
 557         'area'  => $area,
 558         'sql'  => $sql,
 559         'type' => $type,
 560         'cache_expiry' => scalar $input->param('cache_expiry'),
 561         'public' => scalar $input->param('public'),
 562         'groups_with_subgroups' => groups_with_subgroups($area), # in case we have a report group that matches area
 563     );
 564 }
 565
 566 elsif ( $phase eq 'Save Report' ) {
 567     # save the sql pasted in by a user
 568     my $area  = $input->param('area');
 569     my $group = $input->param('group');
 570     my $subgroup = $input->param('subgroup');
 571     my $sql   = $input->param('sql');
 572     my $name  = $input->param('reportname');
 573     my $type  = $input->param('types');
 574     my $notes = $input->param('notes');
 575     my $cache_expiry = $input->param('cache_expiry');
 576     my $cache_expiry_units = $input->param('cache_expiry_units');
 577     my $public = $input->param('public');
 578     my $save_anyway = $input->param('save_anyway');
 579
 580
 581     # if we have the units, then we came from creating a report from SQL and thus need to handle converting units
 582     if( $cache_expiry_units ){
 583       if( $cache_expiry_units eq "minutes" ){
 584         $cache_expiry *= 60;
 585       } elsif( $cache_expiry_units eq "hours" ){
 586         $cache_expiry *= 3600; # 60 * 60
 587       } elsif( $cache_expiry_units eq "days" ){
 588         $cache_expiry *= 86400; # 60 * 60 * 24
 589       }
 590     }
 591     # 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
 592     if( $cache_expiry && $cache_expiry >= 2592000 ){
 593       push @errors, {cache_expiry => $cache_expiry};
 594     }
 595
 596     create_non_existing_group_and_subgroup($input, $group, $subgroup);
 597     ## FIXME this is AFTER entering a name to save the report under
 598     my ( $is_sql_valid, $validation_errors ) = Koha::Report->new({ savedsql => $sql })->is_sql_valid;
 599     push(@errors, @$validation_errors) unless $is_sql_valid;
 600
 601     if (@errors) {
 602         $template->param(
 603             'errors'    => \@errors,
 604             'sql'       => $sql,
 605             'reportname'=> $name,
 606             'type'      => $type,
 607             'notes'     => $notes,
 608             'cache_expiry' => $cache_expiry,
 609             'public'    => $public,
 610         );
 611     } else {
 612         # Check defined SQL parameters for authorised value validity
 613         my $problematic_authvals = ValidateSQLParameters($sql);
 614
 615         if ( scalar @$problematic_authvals > 0 && not $save_anyway ) {
 616             # There's at least one problematic parameter, report to the
 617             # GUI and provide all user input for further actions
 618             $template->param(
 619                 'area' => $area,
 620                 'group' =>  $group,
 621                 'subgroup' => $subgroup,
 622                 'sql' => $sql,
 623                 'reportname' => $name,
 624                 'type' => $type,
 625                 'notes' => $notes,
 626                 'public' => $public,
 627                 'problematic_authvals' => $problematic_authvals,
 628                 'warn_authval_problem' => 1,
 629                 'phase_save' => 1
 630             );
 631             if ( $usecache ) {
 632                 $template->param(
 633                     cache_expiry => $cache_expiry,
 634                     cache_expiry_units => $cache_expiry_units,
 635                 );
 636             }
 637         } else {
 638             # No params problem found or asked to save anyway
 639             my $id = save_report( {
 640                     borrowernumber => $borrowernumber,
 641                     sql            => $sql,
 642                     name           => $name,
 643                     area           => $area,
 644                     group          => $group,
 645                     subgroup       => $subgroup,
 646                     type           => $type,
 647                     notes          => $notes,
 648                     cache_expiry   => $cache_expiry,
 649                     public         => $public,
 650                 } );
 651                 logaction( "REPORTS", "ADD", $id, "$name | $sql" ) if C4::Context->preference("ReportsLog");
 652             $template->param(
 653                 'save_successful' => 1,
 654                 'reportname'      => $name,
 655                 'id'              => $id,
 656                 'editsql'         => 1,
 657                 'sql'             => $sql,
 658                 'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
 659                 'notes'      => $notes,
 660                 'cache_expiry' => $cache_expiry,
 661                 'public' => $public,
 662                 'usecache' => $usecache,
 663             );
 664         }
 665     }
 666 }
 667
 668 elsif ($phase eq 'Share'){
 669     my $lang = $input->param('mana_language') || '';
 670     my $reportid = $input->param('reportid');
 671     my $result = Koha::SharedContent::send_entity($lang, $borrowernumber, $reportid, 'report');
 672     if ( $result ) {
 673         print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved&manamsg=".$result->{msg});
 674     }else{
 675         print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved&manamsg=noanswer");
 676     }
 677 }
 678 elsif ($phase eq 'Run this report'){
 679     # execute a saved report
 680     my $limit      = $input->param('limit') || 20;
 681     my $offset     = 0;
 682     my $report_id  = $input->param('reports');
 683     my @sql_params = $input->multi_param('sql_params');
 684     my @param_names = $input->multi_param('param_name');
 685     my $want_full_chart = $input->param('want_full_chart') || 0;
 686
 687     # offset algorithm
 688     if ($input->param('page')) {
 689         $offset = ($input->param('page') - 1) * $limit;
 690     }
 691
 692     $template->param(
 693         'limit'   => $limit,
 694         'report_id' => $report_id,
 695     );
 696
 697     my ( $sql, $original_sql, $type, $name, $notes );
 698     if (my $report = Koha::Reports->find($report_id)) {
 699         $sql   = $original_sql = $report->savedsql;
 700         $name  = $report->report_name;
 701         $notes = $report->notes;
 702
 703         my @rows = ();
 704         my @allrows = ();
 705         # if we have at least 1 parameter, and it's not filled, then don't execute but ask for parameters
 706         if ($sql =~ /<</ && !@sql_params) {
 707             # split on ??. Each odd (2,4,6,...) entry should be a parameter to fill
 708             my @split = split /<<|>>/,$sql;
 709             my @tmpl_parameters;
 710             my @authval_errors;
 711             my %uniq_params;
 712             for(my $i=0;$i<($#split/2);$i++) {
 713                 my ($text,$authorised_value_all) = split /\|/,$split[$i*2+1];
 714                 my $sep = $authorised_value_all ? "|" : "";
 715                 if( defined $uniq_params{$text.$sep.$authorised_value_all} ){
 716                     next;
 717                 } else { $uniq_params{$text.$sep.$authorised_value_all} = "$i"; }
 718                 my ($authorised_value, $all) = split /:/, $authorised_value_all;
 719                 my $input;
 720                 my $labelid;
 721                 if ( not defined $authorised_value ) {
 722                     # no authorised value input, provide a text box
 723                     $input = "text";
 724                 } elsif ( $authorised_value eq "date" ) {
 725                     # require a date, provide a date picker
 726                     $input = 'date';
 727                 } elsif ( $authorised_value eq "list" ) {
 728                     # require a list, provide a textarea
 729                     $input = 'textarea';
 730                 } else {
 731                     # defined $authorised_value, and not 'date'
 732                     my $dbh=C4::Context->dbh;
 733                     my @authorised_values;
 734                     my %authorised_lib;
 735                     # builds list, depending on authorised value...
 736                     if ( $authorised_value eq "branches" ) {
 737                         my $libraries = Koha::Libraries->search( {}, { order_by => ['branchname'] } );
 738                         while ( my $library = $libraries->next ) {
 739                             push @authorised_values, $library->branchcode;
 740                             $authorised_lib{$library->branchcode} = $library->branchname;
 741                         }
 742                     }
 743                     elsif ( $authorised_value eq "itemtypes" ) {
 744                         my $sth = $dbh->prepare("SELECT itemtype,description FROM itemtypes ORDER BY description");
 745                         $sth->execute;
 746                         while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
 747                             push @authorised_values, $itemtype;
 748                             $authorised_lib{$itemtype} = $description;
 749                         }
 750                     }
 751                     elsif ( $authorised_value eq "biblio_framework" ) {
 752                         my @frameworks = Koha::BiblioFrameworks->search({}, { order_by => ['frameworktext'] })->as_list;
 753                         my $default_source = '';
 754                         push @authorised_values,$default_source;
 755                         $authorised_lib{$default_source} = 'Default';
 756                         foreach my $framework (@frameworks) {
 757                             push @authorised_values, $framework->frameworkcode;
 758                             $authorised_lib{$framework->frameworkcode} = $framework->frameworktext;
 759                         }
 760                     }
 761                     elsif ( $authorised_value eq "cn_source" ) {
 762                         my $class_sources = GetClassSources();
 763                         my $default_source = C4::Context->preference("DefaultClassificationSource");
 764                         foreach my $class_source (sort keys %$class_sources) {
 765                             next unless $class_sources->{$class_source}->{'used'} or
 766                                         ($class_source eq $default_source);
 767                             push @authorised_values, $class_source;
 768                             $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
 769                         }
 770                     }
 771                     elsif ( $authorised_value eq "categorycode" ) {
 772                         my @patron_categories = Koha::Patron::Categories->search({}, { order_by => ['description']})->as_list;
 773                         %authorised_lib = map { $_->categorycode => $_->description } @patron_categories;
 774                         push @authorised_values, $_->categorycode for @patron_categories;
 775                     }
 776                     elsif ( $authorised_value eq "cash_registers" ) {
 777                         my $sth = $dbh->prepare("SELECT id, name FROM cash_registers ORDER BY description");
 778                         $sth->execute;
 779                         while ( my ( $id, $name ) = $sth->fetchrow_array ) {
 780                             push @authorised_values, $id;
 781                             $authorised_lib{$id} = $name;
 782                         }
 783                     }
 784                     elsif ( $authorised_value eq "debit_types" ) {
 785                         my $sth = $dbh->prepare("SELECT code, description FROM account_debit_types ORDER BY code");
 786                         $sth->execute;
 787                         while ( my ( $code, $description ) = $sth->fetchrow_array ) {
 788                            push @authorised_values, $code;
 789                            $authorised_lib{$code} = $description;
 790                         }
 791                     }
 792                     elsif ( $authorised_value eq "credit_types" ) {
 793                         my $sth = $dbh->prepare("SELECT code, description FROM account_credit_types ORDER BY code");
 794                         $sth->execute;
 795                         while ( my ( $code, $description ) = $sth->fetchrow_array ) {
 796                            push @authorised_values, $code;
 797                            $authorised_lib{$code} = $description;
 798                         }
 799                     }
 800                     else {
 801                         if ( Koha::AuthorisedValues->search({ category => $authorised_value })->count ) {
 802                             my $query = '
 803                             SELECT authorised_value,lib
 804                             FROM authorised_values
 805                             WHERE category=?
 806                             ORDER BY lib
 807                             ';
 808                             my $authorised_values_sth = $dbh->prepare($query);
 809                             $authorised_values_sth->execute( $authorised_value);
 810
 811                             while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
 812                                 push @authorised_values, $value;
 813                                 $authorised_lib{$value} = $lib;
 814                                 # For item location, we show the code and the libelle
 815                                 $authorised_lib{$value} = $lib;
 816                             }
 817                         } else {
 818                             # not exists $authorised_value_categories{$authorised_value})
 819                             push @authval_errors, {'entry' => $text,
 820                                                    'auth_val' => $authorised_value };
 821                             # tell the template there's an error
 822                             $template->param( auth_val_error => 1 );
 823                             # skip scrolling list creation and params push
 824                             next;
 825                         }
 826                     }
 827                     $labelid = $text;
 828                     $labelid =~ s/\W//g;
 829                     $input = {
 830                         name    => "sql_params",
 831                         id      => "sql_params_".$labelid,
 832                         values  => \@authorised_values,
 833                         labels  => \%authorised_lib,
 834                     };
 835                 }
 836
 837                 push @tmpl_parameters, {'entry' => $text, 'input' => $input, 'labelid' => $labelid, 'name' => $text.$sep.$authorised_value_all, 'include_all' => $all };
 838             }
 839             $template->param('sql'         => $sql,
 840                             'name'         => $name,
 841                             'sql_params'   => \@tmpl_parameters,
 842                             'auth_val_errors'  => \@authval_errors,
 843                             'enter_params' => 1,
 844                             'reports'      => $report_id,
 845                             );
 846         } else {
 847             my ($sql,$header_types) = $report->prep_report( \@param_names, \@sql_params );
 848             $template->param(header_types => $header_types);
 849             my ( $sth, $errors ) = execute_query(
 850                 {
 851                     sql        => $sql,
 852                     offset     => $offset,
 853                     limit      => $limit,
 854                     report_id  => $report_id,
 855                 }
 856             );
 857             my $total;
 858             if (!$sth) {
 859                 die "execute_query failed to return sth for report $report_id: $sql";
 860             } elsif ( !$errors ) {
 861                 $total = nb_rows($sql) || 0;
 862                 my $headers = header_cell_loop($sth);
 863                 $template->param(header_row => $headers);
 864                 while (my $row = $sth->fetchrow_arrayref()) {
 865                     my @cells = map { +{ cell => $_ } } @$row;
 866                     push @rows, { cells => \@cells };
 867                 }
 868                 if( $want_full_chart ){
 869                     my ( $sth2, $errors2 ) = execute_query( { sql => $sql, report_id => $report_id } );
 870                     while (my $row = $sth2->fetchrow_arrayref()) {
 871                         my @cells = map { +{ cell => $_ } } @$row;
 872                         push @allrows, { cells => \@cells };
 873                     }
 874                 }
 875
 876                 my $totpages = int($total/$limit) + (($total % $limit) > 0 ? 1 : 0);
 877                 my $url = "/cgi-bin/koha/reports/guided_reports.pl?reports=$report_id&amp;phase=Run%20this%20report&amp;limit=$limit&amp;want_full_chart=$want_full_chart";
 878                 if (@param_names) {
 879                     $url = join('&amp;param_name=', $url, map { URI::Escape::uri_escape_utf8($_) } @param_names);
 880                 }
 881                 if (@sql_params) {
 882                     $url = join('&amp;sql_params=', $url, map { URI::Escape::uri_escape_utf8($_) } @sql_params);
 883                 }
 884
 885                 $template->param(
 886                     'results'        => \@rows,
 887                     'allresults'     => \@allrows,
 888                     'pagination_bar' => pagination_bar($url, $totpages, scalar $input->param('page')),
 889                     'unlimited_total' => $total,
 890                 );
 891             }
 892             $template->param(
 893                 'sql'         => $sql,
 894                 original_sql  => $original_sql,
 895                 'id'          => $report_id,
 896                 'execute'     => 1,
 897                 'name'        => $name,
 898                 'notes'       => $notes,
 899                 'errors'      => defined($errors) ? [$errors] : undef,
 900                 'sql_params'  => \@sql_params,
 901                 'param_names' => \@param_names,
 902             );
 903         }
 904     }
 905     else {
 906         push @errors, { no_sql_for_id => $report_id };
 907     }
 908 }
 909
 910 elsif ($phase eq 'Export'){
 911
 912         # export results to tab separated text or CSV
 913     my $report_id      = $input->param('report_id');
 914     my $report         = Koha::Reports->find($report_id);
 915     my $sql            = $report->savedsql;
 916     my @param_names    = $input->multi_param('param_name');
 917     my @sql_params     = $input->multi_param('sql_params');
 918     my $format         = $input->param('format');
 919     my $reportname     = $input->param('reportname');
 920     my $reportfilename = $reportname ? "$reportname-reportresults.$format" : "reportresults.$format" ;
 921
 922     ($sql, undef) = $report->prep_report( \@param_names, \@sql_params );
 923     my ( $sth, $q_errors ) = execute_query( { sql => $sql, report_id => $report_id } );
 924     unless ($q_errors and @$q_errors) {
 925         my ( $type, $content );
 926         if ($format eq 'tab') {
 927             $type = 'application/octet-stream';
 928             $content .= join("\t", header_cell_values($sth)) . "\n";
 929             $content = Encode::decode('UTF-8', $content);
 930             while (my $row = $sth->fetchrow_arrayref()) {
 931                 $content .= join("\t", map { $_ // '' } @$row) . "\n";
 932             }
 933         } else {
 934             my $delimiter = C4::Context->preference('CSVDelimiter') || ',';
 935             if ( $format eq 'csv' ) {
 936                 $delimiter = "\t" if $delimiter eq 'tabulation';
 937                 $type = 'application/csv';
 938                 my $csv = Text::CSV::Encoded->new({ encoding_out => 'UTF-8', sep_char => $delimiter});
 939                 $csv or die "Text::CSV::Encoded->new({binary => 1}) FAILED: " . Text::CSV::Encoded->error_diag();
 940                 if ($csv->combine(header_cell_values($sth))) {
 941                     $content .= Encode::decode('UTF-8', $csv->string()) . "\n";
 942                 } else {
 943                     push @$q_errors, { combine => 'HEADER ROW: ' . $csv->error_diag() } ;
 944                 }
 945                 while (my $row = $sth->fetchrow_arrayref()) {
 946                     if ($csv->combine(@$row)) {
 947                         $content .= $csv->string() . "\n";
 948                     } else {
 949                         push @$q_errors, { combine => $csv->error_diag() } ;
 950                     }
 951                 }
 952             }
 953             elsif ( $format eq 'ods' ) {
 954                 $type = 'application/vnd.oasis.opendocument.spreadsheet';
 955                 my $ods_fh = File::Temp->new( UNLINK => 0 );
 956                 my $ods_filepath = $ods_fh->filename;
 957                 my $ods_content;
 958
 959                 # First line is headers
 960                 my @headers = header_cell_values($sth);
 961                 push @$ods_content, \@headers;
 962
 963                 # Other line in Unicode
 964                 my $sql_rows = $sth->fetchall_arrayref();
 965                 foreach my $sql_row ( @$sql_rows ) {
 966                     my @content_row;
 967                     foreach my $sql_cell ( @$sql_row ) {
 968                         push @content_row, Encode::encode( 'UTF8', $sql_cell );
 969                     }
 970                     push @$ods_content, \@content_row;
 971                 }
 972
 973                 # Process
 974                 generate_ods($ods_filepath, $ods_content);
 975
 976                 # Output
 977                 binmode(STDOUT);
 978                 open $ods_fh, '<', $ods_filepath;
 979                 $content .= $_ while <$ods_fh>;
 980                 unlink $ods_filepath;
 981             }
 982         }
 983         print $input->header(
 984             -type => $type,
 985             -attachment=> $reportfilename
 986         );
 987         print $content;
 988
 989         foreach my $err (@$q_errors, @errors) {
 990             print "# ERROR: " . (map {$_ . ": " . $err->{$_}} keys %$err) . "\n";
 991         }   # here we print all the non-fatal errors at the end.  Not super smooth, but better than nothing.
 992         exit;
 993     }
 994     $template->param(
 995         'sql'           => $sql,
 996         'execute'       => 1,
 997         'name'          => 'Error exporting report!',
 998         'notes'         => '',
 999         'errors'        => $q_errors,
1000     );
1001 }
1002
1003 elsif ( $phase eq 'Create report from SQL' || $phase eq 'Create report from existing' ) {
1004
1005     my ($group, $subgroup, $sql, $reportname, $notes);
1006     if ( $input->param('sql') ) {
1007         $group      = $input->param('report_group');
1008         $subgroup   = $input->param('report_subgroup');
1009         $sql        = $input->param('sql') // '';
1010         $reportname = $input->param('reportname') // '';
1011         $notes      = $input->param('notes') // '';
1012     }
1013     elsif ( my $report_id = $input->param('report_id') ) {
1014         my $report = Koha::Reports->find($report_id);
1015         $group      = $report->report_group;
1016         $subgroup   = $report->report_subgroup;
1017         $sql        = $report->savedsql // '';
1018         $reportname = $report->report_name // '';
1019         $notes      = $report->notes // '';
1020     }
1021
1022     $template->param(
1023         sql        => $sql,
1024         reportname => $reportname,
1025         notes      => $notes,
1026         'create' => 1,
1027         'groups_with_subgroups' => groups_with_subgroups($group, $subgroup),
1028         'public' => '0',
1029         'cache_expiry' => 300,
1030         'usecache' => $usecache,
1031
1032     );
1033 }
1034
1035 # pass $sth, get back an array of names for the column headers
1036 sub header_cell_values {
1037     my $sth = shift or return ();
1038     return '' unless ($sth->{NAME});
1039     return @{$sth->{NAME}};
1040 }
1041
1042 # pass $sth, get back a TMPL_LOOP-able set of names for the column headers
1043 sub header_cell_loop {
1044     my @headers = map { +{ cell => decode('UTF-8',$_) } } header_cell_values (shift);
1045     return \@headers;
1046 }
1047
1048 foreach (1..6) {
1049      $template->{VARS}->{'build' . $_} and last;
1050 }
1051 $template->param(   'referer' => $input->referer(),
1052                 );
1053
1054 output_html_with_http_headers $input, $cookie, $template->output;
1055
1056 sub groups_with_subgroups {
1057     my ($group, $subgroup) = @_;
1058
1059     my $groups_with_subgroups = get_report_groups();
1060     my @g_sg;
1061     my @sorted_keys = sort {
1062         $groups_with_subgroups->{$a}->{name} cmp $groups_with_subgroups->{$b}->{name}
1063     } keys %$groups_with_subgroups;
1064     foreach my $g_id (@sorted_keys) {
1065         my $v = $groups_with_subgroups->{$g_id};
1066         my @subgroups;
1067         if (my $sg = $v->{subgroups}) {
1068             foreach my $sg_id (sort { $sg->{$a} cmp $sg->{$b} } keys %$sg) {
1069                 push @subgroups, {
1070                     id => $sg_id,
1071                     name => $sg->{$sg_id},
1072                     selected => ($group && $g_id eq $group && $subgroup && $sg_id eq $subgroup ),
1073                 };
1074             }
1075         }
1076         push @g_sg, {
1077             id => $g_id,
1078             name => $v->{name},
1079             selected => ($group && $g_id eq $group),
1080             subgroups => \@subgroups,
1081         };
1082     }
1083     return \@g_sg;
1084 }
1085
1086 sub create_non_existing_group_and_subgroup {
1087     my ($input, $group, $subgroup) = @_;
1088     if (defined $group and $group ne '') {
1089         my $report_groups = C4::Reports::Guided::get_report_groups;
1090         if (not exists $report_groups->{$group}) {
1091             my $groupdesc = $input->param('groupdesc') // $group;
1092             Koha::AuthorisedValue->new({
1093                 category => 'REPORT_GROUP',
1094                 authorised_value => $group,
1095                 lib => $groupdesc,
1096             })->store;
1097             my $cache_key = "AuthorisedValues-REPORT_GROUP-0-".C4::Context->userenv->{"branch"};
1098             my $cache  = Koha::Caches->get_instance();
1099             my $result = $cache->clear_from_cache($cache_key);
1100         }
1101         if (defined $subgroup and $subgroup ne '') {
1102             if (not exists $report_groups->{$group}->{subgroups}->{$subgroup}) {
1103                 my $subgroupdesc = $input->param('subgroupdesc') // $subgroup;
1104                 Koha::AuthorisedValue->new({
1105                     category => 'REPORT_SUBGROUP',
1106                     authorised_value => $subgroup,
1107                     lib => $subgroupdesc,
1108                     lib_opac => $group,
1109                 })->store;
1110             my $cache_key = "AuthorisedValues-REPORT_SUBGROUP-0-".C4::Context->userenv->{"branch"};
1111             my $cache  = Koha::Caches->get_instance();
1112             my $result = $cache->clear_from_cache($cache_key);
1113             }
1114         }
1115     }
1116 }
1117