remove unearned junk from cust_bill_pkg.cgi now that it's a separate report
[freeside.git] / httemplate / search / cust_bill_pkg.cgi
index 0db4b35..5032542 100644 (file)
@@ -1,32 +1,21 @@
-<% include( 'elements/search.html',
-                 'title'       => 'Line items',
-                 'name'        => 'line items',
+<& elements/search.html,
+                 'title'       => emt('Line items'),
+                 'name'        => emt('line items'),
                  'query'       => $query,
                  'count_query' => $count_query,
-                 'count_addl'  => [ $money_char. '%.2f total',
-                                    $unearned ? ( $money_char. '%.2f unearned revenue' ) : (),
-                                  ],
+                 'count_addl'  => [ $money_char. '%.2f total', ],
                  'header'      => [
-                   #'#',
-                   'Description',
-                   ( $unearned
-                     ? ( 'Unearned', 'Owed', 'Payment date' )
-                     : ( 'Setup charge' )
-                   ),
+                   emt('Description'),
+                   emt('Setup charge'),
                    ( $use_usage eq 'usage'
-                     ? 'Usage charge'
-                     : 'Recurring charge'
-                   ),
-                   ( $unearned
-                     ? ( 'Charge start', 'Charge end' )
-                     : ()
+                     ? emt('Usage charge')
+                     : emt('Recurring charge')
                    ),
-                   'Invoice',
-                   'Date',
+                   emt('Invoice'),
+                   emt('Date'),
                    FS::UI::Web::cust_header(),
                  ],
                  'fields'      => [
-                   #'billpkgnum',
                    sub { $_[0]->pkgnum > 0
                            ? $_[0]->get('pkg')      # possibly use override.pkg
                            : $_[0]->get('itemdesc') # but i think this correct
                    #strikethrough or "N/A ($amount)" or something these when
                    # they're not applicable to pkg_tax search
                    sub { my $cust_bill_pkg = shift;
-                         if ( $unearned ) {
-                           my $period =
-                             $cust_bill_pkg->edate - $cust_bill_pkg->sdate;
-                           my $elapsed = $unearned - $cust_bill_pkg->sdate;
-                           $elapsed = 0 if $elapsed < 0;
-
-                           my $remaining = 1 - $elapsed/$period;
-
-                           sprintf($money_char. '%.2f',
-                             $remaining * $cust_bill_pkg->recur );
-
-                         } else {
-                           sprintf($money_char.'%.2f', $cust_bill_pkg->setup );
-                         }
+                         sprintf($money_char.'%.2f', $cust_bill_pkg->setup );
                        },
-                   ( $unearned
-                     ? ( $owed_sub, $payment_date_sub, )
-                     : ()
-                   ),
                    sub { my $row = shift;
                          my $value = 0;
                          if ( $use_usage eq 'recurring' ) {
                          }
                          sprintf($money_char.'%.2f', $value );
                        },
-                   ( $unearned
-                     ? ( sub { time2str('%b %d %Y', shift->sdate ) },
-                         sub { time2str('%b %d %Y', shift->edate ) },
-                       )
-                     : ()
-                   ),
                    'invnum',
                    sub { time2str('%b %d %Y', shift->_date ) },
                    \&FS::UI::Web::cust_fields,
                  ],
                  'sort_fields' => [
-                   'setup', #broken in $unearned case i guess
-                   ( $unearned ? ('', '') : () ),
-                   ( $use_usage eq 'recurring' ? 'recur - usage' :
-                     $use_usage eq 'usage'     ? 'usage'
-                                               : 'recur'
+                   '',
+                   'setup',
+                   ( $use_usage eq 'recurring'
+                        ? 'recur - usage' :
+                     $use_usage eq 'usage' 
+                        ? 'usage'
+                        : 'recur'
                    ),
-                   ( $unearned ? ('sdate', 'edate') : () ),
                    'invnum',
                    '_date',
                  ],
@@ -89,9 +56,7 @@
                    #'',
                    '',
                    '',
-                   ( $unearned ? ( '', '' ) : () ),
                    '',
-                   ( $unearned ? ( '', '' ) : () ),
                    $ilink,
                    $ilink,
                    ( map { $_ ne 'Cust. Status' ? $clink : '' }
                  ],
                  #'align' => 'rlrrrc'.FS::UI::Web::cust_aligns(),
                  'align' => 'lr'.
-                            ( $unearned ? 'rc' : '' ).
                             'r'.
-                            ( $unearned ? 'cc' : '' ).
                             'rc'.
                             FS::UI::Web::cust_aligns(),
                  'color' => [ 
                               #'',
                               '',
                               '',
-                              ( $unearned ? ( '', '' ) : () ),
                               '',
-                              ( $unearned ? ( '', '' ) : () ),
                               '',
                               '',
                               FS::UI::Web::cust_colors(),
                               #'',
                               '',
                               '',
-                              ( $unearned ? ( '', '' ) : () ),
                               '',
-                              ( $unearned ? ( '', '' ) : () ),
                               '',
                               '',
                               FS::UI::Web::cust_styles(),
                             ],
-           )
-%>
+&>
 <%init>
 
 #LOTS of false laziness below w/cust_credit_bill_pkg.cgi
@@ -138,7 +96,8 @@ die "access denied"
 
 my $conf = new FS::Conf;
 
-my $unearned = '';
+my @select = ( 'cust_bill_pkg.*', 'cust_bill._date' );
+my ($join_cust, $join_pkg ) = ('', '');
 
 #here is the agent virtualization
 my $agentnums_sql =
@@ -147,13 +106,29 @@ my $agentnums_sql =
 my @where = ( $agentnums_sql );
 
 my($beginning, $ending) = FS::UI::Web::parse_beginning_ending($cgi);
-push @where, "_date >= $beginning",
-             "_date <= $ending";
+
+if ( $cgi->param('status') =~ /^([a-z]+)$/ ) {
+  push @where, FS::cust_main->cust_status_sql . " = '$1'";
+}
+
+if ( $cgi->param('distribute') == 1 ) {
+  push @where, "sdate <= $ending",
+               "edate >  $beginning",
+  ;
+}
+else {
+  push @where, "cust_bill._date >= $beginning",
+               "cust_bill._date <= $ending";
+}
 
 if ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
   push @where, "cust_main.agentnum = $1";
 }
 
+if ( $cgi->param('refnum') =~ /^(\d+)$/ ) {
+  push @where, "cust_main.refnum = $1";
+}
+
 #classnum
 # not specified: all classes
 # 0: empty class
@@ -186,47 +161,23 @@ if ( $cgi->param('taxclass')
 {
 
   #override taxclass when use_override is specified?  probably
-  #if ( $use_override ) {
-  #
-  #  push @where,
-  #    ' ( '. join(' OR ',
-  #                  map {
-  #                        ' (    part_pkg.taxclass = '. dbh->quote($_).
-  #                        '      AND pkgpart_override IS NULL '.
-  #                        '   OR '.
-  #                        '      override.taxclass = '. dbh->quote($_).
-  #                        '      AND pkgpart_override IS NOT NULL '.
-  #                        ' ) '
-  #                      }
-  #                      $cgi->param('taxclass')
-  #               ).
-  #    ' ) ';
-  #
-  #} else {
-
-    push @where,
-      ' ( '. join(' OR ',
-                    map ' part_pkg.taxclass = '.dbh->quote($_),
-                        $cgi->param('taxclass')
-                 ).
-      ' ) ';
-
-  #}
+
+    push @where, ' part_pkg.taxclass IN ( '.
+                   join(', ', map dbh->quote($_), $cgi->param('taxclass') ).
+                 ' ) ';
 
 }
 
-my @loc_param = qw( city county state country );
+my @loc_param = qw( district city county state country );
 
 if ( $cgi->param('out') ) {
 
-  my ( $loc_sql, @param ) = FS::cust_pkg->location_sql( 'ornull' => 1 );
-  while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
-    $loc_sql =~ s/\?/'cust_main_county.'.shift(@param)/e;
-  }
-
-  $loc_sql =~ s/cust_pkg\.locationnum/cust_bill_pkg_tax_location.locationnum/g
-    if $cgi->param('istax');
+  my ( $loc_sql, @param ) = FS::cust_location->in_county_sql( 'ornull' => 1 );
+#  while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
+#    $loc_sql =~ s/\?/'cust_main_county.'.shift(@param)/e;
+#  }
 
+    warn "\nLOC_SQL:\n$loc_sql\n";
   push @where, "
     0 = (
           SELECT COUNT(*) FROM cust_main_county
@@ -240,16 +191,17 @@ if ( $cgi->param('out') ) {
 
     my %ph = map { $_ => dbh->quote( scalar($cgi->param($_)) ) } @loc_param;
 
-    my ( $loc_sql, @param ) = FS::cust_pkg->location_sql;
+    my ( $loc_sql, @param ) = FS::cust_location->in_county_sql(param => 1);
     while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
       $loc_sql =~ s/\?/$ph{shift(@param)}/e;
     }
 
+    warn "\nLOC_SQL:\n$loc_sql\n";
     push @where, $loc_sql;
 
   }
 
-} elsif ( $cgi->param('country') ) {
+} elsif ( $cgi->param('country') ) { # and not $cgi->param('out')
 
   my @counties = $cgi->param('county');
    
@@ -263,10 +215,10 @@ if ( $cgi->param('out') ) {
 
           my %ph = ( 'county' => dbh->quote($_),
                      map { $_ => dbh->quote( $cgi->param($_) ) }
-                       qw( city state country )
+                       qw( district city state country )
                    );
 
-          my ( $loc_sql, @param ) = FS::cust_pkg->location_sql;
+          my ( $loc_sql, @param ) = FS::cust_location->in_county_sql(param => 1);
           while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
             $loc_sql =~ s/\?/$ph{shift(@param)}/e;
           }
@@ -277,17 +229,20 @@ if ( $cgi->param('out') ) {
 
       ). ' ) ';
 
+    warn "\nLOC_SQL:\n$locs_sql\n";
     push @where, $locs_sql;
 
-  } else {
+  } else { #scalar(@counties) <= 1
 
     my %ph = map { $_ => dbh->quote( scalar($cgi->param($_)) ) } @loc_param;
 
-    my ( $loc_sql, @param ) = FS::cust_pkg->location_sql;
+    
+    my ( $loc_sql, @param ) = FS::cust_location->in_county_sql(param => 1);
     while ( $loc_sql =~ /\?/ ) { #easier to do our own substitution
       $loc_sql =~ s/\?/$ph{shift(@param)}/e;
     }
 
+    warn "\nLOC_SQL:\n$loc_sql\n";
     push @where, $loc_sql;
 
   }
@@ -305,8 +260,11 @@ if ( $cgi->param('out') ) {
     #warn "neither nottax nor istax parameters specified";
   }
 
-  if ( $cgi->param('taxclassNULL') ) {
-
+  if ( $cgi->param('taxclassNULL')
+       && ! $cgi->param('istax')  #no part_pkg.taxclass in this case
+                                  #(see comment above?)
+     )
+  {
     my %hash = ( 'country' => scalar($cgi->param('country')) );
     foreach (qw( state county )) {
       $hash{$_} = scalar($cgi->param($_)) if $cgi->param($_);
@@ -315,42 +273,18 @@ if ( $cgi->param('out') ) {
     die "unknown base region for empty taxclass" unless $cust_main_county;
 
     my $same_sql = $cust_main_county->sql_taxclass_sameregion;
+    $same_sql =~ s/taxclass/part_pkg.taxclass/g;
     push @where, $same_sql if $same_sql;
 
   }
 
 } elsif ( scalar( grep( /locationtaxid/, $cgi->param ) ) ) {
+# and not $cgi->param('out' or 'country')
 
-  # this should really be shoved out to FS::cust_pkg->location_sql or something
-  # along with the code in report_newtax.cgi
-
-  my %pn = (
-   'county'        => 'tax_rate_location.county',
-   'state'         => 'tax_rate_location.state',
-   'city'          => 'tax_rate_location.city',
-   'locationtaxid' => 'cust_bill_pkg_tax_rate_location.locationtaxid',
-  );
-
-  my %ph = map { ( $pn{$_} => dbh->quote( $cgi->param($_) || '' ) ) }
-           qw( city county state locationtaxid );
-
-  push @where,
-    join( ' AND ', map { "( $_ = $ph{$_} OR $ph{$_} = '' AND $_ IS NULL)" }
-                   keys %ph
-    );
-
-} elsif ( $cgi->param('unearned_now') =~ /^(\d+)$/ ) {
-
-  $unearned = $1;
-
-  push @where, "cust_bill_pkg.sdate < $unearned",
-               "cust_bill_pkg.edate > $unearned",
-               "cust_bill_pkg.recur != 0",
-               "part_pkg.freq != '0'",
-               "part_pkg.freq != '1'",
-               "part_pkg.freq NOT LIKE '%h'",
-               "part_pkg.freq NOT LIKE '%d'",
-               "part_pkg.freq NOT LIKE '%w'";
+  push @where, FS::tax_rate_location->location_sql(
+                 map { $_ => (scalar($cgi->param($_)) || '') }
+                   qw( district city county state locationtaxid )
+               );
 
 }
 
@@ -457,9 +391,9 @@ if ( $cgi->param('pkg_tax') ) {
             AND cust_bill_pkg.recur > 0 )
     )",
     #not a tax_exempt customer
-    "( tax != 'Y' OR tax IS NULL )";
+    "( tax != 'Y' OR tax IS NULL )", # assume this was intended?
     #not covered in full by a monthly tax exemption (texas tax)
-    "0 < ( $setup_taxable + $recur_taxable - $exempt )",
+    "0 < ( $setup_taxable + $recur_taxable - $exempt )";
 
 } else {
 
@@ -470,53 +404,31 @@ if ( $cgi->param('pkg_tax') ) {
   }
 
   if ( $use_usage eq 'recurring' ) {
-    $count_query .= "SUM(setup + recur - usage)";
+    $count_query .= "SUM(cust_bill_pkg.setup + cust_bill_pkg.recur - usage)";
   } elsif ( $use_usage eq 'usage' ) {
     $count_query .= "SUM(usage)";
-  } elsif ( $unearned ) {
-    $count_query .= "SUM(cust_bill_pkg.recur)";
   } elsif ( scalar( grep( /locationtaxid/, $cgi->param ) ) ) {
-    $count_query .= "SUM( COALESCE(cust_bill_pkg_tax_location.amount, cust_bill_pkg.setup + cust_bill_pkg.recur))";
+    $count_query .= "SUM( COALESCE(cust_bill_pkg_tax_rate_location.amount, cust_bill_pkg.setup + cust_bill_pkg.recur))";
   } elsif ( $cgi->param('iscredit') eq 'rate') {
     $count_query .= "SUM( cust_credit_bill_pkg.amount )";
   } else {
     $count_query .= "SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)";
   }
 
-  if ( $unearned ) {
-
-    #false laziness w/report_prepaid_income.cgi
-
-    my $float = 'REAL'; #'DOUBLE PRECISION';
-
-    my $period = "CAST(cust_bill_pkg.edate - cust_bill_pkg.sdate AS $float)";
-    my $elapsed = "(CASE WHEN cust_bill_pkg.sdate > $unearned
-                     THEN 0
-                     ELSE ($unearned - cust_bill_pkg.sdate)
-                   END)";
-    #my $elapsed = "CAST($unearned - cust_bill_pkg.sdate AS $float)";
-
-    my $remaining = "(1 - $elapsed/$period)";
-
-    $count_query .= ", SUM($remaining * cust_bill_pkg.recur)";
-
-  }
-
 }
 
