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