3 # Copyright 2000-2002 Katipo Communications
5 # 2007-2010 BibLibre, Paul POULAIN
7 # 2011 PTFS-Europe Ltd.
9 # This file is part of Koha.
11 # Koha is free software; you can redistribute it and/or modify it
12 # under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 3 of the License, or
14 # (at your option) any later version.
16 # Koha is distributed in the hope that it will be useful, but
17 # WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License
22 # along with Koha; if not, see <http://www.gnu.org/licenses>.
26 script to execute returns of books
32 # FIXME There are weird things going on with $patron and $borrowernumber in this script
37 use C4::Auth qw( get_template_and_user get_session haspermission );
38 use C4::Circulation qw( barcodedecode GetBranchItemRule AddReturn updateWrongTransfer LostItem );
40 use C4::Items qw( ModItemTransfer );
41 use C4::Members::Messaging;
43 use C4::Output qw( output_html_with_http_headers );
44 use C4::Reserves qw( ModReserve ModReserveAffect GetOtherReserves );
45 use C4::RotatingCollections;
46 use Koha::AuthorisedValues;
47 use Koha::BiblioFrameworks;
50 use Koha::DateUtils qw( dt_from_string output_pref );
53 use Koha::Item::Transfers;
59 my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
61 template_name => "circ/returns.tt",
64 flagsrequired => { circulate => "circulate_remaining_permissions" },
68 my $sessionID = $query->cookie("CGISESSID");
69 my $session = get_session($sessionID);
70 my $desk_id = C4::Context->userenv->{"desk_id"} || '';
72 # Print a reserve slip on this page
73 if ( $query->param('print_slip') ) {
76 reserve_id => scalar $query->param('reserve_id'),
81 if ( $query->param('recall_slip') ) {
84 recall_id => scalar $query->param('recall_id'),
91 my $userenv = C4::Context->userenv;
92 my $userenv_branch = $userenv->{'branch'} // '';
93 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
95 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') eq 'production');
97 # Set up the item stack ....
100 my %riborrowernumber;
102 foreach ( $query->param ) {
115 my $barcode = $query->param("ri-$counter");
116 my $duedate = $query->param("dd-$counter");
117 my $borrowernumber = $query->param("bn-$counter");
120 # decode barcode ## Didn't we already decode them before passing them back last time??
121 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
122 $barcode = barcodedecode($barcode) if $barcode;
124 ######################
125 #Are these lines still useful ?
126 $returneditems{$counter} = $barcode;
127 $riduedate{$counter} = $duedate;
128 $riborrowernumber{$counter} = $borrowernumber;
130 #######################
131 $input{counter} = $counter;
132 $input{barcode} = $barcode;
133 $input{duedate} = $duedate;
134 $input{borrowernumber} = $borrowernumber;
135 push( @inputloop, \%input );
139 # Deal with the requests....
140 my $itemnumber = $query->param('itemnumber');
141 if ( $query->param('reserve_id') ) {
142 my $borrowernumber = $query->param('borrowernumber');
143 my $reserve_id = $query->param('reserve_id');
144 my $diffBranchReturned = $query->param('diffBranch');
145 my $cancel_reserve = $query->param('cancel_reserve');
146 # fix up item type for display
147 my $item = Koha::Items->find( $itemnumber );
148 my $biblio = $item->biblio;
150 if ( $cancel_reserve ) {
151 my $hold = Koha::Holds->find( $reserve_id );
153 $hold->cancel( { charge_cancel_fee => !$forgivemanualholdsexpire } );
156 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
157 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
158 # i.e., whether to apply waiting status
159 ModReserveAffect( $itemnumber, $borrowernumber, $diffBranchSend, $reserve_id, $desk_id );
161 # check if we have other reserves for this document, if we have a return send the message of transfer
162 my ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
164 my $patron = Koha::Patrons->find( $nextreservinfo );
165 if ( $messages->{'transfert'} ) {
167 itemtitle => $biblio->title,
168 itembiblionumber => $biblio->biblionumber,
169 iteminfo => $biblio->author,
176 if ( $query->param('recall_id') ) {
177 my $recall = Koha::Recalls->find( scalar $query->param('recall_id') );
178 my $itemnumber = $query->param('itemnumber');
179 my $return_branch = $query->param('returnbranch');
182 if ( !$recall->item_level_recall ) {
183 $item = Koha::Items->find( $itemnumber );
186 if ( $recall->branchcode ne $return_branch ) {
187 $recall->start_transfer({ item => $item }) if !$recall->in_transit;
189 my $expirationdate = $recall->calc_expirationdate;
190 $recall->set_waiting({ item => $item, expirationdate => $expirationdate }) if !$recall->waiting;
198 my $barcode = $query->param('barcode');
199 my $exemptfine = $query->param('exemptfine');
202 !C4::Auth::haspermission(C4::Context->userenv->{'id'}, {'updatecharges' => 'writeoff'})
204 # silently prevent unauthorized operator from forgiving overdue
205 # fines by manually tweaking form parameters
208 my $dropboxmode = $query->param('dropboxmode');
209 my $dotransfer = $query->param('dotransfer');
210 my $canceltransfer = $query->param('canceltransfer');
211 my $transit = $query->param('transit');
212 my $dest = $query->param('dest');
213 #dropbox: get last open day (today - 1)
214 my $dropboxdate = Koha::Checkouts::calculate_dropbox_date();
216 my $return_date_override = $query->param('return_date_override');
217 my $return_date_override_dt;
218 my $return_date_override_remember =
219 $query->param('return_date_override_remember');
220 if ($return_date_override) {
221 if ( C4::Context->preference('SpecifyReturnDate') ) {
222 $return_date_override_dt = eval {dt_from_string( $return_date_override ) };
223 if ( $return_date_override_dt ) {
224 # note that we've overriden the return date
225 $template->param( return_date_was_overriden => 1);
226 # Save the original format if we are remembering for this series
228 return_date_override => $return_date_override,
229 return_date_override_remember => 1
230 ) if ($return_date_override_remember);
232 $return_date_override =
233 DateTime::Format::MySQL->format_datetime( $return_date_override_dt );
237 $return_date_override = q{};
242 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
243 my $transferitem = $query->param('transferitem');
244 my $tobranch = $query->param('tobranch');
245 my $trigger = $query->param('trigger');
246 ModItemTransfer($transferitem, $userenv_branch, $tobranch, $trigger);
250 my $transfer = Koha::Item::Transfers->find($transit);
251 if ( $canceltransfer ) {
252 $transfer->cancel({ reason => 'Manual', force => 1});
253 my $recall_transfer_deleted = Koha::Recalls->find({ itemnumber => $itemnumber, status => 'T' });
254 if ( defined $recall_transfer_deleted ) {
255 $recall_transfer_deleted->revert_transfer;
257 $template->param( transfercancelled => 1);
261 } elsif ($canceltransfer){
262 my $item = Koha::Items->find($itemnumber);
263 my $transfer = $item->get_transfer;
264 $transfer->cancel({ reason => 'Manual', force => 1});
265 my $recall_transfer_deleted = Koha::Recalls->find({ itemnumber => $itemnumber, status => 'T' });
266 if ( defined $recall_transfer_deleted ) {
267 $recall_transfer_deleted->revert_transfer;
270 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
273 $template->param( transfercancelled => 1);
278 # actually return book and prepare item table.....
281 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
282 $barcode = barcodedecode($barcode) if $barcode;
283 my $item = Koha::Items->find({ barcode => $barcode });
286 $itemnumber = $item->itemnumber;
287 # Check if we should display a checkin message, based on the the item
288 # type of the checked in item
289 my $itemtype = Koha::ItemTypes->find( $item->effective_itemtype );
290 if ( $itemtype && $itemtype->checkinmsg ) {
292 checkinmsg => $itemtype->checkinmsg,
293 checkinmsgtype => $itemtype->checkinmsgtype,
297 # make sure return branch respects home branch circulation rules, default to homebranch
298 my $hbr = GetBranchItemRule($item->homebranch, $itemtype ? $itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
299 $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $userenv_branch; # can be noreturn, homebranch or holdingbranch
301 my $materials = $item->materials;
302 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => '', kohafield =>'items.materials', authorised_value => $materials });
303 $materials = $descriptions->{lib} // $materials;
305 my $checkout = $item->checkout;
306 my $biblio = $item->biblio;
308 title => $biblio->title,
309 returnbranch => $returnbranch,
310 author => $biblio->author,
311 itembiblionumber => $biblio->biblionumber,
312 biblionumber => $biblio->biblionumber,
313 additional_materials => $materials,
317 } # FIXME else we should not call AddReturn but set BadBarcode directly instead
325 my $return_date = $dropboxmode ? $dropboxdate : $return_date_override_dt;
327 # Block return if multi-part and confirm has not been received
329 C4::Context->preference("CircConfirmItemParts")
332 && !$query->param('multiple_confirm');
333 $template->param( 'multiple_confirmed' => 1 )
334 if $query->param('multiple_confirm');
337 ( $returned, $messages, $issue, $borrower ) =
338 AddReturn( $barcode, $userenv_branch, $exemptfine, $return_date )
339 unless $needs_confirm;
342 my $time_now = dt_from_string()->truncate( to => 'minute');
343 my $date_due_dt = dt_from_string( $issue->date_due, 'sql' );
344 my $duedate = $date_due_dt->strftime('%Y-%m-%d %H:%M');
345 $returneditems{0} = $barcode;
346 $riborrowernumber{0} = $borrower->{'borrowernumber'};
347 $riduedate{0} = $duedate;
348 $input{borrowernumber} = $borrower->{'borrowernumber'};
349 $input{duedate} = $duedate;
350 unless ( $dropboxmode ) {
351 $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, dt_from_string()) == -1);
353 $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, $dropboxdate) == -1);
355 push( @inputloop, \%input );
357 if ( C4::Context->preference("FineNotifyAtCheckin") ) {
358 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
359 my $balance = $patron->account->balance;
362 $template->param( fines => sprintf("%.2f", $balance) );
363 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
367 if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
368 #Check for waiting holds
369 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
370 my $waiting_holds = $patron->holds->search({ found => 'W', branchcode => $userenv_branch })->count;
371 if ($waiting_holds > 0) {
373 waiting_holds => $waiting_holds,
374 holdsborrowernumber => $borrower->{'borrowernumber'},
375 holdsfirstname => $borrower->{'firstname'},
376 holdssurname => $borrower->{'surname'},
380 } elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} and !$needs_confirm ) {
382 $returneditems{0} = $barcode;
384 push( @inputloop, \%input );
386 $template->param( privacy => $borrower->{privacy} );
388 if ( $needs_confirm ) {
389 $template->param( needs_confirm => $needs_confirm );
392 $template->param( inputloop => \@inputloop );
399 # new op dev : we check if the document must be returned to his homebranch directly,
400 # if the document is transferred, we have warning message .
402 if ( $messages->{'WasTransfered'} ) {
405 transfer => $messages->{'WasTransfered'},
406 trigger => $messages->{'TransferTrigger'},
407 itemnumber => $itemnumber,
411 if ( $messages->{'NeedsTransfer'} ){
414 needstransfer => $messages->{'NeedsTransfer'},
415 trigger => $messages->{'TransferTrigger'},
419 if ( $messages->{'Wrongbranch'} ){
422 rightbranch => $messages->{'Wrongbranch'}->{'Rightbranch'},
426 # case of wrong transfert, if the document wasn't transferred to the right library (according to branchtransfer (tobranch) BDD)
428 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
430 # Trigger modal to prompt librarian
433 TransferWaitingAt => $messages->{'WrongTransfer'},
434 WrongTransferItem => $messages->{'WrongTransferItem'},
435 trigger => $messages->{'TransferTrigger'},
438 # Update the transfer to reflect the new item holdingbranch
439 my $new_transfer = updateWrongTransfer($messages->{'WrongTransferItem'},$messages->{'WrongTransfer'}, $userenv_branch);
441 NewTransfer => $new_transfer->id
444 my $reserve = $messages->{'ResFound'};
446 my $patron = Koha::Patrons->find( $reserve->{'borrowernumber'} );
454 # reserve found and item arrived at the expected branch
456 if ( $messages->{'ResFound'} ) {
457 my $reserve = $messages->{'ResFound'};
458 my $patron = Koha::Patrons->find( $reserve->{borrowernumber} );
459 my $holdmsgpreferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $reserve->{'borrowernumber'}, message_name => 'Hold_Filled' } );
460 my $branchCheck = ( $userenv_branch eq $reserve->{branchcode} );
461 if ( $reserve->{'ResFound'} eq "Waiting" ) {
463 waiting => $branchCheck ? 1 : undef,
465 } elsif ( C4::Context->preference('HoldsAutoFill') ) {
466 my $item = Koha::Items->find( $itemnumber );
467 my $biblio = $item->biblio;
469 my $diffBranchSend = !$branchCheck ? $reserve->{branchcode} : undef;
470 ModReserveAffect( $reserve->{itemnumber}, $reserve->{borrowernumber}, $diffBranchSend, $reserve->{reserve_id}, $desk_id );
471 my ( $messages, $nextreservinfo ) = GetOtherReserves($reserve->{itemnumber});
474 hold_auto_filled => 1,
475 print_slip => C4::Context->preference('HoldsAutoFillPrintSlip'),
476 reserve_id => $nextreservinfo->{reserve_id},
479 if ( $messages->{'transfert'} ) {
481 itemtitle => $biblio->title,
482 itembiblionumber => $biblio->biblionumber,
483 iteminfo => $biblio->author,
489 intransit => $branchCheck ? undef : 1,
490 transfertodo => $branchCheck ? undef : 1,
491 reserve_id => $reserve->{reserve_id},
496 # same params for Waiting or Reserved
501 destbranch => $reserve->{'branchcode'},
502 reservenotes => $reserve->{'reservenotes'},
503 reserve_id => $reserve->{reserve_id},
504 bormessagepref => $holdmsgpreferences->{'transports'},
508 if ( $messages->{RecallFound} ) {
509 my $recall = $messages->{RecallFound};
510 if ( dt_from_string( $recall->timestamp ) == dt_from_string ) {
511 # we just updated this recall
512 $template->param( recall => $recall );
514 my $transferbranch = $messages->{RecallNeedsTransfer};
515 my $transfertodo = ( !$transferbranch or $transferbranch eq $recall->library->branchcode ) ? undef : 1;
519 recalled => $recall->waiting ? 0 : 1,
520 transfertodo => $transfertodo,
521 waitingrecall => $recall->waiting ? 1 : 0,
526 if ( $messages->{TransferredRecall} ) {
527 my $recall = $messages->{TransferredRecall};
529 # confirm transfer has arrived at the branch
530 my $transfer = Koha::Item::Transfers->search({ datearrived => { '!=' => undef }, itemnumber => $recall->itemnumber }, { order_by => { -desc => 'datearrived' } })->next;
532 # if transfer has completed, show popup to confirm as waiting
533 if ( defined $transfer and $transfer->tobranch eq $recall->branchcode ) {
544 foreach my $code ( keys %$messages ) {
546 my $exit_required_p = 0;
547 if ( $code eq 'BadBarcode' ) {
548 $err{badbarcode} = 1;
549 $err{msg} = $messages->{'BadBarcode'};
551 elsif ( $code eq 'NotIssued' ) {
555 elsif ( $code eq 'LocalUse' ) {
558 elsif ( $code eq 'WasLost' ) {
560 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfLostItems");
562 elsif ( $code eq 'LostItemFeeRefunded' ) {
563 $template->param( LostItemFeeRefunded => 1 );
565 elsif ( $code eq 'LostItemFeeCharged' ) {
566 $template->param( LostItemFeeCharged => 1 );
568 elsif ( $code eq 'LostItemFeeRestored' ) {
569 $template->param( LostItemFeeRestored => 1 );
571 elsif ( $code eq 'ResFound' ) {
572 ; # FIXME... anything to do here?
574 elsif ( $code eq 'WasReturned' ) {
575 ; # FIXME... anything to do here?
577 elsif ( $code eq 'WasTransfered' ) {
578 ; # FIXME... anything to do here?
580 elsif ( $code eq 'withdrawn' ) {
582 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
584 elsif ( $code eq 'WrongTransfer' ) {
585 ; # FIXME... anything to do here?
587 elsif ( $code eq 'WrongTransferItem' ) {
588 ; # FIXME... anything to do here?
590 elsif ( $code eq 'NeedsTransfer' ) {
592 elsif ( $code eq 'TransferTrigger' ) {
593 ; # Handled alongside NeedsTransfer
595 elsif ( $code eq 'TransferArrived' ) {
596 $err{transferred} = $messages->{'TransferArrived'};
598 elsif ( $code eq 'Wrongbranch' ) {
600 elsif ( $code eq 'Debarred' ) {
601 $err{debarred} = $messages->{'Debarred'};
602 $err{debarcardnumber} = $borrower->{cardnumber};
603 $err{debarborrowernumber} = $borrower->{borrowernumber};
604 $err{debarname} = "$borrower->{firstname} $borrower->{surname}";
606 elsif ( $code eq 'PrevDebarred' ) {
607 $err{prevdebarred} = $messages->{'PrevDebarred'};
609 elsif ( $code eq 'ForeverDebarred' ) {
610 $err{foreverdebarred} = $messages->{'ForeverDebarred'};
612 elsif ( $code eq 'ItemLocationUpdated' ) {
613 $err{ItemLocationUpdated} = $messages->{ItemLocationUpdated};
615 elsif ( $code eq 'NotForLoanStatusUpdated' ) {
616 $err{NotForLoanStatusUpdated} = $messages->{NotForLoanStatusUpdated};
618 elsif ( $code eq 'DataCorrupted' ) {
619 $err{data_corrupted} = 1;
621 elsif ( $code eq 'ReturnClaims' ) {
622 $template->param( ReturnClaims => $messages->{ReturnClaims} );
623 } elsif ( $code eq 'RecallFound' ) {
625 } elsif ( $code eq 'RecallNeedsTransfer' ) {
627 } elsif ( $code eq 'TransferredRecall' ) {
630 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
631 # This forces the issue of staying in sync w/ Circulation.pm
634 push( @errmsgloop, \%err );
636 last if $exit_required_p;
638 $template->param( errmsgloop => \@errmsgloop );
640 #set up so only the last 8 returned items display (make for faster loading pages)
641 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
645 { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
646 foreach ( sort { $a <=> $b } keys %returneditems ) {
648 if ( $count++ < $returned_counter ) {
649 my $bar_code = $returneditems{$_};
650 if ($riduedate{$_}) {
651 my $duedate = dt_from_string( $riduedate{$_}, 'sql');
652 $ri{year} = $duedate->year();
653 $ri{month} = $duedate->month();
654 $ri{day} = $duedate->day();
655 $ri{hour} = $duedate->hour();
656 $ri{minute} = $duedate->minute();
657 $ri{duedate} = output_pref($duedate);
658 my $patron = Koha::Patrons->find( $riborrowernumber{$_} );
659 unless ( $dropboxmode ) {
660 $ri{return_overdue} = 1 if (DateTime->compare($duedate, dt_from_string()) == -1);
662 $ri{return_overdue} = 1 if (DateTime->compare($duedate, $dropboxdate) == -1);
664 $ri{patron} = $patron,
665 $ri{borissuescount} = $patron->checkouts->count;
668 $ri{borrowernumber} = $riborrowernumber{$_};
671 my $item = Koha::Items->find({ barcode => $bar_code });
672 next unless $item; # FIXME The item has been deleted in the meantime,
673 # we could handle that better displaying a message in the template
675 my $biblio = $item->biblio;
676 # FIXME pass $item to the template and we are done here...
677 $ri{itembiblionumber} = $biblio->biblionumber;
678 $ri{itemtitle} = $biblio->title;
679 $ri{subtitle} = $biblio->subtitle;
680 $ri{part_name} = $biblio->part_name;
681 $ri{part_number} = $biblio->part_number;
682 $ri{itemauthor} = $biblio->author;
683 $ri{itemcallnumber} = $item->itemcallnumber;
684 $ri{dateaccessioned} = $item->dateaccessioned;
685 $ri{recordtype} = $biblio->itemtype;
686 $ri{itemtype} = $item->itype;
687 $ri{itemnote} = $item->itemnotes;
688 $ri{itemnotes_nonpublic} = $item->itemnotes_nonpublic;
689 $ri{ccode} = $item->ccode;
690 $ri{enumchron} = $item->enumchron;
691 $ri{itemnumber} = $item->itemnumber;
692 $ri{barcode} = $bar_code;
693 $ri{homebranch} = $item->homebranch;
694 $ri{transferbranch} = $item->get_transfer ? $item->get_transfer->tobranch : '';
695 $ri{damaged} = $item->damaged;
697 $ri{location} = $item->location;
698 my $shelfcode = $ri{'location'};
699 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
710 errmsgloop => \@errmsgloop,
711 exemptfine => $exemptfine,
712 dropboxmode => $dropboxmode,
713 dropboxdate => $dropboxdate,
714 forgivemanualholdsexpire => $forgivemanualholdsexpire,
715 overduecharges => $overduecharges,
716 AudioAlerts => C4::Context->preference("AudioAlerts"),
720 my $item_from_barcode = Koha::Items->find({barcode => $barcode }); # How many times do we fetch this item?!?
721 if ( $item_from_barcode ) {
722 $itemnumber = $item_from_barcode->itemnumber;
723 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
724 if ( $holdingBranch and $collectionBranch ) {
725 $holdingBranch //= '';
726 $collectionBranch //= $returnbranch;
727 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
729 collectionItemNeedsTransferred => 1,
730 collectionBranch => $collectionBranch,
737 $template->param( itemnumber => $itemnumber );
739 # Checking if there is a Fast Cataloging Framework
740 $template->param( fast_cataloging => 1 ) if Koha::BiblioFrameworks->find( 'FA' );
742 # actually print the page!
743 output_html_with_http_headers $query, $cookie, $template->output;