X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fflat.pm;h=f9aaebee7e677992c2fb90fc33e9f896171a694a;hp=f2f3a8d9a3806afaefe9022f2726802ec701de45;hb=08ab7010467cf25578acdf8d9a9a068a87f1c49f;hpb=c160bc6f05b17d8084addc4d638ebc908c9ec0e6 diff --git a/FS/FS/part_pkg/flat.pm b/FS/FS/part_pkg/flat.pm index f2f3a8d9a..f9aaebee7 100644 --- a/FS/FS/part_pkg/flat.pm +++ b/FS/FS/part_pkg/flat.pm @@ -1,15 +1,96 @@ 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; -use Date::Manip; @ISA = qw(FS::part_pkg); +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' => '', + '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', 'fields' => { 'setup_fee' => { 'name' => 'Setup fee for this package', 'default' => 0, @@ -17,61 +98,112 @@ use Date::Manip; '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' ], - #'setup' => 'what.setup_fee.value', - #'recur' => 'what.recur_fee.value', + 'fieldorder' => [ qw( setup_fee recur_fee recur_temporality unused_credit ), + @usage_fieldorder, @usage_recharge_fieldorder, + qw( 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 = 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) = @_; + + return 0 unless $self->freq =~ /^\d+$/ && $self->freq > 0; + + sprintf('%.2f', $self->base_recur($cust_pkg) / $self->freq ); } sub calc_remain { - my ($self, $cust_pkg) = @_; - my $time = time; + 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; - my $now_date = ParseDate("epoch $time"); - my $last_date = ParseDate("epoch $last_bill"); - my $next_date = ParseDate("epoch $next_bill"); - my $err; - my $delta = DateCalc($now_date,$next_date,\$err, 0); - my $days_remaining = Delta_Format($delta, 4, "%dh"); + #my $last_bill = $cust_pkg->last_bill || 0; + my $last_bill = $cust_pkg->get('last_bill') || 0; #->last_bill falls back to setup - my $frequency = $self->freq; + return 0 if ! $self->base_recur($cust_pkg) + || ! $self->option('unused_credit', 1) + || ! $last_bill + || ! $next_bill + || $next_bill < $time; - # TODO: Remove this after the frequencies are Data::Manip friendly. - $frequency .= "m" unless $frequency =~ /[wd]$/; + 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 + ); - my $freq_delta = ParseDateDelta($frequency); - my $days = Delta_Format($freq_delta,4,"%dh"); + $self->freq =~ /^(\d+)([hdwm]?)$/ + or die 'unparsable frequency: '. $self->freq; + my $freq_sec = $1 * $sec{$2||'m'}; + return 0 unless $freq_sec; - my $recurring= $self->base_recur; - my $daily = $recurring/$days; + sprintf("%.2f", $self->base_recur($cust_pkg) * ( $next_bill - $time ) / $freq_sec ); - sprintf("%.2f",($daily * $days_remaining)); } sub is_free_options { @@ -82,4 +214,22 @@ sub is_prepaid { 0; #no, we're postpaid } +sub usage_valuehash { + my $self = shift; + map { $_, $self->option($_) } + grep { $self->option($_, 'hush') } + qw(seconds upbytes downbytes totalbytes); +} + +sub reset_usage { + my($self, $cust_pkg, %opt) = @_; + 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); + }else{ + $cust_pkg->set_usage(\%values, %opt); + } +} + 1;