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 under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #use warnings; FIXME - Bug 2505
32 use C4::Dates qw(format_date);
34 use C4::ItemCirculationAlertPreference;
37 use C4::Branch; # GetBranches
38 use C4::Log; # logaction
40 GetAuthorisedValueByCode
42 GetKohaAuthorisedValueLib
44 use C4::Overdues qw(CalcFine UpdateFine);
45 use Algorithm::CheckDigits;
60 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
64 $VERSION = 3.07.00.049; # for version checking
67 # FIXME subs that should probably be elsewhere
74 # subs to deal with issuing a book
85 &GetBranchBorrowerCircRule
89 &AnonymiseIssueHistory
90 &CheckIfIssuedToPatron
94 # subs to deal with returns
100 # subs to deal with transfers
107 &IsBranchTransferAllowed
108 &CreateBranchTransferLimit
109 &DeleteBranchTransferLimits
113 # subs to deal with offline circulation
115 &GetOfflineOperations
118 &DeleteOfflineOperation
119 &ProcessOfflineOperation
125 C4::Circulation - Koha circulation module
133 The functions in this module deal with circulation, issues, and
134 returns, as well as general information about the library.
135 Also deals with stocktaking.
141 $str = &barcodedecode($barcode, [$filter]);
143 Generic filter function for barcode string.
144 Called on every circ if the System Pref itemBarcodeInputFilter is set.
145 Will do some manipulation of the barcode for systems that deliver a barcode
146 to circulation.pl that differs from the barcode stored for the item.
147 For proper functioning of this filter, calling the function on the
148 correct barcode string (items.barcode) should return an unaltered barcode.
150 The optional $filter argument is to allow for testing or explicit
151 behavior that ignores the System Pref. Valid values are the same as the
156 # FIXME -- the &decode fcn below should be wrapped into this one.
157 # FIXME -- these plugins should be moved out of Circulation.pm
160 my ($barcode, $filter) = @_;
161 my $branch = C4::Branch::mybranch();
162 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
163 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
164 if ($filter eq 'whitespace') {
166 } elsif ($filter eq 'cuecat') {
168 my @fields = split( /\./, $barcode );
169 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
170 ($#results == 2) and return $results[2];
171 } elsif ($filter eq 'T-prefix') {
172 if ($barcode =~ /^[Tt](\d)/) {
173 (defined($1) and $1 eq '0') and return $barcode;
174 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
176 return sprintf("T%07d", $barcode);
177 # FIXME: $barcode could be "T1", causing warning: substr outside of string
178 # Why drop the nonzero digit after the T?
179 # Why pass non-digits (or empty string) to "T%07d"?
180 } elsif ($filter eq 'libsuite8') {
181 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
182 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
183 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
185 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
188 } elsif ($filter eq 'EAN13') {
189 my $ean = CheckDigits('ean');
190 if ( $ean->is_valid($barcode) ) {
191 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
192 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
194 warn "# [$barcode] not valid EAN-13/UPC-A\n";
197 return $barcode; # return barcode, modified or not
202 $str = &decode($chunk);
204 Decodes a segment of a string emitted by a CueCat barcode scanner and
207 FIXME: Should be replaced with Barcode::Cuecat from CPAN
208 or Javascript based decoding on the client side.
215 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
216 my @s = map { index( $seq, $_ ); } split( //, $encoded );
217 my $l = ( $#s + 1 ) % 4;
220 # warn "Error: Cuecat decode parsing failed!";
228 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
230 chr( ( $n >> 16 ) ^ 67 )
231 .chr( ( $n >> 8 & 255 ) ^ 67 )
232 .chr( ( $n & 255 ) ^ 67 );
235 $r = substr( $r, 0, length($r) - $l );
241 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
242 $barcode, $ignore_reserves);
244 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
246 C<$newbranch> is the code for the branch to which the item should be transferred.
248 C<$barcode> is the barcode of the item to be transferred.
250 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
251 Otherwise, if an item is reserved, the transfer fails.
253 Returns three values:
259 is true if the transfer was successful.
263 is a reference-to-hash which may have any of the following keys:
269 There is no item in the catalog with the given barcode. The value is C<$barcode>.
273 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.
275 =item C<DestinationEqualsHolding>
277 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.
281 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.
285 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>.
287 =item C<WasTransferred>
289 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
298 my ( $tbr, $barcode, $ignoreRs ) = @_;
301 my $branches = GetBranches();
302 my $itemnumber = GetItemnumberFromBarcode( $barcode );
303 my $issue = GetItemIssue($itemnumber);
304 my $biblio = GetBiblioFromItemNumber($itemnumber);
307 if ( not $itemnumber ) {
308 $messages->{'BadBarcode'} = $barcode;
312 # get branches of book...
313 my $hbr = $biblio->{'homebranch'};
314 my $fbr = $biblio->{'holdingbranch'};
316 # if using Branch Transfer Limits
317 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
318 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
319 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
320 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
323 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
324 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
330 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
331 $messages->{'IsPermanent'} = $hbr;
335 # can't transfer book if is already there....
336 if ( $fbr eq $tbr ) {
337 $messages->{'DestinationEqualsHolding'} = 1;
341 # check if it is still issued to someone, return it...
342 if ($issue->{borrowernumber}) {
343 AddReturn( $barcode, $fbr );
344 $messages->{'WasReturned'} = $issue->{borrowernumber};
348 # That'll save a database query.
349 my ( $resfound, $resrec, undef ) =
350 CheckReserves( $itemnumber );
351 if ( $resfound and not $ignoreRs ) {
352 $resrec->{'ResFound'} = $resfound;
354 # $messages->{'ResFound'} = $resrec;
358 #actually do the transfer....
360 ModItemTransfer( $itemnumber, $fbr, $tbr );
362 # don't need to update MARC anymore, we do it in batch now
363 $messages->{'WasTransfered'} = 1;
366 ModDateLastSeen( $itemnumber );
367 return ( $dotransfer, $messages, $biblio );
372 my $borrower = shift;
373 my $biblionumber = shift;
375 my $cat_borrower = $borrower->{'categorycode'};
376 my $dbh = C4::Context->dbh;
378 # Get which branchcode we need
379 $branch = _GetCircControlBranch($item,$borrower);
380 my $type = (C4::Context->preference('item-level_itypes'))
381 ? $item->{'itype'} # item-level
382 : $item->{'itemtype'}; # biblio-level
384 # given branch, patron category, and item type, determine
385 # applicable issuing rule
386 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
388 # if a rule is found and has a loan limit set, count
389 # how many loans the patron already has that meet that
391 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
393 my $count_query = "SELECT COUNT(*) FROM issues
394 JOIN items USING (itemnumber) ";
396 my $rule_itemtype = $issuing_rule->{itemtype};
397 if ($rule_itemtype eq "*") {
398 # matching rule has the default item type, so count only
399 # those existing loans that don't fall under a more
401 if (C4::Context->preference('item-level_itypes')) {
402 $count_query .= " WHERE items.itype NOT IN (
403 SELECT itemtype FROM issuingrules
405 AND (categorycode = ? OR categorycode = ?)
409 $count_query .= " JOIN biblioitems USING (biblionumber)
410 WHERE biblioitems.itemtype NOT IN (
411 SELECT itemtype FROM issuingrules
413 AND (categorycode = ? OR categorycode = ?)
417 push @bind_params, $issuing_rule->{branchcode};
418 push @bind_params, $issuing_rule->{categorycode};
419 push @bind_params, $cat_borrower;
421 # rule has specific item type, so count loans of that
423 if (C4::Context->preference('item-level_itypes')) {
424 $count_query .= " WHERE items.itype = ? ";
426 $count_query .= " JOIN biblioitems USING (biblionumber)
427 WHERE biblioitems.itemtype= ? ";
429 push @bind_params, $type;
432 $count_query .= " AND borrowernumber = ? ";
433 push @bind_params, $borrower->{'borrowernumber'};
434 my $rule_branch = $issuing_rule->{branchcode};
435 if ($rule_branch ne "*") {
436 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
437 $count_query .= " AND issues.branchcode = ? ";
438 push @bind_params, $branch;
439 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
440 ; # if branch is the patron's home branch, then count all loans by patron
442 $count_query .= " AND items.homebranch = ? ";
443 push @bind_params, $branch;
447 my $count_sth = $dbh->prepare($count_query);
448 $count_sth->execute(@bind_params);
449 my ($current_loan_count) = $count_sth->fetchrow_array;
451 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
452 if ($current_loan_count >= $max_loans_allowed) {
453 return ($current_loan_count, $max_loans_allowed);
457 # Now count total loans against the limit for the branch
458 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
459 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
460 my @bind_params = ();
461 my $branch_count_query = "SELECT COUNT(*) FROM issues
462 JOIN items USING (itemnumber)
463 WHERE borrowernumber = ? ";
464 push @bind_params, $borrower->{borrowernumber};
466 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
467 $branch_count_query .= " AND issues.branchcode = ? ";
468 push @bind_params, $branch;
469 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
470 ; # if branch is the patron's home branch, then count all loans by patron
472 $branch_count_query .= " AND items.homebranch = ? ";
473 push @bind_params, $branch;
475 my $branch_count_sth = $dbh->prepare($branch_count_query);
476 $branch_count_sth->execute(@bind_params);
477 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
479 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
480 if ($current_loan_count >= $max_loans_allowed) {
481 return ($current_loan_count, $max_loans_allowed);
485 # OK, the patron can issue !!!
491 @issues = &itemissues($biblioitemnumber, $biblio);
493 Looks up information about who has borrowed the bookZ<>(s) with the
494 given biblioitemnumber.
496 C<$biblio> is ignored.
498 C<&itemissues> returns an array of references-to-hash. The keys
499 include the fields from the C<items> table in the Koha database.
500 Additional keys include:
506 If the item is currently on loan, this gives the due date.
508 If the item is not on loan, then this is either "Available" or
509 "Cancelled", if the item has been withdrawn.
513 If the item is currently on loan, this gives the card number of the
514 patron who currently has the item.
516 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
518 These give the timestamp for the last three times the item was
521 =item C<card0>, C<card1>, C<card2>
523 The card number of the last three patrons who borrowed this item.
525 =item C<borrower0>, C<borrower1>, C<borrower2>
527 The borrower number of the last three patrons who borrowed this item.
535 my ( $bibitem, $biblio ) = @_;
536 my $dbh = C4::Context->dbh;
538 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
543 $sth->execute($bibitem) || die $sth->errstr;
545 while ( my $data = $sth->fetchrow_hashref ) {
547 # Find out who currently has this item.
548 # FIXME - Wouldn't it be better to do this as a left join of
549 # some sort? Currently, this code assumes that if
550 # fetchrow_hashref() fails, then the book is on the shelf.
551 # fetchrow_hashref() can fail for any number of reasons (e.g.,
552 # database server crash), not just because no items match the
554 my $sth2 = $dbh->prepare(
555 "SELECT * FROM issues
556 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
561 $sth2->execute( $data->{'itemnumber'} );
562 if ( my $data2 = $sth2->fetchrow_hashref ) {
563 $data->{'date_due'} = $data2->{'date_due'};
564 $data->{'card'} = $data2->{'cardnumber'};
565 $data->{'borrower'} = $data2->{'borrowernumber'};
568 $data->{'date_due'} = ($data->{'withdrawn'} eq '1') ? 'Cancelled' : 'Available';
572 # Find the last 3 people who borrowed this item.
573 $sth2 = $dbh->prepare(
574 "SELECT * FROM old_issues
575 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
577 ORDER BY returndate DESC,timestamp DESC"
580 $sth2->execute( $data->{'itemnumber'} );
581 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
582 { # FIXME : error if there is less than 3 pple borrowing this item
583 if ( my $data2 = $sth2->fetchrow_hashref ) {
584 $data->{"timestamp$i2"} = $data2->{'timestamp'};
585 $data->{"card$i2"} = $data2->{'cardnumber'};
586 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
590 $results[$i] = $data;
597 =head2 CanBookBeIssued
599 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
600 $barcode, $duedatespec, $inprocess, $ignore_reserves );
602 Check if a book can be issued.
604 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
608 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
610 =item C<$barcode> is the bar code of the book being issued.
612 =item C<$duedatespec> is a C4::Dates object.
614 =item C<$inprocess> boolean switch
615 =item C<$ignore_reserves> boolean switch
623 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
624 Possible values are :
630 sticky due date is invalid
634 borrower gone with no address
638 borrower declared it's card lost
644 =head3 UNKNOWN_BARCODE
658 item is restricted (set by ??)
660 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
661 could be prevented, but ones that can be overriden by the operator.
663 Possible values are :
671 renewing, not issuing
673 =head3 ISSUED_TO_ANOTHER
675 issued to someone else.
679 reserved for someone else.
683 sticky due date is invalid or due date in the past
687 if the borrower borrows to much things
691 sub CanBookBeIssued {
692 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves ) = @_;
693 my %needsconfirmation; # filled with problems that needs confirmations
694 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
695 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
697 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
698 my $issue = GetItemIssue($item->{itemnumber});
699 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
700 $item->{'itemtype'}=$item->{'itype'};
701 my $dbh = C4::Context->dbh;
703 # MANDATORY CHECKS - unless item exists, nothing else matters
704 unless ( $item->{barcode} ) {
705 $issuingimpossible{UNKNOWN_BARCODE} = 1;
707 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
710 # DUE DATE is OK ? -- should already have checked.
712 if ($duedate && ref $duedate ne 'DateTime') {
713 $duedate = dt_from_string($duedate);
715 my $now = DateTime->now( time_zone => C4::Context->tz() );
716 unless ( $duedate ) {
717 my $issuedate = $now->clone();
719 my $branch = _GetCircControlBranch($item,$borrower);
720 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
721 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
723 # Offline circ calls AddIssue directly, doesn't run through here
724 # So issuingimpossible should be ok.
727 my $today = $now->clone();
728 $today->truncate( to => 'minute');
729 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
730 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
733 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
739 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
740 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
741 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'}, undef, $item->{'ccode'});
742 ModDateLastSeen( $item->{'itemnumber'} );
743 return( { STATS => 1 }, {});
745 if ( $borrower->{flags}->{GNA} ) {
746 $issuingimpossible{GNA} = 1;
748 if ( $borrower->{flags}->{'LOST'} ) {
749 $issuingimpossible{CARD_LOST} = 1;
751 if ( $borrower->{flags}->{'DBARRED'} ) {
752 $issuingimpossible{DEBARRED} = 1;
754 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
755 $issuingimpossible{EXPIRED} = 1;
757 my ($y, $m, $d) = split /-/,$borrower->{'dateexpiry'};
758 if ($y && $m && $d) { # are we really writing oinvalid dates to borrs
759 my $expiry_dt = DateTime->new(
763 time_zone => C4::Context->tz,
765 $expiry_dt->truncate( to => 'day');
766 my $today = $now->clone()->truncate(to => 'day');
767 if (DateTime->compare($today, $expiry_dt) == 1) {
768 $issuingimpossible{EXPIRED} = 1;
771 carp("Invalid expity date in borr");
772 $issuingimpossible{EXPIRED} = 1;
780 my ($balance, $non_issue_charges, $other_charges) =
781 C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
782 my $amountlimit = C4::Context->preference("noissuescharge");
783 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
784 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
785 if ( C4::Context->preference("IssuingInProcess") ) {
786 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
787 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
788 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
789 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
790 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
791 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
795 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
796 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
797 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
798 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
799 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
800 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
803 if ($balance > 0 && $other_charges > 0) {
804 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
807 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
808 if ($blocktype == -1) {
809 ## patron has outstanding overdue loans
810 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
811 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
813 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
814 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
816 } elsif($blocktype == 1) {
817 # patron has accrued fine days
818 $issuingimpossible{USERBLOCKEDREMAINING} = $count;
822 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
824 my ($current_loan_count, $max_loans_allowed) = TooMany( $borrower, $item->{biblionumber}, $item );
825 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
826 if (defined $max_loans_allowed && $max_loans_allowed == 0) {
827 $needsconfirmation{PATRON_CANT} = 1;
829 if($max_loans_allowed){
830 if ( C4::Context->preference("AllowTooManyOverride") ) {
831 $needsconfirmation{TOO_MANY} = 1;
832 $needsconfirmation{current_loan_count} = $current_loan_count;
833 $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
835 $issuingimpossible{TOO_MANY} = 1;
836 $issuingimpossible{current_loan_count} = $current_loan_count;
837 $issuingimpossible{max_loans_allowed} = $max_loans_allowed;
845 if ( $item->{'notforloan'} )
847 if(!C4::Context->preference("AllowNotForLoanOverride")){
848 $issuingimpossible{NOT_FOR_LOAN} = 1;
849 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
851 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
852 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
856 # we have to check itemtypes.notforloan also
857 if (C4::Context->preference('item-level_itypes')){
858 # this should probably be a subroutine
859 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
860 $sth->execute($item->{'itemtype'});
861 my $notforloan=$sth->fetchrow_hashref();
862 if ($notforloan->{'notforloan'}) {
863 if (!C4::Context->preference("AllowNotForLoanOverride")) {
864 $issuingimpossible{NOT_FOR_LOAN} = 1;
865 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
867 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
868 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
872 elsif ($biblioitem->{'notforloan'} == 1){
873 if (!C4::Context->preference("AllowNotForLoanOverride")) {
874 $issuingimpossible{NOT_FOR_LOAN} = 1;
875 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
877 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
878 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
882 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
884 $issuingimpossible{WTHDRAWN} = 1;
886 if ( $item->{'restricted'}
887 && $item->{'restricted'} == 1 )
889 $issuingimpossible{RESTRICTED} = 1;
891 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
892 my $code = GetAuthorisedValueByCode( 'LOST', $item->{'itemlost'} );
893 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
894 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
896 if ( C4::Context->preference("IndependentBranches") ) {
897 my $userenv = C4::Context->userenv;
898 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
899 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
900 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
901 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
903 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
904 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
909 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
911 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
914 # Already issued to current borrower. Ask whether the loan should
916 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
917 $borrower->{'borrowernumber'},
918 $item->{'itemnumber'}
920 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
921 $issuingimpossible{NO_MORE_RENEWALS} = 1;
924 $needsconfirmation{RENEW_ISSUE} = 1;
927 elsif ($issue->{borrowernumber}) {
929 # issued to someone else
930 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
932 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
933 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
934 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
935 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
936 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
937 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
940 unless ( $ignore_reserves ) {
941 # See if the item is on reserve.
942 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
944 my $resbor = $res->{'borrowernumber'};
945 if ( $resbor ne $borrower->{'borrowernumber'} ) {
946 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
947 my $branchname = GetBranchName( $res->{'branchcode'} );
948 if ( $restype eq "Waiting" )
950 # The item is on reserve and waiting, but has been
951 # reserved by some other patron.
952 $needsconfirmation{RESERVE_WAITING} = 1;
953 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
954 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
955 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
956 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
957 $needsconfirmation{'resbranchname'} = $branchname;
958 $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
960 elsif ( $restype eq "Reserved" ) {
961 # The item is on reserve for someone else.
962 $needsconfirmation{RESERVED} = 1;
963 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
964 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
965 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
966 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
967 $needsconfirmation{'resbranchname'} = $branchname;
968 $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
974 # CHECK AGE RESTRICTION
977 # get $marker from preferences. Could be something like "FSK|PEGI|Alter|Age:"
978 my $markers = C4::Context->preference('AgeRestrictionMarker' );
979 my $bibvalues = $biblioitem->{'agerestriction'};
980 if (($markers)&&($bibvalues))
982 # Split $bibvalues to something like FSK 16 or PEGI 6
983 my @values = split ' ', $bibvalues;
985 # Search first occurence of one of the markers
986 my @markers = split /\|/, $markers;
989 for my $value (@values) {
991 for my $marker (@markers) {
992 $marker =~ s/^\s+//; #remove leading spaces
993 $marker =~ s/\s+$//; #remove trailing spaces
994 if (uc($marker) eq uc($value)) {
1003 # Index points to the next value
1004 my $restrictionyear = 0;
1005 if (($take <= $#values) && ($take >= 0)){
1006 $restrictionyear += $values[$take];
1009 if ($restrictionyear > 0) {
1010 if ( $borrower->{'dateofbirth'} ) {
1011 my @alloweddate = split /-/,$borrower->{'dateofbirth'} ;
1012 $alloweddate[0] += $restrictionyear;
1013 #Prevent runime eror on leap year (invalid date)
1014 if (($alloweddate[1] == 2) && ($alloweddate[2] == 29)) {
1015 $alloweddate[2] = 28;
1018 if ( Date_to_Days(Today) < Date_to_Days(@alloweddate) -1 ) {
1019 if (C4::Context->preference('AgeRestrictionOverride' )) {
1020 $needsconfirmation{AGE_RESTRICTION} = "$bibvalues";
1023 $issuingimpossible{AGE_RESTRICTION} = "$bibvalues";
1030 ## check for high holds decreasing loan period
1031 my $decrease_loan = C4::Context->preference('decreaseLoanHighHolds');
1032 if ( $decrease_loan && $decrease_loan == 1 ) {
1033 my ( $reserved, $num, $duration, $returndate ) =
1034 checkHighHolds( $item, $borrower );
1036 if ( $num >= C4::Context->preference('decreaseLoanHighHoldsValue') ) {
1037 $needsconfirmation{HIGHHOLDS} = {
1039 duration => $duration,
1040 returndate => output_pref($returndate),
1045 return ( \%issuingimpossible, \%needsconfirmation, \%alerts );
1048 =head2 CanBookBeReturned
1050 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1052 Check whether the item can be returned to the provided branch
1056 =item C<$item> is a hash of item information as returned from GetItem
1058 =item C<$branch> is the branchcode where the return is taking place
1066 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1068 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1074 sub CanBookBeReturned {
1075 my ($item, $branch) = @_;
1076 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1078 # assume return is allowed to start
1082 # identify all cases where return is forbidden
1083 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1085 $message = $item->{'homebranch'};
1086 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1088 $message = $item->{'holdingbranch'};
1089 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1091 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1094 return ($allowed, $message);
1097 =head2 CheckHighHolds
1099 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1100 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1101 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1105 sub checkHighHolds {
1106 my ( $item, $borrower ) = @_;
1107 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1108 my $branch = _GetCircControlBranch( $item, $borrower );
1109 my $dbh = C4::Context->dbh;
1110 my $sth = $dbh->prepare(
1111 'select count(borrowernumber) as num_holds from reserves where biblionumber=?'
1113 $sth->execute( $item->{'biblionumber'} );
1114 my ($holds) = $sth->fetchrow_array;
1116 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1118 my $calendar = Koha::Calendar->new( branchcode => $branch );
1121 ( C4::Context->preference('item-level_itypes') )
1122 ? $biblio->{'itype'}
1123 : $biblio->{'itemtype'};
1125 C4::Circulation::CalcDateDue( $issuedate, $itype, $branch,
1128 my $reduced_datedue =
1129 $calendar->addDate( $issuedate,
1130 C4::Context->preference('decreaseLoanHighHoldsDuration') );
1132 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1134 C4::Context->preference('decreaseLoanHighHoldsDuration'),
1138 return ( 0, 0, 0, undef );
1143 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1145 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1149 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1151 =item C<$barcode> is the barcode of the item being issued.
1153 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
1154 Calculated if empty.
1156 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1158 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1159 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
1161 AddIssue does the following things :
1163 - step 01: check that there is a borrowernumber & a barcode provided
1164 - check for RENEWAL (book issued & being issued to the same patron)
1165 - renewal YES = Calculate Charge & renew
1167 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1169 - fill reserve if reserve to this patron
1170 - cancel reserve or not, otherwise
1171 * TRANSFERT PENDING ?
1172 - complete the transfert
1180 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
1181 my $dbh = C4::Context->dbh;
1182 my $barcodecheck=CheckValidBarcode($barcode);
1183 if ($datedue && ref $datedue ne 'DateTime') {
1184 $datedue = dt_from_string($datedue);
1186 # $issuedate defaults to today.
1187 if ( ! defined $issuedate ) {
1188 $issuedate = DateTime->now(time_zone => C4::Context->tz());
1191 if ( ref $issuedate ne 'DateTime') {
1192 $issuedate = dt_from_string($issuedate);
1196 if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1197 # find which item we issue
1198 my $item = GetItem('', $barcode) or return; # if we don't get an Item, abort.
1199 my $branch = _GetCircControlBranch($item,$borrower);
1201 # get actual issuing if there is one
1202 my $actualissue = GetItemIssue( $item->{itemnumber});
1204 # get biblioinformation for this item
1205 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
1208 # check if we just renew the issue.
1210 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
1211 $datedue = AddRenewal(
1212 $borrower->{'borrowernumber'},
1213 $item->{'itemnumber'},
1216 $issuedate, # here interpreted as the renewal date
1220 # it's NOT a renewal
1221 if ( $actualissue->{borrowernumber}) {
1222 # This book is currently on loan, but not to the person
1223 # who wants to borrow it now. mark it returned before issuing to the new borrower
1226 C4::Context->userenv->{'branch'}
1230 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1231 # Starting process for transfer job (checking transfert and validate it if we have one)
1232 my ($datesent) = GetTransfers($item->{'itemnumber'});
1234 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1237 "UPDATE branchtransfers
1238 SET datearrived = now(),
1240 comments = 'Forced branchtransfer'
1241 WHERE itemnumber= ? AND datearrived IS NULL"
1243 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1246 # Record in the database the fact that the book was issued.
1250 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1254 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1255 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1258 $datedue->truncate( to => 'minute');
1260 $borrower->{'borrowernumber'}, # borrowernumber
1261 $item->{'itemnumber'}, # itemnumber
1262 $issuedate->strftime('%Y-%m-%d %H:%M:00'), # issuedate
1263 $datedue->strftime('%Y-%m-%d %H:%M:00'), # date_due
1264 C4::Context->userenv->{'branch'} # branchcode
1266 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1267 CartToShelf( $item->{'itemnumber'} );
1269 $item->{'issues'}++;
1270 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1271 UpdateTotalIssues($item->{'biblionumber'}, 1);
1274 ## If item was lost, it has now been found, reverse any list item charges if neccessary.
1275 if ( $item->{'itemlost'} ) {
1276 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1277 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1281 ModItem({ issues => $item->{'issues'},
1282 holdingbranch => C4::Context->userenv->{'branch'},
1284 datelastborrowed => DateTime->now(time_zone => C4::Context->tz())->ymd(),
1285 onloan => $datedue->ymd(),
1286 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1287 ModDateLastSeen( $item->{'itemnumber'} );
1289 # If it costs to borrow this book, charge it to the patron's account.
1290 my ( $charge, $itemtype ) = GetIssuingCharges(
1291 $item->{'itemnumber'},
1292 $borrower->{'borrowernumber'}
1294 if ( $charge > 0 ) {
1296 $item->{'itemnumber'},
1297 $borrower->{'borrowernumber'}, $charge
1299 $item->{'charge'} = $charge;
1302 # Record the fact that this book was issued.
1304 C4::Context->userenv->{'branch'},
1306 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1307 $item->{'itype'}, $borrower->{'borrowernumber'}, undef, $item->{'ccode'}
1310 # Send a checkout slip.
1311 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1313 branchcode => $branch,
1314 categorycode => $borrower->{categorycode},
1315 item_type => $item->{itype},
1316 notification => 'CHECKOUT',
1318 if ($circulation_alert->is_enabled_for(\%conditions)) {
1319 SendCirculationAlert({
1322 borrower => $borrower,
1328 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'itemnumber'})
1329 if C4::Context->preference("IssueLog");
1331 return ($datedue); # not necessarily the same as when it came in!
1334 =head2 GetLoanLength
1336 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1338 Get loan length for an itemtype, a borrower type and a branch
1343 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1344 my $dbh = C4::Context->dbh;
1345 my $sth = $dbh->prepare(qq{
1346 SELECT issuelength, lengthunit, renewalperiod
1348 WHERE categorycode=?
1351 AND issuelength IS NOT NULL
1354 # try to find issuelength & return the 1st available.
1355 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1356 $sth->execute( $borrowertype, $itemtype, $branchcode );
1357 my $loanlength = $sth->fetchrow_hashref;
1360 if defined($loanlength) && $loanlength->{issuelength};
1362 $sth->execute( $borrowertype, '*', $branchcode );
1363 $loanlength = $sth->fetchrow_hashref;
1365 if defined($loanlength) && $loanlength->{issuelength};
1367 $sth->execute( '*', $itemtype, $branchcode );
1368 $loanlength = $sth->fetchrow_hashref;
1370 if defined($loanlength) && $loanlength->{issuelength};
1372 $sth->execute( '*', '*', $branchcode );
1373 $loanlength = $sth->fetchrow_hashref;
1375 if defined($loanlength) && $loanlength->{issuelength};
1377 $sth->execute( $borrowertype, $itemtype, '*' );
1378 $loanlength = $sth->fetchrow_hashref;
1380 if defined($loanlength) && $loanlength->{issuelength};
1382 $sth->execute( $borrowertype, '*', '*' );
1383 $loanlength = $sth->fetchrow_hashref;
1385 if defined($loanlength) && $loanlength->{issuelength};
1387 $sth->execute( '*', $itemtype, '*' );
1388 $loanlength = $sth->fetchrow_hashref;
1390 if defined($loanlength) && $loanlength->{issuelength};
1392 $sth->execute( '*', '*', '*' );
1393 $loanlength = $sth->fetchrow_hashref;
1395 if defined($loanlength) && $loanlength->{issuelength};
1397 # if no rule is set => 21 days (hardcoded)
1400 renewalperiod => 21,
1401 lengthunit => 'days',
1407 =head2 GetHardDueDate
1409 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1411 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1415 sub GetHardDueDate {
1416 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1418 my $rule = GetIssuingRule( $borrowertype, $itemtype, $branchcode );
1420 if ( defined( $rule ) ) {
1421 if ( $rule->{hardduedate} ) {
1422 return (dt_from_string($rule->{hardduedate}, 'iso'),$rule->{hardduedatecompare});
1424 return (undef, undef);
1429 =head2 GetIssuingRule
1431 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1433 FIXME - This is a copy-paste of GetLoanLength
1434 as a stop-gap. Do not wish to change API for GetLoanLength
1435 this close to release.
1437 Get the issuing rule for an itemtype, a borrower type and a branch
1438 Returns a hashref from the issuingrules table.
1442 sub GetIssuingRule {
1443 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1444 my $dbh = C4::Context->dbh;
1445 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1448 $sth->execute( $borrowertype, $itemtype, $branchcode );
1449 $irule = $sth->fetchrow_hashref;
1450 return $irule if defined($irule) ;
1452 $sth->execute( $borrowertype, "*", $branchcode );
1453 $irule = $sth->fetchrow_hashref;
1454 return $irule if defined($irule) ;
1456 $sth->execute( "*", $itemtype, $branchcode );
1457 $irule = $sth->fetchrow_hashref;
1458 return $irule if defined($irule) ;
1460 $sth->execute( "*", "*", $branchcode );
1461 $irule = $sth->fetchrow_hashref;
1462 return $irule if defined($irule) ;
1464 $sth->execute( $borrowertype, $itemtype, "*" );
1465 $irule = $sth->fetchrow_hashref;
1466 return $irule if defined($irule) ;
1468 $sth->execute( $borrowertype, "*", "*" );
1469 $irule = $sth->fetchrow_hashref;
1470 return $irule if defined($irule) ;
1472 $sth->execute( "*", $itemtype, "*" );
1473 $irule = $sth->fetchrow_hashref;
1474 return $irule if defined($irule) ;
1476 $sth->execute( "*", "*", "*" );
1477 $irule = $sth->fetchrow_hashref;
1478 return $irule if defined($irule) ;
1480 # if no rule matches,
1484 =head2 GetBranchBorrowerCircRule
1486 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1488 Retrieves circulation rule attributes that apply to the given
1489 branch and patron category, regardless of item type.
1490 The return value is a hashref containing the following key:
1492 maxissueqty - maximum number of loans that a
1493 patron of the given category can have at the given
1494 branch. If the value is undef, no limit.
1496 This will first check for a specific branch and
1497 category match from branch_borrower_circ_rules.
1499 If no rule is found, it will then check default_branch_circ_rules
1500 (same branch, default category). If no rule is found,
1501 it will then check default_borrower_circ_rules (default
1502 branch, same category), then failing that, default_circ_rules
1503 (default branch, default category).
1505 If no rule has been found in the database, it will default to
1510 C<$branchcode> and C<$categorycode> should contain the
1511 literal branch code and patron category code, respectively - no
1516 sub GetBranchBorrowerCircRule {
1517 my $branchcode = shift;
1518 my $categorycode = shift;
1520 my $branch_cat_query = "SELECT maxissueqty
1521 FROM branch_borrower_circ_rules
1522 WHERE branchcode = ?
1523 AND categorycode = ?";
1524 my $dbh = C4::Context->dbh();
1525 my $sth = $dbh->prepare($branch_cat_query);
1526 $sth->execute($branchcode, $categorycode);
1528 if ($result = $sth->fetchrow_hashref()) {
1532 # try same branch, default borrower category
1533 my $branch_query = "SELECT maxissueqty
1534 FROM default_branch_circ_rules
1535 WHERE branchcode = ?";
1536 $sth = $dbh->prepare($branch_query);
1537 $sth->execute($branchcode);
1538 if ($result = $sth->fetchrow_hashref()) {
1542 # try default branch, same borrower category
1543 my $category_query = "SELECT maxissueqty
1544 FROM default_borrower_circ_rules
1545 WHERE categorycode = ?";
1546 $sth = $dbh->prepare($category_query);
1547 $sth->execute($categorycode);
1548 if ($result = $sth->fetchrow_hashref()) {
1552 # try default branch, default borrower category
1553 my $default_query = "SELECT maxissueqty
1554 FROM default_circ_rules";
1555 $sth = $dbh->prepare($default_query);
1557 if ($result = $sth->fetchrow_hashref()) {
1561 # built-in default circulation rule
1563 maxissueqty => undef,
1567 =head2 GetBranchItemRule
1569 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1571 Retrieves circulation rule attributes that apply to the given
1572 branch and item type, regardless of patron category.
1574 The return value is a hashref containing the following keys:
1576 holdallowed => Hold policy for this branch and itemtype. Possible values:
1577 0: No holds allowed.
1578 1: Holds allowed only by patrons that have the same homebranch as the item.
1579 2: Holds allowed from any patron.
1581 returnbranch => branch to which to return item. Possible values:
1582 noreturn: do not return, let item remain where checked in (floating collections)
1583 homebranch: return to item's home branch
1585 This searches branchitemrules in the following order:
1587 * Same branchcode and itemtype
1588 * Same branchcode, itemtype '*'
1589 * branchcode '*', same itemtype
1590 * branchcode and itemtype '*'
1592 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1596 sub GetBranchItemRule {
1597 my ( $branchcode, $itemtype ) = @_;
1598 my $dbh = C4::Context->dbh();
1602 ['SELECT holdallowed, returnbranch
1603 FROM branch_item_rules
1604 WHERE branchcode = ?
1605 AND itemtype = ?', $branchcode, $itemtype],
1606 ['SELECT holdallowed, returnbranch
1607 FROM default_branch_circ_rules
1608 WHERE branchcode = ?', $branchcode],
1609 ['SELECT holdallowed, returnbranch
1610 FROM default_branch_item_rules
1611 WHERE itemtype = ?', $itemtype],
1612 ['SELECT holdallowed, returnbranch
1613 FROM default_circ_rules'],
1616 foreach my $attempt (@attempts) {
1617 my ($query, @bind_params) = @{$attempt};
1618 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1621 # Since branch/category and branch/itemtype use the same per-branch
1622 # defaults tables, we have to check that the key we want is set, not
1623 # just that a row was returned
1624 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1625 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1628 # built-in default circulation rule
1629 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1630 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1637 ($doreturn, $messages, $iteminformation, $borrower) =
1638 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1644 =item C<$barcode> is the bar code of the book being returned.
1646 =item C<$branch> is the code of the branch where the book is being returned.
1648 =item C<$exemptfine> indicates that overdue charges for the item will be
1651 =item C<$dropbox> indicates that the check-in date is assumed to be
1652 yesterday, or the last non-holiday as defined in C4::Calendar . If
1653 overdue charges are applied and C<$dropbox> is true, the last charge
1654 will be removed. This assumes that the fines accrual script has run
1659 C<&AddReturn> returns a list of four items:
1661 C<$doreturn> is true iff the return succeeded.
1663 C<$messages> is a reference-to-hash giving feedback on the operation.
1664 The keys of the hash are:
1670 No item with this barcode exists. The value is C<$barcode>.
1674 The book is not currently on loan. The value is C<$barcode>.
1676 =item C<IsPermanent>
1678 The book's home branch is a permanent collection. If you have borrowed
1679 this book, you are not allowed to return it. The value is the code for
1680 the book's home branch.
1684 This book has been withdrawn/cancelled. The value should be ignored.
1686 =item C<Wrongbranch>
1688 This book has was returned to the wrong branch. The value is a hashref
1689 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1690 contain the branchcode of the incorrect and correct return library, respectively.
1694 The item was reserved. The value is a reference-to-hash whose keys are
1695 fields from the reserves table of the Koha database, and
1696 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1697 either C<Waiting>, C<Reserved>, or 0.
1701 C<$iteminformation> is a reference-to-hash, giving information about the
1702 returned item from the issues table.
1704 C<$borrower> is a reference-to-hash, giving information about the
1705 patron who last borrowed the book.
1710 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1712 if ($branch and not GetBranchDetail($branch)) {
1713 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1716 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1721 my $validTransfert = 0;
1722 my $stat_type = 'return';
1724 # get information on item
1725 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1726 unless ($itemnumber) {
1727 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1729 my $issue = GetItemIssue($itemnumber);
1730 # warn Dumper($iteminformation);
1731 if ($issue and $issue->{borrowernumber}) {
1732 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1733 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1734 . Dumper($issue) . "\n";
1736 $messages->{'NotIssued'} = $barcode;
1737 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1739 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1740 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1741 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1742 $messages->{'LocalUse'} = 1;
1743 $stat_type = 'localuse';
1747 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1748 # full item data, but no borrowernumber or checkout info (no issue)
1749 # we know GetItem should work because GetItemnumberFromBarcode worked
1750 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1751 # get the proper branch to which to return the item
1752 $hbr = $item->{$hbr} || $branch ;
1753 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1755 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1757 # check if the book is in a permanent collection....
1758 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1760 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1761 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1764 # check if the return is allowed at this branch
1765 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1766 unless ($returnallowed){
1767 $messages->{'Wrongbranch'} = {
1768 Wrongbranch => $branch,
1769 Rightbranch => $message
1772 return ( $doreturn, $messages, $issue, $borrower );
1775 if ( $item->{'withdrawn'} ) { # book has been cancelled
1776 $messages->{'withdrawn'} = 1;
1777 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1780 # case of a return of document (deal with issues and holdingbranch)
1781 my $today = DateTime->now( time_zone => C4::Context->tz() );
1783 my $datedue = $issue->{date_due};
1784 $borrower or warn "AddReturn without current borrower";
1785 my $circControlBranch;
1787 # define circControlBranch only if dropbox mode is set
1788 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1789 # FIXME: check issuedate > returndate, factoring in holidays
1790 #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1791 $circControlBranch = _GetCircControlBranch($item,$borrower);
1792 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $today ) == -1 ? 1 : 0;
1795 if ($borrowernumber) {
1796 if( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'}){
1797 # we only need to calculate and change the fines if we want to do that on return
1798 # Should be on for hourly loans
1799 my $control = C4::Context->preference('CircControl');
1800 my $control_branchcode =
1801 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
1802 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
1803 : $issue->{branchcode};
1805 my ( $amount, $type, $unitcounttotal ) =
1806 C4::Overdues::CalcFine( $item, $borrower->{categorycode},
1807 $control_branchcode, $datedue, $today );
1812 && C4::Context->preference('finesMode') eq 'production' )
1814 C4::Overdues::UpdateFine( $issue->{itemnumber},
1815 $issue->{borrowernumber},
1816 $amount, $type, output_pref($datedue) );
1820 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1821 $circControlBranch, '', $borrower->{'privacy'} );
1823 # FIXME is the "= 1" right? This could be the borrower hash.
1824 $messages->{'WasReturned'} = 1;
1828 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1831 # the holdingbranch is updated if the document is returned to another location.
1832 # this is always done regardless of whether the item was on loan or not
1833 if ($item->{'holdingbranch'} ne $branch) {
1834 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1835 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1837 ModDateLastSeen( $item->{'itemnumber'} );
1839 # check if we have a transfer for this document
1840 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1842 # if we have a transfer to do, we update the line of transfers with the datearrived
1844 if ( $tobranch eq $branch ) {
1845 my $sth = C4::Context->dbh->prepare(
1846 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1848 $sth->execute( $item->{'itemnumber'} );
1849 # if we have a reservation with valid transfer, we can set it's status to 'W'
1850 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1851 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1853 $messages->{'WrongTransfer'} = $tobranch;
1854 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1856 $validTransfert = 1;
1858 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1861 # fix up the accounts.....
1862 if ( $item->{'itemlost'} ) {
1863 $messages->{'WasLost'} = 1;
1865 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1866 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1867 $messages->{'LostItemFeeRefunded'} = 1;
1871 # fix up the overdues in accounts...
1872 if ($borrowernumber) {
1873 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1874 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1876 if ( $issue->{overdue} && $issue->{date_due} ) {
1879 _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1880 $messages->{Debarred} = $debardate if ($debardate);
1884 # find reserves.....
1885 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1886 my ($resfound, $resrec);
1887 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1888 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
1890 $resrec->{'ResFound'} = $resfound;
1891 $messages->{'ResFound'} = $resrec;
1895 # Record the fact that this book was returned.
1897 $branch, $stat_type, '0', '',
1898 $item->{'itemnumber'},
1899 $biblio->{'itemtype'},
1900 $borrowernumber, undef, $item->{'ccode'}
1903 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1904 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1906 branchcode => $branch,
1907 categorycode => $borrower->{categorycode},
1908 item_type => $item->{itype},
1909 notification => 'CHECKIN',
1911 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1912 SendCirculationAlert({
1915 borrower => $borrower,
1920 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
1921 if C4::Context->preference("ReturnLog");
1923 # FIXME: make this comment intelligible.
1924 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1925 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1927 if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
1928 if ( C4::Context->preference("AutomaticItemReturn" ) or
1929 (C4::Context->preference("UseBranchTransferLimits") and
1930 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1932 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1933 $debug and warn "item: " . Dumper($item);
1934 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1935 $messages->{'WasTransfered'} = 1;
1937 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1940 return ( $doreturn, $messages, $issue, $borrower );
1943 =head2 MarkIssueReturned
1945 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1947 Unconditionally marks an issue as being returned by
1948 moving the C<issues> row to C<old_issues> and
1949 setting C<returndate> to the current date, or
1950 the last non-holiday date of the branccode specified in
1951 C<dropbox_branch> . Assumes you've already checked that
1952 it's safe to do this, i.e. last non-holiday > issuedate.
1954 if C<$returndate> is specified (in iso format), it is used as the date
1955 of the return. It is ignored when a dropbox_branch is passed in.
1957 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1958 the old_issue is immediately anonymised
1960 Ideally, this function would be internal to C<C4::Circulation>,
1961 not exported, but it is currently needed by one
1962 routine in C<C4::Accounts>.
1966 sub MarkIssueReturned {
1967 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1969 my $dbh = C4::Context->dbh;
1970 my $query = 'UPDATE issues SET returndate=';
1972 if ($dropbox_branch) {
1973 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
1974 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
1976 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
1977 } elsif ($returndate) {
1979 push @bind, $returndate;
1981 $query .= ' now() ';
1983 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
1984 push @bind, $borrowernumber, $itemnumber;
1986 my $sth_upd = $dbh->prepare($query);
1987 $sth_upd->execute(@bind);
1988 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
1989 WHERE borrowernumber = ?
1990 AND itemnumber = ?');
1991 $sth_copy->execute($borrowernumber, $itemnumber);
1992 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
1993 if ( $privacy == 2) {
1994 # The default of 0 does not work due to foreign key constraints
1995 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
1996 # FIXME the above is unacceptable - bug 9942 relates
1997 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
1998 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
1999 WHERE borrowernumber = ?
2000 AND itemnumber = ?");
2001 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2003 my $sth_del = $dbh->prepare("DELETE FROM issues
2004 WHERE borrowernumber = ?
2005 AND itemnumber = ?");
2006 $sth_del->execute($borrowernumber, $itemnumber);
2009 =head2 _debar_user_on_return
2011 _debar_user_on_return($borrower, $item, $datedue, today);
2013 C<$borrower> borrower hashref
2015 C<$item> item hashref
2017 C<$datedue> date due DateTime object
2019 C<$today> DateTime object representing the return time
2021 Internal function, called only by AddReturn that calculates and updates
2022 the user fine days, and debars him if necessary.
2024 Should only be called for overdue returns
2028 sub _debar_user_on_return {
2029 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2031 my $branchcode = _GetCircControlBranch( $item, $borrower );
2032 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
2034 # $deltadays is a DateTime::Duration object
2035 my $deltadays = $calendar->days_between( $dt_due, $dt_today );
2037 my $circcontrol = C4::Context->preference('CircControl');
2039 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2040 my $finedays = $issuingrule->{finedays};
2041 my $unit = $issuingrule->{lengthunit};
2045 # finedays is in days, so hourly loans must multiply by 24
2046 # thus 1 hour late equals 1 day suspension * finedays rate
2047 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2049 # grace period is measured in the same units as the loan
2051 DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2052 if ( $deltadays->subtract($grace)->is_positive() ) {
2055 $dt_today->clone()->add_duration( $deltadays * $finedays );
2056 if ( $borrower->{debarred} ) {
2057 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2059 # Update patron only if new date > old
2060 if ( DateTime->compare( $borrower_debar_dt, $new_debar_dt ) !=
2067 C4::Members::DebarMember( $borrower->{borrowernumber},
2068 $new_debar_dt->ymd() );
2069 return $new_debar_dt->ymd();
2075 =head2 _FixOverduesOnReturn
2077 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2079 C<$brn> borrowernumber
2083 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2084 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2086 Internal function, called only by AddReturn
2090 sub _FixOverduesOnReturn {
2091 my ($borrowernumber, $item);
2092 unless ($borrowernumber = shift) {
2093 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2096 unless ($item = shift) {
2097 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2100 my ($exemptfine, $dropbox) = @_;
2101 my $dbh = C4::Context->dbh;
2103 # check for overdue fine
2104 my $sth = $dbh->prepare(
2105 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2107 $sth->execute( $borrowernumber, $item );
2109 # alter fine to show that the book has been returned
2110 my $data = $sth->fetchrow_hashref;
2111 return 0 unless $data; # no warning, there's just nothing to fix
2114 my @bind = ($data->{'accountlines_id'});
2116 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2117 if (C4::Context->preference("FinesLog")) {
2118 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2120 } elsif ($dropbox && $data->{lastincrement}) {
2121 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2122 my $amt = $data->{amount} - $data->{lastincrement} ;
2123 if (C4::Context->preference("FinesLog")) {
2124 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2126 $uquery = "update accountlines set accounttype='F' ";
2127 if($outstanding >= 0 && $amt >=0) {
2128 $uquery .= ", amount = ? , amountoutstanding=? ";
2129 unshift @bind, ($amt, $outstanding) ;
2132 $uquery = "update accountlines set accounttype='F' ";
2134 $uquery .= " where (accountlines_id = ?)";
2135 my $usth = $dbh->prepare($uquery);
2136 return $usth->execute(@bind);
2139 =head2 _FixAccountForLostAndReturned
2141 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2143 Calculates the charge for a book lost and returned.
2145 Internal function, not exported, called only by AddReturn.
2147 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2148 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2152 sub _FixAccountForLostAndReturned {
2153 my $itemnumber = shift or return;
2154 my $borrowernumber = @_ ? shift : undef;
2155 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2156 my $dbh = C4::Context->dbh;
2157 # check for charge made for lost book
2158 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2159 $sth->execute($itemnumber);
2160 my $data = $sth->fetchrow_hashref;
2161 $data or return; # bail if there is nothing to do
2162 $data->{accounttype} eq 'W' and return; # Written off
2164 # writeoff this amount
2166 my $amount = $data->{'amount'};
2167 my $acctno = $data->{'accountno'};
2168 my $amountleft; # Starts off undef/zero.
2169 if ($data->{'amountoutstanding'} == $amount) {
2170 $offset = $data->{'amount'};
2171 $amountleft = 0; # Hey, it's zero here, too.
2173 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2174 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2176 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2177 WHERE (accountlines_id = ?)");
2178 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2179 #check if any credit is left if so writeoff other accounts
2180 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2181 $amountleft *= -1 if ($amountleft < 0);
2182 if ($amountleft > 0) {
2183 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2184 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2185 $msth->execute($data->{'borrowernumber'});
2186 # offset transactions
2189 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2190 if ($accdata->{'amountoutstanding'} < $amountleft) {
2192 $amountleft -= $accdata->{'amountoutstanding'};
2194 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2197 my $thisacct = $accdata->{'accountlines_id'};
2198 # FIXME: move prepares outside while loop!
2199 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2200 WHERE (accountlines_id = ?)");
2201 $usth->execute($newamtos,$thisacct);
2202 $usth = $dbh->prepare("INSERT INTO accountoffsets
2203 (borrowernumber, accountno, offsetaccount, offsetamount)
2206 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2209 $amountleft *= -1 if ($amountleft > 0);
2210 my $desc = "Item Returned " . $item_id;
2211 $usth = $dbh->prepare("INSERT INTO accountlines
2212 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2213 VALUES (?,?,now(),?,?,'CR',?)");
2214 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2215 if ($borrowernumber) {
2216 # FIXME: same as query above. use 1 sth for both
2217 $usth = $dbh->prepare("INSERT INTO accountoffsets
2218 (borrowernumber, accountno, offsetaccount, offsetamount)
2220 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2222 ModItem({ paidfor => '' }, undef, $itemnumber);
2226 =head2 _GetCircControlBranch
2228 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2232 Return the library code to be used to determine which circulation
2233 policy applies to a transaction. Looks up the CircControl and
2234 HomeOrHoldingBranch system preferences.
2236 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2238 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2242 sub _GetCircControlBranch {
2243 my ($item, $borrower) = @_;
2244 my $circcontrol = C4::Context->preference('CircControl');
2247 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2248 $branch= C4::Context->userenv->{'branch'};
2249 } elsif ($circcontrol eq 'PatronLibrary') {
2250 $branch=$borrower->{branchcode};
2252 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2253 $branch = $item->{$branchfield};
2254 # default to item home branch if holdingbranch is used
2255 # and is not defined
2256 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2257 $branch = $item->{homebranch};
2270 $issue = &GetItemIssue($itemnumber);
2272 Returns patron currently having a book, or undef if not checked out.
2274 C<$itemnumber> is the itemnumber.
2276 C<$issue> is a hashref of the row from the issues table.
2281 my ($itemnumber) = @_;
2282 return unless $itemnumber;
2283 my $sth = C4::Context->dbh->prepare(
2284 "SELECT items.*, issues.*
2286 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2287 WHERE issues.itemnumber=?");
2288 $sth->execute($itemnumber);
2289 my $data = $sth->fetchrow_hashref;
2290 return unless $data;
2291 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2292 $data->{issuedate}->truncate(to => 'minute');
2293 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2294 $data->{date_due}->truncate(to => 'minute');
2295 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2296 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2302 $issue = GetOpenIssue( $itemnumber );
2304 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2306 C<$itemnumber> is the item's itemnumber
2313 my ( $itemnumber ) = @_;
2314 return unless $itemnumber;
2315 my $dbh = C4::Context->dbh;
2316 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2317 $sth->execute( $itemnumber );
2318 return $sth->fetchrow_hashref();
2322 =head2 GetItemIssues
2324 $issues = &GetItemIssues($itemnumber, $history);
2326 Returns patrons that have issued a book
2328 C<$itemnumber> is the itemnumber
2329 C<$history> is false if you just want the current "issuer" (if any)
2330 and true if you want issues history from old_issues also.
2332 Returns reference to an array of hashes
2337 my ( $itemnumber, $history ) = @_;
2339 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2340 $today->truncate( to => 'minute' );
2341 my $sql = "SELECT * FROM issues
2342 JOIN borrowers USING (borrowernumber)
2343 JOIN items USING (itemnumber)
2344 WHERE issues.itemnumber = ? ";
2347 SELECT * FROM old_issues
2348 LEFT JOIN borrowers USING (borrowernumber)
2349 JOIN items USING (itemnumber)
2350 WHERE old_issues.itemnumber = ? ";
2352 $sql .= "ORDER BY date_due DESC";
2353 my $sth = C4::Context->dbh->prepare($sql);
2355 $sth->execute($itemnumber, $itemnumber);
2357 $sth->execute($itemnumber);
2359 my $results = $sth->fetchall_arrayref({});
2360 foreach (@$results) {
2361 my $date_due = dt_from_string($_->{date_due},'sql');
2362 $date_due->truncate( to => 'minute' );
2364 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2369 =head2 GetBiblioIssues
2371 $issues = GetBiblioIssues($biblionumber);
2373 this function get all issues from a biblionumber.
2376 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2377 tables issues and the firstname,surname & cardnumber from borrowers.
2381 sub GetBiblioIssues {
2382 my $biblionumber = shift;
2383 return unless $biblionumber;
2384 my $dbh = C4::Context->dbh;
2386 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2388 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2389 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2390 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2391 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2392 WHERE biblio.biblionumber = ?
2394 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2396 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2397 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2398 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2399 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2400 WHERE biblio.biblionumber = ?
2403 my $sth = $dbh->prepare($query);
2404 $sth->execute($biblionumber, $biblionumber);
2407 while ( my $data = $sth->fetchrow_hashref ) {
2408 push @issues, $data;
2413 =head2 GetUpcomingDueIssues
2415 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2419 sub GetUpcomingDueIssues {
2422 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2423 my $dbh = C4::Context->dbh;
2425 my $statement = <<END_SQL;
2426 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2428 LEFT JOIN items USING (itemnumber)
2429 LEFT OUTER JOIN branches USING (branchcode)
2430 WHERE returndate is NULL
2431 HAVING days_until_due > 0 AND days_until_due < ?
2434 my @bind_parameters = ( $params->{'days_in_advance'} );
2436 my $sth = $dbh->prepare( $statement );
2437 $sth->execute( @bind_parameters );
2438 my $upcoming_dues = $sth->fetchall_arrayref({});
2440 return $upcoming_dues;
2443 =head2 CanBookBeRenewed
2445 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2447 Find out whether a borrowed item may be renewed.
2449 C<$borrowernumber> is the borrower number of the patron who currently
2450 has the item on loan.
2452 C<$itemnumber> is the number of the item to renew.
2454 C<$override_limit>, if supplied with a true value, causes
2455 the limit on the number of times that the loan can be renewed
2456 (as controlled by the item type) to be ignored.
2458 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2459 item must currently be on loan to the specified borrower; renewals
2460 must be allowed for the item's type; and the borrower must not have
2461 already renewed the loan. $error will contain the reason the renewal can not proceed
2465 sub CanBookBeRenewed {
2467 # check renewal status
2468 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2469 my $dbh = C4::Context->dbh;
2474 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return;
2475 my $item = GetItem($itemnumber) or return;
2476 my $itemissue = GetItemIssue($itemnumber) or return;
2478 my $branchcode = _GetCircControlBranch($item, $borrower);
2480 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2482 if ( ( $issuingrule->{renewalsallowed} > $itemissue->{renewals} ) || $override_limit ) {
2485 $error = "too_many";
2488 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves( $itemnumber );
2490 if ( $resfound ) { # '' when no hold was found
2492 $error = "on_reserve";
2495 return ( $renewokay, $error );
2500 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2504 C<$borrowernumber> is the borrower number of the patron who currently
2507 C<$itemnumber> is the number of the item to renew.
2509 C<$branch> is the library where the renewal took place (if any).
2510 The library that controls the circ policies for the renewal is retrieved from the issues record.
2512 C<$datedue> can be a C4::Dates object used to set the due date.
2514 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2515 this parameter is not supplied, lastreneweddate is set to the current date.
2517 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2518 from the book's item type.
2523 my $borrowernumber = shift or return;
2524 my $itemnumber = shift or return;
2526 my $datedue = shift;
2527 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2528 my $item = GetItem($itemnumber) or return;
2529 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2531 my $dbh = C4::Context->dbh;
2532 # Find the issues record for this book
2534 $dbh->prepare("SELECT * FROM issues
2535 WHERE borrowernumber=?
2538 $sth->execute( $borrowernumber, $itemnumber );
2539 my $issuedata = $sth->fetchrow_hashref;
2540 if(defined $datedue && ref $datedue ne 'DateTime' ) {
2541 carp 'Invalid date passed to AddRenewal.';
2544 # If the due date wasn't specified, calculate it by adding the
2545 # book's loan length to today's date or the current due date
2546 # based on the value of the RenewalPeriodBase syspref.
2549 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2550 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2552 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2553 dt_from_string( $issuedata->{date_due} ) :
2554 DateTime->now( time_zone => C4::Context->tz());
2555 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2558 # Update the issues record to have the new due date, and a new count
2559 # of how many times it has been renewed.
2560 my $renews = $issuedata->{'renewals'} + 1;
2561 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2562 WHERE borrowernumber=?
2566 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2568 # Update the renewal count on the item, and tell zebra to reindex
2569 $renews = $biblio->{'renewals'} + 1;
2570 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2572 # Charge a new rental fee, if applicable?
2573 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2574 if ( $charge > 0 ) {
2575 my $accountno = getnextacctno( $borrowernumber );
2576 my $item = GetBiblioFromItemNumber($itemnumber);
2578 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2579 $sth = $dbh->prepare(
2580 "INSERT INTO accountlines
2581 (date, borrowernumber, accountno, amount, manager_id,
2582 description,accounttype, amountoutstanding, itemnumber)
2583 VALUES (now(),?,?,?,?,?,?,?,?)"
2585 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2586 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2587 'Rent', $charge, $itemnumber );
2590 # Send a renewal slip according to checkout alert preferencei
2591 if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2592 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2593 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2595 branchcode => $branch,
2596 categorycode => $borrower->{categorycode},
2597 item_type => $item->{itype},
2598 notification => 'CHECKOUT',
2600 if ($circulation_alert->is_enabled_for(\%conditions)) {
2601 SendCirculationAlert({
2604 borrower => $borrower,
2611 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber, undef, $item->{'ccode'});
2616 # check renewal status
2617 my ( $bornum, $itemno ) = @_;
2618 my $dbh = C4::Context->dbh;
2620 my $renewsallowed = 0;
2623 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2624 my $item = GetItem($itemno);
2626 # Look in the issues table for this item, lent to this borrower,
2627 # and not yet returned.
2629 # FIXME - I think this function could be redone to use only one SQL call.
2630 my $sth = $dbh->prepare(
2631 "select * from issues
2632 where (borrowernumber = ?)
2633 and (itemnumber = ?)"
2635 $sth->execute( $bornum, $itemno );
2636 my $data = $sth->fetchrow_hashref;
2637 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2638 # $item and $borrower should be calculated
2639 my $branchcode = _GetCircControlBranch($item, $borrower);
2641 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2643 $renewsallowed = $issuingrule->{'renewalsallowed'};
2644 $renewsleft = $renewsallowed - $renewcount;
2645 if($renewsleft < 0){ $renewsleft = 0; }
2646 return ( $renewcount, $renewsallowed, $renewsleft );
2649 =head2 GetIssuingCharges
2651 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2653 Calculate how much it would cost for a given patron to borrow a given
2654 item, including any applicable discounts.
2656 C<$itemnumber> is the item number of item the patron wishes to borrow.
2658 C<$borrowernumber> is the patron's borrower number.
2660 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2661 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2666 sub GetIssuingCharges {
2668 # calculate charges due
2669 my ( $itemnumber, $borrowernumber ) = @_;
2671 my $dbh = C4::Context->dbh;
2674 # Get the book's item type and rental charge (via its biblioitem).
2675 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2676 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2677 $charge_query .= (C4::Context->preference('item-level_itypes'))
2678 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2679 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2681 $charge_query .= ' WHERE items.itemnumber =?';
2683 my $sth = $dbh->prepare($charge_query);
2684 $sth->execute($itemnumber);
2685 if ( my $item_data = $sth->fetchrow_hashref ) {
2686 $item_type = $item_data->{itemtype};
2687 $charge = $item_data->{rentalcharge};
2688 my $branch = C4::Branch::mybranch();
2689 my $discount_query = q|SELECT rentaldiscount,
2690 issuingrules.itemtype, issuingrules.branchcode
2692 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2693 WHERE borrowers.borrowernumber = ?
2694 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2695 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2696 my $discount_sth = $dbh->prepare($discount_query);
2697 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2698 my $discount_rules = $discount_sth->fetchall_arrayref({});
2699 if (@{$discount_rules}) {
2700 # We may have multiple rules so get the most specific
2701 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2702 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2706 return ( $charge, $item_type );
2709 # Select most appropriate discount rule from those returned
2710 sub _get_discount_from_rule {
2711 my ($rules_ref, $branch, $itemtype) = @_;
2714 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2715 $discount = $rules_ref->[0]->{rentaldiscount};
2716 return (defined $discount) ? $discount : 0;
2718 # could have up to 4 does one match $branch and $itemtype
2719 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2721 $discount = $d[0]->{rentaldiscount};
2722 return (defined $discount) ? $discount : 0;
2724 # do we have item type + all branches
2725 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2727 $discount = $d[0]->{rentaldiscount};
2728 return (defined $discount) ? $discount : 0;
2730 # do we all item types + this branch
2731 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2733 $discount = $d[0]->{rentaldiscount};
2734 return (defined $discount) ? $discount : 0;
2736 # so all and all (surely we wont get here)
2737 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2739 $discount = $d[0]->{rentaldiscount};
2740 return (defined $discount) ? $discount : 0;
2746 =head2 AddIssuingCharge
2748 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2752 sub AddIssuingCharge {
2753 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2754 my $dbh = C4::Context->dbh;
2755 my $nextaccntno = getnextacctno( $borrowernumber );
2757 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2759 INSERT INTO accountlines
2760 (borrowernumber, itemnumber, accountno,
2761 date, amount, description, accounttype,
2762 amountoutstanding, manager_id)
2763 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2765 my $sth = $dbh->prepare($query);
2766 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2771 GetTransfers($itemnumber);
2776 my ($itemnumber) = @_;
2778 my $dbh = C4::Context->dbh;
2784 FROM branchtransfers
2785 WHERE itemnumber = ?
2786 AND datearrived IS NULL
2788 my $sth = $dbh->prepare($query);
2789 $sth->execute($itemnumber);
2790 my @row = $sth->fetchrow_array();
2794 =head2 GetTransfersFromTo
2796 @results = GetTransfersFromTo($frombranch,$tobranch);
2798 Returns the list of pending transfers between $from and $to branch
2802 sub GetTransfersFromTo {
2803 my ( $frombranch, $tobranch ) = @_;
2804 return unless ( $frombranch && $tobranch );
2805 my $dbh = C4::Context->dbh;
2807 SELECT itemnumber,datesent,frombranch
2808 FROM branchtransfers
2811 AND datearrived IS NULL
2813 my $sth = $dbh->prepare($query);
2814 $sth->execute( $frombranch, $tobranch );
2817 while ( my $data = $sth->fetchrow_hashref ) {
2818 push @gettransfers, $data;
2820 return (@gettransfers);
2823 =head2 DeleteTransfer
2825 &DeleteTransfer($itemnumber);
2829 sub DeleteTransfer {
2830 my ($itemnumber) = @_;
2831 return unless $itemnumber;
2832 my $dbh = C4::Context->dbh;
2833 my $sth = $dbh->prepare(
2834 "DELETE FROM branchtransfers
2836 AND datearrived IS NULL "
2838 return $sth->execute($itemnumber);
2841 =head2 AnonymiseIssueHistory
2843 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
2845 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2846 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2848 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2849 setting (force delete).
2851 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
2855 sub AnonymiseIssueHistory {
2857 my $borrowernumber = shift;
2858 my $dbh = C4::Context->dbh;
2861 SET borrowernumber = ?
2862 WHERE returndate < ?
2863 AND borrowernumber IS NOT NULL
2866 # The default of 0 does not work due to foreign key constraints
2867 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2868 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2869 my @bind_params = ($anonymouspatron, $date);
2870 if (defined $borrowernumber) {
2871 $query .= " AND borrowernumber = ?";
2872 push @bind_params, $borrowernumber;
2874 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2876 my $sth = $dbh->prepare($query);
2877 $sth->execute(@bind_params);
2878 my $anonymisation_err = $dbh->err;
2879 my $rows_affected = $sth->rows; ### doublecheck row count return function
2880 return ($rows_affected, $anonymisation_err);
2883 =head2 SendCirculationAlert
2885 Send out a C<check-in> or C<checkout> alert using the messaging system.
2893 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2897 Hashref of information about the item being checked in or out.
2901 Hashref of information about the borrower of the item.
2905 The branchcode from where the checkout or check-in took place.
2911 SendCirculationAlert({
2914 borrower => $borrower,
2920 sub SendCirculationAlert {
2922 my ($type, $item, $borrower, $branch) =
2923 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2924 my %message_name = (
2925 CHECKIN => 'Item_Check_in',
2926 CHECKOUT => 'Item_Checkout',
2927 RENEWAL => 'Item_Checkout',
2929 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2930 borrowernumber => $borrower->{borrowernumber},
2931 message_name => $message_name{$type},
2933 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
2934 my $letter = C4::Letters::GetPreparedLetter (
2935 module => 'circulation',
2936 letter_code => $type,
2937 branchcode => $branch,
2939 $issues_table => $item->{itemnumber},
2940 'items' => $item->{itemnumber},
2941 'biblio' => $item->{biblionumber},
2942 'biblioitems' => $item->{biblionumber},
2943 'borrowers' => $borrower,
2944 'branches' => $branch,
2948 my @transports = keys %{ $borrower_preferences->{transports} };
2949 # warn "no transports" unless @transports;
2951 # warn "transport: $_";
2952 my $message = C4::Message->find_last_message($borrower, $type, $_);
2954 #warn "create new message";
2955 C4::Message->enqueue($letter, $borrower, $_);
2957 #warn "append to old message";
2958 $message->append($letter);
2966 =head2 updateWrongTransfer
2968 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2970 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
2974 sub updateWrongTransfer {
2975 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2976 my $dbh = C4::Context->dbh;
2977 # first step validate the actual line of transfert .
2980 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2982 $sth->execute($FromLibrary,$itemNumber);
2984 # second step create a new line of branchtransfer to the right location .
2985 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2987 #third step changing holdingbranch of item
2988 UpdateHoldingbranch($FromLibrary,$itemNumber);
2991 =head2 UpdateHoldingbranch
2993 $items = UpdateHoldingbranch($branch,$itmenumber);
2995 Simple methode for updating hodlingbranch in items BDD line
2999 sub UpdateHoldingbranch {
3000 my ( $branch,$itemnumber ) = @_;
3001 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3006 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3008 this function calculates the due date given the start date and configured circulation rules,
3009 checking against the holidays calendar as per the 'useDaysMode' syspref.
3010 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
3011 C<$itemtype> = itemtype code of item in question
3012 C<$branch> = location whose calendar to use
3013 C<$borrower> = Borrower object
3014 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3019 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3023 # loanlength now a href
3025 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3027 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3033 if (ref $startdate ne 'DateTime' ) {
3034 $datedue = dt_from_string($datedue);
3036 $datedue = $startdate->clone;
3040 DateTime->now( time_zone => C4::Context->tz() )
3041 ->truncate( to => 'minute' );
3045 # calculate the datedue as normal
3046 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3047 { # ignoring calendar
3048 if ( $loanlength->{lengthunit} eq 'hours' ) {
3049 $datedue->add( hours => $loanlength->{$length_key} );
3051 $datedue->add( days => $loanlength->{$length_key} );
3052 $datedue->set_hour(23);
3053 $datedue->set_minute(59);
3057 if ($loanlength->{lengthunit} eq 'hours') {
3058 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3061 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3063 my $calendar = Koha::Calendar->new( branchcode => $branch );
3064 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3065 if ($loanlength->{lengthunit} eq 'days') {
3066 $datedue->set_hour(23);
3067 $datedue->set_minute(59);
3071 # if Hard Due Dates are used, retreive them and apply as necessary
3072 my ( $hardduedate, $hardduedatecompare ) =
3073 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3074 if ($hardduedate) { # hardduedates are currently dates
3075 $hardduedate->truncate( to => 'minute' );
3076 $hardduedate->set_hour(23);
3077 $hardduedate->set_minute(59);
3078 my $cmp = DateTime->compare( $hardduedate, $datedue );
3080 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3081 # if the calculated date is before the 'after' Hard Due Date (floor), override
3082 # if the hard due date is set to 'exactly', overrride
3083 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3084 $datedue = $hardduedate->clone;
3087 # in all other cases, keep the date due as it is
3091 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3092 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3093 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
3094 $expiry_dt->set( hour => 23, minute => 59);
3095 if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
3096 $datedue = $expiry_dt->clone;
3104 =head2 CheckRepeatableHolidays
3106 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3108 This function checks if the date due is a repeatable holiday
3110 C<$date_due> = returndate calculate with no day check
3111 C<$itemnumber> = itemnumber
3112 C<$branchcode> = localisation of issue
3116 sub CheckRepeatableHolidays{
3117 my($itemnumber,$week_day,$branchcode)=@_;
3118 my $dbh = C4::Context->dbh;
3119 my $query = qq|SELECT count(*)
3120 FROM repeatable_holidays
3123 my $sth = $dbh->prepare($query);
3124 $sth->execute($branchcode,$week_day);
3125 my $result=$sth->fetchrow;
3130 =head2 CheckSpecialHolidays
3132 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3134 This function check if the date is a special holiday
3136 C<$years> = the years of datedue
3137 C<$month> = the month of datedue
3138 C<$day> = the day of datedue
3139 C<$itemnumber> = itemnumber
3140 C<$branchcode> = localisation of issue
3144 sub CheckSpecialHolidays{
3145 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3146 my $dbh = C4::Context->dbh;
3147 my $query=qq|SELECT count(*)
3148 FROM `special_holidays`
3154 my $sth = $dbh->prepare($query);
3155 $sth->execute($years,$month,$day,$branchcode);
3156 my $countspecial=$sth->fetchrow ;
3157 return $countspecial;
3160 =head2 CheckRepeatableSpecialHolidays
3162 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3164 This function check if the date is a repeatble special holidays
3166 C<$month> = the month of datedue
3167 C<$day> = the day of datedue
3168 C<$itemnumber> = itemnumber
3169 C<$branchcode> = localisation of issue
3173 sub CheckRepeatableSpecialHolidays{
3174 my ($month,$day,$itemnumber,$branchcode) = @_;
3175 my $dbh = C4::Context->dbh;
3176 my $query=qq|SELECT count(*)
3177 FROM `repeatable_holidays`
3182 my $sth = $dbh->prepare($query);
3183 $sth->execute($month,$day,$branchcode);
3184 my $countspecial=$sth->fetchrow ;
3185 return $countspecial;
3190 sub CheckValidBarcode{
3192 my $dbh = C4::Context->dbh;
3193 my $query=qq|SELECT count(*)
3197 my $sth = $dbh->prepare($query);
3198 $sth->execute($barcode);
3199 my $exist=$sth->fetchrow ;
3203 =head2 IsBranchTransferAllowed
3205 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3207 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3211 sub IsBranchTransferAllowed {
3212 my ( $toBranch, $fromBranch, $code ) = @_;
3214 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3216 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3217 my $dbh = C4::Context->dbh;
3219 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3220 $sth->execute( $toBranch, $fromBranch, $code );
3221 my $limit = $sth->fetchrow_hashref();
3223 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3224 if ( $limit->{'limitId'} ) {
3231 =head2 CreateBranchTransferLimit
3233 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3235 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3239 sub CreateBranchTransferLimit {
3240 my ( $toBranch, $fromBranch, $code ) = @_;
3241 return unless defined($toBranch) && defined($fromBranch);
3242 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3244 my $dbh = C4::Context->dbh;
3246 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3247 return $sth->execute( $code, $toBranch, $fromBranch );
3250 =head2 DeleteBranchTransferLimits
3252 my $result = DeleteBranchTransferLimits($frombranch);
3254 Deletes all the library transfer limits for one library. Returns the
3255 number of limits deleted, 0e0 if no limits were deleted, or undef if
3256 no arguments are supplied.
3260 sub DeleteBranchTransferLimits {
3262 return unless defined $branch;
3263 my $dbh = C4::Context->dbh;
3264 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3265 return $sth->execute($branch);
3269 my ( $borrowernumber, $itemnum ) = @_;
3271 MarkIssueReturned( $borrowernumber, $itemnum );
3272 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3273 my $item = C4::Items::GetItem( $itemnum );
3274 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3275 my @datearr = localtime(time);
3276 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3277 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3278 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3283 my ($itemnumber, $mark_returned) = @_;
3285 my $dbh = C4::Context->dbh();
3286 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3288 JOIN items USING (itemnumber)
3289 JOIN biblio USING (biblionumber)
3290 WHERE issues.itemnumber=?");
3291 $sth->execute($itemnumber);
3292 my $issues=$sth->fetchrow_hashref();
3294 # If a borrower lost the item, add a replacement cost to the their record
3295 if ( my $borrowernumber = $issues->{borrowernumber} ){
3296 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3298 if (C4::Context->preference('WhenLostForgiveFine')){
3299 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3300 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3302 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3303 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3304 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3305 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3308 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3312 sub GetOfflineOperations {
3313 my $dbh = C4::Context->dbh;
3314 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3315 $sth->execute(C4::Context->userenv->{'branch'});
3316 my $results = $sth->fetchall_arrayref({});
3320 sub GetOfflineOperation {
3321 my $operationid = shift;
3322 return unless $operationid;
3323 my $dbh = C4::Context->dbh;
3324 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3325 $sth->execute( $operationid );
3326 return $sth->fetchrow_hashref;
3329 sub AddOfflineOperation {
3330 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3331 my $dbh = C4::Context->dbh;
3332 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3333 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3337 sub DeleteOfflineOperation {
3338 my $dbh = C4::Context->dbh;
3339 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3340 $sth->execute( shift );
3344 sub ProcessOfflineOperation {
3345 my $operation = shift;
3348 if ( $operation->{action} eq 'return' ) {
3349 $report = ProcessOfflineReturn( $operation );
3350 } elsif ( $operation->{action} eq 'issue' ) {
3351 $report = ProcessOfflineIssue( $operation );
3352 } elsif ( $operation->{action} eq 'payment' ) {
3353 $report = ProcessOfflinePayment( $operation );
3356 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3361 sub ProcessOfflineReturn {
3362 my $operation = shift;
3364 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3366 if ( $itemnumber ) {
3367 my $issue = GetOpenIssue( $itemnumber );
3370 $issue->{borrowernumber},
3373 $operation->{timestamp},
3376 { renewals => 0, onloan => undef },
3377 $issue->{'biblionumber'},
3382 return "Item not issued.";
3385 return "Item not found.";
3389 sub ProcessOfflineIssue {
3390 my $operation = shift;
3392 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3394 if ( $borrower->{borrowernumber} ) {
3395 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3396 unless ($itemnumber) {
3397 return "Barcode not found.";
3399 my $issue = GetOpenIssue( $itemnumber );
3401 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3403 $issue->{borrowernumber},
3406 $operation->{timestamp},
3411 $operation->{'barcode'},
3414 $operation->{timestamp},
3419 return "Borrower not found.";
3423 sub ProcessOfflinePayment {
3424 my $operation = shift;
3426 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3427 my $amount = $operation->{amount};
3429 recordpayment( $borrower->{borrowernumber}, $amount );
3437 TransferSlip($user_branch, $itemnumber, $to_branch)
3439 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3444 my ($branch, $itemnumber, $to_branch) = @_;
3446 my $item = GetItem( $itemnumber )
3449 my $pulldate = C4::Dates->new();
3451 return C4::Letters::GetPreparedLetter (
3452 module => 'circulation',
3453 letter_code => 'TRANSFERSLIP',
3454 branchcode => $branch,
3456 'branches' => $to_branch,
3457 'biblio' => $item->{biblionumber},
3463 =head2 CheckIfIssuedToPatron
3465 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3467 Return 1 if any record item is issued to patron, otherwise return 0
3471 sub CheckIfIssuedToPatron {
3472 my ($borrowernumber, $biblionumber) = @_;
3474 my $items = GetItemsByBiblioitemnumber($biblionumber);
3476 foreach my $item (@{$items}) {
3477 return 1 if ($item->{borrowernumber} && $item->{borrowernumber} eq $borrowernumber);
3485 IsItemIssued( $itemnumber )
3487 Return 1 if the item is on loan, otherwise return 0
3492 my $itemnumber = shift;
3493 my $dbh = C4::Context->dbh;
3494 my $sth = $dbh->prepare(q{
3497 WHERE itemnumber = ?
3499 $sth->execute($itemnumber);
3500 return $sth->fetchrow;
3509 Koha Development Team <http://koha-community.org/>