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