X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fvoip_cdr.pm;h=005009ae2dc7ff5033906987efabfb10dca33f2b;hp=47102c1aff9c43553c4b675ed7a300d027d5044b;hb=74a3083375ccc3a0dc8b74f9b39392989d088656;hpb=62bfeae993beb7f98d50d319360f1fece128982b diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm index 47102c1af..005009ae2 100644 --- a/FS/FS/part_pkg/voip_cdr.pm +++ b/FS/FS/part_pkg/voip_cdr.pm @@ -13,9 +13,16 @@ use FS::rate_prefix; use FS::rate_detail; use FS::part_pkg::recur_Common; +use List::Util qw(first min); + @ISA = qw(FS::part_pkg::recur_Common); -$DEBUG = 1; +$DEBUG = 0; + +tie my %cdr_svc_method, 'Tie::IxHash', + 'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)', + 'svc_pbx.title' => 'PBX name (svc_pbx.title)', +; tie my %rating_method, 'Tie::IxHash', 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables', @@ -71,6 +78,11 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'select_options' => \%FS::part_pkg::recur_Common::recur_method, }, + 'cdr_svc_method' => { 'name' => 'CDR service matching method', + 'type' => 'radio', + 'options' => \%cdr_svc_method, + }, + 'rating_method' => { 'name' => 'Rating method', 'type' => 'radio', 'options' => \%rating_method, @@ -83,6 +95,10 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'select_label' => 'ratename', }, + 'min_included' => { 'name' => 'Minutes included when using "single price per minute" rating method', + }, + + 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method', }, @@ -137,18 +153,45 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ', }, - 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:', + 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ', + }, + + 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ', }, 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:', }, + 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:', + }, + + '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', + 'type' => 'checkbox', + }, + + 'accountcode_tollfree_ratenum' => { + 'name' => 'Optional alternate rate plan when accountcode is toll free: ', + 'type' => 'select', + 'select_table' => 'rate', + 'select_key' => 'ratenum', + 'select_label' => 'ratename', + 'disable_empty' => 0, + 'empty_label' => '', + }, + 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:', }, - 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value', + 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free', + 'type' => 'checkbox', + }, + + 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ', }, + 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ', + }, + 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field', 'type' => 'checkbox', }, @@ -163,7 +206,7 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'default' => 'default', #XXX test }, - 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not)', + 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ', }, 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section', @@ -210,6 +253,7 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'fieldorder' => [qw( setup_fee recur_fee recur_temporality unused_credit recur_method cutoff_day + cdr_svc_method rating_method ratenum min_charge sec_granularity ignore_unrateable default_prefix @@ -218,8 +262,14 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); disable_tollfree use_amaflags use_disposition use_disposition_taqua use_carrierid use_cdrtypenum - skip_dcontext skip_dstchannel_prefix - skip_dst_length_less skip_lastapp + skip_dcontext skip_dst_prefix + skip_dstchannel_prefix skip_src_length_more + noskip_src_length_accountcode_tollfree + accountcode_tollfree_ratenum + skip_dst_length_less + noskip_dst_length_accountcode_tollfree + skip_lastapp + skip_max_callers use_duration 411_rewrite output_format usage_mandate summarize_usage usage_section @@ -278,6 +328,7 @@ sub calc_usage { # my $downstream_cdr = ''; + my $cdr_svc_method = $self->option('cdr_svc_method',1)||'svc_phone.phonenum'; my $rating_method = $self->option('rating_method') || 'prefix'; my $intl = $self->option('international_prefix') || '011'; my $domestic_prefix = $self->option('domestic_prefix'); @@ -298,6 +349,8 @@ sub calc_usage { @dirass = split(',', $dirass); } + my %interval_cache = (); # for timed rates + #for check_chargable, so we don't keep looking up options inside the loop my %opt_cache = (); @@ -305,14 +358,19 @@ sub calc_usage { die $@ if $@; my $csv = new Text::CSV_XS; + my($svc_table, $svc_field) = split('\.', $cdr_svc_method); + foreach my $cust_svc ( - grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc + grep { $_->part_svc->svcdb eq $svc_table } $cust_pkg->cust_svc ) { + my $svc_x = $cust_svc->svc_x; foreach my $cdr ( - $cust_svc->get_cdrs_for_update( + $svc_x->get_cdrs( 'disable_src' => $self->option('disable_src'), 'default_prefix' => $self->option('default_prefix'), + 'status' => '', + 'for_update' => 1, ) # $last_bill, $$sdate ) ) { if ( $DEBUG > 1 ) { @@ -322,11 +380,16 @@ sub calc_usage { my $rate_detail; my( $rate_region, $regionnum ); + my $rate; my $pretty_destnum; my $charge = ''; my $seconds = ''; + my $weektime = ''; my $regionname = ''; my $classnum = ''; + my $countrycode; + my $number; + my @call_details = (); if ( $rating_method eq 'prefix' ) { @@ -353,7 +416,7 @@ sub calc_usage { # (or calling station id for toll free calls) ### - my( $to_or_from, $number ); + my( $to_or_from ); if ( $cdr->is_tollfree && ! $disable_tollfree ) { #tollfree call $to_or_from = 'from'; @@ -373,7 +436,7 @@ sub calc_usage { # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com #determine the country code - my $countrycode; + $countrycode = ''; if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/ || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/ ) @@ -399,12 +462,27 @@ sub calc_usage { warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG; $pretty_destnum = "+$countrycode $number"; - - my $rate = qsearchs('rate', { 'ratenum' => $ratenum }) - or die "ratenum $ratenum not found!"; - + #asterisks here causes inserting the detail to barf, so: + $pretty_destnum =~ s/\*//g; + + my $eff_ratenum = $cdr->is_tollfree('accountcode') + ? $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum') + : ''; + $eff_ratenum ||= $ratenum; + $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum }) + or die "ratenum $eff_ratenum not found!"; + + my @ltime = localtime($cdr->startdate); + $weektime = $ltime[0] + + $ltime[1]*60 + #minutes + $ltime[2]*3600 + #hours + $ltime[6]*86400; #days since sunday + # if there's no timed rate_detail for this time/region combination, + # dest_detail returns the default. There may still be a timed rate + # that applies after the starttime of the call, so be careful... $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode, 'phonenum' => $number, + 'weektime' => $weektime, }); if ( $rate_detail ) { @@ -416,6 +494,17 @@ sub calc_usage { "and rate detail $rate_detail\n" if $DEBUG; + if ( !exists($interval_cache{$regionnum}) ) { + my @intervals = ( + sort { $a->stime <=> $b->stime } + map { my $r = $_->rate_time; $r ? $r->intervals : () } + $rate->rate_detail + ); + $interval_cache{$regionnum} = \@intervals; + warn " cached ".scalar(@intervals)." interval(s)\n" + if $DEBUG; + } + } elsif ( $ignore_unrateable ) { $rate_region = ''; @@ -432,42 +521,12 @@ sub calc_usage { } -# } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove? -# -# if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid -# -# $rate_detail = $cdr->cdr_upstream_rate->rate_detail; -# -# $regionnum = $rate_detail->dest_regionnum; -# $rate_region = $rate_detail->dest_region; -# -# $pretty_destnum = $cdr->dst; -# -# warn " found rate for regionnum $regionnum and ". -# "rate detail $rate_detail\n" -# if $DEBUG; -# -# } else { #pass upstream price through -# -# $charge = sprintf('%.2f', $cdr->upstream_price); -# $charges += $charge; -# -# @call_details = ( -# #time2str("%Y %b %d - %r", $cdr->calldate_unix ), -# time2str("%c", $cdr->calldate_unix), #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot -# 'N/A', #minutes... -# '$'.$charge, -# #$pretty_destnum, -# $cdr->description, #$rate_region->regionname, -# ); -# -# } - } elsif ( $rating_method eq 'upstream_simple' ) { #XXX $charge = sprintf('%.2f', $cdr->upstream_price); $charge = sprintf('%.3f', $cdr->upstream_price); $charges += $charge; + warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG; @call_details = ($cdr->downstream_csv( 'format' => $output_format, 'charge' => $charge, @@ -478,30 +537,34 @@ sub calc_usage { } elsif ( $rating_method eq 'single_price' ) { # a little false laziness w/below + # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ? my $granularity = length($self->option('sec_granularity')) ? $self->option('sec_granularity') : 60; - # length($cdr->billsec) ? $cdr->billsec : $cdr->duration; $seconds = $use_duration ? $cdr->duration : $cdr->billsec; $seconds += $granularity - ( $seconds % $granularity ) if $seconds # don't granular-ize 0 billsec calls (bills them) - && $granularity; # 0 is per call - my $minutes = $seconds / 60; # sprintf("%.1f", - #$minutes =~ s/\.0$// if $granularity == 60; - + && $granularity # 0 is per call + && $seconds % $granularity; + my $minutes = $seconds / 60; # XXX config? #$charge = sprintf('%.2f', ( $self->option('min_charge') * $minutes ) #+ 0.00000001 ); #so 1.005 rounds to 1.01 $charge = sprintf('%.4f', ( $self->option('min_charge') * $minutes ) + 0.0000000001 ); #so 1.00005 rounds to 1.0001 + warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG; $charges += $charge; - @call_details = ($cdr->downstream_csv( 'format' => $output_format, - 'charge' => $charge, + @call_details = ($cdr->downstream_csv( 'format' => $output_format, + 'charge' => $charge, + 'seconds' => ($use_duration ? + $cdr->duration : + $cdr->billsec), + 'granularity' => $granularity, ) ); @@ -524,60 +587,122 @@ sub calc_usage { "; skipping\n" } else { # there *is* a rate_detail (or call_details), proceed... + # About this section: + # We don't round _anything_ (except granularizing) + # until the final $charge = sprintf("%.2f"...). unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) { - $included_min{$regionnum} = $rate_detail->min_included - unless exists $included_min{$regionnum}; + my $seconds_left = $use_duration ? $cdr->duration : $cdr->billsec; + # charge for the first (conn_sec) seconds + $seconds = min($seconds_left, $rate_detail->conn_sec); + $seconds_left -= $seconds; + $weektime += $seconds; + $charge = $rate_detail->conn_charge; + + my $etime; + while($seconds_left) { + my $ratetimenum = $rate_detail->ratetimenum; # may be empty + + # find the end of the current rate interval + if(@{ $interval_cache{$regionnum} } == 0) { + # There are no timed rates in this group, so just stay + # in the default rate_detail for the entire duration. + # Set an "end" of 1 past the end of the current call. + $etime = $weektime + $seconds_left + 1; + } + elsif($ratetimenum) { + # This is a timed rate, so go to the etime of this interval. + # If it's followed by another timed rate, the stime of that + # interval should match the etime of this one. + my $interval = $rate_detail->rate_time->contains($weektime); + $etime = $interval->etime; + } + else { + # This is a default rate, so use the stime of the next + # interval in the sequence. + my $next_int = first { $_->stime > $weektime } + @{ $interval_cache{$regionnum} }; + if ($next_int) { + $etime = $next_int->stime; + } + else { + # weektime is near the end of the week, so decrement + # it by a full week and use the stime of the first + # interval. + $weektime -= (3600*24*7); + $etime = $interval_cache{$regionnum}->[0]->stime; + } + } - my $granularity = $rate_detail->sec_granularity; + my $charge_sec = min($seconds_left, $etime - $weektime); - # length($cdr->billsec) ? $cdr->billsec : $cdr->duration; - $seconds = $use_duration ? $cdr->duration : $cdr->billsec; + $seconds_left -= $charge_sec; - $seconds += $granularity - ( $seconds % $granularity ) - if $seconds # don't granular-ize 0 billsec calls (bills them) - && $granularity; # 0 is per call - my $minutes = sprintf("%.1f", $seconds / 60); - $minutes =~ s/\.0$// if $granularity == 60; + $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included + unless exists $included_min{$regionnum}{$ratetimenum}; - # per call rather than per minute - $minutes = 1 unless $granularity; + my $granularity = $rate_detail->sec_granularity; - $included_min{$regionnum} -= $minutes; + my $minutes; + if ( $granularity ) { # charge per minute + # Round up to the nearest $granularity + if ( $charge_sec and $charge_sec % $granularity ) { + $charge_sec += $granularity - ($charge_sec % $granularity); + } + $minutes = $charge_sec / 60; #don't round this + } + else { # per call + $minutes = 1; + $seconds_left = 0; + } - if ( $included_min{$regionnum} < 0 ) { - my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve - #(display?) this - $included_min{$regionnum} = 0; - $charge = sprintf('%.2f', ( $rate_detail->min_charge * $charge_min ) - + 0.00000001 ); #so 1.005 rounds to 1.01 - $charges += $charge; - } + $seconds += $charge_sec; + + $included_min{$regionnum}{$ratetimenum} -= $minutes; + if ( $included_min{$regionnum}{$ratetimenum} <= 0 ) { + my $charge_min = 0 - $included_min{$regionnum}{$ratetimenum}; #XXX should preserve + #(display?) this + $included_min{$regionnum}{$ratetimenum} = 0; + $charge += ($rate_detail->min_charge * $charge_min); #still not rounded + } + # choose next rate_detail + $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode, + 'phonenum' => $number, + 'weektime' => $etime }) + if($seconds_left); + # we have now moved forward to $etime + $weektime = $etime; + + } #while $seconds_left # this is why we need regionnum/rate_region.... warn " (rate region $rate_region)\n" if $DEBUG; - @call_details = ( - $cdr->downstream_csv( 'format' => $output_format, - 'granularity' => $granularity, - 'minutes' => $minutes, - 'charge' => $charge, - 'pretty_dst' => $pretty_destnum, - 'dst_regionname' => $regionname, - ) - ); - $classnum = $rate_detail->classnum; + $charge = sprintf('%.2f', $charge + 0.000001); # NOW round it. + warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG; + $charges += $charge; - } + @call_details = ( + $cdr->downstream_csv( 'format' => $output_format, + 'granularity' => $rate_detail->sec_granularity, + 'seconds' => ($use_duration ? + $cdr->duration : + $cdr->billsec), + 'charge' => $charge, + 'pretty_dst' => $pretty_destnum, + 'dst_regionname' => $regionname, + ) + ); + } #if(there is a rate_detail) + if ( $charge > 0 ) { #just use FS::cust_bill_pkg_detail objects? my $call_details; my $phonenum = $cust_svc->svc_x->phonenum; - #if ( $self->option('rating_method') eq 'upstream_simple' ) { if ( scalar(@call_details) == 1 ) { $call_details = [ 'C', @@ -624,7 +749,14 @@ sub calc_usage { } # $cust_svc - unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ] + unshift @$details, [ 'C', + FS::cdr::invoice_header($output_format), + '', + '', + '', + '', + '', + ] if @$details && $rating_method ne 'upstream'; # if ( $spool_cdr && length($downstream_cdr) ) { @@ -670,10 +802,13 @@ sub check_chargable { use_disposition_taqua use_carrierid use_cdrtypenum + skip_dst_prefix skip_dcontext skip_dstchannel_prefix - skip_dst_length_less + skip_src_length_more noskip_src_length_accountcode_tollfree + skip_dst_length_less noskip_dst_length_accountcode_tollfree skip_lastapp + skip_max_callers ); foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) { $flags{option_cache}->{$opt} = $self->option($opt, 1); @@ -698,6 +833,11 @@ sub check_chargable { if length($opt{'use_cdrtypenum'}) && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches '' + foreach(split(',',$opt{'skip_dst_prefix'})) { + return "dst starts with '$_'" + if length($_) && substr($cdr->dst,0,length($_)) eq $_; + } + return "dcontext IN ( $opt{'skip_dcontext'} )" if $opt{'skip_dcontext'} =~ /\S/ && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'}); @@ -709,11 +849,39 @@ sub check_chargable { my $dst_length = $opt{'skip_dst_length_less'}; return "destination less than $dst_length digits" - if $dst_length && length($cdr->dst) < $dst_length; + if $dst_length && length($cdr->dst) < $dst_length + && ! ( $opt{'noskip_dst_length_accountcode_tollfree'} + && $cdr->is_tollfree('accountcode') + ); return "lastapp is $opt{'skip_lastapp'}" if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'}; + my $src_length = $opt{'skip_src_length_more'}; + if ( $src_length ) { + + if ( $opt{'noskip_src_length_accountcode_tollfree'} ) { + + if ( $cdr->is_tollfree('accountcode') ) { + return "source less than or equal to $src_length digits" + if length($cdr->src) <= $src_length; + } else { + return "source more than $src_length digits" + if length($cdr->src) > $src_length; + } + + } else { + return "source more than $src_length digits" + if length($cdr->src) > $src_length; + } + + } + + return "max_callers <= $opt{skip_max_callers}" + if length($opt{'skip_max_callers'}) + and length($cdr->max_callers) + and $cdr->max_callers <= $opt{'skip_max_callers'}; + #all right then, rate it ''; }