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 %cdr_svc_method, 'Tie::IxHash',
21 'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)',
22 'svc_pbx.title' => 'PBX name (svc_pbx.title)',
25 tie my %rating_method, 'Tie::IxHash',
26 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
27 # '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.',
28 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
29 'single_price' => 'A single price per minute for all calls.',
32 #tie my %cdr_location, 'Tie::IxHash',
33 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
34 # 'external' => 'External: CDR records queried directly from an external '.
35 # 'Asterisk (or other?) CDR table',
38 tie my %temporalities, 'Tie::IxHash',
39 'upcoming' => "Upcoming (future)",
40 'preceding' => "Preceding (past)",
43 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
46 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
47 'shortname' => 'VoIP/telco CDR rating (standard)',
49 'setup_fee' => { 'name' => 'Setup fee for this package',
52 'recur_fee' => { 'name' => 'Base recurring fee for this package',
56 #false laziness w/flat.pm
57 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
59 'select_options' => \%temporalities,
62 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
63 ' of service at cancellation',
67 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
72 'recur_method' => { 'name' => 'Recurring fee method',
74 #'options' => \%recur_method,
76 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
79 'cdr_svc_method' => { 'name' => 'CDR service matching method',
81 'options' => \%cdr_svc_method,
84 'rating_method' => { 'name' => 'Rating method',
86 'options' => \%rating_method,
89 'ratenum' => { 'name' => 'Rate plan',
91 'select_table' => 'rate',
92 'select_key' => 'ratenum',
93 'select_label' => 'ratename',
96 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
99 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
101 'select_options' => \%granularity,
104 '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.',
105 'type' => 'checkbox',
108 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
112 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
116 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
120 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
121 # 'type' => 'checkbox',
124 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
128 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
129 'type' => 'checkbox',
132 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
133 'type' => 'checkbox',
136 'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
137 'type' => 'checkbox',
140 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
141 'type' => 'checkbox',
144 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
147 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
150 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
153 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
156 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
159 'noskip_src_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where source is equal or greater than the specified digits and accountcode is toll free',
160 'type' => 'checkbox',
163 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
166 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
169 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
170 'type' => 'checkbox',
173 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
176 #false laziness w/cdr_termination.pm
177 'output_format' => { 'name' => 'CDR invoice display format',
179 'select_options' => { FS::cdr::invoice_formats() },
180 'default' => 'default', #XXX test
183 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not)',
186 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
187 'type' => 'checkbox',
190 'usage_mandate' => { 'name' => 'Always put usage details in separate section',
191 'type' => 'checkbox',
195 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.',
196 'type' => 'checkbox',
199 '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.',
200 'type' => 'checkbox',
203 #XXX also have option for an external db
204 # 'cdr_location' => { 'name' => 'CDR database location'
205 # 'type' => 'select',
206 # 'select_options' => \%cdr_location,
207 # 'select_callback' => {
209 # 'enable' => [ 'datasrc', 'username', 'password' ],
212 # 'disable' => [ 'datasrc', 'username', 'password' ],
216 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
219 # 'username' => { 'name' => 'External database username',
222 # 'password' => { 'name' => 'External database password',
228 setup_fee recur_fee recur_temporality unused_credit
229 recur_method cutoff_day
231 rating_method ratenum min_charge sec_granularity
235 domestic_prefix international_prefix
237 use_amaflags use_disposition
238 use_disposition_taqua use_carrierid use_cdrtypenum
239 skip_dcontext skip_dstchannel_prefix
240 skip_src_length_more noskip_src_length_accountcode_tollfree
241 skip_dst_length_less skip_lastapp
244 output_format usage_mandate summarize_usage usage_section
246 count_available_phones
253 my($self, $cust_pkg ) = @_;
254 $self->option('setup_fee');
259 my($cust_pkg, $sdate, $details, $param ) = @_;
263 $charges += $self->calc_usage(@_);
264 $charges += $self->calc_recur_Common(@_);
272 my($cust_pkg, $sdate, $details, $param ) = @_;
274 $self->calc_usage(@_);
277 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
281 my($cust_pkg, $sdate, $details, $param ) = @_;
283 #my $last_bill = $cust_pkg->last_bill;
284 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
287 if $self->option('recur_temporality', 1) eq 'preceding'
288 && ( $last_bill eq '' || $last_bill == 0 );
290 my $ratenum = $cust_pkg->part_pkg->option('ratenum');
292 my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
294 my %included_min = ();
298 # my $downstream_cdr = '';
300 my $cdr_svc_method = $self->option('cdr_svc_method')||'svc_phone.phonenum';
301 my $rating_method = $self->option('rating_method') || 'prefix';
302 my $intl = $self->option('international_prefix') || '011';
303 my $domestic_prefix = $self->option('domestic_prefix');
304 my $disable_tollfree = $self->option('disable_tollfree');
305 my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
306 my $use_duration = $self->option('use_duration');
308 my $output_format = $self->option('output_format', 'Hush!')
309 || ( $rating_method eq 'upstream_simple'
315 if ( $self->option('411_rewrite') ) {
316 my $dirass = $self->option('411_rewrite');
318 @dirass = split(',', $dirass);
321 #for check_chargable, so we don't keep looking up options inside the loop
324 eval "use Text::CSV_XS;";
326 my $csv = new Text::CSV_XS;
328 my($svc_table, $svc_field) = split('.', $cdr_svc_method);
330 foreach my $cust_svc (
331 grep { $_->part_svc->svcdb eq $svc_table } $cust_pkg->cust_svc
334 my $svc_x = $cust_svc->svc_x;
337 'disable_src' => $self->option('disable_src'),
338 'default_prefix' => $self->option('default_prefix'),
341 ) # $last_bill, $$sdate )
344 warn "rating CDR $cdr\n".
345 join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
349 my( $rate_region, $regionnum );
355 my @call_details = ();
356 if ( $rating_method eq 'prefix' ) {
359 if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
364 my $reason = $self->check_chargable( $cdr,
365 'da_rewrote' => $da_rewrote,
366 'option_cache' => \%opt_cache,
371 warn "not charging for CDR ($reason)\n" if $DEBUG;
377 # look up rate details based on called station id
378 # (or calling station id for toll free calls)
381 my( $to_or_from, $number );
382 if ( $cdr->is_tollfree && ! $disable_tollfree )
384 $to_or_from = 'from';
386 } else { #regular call
391 warn "parsing call $to_or_from $number\n" if $DEBUG;
393 #remove non-phone# stuff and whitespace
396 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
398 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
400 #determine the country code
402 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
403 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
407 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
408 #first look for 1 digit country code
409 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
411 $number = $u1.$u2.$rest;
412 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
415 } else { #3 digit country code
416 $countrycode = $three;
421 $countrycode = $domestic_prefix || '1';
422 $number =~ s/^$countrycode//;# if length($number) > 10;
425 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
426 $pretty_destnum = "+$countrycode $number";
427 #asterisks here causes inserting the detail to barf, so:
428 $pretty_destnum =~ s/\*//g;
430 my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
431 or die "ratenum $ratenum not found!";
433 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
434 'phonenum' => $number,
437 if ( $rate_detail ) {
439 $rate_region = $rate_detail->dest_region;
440 $regionnum = $rate_region->regionnum;
441 $regionname = $rate_region->regionname;
442 warn " found rate for regionnum $regionnum ".
443 "and rate detail $rate_detail\n"
446 } elsif ( $ignore_unrateable ) {
450 #code below will throw a warning & skip
454 die "FATAL: no rate_detail found in ".
455 $rate->ratenum. ":". $rate->ratename. " rate plan ".
456 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
457 "add a rate or set ignore_unrateable flag on the package def\n";
462 # } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove?
464 # if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
466 # $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
468 # $regionnum = $rate_detail->dest_regionnum;
469 # $rate_region = $rate_detail->dest_region;
471 # $pretty_destnum = $cdr->dst;
473 # warn " found rate for regionnum $regionnum and ".
474 # "rate detail $rate_detail\n"
477 # } else { #pass upstream price through
479 # $charge = sprintf('%.2f', $cdr->upstream_price);
480 # warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
481 # $charges += $charge;
484 # #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
485 # 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
489 # $cdr->description, #$rate_region->regionname,
494 } elsif ( $rating_method eq 'upstream_simple' ) {
496 #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
497 $charge = sprintf('%.3f', $cdr->upstream_price);
499 warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
501 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
505 $classnum = $cdr->calltypenum;
507 } elsif ( $rating_method eq 'single_price' ) {
509 # a little false laziness w/below
511 my $granularity = length($self->option('sec_granularity'))
512 ? $self->option('sec_granularity')
515 # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
516 $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
518 $seconds += $granularity - ( $seconds % $granularity )
519 if $seconds # don't granular-ize 0 billsec calls (bills them)
520 && $granularity; # 0 is per call
521 my $minutes = $seconds / 60; # sprintf("%.1f",
522 #$minutes =~ s/\.0$// if $granularity == 60;
525 #$charge = sprintf('%.2f', ( $self->option('min_charge') * $minutes )
526 #+ 0.00000001 ); #so 1.005 rounds to 1.01
527 $charge = sprintf('%.4f', ( $self->option('min_charge') * $minutes )
528 + 0.0000000001 ); #so 1.00005 rounds to 1.0001
530 warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
533 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
539 die "don't know how to rate CDRs using method: $rating_method\n";
543 # find the price and add detail to the invoice
546 # if $rate_detail is not found, skip this CDR... i.e.
547 # don't add it to invoice, don't set its status to done,
548 # don't call downstream_csv or something on it...
549 # but DO emit a warning...
550 #if ( ! $rate_detail && ! scalar(@call_details) ) {}
551 if ( ! $rate_detail && $charge eq '' ) {
553 warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
556 } else { # there *is* a rate_detail (or call_details), proceed...
558 unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
560 $included_min{$regionnum} = $rate_detail->min_included
561 unless exists $included_min{$regionnum};
563 my $granularity = $rate_detail->sec_granularity;
565 # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
566 $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
568 $seconds -= $rate_detail->conn_sec;
569 $seconds = 0 if $seconds < 0;
571 $seconds += $granularity - ( $seconds % $granularity )
572 if $seconds # don't granular-ize 0 billsec calls (bills them)
573 && $granularity; # 0 is per call
574 my $minutes = sprintf("%.1f", $seconds / 60);
575 $minutes =~ s/\.0$// if $granularity == 60;
577 # per call rather than per minute
578 $minutes = 1 unless $granularity;
580 $included_min{$regionnum} -= $minutes;
582 $charge = sprintf('%.2f', $rate_detail->conn_charge);
584 if ( $included_min{$regionnum} <= 0 ) {
585 my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve
587 $included_min{$regionnum} = 0;
588 $charge += sprintf('%.2f', ($rate_detail->min_charge * $charge_min)
589 + 0.00000001 ); #so 1.005 rounds to 1.01
590 $charge = sprintf('%.2f', $charge);
591 warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
595 # this is why we need regionnum/rate_region....
596 warn " (rate region $rate_region)\n" if $DEBUG;
599 $cdr->downstream_csv( 'format' => $output_format,
600 'granularity' => $granularity,
601 'minutes' => $minutes,
603 'pretty_dst' => $pretty_destnum,
604 'dst_regionname' => $regionname,
608 $classnum = $rate_detail->classnum;
613 #just use FS::cust_bill_pkg_detail objects?
615 my $phonenum = $cust_svc->svc_x->phonenum;
617 #if ( $self->option('rating_method') eq 'upstream_simple' ) {
618 if ( scalar(@call_details) == 1 ) {
628 } else { #only used for $rating_method eq 'upstream' now
629 $csv->combine(@call_details);
640 warn " adding details on charge to invoice: [ ".
641 join(', ', @{$call_details} ). " ]"
642 if ( $DEBUG && ref($call_details) );
643 push @$details, $call_details; #\@call_details,
646 # if the customer flag is on, call "downstream_csv" or something
647 # like it to export the call downstream!
648 # XXX price plan option to pick format, or something...
649 #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
652 my $error = $cdr->set_status_and_rated_price( 'done',
656 die $error if $error;
664 unshift @$details, [ 'C',
665 FS::cdr::invoice_header($output_format),
672 if @$details && $rating_method ne 'upstream';
674 # if ( $spool_cdr && length($downstream_cdr) ) {
676 # use FS::UID qw(datasrc);
677 # my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
678 # mkdir $dir, 0700 unless -d $dir;
679 # $dir .= '/'. $cust_pkg->custnum.
680 # mkdir $dir, 0700 unless -d $dir;
681 # 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
683 # push @{ $param->{'precommit_hooks'} },
685 # #lock the downstream spool file and append the records
686 # use Fcntl qw(:flock);
688 # my $spool = new IO::File ">>$filename"
689 # or die "can't open $filename: $!\n";
690 # flock( $spool, LOCK_EX)
691 # or die "can't lock $filename: $!\n";
693 # or die "can't seek to end of $filename: $!\n";
694 # print $spool $downstream_cdr;
695 # flock( $spool, LOCK_UN );
699 # } #if ( $spool_cdr && length($downstream_cdr) )
704 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
705 sub check_chargable {
706 my( $self, $cdr, %flags ) = @_;
708 #should have some better way of checking these options from a hash
714 use_disposition_taqua
718 skip_dstchannel_prefix
719 skip_src_length_more noskip_src_length_accountcode_tollfree
723 foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
724 $flags{option_cache}->{$opt} = $self->option($opt, 1);
726 my %opt = %{ $flags{option_cache} };
728 return 'amaflags != 2'
729 if $opt{'use_amaflags'} && $cdr->amaflags != 2;
731 return 'disposition != ANSWERED'
732 if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
734 return "disposition != 100"
735 if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
737 return "carrierid != $opt{'use_carrierid'}"
738 if length($opt{'use_carrierid'})
739 && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
740 && ! $flags{'da_rewrote'};
742 return "cdrtypenum != $opt{'use_cdrtypenum'}"
743 if length($opt{'use_cdrtypenum'})
744 && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
746 return "dcontext IN ( $opt{'skip_dcontext'} )"
747 if $opt{'skip_dcontext'} =~ /\S/
748 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
750 my $len_prefix = length($opt{'skip_dstchannel_prefix'});
751 return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
753 && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
755 my $dst_length = $opt{'skip_dst_length_less'};
756 return "destination less than $dst_length digits"
757 if $dst_length && length($cdr->dst) < $dst_length;
759 return "lastapp is $opt{'skip_lastapp'}"
760 if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
762 my $src_length = $opt{'skip_src_length_more'};
765 if ( $opt{'noskip_src_length_accountcode_tollfree'} ) {
767 if ( $cdr->is_tollfree('accountcode') ) {
768 return "source less than or equal to $src_length digits"
769 if length($cdr->src) <= $src_length;
771 return "source more than $src_length digits"
772 if length($cdr->src) > $src_length;
776 return "source more than $src_length digits"
777 if length($cdr->src) > $src_length;
782 #all right then, rate it
790 # This equates svc_phone records; perhaps svc_phone should have a field
791 # to indicate it represents a line
793 my($self, $cust_pkg ) = @_;
795 if ( $self->option('count_available_phones', 1)) {
796 map { $count += ( $_->quantity || 0 ) }
797 grep { $_->part_svc->svcdb eq 'svc_phone' }
798 $cust_pkg->part_pkg->pkg_svc;
801 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);