use strict;
use vars qw( %info );
-use Time::Local qw( timelocal );
+use Tie::IxHash;
+use Time::Local qw( timelocal timelocal_nocheck );
use Date::Format qw( time2str );
+use List::Util qw( min );
+
+tie our %prorate_round_day_opts, 'Tie::IxHash',
+ 0 => 'no',
+ 1 => 'to the nearest day',
+ 2 => 'up to a full day',
+ 3 => 'down to a full day',
+;
%info = (
'disabled' => 1,
'type' => 'checkbox',
},
'prorate_round_day' => {
- 'name' => 'When prorating, round to the nearest full day',
- 'type' => 'checkbox',
+ 'name' => 'When prorating, round the prorated period',
+ 'type' => 'select',
+ 'select_options' => \%prorate_round_day_opts,
},
'prorate_defer_bill' => {
'name' => 'When prorating, defer the first bill until the '.
Options:
- add_full_period: Bill for the time up to the prorate day plus one full
-billing period after that.
+ billing period after that.
- prorate_round_day: Round the current time to the nearest full day,
-instead of using the exact time.
+ instead of using the exact time.
- prorate_defer_bill: Don't bill the prorate interval until the prorate
-day arrives.
+ day arrives.
- prorate_verbose: Generate details to explain the prorate calculations.
=cut
sub calc_prorate {
- my ($self, $cust_pkg, $sdate, $details, $param, $cutoff_day) = @_;
- die "no cutoff_day" unless $cutoff_day;
+ my ($self, $cust_pkg, $sdate, $details, $param, @cutoff_days) = @_;
+ die "no cutoff_day" unless @cutoff_days;
die "can't prorate non-monthly package\n" if $self->freq =~ /\D/;
my $money_char = FS::Conf->new->config('money_char') || '$';
$add_period = 1;
}
+ # if the customer already has a billing day-of-month established,
+ # and it's a valid cutoff day, try to respect it
+ my $next_bill_day;
+ if ( my $next_bill = $cust_pkg->cust_main->next_bill_date ) {
+ $next_bill_day = (localtime($next_bill))[3];
+ if ( grep {$_ == $next_bill_day} @cutoff_days ) {
+ # by removing all other cutoff days from the list
+ @cutoff_days = ($next_bill_day);
+ }
+ }
+
my ($mend, $mstart);
- ($mnow, $mend, $mstart) = $self->_endpoints($mnow, $cutoff_day);
+ ($mnow, $mend, $mstart) = $self->_endpoints($mnow, @cutoff_days);
# next bill date will be figured as $$sdate + one period
$$sdate = $mstart;
my $permonth = $charge / $self->freq;
my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) );
-
- if ( $self->option('prorate_verbose',1)
- and $months > 0 and $months < $self->freq ) {
- push @$details,
- 'Prorated (' . time2str('%b %d', $mnow) .
- ' - ' . time2str('%b %d', $mend) . '): ' . $money_char .
- sprintf('%.2f', $permonth * $months + 0.00000001 );
- }
+ # after this, $self->freq - 1 < $months <= $self->freq
# add a full period if currently billing for a partial period
# or periods up to freq_override if billing for an override interval
if ( ($param->{'freq_override'} || 0) > 1 ) {
$months += $param->{'freq_override'} - 1;
- }
- elsif ( $add_period && $months < $self->freq) {
+ # freq_override - 1 correct here?
+ # (probably only if freq == 1, yes?)
+ } elsif ( $add_period && $months < $self->freq ) {
+
+ # 'add_period' is a misnomer.
+ # we add enough to make the total at least a full period
+ $months++;
+ $$sdate = $self->add_freq($mstart, 1);
+ # now $self->freq <= $months <= $self->freq + 1
+ # (note that this only happens if $months < $self->freq to begin with)
+
+ }
- if ( $self->option('prorate_verbose',1) ) {
- # calculate the prorated and add'l period charges
+ if ( $self->option('prorate_verbose',1) and $months > 0 ) {
+ if ( $months < $self->freq ) {
+ # we are billing a fractional period only
+ # # (though maybe not a fractional month)
+ my $period_end = $self->add_freq($mstart);
+ push @$details,
+ 'Prorated (' . time2str('%b %d', $mnow) .
+ ' - ' . time2str('%b %d', $period_end) . '): ' . $money_char .
+ sprintf('%.2f', $permonth * $months + 0.00000001 );
+
+ } elsif ( $months > $self->freq ) {
+ # we are billing MORE than a full period
push @$details,
- 'First full month: ' . $money_char .
- sprintf('%.2f', $permonth);
- }
- $months += $self->freq;
- $$sdate = $self->add_freq($mstart);
+ 'Prorated (' . time2str('%b %d', $mnow) .
+ ' - ' . time2str('%b %d', $mend) . '): ' . $money_char .
+ sprintf('%.2f', $permonth * ($months - $self->freq + 0.0000001)),
+
+ 'First full period: ' . $money_char .
+ sprintf('%.2f', $permonth * $self->freq);
+ } # else $months == $self->freq, and no prorating has happened
}
$param->{'months'} = $months;
#so 1.005 rounds to 1.01
$charge = sprintf('%.2f', $permonth * $months + 0.00000001 );
- return $charge;
+ return sprintf('%.2f', $charge);
}
=item prorate_setup CUST_PKG SDATE
sub prorate_setup {
my $self = shift;
my ($cust_pkg, $sdate) = @_;
- my $cutoff_day = $self->cutoff_day($cust_pkg);
- if ( ! $cust_pkg->bill
- and $self->option('prorate_defer_bill',1)
- and $cutoff_day
- ) {
- my ($mnow, $mend, $mstart) = $self->_endpoints($sdate, $cutoff_day);
- # If today is the cutoff day, set the next bill and setup both to
- # midnight today, so that the customer will be billed normally for a
- # month starting today.
- if ( $mnow - $mstart < 86400 ) {
- $cust_pkg->setup($mstart);
- $cust_pkg->bill($mstart);
- }
- else {
- $cust_pkg->bill($mend);
+ my @cutoff_days = $self->cutoff_day($cust_pkg);
+ if ( @cutoff_days and $self->option('prorate_defer_bill', 1) ) {
+ if ( $cust_pkg->setup ) {
+ # Setup date is already set. Then we're being called indirectly via calc_prorate
+ # to calculate the deferred setup fee. Allow that to happen normally.
+ return 0;
+ } else {
+ # We're going to set the setup date (so that the deferred billing knows when
+ # the package started) and suppress charging the setup fee.
+ if ( $cust_pkg->bill ) {
+ # For some reason (probably user override), the bill date has been set even
+ # though the package isn't billing yet. Start billing as though that was the
+ # start date.
+ $sdate = $cust_pkg->bill;
+ $cust_pkg->setup($cust_pkg->bill);
+ }
+ # Now figure the start and end of the period that contains the start date.
+ my ($mnow, $mend, $mstart) = $self->_endpoints($sdate, @cutoff_days);
+ # If today is the cutoff day, set the next bill and setup both to
+ # midnight today, so that the customer will be billed normally for a
+ # month starting today.
+ if ( $mnow - $mstart < 86400 ) {
+ $cust_pkg->setup($mstart);
+ $cust_pkg->bill($mstart);
+ }
+ else {
+ $cust_pkg->bill($mend);
+ }
+ return 1;
}
- return 1;
}
return 0;
}
=cut
sub _endpoints {
- my ($self, $mnow, $cutoff_day) = @_;
+ my $self = shift;
+ my $mnow = shift;
+ my @cutoff_days = sort {$a <=> $b} @_;
# only works for freq >= 1 month; probably can't be fixed
my ($sec, $min, $hour, $mday, $mon, $year) = (localtime($mnow))[0..5];
- if( $self->option('prorate_round_day',1) ) {
+ my $rounding_mode = $self->option('prorate_round_day',1);
+ if ( $rounding_mode == 1 ) {
# If the time is 12:00-23:59, move to the next day by adding 18
# hours to $mnow. Because of DST this can end up from 05:00 to 18:59
# but it's always within the next day.
($mday,$mon,$year) = (localtime($mnow))[3..5];
# Then set $mnow to midnight on that day.
$mnow = timelocal(0,0,0,$mday,$mon,$year);
+ } elsif ( $rounding_mode == 2 ) {
+ # Move the time back to midnight. This increases the length of the
+ # prorate interval.
+ $mnow = timelocal(0,0,0,$mday,$mon,$year);
+ ($mday,$mon,$year) = (localtime($mnow))[3..5];
+ } elsif ( $rounding_mode == 3 ) {
+ # If the time is after midnight, move it forward to the next midnight.
+ # This decreases the length of the prorate interval.
+ if ( $sec > 0 or $min > 0 or $hour > 0 ) {
+ # move to one second before midnight, then tick forward
+ $mnow = timelocal(59,59,23,$mday,$mon,$year) + 1;
+ ($mday,$mon,$year) = (localtime($mnow))[3..5];
+ }
}
my $mend;
my $mstart;
- # if cutoff day > 28, force it to the 1st of next month
- if ( $cutoff_day > 28 ) {
- $cutoff_day = 1;
- # and if we are currently after the 28th, roll the current day
- # forward to that day
- if ( $mday > 28 ) {
- $mday = 1;
- #set $mnow = $mend so the amount billed will be zero
- $mnow = timelocal(0,0,0,1,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
- }
- }
+ # select the first cutoff day that's on or after the current day
+ my $cutoff_day = min( grep { $_ >= $mday } @cutoff_days );
+ # if today is after the last cutoff, choose the first one
+ $cutoff_day ||= $cutoff_days[0];
+
+ # then, if today is on or after the selected day, set period to
+ # (cutoff day this month) - (cutoff day next month)
if ( $mday >= $cutoff_day ) {
$mend =
- timelocal(0,0,0,$cutoff_day,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
+ timelocal_nocheck(0,0,0,$cutoff_day,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
$mstart =
- timelocal(0,0,0,$cutoff_day,$mon,$year);
+ timelocal_nocheck(0,0,0,$cutoff_day,$mon,$year);
}
+ # otherwise, set period to (cutoff day last month) - (cutoff day this month)
else {
$mend =
- timelocal(0,0,0,$cutoff_day,$mon,$year);
+ timelocal_nocheck(0,0,0,$cutoff_day,$mon,$year);
$mstart =
- timelocal(0,0,0,$cutoff_day,$mon == 0 ? 11 : $mon - 1,$year-($mon==0));
+ timelocal_nocheck(0,0,0,$cutoff_day,$mon == 0 ? 11 : $mon - 1,$year-($mon==0));
}
return ($mnow, $mend, $mstart);
}
projects / freeside.git / blobdiff