httemplate/graph/cust_bill_pkg.cgi

   1 <% include('elements/monthly.html',
   2    #Dumper(
   3                 'title'        => $title,
   4                 'graph_type'   => 'Mountain',
   5                 'items'        => \@items,
   6                 'params'       => \@params,
   7                 'labels'       => \@labels,
   8                 'graph_labels' => \@labels,
   9                 'colors'       => \@colors,
  10                 'links'        => \@links,
  11                 'no_graph'     => \@no_graph,
  12                 'remove_empty' => 1,
  13                 'bottom_total' => 1,
  14                 'bottom_link'  => $bottom_link,
  15                 'agentnum'     => $agentnum,
  16                 'cust_classnum'=> \@cust_classnums,
  17              )
  18 %>
  19 <%init>
  20
  21 die "access denied"
  22   unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
  23
  24 my $link = "${p}search/cust_bill_pkg.cgi?nottax=1";
  25 my $bottom_link = "$link;";
  26
  27 my $use_usage = $cgi->param('use_usage') || 0;
  28 my $use_setup = $cgi->param('use_setup') || 0;
  29 my $use_override         = $cgi->param('use_override')         ? 1 : 0;
  30 my $average_per_cust_pkg = $cgi->param('average_per_cust_pkg') ? 1 : 0;
  31 my $distribute           = $cgi->param('distribute')           ? 1 : 0;
  32
  33 my %charge_labels = (
  34   'SR' => 'setup + recurring',
  35   'RU' => 'recurring',
  36   'S'  => 'setup',
  37   'R'  => 'recurring',
  38   'U'  => 'usage',
  39 );
  40
  41 #XXX or virtual
  42 my( $agentnum, $sel_agent, $all_agent ) = ('', '', '');
  43 if ( $cgi->param('agentnum') eq 'all' ) {
  44   $agentnum = 0;
  45   $all_agent = 'ALL';
  46 }
  47 elsif ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
  48   $agentnum = $1;
  49   $bottom_link .= "agentnum=$agentnum;";
  50   $sel_agent = qsearchs('agent', { 'agentnum' => $agentnum } );
  51   die "agentnum $agentnum not found!" unless $sel_agent;
  52 }
  53 my $title = $sel_agent ? $sel_agent->agent.' ' : '';
  54
  55 my( $refnum, $sel_part_referral, $all_part_referral ) = ('', '', '');
  56 if ( $cgi->param('refnum') eq 'all' ) {
  57   $refnum = 0;
  58   $all_part_referral = 'ALL';
  59 }
  60 elsif ( $cgi->param('refnum') =~ /^(\d+)$/ ) {
  61   $refnum = $1;
  62   $bottom_link .= "refnum=$refnum;";
  63   $sel_part_referral = qsearchs('part_referral', { 'refnum' => $refnum } );
  64   die "part_referral $refnum not found!" unless $sel_part_referral;
  65 }
  66 $title .= $sel_part_referral->referral.' '
  67   if $sel_part_referral;
  68
  69 $title .= 'Sales Report (Gross)';
  70 $title .= ', average per customer package'  if $average_per_cust_pkg;
  71
  72 my @cust_classnums = grep /^\d+$/, $cgi->param('cust_classnum');
  73 $bottom_link .= "cust_classnum=$_;" foreach @cust_classnums;
  74
  75 #classnum (here)
  76 # 0: all classes
  77 # not specified: empty class
  78 # N: classnum
  79 #classnum (link)
  80 # not specified: all classes
  81 # 0: empty class
  82 # N: classnum
  83
  84 #false lazinessish w/FS::cust_pkg::search_sql (previously search/cust_pkg.cgi)
  85 my $classnum = 0;
  86 my (@classnums, @classnames);
  87 my $all_class = '';
  88
  89 my ($class_table, $name_col, $value_col, $class_param);
  90
  91 if ( $cgi->param('mode') eq 'report' ) {
  92   $class_param = 'report_optionnum'; # CGI param name, also used in the report engine
  93   $class_table = 'part_pkg_report_option'; # table containing classes
  94   $name_col = 'name'; # the column of that table containing the label
  95   $value_col = 'num'; # the column containing the class number
  96 } else {
  97   $class_param = 'classnum';
  98   $class_table = 'pkg_class';
  99   $name_col = 'classname';
 100   $value_col = 'classnum';
 101 }
 102
 103 if ( $cgi->param($class_param) eq 'all' ) { # all, aggregated
 104   $all_class = 'ALL';
 105   @classnums = ('');
 106   @classnames = ('');
 107 } elsif ( $cgi->param($class_param) =~ /^(\d*)$/ ) {
 108
 109   $classnum = $1;
 110   if ( $classnum ) { #a specific class
 111     my $class = qsearchs($class_table, { $value_col => $classnum })
 112       or die "$class_table #$classnum not found";
 113
 114     $title .= ' '.$class->get($name_col);
 115     $bottom_link .= "$class_param=$classnum;";
 116
 117     @classnums = ($classnum);
 118     @classnames = ($class->get($name_col));
 119
 120   } elsif ( $classnum eq '0' ) { #the empty class
 121
 122     $title .= ' Empty class ';
 123     @classnums = ( '' );
 124     @classnames = ( '(empty class)' );
 125     $bottom_link .= "$class_param=0;";
 126
 127   } elsif ( $classnum eq '' ) { #all, breakdown
 128
 129     my @classes = qsearch($class_table, {});
 130     @classnames = map { $_->get($name_col) } @classes;
 131     @classnums  = map { $_->get($value_col) } @classes;
 132
 133     push @classnames, '(empty class)';
 134     push @classnums, '0';
 135
 136     if ( $cgi->param('mode') eq 'report' ) {
 137       # In theory, a package can belong to any subset of the report classes,
 138       # so the report groups should be all the _subsets_, but for now we're
 139       # handling the simple case where each package belongs to one report
 140       # class. Packages with multiple classes will go into one bin at the
 141       # end.
 142       push @classnames, '(multiple classes)';
 143       push @classnums, 'multiple';
 144     }
 145   }
 146 } #eslaf
 147
 148 my $hue = 0;
 149 #my $hue_increment = 170;
 150 #my $hue_increment = 145;
 151 my $hue_increment = 125;
 152
 153 my @items  = ();
 154 my @params = ();
 155 my @labels = ();
 156 my @colors = ();
 157 my @links  = ();
 158 my @no_graph;
 159
 160 my @components = ( 'SRU' );
 161 # split/omit components as appropriate
 162 if ( $use_setup == 1 ) {
 163   @components = ( 'S', 'RU' );
 164 }
 165 elsif ( $use_setup == 2 ) {
 166   @components = ( 'RU' );
 167 }
 168 if ( $use_usage == 1 ) {
 169   $components[-1] =~ s/U//; push @components, 'U';
 170 }
 171 elsif ( $use_usage == 2 ) {
 172   $components[-1] =~ s/U//;
 173 }
 174
 175 # Categorization of line items goes
 176 # Agent -> Referral -> Package class -> Component (setup/recur/usage)
 177 # If per-agent totals are enabled, they go under the Agent level.
 178 # There aren't any other kinds of subtotals.
 179
 180 foreach my $agent ( $all_agent || $sel_agent || qsearch('agent', { 'disabled' => '' } ) ) {
 181
 182   my $col_scheme = Color::Scheme->new
 183                      ->from_hue($hue) #->from_hex($agent->color)
 184                      ->scheme('analogic')
 185                    ;
 186   my @recur_colors = ();
 187   my @onetime_colors = ();
 188
 189   ### fixup the color handling for package classes...
 190   ### and usage
 191
 192   foreach my $part_referral (
 193     $all_part_referral ||
 194     $sel_part_referral ||
 195     qsearch('part_referral', { 'disabled' => '' } )
 196   ) {
 197
 198     for (my $i = 0; $i < scalar @classnums; $i++) {
 199       my $row_classnum = $classnums[$i];
 200       my $row_classname = $classnames[$i];
 201       foreach my $component ( @components ) {
 202
 203         push @items, 'cust_bill_pkg';
 204
 205         push @labels,
 206           ( $all_agent || $sel_agent ? '' : $agent->agent.' ' ).
 207           ( $all_part_referral || $sel_part_referral ? '' : $part_referral->referral.' ' ).
 208           $row_classname .  ' ' . $charge_labels{$component};
 209
 210         my $row_agentnum = $all_agent || $agent->agentnum;
 211         my $row_refnum = $all_part_referral || $part_referral->refnum;
 212         push @params, [ ($all_class ? () : ($class_param => $row_classnum) ),
 213                         ($all_agent ? () : ('agentnum' => $row_agentnum) ),
 214                         ($all_part_referral ? () : ('refnum' => $row_refnum) ),
 215                         'use_override'         => $use_override,
 216                         'charges'              => $component,
 217                         'average_per_cust_pkg' => $average_per_cust_pkg,
 218                         'distribute'           => $distribute,
 219                       ];
 220
 221         push @links, "$link;".
 222                      ($all_agent ? '' : "agentnum=$row_agentnum;").
 223                      ($all_part_referral ? '' : "refnum=$row_refnum;").
 224                      (join('',map {"cust_classnum=$_;"} @cust_classnums)).
 225                      ($all_class ? '' : "$class_param=$row_classnum;").
 226                      "distribute=$distribute;".
 227                      "use_override=$use_override;charges=$component;";
 228
 229         @recur_colors = ($col_scheme->colors)[0,4,8,1,5,9]
 230           unless @recur_colors;
 231         @onetime_colors = ($col_scheme->colors)[2,6,10,3,7,11]
 232           unless @onetime_colors;
 233         push @colors, shift @recur_colors;
 234         push @no_graph, 0;
 235
 236       } #foreach $component
 237     } #foreach $row_classnum
 238   } #foreach $part_referral
 239
 240   if ( $cgi->param('agent_totals') and !$all_agent ) {
 241     my $row_agentnum = $agent->agentnum;
 242     # Include all components that are anywhere on this report
 243     my $component = join('', @components);
 244
 245     my @row_params = (  'agentnum'              => $row_agentnum,
 246                         'cust_classnum'         => \@cust_classnums,
 247                         'use_override'          => $use_override,
 248                         'average_per_cust_pkg'  => $average_per_cust_pkg,
 249                         'distribute'            => $distribute,
 250                         'charges'               => $component,
 251                      );
 252     my $row_link = "$link;".
 253                    "agentnum=$row_agentnum;".
 254                    "distribute=$distribute;".
 255                    "charges=$component";
 256
 257     # Also apply any refnum/classnum filters
 258     if ( !$all_class and scalar(@classnums) == 1 ) {
 259       # then a specific class has been chosen, but it may be the empty class
 260       push @row_params, $class_param => $classnums[0];
 261       $row_link .= ";$class_param=".$classnums[0];
 262     }
 263     if ( $sel_part_referral ) {
 264       push @row_params, 'refnum' => $sel_part_referral->refnum;
 265       $row_link .= ";refnum=".$sel_part_referral->refnum;
 266     }
 267
 268     $row_link .= ";cust_classnum=$_" foreach @cust_classnums;
 269
 270     push @items, 'cust_bill_pkg';
 271     push @labels, mt('[_1] - Subtotal', $agent->agent);
 272     push @params, \@row_params;
 273     push @links, $row_link;
 274     push @colors, '000000'; # better idea?
 275     push @no_graph, 1;
 276   }
 277
 278   $hue += $hue_increment;
 279
 280 }
 281
 282 #use Data::Dumper;
 283 if ( $cgi->param('debug') == 1 ) {
 284   $FS::Report::Table::DEBUG = 1;
 285 }
 286 </%init>