522 lines
15 KiB
Perl
Executable file
522 lines
15 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
|
|
# Copyright 2007 Liblime ltd
|
|
#
|
|
# This file is part of Koha.
|
|
#
|
|
# Koha is free software; you can redistribute it and/or modify it under the
|
|
# terms of the GNU General Public License as published by the Free Software
|
|
# Foundation; either version 2 of the License, or (at your option) any later
|
|
# version.
|
|
#
|
|
# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
|
|
# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
|
|
# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License along with
|
|
# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
|
|
# Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
use strict;
|
|
# use warnings; # FIXME
|
|
use CGI;
|
|
use Text::CSV;
|
|
use C4::Reports::Guided;
|
|
use C4::Auth;
|
|
use C4::Output;
|
|
use C4::Dates;
|
|
use C4::Debug;
|
|
|
|
=head1 NAME
|
|
|
|
guided_reports.pl
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
Script to control the guided report creation
|
|
|
|
=over2
|
|
|
|
=cut
|
|
|
|
my $input = new CGI;
|
|
|
|
my $phase = $input->param('phase');
|
|
my $flagsrequired;
|
|
if ( $phase eq 'Build new' ) {
|
|
$flagsrequired = 'create_report';
|
|
}
|
|
elsif ( $phase eq 'Use saved' ) {
|
|
$flagsrequired = 'execute_report';
|
|
} else {
|
|
$flagsrequired = '*';
|
|
}
|
|
|
|
my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
|
|
{
|
|
template_name => "reports/guided_reports_start.tmpl",
|
|
query => $input,
|
|
type => "intranet",
|
|
authnotrequired => 0,
|
|
flagsrequired => { reports => $flagsrequired },
|
|
debug => 1,
|
|
}
|
|
);
|
|
|
|
my @errors = ();
|
|
if ( !$phase ) {
|
|
$template->param( 'start' => 1 );
|
|
# show welcome page
|
|
}
|
|
elsif ( $phase eq 'Build new' ) {
|
|
# build a new report
|
|
$template->param( 'build1' => 1 );
|
|
$template->param( 'areas' => get_report_areas() );
|
|
}
|
|
elsif ( $phase eq 'Use saved' ) {
|
|
# use a saved report
|
|
# get list of reports and display them
|
|
$template->param( 'saved1' => 1 );
|
|
$template->param( 'savedreports' => get_saved_reports() );
|
|
}
|
|
|
|
elsif ( $phase eq 'Delete Saved') {
|
|
|
|
# delete a report from the saved reports list
|
|
my $id = $input->param('reports');
|
|
delete_report($id);
|
|
print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
|
|
exit;
|
|
}
|
|
|
|
elsif ( $phase eq 'Show SQL'){
|
|
|
|
my $id = $input->param('reports');
|
|
my $sql = get_sql($id);
|
|
$template->param(
|
|
'sql' => $sql,
|
|
'showsql' => 1,
|
|
);
|
|
}
|
|
|
|
elsif ( $phase eq 'Edit SQL'){
|
|
|
|
my $id = $input->param('reports');
|
|
my ($sql,$type,$reportname,$notes) = get_saved_report($id);
|
|
$template->param(
|
|
'sql' => $sql,
|
|
'reportname' => $reportname,
|
|
'notes' => $notes,
|
|
'id' => $id,
|
|
'editsql' => 1,
|
|
);
|
|
}
|
|
|
|
elsif ( $phase eq 'Update SQL'){
|
|
my $id = $input->param('id');
|
|
my $sql = $input->param('sql');
|
|
my $reportname = $input->param('reportname');
|
|
my $notes = $input->param('notes');
|
|
my @errors;
|
|
if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
|
|
push @errors, {sqlerr => $1};
|
|
}
|
|
elsif ($sql !~ /^(SELECT)/i) {
|
|
push @errors, {queryerr => 1};
|
|
}
|
|
if (@errors) {
|
|
$template->param(
|
|
'errors' => \@errors,
|
|
'sql' => $sql,
|
|
);
|
|
}
|
|
else {
|
|
update_sql( $id, $sql, $reportname, $notes );
|
|
$template->param(
|
|
'save_successful' => 1,
|
|
);
|
|
}
|
|
|
|
}
|
|
|
|
elsif ($phase eq 'retrieve results') {
|
|
my $id = $input->param('id');
|
|
my ($results,$name,$notes) = format_results($id);
|
|
# do something
|
|
$template->param(
|
|
'retresults' => 1,
|
|
'results' => $results,
|
|
'name' => $name,
|
|
'notes' => $notes,
|
|
);
|
|
}
|
|
|
|
elsif ( $phase eq 'Report on this Area' ) {
|
|
|
|
# they have choosen a new report and the area to report on
|
|
$template->param(
|
|
'build2' => 1,
|
|
'area' => $input->param('areas'),
|
|
'types' => get_report_types(),
|
|
);
|
|
}
|
|
|
|
elsif ( $phase eq 'Choose this type' ) {
|
|
|
|
# they have chosen type and area
|
|
# get area and type and pass them to the template
|
|
my $area = $input->param('area');
|
|
my $type = $input->param('types');
|
|
$template->param(
|
|
'build3' => 1,
|
|
'area' => $area,
|
|
'type' => $type,
|
|
columns => get_columns($area,$input),
|
|
);
|
|
}
|
|
|
|
elsif ( $phase eq 'Choose these columns' ) {
|
|
|
|
# we now know type, area, and columns
|
|
# next step is the constraints
|
|
my $area = $input->param('area');
|
|
my $type = $input->param('type');
|
|
my @columns = $input->param('columns');
|
|
my $column = join( ',', @columns );
|
|
$template->param(
|
|
'build4' => 1,
|
|
'area' => $area,
|
|
'type' => $type,
|
|
'column' => $column,
|
|
definitions => get_from_dictionary($area),
|
|
criteria => get_criteria($area,$input),
|
|
);
|
|
}
|
|
|
|
elsif ( $phase eq 'Choose these criteria' ) {
|
|
my $area = $input->param('area');
|
|
my $type = $input->param('type');
|
|
my $column = $input->param('column');
|
|
my @definitions = $input->param('definition');
|
|
my $definition = join (',',@definitions);
|
|
my @criteria = $input->param('criteria_column');
|
|
my $query_criteria;
|
|
foreach my $crit (@criteria) {
|
|
my $value = $input->param( $crit . "_value" );
|
|
|
|
# If value is not defined, then it may be range values
|
|
if (!$value) {
|
|
|
|
my $fromvalue = $input->param( "from_" . $crit . "_value" );
|
|
my $tovalue = $input->param( "to_" . $crit . "_value" );
|
|
|
|
# If the range values are dates
|
|
if ($fromvalue =~ C4::Dates->regexp('syspref') && $tovalue =~ C4::Dates->regexp('syspref')) {
|
|
$fromvalue = C4::Dates->new($fromvalue)->output("iso");
|
|
$tovalue = C4::Dates->new($tovalue)->output("iso");
|
|
}
|
|
|
|
if ($fromvalue && $tovalue) {
|
|
$query_criteria .= " AND $crit >= '$fromvalue' AND $crit <= '$tovalue'";
|
|
}
|
|
|
|
} else {
|
|
|
|
# If value is a date
|
|
if ($value =~ C4::Dates->regexp('syspref')) {
|
|
$value = C4::Dates->new($value)->output("iso");
|
|
}
|
|
$query_criteria .= " AND $crit='$value'";
|
|
}
|
|
warn $query_criteria;
|
|
}
|
|
|
|
$template->param(
|
|
'build5' => 1,
|
|
'area' => $area,
|
|
'type' => $type,
|
|
'column' => $column,
|
|
'definition' => $definition,
|
|
'criteriastring' => $query_criteria,
|
|
);
|
|
|
|
# get columns
|
|
my @columns = split( ',', $column );
|
|
my @total_by;
|
|
|
|
# build structue for use by tmpl_loop to choose columns to order by
|
|
# need to do something about the order of the order :)
|
|
# we also want to use the %columns hash to get the plain english names
|
|
foreach my $col (@columns) {
|
|
my %total = (name => $col);
|
|
my @selects = map {+{ value => $_ }} (qw(sum min max avg count));
|
|
$total{'select'} = \@selects;
|
|
push @total_by, \%total;
|
|
}
|
|
|
|
$template->param( 'total_by' => \@total_by );
|
|
}
|
|
|
|
elsif ( $phase eq 'Choose These Operations' ) {
|
|
my $area = $input->param('area');
|
|
my $type = $input->param('type');
|
|
my $column = $input->param('column');
|
|
my $criteria = $input->param('criteria');
|
|
my $definition = $input->param('definition');
|
|
my @total_by = $input->param('total_by');
|
|
my $totals;
|
|
foreach my $total (@total_by) {
|
|
my $value = $input->param( $total . "_tvalue" );
|
|
$totals .= "$value($total),";
|
|
}
|
|
|
|
$template->param(
|
|
'build6' => 1,
|
|
'area' => $area,
|
|
'type' => $type,
|
|
'column' => $column,
|
|
'criteriastring' => $criteria,
|
|
'totals' => $totals,
|
|
'definition' => $definition,
|
|
);
|
|
|
|
# get columns
|
|
my @columns = split( ',', $column );
|
|
my @order_by;
|
|
|
|
# build structue for use by tmpl_loop to choose columns to order by
|
|
# need to do something about the order of the order :)
|
|
foreach my $col (@columns) {
|
|
my %order = (name => $col);
|
|
my @selects = map {+{ value => $_ }} (qw(asc desc));
|
|
$order{'select'} = \@selects;
|
|
push @order_by, \%order;
|
|
}
|
|
|
|
$template->param( 'order_by' => \@order_by );
|
|
}
|
|
|
|
elsif ( $phase eq 'Build Report' ) {
|
|
|
|
# now we have all the info we need and can build the sql
|
|
my $area = $input->param('area');
|
|
my $type = $input->param('type');
|
|
my $column = $input->param('column');
|
|
my $crit = $input->param('criteria');
|
|
my $totals = $input->param('totals');
|
|
my $definition = $input->param('definition');
|
|
# my @criteria = split( ',', $crit );
|
|
my $query_criteria=$crit;
|
|
# split the columns up by ,
|
|
my @columns = split( ',', $column );
|
|
my @order_by = $input->param('order_by');
|
|
|
|
my $query_orderby;
|
|
foreach my $order (@order_by) {
|
|
my $value = $input->param( $order . "_ovalue" );
|
|
if ($query_orderby) {
|
|
$query_orderby .= ",$order $value";
|
|
}
|
|
else {
|
|
$query_orderby = " ORDER BY $order $value";
|
|
}
|
|
}
|
|
|
|
# get the sql
|
|
my $sql =
|
|
build_query( \@columns, $query_criteria, $query_orderby, $area, $totals, $definition );
|
|
$template->param(
|
|
'showreport' => 1,
|
|
'sql' => $sql,
|
|
'type' => $type
|
|
);
|
|
}
|
|
|
|
elsif ( $phase eq 'Save' ) {
|
|
# Save the report that has just been built
|
|
my $sql = $input->param('sql');
|
|
my $type = $input->param('type');
|
|
$template->param(
|
|
'save' => 1,
|
|
'sql' => $sql,
|
|
'type' => $type
|
|
);
|
|
}
|
|
|
|
elsif ( $phase eq 'Save Report' ) {
|
|
# save the sql pasted in by a user
|
|
my $sql = $input->param('sql');
|
|
my $name = $input->param('reportname');
|
|
my $type = $input->param('types');
|
|
my $notes = $input->param('notes');
|
|
if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
|
|
push @errors, {sqlerr => $1};
|
|
}
|
|
elsif ($sql !~ /^(SELECT)/i) {
|
|
push @errors, {queryerr => 1};
|
|
}
|
|
if (@errors) {
|
|
$template->param(
|
|
'errors' => \@errors,
|
|
'sql' => $sql,
|
|
'reportname'=> $name,
|
|
'type' => $type,
|
|
'notes' => $notes,
|
|
);
|
|
}
|
|
else {
|
|
save_report( $borrowernumber, $sql, $name, $type, $notes );
|
|
$template->param(
|
|
'save_successful' => 1,
|
|
);
|
|
}
|
|
}
|
|
|
|
elsif ($phase eq 'Run this report'){
|
|
# execute a saved report
|
|
my $limit = 20; # page size. # TODO: move to DB or syspref?
|
|
my $offset = 0;
|
|
my $report = $input->param('reports');
|
|
# offset algorithm
|
|
if ($input->param('page')) {
|
|
$offset = ($input->param('page') - 1) * $limit;
|
|
}
|
|
my ($sql,$type,$name,$notes) = get_saved_report($report);
|
|
unless ($sql) {
|
|
push @errors, {no_sql_for_id=>$report};
|
|
}
|
|
my @rows = ();
|
|
my ($sth, $errors) = execute_query($sql, $offset, $limit);
|
|
my $total = select_2_select_count_value($sql) || 0;
|
|
unless ($sth) {
|
|
die "execute_query failed to return sth for report $report: $sql";
|
|
} else {
|
|
my $headref = $sth->{NAME} || [];
|
|
my @headers = map { +{ cell => $_ } } @$headref;
|
|
$template->param(header_row => \@headers);
|
|
while (my $row = $sth->fetchrow_arrayref()) {
|
|
my @cells = map { +{ cell => $_ } } @$row;
|
|
push @rows, { cells => \@cells };
|
|
}
|
|
}
|
|
|
|
my $totpages = int($total/$limit) + (($total % $limit) > 0 ? 1 : 0);
|
|
my $url = "/cgi-bin/koha/reports/guided_reports.pl?reports=$report&phase=Run%20this%20report";
|
|
$template->param(
|
|
'results' => \@rows,
|
|
'sql' => $sql,
|
|
'execute' => 1,
|
|
'name' => $name,
|
|
'notes' => $notes,
|
|
'errors' => $errors,
|
|
'pagination_bar' => pagination_bar($url, $totpages, $input->param('page')),
|
|
'unlimited_total' => $total,
|
|
);
|
|
}
|
|
|
|
elsif ($phase eq 'Export'){
|
|
binmode STDOUT, ':utf8';
|
|
|
|
# export results to tab separated text or CSV
|
|
my $sql = $input->param('sql'); # FIXME: use sql from saved report ID#, not new user-supplied SQL!
|
|
my $format = $input->param('format');
|
|
my ($sth, $q_errors) = execute_query($sql);
|
|
unless ($q_errors and @$q_errors) {
|
|
print $input->header( -type => 'application/octet-stream',
|
|
-attachment=>"reportresults.$format"
|
|
);
|
|
if ($format eq 'tab') {
|
|
print join("\t", header_cell_values($sth)), "\n";
|
|
while (my $row = $sth->fetchrow_arrayref()) {
|
|
print join("\t", @$row), "\n";
|
|
}
|
|
} else {
|
|
my $csv = Text::CSV->new({binary => 1});
|
|
$csv or die "Text::CSV->new({binary => 1}) FAILED: " . Text::CSV->error_diag();
|
|
if ($csv->combine(header_cell_values($sth))) {
|
|
print $csv->string(), "\n";
|
|
} else {
|
|
push @$q_errors, { combine => 'HEADER ROW: ' . $csv->error_diag() } ;
|
|
}
|
|
while (my $row = $sth->fetchrow_arrayref()) {
|
|
if ($csv->combine(@$row)) {
|
|
print $csv->string(), "\n";
|
|
} else {
|
|
push @$q_errors, { combine => $csv->error_diag() } ;
|
|
}
|
|
}
|
|
}
|
|
foreach my $err (@$q_errors, @errors) {
|
|
print "# ERROR: " . (map {$_ . ": " . $err->{$_}} keys %$err) . "\n";
|
|
} # here we print all the non-fatal errors at the end. Not super smooth, but better than nothing.
|
|
exit;
|
|
}
|
|
$template->param(
|
|
'sql' => $sql,
|
|
'execute' => 1,
|
|
'name' => 'Error exporting report!',
|
|
'notes' => '',
|
|
'errors' => $q_errors,
|
|
);
|
|
}
|
|
|
|
elsif ($phase eq 'Create report from SQL') {
|
|
# allow the user to paste in sql
|
|
if ($input->param('sql')) {
|
|
$template->param(
|
|
'sql' => $input->param('sql'),
|
|
'reportname' => $input->param('reportname'),
|
|
'notes' => $input->param('notes'),
|
|
);
|
|
}
|
|
$template->param('create' => 1);
|
|
}
|
|
|
|
elsif ($phase eq 'Create Compound Report'){
|
|
$template->param( 'savedreports' => get_saved_reports(),
|
|
'compound' => 1,
|
|
);
|
|
}
|
|
|
|
elsif ($phase eq 'Save Compound'){
|
|
my $master = $input->param('master');
|
|
my $subreport = $input->param('subreport');
|
|
my ($mastertables,$subtables) = create_compound($master,$subreport);
|
|
$template->param( 'save_compound' => 1,
|
|
master=>$mastertables,
|
|
subsql=>$subtables
|
|
);
|
|
}
|
|
|
|
# pass $sth, get back an array of names for the column headers
|
|
sub header_cell_values {
|
|
my $sth = shift or return ();
|
|
return @{$sth->{NAME}};
|
|
}
|
|
|
|
# pass $sth, get back a TMPL_LOOP-able set of names for the column headers
|
|
sub header_cell_loop {
|
|
my @headers = map { +{ cell => $_ } } header_cell_values (shift);
|
|
return \@headers;
|
|
}
|
|
|
|
# pass $sth, get back an array of names for the column headers
|
|
sub header_cell_values {
|
|
my $sth = shift or return ();
|
|
return @{$sth->{NAME}};
|
|
}
|
|
|
|
# pass $sth, get back a TMPL_LOOP-able set of names for the column headers
|
|
sub header_cell_loop {
|
|
my @headers = map { +{ cell => $_ } } header_cell_values (shift);
|
|
return \@headers;
|
|
}
|
|
|
|
foreach (1..6) {
|
|
$template->param('build' . $_) and $template->param(buildx => $_) and last;
|
|
}
|
|
$template->param( 'referer' => $input->referer(),
|
|
'DHTMLcalendar_dateformat' => C4::Dates->DHTMLcalendar(),
|
|
);
|
|
|
|
output_html_with_http_headers $input, $cookie, $template->output;
|