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;
16 tie my %cdr_svc_method, 'Tie::IxHash',
17 'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)',
18 'svc_pbx.title' => 'PBX name (svc_pbx.title)',
19 'svc_pbx.svcnum' => 'Freeside service # (svc_pbx.svcnum)',
20 'svc_pbx.ip.src' => 'PBX name to source IP address',
21 'svc_pbx.ip.dst' => 'PBX name to destination IP address',
22 'svc_acct.username' => 'Username (svc_acct.username)',
25 tie my %rating_method, 'Tie::IxHash',
26 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
27 # '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.',
28 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
29 'single_price' => 'A single price per minute for all calls.',
32 tie my %rounding, 'Tie::IxHash',
33 '2' => 'Two decimal places (cent)',
34 '4' => 'Four decimal places (100th of a cent)',
37 #tie my %cdr_location, 'Tie::IxHash',
38 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
39 # 'external' => 'External: CDR records queried directly from an external '.
40 # 'Asterisk (or other?) CDR table',
43 tie my %temporalities, 'Tie::IxHash',
44 'upcoming' => "Upcoming (future)",
45 'preceding' => "Preceding (past)",
48 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
50 # previously "1" was "ignore"
51 tie my %unrateable_opts, 'Tie::IxHash',
52 '' => 'Exit with a fatal error',
53 1 => 'Ignore and continue',
54 2 => 'Flag for later review',
57 tie my %detail_formats, 'Tie::IxHash',
59 FS::cdr::invoice_formats()
62 tie my %accountcode_tollfree_field, 'Tie::IxHash',
63 'dst' => 'Destination (dst)',
64 'src' => 'Source (src)',
68 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
69 'shortname' => 'VoIP/telco CDR rating (standard)',
70 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
72 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
75 #false laziness w/flat.pm
76 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
78 'select_options' => \%temporalities,
81 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
85 'recur_method' => { 'name' => 'Recurring fee method',
87 #'options' => \%recur_method,
89 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
92 'cdr_svc_method' => { 'name' => 'CDR service matching method',
95 'select_options' => \%cdr_svc_method,
98 'rating_method' => { 'name' => 'Rating method',
100 'options' => \%rating_method,
103 'rounding' => { 'name' => 'Rounding for destination prefix rating',
105 'select_options' => \%rounding,
108 'ratenum' => { 'name' => 'Rate plan',
109 'type' => 'select-rate',
112 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
113 'type' => 'select-rate',
114 'disable_empty' => 0,
115 'empty_label' => ' ',
118 'calls_included' => { 'name' => 'Number of calls included at no usage charge', },
120 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" or "prefix" rating method',
123 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
126 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
128 'select_options' => \%granularity,
131 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
133 'select_options' => \%unrateable_opts,
136 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
140 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
144 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
148 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
149 # 'type' => 'checkbox',
152 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
156 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
157 'type' => 'checkbox',
160 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
161 'type' => 'checkbox',
164 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to any of these (comma-separated) values: ',
167 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to this cdrtypenum: ',
170 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to this cdrtypenum: ',
173 'use_calltypenum' => { 'name' => 'Only charge for CDRs where the CDR Call Type is set to this calltypenum: ',
176 'ignore_calltypenum' => { 'name' => 'Do not charge for CDRs where the CDR Call Type is set to this calltypenum: ',
179 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
182 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
185 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
188 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
191 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
194 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
197 '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',
198 'type' => 'checkbox',
201 'accountcode_tollfree_ratenum' => {
202 'name' => 'Optional alternate rate plan when accountcode is toll free: ',
204 'select_table' => 'rate',
205 'select_key' => 'ratenum',
206 'select_label' => 'ratename',
207 'disable_empty' => 0,
211 'accountcode_tollfree_field' => {
212 'name' => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations',
214 'select_options' => \%accountcode_tollfree_field,
217 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
220 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
221 'type' => 'checkbox',
224 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
227 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
230 'skip_same_customer' => {
231 'name' => 'Do not charge for calls between numbers belonging to the same customer',
232 'type' => 'checkbox',
235 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
236 'type' => 'checkbox',
239 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
242 #false laziness w/cdr_termination.pm
243 'output_format' => { 'name' => 'CDR display format for invoices',
245 'select_options' => \%detail_formats,
246 'default' => 'default', #XXX test
249 'selfservice_format' =>
250 { 'name' => 'CDR display format for selfservice',
252 'select_options' => \%detail_formats,
253 'default' => 'default'
255 'selfservice_inbound_format' =>
256 { 'name' => 'Inbound CDR display format for selfservice',
258 'select_options' => \%detail_formats,
262 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
265 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
266 'type' => 'checkbox',
269 'usage_mandate' => { 'name' => 'Always put usage details in separate section. The section is defined in the next option.',
270 'type' => 'checkbox',
274 'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.',
275 'type' => 'checkbox',
278 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
279 'type' => 'checkbox',
282 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
283 'type' => 'checkbox',
285 'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period',
286 'type' => 'checkbox',
289 '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.',
290 'type' => 'checkbox',
293 #XXX also have option for an external db? these days we suck them into ours
294 # 'cdr_location' => { 'name' => 'CDR database location'
295 # 'type' => 'select',
296 # 'select_options' => \%cdr_location,
297 # 'select_callback' => {
299 # 'enable' => [ 'datasrc', 'username', 'password' ],
302 # 'disable' => [ 'datasrc', 'username', 'password' ],
306 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
309 # 'username' => { 'name' => 'External database username',
312 # 'password' => { 'name' => 'External database password',
319 recur_method cutoff_day ),
320 FS::part_pkg::prorate_Mixin::fieldorder,
323 rating_method rounding ratenum intrastate_ratenum
325 min_charge min_included sec_granularity
329 domestic_prefix international_prefix
333 use_cdrtypenum ignore_cdrtypenum
334 use_calltypenum ignore_calltypenum
335 ignore_disposition disposition_in
336 skip_dcontext skip_dst_prefix
337 skip_dstchannel_prefix skip_src_length_more
338 noskip_src_length_accountcode_tollfree
339 accountcode_tollfree_ratenum accountcode_tollfree_field
341 noskip_dst_length_accountcode_tollfree
348 selfservice_format selfservice_inbound_format
349 usage_mandate usage_section summarize_usage
350 usage_showzero bill_every_call bill_inactive_svcs
352 count_available_phones suspend_bill
360 my $str = $self->SUPER::price_info(@_);
361 $str .= " plus usage" if $str;
367 my($cust_pkg, $sdate, $details, $param ) = @_;
371 $charges += $self->calc_usage(@_);
372 $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_);
381 # my($cust_pkg, $sdate, $details, $param ) = @_;
383 # $self->calc_usage(@_);
386 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
390 my($cust_pkg, $sdate, $details, $param ) = @_;
392 #my $last_bill = $cust_pkg->last_bill;
393 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
396 if $self->recur_temporality eq 'preceding'
397 && ( $last_bill eq '' || $last_bill == 0 );
401 my $included_min = $self->option('min_included', 1) || 0;
405 my $included_calls = $self->option('calls_included', 1) || 0;
407 my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
408 my $rating_method = $self->option('rating_method') || 'prefix';
409 my %detail_included_min = ();
411 my $output_format = $self->option('output_format', 'Hush!')
412 || ( $rating_method eq 'upstream_simple'
417 my $usage_showzero = $self->option('usage_showzero', 1);
419 my $formatter = FS::detail_format->new($output_format,
421 locale => $cust_pkg->cust_main->locale
424 my $use_duration = $self->option('use_duration');
426 my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method);
429 if( $self->option('bill_inactive_svcs',1) ) {
430 #XXX in this mode do we need to restrict the set of CDRs by date also?
431 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
434 @cust_svc = $cust_pkg->cust_svc;
436 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
438 foreach my $cust_svc (@cust_svc) {
441 if( $self->option('bill_inactive_svcs',1) ) {
442 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
445 $svc_x = $cust_svc->svc_x;
449 my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : '';
450 warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n";
454 'disable_src' => $self->option('disable_src',1),
455 'default_prefix' => $self->option('default_prefix',1),
456 'cdrtypenum' => $self->option('use_cdrtypenum',1),
457 'calltypenum' => $self->option('use_calltypenum',1),
461 if ( $self->option('bill_only_pkg_dates') ) {
462 $options{'begin'} = $last_bill;
463 $options{'end'} = $$sdate;
465 if ( $svc_field eq 'svcnum' ) {
466 $options{'by_svcnum'} = 1;
467 } elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') {
468 $options{'by_ip_addr'} = $by_ip_addr;
471 #my @invoice_details_sort;
473 # for tagging invoice details
474 # (unfortunate; should be a svc_x class method or table_info item or
477 if ( $svc_table eq 'svc_phone' ) {
478 $phonenum = $svc_x->phonenum;
479 } elsif ( $svc_table eq 'svc_pbx' ) {
480 $phonenum = $svc_x->title;
481 } elsif ( $svc_table eq 'svc_acct' ) {
482 $phonenum = $svc_x->username;
484 $formatter->phonenum($phonenum);
486 #first rate any outstanding CDRs not yet rated
487 # use FS::Cursor for this starting in 4.x
488 my $cdr_search = $svc_x->psearch_cdrs(%options);
489 $cdr_search->limit(1000);
490 $cdr_search->increment(0); # because we're changing their status as we go
491 while ( my $cdr = $cdr_search->fetch ) {
493 my $error = $cdr->rate(
495 'cust_pkg' => $cust_pkg,
496 'svcnum' => $svc_x->svcnum,
497 'plan_included_min' => \$included_min,
498 'detail_included_min_hashref' => \%detail_included_min,
500 die $error if $error; #??
502 $cdr_search->adjust(1) if $cdr->freesidestatus eq '';
503 # it was skipped without changing status, so increment the
504 # offset so that we don't re-fetch it on refill
508 #then add details to invoices & get a total
509 $options{'status'} = 'rated';
511 $cdr_search = $svc_x->psearch_cdrs(%options);
512 $cdr_search->limit(1000);
513 $cdr_search->increment(0);
514 while ( my $cdr = $cdr_search->fetch ) {
516 # at this point we officially Do Not Care about the rating method
517 if ( $included_calls > 0 ) {
519 #$charges += 0, obviously
520 #but don't set the rated price to zero--there should be a record
521 $error = $cdr->set_status('no-charge');
524 $charges += $cdr->rated_price;
525 $error = $cdr->set_status('done');
527 die $error if $error;
528 $formatter->append($cdr)
529 unless $cdr->rated_price == 0 and not $usage_showzero;
531 $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated';
535 $formatter->finish; #writes into $details
536 unshift @$details, $formatter->header if @$details;
541 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
542 # lots of false laziness w/voip_inbound
543 sub check_chargable {
544 my( $self, $cdr, %flags ) = @_;
546 return 'amaflags != 2'
547 if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2;
549 return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )"
550 if $self->option_cacheable('disposition_in') =~ /\S/
551 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in'));
553 return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )"
554 if $self->option_cacheable('ignore_disposition') =~ /\S/
555 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition'));
557 foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) {
558 return "dst starts with '$_'"
559 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
562 return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )"
563 if $self->option_cacheable('use_carrierid') =~ /\S/
564 && ! $flags{'da_rewrote'} #why?
565 && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches ''
567 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
568 return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum')
569 if length($self->option_cacheable('use_cdrtypenum'))
570 && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches ''
572 return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum')
573 if length($self->option_cacheable('ignore_cdrtypenum'))
574 && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches ''
576 # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs.
577 return "calltypenum != ". $self->option_cacheable('use_calltypenum')
578 if length($self->option_cacheable('use_calltypenum'))
579 && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches ''
581 return "calltypenum == ". $self->option_cacheable('ignore_calltypenum')
582 if length($self->option_cacheable('ignore_calltypenum'))
583 && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches ''
585 return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )"
586 if $self->option_cacheable('skip_dcontext') =~ /\S/
587 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext'));
589 my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix'));
590 return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix')
592 && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix');
594 my $dst_length = $self->option_cacheable('skip_dst_length_less');
595 return "destination less than $dst_length digits"
596 if $dst_length && length($cdr->dst) < $dst_length
597 && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree')
598 && $cdr->is_tollfree('accountcode')
601 return "lastapp is ". $self->option_cacheable('skip_lastapp')
602 if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp');
604 my $src_length = $self->option_cacheable('skip_src_length_more');
607 if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) {
609 if ( $cdr->is_tollfree('accountcode') ) {
610 return "source less than or equal to $src_length digits"
611 if length($cdr->src) <= $src_length;
613 return "source more than $src_length digits"
614 if length($cdr->src) > $src_length;
618 return "source more than $src_length digits"
619 if length($cdr->src) > $src_length;
624 return "max_callers <= ". $self->option_cacheable('skip_max_callers')
625 if length($self->option_cacheable('skip_max_callers'))
626 and length($cdr->max_callers)
627 and $cdr->max_callers <= $self->option_cacheable('skip_max_callers');
629 #all right then, rate it
637 # This equates svc_phone records; perhaps svc_phone should have a field
638 # to indicate it represents a line
640 my($self, $cust_pkg ) = @_;
642 if ( $self->option('count_available_phones', 1)) {
643 foreach my $pkg_svc ($cust_pkg->part_pkg->pkg_svc) {
644 if ($pkg_svc->part_svc->svcdb eq 'svc_phone') { # svc_pbx?
645 $count += $pkg_svc->quantity || 0;
648 $count *= $cust_pkg->quantity;
651 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
657 my ($self, $cust_pkg, %opt) = @_;
658 my @part_pkg_usage = $self->part_pkg_usage or return '';
659 warn " resetting usage minutes\n" if $opt{debug};
660 my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage;
661 foreach my $part_pkg_usage (@part_pkg_usage) {
662 my $part = $part_pkg_usage->pkgusagepart;
663 my $usage = $cust_pkg_usage{$part} ||
664 FS::cust_pkg_usage->new({
665 'pkgnum' => $cust_pkg->pkgnum,
666 'pkgusagepart' => $part,
667 'minutes' => $part_pkg_usage->minutes,
669 foreach my $cdr_usage (
670 qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum})
672 my $error = $cdr_usage->delete;
673 warn " error resetting CDR usage: $error\n";
676 if ( $usage->pkgusagenum ) {
677 if ( $part_pkg_usage->rollover ) {
678 $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes);
680 $usage->set('minutes', $part_pkg_usage->minutes);
682 my $error = $usage->replace;
683 warn " error resetting usage minutes: $error\n" if $error;
685 my $error = $usage->insert;
686 warn " error resetting usage minutes: $error\n" if $error;
688 } #foreach $part_pkg_usage
691 # tells whether cust_bill_pkg_detail should return a single line for
693 # i think this is currently unused?
696 $self->option('output_format') =~ /^sum_/;
699 # and whether cust_bill should show a detail line for the service label
700 # (separate from usage details)
701 sub hide_svc_detail {
703 $self->option('output_format') =~ /^sum_/;