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 %cdr_location, 'Tie::IxHash',
35 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
36 # 'external' => 'External: CDR records queried directly from an external '.
37 # 'Asterisk (or other?) CDR table',
40 tie my %temporalities, 'Tie::IxHash',
41 'upcoming' => "Upcoming (future)",
42 'preceding' => "Preceding (past)",
45 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
47 # previously "1" was "ignore"
48 tie my %unrateable_opts, 'Tie::IxHash',
49 '' => 'Exit with a fatal error',
50 1 => 'Ignore and continue',
51 2 => 'Flag for later review',
54 tie my %detail_formats, 'Tie::IxHash',
56 FS::cdr::invoice_formats()
60 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
61 'shortname' => 'VoIP/telco CDR rating (standard)',
62 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
64 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
67 #false laziness w/flat.pm
68 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
70 'select_options' => \%temporalities,
73 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
77 'recur_method' => { 'name' => 'Recurring fee method',
79 #'options' => \%recur_method,
81 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
84 'cdr_svc_method' => { 'name' => 'CDR service matching method',
87 'select_options' => \%cdr_svc_method,
90 'rating_method' => { 'name' => 'Rating method',
92 'options' => \%rating_method,
95 'ratenum' => { 'name' => 'Rate plan',
97 'select_table' => 'rate',
98 'select_key' => 'ratenum',
99 'select_label' => 'ratename',
102 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
104 'select_table' => 'rate',
105 'select_key' => 'ratenum',
106 'select_label' => 'ratename',
107 'disable_empty' => 0,
111 'calls_included' => { 'name' => 'Number of calls included at no usage charge', },
113 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" or "prefix" rating method',
116 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
119 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
121 'select_options' => \%granularity,
124 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
126 'select_options' => \%unrateable_opts,
129 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
133 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
137 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
141 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
142 # 'type' => 'checkbox',
145 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
149 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
150 'type' => 'checkbox',
153 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
154 'type' => 'checkbox',
157 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to any of these (comma-separated) values: ',
160 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to: ',
163 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ',
166 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
169 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
172 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
175 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
178 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
181 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
184 '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',
185 'type' => 'checkbox',
188 'accountcode_tollfree_ratenum' => {
189 'name' => 'Optional alternate rate plan when accountcode is toll free: ',
191 'select_table' => 'rate',
192 'select_key' => 'ratenum',
193 'select_label' => 'ratename',
194 'disable_empty' => 0,
198 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
201 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
202 'type' => 'checkbox',
205 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
208 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
211 'skip_same_customer' => {
212 'name' => 'Do not charge for calls between numbers belonging to the same customer',
213 'type' => 'checkbox',
216 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
217 'type' => 'checkbox',
220 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
223 #false laziness w/cdr_termination.pm
224 'output_format' => { 'name' => 'CDR display format for invoices',
226 'select_options' => \%detail_formats,
227 'default' => 'default', #XXX test
230 'selfservice_format' =>
231 { 'name' => 'CDR display format for selfservice',
233 'select_options' => \%detail_formats,
234 'default' => 'default'
236 'selfservice_inbound_format' =>
237 { 'name' => 'Inbound CDR display format for selfservice',
239 'select_options' => \%detail_formats,
243 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
246 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
247 'type' => 'checkbox',
250 'usage_mandate' => { 'name' => 'Always put usage details in separate section',
251 'type' => 'checkbox',
255 'usage_nozero' => { 'name' => 'Omit details for included / no-charge calls.',
256 'type' => 'checkbox',
259 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
260 'type' => 'checkbox',
263 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
264 'type' => 'checkbox',
267 '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.',
268 'type' => 'checkbox',
271 #XXX also have option for an external db? these days we suck them into ours
272 # 'cdr_location' => { 'name' => 'CDR database location'
273 # 'type' => 'select',
274 # 'select_options' => \%cdr_location,
275 # 'select_callback' => {
277 # 'enable' => [ 'datasrc', 'username', 'password' ],
280 # 'disable' => [ 'datasrc', 'username', 'password' ],
284 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
287 # 'username' => { 'name' => 'External database username',
290 # 'password' => { 'name' => 'External database password',
297 recur_method cutoff_day ),
298 FS::part_pkg::prorate_Mixin::fieldorder,
301 rating_method ratenum intrastate_ratenum
303 min_charge min_included sec_granularity
307 domestic_prefix international_prefix
311 use_cdrtypenum ignore_cdrtypenum
312 ignore_disposition disposition_in
313 skip_dcontext skip_dst_prefix
314 skip_dstchannel_prefix skip_src_length_more
315 noskip_src_length_accountcode_tollfree
316 accountcode_tollfree_ratenum
318 noskip_dst_length_accountcode_tollfree
325 selfservice_format selfservice_inbound_format
326 usage_mandate summarize_usage usage_section
327 bill_every_call bill_inactive_svcs
328 count_available_phones suspend_bill
336 my $str = $self->SUPER::price_info;
337 $str .= " plus usage" if $str;
343 my($cust_pkg, $sdate, $details, $param ) = @_;
347 $charges += $self->calc_usage(@_);
348 $charges += $self->calc_recur_Common(@_);
357 # my($cust_pkg, $sdate, $details, $param ) = @_;
359 # $self->calc_usage(@_);
362 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
366 my($cust_pkg, $sdate, $details, $param ) = @_;
368 #my $last_bill = $cust_pkg->last_bill;
369 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
372 if $self->recur_temporality eq 'preceding'
373 && ( $last_bill eq '' || $last_bill == 0 );
377 my $included_min = $self->option('min_included', 1) || 0; #single price rating
378 my $included_calls = $self->option('calls_included', 1) || 0;
380 my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
381 my $rating_method = $self->option('rating_method') || 'prefix';
382 my $region_group_included_min = $self->option('min_included',1) || 0;
383 my %region_group_included_min = ();
385 my $output_format = $self->option('output_format', 'Hush!')
386 || ( $rating_method eq 'upstream_simple'
391 my $usage_nozero = $self->option('usage_nozero', 1);
393 my $formatter = FS::detail_format->new($output_format, buffer => $details);
395 my $use_duration = $self->option('use_duration');
397 my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
400 if( $self->option('bill_inactive_svcs',1) ) {
401 #XXX in this mode do we need to restrict the set of CDRs by date also?
402 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
405 @cust_svc = $cust_pkg->cust_svc;
407 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
409 foreach my $cust_svc (@cust_svc) {
412 if( $self->option('bill_inactive_svcs',1) ) {
413 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
416 $svc_x = $cust_svc->svc_x;
420 'disable_src' => $self->option('disable_src'),
421 'default_prefix' => $self->option('default_prefix'),
422 'cdrtypenum' => $self->option('use_cdrtypenum'),
425 ); # $last_bill, $$sdate )
426 if ( $svc_field eq 'svcnum' ) {
427 $options{'by_svcnum'} = 1;
429 elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
430 $options{'by_ip_addr'} = $by_ip_addr;
433 #my @invoice_details_sort;
435 #first rate any outstanding CDRs not yet rated
436 my $cdr_search = $svc_x->psearch_cdrs(%options);
437 $cdr_search->limit(1000);
438 $cdr_search->increment(0); # because we're changing their status as we go
439 while ( my $cdr = $cdr_search->fetch ) {
441 my $error = $cdr->rate(
443 'cust_pkg' => $cust_pkg,
444 'svcnum' => $svc_x->svcnum,
445 'single_price_included_min' => \$included_min,
446 'region_group_included_min' => \$region_group_included_min,
447 'region_group_included_min_hashref' => \%region_group_included_min,
449 die $error if $error; #??
451 $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
452 # it was skipped without changing status, so increment the
453 # offset so that we don't re-fetch it on refill
457 #then add details to invoices & get a total
458 $options{'status'} = 'rated';
460 $cdr_search = $svc_x->psearch_cdrs(%options);
461 $cdr_search->limit(1000);
462 $cdr_search->increment(0);
463 while ( my $cdr = $cdr_search->fetch ) {
465 # at this point we officially Do Not Care about the rating method
466 if ( $included_calls > 0 ) {
468 #$charges += 0, obviously
469 #but don't set the rated price to zero--there should be a record
470 $error = $cdr->set_status('no-charge');
473 $charges += $cdr->rated_price;
474 $error = $cdr->set_status('done');
476 die $error if $error;
477 $formatter->append($cdr) unless $usage_nozero && $cdr->rated_price == 0;
479 $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
483 $formatter->finish; #writes into $details
484 unshift @$details, $formatter->header if @$details;
489 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
490 sub check_chargable {
491 my( $self, $cdr, %flags ) = @_;
493 return 'amaflags != 2'
494 if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
496 return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
497 if $self->option_cacheable('disposition_in') =~ /\S/
498 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
500 return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
501 if $self->option_cacheable('ignore_disposition') =~ /\S/
502 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
504 foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
505 return "dst starts with '$_'"
506 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
509 return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
510 if $self->option_cacheable('use_carrierid') =~ /\S/
511 && ! $flags{'da_rewrote'} #why?
512 && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
514 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
515 return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
516 if length($self->option_cacheable('use_cdrtypenum'))
517 && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
519 return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
520 if length($self->option_cacheable('ignore_cdrtypenum'))
521 && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
523 return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
524 if $self->option_cacheable('skip_dcontext') =~ /\S/
525 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
527 my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
528 return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
530 && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
532 my $dst_length = $self->option_cacheable('skip_dst_length_less');
533 return "destination less than $dst_length digits"
534 if $dst_length && length($cdr->dst) < $dst_length
535 && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
536 && $cdr->is_tollfree('accountcode')
539 return "lastapp is ". $self->option_cacheable('skip_lastapp')
540 if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
542 my $src_length = $self->option_cacheable('skip_src_length_more');
545 if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
547 if ( $cdr->is_tollfree('accountcode') ) {
548 return "source less than or equal to $src_length digits"
549 if length($cdr->src) <= $src_length;
551 return "source more than $src_length digits"
552 if length($cdr->src) > $src_length;
556 return "source more than $src_length digits"
557 if length($cdr->src) > $src_length;
562 return "max_callers <= ". $self->option_cacheable('skip_max_callers')
563 if length($self->option_cacheable('skip_max_callers'))
564 and length($cdr->max_callers)
565 and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
567 #all right then, rate it
575 # This equates svc_phone records; perhaps svc_phone should have a field
576 # to indicate it represents a line
578 my($self, $cust_pkg ) = @_;
580 if ( $self->option('count_available_phones', 1)) {
581 map { $count += ( $_->quantity || 0 ) }
582 grep { $_->part_svc->svcdb eq 'svc_phone' }
583 $cust_pkg->part_pkg->pkg_svc;
586 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
592 my ($self, $cust_pkg, %opt) = @_;
593 my @part_pkg_usage = $self->part_pkg_usage or return '';
594 warn " resetting usage minutes\n" if $opt{debug};
595 my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
596 foreach my $part_pkg_usage (@part_pkg_usage) {
597 my $part = $part_pkg_usage->pkgusagepart;
598 my $usage = $cust_pkg_usage{$part} ||
599 FS::cust_pkg_usage->new({
600 'pkgnum' => $cust_pkg->pkgnum,
601 'pkgusagepart' => $part,
602 'minutes' => $part_pkg_usage->minutes,
604 foreach my $cdr_usage (
605 qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
607 my $error = $cdr_usage->delete;
608 warn " error resetting CDR usage: $error\n";
611 if ( $usage->pkgusagenum ) {
612 if ( $part_pkg_usage->rollover ) {
613 $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
615 $usage->set('minutes', $part_pkg_usage->minutes);
617 my $error = $usage->replace;
618 warn " error resetting usage minutes: $error\n" if $error;
620 my $error = $usage->insert;
621 warn " error resetting usage minutes: $error\n" if $error;
623 } #foreach $part_pkg_usage
626 # tells whether cust_bill_pkg_detail should return a single line for
630 $self->option('output_format') =~ /^sum_/;
633 # and whether cust_bill should show a detail line for the service label
634 # (separate from usage details)
635 sub hide_svc_detail {
637 $self->option('output_format') =~ /^sum_/;