prepaid cdr pickup & bill daemon, RT#4184
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
index 14f812f..a3b54ee 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);
 
@@ -27,6 +28,11 @@ tie my %rating_method, 'Tie::IxHash',
 #                'Asterisk (or other?) CDR table',
 #;
 
+tie my %temporalities, 'Tie::IxHash',
+  'upcoming'  => "Upcoming (future)",
+  'preceding' => "Preceding (past)",
+;
+
 %info = (
   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
   'shortname' => 'VoIP/telco CDR rating (standard)',
@@ -37,6 +43,13 @@ tie my %rating_method, 'Tie::IxHash',
     'recur_fee'     => { 'name' => 'Base recurring fee for this package',
                          'default' => 0,
                        },
+
+    #false laziness w/flat.pm
+    'recur_temporality' => { 'name' => 'Charge recurring fee for period',
+                             'type' => 'select',
+                             'select_options' => \%temporalities,
+                           },
+
     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
                                    ' of service at cancellation',
                          'type' => 'checkbox',
@@ -72,6 +85,10 @@ tie my %rating_method, 'Tie::IxHash',
                                 'default' => '011',
                               },
 
+    'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
+                            'type' => 'checkbox',
+                          },
+
     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
                         'type' => 'checkbox',
                       },
@@ -80,15 +97,39 @@ tie my %rating_method, 'Tie::IxHash',
                            'type' => 'checkbox',
                          },
 
+    'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
+                                 'type' => 'checkbox',
+                               },
+
+    'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
+                         },
+
+    'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
+                         },
+
+    'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
+                          'type' => 'checkbox',
+                        },
+
+    '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes: ',
+                      },
+
     'output_format' => { 'name' => 'Simple output format',
                          'type' => 'select',
                          'select_options' => { FS::cdr::invoice_formats() },
                        },
 
-    'separate_usage' => { 'name' => 'Separate usage charges from recurring charges',
+    'usage_section' => { 'name' => 'Section in which to place separate usage charges',
+                       },
+
+    'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
                           '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',
@@ -114,13 +155,18 @@ tie my %rating_method, 'Tie::IxHash',
 
   },
   'fieldorder' => [qw(
-                       setup_fee recur_fee unused_credit
+                       setup_fee recur_fee recur_temporality unused_credit
                        rating_method ratenum 
                        default_prefix
                        disable_src
                        domestic_prefix international_prefix
-                       use_amaflags use_disposition output_format
-                       separate_usage
+                       disable_tollfree
+                       use_amaflags use_disposition
+                       use_disposition_taqua use_carrierid use_cdrtypenum
+                       use_duration
+                       411_rewrite
+                       output_format summarize_usage usage_section
+                       bill_every_call
                      )
                   ],
   'weight' => 40,
@@ -131,19 +177,15 @@ sub calc_setup {
   $self->option('setup_fee');
 }
 
-sub calc_recur {
-  my $self = shift;
-  my $charges = 0;
-  $charges = $self->calc_usage(@_)
-    unless $self->option('separate_usage', 'Hush!');
-  $self->option('recur_fee') + $charges;
-}
-
 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
