use strict;
use vars qw( @ISA @EXPORT_OK $DEBUG $me
$conf $cdr_prerate %cdr_prerate_cdrtypenums
+ $use_lrn $support_key
);
use Exporter;
use List::Util qw(first min);
use FS::rate_prefix;
use FS::rate_detail;
+# LRN lookup
+use LWP::UserAgent;
+use HTTP::Request::Common qw(POST);
+use IO::Socket::SSL;
+use Cpanel::JSON::XS qw(decode_json);
+
@ISA = qw(FS::Record);
-@EXPORT_OK = qw( _cdr_date_parser_maker _cdr_min_parser_maker );
+@EXPORT_OK = qw( _cdr_date_parser_maker _cdr_min_parser_maker _cdr_date_parse );
$DEBUG = 0;
$me = '[FS::cdr]';
@cdr_prerate_cdrtypenums = $conf->config('cdr-prerate-cdrtypenums')
if $cdr_prerate;
%cdr_prerate_cdrtypenums = map { $_=>1 } @cdr_prerate_cdrtypenums;
+
+ $support_key = $conf->config('support-key');
+ $use_lrn = $conf->exists('cdr-lrn_lookup');
+
});
=head1 NAME
=item dst_ip_addr - Destination IP address (same)
+=item dst_term - Terminating destination number (if different from dst)
+
=item startdate - Start of call (UNIX-style integer timestamp)
=item answerdate - Answer time of call (UNIX-style integer timestamp)
=item cdrbatch
+=item detailnum - Link to invoice detail (L<FS::cust_bill_pkg_detail>)
+
=back
=head1 METHODS
#'lastdata' => '',
'src_ip_addr' => 'Source IP',
'dst_ip_addr' => 'Dest. IP',
+ 'dst_term' => 'Termination dest.',
'startdate' => 'Start date',
'answerdate' => 'Answer date',
'enddate' => 'End date',
'upstream_price' => 'Upstream price',
#'upstream_rateplanid' => '',
#'ratedetailnum' => '',
+ 'src_lrn' => 'Source LRN',
+ 'dst_lrn' => 'Dest. LRN',
'rated_price' => 'Rated price',
+ 'rated_cost' => 'Rated cost',
#'distance' => '',
#'islocal' => '',
#'calltypenum' => '',
'freesiderewritestatus' => 'Freeside rewrite status',
'cdrbatch' => 'Legacy batch',
'cdrbatchnum' => 'Batch',
+ 'detailnum' => 'Freeside invoice detail line',
},
};
#check the foreign keys even?
#do we want to outright *reject* the CDR?
- my $error =
- $self->ut_numbern('acctid')
+ my $error = $self->ut_numbern('acctid');
+ return $error if $error;
+
+ if ( $self->freesidestatus ne 'done' ) {
+ $self->set('detailnum', ''); # can't have this on an unbilled call
+ }
#add a config option to turn these back on if someone needs 'em
#
#
# # Telstra =1, Optus = 2, RSL COM = 3
# || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' )
- ;
- return $error if $error;
$self->SUPER::check;
}
sub is_tollfree {
my $self = shift;
my $field = scalar(@_) ? shift : 'dst';
- ( $self->$field() =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0;
+ my $country = $conf->config('tollfree-country') || '';
+ if ( $country eq 'AU' ) {
+ ( $self->$field() =~ /^(\+?61)?(1800|1300)/ ) ? 1 : 0;
+ } elsif ( $country eq 'NZ' ) {
+ ( $self->$field() =~ /^(\+?64)?(800|508)/ ) ? 1 : 0;
+ } else { #NANPA (US/Canaada)
+ ( $self->$field() =~ /^(\+?1)?8(8|([02-7])\3)/ ) ? 1 : 0;
+ }
}
=item set_charged_party
Available options are: inbound, rated_pretty_dst, rated_regionname,
rated_seconds, rated_minutes, rated_granularity, rated_ratedetailnum,
-rated_classnum, rated_ratename.
+rated_classnum, rated_ratename. If rated_ratedetailnum is provided,
+will also set a recalculated L</rate_cost> in the rated_cost field
+after the other fields are set (does not work with inbound.)
If there is an error, returns the error, otherwise returns false.
rated_price => $rated_price,
status => $status,
});
- $term->rated_seconds($opt{rated_seconds}) if exists($opt{rated_seconds});
- $term->rated_minutes($opt{rated_minutes}) if exists($opt{rated_minutes});
+ foreach (qw(rated_seconds rated_minutes rated_granularity)) {
+ $term->set($_, $opt{$_}) if exists($opt{$_});
+ }
$term->svcnum($svcnum) if $svcnum;
return $term->insert;
qw( pretty_dst regionname seconds minutes granularity
ratedetailnum classnum ratename );
$self->svcnum($svcnum) if $svcnum;
+ $self->rated_cost($self->rate_cost) if $opt{'rated_ratedetailnum'};
+
return $self->replace();
}
my $field = $options{column} || 'dst';
my $intl = $options{international_prefix} || '011';
+ # Still, don't break anyone's CDR rating if they have an empty string in
+ # there. Require an explicit statement that there's no prefix.
+ $intl = '' if lc($intl) eq 'none';
my $countrycode = '';
my $number = $self->$field();
Rates this CDR according and sets the status to 'rated'.
-Available options are: part_pkg, svcnum, single_price_included_minutes, region_group, region_group_included_minutes.
+Available options are: part_pkg, svcnum, plan_included_min,
+detail_included_min_hashref.
part_pkg is required.
If svcnum is specified, will also associate this CDR with the specified svcnum.
-single_price_included_minutes is requried for single_price price plans
-(otherwise unused/ignored). It should be set to a scalar reference of the
-number of included minutes and will be decremented by the rated minutes of this
+plan_included_min should be set to a scalar reference of the number of
+included minutes and will be decremented by the rated minutes of this
CDR.
-region_group_included_minutes is required for prefix price plans which have
-included minutes (otherwise unused/ignored). It should be set to a scalar
-reference of the number of included minutes and will be decremented by the
-rated minutes of this CDR.
-
-region_group_included_minutes_hashref is required for prefix price plans which
-have included minues (otherwise unused/ignored). It should be set to an empty
-hashref at the start of a month's rating and then preserved across CDRs.
+detail_included_min_hashref should be set to an empty hashref at the
+start of a month's rating and then preserved across CDRs.
=cut
}
}
-
-
-
###
# look up rate details based on called station id
# (or calling station id for toll free calls)
###
+ my $eff_ratenum = $self->is_tollfree('accountcode')
+ ? $part_pkg->option_cacheable('accountcode_tollfree_ratenum')
+ : '';
+
my( $to_or_from, $column );
- if ( $self->is_tollfree && ! $part_pkg->option_cacheable('disable_tollfree') )
+ if(
+ ( $self->is_tollfree
+ && ! $part_pkg->option_cacheable('disable_tollfree')
+ )
+ or ( $eff_ratenum
+ && $part_pkg->option_cacheable('accountcode_tollfree_field') eq 'src'
+ )
+ )
{ #tollfree call
$to_or_from = 'from';
$column = 'src';
domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
);
+ my $ratename = '';
+ my $intrastate_ratenum = $part_pkg->option_cacheable('intrastate_ratenum');
+
+ if ( $use_lrn and $countrycode eq '1' ) {
+
+ # then ask about the number
+ foreach my $field ('src', 'dst') {
+
+ $self->get_lrn($field);
+ if ( $field eq $column ) {
+ # then we are rating on this number
+ $number = $self->get($field.'_lrn');
+ $number =~ s/^1//;
+ # is this ever meaningful? can the LRN be outside NANP space?
+ }
+
+ } # foreach $field
+
+ }
+
warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
my $pretty_dst = "+$countrycode $number";
#asterisks here causes inserting the detail to barf, so:
$pretty_dst =~ s/\*//g;
- my $eff_ratenum = $self->is_tollfree('accountcode')
- ? $part_pkg->option_cacheable('accountcode_tollfree_ratenum')
- : '';
-
- my $ratename = '';
- my $intrastate_ratenum = $part_pkg->option_cacheable('intrastate_ratenum');
+ # should check $countrycode eq '1' here?
if ( $intrastate_ratenum && !$self->is_tollfree ) {
$ratename = 'Interstate'; #until proven otherwise
# this is relatively easy only because:
# -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 $dst_col = $use_lrn ? 'dst_lrn' : 'dst';
+ my $src_col = $use_lrn ? 'src_lrn' : 'src';
my (undef, $dstprefix) = $self->parse_number(
- column => 'dst',
+ column => $dst_col,
international_prefix => $part_pkg->option_cacheable('international_prefix'),
domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
);
'npa' => $1,
}) || '';
my (undef, $srcprefix) = $self->parse_number(
- column => 'src',
+ column => $src_col,
international_prefix => $part_pkg->option_cacheable('international_prefix'),
domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'),
);
}
+ my $regionnum = $rate_detail->dest_regionnum;
my $rate_region = $rate_detail->dest_region;
- my $regionnum = $rate_region->regionnum;
warn " found rate for regionnum $regionnum ".
"and rate detail $rate_detail\n"
if $DEBUG;
# We don't round _anything_ (except granularizing)
# until the final $charge = sprintf("%.2f"...).
- my $seconds_left = $part_pkg->option_cacheable('use_duration')
- ? $self->duration
- : $self->billsec;
+ my $rated_seconds = $part_pkg->option_cacheable('use_duration')
+ ? $self->duration
+ : $self->billsec;
+ my $seconds_left = $rated_seconds;
#no, do this later so it respects (group) included minutes
# # charge for the first (conn_sec) seconds
# $seconds_left -= $seconds;
# $weektime += $seconds;
# my $charge = $rate_detail->conn_charge;
- my $seconds = 0;
+ #my $seconds = 0;
my $charge = 0;
my $connection_charged = 0;
+ # before doing anything else, if there's an upstream multiplier and
+ # an upstream price, add that to the charge. (usually the rate detail
+ # will then have a minute charge of zero, but not necessarily.)
+ $charge += ($self->upstream_price || 0) * $rate_detail->upstream_mult_charge;
+
my $etime;
while($seconds_left) {
my $ratetimenum = $rate_detail->ratetimenum; # may be empty
$seconds_left = 0;
}
- $seconds += $charge_sec;
+ #$seconds += $charge_sec;
if ( $rate_detail->min_included ) {
- # the old, kind of deprecated way to do this
- my $included_min = $opt{'region_group_included_min_hashref'} || {};
+ # the old, kind of deprecated way to do this:
+ #
+ # The rate detail itself has included minutes. We MUST have a place
+ # to track them.
+ my $included_min = $opt{'detail_included_min_hashref'}
+ or return "unable to rate CDR: rate detail has included minutes, but ".
+ "no detail_included_min_hashref provided.\n";
# by default, set the included minutes for this region/time to
# what's in the rate_detail
- $included_min->{$regionnum}{$ratetimenum} = $rate_detail->min_included
- unless exists $included_min->{$regionnum}{$ratetimenum};
-
- # the way that doesn't work
- #my $region_group = ($part_pkg->option_cacheable('min_included') || 0) > 0;
-
- #${$opt{region_group_included_min}} -= $minutes
- # if $region_group && $rate_detail->region_group;
+ if (!exists( $included_min->{$regionnum}{$ratetimenum} )) {
+ $included_min->{$regionnum}{$ratetimenum} =
+ ($rate_detail->min_included * $cust_pkg->quantity || 1);
+ }
- if ( $included_min->{$regionnum}{$ratetimenum} > $minutes ) {
+ if ( $included_min->{$regionnum}{$ratetimenum} >= $minutes ) {
$charge_sec = 0;
$included_min->{$regionnum}{$ratetimenum} -= $minutes;
} else {
$charge_sec -= ($included_min->{$regionnum}{$ratetimenum} * 60);
$included_min->{$regionnum}{$ratetimenum} = 0;
}
+ } elsif ( $opt{plan_included_min} && ${ $opt{plan_included_min} } > 0 ) {
+ # The package definition has included minutes, but only for in-group
+ # rate details. Decrement them if this is an in-group call.
+ if ( $rate_detail->region_group ) {
+ if ( ${ $opt{'plan_included_min'} } >= $minutes ) {
+ $charge_sec = 0;
+ ${ $opt{'plan_included_min'} } -= $minutes;
+ } else {
+ $charge_sec -= (${ $opt{'plan_included_min'} } * 60);
+ ${ $opt{'plan_included_min'} } = 0;
+ }
+ }
} else {
# the new way!
my $applied_min = $cust_pkg->apply_usage(
}
#should preserve (display?) this
- my $charge_min = ( $charge_sec - $conn_seconds ) / 60;
- $charge += ($rate_detail->min_charge * $charge_min) if $charge_min > 0; #still not rounded
+ if ( $granularity == 0 ) { # per call rate
+ $charge += $rate_detail->min_charge;
+ } else {
+ my $charge_min = ( $charge_sec - $conn_seconds ) / 60;
+ $charge += ($rate_detail->min_charge * $charge_min) if $charge_min > 0; #still not rounded
+ }
}
# this is why we need regionnum/rate_region....
warn " (rate region $rate_region)\n" if $DEBUG;
+ # NOW round it.
+ my $rounding = $part_pkg->option_cacheable('rounding') || 2;
+ my $sprintformat = '%.'. $rounding. 'f';
+ my $roundup = 10**(-3-$rounding);
+ my $price = sprintf($sprintformat, $charge + $roundup);
+
$self->set_status_and_rated_price(
'rated',
- sprintf('%.2f', $charge + 0.000001), # NOW round it.
+ $price,
$opt{'svcnum'},
'rated_pretty_dst' => $pretty_dst,
- 'rated_regionname' => $rate_region->regionname,
- 'rated_seconds' => $seconds,
+ 'rated_regionname' => ($rate_region ? $rate_region->regionname : ''),
+ 'rated_seconds' => $rated_seconds, #$seconds,
'rated_granularity' => $rate_detail->sec_granularity, #$granularity
'rated_ratedetailnum' => $rate_detail->ratedetailnum,
'rated_classnum' => $rate_detail->classnum, #rated_ratedetailnum?
sprintf('%.3f', $self->upstream_price),
$opt{'svcnum'},
'rated_classnum' => $self->calltypenum,
+ 'rated_seconds' => $self->billsec,
+ # others? upstream_*_regionname => rated_regionname is possible
);
}
my $charge_min = $minutes;
- ${$opt{single_price_included_min}} -= $minutes;
- if ( ${$opt{single_price_included_min}} > 0 ) {
+ ${$opt{plan_included_min}} -= $minutes;
+ if ( ${$opt{plan_included_min}} > 0 ) {
$charge_min = 0;
} else {
- $charge_min = 0 - ${$opt{single_price_included_min}};
- ${$opt{single_price_included_min}} = 0;
+ $charge_min = 0 - ${$opt{plan_included_min}};
+ ${$opt{plan_included_min}} = 0;
}
my $charge =
}
+=item rate_cost
+
+Rates an already-rated CDR according to the cost fields from the rate plan.
+
+Returns the amount.
+
+=cut
+
+sub rate_cost {
+ my $self = shift;
+
+ return 0 unless $self->rated_ratedetailnum;
+
+ my $rate_detail =
+ qsearchs('rate_detail', { 'ratedetailnum' => $self->rated_ratedetailnum } );
+
+ my $charge = 0;
+ $charge += ($self->upstream_price || 0) * ($rate_detail->upstream_mult_cost);
+
+ if ( $self->rated_granularity == 0 ) {
+ $charge += $rate_detail->min_cost;
+ } else {
+ my $minutes = $self->rated_seconds / 60;
+ $charge += $rate_detail->conn_cost + $minutes * $rate_detail->min_cost;
+ }
+
+ sprintf('%.2f', $charge + .00001 );
+
+}
+
=item cdr_termination [ TERMPART ]
=cut
=cut
+# in the future, load this dynamically from detail_format classes
+
my %export_names = (
'simple' => {
'name' => 'Simple',
'name' => 'Basic',
'invoice_header' => "Date/Time,Called Number,Min/Sec,Price",
},
+ 'basic_upstream_dst_regionname' => {
+ 'name' => 'Basic with upstream destination name',
+ 'invoice_header' => "Date/Time,Called Number,Destination,Min/Sec,Price",
+ },
'default' => {
'name' => 'Default',
'invoice_header' => 'Date,Time,Number,Destination,Duration,Price',
'name' => 'Number of calls, one line per service',
'invoice_header' => 'Caller,Rate,Messages,Price',
},
+ 'sum_duration' => {
+ 'name' => 'Summary, one line per service',
+ 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
+ },
'sum_duration_prefix' => {
'name' => 'Summary, one line per destination prefix',
'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
},
+ 'sum_count_class' => {
+ 'name' => 'Summary, one line per usage class',
+ 'invoice_header' => 'Caller,Class,Calls,Price',
+ },
+ 'sum_duration_accountcode' => {
+ 'name' => 'Summary, one line per accountcode',
+ 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price',
+ },
);
my %export_formats = ();
my $conf = new FS::Conf;
my $date_format = $conf->config('date_format') || '%m/%d/%Y';
- # call duration in the largest units that accurately reflect the granularity
+ # call duration in the largest units that accurately reflect the granularity
my $duration_sub = sub {
my($cdr, %opt) = @_;
my $sec = $opt{seconds} || $cdr->billsec;
}
+sub get_lrn {
+ my $self = shift;
+ my $field = shift;
+
+ my $ua = LWP::UserAgent->new(
+ 'ssl_opts' => {
+ verify_hostname => 0,
+ SSL_verify_mode => IO::Socket::SSL::SSL_VERIFY_NONE,
+ },
+ );
+
+ my $url = 'https://ws.freeside.biz/get_lrn';
+
+ my %content = ( 'support-key' => $support_key,
+ 'tn' => $self->get($field),
+ );
+ my $response = $ua->request( POST $url, \%content );
+
+ die "LRN service error: ". $response->message. "\n"
+ unless $response->is_success;
+
+ local $@;
+ my $data = eval { decode_json($response->content) };
+ die "LRN service JSON error : $@\n" if $@;
+
+ if ($data->{error}) {
+ die "acctid ".$self->acctid." $field LRN lookup failed:\n$data->{error}";
+ # for testing; later we should respect ignore_unrateable
+ } elsif ($data->{lrn}) {
+ # normal case
+ $self->set($field.'_lrn', $data->{lrn});
+ } else {
+ die "acctid ".$self->acctid." $field LRN lookup returned no number.\n";
+ }
+
+ return $data; # in case it's interesting somehow
+}
+
=back
=head1 CLASS METHODS
sub invoice_formats {
map { ($_ => $export_names{$_}->{'name'}) }
grep { $export_names{$_}->{'invoice_header'} }
- keys %export_names;
+ sort keys %export_names;
}
=item invoice_header FORMAT
my %cdr_info;
foreach my $INC ( @INC ) {
- warn "globbing $INC/FS/cdr/*.pm\n" if $DEBUG;
- foreach my $file ( glob("$INC/FS/cdr/*.pm") ) {
+ warn "globbing $INC/FS/cdr/[a-z]*.pm\n" if $DEBUG;
+ foreach my $file ( glob("$INC/FS/cdr/[a-z]*.pm") ) {
warn "attempting to load CDR format info from $file\n" if $DEBUG;
$file =~ /\/(\w+)\.pm$/ or do {
warn "unrecognized file in $INC/FS/cdr/: $file\n";
# optionally without seconds
($mon, $day, $year, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
$sec = 0 if !defined($sec);
- } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d+\.\d+)(\D|$)/ ) {
+ } elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})(\.\d+)$/ ) {
# broadsoft: 20081223201938.314
($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
} elsif ( $date =~ /^\s*(\d{4})(\d{2})(\d{2})(\d{2})(\d{2})(\d{2})\d+(\D|$)/ ) {
# WIP: 20100329121420
($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
} elsif ( $date =~ /^(\d{4})-(\d{2})-(\d{2})T(\d{2}):(\d{2}):(\d{2})Z$/) {
- # Telos
+ # Telos 2014-10-10T05:30:33Z
($year, $mon, $day, $hour, $min, $sec) = ( $1, $2, $3, $4, $5, $6 );
$options{gmt} = 1;
} else {
keys %cdr_info
},
- 'format_row_callbacks' => { map { $_ => $cdr_info{$_}->{'row_callback'}; }
- keys %cdr_info
- },
+ 'format_row_callbacks' =>
+ { map { $_ => $cdr_info{$_}->{'row_callback'}; }
+ keys %cdr_info
+ },
+
+ 'format_parser_opts' =>
+ { map { $_ => $cdr_info{$_}->{'parser_opt'}; }
+ keys %cdr_info
+ },
);
sub _import_options {
projects / freeside.git / blobdiff