1 package FS::part_pkg::flat;
4 use base qw( FS::part_pkg
5 FS::part_pkg::prorate_Mixin
6 FS::part_pkg::discount_Mixin
8 use vars qw( %info %usage_recharge_fields @usage_recharge_fieldorder );
10 use List::Util qw(min); # max);
11 #use FS::Record qw(qsearch);
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' => [ '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 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
57 'unsuspend_adjust_bill' =>
58 { 'name' => 'Adjust next bill date forward when '.
63 'externalid' => { 'name' => 'Optional External ID',
67 'fieldorder' => [ qw( recur_temporality
68 expire_months adjourn_months
70 start_1st sync_bill_date
71 suspend_bill unsuspend_adjust_bill
79 my $conf = new FS::Conf;
80 my $money_char = $conf->config('money_char') || '$';
81 my $setup = $self->option('setup_fee') || 0;
82 my $recur = $self->option('recur_fee', 1) || 0;
84 $str = $money_char . $setup . ' one-time' if $setup;
85 $str .= ', ' if ($setup && $recur);
86 $str .= $money_char . $recur . ' recurring ' if $recur;
91 my($self, $cust_pkg, $sdate, $details ) = @_;
94 my $count = $self->option( 'additional_count', 'quiet' ) || 0;
96 push @$details, $self->option( 'additional_info' . $i++ );
99 my $quantity = $cust_pkg->quantity || 1;
101 my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details);
103 my $param = { 'setup_charge' => $charge };
104 my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
106 sprintf('%.2f', $charge - $discount);
110 my($self, $cust_pkg, $sdate, $details ) = @_;
112 $self->option('setup_fee') || 0;
117 my($cust_pkg, $sdate, $details, $param ) = @_;
119 #my $last_bill = $cust_pkg->last_bill;
120 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
123 if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
125 my $charge = $self->base_recur($cust_pkg, $sdate);
126 if ( $self->option('sync_bill_date',1) ) {
127 my $next_bill = $cust_pkg->cust_main->next_bill_date;
128 if ( defined($next_bill) ) {
129 my $cutoff_day = (localtime($next_bill))[3];
130 $charge = $self->calc_prorate(@_, $cutoff_day);
133 elsif ( $param->{freq_override} ) {
134 # XXX not sure if this should be mutually exclusive with sync_bill_date.
135 # Given the very specific problem that freq_override is meant to 'solve',
136 # it probably should.
137 $charge *= $param->{freq_override} if $param->{freq_override};
140 my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
141 return sprintf('%.2f', $charge - $discount);
145 my($self, $cust_pkg, $sdate) = @_;
146 $self->option('recur_fee', 1) || 0;
149 sub base_recur_permonth {
150 my($self, $cust_pkg) = @_;
152 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
154 sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
158 my ($self, $cust_pkg, %options) = @_;
161 if ($options{'time'}) {
162 $time = $options{'time'};
167 my $next_bill = $cust_pkg->getfield('bill') || 0;
169 return 0 if ! $self->base_recur($cust_pkg, \$time)
171 || $next_bill < $time;
174 'h' => 3600, # 60 * 60
175 'd' => 86400, # 60 * 60 * 24
176 'w' => 604800, # 60 * 60 * 24 * 7
177 'm' => 2629744, # 60 * 60 * 24 * 365.2422 / 12
180 $self->freq =~ /^(\d+)([hdwm]?)$/
181 or die 'unparsable frequency: '. $self->freq;
182 my $freq_sec = $1 * $sec{$2||'m'};
183 return 0 unless $freq_sec;
185 sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec );
189 sub is_free_options {
190 qw( setup_fee recur_fee );
193 sub is_prepaid { 0; } #no, we're postpaid
195 #XXX discounts only on recurring fees for now (no setup/one-time or usage)
198 $self->freq =~ /^\d+$/ && $self->freq > 0;
201 sub usage_valuehash {
203 map { $_, $self->option($_) }
204 grep { $self->option($_, 'hush') }
205 qw(seconds upbytes downbytes totalbytes);
209 my($self, $cust_pkg, %opt) = @_;
210 warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
211 my %values = $self->usage_valuehash;
212 if ($self->option('usage_rollover', 1)) {
213 $cust_pkg->recharge(\%values);
215 $cust_pkg->set_usage(\%values, %opt);