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.....
253 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
254 $barcode = barcodedecode
($barcode) if C4
::Context
->preference('itemBarcodeInputFilter');
255 $itemnumber = GetItemnumberFromBarcode
($barcode);
261 # get biblio description
262 my $biblio = GetBiblioFromItemNumber
($itemnumber);
263 # fix up item type for display
264 $biblio->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$biblio->{'itype'} : $biblio->{'itemtype'};
266 # Check if we should display a checkin message, based on the the item
267 # type of the checked in item
268 my $itemtype = C4
::ItemType
->get( $biblio->{'itemtype'} );
269 if ( $itemtype->{'checkinmsg'} ) {
271 checkinmsg
=> $itemtype->{'checkinmsg'},
272 checkinmsgtype
=> $itemtype->{'checkinmsgtype'},
276 # make sure return branch respects home branch circulation rules, default to homebranch
277 my $hbr = GetBranchItemRule
($biblio->{'homebranch'}, $itemtype->{itemtype
})->{'returnbranch'} || "homebranch";
278 my $returnbranch = $biblio->{$hbr} ;
281 title
=> $biblio->{'title'},
282 homebranch
=> $biblio->{'homebranch'},
283 holdingbranch
=> $biblio->{'holdingbranch'},
284 returnbranch
=> $returnbranch,
285 author
=> $biblio->{'author'},
286 itembarcode
=> $biblio->{'barcode'},
287 itemtype
=> $biblio->{'itemtype'},
288 ccode
=> $biblio->{'ccode'},
289 itembiblionumber
=> $biblio->{'biblionumber'},
290 biblionumber
=> $biblio->{'biblionumber'},
291 borrower
=> $borrower,
292 additional_materials
=> $biblio->{'materials'},
302 ( $returned, $messages, $issueinformation, $borrower ) =
303 AddReturn
( $barcode, $userenv_branch, $exemptfine, $dropboxmode, $return_date_override, $dropboxdate );
306 my $time_now = DateTime
->now( time_zone
=> C4
::Context
->tz )->truncate( to
=> 'minute');
307 my $duedate = $issueinformation->{date_due
}->strftime('%Y-%m-%d %H:%M');
308 $returneditems{0} = $barcode;
309 $riborrowernumber{0} = $borrower->{'borrowernumber'};
310 $riduedate{0} = $duedate;
311 $input{borrowernumber
} = $borrower->{'borrowernumber'};
312 $input{duedate
} = $duedate;
313 unless ( $dropboxmode ) {
314 $input{return_overdue
} = 1 if (DateTime
->compare($issueinformation->{date_due
}, DateTime
->now()) == -1);
316 $input{return_overdue
} = 1 if (DateTime
->compare($issueinformation->{date_due
}, $dropboxdate) == -1);
318 push( @inputloop, \
%input );
320 if ( C4
::Context
->preference("FineNotifyAtCheckin") ) {
321 my ( $od, $issue, $fines ) = GetMemberIssuesAndFines
( $borrower->{'borrowernumber'} );
322 if ($fines && $fines > 0) {
323 $template->param( fines
=> sprintf("%.2f",$fines) );
324 $template->param( fineborrowernumber
=> $borrower->{'borrowernumber'} );
328 if (C4
::Context
->preference("WaitingNotifyAtCheckin") ) {
329 #Check for waiting holds
330 my @reserves = GetReservesFromBorrowernumber
($borrower->{'borrowernumber'});
331 my $waiting_holds = 0;
332 foreach my $num_res (@reserves) {
333 if ( $num_res->{'found'} eq 'W' && $num_res->{'branchcode'} eq $userenv_branch) {
337 if ($waiting_holds > 0) {
339 waiting_holds
=> $waiting_holds,
340 holdsborrowernumber
=> $borrower->{'borrowernumber'},
341 holdsfirstname
=> $borrower->{'firstname'},
342 holdssurname
=> $borrower->{'surname'},
346 } elsif ( C4
::Context
->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} ) {
348 $returneditems{0} = $barcode;
350 push( @inputloop, \
%input );
352 $template->param( privacy
=> $borrower->{privacy
} );
354 $template->param( inputloop
=> \
@inputloop );
360 # new op dev : we check if the document must be returned to his homebranch directly,
361 # if the document is transfered, we have warning message .
363 if ( $messages->{'WasTransfered'} ) {
367 itemnumber
=> $itemnumber,
371 if ( $messages->{'NeedsTransfer'} ){
374 needstransfer
=> $messages->{'NeedsTransfer'},
375 itemnumber
=> $itemnumber,
379 if ( $messages->{'Wrongbranch'} ){
382 rightbranch
=> $messages->{'Wrongbranch'}->{'Rightbranch'},
386 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
388 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
391 TransferWaitingAt
=> $messages->{'WrongTransfer'},
392 WrongTransferItem
=> $messages->{'WrongTransferItem'},
393 itemnumber
=> $itemnumber,
396 my $reserve = $messages->{'ResFound'};
397 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
398 my $borr = C4
::Members
::GetMember
( borrowernumber
=> $reserve->{'borrowernumber'} );
399 my $name = $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'};
402 wborfirstname
=> $borr->{'firstname'},
403 wborsurname
=> $borr->{'surname'},
404 wbortitle
=> $borr->{'title'},
405 wborphone
=> $borr->{'phone'},
406 wboremail
=> $borr->{'email'},
407 wborstnum
=> $borr->{streetnumber
},
408 wboraddress
=> $borr->{'address'},
409 wboraddress2
=> $borr->{'address2'},
410 wborcity
=> $borr->{'city'},
411 wborzip
=> $borr->{'zipcode'},
412 wborrowernumber
=> $reserve->{'borrowernumber'},
413 wborcnum
=> $borr->{'cardnumber'},
414 wtransfertFrom
=> $userenv_branch,
419 # reserve found and item arrived at the expected branch
421 if ( $messages->{'ResFound'}) {
422 my $reserve = $messages->{'ResFound'};
423 my $branchname = $branches->{ $reserve->{'branchcode'} }->{'branchname'};
424 my $borr = C4
::Members
::GetMember
( borrowernumber
=> $reserve->{'borrowernumber'} );
426 if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
427 if ( $reserve->{'ResFound'} eq "Waiting" ) {
429 waiting
=> ($userenv_branch eq $reserve->{'branchcode'} ?
1 : 0 ),
431 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
433 intransit
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
434 transfertodo
=> ($userenv_branch eq $reserve->{'branchcode'} ?
0 : 1 ),
435 resbarcode
=> $barcode,
440 # same params for Waiting or Reserved
443 currentbranch
=> $branches->{$userenv_branch}->{'branchname'},
444 destbranchname
=> $branches->{ $reserve->{'branchcode'} }->{'branchname'},
445 name
=> $borr->{'surname'} . ", " . $borr->{'title'} . " " . $borr->{'firstname'},
446 borfirstname
=> $borr->{'firstname'},
447 borsurname
=> $borr->{'surname'},
448 bortitle
=> $borr->{'title'},
449 borphone
=> $borr->{'phone'},
450 boremail
=> $borr->{'email'},
451 boraddress
=> $borr->{'address'},
452 boraddress2
=> $borr->{'address2'},
453 borstnum
=> $borr->{streetnumber
},
454 borcity
=> $borr->{'city'},
455 borzip
=> $borr->{'zipcode'},
456 borcnum
=> $borr->{'cardnumber'},
457 debarred
=> $borr->{'debarred'},
458 gonenoaddress
=> $borr->{'gonenoaddress'},
460 destbranch
=> $reserve->{'branchcode'},
461 borrowernumber
=> $reserve->{'borrowernumber'},
462 itemnumber
=> $reserve->{'itemnumber'},
463 reservenotes
=> $reserve->{'reservenotes'},
465 } # else { ; } # error?
470 foreach my $code ( keys %$messages ) {
472 my $exit_required_p = 0;
473 if ( $code eq 'BadBarcode' ) {
474 $err{badbarcode
} = 1;
475 $err{msg
} = $messages->{'BadBarcode'};
477 elsif ( $code eq 'NotIssued' ) {
480 $err{msg
} = $branches->{ $messages->{'IsPermanent'} }->{'branchname'} if $messages->{'IsPermanent'};
482 elsif ( $code eq 'LocalUse' ) {
485 elsif ( $code eq 'WasLost' ) {
488 elsif ( $code eq 'LostItemFeeRefunded' ) {
489 $template->param( LostItemFeeRefunded
=> 1 );
491 elsif ( $code eq 'ResFound' ) {
492 ; # FIXME... anything to do here?
494 elsif ( $code eq 'WasReturned' ) {
495 ; # FIXME... anything to do here?
497 elsif ( $code eq 'WasTransfered' ) {
498 ; # FIXME... anything to do here?
500 elsif ( $code eq 'withdrawn' ) {
502 $exit_required_p = 1 if C4
::Context
->preference("BlockReturnOfWithdrawnItems");
504 elsif ( ( $code eq 'IsPermanent' ) && ( not $messages->{'ResFound'} ) ) {
505 if ( $messages->{'IsPermanent'} ne $userenv_branch ) {
506 $err{ispermanent
} = 1;
508 $branches->{ $messages->{'IsPermanent'} }->{'branchname'};
511 elsif ( $code eq 'WrongTransfer' ) {
512 ; # FIXME... anything to do here?
514 elsif ( $code eq 'WrongTransferItem' ) {
515 ; # FIXME... anything to do here?
517 elsif ( $code eq 'NeedsTransfer' ) {
519 elsif ( $code eq 'Wrongbranch' ) {
521 elsif ( $code eq 'Debarred' ) {
522 $err{debarred
} = $messages->{'Debarred'};
523 $err{debarcardnumber
} = $borrower->{cardnumber
};
524 $err{debarborrowernumber
} = $borrower->{borrowernumber
};
525 $err{debarname
} = "$borrower->{firstname} $borrower->{surname}";
527 elsif ( $code eq 'PrevDebarred' ) {
528 $err{prevdebarred
} = $messages->{'PrevDebarred'};
530 elsif ( $code eq 'ForeverDebarred' ) {
531 $err{foreverdebarred
} = $messages->{'ForeverDebarred'};
533 elsif ( $code eq 'NotForLoanStatusUpdated' ) {
534 $err{NotForLoanStatusUpdated
} = $messages->{NotForLoanStatusUpdated
};
537 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
538 # This forces the issue of staying in sync w/ Circulation.pm
541 push( @errmsgloop, \
%err );
543 last if $exit_required_p;
545 $template->param( errmsgloop
=> \
@errmsgloop );
547 #set up so only the last 8 returned items display (make for faster loading pages)
548 my $returned_counter = ( C4
::Context
->preference('numReturnedItemsToShow') ) ? C4
::Context
->preference('numReturnedItemsToShow') : 8;
551 my $shelflocations = GetKohaAuthorisedValues
('items.location','');
552 foreach ( sort { $a <=> $b } keys %returneditems ) {
554 if ( $count++ < $returned_counter ) {
555 my $bar_code = $returneditems{$_};
556 if ($riduedate{$_}) {
557 my $duedate = dt_from_string
( $riduedate{$_}, 'sql');
558 $ri{year
} = $duedate->year();
559 $ri{month
} = $duedate->month();
560 $ri{day
} = $duedate->day();
561 $ri{hour
} = $duedate->hour();
562 $ri{minute
} = $duedate->minute();
563 $ri{duedate
} = output_pref
($duedate);
564 my $b = C4
::Members
::GetMember
( borrowernumber
=> $riborrowernumber{$_} );
565 unless ( $dropboxmode ) {
566 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, DateTime
->now()) == -1);
568 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, $dropboxdate) == -1);
570 $ri{borrowernumber
} = $b->{'borrowernumber'};
571 $ri{borcnum
} = $b->{'cardnumber'};
572 $ri{borfirstname
} = $b->{'firstname'};
573 $ri{borsurname
} = $b->{'surname'};
574 $ri{bortitle
} = $b->{'title'};
575 $ri{bornote
} = $b->{'borrowernotes'};
576 $ri{borcategorycode
}= $b->{'categorycode'};
579 $ri{borrowernumber
} = $riborrowernumber{$_};
583 my $biblio = GetBiblioFromItemNumber
(GetItemnumberFromBarcode
($bar_code));
584 my $item = GetItem
( GetItemnumberFromBarcode
($bar_code) );
585 # fix up item type for display
586 $biblio->{'itemtype'} = C4
::Context
->preference('item-level_itypes') ?
$biblio->{'itype'} : $biblio->{'itemtype'};
587 $ri{itembiblionumber
} = $biblio->{'biblionumber'};
588 $ri{itemtitle
} = $biblio->{'title'};
589 $ri{itemauthor
} = $biblio->{'author'};
590 $ri{itemcallnumber
} = $biblio->{'itemcallnumber'};
591 $ri{itemtype
} = $biblio->{'itemtype'};
592 $ri{itemnote
} = $biblio->{'itemnotes'};
593 $ri{itemnotes_nonpublic
} = $item->{'itemnotes_nonpublic'};
594 $ri{ccode
} = $biblio->{'ccode'};
595 $ri{itemnumber
} = $biblio->{'itemnumber'};
596 $ri{barcode
} = $bar_code;
597 $ri{homebranch
} = $item->{'homebranch'};
598 $ri{holdingbranch
} = $item->{'holdingbranch'};
600 $ri{location
} = $biblio->{'location'};
601 my $shelfcode = $ri{'location'};
602 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
610 my ($genbrname, $genprname);
611 if (my $b = $branches->{$userenv_branch}) {
612 $genbrname = $b->{'branchname'};
614 if (my $p = $printers->{$printer}) {
615 $genprname = $p->{'printername'};
619 genbrname
=> $genbrname,
620 genprname
=> $genprname,
621 branchname
=> $genbrname,
623 errmsgloop
=> \
@errmsgloop,
624 exemptfine
=> $exemptfine,
625 dropboxmode
=> $dropboxmode,
626 dropboxdate
=> output_pref
($dropboxdate),
627 forgivemanualholdsexpire
=> $forgivemanualholdsexpire,
628 overduecharges
=> $overduecharges,
629 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
630 BlockReturnOfWithdrawnItems
=> C4
::Context
->preference("BlockReturnOfWithdrawnItems"),
633 $itemnumber = GetItemnumberFromBarcode
( $barcode );
635 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches
( $itemnumber );
636 $holdingBranch //= '';
637 $collectionBranch //= '';
638 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
640 collectionItemNeedsTransferred
=> 1,
641 collectionBranch
=> GetBranchName
($collectionBranch),
646 # actually print the page!
647 output_html_with_http_headers
$query, $cookie, $template->output;