RT#25563: Better handling of commissions which do not have rates configured [more...

[freeside.git] / FS / FS / part_event / Action / Mixin / credit_bill.pm

diff --git a/FS/FS/part_event/Action/Mixin/credit_bill.pm b/FS/FS/part_event/Action/Mixin/credit_bill.pm
index 4930e35..91fa21f 100644 (file)
--- a/FS/FS/part_event/Action/Mixin/credit_bill.pm
+++ b/FS/FS/part_event/Action/Mixin/credit_bill.pm
@@ -24,14 +24,15 @@ sub option_fields {
       'label'   => 'Of',
       'type'    => 'select',
       #add additional ways to specify in the package def
-      'options' => [qw( setuprecur setup recur setuprecur_margin setup_margin recur_margin )],
+      'options' => [qw( setuprecur setup recur setup_cost recur_cost setup_margin recur_margin_permonth )],
       'labels'  => {
-        'setuprecur'        => 'Amount charged',
-        'setup'             => 'Setup fee',
-        'recur'             => 'Recurring fee',
-        'setuprecur_margin' => 'Amount charged minus total cost',
-        'setup_margin'      => 'Setup fee minus setup cost',
-        'recur_margin'      => 'Recurring fee minus recurring cost',
+        'setuprecur'        => 'Amount charged on this invoice',
+        'setup'             => 'Setup fee charged on this invoice',
+        'recur'             => 'Recurring fee charged on this invoice',
+        'setup_cost'        => 'Setup cost',
+        'recur_cost'        => 'Recurring cost',
+        'setup_margin'      => 'Package setup fee minus setup cost',
+        'recur_margin_permonth' => 'Monthly recurring fee minus recurring cost',
       },
     },
   );
@@ -49,46 +50,69 @@ our %part_pkg_cache;
 # 2. the recipient of the commission; may be FS::sales, FS::agent, 
 # FS::access_user, etc. Here we don't use it, but it will be passed through
 # to _calc_credit_percent.
+# 3. optional scalar reference for recording a warning message
 
 sub _calc_credit {
   my $self = shift;
   my $cust_bill_pkg = shift;
+  my $who = shift;
+  my $warnref = shift;
+  my $warning = '';
 
   my $what = $self->option('what');
-  my $margin = 1 if $what =~ s/_margin$//;
+  my $cost = ($what =~ /_cost/ ? 1 : 0);
+  my $margin = ($what =~ /_margin/ ? 1 : 0);
 
   my $pkgnum = $cust_bill_pkg->pkgnum;
   my $cust_pkg = $cust_bill_pkg->cust_pkg;
 
   my $percent;
   if ( $self->can('_calc_credit_percent') ) {
-    $percent = $self->_calc_credit_percent($cust_pkg, @_);
+    $percent = $self->_calc_credit_percent($cust_pkg, $who);
+    $warning = 'Percent calculated to zero ' unless $percent+0;
   } else {
     $percent = $self->option('percent') || 0;
+    $warning = 'Percent set to zero ' unless $percent+0;
   }
 
   my $charge = 0;
-  if ( $what eq 'setup' ) {
-    $charge = $cust_bill_pkg->get('setup');
-  } elsif ( $what eq 'recur' ) {
-    $charge = $cust_bill_pkg->get('recur');
-  } elsif ( $what eq 'setuprecur' ) {
-    $charge = $cust_bill_pkg->get('setup') + $cust_bill_pkg->get('recur');
-  }
-  if ( $margin ) {
+  if ( $margin or $cost ) {
+    # look up package costs only if we need them
     my $pkgpart = $cust_bill_pkg->pkgpart_override || $cust_pkg->pkgpart;
     my $part_pkg   = $part_pkg_cache{$pkgpart}
                  ||= FS::part_pkg->by_key($pkgpart);
+
+    if ( $cost ) {
+      $charge = $part_pkg->get($what);
+    } else { # $margin
+      $charge = $part_pkg->$what($cust_pkg);
+    }
+
+    $charge = ($charge || 0) * ($cust_pkg->quantity || 1);
+    $warning .= 'Charge calculated to zero ' unless $charge+0;
+
+  } else { # setup, recur, or setuprecur
+
     if ( $what eq 'setup' ) {
-      $charge -= $part_pkg->get('setup_cost');
+      $charge = $cust_bill_pkg->get('setup');
+      $warning .= 'Setup is zero ' unless $charge+0;
     } elsif ( $what eq 'recur' ) {
-      $charge -= $part_pkg->get('recur_cost');
+      $charge = $cust_bill_pkg->get('recur');
+      $warning .= 'Recur is zero ' unless $charge+0;
     } elsif ( $what eq 'setuprecur' ) {
-      $charge -= $part_pkg->get('setup_cost') + $part_pkg->get('recur_cost');
+      $charge = $cust_bill_pkg->get('setup') + $cust_bill_pkg->get('recur');
+      $warning .= 'Setup and recur are zero ' unless $charge+0;
     }
+
+    # don't multiply by quantity here; it's already included
+  }
+
+  if ($charge < 0) { # e.g. prorate
+    $charge = 0;
+    $warning .= 'Negative charge set to zero ';
   }
 
-  $charge = 0 if $charge < 0; # e.g. prorate
+  $$warnref .= $warning if ref($warnref);
   return ($percent * $charge / 100);
 }