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