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 if ( $messages->{'wthdrawn'} ) {
289 $input{withdrawn
} = 1;
290 $input{borrowernumber
} = 'Item Cancelled'; # FIXME: should be in display layer ?
291 $riborrowernumber{0} = 'Item Cancelled';
294 $input{borrowernumber
} = ' '; # This seems clearly bogus.
295 $riborrowernumber{0} = ' ';
297 push( @inputloop, \
%input );
300 $template->param( inputloop
=> \
@inputloop );
306 # new op dev : we check if the document must be returned to his homebranch directly,
307 # if the document is transfered, we have warning message .
309 if ( $messages->{'WasTransfered'} ) {
313 itemnumber
=> $itemnumber,
317 if ( $messages->{'NeedsTransfer'} ){
321 itemnumber
=> $itemnumber,
325 if ( $messages->{'Wrongbranch'} ){
331 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
333 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
336 TransferWaitingAt
=> $messages->{'WrongTransfer'},
337 WrongTransferItem
=> $messages->{'WrongTransferItem'},
338 itemnumber
=> $itemnumber,
341 my $reserve = $messages->{'ResFound'};
342 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
343 my ($borr) = GetMemberDetails
( $reserve->{'borrowernumber'}, 0 );
344 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
347 wborfirstname
=> $borr->{'firstname'},
348 wborsurname
=> $borr->{'surname'},
349 wbortitle
=> $borr->{'title'},
350 wborphone
=> $borr->{'phone'},
351 wboremail
=> $borr->{'email'},
352 wboraddress
=> $borr->{'address'},
353 wboraddress2
=> $borr->{'address2'},
354 wborcity
=> $borr->{'city'},
355 wborzip
=> $borr->{'zipcode'},
356 wborrowernumber
=> $reserve->{'borrowernumber'},
357 wborcnum
=> $borr->{'cardnumber'},
358 wtransfertFrom
=> $userenv_branch,
363 # reserve found and item arrived at the expected branch
365 if ( $messages->{'ResFound'}) {
366 my $reserve = $messages->{'ResFound'};
367 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
368 my ($borr) = GetMemberDetails
( $reserve->{'borrowernumber'}, 0 );
370 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
371 if ( $reserve->{'ResFound'} eq "Waiting" ) {
373 waiting
=> ($userenv_branch eq $reserve->{'branchcode'} ?
1 : 0 ),
375 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
377 intransit
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
378 transfertodo
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
379 resbarcode
=> $barcode,
384 # same params for Waiting or Reserved
387 currentbranch
=> $branches->{$userenv_branch}->{'branchname'},
388 destbranchname
=> $branches->{ $reserve->{'branchcode'} }->{'branchname'},
389 name
=> $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
390 borfirstname
=> $borr->{'firstname'},
391 borsurname
=> $borr->{'surname'},
392 bortitle
=> $borr->{'title'},
393 borphone
=> $borr->{'phone'},
394 boremail
=> $borr->{'email'},
395 boraddress
=> $borr->{'address'},
396 boraddress2
=> $borr->{'address2'},
397 borcity
=> $borr->{'city'},
398 borzip
=> $borr->{'zipcode'},
399 borcnum
=> $borr->{'cardnumber'},
400 debarred
=> $borr->{'debarred'},
401 gonenoaddress
=> $borr->{'gonenoaddress'},
403 destbranch
=> $reserve->{'branchcode'},
404 borrowernumber
=> $reserve->{'borrowernumber'},
405 itemnumber
=> $reserve->{'itemnumber'},
406 reservenotes
=> $reserve->{'reservenotes'},
408 } # else { ; } # error?
413 foreach my $code ( keys %$messages ) {
415 my $exit_required_p = 0;
416 if ( $code eq 'BadBarcode' ) {
417 $err{badbarcode
} = 1;
418 $err{msg
} = $messages->{'BadBarcode'};
420 elsif ( $code eq 'NotIssued' ) {
422 $err{msg
} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
424 elsif ( $code eq 'LocalUse' ) {
427 elsif ( $code eq 'WasLost' ) {
430 elsif ( $code eq 'ResFound' ) {
431 ; # FIXME... anything to do here?
433 elsif ( $code eq 'WasReturned' ) {
434 ; # FIXME... anything to do here?
436 elsif ( $code eq 'WasTransfered' ) {
437 ; # FIXME... anything to do here?
439 elsif ( $code eq 'wthdrawn' ) {
441 $exit_required_p = 1;
443 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
444 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
445 $err{ispermanent
} = 1;
447 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
450 elsif ( $code eq 'WrongTransfer' ) {
451 ; # FIXME... anything to do here?
453 elsif ( $code eq 'WrongTransferItem' ) {
454 ; # FIXME... anything to do here?
456 elsif ( $code eq 'NeedsTransfer' ) {
458 elsif ( $code eq 'Wrongbranch' ) {
460 elsif ( $code eq 'Debarred' ) {
461 $err{debarred
} = $messages->{'Debarred'};
462 $err{debarcardnumber
} = $borrower->{cardnumber
};
463 $err{debarborrowernumber
} = $borrower->{borrowernumber
};
464 $err{debarname
} = "$borrower->{firstname} $borrower->{surname}";
467 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
468 # This forces the issue of staying in sync w/ Circulation.pm
471 push( @errmsgloop, \
%err );
473 last if $exit_required_p;
475 $template->param( errmsgloop
=> \
@errmsgloop );
479 my $flags = $borrower->{'flags'};
482 foreach my $flag ( sort keys %$flags ) {
484 unless ($flagset) { $flagset = 1; }
485 $flaginfo{redfont
} = ( $flags->{$flag}->{'noissues'} );
486 $flaginfo{flag
} = $flag;
487 if ( $flag eq 'CHARGES' ) {
488 $flaginfo{msg
} = $flag;
489 $flaginfo{charges
} = 1;
490 $flaginfo{chargeamount
} = $flags->{$flag}->{amount
};
491 $flaginfo{borrowernumber
} = $borrower->{borrowernumber
};
493 elsif ( $flag eq 'WAITING' ) {
494 $flaginfo{msg
} = $flag;
495 $flaginfo{waiting
} = 1;
497 my $items = $flags->{$flag}->{'itemlist'};
498 foreach my $item (@
$items) {
499 my $biblio = GetBiblioFromItemNumber
( $item->{'itemnumber'});
500 push @waitingitemloop, {
501 biblionum
=> $biblio->{'biblionumber'},
502 barcode
=> $biblio->{'barcode'},
503 title
=> $biblio->{'title'},
504 brname
=> $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
507 $flaginfo{itemloop
} = \
@waitingitemloop;
509 elsif ( $flag eq 'ODUES' ) {
510 my $items = $flags->{$flag}->{'itemlist'};
512 foreach my $item ( sort { $a->{'date_due'} cmp $b->{'date_due'} }
515 my $biblio = GetBiblioFromItemNumber
( $item->{'itemnumber'});
517 duedate
=> format_sqldatetime
($item->{date_due
}),
518 biblionum
=> $biblio->{'biblionumber'},
519 barcode
=> $biblio->{'barcode'},
520 title
=> $biblio->{'title'},
521 brname
=> $branches->{ $biblio->{'holdingbranch'} }->{'branchname'},
524 $flaginfo{itemloop
} = \
@itemloop;
525 $flaginfo{overdue
} = 1;
528 $flaginfo{other
} = 1;
529 $flaginfo{msg
} = $flags->{$flag}->{'message'};
531 push( @flagloop, \
%flaginfo );
535 flagloop
=> \
@flagloop,
536 riborrowernumber
=> $borrower->{'borrowernumber'},
537 riborcnum
=> $borrower->{'cardnumber'},
538 riborsurname
=> $borrower->{'surname'},
539 ribortitle
=> $borrower->{'title'},
540 riborfirstname
=> $borrower->{'firstname'}
543 #set up so only the last 8 returned items display (make for faster loading pages)
544 my $returned_counter = ( C4
::Context
->preference('numReturnedItemsToShow') ) ? C4
::Context
->preference('numReturnedItemsToShow') : 8;
547 my $shelflocations = GetKohaAuthorisedValues
('items.location','');
548 foreach ( sort { $a <=> $b } keys %returneditems ) {
550 if ( $count++ < $returned_counter ) {
551 my $bar_code = $returneditems{$_};
552 if ($riduedate{$_}) {
553 my $duedate = dt_from_string
( $riduedate{$_}, 'sql');
554 $ri{year
} = $duedate->year();
555 $ri{month
} = $duedate->month();
556 $ri{day
} = $duedate->day();
557 $ri{hour
} = $duedate->hour();
558 $ri{minute
} = $duedate->minute();
559 $ri{duedate
} = output_pref
($duedate);
560 my ($b) = GetMemberDetails
( $riborrowernumber{$_}, 0 );
561 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, DateTime
->now()) == -1 );
562 $ri{borrowernumber
} = $b->{'borrowernumber'};
563 $ri{borcnum
} = $b->{'cardnumber'};
564 $ri{borfirstname
} = $b->{'firstname'};
565 $ri{borsurname
} = $b->{'surname'};
566 $ri{bortitle
} = $b->{'title'};
567 $ri{bornote
} = $b->{'borrowernotes'};
568 $ri{borcategorycode
}= $b->{'categorycode'};
571 $ri{borrowernumber
} = $riborrowernumber{$_};
575 my $biblio = GetBiblioFromItemNumber
(GetItemnumberFromBarcode
($bar_code));
576 my $item = GetItem
( GetItemnumberFromBarcode
($bar_code) );
577 # fix up item type for display
578 $biblio->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$biblio->{'itype'} : $biblio->{'itemtype'};
579 $ri{itembiblionumber
} = $biblio->{'biblionumber'};
580 $ri{itemtitle
} = $biblio->{'title'};
581 $ri{itemauthor
} = $biblio->{'author'};
582 $ri{itemcallnumber
} = $biblio->{'itemcallnumber'};
583 $ri{itemtype
} = $biblio->{'itemtype'};
584 $ri{itemnote
} = $biblio->{'itemnotes'};
585 $ri{ccode
} = $biblio->{'ccode'};
586 $ri{itemnumber
} = $biblio->{'itemnumber'};
587 $ri{barcode
} = $bar_code;
588 $ri{homebranch
} = $item->{'homebranch'};
589 $ri{holdingbranch
} = $item->{'holdingbranch'};
591 $ri{location
} = $biblio->{'location'};
592 my $shelfcode = $ri{'location'};
593 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
603 genbrname
=> $branches->{$userenv_branch}->{'branchname'},
604 genprname
=> $printers->{$printer}->{'printername'},
605 branchname
=> $branches->{$userenv_branch}->{'branchname'},
607 errmsgloop
=> \
@errmsgloop,
608 exemptfine
=> $exemptfine,
609 dropboxmode
=> $dropboxmode,
610 dropboxdate
=> output_pref
($dropboxdate),
611 overduecharges
=> $overduecharges,
612 soundon
=> C4
::Context
->preference("SoundOn"),
615 ### Comment out rotating collections for now to allow it a little more time to bake
616 ### for 3.4; in particular, must ensure that it doesn't fight with transfers required
617 ### to fill hold requests
618 ### -- Galen Charlton 2010-10-06
619 #my $itemnumber = GetItemnumberFromBarcode( $query->param('barcode') );
620 #if ( $itemnumber ) {
621 # my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
622 # if ( ! ( $holdingBranch eq $collectionBranch ) ) {
624 # collectionItemNeedsTransferred => 1,
625 # collectionBranch => GetBranchName($collectionBranch),
630 # actually print the page!
631 output_html_with_http_headers
$query, $cookie, $template->output;