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