package FS::part_pkg::voip_cdr;
+use base qw( FS::part_pkg::recur_Common );
use strict;
-use vars qw(@ISA $DEBUG %info);
-use Date::Format;
+use vars qw( $DEBUG %info );
+use List::Util qw(first min);
use Tie::IxHash;
+use Date::Format;
+use Text::CSV_XS;
use FS::Conf;
use FS::Record qw(qsearchs qsearch);
-use FS::part_pkg::recur_Common;
use FS::cdr;
use FS::rate;
use FS::rate_prefix;
use FS::rate_detail;
-use FS::part_pkg::recur_Common;
-
-@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)',
+ 'svc_pbx.svcnum' => 'Freeside service # (svc_pbx.svcnum)',
+;
+
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.',
tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
+# previously "1" was "ignore"
+tie my %unrateable_opts, 'Tie::IxHash',
+ '' => 'Exit with a fatal error',
+ 1 => 'Ignore and continue',
+ 2 => 'Flag for later review',
+;
+
%info = (
'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
'shortname' => 'VoIP/telco CDR rating (standard)',
+ 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ],
'fields' => {
- 'setup_fee' => { 'name' => 'Setup fee for this package',
- 'default' => 0,
- },
- 'recur_fee' => { 'name' => 'Base recurring fee for this package',
- 'default' => 0,
- },
-
+ 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended',
+ 'type' => 'checkbox',
+ },
#false laziness w/flat.pm
'recur_temporality' => { 'name' => 'Charge recurring fee for period',
'type' => 'select',
'select_options' => \%temporalities,
},
- 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
- ' of service at cancellation',
- 'type' => 'checkbox',
- },
-
'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
'subscription',
'default' => '1',
},
-
'recur_method' => { 'name' => 'Recurring fee method',
#'type' => 'radio',
#'options' => \%recur_method,
'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_key' => 'ratenum',
'select_label' => 'ratename',
},
+
+ 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan',
+ 'type' => 'select',
+ 'select_table' => 'rate',
+ 'select_key' => 'ratenum',
+ 'select_label' => 'ratename',
+ 'disable_empty' => 0,
+ 'empty_label' => '',
+ },
+
+ 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" rating method or when using the "prefix" rating method ("region group" billing)',
+ },
'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method',
},
'select_options' => \%granularity,
},
- 'ignore_unrateable' => { 'name' => 'Ignore calls without a rate in the rate tables. By default, the system will throw a fatal error upon encountering unrateable calls.',
- 'type' => 'checkbox',
+ 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table',
+ 'type' => 'select',
+ 'select_options' => \%unrateable_opts,
},
'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
'type' => 'checkbox',
},
- 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
+ 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").',
'type' => 'checkbox',
},
- 'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
- 'type' => 'checkbox',
+ 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to: ',
},
- 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
- 'type' => 'checkbox',
- },
-
- 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
+ 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to: ',
},
-
- 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
+
+ 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ',
+ },
+
+ 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ',
},
+
+ 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition 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_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',
},
#eofalse
- 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.',
+ 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.',
'type' => 'checkbox',
},
+ 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period',
+ 'type' => 'checkbox',
+ },
+
'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.',
'type' => 'checkbox',
},
},
'fieldorder' => [qw(
- setup_fee recur_fee recur_temporality unused_credit
- recur_method cutoff_day
- rating_method ratenum min_charge sec_granularity
+ recur_temporality
+ recur_method cutoff_day ),
+ FS::part_pkg::prorate_Mixin::fieldorder,
+ qw(
+ cdr_svc_method
+ rating_method ratenum intrastate_ratenum
+ min_charge min_included sec_granularity
ignore_unrateable
default_prefix
disable_src
domestic_prefix international_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
+ use_amaflags
+ use_carrierid
+ use_cdrtypenum ignore_cdrtypenum
+ ignore_disposition disposition_in
+ 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
- bill_every_call
- count_available_phones
+ bill_every_call bill_inactive_svcs
+ count_available_phones suspend_bill
)
],
'weight' => 40,
);
-sub calc_setup {
- my($self, $cust_pkg ) = @_;
- $self->option('setup_fee');
+sub price_info {
+ my $self = shift;
+ my $str = $self->SUPER::price_info;
+ $str .= " plus usage" if $str;
+ $str;
}
sub calc_recur {
my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
return 0
- if $self->option('recur_temporality', 1) eq 'preceding'
+ if $self->recur_temporality eq 'preceding'
&& ( $last_bill eq '' || $last_bill == 0 );
my $ratenum = $cust_pkg->part_pkg->option('ratenum');
my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
- my %included_min = ();
+ my %included_min = (); #region groups w/prefix rating
+
+ my $included_min = $self->option('min_included', 1) || 0; #single price rating
my $charges = 0;
# 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');
my $disable_tollfree = $self->option('disable_tollfree');
my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
my $use_duration = $self->option('use_duration');
+ my $region_group = ($rating_method eq 'prefix' && ($self->option('min_included',1) || 0) > 0);
+ my $region_group_included_min = $region_group ? $self->option('min_included') : 0;
my $output_format = $self->option('output_format', 'Hush!')
|| ( $rating_method eq 'upstream_simple'
@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 = ();
- eval "use Text::CSV_XS;";
- die $@ if $@;
my $csv = new Text::CSV_XS;
- foreach my $cust_svc (
- grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
- ) {
+ my($svc_table, $svc_field) = split('\.', $cdr_svc_method);
- foreach my $cdr (
- $cust_svc->get_cdrs_for_update(
+ my @cust_svc;
+ if( $self->option('bill_inactive_svcs',1) ) {
+ #XXX in this mode do we need to restrict the set of CDRs by date also?
+ @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill);
+ }
+ else {
+ @cust_svc = $cust_pkg->cust_svc;
+ }
+ @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc;
+
+ foreach my $cust_svc (@cust_svc) {
+
+ my $svc_x;
+ if( $self->option('bill_inactive_svcs',1) ) {
+ $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill);
+ }
+ else {
+ $svc_x = $cust_svc->svc_x;
+ }
+ my %options = (
'disable_src' => $self->option('disable_src'),
'default_prefix' => $self->option('default_prefix'),
- ) # $last_bill, $$sdate )
+ 'cdrtypenum' => $self->option('use_cdrtypenum'),
+ 'status' => '',
+ 'for_update' => 1,
+ ); # $last_bill, $$sdate )
+ $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum';
+
+ my @invoice_details_sort;
+
+ foreach my $cdr (
+ $svc_x->get_cdrs( %options )
) {
if ( $DEBUG > 1 ) {
warn "rating CDR $cdr\n".
my $rate_detail;
my( $rate_region, $regionnum );
+ my $rate;
my $pretty_destnum;
my $charge = '';
my $seconds = '';
+ my $weektime = '';
my $regionname = '';
+ my $ratename = '';
my $classnum = '';
+ my $countrycode;
+ my $number;
+
my @call_details = ();
if ( $rating_method eq 'prefix' ) {
my $da_rewrote = 0;
+ # this will result in those CDRs being marked as done... is that
+ # what we want?
if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
$cdr->dst('411');
$da_rewrote = 1;
warn "not charging for CDR ($reason)\n" if $DEBUG;
$charge = 0;
+ # this will result in those CDRs being marked as done... is that
+ # what we want?
} else {
# (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+)$/
)
}
} else {
- $countrycode = $domestic_prefix || '1';
+ $countrycode = length($domestic_prefix) ? $domestic_prefix : '1';
$number =~ s/^$countrycode//;# if length($number) > 10;
}
warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
$pretty_destnum = "+$countrycode $number";
+ #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')
+ : '';
+
+ my $intrastate_ratenum = $cust_pkg->part_pkg->option('intrastate_ratenum');
+ if ( $intrastate_ratenum && !$cdr->is_tollfree ) {
+ $ratename = 'Interstate'; #until proven otherwise
+ # this is relatively easy only because:
+ # -assume all numbers are valid NANP numbers NOT in a fully-qualified format
+ # -disregard toll-free
+ # -disregard private or unknown numbers
+ # -there is exactly one record in rate_prefix for a given NPANXX
+ # -default to interstate if we can't find one or both of the prefixes
+ my $dstprefix = $cdr->dst;
+ $dstprefix =~ /^(\d{6})/;
+ $dstprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
+ 'npa' => $1,
+ }) || '';
+ my $srcprefix = $cdr->src;
+ $srcprefix =~ /^(\d{6})/;
+ $srcprefix = qsearchs('rate_prefix', { 'countrycode' => '1',
+ 'npa' => $1,
+ }) || '';
+ if ($srcprefix && $dstprefix
+ && $srcprefix->state && $dstprefix->state
+ && $srcprefix->state eq $dstprefix->state) {
+ $eff_ratenum = $intrastate_ratenum;
+ $ratename = 'Intrastate'; # XXX possibly just use the ratename?
+ }
+ }
- my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
- or die "ratenum $ratenum not found!";
-
+ $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,
+ 'cdrtypenum' => $cdr->cdrtypenum,
});
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 = '';
}
-# } 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,
} 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;
-
- # 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 )
+ && $granularity # 0 is per call
+ && $seconds % $granularity;
+ my $minutes = $granularity ? ($seconds / 60) : 1;
+
+ my $charge_min = $minutes;
+
+ $included_min -= $minutes;
+ if ( $included_min > 0 ) {
+ $charge_min = 0;
+ } else {
+ $charge_min = 0 - $included_min;
+ $included_min = 0;
+ }
+
+ $charge = sprintf('%.4f', ( $self->option('min_charge') * $charge_min )
+ 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,
)
);
#if ( ! $rate_detail && ! scalar(@call_details) ) {}
if ( ! $rate_detail && $charge eq '' ) {
- warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
- "; skipping\n"
+ if ( $ignore_unrateable == 2 ) {
+ # mark the CDR as unrateable
+ my $error = $cdr->set_status_and_rated_price(
+ 'failed',
+ '',
+ $cust_svc->svcnum
+ );
+ die $error if $error;
+ }
+ elsif ( $ignore_unrateable == 1 ) {
+ # warn and continue
+ warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
+ "; skipping\n"
+ } #if $ignore_unrateable
} 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 $charge_sec = min($seconds_left, $etime - $weektime);
- my $granularity = $rate_detail->sec_granularity;
+ $seconds_left -= $charge_sec;
- # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
- $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
+ $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included
+ unless exists $included_min{$regionnum}{$ratetimenum};
- $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;
+ my $granularity = $rate_detail->sec_granularity;
- # per call rather than per minute
- $minutes = 1 unless $granularity;
+ 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;
+ }
- $included_min{$regionnum} -= $minutes;
+ $seconds += $charge_sec;
- 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;
- }
+ $region_group_included_min -= $minutes
+ if $region_group && $rate_detail->region_group;
+
+ $included_min{$regionnum}{$ratetimenum} -= $minutes;
+ if ( ($region_group_included_min <= 0 || !$rate_detail->region_group)
+ && $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
+ }
+ elsif( $region_group_included_min > 0 && $region_group
+ && $rate_detail->region_group ) {
+ $included_min{$regionnum}{$ratetimenum} = 0
+ }
+ # choose next rate_detail
+ $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
+ 'phonenum' => $number,
+ 'weektime' => $etime,
+ 'cdrtypenum' => $cdr->cdrtypenum })
+ 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;
-
- }
-
- 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',
- $call_details[0],
- $charge,
- $classnum,
- $phonenum,
- $seconds,
- $regionname,
- ];
- } else { #only used for $rating_method eq 'upstream' now
- $csv->combine(@call_details);
- $call_details =
- [ 'C',
- $csv->string,
- $charge,
- $classnum,
- $phonenum,
- $seconds,
- $regionname,
- ];
+ $charge = sprintf('%.2f', $charge + 0.000001); # NOW round it.
+ warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
+ $charges += $charge;
+
+ if ( !$self->sum_usage ) {
+ @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,
+ )
+ );
}
- warn " adding details on charge to invoice: [ ".
- join(', ', @{$call_details} ). " ]"
- if ( $DEBUG && ref($call_details) );
- push @$details, $call_details; #\@call_details,
+ } #if(there is a rate_detail)
+
+ #if ( $charge > 0 ) {
+ # generate a detail record for every call; filter out $charge = 0
+ # later.
+ my $call_details;
+ my $phonenum = $svc_x->phonenum;
+
+ if ( scalar(@call_details) == 1 ) {
+ $call_details =
+ { format => 'C',
+ detail => $call_details[0],
+ amount => $charge,
+ classnum => $classnum,
+ phonenum => $phonenum,
+ accountcode => $cdr->accountcode,
+ startdate => $cdr->startdate,
+ duration => $seconds,
+ regionname => $regionname,
+ };
+ } else { #only used for $rating_method eq 'upstream' now
+ # and for sum_ formats
+ $csv->combine(@call_details);
+ $call_details =
+ { format => 'C',
+ detail => $csv->string,
+ amount => $charge,
+ classnum => $classnum,
+ phonenum => $phonenum,
+ accountcode => $cdr->accountcode,
+ startdate => $cdr->startdate,
+ duration => $seconds,
+ regionname => $regionname,
+ };
}
+ $call_details->{'ratename'} = $ratename;
+
+ push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ];
+ #} $charge > 0
# if the customer flag is on, call "downstream_csv" or something
# like it to export the call downstream!
} # $cdr
+ if ( !$self->sum_usage ) {
+ #sort them
+ my @sorted_invoice_details =
+ sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort;
+ foreach my $sorted_call_detail ( @sorted_invoice_details ) {
+ my $d = $sorted_call_detail->[0];
+ push @$details, $d if $d->{amount} > 0;
+ }
+ }
+ else { #$self->sum_usage
+ push @$details, $self->sum_detail($svc_x, \@invoice_details_sort);
+ }
} # $cust_svc
- unshift @$details, [ 'C',
- FS::cdr::invoice_header($output_format),
- '',
- '',
- '',
- '',
- '',
- ]
+ unshift @$details, { format => 'C',
+ detail => FS::cdr::invoice_header($output_format),
+ }
if @$details && $rating_method ne 'upstream';
-# if ( $spool_cdr && length($downstream_cdr) ) {
-#
-# use FS::UID qw(datasrc);
-# my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
-# mkdir $dir, 0700 unless -d $dir;
-# $dir .= '/'. $cust_pkg->custnum.
-# mkdir $dir, 0700 unless -d $dir;
-# my $filename = time2str("$dir/CDR%Y%m%d-spool.CSV", time); #XXX invoice date instead? would require changing the order things are generated in cust_main::bill insert cust_bill first - with transactions it could be done though
-#
-# push @{ $param->{'precommit_hooks'} },
-# sub {
-# #lock the downstream spool file and append the records
-# use Fcntl qw(:flock);
-# use IO::File;
-# my $spool = new IO::File ">>$filename"
-# or die "can't open $filename: $!\n";
-# flock( $spool, LOCK_EX)
-# or die "can't lock $filename: $!\n";
-# seek($spool, 0, 2)
-# or die "can't seek to end of $filename: $!\n";
-# print $spool $downstream_cdr;
-# flock( $spool, LOCK_UN );
-# close $spool;
-# };
-#
-# } #if ( $spool_cdr && length($downstream_cdr) )
-
$charges;
}
my @opt = qw(
use_amaflags
- use_disposition
- use_disposition_taqua
use_carrierid
use_cdrtypenum
+ ignore_cdrtypenum
+ disposition_in
+ ignore_disposition
+ 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);
return 'amaflags != 2'
if $opt{'use_amaflags'} && $cdr->amaflags != 2;
- return 'disposition != ANSWERED'
- if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
-
- return "disposition != 100"
- if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
+ return "disposition NOT IN ( $opt{'disposition_in'} )"
+ if $opt{'disposition_in'} =~ /\S/
+ && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'disposition_in'});
+
+ return "disposition IN ( $opt{'ignore_disposition'} )"
+ if $opt{'ignore_disposition'} =~ /\S/
+ && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'ignore_disposition'});
+
+ foreach(split(/\s*,\s*/, $opt{'skip_dst_prefix'})) {
+ return "dst starts with '$_'"
+ if length($_) && substr($cdr->dst,0,length($_)) eq $_;
+ }
return "carrierid != $opt{'use_carrierid'}"
if length($opt{'use_carrierid'})
&& $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
&& ! $flags{'da_rewrote'};
+ # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
return "cdrtypenum != $opt{'use_cdrtypenum'}"
if length($opt{'use_cdrtypenum'})
&& $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
+
+ return "cdrtypenum == $opt{'ignore_cdrtypenum'}"
+ if length($opt{'ignore_cdrtypenum'})
+ && $cdr->cdrtypenum eq $opt{'ignore_cdrtypenum'}; #eq otherwise 0 matches ''
return "dcontext IN ( $opt{'skip_dcontext'} )"
if $opt{'skip_dcontext'} =~ /\S/
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
'';
}
$count;
}
+# tells whether cust_bill_pkg_detail should return a single line for
+# each phonenum
+sub sum_usage {
+ my $self = shift;
+ $self->option('output_format') =~ /^sum_/;
+}
+
+sub sum_detail {
+ my $self = shift;
+ my $svc_x = shift;
+ my $invoice_details = shift || [];
+ return () if !@$invoice_details;
+ my $details_by_rate = {};
+ # combine the entire set of CDRs
+ foreach ( @$invoice_details ) {
+ my $d = $_->[0];
+ my $sum = $details_by_rate->{ $d->{ratename} } ||= {
+ amount => 0,
+ format => 'C',
+ classnum => '', #XXX
+ duration => 0,
+ phonenum => $svc_x->phonenum,
+ accountcode => '', #XXX
+ startdate => '', #XXX
+ regionname => '',
+ count => 0,
+ };
+ $sum->{amount} += $d->{amount};
+ $sum->{duration} += $d->{duration};
+ $sum->{count}++;
+ }
+ my @details;
+ foreach my $ratename ( sort keys(%$details_by_rate) ) {
+ my $sum = $details_by_rate->{$ratename};
+ next if $sum->{count} == 0;
+ my $total_cdr = FS::cdr->new({
+ 'billsec' => $sum->{duration},
+ 'src' => $sum->{phonenum},
+ });
+ $sum->{detail} = $total_cdr->downstream_csv(
+ format => $self->option('output_format'),
+ seconds => $sum->{duration},
+ charge => sprintf('%.2f',$sum->{amount}),
+ ratename => $ratename,
+ phonenum => $sum->{phonenum},
+ count => $sum->{count},
+ );
+ push @details, $sum;
+ }
+ @details;
+}
+
+# and whether cust_bill should show a detail line for the service label
+# (separate from usage details)
+sub hide_svc_detail {
+ my $self = shift;
+ $self->option('output_format') =~ /^sum_/;
+}
+
+
1;
projects / freeside.git / blobdiff