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;
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',
27 tie my %rating_method, 'Tie::IxHash',
28 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
29 # '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.',
30 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
31 'single_price' => 'A single price per minute for all calls.',
34 tie my %rounding, 'Tie::IxHash',
35 '2' => 'Two decimal places (cent)',
36 '4' => 'Four decimal places (100th of a cent)',
39 #tie my %cdr_location, 'Tie::IxHash',
40 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
41 # 'external' => 'External: CDR records queried directly from an external '.
42 # 'Asterisk (or other?) CDR table',
45 tie my %temporalities, 'Tie::IxHash',
46 'upcoming' => "Upcoming (future)",
47 'preceding' => "Preceding (past)",
50 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
52 # previously "1" was "ignore"
53 tie my %unrateable_opts, 'Tie::IxHash',
54 '' => 'Exit with a fatal error',
55 1 => 'Ignore and continue',
56 2 => 'Flag for later review',
59 tie my %detail_formats, 'Tie::IxHash',
61 FS::cdr::invoice_formats()
64 tie my %accountcode_tollfree_field, 'Tie::IxHash',
65 'dst' => 'Destination (dst)',
66 'src' => 'Source (src)',
70 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
71 'shortname' => 'VoIP/telco CDR rating (standard)',
72 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
74 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
77 #false laziness w/flat.pm
78 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
80 'select_options' => \%temporalities,
83 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
87 'recur_method' => { 'name' => 'Recurring fee method',
89 #'options' => \%recur_method,
91 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
94 'cdr_svc_method' => { 'name' => 'CDR service matching method',
97 'select_options' => \%cdr_svc_method,
100 'rating_method' => { 'name' => 'Rating method',
102 'options' => \%rating_method,
105 'rounding' => { 'name' => 'Rounding for destination prefix rating',
107 'select_options' => \%rounding,
110 'ratenum' => { 'name' => 'Rate plan',
112 'select_table' => 'rate',
113 'select_key' => 'ratenum',
114 'select_label' => 'ratename',
117 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
119 'select_table' => 'rate',
120 'select_key' => 'ratenum',
121 'select_label' => 'ratename',
122 'disable_empty' => 0,
126 'calls_included' => { 'name' => 'Number of calls included at no usage charge', },
128 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" or "prefix" rating method',
131 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
134 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
136 'select_options' => \%granularity,
139 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
141 'select_options' => \%unrateable_opts,
144 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
148 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
152 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
156 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
157 # 'type' => 'checkbox',
160 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
164 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
165 'type' => 'checkbox',
168 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
169 'type' => 'checkbox',
172 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to any of these (comma-separated) values: ',
175 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to this cdrtypenum: ',
178 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to this cdrtypenum: ',
181 'use_calltypenum' => { 'name' => 'Only charge for CDRs where the CDR Call Type is set to this calltypenum: ',
184 'ignore_calltypenum' => { 'name' => 'Do not charge for CDRs where the CDR Call Type is set to this calltypenum: ',
187 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
190 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
193 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
196 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
199 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
202 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
205 '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',
206 'type' => 'checkbox',
209 'accountcode_tollfree_ratenum' => {
210 'name' => 'Optional alternate rate plan when accountcode is toll free: ',
212 'select_table' => 'rate',
213 'select_key' => 'ratenum',
214 'select_label' => 'ratename',
215 'disable_empty' => 0,
219 'accountcode_tollfree_field' => {
220 'name' => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations',
222 'select_options' => \%accountcode_tollfree_field,
225 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
228 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
229 'type' => 'checkbox',
232 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
235 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
238 'skip_same_customer' => {
239 'name' => 'Do not charge for calls between numbers belonging to the same customer',
240 'type' => 'checkbox',
243 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
244 'type' => 'checkbox',
247 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
250 #false laziness w/cdr_termination.pm
251 'output_format' => { 'name' => 'CDR display format for invoices',
253 'select_options' => \%detail_formats,
254 'default' => 'default', #XXX test
257 'selfservice_format' =>
258 { 'name' => 'CDR display format for selfservice',
260 'select_options' => \%detail_formats,
261 'default' => 'default'
263 'selfservice_inbound_format' =>
264 { 'name' => 'Inbound CDR display format for selfservice',
266 'select_options' => \%detail_formats,
270 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
273 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
274 'type' => 'checkbox',
277 'usage_mandate' => { 'name' => 'Always put usage details in separate section. The section is defined in the next option.',
278 'type' => 'checkbox',
282 'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.',
283 'type' => 'checkbox',
286 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
287 'type' => 'checkbox',
290 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
291 'type' => 'checkbox',
294 '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.',
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 sec_granularity
334 domestic_prefix international_prefix
338 use_cdrtypenum ignore_cdrtypenum
339 use_calltypenum ignore_calltypenum
340 ignore_disposition disposition_in
341 skip_dcontext skip_dst_prefix
342 skip_dstchannel_prefix skip_src_length_more
343 noskip_src_length_accountcode_tollfree
344 accountcode_tollfree_ratenum accountcode_tollfree_field
346 noskip_dst_length_accountcode_tollfree
353 selfservice_format selfservice_inbound_format
354 usage_mandate usage_section summarize_usage
355 usage_showzero bill_every_call bill_inactive_svcs
356 count_available_phones suspend_bill
364 my $str = $self->SUPER::price_info(@_);
365 $str .= " plus usage" if $str;
371 my($cust_pkg, $sdate, $details, $param ) = @_;
375 $charges += $self->calc_usage(@_);
376 $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_);
385 # my($cust_pkg, $sdate, $details, $param ) = @_;
387 # $self->calc_usage(@_);
390 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
394 my($cust_pkg, $sdate, $details, $param ) = @_;
396 #my $last_bill = $cust_pkg->last_bill;
397 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
400 if $self->recur_temporality eq 'preceding'
401 && ( $last_bill eq '' || $last_bill == 0 );
405 my $included_min = $self->option('min_included', 1) || 0;
409 my $included_calls = $self->option('calls_included', 1) || 0;
411 my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
412 my $rating_method = $self->option('rating_method') || 'prefix';
413 my %detail_included_min = ();
415 my $output_format = $self->option('output_format', 'Hush!')
416 || ( $rating_method eq 'upstream_simple'
421 my $usage_showzero = $self->option('usage_showzero', 1);
423 my $formatter = FS::detail_format->new($output_format,
425 locale => $cust_pkg->cust_main->locale
428 my $use_duration = $self->option('use_duration');
430 my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
433 if( $self->option('bill_inactive_svcs',1) ) {
434 #XXX in this mode do we need to restrict the set of CDRs by date also?
435 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
438 @cust_svc = $cust_pkg->cust_svc;
440 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
442 foreach my $cust_svc (@cust_svc) {
445 if( $self->option('bill_inactive_svcs',1) ) {
446 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
449 $svc_x = $cust_svc->svc_x;
453 my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : '';
454 warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n";
458 'disable_src' => $self->option('disable_src',1),
459 'default_prefix' => $self->option('default_prefix',1),
460 'cdrtypenum' => $self->option('use_cdrtypenum',1),
461 'calltypenum' => $self->option('use_calltypenum',1),
464 ); # $last_bill, $$sdate )
465 if ( $svc_field eq 'svcnum' ) {
466 $options{'by_svcnum'} = 1;
468 elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
469 $options{'by_ip_addr'} = $by_ip_addr;
472 #my @invoice_details_sort;
474 #first rate any outstanding CDRs not yet rated
475 # XXX eventually use an FS::Cursor for this
476 my $cdr_search = $svc_x->psearch_cdrs(%options);
477 $cdr_search->limit(1000);
478 $cdr_search->increment(0); # because we're changing their status as we go
479 while ( my $cdr = $cdr_search->fetch ) {
481 my $error = $cdr->rate(
483 'cust_pkg' => $cust_pkg,
484 'svcnum' => $svc_x->svcnum,
485 'plan_included_min' => \$included_min,
486 'detail_included_min_hashref' => \%detail_included_min,
488 die $error if $error; #??
490 $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
491 # it was skipped without changing status, so increment the
492 # offset so that we don't re-fetch it on refill
496 #then add details to invoices & get a total
497 $options{'status'} = 'rated';
499 $cdr_search = $svc_x->psearch_cdrs(%options);
500 $cdr_search->limit(1000);
501 $cdr_search->increment(0);
502 while ( my $cdr = $cdr_search->fetch ) {
504 # at this point we officially Do Not Care about the rating method
505 if ( $included_calls > 0 ) {
507 #$charges += 0, obviously
508 #but don't set the rated price to zero--there should be a record
509 $error = $cdr->set_status('no-charge');
512 $charges += $cdr->rated_price;
513 $error = $cdr->set_status('done');
515 die $error if $error;
516 $formatter->append($cdr)
517 unless $cdr->rated_price == 0 and not $usage_showzero;
519 $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
523 $formatter->finish; #writes into $details
524 unshift @$details, $formatter->header if @$details;
529 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
530 # lots of false laziness w/voip_inbound
531 sub check_chargable {
532 my( $self, $cdr, %flags ) = @_;
534 return 'amaflags != 2'
535 if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
537 return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
538 if $self->option_cacheable('disposition_in') =~ /\S/
539 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
541 return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
542 if $self->option_cacheable('ignore_disposition') =~ /\S/
543 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
545 foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
546 return "dst starts with '$_'"
547 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
550 return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
551 if $self->option_cacheable('use_carrierid') =~ /\S/
552 && ! $flags{'da_rewrote'} #why?
553 && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
555 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
556 return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
557 if length($self->option_cacheable('use_cdrtypenum'))
558 && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
560 return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
561 if length($self->option_cacheable('ignore_cdrtypenum'))
562 && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
564 # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs.
565 return "calltypenum != ". $self->option_cacheable('use_calltypenum')
566 if length($self->option_cacheable('use_calltypenum'))
567 && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches ''
569 return "calltypenum == ". $self->option_cacheable('ignore_calltypenum')
570 if length($self->option_cacheable('ignore_calltypenum'))
571 && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches ''
573 return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
574 if $self->option_cacheable('skip_dcontext') =~ /\S/
575 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
577 my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
578 return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
580 && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
582 my $dst_length = $self->option_cacheable('skip_dst_length_less');
583 return "destination less than $dst_length digits"
584 if $dst_length && length($cdr->dst) < $dst_length
585 && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
586 && $cdr->is_tollfree('accountcode')
589 return "lastapp is ". $self->option_cacheable('skip_lastapp')
590 if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
592 my $src_length = $self->option_cacheable('skip_src_length_more');
595 if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
597 if ( $cdr->is_tollfree('accountcode') ) {
598 return "source less than or equal to $src_length digits"
599 if length($cdr->src) <= $src_length;
601 return "source more than $src_length digits"
602 if length($cdr->src) > $src_length;
606 return "source more than $src_length digits"
607 if length($cdr->src) > $src_length;
612 return "max_callers <= ". $self->option_cacheable('skip_max_callers')
613 if length($self->option_cacheable('skip_max_callers'))
614 and length($cdr->max_callers)
615 and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
617 #all right then, rate it
625 # This equates svc_phone records; perhaps svc_phone should have a field
626 # to indicate it represents a line
628 my($self, $cust_pkg ) = @_;
630 if ( $self->option('count_available_phones', 1)) {
631 foreach my $pkg_svc ($cust_pkg->part_pkg->pkg_svc) {
632 if ($pkg_svc->part_svc->svcdb eq 'svc_phone') { # svc_pbx?
633 $count += $pkg_svc->quantity || 0;
636 $count *= $cust_pkg->quantity;
639 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
645 my ($self, $cust_pkg, %opt) = @_;
646 my @part_pkg_usage = $self->part_pkg_usage or return '';
647 warn " resetting usage minutes\n" if $opt{debug};
648 my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
649 foreach my $part_pkg_usage (@part_pkg_usage) {
650 my $part = $part_pkg_usage->pkgusagepart;
651 my $usage = $cust_pkg_usage{$part} ||
652 FS::cust_pkg_usage->new({
653 'pkgnum' => $cust_pkg->pkgnum,
654 'pkgusagepart' => $part,
655 'minutes' => $part_pkg_usage->minutes,
657 foreach my $cdr_usage (
658 qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
660 my $error = $cdr_usage->delete;
661 warn " error resetting CDR usage: $error\n";
664 if ( $usage->pkgusagenum ) {
665 if ( $part_pkg_usage->rollover ) {
666 $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
668 $usage->set('minutes', $part_pkg_usage->minutes);
670 my $error = $usage->replace;
671 warn " error resetting usage minutes: $error\n" if $error;
673 my $error = $usage->insert;
674 warn " error resetting usage minutes: $error\n" if $error;
676 } #foreach $part_pkg_usage
679 # tells whether cust_bill_pkg_detail should return a single line for
683 $self->option('output_format') =~ /^sum_/;
686 # and whether cust_bill should show a detail line for the service label
687 # (separate from usage details)
688 sub hide_svc_detail {
690 $self->option('output_format') =~ /^sum_/;