optionally show introductory rates as discounts, #72097

[freeside.git] / FS / FS / part_pkg / flat_introrate.pm

diff --git a/FS/FS/part_pkg/flat_introrate.pm b/FS/FS/part_pkg/flat_introrate.pm
index 2568afa..e43a525 100644 (file)
--- a/FS/FS/part_pkg/flat_introrate.pm
+++ b/FS/FS/part_pkg/flat_introrate.pm
@@ -1,68 +1,117 @@
 package FS::part_pkg::flat_introrate;
+use base qw( FS::part_pkg::flat );
 
 use strict;
-use vars qw(@ISA %info $DEBUG $DEBUG_PRE);
-#use FS::Record qw(qsearch qsearchs);
-use FS::part_pkg::flat;
+use vars qw( %info );
 
-use Date::Manip qw(DateCalc UnixDate ParseDate);
+use FS::Log;
 
-@ISA = qw(FS::part_pkg::flat);
-$DEBUG = 0;
-$DEBUG_PRE = '[' . __PACKAGE__ . ']: ';
+# 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',
-  'fields' =>  {
-    'setup_fee' => { 'name' => 'Setup fee for this package',
+  'inherit_fields' => [ 'flat', 'usage_Mixin', 'global_Mixin' ],
+  'fields' => {
+    'intro_fee' => { 'name' => 'Introductory recurring fee for this package',
                      'default' => 0,
+                     'validate' => \&validate_money,
                    },
-    'intro_fee' => { 'name' => 'Introductory recurring free for this package',
-                     'default' => 0,
-                   },
-    'intro_duration' => { 'name' => 'Duration of the introductory period, ' .
-                                    'in number of months',
-                          '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',
-                       },
+    'intro_duration' =>
+         { 'name' => 'Duration of the introductory period, in number of months',
+           'default' => 0,
+           'validate' => \&validate_number,
+         },
+    'show_as_discount' =>
+         { 'name' => 'Show the introductory rate on the invoice as if it\'s a discount',
+           'type' => 'checkbox',
+         },
   },
-  'fieldorder' => [ 'setup_fee', 'intro_duration', 'intro_fee', 'recur_fee', 'unused_credit' ],
+  'fieldorder' => [ qw(intro_duration intro_fee show_as_discount) ],
   'weight' => 14,
 );
 
-sub calc_recur {
-  my($self, $cust_pkg, $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;
 
-  warn $DEBUG_PRE . "\$duration = ${duration}" if $DEBUG;
-  warn $DEBUG_PRE . "\$intro_end = ${intro_end}" if $DEBUG;
-  warn $DEBUG_PRE . "$$time < " . &UnixDate($intro_end, '%s') if $DEBUG;
+  $self->add_freq($start, $duration);
+}
 
-  if ($$time < &UnixDate($intro_end, '%s')) {
-    $recur = $self->option('intro_fee');
+sub base_recur {
+  my($self, $cust_pkg, $time ) = @_;
+
+  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');
+  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;