service label localization, internals and UI, #71347
[freeside.git] / httemplate / edit / part_pkg.cgi
index d36fac6..eed466e 100755 (executable)
@@ -12,7 +12,8 @@
                                          $javascript,
               'html_bottom'           => $html_bottom,
               'body_etc'              =>
-                'onLoad="agent_changed(document.edit_topform.agentnum)"',
+                'onLoad="agent_changed(document.edit_topform.agentnum);
+                         hide_supp_pkgs()"',
 
               'begin_callback'        => $begin_callback,
               'end_callback'          => $end_callback,
               'error_callback'        => $error_callback,
               'field_callback'        => $field_callback,
 
+              'onsubmit'              => 'confirm_submit',
+
               'labels' => { 
                             'pkgpart'          => 'Package Definition',
-                            'pkg'              => 'Package (customer-visible)',
+                            'pkg'              => 'Package',
+                            %locale_field_labels,
                             'comment'          => 'Comment (customer-hidden)',
                             'classnum'         => 'Package class',
                             'addon_classnum'   => 'Restrict additional orders to package class',
                             'plan'             => 'Price plan',
                             'disabled'         => 'Disable new orders',
                             'disable_line_item_date_ranges' => 'Disable line item date ranges',
+                            'start_on_hold'    => 'Start on hold',
                             'setup_cost'       => 'Setup cost',
                             'recur_cost'       => 'Recur cost',
                             'pay_weight'       => 'Payment weight',
                             'credit_weight'    => 'Credit weight',
-                            'agentnum'         => 'Agent',
+                            'agent_pkgpartid'  => 'External ID',
+                           'agentnum'         => 'Agent',
+                           'agent_type'       => ' ', #just its title headingn is fine
                             'setup_fee'        => 'Setup fee',
+                            'setup_show_zero'  => 'Show zero setup',
                             'recur_fee'        => 'Recurring fee',
                             'recur_show_zero'  => 'Show zero recurring',
                             'discountnum'      => 'Offer discounts for longer terms',
                             'bill_dst_pkgpart' => 'Include line item(s) from package',
                             'svc_dst_pkgpart'  => 'Include services of package',
+                            'supp_dst_pkgpart' => 'When ordering package, also order',
                             'report_option'    => 'Report classes',
                             'fcc_ds0s'         => 'Voice-grade equivalents',
+                            'fcc_voip_class'   => 'Category',
+                            'delay_start'      => 'Default delay (days)',
                           },
 
               'fields' => [
                             },
 
                             { field=>'custom',  type=>'hidden' },
+                            { field=>'family_pkgpart', type=>'hidden' },
+                            { field=>'successor', type=>'hidden' },
 
                             { type => 'columnstart' },
                             
                               { field     => 'pkg',
-                                type      => 'text',
+                                type      => 'input-locale-text',
                                 size      => 40, #32
                                 maxlength => 50,
                               },
+                              #@locale_fields,
                               {field=>'comment',  type=>'text', size=>40 }, #32
                               { field         => 'agentnum',
                                 type          => 'select-agent',
                               ),
                               {field=>'disabled', type=>$disabled_type, value=>'Y'},
                               {field=>'disable_line_item_date_ranges', type=>$disabled_type, value=>'Y'},
+                              { field => 'start_on_hold',
+                                type => 'checkbox',
+                                value => 'Y'
+                              },
 
