Bug 35944: (QA follow-up) Tidy
[koha.git] / C4 / Circulation.pm
1 package C4::Circulation;
2
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
5 #
6 # This file is part of Koha.
7 #
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
12 #
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
17 #
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20
21 use Modern::Perl;
22 use DateTime;
23 use POSIX qw( floor );
24 use YAML::XS;
25 use Encode;
26
27 use C4::Context;
28 use C4::Stats qw( UpdateStats );
29 use C4::Reserves qw( CheckReserves CanItemBeReserved MoveReserve ModReserve ModReserveMinusPriority RevertWaitingStatus IsItemOnHoldAndFound IsAvailableForItemLevelRequest );
30 use C4::Biblio qw( UpdateTotalIssues );
31 use C4::Items qw( ModItemTransfer ModDateLastSeen CartToShelf );
32 use C4::Accounts;
33 use C4::ItemCirculationAlertPreference;
34 use C4::Message;
35 use C4::Log qw( logaction ); # logaction
36 use C4::Overdues;
37 use C4::RotatingCollections qw(GetCollectionItemBranches);
38 use Algorithm::CheckDigits qw( CheckDigits );
39
40 use Data::Dumper qw( Dumper );
41 use Koha::Account;
42 use Koha::AuthorisedValues;
43 use Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue;
44 use Koha::Biblioitems;
45 use Koha::DateUtils qw( dt_from_string );
46 use Koha::Calendar;
47 use Koha::Checkouts;
48 use Koha::Illrequests;
49 use Koha::Items;
50 use Koha::Patrons;
51 use Koha::Patron::Debarments qw( DelUniqueDebarment AddUniqueDebarment );
52 use Koha::Database;
53 use Koha::Libraries;
54 use Koha::Account::Lines;
55 use Koha::Holds;
56 use Koha::Account::Lines;
57 use Koha::Account::Offsets;
58 use Koha::Config::SysPrefs;
59 use Koha::Charges::Fees;
60 use Koha::Config::SysPref;
61 use Koha::Checkouts::ReturnClaims;
62 use Koha::SearchEngine::Indexer;
63 use Koha::Exceptions::Checkout;
64 use Koha::Plugins;
65 use Koha::Recalls;
66 use Carp qw( carp );
67 use List::MoreUtils qw( any );
68 use Scalar::Util qw( looks_like_number blessed );
69 use Date::Calc qw( Date_to_Days );
70 our (@ISA, @EXPORT_OK);
71 BEGIN {
72
73     require Exporter;
74     @ISA = qw(Exporter);
75
76     # FIXME subs that should probably be elsewhere
77     push @EXPORT_OK, qw(
78       barcodedecode
79       LostItem
80       ReturnLostItem
81       GetPendingOnSiteCheckouts
82
83       CanBookBeIssued
84       checkHighHolds
85       CanBookBeRenewed
86       AddIssue
87       GetLoanLength
88       GetHardDueDate
89       AddRenewal
90       GetRenewCount
91       GetSoonestRenewDate
92       GetLatestAutoRenewDate
93       GetIssuingCharges
94       AddIssuingCharge
95       GetBranchBorrowerCircRule
96       GetBranchItemRule
97       GetBiblioIssues
98       GetUpcomingDueIssues
99       CheckIfIssuedToPatron
100       IsItemIssued
101       GetAgeRestriction
102       GetTopIssues
103
104       AddReturn
105       MarkIssueReturned
106
107       transferbook
108       TooMany
109       GetTransfersFromTo
110       updateWrongTransfer
111       CalcDateDue
112       CheckValidBarcode
113       IsBranchTransferAllowed
114       CreateBranchTransferLimit
115       DeleteBranchTransferLimits
116       TransferSlip
117
118       GetOfflineOperations
119       GetOfflineOperation
120       AddOfflineOperation
121       DeleteOfflineOperation
122       ProcessOfflineOperation
123       ProcessOfflinePayment
124       ProcessOfflineIssue
125     );
126     push @EXPORT_OK, '_GetCircControlBranch';    # This is wrong!
127 }
128
129 =head1 NAME
130
131 C4::Circulation - Koha circulation module
132
133 =head1 SYNOPSIS
134
135 use C4::Circulation;
136
137 =head1 DESCRIPTION
138
139 The functions in this module deal with circulation, issues, and
140 returns, as well as general information about the library.
141 Also deals with inventory.
142
143 =head1 FUNCTIONS
144
145 =head2 barcodedecode
146
147   $str = &barcodedecode($barcode, [$filter]);
148
149 Generic filter function for barcode string.
150 Called on every circ if the System Pref itemBarcodeInputFilter is set.
151 Will do some manipulation of the barcode for systems that deliver a barcode
152 to circulation.pl that differs from the barcode stored for the item.
153 For proper functioning of this filter, calling the function on the 
154 correct barcode string (items.barcode) should return an unaltered barcode.
155 Barcode is going to be automatically trimmed of leading/trailing whitespaces.
156
157 The optional $filter argument is to allow for testing or explicit 
158 behavior that ignores the System Pref.  Valid values are the same as the 
159 System Pref options.
160
161 =cut
162
163 # FIXME -- the &decode fcn below should be wrapped into this one.
164 # FIXME -- these plugins should be moved out of Circulation.pm
165 #
166 sub barcodedecode {
167     my ($barcode, $filter) = @_;
168
169     return unless defined $barcode;
170
171     my $branch = C4::Context::mybranch();
172     $barcode =~ s/^\s+|\s+$//g;
173     $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
174     Koha::Plugins->call('item_barcode_transform',  \$barcode );
175     $filter or return $barcode;     # ensure filter is defined, else return untouched barcode
176         if ($filter eq 'whitespace') {
177                 $barcode =~ s/\s//g;
178         } elsif ($filter eq 'cuecat') {
179                 chomp($barcode);
180             my @fields = split( /\./, $barcode );
181             my @results = map( C4::Circulation::_decode($_), @fields[ 1 .. $#fields ] );
182             ($#results == 2) and return $results[2];
183         } elsif ($filter eq 'T-prefix') {
184                 if ($barcode =~ /^[Tt](\d)/) {
185                         (defined($1) and $1 eq '0') and return $barcode;
186             $barcode = substr($barcode, 2) + 0;     # FIXME: probably should be substr($barcode, 1)
187                 }
188         return sprintf("T%07d", $barcode);
189         # FIXME: $barcode could be "T1", causing warning: substr outside of string
190         # Why drop the nonzero digit after the T?
191         # Why pass non-digits (or empty string) to "T%07d"?
192         } elsif ($filter eq 'libsuite8') {
193                 unless($barcode =~ m/^($branch)-/i){    #if barcode starts with branch code its in Koha style. Skip it.
194                         if($barcode =~ m/^(\d)/i){      #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
195                                 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
196                         }else{
197                                 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
198                         }
199                 }
200     } elsif ($filter eq 'EAN13') {
201         my $ean = CheckDigits('ean');
202         if ( $ean->is_valid($barcode) ) {
203             #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
204             $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
205         } else {
206             warn "# [$barcode] not valid EAN-13/UPC-A\n";
207         }
208         }
209     return $barcode;    # return barcode, modified or not
210 }
211
212 =head2 _decode
213
214   $str = &_decode($chunk);
215
216 Decodes a segment of a string emitted by a CueCat barcode scanner and
217 returns it.
218
219 FIXME: Should be replaced with Barcode::Cuecat from CPAN
220 or Javascript based decoding on the client side.
221
222 =cut
223
224 sub _decode {
225     my ($encoded) = @_;
226     my $seq =
227       'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
228     my @s = map { index( $seq, $_ ); } split( //, $encoded );
229     my $l = ( $#s + 1 ) % 4;
230     if ($l) {
231         if ( $l == 1 ) {
232             # warn "Error: Cuecat decode parsing failed!";
233             return;
234         }
235         $l = 4 - $l;
236         $#s += $l;
237     }
238     my $r = '';
239     while ( $#s >= 0 ) {
240         my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
241         $r .=
242             chr( ( $n >> 16 ) ^ 67 )
243          .chr( ( $n >> 8 & 255 ) ^ 67 )
244          .chr( ( $n & 255 ) ^ 67 );
245         @s = @s[ 4 .. $#s ];
246     }
247     $r = substr( $r, 0, length($r) - $l );
248     return $r;
249 }
250
251 =head2 transferbook
252
253   ($dotransfer, $messages, $iteminformation) = &transferbook({
254                                                    from_branch => $frombranch
255                                                    to_branch => $tobranch,
256                                                    barcode => $barcode,
257                                                    ignore_reserves => $ignore_reserves,
258                                                    trigger => $trigger
259                                                 });
260
261 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
262
263 C<$fbr> is the code for the branch initiating the transfer.
264 C<$tbr> is the code for the branch to which the item should be transferred.
265
266 C<$barcode> is the barcode of the item to be transferred.
267
268 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
269 Otherwise, if an item is reserved, the transfer fails.
270
271 C<$trigger> is the enum value for what triggered the transfer.
272
273 Returns three values:
274
275 =over
276
277 =item $dotransfer 
278
279 is true if the transfer was successful.
280
281 =item $messages
282
283 is a reference-to-hash which may have any of the following keys:
284
285 =over
286
287 =item C<BadBarcode>
288
289 There is no item in the catalog with the given barcode. The value is C<$barcode>.
290
291 =item C<DestinationEqualsHolding>
292
293 The item is already at the branch to which it is being transferred. The transfer is nonetheless considered to have failed. The value should be ignored.
294
295 =item C<WasReturned>
296
297 The item was on loan, and C<&transferbook> automatically returned it before transferring it. The value is the borrower number of the patron who had the item.
298
299 =item C<ResFound>
300
301 The item was reserved. The value is a reference-to-hash whose keys are fields from the reserves table of the Koha database, and C<biblioitemnumber>. It also has the key C<ResFound>, whose value is either C<Waiting> or C<Reserved>.
302
303 =item C<WasTransferred>
304
305 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
306
307 =item C<RecallPlacedAtHoldingBranch>
308
309 A recall for this item was found, and the transfer has already been completed as the item's branch matches the recall's pickup branch.
310
311 =item C<RecallFound>
312
313 A recall for this item was found, and the item needs to be transferred to the recall's pickup branch.
314
315 =back
316
317 =back
318
319 =cut
320
321 sub transferbook {
322     my $params = shift;
323     my $tbr      = $params->{to_branch};
324     my $fbr      = $params->{from_branch};
325     my $ignoreRs = $params->{ignore_reserves};
326     my $barcode  = $params->{barcode};
327     my $trigger  = $params->{trigger};
328     my $messages;
329     my $dotransfer      = 1;
330     my $item = $barcode ? Koha::Items->find( { barcode => $barcode } ) : undef;
331
332     Koha::Exceptions::MissingParameter->throw(
333         "Missing mandatory parameter: from_branch")
334       unless $fbr;
335
336     Koha::Exceptions::MissingParameter->throw(
337         "Missing mandatory parameter: to_branch")
338       unless $tbr;
339
340     # bad barcode..
341     unless ( $item ) {
342         $messages->{'BadBarcode'} = $barcode;
343         $dotransfer = 0;
344         return ( $dotransfer, $messages );
345     }
346
347     my $itemnumber = $item->itemnumber;
348     # get branches of book...
349     my $hbr = $item->homebranch;
350
351     # if using Branch Transfer Limits
352     if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
353         my $code = C4::Context->preference("BranchTransferLimitsType") eq 'ccode' ? $item->ccode : $item->biblio->biblioitem->itemtype; # BranchTransferLimitsType is 'ccode' or 'itemtype'
354         if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
355             if ( ! IsBranchTransferAllowed( $tbr, $fbr, $item->itype ) ) {
356                 $messages->{'NotAllowed'} = $tbr . "::" . $item->itype;
357                 $dotransfer = 0;
358             }
359         } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $code ) ) {
360             $messages->{'NotAllowed'} = $tbr . "::" . $code;
361             $dotransfer = 0;
362         }
363     }
364
365     # can't transfer book if is already there....
366     if ( $fbr eq $tbr ) {
367         $messages->{'DestinationEqualsHolding'} = 1;
368         $dotransfer = 0;
369     }
370
371     # check if it is still issued to someone, return it...
372     my $issue = $item->checkout;
373     if ( $issue ) {
374         AddReturn( $barcode, $fbr );
375         $messages->{'WasReturned'} = $issue->borrowernumber;
376     }
377
378     # find reserves.....
379     # That'll save a database query.
380     my ( $resfound, $resrec, undef ) =
381       CheckReserves( $item );
382     if ( $resfound ) {
383         $resrec->{'ResFound'} = $resfound;
384         $messages->{'ResFound'} = $resrec;
385         $dotransfer = 0 unless $ignoreRs;
386     }
387
388     # find recall
389     if ( C4::Context->preference('UseRecalls') ) {
390         my $recall = Koha::Recalls->find({ item_id => $itemnumber, status => 'in_transit' });
391         if ( defined $recall ) {
392             # do a transfer if the recall branch is different to the item holding branch
393             if ( $recall->pickup_library_id eq $fbr ) {
394                 $dotransfer = 0;
395                 $messages->{'RecallPlacedAtHoldingBranch'} = 1;
396             } else {
397                 $dotransfer = 1;
398                 $messages->{'RecallFound'} = $recall;
399             }
400         }
401     }
402
403     #actually do the transfer....
404     if ($dotransfer) {
405         ModItemTransfer( $itemnumber, $fbr, $tbr, $trigger );
406
407         # don't need to update MARC anymore, we do it in batch now
408         $messages->{'WasTransfered'} = $tbr;
409
410     }
411     ModDateLastSeen( $itemnumber );
412     return ( $dotransfer, $messages );
413 }
414
415
416 sub TooMany {
417     my ($patron, $item, $params) = @_;
418     my $onsite_checkout = $params->{onsite_checkout} || 0;
419     my $switch_onsite_checkout = $params->{switch_onsite_checkout} || 0;
420     my $cat_borrower    = $patron->categorycode;
421     my $dbh             = C4::Context->dbh;
422     # Get which branchcode we need
423     my $branch = _GetCircControlBranch($item, $patron);
424     my $type = $item->effective_itemtype;
425
426     my ($type_object, $parent_type, $parent_maxissueqty_rule);
427     $type_object = Koha::ItemTypes->find( $type );
428     $parent_type = $type_object->parent_type if $type_object;
429     my $child_types = Koha::ItemTypes->search({ parent_type => $type });
430     # Find any children if we are a parent_type;
431
432     # given branch, patron category, and item type, determine
433     # applicable issuing rule
434
435     $parent_maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
436         {
437             categorycode => $cat_borrower,
438             itemtype     => $parent_type,
439             branchcode   => $branch,
440             rule_name    => 'maxissueqty',
441         }
442     ) if $parent_type;
443     # If the parent rule is for default type we discount it
444     $parent_maxissueqty_rule = undef if $parent_maxissueqty_rule && !defined $parent_maxissueqty_rule->itemtype;
445
446     my $maxissueqty_rule = Koha::CirculationRules->get_effective_rule(
447         {
448             categorycode => $cat_borrower,
449             itemtype     => $type,
450             branchcode   => $branch,
451             rule_name    => 'maxissueqty',
452         }
453     );
454
455     my $maxonsiteissueqty_rule = Koha::CirculationRules->get_effective_rule(
456         {
457             categorycode => $cat_borrower,
458             itemtype     => $type,
459             branchcode   => $branch,
460             rule_name    => 'maxonsiteissueqty',
461         }
462     );
463
464     # if a rule is found and has a loan limit set, count
465     # how many loans the patron already has that meet that
466     # rule
467     if (defined($maxissueqty_rule) and $maxissueqty_rule->rule_value ne "") {
468
469         my $checkouts;
470         if ( $maxissueqty_rule->branchcode ) {
471             if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
472                 $checkouts = $patron->checkouts->search(
473                     { 'me.branchcode' => $maxissueqty_rule->branchcode } );
474             } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
475                 $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
476             } else {
477                 my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
478                 $checkouts = $patron->checkouts->search(
479                     { "item.$branch_type" => $maxissueqty_rule->branchcode } );
480             }
481         } else {
482             $checkouts = $patron->checkouts; # if rule is not branch specific then count all loans by patron
483         }
484         $checkouts = $checkouts->search(undef, { prefetch => 'item' });
485
486         my $sum_checkouts;
487         my $rule_itemtype = $maxissueqty_rule->itemtype;
488
489         my @types;
490         unless ( $rule_itemtype ) {
491             # matching rule has the default item type, so count only
492             # those existing loans that don't fall under a more
493             # specific rule
494             @types = Koha::CirculationRules->search(
495                 {
496                     branchcode => $maxissueqty_rule->branchcode,
497                     categorycode => [ $maxissueqty_rule->categorycode, $cat_borrower ],
498                     itemtype  => { '!=' => undef },
499                     rule_name => 'maxissueqty'
500                 }
501             )->get_column('itemtype');
502         } else {
503             if ( $parent_maxissueqty_rule ) {
504                 # if we have a parent item type then we count loans of the
505                 # specific item type or its siblings or parent
506                 my $children = Koha::ItemTypes->search({ parent_type => $parent_type });
507                 @types = $children->get_column('itemtype');
508                 push @types, $parent_type;
509             } elsif ( $child_types ) {
510                 # If we are a parent type, we need to count all child types and our own type
511                 @types = $child_types->get_column('itemtype');
512                 push @types, $type; # And don't forget to count our own types
513             } else {
514                 # Otherwise only count the specific itemtype
515                 push @types, $type;
516             }
517         }
518
519         while ( my $c = $checkouts->next ) {
520             my $itemtype = $c->item->effective_itemtype;
521
522             unless ( $rule_itemtype ) {
523                 next if grep {$_ eq $itemtype} @types;
524             } else {
525                 next unless grep {$_ eq $itemtype} @types;
526             }
527
528             $sum_checkouts->{total}++;
529             $sum_checkouts->{onsite_checkouts}++ if $c->onsite_checkout;
530             $sum_checkouts->{itemtype}->{$itemtype}++;
531         }
532
533         my $checkout_count_type = $sum_checkouts->{itemtype}->{$type} || 0;
534         my $checkout_count = $sum_checkouts->{total} || 0;
535         my $onsite_checkout_count = $sum_checkouts->{onsite_checkouts} || 0;
536
537         my $checkout_rules = {
538             checkout_count               => $checkout_count,
539             onsite_checkout_count        => $onsite_checkout_count,
540             onsite_checkout              => $onsite_checkout,
541             max_checkouts_allowed        => $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef,
542             max_onsite_checkouts_allowed => $maxonsiteissueqty_rule ? $maxonsiteissueqty_rule->rule_value : undef,
543             switch_onsite_checkout       => $switch_onsite_checkout,
544             circulation_rule             => $maxissueqty_rule,
545             onsite_circulation_rule      => $maxonsiteissueqty_rule,
546         };
547         # If parent rules exists
548         if ( defined($parent_maxissueqty_rule) and defined($parent_maxissueqty_rule->rule_value) ){
549             $checkout_rules->{max_checkouts_allowed} = $parent_maxissueqty_rule ? $parent_maxissueqty_rule->rule_value : undef;
550             my $qty_over = _check_max_qty($checkout_rules);
551             return $qty_over if defined $qty_over;
552
553             # If the parent rule is less than or equal to the child, we only need check the parent
554             if( $maxissueqty_rule->rule_value < $parent_maxissueqty_rule->rule_value && defined($maxissueqty_rule->itemtype) ) {
555                 $checkout_rules->{checkout_count} = $checkout_count_type;
556                 $checkout_rules->{max_checkouts_allowed} = $maxissueqty_rule ? $maxissueqty_rule->rule_value : undef;
557                 my $qty_over = _check_max_qty($checkout_rules);
558                 return $qty_over if defined $qty_over;
559             }
560         } else {
561             my $qty_over = _check_max_qty($checkout_rules);
562             return $qty_over if defined $qty_over;
563         }
564     }
565
566     # Now count total loans against the limit for the branch
567     my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
568     if (defined($branch_borrower_circ_rule->{patron_maxissueqty}) and $branch_borrower_circ_rule->{patron_maxissueqty} ne '') {
569         my $checkouts;
570         if ( C4::Context->preference('CircControl') eq 'PickupLibrary' ) {
571             $checkouts = $patron->checkouts->search(
572                 { 'me.branchcode' => $branch} );
573         } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
574             $checkouts = $patron->checkouts; # if branch is the patron's home branch, then count all loans by patron
575         } else {
576             my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
577             $checkouts = $patron->checkouts->search(
578                 { "item.$branch_type" => $branch},
579                 { prefetch            => 'item' } );
580         }
581
582         my $checkout_count = $checkouts->count;
583         my $onsite_checkout_count = $checkouts->search({ onsite_checkout => 1 })->count;
584         my $max_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxissueqty};
585         my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{patron_maxonsiteissueqty} || undef;
586
587         my $qty_over = _check_max_qty(
588             {
589                 checkout_count               => $checkout_count,
590                 onsite_checkout_count        => $onsite_checkout_count,
591                 onsite_checkout              => $onsite_checkout,
592                 max_checkouts_allowed        => $max_checkouts_allowed,
593                 max_onsite_checkouts_allowed => $max_onsite_checkouts_allowed,
594                 switch_onsite_checkout       => $switch_onsite_checkout,
595                 circulation_rule             => $branch_borrower_circ_rule,
596             }
597         );
598         return $qty_over if defined $qty_over;
599     }
600
601     if ( not defined( $maxissueqty_rule ) and not defined($branch_borrower_circ_rule->{patron_maxissueqty}) ) {
602         return { reason => 'NO_RULE_DEFINED', max_allowed => 0 };
603     }
604
605     # OK, the patron can issue !!!
606     return;
607 }
608
609 sub _check_max_qty {
610     my $params                       = shift;
611     my $checkout_count               = $params->{checkout_count};
612     my $onsite_checkout_count        = $params->{onsite_checkout_count};
613     my $onsite_checkout              = $params->{onsite_checkout};
614     my $max_checkouts_allowed        = $params->{max_checkouts_allowed};
615     my $max_onsite_checkouts_allowed = $params->{max_onsite_checkouts_allowed};
616     my $switch_onsite_checkout       = $params->{switch_onsite_checkout};
617     my $circulation_rule             = $params->{circulation_rule};
618     my $onsite_circulation_rule      = $params->{onsite_circulation_rule};
619
620     if ( $onsite_checkout and defined $max_onsite_checkouts_allowed ) {
621         if ( $max_onsite_checkouts_allowed eq '' ) { return; }
622         if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
623             return {
624                 reason           => 'TOO_MANY_ONSITE_CHECKOUTS',
625                 count            => $onsite_checkout_count,
626                 max_allowed      => $max_onsite_checkouts_allowed,
627                 circulation_rule => $onsite_circulation_rule,
628             };
629         }
630     }
631     if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
632         if ( $max_checkouts_allowed eq '' ) { return; }
633         my $delta = $switch_onsite_checkout ? 1 : 0;
634         if ( $checkout_count >= $max_checkouts_allowed + $delta ) {
635             return {
636                 reason           => 'TOO_MANY_CHECKOUTS',
637                 count            => $checkout_count,
638                 max_allowed      => $max_checkouts_allowed,
639                 circulation_rule => $circulation_rule,
640             };
641         }
642     }
643     elsif ( not $onsite_checkout ) {
644         if ( $max_checkouts_allowed eq '' ) { return; }
645         if (
646             $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed )
647         {
648             return {
649                 reason           => 'TOO_MANY_CHECKOUTS',
650                 count            => $checkout_count - $onsite_checkout_count,
651                 max_allowed      => $max_checkouts_allowed,
652                 circulation_rule => $circulation_rule,
653             };
654         }
655     }
656
657     return;
658 }
659
660 =head2 CanBookBeIssued
661
662   ( $issuingimpossible, $needsconfirmation, [ $alerts ] ) =  CanBookBeIssued( $patron,
663                       $barcode, $duedate, $inprocess, $ignore_reserves, $params );
664
665 Check if a book can be issued.
666
667 C<$issuingimpossible> and C<$needsconfirmation> are hashrefs.
668
669 IMPORTANT: The assumption by users of this routine is that causes blocking
670 the issue are keyed by uppercase labels and other returned
671 data is keyed in lower case!
672
673 =over 4
674
675 =item C<$patron> is a Koha::Patron
676
677 =item C<$barcode> is the bar code of the book being issued.
678
679 =item C<$duedates> is a DateTime object.
680
681 =item C<$inprocess> boolean switch
682
683 =item C<$ignore_reserves> boolean switch
684
685 =item C<$params> Hashref of additional parameters
686
687 Available keys:
688     override_high_holds - Ignore high holds
689     onsite_checkout     - Checkout is an onsite checkout that will not leave the library
690     item                - Optionally pass the object for the item we are checking out to save a lookup
691
692 =back
693
694 Returns :
695
696 =over 4
697
698 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
699 Possible values are :
700
701 =back
702
703 =head3 INVALID_DATE 
704
705 sticky due date is invalid
706
707 =head3 GNA
708
709 borrower gone with no address
710
711 =head3 CARD_LOST
712
713 borrower declared it's card lost
714
715 =head3 DEBARRED
716
717 borrower debarred
718
719 =head3 UNKNOWN_BARCODE
720
721 barcode unknown
722
723 =head3 NOT_FOR_LOAN
724
725 item is not for loan
726
727 =head3 WTHDRAWN
728
729 item withdrawn.
730
731 =head3 RESTRICTED
732
733 item is restricted (set by ??)
734
735 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan 
736 could be prevented, but ones that can be overriden by the operator.
737
738 Possible values are :
739
740 =head3 DEBT
741
742 borrower has debts.
743
744 =head3 RENEW_ISSUE
745
746 renewing, not issuing
747
748 =head3 ISSUED_TO_ANOTHER
749
750 issued to someone else.
751
752 =head3 RESERVED
753
754 reserved for someone else.
755
756 =head3 TRANSFERRED
757
758 reserved and being transferred for someone else.
759
760 =head3 INVALID_DATE
761
762 sticky due date is invalid or due date in the past
763
764 =head3 TOO_MANY
765
766 if the borrower borrows to much things
767
768 =head3 RECALLED
769
770 recalled by someone else
771
772 =cut
773
774 sub CanBookBeIssued {
775     my ( $patron, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
776     my %needsconfirmation;    # filled with problems that needs confirmations
777     my %issuingimpossible;    # filled with problems that causes the issue to be IMPOSSIBLE
778     my %alerts;               # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
779     my %messages;             # filled with information messages that should be displayed.
780
781     my $onsite_checkout     = $params->{onsite_checkout}     || 0;
782     my $override_high_holds = $params->{override_high_holds} || 0;
783
784     my $item_object = $params->{item}
785       // Koha::Items->find( { barcode => $barcode } );
786
787     # MANDATORY CHECKS - unless item exists, nothing else matters
788     unless ( $item_object ) {
789         $issuingimpossible{UNKNOWN_BARCODE} = 1;
790     }
791     return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
792
793     my $item_unblessed = $item_object->unblessed; # Transition...
794     my $issue = $item_object->checkout;
795     my $biblio = $item_object->biblio;
796
797     my $biblioitem = $biblio->biblioitem;
798     my $effective_itemtype = $item_object->effective_itemtype;
799     my $dbh             = C4::Context->dbh;
800     my $patron_unblessed = $patron->unblessed;
801
802     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
803
804     my $now = dt_from_string();
805     $duedate ||= CalcDateDue( $now, $effective_itemtype, $circ_library->branchcode, $patron );
806     if (DateTime->compare($duedate,$now) == -1 ) { # duedate cannot be before now
807          $needsconfirmation{INVALID_DATE} = $duedate;
808     }
809
810     my $fees = Koha::Charges::Fees->new(
811         {
812             patron    => $patron,
813             library   => $circ_library,
814             item      => $item_object,
815             to_date   => $duedate,
816         }
817     );
818
819     #
820     # BORROWER STATUS
821     #
822     if ( $patron->category->category_type eq 'X' && ( $item_object->barcode ) ) {
823
824         # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1  .
825         C4::Stats::UpdateStats(
826             {
827                 branch         => C4::Context->userenv->{'branch'},
828                 type           => 'localuse',
829                 itemnumber     => $item_object->itemnumber,
830                 itemtype       => $effective_itemtype,
831                 borrowernumber => $patron->borrowernumber,
832                 ccode          => $item_object->ccode,
833                 categorycode   => $patron->categorycode,
834                 location       => $item_object->location,
835                 interface      => C4::Context->interface,
836             }
837         );
838         my $block_lost_return = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
839         ModDateLastSeen( $item_object->itemnumber, $block_lost_return );    # FIXME Move to Koha::Item
840         return ( { STATS => 1, }, {} );
841     }
842
843     if ( $patron->gonenoaddress && $patron->gonenoaddress == 1 ) {
844         $issuingimpossible{GNA} = 1;
845     }
846
847     if ( $patron->lost && $patron->lost == 1 ) {
848         $issuingimpossible{CARD_LOST} = 1;
849     }
850     if ( $patron->is_debarred ) {
851         $issuingimpossible{DEBARRED} = 1;
852     }
853
854     if ( $patron->is_expired ) {
855         $issuingimpossible{EXPIRED} = 1;
856     }
857
858     #
859     # BORROWER STATUS
860     #
861
862     # DEBTS
863     my $account = $patron->account;
864     my $balance = $account->balance;
865     my $non_issues_charges = $account->non_issues_charges;
866     my $other_charges = $balance - $non_issues_charges;
867
868     my $amountlimit = C4::Context->preference("noissuescharge");
869     my $allowfineoverride = C4::Context->preference("AllowFineOverride");
870     my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
871
872     # Check the debt of this patrons guarantees
873     my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
874     $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
875     if ( defined $no_issues_charge_guarantees ) {
876         my @guarantees = map { $_->guarantee } $patron->guarantee_relationships->as_list;
877         my $guarantees_non_issues_charges = 0;
878         foreach my $g ( @guarantees ) {
879             $guarantees_non_issues_charges += $g->account->non_issues_charges;
880         }
881
882         if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
883             $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
884         } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
885             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
886         } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
887             $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
888         }
889     }
890
891     # Check the debt of this patrons guarantors *and* the guarantees of those guarantors
892     my $no_issues_charge_guarantors = C4::Context->preference("NoIssuesChargeGuarantorsWithGuarantees");
893     $no_issues_charge_guarantors = undef unless looks_like_number( $no_issues_charge_guarantors );
894     if ( defined $no_issues_charge_guarantors ) {
895         my $guarantors_non_issues_charges = $patron->relationships_debt({ include_guarantors => 1, only_this_guarantor => 0, include_this_patron => 1 });
896
897         if ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && !$allowfineoverride) {
898             $issuingimpossible{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
899         } elsif ( $guarantors_non_issues_charges > $no_issues_charge_guarantors && !$inprocess && $allowfineoverride) {
900             $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
901         } elsif ( $allfinesneedoverride && $guarantors_non_issues_charges > 0 && $guarantors_non_issues_charges <= $no_issues_charge_guarantors && !$inprocess ) {
902             $needsconfirmation{DEBT_GUARANTORS} = $guarantors_non_issues_charges;
903         }
904     }
905
906     if ( C4::Context->preference("IssuingInProcess") ) {
907         if ( $non_issues_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
908             $issuingimpossible{DEBT} = $non_issues_charges;
909         } elsif ( $non_issues_charges > $amountlimit && !$inprocess && $allowfineoverride) {
910             $needsconfirmation{DEBT} = $non_issues_charges;
911         } elsif ( $allfinesneedoverride && $non_issues_charges > 0 && $non_issues_charges <= $amountlimit && !$inprocess ) {
912             $needsconfirmation{DEBT} = $non_issues_charges;
913         }
914     }
915     else {
916         if ( $non_issues_charges > $amountlimit && $allowfineoverride ) {
917             $needsconfirmation{DEBT} = $non_issues_charges;
918         } elsif ( $non_issues_charges > $amountlimit && !$allowfineoverride) {
919             $issuingimpossible{DEBT} = $non_issues_charges;
920         } elsif ( $non_issues_charges > 0 && $allfinesneedoverride ) {
921             $needsconfirmation{DEBT} = $non_issues_charges;
922         }
923     }
924
925     if ($balance > 0 && $other_charges > 0) {
926         $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
927     }
928
929     $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
930     $patron_unblessed = $patron->unblessed;
931
932     if ( my $debarred_date = $patron->is_debarred ) {
933          # patron has accrued fine days or has a restriction. $count is a date
934         if ($debarred_date eq '9999-12-31') {
935             $issuingimpossible{USERBLOCKEDNOENDDATE} = $debarred_date;
936         }
937         else {
938             $issuingimpossible{USERBLOCKEDWITHENDDATE} = $debarred_date;
939         }
940     } elsif ( my $num_overdues = $patron->has_overdues ) {
941         ## patron has outstanding overdue loans
942         if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
943             $issuingimpossible{USERBLOCKEDOVERDUE} = $num_overdues;
944         }
945         elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
946             $needsconfirmation{USERBLOCKEDOVERDUE} = $num_overdues;
947         }
948     }
949
950     # Additional Materials Check
951     if ( C4::Context->preference("CircConfirmItemParts")
952         && $item_object->materials )
953     {
954         $needsconfirmation{ADDITIONAL_MATERIALS} = $item_object->materials;
955     }
956
957     #
958     # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
959     #
960     if ( $issue && $issue->borrowernumber eq $patron->borrowernumber ){
961
962         # Already issued to current borrower.
963         # If it is an on-site checkout if it can be switched to a normal checkout
964         # or ask whether the loan should be renewed
965
966         if ( $issue->onsite_checkout
967                 and C4::Context->preference('SwitchOnSiteCheckouts') ) {
968             $messages{ONSITE_CHECKOUT_WILL_BE_SWITCHED} = 1;
969         } else {
970             my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed($patron, $issue);
971             if ( $CanBookBeRenewed == 0 ) {    # no more renewals allowed
972                 if ( $renewerror eq 'onsite_checkout' ) {
973                     $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
974                 }
975                 else {
976                     $issuingimpossible{NO_MORE_RENEWALS} = 1;
977                 }
978             }
979             else {
980                 $needsconfirmation{RENEW_ISSUE} = 1;
981             }
982         }
983     }
984     elsif ( $issue ) {
985
986         # issued to someone else
987
988         my $patron = Koha::Patrons->find( $issue->borrowernumber );
989
990         my ( $can_be_returned, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
991
992         if ( !$can_be_returned ) {
993             $issuingimpossible{RETURN_IMPOSSIBLE} = 1;
994             $issuingimpossible{branch_to_return} = $message;
995         } else {
996             if ( C4::Context->preference('AutoReturnCheckedOutItems') ) {
997                 $alerts{RETURNED_FROM_ANOTHER} = { patron => $patron };
998             }
999             else {
1000                 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
1001                 $needsconfirmation{issued_firstname} = $patron->firstname;
1002                 $needsconfirmation{issued_surname} = $patron->surname;
1003                 $needsconfirmation{issued_cardnumber} = $patron->cardnumber;
1004                 $needsconfirmation{issued_borrowernumber} = $patron->borrowernumber;
1005             }
1006         }
1007     }
1008
1009     # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
1010     #
1011     my $switch_onsite_checkout = (
1012           C4::Context->preference('SwitchOnSiteCheckouts')
1013       and $issue
1014       and $issue->onsite_checkout
1015       and $issue->borrowernumber == $patron->borrowernumber ? 1 : 0 );
1016     my $toomany = TooMany( $patron, $item_object, { onsite_checkout => $onsite_checkout, switch_onsite_checkout => $switch_onsite_checkout, } );
1017     # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
1018     if ( $toomany && not exists $needsconfirmation{RENEW_ISSUE} ) {
1019         if ( $toomany->{max_allowed} == 0 ) {
1020             $needsconfirmation{PATRON_CANT}                  = 1;
1021             $needsconfirmation{circulation_rule_PATRON_CANT} = $toomany->{circulation_rule};
1022         }
1023         if ( C4::Context->preference("AllowTooManyOverride") ) {
1024             $needsconfirmation{TOO_MANY}                  = $toomany->{reason};
1025             $needsconfirmation{current_loan_count}        = $toomany->{count};
1026             $needsconfirmation{max_loans_allowed}         = $toomany->{max_allowed};
1027             $needsconfirmation{circulation_rule_TOO_MANY} = $toomany->{circulation_rule};
1028         } else {
1029             $issuingimpossible{TOO_MANY}                  = $toomany->{reason};
1030             $issuingimpossible{current_loan_count}        = $toomany->{count};
1031             $issuingimpossible{max_loans_allowed}         = $toomany->{max_allowed};
1032             $needsconfirmation{circulation_rule_TOO_MANY} = $toomany->{circulation_rule};
1033         }
1034     }
1035
1036     #
1037     # CHECKPREVCHECKOUT: CHECK IF ITEM HAS EVER BEEN LENT TO PATRON
1038     #
1039     $patron = Koha::Patrons->find( $patron->borrowernumber ); # FIXME Refetch just in case, to avoid regressions. But must not be needed
1040     if ( $patron->wants_check_for_previous_checkout && $patron->do_check_for_previous_checkout($item_unblessed) ) {
1041         $needsconfirmation{PREVISSUE} = 1;
1042     }
1043
1044     #
1045     # ITEM CHECKING
1046     #
1047     if ( $item_object->notforloan )
1048     {
1049         if(!C4::Context->preference("AllowNotForLoanOverride")){
1050             $issuingimpossible{NOT_FOR_LOAN} = 1;
1051             $issuingimpossible{item_notforloan} = $item_object->notforloan;
1052         }else{
1053             $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1054             $needsconfirmation{item_notforloan} = $item_object->notforloan;
1055         }
1056     }
1057     else {
1058         # we have to check itemtypes.notforloan also
1059         if (C4::Context->preference('item-level_itypes')){
1060             # this should probably be a subroutine
1061             my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
1062             $sth->execute($effective_itemtype);
1063             my $notforloan=$sth->fetchrow_hashref();
1064             if ($notforloan->{'notforloan'}) {
1065                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1066                     $issuingimpossible{NOT_FOR_LOAN} = 1;
1067                     $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1068                 } else {
1069                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1070                     $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1071                 }
1072             }
1073         }
1074         else {
1075             my $itemtype = Koha::ItemTypes->find($biblioitem->itemtype);
1076             if ( $itemtype && defined $itemtype->notforloan && $itemtype->notforloan == 1){
1077                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
1078                     $issuingimpossible{NOT_FOR_LOAN} = 1;
1079                     $issuingimpossible{itemtype_notforloan} = $effective_itemtype;
1080                 } else {
1081                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
1082                     $needsconfirmation{itemtype_notforloan} = $effective_itemtype;
1083                 }
1084             }
1085         }
1086     }
1087     if ( $item_object->withdrawn && $item_object->withdrawn > 0 )
1088     {
1089         $issuingimpossible{WTHDRAWN} = 1;
1090     }
1091     if (   $item_object->restricted
1092         && $item_object->restricted == 1 )
1093     {
1094         $issuingimpossible{RESTRICTED} = 1;
1095     }
1096     if ( $item_object->itemlost && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
1097         my $av = Koha::AuthorisedValues->search({ category => 'LOST', authorised_value => $item_object->itemlost });
1098         my $code = $av->count ? $av->next->lib : '';
1099         $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
1100         $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
1101     }
1102     if ( C4::Context->preference("IndependentBranches") ) {
1103         my $userenv = C4::Context->userenv;
1104         unless ( C4::Context->IsSuperLibrarian() ) {
1105             my $HomeOrHoldingBranch = C4::Context->preference("HomeOrHoldingBranch");
1106             if ( $item_object->$HomeOrHoldingBranch ne $userenv->{branch} ){
1107                 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
1108                 $issuingimpossible{'itemhomebranch'} = $item_object->$HomeOrHoldingBranch;
1109             }
1110             $needsconfirmation{BORRNOTSAMEBRANCH} = $patron->branchcode
1111               if ( $patron->branchcode ne $userenv->{branch} );
1112         }
1113     }
1114
1115     #
1116     # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1117     #
1118     my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1119     if ($rentalConfirmation) {
1120         my ($rentalCharge) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1121
1122         my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1123         if ($itemtype_object) {
1124             my $accumulate_charge = $fees->accumulate_rentalcharge();
1125             if ( $accumulate_charge > 0 ) {
1126                 $rentalCharge += $accumulate_charge;
1127             }
1128         }
1129
1130         if ( $rentalCharge > 0 ) {
1131             $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1132         }
1133     }
1134
1135     my $recall;
1136     # CHECK IF ITEM HAS BEEN RECALLED BY ANOTHER PATRON
1137     # Only bother doing this if UseRecalls is enabled and the item is recallable
1138     # Don't look at recalls that are in transit
1139     if ( C4::Context->preference('UseRecalls') and $item_object->can_be_waiting_recall ) {
1140         my @recalls = $biblio->recalls({},{ order_by => { -asc => 'created_date' } })->filter_by_current->as_list;
1141
1142         foreach my $r ( @recalls ) {
1143             if ( $r->item_id and
1144                 $r->item_id == $item_object->itemnumber and
1145                 $r->patron_id == $patron->borrowernumber and
1146                 ( $r->waiting or $r->requested ) ) {
1147                 $messages{RECALLED} = $r->id;
1148                 $recall = $r;
1149                 # this item is recalled by or already waiting for this borrower and the recall can be fulfilled
1150                 last;
1151             }
1152             elsif ( $r->item_id and
1153                 $r->item_id == $item_object->itemnumber and
1154                 $r->in_transit ) {
1155                 # recalled item is in transit
1156                 $issuingimpossible{RECALLED_INTRANSIT} = $r->pickup_library_id;
1157             }
1158             elsif ( $r->item_level and
1159                 $r->item_id == $item_object->itemnumber and
1160                 $r->patron_id != $patron->borrowernumber and
1161                 !$r->in_transit ) {
1162                 # this specific item has been recalled by a different patron
1163                 $needsconfirmation{RECALLED} = $r;
1164                 $recall = $r;
1165                 last;
1166             }
1167             elsif ( !$r->item_level and
1168                 $r->patron_id != $patron->borrowernumber and
1169                 !$r->in_transit ) {
1170                 # a different patron has placed a biblio-level recall and this item is eligible to fill it
1171                 $needsconfirmation{RECALLED} = $r;
1172                 $recall = $r;
1173                 last;
1174             }
1175         }
1176     }
1177
1178     unless ( $ignore_reserves || $recall ) {
1179         # See if the item is on reserve.
1180         my ( $restype, $res ) = CheckReserves( $item_object );
1181         if ($restype) {
1182             my $resbor = $res->{'borrowernumber'};
1183             if ( $resbor ne $patron->borrowernumber ) {
1184                 my $patron = Koha::Patrons->find( $resbor );
1185                 if ( $restype eq "Waiting" )
1186                 {
1187                     # The item is on reserve and waiting, but has been
1188                     # reserved by some other patron.
1189                     $needsconfirmation{RESERVE_WAITING} = 1;
1190                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1191                     $needsconfirmation{'ressurname'} = $patron->surname;
1192                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1193                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1194                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1195                     $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1196                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1197                 }
1198                 elsif ( $restype eq "Reserved" ) {
1199                     # The item is on reserve for someone else.
1200                     $needsconfirmation{RESERVED} = 1;
1201                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1202                     $needsconfirmation{'ressurname'} = $patron->surname;
1203                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1204                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1205                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1206                     $needsconfirmation{'resreservedate'} = $res->{reservedate};
1207                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1208                 }
1209                 elsif ( $restype eq "Transferred" ) {
1210                     # The item is determined hold being transferred for someone else.
1211                     $needsconfirmation{TRANSFERRED} = 1;
1212                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1213                     $needsconfirmation{'ressurname'} = $patron->surname;
1214                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1215                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1216                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1217                     $needsconfirmation{'resreservedate'} = $res->{reservedate};
1218                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1219                 }
1220                 elsif ( $restype eq "Processing" ) {
1221                     # The item is determined hold being processed for someone else.
1222                     $needsconfirmation{PROCESSING} = 1;
1223                     $needsconfirmation{'resfirstname'} = $patron->firstname;
1224                     $needsconfirmation{'ressurname'} = $patron->surname;
1225                     $needsconfirmation{'rescardnumber'} = $patron->cardnumber;
1226                     $needsconfirmation{'resborrowernumber'} = $patron->borrowernumber;
1227                     $needsconfirmation{'resbranchcode'} = $res->{branchcode};
1228                     $needsconfirmation{'resreservedate'} = $res->{reservedate};
1229                     $needsconfirmation{'reserve_id'} = $res->{reserve_id};
1230                 }
1231             }
1232         }
1233     }
1234
1235     ## CHECK FOR BOOKINGS
1236     if (
1237         my $booking = $item_object->find_booking(
1238             { checkout_date => $now, due_date => $duedate, patron_id => $patron->borrowernumber }
1239         )
1240         )
1241     {
1242         my $booking_start = dt_from_string( $booking->start_date );
1243
1244         # Booked to this patron :)
1245         if ( $booking->patron_id == $patron->borrowernumber ) {
1246             if ( $now < $booking_start ) {
1247                 $needsconfirmation{'BOOKED_EARLY'} = $booking;
1248             } else {
1249                 $alerts{'BOOKED'} = $booking;
1250             }
1251
1252         } else {
1253
1254             # Loan falls inside booking
1255             if ( $now > $booking_start ) {
1256                 $issuingimpossible{'BOOKED_TO_ANOTHER'} = $booking;
1257             }
1258
1259             # Booking starts before due date, reduce loan?
1260             else {
1261                 $needsconfirmation{'BOOKED_TO_ANOTHER'} = $booking;
1262             }
1263         }
1264     }
1265
1266     ## CHECK AGE RESTRICTION
1267     my $agerestriction = $biblioitem->agerestriction;
1268     my ( $restriction_age, $daysToAgeRestriction ) =
1269       GetAgeRestriction( $agerestriction, $patron->unblessed );
1270     if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1271         if ( C4::Context->preference('AgeRestrictionOverride') ) {
1272             $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1273         }
1274         else {
1275             $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1276         }
1277     }
1278
1279     ## check for high holds decreasing loan period
1280     if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1281         my $check = checkHighHolds( $item_object, $patron );
1282
1283         if ( $check->{exceeded} ) {
1284             my $highholds = {
1285                 num_holds  => $check->{outstanding},
1286                 duration   => $check->{duration},
1287                 returndate => $check->{due_date},
1288             };
1289             if ($override_high_holds) {
1290                 $alerts{HIGHHOLDS} = $highholds;
1291             }
1292             else {
1293                 $needsconfirmation{HIGHHOLDS} = $highholds;
1294             }
1295         }
1296     }
1297
1298     if (
1299         !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1300         # don't do the multiple loans per bib check if we've
1301         # already determined that we've got a loan on the same item
1302         !$issuingimpossible{NO_MORE_RENEWALS} &&
1303         !$needsconfirmation{RENEW_ISSUE}
1304     ) {
1305         # Check if borrower has already issued an item from the same biblio
1306         # Only if it's not a subscription
1307         my $biblionumber = $item_object->biblionumber;
1308         require C4::Serials;
1309         my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1310         unless ($is_a_subscription) {
1311             # FIXME Should be $patron->checkouts($args);
1312             my $checkouts = Koha::Checkouts->search(
1313                 {
1314                     borrowernumber => $patron->borrowernumber,
1315                     biblionumber   => $biblionumber,
1316                 },
1317                 {
1318                     join => 'item',
1319                 }
1320             );
1321             # if we get here, we don't already have a loan on this item,
1322             # so if there are any loans on this bib, ask for confirmation
1323             if ( $checkouts->count ) {
1324                 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1325             }
1326         }
1327     }
1328
1329     return ( \%issuingimpossible, \%needsconfirmation, \%alerts, \%messages, );
1330 }
1331
1332 =head2 CanBookBeReturned
1333
1334   ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1335
1336 Check whether the item can be returned to the provided branch
1337
1338 =over 4
1339
1340 =item C<$item> is a hash of item information as returned Koha::Items->find->unblessed (Temporary, should be a Koha::Item instead)
1341
1342 =item C<$branch> is the branchcode where the return is taking place
1343
1344 =back
1345
1346 Returns:
1347
1348 =over 4
1349
1350 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1351
1352 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1353
1354 =back
1355
1356 =cut
1357
1358 sub CanBookBeReturned {
1359   my ($item, $branch) = @_;
1360   my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1361
1362   # assume return is allowed to start
1363   my $allowed = 1;
1364   my $message;
1365
1366   # identify all cases where return is forbidden
1367   if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1368      $allowed = 0;
1369      $message = $item->{'homebranch'};
1370   } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1371      $allowed = 0;
1372      $message = $item->{'holdingbranch'};
1373   } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1374      $allowed = 0;
1375      $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1376   }
1377
1378   return ($allowed, $message);
1379 }
1380
1381 =head2 CheckHighHolds
1382
1383     used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1384     decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1385     has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1386
1387 =cut
1388
1389 sub checkHighHolds {
1390     my ( $item, $patron ) = @_;
1391     my $branchcode = _GetCircControlBranch( $item, $patron );
1392
1393     my $return_data = {
1394         exceeded    => 0,
1395         outstanding => 0,
1396         duration    => 0,
1397         due_date    => undef,
1398     };
1399
1400
1401     # Count holds on this record, ignoring the borrowers own holds as they would be filled by the checkout
1402     my $holds = Koha::Holds->search({
1403         biblionumber => $item->biblionumber,
1404         borrowernumber => { '!=' => $patron->borrowernumber }
1405     });
1406
1407     if ( $holds->count() ) {
1408         $return_data->{outstanding} = $holds->count();
1409
1410         my $decreaseLoanHighHoldsControl        = C4::Context->preference('decreaseLoanHighHoldsControl');
1411         my $decreaseLoanHighHoldsValue          = C4::Context->preference('decreaseLoanHighHoldsValue');
1412         my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1413
1414         my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1415
1416         if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1417
1418             # static means just more than a given number of holds on the record
1419
1420             # If the number of holds is not above the threshold, we can stop here
1421             if ( $holds->count() <= $decreaseLoanHighHoldsValue ) {
1422                 return $return_data;
1423             }
1424         }
1425         elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1426
1427             # dynamic means X more than the number of holdable items on the record
1428
1429             # let's get the items
1430             my @items = $holds->next()->biblio()->items()->as_list;
1431
1432             # Remove any items with status defined to be ignored even if the would not make item unholdable
1433             foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1434                 @items = grep { !$_->$status } @items;
1435             }
1436
1437             # Remove any items that are not holdable for this patron
1438             # We need to ignore hold counts as the borrower's own hold that will be filled by the checkout
1439             # could prevent them from placing further holds
1440             @items = grep { CanItemBeReserved( $patron, $_, undef, { ignore_hold_counts => 1 } )->{status} eq 'OK' } @items;
1441
1442             my $items_count = scalar @items;
1443
1444             my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1445
1446             # If the number of holds is less than the count of items we have
1447             # plus the number of holds allowed above that count, we can stop here
1448             if ( $holds->count() <= $threshold ) {
1449                 return $return_data;
1450             }
1451         }
1452
1453         my $issuedate = dt_from_string();
1454
1455         my $itype = $item->effective_itemtype;
1456         my $daysmode = Koha::CirculationRules->get_effective_daysmode(
1457             {
1458                 categorycode => $patron->categorycode,
1459                 itemtype     => $itype,
1460                 branchcode   => $branchcode,
1461             }
1462         );
1463         my $calendar = Koha::Calendar->new( branchcode => $branchcode, days_mode => $daysmode );
1464
1465         my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1466
1467         my $rule = Koha::CirculationRules->get_effective_rule_value(
1468             {
1469                 categorycode => $patron->categorycode,
1470                 itemtype     => $item->effective_itemtype,
1471                 branchcode   => $branchcode,
1472                 rule_name    => 'decreaseloanholds',
1473             }
1474         );
1475
1476         my $duration;
1477         if ( defined($rule) && $rule ne '' ){
1478             # overrides decreaseLoanHighHoldsDuration syspref
1479             $duration = $rule;
1480         } else {
1481             $duration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1482         }
1483         my $reduced_datedue = $calendar->addDuration( $issuedate, $duration );
1484         $reduced_datedue->set_hour($orig_due->hour);
1485         $reduced_datedue->set_minute($orig_due->minute);
1486         $reduced_datedue->truncate( to => 'minute' );
1487
1488         if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1489             $return_data->{exceeded} = 1;
1490             $return_data->{duration} = $duration;
1491             $return_data->{due_date} = $reduced_datedue;
1492         }
1493     }
1494
1495     return $return_data;
1496 }
1497
1498 =head2 AddIssue
1499
1500   &AddIssue($patron, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1501
1502 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1503
1504 =over 4
1505
1506 =item C<$patron> is a patron object.
1507
1508 =item C<$barcode> is the barcode of the item being issued.
1509
1510 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1511 Calculated if empty.
1512
1513 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1514
1515 =item C<$issuedate> is a DateTime object for the date to issue the item (optional).
1516 Defaults to today.
1517
1518 AddIssue does the following things :
1519
1520   - step 01: check that there is a borrowernumber & a barcode provided
1521   - check for RENEWAL (book issued & being issued to the same patron)
1522       - renewal YES = Calculate Charge & renew
1523       - renewal NO  =
1524           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1525           * RESERVE PLACED ?
1526               - fill reserve if reserve to this patron
1527               - cancel reserve or not, otherwise
1528           * RECALL PLACED ?
1529               - fill recall if recall to this patron
1530               - cancel recall or not
1531               - revert recall's waiting status or not
1532           * TRANSFERT PENDING ?
1533               - complete the transfert
1534           * ISSUE THE BOOK
1535
1536 =back
1537
1538 =cut
1539
1540 sub AddIssue {
1541     my ( $patron, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1542
1543     my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1544     my $switch_onsite_checkout = $params && $params->{switch_onsite_checkout};
1545     my $auto_renew = $params && $params->{auto_renew};
1546     my $cancel_recall = $params && $params->{cancel_recall};
1547     my $recall_id = $params && $params->{recall_id};
1548     my $dbh          = C4::Context->dbh;
1549     my $barcodecheck = CheckValidBarcode($barcode);
1550
1551     my $issue;
1552
1553     if ( $datedue && ref $datedue ne 'DateTime' ) {
1554         $datedue = dt_from_string($datedue);
1555     }
1556
1557     # $issuedate defaults to today.
1558     if ( !defined $issuedate ) {
1559         $issuedate = dt_from_string();
1560     }
1561     else {
1562         if ( ref $issuedate ne 'DateTime' ) {
1563             $issuedate = dt_from_string($issuedate);
1564
1565         }
1566     }
1567
1568     # Stop here if the patron or barcode doesn't exist
1569     if ( $patron && $barcode && $barcodecheck ) {
1570         # find which item we issue
1571         my $item_object = Koha::Items->find({ barcode => $barcode })
1572           or return;    # if we don't get an Item, abort.
1573         my $item_unblessed = $item_object->unblessed;
1574
1575         my $branchcode = _GetCircControlBranch( $item_object, $patron );
1576
1577         # get actual issuing if there is one
1578         my $actualissue = $item_object->checkout;
1579
1580         # check if we just renew the issue.
1581         if ( $actualissue and $actualissue->borrowernumber eq $patron->borrowernumber
1582                 and not $switch_onsite_checkout ) {
1583             $datedue = AddRenewal(
1584                 {
1585                     borrowernumber => $patron->borrowernumber,
1586                     itemnumber     => $item_object->itemnumber,
1587                     branch         => $branchcode,
1588                     datedue        => $datedue,
1589                     lastreneweddate =>
1590                       $issuedate,    # here interpreted as the renewal date
1591                 }
1592             );
1593             $issue = $item_object->checkout;
1594         }
1595         else {
1596
1597             unless ($datedue) {
1598                 my $itype = $item_object->effective_itemtype;
1599                 $datedue = CalcDateDue( $issuedate, $itype, $branchcode, $patron );
1600
1601             }
1602
1603             # Check if we need to use an exact due date set by the ILL module
1604             if ( C4::Context->preference('ILLModule') ) {
1605                 # Check if there is an ILL connected with the biblio of the item we are issuing
1606                 my $ill_request = Koha::Illrequests->search({
1607                     biblio_id => $item_object->biblionumber,
1608                     borrowernumber => $patron->borrowernumber,
1609                     completed => undef,
1610                     due_date => { '!=', undef },
1611                 })->next;
1612
1613                 if ( $ill_request and length( $ill_request->due_date ) > 0 ) {
1614                     my $ill_dt = dt_from_string( $ill_request->due_date );
1615                     $ill_dt->set_hour(23);
1616                     $ill_dt->set_minute(59);
1617                     $datedue = $ill_dt;
1618                 }
1619             }
1620
1621             $datedue->truncate( to => 'minute' );
1622
1623             my $library = Koha::Libraries->find( $branchcode );
1624             my $fees = Koha::Charges::Fees->new(
1625                 {
1626                     patron    => $patron,
1627                     library   => $library,
1628                     item      => $item_object,
1629                     to_date   => $datedue,
1630                 }
1631             );
1632
1633             # it's NOT a renewal
1634             if ( $actualissue and not $switch_onsite_checkout ) {
1635                 # This book is currently on loan, but not to the person
1636                 # who wants to borrow it now. mark it returned before issuing to the new borrower
1637                 my ( $allowed, $message ) = CanBookBeReturned( $item_unblessed, C4::Context->userenv->{branch} );
1638                 return unless $allowed;
1639                 AddReturn( $item_object->barcode, C4::Context->userenv->{'branch'} );
1640                 # AddReturn certainly has side-effects, like onloan => undef
1641                 $item_object->discard_changes;
1642             }
1643
1644             if ( C4::Context->preference('UseRecalls') ) {
1645                 Koha::Recalls->move_recall(
1646                     {
1647                         action         => $cancel_recall,
1648                         recall_id      => $recall_id,
1649                         item           => $item_object,
1650                         borrowernumber => $patron->borrowernumber,
1651                     }
1652                 );
1653             }
1654
1655             C4::Reserves::MoveReserve( $item_object->itemnumber, $patron->borrowernumber, $cancelreserve );
1656
1657             # Starting process for transfer job (checking transfert and validate it if we have one)
1658             if ( my $transfer = $item_object->get_transfer ) {
1659                 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1660                 $transfer->set(
1661                     {
1662                         datearrived => dt_from_string,
1663                         tobranch    => C4::Context->userenv->{branch},
1664                         comments    => 'Forced branchtransfer'
1665                     }
1666                 )->store;
1667                 if ( $transfer->reason && $transfer->reason eq 'Reserve' ) {
1668                     my $hold = $item_object->holds->search( { found => 'T' } )->next;
1669                     if ( $hold ) { # Is this really needed?
1670                         $hold->set( { found => undef } )->store;
1671                         C4::Reserves::ModReserveMinusPriority($item_object->itemnumber, $hold->reserve_id);
1672                     }
1673                 }
1674             }
1675
1676             # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1677             unless ($auto_renew) {
1678                 my $rule = Koha::CirculationRules->get_effective_rule_value(
1679                     {
1680                         categorycode => $patron->categorycode,
1681                         itemtype     => $item_object->effective_itemtype,
1682                         branchcode   => $branchcode,
1683                         rule_name    => 'auto_renew'
1684                     }
1685                 );
1686
1687                 $auto_renew = $rule if defined $rule && $rule ne '';
1688             }
1689
1690             my $issue_attributes = {
1691                 borrowernumber  => $patron->borrowernumber,
1692                 issuedate       => $issuedate,
1693                 date_due        => $datedue,
1694                 branchcode      => C4::Context->userenv->{'branch'},
1695                 onsite_checkout => $onsite_checkout,
1696                 auto_renew      => $auto_renew ? 1 : 0,
1697             };
1698
1699             # Get ID of logged in user.  if called from a batch job,
1700             # no user session exists and C4::Context->userenv() returns
1701             # the scalar '0'. Only do this if the syspref says so
1702             if ( C4::Context->preference('RecordStaffUserOnCheckout') ) {
1703                 my $userenv = C4::Context->userenv();
1704                 my $usernumber = (ref($userenv) eq 'HASH') ? $userenv->{'number'} : undef;
1705                 if ($usernumber) {
1706                     $issue_attributes->{issuer_id} = $usernumber;
1707                 }
1708             }
1709
1710             # In the case that the borrower has an on-site checkout
1711             # and SwitchOnSiteCheckouts is enabled this converts it to a regular checkout
1712             $issue = Koha::Checkouts->find( { itemnumber => $item_object->itemnumber } );
1713             if ($issue) {
1714                 $issue->set($issue_attributes)->store;
1715             }
1716             else {
1717                 $issue = Koha::Checkout->new(
1718                     {
1719                         itemnumber => $item_object->itemnumber,
1720                         %$issue_attributes,
1721                     }
1722                 )->store;
1723
1724                 # Ensure item is no longer listed in the holds queue
1725                 $dbh->do(
1726                     q{DELETE tmp_holdsqueue, hold_fill_targets FROM tmp_holdsqueue LEFT JOIN hold_fill_targets USING ( itemnumber ) WHERE itemnumber = ?},
1727                     undef, $item_object->id
1728                 );
1729             }
1730             $issue->discard_changes;
1731             $patron->update_lastseen('check_out');
1732             if ( $item_object->location && $item_object->location eq 'CART'
1733                 && ( !$item_object->permanent_location || $item_object->permanent_location ne 'CART' ) ) {
1734             ## Item was moved to cart via UpdateItemLocationOnCheckin, anything issued should be taken off the cart.
1735                 CartToShelf( $item_object->itemnumber );
1736             }
1737
1738             # Update item location
1739             $item_object->location_update_trigger( 'checkout' );
1740
1741             if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1742                 UpdateTotalIssues( $item_object->biblionumber, 1, undef, { skip_holds_queue => 1 } );
1743             }
1744
1745             # Record if item was lost
1746             my $was_lost = $item_object->itemlost;
1747
1748             $item_object->issues( ( $item_object->issues || 0 ) + 1);
1749             $item_object->holdingbranch(C4::Context->userenv->{'branch'});
1750             $item_object->itemlost(0);
1751             $item_object->onloan($datedue->ymd());
1752             $item_object->datelastborrowed( dt_from_string()->ymd() );
1753             $item_object->datelastseen( dt_from_string() );
1754             $item_object->store( { log_action => 0, skip_holds_queue => 1 } );
1755
1756             # If the item was lost, it has now been found, charge the overdue if necessary
1757             if ($was_lost) {
1758                 if ( $item_object->{_charge} ) {
1759                     $actualissue //= Koha::Old::Checkouts->search(
1760                         { itemnumber => $item_object->itemnumber },
1761                         {
1762                             order_by => { '-desc' => 'returndate' },
1763                             rows     => 1
1764                         }
1765                     )->single;
1766                     unless ( $patron->branchcode ) {
1767                         $patron = $actualissue->patron;
1768                     }
1769                     _CalculateAndUpdateFine(
1770                         {
1771                             issue       => $actualissue,
1772                             item        => $item_unblessed,
1773                             borrower    => $patron->unblessed,
1774                             return_date => $issuedate
1775                         }
1776                     );
1777                     _FixOverduesOnReturn( $patron->borrowernumber,
1778                         $item_object->itemnumber, undef, 'RENEWED' );
1779                 }
1780             }
1781
1782             # If it costs to borrow this book, charge it to the patron's account.
1783             my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $patron->borrowernumber );
1784             if ( $charge && $charge > 0 ) {
1785                 AddIssuingCharge( $issue, $charge, 'RENT' );
1786             }
1787
1788             my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1789             if ( $itemtype_object ) {
1790                 my $accumulate_charge = $fees->accumulate_rentalcharge();
1791                 if ( $accumulate_charge > 0 ) {
1792                     AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1793                     $charge += $accumulate_charge;
1794                     $item_unblessed->{charge} = $charge;
1795                 }
1796             }
1797
1798             my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckout');
1799             if ($yaml) {
1800                 $yaml = "$yaml\n\n";
1801
1802                 my $rules;
1803                 eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
1804                 if ($@) {
1805                     warn "Unable to parse UpdateNotForLoanStatusOnCheckout syspref : $@";
1806                 }
1807                 else {
1808                     foreach my $key ( keys %$rules ) {
1809                         if ( $item_object->notforloan eq $key ) {
1810                             $item_object->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
1811                             last;
1812                         }
1813                     }
1814                 }
1815             }
1816
1817             # Record the fact that this book was issued.
1818             C4::Stats::UpdateStats(
1819                 {
1820                     branch => C4::Context->userenv->{'branch'},
1821                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1822                     amount         => $charge,
1823                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1824                     itemnumber     => $item_object->itemnumber,
1825                     itemtype       => $item_object->effective_itemtype,
1826                     location       => $item_object->location,
1827                     borrowernumber => $patron->borrowernumber,
1828                     ccode          => $item_object->ccode,
1829                     categorycode   => $patron->categorycode
1830                 }
1831             );
1832
1833             # Send a checkout slip.
1834             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1835             my %conditions        = (
1836                 branchcode   => $branchcode,
1837                 categorycode => $patron->categorycode,
1838                 item_type    => $item_object->effective_itemtype,
1839                 notification => 'CHECKOUT',
1840             );
1841             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1842                 SendCirculationAlert(
1843                     {
1844                         type     => 'CHECKOUT',
1845                         item     => $item_object->unblessed,
1846                         borrower => $patron->unblessed,
1847                         branch   => $branchcode,
1848                     }
1849                 );
1850             }
1851             logaction(
1852                 "CIRCULATION", "ISSUE",
1853                 $patron->borrowernumber,
1854                 $item_object->itemnumber,
1855             ) if C4::Context->preference("IssueLog");
1856
1857             Koha::Plugins->call('after_circ_action', {
1858                 action  => 'checkout',
1859                 payload => {
1860                     type     => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1861                     checkout => $issue->get_from_storage
1862                 }
1863             });
1864
1865             Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
1866                 {
1867                     biblio_ids => [ $item_object->biblionumber ]
1868                 }
1869             ) if C4::Context->preference('RealTimeHoldsQueue');
1870         }
1871     }
1872     return $issue;
1873 }
1874
1875 =head2 GetLoanLength
1876
1877   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1878
1879 Get loan length for an itemtype, a borrower type and a branch
1880
1881 =cut
1882
1883 sub GetLoanLength {
1884     my ( $categorycode, $itemtype, $branchcode ) = @_;
1885
1886     # Initialize default values
1887     my $rules = {
1888         issuelength   => 0,
1889         renewalperiod => 0,
1890         lengthunit    => 'days',
1891     };
1892
1893     my $found = Koha::CirculationRules->get_effective_rules( {
1894         branchcode => $branchcode,
1895         categorycode => $categorycode,
1896         itemtype => $itemtype,
1897         rules => [
1898             'issuelength',
1899             'renewalperiod',
1900             'lengthunit'
1901         ],
1902     } );
1903
1904     # Search for rules!
1905     foreach my $rule_name (keys %$found) {
1906         $rules->{$rule_name} = $found->{$rule_name};
1907     }
1908
1909     return $rules;
1910 }
1911
1912
1913 =head2 GetHardDueDate
1914
1915   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1916
1917 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1918
1919 =cut
1920
1921 sub GetHardDueDate {
1922     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1923
1924     my $rules = Koha::CirculationRules->get_effective_rules(
1925         {
1926             categorycode => $borrowertype,
1927             itemtype     => $itemtype,
1928             branchcode   => $branchcode,
1929             rules        => [ 'hardduedate', 'hardduedatecompare' ],
1930         }
1931     );
1932
1933     if ( defined( $rules->{hardduedate} ) ) {
1934         if ( $rules->{hardduedate} ) {
1935             return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1936         }
1937         else {
1938             return ( undef, undef );
1939         }
1940     }
1941 }
1942
1943 =head2 GetBranchBorrowerCircRule
1944
1945   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1946
1947 Retrieves circulation rule attributes that apply to the given
1948 branch and patron category, regardless of item type.  
1949 The return value is a hashref containing the following key:
1950
1951 patron_maxissueqty - maximum number of loans that a
1952 patron of the given category can have at the given
1953 branch.  If the value is undef, no limit.
1954
1955 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1956 patron of the given category can have at the given
1957 branch.  If the value is undef, no limit.
1958
1959 This will check for different branch/category combinations in the following order:
1960 branch and category
1961 branch only
1962 category only
1963 default branch and category
1964
1965 If no rule has been found in the database, it will default to
1966 the buillt in rule:
1967
1968 patron_maxissueqty - undef
1969 patron_maxonsiteissueqty - undef
1970
1971 C<$branchcode> and C<$categorycode> should contain the
1972 literal branch code and patron category code, respectively - no
1973 wildcards.
1974
1975 =cut
1976
1977 sub GetBranchBorrowerCircRule {
1978     my ( $branchcode, $categorycode ) = @_;
1979
1980     # Initialize default values
1981     my $rules = {
1982         patron_maxissueqty       => undef,
1983         patron_maxonsiteissueqty => undef,
1984     };
1985
1986     # Search for rules!
1987     foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1988         my $rule = Koha::CirculationRules->get_effective_rule(
1989             {
1990                 categorycode => $categorycode,
1991                 itemtype     => undef,
1992                 branchcode   => $branchcode,
1993                 rule_name    => $rule_name,
1994             }
1995         );
1996
1997         $rules->{$rule_name} = $rule->rule_value if defined $rule;
1998     }
1999
2000     return $rules;
2001 }
2002
2003 =head2 GetBranchItemRule
2004
2005   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
2006
2007 Retrieves circulation rule attributes that apply to the given
2008 branch and item type, regardless of patron category.
2009
2010 The return value is a hashref containing the following keys:
2011
2012 holdallowed => Hold policy for this branch and itemtype. Possible values:
2013   not_allowed:           No holds allowed.
2014   from_home_library:     Holds allowed only by patrons that have the same homebranch as the item.
2015   from_any_library:      Holds allowed from any patron.
2016   from_local_hold_group: Holds allowed from libraries in hold group
2017
2018 This searches branchitemrules in the following order:
2019
2020   * Same branchcode and itemtype
2021   * Same branchcode, itemtype '*'
2022   * branchcode '*', same itemtype
2023   * branchcode and itemtype '*'
2024
2025 Neither C<$branchcode> nor C<$itemtype> should be '*'.
2026
2027 =cut
2028
2029 sub GetBranchItemRule {
2030     my ( $branchcode, $itemtype ) = @_;
2031
2032     # Search for rules!
2033     my $rules = Koha::CirculationRules->get_effective_rules({
2034         branchcode => $branchcode,
2035         itemtype => $itemtype,
2036         rules => ['holdallowed', 'hold_fulfillment_policy']
2037     });
2038
2039     # built-in default circulation rule
2040     $rules->{holdallowed} //= 'from_any_library';
2041     $rules->{hold_fulfillment_policy} //= 'any';
2042
2043     return $rules;
2044 }
2045
2046 =head2 AddReturn
2047
2048   ($doreturn, $messages, $iteminformation, $borrower) =
2049       &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] [,$skip_localuse ] );
2050
2051 Returns a book.
2052
2053 =over 4
2054
2055 =item C<$barcode> is the bar code of the book being returned.
2056
2057 =item C<$branch> is the code of the branch where the book is being returned.
2058
2059 =item C<$exemptfine> indicates that overdue charges for the item will be
2060 removed. Optional.
2061
2062 =item C<$return_date> allows the default return date to be overridden
2063 by the given return date. Optional.
2064
2065 =item C<$skip_localuse> indicated that localuse should not be recorded. Optional.
2066
2067 =back
2068
2069 C<&AddReturn> returns a list of four items:
2070
2071 C<$doreturn> is true iff the return succeeded.
2072
2073 C<$messages> is a reference-to-hash giving feedback on the operation.
2074 The keys of the hash are:
2075
2076 =over 4
2077
2078 =item C<BadBarcode>
2079
2080 No item with this barcode exists. The value is C<$barcode>.
2081
2082 =item C<NotIssued>
2083
2084 The book is not currently on loan. The value is C<$barcode>.
2085
2086 =item C<withdrawn>
2087
2088 This book has been withdrawn/cancelled. The value should be ignored.
2089
2090 =item C<Wrongbranch>
2091
2092 This book has was returned to the wrong branch.  The value is a hashref
2093 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
2094 contain the branchcode of the incorrect and correct return library, respectively.
2095
2096 =item C<ResFound>
2097
2098 The item was reserved. The value is a reference-to-hash whose keys are
2099 fields from the reserves table of the Koha database, and
2100 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
2101 either C<Waiting>, C<Reserved>, or 0.
2102
2103 =item C<WasReturned>
2104
2105 Value 1 if return is successful.
2106
2107 =item C<NeedsTransfer>
2108
2109 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
2110
2111 =item C<RecallFound>
2112
2113 This item can fill a recall. The recall object is returned. If the recall pickup branch differs from
2114 the branch this item is being returned at, C<RecallNeedsTransfer> is also returned which contains this
2115 branchcode.
2116
2117 =item C<TransferredRecall>
2118
2119 This item has been transferred to this branch to fill a recall. The recall object is returned.
2120
2121 =back
2122
2123 C<$iteminformation> is a reference-to-hash, giving information about the
2124 returned item from the issues table.
2125
2126 C<$borrower> is a reference-to-hash, giving information about the
2127 patron who last borrowed the book.
2128
2129 =cut
2130
2131 sub AddReturn {
2132     my ( $barcode, $branch, $exemptfine, $return_date, $skip_localuse ) = @_;
2133
2134     if ($branch and not Koha::Libraries->find($branch)) {
2135         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
2136         undef $branch;
2137     }
2138     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
2139     my $return_date_specified = !!$return_date;
2140     $return_date //= dt_from_string();
2141     my $messages;
2142     my $patron;
2143     my $doreturn       = 1;
2144     my $validTransfer = 1;
2145     my $stat_type = 'return';
2146
2147     # get information on item
2148     my $item = Koha::Items->find({ barcode => $barcode });
2149     unless ($item) {
2150         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
2151     }
2152
2153     my $itemnumber = $item->itemnumber;
2154     my $itemtype = $item->effective_itemtype;
2155
2156     my $issue  = $item->checkout;
2157     if ( $issue ) {
2158         $patron = $issue->patron
2159             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
2160                 . Dumper($issue->unblessed) . "\n";
2161     } else {
2162         $messages->{'NotIssued'} = $barcode;
2163         $item->onloan(undef)->store( { skip_record_index => 1, skip_holds_queue => 1 } ) if defined $item->onloan;
2164
2165         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
2166         $doreturn = 0;
2167         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
2168         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
2169         if (C4::Context->preference("RecordLocalUseOnReturn")) {
2170            $messages->{'LocalUse'} = 1;
2171            $stat_type = 'localuse';
2172         }
2173     }
2174
2175     if ( $item->withdrawn ) { # book has been cancelled
2176         $messages->{'withdrawn'} = 1;
2177
2178         # In the case where we block return of withdrawn, we should completely block the return
2179         # without updating item statuses, so we exit early
2180         return ( 0, $messages, $issue, ( $patron ? $patron->unblessed : {} ))
2181             if C4::Context->preference("BlockReturnOfWithdrawnItems");
2182     }
2183
2184
2185     # full item data, but no borrowernumber or checkout info (no issue)
2186     my $hbr = Koha::CirculationRules->get_return_branch_policy($item);
2187
2188     # check if returnbranch and homebranch belong to the same float group
2189     my $validate_float =
2190         Koha::Libraries->find( $item->homebranch )->validate_float_sibling( { branchcode => $branch } );
2191
2192     # get the proper branch to which to return the item
2193     my $returnbranch;
2194     if ( $hbr eq 'noreturn' ) {
2195         $returnbranch = $branch;
2196     } elsif ( $hbr eq 'returnbylibrarygroup' ) {
2197
2198         # if library isn't in same the float group, transfer item to homebranch
2199         $hbr          = 'homebranch';
2200         $returnbranch = $validate_float ? $branch : $item->$hbr;
2201     } else {
2202         $returnbranch = $item->$hbr;
2203     }
2204
2205     # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
2206     my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
2207
2208     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
2209     my $patron_unblessed = $patron ? $patron->unblessed : {};
2210
2211     # Update item location
2212     my $loc_messages = $item->location_update_trigger( 'checkin' );
2213     foreach my $loc_msg_key ( keys %$loc_messages ) {
2214         $messages->{ $loc_msg_key } = $loc_messages->{ $loc_msg_key };
2215     }
2216
2217     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2218     if ($yaml) {
2219         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
2220         my $rules;
2221         eval { $rules = YAML::XS::Load(Encode::encode_utf8($yaml)); };
2222         if ($@) {
2223             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2224         }
2225         else {
2226             if ( defined $rules->{$item->itype} ) {
2227                 foreach my $notloan_rule_key (keys %{ $rules->{$item->itype}} ) {
2228                     if ( $item->notforloan eq $notloan_rule_key ) {
2229                         $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$item->itype}->{$notloan_rule_key} };
2230                         $item->notforloan( $rules->{ $item->itype }->{$notloan_rule_key} )
2231                             ->store( { log_action => 0, skip_record_index => 1, skip_holds_queue => 1 } )
2232                             unless $rules->{ $item->itype }->{$notloan_rule_key} eq 'ONLYMESSAGE';
2233                         last;
2234                     }
2235                 }
2236             } elsif ( defined $rules->{'_ALL_'} ) {
2237                 foreach my $notloan_rule_key (keys %{ $rules->{'_ALL_'}} ) {
2238                     if ( $item->notforloan eq $notloan_rule_key ) {
2239                         $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{'_ALL_'}->{$notloan_rule_key} };
2240                         $item->notforloan( $rules->{'_ALL_'}->{$notloan_rule_key} )
2241                             ->store( { log_action => 0, skip_record_index => 1, skip_holds_queue => 1 } )
2242                             unless $rules->{ '_ALL_' }->{$notloan_rule_key} eq 'ONLYMESSAGE';
2243                         last;
2244                     }
2245                 }
2246             }
2247         }
2248     }
2249
2250     # check if the return is allowed at this branch
2251     my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2252     unless ($returnallowed){
2253         $messages->{'Wrongbranch'} = {
2254             Wrongbranch => $branch,
2255             Rightbranch => $message
2256         };
2257         $doreturn = 0;
2258         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2259         $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2260         return ( $doreturn, $messages, $issue, $patron_unblessed);
2261     }
2262
2263     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2264         $doreturn = 0;
2265     }
2266
2267     # case of a return of document (deal with issues and holdingbranch)
2268     if ($doreturn) {
2269         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2270         $patron or warn "AddReturn without current borrower";
2271
2272         if ($patron) {
2273             eval {
2274                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1, skip_holds_queue => 1} );
2275             };
2276             unless ( $@ ) {
2277                 if (
2278                     (
2279                         C4::Context->preference('CalculateFinesOnReturn')
2280                         || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2281                     )
2282                     && !$item->itemlost
2283                   )
2284                 {
2285                     _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2286                 }
2287             } else {
2288                 carp "The checkin for the following issue failed, Please go to the about page and check all messages on the 'System information' to see if there are configuration / data issues ($@)" . Dumper( $issue->unblessed );
2289
2290                 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2291                 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2292
2293                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2294             }
2295
2296             # FIXME is the "= 1" right?  This could be the borrower hash.
2297             $messages->{'WasReturned'} = 1;
2298
2299         } else {
2300             $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1, skip_holds_queue => 1 });
2301         }
2302     }
2303
2304     # the holdingbranch is updated if the document is returned to another location.
2305     # this is always done regardless of whether the item was on loan or not
2306     if ($item->holdingbranch ne $branch) {
2307         $item->holdingbranch($branch)->store({ log_action => 0, skip_record_index => 1, skip_holds_queue => 1 });
2308     }
2309
2310     my $item_was_lost = $item->itemlost;
2311     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2312     my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1, skip_holds_queue => 1 } ); # will unset itemlost if needed
2313
2314     # fix up the accounts.....
2315     if ($item_was_lost) {
2316         $messages->{'WasLost'} = 1;
2317         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2318             my @object_messages = @{ $updated_item->object_messages };
2319             for my $message (@object_messages) {
2320                 $messages->{'LostItemFeeRefunded'} = 1
2321                   if $message->message eq 'lost_refunded';
2322                 $messages->{'ProcessingFeeRefunded'} = 1
2323                   if $message->message eq 'processing_refunded';
2324                 $messages->{'LostItemFeeRestored'} = 1
2325                   if $message->message eq 'lost_restored';
2326
2327                 if ( $message->message eq 'lost_charge' ) {
2328                     $issue //= Koha::Old::Checkouts->search(
2329                         { itemnumber => $item->itemnumber },
2330                         { order_by   => { '-desc' => 'returndate' }, rows => 1 }
2331                     )->single;
2332                     unless ( exists( $patron_unblessed->{branchcode} ) ) {
2333                         my $patron = $issue->patron;
2334                         $patron_unblessed = $patron->unblessed;
2335                     }
2336                     _CalculateAndUpdateFine(
2337                         {
2338                             issue       => $issue,
2339                             item        => $item->unblessed,
2340                             borrower    => $patron_unblessed,
2341                             return_date => $return_date
2342                         }
2343                     );
2344                     _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2345                         $item->itemnumber, undef, 'RETURNED' );
2346                     $messages->{'LostItemFeeCharged'} = 1;
2347                 }
2348             }
2349         }
2350     }
2351
2352     # check if we have a transfer for this document
2353     my $transfer = $item->get_transfer;
2354
2355     # if we have a transfer to complete, we update the line of transfers with the datearrived
2356     if ($transfer) {
2357         $validTransfer = 0;
2358         if ( $transfer->in_transit ) {
2359             if ( $transfer->tobranch eq $branch ) {
2360                 $transfer->receive;
2361                 $messages->{'TransferArrived'} = $transfer->frombranch;
2362                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2363                 $validTransfer = 1
2364                   if defined $transfer->reason && $transfer->reason eq 'Reserve';
2365             }
2366             else {
2367                 $messages->{'WrongTransfer'}     = $transfer->tobranch;
2368                 $messages->{'WrongTransferItem'} = $item->itemnumber;
2369                 $messages->{'TransferTrigger'}   = $transfer->reason;
2370             }
2371         }
2372         else {
2373             if ( $transfer->tobranch eq $branch ) {
2374                 $transfer->receive;
2375                 $messages->{'TransferArrived'} = $transfer->frombranch;
2376                 # validTransfer=1 allows us returning the item back if the reserve is cancelled
2377                 $validTransfer = 1 if $transfer->reason eq 'Reserve';
2378             }
2379             else {
2380                 $messages->{'TransferTrigger'} = $transfer->reason;
2381                 if ( $transfer->frombranch eq $branch ) {
2382                     $transfer->transit;
2383                     $messages->{'WasTransfered'}   = $transfer->tobranch;
2384                 }
2385                 else {
2386                     $messages->{'WrongTransfer'}     = $transfer->tobranch;
2387                     $messages->{'WrongTransferItem'} = $item->itemnumber;
2388                 }
2389             }
2390         }
2391     }
2392
2393     # fix up the overdues in accounts...
2394     if ($borrowernumber) {
2395         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2396         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!";  # zero is OK, check defined
2397
2398         if ( $issue and $issue->is_overdue($return_date) ) {
2399         # fix fine days
2400             my ($debardate,$reminder) = _debar_user_on_return( $patron, $item, dt_from_string($issue->date_due), $return_date );
2401             if ($debardate and $debardate ne "9999-12-31") {
2402                 if ($reminder){
2403                     $messages->{'PrevDebarred'} = $debardate;
2404                 } else {
2405                     $messages->{'Debarred'} = $debardate;
2406                 }
2407             } elsif ($patron->debarred) {
2408                 if ( $patron->debarred eq "9999-12-31") {
2409                     $messages->{'ForeverDebarred'} = $patron->debarred;
2410                 } else {
2411                     my $borrower_debar_dt = dt_from_string( $patron->debarred );
2412                     $borrower_debar_dt->truncate(to => 'day');
2413                     my $today_dt = $return_date->clone()->truncate(to => 'day');
2414                     if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2415                         $messages->{'PrevDebarred'} = $patron->debarred;
2416                     }
2417                 }
2418             }
2419         # there's no overdue on the item but borrower had been previously debarred
2420         } elsif ( $issue->date_due and $patron->debarred ) {
2421              if ( $patron->debarred eq "9999-12-31") {
2422                 $messages->{'ForeverDebarred'} = $patron->debarred;
2423              } else {
2424                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2425                   $borrower_debar_dt->truncate(to => 'day');
2426                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2427                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2428                       $messages->{'PrevDebarred'} = $patron->debarred;
2429                   }
2430              }
2431         }
2432     }
2433
2434     # find recalls...
2435     if ( C4::Context->preference('UseRecalls') ) {
2436         # check if this item is recallable first, which includes checking if UseRecalls syspref is enabled
2437         my $recall = undef;
2438         $recall = $item->check_recalls if $item->can_be_waiting_recall;
2439         if ( defined $recall ) {
2440             $messages->{RecallFound} = $recall;
2441             if ( $recall->pickup_library_id ne $branch ) {
2442                 $messages->{RecallNeedsTransfer} = $branch;
2443             }
2444         }
2445     }
2446
2447     # find reserves.....
2448     # launch the Checkreserves routine to find any holds
2449     my ($resfound, $resrec);
2450     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2451     ($resfound, $resrec, undef) = CheckReserves( $item, $lookahead ) unless ( $item->withdrawn );
2452     # if a hold is found and is waiting at another branch, change the priority back to 1 and trigger the hold (this will trigger a transfer and update the hold status properly)
2453     if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2454         my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2455         $resfound = 'Reserved';
2456         $resrec = $hold->unblessed;
2457     }
2458     if ($resfound) {
2459           $resrec->{'ResFound'} = $resfound;
2460         $messages->{'ResFound'} = $resrec;
2461     }
2462
2463     # Record the fact that this book was returned.
2464     my $categorycode = $patron_unblessed ? $patron_unblessed->{categorycode} : undef;
2465     C4::Stats::UpdateStats({
2466         branch         => $branch,
2467         type           => $stat_type,
2468         itemnumber     => $itemnumber,
2469         itemtype       => $itemtype,
2470         location       => $item->location,
2471         borrowernumber => $borrowernumber,
2472         ccode          => $item->ccode,
2473         categorycode   => $categorycode,
2474         interface      => C4::Context->interface,
2475     }) unless ( $skip_localuse && $stat_type eq 'localuse' );
2476
2477     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2478     if ( $patron ) {
2479         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2480         my %conditions = (
2481             branchcode   => $branch,
2482             categorycode => $patron->categorycode,
2483             item_type    => $itemtype,
2484             notification => 'CHECKIN',
2485         );
2486         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2487             SendCirculationAlert({
2488                 type     => 'CHECKIN',
2489                 item     => $item->unblessed,
2490                 borrower => $patron->unblessed,
2491                 branch   => $branch,
2492                 issue    => $issue
2493             });
2494         }
2495
2496         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2497             if C4::Context->preference("ReturnLog");
2498
2499         #Update borrowers.lastseen
2500         $patron->update_lastseen('check_in');
2501     }
2502
2503     # Check if this item belongs to a biblio record that is attached to an
2504     # ILL request, if it is we need to update the ILL request's status
2505     if ( $doreturn and C4::Context->preference('CirculateILL')) {
2506         my $request = Koha::Illrequests->find(
2507             { biblio_id => $item->biblio->biblionumber }
2508         );
2509         $request->status('RET') if $request;
2510     }
2511
2512     if ( C4::Context->preference('UseRecalls') ) {
2513         # all recalls that have triggered a transfer will have an allocated itemnumber
2514         my $transfer_recall = Koha::Recalls->find({ item_id => $item->itemnumber, status => 'in_transit' });
2515         if ( $transfer_recall and $transfer_recall->pickup_library_id eq $branch ) {
2516             $messages->{TransferredRecall} = $transfer_recall;
2517         }
2518     }
2519
2520     if ( $messages->{WasLost} and C4::Context->preference('BlockReturnOfLostItems') ) {
2521         $validTransfer = 0;
2522     }
2523
2524     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2525     if ( $validTransfer && !C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber )
2526         && ( $doreturn or $messages->{'NotIssued'} )
2527         and !$resfound
2528         and ( $branch ne $returnbranch )
2529         and not $messages->{'WrongTransfer'}
2530         and not $messages->{'WasTransfered'}
2531         and not $messages->{TransferredRecall}
2532         and not $messages->{RecallNeedsTransfer} )
2533     {
2534         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2535         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2536             (C4::Context->preference("UseBranchTransferLimits") and
2537              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2538            )) {
2539             ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2540             $messages->{'WasTransfered'} = $returnbranch;
2541             $messages->{'TransferTrigger'} = $transfer_trigger;
2542         } else {
2543             $messages->{'NeedsTransfer'} = $returnbranch;
2544             $messages->{'TransferTrigger'} = $transfer_trigger;
2545         }
2546     }
2547
2548     if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2549         my $claims = Koha::Checkouts::ReturnClaims->search(
2550            {
2551                itemnumber => $item->id,
2552                resolution => undef,
2553            }
2554         );
2555
2556         if ( $claims->count ) {
2557             $messages->{ReturnClaims} = $claims;
2558         }
2559     }
2560
2561     # Check for bundle status
2562     if ( $item->in_bundle ) {
2563         my $host = $item->bundle_host;
2564         $messages->{InBundle} = $host;
2565     }
2566
2567     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2568     $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2569
2570     if ( $doreturn and $issue ) {
2571         my $checkin = Koha::Old::Checkouts->find($issue->id);
2572
2573         Koha::Plugins->call('after_circ_action', {
2574             action  => 'checkin',
2575             payload => {
2576                 checkout=> $checkin
2577             }
2578         });
2579
2580         Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue->new->enqueue(
2581             {
2582                 biblio_ids => [ $item->biblionumber ]
2583             }
2584         ) if C4::Context->preference('RealTimeHoldsQueue');
2585     }
2586
2587     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2588 }
2589
2590 =head2 MarkIssueReturned
2591
2592   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2593
2594 Unconditionally marks an issue as being returned by
2595 moving the C<issues> row to C<old_issues> and
2596 setting C<returndate> to the current date.
2597
2598 if C<$returndate> is specified (in iso format), it is used as the date
2599 of the return.
2600
2601 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2602 the old_issue is immediately anonymised
2603
2604 Ideally, this function would be internal to C<C4::Circulation>,
2605 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2606 and offline_circ/process_koc.pl.
2607
2608 The last optional parameter allos passing skip_record_index to the item store call.
2609
2610 =cut
2611
2612 sub MarkIssueReturned {
2613     my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2614
2615     # Retrieve the issue
2616     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2617     my $issue_branchcode = $issue->branchcode;
2618
2619     return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2620
2621     my $issue_id = $issue->issue_id;
2622
2623     my $schema = Koha::Database->schema;
2624
2625     # FIXME Improve the return value and handle it from callers
2626     $schema->txn_do(sub {
2627
2628         my $patron = Koha::Patrons->find( $borrowernumber );
2629
2630         # Update the returndate value
2631         if ( $returndate ) {
2632             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2633         }
2634         else {
2635             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2636         }
2637
2638         # Create the old_issues entry
2639         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2640
2641         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2642         if ( $privacy && $privacy == 2) {
2643             $old_checkout->anonymize;
2644         }
2645
2646         # And finally delete the issue
2647         $issue->delete;
2648
2649         $issue->item->onloan(undef)->store(
2650             {   log_action        => 0,
2651                 skip_record_index => $params->{skip_record_index},
2652                 skip_holds_queue  => $params->{skip_holds_queue}
2653             }
2654         );
2655
2656         if ( C4::Context->preference('StoreLastBorrower') ) {
2657             my $item = Koha::Items->find( $itemnumber );
2658             $item->last_returned_by( $patron->borrowernumber )->store;
2659         }
2660
2661         # Possibly remove any OVERDUES related debarment
2662         my $overdue_restrictions = $patron->restrictions->search( { type => 'OVERDUES' } );
2663         if ( C4::Context->preference('AutoRemoveOverduesRestrictions') ne 'no' && $patron->is_debarred ) {
2664             my $remove_restrictions =
2665                 C4::Context->preference('AutoRemoveOverduesRestrictions') eq 'when_no_overdue_causing_debarment'
2666                 ? !$patron->has_restricting_overdues( { issue_branchcode => $issue_branchcode } )
2667                 : !$patron->has_overdues;
2668             if ( $remove_restrictions && $overdue_restrictions->count ) {
2669                 DelUniqueDebarment( { borrowernumber => $borrowernumber, type => 'OVERDUES' } );
2670             }
2671         }
2672
2673     });
2674
2675     return $issue_id;
2676 }
2677
2678 =head2 _debar_user_on_return
2679
2680     _debar_user_on_return($patron, $item, $datedue, $returndate);
2681
2682 C<$patron> patron object
2683
2684 C<$item> item object
2685
2686 C<$datedue> date due DateTime object
2687
2688 C<$returndate> DateTime object representing the return time
2689
2690 Internal function, called only by AddReturn that calculates and updates
2691  the user fine days, and debars them if necessary.
2692
2693 Should only be called for overdue returns
2694
2695 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2696 to ease testing.
2697
2698 =cut
2699
2700 sub _calculate_new_debar_dt {
2701     my ( $patron, $item, $dt_due, $return_date ) = @_;
2702
2703     my $branchcode = _GetCircControlBranch( $item, $patron );
2704     my $circcontrol = C4::Context->preference('CircControl');
2705     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2706         {   categorycode => $patron->categorycode,
2707             itemtype     => $item->effective_itemtype,
2708             branchcode   => $branchcode,
2709             rules => [
2710                 'finedays',
2711                 'lengthunit',
2712                 'firstremind',
2713                 'maxsuspensiondays',
2714                 'suspension_chargeperiod',
2715             ]
2716         }
2717     );
2718     my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2719     my $unit     = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2720     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2721
2722     return unless $finedays;
2723
2724     # finedays is in days, so hourly loans must multiply by 24
2725     # thus 1 hour late equals 1 day suspension * finedays rate
2726     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2727
2728     # grace period is measured in the same units as the loan
2729     my $grace =
2730       DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2731
2732     my $deltadays = DateTime::Duration->new(
2733         days => $chargeable_units
2734     );
2735
2736     if ( $deltadays->subtract($grace)->is_positive() ) {
2737         my $suspension_days = $deltadays * $finedays;
2738
2739         if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2740             # No need to / 1 and do not consider / 0
2741             $suspension_days = DateTime::Duration->new(
2742                 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2743             );
2744         }
2745
2746         # If the max suspension days is < than the suspension days
2747         # the suspension days is limited to this maximum period.
2748         my $max_sd = $issuing_rule->{maxsuspensiondays};
2749         if ( defined $max_sd && $max_sd ne '' ) {
2750             $max_sd = DateTime::Duration->new( days => $max_sd );
2751             $suspension_days = $max_sd
2752               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2753         }
2754
2755         my ( $has_been_extended );
2756         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $patron->is_debarred ) {
2757             my $debarment = $patron->restrictions->search({type => 'SUSPENSION' },{rows => 1})->single;
2758             if ( $debarment ) {
2759                 $return_date = dt_from_string( $debarment->expiration, 'sql' );
2760                 $has_been_extended = 1;
2761             }
2762         }
2763
2764         my $new_debar_dt;
2765         # Use the calendar or not to calculate the debarment date
2766         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2767             my $calendar = Koha::Calendar->new(
2768                 branchcode => $branchcode,
2769                 days_mode  => 'Calendar'
2770             );
2771             $new_debar_dt = $calendar->addDuration( $return_date, $suspension_days );
2772         }
2773         else {
2774             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2775         }
2776         return $new_debar_dt;
2777     }
2778     return;
2779 }
2780
2781 sub _debar_user_on_return {
2782     my ( $patron, $item, $dt_due, $return_date ) = @_;
2783
2784     $return_date //= dt_from_string();
2785
2786     my $new_debar_dt = _calculate_new_debar_dt($patron, $item, $dt_due, $return_date);
2787
2788     return unless $new_debar_dt;
2789
2790     Koha::Patron::Debarments::AddUniqueDebarment({
2791         borrowernumber => $patron->borrowernumber,
2792         expiration     => $new_debar_dt->ymd(),
2793         type           => 'SUSPENSION',
2794     });
2795     # if borrower was already debarred but does not get an extra debarment
2796     my ($new_debarment_str, $is_a_reminder);
2797     if ( $patron->is_debarred ) {
2798         $is_a_reminder = 1;
2799         $new_debarment_str = $patron->debarred;
2800     } else {
2801         $new_debarment_str = $new_debar_dt->ymd();
2802     }
2803     # FIXME Should return a DateTime object
2804     return $new_debarment_str, $is_a_reminder;
2805 }
2806
2807 =head2 _FixOverduesOnReturn
2808
2809    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2810
2811 C<$borrowernumber> borrowernumber
2812
2813 C<$itemnumber> itemnumber
2814
2815 C<$exemptfine> BOOL -- remove overdue charge associated with this issue. 
2816
2817 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2818
2819 Internal function
2820
2821 =cut
2822
2823 sub _FixOverduesOnReturn {
2824     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2825     unless( $borrowernumber ) {
2826         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2827         return;
2828     }
2829     unless( $item ) {
2830         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2831         return;
2832     }
2833     unless( $status ) {
2834         warn "_FixOverduesOnReturn() not supplied valid status";
2835         return;
2836     }
2837
2838     my $schema = Koha::Database->schema;
2839
2840     my $result = $schema->txn_do(
2841         sub {
2842             # check for overdue fine
2843             my $accountlines = Koha::Account::Lines->search(
2844                 {
2845                     borrowernumber  => $borrowernumber,
2846                     itemnumber      => $item,
2847                     debit_type_code => 'OVERDUE',
2848                     status          => 'UNRETURNED'
2849                 }
2850             );
2851             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2852
2853             my $accountline = $accountlines->next;
2854             my $payments = $accountline->credits;
2855
2856             my $amountoutstanding = $accountline->amountoutstanding;
2857             if ( $accountline->amount == 0 && $payments->count == 0 ) {
2858                 $accountline->delete;
2859                 return 0; # no warning, we've just removed a zero value fine (backdated return)
2860             } elsif ($exemptfine && ($amountoutstanding != 0)) {
2861                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2862                 my $credit = $account->add_credit(
2863                     {
2864                         amount     => $amountoutstanding,
2865                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2866                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2867                         interface  => C4::Context->interface,
2868                         type       => 'FORGIVEN',
2869                         item_id    => $item
2870                     }
2871                 );
2872
2873                 $credit->apply({ debits => [ $accountline ] });
2874
2875                 if (C4::Context->preference("FinesLog")) {
2876                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2877                 }
2878             }
2879
2880             $accountline->status($status);
2881             return $accountline->store();
2882         }
2883     );
2884
2885     return $result;
2886 }
2887
2888 =head2 _GetCircControlBranch
2889
2890    my $circ_control_branch = _GetCircControlBranch($item, $patron);
2891
2892 Internal function :
2893
2894 Return the library code to be used to determine which circulation
2895 policy applies to a transaction.  Looks up the CircControl and
2896 HomeOrHoldingBranch system preferences.
2897
2898 C<$item> is an item object.
2899
2900 C<$patron> is a patron object.
2901
2902 =cut
2903
2904 sub _GetCircControlBranch {
2905     my ($item, $patron) = @_;
2906     my $circcontrol = C4::Context->preference('CircControl');
2907     my $branch;
2908
2909     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2910         $branch = C4::Context->userenv->{'branch'};
2911     } elsif ($circcontrol eq 'PatronLibrary') {
2912         $branch = $patron->branchcode;
2913     } else {
2914         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2915         $branch = $item->get_column($branchfield);
2916         # default to item home branch if holdingbranch is used
2917         # and is not defined
2918         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2919             $branch = $item->homebranch;
2920         }
2921     }
2922     return $branch;
2923 }
2924
2925 =head2 GetUpcomingDueIssues
2926
2927   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2928
2929 =cut
2930
2931 sub GetUpcomingDueIssues {
2932     my $params = shift;
2933
2934     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2935     my $dbh = C4::Context->dbh;
2936     my $statement;
2937     $statement = q{
2938         SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2939         FROM issues
2940         LEFT JOIN items USING (itemnumber)
2941         LEFT JOIN branches ON branches.branchcode =
2942     };
2943     $statement .= $params->{'owning_library'} ? " items.homebranch " : " issues.branchcode ";
2944     $statement .= " WHERE returndate is NULL AND TO_DAYS( date_due )-TO_DAYS( NOW() ) BETWEEN 0 AND ?";
2945     my @bind_parameters = ( $params->{'days_in_advance'} );
2946     
2947     my $sth = $dbh->prepare( $statement );
2948     $sth->execute( @bind_parameters );
2949     my $upcoming_dues = $sth->fetchall_arrayref({});
2950
2951     return $upcoming_dues;
2952 }
2953
2954 =head2 CanBookBeRenewed
2955
2956   ($ok,$error,$info) = &CanBookBeRenewed($patron, $issue, $override_limit, $cron);
2957
2958 Find out whether a borrowed item may be renewed.
2959
2960 C<$patron> is the patron who currently has the issue.
2961
2962 C<$issue> is the checkout to renew.
2963
2964 C<$cron> true or false, specifies if this check is being made
2965 by the automatic_renewals.pl cronscript
2966
2967 C<$override_limit>, if supplied with a true value, causes
2968 the limit on the number of times that the loan can be renewed
2969 (as controlled by the item type) to be ignored. Overriding also allows
2970 to renew sooner than "No renewal before" and to manually renew loans
2971 that are automatically renewed.
2972
2973 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2974 item must currently be on loan to the specified borrower; renewals
2975 must be allowed for the item's type; and the borrower must not have
2976 already renewed the loan.
2977     $error will contain the reason the renewal can not proceed
2978     $info will contain a hash of additional info
2979       currently 'soonest_renew_date' if error is 'too soon'
2980
2981 =cut
2982
2983 sub CanBookBeRenewed {
2984     my ( $patron, $issue, $override_limit, $cron ) = @_;
2985
2986     my $auto_renew = "no";
2987     my $soonest;
2988     my $item = $issue->item;
2989
2990     return ( 0, 'no_item' ) unless $item;
2991     return ( 0, 'no_checkout' ) unless $issue;
2992     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2993     return ( 0, 'item_issued_to_other_patron') if $issue->borrowernumber != $patron->borrowernumber;
2994     return ( 0, 'item_denied_renewal') if $item->is_denied_renewal;
2995
2996     my $final_renewal        = 0;
2997     my $final_unseen_renewal = 0;
2998
2999     # override_limit will override anything else except on_reserve
3000     my $branchcode = _GetCircControlBranch( $item, $patron );
3001     unless ( $override_limit ){
3002
3003         ( $auto_renew, $soonest ) = _CanBookBeAutoRenewed({
3004             patron     => $patron,
3005             item       => $item,
3006             branchcode => $branchcode,
3007             issue      => $issue
3008         });
3009         return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $auto_renew =~ 'auto_too_soon' && $cron;
3010         # cron wants 'too_soon' over 'on_reserve' for performance and to avoid
3011         # extra notices being sent. Cron also implies no override
3012         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_account_expired';
3013         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_late';
3014         return ( 0, $auto_renew  ) if $auto_renew =~ 'auto_too_much_oweing';
3015
3016         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3017             {
3018                 categorycode => $patron->categorycode,
3019                 itemtype     => $item->effective_itemtype,
3020                 branchcode   => $branchcode,
3021                 rules => [
3022                     'renewalsallowed',
3023                     'lengthunit',
3024                     'unseen_renewals_allowed'
3025                 ]
3026             }
3027         );
3028
3029         return ( 0, "too_many" )
3030           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals_count;
3031
3032         return ( 0, "too_unseen" )
3033           if C4::Context->preference('UnseenRenewals') &&
3034             looks_like_number($issuing_rule->{unseen_renewals_allowed}) &&
3035             $issuing_rule->{unseen_renewals_allowed} <= $issue->unseen_renewals;
3036
3037         $final_renewal        = $issuing_rule->{renewalsallowed} == ( $issue->renewals_count + 1 ) ? 1 : 0;
3038         $final_unseen_renewal = ( C4::Context->preference('UnseenRenewals')
3039                 && $issuing_rule->{unseen_renewals_allowed} == ( $issue->unseen_renewals + 1 ) ) ? 1 : 0;
3040
3041         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
3042         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
3043         my $restricted  = $patron->is_debarred;
3044         my $hasoverdues = $patron->has_overdues;
3045
3046         if ( $restricted and $restrictionblockrenewing ) {
3047             return ( 0, 'restriction');
3048         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
3049             return ( 0, 'overdue');
3050         }
3051
3052     }
3053
3054     if ( C4::Context->preference('UseRecalls') ) {
3055         my $recall = undef;
3056         $recall = $item->check_recalls if $item->can_be_waiting_recall;
3057         if ( defined $recall ) {
3058             if ( $recall->item_level ) {
3059                 # item-level recall. check if this item is the recalled item, otherwise renewal will be allowed
3060                 return ( 0, 'recalled' ) if ( $recall->item_id == $item->itemnumber );
3061             } else {
3062                 # biblio-level recall, so only disallow renewal if the biblio-level recall has been fulfilled by a different item
3063                 return ( 0, 'recalled' ) unless ( $recall->waiting );
3064             }
3065         }
3066     }
3067
3068     # There is an item level hold on this item, no other item can fill the hold
3069     return ( 0, "on_reserve" )
3070       if ( $item->current_holds->search( { non_priority => 0 } )->count );
3071
3072     my $fillable_holds = Koha::Holds->search(
3073         {
3074             biblionumber => $item->biblionumber,
3075             non_priority => 0,
3076             found        => undef,
3077             reservedate  => { '<=' => \'NOW()' },
3078             suspend      => 0
3079         }
3080     );
3081     if ( $fillable_holds->count ) {
3082         if ( C4::Context->preference('AllowRenewalIfOtherItemsAvailable') ) {
3083             my @possible_holds = $fillable_holds->as_list;
3084
3085             # Get all other items that could possibly fill reserves
3086             # FIXME We could join reserves (or more tables) here to eliminate some checks later
3087             my @other_items = Koha::Items->search({
3088                 biblionumber => $item->biblionumber,
3089                 onloan       => undef,
3090                 notforloan   => 0,
3091                 -not         => { itemnumber => $item->itemnumber } })->as_list;
3092
3093             return ( 0, "on_reserve" ) if @possible_holds && (scalar @other_items < scalar @possible_holds);
3094
3095             my %matched_items;
3096             foreach my $possible_hold (@possible_holds) {
3097                 my $fillable = 0;
3098                 my $patron_with_reserve = Koha::Patrons->find($possible_hold->borrowernumber);
3099
3100                 # FIXME: We are not checking whether the item we are renewing can fill the hold
3101
3102                 foreach my $other_item (@other_items) {
3103                   next if defined $matched_items{$other_item->itemnumber};
3104                   next if IsItemOnHoldAndFound( $other_item->itemnumber );
3105                   next unless IsAvailableForItemLevelRequest($other_item, $patron_with_reserve, undef);
3106                   next unless CanItemBeReserved($patron_with_reserve,$other_item,undef,{ignore_hold_counts=>1})->{status} eq 'OK';
3107                   # NOTE: At checkin we call 'CheckReserves' which checks hold 'policy'
3108                   # CanItemBeReserved checks 'rules' and 'policies' which means
3109                   # items will fill holds at checkin that are rejected here
3110                   $fillable = 1;
3111                   $matched_items{$other_item->itemnumber} = 1;
3112                   last;
3113                 }
3114                 return ( 0, "on_reserve" ) unless $fillable;
3115             }
3116         }
3117         else {
3118             my ($status, $matched_reserve, $possible_reserves) = CheckReserves($item);
3119             return ( 0, "on_reserve" ) if $status;
3120         }
3121     }
3122
3123     # CHECK FOR BOOKINGS
3124     if ( $item->bookings->count ) {
3125         my $startdate =
3126             ( C4::Context->preference('RenewalPeriodBase') eq 'date_due' )
3127             ? dt_from_string( $issue->date_due, 'sql' )
3128             : dt_from_string();
3129         my $datedue = CalcDateDue( $startdate, $item->effective_itemtype, $branchcode, $patron, 'is a renewal' );
3130         if (
3131             my $booking = $item->find_booking(
3132                 { checkout_date => $startdate, due_date => $datedue, patron_id => $patron->borrowernumber }
3133             )
3134             )
3135         {
3136             return ( 0, 'booked' ) unless ( $booking->patron_id == $patron->borrowernumber );
3137         }
3138
3139     }
3140
3141     if ( $auto_renew eq 'auto_too_soon' ) {
3142
3143         # If its cron, tell it it's too soon for a an auto renewal
3144         return ( 0, $auto_renew, { soonest_renew_date => $soonest } ) if $cron;
3145
3146         # Check if it's too soon for a manual renewal
3147         my $soonestManual = GetSoonestRenewDate( $patron, $issue );
3148         if ( $soonestManual > dt_from_string() ) {
3149             return ( 0, "too_soon", { soonest_renew_date => $soonestManual } ) unless $override_limit;
3150         }
3151     }
3152
3153     $soonest = GetSoonestRenewDate($patron, $issue);
3154     if ( $soonest > dt_from_string() ){
3155         return (0, "too_soon", { soonest_renew_date => $soonest } ) unless $override_limit;
3156     }
3157
3158     my $auto_renew_code = $final_renewal ? 'auto_renew_final' : $final_unseen_renewal ? 'auto_unseen_final' : 'auto_renew';
3159     return ( 1, $auto_renew_code ) if $auto_renew eq "ok" || $auto_renew eq "auto_too_soon" && !$override_limit;
3160
3161     return ( 1, undef );
3162 }
3163
3164 =head2 AddRenewal
3165
3166   $new_date_due = AddRenewal({
3167       borrowernumber   => $borrowernumber,
3168       itemnumber       => $itemnumber,
3169       branch           => $branch,
3170       [datedue         => $datedue],
3171       [lastreneweddate => $lastreneweddate],
3172       [skipfinecalc    => $skipfinecalc],
3173       [seen            => $seen],
3174       [automatic       => $automatic],
3175       [skip_record_index => $skip_record_index]
3176   });
3177
3178 Renews a loan, returns the updated due date upon success.
3179
3180 C<$borrowernumber> is the borrower number of the patron who currently
3181 has the item.
3182
3183 C<$itemnumber> is the number of the item to renew.
3184
3185 C<$branch> is the library where the renewal took place (if any).
3186            The library that controls the circ policies for the renewal is retrieved from the issues record.
3187
3188 C<$datedue> can be a DateTime object used to set the due date.
3189
3190 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
3191 this parameter is not supplied, lastreneweddate is set to the current date.
3192
3193 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3194 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3195 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3196 syspref)
3197
3198 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3199 from the book's item type.
3200
3201 C<$seen> is a boolean flag indicating if the item was seen or not during the renewal. This
3202 informs the incrementing of the unseen_renewals column. If this flag is not supplied, we
3203 fallback to a true value
3204
3205 C<$automatic> is a boolean flag indicating the renewal was triggered automatically and not by a person ( librarian or patron )
3206
3207 C<$skip_record_index> is an optional boolean flag to indicate whether queuing the search indexing
3208 should be skipped for this renewal.
3209
3210 =cut
3211
3212 sub AddRenewal {
3213     my $params = shift;
3214
3215     my $borrowernumber  = $params->{borrowernumber};
3216     my $itemnumber      = $params->{itemnumber};
3217     return unless $itemnumber;
3218
3219     my $branch            = $params->{branch};
3220     my $datedue           = $params->{datedue};
3221     my $lastreneweddate   = $params->{lastreneweddate} // dt_from_string();
3222     my $skipfinecalc      = $params->{skipfinecalc};
3223     my $seen              = $params->{seen};
3224     my $automatic         = $params->{automatic};
3225     my $skip_record_index = $params->{skip_record_index};
3226
3227     # Fallback on a 'seen' renewal
3228     $seen = defined $seen && $seen == 0 ? 0 : 1;
3229
3230     my $item_object   = Koha::Items->find($itemnumber) or return;
3231     my $biblio = $item_object->biblio;
3232     my $issue  = $item_object->checkout;
3233     my $item_unblessed = $item_object->unblessed;
3234
3235     my $renewal_type = $automatic ? "Automatic" : "Manual";
3236
3237     my $dbh = C4::Context->dbh;
3238
3239     return unless $issue;
3240
3241     $borrowernumber ||= $issue->borrowernumber;
3242
3243     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3244         $datedue = dt_from_string($datedue, 'sql');
3245     }
3246
3247     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3248     my $patron_unblessed = $patron->unblessed;
3249
3250     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_object, $patron) );
3251
3252     my $schema = Koha::Database->schema;
3253     $schema->txn_do(sub{
3254
3255         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3256             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3257         }
3258         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3259
3260         # If the due date wasn't specified, calculate it by adding the
3261         # book's loan length to today's date or the current due date
3262         # based on the value of the RenewalPeriodBase syspref.
3263         my $itemtype = $item_object->effective_itemtype;
3264         unless ($datedue) {
3265
3266             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3267                                             dt_from_string( $issue->date_due, 'sql' ) :
3268                                             dt_from_string();
3269             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron, 'is a renewal');
3270         }
3271
3272         my $fees = Koha::Charges::Fees->new(
3273             {
3274                 patron    => $patron,
3275                 library   => $circ_library,
3276                 item      => $item_object,
3277                 from_date => dt_from_string( $issue->date_due, 'sql' ),
3278                 to_date   => dt_from_string($datedue),
3279             }
3280         );
3281
3282         # Increment the unseen renewals, if appropriate
3283         # We only do so if the syspref is enabled and
3284         # a maximum value has been set in the circ rules
3285         my $unseen_renewals = $issue->unseen_renewals;
3286         if (C4::Context->preference('UnseenRenewals')) {
3287             my $rule = Koha::CirculationRules->get_effective_rule(
3288                 {   categorycode => $patron->categorycode,
3289                     itemtype     => $item_object->effective_itemtype,
3290                     branchcode   => $circ_library->branchcode,
3291                     rule_name    => 'unseen_renewals_allowed'
3292                 }
3293             );
3294             if (!$seen && $rule && looks_like_number($rule->rule_value)) {
3295                 $unseen_renewals++;
3296             } else {
3297                 # If the renewal is seen, unseen should revert to 0
3298                 $unseen_renewals = 0;
3299             }
3300         }
3301
3302         # Update the issues record to have the new due date, and a new count
3303         # of how many times it has been renewed.
3304         my $renews = ( $issue->renewals_count || 0 ) + 1;
3305         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals_count = ?, unseen_renewals = ?, lastreneweddate = ? WHERE issue_id = ?");
3306
3307         eval{
3308             $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $unseen_renewals, $lastreneweddate, $issue->issue_id );
3309         };
3310         if( $sth->err ){
3311             Koha::Exceptions::Checkout::FailedRenewal->throw(
3312                 error => 'Update of issue# ' . $issue->issue_id . ' failed with error: ' . $sth->errstr
3313             );
3314         }
3315
3316         # Update the renewal count on the item, and tell zebra to reindex
3317         $renews = ( $item_object->renewals || 0 ) + 1;
3318         $item_object->renewals($renews);
3319         $item_object->onloan($datedue);
3320         # Don't index as we are in a transaction, skip hardcoded here
3321         $item_object->store({ log_action => 0, skip_record_index => 1 });
3322
3323         # Charge a new rental fee, if applicable
3324         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3325         if ( $charge > 0 ) {
3326             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3327         }
3328
3329         # Charge a new accumulate rental fee, if applicable
3330         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3331         if ( $itemtype_object ) {
3332             my $accumulate_charge = $fees->accumulate_rentalcharge();
3333             if ( $accumulate_charge > 0 ) {
3334                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3335             }
3336             $charge += $accumulate_charge;
3337         }
3338
3339         # Send a renewal slip according to checkout alert preferencei
3340         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3341             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3342             my %conditions        = (
3343                 branchcode   => $branch,
3344                 categorycode => $patron->categorycode,
3345                 item_type    => $itemtype,
3346                 notification => 'CHECKOUT',
3347             );
3348             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3349                 SendCirculationAlert(
3350                     {
3351                         type     => 'RENEWAL',
3352                         item     => $item_unblessed,
3353                         borrower => $patron->unblessed,
3354                         branch   => $branch,
3355                     }
3356                 );
3357             }
3358         }
3359
3360         # Remove any OVERDUES related debarment if the borrower has no overdues
3361         my $overdue_restrictions = $patron->restrictions->search({ type => 'OVERDUES' });
3362         if ( $patron
3363           && $patron->is_debarred
3364           && ! $patron->has_overdues
3365           && $overdue_restrictions->count
3366         ) {
3367             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3368         }
3369
3370         # Add renewal record
3371         my $renewal = Koha::Checkouts::Renewal->new(
3372             {
3373                 checkout_id  => $issue->issue_id,
3374                 interface    => C4::Context->interface,
3375                 renewal_type => $renewal_type,
3376                 renewer_id   => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3377                 seen         => $seen,
3378             }
3379         )->store();
3380
3381         # Add the renewal to stats
3382         C4::Stats::UpdateStats(
3383             {
3384                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3385                 type           => 'renew',
3386                 amount         => $charge,
3387                 itemnumber     => $itemnumber,
3388                 itemtype       => $itemtype,
3389                 location       => $item_object->location,
3390                 borrowernumber => $borrowernumber,
3391                 ccode          => $item_object->ccode,
3392                 categorycode   => $patron->categorycode,
3393                 interface      => C4::Context->interface,
3394             }
3395         );
3396         #Update borrowers.lastseen
3397         $patron->update_lastseen('renewal');
3398
3399         #Log the renewal
3400         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3401
3402         Koha::Plugins->call('after_circ_action', {
3403             action  => 'renewal',
3404             payload => {
3405                 checkout  => $issue->get_from_storage
3406             }
3407         });
3408     });
3409
3410     unless( $skip_record_index ){
3411         # We index now, after the transaction is committed
3412         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
3413         $indexer->index_records( $item_object->biblionumber, "specialUpdate", "biblioserver" );
3414     }
3415
3416     return $datedue;
3417 }
3418
3419 sub GetRenewCount {
3420     # check renewal status
3421     my ( $borrowernumber_or_patron, $itemnumber_or_item ) = @_;
3422
3423     my $dbh           = C4::Context->dbh;
3424     my $renewcount    = 0;
3425     my $unseencount    = 0;
3426     my $renewsallowed = 0;
3427     my $unseenallowed = 0;
3428     my $renewsleft    = 0;
3429     my $unseenleft    = 0;
3430     my $patron = blessed $borrowernumber_or_patron ?
3431         $borrowernumber_or_patron : Koha::Patrons->find($borrowernumber_or_patron);
3432     my $item = blessed $itemnumber_or_item ?
3433         $itemnumber_or_item : Koha::Items->find($itemnumber_or_item);
3434
3435     return (0, 0, 0, 0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3436
3437     # Look in the issues table for this item, lent to this borrower,
3438     # and not yet returned.
3439
3440     # FIXME - I think this function could be redone to use only one SQL call.
3441     my $sth = $dbh->prepare(q{
3442         SELECT * FROM issues
3443         WHERE  (borrowernumber = ?) AND (itemnumber = ?)
3444     });
3445     $sth->execute( $patron->borrowernumber, $item->itemnumber );
3446     my $data = $sth->fetchrow_hashref;
3447     $renewcount = $data->{'renewals_count'} if $data->{'renewals_count'};
3448     $unseencount = $data->{'unseen_renewals'} if $data->{'unseen_renewals'};
3449     # $item and $borrower should be calculated
3450     my $branchcode = _GetCircControlBranch($item, $patron);
3451
3452     my $rules = Koha::CirculationRules->get_effective_rules(
3453         {
3454             categorycode => $patron->categorycode,
3455             itemtype     => $item->effective_itemtype,
3456             branchcode   => $branchcode,
3457             rules        => [ 'renewalsallowed', 'unseen_renewals_allowed' ]
3458         }
3459     );
3460     $renewsallowed = $rules ? $rules->{renewalsallowed} : 0;
3461     $unseenallowed = $rules->{unseen_renewals_allowed} ?
3462         $rules->{unseen_renewals_allowed} :
3463         0;
3464     $renewsleft    = $renewsallowed - $renewcount;
3465     $unseenleft    = $unseenallowed - $unseencount;
3466     if($renewsleft < 0){ $renewsleft = 0; }
3467     if($unseenleft < 0){ $unseenleft = 0; }
3468     return (
3469         $renewcount,
3470         $renewsallowed,
3471         $renewsleft,
3472         $unseencount,
3473         $unseenallowed,
3474         $unseenleft
3475     );
3476 }
3477
3478 =head2 GetSoonestRenewDate
3479
3480   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($patron, $issue);
3481
3482 Find out the soonest possible renew date of a borrowed item.
3483
3484 C<$patron> is the patron who currently has the item on loan.
3485
3486 C<$issue> is the the item issue.
3487
3488 C<$is_auto> is this soonest renew date for an auto renewal?
3489
3490 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3491 renew date, based on the value "No renewal before" of the applicable
3492 issuing rule. Returns the current date if the item can already be
3493 renewed, and returns undefined if the patron, item, or checkout
3494 cannot be found.
3495
3496 =cut
3497
3498 sub GetSoonestRenewDate {
3499     my ( $patron, $issue, $is_auto ) = @_;
3500     return unless $issue;
3501     return unless $patron;
3502
3503     my $item = $issue->item;
3504     return unless $item;
3505
3506     my $circ_rule = $is_auto ? 'noautorenewalbefore' : 'norenewalbefore';
3507
3508     my $dbh = C4::Context->dbh;
3509
3510     my $branchcode = _GetCircControlBranch( $item, $patron );
3511     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3512         {   categorycode => $patron->categorycode,
3513             itemtype     => $item->effective_itemtype,
3514             branchcode   => $branchcode,
3515             rules => [
3516                 $circ_rule,
3517                 'lengthunit',
3518             ]
3519         }
3520     );
3521
3522     my $now = dt_from_string;
3523
3524     if ( defined $issuing_rule->{$circ_rule}
3525         and $issuing_rule->{$circ_rule} ne "" )
3526     {
3527         my $soonestrenewal =
3528           dt_from_string( $issue->date_due )->subtract(
3529             $issuing_rule->{lengthunit} => $issuing_rule->{$circ_rule} );
3530
3531         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3532             and $issuing_rule->{lengthunit} eq 'days' )
3533         {
3534             $soonestrenewal->truncate( to => 'day' );
3535         }
3536         return $soonestrenewal;
3537     } elsif ( $is_auto && $issue->auto_renew && $patron->autorenew_checkouts ) {
3538         # Checkouts with auto-renewing fall back to due date if noautorenewalbefore is undef
3539         my $soonestrenewal = dt_from_string( $issue->date_due );
3540         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3541             and $issuing_rule->{lengthunit} eq 'days' )
3542         {
3543             $soonestrenewal->truncate( to => 'day' );
3544         }
3545         return $soonestrenewal;
3546     }
3547     return $now;
3548 }
3549
3550 =head2 GetLatestAutoRenewDate
3551
3552   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($patron, $issue);
3553
3554 Find out the latest possible auto renew date of a borrowed item.
3555
3556 C<$patron> is the patron who currently has the item on loan.
3557
3558 C<$issue> is the item issue.
3559
3560 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3561 auto renew date, based on the value "No auto renewal after" and the "No auto
3562 renewal after (hard limit) of the applicable issuing rule.
3563 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3564 or item cannot be found.
3565
3566 =cut
3567
3568 sub GetLatestAutoRenewDate {
3569     my ( $patron, $issue ) = @_;
3570     return unless $issue;
3571     return unless $patron;
3572
3573     my $item = $issue->item;
3574     return unless $item;
3575
3576     my $dbh = C4::Context->dbh;
3577     my $branchcode = _GetCircControlBranch( $item, $patron );
3578
3579     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3580         {
3581             categorycode => $patron->categorycode,
3582             itemtype     => $item->effective_itemtype,
3583             branchcode   => $branchcode,
3584             rules => [
3585                 'no_auto_renewal_after',
3586                 'no_auto_renewal_after_hard_limit',
3587                 'lengthunit',
3588             ]
3589         }
3590     );
3591
3592     return unless $circulation_rules;
3593     return
3594       if ( not $circulation_rules->{no_auto_renewal_after}
3595             or $circulation_rules->{no_auto_renewal_after} eq '' )
3596       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3597              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3598
3599     my $maximum_renewal_date;
3600     if ( $circulation_rules->{no_auto_renewal_after} ) {
3601         $maximum_renewal_date = dt_from_string($issue->issuedate);
3602         $maximum_renewal_date->add(
3603             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3604         );
3605     }
3606
3607     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3608         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3609         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3610     }
3611     return $maximum_renewal_date;
3612 }
3613
3614
3615 =head2 GetIssuingCharges
3616
3617   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3618
3619 Calculate how much it would cost for a given patron to borrow a given
3620 item, including any applicable discounts.
3621
3622 C<$itemnumber> is the item number of item the patron wishes to borrow.
3623
3624 C<$borrowernumber> is the patron's borrower number.
3625
3626 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3627 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3628 if it's a video).
3629
3630 =cut
3631
3632 sub GetIssuingCharges {
3633
3634     # calculate charges due
3635     my ( $itemnumber, $borrowernumber ) = @_;
3636     my $charge = 0;
3637     my $dbh    = C4::Context->dbh;
3638     my $item_type;
3639
3640     # Get the book's item type and rental charge (via its biblioitem).
3641     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3642         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3643     $charge_query .= (C4::Context->preference('item-level_itypes'))
3644         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3645         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3646
3647     $charge_query .= ' WHERE items.itemnumber =?';
3648
3649     my $sth = $dbh->prepare($charge_query);
3650     $sth->execute($itemnumber);
3651     my $patron;
3652     if ( my $item_data = $sth->fetchrow_hashref ) {
3653         $item_type = $item_data->{itemtype};
3654         $charge    = $item_data->{rentalcharge};
3655         if ($charge) {
3656             # FIXME This should follow CircControl
3657             my $branch = C4::Context::mybranch();
3658             $patron //= Koha::Patrons->find( $borrowernumber );
3659             my $discount = Koha::CirculationRules->get_effective_rule({
3660                 categorycode => $patron->categorycode,
3661                 branchcode   => $branch,
3662                 itemtype     => $item_type,
3663                 rule_name    => 'rentaldiscount'
3664             });
3665             if ($discount) {
3666                 $charge = ( $charge * ( 100 - $discount->rule_value ) ) / 100;
3667             }
3668             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3669         }
3670     }
3671
3672     return ( $charge, $item_type );
3673 }
3674
3675 =head2 AddIssuingCharge
3676
3677   &AddIssuingCharge( $checkout, $charge, $type )
3678
3679 =cut
3680
3681 sub AddIssuingCharge {
3682     my ( $checkout, $charge, $type ) = @_;
3683
3684     # FIXME What if checkout does not exist?
3685
3686     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3687     my $accountline = $account->add_debit(
3688         {
3689             amount      => $charge,
3690             note        => undef,
3691             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3692             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3693             interface   => C4::Context->interface,
3694             type        => $type,
3695             item_id     => $checkout->itemnumber,
3696             issue_id    => $checkout->issue_id,
3697         }
3698     );
3699 }
3700
3701 =head2 GetTransfersFromTo
3702
3703   @results = GetTransfersFromTo($frombranch,$tobranch);
3704
3705 Returns the list of pending transfers between $from and $to branch
3706
3707 =cut
3708
3709 sub GetTransfersFromTo {
3710     my ( $frombranch, $tobranch ) = @_;
3711     return unless ( $frombranch && $tobranch );
3712     my $dbh   = C4::Context->dbh;
3713     my $query = "
3714         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3715         FROM   branchtransfers
3716         WHERE  frombranch=?
3717           AND  tobranch=?
3718           AND datecancelled IS NULL
3719           AND datesent IS NOT NULL
3720           AND datearrived IS NULL
3721     ";
3722     my $sth = $dbh->prepare($query);
3723     $sth->execute( $frombranch, $tobranch );
3724     my @gettransfers;
3725
3726     while ( my $data = $sth->fetchrow_hashref ) {
3727         push @gettransfers, $data;
3728     }
3729     return (@gettransfers);
3730 }
3731
3732 =head2 SendCirculationAlert
3733
3734 Send out a C<check-in> or C<checkout> alert using the messaging system.
3735
3736 B<Parameters>:
3737
3738 =over 4
3739
3740 =item type
3741
3742 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3743
3744 =item item
3745
3746 Hashref of information about the item being checked in or out.
3747
3748 =item borrower
3749
3750 Hashref of information about the borrower of the item.
3751
3752 =item branch
3753
3754 The branchcode from where the checkout or check-in took place.
3755
3756 =back
3757
3758 B<Example>:
3759
3760     SendCirculationAlert({
3761         type     => 'CHECKOUT',
3762         item     => $item,
3763         borrower => $borrower,
3764         branch   => $branch,
3765     });
3766
3767 =cut
3768
3769 sub SendCirculationAlert {
3770     my ($opts) = @_;
3771     my ($type, $item, $borrower, $branch, $issue) =
3772         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch}, $opts->{issue});
3773     my %message_name = (
3774         CHECKIN  => 'Item_Check_in',
3775         CHECKOUT => 'Item_Checkout',
3776         RENEWAL  => 'Item_Checkout',
3777     );
3778     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3779         borrowernumber => $borrower->{borrowernumber},
3780         message_name   => $message_name{$type},
3781     });
3782
3783
3784     my $tables = {
3785         items => $item->{itemnumber},
3786         biblio      => $item->{biblionumber},
3787         biblioitems => $item->{biblionumber},
3788         borrowers   => $borrower,
3789         branches    => $branch,
3790     };
3791
3792     # TODO: Currently, we need to pass an issue_id as identifier for old_issues, but still an itemnumber for issues.
3793     # See C4::Letters:: _parseletter_sth
3794     if( $type eq 'CHECKIN' ){
3795         $tables->{old_issues} = $issue->issue_id;
3796     } else {
3797         $tables->{issues} = $item->{itemnumber};
3798     }
3799
3800     my $schema = Koha::Database->new->schema;
3801     my @transports = keys %{ $borrower_preferences->{transports} };
3802
3803     # From the MySQL doc:
3804     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3805     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3806     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3807     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3808
3809     for my $mtt (@transports) {
3810         my $letter =  C4::Letters::GetPreparedLetter (
3811             module => 'circulation',
3812             letter_code => $type,
3813             branchcode => $branch,
3814             message_transport_type => $mtt,
3815             lang => $borrower->{lang},
3816             tables => $tables,
3817         ) or next;
3818
3819         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3820         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3821         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3822         unless ( $message ) {
3823             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3824             my $patron = Koha::Patrons->find($borrower->{borrowernumber});
3825             C4::Message->enqueue($letter, $patron, $mtt);
3826         } else {
3827             $message->append($letter);
3828             $message->update;
3829         }
3830         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3831     }
3832
3833     return;
3834 }
3835
3836 =head2 updateWrongTransfer
3837
3838   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3839
3840 This function validate the line of brachtransfer but with the wrong destination (mistake from a librarian ...), and create a new line in branchtransfer from the actual library to the original library of reservation 
3841
3842 =cut
3843
3844 sub updateWrongTransfer {
3845         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3846
3847     # first step: cancel the original transfer
3848     my $item = Koha::Items->find($itemNumber);
3849     my $transfer = $item->get_transfer;
3850     $transfer->set({ datecancelled => dt_from_string, cancellation_reason => 'WrongTransfer' })->store();
3851
3852     # second step: create a new transfer to the right location
3853     my $new_transfer = $item->request_transfer(
3854         {
3855             to            => $transfer->to_library,
3856             reason        => $transfer->reason,
3857             comment       => $transfer->comments,
3858             ignore_limits => 1,
3859             enqueue       => 1
3860         }
3861     );
3862
3863     return $new_transfer;
3864 }
3865
3866 =head2 CalcDateDue
3867
3868 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3869
3870 this function calculates the due date given the start date and configured circulation rules,
3871 checking against the holidays calendar as per the daysmode circulation rule.
3872 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3873 C<$itemtype>  = itemtype code of item in question
3874 C<$branch>  = location whose calendar to use
3875 C<$patron> = Patron object
3876 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3877
3878 =cut
3879
3880 sub CalcDateDue {
3881     my ( $startdate, $itemtype, $branch, $patron, $isrenewal ) = @_;
3882
3883     $isrenewal ||= 0;
3884
3885     # loanlength now a href
3886     my $loanlength =
3887             GetLoanLength( $patron->categorycode, $itemtype, $branch );
3888
3889     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} and $loanlength->{renewalperiod} ne q{} )
3890             ? qq{renewalperiod}
3891             : qq{issuelength};
3892
3893     my $datedue;
3894     if ( $startdate ) {
3895         if (ref $startdate ne 'DateTime' ) {
3896             $datedue = dt_from_string($datedue);
3897         } else {
3898             $datedue = $startdate->clone;
3899         }
3900     } else {
3901         $datedue = dt_from_string()->truncate( to => 'minute' );
3902     }
3903
3904
3905     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3906         {
3907             categorycode => $patron->categorycode,
3908             itemtype     => $itemtype,
3909             branchcode   => $branch,
3910         }
3911     );
3912
3913     # calculate the datedue as normal
3914     if ( $daysmode eq 'Days' )
3915     {    # ignoring calendar
3916         if ( $loanlength->{lengthunit} eq 'hours' ) {
3917             $datedue->add( hours => $loanlength->{$length_key} );
3918         } else {    # days
3919             $datedue->add( days => $loanlength->{$length_key} );
3920             $datedue->set_hour(23);
3921             $datedue->set_minute(59);
3922         }
3923     } else {
3924         my $dur;
3925         if ($loanlength->{lengthunit} eq 'hours') {
3926             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3927         }
3928         else { # days
3929             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3930         }
3931         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3932         $datedue = $calendar->addDuration( $datedue, $dur, $loanlength->{lengthunit} );
3933         if ($loanlength->{lengthunit} eq 'days') {
3934             $datedue->set_hour(23);
3935             $datedue->set_minute(59);
3936         }
3937     }
3938
3939     # if Hard Due Dates are used, retrieve them and apply as necessary
3940     my ( $hardduedate, $hardduedatecompare ) =
3941       GetHardDueDate( $patron->categorycode, $itemtype, $branch );
3942     if ($hardduedate) {    # hardduedates are currently dates
3943         $hardduedate->truncate( to => 'minute' );
3944         $hardduedate->set_hour(23);
3945         $hardduedate->set_minute(59);
3946         my $cmp = DateTime->compare( $hardduedate, $datedue );
3947
3948 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3949 # if the calculated date is before the 'after' Hard Due Date (floor), override
3950 # if the hard due date is set to 'exactly', overrride
3951         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3952             $datedue = $hardduedate->clone;
3953         }
3954
3955         # in all other cases, keep the date due as it is
3956
3957     }
3958
3959     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3960     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3961         my $expiry_dt = dt_from_string( $patron->dateexpiry, 'iso', 'floating');
3962         if( $expiry_dt ) { #skip empty expiry date..
3963             $expiry_dt->set( hour => 23, minute => 59);
3964             my $d1= $datedue->clone->set_time_zone('floating');
3965             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3966                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3967             }
3968         }
3969         if ( $daysmode ne 'Days' ) {
3970           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3971           if ( $calendar->is_holiday($datedue) ) {
3972               # Don't return on a closed day
3973               $datedue = $calendar->prev_open_days( $datedue, 1 );
3974           }
3975         }
3976     }
3977
3978     return $datedue;
3979 }
3980
3981
3982 sub CheckValidBarcode{
3983 my ($barcode) = @_;
3984 my $dbh = C4::Context->dbh;
3985 my $query=qq|SELECT count(*) 
3986              FROM items 
3987              WHERE barcode=?
3988             |;
3989 my $sth = $dbh->prepare($query);
3990 $sth->execute($barcode);
3991 my $exist=$sth->fetchrow ;
3992 return $exist;
3993 }
3994
3995 =head2 IsBranchTransferAllowed
3996
3997   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3998
3999 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
4000
4001 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
4002 Koha::Item->can_be_transferred.
4003
4004 =cut
4005
4006 sub IsBranchTransferAllowed {
4007         my ( $toBranch, $fromBranch, $code ) = @_;
4008
4009         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
4010         
4011         my $limitType = C4::Context->preference("BranchTransferLimitsType");   
4012         my $dbh = C4::Context->dbh;
4013             
4014         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
4015         $sth->execute( $toBranch, $fromBranch, $code );
4016         my $limit = $sth->fetchrow_hashref();
4017                         
4018         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
4019         if ( $limit->{'limitId'} ) {
4020                 return 0;
4021         } else {
4022                 return 1;
4023         }
4024 }                                                        
4025
4026 =head2 CreateBranchTransferLimit
4027
4028   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
4029
4030 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
4031
4032 Deprecated in favor of Koha::Item::Transfer::Limit->new.
4033
4034 =cut
4035
4036 sub CreateBranchTransferLimit {
4037    my ( $toBranch, $fromBranch, $code ) = @_;
4038    return unless defined($toBranch) && defined($fromBranch);
4039    my $limitType = C4::Context->preference("BranchTransferLimitsType");
4040    
4041    my $dbh = C4::Context->dbh;
4042    
4043    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
4044    return $sth->execute( $code, $toBranch, $fromBranch );
4045 }
4046
4047 =head2 DeleteBranchTransferLimits
4048
4049     my $result = DeleteBranchTransferLimits($frombranch);
4050
4051 Deletes all the library transfer limits for one library.  Returns the
4052 number of limits deleted, 0e0 if no limits were deleted, or undef if
4053 no arguments are supplied.
4054
4055 Deprecated in favor of Koha::Item::Transfer::Limits->search({
4056     fromBranch => $fromBranch
4057     })->delete.
4058
4059 =cut
4060
4061 sub DeleteBranchTransferLimits {
4062     my $branch = shift;
4063     return unless defined $branch;
4064     my $dbh    = C4::Context->dbh;
4065     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
4066     return $sth->execute($branch);
4067 }
4068
4069 sub ReturnLostItem{
4070     my ( $borrowernumber, $itemnum ) = @_;
4071     MarkIssueReturned( $borrowernumber, $itemnum );
4072 }
4073
4074 =head2 LostItem
4075
4076   LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
4077
4078 The final optional parameter, C<$params>, expected to contain
4079 'skip_record_index' key, which relayed down to Koha::Item/store,
4080 there it prevents calling of ModZebra index_records,
4081 which takes most of the time in batch adds/deletes: index_records better
4082 to be called later in C<additem.pl> after the whole loop.
4083
4084 $params:
4085     skip_record_index => 1|0
4086
4087 =cut
4088
4089 sub LostItem{
4090     my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
4091
4092     unless ( $mark_lost_from ) {
4093         # Temporary check to avoid regressions
4094         die q|LostItem called without $mark_lost_from, check the API.|;
4095     }
4096
4097     my $mark_returned;
4098     if ( $force_mark_returned ) {
4099         $mark_returned = 1;
4100     } else {
4101         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
4102         $mark_returned = ( $pref =~ m|$mark_lost_from| );
4103     }
4104
4105     my $dbh = C4::Context->dbh();
4106     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title 
4107                            FROM issues 
4108                            JOIN items USING (itemnumber) 
4109                            JOIN biblio USING (biblionumber)
4110                            WHERE issues.itemnumber=?");
4111     $sth->execute($itemnumber);
4112     my $issues=$sth->fetchrow_hashref();
4113
4114     # If a borrower lost the item, add a replacement cost to the their record
4115     if ( my $borrowernumber = $issues->{borrowernumber} ){
4116         my $patron = Koha::Patrons->find( $borrowernumber );
4117
4118         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
4119         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
4120
4121         if (C4::Context->preference('WhenLostChargeReplacementFee')){
4122             C4::Accounts::chargelostitem(
4123                 $borrowernumber,
4124                 $itemnumber,
4125                 $issues->{'replacementprice'},
4126                 sprintf( "%s %s %s",
4127                     $issues->{'title'}          || q{},
4128                     $issues->{'barcode'}        || q{},
4129                     $issues->{'itemcallnumber'} || q{},
4130                 ),
4131             );
4132             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
4133             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
4134         }
4135
4136         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy,$params) if $mark_returned;
4137     }
4138
4139     # When an item is marked as lost, we should automatically cancel its outstanding transfers.
4140     my $item = Koha::Items->find($itemnumber);
4141     my $transfers = $item->get_transfers;
4142     while (my $transfer = $transfers->next) {
4143         $transfer->cancel({ reason => 'ItemLost', force => 1 });
4144     }
4145 }
4146
4147 sub GetOfflineOperations {
4148     my $dbh = C4::Context->dbh;
4149     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
4150     $sth->execute(C4::Context->userenv->{'branch'});
4151     my $results = $sth->fetchall_arrayref({});
4152     return $results;
4153 }
4154
4155 sub GetOfflineOperation {
4156     my $operationid = shift;
4157     return unless $operationid;
4158     my $dbh = C4::Context->dbh;
4159     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
4160     $sth->execute( $operationid );
4161     return $sth->fetchrow_hashref;
4162 }
4163
4164 sub AddOfflineOperation {
4165     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
4166     my $dbh = C4::Context->dbh;
4167     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
4168     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
4169     return "Added.";
4170 }
4171
4172 sub DeleteOfflineOperation {
4173     my $dbh = C4::Context->dbh;
4174     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4175     $sth->execute( shift );
4176     return "Deleted.";
4177 }
4178
4179 sub ProcessOfflineOperation {
4180     my $operation = shift;
4181
4182     my $report;
4183     if ( $operation->{action} eq 'return' ) {
4184         $report = ProcessOfflineReturn( $operation );
4185     } elsif ( $operation->{action} eq 'issue' ) {
4186         $report = ProcessOfflineIssue( $operation );
4187     } elsif ( $operation->{action} eq 'payment' ) {
4188         $report = ProcessOfflinePayment( $operation );
4189     }
4190
4191     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4192
4193     return $report;
4194 }
4195
4196 sub ProcessOfflineReturn {
4197     my $operation = shift;
4198
4199     my $item = Koha::Items->find({barcode => $operation->{barcode}});
4200
4201     if ( $item ) {
4202         my $itemnumber = $item->itemnumber;
4203         my $issue = $item->checkout;
4204         if ( $issue ) {
4205             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4206             ModDateLastSeen( $itemnumber, $leave_item_lost );
4207             MarkIssueReturned(
4208                 $issue->borrowernumber,
4209                 $itemnumber,
4210                 $operation->{timestamp},
4211             );
4212             $item->onloan(undef);
4213             $item->store({ log_action => 0 });
4214             return "Success.";
4215         } else {
4216             return "Item not issued.";
4217         }
4218     } else {
4219         return "Item not found.";
4220     }
4221 }
4222
4223 sub ProcessOfflineIssue {
4224     my $operation = shift;
4225
4226     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4227     $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4228
4229     if ( $patron ) {
4230         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4231         unless ($item) {
4232             return "Barcode not found.";
4233         }
4234         my $itemnumber = $item->itemnumber;
4235         my $issue = $item->checkout;
4236
4237         if ( $issue and ( $issue->borrowernumber ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4238             MarkIssueReturned(
4239                 $issue->borrowernumber,
4240                 $itemnumber,
4241                 $operation->{timestamp},
4242             );
4243         }
4244         AddIssue(
4245             $patron,
4246             $operation->{'barcode'},
4247             undef,
4248             undef,
4249             $operation->{timestamp},
4250             undef,
4251         );
4252         return "Success.";
4253     } else {
4254         return "Borrower not found.";
4255     }
4256 }
4257
4258 sub ProcessOfflinePayment {
4259     my $operation = shift;
4260
4261     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4262     $patron ||= Koha::Patrons->find( { userid => $operation->{cardnumber} } );
4263
4264     $patron->account->pay(
4265         {
4266             amount     => $operation->{amount},
4267             library_id => $operation->{branchcode},
4268             interface  => 'koc'
4269         }
4270     );
4271
4272     return "Success.";
4273 }
4274
4275 =head2 TransferSlip
4276
4277   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4278
4279   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4280
4281 =cut
4282
4283 sub TransferSlip {
4284     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4285
4286     my $item =
4287       $itemnumber
4288       ? Koha::Items->find($itemnumber)
4289       : Koha::Items->find( { barcode => $barcode } );
4290
4291     $item or return;
4292
4293     return C4::Letters::GetPreparedLetter (
4294         module => 'circulation',
4295         letter_code => 'TRANSFERSLIP',
4296         branchcode => $branch,
4297         tables => {
4298             'branches'    => $to_branch,
4299             'biblio'      => $item->biblionumber,
4300             'items'       => $item->unblessed,
4301         },
4302     );
4303 }
4304
4305 =head2 CheckIfIssuedToPatron
4306
4307   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4308
4309   Return 1 if any record item is issued to patron, otherwise return 0
4310
4311 =cut
4312
4313 sub CheckIfIssuedToPatron {
4314     my ($borrowernumber, $biblionumber) = @_;
4315
4316     my $dbh = C4::Context->dbh;
4317     my $query = q|
4318         SELECT COUNT(*) FROM issues
4319         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4320         WHERE items.biblionumber = ?
4321         AND issues.borrowernumber = ?
4322     |;
4323     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4324     return 1 if $is_issued;
4325     return;
4326 }
4327
4328 =head2 IsItemIssued
4329
4330   IsItemIssued( $itemnumber )
4331
4332   Return 1 if the item is on loan, otherwise return 0
4333
4334 =cut
4335
4336 sub IsItemIssued {
4337     my $itemnumber = shift;
4338     my $dbh = C4::Context->dbh;
4339     my $sth = $dbh->prepare(q{
4340         SELECT COUNT(*)
4341         FROM issues
4342         WHERE itemnumber = ?
4343     });
4344     $sth->execute($itemnumber);
4345     return $sth->fetchrow;
4346 }
4347
4348 =head2 GetAgeRestriction
4349
4350   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4351   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4352
4353   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4354   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4355
4356 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4357 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4358 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4359          Negative days mean the borrower has gone past the age restriction age.
4360
4361 =cut
4362
4363 sub GetAgeRestriction {
4364     my ($record_restrictions, $borrower) = @_;
4365     my $markers = C4::Context->preference('AgeRestrictionMarker');
4366
4367     return unless $record_restrictions;
4368     # Split $record_restrictions to something like FSK 16 or PEGI 6
4369     my @values = split ' ', uc($record_restrictions);
4370     return unless @values;
4371
4372     # Search first occurrence of one of the markers
4373     my @markers = split /\|/, uc($markers);
4374     return unless @markers;
4375
4376     my $index            = 0;
4377     my $restriction_year = 0;
4378     for my $value (@values) {
4379         $index++;
4380         for my $marker (@markers) {
4381             $marker =~ s/^\s+//;    #remove leading spaces
4382             $marker =~ s/\s+$//;    #remove trailing spaces
4383             if ( $marker eq $value ) {
4384                 if ( $index <= $#values ) {
4385                     $restriction_year += $values[$index];
4386                 }
4387                 last;
4388             }
4389             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4390
4391                 # Perhaps it is something like "K16" (as in Finland)
4392                 $restriction_year += $1;
4393                 last;
4394             }
4395         }
4396         last if ( $restriction_year > 0 );
4397     }
4398
4399     #Check if the borrower is age restricted for this material and for how long.
4400     if ($restriction_year && $borrower) {
4401         if ( $borrower->{'dateofbirth'} ) {
4402             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4403             $alloweddate[0] += $restriction_year;
4404
4405             #Prevent runime eror on leap year (invalid date)
4406             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4407                 $alloweddate[2] = 28;
4408             }
4409
4410             #Get how many days the borrower has to reach the age restriction
4411             my @Today = split /-/, dt_from_string()->ymd();
4412             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4413             #Negative days means the borrower went past the age restriction age
4414             return ($restriction_year, $daysToAgeRestriction);
4415         }
4416     }
4417
4418     return ($restriction_year);
4419 }
4420
4421
4422 =head2 GetPendingOnSiteCheckouts
4423
4424 =cut
4425
4426 sub GetPendingOnSiteCheckouts {
4427     my $dbh = C4::Context->dbh;
4428     return $dbh->selectall_arrayref(q|
4429         SELECT
4430           items.barcode,
4431           items.biblionumber,
4432           items.itemnumber,
4433           items.itemnotes,
4434           items.itemcallnumber,
4435           items.location,
4436           issues.date_due,
4437           issues.branchcode,
4438           issues.date_due < NOW() AS is_overdue,
4439           biblio.author,
4440           biblio.title,
4441           borrowers.firstname,
4442           borrowers.surname,
4443           borrowers.cardnumber,
4444           borrowers.borrowernumber
4445         FROM items
4446         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4447         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4448         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4449         WHERE issues.onsite_checkout = 1
4450     |, { Slice => {} } );
4451 }
4452
4453 sub GetTopIssues {
4454     my ($params) = @_;
4455
4456     my ($count, $branch, $itemtype, $ccode, $newness)
4457         = @$params{qw(count branch itemtype ccode newness)};
4458
4459     my $dbh = C4::Context->dbh;
4460     my $query = q{
4461         SELECT * FROM (
4462         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4463           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4464           i.ccode, SUM(i.issues) AS count
4465         FROM biblio b
4466         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4467         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4468     };
4469
4470     my (@where_strs, @where_args);
4471
4472     if ($branch) {
4473         push @where_strs, 'i.homebranch = ?';
4474         push @where_args, $branch;
4475     }
4476     if ($itemtype) {
4477         if (C4::Context->preference('item-level_itypes')){
4478             push @where_strs, 'i.itype = ?';
4479             push @where_args, $itemtype;
4480         } else {
4481             push @where_strs, 'bi.itemtype = ?';
4482             push @where_args, $itemtype;
4483         }
4484     }
4485     if ($ccode) {
4486         push @where_strs, 'i.ccode = ?';
4487         push @where_args, $ccode;
4488     }
4489     if ($newness) {
4490         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4491         push @where_args, $newness;
4492     }
4493
4494     if (@where_strs) {
4495         $query .= 'WHERE ' . join(' AND ', @where_strs);
4496     }
4497
4498     $query .= q{
4499         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4500           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4501           i.ccode
4502         ORDER BY count DESC
4503     };
4504
4505     $query .= q{ ) xxx WHERE count > 0 };
4506     $count = int($count);
4507     if ($count > 0) {
4508         $query .= "LIMIT $count";
4509     }
4510
4511     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4512
4513     return @$rows;
4514 }
4515
4516 =head2 Internal methods
4517
4518 =cut
4519
4520 sub _CalculateAndUpdateFine {
4521     my ($params) = @_;
4522
4523     my $borrower    = $params->{borrower};
4524     my $item        = $params->{item};
4525     my $issue       = $params->{issue};
4526     my $return_date = $params->{return_date};
4527
4528     unless ($borrower) { carp "No borrower passed in!" && return; }
4529     unless ($item)     { carp "No item passed in!"     && return; }
4530     unless ($issue)    { carp "No issue passed in!"    && return; }
4531
4532     my $datedue = dt_from_string( $issue->date_due );
4533
4534     # we only need to calculate and change the fines if we want to do that on return
4535     # Should be on for hourly loans
4536     my $control = C4::Context->preference('CircControl');
4537     my $branch_type = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
4538     my $control_branchcode =
4539         ( $control eq 'ItemHomeLibrary' ) ? $item->{$branch_type}
4540       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4541       :                                     $issue->branchcode;
4542
4543     my $date_returned = $return_date ? $return_date : dt_from_string();
4544
4545     my ( $amount, $unitcounttotal, $unitcount  ) =
4546       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4547
4548     if ( C4::Context->preference('finesMode') eq 'production' ) {
4549         if ( $amount > 0 ) {
4550             C4::Overdues::UpdateFine({
4551                 issue_id       => $issue->issue_id,
4552                 itemnumber     => $issue->itemnumber,
4553                 borrowernumber => $issue->borrowernumber,
4554                 amount         => $amount,
4555                 due            => $datedue,
4556             });
4557         }
4558         elsif ($return_date) {
4559
4560             # Backdated returns may have fines that shouldn't exist,
4561             # so in this case, we need to drop those fines to 0
4562
4563             C4::Overdues::UpdateFine({
4564                 issue_id       => $issue->issue_id,
4565                 itemnumber     => $issue->itemnumber,
4566                 borrowernumber => $issue->borrowernumber,
4567                 amount         => 0,
4568                 due            => $datedue,
4569             });
4570         }
4571     }
4572 }
4573
4574 sub _CanBookBeAutoRenewed {
4575     my ( $params ) = @_;
4576     my $patron = $params->{patron};
4577     my $item = $params->{item};
4578     my $branchcode = $params->{branchcode};
4579     my $issue = $params->{issue};
4580
4581     return "no" unless $issue->auto_renew && $patron->autorenew_checkouts;
4582
4583     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
4584         {
4585             categorycode => $patron->categorycode,
4586             itemtype     => $item->effective_itemtype,
4587             branchcode   => $branchcode,
4588             rules => [
4589                 'no_auto_renewal_after',
4590                 'no_auto_renewal_after_hard_limit',
4591                 'lengthunit',
4592                 'noautorenewalbefore',
4593             ]
4594         }
4595     );
4596
4597     if ( $patron->is_expired && $patron->category->effective_BlockExpiredPatronOpacActions ) {
4598         return 'auto_account_expired';
4599     }
4600
4601     if ( defined $issuing_rule->{no_auto_renewal_after}
4602             and $issuing_rule->{no_auto_renewal_after} ne "" ) {
4603         # Get issue_date and add no_auto_renewal_after
4604         # If this is greater than today, it's too late for renewal.
4605         my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
4606         $maximum_renewal_date->add(
4607             $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
4608         );
4609         my $now = dt_from_string;
4610         if ( $now >= $maximum_renewal_date ) {
4611             return "auto_too_late";
4612         }
4613     }
4614     if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
4615                   and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
4616         # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
4617         if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
4618             return "auto_too_late";
4619         }
4620     }
4621
4622     if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
4623         my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
4624         my $amountoutstanding =
4625           C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
4626           ? $patron->account->balance
4627           : $patron->account->outstanding_debits->total_outstanding;
4628         if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
4629             return "auto_too_much_oweing";
4630         }
4631     }
4632
4633     my $soonest = GetSoonestRenewDate( $patron, $issue, 1 );
4634     if ( $soonest > dt_from_string() )
4635     {
4636         return ( "auto_too_soon", $soonest );
4637     }
4638
4639     return "ok";
4640 }
4641
4642
4643 1;
4644
4645 __END__
4646
4647 =head1 AUTHOR
4648
4649 Koha Development Team <http://koha-community.org/>
4650
4651 =cut