1 package FS::part_pkg::voip_cdr;
4 use vars qw(@ISA $DEBUG %info);
8 use FS::Record qw(qsearchs qsearch);
9 use FS::part_pkg::flat;
15 @ISA = qw(FS::part_pkg::flat);
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.',
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',
31 tie my %temporalities, 'Tie::IxHash',
32 'upcoming' => "Upcoming (future)",
33 'preceding' => "Preceding (past)",
37 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
38 'shortname' => 'VoIP/telco CDR rating (standard)',
40 'setup_fee' => { 'name' => 'Setup fee for this package',
43 'recur_fee' => { 'name' => 'Base recurring fee for this package',
47 #false laziness w/flat.pm
48 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
50 'select_options' => \%temporalities,
53 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
54 ' of service at cancellation',
58 'rating_method' => { 'name' => 'Region rating method',
60 'options' => \%rating_method,
63 'ratenum' => { 'name' => 'Rate plan',
65 'select_table' => 'rate',
66 'select_key' => 'ratenum',
67 'select_label' => 'ratename',
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.',
74 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
78 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
82 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
86 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
87 # 'type' => 'checkbox',
90 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
94 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
98 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
102 'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
103 'type' => 'checkbox',
106 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
107 'type' => 'checkbox',
110 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
113 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
116 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
117 'type' => 'checkbox',
120 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
123 'output_format' => { 'name' => 'CDR invoice display format',
125 'select_options' => { FS::cdr::invoice_formats() },
126 'default' => 'default', #XXX test
129 'usage_section' => { 'name' => 'Section in which to place separate usage charges',
132 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
133 'type' => 'checkbox',
136 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.',
137 'type' => 'checkbox',
140 #XXX also have option for an external db
141 # 'cdr_location' => { 'name' => 'CDR database location'
142 # 'type' => 'select',
143 # 'select_options' => \%cdr_location,
144 # 'select_callback' => {
146 # 'enable' => [ 'datasrc', 'username', 'password' ],
149 # 'disable' => [ 'datasrc', 'username', 'password' ],
153 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
156 # 'username' => { 'name' => 'External database username',
159 # 'password' => { 'name' => 'External database password',
165 setup_fee recur_fee recur_temporality unused_credit
166 rating_method ratenum ignore_unrateable
169 domestic_prefix international_prefix
171 use_amaflags use_disposition
172 use_disposition_taqua use_carrierid use_cdrtypenum
175 output_format summarize_usage usage_section
183 my($self, $cust_pkg ) = @_;
184 $self->option('setup_fee');
187 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
189 my($self, $cust_pkg, $sdate, $details, $param ) = @_;
191 #my $last_bill = $cust_pkg->last_bill;
192 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
195 if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
197 my $ratenum = $cust_pkg->part_pkg->option('ratenum');
199 my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
201 my %included_min = ();
205 my $downstream_cdr = '';
207 my $rating_method = $self->option('rating_method') || 'prefix';
210 $self->option('output_format', 'Hush!')
211 || ( $rating_method eq 'upstream_simple' ? 'simple' : 'default' );
213 eval "use Text::CSV_XS;";
215 my $csv = new Text::CSV_XS;
217 foreach my $cust_svc (
218 grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
222 $cust_svc->get_cdrs_for_update( 'disable_src' => $self->option('disable_src'),
223 'default_prefix' => $self->option('default_prefix'),
224 ) # $last_bill, $$sdate )
227 warn "rating CDR $cdr\n".
228 join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
232 my( $rate_region, $regionnum );
236 my @call_details = ();
237 if ( $rating_method eq 'prefix' ) {
240 if ( $self->option('411_rewrite') ) {
241 my $dirass = $self->option('411_rewrite');
243 my @dirass = split(',', $dirass);
244 if ( grep $cdr->dst eq $_, @dirass ) {
250 my $reason = $self->check_chargable( $cdr,
251 '411_rewrite' => $da_rewrite,
256 warn "not charging for CDR ($reason)\n" if $DEBUG;
262 # look up rate details based on called station id
263 # (or calling station id for toll free calls)
266 my( $to_or_from, $number );
267 if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
268 && ! $self->option('disable_tollfree')
271 $to_or_from = 'from';
273 } else { #regular call
278 warn "parsing call $to_or_from $number\n" if $DEBUG;
280 #remove non-phone# stuff and whitespace
283 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
285 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
287 my $intl = $self->option('international_prefix') || '011';
289 #determine the country code
291 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
292 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
296 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
297 #first look for 1 digit country code
298 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
300 $number = $u1.$u2.$rest;
301 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
304 } else { #3 digit country code
305 $countrycode = $three;
310 $countrycode = $self->option('domestic_prefix') || '1';
311 $number =~ s/^$countrycode//;# if length($number) > 10;
314 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
315 $pretty_destnum = "+$countrycode $number";
317 my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
318 or die "ratenum $ratenum not found!";
320 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
321 'phonenum' => $number,
324 if ( $rate_detail ) {
326 warn " found rate for regionnum $regionnum ".
327 "and rate detail $rate_detail\n"
329 $rate_region = $rate_detail->dest_region;
330 $regionnum = $rate_region->regionnum;
332 } elsif ( $self->option('ignore_unrateable', 1) ) {
336 #code below will throw a warning & skip
340 die "FATAL: no rate_detail found in ".
341 $rate->ratenum. ":". $rate->ratename. " rate plan ".
342 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
343 "add a rate or set ignore_unrateable flag on the package def\n";
348 } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove?
350 if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
352 $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
354 $regionnum = $rate_detail->dest_regionnum;
355 $rate_region = $rate_detail->dest_region;
357 $pretty_destnum = $cdr->dst;
359 warn " found rate for regionnum $regionnum and ".
360 "rate detail $rate_detail\n"
363 } else { #pass upstream price through
365 $charge = sprintf('%.2f', $cdr->upstream_price);
369 #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
370 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
374 $cdr->description, #$rate_region->regionname,
379 } elsif ( $rating_method eq 'upstream_simple' ) {
381 #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
382 $charge = sprintf('%.3f', $cdr->upstream_price);
385 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
389 $classnum = $cdr->calltypenum;
392 die "don't know how to rate CDRs using method: $rating_method\n";
396 # find the price and add detail to the invoice
399 # if $rate_detail is not found, skip this CDR... i.e.
400 # don't add it to invoice, don't set its status to done,
401 # don't call downstream_csv or something on it...
402 # but DO emit a warning...
403 #if ( ! $rate_detail && ! scalar(@call_details) ) {}
404 if ( ! $rate_detail && $charge eq '' ) {
406 warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
409 } else { # there *is* a rate_detail (or call_details), proceed...
411 unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
413 $included_min{$regionnum} = $rate_detail->min_included
414 unless exists $included_min{$regionnum};
416 my $granularity = $rate_detail->sec_granularity;
418 # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
419 my $seconds = $self->option('use_duration')
423 $seconds += $granularity - ( $seconds % $granularity )
424 if $seconds # don't granular-ize 0 billsec calls (bills them)
425 && $granularity; # 0 is per call
426 my $minutes = sprintf("%.1f", $seconds / 60);
427 $minutes =~ s/\.0$// if $granularity == 60;
429 # per call rather than per minute
430 $minutes = 1 unless $granularity;
432 $included_min{$regionnum} -= $minutes;
434 if ( $included_min{$regionnum} < 0 ) {
435 my $charge_min = 0 - $included_min{$regionnum};
436 $included_min{$regionnum} = 0;
437 $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
441 # this is why we need regionnum/rate_region....
442 warn " (rate region $rate_region)\n" if $DEBUG;
445 $cdr->downstream_csv( 'format' => $output_format,
446 'granularity' => $granularity,
447 'minutes' => $minutes,
449 'pretty_dst' => $pretty_destnum,
450 'dst_regionname' => $rate_region->regionname,
454 $classnum = $rate_detail->classnum;
459 #just use FS::cust_bill_pkg_detail objects?
462 #if ( $self->option('rating_method') eq 'upstream_simple' ) {
463 if ( scalar(@call_details) == 1 ) {
464 $call_details = [ 'C', $call_details[0], $charge, $classnum ];
465 } else { #only used for $rating_method eq 'upstream' now
466 $csv->combine(@call_details);
467 $call_details = [ 'C', $csv->string, $charge, $classnum ];
469 warn " adding details on charge to invoice: [ ".
470 join(', ', @{$call_details} ). " ]"
471 if ( $DEBUG && ref($call_details) );
472 push @$details, $call_details; #\@call_details,
475 # if the customer flag is on, call "downstream_csv" or something
476 # like it to export the call downstream!
477 # XXX price plan option to pick format, or something...
478 $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
481 my $error = $cdr->set_status_and_rated_price('done', $charge);
482 die $error if $error;
490 unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
491 if @$details && $rating_method ne 'upstream';
493 if ( $spool_cdr && length($downstream_cdr) ) {
495 use FS::UID qw(datasrc);
496 my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
497 mkdir $dir, 0700 unless -d $dir;
498 $dir .= '/'. $cust_pkg->custnum.
499 mkdir $dir, 0700 unless -d $dir;
500 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
502 push @{ $param->{'precommit_hooks'} },
504 #lock the downstream spool file and append the records
505 use Fcntl qw(:flock);
507 my $spool = new IO::File ">>$filename"
508 or die "can't open $filename: $!\n";
509 flock( $spool, LOCK_EX)
510 or die "can't lock $filename: $!\n";
512 or die "can't seek to end of $filename: $!\n";
513 print $spool $downstream_cdr;
514 flock( $spool, LOCK_UN );
518 } #if ( $spool_cdr && length($downstream_cdr) )
520 $charges += $self->option('recur_fee')
521 if $param->{'increment_next_bill'};
526 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
527 sub check_chargable {
528 my( $self, $cdr, %opt ) = @_;
530 #should have some better way of checking these options from a hash
533 return 'amaflags != 2'
534 if $self->option('use_amaflags') && $cdr->amaflags != 2;
536 return 'disposition != ANSWERED'
537 if $self->option('use_disposition') && $cdr->disposition ne 'ANSWERED';
539 return "disposition != 100"
540 if $self->option('use_disposition_taqua') && $cdr->disposition != 100;
542 return 'carrierid != '. $self->option('use_carrierid')
543 if $self->option('use_carrierid')
544 && $cdr->carrierid != $self->option('use_carrierid')
545 && ! $opt{'411_rewrite'};
547 return 'cdrtypenum != '. $self->option('use_cdrtypenum')
548 if $self->option('use_cdrtypenum')
549 && $cdr->cdrtypenum != $self->option('use_cdrtypenum');
551 #all right then, rate it
560 my($self, $cust_pkg) = @_;
561 $self->option('recur_fee');
564 # This equates svc_phone records; perhaps svc_phone should have a field
565 # to indicate it represents a line
567 my($self, $cust_pkg ) = @_;
568 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);