-                              { type  => 'tablebreak-tr-title',
-                                value => 'Pricing', #better name?
+                              { type     => 'tablebreak-tr-title',
+                                value    => 'Pricing', #better name?
                               },
-                              { field => 'plan',
-                                type  => 'selectlayers-select',
-                                options => [ keys %plan_labels ],
-                                labels  => \%plan_labels,
+                              { field    => 'plan',
+                                type     => 'selectlayers-select',
+                                options  => [ keys %plan_labels ],
+                                labels   => \%plan_labels,
                                 onchange => 'aux_planchanged(what);',
                               },
-                              { field => 'setup_fee',
-                                type  => 'money',
+                              { field    => 'setup_fee',
+                                type     => 'money',
+                                onchange => 'setup_changed',
+                              },
+                              { field    => 'setup_show_zero',
+                                type     => 'checkbox',
+                                value    => 'Y',
+                                disabled => sub { $setup_show_zero_disabled },
                               },
                               { field    => 'freq',
                                 type     => 'part_pkg_freq',
                               { type  => 'tablebreak-tr-title',
                                 value => 'Cost tracking', #better name?
                               },
-                              { field=>'setup_cost', type=>'money', },
-                              { field=>'recur_cost', type=>'money', },
+
+                              ( $curuser->access_right('Edit package definition costs')
+                                ? ( { field=>'setup_cost', type=>'money', },
+                                    { field=>'recur_cost', type=>'money', },
+                                  )
+                                : ( { field=>'setup_cost', type=>'fixed', },
+                                    { field=>'recur_cost', type=>'fixed', },
+                                  )
+                              ),
+
+                              ( $conf->exists('part_pkg-delay_start')
+                                ? ( { type  => 'tablebreak-tr-title',
+                                      value => 'Delayed start',
+                                    },
+                                    { field => 'delay_start',
+                                      type => 'text', size => 6 },
+                                  )
+                                : ()
+                              ),
 
                             { type => 'columnnext' },
 
-                              { field    => 'agent_type',
-                                type     => 'select-agent_types',
-                                disabled => ! $acl_edit_global,
+                              {type=>'justtitle', value=>'Agent (reseller) types' },
+                              
+                              { field       => 'agent_type',
+                                type        => 'select-agent_type',
+                                disabled    => ! $acl_edit_global,
+                                element_etc => 'size="10"',
+                                multiple    =>  '1', #cause edit.html is dum
                                 curr_value_callback => sub {
                                   my($cgi, $object, $field) = @_;
                                   #in the other callbacks..?  hmm.
                                 },
                               },
 
-                              { type  => 'tablebreak-tr-title',
-                                value => 'Line-item revenue recogition', #better name?
-                              },
-                              { field=>'pay_weight',    type=>'text', size=>6 },
-                              { field=>'credit_weight', type=>'text', size=>6 },
-
-                              ( $conf->exists('cust_pkg-show_fcc_voice_grade_equivalent')
-                                ? ( 
-                                    { type  => 'tablebreak-tr-title',
-                                      value => 'FCC Form 477 information',
-                                    },
-                                    { field=>'fcc_ds0s', type=>'text', size=>6 },
-                                  )
-                                 : ()
-                              ),
-
-
+                      { type  => 'tablebreak-tr-title',
+                        value => 'External Links', #better name?
+                      },
+                      { field=>'agent_pkgpartid', type=>'text', size=>21 },
+
+                      { type  => 'tablebreak-tr-title',
+                        value => 'Line-item revenue recogition', #better name?
+                      },
+                      { field=>'pay_weight',    type=>'text', size=>6 },
+                      { field=>'credit_weight', type=>'text', size=>6 },
+                    ($fcc_opts ? ( 
+                      { type  => 'tablebreak-tr-title',
+                        value => 'FCC Form 477 information',
+                      },
+                      { field => 'fcc_options_string',
+                        type  => 'input-fcc_options',
+                        curr_value_callback => sub {
+                          my ($cgi, $part_pkg, $fref) = @_;
+                          if ( $cgi->param('fcc_options_string') ) {
+                            # error redirect
+                            return $cgi->param('fcc_options_string');
+                          }
+                          my %hash;
+                          %hash = $part_pkg->fcc_options 
+                            if ($part_pkg->pkgpart);
+                          return encode_json(\%hash);
+                        },
+                      },
+                      ) : ()
+                    ),
                             { type => 'columnend' },
 
                             { 'type'  => $report_option ? 'tablebreak-tr-title'
                                                      ? "AND pkgpart != $pkgpart"
                                                      : ''
                                                   },
++                             'label_callback' => sub { shift->pkg_comment_only },
                               'm2_label'   => 'Include line item(s) from package',
                               'm2m_method' => 'bill_part_pkg_link',
                               'm2m_dstcol' => 'dst_pkgpart',
                                                      ? "AND pkgpart != $pkgpart"
                                                      : ''
                                                   },
++                             'label_callback' => sub { shift->pkg_comment_only },
                               'm2_label'   => 'Include services of package: ',
                               'm2m_method' => 'svc_part_pkg_link',
                               'm2m_dstcol' => 'dst_pkgpart',
                                 &{$m2_error_callback_maker}('svc'),
                             },
 
+                            { 'type'    => 'tablebreak-tr-title',
+                              'value'   => 'Supplemental packages',
+                              'colspan' => '4',
+                              'include_opt_callback' => sub {
+                                 'id' => 'show_supp_pkgs',
+                              },
+                            },
+                            { 'field'       => 'supp_dst_pkgpart',
+                              'type'        => 'select-part_pkg',
++                             'label_callback' => sub { shift->pkg_comment_only },
+                              'm2_label'    => 'When ordering package, also order',
+                              'm2m_method'  => 'supp_part_pkg_link',
+                              'm2m_dstcol'  => 'dst_pkgpart',
+                              'm2_error_callback' =>
+                                &{$m2_error_callback_maker}('supp'),
+                            },
+
                             { type  => 'tablebreak-tr-title',
                               value => 'Price plan options',
                             },
@@ -308,6 +385,24 @@ my $agent_clone_extra_sql =
 my $conf = new FS::Conf;
 my $taxproducts = $conf->exists('enable_taxproducts');
 
+my $fcc_opts = $conf->exists('part_pkg-show_fcc_options');
+
+my @locales = grep { ! /^en_/i } $conf->config('available-locales'); #should filter from the default locale lang instead of en_
+my %locale_labels =  map {
+  ( $_ => 'Package -- '. FS::Locales->description($_) )
+} @locales;
+@locales = 
+  sort { $locale_labels{$a} cmp $locale_labels{$b} }
+    @locales;
+
+my $n = 0;
+my %locale_field_labels = (
+  map {
+        ( 'pkgpartmsgnum'. $n++. '_pkg' => $locale_labels{$_} );
+      }
+    @locales
+);
+
 my $sth = dbh->prepare("SELECT COUNT(*) FROM part_pkg_report_option".
                        "  WHERE disabled IS NULL OR disabled = ''  ")
   or die dbh->errstr;
@@ -334,6 +429,7 @@ my @taxproductnums = ( qw( setup recur ), sort (keys %taxproductnums) );
 
 my %options = ();
 my $recur_disabled = 1;
+my $setup_show_zero_disabled = 0;
 my $recur_show_zero_disabled = 1;
 
 my $pkgpart = '';
@@ -345,10 +441,12 @@ my $error_callback = sub {
 
   $opt->{action} = 'Custom' if $cgi->param('pkgnum');
 
+  $setup_show_zero_disabled = ($cgi->param('setup_fee') > 0) ? 1 : 0;
+
   $recur_disabled = $cgi->param('freq') ? 0 : 1;
   $recur_show_zero_disabled =
     $cgi->param('freq')
-      ? $cgi->param('recur_fee') ? 0 : 1
+      ? $cgi->param('recur_fee') > 0 ? 1 : 0
       : 1;
 
   foreach ($cgi->param) {
@@ -391,13 +489,8 @@ my $new_object_callback = sub {
 
 };
 
-my $edit_callback = sub {
-  my( $cgi, $object, $fields, $opt ) = @_;
-
-  $recur_disabled = $object->freq ? 0 : 1;
-
-  (@agent_type) =
-    map {$_->typenum} qsearch('type_pkgs', { 'pkgpart' => $object->pkgpart } );
+sub set_report_option {
+  my($cgi, $object, $fields ) = @_; #, $opt
 
   my @report_option = ();
   foreach ($object->options) {
@@ -420,9 +513,28 @@ my $edit_callback = sub {
     $field->{value} = join(',', @report_option);
   }
 
+}
+
+my $edit_callback = sub {
+  my( $cgi, $object, $fields, $opt ) = @_;
+
+  $setup_show_zero_disabled = ($object->option('setup_fee') > 0) ? 1 : 0;
+
+  $recur_disabled = $object->freq ? 0 : 1;
+
+  $recur_show_zero_disabled =
+    $object->freq
+      ? $object->option('recur_fee') > 0 ? 1 : 0
+      : 1;
+
+  (@agent_type) =
+    map {$_->typenum} qsearch('type_pkgs', { 'pkgpart' => $object->pkgpart } );
+
+  set_report_option( $cgi, $object, $fields);
+
   %options = $object->options;
 
-  $object->set($_ => $object->option($_))
+  $object->set($_ => $object->option($_, 1))
     foreach (qw( setup_fee recur_fee disable_line_item_date_ranges ));
 
   $pkgpart = $object->pkgpart;
@@ -435,8 +547,7 @@ my $new_callback = sub {
   my $conf = new FS::Conf; 
 
   if ( $conf->exists('agent_defaultpkg') ) {
-    #my @all_agent_types = map {$_->typenum} qsearch('agent_type',{});
-    @agent_type = map {$_->typenum} qsearch('agent_type',{});
+    @agent_type = map {$_->typenum} qsearch('agent_type', { 'disabled'=>'' });
   }
 
   $options{'suspend_bill'}=1 if $conf->exists('part_pkg-default_suspend_bill');
@@ -459,19 +570,22 @@ my $clone_callback = sub {
 
     $object->disabled('Y');
 
-  } else { #not when cloning...
+  } else { #when explicitly cloning, not customizing
 
     (@agent_type) =
       map {$_->typenum} qsearch('type_pkgs',{ 'pkgpart' => $object->pkgpart } );
 
   }
 
+  set_report_option( $cgi, $object, $fields);
+
   %options = $object->options;
 
   $object->set($_ => $options{$_})
     foreach (qw( setup_fee recur_fee disable_line_item_date_ranges ));
 
   $recur_disabled = $object->freq ? 0 : 1;
+
 };
 
 my $discount_error_callback = sub {
@@ -531,15 +645,24 @@ my $javascript = <<'END';
       } else {
         what.form.recur_fee.disabled = false;
         what.form.recur_fee.style.backgroundColor = '#ffffff';
-        what.form.recur_show_zero.disabled = false;
+        recur_changed( what.form.recur_fee );
         //what.form.recur_show_zero.style.backgroundColor= '#ffffff';
       }
 
     }
 
+    function setup_changed(what) {
+      var setup = what.value;
+      if ( parseFloat(setup) == 0 ) {
+        what.form.setup_show_zero.disabled = false;
+      } else {
+        what.form.setup_show_zero.disabled = true;
+      }
+    }
+
     function recur_changed(what) {
       var recur = what.value;
-      if ( recur == 0 ) {
+      if ( parseFloat(recur) == 0 ) {
         what.form.recur_show_zero.disabled = false;
       } else {
         what.form.recur_show_zero.disabled = true;
@@ -567,11 +690,10 @@ my $javascript = <<'END';
 
     }
 
-    function aux_planchanged(what) {
+    function aux_planchanged(what) { //?
 
-      alert('called!');
       var plan = what.options[what.selectedIndex].value;
-      var table = document.getElementById('TableNumber7') // XXX NOT ROBUST
+      var table = document.getElementById('TableNumber6') // XXX NOT ROBUST
 
       if ( plan == 'flat' || plan == 'prorate' || plan == 'subscription' ) {
         //table.disabled = false;
@@ -583,9 +705,62 @@ my $javascript = <<'END';
 
     }
 
-  </SCRIPT>
+    // some magic to make "supplemental packages" less obvious
+    var supp_pkg_rows = [];
+    function show_supp_pkgs_click() {
+      supp_pkg_rows[0].style.display = '';
+      this.onclick = '';
+      this.style.backgroundColor = '';
+      this.style.border = '';
+      this.style.padding = '';
+    }
+
+    function hide_supp_pkgs() {
+      var all_selects = document.getElementsByTagName('select');
+      for (var i=0; i < all_selects.length; i++) {
+        if ( all_selects[i].id.match(/^supp_dst_pkgpart/) ) {
+          supp_pkg_rows.push( all_selects[i].parentNode.parentNode );
+        }
+      }
+      if ( supp_pkg_rows.length == 1 ) {
+        // there are none configured, so hide the row to create a new one
+        supp_pkg_rows[0].style.display = 'none';
+        var button = document.getElementById('show_supp_pkgs');
+        button.onclick = show_supp_pkgs_click;
+        button.style.backgroundColor = '#cccccc';
+        button.style.border = '1px solid #7e0079';
+        button.style.padding = '1px';
+      }
+    }
+
+    function finish_edit_fcc(id) {
+      cClick();
+      show_fcc_options(id); // refresh the display
+    }
+
 END
 
+my $warning =
+  'Changing the setup or recurring fee will create a new package definition. '.
+  'Continue?';
+
+$javascript .= "function confirm_submit(f) {";
+if ( $conf->exists('part_pkg-lineage') ) {
+  $javascript .= "
+
+    var fields = Array('setup_fee','recur_fee');
+    for(var i=0; i < fields.length; i++) {
+        if ( f[fields[i]].value != f[fields[i]].defaultValue ) {
+            return confirm('$warning');
+        }
+    }
+";
+}
+$javascript .= "
+  return true;
+}
+</SCRIPT>";
+
 tie my %plans, 'Tie::IxHash', %{ FS::part_pkg::plan_info() };
 
 tie my %plan_labels, 'Tie::IxHash',
@@ -620,19 +795,52 @@ my $html_bottom = sub {
    #$html .= '</SELECT></TD></TR>';
   
     my $href = $plans{$layer}->{'fields'};
-    my @fields = exists($plans{$layer}->{'fieldorder'})
-                   ? @{$plans{$layer}->{'fieldorder'}}
-                   : keys %{ $href };
-  
+    my @fields;
+    if ( $plans{$layer}->{'fieldorder'} ) {
+      @fields = @{ $plans{$layer}->{'fieldorder'} };
+    } else {
+      warn "FS::part_pkg::$layer has no fieldorder.\n";
+      @fields = keys %$href;
+    }
+    
+    # hash of dependencies for each of the Pricing Plan fields.
+    # make sure NOT to use double-quotes inside the 'msg' value.
+    my $dependencies = {
+        'unused_credit_suspend' => {
+            'msg'       => q|You must set the 'suspend_credit_type' option in Configuration->Settings to gain access to this option.|,
+            'are_met'   => sub{
+                my $conf = new FS::conf;
+                my @conf_info = qsearch('conf', { 'name' => 'suspend_credit_type' } );
+                return 1 if (exists($conf_info[0]) && $conf_info[0]->{Hash}{value});
+                return 0;
+            }
+        },
+        'unused_credit_cancel' => {
+            'msg'       => q|You must set the 'cancel_credit_type' option in Configuration->Settings to gain access to this option.|,
+            'are_met'   => sub{
+                my $conf = new FS::conf;
+                my @conf_info = qsearch('conf', { 'name' => 'cancel_credit_type' } );
+                return 1 if (exists($conf_info[0]) && $conf_info[0]->{Hash}{value});
+                return 0;
+            }
+        }
+    };
+
     foreach my $field ( grep $_ !~ /^(setup|recur)_fee$/, @fields ) {
   
-       if(!exists($href->{$field})) {
+      if(!exists($href->{$field})) {
         # shouldn't happen
         warn "nonexistent part_pkg option: '$field'\n";
         next;
       }
+      if ( exists($href->{$field}->{display_if}) ) {
+        my %args = ( 'plan' => $layer ); # anything else?
+        my $display = &{ $href->{$field}->{display_if} }(%args);
+        next if !$display;
+      }
 
-      $html .= '<TR><TD ALIGN="right">'. $href->{$field}{'name'}. '</TD><TD>';
+      $html .= '<TR><TD ALIGN="right">'. $href->{$field}{'name'}. '</TD><TD>
+      ';
   
       my $format = sub { shift };
       $format = $href->{$field}{'format'} if exists($href->{$field}{'format'});
@@ -640,7 +848,10 @@ my $html_bottom = sub {
       #XXX these should use elements/ fields... (or this whole thing should
       #just use layer_fields instead of layer_callback)
   
-      if ( ! exists($href->{$field}{'type'}) ) {
+      if (exists($dependencies->{$field}) && !$dependencies->{$field}{'are_met'}()) {
+          $html .= q!<span title="!.$dependencies->{$field}{'msg'}.q!">N/A</span>!;
+          
+      } elsif ( ! exists($href->{$field}{'type'}) ) {
   
         $html .= qq!<INPUT TYPE="text" NAME="${layer}__$field" VALUE="!.
                  ( exists($options{$field})
@@ -655,7 +866,17 @@ my $html_bottom = sub {
                    ? ' CHECKED'
                    : ''
                  ). '>';
-  
+
+      } elsif ( $href->{$field}{'type'} eq 'select-rate' ) {
+
+        $html .= include('/elements/select-rate.html',
+                           'field'      => $layer.'__'.$field,
+                           'curr_value' => $options{$field},
+                           map { $_ => $href->{$field}{$_} }
+                             grep { $_ !~ /^(name|type)$/ }
+                               keys %{ $href->{$field} }
+                        );
+
       } elsif ( $href->{$field}{'type'} =~ /^select/ ) {
   
         $html .= '<SELECT';
@@ -718,9 +939,11 @@ my $html_bottom = sub {
       $html .= '</TD></TR>';
     }
     $html .= '</TABLE>';
-  
-    $html .= qq(<INPUT TYPE="hidden" NAME="${layer}__OPTIONS" VALUE=").
-             join(',', keys %{ $href } ). '">';
+    $html .= include('/elements/hidden.html',
+                field => $layer.'__OPTIONS',
+                value => join(',', @fields)
+             );
   
     $html;
   
@@ -732,6 +955,7 @@ my $html_bottom = sub {
     labels         => \%plan_labels,
     curr_value     => $object->plan,
     layer_callback => $layer_callback,
+    onchange       => 'aux_planchanged(what);',
   );
 
   my $return =