Bug 20822: (bug 18789 follow-up) Fix HOLD_SLIP
[koha.git] / circ / returns.pl
1 #!/usr/bin/perl
2
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.
8 #
9 # This file is part of Koha.
10 #
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.
15 #
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.
20 #
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>.
23
24 =head1 returns.pl
25
26 script to execute returns of books
27
28 =cut
29
30 use Modern::Perl;
31
32 # FIXME There are weird things going on with $patron and $borrowernumber in this script
33
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;
55
56 my $query = new CGI;
57
58 #getting the template
59 my ( $template, $librarian, $cookie, $flags ) = get_template_and_user(
60     {
61         template_name   => "circ/returns.tt",
62         query           => $query,
63         type            => "intranet",
64         authnotrequired => 0,
65         flagsrequired   => { circulate => "circulate_remaining_permissions" },
66     }
67 );
68
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;
75 }
76
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     );
84 }
85
86 #####################
87 #Global vars
88 my $printers = GetPrinters();
89 my $userenv = C4::Context->userenv;
90 my $userenv_branch = $userenv->{'branch'} // '';
91 my $printer = $userenv->{'branchprinter'} // '';
92 my $forgivemanualholdsexpire = $query->param('forgivemanualholdsexpire');
93
94 my $overduecharges = (C4::Context->preference('finesMode') && C4::Context->preference('finesMode') ne 'off');
95  #
96 # Some code to handle the error if there is no branch or printer setting.....
97 #
98
99 # Set up the item stack ....
100 my %returneditems;
101 my %riduedate;
102 my %riborrowernumber;
103 my @inputloop;
104 foreach ( $query->param ) {
105     my $counter;
106     if (/ri-(\d*)/) {
107         $counter = $1;
108         if ($counter > 20) {
109             next;
110         }
111     }
112     else {
113         next;
114     }
115
116     my %input;
117     my $barcode        = $query->param("ri-$counter");
118     my $duedate        = $query->param("dd-$counter");
119     my $borrowernumber = $query->param("bn-$counter");
120     $counter++;
121
122     # decode barcode    ## Didn't we already decode them before passing them back last time??
123     $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
124     $barcode = barcodedecode($barcode) if(C4::Context->preference('itemBarcodeInputFilter'));
125
126     ######################
127     #Are these lines still useful ?
128     $returneditems{$counter}    = $barcode;
129     $riduedate{$counter}        = $duedate;
130     $riborrowernumber{$counter} = $borrowernumber;
131
132     #######################
133     $input{counter}        = $counter;
134     $input{barcode}        = $barcode;
135     $input{duedate}        = $duedate;
136     $input{borrowernumber} = $borrowernumber;
137     push( @inputloop, \%input );
138 }
139
140 ############
141 # Deal with the requests....
142
143 if ($query->param('WT-itemNumber')){
144         updateWrongTransfer ($query->param('WT-itemNumber'),$query->param('WT-waitingAt'),$query->param('WT-From'));
145 }
146
147 if ( $query->param('reserve_id') ) {
148     my $itemnumber     = $query->param('itemnumber');
149     my $borrowernumber = $query->param('borrowernumber');
150     my $reserve_id     = $query->param('reserve_id');
151     my $diffBranchReturned = $query->param('diffBranch');
152     my $cancel_reserve = $query->param('cancel_reserve');
153     # fix up item type for display
154     my $item = Koha::Items->find( $itemnumber );
155     my $biblio = $item->biblio;
156
157     if ( $cancel_reserve ) {
158         my $hold = Koha::Holds->find( $reserve_id );
159         if ( $hold ) {
160             $hold->cancel( { charge_cancel_fee => !$forgivemanualholdsexpire } );
161         } # FIXME else?
162     } else {
163         my $diffBranchSend = ($userenv_branch ne $diffBranchReturned) ? $diffBranchReturned : undef;
164         # diffBranchSend tells ModReserveAffect whether document is expected in this library or not,
165         # i.e., whether to apply waiting status
166         ModReserveAffect( $itemnumber, $borrowernumber, $diffBranchSend, $reserve_id );
167     }
168 #   check if we have other reserves for this document, if we have a return send the message of transfer
169     my ( $messages, $nextreservinfo ) = GetOtherReserves($itemnumber);
170
171     my $patron = Koha::Patrons->find( $nextreservinfo );
172     my $name   = $patron ? $patron->surname . ", " . $patron->title . " " . $patron->firstname : '';
173     if ( $messages->{'transfert'} ) {
174         $template->param(
175             itemtitle      => $biblio->title,
176             itemnumber     => $item->itemnumber,
177             itembiblionumber => $biblio->biblionumber,
178             iteminfo       => $biblio->author,
179             name           => $name,
180             patron         => $patron,
181             diffbranch     => 1,
182         );
183     }
184 }
185
186 my $borrower;
187 my $returned = 0;
188 my $messages;
189 my $issue;
190 my $itemnumber;
191 my $barcode     = $query->param('barcode');
192 my $exemptfine  = $query->param('exemptfine');
193 if (
194   $exemptfine &&
195   !C4::Auth::haspermission(C4::Context->userenv->{'id'}, {'updatecharges' => 'writeoff'})
196 ) {
197     # silently prevent unauthorized operator from forgiving overdue
198     # fines by manually tweaking form parameters
199     undef $exemptfine;
200 }
201 my $dropboxmode = $query->param('dropboxmode');
202 my $dotransfer  = $query->param('dotransfer');
203 my $canceltransfer = $query->param('canceltransfer');
204 my $dest = $query->param('dest');
205 my $calendar    = Koha::Calendar->new( branchcode => $userenv_branch );
206 #dropbox: get last open day (today - 1)
207 my $today       = DateTime->now( time_zone => C4::Context->tz());
208 my $dropboxdate = $calendar->addDate($today, -1);
209
210 my $return_date_override = $query->param('return_date_override');
211 my $return_date_override_remember =
212   $query->param('return_date_override_remember');
213 if ($return_date_override) {
214     if ( C4::Context->preference('SpecifyReturnDate') ) {
215         my $return_date_override_dt = eval {dt_from_string( $return_date_override ) };
216         if ( $return_date_override_dt ) {
217             # note that we've overriden the return date
218             $template->param( return_date_was_overriden => 1);
219             # Save the original format if we are remembering for this series
220             $template->param(
221                 return_date_override          => $return_date_override,
222                 return_date_override_remember => 1
223             ) if ($return_date_override_remember);
224
225             $return_date_override =
226               DateTime::Format::MySQL->format_datetime( $return_date_override_dt );
227         }
228     }
229     else {
230         $return_date_override = q{};
231     }
232 }
233
234 if ($dotransfer){
235 # An item has been returned to a branch other than the homebranch, and the librarian has chosen to initiate a transfer
236     my $transferitem = $query->param('transferitem');
237     my $tobranch     = $query->param('tobranch');
238     ModItemTransfer($transferitem, $userenv_branch, $tobranch);
239 }
240
241 if ($canceltransfer){
242     $itemnumber=$query->param('itemnumber');
243     DeleteTransfer($itemnumber);
244     if($dest eq "ttr"){
245         print $query->redirect("/cgi-bin/koha/circ/transferstoreceive.pl");
246         exit;
247     } else {
248         $template->param( transfercancelled => 1);
249     }
250 }
251
252 # actually return book and prepare item table.....
253 my $returnbranch;
254 if ($barcode) {
255     $barcode =~ s/^\s*|\s*$//g; # remove leading/trailing whitespace
256     $barcode = barcodedecode($barcode) if C4::Context->preference('itemBarcodeInputFilter');
257     my $item = Koha::Items->find({ barcode => $barcode });
258
259     if ( $item ) {
260         $itemnumber = $item->itemnumber;
261         # Check if we should display a checkin message, based on the the item
262         # type of the checked in item
263         my $itemtype = Koha::ItemTypes->find( $item->effective_itemtype );
264         if ( $itemtype && $itemtype->checkinmsg ) {
265             $template->param(
266                 checkinmsg     => $itemtype->checkinmsg,
267                 checkinmsgtype => $itemtype->checkinmsgtype,
268             );
269         }
270
271         # make sure return branch respects home branch circulation rules, default to homebranch
272         my $hbr = GetBranchItemRule($item->homebranch, $itemtype ? $itemtype->itemtype : undef )->{'returnbranch'} || "homebranch";
273         $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $userenv_branch; # can be noreturn, homebranch or holdingbranch
274
275         my $materials = $item->materials;
276         my $descriptions = Koha::AuthorisedValues->get_description_by_koha_field({frameworkcode => '', kohafield =>'items.materials', authorised_value => $materials });
277         $materials = $descriptions->{lib} // $materials;
278
279         my $checkout = $item->checkout;
280         my $biblio   = $item->biblio;
281         $template->param(
282             title            => $biblio->title,
283             homebranch       => $item->homebranch,
284             holdingbranch    => $item->holdingbranch,
285             returnbranch     => $returnbranch,
286             author           => $biblio->author,
287             itembarcode      => $item->barcode,
288             itemtype         => $item->effective_itemtype,
289             ccode            => $item->ccode,
290             itembiblionumber => $biblio->biblionumber,
291             biblionumber     => $biblio->biblionumber,
292             additional_materials => $materials,
293             issue            => $checkout,
294         );
295     } # FIXME else we should not call AddReturn but set BadBarcode directly instead
296
297     my %input = (
298         counter => 0,
299         first   => 1,
300         barcode => $barcode,
301     );
302
303
304     # do the return
305     ( $returned, $messages, $issue, $borrower ) =
306       AddReturn( $barcode, $userenv_branch, $exemptfine, $dropboxmode, $return_date_override, $dropboxdate );
307
308     if ($returned) {
309         my $time_now = DateTime->now( time_zone => C4::Context->tz )->truncate( to => 'minute');
310         my $date_due_dt = dt_from_string( $issue->date_due, 'sql' );
311         my $duedate = $date_due_dt->strftime('%Y-%m-%d %H:%M');
312         $returneditems{0}      = $barcode;
313         $riborrowernumber{0}   = $borrower->{'borrowernumber'};
314         $riduedate{0}          = $duedate;
315         $input{borrowernumber} = $borrower->{'borrowernumber'};
316         $input{duedate}        = $duedate;
317         unless ( $dropboxmode ) {
318             $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, DateTime->now()) == -1);
319         } else {
320             $input{return_overdue} = 1 if (DateTime->compare($date_due_dt, $dropboxdate) == -1);
321         }
322         push( @inputloop, \%input );
323
324         if ( C4::Context->preference("FineNotifyAtCheckin") ) {
325             my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
326             my $balance = $patron->account->balance;
327
328             if ($balance > 0) {
329                 $template->param( fines => sprintf("%.2f", $balance) );
330                 $template->param( fineborrowernumber => $borrower->{'borrowernumber'} );
331             }
332         }
333
334         if (C4::Context->preference("WaitingNotifyAtCheckin") ) {
335             #Check for waiting holds
336             my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
337             my $waiting_holds = $patron->holds->search({ found => 'W', branchcode => $userenv_branch })->count;
338             if ($waiting_holds > 0) {
339                 $template->param(
340                     waiting_holds       => $waiting_holds,
341                     holdsborrowernumber => $borrower->{'borrowernumber'},
342                     holdsfirstname => $borrower->{'firstname'},
343                     holdssurname => $borrower->{'surname'},
344                 );
345             }
346         }
347     } elsif ( C4::Context->preference('ShowAllCheckins') and !$messages->{'BadBarcode'} ) {
348         $input{duedate}   = 0;
349         $returneditems{0} = $barcode;
350         $riduedate{0}     = 0;
351         push( @inputloop, \%input );
352     }
353     $template->param( privacy => $borrower->{privacy} );
354 }
355 $template->param( inputloop => \@inputloop );
356
357 my $found    = 0;
358 my $waiting  = 0;
359 my $reserved = 0;
360
361 # new op dev : we check if the document must be returned to his homebranch directly,
362 #  if the document is transfered, we have warning message .
363
364 if ( $messages->{'WasTransfered'} ) {
365     $template->param(
366         found          => 1,
367         transfer       => 1,
368         itemnumber     => $itemnumber,
369     );
370 }
371
372 if ( $messages->{'NeedsTransfer'} ){
373     $template->param(
374         found          => 1,
375         needstransfer  => $messages->{'NeedsTransfer'},
376         itemnumber     => $itemnumber,
377     );
378 }
379
380 if ( $messages->{'Wrongbranch'} ){
381     $template->param(
382         wrongbranch => 1,
383         rightbranch => $messages->{'Wrongbranch'}->{'Rightbranch'},
384     );
385 }
386
387 # case of wrong transfert, if the document wasn't transfered to the right library (according to branchtransfer (tobranch) BDD)
388
389 if ( $messages->{'WrongTransfer'} and not $messages->{'WasTransfered'}) {
390     $template->param(
391         WrongTransfer  => 1,
392         TransferWaitingAt => $messages->{'WrongTransfer'},
393         WrongTransferItem => $messages->{'WrongTransferItem'},
394         itemnumber => $itemnumber,
395     );
396
397     my $reserve    = $messages->{'ResFound'};
398     if ( $reserve ) {
399         my $patron = Koha::Patrons->find( $reserve->{'borrowernumber'} );
400         my $name = $patron->surname . ", " . $patron->title . " " . $patron->firstname;
401         $template->param(
402             patron => $patron,
403         );
404     }
405     $template->param(
406         wtransfertFrom  => $userenv_branch,
407     );
408 }
409
410 #
411 # reserve found and item arrived at the expected branch
412 #
413 if ( $messages->{'ResFound'}) {
414     my $reserve    = $messages->{'ResFound'};
415     my $patron = Koha::Patrons->find( $reserve->{borrowernumber} );
416     my $holdmsgpreferences =  C4::Members::Messaging::GetMessagingPreferences( { borrowernumber => $reserve->{'borrowernumber'}, message_name   => 'Hold_Filled' } );
417     if ( $reserve->{'ResFound'} eq "Waiting" or $reserve->{'ResFound'} eq "Reserved" ) {
418         if ( $reserve->{'ResFound'} eq "Waiting" ) {
419             $template->param(
420                 waiting      => ($userenv_branch eq $reserve->{'branchcode'} ? 1 : 0 ),
421             );
422         } elsif ( $reserve->{'ResFound'} eq "Reserved" ) {
423             $template->param(
424                 intransit    => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
425                 transfertodo => ($userenv_branch eq $reserve->{'branchcode'} ? 0 : 1 ),
426                 reserve_id   => $reserve->{reserve_id},
427                 reserved     => 1,
428             );
429         }
430
431         # same params for Waiting or Reserved
432         $template->param(
433             # FIXME The full patron object should be passed to the template
434             found          => 1,
435             patron         => $patron,
436             barcode        => $barcode,
437             destbranch     => $reserve->{'branchcode'},
438             itemnumber     => $reserve->{'itemnumber'},
439             reservenotes   => $reserve->{'reservenotes'},
440             reserve_id     => $reserve->{reserve_id},
441             bormessagepref => $holdmsgpreferences->{'transports'},
442         );
443     } # else { ; }  # error?
444 }
445
446 # Error Messages
447 my @errmsgloop;
448 foreach my $code ( keys %$messages ) {
449     my %err;
450     my $exit_required_p = 0;
451     if ( $code eq 'BadBarcode' ) {
452         $err{badbarcode} = 1;
453         $err{msg}        = $messages->{'BadBarcode'};
454     }
455     elsif ( $code eq 'NotIssued' ) {
456         $err{notissued} = 1;
457         $err{msg} = '';
458     }
459     elsif ( $code eq 'LocalUse' ) {
460         $err{localuse} = 1;
461     }
462     elsif ( $code eq 'WasLost' ) {
463         $err{waslost} = 1;
464         $exit_required_p = 1 if C4::Context->preference("BlockReturnOfLostItems");
465     }
466     elsif ( $code eq 'LostItemFeeRefunded' ) {
467         $template->param( LostItemFeeRefunded => 1 );
468     }
469     elsif ( $code eq 'ResFound' ) {
470         ;    # FIXME... anything to do here?
471     }
472     elsif ( $code eq 'WasReturned' ) {
473         ;    # FIXME... anything to do here?
474     }
475     elsif ( $code eq 'WasTransfered' ) {
476         ;    # FIXME... anything to do here?
477     }
478     elsif ( $code eq 'withdrawn' ) {
479         $err{withdrawn} = 1;
480         $exit_required_p = 1 if C4::Context->preference("BlockReturnOfWithdrawnItems");
481     }
482     elsif ( $code eq 'WrongTransfer' ) {
483         ;    # FIXME... anything to do here?
484     }
485     elsif ( $code eq 'WrongTransferItem' ) {
486         ;    # FIXME... anything to do here?
487     }
488     elsif ( $code eq 'NeedsTransfer' ) {
489     }
490     elsif ( $code eq 'Wrongbranch' ) {
491     }
492     elsif ( $code eq 'Debarred' ) {
493         $err{debarred}            = $messages->{'Debarred'};
494         $err{debarcardnumber}     = $borrower->{cardnumber};
495         $err{debarborrowernumber} = $borrower->{borrowernumber};
496         $err{debarname}           = "$borrower->{firstname} $borrower->{surname}";
497     }
498     elsif ( $code eq 'PrevDebarred' ) {
499         $err{prevdebarred}        = $messages->{'PrevDebarred'};
500     }
501     elsif ( $code eq 'ForeverDebarred' ) {
502         $err{foreverdebarred}        = $messages->{'ForeverDebarred'};
503     }
504     elsif ( $code eq 'NotForLoanStatusUpdated' ) {
505         $err{NotForLoanStatusUpdated} = $messages->{NotForLoanStatusUpdated};
506     }
507     elsif ( $code eq 'DataCorrupted' ) {
508         $err{data_corrupted} = 1;
509     }
510     else {
511         die "Unknown error code $code";    # note we need all the (empty) elsif's above, or we die.
512         # This forces the issue of staying in sync w/ Circulation.pm
513     }
514     if (%err) {
515         push( @errmsgloop, \%err );
516     }
517     last if $exit_required_p;
518 }
519 $template->param( errmsgloop => \@errmsgloop );
520
521 #set up so only the last 8 returned items display (make for faster loading pages)
522 my $returned_counter = ( C4::Context->preference('numReturnedItemsToShow') ) ? C4::Context->preference('numReturnedItemsToShow') : 8;
523 my $count = 0;
524 my @riloop;
525 my $shelflocations =
526   { map { $_->{authorised_value} => $_->{lib} } Koha::AuthorisedValues->get_descriptions_by_koha_field( { frameworkcode => '', kohafield => 'items.location' } ) };
527 foreach ( sort { $a <=> $b } keys %returneditems ) {
528     my %ri;
529     if ( $count++ < $returned_counter ) {
530         my $bar_code = $returneditems{$_};
531         if ($riduedate{$_}) {
532             my $duedate = dt_from_string( $riduedate{$_}, 'sql');
533             $ri{year}  = $duedate->year();
534             $ri{month} = $duedate->month();
535             $ri{day}   = $duedate->day();
536             $ri{hour}   = $duedate->hour();
537             $ri{minute}   = $duedate->minute();
538             $ri{duedate} = output_pref($duedate);
539             my $patron = Koha::Patrons->find( $riborrowernumber{$_} );
540             unless ( $dropboxmode ) {
541                 $ri{return_overdue} = 1 if (DateTime->compare($duedate, DateTime->now()) == -1);
542             } else {
543                 $ri{return_overdue} = 1 if (DateTime->compare($duedate, $dropboxdate) == -1);
544             }
545             $ri{patron} = $patron,
546             $ri{borissuescount} = $patron->checkouts->count;
547         }
548         else {
549             $ri{borrowernumber} = $riborrowernumber{$_};
550         }
551
552         my $item = Koha::Items->find({ barcode => $bar_code });
553         my $biblio = $item->biblio;
554         # FIXME pass $item to the template and we are done here...
555         $ri{itembiblionumber}    = $biblio->biblionumber;
556         $ri{itemtitle}           = $biblio->title;
557         $ri{itemauthor}          = $biblio->author;
558         $ri{itemcallnumber}      = $item->itemcallnumber;
559         $ri{dateaccessioned}     = $item->dateaccessioned;
560         $ri{itemtype}            = $item->effective_itemtype;
561         $ri{itemnote}            = $item->itemnotes;
562         $ri{itemnotes_nonpublic} = $item->itemnotes_nonpublic;
563         $ri{ccode}               = $item->ccode;
564         $ri{enumchron}           = $item->enumchron;
565         $ri{itemnumber}          = $item->itemnumber;
566         $ri{barcode}             = $bar_code;
567         $ri{homebranch}          = $item->homebranch;
568         $ri{holdingbranch}       = $item->holdingbranch;
569
570         $ri{location} = $item->location;
571         my $shelfcode = $ri{'location'};
572         $ri{'location'} = $shelflocations->{$shelfcode} if ( defined( $shelfcode ) && defined($shelflocations) && exists( $shelflocations->{$shelfcode} ) );
573
574     }
575     else {
576         last;
577     }
578     push @riloop, \%ri;
579 }
580
581 $template->param(
582     riloop         => \@riloop,
583     printer        => $printer,
584     errmsgloop     => \@errmsgloop,
585     exemptfine     => $exemptfine,
586     dropboxmode    => $dropboxmode,
587     dropboxdate    => output_pref($dropboxdate),
588     forgivemanualholdsexpire => $forgivemanualholdsexpire,
589     overduecharges => $overduecharges,
590     AudioAlerts        => C4::Context->preference("AudioAlerts"),
591 );
592
593 $itemnumber = GetItemnumberFromBarcode( $barcode );
594 if ( $itemnumber ) {
595     my ( $holdingBranch, $collectionBranch ) = GetCollectionItemBranches( $itemnumber );
596     if ( $holdingBranch and $collectionBranch ) {
597         $holdingBranch //= '';
598         $collectionBranch //= $returnbranch;
599         if ( ! ( $holdingBranch eq $collectionBranch ) ) {
600             $template->param(
601               collectionItemNeedsTransferred => 1,
602               collectionBranch => $collectionBranch,
603               itemnumber => $itemnumber,
604             );
605         }
606     }
607 }
608
609 # Checking if there is a Fast Cataloging Framework
610 $template->param( fast_cataloging => 1 ) if Koha::BiblioFrameworks->find( 'FA' );
611
612 # actually print the page!
613 output_html_with_http_headers $query, $cookie, $template->output;