X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fvoip_cdr.pm;h=003a3f3a9bda5535968b12fe8d4854b835b5300a;hb=99305e66f7e7a5cc16a35694f57a6adb49691625;hp=929a2d7257527ce9b57a521ce75efba5ebcb7dcb;hpb=2b7f02dec42a7b63cb66f6521eaddd2ea54f9b57;p=freeside.git diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm index 929a2d725..003a3f3a9 100644 --- a/FS/FS/part_pkg/voip_cdr.pm +++ b/FS/FS/part_pkg/voip_cdr.pm @@ -4,30 +4,31 @@ use strict; use vars qw(@ISA $DEBUG %info); use Date::Format; use Tie::IxHash; -use Time::Local; use FS::Conf; use FS::Record qw(qsearchs qsearch); -use FS::part_pkg::flat; +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::prorate); +use List::Util qw(first min); -$DEBUG = 0; +@ISA = qw(FS::part_pkg::recur_Common); + +$DEBUG = 1; + +tie my %cdr_svc_method, 'Tie::IxHash', + 'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)', + 'svc_pbx.title' => 'PBX name (svc_pbx.title)', +; tie my %rating_method, 'Tie::IxHash', 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables', # 'upstream' => 'Rate calls based on upstream data: If the call type is "1", map the upstream rate ID directly to an internal rate (rate_detail), otherwise, pass the upstream price through directly.', 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.', - 'flat' => 'A single price per minute for all calls.', -; - -tie my %recur_method, 'Tie::IxHash', - 'anniversary' => 'Charge the recurring fee at the frequency specified above', - 'prorate' => 'Charge a prorated fee the first time (selectable billing date)', - 'subscription' => 'Charge the full fee for the first partial period (selectable billing date)', + 'single_price' => 'A single price per minute for all calls.', ; #tie my %cdr_location, 'Tie::IxHash', @@ -41,6 +42,8 @@ tie my %temporalities, 'Tie::IxHash', 'preceding' => "Preceding (past)", ; +tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); + %info = ( 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table', 'shortname' => 'VoIP/telco CDR rating (standard)', @@ -72,10 +75,15 @@ tie my %temporalities, 'Tie::IxHash', #'type' => 'radio', #'options' => \%recur_method, 'type' => 'select', - 'select_options' => \%recur_method, + 'select_options' => \%FS::part_pkg::recur_Common::recur_method, }, - 'rating_method' => { 'name' => 'Region rating 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, }, @@ -87,6 +95,14 @@ tie my %temporalities, 'Tie::IxHash', 'select_label' => 'ratename', }, + 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method', + }, + + 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method', + 'type' => 'select', + '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', }, @@ -139,6 +155,23 @@ tie my %temporalities, 'Tie::IxHash', '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 and 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:', }, @@ -152,19 +185,25 @@ tie my %temporalities, 'Tie::IxHash', '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ', }, + #false laziness w/cdr_termination.pm 'output_format' => { 'name' => 'CDR invoice display format', 'type' => 'select', 'select_options' => { FS::cdr::invoice_formats() }, 'default' => 'default', #XXX test }, - 'usage_section' => { 'name' => 'Section in which to place separate usage charges', + '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', 'type' => 'checkbox', }, + 'usage_mandate' => { 'name' => 'Always put usage details in separate section', + 'type' => 'checkbox', + }, + #eofalse + 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.', 'type' => 'checkbox', }, @@ -200,7 +239,9 @@ tie my %temporalities, 'Tie::IxHash', 'fieldorder' => [qw( setup_fee recur_fee recur_temporality unused_credit recur_method cutoff_day - rating_method ratenum ignore_unrateable + cdr_svc_method + rating_method ratenum min_charge sec_granularity + ignore_unrateable default_prefix disable_src domestic_prefix international_prefix @@ -208,10 +249,12 @@ tie my %temporalities, 'Tie::IxHash', use_amaflags use_disposition use_disposition_taqua use_carrierid use_cdrtypenum skip_dcontext skip_dstchannel_prefix + skip_src_length_more noskip_src_length_accountcode_tollfree + accountcode_tollfree_ratenum skip_dst_length_less skip_lastapp use_duration 411_rewrite - output_format summarize_usage usage_section + output_format usage_mandate summarize_usage usage_section bill_every_call count_available_phones ) @@ -224,11 +267,32 @@ sub calc_setup { $self->option('setup_fee'); } -#false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again sub calc_recur { my $self = shift; my($cust_pkg, $sdate, $details, $param ) = @_; + my $charges = 0; + + $charges += $self->calc_usage(@_); + $charges += $self->calc_recur_Common(@_); + + $charges; + +} + +sub calc_cancel { + my $self = shift; + my($cust_pkg, $sdate, $details, $param ) = @_; + + $self->calc_usage(@_); +} + +#false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again + +sub calc_usage { + my $self = shift; + my($cust_pkg, $sdate, $details, $param ) = @_; + #my $last_bill = $cust_pkg->last_bill; my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup @@ -246,6 +310,7 @@ sub calc_recur { # my $downstream_cdr = ''; + my $cdr_svc_method = $self->option('cdr_svc_method')||'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'); @@ -266,6 +331,8 @@ sub calc_recur { @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 = (); @@ -273,14 +340,19 @@ sub calc_recur { die $@ if $@; my $csv = new Text::CSV_XS; + my($svc_table, $svc_field) = split('\.', $cdr_svc_method); + foreach my $cust_svc ( - grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc + grep { $_->part_svc->svcdb eq $svc_table } $cust_pkg->cust_svc ) { + my $svc_x = $cust_svc->svc_x; foreach my $cdr ( - $cust_svc->get_cdrs_for_update( + $svc_x->get_cdrs( 'disable_src' => $self->option('disable_src'), 'default_prefix' => $self->option('default_prefix'), + 'status' => '', + 'for_update' => 1, ) # $last_bill, $$sdate ) ) { if ( $DEBUG > 1 ) { @@ -290,9 +362,16 @@ sub calc_recur { my $rate_detail; my( $rate_region, $regionnum ); + my $rate; my $pretty_destnum; my $charge = ''; + my $seconds = ''; + my $weektime = ''; + my $regionname = ''; my $classnum = ''; + my $countrycode; + my $number; + my @call_details = (); if ( $rating_method eq 'prefix' ) { @@ -319,7 +398,7 @@ sub calc_recur { # (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'; @@ -339,7 +418,7 @@ sub calc_recur { # $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+)$/ ) @@ -365,22 +444,49 @@ sub calc_recur { warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG; $pretty_destnum = "+$countrycode $number"; - - my $rate = qsearchs('rate', { 'ratenum' => $ratenum }) - or die "ratenum $ratenum not found!"; - + #asterisks here causes inserting the detail to barf, so: + $pretty_destnum =~ s/\*//g; + + my $eff_ratenum = $cdr->is_tollfree('accountcode') + ? $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum') + : ''; + $eff_ratenum ||= $ratenum; + $rate = qsearchs('rate', { 'ratenum' => $eff_ratenum }) + or die "ratenum $eff_ratenum not found!"; + + my @ltime = localtime($cdr->startdate); + $weektime = $ltime[0] + + $ltime[1]*60 + #minutes + $ltime[2]*3600 + #hours + $ltime[6]*86400; #days since sunday + # if there's no timed rate_detail for this time/region combination, + # dest_detail returns the default. There may still be a timed rate + # that applies after the starttime of the call, so be careful... $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode, 'phonenum' => $number, + 'weektime' => $weektime, }); if ( $rate_detail ) { $rate_region = $rate_detail->dest_region; $regionnum = $rate_region->regionnum; + $regionname = $rate_region->regionname; 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 { 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 = ''; @@ -415,6 +521,7 @@ sub calc_recur { # } else { #pass upstream price through # # $charge = sprintf('%.2f', $cdr->upstream_price); +# warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG; # $charges += $charge; # # @call_details = ( @@ -433,6 +540,7 @@ sub calc_recur { #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, @@ -440,6 +548,37 @@ sub calc_recur { ); $classnum = $cdr->calltypenum; + } elsif ( $rating_method eq 'single_price' ) { + + # a little false laziness w/below + + 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 ) + + 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, + ) + ); + } else { die "don't know how to rate CDRs using method: $rating_method\n"; } @@ -462,61 +601,146 @@ sub calc_recur { unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) { - $included_min{$regionnum} = $rate_detail->min_included - unless exists $included_min{$regionnum}; + my $seconds_left = $use_duration ? $cdr->duration : $cdr->billsec; + # charge for the first (conn_sec) seconds + $seconds = min($seconds_left, $rate_detail->conn_sec); + $seconds_left -= $seconds; + $weektime += $seconds; + $charge = sprintf("%.02f", $rate_detail->conn_charge); + + my $total_minutes = 0; + my $whole_minutes = 1; + my $etime; + while($seconds_left) { + my $ratetimenum = $rate_detail->ratetimenum; # may be empty + + # find the end of the current rate interval + if(@{ $interval_cache{$regionnum} } == 0) { + # There are no timed rates in this group, so just stay + # in the default rate_detail for the entire duration. + # Set an "end" of 1 past the end of the current call. + $etime = $weektime + $seconds_left + 1; + } + elsif($ratetimenum) { + # This is a timed rate, so go to the etime of this interval. + # If it's followed by another timed rate, the stime of that + # interval should match the etime of this one. + my $interval = $rate_detail->rate_time->contains($weektime); + $etime = $interval->etime; + } + else { + # This is a default rate, so use the stime of the next + # interval in the sequence. + my $next_int = first { $_->stime > $weektime } + @{ $interval_cache{$regionnum} }; + if ($next_int) { + $etime = $next_int->stime; + } + else { + # weektime is near the end of the week, so decrement + # it by a full week and use the stime of the first + # interval. + $weektime -= (3600*24*7); + $etime = $interval_cache{$regionnum}->[0]->stime; + } + } - my $granularity = $rate_detail->sec_granularity; + my $charge_sec = min($seconds_left, $etime - $weektime); - # length($cdr->billsec) ? $cdr->billsec : $cdr->duration; - my $seconds = $use_duration ? $cdr->duration : $cdr->billsec; + $seconds_left -= $charge_sec; - $seconds += $granularity - ( $seconds % $granularity ) - if $seconds # don't granular-ize 0 billsec calls (bills them) - && $granularity; # 0 is per call - my $minutes = sprintf("%.1f", $seconds / 60); - $minutes =~ s/\.0$// if $granularity == 60; + $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included + unless exists $included_min{$regionnum}{$ratetimenum}; - # per call rather than per minute - $minutes = 1 unless $granularity; + my $granularity = $rate_detail->sec_granularity; + $whole_minutes = 0 if $granularity; - $included_min{$regionnum} -= $minutes; + # should this be done in every rate interval? + $charge_sec += $granularity - ( $charge_sec % $granularity ) + if $charge_sec # don't granular-ize 0 billsec calls (bills them) + && $granularity; # 0 is per call + my $minutes = sprintf("%.1f", $charge_sec / 60); + $minutes =~ s/\.0$// if $granularity == 60; - if ( $included_min{$regionnum} < 0 ) { - my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve - #(display?) this - $included_min{$regionnum} = 0; - $charge = sprintf('%.2f', ( $rate_detail->min_charge * $charge_min ) - + 0.00000001 ); #so 1.005 rounds to 1.01 - $charges += $charge; - } + $seconds += $charge_sec; + + # per call rather than per minute + $minutes = 1 unless $granularity; + $seconds_left = 0 unless $granularity; + + $included_min{$regionnum}{$ratetimenum} -= $minutes; + + if ( $included_min{$regionnum}{$ratetimenum} <= 0 ) { + my $charge_min = 0 - $included_min{$regionnum}{$ratetimenum}; #XXX should preserve + #(display?) this + $included_min{$regionnum}{$ratetimenum} = 0; + $charge += sprintf('%.2f', ($rate_detail->min_charge * $charge_min) + + 0.00000001 ); #so 1.005 rounds to 1.01 + } + + # choose next rate_detail + $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode, + 'phonenum' => $number, + 'weektime' => $etime }) + if($seconds_left); + # we have now moved forward to $etime + $weektime = $etime; + } #while $seconds_left # this is why we need regionnum/rate_region.... warn " (rate region $rate_region)\n" if $DEBUG; - @call_details = ( - $cdr->downstream_csv( 'format' => $output_format, - 'granularity' => $granularity, - 'minutes' => $minutes, - 'charge' => $charge, - 'pretty_dst' => $pretty_destnum, - 'dst_regionname' => $rate_region->regionname, - ) - ); + $total_minutes = sprintf("%.1f", $seconds / 60); + $total_minutes =~ s/\.0$// if $whole_minutes; $classnum = $rate_detail->classnum; + $charge = sprintf('%.2f', $charge); - } + @call_details = ( + $cdr->downstream_csv( 'format' => $output_format, + 'granularity' => $rate_detail->sec_granularity, + 'minutes' => $total_minutes, + # why do we go through this hocus-pocus? + # the cdr *will* show duration here + # if we forego the 'minutes' key + # duration vs billsec? + 'charge' => $charge, + 'pretty_dst' => $pretty_destnum, + 'dst_regionname' => $regionname, + ) + ); + } #if(there is a rate_detail) + if ( $charge > 0 ) { #just use FS::cust_bill_pkg_detail objects? + warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG; + $charges += $charge; 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 ]; + $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 ]; + $call_details = + [ 'C', + $csv->string, + $charge, + $classnum, + $phonenum, + $seconds, + $regionname, + ]; } warn " adding details on charge to invoice: [ ". join(', ', @{$call_details} ). " ]" @@ -530,7 +754,10 @@ sub calc_recur { #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' ) # if $spool_cdr; - my $error = $cdr->set_status_and_rated_price('done', $charge); + my $error = $cdr->set_status_and_rated_price( 'done', + $charge, + $cust_svc->svcnum, + ); die $error if $error; } @@ -539,7 +766,14 @@ sub calc_recur { } # $cust_svc - unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ] + unshift @$details, [ 'C', + FS::cdr::invoice_header($output_format), + '', + '', + '', + '', + '', + ] if @$details && $rating_method ne 'upstream'; # if ( $spool_cdr && length($downstream_cdr) ) { @@ -569,33 +803,6 @@ sub calc_recur { # # } #if ( $spool_cdr && length($downstream_cdr) ) - if ($param->{'increment_next_bill'}) { - my $recur_method = $self->option('recur_method', 1) || 'anniversary'; - - if ( $recur_method eq 'prorate' ) { - - $charges += $self->SUPER::calc_recur(@_); - - } else { - - $charges += $self->option('recur_fee'); - - if ( $recur_method eq 'subscription' ) { - - my $cutoff_day = $self->option('cutoff_day', 1) || 1; - my ($day, $mon, $year) = ( localtime($$sdate) )[ 3..5 ]; - - if ( $day < $cutoff_day ) { - if ( $mon == 0 ) { $mon=11; $year--; } - else { $mon--; } - } - - $$sdate = timelocal(0, 0, 0, $cutoff_day, $mon, $year); - - }#$recur_method eq 'subscription' - }#$recur_method eq 'prorate' - }#increment_next_bill - $charges; } @@ -614,6 +821,7 @@ sub check_chargable { use_cdrtypenum skip_dcontext skip_dstchannel_prefix + skip_src_length_more noskip_src_length_accountcode_tollfree skip_dst_length_less skip_lastapp ); @@ -656,6 +864,26 @@ sub check_chargable { 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; + } + + } + #all right then, rate it ''; } @@ -664,11 +892,6 @@ sub is_free { 0; } -sub base_recur { - my($self, $cust_pkg) = @_; - $self->option('recur_fee'); -} - # This equates svc_phone records; perhaps svc_phone should have a field # to indicate it represents a line sub calc_units {