bulk provisioning via ftp and SOAP #5202
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
index 5648d61..1195b16 100644 (file)
@@ -4,6 +4,7 @@ use strict;
 use vars qw(@ISA $DEBUG %info);
 use Date::Format;
 use Tie::IxHash;
+use Time::Local;
 use FS::Conf;
 use FS::Record qw(qsearchs qsearch);
 use FS::part_pkg::flat;
@@ -12,9 +13,9 @@ use FS::rate;
 use FS::rate_prefix;
 use FS::rate_detail;
 
-@ISA = qw(FS::part_pkg::flat);
+@ISA = qw(FS::part_pkg::prorate);
 
-$DEBUG = 1;
+$DEBUG = 0;
 
 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',
@@ -22,6 +23,12 @@ tie my %rating_method, 'Tie::IxHash',
   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
 ;
 
+tie my %recur_method, 'Tie::IxHash',
+  'anniversary' => 'Charge the recurring fee at the frequency specified above',
+  'prorate' => 'Charge a prorated fee the first time (selectable billing date)',
+  'subscription' => 'Charge the full fee for the first partial period (selectable billing date)',
+;
+
 #tie my %cdr_location, 'Tie::IxHash',
 #  'internal' => 'Internal: CDR records imported into the internal CDR table',
 #  'external' => 'External: CDR records queried directly from an external '.
@@ -55,6 +62,18 @@ tie my %temporalities, 'Tie::IxHash',
                          'type' => 'checkbox',
                        },
 
+    'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating or '.
+                                   'subscription',
+                         'default' => '1',
+                       },
+
+    'recur_method'  => { 'name' => 'Recurring fee method',
+                         #'type' => 'radio',
+                         #'options' => \%recur_method,
+                         'type' => 'select',
+                         'select_options' => \%recur_method,
+                       },
+
     'rating_method' => { 'name' => 'Region rating method',
                          'type' => 'radio',
                          'options' => \%rating_method,
@@ -113,6 +132,18 @@ tie my %temporalities, 'Tie::IxHash',
     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
                          },
 
+    'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
+                       },
+
+    'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
+                                },
+
+    'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
+                              },
+
+    'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
+                      },
+
     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
                           'type' => 'checkbox',
                         },
@@ -137,6 +168,10 @@ tie my %temporalities, 'Tie::IxHash',
                            'type' => 'checkbox',
                          },
 
+    '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',
+                         },
+
     #XXX also have option for an external db
 #    'cdr_location' => { 'name' => 'CDR database location'
 #                        'type' => 'select',
@@ -163,6 +198,7 @@ tie my %temporalities, 'Tie::IxHash',
   },
   'fieldorder' => [qw(
                        setup_fee recur_fee recur_temporality unused_credit
+                       recur_method cutoff_day
                        rating_method ratenum ignore_unrateable
                        default_prefix
                        disable_src
@@ -170,10 +206,13 @@ tie my %temporalities, 'Tie::IxHash',
                        disable_tollfree
                        use_amaflags use_disposition
                        use_disposition_taqua use_carrierid use_cdrtypenum
+                       skip_dcontext skip_dstchannel_prefix
+                       skip_dst_length_less skip_lastapp
                        use_duration
                        411_rewrite
                        output_format summarize_usage usage_section
                        bill_every_call
+                       count_available_phones
                      )
                   ],
   'weight' => 40,
