From 4117c20f85ce085d7dd42b8970ce9c65b95d7e27 Mon Sep 17 00:00:00 2001 From: mark Date: Thu, 19 Aug 2010 19:11:45 +0000 Subject: part_pkg prorate mixin and sync_bill_date option, RT#9554 --- FS/FS/part_pkg/prorate_Mixin.pm | 96 +++++++++++++++++++++++++++++++++++++++++ 1 file changed, 96 insertions(+) create mode 100644 FS/FS/part_pkg/prorate_Mixin.pm (limited to 'FS/FS/part_pkg/prorate_Mixin.pm') diff --git a/FS/FS/part_pkg/prorate_Mixin.pm b/FS/FS/part_pkg/prorate_Mixin.pm new file mode 100644 index 000000000..a60858b37 --- /dev/null +++ b/FS/FS/part_pkg/prorate_Mixin.pm @@ -0,0 +1,96 @@ +package FS::part_pkg::prorate_Mixin; + +use strict; +use vars qw(@ISA %info); +use Time::Local qw(timelocal); + +@ISA = qw(FS::part_pkg); +%info = ( 'disabled' => 1 ); + +=head1 NAME + +FS::part_pkg::prorate_Mixin - Mixin class for part_pkg:: classes that +need to prorate partial months + +=head1 SYNOPSIS + +package FS::part_pkg::...; +use base qw( FS::part_pkg::prorate_Mixin ); + +sub calc_recur { + ... + if( conditions that trigger prorate ) { + # sets $$sdate and $param->{'months'}, returns the prorated charge + $charges = $self->calc_prorate($cust_pkg, $sdate, $param, $cutoff_day); + } + ... +} + +=head METHODS + +=item calc_prorate + +Takes all the arguments of calc_recur, and calculates a prorated charge +in one of two ways: + +- If 'sync_bill_date' is set: Charge for a number of days to synchronize + this package to the customer's next bill date. If this is their only + package (or they're already synchronized), that will take them through + one billing cycle. +- If 'cutoff_day' is set: Prorate this package so that its next bill date + falls on that day of the month. + +=cut + +sub calc_prorate { + my $self = shift; + my ($cust_pkg, $sdate, $details, $param) = @_; + + my $charge = $self->option('recur_fee') || 0; + my $cutoff_day; + if( $self->option('sync_bill_date') ) { + my $next_bill = $cust_pkg->cust_main->next_bill_date; + if( defined($next_bill) and $next_bill != $$sdate ) { + $cutoff_day = (localtime($next_bill))[3]; + } + else { + # don't prorate, assume a full month + $param->{'months'} = $self->freq; + } + } + else { # no sync, use cutoff_day or day 1 + $cutoff_day = $self->option('cutoff_day') || 1; + } + + if($cutoff_day) { + # only works for freq >= 1 month; probably can't be fixed + my $mnow = $$sdate; + my ($sec, $min, $hour, $mday, $mon, $year) = (localtime($mnow))[0..5]; + my $mend; + my $mstart; + if ( $mday >= $cutoff_day ) { + $mend = + timelocal(0,0,0,$cutoff_day,$mon == 11 ? 0 : $mon + 1,$year+($mon==11)); + $mstart = + timelocal(0,0,0,$cutoff_day,$mon,$year); + } + else { + $mend = + timelocal(0,0,0,$cutoff_day,$mon,$year); + $mstart = + timelocal(0,0,0,$cutoff_day,$mon == 0 ? 11 : $mon - 1,$year-($mon==11)); + } + + $$sdate = $mstart; + + my $permonth = $self->option('recur_fee', 1) / $self->freq; + my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) ); + + $param->{'months'} = $months; + $charge = sprintf('%.2f', $permonth * $months); + } + my $discount = $self->calc_discount(@_); + return ($charge - $discount); +} + +1; -- cgit v1.2.1 From ced6be92d868addbed9ff93b39bbd6a1f634bcb7 Mon Sep 17 00:00:00 2001 From: ivan Date: Tue, 24 Aug 2010 19:07:59 +0000 Subject: eliminate needless noise on lack of sync_bill_date option --- FS/FS/part_pkg/prorate_Mixin.pm | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) (limited to 'FS/FS/part_pkg/prorate_Mixin.pm') diff --git a/FS/FS/part_pkg/prorate_Mixin.pm b/FS/FS/part_pkg/prorate_Mixin.pm index a60858b37..2adf2f16a 100644 --- a/FS/FS/part_pkg/prorate_Mixin.pm +++ b/FS/FS/part_pkg/prorate_Mixin.pm @@ -48,7 +48,7 @@ sub calc_prorate { my $charge = $self->option('recur_fee') || 0; my $cutoff_day; - if( $self->option('sync_bill_date') ) { + if( $self->option('sync_bill_date',1) ) { my $next_bill = $cust_pkg->cust_main->next_bill_date; if( defined($next_bill) and $next_bill != $$sdate ) { $cutoff_day = (localtime($next_bill))[3]; -- cgit v1.2.1 From 86119e342d95f16b799043e9cf66230d015c37de Mon Sep 17 00:00:00 2001 From: mark Date: Wed, 29 Sep 2010 23:41:34 +0000 Subject: option to charge the next full period when prorating, RT#9874 --- FS/FS/part_pkg/prorate_Mixin.pm | 11 +++++++++-- 1 file changed, 9 insertions(+), 2 deletions(-) (limited to 'FS/FS/part_pkg/prorate_Mixin.pm') diff --git a/FS/FS/part_pkg/prorate_Mixin.pm b/FS/FS/part_pkg/prorate_Mixin.pm index 2adf2f16a..ed532ee12 100644 --- a/FS/FS/part_pkg/prorate_Mixin.pm +++ b/FS/FS/part_pkg/prorate_Mixin.pm @@ -80,12 +80,19 @@ sub calc_prorate { $mstart = timelocal(0,0,0,$cutoff_day,$mon == 0 ? 11 : $mon - 1,$year-($mon==11)); } - + + # next bill date will be figured as $$sdate + one period $$sdate = $mstart; my $permonth = $self->option('recur_fee', 1) / $self->freq; my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) ); - + + if ( $self->option('add_full_period',1) ) { + # charge a full period in addition to the partial month + $months += $self->freq; + $$sdate = $self->add_freq($mstart); + } + $param->{'months'} = $months; $charge = sprintf('%.2f', $permonth * $months); } -- cgit v1.2.1 From 4ad8b72c0dde10d4907298277181ddfaa99dafb6 Mon Sep 17 00:00:00 2001 From: mark Date: Fri, 29 Oct 2010 08:51:51 +0000 Subject: prorate option to round to full day, RT#7353 --- FS/FS/part_pkg/prorate_Mixin.pm | 4 ++++ 1 file changed, 4 insertions(+) (limited to 'FS/FS/part_pkg/prorate_Mixin.pm') diff --git a/FS/FS/part_pkg/prorate_Mixin.pm b/FS/FS/part_pkg/prorate_Mixin.pm index ed532ee12..b77d898c4 100644 --- a/FS/FS/part_pkg/prorate_Mixin.pm +++ b/FS/FS/part_pkg/prorate_Mixin.pm @@ -66,6 +66,10 @@ sub calc_prorate { # only works for freq >= 1 month; probably can't be fixed my $mnow = $$sdate; my ($sec, $min, $hour, $mday, $mon, $year) = (localtime($mnow))[0..5]; + if ( $self->option('prorate_round_day',1) ) { + $mday++ if $hour >= 12; + $mnow = timelocal(0,0,0,$mday,$mon,$year); + } my $mend; my $mstart; if ( $mday >= $cutoff_day ) { -- cgit v1.2.1 From cc04f43d238a1aed658d766577e45d96fcb38d77 Mon Sep 17 00:00:00 2001 From: mark Date: Sat, 30 Oct 2010 23:22:31 +0000 Subject: discount_Mixin --- FS/FS/part_pkg/prorate_Mixin.pm | 49 +++++++++++++++-------------------------- 1 file changed, 18 insertions(+), 31 deletions(-) (limited to 'FS/FS/part_pkg/prorate_Mixin.pm') diff --git a/FS/FS/part_pkg/prorate_Mixin.pm b/FS/FS/part_pkg/prorate_Mixin.pm index b77d898c4..9c0c2669b 100644 --- a/FS/FS/part_pkg/prorate_Mixin.pm +++ b/FS/FS/part_pkg/prorate_Mixin.pm @@ -5,7 +5,9 @@ use vars qw(@ISA %info); use Time::Local qw(timelocal); @ISA = qw(FS::part_pkg); -%info = ( 'disabled' => 1 ); +%info = ( + 'disabled' => 1, +); =head1 NAME @@ -28,45 +30,31 @@ sub calc_recur { =head METHODS -=item calc_prorate +=item calc_prorate CUST_PKG -Takes all the arguments of calc_recur, and calculates a prorated charge -in one of two ways: +Takes all the arguments of calc_recur, followed by a day of the month +to prorate to. Calculates a prorated charge from the $sdate to that day, +and sets the $sdate and $param->{months} accordingly. -- If 'sync_bill_date' is set: Charge for a number of days to synchronize - this package to the customer's next bill date. If this is their only - package (or they're already synchronized), that will take them through - one billing cycle. -- If 'cutoff_day' is set: Prorate this package so that its next bill date - falls on that day of the month. +Options: +- recur_fee: The charge to use for a complete billing period. +- add_full_period: Bill for the time up to the prorate day plus one full +billing period after that. +- prorate_round_day: Round the current time to the nearest full day, +instead of using the exact time. =cut sub calc_prorate { my $self = shift; - my ($cust_pkg, $sdate, $details, $param) = @_; + my ($cust_pkg, $sdate, $details, $param, $cutoff_day) = @_; - my $charge = $self->option('recur_fee') || 0; - my $cutoff_day; - if( $self->option('sync_bill_date',1) ) { - my $next_bill = $cust_pkg->cust_main->next_bill_date; - if( defined($next_bill) and $next_bill != $$sdate ) { - $cutoff_day = (localtime($next_bill))[3]; - } - else { - # don't prorate, assume a full month - $param->{'months'} = $self->freq; - } - } - else { # no sync, use cutoff_day or day 1 - $cutoff_day = $self->option('cutoff_day') || 1; - } - + my $charge = $self->option('recur_fee',1) || 0; if($cutoff_day) { # only works for freq >= 1 month; probably can't be fixed my $mnow = $$sdate; my ($sec, $min, $hour, $mday, $mon, $year) = (localtime($mnow))[0..5]; - if ( $self->option('prorate_round_day',1) ) { + if( $self->option('prorate_round_day',1) ) { $mday++ if $hour >= 12; $mnow = timelocal(0,0,0,$mday,$mon,$year); } @@ -88,7 +76,7 @@ sub calc_prorate { # next bill date will be figured as $$sdate + one period $$sdate = $mstart; - my $permonth = $self->option('recur_fee', 1) / $self->freq; + my $permonth = $charge / $self->freq; my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) ); if ( $self->option('add_full_period',1) ) { @@ -100,8 +88,7 @@ sub calc_prorate { $param->{'months'} = $months; $charge = sprintf('%.2f', $permonth * $months); } - my $discount = $self->calc_discount(@_); - return ($charge - $discount); + return $charge; } 1; -- cgit v1.2.1