1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
22 #use warnings; # soon!
42 use POSIX qw(strftime);
43 use C4::Branch; # GetBranches
44 use C4::Log; # logaction
48 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
52 $VERSION = 3.02; # for version checking
55 # FIXME subs that should probably be elsewhere
61 # subs to deal with issuing a book
73 &GetBranchBorrowerCircRule
75 &AnonymiseIssueHistory
78 # subs to deal with returns
84 # subs to deal with transfers
96 C4::Circulation - Koha circulation module
104 The functions in this module deal with circulation, issues, and
105 returns, as well as general information about the library.
106 Also deals with stocktaking.
112 =head3 $str = &barcodedecode($barcode, [$filter]);
116 =item Generic filter function for barcode string.
117 Called on every circ if the System Pref itemBarcodeInputFilter is set.
118 Will do some manipulation of the barcode for systems that deliver a barcode
119 to circulation.pl that differs from the barcode stored for the item.
120 For proper functioning of this filter, calling the function on the
121 correct barcode string (items.barcode) should return an unaltered barcode.
123 The optional $filter argument is to allow for testing or explicit
124 behavior that ignores the System Pref. Valid values are the same as the
131 # FIXME -- the &decode fcn below should be wrapped into this one.
132 # FIXME -- these plugins should be moved out of Circulation.pm
135 my ($barcode, $filter) = @_;
136 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
137 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
138 if ($filter eq 'whitespace') {
140 } elsif ($filter eq 'cuecat') {
142 my @fields = split( /\./, $barcode );
143 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
144 ($#results == 2) and return $results[2];
145 } elsif ($filter eq 'T-prefix') {
146 if ($barcode =~ /^[Tt](\d)/) {
147 (defined($1) and $1 eq '0') and return $barcode;
148 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
150 return sprintf("T%07d", $barcode);
151 # FIXME: $barcode could be "T1", causing warning: substr outside of string
152 # Why drop the nonzero digit after the T?
153 # Why pass non-digits (or empty string) to "T%07d"?
155 return $barcode; # return barcode, modified or not
160 =head3 $str = &decode($chunk);
164 =item Decodes a segment of a string emitted by a CueCat barcode scanner and
167 FIXME: Should be replaced with Barcode::Cuecat from CPAN
168 or Javascript based decoding on the client side.
177 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
178 my @s = map { index( $seq, $_ ); } split( //, $encoded );
179 my $l = ( $#s + 1 ) % 4;
182 # warn "Error: Cuecat decode parsing failed!";
190 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
192 chr( ( $n >> 16 ) ^ 67 )
193 .chr( ( $n >> 8 & 255 ) ^ 67 )
194 .chr( ( $n & 255 ) ^ 67 );
197 $r = substr( $r, 0, length($r) - $l );
203 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch, $barcode, $ignore_reserves);
205 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
207 C<$newbranch> is the code for the branch to which the item should be transferred.
209 C<$barcode> is the barcode of the item to be transferred.
211 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
212 Otherwise, if an item is reserved, the transfer fails.
214 Returns three values:
218 is true if the transfer was successful.
222 is a reference-to-hash which may have any of the following keys:
228 There is no item in the catalog with the given barcode. The value is C<$barcode>.
232 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.
234 =item C<DestinationEqualsHolding>
236 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.
240 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.
244 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>.
246 =item C<WasTransferred>
248 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
255 my ( $tbr, $barcode, $ignoreRs ) = @_;
258 my $branches = GetBranches();
259 my $itemnumber = GetItemnumberFromBarcode( $barcode );
260 my $issue = GetItemIssue($itemnumber);
261 my $biblio = GetBiblioFromItemNumber($itemnumber);
264 if ( not $itemnumber ) {
265 $messages->{'BadBarcode'} = $barcode;
269 # get branches of book...
270 my $hbr = $biblio->{'homebranch'};
271 my $fbr = $biblio->{'holdingbranch'};
274 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
275 $messages->{'IsPermanent'} = $hbr;
278 # can't transfer book if is already there....
279 if ( $fbr eq $tbr ) {
280 $messages->{'DestinationEqualsHolding'} = 1;
284 # check if it is still issued to someone, return it...
285 if ($issue->{borrowernumber}) {
286 AddReturn( $barcode, $fbr );
287 $messages->{'WasReturned'} = $issue->{borrowernumber};
291 # That'll save a database query.
292 my ( $resfound, $resrec ) =
293 CheckReserves( $itemnumber );
294 if ( $resfound and not $ignoreRs ) {
295 $resrec->{'ResFound'} = $resfound;
297 # $messages->{'ResFound'} = $resrec;
301 #actually do the transfer....
303 ModItemTransfer( $itemnumber, $fbr, $tbr );
305 # don't need to update MARC anymore, we do it in batch now
306 $messages->{'WasTransfered'} = 1;
307 ModDateLastSeen( $itemnumber );
309 return ( $dotransfer, $messages, $biblio );
314 my $borrower = shift;
315 my $biblionumber = shift;
317 my $cat_borrower = $borrower->{'categorycode'};
318 my $dbh = C4::Context->dbh;
320 # Get which branchcode we need
321 if (C4::Context->preference('CircControl') eq 'PickupLibrary'){
322 $branch = C4::Context->userenv->{'branch'};
324 elsif (C4::Context->preference('CircControl') eq 'PatronLibrary'){
325 $branch = $borrower->{'branchcode'};
329 $branch = $item->{'homebranch'};
331 my $type = (C4::Context->preference('item-level_itypes'))
332 ? $item->{'itype'} # item-level
333 : $item->{'itemtype'}; # biblio-level
335 # given branch, patron category, and item type, determine
336 # applicable issuing rule
337 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
339 # if a rule is found and has a loan limit set, count
340 # how many loans the patron already has that meet that
342 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
344 my $count_query = "SELECT COUNT(*) FROM issues
345 JOIN items USING (itemnumber) ";
347 my $rule_itemtype = $issuing_rule->{itemtype};
348 if ($rule_itemtype eq "*") {
349 # matching rule has the default item type, so count only
350 # those existing loans that don't fall under a more
352 if (C4::Context->preference('item-level_itypes')) {
353 $count_query .= " WHERE items.itype NOT IN (
354 SELECT itemtype FROM issuingrules
356 AND (categorycode = ? OR categorycode = ?)
360 $count_query .= " JOIN biblioitems USING (biblionumber)
361 WHERE biblioitems.itemtype NOT IN (
362 SELECT itemtype FROM issuingrules
364 AND (categorycode = ? OR categorycode = ?)
368 push @bind_params, $issuing_rule->{branchcode};
369 push @bind_params, $issuing_rule->{categorycode};
370 push @bind_params, $cat_borrower;
372 # rule has specific item type, so count loans of that
374 if (C4::Context->preference('item-level_itypes')) {
375 $count_query .= " WHERE items.itype = ? ";
377 $count_query .= " JOIN biblioitems USING (biblionumber)
378 WHERE biblioitems.itemtype= ? ";
380 push @bind_params, $type;
383 $count_query .= " AND borrowernumber = ? ";
384 push @bind_params, $borrower->{'borrowernumber'};
385 my $rule_branch = $issuing_rule->{branchcode};
386 if ($rule_branch ne "*") {
387 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
388 $count_query .= " AND issues.branchcode = ? ";
389 push @bind_params, $branch;
390 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
391 ; # if branch is the patron's home branch, then count all loans by patron
393 $count_query .= " AND items.homebranch = ? ";
394 push @bind_params, $branch;
398 my $count_sth = $dbh->prepare($count_query);
399 $count_sth->execute(@bind_params);
400 my ($current_loan_count) = $count_sth->fetchrow_array;
402 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
403 if ($current_loan_count >= $max_loans_allowed) {
404 return "$current_loan_count / $max_loans_allowed";
408 # Now count total loans against the limit for the branch
409 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
410 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
411 my @bind_params = ();
412 my $branch_count_query = "SELECT COUNT(*) FROM issues
413 JOIN items USING (itemnumber)
414 WHERE borrowernumber = ? ";
415 push @bind_params, $borrower->{borrowernumber};
417 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
418 $branch_count_query .= " AND issues.branchcode = ? ";
419 push @bind_params, $branch;
420 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
421 ; # if branch is the patron's home branch, then count all loans by patron
423 $branch_count_query .= " AND items.homebranch = ? ";
424 push @bind_params, $branch;
426 my $branch_count_sth = $dbh->prepare($branch_count_query);
427 $branch_count_sth->execute(@bind_params);
428 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
430 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
431 if ($current_loan_count >= $max_loans_allowed) {
432 return "$current_loan_count / $max_loans_allowed";
436 # OK, the patron can issue !!!
442 @issues = &itemissues($biblioitemnumber, $biblio);
444 Looks up information about who has borrowed the bookZ<>(s) with the
445 given biblioitemnumber.
447 C<$biblio> is ignored.
449 C<&itemissues> returns an array of references-to-hash. The keys
450 include the fields from the C<items> table in the Koha database.
451 Additional keys include:
457 If the item is currently on loan, this gives the due date.
459 If the item is not on loan, then this is either "Available" or
460 "Cancelled", if the item has been withdrawn.
464 If the item is currently on loan, this gives the card number of the
465 patron who currently has the item.
467 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
469 These give the timestamp for the last three times the item was
472 =item C<card0>, C<card1>, C<card2>
474 The card number of the last three patrons who borrowed this item.
476 =item C<borrower0>, C<borrower1>, C<borrower2>
478 The borrower number of the last three patrons who borrowed this item.
486 my ( $bibitem, $biblio ) = @_;
487 my $dbh = C4::Context->dbh;
489 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
494 $sth->execute($bibitem) || die $sth->errstr;
496 while ( my $data = $sth->fetchrow_hashref ) {
498 # Find out who currently has this item.
499 # FIXME - Wouldn't it be better to do this as a left join of
500 # some sort? Currently, this code assumes that if
501 # fetchrow_hashref() fails, then the book is on the shelf.
502 # fetchrow_hashref() can fail for any number of reasons (e.g.,
503 # database server crash), not just because no items match the
505 my $sth2 = $dbh->prepare(
506 "SELECT * FROM issues
507 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
512 $sth2->execute( $data->{'itemnumber'} );
513 if ( my $data2 = $sth2->fetchrow_hashref ) {
514 $data->{'date_due'} = $data2->{'date_due'};
515 $data->{'card'} = $data2->{'cardnumber'};
516 $data->{'borrower'} = $data2->{'borrowernumber'};
519 $data->{'date_due'} = ($data->{'wthdrawn'} eq '1') ? 'Cancelled' : 'Available';
524 # Find the last 3 people who borrowed this item.
525 $sth2 = $dbh->prepare(
526 "SELECT * FROM old_issues
527 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
529 ORDER BY returndate DESC,timestamp DESC"
532 $sth2->execute( $data->{'itemnumber'} );
533 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
534 { # FIXME : error if there is less than 3 pple borrowing this item
535 if ( my $data2 = $sth2->fetchrow_hashref ) {
536 $data->{"timestamp$i2"} = $data2->{'timestamp'};
537 $data->{"card$i2"} = $data2->{'cardnumber'};
538 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
543 $results[$i] = $data;
551 =head2 CanBookBeIssued
553 Check if a book can be issued.
555 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower, $barcode, $duedatespec, $inprocess );
557 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
561 =item C<$borrower> hash with borrower informations (from GetMemberDetails)
563 =item C<$barcode> is the bar code of the book being issued.
565 =item C<$duedatespec> is a C4::Dates object.
575 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
576 Possible values are :
582 sticky due date is invalid
586 borrower gone with no address
590 borrower declared it's card lost
596 =head3 UNKNOWN_BARCODE
610 item is restricted (set by ??)
612 C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
613 Possible values are :
621 renewing, not issuing
623 =head3 ISSUED_TO_ANOTHER
625 issued to someone else.
629 reserved for someone else.
633 sticky due date is invalid
637 if the borrower borrows to much things
641 sub CanBookBeIssued {
642 my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
643 my %needsconfirmation; # filled with problems that needs confirmations
644 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
645 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
646 my $issue = GetItemIssue($item->{itemnumber});
647 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
648 $item->{'itemtype'}=$item->{'itype'};
649 my $dbh = C4::Context->dbh;
652 # DUE DATE is OK ? -- should already have checked.
654 #$issuingimpossible{INVALID_DATE} = 1 unless ($duedate);
659 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
660 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
661 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'});
662 return( { STATS => 1 }, {});
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 > 0 && $amount <= $amountlimit && !$inprocess ) {
695 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
700 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
704 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
705 if($blocktype == -1){
706 ## remaining overdue documents
707 $issuingimpossible{USERBLOCKEDREMAINING} = $count;
708 }elsif($blocktype == 1){
709 ## blocked because of overdue return
710 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
714 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
716 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
717 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
722 unless ( $item->{barcode} ) {
723 $issuingimpossible{UNKNOWN_BARCODE} = 1;
725 if ( $item->{'notforloan'}
726 && $item->{'notforloan'} > 0 )
728 if(C4::Context->preference("AllowNotForLoanOverride")){
729 $issuingimpossible{NOT_FOR_LOAN_CAN_FORCE} = 1;
731 $issuingimpossible{NOT_FOR_LOAN} = 1;
734 elsif ( !$item->{'notforloan'} ){
735 # we have to check itemtypes.notforloan also
736 if (C4::Context->preference('item-level_itypes')){
737 # this should probably be a subroutine
738 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
739 $sth->execute($item->{'itemtype'});
740 my $notforloan=$sth->fetchrow_hashref();
742 if ($notforloan->{'notforloan'} == 1){
743 $issuingimpossible{NOT_FOR_LOAN} = 1;
746 elsif ($biblioitem->{'notforloan'} == 1){
747 $issuingimpossible{NOT_FOR_LOAN} = 1;
750 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
752 $issuingimpossible{WTHDRAWN} = 1;
754 if ( $item->{'restricted'}
755 && $item->{'restricted'} == 1 )
757 $issuingimpossible{RESTRICTED} = 1;
759 if ( C4::Context->preference("IndependantBranches") ) {
760 my $userenv = C4::Context->userenv;
761 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
762 $issuingimpossible{NOTSAMEBRANCH} = 1
763 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
768 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
770 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
773 # Already issued to current borrower. Ask whether the loan should
775 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
776 $borrower->{'borrowernumber'},
777 $item->{'itemnumber'}
779 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
780 $issuingimpossible{NO_MORE_RENEWALS} = 1;
783 $needsconfirmation{RENEW_ISSUE} = 1;
786 elsif ($issue->{borrowernumber}) {
788 # issued to someone else
789 my $currborinfo = GetMemberDetails( $issue->{borrowernumber} );
791 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
792 $needsconfirmation{ISSUED_TO_ANOTHER} =
793 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
796 # See if the item is on reserve.
797 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
799 my $resbor = $res->{'borrowernumber'};
800 my ( $resborrower ) = C4::Members::GetMemberDetails( $resbor, 0 );
801 my $branches = GetBranches();
802 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
803 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
805 # The item is on reserve and waiting, but has been
806 # reserved by some other patron.
807 $needsconfirmation{RESERVE_WAITING} =
808 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
810 elsif ( $restype eq "Reserved" ) {
811 # The item is on reserve for someone else.
812 $needsconfirmation{RESERVED} =
813 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
816 if ( C4::Context->preference("LibraryName") eq "Horowhenua Library Trust" ) {
817 if ( $borrower->{'categorycode'} eq 'W' ) {
819 return ( \%emptyhash, \%needsconfirmation );
822 return ( \%issuingimpossible, \%needsconfirmation );
827 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
829 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
833 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
835 =item C<$barcode> is the barcode of the item being issued.
837 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
840 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
842 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
843 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
845 AddIssue does the following things :
846 - step 01: check that there is a borrowernumber & a barcode provided
847 - check for RENEWAL (book issued & being issued to the same patron)
848 - renewal YES = Calculate Charge & renew
850 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
852 - fill reserve if reserve to this patron
853 - cancel reserve or not, otherwise
854 * TRANSFERT PENDING ?
855 - complete the transfert
863 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
864 my $dbh = C4::Context->dbh;
865 my $barcodecheck=CheckValidBarcode($barcode);
867 # $issuedate defaults to today.
868 if ( ! defined $issuedate ) {
869 $issuedate = strftime( "%Y-%m-%d", localtime );
870 # TODO: for hourly circ, this will need to be a C4::Dates object
871 # and all calls to AddIssue including issuedate will need to pass a Dates object.
873 if ($borrower and $barcode and $barcodecheck ne '0'){
874 # find which item we issue
875 my $item = GetItem('', $barcode) or return undef; # if we don't get an Item, abort.
876 my $branch = (C4::Context->preference('CircControl') eq 'PickupLibrary') ? C4::Context->userenv->{'branch'} :
877 (C4::Context->preference('CircControl') eq 'PatronLibrary') ? $borrower->{'branchcode'} :
878 $item->{'homebranch'}; # fallback to item's homebranch
880 # get actual issuing if there is one
881 my $actualissue = GetItemIssue( $item->{itemnumber});
883 # get biblioinformation for this item
884 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
887 # check if we just renew the issue.
889 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
890 $datedue = AddRenewal(
891 $borrower->{'borrowernumber'},
892 $item->{'itemnumber'},
895 $issuedate, # here interpreted as the renewal date
900 if ( $actualissue->{borrowernumber}) {
901 # This book is currently on loan, but not to the person
902 # who wants to borrow it now. mark it returned before issuing to the new borrower
905 C4::Context->userenv->{'branch'}
909 # See if the item is on reserve.
910 my ( $restype, $res ) =
911 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
913 my $resbor = $res->{'borrowernumber'};
914 if ( $resbor eq $borrower->{'borrowernumber'} ) {
915 # The item is reserved by the current patron
916 ModReserveFill($res);
918 elsif ( $restype eq "Waiting" ) {
920 # The item is on reserve and waiting, but has been
921 # reserved by some other patron.
923 elsif ( $restype eq "Reserved" ) {
925 # The item is reserved by someone else.
926 if ($cancelreserve) { # cancel reserves on this item
927 CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
930 if ($cancelreserve) {
931 CancelReserve($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
934 # set waiting reserve to first in reserve queue as book isn't waiting now
936 $res->{'biblionumber'},
937 $res->{'borrowernumber'},
943 # Starting process for transfer job (checking transfert and validate it if we have one)
944 my ($datesent) = GetTransfers($item->{'itemnumber'});
946 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
949 "UPDATE branchtransfers
950 SET datearrived = now(),
952 comments = 'Forced branchtransfer'
953 WHERE itemnumber= ? AND datearrived IS NULL"
955 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
958 # Record in the database the fact that the book was issued.
962 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
966 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
967 my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
968 $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch );
970 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
971 if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
972 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
976 $borrower->{'borrowernumber'}, # borrowernumber
977 $item->{'itemnumber'}, # itemnumber
978 $issuedate, # issuedate
979 $datedue->output('iso'), # date_due
980 C4::Context->userenv->{'branch'} # branchcode
984 ModItem({ issues => $item->{'issues'},
985 holdingbranch => C4::Context->userenv->{'branch'},
987 datelastborrowed => C4::Dates->new()->output('iso'),
988 onloan => $datedue->output('iso'),
989 }, $item->{'biblionumber'}, $item->{'itemnumber'});
990 ModDateLastSeen( $item->{'itemnumber'} );
992 # If it costs to borrow this book, charge it to the patron's account.
993 my ( $charge, $itemtype ) = GetIssuingCharges(
994 $item->{'itemnumber'},
995 $borrower->{'borrowernumber'}
999 $item->{'itemnumber'},
1000 $borrower->{'borrowernumber'}, $charge
1002 $item->{'charge'} = $charge;
1005 # Record the fact that this book was issued.
1007 C4::Context->userenv->{'branch'},
1009 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1010 $item->{'itype'}, $borrower->{'borrowernumber'}
1014 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1015 if C4::Context->preference("IssueLog");
1017 return ($datedue); # not necessarily the same as when it came in!
1020 =head2 GetLoanLength
1022 Get loan length for an itemtype, a borrower type and a branch
1024 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1029 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1030 my $dbh = C4::Context->dbh;
1033 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1035 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1036 # try to find issuelength & return the 1st available.
1037 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1038 $sth->execute( $borrowertype, $itemtype, $branchcode );
1039 my $loanlength = $sth->fetchrow_hashref;
1040 return $loanlength->{issuelength}
1041 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1043 $sth->execute( $borrowertype, "*", $branchcode );
1044 $loanlength = $sth->fetchrow_hashref;
1045 return $loanlength->{issuelength}
1046 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1048 $sth->execute( "*", $itemtype, $branchcode );
1049 $loanlength = $sth->fetchrow_hashref;
1050 return $loanlength->{issuelength}
1051 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1053 $sth->execute( "*", "*", $branchcode );
1054 $loanlength = $sth->fetchrow_hashref;
1055 return $loanlength->{issuelength}
1056 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1058 $sth->execute( $borrowertype, $itemtype, "*" );
1059 $loanlength = $sth->fetchrow_hashref;
1060 return $loanlength->{issuelength}
1061 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1063 $sth->execute( $borrowertype, "*", "*" );
1064 $loanlength = $sth->fetchrow_hashref;
1065 return $loanlength->{issuelength}
1066 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1068 $sth->execute( "*", $itemtype, "*" );
1069 $loanlength = $sth->fetchrow_hashref;
1070 return $loanlength->{issuelength}
1071 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1073 $sth->execute( "*", "*", "*" );
1074 $loanlength = $sth->fetchrow_hashref;
1075 return $loanlength->{issuelength}
1076 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1078 # if no rule is set => 21 days (hardcoded)
1082 =head2 GetIssuingRule
1084 FIXME - This is a copy-paste of GetLoanLength
1085 as a stop-gap. Do not wish to change API for GetLoanLength
1086 this close to release, however, Overdues::GetIssuingRules is broken.
1088 Get the issuing rule for an itemtype, a borrower type and a branch
1089 Returns a hashref from the issuingrules table.
1091 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1095 sub GetIssuingRule {
1096 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1097 my $dbh = C4::Context->dbh;
1098 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1101 $sth->execute( $borrowertype, $itemtype, $branchcode );
1102 $irule = $sth->fetchrow_hashref;
1103 return $irule if defined($irule) ;
1105 $sth->execute( $borrowertype, "*", $branchcode );
1106 $irule = $sth->fetchrow_hashref;
1107 return $irule if defined($irule) ;
1109 $sth->execute( "*", $itemtype, $branchcode );
1110 $irule = $sth->fetchrow_hashref;
1111 return $irule if defined($irule) ;
1113 $sth->execute( "*", "*", $branchcode );
1114 $irule = $sth->fetchrow_hashref;
1115 return $irule if defined($irule) ;
1117 $sth->execute( $borrowertype, $itemtype, "*" );
1118 $irule = $sth->fetchrow_hashref;
1119 return $irule if defined($irule) ;
1121 $sth->execute( $borrowertype, "*", "*" );
1122 $irule = $sth->fetchrow_hashref;
1123 return $irule if defined($irule) ;
1125 $sth->execute( "*", $itemtype, "*" );
1126 $irule = $sth->fetchrow_hashref;
1127 return $irule if defined($irule) ;
1129 $sth->execute( "*", "*", "*" );
1130 $irule = $sth->fetchrow_hashref;
1131 return $irule if defined($irule) ;
1133 # if no rule matches,
1137 =head2 GetBranchBorrowerCircRule
1141 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1145 Retrieves circulation rule attributes that apply to the given
1146 branch and patron category, regardless of item type.
1147 The return value is a hashref containing the following key:
1149 maxissueqty - maximum number of loans that a
1150 patron of the given category can have at the given
1151 branch. If the value is undef, no limit.
1153 This will first check for a specific branch and
1154 category match from branch_borrower_circ_rules.
1156 If no rule is found, it will then check default_branch_circ_rules
1157 (same branch, default category). If no rule is found,
1158 it will then check default_borrower_circ_rules (default
1159 branch, same category), then failing that, default_circ_rules
1160 (default branch, default category).
1162 If no rule has been found in the database, it will default to
1167 C<$branchcode> and C<$categorycode> should contain the
1168 literal branch code and patron category code, respectively - no
1173 sub GetBranchBorrowerCircRule {
1174 my $branchcode = shift;
1175 my $categorycode = shift;
1177 my $branch_cat_query = "SELECT maxissueqty
1178 FROM branch_borrower_circ_rules
1179 WHERE branchcode = ?
1180 AND categorycode = ?";
1181 my $dbh = C4::Context->dbh();
1182 my $sth = $dbh->prepare($branch_cat_query);
1183 $sth->execute($branchcode, $categorycode);
1185 if ($result = $sth->fetchrow_hashref()) {
1189 # try same branch, default borrower category
1190 my $branch_query = "SELECT maxissueqty
1191 FROM default_branch_circ_rules
1192 WHERE branchcode = ?";
1193 $sth = $dbh->prepare($branch_query);
1194 $sth->execute($branchcode);
1195 if ($result = $sth->fetchrow_hashref()) {
1199 # try default branch, same borrower category
1200 my $category_query = "SELECT maxissueqty
1201 FROM default_borrower_circ_rules
1202 WHERE categorycode = ?";
1203 $sth = $dbh->prepare($category_query);
1204 $sth->execute($categorycode);
1205 if ($result = $sth->fetchrow_hashref()) {
1209 # try default branch, default borrower category
1210 my $default_query = "SELECT maxissueqty
1211 FROM default_circ_rules";
1212 $sth = $dbh->prepare($default_query);
1214 if ($result = $sth->fetchrow_hashref()) {
1218 # built-in default circulation rule
1220 maxissueqty => undef,
1226 ($doreturn, $messages, $iteminformation, $borrower) =
1227 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1233 =item C<$barcode> is the bar code of the book being returned.
1235 =item C<$branch> is the code of the branch where the book is being returned.
1237 =item C<$exemptfine> indicates that overdue charges for the item will be
1240 =item C<$dropbox> indicates that the check-in date is assumed to be
1241 yesterday, or the last non-holiday as defined in C4::Calendar . If
1242 overdue charges are applied and C<$dropbox> is true, the last charge
1243 will be removed. This assumes that the fines accrual script has run
1248 C<&AddReturn> returns a list of four items:
1250 C<$doreturn> is true iff the return succeeded.
1252 C<$messages> is a reference-to-hash giving the reason for failure:
1258 No item with this barcode exists. The value is C<$barcode>.
1262 The book is not currently on loan. The value is C<$barcode>.
1264 =item C<IsPermanent>
1266 The book's home branch is a permanent collection. If you have borrowed
1267 this book, you are not allowed to return it. The value is the code for
1268 the book's home branch.
1272 This book has been withdrawn/cancelled. The value should be ignored.
1276 The item was reserved. The value is a reference-to-hash whose keys are
1277 fields from the reserves table of the Koha database, and
1278 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1279 either C<Waiting>, C<Reserved>, or 0.
1283 C<$borrower> is a reference-to-hash, giving information about the
1284 patron who last borrowed the book.
1289 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1290 my $dbh = C4::Context->dbh;
1294 my $validTransfert = 0;
1295 my $reserveDone = 0;
1297 # get information on item
1298 my $iteminformation = GetItemIssue( GetItemnumberFromBarcode($barcode));
1299 my $biblio = GetBiblioItemData($iteminformation->{'biblioitemnumber'});
1300 # use Data::Dumper;warn Data::Dumper::Dumper($iteminformation);
1301 unless ($iteminformation->{'itemnumber'} ) {
1302 $messages->{'BadBarcode'} = $barcode;
1306 if ( ( not $iteminformation->{borrowernumber} ) && $doreturn ) {
1307 $messages->{'NotIssued'} = $barcode;
1308 # even though item is not on loan, it may still
1309 # be transferred; therefore, get current branch information
1310 my $curr_iteminfo = GetItem($iteminformation->{'itemnumber'});
1311 $iteminformation->{'homebranch'} = $curr_iteminfo->{'homebranch'};
1312 $iteminformation->{'holdingbranch'} = $curr_iteminfo->{'holdingbranch'};
1316 # check if the book is in a permanent collection....
1317 my $hbr = $iteminformation->{C4::Context->preference("HomeOrHoldingBranch")};
1318 my $branches = GetBranches();
1319 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1320 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
1321 $messages->{'IsPermanent'} = $hbr;
1324 # if independent branches are on and returning to different branch, refuse the return
1325 if ($hbr ne C4::Context->userenv->{'branch'} && C4::Context->preference("IndependantBranches")){
1326 $messages->{'Wrongbranch'} = 1;
1330 # check that the book has been cancelled
1331 if ( $iteminformation->{'wthdrawn'} ) {
1332 $messages->{'wthdrawn'} = 1;
1336 # new op dev : if the book returned in an other branch update the holding branch
1338 # update issues, thereby returning book (should push this out into another subroutine
1339 $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1341 # case of a return of document (deal with issues and holdingbranch)
1344 my $circControlBranch;
1346 # don't allow dropbox mode to create an invalid entry in issues (issuedate > returndate) FIXME: actually checks eq, not gt
1347 undef($dropbox) if ( $iteminformation->{'issuedate'} eq C4::Dates->today('iso') );
1348 if (C4::Context->preference('CircControl') eq 'ItemHomeBranch' ) {
1349 $circControlBranch = $iteminformation->{homebranch};
1350 } elsif ( C4::Context->preference('CircControl') eq 'PatronLibrary') {
1351 $circControlBranch = $borrower->{branchcode};
1352 } else { # CircControl must be PickupLibrary.
1353 $circControlBranch = $iteminformation->{holdingbranch};
1354 # FIXME - is this right ? are we sure that the holdingbranch is still the pickup branch?
1357 MarkIssueReturned($borrower->{'borrowernumber'}, $iteminformation->{'itemnumber'},$circControlBranch);
1358 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right?
1359 # continue to deal with returns cases, but not only if we have an issue
1361 # the holdingbranch is updated if the document is returned in an other location .
1362 if ( $iteminformation->{'holdingbranch'} ne C4::Context->userenv->{'branch'} ) {
1363 UpdateHoldingbranch(C4::Context->userenv->{'branch'},$iteminformation->{'itemnumber'});
1364 # reload iteminformation holdingbranch with the userenv value
1365 $iteminformation->{'holdingbranch'} = C4::Context->userenv->{'branch'};
1367 ModDateLastSeen( $iteminformation->{'itemnumber'} );
1368 ModItem({ onloan => undef }, $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'});
1370 if ($iteminformation->{borrowernumber}){
1371 ($borrower) = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1374 # fix up the accounts.....
1375 if ( $iteminformation->{'itemlost'} ) {
1376 $messages->{'WasLost'} = 1;
1379 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1380 # check if we have a transfer for this document
1381 my ($datesent,$frombranch,$tobranch) = GetTransfers( $iteminformation->{'itemnumber'} );
1383 # if we have a transfer to do, we update the line of transfers with the datearrived
1385 if ( $tobranch eq C4::Context->userenv->{'branch'} ) {
1388 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1390 $sth->execute( $iteminformation->{'itemnumber'} );
1392 # 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'
1393 C4::Reserves::ModReserveStatus( $iteminformation->{'itemnumber'},'W' );
1396 $messages->{'WrongTransfer'} = $tobranch;
1397 $messages->{'WrongTransferItem'} = $iteminformation->{'itemnumber'};
1399 $validTransfert = 1;
1402 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1403 # fix up the accounts.....
1404 if ($iteminformation->{'itemlost'}) {
1405 FixAccountForLostAndReturned($iteminformation, $borrower);
1406 $messages->{'WasLost'} = 1;
1408 # fix up the overdues in accounts...
1409 FixOverduesOnReturn( $borrower->{'borrowernumber'},
1410 $iteminformation->{'itemnumber'}, $exemptfine, $dropbox );
1412 # find reserves.....
1413 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1414 my ( $resfound, $resrec ) =
1415 C4::Reserves::CheckReserves( $iteminformation->{'itemnumber'} );
1417 $resrec->{'ResFound'} = $resfound;
1418 $messages->{'ResFound'} = $resrec;
1423 # Record the fact that this book was returned.
1425 $branch, 'return', '0', '',
1426 $iteminformation->{'itemnumber'},
1427 $biblio->{'itemtype'},
1428 $borrower->{'borrowernumber'}
1431 logaction("CIRCULATION", "RETURN", $iteminformation->{borrowernumber}, $iteminformation->{'biblionumber'})
1432 if C4::Context->preference("ReturnLog");
1434 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1435 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1437 if ($doreturn and ($iteminformation->{'holdingbranch'} ne $iteminformation->{'homebranch'}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) and ($reserveDone ne 1) ){
1438 if (C4::Context->preference("AutomaticItemReturn") == 1) {
1439 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1440 $messages->{'WasTransfered'} = 1;
1443 $messages->{'NeedsTransfer'} = 1;
1447 return ( $doreturn, $messages, $iteminformation, $borrower );
1450 =head2 MarkIssueReturned
1454 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate);
1458 Unconditionally marks an issue as being returned by
1459 moving the C<issues> row to C<old_issues> and
1460 setting C<returndate> to the current date, or
1461 the last non-holiday date of the branccode specified in
1462 C<dropbox_branch> . Assumes you've already checked that
1463 it's safe to do this, i.e. last non-holiday > issuedate.
1465 if C<$returndate> is specified (in iso format), it is used as the date
1466 of the return. It is ignored when a dropbox_branch is passed in.
1468 Ideally, this function would be internal to C<C4::Circulation>,
1469 not exported, but it is currently needed by one
1470 routine in C<C4::Accounts>.
1474 sub MarkIssueReturned {
1475 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate ) = @_;
1476 my $dbh = C4::Context->dbh;
1477 my $query = "UPDATE issues SET returndate=";
1479 if ($dropbox_branch) {
1480 my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1481 my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1483 push @bind, $dropboxdate->output('iso');
1484 } elsif ($returndate) {
1486 push @bind, $returndate;
1488 $query .= " now() ";
1490 $query .= " WHERE borrowernumber = ? AND itemnumber = ?";
1491 push @bind, $borrowernumber, $itemnumber;
1493 my $sth_upd = $dbh->prepare($query);
1494 $sth_upd->execute(@bind);
1495 my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1496 WHERE borrowernumber = ?
1497 AND itemnumber = ?");
1498 $sth_copy->execute($borrowernumber, $itemnumber);
1499 my $sth_del = $dbh->prepare("DELETE FROM issues
1500 WHERE borrowernumber = ?
1501 AND itemnumber = ?");
1502 $sth_del->execute($borrowernumber, $itemnumber);
1505 =head2 FixOverduesOnReturn
1507 &FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1509 C<$brn> borrowernumber
1513 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1514 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1516 internal function, called only by AddReturn
1520 sub FixOverduesOnReturn {
1521 my ( $borrowernumber, $item, $exemptfine, $dropbox ) = @_;
1522 my $dbh = C4::Context->dbh;
1524 # check for overdue fine
1527 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1529 $sth->execute( $borrowernumber, $item );
1531 # alter fine to show that the book has been returned
1533 if ($data = $sth->fetchrow_hashref) {
1535 my @bind = ($borrowernumber,$item ,$data->{'accountno'});
1537 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1538 if (C4::Context->preference("FinesLog")) {
1539 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1541 } elsif ($dropbox && $data->{lastincrement}) {
1542 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1543 my $amt = $data->{amount} - $data->{lastincrement} ;
1544 if (C4::Context->preference("FinesLog")) {
1545 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1547 $uquery = "update accountlines set accounttype='F' ";
1548 if($outstanding >= 0 && $amt >=0) {
1549 $uquery .= ", amount = ? , amountoutstanding=? ";
1550 unshift @bind, ($amt, $outstanding) ;
1553 $uquery = "update accountlines set accounttype='F' ";
1555 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1556 my $usth = $dbh->prepare($uquery);
1557 $usth->execute(@bind);
1565 =head2 FixAccountForLostAndReturned
1567 &FixAccountForLostAndReturned($iteminfo,$borrower);
1569 Calculates the charge for a book lost and returned (Not exported & used only once)
1571 C<$iteminfo> is a hashref to iteminfo. Only {itemnumber} is used.
1573 C<$borrower> is a hashref to borrower. Only {borrowernumber is used.
1575 Internal function, called by AddReturn
1579 sub FixAccountForLostAndReturned {
1580 my ($iteminfo, $borrower) = @_;
1581 my $dbh = C4::Context->dbh;
1582 my $itm = $iteminfo->{'itemnumber'};
1583 # check for charge made for lost book
1584 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1585 $sth->execute($itm);
1586 if (my $data = $sth->fetchrow_hashref) {
1587 # writeoff this amount
1589 my $amount = $data->{'amount'};
1590 my $acctno = $data->{'accountno'};
1592 if ($data->{'amountoutstanding'} == $amount) {
1593 $offset = $data->{'amount'};
1596 $offset = $amount - $data->{'amountoutstanding'};
1597 $amountleft = $data->{'amountoutstanding'} - $amount;
1599 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1600 WHERE (borrowernumber = ?)
1601 AND (itemnumber = ?) AND (accountno = ?) ");
1602 $usth->execute($data->{'borrowernumber'},$itm,$acctno);
1604 #check if any credit is left if so writeoff other accounts
1605 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1606 if ($amountleft < 0){
1609 if ($amountleft > 0){
1610 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1611 AND (amountoutstanding >0) ORDER BY date");
1612 $msth->execute($data->{'borrowernumber'});
1613 # offset transactions
1616 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1617 if ($accdata->{'amountoutstanding'} < $amountleft) {
1619 $amountleft -= $accdata->{'amountoutstanding'};
1621 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1624 my $thisacct = $accdata->{'accountno'};
1625 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1626 WHERE (borrowernumber = ?)
1627 AND (accountno=?)");
1628 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');
1630 $usth = $dbh->prepare("INSERT INTO accountoffsets
1631 (borrowernumber, accountno, offsetaccount, offsetamount)
1634 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1639 if ($amountleft > 0){
1642 my $desc="Item Returned ".$iteminfo->{'barcode'};
1643 $usth = $dbh->prepare("INSERT INTO accountlines
1644 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1645 VALUES (?,?,now(),?,?,'CR',?)");
1646 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1648 $usth = $dbh->prepare("INSERT INTO accountoffsets
1649 (borrowernumber, accountno, offsetaccount, offsetamount)
1651 $usth->execute($borrower->{'borrowernumber'},$data->{'accountno'},$nextaccntno,$offset);
1653 ModItem({ paidfor => '' }, undef, $itm);
1661 $issues = &GetItemIssue($itemnumber);
1663 Returns patrons currently having a book. nothing if item is not issued atm
1665 C<$itemnumber> is the itemnumber
1667 Returns an array of hashes
1669 FIXME: Though the above says that this function returns nothing if the
1670 item is not issued, this actually returns a hasref that looks like
1681 my ( $itemnumber) = @_;
1682 return unless $itemnumber;
1683 my $dbh = C4::Context->dbh;
1687 my $today = POSIX::strftime("%Y%m%d", localtime);
1689 my $sth = $dbh->prepare(
1690 "SELECT * FROM issues
1691 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1693 issues.itemnumber=?");
1694 $sth->execute($itemnumber);
1695 my $data = $sth->fetchrow_hashref;
1696 my $datedue = $data->{'date_due'};
1698 if ( $datedue < $today ) {
1699 $data->{'overdue'} = 1;
1701 $data->{'itemnumber'} = $itemnumber; # fill itemnumber, in case item is not on issue
1706 =head2 GetItemIssues
1708 $issues = &GetItemIssues($itemnumber, $history);
1710 Returns patrons that have issued a book
1712 C<$itemnumber> is the itemnumber
1713 C<$history> is 0 if you want actuel "issuer" (if it exist) and 1 if you want issues history
1715 Returns an array of hashes
1720 my ( $itemnumber,$history ) = @_;
1721 my $dbh = C4::Context->dbh;
1725 my $today = POSIX::strftime("%Y%m%d", localtime);
1727 my $sql = "SELECT * FROM issues
1728 JOIN borrowers USING (borrowernumber)
1729 JOIN items USING (itemnumber)
1730 WHERE issues.itemnumber = ? ";
1733 SELECT * FROM old_issues
1734 LEFT JOIN borrowers USING (borrowernumber)
1735 JOIN items USING (itemnumber)
1736 WHERE old_issues.itemnumber = ? ";
1738 $sql .= "ORDER BY date_due DESC";
1739 my $sth = $dbh->prepare($sql);
1741 $sth->execute($itemnumber, $itemnumber);
1743 $sth->execute($itemnumber);
1745 while ( my $data = $sth->fetchrow_hashref ) {
1746 my $datedue = $data->{'date_due'};
1748 if ( $datedue < $today ) {
1749 $data->{'overdue'} = 1;
1751 my $itemnumber = $data->{'itemnumber'};
1752 push @GetItemIssues, $data;
1755 return ( \@GetItemIssues );
1758 =head2 GetBiblioIssues
1760 $issues = GetBiblioIssues($biblionumber);
1762 this function get all issues from a biblionumber.
1765 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1766 tables issues and the firstname,surname & cardnumber from borrowers.
1770 sub GetBiblioIssues {
1771 my $biblionumber = shift;
1772 return undef unless $biblionumber;
1773 my $dbh = C4::Context->dbh;
1775 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1777 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1778 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1779 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1780 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1781 WHERE biblio.biblionumber = ?
1783 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1785 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1786 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1787 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1788 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1789 WHERE biblio.biblionumber = ?
1792 my $sth = $dbh->prepare($query);
1793 $sth->execute($biblionumber, $biblionumber);
1796 while ( my $data = $sth->fetchrow_hashref ) {
1797 push @issues, $data;
1802 =head2 GetUpcomingDueIssues
1806 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
1812 sub GetUpcomingDueIssues {
1815 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
1816 my $dbh = C4::Context->dbh;
1818 my $statement = <<END_SQL;
1819 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
1821 LEFT JOIN items USING (itemnumber)
1822 WhERE returndate is NULL
1823 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
1826 my @bind_parameters = ( $params->{'days_in_advance'} );
1828 my $sth = $dbh->prepare( $statement );
1829 $sth->execute( @bind_parameters );
1830 my $upcoming_dues = $sth->fetchall_arrayref({});
1833 return $upcoming_dues;
1836 =head2 CanBookBeRenewed
1838 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
1840 Find out whether a borrowed item may be renewed.
1842 C<$dbh> is a DBI handle to the Koha database.
1844 C<$borrowernumber> is the borrower number of the patron who currently
1845 has the item on loan.
1847 C<$itemnumber> is the number of the item to renew.
1849 C<$override_limit>, if supplied with a true value, causes
1850 the limit on the number of times that the loan can be renewed
1851 (as controlled by the item type) to be ignored.
1853 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
1854 item must currently be on loan to the specified borrower; renewals
1855 must be allowed for the item's type; and the borrower must not have
1856 already renewed the loan. $error will contain the reason the renewal can not proceed
1860 sub CanBookBeRenewed {
1862 # check renewal status
1863 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
1864 my $dbh = C4::Context->dbh;
1869 # Look in the issues table for this item, lent to this borrower,
1870 # and not yet returned.
1872 # FIXME - I think this function could be redone to use only one SQL call.
1873 my $sth1 = $dbh->prepare(
1874 "SELECT * FROM issues
1875 WHERE borrowernumber = ?
1878 $sth1->execute( $borrowernumber, $itemnumber );
1879 if ( my $data1 = $sth1->fetchrow_hashref ) {
1881 # Found a matching item
1883 # See if this item may be renewed. This query is convoluted
1884 # because it's a bit messy: given the item number, we need to find
1885 # the biblioitem, which gives us the itemtype, which tells us
1886 # whether it may be renewed.
1887 my $query = "SELECT renewalsallowed FROM items ";
1888 $query .= (C4::Context->preference('item-level_itypes'))
1889 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
1890 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
1891 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
1892 $query .= "WHERE items.itemnumber = ?";
1893 my $sth2 = $dbh->prepare($query);
1894 $sth2->execute($itemnumber);
1895 if ( my $data2 = $sth2->fetchrow_hashref ) {
1896 $renews = $data2->{'renewalsallowed'};
1898 if ( ( $renews && $renews > $data1->{'renewals'} ) || $override_limit ) {
1905 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
1913 return ($renewokay,$error);
1918 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
1922 C<$borrowernumber> is the borrower number of the patron who currently
1925 C<$itemnumber> is the number of the item to renew.
1927 C<$branch> is the library branch. Defaults to the homebranch of the ITEM.
1929 C<$datedue> can be a C4::Dates object used to set the due date.
1931 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
1932 this parameter is not supplied, lastreneweddate is set to the current date.
1934 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
1935 from the book's item type.
1940 my $borrowernumber = shift or return undef;
1941 my $itemnumber = shift or return undef;
1942 my $item = GetItem($itemnumber) or return undef;
1943 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
1944 my $branch = (@_) ? shift : $item->{homebranch}; # opac-renew doesn't send branch
1945 my $datedue = shift;
1946 my $lastreneweddate = shift;
1948 # If the due date wasn't specified, calculate it by adding the
1949 # book's loan length to today's date.
1950 unless ($datedue && $datedue->output('iso')) {
1952 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
1953 my $loanlength = GetLoanLength(
1954 $borrower->{'categorycode'},
1955 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
1956 $item->{homebranch} # item's homebranch determines loanlength OR do we want the branch specified by the AddRenewal argument?
1958 #FIXME -- use circControl?
1959 $datedue = CalcDateDue(C4::Dates->new(),$loanlength,$branch); # this branch is the transactional branch.
1960 # The question of whether to use item's homebranch calendar is open.
1963 # $lastreneweddate defaults to today.
1964 unless (defined $lastreneweddate) {
1965 $lastreneweddate = strftime( "%Y-%m-%d", localtime );
1968 my $dbh = C4::Context->dbh;
1969 # Find the issues record for this book
1971 $dbh->prepare("SELECT * FROM issues
1972 WHERE borrowernumber=?
1975 $sth->execute( $borrowernumber, $itemnumber );
1976 my $issuedata = $sth->fetchrow_hashref;
1979 # If the due date wasn't specified, calculate it by adding the
1980 # book's loan length to due's date.
1981 unless (@_ and $datedue = shift and $datedue->output('iso')) {
1983 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
1984 my $loanlength = GetLoanLength(
1985 $borrower->{'categorycode'},
1986 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
1987 $item->{homebranch} # item's homebranch determines loanlength OR do we want the branch specified by the AddRenewal argument?
1990 #FIXME -- use circControl?
1991 $datedue = CalcDateDue(C4::Dates->new($issuedata->{date_due}, 'iso'),$loanlength,$branch); # this branch is the transactional branch.
1992 # The question of whether to use item's homebranch calendar is open.
1995 # Update the issues record to have the new due date, and a new count
1996 # of how many times it has been renewed.
1997 my $renews = $issuedata->{'renewals'} + 1;
1998 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
1999 WHERE borrowernumber=?
2002 $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2005 # Update the renewal count on the item, and tell zebra to reindex
2006 $renews = $biblio->{'renewals'} + 1;
2007 ModItem({ renewals => $renews }, $biblio->{'biblionumber'}, $itemnumber);
2009 # Charge a new rental fee, if applicable?
2010 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2011 if ( $charge > 0 ) {
2012 my $accountno = getnextacctno( $borrowernumber );
2013 my $item = GetBiblioFromItemNumber($itemnumber);
2014 $sth = $dbh->prepare(
2015 "INSERT INTO accountlines
2017 borrowernumber, accountno, amount,
2019 accounttype, amountoutstanding, itemnumber
2021 VALUES (now(),?,?,?,?,?,?,?)"
2023 $sth->execute( $borrowernumber, $accountno, $charge,
2024 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2025 'Rent', $charge, $itemnumber );
2029 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2034 # check renewal status
2035 my ($bornum,$itemno)=@_;
2036 my $dbh = C4::Context->dbh;
2038 my $renewsallowed = 0;
2040 # Look in the issues table for this item, lent to this borrower,
2041 # and not yet returned.
2043 # FIXME - I think this function could be redone to use only one SQL call.
2044 my $sth = $dbh->prepare("select * from issues
2045 where (borrowernumber = ?)
2046 and (itemnumber = ?)");
2047 $sth->execute($bornum,$itemno);
2048 my $data = $sth->fetchrow_hashref;
2049 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2051 my $query = "SELECT renewalsallowed FROM items ";
2052 $query .= (C4::Context->preference('item-level_itypes'))
2053 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2054 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2055 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2056 $query .= "WHERE items.itemnumber = ?";
2057 my $sth2 = $dbh->prepare($query);
2058 $sth2->execute($itemno);
2059 my $data2 = $sth2->fetchrow_hashref();
2060 $renewsallowed = $data2->{'renewalsallowed'};
2061 $renewsleft = $renewsallowed - $renewcount;
2062 return ($renewcount,$renewsallowed,$renewsleft);
2065 =head2 GetIssuingCharges
2067 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2069 Calculate how much it would cost for a given patron to borrow a given
2070 item, including any applicable discounts.
2072 C<$itemnumber> is the item number of item the patron wishes to borrow.
2074 C<$borrowernumber> is the patron's borrower number.
2076 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2077 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2082 sub GetIssuingCharges {
2084 # calculate charges due
2085 my ( $itemnumber, $borrowernumber ) = @_;
2087 my $dbh = C4::Context->dbh;
2090 # Get the book's item type and rental charge (via its biblioitem).
2091 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
2092 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2093 $qcharge .= (C4::Context->preference('item-level_itypes'))
2094 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2095 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2097 $qcharge .= "WHERE items.itemnumber =?";
2099 my $sth1 = $dbh->prepare($qcharge);
2100 $sth1->execute($itemnumber);
2101 if ( my $data1 = $sth1->fetchrow_hashref ) {
2102 $item_type = $data1->{'itemtype'};
2103 $charge = $data1->{'rentalcharge'};
2104 my $q2 = "SELECT rentaldiscount FROM borrowers
2105 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2106 WHERE borrowers.borrowernumber = ?
2107 AND issuingrules.itemtype = ?";
2108 my $sth2 = $dbh->prepare($q2);
2109 $sth2->execute( $borrowernumber, $item_type );
2110 if ( my $data2 = $sth2->fetchrow_hashref ) {
2111 my $discount = $data2->{'rentaldiscount'};
2112 if ( $discount eq 'NULL' ) {
2115 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2121 return ( $charge, $item_type );
2124 =head2 AddIssuingCharge
2126 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2130 sub AddIssuingCharge {
2131 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2132 my $dbh = C4::Context->dbh;
2133 my $nextaccntno = getnextacctno( $borrowernumber );
2135 INSERT INTO accountlines
2136 (borrowernumber, itemnumber, accountno,
2137 date, amount, description, accounttype,
2139 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2141 my $sth = $dbh->prepare($query);
2142 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2148 GetTransfers($itemnumber);
2153 my ($itemnumber) = @_;
2155 my $dbh = C4::Context->dbh;
2161 FROM branchtransfers
2162 WHERE itemnumber = ?
2163 AND datearrived IS NULL
2165 my $sth = $dbh->prepare($query);
2166 $sth->execute($itemnumber);
2167 my @row = $sth->fetchrow_array();
2173 =head2 GetTransfersFromTo
2175 @results = GetTransfersFromTo($frombranch,$tobranch);
2177 Returns the list of pending transfers between $from and $to branch
2181 sub GetTransfersFromTo {
2182 my ( $frombranch, $tobranch ) = @_;
2183 return unless ( $frombranch && $tobranch );
2184 my $dbh = C4::Context->dbh;
2186 SELECT itemnumber,datesent,frombranch
2187 FROM branchtransfers
2190 AND datearrived IS NULL
2192 my $sth = $dbh->prepare($query);
2193 $sth->execute( $frombranch, $tobranch );
2196 while ( my $data = $sth->fetchrow_hashref ) {
2197 push @gettransfers, $data;
2200 return (@gettransfers);
2203 =head2 DeleteTransfer
2205 &DeleteTransfer($itemnumber);
2209 sub DeleteTransfer {
2210 my ($itemnumber) = @_;
2211 my $dbh = C4::Context->dbh;
2212 my $sth = $dbh->prepare(
2213 "DELETE FROM branchtransfers
2215 AND datearrived IS NULL "
2217 $sth->execute($itemnumber);
2221 =head2 AnonymiseIssueHistory
2223 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2225 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2226 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2228 return the number of affected rows.
2232 sub AnonymiseIssueHistory {
2234 my $borrowernumber = shift;
2235 my $dbh = C4::Context->dbh;
2238 SET borrowernumber = NULL
2239 WHERE returndate < '".$date."'
2240 AND borrowernumber IS NOT NULL
2242 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2243 my $rows_affected = $dbh->do($query);
2244 return $rows_affected;
2247 =head2 updateWrongTransfer
2249 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2251 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
2255 sub updateWrongTransfer {
2256 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2257 my $dbh = C4::Context->dbh;
2258 # first step validate the actual line of transfert .
2261 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2263 $sth->execute($FromLibrary,$itemNumber);
2266 # second step create a new line of branchtransfer to the right location .
2267 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2269 #third step changing holdingbranch of item
2270 UpdateHoldingbranch($FromLibrary,$itemNumber);
2273 =head2 UpdateHoldingbranch
2275 $items = UpdateHoldingbranch($branch,$itmenumber);
2276 Simple methode for updating hodlingbranch in items BDD line
2280 sub UpdateHoldingbranch {
2281 my ( $branch,$itemnumber ) = @_;
2282 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2287 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2288 this function calculates the due date given the loan length ,
2289 checking against the holidays calendar as per the 'useDaysMode' syspref.
2290 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2291 C<$branch> = location whose calendar to use
2292 C<$loanlength> = loan length prior to adjustment
2296 my ($startdate,$loanlength,$branch) = @_;
2297 if(C4::Context->preference('useDaysMode') eq 'Days') { # ignoring calendar
2298 my $datedue = time + ($loanlength) * 86400;
2299 #FIXME - assumes now even though we take a startdate
2300 my @datearr = localtime($datedue);
2301 return C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2303 my $calendar = C4::Calendar->new( branchcode => $branch );
2304 my $datedue = $calendar->addDate($startdate, $loanlength);
2309 =head2 CheckValidDatedue
2310 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2311 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2313 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2314 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2315 C<$date_due> = returndate calculate with no day check
2316 C<$itemnumber> = itemnumber
2317 C<$branchcode> = location of issue (affected by 'CircControl' syspref)
2318 C<$loanlength> = loan length prior to adjustment
2321 sub CheckValidDatedue {
2322 my ($date_due,$itemnumber,$branchcode)=@_;
2323 my @datedue=split('-',$date_due->output('iso'));
2324 my $years=$datedue[0];
2325 my $month=$datedue[1];
2326 my $day=$datedue[2];
2327 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2329 for (my $i=0;$i<2;$i++){
2330 $dow=Day_of_Week($years,$month,$day);
2331 ($dow=0) if ($dow>6);
2332 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2333 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2334 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2335 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2337 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2340 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2345 =head2 CheckRepeatableHolidays
2347 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2348 this function checks if the date due is a repeatable holiday
2349 C<$date_due> = returndate calculate with no day check
2350 C<$itemnumber> = itemnumber
2351 C<$branchcode> = localisation of issue
2355 sub CheckRepeatableHolidays{
2356 my($itemnumber,$week_day,$branchcode)=@_;
2357 my $dbh = C4::Context->dbh;
2358 my $query = qq|SELECT count(*)
2359 FROM repeatable_holidays
2362 my $sth = $dbh->prepare($query);
2363 $sth->execute($branchcode,$week_day);
2364 my $result=$sth->fetchrow;
2370 =head2 CheckSpecialHolidays
2372 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2373 this function check if the date is a special holiday
2374 C<$years> = the years of datedue
2375 C<$month> = the month of datedue
2376 C<$day> = the day of datedue
2377 C<$itemnumber> = itemnumber
2378 C<$branchcode> = localisation of issue
2382 sub CheckSpecialHolidays{
2383 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2384 my $dbh = C4::Context->dbh;
2385 my $query=qq|SELECT count(*)
2386 FROM `special_holidays`
2392 my $sth = $dbh->prepare($query);
2393 $sth->execute($years,$month,$day,$branchcode);
2394 my $countspecial=$sth->fetchrow ;
2396 return $countspecial;
2399 =head2 CheckRepeatableSpecialHolidays
2401 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2402 this function check if the date is a repeatble special holidays
2403 C<$month> = the month of datedue
2404 C<$day> = the day of datedue
2405 C<$itemnumber> = itemnumber
2406 C<$branchcode> = localisation of issue
2410 sub CheckRepeatableSpecialHolidays{
2411 my ($month,$day,$itemnumber,$branchcode) = @_;
2412 my $dbh = C4::Context->dbh;
2413 my $query=qq|SELECT count(*)
2414 FROM `repeatable_holidays`
2419 my $sth = $dbh->prepare($query);
2420 $sth->execute($month,$day,$branchcode);
2421 my $countspecial=$sth->fetchrow ;
2423 return $countspecial;
2428 sub CheckValidBarcode{
2430 my $dbh = C4::Context->dbh;
2431 my $query=qq|SELECT count(*)
2435 my $sth = $dbh->prepare($query);
2436 $sth->execute($barcode);
2437 my $exist=$sth->fetchrow ;
2448 Koha Developement team <info@koha.org>