#
# This file is part of Koha.
#
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
#
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
use strict;
#use warnings; FIXME - Bug 2505
use Date::Calc qw/Today Date_to_Days/;
use Date::Manip qw/UnixDate/;
use List::MoreUtils qw( uniq );
+use POSIX qw( floor ceil );
+use Locale::Currency::Format 1.28;
+use Carp;
use C4::Circulation;
use C4::Context;
use C4::Accounts;
use C4::Log; # logaction
use C4::Debug;
+use Koha::DateUtils;
+use Koha::Account::Line;
+use Koha::Account::Lines;
-use vars qw($VERSION @ISA @EXPORT);
+use vars qw(@ISA @EXPORT);
BEGIN {
- # set the version for version checking
- $VERSION = 3.07.00.049;
- require Exporter;
- @ISA = qw(Exporter);
- # subs to rename (and maybe merge some...)
- push @EXPORT, qw(
- &CalcFine
- &Getoverdues
- &checkoverdues
- &NumberNotifyId
- &AmountNotify
- &UpdateFine
- &GetFine
-
- &CheckItemNotify
- &GetOverduesForBranch
- &RemoveNotifyLine
- &AddNotifyLine
- &GetOverdueMessageTransportTypes
- );
- # subs to remove
- push @EXPORT, qw(
- &BorType
- );
-
- # check that an equivalent don't exist already before moving
-
- # subs to move to Circulation.pm
- push @EXPORT, qw(
- &GetIssuesIteminfo
- );
-
- # &GetIssuingRules - delete.
- # use C4::Circulation::GetIssuingRule instead.
-
- # subs to move to Biblio.pm
- push @EXPORT, qw(
- &GetItems
- );
+ require Exporter;
+ @ISA = qw(Exporter);
+
+ # subs to rename (and maybe merge some...)
+ push @EXPORT, qw(
+ &CalcFine
+ &Getoverdues
+ &checkoverdues
+ &NumberNotifyId
+ &AmountNotify
+ &UpdateFine
+ &GetFine
+ &get_chargeable_units
+ &CheckItemNotify
+ &GetOverduesForBranch
+ &RemoveNotifyLine
+ &AddNotifyLine
+ &GetOverdueMessageTransportTypes
+ &parse_overdues_letter
+ );
+
+ # subs to remove
+ push @EXPORT, qw(
+ &BorType
+ );
+
+ # check that an equivalent don't exist already before moving
+
+ # subs to move to Circulation.pm
+ push @EXPORT, qw(
+ &GetIssuesIteminfo
+ );
+
+ # &GetIssuingRules - delete.
+ # use C4::Circulation::GetIssuingRule instead.
+
+ # subs to move to Biblio.pm
+ push @EXPORT, qw(
+ &GetItems
+ );
}
=head1 NAME
my $statement;
if ( C4::Context->preference('item-level_itypes') ) {
$statement = "
- SELECT issues.*, items.itype as itemtype, items.homebranch, items.barcode
+ SELECT issues.*, items.itype as itemtype, items.homebranch, items.barcode, items.itemlost, items.replacementprice
FROM issues
LEFT JOIN items USING (itemnumber)
WHERE date_due < NOW()
";
} else {
$statement = "
- SELECT issues.*, biblioitems.itemtype, items.itype, items.homebranch, items.barcode
+ SELECT issues.*, biblioitems.itemtype, items.itype, items.homebranch, items.barcode, items.itemlost, replacementprice
FROM issues
LEFT JOIN items USING (itemnumber)
LEFT JOIN biblioitems USING (biblioitemnumber)
=head2 CalcFine
- ($amount, $chargename, $daycounttotal) = &CalcFine($item,
+ ($amount, $chargename, $units_minus_grace, $chargeable_units) = &CalcFine($item,
$categorycode, $branch,
$start_dt, $end_dt );
C<$chargename> is the chargename field from the applicable record in
the categoryitem table, whatever that is.
-C<$unitcount> is the number of chargeable units (days between start and end dates, Calendar adjusted where needed,
-minus any applicable grace period, or hours)
+C<$units_minus_grace> is the number of chargeable units minus the grace period
-FIXME - What is chargename supposed to be ?
+C<$chargeable_units> is the number of chargeable units (days between start and end dates, Calendar adjusted where needed,
+minus any applicable grace period, or hours)
FIXME: previously attempted to return C<$message> as a text message, either "First Notice", "Second Notice",
or "Final Notice". But CalcFine never defined any value.
my $fine_unit = $data->{lengthunit};
$fine_unit ||= 'days';
- my $chargeable_units = _get_chargeable_units($fine_unit, $start_date, $end_date, $branchcode);
+ my $chargeable_units = get_chargeable_units($fine_unit, $start_date, $end_date, $branchcode);
my $units_minus_grace = $chargeable_units - $data->{firstremind};
my $amount = 0;
- if ($data->{'chargeperiod'} && ($units_minus_grace > 0) ) {
- if ( C4::Context->preference('FinesIncludeGracePeriod') ) {
- $amount = int($chargeable_units / $data->{'chargeperiod'}) * $data->{'fine'};# TODO fine calc should be in cents
- } else {
- $amount = int($units_minus_grace / $data->{'chargeperiod'}) * $data->{'fine'};
- }
- } else {
- # a zero (or null) chargeperiod or negative units_minus_grace value means no charge.
- }
+ if ( $data->{'chargeperiod'} && ( $units_minus_grace > 0 ) ) {
+ my $units = C4::Context->preference('FinesIncludeGracePeriod') ? $chargeable_units : $units_minus_grace;
+ my $charge_periods = $units / $data->{'chargeperiod'};
+ # If chargeperiod_charge_at = 1, we charge a fine at the start of each charge period
+ # if chargeperiod_charge_at = 0, we charge at the end of each charge period
+ $charge_periods = $data->{'chargeperiod_charge_at'} == 1 ? ceil($charge_periods) : floor($charge_periods);
+ $amount = $charge_periods * $data->{'fine'};
+ } # else { # a zero (or null) chargeperiod or negative units_minus_grace value means no charge. }
+
$amount = $data->{overduefinescap} if $data->{overduefinescap} && $amount > $data->{overduefinescap};
+ $amount = $item->{replacementprice} if ( $data->{cap_fine_to_replacement_price} && $item->{replacementprice} && $amount > $item->{replacementprice} );
$debug and warn sprintf("CalcFine returning (%s, %s, %s, %s)", $amount, $data->{'chargename'}, $units_minus_grace, $chargeable_units);
return ($amount, $data->{'chargename'}, $units_minus_grace, $chargeable_units);
# FIXME: chargename is NEVER populated anywhere.
}
-=head2 _get_chargeable_units
+=head2 get_chargeable_units
- _get_chargeable_units($unit, $start_date_ $end_date, $branchcode);
+ get_chargeable_units($unit, $start_date_ $end_date, $branchcode);
return integer value of units between C<$start_date> and C<$end_date>, factoring in holidays for C<$branchcode>.
=cut
-sub _get_chargeable_units {
+sub get_chargeable_units {
my ($unit, $date_due, $date_returned, $branchcode) = @_;
# If the due date is later than the return date
=head2 UpdateFine
- &UpdateFine($itemnumber, $borrowernumber, $amount, $type, $description);
+ &UpdateFine({ issue_id => $issue_id, itemnumber => $itemnumber, borrwernumber => $borrowernumber, amount => $amount, type => $type, $due => $date_due });
(Note: the following is mostly conjecture and guesswork.)
C<$type> will be used in the description of the fine.
-C<$description> is a string that must be present in the description of
-the fine. I think this is expected to be a date in DD/MM/YYYY format.
+C<$due> is the due date formatted to the currently specified date format
C<&UpdateFine> looks up the amount currently owed on the given item
and sets it to C<$amount>, creating, if necessary, a new entry in the
# Possible Answer: You might update a fine for a damaged item, *after* it is returned.
#
sub UpdateFine {
- my ( $itemnum, $borrowernumber, $amount, $type, $due ) = @_;
- $debug and warn "UpdateFine($itemnum, $borrowernumber, $amount, " . ($type||'""') . ", $due) called";
+ my ($params) = @_;
+
+ my $issue_id = $params->{issue_id};
+ my $itemnum = $params->{itemnumber};
+ my $borrowernumber = $params->{borrowernumber};
+ my $amount = $params->{amount};
+ my $type = $params->{type};
+ my $due = $params->{due};
+
+ $debug and warn "UpdateFine({ itemnumber => $itemnum, borrowernumber => $borrowernumber, type => $type, due => $due, issue_id => $issue_id})";
+
+ unless ( $issue_id ) {
+ carp("No issue_id passed in!");
+ return;
+ }
+
my $dbh = C4::Context->dbh;
# FIXME - What exactly is this query supposed to do? It looks up an
# entry in accountlines that matches the given item and borrower
# account type has one of several values, but what does this _mean_?
# Does it look up existing fines for this item?
# FIXME - What are these various account types? ("FU", "O", "F", "M")
- # "L" is LOST item
- # "A" is Account Management Fee
- # "N" is New Card
- # "M" is Sundry
- # "O" is Overdue ??
- # "F" is Fine ??
- # "FU" is Fine UPDATE??
- # "Pay" is Payment
- # "REF" is Cash Refund
+ # "L" is LOST item
+ # "A" is Account Management Fee
+ # "N" is New Card
+ # "M" is Sundry
+ # "O" is Overdue ??
+ # "F" is Fine ??
+ # "FU" is Fine UPDATE??
+ # "Pay" is Payment
+ # "REF" is Cash Refund
my $sth = $dbh->prepare(
"SELECT * FROM accountlines
WHERE borrowernumber=?
# - accumulate fines for other items
# so we can update $itemnum fine taking in account fine caps
while (my $rec = $sth->fetchrow_hashref) {
- if ($rec->{itemnumber} == $itemnum && $rec->{description} =~ /$due_qr/) {
+ if ( $rec->{issue_id} == $issue_id ) {
if ($data) {
- warn "Not a unique accountlines record for item $itemnum borrower $borrowernumber";
- } else {
+ warn "Not a unique accountlines record for issue_id $issue_id";
+ }
+ else {
$data = $rec;
next;
}
}
if ( $data ) {
-
- # we're updating an existing fine. Only modify if amount changed
+ # we're updating an existing fine. Only modify if amount changed
# Note that in the current implementation, you cannot pay against an accruing fine
# (i.e. , of accounttype 'FU'). Doing so will break accrual.
- if ( $data->{'amount'} != $amount ) {
+ if ( $data->{'amount'} != $amount ) {
+ my $accountline = Koha::Account::Lines->find( $data->{accountlines_id} );
my $diff = $amount - $data->{'amount'};
- #3341: diff could be positive or negative!
- my $out = $data->{'amountoutstanding'} + $diff;
- my $query = "
- UPDATE accountlines
- SET date=now(), amount=?, amountoutstanding=?,
- lastincrement=?, accounttype='FU'
- WHERE borrowernumber=?
- AND itemnumber=?
- AND accounttype IN ('FU','O')
- AND description LIKE ?
- LIMIT 1 ";
- my $sth2 = $dbh->prepare($query);
- # FIXME: BOGUS query cannot ensure uniqueness w/ LIKE %x% !!!
- # LIMIT 1 added to prevent multiple affected lines
- # FIXME: accountlines table needs unique key!! Possibly a combo of borrowernumber and accountline.
- # But actually, we should just have a regular autoincrementing PK and forget accountline,
- # including the bogus getnextaccountno function (doesn't prevent conflict on simultaneous ops).
- # FIXME: Why only 2 account types here?
- $debug and print STDERR "UpdateFine query: $query\n" .
- "w/ args: $amount, $out, $diff, $data->{'borrowernumber'}, $data->{'itemnumber'}, \"\%$due\%\"\n";
- $sth2->execute($amount, $out, $diff, $data->{'borrowernumber'}, $data->{'itemnumber'}, "%$due%");
- } else {
- # print "no update needed $data->{'amount'}"
+
+ #3341: diff could be positive or negative!
+ my $out = $data->{'amountoutstanding'} + $diff;
+
+ $accountline->set(
+ {
+ date => dt_from_string(),
+ amount => $amount,
+ outstanding => $out,
+ lastincrement => $diff,
+ accounttype => 'FU',
+ }
+ )->store();
}
} else {
- my $sth4 = $dbh->prepare(
- "SELECT title FROM biblio LEFT JOIN items ON biblio.biblionumber=items.biblionumber WHERE items.itemnumber=?"
- );
- $sth4->execute($itemnum);
- my $title = $sth4->fetchrow;
-
-# # print "not in account";
-# my $sth3 = $dbh->prepare("Select max(accountno) from accountlines");
-# $sth3->execute;
-#
-# # FIXME - Make $accountno a scalar.
-# my @accountno = $sth3->fetchrow_array;
-# $sth3->finish;
-# $accountno[0]++;
-# begin transaction
- my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
- my $desc = ($type ? "$type " : '') . "$title $due"; # FIXEDME, avoid whitespace prefix on empty $type
- my $query = "INSERT INTO accountlines
- (borrowernumber,itemnumber,date,amount,description,accounttype,amountoutstanding,lastincrement,accountno)
- VALUES (?,?,now(),?,?,'FU',?,?,?)";
- my $sth2 = $dbh->prepare($query);
- $debug and print STDERR "UpdateFine query: $query\nw/ args: $borrowernumber, $itemnum, $amount, $desc, $amount, $amount, $nextaccntno\n";
- $sth2->execute($borrowernumber, $itemnum, $amount, $desc, $amount, $amount, $nextaccntno);
+ if ( $amount ) { # Don't add new fines with an amount of 0
+ my $sth4 = $dbh->prepare(
+ "SELECT title FROM biblio LEFT JOIN items ON biblio.biblionumber=items.biblionumber WHERE items.itemnumber=?"
+ );
+ $sth4->execute($itemnum);
+ my $title = $sth4->fetchrow;
+
+ my $nextaccntno = C4::Accounts::getnextacctno($borrowernumber);
+
+ my $desc = ( $type ? "$type " : '' ) . "$title $due"; # FIXEDME, avoid whitespace prefix on empty $type
+
+ my $accountline = Koha::Account::Line->new(
+ {
+ borrowernumber => $borrowernumber,
+ itemnumber => $itemnum,
+ date => dt_from_string(),
+ amount => $amount,
+ description => $desc,
+ accounttype => 'FU',
+ amountoutstanding => $amount,
+ lastincrement => $amount,
+ accountno => $nextaccntno,
+ }
+ )->store();
+ }
}
# logging action
&logaction(
return unless $categorycode and $letternumber;
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("
- SELECT message_transport_type FROM overduerules_transport_types
- WHERE branchcode = ? AND categorycode = ? AND letternumber = ?
+ SELECT message_transport_type
+ FROM overduerules odr LEFT JOIN overduerules_transport_types ott USING (overduerules_id)
+ WHERE branchcode = ?
+ AND categorycode = ?
+ AND letternumber = ?
");
$sth->execute( $branchcode, $categorycode, $letternumber );
my @mtts;
return \@mtts;
}
+=head2 parse_overdues_letter
+
+parses the letter template, replacing the placeholders with data
+specific to this patron, biblio, or item for overdues
+
+named parameters:
+ letter - required hashref
+ borrowernumber - required integer
+ substitute - optional hashref of other key/value pairs that should
+ be substituted in the letter content
+
+returns the C<letter> hashref, with the content updated to reflect the
+substituted keys and values.
+
+=cut
+
+sub parse_overdues_letter {
+ my $params = shift;
+ foreach my $required (qw( letter_code borrowernumber )) {
+ return unless ( exists $params->{$required} && $params->{$required} );
+ }
+
+ my $substitute = $params->{'substitute'} || {};
+ $substitute->{today} ||= output_pref( { dt => dt_from_string, dateonly => 1} );
+
+ my %tables = ( 'borrowers' => $params->{'borrowernumber'} );
+ if ( my $p = $params->{'branchcode'} ) {
+ $tables{'branches'} = $p;
+ }
+
+ my $active_currency = Koha::Acquisition::Currencies->get_active;
+
+ my $currency_format;
+ $currency_format = $active_currency->currency if defined($active_currency);
+
+ my @item_tables;
+ if ( my $i = $params->{'items'} ) {
+ my $item_format = '';
+ foreach my $item (@$i) {
+ my $fine = GetFine($item->{'itemnumber'}, $params->{'borrowernumber'});
+ if ( !$item_format and defined $params->{'letter'}->{'content'} ) {
+ $params->{'letter'}->{'content'} =~ m/(<item>.*<\/item>)/;
+ $item_format = $1;
+ }
+
+ $item->{'fine'} = currency_format($currency_format, "$fine", FMT_SYMBOL);
+ # if active currency isn't correct ISO code fallback to sprintf
+ $item->{'fine'} = sprintf('%.2f', $fine) unless $item->{'fine'};
+
+ push @item_tables, {
+ 'biblio' => $item->{'biblionumber'},
+ 'biblioitems' => $item->{'biblionumber'},
+ 'items' => $item,
+ 'issues' => $item->{'itemnumber'},
+ };
+ }
+ }
+
+ return C4::Letters::GetPreparedLetter (
+ module => 'circulation',
+ letter_code => $params->{'letter_code'},
+ branchcode => $params->{'branchcode'},
+ tables => \%tables,
+ substitute => $substitute,
+ repeat => { item => \@item_tables },
+ message_transport_type => $params->{message_transport_type},
+ );
+}
+
1;
__END__