experimental package balances, RT#4339

13 files changed, 165 insertions, 29 deletions

diff --git a/httemplate/edit/cust_credit.cgi b/httemplate/edit/cust_credit.cgi
index c9ca31ff3..c6b2bcbea 100755
--- a/httemplate/edit/cust_credit.cgi
+++ b/httemplate/edit/cust_credit.cgi
@@ -40,6 +40,16 @@ Credit
     <TD><SELECT NAME="apply"><OPTION VALUE="yes" SELECTED>yes<OPTION>no</SELECT></TD>
   </TR>
 
+% if ( $conf->exists('pkg-balances') ) {
+  <% include('/elements/tr-select-cust_pkg-balances.html',
+               'custnum' => $custnum,
+               'cgi'     => $cgi
+            )
+  %>
+% } else {
+  <INPUT TYPE="hidden" NAME="pkgnum" VALUE="">
+% }
+
 </TABLE>
 
 <BR>
@@ -65,4 +75,7 @@ my $_date   = time;
 my $otaker  = getotaker;
 my $p1      = popurl(1);
 
+my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
+  or die "unknown custnum $custnum\n";
+
 </%init>
diff --git a/httemplate/edit/cust_pay.cgi b/httemplate/edit/cust_pay.cgi
index 3c2877498..4dff06d88 100755
--- a/httemplate/edit/cust_pay.cgi
+++ b/httemplate/edit/cust_pay.cgi
@@ -72,6 +72,16 @@ Payment
 % } 
 </TR>
 
+% if ( $conf->exists('pkg-balances') ) {
+  <% include('/elements/tr-select-cust_pkg-balances.html',
+               'custnum' => $custnum,
+               'cgi'     => $cgi
+            )
+  %>
+% } else {
+  <INPUT TYPE="hidden" NAME="pkgnum" VALUE="">
+% }
+
 </TABLE>
 
 <BR>
@@ -95,7 +105,7 @@ my $money_char = $conf->config('money_char') || '$';
 die "access denied"
   unless $FS::CurrentUser::CurrentUser->access_right('Post payment');
 
-my($link, $linknum, $paid, $payby, $payinfo, $_date); 
+my($link, $linknum, $paid, $payby, $payinfo, $_date, $pkgnum); 
 if ( $cgi->param('error') ) {
   $link     = $cgi->param('link');
   $linknum  = $cgi->param('linknum');
@@ -131,7 +141,7 @@ if ( $link eq 'invnum' ) {
   my $cust_bill = qsearchs('cust_bill', { 'invnum' => $linknum } )
     or die "unknown invnum $linknum";
   $custnum = $cust_bill->custnum;
-} elsif ( $link eq 'custnum' ) {
+} elsif ( $link eq 'custnum' || $link eq 'popup' ) {
   $custnum = $linknum;
 }
 
diff --git a/httemplate/edit/process/cust_pay.cgi b/httemplate/edit/process/cust_pay.cgi
index 647f6fc6c..f8ac8b183 100755
--- a/httemplate/edit/process/cust_pay.cgi
+++ b/httemplate/edit/process/cust_pay.cgi
@@ -46,7 +46,9 @@ my $new = new FS::cust_pay ( {
   _date  => $_date,
   map {
     $_, scalar($cgi->param($_));
-  } qw(paid payby payinfo paybatch)
+  } qw( paid payby payinfo paybatch
+        pkgnum
+      )
   #} fields('cust_pay')
 } );
 
