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 with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
22 #use warnings; # soon!
33 use C4::ItemCirculationAlertPreference;
44 use POSIX qw(strftime);
45 use C4::Branch; # GetBranches
46 use C4::Log; # logaction
50 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
54 $VERSION = 3.02; # for version checking
57 # FIXME subs that should probably be elsewhere
63 # subs to deal with issuing a book
76 &GetBranchBorrowerCircRule
79 &AnonymiseIssueHistory
82 # subs to deal with returns
88 # subs to deal with transfers
95 &IsBranchTransferAllowed
96 &CreateBranchTransferLimit
97 &DeleteBranchTransferLimits
103 C4::Circulation - Koha circulation module
111 The functions in this module deal with circulation, issues, and
112 returns, as well as general information about the library.
113 Also deals with stocktaking.
119 =head3 $str = &barcodedecode($barcode, [$filter]);
123 =item Generic filter function for barcode string.
124 Called on every circ if the System Pref itemBarcodeInputFilter is set.
125 Will do some manipulation of the barcode for systems that deliver a barcode
126 to circulation.pl that differs from the barcode stored for the item.
127 For proper functioning of this filter, calling the function on the
128 correct barcode string (items.barcode) should return an unaltered barcode.
130 The optional $filter argument is to allow for testing or explicit
131 behavior that ignores the System Pref. Valid values are the same as the
138 # FIXME -- the &decode fcn below should be wrapped into this one.
139 # FIXME -- these plugins should be moved out of Circulation.pm
142 my ($barcode, $filter) = @_;
143 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
144 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
145 if ($filter eq 'whitespace') {
147 } elsif ($filter eq 'cuecat') {
149 my @fields = split( /\./, $barcode );
150 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
151 ($#results == 2) and return $results[2];
152 } elsif ($filter eq 'T-prefix') {
153 if ($barcode =~ /^[Tt](\d)/) {
154 (defined($1) and $1 eq '0') and return $barcode;
155 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
157 return sprintf("T%07d", $barcode);
158 # FIXME: $barcode could be "T1", causing warning: substr outside of string
159 # Why drop the nonzero digit after the T?
160 # Why pass non-digits (or empty string) to "T%07d"?
162 return $barcode; # return barcode, modified or not
167 =head3 $str = &decode($chunk);
171 =item Decodes a segment of a string emitted by a CueCat barcode scanner and
174 FIXME: Should be replaced with Barcode::Cuecat from CPAN
175 or Javascript based decoding on the client side.
184 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
185 my @s = map { index( $seq, $_ ); } split( //, $encoded );
186 my $l = ( $#s + 1 ) % 4;
189 # warn "Error: Cuecat decode parsing failed!";
197 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
199 chr( ( $n >> 16 ) ^ 67 )
200 .chr( ( $n >> 8 & 255 ) ^ 67 )
201 .chr( ( $n & 255 ) ^ 67 );
204 $r = substr( $r, 0, length($r) - $l );
210 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch, $barcode, $ignore_reserves);
212 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
214 C<$newbranch> is the code for the branch to which the item should be transferred.
216 C<$barcode> is the barcode of the item to be transferred.
218 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
219 Otherwise, if an item is reserved, the transfer fails.
221 Returns three values:
225 is true if the transfer was successful.
229 is a reference-to-hash which may have any of the following keys:
235 There is no item in the catalog with the given barcode. The value is C<$barcode>.
239 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.
241 =item C<DestinationEqualsHolding>
243 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.
247 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.
251 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>.
253 =item C<WasTransferred>
255 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
262 my ( $tbr, $barcode, $ignoreRs ) = @_;
265 my $branches = GetBranches();
266 my $itemnumber = GetItemnumberFromBarcode( $barcode );
267 my $issue = GetItemIssue($itemnumber);
268 my $biblio = GetBiblioFromItemNumber($itemnumber);
271 if ( not $itemnumber ) {
272 $messages->{'BadBarcode'} = $barcode;
276 # get branches of book...
277 my $hbr = $biblio->{'homebranch'};
278 my $fbr = $biblio->{'holdingbranch'};
280 # if using Branch Transfer Limits
281 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
282 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
283 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
284 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
287 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
288 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
294 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
295 $messages->{'IsPermanent'} = $hbr;
299 # can't transfer book if is already there....
300 if ( $fbr eq $tbr ) {
301 $messages->{'DestinationEqualsHolding'} = 1;
305 # check if it is still issued to someone, return it...
306 if ($issue->{borrowernumber}) {
307 AddReturn( $barcode, $fbr );
308 $messages->{'WasReturned'} = $issue->{borrowernumber};
312 # That'll save a database query.
313 my ( $resfound, $resrec ) =
314 CheckReserves( $itemnumber );
315 if ( $resfound and not $ignoreRs ) {
316 $resrec->{'ResFound'} = $resfound;
318 # $messages->{'ResFound'} = $resrec;
322 #actually do the transfer....
324 ModItemTransfer( $itemnumber, $fbr, $tbr );
326 # don't need to update MARC anymore, we do it in batch now
327 $messages->{'WasTransfered'} = 1;
328 ModDateLastSeen( $itemnumber );
330 return ( $dotransfer, $messages, $biblio );
335 my $borrower = shift;
336 my $biblionumber = shift;
338 my $cat_borrower = $borrower->{'categorycode'};
339 my $dbh = C4::Context->dbh;
341 # Get which branchcode we need
342 $branch = _GetCircControlBranch($item,$borrower);
343 my $type = (C4::Context->preference('item-level_itypes'))
344 ? $item->{'itype'} # item-level
345 : $item->{'itemtype'}; # biblio-level
347 # given branch, patron category, and item type, determine
348 # applicable issuing rule
349 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
351 # if a rule is found and has a loan limit set, count
352 # how many loans the patron already has that meet that
354 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
356 my $count_query = "SELECT COUNT(*) FROM issues
357 JOIN items USING (itemnumber) ";
359 my $rule_itemtype = $issuing_rule->{itemtype};
360 if ($rule_itemtype eq "*") {
361 # matching rule has the default item type, so count only
362 # those existing loans that don't fall under a more
364 if (C4::Context->preference('item-level_itypes')) {
365 $count_query .= " WHERE items.itype NOT IN (
366 SELECT itemtype FROM issuingrules
368 AND (categorycode = ? OR categorycode = ?)
372 $count_query .= " JOIN biblioitems USING (biblionumber)
373 WHERE biblioitems.itemtype NOT IN (
374 SELECT itemtype FROM issuingrules
376 AND (categorycode = ? OR categorycode = ?)
380 push @bind_params, $issuing_rule->{branchcode};
381 push @bind_params, $issuing_rule->{categorycode};
382 push @bind_params, $cat_borrower;
384 # rule has specific item type, so count loans of that
386 if (C4::Context->preference('item-level_itypes')) {
387 $count_query .= " WHERE items.itype = ? ";
389 $count_query .= " JOIN biblioitems USING (biblionumber)
390 WHERE biblioitems.itemtype= ? ";
392 push @bind_params, $type;
395 $count_query .= " AND borrowernumber = ? ";
396 push @bind_params, $borrower->{'borrowernumber'};
397 my $rule_branch = $issuing_rule->{branchcode};
398 if ($rule_branch ne "*") {
399 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
400 $count_query .= " AND issues.branchcode = ? ";
401 push @bind_params, $branch;
402 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
403 ; # if branch is the patron's home branch, then count all loans by patron
405 $count_query .= " AND items.homebranch = ? ";
406 push @bind_params, $branch;
410 my $count_sth = $dbh->prepare($count_query);
411 $count_sth->execute(@bind_params);
412 my ($current_loan_count) = $count_sth->fetchrow_array;
414 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
415 if ($current_loan_count >= $max_loans_allowed) {
416 return "$current_loan_count / $max_loans_allowed";
420 # Now count total loans against the limit for the branch
421 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
422 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
423 my @bind_params = ();
424 my $branch_count_query = "SELECT COUNT(*) FROM issues
425 JOIN items USING (itemnumber)
426 WHERE borrowernumber = ? ";
427 push @bind_params, $borrower->{borrowernumber};
429 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
430 $branch_count_query .= " AND issues.branchcode = ? ";
431 push @bind_params, $branch;
432 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
433 ; # if branch is the patron's home branch, then count all loans by patron
435 $branch_count_query .= " AND items.homebranch = ? ";
436 push @bind_params, $branch;
438 my $branch_count_sth = $dbh->prepare($branch_count_query);
439 $branch_count_sth->execute(@bind_params);
440 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
442 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
443 if ($current_loan_count >= $max_loans_allowed) {
444 return "$current_loan_count / $max_loans_allowed";
448 # OK, the patron can issue !!!
454 @issues = &itemissues($biblioitemnumber, $biblio);
456 Looks up information about who has borrowed the bookZ<>(s) with the
457 given biblioitemnumber.
459 C<$biblio> is ignored.
461 C<&itemissues> returns an array of references-to-hash. The keys
462 include the fields from the C<items> table in the Koha database.
463 Additional keys include:
469 If the item is currently on loan, this gives the due date.
471 If the item is not on loan, then this is either "Available" or
472 "Cancelled", if the item has been withdrawn.
476 If the item is currently on loan, this gives the card number of the
477 patron who currently has the item.
479 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
481 These give the timestamp for the last three times the item was
484 =item C<card0>, C<card1>, C<card2>
486 The card number of the last three patrons who borrowed this item.
488 =item C<borrower0>, C<borrower1>, C<borrower2>
490 The borrower number of the last three patrons who borrowed this item.
498 my ( $bibitem, $biblio ) = @_;
499 my $dbh = C4::Context->dbh;
501 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
506 $sth->execute($bibitem) || die $sth->errstr;
508 while ( my $data = $sth->fetchrow_hashref ) {
510 # Find out who currently has this item.
511 # FIXME - Wouldn't it be better to do this as a left join of
512 # some sort? Currently, this code assumes that if
513 # fetchrow_hashref() fails, then the book is on the shelf.
514 # fetchrow_hashref() can fail for any number of reasons (e.g.,
515 # database server crash), not just because no items match the
517 my $sth2 = $dbh->prepare(
518 "SELECT * FROM issues
519 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
524 $sth2->execute( $data->{'itemnumber'} );
525 if ( my $data2 = $sth2->fetchrow_hashref ) {
526 $data->{'date_due'} = $data2->{'date_due'};
527 $data->{'card'} = $data2->{'cardnumber'};
528 $data->{'borrower'} = $data2->{'borrowernumber'};
531 $data->{'date_due'} = ($data->{'wthdrawn'} eq '1') ? 'Cancelled' : 'Available';
536 # Find the last 3 people who borrowed this item.
537 $sth2 = $dbh->prepare(
538 "SELECT * FROM old_issues
539 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
541 ORDER BY returndate DESC,timestamp DESC"
544 $sth2->execute( $data->{'itemnumber'} );
545 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
546 { # FIXME : error if there is less than 3 pple borrowing this item
547 if ( my $data2 = $sth2->fetchrow_hashref ) {
548 $data->{"timestamp$i2"} = $data2->{'timestamp'};
549 $data->{"card$i2"} = $data2->{'cardnumber'};
550 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
555 $results[$i] = $data;
563 =head2 CanBookBeIssued
565 Check if a book can be issued.
567 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower, $barcode, $duedatespec, $inprocess );
569 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
573 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
575 =item C<$barcode> is the bar code of the book being issued.
577 =item C<$duedatespec> is a C4::Dates object.
587 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
588 Possible values are :
594 sticky due date is invalid
598 borrower gone with no address
602 borrower declared it's card lost
608 =head3 UNKNOWN_BARCODE
622 item is restricted (set by ??)
624 C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
625 Possible values are :
633 renewing, not issuing
635 =head3 ISSUED_TO_ANOTHER
637 issued to someone else.
641 reserved for someone else.
645 sticky due date is invalid
649 if the borrower borrows to much things
653 sub CanBookBeIssued {
654 my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
655 my %needsconfirmation; # filled with problems that needs confirmations
656 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
657 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
658 my $issue = GetItemIssue($item->{itemnumber});
659 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
660 $item->{'itemtype'}=$item->{'itype'};
661 my $dbh = C4::Context->dbh;
663 # MANDATORY CHECKS - unless item exists, nothing else matters
664 unless ( $item->{barcode} ) {
665 $issuingimpossible{UNKNOWN_BARCODE} = 1;
667 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
670 # DUE DATE is OK ? -- should already have checked.
672 unless ( $duedate ) {
673 my $issuedate = strftime( "%Y-%m-%d", localtime );
675 my $branch = _GetCircControlBranch($item,$borrower);
676 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
677 my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
678 $duedate = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
680 # Offline circ calls AddIssue directly, doesn't run through here
681 # So issuingimpossible should be ok.
683 $issuingimpossible{INVALID_DATE} = $duedate->output('syspref') unless ( $duedate && $duedate->output('iso') ge C4::Dates->today('iso') );
688 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
689 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
690 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'});
691 return( { STATS => 1 }, {});
693 if ( $borrower->{flags}->{GNA} ) {
694 $issuingimpossible{GNA} = 1;
696 if ( $borrower->{flags}->{'LOST'} ) {
697 $issuingimpossible{CARD_LOST} = 1;
699 if ( $borrower->{flags}->{'DBARRED'} ) {
700 $issuingimpossible{DEBARRED} = 1;
702 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
703 $issuingimpossible{EXPIRED} = 1;
705 my @expirydate= split /-/,$borrower->{'dateexpiry'};
706 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
707 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
708 $issuingimpossible{EXPIRED} = 1;
717 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
718 if ( C4::Context->preference("IssuingInProcess") ) {
719 my $amountlimit = C4::Context->preference("noissuescharge");
720 if ( $amount > $amountlimit && !$inprocess ) {
721 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
723 elsif ( $amount > 0 && $amount <= $amountlimit && !$inprocess ) {
724 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
729 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
734 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
736 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
737 # if TooMany return / 0, then the user has no permission to check out this book
738 if ($toomany =~ /\/ 0/) {
739 $needsconfirmation{PATRON_CANT} = 1;
741 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
747 if ( $item->{'notforloan'}
748 && $item->{'notforloan'} > 0 )
750 if(!C4::Context->preference("AllowNotForLoanOverride")){
751 $issuingimpossible{NOT_FOR_LOAN} = 1;
753 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
756 elsif ( !$item->{'notforloan'} ){
757 # we have to check itemtypes.notforloan also
758 if (C4::Context->preference('item-level_itypes')){
759 # this should probably be a subroutine
760 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
761 $sth->execute($item->{'itemtype'});
762 my $notforloan=$sth->fetchrow_hashref();
764 if ($notforloan->{'notforloan'}) {
765 if (!C4::Context->preference("AllowNotForLoanOverride")) {
766 $issuingimpossible{NOT_FOR_LOAN} = 1;
768 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
772 elsif ($biblioitem->{'notforloan'} == 1){
773 if (!C4::Context->preference("AllowNotForLoanOverride")) {
774 $issuingimpossible{NOT_FOR_LOAN} = 1;
776 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
780 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
782 $issuingimpossible{WTHDRAWN} = 1;
784 if ( $item->{'restricted'}
785 && $item->{'restricted'} == 1 )
787 $issuingimpossible{RESTRICTED} = 1;
789 if ( C4::Context->preference("IndependantBranches") ) {
790 my $userenv = C4::Context->userenv;
791 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
792 $issuingimpossible{NOTSAMEBRANCH} = 1
793 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
798 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
800 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
803 # Already issued to current borrower. Ask whether the loan should
805 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
806 $borrower->{'borrowernumber'},
807 $item->{'itemnumber'}
809 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
810 $issuingimpossible{NO_MORE_RENEWALS} = 1;
813 $needsconfirmation{RENEW_ISSUE} = 1;
816 elsif ($issue->{borrowernumber}) {
818 # issued to someone else
819 my $currborinfo = C4::Members::GetMemberDetails( $issue->{borrowernumber} );
821 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
822 $needsconfirmation{ISSUED_TO_ANOTHER} =
823 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
826 # See if the item is on reserve.
827 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
829 my $resbor = $res->{'borrowernumber'};
830 my ( $resborrower ) = C4::Members::GetMemberDetails( $resbor, 0 );
831 my $branches = GetBranches();
832 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
833 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
835 # The item is on reserve and waiting, but has been
836 # reserved by some other patron.
837 $needsconfirmation{RESERVE_WAITING} =
838 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
840 elsif ( $restype eq "Reserved" ) {
841 # The item is on reserve for someone else.
842 $needsconfirmation{RESERVED} =
843 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
846 return ( \%issuingimpossible, \%needsconfirmation );
851 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
853 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
857 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
859 =item C<$barcode> is the barcode of the item being issued.
861 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
864 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
866 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
867 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
869 AddIssue does the following things :
871 - step 01: check that there is a borrowernumber & a barcode provided
872 - check for RENEWAL (book issued & being issued to the same patron)
873 - renewal YES = Calculate Charge & renew
875 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
877 - fill reserve if reserve to this patron
878 - cancel reserve or not, otherwise
879 * TRANSFERT PENDING ?
880 - complete the transfert
888 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
889 my $dbh = C4::Context->dbh;
890 my $barcodecheck=CheckValidBarcode($barcode);
892 # $issuedate defaults to today.
893 if ( ! defined $issuedate ) {
894 $issuedate = strftime( "%Y-%m-%d", localtime );
895 # TODO: for hourly circ, this will need to be a C4::Dates object
896 # and all calls to AddIssue including issuedate will need to pass a Dates object.
898 if ($borrower and $barcode and $barcodecheck ne '0'){
899 # find which item we issue
900 my $item = GetItem('', $barcode) or return undef; # if we don't get an Item, abort.
901 my $branch = _GetCircControlBranch($item,$borrower);
903 # get actual issuing if there is one
904 my $actualissue = GetItemIssue( $item->{itemnumber});
906 # get biblioinformation for this item
907 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
910 # check if we just renew the issue.
912 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
913 $datedue = AddRenewal(
914 $borrower->{'borrowernumber'},
915 $item->{'itemnumber'},
918 $issuedate, # here interpreted as the renewal date
923 if ( $actualissue->{borrowernumber}) {
924 # This book is currently on loan, but not to the person
925 # who wants to borrow it now. mark it returned before issuing to the new borrower
928 C4::Context->userenv->{'branch'}
932 # See if the item is on reserve.
933 my ( $restype, $res ) =
934 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
936 my $resbor = $res->{'borrowernumber'};
937 if ( $resbor eq $borrower->{'borrowernumber'} ) {
938 # The item is reserved by the current patron
939 ModReserveFill($res);
941 elsif ( $restype eq "Waiting" ) {
943 # The item is on reserve and waiting, but has been
944 # reserved by some other patron.
946 elsif ( $restype eq "Reserved" ) {
948 # The item is reserved by someone else.
949 if ($cancelreserve) { # cancel reserves on this item
950 CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
953 if ($cancelreserve) {
954 CancelReserve($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
957 # set waiting reserve to first in reserve queue as book isn't waiting now
959 $res->{'biblionumber'},
960 $res->{'borrowernumber'},
966 # Starting process for transfer job (checking transfert and validate it if we have one)
967 my ($datesent) = GetTransfers($item->{'itemnumber'});
969 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
972 "UPDATE branchtransfers
973 SET datearrived = now(),
975 comments = 'Forced branchtransfer'
976 WHERE itemnumber= ? AND datearrived IS NULL"
978 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
981 # Record in the database the fact that the book was issued.
985 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
989 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
990 my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
991 $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
995 $borrower->{'borrowernumber'}, # borrowernumber
996 $item->{'itemnumber'}, # itemnumber
997 $issuedate, # issuedate
998 $datedue->output('iso'), # date_due
999 C4::Context->userenv->{'branch'} # branchcode
1002 $item->{'issues'}++;
1003 ModItem({ issues => $item->{'issues'},
1004 holdingbranch => C4::Context->userenv->{'branch'},
1006 datelastborrowed => C4::Dates->new()->output('iso'),
1007 onloan => $datedue->output('iso'),
1008 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1009 ModDateLastSeen( $item->{'itemnumber'} );
1011 # If it costs to borrow this book, charge it to the patron's account.
1012 my ( $charge, $itemtype ) = GetIssuingCharges(
1013 $item->{'itemnumber'},
1014 $borrower->{'borrowernumber'}
1016 if ( $charge > 0 ) {
1018 $item->{'itemnumber'},
1019 $borrower->{'borrowernumber'}, $charge
1021 $item->{'charge'} = $charge;
1024 # Record the fact that this book was issued.
1026 C4::Context->userenv->{'branch'},
1028 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1029 $item->{'itype'}, $borrower->{'borrowernumber'}
1032 # Send a checkout slip.
1033 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1035 branchcode => $branch,
1036 categorycode => $borrower->{categorycode},
1037 item_type => $item->{itype},
1038 notification => 'CHECKOUT',
1040 if ($circulation_alert->is_enabled_for(\%conditions)) {
1041 SendCirculationAlert({
1044 borrower => $borrower,
1050 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1051 if C4::Context->preference("IssueLog");
1053 return ($datedue); # not necessarily the same as when it came in!
1056 =head2 GetLoanLength
1058 Get loan length for an itemtype, a borrower type and a branch
1060 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1065 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1066 my $dbh = C4::Context->dbh;
1069 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1071 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1072 # try to find issuelength & return the 1st available.
1073 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1074 $sth->execute( $borrowertype, $itemtype, $branchcode );
1075 my $loanlength = $sth->fetchrow_hashref;
1076 return $loanlength->{issuelength}
1077 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1079 $sth->execute( $borrowertype, "*", $branchcode );
1080 $loanlength = $sth->fetchrow_hashref;
1081 return $loanlength->{issuelength}
1082 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1084 $sth->execute( "*", $itemtype, $branchcode );
1085 $loanlength = $sth->fetchrow_hashref;
1086 return $loanlength->{issuelength}
1087 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1089 $sth->execute( "*", "*", $branchcode );
1090 $loanlength = $sth->fetchrow_hashref;
1091 return $loanlength->{issuelength}
1092 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1094 $sth->execute( $borrowertype, $itemtype, "*" );
1095 $loanlength = $sth->fetchrow_hashref;
1096 return $loanlength->{issuelength}
1097 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1099 $sth->execute( $borrowertype, "*", "*" );
1100 $loanlength = $sth->fetchrow_hashref;
1101 return $loanlength->{issuelength}
1102 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1104 $sth->execute( "*", $itemtype, "*" );
1105 $loanlength = $sth->fetchrow_hashref;
1106 return $loanlength->{issuelength}
1107 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1109 $sth->execute( "*", "*", "*" );
1110 $loanlength = $sth->fetchrow_hashref;
1111 return $loanlength->{issuelength}
1112 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1114 # if no rule is set => 21 days (hardcoded)
1118 =head2 GetIssuingRule
1120 FIXME - This is a copy-paste of GetLoanLength
1121 as a stop-gap. Do not wish to change API for GetLoanLength
1122 this close to release, however, Overdues::GetIssuingRules is broken.
1124 Get the issuing rule for an itemtype, a borrower type and a branch
1125 Returns a hashref from the issuingrules table.
1127 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1131 sub GetIssuingRule {
1132 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1133 my $dbh = C4::Context->dbh;
1134 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1137 $sth->execute( $borrowertype, $itemtype, $branchcode );
1138 $irule = $sth->fetchrow_hashref;
1139 return $irule if defined($irule) ;
1141 $sth->execute( $borrowertype, "*", $branchcode );
1142 $irule = $sth->fetchrow_hashref;
1143 return $irule if defined($irule) ;
1145 $sth->execute( "*", $itemtype, $branchcode );
1146 $irule = $sth->fetchrow_hashref;
1147 return $irule if defined($irule) ;
1149 $sth->execute( "*", "*", $branchcode );
1150 $irule = $sth->fetchrow_hashref;
1151 return $irule if defined($irule) ;
1153 $sth->execute( $borrowertype, $itemtype, "*" );
1154 $irule = $sth->fetchrow_hashref;
1155 return $irule if defined($irule) ;
1157 $sth->execute( $borrowertype, "*", "*" );
1158 $irule = $sth->fetchrow_hashref;
1159 return $irule if defined($irule) ;
1161 $sth->execute( "*", $itemtype, "*" );
1162 $irule = $sth->fetchrow_hashref;
1163 return $irule if defined($irule) ;
1165 $sth->execute( "*", "*", "*" );
1166 $irule = $sth->fetchrow_hashref;
1167 return $irule if defined($irule) ;
1169 # if no rule matches,
1173 =head2 GetBranchBorrowerCircRule
1177 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1181 Retrieves circulation rule attributes that apply to the given
1182 branch and patron category, regardless of item type.
1183 The return value is a hashref containing the following key:
1185 maxissueqty - maximum number of loans that a
1186 patron of the given category can have at the given
1187 branch. If the value is undef, no limit.
1189 This will first check for a specific branch and
1190 category match from branch_borrower_circ_rules.
1192 If no rule is found, it will then check default_branch_circ_rules
1193 (same branch, default category). If no rule is found,
1194 it will then check default_borrower_circ_rules (default
1195 branch, same category), then failing that, default_circ_rules
1196 (default branch, default category).
1198 If no rule has been found in the database, it will default to
1203 C<$branchcode> and C<$categorycode> should contain the
1204 literal branch code and patron category code, respectively - no
1209 sub GetBranchBorrowerCircRule {
1210 my $branchcode = shift;
1211 my $categorycode = shift;
1213 my $branch_cat_query = "SELECT maxissueqty
1214 FROM branch_borrower_circ_rules
1215 WHERE branchcode = ?
1216 AND categorycode = ?";
1217 my $dbh = C4::Context->dbh();
1218 my $sth = $dbh->prepare($branch_cat_query);
1219 $sth->execute($branchcode, $categorycode);
1221 if ($result = $sth->fetchrow_hashref()) {
1225 # try same branch, default borrower category
1226 my $branch_query = "SELECT maxissueqty
1227 FROM default_branch_circ_rules
1228 WHERE branchcode = ?";
1229 $sth = $dbh->prepare($branch_query);
1230 $sth->execute($branchcode);
1231 if ($result = $sth->fetchrow_hashref()) {
1235 # try default branch, same borrower category
1236 my $category_query = "SELECT maxissueqty
1237 FROM default_borrower_circ_rules
1238 WHERE categorycode = ?";
1239 $sth = $dbh->prepare($category_query);
1240 $sth->execute($categorycode);
1241 if ($result = $sth->fetchrow_hashref()) {
1245 # try default branch, default borrower category
1246 my $default_query = "SELECT maxissueqty
1247 FROM default_circ_rules";
1248 $sth = $dbh->prepare($default_query);
1250 if ($result = $sth->fetchrow_hashref()) {
1254 # built-in default circulation rule
1256 maxissueqty => undef,
1260 =head2 GetBranchItemRule
1264 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1268 Retrieves circulation rule attributes that apply to the given
1269 branch and item type, regardless of patron category.
1271 The return value is a hashref containing the following key:
1273 holdallowed => Hold policy for this branch and itemtype. Possible values:
1274 0: No holds allowed.
1275 1: Holds allowed only by patrons that have the same homebranch as the item.
1276 2: Holds allowed from any patron.
1278 This searches branchitemrules in the following order:
1280 * Same branchcode and itemtype
1281 * Same branchcode, itemtype '*'
1282 * branchcode '*', same itemtype
1283 * branchcode and itemtype '*'
1285 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1289 sub GetBranchItemRule {
1290 my ( $branchcode, $itemtype ) = @_;
1291 my $dbh = C4::Context->dbh();
1295 ['SELECT holdallowed
1296 FROM branch_item_rules
1297 WHERE branchcode = ?
1298 AND itemtype = ?', $branchcode, $itemtype],
1299 ['SELECT holdallowed
1300 FROM default_branch_circ_rules
1301 WHERE branchcode = ?', $branchcode],
1302 ['SELECT holdallowed
1303 FROM default_branch_item_rules
1304 WHERE itemtype = ?', $itemtype],
1305 ['SELECT holdallowed
1306 FROM default_circ_rules'],
1309 foreach my $attempt (@attempts) {
1310 my ($query, @bind_params) = @{$attempt};
1312 # Since branch/category and branch/itemtype use the same per-branch
1313 # defaults tables, we have to check that the key we want is set, not
1314 # just that a row was returned
1315 return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1318 # built-in default circulation rule
1326 ($doreturn, $messages, $iteminformation, $borrower) =
1327 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1333 =item C<$barcode> is the bar code of the book being returned.
1335 =item C<$branch> is the code of the branch where the book is being returned.
1337 =item C<$exemptfine> indicates that overdue charges for the item will be
1340 =item C<$dropbox> indicates that the check-in date is assumed to be
1341 yesterday, or the last non-holiday as defined in C4::Calendar . If
1342 overdue charges are applied and C<$dropbox> is true, the last charge
1343 will be removed. This assumes that the fines accrual script has run
1348 C<&AddReturn> returns a list of four items:
1350 C<$doreturn> is true iff the return succeeded.
1352 C<$messages> is a reference-to-hash giving feedback on the operation.
1353 The keys of the hash are:
1359 No item with this barcode exists. The value is C<$barcode>.
1363 The book is not currently on loan. The value is C<$barcode>.
1365 =item C<IsPermanent>
1367 The book's home branch is a permanent collection. If you have borrowed
1368 this book, you are not allowed to return it. The value is the code for
1369 the book's home branch.
1373 This book has been withdrawn/cancelled. The value should be ignored.
1375 =item C<Wrongbranch>
1377 This book has was returned to the wrong branch. The value is a hashref
1378 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1379 contain the branchcode of the incorrect and correct return library, respectively.
1383 The item was reserved. The value is a reference-to-hash whose keys are
1384 fields from the reserves table of the Koha database, and
1385 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1386 either C<Waiting>, C<Reserved>, or 0.
1390 C<$iteminformation> is a reference-to-hash, giving information about the
1391 returned item from the issues table.
1393 C<$borrower> is a reference-to-hash, giving information about the
1394 patron who last borrowed the book.
1399 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1400 if ($branch and not GetBranchDetail($branch)) {
1401 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1404 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1409 my $validTransfert = 0;
1411 # get information on item
1412 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1413 unless ($itemnumber) {
1414 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1416 my $issue = GetItemIssue($itemnumber);
1417 # warn Dumper($iteminformation);
1418 if ($issue and $issue->{borrowernumber}) {
1419 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1420 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1421 . Dumper($issue) . "\n";
1423 $messages->{'NotIssued'} = $barcode;
1424 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1426 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1429 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1430 # full item data, but no borrowernumber or checkout info (no issue)
1431 # we know GetItem should work because GetItemnumberFromBarcode worked
1432 my $hbr = $item->{C4::Context->preference("HomeOrHoldingBranch")} || '';
1433 # item must be from items table -- issues table has branchcode and issuingbranch, not homebranch nor holdingbranch
1435 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1437 # check if the book is in a permanent collection....
1438 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1440 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1441 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1444 # if indy branches and returning to different branch, refuse the return
1445 if ($hbr ne $branch && C4::Context->preference("IndependantBranches")){
1446 $messages->{'Wrongbranch'} = {
1447 Wrongbranch => $branch,
1448 Rightbranch => $hbr,
1450 $doreturn = 0; # Could we bail here?
1453 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1454 $messages->{'wthdrawn'} = 1;
1458 # case of a return of document (deal with issues and holdingbranch)
1460 $borrower or warn "AddReturn without current borrower";
1461 my $circControlBranch = _GetCircControlBranch($item,$borrower);
1463 # don't allow dropbox mode to create an invalid entry in issues (issuedate > returndate) FIXME: actually checks eq, not gt
1464 undef($dropbox) if ( $item->{'issuedate'} eq C4::Dates->today('iso') );
1467 if ($borrowernumber) {
1468 MarkIssueReturned($borrowernumber, $item->{'itemnumber'}, $circControlBranch);
1469 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right? This could be the borrower hash.
1472 # the holdingbranch is updated if the document is returned to another location.
1473 if ($item->{'holdingbranch'} ne $branch) {
1474 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1475 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1477 ModDateLastSeen( $item->{'itemnumber'} );
1478 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1481 # check if we have a transfer for this document
1482 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1484 # if we have a transfer to do, we update the line of transfers with the datearrived
1486 if ( $tobranch eq $branch ) {
1487 my $sth = C4::Context->dbh->prepare(
1488 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1490 $sth->execute( $item->{'itemnumber'} );
1491 # if we have a reservation with valid transfer, we can set it's status to 'W'
1492 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1494 $messages->{'WrongTransfer'} = $tobranch;
1495 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1497 $validTransfert = 1;
1500 # fix up the accounts.....
1501 if ($item->{'itemlost'}) {
1502 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1503 $messages->{'WasLost'} = 1;
1506 # fix up the overdues in accounts...
1507 if ($borrowernumber) {
1508 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1509 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1512 # find reserves.....
1513 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1514 my ($resfound, $resrec) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1516 $resrec->{'ResFound'} = $resfound;
1517 $messages->{'ResFound'} = $resrec;
1521 # Record the fact that this book was returned.
1523 $branch, 'return', '0', '',
1524 $item->{'itemnumber'},
1525 $biblio->{'itemtype'},
1529 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1530 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1532 branchcode => $branch,
1533 categorycode => $borrower->{categorycode},
1534 item_type => $item->{itype},
1535 notification => 'CHECKIN',
1537 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1538 SendCirculationAlert({
1541 borrower => $borrower,
1546 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1547 if C4::Context->preference("ReturnLog");
1549 # FIXME: make this comment intelligible.
1550 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1551 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1553 if ($doreturn and ($branch ne $item->{$hbr}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) ){
1554 if ( C4::Context->preference("AutomaticItemReturn" ) or
1555 (C4::Context->preference("UseBranchTransferLimits") and
1556 ! IsBranchTransferAllowed($branch, $item->{$hbr}, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1558 warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $item->{$hbr};
1559 warn "item: " . Dumper($item);
1560 ModItemTransfer($item->{'itemnumber'}, $branch, $item->{$hbr});
1561 $messages->{'WasTransfered'} = 1;
1563 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1566 return ( $doreturn, $messages, $issue, $borrower );
1569 =head2 MarkIssueReturned
1573 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate);
1577 Unconditionally marks an issue as being returned by
1578 moving the C<issues> row to C<old_issues> and
1579 setting C<returndate> to the current date, or
1580 the last non-holiday date of the branccode specified in
1581 C<dropbox_branch> . Assumes you've already checked that
1582 it's safe to do this, i.e. last non-holiday > issuedate.
1584 if C<$returndate> is specified (in iso format), it is used as the date
1585 of the return. It is ignored when a dropbox_branch is passed in.
1587 Ideally, this function would be internal to C<C4::Circulation>,
1588 not exported, but it is currently needed by one
1589 routine in C<C4::Accounts>.
1593 sub MarkIssueReturned {
1594 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate ) = @_;
1595 my $dbh = C4::Context->dbh;
1596 my $query = "UPDATE issues SET returndate=";
1598 if ($dropbox_branch) {
1599 my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1600 my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1602 push @bind, $dropboxdate->output('iso');
1603 } elsif ($returndate) {
1605 push @bind, $returndate;
1607 $query .= " now() ";
1609 $query .= " WHERE borrowernumber = ? AND itemnumber = ?";
1610 push @bind, $borrowernumber, $itemnumber;
1612 my $sth_upd = $dbh->prepare($query);
1613 $sth_upd->execute(@bind);
1614 my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1615 WHERE borrowernumber = ?
1616 AND itemnumber = ?");
1617 $sth_copy->execute($borrowernumber, $itemnumber);
1618 my $sth_del = $dbh->prepare("DELETE FROM issues
1619 WHERE borrowernumber = ?
1620 AND itemnumber = ?");
1621 $sth_del->execute($borrowernumber, $itemnumber);
1624 =head2 _FixOverduesOnReturn
1626 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1628 C<$brn> borrowernumber
1632 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1633 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1635 Internal function, called only by AddReturn
1639 sub _FixOverduesOnReturn {
1640 my ($borrowernumber, $item);
1641 unless ($borrowernumber = shift) {
1642 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1645 unless ($item = shift) {
1646 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1649 my ($exemptfine, $dropbox) = @_;
1650 my $dbh = C4::Context->dbh;
1652 # check for overdue fine
1653 my $sth = $dbh->prepare(
1654 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1656 $sth->execute( $borrowernumber, $item );
1658 # alter fine to show that the book has been returned
1659 my $data = $sth->fetchrow_hashref;
1660 return 0 unless $data; # no warning, there's just nothing to fix
1663 my @bind = ($borrowernumber, $item, $data->{'accountno'});
1665 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1666 if (C4::Context->preference("FinesLog")) {
1667 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1669 } elsif ($dropbox && $data->{lastincrement}) {
1670 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1671 my $amt = $data->{amount} - $data->{lastincrement} ;
1672 if (C4::Context->preference("FinesLog")) {
1673 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1675 $uquery = "update accountlines set accounttype='F' ";
1676 if($outstanding >= 0 && $amt >=0) {
1677 $uquery .= ", amount = ? , amountoutstanding=? ";
1678 unshift @bind, ($amt, $outstanding) ;
1681 $uquery = "update accountlines set accounttype='F' ";
1683 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1684 my $usth = $dbh->prepare($uquery);
1685 return $usth->execute(@bind);
1688 =head2 _FixAccountForLostAndReturned
1690 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1692 Calculates the charge for a book lost and returned.
1694 Internal function, not exported, called only by AddReturn.
1696 FIXME: This function reflects how inscrutable fines logic is. Fix both.
1697 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
1701 sub _FixAccountForLostAndReturned {
1702 my $itemnumber = shift or return;
1703 my $borrowernumber = @_ ? shift : undef;
1704 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
1705 my $dbh = C4::Context->dbh;
1706 # check for charge made for lost book
1707 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1708 $sth->execute($itemnumber);
1709 my $data = $sth->fetchrow_hashref;
1710 $data or return; # bail if there is nothing to do
1712 # writeoff this amount
1714 my $amount = $data->{'amount'};
1715 my $acctno = $data->{'accountno'};
1716 my $amountleft; # Starts off undef/zero.
1717 if ($data->{'amountoutstanding'} == $amount) {
1718 $offset = $data->{'amount'};
1719 $amountleft = 0; # Hey, it's zero here, too.
1721 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
1722 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
1724 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1725 WHERE (borrowernumber = ?)
1726 AND (itemnumber = ?) AND (accountno = ?) ");
1727 $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
1728 #check if any credit is left if so writeoff other accounts
1729 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1730 $amountleft *= -1 if ($amountleft < 0);
1731 if ($amountleft > 0) {
1732 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1733 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
1734 $msth->execute($data->{'borrowernumber'});
1735 # offset transactions
1738 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1739 if ($accdata->{'amountoutstanding'} < $amountleft) {
1741 $amountleft -= $accdata->{'amountoutstanding'};
1743 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1746 my $thisacct = $accdata->{'accountno'};
1747 # FIXME: move prepares outside while loop!
1748 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1749 WHERE (borrowernumber = ?)
1750 AND (accountno=?)");
1751 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct'); # FIXME: '$thisacct' is a string literal!
1752 $usth = $dbh->prepare("INSERT INTO accountoffsets
1753 (borrowernumber, accountno, offsetaccount, offsetamount)
1756 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1758 $msth->finish; # $msth might actually have data left
1760 $amountleft *= -1 if ($amountleft > 0);
1761 my $desc = "Item Returned " . $item_id;
1762 $usth = $dbh->prepare("INSERT INTO accountlines
1763 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1764 VALUES (?,?,now(),?,?,'CR',?)");
1765 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1766 if ($borrowernumber) {
1767 # FIXME: same as query above. use 1 sth for both
1768 $usth = $dbh->prepare("INSERT INTO accountoffsets
1769 (borrowernumber, accountno, offsetaccount, offsetamount)
1771 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
1773 ModItem({ paidfor => '' }, undef, $itemnumber);
1777 =head2 _GetCircControlBranch
1779 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
1783 Return the library code to be used to determine which circulation
1784 policy applies to a transaction. Looks up the CircControl and
1785 HomeOrHoldingBranch system preferences.
1787 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
1789 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
1793 sub _GetCircControlBranch {
1794 my ($item, $borrower) = @_;
1795 my $circcontrol = C4::Context->preference('CircControl');
1798 if ($circcontrol eq 'PickupLibrary') {
1799 $branch= C4::Context->userenv->{'branch'};
1800 } elsif ($circcontrol eq 'PatronLibrary') {
1801 $branch=$borrower->{branchcode};
1803 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
1804 $branch = $item->{$branchfield};
1805 # default to item home branch if holdingbranch is used
1806 # and is not defined
1807 if (!defined($branch) && $branchfield eq 'holdingbranch') {
1808 $branch = $item->{homebranch};
1821 $issue = &GetItemIssue($itemnumber);
1823 Returns patron currently having a book, or undef if not checked out.
1825 C<$itemnumber> is the itemnumber.
1827 C<$issue> is a hashref of the row from the issues table.
1832 my ($itemnumber) = @_;
1833 return unless $itemnumber;
1834 my $sth = C4::Context->dbh->prepare(
1837 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1838 WHERE issues.itemnumber=?");
1839 $sth->execute($itemnumber);
1840 my $data = $sth->fetchrow_hashref;
1841 return unless $data;
1842 $data->{'overdue'} = ($data->{'date_due'} lt C4::Dates->today('iso')) ? 1 : 0;
1848 $issue = GetOpenIssue( $itemnumber );
1850 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1852 C<$itemnumber> is the item's itemnumber
1859 my ( $itemnumber ) = @_;
1861 my $dbh = C4::Context->dbh;
1862 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1863 $sth->execute( $itemnumber );
1864 my $issue = $sth->fetchrow_hashref();
1868 =head2 GetItemIssues
1870 $issues = &GetItemIssues($itemnumber, $history);
1872 Returns patrons that have issued a book
1874 C<$itemnumber> is the itemnumber
1875 C<$history> is false if you just want the current "issuer" (if any)
1876 and true if you want issues history from old_issues also.
1878 Returns reference to an array of hashes
1883 my ( $itemnumber, $history ) = @_;
1885 my $today = C4::Dates->today('iso'); # get today date
1886 my $sql = "SELECT * FROM issues
1887 JOIN borrowers USING (borrowernumber)
1888 JOIN items USING (itemnumber)
1889 WHERE issues.itemnumber = ? ";
1892 SELECT * FROM old_issues
1893 LEFT JOIN borrowers USING (borrowernumber)
1894 JOIN items USING (itemnumber)
1895 WHERE old_issues.itemnumber = ? ";
1897 $sql .= "ORDER BY date_due DESC";
1898 my $sth = C4::Context->dbh->prepare($sql);
1900 $sth->execute($itemnumber, $itemnumber);
1902 $sth->execute($itemnumber);
1904 my $results = $sth->fetchall_arrayref({});
1905 foreach (@$results) {
1906 $_->{'overdue'} = ($_->{'date_due'} lt $today) ? 1 : 0;
1911 =head2 GetBiblioIssues
1913 $issues = GetBiblioIssues($biblionumber);
1915 this function get all issues from a biblionumber.
1918 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1919 tables issues and the firstname,surname & cardnumber from borrowers.
1923 sub GetBiblioIssues {
1924 my $biblionumber = shift;
1925 return undef unless $biblionumber;
1926 my $dbh = C4::Context->dbh;
1928 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1930 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1931 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1932 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1933 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1934 WHERE biblio.biblionumber = ?
1936 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1938 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1939 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1940 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1941 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1942 WHERE biblio.biblionumber = ?
1945 my $sth = $dbh->prepare($query);
1946 $sth->execute($biblionumber, $biblionumber);
1949 while ( my $data = $sth->fetchrow_hashref ) {
1950 push @issues, $data;
1955 =head2 GetUpcomingDueIssues
1959 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
1965 sub GetUpcomingDueIssues {
1968 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
1969 my $dbh = C4::Context->dbh;
1971 my $statement = <<END_SQL;
1972 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
1974 LEFT JOIN items USING (itemnumber)
1975 WhERE returndate is NULL
1976 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
1979 my @bind_parameters = ( $params->{'days_in_advance'} );
1981 my $sth = $dbh->prepare( $statement );
1982 $sth->execute( @bind_parameters );
1983 my $upcoming_dues = $sth->fetchall_arrayref({});
1986 return $upcoming_dues;
1989 =head2 CanBookBeRenewed
1991 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
1993 Find out whether a borrowed item may be renewed.
1995 C<$dbh> is a DBI handle to the Koha database.
1997 C<$borrowernumber> is the borrower number of the patron who currently
1998 has the item on loan.
2000 C<$itemnumber> is the number of the item to renew.
2002 C<$override_limit>, if supplied with a true value, causes
2003 the limit on the number of times that the loan can be renewed
2004 (as controlled by the item type) to be ignored.
2006 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2007 item must currently be on loan to the specified borrower; renewals
2008 must be allowed for the item's type; and the borrower must not have
2009 already renewed the loan. $error will contain the reason the renewal can not proceed
2013 sub CanBookBeRenewed {
2015 # check renewal status
2016 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2017 my $dbh = C4::Context->dbh;
2022 # Look in the issues table for this item, lent to this borrower,
2023 # and not yet returned.
2025 # FIXME - I think this function could be redone to use only one SQL call.
2026 my $sth1 = $dbh->prepare(
2027 "SELECT * FROM issues
2028 WHERE borrowernumber = ?
2031 $sth1->execute( $borrowernumber, $itemnumber );
2032 if ( my $data1 = $sth1->fetchrow_hashref ) {
2034 # Found a matching item
2036 # See if this item may be renewed. This query is convoluted
2037 # because it's a bit messy: given the item number, we need to find
2038 # the biblioitem, which gives us the itemtype, which tells us
2039 # whether it may be renewed.
2040 my $query = "SELECT renewalsallowed FROM items ";
2041 $query .= (C4::Context->preference('item-level_itypes'))
2042 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2043 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2044 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2045 $query .= "WHERE items.itemnumber = ?";
2046 my $sth2 = $dbh->prepare($query);
2047 $sth2->execute($itemnumber);
2048 if ( my $data2 = $sth2->fetchrow_hashref ) {
2049 $renews = $data2->{'renewalsallowed'};
2051 if ( ( $renews && $renews > $data1->{'renewals'} ) || $override_limit ) {
2058 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2066 return ($renewokay,$error);
2071 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2075 C<$borrowernumber> is the borrower number of the patron who currently
2078 C<$itemnumber> is the number of the item to renew.
2080 C<$branch> is the library where the renewal took place (if any).
2081 The library that controls the circ policies for the renewal is retrieved from the issues record.
2083 C<$datedue> can be a C4::Dates object used to set the due date.
2085 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2086 this parameter is not supplied, lastreneweddate is set to the current date.
2088 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2089 from the book's item type.
2094 my $borrowernumber = shift or return undef;
2095 my $itemnumber = shift or return undef;
2097 my $datedue = shift;
2098 my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2099 my $item = GetItem($itemnumber) or return undef;
2100 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2102 my $dbh = C4::Context->dbh;
2103 # Find the issues record for this book
2105 $dbh->prepare("SELECT * FROM issues
2106 WHERE borrowernumber=?
2109 $sth->execute( $borrowernumber, $itemnumber );
2110 my $issuedata = $sth->fetchrow_hashref;
2112 if($datedue && ! $datedue->output('iso')){
2113 warn "Invalid date passed to AddRenewal.";
2116 # If the due date wasn't specified, calculate it by adding the
2117 # book's loan length to today's date or the current due date
2118 # based on the value of the RenewalPeriodBase syspref.
2121 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2122 my $loanlength = GetLoanLength(
2123 $borrower->{'categorycode'},
2124 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2125 $issuedata->{'branchcode'} ); # that's the circ control branch.
2127 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2128 C4::Dates->new($issuedata->{date_due}, 'iso') :
2130 $datedue = CalcDateDue($datedue,$loanlength,$issuedata->{'branchcode'},$borrower);
2133 # Update the issues record to have the new due date, and a new count
2134 # of how many times it has been renewed.
2135 my $renews = $issuedata->{'renewals'} + 1;
2136 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2137 WHERE borrowernumber=?
2140 $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2143 # Update the renewal count on the item, and tell zebra to reindex
2144 $renews = $biblio->{'renewals'} + 1;
2145 ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2147 # Charge a new rental fee, if applicable?
2148 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2149 if ( $charge > 0 ) {
2150 my $accountno = getnextacctno( $borrowernumber );
2151 my $item = GetBiblioFromItemNumber($itemnumber);
2152 $sth = $dbh->prepare(
2153 "INSERT INTO accountlines
2155 borrowernumber, accountno, amount,
2157 accounttype, amountoutstanding, itemnumber
2159 VALUES (now(),?,?,?,?,?,?,?)"
2161 $sth->execute( $borrowernumber, $accountno, $charge,
2162 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2163 'Rent', $charge, $itemnumber );
2167 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2172 # check renewal status
2173 my ($bornum,$itemno)=@_;
2174 my $dbh = C4::Context->dbh;
2176 my $renewsallowed = 0;
2178 # Look in the issues table for this item, lent to this borrower,
2179 # and not yet returned.
2181 # FIXME - I think this function could be redone to use only one SQL call.
2182 my $sth = $dbh->prepare("select * from issues
2183 where (borrowernumber = ?)
2184 and (itemnumber = ?)");
2185 $sth->execute($bornum,$itemno);
2186 my $data = $sth->fetchrow_hashref;
2187 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2189 my $query = "SELECT renewalsallowed FROM items ";
2190 $query .= (C4::Context->preference('item-level_itypes'))
2191 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2192 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2193 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2194 $query .= "WHERE items.itemnumber = ?";
2195 my $sth2 = $dbh->prepare($query);
2196 $sth2->execute($itemno);
2197 my $data2 = $sth2->fetchrow_hashref();
2198 $renewsallowed = $data2->{'renewalsallowed'};
2199 $renewsleft = $renewsallowed - $renewcount;
2200 return ($renewcount,$renewsallowed,$renewsleft);
2203 =head2 GetIssuingCharges
2205 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2207 Calculate how much it would cost for a given patron to borrow a given
2208 item, including any applicable discounts.
2210 C<$itemnumber> is the item number of item the patron wishes to borrow.
2212 C<$borrowernumber> is the patron's borrower number.
2214 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2215 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2220 sub GetIssuingCharges {
2222 # calculate charges due
2223 my ( $itemnumber, $borrowernumber ) = @_;
2225 my $dbh = C4::Context->dbh;
2228 # Get the book's item type and rental charge (via its biblioitem).
2229 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
2230 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2231 $qcharge .= (C4::Context->preference('item-level_itypes'))
2232 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2233 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2235 $qcharge .= "WHERE items.itemnumber =?";
2237 my $sth1 = $dbh->prepare($qcharge);
2238 $sth1->execute($itemnumber);
2239 if ( my $data1 = $sth1->fetchrow_hashref ) {
2240 $item_type = $data1->{'itemtype'};
2241 $charge = $data1->{'rentalcharge'};
2242 my $q2 = "SELECT rentaldiscount FROM borrowers
2243 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2244 WHERE borrowers.borrowernumber = ?
2245 AND issuingrules.itemtype = ?";
2246 my $sth2 = $dbh->prepare($q2);
2247 $sth2->execute( $borrowernumber, $item_type );
2248 if ( my $data2 = $sth2->fetchrow_hashref ) {
2249 my $discount = $data2->{'rentaldiscount'};
2250 if ( $discount eq 'NULL' ) {
2253 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2259 return ( $charge, $item_type );
2262 =head2 AddIssuingCharge
2264 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2268 sub AddIssuingCharge {
2269 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2270 my $dbh = C4::Context->dbh;
2271 my $nextaccntno = getnextacctno( $borrowernumber );
2273 INSERT INTO accountlines
2274 (borrowernumber, itemnumber, accountno,
2275 date, amount, description, accounttype,
2277 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2279 my $sth = $dbh->prepare($query);
2280 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2286 GetTransfers($itemnumber);
2291 my ($itemnumber) = @_;
2293 my $dbh = C4::Context->dbh;
2299 FROM branchtransfers
2300 WHERE itemnumber = ?
2301 AND datearrived IS NULL
2303 my $sth = $dbh->prepare($query);
2304 $sth->execute($itemnumber);
2305 my @row = $sth->fetchrow_array();
2310 =head2 GetTransfersFromTo
2312 @results = GetTransfersFromTo($frombranch,$tobranch);
2314 Returns the list of pending transfers between $from and $to branch
2318 sub GetTransfersFromTo {
2319 my ( $frombranch, $tobranch ) = @_;
2320 return unless ( $frombranch && $tobranch );
2321 my $dbh = C4::Context->dbh;
2323 SELECT itemnumber,datesent,frombranch
2324 FROM branchtransfers
2327 AND datearrived IS NULL
2329 my $sth = $dbh->prepare($query);
2330 $sth->execute( $frombranch, $tobranch );
2333 while ( my $data = $sth->fetchrow_hashref ) {
2334 push @gettransfers, $data;
2337 return (@gettransfers);
2340 =head2 DeleteTransfer
2342 &DeleteTransfer($itemnumber);
2346 sub DeleteTransfer {
2347 my ($itemnumber) = @_;
2348 my $dbh = C4::Context->dbh;
2349 my $sth = $dbh->prepare(
2350 "DELETE FROM branchtransfers
2352 AND datearrived IS NULL "
2354 $sth->execute($itemnumber);
2358 =head2 AnonymiseIssueHistory
2360 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2362 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2363 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2365 return the number of affected rows.
2369 sub AnonymiseIssueHistory {
2371 my $borrowernumber = shift;
2372 my $dbh = C4::Context->dbh;
2375 SET borrowernumber = NULL
2376 WHERE returndate < '".$date."'
2377 AND borrowernumber IS NOT NULL
2379 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2380 my $rows_affected = $dbh->do($query);
2381 return $rows_affected;
2384 =head2 SendCirculationAlert
2386 Send out a C<check-in> or C<checkout> alert using the messaging system.
2394 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2398 Hashref of information about the item being checked in or out.
2402 Hashref of information about the borrower of the item.
2406 The branchcode from where the checkout or check-in took place.
2412 SendCirculationAlert({
2415 borrower => $borrower,
2421 sub SendCirculationAlert {
2423 my ($type, $item, $borrower, $branch) =
2424 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2425 my %message_name = (
2426 CHECKIN => 'Item Check-in',
2427 CHECKOUT => 'Item Checkout',
2429 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2430 borrowernumber => $borrower->{borrowernumber},
2431 message_name => $message_name{$type},
2433 my $letter = C4::Letters::getletter('circulation', $type);
2434 C4::Letters::parseletter($letter, 'biblio', $item->{biblionumber});
2435 C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2436 C4::Letters::parseletter($letter, 'borrowers', $borrower->{borrowernumber});
2437 C4::Letters::parseletter($letter, 'branches', $branch);
2438 my @transports = @{ $borrower_preferences->{transports} };
2439 # warn "no transports" unless @transports;
2441 # warn "transport: $_";
2442 my $message = C4::Message->find_last_message($borrower, $type, $_);
2444 #warn "create new message";
2445 C4::Message->enqueue($letter, $borrower, $_);
2447 #warn "append to old message";
2448 $message->append($letter);
2455 =head2 updateWrongTransfer
2457 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2459 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
2463 sub updateWrongTransfer {
2464 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2465 my $dbh = C4::Context->dbh;
2466 # first step validate the actual line of transfert .
2469 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2471 $sth->execute($FromLibrary,$itemNumber);
2474 # second step create a new line of branchtransfer to the right location .
2475 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2477 #third step changing holdingbranch of item
2478 UpdateHoldingbranch($FromLibrary,$itemNumber);
2481 =head2 UpdateHoldingbranch
2483 $items = UpdateHoldingbranch($branch,$itmenumber);
2484 Simple methode for updating hodlingbranch in items BDD line
2488 sub UpdateHoldingbranch {
2489 my ( $branch,$itemnumber ) = @_;
2490 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2495 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2496 this function calculates the due date given the loan length ,
2497 checking against the holidays calendar as per the 'useDaysMode' syspref.
2498 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2499 C<$branch> = location whose calendar to use
2500 C<$loanlength> = loan length prior to adjustment
2504 my ($startdate,$loanlength,$branch,$borrower) = @_;
2507 if(C4::Context->preference('useDaysMode') eq 'Days') { # ignoring calendar
2508 my $timedue = time + ($loanlength) * 86400;
2509 #FIXME - assumes now even though we take a startdate
2510 my @datearr = localtime($timedue);
2511 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2513 my $calendar = C4::Calendar->new( branchcode => $branch );
2514 $datedue = $calendar->addDate($startdate, $loanlength);
2517 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2518 if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2519 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2522 # if ceilingDueDate ON the datedue can't be after the ceiling date
2523 if ( C4::Context->preference('ceilingDueDate')
2524 && ( C4::Context->preference('ceilingDueDate') =~ C4::Dates->regexp('syspref') ) ) {
2525 my $ceilingDate = C4::Dates->new( C4::Context->preference('ceilingDueDate') );
2526 if ( $datedue->output( 'iso' ) gt $ceilingDate->output( 'iso' ) ) {
2527 $datedue = $ceilingDate;
2534 =head2 CheckValidDatedue
2535 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2536 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2538 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2539 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2540 C<$date_due> = returndate calculate with no day check
2541 C<$itemnumber> = itemnumber
2542 C<$branchcode> = location of issue (affected by 'CircControl' syspref)
2543 C<$loanlength> = loan length prior to adjustment
2546 sub CheckValidDatedue {
2547 my ($date_due,$itemnumber,$branchcode)=@_;
2548 my @datedue=split('-',$date_due->output('iso'));
2549 my $years=$datedue[0];
2550 my $month=$datedue[1];
2551 my $day=$datedue[2];
2552 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2554 for (my $i=0;$i<2;$i++){
2555 $dow=Day_of_Week($years,$month,$day);
2556 ($dow=0) if ($dow>6);
2557 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2558 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2559 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2560 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2562 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2565 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2570 =head2 CheckRepeatableHolidays
2572 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2573 this function checks if the date due is a repeatable holiday
2574 C<$date_due> = returndate calculate with no day check
2575 C<$itemnumber> = itemnumber
2576 C<$branchcode> = localisation of issue
2580 sub CheckRepeatableHolidays{
2581 my($itemnumber,$week_day,$branchcode)=@_;
2582 my $dbh = C4::Context->dbh;
2583 my $query = qq|SELECT count(*)
2584 FROM repeatable_holidays
2587 my $sth = $dbh->prepare($query);
2588 $sth->execute($branchcode,$week_day);
2589 my $result=$sth->fetchrow;
2595 =head2 CheckSpecialHolidays
2597 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2598 this function check if the date is a special holiday
2599 C<$years> = the years of datedue
2600 C<$month> = the month of datedue
2601 C<$day> = the day of datedue
2602 C<$itemnumber> = itemnumber
2603 C<$branchcode> = localisation of issue
2607 sub CheckSpecialHolidays{
2608 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2609 my $dbh = C4::Context->dbh;
2610 my $query=qq|SELECT count(*)
2611 FROM `special_holidays`
2617 my $sth = $dbh->prepare($query);
2618 $sth->execute($years,$month,$day,$branchcode);
2619 my $countspecial=$sth->fetchrow ;
2621 return $countspecial;
2624 =head2 CheckRepeatableSpecialHolidays
2626 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2627 this function check if the date is a repeatble special holidays
2628 C<$month> = the month of datedue
2629 C<$day> = the day of datedue
2630 C<$itemnumber> = itemnumber
2631 C<$branchcode> = localisation of issue
2635 sub CheckRepeatableSpecialHolidays{
2636 my ($month,$day,$itemnumber,$branchcode) = @_;
2637 my $dbh = C4::Context->dbh;
2638 my $query=qq|SELECT count(*)
2639 FROM `repeatable_holidays`
2644 my $sth = $dbh->prepare($query);
2645 $sth->execute($month,$day,$branchcode);
2646 my $countspecial=$sth->fetchrow ;
2648 return $countspecial;
2653 sub CheckValidBarcode{
2655 my $dbh = C4::Context->dbh;
2656 my $query=qq|SELECT count(*)
2660 my $sth = $dbh->prepare($query);
2661 $sth->execute($barcode);
2662 my $exist=$sth->fetchrow ;
2667 =head2 IsBranchTransferAllowed
2669 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2671 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2675 sub IsBranchTransferAllowed {
2676 my ( $toBranch, $fromBranch, $code ) = @_;
2678 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2680 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2681 my $dbh = C4::Context->dbh;
2683 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2684 $sth->execute( $toBranch, $fromBranch, $code );
2685 my $limit = $sth->fetchrow_hashref();
2687 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2688 if ( $limit->{'limitId'} ) {
2695 =head2 CreateBranchTransferLimit
2697 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2699 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2703 sub CreateBranchTransferLimit {
2704 my ( $toBranch, $fromBranch, $code ) = @_;
2706 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2708 my $dbh = C4::Context->dbh;
2710 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2711 $sth->execute( $code, $toBranch, $fromBranch );
2714 =head2 DeleteBranchTransferLimits
2716 DeleteBranchTransferLimits();
2720 sub DeleteBranchTransferLimits {
2721 my $dbh = C4::Context->dbh;
2722 my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2733 Koha Developement team <info@koha.org>