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 'prorate_defer_bill' => {
55 'name' => 'When synchronizing, defer the bill until '.
56 'the customer\'s next bill date',
59 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
62 'unsuspend_adjust_bill' =>
63 { 'name' => 'Adjust next bill date forward when '.
68 'externalid' => { 'name' => 'Optional External ID',
72 'fieldorder' => [ qw( recur_temporality
73 expire_months adjourn_months
75 start_1st sync_bill_date prorate_defer_bill
76 suspend_bill unsuspend_adjust_bill
84 my $conf = new FS::Conf;
85 my $money_char = $conf->config('money_char') || '$';
86 my $setup = $self->option('setup_fee') || 0;
87 my $recur = $self->option('recur_fee', 1) || 0;
89 $str = $money_char . $setup . ' one-time' if $setup;
90 $str .= ', ' if ($setup && $recur);
91 $str .= $money_char . $recur . ' recurring ' if $recur;
96 my($self, $cust_pkg, $sdate, $details ) = @_;
98 return 0 if $self->prorate_setup($cust_pkg, $sdate);
101 my $count = $self->option( 'additional_count', 'quiet' ) || 0;
102 while ($i < $count) {
103 push @$details, $self->option( 'additional_info' . $i++ );
106 my $quantity = $cust_pkg->quantity || 1;
108 my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details);
109 sprintf('%.2f', $charge);
113 my($self, $cust_pkg, $sdate, $details ) = @_;
115 $self->option('setup_fee') || 0;
120 my($cust_pkg, $sdate, $details, $param ) = @_;
122 #my $last_bill = $cust_pkg->last_bill;
123 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
126 if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
128 my $charge = $self->base_recur($cust_pkg, $sdate);
129 if ( my $cutoff_day = $self->cutoff_day($cust_pkg) ) {
130 $charge = $self->calc_prorate(@_, $cutoff_day);
132 elsif ( $param->{freq_override} ) {
133 # XXX not sure if this should be mutually exclusive with sync_bill_date.
134 # Given the very specific problem that freq_override is meant to 'solve',
135 # it probably should.
136 $charge *= $param->{freq_override} if $param->{freq_override};
139 my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
140 return sprintf('%.2f', $charge - $discount);
145 my $cust_pkg = shift;
146 if ( $self->option('sync_bill_date',1) ) {
147 my $next_bill = $cust_pkg->cust_main->next_bill_date;
148 if ( defined($next_bill) ) {
149 return (localtime($next_bill))[3];
156 my($self, $cust_pkg, $sdate) = @_;
157 $self->option('recur_fee', 1) || 0;
160 sub base_recur_permonth {
161 my($self, $cust_pkg) = @_;
163 return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
165 sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
169 my ($self, $cust_pkg, %options) = @_;
172 if ($options{'time'}) {
173 $time = $options{'time'};
178 my $next_bill = $cust_pkg->getfield('bill') || 0;
180 return 0 if ! $self->base_recur($cust_pkg, \$time)
182 || $next_bill < $time;
185 'h' => 3600, # 60 * 60
186 'd' => 86400, # 60 * 60 * 24
187 'w' => 604800, # 60 * 60 * 24 * 7
188 'm' => 2629744, # 60 * 60 * 24 * 365.2422 / 12
191 $self->freq =~ /^(\d+)([hdwm]?)$/
192 or die 'unparsable frequency: '. $self->freq;
193 my $freq_sec = $1 * $sec{$2||'m'};
194 return 0 unless $freq_sec;
196 sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec );
200 sub is_free_options {
201 qw( setup_fee recur_fee );
204 sub is_prepaid { 0; } #no, we're postpaid
206 #XXX discounts only on recurring fees for now (no setup/one-time or usage)
209 $self->freq =~ /^\d+$/ && $self->freq > 0;
212 sub usage_valuehash {
214 map { $_, $self->option($_) }
215 grep { $self->option($_, 'hush') }
216 qw(seconds upbytes downbytes totalbytes);
220 my($self, $cust_pkg, %opt) = @_;
221 warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
222 my %values = $self->usage_valuehash;
223 if ($self->option('usage_rollover', 1)) {
224 $cust_pkg->recharge(\%values);
226 $cust_pkg->set_usage(\%values, %opt);