From: ivan <ivan>
Date: Fri, 5 Mar 2004 14:34:24 +0000 (+0000)
Subject: beginning of OO reporting interface, create acadia-requested crosstab reports
X-Git-Tag: NET_WHOIS_RAW_0_31~106
X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=commitdiff_plain;h=654234a526b5447ec02970962cccb1cf879796c8

beginning of OO reporting interface, create acadia-requested crosstab reports
---

diff --git a/FS/FS/Report.pm b/FS/FS/Report.pm
new file mode 100644
index 000000000..181fea2f6
--- /dev/null
+++ b/FS/FS/Report.pm
@@ -0,0 +1,46 @@
+package FS::Report;
+
+use strict;
+
+=head1 NAME
+
+FS::Report - Report data objects
+
+=head1 SYNOPSIS
+
+  #see the more speicific report objects, currently only FS::Report::Table
+
+=head1 DESCRIPTION
+
+See the more specific report objects, currently only FS::Report::Table
+
+=head1 METHODS
+
+=over 4
+
+=item new [ OPTION => VALUE ... ]
+
+Constructor.  Takes a list of options and their values.
+
+=cut
+
+sub new {
+  my $proto = shift;
+  my $class = ref($proto) || $proto;
+  my $self = @_ ? ( ref($_[0]) ? shift : { @_ } ) : {};
+  bless( $self, $class );
+}
+
+=back
+
+=head1 BUGS
+
+Documentation.
+
+=head1 SEE ALSO
+
+L<FS::Report::Table>, reports in the web interface.
+
+=cut
+
+1;
diff --git a/FS/FS/Report/Table.pm b/FS/FS/Report/Table.pm
new file mode 100644
index 000000000..9f636fa43
--- /dev/null
+++ b/FS/FS/Report/Table.pm
@@ -0,0 +1,27 @@
+package FS::Report::Table;
+
+use strict;
+use vars qw( @ISA );
+use FS::Report;
+
+@ISA = qw( FS::Report );
+
+=head1 NAME
+
+FS::Report::Table - Tables of report data
+
+=head1 SYNOPSIS
+
+See the more specific report objects, currently only FS::Report::Table::Monthly
+
+=head1 BUGS
+
+Documentation.
+
+=head1 SEE ALSO
+
+L<FS::Report::Table::Monthly>, reports in the web interface.
+
+=cut
+
+1;
diff --git a/FS/FS/Report/Table/Monthly.pm b/FS/FS/Report/Table/Monthly.pm
new file mode 100644
index 000000000..9aebeee3d
--- /dev/null
+++ b/FS/FS/Report/Table/Monthly.pm
@@ -0,0 +1,166 @@
+package FS::Report::Table::Monthly;
+
+use strict;
+use vars qw( @ISA );
+use Time::Local;
+use FS::UID qw( dbh );
+use FS::Report::Table;
+
+@ISA = qw( FS::Report::Table );
+
+=head1 NAME
+
+FS::Report::Table::Monthly - Tables of report data, indexed monthly
+
+=head1 SYNOPSIS
+
+  use FS::Report::Table::Monthly;
+
+  my $report = new FS::Report::Table (
+    'items' => [ 'invoiced', 'netsales', 'credits', 'receipts', ],
+    'start_month' => 4,
+    'start_year'  => 2000,
+    'end_month'   => 4,
+    'end_year'    => 2020,
+  );
+
+  my $data = $report->data;
+
+=head1 METHODS
+
+=over 4
+
+=item data
+
+Returns a hashref of data (!! describe)
+
+=cut
+
+sub data {
+  my $self = shift;
+
+  my $smonth = $self->{'start_month'};
+  my $syear = $self->{'start_year'};
+  my $emonth = $self->{'end_month'};
+  my $eyear = $self->{'end_year'};
+
+  my %data;
+
+  while ( $syear < $eyear || ( $syear == $eyear && $smonth < $emonth+1 ) ) {
+
+    push @{$data{label}}, "$smonth/$syear";
+
+    my $speriod = timelocal(0,0,0,1,$smonth-1,$syear);
+    if ( ++$smonth == 13 ) { $syear++; $smonth=1; }
+    my $eperiod = timelocal(0,0,0,1,$smonth-1,$syear);
+  
+    foreach my $item ( @{$self->{'items'}} ) {
+      push @{$data{$item}}, $self->$item($speriod, $eperiod);
+    }
+
+  }
+
+  \%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 = $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 );
+
+  #cashflow
+  my $paid = $self->scalar_sql("
+    SELECT SUM(paid) FROM cust_pay
+    WHERE ". $self->in_time_period($speriod, $eperiod)
+  );
+
+  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 = $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 _%'";
+  
+  $paid-$refunded-$expenses;
+}
+
+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)
+  );
+}
+
+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;
+}
+
+=back
+
+=head1 BUGS
+
+Documentation.
+
+=head1 SEE ALSO
+
+=cut
+
+1;
+
diff --git a/FS/MANIFEST b/FS/MANIFEST
index 3cbf0e91f..555509a41 100644
--- a/FS/MANIFEST
+++ b/FS/MANIFEST
@@ -37,6 +37,9 @@ FS/Conf.pm
 FS/ConfItem.pm
 FS/Misc.pm
 FS/Record.pm
