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',
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 the dcontext is set to any of these (comma-separated) values: ',
194 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
197 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
200 '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',
201 'type' => 'checkbox',
204 'accountcode_tollfree_ratenum' => {
205 'name' => 'Optional alternate rate plan when accountcode is toll free: ',
207 'select_table' => 'rate',
208 'select_key' => 'ratenum',
209 'select_label' => 'ratename',
210 'disable_empty' => 0,
214 'accountcode_tollfree_field' => {
215 'name' => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations',
217 'select_options' => \%accountcode_tollfree_field,
220 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
223 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
224 'type' => 'checkbox',
227 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
230 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
233 'skip_same_customer' => {
234 'name' => 'Do not charge for calls between numbers belonging to the same customer',
235 'type' => 'checkbox',
238 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
239 'type' => 'checkbox',
242 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
245 #false laziness w/cdr_termination.pm
246 'output_format' => { 'name' => 'CDR display format for invoices',
248 'select_options' => \%detail_formats,
249 'default' => 'default', #XXX test
252 'selfservice_format' =>
253 { 'name' => 'CDR display format for selfservice',
255 'select_options' => \%detail_formats,
256 'default' => 'default'
258 'selfservice_inbound_format' =>
259 { 'name' => 'Inbound CDR display format for selfservice',
261 'select_options' => \%detail_formats,
265 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
268 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
269 'type' => 'checkbox',
272 'usage_mandate' => { 'name' => 'Always put usage details in separate section. The section is defined in the next option.',
273 'type' => 'checkbox',
277 'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.',
278 'type' => 'checkbox',
281 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
282 'type' => 'checkbox',
285 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
286 'type' => 'checkbox',
288 'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period',
289 'type' => 'checkbox',
292 '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.',
293 'type' => 'checkbox',
296 #XXX also have option for an external db? these days we suck them into ours
297 # 'cdr_location' => { 'name' => 'CDR database location'
298 # 'type' => 'select',
299 # 'select_options' => \%cdr_location,
300 # 'select_callback' => {
302 # 'enable' => [ 'datasrc', 'username', 'password' ],
305 # 'disable' => [ 'datasrc', 'username', 'password' ],
309 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
312 # 'username' => { 'name' => 'External database username',
315 # 'password' => { 'name' => 'External database password',
322 recur_method cutoff_day ),
323 FS::part_pkg::prorate_Mixin::fieldorder,
326 rating_method rounding ratenum intrastate_ratenum
328 min_charge min_included sec_granularity
332 domestic_prefix international_prefix
336 use_cdrtypenum ignore_cdrtypenum
337 use_calltypenum ignore_calltypenum
338 ignore_disposition disposition_in
339 skip_dcontext skip_dst_prefix
340 skip_dstchannel_prefix skip_src_length_more
341 noskip_src_length_accountcode_tollfree
342 accountcode_tollfree_ratenum accountcode_tollfree_field
344 noskip_dst_length_accountcode_tollfree
351 selfservice_format selfservice_inbound_format
352 usage_mandate usage_section summarize_usage
353 usage_showzero bill_every_call bill_inactive_svcs
355 count_available_phones suspend_bill
363 my $str = $self->SUPER::price_info;
364 $str .= " plus usage" if $str;
370 my($cust_pkg, $sdate, $details, $param ) = @_;
374 $charges += $self->calc_usage(@_);
375 $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_);
384 # my($cust_pkg, $sdate, $details, $param ) = @_;
386 # $self->calc_usage(@_);
389 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
393 my($cust_pkg, $sdate, $details, $param ) = @_;
395 #my $last_bill = $cust_pkg->last_bill;
396 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
399 if $self->recur_temporality eq 'preceding'
400 && ( $last_bill eq '' || $last_bill == 0 );
404 my $included_min = $self->option('min_included', 1) || 0;
408 my $included_calls = $self->option('calls_included', 1) || 0;
410 my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
411 my $rating_method = $self->option('rating_method') || 'prefix';
412 my %detail_included_min = ();
414 my $output_format = $self->option('output_format', 'Hush!')
415 || ( $rating_method eq 'upstream_simple'
420 my $usage_showzero = $self->option('usage_showzero', 1);
422 my $formatter = FS::detail_format->new($output_format,
424 locale => $cust_pkg->cust_main->locale
427 my $use_duration = $self->option('use_duration');
429 my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
432 if( $self->option('bill_inactive_svcs',1) ) {
433 #XXX in this mode do we need to restrict the set of CDRs by date also?
434 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
437 @cust_svc = $cust_pkg->cust_svc;
439 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
441 foreach my $cust_svc (@cust_svc) {
444 if( $self->option('bill_inactive_svcs',1) ) {
445 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
448 $svc_x = $cust_svc->svc_x;
452 my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : '';
453 warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n";
457 'disable_src' => $self->option('disable_src'),
458 'default_prefix' => $self->option('default_prefix'),
459 'cdrtypenum' => $self->option('use_cdrtypenum'),
460 'calltypenum' => $self->option('use_calltypenum', 1),
464 if ( $self->option('bill_only_pkg_dates') ) {
465 $options{'begin'} = $last_bill;
466 $options{'end'} = $$sdate;
468 if ( $svc_field eq 'svcnum' ) {
469 $options{'by_svcnum'} = 1;
470 } elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
471 $options{'by_ip_addr'} = $by_ip_addr;
474 #my @invoice_details_sort;
476 # for tagging invoice details
477 # (unfortunate; should be a svc_x class method or table_info item or
480 if ( $svc_table eq 'svc_phone' ) {
481 $phonenum = $svc_x->phonenum;
482 } elsif ( $svc_table eq 'svc_pbx' ) {
483 $phonenum = $svc_x->title;
484 } elsif ( $svc_table eq 'svc_acct' ) {
485 $phonenum = $svc_x->username;
487 $formatter->phonenum($phonenum);
489 #first rate any outstanding CDRs not yet rated
490 # use FS::Cursor for this starting in 4.x
491 my $cdr_search = $svc_x->psearch_cdrs(%options);
492 $cdr_search->limit(1000);
493 $cdr_search->increment(0); # because we're changing their status as we go
494 while ( my $cdr = $cdr_search->fetch ) {
496 my $error = $cdr->rate(
498 'cust_pkg' => $cust_pkg,
499 'svcnum' => $svc_x->svcnum,
500 'plan_included_min' => \$included_min,
501 'detail_included_min_hashref' => \%detail_included_min,
503 die $error if $error; #??
505 $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
506 # it was skipped without changing status, so increment the
507 # offset so that we don't re-fetch it on refill
511 #then add details to invoices & get a total
512 $options{'status'} = 'rated';
514 $cdr_search = $svc_x->psearch_cdrs(%options);
515 $cdr_search->limit(1000);
516 $cdr_search->increment(0);
517 while ( my $cdr = $cdr_search->fetch ) {
519 # at this point we officially Do Not Care about the rating method
520 if ( $included_calls > 0 ) {
522 #$charges += 0, obviously
523 #but don't set the rated price to zero--there should be a record
524 $error = $cdr->set_status('no-charge');
527 $charges += $cdr->rated_price;
528 $error = $cdr->set_status('done');
530 die $error if $error;
531 $formatter->append($cdr)
532 unless $cdr->rated_price == 0 and not $usage_showzero;
534 $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
538 $formatter->finish; #writes into $details
539 unshift @$details, $formatter->header if @$details;
544 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
545 # lots of false laziness w/voip_inbound
546 sub check_chargable {
547 my( $self, $cdr, %flags ) = @_;
549 return 'amaflags != 2'
550 if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
552 return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
553 if $self->option_cacheable('disposition_in') =~ /\S/
554 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
556 return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
557 if $self->option_cacheable('ignore_disposition') =~ /\S/
558 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
560 foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
561 return "dst starts with '$_'"
562 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
565 return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
566 if $self->option_cacheable('use_carrierid') =~ /\S/
567 && ! $flags{'da_rewrote'} #why?
568 && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
570 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
571 return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
572 if length($self->option_cacheable('use_cdrtypenum'))
573 && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
575 return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
576 if length($self->option_cacheable('ignore_cdrtypenum'))
577 && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
579 # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs.
580 return "calltypenum != ". $self->option_cacheable('use_calltypenum')
581 if length($self->option_cacheable('use_calltypenum'))
582 && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches ''
584 return "calltypenum == ". $self->option_cacheable('ignore_calltypenum')
585 if length($self->option_cacheable('ignore_calltypenum'))
586 && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches ''
588 return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
589 if $self->option_cacheable('skip_dcontext') =~ /\S/
590 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
592 my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
593 return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
595 && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
597 my $dst_length = $self->option_cacheable('skip_dst_length_less');
598 return "destination less than $dst_length digits"
599 if $dst_length && length($cdr->dst) < $dst_length
600 && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
601 && $cdr->is_tollfree('accountcode')
604 return "lastapp is ". $self->option_cacheable('skip_lastapp')
605 if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
607 my $src_length = $self->option_cacheable('skip_src_length_more');
610 if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
612 if ( $cdr->is_tollfree('accountcode') ) {
613 return "source less than or equal to $src_length digits"
614 if length($cdr->src) <= $src_length;
616 return "source more than $src_length digits"
617 if length($cdr->src) > $src_length;
621 return "source more than $src_length digits"
622 if length($cdr->src) > $src_length;
627 return "max_callers <= ". $self->option_cacheable('skip_max_callers')
628 if length($self->option_cacheable('skip_max_callers'))
629 and length($cdr->max_callers)
630 and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
632 #all right then, rate it
640 # This equates svc_phone records; perhaps svc_phone should have a field
641 # to indicate it represents a line
643 my($self, $cust_pkg ) = @_;
645 if ( $self->option('count_available_phones', 1)) {
646 foreach my $pkg_svc ($cust_pkg->part_pkg->pkg_svc) {
647 if ($pkg_svc->part_svc->svcdb eq 'svc_phone') { # svc_pbx?
648 $count += $pkg_svc->quantity || 0;
651 $count *= $cust_pkg->quantity;
654 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
660 my ($self, $cust_pkg, %opt) = @_;
661 my @part_pkg_usage = $self->part_pkg_usage or return '';
662 warn " resetting usage minutes\n" if $opt{debug};
663 my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
664 foreach my $part_pkg_usage (@part_pkg_usage) {
665 my $part = $part_pkg_usage->pkgusagepart;
666 my $usage = $cust_pkg_usage{$part} ||
667 FS::cust_pkg_usage->new({
668 'pkgnum' => $cust_pkg->pkgnum,
669 'pkgusagepart' => $part,
670 'minutes' => $part_pkg_usage->minutes,
672 foreach my $cdr_usage (
673 qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
675 my $error = $cdr_usage->delete;
676 warn " error resetting CDR usage: $error\n";
679 if ( $usage->pkgusagenum ) {
680 if ( $part_pkg_usage->rollover ) {
681 $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
683 $usage->set('minutes', $part_pkg_usage->minutes);
685 my $error = $usage->replace;
686 warn " error resetting usage minutes: $error\n" if $error;
688 my $error = $usage->insert;
689 warn " error resetting usage minutes: $error\n" if $error;
691 } #foreach $part_pkg_usage
694 # tells whether cust_bill_pkg_detail should return a single line for
698 $self->option('output_format') =~ /^sum_/;
701 # and whether cust_bill should show a detail line for the service label
702 # (separate from usage details)
703 sub hide_svc_detail {
705 $self->option('output_format') =~ /^sum_/;