factor out the range-handling portions of receivables report, start on a similar unapplied payment report, RT#4861

4 files changed, 312 insertions, 168 deletions

diff --git a/httemplate/search/elements/cust_main_dayranges.html b/httemplate/search/elements/cust_main_dayranges.html
new file mode 100644
index 0000000..3ab5941
--- /dev/null
+++ b/httemplate/search/elements/cust_main_dayranges.html
@@ -0,0 +1,219 @@
+<%doc>
+
+Example:
+
+  include( 'elements/cust_main_dayranges.html',
+                 'title'       => 'Accounts Receivable Aging Summary',
+                 'range_sub'   => $mysub,
+         )
+
+  my $mysub = sub {
+    my( $start, $end ) = @_;
+
+    "SQL EXPRESSION BASED ON $start AND $end";
+  };
+
+</%doc>
+<% include( 'search.html',
+                 'name'        => 'customers',
+                 'query'       => $sql_query,
+                 'count_query' => $count_sql,
+                 'header'      => [
+                                    FS::UI::Web::cust_header(),
+                                    '0-30',
+                                    '30-60',
+                                    '60-90',
+                                    '90+',
+                                    'Total',
+                                  ],
+                 'footer'      => [
+                                    'Total',
+                                    ( map '',
+                                          ( 1 .. 
+                                            scalar(FS::UI::Web::cust_header()-1)
+                                          )
+                                    ),
+                                    sprintf( $money_char.'%.2f',
+                                             $row->{'rangecol_0_30'} ),
+                                    sprintf( $money_char.'%.2f',
+                                             $row->{'rangecol_30_60'} ),
+                                    sprintf( $money_char.'%.2f',
+                                             $row->{'rangecol_60_90'} ),
+                                    sprintf( $money_char.'%.2f',
+                                             $row->{'rangecol_90_0'} ),
+                                    sprintf( '<b>'. $money_char.'%.2f'. '</b>',
+                                             $row->{'rangecol_0_0'} ),
+                                  ],
+                 'fields'      => [
+                                    \&FS::UI::Web::cust_fields,
+                                    format_rangecol('0_30'),
+                                    format_rangecol('30_60'),
+                                    format_rangecol('60_90'),
+                                    format_rangecol('90_0'),
+                                    format_rangecol('0_0'),
+                                  ],
+                 'links'       => [
+                                    ( map { $_ ne 'Cust. Status' ? $clink : '' }
+                                          FS::UI::Web::cust_header()
+                                    ),
+                                    '',
+                                    '',
+                                    '',
+                                    '',
+                                    '',
+                                  ],
+                 #'align'       => 'rlccrrrrr',
+                 'align'       => FS::UI::Web::cust_aligns(). 'rrrrr',
+                 #'size'        => [ '', '', '-1', '-1', '', '', '', '',  '', ],
+                 #'style'       => [ '', '',  'b',  'b', '', '', '', '', 'b', ],
+                 'size'        => [ ( map '', FS::UI::Web::cust_header() ),
+                                    #'-1', '', '', '', '',  '', ],
+                                    '', '', '', '',  '', ],
+                 'style'       => [ FS::UI::Web::cust_styles(),
+                                    #'b', '', '', '', '', 'b', ],
+                                    '', '', '', '', 'b', ],
+                 'color'       => [
+                                    FS::UI::Web::cust_colors(),
+                                    '',
+                                    '',
+                                    '',
+                                    '',
+                                    '',
+                                  ],
+               %opt,
+             )
+%>
+<%init>
+
+my %opt = @_;
+
+#actually need to auto-generate other things too for a passed-in ranges to work
+my @ranges = $opt{'ranges'} ? @{ delete($opt{'ranges'}) } : [
+  [  0, 30 ],
+  [ 30, 60 ],
+  [ 60, 90 ],
+  [ 90,  0 ],
+  [  0,  0 ],
+];
+
+my $range_sub = delete($opt{'range_sub'}); #or die
+
+#my $range_cols = join(',', map &{$range_sub}( @$_ ), @ranges );
+my $range_cols = join(',', map call_range_sub($range_sub, @$_ ), @ranges );
+
+my $select_count_pkgs = FS::cust_main->select_count_pkgs_sql;
+
+my $active_sql    = FS::cust_pkg->active_sql;
+my $inactive_sql  = FS::cust_pkg->inactive_sql;
+my $suspended_sql = FS::cust_pkg->suspended_sql;
+my $cancelled_sql = FS::cust_pkg->cancelled_sql;
+
+my $packages_cols = <<END;
+     ( $select_count_pkgs                    ) AS num_pkgs_sql,
+     ( $select_count_pkgs AND $active_sql    ) AS active_pkgs,
+     ( $select_count_pkgs AND $inactive_sql  ) AS inactive_pkgs,
+     ( $select_count_pkgs AND $suspended_sql ) AS suspended_pkgs,
+     ( $select_count_pkgs AND $cancelled_sql ) AS cancelled_pkgs
+END
+
+my @where = ();
+
+unless ( $cgi->param('all_customers') ) {
+
+  my $days = 0;
+  if ( $cgi->param('days') =~ /^\s*(\d+)\s*$/ ) {
+    $days = $1;
+  }
+
+  push @where,
+    call_range_sub($range_sub, $days, 0, 'no_as'=>1). ' > 0'; # != 0';
+}
+
+if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
+  my $agentnum = $1;
+  push @where, "agentnum = $agentnum";
+}
+
+#status (false laziness w/cust_main::search_sql
+
+#prospect active inactive suspended cancelled
+if ( grep { $cgi->param('status') eq $_ } FS::cust_main->statuses() ) {
+  my $method = $cgi->param('status'). '_sql';
+  #push @where, $class->$method();
+  push @where, FS::cust_main->$method();
+}
+
+#here is the agent virtualization
+push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
+
+my $where = join(' AND ', @where);
+$where = "WHERE $where" if $where;
+
+my $count_sql = "select count(*) from cust_main $where";
+
+my $sql_query = {
+  'table'     => 'cust_main',
+  'hashref'   => {},
+  'select'    => join(',',
+                   #'cust_main.*',
+                   'custnum',
+                   $owed_cols,
+                   $packages_cols,
+                   FS::UI::Web::cust_sql_fields(),
+                 ),
+  'extra_sql' => $where,
+  'order_by'  => "order by coalesce(lower(company), ''), lower(last)",
+};
+
+my $total_sql =
+  "SELECT ".
+      join(',', map call_range_sub( $range_sub, @$_, 'sum'=>1 ), @ranges).
+    " FROM cust_main $where";
+
+my $total_sth = dbh->prepare($total_sql) or die dbh->errstr;
+$total_sth->execute or die "error executing $total_sql: ". $total_sth->errstr;
+my $row = $total_sth->fetchrow_hashref();
+
+my $clink = [ "${p}view/cust_main.cgi?", 'custnum' ];
+
+</%init>
+<%once>
+
+my $conf = new FS::Conf;
+
+my $money_char = $conf->config('money_char') || '$';
+
+#Example:
+#
+# my $balance = balance(
+#   $start, $end, 
+#   'no_as'  => 1, #set to true when using in a WHERE clause (supress AS clause)
+#                 #or 0 / omit when using in a SELECT clause as a column
+#                 #  ("AS balance_$start_$end")
+#   'sum'    => 1, #set to true to get a SUM() of the values, for totals
+#
+#   #obsolete? options for totals (passed to cust_main::balance_date_sql)
+#   'total'  => 1, #set to true to remove all customer comparison clauses
+#   'join'   => $join,   #JOIN clause
+#   'where'  => \@where, #WHERE clause hashref (elements "AND"ed together)
+# )
+
+sub call_range_sub {
+  my($range_sub, $start, $end, %opt) = @_;
+
+  my $as = $opt{'no_as'} ? '' : " AS rangecol_${start}_$end";
+
+  my $sql = &{$range_sub}( $start, $end ); #%opt?
+
+  $sql = "SUM($sql)" if $opt{'sum'};
+
+  $sql.$as;
+
+}
+
+sub format_range { #closures help alot
+  my $range = shift;
+  sub { sprintf( $money_char.'%.2f', shift->get("rangecol_$range") ) };
+}
+
+</%once>
diff --git a/httemplate/search/report_receivables.cgi b/httemplate/search/report_receivables.cgi
index 63adba0..a11fb81 100755
--- a/httemplate/search/report_receivables.cgi
+++ b/httemplate/search/report_receivables.cgi
@@ -1,72 +1,7 @@
-<% include( 'elements/search.html',
+<% include( 'elements/cust_main_dayranges.html',
                  'title'       => 'Accounts Receivable Aging Summary',
-                 'name'        => 'customers',
-                 'query'       => $sql_query,
-                 'count_query' => $count_sql,
-                 'header'      => [
-                                    FS::UI::Web::cust_header(),
-                                    '0-30',
-                                    '30-60',
-                                    '60-90',
-                                    '90+',
-                                    'Total',
-                                  ],
-                 'footer'      => [
-                                    'Total',
-                                    ( map '',
-                                          ( 1 .. 
-                                            scalar(FS::UI::Web::cust_header()-1)
-                                          )
-                                    ),
-                                    sprintf( $money_char.'%.2f',
-                                             $row->{'balance_0_30'} ),
-                                    sprintf( $money_char.'%.2f',
-                                             $row->{'balance_30_60'} ),
-                                    sprintf( $money_char.'%.2f',
-                                             $row->{'balance_60_90'} ),
-                                    sprintf( $money_char.'%.2f',
-                                             $row->{'balance_90_0'} ),
-                                    sprintf( '<b>'. $money_char.'%.2f'. '</b>',
-                                             $row->{'balance_0_0'} ),
-                                  ],
-                 'fields'      => [
-                                    \&FS::UI::Web::cust_fields,
-                                    format_balance('0_30'),
-                                    format_balance('30_60'),
-                                    format_balance('60_90'),
-                                    format_balance('90_0'),
-                                    format_balance('0_0'),
-                                  ],
-                 'links'       => [
-                                    ( map { $_ ne 'Cust. Status' ? $clink : '' }
-                                          FS::UI::Web::cust_header()
-                                    ),
-                                    '',
-                                    '',
-                                    '',
-                                    '',
-                                    '',
-                                  ],
-                 #'align'       => 'rlccrrrrr',
-                 'align'       => FS::UI::Web::cust_aligns(). 'rrrrr',
-                 #'size'        => [ '', '', '-1', '-1', '', '', '', '',  '', ],
-                 #'style'       => [ '', '',  'b',  'b', '', '', '', '', 'b', ],
-                 'size'        => [ ( map '', FS::UI::Web::cust_header() ),
-                                    #'-1', '', '', '', '',  '', ],
-                                    '', '', '', '',  '', ],
-                 'style'       => [ FS::UI::Web::cust_styles(),
-                                    #'b', '', '', '', '', 'b', ],
-                                    '', '', '', '', 'b', ],
-                 'color'       => [
-                                    FS::UI::Web::cust_colors(),
-                                    '',
-                                    '',
-                                    '',
-                                    '',
-                                    '',
-                                  ],
-
-             )
+                 'range_sub'   => \&balance,
+          )
 %>
 <%init>
 
