1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #use warnings; FIXME - Bug 2505
32 use C4::Dates qw(format_date);
34 use C4::ItemCirculationAlertPreference;
37 use C4::Branch; # GetBranches
38 use C4::Log; # logaction
40 GetAuthorisedValueByCode
42 GetKohaAuthorisedValueLib
44 use C4::Overdues qw(CalcFine UpdateFine);
45 use Algorithm::CheckDigits;
60 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
64 $VERSION = 3.07.00.049; # for version checking
67 # FIXME subs that should probably be elsewhere
74 # subs to deal with issuing a book
85 &GetBranchBorrowerCircRule
89 &AnonymiseIssueHistory
90 &CheckIfIssuedToPatron
93 # subs to deal with returns
99 # subs to deal with transfers
106 &IsBranchTransferAllowed
107 &CreateBranchTransferLimit
108 &DeleteBranchTransferLimits
112 # subs to deal with offline circulation
114 &GetOfflineOperations
117 &DeleteOfflineOperation
118 &ProcessOfflineOperation
124 C4::Circulation - Koha circulation module
132 The functions in this module deal with circulation, issues, and
133 returns, as well as general information about the library.
134 Also deals with stocktaking.
140 $str = &barcodedecode($barcode, [$filter]);
142 Generic filter function for barcode string.
143 Called on every circ if the System Pref itemBarcodeInputFilter is set.
144 Will do some manipulation of the barcode for systems that deliver a barcode
145 to circulation.pl that differs from the barcode stored for the item.
146 For proper functioning of this filter, calling the function on the
147 correct barcode string (items.barcode) should return an unaltered barcode.
149 The optional $filter argument is to allow for testing or explicit
150 behavior that ignores the System Pref. Valid values are the same as the
155 # FIXME -- the &decode fcn below should be wrapped into this one.
156 # FIXME -- these plugins should be moved out of Circulation.pm
159 my ($barcode, $filter) = @_;
160 my $branch = C4::Branch::mybranch();
161 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
162 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
163 if ($filter eq 'whitespace') {
165 } elsif ($filter eq 'cuecat') {
167 my @fields = split( /\./, $barcode );
168 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
169 ($#results == 2) and return $results[2];
170 } elsif ($filter eq 'T-prefix') {
171 if ($barcode =~ /^[Tt](\d)/) {
172 (defined($1) and $1 eq '0') and return $barcode;
173 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
175 return sprintf("T%07d", $barcode);
176 # FIXME: $barcode could be "T1", causing warning: substr outside of string
177 # Why drop the nonzero digit after the T?
178 # Why pass non-digits (or empty string) to "T%07d"?
179 } elsif ($filter eq 'libsuite8') {
180 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
181 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
182 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
184 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
187 } elsif ($filter eq 'EAN13') {
188 my $ean = CheckDigits('ean');
189 if ( $ean->is_valid($barcode) ) {
190 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
191 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
193 warn "# [$barcode] not valid EAN-13/UPC-A\n";
196 return $barcode; # return barcode, modified or not
201 $str = &decode($chunk);
203 Decodes a segment of a string emitted by a CueCat barcode scanner and
206 FIXME: Should be replaced with Barcode::Cuecat from CPAN
207 or Javascript based decoding on the client side.
214 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
215 my @s = map { index( $seq, $_ ); } split( //, $encoded );
216 my $l = ( $#s + 1 ) % 4;
219 # warn "Error: Cuecat decode parsing failed!";
227 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
229 chr( ( $n >> 16 ) ^ 67 )
230 .chr( ( $n >> 8 & 255 ) ^ 67 )
231 .chr( ( $n & 255 ) ^ 67 );
234 $r = substr( $r, 0, length($r) - $l );
240 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
241 $barcode, $ignore_reserves);
243 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
245 C<$newbranch> is the code for the branch to which the item should be transferred.
247 C<$barcode> is the barcode of the item to be transferred.
249 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
250 Otherwise, if an item is reserved, the transfer fails.
252 Returns three values:
258 is true if the transfer was successful.
262 is a reference-to-hash which may have any of the following keys:
268 There is no item in the catalog with the given barcode. The value is C<$barcode>.
272 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.
274 =item C<DestinationEqualsHolding>
276 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.
280 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.
284 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>.
286 =item C<WasTransferred>
288 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
297 my ( $tbr, $barcode, $ignoreRs ) = @_;
300 my $branches = GetBranches();
301 my $itemnumber = GetItemnumberFromBarcode( $barcode );
302 my $issue = GetItemIssue($itemnumber);
303 my $biblio = GetBiblioFromItemNumber($itemnumber);
306 if ( not $itemnumber ) {
307 $messages->{'BadBarcode'} = $barcode;
311 # get branches of book...
312 my $hbr = $biblio->{'homebranch'};
313 my $fbr = $biblio->{'holdingbranch'};
315 # if using Branch Transfer Limits
316 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
317 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
318 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
319 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
322 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
323 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
329 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
330 $messages->{'IsPermanent'} = $hbr;
334 # can't transfer book if is already there....
335 if ( $fbr eq $tbr ) {
336 $messages->{'DestinationEqualsHolding'} = 1;
340 # check if it is still issued to someone, return it...
341 if ($issue->{borrowernumber}) {
342 AddReturn( $barcode, $fbr );
343 $messages->{'WasReturned'} = $issue->{borrowernumber};
347 # That'll save a database query.
348 my ( $resfound, $resrec, undef ) =
349 CheckReserves( $itemnumber );
350 if ( $resfound and not $ignoreRs ) {
351 $resrec->{'ResFound'} = $resfound;
353 # $messages->{'ResFound'} = $resrec;
357 #actually do the transfer....
359 ModItemTransfer( $itemnumber, $fbr, $tbr );
361 # don't need to update MARC anymore, we do it in batch now
362 $messages->{'WasTransfered'} = 1;
365 ModDateLastSeen( $itemnumber );
366 return ( $dotransfer, $messages, $biblio );
371 my $borrower = shift;
372 my $biblionumber = shift;
374 my $cat_borrower = $borrower->{'categorycode'};
375 my $dbh = C4::Context->dbh;
377 # Get which branchcode we need
378 $branch = _GetCircControlBranch($item,$borrower);
379 my $type = (C4::Context->preference('item-level_itypes'))
380 ? $item->{'itype'} # item-level
381 : $item->{'itemtype'}; # biblio-level
383 # given branch, patron category, and item type, determine
384 # applicable issuing rule
385 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
387 # if a rule is found and has a loan limit set, count
388 # how many loans the patron already has that meet that
390 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
392 my $count_query = "SELECT COUNT(*) FROM issues
393 JOIN items USING (itemnumber) ";
395 my $rule_itemtype = $issuing_rule->{itemtype};
396 if ($rule_itemtype eq "*") {
397 # matching rule has the default item type, so count only
398 # those existing loans that don't fall under a more
400 if (C4::Context->preference('item-level_itypes')) {
401 $count_query .= " WHERE items.itype NOT IN (
402 SELECT itemtype FROM issuingrules
404 AND (categorycode = ? OR categorycode = ?)
408 $count_query .= " JOIN biblioitems USING (biblionumber)
409 WHERE biblioitems.itemtype NOT IN (
410 SELECT itemtype FROM issuingrules
412 AND (categorycode = ? OR categorycode = ?)
416 push @bind_params, $issuing_rule->{branchcode};
417 push @bind_params, $issuing_rule->{categorycode};
418 push @bind_params, $cat_borrower;
420 # rule has specific item type, so count loans of that
422 if (C4::Context->preference('item-level_itypes')) {
423 $count_query .= " WHERE items.itype = ? ";
425 $count_query .= " JOIN biblioitems USING (biblionumber)
426 WHERE biblioitems.itemtype= ? ";
428 push @bind_params, $type;
431 $count_query .= " AND borrowernumber = ? ";
432 push @bind_params, $borrower->{'borrowernumber'};
433 my $rule_branch = $issuing_rule->{branchcode};
434 if ($rule_branch ne "*") {
435 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
436 $count_query .= " AND issues.branchcode = ? ";
437 push @bind_params, $branch;
438 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
439 ; # if branch is the patron's home branch, then count all loans by patron
441 $count_query .= " AND items.homebranch = ? ";
442 push @bind_params, $branch;
446 my $count_sth = $dbh->prepare($count_query);
447 $count_sth->execute(@bind_params);
448 my ($current_loan_count) = $count_sth->fetchrow_array;
450 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
451 if ($current_loan_count >= $max_loans_allowed) {
452 return ($current_loan_count, $max_loans_allowed);
456 # Now count total loans against the limit for the branch
457 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
458 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
459 my @bind_params = ();
460 my $branch_count_query = "SELECT COUNT(*) FROM issues
461 JOIN items USING (itemnumber)
462 WHERE borrowernumber = ? ";
463 push @bind_params, $borrower->{borrowernumber};
465 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
466 $branch_count_query .= " AND issues.branchcode = ? ";
467 push @bind_params, $branch;
468 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
469 ; # if branch is the patron's home branch, then count all loans by patron
471 $branch_count_query .= " AND items.homebranch = ? ";
472 push @bind_params, $branch;
474 my $branch_count_sth = $dbh->prepare($branch_count_query);
475 $branch_count_sth->execute(@bind_params);
476 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
478 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
479 if ($current_loan_count >= $max_loans_allowed) {
480 return ($current_loan_count, $max_loans_allowed);
484 # OK, the patron can issue !!!
490 @issues = &itemissues($biblioitemnumber, $biblio);
492 Looks up information about who has borrowed the bookZ<>(s) with the
493 given biblioitemnumber.
495 C<$biblio> is ignored.
497 C<&itemissues> returns an array of references-to-hash. The keys
498 include the fields from the C<items> table in the Koha database.
499 Additional keys include:
505 If the item is currently on loan, this gives the due date.
507 If the item is not on loan, then this is either "Available" or
508 "Cancelled", if the item has been withdrawn.
512 If the item is currently on loan, this gives the card number of the
513 patron who currently has the item.
515 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
517 These give the timestamp for the last three times the item was
520 =item C<card0>, C<card1>, C<card2>
522 The card number of the last three patrons who borrowed this item.
524 =item C<borrower0>, C<borrower1>, C<borrower2>
526 The borrower number of the last three patrons who borrowed this item.
534 my ( $bibitem, $biblio ) = @_;
535 my $dbh = C4::Context->dbh;
537 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
542 $sth->execute($bibitem) || die $sth->errstr;
544 while ( my $data = $sth->fetchrow_hashref ) {
546 # Find out who currently has this item.
547 # FIXME - Wouldn't it be better to do this as a left join of
548 # some sort? Currently, this code assumes that if
549 # fetchrow_hashref() fails, then the book is on the shelf.
550 # fetchrow_hashref() can fail for any number of reasons (e.g.,
551 # database server crash), not just because no items match the
553 my $sth2 = $dbh->prepare(
554 "SELECT * FROM issues
555 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
560 $sth2->execute( $data->{'itemnumber'} );
561 if ( my $data2 = $sth2->fetchrow_hashref ) {
562 $data->{'date_due'} = $data2->{'date_due'};
563 $data->{'card'} = $data2->{'cardnumber'};
564 $data->{'borrower'} = $data2->{'borrowernumber'};
567 $data->{'date_due'} = ($data->{'wthdrawn'} eq '1') ? 'Cancelled' : 'Available';
571 # Find the last 3 people who borrowed this item.
572 $sth2 = $dbh->prepare(
573 "SELECT * FROM old_issues
574 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
576 ORDER BY returndate DESC,timestamp DESC"
579 $sth2->execute( $data->{'itemnumber'} );
580 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
581 { # FIXME : error if there is less than 3 pple borrowing this item
582 if ( my $data2 = $sth2->fetchrow_hashref ) {
583 $data->{"timestamp$i2"} = $data2->{'timestamp'};
584 $data->{"card$i2"} = $data2->{'cardnumber'};
585 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
589 $results[$i] = $data;
596 =head2 CanBookBeIssued
598 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
599 $barcode, $duedatespec, $inprocess, $ignore_reserves );
601 Check if a book can be issued.
603 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
607 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
609 =item C<$barcode> is the bar code of the book being issued.
611 =item C<$duedatespec> is a C4::Dates object.
613 =item C<$inprocess> boolean switch
614 =item C<$ignore_reserves> boolean switch
622 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
623 Possible values are :
629 sticky due date is invalid
633 borrower gone with no address
637 borrower declared it's card lost
643 =head3 UNKNOWN_BARCODE
657 item is restricted (set by ??)
659 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
660 could be prevented, but ones that can be overriden by the operator.
662 Possible values are :
670 renewing, not issuing
672 =head3 ISSUED_TO_ANOTHER
674 issued to someone else.
678 reserved for someone else.
682 sticky due date is invalid or due date in the past
686 if the borrower borrows to much things
690 sub CanBookBeIssued {
691 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves ) = @_;
692 my %needsconfirmation; # filled with problems that needs confirmations
693 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
694 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
696 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
697 my $issue = GetItemIssue($item->{itemnumber});
698 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
699 $item->{'itemtype'}=$item->{'itype'};
700 my $dbh = C4::Context->dbh;
702 # MANDATORY CHECKS - unless item exists, nothing else matters
703 unless ( $item->{barcode} ) {
704 $issuingimpossible{UNKNOWN_BARCODE} = 1;
706 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
709 # DUE DATE is OK ? -- should already have checked.
711 if ($duedate && ref $duedate ne 'DateTime') {
712 $duedate = dt_from_string($duedate);
714 my $now = DateTime->now( time_zone => C4::Context->tz() );
715 unless ( $duedate ) {
716 my $issuedate = $now->clone();
718 my $branch = _GetCircControlBranch($item,$borrower);
719 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
720 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
722 # Offline circ calls AddIssue directly, doesn't run through here
723 # So issuingimpossible should be ok.
726 my $today = $now->clone();
727 $today->truncate( to => 'minute');
728 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
729 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
732 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
738 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
739 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
740 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'}, undef, $item->{'ccode'});
741 ModDateLastSeen( $item->{'itemnumber'} );
742 return( { STATS => 1 }, {});
744 if ( $borrower->{flags}->{GNA} ) {
745 $issuingimpossible{GNA} = 1;
747 if ( $borrower->{flags}->{'LOST'} ) {
748 $issuingimpossible{CARD_LOST} = 1;
750 if ( $borrower->{flags}->{'DBARRED'} ) {
751 $issuingimpossible{DEBARRED} = 1;
753 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
754 $issuingimpossible{EXPIRED} = 1;
756 my ($y, $m, $d) = split /-/,$borrower->{'dateexpiry'};
757 if ($y && $m && $d) { # are we really writing oinvalid dates to borrs
758 my $expiry_dt = DateTime->new(
762 time_zone => C4::Context->tz,
764 $expiry_dt->truncate( to => 'day');
765 my $today = $now->clone()->truncate(to => 'day');
766 if (DateTime->compare($today, $expiry_dt) == 1) {
767 $issuingimpossible{EXPIRED} = 1;
770 carp("Invalid expity date in borr");
771 $issuingimpossible{EXPIRED} = 1;
779 my ($balance, $non_issue_charges, $other_charges) =
780 C4::Members::GetMemberAccountBalance( $borrower->{'borrowernumber'} );
781 my $amountlimit = C4::Context->preference("noissuescharge");
782 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
783 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
784 if ( C4::Context->preference("IssuingInProcess") ) {
785 if ( $non_issue_charges > $amountlimit && !$inprocess && !$allowfineoverride) {
786 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
787 } elsif ( $non_issue_charges > $amountlimit && !$inprocess && $allowfineoverride) {
788 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
789 } elsif ( $allfinesneedoverride && $non_issue_charges > 0 && $non_issue_charges <= $amountlimit && !$inprocess ) {
790 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
794 if ( $non_issue_charges > $amountlimit && $allowfineoverride ) {
795 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
796 } elsif ( $non_issue_charges > $amountlimit && !$allowfineoverride) {
797 $issuingimpossible{DEBT} = sprintf( "%.2f", $non_issue_charges );
798 } elsif ( $non_issue_charges > 0 && $allfinesneedoverride ) {
799 $needsconfirmation{DEBT} = sprintf( "%.2f", $non_issue_charges );
802 if ($balance > 0 && $other_charges > 0) {
803 $alerts{OTHER_CHARGES} = sprintf( "%.2f", $other_charges );
806 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
807 if ($blocktype == -1) {
808 ## patron has outstanding overdue loans
809 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
810 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
812 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
813 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
815 } elsif($blocktype == 1) {
816 # patron has accrued fine days
817 $issuingimpossible{USERBLOCKEDREMAINING} = $count;
821 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
823 my ($current_loan_count, $max_loans_allowed) = TooMany( $borrower, $item->{biblionumber}, $item );
824 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
825 if (defined $max_loans_allowed && $max_loans_allowed == 0) {
826 $needsconfirmation{PATRON_CANT} = 1;
828 if($max_loans_allowed){
829 if ( C4::Context->preference("AllowTooManyOverride") ) {
830 $needsconfirmation{TOO_MANY} = 1;
831 $needsconfirmation{current_loan_count} = $current_loan_count;
832 $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
834 $issuingimpossible{TOO_MANY} = 1;
835 $issuingimpossible{current_loan_count} = $current_loan_count;
836 $issuingimpossible{max_loans_allowed} = $max_loans_allowed;
844 if ( $item->{'notforloan'} )
846 if(!C4::Context->preference("AllowNotForLoanOverride")){
847 $issuingimpossible{NOT_FOR_LOAN} = 1;
848 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
850 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
851 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
855 # we have to check itemtypes.notforloan also
856 if (C4::Context->preference('item-level_itypes')){
857 # this should probably be a subroutine
858 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
859 $sth->execute($item->{'itemtype'});
860 my $notforloan=$sth->fetchrow_hashref();
862 if ($notforloan->{'notforloan'}) {
863 if (!C4::Context->preference("AllowNotForLoanOverride")) {
864 $issuingimpossible{NOT_FOR_LOAN} = 1;
865 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
867 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
868 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
872 elsif ($biblioitem->{'notforloan'} == 1){
873 if (!C4::Context->preference("AllowNotForLoanOverride")) {
874 $issuingimpossible{NOT_FOR_LOAN} = 1;
875 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
877 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
878 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
882 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} > 0 )
884 $issuingimpossible{WTHDRAWN} = 1;
886 if ( $item->{'restricted'}
887 && $item->{'restricted'} == 1 )
889 $issuingimpossible{RESTRICTED} = 1;
891 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
892 my $code = GetAuthorisedValueByCode( 'LOST', $item->{'itemlost'} );
893 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
894 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
896 if ( C4::Context->preference("IndependentBranches") ) {
897 my $userenv = C4::Context->userenv;
898 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
899 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1
900 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
901 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
902 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
907 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
909 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
912 # Already issued to current borrower. Ask whether the loan should
914 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
915 $borrower->{'borrowernumber'},
916 $item->{'itemnumber'}
918 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
919 $issuingimpossible{NO_MORE_RENEWALS} = 1;
922 $needsconfirmation{RENEW_ISSUE} = 1;
925 elsif ($issue->{borrowernumber}) {
927 # issued to someone else
928 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
930 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
931 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
932 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
933 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
934 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
935 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
938 unless ( $ignore_reserves ) {
939 # See if the item is on reserve.
940 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
942 my $resbor = $res->{'borrowernumber'};
943 if ( $resbor ne $borrower->{'borrowernumber'} ) {
944 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
945 my $branchname = GetBranchName( $res->{'branchcode'} );
946 if ( $restype eq "Waiting" )
948 # The item is on reserve and waiting, but has been
949 # reserved by some other patron.
950 $needsconfirmation{RESERVE_WAITING} = 1;
951 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
952 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
953 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
954 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
955 $needsconfirmation{'resbranchname'} = $branchname;
956 $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
958 elsif ( $restype eq "Reserved" ) {
959 # The item is on reserve for someone else.
960 $needsconfirmation{RESERVED} = 1;
961 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
962 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
963 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
964 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
965 $needsconfirmation{'resbranchname'} = $branchname;
966 $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
972 # CHECK AGE RESTRICTION
975 # get $marker from preferences. Could be something like "FSK|PEGI|Alter|Age:"
976 my $markers = C4::Context->preference('AgeRestrictionMarker' );
977 my $bibvalues = $biblioitem->{'agerestriction'};
978 if (($markers)&&($bibvalues))
980 # Split $bibvalues to something like FSK 16 or PEGI 6
981 my @values = split ' ', $bibvalues;
983 # Search first occurence of one of the markers
984 my @markers = split /\|/, $markers;
987 for my $value (@values) {
989 for my $marker (@markers) {
990 $marker =~ s/^\s+//; #remove leading spaces
991 $marker =~ s/\s+$//; #remove trailing spaces
992 if (uc($marker) eq uc($value)) {
1001 # Index points to the next value
1002 my $restrictionyear = 0;
1003 if (($take <= $#values) && ($take >= 0)){
1004 $restrictionyear += $values[$take];
1007 if ($restrictionyear > 0) {
1008 if ( $borrower->{'dateofbirth'} ) {
1009 my @alloweddate = split /-/,$borrower->{'dateofbirth'} ;
1010 $alloweddate[0] += $restrictionyear;
1011 #Prevent runime eror on leap year (invalid date)
1012 if (($alloweddate[1] == 2) && ($alloweddate[2] == 29)) {
1013 $alloweddate[2] = 28;
1016 if ( Date_to_Days(Today) < Date_to_Days(@alloweddate) -1 ) {
1017 if (C4::Context->preference('AgeRestrictionOverride' )) {
1018 $needsconfirmation{AGE_RESTRICTION} = "$bibvalues";
1021 $issuingimpossible{AGE_RESTRICTION} = "$bibvalues";
1028 ## check for high holds decreasing loan period
1029 my $decrease_loan = C4::Context->preference('decreaseLoanHighHolds');
1030 if ( $decrease_loan && $decrease_loan == 1 ) {
1031 my ( $reserved, $num, $duration, $returndate ) =
1032 checkHighHolds( $item, $borrower );
1034 if ( $num >= C4::Context->preference('decreaseLoanHighHoldsValue') ) {
1035 $needsconfirmation{HIGHHOLDS} = {
1037 duration => $duration,
1038 returndate => output_pref($returndate),
1043 return ( \%issuingimpossible, \%needsconfirmation, \%alerts );
1046 =head2 CanBookBeReturned
1048 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1050 Check whether the item can be returned to the provided branch
1054 =item C<$item> is a hash of item information as returned from GetItem
1056 =item C<$branch> is the branchcode where the return is taking place
1064 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1066 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1072 sub CanBookBeReturned {
1073 my ($item, $branch) = @_;
1074 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1076 # assume return is allowed to start
1080 # identify all cases where return is forbidden
1081 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1083 $message = $item->{'homebranch'};
1084 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1086 $message = $item->{'holdingbranch'};
1087 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1089 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1092 return ($allowed, $message);
1095 =head2 CheckHighHolds
1097 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1098 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1099 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1103 sub checkHighHolds {
1104 my ( $item, $borrower ) = @_;
1105 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1106 my $branch = _GetCircControlBranch( $item, $borrower );
1107 my $dbh = C4::Context->dbh;
1108 my $sth = $dbh->prepare(
1109 'select count(borrowernumber) as num_holds from reserves where biblionumber=?'
1111 $sth->execute( $item->{'biblionumber'} );
1112 my ($holds) = $sth->fetchrow_array;
1114 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1116 my $calendar = Koha::Calendar->new( branchcode => $branch );
1119 ( C4::Context->preference('item-level_itypes') )
1120 ? $biblio->{'itype'}
1121 : $biblio->{'itemtype'};
1123 C4::Circulation::CalcDateDue( $issuedate, $itype, $branch,
1126 my $reduced_datedue =
1127 $calendar->addDate( $issuedate,
1128 C4::Context->preference('decreaseLoanHighHoldsDuration') );
1130 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1132 C4::Context->preference('decreaseLoanHighHoldsDuration'),
1136 return ( 0, 0, 0, undef );
1141 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1143 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1147 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1149 =item C<$barcode> is the barcode of the item being issued.
1151 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
1152 Calculated if empty.
1154 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1156 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1157 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
1159 AddIssue does the following things :
1161 - step 01: check that there is a borrowernumber & a barcode provided
1162 - check for RENEWAL (book issued & being issued to the same patron)
1163 - renewal YES = Calculate Charge & renew
1165 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1167 - fill reserve if reserve to this patron
1168 - cancel reserve or not, otherwise
1169 * TRANSFERT PENDING ?
1170 - complete the transfert
1178 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
1179 my $dbh = C4::Context->dbh;
1180 my $barcodecheck=CheckValidBarcode($barcode);
1181 if ($datedue && ref $datedue ne 'DateTime') {
1182 $datedue = dt_from_string($datedue);
1184 # $issuedate defaults to today.
1185 if ( ! defined $issuedate ) {
1186 $issuedate = DateTime->now(time_zone => C4::Context->tz());
1189 if ( ref $issuedate ne 'DateTime') {
1190 $issuedate = dt_from_string($issuedate);
1194 if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1195 # find which item we issue
1196 my $item = GetItem('', $barcode) or return; # if we don't get an Item, abort.
1197 my $branch = _GetCircControlBranch($item,$borrower);
1199 # get actual issuing if there is one
1200 my $actualissue = GetItemIssue( $item->{itemnumber});
1202 # get biblioinformation for this item
1203 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
1206 # check if we just renew the issue.
1208 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
1209 $datedue = AddRenewal(
1210 $borrower->{'borrowernumber'},
1211 $item->{'itemnumber'},
1214 $issuedate, # here interpreted as the renewal date
1218 # it's NOT a renewal
1219 if ( $actualissue->{borrowernumber}) {
1220 # This book is currently on loan, but not to the person
1221 # who wants to borrow it now. mark it returned before issuing to the new borrower
1224 C4::Context->userenv->{'branch'}
1228 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1229 # Starting process for transfer job (checking transfert and validate it if we have one)
1230 my ($datesent) = GetTransfers($item->{'itemnumber'});
1232 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1235 "UPDATE branchtransfers
1236 SET datearrived = now(),
1238 comments = 'Forced branchtransfer'
1239 WHERE itemnumber= ? AND datearrived IS NULL"
1241 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1244 # Record in the database the fact that the book was issued.
1248 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1252 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1253 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1256 $datedue->truncate( to => 'minute');
1258 $borrower->{'borrowernumber'}, # borrowernumber
1259 $item->{'itemnumber'}, # itemnumber
1260 $issuedate->strftime('%Y-%m-%d %H:%M:00'), # issuedate
1261 $datedue->strftime('%Y-%m-%d %H:%M:00'), # date_due
1262 C4::Context->userenv->{'branch'} # branchcode
1264 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1265 CartToShelf( $item->{'itemnumber'} );
1267 $item->{'issues'}++;
1268 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1269 UpdateTotalIssues($item->{'biblionumber'}, 1);
1272 ## If item was lost, it has now been found, reverse any list item charges if neccessary.
1273 if ( $item->{'itemlost'} ) {
1274 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1275 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1279 ModItem({ issues => $item->{'issues'},
1280 holdingbranch => C4::Context->userenv->{'branch'},
1282 datelastborrowed => DateTime->now(time_zone => C4::Context->tz())->ymd(),
1283 onloan => $datedue->ymd(),
1284 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1285 ModDateLastSeen( $item->{'itemnumber'} );
1287 # If it costs to borrow this book, charge it to the patron's account.
1288 my ( $charge, $itemtype ) = GetIssuingCharges(
1289 $item->{'itemnumber'},
1290 $borrower->{'borrowernumber'}
1292 if ( $charge > 0 ) {
1294 $item->{'itemnumber'},
1295 $borrower->{'borrowernumber'}, $charge
1297 $item->{'charge'} = $charge;
1300 # Record the fact that this book was issued.
1302 C4::Context->userenv->{'branch'},
1304 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1305 $item->{'itype'}, $borrower->{'borrowernumber'}, undef, $item->{'ccode'}
1308 # Send a checkout slip.
1309 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1311 branchcode => $branch,
1312 categorycode => $borrower->{categorycode},
1313 item_type => $item->{itype},
1314 notification => 'CHECKOUT',
1316 if ($circulation_alert->is_enabled_for(\%conditions)) {
1317 SendCirculationAlert({
1320 borrower => $borrower,
1326 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'itemnumber'})
1327 if C4::Context->preference("IssueLog");
1329 return ($datedue); # not necessarily the same as when it came in!
1332 =head2 GetLoanLength
1334 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1336 Get loan length for an itemtype, a borrower type and a branch
1341 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1342 my $dbh = C4::Context->dbh;
1343 my $sth = $dbh->prepare(qq{
1344 SELECT issuelength, lengthunit, renewalperiod
1346 WHERE categorycode=?
1349 AND issuelength IS NOT NULL
1352 # try to find issuelength & return the 1st available.
1353 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1354 $sth->execute( $borrowertype, $itemtype, $branchcode );
1355 my $loanlength = $sth->fetchrow_hashref;
1358 if defined($loanlength) && $loanlength->{issuelength};
1360 $sth->execute( $borrowertype, '*', $branchcode );
1361 $loanlength = $sth->fetchrow_hashref;
1363 if defined($loanlength) && $loanlength->{issuelength};
1365 $sth->execute( '*', $itemtype, $branchcode );
1366 $loanlength = $sth->fetchrow_hashref;
1368 if defined($loanlength) && $loanlength->{issuelength};
1370 $sth->execute( '*', '*', $branchcode );
1371 $loanlength = $sth->fetchrow_hashref;
1373 if defined($loanlength) && $loanlength->{issuelength};
1375 $sth->execute( $borrowertype, $itemtype, '*' );
1376 $loanlength = $sth->fetchrow_hashref;
1378 if defined($loanlength) && $loanlength->{issuelength};
1380 $sth->execute( $borrowertype, '*', '*' );
1381 $loanlength = $sth->fetchrow_hashref;
1383 if defined($loanlength) && $loanlength->{issuelength};
1385 $sth->execute( '*', $itemtype, '*' );
1386 $loanlength = $sth->fetchrow_hashref;
1388 if defined($loanlength) && $loanlength->{issuelength};
1390 $sth->execute( '*', '*', '*' );
1391 $loanlength = $sth->fetchrow_hashref;
1393 if defined($loanlength) && $loanlength->{issuelength};
1395 # if no rule is set => 21 days (hardcoded)
1398 renewalperiod => 21,
1399 lengthunit => 'days',
1405 =head2 GetHardDueDate
1407 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1409 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1413 sub GetHardDueDate {
1414 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1416 my $rule = GetIssuingRule( $borrowertype, $itemtype, $branchcode );
1418 if ( defined( $rule ) ) {
1419 if ( $rule->{hardduedate} ) {
1420 return (dt_from_string($rule->{hardduedate}, 'iso'),$rule->{hardduedatecompare});
1422 return (undef, undef);
1427 =head2 GetIssuingRule
1429 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1431 FIXME - This is a copy-paste of GetLoanLength
1432 as a stop-gap. Do not wish to change API for GetLoanLength
1433 this close to release.
1435 Get the issuing rule for an itemtype, a borrower type and a branch
1436 Returns a hashref from the issuingrules table.
1440 sub GetIssuingRule {
1441 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1442 my $dbh = C4::Context->dbh;
1443 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1446 $sth->execute( $borrowertype, $itemtype, $branchcode );
1447 $irule = $sth->fetchrow_hashref;
1448 return $irule if defined($irule) ;
1450 $sth->execute( $borrowertype, "*", $branchcode );
1451 $irule = $sth->fetchrow_hashref;
1452 return $irule if defined($irule) ;
1454 $sth->execute( "*", $itemtype, $branchcode );
1455 $irule = $sth->fetchrow_hashref;
1456 return $irule if defined($irule) ;
1458 $sth->execute( "*", "*", $branchcode );
1459 $irule = $sth->fetchrow_hashref;
1460 return $irule if defined($irule) ;
1462 $sth->execute( $borrowertype, $itemtype, "*" );
1463 $irule = $sth->fetchrow_hashref;
1464 return $irule if defined($irule) ;
1466 $sth->execute( $borrowertype, "*", "*" );
1467 $irule = $sth->fetchrow_hashref;
1468 return $irule if defined($irule) ;
1470 $sth->execute( "*", $itemtype, "*" );
1471 $irule = $sth->fetchrow_hashref;
1472 return $irule if defined($irule) ;
1474 $sth->execute( "*", "*", "*" );
1475 $irule = $sth->fetchrow_hashref;
1476 return $irule if defined($irule) ;
1478 # if no rule matches,
1482 =head2 GetBranchBorrowerCircRule
1484 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1486 Retrieves circulation rule attributes that apply to the given
1487 branch and patron category, regardless of item type.
1488 The return value is a hashref containing the following key:
1490 maxissueqty - maximum number of loans that a
1491 patron of the given category can have at the given
1492 branch. If the value is undef, no limit.
1494 This will first check for a specific branch and
1495 category match from branch_borrower_circ_rules.
1497 If no rule is found, it will then check default_branch_circ_rules
1498 (same branch, default category). If no rule is found,
1499 it will then check default_borrower_circ_rules (default
1500 branch, same category), then failing that, default_circ_rules
1501 (default branch, default category).
1503 If no rule has been found in the database, it will default to
1508 C<$branchcode> and C<$categorycode> should contain the
1509 literal branch code and patron category code, respectively - no
1514 sub GetBranchBorrowerCircRule {
1515 my $branchcode = shift;
1516 my $categorycode = shift;
1518 my $branch_cat_query = "SELECT maxissueqty
1519 FROM branch_borrower_circ_rules
1520 WHERE branchcode = ?
1521 AND categorycode = ?";
1522 my $dbh = C4::Context->dbh();
1523 my $sth = $dbh->prepare($branch_cat_query);
1524 $sth->execute($branchcode, $categorycode);
1526 if ($result = $sth->fetchrow_hashref()) {
1530 # try same branch, default borrower category
1531 my $branch_query = "SELECT maxissueqty
1532 FROM default_branch_circ_rules
1533 WHERE branchcode = ?";
1534 $sth = $dbh->prepare($branch_query);
1535 $sth->execute($branchcode);
1536 if ($result = $sth->fetchrow_hashref()) {
1540 # try default branch, same borrower category
1541 my $category_query = "SELECT maxissueqty
1542 FROM default_borrower_circ_rules
1543 WHERE categorycode = ?";
1544 $sth = $dbh->prepare($category_query);
1545 $sth->execute($categorycode);
1546 if ($result = $sth->fetchrow_hashref()) {
1550 # try default branch, default borrower category
1551 my $default_query = "SELECT maxissueqty
1552 FROM default_circ_rules";
1553 $sth = $dbh->prepare($default_query);
1555 if ($result = $sth->fetchrow_hashref()) {
1559 # built-in default circulation rule
1561 maxissueqty => undef,
1565 =head2 GetBranchItemRule
1567 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1569 Retrieves circulation rule attributes that apply to the given
1570 branch and item type, regardless of patron category.
1572 The return value is a hashref containing the following keys:
1574 holdallowed => Hold policy for this branch and itemtype. Possible values:
1575 0: No holds allowed.
1576 1: Holds allowed only by patrons that have the same homebranch as the item.
1577 2: Holds allowed from any patron.
1579 returnbranch => branch to which to return item. Possible values:
1580 noreturn: do not return, let item remain where checked in (floating collections)
1581 homebranch: return to item's home branch
1583 This searches branchitemrules in the following order:
1585 * Same branchcode and itemtype
1586 * Same branchcode, itemtype '*'
1587 * branchcode '*', same itemtype
1588 * branchcode and itemtype '*'
1590 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1594 sub GetBranchItemRule {
1595 my ( $branchcode, $itemtype ) = @_;
1596 my $dbh = C4::Context->dbh();
1600 ['SELECT holdallowed, returnbranch
1601 FROM branch_item_rules
1602 WHERE branchcode = ?
1603 AND itemtype = ?', $branchcode, $itemtype],
1604 ['SELECT holdallowed, returnbranch
1605 FROM default_branch_circ_rules
1606 WHERE branchcode = ?', $branchcode],
1607 ['SELECT holdallowed, returnbranch
1608 FROM default_branch_item_rules
1609 WHERE itemtype = ?', $itemtype],
1610 ['SELECT holdallowed, returnbranch
1611 FROM default_circ_rules'],
1614 foreach my $attempt (@attempts) {
1615 my ($query, @bind_params) = @{$attempt};
1616 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1619 # Since branch/category and branch/itemtype use the same per-branch
1620 # defaults tables, we have to check that the key we want is set, not
1621 # just that a row was returned
1622 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1623 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1626 # built-in default circulation rule
1627 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1628 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1635 ($doreturn, $messages, $iteminformation, $borrower) =
1636 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1642 =item C<$barcode> is the bar code of the book being returned.
1644 =item C<$branch> is the code of the branch where the book is being returned.
1646 =item C<$exemptfine> indicates that overdue charges for the item will be
1649 =item C<$dropbox> indicates that the check-in date is assumed to be
1650 yesterday, or the last non-holiday as defined in C4::Calendar . If
1651 overdue charges are applied and C<$dropbox> is true, the last charge
1652 will be removed. This assumes that the fines accrual script has run
1657 C<&AddReturn> returns a list of four items:
1659 C<$doreturn> is true iff the return succeeded.
1661 C<$messages> is a reference-to-hash giving feedback on the operation.
1662 The keys of the hash are:
1668 No item with this barcode exists. The value is C<$barcode>.
1672 The book is not currently on loan. The value is C<$barcode>.
1674 =item C<IsPermanent>
1676 The book's home branch is a permanent collection. If you have borrowed
1677 this book, you are not allowed to return it. The value is the code for
1678 the book's home branch.
1682 This book has been withdrawn/cancelled. The value should be ignored.
1684 =item C<Wrongbranch>
1686 This book has was returned to the wrong branch. The value is a hashref
1687 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1688 contain the branchcode of the incorrect and correct return library, respectively.
1692 The item was reserved. The value is a reference-to-hash whose keys are
1693 fields from the reserves table of the Koha database, and
1694 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1695 either C<Waiting>, C<Reserved>, or 0.
1699 C<$iteminformation> is a reference-to-hash, giving information about the
1700 returned item from the issues table.
1702 C<$borrower> is a reference-to-hash, giving information about the
1703 patron who last borrowed the book.
1708 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1710 if ($branch and not GetBranchDetail($branch)) {
1711 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1714 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1719 my $validTransfert = 0;
1720 my $stat_type = 'return';
1722 # get information on item
1723 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1724 unless ($itemnumber) {
1725 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1727 my $issue = GetItemIssue($itemnumber);
1728 # warn Dumper($iteminformation);
1729 if ($issue and $issue->{borrowernumber}) {
1730 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1731 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1732 . Dumper($issue) . "\n";
1734 $messages->{'NotIssued'} = $barcode;
1735 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1737 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1738 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1739 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1740 $messages->{'LocalUse'} = 1;
1741 $stat_type = 'localuse';
1745 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1746 # full item data, but no borrowernumber or checkout info (no issue)
1747 # we know GetItem should work because GetItemnumberFromBarcode worked
1748 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1749 # get the proper branch to which to return the item
1750 $hbr = $item->{$hbr} || $branch ;
1751 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1753 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1755 # check if the book is in a permanent collection....
1756 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1758 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1759 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1762 # check if the return is allowed at this branch
1763 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1764 unless ($returnallowed){
1765 $messages->{'Wrongbranch'} = {
1766 Wrongbranch => $branch,
1767 Rightbranch => $message
1770 return ( $doreturn, $messages, $issue, $borrower );
1773 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1774 $messages->{'wthdrawn'} = 1;
1775 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1778 # case of a return of document (deal with issues and holdingbranch)
1779 my $today = DateTime->now( time_zone => C4::Context->tz() );
1781 my $datedue = $issue->{date_due};
1782 $borrower or warn "AddReturn without current borrower";
1783 my $circControlBranch;
1785 # define circControlBranch only if dropbox mode is set
1786 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1787 # FIXME: check issuedate > returndate, factoring in holidays
1788 #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1789 $circControlBranch = _GetCircControlBranch($item,$borrower);
1790 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $today ) == -1 ? 1 : 0;
1793 if ($borrowernumber) {
1794 if( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'}){
1795 # we only need to calculate and change the fines if we want to do that on return
1796 # Should be on for hourly loans
1797 my $control = C4::Context->preference('CircControl');
1798 my $control_branchcode =
1799 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
1800 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
1801 : $issue->{branchcode};
1803 my ( $amount, $type, $unitcounttotal ) =
1804 C4::Overdues::CalcFine( $item, $borrower->{categorycode},
1805 $control_branchcode, $datedue, $today );
1810 && C4::Context->preference('finesMode') eq 'production' )
1812 C4::Overdues::UpdateFine( $issue->{itemnumber},
1813 $issue->{borrowernumber},
1814 $amount, $type, output_pref($datedue) );
1818 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1819 $circControlBranch, '', $borrower->{'privacy'} );
1821 # FIXME is the "= 1" right? This could be the borrower hash.
1822 $messages->{'WasReturned'} = 1;
1826 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1829 # the holdingbranch is updated if the document is returned to another location.
1830 # this is always done regardless of whether the item was on loan or not
1831 if ($item->{'holdingbranch'} ne $branch) {
1832 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1833 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1835 ModDateLastSeen( $item->{'itemnumber'} );
1837 # check if we have a transfer for this document
1838 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1840 # if we have a transfer to do, we update the line of transfers with the datearrived
1842 if ( $tobranch eq $branch ) {
1843 my $sth = C4::Context->dbh->prepare(
1844 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1846 $sth->execute( $item->{'itemnumber'} );
1847 # if we have a reservation with valid transfer, we can set it's status to 'W'
1848 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1849 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1851 $messages->{'WrongTransfer'} = $tobranch;
1852 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1854 $validTransfert = 1;
1856 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1859 # fix up the accounts.....
1860 if ( $item->{'itemlost'} ) {
1861 $messages->{'WasLost'} = 1;
1863 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1864 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1865 $messages->{'LostItemFeeRefunded'} = 1;
1869 # fix up the overdues in accounts...
1870 if ($borrowernumber) {
1871 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1872 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1874 if ( $issue->{overdue} && $issue->{date_due} ) {
1877 _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1878 $messages->{Debarred} = $debardate if ($debardate);
1882 # find reserves.....
1883 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1884 my ($resfound, $resrec);
1885 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'} ) unless ( $item->{'wthdrawn'} );
1887 $resrec->{'ResFound'} = $resfound;
1888 $messages->{'ResFound'} = $resrec;
1892 # Record the fact that this book was returned.
1894 $branch, $stat_type, '0', '',
1895 $item->{'itemnumber'},
1896 $biblio->{'itemtype'},
1897 $borrowernumber, undef, $item->{'ccode'}
1900 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1901 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1903 branchcode => $branch,
1904 categorycode => $borrower->{categorycode},
1905 item_type => $item->{itype},
1906 notification => 'CHECKIN',
1908 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1909 SendCirculationAlert({
1912 borrower => $borrower,
1917 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
1918 if C4::Context->preference("ReturnLog");
1920 # FIXME: make this comment intelligible.
1921 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1922 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1924 if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
1925 if ( C4::Context->preference("AutomaticItemReturn" ) or
1926 (C4::Context->preference("UseBranchTransferLimits") and
1927 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1929 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1930 $debug and warn "item: " . Dumper($item);
1931 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1932 $messages->{'WasTransfered'} = 1;
1934 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1937 return ( $doreturn, $messages, $issue, $borrower );
1940 =head2 MarkIssueReturned
1942 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1944 Unconditionally marks an issue as being returned by
1945 moving the C<issues> row to C<old_issues> and
1946 setting C<returndate> to the current date, or
1947 the last non-holiday date of the branccode specified in
1948 C<dropbox_branch> . Assumes you've already checked that
1949 it's safe to do this, i.e. last non-holiday > issuedate.
1951 if C<$returndate> is specified (in iso format), it is used as the date
1952 of the return. It is ignored when a dropbox_branch is passed in.
1954 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1955 the old_issue is immediately anonymised
1957 Ideally, this function would be internal to C<C4::Circulation>,
1958 not exported, but it is currently needed by one
1959 routine in C<C4::Accounts>.
1963 sub MarkIssueReturned {
1964 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1966 my $dbh = C4::Context->dbh;
1967 my $query = 'UPDATE issues SET returndate=';
1969 if ($dropbox_branch) {
1970 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
1971 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
1973 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
1974 } elsif ($returndate) {
1976 push @bind, $returndate;
1978 $query .= ' now() ';
1980 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
1981 push @bind, $borrowernumber, $itemnumber;
1983 my $sth_upd = $dbh->prepare($query);
1984 $sth_upd->execute(@bind);
1985 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
1986 WHERE borrowernumber = ?
1987 AND itemnumber = ?');
1988 $sth_copy->execute($borrowernumber, $itemnumber);
1989 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
1990 if ( $privacy == 2) {
1991 # The default of 0 does not work due to foreign key constraints
1992 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
1993 # FIXME the above is unacceptable - bug 9942 relates
1994 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
1995 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
1996 WHERE borrowernumber = ?
1997 AND itemnumber = ?");
1998 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
2000 my $sth_del = $dbh->prepare("DELETE FROM issues
2001 WHERE borrowernumber = ?
2002 AND itemnumber = ?");
2003 $sth_del->execute($borrowernumber, $itemnumber);
2006 =head2 _debar_user_on_return
2008 _debar_user_on_return($borrower, $item, $datedue, today);
2010 C<$borrower> borrower hashref
2012 C<$item> item hashref
2014 C<$datedue> date due DateTime object
2016 C<$today> DateTime object representing the return time
2018 Internal function, called only by AddReturn that calculates and updates
2019 the user fine days, and debars him if necessary.
2021 Should only be called for overdue returns
2025 sub _debar_user_on_return {
2026 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2028 my $branchcode = _GetCircControlBranch( $item, $borrower );
2029 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
2031 # $deltadays is a DateTime::Duration object
2032 my $deltadays = $calendar->days_between( $dt_due, $dt_today );
2034 my $circcontrol = C4::Context->preference('CircControl');
2036 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2037 my $finedays = $issuingrule->{finedays};
2038 my $unit = $issuingrule->{lengthunit};
2042 # finedays is in days, so hourly loans must multiply by 24
2043 # thus 1 hour late equals 1 day suspension * finedays rate
2044 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2046 # grace period is measured in the same units as the loan
2048 DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2049 if ( $deltadays->subtract($grace)->is_positive() ) {
2052 $dt_today->clone()->add_duration( $deltadays * $finedays );
2053 if ( $borrower->{debarred} ) {
2054 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2056 # Update patron only if new date > old
2057 if ( DateTime->compare( $borrower_debar_dt, $new_debar_dt ) !=
2064 C4::Members::DebarMember( $borrower->{borrowernumber},
2065 $new_debar_dt->ymd() );
2066 return $new_debar_dt->ymd();
2072 =head2 _FixOverduesOnReturn
2074 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2076 C<$brn> borrowernumber
2080 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2081 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2083 Internal function, called only by AddReturn
2087 sub _FixOverduesOnReturn {
2088 my ($borrowernumber, $item);
2089 unless ($borrowernumber = shift) {
2090 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2093 unless ($item = shift) {
2094 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2097 my ($exemptfine, $dropbox) = @_;
2098 my $dbh = C4::Context->dbh;
2100 # check for overdue fine
2101 my $sth = $dbh->prepare(
2102 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2104 $sth->execute( $borrowernumber, $item );
2106 # alter fine to show that the book has been returned
2107 my $data = $sth->fetchrow_hashref;
2108 return 0 unless $data; # no warning, there's just nothing to fix
2111 my @bind = ($data->{'accountlines_id'});
2113 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2114 if (C4::Context->preference("FinesLog")) {
2115 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2117 } elsif ($dropbox && $data->{lastincrement}) {
2118 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2119 my $amt = $data->{amount} - $data->{lastincrement} ;
2120 if (C4::Context->preference("FinesLog")) {
2121 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2123 $uquery = "update accountlines set accounttype='F' ";
2124 if($outstanding >= 0 && $amt >=0) {
2125 $uquery .= ", amount = ? , amountoutstanding=? ";
2126 unshift @bind, ($amt, $outstanding) ;
2129 $uquery = "update accountlines set accounttype='F' ";
2131 $uquery .= " where (accountlines_id = ?)";
2132 my $usth = $dbh->prepare($uquery);
2133 return $usth->execute(@bind);
2136 =head2 _FixAccountForLostAndReturned
2138 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2140 Calculates the charge for a book lost and returned.
2142 Internal function, not exported, called only by AddReturn.
2144 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2145 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2149 sub _FixAccountForLostAndReturned {
2150 my $itemnumber = shift or return;
2151 my $borrowernumber = @_ ? shift : undef;
2152 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2153 my $dbh = C4::Context->dbh;
2154 # check for charge made for lost book
2155 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2156 $sth->execute($itemnumber);
2157 my $data = $sth->fetchrow_hashref;
2158 $data or return; # bail if there is nothing to do
2159 $data->{accounttype} eq 'W' and return; # Written off
2161 # writeoff this amount
2163 my $amount = $data->{'amount'};
2164 my $acctno = $data->{'accountno'};
2165 my $amountleft; # Starts off undef/zero.
2166 if ($data->{'amountoutstanding'} == $amount) {
2167 $offset = $data->{'amount'};
2168 $amountleft = 0; # Hey, it's zero here, too.
2170 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2171 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2173 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2174 WHERE (accountlines_id = ?)");
2175 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2176 #check if any credit is left if so writeoff other accounts
2177 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2178 $amountleft *= -1 if ($amountleft < 0);
2179 if ($amountleft > 0) {
2180 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2181 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2182 $msth->execute($data->{'borrowernumber'});
2183 # offset transactions
2186 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2187 if ($accdata->{'amountoutstanding'} < $amountleft) {
2189 $amountleft -= $accdata->{'amountoutstanding'};
2191 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2194 my $thisacct = $accdata->{'accountlines_id'};
2195 # FIXME: move prepares outside while loop!
2196 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2197 WHERE (accountlines_id = ?)");
2198 $usth->execute($newamtos,$thisacct);
2199 $usth = $dbh->prepare("INSERT INTO accountoffsets
2200 (borrowernumber, accountno, offsetaccount, offsetamount)
2203 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2205 $msth->finish; # $msth might actually have data left
2207 $amountleft *= -1 if ($amountleft > 0);
2208 my $desc = "Item Returned " . $item_id;
2209 $usth = $dbh->prepare("INSERT INTO accountlines
2210 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2211 VALUES (?,?,now(),?,?,'CR',?)");
2212 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2213 if ($borrowernumber) {
2214 # FIXME: same as query above. use 1 sth for both
2215 $usth = $dbh->prepare("INSERT INTO accountoffsets
2216 (borrowernumber, accountno, offsetaccount, offsetamount)
2218 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2220 ModItem({ paidfor => '' }, undef, $itemnumber);
2224 =head2 _GetCircControlBranch
2226 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2230 Return the library code to be used to determine which circulation
2231 policy applies to a transaction. Looks up the CircControl and
2232 HomeOrHoldingBranch system preferences.
2234 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2236 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2240 sub _GetCircControlBranch {
2241 my ($item, $borrower) = @_;
2242 my $circcontrol = C4::Context->preference('CircControl');
2245 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2246 $branch= C4::Context->userenv->{'branch'};
2247 } elsif ($circcontrol eq 'PatronLibrary') {
2248 $branch=$borrower->{branchcode};
2250 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2251 $branch = $item->{$branchfield};
2252 # default to item home branch if holdingbranch is used
2253 # and is not defined
2254 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2255 $branch = $item->{homebranch};
2268 $issue = &GetItemIssue($itemnumber);
2270 Returns patron currently having a book, or undef if not checked out.
2272 C<$itemnumber> is the itemnumber.
2274 C<$issue> is a hashref of the row from the issues table.
2279 my ($itemnumber) = @_;
2280 return unless $itemnumber;
2281 my $sth = C4::Context->dbh->prepare(
2282 "SELECT items.*, issues.*
2284 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2285 WHERE issues.itemnumber=?");
2286 $sth->execute($itemnumber);
2287 my $data = $sth->fetchrow_hashref;
2288 return unless $data;
2289 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2290 $data->{issuedate}->truncate(to => 'minute');
2291 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2292 $data->{date_due}->truncate(to => 'minute');
2293 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2294 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2300 $issue = GetOpenIssue( $itemnumber );
2302 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2304 C<$itemnumber> is the item's itemnumber
2311 my ( $itemnumber ) = @_;
2313 my $dbh = C4::Context->dbh;
2314 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2315 $sth->execute( $itemnumber );
2316 my $issue = $sth->fetchrow_hashref();
2320 =head2 GetItemIssues
2322 $issues = &GetItemIssues($itemnumber, $history);
2324 Returns patrons that have issued a book
2326 C<$itemnumber> is the itemnumber
2327 C<$history> is false if you just want the current "issuer" (if any)
2328 and true if you want issues history from old_issues also.
2330 Returns reference to an array of hashes
2335 my ( $itemnumber, $history ) = @_;
2337 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2338 $today->truncate( to => 'minute' );
2339 my $sql = "SELECT * FROM issues
2340 JOIN borrowers USING (borrowernumber)
2341 JOIN items USING (itemnumber)
2342 WHERE issues.itemnumber = ? ";
2345 SELECT * FROM old_issues
2346 LEFT JOIN borrowers USING (borrowernumber)
2347 JOIN items USING (itemnumber)
2348 WHERE old_issues.itemnumber = ? ";
2350 $sql .= "ORDER BY date_due DESC";
2351 my $sth = C4::Context->dbh->prepare($sql);
2353 $sth->execute($itemnumber, $itemnumber);
2355 $sth->execute($itemnumber);
2357 my $results = $sth->fetchall_arrayref({});
2358 foreach (@$results) {
2359 my $date_due = dt_from_string($_->{date_due},'sql');
2360 $date_due->truncate( to => 'minute' );
2362 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2367 =head2 GetBiblioIssues
2369 $issues = GetBiblioIssues($biblionumber);
2371 this function get all issues from a biblionumber.
2374 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2375 tables issues and the firstname,surname & cardnumber from borrowers.
2379 sub GetBiblioIssues {
2380 my $biblionumber = shift;
2381 return unless $biblionumber;
2382 my $dbh = C4::Context->dbh;
2384 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2386 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2387 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2388 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2389 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2390 WHERE biblio.biblionumber = ?
2392 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2394 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2395 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2396 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2397 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2398 WHERE biblio.biblionumber = ?
2401 my $sth = $dbh->prepare($query);
2402 $sth->execute($biblionumber, $biblionumber);
2405 while ( my $data = $sth->fetchrow_hashref ) {
2406 push @issues, $data;
2411 =head2 GetUpcomingDueIssues
2413 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2417 sub GetUpcomingDueIssues {
2420 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2421 my $dbh = C4::Context->dbh;
2423 my $statement = <<END_SQL;
2424 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2426 LEFT JOIN items USING (itemnumber)
2427 LEFT OUTER JOIN branches USING (branchcode)
2428 WhERE returndate is NULL
2429 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
2432 my @bind_parameters = ( $params->{'days_in_advance'} );
2434 my $sth = $dbh->prepare( $statement );
2435 $sth->execute( @bind_parameters );
2436 my $upcoming_dues = $sth->fetchall_arrayref({});
2439 return $upcoming_dues;
2442 =head2 CanBookBeRenewed
2444 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2446 Find out whether a borrowed item may be renewed.
2448 C<$borrowernumber> is the borrower number of the patron who currently
2449 has the item on loan.
2451 C<$itemnumber> is the number of the item to renew.
2453 C<$override_limit>, if supplied with a true value, causes
2454 the limit on the number of times that the loan can be renewed
2455 (as controlled by the item type) to be ignored.
2457 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2458 item must currently be on loan to the specified borrower; renewals
2459 must be allowed for the item's type; and the borrower must not have
2460 already renewed the loan. $error will contain the reason the renewal can not proceed
2464 sub CanBookBeRenewed {
2466 # check renewal status
2467 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2468 my $dbh = C4::Context->dbh;
2473 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return;
2474 my $item = GetItem($itemnumber) or return;
2475 my $itemissue = GetItemIssue($itemnumber) or return;
2477 my $branchcode = _GetCircControlBranch($item, $borrower);
2479 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2481 if ( ( $issuingrule->{renewalsallowed} > $itemissue->{renewals} ) || $override_limit ) {
2484 $error = "too_many";
2487 my $resstatus = C4::Reserves::GetReserveStatus($itemnumber);
2488 if ( $resstatus eq "Waiting" or $resstatus eq "Reserved" ) {
2490 $error = "on_reserve";
2493 return ( $renewokay, $error );
2498 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2502 C<$borrowernumber> is the borrower number of the patron who currently
2505 C<$itemnumber> is the number of the item to renew.
2507 C<$branch> is the library where the renewal took place (if any).
2508 The library that controls the circ policies for the renewal is retrieved from the issues record.
2510 C<$datedue> can be a C4::Dates object used to set the due date.
2512 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2513 this parameter is not supplied, lastreneweddate is set to the current date.
2515 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2516 from the book's item type.
2521 my $borrowernumber = shift or return;
2522 my $itemnumber = shift or return;
2524 my $datedue = shift;
2525 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2526 my $item = GetItem($itemnumber) or return;
2527 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2529 my $dbh = C4::Context->dbh;
2530 # Find the issues record for this book
2532 $dbh->prepare("SELECT * FROM issues
2533 WHERE borrowernumber=?
2536 $sth->execute( $borrowernumber, $itemnumber );
2537 my $issuedata = $sth->fetchrow_hashref;
2539 if(defined $datedue && ref $datedue ne 'DateTime' ) {
2540 carp 'Invalid date passed to AddRenewal.';
2543 # If the due date wasn't specified, calculate it by adding the
2544 # book's loan length to today's date or the current due date
2545 # based on the value of the RenewalPeriodBase syspref.
2548 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2549 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2551 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2552 dt_from_string( $issuedata->{date_due} ) :
2553 DateTime->now( time_zone => C4::Context->tz());
2554 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2557 # Update the issues record to have the new due date, and a new count
2558 # of how many times it has been renewed.
2559 my $renews = $issuedata->{'renewals'} + 1;
2560 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2561 WHERE borrowernumber=?
2565 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2568 # Update the renewal count on the item, and tell zebra to reindex
2569 $renews = $biblio->{'renewals'} + 1;
2570 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2572 # Charge a new rental fee, if applicable?
2573 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2574 if ( $charge > 0 ) {
2575 my $accountno = getnextacctno( $borrowernumber );
2576 my $item = GetBiblioFromItemNumber($itemnumber);
2578 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2579 $sth = $dbh->prepare(
2580 "INSERT INTO accountlines
2581 (date, borrowernumber, accountno, amount, manager_id,
2582 description,accounttype, amountoutstanding, itemnumber)
2583 VALUES (now(),?,?,?,?,?,?,?,?)"
2585 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2586 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2587 'Rent', $charge, $itemnumber );
2590 # Send a renewal slip according to checkout alert preferencei
2591 if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2592 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2593 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2595 branchcode => $branch,
2596 categorycode => $borrower->{categorycode},
2597 item_type => $item->{itype},
2598 notification => 'CHECKOUT',
2600 if ($circulation_alert->is_enabled_for(\%conditions)) {
2601 SendCirculationAlert({
2604 borrower => $borrower,
2611 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber, undef, $item->{'ccode'});
2616 # check renewal status
2617 my ( $bornum, $itemno ) = @_;
2618 my $dbh = C4::Context->dbh;
2620 my $renewsallowed = 0;
2623 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2624 my $item = GetItem($itemno);
2626 # Look in the issues table for this item, lent to this borrower,
2627 # and not yet returned.
2629 # FIXME - I think this function could be redone to use only one SQL call.
2630 my $sth = $dbh->prepare(
2631 "select * from issues
2632 where (borrowernumber = ?)
2633 and (itemnumber = ?)"
2635 $sth->execute( $bornum, $itemno );
2636 my $data = $sth->fetchrow_hashref;
2637 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2639 # $item and $borrower should be calculated
2640 my $branchcode = _GetCircControlBranch($item, $borrower);
2642 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2644 $renewsallowed = $issuingrule->{'renewalsallowed'};
2645 $renewsleft = $renewsallowed - $renewcount;
2646 if($renewsleft < 0){ $renewsleft = 0; }
2647 return ( $renewcount, $renewsallowed, $renewsleft );
2650 =head2 GetIssuingCharges
2652 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2654 Calculate how much it would cost for a given patron to borrow a given
2655 item, including any applicable discounts.
2657 C<$itemnumber> is the item number of item the patron wishes to borrow.
2659 C<$borrowernumber> is the patron's borrower number.
2661 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2662 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2667 sub GetIssuingCharges {
2669 # calculate charges due
2670 my ( $itemnumber, $borrowernumber ) = @_;
2672 my $dbh = C4::Context->dbh;
2675 # Get the book's item type and rental charge (via its biblioitem).
2676 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2677 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2678 $charge_query .= (C4::Context->preference('item-level_itypes'))
2679 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2680 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2682 $charge_query .= ' WHERE items.itemnumber =?';
2684 my $sth = $dbh->prepare($charge_query);
2685 $sth->execute($itemnumber);
2686 if ( my $item_data = $sth->fetchrow_hashref ) {
2687 $item_type = $item_data->{itemtype};
2688 $charge = $item_data->{rentalcharge};
2689 my $branch = C4::Branch::mybranch();
2690 my $discount_query = q|SELECT rentaldiscount,
2691 issuingrules.itemtype, issuingrules.branchcode
2693 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2694 WHERE borrowers.borrowernumber = ?
2695 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2696 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2697 my $discount_sth = $dbh->prepare($discount_query);
2698 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2699 my $discount_rules = $discount_sth->fetchall_arrayref({});
2700 if (@{$discount_rules}) {
2701 # We may have multiple rules so get the most specific
2702 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2703 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2707 $sth->finish; # we havent _explicitly_ fetched all rows
2708 return ( $charge, $item_type );
2711 # Select most appropriate discount rule from those returned
2712 sub _get_discount_from_rule {
2713 my ($rules_ref, $branch, $itemtype) = @_;
2716 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2717 $discount = $rules_ref->[0]->{rentaldiscount};
2718 return (defined $discount) ? $discount : 0;
2720 # could have up to 4 does one match $branch and $itemtype
2721 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2723 $discount = $d[0]->{rentaldiscount};
2724 return (defined $discount) ? $discount : 0;
2726 # do we have item type + all branches
2727 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2729 $discount = $d[0]->{rentaldiscount};
2730 return (defined $discount) ? $discount : 0;
2732 # do we all item types + this branch
2733 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2735 $discount = $d[0]->{rentaldiscount};
2736 return (defined $discount) ? $discount : 0;
2738 # so all and all (surely we wont get here)
2739 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2741 $discount = $d[0]->{rentaldiscount};
2742 return (defined $discount) ? $discount : 0;
2748 =head2 AddIssuingCharge
2750 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2754 sub AddIssuingCharge {
2755 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2756 my $dbh = C4::Context->dbh;
2757 my $nextaccntno = getnextacctno( $borrowernumber );
2759 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2761 INSERT INTO accountlines
2762 (borrowernumber, itemnumber, accountno,
2763 date, amount, description, accounttype,
2764 amountoutstanding, manager_id)
2765 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2767 my $sth = $dbh->prepare($query);
2768 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2774 GetTransfers($itemnumber);
2779 my ($itemnumber) = @_;
2781 my $dbh = C4::Context->dbh;
2787 FROM branchtransfers
2788 WHERE itemnumber = ?
2789 AND datearrived IS NULL
2791 my $sth = $dbh->prepare($query);
2792 $sth->execute($itemnumber);
2793 my @row = $sth->fetchrow_array();
2798 =head2 GetTransfersFromTo
2800 @results = GetTransfersFromTo($frombranch,$tobranch);
2802 Returns the list of pending transfers between $from and $to branch
2806 sub GetTransfersFromTo {
2807 my ( $frombranch, $tobranch ) = @_;
2808 return unless ( $frombranch && $tobranch );
2809 my $dbh = C4::Context->dbh;
2811 SELECT itemnumber,datesent,frombranch
2812 FROM branchtransfers
2815 AND datearrived IS NULL
2817 my $sth = $dbh->prepare($query);
2818 $sth->execute( $frombranch, $tobranch );
2821 while ( my $data = $sth->fetchrow_hashref ) {
2822 push @gettransfers, $data;
2825 return (@gettransfers);
2828 =head2 DeleteTransfer
2830 &DeleteTransfer($itemnumber);
2834 sub DeleteTransfer {
2835 my ($itemnumber) = @_;
2836 my $dbh = C4::Context->dbh;
2837 my $sth = $dbh->prepare(
2838 "DELETE FROM branchtransfers
2840 AND datearrived IS NULL "
2842 $sth->execute($itemnumber);
2846 =head2 AnonymiseIssueHistory
2848 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
2850 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2851 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2853 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2854 setting (force delete).
2856 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
2860 sub AnonymiseIssueHistory {
2862 my $borrowernumber = shift;
2863 my $dbh = C4::Context->dbh;
2866 SET borrowernumber = ?
2867 WHERE returndate < ?
2868 AND borrowernumber IS NOT NULL
2871 # The default of 0 does not work due to foreign key constraints
2872 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2873 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2874 my @bind_params = ($anonymouspatron, $date);
2875 if (defined $borrowernumber) {
2876 $query .= " AND borrowernumber = ?";
2877 push @bind_params, $borrowernumber;
2879 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2881 my $sth = $dbh->prepare($query);
2882 $sth->execute(@bind_params);
2883 my $anonymisation_err = $dbh->err;
2884 my $rows_affected = $sth->rows; ### doublecheck row count return function
2885 return ($rows_affected, $anonymisation_err);
2888 =head2 SendCirculationAlert
2890 Send out a C<check-in> or C<checkout> alert using the messaging system.
2898 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2902 Hashref of information about the item being checked in or out.
2906 Hashref of information about the borrower of the item.
2910 The branchcode from where the checkout or check-in took place.
2916 SendCirculationAlert({
2919 borrower => $borrower,
2925 sub SendCirculationAlert {
2927 my ($type, $item, $borrower, $branch) =
2928 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2929 my %message_name = (
2930 CHECKIN => 'Item_Check_in',
2931 CHECKOUT => 'Item_Checkout',
2932 RENEWAL => 'Item_Checkout',
2934 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2935 borrowernumber => $borrower->{borrowernumber},
2936 message_name => $message_name{$type},
2938 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
2939 my $letter = C4::Letters::GetPreparedLetter (
2940 module => 'circulation',
2941 letter_code => $type,
2942 branchcode => $branch,
2944 $issues_table => $item->{itemnumber},
2945 'items' => $item->{itemnumber},
2946 'biblio' => $item->{biblionumber},
2947 'biblioitems' => $item->{biblionumber},
2948 'borrowers' => $borrower,
2949 'branches' => $branch,
2953 my @transports = keys %{ $borrower_preferences->{transports} };
2954 # warn "no transports" unless @transports;
2956 # warn "transport: $_";
2957 my $message = C4::Message->find_last_message($borrower, $type, $_);
2959 #warn "create new message";
2960 C4::Message->enqueue($letter, $borrower, $_);
2962 #warn "append to old message";
2963 $message->append($letter);
2971 =head2 updateWrongTransfer
2973 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2975 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
2979 sub updateWrongTransfer {
2980 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2981 my $dbh = C4::Context->dbh;
2982 # first step validate the actual line of transfert .
2985 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2987 $sth->execute($FromLibrary,$itemNumber);
2990 # second step create a new line of branchtransfer to the right location .
2991 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2993 #third step changing holdingbranch of item
2994 UpdateHoldingbranch($FromLibrary,$itemNumber);
2997 =head2 UpdateHoldingbranch
2999 $items = UpdateHoldingbranch($branch,$itmenumber);
3001 Simple methode for updating hodlingbranch in items BDD line
3005 sub UpdateHoldingbranch {
3006 my ( $branch,$itemnumber ) = @_;
3007 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3012 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3014 this function calculates the due date given the start date and configured circulation rules,
3015 checking against the holidays calendar as per the 'useDaysMode' syspref.
3016 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
3017 C<$itemtype> = itemtype code of item in question
3018 C<$branch> = location whose calendar to use
3019 C<$borrower> = Borrower object
3020 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3025 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3029 # loanlength now a href
3031 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3033 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3039 if (ref $startdate ne 'DateTime' ) {
3040 $datedue = dt_from_string($datedue);
3042 $datedue = $startdate->clone;
3046 DateTime->now( time_zone => C4::Context->tz() )
3047 ->truncate( to => 'minute' );
3051 # calculate the datedue as normal
3052 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3053 { # ignoring calendar
3054 if ( $loanlength->{lengthunit} eq 'hours' ) {
3055 $datedue->add( hours => $loanlength->{$length_key} );
3057 $datedue->add( days => $loanlength->{$length_key} );
3058 $datedue->set_hour(23);
3059 $datedue->set_minute(59);
3063 if ($loanlength->{lengthunit} eq 'hours') {
3064 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3067 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3069 my $calendar = Koha::Calendar->new( branchcode => $branch );
3070 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3071 if ($loanlength->{lengthunit} eq 'days') {
3072 $datedue->set_hour(23);
3073 $datedue->set_minute(59);
3077 # if Hard Due Dates are used, retreive them and apply as necessary
3078 my ( $hardduedate, $hardduedatecompare ) =
3079 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3080 if ($hardduedate) { # hardduedates are currently dates
3081 $hardduedate->truncate( to => 'minute' );
3082 $hardduedate->set_hour(23);
3083 $hardduedate->set_minute(59);
3084 my $cmp = DateTime->compare( $hardduedate, $datedue );
3086 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3087 # if the calculated date is before the 'after' Hard Due Date (floor), override
3088 # if the hard due date is set to 'exactly', overrride
3089 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3090 $datedue = $hardduedate->clone;
3093 # in all other cases, keep the date due as it is
3097 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3098 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3099 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
3100 $expiry_dt->set( hour => 23, minute => 59);
3101 if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
3102 $datedue = $expiry_dt->clone;
3110 =head2 CheckRepeatableHolidays
3112 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3114 This function checks if the date due is a repeatable holiday
3116 C<$date_due> = returndate calculate with no day check
3117 C<$itemnumber> = itemnumber
3118 C<$branchcode> = localisation of issue
3122 sub CheckRepeatableHolidays{
3123 my($itemnumber,$week_day,$branchcode)=@_;
3124 my $dbh = C4::Context->dbh;
3125 my $query = qq|SELECT count(*)
3126 FROM repeatable_holidays
3129 my $sth = $dbh->prepare($query);
3130 $sth->execute($branchcode,$week_day);
3131 my $result=$sth->fetchrow;
3137 =head2 CheckSpecialHolidays
3139 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3141 This function check if the date is a special holiday
3143 C<$years> = the years of datedue
3144 C<$month> = the month of datedue
3145 C<$day> = the day of datedue
3146 C<$itemnumber> = itemnumber
3147 C<$branchcode> = localisation of issue
3151 sub CheckSpecialHolidays{
3152 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3153 my $dbh = C4::Context->dbh;
3154 my $query=qq|SELECT count(*)
3155 FROM `special_holidays`
3161 my $sth = $dbh->prepare($query);
3162 $sth->execute($years,$month,$day,$branchcode);
3163 my $countspecial=$sth->fetchrow ;
3165 return $countspecial;
3168 =head2 CheckRepeatableSpecialHolidays
3170 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3172 This function check if the date is a repeatble special holidays
3174 C<$month> = the month of datedue
3175 C<$day> = the day of datedue
3176 C<$itemnumber> = itemnumber
3177 C<$branchcode> = localisation of issue
3181 sub CheckRepeatableSpecialHolidays{
3182 my ($month,$day,$itemnumber,$branchcode) = @_;
3183 my $dbh = C4::Context->dbh;
3184 my $query=qq|SELECT count(*)
3185 FROM `repeatable_holidays`
3190 my $sth = $dbh->prepare($query);
3191 $sth->execute($month,$day,$branchcode);
3192 my $countspecial=$sth->fetchrow ;
3194 return $countspecial;
3199 sub CheckValidBarcode{
3201 my $dbh = C4::Context->dbh;
3202 my $query=qq|SELECT count(*)
3206 my $sth = $dbh->prepare($query);
3207 $sth->execute($barcode);
3208 my $exist=$sth->fetchrow ;
3213 =head2 IsBranchTransferAllowed
3215 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3217 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3221 sub IsBranchTransferAllowed {
3222 my ( $toBranch, $fromBranch, $code ) = @_;
3224 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3226 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3227 my $dbh = C4::Context->dbh;
3229 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3230 $sth->execute( $toBranch, $fromBranch, $code );
3231 my $limit = $sth->fetchrow_hashref();
3233 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3234 if ( $limit->{'limitId'} ) {
3241 =head2 CreateBranchTransferLimit
3243 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3245 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3249 sub CreateBranchTransferLimit {
3250 my ( $toBranch, $fromBranch, $code ) = @_;
3252 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3254 my $dbh = C4::Context->dbh;
3256 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3257 $sth->execute( $code, $toBranch, $fromBranch );
3260 =head2 DeleteBranchTransferLimits
3262 DeleteBranchTransferLimits($frombranch);
3264 Deletes all the branch transfer limits for one branch
3268 sub DeleteBranchTransferLimits {
3270 my $dbh = C4::Context->dbh;
3271 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3272 $sth->execute($branch);
3276 my ( $borrowernumber, $itemnum ) = @_;
3278 MarkIssueReturned( $borrowernumber, $itemnum );
3279 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3280 my $item = C4::Items::GetItem( $itemnum );
3281 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3282 my @datearr = localtime(time);
3283 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3284 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3285 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3290 my ($itemnumber, $mark_returned, $charge_fee) = @_;
3292 my $dbh = C4::Context->dbh();
3293 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3295 JOIN items USING (itemnumber)
3296 JOIN biblio USING (biblionumber)
3297 WHERE issues.itemnumber=?");
3298 $sth->execute($itemnumber);
3299 my $issues=$sth->fetchrow_hashref();
3302 # if a borrower lost the item, add a replacement cost to the their record
3303 if ( my $borrowernumber = $issues->{borrowernumber} ){
3304 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3306 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}")
3308 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3309 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3310 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3314 sub GetOfflineOperations {
3315 my $dbh = C4::Context->dbh;
3316 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3317 $sth->execute(C4::Context->userenv->{'branch'});
3318 my $results = $sth->fetchall_arrayref({});
3323 sub GetOfflineOperation {
3324 my $dbh = C4::Context->dbh;
3325 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3326 $sth->execute( shift );
3327 my $result = $sth->fetchrow_hashref;
3332 sub AddOfflineOperation {
3333 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3334 my $dbh = C4::Context->dbh;
3335 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3336 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3340 sub DeleteOfflineOperation {
3341 my $dbh = C4::Context->dbh;
3342 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3343 $sth->execute( shift );
3347 sub ProcessOfflineOperation {
3348 my $operation = shift;
3351 if ( $operation->{action} eq 'return' ) {
3352 $report = ProcessOfflineReturn( $operation );
3353 } elsif ( $operation->{action} eq 'issue' ) {
3354 $report = ProcessOfflineIssue( $operation );
3355 } elsif ( $operation->{action} eq 'payment' ) {
3356 $report = ProcessOfflinePayment( $operation );
3359 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3364 sub ProcessOfflineReturn {
3365 my $operation = shift;
3367 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3369 if ( $itemnumber ) {
3370 my $issue = GetOpenIssue( $itemnumber );
3373 $issue->{borrowernumber},
3376 $operation->{timestamp},
3379 { renewals => 0, onloan => undef },
3380 $issue->{'biblionumber'},
3385 return "Item not issued.";
3388 return "Item not found.";
3392 sub ProcessOfflineIssue {
3393 my $operation = shift;
3395 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3397 if ( $borrower->{borrowernumber} ) {
3398 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3399 unless ($itemnumber) {
3400 return "Barcode not found.";
3402 my $issue = GetOpenIssue( $itemnumber );
3404 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3406 $issue->{borrowernumber},
3409 $operation->{timestamp},
3414 $operation->{'barcode'},
3417 $operation->{timestamp},
3422 return "Borrower not found.";
3426 sub ProcessOfflinePayment {
3427 my $operation = shift;
3429 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3430 my $amount = $operation->{amount};
3432 recordpayment( $borrower->{borrowernumber}, $amount );
3440 TransferSlip($user_branch, $itemnumber, $to_branch)
3442 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3447 my ($branch, $itemnumber, $to_branch) = @_;
3449 my $item = GetItem( $itemnumber )
3452 my $pulldate = C4::Dates->new();
3454 return C4::Letters::GetPreparedLetter (
3455 module => 'circulation',
3456 letter_code => 'TRANSFERSLIP',
3457 branchcode => $branch,
3459 'branches' => $to_branch,
3460 'biblio' => $item->{biblionumber},
3466 =head2 CheckIfIssuedToPatron
3468 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3470 Return 1 if any record item is issued to patron, otherwise return 0
3474 sub CheckIfIssuedToPatron {
3475 my ($borrowernumber, $biblionumber) = @_;
3477 my $items = GetItemsByBiblioitemnumber($biblionumber);
3479 foreach my $item (@{$items}) {
3480 return 1 if ($item->{borrowernumber} && $item->{borrowernumber} eq $borrowernumber);
3493 Koha Development Team <http://koha-community.org/>