3 # Copyright 2000-2002 Katipo Communications
5 # 2007-2010 BibLibre, Paul POULAIN
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 2 of the License, or (at your option) any later
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 script to execute returns of books
29 #use warnings; FIXME - Bug 2505
33 use C4::Auth qw/:DEFAULT get_session/;
36 use C4::Dates qw/format_date/;
37 use Date::Calc qw/Add_Delta_Days/;
44 use C4::Branch; # GetBranches GetBranchName
45 use C4::Koha; # FIXME : is it still useful ?
46 use C4::RotatingCollections;
50 if (!C4::Context->userenv){
51 my $sessionID = $query->cookie("CGISESSID");
52 my $session = get_session($sessionID);
53 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
54 # no branch set we can't return
55 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
61 my ( $template, $librarian, $cookie ) = get_template_and_user(
63 template_name => "circ/returns.tmpl",
67 flagsrequired => { circulate => "circulate_remaining_permissions" },
73 my $branches = GetBranches();
74 my $printers = GetPrinters();
76 my $printer = C4::Context->userenv ? C4::Context->userenv->{'branchprinter'} : "";
77 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
79 my $userenv_branch = C4::Context->userenv->{'branch'} || '';
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 itembiblionumber => $iteminfo->{'biblionumber'},
153 iteminfo => $iteminfo->{'author'},
154 tobranchname => GetBranchName($messages->{'transfert'}),
156 borrowernumber => $borrowernumber,
157 borcnum => $borr->{'cardnumber'},
158 borfirstname => $borr->{'firstname'},
159 borsurname => $borr->{'surname'},
168 my $issueinformation;
170 my $barcode = $query->param('barcode');
171 my $exemptfine = $query->param('exemptfine');
172 my $dropboxmode = $query->param('dropboxmode');
173 my $dotransfer = $query->param('dotransfer');
174 my $calendar = C4::Calendar->new( branchcode => $userenv_branch );
175 #dropbox: get last open day (today - 1)
176 my $today = C4::Dates->new();
177 my $today_iso = $today->output('iso');
178 my $dropboxdate = $calendar->addDate($today, -1);
180 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
181 my $transferitem = $query->param('transferitem');
182 my $tobranch = $query->param('tobranch');
183 ModItemTransfer($transferitem, $userenv_branch, $tobranch);
186 # actually return book and prepare item table.....
188 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
189 $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
190 $itemnumber = GetItemnumberFromBarcode($barcode);
192 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
193 my $item = GetItem( $itemnumber );
194 if ( $item->{'location'} eq 'PROC' ) {
195 $item->{'location'} = 'CART';
196 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
200 if ( C4::Context->preference("ReturnToShelvingCart") ) {
201 my $item = GetItem( $itemnumber );
202 $item->{'location'} = 'CART';
203 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
209 ( $returned, $messages, $issueinformation, $borrower ) =
210 AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode); # do the return
211 my $homeorholdingbranchreturn = C4::Context->preference('HomeOrHoldingBranchReturn') or 'homebranch';
213 # get biblio description
214 my $biblio = GetBiblioFromItemNumber($itemnumber);
215 # fix up item type for display
216 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
219 title => $biblio->{'title'},
220 homebranch => $biblio->{'homebranch'},
221 homebranchname => GetBranchName( $biblio->{$homeorholdingbranchreturn} ),
222 author => $biblio->{'author'},
223 itembarcode => $biblio->{'barcode'},
224 itemtype => $biblio->{'itemtype'},
225 ccode => $biblio->{'ccode'},
226 itembiblionumber => $biblio->{'biblionumber'},
236 my $duedate = $issueinformation->{'date_due'};
237 $returneditems{0} = $barcode;
238 $riborrowernumber{0} = $borrower->{'borrowernumber'};
239 $riduedate{0} = $duedate;
240 $input{borrowernumber} = $borrower->{'borrowernumber'};
241 $input{duedate} = $duedate;
242 $input{return_overdue} = 1 if ($duedate and $duedate lt $today->output('iso'));
243 push( @inputloop, \%input );
245 if ( C4::Context->preference("FineNotifyAtCheckin") ) {
246 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines( $borrower->{'borrowernumber'} );
248 $template->param( fines => sprintf("%.2f",$fines) );
249 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
253 if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
254 #Check for waiting holds
255 my @reserves = GetReservesFromBorrowernumber($borrower->{'borrowernumber'});
257 foreach my $num_res (@reserves) {
258 if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
262 if ($waiting_holds > 0) {
264 waiting_holds => $waiting_holds,
265 holdsborrowernumber => $borrower->{'borrowernumber'},
270 elsif ( !$messages->{'BadBarcode'} ) {
272 $returneditems{0} = $barcode;
274 if ( $messages->{'wthdrawn'} ) {
275 $input{withdrawn} = 1;
276 $input{borrowernumber} = 'Item Cancelled'; # FIXME: should be in display layer ?
277 $riborrowernumber{0} = 'Item Cancelled';
280 $input{borrowernumber} = ' '; # This seems clearly bogus.
281 $riborrowernumber{0} = ' ';
283 push( @inputloop, \%input );
286 $template->param( inputloop => \@inputloop );
292 # new op dev : we check if the document must be returned to his homebranch directly,
293 # if the document is transfered, we have warning message .
295 if ( $messages->{'WasTransfered'} ) {
302 if ( $messages->{'NeedsTransfer'} ){
306 itemnumber => $itemnumber,
310 if ( $messages->{'Wrongbranch'} ){
316 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
318 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
319 $messages->{'WrongTransfer'} = GetBranchName( $messages->{'WrongTransfer'} );
322 TransferWaitingAt => $messages->{'WrongTransfer'},
323 WrongTransferItem => $messages->{'WrongTransferItem'},
326 my $reserve = $messages->{'ResFound'};
327 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
328 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
329 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
332 wborfirstname => $borr->{'firstname'},
333 wborsurname => $borr->{'surname'},
334 wbortitle => $borr->{'title'},
335 wborphone => $borr->{'phone'},
336 wboremail => $borr->{'email'},
337 wboraddress => $borr->{'address'},
338 wboraddress2 => $borr->{'address2'},
339 wborcity => $borr->{'city'},
340 wborzip => $borr->{'zipcode'},
341 wborrowernumber => $reserve->{'borrowernumber'},
342 wborcnum => $borr->{'cardnumber'},
343 wtransfertFrom => $userenv_branch,
348 # reserve found and item arrived at the expected branch
350 if ( $messages->{'ResFound'}) {
351 my $reserve = $messages->{'ResFound'};
352 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
353 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
355 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
356 if ( $reserve->{'ResFound'} eq "Waiting" ) {
358 waiting => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
360 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
362 intransit => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
363 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
364 resbarcode => $barcode,
369 # same params for Waiting or Reserved
372 currentbranch => $branches->{$userenv_branch}->{'branchname'},
373 destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
374 name => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
375 borfirstname => $borr->{'firstname'},
376 borsurname => $borr->{'surname'},
377 bortitle => $borr->{'title'},
378 borphone => $borr->{'phone'},
379 boremail => $borr->{'email'},
380 boraddress => $borr->{'address'},
381 boraddress2 => $borr->{'address2'},
382 borcity => $borr->{'city'},
383 borzip => $borr->{'zipcode'},
384 borcnum => $borr->{'cardnumber'},
385 debarred => $borr->{'debarred'},
386 gonenoaddress => $borr->{'gonenoaddress'},
388 destbranch => $reserve->{'branchcode'},
389 borrowernumber => $reserve->{'borrowernumber'},
390 itemnumber => $reserve->{'itemnumber'},
391 reservenotes => $reserve->{'reservenotes'},
393 } # else { ; } # error?
398 foreach my $code ( keys %$messages ) {
400 my $exit_required_p = 0;
401 if ( $code eq 'BadBarcode' ) {
402 $err{badbarcode} = 1;
403 $err{msg} = $messages->{'BadBarcode'};
405 elsif ( $code eq 'NotIssued' ) {
407 $err{msg} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
409 elsif ( $code eq 'WasLost' ) {
412 elsif ( $code eq 'ResFound' ) {
413 ; # FIXME... anything to do here?
415 elsif ( $code eq 'WasReturned' ) {
416 ; # FIXME... anything to do here?
418 elsif ( $code eq 'WasTransfered' ) {
419 ; # FIXME... anything to do here?
421 elsif ( $code eq 'wthdrawn' ) {
423 $exit_required_p = 1;
425 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
426 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
427 $err{ispermanent} = 1;
429 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
432 elsif ( $code eq 'WrongTransfer' ) {
433 ; # FIXME... anything to do here?
435 elsif ( $code eq 'WrongTransferItem' ) {
436 ; # FIXME... anything to do here?
438 elsif ( $code eq 'NeedsTransfer' ) {
440 elsif ( $code eq 'Wrongbranch' ) {
444 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
445 # This forces the issue of staying in sync w/ Circulation.pm
448 push( @errmsgloop, \%err );
450 last if $exit_required_p;
452 $template->param( errmsgloop => \@errmsgloop );
456 my $flags = $borrower->{'flags'};
459 foreach my $flag ( sort keys %$flags ) {
461 unless ($flagset) { $flagset = 1; }
462 $flaginfo{redfont} = ( $flags->{$flag}->{'noissues'} );
463 $flaginfo{flag} = $flag;
464 if ( $flag eq 'CHARGES' ) {
465 $flaginfo{msg} = $flag;
466 $flaginfo{charges} = 1;
467 $flaginfo{chargeamount} = $flags->{$flag}->{amount};
468 $flaginfo{borrowernumber} = $borrower->{borrowernumber};
470 elsif ( $flag eq 'WAITING' ) {
471 $flaginfo{msg} = $flag;
472 $flaginfo{waiting} = 1;
474 my $items = $flags->{$flag}->{'itemlist'};
475 foreach my $item (@$items) {
476 my $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'});
477 push @waitingitemloop, {
478 biblionum => $biblio->{'biblionumber'},
479 barcode => $biblio->{'barcode'},
480 title => $biblio->{'title'},
481 brname => $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
484 $flaginfo{itemloop} = \@waitingitemloop;
486 elsif ( $flag eq 'ODUES' ) {
487 my $items = $flags->{$flag}->{'itemlist'};
489 foreach my $item ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
492 my $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'});
494 duedate => format_date($item->{'date_due'}),
495 biblionum => $biblio->{'biblionumber'},
496 barcode => $biblio->{'barcode'},
497 title => $biblio->{'title'},
498 brname => $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
501 $flaginfo{itemloop} = \@itemloop;
502 $flaginfo{overdue} = 1;
505 $flaginfo{other} = 1;
506 $flaginfo{msg} = $flags->{$flag}->{'message'};
508 push( @flagloop, \%flaginfo );
512 flagloop => \@flagloop,
513 riborrowernumber => $borrower->{'borrowernumber'},
514 riborcnum => $borrower->{'cardnumber'},
515 riborsurname => $borrower->{'surname'},
516 ribortitle => $borrower->{'title'},
517 riborfirstname => $borrower->{'firstname'}
521 #set up so only the last 8 returned items display (make for faster loading pages)
522 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
525 foreach ( sort { $a <=> $b } keys %returneditems ) {
527 if ( $count++ < $returned_counter ) {
528 my $bar_code = $returneditems{$_};
529 my $duedate = $riduedate{$_};
531 my @tempdate = split( /-/, $duedate );
532 $ri{year} = $tempdate[0];
533 $ri{month} = $tempdate[1];
534 $ri{day} = $tempdate[2];
535 $ri{duedate} = format_date($duedate);
536 my ($b) = GetMemberDetails( $riborrowernumber{$_}, 0 );
537 $ri{return_overdue} = 1 if ($duedate lt $today->output('iso'));
538 $ri{borrowernumber} = $b->{'borrowernumber'};
539 $ri{borcnum} = $b->{'cardnumber'};
540 $ri{borfirstname} = $b->{'firstname'};
541 $ri{borsurname} = $b->{'surname'};
542 $ri{bortitle} = $b->{'title'};
543 $ri{bornote} = $b->{'borrowernotes'};
544 $ri{borcategorycode}= $b->{'categorycode'};
547 $ri{borrowernumber} = $riborrowernumber{$_};
551 my $biblio = GetBiblioFromItemNumber(GetItemnumberFromBarcode($bar_code));
552 # fix up item type for display
553 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
554 $ri{itembiblionumber} = $biblio->{'biblionumber'};
555 $ri{itemtitle} = $biblio->{'title'};
556 $ri{itemauthor} = $biblio->{'author'};
557 $ri{itemcallnumber} = $biblio->{'itemcallnumber'};
558 $ri{itemtype} = $biblio->{'itemtype'};
559 $ri{itemnote} = $biblio->{'itemnotes'};
560 $ri{ccode} = $biblio->{'ccode'};
561 $ri{itemnumber} = $biblio->{'itemnumber'};
562 $ri{barcode} = $bar_code;
572 genbrname => $branches->{$userenv_branch}->{'branchname'},
573 genprname => $printers->{$printer}->{'printername'},
574 branchname => $branches->{$userenv_branch}->{'branchname'},
576 errmsgloop => \@errmsgloop,
577 exemptfine => $exemptfine,
578 dropboxmode => $dropboxmode,
579 dropboxdate => $dropboxdate->output(),
580 overduecharges => $overduecharges,
581 soundon => C4::Context->preference("SoundOn"),
584 ### Comment out rotating collections for now to allow it a little more time to bake
585 ### for 3.4; in particular, must ensure that it doesn't fight with transfers required
586 ### to fill hold requests
587 ### -- Galen Charlton 2010-10-06
588 #my $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
589 #if ( $itemnumber ) {
590 # my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
591 # if ( ! ( $holdingBranch eq $collectionBranch ) ) {
593 # collectionItemNeedsTransferred => 1,
594 # collectionBranch => GetBranchName($collectionBranch),
599 # actually print the page!
600 output_html_with_http_headers $query, $cookie, $template->output;