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