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()
65 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
66 'shortname' => 'VoIP/telco CDR rating (standard)',
67 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
69 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
72 #false laziness w/flat.pm
73 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
75 'select_options' => \%temporalities,
78 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
82 'recur_method' => { 'name' => 'Recurring fee method',
84 #'options' => \%recur_method,
86 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
89 'cdr_svc_method' => { 'name' => 'CDR service matching method',
92 'select_options' => \%cdr_svc_method,
95 'rating_method' => { 'name' => 'Rating method',
97 'options' => \%rating_method,
100 'rounding' => { 'name' => 'Rounding for destination prefix rating',
102 'select_options' => \%rounding,
105 'ratenum' => { 'name' => 'Rate plan',
107 'select_table' => 'rate',
108 'select_key' => 'ratenum',
109 'select_label' => 'ratename',
112 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
114 'select_table' => 'rate',
115 'select_key' => 'ratenum',
116 'select_label' => 'ratename',
117 'disable_empty' => 0,
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 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
217 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
218 'type' => 'checkbox',
221 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
224 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
227 'skip_same_customer' => {
228 'name' => 'Do not charge for calls between numbers belonging to the same customer',
229 'type' => 'checkbox',
232 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
233 'type' => 'checkbox',
236 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
239 #false laziness w/cdr_termination.pm
240 'output_format' => { 'name' => 'CDR display format for invoices',
242 'select_options' => \%detail_formats,
243 'default' => 'default', #XXX test
246 'selfservice_format' =>
247 { 'name' => 'CDR display format for selfservice',
249 'select_options' => \%detail_formats,
250 'default' => 'default'
252 'selfservice_inbound_format' =>
253 { 'name' => 'Inbound CDR display format for selfservice',
255 'select_options' => \%detail_formats,
259 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
262 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
263 'type' => 'checkbox',
266 'usage_mandate' => { 'name' => 'Always put usage details in separate section. The section is defined in the next option.',
267 'type' => 'checkbox',
271 'usage_nozero' => { 'name' => 'Omit details for included / no-charge calls.',
272 'type' => 'checkbox',
275 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
276 'type' => 'checkbox',
279 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
280 'type' => 'checkbox',
283 '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.',
284 'type' => 'checkbox',
287 #XXX also have option for an external db? these days we suck them into ours
288 # 'cdr_location' => { 'name' => 'CDR database location'
289 # 'type' => 'select',
290 # 'select_options' => \%cdr_location,
291 # 'select_callback' => {
293 # 'enable' => [ 'datasrc', 'username', 'password' ],
296 # 'disable' => [ 'datasrc', 'username', 'password' ],
300 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
303 # 'username' => { 'name' => 'External database username',
306 # 'password' => { 'name' => 'External database password',
313 recur_method cutoff_day ),
314 FS::part_pkg::prorate_Mixin::fieldorder,
317 rating_method rounding ratenum intrastate_ratenum
319 min_charge min_included sec_granularity
323 domestic_prefix international_prefix
327 use_cdrtypenum ignore_cdrtypenum
328 use_calltypenum ignore_calltypenum
329 ignore_disposition disposition_in
330 skip_dcontext skip_dst_prefix
331 skip_dstchannel_prefix skip_src_length_more
332 noskip_src_length_accountcode_tollfree
333 accountcode_tollfree_ratenum
335 noskip_dst_length_accountcode_tollfree
342 selfservice_format selfservice_inbound_format
343 usage_mandate usage_section summarize_usage
344 usage_nozero bill_every_call bill_inactive_svcs
345 count_available_phones suspend_bill
353 my $str = $self->SUPER::price_info;
354 $str .= " plus usage" if $str;
360 my($cust_pkg, $sdate, $details, $param ) = @_;
364 $charges += $self->calc_usage(@_);
365 $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_);
374 # my($cust_pkg, $sdate, $details, $param ) = @_;
376 # $self->calc_usage(@_);
379 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
383 my($cust_pkg, $sdate, $details, $param ) = @_;
385 #my $last_bill = $cust_pkg->last_bill;
386 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
389 if $self->recur_temporality eq 'preceding'
390 && ( $last_bill eq '' || $last_bill == 0 );
394 my $included_min = $self->option('min_included', 1) || 0; #single price rating
395 my $included_calls = $self->option('calls_included', 1) || 0;
397 my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
398 my $rating_method = $self->option('rating_method') || 'prefix';
399 my $region_group_included_min = $self->option('min_included',1) || 0;
400 my %region_group_included_min = ();
402 my $output_format = $self->option('output_format', 'Hush!')
403 || ( $rating_method eq 'upstream_simple'
408 my $usage_nozero = $self->option('usage_nozero', 1);
410 my $formatter = FS::detail_format->new($output_format, buffer => $details);
412 my $use_duration = $self->option('use_duration');
414 my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
417 if( $self->option('bill_inactive_svcs',1) ) {
418 #XXX in this mode do we need to restrict the set of CDRs by date also?
419 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
422 @cust_svc = $cust_pkg->cust_svc;
424 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
426 foreach my $cust_svc (@cust_svc) {
429 if( $self->option('bill_inactive_svcs',1) ) {
430 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
433 $svc_x = $cust_svc->svc_x;
437 my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : '';
438 warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n";
442 'disable_src' => $self->option('disable_src'),
443 'default_prefix' => $self->option('default_prefix'),
444 'cdrtypenum' => $self->option('use_cdrtypenum'),
445 'calltypenum' => $self->option('use_calltypenum'),
448 ); # $last_bill, $$sdate )
449 if ( $svc_field eq 'svcnum' ) {
450 $options{'by_svcnum'} = 1;
452 elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
453 $options{'by_ip_addr'} = $by_ip_addr;
456 #my @invoice_details_sort;
458 #first rate any outstanding CDRs not yet rated
459 my $cdr_search = $svc_x->psearch_cdrs(%options);
460 $cdr_search->limit(1000);
461 $cdr_search->increment(0); # because we're changing their status as we go
462 while ( my $cdr = $cdr_search->fetch ) {
464 my $error = $cdr->rate(
466 'cust_pkg' => $cust_pkg,
467 'svcnum' => $svc_x->svcnum,
468 'single_price_included_min' => \$included_min,
469 'region_group_included_min' => \$region_group_included_min,
470 'region_group_included_min_hashref' => \%region_group_included_min,
472 die $error if $error; #??
474 $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
475 # it was skipped without changing status, so increment the
476 # offset so that we don't re-fetch it on refill
480 #then add details to invoices & get a total
481 $options{'status'} = 'rated';
483 $cdr_search = $svc_x->psearch_cdrs(%options);
484 $cdr_search->limit(1000);
485 $cdr_search->increment(0);
486 while ( my $cdr = $cdr_search->fetch ) {
488 # at this point we officially Do Not Care about the rating method
489 if ( $included_calls > 0 ) {
491 #$charges += 0, obviously
492 #but don't set the rated price to zero--there should be a record
493 $error = $cdr->set_status('no-charge');
496 $charges += $cdr->rated_price;
497 $error = $cdr->set_status('done');
499 die $error if $error;
500 $formatter->append($cdr) unless $usage_nozero && $cdr->rated_price == 0;
502 $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
506 $formatter->finish; #writes into $details
507 unshift @$details, $formatter->header if @$details;
512 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
513 # lots of false laziness w/voip_inbound
514 sub check_chargable {
515 my( $self, $cdr, %flags ) = @_;
517 return 'amaflags != 2'
518 if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
520 return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
521 if $self->option_cacheable('disposition_in') =~ /\S/
522 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
524 return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
525 if $self->option_cacheable('ignore_disposition') =~ /\S/
526 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
528 foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
529 return "dst starts with '$_'"
530 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
533 return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
534 if $self->option_cacheable('use_carrierid') =~ /\S/
535 && ! $flags{'da_rewrote'} #why?
536 && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
538 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
539 return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
540 if length($self->option_cacheable('use_cdrtypenum'))
541 && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
543 return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
544 if length($self->option_cacheable('ignore_cdrtypenum'))
545 && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
547 # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs.
548 return "calltypenum != ". $self->option_cacheable('use_calltypenum')
549 if length($self->option_cacheable('use_calltypenum'))
550 && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches ''
552 return "calltypenum == ". $self->option_cacheable('ignore_calltypenum')
553 if length($self->option_cacheable('ignore_calltypenum'))
554 && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches ''
556 return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
557 if $self->option_cacheable('skip_dcontext') =~ /\S/
558 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
560 my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
561 return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
563 && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
565 my $dst_length = $self->option_cacheable('skip_dst_length_less');
566 return "destination less than $dst_length digits"
567 if $dst_length && length($cdr->dst) < $dst_length
568 && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
569 && $cdr->is_tollfree('accountcode')
572 return "lastapp is ". $self->option_cacheable('skip_lastapp')
573 if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
575 my $src_length = $self->option_cacheable('skip_src_length_more');
578 if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
580 if ( $cdr->is_tollfree('accountcode') ) {
581 return "source less than or equal to $src_length digits"
582 if length($cdr->src) <= $src_length;
584 return "source more than $src_length digits"
585 if length($cdr->src) > $src_length;
589 return "source more than $src_length digits"
590 if length($cdr->src) > $src_length;
595 return "max_callers <= ". $self->option_cacheable('skip_max_callers')
596 if length($self->option_cacheable('skip_max_callers'))
597 and length($cdr->max_callers)
598 and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
600 #all right then, rate it
608 # This equates svc_phone records; perhaps svc_phone should have a field
609 # to indicate it represents a line
611 my($self, $cust_pkg ) = @_;
613 if ( $self->option('count_available_phones', 1)) {
614 map { $count += ( $_->quantity || 0 ) }
615 grep { $_->part_svc->svcdb eq 'svc_phone' }
616 $cust_pkg->part_pkg->pkg_svc;
619 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
625 my ($self, $cust_pkg, %opt) = @_;
626 my @part_pkg_usage = $self->part_pkg_usage or return '';
627 warn " resetting usage minutes\n" if $opt{debug};
628 my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
629 foreach my $part_pkg_usage (@part_pkg_usage) {
630 my $part = $part_pkg_usage->pkgusagepart;
631 my $usage = $cust_pkg_usage{$part} ||
632 FS::cust_pkg_usage->new({
633 'pkgnum' => $cust_pkg->pkgnum,
634 'pkgusagepart' => $part,
635 'minutes' => $part_pkg_usage->minutes,
637 foreach my $cdr_usage (
638 qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
640 my $error = $cdr_usage->delete;
641 warn " error resetting CDR usage: $error\n";
644 if ( $usage->pkgusagenum ) {
645 if ( $part_pkg_usage->rollover ) {
646 $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
648 $usage->set('minutes', $part_pkg_usage->minutes);
650 my $error = $usage->replace;
651 warn " error resetting usage minutes: $error\n" if $error;
653 my $error = $usage->insert;
654 warn " error resetting usage minutes: $error\n" if $error;
656 } #foreach $part_pkg_usage
659 # tells whether cust_bill_pkg_detail should return a single line for
663 $self->option('output_format') =~ /^sum_/;
666 # and whether cust_bill should show a detail line for the service label
667 # (separate from usage details)
668 sub hide_svc_detail {
670 $self->option('output_format') =~ /^sum_/;