X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fcdr.pm;h=a2b9a8ccbfd18c8bc48b0fdab830c622e1c4301b;hp=5e986ab50e2aa0dc5acc5ec376909adcfd25925b;hb=674cb2d9d7105f4cc2871539b2e9f7088cdaa750;hpb=db5e7f34b1e17ae6ce8909062537cc2fb98ca30d diff --git a/FS/FS/cdr.pm b/FS/FS/cdr.pm index 5e986ab50..a2b9a8ccb 100644 --- a/FS/FS/cdr.pm +++ b/FS/FS/cdr.pm @@ -92,6 +92,8 @@ following fields are currently supported: =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) @@ -159,6 +161,8 @@ following fields are currently supported: =item cdrbatch +=item detailnum - Link to invoice detail (L) + =back =head1 METHODS @@ -194,6 +198,7 @@ sub table_info { #'lastdata' => '', 'src_ip_addr' => 'Source IP', 'dst_ip_addr' => 'Dest. IP', + 'dst_term' => 'Termination dest.', 'startdate' => 'Start date', 'answerdate' => 'Answer date', 'enddate' => 'End date', @@ -211,6 +216,7 @@ sub table_info { #'upstream_rateplanid' => '', #'ratedetailnum' => '', 'rated_price' => 'Rated price', + 'rated_cost' => 'Rated cost', #'distance' => '', #'islocal' => '', #'calltypenum' => '', @@ -223,6 +229,7 @@ sub table_info { 'freesiderewritestatus' => 'Freeside rewrite status', 'cdrbatch' => 'Legacy batch', 'cdrbatchnum' => 'Batch', + 'detailnum' => 'Freeside invoice detail line', }, }; @@ -334,8 +341,12 @@ sub check { #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 # @@ -347,8 +358,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; } @@ -365,7 +374,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 @@ -426,12 +442,25 @@ sub set_charged_party { 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); - $self->replace; + 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 ... ] ] @@ -440,7 +469,9 @@ 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. +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. @@ -478,6 +509,8 @@ sub set_status_and_rated_price { 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(); } @@ -513,6 +546,9 @@ sub parse_number { 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(); @@ -561,25 +597,19 @@ sub parse_number { 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 (otehrwise 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 @@ -603,6 +633,7 @@ 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 @@ -630,14 +661,52 @@ sub rate_prefix { ); } + 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') ) + 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'; @@ -658,10 +727,6 @@ sub rate_prefix { #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'); if ( $intrastate_ratenum && !$self->is_tollfree ) { @@ -747,8 +812,8 @@ sub rate_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; @@ -775,9 +840,10 @@ sub rate_prefix { # 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 @@ -785,10 +851,15 @@ sub rate_prefix { # $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 @@ -828,11 +899,6 @@ sub rate_prefix { $seconds_left -= $charge_sec; - my $included_min = $opt{'region_group_included_min_hashref'} || {}; - - $included_min->{$regionnum}{$ratetimenum} = $rate_detail->min_included - unless exists $included_min->{$regionnum}{$ratetimenum}; - my $granularity = $rate_detail->sec_granularity; my $minutes; @@ -848,22 +914,55 @@ sub rate_prefix { $seconds_left = 0; } - $seconds += $charge_sec; - - - my $region_group = ($part_pkg->option_cacheable('min_included') || 0) > 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); + } - ${$opt{region_group_included_min}} -= $minutes - if $region_group && $rate_detail->region_group; + 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; + } - $included_min->{$regionnum}{$ratetimenum} -= $minutes; - if ( - $included_min->{$regionnum}{$ratetimenum} <= 0 - && ( ${$opt{region_group_included_min}} <= 0 - || ! $rate_detail->region_group - ) - ) - { + if ( $charge_sec > 0 ) { #NOW do connection charges here... right? #my $conn_seconds = min($seconds_left, $rate_detail->conn_sec); @@ -876,16 +975,13 @@ sub rate_prefix { } #should preserve (display?) this - my $charge_min = 0 - $included_min->{$regionnum}{$ratetimenum} - ( $conn_seconds / 60 ); - $included_min->{$regionnum}{$ratetimenum} = 0; - $charge += ($rate_detail->min_charge * $charge_min) if $charge_min > 0; #still not rounded - - } elsif ( ${$opt{region_group_included_min}} > 0 - && $region_group - && $rate_detail->region_group - ) - { - $included_min->{$regionnum}{$ratetimenum} = 0 + 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 @@ -902,13 +998,19 @@ sub rate_prefix { # 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? @@ -925,6 +1027,8 @@ sub rate_upstream_simple { sprintf('%.3f', $self->upstream_price), $opt{'svcnum'}, 'rated_classnum' => $self->calltypenum, + 'rated_seconds' => $self->billsec, + # others? upstream_*_regionname => rated_regionname is possible ); } @@ -951,12 +1055,12 @@ sub rate_single_price { 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 = @@ -973,6 +1077,36 @@ sub rate_single_price { } +=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 @@ -1082,6 +1216,8 @@ sub calltypename { =cut +# in the future, load this dynamically from detail_format classes + my %export_names = ( 'simple' => { 'name' => 'Simple', @@ -1100,6 +1236,10 @@ my %export_names = ( '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', @@ -1124,10 +1264,22 @@ my %export_names = ( '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 = (); @@ -1139,7 +1291,7 @@ 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; @@ -1329,7 +1481,7 @@ as keys (for use with part_pkg::voip_cdr) and "pretty" format names as values. sub invoice_formats { map { ($_ => $export_names{$_}->{'name'}) } grep { $export_names{$_}->{'invoice_header'} } - keys %export_names; + sort keys %export_names; } =item invoice_header FORMAT @@ -1408,8 +1560,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"; @@ -1498,7 +1650,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|$)/ ) { @@ -1508,7 +1660,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 { @@ -1588,9 +1740,15 @@ my %import_options = ( 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 {