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