X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fflat.pm;h=97d4363da910c5b16bf81943db2946ea98c166c9;hp=60a2346ace4a02737486c9e31ec37872b7f6e337;hb=44dcd4a1ff335a85a6babf0e007be57e6ec4f525;hpb=581d4b07156ba59e7445235305872c74aa97c6d9 diff --git a/FS/FS/part_pkg/flat.pm b/FS/FS/part_pkg/flat.pm index 60a2346ac..97d4363da 100644 --- a/FS/FS/part_pkg/flat.pm +++ b/FS/FS/part_pkg/flat.pm @@ -1,19 +1,26 @@ 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 vars qw( $conf $money_char %info %usage_recharge_fields @usage_recharge_fieldorder ); +use FS::UID; +use FS::Record qw( qsearch ); +use FS::cust_credit_source_bill_pkg; use Tie::IxHash; -use List::Util qw(min); # max); -#use FS::Record qw(qsearch); +use List::Util qw( min ); use FS::UI::bytecount; use FS::Conf; -use FS::part_pkg; -@ISA = qw(FS::part_pkg - FS::part_pkg::prorate_Mixin - FS::part_pkg::discount_Mixin); +#ask FS::UID to run this stuff for us later +FS::UID->install_callback( sub { + $conf = new FS::Conf; + $money_char = $conf->config('money_char') || '$'; +}); tie my %temporalities, 'Tie::IxHash', 'upcoming' => "Upcoming (future)", @@ -28,7 +35,7 @@ tie my %contract_years, 'Tie::IxHash', ( %info = ( 'name' => 'Flat rate (anniversary billing)', 'shortname' => 'Anniversary', - 'inherit_fields' => [ 'usage_Mixin', 'global_Mixin' ], + 'inherit_fields' => [ 'prorate_Mixin', 'usage_Mixin', 'global_Mixin' ], 'fields' => { #false laziness w/voip_cdr.pm 'recur_temporality' => { 'name' => 'Charge recurring fee for period', @@ -36,16 +43,6 @@ tie my %contract_years, 'Tie::IxHash', ( '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', - }, - 'adjourn_months'=> { 'name' => 'Auto-add a suspension date this number of months out', - }, - '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', @@ -59,6 +56,14 @@ tie my %contract_years, 'Tie::IxHash', ( 'the customer\'s next bill date', 'type' => 'checkbox', }, + 'prorate_round_day' => { + 'name' => 'When synchronizing, round the prorated '. + 'period', + 'type' => 'select', + 'select_options' => \%FS::part_pkg::prorate_Mixin::prorate_round_day_opts, + }, + 'add_full_period' => { 'disabled' => 1 }, # doesn't make sense with sync? + 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended', 'type' => 'checkbox', }, @@ -67,23 +72,48 @@ tie my %contract_years, 'Tie::IxHash', ( 'unsuspending', 'type' => 'checkbox', }, - + 'bill_recur_on_cancel' => { + 'name' => 'Bill the last period on cancellation', + 'type' => 'checkbox', + }, + 'bill_suspend_as_cancel' => { + 'name' => 'Bill immediately upon suspension', #desc? + 'type' => 'checkbox', + }, 'externalid' => { 'name' => 'Optional External ID', 'default' => '', }, }, 'fieldorder' => [ qw( recur_temporality - expire_months adjourn_months - contract_end_months - start_1st sync_bill_date prorate_defer_bill + start_1st + sync_bill_date prorate_defer_bill prorate_round_day suspend_bill unsuspend_adjust_bill + bill_recur_on_cancel + bill_suspend_as_cancel externalid ), ], 'weight' => 10, ); +sub price_info { + my $self = shift; + my %opt = @_; + + my $setup = $opt{cust_pkg} ? $self->base_setup( $opt{cust_pkg} ) + : ($self->option('setup_fee') || 0); + my $recur = $opt{cust_pkg} ? $self->base_recur( $opt{cust_pkg} ) + : ($self->option('recur_fee', 1) || 0); + $recur += $self->usageprice_recur( $opt{cust_pkg} ) if $opt{cust_pkg}; + + my $str = ''; + $str = $money_char . $setup . ($recur ? ' setup' : ' one-time') if $setup; + $str .= ', ' if ($setup && $recur); + $str .= $money_char. $recur. '/'. $self->freq_pretty if $recur; + $str; +} + sub calc_setup { - my($self, $cust_pkg, $sdate, $details ) = @_; + my($self, $cust_pkg, $sdate, $details, $param ) = @_; return 0 if $self->prorate_setup($cust_pkg, $sdate); @@ -93,16 +123,21 @@ sub calc_setup { push @$details, $self->option( 'additional_info' . $i++ ); } - my $quantity = $cust_pkg->quantity || 1; + my $charge = $self->base_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'}; + } - my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details); - sprintf('%.2f', $charge); + sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) ); } -sub unit_setup { +sub base_setup { my($self, $cust_pkg, $sdate, $details ) = @_; - - $self->option('setup_fee') || 0; + $self->option('setup_fee', 1) || 0; } sub calc_recur { @@ -113,11 +148,12 @@ sub calc_recur { my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup return 0 - if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0; + if $self->recur_temporality eq 'preceding' && !$last_bill; my $charge = $self->base_recur($cust_pkg, $sdate); - if ( my $cutoff_day = $self->cutoff_day($cust_pkg) ) { - $charge = $self->calc_prorate(@_); + # always treat cutoff_day as a list + 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. @@ -126,8 +162,12 @@ sub calc_recur { $charge *= $param->{freq_override} if $param->{freq_override}; } + $charge += $self->usageprice_recur($cust_pkg, $sdate); + $cust_pkg->apply_usageprice(); #$sdate for prorating? + my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param); - return sprintf('%.2f', $charge - $discount); + + sprintf( '%.2f', ($cust_pkg->quantity || 1) * ($charge - $discount) ); } sub cutoff_day { @@ -135,11 +175,17 @@ sub cutoff_day { 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) ) { + if ( $next_bill ) { + # careful here. if the prorate calculation is going to round to + # the nearest day, this needs to always return the same result + if ( $self->option('prorate_round_day', 1) ) { + my $hour = (localtime($next_bill))[2]; + $next_bill += 64800 if $hour >= 12; + } return (localtime($next_bill))[3]; } } - return 0; + return (); } sub base_recur { @@ -155,6 +201,32 @@ sub base_recur_permonth { sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq ); } +sub usageprice_recur { + my($self, $cust_pkg, $sdate) = @_; + + my $recur = 0; + $recur += $_->price foreach $cust_pkg->cust_pkg_usageprice; + + sprintf('%.2f', $recur); +} + +sub calc_cancel { + my $self = shift; + if ( $self->recur_temporality eq 'preceding' + and $self->option('bill_recur_on_cancel', 1) ) { + # run another recurring cycle + return $self->calc_recur(@_); + } elsif ( $conf->exists('bill_usage_on_cancel') # should be a package option? + and $self->can('calc_usage') ) { + # bill for outstanding usage + return $self->calc_usage(@_); + } else { + return 'NOTHING'; # numerically zero, but has special meaning + } +} + +# no longer used; see credit_remaining in FS::cust_pkg + sub calc_remain { my ($self, $cust_pkg, %options) = @_; @@ -171,19 +243,48 @@ sub calc_remain { || ! $next_bill || $next_bill < $time; - 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 - ); + # Use actual charge for this period, not base_recur (for discounts). + # Use sdate < $time and edate >= $time because when billing on + # cancellation, edate = $time. + my $credit = 0; + foreach my $cust_bill_pkg ( + qsearch('cust_bill_pkg', { + pkgnum => $cust_pkg->pkgnum, + edate => {op => '>=', value => $time}, + recur => {op => '>' , value => 0}, + }) + ) { + + # hack to deal with the weird behavior of edate on package cancellation + my $edate = $cust_bill_pkg->edate; + if ( $self->recur_temporality eq 'preceding' ) { + $edate = $self->add_freq($cust_bill_pkg->sdate); + } - $self->freq =~ /^(\d+)([hdwm]?)$/ - or die 'unparsable frequency: '. $self->freq; - my $freq_sec = $1 * $sec{$2||'m'}; - return 0 unless $freq_sec; + # this will also get any package charges that are _entirely_ after the + # cancellation date (can happen with advance billing). in that case, + # use the entire recurring charge: + my $amount = $cust_bill_pkg->recur - $cust_bill_pkg->usage; - sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec ); + # but if the cancellation happens during the interval, prorate it: + # (XXX obey prorate_round_day here?) + if ( $cust_bill_pkg->sdate < $time ) { + $amount = $amount * ($edate - $time) / ($edate - $cust_bill_pkg->sdate); + } + + $credit += $amount; + + push @{ $options{'cust_credit_source_bill_pkg'} }, + new FS::cust_credit_source_bill_pkg { + 'billpkgnum' => $cust_bill_pkg->billpkgnum, + 'amount' => sprintf('%.2f', $amount), + 'currency' => $cust_bill_pkg->cust_bill->currency, + } + if $options{'cust_credit_source_bill_pkg'}; + + } + + sprintf('%.2f', $credit); } @@ -193,10 +294,24 @@ sub is_free_options { sub is_prepaid { 0; } #no, we're postpaid -#XXX discounts only on recurring fees for now (no setup/one-time or usage) -sub can_discount { +sub can_start_date { + my $self = shift; + my %opt = @_; + return 0 if $self->start_on_hold; + + ! $self->option('start_1st', 1) && ( ! $self->option('sync_bill_date',1) + || ! $self->option('prorate_defer_bill',1) + || ! $opt{'num_ncancelled_pkgs'} + ); +} + +sub can_discount { 1; } + +sub can_usageprice { 1; } + +sub recur_temporality { my $self = shift; - $self->freq =~ /^\d+$/ && $self->freq > 0; + $self->option('recur_temporality', 1); } sub usage_valuehash {