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 or has a restriction. $count is a date
827 if ($count eq '9999-12-31') {
828 $issuingimpossible{USERBLOCKEDNOENDDATE} = $count;
831 $issuingimpossible{USERBLOCKEDWITHENDDATE} = $count;
836 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
838 my ($current_loan_count, $max_loans_allowed) = TooMany( $borrower, $item->{biblionumber}, $item );
839 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
840 if (defined $max_loans_allowed && $max_loans_allowed == 0) {
841 $needsconfirmation{PATRON_CANT} = 1;
843 if($max_loans_allowed){
844 if ( C4::Context->preference("AllowTooManyOverride") ) {
845 $needsconfirmation{TOO_MANY} = 1;
846 $needsconfirmation{current_loan_count} = $current_loan_count;
847 $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
849 $issuingimpossible{TOO_MANY} = 1;
850 $issuingimpossible{current_loan_count} = $current_loan_count;
851 $issuingimpossible{max_loans_allowed} = $max_loans_allowed;
859 if ( $item->{'notforloan'} )
861 if(!C4::Context->preference("AllowNotForLoanOverride")){
862 $issuingimpossible{NOT_FOR_LOAN} = 1;
863 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
865 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
866 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
870 # we have to check itemtypes.notforloan also
871 if (C4::Context->preference('item-level_itypes')){
872 # this should probably be a subroutine
873 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
874 $sth->execute($item->{'itemtype'});
875 my $notforloan=$sth->fetchrow_hashref();
876 if ($notforloan->{'notforloan'}) {
877 if (!C4::Context->preference("AllowNotForLoanOverride")) {
878 $issuingimpossible{NOT_FOR_LOAN} = 1;
879 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
881 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
882 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
886 elsif ($biblioitem->{'notforloan'} == 1){
887 if (!C4::Context->preference("AllowNotForLoanOverride")) {
888 $issuingimpossible{NOT_FOR_LOAN} = 1;
889 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
891 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
892 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
896 if ( $item->{'withdrawn'} && $item->{'withdrawn'} > 0 )
898 $issuingimpossible{WTHDRAWN} = 1;
900 if ( $item->{'restricted'}
901 && $item->{'restricted'} == 1 )
903 $issuingimpossible{RESTRICTED} = 1;
905 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
906 my $code = GetAuthorisedValueByCode( 'LOST', $item->{'itemlost'} );
907 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
908 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
910 if ( C4::Context->preference("IndependentBranches") ) {
911 my $userenv = C4::Context->userenv;
912 unless ( C4::Context->IsSuperLibrarian() ) {
913 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
914 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
915 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
917 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
918 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
923 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
925 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
928 # Already issued to current borrower. Ask whether the loan should
930 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
931 $borrower->{'borrowernumber'},
932 $item->{'itemnumber'}
934 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
935 $issuingimpossible{NO_MORE_RENEWALS} = 1;
938 $needsconfirmation{RENEW_ISSUE} = 1;
941 elsif ($issue->{borrowernumber}) {
943 # issued to someone else
944 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
946 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
947 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
948 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
949 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
950 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
951 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
954 unless ( $ignore_reserves ) {
955 # See if the item is on reserve.
956 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
958 my $resbor = $res->{'borrowernumber'};
959 if ( $resbor ne $borrower->{'borrowernumber'} ) {
960 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
961 my $branchname = GetBranchName( $res->{'branchcode'} );
962 if ( $restype eq "Waiting" )
964 # The item is on reserve and waiting, but has been
965 # reserved by some other patron.
966 $needsconfirmation{RESERVE_WAITING} = 1;
967 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
968 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
969 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
970 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
971 $needsconfirmation{'resbranchname'} = $branchname;
972 $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
974 elsif ( $restype eq "Reserved" ) {
975 # The item is on reserve for someone else.
976 $needsconfirmation{RESERVED} = 1;
977 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
978 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
979 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
980 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
981 $needsconfirmation{'resbranchname'} = $branchname;
982 $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
988 ## CHECK AGE RESTRICTION
989 # get $marker from preferences. Could be something like "FSK|PEGI|Alter|Age:"
990 my $markers = C4::Context->preference('AgeRestrictionMarker');
991 my $bibvalues = $biblioitem->{'agerestriction'};
992 my $restriction_age = GetAgeRestriction( $bibvalues );
994 if ( $restriction_age > 0 ) {
995 if ( $borrower->{'dateofbirth'} ) {
996 my @alloweddate = split /-/, $borrower->{'dateofbirth'};
997 $alloweddate[0] += $restriction_age;
999 #Prevent runime eror on leap year (invalid date)
1000 if ( ( $alloweddate[1] == 2 ) && ( $alloweddate[2] == 29 ) ) {
1001 $alloweddate[2] = 28;
1004 if ( Date_to_Days(Today) < Date_to_Days(@alloweddate) - 1 ) {
1005 if ( C4::Context->preference('AgeRestrictionOverride') ) {
1006 $needsconfirmation{AGE_RESTRICTION} = "$bibvalues";
1009 $issuingimpossible{AGE_RESTRICTION} = "$bibvalues";
1015 ## check for high holds decreasing loan period
1016 my $decrease_loan = C4::Context->preference('decreaseLoanHighHolds');
1017 if ( $decrease_loan && $decrease_loan == 1 ) {
1018 my ( $reserved, $num, $duration, $returndate ) =
1019 checkHighHolds( $item, $borrower );
1021 if ( $num >= C4::Context->preference('decreaseLoanHighHoldsValue') ) {
1022 $needsconfirmation{HIGHHOLDS} = {
1024 duration => $duration,
1025 returndate => output_pref($returndate),
1031 !C4::Context->preference('AllowMultipleIssuesOnABiblio') &&
1032 # don't do the multiple loans per bib check if we've
1033 # already determined that we've got a loan on the same item
1034 !$issuingimpossible{NO_MORE_RENEWALS} &&
1035 !$needsconfirmation{RENEW_ISSUE}
1037 # Check if borrower has already issued an item from the same biblio
1038 # Only if it's not a subscription
1039 my $biblionumber = $item->{biblionumber};
1040 require C4::Serials;
1041 my $is_a_subscription = C4::Serials::CountSubscriptionFromBiblionumber($biblionumber);
1042 unless ($is_a_subscription) {
1043 my $issues = GetIssues( {
1044 borrowernumber => $borrower->{borrowernumber},
1045 biblionumber => $biblionumber,
1047 my @issues = $issues ? @$issues : ();
1048 # if we get here, we don't already have a loan on this item,
1049 # so if there are any loans on this bib, ask for confirmation
1050 if (scalar @issues > 0) {
1051 $needsconfirmation{BIBLIO_ALREADY_ISSUED} = 1;
1056 return ( \%issuingimpossible, \%needsconfirmation, \%alerts );
1059 =head2 CanBookBeReturned
1061 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1063 Check whether the item can be returned to the provided branch
1067 =item C<$item> is a hash of item information as returned from GetItem
1069 =item C<$branch> is the branchcode where the return is taking place
1077 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1079 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1085 sub CanBookBeReturned {
1086 my ($item, $branch) = @_;
1087 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1089 # assume return is allowed to start
1093 # identify all cases where return is forbidden
1094 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1096 $message = $item->{'homebranch'};
1097 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1099 $message = $item->{'holdingbranch'};
1100 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1102 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1105 return ($allowed, $message);
1108 =head2 CheckHighHolds
1110 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1111 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1112 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1116 sub checkHighHolds {
1117 my ( $item, $borrower ) = @_;
1118 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1119 my $branch = _GetCircControlBranch( $item, $borrower );
1120 my $dbh = C4::Context->dbh;
1121 my $sth = $dbh->prepare(
1122 'select count(borrowernumber) as num_holds from reserves where biblionumber=?'
1124 $sth->execute( $item->{'biblionumber'} );
1125 my ($holds) = $sth->fetchrow_array;
1127 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1129 my $calendar = Koha::Calendar->new( branchcode => $branch );
1132 ( C4::Context->preference('item-level_itypes') )
1133 ? $biblio->{'itype'}
1134 : $biblio->{'itemtype'};
1136 C4::Circulation::CalcDateDue( $issuedate, $itype, $branch,
1139 my $reduced_datedue =
1140 $calendar->addDate( $issuedate,
1141 C4::Context->preference('decreaseLoanHighHoldsDuration') );
1143 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1145 C4::Context->preference('decreaseLoanHighHoldsDuration'),
1149 return ( 0, 0, 0, undef );
1154 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1156 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1160 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1162 =item C<$barcode> is the barcode of the item being issued.
1164 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
1165 Calculated if empty.
1167 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1169 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1170 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
1172 AddIssue does the following things :
1174 - step 01: check that there is a borrowernumber & a barcode provided
1175 - check for RENEWAL (book issued & being issued to the same patron)
1176 - renewal YES = Calculate Charge & renew
1178 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1180 - fill reserve if reserve to this patron
1181 - cancel reserve or not, otherwise
1182 * TRANSFERT PENDING ?
1183 - complete the transfert
1191 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode, $params ) = @_;
1192 my $onsite_checkout = $params && $params->{onsite_checkout} ? 1 : 0;
1193 my $auto_renew = $params && $params->{auto_renew};
1194 my $dbh = C4::Context->dbh;
1195 my $barcodecheck=CheckValidBarcode($barcode);
1197 if ($datedue && ref $datedue ne 'DateTime') {
1198 $datedue = dt_from_string($datedue);
1200 # $issuedate defaults to today.
1201 if ( ! defined $issuedate ) {
1202 $issuedate = DateTime->now(time_zone => C4::Context->tz());
1205 if ( ref $issuedate ne 'DateTime') {
1206 $issuedate = dt_from_string($issuedate);
1210 if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1211 # find which item we issue
1212 my $item = GetItem('', $barcode) or return; # if we don't get an Item, abort.
1213 my $branch = _GetCircControlBranch($item,$borrower);
1215 # get actual issuing if there is one
1216 my $actualissue = GetItemIssue( $item->{itemnumber});
1218 # get biblioinformation for this item
1219 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
1222 # check if we just renew the issue.
1224 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
1225 $datedue = AddRenewal(
1226 $borrower->{'borrowernumber'},
1227 $item->{'itemnumber'},
1230 $issuedate, # here interpreted as the renewal date
1234 # it's NOT a renewal
1235 if ( $actualissue->{borrowernumber}) {
1236 # This book is currently on loan, but not to the person
1237 # who wants to borrow it now. mark it returned before issuing to the new borrower
1240 C4::Context->userenv->{'branch'}
1244 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1245 # Starting process for transfer job (checking transfert and validate it if we have one)
1246 my ($datesent) = GetTransfers($item->{'itemnumber'});
1248 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1251 "UPDATE branchtransfers
1252 SET datearrived = now(),
1254 comments = 'Forced branchtransfer'
1255 WHERE itemnumber= ? AND datearrived IS NULL"
1257 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1260 # If automatic renewal wasn't selected while issuing, set the value according to the issuing rule.
1261 unless ($auto_renew) {
1262 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branch);
1263 $auto_renew = $issuingrule->{auto_renew};
1266 # Record in the database the fact that the book was issued.
1270 (borrowernumber, itemnumber,issuedate, date_due, branchcode, onsite_checkout, auto_renew)
1271 VALUES (?,?,?,?,?,?,?)"
1274 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1275 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1278 $datedue->truncate( to => 'minute');
1281 $borrower->{'borrowernumber'}, # borrowernumber
1282 $item->{'itemnumber'}, # itemnumber
1283 $issuedate->strftime('%Y-%m-%d %H:%M:00'), # issuedate
1284 $datedue->strftime('%Y-%m-%d %H:%M:00'), # date_due
1285 C4::Context->userenv->{'branch'}, # branchcode
1287 $auto_renew ? 1 : 0 # automatic renewal
1289 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1290 CartToShelf( $item->{'itemnumber'} );
1292 $item->{'issues'}++;
1293 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1294 UpdateTotalIssues($item->{'biblionumber'}, 1);
1297 ## If item was lost, it has now been found, reverse any list item charges if neccessary.
1298 if ( $item->{'itemlost'} ) {
1299 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1300 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1304 ModItem({ issues => $item->{'issues'},
1305 holdingbranch => C4::Context->userenv->{'branch'},
1307 datelastborrowed => DateTime->now(time_zone => C4::Context->tz())->ymd(),
1308 onloan => $datedue->ymd(),
1309 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1310 ModDateLastSeen( $item->{'itemnumber'} );
1312 # If it costs to borrow this book, charge it to the patron's account.
1313 my ( $charge, $itemtype ) = GetIssuingCharges(
1314 $item->{'itemnumber'},
1315 $borrower->{'borrowernumber'}
1317 if ( $charge > 0 ) {
1319 $item->{'itemnumber'},
1320 $borrower->{'borrowernumber'}, $charge
1322 $item->{'charge'} = $charge;
1325 # Record the fact that this book was issued.
1327 branch => C4::Context->userenv->{'branch'},
1328 type => ( $onsite_checkout ? 'onsite_checkout' : 'issue' ),
1330 other => ($sipmode ? "SIP-$sipmode" : ''),
1331 itemnumber => $item->{'itemnumber'},
1332 itemtype => $item->{'itype'},
1333 borrowernumber => $borrower->{'borrowernumber'},
1334 ccode => $item->{'ccode'}}
1337 # Send a checkout slip.
1338 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1340 branchcode => $branch,
1341 categorycode => $borrower->{categorycode},
1342 item_type => $item->{itype},
1343 notification => 'CHECKOUT',
1345 if ($circulation_alert->is_enabled_for(\%conditions)) {
1346 SendCirculationAlert({
1349 borrower => $borrower,
1355 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'itemnumber'})
1356 if C4::Context->preference("IssueLog");
1358 return ($datedue); # not necessarily the same as when it came in!
1361 =head2 GetLoanLength
1363 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1365 Get loan length for an itemtype, a borrower type and a branch
1370 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1371 my $dbh = C4::Context->dbh;
1372 my $sth = $dbh->prepare(qq{
1373 SELECT issuelength, lengthunit, renewalperiod
1375 WHERE categorycode=?
1378 AND issuelength IS NOT NULL
1381 # try to find issuelength & return the 1st available.
1382 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1383 $sth->execute( $borrowertype, $itemtype, $branchcode );
1384 my $loanlength = $sth->fetchrow_hashref;
1387 if defined($loanlength) && $loanlength->{issuelength};
1389 $sth->execute( $borrowertype, '*', $branchcode );
1390 $loanlength = $sth->fetchrow_hashref;
1392 if defined($loanlength) && $loanlength->{issuelength};
1394 $sth->execute( '*', $itemtype, $branchcode );
1395 $loanlength = $sth->fetchrow_hashref;
1397 if defined($loanlength) && $loanlength->{issuelength};
1399 $sth->execute( '*', '*', $branchcode );
1400 $loanlength = $sth->fetchrow_hashref;
1402 if defined($loanlength) && $loanlength->{issuelength};
1404 $sth->execute( $borrowertype, $itemtype, '*' );
1405 $loanlength = $sth->fetchrow_hashref;
1407 if defined($loanlength) && $loanlength->{issuelength};
1409 $sth->execute( $borrowertype, '*', '*' );
1410 $loanlength = $sth->fetchrow_hashref;
1412 if defined($loanlength) && $loanlength->{issuelength};
1414 $sth->execute( '*', $itemtype, '*' );
1415 $loanlength = $sth->fetchrow_hashref;
1417 if defined($loanlength) && $loanlength->{issuelength};
1419 $sth->execute( '*', '*', '*' );
1420 $loanlength = $sth->fetchrow_hashref;
1422 if defined($loanlength) && $loanlength->{issuelength};
1424 # if no rule is set => 21 days (hardcoded)
1427 renewalperiod => 21,
1428 lengthunit => 'days',
1434 =head2 GetHardDueDate
1436 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1438 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1442 sub GetHardDueDate {
1443 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1445 my $rule = GetIssuingRule( $borrowertype, $itemtype, $branchcode );
1447 if ( defined( $rule ) ) {
1448 if ( $rule->{hardduedate} ) {
1449 return (dt_from_string($rule->{hardduedate}, 'iso'),$rule->{hardduedatecompare});
1451 return (undef, undef);
1456 =head2 GetIssuingRule
1458 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1460 FIXME - This is a copy-paste of GetLoanLength
1461 as a stop-gap. Do not wish to change API for GetLoanLength
1462 this close to release.
1464 Get the issuing rule for an itemtype, a borrower type and a branch
1465 Returns a hashref from the issuingrules table.
1469 sub GetIssuingRule {
1470 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1471 my $dbh = C4::Context->dbh;
1472 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1475 $sth->execute( $borrowertype, $itemtype, $branchcode );
1476 $irule = $sth->fetchrow_hashref;
1477 return $irule if defined($irule) ;
1479 $sth->execute( $borrowertype, "*", $branchcode );
1480 $irule = $sth->fetchrow_hashref;
1481 return $irule if defined($irule) ;
1483 $sth->execute( "*", $itemtype, $branchcode );
1484 $irule = $sth->fetchrow_hashref;
1485 return $irule if defined($irule) ;
1487 $sth->execute( "*", "*", $branchcode );
1488 $irule = $sth->fetchrow_hashref;
1489 return $irule if defined($irule) ;
1491 $sth->execute( $borrowertype, $itemtype, "*" );
1492 $irule = $sth->fetchrow_hashref;
1493 return $irule if defined($irule) ;
1495 $sth->execute( $borrowertype, "*", "*" );
1496 $irule = $sth->fetchrow_hashref;
1497 return $irule if defined($irule) ;
1499 $sth->execute( "*", $itemtype, "*" );
1500 $irule = $sth->fetchrow_hashref;
1501 return $irule if defined($irule) ;
1503 $sth->execute( "*", "*", "*" );
1504 $irule = $sth->fetchrow_hashref;
1505 return $irule if defined($irule) ;
1507 # if no rule matches,
1511 =head2 GetBranchBorrowerCircRule
1513 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1515 Retrieves circulation rule attributes that apply to the given
1516 branch and patron category, regardless of item type.
1517 The return value is a hashref containing the following key:
1519 maxissueqty - maximum number of loans that a
1520 patron of the given category can have at the given
1521 branch. If the value is undef, no limit.
1523 This will first check for a specific branch and
1524 category match from branch_borrower_circ_rules.
1526 If no rule is found, it will then check default_branch_circ_rules
1527 (same branch, default category). If no rule is found,
1528 it will then check default_borrower_circ_rules (default
1529 branch, same category), then failing that, default_circ_rules
1530 (default branch, default category).
1532 If no rule has been found in the database, it will default to
1537 C<$branchcode> and C<$categorycode> should contain the
1538 literal branch code and patron category code, respectively - no
1543 sub GetBranchBorrowerCircRule {
1544 my $branchcode = shift;
1545 my $categorycode = shift;
1547 my $branch_cat_query = "SELECT maxissueqty
1548 FROM branch_borrower_circ_rules
1549 WHERE branchcode = ?
1550 AND categorycode = ?";
1551 my $dbh = C4::Context->dbh();
1552 my $sth = $dbh->prepare($branch_cat_query);
1553 $sth->execute($branchcode, $categorycode);
1555 if ($result = $sth->fetchrow_hashref()) {
1559 # try same branch, default borrower category
1560 my $branch_query = "SELECT maxissueqty
1561 FROM default_branch_circ_rules
1562 WHERE branchcode = ?";
1563 $sth = $dbh->prepare($branch_query);
1564 $sth->execute($branchcode);
1565 if ($result = $sth->fetchrow_hashref()) {
1569 # try default branch, same borrower category
1570 my $category_query = "SELECT maxissueqty
1571 FROM default_borrower_circ_rules
1572 WHERE categorycode = ?";
1573 $sth = $dbh->prepare($category_query);
1574 $sth->execute($categorycode);
1575 if ($result = $sth->fetchrow_hashref()) {
1579 # try default branch, default borrower category
1580 my $default_query = "SELECT maxissueqty
1581 FROM default_circ_rules";
1582 $sth = $dbh->prepare($default_query);
1584 if ($result = $sth->fetchrow_hashref()) {
1588 # built-in default circulation rule
1590 maxissueqty => undef,
1594 =head2 GetBranchItemRule
1596 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1598 Retrieves circulation rule attributes that apply to the given
1599 branch and item type, regardless of patron category.
1601 The return value is a hashref containing the following keys:
1603 holdallowed => Hold policy for this branch and itemtype. Possible values:
1604 0: No holds allowed.
1605 1: Holds allowed only by patrons that have the same homebranch as the item.
1606 2: Holds allowed from any patron.
1608 returnbranch => branch to which to return item. Possible values:
1609 noreturn: do not return, let item remain where checked in (floating collections)
1610 homebranch: return to item's home branch
1612 This searches branchitemrules in the following order:
1614 * Same branchcode and itemtype
1615 * Same branchcode, itemtype '*'
1616 * branchcode '*', same itemtype
1617 * branchcode and itemtype '*'
1619 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1623 sub GetBranchItemRule {
1624 my ( $branchcode, $itemtype ) = @_;
1625 my $dbh = C4::Context->dbh();
1629 ['SELECT holdallowed, returnbranch
1630 FROM branch_item_rules
1631 WHERE branchcode = ?
1632 AND itemtype = ?', $branchcode, $itemtype],
1633 ['SELECT holdallowed, returnbranch
1634 FROM default_branch_circ_rules
1635 WHERE branchcode = ?', $branchcode],
1636 ['SELECT holdallowed, returnbranch
1637 FROM default_branch_item_rules
1638 WHERE itemtype = ?', $itemtype],
1639 ['SELECT holdallowed, returnbranch
1640 FROM default_circ_rules'],
1643 foreach my $attempt (@attempts) {
1644 my ($query, @bind_params) = @{$attempt};
1645 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1648 # Since branch/category and branch/itemtype use the same per-branch
1649 # defaults tables, we have to check that the key we want is set, not
1650 # just that a row was returned
1651 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1652 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1655 # built-in default circulation rule
1656 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1657 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1664 ($doreturn, $messages, $iteminformation, $borrower) =
1665 &AddReturn( $barcode, $branch [,$exemptfine] [,$dropbox] [,$returndate] );
1671 =item C<$barcode> is the bar code of the book being returned.
1673 =item C<$branch> is the code of the branch where the book is being returned.
1675 =item C<$exemptfine> indicates that overdue charges for the item will be
1678 =item C<$dropbox> indicates that the check-in date is assumed to be
1679 yesterday, or the last non-holiday as defined in C4::Calendar . If
1680 overdue charges are applied and C<$dropbox> is true, the last charge
1681 will be removed. This assumes that the fines accrual script has run
1682 for _today_. Optional.
1684 =item C<$return_date> allows the default return date to be overridden
1685 by the given return date. Optional.
1689 C<&AddReturn> returns a list of four items:
1691 C<$doreturn> is true iff the return succeeded.
1693 C<$messages> is a reference-to-hash giving feedback on the operation.
1694 The keys of the hash are:
1700 No item with this barcode exists. The value is C<$barcode>.
1704 The book is not currently on loan. The value is C<$barcode>.
1706 =item C<IsPermanent>
1708 The book's home branch is a permanent collection. If you have borrowed
1709 this book, you are not allowed to return it. The value is the code for
1710 the book's home branch.
1714 This book has been withdrawn/cancelled. The value should be ignored.
1716 =item C<Wrongbranch>
1718 This book has was returned to the wrong branch. The value is a hashref
1719 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1720 contain the branchcode of the incorrect and correct return library, respectively.
1724 The item was reserved. The value is a reference-to-hash whose keys are
1725 fields from the reserves table of the Koha database, and
1726 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1727 either C<Waiting>, C<Reserved>, or 0.
1731 C<$iteminformation> is a reference-to-hash, giving information about the
1732 returned item from the issues table.
1734 C<$borrower> is a reference-to-hash, giving information about the
1735 patron who last borrowed the book.
1740 my ( $barcode, $branch, $exemptfine, $dropbox, $return_date ) = @_;
1742 if ($branch and not GetBranchDetail($branch)) {
1743 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1746 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1751 my $validTransfert = 0;
1752 my $stat_type = 'return';
1754 # get information on item
1755 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1756 unless ($itemnumber) {
1757 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1759 my $issue = GetItemIssue($itemnumber);
1760 # warn Dumper($iteminformation);
1761 if ($issue and $issue->{borrowernumber}) {
1762 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1763 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1764 . Dumper($issue) . "\n";
1766 $messages->{'NotIssued'} = $barcode;
1767 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1769 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1770 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1771 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1772 $messages->{'LocalUse'} = 1;
1773 $stat_type = 'localuse';
1777 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1778 # full item data, but no borrowernumber or checkout info (no issue)
1779 # we know GetItem should work because GetItemnumberFromBarcode worked
1780 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1781 # get the proper branch to which to return the item
1782 $hbr = $item->{$hbr} || $branch ;
1783 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1785 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1787 my $yaml = C4::Context->preference('UpdateNotForLoanStatusOnCheckin');
1789 $yaml = "$yaml\n\n"; # YAML is anal on ending \n. Surplus does not hurt
1791 eval { $rules = YAML::Load($yaml); };
1793 warn "Unable to parse UpdateNotForLoanStatusOnCheckin syspref : $@";
1796 foreach my $key ( keys %$rules ) {
1797 if ( $item->{notforloan} eq $key ) {
1798 $messages->{'NotForLoanStatusUpdated'} = { from => $item->{notforloan}, to => $rules->{$key} };
1799 ModItem( { notforloan => $rules->{$key} }, undef, $itemnumber );
1807 # check if the book is in a permanent collection....
1808 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1810 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1811 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1814 # check if the return is allowed at this branch
1815 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1816 unless ($returnallowed){
1817 $messages->{'Wrongbranch'} = {
1818 Wrongbranch => $branch,
1819 Rightbranch => $message
1822 return ( $doreturn, $messages, $issue, $borrower );
1825 if ( $item->{'withdrawn'} ) { # book has been cancelled
1826 $messages->{'withdrawn'} = 1;
1827 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1830 # case of a return of document (deal with issues and holdingbranch)
1831 my $today = DateTime->now( time_zone => C4::Context->tz() );
1834 my $datedue = $issue->{date_due};
1835 $borrower or warn "AddReturn without current borrower";
1836 my $circControlBranch;
1838 # define circControlBranch only if dropbox mode is set
1839 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1840 # FIXME: check issuedate > returndate, factoring in holidays
1841 #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1842 $circControlBranch = _GetCircControlBranch($item,$borrower);
1843 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $today ) == -1 ? 1 : 0;
1846 if ($borrowernumber) {
1847 if ( ( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'} ) || $return_date ) {
1848 # we only need to calculate and change the fines if we want to do that on return
1849 # Should be on for hourly loans
1850 my $control = C4::Context->preference('CircControl');
1851 my $control_branchcode =
1852 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
1853 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
1854 : $issue->{branchcode};
1857 $return_date ? dt_from_string($return_date) : $today;
1859 my ( $amount, $type, $unitcounttotal ) =
1860 C4::Overdues::CalcFine( $item, $borrower->{categorycode},
1861 $control_branchcode, $datedue, $date_returned );
1865 if ( C4::Context->preference('finesMode') eq 'production' ) {
1866 if ( $amount > 0 ) {
1867 C4::Overdues::UpdateFine( $issue->{itemnumber},
1868 $issue->{borrowernumber},
1869 $amount, $type, output_pref($datedue) );
1871 elsif ($return_date) {
1873 # Backdated returns may have fines that shouldn't exist,
1874 # so in this case, we need to drop those fines to 0
1876 C4::Overdues::UpdateFine( $issue->{itemnumber},
1877 $issue->{borrowernumber},
1878 0, $type, output_pref($datedue) );
1883 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1884 $circControlBranch, $return_date, $borrower->{'privacy'} );
1886 # FIXME is the "= 1" right? This could be the borrower hash.
1887 $messages->{'WasReturned'} = 1;
1891 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1894 # the holdingbranch is updated if the document is returned to another location.
1895 # this is always done regardless of whether the item was on loan or not
1896 if ($item->{'holdingbranch'} ne $branch) {
1897 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1898 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1900 ModDateLastSeen( $item->{'itemnumber'} );
1902 # check if we have a transfer for this document
1903 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1905 # if we have a transfer to do, we update the line of transfers with the datearrived
1907 if ( $tobranch eq $branch ) {
1908 my $sth = C4::Context->dbh->prepare(
1909 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1911 $sth->execute( $item->{'itemnumber'} );
1912 # if we have a reservation with valid transfer, we can set it's status to 'W'
1913 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1914 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1916 $messages->{'WrongTransfer'} = $tobranch;
1917 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1919 $validTransfert = 1;
1921 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1924 # fix up the accounts.....
1925 if ( $item->{'itemlost'} ) {
1926 $messages->{'WasLost'} = 1;
1928 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1929 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1930 $messages->{'LostItemFeeRefunded'} = 1;
1934 # fix up the overdues in accounts...
1935 if ($borrowernumber) {
1936 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1937 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1939 if ( $issue->{overdue} && $issue->{date_due} ) {
1941 my ($debardate,$reminder) = _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1943 $messages->{'PrevDebarred'} = $debardate;
1945 $messages->{'Debarred'} = $debardate if $debardate;
1947 # there's no overdue on the item but borrower had been previously debarred
1948 } elsif ( $issue->{date_due} and $borrower->{'debarred'} ) {
1949 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
1950 $borrower_debar_dt->truncate(to => 'day');
1951 my $today_dt = $today->clone()->truncate(to => 'day');
1952 if ( DateTime->compare( $borrower_debar_dt, $today_dt ) != -1 ) {
1953 $messages->{'PrevDebarred'} = $borrower->{'debarred'};
1958 # find reserves.....
1959 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1960 my ($resfound, $resrec);
1961 my $lookahead= C4::Context->preference('ConfirmFutureHolds'); #number of days to look for future holds
1962 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'}, undef, $lookahead ) unless ( $item->{'withdrawn'} );
1964 $resrec->{'ResFound'} = $resfound;
1965 $messages->{'ResFound'} = $resrec;
1968 # Record the fact that this book was returned.
1969 # FIXME itemtype should record item level type, not bibliolevel type
1973 itemnumber => $item->{'itemnumber'},
1974 itemtype => $biblio->{'itemtype'},
1975 borrowernumber => $borrowernumber,
1976 ccode => $item->{'ccode'}}
1979 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1980 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1982 branchcode => $branch,
1983 categorycode => $borrower->{categorycode},
1984 item_type => $item->{itype},
1985 notification => 'CHECKIN',
1987 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1988 SendCirculationAlert({
1991 borrower => $borrower,
1996 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
1997 if C4::Context->preference("ReturnLog");
1999 # Remove any OVERDUES related debarment if the borrower has no overdues
2000 if ( $borrowernumber
2001 && $borrower->{'debarred'}
2002 && C4::Context->preference('AutoRemoveOverduesRestrictions')
2003 && !HasOverdues( $borrowernumber )
2004 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2006 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2009 # FIXME: make this comment intelligible.
2010 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
2011 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
2013 if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
2014 if ( C4::Context->preference("AutomaticItemReturn" ) or
2015 (C4::Context->preference("UseBranchTransferLimits") and
2016 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
2018 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
2019 $debug and warn "item: " . Dumper($item);
2020 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
2021 $messages->{'WasTransfered'} = 1;
2023 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
2026 return ( $doreturn, $messages, $issue, $borrower );
2029 =head2 MarkIssueReturned
2031 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
2033 Unconditionally marks an issue as being returned by
2034 moving the C<issues> row to C<old_issues> and
2035 setting C<returndate> to the current date, or
2036 the last non-holiday date of the branccode specified in
2037 C<dropbox_branch> . Assumes you've already checked that
2038 it's safe to do this, i.e. last non-holiday > issuedate.
2040 if C<$returndate> is specified (in iso format), it is used as the date
2041 of the return. It is ignored when a dropbox_branch is passed in.
2043 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
2044 the old_issue is immediately anonymised
2046 Ideally, this function would be internal to C<C4::Circulation>,
2047 not exported, but it is currently needed by one
2048 routine in C<C4::Accounts>.
2052 sub MarkIssueReturned {
2053 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
2055 my $dbh = C4::Context->dbh;
2056 my $query = 'UPDATE issues SET returndate=';
2058 if ($dropbox_branch) {
2059 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
2060 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
2062 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
2063 } elsif ($returndate) {
2065 push @bind, $returndate;
2067 $query .= ' now() ';
2069 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
2070 push @bind, $borrowernumber, $itemnumber;
2072 my $sth_upd = $dbh->prepare($query);
2073 $sth_upd->execute(@bind);
2074 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
2075 WHERE borrowernumber = ?
2076 AND itemnumber = ?');
2077 $sth_copy->execute($borrowernumber, $itemnumber);
2078 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
2079 if ( $privacy == 2) {
2080 # The default of 0 does not work due to foreign key constraints
2081 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2082 # FIXME the above is unacceptable - bug 9942 relates
2083 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2084 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
2085 WHERE borrowernumber = ?
2086 AND itemnumber = ?");
2087 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2089 my $sth_del = $dbh->prepare("DELETE FROM issues
2090 WHERE borrowernumber = ?
2091 AND itemnumber = ?");
2092 $sth_del->execute($borrowernumber, $itemnumber);
2094 ModItem( { 'onloan' => undef }, undef, $itemnumber );
2097 =head2 _debar_user_on_return
2099 _debar_user_on_return($borrower, $item, $datedue, today);
2101 C<$borrower> borrower hashref
2103 C<$item> item hashref
2105 C<$datedue> date due DateTime object
2107 C<$today> DateTime object representing the return time
2109 Internal function, called only by AddReturn that calculates and updates
2110 the user fine days, and debars him if necessary.
2112 Should only be called for overdue returns
2116 sub _debar_user_on_return {
2117 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2119 my $branchcode = _GetCircControlBranch( $item, $borrower );
2120 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
2122 # $deltadays is a DateTime::Duration object
2123 my $deltadays = $calendar->days_between( $dt_due, $dt_today );
2125 my $circcontrol = C4::Context->preference('CircControl');
2127 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2128 my $finedays = $issuingrule->{finedays};
2129 my $unit = $issuingrule->{lengthunit};
2133 # finedays is in days, so hourly loans must multiply by 24
2134 # thus 1 hour late equals 1 day suspension * finedays rate
2135 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2137 # grace period is measured in the same units as the loan
2139 DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2141 if ( $deltadays->subtract($grace)->is_positive() ) {
2142 my $suspension_days = $deltadays * $finedays;
2144 # If the max suspension days is < than the suspension days
2145 # the suspension days is limited to this maximum period.
2146 my $max_sd = $issuingrule->{maxsuspensiondays};
2147 if ( defined $max_sd ) {
2148 $max_sd = DateTime::Duration->new( days => $max_sd );
2149 $suspension_days = $max_sd
2150 if DateTime::Duration->compare( $max_sd, $suspension_days ) < 0;
2154 $dt_today->clone()->add_duration( $suspension_days );
2156 Koha::Borrower::Debarments::AddUniqueDebarment({
2157 borrowernumber => $borrower->{borrowernumber},
2158 expiration => $new_debar_dt->ymd(),
2159 type => 'SUSPENSION',
2161 # if borrower was already debarred but does not get an extra debarment
2162 if ( $borrower->{debarred} eq Koha::Borrower::Debarments::IsDebarred($borrower->{borrowernumber}) ) {
2163 return ($borrower->{debarred},1);
2165 return $new_debar_dt->ymd();
2171 =head2 _FixOverduesOnReturn
2173 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2175 C<$brn> borrowernumber
2179 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2180 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2182 Internal function, called only by AddReturn
2186 sub _FixOverduesOnReturn {
2187 my ($borrowernumber, $item);
2188 unless ($borrowernumber = shift) {
2189 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2192 unless ($item = shift) {
2193 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2196 my ($exemptfine, $dropbox) = @_;
2197 my $dbh = C4::Context->dbh;
2199 # check for overdue fine
2200 my $sth = $dbh->prepare(
2201 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2203 $sth->execute( $borrowernumber, $item );
2205 # alter fine to show that the book has been returned
2206 my $data = $sth->fetchrow_hashref;
2207 return 0 unless $data; # no warning, there's just nothing to fix
2210 my @bind = ($data->{'accountlines_id'});
2212 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2213 if (C4::Context->preference("FinesLog")) {
2214 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2216 } elsif ($dropbox && $data->{lastincrement}) {
2217 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2218 my $amt = $data->{amount} - $data->{lastincrement} ;
2219 if (C4::Context->preference("FinesLog")) {
2220 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2222 $uquery = "update accountlines set accounttype='F' ";
2223 if($outstanding >= 0 && $amt >=0) {
2224 $uquery .= ", amount = ? , amountoutstanding=? ";
2225 unshift @bind, ($amt, $outstanding) ;
2228 $uquery = "update accountlines set accounttype='F' ";
2230 $uquery .= " where (accountlines_id = ?)";
2231 my $usth = $dbh->prepare($uquery);
2232 return $usth->execute(@bind);
2235 =head2 _FixAccountForLostAndReturned
2237 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2239 Calculates the charge for a book lost and returned.
2241 Internal function, not exported, called only by AddReturn.
2243 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2244 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2248 sub _FixAccountForLostAndReturned {
2249 my $itemnumber = shift or return;
2250 my $borrowernumber = @_ ? shift : undef;
2251 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2252 my $dbh = C4::Context->dbh;
2253 # check for charge made for lost book
2254 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2255 $sth->execute($itemnumber);
2256 my $data = $sth->fetchrow_hashref;
2257 $data or return; # bail if there is nothing to do
2258 $data->{accounttype} eq 'W' and return; # Written off
2260 # writeoff this amount
2262 my $amount = $data->{'amount'};
2263 my $acctno = $data->{'accountno'};
2264 my $amountleft; # Starts off undef/zero.
2265 if ($data->{'amountoutstanding'} == $amount) {
2266 $offset = $data->{'amount'};
2267 $amountleft = 0; # Hey, it's zero here, too.
2269 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2270 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2272 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2273 WHERE (accountlines_id = ?)");
2274 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2275 #check if any credit is left if so writeoff other accounts
2276 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2277 $amountleft *= -1 if ($amountleft < 0);
2278 if ($amountleft > 0) {
2279 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2280 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2281 $msth->execute($data->{'borrowernumber'});
2282 # offset transactions
2285 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2286 if ($accdata->{'amountoutstanding'} < $amountleft) {
2288 $amountleft -= $accdata->{'amountoutstanding'};
2290 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2293 my $thisacct = $accdata->{'accountlines_id'};
2294 # FIXME: move prepares outside while loop!
2295 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2296 WHERE (accountlines_id = ?)");
2297 $usth->execute($newamtos,$thisacct);
2298 $usth = $dbh->prepare("INSERT INTO accountoffsets
2299 (borrowernumber, accountno, offsetaccount, offsetamount)
2302 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2305 $amountleft *= -1 if ($amountleft > 0);
2306 my $desc = "Item Returned " . $item_id;
2307 $usth = $dbh->prepare("INSERT INTO accountlines
2308 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2309 VALUES (?,?,now(),?,?,'CR',?)");
2310 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2311 if ($borrowernumber) {
2312 # FIXME: same as query above. use 1 sth for both
2313 $usth = $dbh->prepare("INSERT INTO accountoffsets
2314 (borrowernumber, accountno, offsetaccount, offsetamount)
2316 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2318 ModItem({ paidfor => '' }, undef, $itemnumber);
2322 =head2 _GetCircControlBranch
2324 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2328 Return the library code to be used to determine which circulation
2329 policy applies to a transaction. Looks up the CircControl and
2330 HomeOrHoldingBranch system preferences.
2332 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2334 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2338 sub _GetCircControlBranch {
2339 my ($item, $borrower) = @_;
2340 my $circcontrol = C4::Context->preference('CircControl');
2343 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2344 $branch= C4::Context->userenv->{'branch'};
2345 } elsif ($circcontrol eq 'PatronLibrary') {
2346 $branch=$borrower->{branchcode};
2348 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2349 $branch = $item->{$branchfield};
2350 # default to item home branch if holdingbranch is used
2351 # and is not defined
2352 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2353 $branch = $item->{homebranch};
2366 $issue = &GetItemIssue($itemnumber);
2368 Returns patron currently having a book, or undef if not checked out.
2370 C<$itemnumber> is the itemnumber.
2372 C<$issue> is a hashref of the row from the issues table.
2377 my ($itemnumber) = @_;
2378 return unless $itemnumber;
2379 my $sth = C4::Context->dbh->prepare(
2380 "SELECT items.*, issues.*
2382 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2383 WHERE issues.itemnumber=?");
2384 $sth->execute($itemnumber);
2385 my $data = $sth->fetchrow_hashref;
2386 return unless $data;
2387 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2388 $data->{issuedate}->truncate(to => 'minute');
2389 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2390 $data->{date_due}->truncate(to => 'minute');
2391 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2392 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2398 $issue = GetOpenIssue( $itemnumber );
2400 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2402 C<$itemnumber> is the item's itemnumber
2409 my ( $itemnumber ) = @_;
2410 return unless $itemnumber;
2411 my $dbh = C4::Context->dbh;
2412 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2413 $sth->execute( $itemnumber );
2414 return $sth->fetchrow_hashref();
2420 $issues = GetIssues({}); # return all issues!
2421 $issues = GetIssues({ borrowernumber => $borrowernumber, biblionumber => $biblionumber });
2423 Returns all pending issues that match given criteria.
2424 Returns a arrayref or undef if an error occurs.
2426 Allowed criteria are:
2430 =item * borrowernumber
2432 =item * biblionumber
2441 my ($criteria) = @_;
2445 my @allowed = qw(borrowernumber biblionumber itemnumber);
2446 foreach (@allowed) {
2447 if (defined $criteria->{$_}) {
2450 value => $criteria->{$_},
2455 # Do we need to join other tables ?
2457 if (defined $criteria->{biblionumber}) {
2464 $where = "WHERE " . join(' AND ', map { "$_->{field} = ?" } @filters);
2470 if (defined $join{items}) {
2472 LEFT JOIN items ON (issues.itemnumber = items.itemnumber)
2478 my $dbh = C4::Context->dbh;
2479 my $sth = $dbh->prepare($query);
2480 my $rv = $sth->execute(map { $_->{value} } @filters);
2482 return $rv ? $sth->fetchall_arrayref({}) : undef;
2485 =head2 GetItemIssues
2487 $issues = &GetItemIssues($itemnumber, $history);
2489 Returns patrons that have issued a book
2491 C<$itemnumber> is the itemnumber
2492 C<$history> is false if you just want the current "issuer" (if any)
2493 and true if you want issues history from old_issues also.
2495 Returns reference to an array of hashes
2500 my ( $itemnumber, $history ) = @_;
2502 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2503 $today->truncate( to => 'minute' );
2504 my $sql = "SELECT * FROM issues
2505 JOIN borrowers USING (borrowernumber)
2506 JOIN items USING (itemnumber)
2507 WHERE issues.itemnumber = ? ";
2510 SELECT * FROM old_issues
2511 LEFT JOIN borrowers USING (borrowernumber)
2512 JOIN items USING (itemnumber)
2513 WHERE old_issues.itemnumber = ? ";
2515 $sql .= "ORDER BY date_due DESC";
2516 my $sth = C4::Context->dbh->prepare($sql);
2518 $sth->execute($itemnumber, $itemnumber);
2520 $sth->execute($itemnumber);
2522 my $results = $sth->fetchall_arrayref({});
2523 foreach (@$results) {
2524 my $date_due = dt_from_string($_->{date_due},'sql');
2525 $date_due->truncate( to => 'minute' );
2527 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2532 =head2 GetBiblioIssues
2534 $issues = GetBiblioIssues($biblionumber);
2536 this function get all issues from a biblionumber.
2539 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2540 tables issues and the firstname,surname & cardnumber from borrowers.
2544 sub GetBiblioIssues {
2545 my $biblionumber = shift;
2546 return unless $biblionumber;
2547 my $dbh = C4::Context->dbh;
2549 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2551 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2552 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2553 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2554 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2555 WHERE biblio.biblionumber = ?
2557 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2559 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2560 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2561 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2562 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2563 WHERE biblio.biblionumber = ?
2566 my $sth = $dbh->prepare($query);
2567 $sth->execute($biblionumber, $biblionumber);
2570 while ( my $data = $sth->fetchrow_hashref ) {
2571 push @issues, $data;
2576 =head2 GetUpcomingDueIssues
2578 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2582 sub GetUpcomingDueIssues {
2585 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2586 my $dbh = C4::Context->dbh;
2588 my $statement = <<END_SQL;
2589 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2591 LEFT JOIN items USING (itemnumber)
2592 LEFT OUTER JOIN branches USING (branchcode)
2593 WHERE returndate is NULL
2594 HAVING days_until_due >= 0 AND days_until_due <= ?
2597 my @bind_parameters = ( $params->{'days_in_advance'} );
2599 my $sth = $dbh->prepare( $statement );
2600 $sth->execute( @bind_parameters );
2601 my $upcoming_dues = $sth->fetchall_arrayref({});
2603 return $upcoming_dues;
2606 =head2 CanBookBeRenewed
2608 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2610 Find out whether a borrowed item may be renewed.
2612 C<$borrowernumber> is the borrower number of the patron who currently
2613 has the item on loan.
2615 C<$itemnumber> is the number of the item to renew.
2617 C<$override_limit>, if supplied with a true value, causes
2618 the limit on the number of times that the loan can be renewed
2619 (as controlled by the item type) to be ignored. Overriding also allows
2620 to renew sooner than "No renewal before" and to manually renew loans
2621 that are automatically renewed.
2623 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2624 item must currently be on loan to the specified borrower; renewals
2625 must be allowed for the item's type; and the borrower must not have
2626 already renewed the loan. $error will contain the reason the renewal can not proceed
2630 sub CanBookBeRenewed {
2631 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2633 my $dbh = C4::Context->dbh;
2636 my $item = GetItem($itemnumber) or return ( 0, 'no_item' );
2637 my $itemissue = GetItemIssue($itemnumber) or return ( 0, 'no_checkout' );
2639 $borrowernumber ||= $itemissue->{borrowernumber};
2640 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber )
2643 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2645 return ( 0, "on_reserve" ) if $resfound; # '' when no hold was found
2647 return ( 1, undef ) if $override_limit;
2649 my $branchcode = _GetCircControlBranch( $item, $borrower );
2651 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2653 return ( 0, "too_many" )
2654 if $issuingrule->{renewalsallowed} <= $itemissue->{renewals};
2656 if ( $issuingrule->{norenewalbefore} ) {
2658 # Get current time and add norenewalbefore.
2659 # If this is smaller than date_due, it's too soon for renewal.
2661 DateTime->now( time_zone => C4::Context->tz() )->add(
2662 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore}
2663 ) < $itemissue->{date_due}
2666 return ( 0, "auto_too_soon" ) if $itemissue->{auto_renew};
2667 return ( 0, "too_soon" );
2671 return ( 0, "auto_renew" ) if $itemissue->{auto_renew};
2672 return ( 1, undef );
2677 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2681 C<$borrowernumber> is the borrower number of the patron who currently
2684 C<$itemnumber> is the number of the item to renew.
2686 C<$branch> is the library where the renewal took place (if any).
2687 The library that controls the circ policies for the renewal is retrieved from the issues record.
2689 C<$datedue> can be a C4::Dates object used to set the due date.
2691 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2692 this parameter is not supplied, lastreneweddate is set to the current date.
2694 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2695 from the book's item type.
2700 my $borrowernumber = shift;
2701 my $itemnumber = shift or return;
2703 my $datedue = shift;
2704 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2706 my $item = GetItem($itemnumber) or return;
2707 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2709 my $dbh = C4::Context->dbh;
2711 # Find the issues record for this book
2713 $dbh->prepare("SELECT * FROM issues WHERE itemnumber = ?");
2714 $sth->execute( $itemnumber );
2715 my $issuedata = $sth->fetchrow_hashref;
2717 return unless ( $issuedata );
2719 $borrowernumber ||= $issuedata->{borrowernumber};
2721 if ( defined $datedue && ref $datedue ne 'DateTime' ) {
2722 carp 'Invalid date passed to AddRenewal.';
2726 # If the due date wasn't specified, calculate it by adding the
2727 # book's loan length to today's date or the current due date
2728 # based on the value of the RenewalPeriodBase syspref.
2731 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2732 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2734 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2735 dt_from_string( $issuedata->{date_due} ) :
2736 DateTime->now( time_zone => C4::Context->tz());
2737 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2740 # Update the issues record to have the new due date, and a new count
2741 # of how many times it has been renewed.
2742 my $renews = $issuedata->{'renewals'} + 1;
2743 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2744 WHERE borrowernumber=?
2748 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2750 # Update the renewal count on the item, and tell zebra to reindex
2751 $renews = $biblio->{'renewals'} + 1;
2752 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2754 # Charge a new rental fee, if applicable?
2755 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2756 if ( $charge > 0 ) {
2757 my $accountno = getnextacctno( $borrowernumber );
2758 my $item = GetBiblioFromItemNumber($itemnumber);
2760 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2761 $sth = $dbh->prepare(
2762 "INSERT INTO accountlines
2763 (date, borrowernumber, accountno, amount, manager_id,
2764 description,accounttype, amountoutstanding, itemnumber)
2765 VALUES (now(),?,?,?,?,?,?,?,?)"
2767 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2768 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2769 'Rent', $charge, $itemnumber );
2772 # Send a renewal slip according to checkout alert preferencei
2773 if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2774 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2775 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2777 branchcode => $branch,
2778 categorycode => $borrower->{categorycode},
2779 item_type => $item->{itype},
2780 notification => 'CHECKOUT',
2782 if ($circulation_alert->is_enabled_for(\%conditions)) {
2783 SendCirculationAlert({
2786 borrower => $borrower,
2792 # Remove any OVERDUES related debarment if the borrower has no overdues
2793 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
2794 if ( $borrowernumber
2795 && $borrower->{'debarred'}
2796 && !HasOverdues( $borrowernumber )
2797 && @{ GetDebarments({ borrowernumber => $borrowernumber, type => 'OVERDUES' }) }
2799 DelUniqueDebarment({ borrowernumber => $borrowernumber, type => 'OVERDUES' });
2803 UpdateStats({branch => $branch,
2806 itemnumber => $itemnumber,
2807 itemtype => $item->{itype},
2808 borrowernumber => $borrowernumber,
2809 ccode => $item->{'ccode'}}
2815 # check renewal status
2816 my ( $bornum, $itemno ) = @_;
2817 my $dbh = C4::Context->dbh;
2819 my $renewsallowed = 0;
2822 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2823 my $item = GetItem($itemno);
2825 # Look in the issues table for this item, lent to this borrower,
2826 # and not yet returned.
2828 # FIXME - I think this function could be redone to use only one SQL call.
2829 my $sth = $dbh->prepare(
2830 "select * from issues
2831 where (borrowernumber = ?)
2832 and (itemnumber = ?)"
2834 $sth->execute( $bornum, $itemno );
2835 my $data = $sth->fetchrow_hashref;
2836 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2837 # $item and $borrower should be calculated
2838 my $branchcode = _GetCircControlBranch($item, $borrower);
2840 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2842 $renewsallowed = $issuingrule->{'renewalsallowed'};
2843 $renewsleft = $renewsallowed - $renewcount;
2844 if($renewsleft < 0){ $renewsleft = 0; }
2845 return ( $renewcount, $renewsallowed, $renewsleft );
2848 =head2 GetSoonestRenewDate
2850 $NoRenewalBeforeThisDate = &GetSoonestRenewDate($borrowernumber, $itemnumber);
2852 Find out the soonest possible renew date of a borrowed item.
2854 C<$borrowernumber> is the borrower number of the patron who currently
2855 has the item on loan.
2857 C<$itemnumber> is the number of the item to renew.
2859 C<$GetSoonestRenewDate> returns the DateTime of the soonest possible
2860 renew date, based on the value "No renewal before" of the applicable
2861 issuing rule. Returns the current date if the item can already be
2862 renewed, and returns undefined if the borrower, loan, or item
2867 sub GetSoonestRenewDate {
2868 my ( $borrowernumber, $itemnumber ) = @_;
2870 my $dbh = C4::Context->dbh;
2872 my $item = GetItem($itemnumber) or return;
2873 my $itemissue = GetItemIssue($itemnumber) or return;
2875 $borrowernumber ||= $itemissue->{borrowernumber};
2876 my $borrower = C4::Members::GetMemberDetails($borrowernumber)
2879 my $branchcode = _GetCircControlBranch( $item, $borrower );
2881 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2883 my $now = DateTime->now( time_zone => C4::Context->tz() );
2885 if ( $issuingrule->{norenewalbefore} ) {
2886 my $soonestrenewal =
2887 $itemissue->{date_due}->subtract(
2888 $issuingrule->{lengthunit} => $issuingrule->{norenewalbefore} );
2890 $soonestrenewal = $now > $soonestrenewal ? $now : $soonestrenewal;
2891 return $soonestrenewal;
2896 =head2 GetIssuingCharges
2898 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2900 Calculate how much it would cost for a given patron to borrow a given
2901 item, including any applicable discounts.
2903 C<$itemnumber> is the item number of item the patron wishes to borrow.
2905 C<$borrowernumber> is the patron's borrower number.
2907 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2908 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2913 sub GetIssuingCharges {
2915 # calculate charges due
2916 my ( $itemnumber, $borrowernumber ) = @_;
2918 my $dbh = C4::Context->dbh;
2921 # Get the book's item type and rental charge (via its biblioitem).
2922 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2923 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2924 $charge_query .= (C4::Context->preference('item-level_itypes'))
2925 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2926 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2928 $charge_query .= ' WHERE items.itemnumber =?';
2930 my $sth = $dbh->prepare($charge_query);
2931 $sth->execute($itemnumber);
2932 if ( my $item_data = $sth->fetchrow_hashref ) {
2933 $item_type = $item_data->{itemtype};
2934 $charge = $item_data->{rentalcharge};
2935 my $branch = C4::Branch::mybranch();
2936 my $discount_query = q|SELECT rentaldiscount,
2937 issuingrules.itemtype, issuingrules.branchcode
2939 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2940 WHERE borrowers.borrowernumber = ?
2941 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2942 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2943 my $discount_sth = $dbh->prepare($discount_query);
2944 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2945 my $discount_rules = $discount_sth->fetchall_arrayref({});
2946 if (@{$discount_rules}) {
2947 # We may have multiple rules so get the most specific
2948 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2949 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2953 return ( $charge, $item_type );
2956 # Select most appropriate discount rule from those returned
2957 sub _get_discount_from_rule {
2958 my ($rules_ref, $branch, $itemtype) = @_;
2961 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2962 $discount = $rules_ref->[0]->{rentaldiscount};
2963 return (defined $discount) ? $discount : 0;
2965 # could have up to 4 does one match $branch and $itemtype
2966 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2968 $discount = $d[0]->{rentaldiscount};
2969 return (defined $discount) ? $discount : 0;
2971 # do we have item type + all branches
2972 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2974 $discount = $d[0]->{rentaldiscount};
2975 return (defined $discount) ? $discount : 0;
2977 # do we all item types + this branch
2978 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2980 $discount = $d[0]->{rentaldiscount};
2981 return (defined $discount) ? $discount : 0;
2983 # so all and all (surely we wont get here)
2984 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2986 $discount = $d[0]->{rentaldiscount};
2987 return (defined $discount) ? $discount : 0;
2993 =head2 AddIssuingCharge
2995 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2999 sub AddIssuingCharge {
3000 my ( $itemnumber, $borrowernumber, $charge ) = @_;
3001 my $dbh = C4::Context->dbh;
3002 my $nextaccntno = getnextacctno( $borrowernumber );
3004 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
3006 INSERT INTO accountlines
3007 (borrowernumber, itemnumber, accountno,
3008 date, amount, description, accounttype,
3009 amountoutstanding, manager_id)
3010 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
3012 my $sth = $dbh->prepare($query);
3013 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
3018 GetTransfers($itemnumber);
3023 my ($itemnumber) = @_;
3025 my $dbh = C4::Context->dbh;
3031 FROM branchtransfers
3032 WHERE itemnumber = ?
3033 AND datearrived IS NULL
3035 my $sth = $dbh->prepare($query);
3036 $sth->execute($itemnumber);
3037 my @row = $sth->fetchrow_array();
3041 =head2 GetTransfersFromTo
3043 @results = GetTransfersFromTo($frombranch,$tobranch);
3045 Returns the list of pending transfers between $from and $to branch
3049 sub GetTransfersFromTo {
3050 my ( $frombranch, $tobranch ) = @_;
3051 return unless ( $frombranch && $tobranch );
3052 my $dbh = C4::Context->dbh;
3054 SELECT itemnumber,datesent,frombranch
3055 FROM branchtransfers
3058 AND datearrived IS NULL
3060 my $sth = $dbh->prepare($query);
3061 $sth->execute( $frombranch, $tobranch );
3064 while ( my $data = $sth->fetchrow_hashref ) {
3065 push @gettransfers, $data;
3067 return (@gettransfers);
3070 =head2 DeleteTransfer
3072 &DeleteTransfer($itemnumber);
3076 sub DeleteTransfer {
3077 my ($itemnumber) = @_;
3078 return unless $itemnumber;
3079 my $dbh = C4::Context->dbh;
3080 my $sth = $dbh->prepare(
3081 "DELETE FROM branchtransfers
3083 AND datearrived IS NULL "
3085 return $sth->execute($itemnumber);
3088 =head2 AnonymiseIssueHistory
3090 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
3092 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
3093 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
3095 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
3096 setting (force delete).
3098 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
3102 sub AnonymiseIssueHistory {
3104 my $borrowernumber = shift;
3105 my $dbh = C4::Context->dbh;
3108 SET borrowernumber = ?
3109 WHERE returndate < ?
3110 AND borrowernumber IS NOT NULL
3113 # The default of 0 does not work due to foreign key constraints
3114 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
3115 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
3116 my @bind_params = ($anonymouspatron, $date);
3117 if (defined $borrowernumber) {
3118 $query .= " AND borrowernumber = ?";
3119 push @bind_params, $borrowernumber;
3121 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
3123 my $sth = $dbh->prepare($query);
3124 $sth->execute(@bind_params);
3125 my $anonymisation_err = $dbh->err;
3126 my $rows_affected = $sth->rows; ### doublecheck row count return function
3127 return ($rows_affected, $anonymisation_err);
3130 =head2 SendCirculationAlert
3132 Send out a C<check-in> or C<checkout> alert using the messaging system.
3140 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
3144 Hashref of information about the item being checked in or out.
3148 Hashref of information about the borrower of the item.
3152 The branchcode from where the checkout or check-in took place.
3158 SendCirculationAlert({
3161 borrower => $borrower,
3167 sub SendCirculationAlert {
3169 my ($type, $item, $borrower, $branch) =
3170 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
3171 my %message_name = (
3172 CHECKIN => 'Item_Check_in',
3173 CHECKOUT => 'Item_Checkout',
3174 RENEWAL => 'Item_Checkout',
3176 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
3177 borrowernumber => $borrower->{borrowernumber},
3178 message_name => $message_name{$type},
3180 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
3181 my $letter = C4::Letters::GetPreparedLetter (
3182 module => 'circulation',
3183 letter_code => $type,
3184 branchcode => $branch,
3186 $issues_table => $item->{itemnumber},
3187 'items' => $item->{itemnumber},
3188 'biblio' => $item->{biblionumber},
3189 'biblioitems' => $item->{biblionumber},
3190 'borrowers' => $borrower,
3191 'branches' => $branch,
3195 my @transports = keys %{ $borrower_preferences->{transports} };
3196 # warn "no transports" unless @transports;
3198 # warn "transport: $_";
3199 my $message = C4::Message->find_last_message($borrower, $type, $_);
3201 #warn "create new message";
3202 C4::Message->enqueue($letter, $borrower, $_);
3204 #warn "append to old message";
3205 $message->append($letter);
3213 =head2 updateWrongTransfer
3215 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
3217 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
3221 sub updateWrongTransfer {
3222 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
3223 my $dbh = C4::Context->dbh;
3224 # first step validate the actual line of transfert .
3227 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
3229 $sth->execute($FromLibrary,$itemNumber);
3231 # second step create a new line of branchtransfer to the right location .
3232 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
3234 #third step changing holdingbranch of item
3235 UpdateHoldingbranch($FromLibrary,$itemNumber);
3238 =head2 UpdateHoldingbranch
3240 $items = UpdateHoldingbranch($branch,$itmenumber);
3242 Simple methode for updating hodlingbranch in items BDD line
3246 sub UpdateHoldingbranch {
3247 my ( $branch,$itemnumber ) = @_;
3248 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3253 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3255 this function calculates the due date given the start date and configured circulation rules,
3256 checking against the holidays calendar as per the 'useDaysMode' syspref.
3257 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
3258 C<$itemtype> = itemtype code of item in question
3259 C<$branch> = location whose calendar to use
3260 C<$borrower> = Borrower object
3261 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3266 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3270 # loanlength now a href
3272 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3274 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3280 if (ref $startdate ne 'DateTime' ) {
3281 $datedue = dt_from_string($datedue);
3283 $datedue = $startdate->clone;
3287 DateTime->now( time_zone => C4::Context->tz() )
3288 ->truncate( to => 'minute' );
3292 # calculate the datedue as normal
3293 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3294 { # ignoring calendar
3295 if ( $loanlength->{lengthunit} eq 'hours' ) {
3296 $datedue->add( hours => $loanlength->{$length_key} );
3298 $datedue->add( days => $loanlength->{$length_key} );
3299 $datedue->set_hour(23);
3300 $datedue->set_minute(59);
3304 if ($loanlength->{lengthunit} eq 'hours') {
3305 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3308 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3310 my $calendar = Koha::Calendar->new( branchcode => $branch );
3311 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3312 if ($loanlength->{lengthunit} eq 'days') {
3313 $datedue->set_hour(23);
3314 $datedue->set_minute(59);
3318 # if Hard Due Dates are used, retreive them and apply as necessary
3319 my ( $hardduedate, $hardduedatecompare ) =
3320 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3321 if ($hardduedate) { # hardduedates are currently dates
3322 $hardduedate->truncate( to => 'minute' );
3323 $hardduedate->set_hour(23);
3324 $hardduedate->set_minute(59);
3325 my $cmp = DateTime->compare( $hardduedate, $datedue );
3327 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3328 # if the calculated date is before the 'after' Hard Due Date (floor), override
3329 # if the hard due date is set to 'exactly', overrride
3330 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3331 $datedue = $hardduedate->clone;
3334 # in all other cases, keep the date due as it is
3338 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3339 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3340 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
3341 $expiry_dt->set( hour => 23, minute => 59);
3342 if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
3343 $datedue = $expiry_dt->clone;
3351 =head2 CheckRepeatableHolidays
3353 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3355 This function checks if the date due is a repeatable holiday
3357 C<$date_due> = returndate calculate with no day check
3358 C<$itemnumber> = itemnumber
3359 C<$branchcode> = localisation of issue
3363 sub CheckRepeatableHolidays{
3364 my($itemnumber,$week_day,$branchcode)=@_;
3365 my $dbh = C4::Context->dbh;
3366 my $query = qq|SELECT count(*)
3367 FROM repeatable_holidays
3370 my $sth = $dbh->prepare($query);
3371 $sth->execute($branchcode,$week_day);
3372 my $result=$sth->fetchrow;
3377 =head2 CheckSpecialHolidays
3379 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3381 This function check if the date is a special holiday
3383 C<$years> = the years of datedue
3384 C<$month> = the month of datedue
3385 C<$day> = the day of datedue
3386 C<$itemnumber> = itemnumber
3387 C<$branchcode> = localisation of issue
3391 sub CheckSpecialHolidays{
3392 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3393 my $dbh = C4::Context->dbh;
3394 my $query=qq|SELECT count(*)
3395 FROM `special_holidays`
3401 my $sth = $dbh->prepare($query);
3402 $sth->execute($years,$month,$day,$branchcode);
3403 my $countspecial=$sth->fetchrow ;
3404 return $countspecial;
3407 =head2 CheckRepeatableSpecialHolidays
3409 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3411 This function check if the date is a repeatble special holidays
3413 C<$month> = the month of datedue
3414 C<$day> = the day of datedue
3415 C<$itemnumber> = itemnumber
3416 C<$branchcode> = localisation of issue
3420 sub CheckRepeatableSpecialHolidays{
3421 my ($month,$day,$itemnumber,$branchcode) = @_;
3422 my $dbh = C4::Context->dbh;
3423 my $query=qq|SELECT count(*)
3424 FROM `repeatable_holidays`
3429 my $sth = $dbh->prepare($query);
3430 $sth->execute($month,$day,$branchcode);
3431 my $countspecial=$sth->fetchrow ;
3432 return $countspecial;
3437 sub CheckValidBarcode{
3439 my $dbh = C4::Context->dbh;
3440 my $query=qq|SELECT count(*)
3444 my $sth = $dbh->prepare($query);
3445 $sth->execute($barcode);
3446 my $exist=$sth->fetchrow ;
3450 =head2 IsBranchTransferAllowed
3452 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3454 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3458 sub IsBranchTransferAllowed {
3459 my ( $toBranch, $fromBranch, $code ) = @_;
3461 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3463 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3464 my $dbh = C4::Context->dbh;
3466 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3467 $sth->execute( $toBranch, $fromBranch, $code );
3468 my $limit = $sth->fetchrow_hashref();
3470 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3471 if ( $limit->{'limitId'} ) {
3478 =head2 CreateBranchTransferLimit
3480 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3482 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3486 sub CreateBranchTransferLimit {
3487 my ( $toBranch, $fromBranch, $code ) = @_;
3488 return unless defined($toBranch) && defined($fromBranch);
3489 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3491 my $dbh = C4::Context->dbh;
3493 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3494 return $sth->execute( $code, $toBranch, $fromBranch );
3497 =head2 DeleteBranchTransferLimits
3499 my $result = DeleteBranchTransferLimits($frombranch);
3501 Deletes all the library transfer limits for one library. Returns the
3502 number of limits deleted, 0e0 if no limits were deleted, or undef if
3503 no arguments are supplied.
3507 sub DeleteBranchTransferLimits {
3509 return unless defined $branch;
3510 my $dbh = C4::Context->dbh;
3511 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3512 return $sth->execute($branch);
3516 my ( $borrowernumber, $itemnum ) = @_;
3518 MarkIssueReturned( $borrowernumber, $itemnum );
3519 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3520 my $item = C4::Items::GetItem( $itemnum );
3521 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3522 my @datearr = localtime(time);
3523 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3524 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3525 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3530 my ($itemnumber, $mark_returned) = @_;
3532 my $dbh = C4::Context->dbh();
3533 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3535 JOIN items USING (itemnumber)
3536 JOIN biblio USING (biblionumber)
3537 WHERE issues.itemnumber=?");
3538 $sth->execute($itemnumber);
3539 my $issues=$sth->fetchrow_hashref();
3541 # If a borrower lost the item, add a replacement cost to the their record
3542 if ( my $borrowernumber = $issues->{borrowernumber} ){
3543 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3545 if (C4::Context->preference('WhenLostForgiveFine')){
3546 my $fix = _FixOverduesOnReturn($borrowernumber, $itemnumber, 1, 0); # 1, 0 = exemptfine, no-dropbox
3547 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $itemnumber...) failed!"; # zero is OK, check defined
3549 if (C4::Context->preference('WhenLostChargeReplacementFee')){
3550 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}");
3551 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3552 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3555 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3559 sub GetOfflineOperations {
3560 my $dbh = C4::Context->dbh;
3561 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3562 $sth->execute(C4::Context->userenv->{'branch'});
3563 my $results = $sth->fetchall_arrayref({});
3567 sub GetOfflineOperation {
3568 my $operationid = shift;
3569 return unless $operationid;
3570 my $dbh = C4::Context->dbh;
3571 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3572 $sth->execute( $operationid );
3573 return $sth->fetchrow_hashref;
3576 sub AddOfflineOperation {
3577 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3578 my $dbh = C4::Context->dbh;
3579 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3580 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3584 sub DeleteOfflineOperation {
3585 my $dbh = C4::Context->dbh;
3586 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3587 $sth->execute( shift );
3591 sub ProcessOfflineOperation {
3592 my $operation = shift;
3595 if ( $operation->{action} eq 'return' ) {
3596 $report = ProcessOfflineReturn( $operation );
3597 } elsif ( $operation->{action} eq 'issue' ) {
3598 $report = ProcessOfflineIssue( $operation );
3599 } elsif ( $operation->{action} eq 'payment' ) {
3600 $report = ProcessOfflinePayment( $operation );
3603 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3608 sub ProcessOfflineReturn {
3609 my $operation = shift;
3611 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3613 if ( $itemnumber ) {
3614 my $issue = GetOpenIssue( $itemnumber );
3617 $issue->{borrowernumber},
3620 $operation->{timestamp},
3623 { renewals => 0, onloan => undef },
3624 $issue->{'biblionumber'},
3629 return "Item not issued.";
3632 return "Item not found.";
3636 sub ProcessOfflineIssue {
3637 my $operation = shift;
3639 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3641 if ( $borrower->{borrowernumber} ) {
3642 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3643 unless ($itemnumber) {
3644 return "Barcode not found.";
3646 my $issue = GetOpenIssue( $itemnumber );
3648 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3650 $issue->{borrowernumber},
3653 $operation->{timestamp},
3658 $operation->{'barcode'},
3661 $operation->{timestamp},
3666 return "Borrower not found.";
3670 sub ProcessOfflinePayment {
3671 my $operation = shift;
3673 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3674 my $amount = $operation->{amount};
3676 recordpayment( $borrower->{borrowernumber}, $amount );
3684 TransferSlip($user_branch, $itemnumber, $to_branch)
3686 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3691 my ($branch, $itemnumber, $to_branch) = @_;
3693 my $item = GetItem( $itemnumber )
3696 my $pulldate = C4::Dates->new();
3698 return C4::Letters::GetPreparedLetter (
3699 module => 'circulation',
3700 letter_code => 'TRANSFERSLIP',
3701 branchcode => $branch,
3703 'branches' => $to_branch,
3704 'biblio' => $item->{biblionumber},
3710 =head2 CheckIfIssuedToPatron
3712 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3714 Return 1 if any record item is issued to patron, otherwise return 0
3718 sub CheckIfIssuedToPatron {
3719 my ($borrowernumber, $biblionumber) = @_;
3721 my $items = GetItemsByBiblioitemnumber($biblionumber);
3723 foreach my $item (@{$items}) {
3724 return 1 if ($item->{borrowernumber} && $item->{borrowernumber} eq $borrowernumber);
3732 IsItemIssued( $itemnumber )
3734 Return 1 if the item is on loan, otherwise return 0
3739 my $itemnumber = shift;
3740 my $dbh = C4::Context->dbh;
3741 my $sth = $dbh->prepare(q{
3744 WHERE itemnumber = ?
3746 $sth->execute($itemnumber);
3747 return $sth->fetchrow;
3750 sub GetAgeRestriction {
3751 my ($record_restrictions) = @_;
3752 my $markers = C4::Context->preference('AgeRestrictionMarker');
3754 # Split $record_restrictions to something like FSK 16 or PEGI 6
3755 my @values = split ' ', uc($record_restrictions);
3756 return unless @values;
3758 # Search first occurence of one of the markers
3759 my @markers = split /\|/, uc($markers);
3760 return unless @markers;
3763 my $restriction_year = 0;
3764 for my $value (@values) {
3766 for my $marker (@markers) {
3767 $marker =~ s/^\s+//; #remove leading spaces
3768 $marker =~ s/\s+$//; #remove trailing spaces
3769 if ( $marker eq $value ) {
3770 if ( $index <= $#values ) {
3771 $restriction_year += $values[$index];
3775 elsif ( $value =~ /^\Q$marker\E(\d+)$/ ) {
3777 # Perhaps it is something like "K16" (as in Finland)
3778 $restriction_year += $1;
3782 last if ( $restriction_year > 0 );
3785 return $restriction_year;
3794 Koha Development Team <http://koha-community.org/>