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