get rid of cdr_upstream_rate table and some other old convergent cruft
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
index 2325e69..929a2d7 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;
@@ -18,8 +19,15 @@ $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',
-  'upstream' => 'Rate calls based on upstream data: If the call type is "1", map the upstream rate ID directly to an internal rate (rate_detail), otherwise, pass the upstream price through directly.',
+#  'upstream' => 'Rate calls based on upstream data: If the call type is "1", map the upstream rate ID directly to an internal rate (rate_detail), otherwise, pass the upstream price through directly.',
   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
+  'flat' => 'A single price per minute for all calls.',
+;
+
+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',
@@ -55,14 +63,18 @@ tie my %temporalities, 'Tie::IxHash',
                          'type' => 'checkbox',
                        },
 
-    'enable_prorate' => { 'name' => 'Enable prorating of the first month',
-                          'type' => 'checkbox',
-                        },
-
-    'cutoff_day'    => { 'name' => 'Billing Day (1 - 28) for prorating ',
+    '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,
@@ -187,7 +199,7 @@ tie my %temporalities, 'Tie::IxHash',
   },
   'fieldorder' => [qw(
                        setup_fee recur_fee recur_temporality unused_credit
-                       enable_prorate cutoff_day
+                       recur_method cutoff_day
                        rating_method ratenum ignore_unrateable
                        default_prefix
                        disable_src
@@ -232,7 +244,7 @@ sub calc_recur {
 
   my $charges = 0;
 
-  my $downstream_cdr = '';
+#  my $downstream_cdr = '';
 
   my $rating_method     = $self->option('rating_method') || 'prefix';
   my $intl              = $self->option('international_prefix') || '011';
@@ -308,9 +320,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;
@@ -387,36 +397,36 @@ sub calc_recur {
 
         }
 
-      } 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
-
-          $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
-
-          $regionnum = $rate_detail->dest_regionnum;
-          $rate_region = $rate_detail->dest_region;
-
-          $pretty_destnum = $cdr->dst;
-
-          warn "  found rate for regionnum $regionnum and ".
-               "rate detail $rate_detail\n"
-            if $DEBUG;
-
-        } else { #pass upstream price through
-
-          $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
-            'N/A', #minutes...
-            '$'.$charge,
-            #$pretty_destnum,
-            $cdr->description, #$rate_region->regionname,
-          );
-
-        }
+#      } 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
+#
+#          $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
+#
+#          $regionnum = $rate_detail->dest_regionnum;
+#          $rate_region = $rate_detail->dest_region;
+#
+#          $pretty_destnum = $cdr->dst;
+#
+#          warn "  found rate for regionnum $regionnum and ".
+#               "rate detail $rate_detail\n"
+#            if $DEBUG;
+#
+#        } else { #pass upstream price through
+#
+#          $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
+#            'N/A', #minutes...
+#            '$'.$charge,
+#            #$pretty_destnum,
+#            $cdr->description, #$rate_region->regionname,
+#          );
+#
+#        }
 
       } elsif ( $rating_method eq 'upstream_simple' ) {
 
@@ -517,8 +527,8 @@ sub calc_recur {
         # if the customer flag is on, call "downstream_csv" or something
         # like it to export the call downstream!
         # XXX price plan option to pick format, or something...
-        $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
-          if $spool_cdr;
+        #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
+        #  if $spool_cdr;
 
         my $error = $cdr->set_status_and_rated_price('done', $charge);
         die $error if $error;
@@ -532,40 +542,59 @@ sub calc_recur {
   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);
-    my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
-    mkdir $dir, 0700 unless -d $dir;
-    $dir .= '/'. $cust_pkg->custnum.
-    mkdir $dir, 0700 unless -d $dir;
-    my $filename = time2str("$dir/CDR%Y%m%d-spool.CSV", time); #XXX invoice date instead?  would require changing the order things are generated in cust_main::bill insert cust_bill first - with transactions it could be done though
-
-    push @{ $param->{'precommit_hooks'} },
-         sub {
-               #lock the downstream spool file and append the records 
-               use Fcntl qw(:flock);
-               use IO::File;
-               my $spool = new IO::File ">>$filename"
-                 or die "can't open $filename: $!\n";
-               flock( $spool, LOCK_EX)
-                 or die "can't lock $filename: $!\n";
-               seek($spool, 0, 2)
-                 or die "can't seek to end of $filename: $!\n";
-               print $spool $downstream_cdr;
-               flock( $spool, LOCK_UN );
-               close $spool;
-             };
-
-  } #if ( $spool_cdr && length($downstream_cdr) )
+#  if ( $spool_cdr && length($downstream_cdr) ) {
+#
+#    use FS::UID qw(datasrc);
+#    my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
+#    mkdir $dir, 0700 unless -d $dir;
+#    $dir .= '/'. $cust_pkg->custnum.
+#    mkdir $dir, 0700 unless -d $dir;
+#    my $filename = time2str("$dir/CDR%Y%m%d-spool.CSV", time); #XXX invoice date instead?  would require changing the order things are generated in cust_main::bill insert cust_bill first - with transactions it could be done though
+#
+#    push @{ $param->{'precommit_hooks'} },
+#         sub {
+#               #lock the downstream spool file and append the records 
+#               use Fcntl qw(:flock);
+#               use IO::File;
+#               my $spool = new IO::File ">>$filename"
+#                 or die "can't open $filename: $!\n";
+#               flock( $spool, LOCK_EX)
+#                 or die "can't lock $filename: $!\n";
+#               seek($spool, 0, 2)
+#                 or die "can't seek to end of $filename: $!\n";
+#               print $spool $downstream_cdr;
+#               flock( $spool, LOCK_UN );
+#               close $spool;
+#             };
+#
+#  } #if ( $spool_cdr && length($downstream_cdr) )
 
   if ($param->{'increment_next_bill'}) {
-    if ( $self->option('enable_prorate', 1) ) {
+    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')
-    }
-  }
+
+      $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;
 }
@@ -589,7 +618,7 @@ sub check_chargable {
     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} };