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
12 # under the terms of the GNU General Public License as published by
13 # the Free Software Foundation; either version 3 of the License, or
14 # (at your option) any later version.
16 # Koha is distributed in the hope that it will be useful, but
17 # WITHOUT ANY WARRANTY; without even the implied warranty of
18 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 # GNU General Public License for more details.
21 # You should have received a copy of the GNU General Public License
22 # along with Koha; if not, see <http://www.gnu.org/licenses>.
26 script to execute returns of books
34 $SIG{ __DIE__
} = sub { Carp
::confess
( @_ ) };
39 use C4
::Auth qw
/:DEFAULT get_session/;
47 use C4
::Branch
; # GetBranches GetBranchName
48 use C4
::Koha
; # FIXME : is it still useful ?
49 use C4
::RotatingCollections
;
56 my ( $template, $librarian, $cookie ) = get_template_and_user
(
58 template_name
=> "circ/returns.tt",
62 flagsrequired
=> { circulate
=> "circulate_remaining_permissions" },
66 my $sessionID = $query->cookie("CGISESSID");
67 my $session = get_session
($sessionID);
68 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
69 # no branch set we can't return
70 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
74 # Print a reserve slip on this page
75 if ( $query->param('print_slip') ) {
78 borrowernumber
=> scalar $query->param('borrowernumber'),
79 biblionumber
=> scalar $query->param('biblionumber'),
85 my $branches = GetBranches
();
86 my $printers = GetPrinters
();
87 my $userenv = C4
::Context
->userenv;
88 my $userenv_branch = $userenv->{'branch'} // '';
89 my $printer = $userenv->{'branchprinter'} // '';
90 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
92 my $overduecharges = (C4
::Context
->preference('finesMode') && C4
::Context
->preference('finesMode') ne 'off');
94 # Some code to handle the error if there is no branch or printer setting.....
97 # Set up the item stack ....
100 my %riborrowernumber;
102 foreach ( $query->param ) {
115 my $barcode = $query->param("ri-$counter");
116 my $duedate = $query->param("dd-$counter");
117 my $borrowernumber = $query->param("bn-$counter");
120 # decode barcode ## Didn't we already decode them before passing them back last time??
121 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
122 $barcode = barcodedecode
($barcode) if(C4
::Context
->preference('itemBarcodeInputFilter'));
124 ######################
125 #Are these lines still useful ?
126 $returneditems{$counter} = $barcode;
127 $riduedate{$counter} = $duedate;
128 $riborrowernumber{$counter} = $borrowernumber;
130 #######################
131 $input{counter
} = $counter;
132 $input{barcode
} = $barcode;
133 $input{duedate
} = $duedate;
134 $input{borrowernumber
} = $borrowernumber;
135 push( @inputloop, \
%input );
139 # Deal with the requests....
141 if ($query->param('WT-itemNumber')){
142 updateWrongTransfer
($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
145 if ( $query->param('resbarcode') ) {
146 my $item = $query->param('itemnumber');
147 my $borrowernumber = $query->param('borrowernumber');
148 my $resbarcode = $query->param('resbarcode');
149 my $diffBranchReturned = $query->param('diffBranch');
150 my $iteminfo = GetBiblioFromItemNumber
($item);
151 my $cancel_reserve = $query->param('cancel_reserve');
152 # fix up item type for display
153 $iteminfo->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$iteminfo->{'itype'} : $iteminfo->{'itemtype'};
155 if ( $cancel_reserve ) {
156 CancelReserve
({ borrowernumber
=> $borrowernumber, itemnumber
=> $item, charge_cancel_fee
=> !$forgivemanualholdsexpire });
158 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ?
$diffBranchReturned : undef;
159 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
160 # i.e., whether to apply waiting status
161 ModReserveAffect
( $item, $borrowernumber, $diffBranchSend);
163 # check if we have other reserves for this document, if we have a return send the message of transfer
164 my ( $messages, $nextreservinfo ) = GetOtherReserves
($item);
166 my $borr = GetMember
( borrowernumber
=> $nextreservinfo );
167 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
168 if ( $messages->{'transfert'} ) {
170 itemtitle
=> $iteminfo->{'title'},
171 itemnumber
=> $iteminfo->{'itemnumber'},
172 itembiblionumber
=> $iteminfo->{'biblionumber'},
173 iteminfo
=> $iteminfo->{'author'},
174 tobranchname
=> GetBranchName
($messages->{'transfert'}),
176 borrowernumber
=> $borrowernumber,
177 borcnum
=> $borr->{'cardnumber'},
178 borfirstname
=> $borr->{'firstname'},
179 borsurname
=> $borr->{'surname'},
188 my $issueinformation;
190 my $barcode = $query->param('barcode');
191 my $exemptfine = $query->param('exemptfine');
194 !C4
::Auth
::haspermission
(C4
::Context
->userenv->{'id'}, {'updatecharges' => 'writeoff'})
196 # silently prevent unauthorized operator from forgiving overdue
197 # fines by manually tweaking form parameters
200 my $dropboxmode = $query->param('dropboxmode');
201 my $dotransfer = $query->param('dotransfer');
202 my $canceltransfer = $query->param('canceltransfer');
203 my $dest = $query->param('dest');
204 my $calendar = Koha
::Calendar
->new( branchcode
=> $userenv_branch );
205 #dropbox: get last open day (today - 1)
206 my $today = DateTime
->now( time_zone
=> C4
::Context
->tz());
207 my $dropboxdate = $calendar->addDate($today, -1);
209 my $return_date_override = $query->param('return_date_override');
210 my $return_date_override_remember =
211 $query->param('return_date_override_remember');
212 if ($return_date_override) {
213 if ( C4
::Context
->preference('SpecifyReturnDate') ) {
214 my $return_date_override_dt = eval {dt_from_string
( $return_date_override ) };
215 if ( $return_date_override_dt ) {
216 # note that we've overriden the return date
217 $template->param( return_date_was_overriden
=> 1);
218 # Save the original format if we are remembering for this series
220 return_date_override
=> $return_date_override,
221 return_date_override_remember
=> 1
222 ) if ($return_date_override_remember);
224 $return_date_override =
225 DateTime
::Format
::MySQL
->format_datetime( $return_date_override_dt );
229 $return_date_override = q{};
234 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
235 my $transferitem = $query->param('transferitem');
236 my $tobranch = $query->param('tobranch');
237 ModItemTransfer
($transferitem, $userenv_branch, $tobranch);
240 if ($canceltransfer){
241 $itemnumber=$query->param('itemnumber');
242 DeleteTransfer
($itemnumber);
244 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
247 $template->param( transfercancelled
=> 1);
251 # actually return book and prepare item table.....
254 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
255 $barcode = barcodedecode
($barcode) if C4
::Context
->preference('itemBarcodeInputFilter');
256 $itemnumber = GetItemnumberFromBarcode
($barcode);
262 # get biblio description
263 my $biblio = GetBiblioFromItemNumber
($itemnumber);
264 # fix up item type for display
265 $biblio->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$biblio->{'itype'} : $biblio->{'itemtype'};
267 # Check if we should display a checkin message, based on the the item
268 # type of the checked in item
269 my $itemtype = Koha
::ItemTypes
->find( $biblio->{'itemtype'} );
270 if ( $itemtype && $itemtype->checkinmsg ) {
272 checkinmsg
=> $itemtype->checkinmsg,
273 checkinmsgtype
=> $itemtype->checkinmsgtype,
277 # make sure return branch respects home branch circulation rules, default to homebranch
278 my $hbr = GetBranchItemRule
($biblio->{'homebranch'}, $itemtype ?
$itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
279 $returnbranch = $biblio->{$hbr};
281 my $materials = $biblio->{'materials'};
282 my $avcode = GetAuthValCode
('items.materials');
284 $materials = GetKohaAuthorisedValueLib
($avcode, $materials);
288 title
=> $biblio->{'title'},
289 homebranch
=> $biblio->{'homebranch'},
290 holdingbranch
=> $biblio->{'holdingbranch'},
291 returnbranch
=> $returnbranch,
292 author
=> $biblio->{'author'},
293 itembarcode
=> $biblio->{'barcode'},
294 itemtype
=> $biblio->{'itemtype'},
295 ccode
=> $biblio->{'ccode'},
296 itembiblionumber
=> $biblio->{'biblionumber'},
297 biblionumber
=> $biblio->{'biblionumber'},
298 borrower
=> $borrower,
299 additional_materials
=> $materials,
309 ( $returned, $messages, $issueinformation, $borrower ) =
310 AddReturn
( $barcode, $userenv_branch, $exemptfine, $dropboxmode, $return_date_override, $dropboxdate );
313 my $time_now = DateTime
->now( time_zone
=> C4
::Context
->tz )->truncate( to
=> 'minute');
314 my $duedate = $issueinformation->{date_due
}->strftime('%Y-%m-%d %H:%M');
315 $returneditems{0} = $barcode;
316 $riborrowernumber{0} = $borrower->{'borrowernumber'};
317 $riduedate{0} = $duedate;
318 $input{borrowernumber
} = $borrower->{'borrowernumber'};
319 $input{duedate
} = $duedate;
320 unless ( $dropboxmode ) {
321 $input{return_overdue
} = 1 if (DateTime
->compare($issueinformation->{date_due
}, DateTime
->now()) == -1);
323 $input{return_overdue
} = 1 if (DateTime
->compare($issueinformation->{date_due
}, $dropboxdate) == -1);
325 push( @inputloop, \
%input );
327 if ( C4
::Context
->preference("FineNotifyAtCheckin") ) {
328 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
( $borrower->{'borrowernumber'} );
329 if ($fines && $fines > 0) {
330 $template->param( fines
=> sprintf("%.2f",$fines) );
331 $template->param( fineborrowernumber
=> $borrower->{'borrowernumber'} );
335 if (C4
::Context
->preference("WaitingNotifyAtCheckin") ) {
336 #Check for waiting holds
337 my @reserves = GetReservesFromBorrowernumber
($borrower->{'borrowernumber'});
338 my $waiting_holds = 0;
339 foreach my $num_res (@reserves) {
340 if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
344 if ($waiting_holds > 0) {
346 waiting_holds
=> $waiting_holds,
347 holdsborrowernumber
=> $borrower->{'borrowernumber'},
348 holdsfirstname
=> $borrower->{'firstname'},
349 holdssurname
=> $borrower->{'surname'},
353 } elsif ( C4
::Context
->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} ) {
355 $returneditems{0} = $barcode;
357 push( @inputloop, \
%input );
359 $template->param( privacy
=> $borrower->{privacy
} );
361 $template->param( inputloop
=> \
@inputloop );
367 # new op dev : we check if the document must be returned to his homebranch directly,
368 # if the document is transfered, we have warning message .
370 if ( $messages->{'WasTransfered'} ) {
374 itemnumber
=> $itemnumber,
378 if ( $messages->{'NeedsTransfer'} ){
381 needstransfer
=> $messages->{'NeedsTransfer'},
382 itemnumber
=> $itemnumber,
386 if ( $messages->{'Wrongbranch'} ){
389 rightbranch
=> $messages->{'Wrongbranch'}->{'Rightbranch'},
393 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
395 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
398 TransferWaitingAt
=> $messages->{'WrongTransfer'},
399 WrongTransferItem
=> $messages->{'WrongTransferItem'},
400 itemnumber
=> $itemnumber,
403 my $reserve = $messages->{'ResFound'};
404 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
405 my $borr = C4
::Members
::GetMember
( borrowernumber
=> $reserve->{'borrowernumber'} );
406 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
409 wborfirstname
=> $borr->{'firstname'},
410 wborsurname
=> $borr->{'surname'},
411 wbortitle
=> $borr->{'title'},
412 wborphone
=> $borr->{'phone'},
413 wboremail
=> $borr->{'email'},
414 wborstnum
=> $borr->{streetnumber
},
415 wboraddress
=> $borr->{'address'},
416 wboraddress2
=> $borr->{'address2'},
417 wborcity
=> $borr->{'city'},
418 wborzip
=> $borr->{'zipcode'},
419 wborrowernumber
=> $reserve->{'borrowernumber'},
420 wborcnum
=> $borr->{'cardnumber'},
421 wtransfertFrom
=> $userenv_branch,
426 # reserve found and item arrived at the expected branch
428 if ( $messages->{'ResFound'}) {
429 my $reserve = $messages->{'ResFound'};
430 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
431 my $borr = C4
::Members
::GetMember
( borrowernumber
=> $reserve->{'borrowernumber'} );
433 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
434 if ( $reserve->{'ResFound'} eq "Waiting" ) {
436 waiting
=> ($userenv_branch eq $reserve->{'branchcode'} ?
1 : 0 ),
438 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
440 intransit
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
441 transfertodo
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
442 resbarcode
=> $barcode,
447 # same params for Waiting or Reserved
450 currentbranch
=> $branches->{$userenv_branch}->{'branchname'},
451 destbranchname
=> $branches->{ $reserve->{'branchcode'} }->{'branchname'},
452 name
=> $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
453 borfirstname
=> $borr->{'firstname'},
454 borsurname
=> $borr->{'surname'},
455 bortitle
=> $borr->{'title'},
456 borphone
=> $borr->{'phone'},
457 boremail
=> $borr->{'email'},
458 boraddress
=> $borr->{'address'},
459 boraddress2
=> $borr->{'address2'},
460 borstnum
=> $borr->{streetnumber
},
461 borcity
=> $borr->{'city'},
462 borzip
=> $borr->{'zipcode'},
463 borcnum
=> $borr->{'cardnumber'},
464 debarred
=> $borr->{'debarred'},
465 gonenoaddress
=> $borr->{'gonenoaddress'},
467 destbranch
=> $reserve->{'branchcode'},
468 borrowernumber
=> $reserve->{'borrowernumber'},
469 itemnumber
=> $reserve->{'itemnumber'},
470 reservenotes
=> $reserve->{'reservenotes'},
472 } # else { ; } # error?
477 foreach my $code ( keys %$messages ) {
479 my $exit_required_p = 0;
480 if ( $code eq 'BadBarcode' ) {
481 $err{badbarcode
} = 1;
482 $err{msg
} = $messages->{'BadBarcode'};
484 elsif ( $code eq 'NotIssued' ) {
487 $err{msg
} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'} if $messages->{'IsPermanent'};
489 elsif ( $code eq 'LocalUse' ) {
492 elsif ( $code eq 'WasLost' ) {
495 elsif ( $code eq 'LostItemFeeRefunded' ) {
496 $template->param( LostItemFeeRefunded
=> 1 );
498 elsif ( $code eq 'ResFound' ) {
499 ; # FIXME... anything to do here?
501 elsif ( $code eq 'WasReturned' ) {
502 ; # FIXME... anything to do here?
504 elsif ( $code eq 'WasTransfered' ) {
505 ; # FIXME... anything to do here?
507 elsif ( $code eq 'withdrawn' ) {
509 $exit_required_p = 1 if C4
::Context
->preference("BlockReturnOfWithdrawnItems");
511 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
512 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
513 $err{ispermanent
} = 1;
515 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
518 elsif ( $code eq 'WrongTransfer' ) {
519 ; # FIXME... anything to do here?
521 elsif ( $code eq 'WrongTransferItem' ) {
522 ; # FIXME... anything to do here?
524 elsif ( $code eq 'NeedsTransfer' ) {
526 elsif ( $code eq 'Wrongbranch' ) {
528 elsif ( $code eq 'Debarred' ) {
529 $err{debarred
} = $messages->{'Debarred'};
530 $err{debarcardnumber
} = $borrower->{cardnumber
};
531 $err{debarborrowernumber
} = $borrower->{borrowernumber
};
532 $err{debarname
} = "$borrower->{firstname} $borrower->{surname}";
534 elsif ( $code eq 'PrevDebarred' ) {
535 $err{prevdebarred
} = $messages->{'PrevDebarred'};
537 elsif ( $code eq 'ForeverDebarred' ) {
538 $err{foreverdebarred
} = $messages->{'ForeverDebarred'};
540 elsif ( $code eq 'NotForLoanStatusUpdated' ) {
541 $err{NotForLoanStatusUpdated
} = $messages->{NotForLoanStatusUpdated
};
544 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
545 # This forces the issue of staying in sync w/ Circulation.pm
548 push( @errmsgloop, \
%err );
550 last if $exit_required_p;
552 $template->param( errmsgloop
=> \
@errmsgloop );
554 #set up so only the last 8 returned items display (make for faster loading pages)
555 my $returned_counter = ( C4
::Context
->preference('numReturnedItemsToShow') ) ? C4
::Context
->preference('numReturnedItemsToShow') : 8;
558 my $shelflocations = GetKohaAuthorisedValues
('items.location','');
559 foreach ( sort { $a <=> $b } keys %returneditems ) {
561 if ( $count++ < $returned_counter ) {
562 my $bar_code = $returneditems{$_};
563 if ($riduedate{$_}) {
564 my $duedate = dt_from_string
( $riduedate{$_}, 'sql');
565 $ri{year
} = $duedate->year();
566 $ri{month
} = $duedate->month();
567 $ri{day
} = $duedate->day();
568 $ri{hour
} = $duedate->hour();
569 $ri{minute
} = $duedate->minute();
570 $ri{duedate
} = output_pref
($duedate);
571 my $b = C4
::Members
::GetMember
( borrowernumber
=> $riborrowernumber{$_} );
572 unless ( $dropboxmode ) {
573 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, DateTime
->now()) == -1);
575 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, $dropboxdate) == -1);
577 $ri{borrowernumber
} = $b->{'borrowernumber'};
578 $ri{borcnum
} = $b->{'cardnumber'};
579 $ri{borfirstname
} = $b->{'firstname'};
580 $ri{borsurname
} = $b->{'surname'};
581 $ri{bortitle
} = $b->{'title'};
582 $ri{bornote
} = $b->{'borrowernotes'};
583 $ri{borcategorycode
}= $b->{'categorycode'};
586 $ri{borrowernumber
} = $riborrowernumber{$_};
590 my $biblio = GetBiblioFromItemNumber
(GetItemnumberFromBarcode
($bar_code));
591 my $item = GetItem
( GetItemnumberFromBarcode
($bar_code) );
592 # fix up item type for display
593 $biblio->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$biblio->{'itype'} : $biblio->{'itemtype'};
594 $ri{itembiblionumber
} = $biblio->{'biblionumber'};
595 $ri{itemtitle
} = $biblio->{'title'};
596 $ri{itemauthor
} = $biblio->{'author'};
597 $ri{itemcallnumber
} = $biblio->{'itemcallnumber'};
598 $ri{dateaccessioned
} = $item->{dateaccessioned
};
599 $ri{itemtype
} = $biblio->{'itemtype'};
600 $ri{itemnote
} = $biblio->{'itemnotes'};
601 $ri{itemnotes_nonpublic
} = $item->{'itemnotes_nonpublic'};
602 $ri{ccode
} = $biblio->{'ccode'};
603 $ri{itemnumber
} = $biblio->{'itemnumber'};
604 $ri{barcode
} = $bar_code;
605 $ri{homebranch
} = $item->{'homebranch'};
606 $ri{holdingbranch
} = $item->{'holdingbranch'};
608 $ri{location
} = $biblio->{'location'};
609 my $shelfcode = $ri{'location'};
610 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
618 my ($genbrname, $genprname);
619 if (my $b = $branches->{$userenv_branch}) {
620 $genbrname = $b->{'branchname'};
622 if (my $p = $printers->{$printer}) {
623 $genprname = $p->{'printername'};
627 genbrname
=> $genbrname,
628 genprname
=> $genprname,
629 branchname
=> $genbrname,
631 errmsgloop
=> \
@errmsgloop,
632 exemptfine
=> $exemptfine,
633 dropboxmode
=> $dropboxmode,
634 dropboxdate
=> output_pref
($dropboxdate),
635 forgivemanualholdsexpire
=> $forgivemanualholdsexpire,
636 overduecharges
=> $overduecharges,
637 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
638 BlockReturnOfWithdrawnItems
=> C4
::Context
->preference("BlockReturnOfWithdrawnItems"),
641 $itemnumber = GetItemnumberFromBarcode
( $barcode );
643 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches
( $itemnumber );
644 $holdingBranch //= '';
645 $collectionBranch //= $returnbranch;
646 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
648 collectionItemNeedsTransferred
=> 1,
649 collectionBranchName
=> GetBranchName
($collectionBranch),
650 collectionBranch
=> $collectionBranch,
651 itemnumber
=> $itemnumber,
656 # actually print the page!
657 output_html_with_http_headers
$query, $cookie, $template->output;