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;
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;
329 ModDateLastSeen( $itemnumber );
331 return ( $dotransfer, $messages, $biblio );
336 my $borrower = shift;
337 my $biblionumber = shift;
339 my $cat_borrower = $borrower->{'categorycode'};
340 my $dbh = C4::Context->dbh;
342 # Get which branchcode we need
343 $branch = _GetCircControlBranch($item,$borrower);
344 my $type = (C4::Context->preference('item-level_itypes'))
345 ? $item->{'itype'} # item-level
346 : $item->{'itemtype'}; # biblio-level
348 # given branch, patron category, and item type, determine
349 # applicable issuing rule
350 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
352 # if a rule is found and has a loan limit set, count
353 # how many loans the patron already has that meet that
355 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
357 my $count_query = "SELECT COUNT(*) FROM issues
358 JOIN items USING (itemnumber) ";
360 my $rule_itemtype = $issuing_rule->{itemtype};
361 if ($rule_itemtype eq "*") {
362 # matching rule has the default item type, so count only
363 # those existing loans that don't fall under a more
365 if (C4::Context->preference('item-level_itypes')) {
366 $count_query .= " WHERE items.itype NOT IN (
367 SELECT itemtype FROM issuingrules
369 AND (categorycode = ? OR categorycode = ?)
373 $count_query .= " JOIN biblioitems USING (biblionumber)
374 WHERE biblioitems.itemtype NOT IN (
375 SELECT itemtype FROM issuingrules
377 AND (categorycode = ? OR categorycode = ?)
381 push @bind_params, $issuing_rule->{branchcode};
382 push @bind_params, $issuing_rule->{categorycode};
383 push @bind_params, $cat_borrower;
385 # rule has specific item type, so count loans of that
387 if (C4::Context->preference('item-level_itypes')) {
388 $count_query .= " WHERE items.itype = ? ";
390 $count_query .= " JOIN biblioitems USING (biblionumber)
391 WHERE biblioitems.itemtype= ? ";
393 push @bind_params, $type;
396 $count_query .= " AND borrowernumber = ? ";
397 push @bind_params, $borrower->{'borrowernumber'};
398 my $rule_branch = $issuing_rule->{branchcode};
399 if ($rule_branch ne "*") {
400 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
401 $count_query .= " AND issues.branchcode = ? ";
402 push @bind_params, $branch;
403 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
404 ; # if branch is the patron's home branch, then count all loans by patron
406 $count_query .= " AND items.homebranch = ? ";
407 push @bind_params, $branch;
411 my $count_sth = $dbh->prepare($count_query);
412 $count_sth->execute(@bind_params);
413 my ($current_loan_count) = $count_sth->fetchrow_array;
415 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
416 if ($current_loan_count >= $max_loans_allowed) {
417 return "$current_loan_count / $max_loans_allowed";
421 # Now count total loans against the limit for the branch
422 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
423 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
424 my @bind_params = ();
425 my $branch_count_query = "SELECT COUNT(*) FROM issues
426 JOIN items USING (itemnumber)
427 WHERE borrowernumber = ? ";
428 push @bind_params, $borrower->{borrowernumber};
430 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
431 $branch_count_query .= " AND issues.branchcode = ? ";
432 push @bind_params, $branch;
433 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
434 ; # if branch is the patron's home branch, then count all loans by patron
436 $branch_count_query .= " AND items.homebranch = ? ";
437 push @bind_params, $branch;
439 my $branch_count_sth = $dbh->prepare($branch_count_query);
440 $branch_count_sth->execute(@bind_params);
441 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
443 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
444 if ($current_loan_count >= $max_loans_allowed) {
445 return "$current_loan_count / $max_loans_allowed";
449 # OK, the patron can issue !!!
455 @issues = &itemissues($biblioitemnumber, $biblio);
457 Looks up information about who has borrowed the bookZ<>(s) with the
458 given biblioitemnumber.
460 C<$biblio> is ignored.
462 C<&itemissues> returns an array of references-to-hash. The keys
463 include the fields from the C<items> table in the Koha database.
464 Additional keys include:
470 If the item is currently on loan, this gives the due date.
472 If the item is not on loan, then this is either "Available" or
473 "Cancelled", if the item has been withdrawn.
477 If the item is currently on loan, this gives the card number of the
478 patron who currently has the item.
480 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
482 These give the timestamp for the last three times the item was
485 =item C<card0>, C<card1>, C<card2>
487 The card number of the last three patrons who borrowed this item.
489 =item C<borrower0>, C<borrower1>, C<borrower2>
491 The borrower number of the last three patrons who borrowed this item.
499 my ( $bibitem, $biblio ) = @_;
500 my $dbh = C4::Context->dbh;
502 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
507 $sth->execute($bibitem) || die $sth->errstr;
509 while ( my $data = $sth->fetchrow_hashref ) {
511 # Find out who currently has this item.
512 # FIXME - Wouldn't it be better to do this as a left join of
513 # some sort? Currently, this code assumes that if
514 # fetchrow_hashref() fails, then the book is on the shelf.
515 # fetchrow_hashref() can fail for any number of reasons (e.g.,
516 # database server crash), not just because no items match the
518 my $sth2 = $dbh->prepare(
519 "SELECT * FROM issues
520 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
525 $sth2->execute( $data->{'itemnumber'} );
526 if ( my $data2 = $sth2->fetchrow_hashref ) {
527 $data->{'date_due'} = $data2->{'date_due'};
528 $data->{'card'} = $data2->{'cardnumber'};
529 $data->{'borrower'} = $data2->{'borrowernumber'};
532 $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'};
556 $results[$i] = $data;
564 =head2 CanBookBeIssued
566 Check if a book can be issued.
568 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower, $barcode, $duedatespec, $inprocess );
570 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
574 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
576 =item C<$barcode> is the bar code of the book being issued.
578 =item C<$duedatespec> is a C4::Dates object.
588 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
589 Possible values are :
595 sticky due date is invalid
599 borrower gone with no address
603 borrower declared it's card lost
609 =head3 UNKNOWN_BARCODE
623 item is restricted (set by ??)
625 C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
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 );
735 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
737 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
738 # if TooMany return / 0, then the user has no permission to check out this book
739 if ($toomany =~ /\/ 0/) {
740 $needsconfirmation{PATRON_CANT} = 1;
742 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
748 if ( $item->{'notforloan'}
749 && $item->{'notforloan'} > 0 )
751 if(!C4::Context->preference("AllowNotForLoanOverride")){
752 $issuingimpossible{NOT_FOR_LOAN} = 1;
754 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
757 elsif ( !$item->{'notforloan'} ){
758 # we have to check itemtypes.notforloan also
759 if (C4::Context->preference('item-level_itypes')){
760 # this should probably be a subroutine
761 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
762 $sth->execute($item->{'itemtype'});
763 my $notforloan=$sth->fetchrow_hashref();
765 if ($notforloan->{'notforloan'}) {
766 if (!C4::Context->preference("AllowNotForLoanOverride")) {
767 $issuingimpossible{NOT_FOR_LOAN} = 1;
769 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
773 elsif ($biblioitem->{'notforloan'} == 1){
774 if (!C4::Context->preference("AllowNotForLoanOverride")) {
775 $issuingimpossible{NOT_FOR_LOAN} = 1;
777 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
781 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
783 $issuingimpossible{WTHDRAWN} = 1;
785 if ( $item->{'restricted'}
786 && $item->{'restricted'} == 1 )
788 $issuingimpossible{RESTRICTED} = 1;
790 if ( C4::Context->preference("IndependantBranches") ) {
791 my $userenv = C4::Context->userenv;
792 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
793 $issuingimpossible{NOTSAMEBRANCH} = 1
794 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
799 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
801 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
804 # Already issued to current borrower. Ask whether the loan should
806 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
807 $borrower->{'borrowernumber'},
808 $item->{'itemnumber'}
810 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
811 $issuingimpossible{NO_MORE_RENEWALS} = 1;
814 $needsconfirmation{RENEW_ISSUE} = 1;
817 elsif ($issue->{borrowernumber}) {
819 # issued to someone else
820 my $currborinfo = C4::Members::GetMemberDetails( $issue->{borrowernumber} );
822 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
823 $needsconfirmation{ISSUED_TO_ANOTHER} =
824 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
827 # See if the item is on reserve.
828 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
830 my $resbor = $res->{'borrowernumber'};
831 my ( $resborrower ) = C4::Members::GetMemberDetails( $resbor, 0 );
832 my $branches = GetBranches();
833 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
834 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
836 # The item is on reserve and waiting, but has been
837 # reserved by some other patron.
838 $needsconfirmation{RESERVE_WAITING} =
839 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
841 elsif ( $restype eq "Reserved" ) {
842 # The item is on reserve for someone else.
843 $needsconfirmation{RESERVED} =
844 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
847 return ( \%issuingimpossible, \%needsconfirmation );
852 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
854 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
858 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
860 =item C<$barcode> is the barcode of the item being issued.
862 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
865 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
867 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
868 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
870 AddIssue does the following things :
872 - step 01: check that there is a borrowernumber & a barcode provided
873 - check for RENEWAL (book issued & being issued to the same patron)
874 - renewal YES = Calculate Charge & renew
876 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
878 - fill reserve if reserve to this patron
879 - cancel reserve or not, otherwise
880 * TRANSFERT PENDING ?
881 - complete the transfert
889 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
890 my $dbh = C4::Context->dbh;
891 my $barcodecheck=CheckValidBarcode($barcode);
893 # $issuedate defaults to today.
894 if ( ! defined $issuedate ) {
895 $issuedate = strftime( "%Y-%m-%d", localtime );
896 # TODO: for hourly circ, this will need to be a C4::Dates object
897 # and all calls to AddIssue including issuedate will need to pass a Dates object.
899 if ($borrower and $barcode and $barcodecheck ne '0'){
900 # find which item we issue
901 my $item = GetItem('', $barcode) or return undef; # if we don't get an Item, abort.
902 my $branch = _GetCircControlBranch($item,$borrower);
904 # get actual issuing if there is one
905 my $actualissue = GetItemIssue( $item->{itemnumber});
907 # get biblioinformation for this item
908 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
911 # check if we just renew the issue.
913 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
914 $datedue = AddRenewal(
915 $borrower->{'borrowernumber'},
916 $item->{'itemnumber'},
919 $issuedate, # here interpreted as the renewal date
924 if ( $actualissue->{borrowernumber}) {
925 # This book is currently on loan, but not to the person
926 # who wants to borrow it now. mark it returned before issuing to the new borrower
929 C4::Context->userenv->{'branch'}
933 # See if the item is on reserve.
934 my ( $restype, $res ) =
935 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
937 my $resbor = $res->{'borrowernumber'};
938 if ( $resbor eq $borrower->{'borrowernumber'} ) {
939 # The item is reserved by the current patron
940 ModReserveFill($res);
942 elsif ( $restype eq "Waiting" ) {
944 # The item is on reserve and waiting, but has been
945 # reserved by some other patron.
947 elsif ( $restype eq "Reserved" ) {
949 # The item is reserved by someone else.
950 if ($cancelreserve) { # cancel reserves on this item
951 CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
954 if ($cancelreserve) {
955 CancelReserve($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
958 # set waiting reserve to first in reserve queue as book isn't waiting now
960 $res->{'biblionumber'},
961 $res->{'borrowernumber'},
967 # Starting process for transfer job (checking transfert and validate it if we have one)
968 my ($datesent) = GetTransfers($item->{'itemnumber'});
970 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
973 "UPDATE branchtransfers
974 SET datearrived = now(),
976 comments = 'Forced branchtransfer'
977 WHERE itemnumber= ? AND datearrived IS NULL"
979 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
982 # Record in the database the fact that the book was issued.
986 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
990 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
991 my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
992 $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
996 $borrower->{'borrowernumber'}, # borrowernumber
997 $item->{'itemnumber'}, # itemnumber
998 $issuedate, # issuedate
999 $datedue->output('iso'), # date_due
1000 C4::Context->userenv->{'branch'} # branchcode
1003 $item->{'issues'}++;
1004 ModItem({ issues => $item->{'issues'},
1005 holdingbranch => C4::Context->userenv->{'branch'},
1007 datelastborrowed => C4::Dates->new()->output('iso'),
1008 onloan => $datedue->output('iso'),
1009 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1010 ModDateLastSeen( $item->{'itemnumber'} );
1012 # If it costs to borrow this book, charge it to the patron's account.
1013 my ( $charge, $itemtype ) = GetIssuingCharges(
1014 $item->{'itemnumber'},
1015 $borrower->{'borrowernumber'}
1017 if ( $charge > 0 ) {
1019 $item->{'itemnumber'},
1020 $borrower->{'borrowernumber'}, $charge
1022 $item->{'charge'} = $charge;
1025 # Record the fact that this book was issued.
1027 C4::Context->userenv->{'branch'},
1029 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1030 $item->{'itype'}, $borrower->{'borrowernumber'}
1033 # Send a checkout slip.
1034 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1036 branchcode => $branch,
1037 categorycode => $borrower->{categorycode},
1038 item_type => $item->{itype},
1039 notification => 'CHECKOUT',
1041 if ($circulation_alert->is_enabled_for(\%conditions)) {
1042 SendCirculationAlert({
1045 borrower => $borrower,
1051 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1052 if C4::Context->preference("IssueLog");
1054 return ($datedue); # not necessarily the same as when it came in!
1057 =head2 GetLoanLength
1059 Get loan length for an itemtype, a borrower type and a branch
1061 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1066 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1067 my $dbh = C4::Context->dbh;
1070 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1072 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1073 # try to find issuelength & return the 1st available.
1074 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1075 $sth->execute( $borrowertype, $itemtype, $branchcode );
1076 my $loanlength = $sth->fetchrow_hashref;
1077 return $loanlength->{issuelength}
1078 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1080 $sth->execute( $borrowertype, "*", $branchcode );
1081 $loanlength = $sth->fetchrow_hashref;
1082 return $loanlength->{issuelength}
1083 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1085 $sth->execute( "*", $itemtype, $branchcode );
1086 $loanlength = $sth->fetchrow_hashref;
1087 return $loanlength->{issuelength}
1088 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1090 $sth->execute( "*", "*", $branchcode );
1091 $loanlength = $sth->fetchrow_hashref;
1092 return $loanlength->{issuelength}
1093 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1095 $sth->execute( $borrowertype, $itemtype, "*" );
1096 $loanlength = $sth->fetchrow_hashref;
1097 return $loanlength->{issuelength}
1098 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1100 $sth->execute( $borrowertype, "*", "*" );
1101 $loanlength = $sth->fetchrow_hashref;
1102 return $loanlength->{issuelength}
1103 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1105 $sth->execute( "*", $itemtype, "*" );
1106 $loanlength = $sth->fetchrow_hashref;
1107 return $loanlength->{issuelength}
1108 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1110 $sth->execute( "*", "*", "*" );
1111 $loanlength = $sth->fetchrow_hashref;
1112 return $loanlength->{issuelength}
1113 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1115 # if no rule is set => 21 days (hardcoded)
1119 =head2 GetIssuingRule
1121 FIXME - This is a copy-paste of GetLoanLength
1122 as a stop-gap. Do not wish to change API for GetLoanLength
1123 this close to release, however, Overdues::GetIssuingRules is broken.
1125 Get the issuing rule for an itemtype, a borrower type and a branch
1126 Returns a hashref from the issuingrules table.
1128 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1132 sub GetIssuingRule {
1133 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1134 my $dbh = C4::Context->dbh;
1135 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1138 $sth->execute( $borrowertype, $itemtype, $branchcode );
1139 $irule = $sth->fetchrow_hashref;
1140 return $irule if defined($irule) ;
1142 $sth->execute( $borrowertype, "*", $branchcode );
1143 $irule = $sth->fetchrow_hashref;
1144 return $irule if defined($irule) ;
1146 $sth->execute( "*", $itemtype, $branchcode );
1147 $irule = $sth->fetchrow_hashref;
1148 return $irule if defined($irule) ;
1150 $sth->execute( "*", "*", $branchcode );
1151 $irule = $sth->fetchrow_hashref;
1152 return $irule if defined($irule) ;
1154 $sth->execute( $borrowertype, $itemtype, "*" );
1155 $irule = $sth->fetchrow_hashref;
1156 return $irule if defined($irule) ;
1158 $sth->execute( $borrowertype, "*", "*" );
1159 $irule = $sth->fetchrow_hashref;
1160 return $irule if defined($irule) ;
1162 $sth->execute( "*", $itemtype, "*" );
1163 $irule = $sth->fetchrow_hashref;
1164 return $irule if defined($irule) ;
1166 $sth->execute( "*", "*", "*" );
1167 $irule = $sth->fetchrow_hashref;
1168 return $irule if defined($irule) ;
1170 # if no rule matches,
1174 =head2 GetBranchBorrowerCircRule
1178 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1182 Retrieves circulation rule attributes that apply to the given
1183 branch and patron category, regardless of item type.
1184 The return value is a hashref containing the following key:
1186 maxissueqty - maximum number of loans that a
1187 patron of the given category can have at the given
1188 branch. If the value is undef, no limit.
1190 This will first check for a specific branch and
1191 category match from branch_borrower_circ_rules.
1193 If no rule is found, it will then check default_branch_circ_rules
1194 (same branch, default category). If no rule is found,
1195 it will then check default_borrower_circ_rules (default
1196 branch, same category), then failing that, default_circ_rules
1197 (default branch, default category).
1199 If no rule has been found in the database, it will default to
1204 C<$branchcode> and C<$categorycode> should contain the
1205 literal branch code and patron category code, respectively - no
1210 sub GetBranchBorrowerCircRule {
1211 my $branchcode = shift;
1212 my $categorycode = shift;
1214 my $branch_cat_query = "SELECT maxissueqty
1215 FROM branch_borrower_circ_rules
1216 WHERE branchcode = ?
1217 AND categorycode = ?";
1218 my $dbh = C4::Context->dbh();
1219 my $sth = $dbh->prepare($branch_cat_query);
1220 $sth->execute($branchcode, $categorycode);
1222 if ($result = $sth->fetchrow_hashref()) {
1226 # try same branch, default borrower category
1227 my $branch_query = "SELECT maxissueqty
1228 FROM default_branch_circ_rules
1229 WHERE branchcode = ?";
1230 $sth = $dbh->prepare($branch_query);
1231 $sth->execute($branchcode);
1232 if ($result = $sth->fetchrow_hashref()) {
1236 # try default branch, same borrower category
1237 my $category_query = "SELECT maxissueqty
1238 FROM default_borrower_circ_rules
1239 WHERE categorycode = ?";
1240 $sth = $dbh->prepare($category_query);
1241 $sth->execute($categorycode);
1242 if ($result = $sth->fetchrow_hashref()) {
1246 # try default branch, default borrower category
1247 my $default_query = "SELECT maxissueqty
1248 FROM default_circ_rules";
1249 $sth = $dbh->prepare($default_query);
1251 if ($result = $sth->fetchrow_hashref()) {
1255 # built-in default circulation rule
1257 maxissueqty => undef,
1261 =head2 GetBranchItemRule
1265 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1269 Retrieves circulation rule attributes that apply to the given
1270 branch and item type, regardless of patron category.
1272 The return value is a hashref containing the following key:
1274 holdallowed => Hold policy for this branch and itemtype. Possible values:
1275 0: No holds allowed.
1276 1: Holds allowed only by patrons that have the same homebranch as the item.
1277 2: Holds allowed from any patron.
1279 This searches branchitemrules in the following order:
1281 * Same branchcode and itemtype
1282 * Same branchcode, itemtype '*'
1283 * branchcode '*', same itemtype
1284 * branchcode and itemtype '*'
1286 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1290 sub GetBranchItemRule {
1291 my ( $branchcode, $itemtype ) = @_;
1292 my $dbh = C4::Context->dbh();
1296 ['SELECT holdallowed
1297 FROM branch_item_rules
1298 WHERE branchcode = ?
1299 AND itemtype = ?', $branchcode, $itemtype],
1300 ['SELECT holdallowed
1301 FROM default_branch_circ_rules
1302 WHERE branchcode = ?', $branchcode],
1303 ['SELECT holdallowed
1304 FROM default_branch_item_rules
1305 WHERE itemtype = ?', $itemtype],
1306 ['SELECT holdallowed
1307 FROM default_circ_rules'],
1310 foreach my $attempt (@attempts) {
1311 my ($query, @bind_params) = @{$attempt};
1313 # Since branch/category and branch/itemtype use the same per-branch
1314 # defaults tables, we have to check that the key we want is set, not
1315 # just that a row was returned
1316 return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1319 # built-in default circulation rule
1327 ($doreturn, $messages, $iteminformation, $borrower) =
1328 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1334 =item C<$barcode> is the bar code of the book being returned.
1336 =item C<$branch> is the code of the branch where the book is being returned.
1338 =item C<$exemptfine> indicates that overdue charges for the item will be
1341 =item C<$dropbox> indicates that the check-in date is assumed to be
1342 yesterday, or the last non-holiday as defined in C4::Calendar . If
1343 overdue charges are applied and C<$dropbox> is true, the last charge
1344 will be removed. This assumes that the fines accrual script has run
1349 C<&AddReturn> returns a list of four items:
1351 C<$doreturn> is true iff the return succeeded.
1353 C<$messages> is a reference-to-hash giving feedback on the operation.
1354 The keys of the hash are:
1360 No item with this barcode exists. The value is C<$barcode>.
1364 The book is not currently on loan. The value is C<$barcode>.
1366 =item C<IsPermanent>
1368 The book's home branch is a permanent collection. If you have borrowed
1369 this book, you are not allowed to return it. The value is the code for
1370 the book's home branch.
1374 This book has been withdrawn/cancelled. The value should be ignored.
1376 =item C<Wrongbranch>
1378 This book has was returned to the wrong branch. The value is a hashref
1379 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1380 contain the branchcode of the incorrect and correct return library, respectively.
1384 The item was reserved. The value is a reference-to-hash whose keys are
1385 fields from the reserves table of the Koha database, and
1386 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1387 either C<Waiting>, C<Reserved>, or 0.
1391 C<$iteminformation> is a reference-to-hash, giving information about the
1392 returned item from the issues table.
1394 C<$borrower> is a reference-to-hash, giving information about the
1395 patron who last borrowed the book.
1400 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1401 if ($branch and not GetBranchDetail($branch)) {
1402 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1405 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1410 my $validTransfert = 0;
1412 # get information on item
1413 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1414 unless ($itemnumber) {
1415 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1417 my $issue = GetItemIssue($itemnumber);
1418 # warn Dumper($iteminformation);
1419 if ($issue and $issue->{borrowernumber}) {
1420 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1421 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1422 . Dumper($issue) . "\n";
1424 $messages->{'NotIssued'} = $barcode;
1425 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1427 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1430 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1431 # full item data, but no borrowernumber or checkout info (no issue)
1432 # we know GetItem should work because GetItemnumberFromBarcode worked
1433 my $hbr = $item->{C4::Context->preference("HomeOrHoldingBranch")} || '';
1434 # item must be from items table -- issues table has branchcode and issuingbranch, not homebranch nor holdingbranch
1436 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1438 # check if the book is in a permanent collection....
1439 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1441 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1442 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1445 # if indy branches and returning to different branch, refuse the return
1446 if ($hbr ne $branch && C4::Context->preference("IndependantBranches")){
1447 $messages->{'Wrongbranch'} = {
1448 Wrongbranch => $branch,
1449 Rightbranch => $hbr,
1451 $doreturn = 0; # Could we bail here?
1454 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1455 $messages->{'wthdrawn'} = 1;
1459 # case of a return of document (deal with issues and holdingbranch)
1461 $borrower or warn "AddReturn without current borrower";
1462 my $circControlBranch = _GetCircControlBranch($item,$borrower);
1464 # don't allow dropbox mode to create an invalid entry in issues (issuedate > returndate) FIXME: actually checks eq, not gt
1465 undef($dropbox) if ( $item->{'issuedate'} eq C4::Dates->today('iso') );
1468 if ($borrowernumber) {
1469 MarkIssueReturned($borrowernumber, $item->{'itemnumber'}, $circControlBranch);
1470 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right? This could be the borrower hash.
1473 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1476 # the holdingbranch is updated if the document is returned to another location.
1477 # this is always done regardless of whether the item was on loan or not
1478 if ($item->{'holdingbranch'} ne $branch) {
1479 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1480 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1482 ModDateLastSeen( $item->{'itemnumber'} );
1484 # check if we have a transfer for this document
1485 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1487 # if we have a transfer to do, we update the line of transfers with the datearrived
1489 if ( $tobranch eq $branch ) {
1490 my $sth = C4::Context->dbh->prepare(
1491 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1493 $sth->execute( $item->{'itemnumber'} );
1494 # if we have a reservation with valid transfer, we can set it's status to 'W'
1495 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1497 $messages->{'WrongTransfer'} = $tobranch;
1498 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1500 $validTransfert = 1;
1503 # fix up the accounts.....
1504 if ($item->{'itemlost'}) {
1505 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1506 $messages->{'WasLost'} = 1;
1509 # fix up the overdues in accounts...
1510 if ($borrowernumber) {
1511 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1512 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1515 # find reserves.....
1516 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1517 my ($resfound, $resrec) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1519 $resrec->{'ResFound'} = $resfound;
1520 $messages->{'ResFound'} = $resrec;
1524 # Record the fact that this book was returned.
1526 $branch, 'return', '0', '',
1527 $item->{'itemnumber'},
1528 $biblio->{'itemtype'},
1532 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1533 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1535 branchcode => $branch,
1536 categorycode => $borrower->{categorycode},
1537 item_type => $item->{itype},
1538 notification => 'CHECKIN',
1540 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1541 SendCirculationAlert({
1544 borrower => $borrower,
1549 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1550 if C4::Context->preference("ReturnLog");
1552 # FIXME: make this comment intelligible.
1553 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1554 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1556 if ($doreturn and ($branch ne $hbr) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) ){
1557 if ( C4::Context->preference("AutomaticItemReturn" ) or
1558 (C4::Context->preference("UseBranchTransferLimits") and
1559 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1561 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1562 $debug and warn "item: " . Dumper($item);
1563 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1564 $messages->{'WasTransfered'} = 1;
1566 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1569 return ( $doreturn, $messages, $issue, $borrower );
1572 =head2 MarkIssueReturned
1576 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate);
1580 Unconditionally marks an issue as being returned by
1581 moving the C<issues> row to C<old_issues> and
1582 setting C<returndate> to the current date, or
1583 the last non-holiday date of the branccode specified in
1584 C<dropbox_branch> . Assumes you've already checked that
1585 it's safe to do this, i.e. last non-holiday > issuedate.
1587 if C<$returndate> is specified (in iso format), it is used as the date
1588 of the return. It is ignored when a dropbox_branch is passed in.
1590 Ideally, this function would be internal to C<C4::Circulation>,
1591 not exported, but it is currently needed by one
1592 routine in C<C4::Accounts>.
1596 sub MarkIssueReturned {
1597 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate ) = @_;
1598 my $dbh = C4::Context->dbh;
1599 my $query = "UPDATE issues SET returndate=";
1601 if ($dropbox_branch) {
1602 my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1603 my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1605 push @bind, $dropboxdate->output('iso');
1606 } elsif ($returndate) {
1608 push @bind, $returndate;
1610 $query .= " now() ";
1612 $query .= " WHERE borrowernumber = ? AND itemnumber = ?";
1613 push @bind, $borrowernumber, $itemnumber;
1615 my $sth_upd = $dbh->prepare($query);
1616 $sth_upd->execute(@bind);
1617 my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1618 WHERE borrowernumber = ?
1619 AND itemnumber = ?");
1620 $sth_copy->execute($borrowernumber, $itemnumber);
1621 my $sth_del = $dbh->prepare("DELETE FROM issues
1622 WHERE borrowernumber = ?
1623 AND itemnumber = ?");
1624 $sth_del->execute($borrowernumber, $itemnumber);
1627 =head2 _FixOverduesOnReturn
1629 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1631 C<$brn> borrowernumber
1635 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1636 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1638 Internal function, called only by AddReturn
1642 sub _FixOverduesOnReturn {
1643 my ($borrowernumber, $item);
1644 unless ($borrowernumber = shift) {
1645 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1648 unless ($item = shift) {
1649 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1652 my ($exemptfine, $dropbox) = @_;
1653 my $dbh = C4::Context->dbh;
1655 # check for overdue fine
1656 my $sth = $dbh->prepare(
1657 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1659 $sth->execute( $borrowernumber, $item );
1661 # alter fine to show that the book has been returned
1662 my $data = $sth->fetchrow_hashref;
1663 return 0 unless $data; # no warning, there's just nothing to fix
1666 my @bind = ($borrowernumber, $item, $data->{'accountno'});
1668 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1669 if (C4::Context->preference("FinesLog")) {
1670 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1672 } elsif ($dropbox && $data->{lastincrement}) {
1673 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1674 my $amt = $data->{amount} - $data->{lastincrement} ;
1675 if (C4::Context->preference("FinesLog")) {
1676 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1678 $uquery = "update accountlines set accounttype='F' ";
1679 if($outstanding >= 0 && $amt >=0) {
1680 $uquery .= ", amount = ? , amountoutstanding=? ";
1681 unshift @bind, ($amt, $outstanding) ;
1684 $uquery = "update accountlines set accounttype='F' ";
1686 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1687 my $usth = $dbh->prepare($uquery);
1688 return $usth->execute(@bind);
1691 =head2 _FixAccountForLostAndReturned
1693 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1695 Calculates the charge for a book lost and returned.
1697 Internal function, not exported, called only by AddReturn.
1699 FIXME: This function reflects how inscrutable fines logic is. Fix both.
1700 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
1704 sub _FixAccountForLostAndReturned {
1705 my $itemnumber = shift or return;
1706 my $borrowernumber = @_ ? shift : undef;
1707 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
1708 my $dbh = C4::Context->dbh;
1709 # check for charge made for lost book
1710 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1711 $sth->execute($itemnumber);
1712 my $data = $sth->fetchrow_hashref;
1713 $data or return; # bail if there is nothing to do
1715 # writeoff this amount
1717 my $amount = $data->{'amount'};
1718 my $acctno = $data->{'accountno'};
1719 my $amountleft; # Starts off undef/zero.
1720 if ($data->{'amountoutstanding'} == $amount) {
1721 $offset = $data->{'amount'};
1722 $amountleft = 0; # Hey, it's zero here, too.
1724 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
1725 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
1727 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1728 WHERE (borrowernumber = ?)
1729 AND (itemnumber = ?) AND (accountno = ?) ");
1730 $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
1731 #check if any credit is left if so writeoff other accounts
1732 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1733 $amountleft *= -1 if ($amountleft < 0);
1734 if ($amountleft > 0) {
1735 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1736 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
1737 $msth->execute($data->{'borrowernumber'});
1738 # offset transactions
1741 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1742 if ($accdata->{'amountoutstanding'} < $amountleft) {
1744 $amountleft -= $accdata->{'amountoutstanding'};
1746 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1749 my $thisacct = $accdata->{'accountno'};
1750 # FIXME: move prepares outside while loop!
1751 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1752 WHERE (borrowernumber = ?)
1753 AND (accountno=?)");
1754 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct'); # FIXME: '$thisacct' is a string literal!
1755 $usth = $dbh->prepare("INSERT INTO accountoffsets
1756 (borrowernumber, accountno, offsetaccount, offsetamount)
1759 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1761 $msth->finish; # $msth might actually have data left
1763 $amountleft *= -1 if ($amountleft > 0);
1764 my $desc = "Item Returned " . $item_id;
1765 $usth = $dbh->prepare("INSERT INTO accountlines
1766 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1767 VALUES (?,?,now(),?,?,'CR',?)");
1768 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1769 if ($borrowernumber) {
1770 # FIXME: same as query above. use 1 sth for both
1771 $usth = $dbh->prepare("INSERT INTO accountoffsets
1772 (borrowernumber, accountno, offsetaccount, offsetamount)
1774 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
1776 ModItem({ paidfor => '' }, undef, $itemnumber);
1780 =head2 _GetCircControlBranch
1782 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
1786 Return the library code to be used to determine which circulation
1787 policy applies to a transaction. Looks up the CircControl and
1788 HomeOrHoldingBranch system preferences.
1790 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
1792 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
1796 sub _GetCircControlBranch {
1797 my ($item, $borrower) = @_;
1798 my $circcontrol = C4::Context->preference('CircControl');
1801 if ($circcontrol eq 'PickupLibrary') {
1802 $branch= C4::Context->userenv->{'branch'};
1803 } elsif ($circcontrol eq 'PatronLibrary') {
1804 $branch=$borrower->{branchcode};
1806 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
1807 $branch = $item->{$branchfield};
1808 # default to item home branch if holdingbranch is used
1809 # and is not defined
1810 if (!defined($branch) && $branchfield eq 'holdingbranch') {
1811 $branch = $item->{homebranch};
1824 $issue = &GetItemIssue($itemnumber);
1826 Returns patron currently having a book, or undef if not checked out.
1828 C<$itemnumber> is the itemnumber.
1830 C<$issue> is a hashref of the row from the issues table.
1835 my ($itemnumber) = @_;
1836 return unless $itemnumber;
1837 my $sth = C4::Context->dbh->prepare(
1840 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1841 WHERE issues.itemnumber=?");
1842 $sth->execute($itemnumber);
1843 my $data = $sth->fetchrow_hashref;
1844 return unless $data;
1845 $data->{'overdue'} = ($data->{'date_due'} lt C4::Dates->today('iso')) ? 1 : 0;
1851 $issue = GetOpenIssue( $itemnumber );
1853 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1855 C<$itemnumber> is the item's itemnumber
1862 my ( $itemnumber ) = @_;
1864 my $dbh = C4::Context->dbh;
1865 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1866 $sth->execute( $itemnumber );
1867 my $issue = $sth->fetchrow_hashref();
1871 =head2 GetItemIssues
1873 $issues = &GetItemIssues($itemnumber, $history);
1875 Returns patrons that have issued a book
1877 C<$itemnumber> is the itemnumber
1878 C<$history> is false if you just want the current "issuer" (if any)
1879 and true if you want issues history from old_issues also.
1881 Returns reference to an array of hashes
1886 my ( $itemnumber, $history ) = @_;
1888 my $today = C4::Dates->today('iso'); # get today date
1889 my $sql = "SELECT * FROM issues
1890 JOIN borrowers USING (borrowernumber)
1891 JOIN items USING (itemnumber)
1892 WHERE issues.itemnumber = ? ";
1895 SELECT * FROM old_issues
1896 LEFT JOIN borrowers USING (borrowernumber)
1897 JOIN items USING (itemnumber)
1898 WHERE old_issues.itemnumber = ? ";
1900 $sql .= "ORDER BY date_due DESC";
1901 my $sth = C4::Context->dbh->prepare($sql);
1903 $sth->execute($itemnumber, $itemnumber);
1905 $sth->execute($itemnumber);
1907 my $results = $sth->fetchall_arrayref({});
1908 foreach (@$results) {
1909 $_->{'overdue'} = ($_->{'date_due'} lt $today) ? 1 : 0;
1914 =head2 GetBiblioIssues
1916 $issues = GetBiblioIssues($biblionumber);
1918 this function get all issues from a biblionumber.
1921 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1922 tables issues and the firstname,surname & cardnumber from borrowers.
1926 sub GetBiblioIssues {
1927 my $biblionumber = shift;
1928 return undef unless $biblionumber;
1929 my $dbh = C4::Context->dbh;
1931 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1933 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1934 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1935 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1936 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1937 WHERE biblio.biblionumber = ?
1939 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1941 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1942 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1943 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1944 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1945 WHERE biblio.biblionumber = ?
1948 my $sth = $dbh->prepare($query);
1949 $sth->execute($biblionumber, $biblionumber);
1952 while ( my $data = $sth->fetchrow_hashref ) {
1953 push @issues, $data;
1958 =head2 GetUpcomingDueIssues
1962 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
1968 sub GetUpcomingDueIssues {
1971 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
1972 my $dbh = C4::Context->dbh;
1974 my $statement = <<END_SQL;
1975 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
1977 LEFT JOIN items USING (itemnumber)
1978 WhERE returndate is NULL
1979 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
1982 my @bind_parameters = ( $params->{'days_in_advance'} );
1984 my $sth = $dbh->prepare( $statement );
1985 $sth->execute( @bind_parameters );
1986 my $upcoming_dues = $sth->fetchall_arrayref({});
1989 return $upcoming_dues;
1992 =head2 CanBookBeRenewed
1994 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
1996 Find out whether a borrowed item may be renewed.
1998 C<$dbh> is a DBI handle to the Koha database.
2000 C<$borrowernumber> is the borrower number of the patron who currently
2001 has the item on loan.
2003 C<$itemnumber> is the number of the item to renew.
2005 C<$override_limit>, if supplied with a true value, causes
2006 the limit on the number of times that the loan can be renewed
2007 (as controlled by the item type) to be ignored.
2009 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2010 item must currently be on loan to the specified borrower; renewals
2011 must be allowed for the item's type; and the borrower must not have
2012 already renewed the loan. $error will contain the reason the renewal can not proceed
2016 sub CanBookBeRenewed {
2018 # check renewal status
2019 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2020 my $dbh = C4::Context->dbh;
2025 # Look in the issues table for this item, lent to this borrower,
2026 # and not yet returned.
2028 # FIXME - I think this function could be redone to use only one SQL call.
2029 my $sth1 = $dbh->prepare(
2030 "SELECT * FROM issues
2031 WHERE borrowernumber = ?
2034 $sth1->execute( $borrowernumber, $itemnumber );
2035 if ( my $data1 = $sth1->fetchrow_hashref ) {
2037 # Found a matching item
2039 # See if this item may be renewed. This query is convoluted
2040 # because it's a bit messy: given the item number, we need to find
2041 # the biblioitem, which gives us the itemtype, which tells us
2042 # whether it may be renewed.
2043 my $query = "SELECT renewalsallowed FROM items ";
2044 $query .= (C4::Context->preference('item-level_itypes'))
2045 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2046 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2047 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2048 $query .= "WHERE items.itemnumber = ?";
2049 my $sth2 = $dbh->prepare($query);
2050 $sth2->execute($itemnumber);
2051 if ( my $data2 = $sth2->fetchrow_hashref ) {
2052 $renews = $data2->{'renewalsallowed'};
2054 if ( ( $renews && $renews > $data1->{'renewals'} ) || $override_limit ) {
2061 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2069 return ($renewokay,$error);
2074 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2078 C<$borrowernumber> is the borrower number of the patron who currently
2081 C<$itemnumber> is the number of the item to renew.
2083 C<$branch> is the library where the renewal took place (if any).
2084 The library that controls the circ policies for the renewal is retrieved from the issues record.
2086 C<$datedue> can be a C4::Dates object used to set the due date.
2088 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2089 this parameter is not supplied, lastreneweddate is set to the current date.
2091 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2092 from the book's item type.
2097 my $borrowernumber = shift or return undef;
2098 my $itemnumber = shift or return undef;
2100 my $datedue = shift;
2101 my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2102 my $item = GetItem($itemnumber) or return undef;
2103 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2105 my $dbh = C4::Context->dbh;
2106 # Find the issues record for this book
2108 $dbh->prepare("SELECT * FROM issues
2109 WHERE borrowernumber=?
2112 $sth->execute( $borrowernumber, $itemnumber );
2113 my $issuedata = $sth->fetchrow_hashref;
2115 if($datedue && ! $datedue->output('iso')){
2116 warn "Invalid date passed to AddRenewal.";
2119 # If the due date wasn't specified, calculate it by adding the
2120 # book's loan length to today's date or the current due date
2121 # based on the value of the RenewalPeriodBase syspref.
2124 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2125 my $loanlength = GetLoanLength(
2126 $borrower->{'categorycode'},
2127 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2128 $issuedata->{'branchcode'} ); # that's the circ control branch.
2130 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2131 C4::Dates->new($issuedata->{date_due}, 'iso') :
2133 $datedue = CalcDateDue($datedue,$loanlength,$issuedata->{'branchcode'},$borrower);
2136 # Update the issues record to have the new due date, and a new count
2137 # of how many times it has been renewed.
2138 my $renews = $issuedata->{'renewals'} + 1;
2139 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2140 WHERE borrowernumber=?
2143 $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2146 # Update the renewal count on the item, and tell zebra to reindex
2147 $renews = $biblio->{'renewals'} + 1;
2148 ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2150 # Charge a new rental fee, if applicable?
2151 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2152 if ( $charge > 0 ) {
2153 my $accountno = getnextacctno( $borrowernumber );
2154 my $item = GetBiblioFromItemNumber($itemnumber);
2155 $sth = $dbh->prepare(
2156 "INSERT INTO accountlines
2158 borrowernumber, accountno, amount,
2160 accounttype, amountoutstanding, itemnumber
2162 VALUES (now(),?,?,?,?,?,?,?)"
2164 $sth->execute( $borrowernumber, $accountno, $charge,
2165 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2166 'Rent', $charge, $itemnumber );
2170 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2175 # check renewal status
2176 my ($bornum,$itemno)=@_;
2177 my $dbh = C4::Context->dbh;
2179 my $renewsallowed = 0;
2181 # Look in the issues table for this item, lent to this borrower,
2182 # and not yet returned.
2184 # FIXME - I think this function could be redone to use only one SQL call.
2185 my $sth = $dbh->prepare("select * from issues
2186 where (borrowernumber = ?)
2187 and (itemnumber = ?)");
2188 $sth->execute($bornum,$itemno);
2189 my $data = $sth->fetchrow_hashref;
2190 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2192 my $query = "SELECT renewalsallowed FROM items ";
2193 $query .= (C4::Context->preference('item-level_itypes'))
2194 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2195 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2196 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2197 $query .= "WHERE items.itemnumber = ?";
2198 my $sth2 = $dbh->prepare($query);
2199 $sth2->execute($itemno);
2200 my $data2 = $sth2->fetchrow_hashref();
2201 $renewsallowed = $data2->{'renewalsallowed'};
2202 $renewsleft = $renewsallowed - $renewcount;
2203 return ($renewcount,$renewsallowed,$renewsleft);
2206 =head2 GetIssuingCharges
2208 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2210 Calculate how much it would cost for a given patron to borrow a given
2211 item, including any applicable discounts.
2213 C<$itemnumber> is the item number of item the patron wishes to borrow.
2215 C<$borrowernumber> is the patron's borrower number.
2217 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2218 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2223 sub GetIssuingCharges {
2225 # calculate charges due
2226 my ( $itemnumber, $borrowernumber ) = @_;
2228 my $dbh = C4::Context->dbh;
2231 # Get the book's item type and rental charge (via its biblioitem).
2232 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
2233 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2234 $qcharge .= (C4::Context->preference('item-level_itypes'))
2235 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2236 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2238 $qcharge .= "WHERE items.itemnumber =?";
2240 my $sth1 = $dbh->prepare($qcharge);
2241 $sth1->execute($itemnumber);
2242 if ( my $data1 = $sth1->fetchrow_hashref ) {
2243 $item_type = $data1->{'itemtype'};
2244 $charge = $data1->{'rentalcharge'};
2245 my $q2 = "SELECT rentaldiscount FROM borrowers
2246 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2247 WHERE borrowers.borrowernumber = ?
2248 AND issuingrules.itemtype = ?";
2249 my $sth2 = $dbh->prepare($q2);
2250 $sth2->execute( $borrowernumber, $item_type );
2251 if ( my $data2 = $sth2->fetchrow_hashref ) {
2252 my $discount = $data2->{'rentaldiscount'};
2253 if ( $discount eq 'NULL' ) {
2256 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2262 return ( $charge, $item_type );
2265 =head2 AddIssuingCharge
2267 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2271 sub AddIssuingCharge {
2272 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2273 my $dbh = C4::Context->dbh;
2274 my $nextaccntno = getnextacctno( $borrowernumber );
2276 INSERT INTO accountlines
2277 (borrowernumber, itemnumber, accountno,
2278 date, amount, description, accounttype,
2280 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2282 my $sth = $dbh->prepare($query);
2283 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2289 GetTransfers($itemnumber);
2294 my ($itemnumber) = @_;
2296 my $dbh = C4::Context->dbh;
2302 FROM branchtransfers
2303 WHERE itemnumber = ?
2304 AND datearrived IS NULL
2306 my $sth = $dbh->prepare($query);
2307 $sth->execute($itemnumber);
2308 my @row = $sth->fetchrow_array();
2313 =head2 GetTransfersFromTo
2315 @results = GetTransfersFromTo($frombranch,$tobranch);
2317 Returns the list of pending transfers between $from and $to branch
2321 sub GetTransfersFromTo {
2322 my ( $frombranch, $tobranch ) = @_;
2323 return unless ( $frombranch && $tobranch );
2324 my $dbh = C4::Context->dbh;
2326 SELECT itemnumber,datesent,frombranch
2327 FROM branchtransfers
2330 AND datearrived IS NULL
2332 my $sth = $dbh->prepare($query);
2333 $sth->execute( $frombranch, $tobranch );
2336 while ( my $data = $sth->fetchrow_hashref ) {
2337 push @gettransfers, $data;
2340 return (@gettransfers);
2343 =head2 DeleteTransfer
2345 &DeleteTransfer($itemnumber);
2349 sub DeleteTransfer {
2350 my ($itemnumber) = @_;
2351 my $dbh = C4::Context->dbh;
2352 my $sth = $dbh->prepare(
2353 "DELETE FROM branchtransfers
2355 AND datearrived IS NULL "
2357 $sth->execute($itemnumber);
2361 =head2 AnonymiseIssueHistory
2363 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2365 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2366 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2368 return the number of affected rows.
2372 sub AnonymiseIssueHistory {
2374 my $borrowernumber = shift;
2375 my $dbh = C4::Context->dbh;
2378 SET borrowernumber = NULL
2379 WHERE returndate < '".$date."'
2380 AND borrowernumber IS NOT NULL
2382 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2383 my $rows_affected = $dbh->do($query);
2384 return $rows_affected;
2387 =head2 SendCirculationAlert
2389 Send out a C<check-in> or C<checkout> alert using the messaging system.
2397 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2401 Hashref of information about the item being checked in or out.
2405 Hashref of information about the borrower of the item.
2409 The branchcode from where the checkout or check-in took place.
2415 SendCirculationAlert({
2418 borrower => $borrower,
2424 sub SendCirculationAlert {
2426 my ($type, $item, $borrower, $branch) =
2427 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2428 my %message_name = (
2429 CHECKIN => 'Item Check-in',
2430 CHECKOUT => 'Item Checkout',
2432 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2433 borrowernumber => $borrower->{borrowernumber},
2434 message_name => $message_name{$type},
2436 my $letter = C4::Letters::getletter('circulation', $type);
2437 C4::Letters::parseletter($letter, 'biblio', $item->{biblionumber});
2438 C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2439 C4::Letters::parseletter($letter, 'borrowers', $borrower->{borrowernumber});
2440 C4::Letters::parseletter($letter, 'branches', $branch);
2441 my @transports = @{ $borrower_preferences->{transports} };
2442 # warn "no transports" unless @transports;
2444 # warn "transport: $_";
2445 my $message = C4::Message->find_last_message($borrower, $type, $_);
2447 #warn "create new message";
2448 C4::Message->enqueue($letter, $borrower, $_);
2450 #warn "append to old message";
2451 $message->append($letter);
2458 =head2 updateWrongTransfer
2460 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2462 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
2466 sub updateWrongTransfer {
2467 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2468 my $dbh = C4::Context->dbh;
2469 # first step validate the actual line of transfert .
2472 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2474 $sth->execute($FromLibrary,$itemNumber);
2477 # second step create a new line of branchtransfer to the right location .
2478 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2480 #third step changing holdingbranch of item
2481 UpdateHoldingbranch($FromLibrary,$itemNumber);
2484 =head2 UpdateHoldingbranch
2486 $items = UpdateHoldingbranch($branch,$itmenumber);
2487 Simple methode for updating hodlingbranch in items BDD line
2491 sub UpdateHoldingbranch {
2492 my ( $branch,$itemnumber ) = @_;
2493 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2498 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2499 this function calculates the due date given the loan length ,
2500 checking against the holidays calendar as per the 'useDaysMode' syspref.
2501 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2502 C<$branch> = location whose calendar to use
2503 C<$loanlength> = loan length prior to adjustment
2507 my ($startdate,$loanlength,$branch,$borrower) = @_;
2510 if(C4::Context->preference('useDaysMode') eq 'Days') { # ignoring calendar
2511 my $timedue = time + ($loanlength) * 86400;
2512 #FIXME - assumes now even though we take a startdate
2513 my @datearr = localtime($timedue);
2514 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2516 my $calendar = C4::Calendar->new( branchcode => $branch );
2517 $datedue = $calendar->addDate($startdate, $loanlength);
2520 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2521 if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2522 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2525 # if ceilingDueDate ON the datedue can't be after the ceiling date
2526 if ( C4::Context->preference('ceilingDueDate')
2527 && ( C4::Context->preference('ceilingDueDate') =~ C4::Dates->regexp('syspref') ) ) {
2528 my $ceilingDate = C4::Dates->new( C4::Context->preference('ceilingDueDate') );
2529 if ( $datedue->output( 'iso' ) gt $ceilingDate->output( 'iso' ) ) {
2530 $datedue = $ceilingDate;
2537 =head2 CheckValidDatedue
2538 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2539 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2541 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2542 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2543 C<$date_due> = returndate calculate with no day check
2544 C<$itemnumber> = itemnumber
2545 C<$branchcode> = location of issue (affected by 'CircControl' syspref)
2546 C<$loanlength> = loan length prior to adjustment
2549 sub CheckValidDatedue {
2550 my ($date_due,$itemnumber,$branchcode)=@_;
2551 my @datedue=split('-',$date_due->output('iso'));
2552 my $years=$datedue[0];
2553 my $month=$datedue[1];
2554 my $day=$datedue[2];
2555 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2557 for (my $i=0;$i<2;$i++){
2558 $dow=Day_of_Week($years,$month,$day);
2559 ($dow=0) if ($dow>6);
2560 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2561 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2562 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2563 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2565 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2568 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2573 =head2 CheckRepeatableHolidays
2575 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2576 this function checks if the date due is a repeatable holiday
2577 C<$date_due> = returndate calculate with no day check
2578 C<$itemnumber> = itemnumber
2579 C<$branchcode> = localisation of issue
2583 sub CheckRepeatableHolidays{
2584 my($itemnumber,$week_day,$branchcode)=@_;
2585 my $dbh = C4::Context->dbh;
2586 my $query = qq|SELECT count(*)
2587 FROM repeatable_holidays
2590 my $sth = $dbh->prepare($query);
2591 $sth->execute($branchcode,$week_day);
2592 my $result=$sth->fetchrow;
2598 =head2 CheckSpecialHolidays
2600 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2601 this function check if the date is a special holiday
2602 C<$years> = the years of datedue
2603 C<$month> = the month of datedue
2604 C<$day> = the day of datedue
2605 C<$itemnumber> = itemnumber
2606 C<$branchcode> = localisation of issue
2610 sub CheckSpecialHolidays{
2611 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2612 my $dbh = C4::Context->dbh;
2613 my $query=qq|SELECT count(*)
2614 FROM `special_holidays`
2620 my $sth = $dbh->prepare($query);
2621 $sth->execute($years,$month,$day,$branchcode);
2622 my $countspecial=$sth->fetchrow ;
2624 return $countspecial;
2627 =head2 CheckRepeatableSpecialHolidays
2629 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2630 this function check if the date is a repeatble special holidays
2631 C<$month> = the month of datedue
2632 C<$day> = the day of datedue
2633 C<$itemnumber> = itemnumber
2634 C<$branchcode> = localisation of issue
2638 sub CheckRepeatableSpecialHolidays{
2639 my ($month,$day,$itemnumber,$branchcode) = @_;
2640 my $dbh = C4::Context->dbh;
2641 my $query=qq|SELECT count(*)
2642 FROM `repeatable_holidays`
2647 my $sth = $dbh->prepare($query);
2648 $sth->execute($month,$day,$branchcode);
2649 my $countspecial=$sth->fetchrow ;
2651 return $countspecial;
2656 sub CheckValidBarcode{
2658 my $dbh = C4::Context->dbh;
2659 my $query=qq|SELECT count(*)
2663 my $sth = $dbh->prepare($query);
2664 $sth->execute($barcode);
2665 my $exist=$sth->fetchrow ;
2670 =head2 IsBranchTransferAllowed
2672 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2674 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2678 sub IsBranchTransferAllowed {
2679 my ( $toBranch, $fromBranch, $code ) = @_;
2681 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2683 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2684 my $dbh = C4::Context->dbh;
2686 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2687 $sth->execute( $toBranch, $fromBranch, $code );
2688 my $limit = $sth->fetchrow_hashref();
2690 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2691 if ( $limit->{'limitId'} ) {
2698 =head2 CreateBranchTransferLimit
2700 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2702 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2706 sub CreateBranchTransferLimit {
2707 my ( $toBranch, $fromBranch, $code ) = @_;
2709 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2711 my $dbh = C4::Context->dbh;
2713 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2714 $sth->execute( $code, $toBranch, $fromBranch );
2717 =head2 DeleteBranchTransferLimits
2719 DeleteBranchTransferLimits();
2723 sub DeleteBranchTransferLimits {
2724 my $dbh = C4::Context->dbh;
2725 my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2736 Koha Developement team <info@koha.org>