X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fvoip_cdr.pm;h=1195b1694006ed249b68d4716d707428eaca6879;hp=09789d945d12c7e863cfef1eac8159aa42ef50d3;hb=15e57a4859d967a13113602b112c4aa197ca6002;hpb=1e6dd07a7ded1948587ece00aa1f1c467e55af20 diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm index 09789d945..1195b1694 100644 --- a/FS/FS/part_pkg/voip_cdr.pm +++ b/FS/FS/part_pkg/voip_cdr.pm @@ -4,6 +4,7 @@ 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; @@ -12,9 +13,9 @@ use FS::rate; use FS::rate_prefix; use FS::rate_detail; -@ISA = qw(FS::part_pkg::flat); +@ISA = qw(FS::part_pkg::prorate); -$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', @@ -22,6 +23,12 @@ tie my %rating_method, 'Tie::IxHash', 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.', ; +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)', +; + #tie my %cdr_location, 'Tie::IxHash', # 'internal' => 'Internal: CDR records imported into the internal CDR table', # 'external' => 'External: CDR records queried directly from an external '. @@ -54,16 +61,34 @@ tie my %temporalities, 'Tie::IxHash', ' of service at cancellation', 'type' => 'checkbox', }, + + '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' => \%recur_method, + }, + + 'rating_method' => { 'name' => 'Region rating method', + 'type' => 'radio', + 'options' => \%rating_method, + }, + 'ratenum' => { 'name' => 'Rate plan', 'type' => 'select', 'select_table' => 'rate', 'select_key' => 'ratenum', 'select_label' => 'ratename', }, - 'rating_method' => { 'name' => 'Region rating method', - 'type' => 'radio', - 'options' => \%rating_method, - }, + + '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', + }, 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records', 'default' => '+1', @@ -107,11 +132,23 @@ 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', }, - '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes: ', + '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ', }, 'output_format' => { 'name' => 'CDR invoice display format', @@ -131,6 +168,10 @@ tie my %temporalities, 'Tie::IxHash', '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', @@ -157,17 +198,21 @@ tie my %temporalities, 'Tie::IxHash', }, 'fieldorder' => [qw( setup_fee recur_fee recur_temporality unused_credit - rating_method ratenum + recur_method cutoff_day + rating_method ratenum 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, @@ -180,13 +225,15 @@ sub calc_setup { #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 $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'); @@ -198,11 +245,28 @@ sub calc_recur { my $downstream_cdr = ''; - my $rating_method = $self->option('rating_method') || 'prefix'; - - my $output_format = - $self->option('output_format', 'Hush!') - || ( $rating_method eq 'upstream_simple' ? 'simple' : 'default' ); + 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 $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 $@; @@ -213,9 +277,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". @@ -230,57 +295,31 @@ sub calc_recur { my @call_details = (); if ( $rating_method eq 'prefix' ) { - #should have some better way of checking these options than a long - #if-else tree... - my $notchg = "not charging for CDR"; - - if ( $self->option('use_amaflags') && $cdr->amaflags != 2 ) { - - warn "$notchg (amaflags != 2)\n" if $DEBUG; - $charge = 0; - - } elsif ( $self->option('use_disposition') - && $cdr->disposition ne 'ANSWERED' ) { + my $da_rewrote = 0; + if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){ + $cdr->dst('411'); + $da_rewrote = 1; + } - warn "$notchg (disposition != ANSWERED)\n" if $DEBUG; - $charge = 0; + my $reason = $self->check_chargable( $cdr, + 'da_rewrote' => $da_rewrote, + 'option_cache' => \%opt_cache, + ); - } elsif ( $self->option('use_disposition_taqua') - && $cdr->disposition != 100 ) { + if ( $reason ) { - warn "$notchg (disposition != 100)\n" if $DEBUG; - $charge = 0; - - } elsif ( $self->option('use_carrierid') - && $cdr->carrierid != $self->option('use_carrierid') ) { - - warn "$notchg (carrierid != ". $self->option('use_carrierid'). ")\n" - if $DEBUG; - $charge = 0; - - } elsif ( $self->option('use_cdrtypenum') - && $cdr->cdrtypenum != $self->option('use_cdrtypenum') ) { - - warn "$notchg (cdrtypenum != ". $self->option('use_cdrtypenum'). ")\n" - if $DEBUG; + warn "not charging for CDR ($reason)\n" if $DEBUG; $charge = 0; } else { - + ### # look up rate details based on called station id # (or calling station id for toll free calls) ### - if ( $self->option('411_rewrite') ) { - my @dirass = split(/\s*,\s*/, $self->option('411_rewrite')); - $cdr->dst('411') if grep $cdr->dst eq $_, @dirass; - } - 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; @@ -298,8 +337,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+)$/ @@ -321,7 +358,7 @@ sub calc_recur { } } else { - $countrycode = $self->option('domestic_prefix') || '1'; + $countrycode = $domestic_prefix || '1'; $number =~ s/^$countrycode//;# if length($number) > 10; } @@ -335,12 +372,27 @@ sub calc_recur { 'phonenum' => $number, }); - $rate_region = $rate_detail->dest_region; - $regionnum = $rate_region->regionnum; + if ( $rate_detail ) { - warn " found rate for regionnum $regionnum ". - "and rate detail $rate_detail\n" - if $DEBUG; + $rate_region = $rate_detail->dest_region; + $regionnum = $rate_region->regionnum; + warn " found rate for regionnum $regionnum ". + "and rate detail $rate_detail\n" + if $DEBUG; + + } elsif ( $ignore_unrateable ) { + + $rate_region = ''; + $regionnum = ''; + #code below will throw a warning & skip + + } else { + + die "FATAL: no rate_detail found in ". + $rate->ratenum. ":". $rate->ratename. " rate plan ". + "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ". + "add a rate or set ignore_unrateable flag on the package def\n"; + } } @@ -396,13 +448,13 @@ sub calc_recur { ### # if $rate_detail is not found, skip this CDR... i.e. - # don't add it to invoice, don't set its status to NULL, + # don't add it to invoice, don't set its status to done, # don't call downstream_csv or something on it... # but DO emit a warning... #if ( ! $rate_detail && ! scalar(@call_details) ) {} if ( ! $rate_detail && $charge eq '' ) { - warn "no rate_detail found for CDR.acctid: ". $cdr->acctid. + warn "no rate_detail found for CDR.acctid: ". $cdr->acctid. "; skipping\n" } else { # there *is* a rate_detail (or call_details), proceed... @@ -415,9 +467,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) @@ -431,9 +481,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; } @@ -516,12 +568,97 @@ sub calc_recur { } #if ( $spool_cdr && length($downstream_cdr) ) - $charges += $self->option('recur_fee') - if $param->{'increment_next_bill'}; + 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; } +#returns a reason why not to rate this CDR, or false if the CDR is chargeable +sub check_chargable { + 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 $opt{'use_amaflags'} && $cdr->amaflags != 2; + + return 'disposition != ANSWERED' + if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED'; + + return "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'}); + + 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'}; + + 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 + ''; +} + sub is_free { 0; } @@ -535,7 +672,16 @@ sub base_recur { # 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;