X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fflat_introrate.pm;h=f12b1accdaf58dcb722032f4af0db697f8684c94;hp=2d551f10f28dd9f78d5cc559a81c679df31814e1;hb=9c6c62fe29a5b5e260d331fb0b663a492dc0bf2d;hpb=40a7b3dc653e099f7bd0bd762b649b04c4432db2 diff --git a/FS/FS/part_pkg/flat_introrate.pm b/FS/FS/part_pkg/flat_introrate.pm index 2d551f10f..f12b1accd 100644 --- a/FS/FS/part_pkg/flat_introrate.pm +++ b/FS/FS/part_pkg/flat_introrate.pm @@ -1,60 +1,117 @@ package FS::part_pkg::flat_introrate; +use base qw( FS::part_pkg::flat ); use strict; -use vars qw(@ISA %info $DEBUG $me); -#use FS::Record qw(qsearch qsearchs); -use FS::part_pkg::flat; - -use Date::Manip qw(DateCalc UnixDate ParseDate); - -@ISA = qw(FS::part_pkg::flat); -$me = '[' . __PACKAGE__ . ']'; -$DEBUG = 0; - -(%info) = (%FS::part_pkg::flat::info); -$info{name} = 'Introductory price for X months, then flat rate,'. - 'relative to setup date (anniversary billing)'; -$info{shortname} = 'Anniversary, with intro price'; -$info{fields} = { %{$info{fields}} }; -$info{fields}{intro_fee} = - { 'name' => 'Introductory recurring fee for this package', +use vars qw( %info ); + +use FS::Log; + +# mostly false laziness with FS::part_pkg::global_Mixin::validate_moneyn, +# except for blank string handling... +sub validate_money { + my ($option, $valref) = @_; + if ( $$valref eq '' ) { + $$valref = '0'; + } elsif ( $$valref =~ /^\s*(\d*)(\.\d{1})\s*$/ ) { + #handle one decimal place without barfing out + $$valref = ( ($1||''). ($2.'0') ) || 0; + } elsif ( $$valref =~ /^\s*(\d*)(\.\d{2})?\s*$/ ) { + $$valref = ( ($1||''). ($2||'') ) || 0; + } else { + return "Illegal (money) $option: ". $$valref; + } + return ''; +} + +sub validate_number { + my ($option, $valref) = @_; + $$valref = 0 unless $$valref; + return "Invalid $option" + unless ($$valref) = ($$valref =~ /^\s*(\d+)\s*$/); + return ''; +} + +%info = ( + 'name' => 'Introductory price for X months, then flat rate,'. + 'relative to setup date (anniversary billing)', + 'shortname' => 'Anniversary, with intro price', + 'inherit_fields' => [ 'flat', 'usage_Mixin', 'global_Mixin' ], + 'fields' => { + 'intro_fee' => { 'name' => 'Introductory recurring fee for this package', 'default' => 0, - }; -$info{fields}{intro_duration} = + 'validate' => \&validate_money, + }, + 'intro_duration' => { 'name' => 'Duration of the introductory period, in number of months', 'default' => 0, - }; -$info{fieldorder} = [ @{ $info{fieldorder} } ]; -splice @{$info{fieldorder}}, 1, 0, qw( intro_duration intro_fee ); -$info{weight} = 14; - -sub base_recur { - my($self, $cust_pkg, $time ) = @_; + 'validate' => \&validate_number, + }, + 'show_as_discount' => + { 'name' => 'Show the introductory rate on the invoice as if it\'s a discount', + 'type' => 'checkbox', + }, + }, + 'fieldorder' => [ qw(intro_duration intro_fee show_as_discount) ], + 'weight' => 14, +); - my $now = $time ? $$time : time; - - my ($duration) = ($self->option('intro_duration') =~ /^(\d+)$/); - unless ($duration) { - die "Invalid intro_duration: " . $self->option('intro_duration'); +sub intro_end { + my($self, $cust_pkg) = @_; + my ($duration) = ($self->option('intro_duration') =~ /^\s*(\d+)\s*$/); + unless (length($duration)) { + my $log = FS::Log->new('FS::part_pkg'); + $log->warning("Invalid intro_duration '".$self->option('intro_duration')."' on pkgpart ".$self->pkgpart + .", defaulting to 0, check package definition"); + $duration = 0; } - my $setup = &ParseDate('epoch ' . $cust_pkg->getfield('setup')); - my $intro_end = &DateCalc($setup, "+${duration} month"); - my $recur; + # no setup or start_date means "start billing the package ASAP", so assume + # it would start billing right now. + my $start = $cust_pkg->setup || $cust_pkg->start_date || time; + + $self->add_freq($start, $duration); +} - warn "$me: \$duration = ${duration}" if $DEBUG; - warn "$me: \$intro_end = ${intro_end}" if $DEBUG; - warn "$me: $now < " . &UnixDate($intro_end, '%s') if $DEBUG; +sub base_recur { + my($self, $cust_pkg, $time ) = @_; - if ($now < &UnixDate($intro_end, '%s')) { - $recur = $self->option('intro_fee'); + my $now; + if (!$time) { # the "$sdate" from _make_lines + my $log = FS::Log->new('FS::part_pkg'); + $log->warning("flat_introrate base_recur requires date!"); + $now = time; } else { - $recur = $self->option('recur_fee'); + $now = $$time; } - $recur; + if ($now < $self->intro_end($cust_pkg)) { + return $self->option('intro_fee'); + } else { + return $self->option('recur_fee'); + } } +sub item_discount { + my ($self, $cust_pkg) = @_; + return unless $self->option('show_as_discount',1); + my $intro_end = $self->intro_end($cust_pkg); + my $amount = sprintf('%.2f', + $self->option('intro_fee') - $self->option('recur_fee') + ); + return unless $amount < 0; + # otherwise it's an "introductory surcharge"? not the intended use of + # the feature. + + { '_is_discount' => 1, + 'description' => $cust_pkg->mt('Introductory discount until') . ' ' . + $cust_pkg->time2str_local('short', $intro_end), + 'setup_amount' => 0, + 'recur_amount' => $amount, + 'ext_description' => [], + 'pkgpart' => $self->pkgpart, + 'feepart' => '', + } +} 1;