respect output_format and add an header for rating_method=prefix too, RT#4387
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
index 0ceaac1..79e50b5 100644 (file)
@@ -8,8 +8,9 @@ use FS::Conf;
 use FS::Record qw(qsearchs qsearch);
 use FS::part_pkg::flat;
 use FS::cdr;
-#use FS::rate;
-#use FS::rate_prefix;
+use FS::rate;
+use FS::rate_prefix;
+use FS::rate_detail;
 
 @ISA = qw(FS::part_pkg::flat);
 
@@ -116,6 +117,7 @@ tie my %temporalities, 'Tie::IxHash',
     'output_format' => { 'name' => 'Simple output format',
                          'type' => 'select',
                          'select_options' => { FS::cdr::invoice_formats() },
+                         'default'        => 'default', #XXX test
                        },
 
     'usage_section' => { 'name' => 'Section in which to place separate usage charges',
@@ -125,6 +127,10 @@ tie my %temporalities, 'Tie::IxHash',
                           'type' => 'checkbox',
                         },
 
+    'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
+                           'type' => 'checkbox',
+                         },
+
     #XXX also have option for an external db
 #    'cdr_location' => { 'name' => 'CDR database location'
 #                        'type' => 'select',
@@ -161,6 +167,7 @@ tie my %temporalities, 'Tie::IxHash',
                        use_duration
                        411_rewrite
                        output_format summarize_usage usage_section
+                       bill_every_call
                      )
                   ],
   'weight' => 40,
@@ -191,8 +198,11 @@ sub calc_recur {
 
   my $downstream_cdr = '';
 
-  my $output_format = $self->option('output_format', 'Hush!')
-                      || 'simple';
+  my $rating_method = $self->option('rating_method') || 'prefix';
+
+  my $output_format =
+    $self->option('output_format', 'Hush!')
+    || ( $rating_method eq 'upstream_simple' ? 'simple' : 'default' );
 
   eval "use Text::CSV_XS;";
   die $@ if $@;
@@ -218,10 +228,7 @@ sub calc_recur {
       my $charge = '';
       my $classnum = '';
       my @call_details = ();
-      if ( $self->option('rating_method') eq 'prefix'
-           || ! $self->option('rating_method')
-         )
-      {
+      if ( $rating_method eq 'prefix' ) {
 
         #should have some better way of checking these options than a long
         #if-else tree...
@@ -321,32 +328,15 @@ sub calc_recur {
           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
           $pretty_destnum = "+$countrycode $number";
 
-          #find a rate prefix, first look at most specific (4 digits) then 3, etc.,
-          # finally trying the country code only
-          my $rate_prefix = '';
-          for my $len ( reverse(1..6) ) {
-            $rate_prefix = qsearchs('rate_prefix', {
-              'countrycode' => $countrycode,
-              #'npa'         => { op=> 'LIKE', value=> substr($number, 0, $len) }
-              'npa'         => substr($number, 0, $len),
-            } ) and last;
-          }
-          $rate_prefix ||= qsearchs('rate_prefix', {
-            'countrycode' => $countrycode,
-            'npa'         => '',
-          });
-
-          #
-          die "Can't find rate for call $to_or_from +$countrycode $number\n"
-            unless $rate_prefix;
+          my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
+            or die "ratenum $ratenum not found!";
 
-          $regionnum = $rate_prefix->regionnum;
-          $rate_detail = qsearchs('rate_detail', {
-            'ratenum'        => $ratenum,
-            'dest_regionnum' => $regionnum,
-          } );
+          $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
+                                              'phonenum'    => $number,
+                                            });
 
-          $rate_region = $rate_prefix->rate_region;
+          $rate_region = $rate_detail->dest_region;
+          $regionnum = $rate_region->regionnum;
 
           warn "  found rate for regionnum $regionnum ".
                "and rate detail $rate_detail\n"
@@ -354,7 +344,7 @@ sub calc_recur {
 
         }
 
-      } elsif ( $self->option('rating_method') eq 'upstream' ) {
+      } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used.  very much becoming the odd one out. remove?
 
         if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
 
@@ -385,7 +375,7 @@ sub calc_recur {
 
         }
 
-      } elsif ( $self->option('rating_method') eq 'upstream_simple' ) {
+      } elsif ( $rating_method eq 'upstream_simple' ) {
 
         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
         $charge = sprintf('%.3f', $cdr->upstream_price);
@@ -394,8 +384,7 @@ sub calc_recur {
         @call_details = ($cdr->downstream_csv( 'format' => $output_format ));
 
       } else {
-        die "don't know how to rate CDRs using method: ".
-            $self->option('rating_method'). "\n";
+        die "don't know how to rate CDRs using method: $rating_method\n";
       }
 
       ###
@@ -406,7 +395,7 @@ sub calc_recur {
       # don't add it to invoice, don't set its status to NULL,
       # don't call downstream_csv or something on it...
       # but DO emit a warning...
-      #if ( ! $rate_detail && ! scalar(@call_details) ) {
+      #if ( ! $rate_detail && ! scalar(@call_details) ) {}
       if ( ! $rate_detail && $charge eq '' ) {
 
         warn "no rate_detail found for CDR.acctid:  ". $cdr->acctid.
@@ -448,12 +437,13 @@ sub calc_recur {
           warn "  (rate region $rate_region)\n" if $DEBUG;
 
           @call_details = (
-            #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
-            time2str("%c", $cdr->calldate_unix),  #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot
-            $granularity ? $minutes.'m' : $minutes.' call',
-            '$'.$charge,
-            $pretty_destnum,
-            $rate_region->regionname,
+           $cdr->downstream_csv( 'format'         => $output_format,
+                                 'granularity'    => $granularity,
+                                 'minutes'        => $minutes,
+                                 'charge'         => $charge,
+                                 'pretty_dst'     => $pretty_destnum,
+                                 'dst_regionname' => $rate_region->regionname,
+                               )
           );
 
           $classnum = $rate_detail->classnum;
@@ -463,9 +453,11 @@ sub calc_recur {
         if ( $charge > 0 ) {
           #just use FS::cust_bill_pkg_detail objects?
           my $call_details;
-          if ( $self->option('rating_method') eq 'upstream_simple' ) {
+
+          #if ( $self->option('rating_method') eq 'upstream_simple' ) {
+          if ( scalar(@call_details) == 1 ) {
             $call_details = [ 'C', $call_details[0], $charge, $classnum ];
-          }else{
+          } else { #only used for $rating_method eq 'upstream' now
             $csv->combine(@call_details);
             $call_details = [ 'C', $csv->string, $charge, $classnum ];
           }
@@ -488,11 +480,11 @@ sub calc_recur {
 
     } # $cdr
 
-    unshift @$details, [ 'C', FS::cdr::invoice_header( $output_format) ]
-      if (@$details && $self->option('rating_method') eq 'upstream_simple' );
-
   } # $cust_svc
 
+  unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
+    if @$details && $rating_method ne 'upstream';
+
   if ( $spool_cdr && length($downstream_cdr) ) {
 
     use FS::UID qw(datasrc);
@@ -520,8 +512,10 @@ sub calc_recur {
 
   } #if ( $spool_cdr && length($downstream_cdr) )
 
-  $self->option('recur_fee') + $charges;
+  $charges += $self->option('recur_fee')
+    if $param->{'increment_next_bill'};
 
+  $charges;
 }
 
 sub is_free {