RT# 82955 - add script to un refund electronic refunds in batch file
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
index 2d53ace..536ea0b 100644 (file)
@@ -4,6 +4,7 @@ use base qw( FS::part_pkg::recur_Common );
 use strict;
 use vars qw( $DEBUG %info );
 use Tie::IxHash;
+use Date::Parse;
 use Date::Format;
 use Text::CSV_XS;
 use FS::Conf;
@@ -28,8 +29,8 @@ tie my %cdr_svc_method, 'Tie::IxHash',
 tie my %rating_method, 'Tie::IxHash',
   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
 #  'upstream' => 'Rate calls based on upstream data: If the call type is "1", map the upstream rate ID directly to an internal rate (rate_detail), otherwise, pass the upstream price through directly.',
-  'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
-  'single_price' => 'A single price per minute for all calls.',
+  'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount (ignoring all options to skip calls).',
+  'single_price' => 'A single price per minute for all calls (ignoring all options to skip calls).',
 ;
 
 tie my %rounding, 'Tie::IxHash',
@@ -123,6 +124,10 @@ tie my %accountcode_tollfree_field, 'Tie::IxHash',
     'min_included' => { 'name' => 'Minutes included when using the "single price per minute" or "prefix" rating method',
                     },
 
+    'show_min_included' => { 'name' => 'Show included minutes as an invoice detail',
+                             'type' => 'checkbox',
+                    },
+
     'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
                     },
 
@@ -168,9 +173,13 @@ tie my %accountcode_tollfree_field, 'Tie::IxHash',
                          },
 
     'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to this cdrtypenum: ',
+                          'validate' => \&FS::part_pkg::validate_number_blank,
+                          'js_validate' => 'digits: true',
                          },
     
     'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to this cdrtypenum: ',
+                             'validate' => \&FS::part_pkg::validate_number_blank,
+                             'js_validate' => 'digits: true',
                          },
 
     'use_calltypenum' => { 'name' => 'Only charge for CDRs where the CDR Call Type is set to this calltypenum: ',
@@ -185,10 +194,19 @@ tie my %accountcode_tollfree_field, 'Tie::IxHash',
     'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
                          },
 
-    'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
+    'disposition_prefix' => { 'name' => 'Only charge for CDRs where the Disposition starts with: ',
+                         },
+
+    'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these (comma-separated) 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_prefix' => { 'name' => 'Do not charge for CDRs where dcontext starts with: ',
+                       },
+
+    '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:',
@@ -288,6 +306,9 @@ tie my %accountcode_tollfree_field, 'Tie::IxHash',
     'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period',
                                'type' => 'checkbox',
                              },
+    'skip_old' => { 'name' => 'Do not charge for CDRs older than: ',
+                    'type' => 'date',
+                  },
 
     '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',
@@ -325,7 +346,8 @@ tie my %accountcode_tollfree_field, 'Tie::IxHash',
                        cdr_svc_method
                        rating_method rounding ratenum intrastate_ratenum 
                        calls_included
-                       min_charge min_included sec_granularity
+                       min_charge min_included show_min_included
+                       sec_granularity
                        ignore_unrateable
                        default_prefix
                        disable_src
@@ -335,8 +357,9 @@ tie my %accountcode_tollfree_field, 'Tie::IxHash',
                        use_carrierid 
                        use_cdrtypenum ignore_cdrtypenum
                        use_calltypenum ignore_calltypenum
-                       ignore_disposition disposition_in
-                       skip_dcontext skip_dst_prefix 
+                       ignore_disposition disposition_in disposition_prefix
+                       skip_dcontext skip_dcontext_prefix skip_dcontext_suffix
+                       skip_dst_prefix 
                        skip_dstchannel_prefix skip_src_length_more 
                        noskip_src_length_accountcode_tollfree
                        accountcode_tollfree_ratenum accountcode_tollfree_field
@@ -351,11 +374,18 @@ tie my %accountcode_tollfree_field, 'Tie::IxHash',
                        selfservice_format selfservice_inbound_format
                        usage_mandate usage_section summarize_usage 
                        usage_showzero bill_every_call bill_inactive_svcs
