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 DONT 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 neccessary.
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
1611 This searches branchitemrules in the following order:
1612
1613   * Same branchcode and itemtype
1614   * Same branchcode, itemtype '*'
1615   * branchcode '*', same itemtype
1616   * branchcode and itemtype '*'
1617
1618 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1619
1620 =cut
1621
1622 sub GetBranchItemRule {
1623     my ( $branchcode, $itemtype ) = @_;
1624     my $dbh = C4::Context->dbh();
1625     my $result = {};
1626
1627     my @attempts = (
1628         ['SELECT holdallowed, returnbranch
1629             FROM branch_item_rules
1630             WHERE branchcode = ?
1631               AND itemtype = ?', $branchcode, $itemtype],
1632         ['SELECT holdallowed, returnbranch
1633             FROM default_branch_circ_rules
1634             WHERE branchcode = ?', $branchcode],
1635         ['SELECT holdallowed, returnbranch
1636             FROM default_branch_item_rules
1637             WHERE itemtype = ?', $itemtype],
1638         ['SELECT holdallowed, returnbranch
1639             FROM default_circ_rules'],
1640     );
1641
1642     foreach my $attempt (@attempts) {
1643         my ($query, @bind_params) = @{$attempt};
1644         my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1645           or next;
1646
1647         # Since branch/category and branch/itemtype use the same per-branch
1648         # defaults tables, we have to check that the key we want is set, not
1649         # just that a row was returned
1650         $result->{'holdallowed'}  = $search_result->{'holdallowed'}  unless ( defined $result->{'holdallowed'} );
1651         $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1652     }
1653
1654     # built-in default circulation rule
1655     $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1656     $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1657
1658     return $result;
1659 }
1660
1661 =head2 AddReturn
1662
1663   ($doreturn, $messages, $iteminformation, $borrower) =
1664       &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1665
1666 Returns a book.
1667
1668 =over 4
1669
1670 =item C<$barcode> is the bar code of the book being returned.
1671
1672 =item C<$branch> is the code of the branch where the book is being returned.
1673
1674 =item C<$exemptfine> indicates that overdue charges for the item will be
1675 removed. Optional.
1676
1677 =item C<$dropbox> indicates that the check-in date is assumed to be
1678 yesterday, or the last non-holiday as defined in C4::Calendar .  If
1679 overdue charges are applied and C<$dropbox> is true, the last charge
1680 will be removed.  This assumes that the fines accrual script has run
1681 for _today_. Optional.
1682
1683 =item C<$return_date> allows the default return date to be overridden
1684 by the given return date. Optional.
1685
1686 =back
1687
1688 C<&AddReturn> returns a list of four items:
1689
1690 C<$doreturn> is true iff the return succeeded.
1691
1692 C<$messages> is a reference-to-hash giving feedback on the operation.
1693 The keys of the hash are:
1694
1695 =over 4
1696
1697 =item C<BadBarcode>
1698
1699 No item with this barcode exists. The value is C<$barcode>.
1700
1701 =item C<NotIssued>
1702
1703 The book is not currently on loan. The value is C<$barcode>.
1704
1705 =item C<IsPermanent>
1706
1707 The book's home branch is a permanent collection. If you have borrowed
1708 this book, you are not allowed to return it. The value is the code for
1709 the book's home branch.
1710
1711 =item C<withdrawn>
1712
1713 This book has been withdrawn/cancelled. The value should be ignored.
1714
1715 =item C<Wrongbranch>
1716
1717 This book has was returned to the wrong branch.  The value is a hashref
1718 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1719 contain the branchcode of the incorrect and correct return library, respectively.
1720
1721 =item C<ResFound>
1722
1723 The item was reserved. The value is a reference-to-hash whose keys are
1724 fields from the reserves table of the Koha database, and
1725 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1726 either C<Waiting>, C<Reserved>, or 0.
1727
1728 =back
1729
1730 C<$iteminformation> is a reference-to-hash, giving information about the
1731 returned item from the issues table.
1732
1733 C<$borrower> is a reference-to-hash, giving information about the
1734 patron who last borrowed the book.
1735
1736 =cut
1737
1738 sub AddReturn {
1739     my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1740
1741     if ($branch and not GetBranchDetail($branch)) {
1742         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1743         undef $branch;
1744     }
1745     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1746     my $messages;
1747     my $borrower;
1748     my $biblio;
1749     my $doreturn       = 1;
1750     my $validTransfert = 0;
1751     my $stat_type = 'return';
1752
1753     # get information on item
1754     my $itemnumber = GetItemnumberFromBarcode( $barcode );
1755     unless ($itemnumber) {
1756         return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower.  bail out.
1757     }
1758     my $issue  = GetItemIssue($itemnumber);
1759 #   warn Dumper($iteminformation);
1760     if ($issue and $issue->{borrowernumber}) {
1761         $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1762             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1763                 . Dumper($issue) . "\n";
1764     } else {
1765         $messages->{'NotIssued'} = $barcode;
1766         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1767         $doreturn = 0;
1768         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1769         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1770         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1771            $messages->{'LocalUse'} = 1;
1772            $stat_type = 'localuse';
1773         }
1774     }
1775
1776     my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1777
1778     if ( $item->{'location'} eq 'PROC' ) {
1779         if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1780             $item->{'location'} = 'CART';
1781         }
1782         else {
1783             $item->{location} = $item->{permanent_location};
1784         }
1785
1786         ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
1787     }
1788
1789         # full item data, but no borrowernumber or checkout info (no issue)
1790         # we know GetItem should work because GetItemnumberFromBarcode worked
1791     my $hbr      = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1792         # get the proper branch to which to return the item
1793     $hbr = $item->{$hbr} || $branch ;
1794         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1795
1796     my $borrowernumber = $borrower->{'borrowernumber'} || undef;    # we don't know if we had a borrower or not
1797
1798     my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1799     if ($yaml) {
1800         $yaml = "$yaml\n\n";  # YAML is anal on ending \n. Surplus does not hurt
1801         my $rules;
1802         eval { $rules = YAML::Load($yaml); };
1803         if ($@) {
1804             warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1805         }
1806         else {
1807             foreach my $key ( keys %$rules ) {
1808                 if ( $item->{notforloan} eq $key ) {
1809                     $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1810                     ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1811                     last;
1812                 }
1813             }
1814         }
1815     }
1816
1817
1818     # check if the book is in a permanent collection....
1819     # FIXME -- This 'PE' attribute is largely undocumented.  afaict, there's no user interface that reflects this functionality.
1820     if ( $hbr ) {
1821         my $branches = GetBranches();    # a potentially expensive call for a non-feature.
1822         $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1823     }
1824
1825     # check if the return is allowed at this branch
1826     my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1827     unless ($returnallowed){
1828         $messages->{'Wrongbranch'} = {
1829             Wrongbranch => $branch,
1830             Rightbranch => $message
1831         };
1832         $doreturn = 0;
1833         return ( $doreturn, $messages, $issue, $borrower );
1834     }
1835
1836     if ( $item->{'withdrawn'} ) { # book has been cancelled
1837         $messages->{'withdrawn'} = 1;
1838         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1839     }
1840
1841     # case of a return of document (deal with issues and holdingbranch)
1842     my $today = DateTime->now( time_zone => C4::Context->tz() );
1843
1844     if ($doreturn) {
1845         my $datedue = $issue->{date_due};
1846         $borrower or warn "AddReturn without current borrower";
1847                 my $circControlBranch;
1848         if ($dropbox) {
1849             # define circControlBranch only if dropbox mode is set
1850             # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1851             # FIXME: check issuedate > returndate, factoring in holidays
1852             #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1853             $circControlBranch = _GetCircControlBranch($item,$borrower);
1854             $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $dropboxdate ) == -1 ? 1 : 0;
1855         }
1856
1857         if ($borrowernumber) {
1858             if ( ( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'} ) || $return_date ) {
1859                 # we only need to calculate and change the fines if we want to do that on return
1860                 # Should be on for hourly loans
1861                 my $control = C4::Context->preference('CircControl');
1862                 my $control_branchcode =
1863                     ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
1864                   : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
1865                   :                                     $issue->{branchcode};
1866
1867                 my $date_returned =
1868                   $return_date ? dt_from_string($return_date) : $today;
1869
1870                 my ( $amount, $type, $unitcounttotal ) =
1871                   C4::Overdues::CalcFine( $item, $borrower->{categorycode},
1872                     $control_branchcode, $datedue, $date_returned );
1873
1874                 $type ||= q{};
1875
1876                 if ( C4::Context->preference('finesMode') eq 'production' ) {
1877                     if ( $amount > 0 ) {
1878                         C4::Overdues::UpdateFine( $issue->{itemnumber},
1879                             $issue->{borrowernumber},
1880                             $amount, $type, output_pref($datedue) );
1881                     }
1882                     elsif ($return_date) {
1883
1884                        # Backdated returns may have fines that shouldn't exist,
1885                        # so in this case, we need to drop those fines to 0
1886
1887                         C4::Overdues::UpdateFine( $issue->{itemnumber},
1888                             $issue->{borrowernumber},
1889                             0, $type, output_pref($datedue) );
1890                     }
1891                 }
1892             }
1893
1894             MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1895                 $circControlBranch, $return_date, $borrower->{'privacy'} );
1896
1897             # FIXME is the "= 1" right?  This could be the borrower hash.
1898             $messages->{'WasReturned'} = 1;
1899
1900         }
1901
1902         ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1903     }
1904
1905     # the holdingbranch is updated if the document is returned to another location.
1906     # this is always done regardless of whether the item was on loan or not
1907     if ($item->{'holdingbranch'} ne $branch) {
1908         UpdateHoldingbranch($branch, $item->{'itemnumber'});
1909         $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1910     }
1911     ModDateLastSeen( $item->{'itemnumber'} );
1912
1913     # check if we have a transfer for this document
1914     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1915
1916     # if we have a transfer to do, we update the line of transfers with the datearrived
1917     my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
1918     if ($datesent) {
1919         if ( $tobranch eq $branch ) {
1920             my $sth = C4::Context->dbh->prepare(
1921                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1922             );
1923             $sth->execute( $item->{'itemnumber'} );
1924             # if we have a reservation with valid transfer, we can set it's status to 'W'
1925             ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1926             C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1927         } else {
1928             $messages->{'WrongTransfer'}     = $tobranch;
1929             $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1930         }
1931         $validTransfert = 1;
1932     } else {
1933         ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1934     }
1935
1936     # fix up the accounts.....
1937     if ( $item->{'itemlost'} ) {
1938         $messages->{'WasLost'} = 1;
1939
1940         if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1941             _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode);    # can tolerate undef $borrowernumber
1942             $messages->{'LostItemFeeRefunded'} = 1;
1943         }
1944     }
1945
1946     # fix up the overdues in accounts...
1947     if ($borrowernumber) {
1948         my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1949         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!";  # zero is OK, check defined
1950
1951         if ( $issue->{overdue} && $issue->{date_due} ) {
1952         # fix fine days
1953             $today = $dropboxdate if $dropbox;
1954             my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1955             if ($reminder){
1956                 $messages->{'PrevDebarred'} = $debardate;
1957             } else {
1958                 $messages->{'Debarred'} = $debardate if $debardate;
1959             }
1960         # there's no overdue on the item but borrower had been previously debarred
1961         } elsif ( $issue->{date_due} and $borrower->{'debarred'} ) {
1962              if ( $borrower->{debarred} eq "9999-12-31") {
1963                 $messages->{'ForeverDebarred'} = $borrower->{'debarred'};
1964              } else {
1965                   my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
1966                   $borrower_debar_dt->truncate(to => 'day');
1967                   my $today_dt = $today->clone()->truncate(to => 'day');
1968                   if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
1969                       $messages->{'PrevDebarred'} = $borrower->{'debarred'};
1970                   }
1971              }
1972         }
1973     }
1974
1975     # find reserves.....
1976     # if we don't have a reserve with the status W, we launch the Checkreserves routine
1977     my ($resfound, $resrec);
1978     my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1979     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
1980     if ($resfound) {
1981           $resrec->{'ResFound'} = $resfound;
1982         $messages->{'ResFound'} = $resrec;
1983     }
1984
1985     # Record the fact that this book was returned.
1986     # FIXME itemtype should record item level type, not bibliolevel type
1987     UpdateStats({
1988                 branch => $branch,
1989                 type => $stat_type,
1990                 itemnumber => $item->{'itemnumber'},
1991                 itemtype => $biblio->{'itemtype'},
1992                 borrowernumber => $borrowernumber,
1993                 ccode => $item->{'ccode'}}
1994     );
1995
1996     # Send a check-in slip. # NOTE: borrower may be undef.  probably shouldn't try to send messages then.
1997     my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1998     my %conditions = (
1999         branchcode   => $branch,
2000         categorycode => $borrower->{categorycode},
2001         item_type    => $item->{itype},
2002         notification => 'CHECKIN',
2003     );
2004     if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2005         SendCirculationAlert({
2006             type     => 'CHECKIN',
2007             item     => $item,
2008             borrower => $borrower,
2009             branch   => $branch,
2010         });
2011     }
2012
2013     logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2014         if C4::Context->preference("ReturnLog");
2015
2016     # Remove any OVERDUES related debarment if the borrower has no overdues
2017     if ( $borrowernumber
2018       && $borrower->{'debarred'}
2019       && C4::Context->preference('AutoRemoveOverduesRestrictions')
2020       && !C4::Members::HasOverdues( $borrowernumber )
2021       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2022     ) {
2023         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2024     }
2025
2026     # FIXME: make this comment intelligible.
2027     #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
2028     #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
2029
2030     if ( !$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
2031         if ( C4::Context->preference("AutomaticItemReturn"    ) or
2032             (C4::Context->preference("UseBranchTransferLimits") and
2033              ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2034            )) {
2035             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
2036             $debug and warn "item: " . Dumper($item);
2037             ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
2038             $messages->{'WasTransfered'} = 1;
2039         } else {
2040             $messages->{'NeedsTransfer'} = 1;   # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
2041         }
2042     }
2043
2044     return ( $doreturn, $messages, $issue, $borrower );
2045 }
2046
2047 =head2 MarkIssueReturned
2048
2049   MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2050
2051 Unconditionally marks an issue as being returned by
2052 moving the C<issues> row to C<old_issues> and
2053 setting C<returndate> to the current date, or
2054 the last non-holiday date of the branccode specified in
2055 C<dropbox_branch> .  Assumes you've already checked that
2056 it's safe to do this, i.e. last non-holiday > issuedate.
2057
2058 if C<$returndate> is specified (in iso format), it is used as the date
2059 of the return. It is ignored when a dropbox_branch is passed in.
2060
2061 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2062 the old_issue is immediately anonymised
2063
2064 Ideally, this function would be internal to C<C4::Circulation>,
2065 not exported, but it is currently needed by one
2066 routine in C<C4::Accounts>.
2067
2068 =cut
2069
2070 sub MarkIssueReturned {
2071     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2072
2073     my $dbh   = C4::Context->dbh;
2074     my $query = 'UPDATE issues SET returndate=';
2075     my @bind;
2076     if ($dropbox_branch) {
2077         my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2078         my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2079         $query .= ' ? ';
2080         push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2081     } elsif ($returndate) {
2082         $query .= ' ? ';
2083         push @bind, $returndate;
2084     } else {
2085         $query .= ' now() ';
2086     }
2087     $query .= ' WHERE  borrowernumber = ?  AND itemnumber = ?';
2088     push @bind, $borrowernumber, $itemnumber;
2089     # FIXME transaction
2090     my $sth_upd  = $dbh->prepare($query);
2091     $sth_upd->execute(@bind);
2092     my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
2093                                   WHERE borrowernumber = ?
2094                                   AND itemnumber = ?');
2095     $sth_copy->execute($borrowernumber, $itemnumber);
2096     # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2097     if ( $privacy == 2) {
2098         # The default of 0 does not work due to foreign key constraints
2099         # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2100         # FIXME the above is unacceptable - bug 9942 relates
2101         my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2102         my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
2103                                   WHERE borrowernumber = ?
2104                                   AND itemnumber = ?");
2105        $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2106     }
2107     my $sth_del  = $dbh->prepare("DELETE FROM issues
2108                                   WHERE borrowernumber = ?
2109                                   AND itemnumber = ?");
2110     $sth_del->execute($borrowernumber, $itemnumber);
2111
2112     ModItem( { 'onloan' => undef }, undef, $itemnumber );
2113 }
2114
2115 =head2 _debar_user_on_return
2116
2117     _debar_user_on_return($borrower, $item, $datedue, today);
2118
2119 C<$borrower> borrower hashref
2120
2121 C<$item> item hashref
2122
2123 C<$datedue> date due DateTime object
2124
2125 C<$today> DateTime object representing the return time
2126
2127 Internal function, called only by AddReturn that calculates and updates
2128  the user fine days, and debars him if necessary.
2129
2130 Should only be called for overdue returns
2131
2132 =cut
2133
2134 sub _debar_user_on_return {
2135     my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2136
2137     my $branchcode = _GetCircControlBranch( $item, $borrower );
2138
2139     my $circcontrol = C4::Context->preference('CircControl');
2140     my $issuingrule =
2141       GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2142     my $finedays = $issuingrule->{finedays};
2143     my $unit     = $issuingrule->{lengthunit};
2144     my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $dt_today, $branchcode);
2145
2146     if ($finedays) {
2147
2148         # finedays is in days, so hourly loans must multiply by 24
2149         # thus 1 hour late equals 1 day suspension * finedays rate
2150         $finedays = $finedays * 24 if ( $unit eq 'hours' );
2151
2152         # grace period is measured in the same units as the loan
2153         my $grace =
2154           DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2155
2156         my $deltadays = DateTime::Duration->new(
2157             days => $chargeable_units
2158         );
2159         if ( $deltadays->subtract($grace)->is_positive() ) {
2160             my $suspension_days = $deltadays * $finedays;
2161
2162             # If the max suspension days is < than the suspension days
2163             # the suspension days is limited to this maximum period.
2164             my $max_sd = $issuingrule->{maxsuspensiondays};
2165             if ( defined $max_sd ) {
2166                 $max_sd = DateTime::Duration->new( days => $max_sd );
2167                 $suspension_days = $max_sd
2168                   if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2169             }
2170
2171             my $new_debar_dt =
2172               $dt_today->clone()->add_duration( $suspension_days );
2173
2174             Koha::Borrower::Debarments::AddUniqueDebarment({
2175                 borrowernumber => $borrower->{borrowernumber},
2176                 expiration     => $new_debar_dt->ymd(),
2177                 type           => 'SUSPENSION',
2178             });
2179             # if borrower was already debarred but does not get an extra debarment
2180             if ( $borrower->{debarred} eq Koha::Borrower::Debarments::IsDebarred($borrower->{borrowernumber}) ) {
2181                     return ($borrower->{debarred},1);
2182             }
2183             return $new_debar_dt->ymd();
2184         }
2185     }
2186     return;
2187 }
2188
2189 =head2 _FixOverduesOnReturn
2190
2191    &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2192
2193 C<$brn> borrowernumber
2194
2195 C<$itm> itemnumber
2196
2197 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2198 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2199
2200 Internal function, called only by AddReturn
2201
2202 =cut
2203
2204 sub _FixOverduesOnReturn {
2205     my ($borrowernumber, $item);
2206     unless ($borrowernumber = shift) {
2207         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2208         return;
2209     }
2210     unless ($item = shift) {
2211         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2212         return;
2213     }
2214     my ($exemptfine, $dropbox) = @_;
2215     my $dbh = C4::Context->dbh;
2216
2217     # check for overdue fine
2218     my $sth = $dbh->prepare(
2219 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2220     );
2221     $sth->execute( $borrowernumber, $item );
2222
2223     # alter fine to show that the book has been returned
2224     my $data = $sth->fetchrow_hashref;
2225     return 0 unless $data;    # no warning, there's just nothing to fix
2226
2227     my $uquery;
2228     my @bind = ($data->{'accountlines_id'});
2229     if ($exemptfine) {
2230         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2231         if (C4::Context->preference("FinesLog")) {
2232             &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2233         }
2234     } elsif ($dropbox && $data->{lastincrement}) {
2235         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2236         my $amt = $data->{amount} - $data->{lastincrement} ;
2237         if (C4::Context->preference("FinesLog")) {
2238             &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2239         }
2240          $uquery = "update accountlines set accounttype='F' ";
2241          if($outstanding  >= 0 && $amt >=0) {
2242             $uquery .= ", amount = ? , amountoutstanding=? ";
2243             unshift @bind, ($amt, $outstanding) ;
2244         }
2245     } else {
2246         $uquery = "update accountlines set accounttype='F' ";
2247     }
2248     $uquery .= " where (accountlines_id = ?)";
2249     my $usth = $dbh->prepare($uquery);
2250     return $usth->execute(@bind);
2251 }
2252
2253 =head2 _FixAccountForLostAndReturned
2254
2255   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2256
2257 Calculates the charge for a book lost and returned.
2258
2259 Internal function, not exported, called only by AddReturn.
2260
2261 FIXME: This function reflects how inscrutable fines logic is.  Fix both.
2262 FIXME: Give a positive return value on success.  It might be the $borrowernumber who received credit, or the amount forgiven.
2263
2264 =cut
2265
2266 sub _FixAccountForLostAndReturned {
2267     my $itemnumber     = shift or return;
2268     my $borrowernumber = @_ ? shift : undef;
2269     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2270     my $dbh = C4::Context->dbh;
2271     # check for charge made for lost book
2272     my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2273     $sth->execute($itemnumber);
2274     my $data = $sth->fetchrow_hashref;
2275     $data or return;    # bail if there is nothing to do
2276     $data->{accounttype} eq 'W' and return;    # Written off
2277
2278     # writeoff this amount
2279     my $offset;
2280     my $amount = $data->{'amount'};
2281     my $acctno = $data->{'accountno'};
2282     my $amountleft;                                             # Starts off undef/zero.
2283     if ($data->{'amountoutstanding'} == $amount) {
2284         $offset     = $data->{'amount'};
2285         $amountleft = 0;                                        # Hey, it's zero here, too.
2286     } else {
2287         $offset     = $amount - $data->{'amountoutstanding'};   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2288         $amountleft = $data->{'amountoutstanding'} - $amount;   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2289     }
2290     my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2291         WHERE (accountlines_id = ?)");
2292     $usth->execute($data->{'accountlines_id'});      # We might be adjusting an account for some OTHER borrowernumber now.  Not the one we passed in.
2293     #check if any credit is left if so writeoff other accounts
2294     my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2295     $amountleft *= -1 if ($amountleft < 0);
2296     if ($amountleft > 0) {
2297         my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2298                             AND (amountoutstanding >0) ORDER BY date");     # might want to order by amountoustanding ASC (pay smallest first)
2299         $msth->execute($data->{'borrowernumber'});
2300         # offset transactions
2301         my $newamtos;
2302         my $accdata;
2303         while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2304             if ($accdata->{'amountoutstanding'} < $amountleft) {
2305                 $newamtos = 0;
2306                 $amountleft -= $accdata->{'amountoutstanding'};
2307             }  else {
2308                 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2309                 $amountleft = 0;
2310             }
2311             my $thisacct = $accdata->{'accountlines_id'};
2312             # FIXME: move prepares outside while loop!
2313             my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2314                     WHERE (accountlines_id = ?)");
2315             $usth->execute($newamtos,$thisacct);
2316             $usth = $dbh->prepare("INSERT INTO accountoffsets
2317                 (borrowernumber, accountno, offsetaccount,  offsetamount)
2318                 VALUES
2319                 (?,?,?,?)");
2320             $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2321         }
2322     }
2323     $amountleft *= -1 if ($amountleft > 0);
2324     my $desc = "Item Returned " . $item_id;
2325     $usth = $dbh->prepare("INSERT INTO accountlines
2326         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2327         VALUES (?,?,now(),?,?,'CR',?)");
2328     $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2329     if ($borrowernumber) {
2330         # FIXME: same as query above.  use 1 sth for both
2331         $usth = $dbh->prepare("INSERT INTO accountoffsets
2332             (borrowernumber, accountno, offsetaccount,  offsetamount)
2333             VALUES (?,?,?,?)");
2334         $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2335     }
2336     ModItem({ paidfor => '' }, undef, $itemnumber);
2337     return;
2338 }
2339
2340 =head2 _GetCircControlBranch
2341
2342    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2343
2344 Internal function :
2345
2346 Return the library code to be used to determine which circulation
2347 policy applies to a transaction.  Looks up the CircControl and
2348 HomeOrHoldingBranch system preferences.
2349
2350 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2351
2352 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2353
2354 =cut
2355
2356 sub _GetCircControlBranch {
2357     my ($item, $borrower) = @_;
2358     my $circcontrol = C4::Context->preference('CircControl');
2359     my $branch;
2360
2361     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2362         $branch= C4::Context->userenv->{'branch'};
2363     } elsif ($circcontrol eq 'PatronLibrary') {
2364         $branch=$borrower->{branchcode};
2365     } else {
2366         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2367         $branch = $item->{$branchfield};
2368         # default to item home branch if holdingbranch is used
2369         # and is not defined
2370         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2371             $branch = $item->{homebranch};
2372         }
2373     }
2374     return $branch;
2375 }
2376
2377
2378
2379
2380
2381
2382 =head2 GetItemIssue
2383
2384   $issue = &GetItemIssue($itemnumber);
2385
2386 Returns patron currently having a book, or undef if not checked out.
2387
2388 C<$itemnumber> is the itemnumber.
2389
2390 C<$issue> is a hashref of the row from the issues table.
2391
2392 =cut
2393
2394 sub GetItemIssue {
2395     my ($itemnumber) = @_;
2396     return unless $itemnumber;
2397     my $sth = C4::Context->dbh->prepare(
2398         "SELECT items.*, issues.*
2399         FROM issues
2400         LEFT JOIN items ON issues.itemnumber=items.itemnumber
2401         WHERE issues.itemnumber=?");
2402     $sth->execute($itemnumber);
2403     my $data = $sth->fetchrow_hashref;
2404     return unless $data;
2405     $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2406     $data->{issuedate}->truncate(to => 'minute');
2407     $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2408     $data->{date_due}->truncate(to => 'minute');
2409     my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2410     $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2411     return $data;
2412 }
2413
2414 =head2 GetOpenIssue
2415
2416   $issue = GetOpenIssue( $itemnumber );
2417
2418 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2419
2420 C<$itemnumber> is the item's itemnumber
2421
2422 Returns a hashref
2423
2424 =cut
2425
2426 sub GetOpenIssue {
2427   my ( $itemnumber ) = @_;
2428   return unless $itemnumber;
2429   my $dbh = C4::Context->dbh;
2430   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2431   $sth->execute( $itemnumber );
2432   return $sth->fetchrow_hashref();
2433
2434 }
2435
2436 =head2 GetIssues
2437
2438     $issues = GetIssues({});    # return all issues!
2439     $issues = GetIssues({ borrowernumber => $borrowernumber, biblionumber => $biblionumber });
2440
2441 Returns all pending issues that match given criteria.
2442 Returns a arrayref or undef if an error occurs.
2443
2444 Allowed criteria are:
2445
2446 =over 2
2447
2448 =item * borrowernumber
2449
2450 =item * biblionumber
2451
2452 =item * itemnumber
2453
2454 =back
2455
2456 =cut
2457
2458 sub GetIssues {
2459     my ($criteria) = @_;
2460
2461     # Build filters
2462     my @filters;
2463     my @allowed = qw(borrowernumber biblionumber itemnumber);
2464     foreach (@allowed) {
2465         if (defined $criteria->{$_}) {
2466             push @filters, {
2467                 field => $_,
2468                 value => $criteria->{$_},
2469             };
2470         }
2471     }
2472
2473     # Do we need to join other tables ?
2474     my %join;
2475     if (defined $criteria->{biblionumber}) {
2476         $join{items} = 1;
2477     }
2478
2479     # Build SQL query
2480     my $where = '';
2481     if (@filters) {
2482         $where = "WHERE " . join(' AND ', map { "$_->{field} = ?" } @filters);
2483     }
2484     my $query = q{
2485         SELECT issues.*
2486         FROM issues
2487     };
2488     if (defined $join{items}) {
2489         $query .= q{
2490             LEFT JOIN items ON (issues.itemnumber = items.itemnumber)
2491         };
2492     }
2493     $query .= $where;
2494
2495     # Execute SQL query
2496     my $dbh = C4::Context->dbh;
2497     my $sth = $dbh->prepare($query);
2498     my $rv = $sth->execute(map { $_->{value} } @filters);
2499
2500     return $rv ? $sth->fetchall_arrayref({}) : undef;
2501 }
2502
2503 =head2 GetItemIssues
2504
2505   $issues = &GetItemIssues($itemnumber, $history);
2506
2507 Returns patrons that have issued a book
2508
2509 C<$itemnumber> is the itemnumber
2510 C<$history> is false if you just want the current "issuer" (if any)
2511 and true if you want issues history from old_issues also.
2512
2513 Returns reference to an array of hashes
2514
2515 =cut
2516
2517 sub GetItemIssues {
2518     my ( $itemnumber, $history ) = @_;
2519
2520     my $today = DateTime->now( time_zome => C4::Context->tz);  # get today date
2521     $today->truncate( to => 'minute' );
2522     my $sql = "SELECT * FROM issues
2523               JOIN borrowers USING (borrowernumber)
2524               JOIN items     USING (itemnumber)
2525               WHERE issues.itemnumber = ? ";
2526     if ($history) {
2527         $sql .= "UNION ALL
2528                  SELECT * FROM old_issues
2529                  LEFT JOIN borrowers USING (borrowernumber)
2530                  JOIN items USING (itemnumber)
2531                  WHERE old_issues.itemnumber = ? ";
2532     }
2533     $sql .= "ORDER BY date_due DESC";
2534     my $sth = C4::Context->dbh->prepare($sql);
2535     if ($history) {
2536         $sth->execute($itemnumber, $itemnumber);
2537     } else {
2538         $sth->execute($itemnumber);
2539     }
2540     my $results = $sth->fetchall_arrayref({});
2541     foreach (@$results) {
2542         my $date_due = dt_from_string($_->{date_due},'sql');
2543         $date_due->truncate( to => 'minute' );
2544
2545         $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2546     }
2547     return $results;
2548 }
2549
2550 =head2 GetBiblioIssues
2551
2552   $issues = GetBiblioIssues($biblionumber);
2553
2554 this function get all issues from a biblionumber.
2555
2556 Return:
2557 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2558 tables issues and the firstname,surname & cardnumber from borrowers.
2559
2560 =cut
2561
2562 sub GetBiblioIssues {
2563     my $biblionumber = shift;
2564     return unless $biblionumber;
2565     my $dbh   = C4::Context->dbh;
2566     my $query = "
2567         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2568         FROM issues
2569             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2570             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2571             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2572             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2573         WHERE biblio.biblionumber = ?
2574         UNION ALL
2575         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2576         FROM old_issues
2577             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2578             LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2579             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2580             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2581         WHERE biblio.biblionumber = ?
2582         ORDER BY timestamp
2583     ";
2584     my $sth = $dbh->prepare($query);
2585     $sth->execute($biblionumber, $biblionumber);
2586
2587     my @issues;
2588     while ( my $data = $sth->fetchrow_hashref ) {
2589         push @issues, $data;
2590     }
2591     return \@issues;
2592 }
2593
2594 =head2 GetUpcomingDueIssues
2595
2596   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2597
2598 =cut
2599
2600 sub GetUpcomingDueIssues {
2601     my $params = shift;
2602
2603     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2604     my $dbh = C4::Context->dbh;
2605
2606     my $statement = <<END_SQL;
2607 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2608 FROM issues
2609 LEFT JOIN items USING (itemnumber)
2610 LEFT OUTER JOIN branches USING (branchcode)
2611 WHERE returndate is NULL
2612 HAVING days_until_due >= 0 AND days_until_due <= ?
2613 END_SQL
2614
2615     my @bind_parameters = ( $params->{'days_in_advance'} );
2616
2617     my $sth = $dbh->prepare( $statement );
2618     $sth->execute( @bind_parameters );
2619     my $upcoming_dues = $sth->fetchall_arrayref({});
2620
2621     return $upcoming_dues;
2622 }
2623
2624 =head2 CanBookBeRenewed
2625
2626   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2627
2628 Find out whether a borrowed item may be renewed.
2629
2630 C<$borrowernumber> is the borrower number of the patron who currently
2631 has the item on loan.
2632
2633 C<$itemnumber> is the number of the item to renew.
2634
2635 C<$override_limit>, if supplied with a true value, causes
2636 the limit on the number of times that the loan can be renewed
2637 (as controlled by the item type) to be ignored. Overriding also allows
2638 to renew sooner than "No renewal before" and to manually renew loans
2639 that are automatically renewed.
2640
2641 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2642 item must currently be on loan to the specified borrower; renewals
2643 must be allowed for the item's type; and the borrower must not have
2644 already renewed the loan. $error will contain the reason the renewal can not proceed
2645
2646 =cut
2647
2648 sub CanBookBeRenewed {
2649     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2650
2651     my $dbh    = C4::Context->dbh;
2652     my $renews = 1;
2653
2654     my $item      = GetItem($itemnumber)      or return ( 0, 'no_item' );
2655     my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2656
2657     $borrowernumber ||= $itemissue->{borrowernumber};
2658     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2659       or return;
2660
2661     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2662
2663     # This item can fill one or more unfilled reserve, can those unfilled reserves
2664     # all be filled by other available items?
2665     if ( $resfound
2666         && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2667     {
2668         my $schema = Koha::Database->new()->schema();
2669
2670         # Get all other items that could possibly fill reserves
2671         my @itemnumbers = $schema->resultset('Item')->search(
2672             {
2673                 biblionumber => $resrec->{biblionumber},
2674                 onloan       => undef,
2675                 -not         => { itemnumber => $itemnumber }
2676             },
2677             { columns => 'itemnumber' }
2678         )->get_column('itemnumber')->all();
2679
2680         # Get all other reserves that could have been filled by this item
2681         my @borrowernumbers;
2682         while (1) {
2683             my ( $reserve_found, $reserve, undef ) =
2684               C4::Reserves::CheckReserves( $itemnumber, undef, undef,
2685                 \@borrowernumbers );
2686
2687             if ($reserve_found) {
2688                 push( @borrowernumbers, $reserve->{borrowernumber} );
2689             }
2690             else {
2691                 last;
2692             }
2693         }
2694
2695         # If the count of the union of the lists of reservable items for each borrower
2696         # is equal or greater than the number of borrowers, we know that all reserves
2697         # can be filled with available items. We can get the union of the sets simply
2698         # by pushing all the elements onto an array and removing the duplicates.
2699         my @reservable;
2700         foreach my $b (@borrowernumbers) {
2701             my ( $borr ) = C4::Members::GetMemberDetails( $b );
2702             foreach my $i (@itemnumbers) {
2703                 my $item   = GetItem($i);
2704                 if (   IsAvailableForItemLevelRequest($item, $borr)
2705                     && CanItemBeReserved( $b, $i )
2706                     && !IsItemOnHoldAndFound($i) )
2707                 {
2708                     push( @reservable, $i );
2709                 }
2710             }
2711         }
2712
2713         @reservable = uniq(@reservable);
2714
2715         if ( @reservable >= @borrowernumbers ) {
2716             $resfound = 0;
2717         }
2718     }
2719
2720     return ( 0, "on_reserve" ) if $resfound;    # '' when no hold was found
2721
2722     return ( 1, undef ) if $override_limit;
2723
2724     my $branchcode = _GetCircControlBranch( $item, $borrower );
2725     my $issuingrule =
2726       GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2727
2728     return ( 0, "too_many" )
2729       if $issuingrule->{renewalsallowed} <= $itemissue->{renewals};
2730
2731     if ( $issuingrule->{norenewalbefore} ) {
2732
2733         # Get current time and add norenewalbefore.
2734         # If this is smaller than date_due, it's too soon for renewal.
2735         if (
2736             DateTime->now( time_zone => C4::Context->tz() )->add(
2737                 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore}
2738             ) < $itemissue->{date_due}
2739           )
2740         {
2741             return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2742             return ( 0, "too_soon" );
2743         }
2744     }
2745
2746     return ( 0, "auto_renew" ) if $itemissue->{auto_renew};
2747     return ( 1, undef );
2748 }
2749
2750 =head2 AddRenewal
2751
2752   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2753
2754 Renews a loan.
2755
2756 C<$borrowernumber> is the borrower number of the patron who currently
2757 has the item.
2758
2759 C<$itemnumber> is the number of the item to renew.
2760
2761 C<$branch> is the library where the renewal took place (if any).
2762            The library that controls the circ policies for the renewal is retrieved from the issues record.
2763
2764 C<$datedue> can be a C4::Dates object used to set the due date.
2765
2766 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2767 this parameter is not supplied, lastreneweddate is set to the current date.
2768
2769 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2770 from the book's item type.
2771
2772 =cut
2773
2774 sub AddRenewal {
2775     my $borrowernumber  = shift;
2776     my $itemnumber      = shift or return;
2777     my $branch          = shift;
2778     my $datedue         = shift;
2779     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2780
2781     my $item   = GetItem($itemnumber) or return;
2782     my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2783
2784     my $dbh = C4::Context->dbh;
2785
2786     # Find the issues record for this book
2787     my $sth =
2788       $dbh->prepare("SELECT * FROM issues WHERE itemnumber = ?");
2789     $sth->execute( $itemnumber );
2790     my $issuedata = $sth->fetchrow_hashref;
2791
2792     return unless ( $issuedata );
2793
2794     $borrowernumber ||= $issuedata->{borrowernumber};
2795
2796     if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2797         carp 'Invalid date passed to AddRenewal.';
2798         return;
2799     }
2800
2801     # If the due date wasn't specified, calculate it by adding the
2802     # book's loan length to today's date or the current due date
2803     # based on the value of the RenewalPeriodBase syspref.
2804     unless ($datedue) {
2805
2806         my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2807         my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2808
2809         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2810                                         dt_from_string( $issuedata->{date_due} ) :
2811                                         DateTime->now( time_zone => C4::Context->tz());
2812         $datedue =  CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2813     }
2814
2815     # Update the issues record to have the new due date, and a new count
2816     # of how many times it has been renewed.
2817     my $renews = $issuedata->{'renewals'} + 1;
2818     $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2819                             WHERE borrowernumber=?
2820                             AND itemnumber=?"
2821     );
2822
2823     $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2824
2825     # Update the renewal count on the item, and tell zebra to reindex
2826     $renews = $biblio->{'renewals'} + 1;
2827     ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2828
2829     # Charge a new rental fee, if applicable?
2830     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2831     if ( $charge > 0 ) {
2832         my $accountno = getnextacctno( $borrowernumber );
2833         my $item = GetBiblioFromItemNumber($itemnumber);
2834         my $manager_id = 0;
2835         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2836         $sth = $dbh->prepare(
2837                 "INSERT INTO accountlines
2838                     (date, borrowernumber, accountno, amount, manager_id,
2839                     description,accounttype, amountoutstanding, itemnumber)
2840                     VALUES (now(),?,?,?,?,?,?,?,?)"
2841         );
2842         $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2843             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2844             'Rent', $charge, $itemnumber );
2845     }
2846
2847     # Send a renewal slip according to checkout alert preferencei
2848     if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2849         my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2850         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2851         my %conditions = (
2852                 branchcode   => $branch,
2853                 categorycode => $borrower->{categorycode},
2854                 item_type    => $item->{itype},
2855                 notification => 'CHECKOUT',
2856         );
2857         if ($circulation_alert->is_enabled_for(\%conditions)) {
2858                 SendCirculationAlert({
2859                         type     => 'RENEWAL',
2860                         item     => $item,
2861                 borrower => $borrower,
2862                 branch   => $branch,
2863                 });
2864         }
2865     }
2866
2867     # Remove any OVERDUES related debarment if the borrower has no overdues
2868     my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2869     if ( $borrowernumber
2870       && $borrower->{'debarred'}
2871       && !C4::Members::HasOverdues( $borrowernumber )
2872       && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2873     ) {
2874         DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2875     }
2876
2877     # Log the renewal
2878     UpdateStats({branch => $branch,
2879                 type => 'renew',
2880                 amount => $charge,
2881                 itemnumber => $itemnumber,
2882                 itemtype => $item->{itype},
2883                 borrowernumber => $borrowernumber,
2884                 ccode => $item->{'ccode'}}
2885                 );
2886         return $datedue;
2887 }
2888
2889 sub GetRenewCount {
2890     # check renewal status
2891     my ( $bornum, $itemno ) = @_;
2892     my $dbh           = C4::Context->dbh;
2893     my $renewcount    = 0;
2894     my $renewsallowed = 0;
2895     my $renewsleft    = 0;
2896
2897     my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2898     my $item     = GetItem($itemno);
2899
2900     # Look in the issues table for this item, lent to this borrower,
2901     # and not yet returned.
2902
2903     # FIXME - I think this function could be redone to use only one SQL call.
2904     my $sth = $dbh->prepare(
2905         "select * from issues
2906                                 where (borrowernumber = ?)
2907                                 and (itemnumber = ?)"
2908     );
2909     $sth->execute( $bornum, $itemno );
2910     my $data = $sth->fetchrow_hashref;
2911     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2912     # $item and $borrower should be calculated
2913     my $branchcode = _GetCircControlBranch($item, $borrower);
2914
2915     my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2916
2917     $renewsallowed = $issuingrule->{'renewalsallowed'};
2918     $renewsleft    = $renewsallowed - $renewcount;
2919     if($renewsleft < 0){ $renewsleft = 0; }
2920     return ( $renewcount, $renewsallowed, $renewsleft );
2921 }
2922
2923 =head2 GetSoonestRenewDate
2924
2925   $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2926
2927 Find out the soonest possible renew date of a borrowed item.
2928
2929 C<$borrowernumber> is the borrower number of the patron who currently
2930 has the item on loan.
2931
2932 C<$itemnumber> is the number of the item to renew.
2933
2934 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2935 renew date, based on the value "No renewal before" of the applicable
2936 issuing rule. Returns the current date if the item can already be
2937 renewed, and returns undefined if the borrower, loan, or item
2938 cannot be found.
2939
2940 =cut
2941
2942 sub GetSoonestRenewDate {
2943     my ( $borrowernumber, $itemnumber ) = @_;
2944
2945     my $dbh = C4::Context->dbh;
2946
2947     my $item      = GetItem($itemnumber)      or return;
2948     my $itemissue = GetItemIssue($itemnumber) or return;
2949
2950     $borrowernumber ||= $itemissue->{borrowernumber};
2951     my $borrower = C4::Members::GetMemberDetails($borrowernumber)
2952       or return;
2953
2954     my $branchcode = _GetCircControlBranch( $item, $borrower );
2955     my $issuingrule =
2956       GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2957
2958     my $now = DateTime->now( time_zone => C4::Context->tz() );
2959
2960     if ( $issuingrule->{norenewalbefore} ) {
2961         my $soonestrenewal =
2962           $itemissue->{date_due}->subtract(
2963             $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore} );
2964
2965         $soonestrenewal = $now > $soonestrenewal ? $now : $soonestrenewal;
2966         return $soonestrenewal;
2967     }
2968     return $now;
2969 }
2970
2971 =head2 GetIssuingCharges
2972
2973   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2974
2975 Calculate how much it would cost for a given patron to borrow a given
2976 item, including any applicable discounts.
2977
2978 C<$itemnumber> is the item number of item the patron wishes to borrow.
2979
2980 C<$borrowernumber> is the patron's borrower number.
2981
2982 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2983 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2984 if it's a video).
2985
2986 =cut
2987
2988 sub GetIssuingCharges {
2989
2990     # calculate charges due
2991     my ( $itemnumber, $borrowernumber ) = @_;
2992     my $charge = 0;
2993     my $dbh    = C4::Context->dbh;
2994     my $item_type;
2995
2996     # Get the book's item type and rental charge (via its biblioitem).
2997     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2998         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2999     $charge_query .= (C4::Context->preference('item-level_itypes'))
3000         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3001         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3002
3003     $charge_query .= ' WHERE items.itemnumber =?';
3004
3005     my $sth = $dbh->prepare($charge_query);
3006     $sth->execute($itemnumber);
3007     if ( my $item_data = $sth->fetchrow_hashref ) {
3008         $item_type = $item_data->{itemtype};
3009         $charge    = $item_data->{rentalcharge};
3010         my $branch = C4::Branch::mybranch();
3011         my $discount_query = q|SELECT rentaldiscount,
3012             issuingrules.itemtype, issuingrules.branchcode
3013             FROM borrowers
3014             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3015             WHERE borrowers.borrowernumber = ?
3016             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3017             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3018         my $discount_sth = $dbh->prepare($discount_query);
3019         $discount_sth->execute( $borrowernumber, $item_type, $branch );
3020         my $discount_rules = $discount_sth->fetchall_arrayref({});
3021         if (@{$discount_rules}) {
3022             # We may have multiple rules so get the most specific
3023             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3024             $charge = ( $charge * ( 100 - $discount ) ) / 100;
3025         }
3026     }
3027
3028     return ( $charge, $item_type );
3029 }
3030
3031 # Select most appropriate discount rule from those returned
3032 sub _get_discount_from_rule {
3033     my ($rules_ref, $branch, $itemtype) = @_;
3034     my $discount;
3035
3036     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3037         $discount = $rules_ref->[0]->{rentaldiscount};
3038         return (defined $discount) ? $discount : 0;
3039     }
3040     # could have up to 4 does one match $branch and $itemtype
3041     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3042     if (@d) {
3043         $discount = $d[0]->{rentaldiscount};
3044         return (defined $discount) ? $discount : 0;
3045     }
3046     # do we have item type + all branches
3047     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3048     if (@d) {
3049         $discount = $d[0]->{rentaldiscount};
3050         return (defined $discount) ? $discount : 0;
3051     }
3052     # do we all item types + this branch
3053     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3054     if (@d) {
3055         $discount = $d[0]->{rentaldiscount};
3056         return (defined $discount) ? $discount : 0;
3057     }
3058     # so all and all (surely we wont get here)
3059     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3060     if (@d) {
3061         $discount = $d[0]->{rentaldiscount};
3062         return (defined $discount) ? $discount : 0;
3063     }
3064     # none of the above
3065     return 0;
3066 }
3067
3068 =head2 AddIssuingCharge
3069
3070   &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3071
3072 =cut
3073
3074 sub AddIssuingCharge {
3075     my ( $itemnumber, $borrowernumber, $charge ) = @_;
3076     my $dbh = C4::Context->dbh;
3077     my $nextaccntno = getnextacctno( $borrowernumber );
3078     my $manager_id = 0;
3079     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3080     my $query ="
3081         INSERT INTO accountlines
3082             (borrowernumber, itemnumber, accountno,
3083             date, amount, description, accounttype,
3084             amountoutstanding, manager_id)
3085         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3086     ";
3087     my $sth = $dbh->prepare($query);
3088     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3089 }
3090
3091 =head2 GetTransfers
3092
3093   GetTransfers($itemnumber);
3094
3095 =cut
3096
3097 sub GetTransfers {
3098     my ($itemnumber) = @_;
3099
3100     my $dbh = C4::Context->dbh;
3101
3102     my $query = '
3103         SELECT datesent,
3104                frombranch,
3105                tobranch
3106         FROM branchtransfers
3107         WHERE itemnumber = ?
3108           AND datearrived IS NULL
3109         ';
3110     my $sth = $dbh->prepare($query);
3111     $sth->execute($itemnumber);
3112     my @row = $sth->fetchrow_array();
3113     return @row;
3114 }
3115
3116 =head2 GetTransfersFromTo
3117
3118   @results = GetTransfersFromTo($frombranch,$tobranch);
3119
3120 Returns the list of pending transfers between $from and $to branch
3121
3122 =cut
3123
3124 sub GetTransfersFromTo {
3125     my ( $frombranch, $tobranch ) = @_;
3126     return unless ( $frombranch && $tobranch );
3127     my $dbh   = C4::Context->dbh;
3128     my $query = "
3129         SELECT itemnumber,datesent,frombranch
3130         FROM   branchtransfers
3131         WHERE  frombranch=?
3132           AND  tobranch=?
3133           AND datearrived IS NULL
3134     ";
3135     my $sth = $dbh->prepare($query);
3136     $sth->execute( $frombranch, $tobranch );
3137     my @gettransfers;
3138
3139     while ( my $data = $sth->fetchrow_hashref ) {
3140         push @gettransfers, $data;
3141     }
3142     return (@gettransfers);
3143 }
3144
3145 =head2 DeleteTransfer
3146
3147   &DeleteTransfer($itemnumber);
3148
3149 =cut
3150
3151 sub DeleteTransfer {
3152     my ($itemnumber) = @_;
3153     return unless $itemnumber;
3154     my $dbh          = C4::Context->dbh;
3155     my $sth          = $dbh->prepare(
3156         "DELETE FROM branchtransfers
3157          WHERE itemnumber=?
3158          AND datearrived IS NULL "
3159     );
3160     return $sth->execute($itemnumber);
3161 }
3162
3163 =head2 AnonymiseIssueHistory
3164
3165   ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
3166
3167 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
3168 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
3169
3170 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
3171 setting (force delete).
3172
3173 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
3174
3175 =cut
3176
3177 sub AnonymiseIssueHistory {
3178     my $date           = shift;
3179     my $borrowernumber = shift;
3180     my $dbh            = C4::Context->dbh;
3181     my $query          = "
3182         UPDATE old_issues
3183         SET    borrowernumber = ?
3184         WHERE  returndate < ?
3185           AND borrowernumber IS NOT NULL
3186     ";
3187
3188     # The default of 0 does not work due to foreign key constraints
3189     # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
3190     my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
3191     my @bind_params = ($anonymouspatron, $date);
3192     if (defined $borrowernumber) {
3193        $query .= " AND borrowernumber = ?";
3194        push @bind_params, $borrowernumber;
3195     } else {
3196        $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
3197     }
3198     my $sth = $dbh->prepare($query);
3199     $sth->execute(@bind_params);
3200     my $anonymisation_err = $dbh->err;
3201     my $rows_affected = $sth->rows;  ### doublecheck row count return function
3202     return ($rows_affected, $anonymisation_err);
3203 }
3204
3205 =head2 SendCirculationAlert
3206
3207 Send out a C<check-in> or C<checkout> alert using the messaging system.
3208
3209 B<Parameters>:
3210
3211 =over 4
3212
3213 =item type
3214
3215 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3216
3217 =item item
3218
3219 Hashref of information about the item being checked in or out.
3220
3221 =item borrower
3222
3223 Hashref of information about the borrower of the item.
3224
3225 =item branch
3226
3227 The branchcode from where the checkout or check-in took place.
3228
3229 =back
3230
3231 B<Example>:
3232
3233     SendCirculationAlert({
3234         type     => 'CHECKOUT',
3235         item     => $item,
3236         borrower => $borrower,
3237         branch   => $branch,
3238     });
3239
3240 =cut
3241
3242 sub SendCirculationAlert {
3243     my ($opts) = @_;
3244     my ($type, $item, $borrower, $branch) =
3245         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3246     my %message_name = (
3247         CHECKIN  => 'Item_Check_in',
3248         CHECKOUT => 'Item_Checkout',
3249         RENEWAL  => 'Item_Checkout',
3250     );
3251     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3252         borrowernumber => $borrower->{borrowernumber},
3253         message_name   => $message_name{$type},
3254     });
3255     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3256
3257     my @transports = keys %{ $borrower_preferences->{transports} };
3258     # warn "no transports" unless @transports;
3259     for (@transports) {
3260         # warn "transport: $_";
3261         my $message = C4::Message->find_last_message($borrower, $type, $_);
3262         if (!$message) {
3263             #warn "create new message";
3264             my $letter =  C4::Letters::GetPreparedLetter (
3265                 module => 'circulation',
3266                 letter_code => $type,
3267                 branchcode => $branch,
3268                 message_transport_type => $_,
3269                 tables => {
3270                     $issues_table => $item->{itemnumber},
3271                     'items'       => $item->{itemnumber},
3272                     'biblio'      => $item->{biblionumber},
3273                     'biblioitems' => $item->{biblionumber},
3274                     'borrowers'   => $borrower,
3275                     'branches'    => $branch,
3276                 }
3277             ) or next;
3278             C4::Message->enqueue($letter, $borrower, $_);
3279         } else {
3280             #warn "append to old message";
3281             my $letter =  C4::Letters::GetPreparedLetter (
3282                 module => 'circulation',
3283                 letter_code => $type,
3284                 branchcode => $branch,
3285                 message_transport_type => $_,
3286                 tables => {
3287                     $issues_table => $item->{itemnumber},
3288                     'items'       => $item->{itemnumber},
3289                     'biblio'      => $item->{biblionumber},
3290                     'biblioitems' => $item->{biblionumber},
3291                     'borrowers'   => $borrower,
3292                     'branches'    => $branch,
3293                 }
3294             ) or next;
3295             $message->append($letter);
3296             $message->update;
3297         }
3298     }
3299
3300     return;
3301 }
3302
3303 =head2 updateWrongTransfer
3304
3305   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3306
3307 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
3308
3309 =cut
3310
3311 sub updateWrongTransfer {
3312         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3313         my $dbh = C4::Context->dbh;
3314 # first step validate the actual line of transfert .
3315         my $sth =
3316                 $dbh->prepare(
3317                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3318                 );
3319                 $sth->execute($FromLibrary,$itemNumber);
3320
3321 # second step create a new line of branchtransfer to the right location .
3322         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3323
3324 #third step changing holdingbranch of item
3325         UpdateHoldingbranch($FromLibrary,$itemNumber);
3326 }
3327
3328 =head2 UpdateHoldingbranch
3329
3330   $items = UpdateHoldingbranch($branch,$itmenumber);
3331
3332 Simple methode for updating hodlingbranch in items BDD line
3333
3334 =cut
3335
3336 sub UpdateHoldingbranch {
3337         my ( $branch,$itemnumber ) = @_;
3338     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3339 }
3340
3341 =head2 CalcDateDue
3342
3343 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3344
3345 this function calculates the due date given the start date and configured circulation rules,
3346 checking against the holidays calendar as per the 'useDaysMode' syspref.
3347 C<$startdate>   = C4::Dates object representing start date of loan period (assumed to be today)
3348 C<$itemtype>  = itemtype code of item in question
3349 C<$branch>  = location whose calendar to use
3350 C<$borrower> = Borrower object
3351 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3352
3353 =cut
3354
3355 sub CalcDateDue {
3356     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3357
3358     $isrenewal ||= 0;
3359
3360     # loanlength now a href
3361     my $loanlength =
3362             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3363
3364     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3365             ? qq{renewalperiod}
3366             : qq{issuelength};
3367
3368     my $datedue;
3369     if ( $startdate ) {
3370         if (ref $startdate ne 'DateTime' ) {
3371             $datedue = dt_from_string($datedue);
3372         } else {
3373             $datedue = $startdate->clone;
3374         }
3375     } else {
3376         $datedue =
3377           DateTime->now( time_zone => C4::Context->tz() )
3378           ->truncate( to => 'minute' );
3379     }
3380
3381
3382     # calculate the datedue as normal
3383     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3384     {    # ignoring calendar
3385         if ( $loanlength->{lengthunit} eq 'hours' ) {
3386             $datedue->add( hours => $loanlength->{$length_key} );
3387         } else {    # days
3388             $datedue->add( days => $loanlength->{$length_key} );
3389             $datedue->set_hour(23);
3390             $datedue->set_minute(59);
3391         }
3392     } else {
3393         my $dur;
3394         if ($loanlength->{lengthunit} eq 'hours') {
3395             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3396         }
3397         else { # days
3398             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3399         }
3400         my $calendar = Koha::Calendar->new( branchcode => $branch );
3401         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3402         if ($loanlength->{lengthunit} eq 'days') {
3403             $datedue->set_hour(23);
3404             $datedue->set_minute(59);
3405         }
3406     }
3407
3408     # if Hard Due Dates are used, retreive them and apply as necessary
3409     my ( $hardduedate, $hardduedatecompare ) =
3410       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3411     if ($hardduedate) {    # hardduedates are currently dates
3412         $hardduedate->truncate( to => 'minute' );
3413         $hardduedate->set_hour(23);
3414         $hardduedate->set_minute(59);
3415         my $cmp = DateTime->compare( $hardduedate, $datedue );
3416
3417 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3418 # if the calculated date is before the 'after' Hard Due Date (floor), override
3419 # if the hard due date is set to 'exactly', overrride
3420         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3421             $datedue = $hardduedate->clone;
3422         }
3423
3424         # in all other cases, keep the date due as it is
3425
3426     }
3427
3428     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3429     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3430         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
3431         $expiry_dt->set( hour => 23, minute => 59);
3432         if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
3433             $datedue = $expiry_dt->clone;
3434         }
3435     }
3436
3437     return $datedue;
3438 }
3439
3440
3441 =head2 CheckRepeatableHolidays
3442
3443   $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3444
3445 This function checks if the date due is a repeatable holiday
3446
3447 C<$date_due>   = returndate calculate with no day check
3448 C<$itemnumber>  = itemnumber
3449 C<$branchcode>  = localisation of issue
3450
3451 =cut
3452
3453 sub CheckRepeatableHolidays{
3454 my($itemnumber,$week_day,$branchcode)=@_;
3455 my $dbh = C4::Context->dbh;
3456 my $query = qq|SELECT count(*)
3457         FROM repeatable_holidays
3458         WHERE branchcode=?
3459         AND weekday=?|;
3460 my $sth = $dbh->prepare($query);
3461 $sth->execute($branchcode,$week_day);
3462 my $result=$sth->fetchrow;
3463 return $result;
3464 }
3465
3466
3467 =head2 CheckSpecialHolidays
3468
3469   $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3470
3471 This function check if the date is a special holiday
3472
3473 C<$years>   = the years of datedue
3474 C<$month>   = the month of datedue
3475 C<$day>     = the day of datedue
3476 C<$itemnumber>  = itemnumber
3477 C<$branchcode>  = localisation of issue
3478
3479 =cut
3480
3481 sub CheckSpecialHolidays{
3482 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3483 my $dbh = C4::Context->dbh;
3484 my $query=qq|SELECT count(*)
3485              FROM `special_holidays`
3486              WHERE year=?
3487              AND month=?
3488              AND day=?
3489              AND branchcode=?
3490             |;
3491 my $sth = $dbh->prepare($query);
3492 $sth->execute($years,$month,$day,$branchcode);
3493 my $countspecial=$sth->fetchrow ;
3494 return $countspecial;
3495 }
3496
3497 =head2 CheckRepeatableSpecialHolidays
3498
3499   $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3500
3501 This function check if the date is a repeatble special holidays
3502
3503 C<$month>   = the month of datedue
3504 C<$day>     = the day of datedue
3505 C<$itemnumber>  = itemnumber
3506 C<$branchcode>  = localisation of issue
3507
3508 =cut
3509
3510 sub CheckRepeatableSpecialHolidays{
3511 my ($month,$day,$itemnumber,$branchcode) = @_;
3512 my $dbh = C4::Context->dbh;
3513 my $query=qq|SELECT count(*)
3514              FROM `repeatable_holidays`
3515              WHERE month=?
3516              AND day=?
3517              AND branchcode=?
3518             |;
3519 my $sth = $dbh->prepare($query);
3520 $sth->execute($month,$day,$branchcode);
3521 my $countspecial=$sth->fetchrow ;
3522 return $countspecial;
3523 }
3524
3525
3526
3527 sub CheckValidBarcode{
3528 my ($barcode) = @_;
3529 my $dbh = C4::Context->dbh;
3530 my $query=qq|SELECT count(*)
3531              FROM items
3532              WHERE barcode=?
3533             |;
3534 my $sth = $dbh->prepare($query);
3535 $sth->execute($barcode);
3536 my $exist=$sth->fetchrow ;
3537 return $exist;
3538 }
3539
3540 =head2 IsBranchTransferAllowed
3541
3542   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3543
3544 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3545
3546 =cut
3547
3548 sub IsBranchTransferAllowed {
3549         my ( $toBranch, $fromBranch, $code ) = @_;
3550
3551         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3552
3553         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3554         my $dbh = C4::Context->dbh;
3555
3556         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3557         $sth->execute( $toBranch, $fromBranch, $code );
3558         my $limit = $sth->fetchrow_hashref();
3559
3560         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3561         if ( $limit->{'limitId'} ) {
3562                 return 0;
3563         } else {
3564                 return 1;
3565         }
3566 }
3567
3568 =head2 CreateBranchTransferLimit
3569
3570   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3571
3572 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3573
3574 =cut
3575
3576 sub CreateBranchTransferLimit {
3577    my ( $toBranch, $fromBranch, $code ) = @_;
3578    return unless defined($toBranch) && defined($fromBranch);
3579    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3580
3581    my $dbh = C4::Context->dbh;
3582
3583    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3584    return $sth->execute( $code, $toBranch, $fromBranch );
3585 }
3586
3587 =head2 DeleteBranchTransferLimits
3588
3589     my $result = DeleteBranchTransferLimits($frombranch);
3590
3591 Deletes all the library transfer limits for one library.  Returns the
3592 number of limits deleted, 0e0 if no limits were deleted, or undef if
3593 no arguments are supplied.
3594
3595 =cut
3596
3597 sub DeleteBranchTransferLimits {
3598     my $branch = shift;
3599     return unless defined $branch;
3600     my $dbh    = C4::Context->dbh;
3601     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3602     return $sth->execute($branch);
3603 }
3604
3605 sub ReturnLostItem{
3606     my ( $borrowernumber, $itemnum ) = @_;
3607
3608     MarkIssueReturned( $borrowernumber, $itemnum );
3609     my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3610     my $item = C4::Items::GetItem( $itemnum );
3611     my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3612     my @datearr = localtime(time);
3613     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3614     my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3615     ModItem({ paidfor =>  $old_note."Paid for by $bor $date" }, undef, $itemnum);
3616 }
3617
3618
3619 sub LostItem{
3620     my ($itemnumber, $mark_returned) = @_;
3621
3622     my $dbh = C4::Context->dbh();
3623     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3624                            FROM issues
3625                            JOIN items USING (itemnumber)
3626                            JOIN biblio USING (biblionumber)
3627                            WHERE issues.itemnumber=?");
3628     $sth->execute($itemnumber);
3629     my $issues=$sth->fetchrow_hashref();
3630
3631     # If a borrower lost the item, add a replacement cost to the their record
3632     if ( my $borrowernumber = $issues->{borrowernumber} ){
3633         my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3634
3635         if (C4::Context->preference('WhenLostForgiveFine')){
3636             my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3637             defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!";  # zero is OK, check defined
3638         }
3639         if (C4::Context->preference('WhenLostChargeReplacementFee')){
3640             C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3641             #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3642             #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3643         }
3644
3645         MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3646     }
3647 }
3648
3649 sub GetOfflineOperations {
3650     my $dbh = C4::Context->dbh;
3651     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3652     $sth->execute(C4::Context->userenv->{'branch'});
3653     my $results = $sth->fetchall_arrayref({});
3654     return $results;
3655 }
3656
3657 sub GetOfflineOperation {
3658     my $operationid = shift;
3659     return unless $operationid;
3660     my $dbh = C4::Context->dbh;
3661     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3662     $sth->execute( $operationid );
3663     return $sth->fetchrow_hashref;
3664 }
3665
3666 sub AddOfflineOperation {
3667     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3668     my $dbh = C4::Context->dbh;
3669     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3670     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3671     return "Added.";
3672 }
3673
3674 sub DeleteOfflineOperation {
3675     my $dbh = C4::Context->dbh;
3676     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3677     $sth->execute( shift );
3678     return "Deleted.";
3679 }
3680
3681 sub ProcessOfflineOperation {
3682     my $operation = shift;
3683
3684     my $report;
3685     if ( $operation->{action} eq 'return' ) {
3686         $report = ProcessOfflineReturn( $operation );
3687     } elsif ( $operation->{action} eq 'issue' ) {
3688         $report = ProcessOfflineIssue( $operation );
3689     } elsif ( $operation->{action} eq 'payment' ) {
3690         $report = ProcessOfflinePayment( $operation );
3691     }
3692
3693     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3694
3695     return $report;
3696 }
3697
3698 sub ProcessOfflineReturn {
3699     my $operation = shift;
3700
3701     my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3702
3703     if ( $itemnumber ) {
3704         my $issue = GetOpenIssue( $itemnumber );
3705         if ( $issue ) {
3706             MarkIssueReturned(
3707                 $issue->{borrowernumber},
3708                 $itemnumber,
3709                 undef,
3710                 $operation->{timestamp},
3711             );
3712             ModItem(
3713                 { renewals => 0, onloan => undef },
3714                 $issue->{'biblionumber'},
3715                 $itemnumber
3716             );
3717             return "Success.";
3718         } else {
3719             return "Item not issued.";
3720         }
3721     } else {
3722         return "Item not found.";
3723     }
3724 }
3725
3726 sub ProcessOfflineIssue {
3727     my $operation = shift;
3728
3729     my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3730
3731     if ( $borrower->{borrowernumber} ) {
3732         my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3733         unless ($itemnumber) {
3734             return "Barcode not found.";
3735         }
3736         my $issue = GetOpenIssue( $itemnumber );
3737
3738         if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3739             MarkIssueReturned(
3740                 $issue->{borrowernumber},
3741                 $itemnumber,
3742                 undef,
3743                 $operation->{timestamp},
3744             );
3745         }
3746         AddIssue(
3747             $borrower,
3748             $operation->{'barcode'},
3749             undef,
3750             1,
3751             $operation->{timestamp},
3752             undef,
3753         );
3754         return "Success.";
3755     } else {
3756         return "Borrower not found.";
3757     }
3758 }
3759
3760 sub ProcessOfflinePayment {
3761     my $operation = shift;
3762
3763     my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3764     my $amount = $operation->{amount};
3765
3766     recordpayment( $borrower->{borrowernumber}, $amount );
3767
3768     return "Success."
3769 }
3770
3771
3772 =head2 TransferSlip
3773
3774   TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3775
3776   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3777
3778 =cut
3779
3780 sub TransferSlip {
3781     my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3782
3783     my $item =  GetItem( $itemnumber, $barcode )
3784       or return;
3785
3786     my $pulldate = C4::Dates->new();
3787
3788     return C4::Letters::GetPreparedLetter (
3789         module => 'circulation',
3790         letter_code => 'TRANSFERSLIP',
3791         branchcode => $branch,
3792         tables => {
3793             'branches'    => $to_branch,
3794             'biblio'      => $item->{biblionumber},
3795             'items'       => $item,
3796         },
3797     );
3798 }
3799
3800 =head2 CheckIfIssuedToPatron
3801
3802   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3803
3804   Return 1 if any record item is issued to patron, otherwise return 0
3805
3806 =cut
3807
3808 sub CheckIfIssuedToPatron {
3809     my ($borrowernumber, $biblionumber) = @_;
3810
3811     my $items = GetItemsByBiblioitemnumber($biblionumber);
3812
3813     foreach my $item (@{$items}) {
3814         return 1 if ($item->{borrowernumber} && $item->{borrowernumber} eq $borrowernumber);
3815     }
3816
3817     return;
3818 }
3819
3820 =head2 IsItemIssued
3821
3822   IsItemIssued( $itemnumber )
3823
3824   Return 1 if the item is on loan, otherwise return 0
3825
3826 =cut
3827
3828 sub IsItemIssued {
3829     my $itemnumber = shift;
3830     my $dbh = C4::Context->dbh;
3831     my $sth = $dbh->prepare(q{
3832         SELECT COUNT(*)
3833         FROM issues
3834         WHERE itemnumber = ?
3835     });
3836     $sth->execute($itemnumber);
3837     return $sth->fetchrow;
3838 }
3839
3840 =head2 GetAgeRestriction
3841
3842   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3843   my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3844
3845   if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as he is older or as old as the agerestriction }
3846   if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3847
3848 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3849 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3850 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3851          Negative days mean the borrower has gone past the age restriction age.
3852
3853 =cut
3854
3855 sub GetAgeRestriction {
3856     my ($record_restrictions, $borrower) = @_;
3857     my $markers = C4::Context->preference('AgeRestrictionMarker');
3858
3859     # Split $record_restrictions to something like FSK 16 or PEGI 6
3860     my @values = split ' ', uc($record_restrictions);
3861     return unless @values;
3862
3863     # Search first occurence of one of the markers
3864     my @markers = split /\|/, uc($markers);
3865     return unless @markers;
3866
3867     my $index            = 0;
3868     my $restriction_year = 0;
3869     for my $value (@values) {
3870         $index++;
3871         for my $marker (@markers) {
3872             $marker =~ s/^\s+//;    #remove leading spaces
3873             $marker =~ s/\s+$//;    #remove trailing spaces
3874             if ( $marker eq $value ) {
3875                 if ( $index <= $#values ) {
3876                     $restriction_year += $values[$index];
3877                 }
3878                 last;
3879             }
3880             elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3881
3882                 # Perhaps it is something like "K16" (as in Finland)
3883                 $restriction_year += $1;
3884                 last;
3885             }
3886         }
3887         last if ( $restriction_year > 0 );
3888     }
3889
3890     #Check if the borrower is age restricted for this material and for how long.
3891     if ($restriction_year && $borrower) {
3892         if ( $borrower->{'dateofbirth'} ) {
3893             my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3894             $alloweddate[0] += $restriction_year;
3895
3896             #Prevent runime eror on leap year (invalid date)
3897             if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3898                 $alloweddate[2] = 28;
3899             }
3900
3901             #Get how many days the borrower has to reach the age restriction
3902             my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(Today);
3903             #Negative days means the borrower went past the age restriction age
3904             return ($restriction_year, $daysToAgeRestriction);
3905         }
3906     }
3907
3908     return ($restriction_year);
3909 }
3910
3911 1;
3912
3913 =head2 GetPendingOnSiteCheckouts
3914
3915 =cut
3916
3917 sub GetPendingOnSiteCheckouts {
3918     my $dbh = C4::Context->dbh;
3919     return $dbh->selectall_arrayref(q|
3920         SELECT
3921           items.barcode,
3922           items.biblionumber,
3923           items.itemnumber,
3924           items.itemnotes,
3925           items.itemcallnumber,
3926           items.location,
3927           issues.date_due,
3928           issues.branchcode,
3929           issues.date_due < NOW() AS is_overdue,
3930           biblio.author,
3931           biblio.title,
3932           borrowers.firstname,
3933           borrowers.surname,
3934           borrowers.cardnumber,
3935           borrowers.borrowernumber
3936         FROM items
3937         LEFT JOIN issues ON items.itemnumber = issues.itemnumber
3938         LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
3939         LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
3940         WHERE issues.onsite_checkout = 1
3941     |, { Slice => {} } );
3942 }
3943
3944 __END__
3945
3946 =head1 AUTHOR
3947
3948 Koha Development Team <http://koha-community.org/>
3949
3950 =cut
3951