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->{'wthdrawn'} 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             $needsconfirmation{TOO_MANY} = 1;
 830             $needsconfirmation{current_loan_count} = $current_loan_count;
 831             $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
 832         }
 833     }
 834
 835     #
 836     # ITEM CHECKING
 837     #
 838     if ( $item->{'notforloan'} )
 839     {
 840         if(!C4::Context->preference("AllowNotForLoanOverride")){
 841             $issuingimpossible{NOT_FOR_LOAN} = 1;
 842             $issuingimpossible{item_notforloan} = $item->{'notforloan'};
 843         }else{
 844             $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 845             $needsconfirmation{item_notforloan} = $item->{'notforloan'};
 846         }
 847     }
 848     else {
 849         # we have to check itemtypes.notforloan also
 850         if (C4::Context->preference('item-level_itypes')){
 851             # this should probably be a subroutine
 852             my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
 853             $sth->execute($item->{'itemtype'});
 854             my $notforloan=$sth->fetchrow_hashref();
 855             $sth->finish();
 856             if ($notforloan->{'notforloan'}) {
 857                 if (!C4::Context->preference("AllowNotForLoanOverride")) {
 858                     $issuingimpossible{NOT_FOR_LOAN} = 1;
 859                     $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
 860                 } else {
 861                     $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 862                     $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
 863                 }
 864             }
 865         }
 866         elsif ($biblioitem->{'notforloan'} == 1){
 867             if (!C4::Context->preference("AllowNotForLoanOverride")) {
 868                 $issuingimpossible{NOT_FOR_LOAN} = 1;
 869                 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
 870             } else {
 871                 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
 872                 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
 873             }
 874         }
 875     }
 876     if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} > 0 )
 877     {
 878         $issuingimpossible{WTHDRAWN} = 1;
 879     }
 880     if (   $item->{'restricted'}
 881         && $item->{'restricted'} == 1 )
 882     {
 883         $issuingimpossible{RESTRICTED} = 1;
 884     }
 885     if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
 886         my $code = GetAuthorisedValueByCode( 'LOST', $item->{'itemlost'} );
 887         $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
 888         $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
 889     }
 890     if ( C4::Context->preference("IndependantBranches") ) {
 891         my $userenv = C4::Context->userenv;
 892         if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
 893             $issuingimpossible{ITEMNOTSAMEBRANCH} = 1
 894               if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
 895             $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
 896               if ( $borrower->{'branchcode'} ne $userenv->{branch} );
 897         }
 898     }
 899
 900     #
 901     # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
 902     #
 903     if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
 904     {
 905
 906         # Already issued to current borrower. Ask whether the loan should
 907         # be renewed.
 908         my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
 909             $borrower->{'borrowernumber'},
 910             $item->{'itemnumber'}
 911         );
 912         if ( $CanBookBeRenewed == 0 ) {    # no more renewals allowed
 913             $issuingimpossible{NO_MORE_RENEWALS} = 1;
 914         }
 915         else {
 916             $needsconfirmation{RENEW_ISSUE} = 1;
 917         }
 918     }
 919     elsif ($issue->{borrowernumber}) {
 920
 921         # issued to someone else
 922         my $currborinfo =    C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
 923
 924 #        warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
 925         $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
 926         $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
 927         $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
 928         $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
 929         $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
 930     }
 931
 932     unless ( $ignore_reserves ) {
 933         # See if the item is on reserve.
 934         my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
 935         if ($restype) {
 936             my $resbor = $res->{'borrowernumber'};
 937             if ( $resbor ne $borrower->{'borrowernumber'} ) {
 938                 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
 939                 my $branchname = GetBranchName( $res->{'branchcode'} );
 940                 if ( $restype eq "Waiting" )
 941                 {
 942                     # The item is on reserve and waiting, but has been
 943                     # reserved by some other patron.
 944                     $needsconfirmation{RESERVE_WAITING} = 1;
 945                     $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
 946                     $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
 947                     $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
 948                     $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
 949                     $needsconfirmation{'resbranchname'} = $branchname;
 950                     $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
 951                 }
 952                 elsif ( $restype eq "Reserved" ) {
 953                     # The item is on reserve for someone else.
 954                     $needsconfirmation{RESERVED} = 1;
 955                     $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
 956                     $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
 957                     $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
 958                     $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
 959                     $needsconfirmation{'resbranchname'} = $branchname;
 960                     $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
 961                 }
 962             }
 963         }
 964     }
 965     #
 966     # CHECK AGE RESTRICTION
 967     #
 968
 969     # get $marker from preferences. Could be something like "FSK|PEGI|Alter|Age:"
 970     my $markers = C4::Context->preference('AgeRestrictionMarker' );
 971     my $bibvalues = $biblioitem->{'agerestriction'};
 972     if (($markers)&&($bibvalues))
 973     {
 974         # Split $bibvalues to something like FSK 16 or PEGI 6
 975         my @values = split ' ', $bibvalues;
 976
 977         # Search first occurence of one of the markers
 978         my @markers = split /\|/, $markers;
 979         my $index = 0;
 980         my $take = -1;
 981         for my $value (@values) {
 982             $index ++;
 983             for my $marker (@markers) {
 984                 $marker =~ s/^\s+//; #remove leading spaces
 985                 $marker =~ s/\s+$//; #remove trailing spaces
 986                 if (uc($marker) eq uc($value)) {
 987                     $take = $index;
 988                     last;
 989                 }
 990             }
 991             if ($take > -1) {
 992                 last;
 993             }
 994         }
 995         # Index points to the next value
 996         my $restrictionyear = 0;
 997         if (($take <= $#values) && ($take >= 0)){
 998             $restrictionyear += $values[$take];
 999         }
1000
1001         if ($restrictionyear > 0) {
1002             if ( $borrower->{'dateofbirth'}  ) {
1003                 my @alloweddate =  split /-/,$borrower->{'dateofbirth'} ;
1004                 $alloweddate[0] += $restrictionyear;
1005                 #Prevent runime eror on leap year (invalid date)
1006                 if (($alloweddate[1] == 2) && ($alloweddate[2] == 29)) {
1007                     $alloweddate[2] = 28;
1008                 }
1009
1010                 if ( Date_to_Days(Today) <  Date_to_Days(@alloweddate) -1  ) {
1011                     if (C4::Context->preference('AgeRestrictionOverride' )) {
1012                         $needsconfirmation{AGE_RESTRICTION} = "$bibvalues";
1013                     }
1014                     else {
1015                         $issuingimpossible{AGE_RESTRICTION} = "$bibvalues";
1016                     }
1017                 }
1018             }
1019         }
1020     }
1021
1022 ## check for high holds decreasing loan period
1023     my $decrease_loan = C4::Context->preference('decreaseLoanHighHolds');
1024     if ( $decrease_loan && $decrease_loan == 1 ) {
1025         my ( $reserved, $num, $duration, $returndate ) =
1026           checkHighHolds( $item, $borrower );
1027
1028         if ( $num >= C4::Context->preference('decreaseLoanHighHoldsValue') ) {
1029             $needsconfirmation{HIGHHOLDS} = {
1030                 num_holds  => $num,
1031                 duration   => $duration,
1032                 returndate => output_pref($returndate),
1033             };
1034         }
1035     }
1036
1037     return ( \%issuingimpossible, \%needsconfirmation, \%alerts );
1038 }
1039
1040 =head2 CanBookBeReturned
1041
1042   ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1043
1044 Check whether the item can be returned to the provided branch
1045
1046 =over 4
1047
1048 =item C<$item> is a hash of item information as returned from GetItem
1049
1050 =item C<$branch> is the branchcode where the return is taking place
1051
1052 =back
1053
1054 Returns:
1055
1056 =over 4
1057
1058 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1059
1060 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1061
1062 =back
1063
1064 =cut
1065
1066 sub CanBookBeReturned {
1067   my ($item, $branch) = @_;
1068   my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1069
1070   # assume return is allowed to start
1071   my $allowed = 1;
1072   my $message;
1073
1074   # identify all cases where return is forbidden
1075   if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1076      $allowed = 0;
1077      $message = $item->{'homebranch'};
1078   } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1079      $allowed = 0;
1080      $message = $item->{'holdingbranch'};
1081   } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1082      $allowed = 0;
1083      $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1084   }
1085
1086   return ($allowed, $message);
1087 }
1088
1089 =head2 CheckHighHolds
1090
1091     used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1092     decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1093     has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1094
1095 =cut
1096
1097 sub checkHighHolds {
1098     my ( $item, $borrower ) = @_;
1099     my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1100     my $branch = _GetCircControlBranch( $item, $borrower );
1101     my $dbh    = C4::Context->dbh;
1102     my $sth    = $dbh->prepare(
1103 'select count(borrowernumber) as num_holds from reserves where biblionumber=?'
1104     );
1105     $sth->execute( $item->{'biblionumber'} );
1106     my ($holds) = $sth->fetchrow_array;
1107     if ($holds) {
1108         my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1109
1110         my $calendar = Koha::Calendar->new( branchcode => $branch );
1111
1112         my $itype =
1113           ( C4::Context->preference('item-level_itypes') )
1114           ? $biblio->{'itype'}
1115           : $biblio->{'itemtype'};
1116         my $orig_due =
1117           C4::Circulation::CalcDateDue( $issuedate, $itype, $branch,
1118             $borrower );
1119
1120         my $reduced_datedue =
1121           $calendar->addDate( $issuedate,
1122             C4::Context->preference('decreaseLoanHighHoldsDuration') );
1123
1124         if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1125             return ( 1, $holds,
1126                 C4::Context->preference('decreaseLoanHighHoldsDuration'),
1127                 $reduced_datedue );
1128         }
1129     }
1130     return ( 0, 0, 0, undef );
1131 }
1132
1133 =head2 AddIssue
1134
1135   &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1136
1137 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1138
1139 =over 4
1140
1141 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1142
1143 =item C<$barcode> is the barcode of the item being issued.
1144
1145 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
1146 Calculated if empty.
1147
1148 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1149
1150 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1151 Defaults to today.  Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
1152
1153 AddIssue does the following things :
1154
1155   - step 01: check that there is a borrowernumber & a barcode provided
1156   - check for RENEWAL (book issued & being issued to the same patron)
1157       - renewal YES = Calculate Charge & renew
1158       - renewal NO  =
1159           * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1160           * RESERVE PLACED ?
1161               - fill reserve if reserve to this patron
1162               - cancel reserve or not, otherwise
1163           * TRANSFERT PENDING ?
1164               - complete the transfert
1165           * ISSUE THE BOOK
1166
1167 =back
1168
1169 =cut
1170
1171 sub AddIssue {
1172     my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
1173     my $dbh = C4::Context->dbh;
1174         my $barcodecheck=CheckValidBarcode($barcode);
1175     if ($datedue && ref $datedue ne 'DateTime') {
1176         $datedue = dt_from_string($datedue);
1177     }
1178     # $issuedate defaults to today.
1179     if ( ! defined $issuedate ) {
1180         $issuedate = DateTime->now(time_zone => C4::Context->tz());
1181     }
1182     else {
1183         if ( ref $issuedate ne 'DateTime') {
1184             $issuedate = dt_from_string($issuedate);
1185
1186         }
1187     }
1188         if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1189                 # find which item we issue
1190                 my $item = GetItem('', $barcode) or return;     # if we don't get an Item, abort.
1191                 my $branch = _GetCircControlBranch($item,$borrower);
1192
1193                 # get actual issuing if there is one
1194                 my $actualissue = GetItemIssue( $item->{itemnumber});
1195
1196                 # get biblioinformation for this item
1197                 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
1198
1199                 #
1200                 # check if we just renew the issue.
1201                 #
1202                 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
1203                     $datedue = AddRenewal(
1204                         $borrower->{'borrowernumber'},
1205                         $item->{'itemnumber'},
1206                         $branch,
1207                         $datedue,
1208                         $issuedate, # here interpreted as the renewal date
1209                         );
1210                 }
1211                 else {
1212         # it's NOT a renewal
1213                         if ( $actualissue->{borrowernumber}) {
1214                                 # This book is currently on loan, but not to the person
1215                                 # who wants to borrow it now. mark it returned before issuing to the new borrower
1216                                 AddReturn(
1217                                         $item->{'barcode'},
1218                                         C4::Context->userenv->{'branch'}
1219                                 );
1220                         }
1221
1222             MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1223                         # Starting process for transfer job (checking transfert and validate it if we have one)
1224             my ($datesent) = GetTransfers($item->{'itemnumber'});
1225             if ($datesent) {
1226         #       updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1227                 my $sth =
1228                     $dbh->prepare(
1229                     "UPDATE branchtransfers
1230                         SET datearrived = now(),
1231                         tobranch = ?,
1232                         comments = 'Forced branchtransfer'
1233                     WHERE itemnumber= ? AND datearrived IS NULL"
1234                     );
1235                 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1236             }
1237
1238         # Record in the database the fact that the book was issued.
1239         my $sth =
1240           $dbh->prepare(
1241                 "INSERT INTO issues
1242                     (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1243                 VALUES (?,?,?,?,?)"
1244           );
1245         unless ($datedue) {
1246             my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1247             $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1248
1249         }
1250         $datedue->truncate( to => 'minute');
1251         $sth->execute(
1252             $borrower->{'borrowernumber'},      # borrowernumber
1253             $item->{'itemnumber'},              # itemnumber
1254             $issuedate->strftime('%Y-%m-%d %H:%M:00'), # issuedate
1255             $datedue->strftime('%Y-%m-%d %H:%M:00'),   # date_due
1256             C4::Context->userenv->{'branch'}    # branchcode
1257         );
1258         if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1259           CartToShelf( $item->{'itemnumber'} );
1260         }
1261         $item->{'issues'}++;
1262         if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1263             UpdateTotalIssues($item->{'biblionumber'}, 1);
1264         }
1265
1266         ## If item was lost, it has now been found, reverse any list item charges if neccessary.
1267         if ( $item->{'itemlost'} ) {
1268             if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1269                 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1270             }
1271         }
1272
1273         ModItem({ issues           => $item->{'issues'},
1274                   holdingbranch    => C4::Context->userenv->{'branch'},
1275                   itemlost         => 0,
1276                   datelastborrowed => DateTime->now(time_zone => C4::Context->tz())->ymd(),
1277                   onloan           => $datedue->ymd(),
1278                 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1279         ModDateLastSeen( $item->{'itemnumber'} );
1280
1281         # If it costs to borrow this book, charge it to the patron's account.
1282         my ( $charge, $itemtype ) = GetIssuingCharges(
1283             $item->{'itemnumber'},
1284             $borrower->{'borrowernumber'}
1285         );
1286         if ( $charge > 0 ) {
1287             AddIssuingCharge(
1288                 $item->{'itemnumber'},
1289                 $borrower->{'borrowernumber'}, $charge
1290             );
1291             $item->{'charge'} = $charge;
1292         }
1293
1294         # Record the fact that this book was issued.
1295         &UpdateStats(
1296             C4::Context->userenv->{'branch'},
1297             'issue', $charge,
1298             ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1299             $item->{'itype'}, $borrower->{'borrowernumber'}, undef, $item->{'ccode'}
1300         );
1301
1302         # Send a checkout slip.
1303         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1304         my %conditions = (
1305             branchcode   => $branch,
1306             categorycode => $borrower->{categorycode},
1307             item_type    => $item->{itype},
1308             notification => 'CHECKOUT',
1309         );
1310         if ($circulation_alert->is_enabled_for(\%conditions)) {
1311             SendCirculationAlert({
1312                 type     => 'CHECKOUT',
1313                 item     => $item,
1314                 borrower => $borrower,
1315                 branch   => $branch,
1316             });
1317         }
1318     }
1319
1320     logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'itemnumber'})
1321         if C4::Context->preference("IssueLog");
1322   }
1323   return ($datedue);    # not necessarily the same as when it came in!
1324 }
1325
1326 =head2 GetLoanLength
1327
1328   my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1329
1330 Get loan length for an itemtype, a borrower type and a branch
1331
1332 =cut
1333
1334 sub GetLoanLength {
1335     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1336     my $dbh = C4::Context->dbh;
1337     my $sth = $dbh->prepare(qq{
1338         SELECT issuelength, lengthunit, renewalperiod
1339         FROM issuingrules
1340         WHERE   categorycode=?
1341             AND itemtype=?
1342             AND branchcode=?
1343             AND issuelength IS NOT NULL
1344     });
1345
1346     # try to find issuelength & return the 1st available.
1347     # check with borrowertype, itemtype and branchcode, then without one of those parameters
1348     $sth->execute( $borrowertype, $itemtype, $branchcode );
1349     my $loanlength = $sth->fetchrow_hashref;
1350
1351     return $loanlength
1352       if defined($loanlength) && $loanlength->{issuelength};
1353
1354     $sth->execute( $borrowertype, '*', $branchcode );
1355     $loanlength = $sth->fetchrow_hashref;
1356     return $loanlength
1357       if defined($loanlength) && $loanlength->{issuelength};
1358
1359     $sth->execute( '*', $itemtype, $branchcode );
1360     $loanlength = $sth->fetchrow_hashref;
1361     return $loanlength
1362       if defined($loanlength) && $loanlength->{issuelength};
1363
1364     $sth->execute( '*', '*', $branchcode );
1365     $loanlength = $sth->fetchrow_hashref;
1366     return $loanlength
1367       if defined($loanlength) && $loanlength->{issuelength};
1368
1369     $sth->execute( $borrowertype, $itemtype, '*' );
1370     $loanlength = $sth->fetchrow_hashref;
1371     return $loanlength
1372       if defined($loanlength) && $loanlength->{issuelength};
1373
1374     $sth->execute( $borrowertype, '*', '*' );
1375     $loanlength = $sth->fetchrow_hashref;
1376     return $loanlength
1377       if defined($loanlength) && $loanlength->{issuelength};
1378
1379     $sth->execute( '*', $itemtype, '*' );
1380     $loanlength = $sth->fetchrow_hashref;
1381     return $loanlength
1382       if defined($loanlength) && $loanlength->{issuelength};
1383
1384     $sth->execute( '*', '*', '*' );
1385     $loanlength = $sth->fetchrow_hashref;
1386     return $loanlength
1387       if defined($loanlength) && $loanlength->{issuelength};
1388
1389     # if no rule is set => 21 days (hardcoded)
1390     return {
1391         issuelength => 21,
1392         renewalperiod => 21,
1393         lengthunit => 'days',
1394     };
1395
1396 }
1397
1398
1399 =head2 GetHardDueDate
1400
1401   my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1402
1403 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1404
1405 =cut
1406
1407 sub GetHardDueDate {
1408     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1409
1410     my $rule = GetIssuingRule( $borrowertype, $itemtype, $branchcode );
1411
1412     if ( defined( $rule ) ) {
1413         if ( $rule->{hardduedate} ) {
1414             return (dt_from_string($rule->{hardduedate}, 'iso'),$rule->{hardduedatecompare});
1415         } else {
1416             return (undef, undef);
1417         }
1418     }
1419 }
1420
1421 =head2 GetIssuingRule
1422
1423   my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1424
1425 FIXME - This is a copy-paste of GetLoanLength
1426 as a stop-gap.  Do not wish to change API for GetLoanLength
1427 this close to release.
1428
1429 Get the issuing rule for an itemtype, a borrower type and a branch
1430 Returns a hashref from the issuingrules table.
1431
1432 =cut
1433
1434 sub GetIssuingRule {
1435     my ( $borrowertype, $itemtype, $branchcode ) = @_;
1436     my $dbh = C4::Context->dbh;
1437     my $sth =  $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"  );
1438     my $irule;
1439
1440         $sth->execute( $borrowertype, $itemtype, $branchcode );
1441     $irule = $sth->fetchrow_hashref;
1442     return $irule if defined($irule) ;
1443
1444     $sth->execute( $borrowertype, "*", $branchcode );
1445     $irule = $sth->fetchrow_hashref;
1446     return $irule if defined($irule) ;
1447
1448     $sth->execute( "*", $itemtype, $branchcode );
1449     $irule = $sth->fetchrow_hashref;
1450     return $irule if defined($irule) ;
1451
1452     $sth->execute( "*", "*", $branchcode );
1453     $irule = $sth->fetchrow_hashref;
1454     return $irule if defined($irule) ;
1455
1456     $sth->execute( $borrowertype, $itemtype, "*" );
1457     $irule = $sth->fetchrow_hashref;
1458     return $irule if defined($irule) ;
1459
1460     $sth->execute( $borrowertype, "*", "*" );
1461     $irule = $sth->fetchrow_hashref;
1462     return $irule if defined($irule) ;
1463
1464     $sth->execute( "*", $itemtype, "*" );
1465     $irule = $sth->fetchrow_hashref;
1466     return $irule if defined($irule) ;
1467
1468     $sth->execute( "*", "*", "*" );
1469     $irule = $sth->fetchrow_hashref;
1470     return $irule if defined($irule) ;
1471
1472     # if no rule matches,
1473     return;
1474 }
1475
1476 =head2 GetBranchBorrowerCircRule
1477
1478   my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1479
1480 Retrieves circulation rule attributes that apply to the given
1481 branch and patron category, regardless of item type.
1482 The return value is a hashref containing the following key:
1483
1484 maxissueqty - maximum number of loans that a
1485 patron of the given category can have at the given
1486 branch.  If the value is undef, no limit.
1487
1488 This will first check for a specific branch and
1489 category match from branch_borrower_circ_rules.
1490
1491 If no rule is found, it will then check default_branch_circ_rules
1492 (same branch, default category).  If no rule is found,
1493 it will then check default_borrower_circ_rules (default
1494 branch, same category), then failing that, default_circ_rules
1495 (default branch, default category).
1496
1497 If no rule has been found in the database, it will default to
1498 the buillt in rule:
1499
1500 maxissueqty - undef
1501
1502 C<$branchcode> and C<$categorycode> should contain the
1503 literal branch code and patron category code, respectively - no
1504 wildcards.
1505
1506 =cut
1507
1508 sub GetBranchBorrowerCircRule {
1509     my $branchcode = shift;
1510     my $categorycode = shift;
1511
1512     my $branch_cat_query = "SELECT maxissueqty
1513                             FROM branch_borrower_circ_rules
1514                             WHERE branchcode = ?
1515                             AND   categorycode = ?";
1516     my $dbh = C4::Context->dbh();
1517     my $sth = $dbh->prepare($branch_cat_query);
1518     $sth->execute($branchcode, $categorycode);
1519     my $result;
1520     if ($result = $sth->fetchrow_hashref()) {
1521         return $result;
1522     }
1523
1524     # try same branch, default borrower category
1525     my $branch_query = "SELECT maxissueqty
1526                         FROM default_branch_circ_rules
1527                         WHERE branchcode = ?";
1528     $sth = $dbh->prepare($branch_query);
1529     $sth->execute($branchcode);
1530     if ($result = $sth->fetchrow_hashref()) {
1531         return $result;
1532     }
1533
1534     # try default branch, same borrower category
1535     my $category_query = "SELECT maxissueqty
1536                           FROM default_borrower_circ_rules
1537                           WHERE categorycode = ?";
1538     $sth = $dbh->prepare($category_query);
1539     $sth->execute($categorycode);
1540     if ($result = $sth->fetchrow_hashref()) {
1541         return $result;
1542     }
1543
1544     # try default branch, default borrower category
1545     my $default_query = "SELECT maxissueqty
1546                           FROM default_circ_rules";
1547     $sth = $dbh->prepare($default_query);
1548     $sth->execute();
1549     if ($result = $sth->fetchrow_hashref()) {
1550         return $result;
1551     }
1552
1553     # built-in default circulation rule
1554     return {
1555         maxissueqty => undef,
1556     };
1557 }
1558
1559 =head2 GetBranchItemRule
1560
1561   my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1562
1563 Retrieves circulation rule attributes that apply to the given
1564 branch and item type, regardless of patron category.
1565
1566 The return value is a hashref containing the following keys:
1567
1568 holdallowed => Hold policy for this branch and itemtype. Possible values:
1569   0: No holds allowed.
1570   1: Holds allowed only by patrons that have the same homebranch as the item.
1571   2: Holds allowed from any patron.
1572
1573 returnbranch => branch to which to return item.  Possible values:
1574   noreturn: do not return, let item remain where checked in (floating collections)
1575   homebranch: return to item's home branch
1576
1577 This searches branchitemrules in the following order:
1578
1579   * Same branchcode and itemtype
1580   * Same branchcode, itemtype '*'
1581   * branchcode '*', same itemtype
1582   * branchcode and itemtype '*'
1583
1584 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1585
1586 =cut
1587
1588 sub GetBranchItemRule {
1589     my ( $branchcode, $itemtype ) = @_;
1590     my $dbh = C4::Context->dbh();
1591     my $result = {};
1592
1593     my @attempts = (
1594         ['SELECT holdallowed, returnbranch
1595             FROM branch_item_rules
1596             WHERE branchcode = ?
1597               AND itemtype = ?', $branchcode, $itemtype],
1598         ['SELECT holdallowed, returnbranch
1599             FROM default_branch_circ_rules
1600             WHERE branchcode = ?', $branchcode],
1601         ['SELECT holdallowed, returnbranch
1602             FROM default_branch_item_rules
1603             WHERE itemtype = ?', $itemtype],
1604         ['SELECT holdallowed, returnbranch
1605             FROM default_circ_rules'],
1606     );
1607
1608     foreach my $attempt (@attempts) {
1609         my ($query, @bind_params) = @{$attempt};
1610         my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1611           or next;
1612
1613         # Since branch/category and branch/itemtype use the same per-branch
1614         # defaults tables, we have to check that the key we want is set, not
1615         # just that a row was returned
1616         $result->{'holdallowed'}  = $search_result->{'holdallowed'}  unless ( defined $result->{'holdallowed'} );
1617         $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1618     }
1619
1620     # built-in default circulation rule
1621     $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1622     $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1623
1624     return $result;
1625 }
1626
1627 =head2 AddReturn
1628
1629   ($doreturn, $messages, $iteminformation, $borrower) =
1630       &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1631
1632 Returns a book.
1633
1634 =over 4
1635
1636 =item C<$barcode> is the bar code of the book being returned.
1637
1638 =item C<$branch> is the code of the branch where the book is being returned.
1639
1640 =item C<$exemptfine> indicates that overdue charges for the item will be
1641 removed.
1642
1643 =item C<$dropbox> indicates that the check-in date is assumed to be
1644 yesterday, or the last non-holiday as defined in C4::Calendar .  If
1645 overdue charges are applied and C<$dropbox> is true, the last charge
1646 will be removed.  This assumes that the fines accrual script has run
1647 for _today_.
1648
1649 =back
1650
1651 C<&AddReturn> returns a list of four items:
1652
1653 C<$doreturn> is true iff the return succeeded.
1654
1655 C<$messages> is a reference-to-hash giving feedback on the operation.
1656 The keys of the hash are:
1657
1658 =over 4
1659
1660 =item C<BadBarcode>
1661
1662 No item with this barcode exists. The value is C<$barcode>.
1663
1664 =item C<NotIssued>
1665
1666 The book is not currently on loan. The value is C<$barcode>.
1667
1668 =item C<IsPermanent>
1669
1670 The book's home branch is a permanent collection. If you have borrowed
1671 this book, you are not allowed to return it. The value is the code for
1672 the book's home branch.
1673
1674 =item C<wthdrawn>
1675
1676 This book has been withdrawn/cancelled. The value should be ignored.
1677
1678 =item C<Wrongbranch>
1679
1680 This book has was returned to the wrong branch.  The value is a hashref
1681 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1682 contain the branchcode of the incorrect and correct return library, respectively.
1683
1684 =item C<ResFound>
1685
1686 The item was reserved. The value is a reference-to-hash whose keys are
1687 fields from the reserves table of the Koha database, and
1688 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1689 either C<Waiting>, C<Reserved>, or 0.
1690
1691 =back
1692
1693 C<$iteminformation> is a reference-to-hash, giving information about the
1694 returned item from the issues table.
1695
1696 C<$borrower> is a reference-to-hash, giving information about the
1697 patron who last borrowed the book.
1698
1699 =cut
1700
1701 sub AddReturn {
1702     my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1703
1704     if ($branch and not GetBranchDetail($branch)) {
1705         warn "AddReturn error: branch '$branch' not found.  Reverting to " . C4::Context->userenv->{'branch'};
1706         undef $branch;
1707     }
1708     $branch = C4::Context->userenv->{'branch'} unless $branch;  # we trust userenv to be a safe fallback/default
1709     my $messages;
1710     my $borrower;
1711     my $biblio;
1712     my $doreturn       = 1;
1713     my $validTransfert = 0;
1714     my $stat_type = 'return';
1715
1716     # get information on item
1717     my $itemnumber = GetItemnumberFromBarcode( $barcode );
1718     unless ($itemnumber) {
1719         return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower.  bail out.
1720     }
1721     my $issue  = GetItemIssue($itemnumber);
1722 #   warn Dumper($iteminformation);
1723     if ($issue and $issue->{borrowernumber}) {
1724         $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1725             or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1726                 . Dumper($issue) . "\n";
1727     } else {
1728         $messages->{'NotIssued'} = $barcode;
1729         # even though item is not on loan, it may still be transferred;  therefore, get current branch info
1730         $doreturn = 0;
1731         # No issue, no borrowernumber.  ONLY if $doreturn, *might* you have a $borrower later.
1732         # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1733         if (C4::Context->preference("RecordLocalUseOnReturn")) {
1734            $messages->{'LocalUse'} = 1;
1735            $stat_type = 'localuse';
1736         }
1737     }
1738
1739     my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1740         # full item data, but no borrowernumber or checkout info (no issue)
1741         # we know GetItem should work because GetItemnumberFromBarcode worked
1742     my $hbr      = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1743         # get the proper branch to which to return the item
1744     $hbr = $item->{$hbr} || $branch ;
1745         # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1746
1747     my $borrowernumber = $borrower->{'borrowernumber'} || undef;    # we don't know if we had a borrower or not
1748
1749     # check if the book is in a permanent collection....
1750     # FIXME -- This 'PE' attribute is largely undocumented.  afaict, there's no user interface that reflects this functionality.
1751     if ( $hbr ) {
1752         my $branches = GetBranches();    # a potentially expensive call for a non-feature.
1753         $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1754     }
1755
1756     # check if the return is allowed at this branch
1757     my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1758     unless ($returnallowed){
1759         $messages->{'Wrongbranch'} = {
1760             Wrongbranch => $branch,
1761             Rightbranch => $message
1762         };
1763         $doreturn = 0;
1764         return ( $doreturn, $messages, $issue, $borrower );
1765     }
1766
1767     if ( $item->{'wthdrawn'} ) { # book has been cancelled
1768         $messages->{'wthdrawn'} = 1;
1769         $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1770     }
1771
1772     # case of a return of document (deal with issues and holdingbranch)
1773     my $today = DateTime->now( time_zone => C4::Context->tz() );
1774     if ($doreturn) {
1775     my $datedue = $issue->{date_due};
1776         $borrower or warn "AddReturn without current borrower";
1777                 my $circControlBranch;
1778         if ($dropbox) {
1779             # define circControlBranch only if dropbox mode is set
1780             # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1781             # FIXME: check issuedate > returndate, factoring in holidays
1782             #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1783             $circControlBranch = _GetCircControlBranch($item,$borrower);
1784         $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $today ) == -1 ? 1 : 0;
1785         }
1786
1787         if ($borrowernumber) {
1788             if( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'}){
1789             # we only need to calculate and change the fines if we want to do that on return
1790             # Should be on for hourly loans
1791                 my $control = C4::Context->preference('CircControl');
1792                 my $control_branchcode =
1793                     ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
1794                   : ( $control eq 'PatronLibrary' )   ? $borrower->{branchcode}
1795                   :                                     $issue->{branchcode};
1796
1797                 my ( $amount, $type, $unitcounttotal ) =
1798                   C4::Overdues::CalcFine( $item, $borrower->{categorycode},
1799                     $control_branchcode, $datedue, $today );
1800
1801                 $type ||= q{};
1802
1803                 if ( $amount > 0
1804                     && C4::Context->preference('finesMode') eq 'production' )
1805                 {
1806                     C4::Overdues::UpdateFine( $issue->{itemnumber},
1807                         $issue->{borrowernumber},
1808                         $amount, $type, output_pref($datedue) );
1809                 }
1810             }
1811
1812             MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1813                 $circControlBranch, '', $borrower->{'privacy'} );
1814
1815             # FIXME is the "= 1" right?  This could be the borrower hash.
1816             $messages->{'WasReturned'} = 1;
1817
1818         }
1819
1820         ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1821     }
1822
1823     # the holdingbranch is updated if the document is returned to another location.
1824     # this is always done regardless of whether the item was on loan or not
1825     if ($item->{'holdingbranch'} ne $branch) {
1826         UpdateHoldingbranch($branch, $item->{'itemnumber'});
1827         $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1828     }
1829     ModDateLastSeen( $item->{'itemnumber'} );
1830
1831     # check if we have a transfer for this document
1832     my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1833
1834     # if we have a transfer to do, we update the line of transfers with the datearrived
1835     if ($datesent) {
1836         if ( $tobranch eq $branch ) {
1837             my $sth = C4::Context->dbh->prepare(
1838                 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1839             );
1840             $sth->execute( $item->{'itemnumber'} );
1841             # if we have a reservation with valid transfer, we can set it's status to 'W'
1842             ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1843             C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1844         } else {
1845             $messages->{'WrongTransfer'}     = $tobranch;
1846             $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1847         }
1848         $validTransfert = 1;
1849     } else {
1850         ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1851     }
1852
1853     # fix up the accounts.....
1854     if ( $item->{'itemlost'} ) {
1855         $messages->{'WasLost'} = 1;
1856
1857         if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1858             _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode);    # can tolerate undef $borrowernumber
1859             $messages->{'LostItemFeeRefunded'} = 1;
1860         }
1861     }
1862
1863     # fix up the overdues in accounts...
1864     if ($borrowernumber) {
1865         my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1866         defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!";  # zero is OK, check defined
1867
1868         if ( $issue->{overdue} && $issue->{date_due} ) {
1869 # fix fine days
1870             my $debardate =
1871               _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1872             $messages->{Debarred} = $debardate if ($debardate);
1873         }
1874     }
1875
1876     # find reserves.....
1877     # if we don't have a reserve with the status W, we launch the Checkreserves routine
1878     my ($resfound, $resrec);
1879     ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'} ) unless ( $item->{'wthdrawn'} );
1880     if ($resfound) {
1881           $resrec->{'ResFound'} = $resfound;
1882         $messages->{'ResFound'} = $resrec;
1883     }
1884
1885     # update stats?
1886     # Record the fact that this book was returned.
1887     UpdateStats(
1888         $branch, $stat_type, '0', '',
1889         $item->{'itemnumber'},
1890         $biblio->{'itemtype'},
1891         $borrowernumber, undef, $item->{'ccode'}
1892     );
1893
1894     # Send a check-in slip. # NOTE: borrower may be undef.  probably shouldn't try to send messages then.
1895     my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1896     my %conditions = (
1897         branchcode   => $branch,
1898         categorycode => $borrower->{categorycode},
1899         item_type    => $item->{itype},
1900         notification => 'CHECKIN',
1901     );
1902     if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1903         SendCirculationAlert({
1904             type     => 'CHECKIN',
1905             item     => $item,
1906             borrower => $borrower,
1907             branch   => $branch,
1908         });
1909     }
1910
1911     logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
1912         if C4::Context->preference("ReturnLog");
1913
1914     # FIXME: make this comment intelligible.
1915     #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1916     #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1917
1918     if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
1919         if ( C4::Context->preference("AutomaticItemReturn"    ) or
1920             (C4::Context->preference("UseBranchTransferLimits") and
1921              ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1922            )) {
1923             $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1924             $debug and warn "item: " . Dumper($item);
1925             ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1926             $messages->{'WasTransfered'} = 1;
1927         } else {
1928             $messages->{'NeedsTransfer'} = 1;   # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1929         }
1930     }
1931     return ( $doreturn, $messages, $issue, $borrower );
1932 }
1933
1934 =head2 MarkIssueReturned
1935
1936   MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1937
1938 Unconditionally marks an issue as being returned by
1939 moving the C<issues> row to C<old_issues> and
1940 setting C<returndate> to the current date, or
1941 the last non-holiday date of the branccode specified in
1942 C<dropbox_branch> .  Assumes you've already checked that
1943 it's safe to do this, i.e. last non-holiday > issuedate.
1944
1945 if C<$returndate> is specified (in iso format), it is used as the date
1946 of the return. It is ignored when a dropbox_branch is passed in.
1947
1948 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1949 the old_issue is immediately anonymised
1950
1951 Ideally, this function would be internal to C<C4::Circulation>,
1952 not exported, but it is currently needed by one
1953 routine in C<C4::Accounts>.
1954
1955 =cut
1956
1957 sub MarkIssueReturned {
1958     my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1959
1960     my $dbh   = C4::Context->dbh;
1961     my $query = 'UPDATE issues SET returndate=';
1962     my @bind;
1963     if ($dropbox_branch) {
1964         my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
1965         my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
1966         $query .= ' ? ';
1967         push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
1968     } elsif ($returndate) {
1969         $query .= ' ? ';
1970         push @bind, $returndate;
1971     } else {
1972         $query .= ' now() ';
1973     }
1974     $query .= ' WHERE  borrowernumber = ?  AND itemnumber = ?';
1975     push @bind, $borrowernumber, $itemnumber;
1976     # FIXME transaction
1977     my $sth_upd  = $dbh->prepare($query);
1978     $sth_upd->execute(@bind);
1979     my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
1980                                   WHERE borrowernumber = ?
1981                                   AND itemnumber = ?');
1982     $sth_copy->execute($borrowernumber, $itemnumber);
1983     # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
1984     if ( $privacy == 2) {
1985         # The default of 0 does not work due to foreign key constraints
1986         # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
1987         # FIXME the above is unacceptable - bug 9942 relates
1988         my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
1989         my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
1990                                   WHERE borrowernumber = ?
1991                                   AND itemnumber = ?");
1992        $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
1993     }
1994     my $sth_del  = $dbh->prepare("DELETE FROM issues
1995                                   WHERE borrowernumber = ?
1996                                   AND itemnumber = ?");
1997     $sth_del->execute($borrowernumber, $itemnumber);
1998 }
1999
2000 =head2 _debar_user_on_return
2001
2002     _debar_user_on_return($borrower, $item, $datedue, today);
2003
2004 C<$borrower> borrower hashref
2005
2006 C<$item> item hashref
2007
2008 C<$datedue> date due DateTime object
2009
2010 C<$today> DateTime object representing the return time
2011
2012 Internal function, called only by AddReturn that calculates and updates
2013  the user fine days, and debars him if necessary.
2014
2015 Should only be called for overdue returns
2016
2017 =cut
2018
2019 sub _debar_user_on_return {
2020     my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2021
2022     my $branchcode = _GetCircControlBranch( $item, $borrower );
2023     my $calendar = Koha::Calendar->new( branchcode => $branchcode );
2024
2025     # $deltadays is a DateTime::Duration object
2026     my $deltadays = $calendar->days_between( $dt_due, $dt_today );
2027
2028     my $circcontrol = C4::Context->preference('CircControl');
2029     my $issuingrule =
2030       GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2031     my $finedays = $issuingrule->{finedays};
2032     my $unit     = $issuingrule->{lengthunit};
2033
2034     if ($finedays) {
2035
2036         # finedays is in days, so hourly loans must multiply by 24
2037         # thus 1 hour late equals 1 day suspension * finedays rate
2038         $finedays = $finedays * 24 if ( $unit eq 'hours' );
2039
2040         # grace period is measured in the same units as the loan
2041         my $grace =
2042           DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2043         if ( $deltadays->subtract($grace)->is_positive() ) {
2044
2045             my $new_debar_dt =
2046               $dt_today->clone()->add_duration( $deltadays * $finedays );
2047             if ( $borrower->{debarred} ) {
2048                 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2049
2050                 # Update patron only if new date > old
2051                 if ( DateTime->compare( $borrower_debar_dt, $new_debar_dt ) !=
2052                     -1 )
2053                 {
2054                     return;
2055                 }
2056
2057             }
2058             C4::Members::DebarMember( $borrower->{borrowernumber},
2059                 $new_debar_dt->ymd() );
2060             return $new_debar_dt->ymd();
2061         }
2062     }
2063     return;
2064 }
2065
2066 =head2 _FixOverduesOnReturn
2067
2068    &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2069
2070 C<$brn> borrowernumber
2071
2072 C<$itm> itemnumber
2073
2074 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2075 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2076
2077 Internal function, called only by AddReturn
2078
2079 =cut
2080
2081 sub _FixOverduesOnReturn {
2082     my ($borrowernumber, $item);
2083     unless ($borrowernumber = shift) {
2084         warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2085         return;
2086     }
2087     unless ($item = shift) {
2088         warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2089         return;
2090     }
2091     my ($exemptfine, $dropbox) = @_;
2092     my $dbh = C4::Context->dbh;
2093
2094     # check for overdue fine
2095     my $sth = $dbh->prepare(
2096 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2097     );
2098     $sth->execute( $borrowernumber, $item );
2099
2100     # alter fine to show that the book has been returned
2101     my $data = $sth->fetchrow_hashref;
2102     return 0 unless $data;    # no warning, there's just nothing to fix
2103
2104     my $uquery;
2105     my @bind = ($data->{'accountlines_id'});
2106     if ($exemptfine) {
2107         $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2108         if (C4::Context->preference("FinesLog")) {
2109             &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2110         }
2111     } elsif ($dropbox && $data->{lastincrement}) {
2112         my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2113         my $amt = $data->{amount} - $data->{lastincrement} ;
2114         if (C4::Context->preference("FinesLog")) {
2115             &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2116         }
2117          $uquery = "update accountlines set accounttype='F' ";
2118          if($outstanding  >= 0 && $amt >=0) {
2119             $uquery .= ", amount = ? , amountoutstanding=? ";
2120             unshift @bind, ($amt, $outstanding) ;
2121         }
2122     } else {
2123         $uquery = "update accountlines set accounttype='F' ";
2124     }
2125     $uquery .= " where (accountlines_id = ?)";
2126     my $usth = $dbh->prepare($uquery);
2127     return $usth->execute(@bind);
2128 }
2129
2130 =head2 _FixAccountForLostAndReturned
2131
2132   &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2133
2134 Calculates the charge for a book lost and returned.
2135
2136 Internal function, not exported, called only by AddReturn.
2137
2138 FIXME: This function reflects how inscrutable fines logic is.  Fix both.
2139 FIXME: Give a positive return value on success.  It might be the $borrowernumber who received credit, or the amount forgiven.
2140
2141 =cut
2142
2143 sub _FixAccountForLostAndReturned {
2144     my $itemnumber     = shift or return;
2145     my $borrowernumber = @_ ? shift : undef;
2146     my $item_id        = @_ ? shift : $itemnumber;  # Send the barcode if you want that logged in the description
2147     my $dbh = C4::Context->dbh;
2148     # check for charge made for lost book
2149     my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2150     $sth->execute($itemnumber);
2151     my $data = $sth->fetchrow_hashref;
2152     $data or return;    # bail if there is nothing to do
2153     $data->{accounttype} eq 'W' and return;    # Written off
2154
2155     # writeoff this amount
2156     my $offset;
2157     my $amount = $data->{'amount'};
2158     my $acctno = $data->{'accountno'};
2159     my $amountleft;                                             # Starts off undef/zero.
2160     if ($data->{'amountoutstanding'} == $amount) {
2161         $offset     = $data->{'amount'};
2162         $amountleft = 0;                                        # Hey, it's zero here, too.
2163     } else {
2164         $offset     = $amount - $data->{'amountoutstanding'};   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2165         $amountleft = $data->{'amountoutstanding'} - $amount;   # Um, isn't this the same as ZERO?  We just tested those two things are ==
2166     }
2167     my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2168         WHERE (accountlines_id = ?)");
2169     $usth->execute($data->{'accountlines_id'});      # We might be adjusting an account for some OTHER borrowernumber now.  Not the one we passed in.
2170     #check if any credit is left if so writeoff other accounts
2171     my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2172     $amountleft *= -1 if ($amountleft < 0);
2173     if ($amountleft > 0) {
2174         my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2175                             AND (amountoutstanding >0) ORDER BY date");     # might want to order by amountoustanding ASC (pay smallest first)
2176         $msth->execute($data->{'borrowernumber'});
2177         # offset transactions
2178         my $newamtos;
2179         my $accdata;
2180         while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2181             if ($accdata->{'amountoutstanding'} < $amountleft) {
2182                 $newamtos = 0;
2183                 $amountleft -= $accdata->{'amountoutstanding'};
2184             }  else {
2185                 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2186                 $amountleft = 0;
2187             }
2188             my $thisacct = $accdata->{'accountlines_id'};
2189             # FIXME: move prepares outside while loop!
2190             my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2191                     WHERE (accountlines_id = ?)");
2192             $usth->execute($newamtos,$thisacct);
2193             $usth = $dbh->prepare("INSERT INTO accountoffsets
2194                 (borrowernumber, accountno, offsetaccount,  offsetamount)
2195                 VALUES
2196                 (?,?,?,?)");
2197             $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2198         }
2199         $msth->finish;  # $msth might actually have data left
2200     }
2201     $amountleft *= -1 if ($amountleft > 0);
2202     my $desc = "Item Returned " . $item_id;
2203     $usth = $dbh->prepare("INSERT INTO accountlines
2204         (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2205         VALUES (?,?,now(),?,?,'CR',?)");
2206     $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2207     if ($borrowernumber) {
2208         # FIXME: same as query above.  use 1 sth for both
2209         $usth = $dbh->prepare("INSERT INTO accountoffsets
2210             (borrowernumber, accountno, offsetaccount,  offsetamount)
2211             VALUES (?,?,?,?)");
2212         $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2213     }
2214     ModItem({ paidfor => '' }, undef, $itemnumber);
2215     return;
2216 }
2217
2218 =head2 _GetCircControlBranch
2219
2220    my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2221
2222 Internal function :
2223
2224 Return the library code to be used to determine which circulation
2225 policy applies to a transaction.  Looks up the CircControl and
2226 HomeOrHoldingBranch system preferences.
2227
2228 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2229
2230 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2231
2232 =cut
2233
2234 sub _GetCircControlBranch {
2235     my ($item, $borrower) = @_;
2236     my $circcontrol = C4::Context->preference('CircControl');
2237     my $branch;
2238
2239     if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2240         $branch= C4::Context->userenv->{'branch'};
2241     } elsif ($circcontrol eq 'PatronLibrary') {
2242         $branch=$borrower->{branchcode};
2243     } else {
2244         my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2245         $branch = $item->{$branchfield};
2246         # default to item home branch if holdingbranch is used
2247         # and is not defined
2248         if (!defined($branch) && $branchfield eq 'holdingbranch') {
2249             $branch = $item->{homebranch};
2250         }
2251     }
2252     return $branch;
2253 }
2254
2255
2256
2257
2258
2259
2260 =head2 GetItemIssue
2261
2262   $issue = &GetItemIssue($itemnumber);
2263
2264 Returns patron currently having a book, or undef if not checked out.
2265
2266 C<$itemnumber> is the itemnumber.
2267
2268 C<$issue> is a hashref of the row from the issues table.
2269
2270 =cut
2271
2272 sub GetItemIssue {
2273     my ($itemnumber) = @_;
2274     return unless $itemnumber;
2275     my $sth = C4::Context->dbh->prepare(
2276         "SELECT items.*, issues.*
2277         FROM issues
2278         LEFT JOIN items ON issues.itemnumber=items.itemnumber
2279         WHERE issues.itemnumber=?");
2280     $sth->execute($itemnumber);
2281     my $data = $sth->fetchrow_hashref;
2282     return unless $data;
2283     $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2284     $data->{issuedate}->truncate(to => 'minute');
2285     $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2286     $data->{date_due}->truncate(to => 'minute');
2287     my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2288     $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2289     return $data;
2290 }
2291
2292 =head2 GetOpenIssue
2293
2294   $issue = GetOpenIssue( $itemnumber );
2295
2296 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2297
2298 C<$itemnumber> is the item's itemnumber
2299
2300 Returns a hashref
2301
2302 =cut
2303
2304 sub GetOpenIssue {
2305   my ( $itemnumber ) = @_;
2306
2307   my $dbh = C4::Context->dbh;
2308   my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2309   $sth->execute( $itemnumber );
2310   my $issue = $sth->fetchrow_hashref();
2311   return $issue;
2312 }
2313
2314 =head2 GetItemIssues
2315
2316   $issues = &GetItemIssues($itemnumber, $history);
2317
2318 Returns patrons that have issued a book
2319
2320 C<$itemnumber> is the itemnumber
2321 C<$history> is false if you just want the current "issuer" (if any)
2322 and true if you want issues history from old_issues also.
2323
2324 Returns reference to an array of hashes
2325
2326 =cut
2327
2328 sub GetItemIssues {
2329     my ( $itemnumber, $history ) = @_;
2330
2331     my $today = DateTime->now( time_zome => C4::Context->tz);  # get today date
2332     $today->truncate( to => 'minute' );
2333     my $sql = "SELECT * FROM issues
2334               JOIN borrowers USING (borrowernumber)
2335               JOIN items     USING (itemnumber)
2336               WHERE issues.itemnumber = ? ";
2337     if ($history) {
2338         $sql .= "UNION ALL
2339                  SELECT * FROM old_issues
2340                  LEFT JOIN borrowers USING (borrowernumber)
2341                  JOIN items USING (itemnumber)
2342                  WHERE old_issues.itemnumber = ? ";
2343     }
2344     $sql .= "ORDER BY date_due DESC";
2345     my $sth = C4::Context->dbh->prepare($sql);
2346     if ($history) {
2347         $sth->execute($itemnumber, $itemnumber);
2348     } else {
2349         $sth->execute($itemnumber);
2350     }
2351     my $results = $sth->fetchall_arrayref({});
2352     foreach (@$results) {
2353         my $date_due = dt_from_string($_->{date_due},'sql');
2354         $date_due->truncate( to => 'minute' );
2355
2356         $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2357     }
2358     return $results;
2359 }
2360
2361 =head2 GetBiblioIssues
2362
2363   $issues = GetBiblioIssues($biblionumber);
2364
2365 this function get all issues from a biblionumber.
2366
2367 Return:
2368 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2369 tables issues and the firstname,surname & cardnumber from borrowers.
2370
2371 =cut
2372
2373 sub GetBiblioIssues {
2374     my $biblionumber = shift;
2375     return unless $biblionumber;
2376     my $dbh   = C4::Context->dbh;
2377     my $query = "
2378         SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2379         FROM issues
2380             LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2381             LEFT JOIN items ON issues.itemnumber = items.itemnumber
2382             LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2383             LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2384         WHERE biblio.biblionumber = ?
2385         UNION ALL
2386         SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2387         FROM old_issues
2388             LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2389             LEFT JOIN items ON old_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         ORDER BY timestamp
2394     ";
2395     my $sth = $dbh->prepare($query);
2396     $sth->execute($biblionumber, $biblionumber);
2397
2398     my @issues;
2399     while ( my $data = $sth->fetchrow_hashref ) {
2400         push @issues, $data;
2401     }
2402     return \@issues;
2403 }
2404
2405 =head2 GetUpcomingDueIssues
2406
2407   my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2408
2409 =cut
2410
2411 sub GetUpcomingDueIssues {
2412     my $params = shift;
2413
2414     $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2415     my $dbh = C4::Context->dbh;
2416
2417     my $statement = <<END_SQL;
2418 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2419 FROM issues
2420 LEFT JOIN items USING (itemnumber)
2421 LEFT OUTER JOIN branches USING (branchcode)
2422 WHERE returndate is NULL
2423 HAVING days_until_due > 0 AND days_until_due < ?
2424 END_SQL
2425
2426     my @bind_parameters = ( $params->{'days_in_advance'} );
2427
2428     my $sth = $dbh->prepare( $statement );
2429     $sth->execute( @bind_parameters );
2430     my $upcoming_dues = $sth->fetchall_arrayref({});
2431     $sth->finish;
2432
2433     return $upcoming_dues;
2434 }
2435
2436 =head2 CanBookBeRenewed
2437
2438   ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2439
2440 Find out whether a borrowed item may be renewed.
2441
2442 C<$borrowernumber> is the borrower number of the patron who currently
2443 has the item on loan.
2444
2445 C<$itemnumber> is the number of the item to renew.
2446
2447 C<$override_limit>, if supplied with a true value, causes
2448 the limit on the number of times that the loan can be renewed
2449 (as controlled by the item type) to be ignored.
2450
2451 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2452 item must currently be on loan to the specified borrower; renewals
2453 must be allowed for the item's type; and the borrower must not have
2454 already renewed the loan. $error will contain the reason the renewal can not proceed
2455
2456 =cut
2457
2458 sub CanBookBeRenewed {
2459
2460     # check renewal status
2461     my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2462     my $dbh       = C4::Context->dbh;
2463     my $renews    = 1;
2464     my $renewokay = 0;
2465     my $error;
2466
2467     my $borrower    = C4::Members::GetMemberDetails( $borrowernumber, 0 )   or return;
2468     my $item        = GetItem($itemnumber)                                  or return;
2469     my $itemissue   = GetItemIssue($itemnumber)                             or return;
2470
2471     my $branchcode  = _GetCircControlBranch($item, $borrower);
2472
2473     my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2474
2475     if ( ( $issuingrule->{renewalsallowed} > $itemissue->{renewals} ) || $override_limit ) {
2476         $renewokay = 1;
2477     } else {
2478         $error = "too_many";
2479     }
2480
2481     my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves( $itemnumber );
2482
2483     if ( $resfound ) { # '' when no hold was found
2484         $renewokay = 0;
2485         $error = "on_reserve";
2486     }
2487
2488     return ( $renewokay, $error );
2489 }
2490
2491 =head2 AddRenewal
2492
2493   &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2494
2495 Renews a loan.
2496
2497 C<$borrowernumber> is the borrower number of the patron who currently
2498 has the item.
2499
2500 C<$itemnumber> is the number of the item to renew.
2501
2502 C<$branch> is the library where the renewal took place (if any).
2503            The library that controls the circ policies for the renewal is retrieved from the issues record.
2504
2505 C<$datedue> can be a C4::Dates object used to set the due date.
2506
2507 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate.  If
2508 this parameter is not supplied, lastreneweddate is set to the current date.
2509
2510 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2511 from the book's item type.
2512
2513 =cut
2514
2515 sub AddRenewal {
2516     my $borrowernumber  = shift or return;
2517     my $itemnumber      = shift or return;
2518     my $branch          = shift;
2519     my $datedue         = shift;
2520     my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2521     my $item   = GetItem($itemnumber) or return;
2522     my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2523
2524     my $dbh = C4::Context->dbh;
2525     # Find the issues record for this book
2526     my $sth =
2527       $dbh->prepare("SELECT * FROM issues
2528                         WHERE borrowernumber=?
2529                         AND itemnumber=?"
2530       );
2531     $sth->execute( $borrowernumber, $itemnumber );
2532     my $issuedata = $sth->fetchrow_hashref;
2533     $sth->finish;
2534     if(defined $datedue && ref $datedue ne 'DateTime' ) {
2535         carp 'Invalid date passed to AddRenewal.';
2536         return;
2537     }
2538     # If the due date wasn't specified, calculate it by adding the
2539     # book's loan length to today's date or the current due date
2540     # based on the value of the RenewalPeriodBase syspref.
2541     unless ($datedue) {
2542
2543         my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2544         my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2545
2546         $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2547                                         dt_from_string( $issuedata->{date_due} ) :
2548                                         DateTime->now( time_zone => C4::Context->tz());
2549         $datedue =  CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2550     }
2551
2552     # Update the issues record to have the new due date, and a new count
2553     # of how many times it has been renewed.
2554     my $renews = $issuedata->{'renewals'} + 1;
2555     $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2556                             WHERE borrowernumber=?
2557                             AND itemnumber=?"
2558     );
2559
2560     $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2561     $sth->finish;
2562
2563     # Update the renewal count on the item, and tell zebra to reindex
2564     $renews = $biblio->{'renewals'} + 1;
2565     ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2566
2567     # Charge a new rental fee, if applicable?
2568     my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2569     if ( $charge > 0 ) {
2570         my $accountno = getnextacctno( $borrowernumber );
2571         my $item = GetBiblioFromItemNumber($itemnumber);
2572         my $manager_id = 0;
2573         $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2574         $sth = $dbh->prepare(
2575                 "INSERT INTO accountlines
2576                     (date, borrowernumber, accountno, amount, manager_id,
2577                     description,accounttype, amountoutstanding, itemnumber)
2578                     VALUES (now(),?,?,?,?,?,?,?,?)"
2579         );
2580         $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2581             "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2582             'Rent', $charge, $itemnumber );
2583     }
2584
2585     # Send a renewal slip according to checkout alert preferencei
2586     if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2587         my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2588         my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2589         my %conditions = (
2590                 branchcode   => $branch,
2591                 categorycode => $borrower->{categorycode},
2592                 item_type    => $item->{itype},
2593                 notification => 'CHECKOUT',
2594         );
2595         if ($circulation_alert->is_enabled_for(\%conditions)) {
2596                 SendCirculationAlert({
2597                         type     => 'RENEWAL',
2598                         item     => $item,
2599                 borrower => $borrower,
2600                 branch   => $branch,
2601                 });
2602         }
2603     }
2604
2605     # Log the renewal
2606     UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber, undef, $item->{'ccode'});
2607         return $datedue;
2608 }
2609
2610 sub GetRenewCount {
2611     # check renewal status
2612     my ( $bornum, $itemno ) = @_;
2613     my $dbh           = C4::Context->dbh;
2614     my $renewcount    = 0;
2615     my $renewsallowed = 0;
2616     my $renewsleft    = 0;
2617
2618     my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2619     my $item     = GetItem($itemno);
2620
2621     # Look in the issues table for this item, lent to this borrower,
2622     # and not yet returned.
2623
2624     # FIXME - I think this function could be redone to use only one SQL call.
2625     my $sth = $dbh->prepare(
2626         "select * from issues
2627                                 where (borrowernumber = ?)
2628                                 and (itemnumber = ?)"
2629     );
2630     $sth->execute( $bornum, $itemno );
2631     my $data = $sth->fetchrow_hashref;
2632     $renewcount = $data->{'renewals'} if $data->{'renewals'};
2633     $sth->finish;
2634     # $item and $borrower should be calculated
2635     my $branchcode = _GetCircControlBranch($item, $borrower);
2636
2637     my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2638
2639     $renewsallowed = $issuingrule->{'renewalsallowed'};
2640     $renewsleft    = $renewsallowed - $renewcount;
2641     if($renewsleft < 0){ $renewsleft = 0; }
2642     return ( $renewcount, $renewsallowed, $renewsleft );
2643 }
2644
2645 =head2 GetIssuingCharges
2646
2647   ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2648
2649 Calculate how much it would cost for a given patron to borrow a given
2650 item, including any applicable discounts.
2651
2652 C<$itemnumber> is the item number of item the patron wishes to borrow.
2653
2654 C<$borrowernumber> is the patron's borrower number.
2655
2656 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2657 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2658 if it's a video).
2659
2660 =cut
2661
2662 sub GetIssuingCharges {
2663
2664     # calculate charges due
2665     my ( $itemnumber, $borrowernumber ) = @_;
2666     my $charge = 0;
2667     my $dbh    = C4::Context->dbh;
2668     my $item_type;
2669
2670     # Get the book's item type and rental charge (via its biblioitem).
2671     my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2672         LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2673     $charge_query .= (C4::Context->preference('item-level_itypes'))
2674         ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2675         : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2676
2677     $charge_query .= ' WHERE items.itemnumber =?';
2678
2679     my $sth = $dbh->prepare($charge_query);
2680     $sth->execute($itemnumber);
2681     if ( my $item_data = $sth->fetchrow_hashref ) {
2682         $item_type = $item_data->{itemtype};
2683         $charge    = $item_data->{rentalcharge};
2684         my $branch = C4::Branch::mybranch();
2685         my $discount_query = q|SELECT rentaldiscount,
2686             issuingrules.itemtype, issuingrules.branchcode
2687             FROM borrowers
2688             LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2689             WHERE borrowers.borrowernumber = ?
2690             AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2691             AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2692         my $discount_sth = $dbh->prepare($discount_query);
2693         $discount_sth->execute( $borrowernumber, $item_type, $branch );
2694         my $discount_rules = $discount_sth->fetchall_arrayref({});
2695         if (@{$discount_rules}) {
2696             # We may have multiple rules so get the most specific
2697             my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2698             $charge = ( $charge * ( 100 - $discount ) ) / 100;
2699         }
2700     }
2701
2702     $sth->finish; # we havent _explicitly_ fetched all rows
2703     return ( $charge, $item_type );
2704 }
2705
2706 # Select most appropriate discount rule from those returned
2707 sub _get_discount_from_rule {
2708     my ($rules_ref, $branch, $itemtype) = @_;
2709     my $discount;
2710
2711     if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2712         $discount = $rules_ref->[0]->{rentaldiscount};
2713         return (defined $discount) ? $discount : 0;
2714     }
2715     # could have up to 4 does one match $branch and $itemtype
2716     my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2717     if (@d) {
2718         $discount = $d[0]->{rentaldiscount};
2719         return (defined $discount) ? $discount : 0;
2720     }
2721     # do we have item type + all branches
2722     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2723     if (@d) {
2724         $discount = $d[0]->{rentaldiscount};
2725         return (defined $discount) ? $discount : 0;
2726     }
2727     # do we all item types + this branch
2728     @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2729     if (@d) {
2730         $discount = $d[0]->{rentaldiscount};
2731         return (defined $discount) ? $discount : 0;
2732     }
2733     # so all and all (surely we wont get here)
2734     @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2735     if (@d) {
2736         $discount = $d[0]->{rentaldiscount};
2737         return (defined $discount) ? $discount : 0;
2738     }
2739     # none of the above
2740     return 0;
2741 }
2742
2743 =head2 AddIssuingCharge
2744
2745   &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2746
2747 =cut
2748
2749 sub AddIssuingCharge {
2750     my ( $itemnumber, $borrowernumber, $charge ) = @_;
2751     my $dbh = C4::Context->dbh;
2752     my $nextaccntno = getnextacctno( $borrowernumber );
2753     my $manager_id = 0;
2754     $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2755     my $query ="
2756         INSERT INTO accountlines
2757             (borrowernumber, itemnumber, accountno,
2758             date, amount, description, accounttype,
2759             amountoutstanding, manager_id)
2760         VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2761     ";
2762     my $sth = $dbh->prepare($query);
2763     $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2764     $sth->finish;
2765 }
2766
2767 =head2 GetTransfers
2768
2769   GetTransfers($itemnumber);
2770
2771 =cut
2772
2773 sub GetTransfers {
2774     my ($itemnumber) = @_;
2775
2776     my $dbh = C4::Context->dbh;
2777
2778     my $query = '
2779         SELECT datesent,
2780                frombranch,
2781                tobranch
2782         FROM branchtransfers
2783         WHERE itemnumber = ?
2784           AND datearrived IS NULL
2785         ';
2786     my $sth = $dbh->prepare($query);
2787     $sth->execute($itemnumber);
2788     my @row = $sth->fetchrow_array();
2789     $sth->finish;
2790     return @row;
2791 }
2792
2793 =head2 GetTransfersFromTo
2794
2795   @results = GetTransfersFromTo($frombranch,$tobranch);
2796
2797 Returns the list of pending transfers between $from and $to branch
2798
2799 =cut
2800
2801 sub GetTransfersFromTo {
2802     my ( $frombranch, $tobranch ) = @_;
2803     return unless ( $frombranch && $tobranch );
2804     my $dbh   = C4::Context->dbh;
2805     my $query = "
2806         SELECT itemnumber,datesent,frombranch
2807         FROM   branchtransfers
2808         WHERE  frombranch=?
2809           AND  tobranch=?
2810           AND datearrived IS NULL
2811     ";
2812     my $sth = $dbh->prepare($query);
2813     $sth->execute( $frombranch, $tobranch );
2814     my @gettransfers;
2815
2816     while ( my $data = $sth->fetchrow_hashref ) {
2817         push @gettransfers, $data;
2818     }
2819     $sth->finish;
2820     return (@gettransfers);
2821 }
2822
2823 =head2 DeleteTransfer
2824
2825   &DeleteTransfer($itemnumber);
2826
2827 =cut
2828
2829 sub DeleteTransfer {
2830     my ($itemnumber) = @_;
2831     my $dbh          = C4::Context->dbh;
2832     my $sth          = $dbh->prepare(
2833         "DELETE FROM branchtransfers
2834          WHERE itemnumber=?
2835          AND datearrived IS NULL "
2836     );
2837     $sth->execute($itemnumber);
2838     $sth->finish;
2839 }
2840
2841 =head2 AnonymiseIssueHistory
2842
2843   ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
2844
2845 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2846 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2847
2848 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2849 setting (force delete).
2850
2851 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
2852
2853 =cut
2854
2855 sub AnonymiseIssueHistory {
2856     my $date           = shift;
2857     my $borrowernumber = shift;
2858     my $dbh            = C4::Context->dbh;
2859     my $query          = "
2860         UPDATE old_issues
2861         SET    borrowernumber = ?
2862         WHERE  returndate < ?
2863           AND borrowernumber IS NOT NULL
2864     ";
2865
2866     # The default of 0 does not work due to foreign key constraints
2867     # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2868     my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2869     my @bind_params = ($anonymouspatron, $date);
2870     if (defined $borrowernumber) {
2871        $query .= " AND borrowernumber = ?";
2872        push @bind_params, $borrowernumber;
2873     } else {
2874        $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2875     }
2876     my $sth = $dbh->prepare($query);
2877     $sth->execute(@bind_params);
2878     my $anonymisation_err = $dbh->err;
2879     my $rows_affected = $sth->rows;  ### doublecheck row count return function
2880     return ($rows_affected, $anonymisation_err);
2881 }
2882
2883 =head2 SendCirculationAlert
2884
2885 Send out a C<check-in> or C<checkout> alert using the messaging system.
2886
2887 B<Parameters>:
2888
2889 =over 4
2890
2891 =item type
2892
2893 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2894
2895 =item item
2896
2897 Hashref of information about the item being checked in or out.
2898
2899 =item borrower
2900
2901 Hashref of information about the borrower of the item.
2902
2903 =item branch
2904
2905 The branchcode from where the checkout or check-in took place.
2906
2907 =back
2908
2909 B<Example>:
2910
2911     SendCirculationAlert({
2912         type     => 'CHECKOUT',
2913         item     => $item,
2914         borrower => $borrower,
2915         branch   => $branch,
2916     });
2917
2918 =cut
2919
2920 sub SendCirculationAlert {
2921     my ($opts) = @_;
2922     my ($type, $item, $borrower, $branch) =
2923         ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2924     my %message_name = (
2925         CHECKIN  => 'Item_Check_in',
2926         CHECKOUT => 'Item_Checkout',
2927         RENEWAL  => 'Item_Checkout',
2928     );
2929     my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2930         borrowernumber => $borrower->{borrowernumber},
2931         message_name   => $message_name{$type},
2932     });
2933     my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
2934     my $letter =  C4::Letters::GetPreparedLetter (
2935         module => 'circulation',
2936         letter_code => $type,
2937         branchcode => $branch,
2938         tables => {
2939             $issues_table => $item->{itemnumber},
2940             'items'       => $item->{itemnumber},
2941             'biblio'      => $item->{biblionumber},
2942             'biblioitems' => $item->{biblionumber},
2943             'borrowers'   => $borrower,
2944             'branches'    => $branch,
2945         }
2946     ) or return;
2947
2948     my @transports = keys %{ $borrower_preferences->{transports} };
2949     # warn "no transports" unless @transports;
2950     for (@transports) {
2951         # warn "transport: $_";
2952         my $message = C4::Message->find_last_message($borrower, $type, $_);
2953         if (!$message) {
2954             #warn "create new message";
2955             C4::Message->enqueue($letter, $borrower, $_);
2956         } else {
2957             #warn "append to old message";
2958             $message->append($letter);
2959             $message->update;
2960         }
2961     }
2962
2963     return $letter;
2964 }
2965
2966 =head2 updateWrongTransfer
2967
2968   $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2969
2970 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
2971
2972 =cut
2973
2974 sub updateWrongTransfer {
2975         my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2976         my $dbh = C4::Context->dbh;
2977 # first step validate the actual line of transfert .
2978         my $sth =
2979                 $dbh->prepare(
2980                         "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2981                 );
2982                 $sth->execute($FromLibrary,$itemNumber);
2983                 $sth->finish;
2984
2985 # second step create a new line of branchtransfer to the right location .
2986         ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2987
2988 #third step changing holdingbranch of item
2989         UpdateHoldingbranch($FromLibrary,$itemNumber);
2990 }
2991
2992 =head2 UpdateHoldingbranch
2993
2994   $items = UpdateHoldingbranch($branch,$itmenumber);
2995
2996 Simple methode for updating hodlingbranch in items BDD line
2997
2998 =cut
2999
3000 sub UpdateHoldingbranch {
3001         my ( $branch,$itemnumber ) = @_;
3002     ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3003 }
3004
3005 =head2 CalcDateDue
3006
3007 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3008
3009 this function calculates the due date given the start date and configured circulation rules,
3010 checking against the holidays calendar as per the 'useDaysMode' syspref.
3011 C<$startdate>   = C4::Dates object representing start date of loan period (assumed to be today)
3012 C<$itemtype>  = itemtype code of item in question
3013 C<$branch>  = location whose calendar to use
3014 C<$borrower> = Borrower object
3015 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3016
3017 =cut
3018
3019 sub CalcDateDue {
3020     my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3021
3022     $isrenewal ||= 0;
3023
3024     # loanlength now a href
3025     my $loanlength =
3026             GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3027
3028     my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3029             ? qq{renewalperiod}
3030             : qq{issuelength};
3031
3032     my $datedue;
3033     if ( $startdate ) {
3034         if (ref $startdate ne 'DateTime' ) {
3035             $datedue = dt_from_string($datedue);
3036         } else {
3037             $datedue = $startdate->clone;
3038         }
3039     } else {
3040         $datedue =
3041           DateTime->now( time_zone => C4::Context->tz() )
3042           ->truncate( to => 'minute' );
3043     }
3044
3045
3046     # calculate the datedue as normal
3047     if ( C4::Context->preference('useDaysMode') eq 'Days' )
3048     {    # ignoring calendar
3049         if ( $loanlength->{lengthunit} eq 'hours' ) {
3050             $datedue->add( hours => $loanlength->{$length_key} );
3051         } else {    # days
3052             $datedue->add( days => $loanlength->{$length_key} );
3053             $datedue->set_hour(23);
3054             $datedue->set_minute(59);
3055         }
3056     } else {
3057         my $dur;
3058         if ($loanlength->{lengthunit} eq 'hours') {
3059             $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3060         }
3061         else { # days
3062             $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3063         }
3064         my $calendar = Koha::Calendar->new( branchcode => $branch );
3065         $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3066         if ($loanlength->{lengthunit} eq 'days') {
3067             $datedue->set_hour(23);
3068             $datedue->set_minute(59);
3069         }
3070     }
3071
3072     # if Hard Due Dates are used, retreive them and apply as necessary
3073     my ( $hardduedate, $hardduedatecompare ) =
3074       GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3075     if ($hardduedate) {    # hardduedates are currently dates
3076         $hardduedate->truncate( to => 'minute' );
3077         $hardduedate->set_hour(23);
3078         $hardduedate->set_minute(59);
3079         my $cmp = DateTime->compare( $hardduedate, $datedue );
3080
3081 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3082 # if the calculated date is before the 'after' Hard Due Date (floor), override
3083 # if the hard due date is set to 'exactly', overrride
3084         if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3085             $datedue = $hardduedate->clone;
3086         }
3087
3088         # in all other cases, keep the date due as it is
3089
3090     }
3091
3092     # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3093     if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3094         my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
3095         $expiry_dt->set( hour => 23, minute => 59);
3096         if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
3097             $datedue = $expiry_dt->clone;
3098         }
3099     }
3100
3101     return $datedue;
3102 }
3103
3104
3105 =head2 CheckRepeatableHolidays
3106
3107   $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3108
3109 This function checks if the date due is a repeatable holiday
3110
3111 C<$date_due>   = returndate calculate with no day check
3112 C<$itemnumber>  = itemnumber
3113 C<$branchcode>  = localisation of issue
3114
3115 =cut
3116
3117 sub CheckRepeatableHolidays{
3118 my($itemnumber,$week_day,$branchcode)=@_;
3119 my $dbh = C4::Context->dbh;
3120 my $query = qq|SELECT count(*)
3121         FROM repeatable_holidays
3122         WHERE branchcode=?
3123         AND weekday=?|;
3124 my $sth = $dbh->prepare($query);
3125 $sth->execute($branchcode,$week_day);
3126 my $result=$sth->fetchrow;
3127 $sth->finish;
3128 return $result;
3129 }
3130
3131
3132 =head2 CheckSpecialHolidays
3133
3134   $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3135
3136 This function check if the date is a special holiday
3137
3138 C<$years>   = the years of datedue
3139 C<$month>   = the month of datedue
3140 C<$day>     = the day of datedue
3141 C<$itemnumber>  = itemnumber
3142 C<$branchcode>  = localisation of issue
3143
3144 =cut
3145
3146 sub CheckSpecialHolidays{
3147 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3148 my $dbh = C4::Context->dbh;
3149 my $query=qq|SELECT count(*)
3150              FROM `special_holidays`
3151              WHERE year=?
3152              AND month=?
3153              AND day=?
3154              AND branchcode=?
3155             |;
3156 my $sth = $dbh->prepare($query);
3157 $sth->execute($years,$month,$day,$branchcode);
3158 my $countspecial=$sth->fetchrow ;
3159 $sth->finish;
3160 return $countspecial;
3161 }
3162
3163 =head2 CheckRepeatableSpecialHolidays
3164
3165   $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3166
3167 This function check if the date is a repeatble special holidays
3168
3169 C<$month>   = the month of datedue
3170 C<$day>     = the day of datedue
3171 C<$itemnumber>  = itemnumber
3172 C<$branchcode>  = localisation of issue
3173
3174 =cut
3175
3176 sub CheckRepeatableSpecialHolidays{
3177 my ($month,$day,$itemnumber,$branchcode) = @_;
3178 my $dbh = C4::Context->dbh;
3179 my $query=qq|SELECT count(*)
3180              FROM `repeatable_holidays`
3181              WHERE month=?
3182              AND day=?
3183              AND branchcode=?
3184             |;
3185 my $sth = $dbh->prepare($query);
3186 $sth->execute($month,$day,$branchcode);
3187 my $countspecial=$sth->fetchrow ;
3188 $sth->finish;
3189 return $countspecial;
3190 }
3191
3192
3193
3194 sub CheckValidBarcode{
3195 my ($barcode) = @_;
3196 my $dbh = C4::Context->dbh;
3197 my $query=qq|SELECT count(*)
3198              FROM items
3199              WHERE barcode=?
3200             |;
3201 my $sth = $dbh->prepare($query);
3202 $sth->execute($barcode);
3203 my $exist=$sth->fetchrow ;
3204 $sth->finish;
3205 return $exist;
3206 }
3207
3208 =head2 IsBranchTransferAllowed
3209
3210   $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3211
3212 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3213
3214 =cut
3215
3216 sub IsBranchTransferAllowed {
3217         my ( $toBranch, $fromBranch, $code ) = @_;
3218
3219         if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3220
3221         my $limitType = C4::Context->preference("BranchTransferLimitsType");
3222         my $dbh = C4::Context->dbh;
3223
3224         my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3225         $sth->execute( $toBranch, $fromBranch, $code );
3226         my $limit = $sth->fetchrow_hashref();
3227
3228         ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3229         if ( $limit->{'limitId'} ) {
3230                 return 0;
3231         } else {
3232                 return 1;
3233         }
3234 }
3235
3236 =head2 CreateBranchTransferLimit
3237
3238   CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3239
3240 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3241
3242 =cut
3243
3244 sub CreateBranchTransferLimit {
3245    my ( $toBranch, $fromBranch, $code ) = @_;
3246
3247    my $limitType = C4::Context->preference("BranchTransferLimitsType");
3248
3249    my $dbh = C4::Context->dbh;
3250
3251    my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3252    $sth->execute( $code, $toBranch, $fromBranch );
3253 }
3254
3255 =head2 DeleteBranchTransferLimits
3256
3257 DeleteBranchTransferLimits($frombranch);
3258
3259 Deletes all the branch transfer limits for one branch
3260
3261 =cut
3262
3263 sub DeleteBranchTransferLimits {
3264     my $branch = shift;
3265     my $dbh    = C4::Context->dbh;
3266     my $sth    = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3267     $sth->execute($branch);
3268 }
3269
3270 sub ReturnLostItem{
3271     my ( $borrowernumber, $itemnum ) = @_;
3272
3273     MarkIssueReturned( $borrowernumber, $itemnum );
3274     my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3275     my $item = C4::Items::GetItem( $itemnum );
3276     my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3277     my @datearr = localtime(time);
3278     my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3279     my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3280     ModItem({ paidfor =>  $old_note."Paid for by $bor $date" }, undef, $itemnum);
3281 }
3282
3283
3284 sub LostItem{
3285     my ($itemnumber, $mark_returned, $charge_fee) = @_;
3286
3287     my $dbh = C4::Context->dbh();
3288     my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3289                            FROM issues
3290                            JOIN items USING (itemnumber)
3291                            JOIN biblio USING (biblionumber)
3292                            WHERE issues.itemnumber=?");
3293     $sth->execute($itemnumber);
3294     my $issues=$sth->fetchrow_hashref();
3295     $sth->finish;
3296
3297     # if a borrower lost the item, add a replacement cost to the their record
3298     if ( my $borrowernumber = $issues->{borrowernumber} ){
3299         my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3300
3301         C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}")
3302           if $charge_fee;
3303         #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3304         #warn " $issues->{'borrowernumber'}  /  $itemnumber ";
3305         MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3306     }
3307 }
3308
3309 sub GetOfflineOperations {
3310     my $dbh = C4::Context->dbh;
3311     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3312     $sth->execute(C4::Context->userenv->{'branch'});
3313     my $results = $sth->fetchall_arrayref({});
3314     $sth->finish;
3315     return $results;
3316 }
3317
3318 sub GetOfflineOperation {
3319     my $dbh = C4::Context->dbh;
3320     my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3321     $sth->execute( shift );
3322     my $result = $sth->fetchrow_hashref;
3323     $sth->finish;
3324     return $result;
3325 }
3326
3327 sub AddOfflineOperation {
3328     my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3329     my $dbh = C4::Context->dbh;
3330     my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3331     $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3332     return "Added.";
3333 }
3334
3335 sub DeleteOfflineOperation {
3336     my $dbh = C4::Context->dbh;
3337     my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3338     $sth->execute( shift );
3339     return "Deleted.";
3340 }
3341
3342 sub ProcessOfflineOperation {
3343     my $operation = shift;
3344
3345     my $report;
3346     if ( $operation->{action} eq 'return' ) {
3347         $report = ProcessOfflineReturn( $operation );
3348     } elsif ( $operation->{action} eq 'issue' ) {
3349         $report = ProcessOfflineIssue( $operation );
3350     } elsif ( $operation->{action} eq 'payment' ) {
3351         $report = ProcessOfflinePayment( $operation );
3352     }
3353
3354     DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3355
3356     return $report;
3357 }
3358
3359 sub ProcessOfflineReturn {
3360     my $operation = shift;
3361
3362     my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3363
3364     if ( $itemnumber ) {
3365         my $issue = GetOpenIssue( $itemnumber );
3366         if ( $issue ) {
3367             MarkIssueReturned(
3368                 $issue->{borrowernumber},
3369                 $itemnumber,
3370                 undef,
3371                 $operation->{timestamp},
3372             );
3373             ModItem(
3374                 { renewals => 0, onloan => undef },
3375                 $issue->{'biblionumber'},
3376                 $itemnumber
3377             );
3378             return "Success.";
3379         } else {
3380             return "Item not issued.";
3381         }
3382     } else {
3383         return "Item not found.";
3384     }
3385 }
3386
3387 sub ProcessOfflineIssue {
3388     my $operation = shift;
3389
3390     my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3391
3392     if ( $borrower->{borrowernumber} ) {
3393         my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3394         unless ($itemnumber) {
3395             return "Barcode not found.";
3396         }
3397         my $issue = GetOpenIssue( $itemnumber );
3398
3399         if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3400             MarkIssueReturned(
3401                 $issue->{borrowernumber},
3402                 $itemnumber,
3403                 undef,
3404                 $operation->{timestamp},
3405             );
3406         }
3407         AddIssue(
3408             $borrower,
3409             $operation->{'barcode'},
3410             undef,
3411             1,
3412             $operation->{timestamp},
3413             undef,
3414         );
3415         return "Success.";
3416     } else {
3417         return "Borrower not found.";
3418     }
3419 }
3420
3421 sub ProcessOfflinePayment {
3422     my $operation = shift;
3423
3424     my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3425     my $amount = $operation->{amount};
3426
3427     recordpayment( $borrower->{borrowernumber}, $amount );
3428
3429     return "Success."
3430 }
3431
3432
3433 =head2 TransferSlip
3434
3435   TransferSlip($user_branch, $itemnumber, $to_branch)
3436
3437   Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3438
3439 =cut
3440
3441 sub TransferSlip {
3442     my ($branch, $itemnumber, $to_branch) = @_;
3443
3444     my $item =  GetItem( $itemnumber )
3445       or return;
3446
3447     my $pulldate = C4::Dates->new();
3448
3449     return C4::Letters::GetPreparedLetter (
3450         module => 'circulation',
3451         letter_code => 'TRANSFERSLIP',
3452         branchcode => $branch,
3453         tables => {
3454             'branches'    => $to_branch,
3455             'biblio'      => $item->{biblionumber},
3456             'items'       => $item,
3457         },
3458     );
3459 }
3460
3461 =head2 CheckIfIssuedToPatron
3462
3463   CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3464
3465   Return 1 if any record item is issued to patron, otherwise return 0
3466
3467 =cut
3468
3469 sub CheckIfIssuedToPatron {
3470     my ($borrowernumber, $biblionumber) = @_;
3471
3472     my $items = GetItemsByBiblioitemnumber($biblionumber);
3473
3474     foreach my $item (@{$items}) {
3475         return 1 if ($item->{borrowernumber} && $item->{borrowernumber} eq $borrowernumber);
3476     }
3477
3478     return;
3479 }
3480
3481
3482 1;
3483
3484 __END__
3485
3486 =head1 AUTHOR
3487
3488 Koha Development Team <http://koha-community.org/>
3489
3490 =cut
3491