avoid counting location-changed packages in total canceled packages
[freeside.git] / httemplate / browse / part_pkg.cgi
1 <% include( 'elements/browse.html',
2                  'title'                 => 'Package Definitions',
3                  'menubar'               => \@menubar,
4                  'html_init'             => $html_init,
5                  'html_form'             => $html_form,
6                  'html_posttotal'        => $html_posttotal,
7                  'name'                  => 'package definitions',
8                  'disableable'           => 1,
9                  'disabled_statuspos'    => 4,
10                  'agent_virt'            => 1,
11                  'agent_null_right'      => [ $edit, $edit_global ],
12                  'agent_null_right_link' => $edit_global,
13                  'agent_pos'             => 7, #5?
14                  'query'                 => { 'select'    => $select,
15                                               'table'     => 'part_pkg',
16                                               'hashref'   => \%hash,
17                                               'extra_sql' => $extra_sql,
18                                               'order_by'  => "ORDER BY $orderby"
19                                             },
20                  'count_query'           => $count_query,
21                  'header'                => \@header,
22                  'fields'                => \@fields,
23                  'links'                 => \@links,
24                  'align'                 => $align,
25                  'link_field'            => 'pkgpart',
26                  'html_init'             => $html_init,
27                  'html_foot'             => $html_foot,
28              )
29 %>
30 <%init>
31
32 my $curuser = $FS::CurrentUser::CurrentUser;
33
34 my $edit        = 'Edit package definitions';
35 my $edit_global = 'Edit global package definitions';
36 my $acl_edit        = $curuser->access_right($edit);
37 my $acl_edit_global = $curuser->access_right($edit_global);
38 my $acl_config      = $curuser->access_right('Configuration'); #to edit services
39                                                                #and agent types
40                                                                #and bulk change
41 my $acl_edit_bulk   = $curuser->access_right('Bulk edit package definitions');
42
43 die "access denied"
44   unless $acl_edit || $acl_edit_global;
45
46 my $conf = new FS::Conf;
47 my $taxclasses = $conf->exists('enable_taxclasses');
48 my $money_char = $conf->config('money_char') || '$';
49
50 my $select = '*';
51 my $orderby = 'pkgpart';
52 my %hash = ();
53 my $extra_count = '';
54 my $family_pkgpart;
55
56 if ( $cgi->param('active') ) {
57   $orderby = 'num_active DESC';
58 }
59
60 my @where = ();
61
62 #if ( $cgi->param('activeONLY') ) {
63 #  push @where, ' WHERE num_active > 0 '; #XXX doesn't affect count...
64 #}
65
66 if ( $cgi->param('recurring') ) {
67   $hash{'freq'} = { op=>'!=', value=>'0' };
68   $extra_count = " freq != '0' ";
69 }
70
71 my $classnum = '';
72 if ( $cgi->param('classnum') =~ /^(\d+)$/ ) {
73   $classnum = $1;
74   push @where, $classnum ? "classnum =  $classnum"
75                          : "classnum IS NULL";
76 }
77 $cgi->delete('classnum');
78
79 if ( $cgi->param('missing_recur_fee') ) {
80   push @where, "0 = ( SELECT COUNT(*) FROM part_pkg_option
81                         WHERE optionname = 'recur_fee'
82                           AND part_pkg_option.pkgpart = part_pkg.pkgpart
83                           AND CAST( optionvalue AS NUMERIC ) > 0
84                     )";
85 }
86
87 if ( $cgi->param('family') =~ /^(\d+)$/ ) {
88   $family_pkgpart = $1;
89   push @where, "family_pkgpart = $1";
90   # Hiding disabled or one-time charges and limiting by classnum aren't 
91   # very useful in this mode, so all links should still refer back to the 
92   # non-family-limited display.
93   $cgi->param('showdisabled', 1);
94   $cgi->delete('family');
95 }
96
97 push @where, FS::part_pkg->curuser_pkgs_sql
98   unless $acl_edit_global;
99
100 my $extra_sql = scalar(@where)
101                 ? ( scalar(keys %hash) ? ' AND ' : ' WHERE ' ).
102                   join( 'AND ', @where)
103                 : '';
104
105 my $agentnums_sql = $curuser->agentnums_sql( 'table'=>'cust_main' );
106 my $count_cust_pkg = "
107   SELECT COUNT(*) FROM cust_pkg LEFT JOIN cust_main USING ( custnum )
108     WHERE cust_pkg.pkgpart = part_pkg.pkgpart
109       AND $agentnums_sql
110 ";
111 my $count_cust_pkg_cancel = "
112   SELECT COUNT(*) FROM cust_pkg LEFT JOIN cust_main USING ( custnum )
113     LEFT JOIN cust_pkg AS cust_pkg_next
114       ON (cust_pkg.pkgnum = cust_pkg_next.change_pkgnum)
115     WHERE cust_pkg.pkgpart = part_pkg.pkgpart
116       AND $agentnums_sql
117       AND cust_pkg.cancel IS NOT NULL AND cust_pkg.cancel != 0
118 ";
119
120 $select = "
121
122   *,
123
124   ( $count_cust_pkg
125       AND ( setup IS NULL OR setup = 0 )
126       AND ( cancel IS NULL OR cancel = 0 )
127       AND ( susp IS NULL OR susp = 0 )
128   ) AS num_not_yet_billed,
129
130   ( $count_cust_pkg
131       AND setup IS NOT NULL AND setup != 0
132       AND ( cancel IS NULL OR cancel = 0 )
133       AND ( susp IS NULL OR susp = 0 )
134   ) AS num_active,
135
136   ( $count_cust_pkg
137       AND ( cancel IS NULL OR cancel = 0 )
138       AND susp IS NOT NULL AND susp != 0
139       AND setup IS NOT NULL AND setup != 0
140   ) AS num_suspended,
141
142   ( $count_cust_pkg
143       AND ( cancel IS NULL OR cancel = 0 )
144       AND susp IS NOT NULL AND susp != 0
145       AND ( setup IS NULL OR setup = 0 )
146   ) AS num_on_hold,
147
148   ( $count_cust_pkg_cancel
149       AND (cust_pkg_next.pkgnum IS NULL
150            OR cust_pkg_next.pkgpart != cust_pkg.pkgpart)
151   ) AS num_cancelled
152
153 ";
154 # About the num_cancelled expression: packages that were changed, but 
155 # kept the same pkgpart, are considered "moved", not "canceled" (because
156 # this is the part_pkg UI).  We could show the count of those but it's 
157 # probably not interesting.
158
159 my $html_init = qq!
160     One or more service definitions are grouped together into a package 
161     definition and given pricing information.  Customers purchase packages
162     rather than purchase services directly.<BR><BR>
163     <FORM METHOD="GET" ACTION="${p}edit/part_pkg.cgi">
164     <A HREF="${p}edit/part_pkg.cgi"><I>Add a new package definition</I></A>
165     or
166     !.include('/elements/select-part_pkg.html', 'element_name' => 'clone' ). qq!
167     <INPUT TYPE="submit" VALUE="Clone existing package">
168     </FORM>
169     <BR><BR>
170   !;
171
172 $cgi->param('dummy', 1);
173
174 my $filter_change =
175   qq(\n<SCRIPT TYPE="text/javascript">\n).
176   "function filter_change() {".
177   "  window.location = '". $cgi->self_url.
178        ";classnum=' + document.getElementById('classnum').options[document.getElementById('classnum').selectedIndex].value".
179   "}".
180   "\n</SCRIPT>\n";
181
182 #restore this so pagination works
183 $cgi->param('classnum', $classnum) if length($classnum);
184
185 #should hide this if there aren't any classes
186 my $html_posttotal =
187   "$filter_change\n<BR>( show class: ".
188   include('/elements/select-pkg_class.html',
189             #'curr_value'    => $classnum,
190             'value'         => $classnum, #insist on 0 :/
191             'onchange'      => 'filter_change()',
192             'pre_options'   => [ '-1' => 'all',
193                                  '0'  => '(none)', ],
194             'disable_empty' => 1,
195          ).
196   ' )';
197
198 my $recur_toggle = $cgi->param('recurring') ? 'show' : 'hide';
199 $cgi->param('recurring', $cgi->param('recurring') ^ 1 );
200
201 $html_posttotal .=
202   '( <A HREF="'. $cgi->self_url.'">'. "$recur_toggle one-time charges</A> )";
203
204 $cgi->param('recurring', $cgi->param('recurring') ^ 1 ); #put it back
205
206 # ------
207
208 my $link = [ $p.'edit/part_pkg.cgi?', 'pkgpart' ];
209
210 my @header = ( '#', 'Package', 'Comment', 'Custom' );
211 my @fields = ( 'pkgpart', 'pkg', 'comment',
212                sub{ '<B><FONT COLOR="#0000CC">'.$_[0]->custom.'</FONT></B>' }
213              );
214 my $align = 'rllc';
215 my @links = ( $link, $link, '', '' );
216
217 unless ( 0 ) { #already showing only one class or something?
218   push @header, 'Class';
219   push @fields, sub { shift->classname || '(none)'; };
220   $align .= 'l';
221 }
222
223 if ( $conf->exists('pkg-addon_classnum') ) {
224   push @header, "Add'l order class";
225   push @fields, sub { shift->addon_classname || '(none)'; };
226   $align .= 'l';
227 }
228
229 tie my %plans, 'Tie::IxHash', %{ FS::part_pkg::plan_info() };
230
231 tie my %plan_labels, 'Tie::IxHash',
232   map {  $_ => ( $plans{$_}->{'shortname'} || $plans{$_}->{'name'} ) }
233       keys %plans;
234
235 push @header, 'Pricing';
236 $align .= 'r'; #?
237 push @fields, sub {
238   my $part_pkg = shift;
239   (my $plan = $plan_labels{$part_pkg->plan} ) =~ s/ /&nbsp;/g;
240   my $is_recur = ( $part_pkg->freq ne '0' );
241   my @discounts = sort { $a->months <=> $b->months }
242                   map { $_->discount  }
243                   $part_pkg->part_pkg_discount;
244
245   [
246     ( !$family_pkgpart &&
247       $part_pkg->pkgpart == $part_pkg->family_pkgpart ? () : [
248       {
249         'align'=> 'center',
250         'colspan' => 2,
251         'size' => '-1',
252         'data' => '<b>Show all versions</b>',
253         'link' => $p.'browse/part_pkg.cgi?family='.$part_pkg->family_pkgpart,
254       }
255     ] ),
256     [
257       { data =>$plan,
258         align=>'center',
259         colspan=>2,
260       },
261     ],
262     [
263       { data =>$money_char.
264                sprintf('%.2f ', $part_pkg->option('setup_fee') ),
265         align=>'right'
266       },
267       { data => ( ( $is_recur ? ' &nbsp; setup' : ' &nbsp; one-time' ).
268                   ( $part_pkg->option('recur_fee') == 0
269                       && $part_pkg->setup_show_zero
270                     ? ' (printed on invoices)'
271                     : ''
272                   )
273                 ),
274         align=>'left',
275       },
276     ],
277     [
278       { data=>(
279           $is_recur
280             ? $money_char. sprintf('%.2f', $part_pkg->option('recur_fee'))
281             : $part_pkg->freq_pretty
282         ),
283         align=> ( $is_recur ? 'right' : 'center' ),
284         colspan=> ( $is_recur ? 1 : 2 ),
285       },
286       ( $is_recur
287         ?  { data => ( $is_recur
288                ? ' &nbsp; '. $part_pkg->freq_pretty.
289                  ( $part_pkg->option('recur_fee') == 0
290                      && $part_pkg->recur_show_zero
291                    ? ' (printed on invoices)'
292                    : ''
293                  )
294                : '' ),
295              align=>'left',
296            }
297         : ()
298       ),
299     ],
300     ( map { my $dst_pkg = $_->dst_pkg;
301             [
302               { data => 'Supplemental: &nbsp;'.
303                         '<A HREF="#'. $dst_pkg->pkgpart . '">' .
304                         $dst_pkg->pkg . '</A>',
305                 align=> 'center',
306                 colspan => 2,
307               }
308             ]
309           }
310       $part_pkg->supp_part_pkg_link
311     ),
312     ( map { 
313             my $dst_pkg = $_->dst_pkg;
314             [ 
315               { data => 'Add-on:&nbsp;'.$dst_pkg->pkg_comment,
316                 align=>'center', #?
317                 colspan=>2,
318               }
319             ]
320           }
321       $part_pkg->bill_part_pkg_link
322     ),
323     ( scalar(@discounts)
324         ?  [ 
325               { data => '<b>Discounts</b>',
326                 align=>'center', #?
327                 colspan=>2,
328               }
329             ]
330         : ()  
331     ),
332     ( scalar(@discounts)
333         ? map { 
334             [ 
335               { data  => $_->months. ':',
336                 align => 'right',
337               },
338               { data => $_->amount ? '$'. $_->amount : $_->percent. '%'
339               }
340             ]
341           }
342           @discounts
343         : ()
344     ),
345   ];
346
347 #  $plan_labels{$part_pkg->plan}.'<BR>'.
348 #    $money_char.sprintf('%.2f setup<BR>', $part_pkg->option('setup_fee') ).
349 #    ( $part_pkg->freq ne '0'
350 #      ? $money_char.sprintf('%.2f ', $part_pkg->option('recur_fee') )
351 #      : ''
352 #    ).
353 #    $part_pkg->freq_pretty; #.'<BR>'
354 };
355
356 push @header, 'Cost&nbsp;tracking';
357 $align .= 'r'; #?
358 push @fields, sub {
359   my $part_pkg = shift;
360   #(my $plan = $plan_labels{$part_pkg->plan} ) =~ s/ /&nbsp;/g;
361   my $is_recur = ( $part_pkg->freq ne '0' );
362
363   [
364     [
365       { data => '&nbsp;', # $plan,
366         align=>'center',
367         colspan=>2,
368       },
369     ],
370     [
371       { data =>$money_char.
372                sprintf('%.2f ', $part_pkg->setup_cost ),
373         align=>'right'
374       },
375       { data => ( $is_recur ? '&nbsp;setup' : '&nbsp;one-time' ),
376         align=>'left',
377       },
378     ],
379     [
380       { data=>(
381           $is_recur
382             ? $money_char. sprintf('%.2f', $part_pkg->recur_cost)
383             : '(no&nbsp;recurring)' #$part_pkg->freq_pretty
384         ),
385         align=> ( $is_recur ? 'right' : 'center' ),
386         colspan=> ( $is_recur ? 1 : 2 ),
387       },
388       ( $is_recur
389         ?  { data => ( $is_recur
390                          ? '&nbsp;'. $part_pkg->freq_pretty
391                          : ''
392                      ),
393              align=>'left',
394            }
395         : ()
396       ),
397     ],
398   ];
399 };
400
401 ###
402 # Agent goes here if displayed
403 ###
404
405 #agent type
406 if ( $acl_edit_global ) {
407   #really we just want a count, but this is fine unless someone has tons
408   my @all_agent_types = map {$_->typenum} qsearch('agent_type',{});
409   if ( scalar(@all_agent_types) > 1 ) {
410     push @header, 'Agent types';
411     my $typelink = $p. 'edit/agent_type.cgi?';
412     push @fields, sub { my $part_pkg = shift;
413                         [
414                           map { my $agent_type = $_->agent_type;
415                                 [ 
416                                   { 'data'  => $agent_type->atype, #escape?
417                                     'align' => 'left',
418                                     'link'  => ( $acl_config
419                                                    ? $typelink.
420                                                      $agent_type->typenum
421                                                    : ''
422                                                ),
423                                   },
424                                 ];
425                               }
426                               $part_pkg->type_pkgs
427                         ];
428                       };
429     $align .= 'l';
430   }
431 }
432
433 #if ( $cgi->param('active') ) {
434   push @header, 'Customer<BR>packages';
435   my %col = (
436     'on hold'         => '7E0079', #purple!
437     'not yet billed'  => '009999', #teal? cyan?
438     'active'          => '00CC00',
439     'suspended'       => 'FF9900',
440     'cancelled'       => 'FF0000',
441     #'one-time charge' => '000000',
442     'charge'          => '000000',
443   );
444   my $cust_pkg_link = $p. 'search/cust_pkg.cgi?pkgpart=';
445   push @fields, sub { my $part_pkg = shift;
446                         [
447                         map( {
448                               my $magic = $_;
449                               my $label = $_;
450                               if ( $magic eq 'active' && $part_pkg->freq == 0 ) {
451                                 $magic = 'inactive';
452                                 #$label = 'one-time charge';
453                                 $label = 'charge';
454                               }
455                               $label= 'not yet billed' if $magic eq 'not_yet_billed';
456                               $label= 'on hold' if $magic eq 'on_hold';
457                           
458                               [
459                                 {
460                                  'data'  => '<B><FONT COLOR="#'. $col{$label}. '">'.
461                                             $part_pkg->get("num_$_").
462                                             '</FONT></B>',
463                                  'align' => 'right',
464                                 },
465                                 {
466                                  'data'  => $label.
467                                               ( $part_pkg->get("num_$_") != 1
468                                                 && $label =~ /charge$/
469                                                   ? 's'
470                                                   : ''
471                                               ),
472                                  'align' => 'left',
473                                  'link'  => ( $part_pkg->get("num_$_")
474                                                 ? $cust_pkg_link.
475                                                   $part_pkg->pkgpart.
476                                                   ";magic=$magic"
477                                                 : ''
478                                             ),
479                                 },
480                               ],
481                             } (qw( on_hold not_yet_billed active suspended cancelled ))
482                           ),
483                       ($acl_config ? 
484                         [ {}, 
485                           { 'data'  => '<FONT SIZE="-1">[ '.
486                               include('/elements/popup_link.html',
487                                 'label'       => 'change',
488                                 'action'      => "${p}edit/bulk-cust_pkg.html?".
489                                                  'pkgpart='.$part_pkg->pkgpart,
490                                 'actionlabel' => 'Change Packages',
491                                 'width'       => 569,
492                                 'height'      => 210,
493                               ).' ]</FONT>',
494                             'align' => 'left',
495                           } 
496                         ] : () ),
497                       ]; 
498   };
499   $align .= 'r';
500 #}
501
502 if ( $taxclasses ) {
503   push @header, 'Taxclass';
504   push @fields, sub { shift->taxclass() || '&nbsp;'; };
505   $align .= 'l';
506 }
507
508 # make a table of report class optionnames =>  the actual 
509 my %report_optionname_name = map { 'report_option_'.$_->num, $_->name }
510   qsearch('part_pkg_report_option', { disabled => '' });
511
512 push @header, 'Plan options',
513               'Services';
514               #'Service', 'Quan', 'Primary';
515
516 push @fields, 
517               sub {
518                     my $part_pkg = shift;
519                     if ( $part_pkg->plan ) {
520
521                       my %options = $part_pkg->options;
522                       # gather any options that are really report options,
523                       # convert them to their user-friendly names,
524                       # and sort them (I think?)
525                       my @report_options =
526                         sort { $a cmp $b }
527                         map { $report_optionname_name{$_} }
528                         grep { $options{$_}
529                                and exists($report_optionname_name{$_}) }
530                         keys %options;
531
532                       my @rows = (
533                         map { 
534                               [
535                                 { 'data'  => "$_: ",
536                                   'align' => 'right',
537                                 },
538                                 { 'data'  => $part_pkg->format($_,$options{$_}),
539                                   'align' => 'left',
540                                 },
541                               ];
542                             }
543                         grep { $options{$_} =~ /\S/ } 
544                         grep { $_ !~ /^(setup|recur)_fee$/ 
545                                and $_ !~ /^report_option_\d+$/ }
546                         keys %options
547                       );
548                       if ( @report_options ) {
549                         push @rows,
550                           [ { 'data'  => 'Report classes',
551                               'align' => 'center',
552                               'style' => 'font-weight: bold',
553                               'colspan' => 2
554                             } ];
555                         foreach (@report_options) {
556                           push @rows, [
557                             { 'data'  => $_,
558                               'align' => 'center',
559                               'colspan' => 2
560                             }
561                           ];
562                         } # foreach @report_options
563                       } # if @report_options
564
565                       return \@rows;
566
567                     } else { # should never happen...
568
569                       [ map { [
570                                 { 'data'  => uc($_),
571                                   'align' => 'right',
572                                 },
573                                 {
574                                   'data'  => $part_pkg->$_(),
575                                   'align' => 'left',
576                                 },
577                               ];
578                             }
579                         (qw(setup recur))
580                       ];
581
582                     }
583
584                   },
585
586               sub {
587                     my $part_pkg = shift;
588                     my @part_pkg_usage = sort { $a->priority <=> $b->priority }
589                                          $part_pkg->part_pkg_usage;
590
591                     [ 
592                       (map {
593                              my $pkg_svc = $_;
594                              my $part_svc = $pkg_svc->part_svc;
595                              my $svc = $part_svc->svc;
596                              if ( $pkg_svc->primary_svc =~ /^Y/i ) {
597                                $svc = "<B>$svc (PRIMARY)</B>";
598                              }
599                              $svc =~ s/ +/&nbsp;/g;
600
601                              [
602                                {
603                                  'data'  => '<B>'. $pkg_svc->quantity. '</B>',
604                                  'align' => 'right'
605                                },
606                                {
607                                  'data'  => $svc,
608                                  'align' => 'left',
609                                  'link'  => ( $acl_config
610                                                 ? $p. 'edit/part_svc.cgi?'.
611                                                   $part_svc->svcpart
612                                                 : ''
613                                             ),
614                                },
615                              ];
616                            }
617                       sort {     $b->primary_svc =~ /^Y/i
618                              <=> $a->primary_svc =~ /^Y/i
619                            }
620                            $part_pkg->pkg_svc('disable_linked'=>1)
621                       ),
622                       ( map { 
623                               my $dst_pkg = $_->dst_pkg;
624                               [
625                                 { data => 'Add-on:&nbsp;'.$dst_pkg->pkg_comment,
626                                   align=>'center', #?
627                                   colspan=>2,
628                                 }
629                               ]
630                             }
631                         $part_pkg->svc_part_pkg_link
632                       ),
633                       ( scalar(@part_pkg_usage) ? 
634                           [ { data  => 'Usage minutes',
635                               align => 'center',
636                               colspan    => 2,
637                               data_style => 'b',
638                               link  => $p.'browse/part_pkg_usage.html#pkgpart'.
639                                        $part_pkg->pkgpart 
640                             } ]
641                           : ()
642                       ),
643                       ( map {
644                               [ { data  => $_->minutes,
645                                   align => 'right'
646                                 },
647                                 { data  => $_->description,
648                                   align => 'left'
649                                 },
650                               ]
651                             } @part_pkg_usage
652                       ),
653                     ];
654
655                   };
656
657 $align .= 'lrl'; #rr';
658
659 # --------
660
661 my $count_extra_sql = $extra_sql;
662 $count_extra_sql =~ s/^\s*AND /WHERE /i;
663 $extra_count = ( $count_extra_sql ? ' AND ' : ' WHERE ' ). $extra_count
664   if $extra_count;
665 my $count_query = "SELECT COUNT(*) FROM part_pkg $count_extra_sql $extra_count";
666
667 my $html_form = '';
668 my $html_foot = '';
669 if ( $acl_edit_bulk ) {
670   # insert a checkbox column
671   push @header, '';
672   push @fields, sub {
673     '<INPUT TYPE="checkbox" NAME="pkgpart" VALUE=' . $_[0]->pkgpart .'>';
674   };
675   push @links, '';
676   $align .= 'c';
677   $html_form = qq!<FORM ACTION="${p}edit/bulk-part_pkg.html" METHOD="POST">!;
678   $html_foot = include('/search/elements/checkbox-foot.html',
679       submit  => 'edit report classes', # for now it's only report classes
680   ) . '</FORM>';
681 }
682
683 my @menubar;
684 # show this if there are any voip_cdr packages defined
685 if ( FS::part_pkg->count("plan = 'voip_cdr'") ) {
686   push @menubar, 'Per-package usage minutes' => $p.'browse/part_pkg_usage.html';
687 }
688 </%init>