Koha/acqui/lateorders.pl
Jonathan Druart 3cf6d99948
Bug 24163: Allow to define CSV profile for late orders export
This new enhancement adds the ability to create a CSV profile for the late
orders export.
Prior to this, the CSV profile was hardcoded in a template and not
editable (unless you modify the .tt file of course).

The main difficulty of the request was to make the multiple claims dates
accessible from the CSV profile. So far we only accept columns from the
database. However we would like to use the Koha::Acquisition::Order
object to make things easier (it had a ->claims method to access the
different claims).
To acchieve this, we are going to accept the TT syntax for that CSV profile.
It means that only CSV profiles created for 'late_orders' will have the
capability to use the TT syntax (can be extended later of course if
needed).
The alternative was to use specific placeholders, like %claims_count%,
%claimed_date%, but it sounded more powerful and flexible to allow the
TT syntax instead.

Note that the former export (template based) still exists and is the
default option.

Test plan:
0. Apply the patches and execute the update database entry
1. Create some orders, close the basket
2. Claim some of the orders
3. Note the new button at the bottom of the table that have several
entries.
=> The first entry will generate a CSV file using the previous method
=> The second entry will generate it using the new CSV profile, note
that the number of claims as well as the different claims date are
displayed.

4. Bonus point: Edit the CSV profile (Home › Tools › CSV export
profiles) that is named "Late orders (csv profile)", or create a new
one, and modify it.
Export the late orders using this CSV profile and confirm that the
generated CSV file is the one you expect.

Sponsored-by: Institute of Technology Tralee
Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Angela O'Connor Desmond <angela.oconnordesmond@staff.ittralee.ie>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
2020-05-05 11:08:21 +01:00

178 lines
5.5 KiB
Perl
Executable file

#!/usr/bin/perl
# Copyright 2005 Biblibre
# 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
# 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, see <http://www.gnu.org/licenses>.
=head1 NAME
lateorders.pl
=head1 DESCRIPTION
this script shows late orders for a specific supplier, branch and delay
given on input arg.
=head1 CGI PARAMETERS
=over 4
=item booksellerid
To know on which supplier this script have to display late order.
=item delay
To know the time boundary. Default value is 30 days.
=item branch
To know on which branch this script have to display late order.
=back
=cut
use Modern::Perl;
use CGI qw ( -utf8 );
use C4::Bookseller qw( GetBooksellersWithLateOrders );
use C4::Auth;
use C4::Koha;
use C4::Output;
use C4::Context;
use C4::Acquisition;
use C4::Letters;
use Koha::DateUtils;
use Koha::Acquisition::Orders;
use Koha::CsvProfiles;
my $input = new CGI;
my ($template, $loggedinuser, $cookie) = get_template_and_user(
{
template_name => "acqui/lateorders.tt",
query => $input,
type => "intranet",
authnotrequired => 0,
flagsrequired => { acquisition => 'order_receive' },
debug => 1,
}
);
my $booksellerid = $input->param('booksellerid') || undef; # we don't want "" or 0
my $delay = $input->param('delay') // 0;
# Get the "date from" param if !defined is today
my $estimateddeliverydatefrom = $input->param('estimateddeliverydatefrom');
my $estimateddeliverydateto = $input->param('estimateddeliverydateto');
my $estimateddeliverydatefrom_dt =
$estimateddeliverydatefrom
? dt_from_string($estimateddeliverydatefrom)
: undef;
# Get the "date to" param. If it is not defined and $delay is not defined too, it is the today's date.
my $estimateddeliverydateto_dt = $estimateddeliverydateto
? dt_from_string($estimateddeliverydateto)
: ( not defined $delay and not defined $estimateddeliverydatefrom)
? dt_from_string()
: undef;
# Format the output of "date from" and "date to"
if ($estimateddeliverydatefrom_dt) {
$estimateddeliverydatefrom = output_pref({dt => $estimateddeliverydatefrom_dt, dateonly => 1});
}
if ($estimateddeliverydateto_dt) {
$estimateddeliverydateto = output_pref({dt => $estimateddeliverydateto_dt, dateonly => 1});
}
my $branch = $input->param('branch');
my $op = $input->param('op');
my @errors = ();
if ( $delay and not $delay =~ /^\d{1,3}$/ ) {
push @errors, {delay_digits => 1, bad_delay => $delay};
}
if ($op and $op eq "send_alert"){
my @ordernums = $input->multi_param("ordernumber");
my $err;
eval {
$err = SendAlerts( 'claimacquisition', \@ordernums, $input->param("letter_code") );
if ( not ref $err or not exists $err->{error} ) {
Koha::Acquisition::Orders->find($_)->claim() for @ordernums;
}
};
if ( ref $err and exists $err->{error} and $err->{error} eq "no_email" ) {
$template->{VARS}->{'error_claim'} = "no_email";
} elsif ( ref $err and exists $err->{error} and $err->{error} eq "no_order_selected"){
$template->{VARS}->{'error_claim'} = "no_order_selected";
} elsif ( $@ or ref $err and exists $err->{error} ) {
$template->param(error_claim => $@ || $err->{error});
} else {
$template->{VARS}->{'info_claim'} = 1;
}
}
my @parameters = ( $delay );
push @parameters, $estimateddeliverydatefrom_dt
? $estimateddeliverydatefrom_dt->ymd()
: undef;
push @parameters, $estimateddeliverydateto_dt
? $estimateddeliverydateto_dt->ymd()
: undef;
my %supplierlist = GetBooksellersWithLateOrders(@parameters);
my (@sloopy); # supplier loop
foreach( sort { $supplierlist{$a} cmp $supplierlist{$b} } keys %supplierlist ) {
push @sloopy, (($booksellerid and $booksellerid eq $_ ) ?
{id=>$_, name=>$supplierlist{$_}, selected=>1} :
{id=>$_, name=>$supplierlist{$_}} ) ;
}
$template->param(SUPPLIER_LOOP => \@sloopy);
$template->param(Supplier=>$supplierlist{$booksellerid}) if ($booksellerid);
$template->param(booksellerid=>$booksellerid) if ($booksellerid);
my $lateorders = Koha::Acquisition::Orders->filter_by_lates(
{
delay => $delay,
booksellerid => $booksellerid,
(
$estimateddeliverydatefrom_dt
? ( estimated_from => $estimateddeliverydatefrom_dt )
: ()
),
(
$estimateddeliverydateto_dt
? ( estimated_to => $estimateddeliverydateto_dt )
: ()
)
}
);
my $letters = GetLetters({ module => "claimacquisition" });
$template->param(ERROR_LOOP => \@errors) if (@errors);
$template->param(
lateorders => $lateorders,
delay => $delay,
letters => $letters,
estimateddeliverydatefrom => $estimateddeliverydatefrom,
estimateddeliverydateto => $estimateddeliverydateto,
intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
csv_profiles => [ Koha::CsvProfiles->search({ type => 'sql', used_for => 'late_orders' }) ],
);
output_html_with_http_headers $input, $cookie, $template->output;