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 $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
650 my $dbh = C4::Context->dbh;
653 # DUE DATE is OK ? -- should already have checked.
655 #$issuingimpossible{INVALID_DATE} = 1 unless ($duedate);
660 if ( $borrower->{flags}->{GNA} ) {
661 $issuingimpossible{GNA} = 1;
663 if ( $borrower->{flags}->{'LOST'} ) {
664 $issuingimpossible{CARD_LOST} = 1;
666 if ( $borrower->{flags}->{'DBARRED'} ) {
667 $issuingimpossible{DEBARRED} = 1;
669 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
670 $issuingimpossible{EXPIRED} = 1;
672 my @expirydate= split /-/,$borrower->{'dateexpiry'};
673 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
674 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
675 $issuingimpossible{EXPIRED} = 1;
684 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
685 if ( C4::Context->preference("IssuingInProcess") ) {
686 my $amountlimit = C4::Context->preference("noissuescharge");
687 if ( $amount > $amountlimit && !$inprocess ) {
688 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
690 elsif ( $amount <= $amountlimit && !$inprocess ) {
691 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
696 $needsconfirmation{DEBT} = $amount;
701 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
704 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
705 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
710 unless ( $item->{barcode} ) {
711 $issuingimpossible{UNKNOWN_BARCODE} = 1;
713 if ( $item->{'notforloan'}
714 && $item->{'notforloan'} > 0 )
716 $issuingimpossible{NOT_FOR_LOAN} = 1;
718 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
720 $issuingimpossible{WTHDRAWN} = 1;
722 if ( $item->{'restricted'}
723 && $item->{'restricted'} == 1 )
725 $issuingimpossible{RESTRICTED} = 1;
727 if ( C4::Context->preference("IndependantBranches") ) {
728 my $userenv = C4::Context->userenv;
729 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
730 $issuingimpossible{NOTSAMEBRANCH} = 1
731 if ( $item->{C4::Context->preference("HomeOrHoldingbranch")} ne $userenv->{branch} );
736 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
738 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
741 # Already issued to current borrower. Ask whether the loan should
743 my ($CanBookBeRenewed) = CanBookBeRenewed(
744 $borrower->{'borrowernumber'},
745 $item->{'itemnumber'}
747 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
748 $issuingimpossible{NO_MORE_RENEWALS} = 1;
751 $needsconfirmation{RENEW_ISSUE} = 1;
754 elsif ($issue->{borrowernumber}) {
756 # issued to someone else
757 my $currborinfo = GetMemberDetails( $issue->{borrowernumber} );
759 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
760 $needsconfirmation{ISSUED_TO_ANOTHER} =
761 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
764 # See if the item is on reserve.
765 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
767 my $resbor = $res->{'borrowernumber'};
768 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
771 # The item is on reserve and waiting, but has been
772 # reserved by some other patron.
773 my ( $resborrower, $flags ) =
774 GetMemberDetails( $resbor, 0 );
775 my $branches = GetBranches();
777 $branches->{ $res->{'branchcode'} }->{'branchname'};
778 $needsconfirmation{RESERVE_WAITING} =
779 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
781 # CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'}); Doesn't belong in a checking subroutine.
783 elsif ( $restype eq "Reserved" ) {
785 # The item is on reserve for someone else.
786 my ( $resborrower, $flags ) =
787 GetMemberDetails( $resbor, 0 );
788 my $branches = GetBranches();
790 $branches->{ $res->{'branchcode'} }->{'branchname'};
791 $needsconfirmation{RESERVED} =
792 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
795 if ( C4::Context->preference("LibraryName") eq "Horowhenua Library Trust" ) {
796 if ( $borrower->{'categorycode'} eq 'W' ) {
797 my %issuingimpossible;
798 return ( \%issuingimpossible, \%needsconfirmation );
800 return ( \%issuingimpossible, \%needsconfirmation );
803 return ( \%issuingimpossible, \%needsconfirmation );
809 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
811 &AddIssue($borrower,$barcode,$date)
815 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
817 =item C<$barcode> is the bar code of the book being issued.
819 =item C<$date> contains the max date of return. calculated if empty.
821 AddIssue does the following things :
822 - step 01: check that there is a borrowernumber & a barcode provided
823 - check for RENEWAL (book issued & being issued to the same patron)
824 - renewal YES = Calculate Charge & renew
826 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
828 - fill reserve if reserve to this patron
829 - cancel reserve or not, otherwise
830 * TRANSFERT PENDING ?
831 - complete the transfert
839 my ( $borrower, $barcode, $date, $cancelreserve ) = @_;
840 my $dbh = C4::Context->dbh;
841 my $barcodecheck=CheckValidBarcode($barcode);
842 if ($borrower and $barcode and $barcodecheck ne '0'){
843 # my ($borrower, $flags) = &GetMemberDetails($borrowernumber, 0);
844 # find which item we issue
845 my $item = GetItem('', $barcode);
848 # get actual issuing if there is one
849 my $actualissue = GetItemIssue( $item->{itemnumber});
851 # get biblioinformation for this item
852 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
855 # check if we just renew the issue.
857 if ( $actualissue->{borrowernumber} eq $borrower->{'borrowernumber'} ) {
859 $borrower->{'borrowernumber'},
860 $item->{'itemnumber'},
861 C4::Context->userenv->{'branch'},
868 if ( $actualissue->{borrowernumber}) {
869 # This book is currently on loan, but not to the person
870 # who wants to borrow it now. mark it returned before issuing to the new borrower
873 C4::Context->userenv->{'branch'}
877 # See if the item is on reserve.
878 my ( $restype, $res ) =
879 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
881 my $resbor = $res->{'borrowernumber'};
882 if ( $resbor eq $borrower->{'borrowernumber'} ) {
884 # The item is reserved by the current patron
885 ModReserveFill($res);
887 elsif ( $restype eq "Waiting" ) {
890 # The item is on reserve and waiting, but has been
891 # reserved by some other patron.
892 my ( $resborrower, $flags ) = GetMemberDetails( $resbor, 0 );
893 my $branches = GetBranches();
895 $branches->{ $res->{'branchcode'} }->{'branchname'};
897 elsif ( $restype eq "Reserved" ) {
900 # The item is reserved by someone else.
901 my ( $resborrower, $flags ) =
902 GetMemberDetails( $resbor, 0 );
903 my $branches = GetBranches();
905 $branches->{ $res->{'branchcode'} }->{'branchname'};
906 if ($cancelreserve) { # cancel reserves on this item
907 CancelReserve( 0, $res->{'itemnumber'},
908 $res->{'borrowernumber'} );
911 if ($cancelreserve) {
912 CancelReserve( $res->{'biblionumber'}, 0,
913 $res->{'borrowernumber'} );
916 # set waiting reserve to first in reserve queue as book isn't waiting now
919 $res->{'biblionumber'},
920 $res->{'borrowernumber'},
926 # Starting process for transfer job (checking transfert and validate it if we have one)
927 my ($datesent) = GetTransfers($item->{'itemnumber'});
929 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for lisibility of this case (maybe for stats ....)
932 "UPDATE branchtransfers
933 SET datearrived = now(),
935 comments = 'Forced branchtransfert'
936 WHERE itemnumber= ? AND datearrived IS NULL"
938 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
942 # Record in the database the fact that the book was issued.
946 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
953 my $itype=(C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ;
954 my $loanlength = GetLoanLength(
955 $borrower->{'categorycode'},
957 $borrower->{'branchcode'}
959 $datedue = time + ($loanlength) * 86400;
960 my @datearr = localtime($datedue);
961 $dateduef = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
962 $dateduef=CheckValidDatedue($dateduef,$item->{'itemnumber'},C4::Context->userenv->{'branch'});
964 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
965 if ( C4::Context->preference('ReturnBeforeExpiry') && $dateduef->output('iso') gt $borrower->{dateexpiry} ) {
966 $dateduef = C4::Dates->new($borrower->{dateexpiry},'iso');
970 $borrower->{'borrowernumber'},
971 $item->{'itemnumber'},
972 strftime( "%Y-%m-%d", localtime ),$dateduef->output('iso'), C4::Context->userenv->{'branch'}
978 "UPDATE items SET issues=?, holdingbranch=?, itemlost=0, datelastborrowed = now(), onloan = ? WHERE itemnumber=?");
981 C4::Context->userenv->{'branch'},
982 $dateduef->output('iso'),
983 $item->{'itemnumber'}
986 &ModDateLastSeen( $item->{'itemnumber'} );
987 my $record = GetMarcItem( $item->{'biblionumber'}, $item->{'itemnumber'} );
988 my $frameworkcode = GetFrameworkCode( $item->{'biblionumber'} );
989 ModItemInMarc( $record, $item->{'biblionumber'}, $item->{'itemnumber'}, $frameworkcode );
990 # If it costs to borrow this book, charge it to the patron's account.
991 my ( $charge, $itemtype ) = GetIssuingCharges(
992 $item->{'itemnumber'},
993 $borrower->{'borrowernumber'}
997 $item->{'itemnumber'},
998 $borrower->{'borrowernumber'}, $charge
1000 $item->{'charge'} = $charge;
1003 # Record the fact that this book was issued.
1005 C4::Context->userenv->{'branch'},
1007 '', $item->{'itemnumber'},
1008 $item->{'itemtype'}, $borrower->{'borrowernumber'}
1012 &logaction(C4::Context->userenv->{'number'},"CIRCULATION","ISSUE",$borrower->{'borrowernumber'},$biblio->{'biblionumber'})
1013 if C4::Context->preference("IssueLog");
1018 =head2 GetLoanLength
1020 Get loan length for an itemtype, a borrower type and a branch
1022 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1027 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1028 my $dbh = C4::Context->dbh;
1031 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1033 warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1034 # try to find issuelength & return the 1st available.
1035 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1036 $sth->execute( $borrowertype, $itemtype, $branchcode );
1037 my $loanlength = $sth->fetchrow_hashref;
1038 return $loanlength->{issuelength}
1039 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1041 $sth->execute( $borrowertype, $itemtype, "*" );
1042 $loanlength = $sth->fetchrow_hashref;
1043 return $loanlength->{issuelength}
1044 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1046 $sth->execute( $borrowertype, "*", $branchcode );
1047 $loanlength = $sth->fetchrow_hashref;
1048 return $loanlength->{issuelength}
1049 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1051 $sth->execute( "*", $itemtype, $branchcode );
1052 $loanlength = $sth->fetchrow_hashref;
1053 return $loanlength->{issuelength}
1054 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1056 $sth->execute( $borrowertype, "*", "*" );
1057 $loanlength = $sth->fetchrow_hashref;
1058 return $loanlength->{issuelength}
1059 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1061 $sth->execute( "*", "*", $branchcode );
1062 $loanlength = $sth->fetchrow_hashref;
1063 return $loanlength->{issuelength}
1064 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1066 $sth->execute( "*", $itemtype, "*" );
1067 $loanlength = $sth->fetchrow_hashref;
1068 return $loanlength->{issuelength}
1069 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1071 $sth->execute( "*", "*", "*" );
1072 $loanlength = $sth->fetchrow_hashref;
1073 return $loanlength->{issuelength}
1074 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1076 # if no rule is set => 21 days (hardcoded)
1082 ($doreturn, $messages, $iteminformation, $borrower) =
1083 &AddReturn($barcode, $branch, $exemptfine);
1087 C<$barcode> is the bar code of the book being returned. C<$branch> is
1088 the code of the branch where the book is being returned. C<$exemptfine>
1089 indicates that overdue charges for the item will not be applied.
1091 C<&AddReturn> returns a list of four items:
1093 C<$doreturn> is true iff the return succeeded.
1095 C<$messages> is a reference-to-hash giving the reason for failure:
1101 No item with this barcode exists. The value is C<$barcode>.
1105 The book is not currently on loan. The value is C<$barcode>.
1107 =item C<IsPermanent>
1109 The book's home branch is a permanent collection. If you have borrowed
1110 this book, you are not allowed to return it. The value is the code for
1111 the book's home branch.
1115 This book has been withdrawn/cancelled. The value should be ignored.
1119 The item was reserved. The value is a reference-to-hash whose keys are
1120 fields from the reserves table of the Koha database, and
1121 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1122 either C<Waiting>, C<Reserved>, or 0.
1126 C<$borrower> is a reference-to-hash, giving information about the
1127 patron who last borrowed the book.
1132 my ( $barcode, $branch, $exemptfine ) = @_;
1133 my $dbh = C4::Context->dbh;
1137 my $validTransfert = 0;
1138 my $reserveDone = 0;
1140 # get information on item
1141 my $iteminformation = GetItemIssue( GetItemnumberFromBarcode($barcode));
1142 my $biblio = GetBiblioFromItemNumber($iteminformation->{'itemnumber'});
1143 unless ($iteminformation->{'itemnumber'} ) {
1144 $messages->{'BadBarcode'} = $barcode;
1148 if ( ( not $iteminformation->{borrowernumber} ) && $doreturn ) {
1149 $messages->{'NotIssued'} = $barcode;
1153 # check if the book is in a permanent collection....
1154 my $hbr = $iteminformation->{'homebranch'};
1155 my $branches = GetBranches();
1156 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
1157 $messages->{'IsPermanent'} = $hbr;
1160 # if independent branches are on and returning to different branch, refuse the return
1161 if ($hbr ne C4::Context->userenv->{'branch'} && C4::Context->preference("IndependantBranches")){
1162 $messages->{'Wrongbranch'} = 1;
1166 # check that the book has been cancelled
1167 if ( $iteminformation->{'wthdrawn'} ) {
1168 $messages->{'wthdrawn'} = 1;
1172 # new op dev : if the book returned in an other branch update the holding branch
1174 # update issues, thereby returning book (should push this out into another subroutine
1175 $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1177 # case of a return of document (deal with issues and holdingbranch)
1182 "UPDATE issues SET returndate = now() WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (returndate IS NULL)"
1184 $sth->execute( $borrower->{'borrowernumber'},
1185 $iteminformation->{'itemnumber'} );
1186 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right?
1189 # continue to deal with returns cases, but not only if we have an issue
1191 # the holdingbranch is updated if the document is returned in an other location .
1192 if ( $iteminformation->{'holdingbranch'} ne C4::Context->userenv->{'branch'} ) {
1193 UpdateHoldingbranch(C4::Context->userenv->{'branch'},$iteminformation->{'itemnumber'});
1194 # reload iteminformation holdingbranch with the userenv value
1195 $iteminformation->{'holdingbranch'} = C4::Context->userenv->{'branch'};
1197 ModDateLastSeen( $iteminformation->{'itemnumber'} );
1198 my $sth = $dbh->prepare("UPDATE items SET onloan = NULL where itemnumber = ?");
1199 $sth->execute($iteminformation->{'itemnumber'});
1201 my $record = GetMarcItem( $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'} );
1202 my $frameworkcode = GetFrameworkCode( $biblio->{'biblionumber'} );
1203 ModItemInMarc( $record, $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'}, $frameworkcode );
1205 if ($iteminformation->{borrowernumber}){
1206 ($borrower) = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1208 # fix up the accounts.....
1209 if ( $iteminformation->{'itemlost'} ) {
1210 $messages->{'WasLost'} = 1;
1213 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1214 # check if we have a transfer for this document
1215 my ($datesent,$frombranch,$tobranch) = GetTransfers( $iteminformation->{'itemnumber'} );
1217 # if we have a transfer to do, we update the line of transfers with the datearrived
1219 if ( $tobranch eq C4::Context->userenv->{'branch'} ) {
1222 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1224 $sth->execute( $iteminformation->{'itemnumber'} );
1226 # 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'
1227 C4::Reserves::ModReserveStatus( $iteminformation->{'itemnumber'},'W' );
1230 $messages->{'WrongTransfer'} = $tobranch;
1231 $messages->{'WrongTransferItem'} = $iteminformation->{'itemnumber'};
1233 $validTransfert = 1;
1236 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1237 # fix up the accounts.....
1238 if ($iteminformation->{'itemlost'}) {
1239 FixAccountForLostAndReturned($iteminformation, $borrower);
1240 $messages->{'WasLost'} = 1;
1242 # fix up the overdues in accounts...
1243 FixOverduesOnReturn( $borrower->{'borrowernumber'},
1244 $iteminformation->{'itemnumber'}, $exemptfine );
1246 # find reserves.....
1247 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1248 my ( $resfound, $resrec ) =
1249 C4::Reserves::CheckReserves( $iteminformation->{'itemnumber'} );
1251 $resrec->{'ResFound'} = $resfound;
1252 $messages->{'ResFound'} = $resrec;
1257 # Record the fact that this book was returned.
1259 $branch, 'return', '0', '',
1260 $iteminformation->{'itemnumber'},
1261 $iteminformation->{'itemtype'},
1262 $borrower->{'borrowernumber'}
1265 &logaction(C4::Context->userenv->{'number'},"CIRCULATION","RETURN",$iteminformation->{borrowernumber},$iteminformation->{'biblionumber'})
1266 if C4::Context->preference("ReturnLog");
1268 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1269 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1271 if ( ($iteminformation->{'holdingbranch'} ne $iteminformation->{'homebranch'}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) and ($reserveDone ne 1) ){
1272 if (C4::Context->preference("AutomaticItemReturn") == 1) {
1273 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1274 $messages->{'WasTransfered'} = 1;
1277 $messages->{'NeedsTransfer'} = 1;
1281 return ( $doreturn, $messages, $iteminformation, $borrower );
1284 =head2 FixOverduesOnReturn
1286 &FixOverduesOnReturn($brn,$itm, $exemptfine);
1288 C<$brn> borrowernumber
1292 internal function, called only by AddReturn
1296 sub FixOverduesOnReturn {
1297 my ( $borrowernumber, $item, $exemptfine ) = @_;
1298 my $dbh = C4::Context->dbh;
1300 # check for overdue fine
1303 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1305 $sth->execute( $borrowernumber, $item );
1307 # alter fine to show that the book has been returned
1309 if ($data = $sth->fetchrow_hashref) {
1310 my $uquery =($exemptfine)? "update accountlines set accounttype='FFOR', amountoutstanding=0":"update accountlines set accounttype='F' ";
1311 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1312 my $usth = $dbh->prepare($uquery);
1313 $usth->execute($borrowernumber,$item ,$data->{'accountno'});
1321 =head2 FixAccountForLostAndReturned
1323 &FixAccountForLostAndReturned($iteminfo,$borrower);
1325 Calculates the charge for a book lost and returned (Not exported & used only once)
1327 C<$iteminfo> is a hashref to iteminfo. Only {itemnumber} is used.
1329 C<$borrower> is a hashref to borrower. Only {borrowernumber is used.
1331 Internal function, called by AddReturn
1335 sub FixAccountForLostAndReturned {
1336 my ($iteminfo, $borrower) = @_;
1338 my $dbh = C4::Context->dbh;
1339 my $itm = $iteminfo->{'itemnumber'};
1340 # check for charge made for lost book
1341 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1342 $sth->execute($itm);
1343 if (my $data = $sth->fetchrow_hashref) {
1344 # writeoff this amount
1346 my $amount = $data->{'amount'};
1347 my $acctno = $data->{'accountno'};
1349 if ($data->{'amountoutstanding'} == $amount) {
1350 $offset = $data->{'amount'};
1353 $offset = $amount - $data->{'amountoutstanding'};
1354 $amountleft = $data->{'amountoutstanding'} - $amount;
1356 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1357 WHERE (borrowernumber = ?)
1358 AND (itemnumber = ?) AND (accountno = ?) ");
1359 $usth->execute($data->{'borrowernumber'},$itm,$acctno);
1361 #check if any credit is left if so writeoff other accounts
1362 my $nextaccntno = getnextacctno(\%env,$data->{'borrowernumber'},$dbh);
1363 if ($amountleft < 0){
1366 if ($amountleft > 0){
1367 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1368 AND (amountoutstanding >0) ORDER BY date");
1369 $msth->execute($data->{'borrowernumber'});
1370 # offset transactions
1373 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1374 if ($accdata->{'amountoutstanding'} < $amountleft) {
1376 $amountleft -= $accdata->{'amountoutstanding'};
1378 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1381 my $thisacct = $accdata->{'accountno'};
1382 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1383 WHERE (borrowernumber = ?)
1384 AND (accountno=?)");
1385 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');
1387 $usth = $dbh->prepare("INSERT INTO accountoffsets
1388 (borrowernumber, accountno, offsetaccount, offsetamount)
1391 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1396 if ($amountleft > 0){
1399 my $desc="Item Returned ".$iteminfo->{'barcode'};
1400 $usth = $dbh->prepare("INSERT INTO accountlines
1401 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1402 VALUES (?,?,now(),?,?,'CR',?)");
1403 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1405 $usth = $dbh->prepare("INSERT INTO accountoffsets
1406 (borrowernumber, accountno, offsetaccount, offsetamount)
1408 $usth->execute($borrower->{'borrowernumber'},$data->{'accountno'},$nextaccntno,$offset);
1410 $usth = $dbh->prepare("UPDATE items SET paidfor='' WHERE itemnumber=?");
1411 $usth->execute($itm);
1420 $issues = &GetItemIssue($itemnumber);
1422 Returns patrons currently having a book. nothing if item is not issued atm
1424 C<$itemnumber> is the itemnumber
1426 Returns an array of hashes
1430 my ( $itemnumber) = @_;
1431 return unless $itemnumber;
1432 my $dbh = C4::Context->dbh;
1436 my $today = POSIX::strftime("%Y%m%d", localtime);
1438 my $sth = $dbh->prepare(
1439 "SELECT * FROM issues
1440 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1442 issues.itemnumber=? AND returndate IS NULL ");
1443 $sth->execute($itemnumber);
1444 my $data = $sth->fetchrow_hashref;
1445 my $datedue = $data->{'date_due'};
1447 if ( $datedue < $today ) {
1448 $data->{'overdue'} = 1;
1450 $data->{'itemnumber'} = $itemnumber; # fill itemnumber, in case item is not on issue
1455 =head2 GetItemIssues
1457 $issues = &GetItemIssues($itemnumber, $history);
1459 Returns patrons that have issued a book
1461 C<$itemnumber> is the itemnumber
1462 C<$history> is 0 if you want actuel "issuer" (if it exist) and 1 if you want issues history
1464 Returns an array of hashes
1468 my ( $itemnumber,$history ) = @_;
1469 my $dbh = C4::Context->dbh;
1473 my $today = POSIX::strftime("%Y%m%d", localtime);
1475 my $sth = $dbh->prepare(
1476 "SELECT * FROM issues
1477 LEFT JOIN borrowers ON borrowers.borrowernumber
1478 LEFT JOIN items ON items.itemnumber=issues.itemnumber
1480 issues.itemnumber=?".($history?"":" AND returndate IS NULL ").
1481 "ORDER BY issues.date_due DESC"
1483 $sth->execute($itemnumber);
1484 while ( my $data = $sth->fetchrow_hashref ) {
1485 my $datedue = $data->{'date_due'};
1487 if ( $datedue < $today ) {
1488 $data->{'overdue'} = 1;
1490 my $itemnumber = $data->{'itemnumber'};
1491 push @GetItemIssues, $data;
1494 return ( \@GetItemIssues );
1497 =head2 GetBiblioIssues
1499 $issues = GetBiblioIssues($biblionumber);
1501 this function get all issues from a biblionumber.
1504 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1505 tables issues and the firstname,surname & cardnumber from borrowers.
1509 sub GetBiblioIssues {
1510 my $biblionumber = shift;
1511 return undef unless $biblionumber;
1512 my $dbh = C4::Context->dbh;
1514 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1516 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1517 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1518 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1519 LEFT JOIN biblio ON biblio.biblionumber = items.biblioitemnumber
1520 WHERE biblio.biblionumber = ?
1521 ORDER BY issues.timestamp
1523 my $sth = $dbh->prepare($query);
1524 $sth->execute($biblionumber);
1527 while ( my $data = $sth->fetchrow_hashref ) {
1528 push @issues, $data;
1533 =head2 CanBookBeRenewed
1535 $ok = &CanBookBeRenewed($borrowernumber, $itemnumber);
1537 Find out whether a borrowed item may be renewed.
1539 C<$dbh> is a DBI handle to the Koha database.
1541 C<$borrowernumber> is the borrower number of the patron who currently
1542 has the item on loan.
1544 C<$itemnumber> is the number of the item to renew.
1546 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
1547 item must currently be on loan to the specified borrower; renewals
1548 must be allowed for the item's type; and the borrower must not have
1549 already renewed the loan.
1553 sub CanBookBeRenewed {
1555 # check renewal status
1556 my ( $borrowernumber, $itemnumber ) = @_;
1557 my $dbh = C4::Context->dbh;
1561 # Look in the issues table for this item, lent to this borrower,
1562 # and not yet returned.
1564 # FIXME - I think this function could be redone to use only one SQL call.
1565 my $sth1 = $dbh->prepare(
1566 "SELECT * FROM issues
1567 WHERE borrowernumber = ?
1569 AND returndate IS NULL"
1571 $sth1->execute( $borrowernumber, $itemnumber );
1572 if ( my $data1 = $sth1->fetchrow_hashref ) {
1574 # Found a matching item
1576 # See if this item may be renewed. This query is convoluted
1577 # because it's a bit messy: given the item number, we need to find
1578 # the biblioitem, which gives us the itemtype, which tells us
1579 # whether it may be renewed.
1580 my $sth2 = $dbh->prepare(
1581 "SELECT renewalsallowed FROM items
1582 LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
1583 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
1584 WHERE items.itemnumber = ?
1587 $sth2->execute($itemnumber);
1588 if ( my $data2 = $sth2->fetchrow_hashref ) {
1589 $renews = $data2->{'renewalsallowed'};
1591 if ( $renews && $renews >= $data1->{'renewals'} ) {
1595 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
1602 return ($renewokay);
1607 &AddRenewal($borrowernumber, $itemnumber, $datedue);
1611 C<$borrowernumber> is the borrower number of the patron who currently
1614 C<$itemnumber> is the number of the item to renew.
1616 C<$datedue> can be used to set the due date. If C<$datedue> is the
1617 empty string, C<&AddRenewal> will calculate the due date automatically
1618 from the book's item type. If you wish to set the due date manually,
1619 C<$datedue> should be in the form YYYY-MM-DD.
1625 my ( $borrowernumber, $itemnumber, $branch ,$datedue ) = @_;
1626 my $dbh = C4::Context->dbh;
1628 my $biblio = GetBiblioFromItemNumber($itemnumber);
1629 # If the due date wasn't specified, calculate it by adding the
1630 # book's loan length to today's date.
1631 unless ( $datedue ) {
1634 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
1635 my $loanlength = GetLoanLength(
1636 $borrower->{'categorycode'},
1637 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
1638 $borrower->{'branchcode'}
1640 #FIXME -- choose issuer or borrower branch.
1641 #FIXME -- where's the calendar ?
1642 #FIXME -- $debug-ify the (0)
1643 my @darray = Add_Delta_DHMS( Today_and_Now(), $loanlength, 0, 0, 0 );
1644 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d",@darray[0..2]), 'iso');
1645 (0) and print STDERR "C4::Dates->new->output = " . C4::Dates->new()->output()
1646 . "\ndatedue->output = " . $datedue->output()
1647 . "\n(Y,M,D) = " . join ',', @darray;
1648 $datedue=CheckValidDatedue($datedue,$itemnumber,$branch);
1651 # Find the issues record for this book
1653 $dbh->prepare("SELECT * FROM issues
1654 WHERE borrowernumber=?
1656 AND returndate IS NULL"
1658 $sth->execute( $borrowernumber, $itemnumber );
1659 my $issuedata = $sth->fetchrow_hashref;
1662 # Update the issues record to have the new due date, and a new count
1663 # of how many times it has been renewed.
1664 my $renews = $issuedata->{'renewals'} + 1;
1665 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?
1666 WHERE borrowernumber=?
1668 AND returndate IS NULL"
1670 $sth->execute( $datedue->output('iso'), $renews, $borrowernumber, $itemnumber );
1673 # Update the renewal count on the item, and tell zebra to reindex
1674 $renews = $biblio->{'renewals'} + 1;
1675 $sth = $dbh->prepare("UPDATE items SET renewals = ? WHERE itemnumber = ?");
1676 $sth->execute($renews,$itemnumber);
1678 my $record = GetMarcItem( $biblio->{'biblionumber'}, $itemnumber );
1679 my $frameworkcode = GetFrameworkCode( $biblio->{'biblionumber'} );
1680 ModItemInMarc( $record, $biblio->{'biblionumber'}, $itemnumber, $frameworkcode );
1682 # Charge a new rental fee, if applicable?
1683 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
1684 if ( $charge > 0 ) {
1685 my $accountno = getnextacctno( $borrowernumber );
1686 my $item = GetBiblioFromItemNumber($itemnumber);
1687 $sth = $dbh->prepare(
1688 "INSERT INTO accountlines
1689 (borrowernumber,accountno,date,amount,
1690 description,accounttype,amountoutstanding,
1692 VALUES (?,?,now(),?,?,?,?,?)"
1694 $sth->execute( $borrowernumber, $accountno, $charge,
1695 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
1696 'Rent', $charge, $itemnumber );
1700 UpdateStats( $branch, 'renew', $charge, '', $itemnumber );
1704 # check renewal status
1705 my ($bornum,$itemno)=@_;
1706 my $dbh = C4::Context->dbh;
1708 my $renewsallowed = 0;
1710 # Look in the issues table for this item, lent to this borrower,
1711 # and not yet returned.
1713 # FIXME - I think this function could be redone to use only one SQL call.
1714 my $sth = $dbh->prepare("select * from issues
1715 where (borrowernumber = ?)
1716 and (itemnumber = ?)
1717 and returndate is null");
1718 $sth->execute($bornum,$itemno);
1719 my $data = $sth->fetchrow_hashref;
1720 $renewcount = $data->{'renewals'} if $data->{'renewals'};
1721 my $sth2 = $dbh->prepare("select renewalsallowed from items,biblioitems,itemtypes
1722 where (items.itemnumber = ?)
1723 and (items.biblioitemnumber = biblioitems.biblioitemnumber)
1724 and (biblioitems.itemtype = itemtypes.itemtype)");
1725 $sth2->execute($itemno);
1726 my $data2 = $sth2->fetchrow_hashref();
1727 $renewsallowed = $data2->{'renewalsallowed'};
1728 $renewsleft = $renewsallowed - $renewcount;
1729 warn "Renewcount:$renewcount RenewsAll:$renewsallowed RenewLeft:$renewsleft";
1730 return ($renewcount,$renewsallowed,$renewsleft);
1732 =head2 GetIssuingCharges
1734 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
1736 Calculate how much it would cost for a given patron to borrow a given
1737 item, including any applicable discounts.
1739 C<$itemnumber> is the item number of item the patron wishes to borrow.
1741 C<$borrowernumber> is the patron's borrower number.
1743 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
1744 and C<$item_type> is the code for the item's item type (e.g., C<VID>
1749 sub GetIssuingCharges {
1751 # calculate charges due
1752 my ( $itemnumber, $borrowernumber ) = @_;
1754 my $dbh = C4::Context->dbh;
1757 # Get the book's item type and rental charge (via its biblioitem).
1758 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
1759 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
1760 $qcharge .= (C4::Context->preference('item-level_itypes'))
1761 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
1762 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
1764 $qcharge .= "WHERE items.itemnumber =?";
1766 my $sth1 = $dbh->prepare($qcharge);
1767 $sth1->execute($itemnumber);
1768 if ( my $data1 = $sth1->fetchrow_hashref ) {
1769 $item_type = $data1->{'itemtype'};
1770 $charge = $data1->{'rentalcharge'};
1771 my $q2 = "SELECT rentaldiscount FROM borrowers
1772 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
1773 WHERE borrowers.borrowernumber = ?
1774 AND issuingrules.itemtype = ?";
1775 my $sth2 = $dbh->prepare($q2);
1776 $sth2->execute( $borrowernumber, $item_type );
1777 if ( my $data2 = $sth2->fetchrow_hashref ) {
1778 my $discount = $data2->{'rentaldiscount'};
1779 if ( $discount eq 'NULL' ) {
1782 $charge = ( $charge * ( 100 - $discount ) ) / 100;
1788 return ( $charge, $item_type );
1791 =head2 AddIssuingCharge
1793 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
1797 sub AddIssuingCharge {
1798 my ( $itemnumber, $borrowernumber, $charge ) = @_;
1799 my $dbh = C4::Context->dbh;
1800 my $nextaccntno = getnextacctno( $borrowernumber );
1802 INSERT INTO accountlines
1803 (borrowernumber, itemnumber, accountno,
1804 date, amount, description, accounttype,
1806 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
1808 my $sth = $dbh->prepare($query);
1809 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
1815 GetTransfers($itemnumber);
1820 my ($itemnumber) = @_;
1822 my $dbh = C4::Context->dbh;
1828 FROM branchtransfers
1829 WHERE itemnumber = ?
1830 AND datearrived IS NULL
1832 my $sth = $dbh->prepare($query);
1833 $sth->execute($itemnumber);
1834 my @row = $sth->fetchrow_array();
1840 =head2 GetTransfersFromTo
1842 @results = GetTransfersFromTo($frombranch,$tobranch);
1844 Returns the list of pending transfers between $from and $to branch
1848 sub GetTransfersFromTo {
1849 my ( $frombranch, $tobranch ) = @_;
1850 return unless ( $frombranch && $tobranch );
1851 my $dbh = C4::Context->dbh;
1853 SELECT itemnumber,datesent,frombranch
1854 FROM branchtransfers
1857 AND datearrived IS NULL
1859 my $sth = $dbh->prepare($query);
1860 $sth->execute( $frombranch, $tobranch );
1863 while ( my $data = $sth->fetchrow_hashref ) {
1864 push @gettransfers, $data;
1867 return (@gettransfers);
1870 =head2 DeleteTransfer
1872 &DeleteTransfer($itemnumber);
1876 sub DeleteTransfer {
1877 my ($itemnumber) = @_;
1878 my $dbh = C4::Context->dbh;
1879 my $sth = $dbh->prepare(
1880 "DELETE FROM branchtransfers
1882 AND datearrived IS NULL "
1884 $sth->execute($itemnumber);
1888 =head2 AnonymiseIssueHistory
1890 $rows = AnonymiseIssueHistory($borrowernumber,$date)
1892 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
1893 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
1895 return the number of affected rows.
1899 sub AnonymiseIssueHistory {
1901 my $borrowernumber = shift;
1902 my $dbh = C4::Context->dbh;
1905 SET borrowernumber = NULL
1906 WHERE returndate < '".$date."'
1907 AND borrowernumber IS NOT NULL
1909 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
1910 my $rows_affected = $dbh->do($query);
1911 return $rows_affected;
1914 =head2 updateWrongTransfer
1916 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
1918 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
1922 sub updateWrongTransfer {
1923 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
1924 my $dbh = C4::Context->dbh;
1925 # first step validate the actual line of transfert .
1928 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
1930 $sth->execute($FromLibrary,$itemNumber);
1933 # second step create a new line of branchtransfer to the right location .
1934 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
1936 #third step changing holdingbranch of item
1937 UpdateHoldingbranch($FromLibrary,$itemNumber);
1940 =head2 UpdateHoldingbranch
1942 $items = UpdateHoldingbranch($branch,$itmenumber);
1943 Simple methode for updating hodlingbranch in items BDD line
1946 sub UpdateHoldingbranch {
1947 my ( $branch,$itmenumber ) = @_;
1948 my $dbh = C4::Context->dbh;
1949 # first step validate the actual line of transfert .
1952 "update items set holdingbranch = ? where itemnumber= ?"
1954 $sth->execute($branch,$itmenumber);
1959 =head2 CheckValidDatedue
1961 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
1962 this function return a new date due after checked if it's a repeatable or special holiday
1963 C<$date_due> = returndate calculate with no day check
1964 C<$itemnumber> = itemnumber
1965 C<$branchcode> = localisation of issue
1967 # Why not create calendar object? -
1968 # TODO add 'duedate' option to useDaysMode .
1969 sub CheckValidDatedue {
1970 my ($date_due,$itemnumber,$branchcode)=@_;
1971 my @datedue=split('-',$date_due->output('iso'));
1972 my $years=$datedue[0];
1973 my $month=$datedue[1];
1974 my $day=$datedue[2];
1975 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
1977 for (my $i=0;$i<2;$i++){
1978 $dow=Day_of_Week($years,$month,$day);
1979 ($dow=0) if ($dow>6);
1980 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
1981 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
1982 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
1983 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
1985 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
1988 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
1991 =head2 CheckRepeatableHolidays
1993 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
1994 this function check if the date due is a repeatable holiday
1995 C<$date_due> = returndate calculate with no day check
1996 C<$itemnumber> = itemnumber
1997 C<$branchcode> = localisation of issue
2001 sub CheckRepeatableHolidays{
2002 my($itemnumber,$week_day,$branchcode)=@_;
2003 my $dbh = C4::Context->dbh;
2004 my $query = qq|SELECT count(*)
2005 FROM repeatable_holidays
2008 my $sth = $dbh->prepare($query);
2009 $sth->execute($branchcode,$week_day);
2010 my $result=$sth->fetchrow;
2016 =head2 CheckSpecialHolidays
2018 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2019 this function check if the date is a special holiday
2020 C<$years> = the years of datedue
2021 C<$month> = the month of datedue
2022 C<$day> = the day of datedue
2023 C<$itemnumber> = itemnumber
2024 C<$branchcode> = localisation of issue
2026 sub CheckSpecialHolidays{
2027 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2028 my $dbh = C4::Context->dbh;
2029 my $query=qq|SELECT count(*)
2030 FROM `special_holidays`
2036 my $sth = $dbh->prepare($query);
2037 $sth->execute($years,$month,$day,$branchcode);
2038 my $countspecial=$sth->fetchrow ;
2040 return $countspecial;
2043 =head2 CheckRepeatableSpecialHolidays
2045 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2046 this function check if the date is a repeatble special holidays
2047 C<$month> = the month of datedue
2048 C<$day> = the day of datedue
2049 C<$itemnumber> = itemnumber
2050 C<$branchcode> = localisation of issue
2052 sub CheckRepeatableSpecialHolidays{
2053 my ($month,$day,$itemnumber,$branchcode) = @_;
2054 my $dbh = C4::Context->dbh;
2055 my $query=qq|SELECT count(*)
2056 FROM `repeatable_holidays`
2061 my $sth = $dbh->prepare($query);
2062 $sth->execute($month,$day,$branchcode);
2063 my $countspecial=$sth->fetchrow ;
2065 return $countspecial;
2070 sub CheckValidBarcode{
2072 my $dbh = C4::Context->dbh;
2073 my $query=qq|SELECT count(*)
2077 my $sth = $dbh->prepare($query);
2078 $sth->execute($barcode);
2079 my $exist=$sth->fetchrow ;
2090 Koha Developement team <info@koha.org>