@@ -74,96 +9,9 @@ die "access denied"
   unless $FS::CurrentUser::CurrentUser->access_right('Receivables report')
       or $FS::CurrentUser::CurrentUser->access_right('Financial reports');
 
-my @ranges = (
-  [  0, 30 ],
-  [ 30, 60 ],
-  [ 60, 90 ],
-  [ 90,  0 ],
-  [  0,  0 ],
-);
-
-my $owed_cols = join(',', map balance( @$_ ), @ranges );
-
-my $select_count_pkgs = FS::cust_main->select_count_pkgs_sql;
-
-my $active_sql    = FS::cust_pkg->active_sql;
-my $inactive_sql  = FS::cust_pkg->inactive_sql;
-my $suspended_sql = FS::cust_pkg->suspended_sql;
-my $cancelled_sql = FS::cust_pkg->cancelled_sql;
-
-my $packages_cols = <<END;
-     ( $select_count_pkgs                    ) AS num_pkgs_sql,
-     ( $select_count_pkgs AND $active_sql    ) AS active_pkgs,
-     ( $select_count_pkgs AND $inactive_sql  ) AS inactive_pkgs,
-     ( $select_count_pkgs AND $suspended_sql ) AS suspended_pkgs,
-     ( $select_count_pkgs AND $cancelled_sql ) AS cancelled_pkgs
-END
-
-my @where = ();
-
-unless ( $cgi->param('all_customers') ) {
-
-  my $days = 0;
-  if ( $cgi->param('days') =~ /^\s*(\d+)\s*$/ ) {
-    $days = $1;
-  }
-
-  push @where, balance($days, 0, 'no_as'=>1). ' > 0'; # != 0';
-
-}
-
-if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
-  my $agentnum = $1;
-  push @where, "agentnum = $agentnum";
-}
-
-#status (false laziness w/cust_main::search_sql
-
-#prospect active inactive suspended cancelled
-if ( grep { $cgi->param('status') eq $_ } FS::cust_main->statuses() ) {
-  my $method = $cgi->param('status'). '_sql';
-  #push @where, $class->$method();
-  push @where, FS::cust_main->$method();
-}
-
-#here is the agent virtualization
-push @where, $FS::CurrentUser::CurrentUser->agentnums_sql;
-
-my $where = join(' AND ', @where);
-$where = "WHERE $where" if $where;
-
-my $count_sql = "select count(*) from cust_main $where";
-
-my $sql_query = {
-  'table'     => 'cust_main',
-  'hashref'   => {},
-  'select'    => join(',',
-                   #'cust_main.*',
-                   'custnum',
-                   $owed_cols,
-                   $packages_cols,
-                   FS::UI::Web::cust_sql_fields(),
-                 ),
-  'extra_sql' => $where,
-  'order_by'  => "order by coalesce(lower(company), ''), lower(last)",
-};
-
-my $total_sql = "SELECT ". join(',', map balance( @$_, 'sum'=>1 ), @ranges).
-                " FROM cust_main $where";
-
-my $total_sth = dbh->prepare($total_sql) or die dbh->errstr;
-$total_sth->execute or die "error executing $total_sql: ". $total_sth->errstr;
-my $row = $total_sth->fetchrow_hashref();
-
-my $clink = [ "${p}view/cust_main.cgi?", 'custnum' ];
-
 </%init>
 <%once>
 
