package FS::part_pkg::flat;
+use base qw( FS::part_pkg::prorate_Mixin
+ FS::part_pkg::discount_Mixin
+ FS::part_pkg
+ );
use strict;
-use vars qw(@ISA %info);
-#use FS::Record qw(qsearch);
-use FS::part_pkg;
+use vars qw( %info %usage_recharge_fields @usage_recharge_fieldorder );
+use Tie::IxHash;
+use List::Util qw( min );
+use FS::UI::bytecount;
+use FS::Conf;
-@ISA = qw(FS::part_pkg);
+tie my %temporalities, 'Tie::IxHash',
+ 'upcoming' => "Upcoming (future)",
+ 'preceding' => "Preceding (past)",
+;
+
+tie my %contract_years, 'Tie::IxHash', (
+ '' => '(none)',
+ map { $_*12 => $_ } (1..5),
+);
%info = (
'name' => 'Flat rate (anniversary billing)',
+ 'shortname' => 'Anniversary',
+ 'inherit_fields' => [ 'prorate_Mixin', 'usage_Mixin', 'global_Mixin' ],
'fields' => {
- 'setup_fee' => { 'name' => 'Setup fee for this package',
- 'default' => 0,
+ #false laziness w/voip_cdr.pm
+ 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
+ 'type' => 'select',
+ 'select_options' => \%temporalities,
+ },
+
+ #used in cust_pkg.pm so could add to any price plan
+ 'expire_months' => { 'name' => 'Auto-add an expiration date this number of months out',
},
- 'recur_fee' => { 'name' => 'Recurring fee for this package',
- 'default' => 0,
+ 'adjourn_months'=> { 'name' => 'Auto-add a suspension date this number of months out',
},
- 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
- ' of service at cancellation',
+ 'contract_end_months'=> {
+ 'name' => 'Auto-add a contract end date this number of years out',
+ 'type' => 'select',
+ 'select_options' => \%contract_years,
+ },
+ #used in cust_pkg.pm so could add to any price plan where it made sense
+ 'start_1st' => { 'name' => 'Auto-add a start date to the 1st, ignoring the current month.',
'type' => 'checkbox',
},
+ 'sync_bill_date' => { 'name' => 'Prorate first month to synchronize '.
+ 'with the customer\'s other packages',
+ 'type' => 'checkbox',
+ },
+ 'prorate_defer_bill' => {
+ 'name' => 'When synchronizing, defer the bill until '.
+ 'the customer\'s next bill date',
+ 'type' => 'checkbox',
+ },
+ 'prorate_round_day' => {
+ 'name' => 'When synchronizing, round the prorated '.
+ 'period to the nearest full day',
+ 'type' => 'checkbox',
+ },
+ 'add_full_period' => { 'disabled' => 1 }, # doesn't make sense with sync?
+
+ 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
+ 'type' => 'checkbox',
+ },
+ 'unsuspend_adjust_bill' =>
+ { 'name' => 'Adjust next bill date forward when '.
+ 'unsuspending',
+ 'type' => 'checkbox',
+ },
+
+ 'externalid' => { 'name' => 'Optional External ID',
+ 'default' => '',
+ },
},
- 'fieldorder' => [ 'setup_fee', 'recur_fee', 'unused_credit' ],
- #'setup' => 'what.setup_fee.value',
- #'recur' => 'what.recur_fee.value',
+ 'fieldorder' => [ qw( recur_temporality
+ expire_months adjourn_months
+ contract_end_months
+ start_1st
+ sync_bill_date prorate_defer_bill prorate_round_day
+ suspend_bill unsuspend_adjust_bill
+ externalid ),
+ ],
'weight' => 10,
);
+sub price_info {
+ my $self = shift;
+ my $conf = new FS::Conf;
+ my $money_char = $conf->config('money_char') || '$';
+ my $setup = $self->option('setup_fee') || 0;
+ my $recur = $self->option('recur_fee', 1) || 0;
+ my $str = '';
+ $str = $money_char . $setup . ' one-time' if $setup;
+ $str .= ', ' if ($setup && $recur);
+ $str .= $money_char . $recur . ' recurring ' if $recur;
+ $str;
+}
+
sub calc_setup {
- my($self, $cust_pkg ) = @_;
- $self->option('setup_fee');
+ my($self, $cust_pkg, $sdate, $details, $param ) = @_;
+
+ return 0 if $self->prorate_setup($cust_pkg, $sdate);
+
+ my $i = 0;
+ my $count = $self->option( 'additional_count', 'quiet' ) || 0;
+ while ($i < $count) {
+ push @$details, $self->option( 'additional_info' . $i++ );
+ }
+
+ my $quantity = $cust_pkg->quantity || 1;
+
+ my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details);
+
+ my $discount = 0;
+ if ( $charge > 0 ) {
+ $param->{'setup_charge'} = $charge;
+ $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
+ delete $param->{'setup_charge'};
+ }
+
+ sprintf('%.2f', $charge - $discount);
+}
+
+sub unit_setup {
+ my($self, $cust_pkg, $sdate, $details ) = @_;
+
+ $self->option('setup_fee') || 0;
}
sub calc_recur {
my $self = shift;
- $self->base_recur(@_);
+ my($cust_pkg, $sdate, $details, $param ) = @_;
+
+ #my $last_bill = $cust_pkg->last_bill;
+ my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
+
+ return 0
+ if $self->recur_temporality eq 'preceding' && $last_bill == 0;
+
+ my $charge = $self->base_recur($cust_pkg, $sdate);
+ if ( my $cutoff_day = $self->cutoff_day($cust_pkg) ) {
+ $charge = $self->calc_prorate(@_, $cutoff_day);
+ }
+ elsif ( $param->{freq_override} ) {
+ # XXX not sure if this should be mutually exclusive with sync_bill_date.
+ # Given the very specific problem that freq_override is meant to 'solve',
+ # it probably should.
+ $charge *= $param->{freq_override} if $param->{freq_override};
+ }
+
+ my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param);
+ return sprintf('%.2f', $charge - $discount);
+}
+
+sub cutoff_day {
+ my $self = shift;
+ my $cust_pkg = shift;
+ if ( $self->option('sync_bill_date',1) ) {
+ my $next_bill = $cust_pkg->cust_main->next_bill_date;
+ if ( defined($next_bill) ) {
+ return (localtime($next_bill))[3];
+ }
+ }
+ return 0;
}
sub base_recur {
+ my($self, $cust_pkg, $sdate) = @_;
+ $self->option('recur_fee', 1) || 0;
+}
+
+sub base_recur_permonth {
my($self, $cust_pkg) = @_;
- $self->option('recur_fee');
+
+ return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0;
+
+ sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq );
}
sub calc_remain {
- my ($self, $cust_pkg) = @_;
- my $time = time;
- my $next_bill = $cust_pkg->getfield('bill') || 0;
- my $last_bill = $cust_pkg->last_bill || 0;
- return 0 if ! $self->base_recur
- || ! $self->option('unused_credit', 1)
- || ! $last_bill
- || ! $next_bill;
+ my ($self, $cust_pkg, %options) = @_;
- my $now_date = ParseDate("epoch $time");
- my $last_date = ParseDate("epoch $last_bill");
- my $next_date = ParseDate("epoch $next_bill");
- my $err;
- my $delta = DateCalc($now_date,$next_date,\$err, 0);
- my $days_remaining = Delta_Format($delta, 4, "%dh");
+ my $time;
+ if ($options{'time'}) {
+ $time = $options{'time'};
+ } else {
+ $time = time;
+ }
- my $frequency = $self->freq;
+ my $next_bill = $cust_pkg->getfield('bill') || 0;
- # TODO: Remove this after the frequencies are Data::Manip friendly.
- $frequency .= "m" unless $frequency =~ /[wd]$/;
+ return 0 if ! $self->base_recur($cust_pkg, \$time)
+ || ! $next_bill
+ || $next_bill < $time;
- my $freq_delta = ParseDateDelta($frequency);
- my $days = Delta_Format($freq_delta,4,"%dh");
+ my %sec = (
+ 'h' => 3600, # 60 * 60
+ 'd' => 86400, # 60 * 60 * 24
+ 'w' => 604800, # 60 * 60 * 24 * 7
+ 'm' => 2629744, # 60 * 60 * 24 * 365.2422 / 12
+ );
- my $recurring= $self->base_recur;
- my $daily = $recurring/$days;
+ $self->freq =~ /^(\d+)([hdwm]?)$/
+ or die 'unparsable frequency: '. $self->freq;
+ my $freq_sec = $1 * $sec{$2||'m'};
+ return 0 unless $freq_sec;
+
+ sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec );
- sprintf("%.2f",($daily * $days_remaining));
}
sub is_free_options {
qw( setup_fee recur_fee );
}
+sub is_prepaid { 0; } #no, we're postpaid
+
+sub can_start_date { ! shift->option('start_1st', 1) }
+
+sub can_discount { 1; }
+
+sub recur_temporality {
+ my $self = shift;
+ $self->option('recur_temporality', 1);
+}
+
+sub usage_valuehash {
+ my $self = shift;
+ map { $_, $self->option($_) }
+ grep { $self->option($_, 'hush') }
+ qw(seconds upbytes downbytes totalbytes);
+}
+
+sub reset_usage {
+ my($self, $cust_pkg, %opt) = @_;
+ warn " resetting usage counters" if defined($opt{debug}) && $opt{debug} > 1;
+ my %values = $self->usage_valuehash;
+ if ($self->option('usage_rollover', 1)) {
+ $cust_pkg->recharge(\%values);
+ }else{
+ $cust_pkg->set_usage(\%values, %opt);
+ }
+}
+
1;
projects / freeside.git / blobdiff