1 package FS::part_pkg::flat;
2 use base qw( FS::part_pkg::prorate_Mixin
3 FS::part_pkg::discount_Mixin
8 use vars qw( %info %usage_recharge_fields @usage_recharge_fieldorder );
9 use FS::Record qw( qsearch );
11 use List::Util qw( min );
12 use FS::UI::bytecount;
15 tie my %temporalities, 'Tie::IxHash',
16 'upcoming' => "Upcoming (future)",
17 'preceding' => "Preceding (past)",
20 tie my %contract_years, 'Tie::IxHash', (
22 map { $_*12 => $_ } (1..5),
26 'name' => 'Flat rate (anniversary billing)',
27 'shortname' => 'Anniversary',
28 'inherit_fields' => [ 'prorate_Mixin', 'usage_Mixin', 'global_Mixin' ],
30 #false laziness w/voip_cdr.pm
31 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
33 'select_options' => \%temporalities,
36 #used in cust_pkg.pm so could add to any price plan
37 'expire_months' => { 'name' => 'Auto-add an expiration date this number of months out',
39 'adjourn_months'=> { 'name' => 'Auto-add a suspension date this number of months out',
41 'contract_end_months'=> {
42 'name' => 'Auto-add a contract end date this number of years out',
44 'select_options' => \%contract_years,
46 #used in cust_pkg.pm so could add to any price plan where it made sense
47 'start_1st' => { 'name' => 'Auto-add a start date to the 1st, ignoring the current month.',
50 'sync_bill_date' => { 'name' => 'Prorate first month to synchronize '.
51 'with the customer\'s other packages',
54 'prorate_defer_bill' => {
55 'name' => 'When synchronizing, defer the bill until '.
56 'the customer\'s next bill date',
59 'prorate_round_day' => {
60 'name' => 'When synchronizing, round the prorated '.
61 'period to the nearest full day',
64 'add_full_period' => { 'disabled' => 1 }, # doesn't make sense with sync?
66 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
69 'unsuspend_adjust_bill' =>
70 { 'name' => 'Adjust next bill date forward when '.
74 'bill_recur_on_cancel' => {
75 'name' => 'Bill the last period on cancellation',
78 'bill_suspend_as_cancel' => {
79 'name' => 'Bill immediately upon suspension', #desc?
82 'externalid' => { 'name' => 'Optional External ID',
86 'fieldorder' => [ qw( recur_temporality
87 expire_months adjourn_months
90 sync_bill_date prorate_defer_bill prorate_round_day
91 suspend_bill unsuspend_adjust_bill
93 bill_suspend_as_cancel
101 my $conf = new FS::Conf;
102 my $money_char = $conf->config('money_char') || '$';
103 my $setup = $self->option('setup_fee') || 0;
104 my $recur = $self->option('recur_fee', 1) || 0;
106 $str = $money_char . $setup . ($recur ? ' setup ' : ' one-time') if $setup;
107 $str .= ', ' if ($setup && $recur);
108 $str .= $money_char. $recur. '/'. $self->freq_pretty if $recur;
113 my($self, $cust_pkg, $sdate, $details, $param ) = @_;
115 return 0 if $self->prorate_setup($cust_pkg, $sdate);
118 my $count = $self->option( 'additional_count', 'quiet' ) || 0;
119 while ($i < $count) {
120 push @$details, $self->option( 'additional_info' . $i++ );
123 my $charge = $self->unit_setup($cust_pkg, $sdate, $details);
127 $param->{'setup_charge'} = $charge;
128 $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
129 delete $param->{'setup_charge'};
132 sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
136 my($self, $cust_pkg, $sdate, $details ) = @_;
137 ( exists( $self->{'Hash'}{'_opt_setup_fee'} )
138 ? $self->{'Hash'}{'_opt_setup_fee'}
139 : $self->option('setup_fee', 1)
146 my($cust_pkg, $sdate, $details, $param ) = @_;
148 #my $last_bill = $cust_pkg->last_bill;
149 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
152 if $self->recur_temporality eq 'preceding' && !$last_bill;
154 my $charge = $self->base_recur($cust_pkg, $sdate);
155 # always treat cutoff_day as a list
156 if ( my @cutoff_day = $self->cutoff_day($cust_pkg) ) {
157 $charge = $self->calc_prorate(@_, @cutoff_day);
159 elsif ( $param->{freq_override} ) {
160 # XXX not sure if this should be mutually exclusive with sync_bill_date.
161 # Given the very specific problem that freq_override is meant to 'solve',
162 # it probably should.
163 $charge *= $param->{freq_override} if $param->{freq_override};
166 my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
168 sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) );
173 my $cust_pkg = shift;
174 if ( $self->option('sync_bill_date',1) ) {
175 my $next_bill = $cust_pkg->cust_main->next_bill_date;
176 if ( defined($next_bill) ) {
177 # careful here. if the prorate calculation is going to round to
178 # the nearest day, this needs to always return the same result
179 if ( $self->option('prorate_round_day', 1) ) {
180 my $hour = (localtime($next_bill))[2];
181 $next_bill += 64800 if $hour >= 12;
183 return (localtime($next_bill))[3];
190 my($self, $cust_pkg, $sdate) = @_;
191 ( exists( $self->{'Hash'}{'_opt_recur_fee'} )
192 ? $self->{'Hash'}{'_opt_recur_fee'}
193 : $self->option('recur_fee', 1)
198 sub base_recur_permonth {
199 my($self, $cust_pkg) = @_;
201 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
203 sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
208 my $conf = new FS::Conf;
209 if ( $self->recur_temporality eq 'preceding'
210 and $self->option('bill_recur_on_cancel', 1) ) {
211 # run another recurring cycle
212 return $self->calc_recur(@_);
213 } elsif ( $conf->exists('bill_usage_on_cancel') # should be a package option?
214 and $self->can('calc_usage') ) {
215 # bill for outstanding usage
216 return $self->calc_usage(@_);
218 return 'NOTHING'; # numerically zero, but has special meaning
223 my ($self, $cust_pkg, %options) = @_;
226 if ($options{'time'}) {
227 $time = $options{'time'};
232 my $next_bill = $cust_pkg->getfield('bill') || 0;
234 return 0 if ! $self->base_recur($cust_pkg, \$time)
236 || $next_bill < $time;
238 # Use actual charge for this period, not base_recur (for discounts).
239 # Use sdate < $time and edate >= $time because when billing on
240 # cancellation, edate = $time.
242 foreach my $cust_bill_pkg (
243 qsearch('cust_bill_pkg', {
244 pkgnum => $cust_pkg->pkgnum,
245 edate => {op => '>=', value => $time},
246 recur => {op => '>' , value => 0},
249 # hack to deal with the weird behavior of edate on package cancellation
250 my $edate = $cust_bill_pkg->edate;
251 if ( $self->recur_temporality eq 'preceding' ) {
252 $edate = $self->add_freq($cust_bill_pkg->sdate);
255 # this will also get any package charges that are _entirely_ after the
256 # cancellation date (can happen with advance billing). in that case,
257 # use the entire recurring charge:
258 my $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage;
260 # but if the cancellation happens during the interval, prorate it:
261 # (XXX obey prorate_round_day here?)
262 if ( $cust_bill_pkg->sdate < $time ) {
263 $amount = $amount * ($edate - $time) / ($edate - $cust_bill_pkg->sdate);
268 sprintf('%.2f', $credit);
272 sub is_free_options {
273 qw( setup_fee recur_fee );
276 sub is_prepaid { 0; } #no, we're postpaid
281 return 0 if $self->start_on_hold;
283 ! $self->option('start_1st', 1) && ( ! $self->option('sync_bill_date',1)
284 || ! $self->option('prorate_defer_bill',1)
285 || ! $opt{'num_ncancelled_pkgs'}
289 sub can_discount { 1; }
291 sub recur_temporality {
293 $self->option('recur_temporality', 1);
296 sub usage_valuehash {
298 map { $_, $self->option($_) }
299 grep { $self->option($_, 'hush') }
300 qw(seconds upbytes downbytes totalbytes);
304 my($self, $cust_pkg, %opt) = @_;
305 warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
306 my %values = $self->usage_valuehash;
307 if ($self->option('usage_rollover', 1)) {
308 $cust_pkg->recharge(\%values);
310 $cust_pkg->set_usage(\%values, %opt);