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;
52 if (!C4::Context->userenv){
53 my $sessionID = $query->cookie("CGISESSID");
54 my $session = get_session($sessionID);
55 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
56 # no branch set we can't return
57 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
63 my ( $template, $librarian, $cookie ) = get_template_and_user(
65 template_name => "circ/returns.tmpl",
69 flagsrequired => { circulate => "circulate_remaining_permissions" },
75 my $branches = GetBranches();
76 my $printers = GetPrinters();
78 my $printer = C4::Context->userenv ? C4::Context->userenv->{'branchprinter'} : "";
79 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
81 my $userenv_branch = C4::Context->userenv->{'branch'} || '';
83 # Some code to handle the error if there is no branch or printer setting.....
86 # Set up the item stack ....
91 foreach ( $query->param ) {
104 my $barcode = $query->param("ri-$counter");
105 my $duedate = $query->param("dd-$counter");
106 my $borrowernumber = $query->param("bn-$counter");
109 # decode barcode ## Didn't we already decode them before passing them back last time??
110 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
111 $barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
113 ######################
114 #Are these lines still useful ?
115 $returneditems{$counter} = $barcode;
116 $riduedate{$counter} = $duedate;
117 $riborrowernumber{$counter} = $borrowernumber;
119 #######################
120 $input{counter} = $counter;
121 $input{barcode} = $barcode;
122 $input{duedate} = $duedate;
123 $input{borrowernumber} = $borrowernumber;
124 push( @inputloop, \%input );
128 # Deal with the requests....
130 if ($query->param('WT-itemNumber')){
131 updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
134 if ( $query->param('resbarcode') ) {
135 my $item = $query->param('itemnumber');
136 my $borrowernumber = $query->param('borrowernumber');
137 my $resbarcode = $query->param('resbarcode');
138 my $diffBranchReturned = $query->param('diffBranch');
139 my $iteminfo = GetBiblioFromItemNumber($item);
140 # fix up item type for display
141 $iteminfo->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $iteminfo->{'itype'} : $iteminfo->{'itemtype'};
142 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
143 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
144 # i.e., whether to apply waiting status
145 ModReserveAffect( $item, $borrowernumber, $diffBranchSend);
146 # check if we have other reserves for this document, if we have a return send the message of transfer
147 my ( $messages, $nextreservinfo ) = GetOtherReserves($item);
149 my ($borr) = GetMemberDetails( $nextreservinfo, 0 );
150 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
151 if ( $messages->{'transfert'} ) {
153 itemtitle => $iteminfo->{'title'},
154 itemnumber => $iteminfo->{'itemnumber'},
155 itembiblionumber => $iteminfo->{'biblionumber'},
156 iteminfo => $iteminfo->{'author'},
157 tobranchname => GetBranchName($messages->{'transfert'}),
159 borrowernumber => $borrowernumber,
160 borcnum => $borr->{'cardnumber'},
161 borfirstname => $borr->{'firstname'},
162 borsurname => $borr->{'surname'},
171 my $issueinformation;
173 my $barcode = $query->param('barcode');
174 my $exemptfine = $query->param('exemptfine');
175 my $dropboxmode = $query->param('dropboxmode');
176 my $dotransfer = $query->param('dotransfer');
177 my $canceltransfer = $query->param('canceltransfer');
178 my $dest = $query->param('dest');
179 my $calendar = Koha::Calendar->new( branchcode => $userenv_branch );
180 #dropbox: get last open day (today - 1)
181 my $today = DateTime->now( time_zone => C4::Context->tz());
182 my $dropboxdate = $calendar->addDate($today, -1);
184 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
185 my $transferitem = $query->param('transferitem');
186 my $tobranch = $query->param('tobranch');
187 ModItemTransfer($transferitem, $userenv_branch, $tobranch);
190 if ($canceltransfer){
191 $itemnumber=$query->param('itemnumber');
192 DeleteTransfer($itemnumber);
194 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
197 $template->param( transfercancelled => 1);
201 # actually return book and prepare item table.....
203 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
204 $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
205 $itemnumber = GetItemnumberFromBarcode($barcode);
207 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
208 my $item = GetItem( $itemnumber );
209 if ( $item->{'location'} eq 'PROC' ) {
210 $item->{'location'} = 'CART';
211 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
218 ( $returned, $messages, $issueinformation, $borrower ) =
219 AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode); # do the return
220 my $homeorholdingbranchreturn = C4::Context->preference('HomeOrHoldingBranchReturn');
221 $homeorholdingbranchreturn ||= 'homebranch';
223 # get biblio description
224 my $biblio = GetBiblioFromItemNumber($itemnumber);
225 # fix up item type for display
226 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
229 title => $biblio->{'title'},
230 homebranch => $biblio->{'homebranch'},
231 homebranchname => GetBranchName( $biblio->{$homeorholdingbranchreturn} ),
232 author => $biblio->{'author'},
233 itembarcode => $biblio->{'barcode'},
234 itemtype => $biblio->{'itemtype'},
235 ccode => $biblio->{'ccode'},
236 itembiblionumber => $biblio->{'biblionumber'},
237 additional_materials => $biblio->{'materials'}
247 my $time_now = DateTime->now( time_zone => C4::Context->tz )->truncate( to => 'minute');
248 my $duedate = $issueinformation->{date_due}->strftime('%Y-%m-%d %H:%M');
249 $returneditems{0} = $barcode;
250 $riborrowernumber{0} = $borrower->{'borrowernumber'};
251 $riduedate{0} = $duedate;
252 $input{borrowernumber} = $borrower->{'borrowernumber'};
253 $input{duedate} = $duedate;
254 $input{return_overdue} = 1 if (DateTime->compare($issueinformation->{date_due}, $time_now) == -1);
255 push( @inputloop, \%input );
257 if ( C4::Context->preference("FineNotifyAtCheckin") ) {
258 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrower->{'borrowernumber'} );
260 $template->param( fines => sprintf("%.2f",$fines) );
261 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
265 if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
266 #Check for waiting holds
267 my @reserves = GetReservesFromBorrowernumber($borrower->{'borrowernumber'});
269 foreach my $num_res (@reserves) {
270 if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
274 if ($waiting_holds > 0) {
276 waiting_holds => $waiting_holds,
277 holdsborrowernumber => $borrower->{'borrowernumber'},
278 holdsfirstname => $borrower->{'firstname'},
279 holdssurname => $borrower->{'surname'},
284 elsif ( !$messages->{'BadBarcode'} ) {
286 $returneditems{0} = $barcode;
288 push( @inputloop, \%input );
291 $template->param( inputloop => \@inputloop );
297 # new op dev : we check if the document must be returned to his homebranch directly,
298 # if the document is transfered, we have warning message .
300 if ( $messages->{'WasTransfered'} ) {
304 itemnumber => $itemnumber,
308 if ( $messages->{'NeedsTransfer'} ){
312 itemnumber => $itemnumber,
316 if ( $messages->{'Wrongbranch'} ){
322 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
324 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
327 TransferWaitingAt => $messages->{'WrongTransfer'},
328 WrongTransferItem => $messages->{'WrongTransferItem'},
329 itemnumber => $itemnumber,
332 my $reserve = $messages->{'ResFound'};
333 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
334 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
335 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
338 wborfirstname => $borr->{'firstname'},
339 wborsurname => $borr->{'surname'},
340 wbortitle => $borr->{'title'},
341 wborphone => $borr->{'phone'},
342 wboremail => $borr->{'email'},
343 wboraddress => $borr->{'address'},
344 wboraddress2 => $borr->{'address2'},
345 wborcity => $borr->{'city'},
346 wborzip => $borr->{'zipcode'},
347 wborrowernumber => $reserve->{'borrowernumber'},
348 wborcnum => $borr->{'cardnumber'},
349 wtransfertFrom => $userenv_branch,
354 # reserve found and item arrived at the expected branch
356 if ( $messages->{'ResFound'}) {
357 my $reserve = $messages->{'ResFound'};
358 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
359 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
361 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
362 if ( $reserve->{'ResFound'} eq "Waiting" ) {
364 waiting => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
366 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
368 intransit => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
369 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
370 resbarcode => $barcode,
375 # same params for Waiting or Reserved
378 currentbranch => $branches->{$userenv_branch}->{'branchname'},
379 destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
380 name => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
381 borfirstname => $borr->{'firstname'},
382 borsurname => $borr->{'surname'},
383 bortitle => $borr->{'title'},
384 borphone => $borr->{'phone'},
385 boremail => $borr->{'email'},
386 boraddress => $borr->{'address'},
387 boraddress2 => $borr->{'address2'},
388 borcity => $borr->{'city'},
389 borzip => $borr->{'zipcode'},
390 borcnum => $borr->{'cardnumber'},
391 debarred => $borr->{'debarred'},
392 gonenoaddress => $borr->{'gonenoaddress'},
394 destbranch => $reserve->{'branchcode'},
395 borrowernumber => $reserve->{'borrowernumber'},
396 itemnumber => $reserve->{'itemnumber'},
397 reservenotes => $reserve->{'reservenotes'},
399 } # else { ; } # error?
404 foreach my $code ( keys %$messages ) {
406 my $exit_required_p = 0;
407 if ( $code eq 'BadBarcode' ) {
408 $err{badbarcode} = 1;
409 $err{msg} = $messages->{'BadBarcode'};
411 elsif ( $code eq 'NotIssued' ) {
413 $err{msg} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
415 elsif ( $code eq 'LocalUse' ) {
418 elsif ( $code eq 'WasLost' ) {
421 elsif ( $code eq 'LostItemFeeRefunded' ) {
422 $template->param( LostItemFeeRefunded => 1 );
424 elsif ( $code eq 'ResFound' ) {
425 ; # FIXME... anything to do here?
427 elsif ( $code eq 'WasReturned' ) {
428 ; # FIXME... anything to do here?
430 elsif ( $code eq 'WasTransfered' ) {
431 ; # FIXME... anything to do here?
433 elsif ( $code eq 'wthdrawn' ) {
435 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
437 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
438 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
439 $err{ispermanent} = 1;
441 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
444 elsif ( $code eq 'WrongTransfer' ) {
445 ; # FIXME... anything to do here?
447 elsif ( $code eq 'WrongTransferItem' ) {
448 ; # FIXME... anything to do here?
450 elsif ( $code eq 'NeedsTransfer' ) {
452 elsif ( $code eq 'Wrongbranch' ) {
454 elsif ( $code eq 'Debarred' ) {
455 $err{debarred} = $messages->{'Debarred'};
456 $err{debarcardnumber} = $borrower->{cardnumber};
457 $err{debarborrowernumber} = $borrower->{borrowernumber};
458 $err{debarname} = "$borrower->{firstname} $borrower->{surname}";
461 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
462 # This forces the issue of staying in sync w/ Circulation.pm
465 push( @errmsgloop, \%err );
467 last if $exit_required_p;
469 $template->param( errmsgloop => \@errmsgloop );
471 #set up so only the last 8 returned items display (make for faster loading pages)
472 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
475 my $shelflocations = GetKohaAuthorisedValues('items.location','');
476 foreach ( sort { $a <=> $b } keys %returneditems ) {
478 if ( $count++ < $returned_counter ) {
479 my $bar_code = $returneditems{$_};
480 if ($riduedate{$_}) {
481 my $duedate = dt_from_string( $riduedate{$_}, 'sql');
482 $ri{year} = $duedate->year();
483 $ri{month} = $duedate->month();
484 $ri{day} = $duedate->day();
485 $ri{hour} = $duedate->hour();
486 $ri{minute} = $duedate->minute();
487 $ri{duedate} = output_pref($duedate);
488 my ($b) = GetMemberDetails( $riborrowernumber{$_}, 0 );
489 $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1 );
490 $ri{borrowernumber} = $b->{'borrowernumber'};
491 $ri{borcnum} = $b->{'cardnumber'};
492 $ri{borfirstname} = $b->{'firstname'};
493 $ri{borsurname} = $b->{'surname'};
494 $ri{bortitle} = $b->{'title'};
495 $ri{bornote} = $b->{'borrowernotes'};
496 $ri{borcategorycode}= $b->{'categorycode'};
499 $ri{borrowernumber} = $riborrowernumber{$_};
503 my $biblio = GetBiblioFromItemNumber(GetItemnumberFromBarcode($bar_code));
504 my $item = GetItem( GetItemnumberFromBarcode($bar_code) );
505 # fix up item type for display
506 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
507 $ri{itembiblionumber} = $biblio->{'biblionumber'};
508 $ri{itemtitle} = $biblio->{'title'};
509 $ri{itemauthor} = $biblio->{'author'};
510 $ri{itemcallnumber} = $biblio->{'itemcallnumber'};
511 $ri{itemtype} = $biblio->{'itemtype'};
512 $ri{itemnote} = $biblio->{'itemnotes'};
513 $ri{ccode} = $biblio->{'ccode'};
514 $ri{itemnumber} = $biblio->{'itemnumber'};
515 $ri{barcode} = $bar_code;
516 $ri{homebranch} = $item->{'homebranch'};
517 $ri{holdingbranch} = $item->{'holdingbranch'};
519 $ri{location} = $biblio->{'location'};
520 my $shelfcode = $ri{'location'};
521 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
531 genbrname => $branches->{$userenv_branch}->{'branchname'},
532 genprname => $printers->{$printer}->{'printername'},
533 branchname => $branches->{$userenv_branch}->{'branchname'},
535 errmsgloop => \@errmsgloop,
536 exemptfine => $exemptfine,
537 dropboxmode => $dropboxmode,
538 dropboxdate => output_pref($dropboxdate),
539 overduecharges => $overduecharges,
540 soundon => C4::Context->preference("SoundOn"),
541 BlockReturnOfWithdrawnItems => C4::Context->preference("BlockReturnOfWithdrawnItems"),
544 ### Comment out rotating collections for now to allow it a little more time to bake
545 ### for 3.4; in particular, must ensure that it doesn't fight with transfers required
546 ### to fill hold requests
547 ### -- Galen Charlton 2010-10-06
548 #my $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
549 #if ( $itemnumber ) {
550 # my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
551 # if ( ! ( $holdingBranch eq $collectionBranch ) ) {
553 # collectionItemNeedsTransferred => 1,
554 # collectionBranch => GetBranchName($collectionBranch),
559 # actually print the page!
560 output_html_with_http_headers $query, $cookie, $template->output;