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