X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FReport%2FTable%2FMonthly.pm;h=0ff7efd16c43424525b706d30fd2077cc54549e1;hb=98ea15536afc6896cce08a41b877d6cb52444d14;hp=d75f0be79f7eb3c00fb3347579e5e2a1cb076f4f;hpb=978fea1c303551f90c95ae852b6463951b78246b;p=freeside.git

diff --git a/FS/FS/Report/Table/Monthly.pm b/FS/FS/Report/Table/Monthly.pm
index d75f0be79..0ff7efd16 100644
--- a/FS/FS/Report/Table/Monthly.pm
+++ b/FS/FS/Report/Table/Monthly.pm
@@ -2,10 +2,9 @@ package FS::Report::Table::Monthly;
 
 use strict;
 use vars qw( @ISA );
-use Time::Local;
-use FS::UID qw( dbh );
+use FS::UID qw(dbh);
 use FS::Report::Table;
-use FS::CurrentUser;
+use Time::Local qw( timelocal );
 
 @ISA = qw( FS::Report::Table );
 
@@ -25,6 +24,8 @@ FS::Report::Table::Monthly - Tables of report data, indexed monthly
     'end_year'    => 2020,
     #opt
     'agentnum'    => 54
+    'refnum'      => 54
+    'cust_classnum' => [ 1,2,4 ],
     'params'      => [ [ 'paramsfor', 'item_one' ], [ 'item', 'two' ] ], # ...
     'remove_empty' => 1, #collapse empty rows, default 0
     'item_labels' => [ ], #useful with remove_empty
@@ -32,49 +33,186 @@ FS::Report::Table::Monthly - Tables of report data, indexed monthly
 
   my $data = $report->data;
 
-=head1 METHODS
+=head1 PARAMETERS
+
+=head2 TIME PERIOD
+
+C<start_month>, C<start_year>, C<end_month>, and C<end_year> specify the date
+range to be included in the report.  The start and end months are included.
+Each month's values are summed from midnight on the first of the month to 
+23:59:59 on the last day of the month.
+
+=head2 REPORT ITEMS
+
+=over 4
+
+=item items: An arrayref of observables to calculate for each month.  See 
+L<FS::Report::Table> for a list of observables and their parameters.
+
+=item params: An arrayref, parallel to C<items>, of arrayrefs of parameters
+(in paired name/value form) to be passed to the observables.
+
+=item cross_params: Cross-product parameters.  This must be an arrayref of 
+arrayrefs of parameters (paired name/value form).  This creates an additional 
+"axis" (orthogonal to the time and C<items> axes) in which the item is 
+calculated once with each set of parameters in C<cross_params>.  These 
+parameters are merged with those in C<params>.  Instead of being nested two
+levels, C<data> will be nested three levels, with the third level 
+corresponding to this arrayref.
+
+=back
+
+=head2 FILTERING
+
+=over 4
+
+=item agentnum: Limit to customers with this agent.
+
+=item refnum: Limit to customers with this advertising source.
+
+=item cust_classnum: Limit to customers with this classnum; can be an 
+arrayref.
+
+=item remove_empty: Set this to a true value to hide rows that contain 
+only zeroes.  The C<indices> array in the returned data will list the item
+indices that are actually present in the output so that you know what they
+are.  Ignored if C<cross_params> is in effect.
+
+=back
+
+=head2 PASS-THROUGH
+
+C<item_labels>, C<colors>, and C<links> may be specified as arrayrefs
+parallel to C<items>.  Those values will be returned in C<data>, with any
+hidden rows (due to C<remove_empty>) filtered out, which is the only 
+reason to do this.  Now that we have C<indices> it's probably better to 
+use that.
+
+=item PROCESSING
+
+=item normalize: Set this to an item index to have all other items expressed
+as a percentage of that one.  That item will then be omitted from the output.
+If the normalization item is zero in some period, all the values in that
+period will be undef.
+
+=head1 RETURNED DATA
+
+The C<data> method runs the report and returns a hashref of the following:
 
 =over 4
 
+=item label
+
+Month labels, in MM/YYYY format.
+
+=item speriod, eperiod
+
+Absolute start and end times of each month, in unix time format.
+
+=item items
+
+The values passed in as C<items>, with any suppressed rows deleted.
+
+=item indices
+
+The indices of items in the input C<items> list that appear in the result
+set.  Useful for figuring out what they are when C<remove_empty> has deleted 
+some items.
+
+=item item_labels, colors, links - see PASS-THROUGH above
+
 =item data
 
