add recur_temporality to flat.pm, RT#3851
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
index c4827c9..03306ad 100644 (file)
@@ -7,6 +7,7 @@ use Tie::IxHash;
 use FS::Conf;
 use FS::Record qw(qsearchs qsearch);
 use FS::part_pkg::flat;
+use FS::cdr;
 #use FS::rate;
 #use FS::rate_prefix;
 
@@ -26,6 +27,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)',
@@ -36,6 +42,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',
@@ -79,6 +92,31 @@ 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: ',
+                         },
+
+    '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() },
+                       },
+
+    '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',
+                        },
+
     #XXX also have option for an external db
 #    'cdr_location' => { 'name' => 'CDR database location'
 #                        'type' => 'select',
@@ -104,12 +142,15 @@ 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
+                       use_disposition_taqua use_carrierid use_cdrtypenum
+                       411_rewrite
+                       output_format summarize_usage usage_section
                      )
                   ],
   'weight' => 40,
@@ -120,11 +161,15 @@ sub calc_setup {
   $self->option('setup_fee');
 }
 
-#false laziness w/voip_sqlradacct... resolve it if that one ever gets used again
+#false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 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') eq 'preceding' && $last_bill == 0;
 
   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 
@@ -136,12 +181,21 @@ sub calc_recur {
 
   my $downstream_cdr = '';
 
+  my $output_format = $self->option('output_format', 'Hush!')
+                      || 'simple';
+
+  eval "use Text::CSV_XS;";
+  die $@ if $@;
+  my $csv = new Text::CSV_XS;
+
   foreach my $cust_svc (
     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
   ) {
 
     foreach my $cdr (
-      $cust_svc->get_cdrs_for_update()  # $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".
@@ -152,21 +206,46 @@ sub calc_recur {
       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 {
@@ -176,6 +255,11 @@ sub calc_recur {
           # (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
             $to_or_from = 'from';
@@ -274,7 +358,7 @@ sub calc_recur {
 
           $charge = sprintf('%.2f', $cdr->upstream_price);
           $charges += $charge;
-
           @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
@@ -292,15 +376,7 @@ sub calc_recur {
         $charge = sprintf('%.3f', $cdr->upstream_price);
         $charges += $charge;
 
-        @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
-          sprintf('%.2f', $cdr->billsec / 60 ).'m',
-          '$'.$charge, #XXX $money_char
-          #$pretty_destnum,
-          $cdr->userfield, #$rate_region->regionname,
-          $cdr->dst,
-        );
+        @call_details = ($cdr->downstream_csv( 'format' => $output_format ));
 
       } else {
         die "don't know how to rate CDRs using method: ".
@@ -360,12 +436,22 @@ sub calc_recur {
             $rate_region->regionname,
           );
 
+          $classnum = $rate_detail->classnum;
+
         }
 
         if ( $charge > 0 ) {
-          my $call_details = join(' - ', @call_details );
-          warn "  adding details on charge to invoice: $call_details"
-            if $DEBUG;
+          #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], $charge, $classnum ];
+          }else{
+            $csv->combine(@call_details);
+            $call_details = [ 'C', $csv->string, $charge, $classnum ];
+          }
+          warn "  adding details on charge to invoice: [ ".
+              join(', ', @{$call_details} ). " ]"
+            if ( $DEBUG && ref($call_details) );
           push @$details, $call_details; #\@call_details,
         }
 
@@ -382,6 +468,9 @@ sub calc_recur {
 
     } # $cdr
 
+    unshift @$details, [ 'C', FS::cdr::invoice_header( $output_format) ]
+      if (@$details && $self->option('rating_method') eq 'upstream_simple' );
+
   } # $cust_svc
 
   if ( $spool_cdr && length($downstream_cdr) ) {