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