C4/Circulation.pm

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