X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fvoip_cdr.pm;h=a7c1903e6d9f93cb4dd379d4bc466be2fbc215b8;hb=efc68f41987d007de5e792b88df1c63bf3dedf4c;hp=15af77b4f6559f8cbf3153c197d8514da120a671;hpb=ff24bc786a5fd479f2252260e0da580a736f97be;p=freeside.git diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm index 15af77b4f..a7c1903e6 100644 --- a/FS/FS/part_pkg/voip_cdr.pm +++ b/FS/FS/part_pkg/voip_cdr.pm @@ -7,6 +7,7 @@ use Tie::IxHash; use FS::Conf; use FS::Record qw(qsearchs qsearch); use FS::part_pkg::flat; +use FS::cdr; #use FS::rate; #use FS::rate_prefix; @@ -17,6 +18,7 @@ $DEBUG = 1; 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.', ; #tie my %cdr_location, 'Tie::IxHash', @@ -26,14 +28,15 @@ tie my %rating_method, 'Tie::IxHash', #; %info = ( - 'name' => 'VoIP rating by plan of CDR records in an internal (or external?) SQL table', + 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table', + 'shortname' => 'VoIP/telco CDR rating (standard)', 'fields' => { 'setup_fee' => { 'name' => 'Setup fee for this package', 'default' => 0, }, - 'recur_flat' => { 'name' => 'Base recurring fee for this package', - 'default' => 0, - }, + 'recur_fee' => { 'name' => 'Base recurring fee for this package', + 'default' => 0, + }, 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'. ' of service at cancellation', 'type' => 'checkbox', @@ -45,15 +48,48 @@ tie my %rating_method, 'Tie::IxHash', 'select_label' => 'ratename', }, 'rating_method' => { 'name' => 'Region rating method', - 'type' => 'select', - 'select_options' => \%rating_method, + 'type' => 'radio', + 'options' => \%rating_method, }, 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records', 'default' => '+1', }, - #XXX also have option for an external db?? + 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"', + 'type' => 'checkbox' + }, + + 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records', + 'default' => '1', + }, + +# 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records', +# 'type' => 'checkbox', +# }, + + 'international_prefix' => { 'name' => 'Destination prefix for international CDR records', + 'default' => '011', + }, + + 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").', + 'type' => 'checkbox', + }, + + 'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".', + 'type' => 'checkbox', + }, + + 'output_format' => { 'name' => 'Simple output format', + 'type' => 'select', + 'select_options' => { FS::cdr::invoice_formats() }, + }, + + 'separate_usage' => { 'name' => 'Separate usage charges from recurring charges', + 'type' => 'checkbox', + }, + + #XXX also have option for an external db # 'cdr_location' => { 'name' => 'CDR database location' # 'type' => 'select', # 'select_options' => \%cdr_location, @@ -77,7 +113,16 @@ tie my %rating_method, 'Tie::IxHash', # }, }, - 'fieldorder' => [qw( setup_fee recur_flat unused_credit ratenum rating_method default_prefix )], + 'fieldorder' => [qw( + setup_fee recur_fee unused_credit + rating_method ratenum + default_prefix + disable_src + domestic_prefix international_prefix + use_amaflags use_disposition output_format + separate_usage + ) + ], 'weight' => 40, ); @@ -86,8 +131,16 @@ sub calc_setup { $self->option('setup_fee'); } -#false laziness w/voip_sqlradacct... resolve it if that one ever gets used again sub calc_recur { + my $self = shift; + my $charges = 0; + $charges = $self->calc_usage(@_) + unless $self->option('separate_usage', 'Hush!'); + $self->option('recur_fee') + $charges; +} + +#false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again +sub calc_usage { my($self, $cust_pkg, $sdate, $details, $param ) = @_; my $last_bill = $cust_pkg->last_bill; @@ -102,13 +155,21 @@ sub calc_recur { my $downstream_cdr = ''; - # also look for a specific domain??? (username@telephonedomain) + my $output_format = $self->option('output_format', 'Hush!') + || 'simple'; + + eval "use Text::CSV_XS;"; + die $@ if $@; + my $csv = new Text::CSV_XS; + foreach my $cust_svc ( - grep { $_->part_svc->svcdb eq 'svc_acct' } $cust_pkg->cust_svc + grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc ) { foreach my $cdr ( - $cust_svc->get_cdrs_for_update() # $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". @@ -118,85 +179,109 @@ sub calc_recur { my $rate_detail; my( $rate_region, $regionnum ); my $pretty_destnum; - my $charge = 0; + my $charge = ''; my @call_details = (); if ( $self->option('rating_method') eq 'prefix' || ! $self->option('rating_method') ) { - die "rating_method 'prefix' not yet supported"; - -# ### -# # look up rate details based on called station id -# ### -# -# my $dest = $cdr->dst; -# -# #remove non-phone# stuff and whitespace -# $dest =~ 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 -# -# #determine the country code -# my $countrycode; -# if ( $dest =~ /^011(((\d)(\d))(\d))(\d+)$/ -# || $dest =~ /^\+(((\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; -# $dest = $u1.$u2.$rest; -# } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2 -# $countrycode = $two; -# $dest = $u2.$rest; -# } else { #3 digit country code -# $countrycode = $three; -# $dest = $rest; -# } -# -# } else { -# $countrycode = '1'; -# $dest =~ s/^1//;# if length($dest) > 10; -# } -# -# warn "rating call to +$countrycode $dest\n" if $DEBUG; -# $pretty_destnum = "+$countrycode $dest"; -# -# #find a rate prefix, first look at most specific (4 digits) then 3, etc., -# # finally trying the country code only -# my $rate_prefix = ''; -# for my $len ( reverse(1..6) ) { -# $rate_prefix = qsearchs('rate_prefix', { -# 'countrycode' => $countrycode, -# #'npa' => { op=> 'LIKE', value=> substr($dest, 0, $len) } -# 'npa' => substr($dest, 0, $len), -# } ) and last; -# } -# $rate_prefix ||= qsearchs('rate_prefix', { -# 'countrycode' => $countrycode, -# 'npa' => '', -# }); -# -# die "Can't find rate for call to +$countrycode $dest\n" -# unless $rate_prefix; -# -# $regionnum = $rate_prefix->regionnum; -# $rate_detail = qsearchs('rate_detail', { -# 'ratenum' => $ratenum, -# 'dest_regionnum' => $regionnum, -# } ); -# -# $rate_region = $rate_prefix->rate_region; -# -# warn " found rate for regionnum $regionnum ". -# "and rate detail $rate_detail\n" -# if $DEBUG; + if ( $self->option('use_amaflags') && $cdr->amaflags != 2 ) { + + warn "not charging for CDR (amaflags != 2)\n" if $DEBUG; + $charge = 0; + + } elsif ( $self->option('use_disposition') + && $cdr->disposition ne 'ANSWERED' ) { + + warn "not charging for CDR (disposition != ANSWERED)\n" if $DEBUG; + $charge = 0; + + } else { + + ### + # look up rate details based on called station id + # (or calling station id for toll free calls) + ### + + my( $to_or_from, $number ); + if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/ ) { #tollfree call + $to_or_from = 'from'; + $number = $cdr->src; + } else { #regular call + $to_or_from = 'to'; + $number = $cdr->dst; + } + + #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 + + my $intl = $self->option('international_prefix') || '011'; + + #determine the country code + my $countrycode; + 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 { + $countrycode = $self->option('domestic_prefix') || '1'; + $number =~ s/^$countrycode//;# if length($number) > 10; + } + + warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG; + $pretty_destnum = "+$countrycode $number"; + + #find a rate prefix, first look at most specific (4 digits) then 3, etc., + # finally trying the country code only + my $rate_prefix = ''; + for my $len ( reverse(1..6) ) { + $rate_prefix = qsearchs('rate_prefix', { + 'countrycode' => $countrycode, + #'npa' => { op=> 'LIKE', value=> substr($number, 0, $len) } + 'npa' => substr($number, 0, $len), + } ) and last; + } + $rate_prefix ||= qsearchs('rate_prefix', { + 'countrycode' => $countrycode, + 'npa' => '', + }); + + # + die "Can't find rate for call $to_or_from +$countrycode $number\n" + unless $rate_prefix; + + $regionnum = $rate_prefix->regionnum; + $rate_detail = qsearchs('rate_detail', { + 'ratenum' => $ratenum, + 'dest_regionnum' => $regionnum, + } ); + + $rate_region = $rate_prefix->rate_region; + + warn " found rate for regionnum $regionnum ". + "and rate detail $rate_detail\n" + if $DEBUG; + + } } elsif ( $self->option('rating_method') eq 'upstream' ) { @@ -216,7 +301,8 @@ sub calc_recur { } 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 @@ -228,6 +314,14 @@ sub calc_recur { } + } elsif ( $self->option('rating_method') eq 'upstream_simple' ) { + + #XXX $charge = sprintf('%.2f', $cdr->upstream_price); + $charge = sprintf('%.3f', $cdr->upstream_price); + $charges += $charge; + + @call_details = ($cdr->downstream_csv( 'format' => $output_format )); + } else { die "don't know how to rate CDRs using method: ". $self->option('rating_method'). "\n"; @@ -241,66 +335,83 @@ sub calc_recur { # don't add it to invoice, don't set its status to NULL, # don't call downstream_csv or something on it... # but DO emit a warning... - if ( ! $rate_detail && ! scalar(@call_details) ) { - + #if ( ! $rate_detail && ! scalar(@call_details) ) { + if ( ! $rate_detail && $charge eq '' ) { + warn "no rate_detail found for CDR.acctid: ". $cdr->acctid. "; skipping\n" } else { # there *is* a rate_detail (or call_details), proceed... - unless ( @call_details ) { - + unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) { + $included_min{$regionnum} = $rate_detail->min_included unless exists $included_min{$regionnum}; - + my $granularity = $rate_detail->sec_granularity; - my $seconds = $cdr->billsec; # |ength($cdr->billsec) ? $cdr->billsec : $cdr->duration; - $seconds += $granularity - ( $seconds % $granularity ); + my $seconds = $cdr->billsec; # length($cdr->billsec) ? $cdr->billsec : $cdr->duration; + $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; - + + # per call rather than per minute + $minutes = 1 unless $granularity; + $included_min{$regionnum} -= $minutes; - + if ( $included_min{$regionnum} < 0 ) { my $charge_min = 0 - $included_min{$regionnum}; $included_min{$regionnum} = 0; $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min ); $charges += $charge; } - + # this is why we need regionnum/rate_region.... warn " (rate region $rate_region)\n" if $DEBUG; - + @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 - $minutes.'m', + $granularity ? $minutes.'m' : $minutes.' call', '$'.$charge, $pretty_destnum, $rate_region->regionname, ); } - - warn " adding details on charge to invoice: ". - join(' - ', @call_details ) - if $DEBUG; - - push @$details, join(' - ', @call_details); #\@call_details, - + + if ( $charge > 0 ) { + my $call_details; + if ( $self->option('rating_method') eq 'upstream_simple' ) { + $call_details = [ 'C', $call_details[0] ]; + }else{ + $csv->combine(@call_details); + $call_details = [ 'C', $csv->string ]; + } + warn " adding details on charge to invoice: [ ". + join(', ', @{$call_details} ). " ]" + if ( $DEBUG && ref($call_details) ); + push @$details, $call_details; #\@call_details, + } + # 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; - + my $error = $cdr->set_status_and_rated_price('done', $charge); die $error if $error; - + } - + } # $cdr + unshift @$details, [ 'C', FS::cdr::invoice_header( $output_format) ] + if (@$details && $self->option('rating_method') eq 'upstream_simple' ); + } # $cust_svc if ( $spool_cdr && length($downstream_cdr) ) { @@ -330,7 +441,7 @@ sub calc_recur { } #if ( $spool_cdr && length($downstream_cdr) ) - $self->option('recur_flat') + $charges; + $charges; } @@ -340,7 +451,39 @@ sub is_free { sub base_recur { my($self, $cust_pkg) = @_; - $self->option('recur_flat'); + $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); +} + +sub append_cust_bill_pkgs { + my $self = shift; + my($cust_pkg, $sdate, $details, $param ) = @_; + return [] + unless $self->option('separate_usage', 'Hush!'); + + my @details = (); + my $charges = $self->calc_usage($cust_pkg, $sdate, \@details, $param); + + my $cust_bill_pkg = new FS::cust_bill_pkg { + 'pkgnum' => $cust_pkg->pkgnum, + 'setup' => 0, + 'unitsetup' => 0, + 'recur' => sprintf( "%.2f", $charges), # hmmm + 'unitrecur' => 0, + 'quantity' => $cust_pkg->quantity, + 'sdate' => $$sdate, + 'edate' => $cust_pkg->bill, # already fiddled + 'itemdesc' => 'Usage charges', # configurable? + 'details' => \@details, + }; + + return [ $cust_bill_pkg ]; } 1;