+FS/Report.pm
+FS/Report/Table.pm
+FS/Report/Table/Monthly.pm
 FS/SearchCache.pm
 FS/UI/Base.pm
 FS/UI/CGI.pm
@@ -128,6 +131,9 @@ t/Conf.t
 t/ConfItem.t
 t/Misc.t
 t/Record.t
+t/Report.pm
+t/Report-Table.pm
+t/Report-Table-Monthly.pm
 t/UID.t
 t/Msgcat.t
 t/SearchCache.t
diff --git a/FS/t/Report-Table-Monthly.t b/FS/t/Report-Table-Monthly.t
new file mode 100644
index 000000000..6ff365d1c
--- /dev/null
+++ b/FS/t/Report-Table-Monthly.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::Report::Table::Monthly;
+$loaded=1;
+print "ok 1\n";
diff --git a/FS/t/Report-Table.t b/FS/t/Report-Table.t
new file mode 100644
index 000000000..866d4981e
--- /dev/null
+++ b/FS/t/Report-Table.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::Report::Table;
+$loaded=1;
+print "ok 1\n";
diff --git a/FS/t/Report.t b/FS/t/Report.t
new file mode 100644
index 000000000..76d6ea489
--- /dev/null
+++ b/FS/t/Report.t
@@ -0,0 +1,5 @@
+BEGIN { $| = 1; print "1..1\n" }
+END {print "not ok 1\n" unless $loaded;}
+use FS::Report;
+$loaded=1;
+print "ok 1\n";
diff --git a/htetc/global.asa b/htetc/global.asa
index 8027ae3e5..5652a6f4f 100644
--- a/htetc/global.asa
+++ b/htetc/global.asa
@@ -24,6 +24,7 @@ use FS::CGI qw(header menubar popurl table itable ntable idiot eidiot
                small_custview myexit http_header);
 use FS::Msgcat qw(gettext geterror);
 use FS::Misc qw( send_email );
+use FS::Report::Table::Monthly;
 
 use FS::agent;
 use FS::agent_type;
diff --git a/htetc/handler.pl b/htetc/handler.pl
index 618c5856f..0301d98d1 100644
--- a/htetc/handler.pl
+++ b/htetc/handler.pl
@@ -81,6 +81,7 @@ sub handler
                      small_custview myexit http_header);
       use FS::Msgcat qw(gettext geterror);
       use FS::Misc qw( send_email );
+      use FS::Report::Table::Monthly;
 
       use FS::agent;
       use FS::agent_type;
diff --git a/httemplate/graph/money_time-graph.cgi b/httemplate/graph/money_time-graph.cgi
index 76f1bd7bd..55e8982b4 100755
--- a/httemplate/graph/money_time-graph.cgi
+++ b/httemplate/graph/money_time-graph.cgi
@@ -10,98 +10,56 @@ my $smonth = $cgi->param('smonth') || $curmon+1;
 #find last month
 my $eyear = $cgi->param('eyear') || 1900+$curyear;
 my $emonth = $cgi->param('emonth') || $curmon+1;
-if ( $emonth++>12 ) { $emonth-=12; $eyear++; }
+#if ( $emonth++>12 ) { $emonth-=12; $eyear++; }
 
-my @labels;
-my %data;
+#my @labels;
+#my %data;
 
