1 package C4
::Circulation
;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 #use warnings; FIXME - Bug 2505
32 use C4
::Dates
qw(format_date);
34 use C4
::ItemCirculationAlertPreference
;
37 use C4
::Branch
; # GetBranches
38 use C4
::Log
; # logaction
40 GetAuthorisedValueByCode
42 GetKohaAuthorisedValueLib
44 use C4
::Overdues
qw(CalcFine UpdateFine get_chargeable_units);
45 use C4
::RotatingCollections
qw(GetCollectionItemBranches);
46 use Algorithm
::CheckDigits
;
51 use Koha
::Borrower
::Debarments
;
54 use List
::MoreUtils
qw( uniq );
64 use vars
qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
68 $VERSION = 3.07.00.049; # for version checking
71 # FIXME subs that should probably be elsewhere
78 # subs to deal with issuing a book
90 &GetBranchBorrowerCircRule
94 &AnonymiseIssueHistory
95 &CheckIfIssuedToPatron
99 # subs to deal with returns
105 # subs to deal with transfers
112 &IsBranchTransferAllowed
113 &CreateBranchTransferLimit
114 &DeleteBranchTransferLimits
118 # subs to deal with offline circulation
120 &GetOfflineOperations
123 &DeleteOfflineOperation
124 &ProcessOfflineOperation
130 C4::Circulation - Koha circulation module
138 The functions in this module deal with circulation, issues, and
139 returns, as well as general information about the library.
140 Also deals with stocktaking.
146 $str = &barcodedecode($barcode, [$filter]);
148 Generic filter function for barcode string.
149 Called on every circ if the System Pref itemBarcodeInputFilter is set.
150 Will do some manipulation of the barcode for systems that deliver a barcode
151 to circulation.pl that differs from the barcode stored for the item.
152 For proper functioning of this filter, calling the function on the
153 correct barcode string (items.barcode) should return an unaltered barcode.
155 The optional $filter argument is to allow for testing or explicit
156 behavior that ignores the System Pref. Valid values are the same as the
161 # FIXME -- the &decode fcn below should be wrapped into this one.
162 # FIXME -- these plugins should be moved out of Circulation.pm
165 my ($barcode, $filter) = @_;
166 my $branch = C4
::Branch
::mybranch
();
167 $filter = C4
::Context
->preference('itemBarcodeInputFilter') unless $filter;
168 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
169 if ($filter eq 'whitespace') {
171 } elsif ($filter eq 'cuecat') {
173 my @fields = split( /\./, $barcode );
174 my @results = map( decode
($_), @fields[ 1 .. $#fields ] );
175 ($#results == 2) and return $results[2];
176 } elsif ($filter eq 'T-prefix') {
177 if ($barcode =~ /^[Tt](\d)/) {
178 (defined($1) and $1 eq '0') and return $barcode;
179 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
181 return sprintf("T%07d", $barcode);
182 # FIXME: $barcode could be "T1", causing warning: substr outside of string
183 # Why drop the nonzero digit after the T?
184 # Why pass non-digits (or empty string) to "T%07d"?
185 } elsif ($filter eq 'libsuite8') {
186 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
187 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
188 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
190 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
193 } elsif ($filter eq 'EAN13') {
194 my $ean = CheckDigits
('ean');
195 if ( $ean->is_valid($barcode) ) {
196 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
197 $barcode = '0' x
( 13 - length($barcode) ) . $barcode;
199 warn "# [$barcode] not valid EAN-13/UPC-A\n";
202 return $barcode; # return barcode, modified or not
207 $str = &decode($chunk);
209 Decodes a segment of a string emitted by a CueCat barcode scanner and
212 FIXME: Should be replaced with Barcode::Cuecat from CPAN
213 or Javascript based decoding on the client side.
220 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
221 my @s = map { index( $seq, $_ ); } split( //, $encoded );
222 my $l = ( $#s + 1 ) % 4;
225 # warn "Error: Cuecat decode parsing failed!";
233 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
235 chr( ( $n >> 16 ) ^ 67 )
236 .chr( ( $n >> 8 & 255 ) ^ 67 )
237 .chr( ( $n & 255 ) ^ 67 );
240 $r = substr( $r, 0, length($r) - $l );
246 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
247 $barcode, $ignore_reserves);
249 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
251 C<$newbranch> is the code for the branch to which the item should be transferred.
253 C<$barcode> is the barcode of the item to be transferred.
255 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
256 Otherwise, if an item is reserved, the transfer fails.
258 Returns three values:
264 is true if the transfer was successful.
268 is a reference-to-hash which may have any of the following keys:
274 There is no item in the catalog with the given barcode. The value is C<$barcode>.
278 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.
280 =item C<DestinationEqualsHolding>
282 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.
286 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.
290 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>.
292 =item C<WasTransferred>
294 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
303 my ( $tbr, $barcode, $ignoreRs ) = @_;
306 my $branches = GetBranches
();
307 my $itemnumber = GetItemnumberFromBarcode
( $barcode );
308 my $issue = GetItemIssue
($itemnumber);
309 my $biblio = GetBiblioFromItemNumber
($itemnumber);
312 if ( not $itemnumber ) {
313 $messages->{'BadBarcode'} = $barcode;
317 # get branches of book...
318 my $hbr = $biblio->{'homebranch'};
319 my $fbr = $biblio->{'holdingbranch'};
321 # if using Branch Transfer Limits
322 if ( C4
::Context
->preference("UseBranchTransferLimits") == 1 ) {
323 if ( C4
::Context
->preference("item-level_itypes") && C4
::Context
->preference("BranchTransferLimitsType") eq 'itemtype' ) {
324 if ( ! IsBranchTransferAllowed
( $tbr, $fbr, $biblio->{'itype'} ) ) {
325 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
328 } elsif ( ! IsBranchTransferAllowed
( $tbr, $fbr, $biblio->{ C4
::Context
->preference("BranchTransferLimitsType") } ) ) {
329 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4
::Context
->preference("BranchTransferLimitsType") };
335 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
336 $messages->{'IsPermanent'} = $hbr;
340 # can't transfer book if is already there....
341 if ( $fbr eq $tbr ) {
342 $messages->{'DestinationEqualsHolding'} = 1;
346 # check if it is still issued to someone, return it...
347 if ($issue->{borrowernumber
}) {
348 AddReturn
( $barcode, $fbr );
349 $messages->{'WasReturned'} = $issue->{borrowernumber
};
353 # That'll save a database query.
354 my ( $resfound, $resrec, undef ) =
355 CheckReserves
( $itemnumber );
356 if ( $resfound and not $ignoreRs ) {
357 $resrec->{'ResFound'} = $resfound;
359 # $messages->{'ResFound'} = $resrec;
363 #actually do the transfer....
365 ModItemTransfer
( $itemnumber, $fbr, $tbr );
367 # don't need to update MARC anymore, we do it in batch now
368 $messages->{'WasTransfered'} = 1;
371 ModDateLastSeen
( $itemnumber );
372 return ( $dotransfer, $messages, $biblio );
377 my $borrower = shift;
378 my $biblionumber = shift;
380 my $cat_borrower = $borrower->{'categorycode'};
381 my $dbh = C4
::Context
->dbh;
383 # Get which branchcode we need
384 $branch = _GetCircControlBranch
($item,$borrower);
385 my $type = (C4
::Context
->preference('item-level_itypes'))
386 ?
$item->{'itype'} # item-level
387 : $item->{'itemtype'}; # biblio-level
389 # given branch, patron category, and item type, determine
390 # applicable issuing rule
391 my $issuing_rule = GetIssuingRule
($cat_borrower, $type, $branch);
393 # if a rule is found and has a loan limit set, count
394 # how many loans the patron already has that meet that
396 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
398 my $count_query = "SELECT COUNT(*) FROM issues
399 JOIN items USING (itemnumber) ";
401 my $rule_itemtype = $issuing_rule->{itemtype
};
402 if ($rule_itemtype eq "*") {
403 # matching rule has the default item type, so count only
404 # those existing loans that don't fall under a more
406 if (C4
::Context
->preference('item-level_itypes')) {
407 $count_query .= " WHERE items.itype NOT IN (
408 SELECT itemtype FROM issuingrules
410 AND (categorycode = ? OR categorycode = ?)
414 $count_query .= " JOIN biblioitems USING (biblionumber)
415 WHERE biblioitems.itemtype NOT IN (
416 SELECT itemtype FROM issuingrules
418 AND (categorycode = ? OR categorycode = ?)
422 push @bind_params, $issuing_rule->{branchcode
};
423 push @bind_params, $issuing_rule->{categorycode
};
424 push @bind_params, $cat_borrower;
426 # rule has specific item type, so count loans of that
428 if (C4
::Context
->preference('item-level_itypes')) {
429 $count_query .= " WHERE items.itype = ? ";
431 $count_query .= " JOIN biblioitems USING (biblionumber)
432 WHERE biblioitems.itemtype= ? ";
434 push @bind_params, $type;
437 $count_query .= " AND borrowernumber = ? ";
438 push @bind_params, $borrower->{'borrowernumber'};
439 my $rule_branch = $issuing_rule->{branchcode
};
440 if ($rule_branch ne "*") {
441 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
442 $count_query .= " AND issues.branchcode = ? ";
443 push @bind_params, $branch;
444 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
445 ; # if branch is the patron's home branch, then count all loans by patron
447 $count_query .= " AND items.homebranch = ? ";
448 push @bind_params, $branch;
452 my $count_sth = $dbh->prepare($count_query);
453 $count_sth->execute(@bind_params);
454 my ($current_loan_count) = $count_sth->fetchrow_array;
456 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
457 if ($current_loan_count >= $max_loans_allowed) {
458 return ($current_loan_count, $max_loans_allowed);
462 # Now count total loans against the limit for the branch
463 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule
($branch, $cat_borrower);
464 if (defined($branch_borrower_circ_rule->{maxissueqty
})) {
465 my @bind_params = ();
466 my $branch_count_query = "SELECT COUNT(*) FROM issues
467 JOIN items USING (itemnumber)
468 WHERE borrowernumber = ? ";
469 push @bind_params, $borrower->{borrowernumber
};
471 if (C4
::Context
->preference('CircControl') eq 'PickupLibrary') {
472 $branch_count_query .= " AND issues.branchcode = ? ";
473 push @bind_params, $branch;
474 } elsif (C4
::Context
->preference('CircControl') eq 'PatronLibrary') {
475 ; # if branch is the patron's home branch, then count all loans by patron
477 $branch_count_query .= " AND items.homebranch = ? ";
478 push @bind_params, $branch;
480 my $branch_count_sth = $dbh->prepare($branch_count_query);
481 $branch_count_sth->execute(@bind_params);
482 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
484 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty
};
485 if ($current_loan_count >= $max_loans_allowed) {
486 return ($current_loan_count, $max_loans_allowed);
490 # OK, the patron can issue !!!
496 @issues = &itemissues($biblioitemnumber, $biblio);
498 Looks up information about who has borrowed the bookZ<>(s) with the
499 given biblioitemnumber.
501 C<$biblio> is ignored.
503 C<&itemissues> returns an array of references-to-hash. The keys
504 include the fields from the C<items> table in the Koha database.
505 Additional keys include:
511 If the item is currently on loan, this gives the due date.
513 If the item is not on loan, then this is either "Available" or
514 "Cancelled", if the item has been withdrawn.
518 If the item is currently on loan, this gives the card number of the
519 patron who currently has the item.
521 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
523 These give the timestamp for the last three times the item was
526 =item C<card0>, C<card1>, C<card2>
528 The card number of the last three patrons who borrowed this item.
530 =item C<borrower0>, C<borrower1>, C<borrower2>
532 The borrower number of the last three patrons who borrowed this item.
540 my ( $bibitem, $biblio ) = @_;
541 my $dbh = C4
::Context
->dbh;
543 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
548 $sth->execute($bibitem) || die $sth->errstr;
550 while ( my $data = $sth->fetchrow_hashref ) {
552 # Find out who currently has this item.
553 # FIXME - Wouldn't it be better to do this as a left join of
554 # some sort? Currently, this code assumes that if
555 # fetchrow_hashref() fails, then the book is on the shelf.
556 # fetchrow_hashref() can fail for any number of reasons (e.g.,
557 # database server crash), not just because no items match the
559 my $sth2 = $dbh->prepare(
560 "SELECT * FROM issues
561 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
566 $sth2->execute( $data->{'itemnumber'} );
567 if ( my $data2 = $sth2->fetchrow_hashref ) {
568 $data->{'date_due'} = $data2->{'date_due'};
569 $data->{'card'} = $data2->{'cardnumber'};
570 $data->{'borrower'} = $data2->{'borrowernumber'};
573 $data->{'date_due'} = ($data->{'withdrawn'} eq '1') ?
'Cancelled' : 'Available';
577 # Find the last 3 people who borrowed this item.
578 $sth2 = $dbh->prepare(
579 "SELECT * FROM old_issues
580 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
582 ORDER BY returndate DESC,timestamp DESC"
585 $sth2->execute( $data->{'itemnumber'} );
586 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
587 { # FIXME : error if there is less than 3 pple borrowing this item
588 if ( my $data2 = $sth2->fetchrow_hashref ) {
589 $data->{"timestamp$i2"} = $data2->{'timestamp'};
590 $data->{"card$i2"} = $data2->{'cardnumber'};
591 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
595 $results[$i] = $data;
602 =head2 CanBookBeIssued
604 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
605 $barcode, $duedatespec, $inprocess, $ignore_reserves );
607 Check if a book can be issued.
609 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
613 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
615 =item C<$barcode> is the bar code of the book being issued.
617 =item C<$duedatespec> is a C4::Dates object.
619 =item C<$inprocess> boolean switch
620 =item C<$ignore_reserves> boolean switch
628 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
629 Possible values are :
635 sticky due date is invalid
639 borrower gone with no address
643 borrower declared it's card lost
649 =head3 UNKNOWN_BARCODE
663 item is restricted (set by ??)
665 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
666 could be prevented, but ones that can be overriden by the operator.
668 Possible values are :
676 renewing, not issuing
678 =head3 ISSUED_TO_ANOTHER
680 issued to someone else.
684 reserved for someone else.
688 sticky due date is invalid or due date in the past
692 if the borrower borrows to much things
696 sub CanBookBeIssued
{
697 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves ) = @_;
698 my %needsconfirmation; # filled with problems that needs confirmations
699 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
700 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
702 my $item = GetItem
(GetItemnumberFromBarcode
( $barcode ));
703 my $issue = GetItemIssue
($item->{itemnumber
});
704 my $biblioitem = GetBiblioItemData
($item->{biblioitemnumber
});
705 $item->{'itemtype'}=$item->{'itype'};
706 my $dbh = C4
::Context
->dbh;
708 # MANDATORY CHECKS - unless item exists, nothing else matters
709 unless ( $item->{barcode
} ) {
710 $issuingimpossible{UNKNOWN_BARCODE
} = 1;
712 return ( \
%issuingimpossible, \
%needsconfirmation ) if %issuingimpossible;
715 # DUE DATE is OK ? -- should already have checked.
717 if ($duedate && ref $duedate ne 'DateTime') {
718 $duedate = dt_from_string
($duedate);
720 my $now = DateTime
->now( time_zone
=> C4
::Context
->tz() );
721 unless ( $duedate ) {
722 my $issuedate = $now->clone();
724 my $branch = _GetCircControlBranch
($item,$borrower);
725 my $itype = ( C4
::Context
->preference('item-level_itypes') ) ?
$item->{'itype'} : $biblioitem->{'itemtype'};
726 $duedate = CalcDateDue
( $issuedate, $itype, $branch, $borrower );
728 # Offline circ calls AddIssue directly, doesn't run through here
729 # So issuingimpossible should be ok.
732 my $today = $now->clone();
733 $today->truncate( to
=> 'minute');
734 if (DateTime
->compare($duedate,$today) == -1 ) { # duedate cannot be before now
735 $needsconfirmation{INVALID_DATE
} = output_pref
($duedate);
738 $issuingimpossible{INVALID_DATE
} = output_pref
($duedate);
744 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode
} )) {
745 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
747 branch
=> C4
::Context
->userenv->{'branch'},
749 itemnumber
=> $item->{'itemnumber'},
750 itemtype
=> $item->{'itemtype'},
751 borrowernumber
=> $borrower->{'borrowernumber'},
752 ccode
=> $item->{'ccode'}}
754 ModDateLastSeen
( $item->{'itemnumber'} );
755 return( { STATS
=> 1 }, {});
757 if ( $borrower->{flags
}->{GNA
} ) {
758 $issuingimpossible{GNA
} = 1;
760 if ( $borrower->{flags
}->{'LOST'} ) {
761 $issuingimpossible{CARD_LOST
} = 1;
763 if ( $borrower->{flags
}->{'DBARRED'} ) {
764 $issuingimpossible{DEBARRED
} = 1;
766 if ( !defined $borrower->{dateexpiry
} || $borrower->{'dateexpiry'} eq '0000-00-00') {
767 $issuingimpossible{EXPIRED
} = 1;
769 my $expiry_dt = dt_from_string
( $borrower->{dateexpiry
}, 'sql', 'floating' );
770 $expiry_dt->truncate( to
=> 'day');
771 my $today = $now->clone()->truncate(to
=> 'day');
772 $today->set_time_zone( 'floating' );
773 if ( DateTime
->compare($today, $expiry_dt) == 1 ) {
774 $issuingimpossible{EXPIRED
} = 1;
783 my ($balance, $non_issue_charges, $other_charges) =
784 C4
::Members
::GetMemberAccountBalance
( $borrower->{'borrowernumber'} );
785 my $amountlimit = C4
::Context
->preference("noissuescharge");
786 my $allowfineoverride = C4
::Context
->preference("AllowFineOverride");
787 my $allfinesneedoverride = C4
::Context
->preference("AllFinesNeedOverride");
788 if ( C4
::Context
->preference("IssuingInProcess") ) {
789 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
790 $issuingimpossible{DEBT
} = sprintf( "%.2f", $non_issue_charges );
791 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
792 $needsconfirmation{DEBT
} = sprintf( "%.2f", $non_issue_charges );
793 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
794 $needsconfirmation{DEBT
} = sprintf( "%.2f", $non_issue_charges );
798 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
799 $needsconfirmation{DEBT
} = sprintf( "%.2f", $non_issue_charges );
800 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
801 $issuingimpossible{DEBT
} = sprintf( "%.2f", $non_issue_charges );
802 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
803 $needsconfirmation{DEBT
} = sprintf( "%.2f", $non_issue_charges );
806 if ($balance > 0 && $other_charges > 0) {
807 $alerts{OTHER_CHARGES
} = sprintf( "%.2f", $other_charges );
810 my ($blocktype, $count) = C4
::Members
::IsMemberBlocked
($borrower->{'borrowernumber'});
811 if ($blocktype == -1) {
812 ## patron has outstanding overdue loans
813 if ( C4
::Context
->preference("OverduesBlockCirc") eq 'block'){
814 $issuingimpossible{USERBLOCKEDOVERDUE
} = $count;
816 elsif ( C4
::Context
->preference("OverduesBlockCirc") eq 'confirmation'){
817 $needsconfirmation{USERBLOCKEDOVERDUE
} = $count;
819 } elsif($blocktype == 1) {
820 # patron has accrued fine days or has a restriction. $count is a date
821 if ($count eq '9999-12-31') {
822 $issuingimpossible{USERBLOCKEDNOENDDATE
} = $count;
825 $issuingimpossible{USERBLOCKEDWITHENDDATE
} = $count;
830 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
832 my ($current_loan_count, $max_loans_allowed) = TooMany
( $borrower, $item->{biblionumber
}, $item );
833 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
834 if (defined $max_loans_allowed && $max_loans_allowed == 0) {
835 $needsconfirmation{PATRON_CANT
} = 1;
837 if($max_loans_allowed){
838 if ( C4
::Context
->preference("AllowTooManyOverride") ) {
839 $needsconfirmation{TOO_MANY
} = 1;
840 $needsconfirmation{current_loan_count
} = $current_loan_count;
841 $needsconfirmation{max_loans_allowed
} = $max_loans_allowed;
843 $issuingimpossible{TOO_MANY
} = 1;
844 $issuingimpossible{current_loan_count
} = $current_loan_count;
845 $issuingimpossible{max_loans_allowed
} = $max_loans_allowed;
853 if ( $item->{'notforloan'} )
855 if(!C4
::Context
->preference("AllowNotForLoanOverride")){
856 $issuingimpossible{NOT_FOR_LOAN
} = 1;
857 $issuingimpossible{item_notforloan
} = $item->{'notforloan'};
859 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
860 $needsconfirmation{item_notforloan
} = $item->{'notforloan'};
864 # we have to check itemtypes.notforloan also
865 if (C4
::Context
->preference('item-level_itypes')){
866 # this should probably be a subroutine
867 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
868 $sth->execute($item->{'itemtype'});
869 my $notforloan=$sth->fetchrow_hashref();
870 if ($notforloan->{'notforloan'}) {
871 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
872 $issuingimpossible{NOT_FOR_LOAN
} = 1;
873 $issuingimpossible{itemtype_notforloan
} = $item->{'itype'};
875 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
876 $needsconfirmation{itemtype_notforloan
} = $item->{'itype'};
880 elsif ($biblioitem->{'notforloan'} == 1){
881 if (!C4
::Context
->preference("AllowNotForLoanOverride")) {
882 $issuingimpossible{NOT_FOR_LOAN
} = 1;
883 $issuingimpossible{itemtype_notforloan
} = $biblioitem->{'itemtype'};
885 $needsconfirmation{NOT_FOR_LOAN_FORCING
} = 1;
886 $needsconfirmation{itemtype_notforloan
} = $biblioitem->{'itemtype'};
890 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
892 $issuingimpossible{WTHDRAWN
} = 1;
894 if ( $item->{'restricted'}
895 && $item->{'restricted'} == 1 )
897 $issuingimpossible{RESTRICTED
} = 1;
899 if ( $item->{'itemlost'} && C4
::Context
->preference("IssueLostItem") ne 'nothing' ) {
900 my $code = GetAuthorisedValueByCode
( 'LOST', $item->{'itemlost'} );
901 $needsconfirmation{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'confirm' );
902 $alerts{ITEM_LOST
} = $code if ( C4
::Context
->preference("IssueLostItem") eq 'alert' );
904 if ( C4
::Context
->preference("IndependentBranches") ) {
905 my $userenv = C4
::Context
->userenv;
906 unless ( C4
::Context
->IsSuperLibrarian() ) {
907 if ( $item->{C4
::Context
->preference("HomeOrHoldingBranch")} ne $userenv->{branch
} ){
908 $issuingimpossible{ITEMNOTSAMEBRANCH
} = 1;
909 $issuingimpossible{'itemhomebranch'} = $item->{C4
::Context
->preference("HomeOrHoldingBranch")};
911 $needsconfirmation{BORRNOTSAMEBRANCH
} = GetBranchName
( $borrower->{'branchcode'} )
912 if ( $borrower->{'branchcode'} ne $userenv->{branch
} );
916 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
918 my $rentalConfirmation = C4
::Context
->preference("RentalFeesCheckoutConfirmation");
920 if ( $rentalConfirmation ){
921 my ($rentalCharge) = GetIssuingCharges
( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
922 if ( $rentalCharge > 0 ){
923 $rentalCharge = sprintf("%.02f", $rentalCharge);
924 $needsconfirmation{RENTALCHARGE
} = $rentalCharge;
929 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
931 if ( $issue->{borrowernumber
} && $issue->{borrowernumber
} eq $borrower->{'borrowernumber'} ){
933 # Already issued to current borrower. Ask whether the loan should
935 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed
(
936 $borrower->{'borrowernumber'},
937 $item->{'itemnumber'}
939 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
940 if ( $renewerror eq 'onsite_checkout' ) {
941 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS
} = 1;
944 $issuingimpossible{NO_MORE_RENEWALS
} = 1;
948 $needsconfirmation{RENEW_ISSUE
} = 1;
951 elsif ($issue->{borrowernumber
}) {
953 # issued to someone else
954 my $currborinfo = C4
::Members
::GetMember
( borrowernumber
=> $issue->{borrowernumber
} );
956 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
957 $needsconfirmation{ISSUED_TO_ANOTHER
} = 1;
958 $needsconfirmation{issued_firstname
} = $currborinfo->{'firstname'};
959 $needsconfirmation{issued_surname
} = $currborinfo->{'surname'};
960 $needsconfirmation{issued_cardnumber
} = $currborinfo->{'cardnumber'};
961 $needsconfirmation{issued_borrowernumber
} = $currborinfo->{'borrowernumber'};
964 unless ( $ignore_reserves ) {
965 # See if the item is on reserve.
966 my ( $restype, $res ) = C4
::Reserves
::CheckReserves
( $item->{'itemnumber'} );
968 my $resbor = $res->{'borrowernumber'};
969 if ( $resbor ne $borrower->{'borrowernumber'} ) {
970 my ( $resborrower ) = C4
::Members
::GetMember
( borrowernumber
=> $resbor );
971 my $branchname = GetBranchName
( $res->{'branchcode'} );
972 if ( $restype eq "Waiting" )
974 # The item is on reserve and waiting, but has been
975 # reserved by some other patron.
976 $needsconfirmation{RESERVE_WAITING
} = 1;
977 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
978 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
979 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
980 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
981 $needsconfirmation{'resbranchname'} = $branchname;
982 $needsconfirmation{'reswaitingdate'} = format_date
($res->{'waitingdate'});
984 elsif ( $restype eq "Reserved" ) {
985 # The item is on reserve for someone else.
986 $needsconfirmation{RESERVED
} = 1;
987 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
988 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
989 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
990 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
991 $needsconfirmation{'resbranchname'} = $branchname;
992 $needsconfirmation{'resreservedate'} = format_date
($res->{'reservedate'});
998 ## CHECK AGE RESTRICTION
999 my $agerestriction = $biblioitem->{'agerestriction'};
1000 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction
( $agerestriction, $borrower );
1001 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1002 if ( C4
::Context
->preference('AgeRestrictionOverride') ) {
1003 $needsconfirmation{AGE_RESTRICTION
} = "$agerestriction";
1006 $issuingimpossible{AGE_RESTRICTION
} = "$agerestriction";
1010 ## check for high holds decreasing loan period
1011 my $decrease_loan = C4
::Context
->preference('decreaseLoanHighHolds');
1012 if ( $decrease_loan && $decrease_loan == 1 ) {
1013 my ( $reserved, $num, $duration, $returndate ) =
1014 checkHighHolds
( $item, $borrower );
1016 if ( $num >= C4
::Context
->preference('decreaseLoanHighHoldsValue') ) {
1017 $needsconfirmation{HIGHHOLDS
} = {
1019 duration
=> $duration,
1020 returndate
=> output_pref
($returndate),
1026 !C4
::Context
->preference('AllowMultipleIssuesOnABiblio') &&
1027 # don't do the multiple loans per bib check if we've
1028 # already determined that we've got a loan on the same item
1029 !$issuingimpossible{NO_MORE_RENEWALS
} &&
1030 !$needsconfirmation{RENEW_ISSUE
}
1032 # Check if borrower has already issued an item from the same biblio
1033 # Only if it's not a subscription
1034 my $biblionumber = $item->{biblionumber
};
1035 require C4
::Serials
;
1036 my $is_a_subscription = C4
::Serials
::CountSubscriptionFromBiblionumber
($biblionumber);
1037 unless ($is_a_subscription) {
1038 my $issues = GetIssues
( {
1039 borrowernumber
=> $borrower->{borrowernumber
},
1040 biblionumber
=> $biblionumber,
1042 my @issues = $issues ? @
$issues : ();
1043 # if we get here, we don't already have a loan on this item,
1044 # so if there are any loans on this bib, ask for confirmation
1045 if (scalar @issues > 0) {
1046 $needsconfirmation{BIBLIO_ALREADY_ISSUED
} = 1;
1051 return ( \
%issuingimpossible, \
%needsconfirmation, \
%alerts );
1054 =head2 CanBookBeReturned
1056 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1058 Check whether the item can be returned to the provided branch
1062 =item C<$item> is a hash of item information as returned from GetItem
1064 =item C<$branch> is the branchcode where the return is taking place
1072 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1074 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1080 sub CanBookBeReturned
{
1081 my ($item, $branch) = @_;
1082 my $allowreturntobranch = C4
::Context
->preference("AllowReturnToBranch") || 'anywhere';
1084 # assume return is allowed to start
1088 # identify all cases where return is forbidden
1089 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1091 $message = $item->{'homebranch'};
1092 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1094 $message = $item->{'holdingbranch'};
1095 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1097 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1100 return ($allowed, $message);
1103 =head2 CheckHighHolds
1105 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1106 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1107 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1111 sub checkHighHolds
{
1112 my ( $item, $borrower ) = @_;
1113 my $biblio = GetBiblioFromItemNumber
( $item->{itemnumber
} );
1114 my $branch = _GetCircControlBranch
( $item, $borrower );
1115 my $dbh = C4
::Context
->dbh;
1116 my $sth = $dbh->prepare(
1117 'select count(borrowernumber) as num_holds from reserves where biblionumber=?'
1119 $sth->execute( $item->{'biblionumber'} );
1120 my ($holds) = $sth->fetchrow_array;
1122 my $issuedate = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1124 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
1127 ( C4
::Context
->preference('item-level_itypes') )
1128 ?
$biblio->{'itype'}
1129 : $biblio->{'itemtype'};
1131 C4
::Circulation
::CalcDateDue
( $issuedate, $itype, $branch,
1134 my $reduced_datedue =
1135 $calendar->addDate( $issuedate,
1136 C4
::Context
->preference('decreaseLoanHighHoldsDuration') );
1138 if ( DateTime
->compare( $reduced_datedue, $orig_due ) == -1 ) {
1140 C4
::Context
->preference('decreaseLoanHighHoldsDuration'),
1144 return ( 0, 0, 0, undef );
1149 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1151 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1155 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1157 =item C<$barcode> is the barcode of the item being issued.
1159 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
1160 Calculated if empty.
1162 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1164 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1165 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
1167 AddIssue does the following things :
1169 - step 01: check that there is a borrowernumber & a barcode provided
1170 - check for RENEWAL (book issued & being issued to the same patron)
1171 - renewal YES = Calculate Charge & renew
1173 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1175 - fill reserve if reserve to this patron
1176 - cancel reserve or not, otherwise
1177 * TRANSFERT PENDING ?
1178 - complete the transfert
1186 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1187 my $onsite_checkout = $params && $params->{onsite_checkout
} ?
1 : 0;
1188 my $auto_renew = $params && $params->{auto_renew
};
1189 my $dbh = C4
::Context
->dbh;
1190 my $barcodecheck=CheckValidBarcode
($barcode);
1194 if ($datedue && ref $datedue ne 'DateTime') {
1195 $datedue = dt_from_string
($datedue);
1197 # $issuedate defaults to today.
1198 if ( ! defined $issuedate ) {
1199 $issuedate = DateTime
->now(time_zone
=> C4
::Context
->tz());
1202 if ( ref $issuedate ne 'DateTime') {
1203 $issuedate = dt_from_string
($issuedate);
1207 if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1208 # find which item we issue
1209 my $item = GetItem
('', $barcode) or return; # if we don't get an Item, abort.
1210 my $branch = _GetCircControlBranch
($item,$borrower);
1212 # get actual issuing if there is one
1213 my $actualissue = GetItemIssue
( $item->{itemnumber
});
1215 # get biblioinformation for this item
1216 my $biblio = GetBiblioFromItemNumber
($item->{itemnumber
});
1219 # check if we just renew the issue.
1221 if ($actualissue->{borrowernumber
} eq $borrower->{'borrowernumber'}) {
1222 $datedue = AddRenewal
(
1223 $borrower->{'borrowernumber'},
1224 $item->{'itemnumber'},
1227 $issuedate, # here interpreted as the renewal date
1231 # it's NOT a renewal
1232 if ( $actualissue->{borrowernumber
}) {
1233 # This book is currently on loan, but not to the person
1234 # who wants to borrow it now. mark it returned before issuing to the new borrower
1237 C4
::Context
->userenv->{'branch'}
1241 MoveReserve
( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1242 # Starting process for transfer job (checking transfert and validate it if we have one)
1243 my ($datesent) = GetTransfers
($item->{'itemnumber'});
1245 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1248 "UPDATE branchtransfers
1249 SET datearrived = now(),
1251 comments = 'Forced branchtransfer'
1252 WHERE itemnumber= ? AND datearrived IS NULL"
1254 $sth->execute(C4
::Context
->userenv->{'branch'},$item->{'itemnumber'});
1257 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1258 unless ($auto_renew) {
1259 my $issuingrule = GetIssuingRule
($borrower->{categorycode
}, $item->{itype
}, $branch);
1260 $auto_renew = $issuingrule->{auto_renew
};
1263 # Record in the database the fact that the book was issued.
1265 my $itype = ( C4
::Context
->preference('item-level_itypes') ) ?
$biblio->{'itype'} : $biblio->{'itemtype'};
1266 $datedue = CalcDateDue
( $issuedate, $itype, $branch, $borrower );
1269 $datedue->truncate( to
=> 'minute');
1271 $issue = Koha
::Database
->new()->schema()->resultset('Issue')->create(
1273 borrowernumber
=> $borrower->{'borrowernumber'},
1274 itemnumber
=> $item->{'itemnumber'},
1275 issuedate
=> $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1276 date_due
=> $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1277 branchcode
=> C4
::Context
->userenv->{'branch'},
1278 onsite_checkout
=> $onsite_checkout,
1279 auto_renew
=> $auto_renew ?
1 : 0
1283 if ( C4
::Context
->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1284 CartToShelf
( $item->{'itemnumber'} );
1286 $item->{'issues'}++;
1287 if ( C4
::Context
->preference('UpdateTotalIssuesOnCirc') ) {
1288 UpdateTotalIssues
($item->{'biblionumber'}, 1);
1291 ## If item was lost, it has now been found, reverse any list item charges if neccessary.
1292 if ( $item->{'itemlost'} ) {
1293 if ( C4
::Context
->preference('RefundLostItemFeeOnReturn' ) ) {
1294 _FixAccountForLostAndReturned
( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1298 ModItem
({ issues
=> $item->{'issues'},
1299 holdingbranch
=> C4
::Context
->userenv->{'branch'},
1301 datelastborrowed
=> DateTime
->now(time_zone
=> C4
::Context
->tz())->ymd(),
1302 onloan
=> $datedue->ymd(),
1303 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1304 ModDateLastSeen
( $item->{'itemnumber'} );
1306 # If it costs to borrow this book, charge it to the patron's account.
1307 my ( $charge, $itemtype ) = GetIssuingCharges
(
1308 $item->{'itemnumber'},
1309 $borrower->{'borrowernumber'}
1311 if ( $charge > 0 ) {
1313 $item->{'itemnumber'},
1314 $borrower->{'borrowernumber'}, $charge
1316 $item->{'charge'} = $charge;
1319 # Record the fact that this book was issued.
1321 branch
=> C4
::Context
->userenv->{'branch'},
1322 type
=> ( $onsite_checkout ?
'onsite_checkout' : 'issue' ),
1324 other
=> ($sipmode ?
"SIP-$sipmode" : ''),
1325 itemnumber
=> $item->{'itemnumber'},
1326 itemtype
=> $item->{'itype'},
1327 borrowernumber
=> $borrower->{'borrowernumber'},
1328 ccode
=> $item->{'ccode'}}
1331 # Send a checkout slip.
1332 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1334 branchcode
=> $branch,
1335 categorycode
=> $borrower->{categorycode
},
1336 item_type
=> $item->{itype
},
1337 notification
=> 'CHECKOUT',
1339 if ($circulation_alert->is_enabled_for(\
%conditions)) {
1340 SendCirculationAlert
({
1343 borrower
=> $borrower,
1349 logaction
("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'itemnumber'})
1350 if C4
::Context
->preference("IssueLog");
1355 =head2 GetLoanLength
1357 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1359 Get loan length for an itemtype, a borrower type and a branch
1364 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1365 my $dbh = C4
::Context
->dbh;
1366 my $sth = $dbh->prepare(qq{
1367 SELECT issuelength
, lengthunit
, renewalperiod
1369 WHERE categorycode
=?
1372 AND issuelength IS NOT NULL
1375 # try to find issuelength & return the 1st available.
1376 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1377 $sth->execute( $borrowertype, $itemtype, $branchcode );
1378 my $loanlength = $sth->fetchrow_hashref;
1381 if defined($loanlength) && $loanlength->{issuelength
};
1383 $sth->execute( $borrowertype, '*', $branchcode );
1384 $loanlength = $sth->fetchrow_hashref;
1386 if defined($loanlength) && $loanlength->{issuelength
};
1388 $sth->execute( '*', $itemtype, $branchcode );
1389 $loanlength = $sth->fetchrow_hashref;
1391 if defined($loanlength) && $loanlength->{issuelength
};
1393 $sth->execute( '*', '*', $branchcode );
1394 $loanlength = $sth->fetchrow_hashref;
1396 if defined($loanlength) && $loanlength->{issuelength
};
1398 $sth->execute( $borrowertype, $itemtype, '*' );
1399 $loanlength = $sth->fetchrow_hashref;
1401 if defined($loanlength) && $loanlength->{issuelength
};
1403 $sth->execute( $borrowertype, '*', '*' );
1404 $loanlength = $sth->fetchrow_hashref;
1406 if defined($loanlength) && $loanlength->{issuelength
};
1408 $sth->execute( '*', $itemtype, '*' );
1409 $loanlength = $sth->fetchrow_hashref;
1411 if defined($loanlength) && $loanlength->{issuelength
};
1413 $sth->execute( '*', '*', '*' );
1414 $loanlength = $sth->fetchrow_hashref;
1416 if defined($loanlength) && $loanlength->{issuelength
};
1418 # if no rule is set => 21 days (hardcoded)
1421 renewalperiod
=> 21,
1422 lengthunit
=> 'days',
1428 =head2 GetHardDueDate
1430 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1432 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1436 sub GetHardDueDate
{
1437 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1439 my $rule = GetIssuingRule
( $borrowertype, $itemtype, $branchcode );
1441 if ( defined( $rule ) ) {
1442 if ( $rule->{hardduedate
} ) {
1443 return (dt_from_string
($rule->{hardduedate
}, 'iso'),$rule->{hardduedatecompare
});
1445 return (undef, undef);
1450 =head2 GetIssuingRule
1452 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1454 FIXME - This is a copy-paste of GetLoanLength
1455 as a stop-gap. Do not wish to change API for GetLoanLength
1456 this close to release.
1458 Get the issuing rule for an itemtype, a borrower type and a branch
1459 Returns a hashref from the issuingrules table.
1463 sub GetIssuingRule
{
1464 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1465 my $dbh = C4
::Context
->dbh;
1466 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1469 $sth->execute( $borrowertype, $itemtype, $branchcode );
1470 $irule = $sth->fetchrow_hashref;
1471 return $irule if defined($irule) ;
1473 $sth->execute( $borrowertype, "*", $branchcode );
1474 $irule = $sth->fetchrow_hashref;
1475 return $irule if defined($irule) ;
1477 $sth->execute( "*", $itemtype, $branchcode );
1478 $irule = $sth->fetchrow_hashref;
1479 return $irule if defined($irule) ;
1481 $sth->execute( "*", "*", $branchcode );
1482 $irule = $sth->fetchrow_hashref;
1483 return $irule if defined($irule) ;
1485 $sth->execute( $borrowertype, $itemtype, "*" );
1486 $irule = $sth->fetchrow_hashref;
1487 return $irule if defined($irule) ;
1489 $sth->execute( $borrowertype, "*", "*" );
1490 $irule = $sth->fetchrow_hashref;
1491 return $irule if defined($irule) ;
1493 $sth->execute( "*", $itemtype, "*" );
1494 $irule = $sth->fetchrow_hashref;
1495 return $irule if defined($irule) ;
1497 $sth->execute( "*", "*", "*" );
1498 $irule = $sth->fetchrow_hashref;
1499 return $irule if defined($irule) ;
1501 # if no rule matches,
1505 =head2 GetBranchBorrowerCircRule
1507 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1509 Retrieves circulation rule attributes that apply to the given
1510 branch and patron category, regardless of item type.
1511 The return value is a hashref containing the following key:
1513 maxissueqty - maximum number of loans that a
1514 patron of the given category can have at the given
1515 branch. If the value is undef, no limit.
1517 This will first check for a specific branch and
1518 category match from branch_borrower_circ_rules.
1520 If no rule is found, it will then check default_branch_circ_rules
1521 (same branch, default category). If no rule is found,
1522 it will then check default_borrower_circ_rules (default
1523 branch, same category), then failing that, default_circ_rules
1524 (default branch, default category).
1526 If no rule has been found in the database, it will default to
1531 C<$branchcode> and C<$categorycode> should contain the
1532 literal branch code and patron category code, respectively - no
1537 sub GetBranchBorrowerCircRule
{
1538 my $branchcode = shift;
1539 my $categorycode = shift;
1541 my $branch_cat_query = "SELECT maxissueqty
1542 FROM branch_borrower_circ_rules
1543 WHERE branchcode = ?
1544 AND categorycode = ?";
1545 my $dbh = C4
::Context
->dbh();
1546 my $sth = $dbh->prepare($branch_cat_query);
1547 $sth->execute($branchcode, $categorycode);
1549 if ($result = $sth->fetchrow_hashref()) {
1553 # try same branch, default borrower category
1554 my $branch_query = "SELECT maxissueqty
1555 FROM default_branch_circ_rules
1556 WHERE branchcode = ?";
1557 $sth = $dbh->prepare($branch_query);
1558 $sth->execute($branchcode);
1559 if ($result = $sth->fetchrow_hashref()) {
1563 # try default branch, same borrower category
1564 my $category_query = "SELECT maxissueqty
1565 FROM default_borrower_circ_rules
1566 WHERE categorycode = ?";
1567 $sth = $dbh->prepare($category_query);
1568 $sth->execute($categorycode);
1569 if ($result = $sth->fetchrow_hashref()) {
1573 # try default branch, default borrower category
1574 my $default_query = "SELECT maxissueqty
1575 FROM default_circ_rules";
1576 $sth = $dbh->prepare($default_query);
1578 if ($result = $sth->fetchrow_hashref()) {
1582 # built-in default circulation rule
1584 maxissueqty
=> undef,
1588 =head2 GetBranchItemRule
1590 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1592 Retrieves circulation rule attributes that apply to the given
1593 branch and item type, regardless of patron category.
1595 The return value is a hashref containing the following keys:
1597 holdallowed => Hold policy for this branch and itemtype. Possible values:
1598 0: No holds allowed.
1599 1: Holds allowed only by patrons that have the same homebranch as the item.
1600 2: Holds allowed from any patron.
1602 returnbranch => branch to which to return item. Possible values:
1603 noreturn: do not return, let item remain where checked in (floating collections)
1604 homebranch: return to item's home branch
1606 This searches branchitemrules in the following order:
1608 * Same branchcode and itemtype
1609 * Same branchcode, itemtype '*'
1610 * branchcode '*', same itemtype
1611 * branchcode and itemtype '*'
1613 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1617 sub GetBranchItemRule
{
1618 my ( $branchcode, $itemtype ) = @_;
1619 my $dbh = C4
::Context
->dbh();
1623 ['SELECT holdallowed, returnbranch
1624 FROM branch_item_rules
1625 WHERE branchcode = ?
1626 AND itemtype = ?', $branchcode, $itemtype],
1627 ['SELECT holdallowed, returnbranch
1628 FROM default_branch_circ_rules
1629 WHERE branchcode = ?', $branchcode],
1630 ['SELECT holdallowed, returnbranch
1631 FROM default_branch_item_rules
1632 WHERE itemtype = ?', $itemtype],
1633 ['SELECT holdallowed, returnbranch
1634 FROM default_circ_rules'],
1637 foreach my $attempt (@attempts) {
1638 my ($query, @bind_params) = @
{$attempt};
1639 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1642 # Since branch/category and branch/itemtype use the same per-branch
1643 # defaults tables, we have to check that the key we want is set, not
1644 # just that a row was returned
1645 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1646 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1649 # built-in default circulation rule
1650 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1651 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1658 ($doreturn, $messages, $iteminformation, $borrower) =
1659 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1665 =item C<$barcode> is the bar code of the book being returned.
1667 =item C<$branch> is the code of the branch where the book is being returned.
1669 =item C<$exemptfine> indicates that overdue charges for the item will be
1672 =item C<$dropbox> indicates that the check-in date is assumed to be
1673 yesterday, or the last non-holiday as defined in C4::Calendar . If
1674 overdue charges are applied and C<$dropbox> is true, the last charge
1675 will be removed. This assumes that the fines accrual script has run
1676 for _today_. Optional.
1678 =item C<$return_date> allows the default return date to be overridden
1679 by the given return date. Optional.
1683 C<&AddReturn> returns a list of four items:
1685 C<$doreturn> is true iff the return succeeded.
1687 C<$messages> is a reference-to-hash giving feedback on the operation.
1688 The keys of the hash are:
1694 No item with this barcode exists. The value is C<$barcode>.
1698 The book is not currently on loan. The value is C<$barcode>.
1700 =item C<IsPermanent>
1702 The book's home branch is a permanent collection. If you have borrowed
1703 this book, you are not allowed to return it. The value is the code for
1704 the book's home branch.
1708 This book has been withdrawn/cancelled. The value should be ignored.
1710 =item C<Wrongbranch>
1712 This book has was returned to the wrong branch. The value is a hashref
1713 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1714 contain the branchcode of the incorrect and correct return library, respectively.
1718 The item was reserved. The value is a reference-to-hash whose keys are
1719 fields from the reserves table of the Koha database, and
1720 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1721 either C<Waiting>, C<Reserved>, or 0.
1725 C<$iteminformation> is a reference-to-hash, giving information about the
1726 returned item from the issues table.
1728 C<$borrower> is a reference-to-hash, giving information about the
1729 patron who last borrowed the book.
1734 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1736 if ($branch and not GetBranchDetail
($branch)) {
1737 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4
::Context
->userenv->{'branch'};
1740 $branch = C4
::Context
->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1745 my $validTransfert = 0;
1746 my $stat_type = 'return';
1748 # get information on item
1749 my $itemnumber = GetItemnumberFromBarcode
( $barcode );
1750 unless ($itemnumber) {
1751 return (0, { BadBarcode
=> $barcode }); # no barcode means no item or borrower. bail out.
1753 my $issue = GetItemIssue
($itemnumber);
1754 # warn Dumper($iteminformation);
1755 if ($issue and $issue->{borrowernumber
}) {
1756 $borrower = C4
::Members
::GetMemberDetails
($issue->{borrowernumber
})
1757 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1758 . Dumper
($issue) . "\n";
1760 $messages->{'NotIssued'} = $barcode;
1761 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1763 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1764 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1765 if (C4
::Context
->preference("RecordLocalUseOnReturn")) {
1766 $messages->{'LocalUse'} = 1;
1767 $stat_type = 'localuse';
1771 my $item = GetItem
($itemnumber) or die "GetItem($itemnumber) failed";
1773 if ( $item->{'location'} eq 'PROC' ) {
1774 if ( C4
::Context
->preference("InProcessingToShelvingCart") ) {
1775 $item->{'location'} = 'CART';
1778 $item->{location
} = $item->{permanent_location
};
1781 ModItem
( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
1784 # full item data, but no borrowernumber or checkout info (no issue)
1785 # we know GetItem should work because GetItemnumberFromBarcode worked
1786 my $hbr = GetBranchItemRule
($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1787 # get the proper branch to which to return the item
1788 $hbr = $item->{$hbr} || $branch ;
1789 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1791 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1793 my $yaml = C4
::Context
->preference('UpdateNotForLoanStatusOnCheckin');
1795 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1797 eval { $rules = YAML
::Load
($yaml); };
1799 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1802 foreach my $key ( keys %$rules ) {
1803 if ( $item->{notforloan
} eq $key ) {
1804 $messages->{'NotForLoanStatusUpdated'} = { from
=> $item->{notforloan
}, to
=> $rules->{$key} };
1805 ModItem
( { notforloan
=> $rules->{$key} }, undef, $itemnumber );
1813 # check if the book is in a permanent collection....
1814 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1816 my $branches = GetBranches
(); # a potentially expensive call for a non-feature.
1817 $branches->{$hbr}->{PE
} and $messages->{'IsPermanent'} = $hbr;
1820 # check if the return is allowed at this branch
1821 my ($returnallowed, $message) = CanBookBeReturned
($item, $branch);
1822 unless ($returnallowed){
1823 $messages->{'Wrongbranch'} = {
1824 Wrongbranch
=> $branch,
1825 Rightbranch
=> $message
1828 return ( $doreturn, $messages, $issue, $borrower );
1831 if ( $item->{'withdrawn'} ) { # book has been cancelled
1832 $messages->{'withdrawn'} = 1;
1833 $doreturn = 0 if C4
::Context
->preference("BlockReturnOfWithdrawnItems");
1836 # case of a return of document (deal with issues and holdingbranch)
1837 my $today = DateTime
->now( time_zone
=> C4
::Context
->tz() );
1840 my $datedue = $issue->{date_due
};
1841 $borrower or warn "AddReturn without current borrower";
1842 my $circControlBranch;
1844 # define circControlBranch only if dropbox mode is set
1845 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1846 # FIXME: check issuedate > returndate, factoring in holidays
1847 #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1848 $circControlBranch = _GetCircControlBranch
($item,$borrower);
1849 $issue->{'overdue'} = DateTime
->compare($issue->{'date_due'}, $dropboxdate ) == -1 ?
1 : 0;
1852 if ($borrowernumber) {
1853 if ( ( C4
::Context
->preference('CalculateFinesOnReturn') && $issue->{'overdue'} ) || $return_date ) {
1854 # we only need to calculate and change the fines if we want to do that on return
1855 # Should be on for hourly loans
1856 my $control = C4
::Context
->preference('CircControl');
1857 my $control_branchcode =
1858 ( $control eq 'ItemHomeLibrary' ) ?
$item->{homebranch
}
1859 : ( $control eq 'PatronLibrary' ) ?
$borrower->{branchcode
}
1860 : $issue->{branchcode
};
1863 $return_date ? dt_from_string
($return_date) : $today;
1865 my ( $amount, $type, $unitcounttotal ) =
1866 C4
::Overdues
::CalcFine
( $item, $borrower->{categorycode
},
1867 $control_branchcode, $datedue, $date_returned );
1871 if ( C4
::Context
->preference('finesMode') eq 'production' ) {
1872 if ( $amount > 0 ) {
1873 C4
::Overdues
::UpdateFine
( $issue->{itemnumber
},
1874 $issue->{borrowernumber
},
1875 $amount, $type, output_pref
($datedue) );
1877 elsif ($return_date) {
1879 # Backdated returns may have fines that shouldn't exist,
1880 # so in this case, we need to drop those fines to 0
1882 C4
::Overdues
::UpdateFine
( $issue->{itemnumber
},
1883 $issue->{borrowernumber
},
1884 0, $type, output_pref
($datedue) );
1890 MarkIssueReturned
( $borrowernumber, $item->{'itemnumber'},
1891 $circControlBranch, $return_date, $borrower->{'privacy'} );
1894 $messages->{'Wrongbranch'} = {
1895 Wrongbranch
=> $branch,
1896 Rightbranch
=> $message
1899 return ( 0, { WasReturned
=> 0 }, $issue, $borrower );
1902 # FIXME is the "= 1" right? This could be the borrower hash.
1903 $messages->{'WasReturned'} = 1;
1907 ModItem
({ onloan
=> undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1910 # the holdingbranch is updated if the document is returned to another location.
1911 # this is always done regardless of whether the item was on loan or not
1912 if ($item->{'holdingbranch'} ne $branch) {
1913 UpdateHoldingbranch
($branch, $item->{'itemnumber'});
1914 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1916 ModDateLastSeen
( $item->{'itemnumber'} );
1918 # check if we have a transfer for this document
1919 my ($datesent,$frombranch,$tobranch) = GetTransfers
( $item->{'itemnumber'} );
1921 # if we have a transfer to do, we update the line of transfers with the datearrived
1922 my $is_in_rotating_collection = C4
::RotatingCollections
::isItemInAnyCollection
( $item->{'itemnumber'} );
1924 if ( $tobranch eq $branch ) {
1925 my $sth = C4
::Context
->dbh->prepare(
1926 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1928 $sth->execute( $item->{'itemnumber'} );
1929 # if we have a reservation with valid transfer, we can set it's status to 'W'
1930 ShelfToCart
( $item->{'itemnumber'} ) if ( C4
::Context
->preference("ReturnToShelvingCart") );
1931 C4
::Reserves
::ModReserveStatus
($item->{'itemnumber'}, 'W');
1933 $messages->{'WrongTransfer'} = $tobranch;
1934 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1936 $validTransfert = 1;
1938 ShelfToCart
( $item->{'itemnumber'} ) if ( C4
::Context
->preference("ReturnToShelvingCart") );
1941 # fix up the accounts.....
1942 if ( $item->{'itemlost'} ) {
1943 $messages->{'WasLost'} = 1;
1945 if ( C4
::Context
->preference('RefundLostItemFeeOnReturn' ) ) {
1946 _FixAccountForLostAndReturned
($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1947 $messages->{'LostItemFeeRefunded'} = 1;
1951 # fix up the overdues in accounts...
1952 if ($borrowernumber) {
1953 my $fix = _FixOverduesOnReturn
($borrowernumber, $item->{itemnumber
}, $exemptfine, $dropbox);
1954 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1956 if ( $issue->{overdue
} && $issue->{date_due
} ) {
1958 $today = $dropboxdate if $dropbox;
1959 my ($debardate,$reminder) = _debar_user_on_return
( $borrower, $item, $issue->{date_due
}, $today );
1961 $messages->{'PrevDebarred'} = $debardate;
1963 $messages->{'Debarred'} = $debardate if $debardate;
1965 # there's no overdue on the item but borrower had been previously debarred
1966 } elsif ( $issue->{date_due
} and $borrower->{'debarred'} ) {
1967 if ( $borrower->{debarred
} eq "9999-12-31") {
1968 $messages->{'ForeverDebarred'} = $borrower->{'debarred'};
1970 my $borrower_debar_dt = dt_from_string
( $borrower->{debarred
} );
1971 $borrower_debar_dt->truncate(to
=> 'day');
1972 my $today_dt = $today->clone()->truncate(to
=> 'day');
1973 if ( DateTime
->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
1974 $messages->{'PrevDebarred'} = $borrower->{'debarred'};
1980 # find reserves.....
1981 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1982 my ($resfound, $resrec);
1983 my $lookahead= C4
::Context
->preference('ConfirmFutureHolds'); #number of days to look for future holds
1984 ($resfound, $resrec, undef) = C4
::Reserves
::CheckReserves
( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
1986 $resrec->{'ResFound'} = $resfound;
1987 $messages->{'ResFound'} = $resrec;
1990 # Record the fact that this book was returned.
1991 # FIXME itemtype should record item level type, not bibliolevel type
1995 itemnumber
=> $item->{'itemnumber'},
1996 itemtype
=> $biblio->{'itemtype'},
1997 borrowernumber
=> $borrowernumber,
1998 ccode
=> $item->{'ccode'}}
2001 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
2002 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2004 branchcode
=> $branch,
2005 categorycode
=> $borrower->{categorycode
},
2006 item_type
=> $item->{itype
},
2007 notification
=> 'CHECKIN',
2009 if ($doreturn && $circulation_alert->is_enabled_for(\
%conditions)) {
2010 SendCirculationAlert
({
2013 borrower
=> $borrower,
2018 logaction
("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2019 if C4
::Context
->preference("ReturnLog");
2021 # Remove any OVERDUES related debarment if the borrower has no overdues
2022 if ( $borrowernumber
2023 && $borrower->{'debarred'}
2024 && C4
::Context
->preference('AutoRemoveOverduesRestrictions')
2025 && !C4
::Members
::HasOverdues
( $borrowernumber )
2026 && @
{ GetDebarments
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' }) }
2028 DelUniqueDebarment
({ borrowernumber
=> $borrowernumber, type
=> 'OVERDUES' });
2031 # FIXME: make this comment intelligible.
2032 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
2033 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
2035 if ( !$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
2036 if ( C4
::Context
->preference("AutomaticItemReturn" ) or
2037 (C4
::Context
->preference("UseBranchTransferLimits") and
2038 ! IsBranchTransferAllowed
($branch, $hbr, $item->{C4
::Context
->preference("BranchTransferLimitsType")} )
2040 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
2041 $debug and warn "item: " . Dumper
($item);
2042 ModItemTransfer
($item->{'itemnumber'}, $branch, $hbr);
2043 $messages->{'WasTransfered'} = 1;
2045 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
2049 return ( $doreturn, $messages, $issue, $borrower );
2052 =head2 MarkIssueReturned
2054 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2056 Unconditionally marks an issue as being returned by
2057 moving the C<issues> row to C<old_issues> and
2058 setting C<returndate> to the current date, or
2059 the last non-holiday date of the branccode specified in
2060 C<dropbox_branch> . Assumes you've already checked that
2061 it's safe to do this, i.e. last non-holiday > issuedate.
2063 if C<$returndate> is specified (in iso format), it is used as the date
2064 of the return. It is ignored when a dropbox_branch is passed in.
2066 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2067 the old_issue is immediately anonymised
2069 Ideally, this function would be internal to C<C4::Circulation>,
2070 not exported, but it is currently needed by one
2071 routine in C<C4::Accounts>.
2075 sub MarkIssueReturned
{
2076 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2078 my $anonymouspatron;
2079 if ( $privacy == 2 ) {
2080 # The default of 0 will not work due to foreign key constraints
2081 # The anonymisation will fail if AnonymousPatron is not a valid entry
2082 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2083 # Note that a warning should appear on the about page (System information tab).
2084 $anonymouspatron = C4
::Context
->preference('AnonymousPatron');
2085 die "Fatal error: the patron ($borrowernumber) has requested a privacy on returning item but the AnonymousPatron pref is not set correctly"
2086 unless C4
::Members
::GetMember
( borrowernumber
=> $anonymouspatron );
2088 my $dbh = C4
::Context
->dbh;
2089 my $query = 'UPDATE issues SET returndate=';
2091 if ($dropbox_branch) {
2092 my $calendar = Koha
::Calendar
->new( branchcode
=> $dropbox_branch );
2093 my $dropboxdate = $calendar->addDate( DateTime
->now( time_zone
=> C4
::Context
->tz), -1 );
2095 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2096 } elsif ($returndate) {
2098 push @bind, $returndate;
2100 $query .= ' now() ';
2102 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
2103 push @bind, $borrowernumber, $itemnumber;
2105 my $sth_upd = $dbh->prepare($query);
2106 $sth_upd->execute(@bind);
2107 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
2108 WHERE borrowernumber = ?
2109 AND itemnumber = ?');
2110 $sth_copy->execute($borrowernumber, $itemnumber);
2111 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2112 if ( $privacy == 2) {
2113 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
2114 WHERE borrowernumber = ?
2115 AND itemnumber = ?");
2116 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2118 my $sth_del = $dbh->prepare("DELETE FROM issues
2119 WHERE borrowernumber = ?
2120 AND itemnumber = ?");
2121 $sth_del->execute($borrowernumber, $itemnumber);
2123 ModItem
( { 'onloan' => undef }, undef, $itemnumber );
2126 =head2 _debar_user_on_return
2128 _debar_user_on_return($borrower, $item, $datedue, today);
2130 C<$borrower> borrower hashref
2132 C<$item> item hashref
2134 C<$datedue> date due DateTime object
2136 C<$today> DateTime object representing the return time
2138 Internal function, called only by AddReturn that calculates and updates
2139 the user fine days, and debars him if necessary.
2141 Should only be called for overdue returns
2145 sub _debar_user_on_return
{
2146 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2148 my $branchcode = _GetCircControlBranch
( $item, $borrower );
2150 my $circcontrol = C4
::Context
->preference('CircControl');
2152 GetIssuingRule
( $borrower->{categorycode
}, $item->{itype
}, $branchcode );
2153 my $finedays = $issuingrule->{finedays
};
2154 my $unit = $issuingrule->{lengthunit
};
2155 my $chargeable_units = C4
::Overdues
::get_chargeable_units
($unit, $dt_due, $dt_today, $branchcode);
2159 # finedays is in days, so hourly loans must multiply by 24
2160 # thus 1 hour late equals 1 day suspension * finedays rate
2161 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2163 # grace period is measured in the same units as the loan
2165 DateTime
::Duration
->new( $unit => $issuingrule->{firstremind
} );
2167 my $deltadays = DateTime
::Duration
->new(
2168 days
=> $chargeable_units
2170 if ( $deltadays->subtract($grace)->is_positive() ) {
2171 my $suspension_days = $deltadays * $finedays;
2173 # If the max suspension days is < than the suspension days
2174 # the suspension days is limited to this maximum period.
2175 my $max_sd = $issuingrule->{maxsuspensiondays
};
2176 if ( defined $max_sd ) {
2177 $max_sd = DateTime
::Duration
->new( days
=> $max_sd );
2178 $suspension_days = $max_sd
2179 if DateTime
::Duration
->compare( $max_sd, $suspension_days ) < 0;
2183 $dt_today->clone()->add_duration( $suspension_days );
2185 Koha
::Borrower
::Debarments
::AddUniqueDebarment
({
2186 borrowernumber
=> $borrower->{borrowernumber
},
2187 expiration
=> $new_debar_dt->ymd(),
2188 type
=> 'SUSPENSION',
2190 # if borrower was already debarred but does not get an extra debarment
2191 if ( $borrower->{debarred
} eq Koha
::Borrower
::Debarments
::IsDebarred
($borrower->{borrowernumber
}) ) {
2192 return ($borrower->{debarred
},1);
2194 return $new_debar_dt->ymd();
2200 =head2 _FixOverduesOnReturn
2202 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2204 C<$brn> borrowernumber
2208 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2209 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2211 Internal function, called only by AddReturn
2215 sub _FixOverduesOnReturn
{
2216 my ($borrowernumber, $item);
2217 unless ($borrowernumber = shift) {
2218 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2221 unless ($item = shift) {
2222 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2225 my ($exemptfine, $dropbox) = @_;
2226 my $dbh = C4
::Context
->dbh;
2228 # check for overdue fine
2229 my $sth = $dbh->prepare(
2230 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2232 $sth->execute( $borrowernumber, $item );
2234 # alter fine to show that the book has been returned
2235 my $data = $sth->fetchrow_hashref;
2236 return 0 unless $data; # no warning, there's just nothing to fix
2239 my @bind = ($data->{'accountlines_id'});
2241 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2242 if (C4
::Context
->preference("FinesLog")) {
2243 &logaction
("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2245 } elsif ($dropbox && $data->{lastincrement
}) {
2246 my $outstanding = $data->{amountoutstanding
} - $data->{lastincrement
} ;
2247 my $amt = $data->{amount
} - $data->{lastincrement
} ;
2248 if (C4
::Context
->preference("FinesLog")) {
2249 &logaction
("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2251 $uquery = "update accountlines set accounttype='F' ";
2252 if($outstanding >= 0 && $amt >=0) {
2253 $uquery .= ", amount = ? , amountoutstanding=? ";
2254 unshift @bind, ($amt, $outstanding) ;
2257 $uquery = "update accountlines set accounttype='F' ";
2259 $uquery .= " where (accountlines_id = ?)";
2260 my $usth = $dbh->prepare($uquery);
2261 return $usth->execute(@bind);
2264 =head2 _FixAccountForLostAndReturned
2266 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2268 Calculates the charge for a book lost and returned.
2270 Internal function, not exported, called only by AddReturn.
2272 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2273 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2277 sub _FixAccountForLostAndReturned
{
2278 my $itemnumber = shift or return;
2279 my $borrowernumber = @_ ?
shift : undef;
2280 my $item_id = @_ ?
shift : $itemnumber; # Send the barcode if you want that logged in the description
2281 my $dbh = C4
::Context
->dbh;
2282 # check for charge made for lost book
2283 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2284 $sth->execute($itemnumber);
2285 my $data = $sth->fetchrow_hashref;
2286 $data or return; # bail if there is nothing to do
2287 $data->{accounttype
} eq 'W' and return; # Written off
2289 # writeoff this amount
2291 my $amount = $data->{'amount'};
2292 my $acctno = $data->{'accountno'};
2293 my $amountleft; # Starts off undef/zero.
2294 if ($data->{'amountoutstanding'} == $amount) {
2295 $offset = $data->{'amount'};
2296 $amountleft = 0; # Hey, it's zero here, too.
2298 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2299 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2301 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2302 WHERE (accountlines_id = ?)");
2303 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2304 #check if any credit is left if so writeoff other accounts
2305 my $nextaccntno = getnextacctno
($data->{'borrowernumber'});
2306 $amountleft *= -1 if ($amountleft < 0);
2307 if ($amountleft > 0) {
2308 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2309 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2310 $msth->execute($data->{'borrowernumber'});
2311 # offset transactions
2314 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2315 if ($accdata->{'amountoutstanding'} < $amountleft) {
2317 $amountleft -= $accdata->{'amountoutstanding'};
2319 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2322 my $thisacct = $accdata->{'accountlines_id'};
2323 # FIXME: move prepares outside while loop!
2324 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2325 WHERE (accountlines_id = ?)");
2326 $usth->execute($newamtos,$thisacct);
2327 $usth = $dbh->prepare("INSERT INTO accountoffsets
2328 (borrowernumber, accountno, offsetaccount, offsetamount)
2331 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2334 $amountleft *= -1 if ($amountleft > 0);
2335 my $desc = "Item Returned " . $item_id;
2336 $usth = $dbh->prepare("INSERT INTO accountlines
2337 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2338 VALUES (?,?,now(),?,?,'CR',?)");
2339 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2340 if ($borrowernumber) {
2341 # FIXME: same as query above. use 1 sth for both
2342 $usth = $dbh->prepare("INSERT INTO accountoffsets
2343 (borrowernumber, accountno, offsetaccount, offsetamount)
2345 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2347 ModItem
({ paidfor
=> '' }, undef, $itemnumber);
2351 =head2 _GetCircControlBranch
2353 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2357 Return the library code to be used to determine which circulation
2358 policy applies to a transaction. Looks up the CircControl and
2359 HomeOrHoldingBranch system preferences.
2361 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2363 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2367 sub _GetCircControlBranch
{
2368 my ($item, $borrower) = @_;
2369 my $circcontrol = C4
::Context
->preference('CircControl');
2372 if ($circcontrol eq 'PickupLibrary' and (C4
::Context
->userenv and C4
::Context
->userenv->{'branch'}) ) {
2373 $branch= C4
::Context
->userenv->{'branch'};
2374 } elsif ($circcontrol eq 'PatronLibrary') {
2375 $branch=$borrower->{branchcode
};
2377 my $branchfield = C4
::Context
->preference('HomeOrHoldingBranch') || 'homebranch';
2378 $branch = $item->{$branchfield};
2379 # default to item home branch if holdingbranch is used
2380 # and is not defined
2381 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2382 $branch = $item->{homebranch
};
2395 $issue = &GetItemIssue($itemnumber);
2397 Returns patron currently having a book, or undef if not checked out.
2399 C<$itemnumber> is the itemnumber.
2401 C<$issue> is a hashref of the row from the issues table.
2406 my ($itemnumber) = @_;
2407 return unless $itemnumber;
2408 my $sth = C4
::Context
->dbh->prepare(
2409 "SELECT items.*, issues.*
2411 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2412 WHERE issues.itemnumber=?");
2413 $sth->execute($itemnumber);
2414 my $data = $sth->fetchrow_hashref;
2415 return unless $data;
2416 $data->{issuedate
} = dt_from_string
($data->{issuedate
}, 'sql');
2417 $data->{issuedate
}->truncate(to
=> 'minute');
2418 $data->{date_due
} = dt_from_string
($data->{date_due
}, 'sql');
2419 $data->{date_due
}->truncate(to
=> 'minute');
2420 my $dt = DateTime
->now( time_zone
=> C4
::Context
->tz)->truncate( to
=> 'minute');
2421 $data->{'overdue'} = DateTime
->compare($data->{'date_due'}, $dt ) == -1 ?
1 : 0;
2427 $issue = GetOpenIssue( $itemnumber );
2429 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2431 C<$itemnumber> is the item's itemnumber
2438 my ( $itemnumber ) = @_;
2439 return unless $itemnumber;
2440 my $dbh = C4
::Context
->dbh;
2441 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2442 $sth->execute( $itemnumber );
2443 return $sth->fetchrow_hashref();
2449 $issues = GetIssues({}); # return all issues!
2450 $issues = GetIssues({ borrowernumber => $borrowernumber, biblionumber => $biblionumber });
2452 Returns all pending issues that match given criteria.
2453 Returns a arrayref or undef if an error occurs.
2455 Allowed criteria are:
2459 =item * borrowernumber
2461 =item * biblionumber
2470 my ($criteria) = @_;
2474 my @allowed = qw(borrowernumber biblionumber itemnumber);
2475 foreach (@allowed) {
2476 if (defined $criteria->{$_}) {
2479 value
=> $criteria->{$_},
2484 # Do we need to join other tables ?
2486 if (defined $criteria->{biblionumber
}) {
2493 $where = "WHERE " . join(' AND ', map { "$_->{field} = ?" } @filters);
2499 if (defined $join{items
}) {
2501 LEFT JOIN items ON (issues.itemnumber = items.itemnumber)
2507 my $dbh = C4
::Context
->dbh;
2508 my $sth = $dbh->prepare($query);
2509 my $rv = $sth->execute(map { $_->{value
} } @filters);
2511 return $rv ?
$sth->fetchall_arrayref({}) : undef;
2514 =head2 GetItemIssues
2516 $issues = &GetItemIssues($itemnumber, $history);
2518 Returns patrons that have issued a book
2520 C<$itemnumber> is the itemnumber
2521 C<$history> is false if you just want the current "issuer" (if any)
2522 and true if you want issues history from old_issues also.
2524 Returns reference to an array of hashes
2529 my ( $itemnumber, $history ) = @_;
2531 my $today = DateTime
->now( time_zome
=> C4
::Context
->tz); # get today date
2532 $today->truncate( to
=> 'minute' );
2533 my $sql = "SELECT * FROM issues
2534 JOIN borrowers USING (borrowernumber)
2535 JOIN items USING (itemnumber)
2536 WHERE issues.itemnumber = ? ";
2539 SELECT * FROM old_issues
2540 LEFT JOIN borrowers USING (borrowernumber)
2541 JOIN items USING (itemnumber)
2542 WHERE old_issues.itemnumber = ? ";
2544 $sql .= "ORDER BY date_due DESC";
2545 my $sth = C4
::Context
->dbh->prepare($sql);
2547 $sth->execute($itemnumber, $itemnumber);
2549 $sth->execute($itemnumber);
2551 my $results = $sth->fetchall_arrayref({});
2552 foreach (@
$results) {
2553 my $date_due = dt_from_string
($_->{date_due
},'sql');
2554 $date_due->truncate( to
=> 'minute' );
2556 $_->{overdue
} = (DateTime
->compare($date_due, $today) == -1) ?
1 : 0;
2561 =head2 GetBiblioIssues
2563 $issues = GetBiblioIssues($biblionumber);
2565 this function get all issues from a biblionumber.
2568 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2569 tables issues and the firstname,surname & cardnumber from borrowers.
2573 sub GetBiblioIssues
{
2574 my $biblionumber = shift;
2575 return unless $biblionumber;
2576 my $dbh = C4
::Context
->dbh;
2578 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2580 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2581 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2582 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2583 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2584 WHERE biblio.biblionumber = ?
2586 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2588 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2589 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2590 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2591 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2592 WHERE biblio.biblionumber = ?
2595 my $sth = $dbh->prepare($query);
2596 $sth->execute($biblionumber, $biblionumber);
2599 while ( my $data = $sth->fetchrow_hashref ) {
2600 push @issues, $data;
2605 =head2 GetUpcomingDueIssues
2607 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2611 sub GetUpcomingDueIssues
{
2614 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2615 my $dbh = C4
::Context
->dbh;
2617 my $statement = <<END_SQL;
2618 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2620 LEFT JOIN items USING (itemnumber)
2621 LEFT OUTER JOIN branches USING (branchcode)
2622 WHERE returndate is NULL
2623 HAVING days_until_due >= 0 AND days_until_due <= ?
2626 my @bind_parameters = ( $params->{'days_in_advance'} );
2628 my $sth = $dbh->prepare( $statement );
2629 $sth->execute( @bind_parameters );
2630 my $upcoming_dues = $sth->fetchall_arrayref({});
2632 return $upcoming_dues;
2635 =head2 CanBookBeRenewed
2637 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2639 Find out whether a borrowed item may be renewed.
2641 C<$borrowernumber> is the borrower number of the patron who currently
2642 has the item on loan.
2644 C<$itemnumber> is the number of the item to renew.
2646 C<$override_limit>, if supplied with a true value, causes
2647 the limit on the number of times that the loan can be renewed
2648 (as controlled by the item type) to be ignored. Overriding also allows
2649 to renew sooner than "No renewal before" and to manually renew loans
2650 that are automatically renewed.
2652 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2653 item must currently be on loan to the specified borrower; renewals
2654 must be allowed for the item's type; and the borrower must not have
2655 already renewed the loan. $error will contain the reason the renewal can not proceed
2659 sub CanBookBeRenewed {
2660 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2662 my $dbh = C4::Context->dbh;
2665 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2666 my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2667 return ( 0, 'onsite_checkout' ) if $itemissue->{onsite_checkout};
2669 $borrowernumber ||= $itemissue->{borrowernumber};
2670 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2673 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2675 # This item can fill one or more unfilled reserve, can those unfilled reserves
2676 # all be filled by other available items?
2678 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2680 my $schema = Koha::Database->new()->schema();
2682 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2684 # There is an item level hold on this item, no other item can fill the hold
2689 # Get all other items that could possibly fill reserves
2690 my @itemnumbers = $schema->resultset('Item')->search(
2692 biblionumber => $resrec->{biblionumber},
2694 -not => { itemnumber => $itemnumber }
2696 { columns => 'itemnumber' }
2697 )->get_column('itemnumber')->all();
2699 # Get all other reserves that could have been filled by this item
2700 my @borrowernumbers;
2702 my ( $reserve_found, $reserve, undef ) =
2703 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2705 if ($reserve_found) {
2706 push( @borrowernumbers, $reserve->{borrowernumber} );
2713 # If the count of the union of the lists of reservable items for each borrower
2714 # is equal or greater than the number of borrowers, we know that all reserves
2715 # can be filled with available items. We can get the union of the sets simply
2716 # by pushing all the elements onto an array and removing the duplicates.
2718 foreach my $b (@borrowernumbers) {
2719 my ($borr) = C4::Members::GetMemberDetails($b);
2720 foreach my $i (@itemnumbers) {
2721 my $item = GetItem($i);
2722 if ( IsAvailableForItemLevelRequest( $item, $borr )
2723 && CanItemBeReserved( $b, $i )
2724 && !IsItemOnHoldAndFound($i) )
2726 push( @reservable, $i );
2731 @reservable = uniq(@reservable);
2733 if ( @reservable >= @borrowernumbers ) {
2739 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2741 return ( 1, undef ) if $override_limit;
2743 my $branchcode = _GetCircControlBranch( $item, $borrower );
2745 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2747 return ( 0, "too_many" )
2748 if $issuingrule->{renewalsallowed} <= $itemissue->{renewals};
2750 if ( $issuingrule->{norenewalbefore} ) {
2752 # Get current time and add norenewalbefore.
2753 # If this is smaller than date_due, it's too soon for renewal.
2755 DateTime->now( time_zone => C4::Context->tz() )->add(
2756 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore}
2757 ) < $itemissue->{date_due}
2760 return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2761 return ( 0, "too_soon" );
2765 return ( 0, "auto_renew" ) if $itemissue->{auto_renew};
2766 return ( 1, undef );
2771 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2775 C<$borrowernumber> is the borrower number of the patron who currently
2778 C<$itemnumber> is the number of the item to renew.
2780 C<$branch> is the library where the renewal took place (if any).
2781 The library that controls the circ policies for the renewal is retrieved from the issues record.
2783 C<$datedue> can be a C4::Dates object used to set the due date.
2785 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2786 this parameter is not supplied, lastreneweddate is set to the current date.
2788 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2789 from the book's item type.
2794 my $borrowernumber = shift;
2795 my $itemnumber = shift or return;
2797 my $datedue = shift;
2798 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2800 my $item = GetItem($itemnumber) or return;
2801 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2803 my $dbh = C4::Context->dbh;
2805 # Find the issues record for this book
2807 $dbh->prepare("SELECT * FROM issues WHERE itemnumber = ?");
2808 $sth->execute( $itemnumber );
2809 my $issuedata = $sth->fetchrow_hashref;
2811 return unless ( $issuedata );
2813 $borrowernumber ||= $issuedata->{borrowernumber};
2815 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2816 carp 'Invalid date passed to AddRenewal.';
2820 # If the due date wasn't specified, calculate it by adding the
2821 # book's loan length to today's date or the current due date
2822 # based on the value of the RenewalPeriodBase syspref.
2825 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2826 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2828 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2829 dt_from_string( $issuedata->{date_due} ) :
2830 DateTime->now( time_zone => C4::Context->tz());
2831 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2834 # Update the issues record to have the new due date, and a new count
2835 # of how many times it has been renewed.
2836 my $renews = $issuedata->{'renewals'} + 1;
2837 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2838 WHERE borrowernumber=?
2842 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2844 # Update the renewal count on the item, and tell zebra to reindex
2845 $renews = $biblio->{'renewals'} + 1;
2846 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2848 # Charge a new rental fee, if applicable?
2849 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2850 if ( $charge > 0 ) {
2851 my $accountno = getnextacctno( $borrowernumber );
2852 my $item = GetBiblioFromItemNumber($itemnumber);
2854 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2855 $sth = $dbh->prepare(
2856 "INSERT INTO accountlines
2857 (date, borrowernumber, accountno, amount, manager_id,
2858 description,accounttype, amountoutstanding, itemnumber)
2859 VALUES (now(),?,?,?,?,?,?,?,?)"
2861 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2862 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2863 'Rent', $charge, $itemnumber );
2866 # Send a renewal slip according to checkout alert preferencei
2867 if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2868 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2869 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2871 branchcode => $branch,
2872 categorycode => $borrower->{categorycode},
2873 item_type => $item->{itype},
2874 notification => 'CHECKOUT',
2876 if ($circulation_alert->is_enabled_for(\%conditions)) {
2877 SendCirculationAlert({
2880 borrower => $borrower,
2886 # Remove any OVERDUES related debarment if the borrower has no overdues
2887 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2888 if ( $borrowernumber
2889 && $borrower->{'debarred'}
2890 && !C4::Members::HasOverdues( $borrowernumber )
2891 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2893 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2897 UpdateStats({branch => $branch,
2900 itemnumber => $itemnumber,
2901 itemtype => $item->{itype},
2902 borrowernumber => $borrowernumber,
2903 ccode => $item->{'ccode'}}
2909 # check renewal status
2910 my ( $bornum, $itemno ) = @_;
2911 my $dbh = C4::Context->dbh;
2913 my $renewsallowed = 0;
2916 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2917 my $item = GetItem($itemno);
2919 # Look in the issues table for this item, lent to this borrower,
2920 # and not yet returned.
2922 # FIXME - I think this function could be redone to use only one SQL call.
2923 my $sth = $dbh->prepare(
2924 "select * from issues
2925 where (borrowernumber = ?)
2926 and (itemnumber = ?)"
2928 $sth->execute( $bornum, $itemno );
2929 my $data = $sth->fetchrow_hashref;
2930 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2931 # $item and $borrower should be calculated
2932 my $branchcode = _GetCircControlBranch($item, $borrower);
2934 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2936 $renewsallowed = $issuingrule->{'renewalsallowed'};
2937 $renewsleft = $renewsallowed - $renewcount;
2938 if($renewsleft < 0){ $renewsleft = 0; }
2939 return ( $renewcount, $renewsallowed, $renewsleft );
2942 =head2 GetSoonestRenewDate
2944 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2946 Find out the soonest possible renew date of a borrowed item.
2948 C<$borrowernumber> is the borrower number of the patron who currently
2949 has the item on loan.
2951 C<$itemnumber> is the number of the item to renew.
2953 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2954 renew date, based on the value "No renewal before" of the applicable
2955 issuing rule. Returns the current date if the item can already be
2956 renewed, and returns undefined if the borrower, loan, or item
2961 sub GetSoonestRenewDate {
2962 my ( $borrowernumber, $itemnumber ) = @_;
2964 my $dbh = C4::Context->dbh;
2966 my $item = GetItem($itemnumber) or return;
2967 my $itemissue = GetItemIssue($itemnumber) or return;
2969 $borrowernumber ||= $itemissue->{borrowernumber};
2970 my $borrower = C4::Members::GetMemberDetails($borrowernumber)
2973 my $branchcode = _GetCircControlBranch( $item, $borrower );
2975 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2977 my $now = DateTime->now( time_zone => C4::Context->tz() );
2979 if ( $issuingrule->{norenewalbefore} ) {
2980 my $soonestrenewal =
2981 $itemissue->{date_due}->subtract(
2982 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore} );
2984 $soonestrenewal = $now > $soonestrenewal ? $now : $soonestrenewal;
2985 return $soonestrenewal;
2990 =head2 GetIssuingCharges
2992 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2994 Calculate how much it would cost for a given patron to borrow a given
2995 item, including any applicable discounts.
2997 C<$itemnumber> is the item number of item the patron wishes to borrow.
2999 C<$borrowernumber> is the patron's borrower number.
3001 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3002 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3007 sub GetIssuingCharges {
3009 # calculate charges due
3010 my ( $itemnumber, $borrowernumber ) = @_;
3012 my $dbh = C4::Context->dbh;
3015 # Get the book's item type and rental charge (via its biblioitem).
3016 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3017 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3018 $charge_query .= (C4::Context->preference('item-level_itypes'))
3019 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3020 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3022 $charge_query .= ' WHERE items.itemnumber =?';
3024 my $sth = $dbh->prepare($charge_query);
3025 $sth->execute($itemnumber);
3026 if ( my $item_data = $sth->fetchrow_hashref ) {
3027 $item_type = $item_data->{itemtype};
3028 $charge = $item_data->{rentalcharge};
3029 my $branch = C4::Branch::mybranch();
3030 my $discount_query = q|SELECT rentaldiscount,
3031 issuingrules.itemtype, issuingrules.branchcode
3033 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3034 WHERE borrowers.borrowernumber = ?
3035 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3036 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3037 my $discount_sth = $dbh->prepare($discount_query);
3038 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3039 my $discount_rules = $discount_sth->fetchall_arrayref({});
3040 if (@{$discount_rules}) {
3041 # We may have multiple rules so get the most specific
3042 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3043 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3047 return ( $charge, $item_type );
3050 # Select most appropriate discount rule from those returned
3051 sub _get_discount_from_rule {
3052 my ($rules_ref, $branch, $itemtype) = @_;
3055 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3056 $discount = $rules_ref->[0]->{rentaldiscount};
3057 return (defined $discount) ? $discount : 0;
3059 # could have up to 4 does one match $branch and $itemtype
3060 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3062 $discount = $d[0]->{rentaldiscount};
3063 return (defined $discount) ? $discount : 0;
3065 # do we have item type + all branches
3066 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype
} eq $itemtype } @
{$rules_ref};
3068 $discount = $d[0]->{rentaldiscount
};
3069 return (defined $discount) ?
$discount : 0;
3071 # do we all item types + this branch
3072 @d = grep { $_->{branchcode
} eq $branch && $_->{itemtype
} eq q{*} } @
{$rules_ref};
3074 $discount = $d[0]->{rentaldiscount
};
3075 return (defined $discount) ?
$discount : 0;
3077 # so all and all (surely we wont get here)
3078 @d = grep { $_->{branchcode
} eq q{*} && $_->{itemtype
} eq q{*} } @
{$rules_ref};
3080 $discount = $d[0]->{rentaldiscount
};
3081 return (defined $discount) ?
$discount : 0;
3087 =head2 AddIssuingCharge
3089 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3093 sub AddIssuingCharge
{
3094 my ( $itemnumber, $borrowernumber, $charge ) = @_;
3095 my $dbh = C4
::Context
->dbh;
3096 my $nextaccntno = getnextacctno
( $borrowernumber );
3098 $manager_id = C4
::Context
->userenv->{'number'} if C4
::Context
->userenv;
3100 INSERT INTO accountlines
3101 (borrowernumber, itemnumber, accountno,
3102 date, amount, description, accounttype,
3103 amountoutstanding, manager_id)
3104 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3106 my $sth = $dbh->prepare($query);
3107 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3112 GetTransfers($itemnumber);
3117 my ($itemnumber) = @_;
3119 my $dbh = C4
::Context
->dbh;
3125 FROM branchtransfers
3126 WHERE itemnumber = ?
3127 AND datearrived IS NULL
3129 my $sth = $dbh->prepare($query);
3130 $sth->execute($itemnumber);
3131 my @row = $sth->fetchrow_array();
3135 =head2 GetTransfersFromTo
3137 @results = GetTransfersFromTo($frombranch,$tobranch);
3139 Returns the list of pending transfers between $from and $to branch
3143 sub GetTransfersFromTo
{
3144 my ( $frombranch, $tobranch ) = @_;
3145 return unless ( $frombranch && $tobranch );
3146 my $dbh = C4
::Context
->dbh;
3148 SELECT itemnumber,datesent,frombranch
3149 FROM branchtransfers
3152 AND datearrived IS NULL
3154 my $sth = $dbh->prepare($query);
3155 $sth->execute( $frombranch, $tobranch );
3158 while ( my $data = $sth->fetchrow_hashref ) {
3159 push @gettransfers, $data;
3161 return (@gettransfers);
3164 =head2 DeleteTransfer
3166 &DeleteTransfer($itemnumber);
3170 sub DeleteTransfer
{
3171 my ($itemnumber) = @_;
3172 return unless $itemnumber;
3173 my $dbh = C4
::Context
->dbh;
3174 my $sth = $dbh->prepare(
3175 "DELETE FROM branchtransfers
3177 AND datearrived IS NULL "
3179 return $sth->execute($itemnumber);
3182 =head2 AnonymiseIssueHistory
3184 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
3186 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
3187 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
3189 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
3190 setting (force delete).
3192 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
3196 sub AnonymiseIssueHistory
{
3198 my $borrowernumber = shift;
3199 my $dbh = C4
::Context
->dbh;
3202 SET borrowernumber = ?
3203 WHERE returndate < ?
3204 AND borrowernumber IS NOT NULL
3207 # The default of 0 does not work due to foreign key constraints
3208 # The anonymisation should not fail quietly if AnonymousPatron is not a valid entry
3209 # Set it to undef (NULL)
3210 my $anonymouspatron = C4
::Context
->preference('AnonymousPatron') || undef;
3211 my @bind_params = ($anonymouspatron, $date);
3212 if (defined $borrowernumber) {
3213 $query .= " AND borrowernumber = ?";
3214 push @bind_params, $borrowernumber;
3216 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
3218 my $sth = $dbh->prepare($query);
3219 $sth->execute(@bind_params);
3220 my $anonymisation_err = $dbh->err;
3221 my $rows_affected = $sth->rows; ### doublecheck row count return function
3222 return ($rows_affected, $anonymisation_err);
3225 =head2 SendCirculationAlert
3227 Send out a C<check-in> or C<checkout> alert using the messaging system.
3235 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3239 Hashref of information about the item being checked in or out.
3243 Hashref of information about the borrower of the item.
3247 The branchcode from where the checkout or check-in took place.
3253 SendCirculationAlert({
3256 borrower => $borrower,
3262 sub SendCirculationAlert
{
3264 my ($type, $item, $borrower, $branch) =
3265 ($opts->{type
}, $opts->{item
}, $opts->{borrower
}, $opts->{branch
});
3266 my %message_name = (
3267 CHECKIN
=> 'Item_Check_in',
3268 CHECKOUT
=> 'Item_Checkout',
3269 RENEWAL
=> 'Item_Checkout',
3271 my $borrower_preferences = C4
::Members
::Messaging
::GetMessagingPreferences
({
3272 borrowernumber
=> $borrower->{borrowernumber
},
3273 message_name
=> $message_name{$type},
3275 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ?
'issues' : 'old_issues';
3277 my @transports = keys %{ $borrower_preferences->{transports
} };
3278 # warn "no transports" unless @transports;
3280 # warn "transport: $_";
3281 my $message = C4
::Message
->find_last_message($borrower, $type, $_);
3283 #warn "create new message";
3284 my $letter = C4
::Letters
::GetPreparedLetter
(
3285 module
=> 'circulation',
3286 letter_code
=> $type,
3287 branchcode
=> $branch,
3288 message_transport_type
=> $_,
3290 $issues_table => $item->{itemnumber
},
3291 'items' => $item->{itemnumber
},
3292 'biblio' => $item->{biblionumber
},
3293 'biblioitems' => $item->{biblionumber
},
3294 'borrowers' => $borrower,
3295 'branches' => $branch,
3298 C4
::Message
->enqueue($letter, $borrower, $_);
3300 #warn "append to old message";
3301 my $letter = C4
::Letters
::GetPreparedLetter
(
3302 module
=> 'circulation',
3303 letter_code
=> $type,
3304 branchcode
=> $branch,
3305 message_transport_type
=> $_,
3307 $issues_table => $item->{itemnumber
},
3308 'items' => $item->{itemnumber
},
3309 'biblio' => $item->{biblionumber
},
3310 'biblioitems' => $item->{biblionumber
},
3311 'borrowers' => $borrower,
3312 'branches' => $branch,
3315 $message->append($letter);
3323 =head2 updateWrongTransfer
3325 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3327 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
3331 sub updateWrongTransfer
{
3332 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3333 my $dbh = C4
::Context
->dbh;
3334 # first step validate the actual line of transfert .
3337 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3339 $sth->execute($FromLibrary,$itemNumber);
3341 # second step create a new line of branchtransfer to the right location .
3342 ModItemTransfer
($itemNumber, $FromLibrary, $waitingAtLibrary);
3344 #third step changing holdingbranch of item
3345 UpdateHoldingbranch
($FromLibrary,$itemNumber);
3348 =head2 UpdateHoldingbranch
3350 $items = UpdateHoldingbranch($branch,$itmenumber);
3352 Simple methode for updating hodlingbranch in items BDD line
3356 sub UpdateHoldingbranch
{
3357 my ( $branch,$itemnumber ) = @_;
3358 ModItem
({ holdingbranch
=> $branch }, undef, $itemnumber);
3363 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3365 this function calculates the due date given the start date and configured circulation rules,
3366 checking against the holidays calendar as per the 'useDaysMode' syspref.
3367 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
3368 C<$itemtype> = itemtype code of item in question
3369 C<$branch> = location whose calendar to use
3370 C<$borrower> = Borrower object
3371 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3376 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3380 # loanlength now a href
3382 GetLoanLength
( $borrower->{'categorycode'}, $itemtype, $branch );
3384 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod
} )
3390 if (ref $startdate ne 'DateTime' ) {
3391 $datedue = dt_from_string
($datedue);
3393 $datedue = $startdate->clone;
3397 DateTime
->now( time_zone
=> C4
::Context
->tz() )
3398 ->truncate( to
=> 'minute' );
3402 # calculate the datedue as normal
3403 if ( C4
::Context
->preference('useDaysMode') eq 'Days' )
3404 { # ignoring calendar
3405 if ( $loanlength->{lengthunit
} eq 'hours' ) {
3406 $datedue->add( hours
=> $loanlength->{$length_key} );
3408 $datedue->add( days
=> $loanlength->{$length_key} );
3409 $datedue->set_hour(23);
3410 $datedue->set_minute(59);
3414 if ($loanlength->{lengthunit
} eq 'hours') {
3415 $dur = DateTime
::Duration
->new( hours
=> $loanlength->{$length_key});
3418 $dur = DateTime
::Duration
->new( days
=> $loanlength->{$length_key});
3420 my $calendar = Koha
::Calendar
->new( branchcode
=> $branch );
3421 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit
} );
3422 if ($loanlength->{lengthunit
} eq 'days') {
3423 $datedue->set_hour(23);
3424 $datedue->set_minute(59);
3428 # if Hard Due Dates are used, retreive them and apply as necessary
3429 my ( $hardduedate, $hardduedatecompare ) =
3430 GetHardDueDate
( $borrower->{'categorycode'}, $itemtype, $branch );
3431 if ($hardduedate) { # hardduedates are currently dates
3432 $hardduedate->truncate( to
=> 'minute' );
3433 $hardduedate->set_hour(23);
3434 $hardduedate->set_minute(59);
3435 my $cmp = DateTime
->compare( $hardduedate, $datedue );
3437 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3438 # if the calculated date is before the 'after' Hard Due Date (floor), override
3439 # if the hard due date is set to 'exactly', overrride
3440 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3441 $datedue = $hardduedate->clone;
3444 # in all other cases, keep the date due as it is
3448 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3449 if ( C4
::Context
->preference('ReturnBeforeExpiry') ) {
3450 my $expiry_dt = dt_from_string
( $borrower->{dateexpiry
}, 'iso', 'floating');
3451 if( $expiry_dt ) { #skip empty expiry date..
3452 $expiry_dt->set( hour
=> 23, minute
=> 59);
3453 my $d1= $datedue->clone->set_time_zone('floating');
3454 if ( DateTime
->compare( $d1, $expiry_dt ) == 1 ) {
3455 $datedue = $expiry_dt->clone->set_time_zone( C4
::Context
->tz );
3464 =head2 CheckRepeatableHolidays
3466 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3468 This function checks if the date due is a repeatable holiday
3470 C<$date_due> = returndate calculate with no day check
3471 C<$itemnumber> = itemnumber
3472 C<$branchcode> = localisation of issue
3476 sub CheckRepeatableHolidays
{
3477 my($itemnumber,$week_day,$branchcode)=@_;
3478 my $dbh = C4
::Context
->dbh;
3479 my $query = qq|SELECT count
(*)
3480 FROM repeatable_holidays
3483 my $sth = $dbh->prepare($query);
3484 $sth->execute($branchcode,$week_day);
3485 my $result=$sth->fetchrow;
3490 =head2 CheckSpecialHolidays
3492 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3494 This function check if the date is a special holiday
3496 C<$years> = the years of datedue
3497 C<$month> = the month of datedue
3498 C<$day> = the day of datedue
3499 C<$itemnumber> = itemnumber
3500 C<$branchcode> = localisation of issue
3504 sub CheckSpecialHolidays
{
3505 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3506 my $dbh = C4
::Context
->dbh;
3507 my $query=qq|SELECT count
(*)
3508 FROM
`special_holidays`
3514 my $sth = $dbh->prepare($query);
3515 $sth->execute($years,$month,$day,$branchcode);
3516 my $countspecial=$sth->fetchrow ;
3517 return $countspecial;
3520 =head2 CheckRepeatableSpecialHolidays
3522 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3524 This function check if the date is a repeatble special holidays
3526 C<$month> = the month of datedue
3527 C<$day> = the day of datedue
3528 C<$itemnumber> = itemnumber
3529 C<$branchcode> = localisation of issue
3533 sub CheckRepeatableSpecialHolidays
{
3534 my ($month,$day,$itemnumber,$branchcode) = @_;
3535 my $dbh = C4
::Context
->dbh;
3536 my $query=qq|SELECT count
(*)
3537 FROM
`repeatable_holidays`
3542 my $sth = $dbh->prepare($query);
3543 $sth->execute($month,$day,$branchcode);
3544 my $countspecial=$sth->fetchrow ;
3545 return $countspecial;
3550 sub CheckValidBarcode
{
3552 my $dbh = C4
::Context
->dbh;
3553 my $query=qq|SELECT count
(*)
3557 my $sth = $dbh->prepare($query);
3558 $sth->execute($barcode);
3559 my $exist=$sth->fetchrow ;
3563 =head2 IsBranchTransferAllowed
3565 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3567 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3571 sub IsBranchTransferAllowed
{
3572 my ( $toBranch, $fromBranch, $code ) = @_;
3574 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3576 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3577 my $dbh = C4
::Context
->dbh;
3579 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3580 $sth->execute( $toBranch, $fromBranch, $code );
3581 my $limit = $sth->fetchrow_hashref();
3583 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3584 if ( $limit->{'limitId'} ) {
3591 =head2 CreateBranchTransferLimit
3593 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3595 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3599 sub CreateBranchTransferLimit
{
3600 my ( $toBranch, $fromBranch, $code ) = @_;
3601 return unless defined($toBranch) && defined($fromBranch);
3602 my $limitType = C4
::Context
->preference("BranchTransferLimitsType");
3604 my $dbh = C4
::Context
->dbh;
3606 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3607 return $sth->execute( $code, $toBranch, $fromBranch );
3610 =head2 DeleteBranchTransferLimits
3612 my $result = DeleteBranchTransferLimits($frombranch);
3614 Deletes all the library transfer limits for one library. Returns the
3615 number of limits deleted, 0e0 if no limits were deleted, or undef if
3616 no arguments are supplied.
3620 sub DeleteBranchTransferLimits
{
3622 return unless defined $branch;
3623 my $dbh = C4
::Context
->dbh;
3624 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3625 return $sth->execute($branch);
3629 my ( $borrowernumber, $itemnum ) = @_;
3631 MarkIssueReturned
( $borrowernumber, $itemnum );
3632 my $borrower = C4
::Members
::GetMember
( 'borrowernumber'=>$borrowernumber );
3633 my $item = C4
::Items
::GetItem
( $itemnum );
3634 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ?
$item->{'paidfor'}.' / ' : q{};
3635 my @datearr = localtime(time);
3636 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3637 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3638 ModItem
({ paidfor
=> $old_note."Paid for by $bor $date" }, undef, $itemnum);
3643 my ($itemnumber, $mark_returned) = @_;
3645 my $dbh = C4
::Context
->dbh();
3646 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3648 JOIN items USING (itemnumber)
3649 JOIN biblio USING (biblionumber)
3650 WHERE issues.itemnumber=?");
3651 $sth->execute($itemnumber);
3652 my $issues=$sth->fetchrow_hashref();
3654 # If a borrower lost the item, add a replacement cost to the their record
3655 if ( my $borrowernumber = $issues->{borrowernumber
} ){
3656 my $borrower = C4
::Members
::GetMemberDetails
( $borrowernumber );
3658 if (C4
::Context
->preference('WhenLostForgiveFine')){
3659 my $fix = _FixOverduesOnReturn
($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3660 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3662 if (C4
::Context
->preference('WhenLostChargeReplacementFee')){
3663 C4
::Accounts
::chargelostitem
($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3664 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3665 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3668 MarkIssueReturned
($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3672 sub GetOfflineOperations
{
3673 my $dbh = C4
::Context
->dbh;
3674 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3675 $sth->execute(C4
::Context
->userenv->{'branch'});
3676 my $results = $sth->fetchall_arrayref({});
3680 sub GetOfflineOperation
{
3681 my $operationid = shift;
3682 return unless $operationid;
3683 my $dbh = C4
::Context
->dbh;
3684 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3685 $sth->execute( $operationid );
3686 return $sth->fetchrow_hashref;
3689 sub AddOfflineOperation
{
3690 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3691 my $dbh = C4
::Context
->dbh;
3692 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3693 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3697 sub DeleteOfflineOperation
{
3698 my $dbh = C4
::Context
->dbh;
3699 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3700 $sth->execute( shift );
3704 sub ProcessOfflineOperation
{
3705 my $operation = shift;
3708 if ( $operation->{action
} eq 'return' ) {
3709 $report = ProcessOfflineReturn
( $operation );
3710 } elsif ( $operation->{action
} eq 'issue' ) {
3711 $report = ProcessOfflineIssue
( $operation );
3712 } elsif ( $operation->{action
} eq 'payment' ) {
3713 $report = ProcessOfflinePayment
( $operation );
3716 DeleteOfflineOperation
( $operation->{operationid
} ) if $operation->{operationid
};
3721 sub ProcessOfflineReturn
{
3722 my $operation = shift;
3724 my $itemnumber = C4
::Items
::GetItemnumberFromBarcode
( $operation->{barcode
} );
3726 if ( $itemnumber ) {
3727 my $issue = GetOpenIssue
( $itemnumber );
3730 $issue->{borrowernumber
},
3733 $operation->{timestamp
},
3736 { renewals
=> 0, onloan
=> undef },
3737 $issue->{'biblionumber'},
3742 return "Item not issued.";
3745 return "Item not found.";
3749 sub ProcessOfflineIssue
{
3750 my $operation = shift;
3752 my $borrower = C4
::Members
::GetMemberDetails
( undef, $operation->{cardnumber
} ); # Get borrower from operation cardnumber
3754 if ( $borrower->{borrowernumber
} ) {
3755 my $itemnumber = C4
::Items
::GetItemnumberFromBarcode
( $operation->{barcode
} );
3756 unless ($itemnumber) {
3757 return "Barcode not found.";
3759 my $issue = GetOpenIssue
( $itemnumber );
3761 if ( $issue and ( $issue->{borrowernumber
} ne $borrower->{borrowernumber
} ) ) { # Item already issued to another borrower, mark it returned
3763 $issue->{borrowernumber
},
3766 $operation->{timestamp
},
3771 $operation->{'barcode'},
3774 $operation->{timestamp
},
3779 return "Borrower not found.";
3783 sub ProcessOfflinePayment
{
3784 my $operation = shift;
3786 my $borrower = C4
::Members
::GetMemberDetails
( undef, $operation->{cardnumber
} ); # Get borrower from operation cardnumber
3787 my $amount = $operation->{amount
};
3789 recordpayment
( $borrower->{borrowernumber
}, $amount );
3797 TransferSlip($user_branch, $itemnumber, $to_branch)
3799 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3804 my ($branch, $itemnumber, $to_branch) = @_;
3806 my $item = GetItem
( $itemnumber )
3809 my $pulldate = C4
::Dates
->new();
3811 return C4
::Letters
::GetPreparedLetter
(
3812 module
=> 'circulation',
3813 letter_code
=> 'TRANSFERSLIP',
3814 branchcode
=> $branch,
3816 'branches' => $to_branch,
3817 'biblio' => $item->{biblionumber
},
3823 =head2 CheckIfIssuedToPatron
3825 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3827 Return 1 if any record item is issued to patron, otherwise return 0
3831 sub CheckIfIssuedToPatron
{
3832 my ($borrowernumber, $biblionumber) = @_;
3834 my $dbh = C4
::Context
->dbh;
3836 SELECT COUNT
(*) FROM issues
3837 LEFT JOIN items ON items
.itemnumber
= issues
.itemnumber
3838 WHERE items
.biblionumber
= ?
3839 AND issues
.borrowernumber
= ?
3841 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3842 return 1 if $is_issued;
3848 IsItemIssued( $itemnumber )
3850 Return 1 if the item is on loan, otherwise return 0
3855 my $itemnumber = shift;
3856 my $dbh = C4
::Context
->dbh;
3857 my $sth = $dbh->prepare(q{
3860 WHERE itemnumber = ?
3862 $sth->execute($itemnumber);
3863 return $sth->fetchrow;
3866 =head2 GetAgeRestriction
3868 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3869 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3871 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as he is older or as old as the agerestriction }
3872 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3874 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3875 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3876 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3877 Negative days mean the borrower has gone past the age restriction age.
3881 sub GetAgeRestriction
{
3882 my ($record_restrictions, $borrower) = @_;
3883 my $markers = C4
::Context
->preference('AgeRestrictionMarker');
3885 # Split $record_restrictions to something like FSK 16 or PEGI 6
3886 my @values = split ' ', uc($record_restrictions);
3887 return unless @values;
3889 # Search first occurence of one of the markers
3890 my @markers = split /\|/, uc($markers);
3891 return unless @markers;
3894 my $restriction_year = 0;
3895 for my $value (@values) {
3897 for my $marker (@markers) {
3898 $marker =~ s/^\s+//; #remove leading spaces
3899 $marker =~ s/\s+$//; #remove trailing spaces
3900 if ( $marker eq $value ) {
3901 if ( $index <= $#values ) {
3902 $restriction_year += $values[$index];
3906 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3908 # Perhaps it is something like "K16" (as in Finland)
3909 $restriction_year += $1;
3913 last if ( $restriction_year > 0 );
3916 #Check if the borrower is age restricted for this material and for how long.
3917 if ($restriction_year && $borrower) {
3918 if ( $borrower->{'dateofbirth'} ) {
3919 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
3920 $alloweddate[0] += $restriction_year;
3922 #Prevent runime eror on leap year (invalid date)
3923 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
3924 $alloweddate[2] = 28;
3927 #Get how many days the borrower has to reach the age restriction
3928 my $daysToAgeRestriction = Date_to_Days
(@alloweddate) - Date_to_Days
(Today
);
3929 #Negative days means the borrower went past the age restriction age
3930 return ($restriction_year, $daysToAgeRestriction);
3934 return ($restriction_year);
3943 Koha Development Team <http://koha-community.org/>