C4/Circulation.pm

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