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 # not specified: no longer happens (unless you de-select all classes)
  77 # 0: empty class
  78 # N: classnum
  79 #classnum (link)
  80 # not specified: all classes
  81 # 0: empty class
  82 # N: classnum
  83
  84 #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
  85
  86 my ($class_table, $name_col, $value_col, $class_param);
  87
  88 if ( $cgi->param('class_mode') eq 'report' ) {
  89   $class_param = 'report_optionnum'; # CGI param name, also used in the report engine
  90   $class_table = 'part_pkg_report_option'; # table containing classes
  91   $name_col = 'name'; # the column of that table containing the label
  92   $value_col = 'num'; # the column containing the class number
  93 } else {
  94   $class_param = 'classnum';
  95   $class_table = 'pkg_class';
  96   $name_col = 'classname';
  97   $value_col = 'classnum';
  98 }
  99
 100 my @classnums = grep /^\d+$/, $cgi->param($class_param);
 101 my @classnames = map { if ( $_ ) {
 102                          my $class = qsearchs($class_table, {$value_col=>$_} );
 103                          $class->$name_col;
 104                        } else {
 105                          '(empty class)';
 106                        }
 107                      }
 108                    @classnums;
 109
 110 $bottom_link .= "$class_param=$_;" foreach @classnums;
 111
 112 if ( $cgi->param('class_agg_break') eq 'aggregate' ) {
 113
 114   $title .= ' '. join(', ', @classnames)
 115     unless scalar(@classnames) > scalar(qsearch($class_table,{'disabled'=>''}));
 116                                  #not efficient for lots of package classes
 117
 118 } elsif ( $cgi->param('class_agg_break') eq 'breakdown' ) {
 119
 120   if ( $cgi->param('mode') eq 'report' ) {
 121     # In theory, a package can belong to any subset of the report classes,
 122     # so the report groups should be all the _subsets_, but for now we're
 123     # handling the simple case where each package belongs to one report
 124     # class. Packages with multiple classes will go into one bin at the
 125     # end.
 126     push @classnames, '(multiple classes)';
 127     push @classnums, 'multiple';
 128   }
 129
 130 } else {
 131   die "guru meditation #434";
 132 }
 133
 134 #eslaf
 135
 136 my $hue = 0;
 137 #my $hue_increment = 170;
 138 #my $hue_increment = 145;
 139 my $hue_increment = 125;
 140
 141 my @items  = ();
 142 my @params = ();
 143 my @labels = ();
 144 my @colors = ();
 145 my @links  = ();
 146 my @no_graph;
 147
 148 my @components = ( 'SRU' );
 149 # split/omit components as appropriate
 150 if ( $use_setup == 1 ) {
 151   @components = ( 'S', 'RU' );
 152 }
 153 elsif ( $use_setup == 2 ) {
 154   @components = ( 'RU' );
 155 }
 156 if ( $use_usage == 1 ) {
 157   $components[-1] =~ s/U//; push @components, 'U';
 158 }
 159 elsif ( $use_usage == 2 ) {
 160   $components[-1] =~ s/U//;
 161 }
 162
 163 # Categorization of line items goes
 164 # Agent -> Referral -> Package class -> Component (setup/recur/usage)
 165 # If per-agent totals are enabled, they go under the Agent level.
 166 # There aren't any other kinds of subtotals.
 167
 168 foreach my $agent ( $all_agent || $sel_agent || qsearch('agent', { 'disabled' => '' } ) ) {
 169
 170   my $col_scheme = Color::Scheme->new
 171                      ->from_hue($hue) #->from_hex($agent->color)
 172                      ->scheme('analogic')
 173                    ;
 174   my @recur_colors = ();
 175   my @onetime_colors = ();
 176
 177   ### fixup the color handling for package classes...
 178   ### and usage
 179
 180   foreach my $part_referral (
 181     $all_part_referral ||
 182     $sel_part_referral ||
 183     qsearch('part_referral', { 'disabled' => '' } )
 184   ) {
 185
 186     my @base_params = (
 187                         'use_override'         => $use_override,
 188                         'average_per_cust_pkg' => $average_per_cust_pkg,
 189                         'distribute'           => $distribute,
 190                       );
 191
 192     if ( $cgi->param('class_agg_break') eq 'aggregate' ) {
 193
 194       foreach my $component ( @components ) {
 195
 196         push @items, 'cust_bill_pkg';
 197
 198         push @labels,
 199           ( $all_agent || $sel_agent ? '' : $agent->agent.' ' ).
 200           ( $all_part_referral || $sel_part_referral ? '' : $part_referral->referral.' ' ).
 201           $charge_labels{$component};
 202
 203         my $row_agentnum = $all_agent || $agent->agentnum;
 204         my $row_refnum = $all_part_referral || $part_referral->refnum;
 205         push @params, [
 206                         @base_params,
 207                         $class_param => \@classnums,
 208                         ($all_agent ? () : ('agentnum' => $row_agentnum) ),
 209                         ($all_part_referral ? () : ('refnum' => $row_refnum) ),
 210                         'charges'              => $component,
 211                       ];
 212
 213         my $rowlink = "$link;".
 214                       ($all_agent ? '' : "agentnum=$row_agentnum;").
 215                       ($all_part_referral ? '' : "refnum=$row_refnum;").
 216                       (join('',map {"cust_classnum=$_;"} @cust_classnums)).
 217                       "distribute=$distribute;".
 218                       "use_override=$use_override;charges=$component;";
 219         $rowlink .= "$class_param=$_;" foreach @classnums;
 220         push @links, $rowlink;
 221
 222         @recur_colors = ($col_scheme->colors)[0,4,8,1,5,9]
 223           unless @recur_colors;
 224         @onetime_colors = ($col_scheme->colors)[2,6,10,3,7,11]
 225           unless @onetime_colors;
 226         push @colors, shift @recur_colors;
 227         push @no_graph, 0;
 228
 229       } #foreach $component
 230
 231     } elsif ( $cgi->param('class_agg_break') eq 'breakdown' ) {
 232
 233       for (my $i = 0; $i < scalar @classnums; $i++) {
 234         my $row_classnum = $classnums[$i];
 235         my $row_classname = $classnames[$i];
 236         foreach my $component ( @components ) {
 237
 238           push @items, 'cust_bill_pkg';
 239
 240           push @labels,
 241             ( $all_agent || $sel_agent ? '' : $agent->agent.' ' ).
 242             ( $all_part_referral || $sel_part_referral ? '' : $part_referral->referral.' ' ).
 243             $row_classname .  ' ' . $charge_labels{$component};
 244
 245           my $row_agentnum = $all_agent || $agent->agentnum;
 246           my $row_refnum = $all_part_referral || $part_referral->refnum;
 247           push @params, [
 248                           @base_params,
 249                           $class_param => $row_classnum,
 250                           ($all_agent ? () : ('agentnum' => $row_agentnum) ),
 251                           ($all_part_referral ? () : ('refnum' => $row_refnum)),
 252                           'charges'              => $component,
 253                         ];
 254
 255           push @links, "$link;".
 256                        ($all_agent ? '' : "agentnum=$row_agentnum;").
 257                        ($all_part_referral ? '' : "refnum=$row_refnum;").
 258                        (join('',map {"cust_classnum=$_;"} @cust_classnums)).
 259                        "$class_param=$row_classnum;".
 260                        "distribute=$distribute;".
 261                        "use_override=$use_override;charges=$component;";
 262
 263           @recur_colors = ($col_scheme->colors)[0,4,8,1,5,9]
 264             unless @recur_colors;
 265           @onetime_colors = ($col_scheme->colors)[2,6,10,3,7,11]
 266             unless @onetime_colors;
 267           push @colors, shift @recur_colors;
 268           push @no_graph, 0;
 269
 270         } #foreach $component
 271       } #foreach $row_classnum
 272
 273     } #$cgi->param('class_agg_break')
 274
 275   } #foreach $part_referral
 276
 277   if ( $cgi->param('agent_totals') and !$all_agent ) {
 278     my $row_agentnum = $agent->agentnum;
 279     # Include all components that are anywhere on this report
 280     my $component = join('', @components);
 281
 282     my @row_params = (  'agentnum'              => $row_agentnum,
 283                         'cust_classnum'         => \@cust_classnums,
 284                         'use_override'          => $use_override,
 285                         'average_per_cust_pkg'  => $average_per_cust_pkg,
 286                         'distribute'            => $distribute,
 287                         'charges'               => $component,
 288                      );
 289     my $row_link = "$link;".
 290                    "agentnum=$row_agentnum;".
 291                    "distribute=$distribute;".
 292                    "charges=$component;";
 293
 294     # package class filters
 295     if ( $cgi->param('class_agg_break') eq 'aggregate' ) {
 296       push @row_params, $class_param => \@classnums;
 297       $row_link .= "$class_param=$_;" foreach @classnums;
 298     }
 299
 300     # refnum filters
 301     if ( $sel_part_referral ) {
 302       push @row_params, 'refnum' => $sel_part_referral->refnum;
 303       $row_link .= "refnum=;".$sel_part_referral->refnum;
 304     }
 305
 306     # customer class filters
 307     $row_link .= "cust_classnum=$_;" foreach @cust_classnums;
 308
 309     push @items, 'cust_bill_pkg';
 310     push @labels, mt('[_1] - Subtotal', $agent->agent);
 311     push @params, \@row_params;
 312     push @links, $row_link;
 313     push @colors, '000000'; # better idea?
 314     push @no_graph, 1;
 315   }
 316
 317   $hue += $hue_increment;
 318
 319 }
 320
 321 #use Data::Dumper;
 322 if ( $cgi->param('debug') == 1 ) {
 323   $FS::Report::Table::DEBUG = 1;
 324 }
 325 </%init>