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/;
42 use C4
::Koha
; # FIXME : is it still useful ?
43 use C4
::Members
::Messaging
;
48 use C4
::RotatingCollections
;
49 use Koha
::AuthorisedValues
;
50 use Koha
::BiblioFrameworks
;
61 my ( $template, $librarian, $cookie, $flags ) = get_template_and_user
(
63 template_name
=> "circ/returns.tt",
67 flagsrequired
=> { circulate
=> "circulate_remaining_permissions" },
71 my $sessionID = $query->cookie("CGISESSID");
72 my $session = get_session
($sessionID);
73 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
74 # no branch set we can't return
75 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
79 # Print a reserve slip on this page
80 if ( $query->param('print_slip') ) {
83 borrowernumber
=> scalar $query->param('borrowernumber'), # FIXME We should send a Koha::Patron and raise an error if not exist.
84 biblionumber
=> scalar $query->param('biblionumber'),
85 itemnumber
=> scalar $query->param('itemnumber'),
91 my $printers = GetPrinters
();
92 my $userenv = C4
::Context
->userenv;
93 my $userenv_branch = $userenv->{'branch'} // '';
94 my $printer = $userenv->{'branchprinter'} // '';
95 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
97 my $overduecharges = (C4
::Context
->preference('finesMode') && C4
::Context
->preference('finesMode') ne 'off');
99 # Some code to handle the error if there is no branch or printer setting.....
102 # Set up the item stack ....
105 my %riborrowernumber;
107 foreach ( $query->param ) {
120 my $barcode = $query->param("ri-$counter");
121 my $duedate = $query->param("dd-$counter");
122 my $borrowernumber = $query->param("bn-$counter");
125 # decode barcode ## Didn't we already decode them before passing them back last time??
126 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
127 $barcode = barcodedecode
($barcode) if(C4
::Context
->preference('itemBarcodeInputFilter'));
129 ######################
130 #Are these lines still useful ?
131 $returneditems{$counter} = $barcode;
132 $riduedate{$counter} = $duedate;
133 $riborrowernumber{$counter} = $borrowernumber;
135 #######################
136 $input{counter
} = $counter;
137 $input{barcode
} = $barcode;
138 $input{duedate
} = $duedate;
139 $input{borrowernumber
} = $borrowernumber;
140 push( @inputloop, \
%input );
144 # Deal with the requests....
146 if ($query->param('WT-itemNumber')){
147 updateWrongTransfer
($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
150 if ( $query->param('reserve_id') ) {
151 my $itemnumber = $query->param('itemnumber');
152 my $borrowernumber = $query->param('borrowernumber');
153 my $reserve_id = $query->param('reserve_id');
154 my $diffBranchReturned = $query->param('diffBranch');
155 my $cancel_reserve = $query->param('cancel_reserve');
156 # fix up item type for display
157 my $item = Koha
::Items
->find( $itemnumber );
158 my $biblio = $item->biblio;
160 if ( $cancel_reserve ) {
161 my $hold = Koha
::Holds
->find( $reserve_id );
163 $hold->cancel( { charge_cancel_fee
=> !$forgivemanualholdsexpire } );
166 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ?
$diffBranchReturned : undef;
167 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
168 # i.e., whether to apply waiting status
169 ModReserveAffect
( $itemnumber, $borrowernumber, $diffBranchSend, $reserve_id );
171 # check if we have other reserves for this document, if we have a return send the message of transfer
172 my ( $messages, $nextreservinfo ) = GetOtherReserves
($itemnumber);
174 my $patron = Koha
::Patrons
->find( $nextreservinfo );
175 my $name = $patron ?
$patron->surname . ", " . $patron->title . " " . $patron->firstname : '';
176 if ( $messages->{'transfert'} ) {
178 itemtitle
=> $biblio->title,
179 itemnumber
=> $item->itemnumber,
180 itembiblionumber
=> $biblio->biblionumber,
181 iteminfo
=> $biblio->author,
194 my $barcode = $query->param('barcode');
195 my $exemptfine = $query->param('exemptfine');
198 !C4
::Auth
::haspermission
(C4
::Context
->userenv->{'id'}, {'updatecharges' => 'writeoff'})
200 # silently prevent unauthorized operator from forgiving overdue
201 # fines by manually tweaking form parameters
204 my $dropboxmode = $query->param('dropboxmode');
205 my $dotransfer = $query->param('dotransfer');
206 my $canceltransfer = $query->param('canceltransfer');
207 my $dest = $query->param('dest');
208 #dropbox: get last open day (today - 1)
209 my $dropboxdate = Koha
::Checkouts
::calculate_dropbox_date
();
211 my $return_date_override = $query->param('return_date_override');
212 my $return_date_override_dt;
213 my $return_date_override_remember =
214 $query->param('return_date_override_remember');
215 if ($return_date_override) {
216 if ( C4
::Context
->preference('SpecifyReturnDate') ) {
217 $return_date_override_dt = eval {dt_from_string
( $return_date_override ) };
218 if ( $return_date_override_dt ) {
219 # note that we've overriden the return date
220 $template->param( return_date_was_overriden
=> 1);
221 # Save the original format if we are remembering for this series
223 return_date_override
=> $return_date_override,
224 return_date_override_remember
=> 1
225 ) if ($return_date_override_remember);
227 $return_date_override =
228 DateTime
::Format
::MySQL
->format_datetime( $return_date_override_dt );
232 $return_date_override = q{};
237 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
238 my $transferitem = $query->param('transferitem');
239 my $tobranch = $query->param('tobranch');
240 ModItemTransfer
($transferitem, $userenv_branch, $tobranch);
243 if ($canceltransfer){
244 $itemnumber=$query->param('itemnumber');
245 DeleteTransfer
($itemnumber);
247 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
250 $template->param( transfercancelled
=> 1);
254 # actually return book and prepare item table.....
257 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
258 $barcode = barcodedecode
($barcode) if C4
::Context
->preference('itemBarcodeInputFilter');
259 my $item = Koha
::Items
->find({ barcode
=> $barcode });
262 $itemnumber = $item->itemnumber;
263 # Check if we should display a checkin message, based on the the item
264 # type of the checked in item
265 my $itemtype = Koha
::ItemTypes
->find( $item->effective_itemtype );
266 if ( $itemtype && $itemtype->checkinmsg ) {
268 checkinmsg
=> $itemtype->checkinmsg,
269 checkinmsgtype
=> $itemtype->checkinmsgtype,
273 # make sure return branch respects home branch circulation rules, default to homebranch
274 my $hbr = GetBranchItemRule
($item->homebranch, $itemtype ?
$itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
275 $returnbranch = $hbr ne 'noreturn' ?
$item->$hbr : $userenv_branch; # can be noreturn, homebranch or holdingbranch
277 my $materials = $item->materials;
278 my $descriptions = Koha
::AuthorisedValues
->get_description_by_koha_field({frameworkcode
=> '', kohafield
=>'items.materials', authorised_value
=> $materials });
279 $materials = $descriptions->{lib
} // $materials;
281 my $checkout = $item->checkout;
282 my $biblio = $item->biblio;
284 title
=> $biblio->title,
285 homebranch
=> $item->homebranch,
286 holdingbranch
=> $item->holdingbranch,
287 returnbranch
=> $returnbranch,
288 author
=> $biblio->author,
289 itembarcode
=> $item->barcode,
290 itemtype
=> $item->effective_itemtype,
291 ccode
=> $item->ccode,
292 itembiblionumber
=> $biblio->biblionumber,
293 biblionumber
=> $biblio->biblionumber,
294 additional_materials
=> $materials,
297 } # FIXME else we should not call AddReturn but set BadBarcode directly instead
305 my $return_date = $dropboxmode ?
$dropboxdate : $return_date_override_dt;
308 ( $returned, $messages, $issue, $borrower ) =
309 AddReturn
( $barcode, $userenv_branch, $exemptfine, $return_date );
312 my $time_now = DateTime
->now( time_zone
=> C4
::Context
->tz )->truncate( to
=> 'minute');
313 my $date_due_dt = dt_from_string
( $issue->date_due, 'sql' );
314 my $duedate = $date_due_dt->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($date_due_dt, DateTime
->now()) == -1);
323 $input{return_overdue
} = 1 if (DateTime
->compare($date_due_dt, $dropboxdate) == -1);
325 push( @inputloop, \
%input );
327 if ( C4
::Context
->preference("FineNotifyAtCheckin") ) {
328 my $patron = Koha
::Patrons
->find( $borrower->{borrowernumber
} );
329 my $balance = $patron->account->balance;
332 $template->param( fines
=> sprintf("%.2f", $balance) );
333 $template->param( fineborrowernumber
=> $borrower->{'borrowernumber'} );
337 if (C4
::Context
->preference("WaitingNotifyAtCheckin") ) {
338 #Check for waiting holds
339 my $patron = Koha
::Patrons
->find( $borrower->{borrowernumber
} );
340 my $waiting_holds = $patron->holds->search({ found
=> 'W', branchcode
=> $userenv_branch })->count;
341 if ($waiting_holds > 0) {
343 waiting_holds
=> $waiting_holds,
344 holdsborrowernumber
=> $borrower->{'borrowernumber'},
345 holdsfirstname
=> $borrower->{'firstname'},
346 holdssurname
=> $borrower->{'surname'},
350 } elsif ( C4
::Context
->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} ) {
352 $returneditems{0} = $barcode;
354 push( @inputloop, \
%input );
356 $template->param( privacy
=> $borrower->{privacy
} );
358 $template->param( inputloop
=> \
@inputloop );
364 # new op dev : we check if the document must be returned to his homebranch directly,
365 # if the document is transferred, we have warning message .
367 if ( $messages->{'WasTransfered'} ) {
371 itemnumber
=> $itemnumber,
375 if ( $messages->{'NeedsTransfer'} ){
378 needstransfer
=> $messages->{'NeedsTransfer'},
379 itemnumber
=> $itemnumber,
383 if ( $messages->{'Wrongbranch'} ){
386 rightbranch
=> $messages->{'Wrongbranch'}->{'Rightbranch'},
390 # case of wrong transfert, if the document wasn't transferred to the right library (according to branchtransfer (tobranch) BDD)
392 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
395 TransferWaitingAt
=> $messages->{'WrongTransfer'},
396 WrongTransferItem
=> $messages->{'WrongTransferItem'},
397 itemnumber
=> $itemnumber,
400 my $reserve = $messages->{'ResFound'};
402 my $patron = Koha
::Patrons
->find( $reserve->{'borrowernumber'} );
403 my $name = $patron->surname . ", " . $patron->title . " " . $patron->firstname;
409 wtransfertFrom
=> $userenv_branch,
414 # reserve found and item arrived at the expected branch
416 if ( $messages->{'ResFound'}) {
417 my $reserve = $messages->{'ResFound'};
418 my $patron = Koha
::Patrons
->find( $reserve->{borrowernumber
} );
419 my $holdmsgpreferences = C4
::Members
::Messaging
::GetMessagingPreferences
( { borrowernumber
=> $reserve->{'borrowernumber'}, message_name
=> 'Hold_Filled' } );
420 my $branchCheck = ( $userenv_branch eq $reserve->{branchcode
} );
421 if ( $reserve->{'ResFound'} eq "Reserved" && C4
::Context
->preference('HoldsAutoFill') ) {
422 my $item = Koha
::Items
->find( $itemnumber );
423 my $biblio = $item->biblio;
425 my $diffBranchSend = !$branchCheck ?
$reserve->{branchcode
} : undef;
426 ModReserveAffect
( $reserve->{itemnumber
}, $reserve->{borrowernumber
}, $diffBranchSend, $reserve->{reserve_id
} );
427 my ( $messages, $nextreservinfo ) = GetOtherReserves
($reserve->{itemnumber
});
429 my $patron = Koha
::Patrons
->find( $nextreservinfo );
432 hold_auto_filled
=> 1,
433 print_slip
=> C4
::Context
->preference('HoldsAutoFillPrintSlip'),
435 borrowernumber
=> $patron->id,
436 biblionumber
=> $biblio->id,
439 if ( $messages->{'transfert'} ) {
441 itemtitle
=> $biblio->title,
442 itemnumber
=> $item->itemnumber,
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
},
463 } # else { ; } # error?
465 # same params for Waiting or Reserved
470 destbranch
=> $reserve->{'branchcode'},
471 itemnumber
=> $reserve->{'itemnumber'},
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 'Wrongbranch' ) {
524 elsif ( $code eq 'Debarred' ) {
525 $err{debarred
} = $messages->{'Debarred'};
526 $err{debarcardnumber
} = $borrower->{cardnumber
};
527 $err{debarborrowernumber
} = $borrower->{borrowernumber
};
528 $err{debarname
} = "$borrower->{firstname} $borrower->{surname}";
530 elsif ( $code eq 'PrevDebarred' ) {
531 $err{prevdebarred
} = $messages->{'PrevDebarred'};
533 elsif ( $code eq 'ForeverDebarred' ) {
534 $err{foreverdebarred
} = $messages->{'ForeverDebarred'};
536 elsif ( $code eq 'ItemLocationUpdated' ) {
537 $err{ItemLocationUpdated
} = $messages->{ItemLocationUpdated
};
539 elsif ( $code eq 'NotForLoanStatusUpdated' ) {
540 $err{NotForLoanStatusUpdated
} = $messages->{NotForLoanStatusUpdated
};
542 elsif ( $code eq 'DataCorrupted' ) {
543 $err{data_corrupted
} = 1;
546 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
547 # This forces the issue of staying in sync w/ Circulation.pm
550 push( @errmsgloop, \
%err );
552 last if $exit_required_p;
554 $template->param( errmsgloop
=> \
@errmsgloop );
556 #set up so only the last 8 returned items display (make for faster loading pages)
557 my $returned_counter = ( C4
::Context
->preference('numReturnedItemsToShow') ) ? C4
::Context
->preference('numReturnedItemsToShow') : 8;
561 { map { $_->{authorised_value
} => $_->{lib
} } Koha
::AuthorisedValues
->get_descriptions_by_koha_field( { frameworkcode
=> '', kohafield
=> 'items.location' } ) };
562 foreach ( sort { $a <=> $b } keys %returneditems ) {
564 if ( $count++ < $returned_counter ) {
565 my $bar_code = $returneditems{$_};
566 if ($riduedate{$_}) {
567 my $duedate = dt_from_string
( $riduedate{$_}, 'sql');
568 $ri{year
} = $duedate->year();
569 $ri{month
} = $duedate->month();
570 $ri{day
} = $duedate->day();
571 $ri{hour
} = $duedate->hour();
572 $ri{minute
} = $duedate->minute();
573 $ri{duedate
} = output_pref
($duedate);
574 my $patron = Koha
::Patrons
->find( $riborrowernumber{$_} );
575 unless ( $dropboxmode ) {
576 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, DateTime
->now()) == -1);
578 $ri{return_overdue
} = 1 if (DateTime
->compare($duedate, $dropboxdate) == -1);
580 $ri{patron
} = $patron,
581 $ri{borissuescount
} = $patron->checkouts->count;
584 $ri{borrowernumber
} = $riborrowernumber{$_};
587 my $item = Koha
::Items
->find({ barcode
=> $bar_code });
588 next unless $item; # FIXME The item has been deleted in the meantime,
589 # we could handle that better displaying a message in the template
590 my $biblio = $item->biblio;
591 # FIXME pass $item to the template and we are done here...
592 $ri{itembiblionumber
} = $biblio->biblionumber;
593 $ri{itemtitle
} = $biblio->title;
594 $ri{itemauthor
} = $biblio->author;
595 $ri{itemcallnumber
} = $item->itemcallnumber;
596 $ri{dateaccessioned
} = $item->dateaccessioned;
597 $ri{itemtype
} = $item->effective_itemtype;
598 $ri{itemnote
} = $item->itemnotes;
599 $ri{itemnotes_nonpublic
} = $item->itemnotes_nonpublic;
600 $ri{ccode
} = $item->ccode;
601 $ri{enumchron
} = $item->enumchron;
602 $ri{itemnumber
} = $item->itemnumber;
603 $ri{barcode
} = $bar_code;
604 $ri{homebranch
} = $item->homebranch;
605 $ri{holdingbranch
} = $item->holdingbranch;
607 $ri{location
} = $item->location;
608 my $shelfcode = $ri{'location'};
609 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
621 errmsgloop
=> \
@errmsgloop,
622 exemptfine
=> $exemptfine,
623 dropboxmode
=> $dropboxmode,
624 dropboxdate
=> $dropboxdate,
625 forgivemanualholdsexpire
=> $forgivemanualholdsexpire,
626 overduecharges
=> $overduecharges,
627 AudioAlerts
=> C4
::Context
->preference("AudioAlerts"),
630 my $item_from_barcode = Koha
::Items
->find({barcode
=> $barcode }); # How many times do we fetch this item?!?
631 if ( $item_from_barcode ) {
632 $itemnumber = $item_from_barcode->itemnumber;
633 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches
( $itemnumber );
634 if ( $holdingBranch and $collectionBranch ) {
635 $holdingBranch //= '';
636 $collectionBranch //= $returnbranch;
637 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
639 collectionItemNeedsTransferred
=> 1,
640 collectionBranch
=> $collectionBranch,
641 itemnumber
=> $itemnumber,
647 # Checking if there is a Fast Cataloging Framework
648 $template->param( fast_cataloging
=> 1 ) if Koha
::BiblioFrameworks
->find( 'FA' );
650 # actually print the page!
651 output_html_with_http_headers
$query, $cookie, $template->output;