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