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
1556                     if ( $lostreturn_policy eq 'charge' ) {
1557                         $actualissue //= Koha::Old::Checkouts->search(
1558                             { itemnumber => $item_unblessed->{itemnumber} },
1559                             {
1560                                 order_by => { '-desc' => 'returndate' },
1561                                 rows     => 1
1562                             }
1563                         )->single;
1564                         unless ( exists( $borrower->{branchcode} ) ) {
1565                             my $patron = $actualissue->patron;
1566                             $borrower = $patron->unblessed;
1567                         }
1568                         _CalculateAndUpdateFine(
1569                             {
1570                                 issue       => $actualissue,
1571                                 item        => $item_unblessed,
1572                                 borrower    => $borrower,
1573                                 return_date => $issuedate
1574                             }
1575                         );
1576                         _FixOverduesOnReturn( $borrower->{borrowernumber},
1577                             $item_object->itemnumber, undef, 'RENEWED' );
1578                     }
1579                     elsif ( $lostreturn_policy eq 'restore' ) {
1580                         _RestoreOverdueForLostAndFound(
1581                             $item_object->itemnumber );
1582                     }
1583
1584                     if ( C4::Context->preference('AccountAutoReconcile') ) {
1585                         $account->reconcile_balance;
1586                     }
1587                 }
1588
1589             }
1590
1591             # If it costs to borrow this book, charge it to the patron's account.
1592             my ( $charge, $itemtype ) = GetIssuingCharges( $item_object->itemnumber, $borrower->{'borrowernumber'} );
1593             if ( $charge && $charge > 0 ) {
1594                 AddIssuingCharge( $issue, $charge, 'RENT' );
1595             }
1596
1597             my $itemtype_object = Koha::ItemTypes->find( $item_object->effective_itemtype );
1598             if ( $itemtype_object ) {
1599                 my $accumulate_charge = $fees->accumulate_rentalcharge();
1600                 if ( $accumulate_charge > 0 ) {
1601                     AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY' );
1602                     $charge += $accumulate_charge;
1603                     $item_unblessed->{charge} = $charge;
1604                 }
1605             }
1606
1607             # Record the fact that this book was issued.
1608             &UpdateStats(
1609                 {
1610                     branch => C4::Context->userenv->{'branch'},
1611                     type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1612                     amount         => $charge,
1613                     other          => ( $sipmode ? "SIP-$sipmode" : '' ),
1614                     itemnumber     => $item_object->itemnumber,
1615                     itemtype       => $item_object->effective_itemtype,
1616                     location       => $item_object->location,
1617                     borrowernumber => $borrower->{'borrowernumber'},
1618                     ccode          => $item_object->ccode,
1619                 }
1620             );
1621
1622             # Send a checkout slip.
1623             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1624             my %conditions        = (
1625                 branchcode   => $branchcode,
1626                 categorycode => $borrower->{categorycode},
1627                 item_type    => $item_object->effective_itemtype,
1628                 notification => 'CHECKOUT',
1629             );
1630             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
1631                 SendCirculationAlert(
1632                     {
1633                         type     => 'CHECKOUT',
1634                         item     => $item_object->unblessed,
1635                         borrower => $borrower,
1636                         branch   => $branchcode,
1637                     }
1638                 );
1639             }
1640             logaction(
1641                 "CIRCULATION", "ISSUE",
1642                 $borrower->{'borrowernumber'},
1643                 $item_object->itemnumber,
1644             ) if C4::Context->preference("IssueLog");
1645
1646             Koha::Plugins->call('after_circ_action', {
1647                 action  => 'checkout',
1648                 payload => {
1649                     type     => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1650                     checkout => $issue->get_from_storage
1651                 }
1652             });
1653         }
1654     }
1655     return $issue;
1656 }
1657
1658 =head2 GetLoanLength
1659
1660   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1661
1662 Get loan length for an itemtype, a borrower type and a branch
1663
1664 =cut
1665
1666 sub GetLoanLength {
1667     my ( $categorycode, $itemtype, $branchcode ) = @_;
1668
1669     # Initialize default values
1670     my $rules = {
1671         issuelength   => 0,
1672         renewalperiod => 0,
1673         lengthunit    => 'days',
1674     };
1675
1676     my $found = Koha::CirculationRules->get_effective_rules( {
1677         branchcode => $branchcode,
1678         categorycode => $categorycode,
1679         itemtype => $itemtype,
1680         rules => [
1681             'issuelength',
1682             'renewalperiod',
1683             'lengthunit'
1684         ],
1685     } );
1686
1687     # Search for rules!
1688     foreach my $rule_name (keys %$found) {
1689         $rules->{$rule_name} = $found->{$rule_name};
1690     }
1691
1692     return $rules;
1693 }
1694
1695
1696 =head2 GetHardDueDate
1697
1698   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1699
1700 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1701
1702 =cut
1703
1704 sub GetHardDueDate {
1705     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1706
1707     my $rules = Koha::CirculationRules->get_effective_rules(
1708         {
1709             categorycode => $borrowertype,
1710             itemtype     => $itemtype,
1711             branchcode   => $branchcode,
1712             rules        => [ 'hardduedate', 'hardduedatecompare' ],
1713         }
1714     );
1715
1716     if ( defined( $rules->{hardduedate} ) ) {
1717         if ( $rules->{hardduedate} ) {
1718             return ( dt_from_string( $rules->{hardduedate}, 'iso' ), $rules->{hardduedatecompare} );
1719         }
1720         else {
1721             return ( undef, undef );
1722         }
1723     }
1724 }
1725
1726 =head2 GetBranchBorrowerCircRule
1727
1728   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1729
1730 Retrieves circulation rule attributes that apply to the given
1731 branch and patron category, regardless of item type.
1732 The return value is a hashref containing the following key:
1733
1734 patron_maxissueqty - maximum number of loans that a
1735 patron of the given category can have at the given
1736 branch.  If the value is undef, no limit.
1737
1738 patron_maxonsiteissueqty - maximum of on-site checkouts that a
1739 patron of the given category can have at the given
1740 branch.  If the value is undef, no limit.
1741
1742 This will check for different branch/category combinations in the following order:
1743 branch and category
1744 branch only
1745 category only
1746 default branch and category
1747
1748 If no rule has been found in the database, it will default to
1749 the buillt in rule:
1750
1751 patron_maxissueqty - undef
1752 patron_maxonsiteissueqty - undef
1753
1754 C<$branchcode> and C<$categorycode> should contain the
1755 literal branch code and patron category code, respectively - no
1756 wildcards.
1757
1758 =cut
1759
1760 sub GetBranchBorrowerCircRule {
1761     my ( $branchcode, $categorycode ) = @_;
1762
1763     # Initialize default values
1764     my $rules = {
1765         patron_maxissueqty       => undef,
1766         patron_maxonsiteissueqty => undef,
1767     };
1768
1769     # Search for rules!
1770     foreach my $rule_name (qw( patron_maxissueqty patron_maxonsiteissueqty )) {
1771         my $rule = Koha::CirculationRules->get_effective_rule(
1772             {
1773                 categorycode => $categorycode,
1774                 itemtype     => undef,
1775                 branchcode   => $branchcode,
1776                 rule_name    => $rule_name,
1777             }
1778         );
1779
1780         $rules->{$rule_name} = $rule->rule_value if defined $rule;
1781     }
1782
1783     return $rules;
1784 }
1785
1786 =head2 GetBranchItemRule
1787
1788   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1789
1790 Retrieves circulation rule attributes that apply to the given
1791 branch and item type, regardless of patron category.
1792
1793 The return value is a hashref containing the following keys:
1794
1795 holdallowed => Hold policy for this branch and itemtype. Possible values:
1796   0: No holds allowed.
1797   1: Holds allowed only by patrons that have the same homebranch as the item.
1798   2: Holds allowed from any patron.
1799
1800 returnbranch => branch to which to return item.  Possible values:
1801   noreturn: do not return, let item remain where checked in (floating collections)
1802   homebranch: return to item's home branch
1803   holdingbranch: return to issuer branch
1804
1805 This searches branchitemrules in the following order:
1806
1807   * Same branchcode and itemtype
1808   * Same branchcode, itemtype '*'
1809   * branchcode '*', same itemtype
1810   * branchcode and itemtype '*'
1811
1812 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1813
1814 =cut
1815
1816 sub GetBranchItemRule {
1817     my ( $branchcode, $itemtype ) = @_;
1818
1819     # Search for rules!
1820     my $holdallowed_rule = Koha::CirculationRules->get_effective_rule(
1821         {
1822             branchcode => $branchcode,
1823             itemtype => $itemtype,
1824             rule_name => 'holdallowed',
1825         }
1826     );
1827     my $hold_fulfillment_policy_rule = Koha::CirculationRules->get_effective_rule(
1828         {
1829             branchcode => $branchcode,
1830             itemtype => $itemtype,
1831             rule_name => 'hold_fulfillment_policy',
1832         }
1833     );
1834     my $returnbranch_rule = Koha::CirculationRules->get_effective_rule(
1835         {
1836             branchcode => $branchcode,
1837             itemtype => $itemtype,
1838             rule_name => 'returnbranch',
1839         }
1840     );
1841
1842     # built-in default circulation rule
1843     my $rules;
1844     $rules->{holdallowed} = defined $holdallowed_rule
1845         ? $holdallowed_rule->rule_value
1846         : 2;
1847     $rules->{hold_fulfillment_policy} = defined $hold_fulfillment_policy_rule
1848         ? $hold_fulfillment_policy_rule->rule_value
1849         : 'any';
1850     $rules->{returnbranch} = defined $returnbranch_rule
1851         ? $returnbranch_rule->rule_value
1852         : 'homebranch';
1853
1854     return $rules;
1855 }
1856
1857 =head2 AddReturn
1858
1859   ($doreturn, $messages, $iteminformation, $borrower) =
1860       &AddReturn( $barcode, $branch [,$exemptfine] [,$returndate] );
1861
1862 Returns a book.
1863
1864 =over 4
1865
1866 =item C<$barcode> is the bar code of the book being returned.
1867
1868 =item C<$branch> is the code of the branch where the book is being returned.
1869
1870 =item C<$exemptfine> indicates that overdue charges for the item will be
1871 removed. Optional.
1872
1873 =item C<$return_date> allows the default return date to be overridden
1874 by the given return date. Optional.
1875
1876 =back
1877
1878 C<&AddReturn> returns a list of four items:
1879
1880 C<$doreturn> is true iff the return succeeded.
1881
1882 C<$messages> is a reference-to-hash giving feedback on the operation.
1883 The keys of the hash are:
1884
1885 =over 4
1886
1887 =item C<BadBarcode>
1888
1889 No item with this barcode exists. The value is C<$barcode>.
1890
1891 =item C<NotIssued>
1892
1893 The book is not currently on loan. The value is C<$barcode>.
1894
1895 =item C<withdrawn>
1896
1897 This book has been withdrawn/cancelled. The value should be ignored.
1898
1899 =item C<Wrongbranch>
1900
1901 This book has was returned to the wrong branch.  The value is a hashref
1902 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1903 contain the branchcode of the incorrect and correct return library, respectively.
1904
1905 =item C<ResFound>
1906
1907 The item was reserved. The value is a reference-to-hash whose keys are
1908 fields from the reserves table of the Koha database, and
1909 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1910 either C<Waiting>, C<Reserved>, or 0.
1911
1912 =item C<WasReturned>
1913
1914 Value 1 if return is successful.
1915
1916 =item C<NeedsTransfer>
1917
1918 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1919
1920 =back
1921
1922 C<$iteminformation> is a reference-to-hash, giving information about the
1923 returned item from the issues table.
1924
1925 C<$borrower> is a reference-to-hash, giving information about the
1926 patron who last borrowed the book.
1927
1928 =cut
1929
1930 sub AddReturn {
1931     my ( $barcode, $branch, $exemptfine, $return_date ) = @_;
1932
1933     if ($branch and not Koha::Libraries->find($branch)) {
1934         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1935         undef $branch;
1936     }
1937     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1938     my $return_date_specified = !!$return_date;
1939     $return_date //= dt_from_string();
1940     my $messages;
1941     my $patron;
1942     my $doreturn       = 1;
1943     my $validTransfer = 1;
1944     my $stat_type = 'return';
1945
1946     # get information on item
1947     my $item = Koha::Items->find({ barcode => $barcode });
1948     unless ($item) {
1949         return ( 0, { BadBarcode => $barcode } );    # no barcode means no item or borrower.  bail out.
1950     }
1951
1952     my $itemnumber = $item->itemnumber;
1953     my $itemtype = $item->effective_itemtype;
1954
1955     my $issue  = $item->checkout;
1956     if ( $issue ) {
1957         $patron = $issue->patron
1958             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '" . $issue->borrowernumber . "'\n"
1959                 . Dumper($issue->unblessed) . "\n";
1960     } else {
1961         $messages->{'NotIssued'} = $barcode;
1962         $item->onloan(undef)->store({skip_record_index=>1}) if defined $item->onloan;
1963
1964         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1965         $doreturn = 0;
1966         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1967         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1968         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1969            $messages->{'LocalUse'} = 1;
1970            $stat_type = 'localuse';
1971         }
1972     }
1973
1974         # full item data, but no borrowernumber or checkout info (no issue)
1975     my $hbr = GetBranchItemRule($item->homebranch, $itemtype)->{'returnbranch'} || "homebranch";
1976         # get the proper branch to which to return the item
1977     my $returnbranch = $hbr ne 'noreturn' ? $item->$hbr : $branch;
1978         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1979     my $transfer_trigger = $hbr eq 'homebranch' ? 'ReturnToHome' : $hbr eq 'holdingbranch' ? 'ReturnToHolding' : undef;
1980
1981     my $borrowernumber = $patron ? $patron->borrowernumber : undef;    # we don't know if we had a borrower or not
1982     my $patron_unblessed = $patron ? $patron->unblessed : {};
1983
1984     my $update_loc_rules = get_yaml_pref_hash('UpdateItemLocationOnCheckin');
1985     map { $update_loc_rules->{$_} = $update_loc_rules->{$_}[0] } keys %$update_loc_rules; #We can only move to one location so we flatten the arrays
1986     if ($update_loc_rules) {
1987         if (defined $update_loc_rules->{_ALL_}) {
1988             if ($update_loc_rules->{_ALL_} eq '_PERM_') { $update_loc_rules->{_ALL_} = $item->permanent_location; }
1989             if ($update_loc_rules->{_ALL_} eq '_BLANK_') { $update_loc_rules->{_ALL_} = ''; }
1990             if ( defined $item->location && $item->location ne $update_loc_rules->{_ALL_}) {
1991                 $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{_ALL_} };
1992                 $item->location($update_loc_rules->{_ALL_})->store({skip_record_index=>1});
1993             }
1994         }
1995         else {
1996             foreach my $key ( keys %$update_loc_rules ) {
1997                 if ( $update_loc_rules->{$key} eq '_PERM_' ) { $update_loc_rules->{$key} = $item->permanent_location; }
1998                 if ( $update_loc_rules->{$key} eq '_BLANK_') { $update_loc_rules->{$key} = '' ;}
1999                 if ( ($item->location eq $key && $item->location ne $update_loc_rules->{$key}) || ($key eq '_BLANK_' && $item->location eq '' && $update_loc_rules->{$key} ne '') ) {
2000                     $messages->{'ItemLocationUpdated'} = { from => $item->location, to => $update_loc_rules->{$key} };
2001                     $item->location($update_loc_rules->{$key})->store({skip_record_index=>1});
2002                     last;
2003                 }
2004             }
2005         }
2006     }
2007
2008     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
2009     if ($yaml) {
2010         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
2011         my $rules;
2012         eval { $rules = YAML::Load($yaml); };
2013         if ($@) {
2014             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
2015         }
2016         else {
2017             foreach my $key ( keys %$rules ) {
2018                 if ( $item->notforloan eq $key ) {
2019                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->notforloan, to => $rules->{$key} };
2020                     $item->notforloan($rules->{$key})->store({ log_action => 0, skip_record_index => 1 });
2021                     last;
2022                 }
2023             }
2024         }
2025     }
2026
2027     # check if the return is allowed at this branch
2028     my ($returnallowed, $message) = CanBookBeReturned($item->unblessed, $branch);
2029     unless ($returnallowed){
2030         $messages->{'Wrongbranch'} = {
2031             Wrongbranch => $branch,
2032             Rightbranch => $message
2033         };
2034         $doreturn = 0;
2035         my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2036         $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2037         return ( $doreturn, $messages, $issue, $patron_unblessed);
2038     }
2039
2040     if ( $item->withdrawn ) { # book has been cancelled
2041         $messages->{'withdrawn'} = 1;
2042         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
2043     }
2044
2045     if ( $item->itemlost and C4::Context->preference("BlockReturnOfLostItems") ) {
2046         $doreturn = 0;
2047     }
2048
2049     # case of a return of document (deal with issues and holdingbranch)
2050     if ($doreturn) {
2051         die "The item is not issed and cannot be returned" unless $issue; # Just in case...
2052         $patron or warn "AddReturn without current borrower";
2053
2054         if ($patron) {
2055             eval {
2056                 MarkIssueReturned( $borrowernumber, $item->itemnumber, $return_date, $patron->privacy, { skip_record_index => 1} );
2057             };
2058             unless ( $@ ) {
2059                 if (
2060                     (
2061                         C4::Context->preference('CalculateFinesOnReturn')
2062                         || ( $return_date_specified && C4::Context->preference('CalculateFinesOnBackdate') )
2063                     )
2064                     && !$item->itemlost
2065                   )
2066                 {
2067                     _CalculateAndUpdateFine( { issue => $issue, item => $item->unblessed, borrower => $patron_unblessed, return_date => $return_date } );
2068                 }
2069             } else {
2070                 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 );
2071
2072                 my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2073                 $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2074
2075                 return ( 0, { WasReturned => 0, DataCorrupted => 1 }, $issue, $patron_unblessed );
2076             }
2077
2078             # FIXME is the "= 1" right?  This could be the borrower hash.
2079             $messages->{'WasReturned'} = 1;
2080
2081         } else {
2082             $item->onloan(undef)->store({ log_action => 0 , skip_record_index => 1 });
2083         }
2084     }
2085
2086     # the holdingbranch is updated if the document is returned to another location.
2087     # this is always done regardless of whether the item was on loan or not
2088     if ($item->holdingbranch ne $branch) {
2089         $item->holdingbranch($branch)->store({ skip_record_index => 1 });
2090     }
2091
2092     my $item_was_lost = $item->itemlost;
2093     my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
2094     my $updated_item = ModDateLastSeen( $item->itemnumber, $leave_item_lost, { skip_record_index => 1 } ); # will unset itemlost if needed
2095
2096     # fix up the accounts.....
2097     if ( $item_was_lost ) {
2098         $messages->{'WasLost'} = 1;
2099         unless ( C4::Context->preference("BlockReturnOfLostItems") ) {
2100             $messages->{'LostItemFeeRefunded'} = $updated_item->{_refunded};
2101
2102             my $lostreturn_policy =
2103               Koha::CirculationRules->get_lostreturn_policy(
2104                 {
2105                     return_branch => C4::Context->userenv->{branch},
2106                     item          => $updated_item
2107                 }
2108               );
2109
2110             if ($lostreturn_policy) {
2111
2112                 if ( $lostreturn_policy eq 'charge' ) {
2113                     $issue //= Koha::Old::Checkouts->search(
2114                         { itemnumber => $item->itemnumber },
2115                         { order_by   => { '-desc' => 'returndate' }, rows => 1 }
2116                     )->single;
2117                     unless (exists($patron_unblessed->{branchcode})) {
2118                         my $patron = $issue->patron;
2119                         $patron_unblessed = $patron->unblessed;
2120                     }
2121                     _CalculateAndUpdateFine(
2122                         {
2123                             issue       => $issue,
2124                             item        => $item->unblessed,
2125                             borrower    => $patron_unblessed,
2126                             return_date => $return_date
2127                         }
2128                     );
2129                     _FixOverduesOnReturn( $patron_unblessed->{borrowernumber},
2130                         $item->itemnumber, undef, 'RETURNED' );
2131                     $messages->{'LostItemFeeCharged'} = 1;
2132                 }
2133                 elsif ( $lostreturn_policy eq 'restore' ) {
2134                     _RestoreOverdueForLostAndFound( $item->itemnumber );
2135                     $messages->{'LostItemFeeRestored'} = 1;
2136                 }
2137             }
2138         }
2139     }
2140
2141     # check if we have a transfer for this document
2142     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->itemnumber );
2143
2144     # if we have a transfer to complete, we update the line of transfers with the datearrived
2145     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->itemnumber );
2146     if ($datesent) {
2147         # At this point we will either fill the transfer or it is a wrong transfer
2148         # either way we should not now generate a new transfer
2149         $validTransfer = 0;
2150         if ( $tobranch eq $branch ) {
2151             my $sth = C4::Context->dbh->prepare(
2152                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2153             );
2154             $sth->execute( $item->itemnumber );
2155             $messages->{'TransferArrived'} = $frombranch;
2156         } else {
2157             $messages->{'WrongTransfer'}     = $tobranch;
2158             $messages->{'WrongTransferItem'} = $item->itemnumber;
2159         }
2160     }
2161
2162     # fix up the overdues in accounts...
2163     if ($borrowernumber) {
2164         my $fix = _FixOverduesOnReturn( $borrowernumber, $item->itemnumber, $exemptfine, 'RETURNED' );
2165         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, ".$item->itemnumber."...) failed!";  # zero is OK, check defined
2166
2167         if ( $issue and $issue->is_overdue($return_date) ) {
2168         # fix fine days
2169             my ($debardate,$reminder) = _debar_user_on_return( $patron_unblessed, $item->unblessed, dt_from_string($issue->date_due), $return_date );
2170             if ($reminder){
2171                 $messages->{'PrevDebarred'} = $debardate;
2172             } else {
2173                 $messages->{'Debarred'} = $debardate if $debardate;
2174             }
2175         # there's no overdue on the item but borrower had been previously debarred
2176         } elsif ( $issue->date_due and $patron->debarred ) {
2177              if ( $patron->debarred eq "9999-12-31") {
2178                 $messages->{'ForeverDebarred'} = $patron->debarred;
2179              } else {
2180                   my $borrower_debar_dt = dt_from_string( $patron->debarred );
2181                   $borrower_debar_dt->truncate(to => 'day');
2182                   my $today_dt = $return_date->clone()->truncate(to => 'day');
2183                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2184                       $messages->{'PrevDebarred'} = $patron->debarred;
2185                   }
2186              }
2187         }
2188     }
2189
2190     # find reserves.....
2191     # launch the Checkreserves routine to find any holds
2192     my ($resfound, $resrec);
2193     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2194     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->itemnumber, undef, $lookahead ) unless ( $item->withdrawn );
2195     # 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)
2196     if ( $resfound and $resfound eq "Waiting" and $branch ne $resrec->{branchcode} ) {
2197         my $hold = C4::Reserves::RevertWaitingStatus( { itemnumber => $item->itemnumber } );
2198         $resfound = 'Reserved';
2199         $resrec = $hold->unblessed;
2200     }
2201     if ($resfound) {
2202           $resrec->{'ResFound'} = $resfound;
2203         $messages->{'ResFound'} = $resrec;
2204     }
2205
2206     # Record the fact that this book was returned.
2207     UpdateStats({
2208         branch         => $branch,
2209         type           => $stat_type,
2210         itemnumber     => $itemnumber,
2211         itemtype       => $itemtype,
2212         location       => $item->location,
2213         borrowernumber => $borrowernumber,
2214         ccode          => $item->ccode,
2215     });
2216
2217     # Send a check-in slip. # NOTE: borrower may be undef. Do not try to send messages then.
2218     if ( $patron ) {
2219         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2220         my %conditions = (
2221             branchcode   => $branch,
2222             categorycode => $patron->categorycode,
2223             item_type    => $itemtype,
2224             notification => 'CHECKIN',
2225         );
2226         if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2227             SendCirculationAlert({
2228                 type     => 'CHECKIN',
2229                 item     => $item->unblessed,
2230                 borrower => $patron->unblessed,
2231                 branch   => $branch,
2232             });
2233         }
2234
2235         logaction("CIRCULATION", "RETURN", $borrowernumber, $item->itemnumber)
2236             if C4::Context->preference("ReturnLog");
2237         }
2238
2239     # Check if this item belongs to a biblio record that is attached to an
2240     # ILL request, if it is we need to update the ILL request's status
2241     if ( $doreturn and C4::Context->preference('CirculateILL')) {
2242         my $request = Koha::Illrequests->find(
2243             { biblio_id => $item->biblio->biblionumber }
2244         );
2245         $request->status('RET') if $request;
2246     }
2247
2248     # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2249     if ($validTransfer && !$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) ){
2250         my $BranchTransferLimitsType = C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ? 'effective_itemtype' : 'ccode';
2251         if  (C4::Context->preference("AutomaticItemReturn"    ) or
2252             (C4::Context->preference("UseBranchTransferLimits") and
2253              ! IsBranchTransferAllowed($branch, $returnbranch, $item->$BranchTransferLimitsType )
2254            )) {
2255             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s, %s)", $item->itemnumber,$branch, $returnbranch, $transfer_trigger;
2256             $debug and warn "item: " . Dumper($item->unblessed);
2257             ModItemTransfer($item->itemnumber, $branch, $returnbranch, $transfer_trigger, { skip_record_index => 1 });
2258             $messages->{'WasTransfered'} = 1;
2259         } else {
2260             $messages->{'NeedsTransfer'} = $returnbranch;
2261             $messages->{'TransferTrigger'} = $transfer_trigger;
2262         }
2263     }
2264
2265     if ( C4::Context->preference('ClaimReturnedLostValue') ) {
2266         my $claims = Koha::Checkouts::ReturnClaims->search(
2267            {
2268                itemnumber => $item->id,
2269                resolution => undef,
2270            }
2271         );
2272
2273         if ( $claims->count ) {
2274             $messages->{ReturnClaims} = $claims;
2275         }
2276     }
2277
2278     my $indexer = Koha::SearchEngine::Indexer->new({ index => $Koha::SearchEngine::BIBLIOS_INDEX });
2279     $indexer->index_records( $item->biblionumber, "specialUpdate", "biblioserver" );
2280
2281     if ( $doreturn and $issue ) {
2282         my $checkin = Koha::Old::Checkouts->find($issue->id);
2283
2284         Koha::Plugins->call('after_circ_action', {
2285             action  => 'checkin',
2286             payload => {
2287                 checkout=> $checkin
2288             }
2289         });
2290     }
2291
2292     return ( $doreturn, $messages, $issue, ( $patron ? $patron->unblessed : {} ));
2293 }
2294
2295 =head2 MarkIssueReturned
2296
2297   MarkIssueReturned($borrowernumber, $itemnumber, $returndate, $privacy, [$params] );
2298
2299 Unconditionally marks an issue as being returned by
2300 moving the C<issues> row to C<old_issues> and
2301 setting C<returndate> to the current date.
2302
2303 if C<$returndate> is specified (in iso format), it is used as the date
2304 of the return.
2305
2306 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2307 the old_issue is immediately anonymised
2308
2309 Ideally, this function would be internal to C<C4::Circulation>,
2310 not exported, but it is currently used in misc/cronjobs/longoverdue.pl
2311 and offline_circ/process_koc.pl.
2312
2313 The last optional parameter allos passing skip_record_index to the item store call.
2314
2315 =cut
2316
2317 sub MarkIssueReturned {
2318     my ( $borrowernumber, $itemnumber, $returndate, $privacy, $params ) = @_;
2319
2320     # Retrieve the issue
2321     my $issue = Koha::Checkouts->find( { itemnumber => $itemnumber } ) or return;
2322
2323     return unless $issue->borrowernumber == $borrowernumber; # If the item is checked out to another patron we do not return it
2324
2325     my $issue_id = $issue->issue_id;
2326
2327     my $anonymouspatron;
2328     if ( $privacy && $privacy == 2 ) {
2329         # The default of 0 will not work due to foreign key constraints
2330         # The anonymisation will fail if AnonymousPatron is not a valid entry
2331         # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2332         # Note that a warning should appear on the about page (System information tab).
2333         $anonymouspatron = C4::Context->preference('AnonymousPatron');
2334         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."
2335             unless Koha::Patrons->find( $anonymouspatron );
2336     }
2337
2338     my $schema = Koha::Database->schema;
2339
2340     # FIXME Improve the return value and handle it from callers
2341     $schema->txn_do(sub {
2342
2343         my $patron = Koha::Patrons->find( $borrowernumber );
2344
2345         # Update the returndate value
2346         if ( $returndate ) {
2347             $issue->returndate( $returndate )->store->discard_changes; # update and refetch
2348         }
2349         else {
2350             $issue->returndate( \'NOW()' )->store->discard_changes; # update and refetch
2351         }
2352
2353         # Create the old_issues entry
2354         my $old_checkout = Koha::Old::Checkout->new($issue->unblessed)->store;
2355
2356         # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2357         if ( $privacy && $privacy == 2) {
2358             $old_checkout->borrowernumber($anonymouspatron)->store;
2359         }
2360
2361         # And finally delete the issue
2362         $issue->delete;
2363
2364         $issue->item->onloan(undef)->store({ log_action => 0, skip_record_index => $params->{skip_record_index} });
2365
2366         if ( C4::Context->preference('StoreLastBorrower') ) {
2367             my $item = Koha::Items->find( $itemnumber );
2368             $item->last_returned_by( $patron );
2369         }
2370
2371         # Remove any OVERDUES related debarment if the borrower has no overdues
2372         if ( C4::Context->preference('AutoRemoveOverduesRestrictions')
2373           && $patron->debarred
2374           && !$patron->has_overdues
2375           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2376         ) {
2377             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2378         }
2379
2380     });
2381
2382     return $issue_id;
2383 }
2384
2385 =head2 _debar_user_on_return
2386
2387     _debar_user_on_return($borrower, $item, $datedue, $returndate);
2388
2389 C<$borrower> borrower hashref
2390
2391 C<$item> item hashref
2392
2393 C<$datedue> date due DateTime object
2394
2395 C<$returndate> DateTime object representing the return time
2396
2397 Internal function, called only by AddReturn that calculates and updates
2398  the user fine days, and debars them if necessary.
2399
2400 Should only be called for overdue returns
2401
2402 Calculation of the debarment date has been moved to a separate subroutine _calculate_new_debar_dt
2403 to ease testing.
2404
2405 =cut
2406
2407 sub _calculate_new_debar_dt {
2408     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2409
2410     my $branchcode = _GetCircControlBranch( $item, $borrower );
2411     my $circcontrol = C4::Context->preference('CircControl');
2412     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2413         {   categorycode => $borrower->{categorycode},
2414             itemtype     => $item->{itype},
2415             branchcode   => $branchcode,
2416             rules => [
2417                 'finedays',
2418                 'lengthunit',
2419                 'firstremind',
2420                 'maxsuspensiondays',
2421                 'suspension_chargeperiod',
2422             ]
2423         }
2424     );
2425     my $finedays = $issuing_rule ? $issuing_rule->{finedays} : undef;
2426     my $unit     = $issuing_rule ? $issuing_rule->{lengthunit} : undef;
2427     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $return_date, $branchcode);
2428
2429     return unless $finedays;
2430
2431     # finedays is in days, so hourly loans must multiply by 24
2432     # thus 1 hour late equals 1 day suspension * finedays rate
2433     $finedays = $finedays * 24 if ( $unit eq 'hours' );
2434
2435     # grace period is measured in the same units as the loan
2436     my $grace =
2437       DateTime::Duration->new( $unit => $issuing_rule->{firstremind} // 0);
2438
2439     my $deltadays = DateTime::Duration->new(
2440         days => $chargeable_units
2441     );
2442
2443     if ( $deltadays->subtract($grace)->is_positive() ) {
2444         my $suspension_days = $deltadays * $finedays;
2445
2446         if ( defined $issuing_rule->{suspension_chargeperiod} && $issuing_rule->{suspension_chargeperiod} > 1 ) {
2447             # No need to / 1 and do not consider / 0
2448             $suspension_days = DateTime::Duration->new(
2449                 days => floor( $suspension_days->in_units('days') / $issuing_rule->{suspension_chargeperiod} )
2450             );
2451         }
2452
2453         # If the max suspension days is < than the suspension days
2454         # the suspension days is limited to this maximum period.
2455         my $max_sd = $issuing_rule->{maxsuspensiondays};
2456         if ( defined $max_sd && $max_sd ne '' ) {
2457             $max_sd = DateTime::Duration->new( days => $max_sd );
2458             $suspension_days = $max_sd
2459               if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2460         }
2461
2462         my ( $has_been_extended );
2463         if ( C4::Context->preference('CumulativeRestrictionPeriods') and $borrower->{debarred} ) {
2464             my $debarment = @{ GetDebarments( { borrowernumber => $borrower->{borrowernumber}, type => 'SUSPENSION' } ) }[0];
2465             if ( $debarment ) {
2466                 $return_date = dt_from_string( $debarment->{expiration}, 'sql' );
2467                 $has_been_extended = 1;
2468             }
2469         }
2470
2471         my $new_debar_dt;
2472         # Use the calendar or not to calculate the debarment date
2473         if ( C4::Context->preference('SuspensionsCalendar') eq 'noSuspensionsWhenClosed' ) {
2474             my $calendar = Koha::Calendar->new(
2475                 branchcode => $branchcode,
2476                 days_mode  => 'Calendar'
2477             );
2478             $new_debar_dt = $calendar->addDate( $return_date, $suspension_days );
2479         }
2480         else {
2481             $new_debar_dt = $return_date->clone()->add_duration($suspension_days);
2482         }
2483         return $new_debar_dt;
2484     }
2485     return;
2486 }
2487
2488 sub _debar_user_on_return {
2489     my ( $borrower, $item, $dt_due, $return_date ) = @_;
2490
2491     $return_date //= dt_from_string();
2492
2493     my $new_debar_dt = _calculate_new_debar_dt ($borrower, $item, $dt_due, $return_date);
2494
2495     return unless $new_debar_dt;
2496
2497     Koha::Patron::Debarments::AddUniqueDebarment({
2498         borrowernumber => $borrower->{borrowernumber},
2499         expiration     => $new_debar_dt->ymd(),
2500         type           => 'SUSPENSION',
2501     });
2502     # if borrower was already debarred but does not get an extra debarment
2503     my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
2504     my ($new_debarment_str, $is_a_reminder);
2505     if ( $borrower->{debarred} && $borrower->{debarred} eq $patron->is_debarred ) {
2506         $is_a_reminder = 1;
2507         $new_debarment_str = $borrower->{debarred};
2508     } else {
2509         $new_debarment_str = $new_debar_dt->ymd();
2510     }
2511     # FIXME Should return a DateTime object
2512     return $new_debarment_str, $is_a_reminder;
2513 }
2514
2515 =head2 _FixOverduesOnReturn
2516
2517    &_FixOverduesOnReturn($borrowernumber, $itemnumber, $exemptfine, $status);
2518
2519 C<$borrowernumber> borrowernumber
2520
2521 C<$itemnumber> itemnumber
2522
2523 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2524
2525 C<$status> ENUM -- reason for fix [ RETURNED, RENEWED, LOST, FORGIVEN ]
2526
2527 Internal function
2528
2529 =cut
2530
2531 sub _FixOverduesOnReturn {
2532     my ( $borrowernumber, $item, $exemptfine, $status ) = @_;
2533     unless( $borrowernumber ) {
2534         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2535         return;
2536     }
2537     unless( $item ) {
2538         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2539         return;
2540     }
2541     unless( $status ) {
2542         warn "_FixOverduesOnReturn() not supplied valid status";
2543         return;
2544     }
2545
2546     my $schema = Koha::Database->schema;
2547
2548     my $result = $schema->txn_do(
2549         sub {
2550             # check for overdue fine
2551             my $accountlines = Koha::Account::Lines->search(
2552                 {
2553                     borrowernumber  => $borrowernumber,
2554                     itemnumber      => $item,
2555                     debit_type_code => 'OVERDUE',
2556                     status          => 'UNRETURNED'
2557                 }
2558             );
2559             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2560
2561             my $accountline = $accountlines->next;
2562             my $payments = $accountline->credits;
2563
2564             my $amountoutstanding = $accountline->amountoutstanding;
2565             if ( $accountline->amount == 0 && $payments->count == 0 ) {
2566                 $accountline->delete;
2567                 return 0; # no warning, we've just removed a zero value fine (backdated return)
2568             } elsif ($exemptfine && ($amountoutstanding != 0)) {
2569                 my $account = Koha::Account->new({patron_id => $borrowernumber});
2570                 my $credit = $account->add_credit(
2571                     {
2572                         amount     => $amountoutstanding,
2573                         user_id    => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
2574                         library_id => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
2575                         interface  => C4::Context->interface,
2576                         type       => 'FORGIVEN',
2577                         item_id    => $item
2578                     }
2579                 );
2580
2581                 $credit->apply({ debits => [ $accountline ], offset_type => 'Forgiven' });
2582
2583                 if (C4::Context->preference("FinesLog")) {
2584                     &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2585                 }
2586             }
2587
2588             $accountline->status($status);
2589             return $accountline->store();
2590         }
2591     );
2592
2593     return $result;
2594 }
2595
2596 =head2 _RestoreOverdueForLostAndFound
2597
2598    &_RestoreOverdueForLostAndFound( $itemnumber );
2599
2600 C<$itemnumber> itemnumber
2601
2602 Internal function
2603
2604 =cut
2605
2606 sub _RestoreOverdueForLostAndFound {
2607     my ( $item ) = @_;
2608
2609     unless( $item ) {
2610         warn "_RestoreOverdueForLostAndFound() not supplied valid itemnumber";
2611         return;
2612     }
2613
2614     my $schema = Koha::Database->schema;
2615
2616     my $result = $schema->txn_do(
2617         sub {
2618             # check for lost overdue fine
2619             my $accountlines = Koha::Account::Lines->search(
2620                 {
2621                     itemnumber      => $item,
2622                     debit_type_code => 'OVERDUE',
2623                     status          => 'LOST'
2624                 },
2625                 {
2626                     order_by => { '-desc' => 'date' },
2627                     rows     => 1
2628                 }
2629             );
2630             return 0 unless $accountlines->count; # no warning, there's just nothing to fix
2631
2632             # Update status of fine
2633             my $overdue = $accountlines->next;
2634             $overdue->status('RETURNED')->store();
2635
2636             # Find related forgive credit
2637             my $refunds = $overdue->credits(
2638                 {
2639                     credit_type_code => 'FORGIVEN',
2640                     itemnumber       => $item,
2641                     status           => [ { '!=' => 'VOID' }, undef ]
2642                 },
2643                 { order_by => { '-desc' => 'date' }, rows => 1 }
2644             );
2645             return 0 unless $refunds->count; # no warning, there's just nothing to fix
2646
2647             # Revert the forgive credit
2648             my $refund = $refunds->next;
2649             return $refund->void();
2650         }
2651     );
2652
2653     return $result;
2654 }
2655
2656 =head2 _GetCircControlBranch
2657
2658    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2659
2660 Internal function :
2661
2662 Return the library code to be used to determine which circulation
2663 policy applies to a transaction.  Looks up the CircControl and
2664 HomeOrHoldingBranch system preferences.
2665
2666 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2667
2668 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2669
2670 =cut
2671
2672 sub _GetCircControlBranch {
2673     my ($item, $borrower) = @_;
2674     my $circcontrol = C4::Context->preference('CircControl');
2675     my $branch;
2676
2677     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2678         $branch= C4::Context->userenv->{'branch'};
2679     } elsif ($circcontrol eq 'PatronLibrary') {
2680         $branch=$borrower->{branchcode};
2681     } else {
2682         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2683         $branch = $item->{$branchfield};
2684         # default to item home branch if holdingbranch is used
2685         # and is not defined
2686         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2687             $branch = $item->{homebranch};
2688         }
2689     }
2690     return $branch;
2691 }
2692
2693 =head2 GetOpenIssue
2694
2695   $issue = GetOpenIssue( $itemnumber );
2696
2697 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2698
2699 C<$itemnumber> is the item's itemnumber
2700
2701 Returns a hashref
2702
2703 =cut
2704
2705 sub GetOpenIssue {
2706   my ( $itemnumber ) = @_;
2707   return unless $itemnumber;
2708   my $dbh = C4::Context->dbh;
2709   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2710   $sth->execute( $itemnumber );
2711   return $sth->fetchrow_hashref();
2712
2713 }
2714
2715 =head2 GetBiblioIssues
2716
2717   $issues = GetBiblioIssues($biblionumber);
2718
2719 this function get all issues from a biblionumber.
2720
2721 Return:
2722 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash contains all column from
2723 tables issues and the firstname,surname & cardnumber from borrowers.
2724
2725 =cut
2726
2727 sub GetBiblioIssues {
2728     my $biblionumber = shift;
2729     return unless $biblionumber;
2730     my $dbh   = C4::Context->dbh;
2731     my $query = "
2732         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2733         FROM issues
2734             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2735             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2736             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2737             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2738         WHERE biblio.biblionumber = ?
2739         UNION ALL
2740         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2741         FROM old_issues
2742             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2743             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2744             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2745             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2746         WHERE biblio.biblionumber = ?
2747         ORDER BY timestamp
2748     ";
2749     my $sth = $dbh->prepare($query);
2750     $sth->execute($biblionumber, $biblionumber);
2751
2752     my @issues;
2753     while ( my $data = $sth->fetchrow_hashref ) {
2754         push @issues, $data;
2755     }
2756     return \@issues;
2757 }
2758
2759 =head2 GetUpcomingDueIssues
2760
2761   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2762
2763 =cut
2764
2765 sub GetUpcomingDueIssues {
2766     my $params = shift;
2767
2768     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2769     my $dbh = C4::Context->dbh;
2770
2771     my $statement = <<END_SQL;
2772 SELECT *
2773 FROM (
2774     SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2775     FROM issues
2776     LEFT JOIN items USING (itemnumber)
2777     LEFT OUTER JOIN branches USING (branchcode)
2778     WHERE returndate is NULL
2779 ) tmp
2780 WHERE days_until_due >= 0 AND days_until_due <= ?
2781 END_SQL
2782
2783     my @bind_parameters = ( $params->{'days_in_advance'} );
2784
2785     my $sth = $dbh->prepare( $statement );
2786     $sth->execute( @bind_parameters );
2787     my $upcoming_dues = $sth->fetchall_arrayref({});
2788
2789     return $upcoming_dues;
2790 }
2791
2792 =head2 CanBookBeRenewed
2793
2794   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2795
2796 Find out whether a borrowed item may be renewed.
2797
2798 C<$borrowernumber> is the borrower number of the patron who currently
2799 has the item on loan.
2800
2801 C<$itemnumber> is the number of the item to renew.
2802
2803 C<$override_limit>, if supplied with a true value, causes
2804 the limit on the number of times that the loan can be renewed
2805 (as controlled by the item type) to be ignored. Overriding also allows
2806 to renew sooner than "No renewal before" and to manually renew loans
2807 that are automatically renewed.
2808
2809 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2810 item must currently be on loan to the specified borrower; renewals
2811 must be allowed for the item's type; and the borrower must not have
2812 already renewed the loan. $error will contain the reason the renewal can not proceed
2813
2814 =cut
2815
2816 sub CanBookBeRenewed {
2817     my ( $borrowernumber, $itemnumber, $override_limit, $cron ) = @_;
2818
2819     my $dbh    = C4::Context->dbh;
2820     my $renews = 1;
2821     my $auto_renew = "no";
2822
2823     my $item      = Koha::Items->find($itemnumber)      or return ( 0, 'no_item' );
2824     my $issue = $item->checkout or return ( 0, 'no_checkout' );
2825     return ( 0, 'onsite_checkout' ) if $issue->onsite_checkout;
2826     return ( 0, 'item_denied_renewal') if _item_denied_renewal({ item => $item });
2827
2828     my $patron = $issue->patron or return;
2829
2830     # override_limit will override anything else except on_reserve
2831     unless ( $override_limit ){
2832         my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
2833         my $issuing_rule = Koha::CirculationRules->get_effective_rules(
2834             {
2835                 categorycode => $patron->categorycode,
2836                 itemtype     => $item->effective_itemtype,
2837                 branchcode   => $branchcode,
2838                 rules => [
2839                     'renewalsallowed',
2840                     'no_auto_renewal_after',
2841                     'no_auto_renewal_after_hard_limit',
2842                     'lengthunit',
2843                     'norenewalbefore',
2844                 ]
2845             }
2846         );
2847
2848         return ( 0, "too_many" )
2849           if not $issuing_rule->{renewalsallowed} or $issuing_rule->{renewalsallowed} <= $issue->renewals;
2850
2851         my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2852         my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2853         $patron         = Koha::Patrons->find($borrowernumber); # FIXME Is this really useful?
2854         my $restricted  = $patron->is_debarred;
2855         my $hasoverdues = $patron->has_overdues;
2856
2857         if ( $restricted and $restrictionblockrenewing ) {
2858             return ( 0, 'restriction');
2859         } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($issue->is_overdue and $overduesblockrenewing eq 'blockitem') ) {
2860             return ( 0, 'overdue');
2861         }
2862
2863         if ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2864
2865             if ( $patron->category->effective_BlockExpiredPatronOpacActions and $patron->is_expired ) {
2866                 return ( 0, 'auto_account_expired' );
2867             }
2868
2869             if ( defined $issuing_rule->{no_auto_renewal_after}
2870                     and $issuing_rule->{no_auto_renewal_after} ne "" ) {
2871                 # Get issue_date and add no_auto_renewal_after
2872                 # If this is greater than today, it's too late for renewal.
2873                 my $maximum_renewal_date = dt_from_string($issue->issuedate, 'sql');
2874                 $maximum_renewal_date->add(
2875                     $issuing_rule->{lengthunit} => $issuing_rule->{no_auto_renewal_after}
2876                 );
2877                 my $now = dt_from_string;
2878                 if ( $now >= $maximum_renewal_date ) {
2879                     return ( 0, "auto_too_late" );
2880                 }
2881             }
2882             if ( defined $issuing_rule->{no_auto_renewal_after_hard_limit}
2883                           and $issuing_rule->{no_auto_renewal_after_hard_limit} ne "" ) {
2884                 # If no_auto_renewal_after_hard_limit is >= today, it's also too late for renewal
2885                 if ( dt_from_string >= dt_from_string( $issuing_rule->{no_auto_renewal_after_hard_limit} ) ) {
2886                     return ( 0, "auto_too_late" );
2887                 }
2888             }
2889
2890             if ( C4::Context->preference('OPACFineNoRenewalsBlockAutoRenew') ) {
2891                 my $fine_no_renewals = C4::Context->preference("OPACFineNoRenewals");
2892                 my $amountoutstanding =
2893                   C4::Context->preference("OPACFineNoRenewalsIncludeCredit")
2894                   ? $patron->account->balance
2895                   : $patron->account->outstanding_debits->total_outstanding;
2896                 if ( $amountoutstanding and $amountoutstanding > $fine_no_renewals ) {
2897                     return ( 0, "auto_too_much_oweing" );
2898                 }
2899             }
2900         }
2901
2902         if ( defined $issuing_rule->{norenewalbefore}
2903             and $issuing_rule->{norenewalbefore} ne "" )
2904         {
2905
2906             # Calculate soonest renewal by subtracting 'No renewal before' from due date
2907             my $soonestrenewal = dt_from_string( $issue->date_due, 'sql' )->subtract(
2908                 $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
2909
2910             # Depending on syspref reset the exact time, only check the date
2911             if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2912                 and $issuing_rule->{lengthunit} eq 'days' )
2913             {
2914                 $soonestrenewal->truncate( to => 'day' );
2915             }
2916
2917             if ( $soonestrenewal > dt_from_string() )
2918             {
2919                 $auto_renew = ($issue->auto_renew && $patron->autorenew_checkouts) ? "auto_too_soon" : "too_soon";
2920             }
2921             elsif ( $issue->auto_renew && $patron->autorenew_checkouts ) {
2922                 $auto_renew = "ok";
2923             }
2924         }
2925
2926         # Fallback for automatic renewals:
2927         # If norenewalbefore is undef, don't renew before due date.
2928         if ( $issue->auto_renew && $auto_renew eq "no" && $patron->autorenew_checkouts ) {
2929             my $now = dt_from_string;
2930             if ( $now >= dt_from_string( $issue->date_due, 'sql' ) ){
2931                 $auto_renew = "ok";
2932             } else {
2933                 $auto_renew = "auto_too_soon";
2934             }
2935         }
2936     }
2937
2938     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2939
2940     # If next hold is non priority, then check if any hold with priority (non_priority = 0) exists for the same biblionumber.
2941     if ( $resfound && $resrec->{non_priority} ) {
2942         $resfound = Koha::Holds->search(
2943             { biblionumber => $resrec->{biblionumber}, non_priority => 0 } )
2944           ->count > 0;
2945     }
2946
2947
2948
2949     # This item can fill one or more unfilled reserve, can those unfilled reserves
2950     # all be filled by other available items?
2951     if ( $resfound
2952         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2953     {
2954         my $schema = Koha::Database->new()->schema();
2955
2956         my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2957         if ($item_holds) {
2958             # There is an item level hold on this item, no other item can fill the hold
2959             $resfound = 1;
2960         }
2961         else {
2962
2963             # Get all other items that could possibly fill reserves
2964             my @itemnumbers = $schema->resultset('Item')->search(
2965                 {
2966                     biblionumber => $resrec->{biblionumber},
2967                     onloan       => undef,
2968                     notforloan   => 0,
2969                     -not         => { itemnumber => $itemnumber }
2970                 },
2971                 { columns => 'itemnumber' }
2972             )->get_column('itemnumber')->all();
2973
2974             # Get all other reserves that could have been filled by this item
2975             my @borrowernumbers;
2976             while (1) {
2977                 my ( $reserve_found, $reserve, undef ) =
2978                   C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2979
2980                 if ($reserve_found) {
2981                     push( @borrowernumbers, $reserve->{borrowernumber} );
2982                 }
2983                 else {
2984                     last;
2985                 }
2986             }
2987
2988             # If the count of the union of the lists of reservable items for each borrower
2989             # is equal or greater than the number of borrowers, we know that all reserves
2990             # can be filled with available items. We can get the union of the sets simply
2991             # by pushing all the elements onto an array and removing the duplicates.
2992             my @reservable;
2993             my %patrons;
2994             ITEM: foreach my $itemnumber (@itemnumbers) {
2995                 my $item = Koha::Items->find( $itemnumber );
2996                 next if IsItemOnHoldAndFound( $itemnumber );
2997                 for my $borrowernumber (@borrowernumbers) {
2998                     my $patron = $patrons{$borrowernumber} //= Koha::Patrons->find( $borrowernumber );
2999                     next unless IsAvailableForItemLevelRequest($item, $patron);
3000                     next unless CanItemBeReserved($borrowernumber,$itemnumber);
3001
3002                     push @reservable, $itemnumber;
3003                     if (@reservable >= @borrowernumbers) {
3004                         $resfound = 0;
3005                         last ITEM;
3006                     }
3007                     last;
3008                 }
3009             }
3010         }
3011     }
3012     if( $cron ) { #The cron wants to return 'too_soon' over 'on_reserve'
3013         return ( 0, $auto_renew  ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3014         return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
3015     } else { # For other purposes we want 'on_reserve' before 'too_soon'
3016         return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
3017         return ( 0, $auto_renew  ) if $auto_renew =~ 'too_soon';#$auto_renew ne "no" && $auto_renew ne "ok";
3018     }
3019
3020     return ( 0, "auto_renew" ) if $auto_renew eq "ok" && !$override_limit; # 0 if auto-renewal should not succeed
3021
3022     return ( 1, undef );
3023 }
3024
3025 =head2 AddRenewal
3026
3027   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
3028
3029 Renews a loan.
3030
3031 C<$borrowernumber> is the borrower number of the patron who currently
3032 has the item.
3033
3034 C<$itemnumber> is the number of the item to renew.
3035
3036 C<$branch> is the library where the renewal took place (if any).
3037            The library that controls the circ policies for the renewal is retrieved from the issues record.
3038
3039 C<$datedue> can be a DateTime object used to set the due date.
3040
3041 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
3042 this parameter is not supplied, lastreneweddate is set to the current date.
3043
3044 C<$skipfinecalc> is an optional boolean. There may be circumstances where, even if the
3045 CalculateFinesOnReturn syspref is enabled, we don't want to calculate fines upon renew,
3046 for example, when we're renewing as a result of a fine being paid (see RenewAccruingItemWhenPaid
3047 syspref)
3048
3049 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
3050 from the book's item type.
3051
3052 =cut
3053
3054 sub AddRenewal {
3055     my $borrowernumber  = shift;
3056     my $itemnumber      = shift or return;
3057     my $branch          = shift;
3058     my $datedue         = shift;
3059     my $lastreneweddate = shift || dt_from_string();
3060     my $skipfinecalc    = shift;
3061
3062     my $item_object   = Koha::Items->find($itemnumber) or return;
3063     my $biblio = $item_object->biblio;
3064     my $issue  = $item_object->checkout;
3065     my $item_unblessed = $item_object->unblessed;
3066
3067     my $dbh = C4::Context->dbh;
3068
3069     return unless $issue;
3070
3071     $borrowernumber ||= $issue->borrowernumber;
3072
3073     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3074         carp 'Invalid date passed to AddRenewal.';
3075         return;
3076     }
3077
3078     my $patron = Koha::Patrons->find( $borrowernumber ) or return; # FIXME Should do more than just return
3079     my $patron_unblessed = $patron->unblessed;
3080
3081     my $circ_library = Koha::Libraries->find( _GetCircControlBranch($item_unblessed, $patron_unblessed) );
3082
3083     my $schema = Koha::Database->schema;
3084     $schema->txn_do(sub{
3085
3086         if ( !$skipfinecalc && C4::Context->preference('CalculateFinesOnReturn') ) {
3087             _CalculateAndUpdateFine( { issue => $issue, item => $item_unblessed, borrower => $patron_unblessed } );
3088         }
3089         _FixOverduesOnReturn( $borrowernumber, $itemnumber, undef, 'RENEWED' );
3090
3091         # If the due date wasn't specified, calculate it by adding the
3092         # book's loan length to today's date or the current due date
3093         # based on the value of the RenewalPeriodBase syspref.
3094         my $itemtype = $item_object->effective_itemtype;
3095         unless ($datedue) {
3096
3097             $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3098                                             dt_from_string( $issue->date_due, 'sql' ) :
3099                                             dt_from_string();
3100             $datedue =  CalcDateDue($datedue, $itemtype, $circ_library->branchcode, $patron_unblessed, 'is a renewal');
3101         }
3102
3103         my $fees = Koha::Charges::Fees->new(
3104             {
3105                 patron    => $patron,
3106                 library   => $circ_library,
3107                 item      => $item_object,
3108                 from_date => dt_from_string( $issue->date_due, 'sql' ),
3109                 to_date   => dt_from_string($datedue),
3110             }
3111         );
3112
3113         # Update the issues record to have the new due date, and a new count
3114         # of how many times it has been renewed.
3115         my $renews = ( $issue->renewals || 0 ) + 1;
3116         my $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3117                                 WHERE borrowernumber=?
3118                                 AND itemnumber=?"
3119         );
3120
3121         $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3122
3123         # Update the renewal count on the item, and tell zebra to reindex
3124         $renews = ( $item_object->renewals || 0 ) + 1;
3125         $item_object->renewals($renews);
3126         $item_object->onloan($datedue);
3127         $item_object->store({ log_action => 0 });
3128
3129         # Charge a new rental fee, if applicable
3130         my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3131         if ( $charge > 0 ) {
3132             AddIssuingCharge($issue, $charge, 'RENT_RENEW');
3133         }
3134
3135         # Charge a new accumulate rental fee, if applicable
3136         my $itemtype_object = Koha::ItemTypes->find( $itemtype );
3137         if ( $itemtype_object ) {
3138             my $accumulate_charge = $fees->accumulate_rentalcharge();
3139             if ( $accumulate_charge > 0 ) {
3140                 AddIssuingCharge( $issue, $accumulate_charge, 'RENT_DAILY_RENEW' )
3141             }
3142             $charge += $accumulate_charge;
3143         }
3144
3145         # Send a renewal slip according to checkout alert preferencei
3146         if ( C4::Context->preference('RenewalSendNotice') eq '1' ) {
3147             my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3148             my %conditions        = (
3149                 branchcode   => $branch,
3150                 categorycode => $patron->categorycode,
3151                 item_type    => $itemtype,
3152                 notification => 'CHECKOUT',
3153             );
3154             if ( $circulation_alert->is_enabled_for( \%conditions ) ) {
3155                 SendCirculationAlert(
3156                     {
3157                         type     => 'RENEWAL',
3158                         item     => $item_unblessed,
3159                         borrower => $patron->unblessed,
3160                         branch   => $branch,
3161                     }
3162                 );
3163             }
3164         }
3165
3166         # Remove any OVERDUES related debarment if the borrower has no overdues
3167         if ( $patron
3168           && $patron->is_debarred
3169           && ! $patron->has_overdues
3170           && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3171         ) {
3172             DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3173         }
3174
3175         # Add the renewal to stats
3176         UpdateStats(
3177             {
3178                 branch         => $item_object->renewal_branchcode({branch => $branch}),
3179                 type           => 'renew',
3180                 amount         => $charge,
3181                 itemnumber     => $itemnumber,
3182                 itemtype       => $itemtype,
3183                 location       => $item_object->location,
3184                 borrowernumber => $borrowernumber,
3185                 ccode          => $item_object->ccode,
3186             }
3187         );
3188
3189         #Log the renewal
3190         logaction("CIRCULATION", "RENEWAL", $borrowernumber, $itemnumber) if C4::Context->preference("RenewalLog");
3191
3192         Koha::Plugins->call('after_circ_action', {
3193             action  => 'renewal',
3194             payload => {
3195                 checkout  => $issue->get_from_storage
3196             }
3197         });
3198     });
3199
3200     return $datedue;
3201 }
3202
3203 sub GetRenewCount {
3204     # check renewal status
3205     my ( $bornum, $itemno ) = @_;
3206     my $dbh           = C4::Context->dbh;
3207     my $renewcount    = 0;
3208     my $renewsallowed = 0;
3209     my $renewsleft    = 0;
3210
3211     my $patron = Koha::Patrons->find( $bornum );
3212     my $item   = Koha::Items->find($itemno);
3213
3214     return (0, 0, 0) unless $patron or $item; # Wrong call, no renewal allowed
3215
3216     # Look in the issues table for this item, lent to this borrower,
3217     # and not yet returned.
3218
3219     # FIXME - I think this function could be redone to use only one SQL call.
3220     my $sth = $dbh->prepare(
3221         "select * from issues
3222                                 where (borrowernumber = ?)
3223                                 and (itemnumber = ?)"
3224     );
3225     $sth->execute( $bornum, $itemno );
3226     my $data = $sth->fetchrow_hashref;
3227     $renewcount = $data->{'renewals'} if $data->{'renewals'};
3228     # $item and $borrower should be calculated
3229     my $branchcode = _GetCircControlBranch($item->unblessed, $patron->unblessed);
3230
3231     my $rule = Koha::CirculationRules->get_effective_rule(
3232         {
3233             categorycode => $patron->categorycode,
3234             itemtype     => $item->effective_itemtype,
3235             branchcode   => $branchcode,
3236             rule_name    => 'renewalsallowed',
3237         }
3238     );
3239
3240     $renewsallowed = $rule ? $rule->rule_value : 0;
3241     $renewsleft    = $renewsallowed - $renewcount;
3242     if($renewsleft < 0){ $renewsleft = 0; }
3243     return ( $renewcount, $renewsallowed, $renewsleft );
3244 }
3245
3246 =head2 GetSoonestRenewDate
3247
3248   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3249
3250 Find out the soonest possible renew date of a borrowed item.
3251
3252 C<$borrowernumber> is the borrower number of the patron who currently
3253 has the item on loan.
3254
3255 C<$itemnumber> is the number of the item to renew.
3256
3257 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3258 renew date, based on the value "No renewal before" of the applicable
3259 issuing rule. Returns the current date if the item can already be
3260 renewed, and returns undefined if the borrower, loan, or item
3261 cannot be found.
3262
3263 =cut
3264
3265 sub GetSoonestRenewDate {
3266     my ( $borrowernumber, $itemnumber ) = @_;
3267
3268     my $dbh = C4::Context->dbh;
3269
3270     my $item      = Koha::Items->find($itemnumber)      or return;
3271     my $itemissue = $item->checkout or return;
3272
3273     $borrowernumber ||= $itemissue->borrowernumber;
3274     my $patron = Koha::Patrons->find( $borrowernumber )
3275       or return;
3276
3277     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3278     my $issuing_rule = Koha::CirculationRules->get_effective_rules(
3279         {   categorycode => $patron->categorycode,
3280             itemtype     => $item->effective_itemtype,
3281             branchcode   => $branchcode,
3282             rules => [
3283                 'norenewalbefore',
3284                 'lengthunit',
3285             ]
3286         }
3287     );
3288
3289     my $now = dt_from_string;
3290     return $now unless $issuing_rule;
3291
3292     if ( defined $issuing_rule->{norenewalbefore}
3293         and $issuing_rule->{norenewalbefore} ne "" )
3294     {
3295         my $soonestrenewal =
3296           dt_from_string( $itemissue->date_due )->subtract(
3297             $issuing_rule->{lengthunit} => $issuing_rule->{norenewalbefore} );
3298
3299         if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3300             and $issuing_rule->{lengthunit} eq 'days' )
3301         {
3302             $soonestrenewal->truncate( to => 'day' );
3303         }
3304         return $soonestrenewal if $now < $soonestrenewal;
3305     }
3306     return $now;
3307 }
3308
3309 =head2 GetLatestAutoRenewDate
3310
3311   $NoAutoRenewalAfterThisDate = &GetLatestAutoRenewDate($borrowernumber, $itemnumber);
3312
3313 Find out the latest possible auto renew date of a borrowed item.
3314
3315 C<$borrowernumber> is the borrower number of the patron who currently
3316 has the item on loan.
3317
3318 C<$itemnumber> is the number of the item to renew.
3319
3320 C<$GetLatestAutoRenewDate> returns the DateTime of the latest possible
3321 auto renew date, based on the value "No auto renewal after" and the "No auto
3322 renewal after (hard limit) of the applicable issuing rule.
3323 Returns undef if there is no date specify in the circ rules or if the patron, loan,
3324 or item cannot be found.
3325
3326 =cut
3327
3328 sub GetLatestAutoRenewDate {
3329     my ( $borrowernumber, $itemnumber ) = @_;
3330
3331     my $dbh = C4::Context->dbh;
3332
3333     my $item      = Koha::Items->find($itemnumber)  or return;
3334     my $itemissue = $item->checkout                 or return;
3335
3336     $borrowernumber ||= $itemissue->borrowernumber;
3337     my $patron = Koha::Patrons->find( $borrowernumber )
3338       or return;
3339
3340     my $branchcode = _GetCircControlBranch( $item->unblessed, $patron->unblessed );
3341     my $circulation_rules = Koha::CirculationRules->get_effective_rules(
3342         {
3343             categorycode => $patron->categorycode,
3344             itemtype     => $item->effective_itemtype,
3345             branchcode   => $branchcode,
3346             rules => [
3347                 'no_auto_renewal_after',
3348                 'no_auto_renewal_after_hard_limit',
3349                 'lengthunit',
3350             ]
3351         }
3352     );
3353
3354     return unless $circulation_rules;
3355     return
3356       if ( not $circulation_rules->{no_auto_renewal_after}
3357             or $circulation_rules->{no_auto_renewal_after} eq '' )
3358       and ( not $circulation_rules->{no_auto_renewal_after_hard_limit}
3359              or $circulation_rules->{no_auto_renewal_after_hard_limit} eq '' );
3360
3361     my $maximum_renewal_date;
3362     if ( $circulation_rules->{no_auto_renewal_after} ) {
3363         $maximum_renewal_date = dt_from_string($itemissue->issuedate);
3364         $maximum_renewal_date->add(
3365             $circulation_rules->{lengthunit} => $circulation_rules->{no_auto_renewal_after}
3366         );
3367     }
3368
3369     if ( $circulation_rules->{no_auto_renewal_after_hard_limit} ) {
3370         my $dt = dt_from_string( $circulation_rules->{no_auto_renewal_after_hard_limit} );
3371         $maximum_renewal_date = $dt if not $maximum_renewal_date or $maximum_renewal_date > $dt;
3372     }
3373     return $maximum_renewal_date;
3374 }
3375
3376
3377 =head2 GetIssuingCharges
3378
3379   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3380
3381 Calculate how much it would cost for a given patron to borrow a given
3382 item, including any applicable discounts.
3383
3384 C<$itemnumber> is the item number of item the patron wishes to borrow.
3385
3386 C<$borrowernumber> is the patron's borrower number.
3387
3388 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3389 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3390 if it's a video).
3391
3392 =cut
3393
3394 sub GetIssuingCharges {
3395
3396     # calculate charges due
3397     my ( $itemnumber, $borrowernumber ) = @_;
3398     my $charge = 0;
3399     my $dbh    = C4::Context->dbh;
3400     my $item_type;
3401
3402     # Get the book's item type and rental charge (via its biblioitem).
3403     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3404         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3405     $charge_query .= (C4::Context->preference('item-level_itypes'))
3406         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3407         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3408
3409     $charge_query .= ' WHERE items.itemnumber =?';
3410
3411     my $sth = $dbh->prepare($charge_query);
3412     $sth->execute($itemnumber);
3413     if ( my $item_data = $sth->fetchrow_hashref ) {
3414         $item_type = $item_data->{itemtype};
3415         $charge    = $item_data->{rentalcharge};
3416         my $branch = C4::Context::mybranch();
3417         my $patron = Koha::Patrons->find( $borrowernumber );
3418         my $discount = _get_discount_from_rule($patron->categorycode, $branch, $item_type);
3419         if ($discount) {
3420             # We may have multiple rules so get the most specific
3421             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3422         }
3423         if ($charge) {
3424             $charge = sprintf '%.2f', $charge; # ensure no fractions of a penny returned
3425         }
3426     }
3427
3428     return ( $charge, $item_type );
3429 }
3430
3431 # Select most appropriate discount rule from those returned
3432 sub _get_discount_from_rule {
3433     my ($categorycode, $branchcode, $itemtype) = @_;
3434
3435     # Set search precedences
3436     my @params = (
3437         {
3438             branchcode   => $branchcode,
3439             itemtype     => $itemtype,
3440             categorycode => $categorycode,
3441         },
3442         {
3443             branchcode   => undef,
3444             categorycode => $categorycode,
3445             itemtype     => $itemtype,
3446         },
3447         {
3448             branchcode   => $branchcode,
3449             categorycode => $categorycode,
3450             itemtype     => undef,
3451         },
3452         {
3453             branchcode   => undef,
3454             categorycode => $categorycode,
3455             itemtype     => undef,
3456         },
3457     );
3458
3459     foreach my $params (@params) {
3460         my $rule = Koha::CirculationRules->search(
3461             {
3462                 rule_name => 'rentaldiscount',
3463                 %$params,
3464             }
3465         )->next();
3466
3467         return $rule->rule_value if $rule;
3468     }
3469
3470     # none of the above
3471     return 0;
3472 }
3473
3474 =head2 AddIssuingCharge
3475
3476   &AddIssuingCharge( $checkout, $charge, $type )
3477
3478 =cut
3479
3480 sub AddIssuingCharge {
3481     my ( $checkout, $charge, $type ) = @_;
3482
3483     # FIXME What if checkout does not exist?
3484
3485     my $account = Koha::Account->new({ patron_id => $checkout->borrowernumber });
3486     my $accountline = $account->add_debit(
3487         {
3488             amount      => $charge,
3489             note        => undef,
3490             user_id     => C4::Context->userenv ? C4::Context->userenv->{'number'} : undef,
3491             library_id  => C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef,
3492             interface   => C4::Context->interface,
3493             type        => $type,
3494             item_id     => $checkout->itemnumber,
3495             issue_id    => $checkout->issue_id,
3496         }
3497     );
3498 }
3499
3500 =head2 GetTransfers
3501
3502   GetTransfers($itemnumber);
3503
3504 =cut
3505
3506 sub GetTransfers {
3507     my ($itemnumber) = @_;
3508
3509     my $dbh = C4::Context->dbh;
3510
3511     my $query = '
3512         SELECT datesent,
3513                frombranch,
3514                tobranch,
3515                branchtransfer_id
3516         FROM branchtransfers
3517         WHERE itemnumber = ?
3518           AND datearrived IS NULL
3519         ';
3520     my $sth = $dbh->prepare($query);
3521     $sth->execute($itemnumber);
3522     my @row = $sth->fetchrow_array();
3523     return @row;
3524 }
3525
3526 =head2 GetTransfersFromTo
3527
3528   @results = GetTransfersFromTo($frombranch,$tobranch);
3529
3530 Returns the list of pending transfers between $from and $to branch
3531
3532 =cut
3533
3534 sub GetTransfersFromTo {
3535     my ( $frombranch, $tobranch ) = @_;
3536     return unless ( $frombranch && $tobranch );
3537     my $dbh   = C4::Context->dbh;
3538     my $query = "
3539         SELECT branchtransfer_id,itemnumber,datesent,frombranch
3540         FROM   branchtransfers
3541         WHERE  frombranch=?
3542           AND  tobranch=?
3543           AND datearrived IS NULL
3544     ";
3545     my $sth = $dbh->prepare($query);
3546     $sth->execute( $frombranch, $tobranch );
3547     my @gettransfers;
3548
3549     while ( my $data = $sth->fetchrow_hashref ) {
3550         push @gettransfers, $data;
3551     }
3552     return (@gettransfers);
3553 }
3554
3555 =head2 DeleteTransfer
3556
3557   &DeleteTransfer($itemnumber);
3558
3559 =cut
3560
3561 sub DeleteTransfer {
3562     my ($itemnumber) = @_;
3563     return unless $itemnumber;
3564     my $dbh          = C4::Context->dbh;
3565     my $sth          = $dbh->prepare(
3566         "DELETE FROM branchtransfers
3567          WHERE itemnumber=?
3568          AND datearrived IS NULL "
3569     );
3570     return $sth->execute($itemnumber);
3571 }
3572
3573 =head2 SendCirculationAlert
3574
3575 Send out a C<check-in> or C<checkout> alert using the messaging system.
3576
3577 B<Parameters>:
3578
3579 =over 4
3580
3581 =item type
3582
3583 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3584
3585 =item item
3586
3587 Hashref of information about the item being checked in or out.
3588
3589 =item borrower
3590
3591 Hashref of information about the borrower of the item.
3592
3593 =item branch
3594
3595 The branchcode from where the checkout or check-in took place.
3596
3597 =back
3598
3599 B<Example>:
3600
3601     SendCirculationAlert({
3602         type     => 'CHECKOUT',
3603         item     => $item,
3604         borrower => $borrower,
3605         branch   => $branch,
3606     });
3607
3608 =cut
3609
3610 sub SendCirculationAlert {
3611     my ($opts) = @_;
3612     my ($type, $item, $borrower, $branch) =
3613         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3614     my %message_name = (
3615         CHECKIN  => 'Item_Check_in',
3616         CHECKOUT => 'Item_Checkout',
3617         RENEWAL  => 'Item_Checkout',
3618     );
3619     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3620         borrowernumber => $borrower->{borrowernumber},
3621         message_name   => $message_name{$type},
3622     });
3623     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3624
3625     my $schema = Koha::Database->new->schema;
3626     my @transports = keys %{ $borrower_preferences->{transports} };
3627
3628     # From the MySQL doc:
3629     # LOCK TABLES is not transaction-safe and implicitly commits any active transaction before attempting to lock the tables.
3630     # If the LOCK/UNLOCK statements are executed from tests, the current transaction will be committed.
3631     # To avoid that we need to guess if this code is execute from tests or not (yes it is a bit hacky)
3632     my $do_not_lock = ( exists $ENV{_} && $ENV{_} =~ m|prove| ) || $ENV{KOHA_TESTING};
3633
3634     for my $mtt (@transports) {
3635         my $letter =  C4::Letters::GetPreparedLetter (
3636             module => 'circulation',
3637             letter_code => $type,
3638             branchcode => $branch,
3639             message_transport_type => $mtt,
3640             lang => $borrower->{lang},
3641             tables => {
3642                 $issues_table => $item->{itemnumber},
3643                 'items'       => $item->{itemnumber},
3644                 'biblio'      => $item->{biblionumber},
3645                 'biblioitems' => $item->{biblionumber},
3646                 'borrowers'   => $borrower,
3647                 'branches'    => $branch,
3648             }
3649         ) or next;
3650
3651         $schema->storage->txn_begin;
3652         C4::Context->dbh->do(q|LOCK TABLE message_queue READ|) unless $do_not_lock;
3653         C4::Context->dbh->do(q|LOCK TABLE message_queue WRITE|) unless $do_not_lock;
3654         my $message = C4::Message->find_last_message($borrower, $type, $mtt);
3655         unless ( $message ) {
3656             C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3657             C4::Message->enqueue($letter, $borrower, $mtt);
3658         } else {
3659             $message->append($letter);
3660             $message->update;
3661         }
3662         C4::Context->dbh->do(q|UNLOCK TABLES|) unless $do_not_lock;
3663         $schema->storage->txn_commit;
3664     }
3665
3666     return;
3667 }
3668
3669 =head2 updateWrongTransfer
3670
3671   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3672
3673 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
3674
3675 =cut
3676
3677 sub updateWrongTransfer {
3678         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3679         my $dbh = C4::Context->dbh;
3680 # first step validate the actual line of transfert .
3681         my $sth =
3682                 $dbh->prepare(
3683                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3684                 );
3685                 $sth->execute($FromLibrary,$itemNumber);
3686
3687 # second step create a new line of branchtransfer to the right location .
3688         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3689
3690 #third step changing holdingbranch of item
3691     my $item = Koha::Items->find($itemNumber)->holdingbranch($FromLibrary)->store;
3692 }
3693
3694 =head2 CalcDateDue
3695
3696 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3697
3698 this function calculates the due date given the start date and configured circulation rules,
3699 checking against the holidays calendar as per the daysmode circulation rule.
3700 C<$startdate>   = DateTime object representing start date of loan period (assumed to be today)
3701 C<$itemtype>  = itemtype code of item in question
3702 C<$branch>  = location whose calendar to use
3703 C<$borrower> = Borrower object
3704 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3705
3706 =cut
3707
3708 sub CalcDateDue {
3709     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3710
3711     $isrenewal ||= 0;
3712
3713     # loanlength now a href
3714     my $loanlength =
3715             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3716
3717     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3718             ? qq{renewalperiod}
3719             : qq{issuelength};
3720
3721     my $datedue;
3722     if ( $startdate ) {
3723         if (ref $startdate ne 'DateTime' ) {
3724             $datedue = dt_from_string($datedue);
3725         } else {
3726             $datedue = $startdate->clone;
3727         }
3728     } else {
3729         $datedue = dt_from_string()->truncate( to => 'minute' );
3730     }
3731
3732
3733     my $daysmode = Koha::CirculationRules->get_effective_daysmode(
3734         {
3735             categorycode => $borrower->{categorycode},
3736             itemtype     => $itemtype,
3737             branchcode   => $branch,
3738         }
3739     );
3740
3741     # calculate the datedue as normal
3742     if ( $daysmode eq 'Days' )
3743     {    # ignoring calendar
3744         if ( $loanlength->{lengthunit} eq 'hours' ) {
3745             $datedue->add( hours => $loanlength->{$length_key} );
3746         } else {    # days
3747             $datedue->add( days => $loanlength->{$length_key} );
3748             $datedue->set_hour(23);
3749             $datedue->set_minute(59);
3750         }
3751     } else {
3752         my $dur;
3753         if ($loanlength->{lengthunit} eq 'hours') {
3754             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3755         }
3756         else { # days
3757             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3758         }
3759         my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3760         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3761         if ($loanlength->{lengthunit} eq 'days') {
3762             $datedue->set_hour(23);
3763             $datedue->set_minute(59);
3764         }
3765     }
3766
3767     # if Hard Due Dates are used, retrieve them and apply as necessary
3768     my ( $hardduedate, $hardduedatecompare ) =
3769       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3770     if ($hardduedate) {    # hardduedates are currently dates
3771         $hardduedate->truncate( to => 'minute' );
3772         $hardduedate->set_hour(23);
3773         $hardduedate->set_minute(59);
3774         my $cmp = DateTime->compare( $hardduedate, $datedue );
3775
3776 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3777 # if the calculated date is before the 'after' Hard Due Date (floor), override
3778 # if the hard due date is set to 'exactly', overrride
3779         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3780             $datedue = $hardduedate->clone;
3781         }
3782
3783         # in all other cases, keep the date due as it is
3784
3785     }
3786
3787     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3788     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3789         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3790         if( $expiry_dt ) { #skip empty expiry date..
3791             $expiry_dt->set( hour => 23, minute => 59);
3792             my $d1= $datedue->clone->set_time_zone('floating');
3793             if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3794                 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3795             }
3796         }
3797         if ( $daysmode ne 'Days' ) {
3798           my $calendar = Koha::Calendar->new( branchcode => $branch, days_mode => $daysmode );
3799           if ( $calendar->is_holiday($datedue) ) {
3800               # Don't return on a closed day
3801               $datedue = $calendar->prev_open_days( $datedue, 1 );
3802           }
3803         }
3804     }
3805
3806     return $datedue;
3807 }
3808
3809
3810 sub CheckValidBarcode{
3811 my ($barcode) = @_;
3812 my $dbh = C4::Context->dbh;
3813 my $query=qq|SELECT count(*)
3814              FROM items
3815              WHERE barcode=?
3816             |;
3817 my $sth = $dbh->prepare($query);
3818 $sth->execute($barcode);
3819 my $exist=$sth->fetchrow ;
3820 return $exist;
3821 }
3822
3823 =head2 IsBranchTransferAllowed
3824
3825   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3826
3827 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3828
3829 Deprecated in favor of Koha::Item::Transfer::Limits->find/search and
3830 Koha::Item->can_be_transferred.
3831
3832 =cut
3833
3834 sub IsBranchTransferAllowed {
3835         my ( $toBranch, $fromBranch, $code ) = @_;
3836
3837         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3838
3839         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3840         my $dbh = C4::Context->dbh;
3841
3842         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3843         $sth->execute( $toBranch, $fromBranch, $code );
3844         my $limit = $sth->fetchrow_hashref();
3845
3846         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3847         if ( $limit->{'limitId'} ) {
3848                 return 0;
3849         } else {
3850                 return 1;
3851         }
3852 }
3853
3854 =head2 CreateBranchTransferLimit
3855
3856   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3857
3858 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3859
3860 Deprecated in favor of Koha::Item::Transfer::Limit->new.
3861
3862 =cut
3863
3864 sub CreateBranchTransferLimit {
3865    my ( $toBranch, $fromBranch, $code ) = @_;
3866    return unless defined($toBranch) && defined($fromBranch);
3867    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3868
3869    my $dbh = C4::Context->dbh;
3870
3871    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3872    return $sth->execute( $code, $toBranch, $fromBranch );
3873 }
3874
3875 =head2 DeleteBranchTransferLimits
3876
3877     my $result = DeleteBranchTransferLimits($frombranch);
3878
3879 Deletes all the library transfer limits for one library.  Returns the
3880 number of limits deleted, 0e0 if no limits were deleted, or undef if
3881 no arguments are supplied.
3882
3883 Deprecated in favor of Koha::Item::Transfer::Limits->search({
3884     fromBranch => $fromBranch
3885     })->delete.
3886
3887 =cut
3888
3889 sub DeleteBranchTransferLimits {
3890     my $branch = shift;
3891     return unless defined $branch;
3892     my $dbh    = C4::Context->dbh;
3893     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3894     return $sth->execute($branch);
3895 }
3896
3897 sub ReturnLostItem{
3898     my ( $borrowernumber, $itemnum ) = @_;
3899     MarkIssueReturned( $borrowernumber, $itemnum );
3900 }
3901
3902 =head2 LostItem
3903
3904   LostItem( $itemnumber, $mark_lost_from, $force_mark_returned, [$params] );
3905
3906 The final optional parameter, C<$params>, expected to contain
3907 'skip_record_index' key, which relayed down to Koha::Item/store,
3908 there it prevents calling of ModZebra index_records,
3909 which takes most of the time in batch adds/deletes: index_records better
3910 to be called later in C<additem.pl> after the whole loop.
3911
3912 $params:
3913     skip_record_index => 1|0
3914
3915 =cut
3916
3917 sub LostItem{
3918     my ($itemnumber, $mark_lost_from, $force_mark_returned, $params) = @_;
3919
3920     unless ( $mark_lost_from ) {
3921         # Temporary check to avoid regressions
3922         die q|LostItem called without $mark_lost_from, check the API.|;
3923     }
3924
3925     my $mark_returned;
3926     if ( $force_mark_returned ) {
3927         $mark_returned = 1;
3928     } else {
3929         my $pref = C4::Context->preference('MarkLostItemsAsReturned') // q{};
3930         $mark_returned = ( $pref =~ m|$mark_lost_from| );
3931     }
3932
3933     my $dbh = C4::Context->dbh();
3934     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3935                            FROM issues
3936                            JOIN items USING (itemnumber)
3937                            JOIN biblio USING (biblionumber)
3938                            WHERE issues.itemnumber=?");
3939     $sth->execute($itemnumber);
3940     my $issues=$sth->fetchrow_hashref();
3941
3942     # If a borrower lost the item, add a replacement cost to the their record
3943     if ( my $borrowernumber = $issues->{borrowernumber} ){
3944         my $patron = Koha::Patrons->find( $borrowernumber );
3945
3946         my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, C4::Context->preference('WhenLostForgiveFine'), 'LOST');
3947         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3948
3949         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3950             C4::Accounts::chargelostitem(
3951                 $borrowernumber,
3952                 $itemnumber,
3953                 $issues->{'replacementprice'},
3954                 sprintf( "%s %s %s",
3955                     $issues->{'title'}          || q{},
3956                     $issues->{'barcode'}        || q{},
3957                     $issues->{'itemcallnumber'} || q{},
3958                 ),
3959             );
3960             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3961             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3962         }
3963
3964         MarkIssueReturned($borrowernumber,$itemnumber,undef,$patron->privacy) if $mark_returned;
3965     }
3966
3967     #When item is marked lost automatically cancel its outstanding transfers and set items holdingbranch to the transfer source branch (frombranch)
3968     if (my ( $datesent,$frombranch,$tobranch ) = GetTransfers($itemnumber)) {
3969         Koha::Items->find($itemnumber)->holdingbranch($frombranch)->store({ skip_record_index => $params->{skip_record_index} });
3970     }
3971     my $transferdeleted = DeleteTransfer($itemnumber);
3972 }
3973
3974 sub GetOfflineOperations {
3975     my $dbh = C4::Context->dbh;
3976     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3977     $sth->execute(C4::Context->userenv->{'branch'});
3978     my $results = $sth->fetchall_arrayref({});
3979     return $results;
3980 }
3981
3982 sub GetOfflineOperation {
3983     my $operationid = shift;
3984     return unless $operationid;
3985     my $dbh = C4::Context->dbh;
3986     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3987     $sth->execute( $operationid );
3988     return $sth->fetchrow_hashref;
3989 }
3990
3991 sub AddOfflineOperation {
3992     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3993     my $dbh = C4::Context->dbh;
3994     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3995     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3996     return "Added.";
3997 }
3998
3999 sub DeleteOfflineOperation {
4000     my $dbh = C4::Context->dbh;
4001     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
4002     $sth->execute( shift );
4003     return "Deleted.";
4004 }
4005
4006 sub ProcessOfflineOperation {
4007     my $operation = shift;
4008
4009     my $report;
4010     if ( $operation->{action} eq 'return' ) {
4011         $report = ProcessOfflineReturn( $operation );
4012     } elsif ( $operation->{action} eq 'issue' ) {
4013         $report = ProcessOfflineIssue( $operation );
4014     } elsif ( $operation->{action} eq 'payment' ) {
4015         $report = ProcessOfflinePayment( $operation );
4016     }
4017
4018     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
4019
4020     return $report;
4021 }
4022
4023 sub ProcessOfflineReturn {
4024     my $operation = shift;
4025
4026     my $item = Koha::Items->find({barcode => $operation->{barcode}});
4027
4028     if ( $item ) {
4029         my $itemnumber = $item->itemnumber;
4030         my $issue = GetOpenIssue( $itemnumber );
4031         if ( $issue ) {
4032             my $leave_item_lost = C4::Context->preference("BlockReturnOfLostItems") ? 1 : 0;
4033             ModDateLastSeen( $itemnumber, $leave_item_lost );
4034             MarkIssueReturned(
4035                 $issue->{borrowernumber},
4036                 $itemnumber,
4037                 $operation->{timestamp},
4038             );
4039             $item->renewals(0);
4040             $item->onloan(undef);
4041             $item->store({ log_action => 0 });
4042             return "Success.";
4043         } else {
4044             return "Item not issued.";
4045         }
4046     } else {
4047         return "Item not found.";
4048     }
4049 }
4050
4051 sub ProcessOfflineIssue {
4052     my $operation = shift;
4053
4054     my $patron = Koha::Patrons->find( { cardnumber => $operation->{cardnumber} } );
4055
4056     if ( $patron ) {
4057         my $item = Koha::Items->find({ barcode => $operation->{barcode} });
4058         unless ($item) {
4059             return "Barcode not found.";
4060         }
4061         my $itemnumber = $item->itemnumber;
4062         my $issue = GetOpenIssue( $itemnumber );
4063
4064         if ( $issue and ( $issue->{borrowernumber} ne $patron->borrowernumber ) ) { # Item already issued to another patron mark it returned
4065             MarkIssueReturned(
4066                 $issue->{borrowernumber},
4067                 $itemnumber,
4068                 $operation->{timestamp},
4069             );
4070         }
4071         AddIssue(
4072             $patron->unblessed,
4073             $operation->{'barcode'},
4074             undef,
4075             1,
4076             $operation->{timestamp},
4077             undef,
4078         );
4079         return "Success.";
4080     } else {
4081         return "Borrower not found.";
4082     }
4083 }
4084
4085 sub ProcessOfflinePayment {
4086     my $operation = shift;
4087
4088     my $patron = Koha::Patrons->find({ cardnumber => $operation->{cardnumber} });
4089
4090     $patron->account->pay(
4091         {
4092             amount     => $operation->{amount},
4093             library_id => $operation->{branchcode},
4094             interface  => 'koc'
4095         }
4096     );
4097
4098     return "Success.";
4099 }
4100
4101 =head2 TransferSlip
4102
4103   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
4104
4105   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
4106
4107 =cut
4108
4109 sub TransferSlip {
4110     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
4111
4112     my $item =
4113       $itemnumber
4114       ? Koha::Items->find($itemnumber)
4115       : Koha::Items->find( { barcode => $barcode } );
4116
4117     $item or return;
4118
4119     return C4::Letters::GetPreparedLetter (
4120         module => 'circulation',
4121         letter_code => 'TRANSFERSLIP',
4122         branchcode => $branch,
4123         tables => {
4124             'branches'    => $to_branch,
4125             'biblio'      => $item->biblionumber,
4126             'items'       => $item->unblessed,
4127         },
4128     );
4129 }
4130
4131 =head2 CheckIfIssuedToPatron
4132
4133   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
4134
4135   Return 1 if any record item is issued to patron, otherwise return 0
4136
4137 =cut
4138
4139 sub CheckIfIssuedToPatron {
4140     my ($borrowernumber, $biblionumber) = @_;
4141
4142     my $dbh = C4::Context->dbh;
4143     my $query = q|
4144         SELECT COUNT(*) FROM issues
4145         LEFT JOIN items ON items.itemnumber = issues.itemnumber
4146         WHERE items.biblionumber = ?
4147         AND issues.borrowernumber = ?
4148     |;
4149     my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
4150     return 1 if $is_issued;
4151     return;
4152 }
4153
4154 =head2 IsItemIssued
4155
4156   IsItemIssued( $itemnumber )
4157
4158   Return 1 if the item is on loan, otherwise return 0
4159
4160 =cut
4161
4162 sub IsItemIssued {
4163     my $itemnumber = shift;
4164     my $dbh = C4::Context->dbh;
4165     my $sth = $dbh->prepare(q{
4166         SELECT COUNT(*)
4167         FROM issues
4168         WHERE itemnumber = ?
4169     });
4170     $sth->execute($itemnumber);
4171     return $sth->fetchrow;
4172 }
4173
4174 =head2 GetAgeRestriction
4175
4176   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
4177   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
4178
4179   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as they are older or as old as the agerestriction }
4180   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
4181
4182 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
4183 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
4184 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
4185          Negative days mean the borrower has gone past the age restriction age.
4186
4187 =cut
4188
4189 sub GetAgeRestriction {
4190     my ($record_restrictions, $borrower) = @_;
4191     my $markers = C4::Context->preference('AgeRestrictionMarker');
4192
4193     return unless $record_restrictions;
4194     # Split $record_restrictions to something like FSK 16 or PEGI 6
4195     my @values = split ' ', uc($record_restrictions);
4196     return unless @values;
4197
4198     # Search first occurrence of one of the markers
4199     my @markers = split /\|/, uc($markers);
4200     return unless @markers;
4201
4202     my $index            = 0;
4203     my $restriction_year = 0;
4204     for my $value (@values) {
4205         $index++;
4206         for my $marker (@markers) {
4207             $marker =~ s/^\s+//;    #remove leading spaces
4208             $marker =~ s/\s+$//;    #remove trailing spaces
4209             if ( $marker eq $value ) {
4210                 if ( $index <= $#values ) {
4211                     $restriction_year += $values[$index];
4212                 }
4213                 last;
4214             }
4215             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4216
4217                 # Perhaps it is something like "K16" (as in Finland)
4218                 $restriction_year += $1;
4219                 last;
4220             }
4221         }
4222         last if ( $restriction_year > 0 );
4223     }
4224
4225     #Check if the borrower is age restricted for this material and for how long.
4226     if ($restriction_year && $borrower) {
4227         if ( $borrower->{'dateofbirth'} ) {
4228             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4229             $alloweddate[0] += $restriction_year;
4230
4231             #Prevent runime eror on leap year (invalid date)
4232             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4233                 $alloweddate[2] = 28;
4234             }
4235
4236             #Get how many days the borrower has to reach the age restriction
4237             my @Today = split /-/, dt_from_string()->ymd();
4238             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(@Today);
4239             #Negative days means the borrower went past the age restriction age
4240             return ($restriction_year, $daysToAgeRestriction);
4241         }
4242     }
4243
4244     return ($restriction_year);
4245 }
4246
4247
4248 =head2 GetPendingOnSiteCheckouts
4249
4250 =cut
4251
4252 sub GetPendingOnSiteCheckouts {
4253     my $dbh = C4::Context->dbh;
4254     return $dbh->selectall_arrayref(q|
4255         SELECT
4256           items.barcode,
4257           items.biblionumber,
4258           items.itemnumber,
4259           items.itemnotes,
4260           items.itemcallnumber,
4261           items.location,
4262           issues.date_due,
4263           issues.branchcode,
4264           issues.date_due < NOW() AS is_overdue,
4265           biblio.author,
4266           biblio.title,
4267           borrowers.firstname,
4268           borrowers.surname,
4269           borrowers.cardnumber,
4270           borrowers.borrowernumber
4271         FROM items
4272         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4273         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4274         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4275         WHERE issues.onsite_checkout = 1
4276     |, { Slice => {} } );
4277 }
4278
4279 sub GetTopIssues {
4280     my ($params) = @_;
4281
4282     my ($count, $branch, $itemtype, $ccode, $newness)
4283         = @$params{qw(count branch itemtype ccode newness)};
4284
4285     my $dbh = C4::Context->dbh;
4286     my $query = q{
4287         SELECT * FROM (
4288         SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4289           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4290           i.ccode, SUM(i.issues) AS count
4291         FROM biblio b
4292         LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4293         LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4294     };
4295
4296     my (@where_strs, @where_args);
4297
4298     if ($branch) {
4299         push @where_strs, 'i.homebranch = ?';
4300         push @where_args, $branch;
4301     }
4302     if ($itemtype) {
4303         if (C4::Context->preference('item-level_itypes')){
4304             push @where_strs, 'i.itype = ?';
4305             push @where_args, $itemtype;
4306         } else {
4307             push @where_strs, 'bi.itemtype = ?';
4308             push @where_args, $itemtype;
4309         }
4310     }
4311     if ($ccode) {
4312         push @where_strs, 'i.ccode = ?';
4313         push @where_args, $ccode;
4314     }
4315     if ($newness) {
4316         push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4317         push @where_args, $newness;
4318     }
4319
4320     if (@where_strs) {
4321         $query .= 'WHERE ' . join(' AND ', @where_strs);
4322     }
4323
4324     $query .= q{
4325         GROUP BY b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4326           bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4327           i.ccode
4328         ORDER BY count DESC
4329     };
4330
4331     $query .= q{ ) xxx WHERE count > 0 };
4332     $count = int($count);
4333     if ($count > 0) {
4334         $query .= "LIMIT $count";
4335     }
4336
4337     my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4338
4339     return @$rows;
4340 }
4341
4342 =head2 Internal methods
4343
4344 =cut
4345
4346 sub _CalculateAndUpdateFine {
4347     my ($params) = @_;
4348
4349     my $borrower    = $params->{borrower};
4350     my $item        = $params->{item};
4351     my $issue       = $params->{issue};
4352     my $return_date = $params->{return_date};
4353
4354     unless ($borrower) { carp "No borrower passed in!" && return; }
4355     unless ($item)     { carp "No item passed in!"     && return; }
4356     unless ($issue)    { carp "No issue passed in!"    && return; }
4357
4358     my $datedue = dt_from_string( $issue->date_due );
4359
4360     # we only need to calculate and change the fines if we want to do that on return
4361     # Should be on for hourly loans
4362     my $control = C4::Context->preference('CircControl');
4363     my $control_branchcode =
4364         ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
4365       : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
4366       :                                     $issue->branchcode;
4367
4368     my $date_returned = $return_date ? $return_date : dt_from_string();
4369
4370     my ( $amount, $unitcounttotal, $unitcount  ) =
4371       C4::Overdues::CalcFine( $item, $borrower->{categorycode}, $control_branchcode, $datedue, $date_returned );
4372
4373     if ( C4::Context->preference('finesMode') eq 'production' ) {
4374         if ( $amount > 0 ) {
4375             C4::Overdues::UpdateFine({
4376                 issue_id       => $issue->issue_id,
4377                 itemnumber     => $issue->itemnumber,
4378                 borrowernumber => $issue->borrowernumber,
4379                 amount         => $amount,
4380                 due            => output_pref($datedue),
4381             });
4382         }
4383         elsif ($return_date) {
4384
4385             # Backdated returns may have fines that shouldn't exist,
4386             # so in this case, we need to drop those fines to 0
4387
4388             C4::Overdues::UpdateFine({
4389                 issue_id       => $issue->issue_id,
4390                 itemnumber     => $issue->itemnumber,
4391                 borrowernumber => $issue->borrowernumber,
4392                 amount         => 0,
4393                 due            => output_pref($datedue),
4394             });
4395         }
4396     }
4397 }
4398
4399 sub _item_denied_renewal {
4400     my ($params) = @_;
4401
4402     my $item = $params->{item};
4403     return unless $item;
4404
4405     my $denyingrules = Koha::Config::SysPrefs->find('ItemsDeniedRenewal')->get_yaml_pref_hash();
4406     return unless $denyingrules;
4407     foreach my $field (keys %$denyingrules) {
4408         my $val = $item->$field;
4409         if( !defined $val) {
4410             if ( any { !defined $_ }  @{$denyingrules->{$field}} ){
4411                 return 1;
4412             }
4413         } elsif (any { defined($_) && $val eq $_ } @{$denyingrules->{$field}}) {
4414            # If the results matches the values in the syspref
4415            # We return true if match found
4416             return 1;
4417         }
4418     }
4419     return 0;
4420 }
4421
4422 1;
4423
4424 __END__
4425
4426 =head1 AUTHOR
4427
4428 Koha Development Team <http://koha-community.org/>
4429
4430 =cut