-                       bill_only_pkg_dates
+                       bill_only_pkg_dates skip_old
                        count_available_phones suspend_bill 
                      )
                   ],
   'weight' => 41,
+  'validate' => sub {
+    # Validation function for FS::part_pkg::check_options()
+    my $options = shift;
+    return "Please choose a Rate Plan for use with selected Rating Method"
+      if $options->{rating_method} eq 'prefix' &&  !$options->{ratenum};
+    return;
+  },
 );
 
 sub price_info {
@@ -401,10 +431,11 @@ sub calc_usage {
 
   my $charges = 0;
 
-  my $included_min = $self->option('min_included', 1) || 0;
+  my $included_min_total = ($self->option('min_included', 1) || 0)
+                           * ($cust_pkg->quantity || 1);
     #single price rating
     #or region group
-  $included_min *= ($cust_pkg->quantity || 1);
+  my $included_min_left = $included_min_total;
 
   my $included_calls = $self->option('calls_included', 1) || 0;
   $included_calls *= ($cust_pkg->quantity || 1);
@@ -423,7 +454,8 @@ sub calc_usage {
 
   my $formatter = FS::detail_format->new($output_format,
     buffer => $details,
-    locale => $cust_pkg->cust_main->locale
+    locale => $cust_pkg->cust_main->locale,
+    rounding  => ($self->option_cacheable('rounding') || 2),
   );
 
   my $use_duration = $self->option('use_duration');
@@ -499,7 +531,7 @@ sub calc_usage {
         'part_pkg'                          => $self,
         'cust_pkg'                          => $cust_pkg,
         'svcnum'                            => $svc_x->svcnum,
-        'plan_included_min'                 => \$included_min,
+        'plan_included_min'                 => \$included_min_left,
         'detail_included_min_hashref'       => \%detail_included_min,
       );
       die $error if $error; #??
@@ -540,6 +572,16 @@ sub calc_usage {
   $formatter->finish; #writes into $details
   unshift @$details, $formatter->header if @$details;
 
+  if ( $self->option_cacheable('show_min_included', 1)
+       and $included_min_total > 0 ) {
+
+    my $min_detail = sprintf('%d / %d ',
+                       $included_min_total - $included_min_left,
+                       $included_min_total
+                     ) .  $cust_pkg->mt('included minutes used');
+    unshift @$details, $min_detail;
+  }
+
   $charges;
 }
 
@@ -554,7 +596,13 @@ sub check_chargable {
   return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
     if $self->option_cacheable('disposition_in') =~ /\S/
     && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
-  
+
+  my $disposition_prefix = $self->option_cacheable('disposition_prefix');
+  my $len_dis_prefix = length($disposition_prefix);
+  return "disposition does not start with $disposition_prefix"
+    if $len_dis_prefix
+    && substr($cdr->disposition, 0, $len_dis_prefix) ne $disposition_prefix;
+
   return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
     if $self->option_cacheable('ignore_disposition') =~ /\S/
     && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
@@ -591,6 +639,17 @@ sub check_chargable {
     if $self->option_cacheable('skip_dcontext') =~ /\S/
     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
 
+  my $len_dcontext_prefix =
+    length($self->option_cacheable('skip_dcontext_prefix'));
+  return "dcontext starts with ". $self->option_cacheable('skip_dcontext_prefix')
+    if $len_dcontext_prefix
+    && substr($cdr->dcontext,0,$len_dcontext_prefix) eq $self->option_cacheable('skip_dcontext_prefix');
+
+  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
@@ -631,6 +690,10 @@ sub check_chargable {
       and length($cdr->max_callers)
       and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
 
+  return "calldate < ". $self->option_cacheable('skip_old')
+    if length($self->option_cacheable('skip_old'))
+    && $cdr->calldate_unix < str2time($self->option_cacheable('skip_old')); 
+
   #all right then, rate it
   '';
 }
@@ -710,4 +773,3 @@ sub hide_svc_detail {
 
 
 1;
-