-while ( $syear < $eyear || ( $syear == $eyear && $smonth < $emonth ) ) {
-  push @labels, "$smonth/$syear";
-
-  my $speriod = timelocal(0,0,0,1,$smonth-1,$syear);
-  if ( ++$smonth == 13 ) { $syear++; $smonth=1; }
-  my $eperiod = timelocal(0,0,0,1,$smonth-1,$syear);
-
-  my $where = "WHERE _date >= $speriod AND _date < $eperiod";
-
-  # Invoiced
-  my $charged_sql = "SELECT SUM(charged) FROM cust_bill $where";
-  my $charged_sth = dbh->prepare($charged_sql) or die dbh->errstr;
-  $charged_sth->execute or die $charged_sth->errstr;
-  my $charged = $charged_sth->fetchrow_arrayref->[0] || 0;
-
-  push @{$data{charged}}, $charged;
-
-  #accounts receivable
-#  my $ar_sql2 = "SELECT SUM(amount) FROM cust_credit $where";
-  my $credited_sql = "SELECT SUM(cust_credit_bill.amount) FROM cust_credit_bill, cust_bill WHERE cust_bill.invnum = cust_credit_bill.invnum AND cust_bill._date >= $speriod AND cust_bill._date < $eperiod";
-  my $credited_sth = dbh->prepare($credited_sql) or die dbh->errstr;
-  $credited_sth->execute or die $credited_sth->errstr;
-  my $credited = $credited_sth->fetchrow_arrayref->[0] || 0;
-
-    #horrible local kludge
-    my $expenses_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 cust_bill._date >= $speriod AND cust_bill._date < $eperiod AND cust_pkg.pkgnum = cust_bill_pkg.pkgnum AND cust_pkg.pkgpart = part_pkg.pkgpart AND LOWER(part_pkg.pkg) LIKE 'expense _%'";
-    my $expenses_sth = dbh->prepare($expenses_sql) or die dbh->errstr;
-    $expenses_sth->execute or die $expenses_sth->errstr;
-    my $expenses = $expenses_sth->fetchrow_arrayref->[0] || 0;
-
-  push @{$data{ar}}, $charged-$credited-$expenses;
-
-  #deferred revenue
-#  push @{$data{defer}}, '0';
-
-  #cashflow
-  my $paid_sql = "SELECT SUM(paid) FROM cust_pay $where";
-  my $paid_sth = dbh->prepare($paid_sql) or die dbh->errstr;
-  $paid_sth->execute or die $paid_sth->errstr;
-  my $paid = $paid_sth->fetchrow_arrayref->[0] || 0;
-
-  my $refunded_sql = "SELECT SUM(refund) FROM cust_refund $where";
-  my $refunded_sth = dbh->prepare($refunded_sql) or die dbh->errstr;
-  $refunded_sth->execute or die $refunded_sth->errstr;
-  my $refunded = $refunded_sth->fetchrow_arrayref->[0] || 0;
-
-    #horrible local kludge that doesn't even really work right
-    my $expenses_sql2 = "SELECT SUM(cust_bill_pay.amount) FROM cust_bill_pay, cust_bill WHERE cust_bill_pay.invnum = cust_bill.invnum AND cust_bill_pay._date >= $speriod AND cust_bill_pay._date < $eperiod 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 _%'";
-    my $expenses_sth2 = dbh->prepare($expenses_sql2) or die dbh->errstr;
-    $expenses_sth2->execute or die $expenses_sth2->errstr;
-    my $expenses2 = $expenses_sth2->fetchrow_arrayref->[0] || 0;
-
-  push @{$data{cash}}, $paid-$refunded-$expenses2;
+my @items = qw( invoiced netsales credits receipts );
+my %label = (
+ 'invoiced' => 'Gross Sales (invoiced)', 
+ 'netsales' => 'Net Sales (invoiced - applied credits)',
+ 'credits'  => 'Credits',
+ 'receipts' => 'Receipts/Cashflow (payments - refunds)',
+);
+my %color = (
+  'invoiced' => [ 153, 153, 255 ], #light blue
+  'netsales' => [   0,   0, 204 ], #blue
+  'credits'  => [ 204,   0,   0 ], #red
+  'receipts' => [   0, 204,   0 ], #green
+);
 
-}
+my $report = new FS::Report::Table::Monthly (
+  'items' => \@items,
+  'start_month' => $smonth,
+  'start_year'  => $syear,
+  'end_month'   => $emonth,
+  'end_year'    => $eyear,
+);
+my %data = %{$report->data};
 
 #my $chart = Chart::LinesPoints->new(1024,480);
-my $chart = Chart::LinesPoints->new(768,480);
+#my $chart = Chart::LinesPoints->new(768,480);
+my $chart = Chart::LinesPoints->new(976,384);
 
+my $d = 0;
 $chart->set(
   #'min_val' => 0,
   'legend' => 'bottom',
-  'legend_labels' => [ #'Invoiced (cust_bill)',
-                       'Accounts receivable (invoices - applied credits)',
-                       #'Deferred revenue',
-                       'Actual cashflow (payments - refunds)' ],
+  'colors' => { ( map { 'dataset'.$d++ => $color{$_} } @items ),
+                #'grey_background' => [ 211, 211, 211 ],
+                'grey_background' => 'white',
+                'background' => [ 0xe8, 0xe8, 0xe8 ], #grey
+              },
+  #'grey_background' => 'false',
+  'legend_labels' => [ map { $label{$_} } @items ],
+  'brush_size' => 4,
+  #'pt_size' => 12,
 );
 
