X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fflat.pm;h=2f8fadf7f5464e4ae2c4f390acfda1f2555f5106;hb=b800a3e44db3b68e72933242dae6d95b6968fd52;hp=b62aebd7d78f68b3794118e3ff274b6b13285af8;hpb=f7fd2a3e34da751cbc02bbf215e99c6dc89adc15;p=freeside.git diff --git a/FS/FS/part_pkg/flat.pm b/FS/FS/part_pkg/flat.pm index b62aebd7d..2f8fadf7f 100644 --- a/FS/FS/part_pkg/flat.pm +++ b/FS/FS/part_pkg/flat.pm @@ -2,39 +2,199 @@ package FS::part_pkg::flat; use strict; use vars qw(@ISA %info); +use Tie::IxHash; #use FS::Record qw(qsearch); +use FS::UI::bytecount; use FS::part_pkg; @ISA = qw(FS::part_pkg); +tie my %temporalities, 'Tie::IxHash', + 'upcoming' => "Upcoming (future)", + 'preceding' => "Preceding (past)", +; + %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, + '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', + }, + 'externalid' => { 'name' => 'Optional External ID', + 'default' => '', }, + '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, + }, + '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', + }, }, - 'fieldorder' => [ 'setup_fee', 'recur_fee' ], - #'setup' => 'what.setup_fee.value', - #'recur' => 'what.recur_fee.value', + 'fieldorder' => [qw( setup_fee recur_fee recur_temporality unused_credit + seconds upbytes downbytes totalbytes + recharge_amount recharge_seconds recharge_upbytes + recharge_downbytes recharge_totalbytes + usage_rollover recharge_reset externalid + ) + ], 'weight' => 10, ); sub calc_setup { - my($self, $cust_pkg ) = @_; + my($self, $cust_pkg, $sdate, $details ) = @_; + + 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; + + 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->option('recur_fee'); + my($self, $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') eq 'preceding' && $last_bill == 0; + + $self->base_recur($cust_pkg); +} + +sub base_recur { + my($self, $cust_pkg) = @_; + $self->option('recur_fee', 1) || 0; +} + +sub calc_remain { + 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; + return 0 if ! $self->base_recur + || ! $self->option('unused_credit', 1) + || ! $last_bill + || ! $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 + ); + + $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 * ( $next_bill - $time ) / $freq_sec ); + } sub is_free_options { qw( setup_fee recur_fee ); } +sub is_prepaid { + 0; #no, we're postpaid +} + +sub reset_usage { + my($self, $cust_pkg, %opt) = @_; + warn " resetting usage counters" if $opt{debug} > 1; + my %values = map { $_, $self->option($_) } + grep { $self->option($_, 'hush') } + qw(seconds upbytes downbytes totalbytes); + if ($self->option('usage_rollover', 1)) { + $cust_pkg->recharge(\%values); + }else{ + $cust_pkg->set_usage(\%values); + } +} + 1;