per-agent subtotals on sales report, #18566
[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              )
17 %>
18 <%init>
19
20 die "access denied"
21   unless $FS::CurrentUser::CurrentUser->access_right('Financial reports');
22
23 my $link = "${p}search/cust_bill_pkg.cgi?nottax=1";
24 my $bottom_link = "$link;";
25
26 my $use_usage = $cgi->param('use_usage') || 0;
27 my $use_setup = $cgi->param('use_setup') || 0;
28 my $use_override         = $cgi->param('use_override')         ? 1 : 0;
29 my $average_per_cust_pkg = $cgi->param('average_per_cust_pkg') ? 1 : 0;
30 my $distribute           = $cgi->param('distribute')           ? 1 : 0;
31
32 my %charge_labels = (
33   'SR' => 'setup + recurring',
34   'RU' => 'recurring',
35   'S'  => 'setup',
36   'R'  => 'recurring',
37   'U'  => 'usage',
38 );
39
40 #XXX or virtual
41 my( $agentnum, $sel_agent, $all_agent ) = ('', '', '');
42 if ( $cgi->param('agentnum') eq 'all' ) {
43   $agentnum = 0;
44   $all_agent = 'ALL';
45 }
46 elsif ( $cgi->param('agentnum') =~ /^(\d+)$/ ) {
47   $agentnum = $1;
48   $bottom_link .= "agentnum=$agentnum;";
49   $sel_agent = qsearchs('agent', { 'agentnum' => $agentnum } );
50   die "agentnum $agentnum not found!" unless $sel_agent;
51 }
52 my $title = $sel_agent ? $sel_agent->agent.' ' : '';
53
54 my( $refnum, $sel_part_referral, $all_part_referral ) = ('', '', '');
55 if ( $cgi->param('refnum') eq 'all' ) {
56   $refnum = 0;
57   $all_part_referral = 'ALL';
58 }
59 elsif ( $cgi->param('refnum') =~ /^(\d+)$/ ) {
60   $refnum = $1;
61   $bottom_link .= "refnum=$refnum;";
62   $sel_part_referral = qsearchs('part_referral', { 'refnum' => $refnum } );
63   die "part_referral $refnum not found!" unless $sel_part_referral;
64 }
65 $title .= $sel_part_referral->referral.' '
66   if $sel_part_referral;
67
68 $title .= 'Sales Report (Gross)';
69 $title .= ', average per customer package'  if $average_per_cust_pkg;
70
71 #classnum (here)
72 # 0: all classes
73 # not specified: empty class
74 # N: classnum
75 #classnum (link)
76 # not specified: all classes
77 # 0: empty class
78 # N: classnum
79
80 #false lazinessish w/FS::cust_pkg::search_sql (previously search/cust_pkg.cgi)
81 my $classnum = 0;
82 my @pkg_class = ();
83 my $all_class = '';
84 if ( $cgi->param('classnum') eq 'all' ) {
85   $all_class = 'ALL';
86   @pkg_class = ('');
87 }
88 elsif ( $cgi->param('classnum') =~ /^(\d*)$/ ) {
89   $classnum = $1;
90   if ( $classnum ) { #a specific class
91
92     @pkg_class = ( qsearchs('pkg_class', { 'classnum' => $classnum } ) );
93     die "classnum $classnum not found!" unless $pkg_class[0];
94     $title .= ' '.$pkg_class[0]->classname.' ';
95     $bottom_link .= "classnum=$classnum;";
96
97   } elsif ( $classnum eq '' ) { #the empty class
98
99     $title .= 'Empty class ';
100     @pkg_class = ( '(empty class)' );
101     $bottom_link .= "classnum=0;";
102
103   } elsif ( $classnum eq '0' ) { #all classes
104
105     @pkg_class = qsearch('pkg_class', {} ); # { 'disabled' => '' } );
106     push @pkg_class, '(empty class)';
107
108   }
109 }
110 #eslaf
111
112 my $hue = 0;
113 #my $hue_increment = 170;
114 #my $hue_increment = 145;
115 my $hue_increment = 125;
116
117 my @items  = ();
118 my @params = ();
119 my @labels = ();
120 my @colors = ();
121 my @links  = ();
122 my @no_graph;
123
124 my @components = ( 'SRU' );
125 # split/omit components as appropriate
126 if ( $use_setup == 1 ) {
127   @components = ( 'S', 'RU' );
128 }
129 elsif ( $use_setup == 2 ) {
130   @components = ( 'RU' );
131 }
132 if ( $use_usage == 1 ) {
133   $components[-1] =~ s/U//; push @components, 'U';
134 }
135 elsif ( $use_usage == 2 ) {
136   $components[-1] =~ s/U//;
137 }
138
139 # Categorization of line items goes
140 # Agent -> Referral -> Package class -> Component (setup/recur/usage)
141 # If per-agent totals are enabled, they go under the Agent level.
142 # There aren't any other kinds of subtotals.
143
144 foreach my $agent ( $all_agent || $sel_agent || qsearch('agent', { 'disabled' => '' } ) ) {
145
146   my $col_scheme = Color::Scheme->new
147                      ->from_hue($hue) #->from_hex($agent->color)
148                      ->scheme('analogic')
149                    ;
150   my @recur_colors = ();
151   my @onetime_colors = ();
152
153   ### fixup the color handling for package classes...
154   ### and usage
155
156   foreach my $part_referral (
157     $all_part_referral ||
158     $sel_part_referral ||
159     qsearch('part_referral', { 'disabled' => '' } ) 
160   ) {
161
162     foreach my $pkg_class ( @pkg_class ) {
163       foreach my $component ( @components ) {
164
165         push @items, 'cust_bill_pkg';
166
167         push @labels,
168           ( $all_agent || $sel_agent ? '' : $agent->agent.' ' ).
169           ( $all_part_referral || $sel_part_referral ? '' : $part_referral->referral.' ' ).
170           ( $classnum eq '0'
171               ? ( ref($pkg_class) ? $pkg_class->classname : $pkg_class ) 
172               : ''
173           ).
174           ' '.$charge_labels{$component};
175
176         my $row_classnum = ref($pkg_class) ? $pkg_class->classnum : 0;
177         my $row_agentnum = $all_agent || $agent->agentnum;
178         my $row_refnum = $all_part_referral || $part_referral->refnum;
179         push @params, [ ($all_class ? () : ('classnum' => $row_classnum) ),
180                         ($all_agent ? () : ('agentnum' => $row_agentnum) ),
181                         ($all_part_referral ? () : ('refnum' => $row_refnum) ),
182                         'use_override'         => $use_override,
183                         'charges'              => $component,
184                         'average_per_cust_pkg' => $average_per_cust_pkg,
185                         'distribute'           => $distribute,
186                       ];
187
188         push @links, "$link;".
189                      ($all_agent ? '' : "agentnum=$row_agentnum;").
190                      ($all_part_referral ? '' : "refnum=$row_refnum;").
191                      ($all_class ? '' : "classnum=$row_classnum;").
192                      "distribute=$distribute;".
193                      "use_override=$use_override;charges=$component;";
194
195         @recur_colors = ($col_scheme->colors)[0,4,8,1,5,9]
196           unless @recur_colors;
197         @onetime_colors = ($col_scheme->colors)[2,6,10,3,7,11]
198           unless @onetime_colors;
199         push @colors, shift @recur_colors;
200         push @no_graph, 0;
201
202       } #foreach $component
203     } #foreach $pkg_class
204   } #foreach $part_referral
205
206   if ( $cgi->param('agent_totals') and !$all_agent ) {
207     my $row_agentnum = $agent->agentnum;
208     # Include all components that are anywhere on this report
209     my $component = join('', @components);
210
211     my @row_params = (  'agentnum'              => $row_agentnum,
212                         'use_override'          => $use_override,
213                         'average_per_cust_pkg'  => $average_per_cust_pkg,
214                         'distribute'            => $distribute,
215                         'charges'               => $component,
216                      );
217     my $row_link = "$link;".
218                    "agentnum=$row_agentnum;".
219                    "distribute=$distribute;".
220                    "charges=$component";
221     
222     # Also apply any refnum/classnum filters
223     if ( !$all_class and scalar(@pkg_class) == 1 ) {
224       # then a specific class has been chosen, but it may be the empty class
225       my $row_classnum = ref($pkg_class[0]) ? $pkg_class[0]->classnum : 0;
226       push @row_params, 'classnum' => $row_classnum;
227       $row_link .= ";classnum=$row_classnum";
228     }
229     if ( $sel_part_referral ) {
230       push @row_params, 'refnum' => $sel_part_referral->refnum;
231       $row_link .= ";refnum=".$sel_part_referral->refnum;
232     }
233
234     push @items, 'cust_bill_pkg';
235     push @labels, mt('[_1] - Subtotal', $agent->agent);
236     push @params, \@row_params;
237     push @links, $row_link;
238     push @colors, '000000'; # better idea?
239     push @no_graph, 1;
240   }
241
242   $hue += $hue_increment;
243
244 }
245
246 #use Data::Dumper;
247 if ( $cgi->param('debug') == 1 ) {
248   $FS::Report::Table::DEBUG = 1;
249 }
250 </%init>