-my @data = ( \@labels,
-             #map $data{$_}, qw( ar defer cash )
-             #map $data{$_}, qw( charged ar cash )
-             map $data{$_}, qw( ar cash )
-           );
-
-#my $gd = $chart->plot(\@data);
-#open (IMG, ">i_r_c.png");
-#print IMG $gd->png;
-#close IMG;
-
-#$chart->png("i_r_c.png", \@data);
-
-#$chart->cgi_png(\@data);
+my @data = map { $data{$_} } ( 'label', @items );
 
 http_header('Content-Type' => 'image/png' );
-#$Response->{ContentType} = 'image/png';
 
 $chart->_set_colors();
 
diff --git a/httemplate/graph/money_time.cgi b/httemplate/graph/money_time.cgi
index de8f6ee0c..14af0f246 100644
--- a/httemplate/graph/money_time.cgi
+++ b/httemplate/graph/money_time.cgi
@@ -19,9 +19,63 @@ my $emonth = $cgi->param('emonth') || $curmon+1;
     <TITLE>Graphing monetary values over time</TITLE>
   </HEAD>
 <BODY BGCOLOR="#e8e8e8">
-<IMG SRC="money_time-graph.cgi?<%= $cgi->query_string %>" WIDTH="768" HEIGHT="480">
+<IMG SRC="money_time-graph.cgi?<%= $cgi->query_string %>" WIDTH="976" HEIGHT="384">
+<BR>
+
+<%= table('e8e8e8') %>
+<%
+
+my @items = qw( invoiced netsales credits receipts );
+my %label = (
+  'invoiced' => 'Gross Sales',
+  'netsales' => 'Net Sales',
+  'credits'  => 'Credits',
+  'receipts' => 'Receipts',
+);
+my %color = (
+  'invoiced' => '9999ff', #light blue
+  'netsales' => '0000cc', #blue
+  'credits'  => 'cc0000', #red
+  'receipts' => '00cc00', #green
+);
+
+my $report = new FS::Report::Table::Monthly (
+  'items' => \@items,
+  'start_month' => $smonth,
+  'start_year'  => $syear,
+  'end_month'   => $emonth,
+  'end_year'    => $eyear,
+);
+my $data = $report->data;
+
+
+my @mon = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec);
+
+%>
+
+<TR><TD></TD>
+<% foreach my $column ( @{$data->{label}} ) {
+     #$column =~ s/^(\d+)\//$mon[$1-1]<BR>/e;
+     $column =~ s/^(\d+)\//$mon[$1-1]<BR>/;
+     %>
+     <TH><%= $column %></TH>
+<% } %>
+</TR>
+
+<% foreach my $row (@items) { %>
+  <TR><TH><FONT COLOR="#<%= $color{$row} %>"><%= $label{$row} %></FONT></TH>
+  <% foreach my $column ( @{$data->{$row}} ) { %>
+    <TD ALIGN="right" BGCOLOR="#ffffff">
+      <FONT COLOR="#<%= $color{$row} %>">$<%= sprintf("%.2f", $column) %></FONT>
+    </TD>
+  <% } %>
+  </TR>
+<% } %>
+</TABLE>
+
 <BR>
 <FORM METHOD="POST">
+<!--
 <INPUT TYPE="checkbox" NAME="ar">
   Accounts receivable (invoices - applied credits)<BR>
 <INPUT TYPE="checkbox" NAME="charged">
@@ -31,8 +85,8 @@ my $emonth = $cgi->param('emonth') || $curmon+1;
 <INPUT TYPE="checkbox" NAME="cash">
   Cashflow (payments - refunds)<BR>
 <BR>
+-->
 From <SELECT NAME="smonth">
-<% my @mon = qw(Jan Feb Mar Apr May Jun Jul Aug Sep Oct Nov Dec); %>
 <% foreach my $mon ( 1..12 ) { %>
 <OPTION VALUE="<%= $mon %>"<%= $mon == $smonth ? ' SELECTED' : '' %>><%= $mon[$mon-1] %>
 <% } %>
@@ -53,7 +107,7 @@ From <SELECT NAME="smonth">
 <% } %>
 </SELECT>
 
-<INPUT TYPE="submit" VALUE="Graph">
+<INPUT TYPE="submit" VALUE="Redisplay">
 </FORM>
 </BODY>
 </HTML>