X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fflat.pm;h=d4b95b5105221802574f626a36323d77c10c5610;hb=cb43a46ebb3d5c5ce8b60707093a53e8bb2e8f9b;hp=a17813bd5410997eb02442bfd07035ce4b466312;hpb=cc04f43d238a1aed658d766577e45d96fcb38d77;p=freeside.git diff --git a/FS/FS/part_pkg/flat.pm b/FS/FS/part_pkg/flat.pm index a17813bd5..d4b95b510 100644 --- a/FS/FS/part_pkg/flat.pm +++ b/FS/FS/part_pkg/flat.pm @@ -1,20 +1,16 @@ package FS::part_pkg::flat; use strict; -use vars qw( @ISA %info - %usage_fields %usage_recharge_fields - @usage_fieldorder @usage_recharge_fieldorder +use base qw( FS::part_pkg + FS::part_pkg::prorate_Mixin + FS::part_pkg::discount_Mixin ); +use vars qw( %info %usage_recharge_fields @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; - -@ISA = qw(FS::part_pkg - FS::part_pkg::prorate_Mixin - FS::part_pkg::discount_Mixin); tie my %temporalities, 'Tie::IxHash', 'upcoming' => "Upcoming (future)", @@ -26,97 +22,16 @@ tie my %contract_years, 'Tie::IxHash', ( map { $_*12 => $_ } (1..5), ); -%usage_fields = ( - - 'seconds' => { 'name' => 'Time limit for this package', - 'default' => '', - 'check' => sub { shift =~ /^\d*$/ }, - }, - 'upbytes' => { 'name' => 'Upload limit for this package', - 'default' => '', - 'check' => sub { shift =~ /^\d*$/ }, - 'format' => \&FS::UI::bytecount::display_bytecount, - 'parse' => \&FS::UI::bytecount::parse_bytecount, - }, - 'downbytes' => { 'name' => 'Download limit for this package', - 'default' => '', - 'check' => sub { shift =~ /^\d*$/ }, - 'format' => \&FS::UI::bytecount::display_bytecount, - 'parse' => \&FS::UI::bytecount::parse_bytecount, - }, - 'totalbytes' => { 'name' => 'Transfer limit for this package', - 'default' => '', - 'check' => sub { shift =~ /^\d*$/ }, - 'format' => \&FS::UI::bytecount::display_bytecount, - 'parse' => \&FS::UI::bytecount::parse_bytecount, - }, -); - -%usage_recharge_fields = ( - - 'recharge_amount' => { 'name' => 'Cost of recharge for this package', - 'default' => '', - 'check' => sub { shift =~ /^\d*(\.\d{2})?$/ }, - }, - 'recharge_seconds' => { 'name' => 'Recharge time for this package', - 'default' => '', - 'check' => sub { shift =~ /^\d*$/ }, - }, - 'recharge_upbytes' => { 'name' => 'Recharge upload for this package', - 'default' => '', - 'check' => sub { shift =~ /^\d*$/ }, - 'format' => \&FS::UI::bytecount::display_bytecount, - 'parse' => \&FS::UI::bytecount::parse_bytecount, - }, - 'recharge_downbytes' => { 'name' => 'Recharge download for this package', - 'default' => '', - 'check' => sub { shift =~ /^\d*$/ }, - 'format' => \&FS::UI::bytecount::display_bytecount, - 'parse' => \&FS::UI::bytecount::parse_bytecount, - }, - 'recharge_totalbytes' => { 'name' => 'Recharge transfer for this package', - 'default' => '', - 'check' => sub { shift =~ /^\d*$/ }, - 'format' => \&FS::UI::bytecount::display_bytecount, - 'parse' => \&FS::UI::bytecount::parse_bytecount, - }, - 'usage_rollover' => { 'name' => 'Allow usage from previous period to roll '. - ' over into current period', - 'type' => 'checkbox', - }, - 'recharge_reset' => { 'name' => 'Reset usage to these values on manual '. - 'package recharge', - 'type' => 'checkbox', - }, -); - -@usage_fieldorder = qw( seconds upbytes downbytes totalbytes ); -@usage_recharge_fieldorder = qw( - recharge_amount recharge_seconds recharge_upbytes - recharge_downbytes recharge_totalbytes - usage_rollover recharge_reset -); - %info = ( 'name' => 'Flat rate (anniversary billing)', 'shortname' => 'Anniversary', + 'inherit_fields' => [ 'usage_Mixin', 'global_Mixin' ], 'fields' => { - 'setup_fee' => { 'name' => 'Setup fee for this package', - 'default' => 0, - }, - 'recur_fee' => { 'name' => 'Recurring 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, }, - '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', @@ -136,6 +51,11 @@ tie my %contract_years, 'Tie::IxHash', ( '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', + }, 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended', 'type' => 'checkbox', }, @@ -145,29 +65,38 @@ tie my %contract_years, 'Tie::IxHash', ( '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( recur_temporality expire_months adjourn_months contract_end_months - start_1st sync_bill_date + start_1st sync_bill_date prorate_defer_bill suspend_bill unsuspend_adjust_bill - ), - @usage_fieldorder, @usage_recharge_fieldorder, - qw( externalid ), + 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, $sdate, $details ) = @_; + return 0 if $self->prorate_setup($cust_pkg, $sdate); + my $i = 0; my $count = $self->option( 'additional_count', 'quiet' ) || 0; while ($i < $count) { @@ -176,7 +105,8 @@ sub calc_setup { my $quantity = $cust_pkg->quantity || 1; - sprintf("%.2f", $quantity * $self->unit_setup($cust_pkg, $sdate, $details) ); + my $charge = $quantity * $self->unit_setup($cust_pkg, $sdate, $details); + sprintf('%.2f', $charge); } sub unit_setup { @@ -195,13 +125,9 @@ sub calc_recur { return 0 if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0; - my $charge = $self->base_recur($cust_pkg); - if ( $self->option('sync_bill_date',1) ) { - my $next_bill = $cust_pkg->cust_main->next_bill_date; - if ( defined($next_bill) and $next_bill != $$sdate ) { - my $cutoff_day = (localtime($next_bill))[3]; - $charge = $self->calc_prorate(@_, $cutoff_day); - } + my $charge = $self->base_recur($cust_pkg, $sdate); + if ( my $cutoff_day = $self->flat_cutoff_day($cust_pkg) ) { + $charge = $self->calc_prorate(@_); } elsif ( $param->{freq_override} ) { # XXX not sure if this should be mutually exclusive with sync_bill_date. @@ -214,8 +140,20 @@ sub calc_recur { return sprintf('%.2f', $charge - $discount); } +sub flat_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) = @_; + my($self, $cust_pkg, $sdate) = @_; $self->option('recur_fee', 1) || 0; } @@ -239,12 +177,7 @@ sub calc_remain { my $next_bill = $cust_pkg->getfield('bill') || 0; - #my $last_bill = $cust_pkg->last_bill || 0; - my $last_bill = $cust_pkg->get('last_bill') || 0; #->last_bill falls back to setup - - return 0 if ! $self->base_recur($cust_pkg) - || ! $self->option('unused_credit', 1) - || ! $last_bill + return 0 if ! $self->base_recur($cust_pkg, \$time) || ! $next_bill || $next_bill < $time; @@ -260,7 +193,7 @@ sub calc_remain { my $freq_sec = $1 * $sec{$2||'m'}; return 0 unless $freq_sec; - sprintf("%.2f", $self->base_recur($cust_pkg) * ( $next_bill - $time ) / $freq_sec ); + sprintf("%.2f", $self->base_recur($cust_pkg, \$time) * ( $next_bill - $time ) / $freq_sec ); }