add skip_dcontext_suffix to skip CDRs with dcontext ending in a definable string...
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
index f23b7a7..7d9a7f5 100644 (file)
@@ -10,9 +10,6 @@ use FS::Conf;
 use FS::Record qw(qsearchs qsearch);
 use FS::cdr;
 use FS::detail_format;
-#use FS::rate;
-#use FS::rate_prefix;
-#use FS::rate_detail;
 
 $DEBUG = 0;
 
@@ -22,6 +19,7 @@ tie my %cdr_svc_method, 'Tie::IxHash',
   'svc_pbx.svcnum'     => 'Freeside service # (svc_pbx.svcnum)',
   'svc_pbx.ip.src'     => 'PBX name to source IP address',
   'svc_pbx.ip.dst'     => 'PBX name to destination IP address',
+  'svc_acct.username'  => 'Username (svc_acct.username)',
 ;
 
 tie my %rating_method, 'Tie::IxHash',
@@ -61,6 +59,11 @@ tie my %detail_formats, 'Tie::IxHash',
   FS::cdr::invoice_formats()
 ;
 
+tie my %accountcode_tollfree_field, 'Tie::IxHash',
+  'dst' => 'Destination (dst)',
+  'src' => 'Source (src)',
+;
+
 %info = (
   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
   'shortname' => 'VoIP/telco CDR rating (standard)',
@@ -103,19 +106,13 @@ tie my %detail_formats, 'Tie::IxHash',
                   },
 
     'ratenum'   => { 'name' => 'Rate plan',
-                     'type' => 'select',
-                     'select_table' => 'rate',
-                     'select_key'   => 'ratenum',
-                     'select_label' => 'ratename',
+                     'type' => 'select-rate',
                    },
                    
     'intrastate_ratenum'   => { 'name' => 'Optional alternate intrastate rate plan',
-                     'type' => 'select',
-                     'select_table' => 'rate',
-                     'select_key'   => 'ratenum',
-                     'select_label' => 'ratename',
+                     'type' => 'select-rate',
                      'disable_empty' => 0,
-                     'empty_label'   => '',
+                     'empty_label'   => ' ',
                    },
 
     'calls_included' => { 'name' => 'Number of calls included at no usage charge', },
@@ -152,7 +149,7 @@ tie my %detail_formats, 'Tie::IxHash',
 #                                    'type' => 'checkbox',
 #                                  },
 
-    'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
+    'international_prefix' => { 'name'    => 'Destination prefix for international CDR records (or "none" for no prefix)',
                                 'default' => '011',
                               },
 
@@ -188,7 +185,10 @@ tie my %detail_formats, 'Tie::IxHash',
     'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
     },
 
-    'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
+    'skip_dcontext' => { 'name' => 'Do not charge for CDRs where dcontext is set to any of these (comma-separated) values: ',
+                       },
+
+    'skip_dcontext_suffix' => { 'name' => 'Do not charge for CDRs where dcontext ends with: ',
                        },
 
     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
@@ -211,6 +211,12 @@ tie my %detail_formats, 'Tie::IxHash',
       'empty_label'   => '',
     },
 
+    'accountcode_tollfree_field' => {
+      'name'           => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations',
+      'type'           => 'select',
+      'select_options' => \%accountcode_tollfree_field,
+    },
+
     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
                               },
 
@@ -268,7 +274,7 @@ tie my %detail_formats, 'Tie::IxHash',
                        },
     #eofalse
 
-    'usage_nozero' => { 'name' => 'Omit details for included / no-charge calls.',
+    'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.',
                         'type' => 'checkbox',
                       },
 
@@ -279,6 +285,9 @@ tie my %detail_formats, 'Tie::IxHash',
     'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
                               'type' => 'checkbox',
                             },
+    'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period',
+                               'type' => 'checkbox',
+                             },
 
     'count_available_phones' => { 'name' => 'Consider for tax purposes the number of lines to be svc_phones that may be provisioned rather than those that actually are.',
                            'type' => 'checkbox',
@@ -327,10 +336,10 @@ tie my %detail_formats, 'Tie::IxHash',
                        use_cdrtypenum ignore_cdrtypenum
                        use_calltypenum ignore_calltypenum
                        ignore_disposition disposition_in
-                       skip_dcontext skip_dst_prefix 
+                       skip_dcontext skip_dcontext_suffix skip_dst_prefix 
                        skip_dstchannel_prefix skip_src_length_more 
                        noskip_src_length_accountcode_tollfree
-                       accountcode_tollfree_ratenum
+                       accountcode_tollfree_ratenum accountcode_tollfree_field
                        skip_dst_length_less
                        noskip_dst_length_accountcode_tollfree
                        skip_lastapp
@@ -341,7 +350,8 @@ tie my %detail_formats, 'Tie::IxHash',
                        output_format 
                        selfservice_format selfservice_inbound_format
                        usage_mandate usage_section summarize_usage 
-                       usage_nozero bill_every_call bill_inactive_svcs
+                       usage_showzero bill_every_call bill_inactive_svcs
+                       bill_only_pkg_dates
                        count_available_phones suspend_bill 
                      )
                   ],
@@ -350,7 +360,7 @@ tie my %detail_formats, 'Tie::IxHash',
 
 sub price_info {
     my $self = shift;
-    my $str = $self->SUPER::price_info;
+    my $str = $self->SUPER::price_info(@_);
     $str .= " plus usage" if $str;
     $str;
 }
