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
34 $SIG{ __DIE__ } = sub { Carp::confess( @_ ) };
39 use C4::Auth qw/:DEFAULT get_session/;
47 use C4::Members::Messaging;
48 use C4::Koha; # FIXME : is it still useful ?
49 use C4::RotatingCollections;
50 use Koha::AuthorisedValues;
53 use Koha::BiblioFrameworks;
60 my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
62 template_name => "circ/returns.tt",
66 flagsrequired => { circulate => "circulate_remaining_permissions" },
70 my $sessionID = $query->cookie("CGISESSID");
71 my $session = get_session($sessionID);
72 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
73 # no branch set we can't return
74 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
78 # Print a reserve slip on this page
79 if ( $query->param('print_slip') ) {
82 borrowernumber => scalar $query->param('borrowernumber'),
83 biblionumber => scalar $query->param('biblionumber'),
89 my $printers = GetPrinters();
90 my $userenv = C4::Context->userenv;
91 my $userenv_branch = $userenv->{'branch'} // '';
92 my $printer = $userenv->{'branchprinter'} // '';
93 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
95 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
97 # Some code to handle the error if there is no branch or printer setting.....
100 # Set up the item stack ....
103 my %riborrowernumber;
105 foreach ( $query->param ) {
118 my $barcode = $query->param("ri-$counter");
119 my $duedate = $query->param("dd-$counter");
120 my $borrowernumber = $query->param("bn-$counter");
123 # decode barcode ## Didn't we already decode them before passing them back last time??
124 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
125 $barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
127 ######################
128 #Are these lines still useful ?
129 $returneditems{$counter} = $barcode;
130 $riduedate{$counter} = $duedate;
131 $riborrowernumber{$counter} = $borrowernumber;
133 #######################
134 $input{counter} = $counter;
135 $input{barcode} = $barcode;
136 $input{duedate} = $duedate;
137 $input{borrowernumber} = $borrowernumber;
138 push( @inputloop, \%input );
142 # Deal with the requests....
144 if ($query->param('WT-itemNumber')){
145 updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
148 if ( $query->param('reserve_id') ) {
149 my $item = $query->param('itemnumber');
150 my $borrowernumber = $query->param('borrowernumber');
151 my $reserve_id = $query->param('reserve_id');
152 my $diffBranchReturned = $query->param('diffBranch');
153 my $iteminfo = GetBiblioFromItemNumber($item);
154 my $cancel_reserve = $query->param('cancel_reserve');
155 # fix up item type for display
156 $iteminfo->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $iteminfo->{'itype'} : $iteminfo->{'itemtype'};
158 if ( $cancel_reserve ) {
159 CancelReserve({ reserve_id => $reserve_id, charge_cancel_fee => !$forgivemanualholdsexpire });
161 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
162 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
163 # i.e., whether to apply waiting status
164 ModReserveAffect( $item, $borrowernumber, $diffBranchSend, $reserve_id );
166 # check if we have other reserves for this document, if we have a return send the message of transfer
167 my ( $messages, $nextreservinfo ) = GetOtherReserves($item);
169 my $borr = GetMember( borrowernumber => $nextreservinfo );
170 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
171 if ( $messages->{'transfert'} ) {
173 itemtitle => $iteminfo->{'title'},
174 itemnumber => $iteminfo->{'itemnumber'},
175 itembiblionumber => $iteminfo->{'biblionumber'},
176 iteminfo => $iteminfo->{'author'},
178 borrowernumber => $borrowernumber,
179 borcnum => $borr->{'cardnumber'},
180 borfirstname => $borr->{'firstname'},
181 borsurname => $borr->{'surname'},
182 borcategory => $borr->{'description'},
193 my $barcode = $query->param('barcode');
194 my $exemptfine = $query->param('exemptfine');
197 !C4::Auth::haspermission(C4::Context->userenv->{'id'}, {'updatecharges' => 'writeoff'})
199 # silently prevent unauthorized operator from forgiving overdue
200 # fines by manually tweaking form parameters
203 my $dropboxmode = $query->param('dropboxmode');
204 my $dotransfer = $query->param('dotransfer');
205 my $canceltransfer = $query->param('canceltransfer');
206 my $dest = $query->param('dest');
207 my $calendar = Koha::Calendar->new( branchcode => $userenv_branch );
208 #dropbox: get last open day (today - 1)
209 my $today = DateTime->now( time_zone => C4::Context->tz());
210 my $dropboxdate = $calendar->addDate($today, -1);
212 my $return_date_override = $query->param('return_date_override');
213 my $return_date_override_remember =
214 $query->param('return_date_override_remember');
215 if ($return_date_override) {
216 if ( C4::Context->preference('SpecifyReturnDate') ) {
217 my $return_date_override_dt = eval {dt_from_string( $return_date_override ) };
218 if ( $return_date_override_dt ) {
219 # note that we've overriden the return date
220 $template->param( return_date_was_overriden => 1);
221 # Save the original format if we are remembering for this series
223 return_date_override => $return_date_override,
224 return_date_override_remember => 1
225 ) if ($return_date_override_remember);
227 $return_date_override =
228 DateTime::Format::MySQL->format_datetime( $return_date_override_dt );
232 $return_date_override = q{};
237 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
238 my $transferitem = $query->param('transferitem');
239 my $tobranch = $query->param('tobranch');
240 ModItemTransfer($transferitem, $userenv_branch, $tobranch);
243 if ($canceltransfer){
244 $itemnumber=$query->param('itemnumber');
245 DeleteTransfer($itemnumber);
247 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
250 $template->param( transfercancelled => 1);
254 # actually return book and prepare item table.....
257 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
258 $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
259 $itemnumber = GetItemnumberFromBarcode($barcode);
265 # get biblio description
266 my $biblio = GetBiblioFromItemNumber($itemnumber);
267 # fix up item type for display
268 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
270 # Check if we should display a checkin message, based on the the item
271 # type of the checked in item
272 my $itemtype = Koha::ItemTypes->find( $biblio->{'itemtype'} );
273 if ( $itemtype && $itemtype->checkinmsg ) {
275 checkinmsg => $itemtype->checkinmsg,
276 checkinmsgtype => $itemtype->checkinmsgtype,
280 # make sure return branch respects home branch circulation rules, default to homebranch
281 my $hbr = GetBranchItemRule($biblio->{'homebranch'}, $itemtype ? $itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
282 $returnbranch = $biblio->{$hbr};
284 my $materials = $biblio->{'materials'};
285 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => '', kohafield =>'items.materials', authorised_value => $materials });
286 $materials = $descriptions->{lib} // $materials;
288 my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } );
291 title => $biblio->{'title'},
292 homebranch => $biblio->{'homebranch'},
293 holdingbranch => $biblio->{'holdingbranch'},
294 returnbranch => $returnbranch,
295 author => $biblio->{'author'},
296 itembarcode => $biblio->{'barcode'},
297 itemtype => $biblio->{'itemtype'},
298 ccode => $biblio->{'ccode'},
299 itembiblionumber => $biblio->{'biblionumber'},
300 biblionumber => $biblio->{'biblionumber'},
301 borrower => $borrower,
302 additional_materials => $materials,
313 ( $returned, $messages, $issue, $borrower ) =
314 AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode, $return_date_override, $dropboxdate );
317 my $time_now = DateTime->now( time_zone => C4::Context->tz )->truncate( to => 'minute');
318 my $date_due_dt = dt_from_string( $issue->date_due, 'sql' );
319 my $duedate = $date_due_dt->strftime('%Y-%m-%d %H:%M');
320 $returneditems{0} = $barcode;
321 $riborrowernumber{0} = $borrower->{'borrowernumber'};
322 $riduedate{0} = $duedate;
323 $input{borrowernumber} = $borrower->{'borrowernumber'};
324 $input{duedate} = $duedate;
325 unless ( $dropboxmode ) {
326 $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, DateTime->now()) == -1);
328 $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, $dropboxdate) == -1);
330 push( @inputloop, \%input );
332 if ( C4::Context->preference("FineNotifyAtCheckin") ) {
333 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
334 my $balance = $patron->account->balance;
337 $template->param( fines => sprintf("%.2f", $balance) );
338 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
342 if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
343 #Check for waiting holds
344 my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
345 my $waiting_holds = $patron->holds->search({ found => 'W', branchcode => $userenv_branch })->count;
346 if ($waiting_holds > 0) {
348 waiting_holds => $waiting_holds,
349 holdsborrowernumber => $borrower->{'borrowernumber'},
350 holdsfirstname => $borrower->{'firstname'},
351 holdssurname => $borrower->{'surname'},
355 } elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} ) {
357 $returneditems{0} = $barcode;
359 push( @inputloop, \%input );
361 $template->param( privacy => $borrower->{privacy} );
363 $template->param( inputloop => \@inputloop );
369 # new op dev : we check if the document must be returned to his homebranch directly,
370 # if the document is transfered, we have warning message .
372 if ( $messages->{'WasTransfered'} ) {
376 itemnumber => $itemnumber,
380 if ( $messages->{'NeedsTransfer'} ){
383 needstransfer => $messages->{'NeedsTransfer'},
384 itemnumber => $itemnumber,
388 if ( $messages->{'Wrongbranch'} ){
391 rightbranch => $messages->{'Wrongbranch'}->{'Rightbranch'},
395 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
397 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
400 TransferWaitingAt => $messages->{'WrongTransfer'},
401 WrongTransferItem => $messages->{'WrongTransferItem'},
402 itemnumber => $itemnumber,
405 my $reserve = $messages->{'ResFound'};
406 my $borr = C4::Members::GetMember( borrowernumber => $reserve->{'borrowernumber'} );
407 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
410 wborfirstname => $borr->{'firstname'},
411 wborsurname => $borr->{'surname'},
412 wborcategory => $borr->{'description'},
413 wbortitle => $borr->{'title'},
414 wborphone => $borr->{'phone'},
415 wboremail => $borr->{'email'},
416 streetnumber => $borr->{streetnumber},
417 streettype => $borr->{streettype},
418 address => $borr->{'address'},
419 address2 => $borr->{'address2'},
420 city => $borr->{'city'},
421 zipcode => $borr->{'zipcode'},
422 state => $borr->{'state'},
423 country => $borr->{'country'},
424 wborrowernumber => $reserve->{'borrowernumber'},
425 wborcnum => $borr->{'cardnumber'},
426 wtransfertFrom => $userenv_branch,
431 # reserve found and item arrived at the expected branch
433 if ( $messages->{'ResFound'}) {
434 my $reserve = $messages->{'ResFound'};
435 my $borr = C4::Members::GetMember( borrowernumber => $reserve->{'borrowernumber'} );
436 my $holdmsgpreferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $reserve->{'borrowernumber'}, message_name => 'Hold_Filled' } );
437 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
438 if ( $reserve->{'ResFound'} eq "Waiting" ) {
440 waiting => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
442 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
444 intransit => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
445 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
446 reserve_id => $reserve->{reserve_id},
451 # same params for Waiting or Reserved
454 name => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
455 borfirstname => $borr->{'firstname'},
456 borsurname => $borr->{'surname'},
457 borcategory => $borr->{'description'},
458 bortitle => $borr->{'title'},
459 borphone => $borr->{'phone'},
460 boremail => $borr->{'email'},
461 streetnumber => $borr->{streetnumber},
462 streettype => $borr->{streettype},
463 address => $borr->{'address'},
464 address2 => $borr->{'address2'},
465 city => $borr->{'city'},
466 zipcode => $borr->{'zipcode'},
467 state => $borr->{'state'},
468 country => $borr->{'country'},
469 borcnum => $borr->{'cardnumber'},
470 debarred => $borr->{'debarred'},
471 gonenoaddress => $borr->{'gonenoaddress'},
473 destbranch => $reserve->{'branchcode'},
474 borrowernumber => $reserve->{'borrowernumber'},
475 itemnumber => $reserve->{'itemnumber'},
476 reservenotes => $reserve->{'reservenotes'},
477 reserve_id => $reserve->{reserve_id},
478 bormessagepref => $holdmsgpreferences->{'transports'},
480 } # else { ; } # error?
485 foreach my $code ( keys %$messages ) {
487 my $exit_required_p = 0;
488 if ( $code eq 'BadBarcode' ) {
489 $err{badbarcode} = 1;
490 $err{msg} = $messages->{'BadBarcode'};
492 elsif ( $code eq 'NotIssued' ) {
495 $err{msg} = $messages->{'IsPermanent'} if $messages->{'IsPermanent'};
497 elsif ( $code eq 'LocalUse' ) {
500 elsif ( $code eq 'WasLost' ) {
503 elsif ( $code eq 'LostItemFeeRefunded' ) {
504 $template->param( LostItemFeeRefunded => 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 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
520 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
521 $err{ispermanent} = 1;
522 $err{msg} = $messages->{'IsPermanent'};
525 elsif ( $code eq 'WrongTransfer' ) {
526 ; # FIXME... anything to do here?
528 elsif ( $code eq 'WrongTransferItem' ) {
529 ; # FIXME... anything to do here?
531 elsif ( $code eq 'NeedsTransfer' ) {
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 'NotForLoanStatusUpdated' ) {
548 $err{NotForLoanStatusUpdated} = $messages->{NotForLoanStatusUpdated};
551 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
552 # This forces the issue of staying in sync w/ Circulation.pm
555 push( @errmsgloop, \%err );
557 last if $exit_required_p;
559 $template->param( errmsgloop => \@errmsgloop );
561 #set up so only the last 8 returned items display (make for faster loading pages)
562 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
566 { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
567 foreach ( sort { $a <=> $b } keys %returneditems ) {
569 if ( $count++ < $returned_counter ) {
570 my $bar_code = $returneditems{$_};
571 if ($riduedate{$_}) {
572 my $duedate = dt_from_string( $riduedate{$_}, 'sql');
573 $ri{year} = $duedate->year();
574 $ri{month} = $duedate->month();
575 $ri{day} = $duedate->day();
576 $ri{hour} = $duedate->hour();
577 $ri{minute} = $duedate->minute();
578 $ri{duedate} = output_pref($duedate);
579 my $b = C4::Members::GetMember( borrowernumber => $riborrowernumber{$_} );
580 unless ( $dropboxmode ) {
581 $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1);
583 $ri{return_overdue} = 1 if (DateTime->compare($duedate, $dropboxdate) == -1);
585 $ri{borrowernumber} = $b->{'borrowernumber'};
586 $ri{borcnum} = $b->{'cardnumber'};
587 $ri{borfirstname} = $b->{'firstname'};
588 $ri{borsurname} = $b->{'surname'};
589 $ri{bortitle} = $b->{'title'};
590 $ri{bornote} = $b->{'borrowernotes'};
591 $ri{borcategorycode}= $b->{'categorycode'};
592 $ri{borissuescount} = Koha::Checkouts->count( { borrowernumber => $b->{'borrowernumber'} } );
595 $ri{borrowernumber} = $riborrowernumber{$_};
599 my $biblio = GetBiblioFromItemNumber(GetItemnumberFromBarcode($bar_code));
600 my $item = GetItem( GetItemnumberFromBarcode($bar_code) );
601 # fix up item type for display
602 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
603 $ri{itembiblionumber} = $biblio->{'biblionumber'};
604 $ri{itemtitle} = $biblio->{'title'};
605 $ri{itemauthor} = $biblio->{'author'};
606 $ri{itemcallnumber} = $biblio->{'itemcallnumber'};
607 $ri{dateaccessioned} = $item->{dateaccessioned};
608 $ri{itemtype} = $biblio->{'itemtype'};
609 $ri{itemnote} = $biblio->{'itemnotes'};
610 $ri{itemnotes_nonpublic} = $item->{'itemnotes_nonpublic'};
611 $ri{ccode} = $biblio->{'ccode'};
612 $ri{enumchron} = $biblio->{'enumchron'};
613 $ri{itemnumber} = $biblio->{'itemnumber'};
614 $ri{barcode} = $bar_code;
615 $ri{homebranch} = $item->{'homebranch'};
616 $ri{holdingbranch} = $item->{'holdingbranch'};
618 $ri{location} = $biblio->{'location'};
619 my $shelfcode = $ri{'location'};
620 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
632 errmsgloop => \@errmsgloop,
633 exemptfine => $exemptfine,
634 dropboxmode => $dropboxmode,
635 dropboxdate => output_pref($dropboxdate),
636 forgivemanualholdsexpire => $forgivemanualholdsexpire,
637 overduecharges => $overduecharges,
638 AudioAlerts => C4::Context->preference("AudioAlerts"),
639 BlockReturnOfWithdrawnItems => C4::Context->preference("BlockReturnOfWithdrawnItems"),
642 $itemnumber = GetItemnumberFromBarcode( $barcode );
644 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
645 if ( $holdingBranch and $collectionBranch ) {
646 $holdingBranch //= '';
647 $collectionBranch //= $returnbranch;
648 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
650 collectionItemNeedsTransferred => 1,
651 collectionBranch => $collectionBranch,
652 itemnumber => $itemnumber,
658 # Checking if there is a Fast Cataloging Framework
659 $template->param( fast_cataloging => 1 ) if Koha::BiblioFrameworks->find( 'FA' );
661 # actually print the page!
662 output_html_with_http_headers $query, $cookie, $template->output;