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