-sub calc_usage {
+sub calc_recur {
   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
 
-  my $last_bill = $cust_pkg->last_bill;
+  #my $last_bill = $cust_pkg->last_bill;
+  my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
+
+  return 0
+    if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
 
   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 
@@ -180,21 +222,46 @@ sub calc_usage {
       my( $rate_region, $regionnum );
       my $pretty_destnum;
       my $charge = '';
+      my $classnum = '';
       my @call_details = ();
       if ( $self->option('rating_method') eq 'prefix'
            || ! $self->option('rating_method')
          )
       {
 
+        #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 "not charging for CDR (amaflags != 2)\n" if $DEBUG;
+          warn "$notchg (amaflags != 2)\n" if $DEBUG;
           $charge = 0;
 
         } elsif ( $self->option('use_disposition')
                   && $cdr->disposition ne 'ANSWERED' ) {
 
-          warn "not charging for CDR (disposition != ANSWERED)\n" if $DEBUG;
+          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') ) {
+
+          warn "$notchg (carrierid != ". $self->option('use_carrierid'). ")\n"
+            if $DEBUG;
+          $charge = 0;
+
+        } elsif ( $self->option('use_cdrtypenum')
+                  && $cdr->cdrtypenum != $self->option('use_cdrtypenum') ) {
+
+          warn "$notchg (cdrtypenum != ". $self->option('use_cdrtypenum'). ")\n"
+            if $DEBUG;
           $charge = 0;
 
         } else {
@@ -204,8 +271,16 @@ sub calc_usage {
           # (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/ ) { #tollfree call
+          if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
+               && ! $self->option('disable_tollfree')
+              )
+          { #tollfree call
             $to_or_from = 'from';
             $number = $cdr->src;
           } else { #regular call
@@ -213,6 +288,8 @@ sub calc_usage {
             $number = $cdr->dst;
           }
 
+          warn "parsing call $to_or_from $number\n" if $DEBUG;
+
           #remove non-phone# stuff and whitespace
           $number =~ s/\s//g;
 #          my $proto = '';
@@ -250,32 +327,15 @@ sub calc_usage {
           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"
@@ -335,7 +395,7 @@ sub calc_usage {
       # 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.
@@ -349,7 +409,12 @@ sub calc_usage {
             unless exists $included_min{$regionnum};
 
           my $granularity = $rate_detail->sec_granularity;
-          my $seconds = $cdr->billsec; # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
+
+                      # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
+          my $seconds = $self->option('use_duration')
+                          ? $cdr->duration
+                          : $cdr->billsec;
+
           $seconds += $granularity - ( $seconds % $granularity )
             if $seconds      # don't granular-ize 0 billsec calls (bills them)
             && $granularity; # 0 is per call
@@ -380,15 +445,18 @@ sub calc_usage {
             $rate_region->regionname,
           );
 
+          $classnum = $rate_detail->classnum;
+
         }
 
         if ( $charge > 0 ) {
+          #just use FS::cust_bill_pkg_detail objects?
           my $call_details;
           if ( $self->option('rating_method') eq 'upstream_simple' ) {
-            $call_details = [ 'C', $call_details[0] ];
+            $call_details = [ 'C', $call_details[0], $charge, $classnum ];
           }else{
             $csv->combine(@call_details);
-            $call_details = [ 'C', $csv->string ];
+            $call_details = [ 'C', $csv->string, $charge, $classnum ];
           }
           warn "  adding details on charge to invoice: [ ".
               join(', ', @{$call_details} ). " ]"
@@ -441,8 +509,10 @@ sub calc_usage {
 
   } #if ( $spool_cdr && length($downstream_cdr) )
 
-  $charges;
+  $charges += $self->option('recur_fee')
+    if $param->{'increment_next_bill'};
 
+  $charges;
 }
 
 sub is_free {
@@ -461,33 +531,5 @@ sub calc_units {
   scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 }
 
-sub append_cust_bill_pkgs {
-  my $self = shift;
-  my($cust_pkg, $sdate, $details, $param ) = @_;
-  return []
-    unless $self->option('separate_usage', 'Hush!');
-
-  my @details = ();
-  my $charges = $self->calc_usage($cust_pkg, $sdate, \@details, $param);
-
-  return []
-    unless $charges;  # unless @details?
-
-  my $cust_bill_pkg = new FS::cust_bill_pkg {
-    'pkgnum'    => $cust_pkg->pkgnum,
-    'setup'     => 0,
-    'unitsetup' => 0,
-    'recur'     => sprintf( "%.2f", $charges),  # hmmm
-    'unitrecur' => 0,
-    'quantity'  => $cust_pkg->quantity,
-    'sdate'     => $$sdate,
-    'edate'     => $cust_pkg->bill,             # already fiddled
-    'itemdesc'  => 'Usage charges',             # configurable?
-    'details'   => \@details,
-  };
-
-  return [ $cust_bill_pkg ];
-}
-
 1;