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::recur_Common;
14 use FS::part_pkg::recur_Common;
16 @ISA = qw(FS::part_pkg::recur_Common);
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 'single_price' => 'A single price per minute for all calls.',
27 #tie my %cdr_location, 'Tie::IxHash',
28 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
29 # 'external' => 'External: CDR records queried directly from an external '.
30 # 'Asterisk (or other?) CDR table',
33 tie my %temporalities, 'Tie::IxHash',
34 'upcoming' => "Upcoming (future)",
35 'preceding' => "Preceding (past)",
38 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
41 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
42 'shortname' => 'VoIP/telco CDR rating (standard)',
44 'setup_fee' => { 'name' => 'Setup fee for this package',
47 'recur_fee' => { 'name' => 'Base recurring fee for this package',
51 #false laziness w/flat.pm
52 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
54 'select_options' => \%temporalities,
57 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
58 ' of service at cancellation',
62 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
67 'recur_method' => { 'name' => 'Recurring fee method',
69 #'options' => \%recur_method,
71 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
74 'rating_method' => { 'name' => 'Rating method',
76 'options' => \%rating_method,
79 'ratenum' => { 'name' => 'Rate plan',
81 'select_table' => 'rate',
82 'select_key' => 'ratenum',
83 'select_label' => 'ratename',
86 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
89 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
91 'select_options' => \%granularity,
94 '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.',
98 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
102 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
106 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
110 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
111 # 'type' => 'checkbox',
114 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
118 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
119 'type' => 'checkbox',
122 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
123 'type' => 'checkbox',
126 'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
127 'type' => 'checkbox',
130 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
131 'type' => 'checkbox',
134 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
137 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
140 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
143 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
146 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
149 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
152 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
153 'type' => 'checkbox',
156 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
159 #false laziness w/cdr_termination.pm
160 'output_format' => { 'name' => 'CDR invoice display format',
162 'select_options' => { FS::cdr::invoice_formats() },
163 'default' => 'default', #XXX test
166 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not)',
169 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
170 'type' => 'checkbox',
173 'usage_mandate' => { 'name' => 'Always put usage details in separate section',
174 'type' => 'checkbox',
178 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.',
179 'type' => 'checkbox',
182 '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.',
183 'type' => 'checkbox',
186 #XXX also have option for an external db
187 # 'cdr_location' => { 'name' => 'CDR database location'
188 # 'type' => 'select',
189 # 'select_options' => \%cdr_location,
190 # 'select_callback' => {
192 # 'enable' => [ 'datasrc', 'username', 'password' ],
195 # 'disable' => [ 'datasrc', 'username', 'password' ],
199 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
202 # 'username' => { 'name' => 'External database username',
205 # 'password' => { 'name' => 'External database password',
211 setup_fee recur_fee recur_temporality unused_credit
212 recur_method cutoff_day
213 rating_method ratenum min_charge sec_granularity
217 domestic_prefix international_prefix
219 use_amaflags use_disposition
220 use_disposition_taqua use_carrierid use_cdrtypenum
221 skip_dcontext skip_dstchannel_prefix
222 skip_dst_length_less skip_lastapp
225 output_format usage_mandate summarize_usage usage_section
227 count_available_phones
234 my($self, $cust_pkg ) = @_;
235 $self->option('setup_fee');
240 my($cust_pkg, $sdate, $details, $param ) = @_;
244 $charges += $self->calc_usage(@_);
245 $charges += $self->calc_recur_Common(@_);
253 my($cust_pkg, $sdate, $details, $param ) = @_;
255 $self->calc_usage(@_);
258 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
262 my($cust_pkg, $sdate, $details, $param ) = @_;
264 #my $last_bill = $cust_pkg->last_bill;
265 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
268 if $self->option('recur_temporality', 1) eq 'preceding'
269 && ( $last_bill eq '' || $last_bill == 0 );
271 my $ratenum = $cust_pkg->part_pkg->option('ratenum');
273 my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
275 my %included_min = ();
279 # my $downstream_cdr = '';
281 my $rating_method = $self->option('rating_method') || 'prefix';
282 my $intl = $self->option('international_prefix') || '011';
283 my $domestic_prefix = $self->option('domestic_prefix');
284 my $disable_tollfree = $self->option('disable_tollfree');
285 my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
286 my $use_duration = $self->option('use_duration');
288 my $output_format = $self->option('output_format', 'Hush!')
289 || ( $rating_method eq 'upstream_simple'
295 if ( $self->option('411_rewrite') ) {
296 my $dirass = $self->option('411_rewrite');
298 @dirass = split(',', $dirass);
301 #for check_chargable, so we don't keep looking up options inside the loop
304 eval "use Text::CSV_XS;";
306 my $csv = new Text::CSV_XS;
308 foreach my $cust_svc (
309 grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
313 $cust_svc->get_cdrs_for_update(
314 'disable_src' => $self->option('disable_src'),
315 'default_prefix' => $self->option('default_prefix'),
316 ) # $last_bill, $$sdate )
319 warn "rating CDR $cdr\n".
320 join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
324 my( $rate_region, $regionnum );
330 my @call_details = ();
331 if ( $rating_method eq 'prefix' ) {
334 if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
339 my $reason = $self->check_chargable( $cdr,
340 'da_rewrote' => $da_rewrote,
341 'option_cache' => \%opt_cache,
346 warn "not charging for CDR ($reason)\n" if $DEBUG;
352 # look up rate details based on called station id
353 # (or calling station id for toll free calls)
356 my( $to_or_from, $number );
357 if ( $cdr->is_tollfree && ! $disable_tollfree )
359 $to_or_from = 'from';
361 } else { #regular call
366 warn "parsing call $to_or_from $number\n" if $DEBUG;
368 #remove non-phone# stuff and whitespace
371 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
373 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
375 #determine the country code
377 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
378 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
382 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
383 #first look for 1 digit country code
384 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
386 $number = $u1.$u2.$rest;
387 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
390 } else { #3 digit country code
391 $countrycode = $three;
396 $countrycode = $domestic_prefix || '1';
397 $number =~ s/^$countrycode//;# if length($number) > 10;
400 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
401 $pretty_destnum = "+$countrycode $number";
403 my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
404 or die "ratenum $ratenum not found!";
406 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
407 'phonenum' => $number,
410 if ( $rate_detail ) {
412 $rate_region = $rate_detail->dest_region;
413 $regionnum = $rate_region->regionnum;
414 $regionname = $rate_region->regionname;
415 warn " found rate for regionnum $regionnum ".
416 "and rate detail $rate_detail\n"
419 } elsif ( $ignore_unrateable ) {
423 #code below will throw a warning & skip
427 die "FATAL: no rate_detail found in ".
428 $rate->ratenum. ":". $rate->ratename. " rate plan ".
429 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
430 "add a rate or set ignore_unrateable flag on the package def\n";
435 # } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove?
437 # if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
439 # $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
441 # $regionnum = $rate_detail->dest_regionnum;
442 # $rate_region = $rate_detail->dest_region;
444 # $pretty_destnum = $cdr->dst;
446 # warn " found rate for regionnum $regionnum and ".
447 # "rate detail $rate_detail\n"
450 # } else { #pass upstream price through
452 # $charge = sprintf('%.2f', $cdr->upstream_price);
453 # $charges += $charge;
456 # #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
457 # 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
461 # $cdr->description, #$rate_region->regionname,
466 } elsif ( $rating_method eq 'upstream_simple' ) {
468 #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
469 $charge = sprintf('%.3f', $cdr->upstream_price);
472 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
476 $classnum = $cdr->calltypenum;
478 } elsif ( $rating_method eq 'single_price' ) {
480 # a little false laziness w/below
482 my $granularity = length($self->option('sec_granularity'))
483 ? $self->option('sec_granularity')
486 # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
487 $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
489 $seconds += $granularity - ( $seconds % $granularity )
490 if $seconds # don't granular-ize 0 billsec calls (bills them)
491 && $granularity; # 0 is per call
492 my $minutes = $seconds / 60; # sprintf("%.1f",
493 #$minutes =~ s/\.0$// if $granularity == 60;
496 #$charge = sprintf('%.2f', ( $self->option('min_charge') * $minutes )
497 #+ 0.00000001 ); #so 1.005 rounds to 1.01
498 $charge = sprintf('%.4f', ( $self->option('min_charge') * $minutes )
499 + 0.0000000001 ); #so 1.00005 rounds to 1.0001
503 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
509 die "don't know how to rate CDRs using method: $rating_method\n";
513 # find the price and add detail to the invoice
516 # if $rate_detail is not found, skip this CDR... i.e.
517 # don't add it to invoice, don't set its status to done,
518 # don't call downstream_csv or something on it...
519 # but DO emit a warning...
520 #if ( ! $rate_detail && ! scalar(@call_details) ) {}
521 if ( ! $rate_detail && $charge eq '' ) {
523 warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
526 } else { # there *is* a rate_detail (or call_details), proceed...
528 unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
530 $included_min{$regionnum} = $rate_detail->min_included
531 unless exists $included_min{$regionnum};
533 my $granularity = $rate_detail->sec_granularity;
535 # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
536 $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
538 $seconds += $granularity - ( $seconds % $granularity )
539 if $seconds # don't granular-ize 0 billsec calls (bills them)
540 && $granularity; # 0 is per call
541 my $minutes = sprintf("%.1f", $seconds / 60);
542 $minutes =~ s/\.0$// if $granularity == 60;
544 # per call rather than per minute
545 $minutes = 1 unless $granularity;
547 $included_min{$regionnum} -= $minutes;
549 if ( $included_min{$regionnum} < 0 ) {
550 my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve
552 $included_min{$regionnum} = 0;
553 $charge = sprintf('%.2f', ( $rate_detail->min_charge * $charge_min )
554 + 0.00000001 ); #so 1.005 rounds to 1.01
558 # this is why we need regionnum/rate_region....
559 warn " (rate region $rate_region)\n" if $DEBUG;
562 $cdr->downstream_csv( 'format' => $output_format,
563 'granularity' => $granularity,
564 'minutes' => $minutes,
566 'pretty_dst' => $pretty_destnum,
567 'dst_regionname' => $regionname,
571 $classnum = $rate_detail->classnum;
576 #just use FS::cust_bill_pkg_detail objects?
578 my $phonenum = $cust_svc->svc_x->phonenum;
580 #if ( $self->option('rating_method') eq 'upstream_simple' ) {
581 if ( scalar(@call_details) == 1 ) {
591 } else { #only used for $rating_method eq 'upstream' now
592 $csv->combine(@call_details);
603 warn " adding details on charge to invoice: [ ".
604 join(', ', @{$call_details} ). " ]"
605 if ( $DEBUG && ref($call_details) );
606 push @$details, $call_details; #\@call_details,
609 # if the customer flag is on, call "downstream_csv" or something
610 # like it to export the call downstream!
611 # XXX price plan option to pick format, or something...
612 #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
615 my $error = $cdr->set_status_and_rated_price( 'done',
619 die $error if $error;
627 unshift @$details, [ 'C',
628 FS::cdr::invoice_header($output_format),
635 if @$details && $rating_method ne 'upstream';
637 # if ( $spool_cdr && length($downstream_cdr) ) {
639 # use FS::UID qw(datasrc);
640 # my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
641 # mkdir $dir, 0700 unless -d $dir;
642 # $dir .= '/'. $cust_pkg->custnum.
643 # mkdir $dir, 0700 unless -d $dir;
644 # 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
646 # push @{ $param->{'precommit_hooks'} },
648 # #lock the downstream spool file and append the records
649 # use Fcntl qw(:flock);
651 # my $spool = new IO::File ">>$filename"
652 # or die "can't open $filename: $!\n";
653 # flock( $spool, LOCK_EX)
654 # or die "can't lock $filename: $!\n";
656 # or die "can't seek to end of $filename: $!\n";
657 # print $spool $downstream_cdr;
658 # flock( $spool, LOCK_UN );
662 # } #if ( $spool_cdr && length($downstream_cdr) )
667 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
668 sub check_chargable {
669 my( $self, $cdr, %flags ) = @_;
671 #should have some better way of checking these options from a hash
677 use_disposition_taqua
681 skip_dstchannel_prefix
685 foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
686 $flags{option_cache}->{$opt} = $self->option($opt, 1);
688 my %opt = %{ $flags{option_cache} };
690 return 'amaflags != 2'
691 if $opt{'use_amaflags'} && $cdr->amaflags != 2;
693 return 'disposition != ANSWERED'
694 if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
696 return "disposition != 100"
697 if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
699 return "carrierid != $opt{'use_carrierid'}"
700 if length($opt{'use_carrierid'})
701 && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
702 && ! $flags{'da_rewrote'};
704 return "cdrtypenum != $opt{'use_cdrtypenum'}"
705 if length($opt{'use_cdrtypenum'})
706 && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
708 return "dcontext IN ( $opt{'skip_dcontext'} )"
709 if $opt{'skip_dcontext'} =~ /\S/
710 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
712 my $len_prefix = length($opt{'skip_dstchannel_prefix'});
713 return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
715 && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
717 my $dst_length = $opt{'skip_dst_length_less'};
718 return "destination less than $dst_length digits"
719 if $dst_length && length($cdr->dst) < $dst_length;
721 return "lastapp is $opt{'skip_lastapp'}"
722 if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
724 #all right then, rate it
732 # This equates svc_phone records; perhaps svc_phone should have a field
733 # to indicate it represents a line
735 my($self, $cust_pkg ) = @_;
737 if ( $self->option('count_available_phones', 1)) {
738 map { $count += ( $_->quantity || 0 ) }
739 grep { $_->part_svc->svcdb eq 'svc_phone' }
740 $cust_pkg->part_pkg->pkg_svc;
743 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);