1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
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
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.
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.
23 #use warnings; FIXME - Bug 2505
32 use C4::Dates qw(format_date);
34 use C4::ItemCirculationAlertPreference;
37 use C4::Branch; # GetBranches
38 use C4::Log; # logaction
40 GetAuthorisedValueByCode
42 GetKohaAuthorisedValueLib
44 use C4::Overdues qw(CalcFine UpdateFine);
45 use Algorithm::CheckDigits;
50 use Koha::Borrower::Debarments;
61 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
65 $VERSION = 3.07.00.049; # for version checking
68 # FIXME subs that should probably be elsewhere
75 # subs to deal with issuing a book
87 &GetBranchBorrowerCircRule
91 &AnonymiseIssueHistory
92 &CheckIfIssuedToPatron
96 # subs to deal with returns
102 # subs to deal with transfers
109 &IsBranchTransferAllowed
110 &CreateBranchTransferLimit
111 &DeleteBranchTransferLimits
115 # subs to deal with offline circulation
117 &GetOfflineOperations
120 &DeleteOfflineOperation
121 &ProcessOfflineOperation
127 C4::Circulation - Koha circulation module
135 The functions in this module deal with circulation, issues, and
136 returns, as well as general information about the library.
137 Also deals with stocktaking.
143 $str = &barcodedecode($barcode, [$filter]);
145 Generic filter function for barcode string.
146 Called on every circ if the System Pref itemBarcodeInputFilter is set.
147 Will do some manipulation of the barcode for systems that deliver a barcode
148 to circulation.pl that differs from the barcode stored for the item.
149 For proper functioning of this filter, calling the function on the
150 correct barcode string (items.barcode) should return an unaltered barcode.
152 The optional $filter argument is to allow for testing or explicit
153 behavior that ignores the System Pref. Valid values are the same as the
158 # FIXME -- the &decode fcn below should be wrapped into this one.
159 # FIXME -- these plugins should be moved out of Circulation.pm
162 my ($barcode, $filter) = @_;
163 my $branch = C4::Branch::mybranch();
164 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
165 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
166 if ($filter eq 'whitespace') {
168 } elsif ($filter eq 'cuecat') {
170 my @fields = split( /\./, $barcode );
171 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
172 ($#results == 2) and return $results[2];
173 } elsif ($filter eq 'T-prefix') {
174 if ($barcode =~ /^[Tt](\d)/) {
175 (defined($1) and $1 eq '0') and return $barcode;
176 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
178 return sprintf("T%07d", $barcode);
179 # FIXME: $barcode could be "T1", causing warning: substr outside of string
180 # Why drop the nonzero digit after the T?
181 # Why pass non-digits (or empty string) to "T%07d"?
182 } elsif ($filter eq 'libsuite8') {
183 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
184 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
185 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
187 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
190 } elsif ($filter eq 'EAN13') {
191 my $ean = CheckDigits('ean');
192 if ( $ean->is_valid($barcode) ) {
193 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
194 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
196 warn "# [$barcode] not valid EAN-13/UPC-A\n";
199 return $barcode; # return barcode, modified or not
204 $str = &decode($chunk);
206 Decodes a segment of a string emitted by a CueCat barcode scanner and
209 FIXME: Should be replaced with Barcode::Cuecat from CPAN
210 or Javascript based decoding on the client side.
217 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
218 my @s = map { index( $seq, $_ ); } split( //, $encoded );
219 my $l = ( $#s + 1 ) % 4;
222 # warn "Error: Cuecat decode parsing failed!";
230 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
232 chr( ( $n >> 16 ) ^ 67 )
233 .chr( ( $n >> 8 & 255 ) ^ 67 )
234 .chr( ( $n & 255 ) ^ 67 );
237 $r = substr( $r, 0, length($r) - $l );
243 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
244 $barcode, $ignore_reserves);
246 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
248 C<$newbranch> is the code for the branch to which the item should be transferred.
250 C<$barcode> is the barcode of the item to be transferred.
252 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
253 Otherwise, if an item is reserved, the transfer fails.
255 Returns three values:
261 is true if the transfer was successful.
265 is a reference-to-hash which may have any of the following keys:
271 There is no item in the catalog with the given barcode. The value is C<$barcode>.
275 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.
277 =item C<DestinationEqualsHolding>
279 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.
283 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.
287 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>.
289 =item C<WasTransferred>
291 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
300 my ( $tbr, $barcode, $ignoreRs ) = @_;
303 my $branches = GetBranches();
304 my $itemnumber = GetItemnumberFromBarcode( $barcode );
305 my $issue = GetItemIssue($itemnumber);
306 my $biblio = GetBiblioFromItemNumber($itemnumber);
309 if ( not $itemnumber ) {
310 $messages->{'BadBarcode'} = $barcode;
314 # get branches of book...
315 my $hbr = $biblio->{'homebranch'};
316 my $fbr = $biblio->{'holdingbranch'};
318 # if using Branch Transfer Limits
319 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
320 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
321 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
322 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
325 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
326 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
332 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
333 $messages->{'IsPermanent'} = $hbr;
337 # can't transfer book if is already there....
338 if ( $fbr eq $tbr ) {
339 $messages->{'DestinationEqualsHolding'} = 1;
343 # check if it is still issued to someone, return it...
344 if ($issue->{borrowernumber}) {
345 AddReturn( $barcode, $fbr );
346 $messages->{'WasReturned'} = $issue->{borrowernumber};
350 # That'll save a database query.
351 my ( $resfound, $resrec, undef ) =
352 CheckReserves( $itemnumber );
353 if ( $resfound and not $ignoreRs ) {
354 $resrec->{'ResFound'} = $resfound;
356 # $messages->{'ResFound'} = $resrec;
360 #actually do the transfer....
362 ModItemTransfer( $itemnumber, $fbr, $tbr );
364 # don't need to update MARC anymore, we do it in batch now
365 $messages->{'WasTransfered'} = 1;
368 ModDateLastSeen( $itemnumber );
369 return ( $dotransfer, $messages, $biblio );
374 my $borrower = shift;
375 my $biblionumber = shift;
377 my $cat_borrower = $borrower->{'categorycode'};
378 my $dbh = C4::Context->dbh;
380 # Get which branchcode we need
381 $branch = _GetCircControlBranch($item,$borrower);
382 my $type = (C4::Context->preference('item-level_itypes'))
383 ? $item->{'itype'} # item-level
384 : $item->{'itemtype'}; # biblio-level
386 # given branch, patron category, and item type, determine
387 # applicable issuing rule
388 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
390 # if a rule is found and has a loan limit set, count
391 # how many loans the patron already has that meet that
393 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
395 my $count_query = "SELECT COUNT(*) FROM issues
396 JOIN items USING (itemnumber) ";
398 my $rule_itemtype = $issuing_rule->{itemtype};
399 if ($rule_itemtype eq "*") {
400 # matching rule has the default item type, so count only
401 # those existing loans that don't fall under a more
403 if (C4::Context->preference('item-level_itypes')) {
404 $count_query .= " WHERE items.itype NOT IN (
405 SELECT itemtype FROM issuingrules
407 AND (categorycode = ? OR categorycode = ?)
411 $count_query .= " JOIN biblioitems USING (biblionumber)
412 WHERE biblioitems.itemtype NOT IN (
413 SELECT itemtype FROM issuingrules
415 AND (categorycode = ? OR categorycode = ?)
419 push @bind_params, $issuing_rule->{branchcode};
420 push @bind_params, $issuing_rule->{categorycode};
421 push @bind_params, $cat_borrower;
423 # rule has specific item type, so count loans of that
425 if (C4::Context->preference('item-level_itypes')) {
426 $count_query .= " WHERE items.itype = ? ";
428 $count_query .= " JOIN biblioitems USING (biblionumber)
429 WHERE biblioitems.itemtype= ? ";
431 push @bind_params, $type;
434 $count_query .= " AND borrowernumber = ? ";
435 push @bind_params, $borrower->{'borrowernumber'};
436 my $rule_branch = $issuing_rule->{branchcode};
437 if ($rule_branch ne "*") {
438 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
439 $count_query .= " AND issues.branchcode = ? ";
440 push @bind_params, $branch;
441 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
442 ; # if branch is the patron's home branch, then count all loans by patron
444 $count_query .= " AND items.homebranch = ? ";
445 push @bind_params, $branch;
449 my $count_sth = $dbh->prepare($count_query);
450 $count_sth->execute(@bind_params);
451 my ($current_loan_count) = $count_sth->fetchrow_array;
453 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
454 if ($current_loan_count >= $max_loans_allowed) {
455 return ($current_loan_count, $max_loans_allowed);
459 # Now count total loans against the limit for the branch
460 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
461 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
462 my @bind_params = ();
463 my $branch_count_query = "SELECT COUNT(*) FROM issues
464 JOIN items USING (itemnumber)
465 WHERE borrowernumber = ? ";
466 push @bind_params, $borrower->{borrowernumber};
468 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
469 $branch_count_query .= " AND issues.branchcode = ? ";
470 push @bind_params, $branch;
471 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
472 ; # if branch is the patron's home branch, then count all loans by patron
474 $branch_count_query .= " AND items.homebranch = ? ";
475 push @bind_params, $branch;
477 my $branch_count_sth = $dbh->prepare($branch_count_query);
478 $branch_count_sth->execute(@bind_params);
479 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
481 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
482 if ($current_loan_count >= $max_loans_allowed) {
483 return ($current_loan_count, $max_loans_allowed);
487 # OK, the patron can issue !!!
493 @issues = &itemissues($biblioitemnumber, $biblio);
495 Looks up information about who has borrowed the bookZ<>(s) with the
496 given biblioitemnumber.
498 C<$biblio> is ignored.
500 C<&itemissues> returns an array of references-to-hash. The keys
501 include the fields from the C<items> table in the Koha database.
502 Additional keys include:
508 If the item is currently on loan, this gives the due date.
510 If the item is not on loan, then this is either "Available" or
511 "Cancelled", if the item has been withdrawn.
515 If the item is currently on loan, this gives the card number of the
516 patron who currently has the item.
518 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
520 These give the timestamp for the last three times the item was
523 =item C<card0>, C<card1>, C<card2>
525 The card number of the last three patrons who borrowed this item.
527 =item C<borrower0>, C<borrower1>, C<borrower2>
529 The borrower number of the last three patrons who borrowed this item.
537 my ( $bibitem, $biblio ) = @_;
538 my $dbh = C4::Context->dbh;
540 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
545 $sth->execute($bibitem) || die $sth->errstr;
547 while ( my $data = $sth->fetchrow_hashref ) {
549 # Find out who currently has this item.
550 # FIXME - Wouldn't it be better to do this as a left join of
551 # some sort? Currently, this code assumes that if
552 # fetchrow_hashref() fails, then the book is on the shelf.
553 # fetchrow_hashref() can fail for any number of reasons (e.g.,
554 # database server crash), not just because no items match the
556 my $sth2 = $dbh->prepare(
557 "SELECT * FROM issues
558 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
563 $sth2->execute( $data->{'itemnumber'} );
564 if ( my $data2 = $sth2->fetchrow_hashref ) {
565 $data->{'date_due'} = $data2->{'date_due'};
566 $data->{'card'} = $data2->{'cardnumber'};
567 $data->{'borrower'} = $data2->{'borrowernumber'};
570 $data->{'date_due'} = ($data->{'withdrawn'} eq '1') ? 'Cancelled' : 'Available';
574 # Find the last 3 people who borrowed this item.
575 $sth2 = $dbh->prepare(
576 "SELECT * FROM old_issues
577 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
579 ORDER BY returndate DESC,timestamp DESC"
582 $sth2->execute( $data->{'itemnumber'} );
583 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
584 { # FIXME : error if there is less than 3 pple borrowing this item
585 if ( my $data2 = $sth2->fetchrow_hashref ) {
586 $data->{"timestamp$i2"} = $data2->{'timestamp'};
587 $data->{"card$i2"} = $data2->{'cardnumber'};
588 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
592 $results[$i] = $data;
599 =head2 CanBookBeIssued
601 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
602 $barcode, $duedatespec, $inprocess, $ignore_reserves );
604 Check if a book can be issued.
606 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
610 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
612 =item C<$barcode> is the bar code of the book being issued.
614 =item C<$duedatespec> is a C4::Dates object.
616 =item C<$inprocess> boolean switch
617 =item C<$ignore_reserves> boolean switch
625 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
626 Possible values are :
632 sticky due date is invalid
636 borrower gone with no address
640 borrower declared it's card lost
646 =head3 UNKNOWN_BARCODE
660 item is restricted (set by ??)
662 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
663 could be prevented, but ones that can be overriden by the operator.
665 Possible values are :
673 renewing, not issuing
675 =head3 ISSUED_TO_ANOTHER
677 issued to someone else.
681 reserved for someone else.
685 sticky due date is invalid or due date in the past
689 if the borrower borrows to much things
693 sub CanBookBeIssued {
694 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves ) = @_;
695 my %needsconfirmation; # filled with problems that needs confirmations
696 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
697 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
699 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
700 my $issue = GetItemIssue($item->{itemnumber});
701 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
702 $item->{'itemtype'}=$item->{'itype'};
703 my $dbh = C4::Context->dbh;
705 # MANDATORY CHECKS - unless item exists, nothing else matters
706 unless ( $item->{barcode} ) {
707 $issuingimpossible{UNKNOWN_BARCODE} = 1;
709 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
712 # DUE DATE is OK ? -- should already have checked.
714 if ($duedate && ref $duedate ne 'DateTime') {
715 $duedate = dt_from_string($duedate);
717 my $now = DateTime->now( time_zone => C4::Context->tz() );
718 unless ( $duedate ) {
719 my $issuedate = $now->clone();
721 my $branch = _GetCircControlBranch($item,$borrower);
722 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
723 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
725 # Offline circ calls AddIssue directly, doesn't run through here
726 # So issuingimpossible should be ok.
729 my $today = $now->clone();
730 $today->truncate( to => 'minute');
731 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
732 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
735 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
741 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
742 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
743 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'}, undef, $item->{'ccode'});
744 ModDateLastSeen( $item->{'itemnumber'} );
745 return( { STATS => 1 }, {});
747 if ( $borrower->{flags}->{GNA} ) {
748 $issuingimpossible{GNA} = 1;
750 if ( $borrower->{flags}->{'LOST'} ) {
751 $issuingimpossible{CARD_LOST} = 1;
753 if ( $borrower->{flags}->{'DBARRED'} ) {
754 $issuingimpossible{DEBARRED} = 1;
756 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
757 $issuingimpossible{EXPIRED} = 1;
759 my ($y, $m, $d) = split /-/,$borrower->{'dateexpiry'};
760 if ($y && $m && $d) { # are we really writing oinvalid dates to borrs
761 my $expiry_dt = DateTime->new(
765 time_zone => C4::Context->tz,
767 $expiry_dt->truncate( to => 'day');
768 my $today = $now->clone()->truncate(to => 'day');
769 if (DateTime->compare($today, $expiry_dt) == 1) {
770 $issuingimpossible{EXPIRED} = 1;
773 carp("Invalid expity date in borr");
774 $issuingimpossible{EXPIRED} = 1;
782 my ($balance, $non_issue_charges, $other_charges) =
783 C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
784 my $amountlimit = C4::Context->preference("noissuescharge");
785 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
786 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
787 if ( C4::Context->preference("IssuingInProcess") ) {
788 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
789 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
790 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
791 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
792 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
793 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
797 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
798 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
799 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
800 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
801 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
802 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
805 if ($balance > 0 && $other_charges > 0) {
806 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
809 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
810 if ($blocktype == -1) {
811 ## patron has outstanding overdue loans
812 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
813 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
815 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
816 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
818 } elsif($blocktype == 1) {
819 # patron has accrued fine days
820 $issuingimpossible{USERBLOCKEDREMAINING} = $count;
824 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
826 my ($current_loan_count, $max_loans_allowed) = TooMany( $borrower, $item->{biblionumber}, $item );
827 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
828 if (defined $max_loans_allowed && $max_loans_allowed == 0) {
829 $needsconfirmation{PATRON_CANT} = 1;
831 if($max_loans_allowed){
832 if ( C4::Context->preference("AllowTooManyOverride") ) {
833 $needsconfirmation{TOO_MANY} = 1;
834 $needsconfirmation{current_loan_count} = $current_loan_count;
835 $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
837 $issuingimpossible{TOO_MANY} = 1;
838 $issuingimpossible{current_loan_count} = $current_loan_count;
839 $issuingimpossible{max_loans_allowed} = $max_loans_allowed;
847 if ( $item->{'notforloan'} )
849 if(!C4::Context->preference("AllowNotForLoanOverride")){
850 $issuingimpossible{NOT_FOR_LOAN} = 1;
851 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
853 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
854 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
858 # we have to check itemtypes.notforloan also
859 if (C4::Context->preference('item-level_itypes')){
860 # this should probably be a subroutine
861 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
862 $sth->execute($item->{'itemtype'});
863 my $notforloan=$sth->fetchrow_hashref();
864 if ($notforloan->{'notforloan'}) {
865 if (!C4::Context->preference("AllowNotForLoanOverride")) {
866 $issuingimpossible{NOT_FOR_LOAN} = 1;
867 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
869 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
870 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
874 elsif ($biblioitem->{'notforloan'} == 1){
875 if (!C4::Context->preference("AllowNotForLoanOverride")) {
876 $issuingimpossible{NOT_FOR_LOAN} = 1;
877 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
879 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
880 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
884 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
886 $issuingimpossible{WTHDRAWN} = 1;
888 if ( $item->{'restricted'}
889 && $item->{'restricted'} == 1 )
891 $issuingimpossible{RESTRICTED} = 1;
893 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
894 my $code = GetAuthorisedValueByCode( 'LOST', $item->{'itemlost'} );
895 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
896 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
898 if ( C4::Context->preference("IndependentBranches") ) {
899 my $userenv = C4::Context->userenv;
900 unless ( C4::Context->IsSuperLibrarian() ) {
901 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
902 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
903 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
905 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
906 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
911 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
913 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
916 # Already issued to current borrower. Ask whether the loan should
918 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
919 $borrower->{'borrowernumber'},
920 $item->{'itemnumber'}
922 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
923 $issuingimpossible{NO_MORE_RENEWALS} = 1;
926 $needsconfirmation{RENEW_ISSUE} = 1;
929 elsif ($issue->{borrowernumber}) {
931 # issued to someone else
932 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
934 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
935 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
936 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
937 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
938 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
939 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
942 unless ( $ignore_reserves ) {
943 # See if the item is on reserve.
944 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
946 my $resbor = $res->{'borrowernumber'};
947 if ( $resbor ne $borrower->{'borrowernumber'} ) {
948 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
949 my $branchname = GetBranchName( $res->{'branchcode'} );
950 if ( $restype eq "Waiting" )
952 # The item is on reserve and waiting, but has been
953 # reserved by some other patron.
954 $needsconfirmation{RESERVE_WAITING} = 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{'reswaitingdate'} = format_date($res->{'waitingdate'});
962 elsif ( $restype eq "Reserved" ) {
963 # The item is on reserve for someone else.
964 $needsconfirmation{RESERVED} = 1;
965 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
966 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
967 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
968 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
969 $needsconfirmation{'resbranchname'} = $branchname;
970 $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
976 # CHECK AGE RESTRICTION
979 # get $marker from preferences. Could be something like "FSK|PEGI|Alter|Age:"
980 my $markers = C4::Context->preference('AgeRestrictionMarker' );
981 my $bibvalues = $biblioitem->{'agerestriction'};
982 if (($markers)&&($bibvalues))
984 # Split $bibvalues to something like FSK 16 or PEGI 6
985 my @values = split ' ', uc($bibvalues);
987 # Search first occurence of one of the markers
988 my @markers = split /\|/, uc($markers);
990 my $restrictionyear = 0;
991 for my $value (@values) {
993 for my $marker (@markers) {
994 $marker =~ s/^\s+//; #remove leading spaces
995 $marker =~ s/\s+$//; #remove trailing spaces
996 if ($marker eq $value) {
997 if ($index <= $#values) {
998 $restrictionyear += $values[$index];
1001 } elsif ($value =~ /^\Q$marker\E(\d+)$/) {
1002 # Perhaps it is something like "K16" (as in Finland)
1003 $restrictionyear += $1;
1007 last if ($restrictionyear > 0);
1010 if ($restrictionyear > 0) {
1011 if ( $borrower->{'dateofbirth'} ) {
1012 my @alloweddate = split /-/,$borrower->{'dateofbirth'} ;
1013 $alloweddate[0] += $restrictionyear;
1014 #Prevent runime eror on leap year (invalid date)
1015 if (($alloweddate[1] == 2) && ($alloweddate[2] == 29)) {
1016 $alloweddate[2] = 28;
1019 if ( Date_to_Days(Today) < Date_to_Days(@alloweddate) -1 ) {
1020 if (C4::Context->preference('AgeRestrictionOverride' )) {
1021 $needsconfirmation{AGE_RESTRICTION} = "$bibvalues";
1024 $issuingimpossible{AGE_RESTRICTION} = "$bibvalues";
1031 ## check for high holds decreasing loan period
1032 my $decrease_loan = C4::Context->preference('decreaseLoanHighHolds');
1033 if ( $decrease_loan && $decrease_loan == 1 ) {
1034 my ( $reserved, $num, $duration, $returndate ) =
1035 checkHighHolds( $item, $borrower );
1037 if ( $num >= C4::Context->preference('decreaseLoanHighHoldsValue') ) {
1038 $needsconfirmation{HIGHHOLDS} = {
1040 duration => $duration,
1041 returndate => output_pref($returndate),
1046 return ( \%issuingimpossible, \%needsconfirmation, \%alerts );
1049 =head2 CanBookBeReturned
1051 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1053 Check whether the item can be returned to the provided branch
1057 =item C<$item> is a hash of item information as returned from GetItem
1059 =item C<$branch> is the branchcode where the return is taking place
1067 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1069 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1075 sub CanBookBeReturned {
1076 my ($item, $branch) = @_;
1077 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1079 # assume return is allowed to start
1083 # identify all cases where return is forbidden
1084 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1086 $message = $item->{'homebranch'};
1087 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1089 $message = $item->{'holdingbranch'};
1090 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1092 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1095 return ($allowed, $message);
1098 =head2 CheckHighHolds
1100 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1101 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1102 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1106 sub checkHighHolds {
1107 my ( $item, $borrower ) = @_;
1108 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1109 my $branch = _GetCircControlBranch( $item, $borrower );
1110 my $dbh = C4::Context->dbh;
1111 my $sth = $dbh->prepare(
1112 'select count(borrowernumber) as num_holds from reserves where biblionumber=?'
1114 $sth->execute( $item->{'biblionumber'} );
1115 my ($holds) = $sth->fetchrow_array;
1117 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1119 my $calendar = Koha::Calendar->new( branchcode => $branch );
1122 ( C4::Context->preference('item-level_itypes') )
1123 ? $biblio->{'itype'}
1124 : $biblio->{'itemtype'};
1126 C4::Circulation::CalcDateDue( $issuedate, $itype, $branch,
1129 my $reduced_datedue =
1130 $calendar->addDate( $issuedate,
1131 C4::Context->preference('decreaseLoanHighHoldsDuration') );
1133 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1135 C4::Context->preference('decreaseLoanHighHoldsDuration'),
1139 return ( 0, 0, 0, undef );
1144 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1146 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1150 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1152 =item C<$barcode> is the barcode of the item being issued.
1154 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
1155 Calculated if empty.
1157 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1159 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1160 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
1162 AddIssue does the following things :
1164 - step 01: check that there is a borrowernumber & a barcode provided
1165 - check for RENEWAL (book issued & being issued to the same patron)
1166 - renewal YES = Calculate Charge & renew
1168 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1170 - fill reserve if reserve to this patron
1171 - cancel reserve or not, otherwise
1172 * TRANSFERT PENDING ?
1173 - complete the transfert
1181 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
1182 my $dbh = C4::Context->dbh;
1183 my $barcodecheck=CheckValidBarcode($barcode);
1184 if ($datedue && ref $datedue ne 'DateTime') {
1185 $datedue = dt_from_string($datedue);
1187 # $issuedate defaults to today.
1188 if ( ! defined $issuedate ) {
1189 $issuedate = DateTime->now(time_zone => C4::Context->tz());
1192 if ( ref $issuedate ne 'DateTime') {
1193 $issuedate = dt_from_string($issuedate);
1197 if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1198 # find which item we issue
1199 my $item = GetItem('', $barcode) or return; # if we don't get an Item, abort.
1200 my $branch = _GetCircControlBranch($item,$borrower);
1202 # get actual issuing if there is one
1203 my $actualissue = GetItemIssue( $item->{itemnumber});
1205 # get biblioinformation for this item
1206 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
1209 # check if we just renew the issue.
1211 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
1212 $datedue = AddRenewal(
1213 $borrower->{'borrowernumber'},
1214 $item->{'itemnumber'},
1217 $issuedate, # here interpreted as the renewal date
1221 # it's NOT a renewal
1222 if ( $actualissue->{borrowernumber}) {
1223 # This book is currently on loan, but not to the person
1224 # who wants to borrow it now. mark it returned before issuing to the new borrower
1227 C4::Context->userenv->{'branch'}
1231 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1232 # Starting process for transfer job (checking transfert and validate it if we have one)
1233 my ($datesent) = GetTransfers($item->{'itemnumber'});
1235 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1238 "UPDATE branchtransfers
1239 SET datearrived = now(),
1241 comments = 'Forced branchtransfer'
1242 WHERE itemnumber= ? AND datearrived IS NULL"
1244 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1247 # Record in the database the fact that the book was issued.
1251 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1255 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1256 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1259 $datedue->truncate( to => 'minute');
1261 $borrower->{'borrowernumber'}, # borrowernumber
1262 $item->{'itemnumber'}, # itemnumber
1263 $issuedate->strftime('%Y-%m-%d %H:%M:00'), # issuedate
1264 $datedue->strftime('%Y-%m-%d %H:%M:00'), # date_due
1265 C4::Context->userenv->{'branch'} # branchcode
1267 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1268 CartToShelf( $item->{'itemnumber'} );
1270 $item->{'issues'}++;
1271 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1272 UpdateTotalIssues($item->{'biblionumber'}, 1);
1275 ## If item was lost, it has now been found, reverse any list item charges if neccessary.
1276 if ( $item->{'itemlost'} ) {
1277 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1278 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1282 ModItem({ issues => $item->{'issues'},
1283 holdingbranch => C4::Context->userenv->{'branch'},
1285 datelastborrowed => DateTime->now(time_zone => C4::Context->tz())->ymd(),
1286 onloan => $datedue->ymd(),
1287 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1288 ModDateLastSeen( $item->{'itemnumber'} );
1290 # If it costs to borrow this book, charge it to the patron's account.
1291 my ( $charge, $itemtype ) = GetIssuingCharges(
1292 $item->{'itemnumber'},
1293 $borrower->{'borrowernumber'}
1295 if ( $charge > 0 ) {
1297 $item->{'itemnumber'},
1298 $borrower->{'borrowernumber'}, $charge
1300 $item->{'charge'} = $charge;
1303 # Record the fact that this book was issued.
1305 C4::Context->userenv->{'branch'},
1307 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1308 $item->{'itype'}, $borrower->{'borrowernumber'}, undef, $item->{'ccode'}
1311 # Send a checkout slip.
1312 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1314 branchcode => $branch,
1315 categorycode => $borrower->{categorycode},
1316 item_type => $item->{itype},
1317 notification => 'CHECKOUT',
1319 if ($circulation_alert->is_enabled_for(\%conditions)) {
1320 SendCirculationAlert({
1323 borrower => $borrower,
1329 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'itemnumber'})
1330 if C4::Context->preference("IssueLog");
1332 return ($datedue); # not necessarily the same as when it came in!
1335 =head2 GetLoanLength
1337 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1339 Get loan length for an itemtype, a borrower type and a branch
1344 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1345 my $dbh = C4::Context->dbh;
1346 my $sth = $dbh->prepare(qq{
1347 SELECT issuelength, lengthunit, renewalperiod
1349 WHERE categorycode=?
1352 AND issuelength IS NOT NULL
1355 # try to find issuelength & return the 1st available.
1356 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1357 $sth->execute( $borrowertype, $itemtype, $branchcode );
1358 my $loanlength = $sth->fetchrow_hashref;
1361 if defined($loanlength) && $loanlength->{issuelength};
1363 $sth->execute( $borrowertype, '*', $branchcode );
1364 $loanlength = $sth->fetchrow_hashref;
1366 if defined($loanlength) && $loanlength->{issuelength};
1368 $sth->execute( '*', $itemtype, $branchcode );
1369 $loanlength = $sth->fetchrow_hashref;
1371 if defined($loanlength) && $loanlength->{issuelength};
1373 $sth->execute( '*', '*', $branchcode );
1374 $loanlength = $sth->fetchrow_hashref;
1376 if defined($loanlength) && $loanlength->{issuelength};
1378 $sth->execute( $borrowertype, $itemtype, '*' );
1379 $loanlength = $sth->fetchrow_hashref;
1381 if defined($loanlength) && $loanlength->{issuelength};
1383 $sth->execute( $borrowertype, '*', '*' );
1384 $loanlength = $sth->fetchrow_hashref;
1386 if defined($loanlength) && $loanlength->{issuelength};
1388 $sth->execute( '*', $itemtype, '*' );
1389 $loanlength = $sth->fetchrow_hashref;
1391 if defined($loanlength) && $loanlength->{issuelength};
1393 $sth->execute( '*', '*', '*' );
1394 $loanlength = $sth->fetchrow_hashref;
1396 if defined($loanlength) && $loanlength->{issuelength};
1398 # if no rule is set => 21 days (hardcoded)
1401 renewalperiod => 21,
1402 lengthunit => 'days',
1408 =head2 GetHardDueDate
1410 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1412 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1416 sub GetHardDueDate {
1417 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1419 my $rule = GetIssuingRule( $borrowertype, $itemtype, $branchcode );
1421 if ( defined( $rule ) ) {
1422 if ( $rule->{hardduedate} ) {
1423 return (dt_from_string($rule->{hardduedate}, 'iso'),$rule->{hardduedatecompare});
1425 return (undef, undef);
1430 =head2 GetIssuingRule
1432 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1434 FIXME - This is a copy-paste of GetLoanLength
1435 as a stop-gap. Do not wish to change API for GetLoanLength
1436 this close to release.
1438 Get the issuing rule for an itemtype, a borrower type and a branch
1439 Returns a hashref from the issuingrules table.
1443 sub GetIssuingRule {
1444 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1445 my $dbh = C4::Context->dbh;
1446 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1449 $sth->execute( $borrowertype, $itemtype, $branchcode );
1450 $irule = $sth->fetchrow_hashref;
1451 return $irule if defined($irule) ;
1453 $sth->execute( $borrowertype, "*", $branchcode );
1454 $irule = $sth->fetchrow_hashref;
1455 return $irule if defined($irule) ;
1457 $sth->execute( "*", $itemtype, $branchcode );
1458 $irule = $sth->fetchrow_hashref;
1459 return $irule if defined($irule) ;
1461 $sth->execute( "*", "*", $branchcode );
1462 $irule = $sth->fetchrow_hashref;
1463 return $irule if defined($irule) ;
1465 $sth->execute( $borrowertype, $itemtype, "*" );
1466 $irule = $sth->fetchrow_hashref;
1467 return $irule if defined($irule) ;
1469 $sth->execute( $borrowertype, "*", "*" );
1470 $irule = $sth->fetchrow_hashref;
1471 return $irule if defined($irule) ;
1473 $sth->execute( "*", $itemtype, "*" );
1474 $irule = $sth->fetchrow_hashref;
1475 return $irule if defined($irule) ;
1477 $sth->execute( "*", "*", "*" );
1478 $irule = $sth->fetchrow_hashref;
1479 return $irule if defined($irule) ;
1481 # if no rule matches,
1485 =head2 GetBranchBorrowerCircRule
1487 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1489 Retrieves circulation rule attributes that apply to the given
1490 branch and patron category, regardless of item type.
1491 The return value is a hashref containing the following key:
1493 maxissueqty - maximum number of loans that a
1494 patron of the given category can have at the given
1495 branch. If the value is undef, no limit.
1497 This will first check for a specific branch and
1498 category match from branch_borrower_circ_rules.
1500 If no rule is found, it will then check default_branch_circ_rules
1501 (same branch, default category). If no rule is found,
1502 it will then check default_borrower_circ_rules (default
1503 branch, same category), then failing that, default_circ_rules
1504 (default branch, default category).
1506 If no rule has been found in the database, it will default to
1511 C<$branchcode> and C<$categorycode> should contain the
1512 literal branch code and patron category code, respectively - no
1517 sub GetBranchBorrowerCircRule {
1518 my $branchcode = shift;
1519 my $categorycode = shift;
1521 my $branch_cat_query = "SELECT maxissueqty
1522 FROM branch_borrower_circ_rules
1523 WHERE branchcode = ?
1524 AND categorycode = ?";
1525 my $dbh = C4::Context->dbh();
1526 my $sth = $dbh->prepare($branch_cat_query);
1527 $sth->execute($branchcode, $categorycode);
1529 if ($result = $sth->fetchrow_hashref()) {
1533 # try same branch, default borrower category
1534 my $branch_query = "SELECT maxissueqty
1535 FROM default_branch_circ_rules
1536 WHERE branchcode = ?";
1537 $sth = $dbh->prepare($branch_query);
1538 $sth->execute($branchcode);
1539 if ($result = $sth->fetchrow_hashref()) {
1543 # try default branch, same borrower category
1544 my $category_query = "SELECT maxissueqty
1545 FROM default_borrower_circ_rules
1546 WHERE categorycode = ?";
1547 $sth = $dbh->prepare($category_query);
1548 $sth->execute($categorycode);
1549 if ($result = $sth->fetchrow_hashref()) {
1553 # try default branch, default borrower category
1554 my $default_query = "SELECT maxissueqty
1555 FROM default_circ_rules";
1556 $sth = $dbh->prepare($default_query);
1558 if ($result = $sth->fetchrow_hashref()) {
1562 # built-in default circulation rule
1564 maxissueqty => undef,
1568 =head2 GetBranchItemRule
1570 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1572 Retrieves circulation rule attributes that apply to the given
1573 branch and item type, regardless of patron category.
1575 The return value is a hashref containing the following keys:
1577 holdallowed => Hold policy for this branch and itemtype. Possible values:
1578 0: No holds allowed.
1579 1: Holds allowed only by patrons that have the same homebranch as the item.
1580 2: Holds allowed from any patron.
1582 returnbranch => branch to which to return item. Possible values:
1583 noreturn: do not return, let item remain where checked in (floating collections)
1584 homebranch: return to item's home branch
1586 This searches branchitemrules in the following order:
1588 * Same branchcode and itemtype
1589 * Same branchcode, itemtype '*'
1590 * branchcode '*', same itemtype
1591 * branchcode and itemtype '*'
1593 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1597 sub GetBranchItemRule {
1598 my ( $branchcode, $itemtype ) = @_;
1599 my $dbh = C4::Context->dbh();
1603 ['SELECT holdallowed, returnbranch
1604 FROM branch_item_rules
1605 WHERE branchcode = ?
1606 AND itemtype = ?', $branchcode, $itemtype],
1607 ['SELECT holdallowed, returnbranch
1608 FROM default_branch_circ_rules
1609 WHERE branchcode = ?', $branchcode],
1610 ['SELECT holdallowed, returnbranch
1611 FROM default_branch_item_rules
1612 WHERE itemtype = ?', $itemtype],
1613 ['SELECT holdallowed, returnbranch
1614 FROM default_circ_rules'],
1617 foreach my $attempt (@attempts) {
1618 my ($query, @bind_params) = @{$attempt};
1619 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1622 # Since branch/category and branch/itemtype use the same per-branch
1623 # defaults tables, we have to check that the key we want is set, not
1624 # just that a row was returned
1625 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1626 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1629 # built-in default circulation rule
1630 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1631 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1638 ($doreturn, $messages, $iteminformation, $borrower) =
1639 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1645 =item C<$barcode> is the bar code of the book being returned.
1647 =item C<$branch> is the code of the branch where the book is being returned.
1649 =item C<$exemptfine> indicates that overdue charges for the item will be
1652 =item C<$dropbox> indicates that the check-in date is assumed to be
1653 yesterday, or the last non-holiday as defined in C4::Calendar . If
1654 overdue charges are applied and C<$dropbox> is true, the last charge
1655 will be removed. This assumes that the fines accrual script has run
1660 C<&AddReturn> returns a list of four items:
1662 C<$doreturn> is true iff the return succeeded.
1664 C<$messages> is a reference-to-hash giving feedback on the operation.
1665 The keys of the hash are:
1671 No item with this barcode exists. The value is C<$barcode>.
1675 The book is not currently on loan. The value is C<$barcode>.
1677 =item C<IsPermanent>
1679 The book's home branch is a permanent collection. If you have borrowed
1680 this book, you are not allowed to return it. The value is the code for
1681 the book's home branch.
1685 This book has been withdrawn/cancelled. The value should be ignored.
1687 =item C<Wrongbranch>
1689 This book has was returned to the wrong branch. The value is a hashref
1690 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1691 contain the branchcode of the incorrect and correct return library, respectively.
1695 The item was reserved. The value is a reference-to-hash whose keys are
1696 fields from the reserves table of the Koha database, and
1697 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1698 either C<Waiting>, C<Reserved>, or 0.
1702 C<$iteminformation> is a reference-to-hash, giving information about the
1703 returned item from the issues table.
1705 C<$borrower> is a reference-to-hash, giving information about the
1706 patron who last borrowed the book.
1711 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1713 if ($branch and not GetBranchDetail($branch)) {
1714 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1717 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1722 my $validTransfert = 0;
1723 my $stat_type = 'return';
1725 # get information on item
1726 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1727 unless ($itemnumber) {
1728 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1730 my $issue = GetItemIssue($itemnumber);
1731 # warn Dumper($iteminformation);
1732 if ($issue and $issue->{borrowernumber}) {
1733 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1734 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1735 . Dumper($issue) . "\n";
1737 $messages->{'NotIssued'} = $barcode;
1738 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1740 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1741 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1742 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1743 $messages->{'LocalUse'} = 1;
1744 $stat_type = 'localuse';
1748 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1749 # full item data, but no borrowernumber or checkout info (no issue)
1750 # we know GetItem should work because GetItemnumberFromBarcode worked
1751 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1752 # get the proper branch to which to return the item
1753 $hbr = $item->{$hbr} || $branch ;
1754 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1756 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1758 # check if the book is in a permanent collection....
1759 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1761 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1762 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1765 # check if the return is allowed at this branch
1766 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1767 unless ($returnallowed){
1768 $messages->{'Wrongbranch'} = {
1769 Wrongbranch => $branch,
1770 Rightbranch => $message
1773 return ( $doreturn, $messages, $issue, $borrower );
1776 if ( $item->{'withdrawn'} ) { # book has been cancelled
1777 $messages->{'withdrawn'} = 1;
1778 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1781 # case of a return of document (deal with issues and holdingbranch)
1782 my $today = DateTime->now( time_zone => C4::Context->tz() );
1784 my $datedue = $issue->{date_due};
1785 $borrower or warn "AddReturn without current borrower";
1786 my $circControlBranch;
1788 # define circControlBranch only if dropbox mode is set
1789 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1790 # FIXME: check issuedate > returndate, factoring in holidays
1791 #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1792 $circControlBranch = _GetCircControlBranch($item,$borrower);
1793 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $today ) == -1 ? 1 : 0;
1796 if ($borrowernumber) {
1797 if( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'}){
1798 # we only need to calculate and change the fines if we want to do that on return
1799 # Should be on for hourly loans
1800 my $control = C4::Context->preference('CircControl');
1801 my $control_branchcode =
1802 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
1803 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
1804 : $issue->{branchcode};
1806 my ( $amount, $type, $unitcounttotal ) =
1807 C4::Overdues::CalcFine( $item, $borrower->{categorycode},
1808 $control_branchcode, $datedue, $today );
1813 && C4::Context->preference('finesMode') eq 'production' )
1815 C4::Overdues::UpdateFine( $issue->{itemnumber},
1816 $issue->{borrowernumber},
1817 $amount, $type, output_pref($datedue) );
1821 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1822 $circControlBranch, '', $borrower->{'privacy'} );
1824 # FIXME is the "= 1" right? This could be the borrower hash.
1825 $messages->{'WasReturned'} = 1;
1829 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1832 # the holdingbranch is updated if the document is returned to another location.
1833 # this is always done regardless of whether the item was on loan or not
1834 if ($item->{'holdingbranch'} ne $branch) {
1835 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1836 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1838 ModDateLastSeen( $item->{'itemnumber'} );
1840 # check if we have a transfer for this document
1841 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1843 # if we have a transfer to do, we update the line of transfers with the datearrived
1845 if ( $tobranch eq $branch ) {
1846 my $sth = C4::Context->dbh->prepare(
1847 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1849 $sth->execute( $item->{'itemnumber'} );
1850 # if we have a reservation with valid transfer, we can set it's status to 'W'
1851 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1852 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1854 $messages->{'WrongTransfer'} = $tobranch;
1855 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1857 $validTransfert = 1;
1859 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1862 # fix up the accounts.....
1863 if ( $item->{'itemlost'} ) {
1864 $messages->{'WasLost'} = 1;
1866 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1867 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1868 $messages->{'LostItemFeeRefunded'} = 1;
1872 # fix up the overdues in accounts...
1873 if ($borrowernumber) {
1874 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1875 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1877 if ( $issue->{overdue} && $issue->{date_due} ) {
1880 _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1881 $messages->{Debarred} = $debardate if ($debardate);
1885 # find reserves.....
1886 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1887 my ($resfound, $resrec);
1888 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1889 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
1891 $resrec->{'ResFound'} = $resfound;
1892 $messages->{'ResFound'} = $resrec;
1896 # Record the fact that this book was returned.
1898 $branch, $stat_type, '0', '',
1899 $item->{'itemnumber'},
1900 $biblio->{'itemtype'},
1901 $borrowernumber, undef, $item->{'ccode'}
1904 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1905 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1907 branchcode => $branch,
1908 categorycode => $borrower->{categorycode},
1909 item_type => $item->{itype},
1910 notification => 'CHECKIN',
1912 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1913 SendCirculationAlert({
1916 borrower => $borrower,
1921 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
1922 if C4::Context->preference("ReturnLog");
1924 # Remove any OVERDUES related debarment if the borrower has no overdues
1925 if ( $borrowernumber
1926 && $borrower->{'debarred'}
1927 && C4::Context->preference('AutoRemoveOverduesRestrictions')
1928 && !HasOverdues( $borrowernumber )
1929 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
1931 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
1934 # FIXME: make this comment intelligible.
1935 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1936 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1938 if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
1939 if ( C4::Context->preference("AutomaticItemReturn" ) or
1940 (C4::Context->preference("UseBranchTransferLimits") and
1941 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1943 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1944 $debug and warn "item: " . Dumper($item);
1945 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1946 $messages->{'WasTransfered'} = 1;
1948 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1951 return ( $doreturn, $messages, $issue, $borrower );
1954 =head2 MarkIssueReturned
1956 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1958 Unconditionally marks an issue as being returned by
1959 moving the C<issues> row to C<old_issues> and
1960 setting C<returndate> to the current date, or
1961 the last non-holiday date of the branccode specified in
1962 C<dropbox_branch> . Assumes you've already checked that
1963 it's safe to do this, i.e. last non-holiday > issuedate.
1965 if C<$returndate> is specified (in iso format), it is used as the date
1966 of the return. It is ignored when a dropbox_branch is passed in.
1968 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1969 the old_issue is immediately anonymised
1971 Ideally, this function would be internal to C<C4::Circulation>,
1972 not exported, but it is currently needed by one
1973 routine in C<C4::Accounts>.
1977 sub MarkIssueReturned {
1978 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1980 my $dbh = C4::Context->dbh;
1981 my $query = 'UPDATE issues SET returndate=';
1983 if ($dropbox_branch) {
1984 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
1985 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
1987 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
1988 } elsif ($returndate) {
1990 push @bind, $returndate;
1992 $query .= ' now() ';
1994 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
1995 push @bind, $borrowernumber, $itemnumber;
1997 my $sth_upd = $dbh->prepare($query);
1998 $sth_upd->execute(@bind);
1999 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
2000 WHERE borrowernumber = ?
2001 AND itemnumber = ?');
2002 $sth_copy->execute($borrowernumber, $itemnumber);
2003 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2004 if ( $privacy == 2) {
2005 # The default of 0 does not work due to foreign key constraints
2006 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2007 # FIXME the above is unacceptable - bug 9942 relates
2008 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2009 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
2010 WHERE borrowernumber = ?
2011 AND itemnumber = ?");
2012 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2014 my $sth_del = $dbh->prepare("DELETE FROM issues
2015 WHERE borrowernumber = ?
2016 AND itemnumber = ?");
2017 $sth_del->execute($borrowernumber, $itemnumber);
2020 =head2 _debar_user_on_return
2022 _debar_user_on_return($borrower, $item, $datedue, today);
2024 C<$borrower> borrower hashref
2026 C<$item> item hashref
2028 C<$datedue> date due DateTime object
2030 C<$today> DateTime object representing the return time
2032 Internal function, called only by AddReturn that calculates and updates
2033 the user fine days, and debars him if necessary.
2035 Should only be called for overdue returns
2039 sub _debar_user_on_return {
2040 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2042 my $branchcode = _GetCircControlBranch( $item, $borrower );
2043 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
2045 # $deltadays is a DateTime::Duration object
2046 my $deltadays = $calendar->days_between( $dt_due, $dt_today );
2048 my $circcontrol = C4::Context->preference('CircControl');
2050 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2051 my $finedays = $issuingrule->{finedays};
2052 my $unit = $issuingrule->{lengthunit};
2056 # finedays is in days, so hourly loans must multiply by 24
2057 # thus 1 hour late equals 1 day suspension * finedays rate
2058 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2060 # grace period is measured in the same units as the loan
2062 DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2063 if ( $deltadays->subtract($grace)->is_positive() ) {
2066 $dt_today->clone()->add_duration( $deltadays * $finedays );
2068 Koha::Borrower::Debarments::AddUniqueDebarment({
2069 borrowernumber => $borrower->{borrowernumber},
2070 expiration => $new_debar_dt->ymd(),
2071 type => 'SUSPENSION',
2074 return $new_debar_dt->ymd();
2080 =head2 _FixOverduesOnReturn
2082 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2084 C<$brn> borrowernumber
2088 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2089 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2091 Internal function, called only by AddReturn
2095 sub _FixOverduesOnReturn {
2096 my ($borrowernumber, $item);
2097 unless ($borrowernumber = shift) {
2098 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2101 unless ($item = shift) {
2102 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2105 my ($exemptfine, $dropbox) = @_;
2106 my $dbh = C4::Context->dbh;
2108 # check for overdue fine
2109 my $sth = $dbh->prepare(
2110 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2112 $sth->execute( $borrowernumber, $item );
2114 # alter fine to show that the book has been returned
2115 my $data = $sth->fetchrow_hashref;
2116 return 0 unless $data; # no warning, there's just nothing to fix
2119 my @bind = ($data->{'accountlines_id'});
2121 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2122 if (C4::Context->preference("FinesLog")) {
2123 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2125 } elsif ($dropbox && $data->{lastincrement}) {
2126 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2127 my $amt = $data->{amount} - $data->{lastincrement} ;
2128 if (C4::Context->preference("FinesLog")) {
2129 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2131 $uquery = "update accountlines set accounttype='F' ";
2132 if($outstanding >= 0 && $amt >=0) {
2133 $uquery .= ", amount = ? , amountoutstanding=? ";
2134 unshift @bind, ($amt, $outstanding) ;
2137 $uquery = "update accountlines set accounttype='F' ";
2139 $uquery .= " where (accountlines_id = ?)";
2140 my $usth = $dbh->prepare($uquery);
2141 return $usth->execute(@bind);
2144 =head2 _FixAccountForLostAndReturned
2146 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2148 Calculates the charge for a book lost and returned.
2150 Internal function, not exported, called only by AddReturn.
2152 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2153 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2157 sub _FixAccountForLostAndReturned {
2158 my $itemnumber = shift or return;
2159 my $borrowernumber = @_ ? shift : undef;
2160 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2161 my $dbh = C4::Context->dbh;
2162 # check for charge made for lost book
2163 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2164 $sth->execute($itemnumber);
2165 my $data = $sth->fetchrow_hashref;
2166 $data or return; # bail if there is nothing to do
2167 $data->{accounttype} eq 'W' and return; # Written off
2169 # writeoff this amount
2171 my $amount = $data->{'amount'};
2172 my $acctno = $data->{'accountno'};
2173 my $amountleft; # Starts off undef/zero.
2174 if ($data->{'amountoutstanding'} == $amount) {
2175 $offset = $data->{'amount'};
2176 $amountleft = 0; # Hey, it's zero here, too.
2178 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2179 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2181 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2182 WHERE (accountlines_id = ?)");
2183 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2184 #check if any credit is left if so writeoff other accounts
2185 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2186 $amountleft *= -1 if ($amountleft < 0);
2187 if ($amountleft > 0) {
2188 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2189 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2190 $msth->execute($data->{'borrowernumber'});
2191 # offset transactions
2194 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2195 if ($accdata->{'amountoutstanding'} < $amountleft) {
2197 $amountleft -= $accdata->{'amountoutstanding'};
2199 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2202 my $thisacct = $accdata->{'accountlines_id'};
2203 # FIXME: move prepares outside while loop!
2204 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2205 WHERE (accountlines_id = ?)");
2206 $usth->execute($newamtos,$thisacct);
2207 $usth = $dbh->prepare("INSERT INTO accountoffsets
2208 (borrowernumber, accountno, offsetaccount, offsetamount)
2211 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2214 $amountleft *= -1 if ($amountleft > 0);
2215 my $desc = "Item Returned " . $item_id;
2216 $usth = $dbh->prepare("INSERT INTO accountlines
2217 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2218 VALUES (?,?,now(),?,?,'CR',?)");
2219 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2220 if ($borrowernumber) {
2221 # FIXME: same as query above. use 1 sth for both
2222 $usth = $dbh->prepare("INSERT INTO accountoffsets
2223 (borrowernumber, accountno, offsetaccount, offsetamount)
2225 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2227 ModItem({ paidfor => '' }, undef, $itemnumber);
2231 =head2 _GetCircControlBranch
2233 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2237 Return the library code to be used to determine which circulation
2238 policy applies to a transaction. Looks up the CircControl and
2239 HomeOrHoldingBranch system preferences.
2241 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2243 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2247 sub _GetCircControlBranch {
2248 my ($item, $borrower) = @_;
2249 my $circcontrol = C4::Context->preference('CircControl');
2252 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2253 $branch= C4::Context->userenv->{'branch'};
2254 } elsif ($circcontrol eq 'PatronLibrary') {
2255 $branch=$borrower->{branchcode};
2257 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2258 $branch = $item->{$branchfield};
2259 # default to item home branch if holdingbranch is used
2260 # and is not defined
2261 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2262 $branch = $item->{homebranch};
2275 $issue = &GetItemIssue($itemnumber);
2277 Returns patron currently having a book, or undef if not checked out.
2279 C<$itemnumber> is the itemnumber.
2281 C<$issue> is a hashref of the row from the issues table.
2286 my ($itemnumber) = @_;
2287 return unless $itemnumber;
2288 my $sth = C4::Context->dbh->prepare(
2289 "SELECT items.*, issues.*
2291 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2292 WHERE issues.itemnumber=?");
2293 $sth->execute($itemnumber);
2294 my $data = $sth->fetchrow_hashref;
2295 return unless $data;
2296 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2297 $data->{issuedate}->truncate(to => 'minute');
2298 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2299 $data->{date_due}->truncate(to => 'minute');
2300 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2301 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2307 $issue = GetOpenIssue( $itemnumber );
2309 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2311 C<$itemnumber> is the item's itemnumber
2318 my ( $itemnumber ) = @_;
2319 return unless $itemnumber;
2320 my $dbh = C4::Context->dbh;
2321 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2322 $sth->execute( $itemnumber );
2323 return $sth->fetchrow_hashref();
2327 =head2 GetItemIssues
2329 $issues = &GetItemIssues($itemnumber, $history);
2331 Returns patrons that have issued a book
2333 C<$itemnumber> is the itemnumber
2334 C<$history> is false if you just want the current "issuer" (if any)
2335 and true if you want issues history from old_issues also.
2337 Returns reference to an array of hashes
2342 my ( $itemnumber, $history ) = @_;
2344 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2345 $today->truncate( to => 'minute' );
2346 my $sql = "SELECT * FROM issues
2347 JOIN borrowers USING (borrowernumber)
2348 JOIN items USING (itemnumber)
2349 WHERE issues.itemnumber = ? ";
2352 SELECT * FROM old_issues
2353 LEFT JOIN borrowers USING (borrowernumber)
2354 JOIN items USING (itemnumber)
2355 WHERE old_issues.itemnumber = ? ";
2357 $sql .= "ORDER BY date_due DESC";
2358 my $sth = C4::Context->dbh->prepare($sql);
2360 $sth->execute($itemnumber, $itemnumber);
2362 $sth->execute($itemnumber);
2364 my $results = $sth->fetchall_arrayref({});
2365 foreach (@$results) {
2366 my $date_due = dt_from_string($_->{date_due},'sql');
2367 $date_due->truncate( to => 'minute' );
2369 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2374 =head2 GetBiblioIssues
2376 $issues = GetBiblioIssues($biblionumber);
2378 this function get all issues from a biblionumber.
2381 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2382 tables issues and the firstname,surname & cardnumber from borrowers.
2386 sub GetBiblioIssues {
2387 my $biblionumber = shift;
2388 return unless $biblionumber;
2389 my $dbh = C4::Context->dbh;
2391 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2393 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2394 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2395 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2396 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2397 WHERE biblio.biblionumber = ?
2399 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2401 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2402 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2403 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2404 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2405 WHERE biblio.biblionumber = ?
2408 my $sth = $dbh->prepare($query);
2409 $sth->execute($biblionumber, $biblionumber);
2412 while ( my $data = $sth->fetchrow_hashref ) {
2413 push @issues, $data;
2418 =head2 GetUpcomingDueIssues
2420 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2424 sub GetUpcomingDueIssues {
2427 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2428 my $dbh = C4::Context->dbh;
2430 my $statement = <<END_SQL;
2431 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2433 LEFT JOIN items USING (itemnumber)
2434 LEFT OUTER JOIN branches USING (branchcode)
2435 WHERE returndate is NULL
2436 HAVING days_until_due >= 0 AND days_until_due <= ?
2439 my @bind_parameters = ( $params->{'days_in_advance'} );
2441 my $sth = $dbh->prepare( $statement );
2442 $sth->execute( @bind_parameters );
2443 my $upcoming_dues = $sth->fetchall_arrayref({});
2445 return $upcoming_dues;
2448 =head2 CanBookBeRenewed
2450 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2452 Find out whether a borrowed item may be renewed.
2454 C<$borrowernumber> is the borrower number of the patron who currently
2455 has the item on loan.
2457 C<$itemnumber> is the number of the item to renew.
2459 C<$override_limit>, if supplied with a true value, causes
2460 the limit on the number of times that the loan can be renewed
2461 (as controlled by the item type) to be ignored.
2463 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2464 item must currently be on loan to the specified borrower; renewals
2465 must be allowed for the item's type; and the borrower must not have
2466 already renewed the loan. $error will contain the reason the renewal can not proceed
2470 sub CanBookBeRenewed {
2471 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2473 my $dbh = C4::Context->dbh;
2478 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2479 my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2481 $borrowernumber ||= $itemissue->{borrowernumber};
2482 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2485 my $branchcode = _GetCircControlBranch($item, $borrower);
2487 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2489 if ( $issuingrule->{norenewalbefore} ) {
2491 # Get current time and add norenewalbefore. If this is smaller than date_due, it's too soon for renewal.
2493 DateTime->now( time_zone => C4::Context->tz() )->add(
2494 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore}
2495 ) < $itemissue->{date_due}
2499 $error = "too_soon";
2503 if ( $issuingrule->{renewalsallowed} <= $itemissue->{renewals} ) {
2505 $error = "too_many";
2508 if ( $override_limit ) {
2513 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves( $itemnumber );
2515 if ( $resfound ) { # '' when no hold was found
2517 $error = "on_reserve";
2520 return ( $renewokay, $error );
2525 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2529 C<$borrowernumber> is the borrower number of the patron who currently
2532 C<$itemnumber> is the number of the item to renew.
2534 C<$branch> is the library where the renewal took place (if any).
2535 The library that controls the circ policies for the renewal is retrieved from the issues record.
2537 C<$datedue> can be a C4::Dates object used to set the due date.
2539 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2540 this parameter is not supplied, lastreneweddate is set to the current date.
2542 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2543 from the book's item type.
2548 my $borrowernumber = shift;
2549 my $itemnumber = shift or return;
2551 my $datedue = shift;
2552 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2554 my $item = GetItem($itemnumber) or return;
2555 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2557 my $dbh = C4::Context->dbh;
2559 # Find the issues record for this book
2561 $dbh->prepare("SELECT * FROM issues WHERE itemnumber = ?");
2562 $sth->execute( $itemnumber );
2563 my $issuedata = $sth->fetchrow_hashref;
2565 return unless ( $issuedata );
2567 $borrowernumber ||= $issuedata->{borrowernumber};
2569 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2570 carp 'Invalid date passed to AddRenewal.';
2574 # If the due date wasn't specified, calculate it by adding the
2575 # book's loan length to today's date or the current due date
2576 # based on the value of the RenewalPeriodBase syspref.
2579 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2580 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2582 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2583 dt_from_string( $issuedata->{date_due} ) :
2584 DateTime->now( time_zone => C4::Context->tz());
2585 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2588 # Update the issues record to have the new due date, and a new count
2589 # of how many times it has been renewed.
2590 my $renews = $issuedata->{'renewals'} + 1;
2591 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2592 WHERE borrowernumber=?
2596 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2598 # Update the renewal count on the item, and tell zebra to reindex
2599 $renews = $biblio->{'renewals'} + 1;
2600 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2602 # Charge a new rental fee, if applicable?
2603 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2604 if ( $charge > 0 ) {
2605 my $accountno = getnextacctno( $borrowernumber );
2606 my $item = GetBiblioFromItemNumber($itemnumber);
2608 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2609 $sth = $dbh->prepare(
2610 "INSERT INTO accountlines
2611 (date, borrowernumber, accountno, amount, manager_id,
2612 description,accounttype, amountoutstanding, itemnumber)
2613 VALUES (now(),?,?,?,?,?,?,?,?)"
2615 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2616 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2617 'Rent', $charge, $itemnumber );
2620 # Send a renewal slip according to checkout alert preferencei
2621 if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2622 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2623 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2625 branchcode => $branch,
2626 categorycode => $borrower->{categorycode},
2627 item_type => $item->{itype},
2628 notification => 'CHECKOUT',
2630 if ($circulation_alert->is_enabled_for(\%conditions)) {
2631 SendCirculationAlert({
2634 borrower => $borrower,
2640 # Remove any OVERDUES related debarment if the borrower has no overdues
2641 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2642 if ( $borrowernumber
2643 && $borrower->{'debarred'}
2644 && !HasOverdues( $borrowernumber )
2645 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2647 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2651 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber, undef, $item->{'ccode'});
2656 # check renewal status
2657 my ( $bornum, $itemno ) = @_;
2658 my $dbh = C4::Context->dbh;
2660 my $renewsallowed = 0;
2663 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2664 my $item = GetItem($itemno);
2666 # Look in the issues table for this item, lent to this borrower,
2667 # and not yet returned.
2669 # FIXME - I think this function could be redone to use only one SQL call.
2670 my $sth = $dbh->prepare(
2671 "select * from issues
2672 where (borrowernumber = ?)
2673 and (itemnumber = ?)"
2675 $sth->execute( $bornum, $itemno );
2676 my $data = $sth->fetchrow_hashref;
2677 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2678 # $item and $borrower should be calculated
2679 my $branchcode = _GetCircControlBranch($item, $borrower);
2681 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2683 $renewsallowed = $issuingrule->{'renewalsallowed'};
2684 $renewsleft = $renewsallowed - $renewcount;
2685 if($renewsleft < 0){ $renewsleft = 0; }
2686 return ( $renewcount, $renewsallowed, $renewsleft );
2689 =head2 GetSoonestRenewDate
2691 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2693 Find out the soonest possible renew date of a borrowed item.
2695 C<$borrowernumber> is the borrower number of the patron who currently
2696 has the item on loan.
2698 C<$itemnumber> is the number of the item to renew.
2700 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2701 renew date, based on the value "No renewal before" of the applicable
2702 issuing rule. Returns the current date if the item can already be
2703 renewed, and returns undefined if the borrower, loan, or item
2708 sub GetSoonestRenewDate {
2709 my ( $borrowernumber, $itemnumber ) = @_;
2711 my $dbh = C4::Context->dbh;
2713 my $item = GetItem($itemnumber) or return;
2714 my $itemissue = GetItemIssue($itemnumber) or return;
2716 $borrowernumber ||= $itemissue->{borrowernumber};
2717 my $borrower = C4::Members::GetMemberDetails($borrowernumber)
2720 my $branchcode = _GetCircControlBranch( $item, $borrower );
2722 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2724 my $now = DateTime->now( time_zone => C4::Context->tz() );
2726 if ( $issuingrule->{norenewalbefore} ) {
2727 my $soonestrenewal =
2728 $itemissue->{date_due}->subtract(
2729 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore} );
2731 $soonestrenewal = $now > $soonestrenewal ? $now : $soonestrenewal;
2732 return $soonestrenewal;
2737 =head2 GetIssuingCharges
2739 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2741 Calculate how much it would cost for a given patron to borrow a given
2742 item, including any applicable discounts.
2744 C<$itemnumber> is the item number of item the patron wishes to borrow.
2746 C<$borrowernumber> is the patron's borrower number.
2748 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2749 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2754 sub GetIssuingCharges {
2756 # calculate charges due
2757 my ( $itemnumber, $borrowernumber ) = @_;
2759 my $dbh = C4::Context->dbh;
2762 # Get the book's item type and rental charge (via its biblioitem).
2763 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2764 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2765 $charge_query .= (C4::Context->preference('item-level_itypes'))
2766 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2767 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2769 $charge_query .= ' WHERE items.itemnumber =?';
2771 my $sth = $dbh->prepare($charge_query);
2772 $sth->execute($itemnumber);
2773 if ( my $item_data = $sth->fetchrow_hashref ) {
2774 $item_type = $item_data->{itemtype};
2775 $charge = $item_data->{rentalcharge};
2776 my $branch = C4::Branch::mybranch();
2777 my $discount_query = q|SELECT rentaldiscount,
2778 issuingrules.itemtype, issuingrules.branchcode
2780 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2781 WHERE borrowers.borrowernumber = ?
2782 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2783 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2784 my $discount_sth = $dbh->prepare($discount_query);
2785 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2786 my $discount_rules = $discount_sth->fetchall_arrayref({});
2787 if (@{$discount_rules}) {
2788 # We may have multiple rules so get the most specific
2789 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2790 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2794 return ( $charge, $item_type );
2797 # Select most appropriate discount rule from those returned
2798 sub _get_discount_from_rule {
2799 my ($rules_ref, $branch, $itemtype) = @_;
2802 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2803 $discount = $rules_ref->[0]->{rentaldiscount};
2804 return (defined $discount) ? $discount : 0;
2806 # could have up to 4 does one match $branch and $itemtype
2807 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2809 $discount = $d[0]->{rentaldiscount};
2810 return (defined $discount) ? $discount : 0;
2812 # do we have item type + all branches
2813 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2815 $discount = $d[0]->{rentaldiscount};
2816 return (defined $discount) ? $discount : 0;
2818 # do we all item types + this branch
2819 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2821 $discount = $d[0]->{rentaldiscount};
2822 return (defined $discount) ? $discount : 0;
2824 # so all and all (surely we wont get here)
2825 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2827 $discount = $d[0]->{rentaldiscount};
2828 return (defined $discount) ? $discount : 0;
2834 =head2 AddIssuingCharge
2836 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2840 sub AddIssuingCharge {
2841 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2842 my $dbh = C4::Context->dbh;
2843 my $nextaccntno = getnextacctno( $borrowernumber );
2845 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2847 INSERT INTO accountlines
2848 (borrowernumber, itemnumber, accountno,
2849 date, amount, description, accounttype,
2850 amountoutstanding, manager_id)
2851 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2853 my $sth = $dbh->prepare($query);
2854 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2859 GetTransfers($itemnumber);
2864 my ($itemnumber) = @_;
2866 my $dbh = C4::Context->dbh;
2872 FROM branchtransfers
2873 WHERE itemnumber = ?
2874 AND datearrived IS NULL
2876 my $sth = $dbh->prepare($query);
2877 $sth->execute($itemnumber);
2878 my @row = $sth->fetchrow_array();
2882 =head2 GetTransfersFromTo
2884 @results = GetTransfersFromTo($frombranch,$tobranch);
2886 Returns the list of pending transfers between $from and $to branch
2890 sub GetTransfersFromTo {
2891 my ( $frombranch, $tobranch ) = @_;
2892 return unless ( $frombranch && $tobranch );
2893 my $dbh = C4::Context->dbh;
2895 SELECT itemnumber,datesent,frombranch
2896 FROM branchtransfers
2899 AND datearrived IS NULL
2901 my $sth = $dbh->prepare($query);
2902 $sth->execute( $frombranch, $tobranch );
2905 while ( my $data = $sth->fetchrow_hashref ) {
2906 push @gettransfers, $data;
2908 return (@gettransfers);
2911 =head2 DeleteTransfer
2913 &DeleteTransfer($itemnumber);
2917 sub DeleteTransfer {
2918 my ($itemnumber) = @_;
2919 return unless $itemnumber;
2920 my $dbh = C4::Context->dbh;
2921 my $sth = $dbh->prepare(
2922 "DELETE FROM branchtransfers
2924 AND datearrived IS NULL "
2926 return $sth->execute($itemnumber);
2929 =head2 AnonymiseIssueHistory
2931 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
2933 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2934 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2936 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2937 setting (force delete).
2939 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
2943 sub AnonymiseIssueHistory {
2945 my $borrowernumber = shift;
2946 my $dbh = C4::Context->dbh;
2949 SET borrowernumber = ?
2950 WHERE returndate < ?
2951 AND borrowernumber IS NOT NULL
2954 # The default of 0 does not work due to foreign key constraints
2955 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2956 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2957 my @bind_params = ($anonymouspatron, $date);
2958 if (defined $borrowernumber) {
2959 $query .= " AND borrowernumber = ?";
2960 push @bind_params, $borrowernumber;
2962 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2964 my $sth = $dbh->prepare($query);
2965 $sth->execute(@bind_params);
2966 my $anonymisation_err = $dbh->err;
2967 my $rows_affected = $sth->rows; ### doublecheck row count return function
2968 return ($rows_affected, $anonymisation_err);
2971 =head2 SendCirculationAlert
2973 Send out a C<check-in> or C<checkout> alert using the messaging system.
2981 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2985 Hashref of information about the item being checked in or out.
2989 Hashref of information about the borrower of the item.
2993 The branchcode from where the checkout or check-in took place.
2999 SendCirculationAlert({
3002 borrower => $borrower,
3008 sub SendCirculationAlert {
3010 my ($type, $item, $borrower, $branch) =
3011 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3012 my %message_name = (
3013 CHECKIN => 'Item_Check_in',
3014 CHECKOUT => 'Item_Checkout',
3015 RENEWAL => 'Item_Checkout',
3017 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3018 borrowernumber => $borrower->{borrowernumber},
3019 message_name => $message_name{$type},
3021 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3022 my $letter = C4::Letters::GetPreparedLetter (
3023 module => 'circulation',
3024 letter_code => $type,
3025 branchcode => $branch,
3027 $issues_table => $item->{itemnumber},
3028 'items' => $item->{itemnumber},
3029 'biblio' => $item->{biblionumber},
3030 'biblioitems' => $item->{biblionumber},
3031 'borrowers' => $borrower,
3032 'branches' => $branch,
3036 my @transports = keys %{ $borrower_preferences->{transports} };
3037 # warn "no transports" unless @transports;
3039 # warn "transport: $_";
3040 my $message = C4::Message->find_last_message($borrower, $type, $_);
3042 #warn "create new message";
3043 C4::Message->enqueue($letter, $borrower, $_);
3045 #warn "append to old message";
3046 $message->append($letter);
3054 =head2 updateWrongTransfer
3056 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3058 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
3062 sub updateWrongTransfer {
3063 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3064 my $dbh = C4::Context->dbh;
3065 # first step validate the actual line of transfert .
3068 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3070 $sth->execute($FromLibrary,$itemNumber);
3072 # second step create a new line of branchtransfer to the right location .
3073 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3075 #third step changing holdingbranch of item
3076 UpdateHoldingbranch($FromLibrary,$itemNumber);
3079 =head2 UpdateHoldingbranch
3081 $items = UpdateHoldingbranch($branch,$itmenumber);
3083 Simple methode for updating hodlingbranch in items BDD line
3087 sub UpdateHoldingbranch {
3088 my ( $branch,$itemnumber ) = @_;
3089 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3094 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3096 this function calculates the due date given the start date and configured circulation rules,
3097 checking against the holidays calendar as per the 'useDaysMode' syspref.
3098 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
3099 C<$itemtype> = itemtype code of item in question
3100 C<$branch> = location whose calendar to use
3101 C<$borrower> = Borrower object
3102 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3107 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3111 # loanlength now a href
3113 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3115 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3121 if (ref $startdate ne 'DateTime' ) {
3122 $datedue = dt_from_string($datedue);
3124 $datedue = $startdate->clone;
3128 DateTime->now( time_zone => C4::Context->tz() )
3129 ->truncate( to => 'minute' );
3133 # calculate the datedue as normal
3134 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3135 { # ignoring calendar
3136 if ( $loanlength->{lengthunit} eq 'hours' ) {
3137 $datedue->add( hours => $loanlength->{$length_key} );
3139 $datedue->add( days => $loanlength->{$length_key} );
3140 $datedue->set_hour(23);
3141 $datedue->set_minute(59);
3145 if ($loanlength->{lengthunit} eq 'hours') {
3146 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3149 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3151 my $calendar = Koha::Calendar->new( branchcode => $branch );
3152 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3153 if ($loanlength->{lengthunit} eq 'days') {
3154 $datedue->set_hour(23);
3155 $datedue->set_minute(59);
3159 # if Hard Due Dates are used, retreive them and apply as necessary
3160 my ( $hardduedate, $hardduedatecompare ) =
3161 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3162 if ($hardduedate) { # hardduedates are currently dates
3163 $hardduedate->truncate( to => 'minute' );
3164 $hardduedate->set_hour(23);
3165 $hardduedate->set_minute(59);
3166 my $cmp = DateTime->compare( $hardduedate, $datedue );
3168 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3169 # if the calculated date is before the 'after' Hard Due Date (floor), override
3170 # if the hard due date is set to 'exactly', overrride
3171 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3172 $datedue = $hardduedate->clone;
3175 # in all other cases, keep the date due as it is
3179 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3180 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3181 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
3182 $expiry_dt->set( hour => 23, minute => 59);
3183 if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
3184 $datedue = $expiry_dt->clone;
3192 =head2 CheckRepeatableHolidays
3194 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3196 This function checks if the date due is a repeatable holiday
3198 C<$date_due> = returndate calculate with no day check
3199 C<$itemnumber> = itemnumber
3200 C<$branchcode> = localisation of issue
3204 sub CheckRepeatableHolidays{
3205 my($itemnumber,$week_day,$branchcode)=@_;
3206 my $dbh = C4::Context->dbh;
3207 my $query = qq|SELECT count(*)
3208 FROM repeatable_holidays
3211 my $sth = $dbh->prepare($query);
3212 $sth->execute($branchcode,$week_day);
3213 my $result=$sth->fetchrow;
3218 =head2 CheckSpecialHolidays
3220 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3222 This function check if the date is a special holiday
3224 C<$years> = the years of datedue
3225 C<$month> = the month of datedue
3226 C<$day> = the day of datedue
3227 C<$itemnumber> = itemnumber
3228 C<$branchcode> = localisation of issue
3232 sub CheckSpecialHolidays{
3233 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3234 my $dbh = C4::Context->dbh;
3235 my $query=qq|SELECT count(*)
3236 FROM `special_holidays`
3242 my $sth = $dbh->prepare($query);
3243 $sth->execute($years,$month,$day,$branchcode);
3244 my $countspecial=$sth->fetchrow ;
3245 return $countspecial;
3248 =head2 CheckRepeatableSpecialHolidays
3250 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3252 This function check if the date is a repeatble special holidays
3254 C<$month> = the month of datedue
3255 C<$day> = the day of datedue
3256 C<$itemnumber> = itemnumber
3257 C<$branchcode> = localisation of issue
3261 sub CheckRepeatableSpecialHolidays{
3262 my ($month,$day,$itemnumber,$branchcode) = @_;
3263 my $dbh = C4::Context->dbh;
3264 my $query=qq|SELECT count(*)
3265 FROM `repeatable_holidays`
3270 my $sth = $dbh->prepare($query);
3271 $sth->execute($month,$day,$branchcode);
3272 my $countspecial=$sth->fetchrow ;
3273 return $countspecial;
3278 sub CheckValidBarcode{
3280 my $dbh = C4::Context->dbh;
3281 my $query=qq|SELECT count(*)
3285 my $sth = $dbh->prepare($query);
3286 $sth->execute($barcode);
3287 my $exist=$sth->fetchrow ;
3291 =head2 IsBranchTransferAllowed
3293 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3295 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3299 sub IsBranchTransferAllowed {
3300 my ( $toBranch, $fromBranch, $code ) = @_;
3302 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3304 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3305 my $dbh = C4::Context->dbh;
3307 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3308 $sth->execute( $toBranch, $fromBranch, $code );
3309 my $limit = $sth->fetchrow_hashref();
3311 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3312 if ( $limit->{'limitId'} ) {
3319 =head2 CreateBranchTransferLimit
3321 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3323 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3327 sub CreateBranchTransferLimit {
3328 my ( $toBranch, $fromBranch, $code ) = @_;
3329 return unless defined($toBranch) && defined($fromBranch);
3330 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3332 my $dbh = C4::Context->dbh;
3334 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3335 return $sth->execute( $code, $toBranch, $fromBranch );
3338 =head2 DeleteBranchTransferLimits
3340 my $result = DeleteBranchTransferLimits($frombranch);
3342 Deletes all the library transfer limits for one library. Returns the
3343 number of limits deleted, 0e0 if no limits were deleted, or undef if
3344 no arguments are supplied.
3348 sub DeleteBranchTransferLimits {
3350 return unless defined $branch;
3351 my $dbh = C4::Context->dbh;
3352 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3353 return $sth->execute($branch);
3357 my ( $borrowernumber, $itemnum ) = @_;
3359 MarkIssueReturned( $borrowernumber, $itemnum );
3360 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3361 my $item = C4::Items::GetItem( $itemnum );
3362 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3363 my @datearr = localtime(time);
3364 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3365 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3366 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3371 my ($itemnumber, $mark_returned) = @_;
3373 my $dbh = C4::Context->dbh();
3374 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3376 JOIN items USING (itemnumber)
3377 JOIN biblio USING (biblionumber)
3378 WHERE issues.itemnumber=?");
3379 $sth->execute($itemnumber);
3380 my $issues=$sth->fetchrow_hashref();
3382 # If a borrower lost the item, add a replacement cost to the their record
3383 if ( my $borrowernumber = $issues->{borrowernumber} ){
3384 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3386 if (C4::Context->preference('WhenLostForgiveFine')){
3387 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3388 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3390 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3391 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3392 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3393 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3396 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3400 sub GetOfflineOperations {
3401 my $dbh = C4::Context->dbh;
3402 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3403 $sth->execute(C4::Context->userenv->{'branch'});
3404 my $results = $sth->fetchall_arrayref({});
3408 sub GetOfflineOperation {
3409 my $operationid = shift;
3410 return unless $operationid;
3411 my $dbh = C4::Context->dbh;
3412 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3413 $sth->execute( $operationid );
3414 return $sth->fetchrow_hashref;
3417 sub AddOfflineOperation {
3418 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3419 my $dbh = C4::Context->dbh;
3420 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3421 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3425 sub DeleteOfflineOperation {
3426 my $dbh = C4::Context->dbh;
3427 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3428 $sth->execute( shift );
3432 sub ProcessOfflineOperation {
3433 my $operation = shift;
3436 if ( $operation->{action} eq 'return' ) {
3437 $report = ProcessOfflineReturn( $operation );
3438 } elsif ( $operation->{action} eq 'issue' ) {
3439 $report = ProcessOfflineIssue( $operation );
3440 } elsif ( $operation->{action} eq 'payment' ) {
3441 $report = ProcessOfflinePayment( $operation );
3444 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3449 sub ProcessOfflineReturn {
3450 my $operation = shift;
3452 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3454 if ( $itemnumber ) {
3455 my $issue = GetOpenIssue( $itemnumber );
3458 $issue->{borrowernumber},
3461 $operation->{timestamp},
3464 { renewals => 0, onloan => undef },
3465 $issue->{'biblionumber'},
3470 return "Item not issued.";
3473 return "Item not found.";
3477 sub ProcessOfflineIssue {
3478 my $operation = shift;
3480 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3482 if ( $borrower->{borrowernumber} ) {
3483 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3484 unless ($itemnumber) {
3485 return "Barcode not found.";
3487 my $issue = GetOpenIssue( $itemnumber );
3489 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3491 $issue->{borrowernumber},
3494 $operation->{timestamp},
3499 $operation->{'barcode'},
3502 $operation->{timestamp},
3507 return "Borrower not found.";
3511 sub ProcessOfflinePayment {
3512 my $operation = shift;
3514 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3515 my $amount = $operation->{amount};
3517 recordpayment( $borrower->{borrowernumber}, $amount );
3525 TransferSlip($user_branch, $itemnumber, $to_branch)
3527 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3532 my ($branch, $itemnumber, $to_branch) = @_;
3534 my $item = GetItem( $itemnumber )
3537 my $pulldate = C4::Dates->new();
3539 return C4::Letters::GetPreparedLetter (
3540 module => 'circulation',
3541 letter_code => 'TRANSFERSLIP',
3542 branchcode => $branch,
3544 'branches' => $to_branch,
3545 'biblio' => $item->{biblionumber},
3551 =head2 CheckIfIssuedToPatron
3553 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3555 Return 1 if any record item is issued to patron, otherwise return 0
3559 sub CheckIfIssuedToPatron {
3560 my ($borrowernumber, $biblionumber) = @_;
3562 my $items = GetItemsByBiblioitemnumber($biblionumber);
3564 foreach my $item (@{$items}) {
3565 return 1 if ($item->{borrowernumber} && $item->{borrowernumber} eq $borrowernumber);
3573 IsItemIssued( $itemnumber )
3575 Return 1 if the item is on loan, otherwise return 0
3580 my $itemnumber = shift;
3581 my $dbh = C4::Context->dbh;
3582 my $sth = $dbh->prepare(q{
3585 WHERE itemnumber = ?
3587 $sth->execute($itemnumber);
3588 return $sth->fetchrow;
3597 Koha Development Team <http://koha-community.org/>