1 package FS::part_pkg::voip_cdr;
2 use base qw( FS::part_pkg::recur_Common );
5 use vars qw( $DEBUG %info );
10 use FS::Record qw(qsearchs qsearch);
12 use FS::detail_format;
16 tie my %cdr_svc_method, 'Tie::IxHash',
17 'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)',
18 'svc_pbx.title' => 'PBX name (svc_pbx.title)',
19 'svc_pbx.svcnum' => 'Freeside service # (svc_pbx.svcnum)',
20 'svc_pbx.ip.src' => 'PBX name to source IP address',
21 'svc_pbx.ip.dst' => 'PBX name to destination IP address',
22 'svc_acct.username' => 'Username (svc_acct.username)',
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 %rounding, 'Tie::IxHash',
33 '2' => 'Two decimal places (cent)',
34 '4' => 'Four decimal places (100th of a cent)',
37 #tie my %cdr_location, 'Tie::IxHash',
38 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
39 # 'external' => 'External: CDR records queried directly from an external '.
40 # 'Asterisk (or other?) CDR table',
43 tie my %temporalities, 'Tie::IxHash',
44 'upcoming' => "Upcoming (future)",
45 'preceding' => "Preceding (past)",
48 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
50 # previously "1" was "ignore"
51 tie my %unrateable_opts, 'Tie::IxHash',
52 '' => 'Exit with a fatal error',
53 1 => 'Ignore and continue',
54 2 => 'Flag for later review',
57 tie my %detail_formats, 'Tie::IxHash',
59 FS::cdr::invoice_formats()
62 tie my %accountcode_tollfree_field, 'Tie::IxHash',
63 'dst' => 'Destination (dst)',
64 'src' => 'Source (src)',
68 'name' => 'VoIP rating by plan of CDR records',
69 'shortname' => 'VoIP/telco CDR rating (standard)',
70 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
72 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
75 #false laziness w/flat.pm
76 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
78 'select_options' => \%temporalities,
81 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
85 'recur_method' => { 'name' => 'Recurring fee method',
87 #'options' => \%recur_method,
89 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
92 'cdr_svc_method' => { 'name' => 'CDR service matching method',
95 'select_options' => \%cdr_svc_method,
98 'rating_method' => { 'name' => 'Rating method',
100 'options' => \%rating_method,
103 'rounding' => { 'name' => 'Rounding for destination prefix rating',
105 'select_options' => \%rounding,
108 'ratenum' => { 'name' => 'Rate plan',
109 'type' => 'select-rate',
112 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
113 'type' => 'select-rate',
114 'disable_empty' => 0,
115 'empty_label' => ' ',
118 'calls_included' => { 'name' => 'Number of calls included at no usage charge', },
120 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" or "prefix" rating method',
123 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
126 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
128 'select_options' => \%granularity,
131 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
133 'select_options' => \%unrateable_opts,
136 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
140 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
144 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
148 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
149 # 'type' => 'checkbox',
152 'international_prefix' => { 'name' => 'Destination prefix for international CDR records (or "none" for no prefix)',
156 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
157 'type' => 'checkbox',
160 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
161 'type' => 'checkbox',
164 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to any of these (comma-separated) values: ',
167 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to this cdrtypenum: ',
170 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to this cdrtypenum: ',
173 'use_calltypenum' => { 'name' => 'Only charge for CDRs where the CDR Call Type is set to this calltypenum: ',
176 'ignore_calltypenum' => { 'name' => 'Do not charge for CDRs where the CDR Call Type is set to this calltypenum: ',
179 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
182 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
185 'disposition_prefix' => { 'name' => 'Only charge for CDRs where the Disposition starts with: ',
188 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these (comma-separated) values: ',
191 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where dcontext is set to any of these (comma-separated) values: ',
194 'skip_dcontext_prefix' => { 'name' => 'Do not charge for CDRs where dcontext starts with: ',
197 'skip_dcontext_suffix' => { 'name' => 'Do not charge for CDRs where dcontext ends with: ',
200 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
203 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
206 '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',
207 'type' => 'checkbox',
210 'accountcode_tollfree_ratenum' => {
211 'name' => 'Optional alternate rate plan when accountcode is toll free: ',
213 'select_table' => 'rate',
214 'select_key' => 'ratenum',
215 'select_label' => 'ratename',
216 'disable_empty' => 0,
220 'accountcode_tollfree_field' => {
221 'name' => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations',
223 'select_options' => \%accountcode_tollfree_field,
226 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
229 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
230 'type' => 'checkbox',
233 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
236 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
239 'skip_same_customer' => {
240 'name' => 'Do not charge for calls between numbers belonging to the same customer',
241 'type' => 'checkbox',
244 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
245 'type' => 'checkbox',
248 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
251 #false laziness w/cdr_termination.pm
252 'output_format' => { 'name' => 'CDR display format for invoices',
254 'select_options' => \%detail_formats,
255 'default' => 'default', #XXX test
258 'selfservice_format' =>
259 { 'name' => 'CDR display format for selfservice',
261 'select_options' => \%detail_formats,
262 'default' => 'default'
264 'selfservice_inbound_format' =>
265 { 'name' => 'Inbound CDR display format for selfservice',
267 'select_options' => \%detail_formats,
271 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
274 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
275 'type' => 'checkbox',
278 'usage_mandate' => { 'name' => 'Always put usage details in separate section. The section is defined in the next option.',
279 'type' => 'checkbox',
283 'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.',
284 'type' => 'checkbox',
287 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
288 'type' => 'checkbox',
291 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
292 'type' => 'checkbox',
294 'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period',
295 'type' => 'checkbox',
298 #XXX also have option for an external db? these days we suck them into ours
299 # 'cdr_location' => { 'name' => 'CDR database location'
300 # 'type' => 'select',
301 # 'select_options' => \%cdr_location,
302 # 'select_callback' => {
304 # 'enable' => [ 'datasrc', 'username', 'password' ],
307 # 'disable' => [ 'datasrc', 'username', 'password' ],
311 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
314 # 'username' => { 'name' => 'External database username',
317 # 'password' => { 'name' => 'External database password',
324 recur_method cutoff_day ),
325 FS::part_pkg::prorate_Mixin::fieldorder,
328 rating_method rounding ratenum intrastate_ratenum
330 min_charge min_included
335 domestic_prefix international_prefix
339 use_cdrtypenum ignore_cdrtypenum
340 use_calltypenum ignore_calltypenum
341 ignore_disposition disposition_in disposition_prefix
342 skip_dcontext skip_dcontext_prefix skip_dcontext_suffix
344 skip_dstchannel_prefix skip_src_length_more
345 noskip_src_length_accountcode_tollfree
346 accountcode_tollfree_ratenum accountcode_tollfree_field
348 noskip_dst_length_accountcode_tollfree
355 selfservice_format selfservice_inbound_format
356 usage_mandate usage_section summarize_usage
357 usage_showzero bill_every_call bill_inactive_svcs
364 # Validation function for FS::part_pkg::check_options()
366 return "Please choose a Rate Plan for use with selected Rating Method"
367 if $options->{rating_method} eq 'prefix' && !$options->{ratenum};
374 my $str = $self->SUPER::price_info(@_);
375 $str .= " plus usage" if $str;
381 my($cust_pkg, $sdate, $details, $param ) = @_;
385 $charges += $self->calc_usage(@_);
386 $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_);
395 # my($cust_pkg, $sdate, $details, $param ) = @_;
397 # $self->calc_usage(@_);
400 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
404 my($cust_pkg, $sdate, $details, $param ) = @_;
406 #my $last_bill = $cust_pkg->last_bill;
407 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
410 if $self->recur_temporality eq 'preceding'
411 && ( $last_bill eq '' || $last_bill == 0 );
415 my $included_min_total = ($self->option('min_included', 1) || 0)
416 * ($cust_pkg->quantity || 1);
419 my $included_min_left = $included_min_total;
421 my $included_calls = $self->option('calls_included', 1) || 0;
422 $included_calls *= ($cust_pkg->quantity || 1);
424 my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
425 my $rating_method = $self->option('rating_method') || 'prefix';
426 my %detail_included_min = ();
428 my $output_format = $self->option('output_format', 'Hush!')
429 || ( $rating_method eq 'upstream_simple'
434 my $usage_showzero = $self->option('usage_showzero', 1);
436 my $formatter = FS::detail_format->new($output_format,
438 locale => $cust_pkg->cust_main->locale,
439 rounding => ($self->option_cacheable('rounding') || 2),
442 my $use_duration = $self->option('use_duration');
444 my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
447 if( $self->option('bill_inactive_svcs',1) ) {
448 #XXX in this mode do we need to restrict the set of CDRs by date also?
449 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
452 @cust_svc = $cust_pkg->cust_svc;
454 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
456 foreach my $cust_svc (@cust_svc) {
459 if( $self->option('bill_inactive_svcs',1) ) {
460 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
463 $svc_x = $cust_svc->svc_x;
467 my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : '';
468 warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n";
472 'disable_src' => $self->option('disable_src',1),
473 'default_prefix' => $self->option('default_prefix',1),
474 'cdrtypenum' => $self->option('use_cdrtypenum',1),
475 'calltypenum' => $self->option('use_calltypenum',1),
479 if ( $self->option('bill_only_pkg_dates') ) {
480 $options{'begin'} = $last_bill;
481 $options{'end'} = $$sdate;
483 if ( $svc_field eq 'svcnum' ) {
484 $options{'by_svcnum'} = 1;
485 } elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
486 $options{'by_ip_addr'} = $by_ip_addr;
489 #my @invoice_details_sort;
491 # for tagging invoice details
492 # (unfortunate; should be a svc_x class method or table_info item or
495 if ( $svc_table eq 'svc_phone' ) {
496 $phonenum = $svc_x->phonenum;
497 } elsif ( $svc_table eq 'svc_pbx' ) {
498 $phonenum = $svc_x->title;
499 } elsif ( $svc_table eq 'svc_acct' ) {
500 $phonenum = $svc_x->username;
502 $formatter->phonenum($phonenum);
504 #first rate any outstanding CDRs not yet rated
505 # use FS::Cursor for this starting in 4.x
506 my $cdr_search = $svc_x->psearch_cdrs(%options);
507 $cdr_search->limit(1000);
508 $cdr_search->increment(0); # because we're changing their status as we go
509 while ( my $cdr = $cdr_search->fetch ) {
511 my $error = $cdr->rate(
513 'cust_pkg' => $cust_pkg,
514 'svcnum' => $svc_x->svcnum,
515 'plan_included_min' => \$included_min_left,
516 'detail_included_min_hashref' => \%detail_included_min,
518 die $error if $error; #??
520 $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
521 # it was skipped without changing status, so increment the
522 # offset so that we don't re-fetch it on refill
526 #then add details to invoices & get a total
527 $options{'status'} = 'rated';
529 $cdr_search = $svc_x->psearch_cdrs(%options);
530 $cdr_search->limit(1000);
531 $cdr_search->increment(0);
532 while ( my $cdr = $cdr_search->fetch ) {
534 # at this point we officially Do Not Care about the rating method
535 if ( $included_calls > 0 ) {
537 #$charges += 0, obviously
538 #but don't set the rated price to zero--there should be a record
539 $error = $cdr->set_status('no-charge');
542 $charges += $cdr->rated_price;
543 $error = $cdr->set_status('done');
545 die $error if $error;
546 $formatter->append($cdr)
547 unless $cdr->rated_price == 0 and not $usage_showzero;
549 $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
553 $formatter->finish; #writes into $details
554 unshift @$details, $formatter->header if @$details;
556 if ( $included_min_total > 0 ) {
558 my $min_detail = sprintf('%d / %d ',
559 $included_min_total - $included_min_left,
561 ) . $cust_pkg->mt('included minutes used');
562 unshift @$details, $min_detail;
568 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
569 # lots of false laziness w/voip_inbound
570 sub check_chargable {
571 my( $self, $cdr, %flags ) = @_;
573 return 'amaflags != 2'
574 if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
576 return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
577 if $self->option_cacheable('disposition_in') =~ /\S/
578 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
580 my $disposition_prefix = $self->option_cacheable('disposition_prefix');
581 my $len_dis_prefix = length($disposition_prefix);
582 return "disposition does not start with $disposition_prefix"
584 && substr($cdr->disposition, 0, $len_dis_prefix) ne $disposition_prefix;
586 return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
587 if $self->option_cacheable('ignore_disposition') =~ /\S/
588 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
590 foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
591 return "dst starts with '$_'"
592 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
595 return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
596 if $self->option_cacheable('use_carrierid') =~ /\S/
597 && ! $flags{'da_rewrote'} #why?
598 && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
600 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
601 return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
602 if length($self->option_cacheable('use_cdrtypenum'))
603 && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
605 return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
606 if length($self->option_cacheable('ignore_cdrtypenum'))
607 && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
609 # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs.
610 return "calltypenum != ". $self->option_cacheable('use_calltypenum')
611 if length($self->option_cacheable('use_calltypenum'))
612 && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches ''
614 return "calltypenum == ". $self->option_cacheable('ignore_calltypenum')
615 if length($self->option_cacheable('ignore_calltypenum'))
616 && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches ''
618 return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
619 if $self->option_cacheable('skip_dcontext') =~ /\S/
620 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
622 my $len_dcontext_prefix =
623 length($self->option_cacheable('skip_dcontext_prefix'));
624 return "dcontext starts with ". $self->option_cacheable('skip_dcontext_prefix')
625 if $len_dcontext_prefix
626 && substr($cdr->dcontext,0,$len_dcontext_prefix) eq $self->option_cacheable('skip_dcontext_prefix');
628 my $len_suffix = length($self->option_cacheable('skip_dcontext_suffix'));
629 return "dcontext ends with ". $self->option_cacheable('skip_dcontext_suffix')
631 && substr($cdr->dcontext,-$len_suffix,$len_suffix) eq $self->option_cacheable('skip_dcontext_suffix');
633 my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
634 return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
636 && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
638 my $dst_length = $self->option_cacheable('skip_dst_length_less');
639 return "destination less than $dst_length digits"
640 if $dst_length && length($cdr->dst) < $dst_length
641 && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
642 && $cdr->is_tollfree('accountcode')
645 return "lastapp is ". $self->option_cacheable('skip_lastapp')
646 if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
648 my $src_length = $self->option_cacheable('skip_src_length_more');
651 if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
653 if ( $cdr->is_tollfree('accountcode') ) {
654 return "source less than or equal to $src_length digits"
655 if length($cdr->src) <= $src_length;
657 return "source more than $src_length digits"
658 if length($cdr->src) > $src_length;
662 return "source more than $src_length digits"
663 if length($cdr->src) > $src_length;
668 return "max_callers <= ". $self->option_cacheable('skip_max_callers')
669 if length($self->option_cacheable('skip_max_callers'))
670 and length($cdr->max_callers)
671 and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
673 #all right then, rate it
682 my ($self, $cust_pkg, %opt) = @_;
683 my @part_pkg_usage = $self->part_pkg_usage or return '';
684 warn " resetting usage minutes\n" if $opt{debug};
685 my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
686 foreach my $part_pkg_usage (@part_pkg_usage) {
687 my $part = $part_pkg_usage->pkgusagepart;
688 my $usage = $cust_pkg_usage{$part} ||
689 FS::cust_pkg_usage->new({
690 'pkgnum' => $cust_pkg->pkgnum,
691 'pkgusagepart' => $part,
692 'minutes' => $part_pkg_usage->minutes *
693 ($cust_pkg->quantity || 1),
695 foreach my $cdr_usage (
696 qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
698 my $error = $cdr_usage->delete;
699 warn " error resetting CDR usage: $error\n";
702 if ( $usage->pkgusagenum ) {
703 if ( $part_pkg_usage->rollover ) {
704 $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
706 $usage->set('minutes', $part_pkg_usage->minutes);
708 my $error = $usage->replace;
709 warn " error resetting usage minutes: $error\n" if $error;
711 my $error = $usage->insert;
712 warn " error resetting usage minutes: $error\n" if $error;
714 } #foreach $part_pkg_usage
717 # tells whether cust_bill_pkg_detail should return a single line for
719 # i think this is currently unused?
722 $self->option('output_format') =~ /^sum_/;
725 # and whether cust_bill should show a detail line for the service label
726 # (separate from usage details)
727 sub hide_svc_detail {
729 $self->option('output_format') =~ /^sum_/;