by his noodly appendage, i hope this is just a precendece problem, RT#4502
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
index 8bfeeeb..5648d61 100644 (file)
@@ -54,16 +54,22 @@ tie my %temporalities, 'Tie::IxHash',
                                    ' of service at cancellation',
                          'type' => 'checkbox',
                        },
+
+    'rating_method' => { 'name' => 'Region rating method',
+                         'type' => 'radio',
+                         'options' => \%rating_method,
+                       },
+
     'ratenum'   => { 'name' => 'Rate plan',
                      'type' => 'select',
                      'select_table' => 'rate',
                      'select_key'   => 'ratenum',
                      'select_label' => 'ratename',
                    },
-    'rating_method' => { 'name' => 'Region rating method',
-                         'type' => 'radio',
-                         'options' => \%rating_method,
-                       },
+
+    'ignore_unrateable' => { 'name' => 'Ignore calls without a rate in the rate tables.  By default, the system will throw a fatal error upon encountering unrateable calls.',
+                             'type' => 'checkbox',
+                           },
 
     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
                           'default' => '+1',
@@ -111,10 +117,10 @@ tie my %temporalities, 'Tie::IxHash',
                           'type' => 'checkbox',
                         },
 
-    '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes: ',
+    '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
                       },
 
-    'output_format' => { 'name' => 'Simple output format',
+    'output_format' => { 'name' => 'CDR invoice display format',
                          'type' => 'select',
                          'select_options' => { FS::cdr::invoice_formats() },
                          'default'        => 'default', #XXX test
@@ -157,7 +163,7 @@ tie my %temporalities, 'Tie::IxHash',
   },
   'fieldorder' => [qw(
                        setup_fee recur_fee recur_temporality unused_credit
-                       rating_method ratenum 
+                       rating_method ratenum ignore_unrateable
                        default_prefix
                        disable_src
                        domestic_prefix international_prefix
@@ -198,11 +204,28 @@ sub calc_recur {
 
   my $downstream_cdr = '';
 
-  my $rating_method = $self->option('rating_method') || 'prefix';
-
-  my $output_format =
-    $self->option('output_format', 'Hush!')
-    || ( $rating_method eq 'upstream_simple' ? 'simple' : 'default' );
+  my $rating_method     = $self->option('rating_method') || 'prefix';
+  my $intl              = $self->option('international_prefix') || '011';
+  my $domestic_prefix   = $self->option('domestic_prefix');
+  my $disable_tollfree  = $self->option('disable_tollfree');
+  my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
+  my $use_duration      = $self->option('use_duration');
+
+  my $output_format     = $self->option('output_format', 'Hush!')
+                          || ( $rating_method eq 'upstream_simple'
+                                 ? 'simple'
+                                 : 'default'
+                             );
+
+  my @dirass = ();
+  if ( $self->option('411_rewrite') ) {
+    my $dirass = $self->option('411_rewrite');
+    $dirass =~ s/\s//g;
+    @dirass = split(',', $dirass);
+  }
+
+  #for check_chargable, so we don't keep looking up options inside the loop
+  my %opt_cache = ();
 
   eval "use Text::CSV_XS;";
   die $@ if $@;
@@ -213,9 +236,10 @@ sub calc_recur {
   ) {
 
     foreach my $cdr (
-      $cust_svc->get_cdrs_for_update( 'disable_src'    => $self->option('disable_src'),
-                                      'default_prefix' => $self->option('default_prefix'),
-                                    )  # $last_bill, $$sdate )
+      $cust_svc->get_cdrs_for_update(
+        'disable_src'    => $self->option('disable_src'),
+        'default_prefix' => $self->option('default_prefix'),
+      )  # $last_bill, $$sdate )
     ) {
       if ( $DEBUG > 1 ) {
         warn "rating CDR $cdr\n".
@@ -230,56 +254,32 @@ sub calc_recur {
       my @call_details = ();
       if ( $rating_method eq 'prefix' ) {
 
-        #should have some better way of checking these options than a long
-        #if-else tree...
-        my $notchg = "not charging for CDR";
-
-        if ( $self->option('use_amaflags') && $cdr->amaflags != 2 ) {
-
-          warn "$notchg (amaflags != 2)\n" if $DEBUG;
-          $charge = 0;
-
-        } elsif ( $self->option('use_disposition')
-                  && $cdr->disposition ne 'ANSWERED' ) {
-
-          warn "$notchg (disposition != ANSWERED)\n" if $DEBUG;
-          $charge = 0;
-
-        } elsif ( $self->option('use_disposition_taqua')
-                  && $cdr->disposition != 100 ) {
-
-          warn "$notchg (disposition != 100)\n" if $DEBUG;
-          $charge = 0;
-
-        } elsif ( $self->option('use_carrierid')
-                  && $cdr->carrierid != $self->option('use_carrierid') ) {
+        my $da_rewrote = 0;
+        if ( scalar(@dirass) && $cdr->dst && grep { $cdr->dst eq $_ } @dirass ){
+          $cdr->dst('411');
+          $da_rewrote = 1;
+        }
 
-          warn "$notchg (carrierid != ". $self->option('use_carrierid'). ")\n"
-            if $DEBUG;
-          $charge = 0;
+        my $reason = $self->check_chargable( $cdr,
+                                             'da_rewrote'   => $da_rewrote,
+                                             'option_cache' => \%opt_cache,
+                                           );
 
-        } elsif ( $self->option('use_cdrtypenum')
-                  && $cdr->cdrtypenum != $self->option('use_cdrtypenum') ) {
+        if ( $reason ) {
 
-          warn "$notchg (cdrtypenum != ". $self->option('use_cdrtypenum'). ")\n"
-            if $DEBUG;
+          warn "not charging for CDR ($reason)\n" if $DEBUG;
           $charge = 0;
 
         } else {
-
+          
           ###
           # look up rate details based on called station id
           # (or calling station id for toll free calls)
           ###
 
-          if ( $self->option('411_rewrite') ) {
-            my @dirass = split(/\s*,\s*/, $self->option('411_rewrite'));
-            $cdr->dst('411') if grep $cdr->dst eq $_, @dirass;
-          }
-
           my( $to_or_from, $number );
           if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
-               && ! $self->option('disable_tollfree')
+               && ! $disable_tollfree
               )
           { #tollfree call
             $to_or_from = 'from';
@@ -298,8 +298,6 @@ sub calc_recur {
 #          my $siphost = '';
 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 
-          my $intl = $self->option('international_prefix') || '011';
-
           #determine the country code
           my $countrycode;
           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
@@ -321,7 +319,7 @@ sub calc_recur {
             }
 
           } else {
-            $countrycode = $self->option('domestic_prefix') || '1';
+            $countrycode = $domestic_prefix || '1';
             $number =~ s/^$countrycode//;# if length($number) > 10;
           }
 
@@ -335,12 +333,27 @@ sub calc_recur {
                                               'phonenum'    => $number,
                                             });
 
-          $rate_region = $rate_detail->dest_region;
-          $regionnum = $rate_region->regionnum;
+          if ( $rate_detail ) {
 
-          warn "  found rate for regionnum $regionnum ".
-               "and rate detail $rate_detail\n"
-            if $DEBUG;
+            warn "  found rate for regionnum $regionnum ".
+                 "and rate detail $rate_detail\n"
+              if $DEBUG;
+            $rate_region = $rate_detail->dest_region;
+            $regionnum = $rate_region->regionnum;
+
+          } elsif ( $ignore_unrateable ) {
+
+            $rate_region = '';
+            $regionnum = '';
+            #code below will throw a warning & skip
+
+          } else {
+
+            die "FATAL: no rate_detail found in ".
+                $rate->ratenum. ":". $rate->ratename. " rate plan ".
+                "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
+                "add a rate or set ignore_unrateable flag on the package def\n";
+          }
 
         }
 
@@ -381,7 +394,10 @@ sub calc_recur {
         $charge = sprintf('%.3f', $cdr->upstream_price);
         $charges += $charge;
 
-        @call_details = ($cdr->downstream_csv( 'format' => $output_format ));
+        @call_details = ($cdr->downstream_csv( 'format' => $output_format,
+                                               'charge' => $charge,
+                                             )
+                        );
         $classnum = $cdr->calltypenum;
 
       } else {
@@ -393,13 +409,13 @@ sub calc_recur {
       ###
 
       # if $rate_detail is not found, skip this CDR... i.e. 
-      # don't add it to invoice, don't set its status to NULL,
+      # don't add it to invoice, don't set its status to done,
       # don't call downstream_csv or something on it...
       # but DO emit a warning...
       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
       if ( ! $rate_detail && $charge eq '' ) {
 
-        warn "no rate_detail found for CDR.acctid:  ". $cdr->acctid.
+        warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
              "; skipping\n"
 
       } else { # there *is* a rate_detail (or call_details), proceed...
@@ -412,9 +428,7 @@ sub calc_recur {
           my $granularity = $rate_detail->sec_granularity;
 
                       # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
-          my $seconds = $self->option('use_duration')
-                          ? $cdr->duration
-                          : $cdr->billsec;
+          my $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
 
           $seconds += $granularity - ( $seconds % $granularity )
             if $seconds      # don't granular-ize 0 billsec calls (bills them)
@@ -519,6 +533,47 @@ sub calc_recur {
   $charges;
 }
 
+#returns a reason why not to rate this CDR, or false if the CDR is chargeable
+sub check_chargable {
+  my( $self, $cdr, %flags ) = @_;
+
+  #should have some better way of checking these options from a hash
+  #or something
+
+  my @opt = qw(
+    use_amaflags
+    use_disposition
+    use_disposition_taqua
+    use_carrierid
+    use_cdrtypenum
+  );
+  foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
+    $flags{option_cache}->{$opt} = $self->option($opt);
+  }
+  my %opt = %{ $flags{option_cache} };
+
+  return 'amaflags != 2'
+    if $opt{'use_amaflags'} && $cdr->amaflags != 2;
+
+  return 'disposition != ANSWERED'
+    if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
+
+  return "disposition != 100"
+    if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
+
+  return "carrierid != $opt{'use_carrierid'}"
+    if $opt{'use_carrierid'}
+    && $cdr->carrierid != $opt{'use_carrierid'}
+    && ! $flags{'da_rewrote'};
+
+  return "cdrtypenum != $opt{'use_cdrtypenum'}"
+    if $opt{'use_cdrtypenum'}
+    && $cdr->cdrtypenum != $opt{'use_cdrtypenum'};
+
+  #all right then, rate it
+  '';
+}
+
 sub is_free {
   0;
 }