FS/FS/part_pkg/voip_cdr.pm

   1 package FS::part_pkg::voip_cdr;
   2
   3 use strict;
   4 use vars qw(@ISA $DEBUG %info);
   5 use Date::Format;
   6 use Tie::IxHash;
   7 use FS::Conf;
   8 use FS::Record qw(qsearchs qsearch);
   9 use FS::part_pkg::flat;
  10 #use FS::rate;
  11 #use FS::rate_prefix;
  12
  13 @ISA = qw(FS::part_pkg::flat);
  14
  15 $DEBUG = 1;
  16
  17 tie my %rating_method, 'Tie::IxHash',
  18   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
  19   '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.',
  20 ;
  21
  22 #tie my %cdr_location, 'Tie::IxHash',
  23 #  'internal' => 'Internal: CDR records imported into the internal CDR table',
  24 #  'external' => 'External: CDR records queried directly from an external '.
  25 #                'Asterisk (or other?) CDR table',
  26 #;
  27
  28 %info = (
  29   'name' => 'VoIP rating by plan of CDR records in an internal (or external?) SQL table',
  30   'fields' => {
  31     'setup_fee'     => { 'name' => 'Setup fee for this package',
  32                          'default' => 0,
  33                        },
  34     'recur_flat'     => { 'name' => 'Base recurring fee for this package',
  35                           'default' => 0,
  36                         },
  37     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
  38                                    ' of service at cancellation',
  39                          'type' => 'checkbox',
  40                        },
  41     'ratenum'   => { 'name' => 'Rate plan',
  42                      'type' => 'select',
  43                      'select_table' => 'rate',
  44                      'select_key'   => 'ratenum',
  45                      'select_label' => 'ratename',
  46                    },
  47     'rating_method' => { 'name' => 'Region rating method',
  48                          'type' => 'select',
  49                          'select_options' => \%rating_method,
  50                        },
  51
  52     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
  53                           'default' => '+1',
  54                         },
  55
  56     #XXX also have option for an external db??
  57 #    'cdr_location' => { 'name' => 'CDR database location'
  58 #                        'type' => 'select',
  59 #                        'select_options' => \%cdr_location,
  60 #                        'select_callback' => {
  61 #                          'external' => {
  62 #                            'enable' => [ 'datasrc', 'username', 'password' ],
  63 #                          },
  64 #                          'internal' => {
  65 #                            'disable' => [ 'datasrc', 'username', 'password' ],
  66 #                          }
  67 #                        },
  68 #                      },
  69 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
  70 #                   'disabled' => 'Y',
  71 #                 },
  72 #    'username' => { 'name' => 'External database username',
  73 #                    'disabled' => 'Y',
  74 #                  },
  75 #    'password' => { 'name' => 'External database password',
  76 #                    'disabled' => 'Y',
  77 #                  },
  78
  79   },
  80   'fieldorder' => [qw( setup_fee recur_flat unused_credit ratenum rating_method default_prefix )],
  81   'weight' => 40,
  82 );
  83
  84 sub calc_setup {
  85   my($self, $cust_pkg ) = @_;
  86   $self->option('setup_fee');
  87 }
  88
  89 #false laziness w/voip_sqlradacct... resolve it if that one ever gets used again
  90 sub calc_recur {
  91   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
  92
  93   my $last_bill = $cust_pkg->last_bill;
  94
  95   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
  96
  97   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
  98
  99   my %included_min = ();
 100
 101   my $charges = 0;
 102
 103   my $downstream_cdr = '';
 104
 105   foreach my $cust_svc (
 106     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
 107   ) {
 108
 109     foreach my $cdr (
 110       $cust_svc->get_cdrs_for_update()  # $last_bill, $$sdate )
 111     ) {
 112       if ( $DEBUG > 1 ) {
 113         warn "rating CDR $cdr\n".
 114              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 115       }
 116
 117       my $rate_detail;
 118       my( $rate_region, $regionnum );
 119       my $pretty_destnum;
 120       my $charge = 0;
 121       my @call_details = ();
 122       if ( $self->option('rating_method') eq 'prefix'
 123            || ! $self->option('rating_method')
 124          )
 125       {
 126
 127         ###
 128         # look up rate details based on called station id
 129         # (or calling station id for toll free calls)
 130         ###
 131
 132         my( $to_or_from, $number );
 133         if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/ ) { #tollfree call
 134           $to_or_from = 'from';
 135           $number = $cdr->src;
 136         } else { #regular call
 137           $to_or_from = 'to';
 138           $number = $cdr->dst;
 139         }
 140
 141         #remove non-phone# stuff and whitespace
 142         $number =~ s/\s//g;
 143 #        my $proto = '';
 144 #        $dest =~ s/^(\w+):// and $proto = $1; #sip:
 145 #        my $siphost = '';
 146 #        $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 147
 148         #determine the country code
 149         my $countrycode;
 150         if (    $number =~ /^011(((\d)(\d))(\d))(\d+)$/
 151              || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 152            )
 153         {
 154
 155           my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 156           #first look for 1 digit country code
 157           if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 158             $countrycode = $one;
 159             $number = $u1.$u2.$rest;
 160           } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 161             $countrycode = $two;
 162             $number = $u2.$rest;
 163           } else { #3 digit country code
 164             $countrycode = $three;
 165             $number = $rest;
 166           }
 167
 168         } else {
 169           $countrycode = '1';
 170           $number =~ s/^1//;# if length($number) > 10;
 171         }
 172
 173         warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 174         $pretty_destnum = "+$countrycode $number";
 175
 176         #find a rate prefix, first look at most specific (4 digits) then 3, etc.,
 177         # finally trying the country code only
 178         my $rate_prefix = '';
 179         for my $len ( reverse(1..6) ) {
 180           $rate_prefix = qsearchs('rate_prefix', {
 181             'countrycode' => $countrycode,
 182             #'npa'         => { op=> 'LIKE', value=> substr($number, 0, $len) }
 183             'npa'         => substr($number, 0, $len),
 184           } ) and last;
 185         }
 186         $rate_prefix ||= qsearchs('rate_prefix', {
 187           'countrycode' => $countrycode,
 188           'npa'         => '',
 189         });
 190
 191         #
 192         die "Can't find rate for call $to_or_from +$countrycode $\numbern"
 193           unless $rate_prefix;
 194
 195         $regionnum = $rate_prefix->regionnum;
 196         $rate_detail = qsearchs('rate_detail', {
 197           'ratenum'        => $ratenum,
 198           'dest_regionnum' => $regionnum,
 199         } );
 200
 201         $rate_region = $rate_prefix->rate_region;
 202
 203         warn "  found rate for regionnum $regionnum ".
 204              "and rate detail $rate_detail\n"
 205           if $DEBUG;
 206
 207       } elsif ( $self->option('rating_method') eq 'upstream' ) {
 208
 209         if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
 210
 211           $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
 212
 213           $regionnum = $rate_detail->dest_regionnum;
 214           $rate_region = $rate_detail->dest_region;
 215
 216           $pretty_destnum = $cdr->dst;
 217
 218           warn "  found rate for regionnum $regionnum and ".
 219                "rate detail $rate_detail\n"
 220             if $DEBUG;
 221
 222         } else { #pass upstream price through
 223
 224           $charge = sprintf('%.2f', $cdr->upstream_price);
 225
 226           @call_details = (
 227             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 228             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
 229             'N/A', #minutes...
 230             '$'.$charge,
 231             #$pretty_destnum,
 232             $cdr->description, #$rate_region->regionname,
 233           );
 234
 235         }
 236
 237       } else {
 238         die "don't know how to rate CDRs using method: ".
 239             $self->option('rating_method'). "\n";
 240       }
 241
 242       ###
 243       # find the price and add detail to the invoice
 244       ###
 245
 246       # if $rate_detail is not found, skip this CDR... i.e.
 247       # don't add it to invoice, don't set its status to NULL,
 248       # don't call downstream_csv or something on it...
 249       # but DO emit a warning...
 250       if ( ! $rate_detail && ! scalar(@call_details) ) {
 251
 252         warn "no rate_detail found for CDR.acctid:  ". $cdr->acctid.
 253              "; skipping\n"
 254
 255       } else { # there *is* a rate_detail (or call_details), proceed...
 256
 257         unless ( @call_details ) {
 258
 259           $included_min{$regionnum} = $rate_detail->min_included
 260             unless exists $included_min{$regionnum};
 261
 262           my $granularity = $rate_detail->sec_granularity;
 263           my $seconds = $cdr->billsec; # |ength($cdr->billsec) ? $cdr->billsec : $cdr->duration;
 264           $seconds += $granularity - ( $seconds % $granularity );
 265           my $minutes = sprintf("%.1f", $seconds / 60);
 266           $minutes =~ s/\.0$// if $granularity == 60;
 267
 268           $included_min{$regionnum} -= $minutes;
 269
 270           if ( $included_min{$regionnum} < 0 ) {
 271             my $charge_min = 0 - $included_min{$regionnum};
 272             $included_min{$regionnum} = 0;
 273             $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
 274             $charges += $charge;
 275           }
 276
 277           # this is why we need regionnum/rate_region....
 278           warn "  (rate region $rate_region)\n" if $DEBUG;
 279
 280           @call_details = (
 281             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 282             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
 283             $minutes.'m',
 284             '$'.$charge,
 285             $pretty_destnum,
 286             $rate_region->regionname,
 287           );
 288
 289         }
 290
 291         warn "  adding details on charge to invoice: ".
 292              join(' - ', @call_details )
 293           if $DEBUG;
 294
 295         push @$details, join(' - ', @call_details); #\@call_details,
 296
 297         # if the customer flag is on, call "downstream_csv" or something
 298         # like it to export the call downstream!
 299         # XXX price plan option to pick format, or something...
 300         $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
 301           if $spool_cdr;
 302
 303         my $error = $cdr->set_status_and_rated_price('done', $charge);
 304         die $error if $error;
 305
 306       }
 307
 308     } # $cdr
 309
 310   } # $cust_svc
 311
 312   if ( $spool_cdr && length($downstream_cdr) ) {
 313
 314     use FS::UID qw(datasrc);
 315     my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 316     mkdir $dir, 0700 unless -d $dir;
 317     $dir .= '/'. $cust_pkg->custnum.
 318     mkdir $dir, 0700 unless -d $dir;
 319     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
 320
 321     push @{ $param->{'precommit_hooks'} },
 322          sub {
 323                #lock the downstream spool file and append the records
 324                use Fcntl qw(:flock);
 325                use IO::File;
 326                my $spool = new IO::File ">>$filename"
 327                  or die "can't open $filename: $!\n";
 328                flock( $spool, LOCK_EX)
 329                  or die "can't lock $filename: $!\n";
 330                seek($spool, 0, 2)
 331                  or die "can't seek to end of $filename: $!\n";
 332                print $spool $downstream_cdr;
 333                flock( $spool, LOCK_UN );
 334                close $spool;
 335              };
 336
 337   } #if ( $spool_cdr && length($downstream_cdr) )
 338
 339   $self->option('recur_flat') + $charges;
 340
 341 }
 342
 343 sub is_free {
 344   0;
 345 }
 346
 347 sub base_recur {
 348   my($self, $cust_pkg) = @_;
 349   $self->option('recur_flat');
 350 }
 351
 352 1;
 353