1 package FS::part_pkg::voip_cdr;
2 use base qw( FS::part_pkg::recur_Common );
5 use vars qw( $DEBUG %info );
11 use FS::Record qw(qsearchs qsearch);
13 use FS::detail_format;
17 tie my %cdr_svc_method, 'Tie::IxHash',
18 'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)',
19 'svc_pbx.title' => 'PBX name (svc_pbx.title)',
20 'svc_pbx.svcnum' => 'Freeside service # (svc_pbx.svcnum)',
21 'svc_pbx.ip.src' => 'PBX name to source IP address',
22 'svc_pbx.ip.dst' => 'PBX name to destination IP address',
23 'svc_acct.username' => 'Username (svc_acct.username)',
26 tie my %rating_method, 'Tie::IxHash',
27 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
28 # '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.',
29 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
30 'single_price' => 'A single price per minute for all calls.',
33 tie my %rounding, 'Tie::IxHash',
34 '2' => 'Two decimal places (cent)',
35 '4' => 'Four decimal places (100th of a cent)',
38 #tie my %cdr_location, 'Tie::IxHash',
39 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
40 # 'external' => 'External: CDR records queried directly from an external '.
41 # 'Asterisk (or other?) CDR table',
44 tie my %temporalities, 'Tie::IxHash',
45 'upcoming' => "Upcoming (future)",
46 'preceding' => "Preceding (past)",
49 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
51 # previously "1" was "ignore"
52 tie my %unrateable_opts, 'Tie::IxHash',
53 '' => 'Exit with a fatal error',
54 1 => 'Ignore and continue',
55 2 => 'Flag for later review',
58 tie my %detail_formats, 'Tie::IxHash',
60 FS::cdr::invoice_formats()
63 tie my %accountcode_tollfree_field, 'Tie::IxHash',
64 'dst' => 'Destination (dst)',
65 'src' => 'Source (src)',
69 'name' => 'VoIP rating by plan of CDR records',
70 'shortname' => 'VoIP/telco CDR rating (standard)',
71 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
73 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
76 #false laziness w/flat.pm
77 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
79 'select_options' => \%temporalities,
82 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
86 'recur_method' => { 'name' => 'Recurring fee method',
88 #'options' => \%recur_method,
90 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
93 'cdr_svc_method' => { 'name' => 'CDR service matching method',
96 'select_options' => \%cdr_svc_method,
99 'rating_method' => { 'name' => 'Rating method',
101 'options' => \%rating_method,
104 'rounding' => { 'name' => 'Rounding for destination prefix rating',
106 'select_options' => \%rounding,
109 'ratenum' => { 'name' => 'Rate plan',
110 'type' => 'select-rate',
113 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
114 'type' => 'select-rate',
115 'disable_empty' => 0,
116 'empty_label' => ' ',
119 'calls_included' => { 'name' => 'Number of calls included at no usage charge', },
121 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" or "prefix" rating method',
124 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
127 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
129 'select_options' => \%granularity,
132 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
134 'select_options' => \%unrateable_opts,
137 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
141 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
145 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
149 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
150 # 'type' => 'checkbox',
153 'international_prefix' => { 'name' => 'Destination prefix for international CDR records (or "none" for no prefix)',
157 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
158 'type' => 'checkbox',
161 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
162 'type' => 'checkbox',
165 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to any of these (comma-separated) values: ',
168 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to this cdrtypenum: ',
171 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to this cdrtypenum: ',
174 'use_calltypenum' => { 'name' => 'Only charge for CDRs where the CDR Call Type is set to this calltypenum: ',
177 'ignore_calltypenum' => { 'name' => 'Do not charge for CDRs where the CDR Call Type is set to this calltypenum: ',
180 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
183 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
186 'disposition_prefix' => { 'name' => 'Only charge for CDRs where the Disposition starts with: ',
189 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these (comma-separated) values: ',
192 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where dcontext is set to any of these (comma-separated) values: ',
195 'skip_dcontext_prefix' => { 'name' => 'Do not charge for CDRs where dcontext starts with: ',
198 'skip_dcontext_suffix' => { 'name' => 'Do not charge for CDRs where dcontext ends with: ',
201 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
204 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
207 'noskip_src_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where source is equal or greater than the specified digits, when accountcode is toll free',
208 'type' => 'checkbox',
211 'accountcode_tollfree_ratenum' => {
212 'name' => 'Optional alternate rate plan when accountcode is toll free: ',
214 'select_table' => 'rate',
215 'select_key' => 'ratenum',
216 'select_label' => 'ratename',
217 'disable_empty' => 0,
221 'accountcode_tollfree_field' => {
222 'name' => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations',
224 'select_options' => \%accountcode_tollfree_field,
227 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
230 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
231 'type' => 'checkbox',
234 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
237 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
240 'skip_same_customer' => {
241 'name' => 'Do not charge for calls between numbers belonging to the same customer',
242 'type' => 'checkbox',
245 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
246 'type' => 'checkbox',
249 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
252 #false laziness w/cdr_termination.pm
253 'output_format' => { 'name' => 'CDR display format for invoices',
255 'select_options' => \%detail_formats,
256 'default' => 'default', #XXX test
259 'selfservice_format' =>
260 { 'name' => 'CDR display format for selfservice',
262 'select_options' => \%detail_formats,
263 'default' => 'default'
265 'selfservice_inbound_format' =>
266 { 'name' => 'Inbound CDR display format for selfservice',
268 'select_options' => \%detail_formats,
272 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
275 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
276 'type' => 'checkbox',
279 'usage_mandate' => { 'name' => 'Always put usage details in separate section. The section is defined in the next option.',
280 'type' => 'checkbox',
284 'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.',
285 'type' => 'checkbox',
288 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
289 'type' => 'checkbox',
292 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
293 'type' => 'checkbox',
295 'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period',
296 'type' => 'checkbox',
298 'skip_old' => { 'name' => 'Do not charge for CDRs older than: ',
302 #XXX also have option for an external db? these days we suck them into ours
303 # 'cdr_location' => { 'name' => 'CDR database location'
304 # 'type' => 'select',
305 # 'select_options' => \%cdr_location,
306 # 'select_callback' => {
308 # 'enable' => [ 'datasrc', 'username', 'password' ],
311 # 'disable' => [ 'datasrc', 'username', 'password' ],
315 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
318 # 'username' => { 'name' => 'External database username',
321 # 'password' => { 'name' => 'External database password',
328 recur_method cutoff_day ),
329 FS::part_pkg::prorate_Mixin::fieldorder,
332 rating_method rounding ratenum intrastate_ratenum
334 min_charge min_included
339 domestic_prefix international_prefix
343 use_cdrtypenum ignore_cdrtypenum
344 use_calltypenum ignore_calltypenum
345 ignore_disposition disposition_in disposition_prefix
346 skip_dcontext skip_dcontext_prefix skip_dcontext_suffix
348 skip_dstchannel_prefix skip_src_length_more
349 noskip_src_length_accountcode_tollfree
350 accountcode_tollfree_ratenum accountcode_tollfree_field
352 noskip_dst_length_accountcode_tollfree
359 selfservice_format selfservice_inbound_format
360 usage_mandate usage_section summarize_usage
361 usage_showzero bill_every_call bill_inactive_svcs
362 bill_only_pkg_dates skip_old
368 # Validation function for FS::part_pkg::check_options()
370 return "Please choose a Rate Plan for use with selected Rating Method"
371 if $options->{rating_method} eq 'prefix' && !$options->{ratenum};
378 my $str = $self->SUPER::price_info(@_);
379 $str .= " plus usage" if $str;
385 my($cust_pkg, $sdate, $details, $param ) = @_;
389 $charges += $self->calc_usage(@_);
390 $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_);
399 # my($cust_pkg, $sdate, $details, $param ) = @_;
401 # $self->calc_usage(@_);
404 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
408 my($cust_pkg, $sdate, $details, $param ) = @_;
410 #my $last_bill = $cust_pkg->last_bill;
411 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
414 if $self->recur_temporality eq 'preceding'
415 && ( $last_bill eq '' || $last_bill == 0 );
419 my $included_min_total = ($self->option('min_included', 1) || 0)
420 * ($cust_pkg->quantity || 1);
423 my $included_min_left = $included_min_total;
425 my $included_calls = $self->option('calls_included', 1) || 0;
426 $included_calls *= ($cust_pkg->quantity || 1);
428 my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
429 my $rating_method = $self->option('rating_method') || 'prefix';
430 my %detail_included_min = ();
432 my $output_format = $self->option('output_format', 'Hush!')
433 || ( $rating_method eq 'upstream_simple'
438 my $usage_showzero = $self->option('usage_showzero', 1);
440 my $formatter = FS::detail_format->new($output_format,
442 locale => $cust_pkg->cust_main->locale,
443 rounding => ($self->option_cacheable('rounding') || 2),
446 my $use_duration = $self->option('use_duration');
448 my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
451 if( $self->option('bill_inactive_svcs',1) ) {
452 #XXX in this mode do we need to restrict the set of CDRs by date also?
453 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
456 @cust_svc = $cust_pkg->cust_svc;
458 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
460 foreach my $cust_svc (@cust_svc) {
463 if( $self->option('bill_inactive_svcs',1) ) {
464 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
467 $svc_x = $cust_svc->svc_x;
471 my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : '';
472 warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n";
476 'disable_src' => $self->option('disable_src',1),
477 'default_prefix' => $self->option('default_prefix',1),
478 'cdrtypenum' => $self->option('use_cdrtypenum',1),
479 'calltypenum' => $self->option('use_calltypenum',1),
483 if ( $self->option('bill_only_pkg_dates') ) {
484 $options{'begin'} = $last_bill;
485 $options{'end'} = $$sdate;
487 if ( $svc_field eq 'svcnum' ) {
488 $options{'by_svcnum'} = 1;
489 } elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
490 $options{'by_ip_addr'} = $by_ip_addr;
493 #my @invoice_details_sort;
495 # for tagging invoice details
496 # (unfortunate; should be a svc_x class method or table_info item or
499 if ( $svc_table eq 'svc_phone' ) {
500 $phonenum = $svc_x->phonenum;
501 } elsif ( $svc_table eq 'svc_pbx' ) {
502 $phonenum = $svc_x->title;
503 } elsif ( $svc_table eq 'svc_acct' ) {
504 $phonenum = $svc_x->username;
506 $formatter->phonenum($phonenum);
508 #first rate any outstanding CDRs not yet rated
509 # use FS::Cursor for this starting in 4.x
510 my $cdr_search = $svc_x->psearch_cdrs(%options);
511 $cdr_search->limit(1000);
512 $cdr_search->increment(0); # because we're changing their status as we go
513 while ( my $cdr = $cdr_search->fetch ) {
515 my $error = $cdr->rate(
517 'cust_pkg' => $cust_pkg,
518 'svcnum' => $svc_x->svcnum,
519 'plan_included_min' => \$included_min_left,
520 'detail_included_min_hashref' => \%detail_included_min,
522 die $error if $error; #??
524 $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
525 # it was skipped without changing status, so increment the
526 # offset so that we don't re-fetch it on refill
530 #then add details to invoices & get a total
531 $options{'status'} = 'rated';
533 $cdr_search = $svc_x->psearch_cdrs(%options);
534 $cdr_search->limit(1000);
535 $cdr_search->increment(0);
536 while ( my $cdr = $cdr_search->fetch ) {
538 # at this point we officially Do Not Care about the rating method
539 if ( $included_calls > 0 ) {
541 #$charges += 0, obviously
542 #but don't set the rated price to zero--there should be a record
543 $error = $cdr->set_status('no-charge');
546 $charges += $cdr->rated_price;
547 $error = $cdr->set_status('done');
549 die $error if $error;
550 $formatter->append($cdr)
551 unless $cdr->rated_price == 0 and not $usage_showzero;
553 $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
557 $formatter->finish; #writes into $details
558 unshift @$details, $formatter->header if @$details;
560 if ( $included_min_total > 0 ) {
562 my $min_detail = sprintf('%d / %d ',
563 $included_min_total - $included_min_left,
565 ) . $cust_pkg->mt('included minutes used');
566 unshift @$details, $min_detail;
572 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
573 # lots of false laziness w/voip_inbound
574 sub check_chargable {
575 my( $self, $cdr, %flags ) = @_;
577 return 'amaflags != 2'
578 if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
580 return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
581 if $self->option_cacheable('disposition_in') =~ /\S/
582 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
584 my $disposition_prefix = $self->option_cacheable('disposition_prefix');
585 my $len_dis_prefix = length($disposition_prefix);
586 return "disposition does not start with $disposition_prefix"
588 && substr($cdr->disposition, 0, $len_dis_prefix) ne $disposition_prefix;
590 return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
591 if $self->option_cacheable('ignore_disposition') =~ /\S/
592 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
594 foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
595 return "dst starts with '$_'"
596 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
599 return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
600 if $self->option_cacheable('use_carrierid') =~ /\S/
601 && ! $flags{'da_rewrote'} #why?
602 && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
604 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
605 return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
606 if length($self->option_cacheable('use_cdrtypenum'))
607 && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
609 return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
610 if length($self->option_cacheable('ignore_cdrtypenum'))
611 && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
613 # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs.
614 return "calltypenum != ". $self->option_cacheable('use_calltypenum')
615 if length($self->option_cacheable('use_calltypenum'))
616 && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches ''
618 return "calltypenum == ". $self->option_cacheable('ignore_calltypenum')
619 if length($self->option_cacheable('ignore_calltypenum'))
620 && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches ''
622 return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
623 if $self->option_cacheable('skip_dcontext') =~ /\S/
624 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
626 my $len_dcontext_prefix =
627 length($self->option_cacheable('skip_dcontext_prefix'));
628 return "dcontext starts with ". $self->option_cacheable('skip_dcontext_prefix')
629 if $len_dcontext_prefix
630 && substr($cdr->dcontext,0,$len_dcontext_prefix) eq $self->option_cacheable('skip_dcontext_prefix');
632 my $len_suffix = length($self->option_cacheable('skip_dcontext_suffix'));
633 return "dcontext ends with ". $self->option_cacheable('skip_dcontext_suffix')
635 && substr($cdr->dcontext,-$len_suffix,$len_suffix) eq $self->option_cacheable('skip_dcontext_suffix');
637 my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
638 return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
640 && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
642 my $dst_length = $self->option_cacheable('skip_dst_length_less');
643 return "destination less than $dst_length digits"
644 if $dst_length && length($cdr->dst) < $dst_length
645 && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
646 && $cdr->is_tollfree('accountcode')
649 return "lastapp is ". $self->option_cacheable('skip_lastapp')
650 if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
652 my $src_length = $self->option_cacheable('skip_src_length_more');
655 if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
657 if ( $cdr->is_tollfree('accountcode') ) {
658 return "source less than or equal to $src_length digits"
659 if length($cdr->src) <= $src_length;
661 return "source more than $src_length digits"
662 if length($cdr->src) > $src_length;
666 return "source more than $src_length digits"
667 if length($cdr->src) > $src_length;
672 return "max_callers <= ". $self->option_cacheable('skip_max_callers')
673 if length($self->option_cacheable('skip_max_callers'))
674 and length($cdr->max_callers)
675 and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
677 return "calldate < ". str2time($self->option_cacheable('skip_old'))
678 if $self->option_cacheable('skip_old')
679 && $self->calldate_unix < str2time($self->option_cacheable('skip_old'));
681 #all right then, rate it
690 my ($self, $cust_pkg, %opt) = @_;
691 my @part_pkg_usage = $self->part_pkg_usage or return '';
692 warn " resetting usage minutes\n" if $opt{debug};
693 my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
694 foreach my $part_pkg_usage (@part_pkg_usage) {
695 my $part = $part_pkg_usage->pkgusagepart;
696 my $usage = $cust_pkg_usage{$part} ||
697 FS::cust_pkg_usage->new({
698 'pkgnum' => $cust_pkg->pkgnum,
699 'pkgusagepart' => $part,
700 'minutes' => $part_pkg_usage->minutes *
701 ($cust_pkg->quantity || 1),
703 foreach my $cdr_usage (
704 qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
706 my $error = $cdr_usage->delete;
707 warn " error resetting CDR usage: $error\n";
710 if ( $usage->pkgusagenum ) {
711 if ( $part_pkg_usage->rollover ) {
712 $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
714 $usage->set('minutes', $part_pkg_usage->minutes);
716 my $error = $usage->replace;
717 warn " error resetting usage minutes: $error\n" if $error;
719 my $error = $usage->insert;
720 warn " error resetting usage minutes: $error\n" if $error;
722 } #foreach $part_pkg_usage
725 # tells whether cust_bill_pkg_detail should return a single line for
727 # i think this is currently unused?
730 $self->option('output_format') =~ /^sum_/;
733 # and whether cust_bill should show a detail line for the service label
734 # (separate from usage details)
735 sub hide_svc_detail {
737 $self->option('output_format') =~ /^sum_/;