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
40 use POSIX qw(strftime);
41 use C4::Branch; # GetBranches
42 use C4::Log; # logaction
46 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
49 # set the version for version checking
53 # FIXME subs that should probably be elsewhere
59 # subs to deal with issuing a book
71 &AnonymiseIssueHistory
74 # subs to deal with returns
79 # subs to deal with transfers
91 C4::Circulation - Koha circulation module
99 The functions in this module deal with circulation, issues, and
100 returns, as well as general information about the library.
101 Also deals with stocktaking.
107 =head3 $str = &decode($chunk);
111 =item Decodes a segment of a string emitted by a CueCat barcode scanner and
118 # FIXME - At least, I'm pretty sure this is for decoding CueCat stuff.
119 # 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 ?
121 sub cuecatbarcodedecode {
124 my @fields = split( /\./, $barcode );
125 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
126 if ( $#results == 2 ) {
136 =head3 $str = &decode($chunk);
140 =item Decodes a segment of a string emitted by a CueCat barcode scanner and
150 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
151 my @s = map { index( $seq, $_ ); } split( //, $encoded );
152 my $l = ( $#s + 1 ) % 4;
163 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
165 chr( ( $n >> 16 ) ^ 67 )
166 .chr( ( $n >> 8 & 255 ) ^ 67 )
167 .chr( ( $n & 255 ) ^ 67 );
170 $r = substr( $r, 0, length($r) - $l );
176 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch, $barcode, $ignore_reserves);
178 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
180 C<$newbranch> is the code for the branch to which the item should be transferred.
182 C<$barcode> is the barcode of the item to be transferred.
184 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
185 Otherwise, if an item is reserved, the transfer fails.
187 Returns three values:
191 is true if the transfer was successful.
195 is a reference-to-hash which may have any of the following keys:
201 There is no item in the catalog with the given barcode. The value is C<$barcode>.
205 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.
207 =item C<DestinationEqualsHolding>
209 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.
213 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.
217 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>.
219 =item C<WasTransferred>
221 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
228 my ( $tbr, $barcode, $ignoreRs ) = @_;
231 my $branches = GetBranches();
232 my $itemnumber = GetItemnumberFromBarcode( $barcode );
233 my $issue = GetItemIssue($itemnumber);
234 my $biblio = GetBiblioFromItemNumber($itemnumber);
237 if ( not $itemnumber ) {
238 $messages->{'BadBarcode'} = $barcode;
242 # get branches of book...
243 my $hbr = $biblio->{'homebranch'};
244 my $fbr = $biblio->{'holdingbranch'};
247 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
248 $messages->{'IsPermanent'} = $hbr;
251 # can't transfer book if is already there....
252 if ( $fbr eq $tbr ) {
253 $messages->{'DestinationEqualsHolding'} = 1;
257 # check if it is still issued to someone, return it...
258 if ($issue->{borrowernumber}) {
259 AddReturn( $barcode, $fbr );
260 $messages->{'WasReturned'} = $issue->{borrowernumber};
264 # That'll save a database query.
265 my ( $resfound, $resrec ) =
266 CheckReserves( $itemnumber );
267 if ( $resfound and not $ignoreRs ) {
268 $resrec->{'ResFound'} = $resfound;
270 # $messages->{'ResFound'} = $resrec;
274 #actually do the transfer....
276 ModItemTransfer( $itemnumber, $fbr, $tbr );
278 # don't need to update MARC anymore, we do it in batch now
279 $messages->{'WasTransfered'} = 1;
280 ModDateLastSeen( $itemnumber );
282 return ( $dotransfer, $messages, $biblio );
285 =head2 CanBookBeIssued
287 Check if a book can be issued.
289 my ($issuingimpossible,$needsconfirmation) = CanBookBeIssued($borrower,$barcode,$year,$month,$day);
293 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
295 =item C<$barcode> is the bar code of the book being issued.
297 =item C<$year> C<$month> C<$day> contains the date of the return (in case it's forced by "stickyduedate".
305 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
306 Possible values are :
312 sticky due date is invalid
316 borrower gone with no address
320 borrower declared it's card lost
326 =head3 UNKNOWN_BARCODE
340 item is restricted (set by ??)
342 C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
343 Possible values are :
351 renewing, not issuing
353 =head3 ISSUED_TO_ANOTHER
355 issued to someone else.
359 reserved for someone else.
363 sticky due date is invalid
367 if the borrower borrows to much things
371 # check if a book can be issued.
375 my $borrower = shift;
376 my $biblionumber = shift;
378 my $cat_borrower = $borrower->{'categorycode'};
379 my $dbh = C4::Context->dbh;
381 # Get which branchcode we need
382 if (C4::Context->preference('CircControl') eq 'PickupLibary'){
383 $branch = C4::Context->userenv->{'branch'};
385 elsif (C4::Context->preference('CircControl') eq 'PatronLibary'){
386 $branch = $borrower->{'branchcode'};
390 $branch = $item->{'homebranch'};
392 my $type = (C4::Context->preference('item-level_itypes'))
393 ? $item->{'itype'} # item-level
394 : $item->{'itemtype'}; # biblio-level
398 'SELECT * FROM issuingrules
399 WHERE categorycode = ?
404 my $query2 = "SELECT COUNT(*) FROM issues i, biblioitems s1, items s2
405 WHERE i.borrowernumber = ?
406 AND i.returndate IS NULL
407 AND i.itemnumber = s2.itemnumber
408 AND s1.biblioitemnumber = s2.biblioitemnumber";
409 if (C4::Context->preference('item-level_itypes')){
410 $query2.=" AND s2.itype=? ";
412 $query2.=" AND s1.itemtype= ? ";
414 my $sth2= $dbh->prepare($query2);
417 'SELECT COUNT(*) FROM issues
418 WHERE borrowernumber = ?
419 AND returndate IS NULL'
423 # check the 3 parameters (branch / itemtype / category code
424 $sth->execute( $cat_borrower, $type, $branch );
425 my $result = $sth->fetchrow_hashref;
426 # warn "$cat_borrower, $type, $branch = ".Data::Dumper::Dumper($result);
428 if ( $result->{maxissueqty} ne '' ) {
429 # warn "checking on everything set";
430 $sth2->execute( $borrower->{'borrowernumber'}, $type );
431 my $alreadyissued = $sth2->fetchrow;
432 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
433 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on branch/category/itemtype failed)" );
435 # now checking for total
436 $sth->execute( $cat_borrower, '*', $branch );
437 my $result = $sth->fetchrow_hashref;
438 if ( $result->{maxissueqty} ne '' ) {
439 $sth2->execute( $borrower->{'borrowernumber'}, $type );
440 my $alreadyissued = $sth2->fetchrow;
441 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
442 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on branch/category/total failed)" );
447 # check the 2 parameters (branch / itemtype / default categorycode
448 $sth->execute( '*', $type, $branch );
449 $result = $sth->fetchrow_hashref;
450 # warn "*, $type, $branch = ".Data::Dumper::Dumper($result);
452 if ( $result->{maxissueqty} ne '' ) {
453 # warn "checking on 2 parameters (default categorycode)";
454 $sth2->execute( $borrower->{'borrowernumber'}, $type );
455 my $alreadyissued = $sth2->fetchrow;
456 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
457 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on branch / default category / itemtype failed)" );
459 # now checking for total
460 $sth->execute( '*', '*', $branch );
461 my $result = $sth->fetchrow_hashref;
462 if ( $result->{maxissueqty} ne '' ) {
463 $sth2->execute( $borrower->{'borrowernumber'}, $type );
464 my $alreadyissued = $sth2->fetchrow;
465 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
466 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on branch / default category / total failed)" );
471 # check the 1 parameters (default branch / itemtype / categorycode
472 $sth->execute( $cat_borrower, $type, '*' );
473 $result = $sth->fetchrow_hashref;
474 # warn "$cat_borrower, $type, * = ".Data::Dumper::Dumper($result);
476 if ( $result->{maxissueqty} ne '' ) {
477 # warn "checking on 1 parameter (default branch + categorycode)";
478 $sth2->execute( $borrower->{'borrowernumber'}, $type );
479 my $alreadyissued = $sth2->fetchrow;
480 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
481 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on default branch/category/itemtype failed)" );
483 # now checking for total
484 $sth->execute( $cat_borrower, '*', '*' );
485 my $result = $sth->fetchrow_hashref;
486 if ( $result->{maxissueqty} ne '' ) {
487 $sth2->execute( $borrower->{'borrowernumber'}, $type );
488 my $alreadyissued = $sth2->fetchrow;
489 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
490 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on default branch / category / total failed)" );
495 # check the 0 parameters (default branch / itemtype / default categorycode
496 $sth->execute( '*', $type, '*' );
497 $result = $sth->fetchrow_hashref;
498 # warn "*, $type, * = ".Data::Dumper::Dumper($result);
500 if ( $result->{maxissueqty} ne '' ) {
501 # warn "checking on default branch and default categorycode";
502 $sth2->execute( $borrower->{'borrowernumber'}, $type );
503 my $alreadyissued = $sth2->fetchrow;
504 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
505 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on default branch / default category / itemtype failed)" );
508 # now checking for total
509 $sth->execute( '*', '*', '*' );
510 $result = $sth->fetchrow_hashref;
511 if ( $result->{maxissueqty} ne '' ) {
512 warn "checking total";
513 $sth2->execute( $borrower->{'borrowernumber'}, $type );
514 my $alreadyissued = $sth2->fetchrow;
515 if ( $result->{'maxissueqty'} <= $alreadyissued ) {
516 return ( "$alreadyissued / ".( $result->{maxissueqty} + 0 )." (rule on default branch / default category / total failed)" );
520 # OK, the patron can issue !!!
526 @issues = &itemissues($biblioitemnumber, $biblio);
528 Looks up information about who has borrowed the bookZ<>(s) with the
529 given biblioitemnumber.
531 C<$biblio> is ignored.
533 C<&itemissues> returns an array of references-to-hash. The keys
534 include the fields from the C<items> table in the Koha database.
535 Additional keys include:
541 If the item is currently on loan, this gives the due date.
543 If the item is not on loan, then this is either "Available" or
544 "Cancelled", if the item has been withdrawn.
548 If the item is currently on loan, this gives the card number of the
549 patron who currently has the item.
551 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
553 These give the timestamp for the last three times the item was
556 =item C<card0>, C<card1>, C<card2>
558 The card number of the last three patrons who borrowed this item.
560 =item C<borrower0>, C<borrower1>, C<borrower2>
562 The borrower number of the last three patrons who borrowed this item.
570 my ( $bibitem, $biblio ) = @_;
571 my $dbh = C4::Context->dbh;
573 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
578 $sth->execute($bibitem) || die $sth->errstr;
580 while ( my $data = $sth->fetchrow_hashref ) {
582 # Find out who currently has this item.
583 # FIXME - Wouldn't it be better to do this as a left join of
584 # some sort? Currently, this code assumes that if
585 # fetchrow_hashref() fails, then the book is on the shelf.
586 # fetchrow_hashref() can fail for any number of reasons (e.g.,
587 # database server crash), not just because no items match the
589 my $sth2 = $dbh->prepare(
590 "SELECT * FROM issues
591 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
593 AND returndate IS NULL
597 $sth2->execute( $data->{'itemnumber'} );
598 if ( my $data2 = $sth2->fetchrow_hashref ) {
599 $data->{'date_due'} = $data2->{'date_due'};
600 $data->{'card'} = $data2->{'cardnumber'};
601 $data->{'borrower'} = $data2->{'borrowernumber'};
604 $data->{'date_due'} = ($data->{'wthdrawn'} eq '1') ? 'Cancelled' : 'Available';
609 # Find the last 3 people who borrowed this item.
610 $sth2 = $dbh->prepare(
611 "SELECT * FROM issues
612 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
614 AND returndate IS NOT NULL
615 ORDER BY returndate DESC,timestamp DESC"
618 $sth2->execute( $data->{'itemnumber'} );
619 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
620 { # FIXME : error if there is less than 3 pple borrowing this item
621 if ( my $data2 = $sth2->fetchrow_hashref ) {
622 $data->{"timestamp$i2"} = $data2->{'timestamp'};
623 $data->{"card$i2"} = $data2->{'cardnumber'};
624 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
629 $results[$i] = $data;
637 =head2 CanBookBeIssued
639 ( $issuingimpossible, $needsconfirmation ) =
640 CanBookBeIssued( $borrower, $barcode, $duedatespec, $inprocess );
641 C<$duedatespec> is a C4::Dates object.
642 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
646 sub CanBookBeIssued {
647 my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
648 my %needsconfirmation; # filled with problems that needs confirmations
649 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
650 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
651 my $issue = GetItemIssue($item->{itemnumber});
652 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
653 $item->{'itemtype'}=$biblioitem->{'itemtype'};
654 my $dbh = C4::Context->dbh;
657 # DUE DATE is OK ? -- should already have checked.
659 #$issuingimpossible{INVALID_DATE} = 1 unless ($duedate);
664 if ( $borrower->{flags}->{GNA} ) {
665 $issuingimpossible{GNA} = 1;
667 if ( $borrower->{flags}->{'LOST'} ) {
668 $issuingimpossible{CARD_LOST} = 1;
670 if ( $borrower->{flags}->{'DBARRED'} ) {
671 $issuingimpossible{DEBARRED} = 1;
673 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
674 $issuingimpossible{EXPIRED} = 1;
676 my @expirydate= split /-/,$borrower->{'dateexpiry'};
677 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
678 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
679 $issuingimpossible{EXPIRED} = 1;
688 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
689 if ( C4::Context->preference("IssuingInProcess") ) {
690 my $amountlimit = C4::Context->preference("noissuescharge");
691 if ( $amount > $amountlimit && !$inprocess ) {
692 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
694 elsif ( $amount <= $amountlimit && !$inprocess ) {
695 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
700 $needsconfirmation{DEBT} = $amount;
705 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
707 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
708 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
713 unless ( $item->{barcode} ) {
714 $issuingimpossible{UNKNOWN_BARCODE} = 1;
716 if ( $item->{'notforloan'}
717 && $item->{'notforloan'} > 0 )
719 $issuingimpossible{NOT_FOR_LOAN} = 1;
721 elsif ( !$item->{'notforloan'} ){
722 # we have to check itemtypes.notforloan also
723 if (C4::Context->preference('item-level_itypes')){
724 # this should probably be a subroutine
725 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
726 $sth->execute($item->{'itemtype'});
727 my $notforloan=$sth->fetchrow_hashref();
729 if ($notforloan->{'notforloan'} == 1){
730 $issuingimpossible{NOT_FOR_LOAN} = 1;
733 elsif ($biblioitem->{'notforloan'} == 1){
734 $issuingimpossible{NOT_FOR_LOAN} = 1;
737 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
739 $issuingimpossible{WTHDRAWN} = 1;
741 if ( $item->{'restricted'}
742 && $item->{'restricted'} == 1 )
744 $issuingimpossible{RESTRICTED} = 1;
746 if ( C4::Context->preference("IndependantBranches") ) {
747 my $userenv = C4::Context->userenv;
748 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
749 $issuingimpossible{NOTSAMEBRANCH} = 1
750 if ( $item->{C4::Context->preference("HomeOrHoldingbranch")} ne $userenv->{branch} );
755 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
757 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
760 # Already issued to current borrower. Ask whether the loan should
762 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
763 $borrower->{'borrowernumber'},
764 $item->{'itemnumber'}
766 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
767 $issuingimpossible{NO_MORE_RENEWALS} = 1;
770 $needsconfirmation{RENEW_ISSUE} = 1;
773 elsif ($issue->{borrowernumber}) {
775 # issued to someone else
776 my $currborinfo = GetMemberDetails( $issue->{borrowernumber} );
778 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
779 $needsconfirmation{ISSUED_TO_ANOTHER} =
780 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
783 # See if the item is on reserve.
784 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
786 my $resbor = $res->{'borrowernumber'};
787 my ( $resborrower, $flags ) = GetMemberDetails( $resbor, 0 );
788 my $branches = GetBranches();
789 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
790 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
792 # The item is on reserve and waiting, but has been
793 # reserved by some other patron.
794 $needsconfirmation{RESERVE_WAITING} =
795 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
797 elsif ( $restype eq "Reserved" ) {
798 # The item is on reserve for someone else.
799 $needsconfirmation{RESERVED} =
800 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
803 if ( C4::Context->preference("LibraryName") eq "Horowhenua Library Trust" ) {
804 if ( $borrower->{'categorycode'} eq 'W' ) {
806 return ( \%emptyhash, \%needsconfirmation );
809 return ( \%issuingimpossible, \%needsconfirmation );
814 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
816 &AddIssue($borrower,$barcode,$date)
820 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
822 =item C<$barcode> is the bar code of the book being issued.
824 =item C<$date> contains the max date of return. calculated if empty.
826 AddIssue does the following things :
827 - step 01: check that there is a borrowernumber & a barcode provided
828 - check for RENEWAL (book issued & being issued to the same patron)
829 - renewal YES = Calculate Charge & renew
831 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
833 - fill reserve if reserve to this patron
834 - cancel reserve or not, otherwise
835 * TRANSFERT PENDING ?
836 - complete the transfert
844 my ( $borrower, $barcode, $date, $cancelreserve ) = @_;
845 my $dbh = C4::Context->dbh;
846 my $barcodecheck=CheckValidBarcode($barcode);
847 if ($borrower and $barcode and $barcodecheck ne '0'){
848 # find which item we issue
849 my $item = GetItem('', $barcode);
853 # Get which branchcode we need
854 if (C4::Context->preference('CircControl') eq 'PickupLibary'){
855 $branch = C4::Context->userenv->{'branchcode'};
857 elsif (C4::Context->preference('CircControl') eq 'PatronLibary'){
858 $branch = $borrower->{'branchcode'};
862 $branch = $item->{'homebranch'};
865 # get actual issuing if there is one
866 my $actualissue = GetItemIssue( $item->{itemnumber});
868 # get biblioinformation for this item
869 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
872 # check if we just renew the issue.
874 if ( $actualissue->{borrowernumber} eq $borrower->{'borrowernumber'} ) {
876 $borrower->{'borrowernumber'},
877 $item->{'itemnumber'},
885 if ( $actualissue->{borrowernumber}) {
886 # This book is currently on loan, but not to the person
887 # who wants to borrow it now. mark it returned before issuing to the new borrower
890 C4::Context->userenv->{'branch'}
894 # See if the item is on reserve.
895 my ( $restype, $res ) =
896 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
898 my $resbor = $res->{'borrowernumber'};
899 if ( $resbor eq $borrower->{'borrowernumber'} ) {
901 # The item is reserved by the current patron
902 ModReserveFill($res);
904 elsif ( $restype eq "Waiting" ) {
907 # The item is on reserve and waiting, but has been
908 # reserved by some other patron.
909 my ( $resborrower, $flags ) = GetMemberDetails( $resbor, 0 );
910 my $branches = GetBranches();
912 $branches->{ $res->{'branchcode'} }->{'branchname'};
914 elsif ( $restype eq "Reserved" ) {
917 # The item is reserved by someone else.
918 my ( $resborrower, $flags ) =
919 GetMemberDetails( $resbor, 0 );
920 my $branches = GetBranches();
921 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
922 if ($cancelreserve) { # cancel reserves on this item
923 CancelReserve( 0, $res->{'itemnumber'},
924 $res->{'borrowernumber'} );
927 if ($cancelreserve) {
928 CancelReserve( $res->{'biblionumber'}, 0,
929 $res->{'borrowernumber'} );
932 # set waiting reserve to first in reserve queue as book isn't waiting now
934 $res->{'biblionumber'},
935 $res->{'borrowernumber'},
941 # Starting process for transfer job (checking transfert and validate it if we have one)
942 my ($datesent) = GetTransfers($item->{'itemnumber'});
944 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for lisibility of this case (maybe for stats ....)
947 "UPDATE branchtransfers
948 SET datearrived = now(),
950 comments = 'Forced branchtransfert'
951 WHERE itemnumber= ? AND datearrived IS NULL"
953 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
957 # Record in the database the fact that the book was issued.
961 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
968 my $itype=(C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ;
969 my $loanlength = GetLoanLength(
970 $borrower->{'categorycode'},
974 $datedue = time + ($loanlength) * 86400;
975 my @datearr = localtime($datedue);
976 $dateduef = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
977 $dateduef=CheckValidDatedue($dateduef,$item->{'itemnumber'},C4::Context->userenv->{'branch'});
979 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
980 if ( C4::Context->preference('ReturnBeforeExpiry') && $dateduef->output('iso') gt $borrower->{dateexpiry} ) {
981 $dateduef = C4::Dates->new($borrower->{dateexpiry},'iso');
985 $borrower->{'borrowernumber'},
986 $item->{'itemnumber'},
987 strftime( "%Y-%m-%d", localtime ),$dateduef->output('iso'), C4::Context->userenv->{'branch'}
991 ModItem({ issues => $item->{'issues'},
992 holdingbranch => C4::Context->userenv->{'branch'},
994 datelastborrowed => C4::Dates->new()->output('iso'),
995 onloan => $dateduef->output('iso'),
996 }, $item->{'biblionumber'}, $item->{'itemnumber'});
997 ModDateLastSeen( $item->{'itemnumber'} );
999 # If it costs to borrow this book, charge it to the patron's account.
1000 my ( $charge, $itemtype ) = GetIssuingCharges(
1001 $item->{'itemnumber'},
1002 $borrower->{'borrowernumber'}
1004 if ( $charge > 0 ) {
1006 $item->{'itemnumber'},
1007 $borrower->{'borrowernumber'}, $charge
1009 $item->{'charge'} = $charge;
1012 # Record the fact that this book was issued.
1014 C4::Context->userenv->{'branch'},
1016 '', $item->{'itemnumber'},
1017 $item->{'itemtype'}, $borrower->{'borrowernumber'}
1021 &logaction(C4::Context->userenv->{'number'},"CIRCULATION","ISSUE",$borrower->{'borrowernumber'},$biblio->{'biblionumber'})
1022 if C4::Context->preference("IssueLog");
1027 =head2 GetLoanLength
1029 Get loan length for an itemtype, a borrower type and a branch
1031 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1036 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1037 my $dbh = C4::Context->dbh;
1040 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1042 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1043 # try to find issuelength & return the 1st available.
1044 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1045 $sth->execute( $borrowertype, $itemtype, $branchcode );
1046 my $loanlength = $sth->fetchrow_hashref;
1047 return $loanlength->{issuelength}
1048 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1050 $sth->execute( $borrowertype, $itemtype, "*" );
1051 $loanlength = $sth->fetchrow_hashref;
1052 return $loanlength->{issuelength}
1053 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1055 $sth->execute( $borrowertype, "*", $branchcode );
1056 $loanlength = $sth->fetchrow_hashref;
1057 return $loanlength->{issuelength}
1058 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1060 $sth->execute( "*", $itemtype, $branchcode );
1061 $loanlength = $sth->fetchrow_hashref;
1062 return $loanlength->{issuelength}
1063 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1065 $sth->execute( $borrowertype, "*", "*" );
1066 $loanlength = $sth->fetchrow_hashref;
1067 return $loanlength->{issuelength}
1068 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1070 $sth->execute( "*", "*", $branchcode );
1071 $loanlength = $sth->fetchrow_hashref;
1072 return $loanlength->{issuelength}
1073 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1075 $sth->execute( "*", $itemtype, "*" );
1076 $loanlength = $sth->fetchrow_hashref;
1077 return $loanlength->{issuelength}
1078 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1080 $sth->execute( "*", "*", "*" );
1081 $loanlength = $sth->fetchrow_hashref;
1082 return $loanlength->{issuelength}
1083 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1085 # if no rule is set => 21 days (hardcoded)
1091 ($doreturn, $messages, $iteminformation, $borrower) =
1092 &AddReturn($barcode, $branch, $exemptfine);
1096 C<$barcode> is the bar code of the book being returned. C<$branch> is
1097 the code of the branch where the book is being returned. C<$exemptfine>
1098 indicates that overdue charges for the item will not be applied.
1100 C<&AddReturn> returns a list of four items:
1102 C<$doreturn> is true iff the return succeeded.
1104 C<$messages> is a reference-to-hash giving the reason for failure:
1110 No item with this barcode exists. The value is C<$barcode>.
1114 The book is not currently on loan. The value is C<$barcode>.
1116 =item C<IsPermanent>
1118 The book's home branch is a permanent collection. If you have borrowed
1119 this book, you are not allowed to return it. The value is the code for
1120 the book's home branch.
1124 This book has been withdrawn/cancelled. The value should be ignored.
1128 The item was reserved. The value is a reference-to-hash whose keys are
1129 fields from the reserves table of the Koha database, and
1130 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1131 either C<Waiting>, C<Reserved>, or 0.
1135 C<$borrower> is a reference-to-hash, giving information about the
1136 patron who last borrowed the book.
1141 my ( $barcode, $branch, $exemptfine ) = @_;
1142 my $dbh = C4::Context->dbh;
1146 my $validTransfert = 0;
1147 my $reserveDone = 0;
1149 # get information on item
1150 my $iteminformation = GetItemIssue( GetItemnumberFromBarcode($barcode));
1151 my $biblio = GetBiblioItemData($iteminformation->{'biblioitemnumber'});
1152 # use Data::Dumper;warn Data::Dumper::Dumper($iteminformation);
1153 unless ($iteminformation->{'itemnumber'} ) {
1154 $messages->{'BadBarcode'} = $barcode;
1158 if ( ( not $iteminformation->{borrowernumber} ) && $doreturn ) {
1159 $messages->{'NotIssued'} = $barcode;
1163 # check if the book is in a permanent collection....
1164 my $hbr = $iteminformation->{'homebranch'};
1165 my $branches = GetBranches();
1166 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
1167 $messages->{'IsPermanent'} = $hbr;
1170 # if independent branches are on and returning to different branch, refuse the return
1171 if ($hbr ne C4::Context->userenv->{'branch'} && C4::Context->preference("IndependantBranches")){
1172 $messages->{'Wrongbranch'} = 1;
1176 # check that the book has been cancelled
1177 if ( $iteminformation->{'wthdrawn'} ) {
1178 $messages->{'wthdrawn'} = 1;
1182 # new op dev : if the book returned in an other branch update the holding branch
1184 # update issues, thereby returning book (should push this out into another subroutine
1185 $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1187 # case of a return of document (deal with issues and holdingbranch)
1192 "UPDATE issues SET returndate = now() WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (returndate IS NULL)"
1194 $sth->execute( $borrower->{'borrowernumber'},
1195 $iteminformation->{'itemnumber'} );
1196 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right?
1199 # continue to deal with returns cases, but not only if we have an issue
1201 # the holdingbranch is updated if the document is returned in an other location .
1202 if ( $iteminformation->{'holdingbranch'} ne C4::Context->userenv->{'branch'} ) {
1203 UpdateHoldingbranch(C4::Context->userenv->{'branch'},$iteminformation->{'itemnumber'});
1204 # reload iteminformation holdingbranch with the userenv value
1205 $iteminformation->{'holdingbranch'} = C4::Context->userenv->{'branch'};
1207 ModDateLastSeen( $iteminformation->{'itemnumber'} );
1208 ModItem({ onloan => undef }, $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'});
1210 if ($iteminformation->{borrowernumber}){
1211 ($borrower) = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1213 # fix up the accounts.....
1214 if ( $iteminformation->{'itemlost'} ) {
1215 $messages->{'WasLost'} = 1;
1218 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1219 # check if we have a transfer for this document
1220 my ($datesent,$frombranch,$tobranch) = GetTransfers( $iteminformation->{'itemnumber'} );
1222 # if we have a transfer to do, we update the line of transfers with the datearrived
1224 if ( $tobranch eq C4::Context->userenv->{'branch'} ) {
1227 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1229 $sth->execute( $iteminformation->{'itemnumber'} );
1231 # 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'
1232 C4::Reserves::ModReserveStatus( $iteminformation->{'itemnumber'},'W' );
1235 $messages->{'WrongTransfer'} = $tobranch;
1236 $messages->{'WrongTransferItem'} = $iteminformation->{'itemnumber'};
1238 $validTransfert = 1;
1241 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1242 # fix up the accounts.....
1243 if ($iteminformation->{'itemlost'}) {
1244 FixAccountForLostAndReturned($iteminformation, $borrower);
1245 $messages->{'WasLost'} = 1;
1247 # fix up the overdues in accounts...
1248 FixOverduesOnReturn( $borrower->{'borrowernumber'},
1249 $iteminformation->{'itemnumber'}, $exemptfine );
1251 # find reserves.....
1252 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1253 my ( $resfound, $resrec ) =
1254 C4::Reserves::CheckReserves( $iteminformation->{'itemnumber'} );
1256 $resrec->{'ResFound'} = $resfound;
1257 $messages->{'ResFound'} = $resrec;
1262 # Record the fact that this book was returned.
1264 $branch, 'return', '0', '',
1265 $iteminformation->{'itemnumber'},
1266 $biblio->{'itemtype'},
1267 $borrower->{'borrowernumber'}
1270 &logaction(C4::Context->userenv->{'number'},"CIRCULATION","RETURN",$iteminformation->{borrowernumber},$iteminformation->{'biblionumber'})
1271 if C4::Context->preference("ReturnLog");
1273 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1274 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1276 if ( ($iteminformation->{'holdingbranch'} ne $iteminformation->{'homebranch'}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) and ($reserveDone ne 1) ){
1277 if (C4::Context->preference("AutomaticItemReturn") == 1) {
1278 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1279 $messages->{'WasTransfered'} = 1;
1282 $messages->{'NeedsTransfer'} = 1;
1286 return ( $doreturn, $messages, $iteminformation, $borrower );
1289 =head2 FixOverduesOnReturn
1291 &FixOverduesOnReturn($brn,$itm, $exemptfine);
1293 C<$brn> borrowernumber
1297 internal function, called only by AddReturn
1301 sub FixOverduesOnReturn {
1302 my ( $borrowernumber, $item, $exemptfine ) = @_;
1303 my $dbh = C4::Context->dbh;
1305 # check for overdue fine
1308 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1310 $sth->execute( $borrowernumber, $item );
1312 # alter fine to show that the book has been returned
1314 if ($data = $sth->fetchrow_hashref) {
1315 my $uquery =($exemptfine)? "update accountlines set accounttype='FFOR', amountoutstanding=0":"update accountlines set accounttype='F' ";
1316 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1317 my $usth = $dbh->prepare($uquery);
1318 $usth->execute($borrowernumber,$item ,$data->{'accountno'});
1326 =head2 FixAccountForLostAndReturned
1328 &FixAccountForLostAndReturned($iteminfo,$borrower);
1330 Calculates the charge for a book lost and returned (Not exported & used only once)
1332 C<$iteminfo> is a hashref to iteminfo. Only {itemnumber} is used.
1334 C<$borrower> is a hashref to borrower. Only {borrowernumber is used.
1336 Internal function, called by AddReturn
1340 sub FixAccountForLostAndReturned {
1341 my ($iteminfo, $borrower) = @_;
1343 my $dbh = C4::Context->dbh;
1344 my $itm = $iteminfo->{'itemnumber'};
1345 # check for charge made for lost book
1346 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1347 $sth->execute($itm);
1348 if (my $data = $sth->fetchrow_hashref) {
1349 # writeoff this amount
1351 my $amount = $data->{'amount'};
1352 my $acctno = $data->{'accountno'};
1354 if ($data->{'amountoutstanding'} == $amount) {
1355 $offset = $data->{'amount'};
1358 $offset = $amount - $data->{'amountoutstanding'};
1359 $amountleft = $data->{'amountoutstanding'} - $amount;
1361 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1362 WHERE (borrowernumber = ?)
1363 AND (itemnumber = ?) AND (accountno = ?) ");
1364 $usth->execute($data->{'borrowernumber'},$itm,$acctno);
1366 #check if any credit is left if so writeoff other accounts
1367 my $nextaccntno = getnextacctno(\%env,$data->{'borrowernumber'},$dbh);
1368 if ($amountleft < 0){
1371 if ($amountleft > 0){
1372 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1373 AND (amountoutstanding >0) ORDER BY date");
1374 $msth->execute($data->{'borrowernumber'});
1375 # offset transactions
1378 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1379 if ($accdata->{'amountoutstanding'} < $amountleft) {
1381 $amountleft -= $accdata->{'amountoutstanding'};
1383 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1386 my $thisacct = $accdata->{'accountno'};
1387 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1388 WHERE (borrowernumber = ?)
1389 AND (accountno=?)");
1390 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');
1392 $usth = $dbh->prepare("INSERT INTO accountoffsets
1393 (borrowernumber, accountno, offsetaccount, offsetamount)
1396 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1401 if ($amountleft > 0){
1404 my $desc="Item Returned ".$iteminfo->{'barcode'};
1405 $usth = $dbh->prepare("INSERT INTO accountlines
1406 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1407 VALUES (?,?,now(),?,?,'CR',?)");
1408 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1410 $usth = $dbh->prepare("INSERT INTO accountoffsets
1411 (borrowernumber, accountno, offsetaccount, offsetamount)
1413 $usth->execute($borrower->{'borrowernumber'},$data->{'accountno'},$nextaccntno,$offset);
1415 ModItem({ paidfor => '' }, undef, $itm);
1423 $issues = &GetItemIssue($itemnumber);
1425 Returns patrons currently having a book. nothing if item is not issued atm
1427 C<$itemnumber> is the itemnumber
1429 Returns an array of hashes
1434 my ( $itemnumber) = @_;
1435 return unless $itemnumber;
1436 my $dbh = C4::Context->dbh;
1440 my $today = POSIX::strftime("%Y%m%d", localtime);
1442 my $sth = $dbh->prepare(
1443 "SELECT * FROM issues
1444 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1446 issues.itemnumber=? AND returndate IS NULL ");
1447 $sth->execute($itemnumber);
1448 my $data = $sth->fetchrow_hashref;
1449 my $datedue = $data->{'date_due'};
1451 if ( $datedue < $today ) {
1452 $data->{'overdue'} = 1;
1454 $data->{'itemnumber'} = $itemnumber; # fill itemnumber, in case item is not on issue
1459 =head2 GetItemIssues
1461 $issues = &GetItemIssues($itemnumber, $history);
1463 Returns patrons that have issued a book
1465 C<$itemnumber> is the itemnumber
1466 C<$history> is 0 if you want actuel "issuer" (if it exist) and 1 if you want issues history
1468 Returns an array of hashes
1473 my ( $itemnumber,$history ) = @_;
1474 my $dbh = C4::Context->dbh;
1478 my $today = POSIX::strftime("%Y%m%d", localtime);
1480 my $sth = $dbh->prepare(
1481 "SELECT * FROM issues
1482 LEFT JOIN borrowers ON borrowers.borrowernumber
1483 LEFT JOIN items ON items.itemnumber=issues.itemnumber
1485 issues.itemnumber=?".($history?"":" AND returndate IS NULL ").
1486 "ORDER BY issues.date_due DESC"
1488 $sth->execute($itemnumber);
1489 while ( my $data = $sth->fetchrow_hashref ) {
1490 my $datedue = $data->{'date_due'};
1492 if ( $datedue < $today ) {
1493 $data->{'overdue'} = 1;
1495 my $itemnumber = $data->{'itemnumber'};
1496 push @GetItemIssues, $data;
1499 return ( \@GetItemIssues );
1502 =head2 GetBiblioIssues
1504 $issues = GetBiblioIssues($biblionumber);
1506 this function get all issues from a biblionumber.
1509 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1510 tables issues and the firstname,surname & cardnumber from borrowers.
1514 sub GetBiblioIssues {
1515 my $biblionumber = shift;
1516 return undef unless $biblionumber;
1517 my $dbh = C4::Context->dbh;
1519 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1521 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1522 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1523 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1524 LEFT JOIN biblio ON biblio.biblionumber = items.biblioitemnumber
1525 WHERE biblio.biblionumber = ?
1526 ORDER BY issues.timestamp
1528 my $sth = $dbh->prepare($query);
1529 $sth->execute($biblionumber);
1532 while ( my $data = $sth->fetchrow_hashref ) {
1533 push @issues, $data;
1538 =head2 CanBookBeRenewed
1540 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber);
1542 Find out whether a borrowed item may be renewed.
1544 C<$dbh> is a DBI handle to the Koha database.
1546 C<$borrowernumber> is the borrower number of the patron who currently
1547 has the item on loan.
1549 C<$itemnumber> is the number of the item to renew.
1551 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
1552 item must currently be on loan to the specified borrower; renewals
1553 must be allowed for the item's type; and the borrower must not have
1554 already renewed the loan. $error will contain the reason the renewal can not proceed
1558 sub CanBookBeRenewed {
1560 # check renewal status
1561 my ( $borrowernumber, $itemnumber ) = @_;
1562 my $dbh = C4::Context->dbh;
1567 # Look in the issues table for this item, lent to this borrower,
1568 # and not yet returned.
1570 # FIXME - I think this function could be redone to use only one SQL call.
1571 my $sth1 = $dbh->prepare(
1572 "SELECT * FROM issues
1573 WHERE borrowernumber = ?
1575 AND returndate IS NULL"
1577 $sth1->execute( $borrowernumber, $itemnumber );
1578 if ( my $data1 = $sth1->fetchrow_hashref ) {
1580 # Found a matching item
1582 # See if this item may be renewed. This query is convoluted
1583 # because it's a bit messy: given the item number, we need to find
1584 # the biblioitem, which gives us the itemtype, which tells us
1585 # whether it may be renewed.
1586 my $sth2 = $dbh->prepare(
1587 "SELECT renewalsallowed FROM items
1588 LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
1589 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
1590 WHERE items.itemnumber = ?
1593 $sth2->execute($itemnumber);
1594 if ( my $data2 = $sth2->fetchrow_hashref ) {
1595 $renews = $data2->{'renewalsallowed'};
1597 if ( $renews && $renews > $data1->{'renewals'} ) {
1604 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
1612 return ($renewokay,$error);
1617 &AddRenewal($borrowernumber, $itemnumber, $datedue);
1621 C<$borrowernumber> is the borrower number of the patron who currently
1624 C<$itemnumber> is the number of the item to renew.
1626 C<$datedue> can be used to set the due date. If C<$datedue> is the
1627 empty string, C<&AddRenewal> will calculate the due date automatically
1628 from the book's item type. If you wish to set the due date manually,
1629 C<$datedue> should be in the form YYYY-MM-DD.
1635 my ( $borrowernumber, $itemnumber, $branch ,$datedue ) = @_;
1636 my $dbh = C4::Context->dbh;
1638 my $biblio = GetBiblioFromItemNumber($itemnumber);
1639 # If the due date wasn't specified, calculate it by adding the
1640 # book's loan length to today's date.
1641 unless ( $datedue ) {
1644 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
1645 my $loanlength = GetLoanLength(
1646 $borrower->{'categorycode'},
1647 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
1648 $borrower->{'branchcode'}
1650 #FIXME -- choose issuer or borrower branch.
1651 #FIXME -- where's the calendar ?
1652 #FIXME -- $debug-ify the (0)
1653 my @darray = Add_Delta_DHMS( Today_and_Now(), $loanlength, 0, 0, 0 );
1654 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d",@darray[0..2]), 'iso');
1655 (0) and print STDERR "C4::Dates->new->output = " . C4::Dates->new()->output()
1656 . "\ndatedue->output = " . $datedue->output()
1657 . "\n(Y,M,D) = " . join ',', @darray;
1658 $datedue=CheckValidDatedue($datedue,$itemnumber,$branch);
1661 # Find the issues record for this book
1663 $dbh->prepare("SELECT * FROM issues
1664 WHERE borrowernumber=?
1666 AND returndate IS NULL"
1668 $sth->execute( $borrowernumber, $itemnumber );
1669 my $issuedata = $sth->fetchrow_hashref;
1672 # Update the issues record to have the new due date, and a new count
1673 # of how many times it has been renewed.
1674 my $renews = $issuedata->{'renewals'} + 1;
1675 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?
1676 WHERE borrowernumber=?
1678 AND returndate IS NULL"
1680 $sth->execute( $datedue->output('iso'), $renews, $borrowernumber, $itemnumber );
1683 # Update the renewal count on the item, and tell zebra to reindex
1684 $renews = $biblio->{'renewals'} + 1;
1685 ModItem({ renewals => $renews }, $biblio->{'biblionumber'}, $itemnumber);
1687 # Charge a new rental fee, if applicable?
1688 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
1689 if ( $charge > 0 ) {
1690 my $accountno = getnextacctno( $borrowernumber );
1691 my $item = GetBiblioFromItemNumber($itemnumber);
1692 $sth = $dbh->prepare(
1693 "INSERT INTO accountlines
1694 (borrowernumber,accountno,date,amount,
1695 description,accounttype,amountoutstanding,
1697 VALUES (?,?,now(),?,?,?,?,?)"
1699 $sth->execute( $borrowernumber, $accountno, $charge,
1700 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
1701 'Rent', $charge, $itemnumber );
1705 UpdateStats( $branch, 'renew', $charge, '', $itemnumber );
1709 # check renewal status
1710 my ($bornum,$itemno)=@_;
1711 my $dbh = C4::Context->dbh;
1713 my $renewsallowed = 0;
1715 # Look in the issues table for this item, lent to this borrower,
1716 # and not yet returned.
1718 # FIXME - I think this function could be redone to use only one SQL call.
1719 my $sth = $dbh->prepare("select * from issues
1720 where (borrowernumber = ?)
1721 and (itemnumber = ?)
1722 and returndate is null");
1723 $sth->execute($bornum,$itemno);
1724 my $data = $sth->fetchrow_hashref;
1725 $renewcount = $data->{'renewals'} if $data->{'renewals'};
1726 my $sth2 = $dbh->prepare("select renewalsallowed from items,biblioitems,itemtypes
1727 where (items.itemnumber = ?)
1728 and (items.biblioitemnumber = biblioitems.biblioitemnumber)
1729 and (biblioitems.itemtype = itemtypes.itemtype)");
1730 $sth2->execute($itemno);
1731 my $data2 = $sth2->fetchrow_hashref();
1732 $renewsallowed = $data2->{'renewalsallowed'};
1733 $renewsleft = $renewsallowed - $renewcount;
1734 # warn "Renewcount:$renewcount RenewsAll:$renewsallowed RenewLeft:$renewsleft";
1735 return ($renewcount,$renewsallowed,$renewsleft);
1737 =head2 GetIssuingCharges
1739 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
1741 Calculate how much it would cost for a given patron to borrow a given
1742 item, including any applicable discounts.
1744 C<$itemnumber> is the item number of item the patron wishes to borrow.
1746 C<$borrowernumber> is the patron's borrower number.
1748 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
1749 and C<$item_type> is the code for the item's item type (e.g., C<VID>
1754 sub GetIssuingCharges {
1756 # calculate charges due
1757 my ( $itemnumber, $borrowernumber ) = @_;
1759 my $dbh = C4::Context->dbh;
1762 # Get the book's item type and rental charge (via its biblioitem).
1763 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
1764 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
1765 $qcharge .= (C4::Context->preference('item-level_itypes'))
1766 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
1767 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
1769 $qcharge .= "WHERE items.itemnumber =?";
1771 my $sth1 = $dbh->prepare($qcharge);
1772 $sth1->execute($itemnumber);
1773 if ( my $data1 = $sth1->fetchrow_hashref ) {
1774 $item_type = $data1->{'itemtype'};
1775 $charge = $data1->{'rentalcharge'};
1776 my $q2 = "SELECT rentaldiscount FROM borrowers
1777 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
1778 WHERE borrowers.borrowernumber = ?
1779 AND issuingrules.itemtype = ?";
1780 my $sth2 = $dbh->prepare($q2);
1781 $sth2->execute( $borrowernumber, $item_type );
1782 if ( my $data2 = $sth2->fetchrow_hashref ) {
1783 my $discount = $data2->{'rentaldiscount'};
1784 if ( $discount eq 'NULL' ) {
1787 $charge = ( $charge * ( 100 - $discount ) ) / 100;
1793 return ( $charge, $item_type );
1796 =head2 AddIssuingCharge
1798 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
1802 sub AddIssuingCharge {
1803 my ( $itemnumber, $borrowernumber, $charge ) = @_;
1804 my $dbh = C4::Context->dbh;
1805 my $nextaccntno = getnextacctno( $borrowernumber );
1807 INSERT INTO accountlines
1808 (borrowernumber, itemnumber, accountno,
1809 date, amount, description, accounttype,
1811 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
1813 my $sth = $dbh->prepare($query);
1814 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
1820 GetTransfers($itemnumber);
1825 my ($itemnumber) = @_;
1827 my $dbh = C4::Context->dbh;
1833 FROM branchtransfers
1834 WHERE itemnumber = ?
1835 AND datearrived IS NULL
1837 my $sth = $dbh->prepare($query);
1838 $sth->execute($itemnumber);
1839 my @row = $sth->fetchrow_array();
1845 =head2 GetTransfersFromTo
1847 @results = GetTransfersFromTo($frombranch,$tobranch);
1849 Returns the list of pending transfers between $from and $to branch
1853 sub GetTransfersFromTo {
1854 my ( $frombranch, $tobranch ) = @_;
1855 return unless ( $frombranch && $tobranch );
1856 my $dbh = C4::Context->dbh;
1858 SELECT itemnumber,datesent,frombranch
1859 FROM branchtransfers
1862 AND datearrived IS NULL
1864 my $sth = $dbh->prepare($query);
1865 $sth->execute( $frombranch, $tobranch );
1868 while ( my $data = $sth->fetchrow_hashref ) {
1869 push @gettransfers, $data;
1872 return (@gettransfers);
1875 =head2 DeleteTransfer
1877 &DeleteTransfer($itemnumber);
1881 sub DeleteTransfer {
1882 my ($itemnumber) = @_;
1883 my $dbh = C4::Context->dbh;
1884 my $sth = $dbh->prepare(
1885 "DELETE FROM branchtransfers
1887 AND datearrived IS NULL "
1889 $sth->execute($itemnumber);
1893 =head2 AnonymiseIssueHistory
1895 $rows = AnonymiseIssueHistory($borrowernumber,$date)
1897 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
1898 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
1900 return the number of affected rows.
1904 sub AnonymiseIssueHistory {
1906 my $borrowernumber = shift;
1907 my $dbh = C4::Context->dbh;
1910 SET borrowernumber = NULL
1911 WHERE returndate < '".$date."'
1912 AND borrowernumber IS NOT NULL
1914 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
1915 my $rows_affected = $dbh->do($query);
1916 return $rows_affected;
1919 =head2 updateWrongTransfer
1921 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
1923 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
1927 sub updateWrongTransfer {
1928 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
1929 my $dbh = C4::Context->dbh;
1930 # first step validate the actual line of transfert .
1933 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
1935 $sth->execute($FromLibrary,$itemNumber);
1938 # second step create a new line of branchtransfer to the right location .
1939 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
1941 #third step changing holdingbranch of item
1942 UpdateHoldingbranch($FromLibrary,$itemNumber);
1945 =head2 UpdateHoldingbranch
1947 $items = UpdateHoldingbranch($branch,$itmenumber);
1948 Simple methode for updating hodlingbranch in items BDD line
1952 sub UpdateHoldingbranch {
1953 my ( $branch,$itemnumber ) = @_;
1954 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
1957 =head2 CheckValidDatedue
1959 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
1960 this function return a new date due after checked if it's a repeatable or special holiday
1961 C<$date_due> = returndate calculate with no day check
1962 C<$itemnumber> = itemnumber
1963 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');
1992 =head2 CheckRepeatableHolidays
1994 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
1995 this function check if the date due is a repeatable holiday
1996 C<$date_due> = returndate calculate with no day check
1997 C<$itemnumber> = itemnumber
1998 C<$branchcode> = localisation of issue
2002 sub CheckRepeatableHolidays{
2003 my($itemnumber,$week_day,$branchcode)=@_;
2004 my $dbh = C4::Context->dbh;
2005 my $query = qq|SELECT count(*)
2006 FROM repeatable_holidays
2009 my $sth = $dbh->prepare($query);
2010 $sth->execute($branchcode,$week_day);
2011 my $result=$sth->fetchrow;
2017 =head2 CheckSpecialHolidays
2019 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2020 this function check if the date is a special holiday
2021 C<$years> = the years of datedue
2022 C<$month> = the month of datedue
2023 C<$day> = the day of datedue
2024 C<$itemnumber> = itemnumber
2025 C<$branchcode> = localisation of issue
2029 sub CheckSpecialHolidays{
2030 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2031 my $dbh = C4::Context->dbh;
2032 my $query=qq|SELECT count(*)
2033 FROM `special_holidays`
2039 my $sth = $dbh->prepare($query);
2040 $sth->execute($years,$month,$day,$branchcode);
2041 my $countspecial=$sth->fetchrow ;
2043 return $countspecial;
2046 =head2 CheckRepeatableSpecialHolidays
2048 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2049 this function check if the date is a repeatble special holidays
2050 C<$month> = the month of datedue
2051 C<$day> = the day of datedue
2052 C<$itemnumber> = itemnumber
2053 C<$branchcode> = localisation of issue
2057 sub CheckRepeatableSpecialHolidays{
2058 my ($month,$day,$itemnumber,$branchcode) = @_;
2059 my $dbh = C4::Context->dbh;
2060 my $query=qq|SELECT count(*)
2061 FROM `repeatable_holidays`
2066 my $sth = $dbh->prepare($query);
2067 $sth->execute($month,$day,$branchcode);
2068 my $countspecial=$sth->fetchrow ;
2070 return $countspecial;
2075 sub CheckValidBarcode{
2077 my $dbh = C4::Context->dbh;
2078 my $query=qq|SELECT count(*)
2082 my $sth = $dbh->prepare($query);
2083 $sth->execute($barcode);
2084 my $exist=$sth->fetchrow ;
2095 Koha Developement team <info@koha.org>