# 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
+# 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 warnings; # FIXME
+#use warnings; FIXME - Bug 2505
use CGI;
use Text::CSV;
+use URI::Escape;
use C4::Reports::Guided;
-use C4::Auth;
+use C4::Auth qw/:DEFAULT get_session/;
use C4::Output;
use C4::Dates;
use C4::Debug;
+use C4::Branch; # XXX subfield_is_koha_internal_p
=head1 NAME
Script to control the guided report creation
-=over2
-
=cut
my $input = new CGI;
+my $usecache = C4::Context->ismemcached;
+
+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(
{
query => $input,
type => "intranet",
authnotrequired => 0,
- flagsrequired => { reports => 1 },
+ flagsrequired => { reports => $flagsrequired },
debug => 1,
}
);
+my $session = $cookie ? get_session($cookie->value) : undef;
+
+my $filter;
+if ( $input->param("filter_set") ) {
+ $filter = {};
+ $filter->{$_} = $input->param("filter_$_") foreach qw/date author keyword/;
+ $session->param('report_filter', $filter) if $session;
+ $template->param( 'filter_set' => 1 );
+}
+elsif ($session) {
+ $filter = $session->param('report_filter');
+}
- my @errors = ();
-my $phase = $input->param('phase');
+
+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() );
+ $template->param( 'areas' => get_report_areas(), 'usecache' => $usecache, 'cache_expiry' => 300, 'public' => '0' );
}
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() );
+ $template->param(
+ 'saved1' => 1,
+ 'savedreports' => get_saved_reports($filter),
+ 'usecache' => $usecache,
+ );
+ if ($filter) {
+ while ( my ($k, $v) = each %$filter ) {
+ $template->param( "filter_$k" => $v ) if $v;
+ }
+ }
}
elsif ( $phase eq 'Delete Saved') {
elsif ( $phase eq 'Show SQL'){
my $id = $input->param('reports');
- my $sql = get_sql($id);
+ my ($sql,$type,$reportname,$notes) = get_saved_report($id);
$template->param(
- 'sql' => $sql,
+ 'id' => $id,
+ 'reportname' => $reportname,
+ 'notes' => $notes,
+ 'sql' => $sql,
'showsql' => 1,
);
}
elsif ( $phase eq 'Edit SQL'){
my $id = $input->param('reports');
- my ($sql,$type,$reportname,$notes) = get_saved_report($id);
+ my ($sql,$type,$reportname,$notes, $cache_expiry, $public) = get_saved_report($id);
$template->param(
'sql' => $sql,
'reportname' => $reportname,
'notes' => $notes,
'id' => $id,
+ 'cache_expiry' => $cache_expiry,
+ 'public' => $public,
+ 'usecache' => $usecache,
'editsql' => 1,
);
}
my $sql = $input->param('sql');
my $reportname = $input->param('reportname');
my $notes = $input->param('notes');
+ my $cache_expiry = $input->param('cache_expiry');
+ my $cache_expiry_units = $input->param('cache_expiry_units');
+ my $public = $input->param('public');
+
my @errors;
+
+ # if we have the units, then we came from creating a report from SQL and thus need to handle converting units
+ if( $cache_expiry_units ){
+ if( $cache_expiry_units eq "minutes" ){
+ $cache_expiry *= 60;
+ } elsif( $cache_expiry_units eq "hours" ){
+ $cache_expiry *= 3600; # 60 * 60
+ } elsif( $cache_expiry_units eq "days" ){
+ $cache_expiry *= 86400; # 60 * 60 * 24
+ }
+ }
+ # check $cache_expiry isnt 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
+ if( $cache_expiry >= 2592000 ){
+ push @errors, {cache_expiry => $cache_expiry};
+ }
+
if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
push @errors, {sqlerr => $1};
}
);
}
else {
- update_sql( $id, $sql, $reportname, $notes );
+ update_sql( $id, $sql, $reportname, $notes, $cache_expiry, $public );
$template->param(
'save_successful' => 1,
+ 'reportname' => $reportname,
+ 'id' => $id,
);
}
}
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(),
- );
+ my $cache_expiry_units = $input->param('cache_expiry_units'),
+ my $cache_expiry = $input->param('cache_expiry');
+
+ # we need to handle converting units
+ if( $cache_expiry_units eq "minutes" ){
+ $cache_expiry *= 60;
+ } elsif( $cache_expiry_units eq "hours" ){
+ $cache_expiry *= 3600; # 60 * 60
+ } elsif( $cache_expiry_units eq "days" ){
+ $cache_expiry *= 86400; # 60 * 60 * 24
+ }
+ # check $cache_expiry isnt 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
+ if( $cache_expiry >= 2592000 ){ # oops, over the limit of 30 days
+ # report error to user
+ $template->param(
+ 'cache_error' => 1,
+ 'build1' => 1,
+ 'areas' => get_report_areas(),
+ 'cache_expiry' => $cache_expiry,
+ 'usecache' => $usecache,
+ 'public' => $input->param('public'),
+ );
+ } else {
+ # they have choosen a new report and the area to report on
+ $template->param(
+ 'build2' => 1,
+ 'area' => $input->param('areas'),
+ 'types' => get_report_types(),
+ 'cache_expiry' => $cache_expiry,
+ 'public' => $input->param('public'),
+ );
+ }
}
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');
'area' => $area,
'type' => $type,
columns => get_columns($area,$input),
+ 'cache_expiry' => $input->param('cache_expiry'),
+ 'public' => $input->param('public'),
);
}
elsif ( $phase eq 'Choose these columns' ) {
-
# we now know type, area, and columns
# next step is the constraints
my $area = $input->param('area');
'column' => $column,
definitions => get_from_dictionary($area),
criteria => get_criteria($area,$input),
+ 'cache_expiry' => $input->param('cache_expiry'),
+ 'cache_expiry_units' => $input->param('cache_expiry_units'),
+ 'public' => $input->param('public'),
);
}
my $query_criteria;
foreach my $crit (@criteria) {
my $value = $input->param( $crit . "_value" );
- ($value) or next;
- if ($value =~ C4::Dates->regexp('syspref')) {
- $value = C4::Dates->new($value)->output("iso");
+
+ # 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'";
}
- $query_criteria .= " AND $crit='$value'";
+ }
}
-
$template->param(
'build5' => 1,
'area' => $area,
'column' => $column,
'definition' => $definition,
'criteriastring' => $query_criteria,
+ 'cache_expiry' => $input->param('cache_expiry'),
+ 'cache_expiry_units' => $input->param('cache_expiry_units'),
+ 'public' => $input->param('public'),
);
# get columns
'criteriastring' => $criteria,
'totals' => $totals,
'definition' => $definition,
+ 'cache_expiry' => $input->param('cache_expiry'),
+ 'public' => $input->param('public'),
);
# get columns
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 );
$template->param(
'showreport' => 1,
'sql' => $sql,
- 'type' => $type
+ 'type' => $type,
+ 'cache_expiry' => $input->param('cache_expiry'),
+ 'public' => $input->param('public'),
);
}
$template->param(
'save' => 1,
'sql' => $sql,
- 'type' => $type
+ 'type' => $type,
+ 'cache_expiry' => $input->param('cache_expiry'),
+ 'public' => $input->param('public'),
);
}
my $name = $input->param('reportname');
my $type = $input->param('types');
my $notes = $input->param('notes');
+ my $cache_expiry = $input->param('cache_expiry');
+ my $cache_expiry_units = $input->param('cache_expiry_units');
+ my $public = $input->param('public');
+
+
+ # if we have the units, then we came from creating a report from SQL and thus need to handle converting units
+ if( $cache_expiry_units ){
+ if( $cache_expiry_units eq "minutes" ){
+ $cache_expiry *= 60;
+ } elsif( $cache_expiry_units eq "hours" ){
+ $cache_expiry *= 3600; # 60 * 60
+ } elsif( $cache_expiry_units eq "days" ){
+ $cache_expiry *= 86400; # 60 * 60 * 24
+ }
+ }
+ # check $cache_expiry isnt 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
+ if( $cache_expiry >= 2592000 ){
+ push @errors, {cache_expiry => $cache_expiry};
+ }
+ ## FIXME this is AFTER entering a name to save the report under
if ($sql =~ /;?\W?(UPDATE|DELETE|DROP|INSERT|SHOW|CREATE)\W/i) {
push @errors, {sqlerr => $1};
}
'reportname'=> $name,
'type' => $type,
'notes' => $notes,
+ 'cache_expiry' => $cache_expiry,
+ 'public' => $public,
);
}
else {
- save_report( $borrowernumber, $sql, $name, $type, $notes );
+ my $id = save_report( $borrowernumber, $sql, $name, $type, $notes, $cache_expiry, $public );
$template->param(
'save_successful' => 1,
+ 'reportname' => $name,
+ 'id' => $id,
);
}
}
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;
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";
+ # 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 eq "date") {
+ $input = 'date';
+ }
+ elsif ($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 {
- 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 };
+ # 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,
- );
-}
+ 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";
+ if (@sql_params) {
+ $url = join('&sql_params=', $url, map { URI::Escape::uri_escape($_) } @sql_params);
+ }
+ $template->param(
+ 'results' => \@rows,
+ 'sql' => $sql,
+ 'id' => $report,
+ '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';
+ binmode STDOUT, ':encoding(UTF-8)';
# 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!
'notes' => $input->param('notes'),
);
}
- $template->param('create' => 1);
+ $template->param('create' => 1, 'public' => '0', 'cache_expiry' => 300, 'usecache' => $usecache);
}
elsif ($phase eq 'Create Compound Report'){
}
foreach (1..6) {
- $template->param('build' . $_) and $template->param(buildx => $_) and last;
+ $template->{VARS}->{'build' . $_} and $template->{VARS}->{'buildx' . $_} and last;
}
$template->param( 'referer' => $input->referer(),
'DHTMLcalendar_dateformat' => C4::Dates->DHTMLcalendar(),
projects / koha.git / blobdiff