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