X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fvoip_cdr.pm;h=3006eaa56477451b6d0f0c948879238eacdfadd8;hb=35e0bcdf5d574b2b30796159617b845255d528ae;hp=3ba3dce22828d4bf4726c915bbe7256637dcc49c;hpb=da5ff2bd04f45b280f9fed2c37848d560657cc7b;p=freeside.git diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm index 3ba3dce22..3006eaa56 100644 --- a/FS/FS/part_pkg/voip_cdr.pm +++ b/FS/FS/part_pkg/voip_cdr.pm @@ -6,20 +6,22 @@ use Date::Format; use Tie::IxHash; 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::flat); +@ISA = qw(FS::part_pkg::recur_Common); -$DEBUG = 1; +$DEBUG = 0; 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' => '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.', + 'single_price' => 'A single price per minute for all calls.', ; #tie my %cdr_location, 'Tie::IxHash', @@ -55,7 +57,19 @@ tie my %temporalities, 'Tie::IxHash', 'type' => 'checkbox', }, - 'rating_method' => { 'name' => 'Region rating method', + 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '. + 'subscription', + 'default' => '1', + }, + + 'recur_method' => { 'name' => 'Recurring fee method', + #'type' => 'radio', + #'options' => \%recur_method, + 'type' => 'select', + 'select_options' => \%FS::part_pkg::recur_Common::recur_method, + }, + + 'rating_method' => { 'name' => 'Rating method', 'type' => 'radio', 'options' => \%rating_method, }, @@ -67,6 +81,10 @@ tie my %temporalities, 'Tie::IxHash', 'select_label' => 'ratename', }, + 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method', + 'type' => 'text', + }, + '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', }, @@ -113,6 +131,18 @@ tie my %temporalities, 'Tie::IxHash', 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ', }, + 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:', + }, + + 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:', + }, + + 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:', + }, + + 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value', + }, + 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field', 'type' => 'checkbox', }, @@ -120,6 +150,7 @@ 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() }, @@ -132,11 +163,16 @@ tie my %temporalities, 'Tie::IxHash', 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section', 'type' => 'checkbox', }, + #eofalse 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.', 'type' => 'checkbox', }, + 'count_available_phones' => { 'name' => 'Consider for tax purposes the number of lines to be svc_phones that may be provisioned rather than those that actually are.', + 'type' => 'checkbox', + }, + #XXX also have option for an external db # 'cdr_location' => { 'name' => 'CDR database location' # 'type' => 'select', @@ -163,17 +199,21 @@ tie my %temporalities, 'Tie::IxHash', }, 'fieldorder' => [qw( setup_fee recur_fee recur_temporality unused_credit - rating_method ratenum ignore_unrateable + recur_method cutoff_day + rating_method ratenum min_charge ignore_unrateable default_prefix disable_src domestic_prefix international_prefix disable_tollfree use_amaflags use_disposition use_disposition_taqua use_carrierid use_cdrtypenum + skip_dcontext skip_dstchannel_prefix + skip_dst_length_less skip_lastapp use_duration 411_rewrite output_format summarize_usage usage_section bill_every_call + count_available_phones ) ], 'weight' => 40, @@ -184,15 +224,38 @@ 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, $cust_pkg, $sdate, $details, $param ) = @_; + 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 return 0 - if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0; + if $self->option('recur_temporality', 1) eq 'preceding' + && ( $last_bill eq '' || $last_bill == 0 ); my $ratenum = $cust_pkg->part_pkg->option('ratenum'); @@ -202,13 +265,30 @@ sub calc_recur { my $charges = 0; - my $downstream_cdr = ''; +# my $downstream_cdr = ''; + + my $rating_method = $self->option('rating_method') || 'prefix'; + my $intl = $self->option('international_prefix') || '011'; + my $domestic_prefix = $self->option('domestic_prefix'); + my $disable_tollfree = $self->option('disable_tollfree'); + my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!'); + my $use_duration = $self->option('use_duration'); - my $rating_method = $self->option('rating_method') || 'prefix'; + my $output_format = $self->option('output_format', 'Hush!') + || ( $rating_method eq 'upstream_simple' + ? 'simple' + : 'default' + ); - my $output_format = - $self->option('output_format', 'Hush!') - || ( $rating_method eq 'upstream_simple' ? 'simple' : 'default' ); + my @dirass = (); + if ( $self->option('411_rewrite') ) { + my $dirass = $self->option('411_rewrite'); + $dirass =~ s/\s//g; + @dirass = split(',', $dirass); + } + + #for check_chargable, so we don't keep looking up options inside the loop + my %opt_cache = (); eval "use Text::CSV_XS;"; die $@ if $@; @@ -219,9 +299,10 @@ sub calc_recur { ) { foreach my $cdr ( - $cust_svc->get_cdrs_for_update( 'disable_src' => $self->option('disable_src'), - 'default_prefix' => $self->option('default_prefix'), - ) # $last_bill, $$sdate ) + $cust_svc->get_cdrs_for_update( + 'disable_src' => $self->option('disable_src'), + 'default_prefix' => $self->option('default_prefix'), + ) # $last_bill, $$sdate ) ) { if ( $DEBUG > 1 ) { warn "rating CDR $cdr\n". @@ -236,19 +317,15 @@ sub calc_recur { my @call_details = (); if ( $rating_method eq 'prefix' ) { - my $da_rewrite = 0; - if ( $self->option('411_rewrite') ) { - my $dirass = $self->option('411_rewrite'); - $dirass =~ s/\s//g; - my @dirass = split(',', $dirass); - if ( grep $cdr->dst eq $_, @dirass ) { - $cdr->dst('411'); - $da_rewrite = 1; - } + my $da_rewrote = 0; + if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){ + $cdr->dst('411'); + $da_rewrote = 1; } my $reason = $self->check_chargable( $cdr, - '411_rewrite' => $da_rewrite, + 'da_rewrote' => $da_rewrote, + 'option_cache' => \%opt_cache, ); if ( $reason ) { @@ -264,9 +341,7 @@ sub calc_recur { ### my( $to_or_from, $number ); - if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/ - && ! $self->option('disable_tollfree') - ) + if ( $cdr->is_tollfree && ! $disable_tollfree ) { #tollfree call $to_or_from = 'from'; $number = $cdr->src; @@ -284,8 +359,6 @@ sub calc_recur { # my $siphost = ''; # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com - my $intl = $self->option('international_prefix') || '011'; - #determine the country code my $countrycode; if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/ @@ -307,7 +380,7 @@ sub calc_recur { } } else { - $countrycode = $self->option('domestic_prefix') || '1'; + $countrycode = $domestic_prefix || '1'; $number =~ s/^$countrycode//;# if length($number) > 10; } @@ -323,13 +396,13 @@ sub calc_recur { if ( $rate_detail ) { + $rate_region = $rate_detail->dest_region; + $regionnum = $rate_region->regionnum; warn " found rate for regionnum $regionnum ". "and rate detail $rate_detail\n" if $DEBUG; - $rate_region = $rate_detail->dest_region; - $regionnum = $rate_region->regionnum; - } elsif ( $self->option('ignore_unrateable', 1) ) { + } elsif ( $ignore_unrateable ) { $rate_region = ''; $regionnum = ''; @@ -345,48 +418,74 @@ sub calc_recur { } - } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove? +# } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove? +# +# if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid +# +# $rate_detail = $cdr->cdr_upstream_rate->rate_detail; +# +# $regionnum = $rate_detail->dest_regionnum; +# $rate_region = $rate_detail->dest_region; +# +# $pretty_destnum = $cdr->dst; +# +# warn " found rate for regionnum $regionnum and ". +# "rate detail $rate_detail\n" +# if $DEBUG; +# +# } else { #pass upstream price through +# +# $charge = sprintf('%.2f', $cdr->upstream_price); +# $charges += $charge; +# +# @call_details = ( +# #time2str("%Y %b %d - %r", $cdr->calldate_unix ), +# time2str("%c", $cdr->calldate_unix), #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot +# 'N/A', #minutes... +# '$'.$charge, +# #$pretty_destnum, +# $cdr->description, #$rate_region->regionname, +# ); +# +# } - if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid + } elsif ( $rating_method eq 'upstream_simple' ) { - $rate_detail = $cdr->cdr_upstream_rate->rate_detail; + #XXX $charge = sprintf('%.2f', $cdr->upstream_price); + $charge = sprintf('%.3f', $cdr->upstream_price); + $charges += $charge; - $regionnum = $rate_detail->dest_regionnum; - $rate_region = $rate_detail->dest_region; + @call_details = ($cdr->downstream_csv( 'format' => $output_format, + 'charge' => $charge, + ) + ); + $classnum = $cdr->calltypenum; - $pretty_destnum = $cdr->dst; + } elsif ( $rating_method eq 'single_price' ) { - warn " found rate for regionnum $regionnum and ". - "rate detail $rate_detail\n" - if $DEBUG; + # a little false laziness w/below - } else { #pass upstream price through + my $granularity = 60; - $charge = sprintf('%.2f', $cdr->upstream_price); - $charges += $charge; - - @call_details = ( - #time2str("%Y %b %d - %r", $cdr->calldate_unix ), - time2str("%c", $cdr->calldate_unix), #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot - 'N/A', #minutes... - '$'.$charge, - #$pretty_destnum, - $cdr->description, #$rate_region->regionname, - ); + # length($cdr->billsec) ? $cdr->billsec : $cdr->duration; + my $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 = sprintf("%.1f", $seconds / 60); + $minutes =~ s/\.0$// ;# if $granularity == 60; - } elsif ( $rating_method eq 'upstream_simple' ) { + $charge = sprintf('%.2f', ( $self->option('min_charge') * $minutes ) + + 0.00000001 ); #so 1.005 rounds to 1.01 - #XXX $charge = sprintf('%.2f', $cdr->upstream_price); - $charge = sprintf('%.3f', $cdr->upstream_price); + $charge = $charges += $charge; @call_details = ($cdr->downstream_csv( 'format' => $output_format, 'charge' => $charge, ) ); - $classnum = $cdr->calltypenum; } else { die "don't know how to rate CDRs using method: $rating_method\n"; @@ -416,9 +515,7 @@ sub calc_recur { my $granularity = $rate_detail->sec_granularity; # length($cdr->billsec) ? $cdr->billsec : $cdr->duration; - my $seconds = $self->option('use_duration') - ? $cdr->duration - : $cdr->billsec; + my $seconds = $use_duration ? $cdr->duration : $cdr->billsec; $seconds += $granularity - ( $seconds % $granularity ) if $seconds # don't granular-ize 0 billsec calls (bills them) @@ -432,9 +529,11 @@ sub calc_recur { $included_min{$regionnum} -= $minutes; if ( $included_min{$regionnum} < 0 ) { - my $charge_min = 0 - $included_min{$regionnum}; + 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 ); + $charge = sprintf('%.2f', ( $rate_detail->min_charge * $charge_min ) + + 0.00000001 ); #so 1.005 rounds to 1.01 $charges += $charge; } @@ -475,8 +574,8 @@ sub calc_recur { # if the customer flag is on, call "downstream_csv" or something # like it to export the call downstream! # XXX price plan option to pick format, or something... - $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' ) - if $spool_cdr; + #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' ) + # if $spool_cdr; my $error = $cdr->set_status_and_rated_price('done', $charge); die $error if $error; @@ -490,63 +589,92 @@ sub calc_recur { unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ] if @$details && $rating_method ne 'upstream'; - if ( $spool_cdr && length($downstream_cdr) ) { - - use FS::UID qw(datasrc); - my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr'; - mkdir $dir, 0700 unless -d $dir; - $dir .= '/'. $cust_pkg->custnum. - mkdir $dir, 0700 unless -d $dir; - my $filename = time2str("$dir/CDR%Y%m%d-spool.CSV", time); #XXX invoice date instead? would require changing the order things are generated in cust_main::bill insert cust_bill first - with transactions it could be done though - - push @{ $param->{'precommit_hooks'} }, - sub { - #lock the downstream spool file and append the records - use Fcntl qw(:flock); - use IO::File; - my $spool = new IO::File ">>$filename" - or die "can't open $filename: $!\n"; - flock( $spool, LOCK_EX) - or die "can't lock $filename: $!\n"; - seek($spool, 0, 2) - or die "can't seek to end of $filename: $!\n"; - print $spool $downstream_cdr; - flock( $spool, LOCK_UN ); - close $spool; - }; - - } #if ( $spool_cdr && length($downstream_cdr) ) - - $charges += $self->option('recur_fee') - if $param->{'increment_next_bill'}; +# if ( $spool_cdr && length($downstream_cdr) ) { +# +# use FS::UID qw(datasrc); +# my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr'; +# mkdir $dir, 0700 unless -d $dir; +# $dir .= '/'. $cust_pkg->custnum. +# mkdir $dir, 0700 unless -d $dir; +# my $filename = time2str("$dir/CDR%Y%m%d-spool.CSV", time); #XXX invoice date instead? would require changing the order things are generated in cust_main::bill insert cust_bill first - with transactions it could be done though +# +# push @{ $param->{'precommit_hooks'} }, +# sub { +# #lock the downstream spool file and append the records +# use Fcntl qw(:flock); +# use IO::File; +# my $spool = new IO::File ">>$filename" +# or die "can't open $filename: $!\n"; +# flock( $spool, LOCK_EX) +# or die "can't lock $filename: $!\n"; +# seek($spool, 0, 2) +# or die "can't seek to end of $filename: $!\n"; +# print $spool $downstream_cdr; +# flock( $spool, LOCK_UN ); +# close $spool; +# }; +# +# } #if ( $spool_cdr && length($downstream_cdr) ) $charges; } #returns a reason why not to rate this CDR, or false if the CDR is chargeable sub check_chargable { - my( $self, $cdr, %opt ) = @_; + my( $self, $cdr, %flags ) = @_; #should have some better way of checking these options from a hash #or something + my @opt = qw( + use_amaflags + use_disposition + use_disposition_taqua + use_carrierid + use_cdrtypenum + skip_dcontext + skip_dstchannel_prefix + skip_dst_length_less + skip_lastapp + ); + foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) { + $flags{option_cache}->{$opt} = $self->option($opt, 1); + } + my %opt = %{ $flags{option_cache} }; + return 'amaflags != 2' - if $self->option('use_amaflags') && $cdr->amaflags != 2; + if $opt{'use_amaflags'} && $cdr->amaflags != 2; return 'disposition != ANSWERED' - if $self->option('use_disposition') && $cdr->disposition ne 'ANSWERED'; + if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED'; return "disposition != 100" - if $self->option('use_disposition_taqua') && $cdr->disposition != 100; + if $opt{'use_disposition_taqua'} && $cdr->disposition != 100; + + return "carrierid != $opt{'use_carrierid'}" + if length($opt{'use_carrierid'}) + && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches '' + && ! $flags{'da_rewrote'}; + + return "cdrtypenum != $opt{'use_cdrtypenum'}" + if length($opt{'use_cdrtypenum'}) + && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches '' + + return "dcontext IN ( $opt{'skip_dcontext'} )" + if $opt{'skip_dcontext'} =~ /\S/ + && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'}); - return 'carrierid != '. $self->option('use_carrierid') - if $self->option('use_carrierid') - && $cdr->carrierid != $self->option('use_carrierid') - && ! $opt{'411_rewrite'}; + my $len_prefix = length($opt{'skip_dstchannel_prefix'}); + return "dstchannel starts with $opt{'skip_dstchannel_prefix'}" + if $len_prefix + && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'}; - return 'cdrtypenum != '. $self->option('use_cdrtypenum') - if $self->option('use_cdrtypenum') - && $cdr->cdrtypenum != $self->option('use_cdrtypenum'); + my $dst_length = $opt{'skip_dst_length_less'}; + return "destination less than $dst_length digits" + if $dst_length && length($cdr->dst) < $dst_length; + + return "lastapp is $opt{'skip_lastapp'}" + if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'}; #all right then, rate it ''; @@ -556,16 +684,20 @@ 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 { my($self, $cust_pkg ) = @_; - scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc); + my $count = 0; + if ( $self->option('count_available_phones', 1)) { + map { $count += ( $_->quantity || 0 ) } + grep { $_->part_svc->svcdb eq 'svc_phone' } + $cust_pkg->part_pkg->pkg_svc; + } else { + $count = + scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc); + } + $count; } 1;