@@ -186,13 +225,15 @@ sub calc_setup {
 
 #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 $self = shift;
+  my($cust_pkg, $sdate, $details, $param ) = @_;
 
   #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;
+    if $self->option('recur_temporality', 1) eq 'preceding'
+    && ( $last_bill eq '' || $last_bill == 0 );
 
   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 
@@ -255,7 +296,7 @@ sub calc_recur {
       if ( $rating_method eq 'prefix' ) {
 
         my $da_rewrote = 0;
-        if ( scalar(@dirass) && $cdr->dst && grep { $cdr->dst eq $_ } @dirass ){
+        if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
           $cdr->dst('411');
           $da_rewrote = 1;
         }
@@ -278,9 +319,7 @@ sub calc_recur {
           ###
 
           my( $to_or_from, $number );
-          if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
-               && ! $disable_tollfree
-              )
+          if ( $cdr->is_tollfree && ! $disable_tollfree )
           { #tollfree call
             $to_or_from = 'from';
             $number = $cdr->src;
@@ -335,11 +374,11 @@ sub calc_recur {
 
           if ( $rate_detail ) {
 
+            $rate_region = $rate_detail->dest_region;
+            $regionnum = $rate_region->regionnum;
             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 ) {
 
@@ -442,9 +481,11 @@ sub calc_recur {
           $included_min{$regionnum} -= $minutes;
 
           if ( $included_min{$regionnum} < 0 ) {
-            my $charge_min = 0 - $included_min{$regionnum};
+            my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve
+                                                            #(display?) this
             $included_min{$regionnum} = 0;
-            $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
+            $charge = sprintf('%.2f', ( $rate_detail->min_charge * $charge_min )
+                                      + 0.00000001 ); #so 1.005 rounds to 1.01
             $charges += $charge;
           }
 
@@ -527,8 +568,32 @@ sub calc_recur {
 
   } #if ( $spool_cdr && length($downstream_cdr) )
 
-  $charges += $self->option('recur_fee')
-    if $param->{'increment_next_bill'};
+  if ($param->{'increment_next_bill'}) {
+    my $recur_method = $self->option('recur_method', 1) || 'anniversary';
+                  
+    if ( $recur_method eq 'prorate' ) {
+
+      $charges += $self->SUPER::calc_recur(@_);
+
+    } else {
+
+      $charges += $self->option('recur_fee');
+
+      if ( $recur_method eq 'subscription' ) {
+
+        my $cutoff_day = $self->option('cutoff_day', 1) || 1;
+        my ($day, $mon, $year) = ( localtime($$sdate) )[ 3..5 ];
+
+        if ( $day < $cutoff_day ) {
+          if ( $mon == 0 ) { $mon=11; $year--; }
+          else { $mon--; }
+        }
+
+        $$sdate = timelocal(0, 0, 0, $cutoff_day, $mon, $year);
+
+      }#$recur_method eq 'subscription'
+    }#$recur_method eq 'prorate'
+  }#increment_next_bill
 
   $charges;
 }
@@ -546,9 +611,13 @@ sub check_chargable {
     use_disposition_taqua
     use_carrierid
     use_cdrtypenum
+    skip_dcontext
+    skip_dstchannel_prefix
+    skip_dst_length_less
+    skip_lastapp
   );
   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
-    $flags{option_cache}->{$opt} = $self->option($opt);
+    $flags{option_cache}->{$opt} = $self->option($opt, 1);
   }
   my %opt = %{ $flags{option_cache} };
 
@@ -562,13 +631,29 @@ sub check_chargable {
     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
 
   return "carrierid != $opt{'use_carrierid'}"
-    if $opt{'use_carrierid'}
-    && $cdr->carrierid != $opt{'use_carrierid'}
+    if length($opt{'use_carrierid'})
+    && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
     && ! $flags{'da_rewrote'};
 
   return "cdrtypenum != $opt{'use_cdrtypenum'}"
-    if $opt{'use_cdrtypenum'}
-    && $cdr->cdrtypenum != $opt{'use_cdrtypenum'};
+    if length($opt{'use_cdrtypenum'})
+    && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
+
+  return "dcontext IN ( $opt{'skip_dcontext'} )"
+    if $opt{'skip_dcontext'} =~ /\S/
+    && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
+
+  my $len_prefix = length($opt{'skip_dstchannel_prefix'});
+  return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
+    if $len_prefix
+    && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
+
+  my $dst_length = $opt{'skip_dst_length_less'};
+  return "destination less than $dst_length digits"
+    if $dst_length && length($cdr->dst) < $dst_length;
+
+  return "lastapp is $opt{'skip_lastapp'}"
+    if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
 
   #all right then, rate it
   '';
@@ -587,7 +672,16 @@ sub base_recur {
 #  to indicate it represents a line
 sub calc_units {    
   my($self, $cust_pkg ) = @_;
-  scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
+  my $count = 0;
+  if ( $self->option('count_available_phones', 1)) {
+    map { $count += ( $_->quantity || 0 ) }
+      grep { $_->part_svc->svcdb eq 'svc_phone' }
+      $cust_pkg->part_pkg->pkg_svc;
+  } else {
+    $count = 
+      scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
+  }
+  $count;
 }
 
 1;