1 package C4::Circulation;
3 # Copyright 2000-2002 Katipo Communications
4 # copyright 2010 BibLibre
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along
18 # with Koha; if not, write to the Free Software Foundation, Inc.,
19 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 #use warnings; FIXME - Bug 2505
32 use C4::Dates qw(format_date);
34 use C4::ItemCirculationAlertPreference;
37 use C4::Branch; # GetBranches
38 use C4::Log; # logaction
39 use C4::Koha qw(GetAuthorisedValueByCode);
40 use C4::Overdues qw(CalcFine UpdateFine);
41 use Algorithm::CheckDigits;
56 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
60 $VERSION = 3.07.00.049; # for version checking
63 # FIXME subs that should probably be elsewhere
70 # subs to deal with issuing a book
81 &GetBranchBorrowerCircRule
85 &AnonymiseIssueHistory
88 # subs to deal with returns
94 # subs to deal with transfers
101 &IsBranchTransferAllowed
102 &CreateBranchTransferLimit
103 &DeleteBranchTransferLimits
107 # subs to deal with offline circulation
109 &GetOfflineOperations
112 &DeleteOfflineOperation
113 &ProcessOfflineOperation
119 C4::Circulation - Koha circulation module
127 The functions in this module deal with circulation, issues, and
128 returns, as well as general information about the library.
129 Also deals with stocktaking.
135 $str = &barcodedecode($barcode, [$filter]);
137 Generic filter function for barcode string.
138 Called on every circ if the System Pref itemBarcodeInputFilter is set.
139 Will do some manipulation of the barcode for systems that deliver a barcode
140 to circulation.pl that differs from the barcode stored for the item.
141 For proper functioning of this filter, calling the function on the
142 correct barcode string (items.barcode) should return an unaltered barcode.
144 The optional $filter argument is to allow for testing or explicit
145 behavior that ignores the System Pref. Valid values are the same as the
150 # FIXME -- the &decode fcn below should be wrapped into this one.
151 # FIXME -- these plugins should be moved out of Circulation.pm
154 my ($barcode, $filter) = @_;
155 my $branch = C4::Branch::mybranch();
156 $filter = C4::Context->preference('itemBarcodeInputFilter') unless $filter;
157 $filter or return $barcode; # ensure filter is defined, else return untouched barcode
158 if ($filter eq 'whitespace') {
160 } elsif ($filter eq 'cuecat') {
162 my @fields = split( /\./, $barcode );
163 my @results = map( decode($_), @fields[ 1 .. $#fields ] );
164 ($#results == 2) and return $results[2];
165 } elsif ($filter eq 'T-prefix') {
166 if ($barcode =~ /^[Tt](\d)/) {
167 (defined($1) and $1 eq '0') and return $barcode;
168 $barcode = substr($barcode, 2) + 0; # FIXME: probably should be substr($barcode, 1)
170 return sprintf("T%07d", $barcode);
171 # FIXME: $barcode could be "T1", causing warning: substr outside of string
172 # Why drop the nonzero digit after the T?
173 # Why pass non-digits (or empty string) to "T%07d"?
174 } elsif ($filter eq 'libsuite8') {
175 unless($barcode =~ m/^($branch)-/i){ #if barcode starts with branch code its in Koha style. Skip it.
176 if($barcode =~ m/^(\d)/i){ #Some barcodes even start with 0's & numbers and are assumed to have b as the item type in the libsuite8 software
177 $barcode =~ s/^[0]*(\d+)$/$branch-b-$1/i;
179 $barcode =~ s/^(\D+)[0]*(\d+)$/$branch-$1-$2/i;
182 } elsif ($filter eq 'EAN13') {
183 my $ean = CheckDigits('ean');
184 if ( $ean->is_valid($barcode) ) {
185 #$barcode = sprintf('%013d',$barcode); # this doesn't work on 32-bit systems
186 $barcode = '0' x ( 13 - length($barcode) ) . $barcode;
188 warn "# [$barcode] not valid EAN-13/UPC-A\n";
191 return $barcode; # return barcode, modified or not
196 $str = &decode($chunk);
198 Decodes a segment of a string emitted by a CueCat barcode scanner and
201 FIXME: Should be replaced with Barcode::Cuecat from CPAN
202 or Javascript based decoding on the client side.
209 'abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-';
210 my @s = map { index( $seq, $_ ); } split( //, $encoded );
211 my $l = ( $#s + 1 ) % 4;
214 # warn "Error: Cuecat decode parsing failed!";
222 my $n = ( ( $s[0] << 6 | $s[1] ) << 6 | $s[2] ) << 6 | $s[3];
224 chr( ( $n >> 16 ) ^ 67 )
225 .chr( ( $n >> 8 & 255 ) ^ 67 )
226 .chr( ( $n & 255 ) ^ 67 );
229 $r = substr( $r, 0, length($r) - $l );
235 ($dotransfer, $messages, $iteminformation) = &transferbook($newbranch,
236 $barcode, $ignore_reserves);
238 Transfers an item to a new branch. If the item is currently on loan, it is automatically returned before the actual transfer.
240 C<$newbranch> is the code for the branch to which the item should be transferred.
242 C<$barcode> is the barcode of the item to be transferred.
244 If C<$ignore_reserves> is true, C<&transferbook> ignores reserves.
245 Otherwise, if an item is reserved, the transfer fails.
247 Returns three values:
253 is true if the transfer was successful.
257 is a reference-to-hash which may have any of the following keys:
263 There is no item in the catalog with the given barcode. The value is C<$barcode>.
267 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.
269 =item C<DestinationEqualsHolding>
271 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.
275 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.
279 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>.
281 =item C<WasTransferred>
283 The item was eligible to be transferred. Barring problems communicating with the database, the transfer should indeed have succeeded. The value should be ignored.
292 my ( $tbr, $barcode, $ignoreRs ) = @_;
295 my $branches = GetBranches();
296 my $itemnumber = GetItemnumberFromBarcode( $barcode );
297 my $issue = GetItemIssue($itemnumber);
298 my $biblio = GetBiblioFromItemNumber($itemnumber);
301 if ( not $itemnumber ) {
302 $messages->{'BadBarcode'} = $barcode;
306 # get branches of book...
307 my $hbr = $biblio->{'homebranch'};
308 my $fbr = $biblio->{'holdingbranch'};
310 # if using Branch Transfer Limits
311 if ( C4::Context->preference("UseBranchTransferLimits") == 1 ) {
312 if ( C4::Context->preference("item-level_itypes") && C4::Context->preference("BranchTransferLimitsType") eq 'itemtype' ) {
313 if ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{'itype'} ) ) {
314 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{'itype'};
317 } elsif ( ! IsBranchTransferAllowed( $tbr, $fbr, $biblio->{ C4::Context->preference("BranchTransferLimitsType") } ) ) {
318 $messages->{'NotAllowed'} = $tbr . "::" . $biblio->{ C4::Context->preference("BranchTransferLimitsType") };
324 if ( $hbr && $branches->{$hbr}->{'PE'} ) {
325 $messages->{'IsPermanent'} = $hbr;
329 # can't transfer book if is already there....
330 if ( $fbr eq $tbr ) {
331 $messages->{'DestinationEqualsHolding'} = 1;
335 # check if it is still issued to someone, return it...
336 if ($issue->{borrowernumber}) {
337 AddReturn( $barcode, $fbr );
338 $messages->{'WasReturned'} = $issue->{borrowernumber};
342 # That'll save a database query.
343 my ( $resfound, $resrec, undef ) =
344 CheckReserves( $itemnumber );
345 if ( $resfound and not $ignoreRs ) {
346 $resrec->{'ResFound'} = $resfound;
348 # $messages->{'ResFound'} = $resrec;
352 #actually do the transfer....
354 ModItemTransfer( $itemnumber, $fbr, $tbr );
356 # don't need to update MARC anymore, we do it in batch now
357 $messages->{'WasTransfered'} = 1;
360 ModDateLastSeen( $itemnumber );
361 return ( $dotransfer, $messages, $biblio );
366 my $borrower = shift;
367 my $biblionumber = shift;
369 my $cat_borrower = $borrower->{'categorycode'};
370 my $dbh = C4::Context->dbh;
372 # Get which branchcode we need
373 $branch = _GetCircControlBranch($item,$borrower);
374 my $type = (C4::Context->preference('item-level_itypes'))
375 ? $item->{'itype'} # item-level
376 : $item->{'itemtype'}; # biblio-level
378 # given branch, patron category, and item type, determine
379 # applicable issuing rule
380 my $issuing_rule = GetIssuingRule($cat_borrower, $type, $branch);
382 # if a rule is found and has a loan limit set, count
383 # how many loans the patron already has that meet that
385 if (defined($issuing_rule) and defined($issuing_rule->{'maxissueqty'})) {
387 my $count_query = "SELECT COUNT(*) FROM issues
388 JOIN items USING (itemnumber) ";
390 my $rule_itemtype = $issuing_rule->{itemtype};
391 if ($rule_itemtype eq "*") {
392 # matching rule has the default item type, so count only
393 # those existing loans that don't fall under a more
395 if (C4::Context->preference('item-level_itypes')) {
396 $count_query .= " WHERE items.itype NOT IN (
397 SELECT itemtype FROM issuingrules
399 AND (categorycode = ? OR categorycode = ?)
403 $count_query .= " JOIN biblioitems USING (biblionumber)
404 WHERE biblioitems.itemtype NOT IN (
405 SELECT itemtype FROM issuingrules
407 AND (categorycode = ? OR categorycode = ?)
411 push @bind_params, $issuing_rule->{branchcode};
412 push @bind_params, $issuing_rule->{categorycode};
413 push @bind_params, $cat_borrower;
415 # rule has specific item type, so count loans of that
417 if (C4::Context->preference('item-level_itypes')) {
418 $count_query .= " WHERE items.itype = ? ";
420 $count_query .= " JOIN biblioitems USING (biblionumber)
421 WHERE biblioitems.itemtype= ? ";
423 push @bind_params, $type;
426 $count_query .= " AND borrowernumber = ? ";
427 push @bind_params, $borrower->{'borrowernumber'};
428 my $rule_branch = $issuing_rule->{branchcode};
429 if ($rule_branch ne "*") {
430 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
431 $count_query .= " AND issues.branchcode = ? ";
432 push @bind_params, $branch;
433 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
434 ; # if branch is the patron's home branch, then count all loans by patron
436 $count_query .= " AND items.homebranch = ? ";
437 push @bind_params, $branch;
441 my $count_sth = $dbh->prepare($count_query);
442 $count_sth->execute(@bind_params);
443 my ($current_loan_count) = $count_sth->fetchrow_array;
445 my $max_loans_allowed = $issuing_rule->{'maxissueqty'};
446 if ($current_loan_count >= $max_loans_allowed) {
447 return ($current_loan_count, $max_loans_allowed);
451 # Now count total loans against the limit for the branch
452 my $branch_borrower_circ_rule = GetBranchBorrowerCircRule($branch, $cat_borrower);
453 if (defined($branch_borrower_circ_rule->{maxissueqty})) {
454 my @bind_params = ();
455 my $branch_count_query = "SELECT COUNT(*) FROM issues
456 JOIN items USING (itemnumber)
457 WHERE borrowernumber = ? ";
458 push @bind_params, $borrower->{borrowernumber};
460 if (C4::Context->preference('CircControl') eq 'PickupLibrary') {
461 $branch_count_query .= " AND issues.branchcode = ? ";
462 push @bind_params, $branch;
463 } elsif (C4::Context->preference('CircControl') eq 'PatronLibrary') {
464 ; # if branch is the patron's home branch, then count all loans by patron
466 $branch_count_query .= " AND items.homebranch = ? ";
467 push @bind_params, $branch;
469 my $branch_count_sth = $dbh->prepare($branch_count_query);
470 $branch_count_sth->execute(@bind_params);
471 my ($current_loan_count) = $branch_count_sth->fetchrow_array;
473 my $max_loans_allowed = $branch_borrower_circ_rule->{maxissueqty};
474 if ($current_loan_count >= $max_loans_allowed) {
475 return ($current_loan_count, $max_loans_allowed);
479 # OK, the patron can issue !!!
485 @issues = &itemissues($biblioitemnumber, $biblio);
487 Looks up information about who has borrowed the bookZ<>(s) with the
488 given biblioitemnumber.
490 C<$biblio> is ignored.
492 C<&itemissues> returns an array of references-to-hash. The keys
493 include the fields from the C<items> table in the Koha database.
494 Additional keys include:
500 If the item is currently on loan, this gives the due date.
502 If the item is not on loan, then this is either "Available" or
503 "Cancelled", if the item has been withdrawn.
507 If the item is currently on loan, this gives the card number of the
508 patron who currently has the item.
510 =item C<timestamp0>, C<timestamp1>, C<timestamp2>
512 These give the timestamp for the last three times the item was
515 =item C<card0>, C<card1>, C<card2>
517 The card number of the last three patrons who borrowed this item.
519 =item C<borrower0>, C<borrower1>, C<borrower2>
521 The borrower number of the last three patrons who borrowed this item.
529 my ( $bibitem, $biblio ) = @_;
530 my $dbh = C4::Context->dbh;
532 $dbh->prepare("Select * from items where items.biblioitemnumber = ?")
537 $sth->execute($bibitem) || die $sth->errstr;
539 while ( my $data = $sth->fetchrow_hashref ) {
541 # Find out who currently has this item.
542 # FIXME - Wouldn't it be better to do this as a left join of
543 # some sort? Currently, this code assumes that if
544 # fetchrow_hashref() fails, then the book is on the shelf.
545 # fetchrow_hashref() can fail for any number of reasons (e.g.,
546 # database server crash), not just because no items match the
548 my $sth2 = $dbh->prepare(
549 "SELECT * FROM issues
550 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
555 $sth2->execute( $data->{'itemnumber'} );
556 if ( my $data2 = $sth2->fetchrow_hashref ) {
557 $data->{'date_due'} = $data2->{'date_due'};
558 $data->{'card'} = $data2->{'cardnumber'};
559 $data->{'borrower'} = $data2->{'borrowernumber'};
562 $data->{'date_due'} = ($data->{'wthdrawn'} eq '1') ? 'Cancelled' : 'Available';
566 # Find the last 3 people who borrowed this item.
567 $sth2 = $dbh->prepare(
568 "SELECT * FROM old_issues
569 LEFT JOIN borrowers ON issues.borrowernumber = borrowers.borrowernumber
571 ORDER BY returndate DESC,timestamp DESC"
574 $sth2->execute( $data->{'itemnumber'} );
575 for ( my $i2 = 0 ; $i2 < 2 ; $i2++ )
576 { # FIXME : error if there is less than 3 pple borrowing this item
577 if ( my $data2 = $sth2->fetchrow_hashref ) {
578 $data->{"timestamp$i2"} = $data2->{'timestamp'};
579 $data->{"card$i2"} = $data2->{'cardnumber'};
580 $data->{"borrower$i2"} = $data2->{'borrowernumber'};
584 $results[$i] = $data;
591 =head2 CanBookBeIssued
593 ( $issuingimpossible, $needsconfirmation ) = CanBookBeIssued( $borrower,
594 $barcode, $duedatespec, $inprocess, $ignore_reserves );
596 Check if a book can be issued.
598 C<$issuingimpossible> and C<$needsconfirmation> are some hashref.
602 =item C<$borrower> hash with borrower informations (from GetMember or GetMemberDetails)
604 =item C<$barcode> is the bar code of the book being issued.
606 =item C<$duedatespec> is a C4::Dates object.
608 =item C<$inprocess> boolean switch
609 =item C<$ignore_reserves> boolean switch
617 =item C<$issuingimpossible> a reference to a hash. It contains reasons why issuing is impossible.
618 Possible values are :
624 sticky due date is invalid
628 borrower gone with no address
632 borrower declared it's card lost
638 =head3 UNKNOWN_BARCODE
652 item is restricted (set by ??)
654 C<$needsconfirmation> a reference to a hash. It contains reasons why the loan
655 could be prevented, but ones that can be overriden by the operator.
657 Possible values are :
665 renewing, not issuing
667 =head3 ISSUED_TO_ANOTHER
669 issued to someone else.
673 reserved for someone else.
677 sticky due date is invalid or due date in the past
681 if the borrower borrows to much things
685 sub CanBookBeIssued {
686 my ( $borrower, $barcode, $duedate, $inprocess, $ignore_reserves ) = @_;
687 my %needsconfirmation; # filled with problems that needs confirmations
688 my %issuingimpossible; # filled with problems that causes the issue to be IMPOSSIBLE
689 my %alerts; # filled with messages that shouldn't stop issuing, but the librarian should be aware of.
691 my $item = GetItem(GetItemnumberFromBarcode( $barcode ));
692 my $issue = GetItemIssue($item->{itemnumber});
693 my $biblioitem = GetBiblioItemData($item->{biblioitemnumber});
694 $item->{'itemtype'}=$item->{'itype'};
695 my $dbh = C4::Context->dbh;
697 # MANDATORY CHECKS - unless item exists, nothing else matters
698 unless ( $item->{barcode} ) {
699 $issuingimpossible{UNKNOWN_BARCODE} = 1;
701 return ( \%issuingimpossible, \%needsconfirmation ) if %issuingimpossible;
704 # DUE DATE is OK ? -- should already have checked.
706 if ($duedate && ref $duedate ne 'DateTime') {
707 $duedate = dt_from_string($duedate);
709 my $now = DateTime->now( time_zone => C4::Context->tz() );
710 unless ( $duedate ) {
711 my $issuedate = $now->clone();
713 my $branch = _GetCircControlBranch($item,$borrower);
714 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $item->{'itype'} : $biblioitem->{'itemtype'};
715 $duedate = CalcDateDue( $issuedate, $itype, $branch, $borrower );
717 # Offline circ calls AddIssue directly, doesn't run through here
718 # So issuingimpossible should be ok.
721 my $today = $now->clone();
722 $today->truncate( to => 'minute');
723 if (DateTime->compare($duedate,$today) == -1 ) { # duedate cannot be before now
724 $needsconfirmation{INVALID_DATE} = output_pref($duedate);
727 $issuingimpossible{INVALID_DATE} = output_pref($duedate);
733 if ( $borrower->{'category_type'} eq 'X' && ( $item->{barcode} )) {
734 # stats only borrower -- add entry to statistics table, and return issuingimpossible{STATS} = 1 .
735 &UpdateStats(C4::Context->userenv->{'branch'},'localuse','','',$item->{'itemnumber'},$item->{'itemtype'},$borrower->{'borrowernumber'});
736 ModDateLastSeen( $item->{'itemnumber'} );
737 return( { STATS => 1 }, {});
739 if ( $borrower->{flags}->{GNA} ) {
740 $issuingimpossible{GNA} = 1;
742 if ( $borrower->{flags}->{'LOST'} ) {
743 $issuingimpossible{CARD_LOST} = 1;
745 if ( $borrower->{flags}->{'DBARRED'} ) {
746 $issuingimpossible{DEBARRED} = 1;
748 if ( !defined $borrower->{dateexpiry} || $borrower->{'dateexpiry'} eq '0000-00-00') {
749 $issuingimpossible{EXPIRED} = 1;
751 my ($y, $m, $d) = split /-/,$borrower->{'dateexpiry'};
752 if ($y && $m && $d) { # are we really writing oinvalid dates to borrs
753 my $expiry_dt = DateTime->new(
757 time_zone => C4::Context->tz,
759 $expiry_dt->truncate( to => 'day');
760 my $today = $now->clone()->truncate(to => 'day');
761 if (DateTime->compare($today, $expiry_dt) == 1) {
762 $issuingimpossible{EXPIRED} = 1;
765 carp("Invalid expity date in borr");
766 $issuingimpossible{EXPIRED} = 1;
775 C4::Members::GetMemberAccountRecords( $borrower->{'borrowernumber'}, '' && $duedate->ymd() );
776 my $amountlimit = C4::Context->preference("noissuescharge");
777 my $allowfineoverride = C4::Context->preference("AllowFineOverride");
778 my $allfinesneedoverride = C4::Context->preference("AllFinesNeedOverride");
779 if ( C4::Context->preference("IssuingInProcess") ) {
780 if ( $amount > $amountlimit && !$inprocess && !$allowfineoverride) {
781 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
782 } elsif ( $amount > $amountlimit && !$inprocess && $allowfineoverride) {
783 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
784 } elsif ( $allfinesneedoverride && $amount > 0 && $amount <= $amountlimit && !$inprocess ) {
785 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
789 if ( $amount > $amountlimit && $allowfineoverride ) {
790 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
791 } elsif ( $amount > $amountlimit && !$allowfineoverride) {
792 $issuingimpossible{DEBT} = sprintf( "%.2f", $amount );
793 } elsif ( $amount > 0 && $allfinesneedoverride ) {
794 $needsconfirmation{DEBT} = sprintf( "%.2f", $amount );
798 my ($blocktype, $count) = C4::Members::IsMemberBlocked($borrower->{'borrowernumber'});
799 if ($blocktype == -1) {
800 ## patron has outstanding overdue loans
801 if ( C4::Context->preference("OverduesBlockCirc") eq 'block'){
802 $issuingimpossible{USERBLOCKEDOVERDUE} = $count;
804 elsif ( C4::Context->preference("OverduesBlockCirc") eq 'confirmation'){
805 $needsconfirmation{USERBLOCKEDOVERDUE} = $count;
807 } elsif($blocktype == 1) {
808 # patron has accrued fine days
809 $issuingimpossible{USERBLOCKEDREMAINING} = $count;
813 # JB34 CHECKS IF BORROWERS DONT HAVE ISSUE TOO MANY BOOKS
815 my ($current_loan_count, $max_loans_allowed) = TooMany( $borrower, $item->{biblionumber}, $item );
816 # if TooMany max_loans_allowed returns 0 the user doesn't have permission to check out this book
817 if (defined $max_loans_allowed && $max_loans_allowed == 0) {
818 $needsconfirmation{PATRON_CANT} = 1;
820 if($max_loans_allowed){
821 $needsconfirmation{TOO_MANY} = 1;
822 $needsconfirmation{current_loan_count} = $current_loan_count;
823 $needsconfirmation{max_loans_allowed} = $max_loans_allowed;
830 if ( $item->{'notforloan'}
831 && $item->{'notforloan'} > 0 )
833 if(!C4::Context->preference("AllowNotForLoanOverride")){
834 $issuingimpossible{NOT_FOR_LOAN} = 1;
836 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
839 elsif ( !$item->{'notforloan'} ){
840 # we have to check itemtypes.notforloan also
841 if (C4::Context->preference('item-level_itypes')){
842 # this should probably be a subroutine
843 my $sth = $dbh->prepare("SELECT notforloan FROM itemtypes WHERE itemtype = ?");
844 $sth->execute($item->{'itemtype'});
845 my $notforloan=$sth->fetchrow_hashref();
847 if ($notforloan->{'notforloan'}) {
848 if (!C4::Context->preference("AllowNotForLoanOverride")) {
849 $issuingimpossible{NOT_FOR_LOAN} = 1;
851 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
855 elsif ($biblioitem->{'notforloan'} == 1){
856 if (!C4::Context->preference("AllowNotForLoanOverride")) {
857 $issuingimpossible{NOT_FOR_LOAN} = 1;
859 $needsconfirmation{NOT_FOR_LOAN_FORCING} = 1;
863 if ( $item->{'wthdrawn'} && $item->{'wthdrawn'} > 0 )
865 $issuingimpossible{WTHDRAWN} = 1;
867 if ( $item->{'restricted'}
868 && $item->{'restricted'} == 1 )
870 $issuingimpossible{RESTRICTED} = 1;
872 if ( $item->{'itemlost'} && C4::Context->preference("IssueLostItem") ne 'nothing' ) {
873 my $code = GetAuthorisedValueByCode( 'LOST', $item->{'itemlost'} );
874 $needsconfirmation{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'confirm' );
875 $alerts{ITEM_LOST} = $code if ( C4::Context->preference("IssueLostItem") eq 'alert' );
877 if ( C4::Context->preference("IndependantBranches") ) {
878 my $userenv = C4::Context->userenv;
879 if ( ($userenv) && ( $userenv->{flags} % 2 != 1 ) ) {
880 $issuingimpossible{ITEMNOTSAMEBRANCH} = 1
881 if ( $item->{C4::Context->preference("HomeOrHoldingBranch")} ne $userenv->{branch} );
882 $needsconfirmation{BORRNOTSAMEBRANCH} = GetBranchName( $borrower->{'branchcode'} )
883 if ( $borrower->{'branchcode'} ne $userenv->{branch} );
888 # CHECK IF BOOK ALREADY ISSUED TO THIS BORROWER
890 if ( $issue->{borrowernumber} && $issue->{borrowernumber} eq $borrower->{'borrowernumber'} )
893 # Already issued to current borrower. Ask whether the loan should
895 my ($CanBookBeRenewed,$renewerror) = CanBookBeRenewed(
896 $borrower->{'borrowernumber'},
897 $item->{'itemnumber'}
899 if ( $CanBookBeRenewed == 0 ) { # no more renewals allowed
900 $issuingimpossible{NO_MORE_RENEWALS} = 1;
903 $needsconfirmation{RENEW_ISSUE} = 1;
906 elsif ($issue->{borrowernumber}) {
908 # issued to someone else
909 my $currborinfo = C4::Members::GetMember( borrowernumber => $issue->{borrowernumber} );
911 # warn "=>.$currborinfo->{'firstname'} $currborinfo->{'surname'} ($currborinfo->{'cardnumber'})";
912 $needsconfirmation{ISSUED_TO_ANOTHER} = 1;
913 $needsconfirmation{issued_firstname} = $currborinfo->{'firstname'};
914 $needsconfirmation{issued_surname} = $currborinfo->{'surname'};
915 $needsconfirmation{issued_cardnumber} = $currborinfo->{'cardnumber'};
916 $needsconfirmation{issued_borrowernumber} = $currborinfo->{'borrowernumber'};
919 unless ( $ignore_reserves ) {
920 # See if the item is on reserve.
921 my ( $restype, $res ) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
923 my $resbor = $res->{'borrowernumber'};
924 if ( $resbor ne $borrower->{'borrowernumber'} ) {
925 my ( $resborrower ) = C4::Members::GetMember( borrowernumber => $resbor );
926 my $branchname = GetBranchName( $res->{'branchcode'} );
927 if ( $restype eq "Waiting" )
929 # The item is on reserve and waiting, but has been
930 # reserved by some other patron.
931 $needsconfirmation{RESERVE_WAITING} = 1;
932 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
933 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
934 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
935 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
936 $needsconfirmation{'resbranchname'} = $branchname;
937 $needsconfirmation{'reswaitingdate'} = format_date($res->{'waitingdate'});
939 elsif ( $restype eq "Reserved" ) {
940 # The item is on reserve for someone else.
941 $needsconfirmation{RESERVED} = 1;
942 $needsconfirmation{'resfirstname'} = $resborrower->{'firstname'};
943 $needsconfirmation{'ressurname'} = $resborrower->{'surname'};
944 $needsconfirmation{'rescardnumber'} = $resborrower->{'cardnumber'};
945 $needsconfirmation{'resborrowernumber'} = $resborrower->{'borrowernumber'};
946 $needsconfirmation{'resbranchname'} = $branchname;
947 $needsconfirmation{'resreservedate'} = format_date($res->{'reservedate'});
953 # CHECK AGE RESTRICTION
956 # get $marker from preferences. Could be something like "FSK|PEGI|Alter|Age:"
957 my $markers = C4::Context->preference('AgeRestrictionMarker' );
958 my $bibvalues = $biblioitem->{'agerestriction'};
959 if (($markers)&&($bibvalues))
961 # Split $bibvalues to something like FSK 16 or PEGI 6
962 my @values = split ' ', $bibvalues;
964 # Search first occurence of one of the markers
965 my @markers = split /\|/, $markers;
968 for my $value (@values) {
970 for my $marker (@markers) {
971 $marker =~ s/^\s+//; #remove leading spaces
972 $marker =~ s/\s+$//; #remove trailing spaces
973 if (uc($marker) eq uc($value)) {
982 # Index points to the next value
983 my $restrictionyear = 0;
984 if (($take <= $#values) && ($take >= 0)){
985 $restrictionyear += @values[$take];
988 if ($restrictionyear > 0) {
989 if ( $borrower->{'dateofbirth'} ) {
990 my @alloweddate = split /-/,$borrower->{'dateofbirth'} ;
991 @alloweddate[0] += $restrictionyear;
992 #Prevent runime eror on leap year (invalid date)
993 if ((@alloweddate[1] == 2) && (@alloweddate[2] == 29)) {
994 @alloweddate[2] = 28;
997 if ( Date_to_Days(Today) < Date_to_Days(@alloweddate) -1 ) {
998 if (C4::Context->preference('AgeRestrictionOverride' )) {
999 $needsconfirmation{AGE_RESTRICTION} = "$bibvalues";
1002 $issuingimpossible{AGE_RESTRICTION} = "$bibvalues";
1008 return ( \%issuingimpossible, \%needsconfirmation, \%alerts );
1013 &AddIssue($borrower, $barcode, [$datedue], [$cancelreserve], [$issuedate])
1015 Issue a book. Does no check, they are done in CanBookBeIssued. If we reach this sub, it means the user confirmed if needed.
1019 =item C<$borrower> is a hash with borrower informations (from GetMember or GetMemberDetails).
1021 =item C<$barcode> is the barcode of the item being issued.
1023 =item C<$datedue> is a C4::Dates object for the max date of return, i.e. the date due (optional).
1024 Calculated if empty.
1026 =item C<$cancelreserve> is 1 to override and cancel any pending reserves for the item (optional).
1028 =item C<$issuedate> is the date to issue the item in iso (YYYY-MM-DD) format (optional).
1029 Defaults to today. Unlike C<$datedue>, NOT a C4::Dates object, unfortunately.
1031 AddIssue does the following things :
1033 - step 01: check that there is a borrowernumber & a barcode provided
1034 - check for RENEWAL (book issued & being issued to the same patron)
1035 - renewal YES = Calculate Charge & renew
1037 * BOOK ACTUALLY ISSUED ? do a return if book is actually issued (but to someone else)
1039 - fill reserve if reserve to this patron
1040 - cancel reserve or not, otherwise
1041 * TRANSFERT PENDING ?
1042 - complete the transfert
1050 my ( $borrower, $barcode, $datedue, $cancelreserve, $issuedate, $sipmode) = @_;
1051 my $dbh = C4::Context->dbh;
1052 my $barcodecheck=CheckValidBarcode($barcode);
1053 if ($datedue && ref $datedue ne 'DateTime') {
1054 $datedue = dt_from_string($datedue);
1056 # $issuedate defaults to today.
1057 if ( ! defined $issuedate ) {
1058 $issuedate = DateTime->now(time_zone => C4::Context->tz());
1061 if ( ref $issuedate ne 'DateTime') {
1062 $issuedate = dt_from_string($issuedate);
1066 if ($borrower and $barcode and $barcodecheck ne '0'){#??? wtf
1067 # find which item we issue
1068 my $item = GetItem('', $barcode) or return undef; # if we don't get an Item, abort.
1069 my $branch = _GetCircControlBranch($item,$borrower);
1071 # get actual issuing if there is one
1072 my $actualissue = GetItemIssue( $item->{itemnumber});
1074 # get biblioinformation for this item
1075 my $biblio = GetBiblioFromItemNumber($item->{itemnumber});
1078 # check if we just renew the issue.
1080 if ($actualissue->{borrowernumber} eq $borrower->{'borrowernumber'}) {
1081 $datedue = AddRenewal(
1082 $borrower->{'borrowernumber'},
1083 $item->{'itemnumber'},
1086 $issuedate, # here interpreted as the renewal date
1090 # it's NOT a renewal
1091 if ( $actualissue->{borrowernumber}) {
1092 # This book is currently on loan, but not to the person
1093 # who wants to borrow it now. mark it returned before issuing to the new borrower
1096 C4::Context->userenv->{'branch'}
1100 MoveReserve( $item->{'itemnumber'}, $borrower->{'borrowernumber'}, $cancelreserve );
1101 # Starting process for transfer job (checking transfert and validate it if we have one)
1102 my ($datesent) = GetTransfers($item->{'itemnumber'});
1104 # updating line of branchtranfert to finish it, and changing the to branch value, implement a comment for visibility of this case (maybe for stats ....)
1107 "UPDATE branchtransfers
1108 SET datearrived = now(),
1110 comments = 'Forced branchtransfer'
1111 WHERE itemnumber= ? AND datearrived IS NULL"
1113 $sth->execute(C4::Context->userenv->{'branch'},$item->{'itemnumber'});
1116 # Record in the database the fact that the book was issued.
1120 (borrowernumber, itemnumber,issuedate, date_due, branchcode)
1124 my $itype = ( C4::Context->preference('item-level_itypes') ) ? $biblio->{'itype'} : $biblio->{'itemtype'};
1125 $datedue = CalcDateDue( $issuedate, $itype, $branch, $borrower );
1128 $datedue->truncate( to => 'minute');
1130 $borrower->{'borrowernumber'}, # borrowernumber
1131 $item->{'itemnumber'}, # itemnumber
1132 $issuedate->strftime('%Y-%m-%d %H:%M:00'), # issuedate
1133 $datedue->strftime('%Y-%m-%d %H:%M:00'), # date_due
1134 C4::Context->userenv->{'branch'} # branchcode
1136 if ( C4::Context->preference('ReturnToShelvingCart') ) { ## ReturnToShelvingCart is on, anything issued should be taken off the cart.
1137 CartToShelf( $item->{'itemnumber'} );
1139 $item->{'issues'}++;
1140 if ( C4::Context->preference('UpdateTotalIssuesOnCirc') ) {
1141 UpdateTotalIssues($item->{'biblionumber'}, 1);
1144 ## If item was lost, it has now been found, reverse any list item charges if neccessary.
1145 if ( $item->{'itemlost'} ) {
1146 _FixAccountForLostAndReturned( $item->{'itemnumber'}, undef, $item->{'barcode'} );
1149 ModItem({ issues => $item->{'issues'},
1150 holdingbranch => C4::Context->userenv->{'branch'},
1152 datelastborrowed => DateTime->now(time_zone => C4::Context->tz())->ymd(),
1153 onloan => $datedue->ymd(),
1154 }, $item->{'biblionumber'}, $item->{'itemnumber'});
1155 ModDateLastSeen( $item->{'itemnumber'} );
1157 # If it costs to borrow this book, charge it to the patron's account.
1158 my ( $charge, $itemtype ) = GetIssuingCharges(
1159 $item->{'itemnumber'},
1160 $borrower->{'borrowernumber'}
1162 if ( $charge > 0 ) {
1164 $item->{'itemnumber'},
1165 $borrower->{'borrowernumber'}, $charge
1167 $item->{'charge'} = $charge;
1170 # Record the fact that this book was issued.
1172 C4::Context->userenv->{'branch'},
1174 ($sipmode ? "SIP-$sipmode" : ''), $item->{'itemnumber'},
1175 $item->{'itype'}, $borrower->{'borrowernumber'}
1178 # Send a checkout slip.
1179 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1181 branchcode => $branch,
1182 categorycode => $borrower->{categorycode},
1183 item_type => $item->{itype},
1184 notification => 'CHECKOUT',
1186 if ($circulation_alert->is_enabled_for(\%conditions)) {
1187 SendCirculationAlert({
1190 borrower => $borrower,
1196 logaction("CIRCULATION", "ISSUE", $borrower->{'borrowernumber'}, $biblio->{'biblionumber'})
1197 if C4::Context->preference("IssueLog");
1199 return ($datedue); # not necessarily the same as when it came in!
1202 =head2 GetLoanLength
1204 my $loanlength = &GetLoanLength($borrowertype,$itemtype,branchcode)
1206 Get loan length for an itemtype, a borrower type and a branch
1211 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1212 my $dbh = C4::Context->dbh;
1215 'select issuelength, lengthunit from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null'
1217 # warn "in get loan lenght $borrowertype $itemtype $branchcode ";
1218 # try to find issuelength & return the 1st available.
1219 # check with borrowertype, itemtype and branchcode, then without one of those parameters
1220 $sth->execute( $borrowertype, $itemtype, $branchcode );
1221 my $loanlength = $sth->fetchrow_hashref;
1223 if defined($loanlength) && $loanlength->{issuelength};
1225 $sth->execute( $borrowertype, '*', $branchcode );
1226 $loanlength = $sth->fetchrow_hashref;
1228 if defined($loanlength) && $loanlength->{issuelength};
1230 $sth->execute( '*', $itemtype, $branchcode );
1231 $loanlength = $sth->fetchrow_hashref;
1233 if defined($loanlength) && $loanlength->{issuelength};
1235 $sth->execute( '*', '*', $branchcode );
1236 $loanlength = $sth->fetchrow_hashref;
1238 if defined($loanlength) && $loanlength->{issuelength};
1240 $sth->execute( $borrowertype, $itemtype, '*' );
1241 $loanlength = $sth->fetchrow_hashref;
1243 if defined($loanlength) && $loanlength->{issuelength};
1245 $sth->execute( $borrowertype, '*', '*' );
1246 $loanlength = $sth->fetchrow_hashref;
1248 if defined($loanlength) && $loanlength->{issuelength};
1250 $sth->execute( '*', $itemtype, '*' );
1251 $loanlength = $sth->fetchrow_hashref;
1253 if defined($loanlength) && $loanlength->{issuelength};
1255 $sth->execute( '*', '*', '*' );
1256 $loanlength = $sth->fetchrow_hashref;
1258 if defined($loanlength) && $loanlength->{issuelength};
1260 # if no rule is set => 21 days (hardcoded)
1263 lengthunit => 'days',
1269 =head2 GetHardDueDate
1271 my ($hardduedate,$hardduedatecompare) = &GetHardDueDate($borrowertype,$itemtype,branchcode)
1273 Get the Hard Due Date and it's comparison for an itemtype, a borrower type and a branch
1277 sub GetHardDueDate {
1278 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1280 my $rule = GetIssuingRule( $borrowertype, $itemtype, $branchcode );
1282 if ( defined( $rule ) ) {
1283 if ( $rule->{hardduedate} ) {
1284 return (dt_from_string($rule->{hardduedate}, 'iso'),$rule->{hardduedatecompare});
1286 return (undef, undef);
1291 =head2 GetIssuingRule
1293 my $irule = &GetIssuingRule($borrowertype,$itemtype,branchcode)
1295 FIXME - This is a copy-paste of GetLoanLength
1296 as a stop-gap. Do not wish to change API for GetLoanLength
1297 this close to release, however, Overdues::GetIssuingRules is broken.
1299 Get the issuing rule for an itemtype, a borrower type and a branch
1300 Returns a hashref from the issuingrules table.
1304 sub GetIssuingRule {
1305 my ( $borrowertype, $itemtype, $branchcode ) = @_;
1306 my $dbh = C4::Context->dbh;
1307 my $sth = $dbh->prepare( "select * from issuingrules where categorycode=? and itemtype=? and branchcode=? and issuelength is not null" );
1310 $sth->execute( $borrowertype, $itemtype, $branchcode );
1311 $irule = $sth->fetchrow_hashref;
1312 return $irule if defined($irule) ;
1314 $sth->execute( $borrowertype, "*", $branchcode );
1315 $irule = $sth->fetchrow_hashref;
1316 return $irule if defined($irule) ;
1318 $sth->execute( "*", $itemtype, $branchcode );
1319 $irule = $sth->fetchrow_hashref;
1320 return $irule if defined($irule) ;
1322 $sth->execute( "*", "*", $branchcode );
1323 $irule = $sth->fetchrow_hashref;
1324 return $irule if defined($irule) ;
1326 $sth->execute( $borrowertype, $itemtype, "*" );
1327 $irule = $sth->fetchrow_hashref;
1328 return $irule if defined($irule) ;
1330 $sth->execute( $borrowertype, "*", "*" );
1331 $irule = $sth->fetchrow_hashref;
1332 return $irule if defined($irule) ;
1334 $sth->execute( "*", $itemtype, "*" );
1335 $irule = $sth->fetchrow_hashref;
1336 return $irule if defined($irule) ;
1338 $sth->execute( "*", "*", "*" );
1339 $irule = $sth->fetchrow_hashref;
1340 return $irule if defined($irule) ;
1342 # if no rule matches,
1346 =head2 GetBranchBorrowerCircRule
1348 my $branch_cat_rule = GetBranchBorrowerCircRule($branchcode, $categorycode);
1350 Retrieves circulation rule attributes that apply to the given
1351 branch and patron category, regardless of item type.
1352 The return value is a hashref containing the following key:
1354 maxissueqty - maximum number of loans that a
1355 patron of the given category can have at the given
1356 branch. If the value is undef, no limit.
1358 This will first check for a specific branch and
1359 category match from branch_borrower_circ_rules.
1361 If no rule is found, it will then check default_branch_circ_rules
1362 (same branch, default category). If no rule is found,
1363 it will then check default_borrower_circ_rules (default
1364 branch, same category), then failing that, default_circ_rules
1365 (default branch, default category).
1367 If no rule has been found in the database, it will default to
1372 C<$branchcode> and C<$categorycode> should contain the
1373 literal branch code and patron category code, respectively - no
1378 sub GetBranchBorrowerCircRule {
1379 my $branchcode = shift;
1380 my $categorycode = shift;
1382 my $branch_cat_query = "SELECT maxissueqty
1383 FROM branch_borrower_circ_rules
1384 WHERE branchcode = ?
1385 AND categorycode = ?";
1386 my $dbh = C4::Context->dbh();
1387 my $sth = $dbh->prepare($branch_cat_query);
1388 $sth->execute($branchcode, $categorycode);
1390 if ($result = $sth->fetchrow_hashref()) {
1394 # try same branch, default borrower category
1395 my $branch_query = "SELECT maxissueqty
1396 FROM default_branch_circ_rules
1397 WHERE branchcode = ?";
1398 $sth = $dbh->prepare($branch_query);
1399 $sth->execute($branchcode);
1400 if ($result = $sth->fetchrow_hashref()) {
1404 # try default branch, same borrower category
1405 my $category_query = "SELECT maxissueqty
1406 FROM default_borrower_circ_rules
1407 WHERE categorycode = ?";
1408 $sth = $dbh->prepare($category_query);
1409 $sth->execute($categorycode);
1410 if ($result = $sth->fetchrow_hashref()) {
1414 # try default branch, default borrower category
1415 my $default_query = "SELECT maxissueqty
1416 FROM default_circ_rules";
1417 $sth = $dbh->prepare($default_query);
1419 if ($result = $sth->fetchrow_hashref()) {
1423 # built-in default circulation rule
1425 maxissueqty => undef,
1429 =head2 GetBranchItemRule
1431 my $branch_item_rule = GetBranchItemRule($branchcode, $itemtype);
1433 Retrieves circulation rule attributes that apply to the given
1434 branch and item type, regardless of patron category.
1436 The return value is a hashref containing the following keys:
1438 holdallowed => Hold policy for this branch and itemtype. Possible values:
1439 0: No holds allowed.
1440 1: Holds allowed only by patrons that have the same homebranch as the item.
1441 2: Holds allowed from any patron.
1443 returnbranch => branch to which to return item. Possible values:
1444 noreturn: do not return, let item remain where checked in (floating collections)
1445 homebranch: return to item's home branch
1447 This searches branchitemrules in the following order:
1449 * Same branchcode and itemtype
1450 * Same branchcode, itemtype '*'
1451 * branchcode '*', same itemtype
1452 * branchcode and itemtype '*'
1454 Neither C<$branchcode> nor C<$itemtype> should be '*'.
1458 sub GetBranchItemRule {
1459 my ( $branchcode, $itemtype ) = @_;
1460 my $dbh = C4::Context->dbh();
1464 ['SELECT holdallowed, returnbranch
1465 FROM branch_item_rules
1466 WHERE branchcode = ?
1467 AND itemtype = ?', $branchcode, $itemtype],
1468 ['SELECT holdallowed, returnbranch
1469 FROM default_branch_circ_rules
1470 WHERE branchcode = ?', $branchcode],
1471 ['SELECT holdallowed, returnbranch
1472 FROM default_branch_item_rules
1473 WHERE itemtype = ?', $itemtype],
1474 ['SELECT holdallowed, returnbranch
1475 FROM default_circ_rules'],
1478 foreach my $attempt (@attempts) {
1479 my ($query, @bind_params) = @{$attempt};
1480 my $search_result = $dbh->selectrow_hashref ( $query , {}, @bind_params )
1483 # Since branch/category and branch/itemtype use the same per-branch
1484 # defaults tables, we have to check that the key we want is set, not
1485 # just that a row was returned
1486 $result->{'holdallowed'} = $search_result->{'holdallowed'} unless ( defined $result->{'holdallowed'} );
1487 $result->{'returnbranch'} = $search_result->{'returnbranch'} unless ( defined $result->{'returnbranch'} );
1490 # built-in default circulation rule
1491 $result->{'holdallowed'} = 2 unless ( defined $result->{'holdallowed'} );
1492 $result->{'returnbranch'} = 'homebranch' unless ( defined $result->{'returnbranch'} );
1499 ($doreturn, $messages, $iteminformation, $borrower) =
1500 &AddReturn($barcode, $branch, $exemptfine, $dropbox);
1506 =item C<$barcode> is the bar code of the book being returned.
1508 =item C<$branch> is the code of the branch where the book is being returned.
1510 =item C<$exemptfine> indicates that overdue charges for the item will be
1513 =item C<$dropbox> indicates that the check-in date is assumed to be
1514 yesterday, or the last non-holiday as defined in C4::Calendar . If
1515 overdue charges are applied and C<$dropbox> is true, the last charge
1516 will be removed. This assumes that the fines accrual script has run
1521 C<&AddReturn> returns a list of four items:
1523 C<$doreturn> is true iff the return succeeded.
1525 C<$messages> is a reference-to-hash giving feedback on the operation.
1526 The keys of the hash are:
1532 No item with this barcode exists. The value is C<$barcode>.
1536 The book is not currently on loan. The value is C<$barcode>.
1538 =item C<IsPermanent>
1540 The book's home branch is a permanent collection. If you have borrowed
1541 this book, you are not allowed to return it. The value is the code for
1542 the book's home branch.
1546 This book has been withdrawn/cancelled. The value should be ignored.
1548 =item C<Wrongbranch>
1550 This book has was returned to the wrong branch. The value is a hashref
1551 so that C<$messages->{Wrongbranch}->{Wrongbranch}> and C<$messages->{Wrongbranch}->{Rightbranch}>
1552 contain the branchcode of the incorrect and correct return library, respectively.
1556 The item was reserved. The value is a reference-to-hash whose keys are
1557 fields from the reserves table of the Koha database, and
1558 C<biblioitemnumber>. It also has the key C<ResFound>, whose value is
1559 either C<Waiting>, C<Reserved>, or 0.
1563 C<$iteminformation> is a reference-to-hash, giving information about the
1564 returned item from the issues table.
1566 C<$borrower> is a reference-to-hash, giving information about the
1567 patron who last borrowed the book.
1572 my ( $barcode, $branch, $exemptfine, $dropbox ) = @_;
1574 if ($branch and not GetBranchDetail($branch)) {
1575 warn "AddReturn error: branch '$branch' not found. Reverting to " . C4::Context->userenv->{'branch'};
1578 $branch = C4::Context->userenv->{'branch'} unless $branch; # we trust userenv to be a safe fallback/default
1583 my $validTransfert = 0;
1584 my $stat_type = 'return';
1586 # get information on item
1587 my $itemnumber = GetItemnumberFromBarcode( $barcode );
1588 unless ($itemnumber) {
1589 return (0, { BadBarcode => $barcode }); # no barcode means no item or borrower. bail out.
1591 my $issue = GetItemIssue($itemnumber);
1592 # warn Dumper($iteminformation);
1593 if ($issue and $issue->{borrowernumber}) {
1594 $borrower = C4::Members::GetMemberDetails($issue->{borrowernumber})
1595 or die "Data inconsistency: barcode $barcode (itemnumber:$itemnumber) claims to be issued to non-existant borrowernumber '$issue->{borrowernumber}'\n"
1596 . Dumper($issue) . "\n";
1598 $messages->{'NotIssued'} = $barcode;
1599 # even though item is not on loan, it may still be transferred; therefore, get current branch info
1601 # No issue, no borrowernumber. ONLY if $doreturn, *might* you have a $borrower later.
1602 # Record this as a local use, instead of a return, if the RecordLocalUseOnReturn is on
1603 if (C4::Context->preference("RecordLocalUseOnReturn")) {
1604 $messages->{'LocalUse'} = 1;
1605 $stat_type = 'localuse';
1609 my $item = GetItem($itemnumber) or die "GetItem($itemnumber) failed";
1610 # full item data, but no borrowernumber or checkout info (no issue)
1611 # we know GetItem should work because GetItemnumberFromBarcode worked
1612 my $hbr = GetBranchItemRule($item->{'homebranch'}, $item->{'itype'})->{'returnbranch'} || "homebranch";
1613 # get the proper branch to which to return the item
1614 $hbr = $item->{$hbr} || $branch ;
1615 # if $hbr was "noreturn" or any other non-item table value, then it should 'float' (i.e. stay at this branch)
1617 my $borrowernumber = $borrower->{'borrowernumber'} || undef; # we don't know if we had a borrower or not
1619 # check if the book is in a permanent collection....
1620 # FIXME -- This 'PE' attribute is largely undocumented. afaict, there's no user interface that reflects this functionality.
1622 my $branches = GetBranches(); # a potentially expensive call for a non-feature.
1623 $branches->{$hbr}->{PE} and $messages->{'IsPermanent'} = $hbr;
1626 # if indy branches and returning to different branch, refuse the return unless canreservefromotherbranches is turned on
1627 if ($hbr ne $branch && C4::Context->preference("IndependantBranches") && !(C4::Context->preference("canreservefromotherbranches"))){
1628 $messages->{'Wrongbranch'} = {
1629 Wrongbranch => $branch,
1630 Rightbranch => $hbr,
1633 # bailing out here - in this case, current desired behavior
1634 # is to act as if no return ever happened at all.
1635 # FIXME - even in an indy branches situation, there should
1636 # still be an option for the library to accept the item
1637 # and transfer it to its owning library.
1638 return ( $doreturn, $messages, $issue, $borrower );
1641 if ( $item->{'wthdrawn'} ) { # book has been cancelled
1642 $messages->{'wthdrawn'} = 1;
1646 # case of a return of document (deal with issues and holdingbranch)
1647 my $today = DateTime->now( time_zone => C4::Context->tz() );
1649 my $datedue = $issue->{date_due};
1650 $borrower or warn "AddReturn without current borrower";
1651 my $circControlBranch;
1653 # define circControlBranch only if dropbox mode is set
1654 # don't allow dropbox mode to create an invalid entry in issues (issuedate > today)
1655 # FIXME: check issuedate > returndate, factoring in holidays
1656 #$circControlBranch = _GetCircControlBranch($item,$borrower) unless ( $item->{'issuedate'} eq C4::Dates->today('iso') );;
1657 $circControlBranch = _GetCircControlBranch($item,$borrower);
1658 $issue->{'overdue'} = DateTime->compare($issue->{'date_due'}, $today ) == -1 ? 1 : 0;
1661 if ($borrowernumber) {
1662 if($issue->{'overdue'}){
1663 my ( $amount, $type, $unitcounttotal ) = C4::Overdues::CalcFine( $item, $borrower->{categorycode},$branch, $datedue, $today );
1665 if ( $amount > 0 && ( C4::Context->preference('finesMode') eq 'production' )) {
1666 C4::Overdues::UpdateFine(
1667 $issue->{itemnumber},
1668 $issue->{borrowernumber},
1669 $amount, $type, output_pref($datedue)
1673 MarkIssueReturned($borrowernumber, $item->{'itemnumber'}, $circControlBranch, '', $borrower->{'privacy'});
1674 $messages->{'WasReturned'} = 1; # FIXME is the "= 1" right? This could be the borrower hash.
1677 ModItem({ onloan => undef }, $issue->{'biblionumber'}, $item->{'itemnumber'});
1680 # the holdingbranch is updated if the document is returned to another location.
1681 # this is always done regardless of whether the item was on loan or not
1682 if ($item->{'holdingbranch'} ne $branch) {
1683 UpdateHoldingbranch($branch, $item->{'itemnumber'});
1684 $item->{'holdingbranch'} = $branch; # update item data holdingbranch too
1686 ModDateLastSeen( $item->{'itemnumber'} );
1688 # check if we have a transfer for this document
1689 my ($datesent,$frombranch,$tobranch) = GetTransfers( $item->{'itemnumber'} );
1691 # if we have a transfer to do, we update the line of transfers with the datearrived
1693 if ( $tobranch eq $branch ) {
1694 my $sth = C4::Context->dbh->prepare(
1695 "UPDATE branchtransfers SET datearrived = now() WHERE itemnumber= ? AND datearrived IS NULL"
1697 $sth->execute( $item->{'itemnumber'} );
1698 # if we have a reservation with valid transfer, we can set it's status to 'W'
1699 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1700 C4::Reserves::ModReserveStatus($item->{'itemnumber'}, 'W');
1702 $messages->{'WrongTransfer'} = $tobranch;
1703 $messages->{'WrongTransferItem'} = $item->{'itemnumber'};
1705 $validTransfert = 1;
1707 ShelfToCart( $item->{'itemnumber'} ) if ( C4::Context->preference("ReturnToShelvingCart") );
1710 # fix up the accounts.....
1711 if ($item->{'itemlost'}) {
1712 _FixAccountForLostAndReturned($item->{'itemnumber'}, $borrowernumber, $barcode); # can tolerate undef $borrowernumber
1713 $messages->{'WasLost'} = 1;
1716 # fix up the overdues in accounts...
1717 if ($borrowernumber) {
1718 my $fix = _FixOverduesOnReturn($borrowernumber, $item->{itemnumber}, $exemptfine, $dropbox);
1719 defined($fix) or warn "_FixOverduesOnReturn($borrowernumber, $item->{itemnumber}...) failed!"; # zero is OK, check defined
1721 if ( $issue->{overdue} && $issue->{date_due} ) {
1724 _debar_user_on_return( $borrower, $item, $issue->{date_due}, $today );
1725 $messages->{Debarred} = $debardate if ($debardate);
1729 # find reserves.....
1730 # if we don't have a reserve with the status W, we launch the Checkreserves routine
1731 my ($resfound, $resrec, undef) = C4::Reserves::CheckReserves( $item->{'itemnumber'} );
1733 $resrec->{'ResFound'} = $resfound;
1734 $messages->{'ResFound'} = $resrec;
1738 # Record the fact that this book was returned.
1740 $branch, $stat_type, '0', '',
1741 $item->{'itemnumber'},
1742 $biblio->{'itemtype'},
1746 # Send a check-in slip. # NOTE: borrower may be undef. probably shouldn't try to send messages then.
1747 my $circulation_alert = 'C4::ItemCirculationAlertPreference';
1749 branchcode => $branch,
1750 categorycode => $borrower->{categorycode},
1751 item_type => $item->{itype},
1752 notification => 'CHECKIN',
1754 if ($doreturn && $circulation_alert->is_enabled_for(\%conditions)) {
1755 SendCirculationAlert({
1758 borrower => $borrower,
1763 logaction("CIRCULATION", "RETURN", $borrowernumber, $item->{'biblionumber'})
1764 if C4::Context->preference("ReturnLog");
1766 # FIXME: make this comment intelligible.
1767 #adding message if holdingbranch is non equal a userenv branch to return the document to homebranch
1768 #we check, if we don't have reserv or transfert for this document, if not, return it to homebranch .
1770 if (($doreturn or $messages->{'NotIssued'}) and !$resfound and ($branch ne $hbr) and not $messages->{'WrongTransfer'}){
1771 if ( C4::Context->preference("AutomaticItemReturn" ) or
1772 (C4::Context->preference("UseBranchTransferLimits") and
1773 ! IsBranchTransferAllowed($branch, $hbr, $item->{C4::Context->preference("BranchTransferLimitsType")} )
1775 $debug and warn sprintf "about to call ModItemTransfer(%s, %s, %s)", $item->{'itemnumber'},$branch, $hbr;
1776 $debug and warn "item: " . Dumper($item);
1777 ModItemTransfer($item->{'itemnumber'}, $branch, $hbr);
1778 $messages->{'WasTransfered'} = 1;
1780 $messages->{'NeedsTransfer'} = 1; # TODO: instead of 1, specify branchcode that the transfer SHOULD go to, $item->{homebranch}
1783 return ( $doreturn, $messages, $issue, $borrower );
1786 =head2 MarkIssueReturned
1788 MarkIssueReturned($borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy);
1790 Unconditionally marks an issue as being returned by
1791 moving the C<issues> row to C<old_issues> and
1792 setting C<returndate> to the current date, or
1793 the last non-holiday date of the branccode specified in
1794 C<dropbox_branch> . Assumes you've already checked that
1795 it's safe to do this, i.e. last non-holiday > issuedate.
1797 if C<$returndate> is specified (in iso format), it is used as the date
1798 of the return. It is ignored when a dropbox_branch is passed in.
1800 C<$privacy> contains the privacy parameter. If the patron has set privacy to 2,
1801 the old_issue is immediately anonymised
1803 Ideally, this function would be internal to C<C4::Circulation>,
1804 not exported, but it is currently needed by one
1805 routine in C<C4::Accounts>.
1809 sub MarkIssueReturned {
1810 my ( $borrowernumber, $itemnumber, $dropbox_branch, $returndate, $privacy ) = @_;
1812 my $dbh = C4::Context->dbh;
1813 my $query = 'UPDATE issues SET returndate=';
1815 if ($dropbox_branch) {
1816 my $calendar = Koha::Calendar->new( branchcode => $dropbox_branch );
1817 my $dropboxdate = $calendar->addDate( DateTime->now( time_zone => C4::Context->tz), -1 );
1819 push @bind, $dropboxdate->strftime('%Y-%m-%d %H:%M');
1820 } elsif ($returndate) {
1822 push @bind, $returndate;
1824 $query .= ' now() ';
1826 $query .= ' WHERE borrowernumber = ? AND itemnumber = ?';
1827 push @bind, $borrowernumber, $itemnumber;
1829 my $sth_upd = $dbh->prepare($query);
1830 $sth_upd->execute(@bind);
1831 my $sth_copy = $dbh->prepare('INSERT INTO old_issues SELECT * FROM issues
1832 WHERE borrowernumber = ?
1833 AND itemnumber = ?');
1834 $sth_copy->execute($borrowernumber, $itemnumber);
1835 # anonymise patron checkout immediately if $privacy set to 2 and AnonymousPatron is set to a valid borrowernumber
1836 if ( $privacy == 2) {
1837 # The default of 0 does not work due to foreign key constraints
1838 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
1839 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
1840 my $sth_ano = $dbh->prepare("UPDATE old_issues SET borrowernumber=?
1841 WHERE borrowernumber = ?
1842 AND itemnumber = ?");
1843 $sth_ano->execute($anonymouspatron, $borrowernumber, $itemnumber);
1845 my $sth_del = $dbh->prepare("DELETE FROM issues
1846 WHERE borrowernumber = ?
1847 AND itemnumber = ?");
1848 $sth_del->execute($borrowernumber, $itemnumber);
1851 =head2 _debar_user_on_return
1853 _debar_user_on_return($borrower, $item, $datedue, today);
1855 C<$borrower> borrower hashref
1857 C<$item> item hashref
1859 C<$datedue> date due DateTime object
1861 C<$today> DateTime object representing the return time
1863 Internal function, called only by AddReturn that calculates and updates
1864 the user fine days, and debars him if necessary.
1866 Should only be called for overdue returns
1870 sub _debar_user_on_return {
1871 my ( $borrower, $item, $dt_due, $dt_today ) = @_;
1873 my $branchcode = _GetCircControlBranch( $item, $borrower );
1874 my $calendar = Koha::Calendar->new( branchcode => $branchcode );
1876 # $deltadays is a DateTime::Duration object
1877 my $deltadays = $calendar->days_between( $dt_due, $dt_today );
1879 my $circcontrol = C4::Context::preference('CircControl');
1881 GetIssuingRule( $borrower->{categorycode}, $item->{itype}, $branchcode );
1882 my $finedays = $issuingrule->{finedays};
1883 my $unit = $issuingrule->{lengthunit};
1887 # finedays is in days, so hourly loans must multiply by 24
1888 # thus 1 hour late equals 1 day suspension * finedays rate
1889 $finedays = $finedays * 24 if ( $unit eq 'hours' );
1891 # grace period is measured in the same units as the loan
1893 DateTime::Duration->new( $unit => $issuingrule->{firstremind} );
1894 if ( $deltadays->subtract($grace)->is_positive() ) {
1897 $dt_today->clone()->add_duration( $deltadays * $finedays );
1898 if ( $borrower->{debarred} ) {
1899 my $borrower_debar_dt = dt_from_string( $borrower->{debarred} );
1901 # Update patron only if new date > old
1902 if ( DateTime->compare( $borrower_debar_dt, $new_debar_dt ) !=
1909 C4::Members::DebarMember( $borrower->{borrowernumber},
1910 $new_debar_dt->ymd() );
1911 return $new_debar_dt->ymd();
1917 =head2 _FixOverduesOnReturn
1919 &_FixOverduesOnReturn($brn,$itm, $exemptfine, $dropboxmode);
1921 C<$brn> borrowernumber
1925 C<$exemptfine> BOOL -- remove overdue charge associated with this issue.
1926 C<$dropboxmode> BOOL -- remove lastincrement on overdue charge associated with this issue.
1928 Internal function, called only by AddReturn
1932 sub _FixOverduesOnReturn {
1933 my ($borrowernumber, $item);
1934 unless ($borrowernumber = shift) {
1935 warn "_FixOverduesOnReturn() not supplied valid borrowernumber";
1938 unless ($item = shift) {
1939 warn "_FixOverduesOnReturn() not supplied valid itemnumber";
1942 my ($exemptfine, $dropbox) = @_;
1943 my $dbh = C4::Context->dbh;
1945 # check for overdue fine
1946 my $sth = $dbh->prepare(
1947 "SELECT * FROM accountlines WHERE (borrowernumber = ?) AND (itemnumber = ?) AND (accounttype='FU' OR accounttype='O')"
1949 $sth->execute( $borrowernumber, $item );
1951 # alter fine to show that the book has been returned
1952 my $data = $sth->fetchrow_hashref;
1953 return 0 unless $data; # no warning, there's just nothing to fix
1956 my @bind = ($borrowernumber, $item, $data->{'accountno'});
1958 $uquery = "update accountlines set accounttype='FFOR', amountoutstanding=0";
1959 if (C4::Context->preference("FinesLog")) {
1960 &logaction("FINES", 'MODIFY',$borrowernumber,"Overdue forgiven: item $item");
1962 } elsif ($dropbox && $data->{lastincrement}) {
1963 my $outstanding = $data->{amountoutstanding} - $data->{lastincrement} ;
1964 my $amt = $data->{amount} - $data->{lastincrement} ;
1965 if (C4::Context->preference("FinesLog")) {
1966 &logaction("FINES", 'MODIFY',$borrowernumber,"Dropbox adjustment $amt, item $item");
1968 $uquery = "update accountlines set accounttype='F' ";
1969 if($outstanding >= 0 && $amt >=0) {
1970 $uquery .= ", amount = ? , amountoutstanding=? ";
1971 unshift @bind, ($amt, $outstanding) ;
1974 $uquery = "update accountlines set accounttype='F' ";
1976 $uquery .= " where (borrowernumber = ?) and (itemnumber = ?) and (accountno = ?)";
1977 my $usth = $dbh->prepare($uquery);
1978 return $usth->execute(@bind);
1981 =head2 _FixAccountForLostAndReturned
1983 &_FixAccountForLostAndReturned($itemnumber, [$borrowernumber, $barcode]);
1985 Calculates the charge for a book lost and returned.
1987 Internal function, not exported, called only by AddReturn.
1989 FIXME: This function reflects how inscrutable fines logic is. Fix both.
1990 FIXME: Give a positive return value on success. It might be the $borrowernumber who received credit, or the amount forgiven.
1994 sub _FixAccountForLostAndReturned {
1995 my $itemnumber = shift or return;
1996 my $borrowernumber = @_ ? shift : undef;
1997 my $item_id = @_ ? shift : $itemnumber; # Send the barcode if you want that logged in the description
1998 my $dbh = C4::Context->dbh;
1999 # check for charge made for lost book
2000 my $sth = $dbh->prepare("SELECT * FROM accountlines WHERE itemnumber = ? AND accounttype IN ('L', 'Rep', 'W') ORDER BY date DESC, accountno DESC");
2001 $sth->execute($itemnumber);
2002 my $data = $sth->fetchrow_hashref;
2003 $data or return; # bail if there is nothing to do
2004 $data->{accounttype} eq 'W' and return; # Written off
2006 # writeoff this amount
2008 my $amount = $data->{'amount'};
2009 my $acctno = $data->{'accountno'};
2010 my $amountleft; # Starts off undef/zero.
2011 if ($data->{'amountoutstanding'} == $amount) {
2012 $offset = $data->{'amount'};
2013 $amountleft = 0; # Hey, it's zero here, too.
2015 $offset = $amount - $data->{'amountoutstanding'}; # Um, isn't this the same as ZERO? We just tested those two things are ==
2016 $amountleft = $data->{'amountoutstanding'} - $amount; # Um, isn't this the same as ZERO? We just tested those two things are ==
2018 my $usth = $dbh->prepare("UPDATE accountlines SET accounttype = 'LR',amountoutstanding='0'
2019 WHERE (borrowernumber = ?)
2020 AND (itemnumber = ?) AND (accountno = ?) ");
2021 $usth->execute($data->{'borrowernumber'},$itemnumber,$acctno); # We might be adjusting an account for some OTHER borrowernumber now. Not the one we passed in.
2022 #check if any credit is left if so writeoff other accounts
2023 my $nextaccntno = getnextacctno($data->{'borrowernumber'});
2024 $amountleft *= -1 if ($amountleft < 0);
2025 if ($amountleft > 0) {
2026 my $msth = $dbh->prepare("SELECT * FROM accountlines WHERE (borrowernumber = ?)
2027 AND (amountoutstanding >0) ORDER BY date"); # might want to order by amountoustanding ASC (pay smallest first)
2028 $msth->execute($data->{'borrowernumber'});
2029 # offset transactions
2032 while (($accdata=$msth->fetchrow_hashref) and ($amountleft>0)){
2033 if ($accdata->{'amountoutstanding'} < $amountleft) {
2035 $amountleft -= $accdata->{'amountoutstanding'};
2037 $newamtos = $accdata->{'amountoutstanding'} - $amountleft;
2040 my $thisacct = $accdata->{'accountno'};
2041 # FIXME: move prepares outside while loop!
2042 my $usth = $dbh->prepare("UPDATE accountlines SET amountoutstanding= ?
2043 WHERE (borrowernumber = ?)
2044 AND (accountno=?)");
2045 $usth->execute($newamtos,$data->{'borrowernumber'},'$thisacct'); # FIXME: '$thisacct' is a string literal!
2046 $usth = $dbh->prepare("INSERT INTO accountoffsets
2047 (borrowernumber, accountno, offsetaccount, offsetamount)
2050 $usth->execute($data->{'borrowernumber'},$accdata->{'accountno'},$nextaccntno,$newamtos);
2052 $msth->finish; # $msth might actually have data left
2054 $amountleft *= -1 if ($amountleft > 0);
2055 my $desc = "Item Returned " . $item_id;
2056 $usth = $dbh->prepare("INSERT INTO accountlines
2057 (borrowernumber,accountno,date,amount,description,accounttype,amountoutstanding)
2058 VALUES (?,?,now(),?,?,'CR',?)");
2059 $usth->execute($data->{'borrowernumber'},$nextaccntno,0-$amount,$desc,$amountleft);
2060 if ($borrowernumber) {
2061 # FIXME: same as query above. use 1 sth for both
2062 $usth = $dbh->prepare("INSERT INTO accountoffsets
2063 (borrowernumber, accountno, offsetaccount, offsetamount)
2065 $usth->execute($borrowernumber, $data->{'accountno'}, $nextaccntno, $offset);
2067 ModItem({ paidfor => '' }, undef, $itemnumber);
2071 =head2 _GetCircControlBranch
2073 my $circ_control_branch = _GetCircControlBranch($iteminfos, $borrower);
2077 Return the library code to be used to determine which circulation
2078 policy applies to a transaction. Looks up the CircControl and
2079 HomeOrHoldingBranch system preferences.
2081 C<$iteminfos> is a hashref to iteminfo. Only {homebranch or holdingbranch} is used.
2083 C<$borrower> is a hashref to borrower. Only {branchcode} is used.
2087 sub _GetCircControlBranch {
2088 my ($item, $borrower) = @_;
2089 my $circcontrol = C4::Context->preference('CircControl');
2092 if ($circcontrol eq 'PickupLibrary' and (C4::Context->userenv and C4::Context->userenv->{'branch'}) ) {
2093 $branch= C4::Context->userenv->{'branch'};
2094 } elsif ($circcontrol eq 'PatronLibrary') {
2095 $branch=$borrower->{branchcode};
2097 my $branchfield = C4::Context->preference('HomeOrHoldingBranch') || 'homebranch';
2098 $branch = $item->{$branchfield};
2099 # default to item home branch if holdingbranch is used
2100 # and is not defined
2101 if (!defined($branch) && $branchfield eq 'holdingbranch') {
2102 $branch = $item->{homebranch};
2115 $issue = &GetItemIssue($itemnumber);
2117 Returns patron currently having a book, or undef if not checked out.
2119 C<$itemnumber> is the itemnumber.
2121 C<$issue> is a hashref of the row from the issues table.
2126 my ($itemnumber) = @_;
2127 return unless $itemnumber;
2128 my $sth = C4::Context->dbh->prepare(
2131 LEFT JOIN items ON issues.itemnumber=items.itemnumber
2132 WHERE issues.itemnumber=?");
2133 $sth->execute($itemnumber);
2134 my $data = $sth->fetchrow_hashref;
2135 return unless $data;
2136 $data->{issuedate} = dt_from_string($data->{issuedate}, 'sql');
2137 $data->{issuedate}->truncate(to => 'minute');
2138 $data->{date_due} = dt_from_string($data->{date_due}, 'sql');
2139 $data->{date_due}->truncate(to => 'minute');
2140 my $dt = DateTime->now( time_zone => C4::Context->tz)->truncate( to => 'minute');
2141 $data->{'overdue'} = DateTime->compare($data->{'date_due'}, $dt ) == -1 ? 1 : 0;
2147 $issue = GetOpenIssue( $itemnumber );
2149 Returns the row from the issues table if the item is currently issued, undef if the item is not currently issued
2151 C<$itemnumber> is the item's itemnumber
2158 my ( $itemnumber ) = @_;
2160 my $dbh = C4::Context->dbh;
2161 my $sth = $dbh->prepare( "SELECT * FROM issues WHERE itemnumber = ? AND returndate IS NULL" );
2162 $sth->execute( $itemnumber );
2163 my $issue = $sth->fetchrow_hashref();
2167 =head2 GetItemIssues
2169 $issues = &GetItemIssues($itemnumber, $history);
2171 Returns patrons that have issued a book
2173 C<$itemnumber> is the itemnumber
2174 C<$history> is false if you just want the current "issuer" (if any)
2175 and true if you want issues history from old_issues also.
2177 Returns reference to an array of hashes
2182 my ( $itemnumber, $history ) = @_;
2184 my $today = DateTime->now( time_zome => C4::Context->tz); # get today date
2185 $today->truncate( to => 'minute' );
2186 my $sql = "SELECT * FROM issues
2187 JOIN borrowers USING (borrowernumber)
2188 JOIN items USING (itemnumber)
2189 WHERE issues.itemnumber = ? ";
2192 SELECT * FROM old_issues
2193 LEFT JOIN borrowers USING (borrowernumber)
2194 JOIN items USING (itemnumber)
2195 WHERE old_issues.itemnumber = ? ";
2197 $sql .= "ORDER BY date_due DESC";
2198 my $sth = C4::Context->dbh->prepare($sql);
2200 $sth->execute($itemnumber, $itemnumber);
2202 $sth->execute($itemnumber);
2204 my $results = $sth->fetchall_arrayref({});
2205 foreach (@$results) {
2206 my $date_due = dt_from_string($_->{date_due},'sql');
2207 $date_due->truncate( to => 'minute' );
2209 $_->{overdue} = (DateTime->compare($date_due, $today) == -1) ? 1 : 0;
2214 =head2 GetBiblioIssues
2216 $issues = GetBiblioIssues($biblionumber);
2218 this function get all issues from a biblionumber.
2221 C<$issues> is a reference to array which each value is ref-to-hash. This ref-to-hash containts all column from
2222 tables issues and the firstname,surname & cardnumber from borrowers.
2226 sub GetBiblioIssues {
2227 my $biblionumber = shift;
2228 return undef unless $biblionumber;
2229 my $dbh = C4::Context->dbh;
2231 SELECT issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2233 LEFT JOIN borrowers ON borrowers.borrowernumber = issues.borrowernumber
2234 LEFT JOIN items ON issues.itemnumber = items.itemnumber
2235 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2236 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2237 WHERE biblio.biblionumber = ?
2239 SELECT old_issues.*,items.barcode,biblio.biblionumber,biblio.title, biblio.author,borrowers.cardnumber,borrowers.surname,borrowers.firstname
2241 LEFT JOIN borrowers ON borrowers.borrowernumber = old_issues.borrowernumber
2242 LEFT JOIN items ON old_issues.itemnumber = items.itemnumber
2243 LEFT JOIN biblioitems ON items.itemnumber = biblioitems.biblioitemnumber
2244 LEFT JOIN biblio ON biblio.biblionumber = items.biblionumber
2245 WHERE biblio.biblionumber = ?
2248 my $sth = $dbh->prepare($query);
2249 $sth->execute($biblionumber, $biblionumber);
2252 while ( my $data = $sth->fetchrow_hashref ) {
2253 push @issues, $data;
2258 =head2 GetUpcomingDueIssues
2260 my $upcoming_dues = GetUpcomingDueIssues( { days_in_advance => 4 } );
2264 sub GetUpcomingDueIssues {
2267 $params->{'days_in_advance'} = 7 unless exists $params->{'days_in_advance'};
2268 my $dbh = C4::Context->dbh;
2270 my $statement = <<END_SQL;
2271 SELECT issues.*, items.itype as itemtype, items.homebranch, TO_DAYS( date_due )-TO_DAYS( NOW() ) as days_until_due, branches.branchemail
2273 LEFT JOIN items USING (itemnumber)
2274 LEFT OUTER JOIN branches USING (branchcode)
2275 WhERE returndate is NULL
2276 AND ( TO_DAYS( NOW() )-TO_DAYS( date_due ) ) < ?
2279 my @bind_parameters = ( $params->{'days_in_advance'} );
2281 my $sth = $dbh->prepare( $statement );
2282 $sth->execute( @bind_parameters );
2283 my $upcoming_dues = $sth->fetchall_arrayref({});
2286 return $upcoming_dues;
2289 =head2 CanBookBeRenewed
2291 ($ok,$error) = &CanBookBeRenewed($borrowernumber, $itemnumber[, $override_limit]);
2293 Find out whether a borrowed item may be renewed.
2295 C<$dbh> is a DBI handle to the Koha database.
2297 C<$borrowernumber> is the borrower number of the patron who currently
2298 has the item on loan.
2300 C<$itemnumber> is the number of the item to renew.
2302 C<$override_limit>, if supplied with a true value, causes
2303 the limit on the number of times that the loan can be renewed
2304 (as controlled by the item type) to be ignored.
2306 C<$CanBookBeRenewed> returns a true value iff the item may be renewed. The
2307 item must currently be on loan to the specified borrower; renewals
2308 must be allowed for the item's type; and the borrower must not have
2309 already renewed the loan. $error will contain the reason the renewal can not proceed
2313 sub CanBookBeRenewed {
2315 # check renewal status
2316 my ( $borrowernumber, $itemnumber, $override_limit ) = @_;
2317 my $dbh = C4::Context->dbh;
2322 # Look in the issues table for this item, lent to this borrower,
2323 # and not yet returned.
2325 # Look in the issues table for this item, lent to this borrower,
2326 # and not yet returned.
2328 'ItemHomeLibrary' => 'items.homebranch',
2329 'PickupLibrary' => 'items.holdingbranch',
2330 'PatronLibrary' => 'borrowers.branchcode'
2332 my $controlbranch = $branch{C4::Context->preference('CircControl')};
2333 my $itype = C4::Context->preference('item-level_itypes') ? 'items.itype' : 'biblioitems.itemtype';
2335 my $sthcount = $dbh->prepare("
2337 borrowers.categorycode, biblioitems.itemtype, issues.renewals, renewalsallowed, $controlbranch
2340 LEFT JOIN items USING (itemnumber)
2341 LEFT JOIN borrowers USING (borrowernumber)
2342 LEFT JOIN biblioitems USING (biblioitemnumber)
2345 (issuingrules.categorycode = borrowers.categorycode OR issuingrules.categorycode = '*')
2347 (issuingrules.itemtype = $itype OR issuingrules.itemtype = '*')
2349 (issuingrules.branchcode = $controlbranch OR issuingrules.branchcode = '*')
2355 issuingrules.categorycode desc,
2356 issuingrules.itemtype desc,
2357 issuingrules.branchcode desc
2361 $sthcount->execute( $borrowernumber, $itemnumber );
2362 if ( my $data1 = $sthcount->fetchrow_hashref ) {
2364 if ( ( $data1->{renewalsallowed} && $data1->{renewalsallowed} > $data1->{renewals} ) || $override_limit ) {
2371 my ( $resfound, $resrec, undef ) = C4::Reserves::CheckReserves($itemnumber);
2378 return ($renewokay,$error);
2383 &AddRenewal($borrowernumber, $itemnumber, $branch, [$datedue], [$lastreneweddate]);
2387 C<$borrowernumber> is the borrower number of the patron who currently
2390 C<$itemnumber> is the number of the item to renew.
2392 C<$branch> is the library where the renewal took place (if any).
2393 The library that controls the circ policies for the renewal is retrieved from the issues record.
2395 C<$datedue> can be a C4::Dates object used to set the due date.
2397 C<$lastreneweddate> is an optional ISO-formatted date used to set issues.lastreneweddate. If
2398 this parameter is not supplied, lastreneweddate is set to the current date.
2400 If C<$datedue> is the empty string, C<&AddRenewal> will calculate the due date automatically
2401 from the book's item type.
2406 my $borrowernumber = shift or return undef;
2407 my $itemnumber = shift or return undef;
2409 my $datedue = shift;
2410 my $lastreneweddate = shift || DateTime->now(time_zone => C4::Context->tz)->ymd();
2411 my $item = GetItem($itemnumber) or return undef;
2412 my $biblio = GetBiblioFromItemNumber($itemnumber) or return undef;
2414 my $dbh = C4::Context->dbh;
2415 # Find the issues record for this book
2417 $dbh->prepare("SELECT * FROM issues
2418 WHERE borrowernumber=?
2421 $sth->execute( $borrowernumber, $itemnumber );
2422 my $issuedata = $sth->fetchrow_hashref;
2424 if(defined $datedue && ref $datedue ne 'DateTime' ) {
2425 carp 'Invalid date passed to AddRenewal.';
2428 # If the due date wasn't specified, calculate it by adding the
2429 # book's loan length to today's date or the current due date
2430 # based on the value of the RenewalPeriodBase syspref.
2433 my $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber ) or return undef;
2434 my $itemtype = (C4::Context->preference('item-level_itypes')) ? $biblio->{'itype'} : $biblio->{'itemtype'};
2436 $datedue = (C4::Context->preference('RenewalPeriodBase') eq 'date_due') ?
2437 $issuedata->{date_due} :
2438 DateTime->now( time_zone => C4::Context->tz());
2439 $datedue = CalcDateDue($datedue,$itemtype,$issuedata->{'branchcode'},$borrower);
2442 # Update the issues record to have the new due date, and a new count
2443 # of how many times it has been renewed.
2444 my $renews = $issuedata->{'renewals'} + 1;
2445 $sth = $dbh->prepare("UPDATE issues SET date_due = ?, renewals = ?, lastreneweddate = ?
2446 WHERE borrowernumber=?
2450 $sth->execute( $datedue->strftime('%Y-%m-%d %H:%M'), $renews, $lastreneweddate, $borrowernumber, $itemnumber );
2453 # Update the renewal count on the item, and tell zebra to reindex
2454 $renews = $biblio->{'renewals'} + 1;
2455 ModItem({ renewals => $renews, onloan => $datedue->strftime('%Y-%m-%d %H:%M')}, $biblio->{'biblionumber'}, $itemnumber);
2457 # Charge a new rental fee, if applicable?
2458 my ( $charge, $type ) = GetIssuingCharges( $itemnumber, $borrowernumber );
2459 if ( $charge > 0 ) {
2460 my $accountno = getnextacctno( $borrowernumber );
2461 my $item = GetBiblioFromItemNumber($itemnumber);
2463 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2464 $sth = $dbh->prepare(
2465 "INSERT INTO accountlines
2466 (date, borrowernumber, accountno, amount, manager_id,
2467 description,accounttype, amountoutstanding, itemnumber)
2468 VALUES (now(),?,?,?,?,?,?,?,?)"
2470 $sth->execute( $borrowernumber, $accountno, $charge, $manager_id,
2471 "Renewal of Rental Item $item->{'title'} $item->{'barcode'}",
2472 'Rent', $charge, $itemnumber );
2475 UpdateStats( $branch, 'renew', $charge, '', $itemnumber, $item->{itype}, $borrowernumber);
2480 # check renewal status
2481 my ( $bornum, $itemno ) = @_;
2482 my $dbh = C4::Context->dbh;
2484 my $renewsallowed = 0;
2487 my $borrower = C4::Members::GetMember( borrowernumber => $bornum);
2488 my $item = GetItem($itemno);
2490 # Look in the issues table for this item, lent to this borrower,
2491 # and not yet returned.
2493 # FIXME - I think this function could be redone to use only one SQL call.
2494 my $sth = $dbh->prepare(
2495 "select * from issues
2496 where (borrowernumber = ?)
2497 and (itemnumber = ?)"
2499 $sth->execute( $bornum, $itemno );
2500 my $data = $sth->fetchrow_hashref;
2501 $renewcount = $data->{'renewals'} if $data->{'renewals'};
2503 # $item and $borrower should be calculated
2504 my $branchcode = _GetCircControlBranch($item, $borrower);
2506 my $issuingrule = GetIssuingRule($borrower->{categorycode}, $item->{itype}, $branchcode);
2508 $renewsallowed = $issuingrule->{'renewalsallowed'};
2509 $renewsleft = $renewsallowed - $renewcount;
2510 if($renewsleft < 0){ $renewsleft = 0; }
2511 return ( $renewcount, $renewsallowed, $renewsleft );
2514 =head2 GetIssuingCharges
2516 ($charge, $item_type) = &GetIssuingCharges($itemnumber, $borrowernumber);
2518 Calculate how much it would cost for a given patron to borrow a given
2519 item, including any applicable discounts.
2521 C<$itemnumber> is the item number of item the patron wishes to borrow.
2523 C<$borrowernumber> is the patron's borrower number.
2525 C<&GetIssuingCharges> returns two values: C<$charge> is the rental charge,
2526 and C<$item_type> is the code for the item's item type (e.g., C<VID>
2531 sub GetIssuingCharges {
2533 # calculate charges due
2534 my ( $itemnumber, $borrowernumber ) = @_;
2536 my $dbh = C4::Context->dbh;
2539 # Get the book's item type and rental charge (via its biblioitem).
2540 my $charge_query = 'SELECT itemtypes.itemtype,rentalcharge FROM items
2541 LEFT JOIN biblioitems ON biblioitems.biblioitemnumber = items.biblioitemnumber';
2542 $charge_query .= (C4::Context->preference('item-level_itypes'))
2543 ? ' LEFT JOIN itemtypes ON items.itype = itemtypes.itemtype'
2544 : ' LEFT JOIN itemtypes ON biblioitems.itemtype = itemtypes.itemtype';
2546 $charge_query .= ' WHERE items.itemnumber =?';
2548 my $sth = $dbh->prepare($charge_query);
2549 $sth->execute($itemnumber);
2550 if ( my $item_data = $sth->fetchrow_hashref ) {
2551 $item_type = $item_data->{itemtype};
2552 $charge = $item_data->{rentalcharge};
2553 my $branch = C4::Branch::mybranch();
2554 my $discount_query = q|SELECT rentaldiscount,
2555 issuingrules.itemtype, issuingrules.branchcode
2557 LEFT JOIN issuingrules ON borrowers.categorycode = issuingrules.categorycode
2558 WHERE borrowers.borrowernumber = ?
2559 AND (issuingrules.itemtype = ? OR issuingrules.itemtype = '*')
2560 AND (issuingrules.branchcode = ? OR issuingrules.branchcode = '*')|;
2561 my $discount_sth = $dbh->prepare($discount_query);
2562 $discount_sth->execute( $borrowernumber, $item_type, $branch );
2563 my $discount_rules = $discount_sth->fetchall_arrayref({});
2564 if (@{$discount_rules}) {
2565 # We may have multiple rules so get the most specific
2566 my $discount = _get_discount_from_rule($discount_rules, $branch, $item_type);
2567 $charge = ( $charge * ( 100 - $discount ) ) / 100;
2571 $sth->finish; # we havent _explicitly_ fetched all rows
2572 return ( $charge, $item_type );
2575 # Select most appropriate discount rule from those returned
2576 sub _get_discount_from_rule {
2577 my ($rules_ref, $branch, $itemtype) = @_;
2580 if (@{$rules_ref} == 1) { # only 1 applicable rule use it
2581 $discount = $rules_ref->[0]->{rentaldiscount};
2582 return (defined $discount) ? $discount : 0;
2584 # could have up to 4 does one match $branch and $itemtype
2585 my @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq $itemtype } @{$rules_ref};
2587 $discount = $d[0]->{rentaldiscount};
2588 return (defined $discount) ? $discount : 0;
2590 # do we have item type + all branches
2591 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq $itemtype } @{$rules_ref};
2593 $discount = $d[0]->{rentaldiscount};
2594 return (defined $discount) ? $discount : 0;
2596 # do we all item types + this branch
2597 @d = grep { $_->{branchcode} eq $branch && $_->{itemtype} eq q{*} } @{$rules_ref};
2599 $discount = $d[0]->{rentaldiscount};
2600 return (defined $discount) ? $discount : 0;
2602 # so all and all (surely we wont get here)
2603 @d = grep { $_->{branchcode} eq q{*} && $_->{itemtype} eq q{*} } @{$rules_ref};
2605 $discount = $d[0]->{rentaldiscount};
2606 return (defined $discount) ? $discount : 0;
2612 =head2 AddIssuingCharge
2614 &AddIssuingCharge( $itemno, $borrowernumber, $charge )
2618 sub AddIssuingCharge {
2619 my ( $itemnumber, $borrowernumber, $charge ) = @_;
2620 my $dbh = C4::Context->dbh;
2621 my $nextaccntno = getnextacctno( $borrowernumber );
2623 $manager_id = C4::Context->userenv->{'number'} if C4::Context->userenv;
2625 INSERT INTO accountlines
2626 (borrowernumber, itemnumber, accountno,
2627 date, amount, description, accounttype,
2628 amountoutstanding, manager_id)
2629 VALUES (?, ?, ?,now(), ?, 'Rental', 'Rent',?,?)
2631 my $sth = $dbh->prepare($query);
2632 $sth->execute( $borrowernumber, $itemnumber, $nextaccntno, $charge, $charge, $manager_id );
2638 GetTransfers($itemnumber);
2643 my ($itemnumber) = @_;
2645 my $dbh = C4::Context->dbh;
2651 FROM branchtransfers
2652 WHERE itemnumber = ?
2653 AND datearrived IS NULL
2655 my $sth = $dbh->prepare($query);
2656 $sth->execute($itemnumber);
2657 my @row = $sth->fetchrow_array();
2662 =head2 GetTransfersFromTo
2664 @results = GetTransfersFromTo($frombranch,$tobranch);
2666 Returns the list of pending transfers between $from and $to branch
2670 sub GetTransfersFromTo {
2671 my ( $frombranch, $tobranch ) = @_;
2672 return unless ( $frombranch && $tobranch );
2673 my $dbh = C4::Context->dbh;
2675 SELECT itemnumber,datesent,frombranch
2676 FROM branchtransfers
2679 AND datearrived IS NULL
2681 my $sth = $dbh->prepare($query);
2682 $sth->execute( $frombranch, $tobranch );
2685 while ( my $data = $sth->fetchrow_hashref ) {
2686 push @gettransfers, $data;
2689 return (@gettransfers);
2692 =head2 DeleteTransfer
2694 &DeleteTransfer($itemnumber);
2698 sub DeleteTransfer {
2699 my ($itemnumber) = @_;
2700 my $dbh = C4::Context->dbh;
2701 my $sth = $dbh->prepare(
2702 "DELETE FROM branchtransfers
2704 AND datearrived IS NULL "
2706 $sth->execute($itemnumber);
2710 =head2 AnonymiseIssueHistory
2712 $rows = AnonymiseIssueHistory($date,$borrowernumber)
2714 This function write NULL instead of C<$borrowernumber> given on input arg into the table issues.
2715 if C<$borrowernumber> is not set, it will delete the issue history for all borrower older than C<$date>.
2717 If c<$borrowernumber> is set, it will delete issue history for only that borrower, regardless of their opac privacy
2718 setting (force delete).
2720 return the number of affected rows.
2724 sub AnonymiseIssueHistory {
2726 my $borrowernumber = shift;
2727 my $dbh = C4::Context->dbh;
2730 SET borrowernumber = ?
2731 WHERE returndate < ?
2732 AND borrowernumber IS NOT NULL
2735 # The default of 0 does not work due to foreign key constraints
2736 # The anonymisation will fail quietly if AnonymousPatron is not a valid entry
2737 my $anonymouspatron = (C4::Context->preference('AnonymousPatron')) ? C4::Context->preference('AnonymousPatron') : 0;
2738 my @bind_params = ($anonymouspatron, $date);
2739 if (defined $borrowernumber) {
2740 $query .= " AND borrowernumber = ?";
2741 push @bind_params, $borrowernumber;
2743 $query .= " AND (SELECT privacy FROM borrowers WHERE borrowers.borrowernumber=old_issues.borrowernumber) <> 0";
2745 my $sth = $dbh->prepare($query);
2746 $sth->execute(@bind_params);
2747 my $rows_affected = $sth->rows; ### doublecheck row count return function
2748 return $rows_affected;
2751 =head2 SendCirculationAlert
2753 Send out a C<check-in> or C<checkout> alert using the messaging system.
2761 Valid values for this parameter are: C<CHECKIN> and C<CHECKOUT>.
2765 Hashref of information about the item being checked in or out.
2769 Hashref of information about the borrower of the item.
2773 The branchcode from where the checkout or check-in took place.
2779 SendCirculationAlert({
2782 borrower => $borrower,
2788 sub SendCirculationAlert {
2790 my ($type, $item, $borrower, $branch) =
2791 ($opts->{type}, $opts->{item}, $opts->{borrower}, $opts->{branch});
2792 my %message_name = (
2793 CHECKIN => 'Item_Check_in',
2794 CHECKOUT => 'Item_Checkout',
2796 my $borrower_preferences = C4::Members::Messaging::GetMessagingPreferences({
2797 borrowernumber => $borrower->{borrowernumber},
2798 message_name => $message_name{$type},
2800 my $issues_table = ( $type eq 'CHECKOUT' ) ? 'issues' : 'old_issues';
2801 my $letter = C4::Letters::GetPreparedLetter (
2802 module => 'circulation',
2803 letter_code => $type,
2804 branchcode => $branch,
2806 $issues_table => $item->{itemnumber},
2807 'items' => $item->{itemnumber},
2808 'biblio' => $item->{biblionumber},
2809 'biblioitems' => $item->{biblionumber},
2810 'borrowers' => $borrower,
2811 'branches' => $branch,
2815 my @transports = keys %{ $borrower_preferences->{transports} };
2816 # warn "no transports" unless @transports;
2818 # warn "transport: $_";
2819 my $message = C4::Message->find_last_message($borrower, $type, $_);
2821 #warn "create new message";
2822 C4::Message->enqueue($letter, $borrower, $_);
2824 #warn "append to old message";
2825 $message->append($letter);
2833 =head2 updateWrongTransfer
2835 $items = updateWrongTransfer($itemNumber,$borrowernumber,$waitingAtLibrary,$FromLibrary);
2837 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
2841 sub updateWrongTransfer {
2842 my ( $itemNumber,$waitingAtLibrary,$FromLibrary ) = @_;
2843 my $dbh = C4::Context->dbh;
2844 # first step validate the actual line of transfert .
2847 "update branchtransfers set datearrived = now(),tobranch=?,comments='wrongtransfer' where itemnumber= ? AND datearrived IS NULL"
2849 $sth->execute($FromLibrary,$itemNumber);
2852 # second step create a new line of branchtransfer to the right location .
2853 ModItemTransfer($itemNumber, $FromLibrary, $waitingAtLibrary);
2855 #third step changing holdingbranch of item
2856 UpdateHoldingbranch($FromLibrary,$itemNumber);
2859 =head2 UpdateHoldingbranch
2861 $items = UpdateHoldingbranch($branch,$itmenumber);
2863 Simple methode for updating hodlingbranch in items BDD line
2867 sub UpdateHoldingbranch {
2868 my ( $branch,$itemnumber ) = @_;
2869 ModItem({ holdingbranch => $branch }, undef, $itemnumber);
2874 $newdatedue = CalcDateDue($startdate,$itemtype,$branchcode,$borrower);
2876 this function calculates the due date given the start date and configured circulation rules,
2877 checking against the holidays calendar as per the 'useDaysMode' syspref.
2878 C<$startdate> = C4::Dates object representing start date of loan period (assumed to be today)
2879 C<$itemtype> = itemtype code of item in question
2880 C<$branch> = location whose calendar to use
2881 C<$borrower> = Borrower object
2886 my ( $startdate, $itemtype, $branch, $borrower ) = @_;
2888 # loanlength now a href
2890 GetLoanLength( $borrower->{'categorycode'}, $itemtype, $branch );
2894 # if globalDueDate ON the datedue is set to that date
2895 if (C4::Context->preference('globalDueDate')
2896 && ( C4::Context->preference('globalDueDate') =~
2897 C4::Dates->regexp('syspref') )
2899 $datedue = dt_from_string(
2900 C4::Context->preference('globalDueDate'),
2901 C4::Context->preference('dateformat')
2905 # otherwise, calculate the datedue as normal
2906 if ( C4::Context->preference('useDaysMode') eq 'Days' )
2907 { # ignoring calendar
2909 DateTime->now( time_zone => C4::Context->tz() )
2910 ->truncate( to => 'minute' );
2911 if ( $loanlength->{lengthunit} eq 'hours' ) {
2912 $dt->add( hours => $loanlength->{issuelength} );
2915 $dt->add( days => $loanlength->{issuelength} );
2917 $dt->set_minute(59);
2922 if ($loanlength->{lengthunit} eq 'hours') {
2923 $dur = DateTime::Duration->new( hours => $loanlength->{issuelength});
2926 $dur = DateTime::Duration->new( days => $loanlength->{issuelength});
2928 if (ref $startdate ne 'DateTime' ) {
2929 $startdate = dt_from_string($startdate);
2931 my $calendar = Koha::Calendar->new( branchcode => $branch );
2932 $datedue = $calendar->addDate( $startdate, $dur, $loanlength->{lengthunit} );
2933 if ($loanlength->{lengthunit} eq 'days') {
2934 $datedue->set_hour(23);
2935 $datedue->set_minute(59);
2940 # if Hard Due Dates are used, retreive them and apply as necessary
2941 my ( $hardduedate, $hardduedatecompare ) =
2942 GetHardDueDate( $borrower->{'categorycode'}, $itemtype, $branch );
2943 if ($hardduedate) { # hardduedates are currently dates
2944 $hardduedate->truncate( to => 'minute' );
2945 $hardduedate->set_hour(23);
2946 $hardduedate->set_minute(59);
2947 my $cmp = DateTime->compare( $hardduedate, $datedue );
2949 # if the calculated due date is after the 'before' Hard Due Date (ceiling), override
2950 # if the calculated date is before the 'after' Hard Due Date (floor), override
2951 # if the hard due date is set to 'exactly', overrride
2952 if ( $hardduedatecompare == 0 || $hardduedatecompare == $cmp ) {
2953 $datedue = $hardduedate->clone;
2956 # in all other cases, keep the date due as it is
2959 # if ReturnBeforeExpiry ON the datedue can't be after borrower expirydate
2960 if ( C4::Context->preference('ReturnBeforeExpiry') ) {
2961 my $expiry_dt = dt_from_string( $borrower->{dateexpiry}, 'iso' );
2962 if ( DateTime->compare( $datedue, $expiry_dt ) == 1 ) {
2963 $datedue = $expiry_dt->clone;
2971 =head2 CheckRepeatableHolidays
2973 $countrepeatable = CheckRepeatableHoliday($itemnumber,$week_day,$branchcode);
2975 This function checks if the date due is a repeatable holiday
2977 C<$date_due> = returndate calculate with no day check
2978 C<$itemnumber> = itemnumber
2979 C<$branchcode> = localisation of issue
2983 sub CheckRepeatableHolidays{
2984 my($itemnumber,$week_day,$branchcode)=@_;
2985 my $dbh = C4::Context->dbh;
2986 my $query = qq|SELECT count(*)
2987 FROM repeatable_holidays
2990 my $sth = $dbh->prepare($query);
2991 $sth->execute($branchcode,$week_day);
2992 my $result=$sth->fetchrow;
2998 =head2 CheckSpecialHolidays
3000 $countspecial = CheckSpecialHolidays($years,$month,$day,$itemnumber,$branchcode);
3002 This function check if the date is a special holiday
3004 C<$years> = the years of datedue
3005 C<$month> = the month of datedue
3006 C<$day> = the day of datedue
3007 C<$itemnumber> = itemnumber
3008 C<$branchcode> = localisation of issue
3012 sub CheckSpecialHolidays{
3013 my ($years,$month,$day,$itemnumber,$branchcode) = @_;
3014 my $dbh = C4::Context->dbh;
3015 my $query=qq|SELECT count(*)
3016 FROM `special_holidays`
3022 my $sth = $dbh->prepare($query);
3023 $sth->execute($years,$month,$day,$branchcode);
3024 my $countspecial=$sth->fetchrow ;
3026 return $countspecial;
3029 =head2 CheckRepeatableSpecialHolidays
3031 $countspecial = CheckRepeatableSpecialHolidays($month,$day,$itemnumber,$branchcode);
3033 This function check if the date is a repeatble special holidays
3035 C<$month> = the month of datedue
3036 C<$day> = the day of datedue
3037 C<$itemnumber> = itemnumber
3038 C<$branchcode> = localisation of issue
3042 sub CheckRepeatableSpecialHolidays{
3043 my ($month,$day,$itemnumber,$branchcode) = @_;
3044 my $dbh = C4::Context->dbh;
3045 my $query=qq|SELECT count(*)
3046 FROM `repeatable_holidays`
3051 my $sth = $dbh->prepare($query);
3052 $sth->execute($month,$day,$branchcode);
3053 my $countspecial=$sth->fetchrow ;
3055 return $countspecial;
3060 sub CheckValidBarcode{
3062 my $dbh = C4::Context->dbh;
3063 my $query=qq|SELECT count(*)
3067 my $sth = $dbh->prepare($query);
3068 $sth->execute($barcode);
3069 my $exist=$sth->fetchrow ;
3074 =head2 IsBranchTransferAllowed
3076 $allowed = IsBranchTransferAllowed( $toBranch, $fromBranch, $code );
3078 Code is either an itemtype or collection doe depending on the pref BranchTransferLimitsType
3082 sub IsBranchTransferAllowed {
3083 my ( $toBranch, $fromBranch, $code ) = @_;
3085 if ( $toBranch eq $fromBranch ) { return 1; } ## Short circuit for speed.
3087 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3088 my $dbh = C4::Context->dbh;
3090 my $sth = $dbh->prepare("SELECT * FROM branch_transfer_limits WHERE toBranch = ? AND fromBranch = ? AND $limitType = ?");
3091 $sth->execute( $toBranch, $fromBranch, $code );
3092 my $limit = $sth->fetchrow_hashref();
3094 ## If a row is found, then that combination is not allowed, if no matching row is found, then the combination *is allowed*
3095 if ( $limit->{'limitId'} ) {
3102 =head2 CreateBranchTransferLimit
3104 CreateBranchTransferLimit( $toBranch, $fromBranch, $code );
3106 $code is either itemtype or collection code depending on what the pref BranchTransferLimitsType is set to.
3110 sub CreateBranchTransferLimit {
3111 my ( $toBranch, $fromBranch, $code ) = @_;
3113 my $limitType = C4::Context->preference("BranchTransferLimitsType");
3115 my $dbh = C4::Context->dbh;
3117 my $sth = $dbh->prepare("INSERT INTO branch_transfer_limits ( $limitType, toBranch, fromBranch ) VALUES ( ?, ?, ? )");
3118 $sth->execute( $code, $toBranch, $fromBranch );
3121 =head2 DeleteBranchTransferLimits
3123 DeleteBranchTransferLimits($frombranch);
3125 Deletes all the branch transfer limits for one branch
3129 sub DeleteBranchTransferLimits {
3131 my $dbh = C4::Context->dbh;
3132 my $sth = $dbh->prepare("DELETE FROM branch_transfer_limits WHERE fromBranch = ?");
3133 $sth->execute($branch);
3137 my ( $borrowernumber, $itemnum ) = @_;
3139 MarkIssueReturned( $borrowernumber, $itemnum );
3140 my $borrower = C4::Members::GetMember( 'borrowernumber'=>$borrowernumber );
3141 my $item = C4::Items::GetItem( $itemnum );
3142 my $old_note = ($item->{'paidfor'} && ($item->{'paidfor'} ne q{})) ? $item->{'paidfor'}.' / ' : q{};
3143 my @datearr = localtime(time);
3144 my $date = ( 1900 + $datearr[5] ) . "-" . ( $datearr[4] + 1 ) . "-" . $datearr[3];
3145 my $bor = "$borrower->{'firstname'} $borrower->{'surname'} $borrower->{'cardnumber'}";
3146 ModItem({ paidfor => $old_note."Paid for by $bor $date" }, undef, $itemnum);
3151 my ($itemnumber, $mark_returned, $charge_fee) = @_;
3153 my $dbh = C4::Context->dbh();
3154 my $sth=$dbh->prepare("SELECT issues.*,items.*,biblio.title
3156 JOIN items USING (itemnumber)
3157 JOIN biblio USING (biblionumber)
3158 WHERE issues.itemnumber=?");
3159 $sth->execute($itemnumber);
3160 my $issues=$sth->fetchrow_hashref();
3163 # if a borrower lost the item, add a replacement cost to the their record
3164 if ( my $borrowernumber = $issues->{borrowernumber} ){
3165 my $borrower = C4::Members::GetMemberDetails( $borrowernumber );
3167 C4::Accounts::chargelostitem($borrowernumber, $itemnumber, $issues->{'replacementprice'}, "Lost Item $issues->{'title'} $issues->{'barcode'}")
3169 #FIXME : Should probably have a way to distinguish this from an item that really was returned.
3170 #warn " $issues->{'borrowernumber'} / $itemnumber ";
3171 MarkIssueReturned($borrowernumber,$itemnumber,undef,undef,$borrower->{'privacy'}) if $mark_returned;
3175 sub GetOfflineOperations {
3176 my $dbh = C4::Context->dbh;
3177 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE branchcode=? ORDER BY timestamp");
3178 $sth->execute(C4::Context->userenv->{'branch'});
3179 my $results = $sth->fetchall_arrayref({});
3184 sub GetOfflineOperation {
3185 my $dbh = C4::Context->dbh;
3186 my $sth = $dbh->prepare("SELECT * FROM pending_offline_operations WHERE operationid=?");
3187 $sth->execute( shift );
3188 my $result = $sth->fetchrow_hashref;
3193 sub AddOfflineOperation {
3194 my $dbh = C4::Context->dbh;
3195 my $sth = $dbh->prepare("INSERT INTO pending_offline_operations (userid, branchcode, timestamp, action, barcode, cardnumber) VALUES(?,?,?,?,?,?)");
3196 $sth->execute( @_ );
3200 sub DeleteOfflineOperation {
3201 my $dbh = C4::Context->dbh;
3202 my $sth = $dbh->prepare("DELETE FROM pending_offline_operations WHERE operationid=?");
3203 $sth->execute( shift );
3207 sub ProcessOfflineOperation {
3208 my $operation = shift;
3211 if ( $operation->{action} eq 'return' ) {
3212 $report = ProcessOfflineReturn( $operation );
3213 } elsif ( $operation->{action} eq 'issue' ) {
3214 $report = ProcessOfflineIssue( $operation );
3217 DeleteOfflineOperation( $operation->{operationid} ) if $operation->{operationid};
3222 sub ProcessOfflineReturn {
3223 my $operation = shift;
3225 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3227 if ( $itemnumber ) {
3228 my $issue = GetOpenIssue( $itemnumber );
3231 $issue->{borrowernumber},
3234 $operation->{timestamp},
3237 { renewals => 0, onloan => undef },
3238 $issue->{'biblionumber'},
3243 return "Item not issued.";
3246 return "Item not found.";
3250 sub ProcessOfflineIssue {
3251 my $operation = shift;
3253 my $borrower = C4::Members::GetMemberDetails( undef, $operation->{cardnumber} ); # Get borrower from operation cardnumber
3255 if ( $borrower->{borrowernumber} ) {
3256 my $itemnumber = C4::Items::GetItemnumberFromBarcode( $operation->{barcode} );
3257 unless ($itemnumber) {
3258 return "Barcode not found.";
3260 my $issue = GetOpenIssue( $itemnumber );
3262 if ( $issue and ( $issue->{borrowernumber} ne $borrower->{borrowernumber} ) ) { # Item already issued to another borrower, mark it returned
3264 $issue->{borrowernumber},
3267 $operation->{timestamp},
3272 $operation->{'barcode'},
3275 $operation->{timestamp},
3280 return "Borrower not found.";
3288 TransferSlip($user_branch, $itemnumber, $to_branch)
3290 Returns letter hash ( see C4::Letters::GetPreparedLetter ) or undef
3295 my ($branch, $itemnumber, $to_branch) = @_;
3297 my $item = GetItem( $itemnumber )
3300 my $pulldate = C4::Dates->new();
3302 return C4::Letters::GetPreparedLetter (
3303 module => 'circulation',
3304 letter_code => 'TRANSFERSLIP',
3305 branchcode => $branch,
3307 'branches' => $to_branch,
3308 'biblio' => $item->{biblionumber},
3321 Koha Development Team <http://koha-community.org/>