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/:DEFAULT get_session/;
45 use C4::Koha; # FIXME : is it still useful ?
46 use C4::Members::Messaging;
50 use C4::RotatingCollections;
51 use Koha::AuthorisedValues;
52 use Koha::BiblioFrameworks;
58 use Koha::Item::Transfers;
64 my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
66 template_name => "circ/returns.tt",
69 flagsrequired => { circulate => "circulate_remaining_permissions" },
73 my $sessionID = $query->cookie("CGISESSID");
74 my $session = get_session($sessionID);
75 my $desk_id = C4::Context->userenv->{"desk_id"} || '';
77 # Print a reserve slip on this page
78 if ( $query->param('print_slip') ) {
81 reserve_id => scalar $query->param('reserve_id'),
87 my $userenv = C4::Context->userenv;
88 my $userenv_branch = $userenv->{'branch'} // '';
89 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
91 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') eq 'production');
93 # Set up the item stack ....
98 foreach ( $query->param ) {
111 my $barcode = $query->param("ri-$counter");
112 my $duedate = $query->param("dd-$counter");
113 my $borrowernumber = $query->param("bn-$counter");
116 # decode barcode ## Didn't we already decode them before passing them back last time??
117 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
118 $barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
120 ######################
121 #Are these lines still useful ?
122 $returneditems{$counter} = $barcode;
123 $riduedate{$counter} = $duedate;
124 $riborrowernumber{$counter} = $borrowernumber;
126 #######################
127 $input{counter} = $counter;
128 $input{barcode} = $barcode;
129 $input{duedate} = $duedate;
130 $input{borrowernumber} = $borrowernumber;
131 push( @inputloop, \%input );
135 # Deal with the requests....
136 my $itemnumber = $query->param('itemnumber');
137 if ( $query->param('reserve_id') ) {
138 my $borrowernumber = $query->param('borrowernumber');
139 my $reserve_id = $query->param('reserve_id');
140 my $diffBranchReturned = $query->param('diffBranch');
141 my $cancel_reserve = $query->param('cancel_reserve');
142 # fix up item type for display
143 my $item = Koha::Items->find( $itemnumber );
144 my $biblio = $item->biblio;
146 if ( $cancel_reserve ) {
147 my $hold = Koha::Holds->find( $reserve_id );
149 $hold->cancel( { charge_cancel_fee => !$forgivemanualholdsexpire } );
152 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
153 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
154 # i.e., whether to apply waiting status
155 ModReserveAffect( $itemnumber, $borrowernumber, $diffBranchSend, $reserve_id, $desk_id );
157 # check if we have other reserves for this document, if we have a return send the message of transfer
158 my ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
160 my $patron = Koha::Patrons->find( $nextreservinfo );
161 if ( $messages->{'transfert'} ) {
163 itemtitle => $biblio->title,
164 itembiblionumber => $biblio->biblionumber,
165 iteminfo => $biblio->author,
176 my $barcode = $query->param('barcode');
177 my $exemptfine = $query->param('exemptfine');
180 !C4::Auth::haspermission(C4::Context->userenv->{'id'}, {'updatecharges' => 'writeoff'})
182 # silently prevent unauthorized operator from forgiving overdue
183 # fines by manually tweaking form parameters
186 my $dropboxmode = $query->param('dropboxmode');
187 my $dotransfer = $query->param('dotransfer');
188 my $canceltransfer = $query->param('canceltransfer');
189 my $transit = $query->param('transit');
190 my $dest = $query->param('dest');
191 #dropbox: get last open day (today - 1)
192 my $dropboxdate = Koha::Checkouts::calculate_dropbox_date();
194 my $return_date_override = $query->param('return_date_override');
195 my $return_date_override_dt;
196 my $return_date_override_remember =
197 $query->param('return_date_override_remember');
198 if ($return_date_override) {
199 if ( C4::Context->preference('SpecifyReturnDate') ) {
200 $return_date_override_dt = eval {dt_from_string( $return_date_override ) };
201 if ( $return_date_override_dt ) {
202 # note that we've overriden the return date
203 $template->param( return_date_was_overriden => 1);
204 # Save the original format if we are remembering for this series
206 return_date_override => $return_date_override,
207 return_date_override_remember => 1
208 ) if ($return_date_override_remember);
210 $return_date_override =
211 DateTime::Format::MySQL->format_datetime( $return_date_override_dt );
215 $return_date_override = q{};
220 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
221 my $transferitem = $query->param('transferitem');
222 my $tobranch = $query->param('tobranch');
223 my $trigger = $query->param('trigger');
224 ModItemTransfer($transferitem, $userenv_branch, $tobranch, $trigger);
228 my $transfer = Koha::Item::Transfers->find($transit);
229 if ( $canceltransfer ) {
230 $transfer->cancel({ reason => 'Manual', force => 1});
231 $template->param( transfercancelled => 1);
235 } elsif ($canceltransfer){
236 my $item = Koha::Items->find($itemnumber);
237 my $transfer = $item->get_transfer;
238 $transfer->cancel({ reason => 'Manual', force => 1});
240 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
243 $template->param( transfercancelled => 1);
248 # actually return book and prepare item table.....
251 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
252 $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
253 my $item = Koha::Items->find({ barcode => $barcode });
256 $itemnumber = $item->itemnumber;
257 # Check if we should display a checkin message, based on the the item
258 # type of the checked in item
259 my $itemtype = Koha::ItemTypes->find( $item->effective_itemtype );
260 if ( $itemtype && $itemtype->checkinmsg ) {
262 checkinmsg => $itemtype->checkinmsg,
263 checkinmsgtype => $itemtype->checkinmsgtype,
267 # make sure return branch respects home branch circulation rules, default to homebranch
268 my $hbr = GetBranchItemRule($item->homebranch, $itemtype ? $itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
269 $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $userenv_branch; # can be noreturn, homebranch or holdingbranch
271 my $materials = $item->materials;
272 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => '', kohafield =>'items.materials', authorised_value => $materials });
273 $materials = $descriptions->{lib} // $materials;
275 my $checkout = $item->checkout;
276 my $biblio = $item->biblio;
278 title => $biblio->title,
279 returnbranch => $returnbranch,
280 author => $biblio->author,
281 itembiblionumber => $biblio->biblionumber,
282 biblionumber => $biblio->biblionumber,
283 additional_materials => $materials,
287 } # FIXME else we should not call AddReturn but set BadBarcode directly instead
295 my $return_date = $dropboxmode ? $dropboxdate : $return_date_override_dt;
297 # Block return if multi-part and confirm has not been received
299 C4::Context->preference("CircConfirmItemParts")
302 && !$query->param('multiple_confirm');
303 $template->param( 'multiple_confirmed' => 1 )
304 if $query->param('multiple_confirm');
307 ( $returned, $messages, $issue, $borrower ) =
308 AddReturn( $barcode, $userenv_branch, $exemptfine, $return_date )
309 unless $needs_confirm;
312 my $time_now = dt_from_string()->truncate( to => 'minute');
313 my $date_due_dt = dt_from_string( $issue->date_due, 'sql' );
314 my $duedate = $date_due_dt->strftime('%Y-%m-%d %H:%M');
315 $returneditems{0} = $barcode;
316 $riborrowernumber{0} = $borrower->{'borrowernumber'};
317 $riduedate{0} = $duedate;
318 $input{borrowernumber} = $borrower->{'borrowernumber'};
319 $input{duedate} = $duedate;
320 unless ( $dropboxmode ) {
321 $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, dt_from_string()) == -1);
323 $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, $dropboxdate) == -1);
325 push( @inputloop, \%input );
327 if ( C4::Context->preference("FineNotifyAtCheckin") ) {
328 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
329 my $balance = $patron->account->balance;
332 $template->param( fines => sprintf("%.2f", $balance) );
333 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
337 if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
338 #Check for waiting holds
339 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
340 my $waiting_holds = $patron->holds->search({ found => 'W', branchcode => $userenv_branch })->count;
341 if ($waiting_holds > 0) {
343 waiting_holds => $waiting_holds,
344 holdsborrowernumber => $borrower->{'borrowernumber'},
345 holdsfirstname => $borrower->{'firstname'},
346 holdssurname => $borrower->{'surname'},
350 } elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} and !$needs_confirm ) {
352 $returneditems{0} = $barcode;
354 push( @inputloop, \%input );
356 $template->param( privacy => $borrower->{privacy} );
358 if ( $needs_confirm ) {
359 $template->param( needs_confirm => $needs_confirm );
362 $template->param( inputloop => \@inputloop );
368 # new op dev : we check if the document must be returned to his homebranch directly,
369 # if the document is transferred, we have warning message .
371 if ( $messages->{'WasTransfered'} ) {
374 transfer => $messages->{'WasTransfered'},
375 trigger => $messages->{'TransferTrigger'},
376 itemnumber => $itemnumber,
380 if ( $messages->{'NeedsTransfer'} ){
383 needstransfer => $messages->{'NeedsTransfer'},
384 trigger => $messages->{'TransferTrigger'},
388 if ( $messages->{'Wrongbranch'} ){
391 rightbranch => $messages->{'Wrongbranch'}->{'Rightbranch'},
395 # case of wrong transfert, if the document wasn't transferred to the right library (according to branchtransfer (tobranch) BDD)
397 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
399 # Trigger modal to prompt librarian
402 TransferWaitingAt => $messages->{'WrongTransfer'},
403 WrongTransferItem => $messages->{'WrongTransferItem'},
404 trigger => $messages->{'TransferTrigger'},
407 # Update the transfer to reflect the new item holdingbranch
408 my $new_transfer = updateWrongTransfer($messages->{'WrongTransferItem'},$messages->{'WrongTransfer'}, $userenv_branch);
410 NewTransfer => $new_transfer->id
413 my $reserve = $messages->{'ResFound'};
415 my $patron = Koha::Patrons->find( $reserve->{'borrowernumber'} );
423 # reserve found and item arrived at the expected branch
425 if ( $messages->{'ResFound'}) {
426 my $reserve = $messages->{'ResFound'};
427 my $patron = Koha::Patrons->find( $reserve->{borrowernumber} );
428 my $holdmsgpreferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $reserve->{'borrowernumber'}, message_name => 'Hold_Filled' } );
429 my $branchCheck = ( $userenv_branch eq $reserve->{branchcode} );
430 if ( $reserve->{'ResFound'} eq "Waiting" ) {
432 waiting => $branchCheck ? 1 : undef,
434 } elsif ( C4::Context->preference('HoldsAutoFill') ) {
435 my $item = Koha::Items->find( $itemnumber );
436 my $biblio = $item->biblio;
438 my $diffBranchSend = !$branchCheck ? $reserve->{branchcode} : undef;
439 ModReserveAffect( $reserve->{itemnumber}, $reserve->{borrowernumber}, $diffBranchSend, $reserve->{reserve_id}, $desk_id );
440 my ( $messages, $nextreservinfo ) = GetOtherReserves($reserve->{itemnumber});
443 hold_auto_filled => 1,
444 print_slip => C4::Context->preference('HoldsAutoFillPrintSlip'),
445 reserve_id => $nextreservinfo->{reserve_id},
448 if ( $messages->{'transfert'} ) {
450 itemtitle => $biblio->title,
451 itembiblionumber => $biblio->biblionumber,
452 iteminfo => $biblio->author,
458 intransit => $branchCheck ? undef : 1,
459 transfertodo => $branchCheck ? undef : 1,
460 reserve_id => $reserve->{reserve_id},
465 # same params for Waiting or Reserved
470 destbranch => $reserve->{'branchcode'},
471 reservenotes => $reserve->{'reservenotes'},
472 reserve_id => $reserve->{reserve_id},
473 bormessagepref => $holdmsgpreferences->{'transports'},
479 foreach my $code ( keys %$messages ) {
481 my $exit_required_p = 0;
482 if ( $code eq 'BadBarcode' ) {
483 $err{badbarcode} = 1;
484 $err{msg} = $messages->{'BadBarcode'};
486 elsif ( $code eq 'NotIssued' ) {
490 elsif ( $code eq 'LocalUse' ) {
493 elsif ( $code eq 'WasLost' ) {
495 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfLostItems");
497 elsif ( $code eq 'LostItemFeeRefunded' ) {
498 $template->param( LostItemFeeRefunded => 1 );
500 elsif ( $code eq 'LostItemFeeCharged' ) {
501 $template->param( LostItemFeeCharged => 1 );
503 elsif ( $code eq 'LostItemFeeRestored' ) {
504 $template->param( LostItemFeeRestored => 1 );
506 elsif ( $code eq 'ResFound' ) {
507 ; # FIXME... anything to do here?
509 elsif ( $code eq 'WasReturned' ) {
510 ; # FIXME... anything to do here?
512 elsif ( $code eq 'WasTransfered' ) {
513 ; # FIXME... anything to do here?
515 elsif ( $code eq 'withdrawn' ) {
517 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
519 elsif ( $code eq 'WrongTransfer' ) {
520 ; # FIXME... anything to do here?
522 elsif ( $code eq 'WrongTransferItem' ) {
523 ; # FIXME... anything to do here?
525 elsif ( $code eq 'NeedsTransfer' ) {
527 elsif ( $code eq 'TransferTrigger' ) {
528 ; # Handled alongside NeedsTransfer
530 elsif ( $code eq 'TransferArrived' ) {
531 $err{transferred} = $messages->{'TransferArrived'};
533 elsif ( $code eq 'Wrongbranch' ) {
535 elsif ( $code eq 'Debarred' ) {
536 $err{debarred} = $messages->{'Debarred'};
537 $err{debarcardnumber} = $borrower->{cardnumber};
538 $err{debarborrowernumber} = $borrower->{borrowernumber};
539 $err{debarname} = "$borrower->{firstname} $borrower->{surname}";
541 elsif ( $code eq 'PrevDebarred' ) {
542 $err{prevdebarred} = $messages->{'PrevDebarred'};
544 elsif ( $code eq 'ForeverDebarred' ) {
545 $err{foreverdebarred} = $messages->{'ForeverDebarred'};
547 elsif ( $code eq 'ItemLocationUpdated' ) {
548 $err{ItemLocationUpdated} = $messages->{ItemLocationUpdated};
550 elsif ( $code eq 'NotForLoanStatusUpdated' ) {
551 $err{NotForLoanStatusUpdated} = $messages->{NotForLoanStatusUpdated};
553 elsif ( $code eq 'DataCorrupted' ) {
554 $err{data_corrupted} = 1;
556 elsif ( $code eq 'ReturnClaims' ) {
557 $template->param( ReturnClaims => $messages->{ReturnClaims} );
559 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
560 # This forces the issue of staying in sync w/ Circulation.pm
563 push( @errmsgloop, \%err );
565 last if $exit_required_p;
567 $template->param( errmsgloop => \@errmsgloop );
569 #set up so only the last 8 returned items display (make for faster loading pages)
570 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
574 { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
575 foreach ( sort { $a <=> $b } keys %returneditems ) {
577 if ( $count++ < $returned_counter ) {
578 my $bar_code = $returneditems{$_};
579 if ($riduedate{$_}) {
580 my $duedate = dt_from_string( $riduedate{$_}, 'sql');
581 $ri{year} = $duedate->year();
582 $ri{month} = $duedate->month();
583 $ri{day} = $duedate->day();
584 $ri{hour} = $duedate->hour();
585 $ri{minute} = $duedate->minute();
586 $ri{duedate} = output_pref($duedate);
587 my $patron = Koha::Patrons->find( $riborrowernumber{$_} );
588 unless ( $dropboxmode ) {
589 $ri{return_overdue} = 1 if (DateTime->compare($duedate, dt_from_string()) == -1);
591 $ri{return_overdue} = 1 if (DateTime->compare($duedate, $dropboxdate) == -1);
593 $ri{patron} = $patron,
594 $ri{borissuescount} = $patron->checkouts->count;
597 $ri{borrowernumber} = $riborrowernumber{$_};
600 my $item = Koha::Items->find({ barcode => $bar_code });
601 next unless $item; # FIXME The item has been deleted in the meantime,
602 # we could handle that better displaying a message in the template
604 my $biblio = $item->biblio;
605 # FIXME pass $item to the template and we are done here...
606 $ri{itembiblionumber} = $biblio->biblionumber;
607 $ri{itemtitle} = $biblio->title;
608 $ri{subtitle} = $biblio->subtitle;
609 $ri{part_name} = $biblio->part_name;
610 $ri{part_number} = $biblio->part_number;
611 $ri{itemauthor} = $biblio->author;
612 $ri{itemcallnumber} = $item->itemcallnumber;
613 $ri{dateaccessioned} = $item->dateaccessioned;
614 $ri{recordtype} = $biblio->itemtype;
615 $ri{itemtype} = $item->itype;
616 $ri{itemnote} = $item->itemnotes;
617 $ri{itemnotes_nonpublic} = $item->itemnotes_nonpublic;
618 $ri{ccode} = $item->ccode;
619 $ri{enumchron} = $item->enumchron;
620 $ri{itemnumber} = $item->itemnumber;
621 $ri{barcode} = $bar_code;
622 $ri{homebranch} = $item->homebranch;
623 $ri{holdingbranch} = $item->holdingbranch;
624 $ri{damaged} = $item->damaged;
626 $ri{location} = $item->location;
627 my $shelfcode = $ri{'location'};
628 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
639 errmsgloop => \@errmsgloop,
640 exemptfine => $exemptfine,
641 dropboxmode => $dropboxmode,
642 dropboxdate => $dropboxdate,
643 forgivemanualholdsexpire => $forgivemanualholdsexpire,
644 overduecharges => $overduecharges,
645 AudioAlerts => C4::Context->preference("AudioAlerts"),
649 my $item_from_barcode = Koha::Items->find({barcode => $barcode }); # How many times do we fetch this item?!?
650 if ( $item_from_barcode ) {
651 $itemnumber = $item_from_barcode->itemnumber;
652 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
653 if ( $holdingBranch and $collectionBranch ) {
654 $holdingBranch //= '';
655 $collectionBranch //= $returnbranch;
656 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
658 collectionItemNeedsTransferred => 1,
659 collectionBranch => $collectionBranch,
666 $template->param( itemnumber => $itemnumber );
668 # Checking if there is a Fast Cataloging Framework
669 $template->param( fast_cataloging => 1 ) if Koha::BiblioFrameworks->find( 'FA' );
671 # actually print the page!
672 output_html_with_http_headers $query, $cookie, $template->output;