X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcdr.pm;h=c4e9c47a350286d83415a41e8d47b081fed47b63;hp=65ca50b29e18c61a73d447797d63d9b47d57a0f6;hb=f822e27a1e00594332ffa487a1c284234c5580a6;hpb=8a76ec0177f2622ef393eba89f65c123a796502f diff --git a/FS/FS/cdr.pm b/FS/FS/cdr.pm index 65ca50b29..c4e9c47a3 100644 --- a/FS/FS/cdr.pm +++ b/FS/FS/cdr.pm @@ -1,12 +1,18 @@ package FS::cdr; use strict; -use vars qw( @ISA @EXPORT_OK $DEBUG $me ); +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 Tie::IxHash; use Date::Parse; use Date::Format; use Time::Local; +use List::Util qw( first min ); +use Text::CSV_XS; use FS::UID qw( dbh ); use FS::Conf; use FS::Record qw( qsearch qsearchs ); @@ -15,13 +21,37 @@ use FS::cdr_calltype; use FS::cdr_carrier; use FS::cdr_batch; use FS::cdr_termination; +use FS::rate; +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]'; +#ask FS::UID to run this stuff for us later +FS::UID->install_callback( sub { + $conf = new FS::Conf; + + my @cdr_prerate_cdrtypenums; + $cdr_prerate = $conf->exists('cdr-prerate'); + @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 FS::cdr - Object methods for cdr records @@ -69,6 +99,12 @@ following fields are currently supported: =item lastdata - Last application data +=item src_ip_addr - Source IP address (dotted quad, zero-filled) + +=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) @@ -130,12 +166,14 @@ following fields are currently supported: =item svcnum - Link to customer service (see L) -=item freesidestatus - NULL, done (or something) +=item freesidestatus - NULL, processing-tiered, rated, done, skipped, no-charge, failed -=item freesiderewritestatus - NULL, done (or something) +=item freesiderewritestatus - NULL, done, skipped =item cdrbatch +=item detailnum - Link to invoice detail (L) + =back =head1 METHODS @@ -169,6 +207,9 @@ sub table_info { 'dstchannel' => 'Destination channel', #'lastapp' => '', #'lastdata' => '', + 'src_ip_addr' => 'Source IP', + 'dst_ip_addr' => 'Dest. IP', + 'dst_term' => 'Termination dest.', 'startdate' => 'Start date', 'answerdate' => 'Answer date', 'enddate' => 'End date', @@ -185,7 +226,10 @@ sub table_info { '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' => '', @@ -198,6 +242,7 @@ sub table_info { 'freesiderewritestatus' => 'Freeside rewrite status', 'cdrbatch' => 'Legacy batch', 'cdrbatchnum' => 'Batch', + 'detailnum' => 'Freeside invoice detail line', }, }; @@ -301,12 +346,20 @@ sub check { $self->billsec( $self->enddate - $self->answerdate ); } + if ( ! $self->enddate && $self->startdate && $self->duration ) { + $self->enddate( $self->startdate + $self->duration ); + } + $self->set_charged_party; #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 # @@ -318,8 +371,6 @@ sub check { # # # Telstra =1, Optus = 2, RSL COM = 3 # || $self->ut_foreign_keyn('carrierid', 'cdr_carrier', 'carrierid' ) - ; - return $error if $error; $self->SUPER::check; } @@ -336,7 +387,14 @@ to inspect other field. 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 @@ -392,22 +450,54 @@ sub set_charged_party { } -=item set_status_and_rated_price STATUS [ RATED_PRICE [ SVCNUM ] ] +=item set_status STATUS Sets the status to the provided string. If there is an error, returns the error, otherwise returns false. +If status is being changed from 'rated' to some other status, also removes +any usage allocations to this CDR. + +=cut + +sub set_status { + my($self, $status) = @_; + my $old_status = $self->freesidestatus; + $self->freesidestatus($status); + my $error = $self->replace; + if ( $old_status eq 'rated' and $status ne 'done' ) { + # deallocate any usage + foreach (qsearch('cdr_cust_pkg_usage', {acctid => $self->acctid})) { + my $cust_pkg_usage = $_->cust_pkg_usage; + $cust_pkg_usage->set('minutes', $cust_pkg_usage->minutes + $_->minutes); + $error ||= $cust_pkg_usage->replace || $_->delete; + } + } + $error; +} + +=item set_status_and_rated_price STATUS RATED_PRICE [ SVCNUM [ OPTION => VALUE ... ] ] + +Sets the status and rated price. + +Available options are: inbound, rated_pretty_dst, rated_regionname, +rated_seconds, rated_minutes, rated_granularity, rated_ratedetailnum, +rated_classnum, rated_ratename. If rated_ratedetailnum is provided, +will also set a recalculated L 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. + =cut sub set_status_and_rated_price { my($self, $status, $rated_price, $svcnum, %opt) = @_; - if($opt{'inbound'}) { - my $term = qsearchs('cdr_termination', { - acctid => $self->acctid, - termpart => 1 # inbound - }); + + if ($opt{'inbound'}) { + + my $term = $self->cdr_termination( 1 ); #1: inbound my $error; - if($term) { + if ( $term ) { warn "replacing existing cdr status (".$self->acctid.")\n" if $term; $error = $term->delete; return $error if $error; @@ -417,16 +507,659 @@ sub set_status_and_rated_price { termpart => 1, rated_price => $rated_price, status => $status, - svcnum => $svcnum, }); + foreach (qw(rated_seconds rated_minutes rated_granularity)) { + $term->set($_, $opt{$_}) if exists($opt{$_}); + } + $term->svcnum($svcnum) if $svcnum; return $term->insert; - } - else { + + } else { + $self->freesidestatus($status); $self->rated_price($rated_price); + $self->$_($opt{$_}) + foreach grep exists($opt{$_}), map "rated_$_", + 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(); + + } +} + +=item parse_number [ OPTION => VALUE ... ] + +Returns two scalars, the countrycode and the rest of the number. + +Options are passed as name-value pairs. Currently available options are: + +=over 4 + +=item column + +The column containing the number to be parsed. Defaults to dst. + +=item international_prefix + +The digits for international dialing. Defaults to '011' The value '+' is +always recognized. + +=item domestic_prefix + +The digits for domestic long distance dialing. Defaults to '1' + +=back + +=cut + +sub parse_number { + my ($self, %options) = @_; + + 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(); + + my $to_or_from = 'concerning'; + $to_or_from = 'from' if $field eq 'src'; + $to_or_from = 'to' if $field eq 'dst'; + warn "parsing call $to_or_from $number\n" if $DEBUG; + + #remove non-phone# stuff and whitespace + $number =~ s/\s//g; +# my $proto = ''; +# $dest =~ s/^(\w+):// and $proto = $1; #sip: +# my $siphost = ''; +# $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com + + if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/ + || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/ + ) + { + + my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 ); + #first look for 1 digit country code + if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) { + $countrycode = $one; + $number = $u1.$u2.$rest; + } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2 + $countrycode = $two; + $number = $u2.$rest; + } else { #3 digit country code + $countrycode = $three; + $number = $rest; + } + + } else { + my $domestic_prefix = + exists($options{domestic_prefix}) ? $options{domestic_prefix} : ''; + $countrycode = length($domestic_prefix) ? $domestic_prefix : '1'; + $number =~ s/^$countrycode//;# if length($number) > 10; + } + + return($countrycode, $number); + +} + +=item rate [ OPTION => VALUE ... ] + +Rates this CDR according and sets the status to 'rated'. + +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. + +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. + +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 + +sub rate { + my( $self, %opt ) = @_; + my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified"; + + if ( $DEBUG > 1 ) { + warn "rating CDR $self\n". + join('', map { " $_ => ". $self->{$_}. "\n" } keys %$self ); } + + my $rating_method = $part_pkg->option_cacheable('rating_method') || 'prefix'; + my $method = "rate_$rating_method"; + $self->$method(%opt); +} + +#here? +our %interval_cache = (); # for timed rates + +sub rate_prefix { + my( $self, %opt ) = @_; + my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified"; + my $cust_pkg = $opt{'cust_pkg'}; + + my $da_rewrote = 0; + # this will result in those CDRs being marked as done... is that + # what we want? + my @dirass = (); + if ( $part_pkg->option_cacheable('411_rewrite') ) { + my $dirass = $part_pkg->option_cacheable('411_rewrite'); + $dirass =~ s/\s//g; + @dirass = split(',', $dirass); + } + + if ( length($self->dst) && grep { $self->dst eq $_ } @dirass ) { + $self->dst('411'); + $da_rewrote = 1; + } + + my $reason = $part_pkg->check_chargable( $self, + 'da_rewrote' => $da_rewrote, + ); + if ( $reason ) { + warn "not charging for CDR ($reason)\n" if $DEBUG; + return $self->set_status_and_rated_price( 'skipped', + 0, + $opt{'svcnum'}, + ); + } + + if ( $part_pkg->option_cacheable('skip_same_customer') + and ! $self->is_tollfree ) { + my ($dst_countrycode, $dst_number) = $self->parse_number( + column => 'dst', + international_prefix => $part_pkg->option_cacheable('international_prefix'), + domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'), + ); + my $dst_same_cust = FS::Record->scalar_sql( + 'SELECT COUNT(svc_phone.svcnum) AS count '. + 'FROM cust_pkg ' . + 'JOIN cust_svc USING (pkgnum) ' . + 'JOIN svc_phone USING (svcnum) ' . + 'WHERE svc_phone.countrycode = ' . dbh->quote($dst_countrycode) . + ' AND svc_phone.phonenum = ' . dbh->quote($dst_number) . + ' AND cust_pkg.custnum = ' . $cust_pkg->custnum, + ); + if ( $dst_same_cust > 0 ) { + warn "not charging for CDR (same source and destination customer)\n" if $DEBUG; + return $self->set_status_and_rated_price( 'skipped', + 0, + $opt{'svcnum'}, + ); + } + } + + ### + # 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') + ) + or ( $eff_ratenum + && $part_pkg->option_cacheable('accountcode_tollfree_field') eq 'src' + ) + ) + { #tollfree call + $to_or_from = 'from'; + $column = 'src'; + } else { #regular call + $to_or_from = 'to'; + $column = 'dst'; + } + + #determine the country code + my ($countrycode, $number) = $self->parse_number( + column => $column, + international_prefix => $part_pkg->option_cacheable('international_prefix'), + 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; + + # should check $countrycode eq '1' here? + if ( $intrastate_ratenum && !$self->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 $dst_col = $use_lrn ? 'dst_lrn' : 'dst'; + my $src_col = $use_lrn ? 'src_lrn' : 'src'; + my (undef, $dstprefix) = $self->parse_number( + column => $dst_col, + international_prefix => $part_pkg->option_cacheable('international_prefix'), + domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'), + ); + $dstprefix =~ /^(\d{6})/; + $dstprefix = qsearchs('rate_prefix', { 'countrycode' => '1', + 'npa' => $1, + }) || ''; + my (undef, $srcprefix) = $self->parse_number( + column => $src_col, + international_prefix => $part_pkg->option_cacheable('international_prefix'), + domestic_prefix => $part_pkg->option_cacheable('domestic_prefix'), + ); + $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? + } + } + + $eff_ratenum ||= $part_pkg->option_cacheable('ratenum'); + my $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum }) + or die "ratenum $eff_ratenum not found!"; + + my @ltime = localtime($self->startdate); + my $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... + my $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode, + 'phonenum' => $number, + 'weektime' => $weektime, + 'cdrtypenum' => $self->cdrtypenum, + }); + + unless ( $rate_detail ) { + + if ( $part_pkg->option_cacheable('ignore_unrateable') ) { + + if ( $part_pkg->option_cacheable('ignore_unrateable') == 2 ) { + # mark the CDR as unrateable + return $self->set_status_and_rated_price( + 'failed', + '', + $opt{'svcnum'}, + ); + } elsif ( $part_pkg->option_cacheable('ignore_unrateable') == 1 ) { + # warn and continue + warn "no rate_detail found for CDR.acctid: ". $self->acctid. + "; skipping\n"; + return ''; + + } else { + die "unknown ignore_unrateable, pkgpart ". $part_pkg->pkgpart; + } + + } else { + + die "FATAL: no rate_detail found in ". + $rate->ratenum. ":". $rate->ratename. " rate plan ". + "for +$countrycode $number (CDR acctid ". $self->acctid. "); ". + "add a rate or set ignore_unrateable flag on the package def\n"; + } + + } + + my $regionnum = $rate_detail->dest_regionnum; + my $rate_region = $rate_detail->dest_region; + warn " found rate for regionnum $regionnum ". + "and rate detail $rate_detail\n" + if $DEBUG; + + if ( !exists($interval_cache{$regionnum}) ) { + my @intervals = ( + sort { $a->stime <=> $b->stime } + map { $_->rate_time->intervals } + qsearch({ 'table' => 'rate_detail', + 'hashref' => { 'ratenum' => $rate->ratenum }, + 'extra_sql' => 'AND ratetimenum IS NOT NULL', + }) + ); + $interval_cache{$regionnum} = \@intervals; + warn " cached ".scalar(@intervals)." interval(s)\n" + if $DEBUG; + } + + ### + # find the price and add detail to the invoice + ### + + # About this section: + # We don't round _anything_ (except granularizing) + # until the final $charge = sprintf("%.2f"...). + + 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 + # my $seconds = min($seconds_left, $rate_detail->conn_sec); + # $seconds_left -= $seconds; + # $weektime += $seconds; + # my $charge = $rate_detail->conn_charge; + #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 + + # 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); + + $seconds_left -= $charge_sec; + + my $granularity = $rate_detail->sec_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; + } + + #$seconds += $charge_sec; + + if ( $rate_detail->min_included ) { + # 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 + if (!exists( $included_min->{$regionnum}{$ratetimenum} )) { + $included_min->{$regionnum}{$ratetimenum} = + ($rate_detail->min_included * $cust_pkg->quantity || 1); + } + + 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( + 'cdr' => $self, + 'rate_detail' => $rate_detail, + 'minutes' => $minutes + ); + # for now, usage pools deal only in whole minutes + $charge_sec -= $applied_min * 60; + } + + if ( $charge_sec > 0 ) { + + #NOW do connection charges here... right? + #my $conn_seconds = min($seconds_left, $rate_detail->conn_sec); + my $conn_seconds = 0; + unless ( $connection_charged++ ) { #only one connection charge + $conn_seconds = min($charge_sec, $rate_detail->conn_sec); + $seconds_left -= $conn_seconds; + $weektime += $conn_seconds; + $charge += $rate_detail->conn_charge; + } + + #should preserve (display?) this + 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 + } + + } + + # choose next rate_detail + $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode, + 'phonenum' => $number, + 'weektime' => $etime, + 'cdrtypenum' => $self->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; + + # 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', + $price, + $opt{'svcnum'}, + 'rated_pretty_dst' => $pretty_dst, + '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? + 'rated_ratename' => $ratename, #not rate_detail - Intrastate/Interstate + ); + +} + +sub rate_upstream_simple { + my( $self, %opt ) = @_; + + $self->set_status_and_rated_price( + 'rated', + sprintf('%.3f', $self->upstream_price), + $opt{'svcnum'}, + 'rated_classnum' => $self->calltypenum, + 'rated_seconds' => $self->billsec, + # others? upstream_*_regionname => rated_regionname is possible + ); +} + +sub rate_single_price { + my( $self, %opt ) = @_; + my $part_pkg = $opt{'part_pkg'} or return "No part_pkg specified"; + + # a little false laziness w/abov + # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ? + + my $granularity = length($part_pkg->option_cacheable('sec_granularity')) + ? $part_pkg->option_cacheable('sec_granularity') + : 60; + + my $seconds = $part_pkg->option_cacheable('use_duration') + ? $self->duration + : $self->billsec; + + $seconds += $granularity - ( $seconds % $granularity ) + if $seconds # don't granular-ize 0 billsec calls (bills them) + && $granularity # 0 is per call + && $seconds % $granularity; + my $minutes = $granularity ? ($seconds / 60) : 1; + + my $charge_min = $minutes; + + ${$opt{plan_included_min}} -= $minutes; + if ( ${$opt{plan_included_min}} > 0 ) { + $charge_min = 0; + } else { + $charge_min = 0 - ${$opt{plan_included_min}}; + ${$opt{plan_included_min}} = 0; + } + + my $charge = + sprintf('%.4f', ( $part_pkg->option_cacheable('min_charge') * $charge_min ) + + 0.0000000001 ); #so 1.00005 rounds to 1.0001 + + $self->set_status_and_rated_price( + 'rated', + $charge, + $opt{'svcnum'}, + 'rated_granularity' => $granularity, + 'rated_seconds' => $seconds, + ); + +} + +=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 + +sub cdr_termination { + my $self = shift; + + if ( scalar(@_) && $_[0] ) { + my $termpart = shift; + + qsearchs('cdr_termination', { acctid => $self->acctid, + termpart => $termpart, + } + ); + + } else { + + qsearch('cdr_termination', { acctid => $self->acctid, } ); + + } + } =item calldate_unix @@ -515,6 +1248,8 @@ sub calltypename { =cut +# in the future, load this dynamically from detail_format classes + my %export_names = ( 'simple' => { 'name' => 'Simple', @@ -525,10 +1260,18 @@ my %export_names = ( 'invoice_header' => "Date,Time,Called From,Destination,Duration,Price", #"Date,Time,Name,Called From,Destination,Duration,Price", }, + 'accountcode_simple' => { + 'name' => 'Simple with accountcode', + 'invoice_header' => "Date,Time,Called From,Account,Duration,Price", + }, 'basic' => { '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', @@ -541,6 +1284,34 @@ my %export_names = ( 'name' => 'Default plus accountcode', 'invoice_header' => 'Date,Time,Account,Number,Destination,Duration,Price', }, + 'description_default' => { + 'name' => 'Default with description field as destination', + 'invoice_header' => 'Caller,Date,Time,Number,Destination,Duration,Price', + }, + 'sum_duration' => { + 'name' => 'Summary, one line per service', + 'invoice_header' => 'Caller,Rate,Calls,Minutes,Price', + }, + 'sum_count' => { + '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 = (); @@ -552,15 +1323,15 @@ sub 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; - if ( length($opt{granularity}) && + if ( defined $opt{granularity} && $opt{granularity} == 0 ) { #per call return '1 call'; } - elsif ( $opt{granularity} == 60 ) {#full minutes + elsif ( defined $opt{granularity} && $opt{granularity} == 60 ) {#full minutes my $min = int($sec/60); $min++ if $sec%60; return $min.'m'; @@ -570,6 +1341,24 @@ sub export_formats { } }; + my $price_sub = sub { + my ($cdr, %opt) = @_; + my $price; + if ( defined($opt{charge}) ) { + $price = $opt{charge}; + } + elsif ( $opt{inbound} ) { + my $term = $cdr->cdr_termination(1); # 1 = inbound + $price = $term->rated_price if defined $term; + } + else { + $price = $cdr->rated_price; + } + length($price) ? ($opt{money_char} . $price) : ''; + }; + + my $src_sub = sub { $_[0]->clid || $_[0]->src }; + %export_formats = ( 'simple' => [ sub { time2str($date_format, shift->calldate_unix ) }, #DATE @@ -578,23 +1367,46 @@ sub export_formats { 'dst', #NUMBER_DIALED $duration_sub, #DURATION #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE - sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE + $price_sub, ], 'simple2' => [ sub { time2str($date_format, shift->calldate_unix ) }, #DATE sub { time2str('%r', shift->calldate_unix ) }, #TIME #'userfield', #USER - 'src', #called from + $src_sub, #called from 'dst', #NUMBER_DIALED $duration_sub, #DURATION #sub { sprintf('%.3f', shift->upstream_price ) }, #PRICE - sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE + $price_sub, + ], + 'accountcode_simple' => [ + sub { time2str($date_format, shift->calldate_unix ) }, #DATE + sub { time2str('%r', shift->calldate_unix ) }, #TIME + $src_sub, #called from + 'accountcode', #NUMBER_DIALED + $duration_sub, #DURATION + $price_sub, + ], + 'sum_duration' => [ + # for summary formats, the CDR is a fictitious object containing the + # total billsec and the phone number of the service + $src_sub, + sub { my($cdr, %opt) = @_; $opt{ratename} }, + sub { my($cdr, %opt) = @_; $opt{count} }, + sub { my($cdr, %opt) = @_; int($opt{seconds}/60).'m' }, + $price_sub, + ], + 'sum_count' => [ + $src_sub, + sub { my($cdr, %opt) = @_; $opt{ratename} }, + sub { my($cdr, %opt) = @_; $opt{count} }, + $price_sub, ], 'basic' => [ sub { time2str('%d %b - %I:%M %p', shift->calldate_unix) }, 'dst', $duration_sub, - sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, #PRICE + $price_sub, ], 'default' => [ @@ -616,20 +1428,44 @@ sub export_formats { $duration_sub, #PRICE - sub { my($cdr, %opt) = @_; $opt{money_char}. $opt{charge}; }, - + $price_sub, ], ); - $export_formats{'source_default'} = [ 'src', @{ $export_formats{'default'} }, ]; + $export_formats{'source_default'} = [ $src_sub, @{ $export_formats{'default'} }, ]; $export_formats{'accountcode_default'} = [ @{ $export_formats{'default'} }[0,1], 'accountcode', @{ $export_formats{'default'} }[2..5], ]; + my @default = @{ $export_formats{'default'} }; + $export_formats{'description_default'} = + [ $src_sub, @default[0..2], + sub { my($cdr, %opt) = @_; $cdr->description }, + @default[4,5] ]; - %export_formats + return %export_formats; } +=item downstream_csv OPTION => VALUE ... + +Returns a string of formatted call details for display on an invoice. + +Options: + +format + +charge - override the 'rated_price' field of the CDR + +seconds - override the 'billsec' field of the CDR + +count - number of usage events included in this record, for summary formats + +ratename - name of the rate table used to rate this call + +granularity + +=cut + sub downstream_csv { my( $self, %opt ) = @_; @@ -641,8 +1477,6 @@ sub downstream_csv { #$opt{'money_char'} ||= $conf->config('money_char') || '$'; $opt{'money_char'} ||= FS::Conf->new->config('money_char') || '$'; - eval "use Text::CSV_XS;"; - die $@ if $@; my $csv = new Text::CSV_XS; my @columns = @@ -651,6 +1485,8 @@ sub downstream_csv { } @{ $formats{$format} }; + return @columns if defined $opt{'keeparray'}; + my $status = $csv->combine(@columns); die "FS::CDR: error combining ". $csv->error_input(). "into downstream CSV" unless $status; @@ -659,6 +1495,44 @@ sub downstream_csv { } +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 @@ -672,10 +1546,12 @@ as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values. =cut +# in the future, load this dynamically from detail_format classes + sub invoice_formats { map { ($_ => $export_names{$_}->{'name'}) } grep { $export_names{$_}->{'invoice_header'} } - keys %export_names; + sort keys %export_names; } =item invoice_header FORMAT @@ -698,6 +1574,7 @@ CDR reprocessing. sub clear_status { my $self = shift; + my %opt = @_; local $SIG{HUP} = 'IGNORE'; local $SIG{INT} = 'IGNORE'; @@ -710,21 +1587,30 @@ sub clear_status { local $FS::UID::AutoCommit = 0; my $dbh = dbh; - $self->freesidestatus(''); + if ( $cdr_prerate && $cdr_prerate_cdrtypenums{$self->cdrtypenum} + && $self->rated_ratedetailnum #avoid putting old CDRs back in "rated" + && $self->freesidestatus eq 'done' + && ! $opt{'rerate'} + ) + { #special case + $self->freesidestatus('rated'); + } else { + $self->freesidestatus(''); + } + my $error = $self->replace; if ( $error ) { $dbh->rollback if $oldAutoCommit; return $error; } - my @cdr_termination = qsearch('cdr_termination', - { 'acctid' => $self->acctid } ); - foreach my $cdr_termination ( @cdr_termination ) { - $cdr_termination->status(''); - $error = $cdr_termination->replace; + foreach my $cdr_termination ( $self->cdr_termination ) { + #$cdr_termination->status(''); + #$error = $cdr_termination->replace; + $error = $cdr_termination->delete; if ( $error ) { - $dbh->rollback if $oldAutoCommit; - return $error; + $dbh->rollback if $oldAutoCommit; + return $error; } } @@ -744,8 +1630,8 @@ as keys (for use with batch_import) and "pretty" format names as values. 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"; @@ -834,7 +1720,7 @@ sub _cdr_date_parse { # 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|$)/ ) { @@ -844,7 +1730,7 @@ sub _cdr_date_parse { # 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 { @@ -897,7 +1783,7 @@ my %import_options = ( }, #drop the || 'csv' to allow auto xls for csv types? - 'format_types' => { map { $_ => ( lc($cdr_info{$_}->{'type'}) || 'csv' ); } + 'format_types' => { map { $_ => lc($cdr_info{$_}->{'type'} || 'csv'); } keys %cdr_info }, @@ -919,9 +1805,20 @@ my %import_options = ( keys %cdr_info }, - 'format_row_callbacks' => { map { $_ => $cdr_info{$_}->{'row_callback'}; } - keys %cdr_info - }, + 'format_asn_formats' => + { map { $_ => $cdr_info{$_}->{'asn_format'}; } + 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 { @@ -934,6 +1831,14 @@ sub batch_import { my $iopt = _import_options; $opt->{$_} = $iopt->{$_} foreach keys %$iopt; + if ( defined $opt->{'cdrtypenum'} ) { + $opt->{'preinsert_callback'} = sub { + my($record,$param) = (shift,shift); + $record->cdrtypenum($opt->{'cdrtypenum'}); + ''; + }; + } + FS::Record::batch_import( $opt ); } @@ -991,6 +1896,31 @@ sub _upgrade_data { } +=item ip_addr_sql FIELD RANGE + +Returns an SQL condition to search for CDRs with an IP address +within RANGE. FIELD is either 'src_ip_addr' or 'dst_ip_addr'. RANGE +should be in the form "a.b.c.d-e.f.g.h' (dotted quads), where any of +the leftmost octets of the second address can be omitted if they're +the same as the first address. + +=cut + +sub ip_addr_sql { + my $class = shift; + my ($field, $range) = @_; + $range =~ /^[\d\.-]+$/ or die "bad ip address range '$range'"; + my @r = split('-', $range); + my @saddr = split('\.', $r[0] || ''); + my @eaddr = split('\.', $r[1] || ''); + unshift @eaddr, (undef) x (4 - scalar @eaddr); + for(0..3) { + $eaddr[$_] = $saddr[$_] if !defined $eaddr[$_]; + } + "$field >= '".sprintf('%03d.%03d.%03d.%03d', @saddr) . "' AND ". + "$field <= '".sprintf('%03d.%03d.%03d.%03d', @eaddr) . "'"; +} + =back =head1 BUGS