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