C4/Circulation.pm

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