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
86 &GetBranchBorrowerCircRule
90 &AnonymiseIssueHistory
91 &CheckIfIssuedToPatron
95 # subs to deal with returns
101 # subs to deal with transfers
108 &IsBranchTransferAllowed
109 &CreateBranchTransferLimit
110 &DeleteBranchTransferLimits
114 # subs to deal with offline circulation
116 &GetOfflineOperations
119 &DeleteOfflineOperation
120 &ProcessOfflineOperation
126 C4::Circulation - Koha circulation module
134 The functions in this module deal with circulation, issues, and
135 returns, as well as general information about the library.
136 Also deals with stocktaking.
142 $str = &barcodedecode($barcode, [$filter]);
144 Generic filter function for barcode string.
145 Called on every circ if the System Pref itemBarcodeInputFilter is set.
146 Will do some manipulation of the barcode for systems that deliver a barcode
147 to circulation.pl that differs from the barcode stored for the item.
148 For proper functioning of this filter, calling the function on the
149 correct barcode string (items.barcode) should return an unaltered barcode.
151 The optional $filter argument is to allow for testing or explicit
152 behavior that ignores the System Pref. Valid values are the same as the
157 # FIXME -- the &decode fcn below should be wrapped into this one.
158 # FIXME -- these plugins should be moved out of Circulation.pm
161 my ($barcode, $filter) = @_;
162 my $branch = C4
::Branch
::mybranch
();
163 $filter = C4
::Context
->preference('itemBarcodeInputFilter') unless $filter;
164 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
165 if ($filter eq 'whitespace') {
167 } elsif ($filter eq 'cuecat') {
169 my @fields = split( /\./, $barcode );
170 my @results = map( decode
($_), @fields[ 1 .. $#fields ] );
171 ($#results == 2) and return $results[2];
172 } elsif ($filter eq 'T-prefix') {
173 if ($barcode =~ /^[Tt](\d)/) {
174 (defined($1) and $1 eq '0') and return $barcode;
175 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
177 return sprintf("T%07d", $barcode);
178 # FIXME: $barcode could be "T1", causing warning: substr outside of string
179 # Why drop the nonzero digit after the T?
180 # Why pass non-digits (or empty string) to "T%07d"?
181 } elsif ($filter eq 'libsuite8') {
182 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
183 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
184 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
186 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
189 } elsif ($filter eq 'EAN13') {
190 my $ean = CheckDigits
('ean');
191 if ( $ean->is_valid($barcode) ) {
192 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
193 $barcode = '0' x
( 13 - length($barcode) ) . $barcode;
195 warn "# [$barcode] not valid EAN-13/UPC-A\n";
198 return $barcode; # return barcode, modified or not
203 $str = &decode($chunk);
205 Decodes a segment of a string emitted by a CueCat barcode scanner and
208 FIXME: Should be replaced with Barcode::Cuecat from CPAN
209 or Javascript based decoding on the client side.
216 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
217 my @s = map { index( $seq, $_ ); } split( //, $encoded );
218 my $l = ( $#s + 1 ) % 4;
221 # warn "Error: Cuecat decode parsing failed!";
229 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
231 chr( ( $n >> 16 ) ^ 67 )
232 .chr( ( $n >> 8 & 255 ) ^ 67 )
233 .chr( ( $n & 255 ) ^ 67 );
236 $r = substr( $r, 0, length($r) - $l );
242 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
243 $barcode, $ignore_reserves);
245 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
247 C<$newbranch> is the code for the branch to which the item should be transferred.
249 C<$barcode> is the barcode of the item to be transferred.
251 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
252 Otherwise, if an item is reserved, the transfer fails.
254 Returns three values:
260 is true if the transfer was successful.
264 is a reference-to-hash which may have any of the following keys:
270 There is no item in the catalog with the given barcode. The value is C<$barcode>.
274 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.
276 =item C<DestinationEqualsHolding>
278 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.
282 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.
286 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>.
288 =item C<WasTransferred>
290 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
299 my ( $tbr, $barcode, $ignoreRs ) = @_;
302 my $branches = GetBranches
();
303 my $itemnumber = GetItemnumberFromBarcode
( $barcode );
304 my $issue = GetItemIssue
($itemnumber);
305 my $biblio = GetBiblioFromItemNumber
($itemnumber);
308 if ( not $itemnumber ) {
309 $messages->{'BadBarcode'} = $barcode;
313 # get branches of book...
314 my $hbr = $biblio->{'homebranch'};
315 my $fbr = $biblio->{'holdingbranch'};
317 # if using Branch Transfer Limits
318 if ( C4
::Context
->preference("UseBranchTransferLimits") == 1 ) {
319 if ( C4
::Context
->preference("item-level_itypes") && C4
::Context
->preference("BranchTransferLimitsType") eq 'itemtype' ) {
320 if ( ! IsBranchTransferAllowed
( $tbr, $fbr, $biblio->{'itype'} ) ) {
321 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
324 } elsif ( ! IsBranchTransferAllowed
( $tbr, $fbr, $biblio->{ C4
::Context
->preference("BranchTransferLimitsType") } ) ) {
325 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4
::Context
->preference("BranchTransferLimitsType") };
331 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
332 $messages->{'IsPermanent'} = $hbr;
336 # can't transfer book if is already there....
337 if ( $fbr eq $tbr ) {
338 $messages->{'DestinationEqualsHolding'} = 1;
342 # check if it is still issued to someone, return it...
343 if ($issue->{borrowernumber
}) {
344 AddReturn
( $barcode, $fbr );
345 $messages->{'WasReturned'} = $issue->{borrowernumber
};
349 # That'll save a database query.
350 my ( $resfound, $resrec, undef ) =
351 CheckReserves
( $itemnumber );
352 if ( $resfound and not $ignoreRs ) {
353 $resrec->{'ResFound'} = $resfound;
355 # $messages->{'ResFound'} = $resrec;
359 #actually do the transfer....
361 ModItemTransfer
( $itemnumber, $fbr, $tbr );
363 # don't need to update MARC anymore, we do it in batch now
364 $messages->{'WasTransfered'} = 1;
367 ModDateLastSeen
( $itemnumber );
368 return ( $dotransfer, $messages, $biblio );
373 my $borrower = shift;
374 my $biblionumber = shift;
376 my $cat_borrower = $borrower->{'categorycode'};
377 my $dbh = C4
::Context
->dbh;
379 # Get which branchcode we need
380 $branch = _GetCircControlBranch
($item,$borrower);
381 my $type = (C4
::Context
->preference('item-level_itypes'))
382 ?
$item->{'itype'} # item-level
383 : $item->{'itemtype'}; # biblio-level
385 # given branch, patron category, and item type, determine
386 # applicable issuing rule
387 my $issuing_rule = GetIssuingRule
($cat_borrower, $type, $branch);
389 # if a rule is found and has a loan limit set, count
390 # how many loans the patron already has that meet that
392 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
394 my $count_query = "SELECT COUNT(*) FROM issues
395 JOIN items USING (itemnumber) ";
397 my $rule_itemtype = $issuing_rule->{itemtype
};
398 if ($rule_itemtype eq "*") {
399 # matching rule has the default item type, so count only
400 # those existing loans that don't fall under a more
402 if (C4
::Context
->preference('item-level_itypes')) {
403 $count_query .= " WHERE items.itype NOT IN (
404 SELECT itemtype FROM issuingrules
406 AND (categorycode = ? OR categorycode = ?)
410 $count_query .= " JOIN biblioitems USING (biblionumber)
411 WHERE biblioitems.itemtype NOT IN (
412 SELECT itemtype FROM issuingrules
414 AND (categorycode = ? OR categorycode = ?)
418 push @bind_params, $issuing_rule->{branchcode
};
419 push @bind_params, $issuing_rule->{categorycode
};
420 push @bind_params, $cat_borrower;
422 # rule has specific item type, so count loans of that
424 if (C4
::Context
->preference('item-level_itypes')) {
425 $count_query .= " WHERE items.itype = ? ";
427 $count_query .= " JOIN biblioitems USING (biblionumber)
428 WHERE biblioitems.itemtype= ? ";
430 push @bind_params, $type;
433 $count_query .= " AND borrowernumber = ? ";
434 push @bind_params, $borrower->{'borrowernumber'};
435 my $rule_branch = $issuing_rule->{branchcode
};
436 if ($rule_branch ne "*") {
437 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
438 $count_query .= " AND issues.branchcode = ? ";
439 push @bind_params, $branch;
440 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
441 ; # if branch is the patron's home branch, then count all loans by patron
443 $count_query .= " AND items.homebranch = ? ";
444 push @bind_params, $branch;
448 my $count_sth = $dbh->prepare($count_query);
449 $count_sth->execute(@bind_params);
450 my ($current_loan_count) = $count_sth->fetchrow_array;
452 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
453 if ($current_loan_count >= $max_loans_allowed) {
454 return ($current_loan_count, $max_loans_allowed);
458 # Now count total loans against the limit for the branch
459 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule
($branch, $cat_borrower);
460 if (defined($branch_borrower_circ_rule->{maxissueqty
})) {
461 my @bind_params = ();
462 my $branch_count_query = "SELECT COUNT(*) FROM issues
463 JOIN items USING (itemnumber)
464 WHERE borrowernumber = ? ";
465 push @bind_params, $borrower->{borrowernumber
};
467 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
468 $branch_count_query .= " AND issues.branchcode = ? ";
469 push @bind_params, $branch;
470 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
471 ; # if branch is the patron's home branch, then count all loans by patron
473 $branch_count_query .= " AND items.homebranch = ? ";
474 push @bind_params, $branch;
476 my $branch_count_sth = $dbh->prepare($branch_count_query);
477 $branch_count_sth->execute(@bind_params);
478 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
480 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty
};
481 if ($current_loan_count >= $max_loans_allowed) {
482 return ($current_loan_count, $max_loans_allowed);
486 # OK, the patron can issue !!!
492 @issues = &itemissues($biblioitemnumber, $biblio);
494 Looks up information about who has borrowed the bookZ<>(s) with the
495 given biblioitemnumber.
497 C<$biblio> is ignored.
499 C<&itemissues> returns an array of references-to-hash. The keys
500 include the fields from the C<items> table in the Koha database.
501 Additional keys include:
507 If the item is currently on loan, this gives the due date.
509 If the item is not on loan, then this is either "Available" or
510 "Cancelled", if the item has been withdrawn.
514 If the item is currently on loan, this gives the card number of the
515 patron who currently has the item.
517 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
519 These give the timestamp for the last three times the item was
522 =item C<card0>, C<card1>, C<card2>
524 The card number of the last three patrons who borrowed this item.
526 =item C<borrower0>, C<borrower1>, C<borrower2>
528 The borrower number of the last three patrons who borrowed this item.
536 my ( $bibitem, $biblio ) = @_;
537 my $dbh = C4
::Context
->dbh;
539 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
544 $sth->execute($bibitem) || die $sth->errstr;
546 while ( my $data = $sth->fetchrow_hashref ) {
548 # Find out who currently has this item.
549 # FIXME - Wouldn't it be better to do this as a left join of
550 # some sort? Currently, this code assumes that if
551 # fetchrow_hashref() fails, then the book is on the shelf.
552 # fetchrow_hashref() can fail for any number of reasons (e.g.,
553 # database server crash), not just because no items match the
555 my $sth2 = $dbh->prepare(
556 "SELECT * FROM issues
557 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
562 $sth2->execute( $data->{'itemnumber'} );
563 if ( my $data2 = $sth2->fetchrow_hashref ) {
564 $data->{'date_due'} = $data2->{'date_due'};
565 $data->{'card'} = $data2->{'cardnumber'};
566 $data->{'borrower'} = $data2->{'borrowernumber'};
569 $data->{'date_due'} = ($data->{'withdrawn'} eq '1') ?
'Cancelled' : 'Available';
573 # Find the last 3 people who borrowed this item.
574 $sth2 = $dbh->prepare(
575 "SELECT * FROM old_issues
576 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
578 ORDER BY returndate DESC,timestamp DESC"
581 $sth2->execute( $data->{'itemnumber'} );
582 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
583 { # FIXME : error if there is less than 3 pple borrowing this item
584 if ( my $data2 = $sth2->fetchrow_hashref ) {
585 $data->{"timestamp$i2"} = $data2->{'timestamp'};
586 $data->{"card$i2"} = $data2->{'cardnumber'};
587 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
591 $results[$i] = $data;
598 =head2 CanBookBeIssued
600 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
601 $barcode, $duedatespec, $inprocess, $ignore_reserves );
603 Check if a book can be issued.
605 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
609 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
611 =item C<$barcode> is the bar code of the book being issued.
613 =item C<$duedatespec> is a C4::Dates object.
615 =item C<$inprocess> boolean switch
616 =item C<$ignore_reserves> boolean switch
624 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
625 Possible values are :
631 sticky due date is invalid
635 borrower gone with no address
639 borrower declared it's card lost
645 =head3 UNKNOWN_BARCODE
659 item is restricted (set by ??)
661 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
662 could be prevented, but ones that can be overriden by the operator.
664 Possible values are :
672 renewing, not issuing
674 =head3 ISSUED_TO_ANOTHER
676 issued to someone else.
680 reserved for someone else.
684 sticky due date is invalid or due date in the past
688 if the borrower borrows to much things
692 sub CanBookBeIssued
{
693 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves ) = @_;
694 my %needsconfirmation; # filled with problems that needs confirmations
695 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
696 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
698 my $item = GetItem
(GetItemnumberFromBarcode
( $barcode ));
699 my $issue = GetItemIssue
($item->{itemnumber
});
700 my $biblioitem = GetBiblioItemData
($item->{biblioitemnumber
});
701 $item->{'itemtype'}=$item->{'itype'};
702 my $dbh = C4
::Context
->dbh;
704 # MANDATORY CHECKS - unless item exists, nothing else matters
705 unless ( $item->{barcode
} ) {
706 $issuingimpossible{UNKNOWN_BARCODE
} = 1;
708 return ( \
%issuingimpossible, \
%needsconfirmation ) if %issuingimpossible;
711 # DUE DATE is OK ? -- should already have checked.
713 if ($duedate && ref $duedate ne 'DateTime') {
714 $duedate = dt_from_string
($duedate);
716 my $now = DateTime
->now( time_zone
=> C4
::Context
->tz() );
717 unless ( $duedate ) {
718 my $issuedate = $now->clone();
720 my $branch = _GetCircControlBranch
($item,$borrower);
721 my $itype = ( C4
::Context
->preference('item-level_itypes') ) ?
$item->{'itype'} : $biblioitem->{'itemtype'};
722 $duedate = CalcDateDue
( $issuedate, $itype, $branch, $borrower );
724 # Offline circ calls AddIssue directly, doesn't run through here
725 # So issuingimpossible should be ok.
728 my $today = $now->clone();
729 $today->truncate( to
=> 'minute');
730 if (DateTime
->compare($duedate,$today) == -1 ) { # duedate cannot be before now
731 $needsconfirmation{INVALID_DATE
} = output_pref
($duedate);
734 $issuingimpossible{INVALID_DATE
} = output_pref
($duedate);
740 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode
} )) {
741 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
742 &UpdateStats
(C4
::Context
->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'}, undef, $item->{'ccode'});
743 ModDateLastSeen
( $item->{'itemnumber'} );
744 return( { STATS
=> 1 }, {});
746 if ( $borrower->{flags
}->{GNA
} ) {
747 $issuingimpossible{GNA
} = 1;
749 if ( $borrower->{flags
}->{'LOST'} ) {
750 $issuingimpossible{CARD_LOST
} = 1;
752 if ( $borrower->{flags
}->{'DBARRED'} ) {
753 $issuingimpossible{DEBARRED
} = 1;
755 if ( !defined $borrower->{dateexpiry
} || $borrower->{'dateexpiry'} eq '0000-00-00') {
756 $issuingimpossible{EXPIRED
} = 1;
758 my ($y, $m, $d) = split /-/,$borrower->{'dateexpiry'};
759 if ($y && $m && $d) { # are we really writing oinvalid dates to borrs
760 my $expiry_dt = DateTime
->new(
764 time_zone
=> C4
::Context
->tz,
766 $expiry_dt->truncate( to
=> 'day');
767 my $today = $now->clone()->truncate(to
=> 'day');
768 if (DateTime
->compare($today, $expiry_dt) == 1) {
769 $issuingimpossible{EXPIRED
} = 1;
772 carp
("Invalid expity date in borr");
773 $issuingimpossible{EXPIRED
} = 1;
781 my ($balance, $non_issue_charges, $other_charges) =
782 C4
::Members
::GetMemberAccountBalance
( $borrower->{'borrowernumber'} );
783 my $amountlimit = C4
::Context
->preference("noissuescharge");
784 my $allowfineoverride = C4
::Context
->preference("AllowFineOverride");
785 my $allfinesneedoverride = C4
::Context
->preference("AllFinesNeedOverride");
786 if ( C4
::Context
->preference("IssuingInProcess") ) {
787 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
788 $issuingimpossible{DEBT
} = sprintf( "%.2f", $non_issue_charges );
789 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
790 $needsconfirmation{DEBT
} = sprintf( "%.2f", $non_issue_charges );
791 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
792 $needsconfirmation{DEBT
} = sprintf( "%.2f", $non_issue_charges );
796 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
797 $needsconfirmation{DEBT
} = sprintf( "%.2f", $non_issue_charges );
798 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
799 $issuingimpossible{DEBT
} = sprintf( "%.2f", $non_issue_charges );
800 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
801 $needsconfirmation{DEBT
} = sprintf( "%.2f", $non_issue_charges );
804 if ($balance > 0 && $other_charges > 0) {
805 $alerts{OTHER_CHARGES
} = sprintf( "%.2f", $other_charges );
808 my ($blocktype, $count) = C4
::Members
::IsMemberBlocked
($borrower->{'borrowernumber'});
809 if ($blocktype == -1) {
810 ## patron has outstanding overdue loans
811 if ( C4
::Context
->preference("OverduesBlockCirc") eq 'block'){
812 $issuingimpossible{USERBLOCKEDOVERDUE
} = $count;
814 elsif ( C4
::Context
->preference("OverduesBlockCirc") eq 'confirmation'){
815 $needsconfirmation{USERBLOCKEDOVERDUE
} = $count;
817 } elsif($blocktype == 1) {
818 # patron has accrued fine days
819 $issuingimpossible{USERBLOCKEDREMAINING
} = $count;
823 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
825 my ($current_loan_count, $max_loans_allowed) = TooMany
( $borrower, $item->{biblionumber
}, $item );
826 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
827 if (defined $max_loans_allowed && $max_loans_allowed == 0) {
828 $needsconfirmation{PATRON_CANT
} = 1;
830 if($max_loans_allowed){
831 if ( C4
::Context
->preference("AllowTooManyOverride") ) {
832 $needsconfirmation{TOO_MANY
} = 1;
833 $needsconfirmation{current_loan_count
} = $current_loan_count;
834 $needsconfirmation{max_loans_allowed
} = $max_loans_allowed;
836 $issuingimpossible{TOO_MANY
} = 1;
837 $issuingimpossible{current_loan_count
} = $current_loan_count;
838 $issuingimpossible{max_loans_allowed
} = $max_loans_allowed;
846 if ( $item->{'notforloan'} )
848 if(!C4
::Context
->preference("AllowNotForLoanOverride")){
849 $issuingimpossible{NOT_FOR_LOAN
} = 1;
850 $issuingimpossible{item_notforloan
} = $item->{'notforloan'};
852 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
853 $needsconfirmation{item_notforloan
} = $item->{'notforloan'};
857 # we have to check itemtypes.notforloan also
858 if (C4
::Context
->preference('item-level_itypes')){
859 # this should probably be a subroutine
860 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
861 $sth->execute($item->{'itemtype'});
862 my $notforloan=$sth->fetchrow_hashref();
863 if ($notforloan->{'notforloan'}) {
864 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
865 $issuingimpossible{NOT_FOR_LOAN
} = 1;
866 $issuingimpossible{itemtype_notforloan
} = $item->{'itype'};
868 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
869 $needsconfirmation{itemtype_notforloan
} = $item->{'itype'};
873 elsif ($biblioitem->{'notforloan'} == 1){
874 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
875 $issuingimpossible{NOT_FOR_LOAN
} = 1;
876 $issuingimpossible{itemtype_notforloan
} = $biblioitem->{'itemtype'};
878 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
879 $needsconfirmation{itemtype_notforloan
} = $biblioitem->{'itemtype'};
883 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
885 $issuingimpossible{WTHDRAWN
} = 1;
887 if ( $item->{'restricted'}
888 && $item->{'restricted'} == 1 )
890 $issuingimpossible{RESTRICTED
} = 1;
892 if ( $item->{'itemlost'} && C4
::Context
->preference("IssueLostItem") ne 'nothing' ) {
893 my $code = GetAuthorisedValueByCode
( 'LOST', $item->{'itemlost'} );
894 $needsconfirmation{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'confirm' );
895 $alerts{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'alert' );
897 if ( C4
::Context
->preference("IndependentBranches") ) {
898 my $userenv = C4
::Context
->userenv;
899 if ( ($userenv) && ( $userenv->{flags
} % 2 != 1 ) ) {
900 if ( $item->{C4
::Context
->preference("HomeOrHoldingBranch")} ne $userenv->{branch
} ){
901 $issuingimpossible{ITEMNOTSAMEBRANCH
} = 1;
902 $issuingimpossible{'itemhomebranch'} = $item->{C4
::Context
->preference("HomeOrHoldingBranch")};
904 $needsconfirmation{BORRNOTSAMEBRANCH
} = GetBranchName
( $borrower->{'branchcode'} )
905 if ( $borrower->{'branchcode'} ne $userenv->{branch
} );
910 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
912 if ( $issue->{borrowernumber
} && $issue->{borrowernumber
} eq $borrower->{'borrowernumber'} )
915 # Already issued to current borrower. Ask whether the loan should
917 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed
(
918 $borrower->{'borrowernumber'},
919 $item->{'itemnumber'}
921 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
922 $issuingimpossible{NO_MORE_RENEWALS
} = 1;
925 $needsconfirmation{RENEW_ISSUE
} = 1;
928 elsif ($issue->{borrowernumber
}) {
930 # issued to someone else
931 my $currborinfo = C4
::Members
::GetMember
( borrowernumber
=> $issue->{borrowernumber
} );
933 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
934 $needsconfirmation{ISSUED_TO_ANOTHER
} = 1;
935 $needsconfirmation{issued_firstname
} = $currborinfo->{'firstname'};
936 $needsconfirmation{issued_surname
} = $currborinfo->{'surname'};
937 $needsconfirmation{issued_cardnumber
} = $currborinfo->{'cardnumber'};
938 $needsconfirmation{issued_borrowernumber
} = $currborinfo->{'borrowernumber'};
941 unless ( $ignore_reserves ) {
942 # See if the item is on reserve.
943 my ( $restype, $res ) = C4
::Reserves
::CheckReserves
( $item->{'itemnumber'} );
945 my $resbor = $res->{'borrowernumber'};
946 if ( $resbor ne $borrower->{'borrowernumber'} ) {
947 my ( $resborrower ) = C4
::Members
::GetMember
( borrowernumber
=> $resbor );
948 my $branchname = GetBranchName
( $res->{'branchcode'} );
949 if ( $restype eq "Waiting" )
951 # The item is on reserve and waiting, but has been
952 # reserved by some other patron.
953 $needsconfirmation{RESERVE_WAITING
} = 1;
954 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
955 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
956 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
957 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
958 $needsconfirmation{'resbranchname'} = $branchname;
959 $needsconfirmation{'reswaitingdate'} = format_date
($res->{'waitingdate'});
961 elsif ( $restype eq "Reserved" ) {
962 # The item is on reserve for someone else.
963 $needsconfirmation{RESERVED
} = 1;
964 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
965 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
966 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
967 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
968 $needsconfirmation{'resbranchname'} = $branchname;
969 $needsconfirmation{'resreservedate'} = format_date
($res->{'reservedate'});
975 # CHECK AGE RESTRICTION
978 # get $marker from preferences. Could be something like "FSK|PEGI|Alter|Age:"
979 my $markers = C4
::Context
->preference('AgeRestrictionMarker' );
980 my $bibvalues = $biblioitem->{'agerestriction'};
981 if (($markers)&&($bibvalues))
983 # Split $bibvalues to something like FSK 16 or PEGI 6
984 my @values = split ' ', $bibvalues;
986 # Search first occurence of one of the markers
987 my @markers = split /\|/, $markers;
990 for my $value (@values) {
992 for my $marker (@markers) {
993 $marker =~ s/^\s+//; #remove leading spaces
994 $marker =~ s/\s+$//; #remove trailing spaces
995 if (uc($marker) eq uc($value)) {
1004 # Index points to the next value
1005 my $restrictionyear = 0;
1006 if (($take <= $#values) && ($take >= 0)){
1007 $restrictionyear += $values[$take];
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::GetMemberDetails($borrowernumber)
2485 my $branchcode = _GetCircControlBranch($item, $borrower);
2487 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2489 if ( ( $issuingrule->{renewalsallowed} > $itemissue->{renewals} ) || $override_limit ) {
2492 $error = "too_many";
2495 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves( $itemnumber );
2497 if ( $resfound ) { # '' when no hold was found
2499 $error = "on_reserve";
2502 return ( $renewokay, $error );
2507 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2511 C<$borrowernumber> is the borrower number of the patron who currently
2514 C<$itemnumber> is the number of the item to renew.
2516 C<$branch> is the library where the renewal took place (if any).
2517 The library that controls the circ policies for the renewal is retrieved from the issues record.
2519 C<$datedue> can be a C4::Dates object used to set the due date.
2521 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2522 this parameter is not supplied, lastreneweddate is set to the current date.
2524 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2525 from the book's item type.
2530 my $borrowernumber = shift;
2531 my $itemnumber = shift or return;
2533 my $datedue = shift;
2534 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2536 my $item = GetItem($itemnumber) or return;
2537 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2539 my $dbh = C4::Context->dbh;
2541 # Find the issues record for this book
2543 $dbh->prepare("SELECT * FROM issues WHERE itemnumber = ?");
2544 $sth->execute( $itemnumber );
2545 my $issuedata = $sth->fetchrow_hashref;
2547 return unless ( $issuedata );
2549 $borrowernumber ||= $issuedata->{borrowernumber};
2551 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2552 carp 'Invalid date passed to AddRenewal.';
2556 # If the due date wasn't specified, calculate it by adding the
2557 # book's loan length to today's date or the current due date
2558 # based on the value of the RenewalPeriodBase syspref.
2561 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2562 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2564 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2565 dt_from_string( $issuedata->{date_due} ) :
2566 DateTime->now( time_zone => C4::Context->tz());
2567 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2570 # Update the issues record to have the new due date, and a new count
2571 # of how many times it has been renewed.
2572 my $renews = $issuedata->{'renewals'} + 1;
2573 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2574 WHERE borrowernumber=?
2578 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2580 # Update the renewal count on the item, and tell zebra to reindex
2581 $renews = $biblio->{'renewals'} + 1;
2582 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2584 # Charge a new rental fee, if applicable?
2585 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2586 if ( $charge > 0 ) {
2587 my $accountno = getnextacctno( $borrowernumber );
2588 my $item = GetBiblioFromItemNumber($itemnumber);
2590 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2591 $sth = $dbh->prepare(
2592 "INSERT INTO accountlines
2593 (date, borrowernumber, accountno, amount, manager_id,
2594 description,accounttype, amountoutstanding, itemnumber)
2595 VALUES (now(),?,?,?,?,?,?,?,?)"
2597 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2598 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2599 'Rent', $charge, $itemnumber );
2602 # Send a renewal slip according to checkout alert preferencei
2603 if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2604 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2605 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2607 branchcode => $branch,
2608 categorycode => $borrower->{categorycode},
2609 item_type => $item->{itype},
2610 notification => 'CHECKOUT',
2612 if ($circulation_alert->is_enabled_for(\%conditions)) {
2613 SendCirculationAlert({
2616 borrower => $borrower,
2622 # Remove any OVERDUES related debarment if the borrower has no overdues
2623 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2624 if ( $borrowernumber
2625 && $borrower->{'debarred'}
2626 && !HasOverdues( $borrowernumber )
2627 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2629 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2633 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber, undef, $item->{'ccode'});
2638 # check renewal status
2639 my ( $bornum, $itemno ) = @_;
2640 my $dbh = C4::Context->dbh;
2642 my $renewsallowed = 0;
2645 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2646 my $item = GetItem($itemno);
2648 # Look in the issues table for this item, lent to this borrower,
2649 # and not yet returned.
2651 # FIXME - I think this function could be redone to use only one SQL call.
2652 my $sth = $dbh->prepare(
2653 "select * from issues
2654 where (borrowernumber = ?)
2655 and (itemnumber = ?)"
2657 $sth->execute( $bornum, $itemno );
2658 my $data = $sth->fetchrow_hashref;
2659 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2660 # $item and $borrower should be calculated
2661 my $branchcode = _GetCircControlBranch($item, $borrower);
2663 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2665 $renewsallowed = $issuingrule->{'renewalsallowed'};
2666 $renewsleft = $renewsallowed - $renewcount;
2667 if($renewsleft < 0){ $renewsleft = 0; }
2668 return ( $renewcount, $renewsallowed, $renewsleft );
2671 =head2 GetIssuingCharges
2673 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2675 Calculate how much it would cost for a given patron to borrow a given
2676 item, including any applicable discounts.
2678 C<$itemnumber> is the item number of item the patron wishes to borrow.
2680 C<$borrowernumber> is the patron's borrower number.
2682 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2683 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2688 sub GetIssuingCharges {
2690 # calculate charges due
2691 my ( $itemnumber, $borrowernumber ) = @_;
2693 my $dbh = C4::Context->dbh;
2696 # Get the book's item type and rental charge (via its biblioitem).
2697 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2698 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2699 $charge_query .= (C4::Context->preference('item-level_itypes'))
2700 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2701 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2703 $charge_query .= ' WHERE items.itemnumber =?';
2705 my $sth = $dbh->prepare($charge_query);
2706 $sth->execute($itemnumber);
2707 if ( my $item_data = $sth->fetchrow_hashref ) {
2708 $item_type = $item_data->{itemtype};
2709 $charge = $item_data->{rentalcharge};
2710 my $branch = C4::Branch::mybranch();
2711 my $discount_query = q|SELECT rentaldiscount,
2712 issuingrules.itemtype, issuingrules.branchcode
2714 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2715 WHERE borrowers.borrowernumber = ?
2716 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2717 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2718 my $discount_sth = $dbh->prepare($discount_query);
2719 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2720 my $discount_rules = $discount_sth->fetchall_arrayref({});
2721 if (@{$discount_rules}) {
2722 # We may have multiple rules so get the most specific
2723 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2724 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2728 return ( $charge, $item_type );
2731 # Select most appropriate discount rule from those returned
2732 sub _get_discount_from_rule {
2733 my ($rules_ref, $branch, $itemtype) = @_;
2736 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2737 $discount = $rules_ref->[0]->{rentaldiscount};
2738 return (defined $discount) ? $discount : 0;
2740 # could have up to 4 does one match $branch and $itemtype
2741 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2743 $discount = $d[0]->{rentaldiscount};
2744 return (defined $discount) ? $discount : 0;
2746 # do we have item type + all branches
2747 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype
} eq $itemtype } @
{$rules_ref};
2749 $discount = $d[0]->{rentaldiscount
};
2750 return (defined $discount) ?
$discount : 0;
2752 # do we all item types + this branch
2753 @d = grep { $_->{branchcode
} eq $branch && $_->{itemtype
} eq q{*} } @
{$rules_ref};
2755 $discount = $d[0]->{rentaldiscount
};
2756 return (defined $discount) ?
$discount : 0;
2758 # so all and all (surely we wont get here)
2759 @d = grep { $_->{branchcode
} eq q{*} && $_->{itemtype
} eq q{*} } @
{$rules_ref};
2761 $discount = $d[0]->{rentaldiscount
};
2762 return (defined $discount) ?
$discount : 0;
2768 =head2 AddIssuingCharge
2770 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2774 sub AddIssuingCharge
{
2775 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2776 my $dbh = C4
::Context
->dbh;
2777 my $nextaccntno = getnextacctno
( $borrowernumber );
2779 $manager_id = C4
::Context
->userenv->{'number'} if C4
::Context
->userenv;
2781 INSERT INTO accountlines
2782 (borrowernumber, itemnumber, accountno,
2783 date, amount, description, accounttype,
2784 amountoutstanding, manager_id)
2785 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2787 my $sth = $dbh->prepare($query);
2788 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2793 GetTransfers($itemnumber);
2798 my ($itemnumber) = @_;
2800 my $dbh = C4
::Context
->dbh;
2806 FROM branchtransfers
2807 WHERE itemnumber = ?
2808 AND datearrived IS NULL
2810 my $sth = $dbh->prepare($query);
2811 $sth->execute($itemnumber);
2812 my @row = $sth->fetchrow_array();
2816 =head2 GetTransfersFromTo
2818 @results = GetTransfersFromTo($frombranch,$tobranch);
2820 Returns the list of pending transfers between $from and $to branch
2824 sub GetTransfersFromTo
{
2825 my ( $frombranch, $tobranch ) = @_;
2826 return unless ( $frombranch && $tobranch );
2827 my $dbh = C4
::Context
->dbh;
2829 SELECT itemnumber,datesent,frombranch
2830 FROM branchtransfers
2833 AND datearrived IS NULL
2835 my $sth = $dbh->prepare($query);
2836 $sth->execute( $frombranch, $tobranch );
2839 while ( my $data = $sth->fetchrow_hashref ) {
2840 push @gettransfers, $data;
2842 return (@gettransfers);
2845 =head2 DeleteTransfer
2847 &DeleteTransfer($itemnumber);
2851 sub DeleteTransfer
{
2852 my ($itemnumber) = @_;
2853 return unless $itemnumber;
2854 my $dbh = C4
::Context
->dbh;
2855 my $sth = $dbh->prepare(
2856 "DELETE FROM branchtransfers
2858 AND datearrived IS NULL "
2860 return $sth->execute($itemnumber);
2863 =head2 AnonymiseIssueHistory
2865 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
2867 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2868 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2870 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2871 setting (force delete).
2873 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
2877 sub AnonymiseIssueHistory
{
2879 my $borrowernumber = shift;
2880 my $dbh = C4
::Context
->dbh;
2883 SET borrowernumber = ?
2884 WHERE returndate < ?
2885 AND borrowernumber IS NOT NULL
2888 # The default of 0 does not work due to foreign key constraints
2889 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2890 my $anonymouspatron = (C4
::Context
->preference('AnonymousPatron')) ? C4
::Context
->preference('AnonymousPatron') : 0;
2891 my @bind_params = ($anonymouspatron, $date);
2892 if (defined $borrowernumber) {
2893 $query .= " AND borrowernumber = ?";
2894 push @bind_params, $borrowernumber;
2896 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2898 my $sth = $dbh->prepare($query);
2899 $sth->execute(@bind_params);
2900 my $anonymisation_err = $dbh->err;
2901 my $rows_affected = $sth->rows; ### doublecheck row count return function
2902 return ($rows_affected, $anonymisation_err);
2905 =head2 SendCirculationAlert
2907 Send out a C<check-in> or C<checkout> alert using the messaging system.
2915 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2919 Hashref of information about the item being checked in or out.
2923 Hashref of information about the borrower of the item.
2927 The branchcode from where the checkout or check-in took place.
2933 SendCirculationAlert({
2936 borrower => $borrower,
2942 sub SendCirculationAlert
{
2944 my ($type, $item, $borrower, $branch) =
2945 ($opts->{type
}, $opts->{item
}, $opts->{borrower
}, $opts->{branch
});
2946 my %message_name = (
2947 CHECKIN
=> 'Item_Check_in',
2948 CHECKOUT
=> 'Item_Checkout',
2949 RENEWAL
=> 'Item_Checkout',
2951 my $borrower_preferences = C4
::Members
::Messaging
::GetMessagingPreferences
({
2952 borrowernumber
=> $borrower->{borrowernumber
},
2953 message_name
=> $message_name{$type},
2955 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ?
'issues' : 'old_issues';
2956 my $letter = C4
::Letters
::GetPreparedLetter
(
2957 module
=> 'circulation',
2958 letter_code
=> $type,
2959 branchcode
=> $branch,
2961 $issues_table => $item->{itemnumber
},
2962 'items' => $item->{itemnumber
},
2963 'biblio' => $item->{biblionumber
},
2964 'biblioitems' => $item->{biblionumber
},
2965 'borrowers' => $borrower,
2966 'branches' => $branch,
2970 my @transports = keys %{ $borrower_preferences->{transports
} };
2971 # warn "no transports" unless @transports;
2973 # warn "transport: $_";
2974 my $message = C4
::Message
->find_last_message($borrower, $type, $_);
2976 #warn "create new message";
2977 C4
::Message
->enqueue($letter, $borrower, $_);
2979 #warn "append to old message";
2980 $message->append($letter);
2988 =head2 updateWrongTransfer
2990 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2992 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
2996 sub updateWrongTransfer
{
2997 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2998 my $dbh = C4
::Context
->dbh;
2999 # first step validate the actual line of transfert .
3002 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3004 $sth->execute($FromLibrary,$itemNumber);
3006 # second step create a new line of branchtransfer to the right location .
3007 ModItemTransfer
($itemNumber, $FromLibrary, $waitingAtLibrary);
3009 #third step changing holdingbranch of item
3010 UpdateHoldingbranch
($FromLibrary,$itemNumber);
3013 =head2 UpdateHoldingbranch
3015 $items = UpdateHoldingbranch($branch,$itmenumber);
3017 Simple methode for updating hodlingbranch in items BDD line
3021 sub UpdateHoldingbranch
{
3022 my ( $branch,$itemnumber ) = @_;
3023 ModItem
({ holdingbranch
=> $branch }, undef, $itemnumber);
3028 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3030 this function calculates the due date given the start date and configured circulation rules,
3031 checking against the holidays calendar as per the 'useDaysMode' syspref.
3032 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
3033 C<$itemtype> = itemtype code of item in question
3034 C<$branch> = location whose calendar to use
3035 C<$borrower> = Borrower object
3036 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3041 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3045 # loanlength now a href
3047 GetLoanLength
( $borrower->{'categorycode'}, $itemtype, $branch );
3049 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod
} )
3055 if (ref $startdate ne 'DateTime' ) {
3056 $datedue = dt_from_string
($datedue);
3058 $datedue = $startdate->clone;
3062 DateTime
->now( time_zone
=> C4
::Context
->tz() )
3063 ->truncate( to
=> 'minute' );
3067 # calculate the datedue as normal
3068 if ( C4
::Context
->preference('useDaysMode') eq 'Days' )
3069 { # ignoring calendar
3070 if ( $loanlength->{lengthunit
} eq 'hours' ) {
3071 $datedue->add( hours
=> $loanlength->{$length_key} );
3073 $datedue->add( days
=> $loanlength->{$length_key} );
3074 $datedue->set_hour(23);
3075 $datedue->set_minute(59);
3079 if ($loanlength->{lengthunit
} eq 'hours') {
3080 $dur = DateTime
::Duration
->new( hours
=> $loanlength->{$length_key});
3083 $dur = DateTime
::Duration
->new( days
=> $loanlength->{$length_key});
3085 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
3086 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit
} );
3087 if ($loanlength->{lengthunit
} eq 'days') {
3088 $datedue->set_hour(23);
3089 $datedue->set_minute(59);
3093 # if Hard Due Dates are used, retreive them and apply as necessary
3094 my ( $hardduedate, $hardduedatecompare ) =
3095 GetHardDueDate
( $borrower->{'categorycode'}, $itemtype, $branch );
3096 if ($hardduedate) { # hardduedates are currently dates
3097 $hardduedate->truncate( to
=> 'minute' );
3098 $hardduedate->set_hour(23);
3099 $hardduedate->set_minute(59);
3100 my $cmp = DateTime
->compare( $hardduedate, $datedue );
3102 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3103 # if the calculated date is before the 'after' Hard Due Date (floor), override
3104 # if the hard due date is set to 'exactly', overrride
3105 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3106 $datedue = $hardduedate->clone;
3109 # in all other cases, keep the date due as it is
3113 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3114 if ( C4
::Context
->preference('ReturnBeforeExpiry') ) {
3115 my $expiry_dt = dt_from_string
( $borrower->{dateexpiry
}, 'iso' );
3116 $expiry_dt->set( hour
=> 23, minute
=> 59);
3117 if ( DateTime
->compare( $datedue, $expiry_dt ) == 1 ) {
3118 $datedue = $expiry_dt->clone;
3126 =head2 CheckRepeatableHolidays
3128 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3130 This function checks if the date due is a repeatable holiday
3132 C<$date_due> = returndate calculate with no day check
3133 C<$itemnumber> = itemnumber
3134 C<$branchcode> = localisation of issue
3138 sub CheckRepeatableHolidays
{
3139 my($itemnumber,$week_day,$branchcode)=@_;
3140 my $dbh = C4
::Context
->dbh;
3141 my $query = qq|SELECT count
(*)
3142 FROM repeatable_holidays
3145 my $sth = $dbh->prepare($query);
3146 $sth->execute($branchcode,$week_day);
3147 my $result=$sth->fetchrow;
3152 =head2 CheckSpecialHolidays
3154 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3156 This function check if the date is a special holiday
3158 C<$years> = the years of datedue
3159 C<$month> = the month of datedue
3160 C<$day> = the day of datedue
3161 C<$itemnumber> = itemnumber
3162 C<$branchcode> = localisation of issue
3166 sub CheckSpecialHolidays
{
3167 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3168 my $dbh = C4
::Context
->dbh;
3169 my $query=qq|SELECT count
(*)
3170 FROM
`special_holidays`
3176 my $sth = $dbh->prepare($query);
3177 $sth->execute($years,$month,$day,$branchcode);
3178 my $countspecial=$sth->fetchrow ;
3179 return $countspecial;
3182 =head2 CheckRepeatableSpecialHolidays
3184 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3186 This function check if the date is a repeatble special holidays
3188 C<$month> = the month of datedue
3189 C<$day> = the day of datedue
3190 C<$itemnumber> = itemnumber
3191 C<$branchcode> = localisation of issue
3195 sub CheckRepeatableSpecialHolidays
{
3196 my ($month,$day,$itemnumber,$branchcode) = @_;
3197 my $dbh = C4
::Context
->dbh;
3198 my $query=qq|SELECT count
(*)
3199 FROM
`repeatable_holidays`
3204 my $sth = $dbh->prepare($query);
3205 $sth->execute($month,$day,$branchcode);
3206 my $countspecial=$sth->fetchrow ;
3207 return $countspecial;
3212 sub CheckValidBarcode
{
3214 my $dbh = C4
::Context
->dbh;
3215 my $query=qq|SELECT count
(*)
3219 my $sth = $dbh->prepare($query);
3220 $sth->execute($barcode);
3221 my $exist=$sth->fetchrow ;
3225 =head2 IsBranchTransferAllowed
3227 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3229 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3233 sub IsBranchTransferAllowed
{
3234 my ( $toBranch, $fromBranch, $code ) = @_;
3236 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3238 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3239 my $dbh = C4
::Context
->dbh;
3241 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3242 $sth->execute( $toBranch, $fromBranch, $code );
3243 my $limit = $sth->fetchrow_hashref();
3245 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3246 if ( $limit->{'limitId'} ) {
3253 =head2 CreateBranchTransferLimit
3255 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3257 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3261 sub CreateBranchTransferLimit
{
3262 my ( $toBranch, $fromBranch, $code ) = @_;
3263 return unless defined($toBranch) && defined($fromBranch);
3264 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3266 my $dbh = C4
::Context
->dbh;
3268 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3269 return $sth->execute( $code, $toBranch, $fromBranch );
3272 =head2 DeleteBranchTransferLimits
3274 my $result = DeleteBranchTransferLimits($frombranch);
3276 Deletes all the library transfer limits for one library. Returns the
3277 number of limits deleted, 0e0 if no limits were deleted, or undef if
3278 no arguments are supplied.
3282 sub DeleteBranchTransferLimits
{
3284 return unless defined $branch;
3285 my $dbh = C4
::Context
->dbh;
3286 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3287 return $sth->execute($branch);
3291 my ( $borrowernumber, $itemnum ) = @_;
3293 MarkIssueReturned
( $borrowernumber, $itemnum );
3294 my $borrower = C4
::Members
::GetMember
( 'borrowernumber'=>$borrowernumber );
3295 my $item = C4
::Items
::GetItem
( $itemnum );
3296 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ?
$item->{'paidfor'}.' / ' : q{};
3297 my @datearr = localtime(time);
3298 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3299 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3300 ModItem
({ paidfor
=> $old_note."Paid for by $bor $date" }, undef, $itemnum);
3305 my ($itemnumber, $mark_returned) = @_;
3307 my $dbh = C4
::Context
->dbh();
3308 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3310 JOIN items USING (itemnumber)
3311 JOIN biblio USING (biblionumber)
3312 WHERE issues.itemnumber=?");
3313 $sth->execute($itemnumber);
3314 my $issues=$sth->fetchrow_hashref();
3316 # If a borrower lost the item, add a replacement cost to the their record
3317 if ( my $borrowernumber = $issues->{borrowernumber
} ){
3318 my $borrower = C4
::Members
::GetMemberDetails
( $borrowernumber );
3320 if (C4
::Context
->preference('WhenLostForgiveFine')){
3321 my $fix = _FixOverduesOnReturn
($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3322 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3324 if (C4
::Context
->preference('WhenLostChargeReplacementFee')){
3325 C4
::Accounts
::chargelostitem
($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3326 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3327 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3330 MarkIssueReturned
($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3334 sub GetOfflineOperations
{
3335 my $dbh = C4
::Context
->dbh;
3336 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3337 $sth->execute(C4
::Context
->userenv->{'branch'});
3338 my $results = $sth->fetchall_arrayref({});
3342 sub GetOfflineOperation
{
3343 my $operationid = shift;
3344 return unless $operationid;
3345 my $dbh = C4
::Context
->dbh;
3346 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3347 $sth->execute( $operationid );
3348 return $sth->fetchrow_hashref;
3351 sub AddOfflineOperation
{
3352 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3353 my $dbh = C4
::Context
->dbh;
3354 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3355 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3359 sub DeleteOfflineOperation
{
3360 my $dbh = C4
::Context
->dbh;
3361 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3362 $sth->execute( shift );
3366 sub ProcessOfflineOperation
{
3367 my $operation = shift;
3370 if ( $operation->{action
} eq 'return' ) {
3371 $report = ProcessOfflineReturn
( $operation );
3372 } elsif ( $operation->{action
} eq 'issue' ) {
3373 $report = ProcessOfflineIssue
( $operation );
3374 } elsif ( $operation->{action
} eq 'payment' ) {
3375 $report = ProcessOfflinePayment
( $operation );
3378 DeleteOfflineOperation
( $operation->{operationid
} ) if $operation->{operationid
};
3383 sub ProcessOfflineReturn
{
3384 my $operation = shift;
3386 my $itemnumber = C4
::Items
::GetItemnumberFromBarcode
( $operation->{barcode
} );
3388 if ( $itemnumber ) {
3389 my $issue = GetOpenIssue
( $itemnumber );
3392 $issue->{borrowernumber
},
3395 $operation->{timestamp
},
3398 { renewals
=> 0, onloan
=> undef },
3399 $issue->{'biblionumber'},
3404 return "Item not issued.";
3407 return "Item not found.";
3411 sub ProcessOfflineIssue
{
3412 my $operation = shift;
3414 my $borrower = C4
::Members
::GetMemberDetails
( undef, $operation->{cardnumber
} ); # Get borrower from operation cardnumber
3416 if ( $borrower->{borrowernumber
} ) {
3417 my $itemnumber = C4
::Items
::GetItemnumberFromBarcode
( $operation->{barcode
} );
3418 unless ($itemnumber) {
3419 return "Barcode not found.";
3421 my $issue = GetOpenIssue
( $itemnumber );
3423 if ( $issue and ( $issue->{borrowernumber
} ne $borrower->{borrowernumber
} ) ) { # Item already issued to another borrower, mark it returned
3425 $issue->{borrowernumber
},
3428 $operation->{timestamp
},
3433 $operation->{'barcode'},
3436 $operation->{timestamp
},
3441 return "Borrower not found.";
3445 sub ProcessOfflinePayment
{
3446 my $operation = shift;
3448 my $borrower = C4
::Members
::GetMemberDetails
( undef, $operation->{cardnumber
} ); # Get borrower from operation cardnumber
3449 my $amount = $operation->{amount
};
3451 recordpayment
( $borrower->{borrowernumber
}, $amount );
3459 TransferSlip($user_branch, $itemnumber, $to_branch)
3461 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3466 my ($branch, $itemnumber, $to_branch) = @_;
3468 my $item = GetItem
( $itemnumber )
3471 my $pulldate = C4
::Dates
->new();
3473 return C4
::Letters
::GetPreparedLetter
(
3474 module
=> 'circulation',
3475 letter_code
=> 'TRANSFERSLIP',
3476 branchcode
=> $branch,
3478 'branches' => $to_branch,
3479 'biblio' => $item->{biblionumber
},
3485 =head2 CheckIfIssuedToPatron
3487 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3489 Return 1 if any record item is issued to patron, otherwise return 0
3493 sub CheckIfIssuedToPatron
{
3494 my ($borrowernumber, $biblionumber) = @_;
3496 my $items = GetItemsByBiblioitemnumber
($biblionumber);
3498 foreach my $item (@
{$items}) {
3499 return 1 if ($item->{borrowernumber
} && $item->{borrowernumber
} eq $borrowernumber);
3507 IsItemIssued( $itemnumber )
3509 Return 1 if the item is on loan, otherwise return 0
3514 my $itemnumber = shift;
3515 my $dbh = C4
::Context
->dbh;
3516 my $sth = $dbh->prepare(q{
3519 WHERE itemnumber = ?
3521 $sth->execute($itemnumber);
3522 return $sth->fetchrow;
3531 Koha Development Team <http://koha-community.org/>