C4/Circulation.pm

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