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 $needsconfirmation{TOO_MANY} = 1;
830 $needsconfirmation{current_loan_count} = $current_loan_count;
831 $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
838 if ( $item->{'notforloan'} )
840 if(!C4::Context->preference("AllowNotForLoanOverride")){
841 $issuingimpossible{NOT_FOR_LOAN} = 1;
842 $issuingimpossible{item_notforloan} = $item->{'notforloan'};
844 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
845 $needsconfirmation{item_notforloan} = $item->{'notforloan'};
849 # we have to check itemtypes.notforloan also
850 if (C4::Context->preference('item-level_itypes')){
851 # this should probably be a subroutine
852 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
853 $sth->execute($item->{'itemtype'});
854 my $notforloan=$sth->fetchrow_hashref();
856 if ($notforloan->{'notforloan'}) {
857 if (!C4::Context->preference("AllowNotForLoanOverride")) {
858 $issuingimpossible{NOT_FOR_LOAN} = 1;
859 $issuingimpossible{itemtype_notforloan} = $item->{'itype'};
861 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
862 $needsconfirmation{itemtype_notforloan} = $item->{'itype'};
866 elsif ($biblioitem->{'notforloan'} == 1){
867 if (!C4::Context->preference("AllowNotForLoanOverride")) {
868 $issuingimpossible{NOT_FOR_LOAN} = 1;
869 $issuingimpossible{itemtype_notforloan} = $biblioitem->{'itemtype'};
871 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
872 $needsconfirmation{itemtype_notforloan} = $biblioitem->{'itemtype'};
876 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} > 0 )
878 $issuingimpossible{WTHDRAWN} = 1;
880 if ( $item->{'restricted'}
881 && $item->{'restricted'} == 1 )
883 $issuingimpossible{RESTRICTED} = 1;
885 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
886 my $code = GetAuthorisedValueByCode( 'LOST', $item->{'itemlost'} );
887 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
888 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
890 if ( C4::Context->preference("IndependantBranches") ) {
891 my $userenv = C4::Context->userenv;
892 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
893 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} ){
894 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1;
895 $issuingimpossible{'itemhomebranch'} = $item->{C4::Context->preference("HomeOrHoldingBranch")};
897 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
898 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
903 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
905 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
908 # Already issued to current borrower. Ask whether the loan should
910 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
911 $borrower->{'borrowernumber'},
912 $item->{'itemnumber'}
914 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
915 $issuingimpossible{NO_MORE_RENEWALS} = 1;
918 $needsconfirmation{RENEW_ISSUE} = 1;
921 elsif ($issue->{borrowernumber}) {
923 # issued to someone else
924 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
926 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
927 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
928 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
929 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
930 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
931 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
934 unless ( $ignore_reserves ) {
935 # See if the item is on reserve.
936 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
938 my $resbor = $res->{'borrowernumber'};
939 if ( $resbor ne $borrower->{'borrowernumber'} ) {
940 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
941 my $branchname = GetBranchName( $res->{'branchcode'} );
942 if ( $restype eq "Waiting" )
944 # The item is on reserve and waiting, but has been
945 # reserved by some other patron.
946 $needsconfirmation{RESERVE_WAITING} = 1;
947 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
948 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
949 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
950 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
951 $needsconfirmation{'resbranchname'} = $branchname;
952 $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
954 elsif ( $restype eq "Reserved" ) {
955 # The item is on reserve for someone else.
956 $needsconfirmation{RESERVED} = 1;
957 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
958 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
959 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
960 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
961 $needsconfirmation{'resbranchname'} = $branchname;
962 $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
968 # CHECK AGE RESTRICTION
971 # get $marker from preferences. Could be something like "FSK|PEGI|Alter|Age:"
972 my $markers = C4::Context->preference('AgeRestrictionMarker' );
973 my $bibvalues = $biblioitem->{'agerestriction'};
974 if (($markers)&&($bibvalues))
976 # Split $bibvalues to something like FSK 16 or PEGI 6
977 my @values = split ' ', $bibvalues;
979 # Search first occurence of one of the markers
980 my @markers = split /\|/, $markers;
983 for my $value (@values) {
985 for my $marker (@markers) {
986 $marker =~ s/^\s+//; #remove leading spaces
987 $marker =~ s/\s+$//; #remove trailing spaces
988 if (uc($marker) eq uc($value)) {
997 # Index points to the next value
998 my $restrictionyear = 0;
999 if (($take <= $#values) && ($take >= 0)){
1000 $restrictionyear += $values[$take];
1003 if ($restrictionyear > 0) {
1004 if ( $borrower->{'dateofbirth'} ) {
1005 my @alloweddate = split /-/,$borrower->{'dateofbirth'} ;
1006 $alloweddate[0] += $restrictionyear;
1007 #Prevent runime eror on leap year (invalid date)
1008 if (($alloweddate[1] == 2) && ($alloweddate[2] == 29)) {
1009 $alloweddate[2] = 28;
1012 if ( Date_to_Days(Today) < Date_to_Days(@alloweddate) -1 ) {
1013 if (C4::Context->preference('AgeRestrictionOverride' )) {
1014 $needsconfirmation{AGE_RESTRICTION} = "$bibvalues";
1017 $issuingimpossible{AGE_RESTRICTION} = "$bibvalues";
1024 ## check for high holds decreasing loan period
1025 my $decrease_loan = C4::Context->preference('decreaseLoanHighHolds');
1026 if ( $decrease_loan && $decrease_loan == 1 ) {
1027 my ( $reserved, $num, $duration, $returndate ) =
1028 checkHighHolds( $item, $borrower );
1030 if ( $num >= C4::Context->preference('decreaseLoanHighHoldsValue') ) {
1031 $needsconfirmation{HIGHHOLDS} = {
1033 duration => $duration,
1034 returndate => output_pref($returndate),
1039 return ( \%issuingimpossible, \%needsconfirmation, \%alerts );
1042 =head2 CanBookBeReturned
1044 ($returnallowed, $message) = CanBookBeReturned($item, $branch)
1046 Check whether the item can be returned to the provided branch
1050 =item C<$item> is a hash of item information as returned from GetItem
1052 =item C<$branch> is the branchcode where the return is taking place
1060 =item C<$returnallowed> is 0 or 1, corresponding to whether the return is allowed (1) or not (0)
1062 =item C<$message> is the branchcode where the item SHOULD be returned, if the return is not allowed
1068 sub CanBookBeReturned {
1069 my ($item, $branch) = @_;
1070 my $allowreturntobranch = C4::Context->preference("AllowReturnToBranch") || 'anywhere';
1072 # assume return is allowed to start
1076 # identify all cases where return is forbidden
1077 if ($allowreturntobranch eq 'homebranch' && $branch ne $item->{'homebranch'}) {
1079 $message = $item->{'homebranch'};
1080 } elsif ($allowreturntobranch eq 'holdingbranch' && $branch ne $item->{'holdingbranch'}) {
1082 $message = $item->{'holdingbranch'};
1083 } elsif ($allowreturntobranch eq 'homeorholdingbranch' && $branch ne $item->{'homebranch'} && $branch ne $item->{'holdingbranch'}) {
1085 $message = $item->{'homebranch'}; # FIXME: choice of homebranch is arbitrary
1088 return ($allowed, $message);
1091 =head2 CheckHighHolds
1093 used when syspref decreaseLoanHighHolds is active. Returns 1 or 0 to define whether the minimum value held in
1094 decreaseLoanHighHoldsValue is exceeded, the total number of outstanding holds, the number of days the loan
1095 has been decreased to (held in syspref decreaseLoanHighHoldsValue), and the new due date
1099 sub checkHighHolds {
1100 my ( $item, $borrower ) = @_;
1101 my $biblio = GetBiblioFromItemNumber( $item->{itemnumber} );
1102 my $branch = _GetCircControlBranch( $item, $borrower );
1103 my $dbh = C4::Context->dbh;
1104 my $sth = $dbh->prepare(
1105 'select count(borrowernumber) as num_holds from reserves where biblionumber=?'
1107 $sth->execute( $item->{'biblionumber'} );
1108 my ($holds) = $sth->fetchrow_array;
1110 my $issuedate = DateTime->now( time_zone => C4::Context->tz() );
1112 my $calendar = Koha::Calendar->new( branchcode => $branch );
1115 ( C4::Context->preference('item-level_itypes') )
1116 ? $biblio->{'itype'}
1117 : $biblio->{'itemtype'};
1119 C4::Circulation::CalcDateDue( $issuedate, $itype, $branch,
1122 my $reduced_datedue =
1123 $calendar->addDate( $issuedate,
1124 C4::Context->preference('decreaseLoanHighHoldsDuration') );
1126 if ( DateTime->compare( $reduced_datedue, $orig_due ) == -1 ) {
1128 C4::Context->preference('decreaseLoanHighHoldsDuration'),
1132 return ( 0, 0, 0, undef );
1137 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1139 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1143 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1145 =item C<$barcode> is the barcode of the item being issued.
1147 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
1148 Calculated if empty.
1150 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1152 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1153 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
1155 AddIssue does the following things :
1157 - step 01: check that there is a borrowernumber & a barcode provided
1158 - check for RENEWAL (book issued & being issued to the same patron)
1159 - renewal YES = Calculate Charge & renew
1161 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1163 - fill reserve if reserve to this patron
1164 - cancel reserve or not, otherwise
1165 * TRANSFERT PENDING ?
1166 - complete the transfert
1174 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
1175 my $dbh = C4::Context->dbh;
1176 my $barcodecheck=CheckValidBarcode($barcode);
1177 if ($datedue && ref $datedue ne 'DateTime') {
1178 $datedue = dt_from_string($datedue);
1180 # $issuedate defaults to today.
1181 if ( ! defined $issuedate ) {
1182 $issuedate = DateTime->now(time_zone => C4::Context->tz());
1185 if ( ref $issuedate ne 'DateTime') {
1186 $issuedate = dt_from_string($issuedate);
1190 if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1191 # find which item we issue
1192 my $item = GetItem('', $barcode) or return; # if we don't get an Item, abort.
1193 my $branch = _GetCircControlBranch($item,$borrower);
1195 # get actual issuing if there is one
1196 my $actualissue = GetItemIssue( $item->{itemnumber});
1198 # get biblioinformation for this item
1199 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
1202 # check if we just renew the issue.
1204 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
1205 $datedue = AddRenewal(
1206 $borrower->{'borrowernumber'},
1207 $item->{'itemnumber'},
1210 $issuedate, # here interpreted as the renewal date
1214 # it's NOT a renewal
1215 if ( $actualissue->{borrowernumber}) {
1216 # This book is currently on loan, but not to the person
1217 # who wants to borrow it now. mark it returned before issuing to the new borrower
1220 C4::Context->userenv->{'branch'}
1224 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1225 # Starting process for transfer job (checking transfert and validate it if we have one)
1226 my ($datesent) = GetTransfers($item->{'itemnumber'});
1228 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1231 "UPDATE branchtransfers
1232 SET datearrived = now(),
1234 comments = 'Forced branchtransfer'
1235 WHERE itemnumber= ? AND datearrived IS NULL"
1237 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1240 # Record in the database the fact that the book was issued.
1244 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1248 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1249 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1252 $datedue->truncate( to => 'minute');
1254 $borrower->{'borrowernumber'}, # borrowernumber
1255 $item->{'itemnumber'}, # itemnumber
1256 $issuedate->strftime('%Y-%m-%d %H:%M:00'), # issuedate
1257 $datedue->strftime('%Y-%m-%d %H:%M:00'), # date_due
1258 C4::Context->userenv->{'branch'} # branchcode
1260 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1261 CartToShelf( $item->{'itemnumber'} );
1263 $item->{'issues'}++;
1264 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1265 UpdateTotalIssues($item->{'biblionumber'}, 1);
1268 ## If item was lost, it has now been found, reverse any list item charges if neccessary.
1269 if ( $item->{'itemlost'} ) {
1270 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1271 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1275 ModItem({ issues => $item->{'issues'},
1276 holdingbranch => C4::Context->userenv->{'branch'},
1278 datelastborrowed => DateTime->now(time_zone => C4::Context->tz())->ymd(),
1279 onloan => $datedue->ymd(),
1280 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1281 ModDateLastSeen( $item->{'itemnumber'} );
1283 # If it costs to borrow this book, charge it to the patron's account.
1284 my ( $charge, $itemtype ) = GetIssuingCharges(
1285 $item->{'itemnumber'},
1286 $borrower->{'borrowernumber'}
1288 if ( $charge > 0 ) {
1290 $item->{'itemnumber'},
1291 $borrower->{'borrowernumber'}, $charge
1293 $item->{'charge'} = $charge;
1296 # Record the fact that this book was issued.
1298 C4::Context->userenv->{'branch'},
1300 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1301 $item->{'itype'}, $borrower->{'borrowernumber'}, undef, $item->{'ccode'}
1304 # Send a checkout slip.
1305 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1307 branchcode => $branch,
1308 categorycode => $borrower->{categorycode},
1309 item_type => $item->{itype},
1310 notification => 'CHECKOUT',
1312 if ($circulation_alert->is_enabled_for(\%conditions)) {
1313 SendCirculationAlert({
1316 borrower => $borrower,
1322 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'itemnumber'})
1323 if C4::Context->preference("IssueLog");
1325 return ($datedue); # not necessarily the same as when it came in!
1328 =head2 GetLoanLength
1330 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1332 Get loan length for an itemtype, a borrower type and a branch
1337 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1338 my $dbh = C4::Context->dbh;
1339 my $sth = $dbh->prepare(qq{
1340 SELECT issuelength, lengthunit, renewalperiod
1342 WHERE categorycode=?
1345 AND issuelength IS NOT NULL
1348 # try to find issuelength & return the 1st available.
1349 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1350 $sth->execute( $borrowertype, $itemtype, $branchcode );
1351 my $loanlength = $sth->fetchrow_hashref;
1354 if defined($loanlength) && $loanlength->{issuelength};
1356 $sth->execute( $borrowertype, '*', $branchcode );
1357 $loanlength = $sth->fetchrow_hashref;
1359 if defined($loanlength) && $loanlength->{issuelength};
1361 $sth->execute( '*', $itemtype, $branchcode );
1362 $loanlength = $sth->fetchrow_hashref;
1364 if defined($loanlength) && $loanlength->{issuelength};
1366 $sth->execute( '*', '*', $branchcode );
1367 $loanlength = $sth->fetchrow_hashref;
1369 if defined($loanlength) && $loanlength->{issuelength};
1371 $sth->execute( $borrowertype, $itemtype, '*' );
1372 $loanlength = $sth->fetchrow_hashref;
1374 if defined($loanlength) && $loanlength->{issuelength};
1376 $sth->execute( $borrowertype, '*', '*' );
1377 $loanlength = $sth->fetchrow_hashref;
1379 if defined($loanlength) && $loanlength->{issuelength};
1381 $sth->execute( '*', $itemtype, '*' );
1382 $loanlength = $sth->fetchrow_hashref;
1384 if defined($loanlength) && $loanlength->{issuelength};
1386 $sth->execute( '*', '*', '*' );
1387 $loanlength = $sth->fetchrow_hashref;
1389 if defined($loanlength) && $loanlength->{issuelength};
1391 # if no rule is set => 21 days (hardcoded)
1394 renewalperiod => 21,
1395 lengthunit => 'days',
1401 =head2 GetHardDueDate
1403 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1405 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1409 sub GetHardDueDate {
1410 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1412 my $rule = GetIssuingRule( $borrowertype, $itemtype, $branchcode );
1414 if ( defined( $rule ) ) {
1415 if ( $rule->{hardduedate} ) {
1416 return (dt_from_string($rule->{hardduedate}, 'iso'),$rule->{hardduedatecompare});
1418 return (undef, undef);
1423 =head2 GetIssuingRule
1425 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1427 FIXME - This is a copy-paste of GetLoanLength
1428 as a stop-gap. Do not wish to change API for GetLoanLength
1429 this close to release.
1431 Get the issuing rule for an itemtype, a borrower type and a branch
1432 Returns a hashref from the issuingrules table.
1436 sub GetIssuingRule {
1437 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1438 my $dbh = C4::Context->dbh;
1439 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1442 $sth->execute( $borrowertype, $itemtype, $branchcode );
1443 $irule = $sth->fetchrow_hashref;
1444 return $irule if defined($irule) ;
1446 $sth->execute( $borrowertype, "*", $branchcode );
1447 $irule = $sth->fetchrow_hashref;
1448 return $irule if defined($irule) ;
1450 $sth->execute( "*", $itemtype, $branchcode );
1451 $irule = $sth->fetchrow_hashref;
1452 return $irule if defined($irule) ;
1454 $sth->execute( "*", "*", $branchcode );
1455 $irule = $sth->fetchrow_hashref;
1456 return $irule if defined($irule) ;
1458 $sth->execute( $borrowertype, $itemtype, "*" );
1459 $irule = $sth->fetchrow_hashref;
1460 return $irule if defined($irule) ;
1462 $sth->execute( $borrowertype, "*", "*" );
1463 $irule = $sth->fetchrow_hashref;
1464 return $irule if defined($irule) ;
1466 $sth->execute( "*", $itemtype, "*" );
1467 $irule = $sth->fetchrow_hashref;
1468 return $irule if defined($irule) ;
1470 $sth->execute( "*", "*", "*" );
1471 $irule = $sth->fetchrow_hashref;
1472 return $irule if defined($irule) ;
1474 # if no rule matches,
1478 =head2 GetBranchBorrowerCircRule
1480 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1482 Retrieves circulation rule attributes that apply to the given
1483 branch and patron category, regardless of item type.
1484 The return value is a hashref containing the following key:
1486 maxissueqty - maximum number of loans that a
1487 patron of the given category can have at the given
1488 branch. If the value is undef, no limit.
1490 This will first check for a specific branch and
1491 category match from branch_borrower_circ_rules.
1493 If no rule is found, it will then check default_branch_circ_rules
1494 (same branch, default category). If no rule is found,
1495 it will then check default_borrower_circ_rules (default
1496 branch, same category), then failing that, default_circ_rules
1497 (default branch, default category).
1499 If no rule has been found in the database, it will default to
1504 C<$branchcode> and C<$categorycode> should contain the
1505 literal branch code and patron category code, respectively - no
1510 sub GetBranchBorrowerCircRule {
1511 my $branchcode = shift;
1512 my $categorycode = shift;
1514 my $branch_cat_query = "SELECT maxissueqty
1515 FROM branch_borrower_circ_rules
1516 WHERE branchcode = ?
1517 AND categorycode = ?";
1518 my $dbh = C4::Context->dbh();
1519 my $sth = $dbh->prepare($branch_cat_query);
1520 $sth->execute($branchcode, $categorycode);
1522 if ($result = $sth->fetchrow_hashref()) {
1526 # try same branch, default borrower category
1527 my $branch_query = "SELECT maxissueqty
1528 FROM default_branch_circ_rules
1529 WHERE branchcode = ?";
1530 $sth = $dbh->prepare($branch_query);
1531 $sth->execute($branchcode);
1532 if ($result = $sth->fetchrow_hashref()) {
1536 # try default branch, same borrower category
1537 my $category_query = "SELECT maxissueqty
1538 FROM default_borrower_circ_rules
1539 WHERE categorycode = ?";
1540 $sth = $dbh->prepare($category_query);
1541 $sth->execute($categorycode);
1542 if ($result = $sth->fetchrow_hashref()) {
1546 # try default branch, default borrower category
1547 my $default_query = "SELECT maxissueqty
1548 FROM default_circ_rules";
1549 $sth = $dbh->prepare($default_query);
1551 if ($result = $sth->fetchrow_hashref()) {
1555 # built-in default circulation rule
1557 maxissueqty => undef,
1561 =head2 GetBranchItemRule
1563 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1565 Retrieves circulation rule attributes that apply to the given
1566 branch and item type, regardless of patron category.
1568 The return value is a hashref containing the following keys:
1570 holdallowed => Hold policy for this branch and itemtype. Possible values:
1571 0: No holds allowed.
1572 1: Holds allowed only by patrons that have the same homebranch as the item.
1573 2: Holds allowed from any patron.
1575 returnbranch => branch to which to return item. Possible values:
1576 noreturn: do not return, let item remain where checked in (floating collections)
1577 homebranch: return to item's home branch
1579 This searches branchitemrules in the following order:
1581 * Same branchcode and itemtype
1582 * Same branchcode, itemtype '*'
1583 * branchcode '*', same itemtype
1584 * branchcode and itemtype '*'
1586 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1590 sub GetBranchItemRule {
1591 my ( $branchcode, $itemtype ) = @_;
1592 my $dbh = C4::Context->dbh();
1596 ['SELECT holdallowed, returnbranch
1597 FROM branch_item_rules
1598 WHERE branchcode = ?
1599 AND itemtype = ?', $branchcode, $itemtype],
1600 ['SELECT holdallowed, returnbranch
1601 FROM default_branch_circ_rules
1602 WHERE branchcode = ?', $branchcode],
1603 ['SELECT holdallowed, returnbranch
1604 FROM default_branch_item_rules
1605 WHERE itemtype = ?', $itemtype],
1606 ['SELECT holdallowed, returnbranch
1607 FROM default_circ_rules'],
1610 foreach my $attempt (@attempts) {
1611 my ($query, @bind_params) = @{$attempt};
1612 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1615 # Since branch/category and branch/itemtype use the same per-branch
1616 # defaults tables, we have to check that the key we want is set, not
1617 # just that a row was returned
1618 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1619 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1622 # built-in default circulation rule
1623 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1624 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1631 ($doreturn, $messages, $iteminformation, $borrower) =
1632 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1638 =item C<$barcode> is the bar code of the book being returned.
1640 =item C<$branch> is the code of the branch where the book is being returned.
1642 =item C<$exemptfine> indicates that overdue charges for the item will be
1645 =item C<$dropbox> indicates that the check-in date is assumed to be
1646 yesterday, or the last non-holiday as defined in C4::Calendar . If
1647 overdue charges are applied and C<$dropbox> is true, the last charge
1648 will be removed. This assumes that the fines accrual script has run
1653 C<&AddReturn> returns a list of four items:
1655 C<$doreturn> is true iff the return succeeded.
1657 C<$messages> is a reference-to-hash giving feedback on the operation.
1658 The keys of the hash are:
1664 No item with this barcode exists. The value is C<$barcode>.
1668 The book is not currently on loan. The value is C<$barcode>.
1670 =item C<IsPermanent>
1672 The book's home branch is a permanent collection. If you have borrowed
1673 this book, you are not allowed to return it. The value is the code for
1674 the book's home branch.
1678 This book has been withdrawn/cancelled. The value should be ignored.
1680 =item C<Wrongbranch>
1682 This book has was returned to the wrong branch. The value is a hashref
1683 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1684 contain the branchcode of the incorrect and correct return library, respectively.
1688 The item was reserved. The value is a reference-to-hash whose keys are
1689 fields from the reserves table of the Koha database, and
1690 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1691 either C<Waiting>, C<Reserved>, or 0.
1695 C<$iteminformation> is a reference-to-hash, giving information about the
1696 returned item from the issues table.
1698 C<$borrower> is a reference-to-hash, giving information about the
1699 patron who last borrowed the book.
1704 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1706 if ($branch and not GetBranchDetail($branch)) {
1707 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1710 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1715 my $validTransfert = 0;
1716 my $stat_type = 'return';
1718 # get information on item
1719 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1720 unless ($itemnumber) {
1721 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1723 my $issue = GetItemIssue($itemnumber);
1724 # warn Dumper($iteminformation);
1725 if ($issue and $issue->{borrowernumber}) {
1726 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1727 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1728 . Dumper($issue) . "\n";
1730 $messages->{'NotIssued'} = $barcode;
1731 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1733 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1734 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1735 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1736 $messages->{'LocalUse'} = 1;
1737 $stat_type = 'localuse';
1741 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1742 # full item data, but no borrowernumber or checkout info (no issue)
1743 # we know GetItem should work because GetItemnumberFromBarcode worked
1744 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1745 # get the proper branch to which to return the item
1746 $hbr = $item->{$hbr} || $branch ;
1747 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1749 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1751 # check if the book is in a permanent collection....
1752 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1754 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1755 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1758 # check if the return is allowed at this branch
1759 my ($returnallowed, $message) = CanBookBeReturned($item, $branch);
1760 unless ($returnallowed){
1761 $messages->{'Wrongbranch'} = {
1762 Wrongbranch => $branch,
1763 Rightbranch => $message
1766 return ( $doreturn, $messages, $issue, $borrower );
1769 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1770 $messages->{'wthdrawn'} = 1;
1771 $doreturn = 0 if C4::Context->preference("BlockReturnOfWithdrawnItems");
1774 # case of a return of document (deal with issues and holdingbranch)
1775 my $today = DateTime->now( time_zone => C4::Context->tz() );
1777 my $datedue = $issue->{date_due};
1778 $borrower or warn "AddReturn without current borrower";
1779 my $circControlBranch;
1781 # define circControlBranch only if dropbox mode is set
1782 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1783 # FIXME: check issuedate > returndate, factoring in holidays
1784 #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1785 $circControlBranch = _GetCircControlBranch($item,$borrower);
1786 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $today ) == -1 ? 1 : 0;
1789 if ($borrowernumber) {
1790 if( C4::Context->preference('CalculateFinesOnReturn') && $issue->{'overdue'}){
1791 # we only need to calculate and change the fines if we want to do that on return
1792 # Should be on for hourly loans
1793 my $control = C4::Context->preference('CircControl');
1794 my $control_branchcode =
1795 ( $control eq 'ItemHomeLibrary' ) ? $item->{homebranch}
1796 : ( $control eq 'PatronLibrary' ) ? $borrower->{branchcode}
1797 : $issue->{branchcode};
1799 my ( $amount, $type, $unitcounttotal ) =
1800 C4::Overdues::CalcFine( $item, $borrower->{categorycode},
1801 $control_branchcode, $datedue, $today );
1806 && C4::Context->preference('finesMode') eq 'production' )
1808 C4::Overdues::UpdateFine( $issue->{itemnumber},
1809 $issue->{borrowernumber},
1810 $amount, $type, output_pref($datedue) );
1814 MarkIssueReturned( $borrowernumber, $item->{'itemnumber'},
1815 $circControlBranch, '', $borrower->{'privacy'} );
1817 # FIXME is the "= 1" right? This could be the borrower hash.
1818 $messages->{'WasReturned'} = 1;
1822 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1825 # the holdingbranch is updated if the document is returned to another location.
1826 # this is always done regardless of whether the item was on loan or not
1827 if ($item->{'holdingbranch'} ne $branch) {
1828 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1829 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1831 ModDateLastSeen( $item->{'itemnumber'} );
1833 # check if we have a transfer for this document
1834 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1836 # if we have a transfer to do, we update the line of transfers with the datearrived
1838 if ( $tobranch eq $branch ) {
1839 my $sth = C4::Context->dbh->prepare(
1840 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1842 $sth->execute( $item->{'itemnumber'} );
1843 # if we have a reservation with valid transfer, we can set it's status to 'W'
1844 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1845 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1847 $messages->{'WrongTransfer'} = $tobranch;
1848 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1850 $validTransfert = 1;
1852 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1855 # fix up the accounts.....
1856 if ( $item->{'itemlost'} ) {
1857 $messages->{'WasLost'} = 1;
1859 if ( C4::Context->preference('RefundLostItemFeeOnReturn' ) ) {
1860 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1861 $messages->{'LostItemFeeRefunded'} = 1;
1865 # fix up the overdues in accounts...
1866 if ($borrowernumber) {
1867 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1868 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1870 if ( $issue->{overdue} && $issue->{date_due} ) {
1873 _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1874 $messages->{Debarred} = $debardate if ($debardate);
1878 # find reserves.....
1879 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1880 my ($resfound, $resrec);
1881 ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'} ) unless ( $item->{'wthdrawn'} );
1883 $resrec->{'ResFound'} = $resfound;
1884 $messages->{'ResFound'} = $resrec;
1888 # Record the fact that this book was returned.
1890 $branch, $stat_type, '0', '',
1891 $item->{'itemnumber'},
1892 $biblio->{'itemtype'},
1893 $borrowernumber, undef, $item->{'ccode'}
1896 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1897 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1899 branchcode => $branch,
1900 categorycode => $borrower->{categorycode},
1901 item_type => $item->{itype},
1902 notification => 'CHECKIN',
1904 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1905 SendCirculationAlert({
1908 borrower => $borrower,
1913 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'itemnumber'})
1914 if C4::Context->preference("ReturnLog");
1916 # FIXME: make this comment intelligible.
1917 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1918 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1920 if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
1921 if ( C4::Context->preference("AutomaticItemReturn" ) or
1922 (C4::Context->preference("UseBranchTransferLimits") and
1923 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1925 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1926 $debug and warn "item: " . Dumper($item);
1927 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1928 $messages->{'WasTransfered'} = 1;
1930 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1933 return ( $doreturn, $messages, $issue, $borrower );
1936 =head2 MarkIssueReturned
1938 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1940 Unconditionally marks an issue as being returned by
1941 moving the C<issues> row to C<old_issues> and
1942 setting C<returndate> to the current date, or
1943 the last non-holiday date of the branccode specified in
1944 C<dropbox_branch> . Assumes you've already checked that
1945 it's safe to do this, i.e. last non-holiday > issuedate.
1947 if C<$returndate> is specified (in iso format), it is used as the date
1948 of the return. It is ignored when a dropbox_branch is passed in.
1950 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1951 the old_issue is immediately anonymised
1953 Ideally, this function would be internal to C<C4::Circulation>,
1954 not exported, but it is currently needed by one
1955 routine in C<C4::Accounts>.
1959 sub MarkIssueReturned {
1960 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1962 my $dbh = C4::Context->dbh;
1963 my $query = 'UPDATE issues SET returndate=';
1965 if ($dropbox_branch) {
1966 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
1967 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
1969 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
1970 } elsif ($returndate) {
1972 push @bind, $returndate;
1974 $query .= ' now() ';
1976 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
1977 push @bind, $borrowernumber, $itemnumber;
1979 my $sth_upd = $dbh->prepare($query);
1980 $sth_upd->execute(@bind);
1981 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
1982 WHERE borrowernumber = ?
1983 AND itemnumber = ?');
1984 $sth_copy->execute($borrowernumber, $itemnumber);
1985 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
1986 if ( $privacy == 2) {
1987 # The default of 0 does not work due to foreign key constraints
1988 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
1989 # FIXME the above is unacceptable - bug 9942 relates
1990 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
1991 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
1992 WHERE borrowernumber = ?
1993 AND itemnumber = ?");
1994 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
1996 my $sth_del = $dbh->prepare("DELETE FROM issues
1997 WHERE borrowernumber = ?
1998 AND itemnumber = ?");
1999 $sth_del->execute($borrowernumber, $itemnumber);
2002 =head2 _debar_user_on_return
2004 _debar_user_on_return($borrower, $item, $datedue, today);
2006 C<$borrower> borrower hashref
2008 C<$item> item hashref
2010 C<$datedue> date due DateTime object
2012 C<$today> DateTime object representing the return time
2014 Internal function, called only by AddReturn that calculates and updates
2015 the user fine days, and debars him if necessary.
2017 Should only be called for overdue returns
2021 sub _debar_user_on_return {
2022 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
2024 my $branchcode = _GetCircControlBranch( $item, $borrower );
2025 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
2027 # $deltadays is a DateTime::Duration object
2028 my $deltadays = $calendar->days_between( $dt_due, $dt_today );
2030 my $circcontrol = C4::Context->preference('CircControl');
2032 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
2033 my $finedays = $issuingrule->{finedays};
2034 my $unit = $issuingrule->{lengthunit};
2038 # finedays is in days, so hourly loans must multiply by 24
2039 # thus 1 hour late equals 1 day suspension * finedays rate
2040 $finedays = $finedays * 24 if ( $unit eq 'hours' );
2042 # grace period is measured in the same units as the loan
2044 DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
2045 if ( $deltadays->subtract($grace)->is_positive() ) {
2048 $dt_today->clone()->add_duration( $deltadays * $finedays );
2049 if ( $borrower->{debarred} ) {
2050 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
2052 # Update patron only if new date > old
2053 if ( DateTime->compare( $borrower_debar_dt, $new_debar_dt ) !=
2060 C4::Members::DebarMember( $borrower->{borrowernumber},
2061 $new_debar_dt->ymd() );
2062 return $new_debar_dt->ymd();
2068 =head2 _FixOverduesOnReturn
2070 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
2072 C<$brn> borrowernumber
2076 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
2077 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
2079 Internal function, called only by AddReturn
2083 sub _FixOverduesOnReturn {
2084 my ($borrowernumber, $item);
2085 unless ($borrowernumber = shift) {
2086 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
2089 unless ($item = shift) {
2090 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
2093 my ($exemptfine, $dropbox) = @_;
2094 my $dbh = C4::Context->dbh;
2096 # check for overdue fine
2097 my $sth = $dbh->prepare(
2098 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
2100 $sth->execute( $borrowernumber, $item );
2102 # alter fine to show that the book has been returned
2103 my $data = $sth->fetchrow_hashref;
2104 return 0 unless $data; # no warning, there's just nothing to fix
2107 my @bind = ($data->{'accountlines_id'});
2109 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
2110 if (C4::Context->preference("FinesLog")) {
2111 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
2113 } elsif ($dropbox && $data->{lastincrement}) {
2114 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
2115 my $amt = $data->{amount} - $data->{lastincrement} ;
2116 if (C4::Context->preference("FinesLog")) {
2117 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
2119 $uquery = "update accountlines set accounttype='F' ";
2120 if($outstanding >= 0 && $amt >=0) {
2121 $uquery .= ", amount = ? , amountoutstanding=? ";
2122 unshift @bind, ($amt, $outstanding) ;
2125 $uquery = "update accountlines set accounttype='F' ";
2127 $uquery .= " where (accountlines_id = ?)";
2128 my $usth = $dbh->prepare($uquery);
2129 return $usth->execute(@bind);
2132 =head2 _FixAccountForLostAndReturned
2134 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
2136 Calculates the charge for a book lost and returned.
2138 Internal function, not exported, called only by AddReturn.
2140 FIXME: This function reflects how inscrutable fines logic is. Fix both.
2141 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
2145 sub _FixAccountForLostAndReturned {
2146 my $itemnumber = shift or return;
2147 my $borrowernumber = @_ ? shift : undef;
2148 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
2149 my $dbh = C4::Context->dbh;
2150 # check for charge made for lost book
2151 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2152 $sth->execute($itemnumber);
2153 my $data = $sth->fetchrow_hashref;
2154 $data or return; # bail if there is nothing to do
2155 $data->{accounttype} eq 'W' and return; # Written off
2157 # writeoff this amount
2159 my $amount = $data->{'amount'};
2160 my $acctno = $data->{'accountno'};
2161 my $amountleft; # Starts off undef/zero.
2162 if ($data->{'amountoutstanding'} == $amount) {
2163 $offset = $data->{'amount'};
2164 $amountleft = 0; # Hey, it's zero here, too.
2166 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2167 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2169 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2170 WHERE (accountlines_id = ?)");
2171 $usth->execute($data->{'accountlines_id'}); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2172 #check if any credit is left if so writeoff other accounts
2173 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2174 $amountleft *= -1 if ($amountleft < 0);
2175 if ($amountleft > 0) {
2176 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2177 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2178 $msth->execute($data->{'borrowernumber'});
2179 # offset transactions
2182 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2183 if ($accdata->{'amountoutstanding'} < $amountleft) {
2185 $amountleft -= $accdata->{'amountoutstanding'};
2187 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2190 my $thisacct = $accdata->{'accountlines_id'};
2191 # FIXME: move prepares outside while loop!
2192 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2193 WHERE (accountlines_id = ?)");
2194 $usth->execute($newamtos,$thisacct);
2195 $usth = $dbh->prepare("INSERT INTO accountoffsets
2196 (borrowernumber, accountno, offsetaccount, offsetamount)
2199 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2201 $msth->finish; # $msth might actually have data left
2203 $amountleft *= -1 if ($amountleft > 0);
2204 my $desc = "Item Returned " . $item_id;
2205 $usth = $dbh->prepare("INSERT INTO accountlines
2206 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2207 VALUES (?,?,now(),?,?,'CR',?)");
2208 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2209 if ($borrowernumber) {
2210 # FIXME: same as query above. use 1 sth for both
2211 $usth = $dbh->prepare("INSERT INTO accountoffsets
2212 (borrowernumber, accountno, offsetaccount, offsetamount)
2214 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2216 ModItem({ paidfor => '' }, undef, $itemnumber);
2220 =head2 _GetCircControlBranch
2222 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2226 Return the library code to be used to determine which circulation
2227 policy applies to a transaction. Looks up the CircControl and
2228 HomeOrHoldingBranch system preferences.
2230 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2232 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2236 sub _GetCircControlBranch {
2237 my ($item, $borrower) = @_;
2238 my $circcontrol = C4::Context->preference('CircControl');
2241 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2242 $branch= C4::Context->userenv->{'branch'};
2243 } elsif ($circcontrol eq 'PatronLibrary') {
2244 $branch=$borrower->{branchcode};
2246 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2247 $branch = $item->{$branchfield};
2248 # default to item home branch if holdingbranch is used
2249 # and is not defined
2250 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2251 $branch = $item->{homebranch};
2264 $issue = &GetItemIssue($itemnumber);
2266 Returns patron currently having a book, or undef if not checked out.
2268 C<$itemnumber> is the itemnumber.
2270 C<$issue> is a hashref of the row from the issues table.
2275 my ($itemnumber) = @_;
2276 return unless $itemnumber;
2277 my $sth = C4::Context->dbh->prepare(
2278 "SELECT items.*, issues.*
2280 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2281 WHERE issues.itemnumber=?");
2282 $sth->execute($itemnumber);
2283 my $data = $sth->fetchrow_hashref;
2284 return unless $data;
2285 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2286 $data->{issuedate}->truncate(to => 'minute');
2287 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2288 $data->{date_due}->truncate(to => 'minute');
2289 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2290 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2296 $issue = GetOpenIssue( $itemnumber );
2298 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2300 C<$itemnumber> is the item's itemnumber
2307 my ( $itemnumber ) = @_;
2309 my $dbh = C4::Context->dbh;
2310 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2311 $sth->execute( $itemnumber );
2312 my $issue = $sth->fetchrow_hashref();
2316 =head2 GetItemIssues
2318 $issues = &GetItemIssues($itemnumber, $history);
2320 Returns patrons that have issued a book
2322 C<$itemnumber> is the itemnumber
2323 C<$history> is false if you just want the current "issuer" (if any)
2324 and true if you want issues history from old_issues also.
2326 Returns reference to an array of hashes
2331 my ( $itemnumber, $history ) = @_;
2333 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2334 $today->truncate( to => 'minute' );
2335 my $sql = "SELECT * FROM issues
2336 JOIN borrowers USING (borrowernumber)
2337 JOIN items USING (itemnumber)
2338 WHERE issues.itemnumber = ? ";
2341 SELECT * FROM old_issues
2342 LEFT JOIN borrowers USING (borrowernumber)
2343 JOIN items USING (itemnumber)
2344 WHERE old_issues.itemnumber = ? ";
2346 $sql .= "ORDER BY date_due DESC";
2347 my $sth = C4::Context->dbh->prepare($sql);
2349 $sth->execute($itemnumber, $itemnumber);
2351 $sth->execute($itemnumber);
2353 my $results = $sth->fetchall_arrayref({});
2354 foreach (@$results) {
2355 my $date_due = dt_from_string($_->{date_due},'sql');
2356 $date_due->truncate( to => 'minute' );
2358 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2363 =head2 GetBiblioIssues
2365 $issues = GetBiblioIssues($biblionumber);
2367 this function get all issues from a biblionumber.
2370 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2371 tables issues and the firstname,surname & cardnumber from borrowers.
2375 sub GetBiblioIssues {
2376 my $biblionumber = shift;
2377 return unless $biblionumber;
2378 my $dbh = C4::Context->dbh;
2380 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2382 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2383 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2384 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2385 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2386 WHERE biblio.biblionumber = ?
2388 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2390 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2391 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2392 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2393 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2394 WHERE biblio.biblionumber = ?
2397 my $sth = $dbh->prepare($query);
2398 $sth->execute($biblionumber, $biblionumber);
2401 while ( my $data = $sth->fetchrow_hashref ) {
2402 push @issues, $data;
2407 =head2 GetUpcomingDueIssues
2409 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2413 sub GetUpcomingDueIssues {
2416 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2417 my $dbh = C4::Context->dbh;
2419 my $statement = <<END_SQL;
2420 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2422 LEFT JOIN items USING (itemnumber)
2423 LEFT OUTER JOIN branches USING (branchcode)
2424 WHERE returndate is NULL
2425 HAVING days_until_due >= 0 AND days_until_due <= ?
2428 my @bind_parameters = ( $params->{'days_in_advance'} );
2430 my $sth = $dbh->prepare( $statement );
2431 $sth->execute( @bind_parameters );
2432 my $upcoming_dues = $sth->fetchall_arrayref({});
2435 return $upcoming_dues;
2438 =head2 CanBookBeRenewed
2440 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2442 Find out whether a borrowed item may be renewed.
2444 C<$borrowernumber> is the borrower number of the patron who currently
2445 has the item on loan.
2447 C<$itemnumber> is the number of the item to renew.
2449 C<$override_limit>, if supplied with a true value, causes
2450 the limit on the number of times that the loan can be renewed
2451 (as controlled by the item type) to be ignored.
2453 C<$CanBookBeRenewed> returns a true value if the item may be renewed. The
2454 item must currently be on loan to the specified borrower; renewals
2455 must be allowed for the item's type; and the borrower must not have
2456 already renewed the loan. $error will contain the reason the renewal can not proceed
2460 sub CanBookBeRenewed {
2462 # check renewal status
2463 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2464 my $dbh = C4::Context->dbh;
2469 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return;
2470 my $item = GetItem($itemnumber) or return;
2471 my $itemissue = GetItemIssue($itemnumber) or return;
2473 my $branchcode = _GetCircControlBranch($item, $borrower);
2475 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2477 if ( ( $issuingrule->{renewalsallowed} > $itemissue->{renewals} ) || $override_limit ) {
2480 $error = "too_many";
2483 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves( $itemnumber );
2485 if ( $resfound ) { # '' when no hold was found
2487 $error = "on_reserve";
2490 return ( $renewokay, $error );
2495 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2499 C<$borrowernumber> is the borrower number of the patron who currently
2502 C<$itemnumber> is the number of the item to renew.
2504 C<$branch> is the library where the renewal took place (if any).
2505 The library that controls the circ policies for the renewal is retrieved from the issues record.
2507 C<$datedue> can be a C4::Dates object used to set the due date.
2509 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2510 this parameter is not supplied, lastreneweddate is set to the current date.
2512 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2513 from the book's item type.
2518 my $borrowernumber = shift or return;
2519 my $itemnumber = shift or return;
2521 my $datedue = shift;
2522 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2523 my $item = GetItem($itemnumber) or return;
2524 my $biblio = GetBiblioFromItemNumber($itemnumber) or return;
2526 my $dbh = C4::Context->dbh;
2527 # Find the issues record for this book
2529 $dbh->prepare("SELECT * FROM issues
2530 WHERE borrowernumber=?
2533 $sth->execute( $borrowernumber, $itemnumber );
2534 my $issuedata = $sth->fetchrow_hashref;
2536 if(defined $datedue && ref $datedue ne 'DateTime' ) {
2537 carp 'Invalid date passed to AddRenewal.';
2540 # If the due date wasn't specified, calculate it by adding the
2541 # book's loan length to today's date or the current due date
2542 # based on the value of the RenewalPeriodBase syspref.
2545 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return;
2546 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2548 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2549 dt_from_string( $issuedata->{date_due} ) :
2550 DateTime->now( time_zone => C4::Context->tz());
2551 $datedue = CalcDateDue($datedue, $itemtype, $issuedata->{'branchcode'}, $borrower, 'is a renewal');
2554 # Update the issues record to have the new due date, and a new count
2555 # of how many times it has been renewed.
2556 my $renews = $issuedata->{'renewals'} + 1;
2557 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2558 WHERE borrowernumber=?
2562 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2565 # Update the renewal count on the item, and tell zebra to reindex
2566 $renews = $biblio->{'renewals'} + 1;
2567 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2569 # Charge a new rental fee, if applicable?
2570 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2571 if ( $charge > 0 ) {
2572 my $accountno = getnextacctno( $borrowernumber );
2573 my $item = GetBiblioFromItemNumber($itemnumber);
2575 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2576 $sth = $dbh->prepare(
2577 "INSERT INTO accountlines
2578 (date, borrowernumber, accountno, amount, manager_id,
2579 description,accounttype, amountoutstanding, itemnumber)
2580 VALUES (now(),?,?,?,?,?,?,?,?)"
2582 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2583 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2584 'Rent', $charge, $itemnumber );
2587 # Send a renewal slip according to checkout alert preferencei
2588 if ( C4::Context->preference('RenewalSendNotice') eq '1') {
2589 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 );
2590 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
2592 branchcode => $branch,
2593 categorycode => $borrower->{categorycode},
2594 item_type => $item->{itype},
2595 notification => 'CHECKOUT',
2597 if ($circulation_alert->is_enabled_for(\%conditions)) {
2598 SendCirculationAlert({
2601 borrower => $borrower,
2608 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber, undef, $item->{'ccode'});
2613 # check renewal status
2614 my ( $bornum, $itemno ) = @_;
2615 my $dbh = C4::Context->dbh;
2617 my $renewsallowed = 0;
2620 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2621 my $item = GetItem($itemno);
2623 # Look in the issues table for this item, lent to this borrower,
2624 # and not yet returned.
2626 # FIXME - I think this function could be redone to use only one SQL call.
2627 my $sth = $dbh->prepare(
2628 "select * from issues
2629 where (borrowernumber = ?)
2630 and (itemnumber = ?)"
2632 $sth->execute( $bornum, $itemno );
2633 my $data = $sth->fetchrow_hashref;
2634 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2636 # $item and $borrower should be calculated
2637 my $branchcode = _GetCircControlBranch($item, $borrower);
2639 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2641 $renewsallowed = $issuingrule->{'renewalsallowed'};
2642 $renewsleft = $renewsallowed - $renewcount;
2643 if($renewsleft < 0){ $renewsleft = 0; }
2644 return ( $renewcount, $renewsallowed, $renewsleft );
2647 =head2 GetIssuingCharges
2649 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2651 Calculate how much it would cost for a given patron to borrow a given
2652 item, including any applicable discounts.
2654 C<$itemnumber> is the item number of item the patron wishes to borrow.
2656 C<$borrowernumber> is the patron's borrower number.
2658 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2659 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2664 sub GetIssuingCharges {
2666 # calculate charges due
2667 my ( $itemnumber, $borrowernumber ) = @_;
2669 my $dbh = C4::Context->dbh;
2672 # Get the book's item type and rental charge (via its biblioitem).
2673 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2674 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2675 $charge_query .= (C4::Context->preference('item-level_itypes'))
2676 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2677 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2679 $charge_query .= ' WHERE items.itemnumber =?';
2681 my $sth = $dbh->prepare($charge_query);
2682 $sth->execute($itemnumber);
2683 if ( my $item_data = $sth->fetchrow_hashref ) {
2684 $item_type = $item_data->{itemtype};
2685 $charge = $item_data->{rentalcharge};
2686 my $branch = C4::Branch::mybranch();
2687 my $discount_query = q|SELECT rentaldiscount,
2688 issuingrules.itemtype, issuingrules.branchcode
2690 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2691 WHERE borrowers.borrowernumber = ?
2692 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2693 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2694 my $discount_sth = $dbh->prepare($discount_query);
2695 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2696 my $discount_rules = $discount_sth->fetchall_arrayref({});
2697 if (@{$discount_rules}) {
2698 # We may have multiple rules so get the most specific
2699 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2700 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2704 $sth->finish; # we havent _explicitly_ fetched all rows
2705 return ( $charge, $item_type );
2708 # Select most appropriate discount rule from those returned
2709 sub _get_discount_from_rule {
2710 my ($rules_ref, $branch, $itemtype) = @_;
2713 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2714 $discount = $rules_ref->[0]->{rentaldiscount};
2715 return (defined $discount) ? $discount : 0;
2717 # could have up to 4 does one match $branch and $itemtype
2718 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2720 $discount = $d[0]->{rentaldiscount};
2721 return (defined $discount) ? $discount : 0;
2723 # do we have item type + all branches
2724 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2726 $discount = $d[0]->{rentaldiscount};
2727 return (defined $discount) ? $discount : 0;
2729 # do we all item types + this branch
2730 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2732 $discount = $d[0]->{rentaldiscount};
2733 return (defined $discount) ? $discount : 0;
2735 # so all and all (surely we wont get here)
2736 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2738 $discount = $d[0]->{rentaldiscount};
2739 return (defined $discount) ? $discount : 0;
2745 =head2 AddIssuingCharge
2747 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2751 sub AddIssuingCharge {
2752 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2753 my $dbh = C4::Context->dbh;
2754 my $nextaccntno = getnextacctno( $borrowernumber );
2756 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2758 INSERT INTO accountlines
2759 (borrowernumber, itemnumber, accountno,
2760 date, amount, description, accounttype,
2761 amountoutstanding, manager_id)
2762 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2764 my $sth = $dbh->prepare($query);
2765 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2771 GetTransfers($itemnumber);
2776 my ($itemnumber) = @_;
2778 my $dbh = C4::Context->dbh;
2784 FROM branchtransfers
2785 WHERE itemnumber = ?
2786 AND datearrived IS NULL
2788 my $sth = $dbh->prepare($query);
2789 $sth->execute($itemnumber);
2790 my @row = $sth->fetchrow_array();
2795 =head2 GetTransfersFromTo
2797 @results = GetTransfersFromTo($frombranch,$tobranch);
2799 Returns the list of pending transfers between $from and $to branch
2803 sub GetTransfersFromTo {
2804 my ( $frombranch, $tobranch ) = @_;
2805 return unless ( $frombranch && $tobranch );
2806 my $dbh = C4::Context->dbh;
2808 SELECT itemnumber,datesent,frombranch
2809 FROM branchtransfers
2812 AND datearrived IS NULL
2814 my $sth = $dbh->prepare($query);
2815 $sth->execute( $frombranch, $tobranch );
2818 while ( my $data = $sth->fetchrow_hashref ) {
2819 push @gettransfers, $data;
2822 return (@gettransfers);
2825 =head2 DeleteTransfer
2827 &DeleteTransfer($itemnumber);
2831 sub DeleteTransfer {
2832 my ($itemnumber) = @_;
2833 my $dbh = C4::Context->dbh;
2834 my $sth = $dbh->prepare(
2835 "DELETE FROM branchtransfers
2837 AND datearrived IS NULL "
2839 $sth->execute($itemnumber);
2843 =head2 AnonymiseIssueHistory
2845 ($rows,$err_history_not_deleted) = AnonymiseIssueHistory($date,$borrowernumber)
2847 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2848 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2850 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2851 setting (force delete).
2853 return the number of affected rows and a value that evaluates to true if an error occurred deleting the history.
2857 sub AnonymiseIssueHistory {
2859 my $borrowernumber = shift;
2860 my $dbh = C4::Context->dbh;
2863 SET borrowernumber = ?
2864 WHERE returndate < ?
2865 AND borrowernumber IS NOT NULL
2868 # The default of 0 does not work due to foreign key constraints
2869 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2870 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2871 my @bind_params = ($anonymouspatron, $date);
2872 if (defined $borrowernumber) {
2873 $query .= " AND borrowernumber = ?";
2874 push @bind_params, $borrowernumber;
2876 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2878 my $sth = $dbh->prepare($query);
2879 $sth->execute(@bind_params);
2880 my $anonymisation_err = $dbh->err;
2881 my $rows_affected = $sth->rows; ### doublecheck row count return function
2882 return ($rows_affected, $anonymisation_err);
2885 =head2 SendCirculationAlert
2887 Send out a C<check-in> or C<checkout> alert using the messaging system.
2895 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2899 Hashref of information about the item being checked in or out.
2903 Hashref of information about the borrower of the item.
2907 The branchcode from where the checkout or check-in took place.
2913 SendCirculationAlert({
2916 borrower => $borrower,
2922 sub SendCirculationAlert {
2924 my ($type, $item, $borrower, $branch) =
2925 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2926 my %message_name = (
2927 CHECKIN => 'Item_Check_in',
2928 CHECKOUT => 'Item_Checkout',
2929 RENEWAL => 'Item_Checkout',
2931 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2932 borrowernumber => $borrower->{borrowernumber},
2933 message_name => $message_name{$type},
2935 my $issues_table = ( $type eq 'CHECKOUT' || $type eq 'RENEWAL' ) ? 'issues' : 'old_issues';
2936 my $letter = C4::Letters::GetPreparedLetter (
2937 module => 'circulation',
2938 letter_code => $type,
2939 branchcode => $branch,
2941 $issues_table => $item->{itemnumber},
2942 'items' => $item->{itemnumber},
2943 'biblio' => $item->{biblionumber},
2944 'biblioitems' => $item->{biblionumber},
2945 'borrowers' => $borrower,
2946 'branches' => $branch,
2950 my @transports = keys %{ $borrower_preferences->{transports} };
2951 # warn "no transports" unless @transports;
2953 # warn "transport: $_";
2954 my $message = C4::Message->find_last_message($borrower, $type, $_);
2956 #warn "create new message";
2957 C4::Message->enqueue($letter, $borrower, $_);
2959 #warn "append to old message";
2960 $message->append($letter);
2968 =head2 updateWrongTransfer
2970 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2972 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
2976 sub updateWrongTransfer {
2977 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2978 my $dbh = C4::Context->dbh;
2979 # first step validate the actual line of transfert .
2982 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2984 $sth->execute($FromLibrary,$itemNumber);
2987 # second step create a new line of branchtransfer to the right location .
2988 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2990 #third step changing holdingbranch of item
2991 UpdateHoldingbranch($FromLibrary,$itemNumber);
2994 =head2 UpdateHoldingbranch
2996 $items = UpdateHoldingbranch($branch,$itmenumber);
2998 Simple methode for updating hodlingbranch in items BDD line
3002 sub UpdateHoldingbranch {
3003 my ( $branch,$itemnumber ) = @_;
3004 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
3009 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
3011 this function calculates the due date given the start date and configured circulation rules,
3012 checking against the holidays calendar as per the 'useDaysMode' syspref.
3013 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
3014 C<$itemtype> = itemtype code of item in question
3015 C<$branch> = location whose calendar to use
3016 C<$borrower> = Borrower object
3017 C<$isrenewal> = Boolean: is true if we want to calculate the date due for a renewal. Else is false.
3022 my ( $startdate, $itemtype, $branch, $borrower, $isrenewal ) = @_;
3026 # loanlength now a href
3028 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
3030 my $length_key = ( $isrenewal and defined $loanlength->{renewalperiod} )
3036 if (ref $startdate ne 'DateTime' ) {
3037 $datedue = dt_from_string($datedue);
3039 $datedue = $startdate->clone;
3043 DateTime->now( time_zone => C4::Context->tz() )
3044 ->truncate( to => 'minute' );
3048 # calculate the datedue as normal
3049 if ( C4::Context->preference('useDaysMode') eq 'Days' )
3050 { # ignoring calendar
3051 if ( $loanlength->{lengthunit} eq 'hours' ) {
3052 $datedue->add( hours => $loanlength->{$length_key} );
3054 $datedue->add( days => $loanlength->{$length_key} );
3055 $datedue->set_hour(23);
3056 $datedue->set_minute(59);
3060 if ($loanlength->{lengthunit} eq 'hours') {
3061 $dur = DateTime::Duration->new( hours => $loanlength->{$length_key});
3064 $dur = DateTime::Duration->new( days => $loanlength->{$length_key});
3066 my $calendar = Koha::Calendar->new( branchcode => $branch );
3067 $datedue = $calendar->addDate( $datedue, $dur, $loanlength->{lengthunit} );
3068 if ($loanlength->{lengthunit} eq 'days') {
3069 $datedue->set_hour(23);
3070 $datedue->set_minute(59);
3074 # if Hard Due Dates are used, retreive them and apply as necessary
3075 my ( $hardduedate, $hardduedatecompare ) =
3076 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
3077 if ($hardduedate) { # hardduedates are currently dates
3078 $hardduedate->truncate( to => 'minute' );
3079 $hardduedate->set_hour(23);
3080 $hardduedate->set_minute(59);
3081 my $cmp = DateTime->compare( $hardduedate, $datedue );
3083 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
3084 # if the calculated date is before the 'after' Hard Due Date (floor), override
3085 # if the hard due date is set to 'exactly', overrride
3086 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
3087 $datedue = $hardduedate->clone;
3090 # in all other cases, keep the date due as it is
3094 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
3095 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
3096 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
3097 $expiry_dt->set( hour => 23, minute => 59);
3098 if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
3099 $datedue = $expiry_dt->clone;
3107 =head2 CheckRepeatableHolidays
3109 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
3111 This function checks if the date due is a repeatable holiday
3113 C<$date_due> = returndate calculate with no day check
3114 C<$itemnumber> = itemnumber
3115 C<$branchcode> = localisation of issue
3119 sub CheckRepeatableHolidays{
3120 my($itemnumber,$week_day,$branchcode)=@_;
3121 my $dbh = C4::Context->dbh;
3122 my $query = qq|SELECT count(*)
3123 FROM repeatable_holidays
3126 my $sth = $dbh->prepare($query);
3127 $sth->execute($branchcode,$week_day);
3128 my $result=$sth->fetchrow;
3134 =head2 CheckSpecialHolidays
3136 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3138 This function check if the date is a special holiday
3140 C<$years> = the years of datedue
3141 C<$month> = the month of datedue
3142 C<$day> = the day of datedue
3143 C<$itemnumber> = itemnumber
3144 C<$branchcode> = localisation of issue
3148 sub CheckSpecialHolidays{
3149 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3150 my $dbh = C4::Context->dbh;
3151 my $query=qq|SELECT count(*)
3152 FROM `special_holidays`
3158 my $sth = $dbh->prepare($query);
3159 $sth->execute($years,$month,$day,$branchcode);
3160 my $countspecial=$sth->fetchrow ;
3162 return $countspecial;
3165 =head2 CheckRepeatableSpecialHolidays
3167 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3169 This function check if the date is a repeatble special holidays
3171 C<$month> = the month of datedue
3172 C<$day> = the day of datedue
3173 C<$itemnumber> = itemnumber
3174 C<$branchcode> = localisation of issue
3178 sub CheckRepeatableSpecialHolidays{
3179 my ($month,$day,$itemnumber,$branchcode) = @_;
3180 my $dbh = C4::Context->dbh;
3181 my $query=qq|SELECT count(*)
3182 FROM `repeatable_holidays`
3187 my $sth = $dbh->prepare($query);
3188 $sth->execute($month,$day,$branchcode);
3189 my $countspecial=$sth->fetchrow ;
3191 return $countspecial;
3196 sub CheckValidBarcode{
3198 my $dbh = C4::Context->dbh;
3199 my $query=qq|SELECT count(*)
3203 my $sth = $dbh->prepare($query);
3204 $sth->execute($barcode);
3205 my $exist=$sth->fetchrow ;
3210 =head2 IsBranchTransferAllowed
3212 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3214 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3218 sub IsBranchTransferAllowed {
3219 my ( $toBranch, $fromBranch, $code ) = @_;
3221 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3223 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3224 my $dbh = C4::Context->dbh;
3226 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3227 $sth->execute( $toBranch, $fromBranch, $code );
3228 my $limit = $sth->fetchrow_hashref();
3230 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3231 if ( $limit->{'limitId'} ) {
3238 =head2 CreateBranchTransferLimit
3240 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3242 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3246 sub CreateBranchTransferLimit {
3247 my ( $toBranch, $fromBranch, $code ) = @_;
3248 return unless defined($toBranch) && defined($fromBranch);
3249 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3251 my $dbh = C4::Context->dbh;
3253 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3254 return $sth->execute( $code, $toBranch, $fromBranch );
3257 =head2 DeleteBranchTransferLimits
3259 DeleteBranchTransferLimits($frombranch);
3261 Deletes all the branch transfer limits for one branch
3265 sub DeleteBranchTransferLimits {
3267 return unless $branch;
3268 my $dbh = C4::Context->dbh;
3269 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3270 return $sth->execute($branch);
3274 my ( $borrowernumber, $itemnum ) = @_;
3276 MarkIssueReturned( $borrowernumber, $itemnum );
3277 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3278 my $item = C4::Items::GetItem( $itemnum );
3279 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3280 my @datearr = localtime(time);
3281 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3282 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3283 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3288 my ($itemnumber, $mark_returned, $charge_fee) = @_;
3290 my $dbh = C4::Context->dbh();
3291 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3293 JOIN items USING (itemnumber)
3294 JOIN biblio USING (biblionumber)
3295 WHERE issues.itemnumber=?");
3296 $sth->execute($itemnumber);
3297 my $issues=$sth->fetchrow_hashref();
3300 # if a borrower lost the item, add a replacement cost to the their record
3301 if ( my $borrowernumber = $issues->{borrowernumber} ){
3302 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3304 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}")
3306 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3307 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3308 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3312 sub GetOfflineOperations {
3313 my $dbh = C4::Context->dbh;
3314 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3315 $sth->execute(C4::Context->userenv->{'branch'});
3316 my $results = $sth->fetchall_arrayref({});
3321 sub GetOfflineOperation {
3322 my $dbh = C4::Context->dbh;
3323 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3324 $sth->execute( shift );
3325 my $result = $sth->fetchrow_hashref;
3330 sub AddOfflineOperation {
3331 my ( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount ) = @_;
3332 my $dbh = C4::Context->dbh;
3333 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber, amount) VALUES(?,?,?,?,?,?,?)");
3334 $sth->execute( $userid, $branchcode, $timestamp, $action, $barcode, $cardnumber, $amount );
3338 sub DeleteOfflineOperation {
3339 my $dbh = C4::Context->dbh;
3340 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3341 $sth->execute( shift );
3345 sub ProcessOfflineOperation {
3346 my $operation = shift;
3349 if ( $operation->{action} eq 'return' ) {
3350 $report = ProcessOfflineReturn( $operation );
3351 } elsif ( $operation->{action} eq 'issue' ) {
3352 $report = ProcessOfflineIssue( $operation );
3353 } elsif ( $operation->{action} eq 'payment' ) {
3354 $report = ProcessOfflinePayment( $operation );
3357 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3362 sub ProcessOfflineReturn {
3363 my $operation = shift;
3365 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3367 if ( $itemnumber ) {
3368 my $issue = GetOpenIssue( $itemnumber );
3371 $issue->{borrowernumber},
3374 $operation->{timestamp},
3377 { renewals => 0, onloan => undef },
3378 $issue->{'biblionumber'},
3383 return "Item not issued.";
3386 return "Item not found.";
3390 sub ProcessOfflineIssue {
3391 my $operation = shift;
3393 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3395 if ( $borrower->{borrowernumber} ) {
3396 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3397 unless ($itemnumber) {
3398 return "Barcode not found.";
3400 my $issue = GetOpenIssue( $itemnumber );
3402 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3404 $issue->{borrowernumber},
3407 $operation->{timestamp},
3412 $operation->{'barcode'},
3415 $operation->{timestamp},
3420 return "Borrower not found.";
3424 sub ProcessOfflinePayment {
3425 my $operation = shift;
3427 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3428 my $amount = $operation->{amount};
3430 recordpayment( $borrower->{borrowernumber}, $amount );
3438 TransferSlip($user_branch, $itemnumber, $to_branch)
3440 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3445 my ($branch, $itemnumber, $to_branch) = @_;
3447 my $item = GetItem( $itemnumber )
3450 my $pulldate = C4::Dates->new();
3452 return C4::Letters::GetPreparedLetter (
3453 module => 'circulation',
3454 letter_code => 'TRANSFERSLIP',
3455 branchcode => $branch,
3457 'branches' => $to_branch,
3458 'biblio' => $item->{biblionumber},
3464 =head2 CheckIfIssuedToPatron
3466 CheckIfIssuedToPatron($borrowernumber, $biblionumber)
3468 Return 1 if any record item is issued to patron, otherwise return 0
3472 sub CheckIfIssuedToPatron {
3473 my ($borrowernumber, $biblionumber) = @_;
3475 my $items = GetItemsByBiblioitemnumber($biblionumber);
3477 foreach my $item (@{$items}) {
3478 return 1 if ($item->{borrowernumber} && $item->{borrowernumber} eq $borrowernumber);
3491 Koha Development Team <http://koha-community.org/>