C4/Circulation.pm

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