select multiple package classes (or report classes) on sales report, RT#24776
[freeside.git] / httemplate / graph / cust_bill_pkg.cgi
index e7a3bd2..01d309d 100644 (file)
@@ -8,10 +8,12 @@
                 'graph_labels' => \@labels,
                 'colors'       => \@colors,
                 'links'        => \@links,
+                'no_graph'     => \@no_graph,
                 'remove_empty' => 1,
                 'bottom_total' => 1,
                 'bottom_link'  => $bottom_link,
                 'agentnum'     => $agentnum,
+                'cust_classnum'=> \@cust_classnums,
              )
 %>
 <%init>
@@ -67,45 +69,70 @@ $title .= $sel_part_referral->referral.' '
 $title .= 'Sales Report (Gross)';
 $title .= ', average per customer package'  if $average_per_cust_pkg;
 
+my @cust_classnums = grep /^\d+$/, $cgi->param('cust_classnum');
+$bottom_link .= "cust_classnum=$_;" foreach @cust_classnums;
+
 #classnum (here)
-# 0: all classes
-# not specified: empty class
+# not specified: no longer happens (unless you de-select all classes)
+# 0: empty class
 # N: classnum
 #classnum (link)
 # not specified: all classes
 # 0: empty class
 # N: classnum
 
-#false lazinessish w/FS::cust_pkg::search_sql (previously search/cust_pkg.cgi)
-my $classnum = 0;
-my @pkg_class = ();
-my $all_class = '';
-if ( $cgi->param('classnum') eq 'all' ) {
-  $all_class = 'ALL';
-  @pkg_class = ('');
+#started out as false lazinessish w/FS::cust_pkg::search_sql (previously search/cust_pkg.cgi), but not much left the sane now after #24776
+
+my ($class_table, $name_col, $value_col, $class_param);
+
+if ( $cgi->param('class_mode') eq 'report' ) {
+  $class_param = 'report_optionnum'; # CGI param name, also used in the report engine
+  $class_table = 'part_pkg_report_option'; # table containing classes
+  $name_col = 'name'; # the column of that table containing the label
+  $value_col = 'num'; # the column containing the class number
+} else {
+  $class_param = 'classnum';
+  $class_table = 'pkg_class';
+  $name_col = 'classname';
+  $value_col = 'classnum';
 }
-elsif ( $cgi->param('classnum') =~ /^(\d*)$/ ) {
-  $classnum = $1;
-  if ( $classnum ) { #a specific class
 
-    @pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
-    die "classnum $classnum not found!" unless $pkg_class[0];
-    $title .= ' '.$pkg_class[0]->classname.' ';
-    $bottom_link .= "classnum=$classnum;";
+my @classnums = grep /^\d+$/, $cgi->param($value_col);
+my @classnames = map { if ( $_ ) {
+                         my $class = qsearchs($class_table, {$value_col=>$_} );
+                         $class->classname;
+                       } else {
+                         '(empty class)';
+                       }
+                     }
+                   @classnums;
+
+$bottom_link .= "$class_param=$_;" foreach @classnums;
 
-  } elsif ( $classnum eq '' ) { #the empty class
+if ( $cgi->param('class_agg_break') eq 'aggregate' ) {
 
-    $title .= 'Empty class ';
-    @pkg_class = ( '(empty class)' );
-    $bottom_link .= "classnum=0;";
+  $link .= ";$class_param=$_" foreach @classnums;
 
-  } elsif ( $classnum eq '0' ) { #all classes
+  $title .= ' '. join(', ', @classnames)
+    unless scalar(@classnames) > scalar(qsearch($class_table,{'disabled'=>''}));
+                                 #not efficient for lots of package classes
 
-    @pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
-    push @pkg_class, '(empty class)';
+} elsif ( $cgi->param('class_agg_break') eq 'breakdown' ) {
 
+  if ( $cgi->param('mode') eq 'report' ) {
+    # In theory, a package can belong to any subset of the report classes,
+    # so the report groups should be all the _subsets_, but for now we're
+    # handling the simple case where each package belongs to one report
+    # class. Packages with multiple classes will go into one bin at the
+    # end.
+    push @classnames, '(multiple classes)';
+    push @classnums, 'multiple';
   }
+
+} else {
+  die "guru meditation #434";
 }
+
 #eslaf
 
 my $hue = 0;
@@ -118,6 +145,7 @@ my @params = ();
 my @labels = ();
 my @colors = ();
 my @links  = ();
+my @no_graph;
 
 my @components = ( 'SRU' );
 # split/omit components as appropriate
@@ -134,6 +162,11 @@ elsif ( $use_usage == 2 ) {
   $components[-1] =~ s/U//;
 }
 
+# Categorization of line items goes
+# Agent -> Referral -> Package class -> Component (setup/recur/usage)
+# If per-agent totals are enabled, they go under the Agent level.
+# There aren't any other kinds of subtotals.
+
 foreach my $agent ( $all_agent || $sel_agent || qsearch('agent', { 'disabled' => '' } ) ) {
 
   my $col_scheme = Color::Scheme->new
@@ -146,9 +179,20 @@ foreach my $agent ( $all_agent || $sel_agent || qsearch('agent', { 'disabled' =>
   ### fixup the color handling for package classes...
   ### and usage
 
-  foreach my $part_referral ( $all_part_referral || $sel_part_referral || qsearch('part_referral', { 'disabled' => '' } ) ) {
+  foreach my $part_referral (
+    $all_part_referral ||
+    $sel_part_referral ||
+    qsearch('part_referral', { 'disabled' => '' } ) 
+  ) {
+
+    my @base_params = (
+                        'use_override'         => $use_override,
+                        'average_per_cust_pkg' => $average_per_cust_pkg,
+                        'distribute'           => $distribute,
+                      );
+
+    if ( $cgi->param('class_agg_break') eq 'aggregate' ) {
 
-    foreach my $pkg_class ( @pkg_class ) {
       foreach my $component ( @components ) {
 
         push @items, 'cust_bill_pkg';
@@ -156,39 +200,120 @@ foreach my $agent ( $all_agent || $sel_agent || qsearch('agent', { 'disabled' =>
         push @labels,
           ( $all_agent || $sel_agent ? '' : $agent->agent.' ' ).
           ( $all_part_referral || $sel_part_referral ? '' : $part_referral->referral.' ' ).
-          ( $classnum eq '0'
-              ? ( ref($pkg_class) ? $pkg_class->classname : $pkg_class ) 
-              : ''
-          ).
-          ' '.$charge_labels{$component};
+          $charge_labels{$component};
 
-        my $row_classnum = ref($pkg_class) ? $pkg_class->classnum : 0;
         my $row_agentnum = $all_agent || $agent->agentnum;
         my $row_refnum = $all_part_referral || $part_referral->refnum;
-        push @params, [ ($all_class ? () : ('classnum' => $row_classnum) ),
+        push @params, [
+                        @base_params,
+                        $class_param => \@classnums,
                         ($all_agent ? () : ('agentnum' => $row_agentnum) ),
                         ($all_part_referral ? () : ('refnum' => $row_refnum) ),
-                        'use_override'         => $use_override,
                         'charges'              => $component,
-                        'average_per_cust_pkg' => $average_per_cust_pkg,
-                        'distribute'           => $distribute,
                       ];
 
-        push @links, "$link;".
-                     ($all_agent ? '' : "agentnum=$row_agentnum;").
-                     ($all_part_referral ? '' : "refnum=$row_refnum;").
-                     ($all_class ? '' : "classnum=$row_classnum;").
-                     "distribute=$distribute;".
-                     "use_override=$use_override;charges=$component;";
+        my $rowlink = "$link;".
+                      ($all_agent ? '' : "agentnum=$row_agentnum;").
+                      ($all_part_referral ? '' : "refnum=$row_refnum;").
+                      (join('',map {"cust_classnum=$_;"} @cust_classnums)).
+                      "distribute=$distribute;".
+                      "use_override=$use_override;charges=$component;";
+        $rowlink .= "$class_param=$_;" foreach @classnums;
+        push @links, $rowlink;
 
         @recur_colors = ($col_scheme->colors)[0,4,8,1,5,9]
           unless @recur_colors;
         @onetime_colors = ($col_scheme->colors)[2,6,10,3,7,11]
           unless @onetime_colors;
         push @colors, shift @recur_colors;
+        push @no_graph, 0;
+
+      } #foreach $component
+
+    } elsif ( $cgi->param('class_agg_break') eq 'breakdown' ) {
+
+      for (my $i = 0; $i < scalar @classnums; $i++) {
+        my $row_classnum = $classnums[$i];
+        my $row_classname = $classnames[$i];
+        foreach my $component ( @components ) {
+
+          push @items, 'cust_bill_pkg';
+
+          push @labels,
+            ( $all_agent || $sel_agent ? '' : $agent->agent.' ' ).
+            ( $all_part_referral || $sel_part_referral ? '' : $part_referral->referral.' ' ).
+            $row_classname .  ' ' . $charge_labels{$component};
+
+          my $row_agentnum = $all_agent || $agent->agentnum;
+          my $row_refnum = $all_part_referral || $part_referral->refnum;
+          push @params, [
+                          @base_params,
+                          $class_param => $row_classnum,
+                          ($all_agent ? () : ('agentnum' => $row_agentnum) ),
+                          ($all_part_referral ? () : ('refnum' => $row_refnum)),
+                          'charges'              => $component,
+                        ];
+
+          push @links, "$link;".
+                       ($all_agent ? '' : "agentnum=$row_agentnum;").
+                       ($all_part_referral ? '' : "refnum=$row_refnum;").
+                       (join('',map {"cust_classnum=$_;"} @cust_classnums)).
+                       "$class_param=$row_classnum;".
+                       "distribute=$distribute;".
+                       "use_override=$use_override;charges=$component;";
+
+          @recur_colors = ($col_scheme->colors)[0,4,8,1,5,9]
+            unless @recur_colors;
+          @onetime_colors = ($col_scheme->colors)[2,6,10,3,7,11]
+            unless @onetime_colors;
+          push @colors, shift @recur_colors;
+          push @no_graph, 0;
+
+        } #foreach $component
+      } #foreach $row_classnum
+
+    } #$cgi->param('class_agg_break')
+
+  } #foreach $part_referral
+
+  if ( $cgi->param('agent_totals') and !$all_agent ) {
+    my $row_agentnum = $agent->agentnum;
+    # Include all components that are anywhere on this report
+    my $component = join('', @components);
+
+    my @row_params = (  'agentnum'              => $row_agentnum,
+                        'cust_classnum'         => \@cust_classnums,
+                        'use_override'          => $use_override,
+                        'average_per_cust_pkg'  => $average_per_cust_pkg,
+                        'distribute'            => $distribute,
+                        'charges'               => $component,
+                     );
+    my $row_link = "$link;".
+                   "agentnum=$row_agentnum;".
+                   "distribute=$distribute;".
+                   "charges=$component";
+    
+    # package class filters
+    if ( $cgi->param('class_agg_break') eq 'aggregate' ) {
+      push @row_params, $class_param => \@classnums;
+      $row_link .= ";$class_param=".$_ foreach @classnums;
+    }
 
-      }
+    # refnum filters
+    if ( $sel_part_referral ) {
+      push @row_params, 'refnum' => $sel_part_referral->refnum;
+      $row_link .= ";refnum=".$sel_part_referral->refnum;
     }
+
+    # customer class filters
+    $row_link .= ";cust_classnum=$_" foreach @cust_classnums;
+
+    push @items, 'cust_bill_pkg';
+    push @labels, mt('[_1] - Subtotal', $agent->agent);
+    push @params, \@row_params;
+    push @links, $row_link;
+    push @colors, '000000'; # better idea?
+    push @no_graph, 1;
   }
 
   $hue += $hue_increment;