CDR schema and class
[freeside.git] / FS / FS / part_pkg / voip_sqlradacct.pm
index 3f044eb..bf18003 100644 (file)
@@ -2,36 +2,38 @@ package FS::part_pkg::voip_sqlradacct;
 
 use strict;
 use vars qw(@ISA $DEBUG %info);
+use Date::Format;
 use FS::Record qw(qsearchs qsearch);
-use FS::part_pkg;
+use FS::part_pkg::flat;
 #use FS::rate;
 use FS::rate_prefix;
 
-@ISA = qw(FS::part_pkg);
+@ISA = qw(FS::part_pkg::flat);
 
 $DEBUG = 1;
 
 %info = (
-    'name' => 'VoIP rating by plan of CDR records in an SQL RADIUS radacct table',
-    'fields' => {
-      'setup_fee' => { 'name' => 'Setup fee for this package',
-                       'default' => 0,
-                     },
-      'recur_flat' => { 'name' => 'Base monthly charge for this package',
-                        'default' => 0,
-                      },
-      'ratenum'   => { 'name' => 'Rate plan',
-                       'type' => 'select',
-                       'select_table' => 'rate',
-                       'select_key'   => 'ratenum',
-                       'select_label' => 'ratename',
-                     },
-      'ignore_unrateable' => { 'name' => 'Ignore calls for which not rate prefix can be found (otherwise they are fatal)',
-                               'type' => 'checkbox',
-                             },
-    },
-    'fieldorder' => [qw( setup_fee recur_flat ratenum ignore_unrateable )],
-    'weight' => 40,
+  'name' => 'VoIP rating by plan of CDR records in an SQL RADIUS radacct table',
+  'fields' => {
+    'setup_fee'     => { 'name' => 'Setup fee for this package',
+                         'default' => 0,
+                       },
+    'recur_flat'     => { 'name' => 'Base recurring fee for this package',
+                          'default' => 0,
+                        },
+    'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
+                                   ' of service at cancellation',
+                         'type' => 'checkbox',
+                       },
+    'ratenum'   => { 'name' => 'Rate plan',
+                     'type' => 'select',
+                     'select_table' => 'rate',
+                     'select_key'   => 'ratenum',
+                     'select_label' => 'ratename',
+                   },
+  },
+  'fieldorder' => [qw( setup_fee recur_flat unused_credit ratenum ignore_unrateable )],
+  'weight' => 40,
 );
 
 sub calc_setup {
@@ -39,6 +41,7 @@ sub calc_setup {
   $self->option('setup_fee');
 }
 
+#false laziness w/voip_cdr... resolve it if this one ever gets used again
 sub calc_recur {
   my($self, $cust_pkg, $sdate, $details ) = @_;
 
@@ -57,7 +60,10 @@ sub calc_recur {
     foreach my $session (
       $cust_svc->get_session_history( $last_bill, $$sdate )
     ) {
-      warn "rating session $session" if $DEBUG;
+      if ( $DEBUG > 1 ) {
+        warn "rating session $session\n".
+             join('', map { "  $_ => ". $session->{$_}. "\n" } keys %$session );
+      }
 
       ###
       # look up rate details based on called station id
@@ -69,18 +75,21 @@ sub calc_recur {
       $dest =~ s/\s//g;
       my $proto = '';
       $dest =~ s/^(\w+):// and $proto = $1; #sip:
-      my $ip = '';
-      $dest =~ s/\@((\d{1,3}\.){3}\d{1,3})$// and $ip = $1; # @10.54.32.1
+      my $siphost = '';
+      $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 
       #determine the country code
       my $countrycode;
-      if ( $dest =~ /^011((\d\d)(\d))(\d+)$/ ) {
-
-        my( $three, $two, $unknown, $rest ) = ( $1, $2, $3, $4 );
-        #first look for 2 digit country code
-        if ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) {
+      if ( $dest =~ /^011(((\d)(\d))(\d))(\d+)$/ ) {
+
+        my( $three, $two, $one, $u1, $u2, $rest ) = ( $1, $2, $3, $4, $5, $6 );
+        #first look for 1 digit country code
+        if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
+          $countrycode = $one;
+          $dest = $u1.$u2.$rest;
+        } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
           $countrycode = $two;
-          $dest = $unknown.$rest;
+          $dest = $u2.$rest;
         } else { #3 digit country code
           $countrycode = $three;
           $dest = $rest;
@@ -88,17 +97,19 @@ sub calc_recur {
 
       } else {
         $countrycode = '1';
+        $dest =~ s/^1//;# if length($dest) > 10;
       }
 
-      warn "rating call to +$countrycode $dest" if $DEBUG;
+      warn "rating call to +$countrycode $dest\n" if $DEBUG;
 
       #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..4) ) {
+      for my $len ( reverse(1..6) ) {
         $rate_prefix = qsearchs('rate_prefix', {
           'countrycode' => $countrycode,
-          'npa'         => { op=> 'LIKE', value=> substr($dest, 0, $len) }
+          #'npa'         => { op=> 'LIKE', value=> substr($dest, 0, $len) }
+          'npa'         => substr($dest, 0, $len),
         } ) and last;
       }
       $rate_prefix ||= qsearchs('rate_prefix', {
@@ -106,24 +117,17 @@ sub calc_recur {
         'npa'         => '',
       });
 
-      unless ( $rate_prefix ) {
-        if ( $self->option('ignore_unrateable') ) {
-          warn "  skipping unrateable call to +$countrycode $dest";
-          next;
-        } else {
-          die "Can't find rate for call to +$countrycode $dest\n"
-        }
-      }
+      die "Can't find rate for call to +$countrycode $dest\n"
+        unless $rate_prefix;
 
       my $regionnum = $rate_prefix->regionnum;
-
       my $rate_detail = qsearchs('rate_detail', {
         'ratenum'        => $ratenum,
         'dest_regionnum' => $regionnum,
       } );
 
       warn "  found rate for regionnum $regionnum ".
-           "and rate detail $rate_detail"
+           "and rate detail $rate_detail\n"
         if $DEBUG;
 
       ###
@@ -149,25 +153,23 @@ sub calc_recur {
         $charges += $charge;
       }
 
+      my $rate_region = $rate_prefix->rate_region;
+      warn "  (rate region $rate_region)\n" if $DEBUG;
+
+      my @call_details = (
+        #time2str("%Y %b %d - %r", $session->{'acctstarttime'}),
+        time2str("%c", $session->{'acctstarttime'}),
+        $minutes.'m',
+        '$'.$charge,
+        "+$countrycode $dest",
+        $rate_region->regionname,
+      );
+
       warn "  adding details on charge to invoice: ".
-           join(' - ', 
-             "+$countrycode $dest",
-             $rate_prefix->rate_region->regionname,
-             $minutes.'m',
-             '$'.$charge,
-           )
+           join(' - ', @call_details )
         if $DEBUG;
 
-      push @$details, 
-        #[
-        join(' - ', 
-          "+$countrycode $dest",
-          $rate_prefix->rate_region->regionname,
-          $minutes.'m',
-          '$'.$charge,
-        #]
-        )
-      ;
+      push @$details, join(' - ', @call_details); #\@call_details,
 
     } # $session
 
@@ -181,5 +183,10 @@ sub is_free {
   0;
 }
 
+sub base_recur {
+  my($self, $cust_pkg) = @_;
+  $self->option('recur_flat');
+}
+
 1;