C4/Circulation.pm

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