1 package FS::part_pkg::voip_cdr;
4 use vars qw(@ISA $DEBUG %info);
9 use FS::Record qw(qsearchs qsearch);
10 use FS::part_pkg::flat;
16 @ISA = qw(FS::part_pkg::prorate);
20 tie my %rating_method, 'Tie::IxHash',
21 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
22 # '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.',
23 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
24 'flat' => 'A single price per minute for all calls.',
27 tie my %recur_method, 'Tie::IxHash',
28 'anniversary' => 'Charge the recurring fee at the frequency specified above',
29 'prorate' => 'Charge a prorated fee the first time (selectable billing date)',
30 'subscription' => 'Charge the full fee for the first partial period (selectable billing date)',
33 #tie my %cdr_location, 'Tie::IxHash',
34 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
35 # 'external' => 'External: CDR records queried directly from an external '.
36 # 'Asterisk (or other?) CDR table',
39 tie my %temporalities, 'Tie::IxHash',
40 'upcoming' => "Upcoming (future)",
41 'preceding' => "Preceding (past)",
45 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
46 'shortname' => 'VoIP/telco CDR rating (standard)',
48 'setup_fee' => { 'name' => 'Setup fee for this package',
51 'recur_fee' => { 'name' => 'Base recurring fee for this package',
55 #false laziness w/flat.pm
56 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
58 'select_options' => \%temporalities,
61 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
62 ' of service at cancellation',
66 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
71 'recur_method' => { 'name' => 'Recurring fee method',
73 #'options' => \%recur_method,
75 'select_options' => \%recur_method,
78 'rating_method' => { 'name' => 'Region rating method',
80 'options' => \%rating_method,
83 'ratenum' => { 'name' => 'Rate plan',
85 'select_table' => 'rate',
86 'select_key' => 'ratenum',
87 'select_label' => 'ratename',
90 '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.',
94 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
98 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
102 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
106 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
107 # 'type' => 'checkbox',
110 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
114 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
115 'type' => 'checkbox',
118 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
119 'type' => 'checkbox',
122 'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
123 'type' => 'checkbox',
126 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
127 'type' => 'checkbox',
130 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
133 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
136 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
139 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
142 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
145 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
148 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
149 'type' => 'checkbox',
152 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
155 'output_format' => { 'name' => 'CDR invoice display format',
157 'select_options' => { FS::cdr::invoice_formats() },
158 'default' => 'default', #XXX test
161 'usage_section' => { 'name' => 'Section in which to place separate usage charges',
164 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
165 'type' => 'checkbox',
168 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.',
169 'type' => 'checkbox',
172 'count_available_phones' => { 'name' => 'Consider for tax purposes the number of lines to be svc_phones that may be provisioned rather than those that actually are.',
173 'type' => 'checkbox',
176 #XXX also have option for an external db
177 # 'cdr_location' => { 'name' => 'CDR database location'
178 # 'type' => 'select',
179 # 'select_options' => \%cdr_location,
180 # 'select_callback' => {
182 # 'enable' => [ 'datasrc', 'username', 'password' ],
185 # 'disable' => [ 'datasrc', 'username', 'password' ],
189 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
192 # 'username' => { 'name' => 'External database username',
195 # 'password' => { 'name' => 'External database password',
201 setup_fee recur_fee recur_temporality unused_credit
202 recur_method cutoff_day
203 rating_method ratenum ignore_unrateable
206 domestic_prefix international_prefix
208 use_amaflags use_disposition
209 use_disposition_taqua use_carrierid use_cdrtypenum
210 skip_dcontext skip_dstchannel_prefix
211 skip_dst_length_less skip_lastapp
214 output_format summarize_usage usage_section
216 count_available_phones
223 my($self, $cust_pkg ) = @_;
224 $self->option('setup_fee');
227 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
230 my($cust_pkg, $sdate, $details, $param ) = @_;
232 #my $last_bill = $cust_pkg->last_bill;
233 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
236 if $self->option('recur_temporality', 1) eq 'preceding'
237 && ( $last_bill eq '' || $last_bill == 0 );
239 my $ratenum = $cust_pkg->part_pkg->option('ratenum');
241 my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
243 my %included_min = ();
247 # my $downstream_cdr = '';
249 my $rating_method = $self->option('rating_method') || 'prefix';
250 my $intl = $self->option('international_prefix') || '011';
251 my $domestic_prefix = $self->option('domestic_prefix');
252 my $disable_tollfree = $self->option('disable_tollfree');
253 my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
254 my $use_duration = $self->option('use_duration');
256 my $output_format = $self->option('output_format', 'Hush!')
257 || ( $rating_method eq 'upstream_simple'
263 if ( $self->option('411_rewrite') ) {
264 my $dirass = $self->option('411_rewrite');
266 @dirass = split(',', $dirass);
269 #for check_chargable, so we don't keep looking up options inside the loop
272 eval "use Text::CSV_XS;";
274 my $csv = new Text::CSV_XS;
276 foreach my $cust_svc (
277 grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
281 $cust_svc->get_cdrs_for_update(
282 'disable_src' => $self->option('disable_src'),
283 'default_prefix' => $self->option('default_prefix'),
284 ) # $last_bill, $$sdate )
287 warn "rating CDR $cdr\n".
288 join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
292 my( $rate_region, $regionnum );
296 my @call_details = ();
297 if ( $rating_method eq 'prefix' ) {
300 if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
305 my $reason = $self->check_chargable( $cdr,
306 'da_rewrote' => $da_rewrote,
307 'option_cache' => \%opt_cache,
312 warn "not charging for CDR ($reason)\n" if $DEBUG;
318 # look up rate details based on called station id
319 # (or calling station id for toll free calls)
322 my( $to_or_from, $number );
323 if ( $cdr->is_tollfree && ! $disable_tollfree )
325 $to_or_from = 'from';
327 } else { #regular call
332 warn "parsing call $to_or_from $number\n" if $DEBUG;
334 #remove non-phone# stuff and whitespace
337 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
339 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
341 #determine the country code
343 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
344 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
348 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
349 #first look for 1 digit country code
350 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
352 $number = $u1.$u2.$rest;
353 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
356 } else { #3 digit country code
357 $countrycode = $three;
362 $countrycode = $domestic_prefix || '1';
363 $number =~ s/^$countrycode//;# if length($number) > 10;
366 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
367 $pretty_destnum = "+$countrycode $number";
369 my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
370 or die "ratenum $ratenum not found!";
372 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
373 'phonenum' => $number,
376 if ( $rate_detail ) {
378 $rate_region = $rate_detail->dest_region;
379 $regionnum = $rate_region->regionnum;
380 warn " found rate for regionnum $regionnum ".
381 "and rate detail $rate_detail\n"
384 } elsif ( $ignore_unrateable ) {
388 #code below will throw a warning & skip
392 die "FATAL: no rate_detail found in ".
393 $rate->ratenum. ":". $rate->ratename. " rate plan ".
394 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
395 "add a rate or set ignore_unrateable flag on the package def\n";
400 # } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove?
402 # if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
404 # $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
406 # $regionnum = $rate_detail->dest_regionnum;
407 # $rate_region = $rate_detail->dest_region;
409 # $pretty_destnum = $cdr->dst;
411 # warn " found rate for regionnum $regionnum and ".
412 # "rate detail $rate_detail\n"
415 # } else { #pass upstream price through
417 # $charge = sprintf('%.2f', $cdr->upstream_price);
418 # $charges += $charge;
421 # #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
422 # 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
426 # $cdr->description, #$rate_region->regionname,
431 } elsif ( $rating_method eq 'upstream_simple' ) {
433 #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
434 $charge = sprintf('%.3f', $cdr->upstream_price);
437 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
441 $classnum = $cdr->calltypenum;
444 die "don't know how to rate CDRs using method: $rating_method\n";
448 # find the price and add detail to the invoice
451 # if $rate_detail is not found, skip this CDR... i.e.
452 # don't add it to invoice, don't set its status to done,
453 # don't call downstream_csv or something on it...
454 # but DO emit a warning...
455 #if ( ! $rate_detail && ! scalar(@call_details) ) {}
456 if ( ! $rate_detail && $charge eq '' ) {
458 warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
461 } else { # there *is* a rate_detail (or call_details), proceed...
463 unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
465 $included_min{$regionnum} = $rate_detail->min_included
466 unless exists $included_min{$regionnum};
468 my $granularity = $rate_detail->sec_granularity;
470 # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
471 my $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
473 $seconds += $granularity - ( $seconds % $granularity )
474 if $seconds # don't granular-ize 0 billsec calls (bills them)
475 && $granularity; # 0 is per call
476 my $minutes = sprintf("%.1f", $seconds / 60);
477 $minutes =~ s/\.0$// if $granularity == 60;
479 # per call rather than per minute
480 $minutes = 1 unless $granularity;
482 $included_min{$regionnum} -= $minutes;
484 if ( $included_min{$regionnum} < 0 ) {
485 my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve
487 $included_min{$regionnum} = 0;
488 $charge = sprintf('%.2f', ( $rate_detail->min_charge * $charge_min )
489 + 0.00000001 ); #so 1.005 rounds to 1.01
493 # this is why we need regionnum/rate_region....
494 warn " (rate region $rate_region)\n" if $DEBUG;
497 $cdr->downstream_csv( 'format' => $output_format,
498 'granularity' => $granularity,
499 'minutes' => $minutes,
501 'pretty_dst' => $pretty_destnum,
502 'dst_regionname' => $rate_region->regionname,
506 $classnum = $rate_detail->classnum;
511 #just use FS::cust_bill_pkg_detail objects?
514 #if ( $self->option('rating_method') eq 'upstream_simple' ) {
515 if ( scalar(@call_details) == 1 ) {
516 $call_details = [ 'C', $call_details[0], $charge, $classnum ];
517 } else { #only used for $rating_method eq 'upstream' now
518 $csv->combine(@call_details);
519 $call_details = [ 'C', $csv->string, $charge, $classnum ];
521 warn " adding details on charge to invoice: [ ".
522 join(', ', @{$call_details} ). " ]"
523 if ( $DEBUG && ref($call_details) );
524 push @$details, $call_details; #\@call_details,
527 # if the customer flag is on, call "downstream_csv" or something
528 # like it to export the call downstream!
529 # XXX price plan option to pick format, or something...
530 #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
533 my $error = $cdr->set_status_and_rated_price('done', $charge);
534 die $error if $error;
542 unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
543 if @$details && $rating_method ne 'upstream';
545 # if ( $spool_cdr && length($downstream_cdr) ) {
547 # use FS::UID qw(datasrc);
548 # my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
549 # mkdir $dir, 0700 unless -d $dir;
550 # $dir .= '/'. $cust_pkg->custnum.
551 # mkdir $dir, 0700 unless -d $dir;
552 # 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
554 # push @{ $param->{'precommit_hooks'} },
556 # #lock the downstream spool file and append the records
557 # use Fcntl qw(:flock);
559 # my $spool = new IO::File ">>$filename"
560 # or die "can't open $filename: $!\n";
561 # flock( $spool, LOCK_EX)
562 # or die "can't lock $filename: $!\n";
564 # or die "can't seek to end of $filename: $!\n";
565 # print $spool $downstream_cdr;
566 # flock( $spool, LOCK_UN );
570 # } #if ( $spool_cdr && length($downstream_cdr) )
572 if ($param->{'increment_next_bill'}) {
573 my $recur_method = $self->option('recur_method', 1) || 'anniversary';
575 if ( $recur_method eq 'prorate' ) {
577 $charges += $self->SUPER::calc_recur(@_);
581 $charges += $self->option('recur_fee');
583 if ( $recur_method eq 'subscription' ) {
585 my $cutoff_day = $self->option('cutoff_day', 1) || 1;
586 my ($day, $mon, $year) = ( localtime($$sdate) )[ 3..5 ];
588 if ( $day < $cutoff_day ) {
589 if ( $mon == 0 ) { $mon=11; $year--; }
593 $$sdate = timelocal(0, 0, 0, $cutoff_day, $mon, $year);
595 }#$recur_method eq 'subscription'
596 }#$recur_method eq 'prorate'
597 }#increment_next_bill
602 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
603 sub check_chargable {
604 my( $self, $cdr, %flags ) = @_;
606 #should have some better way of checking these options from a hash
612 use_disposition_taqua
616 skip_dstchannel_prefix
620 foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
621 $flags{option_cache}->{$opt} = $self->option($opt, 1);
623 my %opt = %{ $flags{option_cache} };
625 return 'amaflags != 2'
626 if $opt{'use_amaflags'} && $cdr->amaflags != 2;
628 return 'disposition != ANSWERED'
629 if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
631 return "disposition != 100"
632 if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
634 return "carrierid != $opt{'use_carrierid'}"
635 if length($opt{'use_carrierid'})
636 && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
637 && ! $flags{'da_rewrote'};
639 return "cdrtypenum != $opt{'use_cdrtypenum'}"
640 if length($opt{'use_cdrtypenum'})
641 && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
643 return "dcontext IN ( $opt{'skip_dcontext'} )"
644 if $opt{'skip_dcontext'} =~ /\S/
645 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
647 my $len_prefix = length($opt{'skip_dstchannel_prefix'});
648 return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
650 && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
652 my $dst_length = $opt{'skip_dst_length_less'};
653 return "destination less than $dst_length digits"
654 if $dst_length && length($cdr->dst) < $dst_length;
656 return "lastapp is $opt{'skip_lastapp'}"
657 if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
659 #all right then, rate it
668 my($self, $cust_pkg) = @_;
669 $self->option('recur_fee');
672 # This equates svc_phone records; perhaps svc_phone should have a field
673 # to indicate it represents a line
675 my($self, $cust_pkg ) = @_;
677 if ( $self->option('count_available_phones', 1)) {
678 map { $count += ( $_->quantity || 0 ) }
679 grep { $_->part_svc->svcdb eq 'svc_phone' }
680 $cust_pkg->part_pkg->pkg_svc;
683 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);