-Returns a hashref of data (!! describe)
+The actual results.  An arrayref corresponding to C<label> (the time axis),
+containing arrayrefs corresponding to C<items>, containing either numbers
+or, if C<cross_params> is given, arrayrefs corresponding to C<cross_params>.
+
+=back
 
 =cut
 
 sub data {
+  local $FS::UID::AutoCommit = 0;
   my $self = shift;
 
-  #use Data::Dumper;
-  #warn Dumper($self);
+  my $smonth  = $self->{'start_month'};
+  my $syear   = $self->{'start_year'};
+  my $emonth  = $self->{'end_month'};
+  my $eyear   = $self->{'end_year'};
+  # whether to extrapolate into the future
+  my $projecting = $self->{'projection'};
+
+  # sanity checks
+  if ( $eyear < $syear or
+      ($eyear == $syear and $emonth < $smonth) ) {
+    return { error => 'Start month must be before end month' };
+  }
 
-  my $smonth = $self->{'start_month'};
-  my $syear = $self->{'start_year'};
-  my $emonth = $self->{'end_month'};
-  my $eyear = $self->{'end_year'};
   my $agentnum = $self->{'agentnum'};
+  my $refnum = $self->{'refnum'};
+  my $cust_classnum = $self->{'cust_classnum'} || [];
+  $cust_classnum = [ $cust_classnum ] if !ref($cust_classnum);
+
+  if ( $projecting ) {
+
+    $self->init_projection;
+
+    my $thismonth = $smonth;
+    my $thisyear  = $syear;
+    while ( $thisyear < $eyear || 
+      ( $thisyear == $eyear and $thismonth <= $emonth )
+    ) {
+      my $speriod = timelocal(0,0,0,1,$thismonth-1,$thisyear);
+      $thismonth++;
+      if ( $thismonth == 13 ) { $thisyear++; $thismonth = 1; }
+      my $eperiod = timelocal(0,0,0,1,$thismonth-1,$thisyear);
+
+      $self->extend_projection($speriod, $eperiod);
+    }
+  }
 
   my %data;
 
-  while ( $syear < $eyear || ( $syear == $eyear && $smonth < $emonth+1 ) ) {
+  my $max_year  = $eyear;
+  my $max_month = $emonth;
 
-    push @{$data{label}}, "$smonth/$syear";
+  while ( $syear < $max_year
+     || ( $syear == $max_year && $smonth < $max_month+1 ) ) {
+
+    push @{$data{label}}, "$smonth/$syear"; # sprintf?
 
     my $speriod = timelocal(0,0,0,1,$smonth-1,$syear);
     push @{$data{speriod}}, $speriod;
     if ( ++$smonth == 13 ) { $syear++; $smonth=1; }
     my $eperiod = timelocal(0,0,0,1,$smonth-1,$syear);
     push @{$data{eperiod}}, $eperiod;
-  
-    my $col = 0;
-    my @row = ();
-    foreach my $item ( @{$self->{'items'}} ) {
+
+    my $col = 0; # a "column" here is the data corresponding to an item
+    my @items = @{$self->{'items'}};
+    my $i;
+
+    for ( $i = 0; $i < scalar(@items); $i++ ) {
+      my $item = $items[$i];
       my @param = $self->{'params'} ? @{ $self->{'params'}[$col] }: ();
-      my $value = $self->$item($speriod, $eperiod, $agentnum, @param);
-      #push @{$data{$item}}, $value;
-      push @{$data{data}->[$col++]}, $value;
+      push @param, 'project', $projecting;
+      push @param, 'refnum' => $refnum if $refnum;
+      push @param, 'cust_classnum' => $cust_classnum if @$cust_classnum;
+
+      if ( $self->{'cross_params'} ) {
+        my @xdata;
+        foreach my $xparam (@{ $self->{'cross_params'} }) {
+          # @$xparam is a list of additional params to merge into the list
+          my $value = $self->$item($speriod, $eperiod, $agentnum,
+                        @param, 
+                        @$xparam);
+          push @xdata, $value;
+        }
+        push @{$data{data}->[$col++]}, \@xdata;
+      } else {
+        my $value = $self->$item($speriod, $eperiod, $agentnum, @param);
+        push @{$data{data}->[$col++]}, $value;
+      }
     }
-
   }
 
   #these need to get generalized, sheesh
@@ -83,30 +221,58 @@ sub data {
   $data{'colors'}      = $self->{'colors'};
   $data{'links'}       = $self->{'links'} || [];
 
-  #use Data::Dumper;
-  #warn Dumper(\%data);
-
-  if ( $self->{'remove_empty'} ) {
+  if ( defined $self->{'normalize'} ) {
+    my $norm_col = $self->{'normalize'};
+    my $norm_data = $data{data}->[$norm_col];
+
+    my $row = 0;
+    while ( exists $data{speriod}->[$row] ) {
+      my $col = 0;
+      while ( exists $data{items}->[$col ] ) {
+        if ( $col != $norm_col ) {
+          if ( $norm_data->[$row] == 0 ) {
+            $data{data}->[$col][$row] = undef;
+          } else {
+            $data{data}->[$col][$row] = 
+              ( $data{data}->[$col][$row] * 100 / $norm_data->[$row] );
+          }
+        }
+        $col++;
+      }
+      $row++;
+    }
+  }
 
-    #warn "removing empty rows\n";
+  if ( !$self->{'cross_params'} ) {
+    # remove unnecessary rows
 
     my $col = 0;
     #these need to get generalized, sheesh
+    #(though we now return a list of item indices that are present in the 
+    #output, so the front-end code could do this)
     my @newitems = ();
     my @newlabels = ();
     my @newdata = ();
     my @newcolors = ();
     my @newlinks = ();
+    my @indices = ();
     foreach my $item ( @{$self->{'items'}} ) {
 
+      # if remove_empty, then remove rows of zeroes
+      my $is_nonzero = scalar( grep { $_ != 0 } @{ $data{'data'}->[$col] });
+      next if ($self->{'remove_empty'} and $is_nonzero == 0);
+      # if normalizing, strip out the norm column
+      next if (defined($self->{'normalize'}) and $self->{'normalize'} == $col);
+
       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];
+        push @indices,   $col;
       }
-
+    } continue {
       $col++;
     }
 
@@ -115,284 +281,22 @@ sub data {
     $data{'data'}        = \@newdata;
     $data{'colors'}      = \@newcolors;
     $data{'links'}       = \@newlinks;
+    $data{'indices'}     = \@indices;
 
   }
 
-  #use Data::Dumper;
-  #warn Dumper(\%data);
+  # clean up after ourselves
+  #dbh->rollback;
+  # leave in until development is finished, for diagnostics
+  dbh->commit;
 
   \%data;
-
-}
-
-sub invoiced { #invoiced
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-
-  $self->scalar_sql("
-    SELECT SUM(charged)
-      FROM cust_bill
-        LEFT JOIN cust_main USING ( custnum )
-      WHERE ". $self->in_time_period_and_agent($speriod, $eperiod, $agentnum)
-  );
-  
-}
-
-sub netsales { #net sales
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-
-    $self->invoiced($speriod,$eperiod,$agentnum)
-  - $self->credits( $speriod,$eperiod,$agentnum);
-}
-
-#deferred revenue
-
-sub cashflow {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-
-    $self->payments($speriod, $eperiod, $agentnum)
-  - $self->refunds( $speriod, $eperiod, $agentnum);
-}
-
-sub netcashflow {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-
-    $self->receipts($speriod, $eperiod, $agentnum)
-  - $self->netrefunds( $speriod, $eperiod, $agentnum);
-}
-
-sub payments {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $self->scalar_sql("
-    SELECT SUM(paid)
-      FROM cust_pay
-        LEFT JOIN cust_main USING ( custnum )
-      WHERE ". $self->in_time_period_and_agent($speriod, $eperiod, $agentnum)
-  );
-}
-
-sub credits {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $self->scalar_sql("
-    SELECT SUM(amount)
-      FROM cust_credit
-        LEFT JOIN cust_main USING ( custnum )
-      WHERE ". $self->in_time_period_and_agent($speriod, $eperiod, $agentnum)
-  );
-}
-
-sub refunds {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $self->scalar_sql("
-    SELECT SUM(refund)
-      FROM cust_refund
-        LEFT JOIN cust_main USING ( custnum )
-      WHERE ". $self->in_time_period_and_agent($speriod, $eperiod, $agentnum)
-  );
-}
-
-sub netcredits {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $self->scalar_sql("
-    SELECT SUM(cust_credit_bill.amount)
-      FROM cust_credit_bill
-        LEFT JOIN cust_bill USING ( invnum  )
-        LEFT JOIN cust_main USING ( custnum )
-      WHERE ". $self->in_time_period_and_agent( $speriod,
-                                                $eperiod,
-                                                $agentnum,
-                                                'cust_bill._date'
-                                              )
-  );
-}
-
-sub receipts { #net payments
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $self->scalar_sql("
-    SELECT SUM(cust_bill_pay.amount)
-      FROM cust_bill_pay
-        LEFT JOIN cust_bill USING ( invnum  )
-        LEFT JOIN cust_main USING ( custnum )
-      WHERE ". $self->in_time_period_and_agent( $speriod,
-                                                $eperiod,
-                                                $agentnum,
-                                                'cust_bill._date'
-                                              )
-  );
-}
-
-sub netrefunds {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $self->scalar_sql("
-    SELECT SUM(cust_credit_refund.amount)
-      FROM cust_credit_refund
-        LEFT JOIN cust_credit USING ( crednum  )
-        LEFT JOIN cust_main   USING ( custnum )
-      WHERE ". $self->in_time_period_and_agent( $speriod,
-                                                $eperiod,
-                                                $agentnum,
-                                                'cust_credit._date'
-                                              )
-  );
-}
-
-#these should be auto-generated or $AUTOLOADed or something
-sub invoiced_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->invoiced($speriod, $eperiod, $agentnum);
-}
-
-sub netsales_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->netsales($speriod, $eperiod, $agentnum);
-}
-
-sub receipts_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->receipts($speriod, $eperiod, $agentnum);
-}
-
-sub payments_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->payments($speriod, $eperiod, $agentnum);
-}
-
-sub credits_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->credits($speriod, $eperiod, $agentnum);
-}
-
-sub netcredits_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->netcredits($speriod, $eperiod, $agentnum);
-}
-
-sub cashflow_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->cashflow($speriod, $eperiod, $agentnum);
-}
-
-sub netcashflow_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->cashflow($speriod, $eperiod, $agentnum);
-}
-
-sub refunds_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->refunds($speriod, $eperiod, $agentnum);
-}
-
-sub netrefunds_12mo {
-  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-  $speriod = $self->_subtract_11mo($speriod);
-  $self->netrefunds($speriod, $eperiod, $agentnum);
-}
-
-
-#not being too bad with the false laziness
-use Time::Local qw(timelocal);
-sub _subtract_11mo {
-  my($self, $time) = @_;
-  my ($sec,$min,$hour,$mday,$mon,$year) = (localtime($time) )[0,1,2,3,4,5];
-  $mon -= 11;
-  if ( $mon < 0 ) { $mon+=12; $year--; }
-  timelocal($sec,$min,$hour,$mday,$mon,$year);
-}
-
-sub cust_bill_pkg {
-  my( $self, $speriod, $eperiod, $agentnum, %opt ) = @_;
-
-  my $where = '';
-  if ( $opt{'classnum'} =~ /^(\d+)$/ ) {
-    if ( $1 == 0 ) {
-      $where = "classnum IS NULL";
-    } else {
-      $where = "classnum = $1";
-    }
-  }
-
-  $agentnum ||= $opt{'agentnum'};
-
-  $self->scalar_sql("
-    SELECT SUM(cust_bill_pkg.setup + cust_bill_pkg.recur)
-      FROM cust_bill_pkg
-        LEFT JOIN cust_bill USING ( invnum )
-        LEFT JOIN cust_main USING ( custnum )
-        LEFT JOIN cust_pkg USING ( pkgnum )
-        LEFT JOIN part_pkg USING ( pkgpart )
-      WHERE pkgnum != 0
-        AND $where
-        AND ". $self->in_time_period_and_agent($speriod, $eperiod, $agentnum)
-  );
-  
-}
-
-sub setup_pkg  { shift->pkg_field( @_, 'setup' ); }
-sub susp_pkg   { shift->pkg_field( @_, 'susp'  ); }
-sub cancel_pkg { shift->pkg_field( @_, 'cancel'); }
- 
-sub pkg_field {
-  my( $self, $speriod, $eperiod, $agentnum, $field ) = @_;
-  $self->scalar_sql("
-    SELECT COUNT(*) FROM cust_pkg
-        LEFT JOIN cust_main USING ( custnum )
-      WHERE ". $self->in_time_period_and_agent( $speriod,
-                                                $eperiod,
-                                                $agentnum,
-                                                "cust_pkg.$field",
-                                              )
-  );
-
-}
-
-#this is going to be harder..
-#sub unsusp_pkg {
-#  my( $self, $speriod, $eperiod, $agentnum ) = @_;
-#  $self->scalar_sql("
-#    SELECT COUNT(*) FROM h_cust_pkg
-#      WHERE 
-#
-#}
-
-sub in_time_period_and_agent {
-  my( $self, $speriod, $eperiod, $agentnum ) = splice(@_, 0, 4);
-  my $col = @_ ? shift() : '_date';
-
-  my $sql = "$col >= $speriod AND $col < $eperiod";
-
-  #agent selection
-  $sql .= " AND cust_main.agentnum = $agentnum"
-    if $agentnum;
-
-  #agent virtualization
-  $sql .= ' AND '.
-          $FS::CurrentUser::CurrentUser->agentnums_sql( 'table'=>'cust_main' );
-
-  $sql;
-}
-
-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;
 }
 
 =back
 
 =head1 BUGS
 
-Documentation.
-
 =head1 SEE ALSO
 
 =cut