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->{'branchcode'};
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 # FIXME - If this function die()s, the script will abort, and the
574 # user won't get anything; depending on how far the script has
575 # gotten, the user might get a blank page. It would be much better
576 # to at least print an error message. The easiest way to do this
577 # is to set $SIG{__DIE__}.
579 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
584 $sth->execute($bibitem) || die $sth->errstr;
586 while ( my $data = $sth->fetchrow_hashref ) {
588 # Find out who currently has this item.
589 # FIXME - Wouldn't it be better to do this as a left join of
590 # some sort? Currently, this code assumes that if
591 # fetchrow_hashref() fails, then the book is on the shelf.
592 # fetchrow_hashref() can fail for any number of reasons (e.g.,
593 # database server crash), not just because no items match the
595 my $sth2 = $dbh->prepare(
596 "SELECT * FROM issues
597 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
599 AND returndate IS NULL
603 $sth2->execute( $data->{'itemnumber'} );
604 if ( my $data2 = $sth2->fetchrow_hashref ) {
605 $data->{'date_due'} = $data2->{'date_due'};
606 $data->{'card'} = $data2->{'cardnumber'};
607 $data->{'borrower'} = $data2->{'borrowernumber'};
610 if ( $data->{'wthdrawn'} eq '1' ) {
611 $data->{'date_due'} = 'Cancelled';
614 $data->{'date_due'} = 'Available';
620 # Find the last 3 people who borrowed this item.
621 $sth2 = $dbh->prepare(
622 "SELECT * FROM issues
623 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
625 AND returndate IS NOT NULL
626 ORDER BY returndate DESC,timestamp DESC"
629 $sth2->execute( $data->{'itemnumber'} );
630 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
631 { # FIXME : error if there is less than 3 pple borrowing this item
632 if ( my $data2 = $sth2->fetchrow_hashref ) {
633 $data->{"timestamp$i2"} = $data2->{'timestamp'};
634 $data->{"card$i2"} = $data2->{'cardnumber'};
635 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
640 $results[$i] = $data;
648 =head2 CanBookBeIssued
650 $issuingimpossible, $needsconfirmation =
651 CanBookBeIssued( $borrower, $barcode, $duedatespec, $inprocess );
652 C<$duedatespec> is a C4::Dates object.
653 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
657 sub CanBookBeIssued {
658 my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
659 my %needsconfirmation; # filled with problems that needs confirmations
660 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
661 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
662 my $issue = GetItemIssue($item->{itemnumber});
663 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
664 $item->{'itemtype'}=$biblioitem->{'itemtype'};
665 my $dbh = C4::Context->dbh;
668 # DUE DATE is OK ? -- should already have checked.
670 #$issuingimpossible{INVALID_DATE} = 1 unless ($duedate);
675 if ( $borrower->{flags}->{GNA} ) {
676 $issuingimpossible{GNA} = 1;
678 if ( $borrower->{flags}->{'LOST'} ) {
679 $issuingimpossible{CARD_LOST} = 1;
681 if ( $borrower->{flags}->{'DBARRED'} ) {
682 $issuingimpossible{DEBARRED} = 1;
684 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
685 $issuingimpossible{EXPIRED} = 1;
687 my @expirydate= split /-/,$borrower->{'dateexpiry'};
688 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
689 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
690 $issuingimpossible{EXPIRED} = 1;
699 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
700 if ( C4::Context->preference("IssuingInProcess") ) {
701 my $amountlimit = C4::Context->preference("noissuescharge");
702 if ( $amount > $amountlimit && !$inprocess ) {
703 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
705 elsif ( $amount <= $amountlimit && !$inprocess ) {
706 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
711 $needsconfirmation{DEBT} = $amount;
716 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
718 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
719 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
724 unless ( $item->{barcode} ) {
725 $issuingimpossible{UNKNOWN_BARCODE} = 1;
727 if ( $item->{'notforloan'}
728 && $item->{'notforloan'} > 0 )
730 $issuingimpossible{NOT_FOR_LOAN} = 1;
732 elsif ( !$item->{'notforloan'} ){
733 # we have to check itemtypes.notforloan also
734 if (C4::Context->preference('item-level_itypes')){
735 # this should probably be a subroutine
736 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
737 $sth->execute($item->{'itemtype'});
738 my $notforloan=$sth->fetchrow_hashref();
740 if ($notforloan->{'notforloan'} == 1){
741 $issuingimpossible{NOT_FOR_LOAN} = 1;
744 elsif ($biblioitem->{'notforloan'} == 1){
745 $issuingimpossible{NOT_FOR_LOAN} = 1;
748 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
750 $issuingimpossible{WTHDRAWN} = 1;
752 if ( $item->{'restricted'}
753 && $item->{'restricted'} == 1 )
755 $issuingimpossible{RESTRICTED} = 1;
757 if ( C4::Context->preference("IndependantBranches") ) {
758 my $userenv = C4::Context->userenv;
759 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
760 $issuingimpossible{NOTSAMEBRANCH} = 1
761 if ( $item->{C4::Context->preference("HomeOrHoldingbranch")} ne $userenv->{branch} );
766 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
768 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
771 # Already issued to current borrower. Ask whether the loan should
773 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
774 $borrower->{'borrowernumber'},
775 $item->{'itemnumber'}
777 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
778 $issuingimpossible{NO_MORE_RENEWALS} = 1;
781 $needsconfirmation{RENEW_ISSUE} = 1;
784 elsif ($issue->{borrowernumber}) {
786 # issued to someone else
787 my $currborinfo = GetMemberDetails( $issue->{borrowernumber} );
789 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
790 $needsconfirmation{ISSUED_TO_ANOTHER} =
791 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
794 # See if the item is on reserve.
795 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
797 my $resbor = $res->{'borrowernumber'};
798 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
801 # The item is on reserve and waiting, but has been
802 # reserved by some other patron.
803 my ( $resborrower, $flags ) =
804 GetMemberDetails( $resbor, 0 );
805 my $branches = GetBranches();
807 $branches->{ $res->{'branchcode'} }->{'branchname'};
808 $needsconfirmation{RESERVE_WAITING} =
809 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
811 # CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'}); Doesn't belong in a checking subroutine.
813 elsif ( $restype eq "Reserved" ) {
815 # The item is on reserve for someone else.
816 my ( $resborrower, $flags ) =
817 GetMemberDetails( $resbor, 0 );
818 my $branches = GetBranches();
820 $branches->{ $res->{'branchcode'} }->{'branchname'};
821 $needsconfirmation{RESERVED} =
822 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
825 if ( C4::Context->preference("LibraryName") eq "Horowhenua Library Trust" ) {
826 if ( $borrower->{'categorycode'} eq 'W' ) {
827 my %issuingimpossible;
828 return ( \%issuingimpossible, \%needsconfirmation );
830 return ( \%issuingimpossible, \%needsconfirmation );
833 return ( \%issuingimpossible, \%needsconfirmation );
839 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
841 &AddIssue($borrower,$barcode,$date)
845 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
847 =item C<$barcode> is the bar code of the book being issued.
849 =item C<$date> contains the max date of return. calculated if empty.
851 AddIssue does the following things :
852 - step 01: check that there is a borrowernumber & a barcode provided
853 - check for RENEWAL (book issued & being issued to the same patron)
854 - renewal YES = Calculate Charge & renew
856 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
858 - fill reserve if reserve to this patron
859 - cancel reserve or not, otherwise
860 * TRANSFERT PENDING ?
861 - complete the transfert
869 my ( $borrower, $barcode, $date, $cancelreserve ) = @_;
870 my $dbh = C4::Context->dbh;
871 my $barcodecheck=CheckValidBarcode($barcode);
872 if ($borrower and $barcode and $barcodecheck ne '0'){
873 # find which item we issue
874 my $item = GetItem('', $barcode);
878 # Get which branchcode we need
879 if (C4::Context->preference('CircControl') eq 'PickupLibary'){
880 $branch = C4::Context->userenv->{'branchcode'};
882 elsif (C4::Context->preference('CircControl') eq 'PatronLibary'){
883 $branch = $borrower->{'branchcode'};
887 $branch = $item->{'homebranch'};
890 # get actual issuing if there is one
891 my $actualissue = GetItemIssue( $item->{itemnumber});
893 # get biblioinformation for this item
894 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
897 # check if we just renew the issue.
899 if ( $actualissue->{borrowernumber} eq $borrower->{'borrowernumber'} ) {
901 $borrower->{'borrowernumber'},
902 $item->{'itemnumber'},
910 if ( $actualissue->{borrowernumber}) {
911 # This book is currently on loan, but not to the person
912 # who wants to borrow it now. mark it returned before issuing to the new borrower
915 C4::Context->userenv->{'branch'}
919 # See if the item is on reserve.
920 my ( $restype, $res ) =
921 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
923 my $resbor = $res->{'borrowernumber'};
924 if ( $resbor eq $borrower->{'borrowernumber'} ) {
926 # The item is reserved by the current patron
927 ModReserveFill($res);
929 elsif ( $restype eq "Waiting" ) {
932 # The item is on reserve and waiting, but has been
933 # reserved by some other patron.
934 my ( $resborrower, $flags ) = GetMemberDetails( $resbor, 0 );
935 my $branches = GetBranches();
937 $branches->{ $res->{'branchcode'} }->{'branchname'};
939 elsif ( $restype eq "Reserved" ) {
942 # The item is reserved by someone else.
943 my ( $resborrower, $flags ) =
944 GetMemberDetails( $resbor, 0 );
945 my $branches = GetBranches();
946 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
947 if ($cancelreserve) { # cancel reserves on this item
948 CancelReserve( 0, $res->{'itemnumber'},
949 $res->{'borrowernumber'} );
952 if ($cancelreserve) {
953 CancelReserve( $res->{'biblionumber'}, 0,
954 $res->{'borrowernumber'} );
957 # set waiting reserve to first in reserve queue as book isn't waiting now
959 $res->{'biblionumber'},
960 $res->{'borrowernumber'},
966 # Starting process for transfer job (checking transfert and validate it if we have one)
967 my ($datesent) = GetTransfers($item->{'itemnumber'});
969 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for lisibility of this case (maybe for stats ....)
972 "UPDATE branchtransfers
973 SET datearrived = now(),
975 comments = 'Forced branchtransfert'
976 WHERE itemnumber= ? AND datearrived IS NULL"
978 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
982 # Record in the database the fact that the book was issued.
986 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
993 my $itype=(C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ;
994 my $loanlength = GetLoanLength(
995 $borrower->{'categorycode'},
999 $datedue = time + ($loanlength) * 86400;
1000 my @datearr = localtime($datedue);
1001 $dateduef = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
1002 $dateduef=CheckValidDatedue($dateduef,$item->{'itemnumber'},C4::Context->userenv->{'branch'});
1004 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
1005 if ( C4::Context->preference('ReturnBeforeExpiry') && $dateduef->output('iso') gt $borrower->{dateexpiry} ) {
1006 $dateduef = C4::Dates->new($borrower->{dateexpiry},'iso');
1010 $borrower->{'borrowernumber'},
1011 $item->{'itemnumber'},
1012 strftime( "%Y-%m-%d", localtime ),$dateduef->output('iso'), C4::Context->userenv->{'branch'}
1015 $item->{'issues'}++;
1016 ModItem({ issues => $item->{'issues'},
1017 holdingbranch => C4::Context->userenv->{'branch'},
1019 datelastborrowed => C4::Dates->new()->output('iso'),
1020 onloan => $dateduef->output('iso'),
1021 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1022 ModDateLastSeen( $item->{'itemnumber'} );
1024 # If it costs to borrow this book, charge it to the patron's account.
1025 my ( $charge, $itemtype ) = GetIssuingCharges(
1026 $item->{'itemnumber'},
1027 $borrower->{'borrowernumber'}
1029 if ( $charge > 0 ) {
1031 $item->{'itemnumber'},
1032 $borrower->{'borrowernumber'}, $charge
1034 $item->{'charge'} = $charge;
1037 # Record the fact that this book was issued.
1039 C4::Context->userenv->{'branch'},
1041 '', $item->{'itemnumber'},
1042 $item->{'itemtype'}, $borrower->{'borrowernumber'}
1046 &logaction(C4::Context->userenv->{'number'},"CIRCULATION","ISSUE",$borrower->{'borrowernumber'},$biblio->{'biblionumber'})
1047 if C4::Context->preference("IssueLog");
1052 =head2 GetLoanLength
1054 Get loan length for an itemtype, a borrower type and a branch
1056 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1061 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1062 my $dbh = C4::Context->dbh;
1065 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1067 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1068 # try to find issuelength & return the 1st available.
1069 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1070 $sth->execute( $borrowertype, $itemtype, $branchcode );
1071 my $loanlength = $sth->fetchrow_hashref;
1072 return $loanlength->{issuelength}
1073 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1075 $sth->execute( $borrowertype, $itemtype, "*" );
1076 $loanlength = $sth->fetchrow_hashref;
1077 return $loanlength->{issuelength}
1078 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1080 $sth->execute( $borrowertype, "*", $branchcode );
1081 $loanlength = $sth->fetchrow_hashref;
1082 return $loanlength->{issuelength}
1083 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1085 $sth->execute( "*", $itemtype, $branchcode );
1086 $loanlength = $sth->fetchrow_hashref;
1087 return $loanlength->{issuelength}
1088 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1090 $sth->execute( $borrowertype, "*", "*" );
1091 $loanlength = $sth->fetchrow_hashref;
1092 return $loanlength->{issuelength}
1093 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1095 $sth->execute( "*", "*", $branchcode );
1096 $loanlength = $sth->fetchrow_hashref;
1097 return $loanlength->{issuelength}
1098 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1100 $sth->execute( "*", $itemtype, "*" );
1101 $loanlength = $sth->fetchrow_hashref;
1102 return $loanlength->{issuelength}
1103 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1105 $sth->execute( "*", "*", "*" );
1106 $loanlength = $sth->fetchrow_hashref;
1107 return $loanlength->{issuelength}
1108 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1110 # if no rule is set => 21 days (hardcoded)
1116 ($doreturn, $messages, $iteminformation, $borrower) =
1117 &AddReturn($barcode, $branch, $exemptfine);
1121 C<$barcode> is the bar code of the book being returned. C<$branch> is
1122 the code of the branch where the book is being returned. C<$exemptfine>
1123 indicates that overdue charges for the item will not be applied.
1125 C<&AddReturn> returns a list of four items:
1127 C<$doreturn> is true iff the return succeeded.
1129 C<$messages> is a reference-to-hash giving the reason for failure:
1135 No item with this barcode exists. The value is C<$barcode>.
1139 The book is not currently on loan. The value is C<$barcode>.
1141 =item C<IsPermanent>
1143 The book's home branch is a permanent collection. If you have borrowed
1144 this book, you are not allowed to return it. The value is the code for
1145 the book's home branch.
1149 This book has been withdrawn/cancelled. The value should be ignored.
1153 The item was reserved. The value is a reference-to-hash whose keys are
1154 fields from the reserves table of the Koha database, and
1155 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1156 either C<Waiting>, C<Reserved>, or 0.
1160 C<$borrower> is a reference-to-hash, giving information about the
1161 patron who last borrowed the book.
1166 my ( $barcode, $branch, $exemptfine ) = @_;
1167 my $dbh = C4::Context->dbh;
1171 my $validTransfert = 0;
1172 my $reserveDone = 0;
1174 # get information on item
1175 my $iteminformation = GetItemIssue( GetItemnumberFromBarcode($barcode));
1176 my $biblio = GetBiblioItemData($iteminformation->{'biblioitemnumber'});
1177 # use Data::Dumper;warn Data::Dumper::Dumper($iteminformation);
1178 unless ($iteminformation->{'itemnumber'} ) {
1179 $messages->{'BadBarcode'} = $barcode;
1183 if ( ( not $iteminformation->{borrowernumber} ) && $doreturn ) {
1184 $messages->{'NotIssued'} = $barcode;
1188 # check if the book is in a permanent collection....
1189 my $hbr = $iteminformation->{'homebranch'};
1190 my $branches = GetBranches();
1191 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
1192 $messages->{'IsPermanent'} = $hbr;
1195 # if independent branches are on and returning to different branch, refuse the return
1196 if ($hbr ne C4::Context->userenv->{'branch'} && C4::Context->preference("IndependantBranches")){
1197 $messages->{'Wrongbranch'} = 1;
1201 # check that the book has been cancelled
1202 if ( $iteminformation->{'wthdrawn'} ) {
1203 $messages->{'wthdrawn'} = 1;
1207 # new op dev : if the book returned in an other branch update the holding branch
1209 # update issues, thereby returning book (should push this out into another subroutine
1210 $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1212 # case of a return of document (deal with issues and holdingbranch)
1217 "UPDATE issues SET returndate = now() WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (returndate IS NULL)"
1219 $sth->execute( $borrower->{'borrowernumber'},
1220 $iteminformation->{'itemnumber'} );
1221 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right?
1224 # continue to deal with returns cases, but not only if we have an issue
1226 # the holdingbranch is updated if the document is returned in an other location .
1227 if ( $iteminformation->{'holdingbranch'} ne C4::Context->userenv->{'branch'} ) {
1228 UpdateHoldingbranch(C4::Context->userenv->{'branch'},$iteminformation->{'itemnumber'});
1229 # reload iteminformation holdingbranch with the userenv value
1230 $iteminformation->{'holdingbranch'} = C4::Context->userenv->{'branch'};
1232 ModDateLastSeen( $iteminformation->{'itemnumber'} );
1233 ModItem({ onloan => undef }, $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'});
1235 if ($iteminformation->{borrowernumber}){
1236 ($borrower) = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1238 # fix up the accounts.....
1239 if ( $iteminformation->{'itemlost'} ) {
1240 $messages->{'WasLost'} = 1;
1243 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1244 # check if we have a transfer for this document
1245 my ($datesent,$frombranch,$tobranch) = GetTransfers( $iteminformation->{'itemnumber'} );
1247 # if we have a transfer to do, we update the line of transfers with the datearrived
1249 if ( $tobranch eq C4::Context->userenv->{'branch'} ) {
1252 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1254 $sth->execute( $iteminformation->{'itemnumber'} );
1256 # 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'
1257 C4::Reserves::ModReserveStatus( $iteminformation->{'itemnumber'},'W' );
1260 $messages->{'WrongTransfer'} = $tobranch;
1261 $messages->{'WrongTransferItem'} = $iteminformation->{'itemnumber'};
1263 $validTransfert = 1;
1266 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1267 # fix up the accounts.....
1268 if ($iteminformation->{'itemlost'}) {
1269 FixAccountForLostAndReturned($iteminformation, $borrower);
1270 $messages->{'WasLost'} = 1;
1272 # fix up the overdues in accounts...
1273 FixOverduesOnReturn( $borrower->{'borrowernumber'},
1274 $iteminformation->{'itemnumber'}, $exemptfine );
1276 # find reserves.....
1277 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1278 my ( $resfound, $resrec ) =
1279 C4::Reserves::CheckReserves( $iteminformation->{'itemnumber'} );
1281 $resrec->{'ResFound'} = $resfound;
1282 $messages->{'ResFound'} = $resrec;
1287 # Record the fact that this book was returned.
1289 $branch, 'return', '0', '',
1290 $iteminformation->{'itemnumber'},
1291 $biblio->{'itemtype'},
1292 $borrower->{'borrowernumber'}
1295 &logaction(C4::Context->userenv->{'number'},"CIRCULATION","RETURN",$iteminformation->{borrowernumber},$iteminformation->{'biblionumber'})
1296 if C4::Context->preference("ReturnLog");
1298 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1299 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1301 if ( ($iteminformation->{'holdingbranch'} ne $iteminformation->{'homebranch'}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) and ($reserveDone ne 1) ){
1302 if (C4::Context->preference("AutomaticItemReturn") == 1) {
1303 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1304 $messages->{'WasTransfered'} = 1;
1307 $messages->{'NeedsTransfer'} = 1;
1311 return ( $doreturn, $messages, $iteminformation, $borrower );
1314 =head2 FixOverduesOnReturn
1316 &FixOverduesOnReturn($brn,$itm, $exemptfine);
1318 C<$brn> borrowernumber
1322 internal function, called only by AddReturn
1326 sub FixOverduesOnReturn {
1327 my ( $borrowernumber, $item, $exemptfine ) = @_;
1328 my $dbh = C4::Context->dbh;
1330 # check for overdue fine
1333 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1335 $sth->execute( $borrowernumber, $item );
1337 # alter fine to show that the book has been returned
1339 if ($data = $sth->fetchrow_hashref) {
1340 my $uquery =($exemptfine)? "update accountlines set accounttype='FFOR', amountoutstanding=0":"update accountlines set accounttype='F' ";
1341 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1342 my $usth = $dbh->prepare($uquery);
1343 $usth->execute($borrowernumber,$item ,$data->{'accountno'});
1351 =head2 FixAccountForLostAndReturned
1353 &FixAccountForLostAndReturned($iteminfo,$borrower);
1355 Calculates the charge for a book lost and returned (Not exported & used only once)
1357 C<$iteminfo> is a hashref to iteminfo. Only {itemnumber} is used.
1359 C<$borrower> is a hashref to borrower. Only {borrowernumber is used.
1361 Internal function, called by AddReturn
1365 sub FixAccountForLostAndReturned {
1366 my ($iteminfo, $borrower) = @_;
1368 my $dbh = C4::Context->dbh;
1369 my $itm = $iteminfo->{'itemnumber'};
1370 # check for charge made for lost book
1371 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1372 $sth->execute($itm);
1373 if (my $data = $sth->fetchrow_hashref) {
1374 # writeoff this amount
1376 my $amount = $data->{'amount'};
1377 my $acctno = $data->{'accountno'};
1379 if ($data->{'amountoutstanding'} == $amount) {
1380 $offset = $data->{'amount'};
1383 $offset = $amount - $data->{'amountoutstanding'};
1384 $amountleft = $data->{'amountoutstanding'} - $amount;
1386 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1387 WHERE (borrowernumber = ?)
1388 AND (itemnumber = ?) AND (accountno = ?) ");
1389 $usth->execute($data->{'borrowernumber'},$itm,$acctno);
1391 #check if any credit is left if so writeoff other accounts
1392 my $nextaccntno = getnextacctno(\%env,$data->{'borrowernumber'},$dbh);
1393 if ($amountleft < 0){
1396 if ($amountleft > 0){
1397 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1398 AND (amountoutstanding >0) ORDER BY date");
1399 $msth->execute($data->{'borrowernumber'});
1400 # offset transactions
1403 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1404 if ($accdata->{'amountoutstanding'} < $amountleft) {
1406 $amountleft -= $accdata->{'amountoutstanding'};
1408 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1411 my $thisacct = $accdata->{'accountno'};
1412 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1413 WHERE (borrowernumber = ?)
1414 AND (accountno=?)");
1415 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');
1417 $usth = $dbh->prepare("INSERT INTO accountoffsets
1418 (borrowernumber, accountno, offsetaccount, offsetamount)
1421 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1426 if ($amountleft > 0){
1429 my $desc="Item Returned ".$iteminfo->{'barcode'};
1430 $usth = $dbh->prepare("INSERT INTO accountlines
1431 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1432 VALUES (?,?,now(),?,?,'CR',?)");
1433 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1435 $usth = $dbh->prepare("INSERT INTO accountoffsets
1436 (borrowernumber, accountno, offsetaccount, offsetamount)
1438 $usth->execute($borrower->{'borrowernumber'},$data->{'accountno'},$nextaccntno,$offset);
1440 ModItem({ paidfor => '' }, undef, $itm);
1448 $issues = &GetItemIssue($itemnumber);
1450 Returns patrons currently having a book. nothing if item is not issued atm
1452 C<$itemnumber> is the itemnumber
1454 Returns an array of hashes
1459 my ( $itemnumber) = @_;
1460 return unless $itemnumber;
1461 my $dbh = C4::Context->dbh;
1465 my $today = POSIX::strftime("%Y%m%d", localtime);
1467 my $sth = $dbh->prepare(
1468 "SELECT * FROM issues
1469 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1471 issues.itemnumber=? AND returndate IS NULL ");
1472 $sth->execute($itemnumber);
1473 my $data = $sth->fetchrow_hashref;
1474 my $datedue = $data->{'date_due'};
1476 if ( $datedue < $today ) {
1477 $data->{'overdue'} = 1;
1479 $data->{'itemnumber'} = $itemnumber; # fill itemnumber, in case item is not on issue
1484 =head2 GetItemIssues
1486 $issues = &GetItemIssues($itemnumber, $history);
1488 Returns patrons that have issued a book
1490 C<$itemnumber> is the itemnumber
1491 C<$history> is 0 if you want actuel "issuer" (if it exist) and 1 if you want issues history
1493 Returns an array of hashes
1498 my ( $itemnumber,$history ) = @_;
1499 my $dbh = C4::Context->dbh;
1503 my $today = POSIX::strftime("%Y%m%d", localtime);
1505 my $sth = $dbh->prepare(
1506 "SELECT * FROM issues
1507 LEFT JOIN borrowers ON borrowers.borrowernumber
1508 LEFT JOIN items ON items.itemnumber=issues.itemnumber
1510 issues.itemnumber=?".($history?"":" AND returndate IS NULL ").
1511 "ORDER BY issues.date_due DESC"
1513 $sth->execute($itemnumber);
1514 while ( my $data = $sth->fetchrow_hashref ) {
1515 my $datedue = $data->{'date_due'};
1517 if ( $datedue < $today ) {
1518 $data->{'overdue'} = 1;
1520 my $itemnumber = $data->{'itemnumber'};
1521 push @GetItemIssues, $data;
1524 return ( \@GetItemIssues );
1527 =head2 GetBiblioIssues
1529 $issues = GetBiblioIssues($biblionumber);
1531 this function get all issues from a biblionumber.
1534 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1535 tables issues and the firstname,surname & cardnumber from borrowers.
1539 sub GetBiblioIssues {
1540 my $biblionumber = shift;
1541 return undef unless $biblionumber;
1542 my $dbh = C4::Context->dbh;
1544 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1546 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1547 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1548 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1549 LEFT JOIN biblio ON biblio.biblionumber = items.biblioitemnumber
1550 WHERE biblio.biblionumber = ?
1551 ORDER BY issues.timestamp
1553 my $sth = $dbh->prepare($query);
1554 $sth->execute($biblionumber);
1557 while ( my $data = $sth->fetchrow_hashref ) {
1558 push @issues, $data;
1563 =head2 CanBookBeRenewed
1565 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber);
1567 Find out whether a borrowed item may be renewed.
1569 C<$dbh> is a DBI handle to the Koha database.
1571 C<$borrowernumber> is the borrower number of the patron who currently
1572 has the item on loan.
1574 C<$itemnumber> is the number of the item to renew.
1576 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
1577 item must currently be on loan to the specified borrower; renewals
1578 must be allowed for the item's type; and the borrower must not have
1579 already renewed the loan. $error will contain the reason the renewal can not proceed
1583 sub CanBookBeRenewed {
1585 # check renewal status
1586 my ( $borrowernumber, $itemnumber ) = @_;
1587 my $dbh = C4::Context->dbh;
1592 # Look in the issues table for this item, lent to this borrower,
1593 # and not yet returned.
1595 # FIXME - I think this function could be redone to use only one SQL call.
1596 my $sth1 = $dbh->prepare(
1597 "SELECT * FROM issues
1598 WHERE borrowernumber = ?
1600 AND returndate IS NULL"
1602 $sth1->execute( $borrowernumber, $itemnumber );
1603 if ( my $data1 = $sth1->fetchrow_hashref ) {
1605 # Found a matching item
1607 # See if this item may be renewed. This query is convoluted
1608 # because it's a bit messy: given the item number, we need to find
1609 # the biblioitem, which gives us the itemtype, which tells us
1610 # whether it may be renewed.
1611 my $sth2 = $dbh->prepare(
1612 "SELECT renewalsallowed FROM items
1613 LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
1614 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype
1615 WHERE items.itemnumber = ?
1618 $sth2->execute($itemnumber);
1619 if ( my $data2 = $sth2->fetchrow_hashref ) {
1620 $renews = $data2->{'renewalsallowed'};
1622 if ( $renews && $renews >= $data1->{'renewals'} ) {
1629 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
1637 return ($renewokay,$error);
1642 &AddRenewal($borrowernumber, $itemnumber, $datedue);
1646 C<$borrowernumber> is the borrower number of the patron who currently
1649 C<$itemnumber> is the number of the item to renew.
1651 C<$datedue> can be used to set the due date. If C<$datedue> is the
1652 empty string, C<&AddRenewal> will calculate the due date automatically
1653 from the book's item type. If you wish to set the due date manually,
1654 C<$datedue> should be in the form YYYY-MM-DD.
1660 my ( $borrowernumber, $itemnumber, $branch ,$datedue ) = @_;
1661 my $dbh = C4::Context->dbh;
1663 my $biblio = GetBiblioFromItemNumber($itemnumber);
1664 # If the due date wasn't specified, calculate it by adding the
1665 # book's loan length to today's date.
1666 unless ( $datedue ) {
1669 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
1670 my $loanlength = GetLoanLength(
1671 $borrower->{'categorycode'},
1672 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
1673 $borrower->{'branchcode'}
1675 #FIXME -- choose issuer or borrower branch.
1676 #FIXME -- where's the calendar ?
1677 #FIXME -- $debug-ify the (0)
1678 my @darray = Add_Delta_DHMS( Today_and_Now(), $loanlength, 0, 0, 0 );
1679 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d",@darray[0..2]), 'iso');
1680 (0) and print STDERR "C4::Dates->new->output = " . C4::Dates->new()->output()
1681 . "\ndatedue->output = " . $datedue->output()
1682 . "\n(Y,M,D) = " . join ',', @darray;
1683 $datedue=CheckValidDatedue($datedue,$itemnumber,$branch);
1686 # Find the issues record for this book
1688 $dbh->prepare("SELECT * FROM issues
1689 WHERE borrowernumber=?
1691 AND returndate IS NULL"
1693 $sth->execute( $borrowernumber, $itemnumber );
1694 my $issuedata = $sth->fetchrow_hashref;
1697 # Update the issues record to have the new due date, and a new count
1698 # of how many times it has been renewed.
1699 my $renews = $issuedata->{'renewals'} + 1;
1700 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?
1701 WHERE borrowernumber=?
1703 AND returndate IS NULL"
1705 $sth->execute( $datedue->output('iso'), $renews, $borrowernumber, $itemnumber );
1708 # Update the renewal count on the item, and tell zebra to reindex
1709 $renews = $biblio->{'renewals'} + 1;
1710 ModItem({ renewals => $renews }, $biblio->{'biblionumber'}, $itemnumber);
1712 # Charge a new rental fee, if applicable?
1713 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
1714 if ( $charge > 0 ) {
1715 my $accountno = getnextacctno( $borrowernumber );
1716 my $item = GetBiblioFromItemNumber($itemnumber);
1717 $sth = $dbh->prepare(
1718 "INSERT INTO accountlines
1719 (borrowernumber,accountno,date,amount,
1720 description,accounttype,amountoutstanding,
1722 VALUES (?,?,now(),?,?,?,?,?)"
1724 $sth->execute( $borrowernumber, $accountno, $charge,
1725 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
1726 'Rent', $charge, $itemnumber );
1730 UpdateStats( $branch, 'renew', $charge, '', $itemnumber );
1734 # check renewal status
1735 my ($bornum,$itemno)=@_;
1736 my $dbh = C4::Context->dbh;
1738 my $renewsallowed = 0;
1740 # Look in the issues table for this item, lent to this borrower,
1741 # and not yet returned.
1743 # FIXME - I think this function could be redone to use only one SQL call.
1744 my $sth = $dbh->prepare("select * from issues
1745 where (borrowernumber = ?)
1746 and (itemnumber = ?)
1747 and returndate is null");
1748 $sth->execute($bornum,$itemno);
1749 my $data = $sth->fetchrow_hashref;
1750 $renewcount = $data->{'renewals'} if $data->{'renewals'};
1751 my $sth2 = $dbh->prepare("select renewalsallowed from items,biblioitems,itemtypes
1752 where (items.itemnumber = ?)
1753 and (items.biblioitemnumber = biblioitems.biblioitemnumber)
1754 and (biblioitems.itemtype = itemtypes.itemtype)");
1755 $sth2->execute($itemno);
1756 my $data2 = $sth2->fetchrow_hashref();
1757 $renewsallowed = $data2->{'renewalsallowed'};
1758 $renewsleft = $renewsallowed - $renewcount;
1759 # warn "Renewcount:$renewcount RenewsAll:$renewsallowed RenewLeft:$renewsleft";
1760 return ($renewcount,$renewsallowed,$renewsleft);
1762 =head2 GetIssuingCharges
1764 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
1766 Calculate how much it would cost for a given patron to borrow a given
1767 item, including any applicable discounts.
1769 C<$itemnumber> is the item number of item the patron wishes to borrow.
1771 C<$borrowernumber> is the patron's borrower number.
1773 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
1774 and C<$item_type> is the code for the item's item type (e.g., C<VID>
1779 sub GetIssuingCharges {
1781 # calculate charges due
1782 my ( $itemnumber, $borrowernumber ) = @_;
1784 my $dbh = C4::Context->dbh;
1787 # Get the book's item type and rental charge (via its biblioitem).
1788 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
1789 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
1790 $qcharge .= (C4::Context->preference('item-level_itypes'))
1791 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
1792 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
1794 $qcharge .= "WHERE items.itemnumber =?";
1796 my $sth1 = $dbh->prepare($qcharge);
1797 $sth1->execute($itemnumber);
1798 if ( my $data1 = $sth1->fetchrow_hashref ) {
1799 $item_type = $data1->{'itemtype'};
1800 $charge = $data1->{'rentalcharge'};
1801 my $q2 = "SELECT rentaldiscount FROM borrowers
1802 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
1803 WHERE borrowers.borrowernumber = ?
1804 AND issuingrules.itemtype = ?";
1805 my $sth2 = $dbh->prepare($q2);
1806 $sth2->execute( $borrowernumber, $item_type );
1807 if ( my $data2 = $sth2->fetchrow_hashref ) {
1808 my $discount = $data2->{'rentaldiscount'};
1809 if ( $discount eq 'NULL' ) {
1812 $charge = ( $charge * ( 100 - $discount ) ) / 100;
1818 return ( $charge, $item_type );
1821 =head2 AddIssuingCharge
1823 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
1827 sub AddIssuingCharge {
1828 my ( $itemnumber, $borrowernumber, $charge ) = @_;
1829 my $dbh = C4::Context->dbh;
1830 my $nextaccntno = getnextacctno( $borrowernumber );
1832 INSERT INTO accountlines
1833 (borrowernumber, itemnumber, accountno,
1834 date, amount, description, accounttype,
1836 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
1838 my $sth = $dbh->prepare($query);
1839 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
1845 GetTransfers($itemnumber);
1850 my ($itemnumber) = @_;
1852 my $dbh = C4::Context->dbh;
1858 FROM branchtransfers
1859 WHERE itemnumber = ?
1860 AND datearrived IS NULL
1862 my $sth = $dbh->prepare($query);
1863 $sth->execute($itemnumber);
1864 my @row = $sth->fetchrow_array();
1870 =head2 GetTransfersFromTo
1872 @results = GetTransfersFromTo($frombranch,$tobranch);
1874 Returns the list of pending transfers between $from and $to branch
1878 sub GetTransfersFromTo {
1879 my ( $frombranch, $tobranch ) = @_;
1880 return unless ( $frombranch && $tobranch );
1881 my $dbh = C4::Context->dbh;
1883 SELECT itemnumber,datesent,frombranch
1884 FROM branchtransfers
1887 AND datearrived IS NULL
1889 my $sth = $dbh->prepare($query);
1890 $sth->execute( $frombranch, $tobranch );
1893 while ( my $data = $sth->fetchrow_hashref ) {
1894 push @gettransfers, $data;
1897 return (@gettransfers);
1900 =head2 DeleteTransfer
1902 &DeleteTransfer($itemnumber);
1906 sub DeleteTransfer {
1907 my ($itemnumber) = @_;
1908 my $dbh = C4::Context->dbh;
1909 my $sth = $dbh->prepare(
1910 "DELETE FROM branchtransfers
1912 AND datearrived IS NULL "
1914 $sth->execute($itemnumber);
1918 =head2 AnonymiseIssueHistory
1920 $rows = AnonymiseIssueHistory($borrowernumber,$date)
1922 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
1923 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
1925 return the number of affected rows.
1929 sub AnonymiseIssueHistory {
1931 my $borrowernumber = shift;
1932 my $dbh = C4::Context->dbh;
1935 SET borrowernumber = NULL
1936 WHERE returndate < '".$date."'
1937 AND borrowernumber IS NOT NULL
1939 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
1940 my $rows_affected = $dbh->do($query);
1941 return $rows_affected;
1944 =head2 updateWrongTransfer
1946 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
1948 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
1952 sub updateWrongTransfer {
1953 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
1954 my $dbh = C4::Context->dbh;
1955 # first step validate the actual line of transfert .
1958 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
1960 $sth->execute($FromLibrary,$itemNumber);
1963 # second step create a new line of branchtransfer to the right location .
1964 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
1966 #third step changing holdingbranch of item
1967 UpdateHoldingbranch($FromLibrary,$itemNumber);
1970 =head2 UpdateHoldingbranch
1972 $items = UpdateHoldingbranch($branch,$itmenumber);
1973 Simple methode for updating hodlingbranch in items BDD line
1977 sub UpdateHoldingbranch {
1978 my ( $branch,$itemnumber ) = @_;
1979 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
1982 =head2 CheckValidDatedue
1984 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
1985 this function return a new date due after checked if it's a repeatable or special holiday
1986 C<$date_due> = returndate calculate with no day check
1987 C<$itemnumber> = itemnumber
1988 C<$branchcode> = localisation of issue
1992 # Why not create calendar object? -
1993 # TODO add 'duedate' option to useDaysMode .
1994 sub CheckValidDatedue {
1995 my ($date_due,$itemnumber,$branchcode)=@_;
1996 my @datedue=split('-',$date_due->output('iso'));
1997 my $years=$datedue[0];
1998 my $month=$datedue[1];
1999 my $day=$datedue[2];
2000 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2002 for (my $i=0;$i<2;$i++){
2003 $dow=Day_of_Week($years,$month,$day);
2004 ($dow=0) if ($dow>6);
2005 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2006 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2007 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2008 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2010 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2013 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2017 =head2 CheckRepeatableHolidays
2019 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2020 this function check if the date due is a repeatable holiday
2021 C<$date_due> = returndate calculate with no day check
2022 C<$itemnumber> = itemnumber
2023 C<$branchcode> = localisation of issue
2027 sub CheckRepeatableHolidays{
2028 my($itemnumber,$week_day,$branchcode)=@_;
2029 my $dbh = C4::Context->dbh;
2030 my $query = qq|SELECT count(*)
2031 FROM repeatable_holidays
2034 my $sth = $dbh->prepare($query);
2035 $sth->execute($branchcode,$week_day);
2036 my $result=$sth->fetchrow;
2042 =head2 CheckSpecialHolidays
2044 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2045 this function check if the date is a special holiday
2046 C<$years> = the years of datedue
2047 C<$month> = the month of datedue
2048 C<$day> = the day of datedue
2049 C<$itemnumber> = itemnumber
2050 C<$branchcode> = localisation of issue
2054 sub CheckSpecialHolidays{
2055 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2056 my $dbh = C4::Context->dbh;
2057 my $query=qq|SELECT count(*)
2058 FROM `special_holidays`
2064 my $sth = $dbh->prepare($query);
2065 $sth->execute($years,$month,$day,$branchcode);
2066 my $countspecial=$sth->fetchrow ;
2068 return $countspecial;
2071 =head2 CheckRepeatableSpecialHolidays
2073 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2074 this function check if the date is a repeatble special holidays
2075 C<$month> = the month of datedue
2076 C<$day> = the day of datedue
2077 C<$itemnumber> = itemnumber
2078 C<$branchcode> = localisation of issue
2082 sub CheckRepeatableSpecialHolidays{
2083 my ($month,$day,$itemnumber,$branchcode) = @_;
2084 my $dbh = C4::Context->dbh;
2085 my $query=qq|SELECT count(*)
2086 FROM `repeatable_holidays`
2091 my $sth = $dbh->prepare($query);
2092 $sth->execute($month,$day,$branchcode);
2093 my $countspecial=$sth->fetchrow ;
2095 return $countspecial;
2100 sub CheckValidBarcode{
2102 my $dbh = C4::Context->dbh;
2103 my $query=qq|SELECT count(*)
2107 my $sth = $dbh->prepare($query);
2108 $sth->execute($barcode);
2109 my $exist=$sth->fetchrow ;
2120 Koha Developement team <info@koha.org>