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 use FS::rate_detail;
  14
  15 @ISA = qw(FS::part_pkg::flat);
  16
  17 $DEBUG = 0;
  18
  19 tie my %rating_method, 'Tie::IxHash',
  20   'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
  21   '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.',
  22   'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
  23 ;
  24
  25 #tie my %cdr_location, 'Tie::IxHash',
  26 #  'internal' => 'Internal: CDR records imported into the internal CDR table',
  27 #  'external' => 'External: CDR records queried directly from an external '.
  28 #                'Asterisk (or other?) CDR table',
  29 #;
  30
  31 tie my %temporalities, 'Tie::IxHash',
  32   'upcoming'  => "Upcoming (future)",
  33   'preceding' => "Preceding (past)",
  34 ;
  35
  36 %info = (
  37   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
  38   'shortname' => 'VoIP/telco CDR rating (standard)',
  39   'fields' => {
  40     'setup_fee'     => { 'name' => 'Setup fee for this package',
  41                          'default' => 0,
  42                        },
  43     'recur_fee'     => { 'name' => 'Base recurring fee for this package',
  44                          'default' => 0,
  45                        },
  46
  47     #false laziness w/flat.pm
  48     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
  49                              'type' => 'select',
  50                              'select_options' => \%temporalities,
  51                            },
  52
  53     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
  54                                    ' of service at cancellation',
  55                          'type' => 'checkbox',
  56                        },
  57
  58     'rating_method' => { 'name' => 'Region rating method',
  59                          'type' => 'radio',
  60                          'options' => \%rating_method,
  61                        },
  62
  63     'ratenum'   => { 'name' => 'Rate plan',
  64                      'type' => 'select',
  65                      'select_table' => 'rate',
  66                      'select_key'   => 'ratenum',
  67                      'select_label' => 'ratename',
  68                    },
  69
  70     'ignore_unrateable' => { 'name' => 'Ignore calls without a rate in the rate tables.  By default, the system will throw a fatal error upon encountering unrateable calls.',
  71                              'type' => 'checkbox',
  72                            },
  73
  74     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
  75                           'default' => '+1',
  76                         },
  77
  78     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
  79                        'type' => 'checkbox'
  80                      },
  81
  82     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
  83                            'default' => '1',
  84                          },
  85
  86 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
  87 #                                    'type' => 'checkbox',
  88 #                                  },
  89
  90     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
  91                                 'default' => '011',
  92                               },
  93
  94     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
  95                             'type' => 'checkbox',
  96                           },
  97
  98     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
  99                         'type' => 'checkbox',
 100                       },
 101
 102     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
 103                            'type' => 'checkbox',
 104                          },
 105
 106     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
 107                                  'type' => 'checkbox',
 108                                },
 109
 110     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
 111                          },
 112
 113     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
 114                          },
 115
 116     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
 117                        },
 118
 119     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
 120                                 },
 121
 122     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
 123                           'type' => 'checkbox',
 124                         },
 125
 126     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
 127                       },
 128
 129     'output_format' => { 'name' => 'CDR invoice display format',
 130                          'type' => 'select',
 131                          'select_options' => { FS::cdr::invoice_formats() },
 132                          'default'        => 'default', #XXX test
 133                        },
 134
 135     'usage_section' => { 'name' => 'Section in which to place separate usage charges',
 136                        },
 137
 138     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
 139                           'type' => 'checkbox',
 140                         },
 141
 142     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
 143                            'type' => 'checkbox',
 144                          },
 145
 146     #XXX also have option for an external db
 147 #    'cdr_location' => { 'name' => 'CDR database location'
 148 #                        'type' => 'select',
 149 #                        'select_options' => \%cdr_location,
 150 #                        'select_callback' => {
 151 #                          'external' => {
 152 #                            'enable' => [ 'datasrc', 'username', 'password' ],
 153 #                          },
 154 #                          'internal' => {
 155 #                            'disable' => [ 'datasrc', 'username', 'password' ],
 156 #                          }
 157 #                        },
 158 #                      },
 159 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
 160 #                   'disabled' => 'Y',
 161 #                 },
 162 #    'username' => { 'name' => 'External database username',
 163 #                    'disabled' => 'Y',
 164 #                  },
 165 #    'password' => { 'name' => 'External database password',
 166 #                    'disabled' => 'Y',
 167 #                  },
 168
 169   },
 170   'fieldorder' => [qw(
 171                        setup_fee recur_fee recur_temporality unused_credit
 172                        rating_method ratenum ignore_unrateable
 173                        default_prefix
 174                        disable_src
 175                        domestic_prefix international_prefix
 176                        disable_tollfree
 177                        use_amaflags use_disposition
 178                        use_disposition_taqua use_carrierid use_cdrtypenum
 179                        skip_dcontext skip_dstchannel_prefix
 180                        use_duration
 181                        411_rewrite
 182                        output_format summarize_usage usage_section
 183                        bill_every_call
 184                      )
 185                   ],
 186   'weight' => 40,
 187 );
 188
 189 sub calc_setup {
 190   my($self, $cust_pkg ) = @_;
 191   $self->option('setup_fee');
 192 }
 193
 194 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
 195 sub calc_recur {
 196   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
 197
 198   #my $last_bill = $cust_pkg->last_bill;
 199   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
 200
 201   return 0
 202     if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
 203
 204   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
 205
 206   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
 207
 208   my %included_min = ();
 209
 210   my $charges = 0;
 211
 212   my $downstream_cdr = '';
 213
 214   my $rating_method     = $self->option('rating_method') || 'prefix';
 215   my $intl              = $self->option('international_prefix') || '011';
 216   my $domestic_prefix   = $self->option('domestic_prefix');
 217   my $disable_tollfree  = $self->option('disable_tollfree');
 218   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
 219   my $use_duration      = $self->option('use_duration');
 220
 221   my $output_format     = $self->option('output_format', 'Hush!')
 222                           || ( $rating_method eq 'upstream_simple'
 223                                  ? 'simple'
 224                                  : 'default'
 225                              );
 226
 227   my @dirass = ();
 228   if ( $self->option('411_rewrite') ) {
 229     my $dirass = $self->option('411_rewrite');
 230     $dirass =~ s/\s//g;
 231     @dirass = split(',', $dirass);
 232   }
 233
 234   #for check_chargable, so we don't keep looking up options inside the loop
 235   my %opt_cache = ();
 236
 237   eval "use Text::CSV_XS;";
 238   die $@ if $@;
 239   my $csv = new Text::CSV_XS;
 240
 241   foreach my $cust_svc (
 242     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
 243   ) {
 244
 245     foreach my $cdr (
 246       $cust_svc->get_cdrs_for_update(
 247         'disable_src'    => $self->option('disable_src'),
 248         'default_prefix' => $self->option('default_prefix'),
 249       )  # $last_bill, $$sdate )
 250     ) {
 251       if ( $DEBUG > 1 ) {
 252         warn "rating CDR $cdr\n".
 253              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
 254       }
 255
 256       my $rate_detail;
 257       my( $rate_region, $regionnum );
 258       my $pretty_destnum;
 259       my $charge = '';
 260       my $classnum = '';
 261       my @call_details = ();
 262       if ( $rating_method eq 'prefix' ) {
 263
 264         my $da_rewrote = 0;
 265         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
 266           $cdr->dst('411');
 267           $da_rewrote = 1;
 268         }
 269
 270         my $reason = $self->check_chargable( $cdr,
 271                                              'da_rewrote'   => $da_rewrote,
 272                                              'option_cache' => \%opt_cache,
 273                                            );
 274
 275         if ( $reason ) {
 276
 277           warn "not charging for CDR ($reason)\n" if $DEBUG;
 278           $charge = 0;
 279
 280         } else {
 281
 282           ###
 283           # look up rate details based on called station id
 284           # (or calling station id for toll free calls)
 285           ###
 286
 287           my( $to_or_from, $number );
 288           if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
 289                && ! $disable_tollfree
 290               )
 291           { #tollfree call
 292             $to_or_from = 'from';
 293             $number = $cdr->src;
 294           } else { #regular call
 295             $to_or_from = 'to';
 296             $number = $cdr->dst;
 297           }
 298
 299           warn "parsing call $to_or_from $number\n" if $DEBUG;
 300
 301           #remove non-phone# stuff and whitespace
 302           $number =~ s/\s//g;
 303 #          my $proto = '';
 304 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
 305 #          my $siphost = '';
 306 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
 307
 308           #determine the country code
 309           my $countrycode;
 310           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
 311                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
 312              )
 313           {
 314
 315             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
 316             #first look for 1 digit country code
 317             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
 318               $countrycode = $one;
 319               $number = $u1.$u2.$rest;
 320             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
 321               $countrycode = $two;
 322               $number = $u2.$rest;
 323             } else { #3 digit country code
 324               $countrycode = $three;
 325               $number = $rest;
 326             }
 327
 328           } else {
 329             $countrycode = $domestic_prefix || '1';
 330             $number =~ s/^$countrycode//;# if length($number) > 10;
 331           }
 332
 333           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
 334           $pretty_destnum = "+$countrycode $number";
 335
 336           my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
 337             or die "ratenum $ratenum not found!";
 338
 339           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
 340                                               'phonenum'    => $number,
 341                                             });
 342
 343           if ( $rate_detail ) {
 344
 345             $rate_region = $rate_detail->dest_region;
 346             $regionnum = $rate_region->regionnum;
 347             warn "  found rate for regionnum $regionnum ".
 348                  "and rate detail $rate_detail\n"
 349               if $DEBUG;
 350
 351           } elsif ( $ignore_unrateable ) {
 352
 353             $rate_region = '';
 354             $regionnum = '';
 355             #code below will throw a warning & skip
 356
 357           } else {
 358
 359             die "FATAL: no rate_detail found in ".
 360                 $rate->ratenum. ":". $rate->ratename. " rate plan ".
 361                 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
 362                 "add a rate or set ignore_unrateable flag on the package def\n";
 363           }
 364
 365         }
 366
 367       } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used.  very much becoming the odd one out. remove?
 368
 369         if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
 370
 371           $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
 372
 373           $regionnum = $rate_detail->dest_regionnum;
 374           $rate_region = $rate_detail->dest_region;
 375
 376           $pretty_destnum = $cdr->dst;
 377
 378           warn "  found rate for regionnum $regionnum and ".
 379                "rate detail $rate_detail\n"
 380             if $DEBUG;
 381
 382         } else { #pass upstream price through
 383
 384           $charge = sprintf('%.2f', $cdr->upstream_price);
 385           $charges += $charge;
 386
 387           @call_details = (
 388             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
 389             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
 390             'N/A', #minutes...
 391             '$'.$charge,
 392             #$pretty_destnum,
 393             $cdr->description, #$rate_region->regionname,
 394           );
 395
 396         }
 397
 398       } elsif ( $rating_method eq 'upstream_simple' ) {
 399
 400         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
 401         $charge = sprintf('%.3f', $cdr->upstream_price);
 402         $charges += $charge;
 403
 404         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
 405                                                'charge' => $charge,
 406                                              )
 407                         );
 408         $classnum = $cdr->calltypenum;
 409
 410       } else {
 411         die "don't know how to rate CDRs using method: $rating_method\n";
 412       }
 413
 414       ###
 415       # find the price and add detail to the invoice
 416       ###
 417
 418       # if $rate_detail is not found, skip this CDR... i.e.
 419       # don't add it to invoice, don't set its status to done,
 420       # don't call downstream_csv or something on it...
 421       # but DO emit a warning...
 422       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
 423       if ( ! $rate_detail && $charge eq '' ) {
 424
 425         warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
 426              "; skipping\n"
 427
 428       } else { # there *is* a rate_detail (or call_details), proceed...
 429
 430         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
 431
 432           $included_min{$regionnum} = $rate_detail->min_included
 433             unless exists $included_min{$regionnum};
 434
 435           my $granularity = $rate_detail->sec_granularity;
 436
 437                       # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
 438           my $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
 439
 440           $seconds += $granularity - ( $seconds % $granularity )
 441             if $seconds      # don't granular-ize 0 billsec calls (bills them)
 442             && $granularity; # 0 is per call
 443           my $minutes = sprintf("%.1f", $seconds / 60);
 444           $minutes =~ s/\.0$// if $granularity == 60;
 445
 446           # per call rather than per minute
 447           $minutes = 1 unless $granularity;
 448
 449           $included_min{$regionnum} -= $minutes;
 450
 451           if ( $included_min{$regionnum} < 0 ) {
 452             my $charge_min = 0 - $included_min{$regionnum};
 453             $included_min{$regionnum} = 0;
 454             $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
 455             $charges += $charge;
 456           }
 457
 458           # this is why we need regionnum/rate_region....
 459           warn "  (rate region $rate_region)\n" if $DEBUG;
 460
 461           @call_details = (
 462            $cdr->downstream_csv( 'format'         => $output_format,
 463                                  'granularity'    => $granularity,
 464                                  'minutes'        => $minutes,
 465                                  'charge'         => $charge,
 466                                  'pretty_dst'     => $pretty_destnum,
 467                                  'dst_regionname' => $rate_region->regionname,
 468                                )
 469           );
 470
 471           $classnum = $rate_detail->classnum;
 472
 473         }
 474
 475         if ( $charge > 0 ) {
 476           #just use FS::cust_bill_pkg_detail objects?
 477           my $call_details;
 478
 479           #if ( $self->option('rating_method') eq 'upstream_simple' ) {
 480           if ( scalar(@call_details) == 1 ) {
 481             $call_details = [ 'C', $call_details[0], $charge, $classnum ];
 482           } else { #only used for $rating_method eq 'upstream' now
 483             $csv->combine(@call_details);
 484             $call_details = [ 'C', $csv->string, $charge, $classnum ];
 485           }
 486           warn "  adding details on charge to invoice: [ ".
 487               join(', ', @{$call_details} ). " ]"
 488             if ( $DEBUG && ref($call_details) );
 489           push @$details, $call_details; #\@call_details,
 490         }
 491
 492         # if the customer flag is on, call "downstream_csv" or something
 493         # like it to export the call downstream!
 494         # XXX price plan option to pick format, or something...
 495         $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
 496           if $spool_cdr;
 497
 498         my $error = $cdr->set_status_and_rated_price('done', $charge);
 499         die $error if $error;
 500
 501       }
 502
 503     } # $cdr
 504
 505   } # $cust_svc
 506
 507   unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
 508     if @$details && $rating_method ne 'upstream';
 509
 510   if ( $spool_cdr && length($downstream_cdr) ) {
 511
 512     use FS::UID qw(datasrc);
 513     my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
 514     mkdir $dir, 0700 unless -d $dir;
 515     $dir .= '/'. $cust_pkg->custnum.
 516     mkdir $dir, 0700 unless -d $dir;
 517     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
 518
 519     push @{ $param->{'precommit_hooks'} },
 520          sub {
 521                #lock the downstream spool file and append the records
 522                use Fcntl qw(:flock);
 523                use IO::File;
 524                my $spool = new IO::File ">>$filename"
 525                  or die "can't open $filename: $!\n";
 526                flock( $spool, LOCK_EX)
 527                  or die "can't lock $filename: $!\n";
 528                seek($spool, 0, 2)
 529                  or die "can't seek to end of $filename: $!\n";
 530                print $spool $downstream_cdr;
 531                flock( $spool, LOCK_UN );
 532                close $spool;
 533              };
 534
 535   } #if ( $spool_cdr && length($downstream_cdr) )
 536
 537   $charges += $self->option('recur_fee')
 538     if $param->{'increment_next_bill'};
 539
 540   $charges;
 541 }
 542
 543 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
 544 sub check_chargable {
 545   my( $self, $cdr, %flags ) = @_;
 546
 547   #should have some better way of checking these options from a hash
 548   #or something
 549
 550   my @opt = qw(
 551     use_amaflags
 552     use_disposition
 553     use_disposition_taqua
 554     use_carrierid
 555     use_cdrtypenum
 556     skip_dcontext
 557     skip_dstchannel_prefix;
 558   );
 559   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
 560     $flags{option_cache}->{$opt} = $self->option($opt);
 561   }
 562   my %opt = %{ $flags{option_cache} };
 563
 564   return 'amaflags != 2'
 565     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
 566
 567   return 'disposition != ANSWERED'
 568     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
 569
 570   return "disposition != 100"
 571     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
 572
 573   return "carrierid != $opt{'use_carrierid'}"
 574     if length($opt{'use_carrierid'})
 575     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
 576     && ! $flags{'da_rewrote'};
 577
 578   return "cdrtypenum != $opt{'use_cdrtypenum'}"
 579     if length($opt{'use_cdrtypenum'})
 580     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
 581
 582   return "dcontext IN ( $opt{'skip_dcontext'} )"
 583     if $opt{'skip_dcontext'} =~ /\S/
 584     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
 585
 586   my $len = length($opt{'skip_dstchannel_prefix'});
 587   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
 588     if $len
 589     && substr($cdr->dstchannel, 0, $len) eq $opt{'skip_dstchannel_prefix'};
 590
 591   #all right then, rate it
 592   '';
 593 }
 594
 595 sub is_free {
 596   0;
 597 }
 598
 599 sub base_recur {
 600   my($self, $cust_pkg) = @_;
 601   $self->option('recur_fee');
 602 }
 603
 604 #  This equates svc_phone records; perhaps svc_phone should have a field
 605 #  to indicate it represents a line
 606 sub calc_units {
 607   my($self, $cust_pkg ) = @_;
 608   scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
 609 }
 610
 611 1;
 612