X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fflat.pm;h=d1863f4321643801f7713f2c4a8bad4808e874aa;hb=883f6c25e41831d9183e9500accb89f4cb23ae73;hp=c0fbb5a7fdf26ee6bb138157cb4380f4a2f57928;hpb=0dd05e9ff98263d2d42b419b1e278a5a3bc594b2;p=freeside.git diff --git a/FS/FS/part_pkg/flat.pm b/FS/FS/part_pkg/flat.pm index c0fbb5a7f..d1863f432 100644 --- a/FS/FS/part_pkg/flat.pm +++ b/FS/FS/part_pkg/flat.pm @@ -1,77 +1,125 @@ package FS::part_pkg::flat; use strict; -use vars qw(@ISA %info); +use vars qw( @ISA %info + %usage_fields %usage_recharge_fields + @usage_fieldorder @usage_recharge_fieldorder + ); +use Tie::IxHash; #use FS::Record qw(qsearch); +use FS::UI::bytecount; use FS::part_pkg; @ISA = qw(FS::part_pkg); -%info = ( - 'name' => 'Flat rate (anniversary billing)', - 'fields' => { - 'setup_fee' => { 'name' => 'Setup fee for this package', - 'default' => 0, - }, - 'recur_fee' => { 'name' => 'Recurring fee for this package', - 'default' => 0, - }, - 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'. - ' of service at cancellation', - 'type' => 'checkbox', - }, - 'externalid' => { 'name' => 'Optional External ID', - 'default' => '', - }, +tie my %temporalities, 'Tie::IxHash', + 'upcoming' => "Upcoming (future)", + 'preceding' => "Preceding (past)", +; + +%usage_fields = ( + 'seconds' => { 'name' => 'Time limit for this package', 'default' => '', + 'check' => sub { shift =~ /^\d*$/ }, }, 'upbytes' => { 'name' => 'Upload limit for this package', 'default' => '', - 'format' => \&FS::UI::Web::display_bytecount, - 'parse' => \&FS::UI::Web::parse_bytecount, + 'check' => sub { shift =~ /^\d*$/ }, + 'format' => \&FS::UI::bytecount::display_bytecount, + 'parse' => \&FS::UI::bytecount::parse_bytecount, }, 'downbytes' => { 'name' => 'Download limit for this package', 'default' => '', - 'format' => \&FS::UI::Web::display_bytecount, - 'parse' => \&FS::UI::Web::parse_bytecount, + 'check' => sub { shift =~ /^\d*$/ }, + 'format' => \&FS::UI::bytecount::display_bytecount, + 'parse' => \&FS::UI::bytecount::parse_bytecount, }, 'totalbytes' => { 'name' => 'Transfer limit for this package', 'default' => '', - 'format' => \&FS::UI::Web::display_bytecount, - 'parse' => \&FS::UI::Web::parse_bytecount, + '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' => '', - 'format' => \&FS::UI::Web::display_bytecount, - 'parse' => \&FS::UI::Web::parse_bytecount, + 'check' => sub { shift =~ /^\d*(\.\d{2})?$/ }, }, 'recharge_seconds' => { 'name' => 'Recharge time for this package', 'default' => '', - 'format' => \&FS::UI::Web::display_bytecount, - 'parse' => \&FS::UI::Web::parse_bytecount, + 'check' => sub { shift =~ /^\d*$/ }, }, 'recharge_upbytes' => { 'name' => 'Recharge upload for this package', 'default' => '', - 'format' => \&FS::UI::Web::display_bytecount, - 'parse' => \&FS::UI::Web::parse_bytecount, + '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' => '', - 'format' => \&FS::UI::Web::display_bytecount, - 'parse' => \&FS::UI::Web::parse_bytecount, + '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' => '', - 'format' => \&FS::UI::Web::display_bytecount, - 'parse' => \&FS::UI::Web::parse_bytecount, + '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', + '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, + }, + + %usage_fields, + %usage_recharge_fields, + + 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'. + ' of service at cancellation', + 'type' => 'checkbox', + }, + 'externalid' => { 'name' => 'Optional External ID', + 'default' => '', + }, }, - 'fieldorder' => [ 'setup_fee', 'recur_fee', 'unused_credit', - 'seconds', 'upbytes', 'downbytes', 'totalbytes', - 'recharge_amount', 'recharge_seconds', 'recharge_upbytes', - 'recharge_downbytes', 'recharge_totalbytes', - 'externalid' ], + 'fieldorder' => [ qw( setup_fee recur_fee recur_temporality unused_credit ), + @usage_fieldorder, @usage_recharge_fieldorder, + qw( externalid ), + ], 'weight' => 10, ); @@ -84,25 +132,58 @@ sub calc_setup { push @$details, $self->option( 'additional_info' . $i++ ); } + my $quantity = $cust_pkg->quantity || 1; + + sprintf("%.2f", $quantity * $self->unit_setup($cust_pkg, $sdate, $details) ); +} + +sub unit_setup { + my($self, $cust_pkg, $sdate, $details ) = @_; + $self->option('setup_fee'); } sub calc_recur { - my($self, $cust_pkg) = @_; - $self->reset_usage($cust_pkg); - $self->base_recur($cust_pkg); + my $self = shift; + my($cust_pkg) = @_; + + #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->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0; + + $self->base_recur(@_); } sub base_recur { my($self, $cust_pkg) = @_; - $self->option('recur_fee'); + $self->option('recur_fee', 1) || 0; +} + +sub base_recur_permonth { + my($self, $cust_pkg) = @_; #$cust_pkg? + + return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0; + + sprintf('%.2f', $self->base_recur / $self->freq ); } sub calc_remain { - my ($self, $cust_pkg) = @_; - my $time = time; #should be able to pass this in for credit calculation + my ($self, $cust_pkg, %options) = @_; + + my $time; + if ($options{'time'}) { + $time = $options{'time'}; + } else { + $time = time; + } + my $next_bill = $cust_pkg->getfield('bill') || 0; - my $last_bill = $cust_pkg->last_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 || ! $self->option('unused_credit', 1) || ! $last_bill @@ -133,12 +214,22 @@ sub is_prepaid { 0; #no, we're postpaid } -sub reset_usage { - my($self, $cust_pkg) = @_; - my %values = map { $_, $self->option($_) } +sub usage_valuehash { + my $self = shift; + map { $_, $self->option($_) } grep { $self->option($_, 'hush') } qw(seconds upbytes downbytes totalbytes); - $cust_pkg->set_usage(\%values); +} + +sub reset_usage { + my($self, $cust_pkg, %opt) = @_; + warn " resetting usage counters" if $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;