C4/Circulation.pm

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