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;
15 #use FS::rate_detail; #for ::granularities
19 tie my %cdr_svc_method, 'Tie::IxHash',
20 'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)',
21 'svc_pbx.title' => 'PBX name (svc_pbx.title)',
22 'svc_pbx.svcnum' => 'Freeside service # (svc_pbx.svcnum)',
23 'svc_pbx.ip.src' => 'PBX name to source IP address',
24 'svc_pbx.ip.dst' => 'PBX name to destination IP address',
25 'svc_acct.username' => 'Username (svc_acct.username)',
28 tie my %rating_method, 'Tie::IxHash',
29 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
30 # '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.',
31 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
32 'single_price' => 'A single price per minute for all calls.',
35 tie my %rounding, 'Tie::IxHash',
36 '2' => 'Two decimal places (cent)',
37 '4' => 'Four decimal places (100th of a cent)',
40 #tie my %cdr_location, 'Tie::IxHash',
41 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
42 # 'external' => 'External: CDR records queried directly from an external '.
43 # 'Asterisk (or other?) CDR table',
46 tie my %temporalities, 'Tie::IxHash',
47 'upcoming' => "Upcoming (future)",
48 'preceding' => "Preceding (past)",
51 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
53 # previously "1" was "ignore"
54 tie my %unrateable_opts, 'Tie::IxHash',
55 '' => 'Exit with a fatal error',
56 1 => 'Ignore and continue',
57 2 => 'Flag for later review',
60 tie my %detail_formats, 'Tie::IxHash',
62 FS::cdr::invoice_formats()
65 tie my %accountcode_tollfree_field, 'Tie::IxHash',
66 'dst' => 'Destination (dst)',
67 'src' => 'Source (src)',
71 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
72 'shortname' => 'VoIP/telco CDR rating (standard)',
73 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
75 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
78 #false laziness w/flat.pm
79 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
81 'select_options' => \%temporalities,
84 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
88 'recur_method' => { 'name' => 'Recurring fee method',
90 #'options' => \%recur_method,
92 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
95 'cdr_svc_method' => { 'name' => 'CDR service matching method',
98 'select_options' => \%cdr_svc_method,
101 'rating_method' => { 'name' => 'Rating method',
103 'options' => \%rating_method,
106 'rounding' => { 'name' => 'Rounding for destination prefix rating',
108 'select_options' => \%rounding,
111 'ratenum' => { 'name' => 'Rate plan',
112 'type' => 'select-rate',
115 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
116 'type' => 'select-rate',
117 'disable_empty' => 0,
118 'empty_label' => ' ',
121 'calls_included' => { 'name' => 'Number of calls included at no usage charge', },
123 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" or "prefix" rating method',
126 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
129 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
131 'select_options' => \%granularity,
134 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
136 'select_options' => \%unrateable_opts,
139 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
143 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
147 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
151 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
152 # 'type' => 'checkbox',
155 'international_prefix' => { 'name' => 'Destination prefix for international CDR records (or "none" for no prefix)',
159 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
160 'type' => 'checkbox',
163 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
164 'type' => 'checkbox',
167 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to any of these (comma-separated) values: ',
170 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to this cdrtypenum: ',
173 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to this cdrtypenum: ',
176 'use_calltypenum' => { 'name' => 'Only charge for CDRs where the CDR Call Type is set to this calltypenum: ',
179 'ignore_calltypenum' => { 'name' => 'Do not charge for CDRs where the CDR Call Type is set to this calltypenum: ',
182 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
185 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
188 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
191 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where dcontext is set to any of these (comma-separated) values: ',
194 'skip_dcontext_suffix' => { 'name' => 'Do not charge for CDRs where dcontext ends with: ',
197 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
200 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
203 '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',
204 'type' => 'checkbox',
207 'accountcode_tollfree_ratenum' => {
208 'name' => 'Optional alternate rate plan when accountcode is toll free: ',
210 'select_table' => 'rate',
211 'select_key' => 'ratenum',
212 'select_label' => 'ratename',
213 'disable_empty' => 0,
217 'accountcode_tollfree_field' => {
218 'name' => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations',
220 'select_options' => \%accountcode_tollfree_field,
223 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
226 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
227 'type' => 'checkbox',
230 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
233 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
236 'skip_same_customer' => {
237 'name' => 'Do not charge for calls between numbers belonging to the same customer',
238 'type' => 'checkbox',
241 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
242 'type' => 'checkbox',
245 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
248 #false laziness w/cdr_termination.pm
249 'output_format' => { 'name' => 'CDR display format for invoices',
251 'select_options' => \%detail_formats,
252 'default' => 'default', #XXX test
255 'selfservice_format' =>
256 { 'name' => 'CDR display format for selfservice',
258 'select_options' => \%detail_formats,
259 'default' => 'default'
261 'selfservice_inbound_format' =>
262 { 'name' => 'Inbound CDR display format for selfservice',
264 'select_options' => \%detail_formats,
268 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
271 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
272 'type' => 'checkbox',
275 'usage_mandate' => { 'name' => 'Always put usage details in separate section. The section is defined in the next option.',
276 'type' => 'checkbox',
280 'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.',
281 'type' => 'checkbox',
284 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
285 'type' => 'checkbox',
288 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
289 'type' => 'checkbox',
291 'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period',
292 'type' => 'checkbox',
295 '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.',
296 'type' => 'checkbox',
299 #XXX also have option for an external db? these days we suck them into ours
300 # 'cdr_location' => { 'name' => 'CDR database location'
301 # 'type' => 'select',
302 # 'select_options' => \%cdr_location,
303 # 'select_callback' => {
305 # 'enable' => [ 'datasrc', 'username', 'password' ],
308 # 'disable' => [ 'datasrc', 'username', 'password' ],
312 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
315 # 'username' => { 'name' => 'External database username',
318 # 'password' => { 'name' => 'External database password',
325 recur_method cutoff_day ),
326 FS::part_pkg::prorate_Mixin::fieldorder,
329 rating_method rounding ratenum intrastate_ratenum
331 min_charge min_included sec_granularity
335 domestic_prefix international_prefix
339 use_cdrtypenum ignore_cdrtypenum
340 use_calltypenum ignore_calltypenum
341 ignore_disposition disposition_in
342 skip_dcontext skip_dcontext_suffix skip_dst_prefix
343 skip_dstchannel_prefix skip_src_length_more
344 noskip_src_length_accountcode_tollfree
345 accountcode_tollfree_ratenum accountcode_tollfree_field
347 noskip_dst_length_accountcode_tollfree
354 selfservice_format selfservice_inbound_format
355 usage_mandate usage_section summarize_usage
356 usage_showzero bill_every_call bill_inactive_svcs
358 count_available_phones suspend_bill
366 my $str = $self->SUPER::price_info;
367 $str .= " plus usage" if $str;
373 my($cust_pkg, $sdate, $details, $param ) = @_;
377 $charges += $self->calc_usage(@_);
378 $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_);
387 # my($cust_pkg, $sdate, $details, $param ) = @_;
389 # $self->calc_usage(@_);
392 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
396 my($cust_pkg, $sdate, $details, $param ) = @_;
398 #my $last_bill = $cust_pkg->last_bill;
399 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
402 if $self->recur_temporality eq 'preceding'
403 && ( $last_bill eq '' || $last_bill == 0 );
407 my $included_min = $self->option('min_included', 1) || 0;
410 $included_min *= ($cust_pkg->quantity || 1);
412 my $included_calls = $self->option('calls_included', 1) || 0;
413 $included_calls *= ($cust_pkg->quantity || 1);
415 my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
416 my $rating_method = $self->option('rating_method') || 'prefix';
417 my %detail_included_min = ();
419 my $output_format = $self->option('output_format', 'Hush!')
420 || ( $rating_method eq 'upstream_simple'
425 my $usage_showzero = $self->option('usage_showzero', 1);
427 my $formatter = FS::detail_format->new($output_format,
429 locale => $cust_pkg->cust_main->locale,
430 rounding => ($self->option_cacheable('rounding') || 2),
433 my $use_duration = $self->option('use_duration');
435 my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
438 if( $self->option('bill_inactive_svcs',1) ) {
439 #XXX in this mode do we need to restrict the set of CDRs by date also?
440 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
443 @cust_svc = $cust_pkg->cust_svc;
445 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
447 foreach my $cust_svc (@cust_svc) {
450 if( $self->option('bill_inactive_svcs',1) ) {
451 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
454 $svc_x = $cust_svc->svc_x;
458 my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : '';
459 warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n";
463 'disable_src' => $self->option('disable_src'),
464 'default_prefix' => $self->option('default_prefix'),
465 'cdrtypenum' => $self->option('use_cdrtypenum'),
466 'calltypenum' => $self->option('use_calltypenum', 1),
470 if ( $self->option('bill_only_pkg_dates') ) {
471 $options{'begin'} = $last_bill;
472 $options{'end'} = $$sdate;
474 if ( $svc_field eq 'svcnum' ) {
475 $options{'by_svcnum'} = 1;
476 } elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
477 $options{'by_ip_addr'} = $by_ip_addr;
480 #my @invoice_details_sort;
482 # for tagging invoice details
483 # (unfortunate; should be a svc_x class method or table_info item or
486 if ( $svc_table eq 'svc_phone' ) {
487 $phonenum = $svc_x->phonenum;
488 } elsif ( $svc_table eq 'svc_pbx' ) {
489 $phonenum = $svc_x->title;
490 } elsif ( $svc_table eq 'svc_acct' ) {
491 $phonenum = $svc_x->username;
493 $formatter->phonenum($phonenum);
495 #first rate any outstanding CDRs not yet rated
496 # use FS::Cursor for this starting in 4.x
497 my $cdr_search = $svc_x->psearch_cdrs(%options);
498 $cdr_search->limit(1000);
499 $cdr_search->increment(0); # because we're changing their status as we go
500 while ( my $cdr = $cdr_search->fetch ) {
502 my $error = $cdr->rate(
504 'cust_pkg' => $cust_pkg,
505 'svcnum' => $svc_x->svcnum,
506 'plan_included_min' => \$included_min,
507 'detail_included_min_hashref' => \%detail_included_min,
509 die $error if $error; #??
511 $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
512 # it was skipped without changing status, so increment the
513 # offset so that we don't re-fetch it on refill
517 #then add details to invoices & get a total
518 $options{'status'} = 'rated';
520 $cdr_search = $svc_x->psearch_cdrs(%options);
521 $cdr_search->limit(1000);
522 $cdr_search->increment(0);
523 while ( my $cdr = $cdr_search->fetch ) {
525 # at this point we officially Do Not Care about the rating method
526 if ( $included_calls > 0 ) {
528 #$charges += 0, obviously
529 #but don't set the rated price to zero--there should be a record
530 $error = $cdr->set_status('no-charge');
533 $charges += $cdr->rated_price;
534 $error = $cdr->set_status('done');
536 die $error if $error;
537 $formatter->append($cdr)
538 unless $cdr->rated_price == 0 and not $usage_showzero;
540 $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
544 $formatter->finish; #writes into $details
545 unshift @$details, $formatter->header if @$details;
550 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
551 # lots of false laziness w/voip_inbound
552 sub check_chargable {
553 my( $self, $cdr, %flags ) = @_;
555 return 'amaflags != 2'
556 if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
558 return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
559 if $self->option_cacheable('disposition_in') =~ /\S/
560 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
562 return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
563 if $self->option_cacheable('ignore_disposition') =~ /\S/
564 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
566 foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
567 return "dst starts with '$_'"
568 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
571 return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
572 if $self->option_cacheable('use_carrierid') =~ /\S/
573 && ! $flags{'da_rewrote'} #why?
574 && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
576 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
577 return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
578 if length($self->option_cacheable('use_cdrtypenum'))
579 && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
581 return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
582 if length($self->option_cacheable('ignore_cdrtypenum'))
583 && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
585 # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs.
586 return "calltypenum != ". $self->option_cacheable('use_calltypenum')
587 if length($self->option_cacheable('use_calltypenum'))
588 && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches ''
590 return "calltypenum == ". $self->option_cacheable('ignore_calltypenum')
591 if length($self->option_cacheable('ignore_calltypenum'))
592 && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches ''
594 return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
595 if $self->option_cacheable('skip_dcontext') =~ /\S/
596 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
598 my $len_suffix = length($self->option_cacheable('skip_dcontext_suffix'));
599 return "dcontext ends with ". $self->option_cacheable('skip_dcontext_suffix')
601 && substr($cdr->dcontext,-$len_suffix,$len_suffix) eq $self->option_cacheable('skip_dcontext_suffix');
603 my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
604 return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
606 && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
608 my $dst_length = $self->option_cacheable('skip_dst_length_less');
609 return "destination less than $dst_length digits"
610 if $dst_length && length($cdr->dst) < $dst_length
611 && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
612 && $cdr->is_tollfree('accountcode')
615 return "lastapp is ". $self->option_cacheable('skip_lastapp')
616 if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
618 my $src_length = $self->option_cacheable('skip_src_length_more');
621 if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
623 if ( $cdr->is_tollfree('accountcode') ) {
624 return "source less than or equal to $src_length digits"
625 if length($cdr->src) <= $src_length;
627 return "source more than $src_length digits"
628 if length($cdr->src) > $src_length;
632 return "source more than $src_length digits"
633 if length($cdr->src) > $src_length;
638 return "max_callers <= ". $self->option_cacheable('skip_max_callers')
639 if length($self->option_cacheable('skip_max_callers'))
640 and length($cdr->max_callers)
641 and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
643 #all right then, rate it
651 # This equates svc_phone records; perhaps svc_phone should have a field
652 # to indicate it represents a line
654 my($self, $cust_pkg ) = @_;
656 if ( $self->option('count_available_phones', 1)) {
657 foreach my $pkg_svc ($cust_pkg->part_pkg->pkg_svc) {
658 if ($pkg_svc->part_svc->svcdb eq 'svc_phone') { # svc_pbx?
659 $count += $pkg_svc->quantity || 0;
662 $count *= $cust_pkg->quantity;
665 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
671 my ($self, $cust_pkg, %opt) = @_;
672 my @part_pkg_usage = $self->part_pkg_usage or return '';
673 warn " resetting usage minutes\n" if $opt{debug};
674 my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
675 foreach my $part_pkg_usage (@part_pkg_usage) {
676 my $part = $part_pkg_usage->pkgusagepart;
677 my $usage = $cust_pkg_usage{$part} ||
678 FS::cust_pkg_usage->new({
679 'pkgnum' => $cust_pkg->pkgnum,
680 'pkgusagepart' => $part,
681 'minutes' => $part_pkg_usage->minutes *
682 ($cust_pkg->quantity || 1),
684 foreach my $cdr_usage (
685 qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
687 my $error = $cdr_usage->delete;
688 warn " error resetting CDR usage: $error\n";
691 if ( $usage->pkgusagenum ) {
692 if ( $part_pkg_usage->rollover ) {
693 $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
695 $usage->set('minutes', $part_pkg_usage->minutes);
697 my $error = $usage->replace;
698 warn " error resetting usage minutes: $error\n" if $error;
700 my $error = $usage->insert;
701 warn " error resetting usage minutes: $error\n" if $error;
703 } #foreach $part_pkg_usage
706 # tells whether cust_bill_pkg_detail should return a single line for
710 $self->option('output_format') =~ /^sum_/;
713 # and whether cust_bill should show a detail line for the service label
714 # (separate from usage details)
715 sub hide_svc_detail {
717 $self->option('output_format') =~ /^sum_/;