-my $conf = new FS::Conf;
-
-my $money_char = $conf->config('money_char') || '$';
-
 #Example:
 #
 # my $balance = balance(
@@ -180,9 +28,7 @@ my $money_char = $conf->config('money_char') || '$';
 # )
 
 sub balance {
-  my($start, $end, %opt) = @_;
-
-  my $as = $opt{'no_as'} ? '' : " AS balance_${start}_$end";
+  my($start, $end) = @_; #, %opt ?
 
   #handle start and end ranges (86400 = 24h * 60m * 60s)
   my $str2time = str2time_sql;
@@ -190,18 +36,10 @@ sub balance {
   $start = $start ? "( $str2time now() $closing - ".($start * 86400). ' )' : '';
   $end   = $end   ? "( $str2time now() $closing - ".($end   * 86400). ' )' : '';
 
-  $opt{'unapplied_date'} = 1;
-
-  ( $opt{sum} ? 'SUM( ' : '' ). 
-  FS::cust_main->balance_date_sql( $start, $end, %opt ).
-  ( $opt{sum} ? ' )' : '' ). 
-  $as;
+  #$opt{'unapplied_date'} = 1;
 
-}
+  FS::cust_main->balance_date_sql( $start, $end, 'unapplied_date'=>1,).
 
-sub format_balance { #closures help alot
-  my $range = shift;
-  sub { sprintf( $money_char.'%.2f', shift->get("balance_$range") ) };
 }
 
 </%once>
diff --git a/httemplate/search/report_unapplied_cust_pay.html b/httemplate/search/report_unapplied_cust_pay.html
new file mode 100755
index 0000000..3e59221
--- /dev/null
+++ b/httemplate/search/report_unapplied_cust_pay.html
@@ -0,0 +1,41 @@
+<% include('/elements/header.html', 'Unapplied Payments Aging Summary' ) %>
+%# 'Prepaid Balance Aging Summary', #???
+
+<FORM NAME="OneTrueForm" ACTION="unapplied_cust_pay.html" METHOD="GET">
+
+<TABLE BGCOLOR="#cccccc" CELLSPACING=0>
+
+  <TR>
+    <TH BGCOLOR="#e8e8e8" COLSPAN=2 ALIGN="left">
+      <FONT SIZE="+1">Search options</FONT>
+    </TH>
+  </TR>
+
+  <% include( '/elements/tr-select-agent.html', 'disable_empty'=>0 ) %>
+
+  <% include( '/elements/tr-select-cust_main-status.html',
+                'label' => 'Customer Status'
+            )
+  %>
+  
+  <TR>
+    <TD ALIGN="right">Customers</TD>
+    <TD>
+      <INPUT TYPE="radio" NAME="all_customers" VALUE="1" onClick="if (this.checked) { document.OneTrueForm.days.disabled=true; document.OneTrueForm.days.style.backgroundColor = '#dddddd'; } else { document.OneTrueForm.days.disabled=false; document.OneTrueForm.days.style.backgroundColor = '#ffffff'; }">All customers (even those without an outstanding balance)<BR>
+      <INPUT TYPE="radio" NAME="all_customers" VALUE="0" CHECKED onClick="if ( ! this.checked ) { document.OneTrueForm.days.disabled=true; document.OneTrueForm.days.style.backgroundColor = '#dddddd'; } else { document.OneTrueForm.days.disabled=false; document.OneTrueForm.days.style.backgroundColor = '#ffffff'; }">Customers with a balance over <INPUT NAME="days" TYPE="text" SIZE=4 MAXLENGTH=3 VALUE="0"> days old
+    </TD>
+  </TR>
+
+</TABLE>
+
+<BR><INPUT TYPE="submit" VALUE="Get Report">
+</FORM>
+
+<% include('/elements/footer.html') %>
+
+<%init>
+
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
+
+</%init>
diff --git a/httemplate/search/unapplied_cust_pay.html b/httemplate/search/unapplied_cust_pay.html
new file mode 100755
index 0000000..35abd6b
--- /dev/null
+++ b/httemplate/search/unapplied_cust_pay.html
@@ -0,0 +1,46 @@
+<% include( 'elements/cust_main_dayranges.html',
+                 #'title'       => 'Prepaid Balance Aging Summary', #???
+                 'title'       => 'Unapplied Payments Aging Summary',
+                 'range_sub'   => \&unapplied_payments,
+          );
+<%init>
+
+die "access denied"
+  unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
+
+</%init>
+<%once>
+
+#Example:
+#
+# my $balance = balance(
+#   $start, $end, 
+#   'no_as'  => 1, #set to true when using in a WHERE clause (supress AS clause)
+#                 #or 0 / omit when using in a SELECT clause as a column
+#                 #  ("AS balance_$start_$end")
+#   'sum'    => 1, #set to true to get a SUM() of the values, for totals
+#
+#   #obsolete? options for totals (passed to cust_main::balance_date_sql)
+#   'total'  => 1, #set to true to remove all customer comparison clauses
+#   'join'   => $join,   #JOIN clause
+#   'where'  => \@where, #WHERE clause hashref (elements "AND"ed together)
+# )
+
+#sub balance {
+sub unapplied_payments {
+  my($start, $end, %opt) = @_;
+
+#XXX fill-in
+#  #handle start and end ranges (86400 = 24h * 60m * 60s)
+#  my $str2time = str2time_sql;
+#  my $closing = str2time_sql_closing;
+#  $start = $start ? "( $str2time now() $closing - ".($start * 86400). ' )' : '';
+#  $end   = $end   ? "( $str2time now() $closing - ".($end   * 86400). ' )' : '';
+#
+#  #$opt{'unapplied_date'} = 1;
+#
+#  FS::cust_main->balance_date_sql( $start, $end, %opt ).
+
+}
+
+</%once>