C4/Circulation.pm

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