-my $join_cust =  '      JOIN cust_bill USING ( invnum ) 
-                   LEFT JOIN cust_main USING ( custnum ) ';
-
+$join_cust =  '        JOIN cust_bill USING ( invnum )
+                  LEFT JOIN cust_main USING ( custnum ) ';
 
-my $join_pkg;
 if ( $cgi->param('nottax') ) {
 
-  $join_pkg =  ' LEFT JOIN cust_pkg USING ( pkgnum )
-                 LEFT JOIN part_pkg USING ( pkgpart )
-                 LEFT JOIN part_pkg AS override
-                   ON pkgpart_override = override.pkgpart ';
-  $join_pkg .= ' LEFT JOIN cust_location USING ( locationnum ) '
-    if $conf->exists('tax-pkg_address');
+  $join_pkg .=  ' LEFT JOIN cust_pkg USING ( pkgnum )
+                  LEFT JOIN part_pkg USING ( pkgpart )
+                  LEFT JOIN part_pkg AS override
+                    ON pkgpart_override = override.pkgpart
+                  LEFT JOIN cust_location
+                    ON cust_location.locationnum = '.
+                    FS::cust_pkg->tax_locationnum_sql;
 
 } elsif ( $cgi->param('istax') ) {
 
@@ -524,17 +436,26 @@ if ( $cgi->param('nottax') ) {
   if ( scalar( grep( /locationtaxid/, $cgi->param ) ) ||
             $cgi->param('iscredit') eq 'rate') {
 
+    # using tax_rate_location and friends
     $join_pkg .=
       ' LEFT JOIN cust_bill_pkg_tax_rate_location USING ( billpkgnum ) '.
       ' LEFT JOIN tax_rate_location USING ( taxratelocationnum ) ';
 
-  } elsif ( $conf->exists('tax-pkg_address') ) {
+  #} elsif ( $conf->exists('tax-pkg_address') ) {
+  } else {
+
+    # using cust_bill_pkg_tax_location to relate tax items to locations
+    # ...but for consolidated taxes we don't want to duplicate this
+    my $tax_item_location = '(SELECT DISTINCT billpkgnum, locationnum
+      FROM cust_bill_pkg_tax_location) AS tax_item_location';
 
-    $join_pkg .= ' LEFT JOIN cust_bill_pkg_tax_location USING ( billpkgnum )
-                   LEFT JOIN cust_location              USING ( locationnum ) ';
+    $join_pkg .= " LEFT JOIN $tax_item_location USING ( billpkgnum )
+                   LEFT JOIN cust_location
+                    ON tax_item_location.locationnum =
+                       cust_location.locationnum ";
 
     #quelle kludge, somewhat false laziness w/report_tax.cgi
-    s/cust_pkg\.locationnum/cust_bill_pkg_tax_location.locationnum/g for @where;
+    s/cust_pkg\.locationnum/tax_item_location.locationnum/g for @where;
   }
 
   if ( $cgi->param('iscredit') ) {
@@ -553,7 +474,7 @@ if ( $cgi->param('nottax') ) {
 } else { 
 
   #die?
-  warn "neiether nottax nor istax parameters specified";
+  warn "neither nottax nor istax parameters specified";
   #same as before?
   $join_pkg =  ' LEFT JOIN cust_pkg USING ( pkgnum )
                  LEFT JOIN part_pkg USING ( pkgpart ) ';
@@ -573,9 +494,6 @@ if ($use_usage) {
   $count_query .= " FROM cust_bill_pkg $join_cust $join_pkg $where";
 }
 
-my @select = ( 'cust_bill_pkg.*',
-               'cust_bill._date', );
-
 push @select, 'part_pkg.pkg',
               'part_pkg.freq',
   unless $cgi->param('istax');
@@ -587,9 +505,9 @@ my $query = {
   'table'     => 'cust_bill_pkg',
   'addl_from' => "$join_cust $join_pkg",
   'hashref'   => {},
-  'select'    => join(', ', @select ),
+  'select'    => join(",\n", @select ),
   'extra_sql' => $where,
-  'order_by'  => 'ORDER BY _date, billpkgnum',
+  'order_by'  => 'ORDER BY cust_bill._date, billpkgnum',
 };
 
 my $ilink = [ "${p}view/cust_bill.cgi?", 'invnum' ];
@@ -599,9 +517,8 @@ my $conf = new FS::Conf;
 my $money_char = $conf->config('money_char') || '$';
 
 my $owed_sub = sub {
-  $money_char. shift->owed_recur; #_recur :/
+  $money_char . shift->get('owed') # owed_recur is not correct here
 };
-
 my $payment_date_sub = sub {
   #my $cust_bill_pkg = shift;
   my @cust_pay = sort { $a->_date <=> $b->_date }
@@ -610,5 +527,5 @@ my $payment_date_sub = sub {
     or return '';
   time2str('%b %d %Y', $cust_pay[-1]->_date );
 };
-
+warn $count_query;
 </%init>