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