1 package FS::part_pkg::prorate_Mixin;
4 use vars qw(@ISA %info);
5 use Time::Local qw(timelocal);
7 @ISA = qw(FS::part_pkg);
10 # define all fields that are referenced in this code
12 'add_full_period' => {
13 'name' => 'When prorating first month, also bill for one full '.
17 'prorate_round_day' => {
18 'name' => 'When prorating, round to the nearest full day',
21 'prorate_defer_bill' => {
22 'name' => 'When prorating, defer the first bill until the '.
27 'fieldorder' => [ qw(prorate_defer_bill prorate_round_day add_full_period) ],
31 @{ $info{'fieldorder'} }
36 FS::part_pkg::prorate_Mixin - Mixin class for part_pkg:: classes that
37 need to prorate partial months
41 package FS::part_pkg::...;
42 use base qw( FS::part_pkg::prorate_Mixin );
46 if( conditions that trigger prorate ) {
47 # sets $$sdate and $param->{'months'}, returns the prorated charge
48 $charges = $self->calc_prorate($cust_pkg, $sdate, $param, $cutoff_day);
55 =item calc_prorate CUST_PKG SDATE DETAILS PARAM CUTOFF_DAY
57 Takes all the arguments of calc_recur. Calculates a prorated charge from
58 the $sdate to the cutoff day for this package definition, and sets the $sdate
59 and $param->{months} accordingly. base_recur() will be called to determine
60 the base price per billing cycle.
63 - add_full_period: Bill for the time up to the prorate day plus one full
64 billing period after that.
65 - prorate_round_day: Round the current time to the nearest full day,
66 instead of using the exact time.
67 - prorate_defer_bill: Don't bill the prorate interval until the prorate
73 my ($self, $cust_pkg, $sdate, $details, $param, $cutoff_day) = @_;
74 die "no cutoff_day" unless $cutoff_day;
75 die "can't prorate non-monthly package\n" if $self->freq =~ /\D/;
77 my $charge = $self->base_recur($cust_pkg, $sdate) || 0;
81 # if this is the first bill but the bill date has been set
82 # (by prorate_defer_bill), calculate from the setup date,
83 # and append the setup fee to @$details.
84 if ( $self->option('prorate_defer_bill',1)
85 and ! $cust_pkg->getfield('last_bill')
86 and $cust_pkg->setup ) {
87 #warn "[calc_prorate] #".$cust_pkg->pkgnum.": running deferred setup\n";
88 $param->{'setup_fee'} = $self->calc_setup($cust_pkg, $$sdate, $details);
89 $mnow = $cust_pkg->setup;
93 ($mnow, $mend, $mstart) = $self->_endpoints($mnow, $cutoff_day);
95 # next bill date will be figured as $$sdate + one period
98 my $permonth = $charge / $self->freq;
99 my $months = ( ( $self->freq - 1 ) + ($mend-$mnow) / ($mend-$mstart) );
101 # add a full period if currently billing for a partial period
102 if ( ( $self->option('add_full_period',1)
103 or $self->option('prorate_defer_bill',1) ) # necessary
104 and $months < $self->freq ) {
105 $months += $self->freq;
106 $$sdate = $self->add_freq($mstart);
109 $param->{'months'} = $months;
110 $charge = sprintf('%.2f', $permonth * $months);
115 =item prorate_setup CUST_PKG SDATE
117 Set up the package. This only has an effect if prorate_defer_bill is
118 set, in which case it postpones the next bill to the cutoff day.
124 my ($cust_pkg, $sdate) = @_;
125 my $cutoff_day = $self->cutoff_day($cust_pkg);
126 if ( ! $cust_pkg->bill
127 and $self->option('prorate_defer_bill',1)
130 my ($mnow, $mend, $mstart) = $self->_endpoints($sdate, $cutoff_day);
131 # if today is the cutoff day, set the next bill to right now instead
132 # of waiting a month.
133 if ( $mnow - $mstart < 86400 ) {
134 $cust_pkg->bill($mnow);
137 $cust_pkg->bill($mend);
144 =item _endpoints TIME CUTOFF_DAY
146 Given a current time and a day of the month to prorate to, return three
147 times: the start of the prorate interval (usually the current time), the
148 end of the prorate interval (i.e. the cutoff date), and the time one month
149 before the end of the prorate interval.
154 my ($self, $mnow, $cutoff_day) = @_;
156 # only works for freq >= 1 month; probably can't be fixed
157 my ($sec, $min, $hour, $mday, $mon, $year) = (localtime($mnow))[0..5];
158 if( $self->option('prorate_round_day',1) ) {
159 # If the time is 12:00-23:59, move to the next day by adding 18
160 # hours to $mnow. Because of DST this can end up from 05:00 to 18:59
161 # but it's always within the next day.
162 $mnow += 64800 if $hour >= 12;
163 # Get the new day, month, and year.
164 ($mday,$mon,$year) = (localtime($mnow))[3..5];
165 # Then set $mnow to midnight on that day.
166 $mnow = timelocal(0,0,0,$mday,$mon,$year);
170 # if cutoff day > 28, force it to the 1st of next month
171 if ( $cutoff_day > 28 ) {
173 # and if we are currently after the 28th, roll the current day
174 # forward to that day
177 #set $mnow = $mend so the amount billed will be zero
178 $mnow = timelocal(0,0,0,1,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
181 if ( $mday >= $cutoff_day ) {
183 timelocal(0,0,0,$cutoff_day,$mon == 11 ? 0 : $mon + 1,$year+($mon==11));
185 timelocal(0,0,0,$cutoff_day,$mon,$year);
189 timelocal(0,0,0,$cutoff_day,$mon,$year);
191 timelocal(0,0,0,$cutoff_day,$mon == 0 ? 11 : $mon - 1,$year-($mon==0));
193 return ($mnow, $mend, $mstart);