create a Sales, Credits, and Receipts report broken down by day, RT11470
[freeside.git] / FS / FS / Report / Table / Monthly.pm
index 89d44f9..f57fb06 100644 (file)
@@ -1,15 +1,12 @@
 package FS::Report::Table::Monthly;
 
 use strict;
-use vars qw( @ISA $expenses_kludge );
-use Time::Local;
-use FS::UID qw( dbh );
+use vars qw( @ISA );
 use FS::Report::Table;
+use Time::Local qw( timelocal );
 
 @ISA = qw( FS::Report::Table );
 
-$expenses_kludge = 0;
-
 =head1 NAME
 
 FS::Report::Table::Monthly - Tables of report data, indexed monthly
@@ -24,6 +21,11 @@ FS::Report::Table::Monthly - Tables of report data, indexed monthly
     'start_year'  => 2000,
     'end_month'   => 4,
     'end_year'    => 2020,
+    #opt
+    'agentnum'    => 54
+    'params'      => [ [ 'paramsfor', 'item_one' ], [ 'item', 'two' ] ], # ...
+    'remove_empty' => 1, #collapse empty rows, default 0
+    'item_labels' => [ ], #useful with remove_empty
   );
 
   my $data = $report->data;
@@ -45,12 +47,20 @@ sub data {
   my $syear = $self->{'start_year'};
   my $emonth = $self->{'end_month'};
   my $eyear = $self->{'end_year'};
+  my $agentnum = $self->{'agentnum'};
 
   my %data;
 
   while ( $syear < $eyear || ( $syear == $eyear && $smonth < $emonth+1 ) ) {
 
-    push @{$data{label}}, "$smonth/$syear";
+    if ( $self->{'doublemonths'} ) {
+       my($firstLabel,$secondLabel) = @{$self->{'doublemonths'}};
+       push @{$data{label}}, "$smonth/$syear $firstLabel";
+       push @{$data{label}}, "$smonth/$syear $secondLabel";
+    }
+    else {
+       push @{$data{label}}, "$smonth/$syear";
+    }
 
     my $speriod = timelocal(0,0,0,1,$smonth-1,$syear);
     push @{$data{speriod}}, $speriod;
@@ -58,142 +68,67 @@ sub data {
     my $eperiod = timelocal(0,0,0,1,$smonth-1,$syear);
     push @{$data{eperiod}}, $eperiod;
   
-    foreach my $item ( @{$self->{'items'}} ) {
-      push @{$data{$item}}, $self->$item($speriod, $eperiod);
+    my $col = 0;
+    my @items = @{$self->{'items'}};
+    my $i;
+    for ( $i = 0; $i < scalar(@items); $i++ ) {
+      if ( $self->{'doublemonths'} ) {
+         my $item = $items[$i]; 
+         my @param = $self->{'params'} ? @{ $self->{'params'}[$i] }: ();
+         my $value = $self->$item($speriod, $eperiod, $agentnum, @param);
+         push @{$data{data}->[$col]}, $value;
+         $item = $items[$i+1]; 
+         @param = $self->{'params'} ? @{ $self->{'params'}[++$i] }: ();
+         $value = $self->$item($speriod, $eperiod, $agentnum, @param);
+         push @{$data{data}->[$col++]}, $value;
+      }
+      else {
+         my $item = $items[$i];
+         my @param = $self->{'params'} ? @{ $self->{'params'}[$col] }: ();
+         my $value = $self->$item($speriod, $eperiod, $agentnum, @param);
+         push @{$data{data}->[$col++]}, $value;
+      }
     }
 
   }
 
-  \%data;
-
-}
-
-sub invoiced { #invoiced
-  my( $self, $speriod, $eperiod ) = ( shift, shift, shift );
-  $self->scalar_sql("
-    SELECT SUM(charged) FROM cust_bill
-    WHERE ". $self->in_time_period($speriod, $eperiod)
-  );
-}
-
-sub netsales { #net sales
-  my( $self, $speriod, $eperiod ) = ( shift, shift, shift );
-
-  my $credited = $self->scalar_sql("
-    SELECT SUM(cust_credit_bill.amount)
-    FROM cust_credit_bill, cust_bill
-    WHERE cust_bill.invnum = cust_credit_bill.invnum
-      AND ".  $self->in_time_period($speriod, $eperiod, 'cust_bill')
-  );
-
-  #horrible local kludge
-  my $expenses = !$expenses_kludge ? 0 : $self->scalar_sql("
-    SELECT SUM(cust_bill_pkg.setup)
-    FROM cust_bill_pkg, cust_bill, cust_pkg, part_pkg
-    WHERE cust_bill.invnum = cust_bill_pkg.invnum
-    AND ". $self->in_time_period($speriod, $eperiod, 'cust_bill'). "
-    AND cust_pkg.pkgnum = cust_bill_pkg.pkgnum
-    AND cust_pkg.pkgpart = part_pkg.pkgpart
-    AND LOWER(part_pkg.pkg) LIKE 'expense _%'
-  ");
-
-  $self->invoiced($speriod,$eperiod) - $credited - $expenses;
-}
-
-#deferred revenue
-
-sub receipts { #cashflow
-  my( $self, $speriod, $eperiod ) = ( shift, shift, shift );
-
-  my $refunded = $self->scalar_sql("
-    SELECT SUM(refund) FROM cust_refund
-    WHERE ". $self->in_time_period($speriod, $eperiod)
-  );
-
-  #horrible local kludge that doesn't even really work right
-  my $expenses = !$expenses_kludge ? 0 : $self->scalar_sql("
-    SELECT SUM(cust_bill_pay.amount)
-    FROM cust_bill_pay, cust_bill
-    WHERE cust_bill_pay.invnum = cust_bill.invnum
-    AND ". $self->in_time_period($speriod, $eperiod, 'cust_bill_pay'). "
-    AND 0 < ( SELECT COUNT(*) from cust_bill_pkg, cust_pkg, part_pkg
-              WHERE cust_bill.invnum = cust_bill_pkg.invnum
-              AND cust_pkg.pkgnum = cust_bill_pkg.pkgnum
-              AND cust_pkg.pkgpart = part_pkg.pkgpart
-              AND LOWER(part_pkg.pkg) LIKE 'expense _%'
-            )
-  ");
-  #    my $expenses_sql2 = "SELECT SUM(cust_bill_pay.amount) FROM cust_bill_pay, cust_bill_pkg, cust_bill, cust_pkg, part_pkg WHERE cust_bill_pay.invnum = cust_bill.invnum AND cust_bill.invnum = cust_bill_pkg.invnum AND cust_bill_pay._date >= $speriod AND cust_bill_pay._date < $eperiod AND cust_pkg.pkgnum = cust_bill_pkg.pkgnum AND cust_pkg.pkgpart = part_pkg.pkgpart AND LOWER(part_pkg.pkg) LIKE 'expense _%'";
-  
-  $self->payments($speriod, $eperiod) - $refunded - $expenses;
-}
+  #these need to get generalized, sheesh
+  $data{'items'}       = $self->{'items'};
+  $data{'item_labels'} = $self->{'item_labels'} || $self->{'items'};
+  $data{'colors'}      = $self->{'colors'};
+  $data{'links'}       = $self->{'links'} || [];
+
+  if ( $self->{'remove_empty'} ) {
+
+    my $col = 0;
+    #these need to get generalized, sheesh
+    my @newitems = ();
+    my @newlabels = ();
+    my @newdata = ();
+    my @newcolors = ();
+    my @newlinks = ();
+    foreach my $item ( @{$self->{'items'}} ) {
 
-sub payments {
-  my( $self, $speriod, $eperiod ) = ( shift, shift, shift );
-  $self->scalar_sql("
-    SELECT SUM(paid) FROM cust_pay
-    WHERE ". $self->in_time_period($speriod, $eperiod)
-  );
-}
+      if ( grep { $_ != 0 } @{$data{'data'}->[$col]} ) {
+        push @newitems,  $data{'items'}->[$col];
+        push @newlabels, $data{'item_labels'}->[$col];
+        push @newdata,   $data{'data'}->[$col];
+        push @newcolors, $data{'colors'}->[$col];
+        push @newlinks,  $data{'links'}->[$col];
+      }
 
-sub credits {
-  my( $self, $speriod, $eperiod ) = ( shift, shift, shift );
-  $self->scalar_sql("
-    SELECT SUM(amount) FROM cust_credit
-    WHERE ". $self->in_time_period($speriod, $eperiod)
-  );
-}
+      $col++;
+    }
 
-sub canceled { #active
-  my( $self, $speriod, $eperiod ) = ( shift, shift, shift );
-  $self->scalar_sql("
-    SELECT COUNT(*) FROM cust_pkg
-    WHERE cust_pkg.custnum = cust_main.custnum
-    AND 0 = ( SELECT COUNT(*) FROM cust_pkg
-              WHERE cust_pkg.custnum = cust_main.custnum
-              AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
-            )
-    AND cust_pkg.cancel > $speriod AND cust_pkg.cancel < $eperiod
-  ");
-}
-sub newaccount { #newaccount
-  my( $self, $speriod, $eperiod ) = ( shift, shift, shift );
-  $self->scalar_sql("
-     SELECT COUNT(*) FROM cust_pkg
-     WHERE cust_pkg.custnum = cust_main.custnum
-     AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
-     AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
-     AND cust_pkg.setup > $speriod AND cust_pkg.setup < $eperiod
-  ");
-}
-sub suspended { #suspended
-  my( $self, $speriod, $eperiod ) = ( shift, shift, shift );
-  $self->scalar_sql("
-     SELECT COUNT(*) FROM cust_pkg
-     WHERE cust_pkg.custnum = cust_main.custnum
-     AND ( cust_pkg.cancel IS NULL OR cust_pkg.cancel = 0 )
-     AND 0 = ( SELECT COUNT(*) FROM cust_pkg
-               WHERE cust_pkg.custnum = cust_main.custnum
-               AND ( cust_pkg.susp IS NULL OR cust_pkg.susp = 0 )
-             )
-     AND cust_pkg.susp > $speriod AND cust_pkg.susp < $eperiod
-  ");
-}
+    $data{'items'}       = \@newitems;
+    $data{'item_labels'} = \@newlabels;
+    $data{'data'}        = \@newdata;
+    $data{'colors'}      = \@newcolors;
+    $data{'links'}       = \@newlinks;
 
-sub in_time_period {
-  my( $self, $speriod, $eperiod ) = ( shift, shift, shift );
-  my $table = @_ ? shift().'.' : '';
-  "${table}_date >= $speriod AND ${table}_date < $eperiod";
-}
+  }
 
-sub scalar_sql {
-  my( $self, $sql ) = ( shift, shift );
-  my $sth = dbh->prepare($sql) or die dbh->errstr;
-  $sth->execute
-    or die "Unexpected error executing statement $sql: ". $sth->errstr;
-  $sth->fetchrow_arrayref->[0] || 0;
+  \%data;
 }
 
 =back