X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fflat.pm;h=975e80ab32565ce6a4293aadecf1dfd11bf8d7c6;hb=74a3083375ccc3a0dc8b74f9b39392989d088656;hp=02ac6aeede4dd5b352983eb35163156b2b86a331;hpb=94a66b78bcda5605d7ee5eb7c3e692fb2fe5cf2c;p=freeside.git diff --git a/FS/FS/part_pkg/flat.pm b/FS/FS/part_pkg/flat.pm index 02ac6aeed..975e80ab3 100644 --- a/FS/FS/part_pkg/flat.pm +++ b/FS/FS/part_pkg/flat.pm @@ -6,11 +6,14 @@ use vars qw( @ISA %info @usage_fieldorder @usage_recharge_fieldorder ); use Tie::IxHash; +use List::Util qw(min); # max); #use FS::Record qw(qsearch); use FS::UI::bytecount; +use FS::Conf; use FS::part_pkg; +use FS::cust_bill_pkg_discount; -@ISA = qw(FS::part_pkg); +@ISA = qw(FS::part_pkg FS::part_pkg::prorate_Mixin); tie my %temporalities, 'Tie::IxHash', 'upcoming' => "Upcoming (future)", @@ -104,19 +107,43 @@ tie my %temporalities, 'Tie::IxHash', 'type' => 'select', 'select_options' => \%temporalities, }, - - %usage_fields, - %usage_recharge_fields, - 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'. ' of service at cancellation', 'type' => 'checkbox', }, + + #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', + }, + #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', + }, + 'unsuspend_adjust_bill' => + { 'name' => 'Adjust next bill date forward when '. + 'unsuspending', + 'type' => 'checkbox', + }, + + %usage_fields, + %usage_recharge_fields, + 'externalid' => { 'name' => 'Optional External ID', 'default' => '', }, }, - 'fieldorder' => [ qw( setup_fee recur_fee recur_temporality unused_credit ), + 'fieldorder' => [ qw( setup_fee recur_fee + recur_temporality unused_credit + expire_months adjourn_months + start_1st sync_bill_date + unsuspend_adjust_bill + ), @usage_fieldorder, @usage_recharge_fieldorder, qw( externalid ), ], @@ -140,12 +167,12 @@ sub calc_setup { sub unit_setup { my($self, $cust_pkg, $sdate, $details ) = @_; - $self->option('setup_fee'); + $self->option('setup_fee') || 0; } sub calc_recur { my $self = shift; - my($cust_pkg) = @_; + 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 @@ -153,7 +180,100 @@ sub calc_recur { return 0 if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0; - $self->base_recur(@_); + if( $self->option('sync_bill_date',1) ) { + return $self->calc_prorate(@_); + } + else { + my $charge = $self->base_recur($cust_pkg); + $charge *= $param->{freq_override} if $param->{freq_override}; + my $discount = $self->calc_discount($cust_pkg, $sdate, $details, $param); + + return sprintf('%.2f', $charge - $discount); + } +} + +sub calc_discount { + my($self, $cust_pkg, $sdate, $details, $param ) = @_; + + my $br = $self->base_recur($cust_pkg); + + my $tot_discount = 0; + #UI enforces just 1 for now, will need ordering when they can be stacked + + if ( $param->{freq_override} ) { + my $real_part_pkg = new FS::part_pkg { $self->hash }; + $real_part_pkg->pkgpart($param->{real_pkgpart} || $self->pkgpart); + my @discount = grep { $_->months == $param->{freq_override} } + map { $_->discount } + $real_part_pkg->part_pkg_discount; + my $discount = shift @discount; + $param->{months} = $param->{freq_override} unless $param->{months}; + my $error; + if ($discount) { + if ($discount->months == $param->{months}) { + $cust_pkg->discountnum($discount->discountnum); + $error = $cust_pkg->insert_discount; + } else { + $cust_pkg->discountnum(-1); + foreach ( qw( amount percent months ) ) { + my $method = "discountnum_$_"; + $cust_pkg->$method($discount->$_); + } + $error = $cust_pkg->insert_discount; + } + die "error discounting using part_pkg_discount: $error" if $error; + } + } + + my @cust_pkg_discount = $cust_pkg->cust_pkg_discount_active; + foreach my $cust_pkg_discount ( @cust_pkg_discount ) { + my $discount = $cust_pkg_discount->discount; + #UI enforces one or the other (for now? probably for good) + my $amount = 0; + $amount += $discount->amount + if $cust_pkg->pkgpart == $param->{real_pkgpart}; + $amount += sprintf('%.2f', $discount->percent * $br / 100 ); + + my $chg_months = $param->{'months'} || $cust_pkg->part_pkg->freq; + + my $months = $discount->months + ? min( $chg_months, + $discount->months - $cust_pkg_discount->months_used ) + : $chg_months; + + my $error = $cust_pkg_discount->increment_months_used($months) + if $cust_pkg->pkgpart == $param->{real_pkgpart}; + die "error discounting: $error" if $error; + + $amount *= $months; + $amount = sprintf('%.2f', $amount); + + next unless $amount > 0; + + #record details in cust_bill_pkg_discount + my $cust_bill_pkg_discount = new FS::cust_bill_pkg_discount { + 'pkgdiscountnum' => $cust_pkg_discount->pkgdiscountnum, + 'amount' => $amount, + 'months' => $months, + }; + push @{ $param->{'discounts'} }, $cust_bill_pkg_discount; + + #add details on discount to invoice + my $conf = new FS::Conf; + my $money_char = $conf->config('money_char') || '$'; + $months = sprintf('%.2f', $months) if $months =~ /\./; + + my $d = 'Includes '; + $d .= $discount->name. ' ' if $discount->name; + $d .= 'discount of '. $discount->description_short; + $d .= " for $months month". ( $months!=1 ? 's' : '' ); + $d .= ": $money_char$amount" if $months != 1 || $discount->percent; + push @$details, $d; + + $tot_discount += $amount; + } + + sprintf('%.2f', $tot_discount); } sub base_recur { @@ -210,8 +330,12 @@ sub is_free_options { qw( setup_fee recur_fee ); } -sub is_prepaid { - 0; #no, we're postpaid +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 { + my $self = shift; + $self->freq =~ /^\d+$/ && $self->freq > 0; } sub usage_valuehash { @@ -223,7 +347,7 @@ sub usage_valuehash { sub reset_usage { my($self, $cust_pkg, %opt) = @_; - warn " resetting usage counters" if $opt{debug} > 1; + 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);