Right now, Koha only charges fines at the end of a given charge period.
For example, let us assume a circulation rule has a charge period of one
week ( 7 days ) and a fine of $5. This means that an item can be overdue
for 6 days without accruing a fine. Koha should allow circulation rules
to be configured to place the charge at the start of the end of the
charge period so the library can decide when the fine should accrue.
Test Plan:
1) Apply this patch
2) Run updatedatabase.pl
3) prove t/db_dependent/Circulation_Issuingrule.t
4) prove t/db_dependent/Circulation.t
5) prove t/db_dependent/Fines.t
6) Ensure you can still create/edit circulation rules
Edit: I removed the DBIx changes after a couple minutes fighting with them.
Will regenerate as usual in a RM followup / Tomas
Signed-off-by: Daniel Grobani <dgrobani@samuelmerritt.edu>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
use Date::Calc qw/Today Date_to_Days/;
use Date::Manip qw/UnixDate/;
use List::MoreUtils qw( uniq );
+use POSIX qw( floor ceil );
use C4::Circulation;
use C4::Context;
use vars qw($VERSION @ISA @EXPORT);
BEGIN {
- # set the version for version checking
+ # 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
- &get_chargeable_units
- &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
+ );
+
+ # 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 $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};
$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);
$maxsuspensiondays = undef if $maxsuspensiondays eq q||;
my $firstremind = $input->param('firstremind');
my $chargeperiod = $input->param('chargeperiod');
+ my $chargeperiod_charge_at = $input->param('chargeperiod_charge_at');
my $maxissueqty = $input->param('maxissueqty');
my $maxonsiteissueqty = $input->param('maxonsiteissueqty');
my $renewalsallowed = $input->param('renewalsallowed');
my $rs = $schema->resultset('Issuingrule');
my $params = {
- branchcode => $br,
- categorycode => $bor,
- itemtype => $itemtype,
- fine => $fine,
- finedays => $finedays,
- maxsuspensiondays => $maxsuspensiondays,
- firstremind => $firstremind,
- chargeperiod => $chargeperiod,
- maxissueqty => $maxissueqty,
- maxonsiteissueqty => $maxonsiteissueqty,
- renewalsallowed => $renewalsallowed,
- renewalperiod => $renewalperiod,
- norenewalbefore => $norenewalbefore,
- auto_renew => $auto_renew,
- reservesallowed => $reservesallowed,
- issuelength => $issuelength,
- lengthunit => $lengthunit,
- hardduedate => $hardduedate,
- hardduedatecompare => $hardduedatecompare,
- rentaldiscount => $rentaldiscount,
- onshelfholds => $onshelfholds,
- opacitemholds => $opacitemholds,
- overduefinescap => $overduefinescap,
+ branchcode => $br,
+ categorycode => $bor,
+ itemtype => $itemtype,
+ fine => $fine,
+ finedays => $finedays,
+ maxsuspensiondays => $maxsuspensiondays,
+ firstremind => $firstremind,
+ chargeperiod => $chargeperiod,
+ chargeperiod_charge_at => $chargeperiod_charge_at,
+ maxissueqty => $maxissueqty,
+ maxonsiteissueqty => $maxonsiteissueqty,
+ renewalsallowed => $renewalsallowed,
+ renewalperiod => $renewalperiod,
+ norenewalbefore => $norenewalbefore,
+ auto_renew => $auto_renew,
+ reservesallowed => $reservesallowed,
+ issuelength => $issuelength,
+ lengthunit => $lengthunit,
+ hardduedate => $hardduedate,
+ hardduedatecompare => $hardduedatecompare,
+ rentaldiscount => $rentaldiscount,
+ onshelfholds => $onshelfholds,
+ opacitemholds => $opacitemholds,
+ overduefinescap => $overduefinescap,
};
$rs->update_or_create($params);
--- /dev/null
+ALTER TABLE issuingrules ADD chargeperiod_charge_at BOOLEAN NOT NULL DEFAULT '0' AFTER chargeperiod;
`maxsuspensiondays` int(11) default NULL, -- max suspension days
`firstremind` int(11) default NULL, -- fine grace period
`chargeperiod` int(11) default NULL, -- how often the fine amount is charged
+ `chargeperiod_charge_at` tinyint(1) NOT NULL DEFAULT '0', -- Should fine be given at the start ( 1 ) or the end ( 0 ) of the period
`accountsent` int(11) default NULL, -- not used? always NULL
`chargename` varchar(100) default NULL, -- not used? always NULL
`maxissueqty` int(4) default NULL, -- total number of checkouts allowed
<th>Hard due date</th>
<th>Fine amount</th>
<th>Fine charging interval</th>
+ <th>Charge when?</th>
<th>Fine grace period</th>
<th>Overdue fines cap (amount)</th>
<th>Suspension in days (day)</th>
</td>
<td>[% rule.fine %]</td>
<td>[% rule.chargeperiod %]</td>
+ <td>[% IF rule.chargeperiod_charge_at %]Start of interval[% ELSE %]End of interval[% END %]</td>
<td>[% rule.firstremind %]</td>
<td>[% rule.overduefinescap FILTER format("%.2f") %]</td>
<td>[% rule.finedays %]</td>
</td>
<td><input type="text" name="fine" id="fine" size="4" /></td>
<td><input type="text" name="chargeperiod" id="chargeperiod" size="2" /></td>
+ <td>
+ <select name="chargeperiod_charge_at" id="chargeperiod_charge_at">
+ <option value="0">End of interval</option>
+ <option value="1">Start of interval</option>
+ </select>
+ </td>
<td><input type="text" name="firstremind" id="firstremind" size="2" /> </td>
<td><input type="text" name="overduefinescap" id="overduefinescap" size="6" /> </td>
<td><input type="text" name="finedays" id="fined" size="3" /> </td>
auto_renew => 0,
issuelength => 5,
chargeperiod => 0,
+ chargeperiod_charge_at => 0,
rentaldiscount => '2.000000',
reservesallowed => 0,
hardduedate => '2013-01-01',
finedays => 'Null',
firstremind => 'Null',
chargeperiod => 'Null',
+ chargeperiod_charge_at => 0,
rentaldiscount => 2.00,
overduefinescap => 'Null',
accountsent => 'Null',
finedays => 'Null',
firstremind => 'Null',
chargeperiod => 'Null',
+ chargeperiod_charge_at => 0,
rentaldiscount => 3.00,
overduefinescap => 'Null',
accountsent => 'Null',
onshelfholds => 1,
opacitemholds => 'F',
};
+
$query = 'INSERT INTO issuingrules (
branchcode,
categorycode,
finedays,
firstremind,
chargeperiod,
+ chargeperiod_charge_at,
rentaldiscount,
overduefinescap,
accountsent,
chargename,
restrictedtype,
maxsuspensiondays
- ) VALUES(?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)';
+ ) VALUES(?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?,?)';
my $sth = $dbh->prepare($query);
$sth->execute(
$sampleissuingrule1->{branchcode},
$sampleissuingrule1->{finedays},
$sampleissuingrule1->{firstremind},
$sampleissuingrule1->{chargeperiod},
+ $sampleissuingrule1->{chargeperiod_charge_at},
$sampleissuingrule1->{rentaldiscount},
$sampleissuingrule1->{overduefinescap},
$sampleissuingrule1->{accountsent},
$sampleissuingrule2->{finedays},
$sampleissuingrule2->{firstremind},
$sampleissuingrule2->{chargeperiod},
+ $sampleissuingrule2->{chargeperiod_charge_at},
$sampleissuingrule2->{rentaldiscount},
$sampleissuingrule2->{overduefinescap},
$sampleissuingrule2->{accountsent},
$sampleissuingrule3->{finedays},
$sampleissuingrule3->{firstremind},
$sampleissuingrule3->{chargeperiod},
+ $sampleissuingrule3->{chargeperiod_charge_at},
$sampleissuingrule3->{rentaldiscount},
$sampleissuingrule3->{overduefinescap},
$sampleissuingrule3->{accountsent},
--- /dev/null
+#!/usr/bin/perl
+
+use Modern::Perl;
+
+use C4::Context;
+use C4::Overdues;
+use Koha::Database;
+use Koha::DateUtils;
+
+use Test::More tests => 5;
+
+#Start transaction
+my $dbh = C4::Context->dbh;
+my $schema = Koha::Database->new()->schema();
+
+$dbh->{RaiseError} = 1;
+$dbh->{AutoCommit} = 0;
+
+$dbh->do(q|DELETE FROM issuingrules|);
+
+my $issuingrule = $schema->resultset('Issuingrule')->create(
+ {
+ categorycode => '*',
+ itemtype => '*',
+ branchcode => '*',
+ fine => 1,
+ finedays => 0,
+ chargeperiod => 7,
+ chargeperiod_charge_at => 0,
+ lengthunit => 'days',
+ issuelength => 1,
+ }
+);
+
+ok( $issuingrule, 'Issuing rule created' );
+
+my $period_start = dt_from_string('2000-01-01');
+my $period_end = dt_from_string('2000-01-05');
+
+my ( $fine ) = CalcFine( {}, q{}, q{}, $period_start, $period_end );
+is( $fine, 0, '4 days overdue, charge period 7 days, charge at end of interval gives fine of $0' );
+
+$period_end = dt_from_string('2000-01-10');
+( $fine ) = CalcFine( {}, q{}, q{}, $period_start, $period_end );
+is( $fine, 1, '9 days overdue, charge period 7 days, charge at end of interval gives fine of $1' );
+
+# Test charging fine at the *beginning* of each charge period
+$issuingrule->update( { chargeperiod_charge_at => 1 } );
+
+$period_end = dt_from_string('2000-01-05');
+( $fine ) = CalcFine( {}, q{}, q{}, $period_start, $period_end );
+is( $fine, 1, '4 days overdue, charge period 7 days, charge at start of interval gives fine of $1' );
+
+$period_end = dt_from_string('2000-01-10');
+( $fine ) = CalcFine( {}, q{}, q{}, $period_start, $period_end );
+is( $fine, 2, '9 days overdue, charge period 7 days, charge at start of interval gives fine of $2' );
projects / koha-equinox.git / commitdiff