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
32 # FIXME There are weird things going on with $patron and $borrowernumber in this script
37 use C4
::Auth qw
/:DEFAULT get_session/;
45 use C4
::Koha
; # FIXME : is it still useful ?
46 use C4
::Members
::Messaging
;
50 use C4
::RotatingCollections
;
51 use Koha
::AuthorisedValues
;
52 use Koha
::BiblioFrameworks
;
63 my ( $template, $librarian, $cookie, $flags ) = get_template_and_user
(
65 template_name
=> "circ/returns.tt",
68 flagsrequired
=> { circulate
=> "circulate_remaining_permissions" },
72 my $sessionID = $query->cookie("CGISESSID");
73 my $session = get_session
($sessionID);
75 # Print a reserve slip on this page
76 if ( $query->param('print_slip') ) {
79 reserve_id
=> scalar $query->param('reserve_id'),
85 my $userenv = C4
::Context
->userenv;
86 my $userenv_branch = $userenv->{'branch'} // '';
87 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
89 my $overduecharges = (C4
::Context
->preference('finesMode') && C4
::Context
->preference('finesMode') ne 'off');
91 # Set up the item stack ....
96 foreach ( $query->param ) {
109 my $barcode = $query->param("ri-$counter");
110 my $duedate = $query->param("dd-$counter");
111 my $borrowernumber = $query->param("bn-$counter");
114 # decode barcode ## Didn't we already decode them before passing them back last time??
115 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
116 $barcode = barcodedecode
($barcode) if(C4
::Context
->preference('itemBarcodeInputFilter'));
118 ######################
119 #Are these lines still useful ?
120 $returneditems{$counter} = $barcode;
121 $riduedate{$counter} = $duedate;
122 $riborrowernumber{$counter} = $borrowernumber;
124 #######################
125 $input{counter
} = $counter;
126 $input{barcode
} = $barcode;
127 $input{duedate
} = $duedate;
128 $input{borrowernumber
} = $borrowernumber;
129 push( @inputloop, \
%input );
133 # Deal with the requests....
135 if ($query->param('WT-itemNumber')){
136 updateWrongTransfer
($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
139 if ( $query->param('reserve_id') ) {
140 my $itemnumber = $query->param('itemnumber');
141 my $borrowernumber = $query->param('borrowernumber');
142 my $reserve_id = $query->param('reserve_id');
143 my $diffBranchReturned = $query->param('diffBranch');
144 my $cancel_reserve = $query->param('cancel_reserve');
145 # fix up item type for display
146 my $item = Koha
::Items
->find( $itemnumber );
147 my $biblio = $item->biblio;
149 if ( $cancel_reserve ) {
150 my $hold = Koha
::Holds
->find( $reserve_id );
152 $hold->cancel( { charge_cancel_fee
=> !$forgivemanualholdsexpire } );
155 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ?
$diffBranchReturned : undef;
156 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
157 # i.e., whether to apply waiting status
158 ModReserveAffect
( $itemnumber, $borrowernumber, $diffBranchSend, $reserve_id );
160 # check if we have other reserves for this document, if we have a return send the message of transfer
161 my ( $messages, $nextreservinfo ) = GetOtherReserves
($itemnumber);
163 my $patron = Koha
::Patrons
->find( $nextreservinfo );
164 my $name = $patron ?
$patron->surname . ", " . $patron->title . " " . $patron->firstname : '';
165 if ( $messages->{'transfert'} ) {
167 itemtitle
=> $biblio->title,
168 itemnumber
=> $item->itemnumber,
169 itembiblionumber
=> $biblio->biblionumber,
170 iteminfo
=> $biblio->author,
183 my $barcode = $query->param('barcode');
184 my $exemptfine = $query->param('exemptfine');
187 !C4
::Auth
::haspermission
(C4
::Context
->userenv->{'id'}, {'updatecharges' => 'writeoff'})
189 # silently prevent unauthorized operator from forgiving overdue
190 # fines by manually tweaking form parameters
193 my $dropboxmode = $query->param('dropboxmode');
194 my $dotransfer = $query->param('dotransfer');
195 my $canceltransfer = $query->param('canceltransfer');
196 my $dest = $query->param('dest');
197 #dropbox: get last open day (today - 1)
198 my $dropboxdate = Koha
::Checkouts
::calculate_dropbox_date
();
200 my $return_date_override = $query->param('return_date_override');
201 my $return_date_override_dt;
202 my $return_date_override_remember =
203 $query->param('return_date_override_remember');
204 if ($return_date_override) {
205 if ( C4
::Context
->preference('SpecifyReturnDate') ) {
206 $return_date_override_dt = eval {dt_from_string
( $return_date_override ) };
207 if ( $return_date_override_dt ) {
208 # note that we've overriden the return date
209 $template->param( return_date_was_overriden
=> 1);
210 # Save the original format if we are remembering for this series
212 return_date_override
=> $return_date_override,
213 return_date_override_remember
=> 1
214 ) if ($return_date_override_remember);
216 $return_date_override =
217 DateTime
::Format
::MySQL
->format_datetime( $return_date_override_dt );
221 $return_date_override = q{};
226 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
227 my $transferitem = $query->param('transferitem');
228 my $tobranch = $query->param('tobranch');
229 my $trigger = $query->param('trigger');
230 ModItemTransfer
($transferitem, $userenv_branch, $tobranch, $trigger);
233 if ($canceltransfer){
234 $itemnumber=$query->param('itemnumber');
235 DeleteTransfer
($itemnumber);
237 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
240 $template->param( transfercancelled
=> 1);
244 # actually return book and prepare item table.....
247 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
248 $barcode = barcodedecode
($barcode) if C4
::Context
->preference('itemBarcodeInputFilter');
249 my $item = Koha
::Items
->find({ barcode
=> $barcode });
252 $itemnumber = $item->itemnumber;
253 # Check if we should display a checkin message, based on the the item
254 # type of the checked in item
255 my $itemtype = Koha
::ItemTypes
->find( $item->effective_itemtype );
256 if ( $itemtype && $itemtype->checkinmsg ) {
258 checkinmsg
=> $itemtype->checkinmsg,
259 checkinmsgtype
=> $itemtype->checkinmsgtype,
263 # make sure return branch respects home branch circulation rules, default to homebranch
264 my $hbr = GetBranchItemRule
($item->homebranch, $itemtype ?
$itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
265 $returnbranch = $hbr ne 'noreturn' ?
$item->$hbr : $userenv_branch; # can be noreturn, homebranch or holdingbranch
267 my $materials = $item->materials;
268 my $descriptions = Koha
::AuthorisedValues
->get_description_by_koha_field({frameworkcode
=> '', kohafield
=>'items.materials', authorised_value
=> $materials });
269 $materials = $descriptions->{lib
} // $materials;
271 my $checkout = $item->checkout;
272 my $biblio = $item->biblio;
274 title
=> $biblio->title,
275 homebranch
=> $item->homebranch,
276 holdingbranch
=> $item->holdingbranch,
277 returnbranch
=> $returnbranch,
278 author
=> $biblio->author,
279 itembarcode
=> $item->barcode,
280 itemtype
=> $item->effective_itemtype,
281 ccode
=> $item->ccode,
282 itembiblionumber
=> $biblio->biblionumber,
283 biblionumber
=> $biblio->biblionumber,
284 additional_materials
=> $materials,
287 } # FIXME else we should not call AddReturn but set BadBarcode directly instead
295 my $return_date = $dropboxmode ?
$dropboxdate : $return_date_override_dt;
297 # Block return if multi-part and confirm has not been received
299 C4
::Context
->preference("CircConfirmItemParts")
301 && !$query->param('multiple_confirm');
302 $template->param('multiple_confirmed' => 1) if $query->param('multiple_confirm');
305 ( $returned, $messages, $issue, $borrower ) =
306 AddReturn
( $barcode, $userenv_branch, $exemptfine, $return_date )
307 unless $needs_confirm;
310 my $time_now = dt_from_string
()->truncate( to
=> 'minute');
311 my $date_due_dt = dt_from_string
( $issue->date_due, 'sql' );
312 my $duedate = $date_due_dt->strftime('%Y-%m-%d %H:%M');
313 $returneditems{0} = $barcode;
314 $riborrowernumber{0} = $borrower->{'borrowernumber'};
315 $riduedate{0} = $duedate;
316 $input{borrowernumber
} = $borrower->{'borrowernumber'};
317 $input{duedate
} = $duedate;
318 unless ( $dropboxmode ) {
319 $input{return_overdue
} = 1 if (DateTime
->compare($date_due_dt, dt_from_string
()) == -1);
321 $input{return_overdue
} = 1 if (DateTime
->compare($date_due_dt, $dropboxdate) == -1);
323 push( @inputloop, \
%input );
325 if ( C4
::Context
->preference("FineNotifyAtCheckin") ) {
326 my $patron = Koha
::Patrons
->find( $borrower->{borrowernumber
} );
327 my $balance = $patron->account->balance;
330 $template->param( fines
=> sprintf("%.2f", $balance) );
331 $template->param( fineborrowernumber
=> $borrower->{'borrowernumber'} );
335 if (C4
::Context
->preference("WaitingNotifyAtCheckin") ) {
336 #Check for waiting holds
337 my $patron = Koha
::Patrons
->find( $borrower->{borrowernumber
} );
338 my $waiting_holds = $patron->holds->search({ found
=> 'W', branchcode
=> $userenv_branch })->count;
339 if ($waiting_holds > 0) {
341 waiting_holds
=> $waiting_holds,
342 holdsborrowernumber
=> $borrower->{'borrowernumber'},
343 holdsfirstname
=> $borrower->{'firstname'},
344 holdssurname
=> $borrower->{'surname'},
348 } elsif ( C4
::Context
->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} and !$needs_confirm ) {
350 $returneditems{0} = $barcode;
352 push( @inputloop, \
%input );
354 $template->param( privacy
=> $borrower->{privacy
} );
356 if ( $needs_confirm ) {
357 $template->param( needs_confirm
=> $needs_confirm );
360 $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 transferred, we have warning message .
370 if ( $messages->{'WasTransfered'} ) {
374 itemnumber
=> $itemnumber,
378 if ( $messages->{'NeedsTransfer'} ){
381 needstransfer
=> $messages->{'NeedsTransfer'},
382 trigger
=> $messages->{'TransferTrigger'},
383 itemnumber
=> $itemnumber,
387 if ( $messages->{'Wrongbranch'} ){
390 rightbranch
=> $messages->{'Wrongbranch'}->{'Rightbranch'},
394 # case of wrong transfert, if the document wasn't transferred to the right library (according to branchtransfer (tobranch) BDD)
396 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
399 TransferWaitingAt
=> $messages->{'WrongTransfer'},
400 WrongTransferItem
=> $messages->{'WrongTransferItem'},
401 itemnumber
=> $itemnumber,
404 my $reserve = $messages->{'ResFound'};
406 my $patron = Koha
::Patrons
->find( $reserve->{'borrowernumber'} );
407 my $name = $patron->surname . ", " . $patron->title . " " . $patron->firstname;
413 wtransfertFrom
=> $userenv_branch,
418 # reserve found and item arrived at the expected branch
420 if ( $messages->{'ResFound'}) {
421 my $reserve = $messages->{'ResFound'};
422 my $patron = Koha
::Patrons
->find( $reserve->{borrowernumber
} );
423 my $holdmsgpreferences = C4
::Members
::Messaging
::GetMessagingPreferences
( { borrowernumber
=> $reserve->{'borrowernumber'}, message_name
=> 'Hold_Filled' } );
424 my $branchCheck = ( $userenv_branch eq $reserve->{branchcode
} );
425 if ( $reserve->{'ResFound'} eq "Reserved" && C4
::Context
->preference('HoldsAutoFill') ) {
426 my $item = Koha
::Items
->find( $itemnumber );
427 my $biblio = $item->biblio;
429 my $diffBranchSend = !$branchCheck ?
$reserve->{branchcode
} : undef;
430 ModReserveAffect
( $reserve->{itemnumber
}, $reserve->{borrowernumber
}, $diffBranchSend, $reserve->{reserve_id
} );
431 my ( $messages, $nextreservinfo ) = GetOtherReserves
($reserve->{itemnumber
});
434 hold_auto_filled
=> 1,
435 print_slip
=> C4
::Context
->preference('HoldsAutoFillPrintSlip'),
436 reserve_id
=> $nextreservinfo->{reserve_id
},
437 itemnumber
=> $itemnumber,
440 if ( $messages->{'transfert'} ) {
442 itemtitle
=> $biblio->title,
443 itembiblionumber
=> $biblio->biblionumber,
444 iteminfo
=> $biblio->author,
449 elsif ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
450 if ( $reserve->{'ResFound'} eq "Waiting" ) {
452 waiting
=> $branchCheck ?
1 : undef,
454 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
456 intransit
=> $branchCheck ?
undef : 1,
457 transfertodo
=> $branchCheck ?
undef : 1,
458 reserve_id
=> $reserve->{reserve_id
},
460 itemnumber
=> $itemnumber,
464 } # else { ; } # error?
466 # same params for Waiting or Reserved
471 destbranch
=> $reserve->{'branchcode'},
472 reservenotes
=> $reserve->{'reservenotes'},
473 reserve_id
=> $reserve->{reserve_id
},
474 bormessagepref
=> $holdmsgpreferences->{'transports'},
480 foreach my $code ( keys %$messages ) {
482 my $exit_required_p = 0;
483 if ( $code eq 'BadBarcode' ) {
484 $err{badbarcode
} = 1;
485 $err{msg
} = $messages->{'BadBarcode'};
487 elsif ( $code eq 'NotIssued' ) {
491 elsif ( $code eq 'LocalUse' ) {
494 elsif ( $code eq 'WasLost' ) {
496 $exit_required_p = 1 if C4
::Context
->preference("BlockReturnOfLostItems");
498 elsif ( $code eq 'LostItemFeeRefunded' ) {
499 $template->param( LostItemFeeRefunded
=> 1 );
501 elsif ( $code eq 'ResFound' ) {
502 ; # FIXME... anything to do here?
504 elsif ( $code eq 'WasReturned' ) {
505 ; # FIXME... anything to do here?
507 elsif ( $code eq 'WasTransfered' ) {
508 ; # FIXME... anything to do here?
510 elsif ( $code eq 'withdrawn' ) {
512 $exit_required_p = 1 if C4
::Context
->preference("BlockReturnOfWithdrawnItems");
514 elsif ( $code eq 'WrongTransfer' ) {
515 ; # FIXME... anything to do here?
517 elsif ( $code eq 'WrongTransferItem' ) {
518 ; # FIXME... anything to do here?
520 elsif ( $code eq 'NeedsTransfer' ) {
522 elsif ( $code eq 'TransferTrigger' ) {
523 ; # Handled alongside NeedsTransfer
525 elsif ( $code eq 'Wrongbranch' ) {
527 elsif ( $code eq 'Debarred' ) {
528 $err{debarred
} = $messages->{'Debarred'};
529 $err{debarcardnumber
} = $borrower->{cardnumber
};
530 $err{debarborrowernumber
} = $borrower->{borrowernumber
};
531 $err{debarname
} = "$borrower->{firstname} $borrower->{surname}";
533 elsif ( $code eq 'PrevDebarred' ) {
534 $err{prevdebarred
} = $messages->{'PrevDebarred'};
536 elsif ( $code eq 'ForeverDebarred' ) {
537 $err{foreverdebarred
} = $messages->{'ForeverDebarred'};
539 elsif ( $code eq 'ItemLocationUpdated' ) {
540 $err{ItemLocationUpdated
} = $messages->{ItemLocationUpdated
};
542 elsif ( $code eq 'NotForLoanStatusUpdated' ) {
543 $err{NotForLoanStatusUpdated
} = $messages->{NotForLoanStatusUpdated
};
545 elsif ( $code eq 'DataCorrupted' ) {
546 $err{data_corrupted
} = 1;
548 elsif ( $code eq 'ReturnClaims' ) {
549 $template->param( ReturnClaims
=> $messages->{ReturnClaims
} );
551 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
552 # This forces the issue of staying in sync w/ Circulation.pm
555 push( @errmsgloop, \
%err );
557 last if $exit_required_p;
559 $template->param( errmsgloop
=> \
@errmsgloop );
561 #set up so only the last 8 returned items display (make for faster loading pages)
562 my $returned_counter = ( C4
::Context
->preference('numReturnedItemsToShow') ) ? C4
::Context
->preference('numReturnedItemsToShow') : 8;
566 { map { $_->{authorised_value
} => $_->{lib
} } Koha
::AuthorisedValues
->get_descriptions_by_koha_field( { frameworkcode
=> '', kohafield
=> 'items.location' } ) };
567 foreach ( sort { $a <=> $b } keys %returneditems ) {
569 if ( $count++ < $returned_counter ) {
570 my $bar_code = $returneditems{$_};
571 if ($riduedate{$_}) {
572 my $duedate = dt_from_string
( $riduedate{$_}, 'sql');
573 $ri{year
} = $duedate->year();
574 $ri{month
} = $duedate->month();
575 $ri{day
} = $duedate->day();
576 $ri{hour
} = $duedate->hour();
577 $ri{minute
} = $duedate->minute();
578 $ri{duedate
} = output_pref
($duedate);
579 my $patron = Koha
::Patrons
->find( $riborrowernumber{$_} );
580 unless ( $dropboxmode ) {
581 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, dt_from_string
()) == -1);
583 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, $dropboxdate) == -1);
585 $ri{patron
} = $patron,
586 $ri{borissuescount
} = $patron->checkouts->count;
589 $ri{borrowernumber
} = $riborrowernumber{$_};
592 my $item = Koha
::Items
->find({ barcode
=> $bar_code });
593 next unless $item; # FIXME The item has been deleted in the meantime,
594 # we could handle that better displaying a message in the template
596 my $biblio = $item->biblio;
597 # FIXME pass $item to the template and we are done here...
598 $ri{itembiblionumber
} = $biblio->biblionumber;
599 $ri{itemtitle
} = $biblio->title;
600 $ri{subtitle
} = $biblio->subtitle;
601 $ri{part_name
} = $biblio->part_name;
602 $ri{part_number
} = $biblio->part_number;
603 $ri{itemauthor
} = $biblio->author;
604 $ri{itemcallnumber
} = $item->itemcallnumber;
605 $ri{dateaccessioned
} = $item->dateaccessioned;
606 $ri{recordtype
} = $biblio->itemtype;
607 $ri{itemtype
} = $item->itype;
608 $ri{itemnote
} = $item->itemnotes;
609 $ri{itemnotes_nonpublic
} = $item->itemnotes_nonpublic;
610 $ri{ccode
} = $item->ccode;
611 $ri{enumchron
} = $item->enumchron;
612 $ri{itemnumber
} = $item->itemnumber;
613 $ri{barcode
} = $bar_code;
614 $ri{homebranch
} = $item->homebranch;
615 $ri{holdingbranch
} = $item->holdingbranch;
617 $ri{location
} = $item->location;
618 my $shelfcode = $ri{'location'};
619 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
630 errmsgloop
=> \
@errmsgloop,
631 exemptfine
=> $exemptfine,
632 dropboxmode
=> $dropboxmode,
633 dropboxdate
=> $dropboxdate,
634 forgivemanualholdsexpire
=> $forgivemanualholdsexpire,
635 overduecharges
=> $overduecharges,
636 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
640 my $item_from_barcode = Koha
::Items
->find({barcode
=> $barcode }); # How many times do we fetch this item?!?
641 if ( $item_from_barcode ) {
642 $itemnumber = $item_from_barcode->itemnumber;
643 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches
( $itemnumber );
644 if ( $holdingBranch and $collectionBranch ) {
645 $holdingBranch //= '';
646 $collectionBranch //= $returnbranch;
647 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
649 collectionItemNeedsTransferred
=> 1,
650 collectionBranch
=> $collectionBranch,
651 itemnumber
=> $itemnumber,
658 # Checking if there is a Fast Cataloging Framework
659 $template->param( fast_cataloging
=> 1 ) if Koha
::BiblioFrameworks
->find( 'FA' );
661 # actually print the page!
662 output_html_with_http_headers
$query, $cookie, $template->output;