X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2FReport%2FTable%2FMonthly.pm;h=86ab19b7493f00220b5979be95fcd55eb257a36b;hb=64948ee373a03fa156ebc89cb39adfa6d4d2c3d5;hp=4b866c4dc18d4d70a90491c2e3caeda7743f990f;hpb=624b2d44625f69d71175c3348cae635d580c890b;p=freeside.git

diff --git a/FS/FS/Report/Table/Monthly.pm b/FS/FS/Report/Table/Monthly.pm
index 4b866c4dc..86ab19b74 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,7 @@ FS::Report::Table::Monthly - Tables of report data, indexed monthly
     'end_year'    => 2020,
     #opt
     'agentnum'    => 54
+    'refnum'      => 54
     'params'      => [ [ 'paramsfor', 'item_one' ], [ 'item', 'two' ] ], # ...
     'remove_empty' => 1, #collapse empty rows, default 0
     'item_labels' => [ ], #useful with remove_empty
@@ -43,36 +43,93 @@ Returns a hashref of data (!! describe)
 =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'};
+
+  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;
+
+  while ( $syear < $max_year
+     || ( $syear == $max_year && $smonth < $max_month+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;
     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 @param = $self->{'params'} ? @{ $self->{'params'}[$col] }: ();
-      my $value = $self->$item($speriod, $eperiod, $agentnum, @param);
-      #push @{$data{$item}}, $value;
-      push @{$data{data}->[$col++]}, $value;
+    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] }: ();
+        push @param, 'project', $projecting;
+        push @param, 'refnum' => $refnum if $refnum;
+        my $value = $self->$item($speriod, $eperiod, $agentnum, @param);
+        push @{$data{data}->[$col]}, $value;
+        $item = $items[$i+1]; 
+        @param = $self->{'params'} ? @{ $self->{'params'}[++$i] }: ();
+        push @param, 'project', $projecting;
+        push @param, 'refnum' => $refnum if $refnum;
+        $value = $self->$item($speriod, $eperiod, $agentnum, @param);
+        push @{$data{data}->[$col++]}, $value;
+      }
+      else {
+        my $item = $items[$i];
+        my @param = $self->{'params'} ? @{ $self->{'params'}[$col] }: ();
+        push @param, 'project', $projecting;
+        push @param, 'refnum' => $refnum if $refnum;
+        my $value = $self->$item($speriod, $eperiod, $agentnum, @param);
+        push @{$data{data}->[$col++]}, $value;
+      }
     }
 
   }
