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