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
33 use C4::ItemCirculationAlertPreference;
36 use C4::Branch; # GetBranches
37 use C4::Log; # logaction
39 GetAuthorisedValueByCode
41 GetKohaAuthorisedValueLib
43 use C4::Overdues qw(CalcFine UpdateFine get_chargeable_units);
44 use C4::RotatingCollections qw(GetCollectionItemBranches);
45 use Algorithm::CheckDigits;
52 use Koha::Patron::Debarments;
57 use List::MoreUtils qw( uniq );
58 use Scalar::Util qw( looks_like_number );
68 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
74 # FIXME subs that should probably be elsewhere
79 &GetPendingOnSiteCheckouts
82 # subs to deal with issuing a book
94 &GetBranchBorrowerCircRule
98 &AnonymiseIssueHistory
99 &CheckIfIssuedToPatron
104 # subs to deal with returns
110 # subs to deal with transfers
117 &IsBranchTransferAllowed
118 &CreateBranchTransferLimit
119 &DeleteBranchTransferLimits
123 # subs to deal with offline circulation
125 &GetOfflineOperations
128 &DeleteOfflineOperation
129 &ProcessOfflineOperation
135 C4::Circulation - Koha circulation module
143 The functions in this module deal with circulation, issues, and
144 returns, as well as general information about the library.
145 Also deals with stocktaking.
151 $str = &barcodedecode($barcode, [$filter]);
153 Generic filter function for barcode string.
154 Called on every circ if the System Pref itemBarcodeInputFilter is set.
155 Will do some manipulation of the barcode for systems that deliver a barcode
156 to circulation.pl that differs from the barcode stored for the item.
157 For proper functioning of this filter, calling the function on the
158 correct barcode string (items.barcode) should return an unaltered barcode.
160 The optional $filter argument is to allow for testing or explicit
161 behavior that ignores the System Pref. Valid values are the same as the
166 # FIXME -- the &decode fcn below should be wrapped into this one.
167 # FIXME -- these plugins should be moved out of Circulation.pm
170 my ($barcode, $filter) = @_;
171 my $branch = C4::Branch::mybranch();
172 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
173 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
174 if ($filter eq 'whitespace') {
176 } elsif ($filter eq 'cuecat') {
178 my @fields = split( /\./, $barcode );
179 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
180 ($#results == 2) and return $results[2];
181 } elsif ($filter eq 'T-prefix') {
182 if ($barcode =~ /^[Tt](\d)/) {
183 (defined($1) and $1 eq '0') and return $barcode;
184 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
186 return sprintf("T%07d", $barcode);
187 # FIXME: $barcode could be "T1", causing warning: substr outside of string
188 # Why drop the nonzero digit after the T?
189 # Why pass non-digits (or empty string) to "T%07d"?
190 } elsif ($filter eq 'libsuite8') {
191 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
192 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
193 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
195 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
198 } elsif ($filter eq 'EAN13') {
199 my $ean = CheckDigits('ean');
200 if ( $ean->is_valid($barcode) ) {
201 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
202 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
204 warn "# [$barcode] not valid EAN-13/UPC-A\n";
207 return $barcode; # return barcode, modified or not
212 $str = &decode($chunk);
214 Decodes a segment of a string emitted by a CueCat barcode scanner and
217 FIXME: Should be replaced with Barcode::Cuecat from CPAN
218 or Javascript based decoding on the client side.
225 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
226 my @s = map { index( $seq, $_ ); } split( //, $encoded );
227 my $l = ( $#s + 1 ) % 4;
230 # warn "Error: Cuecat decode parsing failed!";
238 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
240 chr( ( $n >> 16 ) ^ 67 )
241 .chr( ( $n >> 8 & 255 ) ^ 67 )
242 .chr( ( $n & 255 ) ^ 67 );
245 $r = substr( $r, 0, length($r) - $l );
251 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
252 $barcode, $ignore_reserves);
254 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
256 C<$newbranch> is the code for the branch to which the item should be transferred.
258 C<$barcode> is the barcode of the item to be transferred.
260 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
261 Otherwise, if an item is reserved, the transfer fails.
263 Returns three values:
269 is true if the transfer was successful.
273 is a reference-to-hash which may have any of the following keys:
279 There is no item in the catalog with the given barcode. The value is C<$barcode>.
283 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.
285 =item C<DestinationEqualsHolding>
287 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.
291 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.
295 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>.
297 =item C<WasTransferred>
299 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
308 my ( $tbr, $barcode, $ignoreRs ) = @_;
311 my $branches = GetBranches();
312 my $itemnumber = GetItemnumberFromBarcode( $barcode );
313 my $issue = GetItemIssue($itemnumber);
314 my $biblio = GetBiblioFromItemNumber($itemnumber);
317 if ( not $itemnumber ) {
318 $messages->{'BadBarcode'} = $barcode;
322 # get branches of book...
323 my $hbr = $biblio->{'homebranch'};
324 my $fbr = $biblio->{'holdingbranch'};
326 # if using Branch Transfer Limits
327 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
328 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
329 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
330 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
333 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
334 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
340 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
341 $messages->{'IsPermanent'} = $hbr;
345 # can't transfer book if is already there....
346 if ( $fbr eq $tbr ) {
347 $messages->{'DestinationEqualsHolding'} = 1;
351 # check if it is still issued to someone, return it...
352 if ($issue->{borrowernumber}) {
353 AddReturn( $barcode, $fbr );
354 $messages->{'WasReturned'} = $issue->{borrowernumber};
358 # That'll save a database query.
359 my ( $resfound, $resrec, undef ) =
360 CheckReserves( $itemnumber );
361 if ( $resfound and not $ignoreRs ) {
362 $resrec->{'ResFound'} = $resfound;
364 # $messages->{'ResFound'} = $resrec;
368 #actually do the transfer....
370 ModItemTransfer( $itemnumber, $fbr, $tbr );
372 # don't need to update MARC anymore, we do it in batch now
373 $messages->{'WasTransfered'} = 1;
376 ModDateLastSeen( $itemnumber );
377 return ( $dotransfer, $messages, $biblio );
382 my $borrower = shift;
383 my $biblionumber = shift;
386 my $onsite_checkout = $params->{onsite_checkout} || 0;
387 my $cat_borrower = $borrower->{'categorycode'};
388 my $dbh = C4::Context->dbh;
390 # Get which branchcode we need
391 $branch = _GetCircControlBranch($item,$borrower);
392 my $type = (C4::Context->preference('item-level_itypes'))
393 ? $item->{'itype'} # item-level
394 : $item->{'itemtype'}; # biblio-level
396 # given branch, patron category, and item type, determine
397 # applicable issuing rule
398 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
400 # if a rule is found and has a loan limit set, count
401 # how many loans the patron already has that meet that
403 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
406 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
408 JOIN items USING (itemnumber)
411 my $rule_itemtype = $issuing_rule->{itemtype};
412 if ($rule_itemtype eq "*") {
413 # matching rule has the default item type, so count only
414 # those existing loans that don't fall under a more
416 if (C4::Context->preference('item-level_itypes')) {
417 $count_query .= " WHERE items.itype NOT IN (
418 SELECT itemtype FROM issuingrules
420 AND (categorycode = ? OR categorycode = ?)
424 $count_query .= " JOIN biblioitems USING (biblionumber)
425 WHERE biblioitems.itemtype NOT IN (
426 SELECT itemtype FROM issuingrules
428 AND (categorycode = ? OR categorycode = ?)
432 push @bind_params, $issuing_rule->{branchcode};
433 push @bind_params, $issuing_rule->{categorycode};
434 push @bind_params, $cat_borrower;
436 # rule has specific item type, so count loans of that
438 if (C4::Context->preference('item-level_itypes')) {
439 $count_query .= " WHERE items.itype = ? ";
441 $count_query .= " JOIN biblioitems USING (biblionumber)
442 WHERE biblioitems.itemtype= ? ";
444 push @bind_params, $type;
447 $count_query .= " AND borrowernumber = ? ";
448 push @bind_params, $borrower->{'borrowernumber'};
449 my $rule_branch = $issuing_rule->{branchcode};
450 if ($rule_branch ne "*") {
451 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
452 $count_query .= " AND issues.branchcode = ? ";
453 push @bind_params, $branch;
454 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
455 ; # if branch is the patron's home branch, then count all loans by patron
457 $count_query .= " AND items.homebranch = ? ";
458 push @bind_params, $branch;
462 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $count_query, {}, @bind_params );
464 my $max_checkouts_allowed = $issuing_rule->{maxissueqty};
465 my $max_onsite_checkouts_allowed = $issuing_rule->{maxonsiteissueqty};
467 if ( $onsite_checkout ) {
468 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
470 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
471 count => $onsite_checkout_count,
472 max_allowed => $max_onsite_checkouts_allowed,
476 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
477 if ( $checkout_count >= $max_checkouts_allowed ) {
479 reason => 'TOO_MANY_CHECKOUTS',
480 count => $checkout_count,
481 max_allowed => $max_checkouts_allowed,
484 } elsif ( not $onsite_checkout ) {
485 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
487 reason => 'TOO_MANY_CHECKOUTS',
488 count => $checkout_count - $onsite_checkout_count,
489 max_allowed => $max_checkouts_allowed,
495 # Now count total loans against the limit for the branch
496 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
497 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
498 my @bind_params = ();
499 my $branch_count_query = q|
500 SELECT COUNT(*) AS total, COALESCE(SUM(onsite_checkout), 0) AS onsite_checkouts
502 JOIN items USING (itemnumber)
503 WHERE borrowernumber = ?
505 push @bind_params, $borrower->{borrowernumber};
507 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
508 $branch_count_query .= " AND issues.branchcode = ? ";
509 push @bind_params, $branch;
510 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
511 ; # if branch is the patron's home branch, then count all loans by patron
513 $branch_count_query .= " AND items.homebranch = ? ";
514 push @bind_params, $branch;
516 my ( $checkout_count, $onsite_checkout_count ) = $dbh->selectrow_array( $branch_count_query, {}, @bind_params );
517 my $max_checkouts_allowed = $branch_borrower_circ_rule->{maxissueqty};
518 my $max_onsite_checkouts_allowed = $branch_borrower_circ_rule->{maxonsiteissueqty};
520 if ( $onsite_checkout ) {
521 if ( $onsite_checkout_count >= $max_onsite_checkouts_allowed ) {
523 reason => 'TOO_MANY_ONSITE_CHECKOUTS',
524 count => $onsite_checkout_count,
525 max_allowed => $max_onsite_checkouts_allowed,
529 if ( C4::Context->preference('ConsiderOnSiteCheckoutsAsNormalCheckouts') ) {
530 if ( $checkout_count >= $max_checkouts_allowed ) {
532 reason => 'TOO_MANY_CHECKOUTS',
533 count => $checkout_count,
534 max_allowed => $max_checkouts_allowed,
537 } elsif ( not $onsite_checkout ) {
538 if ( $checkout_count - $onsite_checkout_count >= $max_checkouts_allowed ) {
540 reason => 'TOO_MANY_CHECKOUTS',
541 count => $checkout_count - $onsite_checkout_count,
542 max_allowed => $max_checkouts_allowed,
548 # OK, the patron can issue !!!
554 @issues = &itemissues($biblioitemnumber, $biblio);
556 Looks up information about who has borrowed the bookZ<>(s) with the
557 given biblioitemnumber.
559 C<$biblio> is ignored.
561 C<&itemissues> returns an array of references-to-hash. The keys
562 include the fields from the C<items> table in the Koha database.
563 Additional keys include:
569 If the item is currently on loan, this gives the due date.
571 If the item is not on loan, then this is either "Available" or
572 "Cancelled", if the item has been withdrawn.
576 If the item is currently on loan, this gives the card number of the
577 patron who currently has the item.
579 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
581 These give the timestamp for the last three times the item was
584 =item C<card0>, C<card1>, C<card2>
586 The card number of the last three patrons who borrowed this item.
588 =item C<borrower0>, C<borrower1>, C<borrower2>
590 The borrower number of the last three patrons who borrowed this item.
598 my ( $bibitem, $biblio ) = @_;
599 my $dbh = C4::Context->dbh;
601 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
606 $sth->execute($bibitem) || die $sth->errstr;
608 while ( my $data = $sth->fetchrow_hashref ) {
610 # Find out who currently has this item.
611 # FIXME - Wouldn't it be better to do this as a left join of
612 # some sort? Currently, this code assumes that if
613 # fetchrow_hashref() fails, then the book is on the shelf.
614 # fetchrow_hashref() can fail for any number of reasons (e.g.,
615 # database server crash), not just because no items match the
617 my $sth2 = $dbh->prepare(
618 "SELECT * FROM issues
619 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
624 $sth2->execute( $data->{'itemnumber'} );
625 if ( my $data2 = $sth2->fetchrow_hashref ) {
626 $data->{'date_due'} = $data2->{'date_due'};
627 $data->{'card'} = $data2->{'cardnumber'};
628 $data->{'borrower'} = $data2->{'borrowernumber'};
631 $data->{'date_due'} = ($data->{'withdrawn'} eq '1') ? 'Cancelled' : 'Available';
635 # Find the last 3 people who borrowed this item.
636 $sth2 = $dbh->prepare(
637 "SELECT * FROM old_issues
638 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
640 ORDER BY returndate DESC,timestamp DESC"
643 $sth2->execute( $data->{'itemnumber'} );
644 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
645 { # FIXME : error if there is less than 3 pple borrowing this item
646 if ( my $data2 = $sth2->fetchrow_hashref ) {
647 $data->{"timestamp$i2"} = $data2->{'timestamp'};
648 $data->{"card$i2"} = $data2->{'cardnumber'};
649 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
653 $results[$i] = $data;
660 =head2 CanBookBeIssued
662 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
663 $barcode, $duedate, $inprocess, $ignore_reserves );
665 Check if a book can be issued.
667 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
671 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
673 =item C<$barcode> is the bar code of the book being issued.
675 =item C<$duedates> is a DateTime object.
677 =item C<$inprocess> boolean switch
679 =item C<$ignore_reserves> boolean switch
687 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
688 Possible values are :
694 sticky due date is invalid
698 borrower gone with no address
702 borrower declared it's card lost
708 =head3 UNKNOWN_BARCODE
722 item is restricted (set by ??)
724 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
725 could be prevented, but ones that can be overriden by the operator.
727 Possible values are :
735 renewing, not issuing
737 =head3 ISSUED_TO_ANOTHER
739 issued to someone else.
743 reserved for someone else.
747 sticky due date is invalid or due date in the past
751 if the borrower borrows to much things
755 sub CanBookBeIssued {
756 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves, $params ) = @_;
757 my %needsconfirmation; # filled with problems that needs confirmations
758 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
759 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
761 my $onsite_checkout = $params->{onsite_checkout} || 0;
763 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
764 my $issue = GetItemIssue($item->{itemnumber});
765 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
766 $item->{'itemtype'}=$item->{'itype'};
767 my $dbh = C4::Context->dbh;
769 # MANDATORY CHECKS - unless item exists, nothing else matters
770 unless ( $item->{barcode} ) {
771 $issuingimpossible{UNKNOWN_BARCODE} = 1;
773 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
776 # DUE DATE is OK ? -- should already have checked.
778 if ($duedate && ref $duedate ne 'DateTime') {
779 $duedate = dt_from_string($duedate);
781 my $now = DateTime->now( time_zone => C4::Context->tz() );
782 unless ( $duedate ) {
783 my $issuedate = $now->clone();
785 my $branch = _GetCircControlBranch($item,$borrower);
786 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
787 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
789 # Offline circ calls AddIssue directly, doesn't run through here
790 # So issuingimpossible should be ok.
793 my $today = $now->clone();
794 $today->truncate( to => 'minute');
795 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
796 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
799 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
805 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
806 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
808 branch => C4::Context->userenv->{'branch'},
810 itemnumber => $item->{'itemnumber'},
811 itemtype => $item->{'itemtype'},
812 borrowernumber => $borrower->{'borrowernumber'},
813 ccode => $item->{'ccode'}}
815 ModDateLastSeen( $item->{'itemnumber'} );
816 return( { STATS => 1 }, {});
818 if ( ref $borrower->{flags} ) {
819 if ( $borrower->{flags}->{GNA} ) {
820 $issuingimpossible{GNA} = 1;
822 if ( $borrower->{flags}->{'LOST'} ) {
823 $issuingimpossible{CARD_LOST} = 1;
825 if ( $borrower->{flags}->{'DBARRED'} ) {
826 $issuingimpossible{DEBARRED} = 1;
829 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
830 $issuingimpossible{EXPIRED} = 1;
832 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'sql', 'floating' );
833 $expiry_dt->truncate( to => 'day');
834 my $today = $now->clone()->truncate(to => 'day');
835 $today->set_time_zone( 'floating' );
836 if ( DateTime->compare($today, $expiry_dt) == 1 ) {
837 $issuingimpossible{EXPIRED} = 1;
846 my ($balance, $non_issue_charges, $other_charges) =
847 C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
849 my $amountlimit = C4::Context->preference("noissuescharge");
850 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
851 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
853 # Check the debt of this patrons guarantees
854 my $no_issues_charge_guarantees = C4::Context->preference("NoIssuesChargeGuarantees");
855 $no_issues_charge_guarantees = undef unless looks_like_number( $no_issues_charge_guarantees );
856 if ( defined $no_issues_charge_guarantees ) {
857 my $p = Koha::Patrons->find( $borrower->{borrowernumber} );
858 my @guarantees = $p->guarantees();
859 my $guarantees_non_issues_charges;
860 foreach my $g ( @guarantees ) {
861 my ( $b, $n, $o ) = C4::Members::GetMemberAccountBalance( $g->id );
862 $guarantees_non_issues_charges += $n;
865 if ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && !$allowfineoverride) {
866 $issuingimpossible{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
867 } elsif ( $guarantees_non_issues_charges > $no_issues_charge_guarantees && !$inprocess && $allowfineoverride) {
868 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
869 } elsif ( $allfinesneedoverride && $guarantees_non_issues_charges > 0 && $guarantees_non_issues_charges <= $no_issues_charge_guarantees && !$inprocess ) {
870 $needsconfirmation{DEBT_GUARANTEES} = $guarantees_non_issues_charges;
874 if ( C4::Context->preference("IssuingInProcess") ) {
875 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
876 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
877 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
878 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
879 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
880 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
884 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
885 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
886 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
887 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
888 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
889 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
893 if ($balance > 0 && $other_charges > 0) {
894 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
897 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
898 if ($blocktype == -1) {
899 ## patron has outstanding overdue loans
900 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
901 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
903 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
904 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
906 } elsif($blocktype == 1) {
907 # patron has accrued fine days or has a restriction. $count is a date
908 if ($count eq '9999-12-31') {
909 $issuingimpossible{USERBLOCKEDNOENDDATE} = $count;
912 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $count;
917 # JB34 CHECKS IF BORROWERS DON'T HAVE ISSUE TOO MANY BOOKS
919 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item, { onsite_checkout => $onsite_checkout } );
920 # if TooMany max_allowed returns 0 the user doesn't have permission to check out this book
922 if ( $toomany->{max_allowed} == 0 ) {
923 $needsconfirmation{PATRON_CANT} = 1;
925 if ( C4::Context->preference("AllowTooManyOverride") ) {
926 $needsconfirmation{TOO_MANY} = $toomany->{reason};
927 $needsconfirmation{current_loan_count} = $toomany->{count};
928 $needsconfirmation{max_loans_allowed} = $toomany->{max_allowed};
930 $needsconfirmation{TOO_MANY} = $toomany->{reason};
931 $issuingimpossible{current_loan_count} = $toomany->{count};
932 $issuingimpossible{max_loans_allowed} = $toomany->{max_allowed};
939 if ( $item->{'notforloan'} )
941 if(!C4::Context->preference("AllowNotForLoanOverride")){
942 $issuingimpossible{NOT_FOR_LOAN} = 1;
943 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
945 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
946 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
950 # we have to check itemtypes.notforloan also
951 if (C4::Context->preference('item-level_itypes')){
952 # this should probably be a subroutine
953 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
954 $sth->execute($item->{'itemtype'});
955 my $notforloan=$sth->fetchrow_hashref();
956 if ($notforloan->{'notforloan'}) {
957 if (!C4::Context->preference("AllowNotForLoanOverride")) {
958 $issuingimpossible{NOT_FOR_LOAN} = 1;
959 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
961 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
962 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
966 elsif ($biblioitem->{'notforloan'} == 1){
967 if (!C4::Context->preference("AllowNotForLoanOverride")) {
968 $issuingimpossible{NOT_FOR_LOAN} = 1;
969 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
971 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
972 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
976 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
978 $issuingimpossible{WTHDRAWN} = 1;
980 if ( $item->{'restricted'}
981 && $item->{'restricted'} == 1 )
983 $issuingimpossible{RESTRICTED} = 1;
985 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
986 my $code = GetAuthorisedValueByCode( 'LOST', $item->{'itemlost'} );
987 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
988 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
990 if ( C4::Context->preference("IndependentBranches") ) {
991 my $userenv = C4::Context->userenv;
992 unless ( C4::Context->IsSuperLibrarian() ) {
993 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
994 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
995 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
997 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
998 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
1002 # CHECK IF THERE IS RENTAL CHARGES. RENTAL MUST BE CONFIRMED BY THE BORROWER
1004 my $rentalConfirmation = C4::Context->preference("RentalFeesCheckoutConfirmation");
1006 if ( $rentalConfirmation ){
1007 my ($rentalCharge) = GetIssuingCharges( $item->{'itemnumber'}, $borrower->{'borrowernumber'} );
1008 if ( $rentalCharge > 0 ){
1009 $rentalCharge = sprintf("%.02f", $rentalCharge);
1010 $needsconfirmation{RENTALCHARGE} = $rentalCharge;
1015 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
1017 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} ){
1019 # Already issued to current borrower. Ask whether the loan should
1021 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
1022 $borrower->{'borrowernumber'},
1023 $item->{'itemnumber'}
1025 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
1026 if ( $renewerror eq 'onsite_checkout' ) {
1027 $issuingimpossible{NO_RENEWAL_FOR_ONSITE_CHECKOUTS} = 1;
1030 $issuingimpossible{NO_MORE_RENEWALS} = 1;
1034 $needsconfirmation{RENEW_ISSUE} = 1;
1037 elsif ($issue->{borrowernumber}) {
1039 # issued to someone else
1040 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
1042 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
1043 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
1044 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
1045 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
1046 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
1047 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
1050 unless ( $ignore_reserves ) {
1051 # See if the item is on reserve.
1052 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1054 my $resbor = $res->{'borrowernumber'};
1055 if ( $resbor ne $borrower->{'borrowernumber'} ) {
1056 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
1057 my $branchname = GetBranchName( $res->{'branchcode'} );
1058 if ( $restype eq "Waiting" )
1060 # The item is on reserve and waiting, but has been
1061 # reserved by some other patron.
1062 $needsconfirmation{RESERVE_WAITING} = 1;
1063 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1064 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1065 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1066 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1067 $needsconfirmation{'resbranchname'} = $branchname;
1068 $needsconfirmation{'reswaitingdate'} = $res->{'waitingdate'};
1070 elsif ( $restype eq "Reserved" ) {
1071 # The item is on reserve for someone else.
1072 $needsconfirmation{RESERVED} = 1;
1073 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
1074 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
1075 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
1076 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
1077 $needsconfirmation{'resbranchname'} = $branchname;
1078 $needsconfirmation{'resreservedate'} = $res->{'reservedate'};
1084 ## CHECK AGE RESTRICTION
1085 my $agerestriction = $biblioitem->{'agerestriction'};
1086 my ($restriction_age, $daysToAgeRestriction) = GetAgeRestriction( $agerestriction, $borrower );
1087 if ( $daysToAgeRestriction && $daysToAgeRestriction > 0 ) {
1088 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1089 $needsconfirmation{AGE_RESTRICTION} = "$agerestriction";
1092 $issuingimpossible{AGE_RESTRICTION} = "$agerestriction";
1096 ## check for high holds decreasing loan period
1097 if ( C4::Context->preference('decreaseLoanHighHolds') ) {
1098 my $check = checkHighHolds( $item, $borrower );
1100 if ( $check->{exceeded} ) {
1101 $needsconfirmation{HIGHHOLDS} = {
1102 num_holds => $check->{outstanding},
1103 duration => $check->{duration},
1104 returndate => output_pref( $check->{due_date} ),
1110 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1111 # don't do the multiple loans per bib check if we've
1112 # already determined that we've got a loan on the same item
1113 !$issuingimpossible{NO_MORE_RENEWALS} &&
1114 !$needsconfirmation{RENEW_ISSUE}
1116 # Check if borrower has already issued an item from the same biblio
1117 # Only if it's not a subscription
1118 my $biblionumber = $item->{biblionumber};
1119 require C4::Serials;
1120 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1121 unless ($is_a_subscription) {
1122 my $issues = GetIssues( {
1123 borrowernumber => $borrower->{borrowernumber},
1124 biblionumber => $biblionumber,
1126 my @issues = $issues ? @$issues : ();
1127 # if we get here, we don't already have a loan on this item,
1128 # so if there are any loans on this bib, ask for confirmation
1129 if (scalar @issues > 0) {
1130 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1135 return ( \%issuingimpossible, \%needsconfirmation, \%alerts );
1138 =head2 CanBookBeReturned
1140 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1142 Check whether the item can be returned to the provided branch
1146 =item C<$item> is a hash of item information as returned from GetItem
1148 =item C<$branch> is the branchcode where the return is taking place
1156 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1158 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1164 sub CanBookBeReturned {
1165 my ($item, $branch) = @_;
1166 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1168 # assume return is allowed to start
1172 # identify all cases where return is forbidden
1173 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1175 $message = $item->{'homebranch'};
1176 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1178 $message = $item->{'holdingbranch'};
1179 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1181 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1184 return ($allowed, $message);
1187 =head2 CheckHighHolds
1189 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1190 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1191 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1195 sub checkHighHolds {
1196 my ( $item, $borrower ) = @_;
1197 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1198 my $branch = _GetCircControlBranch( $item, $borrower );
1207 my $holds = Koha::Holds->search( { biblionumber => $item->{'biblionumber'} } );
1209 if ( $holds->count() ) {
1210 $return_data->{outstanding} = $holds->count();
1212 my $decreaseLoanHighHoldsControl = C4::Context->preference('decreaseLoanHighHoldsControl');
1213 my $decreaseLoanHighHoldsValue = C4::Context->preference('decreaseLoanHighHoldsValue');
1214 my $decreaseLoanHighHoldsIgnoreStatuses = C4::Context->preference('decreaseLoanHighHoldsIgnoreStatuses');
1216 my @decreaseLoanHighHoldsIgnoreStatuses = split( /,/, $decreaseLoanHighHoldsIgnoreStatuses );
1218 if ( $decreaseLoanHighHoldsControl eq 'static' ) {
1220 # static means just more than a given number of holds on the record
1222 # If the number of holds is less than the threshold, we can stop here
1223 if ( $holds->count() < $decreaseLoanHighHoldsValue ) {
1224 return $return_data;
1227 elsif ( $decreaseLoanHighHoldsControl eq 'dynamic' ) {
1229 # dynamic means X more than the number of holdable items on the record
1231 # let's get the items
1232 my @items = $holds->next()->biblio()->items();
1234 # Remove any items with status defined to be ignored even if the would not make item unholdable
1235 foreach my $status (@decreaseLoanHighHoldsIgnoreStatuses) {
1236 @items = grep { !$_->$status } @items;
1239 # Remove any items that are not holdable for this patron
1240 @items = grep { CanItemBeReserved( $borrower->{borrowernumber}, $_->itemnumber ) eq 'OK' } @items;
1242 my $items_count = scalar @items;
1244 my $threshold = $items_count + $decreaseLoanHighHoldsValue;
1246 # If the number of holds is less than the count of items we have
1247 # plus the number of holds allowed above that count, we can stop here
1248 if ( $holds->count() <= $threshold ) {
1249 return $return_data;
1253 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1255 my $calendar = Koha::Calendar->new( branchcode => $branch );
1258 ( C4::Context->preference('item-level_itypes') )
1259 ? $biblio->{'itype'}
1260 : $biblio->{'itemtype'};
1262 my $orig_due = C4::Circulation::CalcDateDue( $issuedate, $itype, $branch, $borrower );
1264 my $decreaseLoanHighHoldsDuration = C4::Context->preference('decreaseLoanHighHoldsDuration');
1266 my $reduced_datedue = $calendar->addDate( $issuedate, $decreaseLoanHighHoldsDuration );
1268 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1269 $return_data->{exceeded} = 1;
1270 $return_data->{duration} = $decreaseLoanHighHoldsDuration;
1271 $return_data->{due_date} = $reduced_datedue;
1275 return $return_data;
1280 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1282 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1286 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1288 =item C<$barcode> is the barcode of the item being issued.
1290 =item C<$datedue> is a DateTime object for the max date of return, i.e. the date due (optional).
1291 Calculated if empty.
1293 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1295 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1296 Defaults to today. Unlike C<$datedue>, NOT a DateTime object, unfortunately.
1298 AddIssue does the following things :
1300 - step 01: check that there is a borrowernumber & a barcode provided
1301 - check for RENEWAL (book issued & being issued to the same patron)
1302 - renewal YES = Calculate Charge & renew
1304 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1306 - fill reserve if reserve to this patron
1307 - cancel reserve or not, otherwise
1308 * TRANSFERT PENDING ?
1309 - complete the transfert
1317 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1318 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1319 my $auto_renew = $params && $params->{auto_renew};
1320 my $dbh = C4::Context->dbh;
1321 my $barcodecheck=CheckValidBarcode($barcode);
1325 if ($datedue && ref $datedue ne 'DateTime') {
1326 $datedue = dt_from_string($datedue);
1328 # $issuedate defaults to today.
1329 if ( ! defined $issuedate ) {
1330 $issuedate = DateTime->now(time_zone => C4::Context->tz());
1333 if ( ref $issuedate ne 'DateTime') {
1334 $issuedate = dt_from_string($issuedate);
1338 if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1339 # find which item we issue
1340 my $item = GetItem('', $barcode) or return; # if we don't get an Item, abort.
1341 my $branch = _GetCircControlBranch($item,$borrower);
1343 # get actual issuing if there is one
1344 my $actualissue = GetItemIssue( $item->{itemnumber});
1346 # get biblioinformation for this item
1347 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
1350 # check if we just renew the issue.
1352 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
1353 $datedue = AddRenewal(
1354 $borrower->{'borrowernumber'},
1355 $item->{'itemnumber'},
1358 $issuedate, # here interpreted as the renewal date
1362 # it's NOT a renewal
1363 if ( $actualissue->{borrowernumber}) {
1364 # This book is currently on loan, but not to the person
1365 # who wants to borrow it now. mark it returned before issuing to the new borrower
1368 C4::Context->userenv->{'branch'}
1372 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1373 # Starting process for transfer job (checking transfert and validate it if we have one)
1374 my ($datesent) = GetTransfers($item->{'itemnumber'});
1376 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1379 "UPDATE branchtransfers
1380 SET datearrived = now(),
1382 comments = 'Forced branchtransfer'
1383 WHERE itemnumber= ? AND datearrived IS NULL"
1385 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1388 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1389 unless ($auto_renew) {
1390 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branch);
1391 $auto_renew = $issuingrule->{auto_renew};
1394 # Record in the database the fact that the book was issued.
1396 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1397 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1400 $datedue->truncate( to => 'minute');
1402 $issue = Koha::Database->new()->schema()->resultset('Issue')->create(
1404 borrowernumber => $borrower->{'borrowernumber'},
1405 itemnumber => $item->{'itemnumber'},
1406 issuedate => $issuedate->strftime('%Y-%m-%d %H:%M:%S'),
1407 date_due => $datedue->strftime('%Y-%m-%d %H:%M:%S'),
1408 branchcode => C4::Context->userenv->{'branch'},
1409 onsite_checkout => $onsite_checkout,
1410 auto_renew => $auto_renew ? 1 : 0
1414 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1415 CartToShelf( $item->{'itemnumber'} );
1417 $item->{'issues'}++;
1418 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1419 UpdateTotalIssues($item->{'biblionumber'}, 1);
1422 ## If item was lost, it has now been found, reverse any list item charges if necessary.
1423 if ( $item->{'itemlost'} ) {
1424 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1425 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1429 ModItem({ issues => $item->{'issues'},
1430 holdingbranch => C4::Context->userenv->{'branch'},
1432 datelastborrowed => DateTime->now(time_zone => C4::Context->tz())->ymd(),
1433 onloan => $datedue->ymd(),
1434 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1435 ModDateLastSeen( $item->{'itemnumber'} );
1437 # If it costs to borrow this book, charge it to the patron's account.
1438 my ( $charge, $itemtype ) = GetIssuingCharges(
1439 $item->{'itemnumber'},
1440 $borrower->{'borrowernumber'}
1442 if ( $charge > 0 ) {
1444 $item->{'itemnumber'},
1445 $borrower->{'borrowernumber'}, $charge
1447 $item->{'charge'} = $charge;
1450 # Record the fact that this book was issued.
1452 branch => C4::Context->userenv->{'branch'},
1453 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1455 other => ($sipmode ? "SIP-$sipmode" : ''),
1456 itemnumber => $item->{'itemnumber'},
1457 itemtype => $item->{'itype'},
1458 borrowernumber => $borrower->{'borrowernumber'},
1459 ccode => $item->{'ccode'}}
1462 # Send a checkout slip.
1463 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1465 branchcode => $branch,
1466 categorycode => $borrower->{categorycode},
1467 item_type => $item->{itype},
1468 notification => 'CHECKOUT',
1470 if ($circulation_alert->is_enabled_for(\%conditions)) {
1471 SendCirculationAlert({
1474 borrower => $borrower,
1480 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'itemnumber'})
1481 if C4::Context->preference("IssueLog");
1486 =head2 GetLoanLength
1488 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1490 Get loan length for an itemtype, a borrower type and a branch
1495 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1496 my $dbh = C4::Context->dbh;
1497 my $sth = $dbh->prepare(qq{
1498 SELECT issuelength, lengthunit, renewalperiod
1500 WHERE categorycode=?
1503 AND issuelength IS NOT NULL
1506 # try to find issuelength & return the 1st available.
1507 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1508 $sth->execute( $borrowertype, $itemtype, $branchcode );
1509 my $loanlength = $sth->fetchrow_hashref;
1512 if defined($loanlength) && defined $loanlength->{issuelength};
1514 $sth->execute( $borrowertype, '*', $branchcode );
1515 $loanlength = $sth->fetchrow_hashref;
1517 if defined($loanlength) && defined $loanlength->{issuelength};
1519 $sth->execute( '*', $itemtype, $branchcode );
1520 $loanlength = $sth->fetchrow_hashref;
1522 if defined($loanlength) && defined $loanlength->{issuelength};
1524 $sth->execute( '*', '*', $branchcode );
1525 $loanlength = $sth->fetchrow_hashref;
1527 if defined($loanlength) && defined $loanlength->{issuelength};
1529 $sth->execute( $borrowertype, $itemtype, '*' );
1530 $loanlength = $sth->fetchrow_hashref;
1532 if defined($loanlength) && defined $loanlength->{issuelength};
1534 $sth->execute( $borrowertype, '*', '*' );
1535 $loanlength = $sth->fetchrow_hashref;
1537 if defined($loanlength) && defined $loanlength->{issuelength};
1539 $sth->execute( '*', $itemtype, '*' );
1540 $loanlength = $sth->fetchrow_hashref;
1542 if defined($loanlength) && defined $loanlength->{issuelength};
1544 $sth->execute( '*', '*', '*' );
1545 $loanlength = $sth->fetchrow_hashref;
1547 if defined($loanlength) && defined $loanlength->{issuelength};
1549 # if no rule is set => 0 day (hardcoded)
1553 lengthunit => 'days',
1559 =head2 GetHardDueDate
1561 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1563 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1567 sub GetHardDueDate {
1568 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1570 my $rule = GetIssuingRule( $borrowertype, $itemtype, $branchcode );
1572 if ( defined( $rule ) ) {
1573 if ( $rule->{hardduedate} ) {
1574 return (dt_from_string($rule->{hardduedate}, 'iso'),$rule->{hardduedatecompare});
1576 return (undef, undef);
1581 =head2 GetIssuingRule
1583 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1585 FIXME - This is a copy-paste of GetLoanLength
1586 as a stop-gap. Do not wish to change API for GetLoanLength
1587 this close to release.
1589 Get the issuing rule for an itemtype, a borrower type and a branch
1590 Returns a hashref from the issuingrules table.
1594 sub GetIssuingRule {
1595 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1596 my $dbh = C4::Context->dbh;
1597 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=?" );
1600 $sth->execute( $borrowertype, $itemtype, $branchcode );
1601 $irule = $sth->fetchrow_hashref;
1602 return $irule if defined($irule) ;
1604 $sth->execute( $borrowertype, "*", $branchcode );
1605 $irule = $sth->fetchrow_hashref;
1606 return $irule if defined($irule) ;
1608 $sth->execute( "*", $itemtype, $branchcode );
1609 $irule = $sth->fetchrow_hashref;
1610 return $irule if defined($irule) ;
1612 $sth->execute( "*", "*", $branchcode );
1613 $irule = $sth->fetchrow_hashref;
1614 return $irule if defined($irule) ;
1616 $sth->execute( $borrowertype, $itemtype, "*" );
1617 $irule = $sth->fetchrow_hashref;
1618 return $irule if defined($irule) ;
1620 $sth->execute( $borrowertype, "*", "*" );
1621 $irule = $sth->fetchrow_hashref;
1622 return $irule if defined($irule) ;
1624 $sth->execute( "*", $itemtype, "*" );
1625 $irule = $sth->fetchrow_hashref;
1626 return $irule if defined($irule) ;
1628 $sth->execute( "*", "*", "*" );
1629 $irule = $sth->fetchrow_hashref;
1630 return $irule if defined($irule) ;
1632 # if no rule matches,
1636 =head2 GetBranchBorrowerCircRule
1638 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1640 Retrieves circulation rule attributes that apply to the given
1641 branch and patron category, regardless of item type.
1642 The return value is a hashref containing the following key:
1644 maxissueqty - maximum number of loans that a
1645 patron of the given category can have at the given
1646 branch. If the value is undef, no limit.
1648 maxonsiteissueqty - maximum of on-site checkouts that a
1649 patron of the given category can have at the given
1650 branch. If the value is undef, no limit.
1652 This will first check for a specific branch and
1653 category match from branch_borrower_circ_rules.
1655 If no rule is found, it will then check default_branch_circ_rules
1656 (same branch, default category). If no rule is found,
1657 it will then check default_borrower_circ_rules (default
1658 branch, same category), then failing that, default_circ_rules
1659 (default branch, default category).
1661 If no rule has been found in the database, it will default to
1665 maxonsiteissueqty - undef
1667 C<$branchcode> and C<$categorycode> should contain the
1668 literal branch code and patron category code, respectively - no
1673 sub GetBranchBorrowerCircRule {
1674 my ( $branchcode, $categorycode ) = @_;
1677 my $dbh = C4::Context->dbh();
1678 $rules = $dbh->selectrow_hashref( q|
1679 SELECT maxissueqty, maxonsiteissueqty
1680 FROM branch_borrower_circ_rules
1681 WHERE branchcode = ?
1682 AND categorycode = ?
1683 |, {}, $branchcode, $categorycode ) ;
1684 return $rules if $rules;
1686 # try same branch, default borrower category
1687 $rules = $dbh->selectrow_hashref( q|
1688 SELECT maxissueqty, maxonsiteissueqty
1689 FROM default_branch_circ_rules
1690 WHERE branchcode = ?
1691 |, {}, $branchcode ) ;
1692 return $rules if $rules;
1694 # try default branch, same borrower category
1695 $rules = $dbh->selectrow_hashref( q|
1696 SELECT maxissueqty, maxonsiteissueqty
1697 FROM default_borrower_circ_rules
1698 WHERE categorycode = ?
1699 |, {}, $categorycode ) ;
1700 return $rules if $rules;
1702 # try default branch, default borrower category
1703 $rules = $dbh->selectrow_hashref( q|
1704 SELECT maxissueqty, maxonsiteissueqty
1705 FROM default_circ_rules
1707 return $rules if $rules;
1709 # built-in default circulation rule
1711 maxissueqty => undef,
1712 maxonsiteissueqty => undef,
1716 =head2 GetBranchItemRule
1718 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1720 Retrieves circulation rule attributes that apply to the given
1721 branch and item type, regardless of patron category.
1723 The return value is a hashref containing the following keys:
1725 holdallowed => Hold policy for this branch and itemtype. Possible values:
1726 0: No holds allowed.
1727 1: Holds allowed only by patrons that have the same homebranch as the item.
1728 2: Holds allowed from any patron.
1730 returnbranch => branch to which to return item. Possible values:
1731 noreturn: do not return, let item remain where checked in (floating collections)
1732 homebranch: return to item's home branch
1733 holdingbranch: return to issuer branch
1735 This searches branchitemrules in the following order:
1737 * Same branchcode and itemtype
1738 * Same branchcode, itemtype '*'
1739 * branchcode '*', same itemtype
1740 * branchcode and itemtype '*'
1742 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1746 sub GetBranchItemRule {
1747 my ( $branchcode, $itemtype ) = @_;
1748 my $dbh = C4::Context->dbh();
1752 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1753 FROM branch_item_rules
1754 WHERE branchcode = ?
1755 AND itemtype = ?', $branchcode, $itemtype],
1756 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1757 FROM default_branch_circ_rules
1758 WHERE branchcode = ?', $branchcode],
1759 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1760 FROM default_branch_item_rules
1761 WHERE itemtype = ?', $itemtype],
1762 ['SELECT holdallowed, returnbranch, hold_fulfillment_policy
1763 FROM default_circ_rules'],
1766 foreach my $attempt (@attempts) {
1767 my ($query, @bind_params) = @{$attempt};
1768 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1771 # Since branch/category and branch/itemtype use the same per-branch
1772 # defaults tables, we have to check that the key we want is set, not
1773 # just that a row was returned
1774 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1775 $result->{'hold_fulfillment_policy'} = $search_result->{'hold_fulfillment_policy'} unless ( defined $result->{'hold_fulfillment_policy'} );
1776 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1779 # built-in default circulation rule
1780 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1781 $result->{'hold_fulfillment_policy'} = 'any' unless ( defined $result->{'hold_fulfillment_policy'} );
1782 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1789 ($doreturn, $messages, $iteminformation, $borrower) =
1790 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1796 =item C<$barcode> is the bar code of the book being returned.
1798 =item C<$branch> is the code of the branch where the book is being returned.
1800 =item C<$exemptfine> indicates that overdue charges for the item will be
1803 =item C<$dropbox> indicates that the check-in date is assumed to be
1804 yesterday, or the last non-holiday as defined in C4::Calendar . If
1805 overdue charges are applied and C<$dropbox> is true, the last charge
1806 will be removed. This assumes that the fines accrual script has run
1807 for _today_. Optional.
1809 =item C<$return_date> allows the default return date to be overridden
1810 by the given return date. Optional.
1814 C<&AddReturn> returns a list of four items:
1816 C<$doreturn> is true iff the return succeeded.
1818 C<$messages> is a reference-to-hash giving feedback on the operation.
1819 The keys of the hash are:
1825 No item with this barcode exists. The value is C<$barcode>.
1829 The book is not currently on loan. The value is C<$barcode>.
1831 =item C<IsPermanent>
1833 The book's home branch is a permanent collection. If you have borrowed
1834 this book, you are not allowed to return it. The value is the code for
1835 the book's home branch.
1839 This book has been withdrawn/cancelled. The value should be ignored.
1841 =item C<Wrongbranch>
1843 This book has was returned to the wrong branch. The value is a hashref
1844 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1845 contain the branchcode of the incorrect and correct return library, respectively.
1849 The item was reserved. The value is a reference-to-hash whose keys are
1850 fields from the reserves table of the Koha database, and
1851 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1852 either C<Waiting>, C<Reserved>, or 0.
1854 =item C<WasReturned>
1856 Value 1 if return is successful.
1858 =item C<NeedsTransfer>
1860 If AutomaticItemReturn is disabled, return branch is given as value of NeedsTransfer.
1864 C<$iteminformation> is a reference-to-hash, giving information about the
1865 returned item from the issues table.
1867 C<$borrower> is a reference-to-hash, giving information about the
1868 patron who last borrowed the book.
1873 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date, $dropboxdate ) = @_;
1875 if ($branch and not Koha::Libraries->find($branch)) {
1876 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1879 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1884 my $validTransfert = 0;
1885 my $stat_type = 'return';
1887 # get information on item
1888 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1889 unless ($itemnumber) {
1890 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1892 my $issue = GetItemIssue($itemnumber);
1893 if ($issue and $issue->{borrowernumber}) {
1894 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1895 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existent borrowernumber '$issue->{borrowernumber}'\n"
1896 . Dumper($issue) . "\n";
1898 $messages->{'NotIssued'} = $barcode;
1899 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1901 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1902 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1903 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1904 $messages->{'LocalUse'} = 1;
1905 $stat_type = 'localuse';
1909 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1911 if ( $item->{'location'} eq 'PROC' ) {
1912 if ( C4::Context->preference("InProcessingToShelvingCart") ) {
1913 $item->{'location'} = 'CART';
1916 $item->{location} = $item->{permanent_location};
1919 ModItem( $item, $item->{'biblionumber'}, $item->{'itemnumber'} );
1922 # full item data, but no borrowernumber or checkout info (no issue)
1923 # we know GetItem should work because GetItemnumberFromBarcode worked
1924 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1925 # get the proper branch to which to return the item
1926 my $returnbranch = $item->{$hbr} || $branch ;
1927 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1929 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1931 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1933 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1935 eval { $rules = YAML::Load($yaml); };
1937 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1940 foreach my $key ( keys %$rules ) {
1941 if ( $item->{notforloan} eq $key ) {
1942 $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1943 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1951 # check if the book is in a permanent collection....
1952 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1953 if ( $returnbranch ) {
1954 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1955 $branches->{$returnbranch}->{PE} and $messages->{'IsPermanent'} = $returnbranch;
1958 # check if the return is allowed at this branch
1959 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1960 unless ($returnallowed){
1961 $messages->{'Wrongbranch'} = {
1962 Wrongbranch => $branch,
1963 Rightbranch => $message
1966 return ( $doreturn, $messages, $issue, $borrower );
1969 if ( $item->{'withdrawn'} ) { # book has been cancelled
1970 $messages->{'withdrawn'} = 1;
1971 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1974 # case of a return of document (deal with issues and holdingbranch)
1975 my $today = DateTime->now( time_zone => C4::Context->tz() );
1978 my $datedue = $issue->{date_due};
1979 $borrower or warn "AddReturn without current borrower";
1980 my $circControlBranch;
1982 # define circControlBranch only if dropbox mode is set
1983 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1984 # FIXME: check issuedate > returndate, factoring in holidays
1986 $circControlBranch = _GetCircControlBranch($item,$borrower);
1987 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $dropboxdate ) == -1 ? 1 : 0;
1990 if ($borrowernumber) {
1991 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'} ) || $return_date ) {
1992 # we only need to calculate and change the fines if we want to do that on return
1993 # Should be on for hourly loans
1994 my $control = C4::Context->preference('CircControl');
1995 my $control_branchcode =
1996 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
1997 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
1998 : $issue->{branchcode};
2001 $return_date ? dt_from_string($return_date) : $today;
2003 my ( $amount, $type, $unitcounttotal ) =
2004 C4::Overdues::CalcFine( $item, $borrower->{categorycode},
2005 $control_branchcode, $datedue, $date_returned );
2009 if ( C4::Context->preference('finesMode') eq 'production' ) {
2010 if ( $amount > 0 ) {
2011 C4::Overdues::UpdateFine(
2013 issue_id => $issue->{issue_id},
2014 itemnumber => $issue->{itemnumber},
2015 borrowernumber => $issue->{borrowernumber},
2018 due => output_pref($datedue),
2022 elsif ($return_date) {
2024 # Backdated returns may have fines that shouldn't exist,
2025 # so in this case, we need to drop those fines to 0
2027 C4::Overdues::UpdateFine(
2029 issue_id => $issue->{issue_id},
2030 itemnumber => $issue->{itemnumber},
2031 borrowernumber => $issue->{borrowernumber},
2034 due => output_pref($datedue),
2042 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
2043 $circControlBranch, $return_date, $borrower->{'privacy'} );
2046 $messages->{'Wrongbranch'} = {
2047 Wrongbranch => $branch,
2048 Rightbranch => $message
2051 return ( 0, { WasReturned => 0 }, $issue, $borrower );
2054 # FIXME is the "= 1" right? This could be the borrower hash.
2055 $messages->{'WasReturned'} = 1;
2059 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
2062 # the holdingbranch is updated if the document is returned to another location.
2063 # this is always done regardless of whether the item was on loan or not
2064 if ($item->{'holdingbranch'} ne $branch) {
2065 UpdateHoldingbranch($branch, $item->{'itemnumber'});
2066 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
2068 ModDateLastSeen( $item->{'itemnumber'} );
2070 # check if we have a transfer for this document
2071 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
2073 # if we have a transfer to do, we update the line of transfers with the datearrived
2074 my $is_in_rotating_collection = C4::RotatingCollections::isItemInAnyCollection( $item->{'itemnumber'} );
2076 if ( $tobranch eq $branch ) {
2077 my $sth = C4::Context->dbh->prepare(
2078 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
2080 $sth->execute( $item->{'itemnumber'} );
2081 # if we have a reservation with valid transfer, we can set it's status to 'W'
2082 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
2083 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
2085 $messages->{'WrongTransfer'} = $tobranch;
2086 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
2088 $validTransfert = 1;
2090 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
2093 # fix up the accounts.....
2094 if ( $item->{'itemlost'} ) {
2095 $messages->{'WasLost'} = 1;
2097 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
2098 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
2099 $messages->{'LostItemFeeRefunded'} = 1;
2103 # fix up the overdues in accounts...
2104 if ($borrowernumber) {
2105 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
2106 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
2108 if ( $issue->{overdue} && $issue->{date_due} ) {
2110 $today = $dropboxdate if $dropbox;
2111 my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
2113 $messages->{'PrevDebarred'} = $debardate;
2115 $messages->{'Debarred'} = $debardate if $debardate;
2117 # there's no overdue on the item but borrower had been previously debarred
2118 } elsif ( $issue->{date_due} and $borrower->{'debarred'} ) {
2119 if ( $borrower->{debarred} eq "9999-12-31") {
2120 $messages->{'ForeverDebarred'} = $borrower->{'debarred'};
2122 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2123 $borrower_debar_dt->truncate(to => 'day');
2124 my $today_dt = $today->clone()->truncate(to => 'day');
2125 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
2126 $messages->{'PrevDebarred'} = $borrower->{'debarred'};
2132 # find reserves.....
2133 # if we don't have a reserve with the status W, we launch the Checkreserves routine
2134 my ($resfound, $resrec);
2135 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
2136 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
2138 $resrec->{'ResFound'} = $resfound;
2139 $messages->{'ResFound'} = $resrec;
2142 # Record the fact that this book was returned.
2143 # FIXME itemtype should record item level type, not bibliolevel type
2147 itemnumber => $item->{'itemnumber'},
2148 itemtype => $biblio->{'itemtype'},
2149 borrowernumber => $borrowernumber,
2150 ccode => $item->{'ccode'}}
2153 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
2154 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2156 branchcode => $branch,
2157 categorycode => $borrower->{categorycode},
2158 item_type => $item->{itype},
2159 notification => 'CHECKIN',
2161 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
2162 SendCirculationAlert({
2165 borrower => $borrower,
2170 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
2171 if C4::Context->preference("ReturnLog");
2173 # Remove any OVERDUES related debarment if the borrower has no overdues
2174 if ( $borrowernumber
2175 && $borrower->{'debarred'}
2176 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2177 && !C4::Members::HasOverdues( $borrowernumber )
2178 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2180 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2183 # Transfer to returnbranch if Automatic transfer set or append message NeedsTransfer
2184 if (!$is_in_rotating_collection && ($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $returnbranch) and not $messages->{'WrongTransfer'}){
2185 if (C4::Context->preference("AutomaticItemReturn" ) or
2186 (C4::Context->preference("UseBranchTransferLimits") and
2187 ! IsBranchTransferAllowed($branch, $returnbranch, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2189 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $returnbranch;
2190 $debug and warn "item: " . Dumper($item);
2191 ModItemTransfer($item->{'itemnumber'}, $branch, $returnbranch);
2192 $messages->{'WasTransfered'} = 1;
2194 $messages->{'NeedsTransfer'} = $returnbranch;
2198 return ( $doreturn, $messages, $issue, $borrower );
2201 =head2 MarkIssueReturned
2203 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2205 Unconditionally marks an issue as being returned by
2206 moving the C<issues> row to C<old_issues> and
2207 setting C<returndate> to the current date, or
2208 the last non-holiday date of the branccode specified in
2209 C<dropbox_branch> . Assumes you've already checked that
2210 it's safe to do this, i.e. last non-holiday > issuedate.
2212 if C<$returndate> is specified (in iso format), it is used as the date
2213 of the return. It is ignored when a dropbox_branch is passed in.
2215 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2216 the old_issue is immediately anonymised
2218 Ideally, this function would be internal to C<C4::Circulation>,
2219 not exported, but it is currently needed by one
2220 routine in C<C4::Accounts>.
2224 sub MarkIssueReturned {
2225 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2227 my $anonymouspatron;
2228 if ( $privacy == 2 ) {
2229 # The default of 0 will not work due to foreign key constraints
2230 # The anonymisation will fail if AnonymousPatron is not a valid entry
2231 # We need to check if the anonymous patron exist, Koha will fail loudly if it does not
2232 # Note that a warning should appear on the about page (System information tab).
2233 $anonymouspatron = C4::Context->preference('AnonymousPatron');
2234 die "Fatal error: the patron ($borrowernumber) has requested their circulation history be anonymized on check-in, but the AnonymousPatron system preference is empty or not set correctly."
2235 unless C4::Members::GetMember( borrowernumber => $anonymouspatron );
2237 my $dbh = C4::Context->dbh;
2238 my $query = 'UPDATE issues SET returndate=';
2240 if ($dropbox_branch) {
2241 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2242 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2244 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2245 } elsif ($returndate) {
2247 push @bind, $returndate;
2249 $query .= ' now() ';
2251 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
2252 push @bind, $borrowernumber, $itemnumber;
2254 my $sth_upd = $dbh->prepare($query);
2255 $sth_upd->execute(@bind);
2256 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
2257 WHERE borrowernumber = ?
2258 AND itemnumber = ?');
2259 $sth_copy->execute($borrowernumber, $itemnumber);
2260 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2261 if ( $privacy == 2) {
2262 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
2263 WHERE borrowernumber = ?
2264 AND itemnumber = ?");
2265 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2267 my $sth_del = $dbh->prepare("DELETE FROM issues
2268 WHERE borrowernumber = ?
2269 AND itemnumber = ?");
2270 $sth_del->execute($borrowernumber, $itemnumber);
2272 ModItem( { 'onloan' => undef }, undef, $itemnumber );
2274 if ( C4::Context->preference('StoreLastBorrower') ) {
2275 my $item = Koha::Items->find( $itemnumber );
2276 my $patron = Koha::Patrons->find( $borrowernumber );
2277 $item->last_returned_by( $patron );
2281 =head2 _debar_user_on_return
2283 _debar_user_on_return($borrower, $item, $datedue, today);
2285 C<$borrower> borrower hashref
2287 C<$item> item hashref
2289 C<$datedue> date due DateTime object
2291 C<$today> DateTime object representing the return time
2293 Internal function, called only by AddReturn that calculates and updates
2294 the user fine days, and debars him if necessary.
2296 Should only be called for overdue returns
2300 sub _debar_user_on_return {
2301 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2303 my $branchcode = _GetCircControlBranch( $item, $borrower );
2305 my $circcontrol = C4::Context->preference('CircControl');
2307 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2308 my $finedays = $issuingrule->{finedays};
2309 my $unit = $issuingrule->{lengthunit};
2310 my $chargeable_units = C4::Overdues::get_chargeable_units($unit, $dt_due, $dt_today, $branchcode);
2314 # finedays is in days, so hourly loans must multiply by 24
2315 # thus 1 hour late equals 1 day suspension * finedays rate
2316 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2318 # grace period is measured in the same units as the loan
2320 DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2322 my $deltadays = DateTime::Duration->new(
2323 days => $chargeable_units
2325 if ( $deltadays->subtract($grace)->is_positive() ) {
2326 my $suspension_days = $deltadays * $finedays;
2328 # If the max suspension days is < than the suspension days
2329 # the suspension days is limited to this maximum period.
2330 my $max_sd = $issuingrule->{maxsuspensiondays};
2331 if ( defined $max_sd ) {
2332 $max_sd = DateTime::Duration->new( days => $max_sd );
2333 $suspension_days = $max_sd
2334 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2338 $dt_today->clone()->add_duration( $suspension_days );
2340 Koha::Patron::Debarments::AddUniqueDebarment({
2341 borrowernumber => $borrower->{borrowernumber},
2342 expiration => $new_debar_dt->ymd(),
2343 type => 'SUSPENSION',
2345 # if borrower was already debarred but does not get an extra debarment
2346 if ( $borrower->{debarred} eq Koha::Patron::Debarments::IsDebarred($borrower->{borrowernumber}) ) {
2347 return ($borrower->{debarred},1);
2349 return $new_debar_dt->ymd();
2355 =head2 _FixOverduesOnReturn
2357 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2359 C<$brn> borrowernumber
2363 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2364 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2366 Internal function, called only by AddReturn
2370 sub _FixOverduesOnReturn {
2371 my ($borrowernumber, $item);
2372 unless ($borrowernumber = shift) {
2373 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2376 unless ($item = shift) {
2377 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2380 my ($exemptfine, $dropbox) = @_;
2381 my $dbh = C4::Context->dbh;
2383 # check for overdue fine
2384 my $sth = $dbh->prepare(
2385 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2387 $sth->execute( $borrowernumber, $item );
2389 # alter fine to show that the book has been returned
2390 my $data = $sth->fetchrow_hashref;
2391 return 0 unless $data; # no warning, there's just nothing to fix
2394 my @bind = ($data->{'accountlines_id'});
2396 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2397 if (C4::Context->preference("FinesLog")) {
2398 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2400 } elsif ($dropbox && $data->{lastincrement}) {
2401 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2402 my $amt = $data->{amount} - $data->{lastincrement} ;
2403 if (C4::Context->preference("FinesLog")) {
2404 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2406 $uquery = "update accountlines set accounttype='F' ";
2407 if($outstanding >= 0 && $amt >=0) {
2408 $uquery .= ", amount = ? , amountoutstanding=? ";
2409 unshift @bind, ($amt, $outstanding) ;
2412 $uquery = "update accountlines set accounttype='F' ";
2414 $uquery .= " where (accountlines_id = ?)";
2415 my $usth = $dbh->prepare($uquery);
2416 return $usth->execute(@bind);
2419 =head2 _FixAccountForLostAndReturned
2421 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2423 Calculates the charge for a book lost and returned.
2425 Internal function, not exported, called only by AddReturn.
2427 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2428 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2432 sub _FixAccountForLostAndReturned {
2433 my $itemnumber = shift or return;
2434 my $borrowernumber = @_ ? shift : undef;
2435 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2436 my $dbh = C4::Context->dbh;
2437 # check for charge made for lost book
2438 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2439 $sth->execute($itemnumber);
2440 my $data = $sth->fetchrow_hashref;
2441 $data or return; # bail if there is nothing to do
2442 $data->{accounttype} eq 'W' and return; # Written off
2444 # writeoff this amount
2446 my $amount = $data->{'amount'};
2447 my $acctno = $data->{'accountno'};
2448 my $amountleft; # Starts off undef/zero.
2449 if ($data->{'amountoutstanding'} == $amount) {
2450 $offset = $data->{'amount'};
2451 $amountleft = 0; # Hey, it's zero here, too.
2453 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2454 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2456 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2457 WHERE (accountlines_id = ?)");
2458 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2459 #check if any credit is left if so writeoff other accounts
2460 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2461 $amountleft *= -1 if ($amountleft < 0);
2462 if ($amountleft > 0) {
2463 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2464 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2465 $msth->execute($data->{'borrowernumber'});
2466 # offset transactions
2469 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2470 if ($accdata->{'amountoutstanding'} < $amountleft) {
2472 $amountleft -= $accdata->{'amountoutstanding'};
2474 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2477 my $thisacct = $accdata->{'accountlines_id'};
2478 # FIXME: move prepares outside while loop!
2479 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2480 WHERE (accountlines_id = ?)");
2481 $usth->execute($newamtos,$thisacct);
2482 $usth = $dbh->prepare("INSERT INTO accountoffsets
2483 (borrowernumber, accountno, offsetaccount, offsetamount)
2486 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2489 $amountleft *= -1 if ($amountleft > 0);
2490 my $desc = "Item Returned " . $item_id;
2491 $usth = $dbh->prepare("INSERT INTO accountlines
2492 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2493 VALUES (?,?,now(),?,?,'CR',?)");
2494 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2495 if ($borrowernumber) {
2496 # FIXME: same as query above. use 1 sth for both
2497 $usth = $dbh->prepare("INSERT INTO accountoffsets
2498 (borrowernumber, accountno, offsetaccount, offsetamount)
2500 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2502 ModItem({ paidfor => '' }, undef, $itemnumber);
2506 =head2 _GetCircControlBranch
2508 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2512 Return the library code to be used to determine which circulation
2513 policy applies to a transaction. Looks up the CircControl and
2514 HomeOrHoldingBranch system preferences.
2516 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2518 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2522 sub _GetCircControlBranch {
2523 my ($item, $borrower) = @_;
2524 my $circcontrol = C4::Context->preference('CircControl');
2527 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2528 $branch= C4::Context->userenv->{'branch'};
2529 } elsif ($circcontrol eq 'PatronLibrary') {
2530 $branch=$borrower->{branchcode};
2532 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2533 $branch = $item->{$branchfield};
2534 # default to item home branch if holdingbranch is used
2535 # and is not defined
2536 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2537 $branch = $item->{homebranch};
2550 $issue = &GetItemIssue($itemnumber);
2552 Returns patron currently having a book, or undef if not checked out.
2554 C<$itemnumber> is the itemnumber.
2556 C<$issue> is a hashref of the row from the issues table.
2561 my ($itemnumber) = @_;
2562 return unless $itemnumber;
2563 my $sth = C4::Context->dbh->prepare(
2564 "SELECT items.*, issues.*
2566 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2567 WHERE issues.itemnumber=?");
2568 $sth->execute($itemnumber);
2569 my $data = $sth->fetchrow_hashref;
2570 return unless $data;
2571 $data->{issuedate_sql} = $data->{issuedate};
2572 $data->{date_due_sql} = $data->{date_due};
2573 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2574 $data->{issuedate}->truncate(to => 'minute');
2575 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2576 $data->{date_due}->truncate(to => 'minute');
2577 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2578 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2584 $issue = GetOpenIssue( $itemnumber );
2586 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2588 C<$itemnumber> is the item's itemnumber
2595 my ( $itemnumber ) = @_;
2596 return unless $itemnumber;
2597 my $dbh = C4::Context->dbh;
2598 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2599 $sth->execute( $itemnumber );
2600 return $sth->fetchrow_hashref();
2606 $issues = GetIssues({}); # return all issues!
2607 $issues = GetIssues({ borrowernumber => $borrowernumber, biblionumber => $biblionumber });
2609 Returns all pending issues that match given criteria.
2610 Returns a arrayref or undef if an error occurs.
2612 Allowed criteria are:
2616 =item * borrowernumber
2618 =item * biblionumber
2627 my ($criteria) = @_;
2631 my @allowed = qw(borrowernumber biblionumber itemnumber);
2632 foreach (@allowed) {
2633 if (defined $criteria->{$_}) {
2636 value => $criteria->{$_},
2641 # Do we need to join other tables ?
2643 if (defined $criteria->{biblionumber}) {
2650 $where = "WHERE " . join(' AND ', map { "$_->{field} = ?" } @filters);
2656 if (defined $join{items}) {
2658 LEFT JOIN items ON (issues.itemnumber = items.itemnumber)
2664 my $dbh = C4::Context->dbh;
2665 my $sth = $dbh->prepare($query);
2666 my $rv = $sth->execute(map { $_->{value} } @filters);
2668 return $rv ? $sth->fetchall_arrayref({}) : undef;
2671 =head2 GetItemIssues
2673 $issues = &GetItemIssues($itemnumber, $history);
2675 Returns patrons that have issued a book
2677 C<$itemnumber> is the itemnumber
2678 C<$history> is false if you just want the current "issuer" (if any)
2679 and true if you want issues history from old_issues also.
2681 Returns reference to an array of hashes
2686 my ( $itemnumber, $history ) = @_;
2688 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2689 $today->truncate( to => 'minute' );
2690 my $sql = "SELECT * FROM issues
2691 JOIN borrowers USING (borrowernumber)
2692 JOIN items USING (itemnumber)
2693 WHERE issues.itemnumber = ? ";
2696 SELECT * FROM old_issues
2697 LEFT JOIN borrowers USING (borrowernumber)
2698 JOIN items USING (itemnumber)
2699 WHERE old_issues.itemnumber = ? ";
2701 $sql .= "ORDER BY date_due DESC";
2702 my $sth = C4::Context->dbh->prepare($sql);
2704 $sth->execute($itemnumber, $itemnumber);
2706 $sth->execute($itemnumber);
2708 my $results = $sth->fetchall_arrayref({});
2709 foreach (@$results) {
2710 my $date_due = dt_from_string($_->{date_due},'sql');
2711 $date_due->truncate( to => 'minute' );
2713 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2718 =head2 GetBiblioIssues
2720 $issues = GetBiblioIssues($biblionumber);
2722 this function get all issues from a biblionumber.
2725 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2726 tables issues and the firstname,surname & cardnumber from borrowers.
2730 sub GetBiblioIssues {
2731 my $biblionumber = shift;
2732 return unless $biblionumber;
2733 my $dbh = C4::Context->dbh;
2735 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2737 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2738 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2739 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2740 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2741 WHERE biblio.biblionumber = ?
2743 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2745 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2746 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2747 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2748 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2749 WHERE biblio.biblionumber = ?
2752 my $sth = $dbh->prepare($query);
2753 $sth->execute($biblionumber, $biblionumber);
2756 while ( my $data = $sth->fetchrow_hashref ) {
2757 push @issues, $data;
2762 =head2 GetUpcomingDueIssues
2764 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2768 sub GetUpcomingDueIssues {
2771 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2772 my $dbh = C4::Context->dbh;
2774 my $statement = <<END_SQL;
2775 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2777 LEFT JOIN items USING (itemnumber)
2778 LEFT OUTER JOIN branches USING (branchcode)
2779 WHERE returndate is NULL
2780 HAVING days_until_due >= 0 AND days_until_due <= ?
2783 my @bind_parameters = ( $params->{'days_in_advance'} );
2785 my $sth = $dbh->prepare( $statement );
2786 $sth->execute( @bind_parameters );
2787 my $upcoming_dues = $sth->fetchall_arrayref({});
2789 return $upcoming_dues;
2792 =head2 CanBookBeRenewed
2794 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2796 Find out whether a borrowed item may be renewed.
2798 C<$borrowernumber> is the borrower number of the patron who currently
2799 has the item on loan.
2801 C<$itemnumber> is the number of the item to renew.
2803 C<$override_limit>, if supplied with a true value, causes
2804 the limit on the number of times that the loan can be renewed
2805 (as controlled by the item type) to be ignored. Overriding also allows
2806 to renew sooner than "No renewal before" and to manually renew loans
2807 that are automatically renewed.
2809 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2810 item must currently be on loan to the specified borrower; renewals
2811 must be allowed for the item's type; and the borrower must not have
2812 already renewed the loan. $error will contain the reason the renewal can not proceed
2816 sub CanBookBeRenewed {
2817 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2819 my $dbh = C4::Context->dbh;
2822 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2823 my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2824 return ( 0, 'onsite_checkout' ) if $itemissue->{onsite_checkout};
2826 $borrowernumber ||= $itemissue->{borrowernumber};
2827 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2830 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2832 # This item can fill one or more unfilled reserve, can those unfilled reserves
2833 # all be filled by other available items?
2835 && C4::Context->preference('AllowRenewalIfOtherItemsAvailable') )
2837 my $schema = Koha::Database->new()->schema();
2839 my $item_holds = $schema->resultset('Reserve')->search( { itemnumber => $itemnumber, found => undef } )->count();
2841 # There is an item level hold on this item, no other item can fill the hold
2846 # Get all other items that could possibly fill reserves
2847 my @itemnumbers = $schema->resultset('Item')->search(
2849 biblionumber => $resrec->{biblionumber},
2852 -not => { itemnumber => $itemnumber }
2854 { columns => 'itemnumber' }
2855 )->get_column('itemnumber')->all();
2857 # Get all other reserves that could have been filled by this item
2858 my @borrowernumbers;
2860 my ( $reserve_found, $reserve, undef ) =
2861 C4::Reserves::CheckReserves( $itemnumber, undef, undef, \@borrowernumbers );
2863 if ($reserve_found) {
2864 push( @borrowernumbers, $reserve->{borrowernumber} );
2871 # If the count of the union of the lists of reservable items for each borrower
2872 # is equal or greater than the number of borrowers, we know that all reserves
2873 # can be filled with available items. We can get the union of the sets simply
2874 # by pushing all the elements onto an array and removing the duplicates.
2876 foreach my $b (@borrowernumbers) {
2877 my ($borr) = C4::Members::GetMemberDetails($b);
2878 foreach my $i (@itemnumbers) {
2879 my $item = GetItem($i);
2880 if ( IsAvailableForItemLevelRequest( $item, $borr )
2881 && CanItemBeReserved( $b, $i )
2882 && !IsItemOnHoldAndFound($i) )
2884 push( @reservable, $i );
2889 @reservable = uniq(@reservable);
2891 if ( @reservable >= @borrowernumbers ) {
2896 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2898 return ( 1, undef ) if $override_limit;
2900 my $branchcode = _GetCircControlBranch( $item, $borrower );
2902 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2904 return ( 0, "too_many" )
2905 if $issuingrule->{renewalsallowed} <= $itemissue->{renewals};
2907 my $overduesblockrenewing = C4::Context->preference('OverduesBlockRenewing');
2908 my $restrictionblockrenewing = C4::Context->preference('RestrictionBlockRenewing');
2909 my $restricted = Koha::Patron::Debarments::IsDebarred($borrowernumber);
2910 my $hasoverdues = C4::Members::HasOverdues($borrowernumber);
2912 if ( $restricted and $restrictionblockrenewing ) {
2913 return ( 0, 'restriction');
2914 } elsif ( ($hasoverdues and $overduesblockrenewing eq 'block') || ($itemissue->{overdue} and $overduesblockrenewing eq 'blockitem') ) {
2915 return ( 0, 'overdue');
2918 if ( defined $issuingrule->{norenewalbefore}
2919 and $issuingrule->{norenewalbefore} ne "" )
2922 # Calculate soonest renewal by subtracting 'No renewal before' from due date
2923 my $soonestrenewal =
2924 $itemissue->{date_due}->clone()
2926 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore} );
2928 # Depending on syspref reset the exact time, only check the date
2929 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
2930 and $issuingrule->{lengthunit} eq 'days' )
2932 $soonestrenewal->truncate( to => 'day' );
2935 if ( $soonestrenewal > DateTime->now( time_zone => C4::Context->tz() ) )
2937 return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2938 return ( 0, "too_soon" );
2940 elsif ( $itemissue->{auto_renew} ) {
2941 return ( 0, "auto_renew" );
2945 # Fallback for automatic renewals:
2946 # If norenewalbefore is undef, don't renew before due date.
2947 elsif ( $itemissue->{auto_renew} ) {
2948 my $now = dt_from_string;
2949 return ( 0, "auto_renew" )
2950 if $now >= $itemissue->{date_due};
2951 return ( 0, "auto_too_soon" );
2954 return ( 1, undef );
2959 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2963 C<$borrowernumber> is the borrower number of the patron who currently
2966 C<$itemnumber> is the number of the item to renew.
2968 C<$branch> is the library where the renewal took place (if any).
2969 The library that controls the circ policies for the renewal is retrieved from the issues record.
2971 C<$datedue> can be a DateTime object used to set the due date.
2973 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2974 this parameter is not supplied, lastreneweddate is set to the current date.
2976 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2977 from the book's item type.
2982 my $borrowernumber = shift;
2983 my $itemnumber = shift or return;
2985 my $datedue = shift;
2986 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2988 my $item = GetItem($itemnumber) or return;
2989 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2991 my $dbh = C4::Context->dbh;
2993 # Find the issues record for this book
2995 $dbh->prepare("SELECT * FROM issues WHERE itemnumber = ?");
2996 $sth->execute( $itemnumber );
2997 my $issuedata = $sth->fetchrow_hashref;
2999 return unless ( $issuedata );
3001 $borrowernumber ||= $issuedata->{borrowernumber};
3003 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
3004 carp 'Invalid date passed to AddRenewal.';
3008 # If the due date wasn't specified, calculate it by adding the
3009 # book's loan length to today's date or the current due date
3010 # based on the value of the RenewalPeriodBase syspref.
3013 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
3014 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
3016 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
3017 dt_from_string( $issuedata->{date_due} ) :
3018 DateTime->now( time_zone => C4::Context->tz());
3019 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
3022 # Update the issues record to have the new due date, and a new count
3023 # of how many times it has been renewed.
3024 my $renews = $issuedata->{'renewals'} + 1;
3025 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
3026 WHERE borrowernumber=?
3030 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
3032 # Update the renewal count on the item, and tell zebra to reindex
3033 $renews = $biblio->{'renewals'} + 1;
3034 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
3036 # Charge a new rental fee, if applicable?
3037 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
3038 if ( $charge > 0 ) {
3039 my $accountno = getnextacctno( $borrowernumber );
3040 my $item = GetBiblioFromItemNumber($itemnumber);
3042 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3043 $sth = $dbh->prepare(
3044 "INSERT INTO accountlines
3045 (date, borrowernumber, accountno, amount, manager_id,
3046 description,accounttype, amountoutstanding, itemnumber)
3047 VALUES (now(),?,?,?,?,?,?,?,?)"
3049 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
3050 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
3051 'Rent', $charge, $itemnumber );
3054 # Send a renewal slip according to checkout alert preferencei
3055 if ( C4::Context->preference('RenewalSendNotice') eq '1') {
3056 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
3057 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
3059 branchcode => $branch,
3060 categorycode => $borrower->{categorycode},
3061 item_type => $item->{itype},
3062 notification => 'CHECKOUT',
3064 if ($circulation_alert->is_enabled_for(\%conditions)) {
3065 SendCirculationAlert({
3068 borrower => $borrower,
3074 # Remove any OVERDUES related debarment if the borrower has no overdues
3075 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
3076 if ( $borrowernumber
3077 && $borrower->{'debarred'}
3078 && !C4::Members::HasOverdues( $borrowernumber )
3079 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
3081 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
3085 UpdateStats({branch => $branch,
3088 itemnumber => $itemnumber,
3089 itemtype => $item->{itype},
3090 borrowernumber => $borrowernumber,
3091 ccode => $item->{'ccode'}}
3097 # check renewal status
3098 my ( $bornum, $itemno ) = @_;
3099 my $dbh = C4::Context->dbh;
3101 my $renewsallowed = 0;
3104 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
3105 my $item = GetItem($itemno);
3107 # Look in the issues table for this item, lent to this borrower,
3108 # and not yet returned.
3110 # FIXME - I think this function could be redone to use only one SQL call.
3111 my $sth = $dbh->prepare(
3112 "select * from issues
3113 where (borrowernumber = ?)
3114 and (itemnumber = ?)"
3116 $sth->execute( $bornum, $itemno );
3117 my $data = $sth->fetchrow_hashref;
3118 $renewcount = $data->{'renewals'} if $data->{'renewals'};
3119 # $item and $borrower should be calculated
3120 my $branchcode = _GetCircControlBranch($item, $borrower);
3122 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
3124 $renewsallowed = $issuingrule->{'renewalsallowed'};
3125 $renewsleft = $renewsallowed - $renewcount;
3126 if($renewsleft < 0){ $renewsleft = 0; }
3127 return ( $renewcount, $renewsallowed, $renewsleft );
3130 =head2 GetSoonestRenewDate
3132 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
3134 Find out the soonest possible renew date of a borrowed item.
3136 C<$borrowernumber> is the borrower number of the patron who currently
3137 has the item on loan.
3139 C<$itemnumber> is the number of the item to renew.
3141 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
3142 renew date, based on the value "No renewal before" of the applicable
3143 issuing rule. Returns the current date if the item can already be
3144 renewed, and returns undefined if the borrower, loan, or item
3149 sub GetSoonestRenewDate {
3150 my ( $borrowernumber, $itemnumber ) = @_;
3152 my $dbh = C4::Context->dbh;
3154 my $item = GetItem($itemnumber) or return;
3155 my $itemissue = GetItemIssue($itemnumber) or return;
3157 $borrowernumber ||= $itemissue->{borrowernumber};
3158 my $borrower = C4::Members::GetMemberDetails($borrowernumber)
3161 my $branchcode = _GetCircControlBranch( $item, $borrower );
3163 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
3165 my $now = dt_from_string;
3167 if ( defined $issuingrule->{norenewalbefore}
3168 and $issuingrule->{norenewalbefore} ne "" )
3170 my $soonestrenewal =
3171 $itemissue->{date_due}->clone()
3173 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore} );
3175 if ( C4::Context->preference('NoRenewalBeforePrecision') eq 'date'
3176 and $issuingrule->{lengthunit} eq 'days' )
3178 $soonestrenewal->truncate( to => 'day' );
3180 return $soonestrenewal if $now < $soonestrenewal;
3185 =head2 GetIssuingCharges
3187 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
3189 Calculate how much it would cost for a given patron to borrow a given
3190 item, including any applicable discounts.
3192 C<$itemnumber> is the item number of item the patron wishes to borrow.
3194 C<$borrowernumber> is the patron's borrower number.
3196 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
3197 and C<$item_type> is the code for the item's item type (e.g., C<VID>
3202 sub GetIssuingCharges {
3204 # calculate charges due
3205 my ( $itemnumber, $borrowernumber ) = @_;
3207 my $dbh = C4::Context->dbh;
3210 # Get the book's item type and rental charge (via its biblioitem).
3211 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
3212 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
3213 $charge_query .= (C4::Context->preference('item-level_itypes'))
3214 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
3215 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
3217 $charge_query .= ' WHERE items.itemnumber =?';
3219 my $sth = $dbh->prepare($charge_query);
3220 $sth->execute($itemnumber);
3221 if ( my $item_data = $sth->fetchrow_hashref ) {
3222 $item_type = $item_data->{itemtype};
3223 $charge = $item_data->{rentalcharge};
3224 my $branch = C4::Branch::mybranch();
3225 my $discount_query = q|SELECT rentaldiscount,
3226 issuingrules.itemtype, issuingrules.branchcode
3228 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
3229 WHERE borrowers.borrowernumber = ?
3230 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
3231 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
3232 my $discount_sth = $dbh->prepare($discount_query);
3233 $discount_sth->execute( $borrowernumber, $item_type, $branch );
3234 my $discount_rules = $discount_sth->fetchall_arrayref({});
3235 if (@{$discount_rules}) {
3236 # We may have multiple rules so get the most specific
3237 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
3238 $charge = ( $charge * ( 100 - $discount ) ) / 100;
3242 return ( $charge, $item_type );
3245 # Select most appropriate discount rule from those returned
3246 sub _get_discount_from_rule {
3247 my ($rules_ref, $branch, $itemtype) = @_;
3250 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
3251 $discount = $rules_ref->[0]->{rentaldiscount};
3252 return (defined $discount) ? $discount : 0;
3254 # could have up to 4 does one match $branch and $itemtype
3255 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
3257 $discount = $d[0]->{rentaldiscount};
3258 return (defined $discount) ? $discount : 0;
3260 # do we have item type + all branches
3261 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
3263 $discount = $d[0]->{rentaldiscount};
3264 return (defined $discount) ? $discount : 0;
3266 # do we all item types + this branch
3267 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
3269 $discount = $d[0]->{rentaldiscount};
3270 return (defined $discount) ? $discount : 0;
3272 # so all and all (surely we wont get here)
3273 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
3275 $discount = $d[0]->{rentaldiscount};
3276 return (defined $discount) ? $discount : 0;
3282 =head2 AddIssuingCharge
3284 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
3288 sub AddIssuingCharge {
3289 my ( $itemnumber, $borrowernumber, $charge ) = @_;
3290 my $dbh = C4::Context->dbh;
3291 my $nextaccntno = getnextacctno( $borrowernumber );
3293 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3295 INSERT INTO accountlines
3296 (borrowernumber, itemnumber, accountno,
3297 date, amount, description, accounttype,
3298 amountoutstanding, manager_id)
3299 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3301 my $sth = $dbh->prepare($query);
3302 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3307 GetTransfers($itemnumber);
3312 my ($itemnumber) = @_;
3314 my $dbh = C4::Context->dbh;
3320 FROM branchtransfers
3321 WHERE itemnumber = ?
3322 AND datearrived IS NULL
3324 my $sth = $dbh->prepare($query);
3325 $sth->execute($itemnumber);
3326 my @row = $sth->fetchrow_array();
3330 =head2 GetTransfersFromTo
3332 @results = GetTransfersFromTo($frombranch,$tobranch);
3334 Returns the list of pending transfers between $from and $to branch
3338 sub GetTransfersFromTo {
3339 my ( $frombranch, $tobranch ) = @_;
3340 return unless ( $frombranch && $tobranch );
3341 my $dbh = C4::Context->dbh;
3343 SELECT itemnumber,datesent,frombranch
3344 FROM branchtransfers
3347 AND datearrived IS NULL
3349 my $sth = $dbh->prepare($query);
3350 $sth->execute( $frombranch, $tobranch );
3353 while ( my $data = $sth->fetchrow_hashref ) {
3354 push @gettransfers, $data;
3356 return (@gettransfers);
3359 =head2 DeleteTransfer
3361 &DeleteTransfer($itemnumber);
3365 sub DeleteTransfer {
3366 my ($itemnumber) = @_;
3367 return unless $itemnumber;
3368 my $dbh = C4::Context->dbh;
3369 my $sth = $dbh->prepare(
3370 "DELETE FROM branchtransfers
3372 AND datearrived IS NULL "
3374 return $sth->execute($itemnumber);
3377 =head2 AnonymiseIssueHistory
3379 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
3381 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
3382 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
3384 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
3385 setting (force delete).
3387 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
3391 sub AnonymiseIssueHistory {
3393 my $borrowernumber = shift;
3394 my $dbh = C4::Context->dbh;
3397 SET borrowernumber = ?
3398 WHERE returndate < ?
3399 AND borrowernumber IS NOT NULL
3402 # The default of 0 does not work due to foreign key constraints
3403 # The anonymisation should not fail quietly if AnonymousPatron is not a valid entry
3404 # Set it to undef (NULL)
3405 my $anonymouspatron = C4::Context->preference('AnonymousPatron') || undef;
3406 my @bind_params = ($anonymouspatron, $date);
3407 if (defined $borrowernumber) {
3408 $query .= " AND borrowernumber = ?";
3409 push @bind_params, $borrowernumber;
3411 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
3413 my $sth = $dbh->prepare($query);
3414 $sth->execute(@bind_params);
3415 my $anonymisation_err = $dbh->err;
3416 my $rows_affected = $sth->rows; ### doublecheck row count return function
3417 return ($rows_affected, $anonymisation_err);
3420 =head2 SendCirculationAlert
3422 Send out a C<check-in> or C<checkout> alert using the messaging system.
3430 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3434 Hashref of information about the item being checked in or out.
3438 Hashref of information about the borrower of the item.
3442 The branchcode from where the checkout or check-in took place.
3448 SendCirculationAlert({
3451 borrower => $borrower,
3457 sub SendCirculationAlert {
3459 my ($type, $item, $borrower, $branch) =
3460 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3461 my %message_name = (
3462 CHECKIN => 'Item_Check_in',
3463 CHECKOUT => 'Item_Checkout',
3464 RENEWAL => 'Item_Checkout',
3466 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3467 borrowernumber => $borrower->{borrowernumber},
3468 message_name => $message_name{$type},
3470 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3472 my @transports = keys %{ $borrower_preferences->{transports} };
3473 # warn "no transports" unless @transports;
3475 # warn "transport: $_";
3476 my $message = C4::Message->find_last_message($borrower, $type, $_);
3478 #warn "create new message";
3479 my $letter = C4::Letters::GetPreparedLetter (
3480 module => 'circulation',
3481 letter_code => $type,
3482 branchcode => $branch,
3483 message_transport_type => $_,
3485 $issues_table => $item->{itemnumber},
3486 'items' => $item->{itemnumber},
3487 'biblio' => $item->{biblionumber},
3488 'biblioitems' => $item->{biblionumber},
3489 'borrowers' => $borrower,
3490 'branches' => $branch,
3493 C4::Message->enqueue($letter, $borrower, $_);
3495 #warn "append to old message";
3496 my $letter = C4::Letters::GetPreparedLetter (
3497 module => 'circulation',
3498 letter_code => $type,
3499 branchcode => $branch,
3500 message_transport_type => $_,
3502 $issues_table => $item->{itemnumber},
3503 'items' => $item->{itemnumber},
3504 'biblio' => $item->{biblionumber},
3505 'biblioitems' => $item->{biblionumber},
3506 'borrowers' => $borrower,
3507 'branches' => $branch,
3510 $message->append($letter);
3518 =head2 updateWrongTransfer
3520 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3522 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
3526 sub updateWrongTransfer {
3527 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3528 my $dbh = C4::Context->dbh;
3529 # first step validate the actual line of transfert .
3532 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3534 $sth->execute($FromLibrary,$itemNumber);
3536 # second step create a new line of branchtransfer to the right location .
3537 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3539 #third step changing holdingbranch of item
3540 UpdateHoldingbranch($FromLibrary,$itemNumber);
3543 =head2 UpdateHoldingbranch
3545 $items = UpdateHoldingbranch($branch,$itmenumber);
3547 Simple methode for updating hodlingbranch in items BDD line
3551 sub UpdateHoldingbranch {
3552 my ( $branch,$itemnumber ) = @_;
3553 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3558 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3560 this function calculates the due date given the start date and configured circulation rules,
3561 checking against the holidays calendar as per the 'useDaysMode' syspref.
3562 C<$startdate> = DateTime object representing start date of loan period (assumed to be today)
3563 C<$itemtype> = itemtype code of item in question
3564 C<$branch> = location whose calendar to use
3565 C<$borrower> = Borrower object
3566 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3571 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3575 # loanlength now a href
3577 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3579 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3585 if (ref $startdate ne 'DateTime' ) {
3586 $datedue = dt_from_string($datedue);
3588 $datedue = $startdate->clone;
3592 DateTime->now( time_zone => C4::Context->tz() )
3593 ->truncate( to => 'minute' );
3597 # calculate the datedue as normal
3598 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3599 { # ignoring calendar
3600 if ( $loanlength->{lengthunit} eq 'hours' ) {
3601 $datedue->add( hours => $loanlength->{$length_key} );
3603 $datedue->add( days => $loanlength->{$length_key} );
3604 $datedue->set_hour(23);
3605 $datedue->set_minute(59);
3609 if ($loanlength->{lengthunit} eq 'hours') {
3610 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3613 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3615 my $calendar = Koha::Calendar->new( branchcode => $branch );
3616 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3617 if ($loanlength->{lengthunit} eq 'days') {
3618 $datedue->set_hour(23);
3619 $datedue->set_minute(59);
3623 # if Hard Due Dates are used, retrieve them and apply as necessary
3624 my ( $hardduedate, $hardduedatecompare ) =
3625 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3626 if ($hardduedate) { # hardduedates are currently dates
3627 $hardduedate->truncate( to => 'minute' );
3628 $hardduedate->set_hour(23);
3629 $hardduedate->set_minute(59);
3630 my $cmp = DateTime->compare( $hardduedate, $datedue );
3632 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3633 # if the calculated date is before the 'after' Hard Due Date (floor), override
3634 # if the hard due date is set to 'exactly', overrride
3635 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3636 $datedue = $hardduedate->clone;
3639 # in all other cases, keep the date due as it is
3643 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3644 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3645 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso', 'floating');
3646 if( $expiry_dt ) { #skip empty expiry date..
3647 $expiry_dt->set( hour => 23, minute => 59);
3648 my $d1= $datedue->clone->set_time_zone('floating');
3649 if ( DateTime->compare( $d1, $expiry_dt ) == 1 ) {
3650 $datedue = $expiry_dt->clone->set_time_zone( C4::Context->tz );
3659 sub CheckValidBarcode{
3661 my $dbh = C4::Context->dbh;
3662 my $query=qq|SELECT count(*)
3666 my $sth = $dbh->prepare($query);
3667 $sth->execute($barcode);
3668 my $exist=$sth->fetchrow ;
3672 =head2 IsBranchTransferAllowed
3674 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3676 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3680 sub IsBranchTransferAllowed {
3681 my ( $toBranch, $fromBranch, $code ) = @_;
3683 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3685 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3686 my $dbh = C4::Context->dbh;
3688 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3689 $sth->execute( $toBranch, $fromBranch, $code );
3690 my $limit = $sth->fetchrow_hashref();
3692 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3693 if ( $limit->{'limitId'} ) {
3700 =head2 CreateBranchTransferLimit
3702 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3704 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3708 sub CreateBranchTransferLimit {
3709 my ( $toBranch, $fromBranch, $code ) = @_;
3710 return unless defined($toBranch) && defined($fromBranch);
3711 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3713 my $dbh = C4::Context->dbh;
3715 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3716 return $sth->execute( $code, $toBranch, $fromBranch );
3719 =head2 DeleteBranchTransferLimits
3721 my $result = DeleteBranchTransferLimits($frombranch);
3723 Deletes all the library transfer limits for one library. Returns the
3724 number of limits deleted, 0e0 if no limits were deleted, or undef if
3725 no arguments are supplied.
3729 sub DeleteBranchTransferLimits {
3731 return unless defined $branch;
3732 my $dbh = C4::Context->dbh;
3733 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3734 return $sth->execute($branch);
3738 my ( $borrowernumber, $itemnum ) = @_;
3740 MarkIssueReturned( $borrowernumber, $itemnum );
3741 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3742 my $item = C4::Items::GetItem( $itemnum );
3743 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3744 my @datearr = localtime(time);
3745 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3746 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3747 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3752 my ($itemnumber, $mark_returned) = @_;
3754 my $dbh = C4::Context->dbh();
3755 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3757 JOIN items USING (itemnumber)
3758 JOIN biblio USING (biblionumber)
3759 WHERE issues.itemnumber=?");
3760 $sth->execute($itemnumber);
3761 my $issues=$sth->fetchrow_hashref();
3763 # If a borrower lost the item, add a replacement cost to the their record
3764 if ( my $borrowernumber = $issues->{borrowernumber} ){
3765 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3767 if (C4::Context->preference('WhenLostForgiveFine')){
3768 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3769 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3771 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3772 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3773 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3774 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3777 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3781 sub GetOfflineOperations {
3782 my $dbh = C4::Context->dbh;
3783 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3784 $sth->execute(C4::Context->userenv->{'branch'});
3785 my $results = $sth->fetchall_arrayref({});
3789 sub GetOfflineOperation {
3790 my $operationid = shift;
3791 return unless $operationid;
3792 my $dbh = C4::Context->dbh;
3793 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3794 $sth->execute( $operationid );
3795 return $sth->fetchrow_hashref;
3798 sub AddOfflineOperation {
3799 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3800 my $dbh = C4::Context->dbh;
3801 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3802 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3806 sub DeleteOfflineOperation {
3807 my $dbh = C4::Context->dbh;
3808 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3809 $sth->execute( shift );
3813 sub ProcessOfflineOperation {
3814 my $operation = shift;
3817 if ( $operation->{action} eq 'return' ) {
3818 $report = ProcessOfflineReturn( $operation );
3819 } elsif ( $operation->{action} eq 'issue' ) {
3820 $report = ProcessOfflineIssue( $operation );
3821 } elsif ( $operation->{action} eq 'payment' ) {
3822 $report = ProcessOfflinePayment( $operation );
3825 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3830 sub ProcessOfflineReturn {
3831 my $operation = shift;
3833 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3835 if ( $itemnumber ) {
3836 my $issue = GetOpenIssue( $itemnumber );
3839 $issue->{borrowernumber},
3842 $operation->{timestamp},
3845 { renewals => 0, onloan => undef },
3846 $issue->{'biblionumber'},
3851 return "Item not issued.";
3854 return "Item not found.";
3858 sub ProcessOfflineIssue {
3859 my $operation = shift;
3861 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3863 if ( $borrower->{borrowernumber} ) {
3864 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3865 unless ($itemnumber) {
3866 return "Barcode not found.";
3868 my $issue = GetOpenIssue( $itemnumber );
3870 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3872 $issue->{borrowernumber},
3875 $operation->{timestamp},
3880 $operation->{'barcode'},
3883 $operation->{timestamp},
3888 return "Borrower not found.";
3892 sub ProcessOfflinePayment {
3893 my $operation = shift;
3895 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3896 my $amount = $operation->{amount};
3898 recordpayment( $borrower->{borrowernumber}, $amount );
3906 TransferSlip($user_branch, $itemnumber, $barcode, $to_branch)
3908 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3913 my ($branch, $itemnumber, $barcode, $to_branch) = @_;
3915 my $item = GetItem( $itemnumber, $barcode )
3918 return C4::Letters::GetPreparedLetter (
3919 module => 'circulation',
3920 letter_code => 'TRANSFERSLIP',
3921 branchcode => $branch,
3923 'branches' => $to_branch,
3924 'biblio' => $item->{biblionumber},
3930 =head2 CheckIfIssuedToPatron
3932 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3934 Return 1 if any record item is issued to patron, otherwise return 0
3938 sub CheckIfIssuedToPatron {
3939 my ($borrowernumber, $biblionumber) = @_;
3941 my $dbh = C4::Context->dbh;
3943 SELECT COUNT(*) FROM issues
3944 LEFT JOIN items ON items.itemnumber = issues.itemnumber
3945 WHERE items.biblionumber = ?
3946 AND issues.borrowernumber = ?
3948 my $is_issued = $dbh->selectrow_array($query, {}, $biblionumber, $borrowernumber );
3949 return 1 if $is_issued;
3955 IsItemIssued( $itemnumber )
3957 Return 1 if the item is on loan, otherwise return 0
3962 my $itemnumber = shift;
3963 my $dbh = C4::Context->dbh;
3964 my $sth = $dbh->prepare(q{
3967 WHERE itemnumber = ?
3969 $sth->execute($itemnumber);
3970 return $sth->fetchrow;
3973 =head2 GetAgeRestriction
3975 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions, $borrower);
3976 my ($ageRestriction, $daysToAgeRestriction) = GetAgeRestriction($record_restrictions);
3978 if($daysToAgeRestriction <= 0) { #Borrower is allowed to access this material, as he is older or as old as the agerestriction }
3979 if($daysToAgeRestriction > 0) { #Borrower is this many days from meeting the agerestriction }
3981 @PARAM1 the koha.biblioitems.agerestriction value, like K18, PEGI 13, ...
3982 @PARAM2 a borrower-object with koha.borrowers.dateofbirth. (OPTIONAL)
3983 @RETURNS The age restriction age in years and the days to fulfill the age restriction for the given borrower.
3984 Negative days mean the borrower has gone past the age restriction age.
3988 sub GetAgeRestriction {
3989 my ($record_restrictions, $borrower) = @_;
3990 my $markers = C4::Context->preference('AgeRestrictionMarker');
3992 # Split $record_restrictions to something like FSK 16 or PEGI 6
3993 my @values = split ' ', uc($record_restrictions);
3994 return unless @values;
3996 # Search first occurrence of one of the markers
3997 my @markers = split /\|/, uc($markers);
3998 return unless @markers;
4001 my $restriction_year = 0;
4002 for my $value (@values) {
4004 for my $marker (@markers) {
4005 $marker =~ s/^\s+//; #remove leading spaces
4006 $marker =~ s/\s+$//; #remove trailing spaces
4007 if ( $marker eq $value ) {
4008 if ( $index <= $#values ) {
4009 $restriction_year += $values[$index];
4013 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
4015 # Perhaps it is something like "K16" (as in Finland)
4016 $restriction_year += $1;
4020 last if ( $restriction_year > 0 );
4023 #Check if the borrower is age restricted for this material and for how long.
4024 if ($restriction_year && $borrower) {
4025 if ( $borrower->{'dateofbirth'} ) {
4026 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
4027 $alloweddate[0] += $restriction_year;
4029 #Prevent runime eror on leap year (invalid date)
4030 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
4031 $alloweddate[2] = 28;
4034 #Get how many days the borrower has to reach the age restriction
4035 my $daysToAgeRestriction = Date_to_Days(@alloweddate) - Date_to_Days(Today);
4036 #Negative days means the borrower went past the age restriction age
4037 return ($restriction_year, $daysToAgeRestriction);
4041 return ($restriction_year);
4045 =head2 GetPendingOnSiteCheckouts
4049 sub GetPendingOnSiteCheckouts {
4050 my $dbh = C4::Context->dbh;
4051 return $dbh->selectall_arrayref(q|
4057 items.itemcallnumber,
4061 issues.date_due < NOW() AS is_overdue,
4064 borrowers.firstname,
4066 borrowers.cardnumber,
4067 borrowers.borrowernumber
4069 LEFT JOIN issues ON items.itemnumber = issues.itemnumber
4070 LEFT JOIN biblio ON items.biblionumber = biblio.biblionumber
4071 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
4072 WHERE issues.onsite_checkout = 1
4073 |, { Slice => {} } );
4079 my ($count, $branch, $itemtype, $ccode, $newness)
4080 = @$params{qw(count branch itemtype ccode newness)};
4082 my $dbh = C4::Context->dbh;
4084 SELECT b.biblionumber, b.title, b.author, bi.itemtype, bi.publishercode,
4085 bi.place, bi.publicationyear, b.copyrightdate, bi.pages, bi.size,
4086 i.ccode, SUM(i.issues) AS count
4088 LEFT JOIN items i ON (i.biblionumber = b.biblionumber)
4089 LEFT JOIN biblioitems bi ON (bi.biblionumber = b.biblionumber)
4092 my (@where_strs, @where_args);
4095 push @where_strs, 'i.homebranch = ?';
4096 push @where_args, $branch;
4099 if (C4::Context->preference('item-level_itypes')){
4100 push @where_strs, 'i.itype = ?';
4101 push @where_args, $itemtype;
4103 push @where_strs, 'bi.itemtype = ?';
4104 push @where_args, $itemtype;
4108 push @where_strs, 'i.ccode = ?';
4109 push @where_args, $ccode;
4112 push @where_strs, 'TO_DAYS(NOW()) - TO_DAYS(b.datecreated) <= ?';
4113 push @where_args, $newness;
4117 $query .= 'WHERE ' . join(' AND ', @where_strs);
4121 GROUP BY b.biblionumber
4126 $count = int($count);
4128 $query .= "LIMIT $count";
4131 my $rows = $dbh->selectall_arrayref($query, { Slice => {} }, @where_args);
4141 Koha Development Team <http://koha-community.org/>