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