@@ -83,20 +140,18 @@ sub data {
   $data{'colors'}      = $self->{'colors'};
   $data{'links'}       = $self->{'links'} || [];
 
-  #use Data::Dumper;
-  #warn Dumper(\%data);
-
   if ( $self->{'remove_empty'} ) {
 
-    #warn "removing empty rows\n";
-
     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 ( grep { $_ != 0 } @{$data{'data'}->[$col]} ) {
@@ -105,6 +160,7 @@ sub data {
         push @newdata,   $data{'data'}->[$col];
         push @newcolors, $data{'colors'}->[$col];
         push @newlinks,  $data{'links'}->[$col];
+        push @indices,   $col;
       }
 
       $col++;
@@ -115,463 +171,15 @@ 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_pkg_setup_cost {
-  my( $self, $speriod, $eperiod, $agentnum, %opt ) = @_;
-  my $where = '';
-  my $comparison = '';
-  if ( $opt{'classnum'} =~ /^(\d+)$/ ) {
-    if ( $1 == 0 ) {
-      $comparison = 'IS NULL';
-    }
-    else {
-      $comparison = "= $1";
-    }
-    $where = "AND part_pkg.classnum $comparison";
-  }
-  $agentnum ||= $opt{'agentnum'};
-
-  my $total_sql = " SELECT SUM(part_pkg.setup_cost) ";
-  $total_sql .= " FROM cust_pkg 
-             LEFT JOIN cust_main USING ( custnum )
-             LEFT JOIN part_pkg  USING ( pkgpart )
-                  WHERE pkgnum != 0
-                  $where
-                  AND ".$self->in_time_period_and_agent(
-                    $speriod, $eperiod, $agentnum, 'cust_pkg.setup');
-  return $self->scalar_sql($total_sql);
-}
-
-sub cust_pkg_recur_cost {
-  my( $self, $speriod, $eperiod, $agentnum, %opt ) = @_;
-  my $where = '';
-  my $comparison = '';
-  if ( $opt{'classnum'} =~ /^(\d+)$/ ) {
-    if ( $1 == 0 ) {
-      $comparison = 'IS NULL';
-    }
-    else {
-      $comparison = "= $1";
-    }
-    $where = " AND part_pkg.classnum $comparison";
-  }
-  $agentnum ||= $opt{'agentnum'};
-  # duplication of in_time_period_and_agent
-  # because we do it a little differently here
-  $where .= " AND cust_main.agentnum = $agentnum" if $agentnum;
-  $where .= " AND ".
-          $FS::CurrentUser::CurrentUser->agentnums_sql('table' => 'cust_main');
-
-  my $total_sql = " SELECT SUM(part_pkg.recur_cost) ";
-  $total_sql .= " FROM cust_pkg
-             LEFT JOIN cust_main USING ( custnum )
-             LEFT JOIN part_pkg  USING ( pkgpart )
-                  WHERE pkgnum != 0
-                  $where
-                  AND cust_pkg.setup < $eperiod
-                  AND (cust_pkg.cancel > $speriod OR cust_pkg.cancel IS NULL)
-                  ";
-  return $self->scalar_sql($total_sql);
-}
- 
-sub cust_bill_pkg {
-  my( $self, $speriod, $eperiod, $agentnum, %opt ) = @_;
-
-  my $where = '';
-  my $comparison = '';
-  if ( $opt{'classnum'} =~ /^(\d+)$/ ) {
-    if ( $1 == 0 ) {
-      $comparison = "IS NULL";
-    } else {
-      $comparison = "= $1";
-    }
-
-    if ( $opt{'use_override'} ) {
-      $where = "(
-        part_pkg.classnum $comparison AND pkgpart_override IS NULL OR
-        override.classnum $comparison AND pkgpart_override IS NOT NULL
-      )";
-    } else {
-      $where = "part_pkg.classnum $comparison";
-    }
-  }
-
-  $agentnum ||= $opt{'agentnum'};
-
-  my $total_sql =
-    " SELECT COALESCE( SUM(cust_bill_pkg.setup + cust_bill_pkg.recur), 0 ) ";
-
-  $total_sql .=
-    " / CASE COUNT(cust_pkg.*) WHEN 0 THEN 1 ELSE COUNT(cust_pkg.*) END "
-      if $opt{average_per_cust_pkg};
-
-  $total_sql .=
-    " 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 )
-        LEFT JOIN part_pkg AS override ON pkgpart_override = override.pkgpart
-      WHERE pkgnum != 0
-        AND $where
-        AND ". $self->in_time_period_and_agent($speriod, $eperiod, $agentnum);
-  
-  if ($opt{use_usage} && $opt{use_usage} eq 'recurring') {
-    my $total = $self->scalar_sql($total_sql);
-    my $usage = cust_bill_pkg_detail(@_); #$speriod, $eperiod, $agentnum, %opt 
-    return $total-$usage;
-  } elsif ($opt{use_usage} && $opt{use_usage} eq 'usage') {
-    return cust_bill_pkg_detail(@_); #$speriod, $eperiod, $agentnum, %opt 
-  } else {
-    return $self->scalar_sql($total_sql);
-  }
-}
-
-sub cust_bill_pkg_detail {
-  my( $self, $speriod, $eperiod, $agentnum, %opt ) = @_;
-
-  my @where = ( "cust_bill_pkg.pkgnum != 0" );
-  my $comparison = '';
-  if ( $opt{'classnum'} =~ /^(\d+)$/ ) {
-    if ( $1 == 0 ) {
-      $comparison = "IS NULL";
-    } else {
-      $comparison = "= $1";
-    }
-
-    if ( $opt{'use_override'} ) {
-      push @where, "(
-        part_pkg.classnum $comparison AND pkgpart_override IS NULL OR
-        override.classnum $comparison AND pkgpart_override IS NOT NULL
-      )";
-    } else {
-      push @where, "part_pkg.classnum $comparison";
-    }
-  }
-
-  if ( $opt{'usageclass'} =~ /^(\d+)$/ ) {
-    if ( $1 == 0 ) {
-      $comparison = "IS NULL";
-    } else {
-      $comparison = "= $1";
-    }
-
-    push @where, "cust_bill_pkg_detail.classnum $comparison";
-  }
-
-  $agentnum ||= $opt{'agentnum'};
-
-  my $where = join( ' AND ', @where );
-
-  my $total_sql = " SELECT SUM(amount) ";
-
-  $total_sql .=
-    " / CASE COUNT(cust_pkg.*) WHEN 0 THEN 1 ELSE COUNT(cust_pkg.*) END "
-      if $opt{average_per_cust_pkg};
-
-  $total_sql .=
-    " FROM cust_bill_pkg_detail
-        LEFT JOIN cust_bill_pkg USING ( billpkgnum )
-        LEFT JOIN cust_bill ON cust_bill_pkg.invnum = cust_bill.invnum
-        LEFT JOIN cust_main USING ( custnum )
-        LEFT JOIN cust_pkg ON cust_bill_pkg.pkgnum = cust_pkg.pkgnum
-        LEFT JOIN part_pkg USING ( pkgpart )
-        LEFT JOIN part_pkg AS override ON pkgpart_override = override.pkgpart
-      WHERE $where
-        AND ". $self->in_time_period_and_agent($speriod, $eperiod, $agentnum);
-
-  $self->scalar_sql($total_sql);
-  
-}
-
-sub cust_bill_pkg_discount {
-  my( $self, $speriod, $eperiod, $agentnum, %opt ) = @_;
-
-  #my $where = '';
-  #my $comparison = '';
-  #if ( $opt{'classnum'} =~ /^(\d+)$/ ) {
-  #  if ( $1 == 0 ) {
-  #    $comparison = "IS NULL";
-  #  } else {
-  #    $comparison = "= $1";
-  #  }
-  #
-  #  if ( $opt{'use_override'} ) {
-  #    $where = "(
-  #      part_pkg.classnum $comparison AND pkgpart_override IS NULL OR
-  #      override.classnum $comparison AND pkgpart_override IS NOT NULL
-  #    )";
-  #  } else {
-  #    $where = "part_pkg.classnum $comparison";
-  #  }
-  #}
-
-  $agentnum ||= $opt{'agentnum'};
-
-  my $total_sql =
-    " SELECT COALESCE( SUM( cust_bill_pkg_discount.amount ), 0 ) ";
-
-  #$total_sql .=
-  #  " / CASE COUNT(cust_pkg.*) WHEN 0 THEN 1 ELSE COUNT(cust_pkg.*) END "
-  #    if $opt{average_per_cust_pkg};
-
-  $total_sql .=
-    " FROM cust_bill_pkg_discount
-        LEFT JOIN cust_bill_pkg USING ( billpkgnum )
-        LEFT JOIN cust_bill USING ( invnum )
-        LEFT JOIN cust_main USING ( custnum )
-      WHERE ". $self->in_time_period_and_agent($speriod, $eperiod, $agentnum);
-  #      LEFT JOIN cust_pkg_discount USING ( pkgdiscountnum )
-  #      LEFT JOIN discount USING ( discountnum )
-  #      LEFT JOIN cust_pkg USING ( pkgnum )
-  #      LEFT JOIN part_pkg USING ( pkgpart )
-  #      LEFT JOIN part_pkg AS override ON pkgpart_override = override.pkgpart
-  
-  return $self->scalar_sql($total_sql);
-
-}
-
-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