Bug 20996: Fix unit tests
[koha.git] / circ / returns.pl
blobc2f20efd919fccb0e0462799ec5edc90c7d80bb0
1 #!/usr/bin/perl
3 # Copyright 2000-2002 Katipo Communications
4 # 2006 SAN-OP
5 # 2007-2010 BibLibre, Paul POULAIN
6 # 2010 Catalyst IT
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>.
24 =head1 returns.pl
26 script to execute returns of books
28 =cut
30 use Modern::Perl;
32 # FIXME There are weird things going on with $patron and $borrowernumber in this script
34 use CGI qw ( -utf8 );
35 use DateTime;
36 use C4::Context;
37 use C4::Auth qw/:DEFAULT get_session/;
38 use C4::Output;
39 use C4::Circulation;
40 use C4::Print;
41 use C4::Reserves;
42 use C4::Biblio;
43 use C4::Items;
44 use C4::Members;
45 use C4::Members::Messaging;
46 use C4::Koha; # FIXME : is it still useful ?
47 use C4::RotatingCollections;
48 use Koha::AuthorisedValues;
49 use Koha::DateUtils;
50 use Koha::Calendar;
51 use Koha::BiblioFrameworks;
52 use Koha::Holds;
53 use Koha::Items;
54 use Koha::Patrons;
56 my $query = new CGI;
58 #getting the template
59 my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
61 template_name => "circ/returns.tt",
62 query => $query,
63 type => "intranet",
64 authnotrequired => 0,
65 flagsrequired => { circulate => "circulate_remaining_permissions" },
69 my $sessionID = $query->cookie("CGISESSID");
70 my $session = get_session($sessionID);
71 if ($session->param('branch') eq 'NO_LIBRARY_SET'){
72 # no branch set we can't return
73 print $query->redirect("/cgi-bin/koha/circ/selectbranchprinter.pl");
74 exit;
77 # Print a reserve slip on this page
78 if ( $query->param('print_slip') ) {
79 $template->param(
80 print_slip => 1,
81 borrowernumber => scalar $query->param('borrowernumber'), # FIXME We should send a Koha::Patron and raise an error if not exist.
82 biblionumber => scalar $query->param('biblionumber'),
83 itemnumber => scalar $query->param('itemnumber'),
87 #####################
88 #Global vars
89 my $printers = GetPrinters();
90 my $userenv = C4::Context->userenv;
91 my $userenv_branch = $userenv->{'branch'} // '';
92 my $printer = $userenv->{'branchprinter'} // '';
93 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
95 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
97 # Some code to handle the error if there is no branch or printer setting.....
100 # Set up the item stack ....
101 my %returneditems;
102 my %riduedate;
103 my %riborrowernumber;
104 my @inputloop;
105 foreach ( $query->param ) {
106 my $counter;
107 if (/ri-(\d*)/) {
108 $counter = $1;
109 if ($counter > 20) {
110 next;
113 else {
114 next;
117 my %input;
118 my $barcode = $query->param("ri-$counter");
119 my $duedate = $query->param("dd-$counter");
120 my $borrowernumber = $query->param("bn-$counter");
121 $counter++;
123 # decode barcode ## Didn't we already decode them before passing them back last time??
124 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
125 $barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
127 ######################
128 #Are these lines still useful ?
129 $returneditems{$counter} = $barcode;
130 $riduedate{$counter} = $duedate;
131 $riborrowernumber{$counter} = $borrowernumber;
133 #######################
134 $input{counter} = $counter;
135 $input{barcode} = $barcode;
136 $input{duedate} = $duedate;
137 $input{borrowernumber} = $borrowernumber;
138 push( @inputloop, \%input );
141 ############
142 # Deal with the requests....
144 if ($query->param('WT-itemNumber')){
145 updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
148 if ( $query->param('reserve_id') ) {
149 my $itemnumber = $query->param('itemnumber');
150 my $borrowernumber = $query->param('borrowernumber');
151 my $reserve_id = $query->param('reserve_id');
152 my $diffBranchReturned = $query->param('diffBranch');
153 my $cancel_reserve = $query->param('cancel_reserve');
154 # fix up item type for display
155 my $item = Koha::Items->find( $itemnumber );
156 my $biblio = $item->biblio;
158 if ( $cancel_reserve ) {
159 my $hold = Koha::Holds->find( $reserve_id );
160 if ( $hold ) {
161 $hold->cancel( { charge_cancel_fee => !$forgivemanualholdsexpire } );
162 } # FIXME else?
163 } else {
164 my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
165 # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
166 # i.e., whether to apply waiting status
167 ModReserveAffect( $itemnumber, $borrowernumber, $diffBranchSend, $reserve_id );
169 # check if we have other reserves for this document, if we have a return send the message of transfer
170 my ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
172 my $patron = Koha::Patrons->find( $nextreservinfo );
173 my $name = $patron ? $patron->surname . ", " . $patron->title . " " . $patron->firstname : '';
174 if ( $messages->{'transfert'} ) {
175 $template->param(
176 itemtitle => $biblio->title,
177 itemnumber => $item->itemnumber,
178 itembiblionumber => $biblio->biblionumber,
179 iteminfo => $biblio->author,
180 name => $name,
181 patron => $patron,
182 diffbranch => 1,
187 my $borrower;
188 my $returned = 0;
189 my $messages;
190 my $issue;
191 my $itemnumber;
192 my $barcode = $query->param('barcode');
193 my $exemptfine = $query->param('exemptfine');
194 if (
195 $exemptfine &&
196 !C4::Auth::haspermission(C4::Context->userenv->{'id'}, {'updatecharges' => 'writeoff'})
198 # silently prevent unauthorized operator from forgiving overdue
199 # fines by manually tweaking form parameters
200 undef $exemptfine;
202 my $dropboxmode = $query->param('dropboxmode');
203 my $dotransfer = $query->param('dotransfer');
204 my $canceltransfer = $query->param('canceltransfer');
205 my $dest = $query->param('dest');
206 my $calendar = Koha::Calendar->new( branchcode => $userenv_branch );
207 #dropbox: get last open day (today - 1)
208 my $today = DateTime->now( time_zone => C4::Context->tz());
209 my $dropboxdate = $calendar->addDate($today, -1);
211 my $return_date_override = $query->param('return_date_override');
212 my $return_date_override_remember =
213 $query->param('return_date_override_remember');
214 if ($return_date_override) {
215 if ( C4::Context->preference('SpecifyReturnDate') ) {
216 my $return_date_override_dt = eval {dt_from_string( $return_date_override ) };
217 if ( $return_date_override_dt ) {
218 # note that we've overriden the return date
219 $template->param( return_date_was_overriden => 1);
220 # Save the original format if we are remembering for this series
221 $template->param(
222 return_date_override => $return_date_override,
223 return_date_override_remember => 1
224 ) if ($return_date_override_remember);
226 $return_date_override =
227 DateTime::Format::MySQL->format_datetime( $return_date_override_dt );
230 else {
231 $return_date_override = q{};
235 if ($dotransfer){
236 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
237 my $transferitem = $query->param('transferitem');
238 my $tobranch = $query->param('tobranch');
239 ModItemTransfer($transferitem, $userenv_branch, $tobranch);
242 if ($canceltransfer){
243 $itemnumber=$query->param('itemnumber');
244 DeleteTransfer($itemnumber);
245 if($dest eq "ttr"){
246 print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
247 exit;
248 } else {
249 $template->param( transfercancelled => 1);
253 # actually return book and prepare item table.....
254 my $returnbranch;
255 if ($barcode) {
256 $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
257 $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
258 my $item = Koha::Items->find({ barcode => $barcode });
260 if ( $item ) {
261 $itemnumber = $item->itemnumber;
262 # Check if we should display a checkin message, based on the the item
263 # type of the checked in item
264 my $itemtype = Koha::ItemTypes->find( $item->effective_itemtype );
265 if ( $itemtype && $itemtype->checkinmsg ) {
266 $template->param(
267 checkinmsg => $itemtype->checkinmsg,
268 checkinmsgtype => $itemtype->checkinmsgtype,
272 # make sure return branch respects home branch circulation rules, default to homebranch
273 my $hbr = GetBranchItemRule($item->homebranch, $itemtype ? $itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
274 $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $userenv_branch; # can be noreturn, homebranch or holdingbranch
276 my $materials = $item->materials;
277 my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => '', kohafield =>'items.materials', authorised_value => $materials });
278 $materials = $descriptions->{lib} // $materials;
280 my $checkout = $item->checkout;
281 my $biblio = $item->biblio;
282 $template->param(
283 title => $biblio->title,
284 homebranch => $item->homebranch,
285 holdingbranch => $item->holdingbranch,
286 returnbranch => $returnbranch,
287 author => $biblio->author,
288 itembarcode => $item->barcode,
289 itemtype => $item->effective_itemtype,
290 ccode => $item->ccode,
291 itembiblionumber => $biblio->biblionumber,
292 biblionumber => $biblio->biblionumber,
293 additional_materials => $materials,
294 issue => $checkout,
296 } # FIXME else we should not call AddReturn but set BadBarcode directly instead
298 my %input = (
299 counter => 0,
300 first => 1,
301 barcode => $barcode,
305 # do the return
306 ( $returned, $messages, $issue, $borrower ) =
307 AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode, $return_date_override, $dropboxdate );
309 if ($returned) {
310 my $time_now = DateTime->now( time_zone => C4::Context->tz )->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, DateTime->now()) == -1);
320 } else {
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;
329 if ($balance > 0) {
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) {
340 $template->param(
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'} ) {
349 $input{duedate} = 0;
350 $returneditems{0} = $barcode;
351 $riduedate{0} = 0;
352 push( @inputloop, \%input );
354 $template->param( privacy => $borrower->{privacy} );
356 $template->param( inputloop => \@inputloop );
358 my $found = 0;
359 my $waiting = 0;
360 my $reserved = 0;
362 # new op dev : we check if the document must be returned to his homebranch directly,
363 # if the document is transfered, we have warning message .
365 if ( $messages->{'WasTransfered'} ) {
366 $template->param(
367 found => 1,
368 transfer => 1,
369 itemnumber => $itemnumber,
373 if ( $messages->{'NeedsTransfer'} ){
374 $template->param(
375 found => 1,
376 needstransfer => $messages->{'NeedsTransfer'},
377 itemnumber => $itemnumber,
381 if ( $messages->{'Wrongbranch'} ){
382 $template->param(
383 wrongbranch => 1,
384 rightbranch => $messages->{'Wrongbranch'}->{'Rightbranch'},
388 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
390 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
391 $template->param(
392 WrongTransfer => 1,
393 TransferWaitingAt => $messages->{'WrongTransfer'},
394 WrongTransferItem => $messages->{'WrongTransferItem'},
395 itemnumber => $itemnumber,
398 my $reserve = $messages->{'ResFound'};
399 if ( $reserve ) {
400 my $patron = Koha::Patrons->find( $reserve->{'borrowernumber'} );
401 my $name = $patron->surname . ", " . $patron->title . " " . $patron->firstname;
402 $template->param(
403 patron => $patron,
406 $template->param(
407 wtransfertFrom => $userenv_branch,
412 # reserve found and item arrived at the expected branch
414 if ( $messages->{'ResFound'}) {
415 my $reserve = $messages->{'ResFound'};
416 my $patron = Koha::Patrons->find( $reserve->{borrowernumber} );
417 my $holdmsgpreferences = C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $reserve->{'borrowernumber'}, message_name => 'Hold_Filled' } );
419 if ( $reserve->{'ResFound'} eq "Reserved" && C4::Context->preference('HoldsAutoFill') ) {
420 my $item = Koha::Items->find( $itemnumber );
421 my $biblio = $item->biblio;
423 my $diffBranchSend = ($userenv_branch ne $reserve->{branchcode}) ? $reserve->{branchcode} : undef;
424 ModReserveAffect( $reserve->{itemnumber}, $reserve->{borrowernumber}, $diffBranchSend, $reserve->{reserve_id} );
425 my ( $messages, $nextreservinfo ) = GetOtherReserves($reserve->{itemnumber});
427 my $patron = Koha::Patrons->find( $nextreservinfo );
429 $template->param(
430 hold_auto_filled => 1,
431 print_slip => C4::Context->preference('HoldsAutoFillPrintSlip'),
432 patron => $patron,
433 borrowernumber => $patron->id,
434 biblionumber => $biblio->id,
437 if ( $messages->{'transfert'} ) {
438 $template->param(
439 itemtitle => $biblio->title,
440 itemnumber => $item->itemnumber,
441 itembiblionumber => $biblio->biblionumber,
442 iteminfo => $biblio->author,
443 diffbranch => 1,
447 elsif ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
448 if ( $reserve->{'ResFound'} eq "Waiting" ) {
449 $template->param(
450 waiting => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
452 } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
453 $template->param(
454 intransit => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
455 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
456 reserve_id => $reserve->{reserve_id},
457 reserved => 1,
461 } # else { ; } # error?
463 # same params for Waiting or Reserved
464 $template->param(
465 found => 1,
466 patron => $patron,
467 barcode => $barcode,
468 destbranch => $reserve->{'branchcode'},
469 itemnumber => $reserve->{'itemnumber'},
470 reservenotes => $reserve->{'reservenotes'},
471 reserve_id => $reserve->{reserve_id},
472 bormessagepref => $holdmsgpreferences->{'transports'},
476 # Error Messages
477 my @errmsgloop;
478 foreach my $code ( keys %$messages ) {
479 my %err;
480 my $exit_required_p = 0;
481 if ( $code eq 'BadBarcode' ) {
482 $err{badbarcode} = 1;
483 $err{msg} = $messages->{'BadBarcode'};
485 elsif ( $code eq 'NotIssued' ) {
486 $err{notissued} = 1;
487 $err{msg} = '';
489 elsif ( $code eq 'LocalUse' ) {
490 $err{localuse} = 1;
492 elsif ( $code eq 'WasLost' ) {
493 $err{waslost} = 1;
494 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfLostItems");
496 elsif ( $code eq 'LostItemFeeRefunded' ) {
497 $template->param( LostItemFeeRefunded => 1 );
499 elsif ( $code eq 'ResFound' ) {
500 ; # FIXME... anything to do here?
502 elsif ( $code eq 'WasReturned' ) {
503 ; # FIXME... anything to do here?
505 elsif ( $code eq 'WasTransfered' ) {
506 ; # FIXME... anything to do here?
508 elsif ( $code eq 'withdrawn' ) {
509 $err{withdrawn} = 1;
510 $exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
512 elsif ( $code eq 'WrongTransfer' ) {
513 ; # FIXME... anything to do here?
515 elsif ( $code eq 'WrongTransferItem' ) {
516 ; # FIXME... anything to do here?
518 elsif ( $code eq 'NeedsTransfer' ) {
520 elsif ( $code eq 'Wrongbranch' ) {
522 elsif ( $code eq 'Debarred' ) {
523 $err{debarred} = $messages->{'Debarred'};
524 $err{debarcardnumber} = $borrower->{cardnumber};
525 $err{debarborrowernumber} = $borrower->{borrowernumber};
526 $err{debarname} = "$borrower->{firstname} $borrower->{surname}";
528 elsif ( $code eq 'PrevDebarred' ) {
529 $err{prevdebarred} = $messages->{'PrevDebarred'};
531 elsif ( $code eq 'ForeverDebarred' ) {
532 $err{foreverdebarred} = $messages->{'ForeverDebarred'};
534 elsif ( $code eq 'NotForLoanStatusUpdated' ) {
535 $err{NotForLoanStatusUpdated} = $messages->{NotForLoanStatusUpdated};
537 elsif ( $code eq 'DataCorrupted' ) {
538 $err{data_corrupted} = 1;
540 else {
541 die "Unknown error code $code"; # note we need all the (empty) elsif's above, or we die.
542 # This forces the issue of staying in sync w/ Circulation.pm
544 if (%err) {
545 push( @errmsgloop, \%err );
547 last if $exit_required_p;
549 $template->param( errmsgloop => \@errmsgloop );
551 #set up so only the last 8 returned items display (make for faster loading pages)
552 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
553 my $count = 0;
554 my @riloop;
555 my $shelflocations =
556 { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
557 foreach ( sort { $a <=> $b } keys %returneditems ) {
558 my %ri;
559 if ( $count++ < $returned_counter ) {
560 my $bar_code = $returneditems{$_};
561 if ($riduedate{$_}) {
562 my $duedate = dt_from_string( $riduedate{$_}, 'sql');
563 $ri{year} = $duedate->year();
564 $ri{month} = $duedate->month();
565 $ri{day} = $duedate->day();
566 $ri{hour} = $duedate->hour();
567 $ri{minute} = $duedate->minute();
568 $ri{duedate} = output_pref($duedate);
569 my $patron = Koha::Patrons->find( $riborrowernumber{$_} );
570 unless ( $dropboxmode ) {
571 $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1);
572 } else {
573 $ri{return_overdue} = 1 if (DateTime->compare($duedate, $dropboxdate) == -1);
575 $ri{patron} = $patron,
576 $ri{borissuescount} = $patron->checkouts->count;
578 else {
579 $ri{borrowernumber} = $riborrowernumber{$_};
582 my $item = Koha::Items->find({ barcode => $bar_code });
583 next unless $item; # FIXME The item has been deleted in the meantime,
584 # we could handle that better displaying a message in the template
585 my $biblio = $item->biblio;
586 # FIXME pass $item to the template and we are done here...
587 $ri{itembiblionumber} = $biblio->biblionumber;
588 $ri{itemtitle} = $biblio->title;
589 $ri{itemauthor} = $biblio->author;
590 $ri{itemcallnumber} = $item->itemcallnumber;
591 $ri{dateaccessioned} = $item->dateaccessioned;
592 $ri{itemtype} = $item->effective_itemtype;
593 $ri{itemnote} = $item->itemnotes;
594 $ri{itemnotes_nonpublic} = $item->itemnotes_nonpublic;
595 $ri{ccode} = $item->ccode;
596 $ri{enumchron} = $item->enumchron;
597 $ri{itemnumber} = $item->itemnumber;
598 $ri{barcode} = $bar_code;
599 $ri{homebranch} = $item->homebranch;
600 $ri{holdingbranch} = $item->holdingbranch;
602 $ri{location} = $item->location;
603 my $shelfcode = $ri{'location'};
604 $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
607 else {
608 last;
610 push @riloop, \%ri;
613 $template->param(
614 riloop => \@riloop,
615 printer => $printer,
616 errmsgloop => \@errmsgloop,
617 exemptfine => $exemptfine,
618 dropboxmode => $dropboxmode,
619 dropboxdate => output_pref($dropboxdate),
620 forgivemanualholdsexpire => $forgivemanualholdsexpire,
621 overduecharges => $overduecharges,
622 AudioAlerts => C4::Context->preference("AudioAlerts"),
625 my $item_from_barcode = Koha::Items->find({barcode => $barcode }); # How many times do we fetch this item?!?
626 if ( $item_from_barcode ) {
627 $itemnumber = $item_from_barcode->itemnumber;
628 my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
629 if ( $holdingBranch and $collectionBranch ) {
630 $holdingBranch //= '';
631 $collectionBranch //= $returnbranch;
632 if ( ! ( $holdingBranch eq $collectionBranch ) ) {
633 $template->param(
634 collectionItemNeedsTransferred => 1,
635 collectionBranch => $collectionBranch,
636 itemnumber => $itemnumber,
642 # Checking if there is a Fast Cataloging Framework
643 $template->param( fast_cataloging => 1 ) if Koha::BiblioFrameworks->find( 'FA' );
645 # actually print the page!
646 output_html_with_http_headers $query, $cookie, $template->output;