1 package FS::part_pkg::voip_cdr;
4 use base qw( FS::part_pkg::recur_Common );
5 use vars qw( $DEBUG %info );
9 use FS::Record qw(qsearchs qsearch);
15 use List::Util qw(first min);
20 tie my %cdr_svc_method, 'Tie::IxHash',
21 'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)',
22 'svc_pbx.title' => 'PBX name (svc_pbx.title)',
23 'svc_pbx.svcnum' => 'Freeside service # (svc_pbx.svcnum)',
26 tie my %rating_method, 'Tie::IxHash',
27 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
28 # '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.',
29 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
30 'single_price' => 'A single price per minute for all calls.',
33 #tie my %cdr_location, 'Tie::IxHash',
34 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
35 # 'external' => 'External: CDR records queried directly from an external '.
36 # 'Asterisk (or other?) CDR table',
39 tie my %temporalities, 'Tie::IxHash',
40 'upcoming' => "Upcoming (future)",
41 'preceding' => "Preceding (past)",
44 tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
46 # previously "1" was "ignore"
47 tie my %unrateable_opts, 'Tie::IxHash',
48 '' => 'Exit with a fatal error',
49 1 => 'Ignore and continue',
50 2 => 'Flag for later review',
54 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
55 'shortname' => 'VoIP/telco CDR rating (standard)',
56 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
58 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
61 #false laziness w/flat.pm
62 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
64 'select_options' => \%temporalities,
67 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
71 'recur_method' => { 'name' => 'Recurring fee method',
73 #'options' => \%recur_method,
75 'select_options' => \%FS::part_pkg::recur_Common::recur_method,
78 'cdr_svc_method' => { 'name' => 'CDR service matching method',
80 'options' => \%cdr_svc_method,
83 'rating_method' => { 'name' => 'Rating method',
85 'options' => \%rating_method,
88 'ratenum' => { 'name' => 'Rate plan',
90 'select_table' => 'rate',
91 'select_key' => 'ratenum',
92 'select_label' => 'ratename',
95 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
97 'select_table' => 'rate',
98 'select_key' => 'ratenum',
99 'select_label' => 'ratename',
100 'disable_empty' => 0,
104 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" rating method or when using the "prefix" rating method ("region group" billing)',
107 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
110 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method',
112 'select_options' => \%granularity,
115 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
117 'select_options' => \%unrateable_opts,
120 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
124 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
128 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
132 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
133 # 'type' => 'checkbox',
136 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
140 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
141 'type' => 'checkbox',
144 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
145 'type' => 'checkbox',
148 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to: ',
151 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to: ',
154 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ',
157 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
160 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
163 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ',
166 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ',
169 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
172 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:',
175 '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',
176 'type' => 'checkbox',
179 'accountcode_tollfree_ratenum' => {
180 'name' => 'Optional alternate rate plan when accountcode is toll free: ',
182 'select_table' => 'rate',
183 'select_key' => 'ratenum',
184 'select_label' => 'ratename',
185 'disable_empty' => 0,
189 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
192 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free',
193 'type' => 'checkbox',
196 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ',
199 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ',
202 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
203 'type' => 'checkbox',
206 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
209 #false laziness w/cdr_termination.pm
210 'output_format' => { 'name' => 'CDR invoice display format',
212 'select_options' => { FS::cdr::invoice_formats() },
213 'default' => 'default', #XXX test
216 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ',
219 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
220 'type' => 'checkbox',
223 'usage_mandate' => { 'name' => 'Always put usage details in separate section',
224 'type' => 'checkbox',
228 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
229 'type' => 'checkbox',
232 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
233 'type' => 'checkbox',
236 '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.',
237 'type' => 'checkbox',
240 #XXX also have option for an external db
241 # 'cdr_location' => { 'name' => 'CDR database location'
242 # 'type' => 'select',
243 # 'select_options' => \%cdr_location,
244 # 'select_callback' => {
246 # 'enable' => [ 'datasrc', 'username', 'password' ],
249 # 'disable' => [ 'datasrc', 'username', 'password' ],
253 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
256 # 'username' => { 'name' => 'External database username',
259 # 'password' => { 'name' => 'External database password',
266 recur_method cutoff_day ),
267 FS::part_pkg::prorate_Mixin::fieldorder,
270 rating_method ratenum intrastate_ratenum
271 min_charge min_included
276 domestic_prefix international_prefix
280 use_cdrtypenum ignore_cdrtypenum
281 ignore_disposition disposition_in
282 skip_dcontext skip_dst_prefix
283 skip_dstchannel_prefix skip_src_length_more
284 noskip_src_length_accountcode_tollfree
285 accountcode_tollfree_ratenum
287 noskip_dst_length_accountcode_tollfree
292 output_format usage_mandate summarize_usage usage_section
293 bill_every_call bill_inactive_svcs
294 count_available_phones suspend_bill
302 my $str = $self->SUPER::price_info;
303 $str .= " plus usage" if $str;
309 my($cust_pkg, $sdate, $details, $param ) = @_;
313 $charges += $self->calc_usage(@_);
314 $charges += $self->calc_recur_Common(@_);
322 my($cust_pkg, $sdate, $details, $param ) = @_;
324 $self->calc_usage(@_);
327 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
331 my($cust_pkg, $sdate, $details, $param ) = @_;
333 #my $last_bill = $cust_pkg->last_bill;
334 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
337 if $self->recur_temporality eq 'preceding'
338 && ( $last_bill eq '' || $last_bill == 0 );
340 my $ratenum = $cust_pkg->part_pkg->option('ratenum');
342 my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
344 my %included_min = ();
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 eval "use Text::CSV_XS;";
380 my $csv = new Text::CSV_XS;
382 my($svc_table, $svc_field) = split('\.', $cdr_svc_method);
385 if( $self->option('bill_inactive_svcs',1) ) {
386 #XXX in this mode do we need to restrict the set of CDRs by date also?
387 @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
390 @cust_svc = $cust_pkg->cust_svc;
392 @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
394 foreach my $cust_svc (@cust_svc) {
397 if( $self->option('bill_inactive_svcs',1) ) {
398 $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
401 $svc_x = $cust_svc->svc_x;
404 'disable_src' => $self->option('disable_src'),
405 'default_prefix' => $self->option('default_prefix'),
406 'cdrtypenum' => $self->option('use_cdrtypenum'),
409 ); # $last_bill, $$sdate )
410 $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum';
412 my @invoice_details_sort;
415 $svc_x->get_cdrs( %options )
418 warn "rating CDR $cdr\n".
419 join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
423 my( $rate_region, $regionnum );
434 my @call_details = ();
435 if ( $rating_method eq 'prefix' ) {
438 # this will result in those CDRs being marked as done... is that
440 if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
445 my $reason = $self->check_chargable( $cdr,
446 'da_rewrote' => $da_rewrote,
447 'option_cache' => \%opt_cache,
452 warn "not charging for CDR ($reason)\n" if $DEBUG;
454 # this will result in those CDRs being marked as done... is that
460 # look up rate details based on called station id
461 # (or calling station id for toll free calls)
465 if ( $cdr->is_tollfree && ! $disable_tollfree )
467 $to_or_from = 'from';
469 } else { #regular call
474 warn "parsing call $to_or_from $number\n" if $DEBUG;
476 #remove non-phone# stuff and whitespace
479 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
481 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
483 #determine the country code
485 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
486 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
490 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
491 #first look for 1 digit country code
492 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
494 $number = $u1.$u2.$rest;
495 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
498 } else { #3 digit country code
499 $countrycode = $three;
504 $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
505 $number =~ s/^$countrycode//;# if length($number) > 10;
508 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
509 $pretty_destnum = "+$countrycode $number";
510 #asterisks here causes inserting the detail to barf, so:
511 $pretty_destnum =~ s/\*//g;
513 my $eff_ratenum = $cdr->is_tollfree('accountcode')
514 ? $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum')
517 my $intrastate_ratenum = $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum');
518 if ( $intrastate_ratenum && !$cdr->is_tollfree ) {
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 $eff_ratenum = $intrastate_ratenum if ($srcprefix && $dstprefix
536 && $srcprefix->state && $dstprefix->state
537 && $srcprefix->state eq $dstprefix->state);
540 $eff_ratenum ||= $ratenum;
541 $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum })
542 or die "ratenum $eff_ratenum not found!";
544 my @ltime = localtime($cdr->startdate);
545 $weektime = $ltime[0] +
546 $ltime[1]*60 + #minutes
547 $ltime[2]*3600 + #hours
548 $ltime[6]*86400; #days since sunday
549 # if there's no timed rate_detail for this time/region combination,
550 # dest_detail returns the default. There may still be a timed rate
551 # that applies after the starttime of the call, so be careful...
552 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
553 'phonenum' => $number,
554 'weektime' => $weektime,
555 'cdrtypenum' => $cdr->cdrtypenum,
558 if ( $rate_detail ) {
560 $rate_region = $rate_detail->dest_region;
561 $regionnum = $rate_region->regionnum;
562 $regionname = $rate_region->regionname;
563 warn " found rate for regionnum $regionnum ".
564 "and rate detail $rate_detail\n"
567 if ( !exists($interval_cache{$regionnum}) ) {
569 sort { $a->stime <=> $b->stime }
570 map { my $r = $_->rate_time; $r ? $r->intervals : () }
573 $interval_cache{$regionnum} = \@intervals;
574 warn " cached ".scalar(@intervals)." interval(s)\n"
578 } elsif ( $ignore_unrateable ) {
582 #code below will throw a warning & skip
586 die "FATAL: no rate_detail found in ".
587 $rate->ratenum. ":". $rate->ratename. " rate plan ".
588 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
589 "add a rate or set ignore_unrateable flag on the package def\n";
594 } elsif ( $rating_method eq 'upstream_simple' ) {
596 #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
597 $charge = sprintf('%.3f', $cdr->upstream_price);
599 warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
601 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
605 $classnum = $cdr->calltypenum;
607 } elsif ( $rating_method eq 'single_price' ) {
609 # a little false laziness w/below
610 # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
612 my $granularity = length($self->option('sec_granularity'))
613 ? $self->option('sec_granularity')
616 $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
618 $seconds += $granularity - ( $seconds % $granularity )
619 if $seconds # don't granular-ize 0 billsec calls (bills them)
620 && $granularity # 0 is per call
621 && $seconds % $granularity;
622 my $minutes = $granularity ? ($seconds / 60) : 1;
623 $charge = sprintf('%.4f', ( $self->option('min_charge') * $minutes )
624 + 0.0000000001 ); #so 1.00005 rounds to 1.0001
626 warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
629 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
631 'seconds' => ($use_duration ?
634 'granularity' => $granularity,
639 die "don't know how to rate CDRs using method: $rating_method\n";
643 # find the price and add detail to the invoice
646 # if $rate_detail is not found, skip this CDR... i.e.
647 # don't add it to invoice, don't set its status to done,
648 # don't call downstream_csv or something on it...
649 # but DO emit a warning...
650 #if ( ! $rate_detail && ! scalar(@call_details) ) {}
651 if ( ! $rate_detail && $charge eq '' ) {
653 if ( $ignore_unrateable == 2 ) {
654 # mark the CDR as unrateable
655 my $error = $cdr->set_status_and_rated_price(
660 die $error if $error;
662 elsif ( $ignore_unrateable == 1 ) {
664 warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
666 } #if $ignore_unrateable
668 } else { # there *is* a rate_detail (or call_details), proceed...
669 # About this section:
670 # We don't round _anything_ (except granularizing)
671 # until the final $charge = sprintf("%.2f"...).
673 unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
675 my $seconds_left = $use_duration ? $cdr->duration : $cdr->billsec;
676 # charge for the first (conn_sec) seconds
677 $seconds = min($seconds_left, $rate_detail->conn_sec);
678 $seconds_left -= $seconds;
679 $weektime += $seconds;
680 $charge = $rate_detail->conn_charge;
683 while($seconds_left) {
684 my $ratetimenum = $rate_detail->ratetimenum; # may be empty
686 # find the end of the current rate interval
687 if(@{ $interval_cache{$regionnum} } == 0) {
688 # There are no timed rates in this group, so just stay
689 # in the default rate_detail for the entire duration.
690 # Set an "end" of 1 past the end of the current call.
691 $etime = $weektime + $seconds_left + 1;
693 elsif($ratetimenum) {
694 # This is a timed rate, so go to the etime of this interval.
695 # If it's followed by another timed rate, the stime of that
696 # interval should match the etime of this one.
697 my $interval = $rate_detail->rate_time->contains($weektime);
698 $etime = $interval->etime;
701 # This is a default rate, so use the stime of the next
702 # interval in the sequence.
703 my $next_int = first { $_->stime > $weektime }
704 @{ $interval_cache{$regionnum} };
706 $etime = $next_int->stime;
709 # weektime is near the end of the week, so decrement
710 # it by a full week and use the stime of the first
712 $weektime -= (3600*24*7);
713 $etime = $interval_cache{$regionnum}->[0]->stime;
717 my $charge_sec = min($seconds_left, $etime - $weektime);
719 $seconds_left -= $charge_sec;
721 $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included
722 unless exists $included_min{$regionnum}{$ratetimenum};
724 my $granularity = $rate_detail->sec_granularity;
727 if ( $granularity ) { # charge per minute
728 # Round up to the nearest $granularity
729 if ( $charge_sec and $charge_sec % $granularity ) {
730 $charge_sec += $granularity - ($charge_sec % $granularity);
732 $minutes = $charge_sec / 60; #don't round this
739 $seconds += $charge_sec;
741 $region_group_included_min -= $minutes
742 if $region_group && $rate_detail->region_group;
744 $included_min{$regionnum}{$ratetimenum} -= $minutes;
745 if ( ($region_group_included_min <= 0 || !$rate_detail->region_group)
746 && $included_min{$regionnum}{$ratetimenum} <= 0 ) {
747 my $charge_min = 0 - $included_min{$regionnum}{$ratetimenum}; #XXX should preserve
749 $included_min{$regionnum}{$ratetimenum} = 0;
750 $charge += ($rate_detail->min_charge * $charge_min); #still not rounded
752 elsif( $region_group_included_min > 0 && $region_group
753 && $rate_detail->region_group ) {
754 $included_min{$regionnum}{$ratetimenum} = 0
757 # choose next rate_detail
758 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
759 'phonenum' => $number,
760 'weektime' => $etime,
761 'cdrtypenum' => $cdr->cdrtypenum })
763 # we have now moved forward to $etime
766 } #while $seconds_left
767 # this is why we need regionnum/rate_region....
768 warn " (rate region $rate_region)\n" if $DEBUG;
770 $classnum = $rate_detail->classnum;
771 $charge = sprintf('%.2f', $charge + 0.000001); # NOW round it.
772 warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
775 if ( !$self->sum_usage ) {
777 $cdr->downstream_csv( 'format' => $output_format,
778 'granularity' => $rate_detail->sec_granularity,
779 'seconds' => ($use_duration ?
783 'pretty_dst' => $pretty_destnum,
784 'dst_regionname' => $regionname,
788 } #if(there is a rate_detail)
791 #if ( $charge > 0 ) {
792 # generate a detail record for every call; filter out $charge = 0
795 my $phonenum = $svc_x->phonenum;
797 if ( scalar(@call_details) == 1 ) {
800 detail => $call_details[0],
802 classnum => $classnum,
803 phonenum => $phonenum,
804 accountcode => $cdr->accountcode,
805 startdate => $cdr->startdate,
806 duration => $seconds,
807 regionname => $regionname,
809 } else { #only used for $rating_method eq 'upstream' now
810 # and for sum_ formats
811 $csv->combine(@call_details);
814 detail => $csv->string,
816 classnum => $classnum,
817 phonenum => $phonenum,
818 accountcode => $cdr->accountcode,
819 startdate => $cdr->startdate,
820 duration => $seconds,
821 regionname => $regionname,
824 push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ];
827 # if the customer flag is on, call "downstream_csv" or something
828 # like it to export the call downstream!
829 # XXX price plan option to pick format, or something...
830 #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
833 my $error = $cdr->set_status_and_rated_price( 'done',
837 die $error if $error;
843 if ( !$self->sum_usage ) {
845 my @sorted_invoice_details =
846 sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort;
847 foreach my $sorted_call_detail ( @sorted_invoice_details ) {
848 my $d = $sorted_call_detail->[0];
849 push @$details, $d if $d->{amount} > 0;
852 else { #$self->sum_usage
853 push @$details, $self->sum_detail($svc_x, \@invoice_details_sort);
857 unshift @$details, { format => 'C',
858 detail => FS::cdr::invoice_header($output_format),
860 if @$details && $rating_method ne 'upstream';
865 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
866 sub check_chargable {
867 my( $self, $cdr, %flags ) = @_;
869 #should have some better way of checking these options from a hash
881 skip_dstchannel_prefix
882 skip_src_length_more noskip_src_length_accountcode_tollfree
883 skip_dst_length_less noskip_dst_length_accountcode_tollfree
887 foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
888 $flags{option_cache}->{$opt} = $self->option($opt, 1);
890 my %opt = %{ $flags{option_cache} };
892 return 'amaflags != 2'
893 if $opt{'use_amaflags'} && $cdr->amaflags != 2;
895 return "disposition NOT IN ( $opt{'disposition_in'} )"
896 if $opt{'disposition_in'} =~ /\S/
897 && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'disposition_in'});
899 return "disposition IN ( $opt{'ignore_disposition'} )"
900 if $opt{'ignore_disposition'} =~ /\S/
901 && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'ignore_disposition'});
903 foreach(split(/\s*,\s*/, $opt{'skip_dst_prefix'})) {
904 return "dst starts with '$_'"
905 if length($_) && substr($cdr->dst,0,length($_)) eq $_;
908 return "carrierid != $opt{'use_carrierid'}"
909 if length($opt{'use_carrierid'})
910 && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
911 && ! $flags{'da_rewrote'};
913 # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
914 return "cdrtypenum != $opt{'use_cdrtypenum'}"
915 if length($opt{'use_cdrtypenum'})
916 && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
918 return "cdrtypenum == $opt{'ignore_cdrtypenum'}"
919 if length($opt{'ignore_cdrtypenum'})
920 && $cdr->cdrtypenum eq $opt{'ignore_cdrtypenum'}; #eq otherwise 0 matches ''
922 return "dcontext IN ( $opt{'skip_dcontext'} )"
923 if $opt{'skip_dcontext'} =~ /\S/
924 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
926 my $len_prefix = length($opt{'skip_dstchannel_prefix'});
927 return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
929 && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
931 my $dst_length = $opt{'skip_dst_length_less'};
932 return "destination less than $dst_length digits"
933 if $dst_length && length($cdr->dst) < $dst_length
934 && ! ( $opt{'noskip_dst_length_accountcode_tollfree'}
935 && $cdr->is_tollfree('accountcode')
938 return "lastapp is $opt{'skip_lastapp'}"
939 if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
941 my $src_length = $opt{'skip_src_length_more'};
944 if ( $opt{'noskip_src_length_accountcode_tollfree'} ) {
946 if ( $cdr->is_tollfree('accountcode') ) {
947 return "source less than or equal to $src_length digits"
948 if length($cdr->src) <= $src_length;
950 return "source more than $src_length digits"
951 if length($cdr->src) > $src_length;
955 return "source more than $src_length digits"
956 if length($cdr->src) > $src_length;
961 return "max_callers <= $opt{skip_max_callers}"
962 if length($opt{'skip_max_callers'})
963 and length($cdr->max_callers)
964 and $cdr->max_callers <= $opt{'skip_max_callers'};
966 #all right then, rate it
974 # This equates svc_phone records; perhaps svc_phone should have a field
975 # to indicate it represents a line
977 my($self, $cust_pkg ) = @_;
979 if ( $self->option('count_available_phones', 1)) {
980 map { $count += ( $_->quantity || 0 ) }
981 grep { $_->part_svc->svcdb eq 'svc_phone' }
982 $cust_pkg->part_pkg->pkg_svc;
985 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
990 # tells whether cust_bill_pkg_detail should return a single line for
994 $self->option('output_format') =~ /^sum_/;
1000 my $invoice_details = shift || [];
1001 my $count = scalar(@$invoice_details);
1002 return () if !$count;
1006 classnum => '', #XXX
1008 phonenum => $svc_x->phonenum,
1009 accountcode => '', #XXX
1010 startdate => '', #XXX
1013 # combine the entire set of CDRs
1014 foreach ( @$invoice_details ) {
1015 $sum_detail->{amount} += $_->[0]{amount};
1016 $sum_detail->{duration} += $_->[0]{duration};
1018 my $total_cdr = FS::cdr->new({
1019 'billsec' => $sum_detail->{duration},
1020 'src' => $sum_detail->{phonenum},
1022 $sum_detail->{detail} = $total_cdr->downstream_csv(
1023 format => $self->option('output_format'),
1024 seconds => $sum_detail->{duration},
1025 charge => sprintf('%.2f',$sum_detail->{amount}),
1026 phonenum => $sum_detail->{phonenum},
1032 # and whether cust_bill should show a detail line for the service label
1033 # (separate from usage details)
1034 sub hide_svc_detail {
1036 $self->option('output_format') =~ /^sum_/;