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;
50 use Koha::Borrower::Debarments;
61 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
65 $VERSION = 3.07.00.049; # for version checking
68 # FIXME subs that should probably be elsewhere
75 # subs to deal with issuing a book
87 &GetBranchBorrowerCircRule
91 &AnonymiseIssueHistory
92 &CheckIfIssuedToPatron
96 # subs to deal with returns
102 # subs to deal with transfers
109 &IsBranchTransferAllowed
110 &CreateBranchTransferLimit
111 &DeleteBranchTransferLimits
115 # subs to deal with offline circulation
117 &GetOfflineOperations
120 &DeleteOfflineOperation
121 &ProcessOfflineOperation
127 C4::Circulation - Koha circulation module
135 The functions in this module deal with circulation, issues, and
136 returns, as well as general information about the library.
137 Also deals with stocktaking.
143 $str = &barcodedecode($barcode, [$filter]);
145 Generic filter function for barcode string.
146 Called on every circ if the System Pref itemBarcodeInputFilter is set.
147 Will do some manipulation of the barcode for systems that deliver a barcode
148 to circulation.pl that differs from the barcode stored for the item.
149 For proper functioning of this filter, calling the function on the
150 correct barcode string (items.barcode) should return an unaltered barcode.
152 The optional $filter argument is to allow for testing or explicit
153 behavior that ignores the System Pref. Valid values are the same as the
158 # FIXME -- the &decode fcn below should be wrapped into this one.
159 # FIXME -- these plugins should be moved out of Circulation.pm
162 my ($barcode, $filter) = @_;
163 my $branch = C4::Branch::mybranch();
164 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
165 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
166 if ($filter eq 'whitespace') {
168 } elsif ($filter eq 'cuecat') {
170 my @fields = split( /\./, $barcode );
171 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
172 ($#results == 2) and return $results[2];
173 } elsif ($filter eq 'T-prefix') {
174 if ($barcode =~ /^[Tt](\d)/) {
175 (defined($1) and $1 eq '0') and return $barcode;
176 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
178 return sprintf("T%07d", $barcode);
179 # FIXME: $barcode could be "T1", causing warning: substr outside of string
180 # Why drop the nonzero digit after the T?
181 # Why pass non-digits (or empty string) to "T%07d"?
182 } elsif ($filter eq 'libsuite8') {
183 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
184 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
185 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
187 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
190 } elsif ($filter eq 'EAN13') {
191 my $ean = CheckDigits('ean');
192 if ( $ean->is_valid($barcode) ) {
193 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
194 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
196 warn "# [$barcode] not valid EAN-13/UPC-A\n";
199 return $barcode; # return barcode, modified or not
204 $str = &decode($chunk);
206 Decodes a segment of a string emitted by a CueCat barcode scanner and
209 FIXME: Should be replaced with Barcode::Cuecat from CPAN
210 or Javascript based decoding on the client side.
217 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
218 my @s = map { index( $seq, $_ ); } split( //, $encoded );
219 my $l = ( $#s + 1 ) % 4;
222 # warn "Error: Cuecat decode parsing failed!";
230 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
232 chr( ( $n >> 16 ) ^ 67 )
233 .chr( ( $n >> 8 & 255 ) ^ 67 )
234 .chr( ( $n & 255 ) ^ 67 );
237 $r = substr( $r, 0, length($r) - $l );
243 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
244 $barcode, $ignore_reserves);
246 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
248 C<$newbranch> is the code for the branch to which the item should be transferred.
250 C<$barcode> is the barcode of the item to be transferred.
252 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
253 Otherwise, if an item is reserved, the transfer fails.
255 Returns three values:
261 is true if the transfer was successful.
265 is a reference-to-hash which may have any of the following keys:
271 There is no item in the catalog with the given barcode. The value is C<$barcode>.
275 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.
277 =item C<DestinationEqualsHolding>
279 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.
283 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.
287 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>.
289 =item C<WasTransferred>
291 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
300 my ( $tbr, $barcode, $ignoreRs ) = @_;
303 my $branches = GetBranches();
304 my $itemnumber = GetItemnumberFromBarcode( $barcode );
305 my $issue = GetItemIssue($itemnumber);
306 my $biblio = GetBiblioFromItemNumber($itemnumber);
309 if ( not $itemnumber ) {
310 $messages->{'BadBarcode'} = $barcode;
314 # get branches of book...
315 my $hbr = $biblio->{'homebranch'};
316 my $fbr = $biblio->{'holdingbranch'};
318 # if using Branch Transfer Limits
319 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
320 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
321 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
322 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
325 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
326 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
332 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
333 $messages->{'IsPermanent'} = $hbr;
337 # can't transfer book if is already there....
338 if ( $fbr eq $tbr ) {
339 $messages->{'DestinationEqualsHolding'} = 1;
343 # check if it is still issued to someone, return it...
344 if ($issue->{borrowernumber}) {
345 AddReturn( $barcode, $fbr );
346 $messages->{'WasReturned'} = $issue->{borrowernumber};
350 # That'll save a database query.
351 my ( $resfound, $resrec, undef ) =
352 CheckReserves( $itemnumber );
353 if ( $resfound and not $ignoreRs ) {
354 $resrec->{'ResFound'} = $resfound;
356 # $messages->{'ResFound'} = $resrec;
360 #actually do the transfer....
362 ModItemTransfer( $itemnumber, $fbr, $tbr );
364 # don't need to update MARC anymore, we do it in batch now
365 $messages->{'WasTransfered'} = 1;
368 ModDateLastSeen( $itemnumber );
369 return ( $dotransfer, $messages, $biblio );
374 my $borrower = shift;
375 my $biblionumber = shift;
377 my $cat_borrower = $borrower->{'categorycode'};
378 my $dbh = C4::Context->dbh;
380 # Get which branchcode we need
381 $branch = _GetCircControlBranch($item,$borrower);
382 my $type = (C4::Context->preference('item-level_itypes'))
383 ? $item->{'itype'} # item-level
384 : $item->{'itemtype'}; # biblio-level
386 # given branch, patron category, and item type, determine
387 # applicable issuing rule
388 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
390 # if a rule is found and has a loan limit set, count
391 # how many loans the patron already has that meet that
393 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
395 my $count_query = "SELECT COUNT(*) FROM issues
396 JOIN items USING (itemnumber) ";
398 my $rule_itemtype = $issuing_rule->{itemtype};
399 if ($rule_itemtype eq "*") {
400 # matching rule has the default item type, so count only
401 # those existing loans that don't fall under a more
403 if (C4::Context->preference('item-level_itypes')) {
404 $count_query .= " WHERE items.itype NOT IN (
405 SELECT itemtype FROM issuingrules
407 AND (categorycode = ? OR categorycode = ?)
411 $count_query .= " JOIN biblioitems USING (biblionumber)
412 WHERE biblioitems.itemtype NOT IN (
413 SELECT itemtype FROM issuingrules
415 AND (categorycode = ? OR categorycode = ?)
419 push @bind_params, $issuing_rule->{branchcode};
420 push @bind_params, $issuing_rule->{categorycode};
421 push @bind_params, $cat_borrower;
423 # rule has specific item type, so count loans of that
425 if (C4::Context->preference('item-level_itypes')) {
426 $count_query .= " WHERE items.itype = ? ";
428 $count_query .= " JOIN biblioitems USING (biblionumber)
429 WHERE biblioitems.itemtype= ? ";
431 push @bind_params, $type;
434 $count_query .= " AND borrowernumber = ? ";
435 push @bind_params, $borrower->{'borrowernumber'};
436 my $rule_branch = $issuing_rule->{branchcode};
437 if ($rule_branch ne "*") {
438 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
439 $count_query .= " AND issues.branchcode = ? ";
440 push @bind_params, $branch;
441 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
442 ; # if branch is the patron's home branch, then count all loans by patron
444 $count_query .= " AND items.homebranch = ? ";
445 push @bind_params, $branch;
449 my $count_sth = $dbh->prepare($count_query);
450 $count_sth->execute(@bind_params);
451 my ($current_loan_count) = $count_sth->fetchrow_array;
453 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
454 if ($current_loan_count >= $max_loans_allowed) {
455 return ($current_loan_count, $max_loans_allowed);
459 # Now count total loans against the limit for the branch
460 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
461 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
462 my @bind_params = ();
463 my $branch_count_query = "SELECT COUNT(*) FROM issues
464 JOIN items USING (itemnumber)
465 WHERE borrowernumber = ? ";
466 push @bind_params, $borrower->{borrowernumber};
468 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
469 $branch_count_query .= " AND issues.branchcode = ? ";
470 push @bind_params, $branch;
471 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
472 ; # if branch is the patron's home branch, then count all loans by patron
474 $branch_count_query .= " AND items.homebranch = ? ";
475 push @bind_params, $branch;
477 my $branch_count_sth = $dbh->prepare($branch_count_query);
478 $branch_count_sth->execute(@bind_params);
479 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
481 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
482 if ($current_loan_count >= $max_loans_allowed) {
483 return ($current_loan_count, $max_loans_allowed);
487 # OK, the patron can issue !!!
493 @issues = &itemissues($biblioitemnumber, $biblio);
495 Looks up information about who has borrowed the bookZ<>(s) with the
496 given biblioitemnumber.
498 C<$biblio> is ignored.
500 C<&itemissues> returns an array of references-to-hash. The keys
501 include the fields from the C<items> table in the Koha database.
502 Additional keys include:
508 If the item is currently on loan, this gives the due date.
510 If the item is not on loan, then this is either "Available" or
511 "Cancelled", if the item has been withdrawn.
515 If the item is currently on loan, this gives the card number of the
516 patron who currently has the item.
518 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
520 These give the timestamp for the last three times the item was
523 =item C<card0>, C<card1>, C<card2>
525 The card number of the last three patrons who borrowed this item.
527 =item C<borrower0>, C<borrower1>, C<borrower2>
529 The borrower number of the last three patrons who borrowed this item.
537 my ( $bibitem, $biblio ) = @_;
538 my $dbh = C4::Context->dbh;
540 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
545 $sth->execute($bibitem) || die $sth->errstr;
547 while ( my $data = $sth->fetchrow_hashref ) {
549 # Find out who currently has this item.
550 # FIXME - Wouldn't it be better to do this as a left join of
551 # some sort? Currently, this code assumes that if
552 # fetchrow_hashref() fails, then the book is on the shelf.
553 # fetchrow_hashref() can fail for any number of reasons (e.g.,
554 # database server crash), not just because no items match the
556 my $sth2 = $dbh->prepare(
557 "SELECT * FROM issues
558 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
563 $sth2->execute( $data->{'itemnumber'} );
564 if ( my $data2 = $sth2->fetchrow_hashref ) {
565 $data->{'date_due'} = $data2->{'date_due'};
566 $data->{'card'} = $data2->{'cardnumber'};
567 $data->{'borrower'} = $data2->{'borrowernumber'};
570 $data->{'date_due'} = ($data->{'withdrawn'} eq '1') ? 'Cancelled' : 'Available';
574 # Find the last 3 people who borrowed this item.
575 $sth2 = $dbh->prepare(
576 "SELECT * FROM old_issues
577 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
579 ORDER BY returndate DESC,timestamp DESC"
582 $sth2->execute( $data->{'itemnumber'} );
583 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
584 { # FIXME : error if there is less than 3 pple borrowing this item
585 if ( my $data2 = $sth2->fetchrow_hashref ) {
586 $data->{"timestamp$i2"} = $data2->{'timestamp'};
587 $data->{"card$i2"} = $data2->{'cardnumber'};
588 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
592 $results[$i] = $data;
599 =head2 CanBookBeIssued
601 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
602 $barcode, $duedatespec, $inprocess, $ignore_reserves );
604 Check if a book can be issued.
606 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
610 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
612 =item C<$barcode> is the bar code of the book being issued.
614 =item C<$duedatespec> is a C4::Dates object.
616 =item C<$inprocess> boolean switch
617 =item C<$ignore_reserves> boolean switch
625 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
626 Possible values are :
632 sticky due date is invalid
636 borrower gone with no address
640 borrower declared it's card lost
646 =head3 UNKNOWN_BARCODE
660 item is restricted (set by ??)
662 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
663 could be prevented, but ones that can be overriden by the operator.
665 Possible values are :
673 renewing, not issuing
675 =head3 ISSUED_TO_ANOTHER
677 issued to someone else.
681 reserved for someone else.
685 sticky due date is invalid or due date in the past
689 if the borrower borrows to much things
693 sub CanBookBeIssued {
694 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves ) = @_;
695 my %needsconfirmation; # filled with problems that needs confirmations
696 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
697 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
699 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
700 my $issue = GetItemIssue($item->{itemnumber});
701 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
702 $item->{'itemtype'}=$item->{'itype'};
703 my $dbh = C4::Context->dbh;
705 # MANDATORY CHECKS - unless item exists, nothing else matters
706 unless ( $item->{barcode} ) {
707 $issuingimpossible{UNKNOWN_BARCODE} = 1;
709 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
712 # DUE DATE is OK ? -- should already have checked.
714 if ($duedate && ref $duedate ne 'DateTime') {
715 $duedate = dt_from_string($duedate);
717 my $now = DateTime->now( time_zone => C4::Context->tz() );
718 unless ( $duedate ) {
719 my $issuedate = $now->clone();
721 my $branch = _GetCircControlBranch($item,$borrower);
722 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
723 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
725 # Offline circ calls AddIssue directly, doesn't run through here
726 # So issuingimpossible should be ok.
729 my $today = $now->clone();
730 $today->truncate( to => 'minute');
731 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
732 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
735 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
741 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
742 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
744 branch => C4::Context->userenv->{'branch'},
746 itemnumber => $item->{'itemnumber'},
747 itemtype => $item->{'itemtype'},
748 borrowernumber => $borrower->{'borrowernumber'},
749 ccode => $item->{'ccode'}}
751 ModDateLastSeen( $item->{'itemnumber'} );
752 return( { STATS => 1 }, {});
754 if ( $borrower->{flags}->{GNA} ) {
755 $issuingimpossible{GNA} = 1;
757 if ( $borrower->{flags}->{'LOST'} ) {
758 $issuingimpossible{CARD_LOST} = 1;
760 if ( $borrower->{flags}->{'DBARRED'} ) {
761 $issuingimpossible{DEBARRED} = 1;
763 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
764 $issuingimpossible{EXPIRED} = 1;
766 my ($y, $m, $d) = split /-/,$borrower->{'dateexpiry'};
767 if ($y && $m && $d) { # are we really writing oinvalid dates to borrs
768 my $expiry_dt = DateTime->new(
772 time_zone => C4::Context->tz,
774 $expiry_dt->truncate( to => 'day');
775 my $today = $now->clone()->truncate(to => 'day');
776 if (DateTime->compare($today, $expiry_dt) == 1) {
777 $issuingimpossible{EXPIRED} = 1;
780 carp("Invalid expity date in borr");
781 $issuingimpossible{EXPIRED} = 1;
789 my ($balance, $non_issue_charges, $other_charges) =
790 C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
791 my $amountlimit = C4::Context->preference("noissuescharge");
792 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
793 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
794 if ( C4::Context->preference("IssuingInProcess") ) {
795 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
796 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
797 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
798 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
799 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
800 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
804 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
805 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
806 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
807 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
808 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
809 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
812 if ($balance > 0 && $other_charges > 0) {
813 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
816 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
817 if ($blocktype == -1) {
818 ## patron has outstanding overdue loans
819 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
820 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
822 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
823 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
825 } elsif($blocktype == 1) {
826 # patron has accrued fine days
827 $issuingimpossible{USERBLOCKEDREMAINING} = $count;
831 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
833 my ($current_loan_count, $max_loans_allowed) = TooMany( $borrower, $item->{biblionumber}, $item );
834 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
835 if (defined $max_loans_allowed && $max_loans_allowed == 0) {
836 $needsconfirmation{PATRON_CANT} = 1;
838 if($max_loans_allowed){
839 if ( C4::Context->preference("AllowTooManyOverride") ) {
840 $needsconfirmation{TOO_MANY} = 1;
841 $needsconfirmation{current_loan_count} = $current_loan_count;
842 $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
844 $issuingimpossible{TOO_MANY} = 1;
845 $issuingimpossible{current_loan_count} = $current_loan_count;
846 $issuingimpossible{max_loans_allowed} = $max_loans_allowed;
854 if ( $item->{'notforloan'} )
856 if(!C4::Context->preference("AllowNotForLoanOverride")){
857 $issuingimpossible{NOT_FOR_LOAN} = 1;
858 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
860 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
861 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
865 # we have to check itemtypes.notforloan also
866 if (C4::Context->preference('item-level_itypes')){
867 # this should probably be a subroutine
868 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
869 $sth->execute($item->{'itemtype'});
870 my $notforloan=$sth->fetchrow_hashref();
871 if ($notforloan->{'notforloan'}) {
872 if (!C4::Context->preference("AllowNotForLoanOverride")) {
873 $issuingimpossible{NOT_FOR_LOAN} = 1;
874 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
876 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
877 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
881 elsif ($biblioitem->{'notforloan'} == 1){
882 if (!C4::Context->preference("AllowNotForLoanOverride")) {
883 $issuingimpossible{NOT_FOR_LOAN} = 1;
884 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
886 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
887 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
891 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
893 $issuingimpossible{WTHDRAWN} = 1;
895 if ( $item->{'restricted'}
896 && $item->{'restricted'} == 1 )
898 $issuingimpossible{RESTRICTED} = 1;
900 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
901 my $code = GetAuthorisedValueByCode( 'LOST', $item->{'itemlost'} );
902 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
903 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
905 if ( C4::Context->preference("IndependentBranches") ) {
906 my $userenv = C4::Context->userenv;
907 unless ( C4::Context->IsSuperLibrarian() ) {
908 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
909 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
910 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
912 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
913 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
918 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
920 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
923 # Already issued to current borrower. Ask whether the loan should
925 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
926 $borrower->{'borrowernumber'},
927 $item->{'itemnumber'}
929 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
930 $issuingimpossible{NO_MORE_RENEWALS} = 1;
933 $needsconfirmation{RENEW_ISSUE} = 1;
936 elsif ($issue->{borrowernumber}) {
938 # issued to someone else
939 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
941 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
942 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
943 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
944 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
945 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
946 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
949 unless ( $ignore_reserves ) {
950 # See if the item is on reserve.
951 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
953 my $resbor = $res->{'borrowernumber'};
954 if ( $resbor ne $borrower->{'borrowernumber'} ) {
955 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
956 my $branchname = GetBranchName( $res->{'branchcode'} );
957 if ( $restype eq "Waiting" )
959 # The item is on reserve and waiting, but has been
960 # reserved by some other patron.
961 $needsconfirmation{RESERVE_WAITING} = 1;
962 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
963 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
964 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
965 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
966 $needsconfirmation{'resbranchname'} = $branchname;
967 $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
969 elsif ( $restype eq "Reserved" ) {
970 # The item is on reserve for someone else.
971 $needsconfirmation{RESERVED} = 1;
972 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
973 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
974 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
975 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
976 $needsconfirmation{'resbranchname'} = $branchname;
977 $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
983 ## CHECK AGE RESTRICTION
984 # get $marker from preferences. Could be something like "FSK|PEGI|Alter|Age:"
985 my $markers = C4::Context->preference('AgeRestrictionMarker');
986 my $bibvalues = $biblioitem->{'agerestriction'};
987 my $restriction_age = GetAgeRestriction( $bibvalues );
989 if ( $restriction_age > 0 ) {
990 if ( $borrower->{'dateofbirth'} ) {
991 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
992 $alloweddate[0] += $restriction_age;
994 #Prevent runime eror on leap year (invalid date)
995 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
996 $alloweddate[2] = 28;
999 if ( Date_to_Days(Today) < Date_to_Days(@alloweddate) - 1 ) {
1000 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1001 $needsconfirmation{AGE_RESTRICTION} = "$bibvalues";
1004 $issuingimpossible{AGE_RESTRICTION} = "$bibvalues";
1010 ## check for high holds decreasing loan period
1011 my $decrease_loan = C4::Context->preference('decreaseLoanHighHolds');
1012 if ( $decrease_loan && $decrease_loan == 1 ) {
1013 my ( $reserved, $num, $duration, $returndate ) =
1014 checkHighHolds( $item, $borrower );
1016 if ( $num >= C4::Context->preference('decreaseLoanHighHoldsValue') ) {
1017 $needsconfirmation{HIGHHOLDS} = {
1019 duration => $duration,
1020 returndate => output_pref($returndate),
1026 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1027 # don't do the multiple loans per bib check if we've
1028 # already determined that we've got a loan on the same item
1029 !$issuingimpossible{NO_MORE_RENEWALS} &&
1030 !$needsconfirmation{RENEW_ISSUE}
1032 # Check if borrower has already issued an item from the same biblio
1033 # Only if it's not a subscription
1034 my $biblionumber = $item->{biblionumber};
1035 require C4::Serials;
1036 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1037 unless ($is_a_subscription) {
1038 my $issues = GetIssues( {
1039 borrowernumber => $borrower->{borrowernumber},
1040 biblionumber => $biblionumber,
1042 my @issues = $issues ? @$issues : ();
1043 # if we get here, we don't already have a loan on this item,
1044 # so if there are any loans on this bib, ask for confirmation
1045 if (scalar @issues > 0) {
1046 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1051 return ( \%issuingimpossible, \%needsconfirmation, \%alerts );
1054 =head2 CanBookBeReturned
1056 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1058 Check whether the item can be returned to the provided branch
1062 =item C<$item> is a hash of item information as returned from GetItem
1064 =item C<$branch> is the branchcode where the return is taking place
1072 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1074 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1080 sub CanBookBeReturned {
1081 my ($item, $branch) = @_;
1082 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1084 # assume return is allowed to start
1088 # identify all cases where return is forbidden
1089 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1091 $message = $item->{'homebranch'};
1092 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1094 $message = $item->{'holdingbranch'};
1095 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1097 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1100 return ($allowed, $message);
1103 =head2 CheckHighHolds
1105 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1106 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1107 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1111 sub checkHighHolds {
1112 my ( $item, $borrower ) = @_;
1113 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1114 my $branch = _GetCircControlBranch( $item, $borrower );
1115 my $dbh = C4::Context->dbh;
1116 my $sth = $dbh->prepare(
1117 'select count(borrowernumber) as num_holds from reserves where biblionumber=?'
1119 $sth->execute( $item->{'biblionumber'} );
1120 my ($holds) = $sth->fetchrow_array;
1122 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1124 my $calendar = Koha::Calendar->new( branchcode => $branch );
1127 ( C4::Context->preference('item-level_itypes') )
1128 ? $biblio->{'itype'}
1129 : $biblio->{'itemtype'};
1131 C4::Circulation::CalcDateDue( $issuedate, $itype, $branch,
1134 my $reduced_datedue =
1135 $calendar->addDate( $issuedate,
1136 C4::Context->preference('decreaseLoanHighHoldsDuration') );
1138 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1140 C4::Context->preference('decreaseLoanHighHoldsDuration'),
1144 return ( 0, 0, 0, undef );
1149 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1151 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1155 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1157 =item C<$barcode> is the barcode of the item being issued.
1159 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
1160 Calculated if empty.
1162 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1164 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1165 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
1167 AddIssue does the following things :
1169 - step 01: check that there is a borrowernumber & a barcode provided
1170 - check for RENEWAL (book issued & being issued to the same patron)
1171 - renewal YES = Calculate Charge & renew
1173 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1175 - fill reserve if reserve to this patron
1176 - cancel reserve or not, otherwise
1177 * TRANSFERT PENDING ?
1178 - complete the transfert
1186 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $auto_renew ) = @_;
1187 my $dbh = C4::Context->dbh;
1188 my $barcodecheck=CheckValidBarcode($barcode);
1189 if ($datedue && ref $datedue ne 'DateTime') {
1190 $datedue = dt_from_string($datedue);
1192 # $issuedate defaults to today.
1193 if ( ! defined $issuedate ) {
1194 $issuedate = DateTime->now(time_zone => C4::Context->tz());
1197 if ( ref $issuedate ne 'DateTime') {
1198 $issuedate = dt_from_string($issuedate);
1202 if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1203 # find which item we issue
1204 my $item = GetItem('', $barcode) or return; # if we don't get an Item, abort.
1205 my $branch = _GetCircControlBranch($item,$borrower);
1207 # get actual issuing if there is one
1208 my $actualissue = GetItemIssue( $item->{itemnumber});
1210 # get biblioinformation for this item
1211 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
1214 # check if we just renew the issue.
1216 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
1217 $datedue = AddRenewal(
1218 $borrower->{'borrowernumber'},
1219 $item->{'itemnumber'},
1222 $issuedate, # here interpreted as the renewal date
1226 # it's NOT a renewal
1227 if ( $actualissue->{borrowernumber}) {
1228 # This book is currently on loan, but not to the person
1229 # who wants to borrow it now. mark it returned before issuing to the new borrower
1232 C4::Context->userenv->{'branch'}
1236 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1237 # Starting process for transfer job (checking transfert and validate it if we have one)
1238 my ($datesent) = GetTransfers($item->{'itemnumber'});
1240 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1243 "UPDATE branchtransfers
1244 SET datearrived = now(),
1246 comments = 'Forced branchtransfer'
1247 WHERE itemnumber= ? AND datearrived IS NULL"
1249 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1252 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1253 unless ($auto_renew) {
1254 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branch);
1255 $auto_renew = $issuingrule->{auto_renew};
1258 # Record in the database the fact that the book was issued.
1262 (borrowernumber, itemnumber,issuedate, date_due, branchcode, auto_renew)
1263 VALUES (?,?,?,?,?,?)"
1266 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1267 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1270 $datedue->truncate( to => 'minute');
1272 $borrower->{'borrowernumber'}, # borrowernumber
1273 $item->{'itemnumber'}, # itemnumber
1274 $issuedate->strftime('%Y-%m-%d %H:%M:00'), # issuedate
1275 $datedue->strftime('%Y-%m-%d %H:%M:00'), # date_due
1276 C4::Context->userenv->{'branch'}, # branchcode
1277 $auto_renew ? 1 : 0 # automatic renewal
1279 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1280 CartToShelf( $item->{'itemnumber'} );
1282 $item->{'issues'}++;
1283 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1284 UpdateTotalIssues($item->{'biblionumber'}, 1);
1287 ## If item was lost, it has now been found, reverse any list item charges if neccessary.
1288 if ( $item->{'itemlost'} ) {
1289 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1290 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1294 ModItem({ issues => $item->{'issues'},
1295 holdingbranch => C4::Context->userenv->{'branch'},
1297 datelastborrowed => DateTime->now(time_zone => C4::Context->tz())->ymd(),
1298 onloan => $datedue->ymd(),
1299 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1300 ModDateLastSeen( $item->{'itemnumber'} );
1302 # If it costs to borrow this book, charge it to the patron's account.
1303 my ( $charge, $itemtype ) = GetIssuingCharges(
1304 $item->{'itemnumber'},
1305 $borrower->{'borrowernumber'}
1307 if ( $charge > 0 ) {
1309 $item->{'itemnumber'},
1310 $borrower->{'borrowernumber'}, $charge
1312 $item->{'charge'} = $charge;
1315 # Record the fact that this book was issued.
1317 branch => C4::Context->userenv->{'branch'},
1320 other => ($sipmode ? "SIP-$sipmode" : ''),
1321 itemnumber => $item->{'itemnumber'},
1322 itemtype => $item->{'itype'},
1323 borrowernumber => $borrower->{'borrowernumber'},
1324 ccode => $item->{'ccode'}}
1327 # Send a checkout slip.
1328 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1330 branchcode => $branch,
1331 categorycode => $borrower->{categorycode},
1332 item_type => $item->{itype},
1333 notification => 'CHECKOUT',
1335 if ($circulation_alert->is_enabled_for(\%conditions)) {
1336 SendCirculationAlert({
1339 borrower => $borrower,
1345 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'itemnumber'})
1346 if C4::Context->preference("IssueLog");
1348 return ($datedue); # not necessarily the same as when it came in!
1351 =head2 GetLoanLength
1353 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1355 Get loan length for an itemtype, a borrower type and a branch
1360 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1361 my $dbh = C4::Context->dbh;
1362 my $sth = $dbh->prepare(qq{
1363 SELECT issuelength, lengthunit, renewalperiod
1365 WHERE categorycode=?
1368 AND issuelength IS NOT NULL
1371 # try to find issuelength & return the 1st available.
1372 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1373 $sth->execute( $borrowertype, $itemtype, $branchcode );
1374 my $loanlength = $sth->fetchrow_hashref;
1377 if defined($loanlength) && $loanlength->{issuelength};
1379 $sth->execute( $borrowertype, '*', $branchcode );
1380 $loanlength = $sth->fetchrow_hashref;
1382 if defined($loanlength) && $loanlength->{issuelength};
1384 $sth->execute( '*', $itemtype, $branchcode );
1385 $loanlength = $sth->fetchrow_hashref;
1387 if defined($loanlength) && $loanlength->{issuelength};
1389 $sth->execute( '*', '*', $branchcode );
1390 $loanlength = $sth->fetchrow_hashref;
1392 if defined($loanlength) && $loanlength->{issuelength};
1394 $sth->execute( $borrowertype, $itemtype, '*' );
1395 $loanlength = $sth->fetchrow_hashref;
1397 if defined($loanlength) && $loanlength->{issuelength};
1399 $sth->execute( $borrowertype, '*', '*' );
1400 $loanlength = $sth->fetchrow_hashref;
1402 if defined($loanlength) && $loanlength->{issuelength};
1404 $sth->execute( '*', $itemtype, '*' );
1405 $loanlength = $sth->fetchrow_hashref;
1407 if defined($loanlength) && $loanlength->{issuelength};
1409 $sth->execute( '*', '*', '*' );
1410 $loanlength = $sth->fetchrow_hashref;
1412 if defined($loanlength) && $loanlength->{issuelength};
1414 # if no rule is set => 21 days (hardcoded)
1417 renewalperiod => 21,
1418 lengthunit => 'days',
1424 =head2 GetHardDueDate
1426 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1428 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1432 sub GetHardDueDate {
1433 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1435 my $rule = GetIssuingRule( $borrowertype, $itemtype, $branchcode );
1437 if ( defined( $rule ) ) {
1438 if ( $rule->{hardduedate} ) {
1439 return (dt_from_string($rule->{hardduedate}, 'iso'),$rule->{hardduedatecompare});
1441 return (undef, undef);
1446 =head2 GetIssuingRule
1448 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1450 FIXME - This is a copy-paste of GetLoanLength
1451 as a stop-gap. Do not wish to change API for GetLoanLength
1452 this close to release.
1454 Get the issuing rule for an itemtype, a borrower type and a branch
1455 Returns a hashref from the issuingrules table.
1459 sub GetIssuingRule {
1460 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1461 my $dbh = C4::Context->dbh;
1462 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1465 $sth->execute( $borrowertype, $itemtype, $branchcode );
1466 $irule = $sth->fetchrow_hashref;
1467 return $irule if defined($irule) ;
1469 $sth->execute( $borrowertype, "*", $branchcode );
1470 $irule = $sth->fetchrow_hashref;
1471 return $irule if defined($irule) ;
1473 $sth->execute( "*", $itemtype, $branchcode );
1474 $irule = $sth->fetchrow_hashref;
1475 return $irule if defined($irule) ;
1477 $sth->execute( "*", "*", $branchcode );
1478 $irule = $sth->fetchrow_hashref;
1479 return $irule if defined($irule) ;
1481 $sth->execute( $borrowertype, $itemtype, "*" );
1482 $irule = $sth->fetchrow_hashref;
1483 return $irule if defined($irule) ;
1485 $sth->execute( $borrowertype, "*", "*" );
1486 $irule = $sth->fetchrow_hashref;
1487 return $irule if defined($irule) ;
1489 $sth->execute( "*", $itemtype, "*" );
1490 $irule = $sth->fetchrow_hashref;
1491 return $irule if defined($irule) ;
1493 $sth->execute( "*", "*", "*" );
1494 $irule = $sth->fetchrow_hashref;
1495 return $irule if defined($irule) ;
1497 # if no rule matches,
1501 =head2 GetBranchBorrowerCircRule
1503 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1505 Retrieves circulation rule attributes that apply to the given
1506 branch and patron category, regardless of item type.
1507 The return value is a hashref containing the following key:
1509 maxissueqty - maximum number of loans that a
1510 patron of the given category can have at the given
1511 branch. If the value is undef, no limit.
1513 This will first check for a specific branch and
1514 category match from branch_borrower_circ_rules.
1516 If no rule is found, it will then check default_branch_circ_rules
1517 (same branch, default category). If no rule is found,
1518 it will then check default_borrower_circ_rules (default
1519 branch, same category), then failing that, default_circ_rules
1520 (default branch, default category).
1522 If no rule has been found in the database, it will default to
1527 C<$branchcode> and C<$categorycode> should contain the
1528 literal branch code and patron category code, respectively - no
1533 sub GetBranchBorrowerCircRule {
1534 my $branchcode = shift;
1535 my $categorycode = shift;
1537 my $branch_cat_query = "SELECT maxissueqty
1538 FROM branch_borrower_circ_rules
1539 WHERE branchcode = ?
1540 AND categorycode = ?";
1541 my $dbh = C4::Context->dbh();
1542 my $sth = $dbh->prepare($branch_cat_query);
1543 $sth->execute($branchcode, $categorycode);
1545 if ($result = $sth->fetchrow_hashref()) {
1549 # try same branch, default borrower category
1550 my $branch_query = "SELECT maxissueqty
1551 FROM default_branch_circ_rules
1552 WHERE branchcode = ?";
1553 $sth = $dbh->prepare($branch_query);
1554 $sth->execute($branchcode);
1555 if ($result = $sth->fetchrow_hashref()) {
1559 # try default branch, same borrower category
1560 my $category_query = "SELECT maxissueqty
1561 FROM default_borrower_circ_rules
1562 WHERE categorycode = ?";
1563 $sth = $dbh->prepare($category_query);
1564 $sth->execute($categorycode);
1565 if ($result = $sth->fetchrow_hashref()) {
1569 # try default branch, default borrower category
1570 my $default_query = "SELECT maxissueqty
1571 FROM default_circ_rules";
1572 $sth = $dbh->prepare($default_query);
1574 if ($result = $sth->fetchrow_hashref()) {
1578 # built-in default circulation rule
1580 maxissueqty => undef,
1584 =head2 GetBranchItemRule
1586 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1588 Retrieves circulation rule attributes that apply to the given
1589 branch and item type, regardless of patron category.
1591 The return value is a hashref containing the following keys:
1593 holdallowed => Hold policy for this branch and itemtype. Possible values:
1594 0: No holds allowed.
1595 1: Holds allowed only by patrons that have the same homebranch as the item.
1596 2: Holds allowed from any patron.
1598 returnbranch => branch to which to return item. Possible values:
1599 noreturn: do not return, let item remain where checked in (floating collections)
1600 homebranch: return to item's home branch
1602 This searches branchitemrules in the following order:
1604 * Same branchcode and itemtype
1605 * Same branchcode, itemtype '*'
1606 * branchcode '*', same itemtype
1607 * branchcode and itemtype '*'
1609 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1613 sub GetBranchItemRule {
1614 my ( $branchcode, $itemtype ) = @_;
1615 my $dbh = C4::Context->dbh();
1619 ['SELECT holdallowed, returnbranch
1620 FROM branch_item_rules
1621 WHERE branchcode = ?
1622 AND itemtype = ?', $branchcode, $itemtype],
1623 ['SELECT holdallowed, returnbranch
1624 FROM default_branch_circ_rules
1625 WHERE branchcode = ?', $branchcode],
1626 ['SELECT holdallowed, returnbranch
1627 FROM default_branch_item_rules
1628 WHERE itemtype = ?', $itemtype],
1629 ['SELECT holdallowed, returnbranch
1630 FROM default_circ_rules'],
1633 foreach my $attempt (@attempts) {
1634 my ($query, @bind_params) = @{$attempt};
1635 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1638 # Since branch/category and branch/itemtype use the same per-branch
1639 # defaults tables, we have to check that the key we want is set, not
1640 # just that a row was returned
1641 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1642 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1645 # built-in default circulation rule
1646 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1647 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1654 ($doreturn, $messages, $iteminformation, $borrower) =
1655 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1661 =item C<$barcode> is the bar code of the book being returned.
1663 =item C<$branch> is the code of the branch where the book is being returned.
1665 =item C<$exemptfine> indicates that overdue charges for the item will be
1668 =item C<$dropbox> indicates that the check-in date is assumed to be
1669 yesterday, or the last non-holiday as defined in C4::Calendar . If
1670 overdue charges are applied and C<$dropbox> is true, the last charge
1671 will be removed. This assumes that the fines accrual script has run
1672 for _today_. Optional.
1674 =item C<$return_date> allows the default return date to be overridden
1675 by the given return date. Optional.
1679 C<&AddReturn> returns a list of four items:
1681 C<$doreturn> is true iff the return succeeded.
1683 C<$messages> is a reference-to-hash giving feedback on the operation.
1684 The keys of the hash are:
1690 No item with this barcode exists. The value is C<$barcode>.
1694 The book is not currently on loan. The value is C<$barcode>.
1696 =item C<IsPermanent>
1698 The book's home branch is a permanent collection. If you have borrowed
1699 this book, you are not allowed to return it. The value is the code for
1700 the book's home branch.
1704 This book has been withdrawn/cancelled. The value should be ignored.
1706 =item C<Wrongbranch>
1708 This book has was returned to the wrong branch. The value is a hashref
1709 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1710 contain the branchcode of the incorrect and correct return library, respectively.
1714 The item was reserved. The value is a reference-to-hash whose keys are
1715 fields from the reserves table of the Koha database, and
1716 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1717 either C<Waiting>, C<Reserved>, or 0.
1721 C<$iteminformation> is a reference-to-hash, giving information about the
1722 returned item from the issues table.
1724 C<$borrower> is a reference-to-hash, giving information about the
1725 patron who last borrowed the book.
1730 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date ) = @_;
1732 if ($branch and not GetBranchDetail($branch)) {
1733 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1736 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1741 my $validTransfert = 0;
1742 my $stat_type = 'return';
1744 # get information on item
1745 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1746 unless ($itemnumber) {
1747 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1749 my $issue = GetItemIssue($itemnumber);
1750 # warn Dumper($iteminformation);
1751 if ($issue and $issue->{borrowernumber}) {
1752 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1753 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1754 . Dumper($issue) . "\n";
1756 $messages->{'NotIssued'} = $barcode;
1757 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1759 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1760 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1761 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1762 $messages->{'LocalUse'} = 1;
1763 $stat_type = 'localuse';
1767 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1768 # full item data, but no borrowernumber or checkout info (no issue)
1769 # we know GetItem should work because GetItemnumberFromBarcode worked
1770 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1771 # get the proper branch to which to return the item
1772 $hbr = $item->{$hbr} || $branch ;
1773 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1775 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1777 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1779 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1781 eval { $rules = YAML::Load($yaml); };
1783 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1786 foreach my $key ( keys %$rules ) {
1787 if ( $item->{notforloan} eq $key ) {
1788 $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1789 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1797 # check if the book is in a permanent collection....
1798 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1800 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1801 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1804 # check if the return is allowed at this branch
1805 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1806 unless ($returnallowed){
1807 $messages->{'Wrongbranch'} = {
1808 Wrongbranch => $branch,
1809 Rightbranch => $message
1812 return ( $doreturn, $messages, $issue, $borrower );
1815 if ( $item->{'withdrawn'} ) { # book has been cancelled
1816 $messages->{'withdrawn'} = 1;
1817 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1820 # case of a return of document (deal with issues and holdingbranch)
1821 my $today = DateTime->now( time_zone => C4::Context->tz() );
1824 my $datedue = $issue->{date_due};
1825 $borrower or warn "AddReturn without current borrower";
1826 my $circControlBranch;
1828 # define circControlBranch only if dropbox mode is set
1829 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1830 # FIXME: check issuedate > returndate, factoring in holidays
1831 #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1832 $circControlBranch = _GetCircControlBranch($item,$borrower);
1833 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $today ) == -1 ? 1 : 0;
1836 if ($borrowernumber) {
1837 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'} ) || $return_date ) {
1838 # we only need to calculate and change the fines if we want to do that on return
1839 # Should be on for hourly loans
1840 my $control = C4::Context->preference('CircControl');
1841 my $control_branchcode =
1842 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
1843 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
1844 : $issue->{branchcode};
1847 $return_date ? dt_from_string($return_date) : $today;
1849 my ( $amount, $type, $unitcounttotal ) =
1850 C4::Overdues::CalcFine( $item, $borrower->{categorycode},
1851 $control_branchcode, $datedue, $date_returned );
1855 if ( C4::Context->preference('finesMode') eq 'production' ) {
1856 if ( $amount > 0 ) {
1857 C4::Overdues::UpdateFine( $issue->{itemnumber},
1858 $issue->{borrowernumber},
1859 $amount, $type, output_pref($datedue) );
1861 elsif ($return_date) {
1863 # Backdated returns may have fines that shouldn't exist,
1864 # so in this case, we need to drop those fines to 0
1866 C4::Overdues::UpdateFine( $issue->{itemnumber},
1867 $issue->{borrowernumber},
1868 0, $type, output_pref($datedue) );
1873 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1874 $circControlBranch, $return_date, $borrower->{'privacy'} );
1876 # FIXME is the "= 1" right? This could be the borrower hash.
1877 $messages->{'WasReturned'} = 1;
1881 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1884 # the holdingbranch is updated if the document is returned to another location.
1885 # this is always done regardless of whether the item was on loan or not
1886 if ($item->{'holdingbranch'} ne $branch) {
1887 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1888 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1890 ModDateLastSeen( $item->{'itemnumber'} );
1892 # check if we have a transfer for this document
1893 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1895 # if we have a transfer to do, we update the line of transfers with the datearrived
1897 if ( $tobranch eq $branch ) {
1898 my $sth = C4::Context->dbh->prepare(
1899 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1901 $sth->execute( $item->{'itemnumber'} );
1902 # if we have a reservation with valid transfer, we can set it's status to 'W'
1903 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1904 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1906 $messages->{'WrongTransfer'} = $tobranch;
1907 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1909 $validTransfert = 1;
1911 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1914 # fix up the accounts.....
1915 if ( $item->{'itemlost'} ) {
1916 $messages->{'WasLost'} = 1;
1918 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1919 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1920 $messages->{'LostItemFeeRefunded'} = 1;
1924 # fix up the overdues in accounts...
1925 if ($borrowernumber) {
1926 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1927 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1929 if ( $issue->{overdue} && $issue->{date_due} ) {
1931 my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1933 $messages->{'PrevDebarred'} = $debardate;
1935 $messages->{'Debarred'} = $debardate if $debardate;
1937 # there's no overdue on the item but borrower had been previously debarred
1938 } elsif ( $issue->{date_due} and $borrower->{'debarred'} ) {
1939 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
1940 $borrower_debar_dt->truncate(to => 'day');
1941 my $today_dt = $today->clone()->truncate(to => 'day');
1942 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
1943 $messages->{'PrevDebarred'} = $borrower->{'debarred'};
1948 # find reserves.....
1949 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1950 my ($resfound, $resrec);
1951 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1952 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
1954 $resrec->{'ResFound'} = $resfound;
1955 $messages->{'ResFound'} = $resrec;
1958 # Record the fact that this book was returned.
1959 # FIXME itemtype should record item level type, not bibliolevel type
1963 itemnumber => $item->{'itemnumber'},
1964 itemtype => $biblio->{'itemtype'},
1965 borrowernumber => $borrowernumber,
1966 ccode => $item->{'ccode'}}
1969 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1970 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1972 branchcode => $branch,
1973 categorycode => $borrower->{categorycode},
1974 item_type => $item->{itype},
1975 notification => 'CHECKIN',
1977 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1978 SendCirculationAlert({
1981 borrower => $borrower,
1986 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
1987 if C4::Context->preference("ReturnLog");
1989 # Remove any OVERDUES related debarment if the borrower has no overdues
1990 if ( $borrowernumber
1991 && $borrower->{'debarred'}
1992 && C4::Context->preference('AutoRemoveOverduesRestrictions')
1993 && !HasOverdues( $borrowernumber )
1994 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
1996 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
1999 # FIXME: make this comment intelligible.
2000 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
2001 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
2003 if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
2004 if ( C4::Context->preference("AutomaticItemReturn" ) or
2005 (C4::Context->preference("UseBranchTransferLimits") and
2006 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2008 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
2009 $debug and warn "item: " . Dumper($item);
2010 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
2011 $messages->{'WasTransfered'} = 1;
2013 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
2016 return ( $doreturn, $messages, $issue, $borrower );
2019 =head2 MarkIssueReturned
2021 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2023 Unconditionally marks an issue as being returned by
2024 moving the C<issues> row to C<old_issues> and
2025 setting C<returndate> to the current date, or
2026 the last non-holiday date of the branccode specified in
2027 C<dropbox_branch> . Assumes you've already checked that
2028 it's safe to do this, i.e. last non-holiday > issuedate.
2030 if C<$returndate> is specified (in iso format), it is used as the date
2031 of the return. It is ignored when a dropbox_branch is passed in.
2033 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2034 the old_issue is immediately anonymised
2036 Ideally, this function would be internal to C<C4::Circulation>,
2037 not exported, but it is currently needed by one
2038 routine in C<C4::Accounts>.
2042 sub MarkIssueReturned {
2043 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2045 my $dbh = C4::Context->dbh;
2046 my $query = 'UPDATE issues SET returndate=';
2048 if ($dropbox_branch) {
2049 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2050 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2052 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2053 } elsif ($returndate) {
2055 push @bind, $returndate;
2057 $query .= ' now() ';
2059 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
2060 push @bind, $borrowernumber, $itemnumber;
2062 my $sth_upd = $dbh->prepare($query);
2063 $sth_upd->execute(@bind);
2064 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
2065 WHERE borrowernumber = ?
2066 AND itemnumber = ?');
2067 $sth_copy->execute($borrowernumber, $itemnumber);
2068 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2069 if ( $privacy == 2) {
2070 # The default of 0 does not work due to foreign key constraints
2071 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2072 # FIXME the above is unacceptable - bug 9942 relates
2073 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2074 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
2075 WHERE borrowernumber = ?
2076 AND itemnumber = ?");
2077 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2079 my $sth_del = $dbh->prepare("DELETE FROM issues
2080 WHERE borrowernumber = ?
2081 AND itemnumber = ?");
2082 $sth_del->execute($borrowernumber, $itemnumber);
2084 ModItem( { 'onloan' => undef }, undef, $itemnumber );
2087 =head2 _debar_user_on_return
2089 _debar_user_on_return($borrower, $item, $datedue, today);
2091 C<$borrower> borrower hashref
2093 C<$item> item hashref
2095 C<$datedue> date due DateTime object
2097 C<$today> DateTime object representing the return time
2099 Internal function, called only by AddReturn that calculates and updates
2100 the user fine days, and debars him if necessary.
2102 Should only be called for overdue returns
2106 sub _debar_user_on_return {
2107 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2109 my $branchcode = _GetCircControlBranch( $item, $borrower );
2110 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
2112 # $deltadays is a DateTime::Duration object
2113 my $deltadays = $calendar->days_between( $dt_due, $dt_today );
2115 my $circcontrol = C4::Context->preference('CircControl');
2117 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2118 my $finedays = $issuingrule->{finedays};
2119 my $unit = $issuingrule->{lengthunit};
2123 # finedays is in days, so hourly loans must multiply by 24
2124 # thus 1 hour late equals 1 day suspension * finedays rate
2125 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2127 # grace period is measured in the same units as the loan
2129 DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2131 if ( $deltadays->subtract($grace)->is_positive() ) {
2132 my $suspension_days = $deltadays * $finedays;
2134 # If the max suspension days is < than the suspension days
2135 # the suspension days is limited to this maximum period.
2136 my $max_sd = $issuingrule->{maxsuspensiondays};
2137 if ( defined $max_sd ) {
2138 $max_sd = DateTime::Duration->new( days => $max_sd );
2139 $suspension_days = $max_sd
2140 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2144 $dt_today->clone()->add_duration( $suspension_days );
2146 Koha::Borrower::Debarments::AddUniqueDebarment({
2147 borrowernumber => $borrower->{borrowernumber},
2148 expiration => $new_debar_dt->ymd(),
2149 type => 'SUSPENSION',
2151 # if borrower was already debarred but does not get an extra debarment
2152 if ( $borrower->{debarred} eq Koha::Borrower::Debarments::IsDebarred($borrower->{borrowernumber}) ) {
2153 return ($borrower->{debarred},1);
2155 return $new_debar_dt->ymd();
2161 =head2 _FixOverduesOnReturn
2163 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2165 C<$brn> borrowernumber
2169 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2170 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2172 Internal function, called only by AddReturn
2176 sub _FixOverduesOnReturn {
2177 my ($borrowernumber, $item);
2178 unless ($borrowernumber = shift) {
2179 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2182 unless ($item = shift) {
2183 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2186 my ($exemptfine, $dropbox) = @_;
2187 my $dbh = C4::Context->dbh;
2189 # check for overdue fine
2190 my $sth = $dbh->prepare(
2191 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2193 $sth->execute( $borrowernumber, $item );
2195 # alter fine to show that the book has been returned
2196 my $data = $sth->fetchrow_hashref;
2197 return 0 unless $data; # no warning, there's just nothing to fix
2200 my @bind = ($data->{'accountlines_id'});
2202 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2203 if (C4::Context->preference("FinesLog")) {
2204 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2206 } elsif ($dropbox && $data->{lastincrement}) {
2207 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2208 my $amt = $data->{amount} - $data->{lastincrement} ;
2209 if (C4::Context->preference("FinesLog")) {
2210 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2212 $uquery = "update accountlines set accounttype='F' ";
2213 if($outstanding >= 0 && $amt >=0) {
2214 $uquery .= ", amount = ? , amountoutstanding=? ";
2215 unshift @bind, ($amt, $outstanding) ;
2218 $uquery = "update accountlines set accounttype='F' ";
2220 $uquery .= " where (accountlines_id = ?)";
2221 my $usth = $dbh->prepare($uquery);
2222 return $usth->execute(@bind);
2225 =head2 _FixAccountForLostAndReturned
2227 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2229 Calculates the charge for a book lost and returned.
2231 Internal function, not exported, called only by AddReturn.
2233 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2234 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2238 sub _FixAccountForLostAndReturned {
2239 my $itemnumber = shift or return;
2240 my $borrowernumber = @_ ? shift : undef;
2241 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2242 my $dbh = C4::Context->dbh;
2243 # check for charge made for lost book
2244 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2245 $sth->execute($itemnumber);
2246 my $data = $sth->fetchrow_hashref;
2247 $data or return; # bail if there is nothing to do
2248 $data->{accounttype} eq 'W' and return; # Written off
2250 # writeoff this amount
2252 my $amount = $data->{'amount'};
2253 my $acctno = $data->{'accountno'};
2254 my $amountleft; # Starts off undef/zero.
2255 if ($data->{'amountoutstanding'} == $amount) {
2256 $offset = $data->{'amount'};
2257 $amountleft = 0; # Hey, it's zero here, too.
2259 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2260 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2262 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2263 WHERE (accountlines_id = ?)");
2264 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2265 #check if any credit is left if so writeoff other accounts
2266 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2267 $amountleft *= -1 if ($amountleft < 0);
2268 if ($amountleft > 0) {
2269 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2270 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2271 $msth->execute($data->{'borrowernumber'});
2272 # offset transactions
2275 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2276 if ($accdata->{'amountoutstanding'} < $amountleft) {
2278 $amountleft -= $accdata->{'amountoutstanding'};
2280 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2283 my $thisacct = $accdata->{'accountlines_id'};
2284 # FIXME: move prepares outside while loop!
2285 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2286 WHERE (accountlines_id = ?)");
2287 $usth->execute($newamtos,$thisacct);
2288 $usth = $dbh->prepare("INSERT INTO accountoffsets
2289 (borrowernumber, accountno, offsetaccount, offsetamount)
2292 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2295 $amountleft *= -1 if ($amountleft > 0);
2296 my $desc = "Item Returned " . $item_id;
2297 $usth = $dbh->prepare("INSERT INTO accountlines
2298 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2299 VALUES (?,?,now(),?,?,'CR',?)");
2300 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2301 if ($borrowernumber) {
2302 # FIXME: same as query above. use 1 sth for both
2303 $usth = $dbh->prepare("INSERT INTO accountoffsets
2304 (borrowernumber, accountno, offsetaccount, offsetamount)
2306 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2308 ModItem({ paidfor => '' }, undef, $itemnumber);
2312 =head2 _GetCircControlBranch
2314 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2318 Return the library code to be used to determine which circulation
2319 policy applies to a transaction. Looks up the CircControl and
2320 HomeOrHoldingBranch system preferences.
2322 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2324 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2328 sub _GetCircControlBranch {
2329 my ($item, $borrower) = @_;
2330 my $circcontrol = C4::Context->preference('CircControl');
2333 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2334 $branch= C4::Context->userenv->{'branch'};
2335 } elsif ($circcontrol eq 'PatronLibrary') {
2336 $branch=$borrower->{branchcode};
2338 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2339 $branch = $item->{$branchfield};
2340 # default to item home branch if holdingbranch is used
2341 # and is not defined
2342 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2343 $branch = $item->{homebranch};
2356 $issue = &GetItemIssue($itemnumber);
2358 Returns patron currently having a book, or undef if not checked out.
2360 C<$itemnumber> is the itemnumber.
2362 C<$issue> is a hashref of the row from the issues table.
2367 my ($itemnumber) = @_;
2368 return unless $itemnumber;
2369 my $sth = C4::Context->dbh->prepare(
2370 "SELECT items.*, issues.*
2372 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2373 WHERE issues.itemnumber=?");
2374 $sth->execute($itemnumber);
2375 my $data = $sth->fetchrow_hashref;
2376 return unless $data;
2377 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2378 $data->{issuedate}->truncate(to => 'minute');
2379 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2380 $data->{date_due}->truncate(to => 'minute');
2381 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2382 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2388 $issue = GetOpenIssue( $itemnumber );
2390 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2392 C<$itemnumber> is the item's itemnumber
2399 my ( $itemnumber ) = @_;
2400 return unless $itemnumber;
2401 my $dbh = C4::Context->dbh;
2402 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2403 $sth->execute( $itemnumber );
2404 return $sth->fetchrow_hashref();
2410 $issues = GetIssues({}); # return all issues!
2411 $issues = GetIssues({ borrowernumber => $borrowernumber, biblionumber => $biblionumber });
2413 Returns all pending issues that match given criteria.
2414 Returns a arrayref or undef if an error occurs.
2416 Allowed criteria are:
2420 =item * borrowernumber
2422 =item * biblionumber
2431 my ($criteria) = @_;
2435 my @allowed = qw(borrowernumber biblionumber itemnumber);
2436 foreach (@allowed) {
2437 if (defined $criteria->{$_}) {
2440 value => $criteria->{$_},
2445 # Do we need to join other tables ?
2447 if (defined $criteria->{biblionumber}) {
2454 $where = "WHERE " . join(' AND ', map { "$_->{field} = ?" } @filters);
2460 if (defined $join{items}) {
2462 LEFT JOIN items ON (issues.itemnumber = items.itemnumber)
2468 my $dbh = C4::Context->dbh;
2469 my $sth = $dbh->prepare($query);
2470 my $rv = $sth->execute(map { $_->{value} } @filters);
2472 return $rv ? $sth->fetchall_arrayref({}) : undef;
2475 =head2 GetItemIssues
2477 $issues = &GetItemIssues($itemnumber, $history);
2479 Returns patrons that have issued a book
2481 C<$itemnumber> is the itemnumber
2482 C<$history> is false if you just want the current "issuer" (if any)
2483 and true if you want issues history from old_issues also.
2485 Returns reference to an array of hashes
2490 my ( $itemnumber, $history ) = @_;
2492 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2493 $today->truncate( to => 'minute' );
2494 my $sql = "SELECT * FROM issues
2495 JOIN borrowers USING (borrowernumber)
2496 JOIN items USING (itemnumber)
2497 WHERE issues.itemnumber = ? ";
2500 SELECT * FROM old_issues
2501 LEFT JOIN borrowers USING (borrowernumber)
2502 JOIN items USING (itemnumber)
2503 WHERE old_issues.itemnumber = ? ";
2505 $sql .= "ORDER BY date_due DESC";
2506 my $sth = C4::Context->dbh->prepare($sql);
2508 $sth->execute($itemnumber, $itemnumber);
2510 $sth->execute($itemnumber);
2512 my $results = $sth->fetchall_arrayref({});
2513 foreach (@$results) {
2514 my $date_due = dt_from_string($_->{date_due},'sql');
2515 $date_due->truncate( to => 'minute' );
2517 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2522 =head2 GetBiblioIssues
2524 $issues = GetBiblioIssues($biblionumber);
2526 this function get all issues from a biblionumber.
2529 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2530 tables issues and the firstname,surname & cardnumber from borrowers.
2534 sub GetBiblioIssues {
2535 my $biblionumber = shift;
2536 return unless $biblionumber;
2537 my $dbh = C4::Context->dbh;
2539 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2541 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2542 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2543 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2544 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2545 WHERE biblio.biblionumber = ?
2547 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2549 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2550 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2551 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2552 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2553 WHERE biblio.biblionumber = ?
2556 my $sth = $dbh->prepare($query);
2557 $sth->execute($biblionumber, $biblionumber);
2560 while ( my $data = $sth->fetchrow_hashref ) {
2561 push @issues, $data;
2566 =head2 GetUpcomingDueIssues
2568 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2572 sub GetUpcomingDueIssues {
2575 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2576 my $dbh = C4::Context->dbh;
2578 my $statement = <<END_SQL;
2579 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2581 LEFT JOIN items USING (itemnumber)
2582 LEFT OUTER JOIN branches USING (branchcode)
2583 WHERE returndate is NULL
2584 HAVING days_until_due >= 0 AND days_until_due <= ?
2587 my @bind_parameters = ( $params->{'days_in_advance'} );
2589 my $sth = $dbh->prepare( $statement );
2590 $sth->execute( @bind_parameters );
2591 my $upcoming_dues = $sth->fetchall_arrayref({});
2593 return $upcoming_dues;
2596 =head2 CanBookBeRenewed
2598 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2600 Find out whether a borrowed item may be renewed.
2602 C<$borrowernumber> is the borrower number of the patron who currently
2603 has the item on loan.
2605 C<$itemnumber> is the number of the item to renew.
2607 C<$override_limit>, if supplied with a true value, causes
2608 the limit on the number of times that the loan can be renewed
2609 (as controlled by the item type) to be ignored. Overriding also allows
2610 to renew sooner than "No renewal before" and to manually renew loans
2611 that are automatically renewed.
2613 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2614 item must currently be on loan to the specified borrower; renewals
2615 must be allowed for the item's type; and the borrower must not have
2616 already renewed the loan. $error will contain the reason the renewal can not proceed
2620 sub CanBookBeRenewed {
2621 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2623 my $dbh = C4::Context->dbh;
2626 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2627 my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2629 $borrowernumber ||= $itemissue->{borrowernumber};
2630 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2633 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2635 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2637 return ( 1, undef ) if $override_limit;
2639 my $branchcode = _GetCircControlBranch( $item, $borrower );
2641 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2643 return ( 0, "too_many" )
2644 if $issuingrule->{renewalsallowed} <= $itemissue->{renewals};
2646 if ( $issuingrule->{norenewalbefore} ) {
2648 # Get current time and add norenewalbefore.
2649 # If this is smaller than date_due, it's too soon for renewal.
2651 DateTime->now( time_zone => C4::Context->tz() )->add(
2652 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore}
2653 ) < $itemissue->{date_due}
2656 return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2657 return ( 0, "too_soon" );
2661 return ( 0, "auto_renew" ) if $itemissue->{auto_renew};
2662 return ( 1, undef );
2667 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2671 C<$borrowernumber> is the borrower number of the patron who currently
2674 C<$itemnumber> is the number of the item to renew.
2676 C<$branch> is the library where the renewal took place (if any).
2677 The library that controls the circ policies for the renewal is retrieved from the issues record.
2679 C<$datedue> can be a C4::Dates object used to set the due date.
2681 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2682 this parameter is not supplied, lastreneweddate is set to the current date.
2684 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2685 from the book's item type.
2690 my $borrowernumber = shift;
2691 my $itemnumber = shift or return;
2693 my $datedue = shift;
2694 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2696 my $item = GetItem($itemnumber) or return;
2697 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2699 my $dbh = C4::Context->dbh;
2701 # Find the issues record for this book
2703 $dbh->prepare("SELECT * FROM issues WHERE itemnumber = ?");
2704 $sth->execute( $itemnumber );
2705 my $issuedata = $sth->fetchrow_hashref;
2707 return unless ( $issuedata );
2709 $borrowernumber ||= $issuedata->{borrowernumber};
2711 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2712 carp 'Invalid date passed to AddRenewal.';
2716 # If the due date wasn't specified, calculate it by adding the
2717 # book's loan length to today's date or the current due date
2718 # based on the value of the RenewalPeriodBase syspref.
2721 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2722 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2724 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2725 dt_from_string( $issuedata->{date_due} ) :
2726 DateTime->now( time_zone => C4::Context->tz());
2727 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2730 # Update the issues record to have the new due date, and a new count
2731 # of how many times it has been renewed.
2732 my $renews = $issuedata->{'renewals'} + 1;
2733 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2734 WHERE borrowernumber=?
2738 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2740 # Update the renewal count on the item, and tell zebra to reindex
2741 $renews = $biblio->{'renewals'} + 1;
2742 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2744 # Charge a new rental fee, if applicable?
2745 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2746 if ( $charge > 0 ) {
2747 my $accountno = getnextacctno( $borrowernumber );
2748 my $item = GetBiblioFromItemNumber($itemnumber);
2750 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2751 $sth = $dbh->prepare(
2752 "INSERT INTO accountlines
2753 (date, borrowernumber, accountno, amount, manager_id,
2754 description,accounttype, amountoutstanding, itemnumber)
2755 VALUES (now(),?,?,?,?,?,?,?,?)"
2757 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2758 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2759 'Rent', $charge, $itemnumber );
2762 # Send a renewal slip according to checkout alert preferencei
2763 if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2764 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2765 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2767 branchcode => $branch,
2768 categorycode => $borrower->{categorycode},
2769 item_type => $item->{itype},
2770 notification => 'CHECKOUT',
2772 if ($circulation_alert->is_enabled_for(\%conditions)) {
2773 SendCirculationAlert({
2776 borrower => $borrower,
2782 # Remove any OVERDUES related debarment if the borrower has no overdues
2783 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2784 if ( $borrowernumber
2785 && $borrower->{'debarred'}
2786 && !HasOverdues( $borrowernumber )
2787 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2789 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2793 UpdateStats({branch => $branch,
2796 itemnumber => $itemnumber,
2797 itemtype => $item->{itype},
2798 borrowernumber => $borrowernumber,
2799 ccode => $item->{'ccode'}}
2805 # check renewal status
2806 my ( $bornum, $itemno ) = @_;
2807 my $dbh = C4::Context->dbh;
2809 my $renewsallowed = 0;
2812 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2813 my $item = GetItem($itemno);
2815 # Look in the issues table for this item, lent to this borrower,
2816 # and not yet returned.
2818 # FIXME - I think this function could be redone to use only one SQL call.
2819 my $sth = $dbh->prepare(
2820 "select * from issues
2821 where (borrowernumber = ?)
2822 and (itemnumber = ?)"
2824 $sth->execute( $bornum, $itemno );
2825 my $data = $sth->fetchrow_hashref;
2826 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2827 # $item and $borrower should be calculated
2828 my $branchcode = _GetCircControlBranch($item, $borrower);
2830 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2832 $renewsallowed = $issuingrule->{'renewalsallowed'};
2833 $renewsleft = $renewsallowed - $renewcount;
2834 if($renewsleft < 0){ $renewsleft = 0; }
2835 return ( $renewcount, $renewsallowed, $renewsleft );
2838 =head2 GetSoonestRenewDate
2840 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2842 Find out the soonest possible renew date of a borrowed item.
2844 C<$borrowernumber> is the borrower number of the patron who currently
2845 has the item on loan.
2847 C<$itemnumber> is the number of the item to renew.
2849 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2850 renew date, based on the value "No renewal before" of the applicable
2851 issuing rule. Returns the current date if the item can already be
2852 renewed, and returns undefined if the borrower, loan, or item
2857 sub GetSoonestRenewDate {
2858 my ( $borrowernumber, $itemnumber ) = @_;
2860 my $dbh = C4::Context->dbh;
2862 my $item = GetItem($itemnumber) or return;
2863 my $itemissue = GetItemIssue($itemnumber) or return;
2865 $borrowernumber ||= $itemissue->{borrowernumber};
2866 my $borrower = C4::Members::GetMemberDetails($borrowernumber)
2869 my $branchcode = _GetCircControlBranch( $item, $borrower );
2871 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2873 my $now = DateTime->now( time_zone => C4::Context->tz() );
2875 if ( $issuingrule->{norenewalbefore} ) {
2876 my $soonestrenewal =
2877 $itemissue->{date_due}->subtract(
2878 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore} );
2880 $soonestrenewal = $now > $soonestrenewal ? $now : $soonestrenewal;
2881 return $soonestrenewal;
2886 =head2 GetIssuingCharges
2888 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2890 Calculate how much it would cost for a given patron to borrow a given
2891 item, including any applicable discounts.
2893 C<$itemnumber> is the item number of item the patron wishes to borrow.
2895 C<$borrowernumber> is the patron's borrower number.
2897 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2898 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2903 sub GetIssuingCharges {
2905 # calculate charges due
2906 my ( $itemnumber, $borrowernumber ) = @_;
2908 my $dbh = C4::Context->dbh;
2911 # Get the book's item type and rental charge (via its biblioitem).
2912 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2913 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2914 $charge_query .= (C4::Context->preference('item-level_itypes'))
2915 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2916 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2918 $charge_query .= ' WHERE items.itemnumber =?';
2920 my $sth = $dbh->prepare($charge_query);
2921 $sth->execute($itemnumber);
2922 if ( my $item_data = $sth->fetchrow_hashref ) {
2923 $item_type = $item_data->{itemtype};
2924 $charge = $item_data->{rentalcharge};
2925 my $branch = C4::Branch::mybranch();
2926 my $discount_query = q|SELECT rentaldiscount,
2927 issuingrules.itemtype, issuingrules.branchcode
2929 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2930 WHERE borrowers.borrowernumber = ?
2931 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2932 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2933 my $discount_sth = $dbh->prepare($discount_query);
2934 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2935 my $discount_rules = $discount_sth->fetchall_arrayref({});
2936 if (@{$discount_rules}) {
2937 # We may have multiple rules so get the most specific
2938 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2939 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2943 return ( $charge, $item_type );
2946 # Select most appropriate discount rule from those returned
2947 sub _get_discount_from_rule {
2948 my ($rules_ref, $branch, $itemtype) = @_;
2951 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2952 $discount = $rules_ref->[0]->{rentaldiscount};
2953 return (defined $discount) ? $discount : 0;
2955 # could have up to 4 does one match $branch and $itemtype
2956 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2958 $discount = $d[0]->{rentaldiscount};
2959 return (defined $discount) ? $discount : 0;
2961 # do we have item type + all branches
2962 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2964 $discount = $d[0]->{rentaldiscount};
2965 return (defined $discount) ? $discount : 0;
2967 # do we all item types + this branch
2968 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2970 $discount = $d[0]->{rentaldiscount};
2971 return (defined $discount) ? $discount : 0;
2973 # so all and all (surely we wont get here)
2974 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2976 $discount = $d[0]->{rentaldiscount};
2977 return (defined $discount) ? $discount : 0;
2983 =head2 AddIssuingCharge
2985 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2989 sub AddIssuingCharge {
2990 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2991 my $dbh = C4::Context->dbh;
2992 my $nextaccntno = getnextacctno( $borrowernumber );
2994 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2996 INSERT INTO accountlines
2997 (borrowernumber, itemnumber, accountno,
2998 date, amount, description, accounttype,
2999 amountoutstanding, manager_id)
3000 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3002 my $sth = $dbh->prepare($query);
3003 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3008 GetTransfers($itemnumber);
3013 my ($itemnumber) = @_;
3015 my $dbh = C4::Context->dbh;
3021 FROM branchtransfers
3022 WHERE itemnumber = ?
3023 AND datearrived IS NULL
3025 my $sth = $dbh->prepare($query);
3026 $sth->execute($itemnumber);
3027 my @row = $sth->fetchrow_array();
3031 =head2 GetTransfersFromTo
3033 @results = GetTransfersFromTo($frombranch,$tobranch);
3035 Returns the list of pending transfers between $from and $to branch
3039 sub GetTransfersFromTo {
3040 my ( $frombranch, $tobranch ) = @_;
3041 return unless ( $frombranch && $tobranch );
3042 my $dbh = C4::Context->dbh;
3044 SELECT itemnumber,datesent,frombranch
3045 FROM branchtransfers
3048 AND datearrived IS NULL
3050 my $sth = $dbh->prepare($query);
3051 $sth->execute( $frombranch, $tobranch );
3054 while ( my $data = $sth->fetchrow_hashref ) {
3055 push @gettransfers, $data;
3057 return (@gettransfers);
3060 =head2 DeleteTransfer
3062 &DeleteTransfer($itemnumber);
3066 sub DeleteTransfer {
3067 my ($itemnumber) = @_;
3068 return unless $itemnumber;
3069 my $dbh = C4::Context->dbh;
3070 my $sth = $dbh->prepare(
3071 "DELETE FROM branchtransfers
3073 AND datearrived IS NULL "
3075 return $sth->execute($itemnumber);
3078 =head2 AnonymiseIssueHistory
3080 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
3082 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
3083 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
3085 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
3086 setting (force delete).
3088 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
3092 sub AnonymiseIssueHistory {
3094 my $borrowernumber = shift;
3095 my $dbh = C4::Context->dbh;
3098 SET borrowernumber = ?
3099 WHERE returndate < ?
3100 AND borrowernumber IS NOT NULL
3103 # The default of 0 does not work due to foreign key constraints
3104 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
3105 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
3106 my @bind_params = ($anonymouspatron, $date);
3107 if (defined $borrowernumber) {
3108 $query .= " AND borrowernumber = ?";
3109 push @bind_params, $borrowernumber;
3111 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
3113 my $sth = $dbh->prepare($query);
3114 $sth->execute(@bind_params);
3115 my $anonymisation_err = $dbh->err;
3116 my $rows_affected = $sth->rows; ### doublecheck row count return function
3117 return ($rows_affected, $anonymisation_err);
3120 =head2 SendCirculationAlert
3122 Send out a C<check-in> or C<checkout> alert using the messaging system.
3130 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3134 Hashref of information about the item being checked in or out.
3138 Hashref of information about the borrower of the item.
3142 The branchcode from where the checkout or check-in took place.
3148 SendCirculationAlert({
3151 borrower => $borrower,
3157 sub SendCirculationAlert {
3159 my ($type, $item, $borrower, $branch) =
3160 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3161 my %message_name = (
3162 CHECKIN => 'Item_Check_in',
3163 CHECKOUT => 'Item_Checkout',
3164 RENEWAL => 'Item_Checkout',
3166 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3167 borrowernumber => $borrower->{borrowernumber},
3168 message_name => $message_name{$type},
3170 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3171 my $letter = C4::Letters::GetPreparedLetter (
3172 module => 'circulation',
3173 letter_code => $type,
3174 branchcode => $branch,
3176 $issues_table => $item->{itemnumber},
3177 'items' => $item->{itemnumber},
3178 'biblio' => $item->{biblionumber},
3179 'biblioitems' => $item->{biblionumber},
3180 'borrowers' => $borrower,
3181 'branches' => $branch,
3185 my @transports = keys %{ $borrower_preferences->{transports} };
3186 # warn "no transports" unless @transports;
3188 # warn "transport: $_";
3189 my $message = C4::Message->find_last_message($borrower, $type, $_);
3191 #warn "create new message";
3192 C4::Message->enqueue($letter, $borrower, $_);
3194 #warn "append to old message";
3195 $message->append($letter);
3203 =head2 updateWrongTransfer
3205 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3207 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
3211 sub updateWrongTransfer {
3212 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3213 my $dbh = C4::Context->dbh;
3214 # first step validate the actual line of transfert .
3217 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3219 $sth->execute($FromLibrary,$itemNumber);
3221 # second step create a new line of branchtransfer to the right location .
3222 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3224 #third step changing holdingbranch of item
3225 UpdateHoldingbranch($FromLibrary,$itemNumber);
3228 =head2 UpdateHoldingbranch
3230 $items = UpdateHoldingbranch($branch,$itmenumber);
3232 Simple methode for updating hodlingbranch in items BDD line
3236 sub UpdateHoldingbranch {
3237 my ( $branch,$itemnumber ) = @_;
3238 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3243 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3245 this function calculates the due date given the start date and configured circulation rules,
3246 checking against the holidays calendar as per the 'useDaysMode' syspref.
3247 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
3248 C<$itemtype> = itemtype code of item in question
3249 C<$branch> = location whose calendar to use
3250 C<$borrower> = Borrower object
3251 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3256 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3260 # loanlength now a href
3262 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3264 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3270 if (ref $startdate ne 'DateTime' ) {
3271 $datedue = dt_from_string($datedue);
3273 $datedue = $startdate->clone;
3277 DateTime->now( time_zone => C4::Context->tz() )
3278 ->truncate( to => 'minute' );
3282 # calculate the datedue as normal
3283 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3284 { # ignoring calendar
3285 if ( $loanlength->{lengthunit} eq 'hours' ) {
3286 $datedue->add( hours => $loanlength->{$length_key} );
3288 $datedue->add( days => $loanlength->{$length_key} );
3289 $datedue->set_hour(23);
3290 $datedue->set_minute(59);
3294 if ($loanlength->{lengthunit} eq 'hours') {
3295 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3298 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3300 my $calendar = Koha::Calendar->new( branchcode => $branch );
3301 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3302 if ($loanlength->{lengthunit} eq 'days') {
3303 $datedue->set_hour(23);
3304 $datedue->set_minute(59);
3308 # if Hard Due Dates are used, retreive them and apply as necessary
3309 my ( $hardduedate, $hardduedatecompare ) =
3310 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3311 if ($hardduedate) { # hardduedates are currently dates
3312 $hardduedate->truncate( to => 'minute' );
3313 $hardduedate->set_hour(23);
3314 $hardduedate->set_minute(59);
3315 my $cmp = DateTime->compare( $hardduedate, $datedue );
3317 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3318 # if the calculated date is before the 'after' Hard Due Date (floor), override
3319 # if the hard due date is set to 'exactly', overrride
3320 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3321 $datedue = $hardduedate->clone;
3324 # in all other cases, keep the date due as it is
3328 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3329 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3330 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
3331 $expiry_dt->set( hour => 23, minute => 59);
3332 if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
3333 $datedue = $expiry_dt->clone;
3341 =head2 CheckRepeatableHolidays
3343 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3345 This function checks if the date due is a repeatable holiday
3347 C<$date_due> = returndate calculate with no day check
3348 C<$itemnumber> = itemnumber
3349 C<$branchcode> = localisation of issue
3353 sub CheckRepeatableHolidays{
3354 my($itemnumber,$week_day,$branchcode)=@_;
3355 my $dbh = C4::Context->dbh;
3356 my $query = qq|SELECT count(*)
3357 FROM repeatable_holidays
3360 my $sth = $dbh->prepare($query);
3361 $sth->execute($branchcode,$week_day);
3362 my $result=$sth->fetchrow;
3367 =head2 CheckSpecialHolidays
3369 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3371 This function check if the date is a special holiday
3373 C<$years> = the years of datedue
3374 C<$month> = the month of datedue
3375 C<$day> = the day of datedue
3376 C<$itemnumber> = itemnumber
3377 C<$branchcode> = localisation of issue
3381 sub CheckSpecialHolidays{
3382 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3383 my $dbh = C4::Context->dbh;
3384 my $query=qq|SELECT count(*)
3385 FROM `special_holidays`
3391 my $sth = $dbh->prepare($query);
3392 $sth->execute($years,$month,$day,$branchcode);
3393 my $countspecial=$sth->fetchrow ;
3394 return $countspecial;
3397 =head2 CheckRepeatableSpecialHolidays
3399 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3401 This function check if the date is a repeatble special holidays
3403 C<$month> = the month of datedue
3404 C<$day> = the day of datedue
3405 C<$itemnumber> = itemnumber
3406 C<$branchcode> = localisation of issue
3410 sub CheckRepeatableSpecialHolidays{
3411 my ($month,$day,$itemnumber,$branchcode) = @_;
3412 my $dbh = C4::Context->dbh;
3413 my $query=qq|SELECT count(*)
3414 FROM `repeatable_holidays`
3419 my $sth = $dbh->prepare($query);
3420 $sth->execute($month,$day,$branchcode);
3421 my $countspecial=$sth->fetchrow ;
3422 return $countspecial;
3427 sub CheckValidBarcode{
3429 my $dbh = C4::Context->dbh;
3430 my $query=qq|SELECT count(*)
3434 my $sth = $dbh->prepare($query);
3435 $sth->execute($barcode);
3436 my $exist=$sth->fetchrow ;
3440 =head2 IsBranchTransferAllowed
3442 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3444 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3448 sub IsBranchTransferAllowed {
3449 my ( $toBranch, $fromBranch, $code ) = @_;
3451 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3453 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3454 my $dbh = C4::Context->dbh;
3456 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3457 $sth->execute( $toBranch, $fromBranch, $code );
3458 my $limit = $sth->fetchrow_hashref();
3460 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3461 if ( $limit->{'limitId'} ) {
3468 =head2 CreateBranchTransferLimit
3470 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3472 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3476 sub CreateBranchTransferLimit {
3477 my ( $toBranch, $fromBranch, $code ) = @_;
3478 return unless defined($toBranch) && defined($fromBranch);
3479 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3481 my $dbh = C4::Context->dbh;
3483 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3484 return $sth->execute( $code, $toBranch, $fromBranch );
3487 =head2 DeleteBranchTransferLimits
3489 my $result = DeleteBranchTransferLimits($frombranch);
3491 Deletes all the library transfer limits for one library. Returns the
3492 number of limits deleted, 0e0 if no limits were deleted, or undef if
3493 no arguments are supplied.
3497 sub DeleteBranchTransferLimits {
3499 return unless defined $branch;
3500 my $dbh = C4::Context->dbh;
3501 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3502 return $sth->execute($branch);
3506 my ( $borrowernumber, $itemnum ) = @_;
3508 MarkIssueReturned( $borrowernumber, $itemnum );
3509 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3510 my $item = C4::Items::GetItem( $itemnum );
3511 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3512 my @datearr = localtime(time);
3513 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3514 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3515 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3520 my ($itemnumber, $mark_returned) = @_;
3522 my $dbh = C4::Context->dbh();
3523 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3525 JOIN items USING (itemnumber)
3526 JOIN biblio USING (biblionumber)
3527 WHERE issues.itemnumber=?");
3528 $sth->execute($itemnumber);
3529 my $issues=$sth->fetchrow_hashref();
3531 # If a borrower lost the item, add a replacement cost to the their record
3532 if ( my $borrowernumber = $issues->{borrowernumber} ){
3533 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3535 if (C4::Context->preference('WhenLostForgiveFine')){
3536 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3537 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3539 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3540 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3541 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3542 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3545 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3549 sub GetOfflineOperations {
3550 my $dbh = C4::Context->dbh;
3551 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3552 $sth->execute(C4::Context->userenv->{'branch'});
3553 my $results = $sth->fetchall_arrayref({});
3557 sub GetOfflineOperation {
3558 my $operationid = shift;
3559 return unless $operationid;
3560 my $dbh = C4::Context->dbh;
3561 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3562 $sth->execute( $operationid );
3563 return $sth->fetchrow_hashref;
3566 sub AddOfflineOperation {
3567 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3568 my $dbh = C4::Context->dbh;
3569 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3570 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3574 sub DeleteOfflineOperation {
3575 my $dbh = C4::Context->dbh;
3576 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3577 $sth->execute( shift );
3581 sub ProcessOfflineOperation {
3582 my $operation = shift;
3585 if ( $operation->{action} eq 'return' ) {
3586 $report = ProcessOfflineReturn( $operation );
3587 } elsif ( $operation->{action} eq 'issue' ) {
3588 $report = ProcessOfflineIssue( $operation );
3589 } elsif ( $operation->{action} eq 'payment' ) {
3590 $report = ProcessOfflinePayment( $operation );
3593 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3598 sub ProcessOfflineReturn {
3599 my $operation = shift;
3601 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3603 if ( $itemnumber ) {
3604 my $issue = GetOpenIssue( $itemnumber );
3607 $issue->{borrowernumber},
3610 $operation->{timestamp},
3613 { renewals => 0, onloan => undef },
3614 $issue->{'biblionumber'},
3619 return "Item not issued.";
3622 return "Item not found.";
3626 sub ProcessOfflineIssue {
3627 my $operation = shift;
3629 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3631 if ( $borrower->{borrowernumber} ) {
3632 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3633 unless ($itemnumber) {
3634 return "Barcode not found.";
3636 my $issue = GetOpenIssue( $itemnumber );
3638 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3640 $issue->{borrowernumber},
3643 $operation->{timestamp},
3648 $operation->{'barcode'},
3651 $operation->{timestamp},
3656 return "Borrower not found.";
3660 sub ProcessOfflinePayment {
3661 my $operation = shift;
3663 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3664 my $amount = $operation->{amount};
3666 recordpayment( $borrower->{borrowernumber}, $amount );
3674 TransferSlip($user_branch, $itemnumber, $to_branch)
3676 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3681 my ($branch, $itemnumber, $to_branch) = @_;
3683 my $item = GetItem( $itemnumber )
3686 my $pulldate = C4::Dates->new();
3688 return C4::Letters::GetPreparedLetter (
3689 module => 'circulation',
3690 letter_code => 'TRANSFERSLIP',
3691 branchcode => $branch,
3693 'branches' => $to_branch,
3694 'biblio' => $item->{biblionumber},
3700 =head2 CheckIfIssuedToPatron
3702 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3704 Return 1 if any record item is issued to patron, otherwise return 0
3708 sub CheckIfIssuedToPatron {
3709 my ($borrowernumber, $biblionumber) = @_;
3711 my $items = GetItemsByBiblioitemnumber($biblionumber);
3713 foreach my $item (@{$items}) {
3714 return 1 if ($item->{borrowernumber} && $item->{borrowernumber} eq $borrowernumber);
3722 IsItemIssued( $itemnumber )
3724 Return 1 if the item is on loan, otherwise return 0
3729 my $itemnumber = shift;
3730 my $dbh = C4::Context->dbh;
3731 my $sth = $dbh->prepare(q{
3734 WHERE itemnumber = ?
3736 $sth->execute($itemnumber);
3737 return $sth->fetchrow;
3740 sub GetAgeRestriction {
3741 my ($record_restrictions) = @_;
3742 my $markers = C4::Context->preference('AgeRestrictionMarker');
3744 # Split $record_restrictions to something like FSK 16 or PEGI 6
3745 my @values = split ' ', uc($record_restrictions);
3746 return unless @values;
3748 # Search first occurence of one of the markers
3749 my @markers = split /\|/, uc($markers);
3750 return unless @markers;
3753 my $restriction_year = 0;
3754 for my $value (@values) {
3756 for my $marker (@markers) {
3757 $marker =~ s/^\s+//; #remove leading spaces
3758 $marker =~ s/\s+$//; #remove trailing spaces
3759 if ( $marker eq $value ) {
3760 if ( $index <= $#values ) {
3761 $restriction_year += $values[$index];
3765 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3767 # Perhaps it is something like "K16" (as in Finland)
3768 $restriction_year += $1;
3772 last if ( $restriction_year > 0 );
3775 return $restriction_year;
3784 Koha Development Team <http://koha-community.org/>