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 );
10 use List::Util qw( min );
11 use FS::UI::bytecount;
14 tie my %temporalities, 'Tie::IxHash',
15 'upcoming' => "Upcoming (future)",
16 'preceding' => "Preceding (past)",
19 tie my %contract_years, 'Tie::IxHash', (
21 map { $_*12 => $_ } (1..5),
25 'name' => 'Flat rate (anniversary billing)',
26 'shortname' => 'Anniversary',
27 'inherit_fields' => [ 'prorate_Mixin', 'usage_Mixin', 'global_Mixin' ],
29 #false laziness w/voip_cdr.pm
30 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
32 'select_options' => \%temporalities,
35 #used in cust_pkg.pm so could add to any price plan
36 'expire_months' => { 'name' => 'Auto-add an expiration date this number of months out',
38 'adjourn_months'=> { 'name' => 'Auto-add a suspension date this number of months out',
40 'contract_end_months'=> {
41 'name' => 'Auto-add a contract end date this number of years out',
43 'select_options' => \%contract_years,
45 #used in cust_pkg.pm so could add to any price plan where it made sense
46 'start_1st' => { 'name' => 'Auto-add a start date to the 1st, ignoring the current month.',
49 'sync_bill_date' => { 'name' => 'Prorate first month to synchronize '.
50 'with the customer\'s other packages',
53 'prorate_defer_bill' => {
54 'name' => 'When synchronizing, defer the bill until '.
55 'the customer\'s next bill date',
58 'prorate_round_day' => {
59 'name' => 'When synchronizing, round the prorated '.
60 'period to the nearest full day',
63 'add_full_period' => { 'disabled' => 1 }, # doesn't make sense with sync?
65 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
68 'unsuspend_adjust_bill' =>
69 { 'name' => 'Adjust next bill date forward when '.
73 'bill_recur_on_cancel' => {
74 'name' => 'Bill the last period on cancellation',
77 'bill_suspend_as_cancel' => {
78 'name' => 'Bill immediately upon suspension', #desc?
81 'externalid' => { 'name' => 'Optional External ID',
85 'fieldorder' => [ qw( recur_temporality
86 expire_months adjourn_months
89 sync_bill_date prorate_defer_bill prorate_round_day
90 suspend_bill unsuspend_adjust_bill
92 bill_suspend_as_cancel
100 my $conf = new FS::Conf;
101 my $money_char = $conf->config('money_char') || '$';
102 my $setup = $self->option('setup_fee') || 0;
103 my $recur = $self->option('recur_fee', 1) || 0;
105 $str = $money_char . $setup . ($recur ? ' setup ' : ' one-time') if $setup;
106 $str .= ', ' if ($setup && $recur);
107 $str .= $money_char. $recur. '/'. $self->freq_pretty if $recur;
112 my($self, $cust_pkg, $sdate, $details, $param ) = @_;
114 return 0 if $self->prorate_setup($cust_pkg, $sdate);
117 my $count = $self->option( 'additional_count', 'quiet' ) || 0;
118 while ($i < $count) {
119 push @$details, $self->option( 'additional_info' . $i++ );
122 my $quantity = $cust_pkg->quantity || 1;
124 my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details);
128 $param->{'setup_charge'} = $charge;
129 $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
130 delete $param->{'setup_charge'};
133 sprintf('%.2f', $charge - $discount);
137 my($self, $cust_pkg, $sdate, $details ) = @_;
139 $self->option('setup_fee') || 0;
144 my($cust_pkg, $sdate, $details, $param ) = @_;
146 #my $last_bill = $cust_pkg->last_bill;
147 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
150 if $self->recur_temporality eq 'preceding' && !$last_bill;
152 my $charge = $self->base_recur($cust_pkg, $sdate);
153 if ( my $cutoff_day = $self->cutoff_day($cust_pkg) ) {
154 $charge = $self->calc_prorate(@_, $cutoff_day);
156 elsif ( $param->{freq_override} ) {
157 # XXX not sure if this should be mutually exclusive with sync_bill_date.
158 # Given the very specific problem that freq_override is meant to 'solve',
159 # it probably should.
160 $charge *= $param->{freq_override} if $param->{freq_override};
163 my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
164 return sprintf('%.2f', $charge - $discount);
169 my $cust_pkg = shift;
170 if ( $self->option('sync_bill_date',1) ) {
171 my $next_bill = $cust_pkg->cust_main->next_bill_date;
172 if ( defined($next_bill) ) {
173 return (localtime($next_bill))[3];
180 my($self, $cust_pkg, $sdate) = @_;
181 $self->option('recur_fee', 1) || 0;
184 sub base_recur_permonth {
185 my($self, $cust_pkg) = @_;
187 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
189 sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
193 my ($self, $cust_pkg, %options) = @_;
196 if ($options{'time'}) {
197 $time = $options{'time'};
202 my $next_bill = $cust_pkg->getfield('bill') || 0;
204 return 0 if ! $self->base_recur($cust_pkg, \$time)
206 || $next_bill < $time;
209 'h' => 3600, # 60 * 60
210 'd' => 86400, # 60 * 60 * 24
211 'w' => 604800, # 60 * 60 * 24 * 7
212 'm' => 2629744, # 60 * 60 * 24 * 365.2422 / 12
215 $self->freq =~ /^(\d+)([hdwm]?)$/
216 or die 'unparsable frequency: '. $self->freq;
217 my $freq_sec = $1 * $sec{$2||'m'};
218 return 0 unless $freq_sec;
220 sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec );
224 sub is_free_options {
225 qw( setup_fee recur_fee );
228 sub is_prepaid { 0; } #no, we're postpaid
230 sub can_start_date { ! shift->option('start_1st', 1) }
232 sub can_discount { 1; }
234 sub recur_temporality {
236 $self->option('recur_temporality', 1);
239 sub usage_valuehash {
241 map { $_, $self->option($_) }
242 grep { $self->option($_, 'hush') }
243 qw(seconds upbytes downbytes totalbytes);
247 my($self, $cust_pkg, %opt) = @_;
248 warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
249 my %values = $self->usage_valuehash;
250 if ($self->option('usage_rollover', 1)) {
251 $cust_pkg->recharge(\%values);
253 $cust_pkg->set_usage(\%values, %opt);