C4/Circulation.pm

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