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
33 use C4::ItemCirculationAlertPreference;
34 use C4::Dates qw(format_date);
47 use POSIX qw(strftime);
48 use C4::Branch; # GetBranches
49 use C4::Log; # logaction
53 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
57 $VERSION = 3.02; # for version checking
60 # FIXME subs that should probably be elsewhere
67 # subs to deal with issuing a book
78 &GetBranchBorrowerCircRule
82 &AnonymiseIssueHistory
85 # subs to deal with returns
91 # subs to deal with transfers
98 &IsBranchTransferAllowed
99 &CreateBranchTransferLimit
100 &DeleteBranchTransferLimits
106 C4::Circulation - Koha circulation module
114 The functions in this module deal with circulation, issues, and
115 returns, as well as general information about the library.
116 Also deals with stocktaking.
122 $str = &barcodedecode($barcode, [$filter]);
124 Generic filter function for barcode string.
125 Called on every circ if the System Pref itemBarcodeInputFilter is set.
126 Will do some manipulation of the barcode for systems that deliver a barcode
127 to circulation.pl that differs from the barcode stored for the item.
128 For proper functioning of this filter, calling the function on the
129 correct barcode string (items.barcode) should return an unaltered barcode.
131 The optional $filter argument is to allow for testing or explicit
132 behavior that ignores the System Pref. Valid values are the same as the
137 # FIXME -- the &decode fcn below should be wrapped into this one.
138 # FIXME -- these plugins should be moved out of Circulation.pm
141 my ($barcode, $filter) = @_;
142 my $branch = C4::Branch::mybranch();
143 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
144 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
145 if ($filter eq 'whitespace') {
147 } elsif ($filter eq 'cuecat') {
149 my @fields = split( /\./, $barcode );
150 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
151 ($#results == 2) and return $results[2];
152 } elsif ($filter eq 'T-prefix') {
153 if ($barcode =~ /^[Tt](\d)/) {
154 (defined($1) and $1 eq '0') and return $barcode;
155 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
157 return sprintf("T%07d", $barcode);
158 # FIXME: $barcode could be "T1", causing warning: substr outside of string
159 # Why drop the nonzero digit after the T?
160 # Why pass non-digits (or empty string) to "T%07d"?
161 } elsif ($filter eq 'libsuite8') {
162 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
163 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
164 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
166 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
170 return $barcode; # return barcode, modified or not
175 $str = &decode($chunk);
177 Decodes a segment of a string emitted by a CueCat barcode scanner and
180 FIXME: Should be replaced with Barcode::Cuecat from CPAN
181 or Javascript based decoding on the client side.
188 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
189 my @s = map { index( $seq, $_ ); } split( //, $encoded );
190 my $l = ( $#s + 1 ) % 4;
193 # warn "Error: Cuecat decode parsing failed!";
201 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
203 chr( ( $n >> 16 ) ^ 67 )
204 .chr( ( $n >> 8 & 255 ) ^ 67 )
205 .chr( ( $n & 255 ) ^ 67 );
208 $r = substr( $r, 0, length($r) - $l );
214 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
215 $barcode, $ignore_reserves);
217 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
219 C<$newbranch> is the code for the branch to which the item should be transferred.
221 C<$barcode> is the barcode of the item to be transferred.
223 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
224 Otherwise, if an item is reserved, the transfer fails.
226 Returns three values:
232 is true if the transfer was successful.
236 is a reference-to-hash which may have any of the following keys:
242 There is no item in the catalog with the given barcode. The value is C<$barcode>.
246 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.
248 =item C<DestinationEqualsHolding>
250 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.
254 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.
258 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>.
260 =item C<WasTransferred>
262 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
271 my ( $tbr, $barcode, $ignoreRs ) = @_;
274 my $branches = GetBranches();
275 my $itemnumber = GetItemnumberFromBarcode( $barcode );
276 my $issue = GetItemIssue($itemnumber);
277 my $biblio = GetBiblioFromItemNumber($itemnumber);
280 if ( not $itemnumber ) {
281 $messages->{'BadBarcode'} = $barcode;
285 # get branches of book...
286 my $hbr = $biblio->{'homebranch'};
287 my $fbr = $biblio->{'holdingbranch'};
289 # if using Branch Transfer Limits
290 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
291 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
292 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
293 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
296 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
297 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
303 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
304 $messages->{'IsPermanent'} = $hbr;
308 # can't transfer book if is already there....
309 if ( $fbr eq $tbr ) {
310 $messages->{'DestinationEqualsHolding'} = 1;
314 # check if it is still issued to someone, return it...
315 if ($issue->{borrowernumber}) {
316 AddReturn( $barcode, $fbr );
317 $messages->{'WasReturned'} = $issue->{borrowernumber};
321 # That'll save a database query.
322 my ( $resfound, $resrec, undef ) =
323 CheckReserves( $itemnumber );
324 if ( $resfound and not $ignoreRs ) {
325 $resrec->{'ResFound'} = $resfound;
327 # $messages->{'ResFound'} = $resrec;
331 #actually do the transfer....
333 ModItemTransfer( $itemnumber, $fbr, $tbr );
335 # don't need to update MARC anymore, we do it in batch now
336 $messages->{'WasTransfered'} = 1;
339 ModDateLastSeen( $itemnumber );
340 return ( $dotransfer, $messages, $biblio );
345 my $borrower = shift;
346 my $biblionumber = shift;
348 my $cat_borrower = $borrower->{'categorycode'};
349 my $dbh = C4::Context->dbh;
351 # Get which branchcode we need
352 $branch = _GetCircControlBranch($item,$borrower);
353 my $type = (C4::Context->preference('item-level_itypes'))
354 ? $item->{'itype'} # item-level
355 : $item->{'itemtype'}; # biblio-level
357 # given branch, patron category, and item type, determine
358 # applicable issuing rule
359 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
361 # if a rule is found and has a loan limit set, count
362 # how many loans the patron already has that meet that
364 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
366 my $count_query = "SELECT COUNT(*) FROM issues
367 JOIN items USING (itemnumber) ";
369 my $rule_itemtype = $issuing_rule->{itemtype};
370 if ($rule_itemtype eq "*") {
371 # matching rule has the default item type, so count only
372 # those existing loans that don't fall under a more
374 if (C4::Context->preference('item-level_itypes')) {
375 $count_query .= " WHERE items.itype NOT IN (
376 SELECT itemtype FROM issuingrules
378 AND (categorycode = ? OR categorycode = ?)
382 $count_query .= " JOIN biblioitems USING (biblionumber)
383 WHERE biblioitems.itemtype NOT IN (
384 SELECT itemtype FROM issuingrules
386 AND (categorycode = ? OR categorycode = ?)
390 push @bind_params, $issuing_rule->{branchcode};
391 push @bind_params, $issuing_rule->{categorycode};
392 push @bind_params, $cat_borrower;
394 # rule has specific item type, so count loans of that
396 if (C4::Context->preference('item-level_itypes')) {
397 $count_query .= " WHERE items.itype = ? ";
399 $count_query .= " JOIN biblioitems USING (biblionumber)
400 WHERE biblioitems.itemtype= ? ";
402 push @bind_params, $type;
405 $count_query .= " AND borrowernumber = ? ";
406 push @bind_params, $borrower->{'borrowernumber'};
407 my $rule_branch = $issuing_rule->{branchcode};
408 if ($rule_branch ne "*") {
409 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
410 $count_query .= " AND issues.branchcode = ? ";
411 push @bind_params, $branch;
412 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
413 ; # if branch is the patron's home branch, then count all loans by patron
415 $count_query .= " AND items.homebranch = ? ";
416 push @bind_params, $branch;
420 my $count_sth = $dbh->prepare($count_query);
421 $count_sth->execute(@bind_params);
422 my ($current_loan_count) = $count_sth->fetchrow_array;
424 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
425 if ($current_loan_count >= $max_loans_allowed) {
426 return ($current_loan_count, $max_loans_allowed);
430 # Now count total loans against the limit for the branch
431 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
432 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
433 my @bind_params = ();
434 my $branch_count_query = "SELECT COUNT(*) FROM issues
435 JOIN items USING (itemnumber)
436 WHERE borrowernumber = ? ";
437 push @bind_params, $borrower->{borrowernumber};
439 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
440 $branch_count_query .= " AND issues.branchcode = ? ";
441 push @bind_params, $branch;
442 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
443 ; # if branch is the patron's home branch, then count all loans by patron
445 $branch_count_query .= " AND items.homebranch = ? ";
446 push @bind_params, $branch;
448 my $branch_count_sth = $dbh->prepare($branch_count_query);
449 $branch_count_sth->execute(@bind_params);
450 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
452 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
453 if ($current_loan_count >= $max_loans_allowed) {
454 return ($current_loan_count, $max_loans_allowed);
458 # OK, the patron can issue !!!
464 @issues = &itemissues($biblioitemnumber, $biblio);
466 Looks up information about who has borrowed the bookZ<>(s) with the
467 given biblioitemnumber.
469 C<$biblio> is ignored.
471 C<&itemissues> returns an array of references-to-hash. The keys
472 include the fields from the C<items> table in the Koha database.
473 Additional keys include:
479 If the item is currently on loan, this gives the due date.
481 If the item is not on loan, then this is either "Available" or
482 "Cancelled", if the item has been withdrawn.
486 If the item is currently on loan, this gives the card number of the
487 patron who currently has the item.
489 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
491 These give the timestamp for the last three times the item was
494 =item C<card0>, C<card1>, C<card2>
496 The card number of the last three patrons who borrowed this item.
498 =item C<borrower0>, C<borrower1>, C<borrower2>
500 The borrower number of the last three patrons who borrowed this item.
508 my ( $bibitem, $biblio ) = @_;
509 my $dbh = C4::Context->dbh;
511 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
516 $sth->execute($bibitem) || die $sth->errstr;
518 while ( my $data = $sth->fetchrow_hashref ) {
520 # Find out who currently has this item.
521 # FIXME - Wouldn't it be better to do this as a left join of
522 # some sort? Currently, this code assumes that if
523 # fetchrow_hashref() fails, then the book is on the shelf.
524 # fetchrow_hashref() can fail for any number of reasons (e.g.,
525 # database server crash), not just because no items match the
527 my $sth2 = $dbh->prepare(
528 "SELECT * FROM issues
529 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
534 $sth2->execute( $data->{'itemnumber'} );
535 if ( my $data2 = $sth2->fetchrow_hashref ) {
536 $data->{'date_due'} = $data2->{'date_due'};
537 $data->{'card'} = $data2->{'cardnumber'};
538 $data->{'borrower'} = $data2->{'borrowernumber'};
541 $data->{'date_due'} = ($data->{'wthdrawn'} eq '1') ? 'Cancelled' : 'Available';
545 # Find the last 3 people who borrowed this item.
546 $sth2 = $dbh->prepare(
547 "SELECT * FROM old_issues
548 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
550 ORDER BY returndate DESC,timestamp DESC"
553 $sth2->execute( $data->{'itemnumber'} );
554 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
555 { # FIXME : error if there is less than 3 pple borrowing this item
556 if ( my $data2 = $sth2->fetchrow_hashref ) {
557 $data->{"timestamp$i2"} = $data2->{'timestamp'};
558 $data->{"card$i2"} = $data2->{'cardnumber'};
559 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
563 $results[$i] = $data;
570 =head2 CanBookBeIssued
572 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
573 $barcode, $duedatespec, $inprocess );
575 Check if a book can be issued.
577 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
581 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
583 =item C<$barcode> is the bar code of the book being issued.
585 =item C<$duedatespec> is a C4::Dates object.
595 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
596 Possible values are :
602 sticky due date is invalid
606 borrower gone with no address
610 borrower declared it's card lost
616 =head3 UNKNOWN_BARCODE
630 item is restricted (set by ??)
632 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
633 could be prevented, but ones that can be overriden by the operator.
635 Possible values are :
643 renewing, not issuing
645 =head3 ISSUED_TO_ANOTHER
647 issued to someone else.
651 reserved for someone else.
655 sticky due date is invalid or due date in the past
659 if the borrower borrows to much things
663 sub CanBookBeIssued {
664 my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
665 my %needsconfirmation; # filled with problems that needs confirmations
666 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
667 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
668 my $issue = GetItemIssue($item->{itemnumber});
669 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
670 $item->{'itemtype'}=$item->{'itype'};
671 my $dbh = C4::Context->dbh;
673 # MANDATORY CHECKS - unless item exists, nothing else matters
674 unless ( $item->{barcode} ) {
675 $issuingimpossible{UNKNOWN_BARCODE} = 1;
677 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
680 # DUE DATE is OK ? -- should already have checked.
682 unless ( $duedate ) {
683 my $issuedate = strftime( "%Y-%m-%d", localtime );
685 my $branch = _GetCircControlBranch($item,$borrower);
686 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
687 $duedate = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $itype, $branch, $borrower );
689 # Offline circ calls AddIssue directly, doesn't run through here
690 # So issuingimpossible should be ok.
693 $needsconfirmation{INVALID_DATE} = $duedate->output('syspref')
694 unless $duedate->output('iso') ge C4::Dates->today('iso');
696 $issuingimpossible{INVALID_DATE} = $duedate->output('syspref');
702 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
703 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
704 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'});
705 ModDateLastSeen( $item->{'itemnumber'} );
706 return( { STATS => 1 }, {});
708 if ( $borrower->{flags}->{GNA} ) {
709 $issuingimpossible{GNA} = 1;
711 if ( $borrower->{flags}->{'LOST'} ) {
712 $issuingimpossible{CARD_LOST} = 1;
714 if ( $borrower->{flags}->{'DBARRED'} ) {
715 $issuingimpossible{DEBARRED} = 1;
717 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
718 $issuingimpossible{EXPIRED} = 1;
720 my @expirydate= split /-/,$borrower->{'dateexpiry'};
721 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
722 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
723 $issuingimpossible{EXPIRED} = 1;
732 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
733 my $amountlimit = C4::Context->preference("noissuescharge");
734 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
735 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
736 if ( C4::Context->preference("IssuingInProcess") ) {
737 if ( $amount > $amountlimit && !$inprocess && !$allowfineoverride) {
738 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
739 } elsif ( $amount > $amountlimit && !$inprocess && $allowfineoverride) {
740 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
741 } elsif ( $allfinesneedoverride && $amount > 0 && $amount <= $amountlimit && !$inprocess ) {
742 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
746 if ( $amount > $amountlimit && $allowfineoverride ) {
747 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
748 } elsif ( $amount > $amountlimit && !$allowfineoverride) {
749 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
750 } elsif ( $amount > 0 && $allfinesneedoverride ) {
751 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
755 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
756 if ($blocktype == -1) {
757 ## patron has outstanding overdue loans
758 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
759 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
761 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
762 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
764 } elsif($blocktype == 1) {
765 # patron has accrued fine days
766 $issuingimpossible{USERBLOCKEDREMAINING} = $count;
770 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
772 my ($current_loan_count, $max_loans_allowed) = TooMany( $borrower, $item->{biblionumber}, $item );
773 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
774 if ($max_loans_allowed eq 0) {
775 $needsconfirmation{PATRON_CANT} = 1;
777 if($max_loans_allowed){
778 $needsconfirmation{TOO_MANY} = 1;
779 $needsconfirmation{current_loan_count} = $current_loan_count;
780 $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
787 if ( $item->{'notforloan'}
788 && $item->{'notforloan'} > 0 )
790 if(!C4::Context->preference("AllowNotForLoanOverride")){
791 $issuingimpossible{NOT_FOR_LOAN} = 1;
793 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
796 elsif ( !$item->{'notforloan'} ){
797 # we have to check itemtypes.notforloan also
798 if (C4::Context->preference('item-level_itypes')){
799 # this should probably be a subroutine
800 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
801 $sth->execute($item->{'itemtype'});
802 my $notforloan=$sth->fetchrow_hashref();
804 if ($notforloan->{'notforloan'}) {
805 if (!C4::Context->preference("AllowNotForLoanOverride")) {
806 $issuingimpossible{NOT_FOR_LOAN} = 1;
808 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
812 elsif ($biblioitem->{'notforloan'} == 1){
813 if (!C4::Context->preference("AllowNotForLoanOverride")) {
814 $issuingimpossible{NOT_FOR_LOAN} = 1;
816 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
820 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} > 0 )
822 $issuingimpossible{WTHDRAWN} = 1;
824 if ( $item->{'restricted'}
825 && $item->{'restricted'} == 1 )
827 $issuingimpossible{RESTRICTED} = 1;
829 if ( C4::Context->preference("IndependantBranches") ) {
830 my $userenv = C4::Context->userenv;
831 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
832 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1
833 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
834 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
835 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
840 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
842 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
845 # Already issued to current borrower. Ask whether the loan should
847 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
848 $borrower->{'borrowernumber'},
849 $item->{'itemnumber'}
851 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
852 $issuingimpossible{NO_MORE_RENEWALS} = 1;
855 $needsconfirmation{RENEW_ISSUE} = 1;
858 elsif ($issue->{borrowernumber}) {
860 # issued to someone else
861 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
863 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
864 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
865 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
866 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
867 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
868 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
871 # See if the item is on reserve.
872 my ( $restype, $res, undef ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
874 my $resbor = $res->{'borrowernumber'};
875 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
876 my $branches = GetBranches();
877 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
878 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
880 # The item is on reserve and waiting, but has been
881 # reserved by some other patron.
882 $needsconfirmation{RESERVE_WAITING} = 1;
883 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
884 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
885 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
886 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
887 $needsconfirmation{'resbranchname'} = $branchname;
888 $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
890 elsif ( $restype eq "Reserved" ) {
891 # The item is on reserve for someone else.
892 $needsconfirmation{RESERVED} = 1;
893 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
894 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
895 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
896 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
897 $needsconfirmation{'resbranchname'} = $branchname;
898 $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
901 return ( \%issuingimpossible, \%needsconfirmation );
906 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
908 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
912 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
914 =item C<$barcode> is the barcode of the item being issued.
916 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
919 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
921 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
922 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
924 AddIssue does the following things :
926 - step 01: check that there is a borrowernumber & a barcode provided
927 - check for RENEWAL (book issued & being issued to the same patron)
928 - renewal YES = Calculate Charge & renew
930 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
932 - fill reserve if reserve to this patron
933 - cancel reserve or not, otherwise
934 * TRANSFERT PENDING ?
935 - complete the transfert
943 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
944 my $dbh = C4::Context->dbh;
945 my $barcodecheck=CheckValidBarcode($barcode);
946 # $issuedate defaults to today.
947 if ( ! defined $issuedate ) {
948 $issuedate = strftime( "%Y-%m-%d", localtime );
949 # TODO: for hourly circ, this will need to be a C4::Dates object
950 # and all calls to AddIssue including issuedate will need to pass a Dates object.
952 if ($borrower and $barcode and $barcodecheck ne '0'){
953 # find which item we issue
954 my $item = GetItem('', $barcode) or return undef; # if we don't get an Item, abort.
955 my $branch = _GetCircControlBranch($item,$borrower);
957 # get actual issuing if there is one
958 my $actualissue = GetItemIssue( $item->{itemnumber});
960 # get biblioinformation for this item
961 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
964 # check if we just renew the issue.
966 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
967 $datedue = AddRenewal(
968 $borrower->{'borrowernumber'},
969 $item->{'itemnumber'},
972 $issuedate, # here interpreted as the renewal date
977 if ( $actualissue->{borrowernumber}) {
978 # This book is currently on loan, but not to the person
979 # who wants to borrow it now. mark it returned before issuing to the new borrower
982 C4::Context->userenv->{'branch'}
986 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
988 # Starting process for transfer job (checking transfert and validate it if we have one)
989 my ($datesent) = GetTransfers($item->{'itemnumber'});
991 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
994 "UPDATE branchtransfers
995 SET datearrived = now(),
997 comments = 'Forced branchtransfer'
998 WHERE itemnumber= ? AND datearrived IS NULL"
1000 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1003 # Record in the database the fact that the book was issued.
1007 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1011 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1012 $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $itype, $branch, $borrower );
1016 $borrower->{'borrowernumber'}, # borrowernumber
1017 $item->{'itemnumber'}, # itemnumber
1018 $issuedate, # issuedate
1019 $datedue->output('iso'), # date_due
1020 C4::Context->userenv->{'branch'} # branchcode
1023 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1024 CartToShelf( $item->{'itemnumber'} );
1026 $item->{'issues'}++;
1027 ModItem({ issues => $item->{'issues'},
1028 holdingbranch => C4::Context->userenv->{'branch'},
1030 datelastborrowed => C4::Dates->new()->output('iso'),
1031 onloan => $datedue->output('iso'),
1032 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1033 ModDateLastSeen( $item->{'itemnumber'} );
1035 # If it costs to borrow this book, charge it to the patron's account.
1036 my ( $charge, $itemtype ) = GetIssuingCharges(
1037 $item->{'itemnumber'},
1038 $borrower->{'borrowernumber'}
1040 if ( $charge > 0 ) {
1042 $item->{'itemnumber'},
1043 $borrower->{'borrowernumber'}, $charge
1045 $item->{'charge'} = $charge;
1048 # Record the fact that this book was issued.
1050 C4::Context->userenv->{'branch'},
1052 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1053 $item->{'itype'}, $borrower->{'borrowernumber'}
1056 # Send a checkout slip.
1057 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1059 branchcode => $branch,
1060 categorycode => $borrower->{categorycode},
1061 item_type => $item->{itype},
1062 notification => 'CHECKOUT',
1064 if ($circulation_alert->is_enabled_for(\%conditions)) {
1065 SendCirculationAlert({
1068 borrower => $borrower,
1074 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1075 if C4::Context->preference("IssueLog");
1077 return ($datedue); # not necessarily the same as when it came in!
1080 =head2 GetLoanLength
1082 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1084 Get loan length for an itemtype, a borrower type and a branch
1089 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1090 my $dbh = C4::Context->dbh;
1093 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1095 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1096 # try to find issuelength & return the 1st available.
1097 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1098 $sth->execute( $borrowertype, $itemtype, $branchcode );
1099 my $loanlength = $sth->fetchrow_hashref;
1100 return $loanlength->{issuelength}
1101 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1103 $sth->execute( $borrowertype, "*", $branchcode );
1104 $loanlength = $sth->fetchrow_hashref;
1105 return $loanlength->{issuelength}
1106 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1108 $sth->execute( "*", $itemtype, $branchcode );
1109 $loanlength = $sth->fetchrow_hashref;
1110 return $loanlength->{issuelength}
1111 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1113 $sth->execute( "*", "*", $branchcode );
1114 $loanlength = $sth->fetchrow_hashref;
1115 return $loanlength->{issuelength}
1116 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1118 $sth->execute( $borrowertype, $itemtype, "*" );
1119 $loanlength = $sth->fetchrow_hashref;
1120 return $loanlength->{issuelength}
1121 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1123 $sth->execute( $borrowertype, "*", "*" );
1124 $loanlength = $sth->fetchrow_hashref;
1125 return $loanlength->{issuelength}
1126 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1128 $sth->execute( "*", $itemtype, "*" );
1129 $loanlength = $sth->fetchrow_hashref;
1130 return $loanlength->{issuelength}
1131 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1133 $sth->execute( "*", "*", "*" );
1134 $loanlength = $sth->fetchrow_hashref;
1135 return $loanlength->{issuelength}
1136 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1138 # if no rule is set => 21 days (hardcoded)
1143 =head2 GetHardDueDate
1145 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1147 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1151 sub GetHardDueDate {
1152 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1153 my $dbh = C4::Context->dbh;
1156 "select hardduedate, hardduedatecompare from issuingrules where categorycode=? and itemtype=? and branchcode=?"
1158 $sth->execute( $borrowertype, $itemtype, $branchcode );
1159 my $results = $sth->fetchrow_hashref;
1160 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1161 if defined($results) && $results->{hardduedate} ne 'NULL';
1163 $sth->execute( $borrowertype, "*", $branchcode );
1164 $results = $sth->fetchrow_hashref;
1165 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1166 if defined($results) && $results->{hardduedate} ne 'NULL';
1168 $sth->execute( "*", $itemtype, $branchcode );
1169 $results = $sth->fetchrow_hashref;
1170 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1171 if defined($results) && $results->{hardduedate} ne 'NULL';
1173 $sth->execute( "*", "*", $branchcode );
1174 $results = $sth->fetchrow_hashref;
1175 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1176 if defined($results) && $results->{hardduedate} ne 'NULL';
1178 $sth->execute( $borrowertype, $itemtype, "*" );
1179 $results = $sth->fetchrow_hashref;
1180 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1181 if defined($results) && $results->{hardduedate} ne 'NULL';
1183 $sth->execute( $borrowertype, "*", "*" );
1184 $results = $sth->fetchrow_hashref;
1185 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1186 if defined($results) && $results->{hardduedate} ne 'NULL';
1188 $sth->execute( "*", $itemtype, "*" );
1189 $results = $sth->fetchrow_hashref;
1190 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1191 if defined($results) && $results->{hardduedate} ne 'NULL';
1193 $sth->execute( "*", "*", "*" );
1194 $results = $sth->fetchrow_hashref;
1195 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1196 if defined($results) && $results->{hardduedate} ne 'NULL';
1198 # if no rule is set => return undefined
1199 return (undef, undef);
1202 =head2 GetIssuingRule
1204 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1206 FIXME - This is a copy-paste of GetLoanLength
1207 as a stop-gap. Do not wish to change API for GetLoanLength
1208 this close to release, however, Overdues::GetIssuingRules is broken.
1210 Get the issuing rule for an itemtype, a borrower type and a branch
1211 Returns a hashref from the issuingrules table.
1215 sub GetIssuingRule {
1216 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1217 my $dbh = C4::Context->dbh;
1218 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1221 $sth->execute( $borrowertype, $itemtype, $branchcode );
1222 $irule = $sth->fetchrow_hashref;
1223 return $irule if defined($irule) ;
1225 $sth->execute( $borrowertype, "*", $branchcode );
1226 $irule = $sth->fetchrow_hashref;
1227 return $irule if defined($irule) ;
1229 $sth->execute( "*", $itemtype, $branchcode );
1230 $irule = $sth->fetchrow_hashref;
1231 return $irule if defined($irule) ;
1233 $sth->execute( "*", "*", $branchcode );
1234 $irule = $sth->fetchrow_hashref;
1235 return $irule if defined($irule) ;
1237 $sth->execute( $borrowertype, $itemtype, "*" );
1238 $irule = $sth->fetchrow_hashref;
1239 return $irule if defined($irule) ;
1241 $sth->execute( $borrowertype, "*", "*" );
1242 $irule = $sth->fetchrow_hashref;
1243 return $irule if defined($irule) ;
1245 $sth->execute( "*", $itemtype, "*" );
1246 $irule = $sth->fetchrow_hashref;
1247 return $irule if defined($irule) ;
1249 $sth->execute( "*", "*", "*" );
1250 $irule = $sth->fetchrow_hashref;
1251 return $irule if defined($irule) ;
1253 # if no rule matches,
1257 =head2 GetBranchBorrowerCircRule
1259 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1261 Retrieves circulation rule attributes that apply to the given
1262 branch and patron category, regardless of item type.
1263 The return value is a hashref containing the following key:
1265 maxissueqty - maximum number of loans that a
1266 patron of the given category can have at the given
1267 branch. If the value is undef, no limit.
1269 This will first check for a specific branch and
1270 category match from branch_borrower_circ_rules.
1272 If no rule is found, it will then check default_branch_circ_rules
1273 (same branch, default category). If no rule is found,
1274 it will then check default_borrower_circ_rules (default
1275 branch, same category), then failing that, default_circ_rules
1276 (default branch, default category).
1278 If no rule has been found in the database, it will default to
1283 C<$branchcode> and C<$categorycode> should contain the
1284 literal branch code and patron category code, respectively - no
1289 sub GetBranchBorrowerCircRule {
1290 my $branchcode = shift;
1291 my $categorycode = shift;
1293 my $branch_cat_query = "SELECT maxissueqty
1294 FROM branch_borrower_circ_rules
1295 WHERE branchcode = ?
1296 AND categorycode = ?";
1297 my $dbh = C4::Context->dbh();
1298 my $sth = $dbh->prepare($branch_cat_query);
1299 $sth->execute($branchcode, $categorycode);
1301 if ($result = $sth->fetchrow_hashref()) {
1305 # try same branch, default borrower category
1306 my $branch_query = "SELECT maxissueqty
1307 FROM default_branch_circ_rules
1308 WHERE branchcode = ?";
1309 $sth = $dbh->prepare($branch_query);
1310 $sth->execute($branchcode);
1311 if ($result = $sth->fetchrow_hashref()) {
1315 # try default branch, same borrower category
1316 my $category_query = "SELECT maxissueqty
1317 FROM default_borrower_circ_rules
1318 WHERE categorycode = ?";
1319 $sth = $dbh->prepare($category_query);
1320 $sth->execute($categorycode);
1321 if ($result = $sth->fetchrow_hashref()) {
1325 # try default branch, default borrower category
1326 my $default_query = "SELECT maxissueqty
1327 FROM default_circ_rules";
1328 $sth = $dbh->prepare($default_query);
1330 if ($result = $sth->fetchrow_hashref()) {
1334 # built-in default circulation rule
1336 maxissueqty => undef,
1340 =head2 GetBranchItemRule
1342 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1344 Retrieves circulation rule attributes that apply to the given
1345 branch and item type, regardless of patron category.
1347 The return value is a hashref containing the following key:
1349 holdallowed => Hold policy for this branch and itemtype. Possible values:
1350 0: No holds allowed.
1351 1: Holds allowed only by patrons that have the same homebranch as the item.
1352 2: Holds allowed from any patron.
1354 This searches branchitemrules in the following order:
1356 * Same branchcode and itemtype
1357 * Same branchcode, itemtype '*'
1358 * branchcode '*', same itemtype
1359 * branchcode and itemtype '*'
1361 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1365 sub GetBranchItemRule {
1366 my ( $branchcode, $itemtype ) = @_;
1367 my $dbh = C4::Context->dbh();
1371 ['SELECT holdallowed
1372 FROM branch_item_rules
1373 WHERE branchcode = ?
1374 AND itemtype = ?', $branchcode, $itemtype],
1375 ['SELECT holdallowed
1376 FROM default_branch_circ_rules
1377 WHERE branchcode = ?', $branchcode],
1378 ['SELECT holdallowed
1379 FROM default_branch_item_rules
1380 WHERE itemtype = ?', $itemtype],
1381 ['SELECT holdallowed
1382 FROM default_circ_rules'],
1385 foreach my $attempt (@attempts) {
1386 my ($query, @bind_params) = @{$attempt};
1388 # Since branch/category and branch/itemtype use the same per-branch
1389 # defaults tables, we have to check that the key we want is set, not
1390 # just that a row was returned
1391 return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1394 # built-in default circulation rule
1402 ($doreturn, $messages, $iteminformation, $borrower) =
1403 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1409 =item C<$barcode> is the bar code of the book being returned.
1411 =item C<$branch> is the code of the branch where the book is being returned.
1413 =item C<$exemptfine> indicates that overdue charges for the item will be
1416 =item C<$dropbox> indicates that the check-in date is assumed to be
1417 yesterday, or the last non-holiday as defined in C4::Calendar . If
1418 overdue charges are applied and C<$dropbox> is true, the last charge
1419 will be removed. This assumes that the fines accrual script has run
1424 C<&AddReturn> returns a list of four items:
1426 C<$doreturn> is true iff the return succeeded.
1428 C<$messages> is a reference-to-hash giving feedback on the operation.
1429 The keys of the hash are:
1435 No item with this barcode exists. The value is C<$barcode>.
1439 The book is not currently on loan. The value is C<$barcode>.
1441 =item C<IsPermanent>
1443 The book's home branch is a permanent collection. If you have borrowed
1444 this book, you are not allowed to return it. The value is the code for
1445 the book's home branch.
1449 This book has been withdrawn/cancelled. The value should be ignored.
1451 =item C<Wrongbranch>
1453 This book has was returned to the wrong branch. The value is a hashref
1454 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1455 contain the branchcode of the incorrect and correct return library, respectively.
1459 The item was reserved. The value is a reference-to-hash whose keys are
1460 fields from the reserves table of the Koha database, and
1461 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1462 either C<Waiting>, C<Reserved>, or 0.
1466 C<$iteminformation> is a reference-to-hash, giving information about the
1467 returned item from the issues table.
1469 C<$borrower> is a reference-to-hash, giving information about the
1470 patron who last borrowed the book.
1475 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1476 if ($branch and not GetBranchDetail($branch)) {
1477 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1480 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1485 my $validTransfert = 0;
1486 my $stat_type = 'return';
1488 # get information on item
1489 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1490 unless ($itemnumber) {
1491 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1493 my $issue = GetItemIssue($itemnumber);
1494 # warn Dumper($iteminformation);
1495 if ($issue and $issue->{borrowernumber}) {
1496 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1497 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1498 . Dumper($issue) . "\n";
1500 $messages->{'NotIssued'} = $barcode;
1501 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1503 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1504 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1505 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1506 $messages->{'LocalUse'} = 1;
1507 $stat_type = 'localuse';
1511 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1512 # full item data, but no borrowernumber or checkout info (no issue)
1513 # we know GetItem should work because GetItemnumberFromBarcode worked
1514 my $hbr = C4::Context->preference("HomeOrHoldingBranchReturn") || "homebranch";
1515 $hbr = $item->{$hbr} || '';
1516 # item must be from items table -- issues table has branchcode and issuingbranch, not homebranch nor holdingbranch
1518 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1520 # check if the book is in a permanent collection....
1521 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1523 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1524 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1527 # if indy branches and returning to different branch, refuse the return
1528 if ($hbr ne $branch && C4::Context->preference("IndependantBranches")){
1529 $messages->{'Wrongbranch'} = {
1530 Wrongbranch => $branch,
1531 Rightbranch => $hbr,
1534 # bailing out here - in this case, current desired behavior
1535 # is to act as if no return ever happened at all.
1536 # FIXME - even in an indy branches situation, there should
1537 # still be an option for the library to accept the item
1538 # and transfer it to its owning library.
1539 return ( $doreturn, $messages, $issue, $borrower );
1542 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1543 $messages->{'wthdrawn'} = 1;
1547 # case of a return of document (deal with issues and holdingbranch)
1549 $borrower or warn "AddReturn without current borrower";
1550 my $circControlBranch;
1552 # define circControlBranch only if dropbox mode is set
1553 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1554 # FIXME: check issuedate > returndate, factoring in holidays
1555 $circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1558 if ($borrowernumber) {
1559 MarkIssueReturned($borrowernumber, $item->{'itemnumber'}, $circControlBranch, '', $borrower->{'privacy'});
1560 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right? This could be the borrower hash.
1563 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1566 # the holdingbranch is updated if the document is returned to another location.
1567 # this is always done regardless of whether the item was on loan or not
1568 if ($item->{'holdingbranch'} ne $branch) {
1569 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1570 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1572 ModDateLastSeen( $item->{'itemnumber'} );
1574 # check if we have a transfer for this document
1575 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1577 # if we have a transfer to do, we update the line of transfers with the datearrived
1579 if ( $tobranch eq $branch ) {
1580 my $sth = C4::Context->dbh->prepare(
1581 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1583 $sth->execute( $item->{'itemnumber'} );
1584 # if we have a reservation with valid transfer, we can set it's status to 'W'
1585 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1587 $messages->{'WrongTransfer'} = $tobranch;
1588 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1590 $validTransfert = 1;
1593 # fix up the accounts.....
1594 if ($item->{'itemlost'}) {
1595 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1596 $messages->{'WasLost'} = 1;
1599 # fix up the overdues in accounts...
1600 if ($borrowernumber) {
1601 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1602 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1605 my $debardate = _FixFineDaysOnReturn( $borrower, $item, $issue->{date_due} );
1606 $messages->{'Debarred'} = $debardate if ($debardate);
1609 # find reserves.....
1610 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1611 my ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1613 $resrec->{'ResFound'} = $resfound;
1614 $messages->{'ResFound'} = $resrec;
1618 # Record the fact that this book was returned.
1620 $branch, $stat_type, '0', '',
1621 $item->{'itemnumber'},
1622 $biblio->{'itemtype'},
1626 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1627 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1629 branchcode => $branch,
1630 categorycode => $borrower->{categorycode},
1631 item_type => $item->{itype},
1632 notification => 'CHECKIN',
1634 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1635 SendCirculationAlert({
1638 borrower => $borrower,
1643 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1644 if C4::Context->preference("ReturnLog");
1646 # FIXME: make this comment intelligible.
1647 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1648 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1650 if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
1651 if ( C4::Context->preference("AutomaticItemReturn" ) or
1652 (C4::Context->preference("UseBranchTransferLimits") and
1653 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1655 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1656 $debug and warn "item: " . Dumper($item);
1657 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1658 $messages->{'WasTransfered'} = 1;
1660 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1663 return ( $doreturn, $messages, $issue, $borrower );
1666 =head2 MarkIssueReturned
1668 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1670 Unconditionally marks an issue as being returned by
1671 moving the C<issues> row to C<old_issues> and
1672 setting C<returndate> to the current date, or
1673 the last non-holiday date of the branccode specified in
1674 C<dropbox_branch> . Assumes you've already checked that
1675 it's safe to do this, i.e. last non-holiday > issuedate.
1677 if C<$returndate> is specified (in iso format), it is used as the date
1678 of the return. It is ignored when a dropbox_branch is passed in.
1680 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1681 the old_issue is immediately anonymised
1683 Ideally, this function would be internal to C<C4::Circulation>,
1684 not exported, but it is currently needed by one
1685 routine in C<C4::Accounts>.
1689 sub MarkIssueReturned {
1690 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1691 my $dbh = C4::Context->dbh;
1692 my $query = "UPDATE issues SET returndate=";
1694 if ($dropbox_branch) {
1695 my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1696 my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1698 push @bind, $dropboxdate->output('iso');
1699 } elsif ($returndate) {
1701 push @bind, $returndate;
1703 $query .= " now() ";
1705 $query .= " WHERE borrowernumber = ? AND itemnumber = ?";
1706 push @bind, $borrowernumber, $itemnumber;
1708 my $sth_upd = $dbh->prepare($query);
1709 $sth_upd->execute(@bind);
1710 my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1711 WHERE borrowernumber = ?
1712 AND itemnumber = ?");
1713 $sth_copy->execute($borrowernumber, $itemnumber);
1714 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
1715 if ( $privacy == 2) {
1716 # The default of 0 does not work due to foreign key constraints
1717 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
1718 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
1719 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
1720 WHERE borrowernumber = ?
1721 AND itemnumber = ?");
1722 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
1724 my $sth_del = $dbh->prepare("DELETE FROM issues
1725 WHERE borrowernumber = ?
1726 AND itemnumber = ?");
1727 $sth_del->execute($borrowernumber, $itemnumber);
1730 =head2 _FixFineDaysOnReturn
1732 &_FixFineDaysOnReturn($borrower, $item, $datedue);
1734 C<$borrower> borrower hashref
1736 C<$item> item hashref
1738 C<$datedue> date due
1740 Internal function, called only by AddReturn that calculate and update the user fine days, and debars him
1744 sub _FixFineDaysOnReturn {
1745 my ( $borrower, $item, $datedue ) = @_;
1748 $datedue = C4::Dates->new( $datedue, "iso" );
1753 my $branchcode = _GetCircControlBranch( $item, $borrower );
1754 my $calendar = C4::Calendar->new( branchcode => $branchcode );
1755 my $today = C4::Dates->new();
1757 my $deltadays = $calendar->daysBetween( $datedue, C4::Dates->new() );
1759 my $circcontrol = C4::Context::preference('CircControl');
1760 my $issuingrule = GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
1761 my $finedays = $issuingrule->{finedays};
1763 # exit if no finedays defined
1764 return unless $finedays;
1765 my $grace = $issuingrule->{firstremind};
1767 if ( $deltadays - $grace > 0 ) {
1768 my @newdate = Add_Delta_Days( Today(), $deltadays * $finedays );
1769 my $isonewdate = join( '-', @newdate );
1770 my ( $deby, $debm, $debd ) = split( /-/, $borrower->{debarred} );
1771 if ( check_date( $deby, $debm, $debd ) ) {
1772 my @olddate = split( /-/, $borrower->{debarred} );
1774 if ( Delta_Days( @olddate, @newdate ) > 0 ) {
1775 C4::Members::DebarMember( $borrower->{borrowernumber}, $isonewdate );
1779 C4::Members::DebarMember( $borrower->{borrowernumber}, $isonewdate );
1785 =head2 _FixOverduesOnReturn
1787 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1789 C<$brn> borrowernumber
1793 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1794 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1796 Internal function, called only by AddReturn
1800 sub _FixOverduesOnReturn {
1801 my ($borrowernumber, $item);
1802 unless ($borrowernumber = shift) {
1803 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1806 unless ($item = shift) {
1807 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1810 my ($exemptfine, $dropbox) = @_;
1811 my $dbh = C4::Context->dbh;
1813 # check for overdue fine
1814 my $sth = $dbh->prepare(
1815 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1817 $sth->execute( $borrowernumber, $item );
1819 # alter fine to show that the book has been returned
1820 my $data = $sth->fetchrow_hashref;
1821 return 0 unless $data; # no warning, there's just nothing to fix
1824 my @bind = ($borrowernumber, $item, $data->{'accountno'});
1826 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1827 if (C4::Context->preference("FinesLog")) {
1828 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1830 } elsif ($dropbox && $data->{lastincrement}) {
1831 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1832 my $amt = $data->{amount} - $data->{lastincrement} ;
1833 if (C4::Context->preference("FinesLog")) {
1834 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1836 $uquery = "update accountlines set accounttype='F' ";
1837 if($outstanding >= 0 && $amt >=0) {
1838 $uquery .= ", amount = ? , amountoutstanding=? ";
1839 unshift @bind, ($amt, $outstanding) ;
1842 $uquery = "update accountlines set accounttype='F' ";
1844 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1845 my $usth = $dbh->prepare($uquery);
1846 return $usth->execute(@bind);
1849 =head2 _FixAccountForLostAndReturned
1851 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1853 Calculates the charge for a book lost and returned.
1855 Internal function, not exported, called only by AddReturn.
1857 FIXME: This function reflects how inscrutable fines logic is. Fix both.
1858 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
1862 sub _FixAccountForLostAndReturned {
1863 my $itemnumber = shift or return;
1864 my $borrowernumber = @_ ? shift : undef;
1865 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
1866 my $dbh = C4::Context->dbh;
1867 # check for charge made for lost book
1868 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1869 $sth->execute($itemnumber);
1870 my $data = $sth->fetchrow_hashref;
1871 $data or return; # bail if there is nothing to do
1873 # writeoff this amount
1875 my $amount = $data->{'amount'};
1876 my $acctno = $data->{'accountno'};
1877 my $amountleft; # Starts off undef/zero.
1878 if ($data->{'amountoutstanding'} == $amount) {
1879 $offset = $data->{'amount'};
1880 $amountleft = 0; # Hey, it's zero here, too.
1882 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
1883 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
1885 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1886 WHERE (borrowernumber = ?)
1887 AND (itemnumber = ?) AND (accountno = ?) ");
1888 $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
1889 #check if any credit is left if so writeoff other accounts
1890 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1891 $amountleft *= -1 if ($amountleft < 0);
1892 if ($amountleft > 0) {
1893 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1894 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
1895 $msth->execute($data->{'borrowernumber'});
1896 # offset transactions
1899 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1900 if ($accdata->{'amountoutstanding'} < $amountleft) {
1902 $amountleft -= $accdata->{'amountoutstanding'};
1904 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1907 my $thisacct = $accdata->{'accountno'};
1908 # FIXME: move prepares outside while loop!
1909 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1910 WHERE (borrowernumber = ?)
1911 AND (accountno=?)");
1912 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct'); # FIXME: '$thisacct' is a string literal!
1913 $usth = $dbh->prepare("INSERT INTO accountoffsets
1914 (borrowernumber, accountno, offsetaccount, offsetamount)
1917 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1919 $msth->finish; # $msth might actually have data left
1921 $amountleft *= -1 if ($amountleft > 0);
1922 my $desc = "Item Returned " . $item_id;
1923 $usth = $dbh->prepare("INSERT INTO accountlines
1924 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1925 VALUES (?,?,now(),?,?,'CR',?)");
1926 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1927 if ($borrowernumber) {
1928 # FIXME: same as query above. use 1 sth for both
1929 $usth = $dbh->prepare("INSERT INTO accountoffsets
1930 (borrowernumber, accountno, offsetaccount, offsetamount)
1932 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
1934 ModItem({ paidfor => '' }, undef, $itemnumber);
1938 =head2 _GetCircControlBranch
1940 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
1944 Return the library code to be used to determine which circulation
1945 policy applies to a transaction. Looks up the CircControl and
1946 HomeOrHoldingBranch system preferences.
1948 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
1950 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
1954 sub _GetCircControlBranch {
1955 my ($item, $borrower) = @_;
1956 my $circcontrol = C4::Context->preference('CircControl');
1959 if ($circcontrol eq 'PickupLibrary') {
1960 $branch= C4::Context->userenv->{'branch'} if C4::Context->userenv;
1961 } elsif ($circcontrol eq 'PatronLibrary') {
1962 $branch=$borrower->{branchcode};
1964 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
1965 $branch = $item->{$branchfield};
1966 # default to item home branch if holdingbranch is used
1967 # and is not defined
1968 if (!defined($branch) && $branchfield eq 'holdingbranch') {
1969 $branch = $item->{homebranch};
1982 $issue = &GetItemIssue($itemnumber);
1984 Returns patron currently having a book, or undef if not checked out.
1986 C<$itemnumber> is the itemnumber.
1988 C<$issue> is a hashref of the row from the issues table.
1993 my ($itemnumber) = @_;
1994 return unless $itemnumber;
1995 my $sth = C4::Context->dbh->prepare(
1998 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1999 WHERE issues.itemnumber=?");
2000 $sth->execute($itemnumber);
2001 my $data = $sth->fetchrow_hashref;
2002 return unless $data;
2003 $data->{'overdue'} = ($data->{'date_due'} lt C4::Dates->today('iso')) ? 1 : 0;
2009 $issue = GetOpenIssue( $itemnumber );
2011 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2013 C<$itemnumber> is the item's itemnumber
2020 my ( $itemnumber ) = @_;
2022 my $dbh = C4::Context->dbh;
2023 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2024 $sth->execute( $itemnumber );
2025 my $issue = $sth->fetchrow_hashref();
2029 =head2 GetItemIssues
2031 $issues = &GetItemIssues($itemnumber, $history);
2033 Returns patrons that have issued a book
2035 C<$itemnumber> is the itemnumber
2036 C<$history> is false if you just want the current "issuer" (if any)
2037 and true if you want issues history from old_issues also.
2039 Returns reference to an array of hashes
2044 my ( $itemnumber, $history ) = @_;
2046 my $today = C4::Dates->today('iso'); # get today date
2047 my $sql = "SELECT * FROM issues
2048 JOIN borrowers USING (borrowernumber)
2049 JOIN items USING (itemnumber)
2050 WHERE issues.itemnumber = ? ";
2053 SELECT * FROM old_issues
2054 LEFT JOIN borrowers USING (borrowernumber)
2055 JOIN items USING (itemnumber)
2056 WHERE old_issues.itemnumber = ? ";
2058 $sql .= "ORDER BY date_due DESC";
2059 my $sth = C4::Context->dbh->prepare($sql);
2061 $sth->execute($itemnumber, $itemnumber);
2063 $sth->execute($itemnumber);
2065 my $results = $sth->fetchall_arrayref({});
2066 foreach (@$results) {
2067 $_->{'overdue'} = ($_->{'date_due'} lt $today) ? 1 : 0;
2072 =head2 GetBiblioIssues
2074 $issues = GetBiblioIssues($biblionumber);
2076 this function get all issues from a biblionumber.
2079 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2080 tables issues and the firstname,surname & cardnumber from borrowers.
2084 sub GetBiblioIssues {
2085 my $biblionumber = shift;
2086 return undef unless $biblionumber;
2087 my $dbh = C4::Context->dbh;
2089 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2091 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2092 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2093 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2094 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2095 WHERE biblio.biblionumber = ?
2097 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2099 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2100 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2101 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2102 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2103 WHERE biblio.biblionumber = ?
2106 my $sth = $dbh->prepare($query);
2107 $sth->execute($biblionumber, $biblionumber);
2110 while ( my $data = $sth->fetchrow_hashref ) {
2111 push @issues, $data;
2116 =head2 GetUpcomingDueIssues
2118 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2122 sub GetUpcomingDueIssues {
2125 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2126 my $dbh = C4::Context->dbh;
2128 my $statement = <<END_SQL;
2129 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2131 LEFT JOIN items USING (itemnumber)
2132 LEFT OUTER JOIN branches USING (branchcode)
2133 WhERE returndate is NULL
2134 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
2137 my @bind_parameters = ( $params->{'days_in_advance'} );
2139 my $sth = $dbh->prepare( $statement );
2140 $sth->execute( @bind_parameters );
2141 my $upcoming_dues = $sth->fetchall_arrayref({});
2144 return $upcoming_dues;
2147 =head2 CanBookBeRenewed
2149 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2151 Find out whether a borrowed item may be renewed.
2153 C<$dbh> is a DBI handle to the Koha database.
2155 C<$borrowernumber> is the borrower number of the patron who currently
2156 has the item on loan.
2158 C<$itemnumber> is the number of the item to renew.
2160 C<$override_limit>, if supplied with a true value, causes
2161 the limit on the number of times that the loan can be renewed
2162 (as controlled by the item type) to be ignored.
2164 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2165 item must currently be on loan to the specified borrower; renewals
2166 must be allowed for the item's type; and the borrower must not have
2167 already renewed the loan. $error will contain the reason the renewal can not proceed
2171 sub CanBookBeRenewed {
2173 # check renewal status
2174 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2175 my $dbh = C4::Context->dbh;
2180 # Look in the issues table for this item, lent to this borrower,
2181 # and not yet returned.
2183 # Look in the issues table for this item, lent to this borrower,
2184 # and not yet returned.
2186 'ItemHomeLibrary' => 'items.homebranch',
2187 'PickupLibrary' => 'items.holdingbranch',
2188 'PatronLibrary' => 'borrowers.branchcode'
2190 my $controlbranch = $branch{C4::Context->preference('CircControl')};
2191 my $itype = C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype';
2193 my $sthcount = $dbh->prepare("
2195 borrowers.categorycode, biblioitems.itemtype, issues.renewals, renewalsallowed, $controlbranch
2198 LEFT JOIN items USING (itemnumber)
2199 LEFT JOIN borrowers USING (borrowernumber)
2200 LEFT JOIN biblioitems USING (biblioitemnumber)
2203 (issuingrules.categorycode = borrowers.categorycode OR issuingrules.categorycode = '*')
2205 (issuingrules.itemtype = $itype OR issuingrules.itemtype = '*')
2207 (issuingrules.branchcode = $controlbranch OR issuingrules.branchcode = '*')
2213 issuingrules.categorycode desc,
2214 issuingrules.itemtype desc,
2215 issuingrules.branchcode desc
2219 $sthcount->execute( $borrowernumber, $itemnumber );
2220 if ( my $data1 = $sthcount->fetchrow_hashref ) {
2222 if ( ( $data1->{renewalsallowed} && $data1->{renewalsallowed} > $data1->{renewals} ) || $override_limit ) {
2229 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2236 return ($renewokay,$error);
2241 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2245 C<$borrowernumber> is the borrower number of the patron who currently
2248 C<$itemnumber> is the number of the item to renew.
2250 C<$branch> is the library where the renewal took place (if any).
2251 The library that controls the circ policies for the renewal is retrieved from the issues record.
2253 C<$datedue> can be a C4::Dates object used to set the due date.
2255 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2256 this parameter is not supplied, lastreneweddate is set to the current date.
2258 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2259 from the book's item type.
2264 my $borrowernumber = shift or return undef;
2265 my $itemnumber = shift or return undef;
2267 my $datedue = shift;
2268 my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2269 my $item = GetItem($itemnumber) or return undef;
2270 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2272 my $dbh = C4::Context->dbh;
2273 # Find the issues record for this book
2275 $dbh->prepare("SELECT * FROM issues
2276 WHERE borrowernumber=?
2279 $sth->execute( $borrowernumber, $itemnumber );
2280 my $issuedata = $sth->fetchrow_hashref;
2282 if($datedue && ! $datedue->output('iso')){
2283 warn "Invalid date passed to AddRenewal.";
2286 # If the due date wasn't specified, calculate it by adding the
2287 # book's loan length to today's date or the current due date
2288 # based on the value of the RenewalPeriodBase syspref.
2291 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return undef;
2292 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2294 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2295 C4::Dates->new($issuedata->{date_due}, 'iso') :
2297 $datedue = CalcDateDue($datedue,$itemtype,$issuedata->{'branchcode'},$borrower);
2300 # Update the issues record to have the new due date, and a new count
2301 # of how many times it has been renewed.
2302 my $renews = $issuedata->{'renewals'} + 1;
2303 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2304 WHERE borrowernumber=?
2307 $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2310 # Update the renewal count on the item, and tell zebra to reindex
2311 $renews = $biblio->{'renewals'} + 1;
2312 ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2314 # Charge a new rental fee, if applicable?
2315 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2316 if ( $charge > 0 ) {
2317 my $accountno = getnextacctno( $borrowernumber );
2318 my $item = GetBiblioFromItemNumber($itemnumber);
2320 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2321 $sth = $dbh->prepare(
2322 "INSERT INTO accountlines
2323 (date, borrowernumber, accountno, amount, manager_id,
2324 description,accounttype, amountoutstanding, itemnumber)
2325 VALUES (now(),?,?,?,?,?,?,?,?)"
2327 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2328 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2329 'Rent', $charge, $itemnumber );
2333 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2338 # check renewal status
2339 my ( $bornum, $itemno ) = @_;
2340 my $dbh = C4::Context->dbh;
2342 my $renewsallowed = 0;
2345 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2346 my $item = GetItem($itemno);
2348 # Look in the issues table for this item, lent to this borrower,
2349 # and not yet returned.
2351 # FIXME - I think this function could be redone to use only one SQL call.
2352 my $sth = $dbh->prepare(
2353 "select * from issues
2354 where (borrowernumber = ?)
2355 and (itemnumber = ?)"
2357 $sth->execute( $bornum, $itemno );
2358 my $data = $sth->fetchrow_hashref;
2359 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2361 # $item and $borrower should be calculated
2362 my $branchcode = _GetCircControlBranch($item, $borrower);
2364 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2366 $renewsallowed = $issuingrule->{'renewalsallowed'};
2367 $renewsleft = $renewsallowed - $renewcount;
2368 if($renewsleft < 0){ $renewsleft = 0; }
2369 return ( $renewcount, $renewsallowed, $renewsleft );
2372 =head2 GetIssuingCharges
2374 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2376 Calculate how much it would cost for a given patron to borrow a given
2377 item, including any applicable discounts.
2379 C<$itemnumber> is the item number of item the patron wishes to borrow.
2381 C<$borrowernumber> is the patron's borrower number.
2383 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2384 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2389 sub GetIssuingCharges {
2391 # calculate charges due
2392 my ( $itemnumber, $borrowernumber ) = @_;
2394 my $dbh = C4::Context->dbh;
2397 # Get the book's item type and rental charge (via its biblioitem).
2398 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2399 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2400 $charge_query .= (C4::Context->preference('item-level_itypes'))
2401 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2402 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2404 $charge_query .= ' WHERE items.itemnumber =?';
2406 my $sth = $dbh->prepare($charge_query);
2407 $sth->execute($itemnumber);
2408 if ( my $item_data = $sth->fetchrow_hashref ) {
2409 $item_type = $item_data->{itemtype};
2410 $charge = $item_data->{rentalcharge};
2411 my $branch = C4::Branch::mybranch();
2412 my $discount_query = q|SELECT rentaldiscount,
2413 issuingrules.itemtype, issuingrules.branchcode
2415 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2416 WHERE borrowers.borrowernumber = ?
2417 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2418 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2419 my $discount_sth = $dbh->prepare($discount_query);
2420 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2421 my $discount_rules = $discount_sth->fetchall_arrayref({});
2422 if (@{$discount_rules}) {
2423 # We may have multiple rules so get the most specific
2424 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2425 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2429 $sth->finish; # we havent _explicitly_ fetched all rows
2430 return ( $charge, $item_type );
2433 # Select most appropriate discount rule from those returned
2434 sub _get_discount_from_rule {
2435 my ($rules_ref, $branch, $itemtype) = @_;
2438 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2439 $discount = $rules_ref->[0]->{rentaldiscount};
2440 return (defined $discount) ? $discount : 0;
2442 # could have up to 4 does one match $branch and $itemtype
2443 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2445 $discount = $d[0]->{rentaldiscount};
2446 return (defined $discount) ? $discount : 0;
2448 # do we have item type + all branches
2449 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2451 $discount = $d[0]->{rentaldiscount};
2452 return (defined $discount) ? $discount : 0;
2454 # do we all item types + this branch
2455 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2457 $discount = $d[0]->{rentaldiscount};
2458 return (defined $discount) ? $discount : 0;
2460 # so all and all (surely we wont get here)
2461 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2463 $discount = $d[0]->{rentaldiscount};
2464 return (defined $discount) ? $discount : 0;
2470 =head2 AddIssuingCharge
2472 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2476 sub AddIssuingCharge {
2477 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2478 my $dbh = C4::Context->dbh;
2479 my $nextaccntno = getnextacctno( $borrowernumber );
2481 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2483 INSERT INTO accountlines
2484 (borrowernumber, itemnumber, accountno,
2485 date, amount, description, accounttype,
2486 amountoutstanding, manager_id)
2487 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2489 my $sth = $dbh->prepare($query);
2490 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2496 GetTransfers($itemnumber);
2501 my ($itemnumber) = @_;
2503 my $dbh = C4::Context->dbh;
2509 FROM branchtransfers
2510 WHERE itemnumber = ?
2511 AND datearrived IS NULL
2513 my $sth = $dbh->prepare($query);
2514 $sth->execute($itemnumber);
2515 my @row = $sth->fetchrow_array();
2520 =head2 GetTransfersFromTo
2522 @results = GetTransfersFromTo($frombranch,$tobranch);
2524 Returns the list of pending transfers between $from and $to branch
2528 sub GetTransfersFromTo {
2529 my ( $frombranch, $tobranch ) = @_;
2530 return unless ( $frombranch && $tobranch );
2531 my $dbh = C4::Context->dbh;
2533 SELECT itemnumber,datesent,frombranch
2534 FROM branchtransfers
2537 AND datearrived IS NULL
2539 my $sth = $dbh->prepare($query);
2540 $sth->execute( $frombranch, $tobranch );
2543 while ( my $data = $sth->fetchrow_hashref ) {
2544 push @gettransfers, $data;
2547 return (@gettransfers);
2550 =head2 DeleteTransfer
2552 &DeleteTransfer($itemnumber);
2556 sub DeleteTransfer {
2557 my ($itemnumber) = @_;
2558 my $dbh = C4::Context->dbh;
2559 my $sth = $dbh->prepare(
2560 "DELETE FROM branchtransfers
2562 AND datearrived IS NULL "
2564 $sth->execute($itemnumber);
2568 =head2 AnonymiseIssueHistory
2570 $rows = AnonymiseIssueHistory($date,$borrowernumber)
2572 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2573 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2575 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2576 setting (force delete).
2578 return the number of affected rows.
2582 sub AnonymiseIssueHistory {
2584 my $borrowernumber = shift;
2585 my $dbh = C4::Context->dbh;
2588 SET borrowernumber = ?
2589 WHERE returndate < ?
2590 AND borrowernumber IS NOT NULL
2593 # The default of 0 does not work due to foreign key constraints
2594 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2595 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2596 my @bind_params = ($anonymouspatron, $date);
2597 if (defined $borrowernumber) {
2598 $query .= " AND borrowernumber = ?";
2599 push @bind_params, $borrowernumber;
2601 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2603 my $sth = $dbh->prepare($query);
2604 $sth->execute(@bind_params);
2605 my $rows_affected = $sth->rows; ### doublecheck row count return function
2606 return $rows_affected;
2609 =head2 SendCirculationAlert
2611 Send out a C<check-in> or C<checkout> alert using the messaging system.
2619 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2623 Hashref of information about the item being checked in or out.
2627 Hashref of information about the borrower of the item.
2631 The branchcode from where the checkout or check-in took place.
2637 SendCirculationAlert({
2640 borrower => $borrower,
2646 sub SendCirculationAlert {
2648 my ($type, $item, $borrower, $branch) =
2649 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2650 my %message_name = (
2651 CHECKIN => 'Item_Check_in',
2652 CHECKOUT => 'Item_Checkout',
2654 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2655 borrowernumber => $borrower->{borrowernumber},
2656 message_name => $message_name{$type},
2658 my $letter = C4::Letters::getletter('circulation', $type);
2659 C4::Letters::parseletter($letter, 'biblio', $item->{biblionumber});
2660 C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2661 C4::Letters::parseletter($letter, 'borrowers', $borrower->{borrowernumber});
2662 C4::Letters::parseletter($letter, 'branches', $branch);
2663 my @transports = @{ $borrower_preferences->{transports} };
2664 # warn "no transports" unless @transports;
2666 # warn "transport: $_";
2667 my $message = C4::Message->find_last_message($borrower, $type, $_);
2669 #warn "create new message";
2670 C4::Message->enqueue($letter, $borrower, $_);
2672 #warn "append to old message";
2673 $message->append($letter);
2680 =head2 updateWrongTransfer
2682 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2684 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
2688 sub updateWrongTransfer {
2689 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2690 my $dbh = C4::Context->dbh;
2691 # first step validate the actual line of transfert .
2694 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2696 $sth->execute($FromLibrary,$itemNumber);
2699 # second step create a new line of branchtransfer to the right location .
2700 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2702 #third step changing holdingbranch of item
2703 UpdateHoldingbranch($FromLibrary,$itemNumber);
2706 =head2 UpdateHoldingbranch
2708 $items = UpdateHoldingbranch($branch,$itmenumber);
2710 Simple methode for updating hodlingbranch in items BDD line
2714 sub UpdateHoldingbranch {
2715 my ( $branch,$itemnumber ) = @_;
2716 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2721 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
2723 this function calculates the due date given the start date and configured circulation rules,
2724 checking against the holidays calendar as per the 'useDaysMode' syspref.
2725 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2726 C<$itemtype> = itemtype code of item in question
2727 C<$branch> = location whose calendar to use
2728 C<$borrower> = Borrower object
2733 my ($startdate,$itemtype,$branch,$borrower) = @_;
2735 my $loanlength = GetLoanLength($borrower->{'categorycode'},$itemtype, $branch);
2737 # if globalDueDate ON the datedue is set to that date
2738 if ( C4::Context->preference('globalDueDate')
2739 && ( C4::Context->preference('globalDueDate') =~ C4::Dates->regexp('syspref') ) ) {
2740 $datedue = C4::Dates->new( C4::Context->preference('globalDueDate') );
2742 # otherwise, calculate the datedue as normal
2743 if(C4::Context->preference('useDaysMode') eq 'Days') { # ignoring calendar
2744 my $timedue = time + ($loanlength) * 86400;
2745 #FIXME - assumes now even though we take a startdate
2746 my @datearr = localtime($timedue);
2747 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2749 my $calendar = C4::Calendar->new( branchcode => $branch );
2750 $datedue = $calendar->addDate($startdate, $loanlength);
2754 # if Hard Due Dates are used, retreive them and apply as necessary
2755 my ($hardduedate, $hardduedatecompare) = GetHardDueDate($borrower->{'categorycode'},$itemtype, $branch);
2756 if ( $hardduedate && $hardduedate->output('iso') && $hardduedate->output('iso') ne '0000-00-00') {
2757 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
2758 if ( $datedue->output( 'iso' ) gt $hardduedate->output( 'iso' ) && $hardduedatecompare == -1) {
2759 $datedue = $hardduedate;
2760 # if the calculated date is before the 'after' Hard Due Date (floor), override
2761 } elsif ( $datedue->output( 'iso' ) lt $hardduedate->output( 'iso' ) && $hardduedatecompare == 1) {
2762 $datedue = $hardduedate;
2763 # if the hard due date is set to 'exactly', overrride
2764 } elsif ( $hardduedatecompare == 0) {
2765 $datedue = $hardduedate;
2767 # in all other cases, keep the date due as it is
2770 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2771 if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2772 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2778 =head2 CheckValidDatedue
2780 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2782 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2783 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2785 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2786 C<$date_due> = returndate calculate with no day check
2787 C<$itemnumber> = itemnumber
2788 C<$branchcode> = location of issue (affected by 'CircControl' syspref)
2789 C<$loanlength> = loan length prior to adjustment
2793 sub CheckValidDatedue {
2794 my ($date_due,$itemnumber,$branchcode)=@_;
2795 my @datedue=split('-',$date_due->output('iso'));
2796 my $years=$datedue[0];
2797 my $month=$datedue[1];
2798 my $day=$datedue[2];
2799 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2801 for (my $i=0;$i<2;$i++){
2802 $dow=Day_of_Week($years,$month,$day);
2803 ($dow=0) if ($dow>6);
2804 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2805 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2806 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2807 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2809 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2812 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2817 =head2 CheckRepeatableHolidays
2819 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2821 This function checks if the date due is a repeatable holiday
2823 C<$date_due> = returndate calculate with no day check
2824 C<$itemnumber> = itemnumber
2825 C<$branchcode> = localisation of issue
2829 sub CheckRepeatableHolidays{
2830 my($itemnumber,$week_day,$branchcode)=@_;
2831 my $dbh = C4::Context->dbh;
2832 my $query = qq|SELECT count(*)
2833 FROM repeatable_holidays
2836 my $sth = $dbh->prepare($query);
2837 $sth->execute($branchcode,$week_day);
2838 my $result=$sth->fetchrow;
2844 =head2 CheckSpecialHolidays
2846 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2848 This function check if the date is a special holiday
2850 C<$years> = the years of datedue
2851 C<$month> = the month of datedue
2852 C<$day> = the day of datedue
2853 C<$itemnumber> = itemnumber
2854 C<$branchcode> = localisation of issue
2858 sub CheckSpecialHolidays{
2859 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2860 my $dbh = C4::Context->dbh;
2861 my $query=qq|SELECT count(*)
2862 FROM `special_holidays`
2868 my $sth = $dbh->prepare($query);
2869 $sth->execute($years,$month,$day,$branchcode);
2870 my $countspecial=$sth->fetchrow ;
2872 return $countspecial;
2875 =head2 CheckRepeatableSpecialHolidays
2877 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2879 This function check if the date is a repeatble special holidays
2881 C<$month> = the month of datedue
2882 C<$day> = the day of datedue
2883 C<$itemnumber> = itemnumber
2884 C<$branchcode> = localisation of issue
2888 sub CheckRepeatableSpecialHolidays{
2889 my ($month,$day,$itemnumber,$branchcode) = @_;
2890 my $dbh = C4::Context->dbh;
2891 my $query=qq|SELECT count(*)
2892 FROM `repeatable_holidays`
2897 my $sth = $dbh->prepare($query);
2898 $sth->execute($month,$day,$branchcode);
2899 my $countspecial=$sth->fetchrow ;
2901 return $countspecial;
2906 sub CheckValidBarcode{
2908 my $dbh = C4::Context->dbh;
2909 my $query=qq|SELECT count(*)
2913 my $sth = $dbh->prepare($query);
2914 $sth->execute($barcode);
2915 my $exist=$sth->fetchrow ;
2920 =head2 IsBranchTransferAllowed
2922 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2924 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2928 sub IsBranchTransferAllowed {
2929 my ( $toBranch, $fromBranch, $code ) = @_;
2931 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2933 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2934 my $dbh = C4::Context->dbh;
2936 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2937 $sth->execute( $toBranch, $fromBranch, $code );
2938 my $limit = $sth->fetchrow_hashref();
2940 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2941 if ( $limit->{'limitId'} ) {
2948 =head2 CreateBranchTransferLimit
2950 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2952 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2956 sub CreateBranchTransferLimit {
2957 my ( $toBranch, $fromBranch, $code ) = @_;
2959 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2961 my $dbh = C4::Context->dbh;
2963 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2964 $sth->execute( $code, $toBranch, $fromBranch );
2967 =head2 DeleteBranchTransferLimits
2969 DeleteBranchTransferLimits();
2973 sub DeleteBranchTransferLimits {
2974 my $dbh = C4::Context->dbh;
2975 my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2980 my ( $borrowernumber, $itemnum ) = @_;
2982 MarkIssueReturned( $borrowernumber, $itemnum );
2983 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
2984 my @datearr = localtime(time);
2985 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
2986 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
2987 ModItem({ paidfor => "Paid for by $bor $date" }, undef, $itemnum);
2992 my ($itemnumber, $mark_returned, $charge_fee) = @_;
2994 my $dbh = C4::Context->dbh();
2995 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
2997 JOIN items USING (itemnumber)
2998 JOIN biblio USING (biblionumber)
2999 WHERE issues.itemnumber=?");
3000 $sth->execute($itemnumber);
3001 my $issues=$sth->fetchrow_hashref();
3004 # if a borrower lost the item, add a replacement cost to the their record
3005 if ( my $borrowernumber = $issues->{borrowernumber} ){
3007 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}")
3009 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3010 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3011 MarkIssueReturned($borrowernumber,$itemnumber) if $mark_returned;
3022 Koha Development Team <http://koha-community.org/>