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;
673 # DUE DATE is OK ? -- should already have checked.
675 unless ( $duedate ) {
676 my $issuedate = strftime( "%Y-%m-%d", localtime );
677 my $branch = (C4::Context->preference('CircControl') eq 'PickupLibrary') ? C4::Context->userenv->{'branch'} :
678 (C4::Context->preference('CircControl') eq 'PatronLibrary') ? $borrower->{'branchcode'} :
679 $item->{'homebranch'}; # fallback to item's homebranch
680 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
681 my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
682 $duedate = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
684 # Offline circ calls AddIssue directly, doesn't run through here
685 # So issuingimpossible should be ok.
687 $issuingimpossible{INVALID_DATE} = $duedate->output('syspref') unless ( $duedate && $duedate->output('iso') ge C4::Dates->today('iso') );
692 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
693 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
694 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'});
695 return( { STATS => 1 }, {});
697 if ( $borrower->{flags}->{GNA} ) {
698 $issuingimpossible{GNA} = 1;
700 if ( $borrower->{flags}->{'LOST'} ) {
701 $issuingimpossible{CARD_LOST} = 1;
703 if ( $borrower->{flags}->{'DBARRED'} ) {
704 $issuingimpossible{DEBARRED} = 1;
706 if ( $borrower->{'dateexpiry'} eq '0000-00-00') {
707 $issuingimpossible{EXPIRED} = 1;
709 my @expirydate= split /-/,$borrower->{'dateexpiry'};
710 if($expirydate[0]==0 || $expirydate[1]==0|| $expirydate[2]==0 ||
711 Date_to_Days(Today) > Date_to_Days( @expirydate )) {
712 $issuingimpossible{EXPIRED} = 1;
721 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->output('iso') );
722 if ( C4::Context->preference("IssuingInProcess") ) {
723 my $amountlimit = C4::Context->preference("noissuescharge");
724 if ( $amount > $amountlimit && !$inprocess ) {
725 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
727 elsif ( $amount > 0 && $amount <= $amountlimit && !$inprocess ) {
728 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
733 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
738 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
740 my $toomany = TooMany( $borrower, $item->{biblionumber}, $item );
741 # if TooMany return / 0, then the user has no permission to check out this book
742 if ($toomany =~ /\/ 0/) {
743 $needsconfirmation{PATRON_CANT} = 1;
745 $needsconfirmation{TOO_MANY} = $toomany if $toomany;
751 unless ( $item->{barcode} ) {
752 $issuingimpossible{UNKNOWN_BARCODE} = 1;
755 if ( $item->{'notforloan'}
756 && $item->{'notforloan'} > 0 )
758 if(!C4::Context->preference("AllowNotForLoanOverride")){
759 $issuingimpossible{NOT_FOR_LOAN} = 1;
761 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
764 elsif ( !$item->{'notforloan'} ){
765 # we have to check itemtypes.notforloan also
766 if (C4::Context->preference('item-level_itypes')){
767 # this should probably be a subroutine
768 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
769 $sth->execute($item->{'itemtype'});
770 my $notforloan=$sth->fetchrow_hashref();
772 if ($notforloan->{'notforloan'} == 1){
773 $issuingimpossible{NOT_FOR_LOAN} = 1;
776 elsif ($biblioitem->{'notforloan'} == 1){
777 $issuingimpossible{NOT_FOR_LOAN} = 1;
780 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} == 1 )
782 $issuingimpossible{WTHDRAWN} = 1;
784 if ( $item->{'restricted'}
785 && $item->{'restricted'} == 1 )
787 $issuingimpossible{RESTRICTED} = 1;
789 if ( C4::Context->preference("IndependantBranches") ) {
790 my $userenv = C4::Context->userenv;
791 if ( ($userenv) && ( $userenv->{flags} != 1 ) ) {
792 $issuingimpossible{NOTSAMEBRANCH} = 1
793 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
798 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
800 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
803 # Already issued to current borrower. Ask whether the loan should
805 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
806 $borrower->{'borrowernumber'},
807 $item->{'itemnumber'}
809 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
810 $issuingimpossible{NO_MORE_RENEWALS} = 1;
813 $needsconfirmation{RENEW_ISSUE} = 1;
816 elsif ($issue->{borrowernumber}) {
818 # issued to someone else
819 my $currborinfo = C4::Members::GetMemberDetails( $issue->{borrowernumber} );
821 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
822 $needsconfirmation{ISSUED_TO_ANOTHER} =
823 "$currborinfo->{'reservedate'} : $currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
826 # See if the item is on reserve.
827 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
829 my $resbor = $res->{'borrowernumber'};
830 my ( $resborrower ) = C4::Members::GetMemberDetails( $resbor, 0 );
831 my $branches = GetBranches();
832 my $branchname = $branches->{ $res->{'branchcode'} }->{'branchname'};
833 if ( $resbor ne $borrower->{'borrowernumber'} && $restype eq "Waiting" )
835 # The item is on reserve and waiting, but has been
836 # reserved by some other patron.
837 $needsconfirmation{RESERVE_WAITING} =
838 "$resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'}, $branchname)";
840 elsif ( $restype eq "Reserved" ) {
841 # The item is on reserve for someone else.
842 $needsconfirmation{RESERVED} =
843 "$res->{'reservedate'} : $resborrower->{'firstname'} $resborrower->{'surname'} ($resborrower->{'cardnumber'})";
846 if ( C4::Context->preference("LibraryName") eq "Horowhenua Library Trust" ) {
847 if ( $borrower->{'categorycode'} eq 'W' ) {
849 return ( \%emptyhash, \%needsconfirmation );
852 return ( \%issuingimpossible, \%needsconfirmation );
857 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
859 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
863 =item C<$borrower> is a hash with borrower informations (from GetMemberDetails).
865 =item C<$barcode> is the barcode of the item being issued.
867 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
870 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
872 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
873 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
875 AddIssue does the following things :
877 - step 01: check that there is a borrowernumber & a barcode provided
878 - check for RENEWAL (book issued & being issued to the same patron)
879 - renewal YES = Calculate Charge & renew
881 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
883 - fill reserve if reserve to this patron
884 - cancel reserve or not, otherwise
885 * TRANSFERT PENDING ?
886 - complete the transfert
894 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
895 my $dbh = C4::Context->dbh;
896 my $barcodecheck=CheckValidBarcode($barcode);
898 # $issuedate defaults to today.
899 if ( ! defined $issuedate ) {
900 $issuedate = strftime( "%Y-%m-%d", localtime );
901 # TODO: for hourly circ, this will need to be a C4::Dates object
902 # and all calls to AddIssue including issuedate will need to pass a Dates object.
904 if ($borrower and $barcode and $barcodecheck ne '0'){
905 # find which item we issue
906 my $item = GetItem('', $barcode) or return undef; # if we don't get an Item, abort.
907 my $branch = (C4::Context->preference('CircControl') eq 'PickupLibrary') ? C4::Context->userenv->{'branch'} :
908 (C4::Context->preference('CircControl') eq 'PatronLibrary') ? $borrower->{'branchcode'} :
909 $item->{'homebranch'}; # fallback to item's homebranch
911 # get actual issuing if there is one
912 my $actualissue = GetItemIssue( $item->{itemnumber});
914 # get biblioinformation for this item
915 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
918 # check if we just renew the issue.
920 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
921 $datedue = AddRenewal(
922 $borrower->{'borrowernumber'},
923 $item->{'itemnumber'},
926 $issuedate, # here interpreted as the renewal date
931 if ( $actualissue->{borrowernumber}) {
932 # This book is currently on loan, but not to the person
933 # who wants to borrow it now. mark it returned before issuing to the new borrower
936 C4::Context->userenv->{'branch'}
940 # See if the item is on reserve.
941 my ( $restype, $res ) =
942 C4::Reserves::CheckReserves( $item->{'itemnumber'} );
944 my $resbor = $res->{'borrowernumber'};
945 if ( $resbor eq $borrower->{'borrowernumber'} ) {
946 # The item is reserved by the current patron
947 ModReserveFill($res);
949 elsif ( $restype eq "Waiting" ) {
951 # The item is on reserve and waiting, but has been
952 # reserved by some other patron.
954 elsif ( $restype eq "Reserved" ) {
956 # The item is reserved by someone else.
957 if ($cancelreserve) { # cancel reserves on this item
958 CancelReserve(0, $res->{'itemnumber'}, $res->{'borrowernumber'});
961 if ($cancelreserve) {
962 CancelReserve($res->{'biblionumber'}, 0, $res->{'borrowernumber'});
965 # set waiting reserve to first in reserve queue as book isn't waiting now
967 $res->{'biblionumber'},
968 $res->{'borrowernumber'},
974 # Starting process for transfer job (checking transfert and validate it if we have one)
975 my ($datesent) = GetTransfers($item->{'itemnumber'});
977 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
980 "UPDATE branchtransfers
981 SET datearrived = now(),
983 comments = 'Forced branchtransfer'
984 WHERE itemnumber= ? AND datearrived IS NULL"
986 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
989 # Record in the database the fact that the book was issued.
993 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
997 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
998 my $loanlength = GetLoanLength( $borrower->{'categorycode'}, $itype, $branch );
999 $datedue = CalcDateDue( C4::Dates->new( $issuedate, 'iso' ), $loanlength, $branch, $borrower );
1003 $borrower->{'borrowernumber'}, # borrowernumber
1004 $item->{'itemnumber'}, # itemnumber
1005 $issuedate, # issuedate
1006 $datedue->output('iso'), # date_due
1007 C4::Context->userenv->{'branch'} # branchcode
1010 $item->{'issues'}++;
1011 ModItem({ issues => $item->{'issues'},
1012 holdingbranch => C4::Context->userenv->{'branch'},
1014 datelastborrowed => C4::Dates->new()->output('iso'),
1015 onloan => $datedue->output('iso'),
1016 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1017 ModDateLastSeen( $item->{'itemnumber'} );
1019 # If it costs to borrow this book, charge it to the patron's account.
1020 my ( $charge, $itemtype ) = GetIssuingCharges(
1021 $item->{'itemnumber'},
1022 $borrower->{'borrowernumber'}
1024 if ( $charge > 0 ) {
1026 $item->{'itemnumber'},
1027 $borrower->{'borrowernumber'}, $charge
1029 $item->{'charge'} = $charge;
1032 # Record the fact that this book was issued.
1034 C4::Context->userenv->{'branch'},
1036 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1037 $item->{'itype'}, $borrower->{'borrowernumber'}
1040 # Send a checkout slip.
1041 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1043 branchcode => $branch,
1044 categorycode => $borrower->{categorycode},
1045 item_type => $item->{itype},
1046 notification => 'CHECKOUT',
1048 if ($circulation_alert->is_enabled_for(\%conditions)) {
1049 SendCirculationAlert({
1052 borrower => $borrower,
1058 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1059 if C4::Context->preference("IssueLog");
1061 return ($datedue); # not necessarily the same as when it came in!
1064 =head2 GetLoanLength
1066 Get loan length for an itemtype, a borrower type and a branch
1068 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1073 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1074 my $dbh = C4::Context->dbh;
1077 "select issuelength from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null"
1079 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1080 # try to find issuelength & return the 1st available.
1081 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1082 $sth->execute( $borrowertype, $itemtype, $branchcode );
1083 my $loanlength = $sth->fetchrow_hashref;
1084 return $loanlength->{issuelength}
1085 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1087 $sth->execute( $borrowertype, "*", $branchcode );
1088 $loanlength = $sth->fetchrow_hashref;
1089 return $loanlength->{issuelength}
1090 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1092 $sth->execute( "*", $itemtype, $branchcode );
1093 $loanlength = $sth->fetchrow_hashref;
1094 return $loanlength->{issuelength}
1095 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1097 $sth->execute( "*", "*", $branchcode );
1098 $loanlength = $sth->fetchrow_hashref;
1099 return $loanlength->{issuelength}
1100 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1102 $sth->execute( $borrowertype, $itemtype, "*" );
1103 $loanlength = $sth->fetchrow_hashref;
1104 return $loanlength->{issuelength}
1105 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1107 $sth->execute( $borrowertype, "*", "*" );
1108 $loanlength = $sth->fetchrow_hashref;
1109 return $loanlength->{issuelength}
1110 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1112 $sth->execute( "*", $itemtype, "*" );
1113 $loanlength = $sth->fetchrow_hashref;
1114 return $loanlength->{issuelength}
1115 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1117 $sth->execute( "*", "*", "*" );
1118 $loanlength = $sth->fetchrow_hashref;
1119 return $loanlength->{issuelength}
1120 if defined($loanlength) && $loanlength->{issuelength} ne 'NULL';
1122 # if no rule is set => 21 days (hardcoded)
1126 =head2 GetIssuingRule
1128 FIXME - This is a copy-paste of GetLoanLength
1129 as a stop-gap. Do not wish to change API for GetLoanLength
1130 this close to release, however, Overdues::GetIssuingRules is broken.
1132 Get the issuing rule for an itemtype, a borrower type and a branch
1133 Returns a hashref from the issuingrules table.
1135 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1139 sub GetIssuingRule {
1140 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1141 my $dbh = C4::Context->dbh;
1142 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1145 $sth->execute( $borrowertype, $itemtype, $branchcode );
1146 $irule = $sth->fetchrow_hashref;
1147 return $irule if defined($irule) ;
1149 $sth->execute( $borrowertype, "*", $branchcode );
1150 $irule = $sth->fetchrow_hashref;
1151 return $irule if defined($irule) ;
1153 $sth->execute( "*", $itemtype, $branchcode );
1154 $irule = $sth->fetchrow_hashref;
1155 return $irule if defined($irule) ;
1157 $sth->execute( "*", "*", $branchcode );
1158 $irule = $sth->fetchrow_hashref;
1159 return $irule if defined($irule) ;
1161 $sth->execute( $borrowertype, $itemtype, "*" );
1162 $irule = $sth->fetchrow_hashref;
1163 return $irule if defined($irule) ;
1165 $sth->execute( $borrowertype, "*", "*" );
1166 $irule = $sth->fetchrow_hashref;
1167 return $irule if defined($irule) ;
1169 $sth->execute( "*", $itemtype, "*" );
1170 $irule = $sth->fetchrow_hashref;
1171 return $irule if defined($irule) ;
1173 $sth->execute( "*", "*", "*" );
1174 $irule = $sth->fetchrow_hashref;
1175 return $irule if defined($irule) ;
1177 # if no rule matches,
1181 =head2 GetBranchBorrowerCircRule
1185 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1189 Retrieves circulation rule attributes that apply to the given
1190 branch and patron category, regardless of item type.
1191 The return value is a hashref containing the following key:
1193 maxissueqty - maximum number of loans that a
1194 patron of the given category can have at the given
1195 branch. If the value is undef, no limit.
1197 This will first check for a specific branch and
1198 category match from branch_borrower_circ_rules.
1200 If no rule is found, it will then check default_branch_circ_rules
1201 (same branch, default category). If no rule is found,
1202 it will then check default_borrower_circ_rules (default
1203 branch, same category), then failing that, default_circ_rules
1204 (default branch, default category).
1206 If no rule has been found in the database, it will default to
1211 C<$branchcode> and C<$categorycode> should contain the
1212 literal branch code and patron category code, respectively - no
1217 sub GetBranchBorrowerCircRule {
1218 my $branchcode = shift;
1219 my $categorycode = shift;
1221 my $branch_cat_query = "SELECT maxissueqty
1222 FROM branch_borrower_circ_rules
1223 WHERE branchcode = ?
1224 AND categorycode = ?";
1225 my $dbh = C4::Context->dbh();
1226 my $sth = $dbh->prepare($branch_cat_query);
1227 $sth->execute($branchcode, $categorycode);
1229 if ($result = $sth->fetchrow_hashref()) {
1233 # try same branch, default borrower category
1234 my $branch_query = "SELECT maxissueqty
1235 FROM default_branch_circ_rules
1236 WHERE branchcode = ?";
1237 $sth = $dbh->prepare($branch_query);
1238 $sth->execute($branchcode);
1239 if ($result = $sth->fetchrow_hashref()) {
1243 # try default branch, same borrower category
1244 my $category_query = "SELECT maxissueqty
1245 FROM default_borrower_circ_rules
1246 WHERE categorycode = ?";
1247 $sth = $dbh->prepare($category_query);
1248 $sth->execute($categorycode);
1249 if ($result = $sth->fetchrow_hashref()) {
1253 # try default branch, default borrower category
1254 my $default_query = "SELECT maxissueqty
1255 FROM default_circ_rules";
1256 $sth = $dbh->prepare($default_query);
1258 if ($result = $sth->fetchrow_hashref()) {
1262 # built-in default circulation rule
1264 maxissueqty => undef,
1268 =head2 GetBranchItemRule
1272 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1276 Retrieves circulation rule attributes that apply to the given
1277 branch and item type, regardless of patron category.
1279 The return value is a hashref containing the following key:
1281 holdallowed => Hold policy for this branch and itemtype. Possible values:
1282 0: No holds allowed.
1283 1: Holds allowed only by patrons that have the same homebranch as the item.
1284 2: Holds allowed from any patron.
1286 This searches branchitemrules in the following order:
1288 * Same branchcode and itemtype
1289 * Same branchcode, itemtype '*'
1290 * branchcode '*', same itemtype
1291 * branchcode and itemtype '*'
1293 Neither C<$branchcode> nor C<$categorycode> should be '*'.
1297 sub GetBranchItemRule {
1298 my ( $branchcode, $itemtype ) = @_;
1299 my $dbh = C4::Context->dbh();
1303 ['SELECT holdallowed
1304 FROM branch_item_rules
1305 WHERE branchcode = ?
1306 AND itemtype = ?', $branchcode, $itemtype],
1307 ['SELECT holdallowed
1308 FROM default_branch_circ_rules
1309 WHERE branchcode = ?', $branchcode],
1310 ['SELECT holdallowed
1311 FROM default_branch_item_rules
1312 WHERE itemtype = ?', $itemtype],
1313 ['SELECT holdallowed
1314 FROM default_circ_rules'],
1317 foreach my $attempt (@attempts) {
1318 my ($query, @bind_params) = @{$attempt};
1320 # Since branch/category and branch/itemtype use the same per-branch
1321 # defaults tables, we have to check that the key we want is set, not
1322 # just that a row was returned
1323 return $result if ( defined( $result->{'holdallowed'} = $dbh->selectrow_array( $query, {}, @bind_params ) ) );
1326 # built-in default circulation rule
1334 ($doreturn, $messages, $iteminformation, $borrower) =
1335 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1341 =item C<$barcode> is the bar code of the book being returned.
1343 =item C<$branch> is the code of the branch where the book is being returned.
1345 =item C<$exemptfine> indicates that overdue charges for the item will be
1348 =item C<$dropbox> indicates that the check-in date is assumed to be
1349 yesterday, or the last non-holiday as defined in C4::Calendar . If
1350 overdue charges are applied and C<$dropbox> is true, the last charge
1351 will be removed. This assumes that the fines accrual script has run
1356 C<&AddReturn> returns a list of four items:
1358 C<$doreturn> is true iff the return succeeded.
1360 C<$messages> is a reference-to-hash giving the reason for failure:
1366 No item with this barcode exists. The value is C<$barcode>.
1370 The book is not currently on loan. The value is C<$barcode>.
1372 =item C<IsPermanent>
1374 The book's home branch is a permanent collection. If you have borrowed
1375 this book, you are not allowed to return it. The value is the code for
1376 the book's home branch.
1380 This book has been withdrawn/cancelled. The value should be ignored.
1384 The item was reserved. The value is a reference-to-hash whose keys are
1385 fields from the reserves table of the Koha database, and
1386 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1387 either C<Waiting>, C<Reserved>, or 0.
1391 C<$borrower> is a reference-to-hash, giving information about the
1392 patron who last borrowed the book.
1397 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1398 my $dbh = C4::Context->dbh;
1402 my $validTransfert = 0;
1403 my $reserveDone = 0;
1405 # get information on item
1406 my $iteminformation = GetItemIssue( GetItemnumberFromBarcode($barcode));
1407 my $biblio = GetBiblioItemData($iteminformation->{'biblioitemnumber'});
1408 # use Data::Dumper;warn Data::Dumper::Dumper($iteminformation);
1409 unless ($iteminformation->{'itemnumber'} ) {
1410 $messages->{'BadBarcode'} = $barcode;
1414 if ( ( not $iteminformation->{borrowernumber} ) && $doreturn ) {
1415 $messages->{'NotIssued'} = $barcode;
1416 # even though item is not on loan, it may still
1417 # be transferred; therefore, get current branch information
1418 my $curr_iteminfo = GetItem($iteminformation->{'itemnumber'});
1419 $iteminformation->{'homebranch'} = $curr_iteminfo->{'homebranch'};
1420 $iteminformation->{'holdingbranch'} = $curr_iteminfo->{'holdingbranch'};
1421 $iteminformation->{'itemlost'} = $curr_iteminfo->{'itemlost'};
1425 # check if the book is in a permanent collection....
1426 my $hbr = $iteminformation->{C4::Context->preference("HomeOrHoldingBranch")};
1427 my $branches = GetBranches();
1428 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1429 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
1430 $messages->{'IsPermanent'} = $hbr;
1433 # if independent branches are on and returning to different branch, refuse the return
1434 if ($hbr ne C4::Context->userenv->{'branch'} && C4::Context->preference("IndependantBranches")){
1435 $messages->{'Wrongbranch'} = 1;
1439 # check that the book has been cancelled
1440 if ( $iteminformation->{'wthdrawn'} ) {
1441 $messages->{'wthdrawn'} = 1;
1445 # new op dev : if the book returned in an other branch update the holding branch
1447 # update issues, thereby returning book (should push this out into another subroutine
1448 $borrower = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1450 # case of a return of document (deal with issues and holdingbranch)
1453 my $circControlBranch;
1455 # don't allow dropbox mode to create an invalid entry in issues (issuedate > returndate) FIXME: actually checks eq, not gt
1456 undef($dropbox) if ( $iteminformation->{'issuedate'} eq C4::Dates->today('iso') );
1457 if (C4::Context->preference('CircControl') eq 'ItemHomeBranch' ) {
1458 $circControlBranch = $iteminformation->{homebranch};
1459 } elsif ( C4::Context->preference('CircControl') eq 'PatronLibrary') {
1460 $circControlBranch = $borrower->{branchcode};
1461 } else { # CircControl must be PickupLibrary.
1462 $circControlBranch = $iteminformation->{holdingbranch};
1463 # FIXME - is this right ? are we sure that the holdingbranch is still the pickup branch?
1466 MarkIssueReturned($borrower->{'borrowernumber'}, $iteminformation->{'itemnumber'},$circControlBranch);
1467 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right?
1470 # continue to deal with returns cases, but not only if we have an issue
1472 # the holdingbranch is updated if the document is returned in an other location .
1473 if ( $iteminformation->{'holdingbranch'} ne C4::Context->userenv->{'branch'} ) {
1474 UpdateHoldingbranch(C4::Context->userenv->{'branch'},$iteminformation->{'itemnumber'});
1475 # reload iteminformation holdingbranch with the userenv value
1476 $iteminformation->{'holdingbranch'} = C4::Context->userenv->{'branch'};
1478 ModDateLastSeen( $iteminformation->{'itemnumber'} );
1479 ModItem({ onloan => undef }, $biblio->{'biblionumber'}, $iteminformation->{'itemnumber'});
1481 if ($iteminformation->{borrowernumber}){
1482 ($borrower) = C4::Members::GetMemberDetails( $iteminformation->{borrowernumber}, 0 );
1485 # fix up the accounts.....
1486 if ( $iteminformation->{'itemlost'} ) {
1487 $messages->{'WasLost'} = 1;
1490 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1491 # check if we have a transfer for this document
1492 my ($datesent,$frombranch,$tobranch) = GetTransfers( $iteminformation->{'itemnumber'} );
1494 # if we have a transfer to do, we update the line of transfers with the datearrived
1496 if ( $tobranch eq C4::Context->userenv->{'branch'} ) {
1499 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1501 $sth->execute( $iteminformation->{'itemnumber'} );
1503 # now we check if there is a reservation with the validate of transfer if we have one, we can set it with the status 'W'
1504 C4::Reserves::ModReserveStatus( $iteminformation->{'itemnumber'},'W' );
1507 $messages->{'WrongTransfer'} = $tobranch;
1508 $messages->{'WrongTransferItem'} = $iteminformation->{'itemnumber'};
1510 $validTransfert = 1;
1513 # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # # #
1514 # fix up the accounts.....
1515 if ($iteminformation->{'itemlost'}) {
1516 FixAccountForLostAndReturned($iteminformation, $borrower);
1517 $messages->{'WasLost'} = 1;
1519 # fix up the overdues in accounts...
1520 FixOverduesOnReturn( $borrower->{'borrowernumber'},
1521 $iteminformation->{'itemnumber'}, $exemptfine, $dropbox );
1523 # find reserves.....
1524 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1525 my ( $resfound, $resrec ) =
1526 C4::Reserves::CheckReserves( $iteminformation->{'itemnumber'} );
1528 $resrec->{'ResFound'} = $resfound;
1529 $messages->{'ResFound'} = $resrec;
1534 # Record the fact that this book was returned.
1536 $branch, 'return', '0', '',
1537 $iteminformation->{'itemnumber'},
1538 $biblio->{'itemtype'},
1539 $borrower->{'borrowernumber'}
1542 # Send a check-in slip.
1543 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1545 branchcode => $branch,
1546 categorycode => $borrower->{categorycode},
1547 item_type => $iteminformation->{itype},
1548 notification => 'CHECKIN',
1550 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1551 SendCirculationAlert({
1553 item => $iteminformation,
1554 borrower => $borrower,
1559 logaction("CIRCULATION", "RETURN", $iteminformation->{borrowernumber}, $iteminformation->{'biblionumber'})
1560 if C4::Context->preference("ReturnLog");
1562 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1563 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1565 if ($doreturn and ($branch ne $iteminformation->{'homebranch'}) and not $messages->{'WrongTransfer'} and ($validTransfert ne 1) and ($reserveDone ne 1) ){
1566 if (C4::Context->preference("AutomaticItemReturn") == 1) {
1567 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1568 $messages->{'WasTransfered'} = 1;
1569 } elsif ( C4::Context->preference("UseBranchTransferLimits") == 1
1570 && ! IsBranchTransferAllowed( $branch, $iteminformation->{'homebranch'}, $iteminformation->{ C4::Context->preference("BranchTransferLimitsType") } )
1572 ModItemTransfer($iteminformation->{'itemnumber'}, C4::Context->userenv->{'branch'}, $iteminformation->{'homebranch'});
1573 $messages->{'WasTransfered'} = 1;
1576 $messages->{'NeedsTransfer'} = 1;
1580 return ( $doreturn, $messages, $iteminformation, $borrower );
1583 =head2 MarkIssueReturned
1587 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate);
1591 Unconditionally marks an issue as being returned by
1592 moving the C<issues> row to C<old_issues> and
1593 setting C<returndate> to the current date, or
1594 the last non-holiday date of the branccode specified in
1595 C<dropbox_branch> . Assumes you've already checked that
1596 it's safe to do this, i.e. last non-holiday > issuedate.
1598 if C<$returndate> is specified (in iso format), it is used as the date
1599 of the return. It is ignored when a dropbox_branch is passed in.
1601 Ideally, this function would be internal to C<C4::Circulation>,
1602 not exported, but it is currently needed by one
1603 routine in C<C4::Accounts>.
1607 sub MarkIssueReturned {
1608 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate ) = @_;
1609 my $dbh = C4::Context->dbh;
1610 my $query = "UPDATE issues SET returndate=";
1612 if ($dropbox_branch) {
1613 my $calendar = C4::Calendar->new( branchcode => $dropbox_branch );
1614 my $dropboxdate = $calendar->addDate( C4::Dates->new(), -1 );
1616 push @bind, $dropboxdate->output('iso');
1617 } elsif ($returndate) {
1619 push @bind, $returndate;
1621 $query .= " now() ";
1623 $query .= " WHERE borrowernumber = ? AND itemnumber = ?";
1624 push @bind, $borrowernumber, $itemnumber;
1626 my $sth_upd = $dbh->prepare($query);
1627 $sth_upd->execute(@bind);
1628 my $sth_copy = $dbh->prepare("INSERT INTO old_issues SELECT * FROM issues
1629 WHERE borrowernumber = ?
1630 AND itemnumber = ?");
1631 $sth_copy->execute($borrowernumber, $itemnumber);
1632 my $sth_del = $dbh->prepare("DELETE FROM issues
1633 WHERE borrowernumber = ?
1634 AND itemnumber = ?");
1635 $sth_del->execute($borrowernumber, $itemnumber);
1638 =head2 FixOverduesOnReturn
1640 &FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1642 C<$brn> borrowernumber
1646 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1647 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1649 internal function, called only by AddReturn
1653 sub FixOverduesOnReturn {
1654 my ( $borrowernumber, $item, $exemptfine, $dropbox ) = @_;
1655 my $dbh = C4::Context->dbh;
1657 # check for overdue fine
1660 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1662 $sth->execute( $borrowernumber, $item );
1664 # alter fine to show that the book has been returned
1666 if ($data = $sth->fetchrow_hashref) {
1668 my @bind = ($borrowernumber,$item ,$data->{'accountno'});
1670 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1671 if (C4::Context->preference("FinesLog")) {
1672 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1674 } elsif ($dropbox && $data->{lastincrement}) {
1675 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1676 my $amt = $data->{amount} - $data->{lastincrement} ;
1677 if (C4::Context->preference("FinesLog")) {
1678 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1680 $uquery = "update accountlines set accounttype='F' ";
1681 if($outstanding >= 0 && $amt >=0) {
1682 $uquery .= ", amount = ? , amountoutstanding=? ";
1683 unshift @bind, ($amt, $outstanding) ;
1686 $uquery = "update accountlines set accounttype='F' ";
1688 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1689 my $usth = $dbh->prepare($uquery);
1690 $usth->execute(@bind);
1698 =head2 FixAccountForLostAndReturned
1700 &FixAccountForLostAndReturned($iteminfo,$borrower);
1702 Calculates the charge for a book lost and returned (Not exported & used only once)
1704 C<$iteminfo> is a hashref to iteminfo. Only {itemnumber} is used.
1706 C<$borrower> is a hashref to borrower. Only {borrowernumber is used.
1708 Internal function, called by AddReturn
1712 sub FixAccountForLostAndReturned {
1713 my ($iteminfo, $borrower) = @_;
1714 my $dbh = C4::Context->dbh;
1715 my $itm = $iteminfo->{'itemnumber'};
1716 # check for charge made for lost book
1717 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE (itemnumber = ?) AND (accounttype='L' OR accounttype='Rep') ORDER BY date DESC");
1718 $sth->execute($itm);
1719 if (my $data = $sth->fetchrow_hashref) {
1720 # writeoff this amount
1722 my $amount = $data->{'amount'};
1723 my $acctno = $data->{'accountno'};
1725 if ($data->{'amountoutstanding'} == $amount) {
1726 $offset = $data->{'amount'};
1729 $offset = $amount - $data->{'amountoutstanding'};
1730 $amountleft = $data->{'amountoutstanding'} - $amount;
1732 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
1733 WHERE (borrowernumber = ?)
1734 AND (itemnumber = ?) AND (accountno = ?) ");
1735 $usth->execute($data->{'borrowernumber'},$itm,$acctno);
1737 #check if any credit is left if so writeoff other accounts
1738 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
1739 if ($amountleft < 0){
1742 if ($amountleft > 0){
1743 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
1744 AND (amountoutstanding >0) ORDER BY date");
1745 $msth->execute($data->{'borrowernumber'});
1746 # offset transactions
1749 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
1750 if ($accdata->{'amountoutstanding'} < $amountleft) {
1752 $amountleft -= $accdata->{'amountoutstanding'};
1754 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
1757 my $thisacct = $accdata->{'accountno'};
1758 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
1759 WHERE (borrowernumber = ?)
1760 AND (accountno=?)");
1761 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct');
1763 $usth = $dbh->prepare("INSERT INTO accountoffsets
1764 (borrowernumber, accountno, offsetaccount, offsetamount)
1767 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
1772 if ($amountleft > 0){
1775 my $desc="Item Returned ".$iteminfo->{'barcode'};
1776 $usth = $dbh->prepare("INSERT INTO accountlines
1777 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
1778 VALUES (?,?,now(),?,?,'CR',?)");
1779 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
1781 $usth = $dbh->prepare("INSERT INTO accountoffsets
1782 (borrowernumber, accountno, offsetaccount, offsetamount)
1784 $usth->execute($borrower->{'borrowernumber'},$data->{'accountno'},$nextaccntno,$offset);
1786 ModItem({ paidfor => '' }, undef, $itm);
1794 $issues = &GetItemIssue($itemnumber);
1796 Returns patrons currently having a book. nothing if item is not issued atm
1798 C<$itemnumber> is the itemnumber
1800 Returns an array of hashes
1802 FIXME: Though the above says that this function returns nothing if the
1803 item is not issued, this actually returns a hasref that looks like
1814 my ( $itemnumber) = @_;
1815 return unless $itemnumber;
1816 my $dbh = C4::Context->dbh;
1820 my $today = POSIX::strftime("%Y%m%d", localtime);
1822 my $sth = $dbh->prepare(
1823 "SELECT * FROM issues
1824 LEFT JOIN items ON issues.itemnumber=items.itemnumber
1826 issues.itemnumber=?");
1827 $sth->execute($itemnumber);
1828 my $data = $sth->fetchrow_hashref;
1829 my $datedue = $data->{'date_due'};
1831 if ( $datedue < $today ) {
1832 $data->{'overdue'} = 1;
1834 $data->{'itemnumber'} = $itemnumber; # fill itemnumber, in case item is not on issue
1841 $issue = GetOpenIssue( $itemnumber );
1843 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
1845 C<$itemnumber> is the item's itemnumber
1852 my ( $itemnumber ) = @_;
1854 my $dbh = C4::Context->dbh;
1855 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
1856 $sth->execute( $itemnumber );
1857 my $issue = $sth->fetchrow_hashref();
1861 =head2 GetItemIssues
1863 $issues = &GetItemIssues($itemnumber, $history);
1865 Returns patrons that have issued a book
1867 C<$itemnumber> is the itemnumber
1868 C<$history> is 0 if you want actuel "issuer" (if it exist) and 1 if you want issues history
1870 Returns an array of hashes
1875 my ( $itemnumber,$history ) = @_;
1876 my $dbh = C4::Context->dbh;
1880 my $today = POSIX::strftime("%Y%m%d", localtime);
1882 my $sql = "SELECT * FROM issues
1883 JOIN borrowers USING (borrowernumber)
1884 JOIN items USING (itemnumber)
1885 WHERE issues.itemnumber = ? ";
1888 SELECT * FROM old_issues
1889 LEFT JOIN borrowers USING (borrowernumber)
1890 JOIN items USING (itemnumber)
1891 WHERE old_issues.itemnumber = ? ";
1893 $sql .= "ORDER BY date_due DESC";
1894 my $sth = $dbh->prepare($sql);
1896 $sth->execute($itemnumber, $itemnumber);
1898 $sth->execute($itemnumber);
1900 while ( my $data = $sth->fetchrow_hashref ) {
1901 my $datedue = $data->{'date_due'};
1903 if ( $datedue < $today ) {
1904 $data->{'overdue'} = 1;
1906 my $itemnumber = $data->{'itemnumber'};
1907 push @GetItemIssues, $data;
1910 return ( \@GetItemIssues );
1913 =head2 GetBiblioIssues
1915 $issues = GetBiblioIssues($biblionumber);
1917 this function get all issues from a biblionumber.
1920 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
1921 tables issues and the firstname,surname & cardnumber from borrowers.
1925 sub GetBiblioIssues {
1926 my $biblionumber = shift;
1927 return undef unless $biblionumber;
1928 my $dbh = C4::Context->dbh;
1930 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1932 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
1933 LEFT JOIN items ON issues.itemnumber = items.itemnumber
1934 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1935 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1936 WHERE biblio.biblionumber = ?
1938 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
1940 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
1941 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
1942 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
1943 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
1944 WHERE biblio.biblionumber = ?
1947 my $sth = $dbh->prepare($query);
1948 $sth->execute($biblionumber, $biblionumber);
1951 while ( my $data = $sth->fetchrow_hashref ) {
1952 push @issues, $data;
1957 =head2 GetUpcomingDueIssues
1961 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
1967 sub GetUpcomingDueIssues {
1970 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
1971 my $dbh = C4::Context->dbh;
1973 my $statement = <<END_SQL;
1974 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due
1976 LEFT JOIN items USING (itemnumber)
1977 WhERE returndate is NULL
1978 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
1981 my @bind_parameters = ( $params->{'days_in_advance'} );
1983 my $sth = $dbh->prepare( $statement );
1984 $sth->execute( @bind_parameters );
1985 my $upcoming_dues = $sth->fetchall_arrayref({});
1988 return $upcoming_dues;
1991 =head2 CanBookBeRenewed
1993 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
1995 Find out whether a borrowed item may be renewed.
1997 C<$dbh> is a DBI handle to the Koha database.
1999 C<$borrowernumber> is the borrower number of the patron who currently
2000 has the item on loan.
2002 C<$itemnumber> is the number of the item to renew.
2004 C<$override_limit>, if supplied with a true value, causes
2005 the limit on the number of times that the loan can be renewed
2006 (as controlled by the item type) to be ignored.
2008 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2009 item must currently be on loan to the specified borrower; renewals
2010 must be allowed for the item's type; and the borrower must not have
2011 already renewed the loan. $error will contain the reason the renewal can not proceed
2015 sub CanBookBeRenewed {
2017 # check renewal status
2018 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2019 my $dbh = C4::Context->dbh;
2024 # Look in the issues table for this item, lent to this borrower,
2025 # and not yet returned.
2027 # FIXME - I think this function could be redone to use only one SQL call.
2028 my $sth1 = $dbh->prepare(
2029 "SELECT * FROM issues
2030 WHERE borrowernumber = ?
2033 $sth1->execute( $borrowernumber, $itemnumber );
2034 if ( my $data1 = $sth1->fetchrow_hashref ) {
2036 # Found a matching item
2038 # See if this item may be renewed. This query is convoluted
2039 # because it's a bit messy: given the item number, we need to find
2040 # the biblioitem, which gives us the itemtype, which tells us
2041 # whether it may be renewed.
2042 my $query = "SELECT renewalsallowed FROM items ";
2043 $query .= (C4::Context->preference('item-level_itypes'))
2044 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2045 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2046 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2047 $query .= "WHERE items.itemnumber = ?";
2048 my $sth2 = $dbh->prepare($query);
2049 $sth2->execute($itemnumber);
2050 if ( my $data2 = $sth2->fetchrow_hashref ) {
2051 $renews = $data2->{'renewalsallowed'};
2053 if ( ( $renews && $renews > $data1->{'renewals'} ) || $override_limit ) {
2060 my ( $resfound, $resrec ) = C4::Reserves::CheckReserves($itemnumber);
2068 return ($renewokay,$error);
2073 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2077 C<$borrowernumber> is the borrower number of the patron who currently
2080 C<$itemnumber> is the number of the item to renew.
2082 C<$branch> is the library branch. Defaults to the homebranch of the ITEM.
2084 C<$datedue> can be a C4::Dates object used to set the due date.
2086 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2087 this parameter is not supplied, lastreneweddate is set to the current date.
2089 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2090 from the book's item type.
2095 my $borrowernumber = shift or return undef;
2096 my $itemnumber = shift or return undef;
2097 my $item = GetItem($itemnumber) or return undef;
2098 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2099 my $branch = (@_) ? shift : $item->{homebranch}; # opac-renew doesn't send branch
2100 my $datedue = shift;
2101 my $lastreneweddate = shift;
2103 # If the due date wasn't specified, calculate it by adding the
2104 # book's loan length to today's date.
2105 unless ($datedue && $datedue->output('iso')) {
2107 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2108 my $loanlength = GetLoanLength(
2109 $borrower->{'categorycode'},
2110 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2111 $item->{homebranch} # item's homebranch determines loanlength OR do we want the branch specified by the AddRenewal argument?
2113 #FIXME -- use circControl?
2114 $datedue = CalcDateDue(C4::Dates->new(),$loanlength,$branch,$borrower); # this branch is the transactional branch.
2115 # The question of whether to use item's homebranch calendar is open.
2118 # $lastreneweddate defaults to today.
2119 unless (defined $lastreneweddate) {
2120 $lastreneweddate = strftime( "%Y-%m-%d", localtime );
2123 my $dbh = C4::Context->dbh;
2124 # Find the issues record for this book
2126 $dbh->prepare("SELECT * FROM issues
2127 WHERE borrowernumber=?
2130 $sth->execute( $borrowernumber, $itemnumber );
2131 my $issuedata = $sth->fetchrow_hashref;
2134 # If the due date wasn't specified, calculate it by adding the
2135 # book's loan length to due's date.
2136 unless (@_ and $datedue = shift and $datedue->output('iso')) {
2138 my $borrower = C4::Members::GetMemberDetails( $borrowernumber, 0 ) or return undef;
2139 my $loanlength = GetLoanLength(
2140 $borrower->{'categorycode'},
2141 (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'} ,
2142 $item->{homebranch} # item's homebranch determines loanlength OR do we want the branch specified by the AddRenewal argument?
2145 #FIXME -- use circControl?
2146 $datedue = CalcDateDue(C4::Dates->new($issuedata->{date_due}, 'iso'),$loanlength,$branch); # this branch is the transactional branch.
2147 # The question of whether to use item's homebranch calendar is open.
2150 # Update the issues record to have the new due date, and a new count
2151 # of how many times it has been renewed.
2152 my $renews = $issuedata->{'renewals'} + 1;
2153 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2154 WHERE borrowernumber=?
2157 $sth->execute( $datedue->output('iso'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2160 # Update the renewal count on the item, and tell zebra to reindex
2161 $renews = $biblio->{'renewals'} + 1;
2162 ModItem({ renewals => $renews, onloan => $datedue->output('iso') }, $biblio->{'biblionumber'}, $itemnumber);
2164 # Charge a new rental fee, if applicable?
2165 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2166 if ( $charge > 0 ) {
2167 my $accountno = getnextacctno( $borrowernumber );
2168 my $item = GetBiblioFromItemNumber($itemnumber);
2169 $sth = $dbh->prepare(
2170 "INSERT INTO accountlines
2172 borrowernumber, accountno, amount,
2174 accounttype, amountoutstanding, itemnumber
2176 VALUES (now(),?,?,?,?,?,?,?)"
2178 $sth->execute( $borrowernumber, $accountno, $charge,
2179 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2180 'Rent', $charge, $itemnumber );
2184 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2189 # check renewal status
2190 my ($bornum,$itemno)=@_;
2191 my $dbh = C4::Context->dbh;
2193 my $renewsallowed = 0;
2195 # Look in the issues table for this item, lent to this borrower,
2196 # and not yet returned.
2198 # FIXME - I think this function could be redone to use only one SQL call.
2199 my $sth = $dbh->prepare("select * from issues
2200 where (borrowernumber = ?)
2201 and (itemnumber = ?)");
2202 $sth->execute($bornum,$itemno);
2203 my $data = $sth->fetchrow_hashref;
2204 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2206 my $query = "SELECT renewalsallowed FROM items ";
2207 $query .= (C4::Context->preference('item-level_itypes'))
2208 ? "LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2209 : "LEFT JOIN biblioitems on items.biblioitemnumber = biblioitems.biblioitemnumber
2210 LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2211 $query .= "WHERE items.itemnumber = ?";
2212 my $sth2 = $dbh->prepare($query);
2213 $sth2->execute($itemno);
2214 my $data2 = $sth2->fetchrow_hashref();
2215 $renewsallowed = $data2->{'renewalsallowed'};
2216 $renewsleft = $renewsallowed - $renewcount;
2217 return ($renewcount,$renewsallowed,$renewsleft);
2220 =head2 GetIssuingCharges
2222 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2224 Calculate how much it would cost for a given patron to borrow a given
2225 item, including any applicable discounts.
2227 C<$itemnumber> is the item number of item the patron wishes to borrow.
2229 C<$borrowernumber> is the patron's borrower number.
2231 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2232 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2237 sub GetIssuingCharges {
2239 # calculate charges due
2240 my ( $itemnumber, $borrowernumber ) = @_;
2242 my $dbh = C4::Context->dbh;
2245 # Get the book's item type and rental charge (via its biblioitem).
2246 my $qcharge = "SELECT itemtypes.itemtype,rentalcharge FROM items
2247 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber";
2248 $qcharge .= (C4::Context->preference('item-level_itypes'))
2249 ? " LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype "
2250 : " LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype ";
2252 $qcharge .= "WHERE items.itemnumber =?";
2254 my $sth1 = $dbh->prepare($qcharge);
2255 $sth1->execute($itemnumber);
2256 if ( my $data1 = $sth1->fetchrow_hashref ) {
2257 $item_type = $data1->{'itemtype'};
2258 $charge = $data1->{'rentalcharge'};
2259 my $q2 = "SELECT rentaldiscount FROM borrowers
2260 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2261 WHERE borrowers.borrowernumber = ?
2262 AND issuingrules.itemtype = ?";
2263 my $sth2 = $dbh->prepare($q2);
2264 $sth2->execute( $borrowernumber, $item_type );
2265 if ( my $data2 = $sth2->fetchrow_hashref ) {
2266 my $discount = $data2->{'rentaldiscount'};
2267 if ( $discount eq 'NULL' ) {
2270 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2276 return ( $charge, $item_type );
2279 =head2 AddIssuingCharge
2281 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2285 sub AddIssuingCharge {
2286 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2287 my $dbh = C4::Context->dbh;
2288 my $nextaccntno = getnextacctno( $borrowernumber );
2290 INSERT INTO accountlines
2291 (borrowernumber, itemnumber, accountno,
2292 date, amount, description, accounttype,
2294 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?)
2296 my $sth = $dbh->prepare($query);
2297 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge );
2303 GetTransfers($itemnumber);
2308 my ($itemnumber) = @_;
2310 my $dbh = C4::Context->dbh;
2316 FROM branchtransfers
2317 WHERE itemnumber = ?
2318 AND datearrived IS NULL
2320 my $sth = $dbh->prepare($query);
2321 $sth->execute($itemnumber);
2322 my @row = $sth->fetchrow_array();
2327 =head2 GetTransfersFromTo
2329 @results = GetTransfersFromTo($frombranch,$tobranch);
2331 Returns the list of pending transfers between $from and $to branch
2335 sub GetTransfersFromTo {
2336 my ( $frombranch, $tobranch ) = @_;
2337 return unless ( $frombranch && $tobranch );
2338 my $dbh = C4::Context->dbh;
2340 SELECT itemnumber,datesent,frombranch
2341 FROM branchtransfers
2344 AND datearrived IS NULL
2346 my $sth = $dbh->prepare($query);
2347 $sth->execute( $frombranch, $tobranch );
2350 while ( my $data = $sth->fetchrow_hashref ) {
2351 push @gettransfers, $data;
2354 return (@gettransfers);
2357 =head2 DeleteTransfer
2359 &DeleteTransfer($itemnumber);
2363 sub DeleteTransfer {
2364 my ($itemnumber) = @_;
2365 my $dbh = C4::Context->dbh;
2366 my $sth = $dbh->prepare(
2367 "DELETE FROM branchtransfers
2369 AND datearrived IS NULL "
2371 $sth->execute($itemnumber);
2375 =head2 AnonymiseIssueHistory
2377 $rows = AnonymiseIssueHistory($borrowernumber,$date)
2379 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2380 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2382 return the number of affected rows.
2386 sub AnonymiseIssueHistory {
2388 my $borrowernumber = shift;
2389 my $dbh = C4::Context->dbh;
2392 SET borrowernumber = NULL
2393 WHERE returndate < '".$date."'
2394 AND borrowernumber IS NOT NULL
2396 $query .= " AND borrowernumber = '".$borrowernumber."'" if defined $borrowernumber;
2397 my $rows_affected = $dbh->do($query);
2398 return $rows_affected;
2401 =head2 SendCirculationAlert
2403 Send out a C<check-in> or C<checkout> alert using the messaging system.
2411 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2415 Hashref of information about the item being checked in or out.
2419 Hashref of information about the borrower of the item.
2423 The branchcode from where the checkout or check-in took place.
2429 SendCirculationAlert({
2432 borrower => $borrower,
2438 sub SendCirculationAlert {
2440 my ($type, $item, $borrower, $branch) =
2441 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2442 my %message_name = (
2443 CHECKIN => 'Item Check-in',
2444 CHECKOUT => 'Item Checkout',
2446 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2447 borrowernumber => $borrower->{borrowernumber},
2448 message_name => $message_name{$type},
2450 my $letter = C4::Letters::getletter('circulation', $type);
2451 C4::Letters::parseletter($letter, 'biblio', $item->{biblionumber});
2452 C4::Letters::parseletter($letter, 'biblioitems', $item->{biblionumber});
2453 C4::Letters::parseletter($letter, 'borrowers', $borrower->{borrowernumber});
2454 C4::Letters::parseletter($letter, 'branches', $branch);
2455 my @transports = @{ $borrower_preferences->{transports} };
2456 # warn "no transports" unless @transports;
2458 # warn "transport: $_";
2459 my $message = C4::Message->find_last_message($borrower, $type, $_);
2461 #warn "create new message";
2462 C4::Message->enqueue($letter, $borrower, $_);
2464 #warn "append to old message";
2465 $message->append($letter);
2472 =head2 updateWrongTransfer
2474 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2476 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
2480 sub updateWrongTransfer {
2481 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2482 my $dbh = C4::Context->dbh;
2483 # first step validate the actual line of transfert .
2486 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2488 $sth->execute($FromLibrary,$itemNumber);
2491 # second step create a new line of branchtransfer to the right location .
2492 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2494 #third step changing holdingbranch of item
2495 UpdateHoldingbranch($FromLibrary,$itemNumber);
2498 =head2 UpdateHoldingbranch
2500 $items = UpdateHoldingbranch($branch,$itmenumber);
2501 Simple methode for updating hodlingbranch in items BDD line
2505 sub UpdateHoldingbranch {
2506 my ( $branch,$itemnumber ) = @_;
2507 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2512 $newdatedue = CalcDateDue($startdate,$loanlength,$branchcode);
2513 this function calculates the due date given the loan length ,
2514 checking against the holidays calendar as per the 'useDaysMode' syspref.
2515 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2516 C<$branch> = location whose calendar to use
2517 C<$loanlength> = loan length prior to adjustment
2521 my ($startdate,$loanlength,$branch,$borrower) = @_;
2524 if(C4::Context->preference('useDaysMode') eq 'Days') { # ignoring calendar
2525 my $timedue = time + ($loanlength) * 86400;
2526 #FIXME - assumes now even though we take a startdate
2527 my @datearr = localtime($timedue);
2528 $datedue = C4::Dates->new( sprintf("%04d-%02d-%02d", 1900 + $datearr[5], $datearr[4] + 1, $datearr[3]), 'iso');
2530 my $calendar = C4::Calendar->new( branchcode => $branch );
2531 $datedue = $calendar->addDate($startdate, $loanlength);
2534 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2535 if ( C4::Context->preference('ReturnBeforeExpiry') && $datedue->output('iso') gt $borrower->{dateexpiry} ) {
2536 $datedue = C4::Dates->new( $borrower->{dateexpiry}, 'iso' );
2539 # if ceilingDueDate ON the datedue can't be after the ceiling date
2540 if ( C4::Context->preference('ceilingDueDate')
2541 && ( C4::Context->preference('ceilingDueDate') =~ C4::Dates->regexp('syspref') )
2542 && $datedue->output gt C4::Context->preference('ceilingDueDate') ) {
2543 $datedue = C4::Dates->new( C4::Context->preference('ceilingDueDate') );
2549 =head2 CheckValidDatedue
2550 This function does not account for holiday exceptions nor does it handle the 'useDaysMode' syspref .
2551 To be replaced by CalcDateDue() once C4::Calendar use is tested.
2553 $newdatedue = CheckValidDatedue($date_due,$itemnumber,$branchcode);
2554 this function validates the loan length against the holidays calendar, and adjusts the due date as per the 'useDaysMode' syspref.
2555 C<$date_due> = returndate calculate with no day check
2556 C<$itemnumber> = itemnumber
2557 C<$branchcode> = location of issue (affected by 'CircControl' syspref)
2558 C<$loanlength> = loan length prior to adjustment
2561 sub CheckValidDatedue {
2562 my ($date_due,$itemnumber,$branchcode)=@_;
2563 my @datedue=split('-',$date_due->output('iso'));
2564 my $years=$datedue[0];
2565 my $month=$datedue[1];
2566 my $day=$datedue[2];
2567 # die "Item# $itemnumber ($branchcode) due: " . ${date_due}->output() . "\n(Y,M,D) = ($years,$month,$day)":
2569 for (my $i=0;$i<2;$i++){
2570 $dow=Day_of_Week($years,$month,$day);
2571 ($dow=0) if ($dow>6);
2572 my $result=CheckRepeatableHolidays($itemnumber,$dow,$branchcode);
2573 my $countspecial=CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2574 my $countspecialrepeatable=CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2575 if (($result ne '0') or ($countspecial ne '0') or ($countspecialrepeatable ne '0') ){
2577 (($years,$month,$day) = Add_Delta_Days($years,$month,$day, 1))if ($i ne '1');
2580 my $newdatedue=C4::Dates->new(sprintf("%04d-%02d-%02d",$years,$month,$day),'iso');
2585 =head2 CheckRepeatableHolidays
2587 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2588 this function checks if the date due is a repeatable holiday
2589 C<$date_due> = returndate calculate with no day check
2590 C<$itemnumber> = itemnumber
2591 C<$branchcode> = localisation of issue
2595 sub CheckRepeatableHolidays{
2596 my($itemnumber,$week_day,$branchcode)=@_;
2597 my $dbh = C4::Context->dbh;
2598 my $query = qq|SELECT count(*)
2599 FROM repeatable_holidays
2602 my $sth = $dbh->prepare($query);
2603 $sth->execute($branchcode,$week_day);
2604 my $result=$sth->fetchrow;
2610 =head2 CheckSpecialHolidays
2612 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
2613 this function check if the date is a special holiday
2614 C<$years> = the years of datedue
2615 C<$month> = the month of datedue
2616 C<$day> = the day of datedue
2617 C<$itemnumber> = itemnumber
2618 C<$branchcode> = localisation of issue
2622 sub CheckSpecialHolidays{
2623 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
2624 my $dbh = C4::Context->dbh;
2625 my $query=qq|SELECT count(*)
2626 FROM `special_holidays`
2632 my $sth = $dbh->prepare($query);
2633 $sth->execute($years,$month,$day,$branchcode);
2634 my $countspecial=$sth->fetchrow ;
2636 return $countspecial;
2639 =head2 CheckRepeatableSpecialHolidays
2641 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
2642 this function check if the date is a repeatble special holidays
2643 C<$month> = the month of datedue
2644 C<$day> = the day of datedue
2645 C<$itemnumber> = itemnumber
2646 C<$branchcode> = localisation of issue
2650 sub CheckRepeatableSpecialHolidays{
2651 my ($month,$day,$itemnumber,$branchcode) = @_;
2652 my $dbh = C4::Context->dbh;
2653 my $query=qq|SELECT count(*)
2654 FROM `repeatable_holidays`
2659 my $sth = $dbh->prepare($query);
2660 $sth->execute($month,$day,$branchcode);
2661 my $countspecial=$sth->fetchrow ;
2663 return $countspecial;
2668 sub CheckValidBarcode{
2670 my $dbh = C4::Context->dbh;
2671 my $query=qq|SELECT count(*)
2675 my $sth = $dbh->prepare($query);
2676 $sth->execute($barcode);
2677 my $exist=$sth->fetchrow ;
2682 =head2 IsBranchTransferAllowed
2684 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
2686 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
2690 sub IsBranchTransferAllowed {
2691 my ( $toBranch, $fromBranch, $code ) = @_;
2693 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
2695 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2696 my $dbh = C4::Context->dbh;
2698 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
2699 $sth->execute( $toBranch, $fromBranch, $code );
2700 my $limit = $sth->fetchrow_hashref();
2702 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
2703 if ( $limit->{'limitId'} ) {
2710 =head2 CreateBranchTransferLimit
2712 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
2714 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
2718 sub CreateBranchTransferLimit {
2719 my ( $toBranch, $fromBranch, $code ) = @_;
2721 my $limitType = C4::Context->preference("BranchTransferLimitsType");
2723 my $dbh = C4::Context->dbh;
2725 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
2726 $sth->execute( $code, $toBranch, $fromBranch );
2729 =head2 DeleteBranchTransferLimits
2731 DeleteBranchTransferLimits();
2735 sub DeleteBranchTransferLimits {
2736 my $dbh = C4::Context->dbh;
2737 my $sth = $dbh->prepare("TRUNCATE TABLE branch_transfer_limits");
2748 Koha Developement team <info@koha.org>