use FS::rate_detail;
use FS::part_pkg::recur_Common;
+use List::Util qw(first min);
+
@ISA = qw(FS::part_pkg::recur_Common);
$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',
# '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.',
'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,
'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',
},
'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',
},
'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',
'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
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
# 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');
@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 = ();
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 ) {
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' ) {
# (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';
# $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+)$/
)
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 ) {
"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 = '';
# } else { #pass upstream price through
#
# $charge = sprintf('%.2f', $cdr->upstream_price);
+# warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
# $charges += $charge;
#
# @call_details = (
#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,
$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,
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 = sprintf("%.02f", $rate_detail->conn_charge);
+
+ my $total_minutes = 0;
+ my $whole_minutes = 1;
+ 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;
+ $whole_minutes = 0 if $granularity;
- $included_min{$regionnum} -= $minutes;
+ # should this be done in every rate interval?
+ $charge_sec += $granularity - ( $charge_sec % $granularity )
+ if $charge_sec # don't granular-ize 0 billsec calls (bills them)
+ && $granularity; # 0 is per call
+ my $minutes = sprintf("%.1f", $charge_sec / 60);
+ $minutes =~ s/\.0$// if $granularity == 60;
- 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;
+
+ # per call rather than per minute
+ $minutes = 1 unless $granularity;
+ $seconds_left = 0 unless $granularity;
+
+ $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 += sprintf('%.2f', ($rate_detail->min_charge * $charge_min)
+ + 0.00000001 ); #so 1.005 rounds to 1.01
+ }
+ # 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,
- )
- );
+ $total_minutes = sprintf("%.1f", $seconds / 60);
+ $total_minutes =~ s/\.0$// if $whole_minutes;
$classnum = $rate_detail->classnum;
+ $charge = sprintf('%.2f', $charge);
+ 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,
+ 'minutes' => $total_minutes,
+ # why do we go through this hocus-pocus?
+ # the cdr *will* show duration here
+ # if we forego the 'minutes' key
+ # duration vs 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?
} # $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) ) {
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);
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'});
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
+ );
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
'';
}