@@ -391,13 +401,17 @@ sub calc_usage {
 
   my $charges = 0;
 
-  my $included_min = $self->option('min_included', 1) || 0; #single price rating
+  my $included_min = $self->option('min_included', 1) || 0;
+    #single price rating
+    #or region group
+  $included_min *= ($cust_pkg->quantity || 1);
+
   my $included_calls = $self->option('calls_included', 1) || 0;
+  $included_calls *= ($cust_pkg->quantity || 1);
 
   my $cdr_svc_method    = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
   my $rating_method     = $self->option('rating_method') || 'prefix';
-  my $region_group_included_min = $self->option('min_included',1) || 0;
-  my %region_group_included_min = ();
+  my %detail_included_min = ();
 
   my $output_format     = $self->option('output_format', 'Hush!')
                           || ( $rating_method eq 'upstream_simple'
@@ -405,9 +419,12 @@ sub calc_usage {
                                  : 'default'
                              );
 
-  my $usage_nozero      = $self->option('usage_nozero', 1);
+  my $usage_showzero    = $self->option('usage_showzero', 1);
 
-  my $formatter = FS::detail_format->new($output_format, buffer => $details);
+  my $formatter = FS::detail_format->new($output_format,
+    buffer => $details,
+    locale => $cust_pkg->cust_main->locale
+  );
 
   my $use_duration = $self->option('use_duration');
 
@@ -439,23 +456,40 @@ sub calc_usage {
     }
 
     my %options = (
-        'disable_src'    => $self->option('disable_src'),
-        'default_prefix' => $self->option('default_prefix'),
-        'cdrtypenum'     => $self->option('use_cdrtypenum'),
-        'calltypenum'    => $self->option('use_calltypenum'),
+        'disable_src'    => $self->option('disable_src',1),
+        'default_prefix' => $self->option('default_prefix',1),
+        'cdrtypenum'     => $self->option('use_cdrtypenum',1),
+        'calltypenum'    => $self->option('use_calltypenum',1),
         'status'         => '',
         'for_update'     => 1,
-      );  # $last_bill, $$sdate )
+    );
+    if ( $self->option('bill_only_pkg_dates') ) {
+      $options{'begin'} = $last_bill;
+      $options{'end'}   = $$sdate;
+    }
     if ( $svc_field eq 'svcnum' ) {
       $options{'by_svcnum'} = 1;
-    }
-    elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
+    } elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
       $options{'by_ip_addr'} = $by_ip_addr;
     }
 
     #my @invoice_details_sort;
 
+    # for tagging invoice details
+    # (unfortunate; should be a svc_x class method or table_info item or 
+    # something)
+    my $phonenum;
+    if ( $svc_table eq 'svc_phone' ) {
+      $phonenum = $svc_x->phonenum;
+    } elsif ( $svc_table eq 'svc_pbx' ) {
+      $phonenum = $svc_x->title;
+    } elsif ( $svc_table eq 'svc_acct' ) {
+      $phonenum = $svc_x->username;
+    }
+    $formatter->phonenum($phonenum);
+
     #first rate any outstanding CDRs not yet rated
+    # use FS::Cursor for this starting in 4.x
     my $cdr_search = $svc_x->psearch_cdrs(%options);
     $cdr_search->limit(1000);
     $cdr_search->increment(0); # because we're changing their status as we go
@@ -465,9 +499,8 @@ sub calc_usage {
         'part_pkg'                          => $self,
         'cust_pkg'                          => $cust_pkg,
         'svcnum'                            => $svc_x->svcnum,
-        'single_price_included_min'         => \$included_min,
-        'region_group_included_min'         => \$region_group_included_min,
-        'region_group_included_min_hashref' => \%region_group_included_min,
+        'plan_included_min'                 => \$included_min,
+        'detail_included_min_hashref'       => \%detail_included_min,
       );
       die $error if $error; #??
 
@@ -497,7 +530,8 @@ sub calc_usage {
         $error = $cdr->set_status('done');
       }
       die $error if $error;
-      $formatter->append($cdr) unless $usage_nozero && $cdr->rated_price == 0;
+      $formatter->append($cdr)
+        unless $cdr->rated_price == 0 and not $usage_showzero;
 
       $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
     } #$cdr
@@ -557,6 +591,11 @@ sub check_chargable {
     if $self->option_cacheable('skip_dcontext') =~ /\S/
     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
 
+  my $len_suffix = length($self->option_cacheable('skip_dcontext_suffix'));
+  return "dcontext ends with ". $self->option_cacheable('skip_dcontext_suffix')
+    if $len_suffix
+    && substr($cdr->dcontext,-$len_suffix,$len_suffix) eq $self->option_cacheable('skip_dcontext_suffix');
+
   my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
   return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
     if $len_prefix
@@ -635,7 +674,8 @@ sub reset_usage {
                 FS::cust_pkg_usage->new({
                     'pkgnum'        => $cust_pkg->pkgnum,
                     'pkgusagepart'  => $part,
-                    'minutes'       => $part_pkg_usage->minutes,
+                    'minutes'       => $part_pkg_usage->minutes *
+                                        ($cust_pkg->quantity || 1),
                 });
     foreach my $cdr_usage (
       qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
@@ -661,6 +701,7 @@ sub reset_usage {
 
 # tells whether cust_bill_pkg_detail should return a single line for 
 # each phonenum
+# i think this is currently unused?
 sub sum_usage {
   my $self = shift;
   $self->option('output_format') =~ /^sum_/;