1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along with
17 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
18 # Suite 330, Boston, MA 02111-1307 USA
22 #use warnings; # soon!
33 use C4::ItemCirculationAlertPreference;
44 use POSIX qw(strftime);
45 use C4::Branch; # GetBranches
46 use C4::Log; # logaction
50 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
54 $VERSION = 3.02; # for version checking
57 # FIXME subs that should probably be elsewhere
63 # subs to deal with issuing a book
76 &GetBranchBorrowerCircRule
79 &AnonymiseIssueHistory
82 # subs to deal with returns
88 # subs to deal with transfers
95 &IsBranchTransferAllowed
96 &CreateBranchTransferLimit
97 &DeleteBranchTransferLimits
103 C4::Circulation - Koha circulation module
111 The functions in this module deal with circulation, issues, and
112 returns, as well as general information about the library.
113 Also deals with stocktaking.
119 =head3 $str = &barcodedecode($barcode, [$filter]);
123 =item Generic filter function for barcode string.
124 Called on every circ if the System Pref itemBarcodeInputFilter is set.
125 Will do some manipulation of the barcode for systems that deliver a barcode
126 to circulation.pl that differs from the barcode stored for the item.
127 For proper functioning of this filter, calling the function on the
128 correct barcode string (items.barcode) should return an unaltered barcode.
130 The optional $filter argument is to allow for testing or explicit
131 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 $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"?
162 return $barcode; # return barcode, modified or not
167 =head3 $str = &decode($chunk);
171 =item Decodes a segment of a string emitted by a CueCat barcode scanner and
174 FIXME: Should be replaced with Barcode::Cuecat from CPAN
175 or Javascript based decoding on the client side.
184 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
185 my @s = map { index( $seq, $_ ); } split( //, $encoded );
186 my $l = ( $#s + 1 ) % 4;
189 # warn "Error: Cuecat decode parsing failed!";
197 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
199 chr( ( $n >> 16 ) ^ 67 )
200 .chr( ( $n >> 8 & 255 ) ^ 67 )
201 .chr( ( $n & 255 ) ^ 67 );
204 $r = substr( $r, 0, length($r) - $l );
210 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch, $barcode, $ignore_reserves);
212 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
214 C<$newbranch> is the code for the branch to which the item should be transferred.
216 C<$barcode> is the barcode of the item to be transferred.
218 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
219 Otherwise, if an item is reserved, the transfer fails.
221 Returns three values:
225 is true if the transfer was successful.
229 is a reference-to-hash which may have any of the following keys:
235 There is no item in the catalog with the given barcode. The value is C<$barcode>.
239 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.
241 =item C<DestinationEqualsHolding>
243 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.
247 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.
251 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>.
253 =item C<WasTransferred>
255 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
262 my ( $tbr, $barcode, $ignoreRs ) = @_;
265 my $branches = GetBranches();
266 my $itemnumber = GetItemnumberFromBarcode( $barcode );
267 my $issue = GetItemIssue($itemnumber);
268 my $biblio = GetBiblioFromItemNumber($itemnumber);
271 if ( not $itemnumber ) {
272 $messages->{'BadBarcode'} = $barcode;
276 # get branches of book...
277 my $hbr = $biblio->{'homebranch'};
278 my $fbr = $biblio->{'holdingbranch'};
280 # if using Branch Transfer Limits
281 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
282 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
283 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
284 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
287 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
288 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
294 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
295 $messages->{'IsPermanent'} = $hbr;
299 # can't transfer book if is already there....
300 if ( $fbr eq $tbr ) {
301 $messages->{'DestinationEqualsHolding'} = 1;
305 # check if it is still issued to someone, return it...
306 if ($issue->{borrowernumber}) {
307 AddReturn( $barcode, $fbr );
308 $messages->{'WasReturned'} = $issue->{borrowernumber};
312 # That'll save a database query.
313 my ( $resfound, $resrec ) =
314 CheckReserves( $itemnumber );
315 if ( $resfound and not $ignoreRs ) {
316 $resrec->{'ResFound'} = $resfound;
318 # $messages->{'ResFound'} = $resrec;
322 #actually do the transfer....
324 ModItemTransfer( $itemnumber, $fbr, $tbr );
326 # don't need to update MARC anymore, we do it in batch now
327 $messages->{'WasTransfered'} = 1;
328 ModDateLastSeen( $itemnumber );
330 return ( $dotransfer, $messages, $biblio );
335 my $borrower = shift;
336 my $biblionumber = shift;
338 my $cat_borrower = $borrower->{'categorycode'};
339 my $dbh = C4::Context->dbh;
341 # Get which branchcode we need
342 if (C4::Context->preference('CircControl') eq 'PickupLibrary'){
343 $branch = C4::Context->userenv->{'branch'};
345 elsif (C4::Context->preference('CircControl') eq 'PatronLibrary'){
346 $branch = $borrower->{'branchcode'};
350 $branch = $item->{'homebranch'};
352 my $type = (C4::Context->preference('item-level_itypes'))
353 ? $item->{'itype'} # item-level
354 : $item->{'itemtype'}; # biblio-level
356 # given branch, patron category, and item type, determine
357 # applicable issuing rule
358 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
360 # if a rule is found and has a loan limit set, count
361 # how many loans the patron already has that meet that
363 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
365 my $count_query = "SELECT COUNT(*) FROM issues
366 JOIN items USING (itemnumber) ";
368 my $rule_itemtype = $issuing_rule->{itemtype};
369 if ($rule_itemtype eq "*") {
370 # matching rule has the default item type, so count only
371 # those existing loans that don't fall under a more
373 if (C4::Context->preference('item-level_itypes')) {
374 $count_query .= " WHERE items.itype NOT IN (
375 SELECT itemtype FROM issuingrules
377 AND (categorycode = ? OR categorycode = ?)
381 $count_query .= " JOIN biblioitems USING (biblionumber)
382 WHERE biblioitems.itemtype NOT IN (
383 SELECT itemtype FROM issuingrules
385 AND (categorycode = ? OR categorycode = ?)
389 push @bind_params, $issuing_rule->{branchcode};
390 push @bind_params, $issuing_rule->{categorycode};
391 push @bind_params, $cat_borrower;
393 # rule has specific item type, so count loans of that
395 if (C4::Context->preference('item-level_itypes')) {
396 $count_query .= " WHERE items.itype = ? ";
398 $count_query .= " JOIN biblioitems USING (biblionumber)
399 WHERE biblioitems.itemtype= ? ";
401 push @bind_params, $type;
404 $count_query .= " AND borrowernumber = ? ";
405 push @bind_params, $borrower->{'borrowernumber'};
406 my $rule_branch = $issuing_rule->{branchcode};
407 if ($rule_branch ne "*") {
408 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
409 $count_query .= " AND issues.branchcode = ? ";
410 push @bind_params, $branch;
411 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
412 ; # if branch is the patron's home branch, then count all loans by patron
414 $count_query .= " AND items.homebranch = ? ";
415 push @bind_params, $branch;
419 my $count_sth = $dbh->prepare($count_query);
420 $count_sth->execute(@bind_params);
421 my ($current_loan_count) = $count_sth->fetchrow_array;
423 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
424 if ($current_loan_count >= $max_loans_allowed) {
425 return "$current_loan_count / $max_loans_allowed";
429 # Now count total loans against the limit for the branch
430 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
431 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
432 my @bind_params = ();
433 my $branch_count_query = "SELECT COUNT(*) FROM issues
434 JOIN items USING (itemnumber)
435 WHERE borrowernumber = ? ";
436 push @bind_params, $borrower->{borrowernumber};
438 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
439 $branch_count_query .= " AND issues.branchcode = ? ";
440 push @bind_params, $branch;
441 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
442 ; # if branch is the patron's home branch, then count all loans by patron
444 $branch_count_query .= " AND items.homebranch = ? ";
445 push @bind_params, $branch;
447 my $branch_count_sth = $dbh->prepare($branch_count_query);
448 $branch_count_sth->execute(@bind_params);
449 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
451 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
452 if ($current_loan_count >= $max_loans_allowed) {
453 return "$current_loan_count / $max_loans_allowed";
457 # OK, the patron can issue !!!
463 @issues = &itemissues($biblioitemnumber, $biblio);
465 Looks up information about who has borrowed the bookZ<>(s) with the
466 given biblioitemnumber.
468 C<$biblio> is ignored.
470 C<&itemissues> returns an array of references-to-hash. The keys
471 include the fields from the C<items> table in the Koha database.
472 Additional keys include:
478 If the item is currently on loan, this gives the due date.
480 If the item is not on loan, then this is either "Available" or
481 "Cancelled", if the item has been withdrawn.
485 If the item is currently on loan, this gives the card number of the
486 patron who currently has the item.
488 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
490 These give the timestamp for the last three times the item was
493 =item C<card0>, C<card1>, C<card2>
495 The card number of the last three patrons who borrowed this item.
497 =item C<borrower0>, C<borrower1>, C<borrower2>
499 The borrower number of the last three patrons who borrowed this item.
507 my ( $bibitem, $biblio ) = @_;
508 my $dbh = C4::Context->dbh;
510 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
515 $sth->execute($bibitem) || die $sth->errstr;
517 while ( my $data = $sth->fetchrow_hashref ) {
519 # Find out who currently has this item.
520 # FIXME - Wouldn't it be better to do this as a left join of
521 # some sort? Currently, this code assumes that if
522 # fetchrow_hashref() fails, then the book is on the shelf.
523 # fetchrow_hashref() can fail for any number of reasons (e.g.,
524 # database server crash), not just because no items match the
526 my $sth2 = $dbh->prepare(
527 "SELECT * FROM issues
528 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
533 $sth2->execute( $data->{'itemnumber'} );
534 if ( my $data2 = $sth2->fetchrow_hashref ) {
535 $data->{'date_due'} = $data2->{'date_due'};
536 $data->{'card'} = $data2->{'cardnumber'};
537 $data->{'borrower'} = $data2->{'borrowernumber'};
540 $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'};
564 $results[$i] = $data;
572 =head2 CanBookBeIssued
574 Check if a book can be issued.
576 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower, $barcode, $duedatespec, $inprocess );
578 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
582 =item C<$borrower> hash with borrower informations (from 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<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
634 Possible values are :
642 renewing, not issuing
644 =head3 ISSUED_TO_ANOTHER
646 issued to someone else.
650 reserved for someone else.
654 sticky due date is invalid
658 if the borrower borrows to much things
662 sub CanBookBeIssued {
663 my ( $borrower, $barcode, $duedate, $inprocess ) = @_;
664 my %needsconfirmation; # filled with problems that needs confirmations
665 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
666 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
667 my $issue = GetItemIssue($item->{itemnumber});
668 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
669 $item->{'itemtype'}=$item->{'itype'};
670 my $dbh = C4::Context->dbh;
672 # MANDATORY CHECKS - unless item exists, nothing else matters
673 unless ( $item->{barcode} ) {
674 $issuingimpossible{UNKNOWN_BARCODE} = 1;
676 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
679 # DUE DATE is OK ? -- should already have checked.
681 unless ( $duedate ) {
682 my $issuedate = strftime( "%Y-%m-%d", localtime );
683 my $branch = (C4::Context->preference('CircControl') eq 'PickupLibrary') ? C4::Context->userenv->{'branch'} :
684 (C4::Context->preference('CircControl') eq 'PatronLibrary') ? $borrower->{'branchcode'} :
685 $item->{'homebranch'}; # fallback to item's homebranch
686 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
687 my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
688 $duedate = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
690 # Offline circ calls AddIssue directly, doesn't run through here
691 # So issuingimpossible should be ok.
693 $issuingimpossible{INVALID_DATE} = $duedate->output('syspref') unless ( $duedate && $duedate->output('iso') ge C4::Dates->today('iso') );
698 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
699 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
700 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'});
701 return( { STATS => 1 }, {});
703 if ( $borrower->{flags}->{GNA} ) {
704 $issuingimpossible{GNA} = 1;
706 if ( $borrower->{flags}->{'LOST'} ) {
707 $issuingimpossible{CARD_LOST} = 1;
709 if ( $borrower->{flags}->{'DBARRED'} ) {
710 $issuingimpossible{DEBARRED} = 1;
712 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
713 $issuingimpossible{EXPIRED} = 1;
715 my @expirydate= split /-/,$borrower->{'dateexpiry'};
716 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
717 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
718 $issuingimpossible{EXPIRED} = 1;
727 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
728 if ( C4::Context->preference("IssuingInProcess") ) {
729 my $amountlimit = C4::Context->preference("noissuescharge");
730 if ( $amount > $amountlimit && !$inprocess ) {
731 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
733 elsif ( $amount > 0 && $amount <= $amountlimit && !$inprocess ) {
734 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
739 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
744 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
746 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
747 # if TooMany return / 0, then the user has no permission to check out this book
748 if ($toomany =~ /\/ 0/) {
749 $needsconfirmation{PATRON_CANT} = 1;
751 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
757 if ( $item->{'notforloan'}
758 && $item->{'notforloan'} > 0 )
760 if(!C4::Context->preference("AllowNotForLoanOverride")){
761 $issuingimpossible{NOT_FOR_LOAN} = 1;
763 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
766 elsif ( !$item->{'notforloan'} ){
767 # we have to check itemtypes.notforloan also
768 if (C4::Context->preference('item-level_itypes')){
769 # this should probably be a subroutine
770 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
771 $sth->execute($item->{'itemtype'});
772 my $notforloan=$sth->fetchrow_hashref();
774 if ($notforloan->{'notforloan'}) {
775 if (!C4::Context->preference("AllowNotForLoanOverride")) {
776 $issuingimpossible{NOT_FOR_LOAN} = 1;
778 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
782 elsif ($biblioitem->{'notforloan'} == 1){
783 if (!C4::Context->preference("AllowNotForLoanOverride")) {
784 $issuingimpossible{NOT_FOR_LOAN} = 1;
786 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
790 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
792 $issuingimpossible{WTHDRAWN} = 1;
794 if ( $item->{'restricted'}
795 && $item->{'restricted'} == 1 )
797 $issuingimpossible{RESTRICTED} = 1;
799 if ( C4::Context->preference("IndependantBranches") ) {
800 my $userenv = C4::Context->userenv;
801 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
802 $issuingimpossible{NOTSAMEBRANCH} = 1
803 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
808 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
810 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
813 # Already issued to current borrower. Ask whether the loan should
815 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
816 $borrower->{'borrowernumber'},
817 $item->{'itemnumber'}
819 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
820 $issuingimpossible{NO_MORE_RENEWALS} = 1;
823 $needsconfirmation{RENEW_ISSUE} = 1;
826 elsif ($issue->{borrowernumber}) {
828 # issued to someone else
829 my $currborinfo = C4::Members::GetMemberDetails( $issue->{borrowernumber} );
831 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
832 $needsconfirmation{ISSUED_TO_ANOTHER} =
833 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
836 # See if the item is on reserve.
837 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
839 my $resbor = $res->{'borrowernumber'};
840 my ( $resborrower ) = C4::Members::GetMemberDetails( $resbor, 0 );
841 my $branches = GetBranches();
842 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
843 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
845 # The item is on reserve and waiting, but has been
846 # reserved by some other patron.
847 $needsconfirmation{RESERVE_WAITING} =
848 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
850 elsif ( $restype eq "Reserved" ) {
851 # The item is on reserve for someone else.
852 $needsconfirmation{RESERVED} =
853 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
856 return ( \%issuingimpossible, \%needsconfirmation );
861 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
863 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
867 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
869 =item C<$barcode> is the barcode of the item being issued.
871 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
874 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
876 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
877 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
879 AddIssue does the following things :
881 - step 01: check that there is a borrowernumber & a barcode provided
882 - check for RENEWAL (book issued & being issued to the same patron)
883 - renewal YES = Calculate Charge & renew
885 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
887 - fill reserve if reserve to this patron
888 - cancel reserve or not, otherwise
889 * TRANSFERT PENDING ?
890 - complete the transfert
898 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
899 my $dbh = C4::Context->dbh;
900 my $barcodecheck=CheckValidBarcode($barcode);
902 # $issuedate defaults to today.
903 if ( ! defined $issuedate ) {
904 $issuedate = strftime( "%Y-%m-%d", localtime );
905 # TODO: for hourly circ, this will need to be a C4::Dates object
906 # and all calls to AddIssue including issuedate will need to pass a Dates object.
908 if ($borrower and $barcode and $barcodecheck ne '0'){
909 # find which item we issue
910 my $item = GetItem('', $barcode) or return undef; # if we don't get an Item, abort.
911 my $branch = (C4::Context->preference('CircControl') eq 'PickupLibrary') ? C4::Context->userenv->{'branch'} :
912 (C4::Context->preference('CircControl') eq 'PatronLibrary') ? $borrower->{'branchcode'} :
913 $item->{'homebranch'}; # fallback to item's homebranch
915 # get actual issuing if there is one
916 my $actualissue = GetItemIssue( $item->{itemnumber});
918 # get biblioinformation for this item
919 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
922 # check if we just renew the issue.
924 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
925 $datedue = AddRenewal(
926 $borrower->{'borrowernumber'},
927 $item->{'itemnumber'},
930 $issuedate, # here interpreted as the renewal date
935 if ( $actualissue->{borrowernumber}) {
936 # This book is currently on loan, but not to the person
937 # who wants to borrow it now. mark it returned before issuing to the new borrower
940 C4::Context->userenv->{'branch'}
944 # See if the item is on reserve.
945 my ( $restype, $res ) =
946 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
948 my $resbor = $res->{'borrowernumber'};
949 if ( $resbor eq $borrower->{'borrowernumber'} ) {
950 # The item is reserved by the current patron
951 ModReserveFill($res);
953 elsif ( $restype eq "Waiting" ) {
955 # The item is on reserve and waiting, but has been
956 # reserved by some other patron.
958 elsif ( $restype eq "Reserved" ) {
960 # The item is reserved by someone else.
961 if ($cancelreserve) { # cancel reserves on this item
962 CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
965 if ($cancelreserve) {
966 CancelReserve($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
969 # set waiting reserve to first in reserve queue as book isn't waiting now
971 $res->{'biblionumber'},
972 $res->{'borrowernumber'},
978 # Starting process for transfer job (checking transfert and validate it if we have one)
979 my ($datesent) = GetTransfers($item->{'itemnumber'});
981 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
984 "UPDATE branchtransfers
985 SET datearrived = now(),
987 comments = 'Forced branchtransfer'
988 WHERE itemnumber= ? AND datearrived IS NULL"
990 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
993 # Record in the database the fact that the book was issued.
997 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1001 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1002 my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
1003 $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
1007 $borrower->{'borrowernumber'}, # borrowernumber
1008 $item->{'itemnumber'}, # itemnumber
1009 $issuedate, # issuedate
1010 $datedue->output('iso'), # date_due
1011 C4::Context->userenv->{'branch'} # branchcode
1014 $item->{'issues'}++;
1015 ModItem({ issues => $item->{'issues'},
1016 holdingbranch => C4::Context->userenv->{'branch'},
1018 datelastborrowed => C4::Dates->new()->output('iso'),
1019 onloan => $datedue->output('iso'),
1020 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1021 ModDateLastSeen( $item->{'itemnumber'} );
1023 # If it costs to borrow this book, charge it to the patron's account.
1024 my ( $charge, $itemtype ) = GetIssuingCharges(
1025 $item->{'itemnumber'},
1026 $borrower->{'borrowernumber'}
1028 if ( $charge > 0 ) {
1030 $item->{'itemnumber'},
1031 $borrower->{'borrowernumber'}, $charge
1033 $item->{'charge'} = $charge;
1036 # Record the fact that this book was issued.
1038 C4::Context->userenv->{'branch'},
1040 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1041 $item->{'itype'}, $borrower->{'borrowernumber'}
1044 # Send a checkout slip.
1045 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1047 branchcode => $branch,
1048 categorycode => $borrower->{categorycode},
1049 item_type => $item->{itype},
1050 notification => 'CHECKOUT',
1052 if ($circulation_alert->is_enabled_for(\%conditions)) {
1053 SendCirculationAlert({
1056 borrower => $borrower,
1062 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1063 if C4::Context->preference("IssueLog");
1065 return ($datedue); # not necessarily the same as when it came in!
1068 =head2 GetLoanLength
1070 Get loan length for an itemtype, a borrower type and a branch
1072 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1077 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1078 my $dbh = C4::Context->dbh;
1081 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1083 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1084 # try to find issuelength & return the 1st available.
1085 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1086 $sth->execute( $borrowertype, $itemtype, $branchcode );
1087 my $loanlength = $sth->fetchrow_hashref;
1088 return $loanlength->{issuelength}
1089 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1091 $sth->execute( $borrowertype, "*", $branchcode );
1092 $loanlength = $sth->fetchrow_hashref;
1093 return $loanlength->{issuelength}
1094 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1096 $sth->execute( "*", $itemtype, $branchcode );
1097 $loanlength = $sth->fetchrow_hashref;
1098 return $loanlength->{issuelength}
1099 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1101 $sth->execute( "*", "*", $branchcode );
1102 $loanlength = $sth->fetchrow_hashref;
1103 return $loanlength->{issuelength}
1104 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1106 $sth->execute( $borrowertype, $itemtype, "*" );
1107 $loanlength = $sth->fetchrow_hashref;
1108 return $loanlength->{issuelength}
1109 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1111 $sth->execute( $borrowertype, "*", "*" );
1112 $loanlength = $sth->fetchrow_hashref;
1113 return $loanlength->{issuelength}
1114 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1116 $sth->execute( "*", $itemtype, "*" );
1117 $loanlength = $sth->fetchrow_hashref;
1118 return $loanlength->{issuelength}
1119 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1121 $sth->execute( "*", "*", "*" );
1122 $loanlength = $sth->fetchrow_hashref;
1123 return $loanlength->{issuelength}
1124 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1126 # if no rule is set => 21 days (hardcoded)
1130 =head2 GetIssuingRule
1132 FIXME - This is a copy-paste of GetLoanLength
1133 as a stop-gap. Do not wish to change API for GetLoanLength
1134 this close to release, however, Overdues::GetIssuingRules is broken.
1136 Get the issuing rule for an itemtype, a borrower type and a branch
1137 Returns a hashref from the issuingrules table.
1139 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1143 sub GetIssuingRule {
1144 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1145 my $dbh = C4::Context->dbh;
1146 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1149 $sth->execute( $borrowertype, $itemtype, $branchcode );
1150 $irule = $sth->fetchrow_hashref;
1151 return $irule if defined($irule) ;
1153 $sth->execute( $borrowertype, "*", $branchcode );
1154 $irule = $sth->fetchrow_hashref;
1155 return $irule if defined($irule) ;
1157 $sth->execute( "*", $itemtype, $branchcode );
1158 $irule = $sth->fetchrow_hashref;
1159 return $irule if defined($irule) ;
1161 $sth->execute( "*", "*", $branchcode );
1162 $irule = $sth->fetchrow_hashref;
1163 return $irule if defined($irule) ;
1165 $sth->execute( $borrowertype, $itemtype, "*" );
1166 $irule = $sth->fetchrow_hashref;
1167 return $irule if defined($irule) ;
1169 $sth->execute( $borrowertype, "*", "*" );
1170 $irule = $sth->fetchrow_hashref;
1171 return $irule if defined($irule) ;
1173 $sth->execute( "*", $itemtype, "*" );
1174 $irule = $sth->fetchrow_hashref;
1175 return $irule if defined($irule) ;
1177 $sth->execute( "*", "*", "*" );
1178 $irule = $sth->fetchrow_hashref;
1179 return $irule if defined($irule) ;
1181 # if no rule matches,
1185 =head2 GetBranchBorrowerCircRule
1189 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1193 Retrieves circulation rule attributes that apply to the given
1194 branch and patron category, regardless of item type.
1195 The return value is a hashref containing the following key:
1197 maxissueqty - maximum number of loans that a
1198 patron of the given category can have at the given
1199 branch. If the value is undef, no limit.
1201 This will first check for a specific branch and
1202 category match from branch_borrower_circ_rules.
1204 If no rule is found, it will then check default_branch_circ_rules
1205 (same branch, default category). If no rule is found,
1206 it will then check default_borrower_circ_rules (default
1207 branch, same category), then failing that, default_circ_rules
1208 (default branch, default category).
1210 If no rule has been found in the database, it will default to
1215 C<$branchcode> and C<$categorycode> should contain the
1216 literal branch code and patron category code, respectively - no
1221 sub GetBranchBorrowerCircRule {
1222 my $branchcode = shift;
1223 my $categorycode = shift;
1225 my $branch_cat_query = "SELECT maxissueqty
1226 FROM branch_borrower_circ_rules
1227 WHERE branchcode = ?
1228 AND categorycode = ?";
1229 my $dbh = C4::Context->dbh();
1230 my $sth = $dbh->prepare($branch_cat_query);
1231 $sth->execute($branchcode, $categorycode);
1233 if ($result = $sth->fetchrow_hashref()) {
1237 # try same branch, default borrower category
1238 my $branch_query = "SELECT maxissueqty
1239 FROM default_branch_circ_rules
1240 WHERE branchcode = ?";
1241 $sth = $dbh->prepare($branch_query);
1242 $sth->execute($branchcode);
1243 if ($result = $sth->fetchrow_hashref()) {
1247 # try default branch, same borrower category
1248 my $category_query = "SELECT maxissueqty
1249 FROM default_borrower_circ_rules
1250 WHERE categorycode = ?";
1251 $sth = $dbh->prepare($category_query);
1252 $sth->execute($categorycode);
1253 if ($result = $sth->fetchrow_hashref()) {
1257 # try default branch, default borrower category
1258 my $default_query = "SELECT maxissueqty
1259 FROM default_circ_rules";
1260 $sth = $dbh->prepare($default_query);
1262 if ($result = $sth->fetchrow_hashref()) {
1266 # built-in default circulation rule
1268 maxissueqty => undef,
1272 =head2 GetBranchItemRule
1276 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1280 Retrieves circulation rule attributes that apply to the given
1281 branch and item type, regardless of patron category.
1283 The return value is a hashref containing the following key:
1285 holdallowed => Hold policy for this branch and itemtype. Possible values:
1286 0: No holds allowed.
1287 1: Holds allowed only by patrons that have the same homebranch as the item.
1288 2: Holds allowed from any patron.
1290 This searches branchitemrules in the following order:
1292 * Same branchcode and itemtype
1293 * Same branchcode, itemtype '*'
1294 * branchcode '*', same itemtype
1295 * branchcode and itemtype '*'
1297 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1301 sub GetBranchItemRule {
1302 my ( $branchcode, $itemtype ) = @_;
1303 my $dbh = C4::Context->dbh();
1307 ['SELECT holdallowed
1308 FROM branch_item_rules
1309 WHERE branchcode = ?
1310 AND itemtype = ?', $branchcode, $itemtype],
1311 ['SELECT holdallowed
1312 FROM default_branch_circ_rules
1313 WHERE branchcode = ?', $branchcode],
1314 ['SELECT holdallowed
1315 FROM default_branch_item_rules
1316 WHERE itemtype = ?', $itemtype],
1317 ['SELECT holdallowed
1318 FROM default_circ_rules'],
1321 foreach my $attempt (@attempts) {
1322 my ($query, @bind_params) = @{$attempt};
1324 # Since branch/category and branch/itemtype use the same per-branch
1325 # defaults tables, we have to check that the key we want is set, not
1326 # just that a row was returned
1327 return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1330 # built-in default circulation rule
1338 ($doreturn, $messages, $iteminformation, $borrower) =
1339 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1345 =item C<$barcode> is the bar code of the book being returned.
1347 =item C<$branch> is the code of the branch where the book is being returned.
1349 =item C<$exemptfine> indicates that overdue charges for the item will be
1352 =item C<$dropbox> indicates that the check-in date is assumed to be
1353 yesterday, or the last non-holiday as defined in C4::Calendar . If
1354 overdue charges are applied and C<$dropbox> is true, the last charge
1355 will be removed. This assumes that the fines accrual script has run
1360 C<&AddReturn> returns a list of four items:
1362 C<$doreturn> is true iff the return succeeded.
1364 C<$messages> is a reference-to-hash giving feedback on the operation.
1365 The keys of the hash are:
1371 No item with this barcode exists. The value is C<$barcode>.
1375 The book is not currently on loan. The value is C<$barcode>.
1377 =item C<IsPermanent>
1379 The book's home branch is a permanent collection. If you have borrowed
1380 this book, you are not allowed to return it. The value is the code for
1381 the book's home branch.
1385 This book has been withdrawn/cancelled. The value should be ignored.
1387 =item C<Wrongbranch>
1389 This book has was returned to the wrong branch. The value is a hashref
1390 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1391 contain the branchcode of the incorrect and correct return library, respectively.
1395 The item was reserved. The value is a reference-to-hash whose keys are
1396 fields from the reserves table of the Koha database, and
1397 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1398 either C<Waiting>, C<Reserved>, or 0.
1402 C<$iteminformation> is a reference-to-hash, giving information about the
1403 returned item from the issues table.
1405 C<$borrower> is a reference-to-hash, giving information about the
1406 patron who last borrowed the book.
1411 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1412 if ($branch and not GetBranchDetail($branch)) {
1413 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1416 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1421 my $validTransfert = 0;
1423 # get information on item
1424 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1425 unless ($itemnumber) {
1426 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1428 my $issue = GetItemIssue($itemnumber);
1429 # warn Dumper($iteminformation);
1430 if ($issue and $issue->{borrowernumber}) {
1431 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1432 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1433 . Dumper($issue) . "\n";
1435 $messages->{'NotIssued'} = $barcode;
1436 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1438 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1441 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1442 # full item data, but no borrowernumber or checkout info (no issue)
1443 # we know GetItem should work because GetItemnumberFromBarcode worked
1444 my $hbr = $item->{C4::Context->preference("HomeOrHoldingBranch")} || '';
1445 # item must be from items table -- issues table has branchcode and issuingbranch, not homebranch nor holdingbranch
1447 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1449 # check if the book is in a permanent collection....
1450 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1452 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1453 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1456 # if indy branches and returning to different branch, refuse the return
1457 if ($hbr ne $branch && C4::Context->preference("IndependantBranches")){
1458 $messages->{'Wrongbranch'} = {
1459 Wrongbranch => $branch,
1460 Rightbranch => $hbr,
1462 $doreturn = 0; # Could we bail here?
1465 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1466 $messages->{'wthdrawn'} = 1;
1470 # case of a return of document (deal with issues and holdingbranch)
1472 $borrower or warn "AddReturn without current borrower";
1473 my $circControlBranch;
1475 # don't allow dropbox mode to create an invalid entry in issues (issuedate > returndate) FIXME: actually checks eq, not gt
1476 undef($dropbox) if ( $item->{'issuedate'} eq C4::Dates->today('iso') );
1477 if (C4::Context->preference('CircControl') eq 'ItemHomeBranch') {
1478 $circControlBranch = $item->{homebranch};
1479 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
1480 $circControlBranch = $borrower->{branchcode};
1481 } else { # CircControl must be PickupLibrary.
1482 $circControlBranch = $item->{holdingbranch};
1483 # FIXME - is this right ? are we sure that the holdingbranch is still the pickup branch?
1487 if ($borrowernumber) {
1488 MarkIssueReturned($borrowernumber, $item->{'itemnumber'}, $circControlBranch);
1489 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right? This could be the borrower hash.
1492 # the holdingbranch is updated if the document is returned to another location.
1493 if ($item->{'holdingbranch'} ne $branch) {
1494 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1495 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1497 ModDateLastSeen( $item->{'itemnumber'} );
1498 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1501 # check if we have a transfer for this document
1502 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1504 # if we have a transfer to do, we update the line of transfers with the datearrived
1506 if ( $tobranch eq $branch ) {
1507 my $sth = C4::Context->dbh->prepare(
1508 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1510 $sth->execute( $item->{'itemnumber'} );
1511 # if we have a reservation with valid transfer, we can set it's status to 'W'
1512 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1514 $messages->{'WrongTransfer'} = $tobranch;
1515 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1517 $validTransfert = 1;
1520 # fix up the accounts.....
1521 if ($item->{'itemlost'}) {
1522 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1523 $messages->{'WasLost'} = 1;
1526 # fix up the overdues in accounts...
1527 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1528 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1530 # find reserves.....
1531 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1532 my ($resfound, $resrec) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1534 $resrec->{'ResFound'} = $resfound;
1535 $messages->{'ResFound'} = $resrec;
1539 # Record the fact that this book was returned.
1541 $branch, 'return', '0', '',
1542 $item->{'itemnumber'},
1543 $biblio->{'itemtype'},
1547 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1548 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1550 branchcode => $branch,
1551 categorycode => $borrower->{categorycode},
1552 item_type => $item->{itype},
1553 notification => 'CHECKIN',
1555 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1556 SendCirculationAlert({
1559 borrower => $borrower,
1564 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1565 if C4::Context->preference("ReturnLog");
1567 # FIXME: make this comment intelligible.
1568 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1569 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1571 if ($doreturn and ($branch ne $item->{homebranch}) and not ($messages->{WrongTransfer} or $validTransfert or $messages->{ResFound}) ){
1572 if ( C4::Context->preference("AutomaticItemReturn" ) or
1573 (C4::Context->preference("UseBranchTransferLimits") and
1574 ! IsBranchTransferAllowed($branch, $item->{homebranch}, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1576 warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'}, C4::Context->userenv->{'branch'}, $item->{'homebranch'};
1577 warn "item: " . Dumper($item);
1578 ModItemTransfer($item->{'itemnumber'}, C4::Context->userenv->{'branch'}, $item->{'homebranch'});
1579 $messages->{'WasTransfered'} = 1;
1581 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1584 return ( $doreturn, $messages, $item, $borrower );
1587 =head2 MarkIssueReturned
1591 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate);
1595 Unconditionally marks an issue as being returned by
1596 moving the C<issues> row to C<old_issues> and
1597 setting C<returndate> to the current date, or
1598 the last non-holiday date of the branccode specified in
1599 C<dropbox_branch> . Assumes you've already checked that
1600 it's safe to do this, i.e. last non-holiday > issuedate.
1602 if C<$returndate> is specified (in iso format), it is used as the date
1603 of the return. It is ignored when a dropbox_branch is passed in.
1605 Ideally, this function would be internal to C<C4::Circulation>,
1606 not exported, but it is currently needed by one
1607 routine in C<C4::Accounts>.
1611 sub MarkIssueReturned {
1612 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate ) = @_;
1613 my $dbh = C4::Context->dbh;
1614 my $query = "UPDATE issues SET returndate=";
1616 if ($dropbox_branch) {
1617 my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1618 my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1620 push @bind, $dropboxdate->output('iso');
1621 } elsif ($returndate) {
1623 push @bind, $returndate;
1625 $query .= " now() ";
1627 $query .= " WHERE borrowernumber = ? AND itemnumber = ?";
1628 push @bind, $borrowernumber, $itemnumber;
1630 my $sth_upd = $dbh->prepare($query);
1631 $sth_upd->execute(@bind);
1632 my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1633 WHERE borrowernumber = ?
1634 AND itemnumber = ?");
1635 $sth_copy->execute($borrowernumber, $itemnumber);
1636 my $sth_del = $dbh->prepare("DELETE FROM issues
1637 WHERE borrowernumber = ?
1638 AND itemnumber = ?");
1639 $sth_del->execute($borrowernumber, $itemnumber);
1642 =head2 _FixOverduesOnReturn
1644 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1646 C<$brn> borrowernumber
1650 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1651 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1653 Internal function, called only by AddReturn
1657 sub _FixOverduesOnReturn {
1658 my ($borrowernumber, $item);
1659 unless ($borrowernumber = shift) {
1660 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1663 unless ($item = shift) {
1664 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1667 my ($exemptfine, $dropbox) = @_;
1668 my $dbh = C4::Context->dbh;
1670 # check for overdue fine
1671 my $sth = $dbh->prepare(
1672 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1674 $sth->execute( $borrowernumber, $item );
1676 # alter fine to show that the book has been returned
1677 my $data = $sth->fetchrow_hashref;
1678 return 0 unless $data; # no warning, there's just nothing to fix
1681 my @bind = ($borrowernumber, $item, $data->{'accountno'});
1683 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1684 if (C4::Context->preference("FinesLog")) {
1685 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1687 } elsif ($dropbox && $data->{lastincrement}) {
1688 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1689 my $amt = $data->{amount} - $data->{lastincrement} ;
1690 if (C4::Context->preference("FinesLog")) {
1691 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1693 $uquery = "update accountlines set accounttype='F' ";
1694 if($outstanding >= 0 && $amt >=0) {
1695 $uquery .= ", amount = ? , amountoutstanding=? ";
1696 unshift @bind, ($amt, $outstanding) ;
1699 $uquery = "update accountlines set accounttype='F' ";
1701 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1702 my $usth = $dbh->prepare($uquery);
1703 return $usth->execute(@bind);
1706 =head2 _FixAccountForLostAndReturned
1708 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1710 Calculates the charge for a book lost and returned.
1712 Internal function, not exported, called only by AddReturn.
1714 FIXME: This function reflects how inscrutable fines logic is. Fix both.
1715 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
1719 sub FixAccountForLostAndReturned {
1720 my $itemnumber = shift or return;
1721 my $borrowernumber = @_ ? shift : undef;
1722 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
1723 my $dbh = C4::Context->dbh;
1724 # check for charge made for lost book
1725 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1726 $sth->execute($itemnumber);
1727 my $data = $sth->fetchrow_hashref;
1728 $data or return; # bail if there is nothing to do
1730 # writeoff this amount
1732 my $amount = $data->{'amount'};
1733 my $acctno = $data->{'accountno'};
1734 my $amountleft; # Starts off undef/zero.
1735 if ($data->{'amountoutstanding'} == $amount) {
1736 $offset = $data->{'amount'};
1737 $amountleft = 0; # Hey, it's zero here, too.
1739 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
1740 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
1742 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1743 WHERE (borrowernumber = ?)
1744 AND (itemnumber = ?) AND (accountno = ?) ");
1745 $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
1746 #check if any credit is left if so writeoff other accounts
1747 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1748 $amountleft *= -1 if ($amountleft < 0);
1749 if ($amountleft > 0) {
1750 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1751 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
1752 $msth->execute($data->{'borrowernumber'});
1753 # offset transactions
1756 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1757 if ($accdata->{'amountoutstanding'} < $amountleft) {
1759 $amountleft -= $accdata->{'amountoutstanding'};
1761 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1764 my $thisacct = $accdata->{'accountno'};
1765 # FIXME: move prepares outside while loop!
1766 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1767 WHERE (borrowernumber = ?)
1768 AND (accountno=?)");
1769 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct'); # FIXME: '$thisacct' is a string literal!
1770 $usth = $dbh->prepare("INSERT INTO accountoffsets
1771 (borrowernumber, accountno, offsetaccount, offsetamount)
1774 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1776 $msth->finish; # $msth might actually have data left
1778 $amountleft *= -1 if ($amountleft > 0);
1779 my $desc = "Item Returned " . $item_id;
1780 $usth = $dbh->prepare("INSERT INTO accountlines
1781 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1782 VALUES (?,?,now(),?,?,'CR',?)");
1783 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1784 if ($borrowernumber) {
1785 # FIXME: same as query above. use 1 sth for both
1786 $usth = $dbh->prepare("INSERT INTO accountoffsets
1787 (borrowernumber, accountno, offsetaccount, offsetamount)
1789 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
1791 ModItem({ paidfor => '' }, undef, $itemnumber);
1797 $issue = &GetItemIssue($itemnumber);
1799 Returns patron currently having a book, or undef if not checked out.
1801 C<$itemnumber> is the itemnumber.
1803 C<$issue> is a hashref of the row from the issues table.
1808 my ($itemnumber) = @_;
1809 return unless $itemnumber;
1810 my $sth = C4::Context->dbh->prepare(
1813 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1814 WHERE issues.itemnumber=?");
1815 $sth->execute($itemnumber);
1816 my $data = $sth->fetchrow_hashref;
1817 return unless $data;
1818 $data->{'overdue'} = ($data->{'date_due'} lt C4::Dates->today('iso')) ? 1 : 0;
1824 $issue = GetOpenIssue( $itemnumber );
1826 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1828 C<$itemnumber> is the item's itemnumber
1835 my ( $itemnumber ) = @_;
1837 my $dbh = C4::Context->dbh;
1838 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1839 $sth->execute( $itemnumber );
1840 my $issue = $sth->fetchrow_hashref();
1844 =head2 GetItemIssues
1846 $issues = &GetItemIssues($itemnumber, $history);
1848 Returns patrons that have issued a book
1850 C<$itemnumber> is the itemnumber
1851 C<$history> is false if you just want the current "issuer" (if any)
1852 and true if you want issues history from old_issues also.
1854 Returns reference to an array of hashes
1859 my ( $itemnumber, $history ) = @_;
1861 my $today = C4::Dates->today('iso'); # get today date
1862 my $sql = "SELECT * FROM issues
1863 JOIN borrowers USING (borrowernumber)
1864 JOIN items USING (itemnumber)
1865 WHERE issues.itemnumber = ? ";
1868 SELECT * FROM old_issues
1869 LEFT JOIN borrowers USING (borrowernumber)
1870 JOIN items USING (itemnumber)
1871 WHERE old_issues.itemnumber = ? ";
1873 $sql .= "ORDER BY date_due DESC";
1874 my $sth = C4::Context->dbh->prepare($sql);
1876 $sth->execute($itemnumber, $itemnumber);
1878 $sth->execute($itemnumber);
1880 my $results = $sth->fetchall_arrayref({});
1881 foreach (@$results) {
1882 $_->{'overdue'} = ($_->{'date_due'} lt $today) ? 1 : 0;
1887 =head2 GetBiblioIssues
1889 $issues = GetBiblioIssues($biblionumber);
1891 this function get all issues from a biblionumber.
1894 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1895 tables issues and the firstname,surname & cardnumber from borrowers.
1899 sub GetBiblioIssues {
1900 my $biblionumber = shift;
1901 return undef unless $biblionumber;
1902 my $dbh = C4::Context->dbh;
1904 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1906 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1907 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1908 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1909 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1910 WHERE biblio.biblionumber = ?
1912 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1914 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1915 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1916 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1917 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1918 WHERE biblio.biblionumber = ?
1921 my $sth = $dbh->prepare($query);
1922 $sth->execute($biblionumber, $biblionumber);
1925 while ( my $data = $sth->fetchrow_hashref ) {
1926 push @issues, $data;
1931 =head2 GetUpcomingDueIssues
1935 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
1941 sub GetUpcomingDueIssues {
1944 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
1945 my $dbh = C4::Context->dbh;
1947 my $statement = <<END_SQL;
1948 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
1950 LEFT JOIN items USING (itemnumber)
1951 WhERE returndate is NULL
1952 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
1955 my @bind_parameters = ( $params->{'days_in_advance'} );
1957 my $sth = $dbh->prepare( $statement );
1958 $sth->execute( @bind_parameters );
1959 my $upcoming_dues = $sth->fetchall_arrayref({});
1962 return $upcoming_dues;
1965 =head2 CanBookBeRenewed
1967 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
1969 Find out whether a borrowed item may be renewed.
1971 C<$dbh> is a DBI handle to the Koha database.
1973 C<$borrowernumber> is the borrower number of the patron who currently
1974 has the item on loan.
1976 C<$itemnumber> is the number of the item to renew.
1978 C<$override_limit>, if supplied with a true value, causes
1979 the limit on the number of times that the loan can be renewed
1980 (as controlled by the item type) to be ignored.
1982 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
1983 item must currently be on loan to the specified borrower; renewals
1984 must be allowed for the item's type; and the borrower must not have
1985 already renewed the loan. $error will contain the reason the renewal can not proceed
1989 sub CanBookBeRenewed {
1991 # check renewal status
1992 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
1993 my $dbh = C4::Context->dbh;
1998 # Look in the issues table for this item, lent to this borrower,
1999 # and not yet returned.
2001 # FIXME - I think this function could be redone to use only one SQL call.
2002 my $sth1 = $dbh->prepare(
2003 "SELECT * FROM issues
2004 WHERE borrowernumber = ?
2007 $sth1->execute( $borrowernumber, $itemnumber );
2008 if ( my $data1 = $sth1->fetchrow_hashref ) {
2010 # Found a matching item
2012 # See if this item may be renewed. This query is convoluted
2013 # because it's a bit messy: given the item number, we need to find
2014 # the biblioitem, which gives us the itemtype, which tells us
2015 # whether it may be renewed.
2016 my $query = "SELECT renewalsallowed FROM items ";
2017 $query .= (C4::Context->preference('item-level_itypes'))
2018 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2019 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2020 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2021 $query .= "WHERE items.itemnumber = ?";
2022 my $sth2 = $dbh->prepare($query);
2023 $sth2->execute($itemnumber);
2024 if ( my $data2 = $sth2->fetchrow_hashref ) {
2025 $renews = $data2->{'renewalsallowed'};
2027 if ( ( $renews && $renews > $data1->{'renewals'} ) || $override_limit ) {
2034 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2042 return ($renewokay,$error);
2047 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2051 C<$borrowernumber> is the borrower number of the patron who currently
2054 C<$itemnumber> is the number of the item to renew.
2056 C<$branch> is the library where the renewal took place (if any).
2057 The library that controls the circ policies for the renewal is retrieved from the issues record.
2059 C<$datedue> can be a C4::Dates object used to set the due date.
2061 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2062 this parameter is not supplied, lastreneweddate is set to the current date.
2064 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2065 from the book's item type.
2070 my $borrowernumber = shift or return undef;
2071 my $itemnumber = shift or return undef;
2073 my $datedue = shift;
2074 my $lastreneweddate = shift || C4::Dates->new()->output('iso');
2075 my $item = GetItem($itemnumber) or return undef;
2076 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2078 my $dbh = C4::Context->dbh;
2079 # Find the issues record for this book
2081 $dbh->prepare("SELECT * FROM issues
2082 WHERE borrowernumber=?
2085 $sth->execute( $borrowernumber, $itemnumber );
2086 my $issuedata = $sth->fetchrow_hashref;
2088 if($datedue && ! $datedue->output('iso')){
2089 warn "Invalid date passed to AddRenewal.";
2092 # If the due date wasn't specified, calculate it by adding the
2093 # book's loan length to today's date or the current due date
2094 # based on the value of the RenewalPeriodBase syspref.
2097 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2098 my $loanlength = GetLoanLength(
2099 $borrower->{'categorycode'},
2100 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2101 $issuedata->{'branchcode'} ); # that's the circ control branch.
2103 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2104 C4::Dates->new($issuedata->{date_due}, 'iso') :
2106 $datedue = CalcDateDue($datedue,$loanlength,$issuedata->{'branchcode'},$borrower);
2109 # Update the issues record to have the new due date, and a new count
2110 # of how many times it has been renewed.
2111 my $renews = $issuedata->{'renewals'} + 1;
2112 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2113 WHERE borrowernumber=?
2116 $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2119 # Update the renewal count on the item, and tell zebra to reindex
2120 $renews = $biblio->{'renewals'} + 1;
2121 ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2123 # Charge a new rental fee, if applicable?
2124 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2125 if ( $charge > 0 ) {
2126 my $accountno = getnextacctno( $borrowernumber );
2127 my $item = GetBiblioFromItemNumber($itemnumber);
2128 $sth = $dbh->prepare(
2129 "INSERT INTO accountlines
2131 borrowernumber, accountno, amount,
2133 accounttype, amountoutstanding, itemnumber
2135 VALUES (now(),?,?,?,?,?,?,?)"
2137 $sth->execute( $borrowernumber, $accountno, $charge,
2138 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2139 'Rent', $charge, $itemnumber );
2143 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2148 # check renewal status
2149 my ($bornum,$itemno)=@_;
2150 my $dbh = C4::Context->dbh;
2152 my $renewsallowed = 0;
2154 # Look in the issues table for this item, lent to this borrower,
2155 # and not yet returned.
2157 # FIXME - I think this function could be redone to use only one SQL call.
2158 my $sth = $dbh->prepare("select * from issues
2159 where (borrowernumber = ?)
2160 and (itemnumber = ?)");
2161 $sth->execute($bornum,$itemno);
2162 my $data = $sth->fetchrow_hashref;
2163 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2165 my $query = "SELECT renewalsallowed FROM items ";
2166 $query .= (C4::Context->preference('item-level_itypes'))
2167 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2168 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2169 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2170 $query .= "WHERE items.itemnumber = ?";
2171 my $sth2 = $dbh->prepare($query);
2172 $sth2->execute($itemno);
2173 my $data2 = $sth2->fetchrow_hashref();
2174 $renewsallowed = $data2->{'renewalsallowed'};
2175 $renewsleft = $renewsallowed - $renewcount;
2176 return ($renewcount,$renewsallowed,$renewsleft);
2179 =head2 GetIssuingCharges
2181 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2183 Calculate how much it would cost for a given patron to borrow a given
2184 item, including any applicable discounts.
2186 C<$itemnumber> is the item number of item the patron wishes to borrow.
2188 C<$borrowernumber> is the patron's borrower number.
2190 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2191 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2196 sub GetIssuingCharges {
2198 # calculate charges due
2199 my ( $itemnumber, $borrowernumber ) = @_;
2201 my $dbh = C4::Context->dbh;
2204 # Get the book's item type and rental charge (via its biblioitem).
2205 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
2206 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2207 $qcharge .= (C4::Context->preference('item-level_itypes'))
2208 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2209 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2211 $qcharge .= "WHERE items.itemnumber =?";
2213 my $sth1 = $dbh->prepare($qcharge);
2214 $sth1->execute($itemnumber);
2215 if ( my $data1 = $sth1->fetchrow_hashref ) {
2216 $item_type = $data1->{'itemtype'};
2217 $charge = $data1->{'rentalcharge'};
2218 my $q2 = "SELECT rentaldiscount FROM borrowers
2219 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2220 WHERE borrowers.borrowernumber = ?
2221 AND issuingrules.itemtype = ?";
2222 my $sth2 = $dbh->prepare($q2);
2223 $sth2->execute( $borrowernumber, $item_type );
2224 if ( my $data2 = $sth2->fetchrow_hashref ) {
2225 my $discount = $data2->{'rentaldiscount'};
2226 if ( $discount eq 'NULL' ) {
2229 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2235 return ( $charge, $item_type );
2238 =head2 AddIssuingCharge
2240 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2244 sub AddIssuingCharge {
2245 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2246 my $dbh = C4::Context->dbh;
2247 my $nextaccntno = getnextacctno( $borrowernumber );
2249 INSERT INTO accountlines
2250 (borrowernumber, itemnumber, accountno,
2251 date, amount, description, accounttype,
2253 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2255 my $sth = $dbh->prepare($query);
2256 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2262 GetTransfers($itemnumber);
2267 my ($itemnumber) = @_;
2269 my $dbh = C4::Context->dbh;
2275 FROM branchtransfers
2276 WHERE itemnumber = ?
2277 AND datearrived IS NULL
2279 my $sth = $dbh->prepare($query);
2280 $sth->execute($itemnumber);
2281 my @row = $sth->fetchrow_array();
2286 =head2 GetTransfersFromTo
2288 @results = GetTransfersFromTo($frombranch,$tobranch);
2290 Returns the list of pending transfers between $from and $to branch
2294 sub GetTransfersFromTo {
2295 my ( $frombranch, $tobranch ) = @_;
2296 return unless ( $frombranch && $tobranch );
2297 my $dbh = C4::Context->dbh;
2299 SELECT itemnumber,datesent,frombranch
2300 FROM branchtransfers
2303 AND datearrived IS NULL
2305 my $sth = $dbh->prepare($query);
2306 $sth->execute( $frombranch, $tobranch );
2309 while ( my $data = $sth->fetchrow_hashref ) {
2310 push @gettransfers, $data;
2313 return (@gettransfers);
2316 =head2 DeleteTransfer
2318 &DeleteTransfer($itemnumber);
2322 sub DeleteTransfer {
2323 my ($itemnumber) = @_;
2324 my $dbh = C4::Context->dbh;
2325 my $sth = $dbh->prepare(
2326 "DELETE FROM branchtransfers
2328 AND datearrived IS NULL "
2330 $sth->execute($itemnumber);
2334 =head2 AnonymiseIssueHistory
2336 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2338 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2339 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2341 return the number of affected rows.
2345 sub AnonymiseIssueHistory {
2347 my $borrowernumber = shift;
2348 my $dbh = C4::Context->dbh;
2351 SET borrowernumber = NULL
2352 WHERE returndate < '".$date."'
2353 AND borrowernumber IS NOT NULL
2355 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2356 my $rows_affected = $dbh->do($query);
2357 return $rows_affected;
2360 =head2 SendCirculationAlert
2362 Send out a C<check-in> or C<checkout> alert using the messaging system.
2370 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2374 Hashref of information about the item being checked in or out.
2378 Hashref of information about the borrower of the item.
2382 The branchcode from where the checkout or check-in took place.
2388 SendCirculationAlert({
2391 borrower => $borrower,
2397 sub SendCirculationAlert {
2399 my ($type, $item, $borrower, $branch) =
2400 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2401 my %message_name = (
2402 CHECKIN => 'Item Check-in',
2403 CHECKOUT => 'Item Checkout',
2405 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2406 borrowernumber => $borrower->{borrowernumber},
2407 message_name => $message_name{$type},
2409 my $letter = C4::Letters::getletter('circulation', $type);
2410 C4::Letters::parseletter($letter, 'biblio', $item->{biblionumber});
2411 C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2412 C4::Letters::parseletter($letter, 'borrowers', $borrower->{borrowernumber});
2413 C4::Letters::parseletter($letter, 'branches', $branch);
2414 my @transports = @{ $borrower_preferences->{transports} };
2415 # warn "no transports" unless @transports;
2417 # warn "transport: $_";
2418 my $message = C4::Message->find_last_message($borrower, $type, $_);
2420 #warn "create new message";
2421 C4::Message->enqueue($letter, $borrower, $_);
2423 #warn "append to old message";
2424 $message->append($letter);
2431 =head2 updateWrongTransfer
2433 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2435 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
2439 sub updateWrongTransfer {
2440 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2441 my $dbh = C4::Context->dbh;
2442 # first step validate the actual line of transfert .
2445 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2447 $sth->execute($FromLibrary,$itemNumber);
2450 # second step create a new line of branchtransfer to the right location .
2451 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2453 #third step changing holdingbranch of item
2454 UpdateHoldingbranch($FromLibrary,$itemNumber);
2457 =head2 UpdateHoldingbranch
2459 $items = UpdateHoldingbranch($branch,$itmenumber);
2460 Simple methode for updating hodlingbranch in items BDD line
2464 sub UpdateHoldingbranch {
2465 my ( $branch,$itemnumber ) = @_;
2466 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2471 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2472 this function calculates the due date given the loan length ,
2473 checking against the holidays calendar as per the 'useDaysMode' syspref.
2474 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2475 C<$branch> = location whose calendar to use
2476 C<$loanlength> = loan length prior to adjustment
2480 my ($startdate,$loanlength,$branch,$borrower) = @_;
2483 if(C4::Context->preference('useDaysMode') eq 'Days') { # ignoring calendar
2484 my $timedue = time + ($loanlength) * 86400;
2485 #FIXME - assumes now even though we take a startdate
2486 my @datearr = localtime($timedue);
2487 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2489 my $calendar = C4::Calendar->new( branchcode => $branch );
2490 $datedue = $calendar->addDate($startdate, $loanlength);
2493 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2494 if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2495 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2498 # if ceilingDueDate ON the datedue can't be after the ceiling date
2499 if ( C4::Context->preference('ceilingDueDate')
2500 && ( C4::Context->preference('ceilingDueDate') =~ C4::Dates->regexp('syspref') )
2501 && $datedue->output gt C4::Context->preference('ceilingDueDate') ) {
2502 $datedue = C4::Dates->new( C4::Context->preference('ceilingDueDate') );
2508 =head2 CheckValidDatedue
2509 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2510 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2512 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2513 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2514 C<$date_due> = returndate calculate with no day check
2515 C<$itemnumber> = itemnumber
2516 C<$branchcode> = location of issue (affected by 'CircControl' syspref)
2517 C<$loanlength> = loan length prior to adjustment
2520 sub CheckValidDatedue {
2521 my ($date_due,$itemnumber,$branchcode)=@_;
2522 my @datedue=split('-',$date_due->output('iso'));
2523 my $years=$datedue[0];
2524 my $month=$datedue[1];
2525 my $day=$datedue[2];
2526 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2528 for (my $i=0;$i<2;$i++){
2529 $dow=Day_of_Week($years,$month,$day);
2530 ($dow=0) if ($dow>6);
2531 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2532 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2533 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2534 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2536 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2539 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2544 =head2 CheckRepeatableHolidays
2546 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2547 this function checks if the date due is a repeatable holiday
2548 C<$date_due> = returndate calculate with no day check
2549 C<$itemnumber> = itemnumber
2550 C<$branchcode> = localisation of issue
2554 sub CheckRepeatableHolidays{
2555 my($itemnumber,$week_day,$branchcode)=@_;
2556 my $dbh = C4::Context->dbh;
2557 my $query = qq|SELECT count(*)
2558 FROM repeatable_holidays
2561 my $sth = $dbh->prepare($query);
2562 $sth->execute($branchcode,$week_day);
2563 my $result=$sth->fetchrow;
2569 =head2 CheckSpecialHolidays
2571 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2572 this function check if the date is a special holiday
2573 C<$years> = the years of datedue
2574 C<$month> = the month of datedue
2575 C<$day> = the day of datedue
2576 C<$itemnumber> = itemnumber
2577 C<$branchcode> = localisation of issue
2581 sub CheckSpecialHolidays{
2582 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2583 my $dbh = C4::Context->dbh;
2584 my $query=qq|SELECT count(*)
2585 FROM `special_holidays`
2591 my $sth = $dbh->prepare($query);
2592 $sth->execute($years,$month,$day,$branchcode);
2593 my $countspecial=$sth->fetchrow ;
2595 return $countspecial;
2598 =head2 CheckRepeatableSpecialHolidays
2600 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2601 this function check if the date is a repeatble special holidays
2602 C<$month> = the month of datedue
2603 C<$day> = the day of datedue
2604 C<$itemnumber> = itemnumber
2605 C<$branchcode> = localisation of issue
2609 sub CheckRepeatableSpecialHolidays{
2610 my ($month,$day,$itemnumber,$branchcode) = @_;
2611 my $dbh = C4::Context->dbh;
2612 my $query=qq|SELECT count(*)
2613 FROM `repeatable_holidays`
2618 my $sth = $dbh->prepare($query);
2619 $sth->execute($month,$day,$branchcode);
2620 my $countspecial=$sth->fetchrow ;
2622 return $countspecial;
2627 sub CheckValidBarcode{
2629 my $dbh = C4::Context->dbh;
2630 my $query=qq|SELECT count(*)
2634 my $sth = $dbh->prepare($query);
2635 $sth->execute($barcode);
2636 my $exist=$sth->fetchrow ;
2641 =head2 IsBranchTransferAllowed
2643 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2645 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2649 sub IsBranchTransferAllowed {
2650 my ( $toBranch, $fromBranch, $code ) = @_;
2652 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2654 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2655 my $dbh = C4::Context->dbh;
2657 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2658 $sth->execute( $toBranch, $fromBranch, $code );
2659 my $limit = $sth->fetchrow_hashref();
2661 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2662 if ( $limit->{'limitId'} ) {
2669 =head2 CreateBranchTransferLimit
2671 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2673 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2677 sub CreateBranchTransferLimit {
2678 my ( $toBranch, $fromBranch, $code ) = @_;
2680 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2682 my $dbh = C4::Context->dbh;
2684 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2685 $sth->execute( $code, $toBranch, $fromBranch );
2688 =head2 DeleteBranchTransferLimits
2690 DeleteBranchTransferLimits();
2694 sub DeleteBranchTransferLimits {
2695 my $dbh = C4::Context->dbh;
2696 my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2707 Koha Developement team <info@koha.org>