Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/circ/returns.pl
Jonathan Druart d864c5640a
Bug 24612: Make hold-transfer-slip take reserve_id 
To make sure we are going to display the correct hold's info we need to
pass the reserve_id.

== Test plan ==
1. Add some content to HOLD_SLIP notice, e.g.

  <h2>[% branch.branchname %]</h2>
  <div>[% biblio.author %]<br>[% biblio.title %]<br>[% item.barcode %]
  <ul><li> Reserve ID:  [% hold.reserve_id %]</li>
  <li>Expiration date: [% hold.expirationdate %]</li></ul>

2. Add 2 holds for 1 patron to a single record
3. Check the reserve IDs in the reserves table - on a clean sandbox, they will be 1 and 2
4. Check in one of the items from the record and print the slip
5. Note that the reserve ID on the slip is 2 and the expiration date is blank
6. Repeated check ins do not change this
7. Check in a second item from the record
8. Note that the reserve ID for this hold is also 2, but this time the expiration date is filled in
9. Check in the first item again - the reserve ID stays as 2, but this time the expiration date is filled in
10. Apply patch
11. cancel the holds to come back to a clean state
    (and maybe ensure items aren't in transit)
12. redo the test and see the following differences
13. 1st checkin:
    1. expiration date ok
    2. the reserve ID is the one of the first hold
14. 2nd checkin:
    1. expiration date ok
    2. the reserve ID is the one of the second hold

Signed-off-by: Victor Grousset/tuxayo <victor@tuxayo.net>
Signed-off-by: Katrin Fischer <katrin.fischer.83@web.de>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
2020-05-22 09:33:16 +01:00

649 lines
23 KiB
Perl
Executable file
Raw Blame History

#!/usr/bin/perl
# Copyright 2000-2002 Katipo Communications
# 2006 SAN-OP
# 2007-2010 BibLibre, Paul POULAIN
# 2010 Catalyst IT
# 2011 PTFS-Europe Ltd.
#
# 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 returns.pl
script to execute returns of books
=cut
use Modern::Perl;
# FIXME There are weird things going on with $patron and $borrowernumber in this script
use CGI qw ( -utf8 );
use DateTime;
use C4::Auth qw/:DEFAULT get_session/;
use C4::Output;
use C4::Circulation;
use C4::Reserves;
use C4::Biblio;
use C4::Circulation;
use C4::Context;
use C4::Items;
use C4::Koha; # FIXME : is it still useful ?
use C4::Members::Messaging;
use C4::Members;
use C4::Output;
use C4::Reserves;
use C4::RotatingCollections;
use Koha::AuthorisedValues;
use Koha::BiblioFrameworks;
use Koha::Calendar;
use Koha::Checkouts;
use Koha::DateUtils;
use Koha::Holds;
use Koha::Items;
use Koha::Patrons;
my $query = new CGI;
#getting the template
my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
{
template_name => "circ/returns.tt",
query => $query,
type => "intranet",
authnotrequired => 0,
flagsrequired => { circulate => "circulate_remaining_permissions" },
}
);
my $sessionID = $query->cookie("CGISESSID");
my $session = get_session($sessionID);
# Print a reserve slip on this page
if ( $query->param('print_slip') ) {
$template->param(
print_slip => 1,
reserve_id => scalar $query->param('reserve_id'),
);
}
#####################
#Global vars
my $userenv = C4::Context->userenv;
my $userenv_branch = $userenv->{'branch'} // '';
my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
# Set up the item stack ....
my %returneditems;
my %riduedate;
my %riborrowernumber;
my @inputloop;
foreach ( $query->param ) {
my $counter;
if (/ri-(\d*)/) {
$counter = $1;
if ($counter > 20) {
next;
}
}
else {
next;
}
my %input;
my $barcode = $query->param("ri-$counter");
my $duedate = $query->param("dd-$counter");
my $borrowernumber = $query->param("bn-$counter");
$counter++;
# decode barcode ## Didn't we already decode them before passing them back last time??
$barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
$barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
######################
#Are these lines still useful ?
$returneditems{$counter} = $barcode;
$riduedate{$counter} = $duedate;
$riborrowernumber{$counter} = $borrowernumber;
#######################
$input{counter} = $counter;
$input{barcode} = $barcode;
$input{duedate} = $duedate;
$input{borrowernumber} = $borrowernumber;
push( @inputloop, \%input );
}
############
# Deal with the requests....
if ($query->param('WT-itemNumber')){
updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
}
if ( $query->param('reserve_id') ) {
my $itemnumber = $query->param('itemnumber');
my $borrowernumber = $query->param('borrowernumber');
my $reserve_id = $query->param('reserve_id');
my $diffBranchReturned = $query->param('diffBranch');
my $cancel_reserve = $query->param('cancel_reserve');
# fix up item type for display
my $item = Koha::Items->find( $itemnumber );
my $biblio = $item->biblio;
if ( $cancel_reserve ) {
my $hold = Koha::Holds->find( $reserve_id );
if ( $hold ) {
$hold->cancel( { charge_cancel_fee => !$forgivemanualholdsexpire } );
} # FIXME else?
} else {
my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
# diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
# i.e., whether to apply waiting status
ModReserveAffect( $itemnumber, $borrowernumber, $diffBranchSend, $reserve_id );
}
# check if we have other reserves for this document, if we have a return send the message of transfer
my ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
my $patron = Koha::Patrons->find( $nextreservinfo );
my $name = $patron ? $patron->surname . ", " . $patron->title . " " . $patron->firstname : '';
if ( $messages->{'transfert'} ) {
$template->param(
itemtitle => $biblio->title,
itemnumber => $item->itemnumber,
itembiblionumber => $biblio->biblionumber,
iteminfo => $biblio->author,
name => $name,
patron => $patron,
diffbranch => 1,
);
}
}
my $borrower;
my $returned = 0;
my $messages;
my $issue;
my $itemnumber;
my $barcode = $query->param('barcode');
my $exemptfine = $query->param('exemptfine');
if (
$exemptfine &&
!C4::Auth::haspermission(C4::Context->userenv->{'id'}, {'updatecharges' => 'writeoff'})
) {
# silently prevent unauthorized operator from forgiving overdue
# fines by manually tweaking form parameters
undef $exemptfine;
}
my $dropboxmode = $query->param('dropboxmode');
my $dotransfer = $query->param('dotransfer');
my $canceltransfer = $query->param('canceltransfer');
my $dest = $query->param('dest');
#dropbox: get last open day (today - 1)
my $dropboxdate = Koha::Checkouts::calculate_dropbox_date();
my $return_date_override = $query->param('return_date_override');
my $return_date_override_dt;
my $return_date_override_remember =
$query->param('return_date_override_remember');
if ($return_date_override) {
if ( C4::Context->preference('SpecifyReturnDate') ) {
$return_date_override_dt = eval {dt_from_string( $return_date_override ) };
if ( $return_date_override_dt ) {
# note that we've overriden the return date
$template->param( return_date_was_overriden => 1);
# Save the original format if we are remembering for this series
$template->param(
return_date_override => $return_date_override,
return_date_override_remember => 1
) if ($return_date_override_remember);
$return_date_override =
DateTime::Format::MySQL->format_datetime( $return_date_override_dt );
}
}
else {
$return_date_override = q{};
}
}
if ($dotransfer){
# An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
my $transferitem = $query->param('transferitem');
my $tobranch = $query->param('tobranch');
my $trigger = $query->param('trigger');
ModItemTransfer($transferitem, $userenv_branch, $tobranch, $trigger);
}
if ($canceltransfer){
$itemnumber=$query->param('itemnumber');
DeleteTransfer($itemnumber);
if($dest eq "ttr"){
print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
exit;
} else {
$template->param( transfercancelled => 1);
}
}
# actually return book and prepare item table.....
my $returnbranch;
if ($barcode) {
$barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
$barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
my $item = Koha::Items->find({ barcode => $barcode });
if ( $item ) {
$itemnumber = $item->itemnumber;
# Check if we should display a checkin message, based on the the item
# type of the checked in item
my $itemtype = Koha::ItemTypes->find( $item->effective_itemtype );
if ( $itemtype && $itemtype->checkinmsg ) {
$template->param(
checkinmsg => $itemtype->checkinmsg,
checkinmsgtype => $itemtype->checkinmsgtype,
);
}
# make sure return branch respects home branch circulation rules, default to homebranch
my $hbr = GetBranchItemRule($item->homebranch, $itemtype ? $itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
$returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $userenv_branch; # can be noreturn, homebranch or holdingbranch
my $materials = $item->materials;
my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => '', kohafield =>'items.materials', authorised_value => $materials });
$materials = $descriptions->{lib} // $materials;
my $checkout = $item->checkout;
my $biblio = $item->biblio;
$template->param(
title => $biblio->title,
homebranch => $item->homebranch,
holdingbranch => $item->holdingbranch,
returnbranch => $returnbranch,
author => $biblio->author,
itembarcode => $item->barcode,
itemtype => $item->effective_itemtype,
ccode => $item->ccode,
itembiblionumber => $biblio->biblionumber,
biblionumber => $biblio->biblionumber,
additional_materials => $materials,
issue => $checkout,
);
} # FIXME else we should not call AddReturn but set BadBarcode directly instead
my %input = (
counter => 0,
first => 1,
barcode => $barcode,
);
my $return_date = $dropboxmode ? $dropboxdate : $return_date_override_dt;
# do the return
( $returned, $messages, $issue, $borrower ) =
AddReturn( $barcode, $userenv_branch, $exemptfine, $return_date );
if ($returned) {
my $time_now = dt_from_string()->truncate( to => 'minute');
my $date_due_dt = dt_from_string( $issue->date_due, 'sql' );
my $duedate = $date_due_dt->strftime('%Y-%m-%d %H:%M');
$returneditems{0} = $barcode;
$riborrowernumber{0} = $borrower->{'borrowernumber'};
$riduedate{0} = $duedate;
$input{borrowernumber} = $borrower->{'borrowernumber'};
$input{duedate} = $duedate;
unless ( $dropboxmode ) {
$input{return_overdue} = 1 if (DateTime->compare($date_due_dt, dt_from_string()) == -1);
} else {
$input{return_overdue} = 1 if (DateTime->compare($date_due_dt, $dropboxdate) == -1);
}
push( @inputloop, \%input );
if ( C4::Context->preference("FineNotifyAtCheckin") ) {
my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
my $balance = $patron->account->balance;
if ($balance > 0) {
$template->param( fines => sprintf("%.2f", $balance) );
$template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
}
}
if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
#Check for waiting holds
my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
my $waiting_holds = $patron->holds->search({ found => 'W', branchcode => $userenv_branch })->count;
if ($waiting_holds > 0) {
$template->param(
waiting_holds => $waiting_holds,
holdsborrowernumber => $borrower->{'borrowernumber'},
holdsfirstname => $borrower->{'firstname'},
holdssurname => $borrower->{'surname'},
);
}
}
} elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} ) {
$input{duedate} = 0;
$returneditems{0} = $barcode;
$riduedate{0} = 0;
push( @inputloop, \%input );
}
$template->param( privacy => $borrower->{privacy} );
}
$template->param( inputloop => \@inputloop );
my $found = 0;
my $waiting = 0;
my $reserved = 0;
# new op dev : we check if the document must be returned to his homebranch directly,
# if the document is transferred, we have warning message .
if ( $messages->{'WasTransfered'} ) {
$template->param(
found => 1,
transfer => 1,
itemnumber => $itemnumber,
);
}
if ( $messages->{'NeedsTransfer'} ){
$template->param(
found => 1,
needstransfer => $messages->{'NeedsTransfer'},
trigger => $messages->{'TransferTrigger'},
itemnumber => $itemnumber,
);
}
if ( $messages->{'Wrongbranch'} ){
$template->param(
wrongbranch => 1,
rightbranch => $messages->{'Wrongbranch'}->{'Rightbranch'},
);
}
# case of wrong transfert, if the document wasn't transferred to the right library (according to branchtransfer (tobranch) BDD)
if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
$template->param(
WrongTransfer => 1,
TransferWaitingAt => $messages->{'WrongTransfer'},
WrongTransferItem => $messages->{'WrongTransferItem'},
itemnumber => $itemnumber,
);
my $reserve = $messages->{'ResFound'};
if ( $reserve ) {
my $patron = Koha::Patrons->find( $reserve->{'borrowernumber'} );
my $name = $patron->surname . ", " . $patron->title . " " . $patron->firstname;
$template->param(
patron => $patron,
);
}
$template->param(
wtransfertFrom => $userenv_branch,
);
}
#
# reserve found and item arrived at the expected branch
#
if ( $messages->{'ResFound'}) {
my $reserve = $messages->{'ResFound'};
my $patron = Koha::Patrons->find( $reserve->{borrowernumber} );
my $holdmsgpreferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $reserve->{'borrowernumber'}, message_name => 'Hold_Filled' } );
my $branchCheck = ( $userenv_branch eq $reserve->{branchcode} );
if ( $reserve->{'ResFound'} eq "Reserved" && C4::Context->preference('HoldsAutoFill') ) {
my $item = Koha::Items->find( $itemnumber );
my $biblio = $item->biblio;
my $diffBranchSend = !$branchCheck ? $reserve->{branchcode} : undef;
ModReserveAffect( $reserve->{itemnumber}, $reserve->{borrowernumber}, $diffBranchSend, $reserve->{reserve_id} );
my ( $messages, $nextreservinfo ) = GetOtherReserves($reserve->{itemnumber});
$template->param(
hold_auto_filled => 1,
print_slip => C4::Context->preference('HoldsAutoFillPrintSlip'),
reserve_id => $nextreservinfo->{reserve_id},
);
if ( $messages->{'transfert'} ) {
$template->param(
itemtitle => $biblio->title,
itemnumber => $item->itemnumber,
itembiblionumber => $biblio->biblionumber,
iteminfo => $biblio->author,
diffbranch => 1,
);
}
}
elsif ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
if ( $reserve->{'ResFound'} eq "Waiting" ) {
$template->param(
waiting => $branchCheck ? 1 : undef,
);
} elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
$template->param(
intransit => $branchCheck ? undef : 1,
transfertodo => $branchCheck ? undef : 1,
reserve_id => $reserve->{reserve_id},
reserved => 1,
);
}
} # else { ; } # error?
# same params for Waiting or Reserved
$template->param(
found => 1,
patron => $patron,
barcode => $barcode,
destbranch => $reserve->{'branchcode'},
itemnumber => $reserve->{'itemnumber'},
reservenotes => $reserve->{'reservenotes'},
reserve_id => $reserve->{reserve_id},
bormessagepref => $holdmsgpreferences->{'transports'},
);
}
# Error Messages
my @errmsgloop;
foreach my $code ( keys %$messages ) {
my %err;
my $exit_required_p = 0;
if ( $code eq 'BadBarcode' ) {
$err{badbarcode} = 1;
$err{msg} = $messages->{'BadBarcode'};
}
elsif ( $code eq 'NotIssued' ) {
$err{notissued} = 1;
$err{msg} = '';
}
elsif ( $code eq 'LocalUse' ) {
$err{localuse} = 1;
}
elsif ( $code eq 'WasLost' ) {
$err{waslost} = 1;
$exit_required_p = 1 if C4::Context->preference("BlockReturnOfLostItems");
}
elsif ( $code eq 'LostItemFeeRefunded' ) {
$template->param( LostItemFeeRefunded => 1 );
}
elsif ( $code eq 'ResFound' ) {
; # FIXME... anything to do here?
}
elsif ( $code eq 'WasReturned' ) {
; # FIXME... anything to do here?
}
elsif ( $code eq 'WasTransfered' ) {
; # FIXME... anything to do here?
}
elsif ( $code eq 'withdrawn' ) {
$err{withdrawn} = 1;
$exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
}
elsif ( $code eq 'WrongTransfer' ) {
; # FIXME... anything to do here?
}
elsif ( $code eq 'WrongTransferItem' ) {
; # FIXME... anything to do here?
}
elsif ( $code eq 'NeedsTransfer' ) {
}
elsif ( $code eq 'TransferTrigger' ) {
; # Handled alongside NeedsTransfer
}
elsif ( $code eq 'Wrongbranch' ) {
}
elsif ( $code eq 'Debarred' ) {
$err{debarred} = $messages->{'Debarred'};
$err{debarcardnumber} = $borrower->{cardnumber};
$err{debarborrowernumber} = $borrower->{borrowernumber};
$err{debarname} = "$borrower->{firstname} $borrower->{surname}";
}
elsif ( $code eq 'PrevDebarred' ) {
$err{prevdebarred} = $messages->{'PrevDebarred'};
}
elsif ( $code eq 'ForeverDebarred' ) {
$err{foreverdebarred} = $messages->{'ForeverDebarred'};
}
elsif ( $code eq 'ItemLocationUpdated' ) {
$err{ItemLocationUpdated} = $messages->{ItemLocationUpdated};
}
elsif ( $code eq 'NotForLoanStatusUpdated' ) {
$err{NotForLoanStatusUpdated} = $messages->{NotForLoanStatusUpdated};
}
elsif ( $code eq 'DataCorrupted' ) {
$err{data_corrupted} = 1;
}
elsif ( $code eq 'ReturnClaims' ) {
$template->param( ReturnClaims => $messages->{ReturnClaims} );
} else {
die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
# This forces the issue of staying in sync w/ Circulation.pm
}
if (%err) {
push( @errmsgloop, \%err );
}
last if $exit_required_p;
}
$template->param( errmsgloop => \@errmsgloop );
#set up so only the last 8 returned items display (make for faster loading pages)
my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
my $count = 0;
my @riloop;
my $shelflocations =
{ map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
foreach ( sort { $a <=> $b } keys %returneditems ) {
my %ri;
if ( $count++ < $returned_counter ) {
my $bar_code = $returneditems{$_};
if ($riduedate{$_}) {
my $duedate = dt_from_string( $riduedate{$_}, 'sql');
$ri{year} = $duedate->year();
$ri{month} = $duedate->month();
$ri{day} = $duedate->day();
$ri{hour} = $duedate->hour();
$ri{minute} = $duedate->minute();
$ri{duedate} = output_pref($duedate);
my $patron = Koha::Patrons->find( $riborrowernumber{$_} );
unless ( $dropboxmode ) {
$ri{return_overdue} = 1 if (DateTime->compare($duedate, dt_from_string()) == -1);
} else {
$ri{return_overdue} = 1 if (DateTime->compare($duedate, $dropboxdate) == -1);
}
$ri{patron} = $patron,
$ri{borissuescount} = $patron->checkouts->count;
}
else {
$ri{borrowernumber} = $riborrowernumber{$_};
}
my $item = Koha::Items->find({ barcode => $bar_code });
next unless $item; # FIXME The item has been deleted in the meantime,
# we could handle that better displaying a message in the template
my $biblio = $item->biblio;
# FIXME pass $item to the template and we are done here...
$ri{itembiblionumber} = $biblio->biblionumber;
$ri{itemtitle} = $biblio->title;
$ri{subtitle} = $biblio->subtitle;
$ri{part_name} = $biblio->part_name;
$ri{part_number} = $biblio->part_number;
$ri{itemauthor} = $biblio->author;
$ri{itemcallnumber} = $item->itemcallnumber;
$ri{dateaccessioned} = $item->dateaccessioned;
$ri{recordtype} = $biblio->itemtype;
$ri{itemtype} = $item->itype;
$ri{itemnote} = $item->itemnotes;
$ri{itemnotes_nonpublic} = $item->itemnotes_nonpublic;
$ri{ccode} = $item->ccode;
$ri{enumchron} = $item->enumchron;
$ri{itemnumber} = $item->itemnumber;
$ri{barcode} = $bar_code;
$ri{homebranch} = $item->homebranch;
$ri{holdingbranch} = $item->holdingbranch;
$ri{location} = $item->location;
my $shelfcode = $ri{'location'};
$ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
}
else {
last;
}
push @riloop, \%ri;
}
$template->param(
riloop => \@riloop,
errmsgloop => \@errmsgloop,
exemptfine => $exemptfine,
dropboxmode => $dropboxmode,
dropboxdate => $dropboxdate,
forgivemanualholdsexpire => $forgivemanualholdsexpire,
overduecharges => $overduecharges,
AudioAlerts => C4::Context->preference("AudioAlerts"),
);
if ( $barcode ) {
my $item_from_barcode = Koha::Items->find({barcode => $barcode }); # How many times do we fetch this item?!?
if ( $item_from_barcode ) {
$itemnumber = $item_from_barcode->itemnumber;
my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
if ( $holdingBranch and $collectionBranch ) {
$holdingBranch //= '';
$collectionBranch //= $returnbranch;
if ( ! ( $holdingBranch eq $collectionBranch ) ) {
$template->param(
collectionItemNeedsTransferred => 1,
collectionBranch => $collectionBranch,
itemnumber => $itemnumber,
);
}
}
}
}
# Checking if there is a Fast Cataloging Framework
$template->param( fast_cataloging => 1 ) if Koha::BiblioFrameworks->find( 'FA' );
# actually print the page!
output_html_with_http_headers $query, $cookie, $template->output;
View git blame Copy permalink