# 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 CGI::Carp qw(fatalsToBrowser warningsToBrowser);
+# You should have received a copy of the GNU General Public License along
+# with Koha; if not, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
use strict;
-use C4::Auth;
+#use warnings; FIXME - Bug 2505
use CGI;
+use Text::CSV;
+use C4::Reports::Guided;
+use C4::Auth;
use C4::Output;
-use C4::Reports;
+use C4::Dates;
+use C4::Debug;
+use C4::Branch; # XXX subfield_is_koha_internal_p
=head1 NAME
-Script to control the guided report creation
+guided_reports.pl
=head1 DESCRIPTION
-
-=over2
+Script to control the guided report creation
=cut
my $input = new CGI;
-my $referer = $input->referer();
+
+my $phase = $input->param('phase');
+my $flagsrequired;
+if ( $phase eq 'Build new' or $phase eq 'Delete Saved' ) {
+ $flagsrequired = 'create_reports';
+}
+elsif ( $phase eq 'Use saved' ) {
+ $flagsrequired = 'execute_reports';
+} else {
+ $flagsrequired = '*';
+}
+
my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
{
template_name => "reports/guided_reports_start.tmpl",
query => $input,
type => "intranet",
authnotrequired => 0,
- flagsrequired => { editcatalogue => 1 },
+ flagsrequired => { reports => $flagsrequired },
debug => 1,
}
);
-my $phase = $input->param('phase');
-my $no_html = 0; # this will be set if we dont want to print out an html::template
-
+ my @errors = ();
if ( !$phase ) {
$template->param( 'start' => 1 );
-
# show welcome page
}
-
elsif ( $phase eq 'Build new' ) {
-
# build a new report
$template->param( 'build1' => 1 );
-
- # get report areas
- my $areas = C4::Reports::get_report_areas();
- $template->param( 'areas' => $areas );
-
+ $template->param( 'areas' => get_report_areas() );
}
-
-elsif ( $phase eq 'Used saved' ) {
-
+elsif ( $phase eq 'Use saved' ) {
# use a saved report
# get list of reports and display them
$template->param( 'saved1' => 1 );
- my $reports = get_saved_reports();
- $template->param( 'savedreports' => $reports );
+ $template->param( 'savedreports' => get_saved_reports() );
}
elsif ( $phase eq 'Delete Saved') {
# delete a report from the saved reports list
- $no_html = 1;
my $id = $input->param('reports');
delete_report($id);
- print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Used%20saved");
-
+ print $input->redirect("/cgi-bin/koha/reports/guided_reports.pl?phase=Use%20saved");
+ exit;
}
elsif ( $phase eq 'Show SQL'){
$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 = format_results($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
- # get area
- my $area = $input->param('areas');
$template->param(
'build2' => 1,
- 'area' => $area
+ 'area' => $input->param('areas'),
+ 'types' => get_report_types(),
);
-
- # get report types
- my $types = C4::Reports::get_report_types();
- $template->param( 'types' => $types );
}
elsif ( $phase eq 'Choose this type' ) {
'build3' => 1,
'area' => $area,
'type' => $type,
+ columns => get_columns($area,$input),
);
-
- # get columns
- my $columns = get_columns($area);
- $template->param( 'columns' => $columns );
}
elsif ( $phase eq 'Choose these columns' ) {
my $type = $input->param('type');
my @columns = $input->param('columns');
my $column = join( ',', @columns );
- my $definitions = get_from_dictionary($area);
$template->param(
'build4' => 1,
'area' => $area,
'type' => $type,
'column' => $column,
+ definitions => get_from_dictionary($area),
+ criteria => get_criteria($area,$input),
);
- my $criteria = get_criteria($area);
- $template->param( 'criteria' => $criteria,
- 'definitions' => $definitions);
}
elsif ( $phase eq 'Choose these criteria' ) {
my $query_criteria;
foreach my $crit (@criteria) {
my $value = $input->param( $crit . "_value" );
- if ($value) {
+
+ # If value is not defined, then it may be range values
+ if (!defined $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");
+ }
+ # don't escape runtime parameters, they'll be at runtime
+ if ($value =~ /<<.*>>/) {
+ $query_criteria .= " AND $crit=$value";
+ } else {
$query_criteria .= " AND $crit='$value'";
}
+ }
}
$template->param(
'area' => $area,
'type' => $type,
'column' => $column,
- 'definition' => $definition,
+ 'definition' => $definition,
'criteriastring' => $query_criteria,
);
# 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;
- $total{'name'} = $col;
- my @selects;
- my %select1;
- $select1{'value'} = 'sum';
- push @selects, \%select1;
- my %select2;
- $select2{'value'} = 'min';
- push @selects, \%select2;
- my %select3;
- $select3{'value'} = 'max';
- push @selects, \%select3;
- my %select4;
- $select4{'value'} = 'avg';
- push @selects, \%select4;
- my %select5;
- $select5{'value'} = 'count';
- push @selects, \%select5;
-
+ my %total = (name => $col);
+ my @selects = map {+{ value => $_ }} (qw(sum min max avg count));
$total{'select'} = \@selects;
push @total_by, \%total;
}
'column' => $column,
'criteriastring' => $criteria,
'totals' => $totals,
- 'definition' => $definition,
+ 'definition' => $definition,
);
# get columns
# 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;
- $order{'name'} = $col;
- my @selects;
- my %select1;
- $select1{'value'} = 'asc';
- push @selects, \%select1;
- my %select2;
- $select2{'value'} = 'desc';
- push @selects, \%select2;
+ my %order = (name => $col);
+ my @selects = map {+{ value => $_ }} (qw(asc desc));
$order{'select'} = \@selects;
push @order_by, \%order;
}
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 $definition = $input->param('definition');
my $query_criteria=$crit;
# split the columns up by ,
my @columns = split( ',', $column );
my $sql = $input->param('sql');
my $type = $input->param('type');
$template->param(
- 'save_successful' => 1,
+ 'save' => 1,
'sql' => $sql,
'type' => $type
);
# save the sql pasted in by a user
my $sql = $input->param('sql');
my $name = $input->param('reportname');
- my $type = $input->param('type');
- my $notes = $input->param('notes');
- save_report( $sql, $name, $type, $notes );
- $template->param(
- 'save_successful' => 1,
- );
-}
-
-elsif ( $phase eq 'Execute' ) {
- # run the sql, and output results in a template
- my $sql = $input->param('sql');
- my $type = $input->param('type');
- my $results = execute_query($sql,$type);
- $template->param(
- 'results' => $results,
- 'sql' => $sql,
- 'execute' => 1
- );
+ 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 {
+ my $id = save_report( $borrowernumber, $sql, $name, $type, $notes );
+ $template->param(
+ 'save_successful' => 1,
+ 'id' => $id,
+ );
+ }
}
elsif ($phase eq 'Run this report'){
# execute a saved report
- my $report = $input->param('reports');
- my ($sql,$type,$name,$notes) = get_saved_report($report);
- my $results = execute_query($sql,$type);
- $template->param(
- 'results' => $results,
- 'sql' => $sql,
- 'execute' => 1,
- 'name' => $name,
- 'notes' => $notes,
- );
-}
+ my $limit = 20; # page size. # TODO: move to DB or syspref?
+ my $offset = 0;
+ my $report = $input->param('reports');
+ my @sql_params = $input->param('sql_params');
+ # 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 = ();
+ # if we have at least 1 parameter, and it's not filled, then don't execute but ask for parameters
+ if ($sql =~ /<</ && !@sql_params) {
+ # split on ??. Each odd (2,4,6,...) entry should be a parameter to fill
+ my @split = split /<<|>>/,$sql;
+ my @tmpl_parameters;
+ for(my $i=0;$i<($#split/2);$i++) {
+ my ($text,$authorised_value) = split /\|/,$split[$i*2+1];
+ my $input;
+ if ($authorised_value) {
+ my $dbh=C4::Context->dbh;
+ my @authorised_values;
+ my %authorised_lib;
+ # builds list, depending on authorised value...
+ if ( $authorised_value eq "branches" ) {
+ my $branches = GetBranchesLoop();
+ foreach my $thisbranch (@$branches) {
+ push @authorised_values, $thisbranch->{value};
+ $authorised_lib{$thisbranch->{value}} = $thisbranch->{branchname};
+ }
+ }
+ elsif ( $authorised_value eq "itemtypes" ) {
+ my $sth = $dbh->prepare("SELECT itemtype,description FROM itemtypes ORDER BY description");
+ $sth->execute;
+ while ( my ( $itemtype, $description ) = $sth->fetchrow_array ) {
+ push @authorised_values, $itemtype;
+ $authorised_lib{$itemtype} = $description;
+ }
+ }
+ elsif ( $authorised_value eq "cn_source" ) {
+ my $class_sources = GetClassSources();
+ my $default_source = C4::Context->preference("DefaultClassificationSource");
+ foreach my $class_source (sort keys %$class_sources) {
+ next unless $class_sources->{$class_source}->{'used'} or
+ ($class_source eq $default_source);
+ push @authorised_values, $class_source;
+ $authorised_lib{$class_source} = $class_sources->{$class_source}->{'description'};
+ }
+ }
+ elsif ( $authorised_value eq "categorycode" ) {
+ my $sth = $dbh->prepare("SELECT categorycode, description FROM categories ORDER BY description");
+ $sth->execute;
+ while ( my ( $categorycode, $description ) = $sth->fetchrow_array ) {
+ push @authorised_values, $categorycode;
+ $authorised_lib{$categorycode} = $description;
+ }
+
+ #---- "true" authorised value
+ }
+ else {
+ my $authorised_values_sth = $dbh->prepare("SELECT authorised_value,lib FROM authorised_values WHERE category=? ORDER BY lib");
+
+ $authorised_values_sth->execute( $authorised_value);
+
+ while ( my ( $value, $lib ) = $authorised_values_sth->fetchrow_array ) {
+ push @authorised_values, $value;
+ $authorised_lib{$value} = $lib;
+ # For item location, we show the code and the libelle
+ $authorised_lib{$value} = $lib;
+ }
+ }
+ $input =CGI::scrolling_list( # FIXME: factor out scrolling_list
+ -name => "sql_params",
+ -values => \@authorised_values,
+# -default => $value,
+ -labels => \%authorised_lib,
+ -override => 1,
+ -size => 1,
+ -multiple => 0,
+ -tabindex => 1,
+ );
+
+ } else {
+ $input = "<input type='text' name='sql_params'/>";
+ }
+ push @tmpl_parameters, {'entry' => $text, 'input' => $input };
+ }
+ $template->param('sql' => $sql,
+ 'name' => $name,
+ 'sql_params' => \@tmpl_parameters,
+ 'enter_params' => 1,
+ 'reports' => $report,
+ );
+ } else {
+ # OK, we have parameters, or there are none, we run the report
+ # if there were parameters, replace before running
+ # split on ??. Each odd (2,4,6,...) entry should be a parameter to fill
+ my @split = split /<<|>>/,$sql;
+ my @tmpl_parameters;
+ for(my $i=0;$i<$#split/2;$i++) {
+ my $quoted = C4::Context->dbh->quote($sql_params[$i]);
+ # if there are special regexp chars, we must \ them
+ $split[$i*2+1] =~ s/(\||\?|\.|\*|\(|\)|\%)/\\$1/g;
+ $sql =~ s/<<$split[$i*2+1]>>/$quoted/;
+ }
+ my ($sth, $errors) = execute_query($sql, $offset, $limit);
+ my $total = nb_rows($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'){
- # export results to tab separated text
- my $sql = $input->param('sql');
- $no_html=1;
- print $input->header( -type => 'application/octet-stream',
- -attachment=>'reportresults.csv');
- my $format=$input->param('format');
- my $results = execute_query($sql,1,$format);
- print $results;
-
+ 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'){
- # alllow the user to paste in sql
+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);
- my $types = C4::Reports::get_report_types();
- $template->param( 'types' => $types );
}
elsif ($phase eq 'Create Compound Report'){
- my $reports = get_saved_reports();
- $template->param( 'savedreports' => $reports,
+ $template->param( 'savedreports' => get_saved_reports(),
'compound' => 1,
);
}
elsif ($phase eq 'Save Compound'){
- my $master = $input->param('master');
+ my $master = $input->param('master');
my $subreport = $input->param('subreport');
-# my $compound_report = create_compound($master,$subreport);
-# my $results = run_compound($compound_report);
my ($mastertables,$subtables) = create_compound($master,$subreport);
$template->param( 'save_compound' => 1,
master=>$mastertables,
);
}
+# pass $sth, get back an array of names for the column headers
+sub header_cell_values {
+ my $sth = shift or return ();
+ return @{$sth->{NAME}};
+}
-$template->param( 'referer' => $referer );
-
+# 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;
+}
-if (!$no_html){
- output_html_with_http_headers $input, $cookie, $template->output;
+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;
projects / koha.git / blobdiff