C4/Circulation.pm

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