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