Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity

Bug 9915: Allow sql_params to be passed to a report using the OPAC svc/report interface

Browse source 
Test plan:

1/ Make a public report that contains SQL parameters
2/ Test it from the staff side
3/ Hit the url like
cgi-bin/koha/svc/report?id=1&sql_params=chris&sql_params=chris2
4/ Test you get JSON

Signed-off-by: Chris Cormack <chrisc@catalyst.net.nz>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Katrin Fischer <Katrin.Fischer.83@web.de>
Passes all tests and QA script.

Tested with a public report:
select * from items
  - cgi-bin/koha/svc/report?id=6
  - URL shows JSON and all items
select * from items where itype = <<itype>>
  - cgi-bin/koha/svc/report?id=6&sql_params=BK
  - URL shows JSON and only BK items
select * from items where itype = <<itype>> and homebranch = <<homebranch>>
  - cgi-bin/koha/svc/report?id=6&sql_params=BK&sql_params=MPL
  - URL shows JSON and only BK items in MPL
select * from items where itype = <<itype|itemtypes>> and homebranch = <<homebranch|branches>>
  - same as above
  - URL shows JSON and only BK items in MPL
select * from items where dateaccessioned = 2013-12-15
  - cgi-bin/koha/svc/report?id=6&sql_params=BK&sql_params=MPL&sql_params=2013-12-15
  - URL shows JSON and correct items

Note: This will currently only work for public reports!

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
This commit is contained in:
Chris Cormack 2013-03-24 20:29:18 +13:00 committed by Galen Charlton
parent 9708138a86
commit 9161911612
1 changed files with 36 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

48
opac/svc/report
View file

@ -4,11 +4,14 @@
#
# Copyright (C) 2011 Chris Cormack <chris@bigballofwax.co.nz>
# Copyright (C) 2013 Mark Tompsett
# Updated 2013 by Chris Cormack <chris@bigballofwax.co.nz>
#
# 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 3 of the License, or
# (at your option) any later version.
# 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 3 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
@ -26,8 +29,8 @@ use CGI;
use Koha::Cache;
my $query = CGI->new();
my $report_id = $query->param('id');
my $query = CGI->new();
my $report_id = $query->param('id');
my $report_name = $query->param('name');
my $report_annotation = $query->param('annotated');
@ -36,18 +39,38 @@ if (!$report_rec) { die "There is no such report.\n"; }
die "Sorry this report is not public\n" unless $report_rec->{public};
my @sql_params = $query->param('sql_params');
my $cache_active = Koha::Cache->is_cache_active;
my ($cache_key, $cache, $json_text);
my ( $cache_key, $cache, $json_text );
if ($cache_active) {
$cache_key = "opac:report:".($report_name ? "name:$report_name" : "id:$report_id");
$cache = Koha::Cache->new();
$cache_key =
"opac:report:"
. ( $report_name ? "name:$report_name" : "id:$report_id" )
. @sql_params;
$cache = Koha::Cache->new();
$json_text = $cache->get_from_cache($cache_key);
}
unless ($json_text) {
my $offset = 0;
my $limit = C4::Context->preference("SvcMaxReportRows") || 10;
my ( $sth, $errors ) = execute_query( $report_rec->{savedsql}, $offset, $limit );
my $limit = C4::Context->preference("SvcMaxReportRows") || 10;
my $sql = $report_rec->{savedsql};
if (@sql_params) {
# we have sql params need to fix the sql
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 );
if ($sth) {
my $lines;
if ($report_annotation) {
@ -59,7 +82,8 @@ unless ($json_text) {
$json_text = to_json($lines);
if ($cache_active) {
$cache->set_in_cache( $cache_key, $json_text, $report_rec->{cache_expiry} );
$cache->set_in_cache( $cache_key, $json_text,
$report_rec->{cache_expiry} );
}
}
else {