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::cdr;
  11 #use FS::rate;
  12 #use FS::rate_prefix;
  13
  14 @ISA = qw(FS::part_pkg::flat);
  15
  16 $DEBUG = 1;
  17
  18 tie my %rating_method, 'Tie::IxHash',
  19   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
  20   '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.',
  21   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
  22 ;
  23
  24 #tie my %cdr_location, 'Tie::IxHash',
  25 #  'internal' => 'Internal: CDR records imported into the internal CDR table',
  26 #  'external' => 'External: CDR records queried directly from an external '.
  27 #                'Asterisk (or other?) CDR table',
  28 #;
  29
  30 %info = (
  31   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
  32   'shortname' => 'VoIP/telco CDR rating (standard)',
  33   'fields' => {
  34     'setup_fee'     => { 'name' => 'Setup fee for this package',
  35                          'default' => 0,
  36                        },
  37     'recur_fee'     => { 'name' => 'Base recurring fee for this package',
  38                          'default' => 0,
  39                        },
  40     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
  41                                    ' of service at cancellation',
  42                          'type' => 'checkbox',
  43                        },
  44     'ratenum'   => { 'name' => 'Rate plan',
  45                      'type' => 'select',
  46                      'select_table' => 'rate',
  47                      'select_key'   => 'ratenum',
  48                      'select_label' => 'ratename',
  49                    },
  50     'rating_method' => { 'name' => 'Region rating method',
  51                          'type' => 'radio',
  52                          'options' => \%rating_method,
  53                        },
  54
  55     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
  56                           'default' => '+1',
  57                         },
  58
  59     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
  60                        'type' => 'checkbox'
  61                      },
  62
  63     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
  64                            'default' => '1',
  65                          },
  66
  67 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
  68 #                                    'type' => 'checkbox',
  69 #                                  },
  70
  71     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
  72                                 'default' => '011',
  73                               },
  74
  75     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
  76                         'type' => 'checkbox',
  77                       },
  78
  79     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
  80                            'type' => 'checkbox',
  81                          },
  82
  83     'output_format' => { 'name' => 'Simple output format',
  84                          'type' => 'select',
  85                          'select_options' => { FS::cdr::invoice_formats() },
  86                        },
  87
  88     'separate_usage' => { 'name' => 'Separate usage charges from recurring charges',
  89                           'type' => 'checkbox',
  90                         },
  91
  92     #XXX also have option for an external db
  93 #    'cdr_location' => { 'name' => 'CDR database location'
  94 #                        'type' => 'select',
  95 #                        'select_options' => \%cdr_location,
  96 #                        'select_callback' => {
  97 #                          'external' => {
  98 #                            'enable' => [ 'datasrc', 'username', 'password' ],
  99 #                          },
 100 #                          'internal' => {
 101 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 102 #                          }
 103 #                        },
 104 #                      },
 105 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 106 #                   'disabled' => 'Y',
 107 #                 },
 108 #    'username' => { 'name' => 'External database username',
 109 #                    'disabled' => 'Y',
 110 #                  },
 111 #    'password' => { 'name' => 'External database password',
 112 #                    'disabled' => 'Y',
 113 #                  },
 114
 115   },
 116   'fieldorder' => [qw(
 117                        setup_fee recur_fee unused_credit
 118                        rating_method ratenum
 119                        default_prefix
 120                        disable_src
 121                        domestic_prefix international_prefix
 122                        use_amaflags use_disposition output_format
 123                        separate_usage
 124                      )
 125                   ],
 126   'weight' => 40,
 127 );
 128
 129 sub calc_setup {
 130   my($self, $cust_pkg ) = @_;
 131   $self->option('setup_fee');
 132 }
 133
 134 sub calc_recur {
 135   my $self = shift;
 136   my $charges = 0;
 137   $charges = $self->calc_usage(@_)
 138     unless $self->option('separate_usage', 'Hush!');
 139   $self->option('recur_fee') + $charges;
 140 }
 141
 142 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 143 sub calc_usage {
 144   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
 145
 146   my $last_bill = $cust_pkg->last_bill;
 147
 148   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 149
 150   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 151
 152   my %included_min = ();
 153
 154   my $charges = 0;
 155
 156   my $downstream_cdr = '';
 157
 158   my $output_format = $self->option('output_format', 'Hush!')
 159                       || 'simple';
 160
 161   eval "use Text::CSV_XS;";
 162   die $@ if $@;
 163   my $csv = new Text::CSV_XS;
 164
 165   foreach my $cust_svc (
 166     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
 167   ) {
 168
 169     foreach my $cdr (
 170       $cust_svc->get_cdrs_for_update( 'disable_src'    => $self->option('disable_src'),
 171                                       'default_prefix' => $self->option('default_prefix'),
 172                                     )  # $last_bill, $$sdate )
 173     ) {
 174       if ( $DEBUG > 1 ) {
 175         warn "rating CDR $cdr\n".
 176              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 177       }
 178
 179       my $rate_detail;
 180       my( $rate_region, $regionnum );
 181       my $pretty_destnum;
 182       my $charge = '';
 183       my @call_details = ();
 184       if ( $self->option('rating_method') eq 'prefix'
 185            || ! $self->option('rating_method')
 186          )
 187       {
 188
 189         if ( $self->option('use_amaflags') && $cdr->amaflags != 2 ) {
 190
 191           warn "not charging for CDR (amaflags != 2)\n" if $DEBUG;
 192           $charge = 0;
 193
 194         } elsif ( $self->option('use_disposition')
 195                   && $cdr->disposition ne 'ANSWERED' ) {
 196
 197           warn "not charging for CDR (disposition != ANSWERED)\n" if $DEBUG;
 198           $charge = 0;
 199
 200         } else {
 201
 202           ###
 203           # look up rate details based on called station id
 204           # (or calling station id for toll free calls)
 205           ###
 206
 207           my( $to_or_from, $number );
 208           if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/ ) { #tollfree call
 209             $to_or_from = 'from';
 210             $number = $cdr->src;
 211           } else { #regular call
 212             $to_or_from = 'to';
 213             $number = $cdr->dst;
 214           }
 215
 216           #remove non-phone# stuff and whitespace
 217           $number =~ s/\s//g;
 218 #          my $proto = '';
 219 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
 220 #          my $siphost = '';
 221 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 222
 223           my $intl = $self->option('international_prefix') || '011';
 224
 225           #determine the country code
 226           my $countrycode;
 227           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
 228                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 229              )
 230           {
 231
 232             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 233             #first look for 1 digit country code
 234             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 235               $countrycode = $one;
 236               $number = $u1.$u2.$rest;
 237             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 238               $countrycode = $two;
 239               $number = $u2.$rest;
 240             } else { #3 digit country code
 241               $countrycode = $three;
 242               $number = $rest;
 243             }
 244
 245           } else {
 246             $countrycode = $self->option('domestic_prefix') || '1';
 247             $number =~ s/^$countrycode//;# if length($number) > 10;
 248           }
 249
 250           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 251           $pretty_destnum = "+$countrycode $number";
 252
 253           #find a rate prefix, first look at most specific (4 digits) then 3, etc.,
 254           # finally trying the country code only
 255           my $rate_prefix = '';
 256           for my $len ( reverse(1..6) ) {
 257             $rate_prefix = qsearchs('rate_prefix', {
 258               'countrycode' => $countrycode,
 259               #'npa'         => { op=> 'LIKE', value=> substr($number, 0, $len) }
 260               'npa'         => substr($number, 0, $len),
 261             } ) and last;
 262           }
 263           $rate_prefix ||= qsearchs('rate_prefix', {
 264             'countrycode' => $countrycode,
 265             'npa'         => '',
 266           });
 267
 268           #
 269           die "Can't find rate for call $to_or_from +$countrycode $number\n"
 270             unless $rate_prefix;
 271
 272           $regionnum = $rate_prefix->regionnum;
 273           $rate_detail = qsearchs('rate_detail', {
 274             'ratenum'        => $ratenum,
 275             'dest_regionnum' => $regionnum,
 276           } );
 277
 278           $rate_region = $rate_prefix->rate_region;
 279
 280           warn "  found rate for regionnum $regionnum ".
 281                "and rate detail $rate_detail\n"
 282             if $DEBUG;
 283
 284         }
 285
 286       } elsif ( $self->option('rating_method') eq 'upstream' ) {
 287
 288         if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
 289
 290           $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
 291
 292           $regionnum = $rate_detail->dest_regionnum;
 293           $rate_region = $rate_detail->dest_region;
 294
 295           $pretty_destnum = $cdr->dst;
 296
 297           warn "  found rate for regionnum $regionnum and ".
 298                "rate detail $rate_detail\n"
 299             if $DEBUG;
 300
 301         } else { #pass upstream price through
 302
 303           $charge = sprintf('%.2f', $cdr->upstream_price);
 304           $charges += $charge;
 305
 306           @call_details = (
 307             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 308             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
 309             'N/A', #minutes...
 310             '$'.$charge,
 311             #$pretty_destnum,
 312             $cdr->description, #$rate_region->regionname,
 313           );
 314
 315         }
 316
 317       } elsif ( $self->option('rating_method') eq 'upstream_simple' ) {
 318
 319         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
 320         $charge = sprintf('%.3f', $cdr->upstream_price);
 321         $charges += $charge;
 322
 323         @call_details = ($cdr->downstream_csv( 'format' => $output_format ));
 324
 325       } else {
 326         die "don't know how to rate CDRs using method: ".
 327             $self->option('rating_method'). "\n";
 328       }
 329
 330       ###
 331       # find the price and add detail to the invoice
 332       ###
 333
 334       # if $rate_detail is not found, skip this CDR... i.e.
 335       # don't add it to invoice, don't set its status to NULL,
 336       # don't call downstream_csv or something on it...
 337       # but DO emit a warning...
 338       #if ( ! $rate_detail && ! scalar(@call_details) ) {
 339       if ( ! $rate_detail && $charge eq '' ) {
 340
 341         warn "no rate_detail found for CDR.acctid:  ". $cdr->acctid.
 342              "; skipping\n"
 343
 344       } else { # there *is* a rate_detail (or call_details), proceed...
 345
 346         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 347
 348           $included_min{$regionnum} = $rate_detail->min_included
 349             unless exists $included_min{$regionnum};
 350
 351           my $granularity = $rate_detail->sec_granularity;
 352           my $seconds = $cdr->billsec; # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
 353           $seconds += $granularity - ( $seconds % $granularity )
 354             if $seconds      # don't granular-ize 0 billsec calls (bills them)
 355             && $granularity; # 0 is per call
 356           my $minutes = sprintf("%.1f", $seconds / 60);
 357           $minutes =~ s/\.0$// if $granularity == 60;
 358
 359           # per call rather than per minute
 360           $minutes = 1 unless $granularity;
 361
 362           $included_min{$regionnum} -= $minutes;
 363
 364           if ( $included_min{$regionnum} < 0 ) {
 365             my $charge_min = 0 - $included_min{$regionnum};
 366             $included_min{$regionnum} = 0;
 367             $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
 368             $charges += $charge;
 369           }
 370
 371           # this is why we need regionnum/rate_region....
 372           warn "  (rate region $rate_region)\n" if $DEBUG;
 373
 374           @call_details = (
 375             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 376             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
 377             $granularity ? $minutes.'m' : $minutes.' call',
 378             '$'.$charge,
 379             $pretty_destnum,
 380             $rate_region->regionname,
 381           );
 382
 383         }
 384
 385         if ( $charge > 0 ) {
 386           my $call_details;
 387           if ( $self->option('rating_method') eq 'upstream_simple' ) {
 388             $call_details = [ 'C', $call_details[0] ];
 389           }else{
 390             $csv->combine(@call_details);
 391             $call_details = [ 'C', $csv->string ];
 392           }
 393           warn "  adding details on charge to invoice: [ ".
 394               join(', ', @{$call_details} ). " ]"
 395             if ( $DEBUG && ref($call_details) );
 396           push @$details, $call_details; #\@call_details,
 397         }
 398
 399         # if the customer flag is on, call "downstream_csv" or something
 400         # like it to export the call downstream!
 401         # XXX price plan option to pick format, or something...
 402         $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
 403           if $spool_cdr;
 404
 405         my $error = $cdr->set_status_and_rated_price('done', $charge);
 406         die $error if $error;
 407
 408       }
 409
 410     } # $cdr
 411
 412     unshift @$details, [ 'C', FS::cdr::invoice_header( $output_format) ]
 413       if (@$details && $self->option('rating_method') eq 'upstream_simple' );
 414
 415   } # $cust_svc
 416
 417   if ( $spool_cdr && length($downstream_cdr) ) {
 418
 419     use FS::UID qw(datasrc);
 420     my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 421     mkdir $dir, 0700 unless -d $dir;
 422     $dir .= '/'. $cust_pkg->custnum.
 423     mkdir $dir, 0700 unless -d $dir;
 424     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
 425
 426     push @{ $param->{'precommit_hooks'} },
 427          sub {
 428                #lock the downstream spool file and append the records
 429                use Fcntl qw(:flock);
 430                use IO::File;
 431                my $spool = new IO::File ">>$filename"
 432                  or die "can't open $filename: $!\n";
 433                flock( $spool, LOCK_EX)
 434                  or die "can't lock $filename: $!\n";
 435                seek($spool, 0, 2)
 436                  or die "can't seek to end of $filename: $!\n";
 437                print $spool $downstream_cdr;
 438                flock( $spool, LOCK_UN );
 439                close $spool;
 440              };
 441
 442   } #if ( $spool_cdr && length($downstream_cdr) )
 443
 444   $charges;
 445
 446 }
 447
 448 sub is_free {
 449   0;
 450 }
 451
 452 sub base_recur {
 453   my($self, $cust_pkg) = @_;
 454   $self->option('recur_fee');
 455 }
 456
 457 #  This equates svc_phone records; perhaps svc_phone should have a field
 458 #  to indicate it represents a line
 459 sub calc_units {
 460   my($self, $cust_pkg ) = @_;
 461   scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 462 }
 463
 464 sub append_cust_bill_pkgs {
 465   my $self = shift;
 466   my($cust_pkg, $sdate, $details, $param ) = @_;
 467   return []
 468     unless $self->option('separate_usage', 'Hush!');
 469
 470   my @details = ();
 471   my $charges = $self->calc_usage($cust_pkg, $sdate, \@details, $param);
 472
 473   my $cust_bill_pkg = new FS::cust_bill_pkg {
 474     'pkgnum'    => $cust_pkg->pkgnum,
 475     'setup'     => 0,
 476     'unitsetup' => 0,
 477     'recur'     => sprintf( "%.2f", $charges),  # hmmm
 478     'unitrecur' => 0,
 479     'quantity'  => $cust_pkg->quantity,
 480     'sdate'     => $$sdate,
 481     'edate'     => $cust_pkg->bill,             # already fiddled
 482     'itemdesc'  => 'Usage charges',             # configurable?
 483     'details'   => \@details,
 484   };
 485
 486   return [ $cust_bill_pkg ];
 487 }
 488
 489 1;
 490