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);
48 use POSIX qw(strftime);
49 use C4::Branch; # GetBranches
50 use C4::Log; # logaction
54 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
58 $VERSION = 3.02; # for version checking
61 # FIXME subs that should probably be elsewhere
68 # subs to deal with issuing a book
79 &GetBranchBorrowerCircRule
83 &AnonymiseIssueHistory
86 # subs to deal with returns
92 # subs to deal with transfers
99 &IsBranchTransferAllowed
100 &CreateBranchTransferLimit
101 &DeleteBranchTransferLimits
107 C4::Circulation - Koha circulation module
115 The functions in this module deal with circulation, issues, and
116 returns, as well as general information about the library.
117 Also deals with stocktaking.
123 $str = &barcodedecode($barcode, [$filter]);
125 Generic filter function for barcode string.
126 Called on every circ if the System Pref itemBarcodeInputFilter is set.
127 Will do some manipulation of the barcode for systems that deliver a barcode
128 to circulation.pl that differs from the barcode stored for the item.
129 For proper functioning of this filter, calling the function on the
130 correct barcode string (items.barcode) should return an unaltered barcode.
132 The optional $filter argument is to allow for testing or explicit
133 behavior that ignores the System Pref. Valid values are the same as the
138 # FIXME -- the &decode fcn below should be wrapped into this one.
139 # FIXME -- these plugins should be moved out of Circulation.pm
142 my ($barcode, $filter) = @_;
143 my $branch = C4::Branch::mybranch();
144 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
145 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
146 if ($filter eq 'whitespace') {
148 } elsif ($filter eq 'cuecat') {
150 my @fields = split( /\./, $barcode );
151 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
152 ($#results == 2) and return $results[2];
153 } elsif ($filter eq 'T-prefix') {
154 if ($barcode =~ /^[Tt](\d)/) {
155 (defined($1) and $1 eq '0') and return $barcode;
156 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
158 return sprintf("T%07d", $barcode);
159 # FIXME: $barcode could be "T1", causing warning: substr outside of string
160 # Why drop the nonzero digit after the T?
161 # Why pass non-digits (or empty string) to "T%07d"?
162 } elsif ($filter eq 'libsuite8') {
163 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
164 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
165 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
167 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
171 return $barcode; # return barcode, modified or not
176 $str = &decode($chunk);
178 Decodes a segment of a string emitted by a CueCat barcode scanner and
181 FIXME: Should be replaced with Barcode::Cuecat from CPAN
182 or Javascript based decoding on the client side.
189 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
190 my @s = map { index( $seq, $_ ); } split( //, $encoded );
191 my $l = ( $#s + 1 ) % 4;
194 # warn "Error: Cuecat decode parsing failed!";
202 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
204 chr( ( $n >> 16 ) ^ 67 )
205 .chr( ( $n >> 8 & 255 ) ^ 67 )
206 .chr( ( $n & 255 ) ^ 67 );
209 $r = substr( $r, 0, length($r) - $l );
215 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
216 $barcode, $ignore_reserves);
218 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
220 C<$newbranch> is the code for the branch to which the item should be transferred.
222 C<$barcode> is the barcode of the item to be transferred.
224 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
225 Otherwise, if an item is reserved, the transfer fails.
227 Returns three values:
233 is true if the transfer was successful.
237 is a reference-to-hash which may have any of the following keys:
243 There is no item in the catalog with the given barcode. The value is C<$barcode>.
247 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.
249 =item C<DestinationEqualsHolding>
251 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.
255 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.
259 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>.
261 =item C<WasTransferred>
263 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
272 my ( $tbr, $barcode, $ignoreRs ) = @_;
275 my $branches = GetBranches();
276 my $itemnumber = GetItemnumberFromBarcode( $barcode );
277 my $issue = GetItemIssue($itemnumber);
278 my $biblio = GetBiblioFromItemNumber($itemnumber);
281 if ( not $itemnumber ) {
282 $messages->{'BadBarcode'} = $barcode;
286 # get branches of book...
287 my $hbr = $biblio->{'homebranch'};
288 my $fbr = $biblio->{'holdingbranch'};
290 # if using Branch Transfer Limits
291 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
292 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
293 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
294 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
297 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
298 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
304 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
305 $messages->{'IsPermanent'} = $hbr;
309 # can't transfer book if is already there....
310 if ( $fbr eq $tbr ) {
311 $messages->{'DestinationEqualsHolding'} = 1;
315 # check if it is still issued to someone, return it...
316 if ($issue->{borrowernumber}) {
317 AddReturn( $barcode, $fbr );
318 $messages->{'WasReturned'} = $issue->{borrowernumber};
322 # That'll save a database query.
323 my ( $resfound, $resrec, undef ) =
324 CheckReserves( $itemnumber );
325 if ( $resfound and not $ignoreRs ) {
326 $resrec->{'ResFound'} = $resfound;
328 # $messages->{'ResFound'} = $resrec;
332 #actually do the transfer....
334 ModItemTransfer( $itemnumber, $fbr, $tbr );
336 # don't need to update MARC anymore, we do it in batch now
337 $messages->{'WasTransfered'} = 1;
340 ModDateLastSeen( $itemnumber );
341 return ( $dotransfer, $messages, $biblio );
346 my $borrower = shift;
347 my $biblionumber = shift;
349 my $cat_borrower = $borrower->{'categorycode'};
350 my $dbh = C4::Context->dbh;
352 # Get which branchcode we need
353 $branch = _GetCircControlBranch($item,$borrower);
354 my $type = (C4::Context->preference('item-level_itypes'))
355 ? $item->{'itype'} # item-level
356 : $item->{'itemtype'}; # biblio-level
358 # given branch, patron category, and item type, determine
359 # applicable issuing rule
360 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
362 # if a rule is found and has a loan limit set, count
363 # how many loans the patron already has that meet that
365 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
367 my $count_query = "SELECT COUNT(*) FROM issues
368 JOIN items USING (itemnumber) ";
370 my $rule_itemtype = $issuing_rule->{itemtype};
371 if ($rule_itemtype eq "*") {
372 # matching rule has the default item type, so count only
373 # those existing loans that don't fall under a more
375 if (C4::Context->preference('item-level_itypes')) {
376 $count_query .= " WHERE items.itype NOT IN (
377 SELECT itemtype FROM issuingrules
379 AND (categorycode = ? OR categorycode = ?)
383 $count_query .= " JOIN biblioitems USING (biblionumber)
384 WHERE biblioitems.itemtype NOT IN (
385 SELECT itemtype FROM issuingrules
387 AND (categorycode = ? OR categorycode = ?)
391 push @bind_params, $issuing_rule->{branchcode};
392 push @bind_params, $issuing_rule->{categorycode};
393 push @bind_params, $cat_borrower;
395 # rule has specific item type, so count loans of that
397 if (C4::Context->preference('item-level_itypes')) {
398 $count_query .= " WHERE items.itype = ? ";
400 $count_query .= " JOIN biblioitems USING (biblionumber)
401 WHERE biblioitems.itemtype= ? ";
403 push @bind_params, $type;
406 $count_query .= " AND borrowernumber = ? ";
407 push @bind_params, $borrower->{'borrowernumber'};
408 my $rule_branch = $issuing_rule->{branchcode};
409 if ($rule_branch ne "*") {
410 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
411 $count_query .= " AND issues.branchcode = ? ";
412 push @bind_params, $branch;
413 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
414 ; # if branch is the patron's home branch, then count all loans by patron
416 $count_query .= " AND items.homebranch = ? ";
417 push @bind_params, $branch;
421 my $count_sth = $dbh->prepare($count_query);
422 $count_sth->execute(@bind_params);
423 my ($current_loan_count) = $count_sth->fetchrow_array;
425 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
426 if ($current_loan_count >= $max_loans_allowed) {
427 return ($current_loan_count, $max_loans_allowed);
431 # Now count total loans against the limit for the branch
432 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
433 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
434 my @bind_params = ();
435 my $branch_count_query = "SELECT COUNT(*) FROM issues
436 JOIN items USING (itemnumber)
437 WHERE borrowernumber = ? ";
438 push @bind_params, $borrower->{borrowernumber};
440 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
441 $branch_count_query .= " AND issues.branchcode = ? ";
442 push @bind_params, $branch;
443 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
444 ; # if branch is the patron's home branch, then count all loans by patron
446 $branch_count_query .= " AND items.homebranch = ? ";
447 push @bind_params, $branch;
449 my $branch_count_sth = $dbh->prepare($branch_count_query);
450 $branch_count_sth->execute(@bind_params);
451 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
453 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
454 if ($current_loan_count >= $max_loans_allowed) {
455 return ($current_loan_count, $max_loans_allowed);
459 # OK, the patron can issue !!!
465 @issues = &itemissues($biblioitemnumber, $biblio);
467 Looks up information about who has borrowed the bookZ<>(s) with the
468 given biblioitemnumber.
470 C<$biblio> is ignored.
472 C<&itemissues> returns an array of references-to-hash. The keys
473 include the fields from the C<items> table in the Koha database.
474 Additional keys include:
480 If the item is currently on loan, this gives the due date.
482 If the item is not on loan, then this is either "Available" or
483 "Cancelled", if the item has been withdrawn.
487 If the item is currently on loan, this gives the card number of the
488 patron who currently has the item.
490 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
492 These give the timestamp for the last three times the item was
495 =item C<card0>, C<card1>, C<card2>
497 The card number of the last three patrons who borrowed this item.
499 =item C<borrower0>, C<borrower1>, C<borrower2>
501 The borrower number of the last three patrons who borrowed this item.
509 my ( $bibitem, $biblio ) = @_;
510 my $dbh = C4::Context->dbh;
512 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
517 $sth->execute($bibitem) || die $sth->errstr;
519 while ( my $data = $sth->fetchrow_hashref ) {
521 # Find out who currently has this item.
522 # FIXME - Wouldn't it be better to do this as a left join of
523 # some sort? Currently, this code assumes that if
524 # fetchrow_hashref() fails, then the book is on the shelf.
525 # fetchrow_hashref() can fail for any number of reasons (e.g.,
526 # database server crash), not just because no items match the
528 my $sth2 = $dbh->prepare(
529 "SELECT * FROM issues
530 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
535 $sth2->execute( $data->{'itemnumber'} );
536 if ( my $data2 = $sth2->fetchrow_hashref ) {
537 $data->{'date_due'} = $data2->{'date_due'};
538 $data->{'card'} = $data2->{'cardnumber'};
539 $data->{'borrower'} = $data2->{'borrowernumber'};
542 $data->{'date_due'} = ($data->{'wthdrawn'} eq '1') ? 'Cancelled' : 'Available';
546 # Find the last 3 people who borrowed this item.
547 $sth2 = $dbh->prepare(
548 "SELECT * FROM old_issues
549 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
551 ORDER BY returndate DESC,timestamp DESC"
554 $sth2->execute( $data->{'itemnumber'} );
555 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
556 { # FIXME : error if there is less than 3 pple borrowing this item
557 if ( my $data2 = $sth2->fetchrow_hashref ) {
558 $data->{"timestamp$i2"} = $data2->{'timestamp'};
559 $data->{"card$i2"} = $data2->{'cardnumber'};
560 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
564 $results[$i] = $data;
571 =head2 CanBookBeIssued
573 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
574 $barcode, $duedatespec, $inprocess );
576 Check if a book can be issued.
578 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
582 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
584 =item C<$barcode> is the bar code of the book being issued.
586 =item C<$duedatespec> is a C4::Dates object.
596 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
597 Possible values are :
603 sticky due date is invalid
607 borrower gone with no address
611 borrower declared it's card lost
617 =head3 UNKNOWN_BARCODE
631 item is restricted (set by ??)
633 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
634 could be prevented, but ones that can be overriden by the operator.
636 Possible values are :
644 renewing, not issuing
646 =head3 ISSUED_TO_ANOTHER
648 issued to someone else.
652 reserved for someone else.
656 sticky due date is invalid or due date in the past
660 if the borrower borrows to much things
664 sub CanBookBeIssued {
665 my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
666 my %needsconfirmation; # filled with problems that needs confirmations
667 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
668 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
669 my $issue = GetItemIssue($item->{itemnumber});
670 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
671 $item->{'itemtype'}=$item->{'itype'};
672 my $dbh = C4::Context->dbh;
674 # MANDATORY CHECKS - unless item exists, nothing else matters
675 unless ( $item->{barcode} ) {
676 $issuingimpossible{UNKNOWN_BARCODE} = 1;
678 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
681 # DUE DATE is OK ? -- should already have checked.
683 unless ( $duedate ) {
684 my $issuedate = strftime( "%Y-%m-%d", localtime );
686 my $branch = _GetCircControlBranch($item,$borrower);
687 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
688 $duedate = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $itype, $branch, $borrower );
690 # Offline circ calls AddIssue directly, doesn't run through here
691 # So issuingimpossible should be ok.
694 $needsconfirmation{INVALID_DATE} = $duedate->output('syspref')
695 unless $duedate->output('iso') ge C4::Dates->today('iso');
697 $issuingimpossible{INVALID_DATE} = $duedate->output('syspref');
703 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
704 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
705 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'});
706 ModDateLastSeen( $item->{'itemnumber'} );
707 return( { STATS => 1 }, {});
709 if ( $borrower->{flags}->{GNA} ) {
710 $issuingimpossible{GNA} = 1;
712 if ( $borrower->{flags}->{'LOST'} ) {
713 $issuingimpossible{CARD_LOST} = 1;
715 if ( $borrower->{flags}->{'DBARRED'} ) {
716 $issuingimpossible{DEBARRED} = 1;
718 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
719 $issuingimpossible{EXPIRED} = 1;
721 my @expirydate= split /-/,$borrower->{'dateexpiry'};
722 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
723 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
724 $issuingimpossible{EXPIRED} = 1;
733 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
734 my $amountlimit = C4::Context->preference("noissuescharge");
735 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
736 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
737 if ( C4::Context->preference("IssuingInProcess") ) {
738 if ( $amount > $amountlimit && !$inprocess && !$allowfineoverride) {
739 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
740 } elsif ( $amount > $amountlimit && !$inprocess && $allowfineoverride) {
741 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
742 } elsif ( $allfinesneedoverride && $amount > 0 && $amount <= $amountlimit && !$inprocess ) {
743 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
747 if ( $amount > $amountlimit && $allowfineoverride ) {
748 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
749 } elsif ( $amount > $amountlimit && !$allowfineoverride) {
750 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
751 } elsif ( $amount > 0 && $allfinesneedoverride ) {
752 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
756 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
757 if ($blocktype == -1) {
758 ## patron has outstanding overdue loans
759 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
760 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
762 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
763 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
765 } elsif($blocktype == 1) {
766 # patron has accrued fine days
767 $issuingimpossible{USERBLOCKEDREMAINING} = $count;
771 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
773 my ($current_loan_count, $max_loans_allowed) = TooMany( $borrower, $item->{biblionumber}, $item );
774 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
775 if ($max_loans_allowed eq 0) {
776 $needsconfirmation{PATRON_CANT} = 1;
778 if($max_loans_allowed){
779 $needsconfirmation{TOO_MANY} = 1;
780 $needsconfirmation{current_loan_count} = $current_loan_count;
781 $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
788 if ( $item->{'notforloan'}
789 && $item->{'notforloan'} > 0 )
791 if(!C4::Context->preference("AllowNotForLoanOverride")){
792 $issuingimpossible{NOT_FOR_LOAN} = 1;
794 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
797 elsif ( !$item->{'notforloan'} ){
798 # we have to check itemtypes.notforloan also
799 if (C4::Context->preference('item-level_itypes')){
800 # this should probably be a subroutine
801 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
802 $sth->execute($item->{'itemtype'});
803 my $notforloan=$sth->fetchrow_hashref();
805 if ($notforloan->{'notforloan'}) {
806 if (!C4::Context->preference("AllowNotForLoanOverride")) {
807 $issuingimpossible{NOT_FOR_LOAN} = 1;
809 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
813 elsif ($biblioitem->{'notforloan'} == 1){
814 if (!C4::Context->preference("AllowNotForLoanOverride")) {
815 $issuingimpossible{NOT_FOR_LOAN} = 1;
817 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
821 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} > 0 )
823 $issuingimpossible{WTHDRAWN} = 1;
825 if ( $item->{'restricted'}
826 && $item->{'restricted'} == 1 )
828 $issuingimpossible{RESTRICTED} = 1;
830 if ( C4::Context->preference("IndependantBranches") ) {
831 my $userenv = C4::Context->userenv;
832 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
833 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1
834 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
835 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
836 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
841 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
843 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
846 # Already issued to current borrower. Ask whether the loan should
848 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
849 $borrower->{'borrowernumber'},
850 $item->{'itemnumber'}
852 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
853 $issuingimpossible{NO_MORE_RENEWALS} = 1;
856 $needsconfirmation{RENEW_ISSUE} = 1;
859 elsif ($issue->{borrowernumber}) {
861 # issued to someone else
862 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
864 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
865 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
866 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
867 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
868 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
869 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
872 # See if the item is on reserve.
873 my ( $restype, $res, undef ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
875 my $resbor = $res->{'borrowernumber'};
876 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
877 my $branches = GetBranches();
878 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
879 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
881 # The item is on reserve and waiting, but has been
882 # reserved by some other patron.
883 $needsconfirmation{RESERVE_WAITING} = 1;
884 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
885 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
886 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
887 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
888 $needsconfirmation{'resbranchname'} = $branchname;
889 $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
891 elsif ( $restype eq "Reserved" ) {
892 # The item is on reserve for someone else.
893 $needsconfirmation{RESERVED} = 1;
894 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
895 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
896 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
897 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
898 $needsconfirmation{'resbranchname'} = $branchname;
899 $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
902 return ( \%issuingimpossible, \%needsconfirmation );
907 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
909 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
913 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
915 =item C<$barcode> is the barcode of the item being issued.
917 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
920 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
922 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
923 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
925 AddIssue does the following things :
927 - step 01: check that there is a borrowernumber & a barcode provided
928 - check for RENEWAL (book issued & being issued to the same patron)
929 - renewal YES = Calculate Charge & renew
931 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
933 - fill reserve if reserve to this patron
934 - cancel reserve or not, otherwise
935 * TRANSFERT PENDING ?
936 - complete the transfert
944 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
945 my $dbh = C4::Context->dbh;
946 my $barcodecheck=CheckValidBarcode($barcode);
947 # $issuedate defaults to today.
948 if ( ! defined $issuedate ) {
949 $issuedate = strftime( "%Y-%m-%d", localtime );
950 # TODO: for hourly circ, this will need to be a C4::Dates object
951 # and all calls to AddIssue including issuedate will need to pass a Dates object.
953 if ($borrower and $barcode and $barcodecheck ne '0'){
954 # find which item we issue
955 my $item = GetItem('', $barcode) or return undef; # if we don't get an Item, abort.
956 my $branch = _GetCircControlBranch($item,$borrower);
958 # get actual issuing if there is one
959 my $actualissue = GetItemIssue( $item->{itemnumber});
961 # get biblioinformation for this item
962 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
965 # check if we just renew the issue.
967 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
968 $datedue = AddRenewal(
969 $borrower->{'borrowernumber'},
970 $item->{'itemnumber'},
973 $issuedate, # here interpreted as the renewal date
978 if ( $actualissue->{borrowernumber}) {
979 # This book is currently on loan, but not to the person
980 # who wants to borrow it now. mark it returned before issuing to the new borrower
983 C4::Context->userenv->{'branch'}
987 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
989 # Starting process for transfer job (checking transfert and validate it if we have one)
990 my ($datesent) = GetTransfers($item->{'itemnumber'});
992 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
995 "UPDATE branchtransfers
996 SET datearrived = now(),
998 comments = 'Forced branchtransfer'
999 WHERE itemnumber= ? AND datearrived IS NULL"
1001 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1004 # Record in the database the fact that the book was issued.
1008 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1012 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1013 $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $itype, $branch, $borrower );
1017 $borrower->{'borrowernumber'}, # borrowernumber
1018 $item->{'itemnumber'}, # itemnumber
1019 $issuedate, # issuedate
1020 $datedue->output('iso'), # date_due
1021 C4::Context->userenv->{'branch'} # branchcode
1024 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1025 CartToShelf( $item->{'itemnumber'} );
1027 $item->{'issues'}++;
1028 ModItem({ issues => $item->{'issues'},
1029 holdingbranch => C4::Context->userenv->{'branch'},
1031 datelastborrowed => C4::Dates->new()->output('iso'),
1032 onloan => $datedue->output('iso'),
1033 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1034 ModDateLastSeen( $item->{'itemnumber'} );
1036 # If it costs to borrow this book, charge it to the patron's account.
1037 my ( $charge, $itemtype ) = GetIssuingCharges(
1038 $item->{'itemnumber'},
1039 $borrower->{'borrowernumber'}
1041 if ( $charge > 0 ) {
1043 $item->{'itemnumber'},
1044 $borrower->{'borrowernumber'}, $charge
1046 $item->{'charge'} = $charge;
1049 # Record the fact that this book was issued.
1051 C4::Context->userenv->{'branch'},
1053 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1054 $item->{'itype'}, $borrower->{'borrowernumber'}
1057 # Send a checkout slip.
1058 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1060 branchcode => $branch,
1061 categorycode => $borrower->{categorycode},
1062 item_type => $item->{itype},
1063 notification => 'CHECKOUT',
1065 if ($circulation_alert->is_enabled_for(\%conditions)) {
1066 SendCirculationAlert({
1069 borrower => $borrower,
1075 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1076 if C4::Context->preference("IssueLog");
1078 return ($datedue); # not necessarily the same as when it came in!
1081 =head2 GetLoanLength
1083 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1085 Get loan length for an itemtype, a borrower type and a branch
1090 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1091 my $dbh = C4::Context->dbh;
1094 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1096 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1097 # try to find issuelength & return the 1st available.
1098 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1099 $sth->execute( $borrowertype, $itemtype, $branchcode );
1100 my $loanlength = $sth->fetchrow_hashref;
1101 return $loanlength->{issuelength}
1102 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1104 $sth->execute( $borrowertype, "*", $branchcode );
1105 $loanlength = $sth->fetchrow_hashref;
1106 return $loanlength->{issuelength}
1107 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1109 $sth->execute( "*", $itemtype, $branchcode );
1110 $loanlength = $sth->fetchrow_hashref;
1111 return $loanlength->{issuelength}
1112 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1114 $sth->execute( "*", "*", $branchcode );
1115 $loanlength = $sth->fetchrow_hashref;
1116 return $loanlength->{issuelength}
1117 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1119 $sth->execute( $borrowertype, $itemtype, "*" );
1120 $loanlength = $sth->fetchrow_hashref;
1121 return $loanlength->{issuelength}
1122 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1124 $sth->execute( $borrowertype, "*", "*" );
1125 $loanlength = $sth->fetchrow_hashref;
1126 return $loanlength->{issuelength}
1127 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1129 $sth->execute( "*", $itemtype, "*" );
1130 $loanlength = $sth->fetchrow_hashref;
1131 return $loanlength->{issuelength}
1132 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1134 $sth->execute( "*", "*", "*" );
1135 $loanlength = $sth->fetchrow_hashref;
1136 return $loanlength->{issuelength}
1137 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1139 # if no rule is set => 21 days (hardcoded)
1144 =head2 GetHardDueDate
1146 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1148 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1152 sub GetHardDueDate {
1153 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1154 my $dbh = C4::Context->dbh;
1157 "select hardduedate, hardduedatecompare from issuingrules where categorycode=? and itemtype=? and branchcode=?"
1159 $sth->execute( $borrowertype, $itemtype, $branchcode );
1160 my $results = $sth->fetchrow_hashref;
1161 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1162 if defined($results) && $results->{hardduedate} ne 'NULL';
1164 $sth->execute( $borrowertype, "*", $branchcode );
1165 $results = $sth->fetchrow_hashref;
1166 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1167 if defined($results) && $results->{hardduedate} ne 'NULL';
1169 $sth->execute( "*", $itemtype, $branchcode );
1170 $results = $sth->fetchrow_hashref;
1171 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1172 if defined($results) && $results->{hardduedate} ne 'NULL';
1174 $sth->execute( "*", "*", $branchcode );
1175 $results = $sth->fetchrow_hashref;
1176 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1177 if defined($results) && $results->{hardduedate} ne 'NULL';
1179 $sth->execute( $borrowertype, $itemtype, "*" );
1180 $results = $sth->fetchrow_hashref;
1181 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1182 if defined($results) && $results->{hardduedate} ne 'NULL';
1184 $sth->execute( $borrowertype, "*", "*" );
1185 $results = $sth->fetchrow_hashref;
1186 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1187 if defined($results) && $results->{hardduedate} ne 'NULL';
1189 $sth->execute( "*", $itemtype, "*" );
1190 $results = $sth->fetchrow_hashref;
1191 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1192 if defined($results) && $results->{hardduedate} ne 'NULL';
1194 $sth->execute( "*", "*", "*" );
1195 $results = $sth->fetchrow_hashref;
1196 return (C4::Dates->new($results->{hardduedate}, 'iso'),$results->{hardduedatecompare})
1197 if defined($results) && $results->{hardduedate} ne 'NULL';
1199 # if no rule is set => return undefined
1200 return (undef, undef);
1203 =head2 GetIssuingRule
1205 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1207 FIXME - This is a copy-paste of GetLoanLength
1208 as a stop-gap. Do not wish to change API for GetLoanLength
1209 this close to release, however, Overdues::GetIssuingRules is broken.
1211 Get the issuing rule for an itemtype, a borrower type and a branch
1212 Returns a hashref from the issuingrules table.
1216 sub GetIssuingRule {
1217 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1218 my $dbh = C4::Context->dbh;
1219 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1222 $sth->execute( $borrowertype, $itemtype, $branchcode );
1223 $irule = $sth->fetchrow_hashref;
1224 return $irule if defined($irule) ;
1226 $sth->execute( $borrowertype, "*", $branchcode );
1227 $irule = $sth->fetchrow_hashref;
1228 return $irule if defined($irule) ;
1230 $sth->execute( "*", $itemtype, $branchcode );
1231 $irule = $sth->fetchrow_hashref;
1232 return $irule if defined($irule) ;
1234 $sth->execute( "*", "*", $branchcode );
1235 $irule = $sth->fetchrow_hashref;
1236 return $irule if defined($irule) ;
1238 $sth->execute( $borrowertype, $itemtype, "*" );
1239 $irule = $sth->fetchrow_hashref;
1240 return $irule if defined($irule) ;
1242 $sth->execute( $borrowertype, "*", "*" );
1243 $irule = $sth->fetchrow_hashref;
1244 return $irule if defined($irule) ;
1246 $sth->execute( "*", $itemtype, "*" );
1247 $irule = $sth->fetchrow_hashref;
1248 return $irule if defined($irule) ;
1250 $sth->execute( "*", "*", "*" );
1251 $irule = $sth->fetchrow_hashref;
1252 return $irule if defined($irule) ;
1254 # if no rule matches,
1258 =head2 GetBranchBorrowerCircRule
1260 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1262 Retrieves circulation rule attributes that apply to the given
1263 branch and patron category, regardless of item type.
1264 The return value is a hashref containing the following key:
1266 maxissueqty - maximum number of loans that a
1267 patron of the given category can have at the given
1268 branch. If the value is undef, no limit.
1270 This will first check for a specific branch and
1271 category match from branch_borrower_circ_rules.
1273 If no rule is found, it will then check default_branch_circ_rules
1274 (same branch, default category). If no rule is found,
1275 it will then check default_borrower_circ_rules (default
1276 branch, same category), then failing that, default_circ_rules
1277 (default branch, default category).
1279 If no rule has been found in the database, it will default to
1284 C<$branchcode> and C<$categorycode> should contain the
1285 literal branch code and patron category code, respectively - no
1290 sub GetBranchBorrowerCircRule {
1291 my $branchcode = shift;
1292 my $categorycode = shift;
1294 my $branch_cat_query = "SELECT maxissueqty
1295 FROM branch_borrower_circ_rules
1296 WHERE branchcode = ?
1297 AND categorycode = ?";
1298 my $dbh = C4::Context->dbh();
1299 my $sth = $dbh->prepare($branch_cat_query);
1300 $sth->execute($branchcode, $categorycode);
1302 if ($result = $sth->fetchrow_hashref()) {
1306 # try same branch, default borrower category
1307 my $branch_query = "SELECT maxissueqty
1308 FROM default_branch_circ_rules
1309 WHERE branchcode = ?";
1310 $sth = $dbh->prepare($branch_query);
1311 $sth->execute($branchcode);
1312 if ($result = $sth->fetchrow_hashref()) {
1316 # try default branch, same borrower category
1317 my $category_query = "SELECT maxissueqty
1318 FROM default_borrower_circ_rules
1319 WHERE categorycode = ?";
1320 $sth = $dbh->prepare($category_query);
1321 $sth->execute($categorycode);
1322 if ($result = $sth->fetchrow_hashref()) {
1326 # try default branch, default borrower category
1327 my $default_query = "SELECT maxissueqty
1328 FROM default_circ_rules";
1329 $sth = $dbh->prepare($default_query);
1331 if ($result = $sth->fetchrow_hashref()) {
1335 # built-in default circulation rule
1337 maxissueqty => undef,
1341 =head2 GetBranchItemRule
1343 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1345 Retrieves circulation rule attributes that apply to the given
1346 branch and item type, regardless of patron category.
1348 The return value is a hashref containing the following key:
1350 holdallowed => Hold policy for this branch and itemtype. Possible values:
1351 0: No holds allowed.
1352 1: Holds allowed only by patrons that have the same homebranch as the item.
1353 2: Holds allowed from any patron.
1355 This searches branchitemrules in the following order:
1357 * Same branchcode and itemtype
1358 * Same branchcode, itemtype '*'
1359 * branchcode '*', same itemtype
1360 * branchcode and itemtype '*'
1362 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1366 sub GetBranchItemRule {
1367 my ( $branchcode, $itemtype ) = @_;
1368 my $dbh = C4::Context->dbh();
1372 ['SELECT holdallowed
1373 FROM branch_item_rules
1374 WHERE branchcode = ?
1375 AND itemtype = ?', $branchcode, $itemtype],
1376 ['SELECT holdallowed
1377 FROM default_branch_circ_rules
1378 WHERE branchcode = ?', $branchcode],
1379 ['SELECT holdallowed
1380 FROM default_branch_item_rules
1381 WHERE itemtype = ?', $itemtype],
1382 ['SELECT holdallowed
1383 FROM default_circ_rules'],
1386 foreach my $attempt (@attempts) {
1387 my ($query, @bind_params) = @{$attempt};
1389 # Since branch/category and branch/itemtype use the same per-branch
1390 # defaults tables, we have to check that the key we want is set, not
1391 # just that a row was returned
1392 return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1395 # built-in default circulation rule
1403 ($doreturn, $messages, $iteminformation, $borrower) =
1404 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1410 =item C<$barcode> is the bar code of the book being returned.
1412 =item C<$branch> is the code of the branch where the book is being returned.
1414 =item C<$exemptfine> indicates that overdue charges for the item will be
1417 =item C<$dropbox> indicates that the check-in date is assumed to be
1418 yesterday, or the last non-holiday as defined in C4::Calendar . If
1419 overdue charges are applied and C<$dropbox> is true, the last charge
1420 will be removed. This assumes that the fines accrual script has run
1425 C<&AddReturn> returns a list of four items:
1427 C<$doreturn> is true iff the return succeeded.
1429 C<$messages> is a reference-to-hash giving feedback on the operation.
1430 The keys of the hash are:
1436 No item with this barcode exists. The value is C<$barcode>.
1440 The book is not currently on loan. The value is C<$barcode>.
1442 =item C<IsPermanent>
1444 The book's home branch is a permanent collection. If you have borrowed
1445 this book, you are not allowed to return it. The value is the code for
1446 the book's home branch.
1450 This book has been withdrawn/cancelled. The value should be ignored.
1452 =item C<Wrongbranch>
1454 This book has was returned to the wrong branch. The value is a hashref
1455 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1456 contain the branchcode of the incorrect and correct return library, respectively.
1460 The item was reserved. The value is a reference-to-hash whose keys are
1461 fields from the reserves table of the Koha database, and
1462 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1463 either C<Waiting>, C<Reserved>, or 0.
1467 C<$iteminformation> is a reference-to-hash, giving information about the
1468 returned item from the issues table.
1470 C<$borrower> is a reference-to-hash, giving information about the
1471 patron who last borrowed the book.
1476 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1477 if ($branch and not GetBranchDetail($branch)) {
1478 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1481 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1486 my $validTransfert = 0;
1487 my $stat_type = 'return';
1489 # get information on item
1490 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1491 unless ($itemnumber) {
1492 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1494 my $issue = GetItemIssue($itemnumber);
1495 # warn Dumper($iteminformation);
1496 if ($issue and $issue->{borrowernumber}) {
1497 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1498 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1499 . Dumper($issue) . "\n";
1501 $messages->{'NotIssued'} = $barcode;
1502 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1504 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1505 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1506 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1507 $messages->{'LocalUse'} = 1;
1508 $stat_type = 'localuse';
1512 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1513 # full item data, but no borrowernumber or checkout info (no issue)
1514 # we know GetItem should work because GetItemnumberFromBarcode worked
1515 my $hbr = C4::Context->preference("HomeOrHoldingBranchReturn") || "homebranch";
1516 $hbr = $item->{$hbr} || '';
1517 # item must be from items table -- issues table has branchcode and issuingbranch, not homebranch nor holdingbranch
1519 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1521 # check if the book is in a permanent collection....
1522 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1524 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1525 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1528 # if indy branches and returning to different branch, refuse the return
1529 if ($hbr ne $branch && C4::Context->preference("IndependantBranches")){
1530 $messages->{'Wrongbranch'} = {
1531 Wrongbranch => $branch,
1532 Rightbranch => $hbr,
1535 # bailing out here - in this case, current desired behavior
1536 # is to act as if no return ever happened at all.
1537 # FIXME - even in an indy branches situation, there should
1538 # still be an option for the library to accept the item
1539 # and transfer it to its owning library.
1540 return ( $doreturn, $messages, $issue, $borrower );
1543 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1544 $messages->{'wthdrawn'} = 1;
1548 # case of a return of document (deal with issues and holdingbranch)
1550 $borrower or warn "AddReturn without current borrower";
1551 my $circControlBranch;
1553 # define circControlBranch only if dropbox mode is set
1554 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1555 # FIXME: check issuedate > returndate, factoring in holidays
1556 $circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1559 if ($borrowernumber) {
1560 MarkIssueReturned($borrowernumber, $item->{'itemnumber'}, $circControlBranch, '', $borrower->{'privacy'});
1561 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right? This could be the borrower hash.
1564 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1567 # the holdingbranch is updated if the document is returned to another location.
1568 # this is always done regardless of whether the item was on loan or not
1569 if ($item->{'holdingbranch'} ne $branch) {
1570 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1571 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1573 ModDateLastSeen( $item->{'itemnumber'} );
1575 # check if we have a transfer for this document
1576 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1578 # if we have a transfer to do, we update the line of transfers with the datearrived
1580 if ( $tobranch eq $branch ) {
1581 my $sth = C4::Context->dbh->prepare(
1582 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1584 $sth->execute( $item->{'itemnumber'} );
1585 # if we have a reservation with valid transfer, we can set it's status to 'W'
1586 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1588 $messages->{'WrongTransfer'} = $tobranch;
1589 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1591 $validTransfert = 1;
1594 # fix up the accounts.....
1595 if ($item->{'itemlost'}) {
1596 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1597 $messages->{'WasLost'} = 1;
1600 # fix up the overdues in accounts...
1601 if ($borrowernumber) {
1602 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1603 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1606 my $debardate = _FixFineDaysOnReturn( $borrower, $item, $issue->{date_due} );
1607 $messages->{'Debarred'} = $debardate if ($debardate);
1610 # find reserves.....
1611 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1612 my ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1614 $resrec->{'ResFound'} = $resfound;
1615 $messages->{'ResFound'} = $resrec;
1619 # Record the fact that this book was returned.
1621 $branch, $stat_type, '0', '',
1622 $item->{'itemnumber'},
1623 $biblio->{'itemtype'},
1627 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1628 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1630 branchcode => $branch,
1631 categorycode => $borrower->{categorycode},
1632 item_type => $item->{itype},
1633 notification => 'CHECKIN',
1635 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1636 SendCirculationAlert({
1639 borrower => $borrower,
1644 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1645 if C4::Context->preference("ReturnLog");
1647 # FIXME: make this comment intelligible.
1648 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1649 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1651 if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
1652 if ( C4::Context->preference("AutomaticItemReturn" ) or
1653 (C4::Context->preference("UseBranchTransferLimits") and
1654 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1656 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1657 $debug and warn "item: " . Dumper($item);
1658 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1659 $messages->{'WasTransfered'} = 1;
1661 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1664 return ( $doreturn, $messages, $issue, $borrower );
1667 =head2 MarkIssueReturned
1669 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1671 Unconditionally marks an issue as being returned by
1672 moving the C<issues> row to C<old_issues> and
1673 setting C<returndate> to the current date, or
1674 the last non-holiday date of the branccode specified in
1675 C<dropbox_branch> . Assumes you've already checked that
1676 it's safe to do this, i.e. last non-holiday > issuedate.
1678 if C<$returndate> is specified (in iso format), it is used as the date
1679 of the return. It is ignored when a dropbox_branch is passed in.
1681 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1682 the old_issue is immediately anonymised
1684 Ideally, this function would be internal to C<C4::Circulation>,
1685 not exported, but it is currently needed by one
1686 routine in C<C4::Accounts>.
1690 sub MarkIssueReturned {
1691 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1692 my $dbh = C4::Context->dbh;
1693 my $query = "UPDATE issues SET returndate=";
1695 if ($dropbox_branch) {
1696 my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1697 my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1699 push @bind, $dropboxdate->output('iso');
1700 } elsif ($returndate) {
1702 push @bind, $returndate;
1704 $query .= " now() ";
1706 $query .= " WHERE borrowernumber = ? AND itemnumber = ?";
1707 push @bind, $borrowernumber, $itemnumber;
1709 my $sth_upd = $dbh->prepare($query);
1710 $sth_upd->execute(@bind);
1711 my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1712 WHERE borrowernumber = ?
1713 AND itemnumber = ?");
1714 $sth_copy->execute($borrowernumber, $itemnumber);
1715 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
1716 if ( $privacy == 2) {
1717 # The default of 0 does not work due to foreign key constraints
1718 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
1719 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
1720 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
1721 WHERE borrowernumber = ?
1722 AND itemnumber = ?");
1723 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
1725 my $sth_del = $dbh->prepare("DELETE FROM issues
1726 WHERE borrowernumber = ?
1727 AND itemnumber = ?");
1728 $sth_del->execute($borrowernumber, $itemnumber);
1731 =head2 _FixFineDaysOnReturn
1733 &_FixFineDaysOnReturn($borrower, $item, $datedue);
1735 C<$borrower> borrower hashref
1737 C<$item> item hashref
1739 C<$datedue> date due
1741 Internal function, called only by AddReturn that calculate and update the user fine days, and debars him
1745 sub _FixFineDaysOnReturn {
1746 my ( $borrower, $item, $datedue ) = @_;
1749 $datedue = C4::Dates->new( $datedue, "iso" );
1754 my $branchcode = _GetCircControlBranch( $item, $borrower );
1755 my $calendar = C4::Calendar->new( branchcode => $branchcode );
1756 my $today = C4::Dates->new();
1758 my $deltadays = $calendar->daysBetween( $datedue, C4::Dates->new() );
1760 my $circcontrol = C4::Context::preference('CircControl');
1761 my $issuingrule = GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
1762 my $finedays = $issuingrule->{finedays};
1764 # exit if no finedays defined
1765 return unless $finedays;
1766 my $grace = $issuingrule->{firstremind};
1768 if ( $deltadays - $grace > 0 ) {
1769 my @newdate = Add_Delta_Days( Today(), $deltadays * $finedays );
1770 my $isonewdate = join( '-', @newdate );
1771 my ( $deby, $debm, $debd ) = split( /-/, $borrower->{debarred} );
1772 if ( check_date( $deby, $debm, $debd ) ) {
1773 my @olddate = split( /-/, $borrower->{debarred} );
1775 if ( Delta_Days( @olddate, @newdate ) > 0 ) {
1776 C4::Members::DebarMember( $borrower->{borrowernumber}, $isonewdate );
1780 C4::Members::DebarMember( $borrower->{borrowernumber}, $isonewdate );
1786 =head2 _FixOverduesOnReturn
1788 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1790 C<$brn> borrowernumber
1794 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1795 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1797 Internal function, called only by AddReturn
1801 sub _FixOverduesOnReturn {
1802 my ($borrowernumber, $item);
1803 unless ($borrowernumber = shift) {
1804 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1807 unless ($item = shift) {
1808 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1811 my ($exemptfine, $dropbox) = @_;
1812 my $dbh = C4::Context->dbh;
1814 # check for overdue fine
1815 my $sth = $dbh->prepare(
1816 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1818 $sth->execute( $borrowernumber, $item );
1820 # alter fine to show that the book has been returned
1821 my $data = $sth->fetchrow_hashref;
1822 return 0 unless $data; # no warning, there's just nothing to fix
1825 my @bind = ($borrowernumber, $item, $data->{'accountno'});
1827 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1828 if (C4::Context->preference("FinesLog")) {
1829 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1831 } elsif ($dropbox && $data->{lastincrement}) {
1832 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1833 my $amt = $data->{amount} - $data->{lastincrement} ;
1834 if (C4::Context->preference("FinesLog")) {
1835 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1837 $uquery = "update accountlines set accounttype='F' ";
1838 if($outstanding >= 0 && $amt >=0) {
1839 $uquery .= ", amount = ? , amountoutstanding=? ";
1840 unshift @bind, ($amt, $outstanding) ;
1843 $uquery = "update accountlines set accounttype='F' ";
1845 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1846 my $usth = $dbh->prepare($uquery);
1847 return $usth->execute(@bind);
1850 =head2 _FixAccountForLostAndReturned
1852 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1854 Calculates the charge for a book lost and returned.
1856 Internal function, not exported, called only by AddReturn.
1858 FIXME: This function reflects how inscrutable fines logic is. Fix both.
1859 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
1863 sub _FixAccountForLostAndReturned {
1864 my $itemnumber = shift or return;
1865 my $borrowernumber = @_ ? shift : undef;
1866 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
1867 my $dbh = C4::Context->dbh;
1868 # check for charge made for lost book
1869 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1870 $sth->execute($itemnumber);
1871 my $data = $sth->fetchrow_hashref;
1872 $data or return; # bail if there is nothing to do
1874 # writeoff this amount
1876 my $amount = $data->{'amount'};
1877 my $acctno = $data->{'accountno'};
1878 my $amountleft; # Starts off undef/zero.
1879 if ($data->{'amountoutstanding'} == $amount) {
1880 $offset = $data->{'amount'};
1881 $amountleft = 0; # Hey, it's zero here, too.
1883 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
1884 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
1886 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1887 WHERE (borrowernumber = ?)
1888 AND (itemnumber = ?) AND (accountno = ?) ");
1889 $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
1890 #check if any credit is left if so writeoff other accounts
1891 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1892 $amountleft *= -1 if ($amountleft < 0);
1893 if ($amountleft > 0) {
1894 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1895 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
1896 $msth->execute($data->{'borrowernumber'});
1897 # offset transactions
1900 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1901 if ($accdata->{'amountoutstanding'} < $amountleft) {
1903 $amountleft -= $accdata->{'amountoutstanding'};
1905 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1908 my $thisacct = $accdata->{'accountno'};
1909 # FIXME: move prepares outside while loop!
1910 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1911 WHERE (borrowernumber = ?)
1912 AND (accountno=?)");
1913 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct'); # FIXME: '$thisacct' is a string literal!
1914 $usth = $dbh->prepare("INSERT INTO accountoffsets
1915 (borrowernumber, accountno, offsetaccount, offsetamount)
1918 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1920 $msth->finish; # $msth might actually have data left
1922 $amountleft *= -1 if ($amountleft > 0);
1923 my $desc = "Item Returned " . $item_id;
1924 $usth = $dbh->prepare("INSERT INTO accountlines
1925 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1926 VALUES (?,?,now(),?,?,'CR',?)");
1927 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1928 if ($borrowernumber) {
1929 # FIXME: same as query above. use 1 sth for both
1930 $usth = $dbh->prepare("INSERT INTO accountoffsets
1931 (borrowernumber, accountno, offsetaccount, offsetamount)
1933 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
1935 ModItem({ paidfor => '' }, undef, $itemnumber);
1939 =head2 _GetCircControlBranch
1941 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
1945 Return the library code to be used to determine which circulation
1946 policy applies to a transaction. Looks up the CircControl and
1947 HomeOrHoldingBranch system preferences.
1949 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
1951 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
1955 sub _GetCircControlBranch {
1956 my ($item, $borrower) = @_;
1957 my $circcontrol = C4::Context->preference('CircControl');
1960 if ($circcontrol eq 'PickupLibrary') {
1961 $branch= C4::Context->userenv->{'branch'} if C4::Context->userenv;
1962 } elsif ($circcontrol eq 'PatronLibrary') {
1963 $branch=$borrower->{branchcode};
1965 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
1966 $branch = $item->{$branchfield};
1967 # default to item home branch if holdingbranch is used
1968 # and is not defined
1969 if (!defined($branch) && $branchfield eq 'holdingbranch') {
1970 $branch = $item->{homebranch};
1983 $issue = &GetItemIssue($itemnumber);
1985 Returns patron currently having a book, or undef if not checked out.
1987 C<$itemnumber> is the itemnumber.
1989 C<$issue> is a hashref of the row from the issues table.
1994 my ($itemnumber) = @_;
1995 return unless $itemnumber;
1996 my $sth = C4::Context->dbh->prepare(
1999 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2000 WHERE issues.itemnumber=?");
2001 $sth->execute($itemnumber);
2002 my $data = $sth->fetchrow_hashref;
2003 return unless $data;
2004 $data->{'overdue'} = ($data->{'date_due'} lt C4::Dates->today('iso')) ? 1 : 0;
2010 $issue = GetOpenIssue( $itemnumber );
2012 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2014 C<$itemnumber> is the item's itemnumber
2021 my ( $itemnumber ) = @_;
2023 my $dbh = C4::Context->dbh;
2024 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2025 $sth->execute( $itemnumber );
2026 my $issue = $sth->fetchrow_hashref();
2030 =head2 GetItemIssues
2032 $issues = &GetItemIssues($itemnumber, $history);
2034 Returns patrons that have issued a book
2036 C<$itemnumber> is the itemnumber
2037 C<$history> is false if you just want the current "issuer" (if any)
2038 and true if you want issues history from old_issues also.
2040 Returns reference to an array of hashes
2045 my ( $itemnumber, $history ) = @_;
2047 my $today = C4::Dates->today('iso'); # get today date
2048 my $sql = "SELECT * FROM issues
2049 JOIN borrowers USING (borrowernumber)
2050 JOIN items USING (itemnumber)
2051 WHERE issues.itemnumber = ? ";
2054 SELECT * FROM old_issues
2055 LEFT JOIN borrowers USING (borrowernumber)
2056 JOIN items USING (itemnumber)
2057 WHERE old_issues.itemnumber = ? ";
2059 $sql .= "ORDER BY date_due DESC";
2060 my $sth = C4::Context->dbh->prepare($sql);
2062 $sth->execute($itemnumber, $itemnumber);
2064 $sth->execute($itemnumber);
2066 my $results = $sth->fetchall_arrayref({});
2067 foreach (@$results) {
2068 $_->{'overdue'} = ($_->{'date_due'} lt $today) ? 1 : 0;
2073 =head2 GetBiblioIssues
2075 $issues = GetBiblioIssues($biblionumber);
2077 this function get all issues from a biblionumber.
2080 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2081 tables issues and the firstname,surname & cardnumber from borrowers.
2085 sub GetBiblioIssues {
2086 my $biblionumber = shift;
2087 return undef unless $biblionumber;
2088 my $dbh = C4::Context->dbh;
2090 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2092 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2093 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2094 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2095 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2096 WHERE biblio.biblionumber = ?
2098 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2100 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2101 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2102 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2103 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2104 WHERE biblio.biblionumber = ?
2107 my $sth = $dbh->prepare($query);
2108 $sth->execute($biblionumber, $biblionumber);
2111 while ( my $data = $sth->fetchrow_hashref ) {
2112 push @issues, $data;
2117 =head2 GetUpcomingDueIssues
2119 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2123 sub GetUpcomingDueIssues {
2126 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2127 my $dbh = C4::Context->dbh;
2129 my $statement = <<END_SQL;
2130 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2132 LEFT JOIN items USING (itemnumber)
2133 LEFT OUTER JOIN branches USING (branchcode)
2134 WhERE returndate is NULL
2135 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
2138 my @bind_parameters = ( $params->{'days_in_advance'} );
2140 my $sth = $dbh->prepare( $statement );
2141 $sth->execute( @bind_parameters );
2142 my $upcoming_dues = $sth->fetchall_arrayref({});
2145 return $upcoming_dues;
2148 =head2 CanBookBeRenewed
2150 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2152 Find out whether a borrowed item may be renewed.
2154 C<$dbh> is a DBI handle to the Koha database.
2156 C<$borrowernumber> is the borrower number of the patron who currently
2157 has the item on loan.
2159 C<$itemnumber> is the number of the item to renew.
2161 C<$override_limit>, if supplied with a true value, causes
2162 the limit on the number of times that the loan can be renewed
2163 (as controlled by the item type) to be ignored.
2165 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2166 item must currently be on loan to the specified borrower; renewals
2167 must be allowed for the item's type; and the borrower must not have
2168 already renewed the loan. $error will contain the reason the renewal can not proceed
2172 sub CanBookBeRenewed {
2174 # check renewal status
2175 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2176 my $dbh = C4::Context->dbh;
2181 # Look in the issues table for this item, lent to this borrower,
2182 # and not yet returned.
2184 # Look in the issues table for this item, lent to this borrower,
2185 # and not yet returned.
2187 'ItemHomeLibrary' => 'items.homebranch',
2188 'PickupLibrary' => 'items.holdingbranch',
2189 'PatronLibrary' => 'borrowers.branchcode'
2191 my $controlbranch = $branch{C4::Context->preference('CircControl')};
2192 my $itype = C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype';
2194 my $sthcount = $dbh->prepare("
2196 borrowers.categorycode, biblioitems.itemtype, issues.renewals, renewalsallowed, $controlbranch
2199 LEFT JOIN items USING (itemnumber)
2200 LEFT JOIN borrowers USING (borrowernumber)
2201 LEFT JOIN biblioitems USING (biblioitemnumber)
2204 (issuingrules.categorycode = borrowers.categorycode OR issuingrules.categorycode = '*')
2206 (issuingrules.itemtype = $itype OR issuingrules.itemtype = '*')
2208 (issuingrules.branchcode = $controlbranch OR issuingrules.branchcode = '*')
2214 issuingrules.categorycode desc,
2215 issuingrules.itemtype desc,
2216 issuingrules.branchcode desc
2220 $sthcount->execute( $borrowernumber, $itemnumber );
2221 if ( my $data1 = $sthcount->fetchrow_hashref ) {
2223 if ( ( $data1->{renewalsallowed} && $data1->{renewalsallowed} > $data1->{renewals} ) || $override_limit ) {
2230 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2237 return ($renewokay,$error);
2242 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2246 C<$borrowernumber> is the borrower number of the patron who currently
2249 C<$itemnumber> is the number of the item to renew.
2251 C<$branch> is the library where the renewal took place (if any).
2252 The library that controls the circ policies for the renewal is retrieved from the issues record.
2254 C<$datedue> can be a C4::Dates object used to set the due date.
2256 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2257 this parameter is not supplied, lastreneweddate is set to the current date.
2259 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2260 from the book's item type.
2265 my $borrowernumber = shift or return undef;
2266 my $itemnumber = shift or return undef;
2268 my $datedue = shift;
2269 my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2270 my $item = GetItem($itemnumber) or return undef;
2271 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2273 my $dbh = C4::Context->dbh;
2274 # Find the issues record for this book
2276 $dbh->prepare("SELECT * FROM issues
2277 WHERE borrowernumber=?
2280 $sth->execute( $borrowernumber, $itemnumber );
2281 my $issuedata = $sth->fetchrow_hashref;
2283 if($datedue && ! $datedue->output('iso')){
2284 warn "Invalid date passed to AddRenewal.";
2287 # If the due date wasn't specified, calculate it by adding the
2288 # book's loan length to today's date or the current due date
2289 # based on the value of the RenewalPeriodBase syspref.
2292 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return undef;
2293 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2295 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2296 C4::Dates->new($issuedata->{date_due}, 'iso') :
2298 $datedue = CalcDateDue($datedue,$itemtype,$issuedata->{'branchcode'},$borrower);
2301 # Update the issues record to have the new due date, and a new count
2302 # of how many times it has been renewed.
2303 my $renews = $issuedata->{'renewals'} + 1;
2304 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2305 WHERE borrowernumber=?
2308 $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2311 # Update the renewal count on the item, and tell zebra to reindex
2312 $renews = $biblio->{'renewals'} + 1;
2313 ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2315 # Charge a new rental fee, if applicable?
2316 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2317 if ( $charge > 0 ) {
2318 my $accountno = getnextacctno( $borrowernumber );
2319 my $item = GetBiblioFromItemNumber($itemnumber);
2321 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2322 $sth = $dbh->prepare(
2323 "INSERT INTO accountlines
2324 (date, borrowernumber, accountno, amount, manager_id,
2325 description,accounttype, amountoutstanding, itemnumber)
2326 VALUES (now(),?,?,?,?,?,?,?,?)"
2328 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2329 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2330 'Rent', $charge, $itemnumber );
2334 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2339 # check renewal status
2340 my ( $bornum, $itemno ) = @_;
2341 my $dbh = C4::Context->dbh;
2343 my $renewsallowed = 0;
2346 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2347 my $item = GetItem($itemno);
2349 # Look in the issues table for this item, lent to this borrower,
2350 # and not yet returned.
2352 # FIXME - I think this function could be redone to use only one SQL call.
2353 my $sth = $dbh->prepare(
2354 "select * from issues
2355 where (borrowernumber = ?)
2356 and (itemnumber = ?)"
2358 $sth->execute( $bornum, $itemno );
2359 my $data = $sth->fetchrow_hashref;
2360 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2362 # $item and $borrower should be calculated
2363 my $branchcode = _GetCircControlBranch($item, $borrower);
2365 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2367 $renewsallowed = $issuingrule->{'renewalsallowed'};
2368 $renewsleft = $renewsallowed - $renewcount;
2369 if($renewsleft < 0){ $renewsleft = 0; }
2370 return ( $renewcount, $renewsallowed, $renewsleft );
2373 =head2 GetIssuingCharges
2375 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2377 Calculate how much it would cost for a given patron to borrow a given
2378 item, including any applicable discounts.
2380 C<$itemnumber> is the item number of item the patron wishes to borrow.
2382 C<$borrowernumber> is the patron's borrower number.
2384 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2385 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2390 sub GetIssuingCharges {
2392 # calculate charges due
2393 my ( $itemnumber, $borrowernumber ) = @_;
2395 my $dbh = C4::Context->dbh;
2398 # Get the book's item type and rental charge (via its biblioitem).
2399 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2400 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2401 $charge_query .= (C4::Context->preference('item-level_itypes'))
2402 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2403 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2405 $charge_query .= ' WHERE items.itemnumber =?';
2407 my $sth = $dbh->prepare($charge_query);
2408 $sth->execute($itemnumber);
2409 if ( my $item_data = $sth->fetchrow_hashref ) {
2410 $item_type = $item_data->{itemtype};
2411 $charge = $item_data->{rentalcharge};
2412 my $branch = C4::Branch::mybranch();
2413 my $discount_query = q|SELECT rentaldiscount,
2414 issuingrules.itemtype, issuingrules.branchcode
2416 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2417 WHERE borrowers.borrowernumber = ?
2418 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2419 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2420 my $discount_sth = $dbh->prepare($discount_query);
2421 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2422 my $discount_rules = $discount_sth->fetchall_arrayref({});
2423 if (@{$discount_rules}) {
2424 # We may have multiple rules so get the most specific
2425 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2426 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2430 $sth->finish; # we havent _explicitly_ fetched all rows
2431 return ( $charge, $item_type );
2434 # Select most appropriate discount rule from those returned
2435 sub _get_discount_from_rule {
2436 my ($rules_ref, $branch, $itemtype) = @_;
2439 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2440 $discount = $rules_ref->[0]->{rentaldiscount};
2441 return (defined $discount) ? $discount : 0;
2443 # could have up to 4 does one match $branch and $itemtype
2444 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2446 $discount = $d[0]->{rentaldiscount};
2447 return (defined $discount) ? $discount : 0;
2449 # do we have item type + all branches
2450 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2452 $discount = $d[0]->{rentaldiscount};
2453 return (defined $discount) ? $discount : 0;
2455 # do we all item types + this branch
2456 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2458 $discount = $d[0]->{rentaldiscount};
2459 return (defined $discount) ? $discount : 0;
2461 # so all and all (surely we wont get here)
2462 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2464 $discount = $d[0]->{rentaldiscount};
2465 return (defined $discount) ? $discount : 0;
2471 =head2 AddIssuingCharge
2473 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2477 sub AddIssuingCharge {
2478 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2479 my $dbh = C4::Context->dbh;
2480 my $nextaccntno = getnextacctno( $borrowernumber );
2482 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2484 INSERT INTO accountlines
2485 (borrowernumber, itemnumber, accountno,
2486 date, amount, description, accounttype,
2487 amountoutstanding, manager_id)
2488 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2490 my $sth = $dbh->prepare($query);
2491 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2497 GetTransfers($itemnumber);
2502 my ($itemnumber) = @_;
2504 my $dbh = C4::Context->dbh;
2510 FROM branchtransfers
2511 WHERE itemnumber = ?
2512 AND datearrived IS NULL
2514 my $sth = $dbh->prepare($query);
2515 $sth->execute($itemnumber);
2516 my @row = $sth->fetchrow_array();
2521 =head2 GetTransfersFromTo
2523 @results = GetTransfersFromTo($frombranch,$tobranch);
2525 Returns the list of pending transfers between $from and $to branch
2529 sub GetTransfersFromTo {
2530 my ( $frombranch, $tobranch ) = @_;
2531 return unless ( $frombranch && $tobranch );
2532 my $dbh = C4::Context->dbh;
2534 SELECT itemnumber,datesent,frombranch
2535 FROM branchtransfers
2538 AND datearrived IS NULL
2540 my $sth = $dbh->prepare($query);
2541 $sth->execute( $frombranch, $tobranch );
2544 while ( my $data = $sth->fetchrow_hashref ) {
2545 push @gettransfers, $data;
2548 return (@gettransfers);
2551 =head2 DeleteTransfer
2553 &DeleteTransfer($itemnumber);
2557 sub DeleteTransfer {
2558 my ($itemnumber) = @_;
2559 my $dbh = C4::Context->dbh;
2560 my $sth = $dbh->prepare(
2561 "DELETE FROM branchtransfers
2563 AND datearrived IS NULL "
2565 $sth->execute($itemnumber);
2569 =head2 AnonymiseIssueHistory
2571 $rows = AnonymiseIssueHistory($date,$borrowernumber)
2573 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2574 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2576 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2577 setting (force delete).
2579 return the number of affected rows.
2583 sub AnonymiseIssueHistory {
2585 my $borrowernumber = shift;
2586 my $dbh = C4::Context->dbh;
2589 SET borrowernumber = ?
2590 WHERE returndate < ?
2591 AND borrowernumber IS NOT NULL
2594 # The default of 0 does not work due to foreign key constraints
2595 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2596 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2597 my @bind_params = ($anonymouspatron, $date);
2598 if (defined $borrowernumber) {
2599 $query .= " AND borrowernumber = ?";
2600 push @bind_params, $borrowernumber;
2602 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2604 my $sth = $dbh->prepare($query);
2605 $sth->execute(@bind_params);
2606 my $rows_affected = $sth->rows; ### doublecheck row count return function
2607 return $rows_affected;
2610 =head2 SendCirculationAlert
2612 Send out a C<check-in> or C<checkout> alert using the messaging system.
2620 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2624 Hashref of information about the item being checked in or out.
2628 Hashref of information about the borrower of the item.
2632 The branchcode from where the checkout or check-in took place.
2638 SendCirculationAlert({
2641 borrower => $borrower,
2647 sub SendCirculationAlert {
2649 my ($type, $item, $borrower, $branch) =
2650 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2651 my %message_name = (
2652 CHECKIN => 'Item_Check_in',
2653 CHECKOUT => 'Item_Checkout',
2655 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2656 borrowernumber => $borrower->{borrowernumber},
2657 message_name => $message_name{$type},
2659 my $letter = C4::Letters::getletter('circulation', $type);
2660 C4::Letters::parseletter($letter, 'biblio', $item->{biblionumber});
2661 C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2662 C4::Letters::parseletter($letter, 'borrowers', $borrower->{borrowernumber});
2663 C4::Letters::parseletter($letter, 'branches', $branch);
2664 my @transports = @{ $borrower_preferences->{transports} };
2665 # warn "no transports" unless @transports;
2667 # warn "transport: $_";
2668 my $message = C4::Message->find_last_message($borrower, $type, $_);
2670 #warn "create new message";
2671 C4::Message->enqueue($letter, $borrower, $_);
2673 #warn "append to old message";
2674 $message->append($letter);
2681 =head2 updateWrongTransfer
2683 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2685 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
2689 sub updateWrongTransfer {
2690 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2691 my $dbh = C4::Context->dbh;
2692 # first step validate the actual line of transfert .
2695 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2697 $sth->execute($FromLibrary,$itemNumber);
2700 # second step create a new line of branchtransfer to the right location .
2701 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2703 #third step changing holdingbranch of item
2704 UpdateHoldingbranch($FromLibrary,$itemNumber);
2707 =head2 UpdateHoldingbranch
2709 $items = UpdateHoldingbranch($branch,$itmenumber);
2711 Simple methode for updating hodlingbranch in items BDD line
2715 sub UpdateHoldingbranch {
2716 my ( $branch,$itemnumber ) = @_;
2717 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2722 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
2724 this function calculates the due date given the start date and configured circulation rules,
2725 checking against the holidays calendar as per the 'useDaysMode' syspref.
2726 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2727 C<$itemtype> = itemtype code of item in question
2728 C<$branch> = location whose calendar to use
2729 C<$borrower> = Borrower object
2734 my ($startdate,$itemtype,$branch,$borrower) = @_;
2736 my $loanlength = GetLoanLength($borrower->{'categorycode'},$itemtype, $branch);
2738 # if globalDueDate ON the datedue is set to that date
2739 if ( C4::Context->preference('globalDueDate')
2740 && ( C4::Context->preference('globalDueDate') =~ C4::Dates->regexp('syspref') ) ) {
2741 $datedue = C4::Dates->new( C4::Context->preference('globalDueDate') );
2743 # otherwise, calculate the datedue as normal
2744 if(C4::Context->preference('useDaysMode') eq 'Days') { # ignoring calendar
2745 my $timedue = time + ($loanlength) * 86400;
2746 #FIXME - assumes now even though we take a startdate
2747 my @datearr = localtime($timedue);
2748 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2750 my $calendar = C4::Calendar->new( branchcode => $branch );
2751 $datedue = $calendar->addDate($startdate, $loanlength);
2755 # if Hard Due Dates are used, retreive them and apply as necessary
2756 my ($hardduedate, $hardduedatecompare) = GetHardDueDate($borrower->{'categorycode'},$itemtype, $branch);
2757 if ( $hardduedate && $hardduedate->output('iso') && $hardduedate->output('iso') ne '0000-00-00') {
2758 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
2759 if ( $datedue->output( 'iso' ) gt $hardduedate->output( 'iso' ) && $hardduedatecompare == -1) {
2760 $datedue = $hardduedate;
2761 # if the calculated date is before the 'after' Hard Due Date (floor), override
2762 } elsif ( $datedue->output( 'iso' ) lt $hardduedate->output( 'iso' ) && $hardduedatecompare == 1) {
2763 $datedue = $hardduedate;
2764 # if the hard due date is set to 'exactly', overrride
2765 } elsif ( $hardduedatecompare == 0) {
2766 $datedue = $hardduedate;
2768 # in all other cases, keep the date due as it is
2771 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2772 if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2773 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2779 =head2 CheckValidDatedue
2781 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2783 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2784 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2786 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2787 C<$date_due> = returndate calculate with no day check
2788 C<$itemnumber> = itemnumber
2789 C<$branchcode> = location of issue (affected by 'CircControl' syspref)
2790 C<$loanlength> = loan length prior to adjustment
2794 sub CheckValidDatedue {
2795 my ($date_due,$itemnumber,$branchcode)=@_;
2796 my @datedue=split('-',$date_due->output('iso'));
2797 my $years=$datedue[0];
2798 my $month=$datedue[1];
2799 my $day=$datedue[2];
2800 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2802 for (my $i=0;$i<2;$i++){
2803 $dow=Day_of_Week($years,$month,$day);
2804 ($dow=0) if ($dow>6);
2805 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2806 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2807 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2808 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2810 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2813 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2818 =head2 CheckRepeatableHolidays
2820 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2822 This function checks if the date due is a repeatable holiday
2824 C<$date_due> = returndate calculate with no day check
2825 C<$itemnumber> = itemnumber
2826 C<$branchcode> = localisation of issue
2830 sub CheckRepeatableHolidays{
2831 my($itemnumber,$week_day,$branchcode)=@_;
2832 my $dbh = C4::Context->dbh;
2833 my $query = qq|SELECT count(*)
2834 FROM repeatable_holidays
2837 my $sth = $dbh->prepare($query);
2838 $sth->execute($branchcode,$week_day);
2839 my $result=$sth->fetchrow;
2845 =head2 CheckSpecialHolidays
2847 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2849 This function check if the date is a special holiday
2851 C<$years> = the years of datedue
2852 C<$month> = the month of datedue
2853 C<$day> = the day of datedue
2854 C<$itemnumber> = itemnumber
2855 C<$branchcode> = localisation of issue
2859 sub CheckSpecialHolidays{
2860 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2861 my $dbh = C4::Context->dbh;
2862 my $query=qq|SELECT count(*)
2863 FROM `special_holidays`
2869 my $sth = $dbh->prepare($query);
2870 $sth->execute($years,$month,$day,$branchcode);
2871 my $countspecial=$sth->fetchrow ;
2873 return $countspecial;
2876 =head2 CheckRepeatableSpecialHolidays
2878 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2880 This function check if the date is a repeatble special holidays
2882 C<$month> = the month of datedue
2883 C<$day> = the day of datedue
2884 C<$itemnumber> = itemnumber
2885 C<$branchcode> = localisation of issue
2889 sub CheckRepeatableSpecialHolidays{
2890 my ($month,$day,$itemnumber,$branchcode) = @_;
2891 my $dbh = C4::Context->dbh;
2892 my $query=qq|SELECT count(*)
2893 FROM `repeatable_holidays`
2898 my $sth = $dbh->prepare($query);
2899 $sth->execute($month,$day,$branchcode);
2900 my $countspecial=$sth->fetchrow ;
2902 return $countspecial;
2907 sub CheckValidBarcode{
2909 my $dbh = C4::Context->dbh;
2910 my $query=qq|SELECT count(*)
2914 my $sth = $dbh->prepare($query);
2915 $sth->execute($barcode);
2916 my $exist=$sth->fetchrow ;
2921 =head2 IsBranchTransferAllowed
2923 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2925 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2929 sub IsBranchTransferAllowed {
2930 my ( $toBranch, $fromBranch, $code ) = @_;
2932 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2934 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2935 my $dbh = C4::Context->dbh;
2937 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2938 $sth->execute( $toBranch, $fromBranch, $code );
2939 my $limit = $sth->fetchrow_hashref();
2941 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2942 if ( $limit->{'limitId'} ) {
2949 =head2 CreateBranchTransferLimit
2951 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2953 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2957 sub CreateBranchTransferLimit {
2958 my ( $toBranch, $fromBranch, $code ) = @_;
2960 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2962 my $dbh = C4::Context->dbh;
2964 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2965 $sth->execute( $code, $toBranch, $fromBranch );
2968 =head2 DeleteBranchTransferLimits
2970 DeleteBranchTransferLimits();
2974 sub DeleteBranchTransferLimits {
2975 my $dbh = C4::Context->dbh;
2976 my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2981 my ( $borrowernumber, $itemnum ) = @_;
2983 MarkIssueReturned( $borrowernumber, $itemnum );
2984 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
2985 my @datearr = localtime(time);
2986 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
2987 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
2988 ModItem({ paidfor => "Paid for by $bor $date" }, undef, $itemnum);
2993 my ($itemnumber, $mark_returned, $charge_fee) = @_;
2995 my $dbh = C4::Context->dbh();
2996 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
2998 JOIN items USING (itemnumber)
2999 JOIN biblio USING (biblionumber)
3000 WHERE issues.itemnumber=?");
3001 $sth->execute($itemnumber);
3002 my $issues=$sth->fetchrow_hashref();
3005 # if a borrower lost the item, add a replacement cost to the their record
3006 if ( my $borrowernumber = $issues->{borrowernumber} ){
3008 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}")
3010 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3011 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3012 MarkIssueReturned($borrowernumber,$itemnumber) if $mark_returned;
3023 Koha Development Team <http://koha-community.org/>