1 package C4
::Circulation
;
3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #use warnings; FIXME - Bug 2505
33 use C4
::ItemCirculationAlertPreference
;
45 use POSIX
qw(strftime);
46 use C4
::Branch
; # GetBranches
47 use C4
::Log
; # logaction
51 use vars
qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
55 $VERSION = 3.02; # for version checking
58 # FIXME subs that should probably be elsewhere
64 # subs to deal with issuing a book
77 &GetBranchBorrowerCircRule
80 &AnonymiseIssueHistory
83 # subs to deal with returns
89 # subs to deal with transfers
96 &IsBranchTransferAllowed
97 &CreateBranchTransferLimit
98 &DeleteBranchTransferLimits
104 C4::Circulation - Koha circulation module
112 The functions in this module deal with circulation, issues, and
113 returns, as well as general information about the library.
114 Also deals with stocktaking.
120 =head3 $str = &barcodedecode($barcode, [$filter]);
124 =item Generic filter function for barcode string.
125 Called on every circ if the System Pref itemBarcodeInputFilter is set.
126 Will do some manipulation of the barcode for systems that deliver a barcode
127 to circulation.pl that differs from the barcode stored for the item.
128 For proper functioning of this filter, calling the function on the
129 correct barcode string (items.barcode) should return an unaltered barcode.
131 The optional $filter argument is to allow for testing or explicit
132 behavior that ignores the System Pref. Valid values are the same as the
139 # FIXME -- the &decode fcn below should be wrapped into this one.
140 # FIXME -- these plugins should be moved out of Circulation.pm
143 my ($barcode, $filter) = @_;
144 $filter = C4
::Context
->preference('itemBarcodeInputFilter') unless $filter;
145 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
146 if ($filter eq 'whitespace') {
148 } elsif ($filter eq 'cuecat') {
150 my @fields = split( /\./, $barcode );
151 my @results = map( decode
($_), @fields[ 1 .. $#fields ] );
152 ($#results == 2) and return $results[2];
153 } elsif ($filter eq 'T-prefix') {
154 if ($barcode =~ /^[Tt](\d)/) {
155 (defined($1) and $1 eq '0') and return $barcode;
156 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
158 return sprintf("T%07d", $barcode);
159 # FIXME: $barcode could be "T1", causing warning: substr outside of string
160 # Why drop the nonzero digit after the T?
161 # Why pass non-digits (or empty string) to "T%07d"?
163 return $barcode; # return barcode, modified or not
168 =head3 $str = &decode($chunk);
172 =item Decodes a segment of a string emitted by a CueCat barcode scanner and
175 FIXME: Should be replaced with Barcode::Cuecat from CPAN
176 or Javascript based decoding on the client side.
185 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
186 my @s = map { index( $seq, $_ ); } split( //, $encoded );
187 my $l = ( $#s + 1 ) % 4;
190 # warn "Error: Cuecat decode parsing failed!";
198 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
200 chr( ( $n >> 16 ) ^ 67 )
201 .chr( ( $n >> 8 & 255 ) ^ 67 )
202 .chr( ( $n & 255 ) ^ 67 );
205 $r = substr( $r, 0, length($r) - $l );
211 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch, $barcode, $ignore_reserves);
213 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
215 C<$newbranch> is the code for the branch to which the item should be transferred.
217 C<$barcode> is the barcode of the item to be transferred.
219 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
220 Otherwise, if an item is reserved, the transfer fails.
222 Returns three values:
226 is true if the transfer was successful.
230 is a reference-to-hash which may have any of the following keys:
236 There is no item in the catalog with the given barcode. The value is C<$barcode>.
240 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.
242 =item C<DestinationEqualsHolding>
244 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.
248 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.
252 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>.
254 =item C<WasTransferred>
256 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
263 my ( $tbr, $barcode, $ignoreRs ) = @_;
266 my $branches = GetBranches
();
267 my $itemnumber = GetItemnumberFromBarcode
( $barcode );
268 my $issue = GetItemIssue
($itemnumber);
269 my $biblio = GetBiblioFromItemNumber
($itemnumber);
272 if ( not $itemnumber ) {
273 $messages->{'BadBarcode'} = $barcode;
277 # get branches of book...
278 my $hbr = $biblio->{'homebranch'};
279 my $fbr = $biblio->{'holdingbranch'};
281 # if using Branch Transfer Limits
282 if ( C4
::Context
->preference("UseBranchTransferLimits") == 1 ) {
283 if ( C4
::Context
->preference("item-level_itypes") && C4
::Context
->preference("BranchTransferLimitsType") eq 'itemtype' ) {
284 if ( ! IsBranchTransferAllowed
( $tbr, $fbr, $biblio->{'itype'} ) ) {
285 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
288 } elsif ( ! IsBranchTransferAllowed
( $tbr, $fbr, $biblio->{ C4
::Context
->preference("BranchTransferLimitsType") } ) ) {
289 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4
::Context
->preference("BranchTransferLimitsType") };
295 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
296 $messages->{'IsPermanent'} = $hbr;
300 # can't transfer book if is already there....
301 if ( $fbr eq $tbr ) {
302 $messages->{'DestinationEqualsHolding'} = 1;
306 # check if it is still issued to someone, return it...
307 if ($issue->{borrowernumber
}) {
308 AddReturn
( $barcode, $fbr );
309 $messages->{'WasReturned'} = $issue->{borrowernumber
};
313 # That'll save a database query.
314 my ( $resfound, $resrec ) =
315 CheckReserves
( $itemnumber );
316 if ( $resfound and not $ignoreRs ) {
317 $resrec->{'ResFound'} = $resfound;
319 # $messages->{'ResFound'} = $resrec;
323 #actually do the transfer....
325 ModItemTransfer
( $itemnumber, $fbr, $tbr );
327 # don't need to update MARC anymore, we do it in batch now
328 $messages->{'WasTransfered'} = 1;
331 ModDateLastSeen
( $itemnumber );
332 return ( $dotransfer, $messages, $biblio );
337 my $borrower = shift;
338 my $biblionumber = shift;
340 my $cat_borrower = $borrower->{'categorycode'};
341 my $dbh = C4
::Context
->dbh;
343 # Get which branchcode we need
344 $branch = _GetCircControlBranch
($item,$borrower);
345 my $type = (C4
::Context
->preference('item-level_itypes'))
346 ?
$item->{'itype'} # item-level
347 : $item->{'itemtype'}; # biblio-level
349 # given branch, patron category, and item type, determine
350 # applicable issuing rule
351 my $issuing_rule = GetIssuingRule
($cat_borrower, $type, $branch);
353 # if a rule is found and has a loan limit set, count
354 # how many loans the patron already has that meet that
356 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
358 my $count_query = "SELECT COUNT(*) FROM issues
359 JOIN items USING (itemnumber) ";
361 my $rule_itemtype = $issuing_rule->{itemtype
};
362 if ($rule_itemtype eq "*") {
363 # matching rule has the default item type, so count only
364 # those existing loans that don't fall under a more
366 if (C4
::Context
->preference('item-level_itypes')) {
367 $count_query .= " WHERE items.itype NOT IN (
368 SELECT itemtype FROM issuingrules
370 AND (categorycode = ? OR categorycode = ?)
374 $count_query .= " JOIN biblioitems USING (biblionumber)
375 WHERE biblioitems.itemtype NOT IN (
376 SELECT itemtype FROM issuingrules
378 AND (categorycode = ? OR categorycode = ?)
382 push @bind_params, $issuing_rule->{branchcode
};
383 push @bind_params, $issuing_rule->{categorycode
};
384 push @bind_params, $cat_borrower;
386 # rule has specific item type, so count loans of that
388 if (C4
::Context
->preference('item-level_itypes')) {
389 $count_query .= " WHERE items.itype = ? ";
391 $count_query .= " JOIN biblioitems USING (biblionumber)
392 WHERE biblioitems.itemtype= ? ";
394 push @bind_params, $type;
397 $count_query .= " AND borrowernumber = ? ";
398 push @bind_params, $borrower->{'borrowernumber'};
399 my $rule_branch = $issuing_rule->{branchcode
};
400 if ($rule_branch ne "*") {
401 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
402 $count_query .= " AND issues.branchcode = ? ";
403 push @bind_params, $branch;
404 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
405 ; # if branch is the patron's home branch, then count all loans by patron
407 $count_query .= " AND items.homebranch = ? ";
408 push @bind_params, $branch;
412 my $count_sth = $dbh->prepare($count_query);
413 $count_sth->execute(@bind_params);
414 my ($current_loan_count) = $count_sth->fetchrow_array;
416 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
417 if ($current_loan_count >= $max_loans_allowed) {
418 return "$current_loan_count / $max_loans_allowed";
422 # Now count total loans against the limit for the branch
423 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule
($branch, $cat_borrower);
424 if (defined($branch_borrower_circ_rule->{maxissueqty
})) {
425 my @bind_params = ();
426 my $branch_count_query = "SELECT COUNT(*) FROM issues
427 JOIN items USING (itemnumber)
428 WHERE borrowernumber = ? ";
429 push @bind_params, $borrower->{borrowernumber
};
431 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
432 $branch_count_query .= " AND issues.branchcode = ? ";
433 push @bind_params, $branch;
434 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
435 ; # if branch is the patron's home branch, then count all loans by patron
437 $branch_count_query .= " AND items.homebranch = ? ";
438 push @bind_params, $branch;
440 my $branch_count_sth = $dbh->prepare($branch_count_query);
441 $branch_count_sth->execute(@bind_params);
442 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
444 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty
};
445 if ($current_loan_count >= $max_loans_allowed) {
446 return "$current_loan_count / $max_loans_allowed";
450 # OK, the patron can issue !!!
456 @issues = &itemissues($biblioitemnumber, $biblio);
458 Looks up information about who has borrowed the bookZ<>(s) with the
459 given biblioitemnumber.
461 C<$biblio> is ignored.
463 C<&itemissues> returns an array of references-to-hash. The keys
464 include the fields from the C<items> table in the Koha database.
465 Additional keys include:
471 If the item is currently on loan, this gives the due date.
473 If the item is not on loan, then this is either "Available" or
474 "Cancelled", if the item has been withdrawn.
478 If the item is currently on loan, this gives the card number of the
479 patron who currently has the item.
481 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
483 These give the timestamp for the last three times the item was
486 =item C<card0>, C<card1>, C<card2>
488 The card number of the last three patrons who borrowed this item.
490 =item C<borrower0>, C<borrower1>, C<borrower2>
492 The borrower number of the last three patrons who borrowed this item.
500 my ( $bibitem, $biblio ) = @_;
501 my $dbh = C4
::Context
->dbh;
503 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
508 $sth->execute($bibitem) || die $sth->errstr;
510 while ( my $data = $sth->fetchrow_hashref ) {
512 # Find out who currently has this item.
513 # FIXME - Wouldn't it be better to do this as a left join of
514 # some sort? Currently, this code assumes that if
515 # fetchrow_hashref() fails, then the book is on the shelf.
516 # fetchrow_hashref() can fail for any number of reasons (e.g.,
517 # database server crash), not just because no items match the
519 my $sth2 = $dbh->prepare(
520 "SELECT * FROM issues
521 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
526 $sth2->execute( $data->{'itemnumber'} );
527 if ( my $data2 = $sth2->fetchrow_hashref ) {
528 $data->{'date_due'} = $data2->{'date_due'};
529 $data->{'card'} = $data2->{'cardnumber'};
530 $data->{'borrower'} = $data2->{'borrowernumber'};
533 $data->{'date_due'} = ($data->{'wthdrawn'} eq '1') ?
'Cancelled' : 'Available';
537 # Find the last 3 people who borrowed this item.
538 $sth2 = $dbh->prepare(
539 "SELECT * FROM old_issues
540 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
542 ORDER BY returndate DESC,timestamp DESC"
545 $sth2->execute( $data->{'itemnumber'} );
546 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
547 { # FIXME : error if there is less than 3 pple borrowing this item
548 if ( my $data2 = $sth2->fetchrow_hashref ) {
549 $data->{"timestamp$i2"} = $data2->{'timestamp'};
550 $data->{"card$i2"} = $data2->{'cardnumber'};
551 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
555 $results[$i] = $data;
562 =head2 CanBookBeIssued
564 Check if a book can be issued.
566 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower, $barcode, $duedatespec, $inprocess );
568 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
572 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
574 =item C<$barcode> is the bar code of the book being issued.
576 =item C<$duedatespec> is a C4::Dates object.
586 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
587 Possible values are :
593 sticky due date is invalid
597 borrower gone with no address
601 borrower declared it's card lost
607 =head3 UNKNOWN_BARCODE
621 item is restricted (set by ??)
623 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan could be prevented,
624 but ones that can be overriden by the operator.
626 Possible values are :
634 renewing, not issuing
636 =head3 ISSUED_TO_ANOTHER
638 issued to someone else.
642 reserved for someone else.
646 sticky due date is invalid
650 if the borrower borrows to much things
654 sub CanBookBeIssued
{
655 my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
656 my %needsconfirmation; # filled with problems that needs confirmations
657 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
658 my $item = GetItem
(GetItemnumberFromBarcode
( $barcode ));
659 my $issue = GetItemIssue
($item->{itemnumber
});
660 my $biblioitem = GetBiblioItemData
($item->{biblioitemnumber
});
661 $item->{'itemtype'}=$item->{'itype'};
662 my $dbh = C4
::Context
->dbh;
664 # MANDATORY CHECKS - unless item exists, nothing else matters
665 unless ( $item->{barcode
} ) {
666 $issuingimpossible{UNKNOWN_BARCODE
} = 1;
668 return ( \
%issuingimpossible, \
%needsconfirmation ) if %issuingimpossible;
671 # DUE DATE is OK ? -- should already have checked.
673 unless ( $duedate ) {
674 my $issuedate = strftime
( "%Y-%m-%d", localtime );
676 my $branch = _GetCircControlBranch
($item,$borrower);
677 my $itype = ( C4
::Context
->preference('item-level_itypes') ) ?
$item->{'itype'} : $biblioitem->{'itemtype'};
678 my $loanlength = GetLoanLength
( $borrower->{'categorycode'}, $itype, $branch );
679 $duedate = CalcDateDue
( C4
::Dates
->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
681 # Offline circ calls AddIssue directly, doesn't run through here
682 # So issuingimpossible should be ok.
684 $issuingimpossible{INVALID_DATE
} = $duedate->output('syspref') unless ( $duedate && $duedate->output('iso') ge C4
::Dates
->today('iso') );
689 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode
} )) {
690 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
691 &UpdateStats
(C4
::Context
->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'});
692 ModDateLastSeen
( $item->{'itemnumber'} );
693 return( { STATS
=> 1 }, {});
695 if ( $borrower->{flags
}->{GNA
} ) {
696 $issuingimpossible{GNA
} = 1;
698 if ( $borrower->{flags
}->{'LOST'} ) {
699 $issuingimpossible{CARD_LOST
} = 1;
701 if ( $borrower->{flags
}->{'DBARRED'} ) {
702 $issuingimpossible{DEBARRED
} = 1;
704 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
705 $issuingimpossible{EXPIRED
} = 1;
707 my @expirydate= split /-/,$borrower->{'dateexpiry'};
708 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
709 Date_to_Days
(Today
) > Date_to_Days
( @expirydate )) {
710 $issuingimpossible{EXPIRED
} = 1;
719 C4
::Members
::GetMemberAccountRecords
( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
720 if ( C4
::Context
->preference("IssuingInProcess") ) {
721 my $amountlimit = C4
::Context
->preference("noissuescharge");
722 if ( $amount > $amountlimit && !$inprocess ) {
723 $issuingimpossible{DEBT
} = sprintf( "%.2f", $amount );
725 elsif ( $amount > 0 && $amount <= $amountlimit && !$inprocess ) {
726 $needsconfirmation{DEBT
} = sprintf( "%.2f", $amount );
731 $needsconfirmation{DEBT
} = sprintf( "%.2f", $amount );
735 my ($blocktype, $count) = C4
::Members
::IsMemberBlocked
($borrower->{'borrowernumber'});
736 if ($blocktype == -1) {
737 ## patron has outstanding overdue loans
738 if ( C4
::Context
->preference("OverduesBlockCirc") eq 'block'){
739 $issuingimpossible{USERBLOCKEDOVERDUE
} = $count;
741 elsif ( C4
::Context
->preference("OverduesBlockCirc") eq 'confirmation'){
742 $needsconfirmation{USERBLOCKEDOVERDUE
} = $count;
744 } elsif($blocktype == 1) {
745 # patron has accrued fine days
746 $issuingimpossible{USERBLOCKEDREMAINING
} = $count;
750 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
752 my $toomany = TooMany
( $borrower, $item->{biblionumber
}, $item );
753 # if TooMany return / 0, then the user has no permission to check out this book
754 if ($toomany =~ /\/ 0/) {
755 $needsconfirmation{PATRON_CANT
} = 1;
757 $needsconfirmation{TOO_MANY
} = $toomany if $toomany;
763 if ( $item->{'notforloan'}
764 && $item->{'notforloan'} > 0 )
766 if(!C4
::Context
->preference("AllowNotForLoanOverride")){
767 $issuingimpossible{NOT_FOR_LOAN
} = 1;
769 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
772 elsif ( !$item->{'notforloan'} ){
773 # we have to check itemtypes.notforloan also
774 if (C4
::Context
->preference('item-level_itypes')){
775 # this should probably be a subroutine
776 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
777 $sth->execute($item->{'itemtype'});
778 my $notforloan=$sth->fetchrow_hashref();
780 if ($notforloan->{'notforloan'}) {
781 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
782 $issuingimpossible{NOT_FOR_LOAN
} = 1;
784 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
788 elsif ($biblioitem->{'notforloan'} == 1){
789 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
790 $issuingimpossible{NOT_FOR_LOAN
} = 1;
792 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
796 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
798 $issuingimpossible{WTHDRAWN
} = 1;
800 if ( $item->{'restricted'}
801 && $item->{'restricted'} == 1 )
803 $issuingimpossible{RESTRICTED
} = 1;
805 if ( C4
::Context
->preference("IndependantBranches") ) {
806 my $userenv = C4
::Context
->userenv;
807 if ( ($userenv) && ( $userenv->{flags
} % 2 != 1 ) ) {
808 $issuingimpossible{ITEMNOTSAMEBRANCH
} = 1
809 if ( $item->{C4
::Context
->preference("HomeOrHoldingBranch")} ne $userenv->{branch
} );
810 $needsconfirmation{BORRNOTSAMEBRANCH
} = GetBranchName
( $borrower->{'branchcode'} )
811 if ( $borrower->{'branchcode'} ne $userenv->{branch
} );
816 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
818 if ( $issue->{borrowernumber
} && $issue->{borrowernumber
} eq $borrower->{'borrowernumber'} )
821 # Already issued to current borrower. Ask whether the loan should
823 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed
(
824 $borrower->{'borrowernumber'},
825 $item->{'itemnumber'}
827 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
828 $issuingimpossible{NO_MORE_RENEWALS
} = 1;
831 $needsconfirmation{RENEW_ISSUE
} = 1;
834 elsif ($issue->{borrowernumber
}) {
836 # issued to someone else
837 my $currborinfo = C4
::Members
::GetMemberDetails
( $issue->{borrowernumber
} );
839 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
840 $needsconfirmation{ISSUED_TO_ANOTHER
} =
841 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
844 # See if the item is on reserve.
845 my ( $restype, $res ) = C4
::Reserves
::CheckReserves
( $item->{'itemnumber'} );
847 my $resbor = $res->{'borrowernumber'};
848 my ( $resborrower ) = C4
::Members
::GetMemberDetails
( $resbor, 0 );
849 my $branches = GetBranches
();
850 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
851 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
853 # The item is on reserve and waiting, but has been
854 # reserved by some other patron.
855 $needsconfirmation{RESERVE_WAITING
} =
856 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
858 elsif ( $restype eq "Reserved" ) {
859 # The item is on reserve for someone else.
860 $needsconfirmation{RESERVED
} =
861 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
864 return ( \
%issuingimpossible, \
%needsconfirmation );
869 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
871 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
875 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
877 =item C<$barcode> is the barcode of the item being issued.
879 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
882 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
884 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
885 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
887 AddIssue does the following things :
889 - step 01: check that there is a borrowernumber & a barcode provided
890 - check for RENEWAL (book issued & being issued to the same patron)
891 - renewal YES = Calculate Charge & renew
893 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
895 - fill reserve if reserve to this patron
896 - cancel reserve or not, otherwise
897 * TRANSFERT PENDING ?
898 - complete the transfert
906 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
907 my $dbh = C4
::Context
->dbh;
908 my $barcodecheck=CheckValidBarcode
($barcode);
910 # $issuedate defaults to today.
911 if ( ! defined $issuedate ) {
912 $issuedate = strftime
( "%Y-%m-%d", localtime );
913 # TODO: for hourly circ, this will need to be a C4::Dates object
914 # and all calls to AddIssue including issuedate will need to pass a Dates object.
916 if ($borrower and $barcode and $barcodecheck ne '0'){
917 # find which item we issue
918 my $item = GetItem
('', $barcode) or return undef; # if we don't get an Item, abort.
919 my $branch = _GetCircControlBranch
($item,$borrower);
921 # get actual issuing if there is one
922 my $actualissue = GetItemIssue
( $item->{itemnumber
});
924 # get biblioinformation for this item
925 my $biblio = GetBiblioFromItemNumber
($item->{itemnumber
});
928 # check if we just renew the issue.
930 if ($actualissue->{borrowernumber
} eq $borrower->{'borrowernumber'}) {
931 $datedue = AddRenewal
(
932 $borrower->{'borrowernumber'},
933 $item->{'itemnumber'},
936 $issuedate, # here interpreted as the renewal date
941 if ( $actualissue->{borrowernumber
}) {
942 # This book is currently on loan, but not to the person
943 # who wants to borrow it now. mark it returned before issuing to the new borrower
946 C4
::Context
->userenv->{'branch'}
950 # See if the item is on reserve.
951 my ( $restype, $res ) =
952 C4
::Reserves
::CheckReserves
( $item->{'itemnumber'} );
954 my $resbor = $res->{'borrowernumber'};
955 if ( $resbor eq $borrower->{'borrowernumber'} ) {
956 # The item is reserved by the current patron
957 ModReserveFill
($res);
959 elsif ( $restype eq "Waiting" ) {
961 # The item is on reserve and waiting, but has been
962 # reserved by some other patron.
964 elsif ( $restype eq "Reserved" ) {
966 # The item is reserved by someone else.
967 if ($cancelreserve) { # cancel reserves on this item
968 CancelReserve
(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
971 if ($cancelreserve) {
972 CancelReserve
($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
975 # set waiting reserve to first in reserve queue as book isn't waiting now
977 $res->{'biblionumber'},
978 $res->{'borrowernumber'},
984 # Starting process for transfer job (checking transfert and validate it if we have one)
985 my ($datesent) = GetTransfers
($item->{'itemnumber'});
987 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
990 "UPDATE branchtransfers
991 SET datearrived = now(),
993 comments = 'Forced branchtransfer'
994 WHERE itemnumber= ? AND datearrived IS NULL"
996 $sth->execute(C4
::Context
->userenv->{'branch'},$item->{'itemnumber'});
999 # Record in the database the fact that the book was issued.
1003 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1007 my $itype = ( C4
::Context
->preference('item-level_itypes') ) ?
$biblio->{'itype'} : $biblio->{'itemtype'};
1008 my $loanlength = GetLoanLength
( $borrower->{'categorycode'}, $itype, $branch );
1009 $datedue = CalcDateDue
( C4
::Dates
->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
1013 $borrower->{'borrowernumber'}, # borrowernumber
1014 $item->{'itemnumber'}, # itemnumber
1015 $issuedate, # issuedate
1016 $datedue->output('iso'), # date_due
1017 C4
::Context
->userenv->{'branch'} # branchcode
1020 if ( C4
::Context
->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1021 CartToShelf
( $item->{'itemnumber'} );
1023 $item->{'issues'}++;
1024 ModItem
({ issues
=> $item->{'issues'},
1025 holdingbranch
=> C4
::Context
->userenv->{'branch'},
1027 datelastborrowed
=> C4
::Dates
->new()->output('iso'),
1028 onloan
=> $datedue->output('iso'),
1029 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1030 ModDateLastSeen
( $item->{'itemnumber'} );
1032 # If it costs to borrow this book, charge it to the patron's account.
1033 my ( $charge, $itemtype ) = GetIssuingCharges
(
1034 $item->{'itemnumber'},
1035 $borrower->{'borrowernumber'}
1037 if ( $charge > 0 ) {
1039 $item->{'itemnumber'},
1040 $borrower->{'borrowernumber'}, $charge
1042 $item->{'charge'} = $charge;
1045 # Record the fact that this book was issued.
1047 C4
::Context
->userenv->{'branch'},
1049 ($sipmode ?
"SIP-$sipmode" : ''), $item->{'itemnumber'},
1050 $item->{'itype'}, $borrower->{'borrowernumber'}
1053 # Send a checkout slip.
1054 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1056 branchcode
=> $branch,
1057 categorycode
=> $borrower->{categorycode
},
1058 item_type
=> $item->{itype
},
1059 notification
=> 'CHECKOUT',
1061 if ($circulation_alert->is_enabled_for(\
%conditions)) {
1062 SendCirculationAlert
({
1065 borrower
=> $borrower,
1071 logaction
("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1072 if C4
::Context
->preference("IssueLog");
1074 return ($datedue); # not necessarily the same as when it came in!
1077 =head2 GetLoanLength
1079 Get loan length for an itemtype, a borrower type and a branch
1081 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1086 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1087 my $dbh = C4
::Context
->dbh;
1090 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1092 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1093 # try to find issuelength & return the 1st available.
1094 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1095 $sth->execute( $borrowertype, $itemtype, $branchcode );
1096 my $loanlength = $sth->fetchrow_hashref;
1097 return $loanlength->{issuelength
}
1098 if defined($loanlength) && $loanlength->{issuelength
} ne 'NULL';
1100 $sth->execute( $borrowertype, "*", $branchcode );
1101 $loanlength = $sth->fetchrow_hashref;
1102 return $loanlength->{issuelength
}
1103 if defined($loanlength) && $loanlength->{issuelength
} ne 'NULL';
1105 $sth->execute( "*", $itemtype, $branchcode );
1106 $loanlength = $sth->fetchrow_hashref;
1107 return $loanlength->{issuelength
}
1108 if defined($loanlength) && $loanlength->{issuelength
} ne 'NULL';
1110 $sth->execute( "*", "*", $branchcode );
1111 $loanlength = $sth->fetchrow_hashref;
1112 return $loanlength->{issuelength
}
1113 if defined($loanlength) && $loanlength->{issuelength
} ne 'NULL';
1115 $sth->execute( $borrowertype, $itemtype, "*" );
1116 $loanlength = $sth->fetchrow_hashref;
1117 return $loanlength->{issuelength
}
1118 if defined($loanlength) && $loanlength->{issuelength
} ne 'NULL';
1120 $sth->execute( $borrowertype, "*", "*" );
1121 $loanlength = $sth->fetchrow_hashref;
1122 return $loanlength->{issuelength
}
1123 if defined($loanlength) && $loanlength->{issuelength
} ne 'NULL';
1125 $sth->execute( "*", $itemtype, "*" );
1126 $loanlength = $sth->fetchrow_hashref;
1127 return $loanlength->{issuelength
}
1128 if defined($loanlength) && $loanlength->{issuelength
} ne 'NULL';
1130 $sth->execute( "*", "*", "*" );
1131 $loanlength = $sth->fetchrow_hashref;
1132 return $loanlength->{issuelength
}
1133 if defined($loanlength) && $loanlength->{issuelength
} ne 'NULL';
1135 # if no rule is set => 21 days (hardcoded)
1139 =head2 GetIssuingRule
1141 FIXME - This is a copy-paste of GetLoanLength
1142 as a stop-gap. Do not wish to change API for GetLoanLength
1143 this close to release, however, Overdues::GetIssuingRules is broken.
1145 Get the issuing rule for an itemtype, a borrower type and a branch
1146 Returns a hashref from the issuingrules table.
1148 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1152 sub GetIssuingRule
{
1153 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1154 my $dbh = C4
::Context
->dbh;
1155 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1158 $sth->execute( $borrowertype, $itemtype, $branchcode );
1159 $irule = $sth->fetchrow_hashref;
1160 return $irule if defined($irule) ;
1162 $sth->execute( $borrowertype, "*", $branchcode );
1163 $irule = $sth->fetchrow_hashref;
1164 return $irule if defined($irule) ;
1166 $sth->execute( "*", $itemtype, $branchcode );
1167 $irule = $sth->fetchrow_hashref;
1168 return $irule if defined($irule) ;
1170 $sth->execute( "*", "*", $branchcode );
1171 $irule = $sth->fetchrow_hashref;
1172 return $irule if defined($irule) ;
1174 $sth->execute( $borrowertype, $itemtype, "*" );
1175 $irule = $sth->fetchrow_hashref;
1176 return $irule if defined($irule) ;
1178 $sth->execute( $borrowertype, "*", "*" );
1179 $irule = $sth->fetchrow_hashref;
1180 return $irule if defined($irule) ;
1182 $sth->execute( "*", $itemtype, "*" );
1183 $irule = $sth->fetchrow_hashref;
1184 return $irule if defined($irule) ;
1186 $sth->execute( "*", "*", "*" );
1187 $irule = $sth->fetchrow_hashref;
1188 return $irule if defined($irule) ;
1190 # if no rule matches,
1194 =head2 GetBranchBorrowerCircRule
1198 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1202 Retrieves circulation rule attributes that apply to the given
1203 branch and patron category, regardless of item type.
1204 The return value is a hashref containing the following key:
1206 maxissueqty - maximum number of loans that a
1207 patron of the given category can have at the given
1208 branch. If the value is undef, no limit.
1210 This will first check for a specific branch and
1211 category match from branch_borrower_circ_rules.
1213 If no rule is found, it will then check default_branch_circ_rules
1214 (same branch, default category). If no rule is found,
1215 it will then check default_borrower_circ_rules (default
1216 branch, same category), then failing that, default_circ_rules
1217 (default branch, default category).
1219 If no rule has been found in the database, it will default to
1224 C<$branchcode> and C<$categorycode> should contain the
1225 literal branch code and patron category code, respectively - no
1230 sub GetBranchBorrowerCircRule
{
1231 my $branchcode = shift;
1232 my $categorycode = shift;
1234 my $branch_cat_query = "SELECT maxissueqty
1235 FROM branch_borrower_circ_rules
1236 WHERE branchcode = ?
1237 AND categorycode = ?";
1238 my $dbh = C4
::Context
->dbh();
1239 my $sth = $dbh->prepare($branch_cat_query);
1240 $sth->execute($branchcode, $categorycode);
1242 if ($result = $sth->fetchrow_hashref()) {
1246 # try same branch, default borrower category
1247 my $branch_query = "SELECT maxissueqty
1248 FROM default_branch_circ_rules
1249 WHERE branchcode = ?";
1250 $sth = $dbh->prepare($branch_query);
1251 $sth->execute($branchcode);
1252 if ($result = $sth->fetchrow_hashref()) {
1256 # try default branch, same borrower category
1257 my $category_query = "SELECT maxissueqty
1258 FROM default_borrower_circ_rules
1259 WHERE categorycode = ?";
1260 $sth = $dbh->prepare($category_query);
1261 $sth->execute($categorycode);
1262 if ($result = $sth->fetchrow_hashref()) {
1266 # try default branch, default borrower category
1267 my $default_query = "SELECT maxissueqty
1268 FROM default_circ_rules";
1269 $sth = $dbh->prepare($default_query);
1271 if ($result = $sth->fetchrow_hashref()) {
1275 # built-in default circulation rule
1277 maxissueqty
=> undef,
1281 =head2 GetBranchItemRule
1285 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1289 Retrieves circulation rule attributes that apply to the given
1290 branch and item type, regardless of patron category.
1292 The return value is a hashref containing the following key:
1294 holdallowed => Hold policy for this branch and itemtype. Possible values:
1295 0: No holds allowed.
1296 1: Holds allowed only by patrons that have the same homebranch as the item.
1297 2: Holds allowed from any patron.
1299 This searches branchitemrules in the following order:
1301 * Same branchcode and itemtype
1302 * Same branchcode, itemtype '*'
1303 * branchcode '*', same itemtype
1304 * branchcode and itemtype '*'
1306 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1310 sub GetBranchItemRule
{
1311 my ( $branchcode, $itemtype ) = @_;
1312 my $dbh = C4
::Context
->dbh();
1316 ['SELECT holdallowed
1317 FROM branch_item_rules
1318 WHERE branchcode = ?
1319 AND itemtype = ?', $branchcode, $itemtype],
1320 ['SELECT holdallowed
1321 FROM default_branch_circ_rules
1322 WHERE branchcode = ?', $branchcode],
1323 ['SELECT holdallowed
1324 FROM default_branch_item_rules
1325 WHERE itemtype = ?', $itemtype],
1326 ['SELECT holdallowed
1327 FROM default_circ_rules'],
1330 foreach my $attempt (@attempts) {
1331 my ($query, @bind_params) = @
{$attempt};
1333 # Since branch/category and branch/itemtype use the same per-branch
1334 # defaults tables, we have to check that the key we want is set, not
1335 # just that a row was returned
1336 return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1339 # built-in default circulation rule
1347 ($doreturn, $messages, $iteminformation, $borrower) =
1348 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1354 =item C<$barcode> is the bar code of the book being returned.
1356 =item C<$branch> is the code of the branch where the book is being returned.
1358 =item C<$exemptfine> indicates that overdue charges for the item will be
1361 =item C<$dropbox> indicates that the check-in date is assumed to be
1362 yesterday, or the last non-holiday as defined in C4::Calendar . If
1363 overdue charges are applied and C<$dropbox> is true, the last charge
1364 will be removed. This assumes that the fines accrual script has run
1369 C<&AddReturn> returns a list of four items:
1371 C<$doreturn> is true iff the return succeeded.
1373 C<$messages> is a reference-to-hash giving feedback on the operation.
1374 The keys of the hash are:
1380 No item with this barcode exists. The value is C<$barcode>.
1384 The book is not currently on loan. The value is C<$barcode>.
1386 =item C<IsPermanent>
1388 The book's home branch is a permanent collection. If you have borrowed
1389 this book, you are not allowed to return it. The value is the code for
1390 the book's home branch.
1394 This book has been withdrawn/cancelled. The value should be ignored.
1396 =item C<Wrongbranch>
1398 This book has was returned to the wrong branch. The value is a hashref
1399 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1400 contain the branchcode of the incorrect and correct return library, respectively.
1404 The item was reserved. The value is a reference-to-hash whose keys are
1405 fields from the reserves table of the Koha database, and
1406 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1407 either C<Waiting>, C<Reserved>, or 0.
1411 C<$iteminformation> is a reference-to-hash, giving information about the
1412 returned item from the issues table.
1414 C<$borrower> is a reference-to-hash, giving information about the
1415 patron who last borrowed the book.
1420 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1421 if ($branch and not GetBranchDetail
($branch)) {
1422 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4
::Context
->userenv->{'branch'};
1425 $branch = C4
::Context
->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1430 my $validTransfert = 0;
1432 # get information on item
1433 my $itemnumber = GetItemnumberFromBarcode
( $barcode );
1434 unless ($itemnumber) {
1435 return (0, { BadBarcode
=> $barcode }); # no barcode means no item or borrower. bail out.
1437 my $issue = GetItemIssue
($itemnumber);
1438 # warn Dumper($iteminformation);
1439 if ($issue and $issue->{borrowernumber
}) {
1440 $borrower = C4
::Members
::GetMemberDetails
($issue->{borrowernumber
})
1441 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1442 . Dumper
($issue) . "\n";
1444 $messages->{'NotIssued'} = $barcode;
1445 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1447 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1450 my $item = GetItem
($itemnumber) or die "GetItem($itemnumber) failed";
1451 # full item data, but no borrowernumber or checkout info (no issue)
1452 # we know GetItem should work because GetItemnumberFromBarcode worked
1453 my $hbr = $item->{C4
::Context
->preference("HomeOrHoldingBranch")} || '';
1454 # item must be from items table -- issues table has branchcode and issuingbranch, not homebranch nor holdingbranch
1456 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1458 # check if the book is in a permanent collection....
1459 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1461 my $branches = GetBranches
(); # a potentially expensive call for a non-feature.
1462 $branches->{$hbr}->{PE
} and $messages->{'IsPermanent'} = $hbr;
1465 # if indy branches and returning to different branch, refuse the return
1466 if ($hbr ne $branch && C4
::Context
->preference("IndependantBranches")){
1467 $messages->{'Wrongbranch'} = {
1468 Wrongbranch
=> $branch,
1469 Rightbranch
=> $hbr,
1472 # bailing out here - in this case, current desired behavior
1473 # is to act as if no return ever happened at all.
1474 # FIXME - even in an indy branches situation, there should
1475 # still be an option for the library to accept the item
1476 # and transfer it to its owning library.
1477 return ( $doreturn, $messages, $issue, $borrower );
1480 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1481 $messages->{'wthdrawn'} = 1;
1485 # case of a return of document (deal with issues and holdingbranch)
1487 $borrower or warn "AddReturn without current borrower";
1488 my $circControlBranch;
1490 # define circControlBranch only if dropbox mode is set
1491 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1492 # FIXME: check issuedate > returndate, factoring in holidays
1493 $circControlBranch = _GetCircControlBranch
($item,$borrower) unless ( $item->{'issuedate'} eq C4
::Dates
->today('iso') );;
1496 if ($borrowernumber) {
1497 MarkIssueReturned
($borrowernumber, $item->{'itemnumber'}, $circControlBranch);
1498 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right? This could be the borrower hash.
1501 ModItem
({ onloan
=> undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1504 # the holdingbranch is updated if the document is returned to another location.
1505 # this is always done regardless of whether the item was on loan or not
1506 if ($item->{'holdingbranch'} ne $branch) {
1507 UpdateHoldingbranch
($branch, $item->{'itemnumber'});
1508 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1510 ModDateLastSeen
( $item->{'itemnumber'} );
1512 # check if we have a transfer for this document
1513 my ($datesent,$frombranch,$tobranch) = GetTransfers
( $item->{'itemnumber'} );
1515 # if we have a transfer to do, we update the line of transfers with the datearrived
1517 if ( $tobranch eq $branch ) {
1518 my $sth = C4
::Context
->dbh->prepare(
1519 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1521 $sth->execute( $item->{'itemnumber'} );
1522 # if we have a reservation with valid transfer, we can set it's status to 'W'
1523 C4
::Reserves
::ModReserveStatus
($item->{'itemnumber'}, 'W');
1525 $messages->{'WrongTransfer'} = $tobranch;
1526 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1528 $validTransfert = 1;
1531 # fix up the accounts.....
1532 if ($item->{'itemlost'}) {
1533 _FixAccountForLostAndReturned
($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1534 $messages->{'WasLost'} = 1;
1537 # fix up the overdues in accounts...
1538 if ($borrowernumber) {
1539 my $fix = _FixOverduesOnReturn
($borrowernumber, $item->{itemnumber
}, $exemptfine, $dropbox);
1540 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1543 # find reserves.....
1544 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1545 my ($resfound, $resrec) = C4
::Reserves
::CheckReserves
( $item->{'itemnumber'} );
1547 $resrec->{'ResFound'} = $resfound;
1548 $messages->{'ResFound'} = $resrec;
1552 # Record the fact that this book was returned.
1554 $branch, 'return', '0', '',
1555 $item->{'itemnumber'},
1556 $biblio->{'itemtype'},
1560 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1561 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1563 branchcode
=> $branch,
1564 categorycode
=> $borrower->{categorycode
},
1565 item_type
=> $item->{itype
},
1566 notification
=> 'CHECKIN',
1568 if ($doreturn && $circulation_alert->is_enabled_for(\
%conditions)) {
1569 SendCirculationAlert
({
1572 borrower
=> $borrower,
1577 logaction
("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1578 if C4
::Context
->preference("ReturnLog");
1580 # FIXME: make this comment intelligible.
1581 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1582 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1584 if ($doreturn and ($branch ne $hbr) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) ){
1585 if ( C4
::Context
->preference("AutomaticItemReturn" ) or
1586 (C4
::Context
->preference("UseBranchTransferLimits") and
1587 ! IsBranchTransferAllowed
($branch, $hbr, $item->{C4
::Context
->preference("BranchTransferLimitsType")} )
1589 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1590 $debug and warn "item: " . Dumper
($item);
1591 ModItemTransfer
($item->{'itemnumber'}, $branch, $hbr);
1592 $messages->{'WasTransfered'} = 1;
1594 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1597 return ( $doreturn, $messages, $issue, $borrower );
1600 =head2 MarkIssueReturned
1604 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate);
1608 Unconditionally marks an issue as being returned by
1609 moving the C<issues> row to C<old_issues> and
1610 setting C<returndate> to the current date, or
1611 the last non-holiday date of the branccode specified in
1612 C<dropbox_branch> . Assumes you've already checked that
1613 it's safe to do this, i.e. last non-holiday > issuedate.
1615 if C<$returndate> is specified (in iso format), it is used as the date
1616 of the return. It is ignored when a dropbox_branch is passed in.
1618 Ideally, this function would be internal to C<C4::Circulation>,
1619 not exported, but it is currently needed by one
1620 routine in C<C4::Accounts>.
1624 sub MarkIssueReturned
{
1625 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate ) = @_;
1626 my $dbh = C4
::Context
->dbh;
1627 my $query = "UPDATE issues SET returndate=";
1629 if ($dropbox_branch) {
1630 my $calendar = C4
::Calendar
->new( branchcode
=> $dropbox_branch );
1631 my $dropboxdate = $calendar->addDate( C4
::Dates
->new(), -1 );
1633 push @bind, $dropboxdate->output('iso');
1634 } elsif ($returndate) {
1636 push @bind, $returndate;
1638 $query .= " now() ";
1640 $query .= " WHERE borrowernumber = ? AND itemnumber = ?";
1641 push @bind, $borrowernumber, $itemnumber;
1643 my $sth_upd = $dbh->prepare($query);
1644 $sth_upd->execute(@bind);
1645 my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1646 WHERE borrowernumber = ?
1647 AND itemnumber = ?");
1648 $sth_copy->execute($borrowernumber, $itemnumber);
1649 my $sth_del = $dbh->prepare("DELETE FROM issues
1650 WHERE borrowernumber = ?
1651 AND itemnumber = ?");
1652 $sth_del->execute($borrowernumber, $itemnumber);
1655 =head2 _FixOverduesOnReturn
1657 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1659 C<$brn> borrowernumber
1663 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1664 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1666 Internal function, called only by AddReturn
1670 sub _FixOverduesOnReturn
{
1671 my ($borrowernumber, $item);
1672 unless ($borrowernumber = shift) {
1673 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1676 unless ($item = shift) {
1677 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1680 my ($exemptfine, $dropbox) = @_;
1681 my $dbh = C4
::Context
->dbh;
1683 # check for overdue fine
1684 my $sth = $dbh->prepare(
1685 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1687 $sth->execute( $borrowernumber, $item );
1689 # alter fine to show that the book has been returned
1690 my $data = $sth->fetchrow_hashref;
1691 return 0 unless $data; # no warning, there's just nothing to fix
1694 my @bind = ($borrowernumber, $item, $data->{'accountno'});
1696 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1697 if (C4
::Context
->preference("FinesLog")) {
1698 &logaction
("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1700 } elsif ($dropbox && $data->{lastincrement
}) {
1701 my $outstanding = $data->{amountoutstanding
} - $data->{lastincrement
} ;
1702 my $amt = $data->{amount
} - $data->{lastincrement
} ;
1703 if (C4
::Context
->preference("FinesLog")) {
1704 &logaction
("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1706 $uquery = "update accountlines set accounttype='F' ";
1707 if($outstanding >= 0 && $amt >=0) {
1708 $uquery .= ", amount = ? , amountoutstanding=? ";
1709 unshift @bind, ($amt, $outstanding) ;
1712 $uquery = "update accountlines set accounttype='F' ";
1714 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1715 my $usth = $dbh->prepare($uquery);
1716 return $usth->execute(@bind);
1719 =head2 _FixAccountForLostAndReturned
1721 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1723 Calculates the charge for a book lost and returned.
1725 Internal function, not exported, called only by AddReturn.
1727 FIXME: This function reflects how inscrutable fines logic is. Fix both.
1728 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
1732 sub _FixAccountForLostAndReturned
{
1733 my $itemnumber = shift or return;
1734 my $borrowernumber = @_ ?
shift : undef;
1735 my $item_id = @_ ?
shift : $itemnumber; # Send the barcode if you want that logged in the description
1736 my $dbh = C4
::Context
->dbh;
1737 # check for charge made for lost book
1738 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1739 $sth->execute($itemnumber);
1740 my $data = $sth->fetchrow_hashref;
1741 $data or return; # bail if there is nothing to do
1743 # writeoff this amount
1745 my $amount = $data->{'amount'};
1746 my $acctno = $data->{'accountno'};
1747 my $amountleft; # Starts off undef/zero.
1748 if ($data->{'amountoutstanding'} == $amount) {
1749 $offset = $data->{'amount'};
1750 $amountleft = 0; # Hey, it's zero here, too.
1752 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
1753 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
1755 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1756 WHERE (borrowernumber = ?)
1757 AND (itemnumber = ?) AND (accountno = ?) ");
1758 $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
1759 #check if any credit is left if so writeoff other accounts
1760 my $nextaccntno = getnextacctno
($data->{'borrowernumber'});
1761 $amountleft *= -1 if ($amountleft < 0);
1762 if ($amountleft > 0) {
1763 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1764 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
1765 $msth->execute($data->{'borrowernumber'});
1766 # offset transactions
1769 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1770 if ($accdata->{'amountoutstanding'} < $amountleft) {
1772 $amountleft -= $accdata->{'amountoutstanding'};
1774 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1777 my $thisacct = $accdata->{'accountno'};
1778 # FIXME: move prepares outside while loop!
1779 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1780 WHERE (borrowernumber = ?)
1781 AND (accountno=?)");
1782 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct'); # FIXME: '$thisacct' is a string literal!
1783 $usth = $dbh->prepare("INSERT INTO accountoffsets
1784 (borrowernumber, accountno, offsetaccount, offsetamount)
1787 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1789 $msth->finish; # $msth might actually have data left
1791 $amountleft *= -1 if ($amountleft > 0);
1792 my $desc = "Item Returned " . $item_id;
1793 $usth = $dbh->prepare("INSERT INTO accountlines
1794 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1795 VALUES (?,?,now(),?,?,'CR',?)");
1796 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1797 if ($borrowernumber) {
1798 # FIXME: same as query above. use 1 sth for both
1799 $usth = $dbh->prepare("INSERT INTO accountoffsets
1800 (borrowernumber, accountno, offsetaccount, offsetamount)
1802 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
1804 ModItem
({ paidfor
=> '' }, undef, $itemnumber);
1808 =head2 _GetCircControlBranch
1810 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
1814 Return the library code to be used to determine which circulation
1815 policy applies to a transaction. Looks up the CircControl and
1816 HomeOrHoldingBranch system preferences.
1818 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
1820 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
1824 sub _GetCircControlBranch
{
1825 my ($item, $borrower) = @_;
1826 my $circcontrol = C4
::Context
->preference('CircControl');
1829 if ($circcontrol eq 'PickupLibrary') {
1830 $branch= C4
::Context
->userenv->{'branch'};
1831 } elsif ($circcontrol eq 'PatronLibrary') {
1832 $branch=$borrower->{branchcode
};
1834 my $branchfield = C4
::Context
->preference('HomeOrHoldingBranch') || 'homebranch';
1835 $branch = $item->{$branchfield};
1836 # default to item home branch if holdingbranch is used
1837 # and is not defined
1838 if (!defined($branch) && $branchfield eq 'holdingbranch') {
1839 $branch = $item->{homebranch
};
1852 $issue = &GetItemIssue($itemnumber);
1854 Returns patron currently having a book, or undef if not checked out.
1856 C<$itemnumber> is the itemnumber.
1858 C<$issue> is a hashref of the row from the issues table.
1863 my ($itemnumber) = @_;
1864 return unless $itemnumber;
1865 my $sth = C4
::Context
->dbh->prepare(
1868 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1869 WHERE issues.itemnumber=?");
1870 $sth->execute($itemnumber);
1871 my $data = $sth->fetchrow_hashref;
1872 return unless $data;
1873 $data->{'overdue'} = ($data->{'date_due'} lt C4
::Dates
->today('iso')) ?
1 : 0;
1879 $issue = GetOpenIssue( $itemnumber );
1881 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1883 C<$itemnumber> is the item's itemnumber
1890 my ( $itemnumber ) = @_;
1892 my $dbh = C4
::Context
->dbh;
1893 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1894 $sth->execute( $itemnumber );
1895 my $issue = $sth->fetchrow_hashref();
1899 =head2 GetItemIssues
1901 $issues = &GetItemIssues($itemnumber, $history);
1903 Returns patrons that have issued a book
1905 C<$itemnumber> is the itemnumber
1906 C<$history> is false if you just want the current "issuer" (if any)
1907 and true if you want issues history from old_issues also.
1909 Returns reference to an array of hashes
1914 my ( $itemnumber, $history ) = @_;
1916 my $today = C4
::Dates
->today('iso'); # get today date
1917 my $sql = "SELECT * FROM issues
1918 JOIN borrowers USING (borrowernumber)
1919 JOIN items USING (itemnumber)
1920 WHERE issues.itemnumber = ? ";
1923 SELECT * FROM old_issues
1924 LEFT JOIN borrowers USING (borrowernumber)
1925 JOIN items USING (itemnumber)
1926 WHERE old_issues.itemnumber = ? ";
1928 $sql .= "ORDER BY date_due DESC";
1929 my $sth = C4
::Context
->dbh->prepare($sql);
1931 $sth->execute($itemnumber, $itemnumber);
1933 $sth->execute($itemnumber);
1935 my $results = $sth->fetchall_arrayref({});
1936 foreach (@
$results) {
1937 $_->{'overdue'} = ($_->{'date_due'} lt $today) ?
1 : 0;
1942 =head2 GetBiblioIssues
1944 $issues = GetBiblioIssues($biblionumber);
1946 this function get all issues from a biblionumber.
1949 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1950 tables issues and the firstname,surname & cardnumber from borrowers.
1954 sub GetBiblioIssues
{
1955 my $biblionumber = shift;
1956 return undef unless $biblionumber;
1957 my $dbh = C4
::Context
->dbh;
1959 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1961 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1962 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1963 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1964 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1965 WHERE biblio.biblionumber = ?
1967 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1969 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1970 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1971 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1972 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1973 WHERE biblio.biblionumber = ?
1976 my $sth = $dbh->prepare($query);
1977 $sth->execute($biblionumber, $biblionumber);
1980 while ( my $data = $sth->fetchrow_hashref ) {
1981 push @issues, $data;
1986 =head2 GetUpcomingDueIssues
1990 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
1996 sub GetUpcomingDueIssues
{
1999 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2000 my $dbh = C4
::Context
->dbh;
2002 my $statement = <<END_SQL;
2003 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
2005 LEFT JOIN items USING (itemnumber)
2006 WhERE returndate is NULL
2007 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
2010 my @bind_parameters = ( $params->{'days_in_advance'} );
2012 my $sth = $dbh->prepare( $statement );
2013 $sth->execute( @bind_parameters );
2014 my $upcoming_dues = $sth->fetchall_arrayref({});
2017 return $upcoming_dues;
2020 =head2 CanBookBeRenewed
2022 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2024 Find out whether a borrowed item may be renewed.
2026 C<$dbh> is a DBI handle to the Koha database.
2028 C<$borrowernumber> is the borrower number of the patron who currently
2029 has the item on loan.
2031 C<$itemnumber> is the number of the item to renew.
2033 C<$override_limit>, if supplied with a true value, causes
2034 the limit on the number of times that the loan can be renewed
2035 (as controlled by the item type) to be ignored.
2037 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2038 item must currently be on loan to the specified borrower; renewals
2039 must be allowed for the item's type; and the borrower must not have
2040 already renewed the loan. $error will contain the reason the renewal can not proceed
2044 sub CanBookBeRenewed {
2046 # check renewal status
2047 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2048 my $dbh = C4::Context->dbh;
2053 # Look in the issues table for this item, lent to this borrower,
2054 # and not yet returned.
2056 # Look in the issues table for this item, lent to this borrower,
2057 # and not yet returned.
2059 'ItemHomeLibrary' => 'items.homebranch',
2060 'PickupLibrary' => 'items.holdingbranch',
2061 'PatronLibrary' => 'borrowers.branchcode'
2063 my $controlbranch = $branch{C4::Context->preference('CircControl')};
2064 my $itype = C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype';
2066 my $sthcount = $dbh->prepare("
2068 borrowers.categorycode, biblioitems.itemtype, issues.renewals, renewalsallowed, $controlbranch
2071 LEFT JOIN items USING (itemnumber)
2072 LEFT JOIN borrowers USING (borrowernumber)
2073 LEFT JOIN biblioitems USING (biblioitemnumber)
2076 (issuingrules.categorycode = borrowers.categorycode OR issuingrules.categorycode = '*')
2078 (issuingrules.itemtype = $itype OR issuingrules.itemtype = '*')
2080 (issuingrules.branchcode = $controlbranch OR issuingrules.branchcode = '*')
2086 issuingrules.categorycode desc,
2087 issuingrules.itemtype desc,
2088 issuingrules.branchcode desc
2092 $sthcount->execute( $borrowernumber, $itemnumber );
2093 if ( my $data1 = $sthcount->fetchrow_hashref ) {
2095 if ( ( $data1->{renewalsallowed} && $data1->{renewalsallowed} > $data1->{renewals} ) || $override_limit ) {
2102 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2109 return ($renewokay,$error);
2114 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2118 C<$borrowernumber> is the borrower number of the patron who currently
2121 C<$itemnumber> is the number of the item to renew.
2123 C<$branch> is the library where the renewal took place (if any).
2124 The library that controls the circ policies for the renewal is retrieved from the issues record.
2126 C<$datedue> can be a C4::Dates object used to set the due date.
2128 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2129 this parameter is not supplied, lastreneweddate is set to the current date.
2131 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2132 from the book's item type.
2137 my $borrowernumber = shift or return undef;
2138 my $itemnumber = shift or return undef;
2140 my $datedue = shift;
2141 my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2142 my $item = GetItem($itemnumber) or return undef;
2143 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2145 my $dbh = C4::Context->dbh;
2146 # Find the issues record for this book
2148 $dbh->prepare("SELECT * FROM issues
2149 WHERE borrowernumber=?
2152 $sth->execute( $borrowernumber, $itemnumber );
2153 my $issuedata = $sth->fetchrow_hashref;
2155 if($datedue && ! $datedue->output('iso')){
2156 warn "Invalid date passed to AddRenewal.";
2159 # If the due date wasn't specified, calculate it by adding the
2160 # book's loan length to today's date or the current due date
2161 # based on the value of the RenewalPeriodBase syspref.
2164 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2165 my $loanlength = GetLoanLength(
2166 $borrower->{'categorycode'},
2167 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2168 $issuedata->{'branchcode'} ); # that's the circ control branch.
2170 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2171 C4::Dates->new($issuedata->{date_due}, 'iso') :
2173 $datedue = CalcDateDue($datedue,$loanlength,$issuedata->{'branchcode'},$borrower);
2176 # Update the issues record to have the new due date, and a new count
2177 # of how many times it has been renewed.
2178 my $renews = $issuedata->{'renewals'} + 1;
2179 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2180 WHERE borrowernumber=?
2183 $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2186 # Update the renewal count on the item, and tell zebra to reindex
2187 $renews = $biblio->{'renewals'} + 1;
2188 ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2190 # Charge a new rental fee, if applicable?
2191 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2192 if ( $charge > 0 ) {
2193 my $accountno = getnextacctno( $borrowernumber );
2194 my $item = GetBiblioFromItemNumber($itemnumber);
2195 $sth = $dbh->prepare(
2196 "INSERT INTO accountlines
2198 borrowernumber, accountno, amount,
2200 accounttype, amountoutstanding, itemnumber
2202 VALUES (now(),?,?,?,?,?,?,?)"
2204 $sth->execute( $borrowernumber, $accountno, $charge,
2205 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2206 'Rent', $charge, $itemnumber );
2210 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2215 # check renewal status
2216 my ( $bornum, $itemno ) = @_;
2217 my $dbh = C4::Context->dbh;
2219 my $renewsallowed = 0;
2222 my $borrower = C4::Members::GetMemberDetails($bornum);
2223 my $item = GetItem($itemno);
2225 # Look in the issues table for this item, lent to this borrower,
2226 # and not yet returned.
2228 # FIXME - I think this function could be redone to use only one SQL call.
2229 my $sth = $dbh->prepare(
2230 "select * from issues
2231 where (borrowernumber = ?)
2232 and (itemnumber = ?)"
2234 $sth->execute( $bornum, $itemno );
2235 my $data = $sth->fetchrow_hashref;
2236 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2238 # $item and $borrower should be calculated
2239 my $branchcode = _GetCircControlBranch($item, $borrower);
2241 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2243 $renewsallowed = $issuingrule->{'renewalsallowed'};
2244 $renewsleft = $renewsallowed - $renewcount;
2245 if($renewsleft < 0){ $renewsleft = 0; }
2246 return ( $renewcount, $renewsallowed, $renewsleft );
2249 =head2 GetIssuingCharges
2251 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2253 Calculate how much it would cost for a given patron to borrow a given
2254 item, including any applicable discounts.
2256 C<$itemnumber> is the item number of item the patron wishes to borrow.
2258 C<$borrowernumber> is the patron's borrower number.
2260 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2261 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2266 sub GetIssuingCharges {
2268 # calculate charges due
2269 my ( $itemnumber, $borrowernumber ) = @_;
2271 my $dbh = C4::Context->dbh;
2274 # Get the book's item type and rental charge (via its biblioitem).
2275 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
2276 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2277 $qcharge .= (C4::Context->preference('item-level_itypes'))
2278 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2279 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2281 $qcharge .= "WHERE items.itemnumber =?";
2283 my $sth1 = $dbh->prepare($qcharge);
2284 $sth1->execute($itemnumber);
2285 if ( my $data1 = $sth1->fetchrow_hashref ) {
2286 $item_type = $data1->{'itemtype'};
2287 $charge = $data1->{'rentalcharge'};
2288 my $q2 = "SELECT rentaldiscount FROM borrowers
2289 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2290 WHERE borrowers.borrowernumber = ?
2291 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')";
2292 my $sth2 = $dbh->prepare($q2);
2293 $sth2->execute( $borrowernumber, $item_type );
2294 if ( my $data2 = $sth2->fetchrow_hashref ) {
2295 my $discount = $data2->{'rentaldiscount'};
2296 if ( $discount eq 'NULL' ) {
2299 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2305 return ( $charge, $item_type );
2308 =head2 AddIssuingCharge
2310 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2314 sub AddIssuingCharge {
2315 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2316 my $dbh = C4::Context->dbh;
2317 my $nextaccntno = getnextacctno( $borrowernumber );
2319 INSERT INTO accountlines
2320 (borrowernumber, itemnumber, accountno,
2321 date, amount, description, accounttype,
2323 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2325 my $sth = $dbh->prepare($query);
2326 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2332 GetTransfers($itemnumber);
2337 my ($itemnumber) = @_;
2339 my $dbh = C4::Context->dbh;
2345 FROM branchtransfers
2346 WHERE itemnumber = ?
2347 AND datearrived IS NULL
2349 my $sth = $dbh->prepare($query);
2350 $sth->execute($itemnumber);
2351 my @row = $sth->fetchrow_array();
2356 =head2 GetTransfersFromTo
2358 @results = GetTransfersFromTo($frombranch,$tobranch);
2360 Returns the list of pending transfers between $from and $to branch
2364 sub GetTransfersFromTo {
2365 my ( $frombranch, $tobranch ) = @_;
2366 return unless ( $frombranch && $tobranch );
2367 my $dbh = C4::Context->dbh;
2369 SELECT itemnumber,datesent,frombranch
2370 FROM branchtransfers
2373 AND datearrived IS NULL
2375 my $sth = $dbh->prepare($query);
2376 $sth->execute( $frombranch, $tobranch );
2379 while ( my $data = $sth->fetchrow_hashref ) {
2380 push @gettransfers, $data;
2383 return (@gettransfers);
2386 =head2 DeleteTransfer
2388 &DeleteTransfer($itemnumber);
2392 sub DeleteTransfer {
2393 my ($itemnumber) = @_;
2394 my $dbh = C4::Context->dbh;
2395 my $sth = $dbh->prepare(
2396 "DELETE FROM branchtransfers
2398 AND datearrived IS NULL "
2400 $sth->execute($itemnumber);
2404 =head2 AnonymiseIssueHistory
2406 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2408 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2409 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2411 return the number of affected rows.
2415 sub AnonymiseIssueHistory {
2417 my $borrowernumber = shift;
2418 my $dbh = C4::Context->dbh;
2421 SET borrowernumber = NULL
2422 WHERE returndate < '".$date."'
2423 AND borrowernumber IS NOT NULL
2425 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2426 my $rows_affected = $dbh->do($query);
2427 return $rows_affected;
2430 =head2 SendCirculationAlert
2432 Send out a C<check-in> or C<checkout> alert using the messaging system.
2440 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2444 Hashref of information about the item being checked in or out.
2448 Hashref of information about the borrower of the item.
2452 The branchcode from where the checkout or check-in took place.
2458 SendCirculationAlert({
2461 borrower => $borrower,
2467 sub SendCirculationAlert {
2469 my ($type, $item, $borrower, $branch) =
2470 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2471 my %message_name = (
2472 CHECKIN => 'Item Check-in',
2473 CHECKOUT => 'Item Checkout',
2475 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2476 borrowernumber => $borrower->{borrowernumber},
2477 message_name => $message_name{$type},
2479 my $letter = C4::Letters::getletter('circulation', $type);
2480 C4::Letters::parseletter($letter, 'biblio', $item->{biblionumber});
2481 C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2482 C4::Letters::parseletter($letter, 'borrowers', $borrower->{borrowernumber});
2483 C4::Letters::parseletter($letter, 'branches', $branch);
2484 my @transports = @{ $borrower_preferences->{transports} };
2485 # warn "no transports" unless @transports;
2487 # warn "transport: $_";
2488 my $message = C4::Message->find_last_message($borrower, $type, $_);
2490 #warn "create new message";
2491 C4::Message->enqueue($letter, $borrower, $_);
2493 #warn "append to old message";
2494 $message->append($letter);
2501 =head2 updateWrongTransfer
2503 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2505 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
2509 sub updateWrongTransfer {
2510 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2511 my $dbh = C4::Context->dbh;
2512 # first step validate the actual line of transfert .
2515 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2517 $sth->execute($FromLibrary,$itemNumber);
2520 # second step create a new line of branchtransfer to the right location .
2521 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2523 #third step changing holdingbranch of item
2524 UpdateHoldingbranch($FromLibrary,$itemNumber);
2527 =head2 UpdateHoldingbranch
2529 $items = UpdateHoldingbranch($branch,$itmenumber);
2530 Simple methode for updating hodlingbranch in items BDD line
2534 sub UpdateHoldingbranch {
2535 my ( $branch,$itemnumber ) = @_;
2536 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2541 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2542 this function calculates the due date given the loan length ,
2543 checking against the holidays calendar as per the 'useDaysMode' syspref.
2544 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2545 C<$branch> = location whose calendar to use
2546 C<$loanlength> = loan length prior to adjustment
2550 my ($startdate,$loanlength,$branch,$borrower) = @_;
2553 if(C4::Context->preference('useDaysMode') eq 'Days') { # ignoring calendar
2554 my $timedue = time + ($loanlength) * 86400;
2555 #FIXME - assumes now even though we take a startdate
2556 my @datearr = localtime($timedue);
2557 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2559 my $calendar = C4::Calendar->new( branchcode => $branch );
2560 $datedue = $calendar->addDate($startdate, $loanlength);
2563 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2564 if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2565 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2568 # if ceilingDueDate ON the datedue can't be after the ceiling date
2569 if ( C4::Context->preference('ceilingDueDate')
2570 && ( C4::Context->preference('ceilingDueDate') =~ C4::Dates->regexp('syspref') ) ) {
2571 my $ceilingDate = C4::Dates->new( C4::Context->preference('ceilingDueDate') );
2572 if ( $datedue->output( 'iso' ) gt $ceilingDate->output( 'iso' ) ) {
2573 $datedue = $ceilingDate;
2580 =head2 CheckValidDatedue
2581 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2582 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2584 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2585 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2586 C<$date_due> = returndate calculate with no day check
2587 C<$itemnumber> = itemnumber
2588 C<$branchcode> = location of issue (affected by 'CircControl' syspref)
2589 C<$loanlength> = loan length prior to adjustment
2592 sub CheckValidDatedue {
2593 my ($date_due,$itemnumber,$branchcode)=@_;
2594 my @datedue=split('-',$date_due->output('iso'));
2595 my $years=$datedue[0];
2596 my $month=$datedue[1];
2597 my $day=$datedue[2];
2598 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2600 for (my $i=0;$i<2;$i++){
2601 $dow=Day_of_Week($years,$month,$day);
2602 ($dow=0) if ($dow>6);
2603 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2604 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2605 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2606 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2608 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2611 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2616 =head2 CheckRepeatableHolidays
2618 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2619 this function checks if the date due is a repeatable holiday
2620 C<$date_due> = returndate calculate with no day check
2621 C<$itemnumber> = itemnumber
2622 C<$branchcode> = localisation of issue
2626 sub CheckRepeatableHolidays{
2627 my($itemnumber,$week_day,$branchcode)=@_;
2628 my $dbh = C4::Context->dbh;
2629 my $query = qq|SELECT count(*)
2630 FROM repeatable_holidays
2633 my $sth = $dbh->prepare($query);
2634 $sth->execute($branchcode,$week_day);
2635 my $result=$sth->fetchrow;
2641 =head2 CheckSpecialHolidays
2643 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2644 this function check if the date is a special holiday
2645 C<$years> = the years of datedue
2646 C<$month> = the month of datedue
2647 C<$day> = the day of datedue
2648 C<$itemnumber> = itemnumber
2649 C<$branchcode> = localisation of issue
2653 sub CheckSpecialHolidays{
2654 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2655 my $dbh = C4::Context->dbh;
2656 my $query=qq|SELECT count(*)
2657 FROM `special_holidays`
2663 my $sth = $dbh->prepare($query);
2664 $sth->execute($years,$month,$day,$branchcode);
2665 my $countspecial=$sth->fetchrow ;
2667 return $countspecial;
2670 =head2 CheckRepeatableSpecialHolidays
2672 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2673 this function check if the date is a repeatble special holidays
2674 C<$month> = the month of datedue
2675 C<$day> = the day of datedue
2676 C<$itemnumber> = itemnumber
2677 C<$branchcode> = localisation of issue
2681 sub CheckRepeatableSpecialHolidays{
2682 my ($month,$day,$itemnumber,$branchcode) = @_;
2683 my $dbh = C4::Context->dbh;
2684 my $query=qq|SELECT count(*)
2685 FROM `repeatable_holidays`
2690 my $sth = $dbh->prepare($query);
2691 $sth->execute($month,$day,$branchcode);
2692 my $countspecial=$sth->fetchrow ;
2694 return $countspecial;
2699 sub CheckValidBarcode{
2701 my $dbh = C4::Context->dbh;
2702 my $query=qq|SELECT count(*)
2706 my $sth = $dbh->prepare($query);
2707 $sth->execute($barcode);
2708 my $exist=$sth->fetchrow ;
2713 =head2 IsBranchTransferAllowed
2715 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2717 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2721 sub IsBranchTransferAllowed {
2722 my ( $toBranch, $fromBranch, $code ) = @_;
2724 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2726 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2727 my $dbh = C4::Context->dbh;
2729 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2730 $sth->execute( $toBranch, $fromBranch, $code );
2731 my $limit = $sth->fetchrow_hashref();
2733 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2734 if ( $limit->{'limitId'} ) {
2741 =head2 CreateBranchTransferLimit
2743 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2745 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2749 sub CreateBranchTransferLimit {
2750 my ( $toBranch, $fromBranch, $code ) = @_;
2752 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2754 my $dbh = C4::Context->dbh;
2756 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2757 $sth->execute( $code, $toBranch, $fromBranch );
2760 =head2 DeleteBranchTransferLimits
2762 DeleteBranchTransferLimits();
2766 sub DeleteBranchTransferLimits {
2767 my $dbh = C4::Context->dbh;
2768 my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2779 Koha Developement team <info@koha.org>