diff --git a/httemplate/elements/select-cust_pkg-balances.html b/httemplate/elements/select-cust_pkg-balances.html
new file mode 100644
index 000000000..d41bd033e
--- /dev/null
+++ b/httemplate/elements/select-cust_pkg-balances.html
@@ -0,0 +1,30 @@
+<SELECT NAME="pkgnum">
+    <OPTION VALUE="">(any)
+% foreach my $cust_pkg (@cust_pkg) {
+%   my $sel = ( $cgi->param('pkgnum') == $cust_pkg->pkgnum ) ? 'SELECTED' : '';
+    <OPTION <% $sel %> VALUE="<% $cust_pkg->pkgnum %>"><% $cust_pkg->pkg_label_long |h %>
+% }
+</SELECT>
+<%init>
+
+my %opt = @_;
+
+my @cust_pkg;
+if ( $opt{'cust_pkg'} ) {
+
+  @cust_pkg = @{ $opt{'cust_pkg'} };
+
+} else {
+
+  my $custnum = $opt{'custnum'};
+
+  my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
+    or die "unknown custnum $custnum\n";
+
+  @cust_pkg =
+    grep { ! $_->get('cancel') || $cust_main->balance_pkgnum($_->pkgnum) }
+         $cust_main->all_pkgs;
+
+}
+
+</%init>
diff --git a/httemplate/elements/tr-select-cust_pkg-balances.html b/httemplate/elements/tr-select-cust_pkg-balances.html
new file mode 100644
index 000000000..89dc5d415
--- /dev/null
+++ b/httemplate/elements/tr-select-cust_pkg-balances.html
@@ -0,0 +1,31 @@
+% if ( scalar(@cust_pkg) == 0 ) {
+  <INPUT TYPE="hidden" NAME="pkgnum" VALUE="">
+% } elsif ( scalar(@cust_pkg) == 1 ) {
+  <INPUT TYPE="hidden" NAME="pkgnum" VALUE="<% $cust_pkg[0]->pkgnum %>">
+% } else {
+  <TR>
+    <TD ALIGN="right">For package</TD>
+    <TD COLSPAN=2>
+      <% include('select-cust_pkg-balances.html',
+                   'cust_pkg' => \@cust_pkg,
+                   'cgi'      => $opt{'cgi'},
+                )
+      %>
+    </TD>
+  </TR>
+
+% }
+
+<%init>
+my %opt = @_;
+
+my $custnum = $opt{'custnum'};
+
+my $cust_main = qsearchs('cust_main', { 'custnum' => $custnum } )
+  or die "unknown custnum $custnum\n";
+
+my @cust_pkg =
+  grep { ! $_->get('cancel') || $cust_main->balance_pkgnum($_->pkgnum) }
+       $cust_main->all_pkgs;
+
+</%init>
diff --git a/httemplate/view/cust_bill.cgi b/httemplate/view/cust_bill.cgi
index 450c74e61..2673e8239 100755
--- a/httemplate/view/cust_bill.cgi
+++ b/httemplate/view/cust_bill.cgi
@@ -6,6 +6,7 @@
 % if ( $cust_bill->owed > 0
 %      && scalar( grep $payby{$_}, qw(BILL CASH WEST MCRD) )
 %      && $FS::CurrentUser::CurrentUser->access_right('Post payment')
+%      && ! $conf->exists('pkg-balances')
 %    )
 % {
 %     my $s = 0;
diff --git a/httemplate/view/cust_main/packages.html b/httemplate/view/cust_main/packages.html
index 428794b7d..8fbefae50 100755
--- a/httemplate/view/cust_main/packages.html
+++ b/httemplate/view/cust_main/packages.html
@@ -138,6 +138,9 @@ my %conf_opt = (
 
   #for status.html
   'cust_pkg-show_autosuspend' => $conf->exists('cust_pkg-show_autosuspend'),
+  #for status.html pkg-balances
+  'pkg-balances'              => $conf->exists('pkg-balances'),
+  'money_char'                => ( $conf->config('money_char') || '$' ),
 
   #for location.html
   'countrydefault'            => $countrydefault,
diff --git a/httemplate/view/cust_main/packages/status.html b/httemplate/view/cust_main/packages/status.html
index 6daff5031..f3b2faaf4 100644
--- a/httemplate/view/cust_main/packages/status.html
+++ b/httemplate/view/cust_main/packages/status.html
@@ -8,15 +8,16 @@
 
     <% pkg_status_row($cust_pkg, 'Cancelled', 'cancel', 'color'=>'FF0000', %opt ) %>
 
-    <% pkg_status_row_colspan(
+    <% pkg_status_row_colspan( $cust_pkg,
          ( $cpr ? $cpr->reasontext. ' by '. $cpr->otaker : '' ), '',
          'align'=>'right', 'color'=>'ff0000', 'size'=>'-2', 'colspan'=>$colspan,
+         %opt
        )
     %>
 
 %   unless ( $cust_pkg->get('setup') ) { 
 
-        <% pkg_status_row_colspan('Never billed', '', 'colspan'=>$colspan, ) %>
+        <% pkg_status_row_colspan( $cust_pkg, 'Never billed', '', 'colspan'=>$colspan, %opt, ) %>
 
 %   } else { 
 
@@ -34,14 +35,15 @@
 
     <% pkg_status_row( $cust_pkg, 'Suspended', 'susp', 'color'=>'FF9900', %opt ) %>
 
-    <% pkg_status_row_colspan(
+    <% pkg_status_row_colspan( $cust_pkg,
          ( $cpr ? $cpr->reasontext. ' by '. $cpr->otaker : '' ), '',
          'align'=>'right', 'color'=>'FF9900', 'size'=>'-2', 'colspan'=>$colspan,
+         %opt,
        )
     %>
 
 %   unless ( $cust_pkg->get('setup') ) { 
-      <% pkg_status_row_colspan('Never billed', '', 'colspan'=>$colspan ) %>
+      <% pkg_status_row_colspan( $cust_pkg, 'Never billed', '', 'colspan'=>$colspan, %opt ) %>
 %   } else { 
       <% pkg_status_row($cust_pkg, 'Setup', 'setup', %opt ) %>
 %   } 
@@ -70,7 +72,7 @@
 %
 %       unless ( $part_pkg->freq ) { 
 
-          <% pkg_status_row_colspan('Not&nbsp;yet&nbsp;billed&nbsp;(one-time&nbsp;charge)', '', 'colspan'=>$colspan, ) %>
+          <% pkg_status_row_colspan( $cust_pkg, 'Not&nbsp;yet&nbsp;billed&nbsp;(one-time&nbsp;charge)', '', 'colspan'=>$colspan, %opt ) %>
 
           <% pkg_status_row_if($cust_pkg, 'Start billing', 'start_date', %opt) %>
 
@@ -86,7 +88,7 @@
 
 %       } else { 
 
-         <% pkg_status_row_colspan("Not&nbsp;yet&nbsp;billed&nbsp;($billed_or_prepaid&nbsp;". myfreq($part_pkg). ')', '', 'colspan'=>$colspan ) %>
+         <% pkg_status_row_colspan($cust_pkg, "Not&nbsp;yet&nbsp;billed&nbsp;($billed_or_prepaid&nbsp;". myfreq($part_pkg). ')', '', 'colspan'=>$colspan, %opt ) %>
 
           <% pkg_status_row_if($cust_pkg, 'Start billing', 'start_date', %opt) %>
 
@@ -96,7 +98,7 @@
 %
 %       unless ( $part_pkg->freq ) { 
 
-          <% pkg_status_row_colspan('One-time&nbsp;charge', '', 'colspan'=>$colspan, ) %>
+          <% pkg_status_row_colspan($cust_pkg, 'One-time&nbsp;charge', '', 'colspan'=>$colspan, %opt ) %>
 
           <% pkg_status_row($cust_pkg, 'Billed', 'setup', %opt) %>
 
@@ -104,18 +106,20 @@
 %
 %         if (scalar($cust_pkg->overlimit)) {
 
-            <% pkg_status_row_colspan(
+            <% pkg_status_row_colspan( $cust_pkg,
                  'Overlimit',
                  $billed_or_prepaid. '&nbsp;'. myfreq($part_pkg),
                  'color'=>'FFD000', 'colspan'=>$colspan,
+                 %opt
                )
             %>
 
 %         } else {
-            <% pkg_status_row_colspan(
+            <% pkg_status_row_colspan( $cust_pkg,
                  'Active',
                  $billed_or_prepaid. '&nbsp;'. myfreq($part_pkg),
                  'color'=>'00CC00', 'colspan'=>$colspan,
+                 %opt
                )
             %>
 %         } 
@@ -169,7 +173,6 @@
 
   </TABLE>
 </TD>
-
 <%init>
 
 my %opt = @_;
@@ -218,8 +221,15 @@ sub pkg_status_row {
   $html   .= qq(<FONT COLOR="#$color"><B>) if length($color);
   $html   .= qq($title&nbsp;);
   $html   .= qq(</B></FONT>) if length($color);
+
+  if ( $opt{'pkg_balances'} && ! $cust_pkg->{_printed_balance}++ ) { #kludge
+    $html .= ' (Balance:&nbsp;<B>'. $opt{'money_char'}.
+             $cust_pkg->cust_main->balance_pkgnum($cust_pkg->pkgnum).
+             '</B>)';
+  }
+
   $html   .= qq(</TD>);
-  $html   .= pkg_datestr($cust_pkg, $field, %opt).'</TR>';
+  $html   .= pkg_datestr($cust_pkg, $field, %opt). '</TR>';
 
   $html;
 }
@@ -253,7 +263,7 @@ sub pkg_status_row_changed {
     my $part_pkg = $old->part_pkg;
     my $label = 'Changed from '. $cust_pkg->change_pkgnum. ': '.
                 $part_pkg->pkg_comment(nopartpkg => 1);
-    $html .= pkg_status_row_colspan( $label, '',
+    $html .= pkg_status_row_colspan( $cust_pkg, $label, '',
                                      'size'    => '-1',
                                      'align'   => 'right',
                                      'colspan' => $opt{'colspan'},
@@ -264,7 +274,7 @@ sub pkg_status_row_changed {
 }
 
 sub pkg_status_row_colspan {
-  my($title, $addl, %opt) = @_;
+  my($cust_pkg, $title, $addl, %opt) = @_;
 
   my $colspan  = $opt{'colspan'};
 
@@ -279,6 +289,13 @@ sub pkg_status_row_colspan {
   $html   .= qq(</B>) if $color && !$size;
   $html   .= qq(</FONT>) if length($color) || $size;
   $html   .= ",&nbsp;$addl" if length($addl);
+
+  if ( $opt{'pkg-balances'} && ! $cust_pkg->{_printed_balance}++ ) { #kludge
+    $html .= ' (Balance:&nbsp;<B>'. $opt{'money_char'}.
+             $cust_pkg->cust_main->balance_pkgnum($cust_pkg->pkgnum).
+             '</B>)';
+  }
+
   $html   .= qq(</TD></TR>);
 
   $html;
diff --git a/httemplate/view/cust_main/payment_history.html b/httemplate/view/cust_main/payment_history.html
index 1711e1449..8adc95426 100644
--- a/httemplate/view/cust_main/payment_history.html
+++ b/httemplate/view/cust_main/payment_history.html
@@ -374,13 +374,16 @@ my %status = (
 #get payment history
 my @history = ();
 
-my %opt =
+my %opt = (
   ( map { $_ => scalar($conf->config($_)) }
         qw( card_refund-days )
   ),
   ( map { $_ => $conf->exists($_) } 
-        qw( deletepayments deleterefunds )
-  );
+        qw( deletepayments deleterefunds pkg-balances )
+  )
+);
+
+warn Dumper(\%opt);
 
 #invoices
 foreach my $cust_bill ($cust_main->cust_bill) {
@@ -405,7 +408,7 @@ foreach my $cust_pay ($cust_main->cust_pay) {
 foreach my $cust_pay_void ($cust_main->cust_pay_void) {
   push @history, {
     'date'   => $cust_pay_void->_date,
-    'desc'   => include('payment_history/voided_payment.html', $cust_pay_void),
+    'desc'   => include('payment_history/voided_payment.html', $cust_pay_void, %opt ),
     'void_payment' => $cust_pay_void->paid,
   };
 
@@ -415,7 +418,7 @@ foreach my $cust_pay_void ($cust_main->cust_pay_void) {
 foreach my $cust_credit ($cust_main->cust_credit) {
   push @history, {
     'date'   => $cust_credit->_date,
-    'desc'   => include('payment_history/credit.html', $cust_credit),
+    'desc'   => include('payment_history/credit.html', $cust_credit, %opt ),
     'credit' => $cust_credit->amount,
   };
 
diff --git a/httemplate/view/cust_main/payment_history/credit.html b/httemplate/view/cust_main/payment_history/credit.html
index 2deb27564..058c6f536 100644
--- a/httemplate/view/cust_main/payment_history/credit.html
+++ b/httemplate/view/cust_main/payment_history/credit.html
@@ -9,7 +9,13 @@ my $curuser = $FS::CurrentUser::CurrentUser;
 my @cust_credit_bill = $cust_credit->cust_credit_bill;
 my @cust_credit_refund = $cust_credit->cust_credit_refund;
 
-my( $pre, $post, $desc, $apply, $ext ) = ( '', '', '', '', '' );
+my $desc = '';
+if ( $opt{'pkg-balances'} && $cust_credit->pkgnum ) {
+  my $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $cust_credit->pkgnum } );
+  $desc .= ' for '. $cust_pkg->pkg_label_long;
+}
+
+my( $pre, $post, $apply, $ext ) = ( '', '', '', '' );
 if (    scalar(@cust_credit_bill)   == 0
      && scalar(@cust_credit_refund) == 0 ) {
   #completely unapplied
@@ -45,15 +51,15 @@ if (    scalar(@cust_credit_bill)   == 0
           && scalar(@cust_credit_refund) == 0
           && $cust_credit->credited == 0      ) {
   #applied to one invoice, the usual situation
-  $desc = ' '. $cust_credit_bill[0]->applied_to_invoice;
+  $desc .= ' '. $cust_credit_bill[0]->applied_to_invoice;
 } elsif (    scalar(@cust_credit_bill)   == 0
           && scalar(@cust_credit_refund) == 1
           && $cust_credit->credited == 0      ) {
   #applied to one refund
-  $desc = ' refunded on '.  time2str("%D", $cust_credit_refund[0]->_date);
+  $desc .= ' refunded on '.  time2str("%D", $cust_credit_refund[0]->_date);
 } else {
   #complicated
-  $desc = '<BR>';
+  $desc .= '<BR>';
   foreach my $app ( sort { $a->_date <=> $b->_date }
                          ( @cust_credit_bill, @cust_credit_refund ) ) {
     if ( $app->isa('FS::cust_credit_bill') ) {
diff --git a/httemplate/view/cust_main/payment_history/payment.html b/httemplate/view/cust_main/payment_history/payment.html
index 2e24b1785..a4a349bb8 100644
--- a/httemplate/view/cust_main/payment_history/payment.html
+++ b/httemplate/view/cust_main/payment_history/payment.html
@@ -32,7 +32,13 @@ $payby =~ s/^MCRD$/Manual credit card/;
 $payby =~ s/^BILL$//;
 my $info = $payby ? "($payby$payinfo)" : '';
 
-my( $pre, $post, $desc, $apply, $ext ) = ( '', '', '', '', '' );
+my $desc = '';
+if ( $opt{'pkg-balances'} && $cust_pay->pkgnum ) {
+  my $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $cust_pay->pkgnum } );
+  $desc .= ' for '. $cust_pkg->pkg_label_long;
+}
+
+my( $pre, $post, $apply, $ext ) = ( '', '', '', '' );
 if (    scalar(@cust_bill_pay)   == 0
      && scalar(@cust_pay_refund) == 0 ) {
   #completely unapplied
@@ -68,15 +74,15 @@ if (    scalar(@cust_bill_pay)   == 0
           && scalar(@cust_pay_refund) == 0
           && $cust_pay->unapplied == 0     ) {
   #applied to one invoice, the usual situation
-  $desc = ' '. $cust_bill_pay[0]->applied_to_invoice;
+  $desc .= ' '. $cust_bill_pay[0]->applied_to_invoice;
 } elsif (    scalar(@cust_bill_pay)   == 0
           && scalar(@cust_pay_refund) == 1
           && $cust_pay->unapplied == 0     ) {
   #applied to one refund
-  $desc = ' refunded on '. time2str("%D", $cust_pay_refund[0]->_date);
+  $desc .= ' refunded on '. time2str("%D", $cust_pay_refund[0]->_date);
 } else {
   #complicated
-  $desc = '<BR>';
+  $desc .= '<BR>';
   foreach my $app ( sort { $a->_date <=> $b->_date }
                          ( @cust_bill_pay, @cust_pay_refund ) ) {
     if ( $app->isa('FS::cust_bill_pay') ) {
diff --git a/httemplate/view/cust_main/payment_history/voided_payment.html b/httemplate/view/cust_main/payment_history/voided_payment.html
index 9cbc47b66..08469dbe9 100644
--- a/httemplate/view/cust_main/payment_history/voided_payment.html
+++ b/httemplate/view/cust_main/payment_history/voided_payment.html
@@ -18,6 +18,11 @@ $payby =~ s/^BILL$//;
 $payby =~ s/^(CARD|COMP)$/$1 /;
 my $info = $payby ? " ($payby$payinfo)" : '';
 
+if ( $opt{'pkg-balances'} && $cust_pay_void->pkgnum ) {
+  my $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $cust_pay_void->pkgnum } );
+  $info .= ' for '. $cust_pkg->pkg_label_long;
+}
+
 my $unvoid = '';
 if ( $cust_pay_void->closed !~ /^Y/i
      && $curuser->access_right('Unvoid')
diff --git a/httemplate/view/cust_pay.html b/httemplate/view/cust_pay.html
index a5c99ac55..2f23d9e14 100644
--- a/httemplate/view/cust_pay.html
+++ b/httemplate/view/cust_pay.html
@@ -93,6 +93,15 @@
 
 % }
 
+% if ( $conf->exists('pkg-balances') && $cust_pay->pkgnum ) {
+%   my $cust_pkg = qsearchs('cust_pkg', { 'pkgnum' => $cust_pay->pkgnum } );
+    <TR>
+      <TD ALIGN="right">For package</TD>
+      <TD BGCOLOR="#FFFFFF"><B><% $cust_pkg->pkg_label_long %></B></TD>
+    </TR>
+
+% }
+
 </TABLE>
 
 % if ( $link eq 'print' ) {