1 package FS::part_pkg::voip_cdr;
2 use base qw( FS::part_pkg::recur_Common );
5 use vars qw( $DEBUG %info );
6 use List::Util qw(first min);
11 use FS::Record qw(qsearchs qsearch);
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)',
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 %cdr_location, 'Tie::IxHash',
33 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
34 # 'external' => 'External: CDR records queried directly from an external '.
35 # 'Asterisk (or other?) CDR table',
38 tie my %temporalities, 'Tie::IxHash',
39 'upcoming' => "Upcoming (future)",
40 'preceding' => "Preceding (past)",
43 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
45 # previously "1" was "ignore"
46 tie my %unrateable_opts, 'Tie::IxHash',
47 '' => 'Exit with a fatal error',
48 1 => 'Ignore and continue',
49 2 => 'Flag for later review',
53 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
54 'shortname' => 'VoIP/telco CDR rating (standard)',
55 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
57 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
60 #false laziness w/flat.pm
61 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
63 'select_options' => \%temporalities,
66 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
70 'recur_method' => { 'name' => 'Recurring fee method',
72 #'options' => \%recur_method,
74 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
77 'cdr_svc_method' => { 'name' => 'CDR service matching method',
79 'options' => \%cdr_svc_method,
82 'rating_method' => { 'name' => 'Rating method',
84 'options' => \%rating_method,
87 'ratenum' => { 'name' => 'Rate plan',
89 'select_table' => 'rate',
90 'select_key' => 'ratenum',
91 'select_label' => 'ratename',
94 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
96 'select_table' => 'rate',
97 'select_key' => 'ratenum',
98 'select_label' => 'ratename',
103 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" rating method or when using the "prefix" rating method ("region group" billing)',
106 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
109 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
111 'select_options' => \%granularity,
114 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
116 'select_options' => \%unrateable_opts,
119 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
123 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
127 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
131 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
132 # 'type' => 'checkbox',
135 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
139 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
140 'type' => 'checkbox',
143 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
144 'type' => 'checkbox',
147 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to: ',
150 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to: ',
153 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ',
156 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
159 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
162 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
165 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
168 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
171 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
174 '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',
175 'type' => 'checkbox',
178 'accountcode_tollfree_ratenum' => {
179 'name' => 'Optional alternate rate plan when accountcode is toll free: ',
181 'select_table' => 'rate',
182 'select_key' => 'ratenum',
183 'select_label' => 'ratename',
184 'disable_empty' => 0,
188 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
191 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
192 'type' => 'checkbox',
195 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
198 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
201 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
202 'type' => 'checkbox',
205 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
208 #false laziness w/cdr_termination.pm
209 'output_format' => { 'name' => 'CDR invoice display format',
211 'select_options' => { FS::cdr::invoice_formats() },
212 'default' => 'default', #XXX test
215 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
218 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
219 'type' => 'checkbox',
222 'usage_mandate' => { 'name' => 'Always put usage details in separate section',
223 'type' => 'checkbox',
227 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
228 'type' => 'checkbox',
231 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
232 'type' => 'checkbox',
235 '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.',
236 'type' => 'checkbox',
239 #XXX also have option for an external db
240 # 'cdr_location' => { 'name' => 'CDR database location'
241 # 'type' => 'select',
242 # 'select_options' => \%cdr_location,
243 # 'select_callback' => {
245 # 'enable' => [ 'datasrc', 'username', 'password' ],
248 # 'disable' => [ 'datasrc', 'username', 'password' ],
252 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
255 # 'username' => { 'name' => 'External database username',
258 # 'password' => { 'name' => 'External database password',
265 recur_method cutoff_day ),
266 FS::part_pkg::prorate_Mixin::fieldorder,
269 rating_method ratenum intrastate_ratenum
270 min_charge min_included sec_granularity
274 domestic_prefix international_prefix
278 use_cdrtypenum ignore_cdrtypenum
279 ignore_disposition disposition_in
280 skip_dcontext skip_dst_prefix
281 skip_dstchannel_prefix skip_src_length_more
282 noskip_src_length_accountcode_tollfree
283 accountcode_tollfree_ratenum
285 noskip_dst_length_accountcode_tollfree
290 output_format usage_mandate summarize_usage usage_section
291 bill_every_call bill_inactive_svcs
292 count_available_phones suspend_bill
300 my $str = $self->SUPER::price_info;
301 $str .= " plus usage" if $str;
307 my($cust_pkg, $sdate, $details, $param ) = @_;
311 $charges += $self->calc_usage(@_);
312 $charges += $self->calc_recur_Common(@_);
320 my($cust_pkg, $sdate, $details, $param ) = @_;
322 $self->calc_usage(@_);
325 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
329 my($cust_pkg, $sdate, $details, $param ) = @_;
331 #my $last_bill = $cust_pkg->last_bill;
332 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
335 if $self->recur_temporality eq 'preceding'
336 && ( $last_bill eq '' || $last_bill == 0 );
338 my $ratenum = $cust_pkg->part_pkg->option('ratenum');
340 my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
342 my %included_min = (); #region groups w/prefix rating
344 my $included_min = $self->option('min_included', 1) || 0; #single price rating
348 # my $downstream_cdr = '';
350 my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum';
351 my $rating_method = $self->option('rating_method') || 'prefix';
352 my $intl = $self->option('international_prefix') || '011';
353 my $domestic_prefix = $self->option('domestic_prefix');
354 my $disable_tollfree = $self->option('disable_tollfree');
355 my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
356 my $use_duration = $self->option('use_duration');
357 my $region_group = ($rating_method eq 'prefix' && ($self->option('min_included',1) || 0) > 0);
358 my $region_group_included_min = $region_group ? $self->option('min_included') : 0;
360 my $output_format = $self->option('output_format', 'Hush!')
361 || ( $rating_method eq 'upstream_simple'
367 if ( $self->option('411_rewrite') ) {
368 my $dirass = $self->option('411_rewrite');
370 @dirass = split(',', $dirass);
373 my %interval_cache = (); # for timed rates
375 #for check_chargable, so we don't keep looking up options inside the loop
378 my $csv = new Text::CSV_XS;
380 my($svc_table, $svc_field) = split('\.', $cdr_svc_method);
383 if( $self->option('bill_inactive_svcs',1) ) {
384 #XXX in this mode do we need to restrict the set of CDRs by date also?
385 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
388 @cust_svc = $cust_pkg->cust_svc;
390 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
392 foreach my $cust_svc (@cust_svc) {
395 if( $self->option('bill_inactive_svcs',1) ) {
396 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
399 $svc_x = $cust_svc->svc_x;
402 'disable_src' => $self->option('disable_src'),
403 'default_prefix' => $self->option('default_prefix'),
404 'cdrtypenum' => $self->option('use_cdrtypenum'),
407 ); # $last_bill, $$sdate )
408 $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum';
410 my @invoice_details_sort;
413 $svc_x->get_cdrs( %options )
416 warn "rating CDR $cdr\n".
417 join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
421 my( $rate_region, $regionnum );
433 my @call_details = ();
434 if ( $rating_method eq 'prefix' ) {
437 # this will result in those CDRs being marked as done... is that
439 if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
444 my $reason = $self->check_chargable( $cdr,
445 'da_rewrote' => $da_rewrote,
446 'option_cache' => \%opt_cache,
451 warn "not charging for CDR ($reason)\n" if $DEBUG;
453 # this will result in those CDRs being marked as done... is that
459 # look up rate details based on called station id
460 # (or calling station id for toll free calls)
464 if ( $cdr->is_tollfree && ! $disable_tollfree )
466 $to_or_from = 'from';
468 } else { #regular call
473 warn "parsing call $to_or_from $number\n" if $DEBUG;
475 #remove non-phone# stuff and whitespace
478 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
480 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
482 #determine the country code
484 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
485 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
489 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
490 #first look for 1 digit country code
491 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
493 $number = $u1.$u2.$rest;
494 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
497 } else { #3 digit country code
498 $countrycode = $three;
503 $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
504 $number =~ s/^$countrycode//;# if length($number) > 10;
507 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
508 $pretty_destnum = "+$countrycode $number";
509 #asterisks here causes inserting the detail to barf, so:
510 $pretty_destnum =~ s/\*//g;
512 my $eff_ratenum = $cdr->is_tollfree('accountcode')
513 ? $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum')
516 my $intrastate_ratenum = $cust_pkg->part_pkg->option('intrastate_ratenum');
517 if ( $intrastate_ratenum && !$cdr->is_tollfree ) {
518 $ratename = 'Interstate'; #until proven otherwise
519 # this is relatively easy only because:
520 # -assume all numbers are valid NANP numbers NOT in a fully-qualified format
521 # -disregard toll-free
522 # -disregard private or unknown numbers
523 # -there is exactly one record in rate_prefix for a given NPANXX
524 # -default to interstate if we can't find one or both of the prefixes
525 my $dstprefix = $cdr->dst;
526 $dstprefix =~ /^(\d{6})/;
527 $dstprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
530 my $srcprefix = $cdr->src;
531 $srcprefix =~ /^(\d{6})/;
532 $srcprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
535 if ($srcprefix && $dstprefix
536 && $srcprefix->state && $dstprefix->state
537 && $srcprefix->state eq $dstprefix->state) {
538 $eff_ratenum = $intrastate_ratenum;
539 $ratename = 'Intrastate'; # XXX possibly just use the ratename?
543 $eff_ratenum ||= $ratenum;
544 $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
545 or die "ratenum $eff_ratenum not found!";
547 my @ltime = localtime($cdr->startdate);
548 $weektime = $ltime[0] +
549 $ltime[1]*60 + #minutes
550 $ltime[2]*3600 + #hours
551 $ltime[6]*86400; #days since sunday
552 # if there's no timed rate_detail for this time/region combination,
553 # dest_detail returns the default. There may still be a timed rate
554 # that applies after the starttime of the call, so be careful...
555 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
556 'phonenum' => $number,
557 'weektime' => $weektime,
558 'cdrtypenum' => $cdr->cdrtypenum,
561 if ( $rate_detail ) {
563 $rate_region = $rate_detail->dest_region;
564 $regionnum = $rate_region->regionnum;
565 $regionname = $rate_region->regionname;
566 warn " found rate for regionnum $regionnum ".
567 "and rate detail $rate_detail\n"
570 if ( !exists($interval_cache{$regionnum}) ) {
572 sort { $a->stime <=> $b->stime }
573 map { my $r = $_->rate_time; $r ? $r->intervals : () }
576 $interval_cache{$regionnum} = \@intervals;
577 warn " cached ".scalar(@intervals)." interval(s)\n"
581 } elsif ( $ignore_unrateable ) {
585 #code below will throw a warning & skip
589 die "FATAL: no rate_detail found in ".
590 $rate->ratenum. ":". $rate->ratename. " rate plan ".
591 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
592 "add a rate or set ignore_unrateable flag on the package def\n";
597 } elsif ( $rating_method eq 'upstream_simple' ) {
599 #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
600 $charge = sprintf('%.3f', $cdr->upstream_price);
602 warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
604 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
608 $classnum = $cdr->calltypenum;
610 } elsif ( $rating_method eq 'single_price' ) {
612 # a little false laziness w/below
613 # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
615 my $granularity = length($self->option('sec_granularity'))
616 ? $self->option('sec_granularity')
619 $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
621 $seconds += $granularity - ( $seconds % $granularity )
622 if $seconds # don't granular-ize 0 billsec calls (bills them)
623 && $granularity # 0 is per call
624 && $seconds % $granularity;
625 my $minutes = $granularity ? ($seconds / 60) : 1;
627 my $charge_min = $minutes;
629 $included_min -= $minutes;
630 if ( $included_min > 0 ) {
633 $charge_min = 0 - $included_min;
637 $charge = sprintf('%.4f', ( $self->option('min_charge') * $charge_min )
638 + 0.0000000001 ); #so 1.00005 rounds to 1.0001
640 warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
643 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
645 'seconds' => ($use_duration ?
648 'granularity' => $granularity,
653 die "don't know how to rate CDRs using method: $rating_method\n";
657 # find the price and add detail to the invoice
660 # if $rate_detail is not found, skip this CDR... i.e.
661 # don't add it to invoice, don't set its status to done,
662 # don't call downstream_csv or something on it...
663 # but DO emit a warning...
664 #if ( ! $rate_detail && ! scalar(@call_details) ) {}
665 if ( ! $rate_detail && $charge eq '' ) {
667 if ( $ignore_unrateable == 2 ) {
668 # mark the CDR as unrateable
669 my $error = $cdr->set_status_and_rated_price(
674 die $error if $error;
676 elsif ( $ignore_unrateable == 1 ) {
678 warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
680 } #if $ignore_unrateable
682 } else { # there *is* a rate_detail (or call_details), proceed...
683 # About this section:
684 # We don't round _anything_ (except granularizing)
685 # until the final $charge = sprintf("%.2f"...).
687 unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
689 my $seconds_left = $use_duration ? $cdr->duration : $cdr->billsec;
690 # charge for the first (conn_sec) seconds
691 $seconds = min($seconds_left, $rate_detail->conn_sec);
692 $seconds_left -= $seconds;
693 $weektime += $seconds;
694 $charge = $rate_detail->conn_charge;
697 while($seconds_left) {
698 my $ratetimenum = $rate_detail->ratetimenum; # may be empty
700 # find the end of the current rate interval
701 if(@{ $interval_cache{$regionnum} } == 0) {
702 # There are no timed rates in this group, so just stay
703 # in the default rate_detail for the entire duration.
704 # Set an "end" of 1 past the end of the current call.
705 $etime = $weektime + $seconds_left + 1;
707 elsif($ratetimenum) {
708 # This is a timed rate, so go to the etime of this interval.
709 # If it's followed by another timed rate, the stime of that
710 # interval should match the etime of this one.
711 my $interval = $rate_detail->rate_time->contains($weektime);
712 $etime = $interval->etime;
715 # This is a default rate, so use the stime of the next
716 # interval in the sequence.
717 my $next_int = first { $_->stime > $weektime }
718 @{ $interval_cache{$regionnum} };
720 $etime = $next_int->stime;
723 # weektime is near the end of the week, so decrement
724 # it by a full week and use the stime of the first
726 $weektime -= (3600*24*7);
727 $etime = $interval_cache{$regionnum}->[0]->stime;
731 my $charge_sec = min($seconds_left, $etime - $weektime);
733 $seconds_left -= $charge_sec;
735 $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included
736 unless exists $included_min{$regionnum}{$ratetimenum};
738 my $granularity = $rate_detail->sec_granularity;
741 if ( $granularity ) { # charge per minute
742 # Round up to the nearest $granularity
743 if ( $charge_sec and $charge_sec % $granularity ) {
744 $charge_sec += $granularity - ($charge_sec % $granularity);
746 $minutes = $charge_sec / 60; #don't round this
753 $seconds += $charge_sec;
755 $region_group_included_min -= $minutes
756 if $region_group && $rate_detail->region_group;
758 $included_min{$regionnum}{$ratetimenum} -= $minutes;
759 if ( ($region_group_included_min <= 0 || !$rate_detail->region_group)
760 && $included_min{$regionnum}{$ratetimenum} <= 0 ) {
761 my $charge_min = 0 - $included_min{$regionnum}{$ratetimenum}; #XXX should preserve
763 $included_min{$regionnum}{$ratetimenum} = 0;
764 $charge += ($rate_detail->min_charge * $charge_min); #still not rounded
766 elsif( $region_group_included_min > 0 && $region_group
767 && $rate_detail->region_group ) {
768 $included_min{$regionnum}{$ratetimenum} = 0
771 # choose next rate_detail
772 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
773 'phonenum' => $number,
774 'weektime' => $etime,
775 'cdrtypenum' => $cdr->cdrtypenum })
777 # we have now moved forward to $etime
780 } #while $seconds_left
781 # this is why we need regionnum/rate_region....
782 warn " (rate region $rate_region)\n" if $DEBUG;
784 $classnum = $rate_detail->classnum;
785 $charge = sprintf('%.2f', $charge + 0.000001); # NOW round it.
786 warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
789 if ( !$self->sum_usage ) {
791 $cdr->downstream_csv( 'format' => $output_format,
792 'granularity' => $rate_detail->sec_granularity,
793 'seconds' => ($use_duration ?
797 'pretty_dst' => $pretty_destnum,
798 'dst_regionname' => $regionname,
802 } #if(there is a rate_detail)
804 #if ( $charge > 0 ) {
805 # generate a detail record for every call; filter out $charge = 0
808 my $phonenum = $svc_x->phonenum;
810 if ( scalar(@call_details) == 1 ) {
813 detail => $call_details[0],
815 classnum => $classnum,
816 phonenum => $phonenum,
817 accountcode => $cdr->accountcode,
818 startdate => $cdr->startdate,
819 duration => $seconds,
820 regionname => $regionname,
822 } else { #only used for $rating_method eq 'upstream' now
823 # and for sum_ formats
824 $csv->combine(@call_details);
827 detail => $csv->string,
829 classnum => $classnum,
830 phonenum => $phonenum,
831 accountcode => $cdr->accountcode,
832 startdate => $cdr->startdate,
833 duration => $seconds,
834 regionname => $regionname,
837 $call_details->{'ratename'} = $ratename;
839 push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ];
842 # if the customer flag is on, call "downstream_csv" or something
843 # like it to export the call downstream!
844 # XXX price plan option to pick format, or something...
845 #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
848 my $error = $cdr->set_status_and_rated_price( 'done',
852 die $error if $error;
858 if ( !$self->sum_usage ) {
860 my @sorted_invoice_details =
861 sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort;
862 foreach my $sorted_call_detail ( @sorted_invoice_details ) {
863 my $d = $sorted_call_detail->[0];
864 push @$details, $d if $d->{amount} > 0;
867 else { #$self->sum_usage
868 push @$details, $self->sum_detail($svc_x, \@invoice_details_sort);
872 unshift @$details, { format => 'C',
873 detail => FS::cdr::invoice_header($output_format),
875 if @$details && $rating_method ne 'upstream';
880 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
881 sub check_chargable {
882 my( $self, $cdr, %flags ) = @_;
884 #should have some better way of checking these options from a hash
896 skip_dstchannel_prefix
897 skip_src_length_more noskip_src_length_accountcode_tollfree
898 skip_dst_length_less noskip_dst_length_accountcode_tollfree
902 foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
903 $flags{option_cache}->{$opt} = $self->option($opt, 1);
905 my %opt = %{ $flags{option_cache} };
907 return 'amaflags != 2'
908 if $opt{'use_amaflags'} && $cdr->amaflags != 2;
910 return "disposition NOT IN ( $opt{'disposition_in'} )"
911 if $opt{'disposition_in'} =~ /\S/
912 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'disposition_in'});
914 return "disposition IN ( $opt{'ignore_disposition'} )"
915 if $opt{'ignore_disposition'} =~ /\S/
916 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'ignore_disposition'});
918 foreach(split(/\s*,\s*/, $opt{'skip_dst_prefix'})) {
919 return "dst starts with '$_'"
920 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
923 return "carrierid != $opt{'use_carrierid'}"
924 if length($opt{'use_carrierid'})
925 && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
926 && ! $flags{'da_rewrote'};
928 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
929 return "cdrtypenum != $opt{'use_cdrtypenum'}"
930 if length($opt{'use_cdrtypenum'})
931 && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
933 return "cdrtypenum == $opt{'ignore_cdrtypenum'}"
934 if length($opt{'ignore_cdrtypenum'})
935 && $cdr->cdrtypenum eq $opt{'ignore_cdrtypenum'}; #eq otherwise 0 matches ''
937 return "dcontext IN ( $opt{'skip_dcontext'} )"
938 if $opt{'skip_dcontext'} =~ /\S/
939 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
941 my $len_prefix = length($opt{'skip_dstchannel_prefix'});
942 return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
944 && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
946 my $dst_length = $opt{'skip_dst_length_less'};
947 return "destination less than $dst_length digits"
948 if $dst_length && length($cdr->dst) < $dst_length
949 && ! ( $opt{'noskip_dst_length_accountcode_tollfree'}
950 && $cdr->is_tollfree('accountcode')
953 return "lastapp is $opt{'skip_lastapp'}"
954 if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
956 my $src_length = $opt{'skip_src_length_more'};
959 if ( $opt{'noskip_src_length_accountcode_tollfree'} ) {
961 if ( $cdr->is_tollfree('accountcode') ) {
962 return "source less than or equal to $src_length digits"
963 if length($cdr->src) <= $src_length;
965 return "source more than $src_length digits"
966 if length($cdr->src) > $src_length;
970 return "source more than $src_length digits"
971 if length($cdr->src) > $src_length;
976 return "max_callers <= $opt{skip_max_callers}"
977 if length($opt{'skip_max_callers'})
978 and length($cdr->max_callers)
979 and $cdr->max_callers <= $opt{'skip_max_callers'};
981 #all right then, rate it
989 # This equates svc_phone records; perhaps svc_phone should have a field
990 # to indicate it represents a line
992 my($self, $cust_pkg ) = @_;
994 if ( $self->option('count_available_phones', 1)) {
995 map { $count += ( $_->quantity || 0 ) }
996 grep { $_->part_svc->svcdb eq 'svc_phone' }
997 $cust_pkg->part_pkg->pkg_svc;
1000 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
1005 # tells whether cust_bill_pkg_detail should return a single line for
1009 $self->option('output_format') =~ /^sum_/;
1015 my $invoice_details = shift || [];
1016 return () if !@$invoice_details;
1017 my $details_by_rate = {};
1018 # combine the entire set of CDRs
1019 foreach ( @$invoice_details ) {
1021 my $sum = $details_by_rate->{ $d->{ratename} } ||= {
1024 classnum => '', #XXX
1026 phonenum => $svc_x->phonenum,
1027 accountcode => '', #XXX
1028 startdate => '', #XXX
1032 $sum->{amount} += $d->{amount};
1033 $sum->{duration} += $d->{duration};
1037 foreach my $ratename ( sort keys(%$details_by_rate) ) {
1038 my $sum = $details_by_rate->{$ratename};
1039 next if $sum->{count} == 0;
1040 my $total_cdr = FS::cdr->new({
1041 'billsec' => $sum->{duration},
1042 'src' => $sum->{phonenum},
1044 $sum->{detail} = $total_cdr->downstream_csv(
1045 format => $self->option('output_format'),
1046 seconds => $sum->{duration},
1047 charge => sprintf('%.2f',$sum->{amount}),
1048 ratename => $ratename,
1049 phonenum => $sum->{phonenum},
1050 count => $sum->{count},
1052 push @details, $sum;
1057 # and whether cust_bill should show a detail line for the service label
1058 # (separate from usage details)
1059 sub hide_svc_detail {
1061 $self->option('output_format') =~ /^sum_/;