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

Bug 23685: (follow-up) Add export limit for guided reports

Browse source 
Test plan:
Set pref ReportsExportLimit to some positive integer.
Test if exporting a report respects that limit.
Run t/db_dependent/Koha/Reports.t

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
This commit is contained in:
Marcel de Rooy 2024-09-06 09:29:39 +00:00 committed by Katrin Fischer
parent e95b32a21a
commit 323863ba14
Signed by: kfischer
GPG key ID: 0EF6E2C03357A834
3 changed files with 63 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

27
Koha/Report.pm
View file

@ -168,7 +168,7 @@ for building batch action links in the template
=cut
sub prep_report {
my ( $self, $param_names, $sql_params ) = @_;
my ( $self, $param_names, $sql_params, $params ) = @_; # params keys: export
my $sql = $self->savedsql;
# First we split out the placeholders
@ -226,10 +226,35 @@ sub prep_report {
$sql =~ s/<<$split[$i*2+1]>>/$quoted/;
}
$sql = $self->_might_add_limit($sql) if $params->{export};
$sql = "$sql /* saved_sql.id: ${\( $self->id )} */";
return $sql, $headers;
}
=head3 _might_add_limit
$sql = $self->_might_add_limit($sql);
Depending on pref ReportsExportLimit. If there is a limit defined
and the report does not contain a limit already, this routine adds
a LIMIT to $sql.
=cut
sub _might_add_limit {
my ( $self, $sql ) = @_;
if ( C4::Context->preference('ReportsExportLimit')
&& $sql !~ /\sLIMIT\s\d+(?![^\(]*\))/i )
{
# Note: regex tries to account for allowed limits in subqueries.
# This assumes that we dont have an INTO option at the end (which does
# not work in current Koha reporting)
$sql .= " LIMIT " . C4::Context->preference('ReportsExportLimit');
}
return $sql;
}
=head3 _type
Returns name of corresponding DBIC resultset

2
reports/guided_reports.pl
View file

@ -630,7 +630,7 @@ elsif ($op eq 'export'){
$reportname ? "$report_id-$reportname-reportresults.$format" : "$report_id-reportresults.$format";
my $scrubber = C4::Scrubber->new();
($sql, undef) = $report->prep_report( \@param_names, \@sql_params );
($sql, undef) = $report->prep_report( \@param_names, \@sql_params, { export => 1 } );
my ( $sth, $q_errors ) = execute_query( { sql => $sql, report_id => $report_id } );
unless ($q_errors and @$q_errors) {
my ( $type, $content );

37
t/db_dependent/Koha/Reports.t
View file

@ -17,12 +17,13 @@
use Modern::Perl;
use Test::More tests => 7;
use Test::More tests => 8;
use Koha::Report;
use Koha::Reports;
use Koha::Database;
use t::lib::Mocks;
use t::lib::TestBuilder;
my $schema = Koha::Database->new->schema;
@ -136,4 +137,38 @@ subtest 'check_columns' => sub {
);
};
subtest '_might_add_limit' => sub {
plan tests => 10;
my $sql;
t::lib::Mocks::mock_preference( 'ReportsExportLimit', undef ); # i.e. no limit
$sql = "SELECT * FROM biblio WHERE 1";
is( Koha::Report->_might_add_limit($sql), $sql, 'Pref is undefined, no changes' );
t::lib::Mocks::mock_preference( 'ReportsExportLimit', 0 ); # i.e. no limit
is( Koha::Report->_might_add_limit($sql), $sql, 'Pref is zero, no changes' );
t::lib::Mocks::mock_preference( 'ReportsExportLimit', q{} ); # i.e. no limit
is( Koha::Report->_might_add_limit($sql), $sql, 'Pref is empty, no changes' );
t::lib::Mocks::mock_preference( 'ReportsExportLimit', 10 );
like( Koha::Report->_might_add_limit($sql), qr/ LIMIT 10$/, 'Limit 10 found at the end' );
$sql = "SELECT * FROM biblio WHERE 1 LIMIT 1000 ";
is( Koha::Report->_might_add_limit($sql), $sql, 'Already contains a limit' );
$sql = "SELECT * FROM biblio WHERE 1 LIMIT 1000,2000";
is( Koha::Report->_might_add_limit($sql), $sql, 'Variation, also contains a limit' );
# trying a subquery having a limit (testing the lookahead in regex)
$sql = "SELECT * FROM biblio WHERE biblionumber IN (SELECT biblionumber FROM reserves LIMIT 2)";
like( Koha::Report->_might_add_limit($sql), qr/ LIMIT 10$/, 'Subquery, limit 10 found at the end' );
$sql = "SELECT * FROM biblio WHERE biblionumber IN (SELECT biblionumber FROM reserves LIMIT 2, 3 ) AND 1";
like( Koha::Report->_might_add_limit($sql), qr/ LIMIT 10$/, 'Subquery variation, limit 10 found at the end' );
$sql = "select * from biblio where biblionumber in (select biblionumber from reserves limiT 3,4) and 1";
like( Koha::Report->_might_add_limit($sql), qr/ LIMIT 10$/, 'Subquery lc variation, limit 10 found at the end' );
$sql = "select limit, 22 from mylimits where limit between 1 and 3";
like(
Koha::Report->_might_add_limit($sql), qr/ LIMIT 10$/,
'Query refers to limit field, limit 10 found at the end'
);
};
$schema->storage->txn_rollback;