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
36 use C4::Auth qw/:DEFAULT get_session/;
44 use C4::Branch; # GetBranches GetBranchName
45 use C4::Koha; # FIXME : is it still useful ?
46 use C4::RotatingCollections;
53 my ( $template, $librarian, $cookie ) = get_template_and_user(
55 template_name => "circ/returns.tt",
59 flagsrequired => { circulate => "circulate_remaining_permissions" },
63 my $sessionID = $query->cookie("CGISESSID");
64 my $session = get_session($sessionID);
65 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
66 # no branch set we can't return
67 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
71 # Print a reserve slip on this page
72 if ( $query->param('print_slip') ) {
75 borrowernumber => $query->param('borrowernumber'),
76 biblionumber => $query->param('biblionumber'),
82 my $branches = GetBranches();
83 my $printers = GetPrinters();
84 my $userenv = C4::Context->userenv;
85 my $userenv_branch = $userenv->{'branch'} // '';
86 my $printer = $userenv->{'branchprinter'} // '';
88 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
90 # Some code to handle the error if there is no branch or printer setting.....
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....
137 if ($query->param('WT-itemNumber')){
138 updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
141 if ( $query->param('resbarcode') ) {
142 my $item = $query->param('itemnumber');
143 my $borrowernumber = $query->param('borrowernumber');
144 my $resbarcode = $query->param('resbarcode');
145 my $diffBranchReturned = $query->param('diffBranch');
146 my $iteminfo = GetBiblioFromItemNumber($item);
147 # fix up item type for display
148 $iteminfo->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $iteminfo->{'itype'} : $iteminfo->{'itemtype'};
149 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
150 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
151 # i.e., whether to apply waiting status
152 ModReserveAffect( $item, $borrowernumber, $diffBranchSend);
153 # check if we have other reserves for this document, if we have a return send the message of transfer
154 my ( $messages, $nextreservinfo ) = GetOtherReserves($item);
156 my ($borr) = GetMemberDetails( $nextreservinfo, 0 );
157 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
158 if ( $messages->{'transfert'} ) {
160 itemtitle => $iteminfo->{'title'},
161 itemnumber => $iteminfo->{'itemnumber'},
162 itembiblionumber => $iteminfo->{'biblionumber'},
163 iteminfo => $iteminfo->{'author'},
164 tobranchname => GetBranchName($messages->{'transfert'}),
166 borrowernumber => $borrowernumber,
167 borcnum => $borr->{'cardnumber'},
168 borfirstname => $borr->{'firstname'},
169 borsurname => $borr->{'surname'},
178 my $issueinformation;
180 my $barcode = $query->param('barcode');
181 my $exemptfine = $query->param('exemptfine');
184 !C4::Auth::haspermission(C4::Context->userenv->{'id'}, {'updatecharges' => 'writeoff'})
186 # silently prevent unauthorized operator from forgiving overdue
187 # fines by manually tweaking form parameters
190 my $dropboxmode = $query->param('dropboxmode');
191 my $dotransfer = $query->param('dotransfer');
192 my $canceltransfer = $query->param('canceltransfer');
193 my $dest = $query->param('dest');
194 my $calendar = Koha::Calendar->new( branchcode => $userenv_branch );
195 #dropbox: get last open day (today - 1)
196 my $today = DateTime->now( time_zone => C4::Context->tz());
197 my $dropboxdate = $calendar->addDate($today, -1);
199 my $return_date_override = $query->param('return_date_override');
200 my $return_date_override_remember =
201 $query->param('return_date_override_remember');
202 if ($return_date_override) {
203 if ( C4::Context->preference('SpecifyReturnDate') ) {
204 # FIXME we really need to stop adding more uses of C4::Dates
205 if ( $return_date_override =~ C4::Dates->regexp('syspref') ) {
207 # note that we've overriden the return date
208 $template->param( return_date_was_overriden => 1);
209 # Save the original format if we are remembering for this series
211 return_date_override => $return_date_override,
212 return_date_override_remember => 1
213 ) if ($return_date_override_remember);
215 my $dt = dt_from_string($return_date_override);
216 $return_date_override =
217 DateTime::Format::MySQL->format_datetime($dt);
221 $return_date_override = q{};
226 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
227 my $transferitem = $query->param('transferitem');
228 my $tobranch = $query->param('tobranch');
229 ModItemTransfer($transferitem, $userenv_branch, $tobranch);
232 if ($canceltransfer){
233 $itemnumber=$query->param('itemnumber');
234 DeleteTransfer($itemnumber);
236 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
239 $template->param( transfercancelled => 1);
243 # actually return book and prepare item table.....
245 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
246 $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
247 $itemnumber = GetItemnumberFromBarcode($barcode);
252 ( $returned, $messages, $issueinformation, $borrower ) =
253 AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode, $return_date_override, $dropboxdate );
254 my $homeorholdingbranchreturn = C4::Context->preference('HomeOrHoldingBranchReturn');
255 $homeorholdingbranchreturn ||= 'homebranch';
257 # get biblio description
258 my $biblio = GetBiblioFromItemNumber($itemnumber);
259 # fix up item type for display
260 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
262 # Check if we should display a checkin message, based on the the item
263 # type of the checked in item
264 my $itemtype = C4::ItemType->get( $biblio->{'itemtype'} );
265 if ( $itemtype->{'checkinmsg'} ) {
267 checkinmsg => $itemtype->{'checkinmsg'},
268 checkinmsgtype => $itemtype->{'checkinmsgtype'},
273 title => $biblio->{'title'},
274 homebranch => $biblio->{'homebranch'},
275 homebranchname => GetBranchName( $biblio->{$homeorholdingbranchreturn} ),
276 author => $biblio->{'author'},
277 itembarcode => $biblio->{'barcode'},
278 itemtype => $biblio->{'itemtype'},
279 ccode => $biblio->{'ccode'},
280 itembiblionumber => $biblio->{'biblionumber'},
281 borrower => $borrower,
282 additional_materials => $biblio->{'materials'},
292 my $time_now = DateTime->now( time_zone => C4::Context->tz )->truncate( to => 'minute');
293 my $duedate = $issueinformation->{date_due}->strftime('%Y-%m-%d %H:%M');
294 $returneditems{0} = $barcode;
295 $riborrowernumber{0} = $borrower->{'borrowernumber'};
296 $riduedate{0} = $duedate;
297 $input{borrowernumber} = $borrower->{'borrowernumber'};
298 $input{duedate} = $duedate;
299 unless ( $dropboxmode ) {
300 $input{return_overdue} = 1 if (DateTime->compare($issueinformation->{date_due}, DateTime->now()) == -1);
302 $input{return_overdue} = 1 if (DateTime->compare($issueinformation->{date_due}, $dropboxdate) == -1);
304 push( @inputloop, \%input );
306 if ( C4::Context->preference("FineNotifyAtCheckin") ) {
307 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrower->{'borrowernumber'} );
308 if ($fines && $fines > 0) {
309 $template->param( fines => sprintf("%.2f",$fines) );
310 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
314 if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
315 #Check for waiting holds
316 my @reserves = GetReservesFromBorrowernumber($borrower->{'borrowernumber'});
317 my $waiting_holds = 0;
318 foreach my $num_res (@reserves) {
319 if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
323 if ($waiting_holds > 0) {
325 waiting_holds => $waiting_holds,
326 holdsborrowernumber => $borrower->{'borrowernumber'},
327 holdsfirstname => $borrower->{'firstname'},
328 holdssurname => $borrower->{'surname'},
333 elsif ( !$messages->{'BadBarcode'} ) {
335 $returneditems{0} = $barcode;
337 push( @inputloop, \%input );
340 $template->param( inputloop => \@inputloop );
346 # new op dev : we check if the document must be returned to his homebranch directly,
347 # if the document is transfered, we have warning message .
349 if ( $messages->{'WasTransfered'} ) {
353 itemnumber => $itemnumber,
357 if ( $messages->{'NeedsTransfer'} ){
361 itemnumber => $itemnumber,
365 if ( $messages->{'Wrongbranch'} ){
371 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
373 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
376 TransferWaitingAt => $messages->{'WrongTransfer'},
377 WrongTransferItem => $messages->{'WrongTransferItem'},
378 itemnumber => $itemnumber,
381 my $reserve = $messages->{'ResFound'};
382 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
383 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
384 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
387 wborfirstname => $borr->{'firstname'},
388 wborsurname => $borr->{'surname'},
389 wbortitle => $borr->{'title'},
390 wborphone => $borr->{'phone'},
391 wboremail => $borr->{'email'},
392 wborstnum => $borr->{streetnumber},
393 wboraddress => $borr->{'address'},
394 wboraddress2 => $borr->{'address2'},
395 wborcity => $borr->{'city'},
396 wborzip => $borr->{'zipcode'},
397 wborrowernumber => $reserve->{'borrowernumber'},
398 wborcnum => $borr->{'cardnumber'},
399 wtransfertFrom => $userenv_branch,
404 # reserve found and item arrived at the expected branch
406 if ( $messages->{'ResFound'}) {
407 my $reserve = $messages->{'ResFound'};
408 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
409 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
411 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
412 if ( $reserve->{'ResFound'} eq "Waiting" ) {
414 waiting => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
416 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
418 intransit => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
419 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
420 resbarcode => $barcode,
425 # same params for Waiting or Reserved
428 currentbranch => $branches->{$userenv_branch}->{'branchname'},
429 destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
430 name => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
431 borfirstname => $borr->{'firstname'},
432 borsurname => $borr->{'surname'},
433 bortitle => $borr->{'title'},
434 borphone => $borr->{'phone'},
435 boremail => $borr->{'email'},
436 boraddress => $borr->{'address'},
437 boraddress2 => $borr->{'address2'},
438 borstnum => $borr->{streetnumber},
439 borcity => $borr->{'city'},
440 borzip => $borr->{'zipcode'},
441 borcnum => $borr->{'cardnumber'},
442 debarred => $borr->{'debarred'},
443 gonenoaddress => $borr->{'gonenoaddress'},
445 destbranch => $reserve->{'branchcode'},
446 borrowernumber => $reserve->{'borrowernumber'},
447 itemnumber => $reserve->{'itemnumber'},
448 reservenotes => $reserve->{'reservenotes'},
450 } # else { ; } # error?
455 foreach my $code ( keys %$messages ) {
457 my $exit_required_p = 0;
458 if ( $code eq 'BadBarcode' ) {
459 $err{badbarcode} = 1;
460 $err{msg} = $messages->{'BadBarcode'};
462 elsif ( $code eq 'NotIssued' ) {
464 $err{msg} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
466 elsif ( $code eq 'LocalUse' ) {
469 elsif ( $code eq 'WasLost' ) {
472 elsif ( $code eq 'LostItemFeeRefunded' ) {
473 $template->param( LostItemFeeRefunded => 1 );
475 elsif ( $code eq 'ResFound' ) {
476 ; # FIXME... anything to do here?
478 elsif ( $code eq 'WasReturned' ) {
479 ; # FIXME... anything to do here?
481 elsif ( $code eq 'WasTransfered' ) {
482 ; # FIXME... anything to do here?
484 elsif ( $code eq 'withdrawn' ) {
486 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
488 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
489 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
490 $err{ispermanent} = 1;
492 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
495 elsif ( $code eq 'WrongTransfer' ) {
496 ; # FIXME... anything to do here?
498 elsif ( $code eq 'WrongTransferItem' ) {
499 ; # FIXME... anything to do here?
501 elsif ( $code eq 'NeedsTransfer' ) {
503 elsif ( $code eq 'Wrongbranch' ) {
505 elsif ( $code eq 'Debarred' ) {
506 $err{debarred} = $messages->{'Debarred'};
507 $err{debarcardnumber} = $borrower->{cardnumber};
508 $err{debarborrowernumber} = $borrower->{borrowernumber};
509 $err{debarname} = "$borrower->{firstname} $borrower->{surname}";
511 elsif ( $code eq 'PrevDebarred' ) {
512 $err{prevdebarred} = $messages->{'PrevDebarred'};
514 elsif ( $code eq 'ForeverDebarred' ) {
515 $err{foreverdebarred} = $messages->{'ForeverDebarred'};
517 elsif ( $code eq 'NotForLoanStatusUpdated' ) {
518 $err{NotForLoanStatusUpdated} = $messages->{NotForLoanStatusUpdated};
521 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
522 # This forces the issue of staying in sync w/ Circulation.pm
525 push( @errmsgloop, \%err );
527 last if $exit_required_p;
529 $template->param( errmsgloop => \@errmsgloop );
531 #set up so only the last 8 returned items display (make for faster loading pages)
532 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
535 my $shelflocations = GetKohaAuthorisedValues('items.location','');
536 foreach ( sort { $a <=> $b } keys %returneditems ) {
538 if ( $count++ < $returned_counter ) {
539 my $bar_code = $returneditems{$_};
540 if ($riduedate{$_}) {
541 my $duedate = dt_from_string( $riduedate{$_}, 'sql');
542 $ri{year} = $duedate->year();
543 $ri{month} = $duedate->month();
544 $ri{day} = $duedate->day();
545 $ri{hour} = $duedate->hour();
546 $ri{minute} = $duedate->minute();
547 $ri{duedate} = output_pref($duedate);
548 my ($b) = GetMemberDetails( $riborrowernumber{$_}, 0 );
549 unless ( $dropboxmode ) {
550 $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1);
552 $ri{return_overdue} = 1 if (DateTime->compare($duedate, $dropboxdate) == -1);
554 $ri{borrowernumber} = $b->{'borrowernumber'};
555 $ri{borcnum} = $b->{'cardnumber'};
556 $ri{borfirstname} = $b->{'firstname'};
557 $ri{borsurname} = $b->{'surname'};
558 $ri{bortitle} = $b->{'title'};
559 $ri{bornote} = $b->{'borrowernotes'};
560 $ri{borcategorycode}= $b->{'categorycode'};
563 $ri{borrowernumber} = $riborrowernumber{$_};
567 my $biblio = GetBiblioFromItemNumber(GetItemnumberFromBarcode($bar_code));
568 my $item = GetItem( GetItemnumberFromBarcode($bar_code) );
569 # fix up item type for display
570 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
571 $ri{itembiblionumber} = $biblio->{'biblionumber'};
572 $ri{itemtitle} = $biblio->{'title'};
573 $ri{itemauthor} = $biblio->{'author'};
574 $ri{itemcallnumber} = $biblio->{'itemcallnumber'};
575 $ri{itemtype} = $biblio->{'itemtype'};
576 $ri{itemnote} = $biblio->{'itemnotes'};
577 $ri{ccode} = $biblio->{'ccode'};
578 $ri{itemnumber} = $biblio->{'itemnumber'};
579 $ri{barcode} = $bar_code;
580 $ri{homebranch} = $item->{'homebranch'};
581 $ri{holdingbranch} = $item->{'holdingbranch'};
583 $ri{location} = $biblio->{'location'};
584 my $shelfcode = $ri{'location'};
585 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
593 my ($genbrname, $genprname);
594 if (my $b = $branches->{$userenv_branch}) {
595 $genbrname = $b->{'branchname'};
597 if (my $p = $printers->{$printer}) {
598 $genprname = $p->{'printername'};
602 genbrname => $genbrname,
603 genprname => $genprname,
604 branchname => $genbrname,
606 errmsgloop => \@errmsgloop,
607 exemptfine => $exemptfine,
608 dropboxmode => $dropboxmode,
609 dropboxdate => output_pref($dropboxdate),
610 overduecharges => $overduecharges,
611 soundon => C4::Context->preference("SoundOn"),
612 BlockReturnOfWithdrawnItems => C4::Context->preference("BlockReturnOfWithdrawnItems"),
615 $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
617 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
618 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
620 collectionItemNeedsTransferred => 1,
621 collectionBranch => GetBranchName($collectionBranch),
626 # actually print the page!
627 output_html_with_http_headers $query, $cookie, $template->output;