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