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'},
266 holdsfirstname => $borrower->{'firstname'},
267 holdssurname => $borrower->{'surname'},
272 elsif ( !$messages->{'BadBarcode'} ) {
274 $returneditems{0} = $barcode;
276 if ( $messages->{'wthdrawn'} ) {
277 $input{withdrawn} = 1;
278 $input{borrowernumber} = 'Item Cancelled'; # FIXME: should be in display layer ?
279 $riborrowernumber{0} = 'Item Cancelled';
282 $input{borrowernumber} = ' '; # This seems clearly bogus.
283 $riborrowernumber{0} = ' ';
285 push( @inputloop, \%input );
288 $template->param( inputloop => \@inputloop );
294 # new op dev : we check if the document must be returned to his homebranch directly,
295 # if the document is transfered, we have warning message .
297 if ( $messages->{'WasTransfered'} ) {
304 if ( $messages->{'NeedsTransfer'} ){
308 itemnumber => $itemnumber,
312 if ( $messages->{'Wrongbranch'} ){
318 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
320 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
321 $messages->{'WrongTransfer'} = GetBranchName( $messages->{'WrongTransfer'} );
324 TransferWaitingAt => $messages->{'WrongTransfer'},
325 WrongTransferItem => $messages->{'WrongTransferItem'},
328 my $reserve = $messages->{'ResFound'};
329 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
330 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
331 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
334 wborfirstname => $borr->{'firstname'},
335 wborsurname => $borr->{'surname'},
336 wbortitle => $borr->{'title'},
337 wborphone => $borr->{'phone'},
338 wboremail => $borr->{'email'},
339 wboraddress => $borr->{'address'},
340 wboraddress2 => $borr->{'address2'},
341 wborcity => $borr->{'city'},
342 wborzip => $borr->{'zipcode'},
343 wborrowernumber => $reserve->{'borrowernumber'},
344 wborcnum => $borr->{'cardnumber'},
345 wtransfertFrom => $userenv_branch,
350 # reserve found and item arrived at the expected branch
352 if ( $messages->{'ResFound'}) {
353 my $reserve = $messages->{'ResFound'};
354 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
355 my ($borr) = GetMemberDetails( $reserve->{'borrowernumber'}, 0 );
357 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
358 if ( $reserve->{'ResFound'} eq "Waiting" ) {
360 waiting => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
362 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
364 intransit => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
365 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
366 resbarcode => $barcode,
371 # same params for Waiting or Reserved
374 currentbranch => $branches->{$userenv_branch}->{'branchname'},
375 destbranchname => $branches->{ $reserve->{'branchcode'} }->{'branchname'},
376 name => $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
377 borfirstname => $borr->{'firstname'},
378 borsurname => $borr->{'surname'},
379 bortitle => $borr->{'title'},
380 borphone => $borr->{'phone'},
381 boremail => $borr->{'email'},
382 boraddress => $borr->{'address'},
383 boraddress2 => $borr->{'address2'},
384 borcity => $borr->{'city'},
385 borzip => $borr->{'zipcode'},
386 borcnum => $borr->{'cardnumber'},
387 debarred => $borr->{'debarred'},
388 gonenoaddress => $borr->{'gonenoaddress'},
390 destbranch => $reserve->{'branchcode'},
391 borrowernumber => $reserve->{'borrowernumber'},
392 itemnumber => $reserve->{'itemnumber'},
393 reservenotes => $reserve->{'reservenotes'},
395 } # else { ; } # error?
400 foreach my $code ( keys %$messages ) {
402 my $exit_required_p = 0;
403 if ( $code eq 'BadBarcode' ) {
404 $err{badbarcode} = 1;
405 $err{msg} = $messages->{'BadBarcode'};
407 elsif ( $code eq 'NotIssued' ) {
409 $err{msg} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
411 elsif ( $code eq 'WasLost' ) {
414 elsif ( $code eq 'ResFound' ) {
415 ; # FIXME... anything to do here?
417 elsif ( $code eq 'WasReturned' ) {
418 ; # FIXME... anything to do here?
420 elsif ( $code eq 'WasTransfered' ) {
421 ; # FIXME... anything to do here?
423 elsif ( $code eq 'wthdrawn' ) {
425 $exit_required_p = 1;
427 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
428 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
429 $err{ispermanent} = 1;
431 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
434 elsif ( $code eq 'WrongTransfer' ) {
435 ; # FIXME... anything to do here?
437 elsif ( $code eq 'WrongTransferItem' ) {
438 ; # FIXME... anything to do here?
440 elsif ( $code eq 'NeedsTransfer' ) {
442 elsif ( $code eq 'Wrongbranch' ) {
446 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
447 # This forces the issue of staying in sync w/ Circulation.pm
450 push( @errmsgloop, \%err );
452 last if $exit_required_p;
454 $template->param( errmsgloop => \@errmsgloop );
458 my $flags = $borrower->{'flags'};
461 foreach my $flag ( sort keys %$flags ) {
463 unless ($flagset) { $flagset = 1; }
464 $flaginfo{redfont} = ( $flags->{$flag}->{'noissues'} );
465 $flaginfo{flag} = $flag;
466 if ( $flag eq 'CHARGES' ) {
467 $flaginfo{msg} = $flag;
468 $flaginfo{charges} = 1;
469 $flaginfo{chargeamount} = $flags->{$flag}->{amount};
470 $flaginfo{borrowernumber} = $borrower->{borrowernumber};
472 elsif ( $flag eq 'WAITING' ) {
473 $flaginfo{msg} = $flag;
474 $flaginfo{waiting} = 1;
476 my $items = $flags->{$flag}->{'itemlist'};
477 foreach my $item (@$items) {
478 my $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'});
479 push @waitingitemloop, {
480 biblionum => $biblio->{'biblionumber'},
481 barcode => $biblio->{'barcode'},
482 title => $biblio->{'title'},
483 brname => $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
486 $flaginfo{itemloop} = \@waitingitemloop;
488 elsif ( $flag eq 'ODUES' ) {
489 my $items = $flags->{$flag}->{'itemlist'};
491 foreach my $item ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
494 my $biblio = GetBiblioFromItemNumber( $item->{'itemnumber'});
496 duedate => format_date($item->{'date_due'}),
497 biblionum => $biblio->{'biblionumber'},
498 barcode => $biblio->{'barcode'},
499 title => $biblio->{'title'},
500 brname => $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
503 $flaginfo{itemloop} = \@itemloop;
504 $flaginfo{overdue} = 1;
507 $flaginfo{other} = 1;
508 $flaginfo{msg} = $flags->{$flag}->{'message'};
510 push( @flagloop, \%flaginfo );
514 flagloop => \@flagloop,
515 riborrowernumber => $borrower->{'borrowernumber'},
516 riborcnum => $borrower->{'cardnumber'},
517 riborsurname => $borrower->{'surname'},
518 ribortitle => $borrower->{'title'},
519 riborfirstname => $borrower->{'firstname'}
523 #set up so only the last 8 returned items display (make for faster loading pages)
524 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
527 foreach ( sort { $a <=> $b } keys %returneditems ) {
529 if ( $count++ < $returned_counter ) {
530 my $bar_code = $returneditems{$_};
531 my $duedate = $riduedate{$_};
533 my @tempdate = split( /-/, $duedate );
534 $ri{year} = $tempdate[0];
535 $ri{month} = $tempdate[1];
536 $ri{day} = $tempdate[2];
537 $ri{duedate} = format_date($duedate);
538 my ($b) = GetMemberDetails( $riborrowernumber{$_}, 0 );
539 $ri{return_overdue} = 1 if ($duedate lt $today->output('iso'));
540 $ri{borrowernumber} = $b->{'borrowernumber'};
541 $ri{borcnum} = $b->{'cardnumber'};
542 $ri{borfirstname} = $b->{'firstname'};
543 $ri{borsurname} = $b->{'surname'};
544 $ri{bortitle} = $b->{'title'};
545 $ri{bornote} = $b->{'borrowernotes'};
546 $ri{borcategorycode}= $b->{'categorycode'};
549 $ri{borrowernumber} = $riborrowernumber{$_};
553 my $biblio = GetBiblioFromItemNumber(GetItemnumberFromBarcode($bar_code));
554 # fix up item type for display
555 $biblio->{'itemtype'} = C4::Context->preference('item-level_itypes') ? $biblio->{'itype'} : $biblio->{'itemtype'};
556 $ri{itembiblionumber} = $biblio->{'biblionumber'};
557 $ri{itemtitle} = $biblio->{'title'};
558 $ri{itemauthor} = $biblio->{'author'};
559 $ri{itemcallnumber} = $biblio->{'itemcallnumber'};
560 $ri{itemtype} = $biblio->{'itemtype'};
561 $ri{itemnote} = $biblio->{'itemnotes'};
562 $ri{ccode} = $biblio->{'ccode'};
563 $ri{itemnumber} = $biblio->{'itemnumber'};
564 $ri{barcode} = $bar_code;
574 genbrname => $branches->{$userenv_branch}->{'branchname'},
575 genprname => $printers->{$printer}->{'printername'},
576 branchname => $branches->{$userenv_branch}->{'branchname'},
578 errmsgloop => \@errmsgloop,
579 exemptfine => $exemptfine,
580 dropboxmode => $dropboxmode,
581 dropboxdate => $dropboxdate->output(),
582 overduecharges => $overduecharges,
583 soundon => C4::Context->preference("SoundOn"),
586 ### Comment out rotating collections for now to allow it a little more time to bake
587 ### for 3.4; in particular, must ensure that it doesn't fight with transfers required
588 ### to fill hold requests
589 ### -- Galen Charlton 2010-10-06
590 #my $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
591 #if ( $itemnumber ) {
592 # my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
593 # if ( ! ( $holdingBranch eq $collectionBranch ) ) {
595 # collectionItemNeedsTransferred => 1,
596 # collectionBranch => GetBranchName($collectionBranch),
601 # actually print the page!
602 output_html_with_http_headers $query, $cookie, $template->output;