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 under the
12 # terms of the GNU General Public License as published by the Free Software
13 # Foundation; either version 2 of the License, or (at your option) any later
16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License along
21 # with Koha; if not, write to the Free Software Foundation, Inc.,
22 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
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.tmpl",
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");
73 my $branches = GetBranches();
74 my $printers = GetPrinters();
75 my $userenv = C4::Context->userenv;
76 my $userenv_branch = $userenv->{'branch'} // '';
77 my $printer = $userenv->{'branchprinter'} // '';
79 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
81 # Some code to handle the error if there is no branch or printer setting.....
84 # Set up the item stack ....
89 foreach ( $query->param ) {
102 my $barcode = $query->param("ri-$counter");
103 my $duedate = $query->param("dd-$counter");
104 my $borrowernumber = $query->param("bn-$counter");
107 # decode barcode ## Didn't we already decode them before passing them back last time??
108 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
109 $barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
111 ######################
112 #Are these lines still useful ?
113 $returneditems{$counter} = $barcode;
114 $riduedate{$counter} = $duedate;
115 $riborrowernumber{$counter} = $borrowernumber;
117 #######################
118 $input{counter} = $counter;
119 $input{barcode} = $barcode;
120 $input{duedate} = $duedate;
121 $input{borrowernumber} = $borrowernumber;
122 push( @inputloop, \%input );
126 # Deal with the requests....
128 if ($query->param('WT-itemNumber')){
129 updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
132 if ( $query->param('resbarcode') ) {
133 my $item = $query->param('itemnumber');
134 my $borrowernumber = $query->param('borrowernumber');
135 my $resbarcode = $query->param('resbarcode');
136 my $diffBranchReturned = $query->param('diffBranch');
137 my $iteminfo = GetBiblioFromItemNumber($item);
138 # fix up item type for display
139 $iteminfo->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $iteminfo->{'itype'} : $iteminfo->{'itemtype'};
140 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
141 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
142 # i.e., whether to apply waiting status
143 ModReserveAffect( $item, $borrowernumber, $diffBranchSend);
144 # check if we have other reserves for this document, if we have a return send the message of transfer
145 my ( $messages, $nextreservinfo ) = GetOtherReserves($item);
147 my ($borr) = GetMemberDetails( $nextreservinfo, 0 );
148 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
149 if ( $messages->{'transfert'} ) {
151 itemtitle => $iteminfo->{'title'},
152 itemnumber => $iteminfo->{'itemnumber'},
153 itembiblionumber => $iteminfo->{'biblionumber'},
154 iteminfo => $iteminfo->{'author'},
155 tobranchname => GetBranchName($messages->{'transfert'}),
157 borrowernumber => $borrowernumber,
158 borcnum => $borr->{'cardnumber'},
159 borfirstname => $borr->{'firstname'},
160 borsurname => $borr->{'surname'},
169 my $issueinformation;
171 my $barcode = $query->param('barcode');
172 my $exemptfine = $query->param('exemptfine');
175 !C4::Auth::haspermission(C4::Context->userenv->{'id'}, {'updatecharges' => 'writeoff'})
177 # silently prevent unauthorized operator from forgiving overdue
178 # fines by manually tweaking form parameters
181 my $dropboxmode = $query->param('dropboxmode');
182 my $dotransfer = $query->param('dotransfer');
183 my $canceltransfer = $query->param('canceltransfer');
184 my $dest = $query->param('dest');
185 my $calendar = Koha::Calendar->new( branchcode => $userenv_branch );
186 #dropbox: get last open day (today - 1)
187 my $today = DateTime->now( time_zone => C4::Context->tz());
188 my $dropboxdate = $calendar->addDate($today, -1);
190 my $return_date_override = $query->param('return_date_override');
191 my $return_date_override_remember =
192 $query->param('return_date_override_remember');
193 if ($return_date_override) {
194 if ( C4::Context->preference('SpecifyReturnDate') ) {
195 # FIXME we really need to stop adding more uses of C4::Dates
196 if ( $return_date_override =~ C4::Dates->regexp('syspref') ) {
198 # note that we've overriden the return date
199 $template->param( return_date_was_overriden => 1);
200 # Save the original format if we are remembering for this series
202 return_date_override => $return_date_override,
203 return_date_override_remember => 1
204 ) if ($return_date_override_remember);
206 my $dt = dt_from_string($return_date_override);
207 $return_date_override =
208 DateTime::Format::MySQL->format_datetime($dt);
212 $return_date_override = q{};
217 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
218 my $transferitem = $query->param('transferitem');
219 my $tobranch = $query->param('tobranch');
220 ModItemTransfer($transferitem, $userenv_branch, $tobranch);
223 if ($canceltransfer){
224 $itemnumber=$query->param('itemnumber');
225 DeleteTransfer($itemnumber);
227 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
230 $template->param( transfercancelled => 1);
234 # actually return book and prepare item table.....
236 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
237 $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
238 $itemnumber = GetItemnumberFromBarcode($barcode);
240 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
241 my $item = GetItem( $itemnumber );
242 if ( $item->{'location'} eq 'PROC' ) {
243 $item->{'location'} = 'CART';
244 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
251 ( $returned, $messages, $issueinformation, $borrower ) =
252 AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode, $return_date_override, $dropboxdate );
253 my $homeorholdingbranchreturn = C4::Context->preference('HomeOrHoldingBranchReturn');
254 $homeorholdingbranchreturn ||= 'homebranch';
256 # get biblio description
257 my $biblio = GetBiblioFromItemNumber($itemnumber);
258 # fix up item type for display
259 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
261 # Check if we should display a checkin message, based on the the item
262 # type of the checked in item
263 my $itemtype = C4::ItemType->get( $biblio->{'itemtype'} );
264 if ( $itemtype->{'checkinmsg'} ) {
266 checkinmsg => $itemtype->{'checkinmsg'},
267 checkinmsgtype => $itemtype->{'checkinmsgtype'},
272 title => $biblio->{'title'},
273 homebranch => $biblio->{'homebranch'},
274 homebranchname => GetBranchName( $biblio->{$homeorholdingbranchreturn} ),
275 author => $biblio->{'author'},
276 itembarcode => $biblio->{'barcode'},
277 itemtype => $biblio->{'itemtype'},
278 ccode => $biblio->{'ccode'},
279 itembiblionumber => $biblio->{'biblionumber'},
280 borrower => $borrower,
281 additional_materials => $biblio->{'materials'},
291 my $time_now = DateTime->now( time_zone => C4::Context->tz )->truncate( to => 'minute');
292 my $duedate = $issueinformation->{date_due}->strftime('%Y-%m-%d %H:%M');
293 $returneditems{0} = $barcode;
294 $riborrowernumber{0} = $borrower->{'borrowernumber'};
295 $riduedate{0} = $duedate;
296 $input{borrowernumber} = $borrower->{'borrowernumber'};
297 $input{duedate} = $duedate;
298 unless ( $dropboxmode ) {
299 $input{return_overdue} = 1 if (DateTime->compare($issueinformation->{date_due}, DateTime->now()) == -1);
301 $input{return_overdue} = 1 if (DateTime->compare($issueinformation->{date_due}, $dropboxdate) == -1);
303 push( @inputloop, \%input );
305 if ( C4::Context->preference("FineNotifyAtCheckin") ) {
306 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrower->{'borrowernumber'} );
307 if ($fines && $fines > 0) {
308 $template->param( fines => sprintf("%.2f",$fines) );
309 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
313 if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
314 #Check for waiting holds
315 my @reserves = GetReservesFromBorrowernumber($borrower->{'borrowernumber'});
316 my $waiting_holds = 0;
317 foreach my $num_res (@reserves) {
318 if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
322 if ($waiting_holds > 0) {
324 waiting_holds => $waiting_holds,
325 holdsborrowernumber => $borrower->{'borrowernumber'},
326 holdsfirstname => $borrower->{'firstname'},
327 holdssurname => $borrower->{'surname'},
332 elsif ( !$messages->{'BadBarcode'} ) {
334 $returneditems{0} = $barcode;
336 push( @inputloop, \%input );
339 $template->param( inputloop => \@inputloop );
345 # new op dev : we check if the document must be returned to his homebranch directly,
346 # if the document is transfered, we have warning message .
348 if ( $messages->{'WasTransfered'} ) {
352 itemnumber => $itemnumber,
356 if ( $messages->{'NeedsTransfer'} ){
360 itemnumber => $itemnumber,
364 if ( $messages->{'Wrongbranch'} ){
370 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
372 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
375 TransferWaitingAt => $messages->{'WrongTransfer'},
376 WrongTransferItem => $messages->{'WrongTransferItem'},
377 itemnumber => $itemnumber,
380 my $reserve = $messages->{'ResFound'};
381 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
382 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
383 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
386 wborfirstname => $borr->{'firstname'},
387 wborsurname => $borr->{'surname'},
388 wbortitle => $borr->{'title'},
389 wborphone => $borr->{'phone'},
390 wboremail => $borr->{'email'},
391 wboraddress => $borr->{'address'},
392 wboraddress2 => $borr->{'address2'},
393 wborcity => $borr->{'city'},
394 wborzip => $borr->{'zipcode'},
395 wborrowernumber => $reserve->{'borrowernumber'},
396 wborcnum => $borr->{'cardnumber'},
397 wtransfertFrom => $userenv_branch,
402 # reserve found and item arrived at the expected branch
404 if ( $messages->{'ResFound'}) {
405 my $reserve = $messages->{'ResFound'};
406 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
407 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
409 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
410 if ( $reserve->{'ResFound'} eq "Waiting" ) {
412 waiting => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
414 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
416 intransit => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
417 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
418 resbarcode => $barcode,
423 # same params for Waiting or Reserved
426 currentbranch => $branches->{$userenv_branch}->{'branchname'},
427 destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
428 name => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
429 borfirstname => $borr->{'firstname'},
430 borsurname => $borr->{'surname'},
431 bortitle => $borr->{'title'},
432 borphone => $borr->{'phone'},
433 boremail => $borr->{'email'},
434 boraddress => $borr->{'address'},
435 boraddress2 => $borr->{'address2'},
436 borcity => $borr->{'city'},
437 borzip => $borr->{'zipcode'},
438 borcnum => $borr->{'cardnumber'},
439 debarred => $borr->{'debarred'},
440 gonenoaddress => $borr->{'gonenoaddress'},
442 destbranch => $reserve->{'branchcode'},
443 borrowernumber => $reserve->{'borrowernumber'},
444 itemnumber => $reserve->{'itemnumber'},
445 reservenotes => $reserve->{'reservenotes'},
447 } # else { ; } # error?
452 foreach my $code ( keys %$messages ) {
454 my $exit_required_p = 0;
455 if ( $code eq 'BadBarcode' ) {
456 $err{badbarcode} = 1;
457 $err{msg} = $messages->{'BadBarcode'};
459 elsif ( $code eq 'NotIssued' ) {
461 $err{msg} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
463 elsif ( $code eq 'LocalUse' ) {
466 elsif ( $code eq 'WasLost' ) {
469 elsif ( $code eq 'LostItemFeeRefunded' ) {
470 $template->param( LostItemFeeRefunded => 1 );
472 elsif ( $code eq 'ResFound' ) {
473 ; # FIXME... anything to do here?
475 elsif ( $code eq 'WasReturned' ) {
476 ; # FIXME... anything to do here?
478 elsif ( $code eq 'WasTransfered' ) {
479 ; # FIXME... anything to do here?
481 elsif ( $code eq 'withdrawn' ) {
483 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
485 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
486 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
487 $err{ispermanent} = 1;
489 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
492 elsif ( $code eq 'WrongTransfer' ) {
493 ; # FIXME... anything to do here?
495 elsif ( $code eq 'WrongTransferItem' ) {
496 ; # FIXME... anything to do here?
498 elsif ( $code eq 'NeedsTransfer' ) {
500 elsif ( $code eq 'Wrongbranch' ) {
502 elsif ( $code eq 'Debarred' ) {
503 $err{debarred} = $messages->{'Debarred'};
504 $err{debarcardnumber} = $borrower->{cardnumber};
505 $err{debarborrowernumber} = $borrower->{borrowernumber};
506 $err{debarname} = "$borrower->{firstname} $borrower->{surname}";
508 elsif ( $code eq 'PrevDebarred' ) {
509 $err{prevdebarred} = $messages->{'PrevDebarred'};
512 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
513 # This forces the issue of staying in sync w/ Circulation.pm
516 push( @errmsgloop, \%err );
518 last if $exit_required_p;
520 $template->param( errmsgloop => \@errmsgloop );
522 #set up so only the last 8 returned items display (make for faster loading pages)
523 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
526 my $shelflocations = GetKohaAuthorisedValues('items.location','');
527 foreach ( sort { $a <=> $b } keys %returneditems ) {
529 if ( $count++ < $returned_counter ) {
530 my $bar_code = $returneditems{$_};
531 if ($riduedate{$_}) {
532 my $duedate = dt_from_string( $riduedate{$_}, 'sql');
533 $ri{year} = $duedate->year();
534 $ri{month} = $duedate->month();
535 $ri{day} = $duedate->day();
536 $ri{hour} = $duedate->hour();
537 $ri{minute} = $duedate->minute();
538 $ri{duedate} = output_pref($duedate);
539 my ($b) = GetMemberDetails( $riborrowernumber{$_}, 0 );
540 unless ( $dropboxmode ) {
541 $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1);
543 $ri{return_overdue} = 1 if (DateTime->compare($duedate, $dropboxdate) == -1);
545 $ri{borrowernumber} = $b->{'borrowernumber'};
546 $ri{borcnum} = $b->{'cardnumber'};
547 $ri{borfirstname} = $b->{'firstname'};
548 $ri{borsurname} = $b->{'surname'};
549 $ri{bortitle} = $b->{'title'};
550 $ri{bornote} = $b->{'borrowernotes'};
551 $ri{borcategorycode}= $b->{'categorycode'};
554 $ri{borrowernumber} = $riborrowernumber{$_};
558 my $biblio = GetBiblioFromItemNumber(GetItemnumberFromBarcode($bar_code));
559 my $item = GetItem( GetItemnumberFromBarcode($bar_code) );
560 # fix up item type for display
561 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
562 $ri{itembiblionumber} = $biblio->{'biblionumber'};
563 $ri{itemtitle} = $biblio->{'title'};
564 $ri{itemauthor} = $biblio->{'author'};
565 $ri{itemcallnumber} = $biblio->{'itemcallnumber'};
566 $ri{itemtype} = $biblio->{'itemtype'};
567 $ri{itemnote} = $biblio->{'itemnotes'};
568 $ri{ccode} = $biblio->{'ccode'};
569 $ri{itemnumber} = $biblio->{'itemnumber'};
570 $ri{barcode} = $bar_code;
571 $ri{homebranch} = $item->{'homebranch'};
572 $ri{holdingbranch} = $item->{'holdingbranch'};
574 $ri{location} = $biblio->{'location'};
575 my $shelfcode = $ri{'location'};
576 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
584 my ($genbrname, $genprname);
585 if (my $b = $branches->{$userenv_branch}) {
586 $genbrname = $b->{'branchname'};
588 if (my $p = $printers->{$printer}) {
589 $genprname = $p->{'printername'};
593 genbrname => $genbrname,
594 genprname => $genprname,
595 branchname => $genbrname,
597 errmsgloop => \@errmsgloop,
598 exemptfine => $exemptfine,
599 dropboxmode => $dropboxmode,
600 dropboxdate => output_pref($dropboxdate),
601 overduecharges => $overduecharges,
602 soundon => C4::Context->preference("SoundOn"),
603 BlockReturnOfWithdrawnItems => C4::Context->preference("BlockReturnOfWithdrawnItems"),
606 ### Comment out rotating collections for now to allow it a little more time to bake
607 ### for 3.4; in particular, must ensure that it doesn't fight with transfers required
608 ### to fill hold requests
609 ### -- Galen Charlton 2010-10-06
610 #my $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
611 #if ( $itemnumber ) {
612 # my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
613 # if ( ! ( $holdingBranch eq $collectionBranch ) ) {
615 # collectionItemNeedsTransferred => 1,
616 # collectionBranch => GetBranchName($collectionBranch),
621 # actually print the page!
622 output_html_with_http_headers $query, $cookie, $template->output;