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
39 use POSIX qw(strftime);
40 use C4::Branch; # GetBranches
41 use C4::Log; # logaction
43 our ($VERSION,@ISA,@EXPORT,@EXPORT_OK,%EXPORT_TAGS);
45 # set the version for version checking
50 C4::Circulation - Koha circulation module
58 The functions in this module deal with circulation, issues, and
59 returns, as well as general information about the library.
60 Also deals with stocktaking.
68 # FIXME subs that should probably be elsewhere
74 # subs to deal with issuing a book
86 &AnonymiseIssueHistory
88 # subs to deal with returns
93 # subs to deal with transfers
102 # FIXME - At least, I'm pretty sure this is for decoding CueCat stuff.
103 # FIXME From Paul : i don't understand what this sub does & why it has to be called on every circ. Speak of this with chris maybe ?
107 =head3 $str = &decode($chunk);
111 =item Decodes a segment of a string emitted by a CueCat barcode scanner and
118 sub cuecatbarcodedecode {
121 my @fields = split( /\./, $barcode );
122 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
123 if ( $#results == 2 ) {
133 =head3 $str = &decode($chunk);
137 =item Decodes a segment of a string emitted by a CueCat barcode scanner and
147 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
148 my @s = map { index( $seq, $_ ); } split( //, $encoded );
149 my $l = ( $#s + 1 ) % 4;
160 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
162 chr( ( $n >> 16 ) ^ 67 )
163 .chr( ( $n >> 8 & 255 ) ^ 67 )
164 .chr( ( $n & 255 ) ^ 67 );
167 $r = substr( $r, 0, length($r) - $l );
173 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch, $barcode, $ignore_reserves);
175 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
177 C<$newbranch> is the code for the branch to which the item should be transferred.
179 C<$barcode> is the barcode of the item to be transferred.
181 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
182 Otherwise, if an item is reserved, the transfer fails.
184 Returns three values:
188 is true if the transfer was successful.
192 is a reference-to-hash which may have any of the following keys:
198 There is no item in the catalog with the given barcode. The value is C<$barcode>.
202 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.
204 =item C<DestinationEqualsHolding>
206 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.
210 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.
214 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>.
216 =item C<WasTransferred>
218 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
225 my ( $tbr, $barcode, $ignoreRs ) = @_;
228 my $branches = GetBranches();
229 my $itemnumber = GetItemnumberFromBarcode( $barcode );
230 my $issue = GetItemIssue($itemnumber);
231 my $biblio = GetBiblioFromItemNumber($itemnumber);
234 if ( not $itemnumber ) {
235 $messages->{'BadBarcode'} = $barcode;
239 # get branches of book...
240 my $hbr = $biblio->{'homebranch'};
241 my $fbr = $biblio->{'holdingbranch'};
244 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
245 $messages->{'IsPermanent'} = $hbr;
248 # can't transfer book if is already there....
249 if ( $fbr eq $tbr ) {
250 $messages->{'DestinationEqualsHolding'} = 1;
254 # check if it is still issued to someone, return it...
255 if ($issue->{borrowernumber}) {
256 AddReturn( $barcode, $fbr );
257 $messages->{'WasReturned'} = $issue->{borrowernumber};
261 # That'll save a database query.
262 my ( $resfound, $resrec ) =
263 CheckReserves( $itemnumber );
264 if ( $resfound and not $ignoreRs ) {
265 $resrec->{'ResFound'} = $resfound;
267 # $messages->{'ResFound'} = $resrec;
271 #actually do the transfer....
273 ModItemTransfer( $itemnumber, $fbr, $tbr );
275 # don't need to update MARC anymore, we do it in batch now
276 $messages->{'WasTransfered'} = 1;
277 ModDateLastSeen( $itemnumber );
279 return ( $dotransfer, $messages, $biblio );
282 =head2 CanBookBeIssued
284 Check if a book can be issued.
286 my ($issuingimpossible,$needsconfirmation) = CanBookBeIssued($borrower,$barcode,$year,$month,$day);
290 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
292 =item C<$barcode> is the bar code of the book being issued.
294 =item C<$year> C<$month> C<$day> contains the date of the return (in case it's forced by "stickyduedate".
302 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
303 Possible values are :
309 sticky due date is invalid
313 borrower gone with no address
317 borrower declared it's card lost
323 =head3 UNKNOWN_BARCODE
337 item is restricted (set by ??)
339 C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
340 Possible values are :
348 renewing, not issuing
350 =head3 ISSUED_TO_ANOTHER
352 issued to someone else.
356 reserved for someone else.
360 sticky due date is invalid
364 if the borrower borrows to much things
368 # check if a book can be issued.
372 my $borrower = shift;
373 my $biblionumber = shift;
375 my $cat_borrower = $borrower->{'categorycode'};
376 my $branch_borrower = $borrower->{'branchcode'};
377 my $dbh = C4::Context->dbh;
379 my $branch_issuer = C4::Context->userenv->{'branchcode'};
380 #TODO : specify issuer or borrower for circrule.
381 my $type = (C4::Context->preference('item-level_itypes'))
382 ? $item->{'itype'} # item-level
383 : $item->{'itemtype'}; # biblio-level
387 'SELECT * FROM issuingrules
388 WHERE categorycode = ?
393 my $query2 = "SELECT COUNT(*) FROM issues i, biblioitems s1, items s2
394 WHERE i.borrowernumber = ?
395 AND i.returndate IS NULL
396 AND i.itemnumber = s2.itemnumber
397 AND s1.biblioitemnumber = s2.biblioitemnumber"
398 . (C4::Context->preference('item-level_itypes'))
400 : " AND s1.itemtype= ? ";
401 my $sth2= $dbh->prepare($query2);
404 'SELECT COUNT(*) FROM issues
405 WHERE borrowernumber = ?
406 AND returndate IS NULL'
410 # check the 3 parameters (branch / itemtype / category code
411 $sth->execute( $cat_borrower, $type, $branch_borrower );
412 my $result = $sth->fetchrow_hashref;
413 # warn "$cat_borrower, $type, $branch_borrower = ".Data::Dumper::Dumper($result);
415 if ( $result->{maxissueqty} ne '' ) {
416 # warn "checking on everything set";
417 $sth2->execute( $borrower->{'borrowernumber'}, $type );
418 my $alreadyissued = $sth2->fetchrow;
419 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
420 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on branch/category/itemtype failed)" );
422 # now checking for total
423 $sth->execute( $cat_borrower, '', $branch_borrower );
424 my $result = $sth->fetchrow_hashref;
425 if ( $result->{maxissueqty} ne '*' ) {
426 $sth2->execute( $borrower->{'borrowernumber'}, $type );
427 my $alreadyissued = $sth2->fetchrow;
428 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
429 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on branch/category/total failed)" );
434 # check the 2 parameters (branch / itemtype / default categorycode
435 $sth->execute( '*', $type, $branch_borrower );
436 my $result = $sth->fetchrow_hashref;
437 # warn "*, $type, $branch_borrower = ".Data::Dumper::Dumper($result);
439 if ( $result->{maxissueqty} ne '' ) {
440 # warn "checking on 2 parameters (default categorycode)";
441 $sth2->execute( $borrower->{'borrowernumber'}, $type );
442 my $alreadyissued = $sth2->fetchrow;
443 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
444 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on branch / default category / itemtype failed)" );
446 # now checking for total
447 $sth->execute( '*', '*', $branch_borrower );
448 my $result = $sth->fetchrow_hashref;
449 if ( $result->{maxissueqty} ne '' ) {
450 $sth2->execute( $borrower->{'borrowernumber'}, $type );
451 my $alreadyissued = $sth2->fetchrow;
452 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
453 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on branch / default category / total failed)" );
458 # check the 1 parameters (default branch / itemtype / categorycode
459 $sth->execute( $cat_borrower, $type, '*' );
460 my $result = $sth->fetchrow_hashref;
461 # warn "$cat_borrower, $type, * = ".Data::Dumper::Dumper($result);
463 if ( $result->{maxissueqty} ne '' ) {
464 # warn "checking on 1 parameter (default branch + categorycode)";
465 $sth2->execute( $borrower->{'borrowernumber'}, $type );
466 my $alreadyissued = $sth2->fetchrow;
467 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
468 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on default branch/category/itemtype failed)" );
470 # now checking for total
471 $sth->execute( $cat_borrower, '*', '*' );
472 my $result = $sth->fetchrow_hashref;
473 if ( $result->{maxissueqty} ne '' ) {
474 $sth2->execute( $borrower->{'borrowernumber'}, $type );
475 my $alreadyissued = $sth2->fetchrow;
476 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
477 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on default branch / category / total failed)" );
482 # check the 0 parameters (default branch / itemtype / default categorycode
483 $sth->execute( '*', $type, '*' );
484 my $result = $sth->fetchrow_hashref;
485 # warn "*, $type, * = ".Data::Dumper::Dumper($result);
487 if ( $result->{maxissueqty} ne '' ) {
488 # warn "checking on default branch and default categorycode";
489 $sth2->execute( $borrower->{'borrowernumber'}, $type );
490 my $alreadyissued = $sth2->fetchrow;
491 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
492 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on default branch / default category / itemtype failed)" );
494 # now checking for total
495 $sth->execute( '*', '*', '*' );
496 my $result = $sth->fetchrow_hashref;
497 if ( $result->{maxissueqty} ne '' ) {
498 $sth2->execute( $borrower->{'borrowernumber'}, $type );
499 my $alreadyissued = $sth2->fetchrow;
500 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
501 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on default branch / default category / total failed)" );
506 #OK, the patron can issue !!!
512 @issues = &itemissues($biblioitemnumber, $biblio);
514 Looks up information about who has borrowed the bookZ<>(s) with the
515 given biblioitemnumber.
517 C<$biblio> is ignored.
519 C<&itemissues> returns an array of references-to-hash. The keys
520 include the fields from the C<items> table in the Koha database.
521 Additional keys include:
527 If the item is currently on loan, this gives the due date.
529 If the item is not on loan, then this is either "Available" or
530 "Cancelled", if the item has been withdrawn.
534 If the item is currently on loan, this gives the card number of the
535 patron who currently has the item.
537 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
539 These give the timestamp for the last three times the item was
542 =item C<card0>, C<card1>, C<card2>
544 The card number of the last three patrons who borrowed this item.
546 =item C<borrower0>, C<borrower1>, C<borrower2>
548 The borrower number of the last three patrons who borrowed this item.
556 my ( $bibitem, $biblio ) = @_;
557 my $dbh = C4::Context->dbh;
559 # FIXME - If this function die()s, the script will abort, and the
560 # user won't get anything; depending on how far the script has
561 # gotten, the user might get a blank page. It would be much better
562 # to at least print an error message. The easiest way to do this
563 # is to set $SIG{__DIE__}.
565 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
570 $sth->execute($bibitem) || die $sth->errstr;
572 while ( my $data = $sth->fetchrow_hashref ) {
574 # Find out who currently has this item.
575 # FIXME - Wouldn't it be better to do this as a left join of
576 # some sort? Currently, this code assumes that if
577 # fetchrow_hashref() fails, then the book is on the shelf.
578 # fetchrow_hashref() can fail for any number of reasons (e.g.,
579 # database server crash), not just because no items match the
581 my $sth2 = $dbh->prepare(
582 "SELECT * FROM issues
583 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
585 AND returndate IS NULL
589 $sth2->execute( $data->{'itemnumber'} );
590 if ( my $data2 = $sth2->fetchrow_hashref ) {
591 $data->{'date_due'} = $data2->{'date_due'};
592 $data->{'card'} = $data2->{'cardnumber'};
593 $data->{'borrower'} = $data2->{'borrowernumber'};
596 if ( $data->{'wthdrawn'} eq '1' ) {
597 $data->{'date_due'} = 'Cancelled';
600 $data->{'date_due'} = 'Available';
606 # Find the last 3 people who borrowed this item.
607 $sth2 = $dbh->prepare(
608 "SELECT * FROM issues
609 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
611 AND returndate IS NOT NULL
612 ORDER BY returndate DESC,timestamp DESC"
615 $sth2->execute( $data->{'itemnumber'} );
616 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
617 { # FIXME : error if there is less than 3 pple borrowing this item
618 if ( my $data2 = $sth2->fetchrow_hashref ) {
619 $data->{"timestamp$i2"} = $data2->{'timestamp'};
620 $data->{"card$i2"} = $data2->{'cardnumber'};
621 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
626 $results[$i] = $data;
634 =head2 CanBookBeIssued
636 $issuingimpossible, $needsconfirmation =
637 CanBookBeIssued( $borrower, $barcode, $duedatespec, $inprocess );
638 C<$duedatespec> is a C4::Dates object.
639 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
643 sub CanBookBeIssued {
644 my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
645 my %needsconfirmation; # filled with problems that needs confirmations
646 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
647 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
648 my $issue = GetItemIssue($item->{itemnumber});
649 my $dbh = C4::Context->dbh;
652 # DUE DATE is OK ? -- should already have checked.
654 #$issuingimpossible{INVALID_DATE} = 1 unless ($duedate);
659 if ( $borrower->{flags}->{GNA} ) {
660 $issuingimpossible{GNA} = 1;
662 if ( $borrower->{flags}->{'LOST'} ) {
663 $issuingimpossible{CARD_LOST} = 1;
665 if ( $borrower->{flags}->{'DBARRED'} ) {
666 $issuingimpossible{DEBARRED} = 1;
668 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
669 $issuingimpossible{EXPIRED} = 1;
671 my @expirydate= split /-/,$borrower->{'dateexpiry'};
672 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
673 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
674 $issuingimpossible{EXPIRED} = 1;
683 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
684 if ( C4::Context->preference("IssuingInProcess") ) {
685 my $amountlimit = C4::Context->preference("noissuescharge");
686 if ( $amount > $amountlimit && !$inprocess ) {
687 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
689 elsif ( $amount <= $amountlimit && !$inprocess ) {
690 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
695 $needsconfirmation{DEBT} = $amount;
700 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
703 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
704 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
709 unless ( $item->{barcode} ) {
710 $issuingimpossible{UNKNOWN_BARCODE} = 1;
712 if ( $item->{'notforloan'}
713 && $item->{'notforloan'} > 0 )
715 $issuingimpossible{NOT_FOR_LOAN} = 1;
717 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
719 $issuingimpossible{WTHDRAWN} = 1;
721 if ( $item->{'restricted'}
722 && $item->{'restricted'} == 1 )
724 $issuingimpossible{RESTRICTED} = 1;
726 if ( C4::Context->preference("IndependantBranches") ) {
727 my $userenv = C4::Context->userenv;
728 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
729 $issuingimpossible{NOTSAMEBRANCH} = 1
730 if ( $item->{C4::Context->preference("HomeOrHoldingbranch")} ne $userenv->{branch} );
735 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
737 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
740 # Already issued to current borrower. Ask whether the loan should
742 my ($CanBookBeRenewed) = CanBookBeRenewed(
743 $borrower->{'borrowernumber'},
744 $item->{'itemnumber'}
746 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
747 $issuingimpossible{NO_MORE_RENEWALS} = 1;
750 $needsconfirmation{RENEW_ISSUE} = 1;
753 elsif ($issue->{borrowernumber}) {
755 # issued to someone else
756 my $currborinfo = GetMemberDetails( $issue->{borrowernumber} );
758 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
759 $needsconfirmation{ISSUED_TO_ANOTHER} =
760 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
763 # See if the item is on reserve.
764 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
766 my $resbor = $res->{'borrowernumber'};
767 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
770 # The item is on reserve and waiting, but has been
771 # reserved by some other patron.
772 my ( $resborrower, $flags ) =
773 GetMemberDetails( $resbor, 0 );
774 my $branches = GetBranches();
776 $branches->{ $res->{'branchcode'} }->{'branchname'};
777 $needsconfirmation{RESERVE_WAITING} =
778 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
780 # CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'}); Doesn't belong in a checking subroutine.
782 elsif ( $restype eq "Reserved" ) {
784 # The item is on reserve for someone else.
785 my ( $resborrower, $flags ) =
786 GetMemberDetails( $resbor, 0 );
787 my $branches = GetBranches();
789 $branches->{ $res->{'branchcode'} }->{'branchname'};
790 $needsconfirmation{RESERVED} =
791 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
794 if ( C4::Context->preference("LibraryName") eq "Horowhenua Library Trust" ) {
795 if ( $borrower->{'categorycode'} eq 'W' ) {
796 my %issuingimpossible;
797 return ( \%issuingimpossible, \%needsconfirmation );
799 return ( \%issuingimpossible, \%needsconfirmation );
802 return ( \%issuingimpossible, \%needsconfirmation );
808 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
810 &AddIssue($borrower,$barcode,$date)
814 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
816 =item C<$barcode> is the bar code of the book being issued.
818 =item C<$date> contains the max date of return. calculated if empty.
820 AddIssue does the following things :
821 - step 01: check that there is a borrowernumber & a barcode provided
822 - check for RENEWAL (book issued & being issued to the same patron)
823 - renewal YES = Calculate Charge & renew
825 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
827 - fill reserve if reserve to this patron
828 - cancel reserve or not, otherwise
829 * TRANSFERT PENDING ?
830 - complete the transfert
838 my ( $borrower, $barcode, $date, $cancelreserve ) = @_;
839 my $dbh = C4::Context->dbh;
840 my $barcodecheck=CheckValidBarcode($barcode);
841 if ($borrower and $barcode and $barcodecheck ne '0'){
842 # my ($borrower, $flags) = &GetMemberDetails($borrowernumber, 0);
843 # find which item we issue
844 my $item = GetItem('', $barcode);
847 # get actual issuing if there is one
848 my $actualissue = GetItemIssue( $item->{itemnumber});
850 # get biblioinformation for this item
851 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
854 # check if we just renew the issue.
856 if ( $actualissue->{borrowernumber} eq $borrower->{'borrowernumber'} ) {
858 $borrower->{'borrowernumber'},
859 $item->{'itemnumber'},
860 C4::Context->userenv->{'branch'},
867 if ( $actualissue->{borrowernumber}) {
868 # This book is currently on loan, but not to the person
869 # who wants to borrow it now. mark it returned before issuing to the new borrower
872 C4::Context->userenv->{'branch'}
876 # See if the item is on reserve.
877 my ( $restype, $res ) =
878 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
880 my $resbor = $res->{'borrowernumber'};
881 if ( $resbor eq $borrower->{'borrowernumber'} ) {
883 # The item is reserved by the current patron
884 ModReserveFill($res);
886 elsif ( $restype eq "Waiting" ) {
889 # The item is on reserve and waiting, but has been
890 # reserved by some other patron.
891 my ( $resborrower, $flags ) = GetMemberDetails( $resbor, 0 );
892 my $branches = GetBranches();
894 $branches->{ $res->{'branchcode'} }->{'branchname'};
896 elsif ( $restype eq "Reserved" ) {
899 # The item is reserved by someone else.
900 my ( $resborrower, $flags ) =
901 GetMemberDetails( $resbor, 0 );
902 my $branches = GetBranches();
904 $branches->{ $res->{'branchcode'} }->{'branchname'};
905 if ($cancelreserve) { # cancel reserves on this item
906 CancelReserve( 0, $res->{'itemnumber'},
907 $res->{'borrowernumber'} );
910 if ($cancelreserve) {
911 CancelReserve( $res->{'biblionumber'}, 0,
912 $res->{'borrowernumber'} );
915 # set waiting reserve to first in reserve queue as book isn't waiting now
918 $res->{'biblionumber'},
919 $res->{'borrowernumber'},
925 # Starting process for transfer job (checking transfert and validate it if we have one)
926 my ($datesent) = GetTransfers($item->{'itemnumber'});
928 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for lisibility of this case (maybe for stats ....)
931 "UPDATE branchtransfers
932 SET datearrived = now(),
934 comments = 'Forced branchtransfert'
935 WHERE itemnumber= ? AND datearrived IS NULL"
937 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
941 # Record in the database the fact that the book was issued.
945 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
952 my $itype=(C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ;
953 my $loanlength = GetLoanLength(
954 $borrower->{'categorycode'},
956 $borrower->{'branchcode'}
958 $datedue = time + ($loanlength) * 86400;
959 my @datearr = localtime($datedue);
960 $dateduef = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
961 $dateduef=CheckValidDatedue($dateduef,$item->{'itemnumber'},C4::Context->userenv->{'branch'});
963 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
964 if ( C4::Context->preference('ReturnBeforeExpiry') && $dateduef->output('iso') gt $borrower->{dateexpiry} ) {
965 $dateduef = C4::Dates->new($borrower->{dateexpiry},'iso');
969 $borrower->{'borrowernumber'},
970 $item->{'itemnumber'},
971 strftime( "%Y-%m-%d", localtime ),$dateduef->output('iso'), C4::Context->userenv->{'branch'}
977 "UPDATE items SET issues=?, holdingbranch=?, itemlost=0, datelastborrowed = now(), onloan = ? WHERE itemnumber=?");
980 C4::Context->userenv->{'branch'},
981 $dateduef->output('iso'),
982 $item->{'itemnumber'}
985 &ModDateLastSeen( $item->{'itemnumber'} );
986 my $record = GetMarcItem( $item->{'biblionumber'}, $item->{'itemnumber'} );
987 my $frameworkcode = GetFrameworkCode( $item->{'biblionumber'} );
988 ModItemInMarc( $record, $item->{'biblionumber'}, $item->{'itemnumber'}, $frameworkcode );
989 # If it costs to borrow this book, charge it to the patron's account.
990 my ( $charge, $itemtype ) = GetIssuingCharges(
991 $item->{'itemnumber'},
992 $borrower->{'borrowernumber'}
996 $item->{'itemnumber'},
997 $borrower->{'borrowernumber'}, $charge
999 $item->{'charge'} = $charge;
1002 # Record the fact that this book was issued.
1004 C4::Context->userenv->{'branch'},
1006 '', $item->{'itemnumber'},
1007 $item->{'itemtype'}, $borrower->{'borrowernumber'}
1011 &logaction(C4::Context->userenv->{'number'},"CIRCULATION","ISSUE",$borrower->{'borrowernumber'},$biblio->{'biblionumber'})
1012 if C4::Context->preference("IssueLog");
1017 =head2 GetLoanLength
1019 Get loan length for an itemtype, a borrower type and a branch
1021 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1026 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1027 my $dbh = C4::Context->dbh;
1030 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1032 warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1033 # try to find issuelength & return the 1st available.
1034 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1035 $sth->execute( $borrowertype, $itemtype, $branchcode );
1036 my $loanlength = $sth->fetchrow_hashref;
1037 return $loanlength->{issuelength}
1038 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1040 $sth->execute( $borrowertype, $itemtype, "*" );
1041 $loanlength = $sth->fetchrow_hashref;
1042 return $loanlength->{issuelength}
1043 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1045 $sth->execute( $borrowertype, "*", $branchcode );
1046 $loanlength = $sth->fetchrow_hashref;
1047 return $loanlength->{issuelength}
1048 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1050 $sth->execute( "*", $itemtype, $branchcode );
1051 $loanlength = $sth->fetchrow_hashref;
1052 return $loanlength->{issuelength}
1053 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1055 $sth->execute( $borrowertype, "*", "*" );
1056 $loanlength = $sth->fetchrow_hashref;
1057 return $loanlength->{issuelength}
1058 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1060 $sth->execute( "*", "*", $branchcode );
1061 $loanlength = $sth->fetchrow_hashref;
1062 return $loanlength->{issuelength}
1063 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1065 $sth->execute( "*", $itemtype, "*" );
1066 $loanlength = $sth->fetchrow_hashref;
1067 return $loanlength->{issuelength}
1068 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1070 $sth->execute( "*", "*", "*" );
1071 $loanlength = $sth->fetchrow_hashref;
1072 return $loanlength->{issuelength}
1073 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1075 # if no rule is set => 21 days (hardcoded)
1081 ($doreturn, $messages, $iteminformation, $borrower) =
1082 &AddReturn($barcode, $branch, $exemptfine);
1086 C<$barcode> is the bar code of the book being returned. C<$branch> is
1087 the code of the branch where the book is being returned. C<$exemptfine>
1088 indicates that overdue charges for the item will not be applied.
1090 C<&AddReturn> returns a list of four items:
1092 C<$doreturn> is true iff the return succeeded.
1094 C<$messages> is a reference-to-hash giving the reason for failure:
1100 No item with this barcode exists. The value is C<$barcode>.
1104 The book is not currently on loan. The value is C<$barcode>.
1106 =item C<IsPermanent>
1108 The book's home branch is a permanent collection. If you have borrowed
1109 this book, you are not allowed to return it. The value is the code for
1110 the book's home branch.
1114 This book has been withdrawn/cancelled. The value should be ignored.
1118 The item was reserved. The value is a reference-to-hash whose keys are
1119 fields from the reserves table of the Koha database, and
1120 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1121 either C<Waiting>, C<Reserved>, or 0.
1125 C<$borrower> is a reference-to-hash, giving information about the
1126 patron who last borrowed the book.
1131 my ( $barcode, $branch, $exemptfine ) = @_;
1132 my $dbh = C4::Context->dbh;
1136 my $validTransfert = 0;
1137 my $reserveDone = 0;
1139 # get information on item
1140 my $iteminformation = GetItemIssue( GetItemnumberFromBarcode($barcode));
1141 my $biblio = GetBiblioFromItemNumber($iteminformation->{'itemnumber'});
1142 unless ($iteminformation->{'itemnumber'} ) {
1143 $messages->{'BadBarcode'} = $barcode;
1147 if ( ( not $iteminformation->{borrowernumber} ) && $doreturn ) {
1148 $messages->{'NotIssued'} = $barcode;
1152 # check if the book is in a permanent collection....
1153 my $hbr = $iteminformation->{'homebranch'};
1154 my $branches = GetBranches();
1155 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
1156 $messages->{'IsPermanent'} = $hbr;
1159 # if independent branches are on and returning to different branch, refuse the return
1160 if ($hbr ne C4::Context->userenv->{'branch'} && C4::Context->preference("IndependantBranches")){
1161 $messages->{'Wrongbranch'} = 1;
1165 # check that the book has been cancelled
1166 if ( $iteminformation->{'wthdrawn'} ) {
1167 $messages->{'wthdrawn'} = 1;
1171 # new op dev : if the book returned in an other branch update the holding branch
1173 # update issues, thereby returning book (should push this out into another subroutine
1174 $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1176 # case of a return of document (deal with issues and holdingbranch)
1181 "UPDATE issues SET returndate = now() WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (returndate IS NULL)"
1183 $sth->execute( $borrower->{'borrowernumber'},
1184 $iteminformation->{'itemnumber'} );
1185 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right?
1188 # continue to deal with returns cases, but not only if we have an issue
1190 # the holdingbranch is updated if the document is returned in an other location .
1191 if ( $iteminformation->{'holdingbranch'} ne C4::Context->userenv->{'branch'} ) {
1192 UpdateHoldingbranch(C4::Context->userenv->{'branch'},$iteminformation->{'itemnumber'});
1193 # reload iteminformation holdingbranch with the userenv value
1194 $iteminformation->{'holdingbranch'} = C4::Context->userenv->{'branch'};
1196 ModDateLastSeen( $iteminformation->{'itemnumber'} );
1197 my $sth = $dbh->prepare("UPDATE items SET onloan = NULL where itemnumber = ?");
1198 $sth->execute($iteminformation->{'itemnumber'});
1200 my $record = GetMarcItem( $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'} );
1201 my $frameworkcode = GetFrameworkCode( $biblio->{'biblionumber'} );
1202 ModItemInMarc( $record, $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'}, $frameworkcode );
1204 if ($iteminformation->{borrowernumber}){
1205 ($borrower) = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1207 # fix up the accounts.....
1208 if ( $iteminformation->{'itemlost'} ) {
1209 $messages->{'WasLost'} = 1;
1212 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1213 # check if we have a transfer for this document
1214 my ($datesent,$frombranch,$tobranch) = GetTransfers( $iteminformation->{'itemnumber'} );
1216 # if we have a transfer to do, we update the line of transfers with the datearrived
1218 if ( $tobranch eq C4::Context->userenv->{'branch'} ) {
1221 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1223 $sth->execute( $iteminformation->{'itemnumber'} );
1225 # now we check if there is a reservation with the validate of transfer if we have one, we can set it with the status 'W'
1226 C4::Reserves::ModReserveStatus( $iteminformation->{'itemnumber'},'W' );
1229 $messages->{'WrongTransfer'} = $tobranch;
1230 $messages->{'WrongTransferItem'} = $iteminformation->{'itemnumber'};
1232 $validTransfert = 1;
1235 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1236 # fix up the accounts.....
1237 if ($iteminformation->{'itemlost'}) {
1238 FixAccountForLostAndReturned($iteminformation, $borrower);
1239 $messages->{'WasLost'} = 1;
1241 # fix up the overdues in accounts...
1242 FixOverduesOnReturn( $borrower->{'borrowernumber'},
1243 $iteminformation->{'itemnumber'}, $exemptfine );
1245 # find reserves.....
1246 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1247 my ( $resfound, $resrec ) =
1248 C4::Reserves::CheckReserves( $iteminformation->{'itemnumber'} );
1250 $resrec->{'ResFound'} = $resfound;
1251 $messages->{'ResFound'} = $resrec;
1256 # Record the fact that this book was returned.
1258 $branch, 'return', '0', '',
1259 $iteminformation->{'itemnumber'},
1260 $iteminformation->{'itemtype'},
1261 $borrower->{'borrowernumber'}
1264 &logaction(C4::Context->userenv->{'number'},"CIRCULATION","RETURN",$iteminformation->{borrowernumber},$iteminformation->{'biblionumber'})
1265 if C4::Context->preference("ReturnLog");
1267 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1268 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1270 if ( ($iteminformation->{'holdingbranch'} ne $iteminformation->{'homebranch'}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) and ($reserveDone ne 1) ){
1271 if (C4::Context->preference("AutomaticItemReturn") == 1) {
1272 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1273 $messages->{'WasTransfered'} = 1;
1276 $messages->{'NeedsTransfer'} = 1;
1280 return ( $doreturn, $messages, $iteminformation, $borrower );
1283 =head2 FixOverduesOnReturn
1285 &FixOverduesOnReturn($brn,$itm, $exemptfine);
1287 C<$brn> borrowernumber
1291 internal function, called only by AddReturn
1295 sub FixOverduesOnReturn {
1296 my ( $borrowernumber, $item, $exemptfine ) = @_;
1297 my $dbh = C4::Context->dbh;
1299 # check for overdue fine
1302 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1304 $sth->execute( $borrowernumber, $item );
1306 # alter fine to show that the book has been returned
1308 if ($data = $sth->fetchrow_hashref) {
1309 my $uquery =($exemptfine)? "update accountlines set accounttype='FFOR', amountoutstanding=0":"update accountlines set accounttype='F' ";
1310 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1311 my $usth = $dbh->prepare($uquery);
1312 $usth->execute($borrowernumber,$item ,$data->{'accountno'});
1320 =head2 FixAccountForLostAndReturned
1322 &FixAccountForLostAndReturned($iteminfo,$borrower);
1324 Calculates the charge for a book lost and returned (Not exported & used only once)
1326 C<$iteminfo> is a hashref to iteminfo. Only {itemnumber} is used.
1328 C<$borrower> is a hashref to borrower. Only {borrowernumber is used.
1330 Internal function, called by AddReturn
1334 sub FixAccountForLostAndReturned {
1335 my ($iteminfo, $borrower) = @_;
1337 my $dbh = C4::Context->dbh;
1338 my $itm = $iteminfo->{'itemnumber'};
1339 # check for charge made for lost book
1340 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1341 $sth->execute($itm);
1342 if (my $data = $sth->fetchrow_hashref) {
1343 # writeoff this amount
1345 my $amount = $data->{'amount'};
1346 my $acctno = $data->{'accountno'};
1348 if ($data->{'amountoutstanding'} == $amount) {
1349 $offset = $data->{'amount'};
1352 $offset = $amount - $data->{'amountoutstanding'};
1353 $amountleft = $data->{'amountoutstanding'} - $amount;
1355 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1356 WHERE (borrowernumber = ?)
1357 AND (itemnumber = ?) AND (accountno = ?) ");
1358 $usth->execute($data->{'borrowernumber'},$itm,$acctno);
1360 #check if any credit is left if so writeoff other accounts
1361 my $nextaccntno = getnextacctno(\%env,$data->{'borrowernumber'},$dbh);
1362 if ($amountleft < 0){
1365 if ($amountleft > 0){
1366 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1367 AND (amountoutstanding >0) ORDER BY date");
1368 $msth->execute($data->{'borrowernumber'});
1369 # offset transactions
1372 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1373 if ($accdata->{'amountoutstanding'} < $amountleft) {
1375 $amountleft -= $accdata->{'amountoutstanding'};
1377 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1380 my $thisacct = $accdata->{'accountno'};
1381 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1382 WHERE (borrowernumber = ?)
1383 AND (accountno=?)");
1384 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');
1386 $usth = $dbh->prepare("INSERT INTO accountoffsets
1387 (borrowernumber, accountno, offsetaccount, offsetamount)
1390 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1395 if ($amountleft > 0){
1398 my $desc="Item Returned ".$iteminfo->{'barcode'};
1399 $usth = $dbh->prepare("INSERT INTO accountlines
1400 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1401 VALUES (?,?,now(),?,?,'CR',?)");
1402 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1404 $usth = $dbh->prepare("INSERT INTO accountoffsets
1405 (borrowernumber, accountno, offsetaccount, offsetamount)
1407 $usth->execute($borrower->{'borrowernumber'},$data->{'accountno'},$nextaccntno,$offset);
1409 $usth = $dbh->prepare("UPDATE items SET paidfor='' WHERE itemnumber=?");
1410 $usth->execute($itm);
1419 $issues = &GetItemIssue($itemnumber);
1421 Returns patrons currently having a book. nothing if item is not issued atm
1423 C<$itemnumber> is the itemnumber
1425 Returns an array of hashes
1429 my ( $itemnumber) = @_;
1430 return unless $itemnumber;
1431 my $dbh = C4::Context->dbh;
1435 my $today = POSIX::strftime("%Y%m%d", localtime);
1437 my $sth = $dbh->prepare(
1438 "SELECT * FROM issues
1439 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1441 issues.itemnumber=? AND returndate IS NULL ");
1442 $sth->execute($itemnumber);
1443 my $data = $sth->fetchrow_hashref;
1444 my $datedue = $data->{'date_due'};
1446 if ( $datedue < $today ) {
1447 $data->{'overdue'} = 1;
1449 $data->{'itemnumber'} = $itemnumber; # fill itemnumber, in case item is not on issue
1454 =head2 GetItemIssues
1456 $issues = &GetItemIssues($itemnumber, $history);
1458 Returns patrons that have issued a book
1460 C<$itemnumber> is the itemnumber
1461 C<$history> is 0 if you want actuel "issuer" (if it exist) and 1 if you want issues history
1463 Returns an array of hashes
1467 my ( $itemnumber,$history ) = @_;
1468 my $dbh = C4::Context->dbh;
1472 my $today = POSIX::strftime("%Y%m%d", localtime);
1474 my $sth = $dbh->prepare(
1475 "SELECT * FROM issues
1476 LEFT JOIN borrowers ON borrowers.borrowernumber
1477 LEFT JOIN items ON items.itemnumber=issues.itemnumber
1479 issues.itemnumber=?".($history?"":" AND returndate IS NULL ").
1480 "ORDER BY issues.date_due DESC"
1482 $sth->execute($itemnumber);
1483 while ( my $data = $sth->fetchrow_hashref ) {
1484 my $datedue = $data->{'date_due'};
1486 if ( $datedue < $today ) {
1487 $data->{'overdue'} = 1;
1489 my $itemnumber = $data->{'itemnumber'};
1490 push @GetItemIssues, $data;
1493 return ( \@GetItemIssues );
1496 =head2 GetBiblioIssues
1498 $issues = GetBiblioIssues($biblionumber);
1500 this function get all issues from a biblionumber.
1503 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1504 tables issues and the firstname,surname & cardnumber from borrowers.
1508 sub GetBiblioIssues {
1509 my $biblionumber = shift;
1510 return undef unless $biblionumber;
1511 my $dbh = C4::Context->dbh;
1513 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1515 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1516 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1517 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1518 LEFT JOIN biblio ON biblio.biblionumber = items.biblioitemnumber
1519 WHERE biblio.biblionumber = ?
1520 ORDER BY issues.timestamp
1522 my $sth = $dbh->prepare($query);
1523 $sth->execute($biblionumber);
1526 while ( my $data = $sth->fetchrow_hashref ) {
1527 push @issues, $data;
1532 =head2 CanBookBeRenewed
1534 $ok = &CanBookBeRenewed($borrowernumber, $itemnumber);
1536 Find out whether a borrowed item may be renewed.
1538 C<$dbh> is a DBI handle to the Koha database.
1540 C<$borrowernumber> is the borrower number of the patron who currently
1541 has the item on loan.
1543 C<$itemnumber> is the number of the item to renew.
1545 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
1546 item must currently be on loan to the specified borrower; renewals
1547 must be allowed for the item's type; and the borrower must not have
1548 already renewed the loan.
1552 sub CanBookBeRenewed {
1554 # check renewal status
1555 my ( $borrowernumber, $itemnumber ) = @_;
1556 my $dbh = C4::Context->dbh;
1560 # Look in the issues table for this item, lent to this borrower,
1561 # and not yet returned.
1563 # FIXME - I think this function could be redone to use only one SQL call.
1564 my $sth1 = $dbh->prepare(
1565 "SELECT * FROM issues
1566 WHERE borrowernumber = ?
1568 AND returndate IS NULL"
1570 $sth1->execute( $borrowernumber, $itemnumber );
1571 if ( my $data1 = $sth1->fetchrow_hashref ) {
1573 # Found a matching item
1575 # See if this item may be renewed. This query is convoluted
1576 # because it's a bit messy: given the item number, we need to find
1577 # the biblioitem, which gives us the itemtype, which tells us
1578 # whether it may be renewed.
1579 my $sth2 = $dbh->prepare(
1580 "SELECT renewalsallowed FROM items
1581 LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
1582 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
1583 WHERE items.itemnumber = ?
1586 $sth2->execute($itemnumber);
1587 if ( my $data2 = $sth2->fetchrow_hashref ) {
1588 $renews = $data2->{'renewalsallowed'};
1590 if ( $renews && $renews >= $data1->{'renewals'} ) {
1594 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
1601 return ($renewokay);
1606 &AddRenewal($borrowernumber, $itemnumber, $datedue);
1610 C<$borrowernumber> is the borrower number of the patron who currently
1613 C<$itemnumber> is the number of the item to renew.
1615 C<$datedue> can be used to set the due date. If C<$datedue> is the
1616 empty string, C<&AddRenewal> will calculate the due date automatically
1617 from the book's item type. If you wish to set the due date manually,
1618 C<$datedue> should be in the form YYYY-MM-DD.
1624 my ( $borrowernumber, $itemnumber, $branch ,$datedue ) = @_;
1625 my $dbh = C4::Context->dbh;
1627 my $biblio = GetBiblioFromItemNumber($itemnumber);
1628 # If the due date wasn't specified, calculate it by adding the
1629 # book's loan length to today's date.
1630 unless ( $datedue ) {
1633 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
1634 my $loanlength = GetLoanLength(
1635 $borrower->{'categorycode'},
1636 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
1637 $borrower->{'branchcode'}
1639 #FIXME -- choose issuer or borrower branch.
1640 #FIXME -- where's the calendar ?
1641 #FIXME -- $debug-ify the (0)
1642 my @darray = Add_Delta_DHMS( Today_and_Now(), $loanlength, 0, 0, 0 );
1643 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d",@darray[0..2]), 'iso');
1644 (0) and print STDERR "C4::Dates->new->output = " . C4::Dates->new()->output()
1645 . "\ndatedue->output = " . $datedue->output()
1646 . "\n(Y,M,D) = " . join ',', @darray;
1647 $datedue=CheckValidDatedue($datedue,$itemnumber,$branch);
1650 # Find the issues record for this book
1652 $dbh->prepare("SELECT * FROM issues
1653 WHERE borrowernumber=?
1655 AND returndate IS NULL"
1657 $sth->execute( $borrowernumber, $itemnumber );
1658 my $issuedata = $sth->fetchrow_hashref;
1661 # Update the issues record to have the new due date, and a new count
1662 # of how many times it has been renewed.
1663 my $renews = $issuedata->{'renewals'} + 1;
1664 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?
1665 WHERE borrowernumber=?
1667 AND returndate IS NULL"
1669 $sth->execute( $datedue->output('iso'), $renews, $borrowernumber, $itemnumber );
1672 # Update the renewal count on the item, and tell zebra to reindex
1673 $renews = $biblio->{'renewals'} + 1;
1674 $sth = $dbh->prepare("UPDATE items SET renewals = ? WHERE itemnumber = ?");
1675 $sth->execute($renews,$itemnumber);
1677 my $record = GetMarcItem( $biblio->{'biblionumber'}, $itemnumber );
1678 my $frameworkcode = GetFrameworkCode( $biblio->{'biblionumber'} );
1679 ModItemInMarc( $record, $biblio->{'biblionumber'}, $itemnumber, $frameworkcode );
1681 # Charge a new rental fee, if applicable?
1682 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
1683 if ( $charge > 0 ) {
1684 my $accountno = getnextacctno( $borrowernumber );
1685 my $item = GetBiblioFromItemNumber($itemnumber);
1686 $sth = $dbh->prepare(
1687 "INSERT INTO accountlines
1688 (borrowernumber,accountno,date,amount,
1689 description,accounttype,amountoutstanding,
1691 VALUES (?,?,now(),?,?,?,?,?)"
1693 $sth->execute( $borrowernumber, $accountno, $charge,
1694 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
1695 'Rent', $charge, $itemnumber );
1699 UpdateStats( $branch, 'renew', $charge, '', $itemnumber );
1703 # check renewal status
1704 my ($bornum,$itemno)=@_;
1705 my $dbh = C4::Context->dbh;
1707 my $renewsallowed = 0;
1709 # Look in the issues table for this item, lent to this borrower,
1710 # and not yet returned.
1712 # FIXME - I think this function could be redone to use only one SQL call.
1713 my $sth = $dbh->prepare("select * from issues
1714 where (borrowernumber = ?)
1715 and (itemnumber = ?)
1716 and returndate is null");
1717 $sth->execute($bornum,$itemno);
1718 my $data = $sth->fetchrow_hashref;
1719 $renewcount = $data->{'renewals'} if $data->{'renewals'};
1720 my $sth2 = $dbh->prepare("select renewalsallowed from items,biblioitems,itemtypes
1721 where (items.itemnumber = ?)
1722 and (items.biblioitemnumber = biblioitems.biblioitemnumber)
1723 and (biblioitems.itemtype = itemtypes.itemtype)");
1724 $sth2->execute($itemno);
1725 my $data2 = $sth2->fetchrow_hashref();
1726 $renewsallowed = $data2->{'renewalsallowed'};
1727 $renewsleft = $renewsallowed - $renewcount;
1728 warn "Renewcount:$renewcount RenewsAll:$renewsallowed RenewLeft:$renewsleft";
1729 return ($renewcount,$renewsallowed,$renewsleft);
1731 =head2 GetIssuingCharges
1733 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
1735 Calculate how much it would cost for a given patron to borrow a given
1736 item, including any applicable discounts.
1738 C<$itemnumber> is the item number of item the patron wishes to borrow.
1740 C<$borrowernumber> is the patron's borrower number.
1742 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
1743 and C<$item_type> is the code for the item's item type (e.g., C<VID>
1748 sub GetIssuingCharges {
1750 # calculate charges due
1751 my ( $itemnumber, $borrowernumber ) = @_;
1753 my $dbh = C4::Context->dbh;
1756 # Get the book's item type and rental charge (via its biblioitem).
1757 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
1758 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
1759 $qcharge .= (C4::Context->preference('item-level_itypes'))
1760 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
1761 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
1763 $qcharge .= "WHERE items.itemnumber =?";
1765 my $sth1 = $dbh->prepare($qcharge);
1766 $sth1->execute($itemnumber);
1767 if ( my $data1 = $sth1->fetchrow_hashref ) {
1768 $item_type = $data1->{'itemtype'};
1769 $charge = $data1->{'rentalcharge'};
1770 my $q2 = "SELECT rentaldiscount FROM borrowers
1771 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
1772 WHERE borrowers.borrowernumber = ?
1773 AND issuingrules.itemtype = ?";
1774 my $sth2 = $dbh->prepare($q2);
1775 $sth2->execute( $borrowernumber, $item_type );
1776 if ( my $data2 = $sth2->fetchrow_hashref ) {
1777 my $discount = $data2->{'rentaldiscount'};
1778 if ( $discount eq 'NULL' ) {
1781 $charge = ( $charge * ( 100 - $discount ) ) / 100;
1787 return ( $charge, $item_type );
1790 =head2 AddIssuingCharge
1792 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
1796 sub AddIssuingCharge {
1797 my ( $itemnumber, $borrowernumber, $charge ) = @_;
1798 my $dbh = C4::Context->dbh;
1799 my $nextaccntno = getnextacctno( $borrowernumber );
1801 INSERT INTO accountlines
1802 (borrowernumber, itemnumber, accountno,
1803 date, amount, description, accounttype,
1805 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
1807 my $sth = $dbh->prepare($query);
1808 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
1814 GetTransfers($itemnumber);
1819 my ($itemnumber) = @_;
1821 my $dbh = C4::Context->dbh;
1827 FROM branchtransfers
1828 WHERE itemnumber = ?
1829 AND datearrived IS NULL
1831 my $sth = $dbh->prepare($query);
1832 $sth->execute($itemnumber);
1833 my @row = $sth->fetchrow_array();
1839 =head2 GetTransfersFromTo
1841 @results = GetTransfersFromTo($frombranch,$tobranch);
1843 Returns the list of pending transfers between $from and $to branch
1847 sub GetTransfersFromTo {
1848 my ( $frombranch, $tobranch ) = @_;
1849 return unless ( $frombranch && $tobranch );
1850 my $dbh = C4::Context->dbh;
1852 SELECT itemnumber,datesent,frombranch
1853 FROM branchtransfers
1856 AND datearrived IS NULL
1858 my $sth = $dbh->prepare($query);
1859 $sth->execute( $frombranch, $tobranch );
1862 while ( my $data = $sth->fetchrow_hashref ) {
1863 push @gettransfers, $data;
1866 return (@gettransfers);
1869 =head2 DeleteTransfer
1871 &DeleteTransfer($itemnumber);
1875 sub DeleteTransfer {
1876 my ($itemnumber) = @_;
1877 my $dbh = C4::Context->dbh;
1878 my $sth = $dbh->prepare(
1879 "DELETE FROM branchtransfers
1881 AND datearrived IS NULL "
1883 $sth->execute($itemnumber);
1887 =head2 AnonymiseIssueHistory
1889 $rows = AnonymiseIssueHistory($borrowernumber,$date)
1891 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
1892 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
1894 return the number of affected rows.
1898 sub AnonymiseIssueHistory {
1900 my $borrowernumber = shift;
1901 my $dbh = C4::Context->dbh;
1904 SET borrowernumber = NULL
1905 WHERE returndate < '".$date."'
1906 AND borrowernumber IS NOT NULL
1908 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
1909 my $rows_affected = $dbh->do($query);
1910 return $rows_affected;
1913 =head2 updateWrongTransfer
1915 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
1917 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
1921 sub updateWrongTransfer {
1922 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
1923 my $dbh = C4::Context->dbh;
1924 # first step validate the actual line of transfert .
1927 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
1929 $sth->execute($FromLibrary,$itemNumber);
1932 # second step create a new line of branchtransfer to the right location .
1933 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
1935 #third step changing holdingbranch of item
1936 UpdateHoldingbranch($FromLibrary,$itemNumber);
1939 =head2 UpdateHoldingbranch
1941 $items = UpdateHoldingbranch($branch,$itmenumber);
1942 Simple methode for updating hodlingbranch in items BDD line
1945 sub UpdateHoldingbranch {
1946 my ( $branch,$itmenumber ) = @_;
1947 my $dbh = C4::Context->dbh;
1948 # first step validate the actual line of transfert .
1951 "update items set holdingbranch = ? where itemnumber= ?"
1953 $sth->execute($branch,$itmenumber);
1958 =head2 CheckValidDatedue
1960 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
1961 this function return a new date due after checked if it's a repeatable or special holiday
1962 C<$date_due> = returndate calculate with no day check
1963 C<$itemnumber> = itemnumber
1964 C<$branchcode> = localisation of issue
1966 # Why not create calendar object? -
1967 # TODO add 'duedate' option to useDaysMode .
1968 sub CheckValidDatedue {
1969 my ($date_due,$itemnumber,$branchcode)=@_;
1970 my @datedue=split('-',$date_due->output('iso'));
1971 my $years=$datedue[0];
1972 my $month=$datedue[1];
1973 my $day=$datedue[2];
1974 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
1976 for (my $i=0;$i<2;$i++){
1977 $dow=Day_of_Week($years,$month,$day);
1978 ($dow=0) if ($dow>6);
1979 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
1980 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
1981 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
1982 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
1984 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
1987 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
1990 =head2 CheckRepeatableHolidays
1992 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
1993 this function check if the date due is a repeatable holiday
1994 C<$date_due> = returndate calculate with no day check
1995 C<$itemnumber> = itemnumber
1996 C<$branchcode> = localisation of issue
2000 sub CheckRepeatableHolidays{
2001 my($itemnumber,$week_day,$branchcode)=@_;
2002 my $dbh = C4::Context->dbh;
2003 my $query = qq|SELECT count(*)
2004 FROM repeatable_holidays
2007 my $sth = $dbh->prepare($query);
2008 $sth->execute($branchcode,$week_day);
2009 my $result=$sth->fetchrow;
2015 =head2 CheckSpecialHolidays
2017 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2018 this function check if the date is a special holiday
2019 C<$years> = the years of datedue
2020 C<$month> = the month of datedue
2021 C<$day> = the day of datedue
2022 C<$itemnumber> = itemnumber
2023 C<$branchcode> = localisation of issue
2025 sub CheckSpecialHolidays{
2026 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2027 my $dbh = C4::Context->dbh;
2028 my $query=qq|SELECT count(*)
2029 FROM `special_holidays`
2035 my $sth = $dbh->prepare($query);
2036 $sth->execute($years,$month,$day,$branchcode);
2037 my $countspecial=$sth->fetchrow ;
2039 return $countspecial;
2042 =head2 CheckRepeatableSpecialHolidays
2044 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2045 this function check if the date is a repeatble special holidays
2046 C<$month> = the month of datedue
2047 C<$day> = the day of datedue
2048 C<$itemnumber> = itemnumber
2049 C<$branchcode> = localisation of issue
2051 sub CheckRepeatableSpecialHolidays{
2052 my ($month,$day,$itemnumber,$branchcode) = @_;
2053 my $dbh = C4::Context->dbh;
2054 my $query=qq|SELECT count(*)
2055 FROM `repeatable_holidays`
2060 my $sth = $dbh->prepare($query);
2061 $sth->execute($month,$day,$branchcode);
2062 my $countspecial=$sth->fetchrow ;
2064 return $countspecial;
2069 sub CheckValidBarcode{
2071 my $dbh = C4::Context->dbh;
2072 my $query=qq|SELECT count(*)
2076 my $sth = $dbh->prepare($query);
2077 $sth->execute($barcode);
2078 my $exist=$sth->fetchrow ;
2089 Koha Developement team <info@koha.org>