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 return( { STATS => 1 }, {});
694 if ( $borrower->{flags}->{GNA} ) {
695 $issuingimpossible{GNA} = 1;
697 if ( $borrower->{flags}->{'LOST'} ) {
698 $issuingimpossible{CARD_LOST} = 1;
700 if ( $borrower->{flags}->{'DBARRED'} ) {
701 $issuingimpossible{DEBARRED} = 1;
703 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
704 $issuingimpossible{EXPIRED} = 1;
706 my @expirydate= split /-/,$borrower->{'dateexpiry'};
707 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
708 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
709 $issuingimpossible{EXPIRED} = 1;
718 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
719 if ( C4::Context->preference("IssuingInProcess") ) {
720 my $amountlimit = C4::Context->preference("noissuescharge");
721 if ( $amount > $amountlimit && !$inprocess ) {
722 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
724 elsif ( $amount > 0 && $amount <= $amountlimit && !$inprocess ) {
725 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
730 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
734 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
735 if ($blocktype == -1) {
736 ## patron has outstanding overdue loans
737 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
738 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
740 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
741 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
743 } elsif($blocktype == 1) {
744 # patron has accrued fine days
745 $issuingimpossible{USERBLOCKEDREMAINING} = $count;
749 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
751 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
752 # if TooMany return / 0, then the user has no permission to check out this book
753 if ($toomany =~ /\/ 0/) {
754 $needsconfirmation{PATRON_CANT} = 1;
756 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
762 if ( $item->{'notforloan'}
763 && $item->{'notforloan'} > 0 )
765 if(!C4::Context->preference("AllowNotForLoanOverride")){
766 $issuingimpossible{NOT_FOR_LOAN} = 1;
768 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
771 elsif ( !$item->{'notforloan'} ){
772 # we have to check itemtypes.notforloan also
773 if (C4::Context->preference('item-level_itypes')){
774 # this should probably be a subroutine
775 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
776 $sth->execute($item->{'itemtype'});
777 my $notforloan=$sth->fetchrow_hashref();
779 if ($notforloan->{'notforloan'}) {
780 if (!C4::Context->preference("AllowNotForLoanOverride")) {
781 $issuingimpossible{NOT_FOR_LOAN} = 1;
783 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
787 elsif ($biblioitem->{'notforloan'} == 1){
788 if (!C4::Context->preference("AllowNotForLoanOverride")) {
789 $issuingimpossible{NOT_FOR_LOAN} = 1;
791 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
795 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
797 $issuingimpossible{WTHDRAWN} = 1;
799 if ( $item->{'restricted'}
800 && $item->{'restricted'} == 1 )
802 $issuingimpossible{RESTRICTED} = 1;
804 if ( C4::Context->preference("IndependantBranches") ) {
805 my $userenv = C4::Context->userenv;
806 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
807 $issuingimpossible{NOTSAMEBRANCH} = 1
808 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
813 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
815 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
818 # Already issued to current borrower. Ask whether the loan should
820 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
821 $borrower->{'borrowernumber'},
822 $item->{'itemnumber'}
824 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
825 $issuingimpossible{NO_MORE_RENEWALS} = 1;
828 $needsconfirmation{RENEW_ISSUE} = 1;
831 elsif ($issue->{borrowernumber}) {
833 # issued to someone else
834 my $currborinfo = C4::Members::GetMemberDetails( $issue->{borrowernumber} );
836 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
837 $needsconfirmation{ISSUED_TO_ANOTHER} =
838 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
841 # See if the item is on reserve.
842 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
844 my $resbor = $res->{'borrowernumber'};
845 my ( $resborrower ) = C4::Members::GetMemberDetails( $resbor, 0 );
846 my $branches = GetBranches();
847 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
848 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
850 # The item is on reserve and waiting, but has been
851 # reserved by some other patron.
852 $needsconfirmation{RESERVE_WAITING} =
853 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
855 elsif ( $restype eq "Reserved" ) {
856 # The item is on reserve for someone else.
857 $needsconfirmation{RESERVED} =
858 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
861 return ( \%issuingimpossible, \%needsconfirmation );
866 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
868 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
872 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
874 =item C<$barcode> is the barcode of the item being issued.
876 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
879 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
881 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
882 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
884 AddIssue does the following things :
886 - step 01: check that there is a borrowernumber & a barcode provided
887 - check for RENEWAL (book issued & being issued to the same patron)
888 - renewal YES = Calculate Charge & renew
890 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
892 - fill reserve if reserve to this patron
893 - cancel reserve or not, otherwise
894 * TRANSFERT PENDING ?
895 - complete the transfert
903 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
904 my $dbh = C4::Context->dbh;
905 my $barcodecheck=CheckValidBarcode($barcode);
907 # $issuedate defaults to today.
908 if ( ! defined $issuedate ) {
909 $issuedate = strftime( "%Y-%m-%d", localtime );
910 # TODO: for hourly circ, this will need to be a C4::Dates object
911 # and all calls to AddIssue including issuedate will need to pass a Dates object.
913 if ($borrower and $barcode and $barcodecheck ne '0'){
914 # find which item we issue
915 my $item = GetItem('', $barcode) or return undef; # if we don't get an Item, abort.
916 my $branch = _GetCircControlBranch($item,$borrower);
918 # get actual issuing if there is one
919 my $actualissue = GetItemIssue( $item->{itemnumber});
921 # get biblioinformation for this item
922 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
925 # check if we just renew the issue.
927 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
928 $datedue = AddRenewal(
929 $borrower->{'borrowernumber'},
930 $item->{'itemnumber'},
933 $issuedate, # here interpreted as the renewal date
938 if ( $actualissue->{borrowernumber}) {
939 # This book is currently on loan, but not to the person
940 # who wants to borrow it now. mark it returned before issuing to the new borrower
943 C4::Context->userenv->{'branch'}
947 # See if the item is on reserve.
948 my ( $restype, $res ) =
949 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
951 my $resbor = $res->{'borrowernumber'};
952 if ( $resbor eq $borrower->{'borrowernumber'} ) {
953 # The item is reserved by the current patron
954 ModReserveFill($res);
956 elsif ( $restype eq "Waiting" ) {
958 # The item is on reserve and waiting, but has been
959 # reserved by some other patron.
961 elsif ( $restype eq "Reserved" ) {
963 # The item is reserved by someone else.
964 if ($cancelreserve) { # cancel reserves on this item
965 CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
968 if ($cancelreserve) {
969 CancelReserve($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
972 # set waiting reserve to first in reserve queue as book isn't waiting now
974 $res->{'biblionumber'},
975 $res->{'borrowernumber'},
981 # Starting process for transfer job (checking transfert and validate it if we have one)
982 my ($datesent) = GetTransfers($item->{'itemnumber'});
984 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
987 "UPDATE branchtransfers
988 SET datearrived = now(),
990 comments = 'Forced branchtransfer'
991 WHERE itemnumber= ? AND datearrived IS NULL"
993 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
996 # Record in the database the fact that the book was issued.
1000 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1004 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1005 my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
1006 $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
1010 $borrower->{'borrowernumber'}, # borrowernumber
1011 $item->{'itemnumber'}, # itemnumber
1012 $issuedate, # issuedate
1013 $datedue->output('iso'), # date_due
1014 C4::Context->userenv->{'branch'} # branchcode
1017 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1018 CartToShelf( $item->{'itemnumber'} );
1020 $item->{'issues'}++;
1021 ModItem({ issues => $item->{'issues'},
1022 holdingbranch => C4::Context->userenv->{'branch'},
1024 datelastborrowed => C4::Dates->new()->output('iso'),
1025 onloan => $datedue->output('iso'),
1026 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1027 ModDateLastSeen( $item->{'itemnumber'} );
1029 # If it costs to borrow this book, charge it to the patron's account.
1030 my ( $charge, $itemtype ) = GetIssuingCharges(
1031 $item->{'itemnumber'},
1032 $borrower->{'borrowernumber'}
1034 if ( $charge > 0 ) {
1036 $item->{'itemnumber'},
1037 $borrower->{'borrowernumber'}, $charge
1039 $item->{'charge'} = $charge;
1042 # Record the fact that this book was issued.
1044 C4::Context->userenv->{'branch'},
1046 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1047 $item->{'itype'}, $borrower->{'borrowernumber'}
1050 # Send a checkout slip.
1051 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1053 branchcode => $branch,
1054 categorycode => $borrower->{categorycode},
1055 item_type => $item->{itype},
1056 notification => 'CHECKOUT',
1058 if ($circulation_alert->is_enabled_for(\%conditions)) {
1059 SendCirculationAlert({
1062 borrower => $borrower,
1068 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1069 if C4::Context->preference("IssueLog");
1071 return ($datedue); # not necessarily the same as when it came in!
1074 =head2 GetLoanLength
1076 Get loan length for an itemtype, a borrower type and a branch
1078 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1083 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1084 my $dbh = C4::Context->dbh;
1087 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1089 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1090 # try to find issuelength & return the 1st available.
1091 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1092 $sth->execute( $borrowertype, $itemtype, $branchcode );
1093 my $loanlength = $sth->fetchrow_hashref;
1094 return $loanlength->{issuelength}
1095 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1097 $sth->execute( $borrowertype, "*", $branchcode );
1098 $loanlength = $sth->fetchrow_hashref;
1099 return $loanlength->{issuelength}
1100 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1102 $sth->execute( "*", $itemtype, $branchcode );
1103 $loanlength = $sth->fetchrow_hashref;
1104 return $loanlength->{issuelength}
1105 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1107 $sth->execute( "*", "*", $branchcode );
1108 $loanlength = $sth->fetchrow_hashref;
1109 return $loanlength->{issuelength}
1110 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1112 $sth->execute( $borrowertype, $itemtype, "*" );
1113 $loanlength = $sth->fetchrow_hashref;
1114 return $loanlength->{issuelength}
1115 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1117 $sth->execute( $borrowertype, "*", "*" );
1118 $loanlength = $sth->fetchrow_hashref;
1119 return $loanlength->{issuelength}
1120 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1122 $sth->execute( "*", $itemtype, "*" );
1123 $loanlength = $sth->fetchrow_hashref;
1124 return $loanlength->{issuelength}
1125 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1127 $sth->execute( "*", "*", "*" );
1128 $loanlength = $sth->fetchrow_hashref;
1129 return $loanlength->{issuelength}
1130 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1132 # if no rule is set => 21 days (hardcoded)
1136 =head2 GetIssuingRule
1138 FIXME - This is a copy-paste of GetLoanLength
1139 as a stop-gap. Do not wish to change API for GetLoanLength
1140 this close to release, however, Overdues::GetIssuingRules is broken.
1142 Get the issuing rule for an itemtype, a borrower type and a branch
1143 Returns a hashref from the issuingrules table.
1145 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1149 sub GetIssuingRule {
1150 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1151 my $dbh = C4::Context->dbh;
1152 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1155 $sth->execute( $borrowertype, $itemtype, $branchcode );
1156 $irule = $sth->fetchrow_hashref;
1157 return $irule if defined($irule) ;
1159 $sth->execute( $borrowertype, "*", $branchcode );
1160 $irule = $sth->fetchrow_hashref;
1161 return $irule if defined($irule) ;
1163 $sth->execute( "*", $itemtype, $branchcode );
1164 $irule = $sth->fetchrow_hashref;
1165 return $irule if defined($irule) ;
1167 $sth->execute( "*", "*", $branchcode );
1168 $irule = $sth->fetchrow_hashref;
1169 return $irule if defined($irule) ;
1171 $sth->execute( $borrowertype, $itemtype, "*" );
1172 $irule = $sth->fetchrow_hashref;
1173 return $irule if defined($irule) ;
1175 $sth->execute( $borrowertype, "*", "*" );
1176 $irule = $sth->fetchrow_hashref;
1177 return $irule if defined($irule) ;
1179 $sth->execute( "*", $itemtype, "*" );
1180 $irule = $sth->fetchrow_hashref;
1181 return $irule if defined($irule) ;
1183 $sth->execute( "*", "*", "*" );
1184 $irule = $sth->fetchrow_hashref;
1185 return $irule if defined($irule) ;
1187 # if no rule matches,
1191 =head2 GetBranchBorrowerCircRule
1195 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1199 Retrieves circulation rule attributes that apply to the given
1200 branch and patron category, regardless of item type.
1201 The return value is a hashref containing the following key:
1203 maxissueqty - maximum number of loans that a
1204 patron of the given category can have at the given
1205 branch. If the value is undef, no limit.
1207 This will first check for a specific branch and
1208 category match from branch_borrower_circ_rules.
1210 If no rule is found, it will then check default_branch_circ_rules
1211 (same branch, default category). If no rule is found,
1212 it will then check default_borrower_circ_rules (default
1213 branch, same category), then failing that, default_circ_rules
1214 (default branch, default category).
1216 If no rule has been found in the database, it will default to
1221 C<$branchcode> and C<$categorycode> should contain the
1222 literal branch code and patron category code, respectively - no
1227 sub GetBranchBorrowerCircRule {
1228 my $branchcode = shift;
1229 my $categorycode = shift;
1231 my $branch_cat_query = "SELECT maxissueqty
1232 FROM branch_borrower_circ_rules
1233 WHERE branchcode = ?
1234 AND categorycode = ?";
1235 my $dbh = C4::Context->dbh();
1236 my $sth = $dbh->prepare($branch_cat_query);
1237 $sth->execute($branchcode, $categorycode);
1239 if ($result = $sth->fetchrow_hashref()) {
1243 # try same branch, default borrower category
1244 my $branch_query = "SELECT maxissueqty
1245 FROM default_branch_circ_rules
1246 WHERE branchcode = ?";
1247 $sth = $dbh->prepare($branch_query);
1248 $sth->execute($branchcode);
1249 if ($result = $sth->fetchrow_hashref()) {
1253 # try default branch, same borrower category
1254 my $category_query = "SELECT maxissueqty
1255 FROM default_borrower_circ_rules
1256 WHERE categorycode = ?";
1257 $sth = $dbh->prepare($category_query);
1258 $sth->execute($categorycode);
1259 if ($result = $sth->fetchrow_hashref()) {
1263 # try default branch, default borrower category
1264 my $default_query = "SELECT maxissueqty
1265 FROM default_circ_rules";
1266 $sth = $dbh->prepare($default_query);
1268 if ($result = $sth->fetchrow_hashref()) {
1272 # built-in default circulation rule
1274 maxissueqty => undef,
1278 =head2 GetBranchItemRule
1282 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1286 Retrieves circulation rule attributes that apply to the given
1287 branch and item type, regardless of patron category.
1289 The return value is a hashref containing the following key:
1291 holdallowed => Hold policy for this branch and itemtype. Possible values:
1292 0: No holds allowed.
1293 1: Holds allowed only by patrons that have the same homebranch as the item.
1294 2: Holds allowed from any patron.
1296 This searches branchitemrules in the following order:
1298 * Same branchcode and itemtype
1299 * Same branchcode, itemtype '*'
1300 * branchcode '*', same itemtype
1301 * branchcode and itemtype '*'
1303 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1307 sub GetBranchItemRule {
1308 my ( $branchcode, $itemtype ) = @_;
1309 my $dbh = C4::Context->dbh();
1313 ['SELECT holdallowed
1314 FROM branch_item_rules
1315 WHERE branchcode = ?
1316 AND itemtype = ?', $branchcode, $itemtype],
1317 ['SELECT holdallowed
1318 FROM default_branch_circ_rules
1319 WHERE branchcode = ?', $branchcode],
1320 ['SELECT holdallowed
1321 FROM default_branch_item_rules
1322 WHERE itemtype = ?', $itemtype],
1323 ['SELECT holdallowed
1324 FROM default_circ_rules'],
1327 foreach my $attempt (@attempts) {
1328 my ($query, @bind_params) = @{$attempt};
1330 # Since branch/category and branch/itemtype use the same per-branch
1331 # defaults tables, we have to check that the key we want is set, not
1332 # just that a row was returned
1333 return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1336 # built-in default circulation rule
1344 ($doreturn, $messages, $iteminformation, $borrower) =
1345 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1351 =item C<$barcode> is the bar code of the book being returned.
1353 =item C<$branch> is the code of the branch where the book is being returned.
1355 =item C<$exemptfine> indicates that overdue charges for the item will be
1358 =item C<$dropbox> indicates that the check-in date is assumed to be
1359 yesterday, or the last non-holiday as defined in C4::Calendar . If
1360 overdue charges are applied and C<$dropbox> is true, the last charge
1361 will be removed. This assumes that the fines accrual script has run
1366 C<&AddReturn> returns a list of four items:
1368 C<$doreturn> is true iff the return succeeded.
1370 C<$messages> is a reference-to-hash giving feedback on the operation.
1371 The keys of the hash are:
1377 No item with this barcode exists. The value is C<$barcode>.
1381 The book is not currently on loan. The value is C<$barcode>.
1383 =item C<IsPermanent>
1385 The book's home branch is a permanent collection. If you have borrowed
1386 this book, you are not allowed to return it. The value is the code for
1387 the book's home branch.
1391 This book has been withdrawn/cancelled. The value should be ignored.
1393 =item C<Wrongbranch>
1395 This book has was returned to the wrong branch. The value is a hashref
1396 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1397 contain the branchcode of the incorrect and correct return library, respectively.
1401 The item was reserved. The value is a reference-to-hash whose keys are
1402 fields from the reserves table of the Koha database, and
1403 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1404 either C<Waiting>, C<Reserved>, or 0.
1408 C<$iteminformation> is a reference-to-hash, giving information about the
1409 returned item from the issues table.
1411 C<$borrower> is a reference-to-hash, giving information about the
1412 patron who last borrowed the book.
1417 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1418 if ($branch and not GetBranchDetail($branch)) {
1419 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1422 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1427 my $validTransfert = 0;
1429 # get information on item
1430 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1431 unless ($itemnumber) {
1432 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1434 my $issue = GetItemIssue($itemnumber);
1435 # warn Dumper($iteminformation);
1436 if ($issue and $issue->{borrowernumber}) {
1437 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1438 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1439 . Dumper($issue) . "\n";
1441 $messages->{'NotIssued'} = $barcode;
1442 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1444 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1447 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1448 # full item data, but no borrowernumber or checkout info (no issue)
1449 # we know GetItem should work because GetItemnumberFromBarcode worked
1450 my $hbr = $item->{C4::Context->preference("HomeOrHoldingBranch")} || '';
1451 # item must be from items table -- issues table has branchcode and issuingbranch, not homebranch nor holdingbranch
1453 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1455 # check if the book is in a permanent collection....
1456 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1458 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1459 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1462 # if indy branches and returning to different branch, refuse the return
1463 if ($hbr ne $branch && C4::Context->preference("IndependantBranches")){
1464 $messages->{'Wrongbranch'} = {
1465 Wrongbranch => $branch,
1466 Rightbranch => $hbr,
1469 # bailing out here - in this case, current desired behavior
1470 # is to act as if no return ever happened at all.
1471 # FIXME - even in an indy branches situation, there should
1472 # still be an option for the library to accept the item
1473 # and transfer it to its owning library.
1474 return ( $doreturn, $messages, $issue, $borrower );
1477 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1478 $messages->{'wthdrawn'} = 1;
1482 # case of a return of document (deal with issues and holdingbranch)
1484 $borrower or warn "AddReturn without current borrower";
1485 my $circControlBranch;
1487 # define circControlBranch only if dropbox mode is set
1488 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1489 # FIXME: check issuedate > returndate, factoring in holidays
1490 $circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1493 if ($borrowernumber) {
1494 MarkIssueReturned($borrowernumber, $item->{'itemnumber'}, $circControlBranch);
1495 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right? This could be the borrower hash.
1498 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1501 # the holdingbranch is updated if the document is returned to another location.
1502 # this is always done regardless of whether the item was on loan or not
1503 if ($item->{'holdingbranch'} ne $branch) {
1504 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1505 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1507 ModDateLastSeen( $item->{'itemnumber'} );
1509 # check if we have a transfer for this document
1510 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1512 # if we have a transfer to do, we update the line of transfers with the datearrived
1514 if ( $tobranch eq $branch ) {
1515 my $sth = C4::Context->dbh->prepare(
1516 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1518 $sth->execute( $item->{'itemnumber'} );
1519 # if we have a reservation with valid transfer, we can set it's status to 'W'
1520 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1522 $messages->{'WrongTransfer'} = $tobranch;
1523 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1525 $validTransfert = 1;
1528 # fix up the accounts.....
1529 if ($item->{'itemlost'}) {
1530 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1531 $messages->{'WasLost'} = 1;
1534 # fix up the overdues in accounts...
1535 if ($borrowernumber) {
1536 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1537 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1540 # find reserves.....
1541 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1542 my ($resfound, $resrec) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1544 $resrec->{'ResFound'} = $resfound;
1545 $messages->{'ResFound'} = $resrec;
1549 # Record the fact that this book was returned.
1551 $branch, 'return', '0', '',
1552 $item->{'itemnumber'},
1553 $biblio->{'itemtype'},
1557 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1558 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1560 branchcode => $branch,
1561 categorycode => $borrower->{categorycode},
1562 item_type => $item->{itype},
1563 notification => 'CHECKIN',
1565 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1566 SendCirculationAlert({
1569 borrower => $borrower,
1574 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1575 if C4::Context->preference("ReturnLog");
1577 # FIXME: make this comment intelligible.
1578 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1579 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1581 if ($doreturn and ($branch ne $hbr) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) ){
1582 if ( C4::Context->preference("AutomaticItemReturn" ) or
1583 (C4::Context->preference("UseBranchTransferLimits") and
1584 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1586 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1587 $debug and warn "item: " . Dumper($item);
1588 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1589 $messages->{'WasTransfered'} = 1;
1591 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1594 return ( $doreturn, $messages, $issue, $borrower );
1597 =head2 MarkIssueReturned
1601 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate);
1605 Unconditionally marks an issue as being returned by
1606 moving the C<issues> row to C<old_issues> and
1607 setting C<returndate> to the current date, or
1608 the last non-holiday date of the branccode specified in
1609 C<dropbox_branch> . Assumes you've already checked that
1610 it's safe to do this, i.e. last non-holiday > issuedate.
1612 if C<$returndate> is specified (in iso format), it is used as the date
1613 of the return. It is ignored when a dropbox_branch is passed in.
1615 Ideally, this function would be internal to C<C4::Circulation>,
1616 not exported, but it is currently needed by one
1617 routine in C<C4::Accounts>.
1621 sub MarkIssueReturned {
1622 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate ) = @_;
1623 my $dbh = C4::Context->dbh;
1624 my $query = "UPDATE issues SET returndate=";
1626 if ($dropbox_branch) {
1627 my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1628 my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1630 push @bind, $dropboxdate->output('iso');
1631 } elsif ($returndate) {
1633 push @bind, $returndate;
1635 $query .= " now() ";
1637 $query .= " WHERE borrowernumber = ? AND itemnumber = ?";
1638 push @bind, $borrowernumber, $itemnumber;
1640 my $sth_upd = $dbh->prepare($query);
1641 $sth_upd->execute(@bind);
1642 my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1643 WHERE borrowernumber = ?
1644 AND itemnumber = ?");
1645 $sth_copy->execute($borrowernumber, $itemnumber);
1646 my $sth_del = $dbh->prepare("DELETE FROM issues
1647 WHERE borrowernumber = ?
1648 AND itemnumber = ?");
1649 $sth_del->execute($borrowernumber, $itemnumber);
1652 =head2 _FixOverduesOnReturn
1654 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1656 C<$brn> borrowernumber
1660 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1661 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1663 Internal function, called only by AddReturn
1667 sub _FixOverduesOnReturn {
1668 my ($borrowernumber, $item);
1669 unless ($borrowernumber = shift) {
1670 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1673 unless ($item = shift) {
1674 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1677 my ($exemptfine, $dropbox) = @_;
1678 my $dbh = C4::Context->dbh;
1680 # check for overdue fine
1681 my $sth = $dbh->prepare(
1682 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1684 $sth->execute( $borrowernumber, $item );
1686 # alter fine to show that the book has been returned
1687 my $data = $sth->fetchrow_hashref;
1688 return 0 unless $data; # no warning, there's just nothing to fix
1691 my @bind = ($borrowernumber, $item, $data->{'accountno'});
1693 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1694 if (C4::Context->preference("FinesLog")) {
1695 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1697 } elsif ($dropbox && $data->{lastincrement}) {
1698 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1699 my $amt = $data->{amount} - $data->{lastincrement} ;
1700 if (C4::Context->preference("FinesLog")) {
1701 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1703 $uquery = "update accountlines set accounttype='F' ";
1704 if($outstanding >= 0 && $amt >=0) {
1705 $uquery .= ", amount = ? , amountoutstanding=? ";
1706 unshift @bind, ($amt, $outstanding) ;
1709 $uquery = "update accountlines set accounttype='F' ";
1711 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1712 my $usth = $dbh->prepare($uquery);
1713 return $usth->execute(@bind);
1716 =head2 _FixAccountForLostAndReturned
1718 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1720 Calculates the charge for a book lost and returned.
1722 Internal function, not exported, called only by AddReturn.
1724 FIXME: This function reflects how inscrutable fines logic is. Fix both.
1725 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
1729 sub _FixAccountForLostAndReturned {
1730 my $itemnumber = shift or return;
1731 my $borrowernumber = @_ ? shift : undef;
1732 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
1733 my $dbh = C4::Context->dbh;
1734 # check for charge made for lost book
1735 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1736 $sth->execute($itemnumber);
1737 my $data = $sth->fetchrow_hashref;
1738 $data or return; # bail if there is nothing to do
1740 # writeoff this amount
1742 my $amount = $data->{'amount'};
1743 my $acctno = $data->{'accountno'};
1744 my $amountleft; # Starts off undef/zero.
1745 if ($data->{'amountoutstanding'} == $amount) {
1746 $offset = $data->{'amount'};
1747 $amountleft = 0; # Hey, it's zero here, too.
1749 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
1750 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
1752 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1753 WHERE (borrowernumber = ?)
1754 AND (itemnumber = ?) AND (accountno = ?) ");
1755 $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
1756 #check if any credit is left if so writeoff other accounts
1757 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1758 $amountleft *= -1 if ($amountleft < 0);
1759 if ($amountleft > 0) {
1760 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1761 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
1762 $msth->execute($data->{'borrowernumber'});
1763 # offset transactions
1766 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1767 if ($accdata->{'amountoutstanding'} < $amountleft) {
1769 $amountleft -= $accdata->{'amountoutstanding'};
1771 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1774 my $thisacct = $accdata->{'accountno'};
1775 # FIXME: move prepares outside while loop!
1776 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1777 WHERE (borrowernumber = ?)
1778 AND (accountno=?)");
1779 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct'); # FIXME: '$thisacct' is a string literal!
1780 $usth = $dbh->prepare("INSERT INTO accountoffsets
1781 (borrowernumber, accountno, offsetaccount, offsetamount)
1784 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1786 $msth->finish; # $msth might actually have data left
1788 $amountleft *= -1 if ($amountleft > 0);
1789 my $desc = "Item Returned " . $item_id;
1790 $usth = $dbh->prepare("INSERT INTO accountlines
1791 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1792 VALUES (?,?,now(),?,?,'CR',?)");
1793 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1794 if ($borrowernumber) {
1795 # FIXME: same as query above. use 1 sth for both
1796 $usth = $dbh->prepare("INSERT INTO accountoffsets
1797 (borrowernumber, accountno, offsetaccount, offsetamount)
1799 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
1801 ModItem({ paidfor => '' }, undef, $itemnumber);
1805 =head2 _GetCircControlBranch
1807 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
1811 Return the library code to be used to determine which circulation
1812 policy applies to a transaction. Looks up the CircControl and
1813 HomeOrHoldingBranch system preferences.
1815 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
1817 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
1821 sub _GetCircControlBranch {
1822 my ($item, $borrower) = @_;
1823 my $circcontrol = C4::Context->preference('CircControl');
1826 if ($circcontrol eq 'PickupLibrary') {
1827 $branch= C4::Context->userenv->{'branch'};
1828 } elsif ($circcontrol eq 'PatronLibrary') {
1829 $branch=$borrower->{branchcode};
1831 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
1832 $branch = $item->{$branchfield};
1833 # default to item home branch if holdingbranch is used
1834 # and is not defined
1835 if (!defined($branch) && $branchfield eq 'holdingbranch') {
1836 $branch = $item->{homebranch};
1849 $issue = &GetItemIssue($itemnumber);
1851 Returns patron currently having a book, or undef if not checked out.
1853 C<$itemnumber> is the itemnumber.
1855 C<$issue> is a hashref of the row from the issues table.
1860 my ($itemnumber) = @_;
1861 return unless $itemnumber;
1862 my $sth = C4::Context->dbh->prepare(
1865 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1866 WHERE issues.itemnumber=?");
1867 $sth->execute($itemnumber);
1868 my $data = $sth->fetchrow_hashref;
1869 return unless $data;
1870 $data->{'overdue'} = ($data->{'date_due'} lt C4::Dates->today('iso')) ? 1 : 0;
1876 $issue = GetOpenIssue( $itemnumber );
1878 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1880 C<$itemnumber> is the item's itemnumber
1887 my ( $itemnumber ) = @_;
1889 my $dbh = C4::Context->dbh;
1890 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1891 $sth->execute( $itemnumber );
1892 my $issue = $sth->fetchrow_hashref();
1896 =head2 GetItemIssues
1898 $issues = &GetItemIssues($itemnumber, $history);
1900 Returns patrons that have issued a book
1902 C<$itemnumber> is the itemnumber
1903 C<$history> is false if you just want the current "issuer" (if any)
1904 and true if you want issues history from old_issues also.
1906 Returns reference to an array of hashes
1911 my ( $itemnumber, $history ) = @_;
1913 my $today = C4::Dates->today('iso'); # get today date
1914 my $sql = "SELECT * FROM issues
1915 JOIN borrowers USING (borrowernumber)
1916 JOIN items USING (itemnumber)
1917 WHERE issues.itemnumber = ? ";
1920 SELECT * FROM old_issues
1921 LEFT JOIN borrowers USING (borrowernumber)
1922 JOIN items USING (itemnumber)
1923 WHERE old_issues.itemnumber = ? ";
1925 $sql .= "ORDER BY date_due DESC";
1926 my $sth = C4::Context->dbh->prepare($sql);
1928 $sth->execute($itemnumber, $itemnumber);
1930 $sth->execute($itemnumber);
1932 my $results = $sth->fetchall_arrayref({});
1933 foreach (@$results) {
1934 $_->{'overdue'} = ($_->{'date_due'} lt $today) ? 1 : 0;
1939 =head2 GetBiblioIssues
1941 $issues = GetBiblioIssues($biblionumber);
1943 this function get all issues from a biblionumber.
1946 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1947 tables issues and the firstname,surname & cardnumber from borrowers.
1951 sub GetBiblioIssues {
1952 my $biblionumber = shift;
1953 return undef unless $biblionumber;
1954 my $dbh = C4::Context->dbh;
1956 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1958 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1959 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1960 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1961 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1962 WHERE biblio.biblionumber = ?
1964 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1966 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1967 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1968 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1969 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1970 WHERE biblio.biblionumber = ?
1973 my $sth = $dbh->prepare($query);
1974 $sth->execute($biblionumber, $biblionumber);
1977 while ( my $data = $sth->fetchrow_hashref ) {
1978 push @issues, $data;
1983 =head2 GetUpcomingDueIssues
1987 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
1993 sub GetUpcomingDueIssues {
1996 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
1997 my $dbh = C4::Context->dbh;
1999 my $statement = <<END_SQL;
2000 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
2002 LEFT JOIN items USING (itemnumber)
2003 WhERE returndate is NULL
2004 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
2007 my @bind_parameters = ( $params->{'days_in_advance'} );
2009 my $sth = $dbh->prepare( $statement );
2010 $sth->execute( @bind_parameters );
2011 my $upcoming_dues = $sth->fetchall_arrayref({});
2014 return $upcoming_dues;
2017 =head2 CanBookBeRenewed
2019 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2021 Find out whether a borrowed item may be renewed.
2023 C<$dbh> is a DBI handle to the Koha database.
2025 C<$borrowernumber> is the borrower number of the patron who currently
2026 has the item on loan.
2028 C<$itemnumber> is the number of the item to renew.
2030 C<$override_limit>, if supplied with a true value, causes
2031 the limit on the number of times that the loan can be renewed
2032 (as controlled by the item type) to be ignored.
2034 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2035 item must currently be on loan to the specified borrower; renewals
2036 must be allowed for the item's type; and the borrower must not have
2037 already renewed the loan. $error will contain the reason the renewal can not proceed
2041 sub CanBookBeRenewed {
2043 # check renewal status
2044 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2045 my $dbh = C4::Context->dbh;
2050 # Look in the issues table for this item, lent to this borrower,
2051 # and not yet returned.
2053 # Look in the issues table for this item, lent to this borrower,
2054 # and not yet returned.
2056 'ItemHomeLibrary' => 'items.homebranch',
2057 'PickupLibrary' => 'items.holdingbranch',
2058 'PatronLibrary' => 'borrowers.branchcode'
2060 my $controlbranch = $branch{C4::Context->preference('CircControl')};
2061 my $itype = C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype';
2063 my $sthcount = $dbh->prepare("
2065 borrowers.categorycode, biblioitems.itemtype, issues.renewals, renewalsallowed, $controlbranch
2068 LEFT JOIN items USING (itemnumber)
2069 LEFT JOIN borrowers USING (borrowernumber)
2070 LEFT JOIN biblioitems USING (biblioitemnumber)
2073 (issuingrules.categorycode = borrowers.categorycode OR issuingrules.categorycode = '*')
2075 (issuingrules.itemtype = $itype OR issuingrules.itemtype = '*')
2077 (issuingrules.branchcode = $controlbranch OR issuingrules.branchcode = '*')
2083 issuingrules.categorycode desc,
2084 issuingrules.itemtype desc,
2085 issuingrules.branchcode desc
2089 $sthcount->execute( $borrowernumber, $itemnumber );
2090 if ( my $data1 = $sthcount->fetchrow_hashref ) {
2092 if ( ( $data1->{renewalsallowed} && $data1->{renewalsallowed} > $data1->{renewals} ) || $override_limit ) {
2099 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2106 return ($renewokay,$error);
2111 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2115 C<$borrowernumber> is the borrower number of the patron who currently
2118 C<$itemnumber> is the number of the item to renew.
2120 C<$branch> is the library where the renewal took place (if any).
2121 The library that controls the circ policies for the renewal is retrieved from the issues record.
2123 C<$datedue> can be a C4::Dates object used to set the due date.
2125 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2126 this parameter is not supplied, lastreneweddate is set to the current date.
2128 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2129 from the book's item type.
2134 my $borrowernumber = shift or return undef;
2135 my $itemnumber = shift or return undef;
2137 my $datedue = shift;
2138 my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2139 my $item = GetItem($itemnumber) or return undef;
2140 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2142 my $dbh = C4::Context->dbh;
2143 # Find the issues record for this book
2145 $dbh->prepare("SELECT * FROM issues
2146 WHERE borrowernumber=?
2149 $sth->execute( $borrowernumber, $itemnumber );
2150 my $issuedata = $sth->fetchrow_hashref;
2152 if($datedue && ! $datedue->output('iso')){
2153 warn "Invalid date passed to AddRenewal.";
2156 # If the due date wasn't specified, calculate it by adding the
2157 # book's loan length to today's date or the current due date
2158 # based on the value of the RenewalPeriodBase syspref.
2161 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2162 my $loanlength = GetLoanLength(
2163 $borrower->{'categorycode'},
2164 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2165 $issuedata->{'branchcode'} ); # that's the circ control branch.
2167 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2168 C4::Dates->new($issuedata->{date_due}, 'iso') :
2170 $datedue = CalcDateDue($datedue,$loanlength,$issuedata->{'branchcode'},$borrower);
2173 # Update the issues record to have the new due date, and a new count
2174 # of how many times it has been renewed.
2175 my $renews = $issuedata->{'renewals'} + 1;
2176 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2177 WHERE borrowernumber=?
2180 $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2183 # Update the renewal count on the item, and tell zebra to reindex
2184 $renews = $biblio->{'renewals'} + 1;
2185 ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2187 # Charge a new rental fee, if applicable?
2188 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2189 if ( $charge > 0 ) {
2190 my $accountno = getnextacctno( $borrowernumber );
2191 my $item = GetBiblioFromItemNumber($itemnumber);
2192 $sth = $dbh->prepare(
2193 "INSERT INTO accountlines
2195 borrowernumber, accountno, amount,
2197 accounttype, amountoutstanding, itemnumber
2199 VALUES (now(),?,?,?,?,?,?,?)"
2201 $sth->execute( $borrowernumber, $accountno, $charge,
2202 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2203 'Rent', $charge, $itemnumber );
2207 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2212 # check renewal status
2213 my ($bornum,$itemno)=@_;
2214 my $dbh = C4::Context->dbh;
2216 my $renewsallowed = 0;
2218 # Look in the issues table for this item, lent to this borrower,
2219 # and not yet returned.
2221 # FIXME - I think this function could be redone to use only one SQL call.
2222 my $sth = $dbh->prepare("select * from issues
2223 where (borrowernumber = ?)
2224 and (itemnumber = ?)");
2225 $sth->execute($bornum,$itemno);
2226 my $data = $sth->fetchrow_hashref;
2227 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2229 my $query = "SELECT renewalsallowed FROM items ";
2230 $query .= (C4::Context->preference('item-level_itypes'))
2231 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2232 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2233 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2234 $query .= "WHERE items.itemnumber = ?";
2235 my $sth2 = $dbh->prepare($query);
2236 $sth2->execute($itemno);
2237 my $data2 = $sth2->fetchrow_hashref();
2238 $renewsallowed = $data2->{'renewalsallowed'};
2239 $renewsleft = $renewsallowed - $renewcount;
2240 return ($renewcount,$renewsallowed,$renewsleft);
2243 =head2 GetIssuingCharges
2245 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2247 Calculate how much it would cost for a given patron to borrow a given
2248 item, including any applicable discounts.
2250 C<$itemnumber> is the item number of item the patron wishes to borrow.
2252 C<$borrowernumber> is the patron's borrower number.
2254 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2255 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2260 sub GetIssuingCharges {
2262 # calculate charges due
2263 my ( $itemnumber, $borrowernumber ) = @_;
2265 my $dbh = C4::Context->dbh;
2268 # Get the book's item type and rental charge (via its biblioitem).
2269 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
2270 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2271 $qcharge .= (C4::Context->preference('item-level_itypes'))
2272 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2273 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2275 $qcharge .= "WHERE items.itemnumber =?";
2277 my $sth1 = $dbh->prepare($qcharge);
2278 $sth1->execute($itemnumber);
2279 if ( my $data1 = $sth1->fetchrow_hashref ) {
2280 $item_type = $data1->{'itemtype'};
2281 $charge = $data1->{'rentalcharge'};
2282 my $q2 = "SELECT rentaldiscount FROM borrowers
2283 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2284 WHERE borrowers.borrowernumber = ?
2285 AND issuingrules.itemtype = ?";
2286 my $sth2 = $dbh->prepare($q2);
2287 $sth2->execute( $borrowernumber, $item_type );
2288 if ( my $data2 = $sth2->fetchrow_hashref ) {
2289 my $discount = $data2->{'rentaldiscount'};
2290 if ( $discount eq 'NULL' ) {
2293 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2299 return ( $charge, $item_type );
2302 =head2 AddIssuingCharge
2304 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2308 sub AddIssuingCharge {
2309 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2310 my $dbh = C4::Context->dbh;
2311 my $nextaccntno = getnextacctno( $borrowernumber );
2313 INSERT INTO accountlines
2314 (borrowernumber, itemnumber, accountno,
2315 date, amount, description, accounttype,
2317 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2319 my $sth = $dbh->prepare($query);
2320 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2326 GetTransfers($itemnumber);
2331 my ($itemnumber) = @_;
2333 my $dbh = C4::Context->dbh;
2339 FROM branchtransfers
2340 WHERE itemnumber = ?
2341 AND datearrived IS NULL
2343 my $sth = $dbh->prepare($query);
2344 $sth->execute($itemnumber);
2345 my @row = $sth->fetchrow_array();
2350 =head2 GetTransfersFromTo
2352 @results = GetTransfersFromTo($frombranch,$tobranch);
2354 Returns the list of pending transfers between $from and $to branch
2358 sub GetTransfersFromTo {
2359 my ( $frombranch, $tobranch ) = @_;
2360 return unless ( $frombranch && $tobranch );
2361 my $dbh = C4::Context->dbh;
2363 SELECT itemnumber,datesent,frombranch
2364 FROM branchtransfers
2367 AND datearrived IS NULL
2369 my $sth = $dbh->prepare($query);
2370 $sth->execute( $frombranch, $tobranch );
2373 while ( my $data = $sth->fetchrow_hashref ) {
2374 push @gettransfers, $data;
2377 return (@gettransfers);
2380 =head2 DeleteTransfer
2382 &DeleteTransfer($itemnumber);
2386 sub DeleteTransfer {
2387 my ($itemnumber) = @_;
2388 my $dbh = C4::Context->dbh;
2389 my $sth = $dbh->prepare(
2390 "DELETE FROM branchtransfers
2392 AND datearrived IS NULL "
2394 $sth->execute($itemnumber);
2398 =head2 AnonymiseIssueHistory
2400 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2402 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2403 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2405 return the number of affected rows.
2409 sub AnonymiseIssueHistory {
2411 my $borrowernumber = shift;
2412 my $dbh = C4::Context->dbh;
2415 SET borrowernumber = NULL
2416 WHERE returndate < '".$date."'
2417 AND borrowernumber IS NOT NULL
2419 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2420 my $rows_affected = $dbh->do($query);
2421 return $rows_affected;
2424 =head2 SendCirculationAlert
2426 Send out a C<check-in> or C<checkout> alert using the messaging system.
2434 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2438 Hashref of information about the item being checked in or out.
2442 Hashref of information about the borrower of the item.
2446 The branchcode from where the checkout or check-in took place.
2452 SendCirculationAlert({
2455 borrower => $borrower,
2461 sub SendCirculationAlert {
2463 my ($type, $item, $borrower, $branch) =
2464 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2465 my %message_name = (
2466 CHECKIN => 'Item Check-in',
2467 CHECKOUT => 'Item Checkout',
2469 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2470 borrowernumber => $borrower->{borrowernumber},
2471 message_name => $message_name{$type},
2473 my $letter = C4::Letters::getletter('circulation', $type);
2474 C4::Letters::parseletter($letter, 'biblio', $item->{biblionumber});
2475 C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2476 C4::Letters::parseletter($letter, 'borrowers', $borrower->{borrowernumber});
2477 C4::Letters::parseletter($letter, 'branches', $branch);
2478 my @transports = @{ $borrower_preferences->{transports} };
2479 # warn "no transports" unless @transports;
2481 # warn "transport: $_";
2482 my $message = C4::Message->find_last_message($borrower, $type, $_);
2484 #warn "create new message";
2485 C4::Message->enqueue($letter, $borrower, $_);
2487 #warn "append to old message";
2488 $message->append($letter);
2495 =head2 updateWrongTransfer
2497 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2499 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
2503 sub updateWrongTransfer {
2504 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2505 my $dbh = C4::Context->dbh;
2506 # first step validate the actual line of transfert .
2509 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2511 $sth->execute($FromLibrary,$itemNumber);
2514 # second step create a new line of branchtransfer to the right location .
2515 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2517 #third step changing holdingbranch of item
2518 UpdateHoldingbranch($FromLibrary,$itemNumber);
2521 =head2 UpdateHoldingbranch
2523 $items = UpdateHoldingbranch($branch,$itmenumber);
2524 Simple methode for updating hodlingbranch in items BDD line
2528 sub UpdateHoldingbranch {
2529 my ( $branch,$itemnumber ) = @_;
2530 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2535 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2536 this function calculates the due date given the loan length ,
2537 checking against the holidays calendar as per the 'useDaysMode' syspref.
2538 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2539 C<$branch> = location whose calendar to use
2540 C<$loanlength> = loan length prior to adjustment
2544 my ($startdate,$loanlength,$branch,$borrower) = @_;
2547 if(C4::Context->preference('useDaysMode') eq 'Days') { # ignoring calendar
2548 my $timedue = time + ($loanlength) * 86400;
2549 #FIXME - assumes now even though we take a startdate
2550 my @datearr = localtime($timedue);
2551 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2553 my $calendar = C4::Calendar->new( branchcode => $branch );
2554 $datedue = $calendar->addDate($startdate, $loanlength);
2557 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2558 if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2559 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2562 # if ceilingDueDate ON the datedue can't be after the ceiling date
2563 if ( C4::Context->preference('ceilingDueDate')
2564 && ( C4::Context->preference('ceilingDueDate') =~ C4::Dates->regexp('syspref') ) ) {
2565 my $ceilingDate = C4::Dates->new( C4::Context->preference('ceilingDueDate') );
2566 if ( $datedue->output( 'iso' ) gt $ceilingDate->output( 'iso' ) ) {
2567 $datedue = $ceilingDate;
2574 =head2 CheckValidDatedue
2575 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2576 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2578 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2579 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2580 C<$date_due> = returndate calculate with no day check
2581 C<$itemnumber> = itemnumber
2582 C<$branchcode> = location of issue (affected by 'CircControl' syspref)
2583 C<$loanlength> = loan length prior to adjustment
2586 sub CheckValidDatedue {
2587 my ($date_due,$itemnumber,$branchcode)=@_;
2588 my @datedue=split('-',$date_due->output('iso'));
2589 my $years=$datedue[0];
2590 my $month=$datedue[1];
2591 my $day=$datedue[2];
2592 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2594 for (my $i=0;$i<2;$i++){
2595 $dow=Day_of_Week($years,$month,$day);
2596 ($dow=0) if ($dow>6);
2597 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2598 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2599 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2600 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2602 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2605 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2610 =head2 CheckRepeatableHolidays
2612 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2613 this function checks if the date due is a repeatable holiday
2614 C<$date_due> = returndate calculate with no day check
2615 C<$itemnumber> = itemnumber
2616 C<$branchcode> = localisation of issue
2620 sub CheckRepeatableHolidays{
2621 my($itemnumber,$week_day,$branchcode)=@_;
2622 my $dbh = C4::Context->dbh;
2623 my $query = qq|SELECT count(*)
2624 FROM repeatable_holidays
2627 my $sth = $dbh->prepare($query);
2628 $sth->execute($branchcode,$week_day);
2629 my $result=$sth->fetchrow;
2635 =head2 CheckSpecialHolidays
2637 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2638 this function check if the date is a special holiday
2639 C<$years> = the years of datedue
2640 C<$month> = the month of datedue
2641 C<$day> = the day of datedue
2642 C<$itemnumber> = itemnumber
2643 C<$branchcode> = localisation of issue
2647 sub CheckSpecialHolidays{
2648 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2649 my $dbh = C4::Context->dbh;
2650 my $query=qq|SELECT count(*)
2651 FROM `special_holidays`
2657 my $sth = $dbh->prepare($query);
2658 $sth->execute($years,$month,$day,$branchcode);
2659 my $countspecial=$sth->fetchrow ;
2661 return $countspecial;
2664 =head2 CheckRepeatableSpecialHolidays
2666 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2667 this function check if the date is a repeatble special holidays
2668 C<$month> = the month of datedue
2669 C<$day> = the day of datedue
2670 C<$itemnumber> = itemnumber
2671 C<$branchcode> = localisation of issue
2675 sub CheckRepeatableSpecialHolidays{
2676 my ($month,$day,$itemnumber,$branchcode) = @_;
2677 my $dbh = C4::Context->dbh;
2678 my $query=qq|SELECT count(*)
2679 FROM `repeatable_holidays`
2684 my $sth = $dbh->prepare($query);
2685 $sth->execute($month,$day,$branchcode);
2686 my $countspecial=$sth->fetchrow ;
2688 return $countspecial;
2693 sub CheckValidBarcode{
2695 my $dbh = C4::Context->dbh;
2696 my $query=qq|SELECT count(*)
2700 my $sth = $dbh->prepare($query);
2701 $sth->execute($barcode);
2702 my $exist=$sth->fetchrow ;
2707 =head2 IsBranchTransferAllowed
2709 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2711 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2715 sub IsBranchTransferAllowed {
2716 my ( $toBranch, $fromBranch, $code ) = @_;
2718 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2720 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2721 my $dbh = C4::Context->dbh;
2723 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2724 $sth->execute( $toBranch, $fromBranch, $code );
2725 my $limit = $sth->fetchrow_hashref();
2727 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2728 if ( $limit->{'limitId'} ) {
2735 =head2 CreateBranchTransferLimit
2737 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2739 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2743 sub CreateBranchTransferLimit {
2744 my ( $toBranch, $fromBranch, $code ) = @_;
2746 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2748 my $dbh = C4::Context->dbh;
2750 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2751 $sth->execute( $code, $toBranch, $fromBranch );
2754 =head2 DeleteBranchTransferLimits
2756 DeleteBranchTransferLimits();
2760 sub DeleteBranchTransferLimits {
2761 my $dbh = C4::Context->dbh;
2762 my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2773 Koha Developement team <info@koha.org>