X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fvoip_cdr.pm;h=7c5272edcb4ff45ab2b17b03df0d01fe2480b046;hb=2b8f2f7d7c2fa79072f7404865691239f23fa5ba;hp=c4e6ab2d8fd6cb09e432cf349ceec901391e517b;hpb=125a6f06ea2d8814e3ea80ca61170da2e2e05034;p=freeside.git diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm index c4e6ab2d8..7c5272edc 100644 --- a/FS/FS/part_pkg/voip_cdr.pm +++ b/FS/FS/part_pkg/voip_cdr.pm @@ -8,12 +8,13 @@ use FS::Conf; use FS::Record qw(qsearchs qsearch); use FS::part_pkg::flat; use FS::cdr; -#use FS::rate; -#use FS::rate_prefix; +use FS::rate; +use FS::rate_prefix; +use FS::rate_detail; @ISA = qw(FS::part_pkg::flat); -$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', @@ -27,6 +28,11 @@ tie my %rating_method, 'Tie::IxHash', # 'Asterisk (or other?) CDR table', #; +tie my %temporalities, 'Tie::IxHash', + 'upcoming' => "Upcoming (future)", + 'preceding' => "Preceding (past)", +; + %info = ( 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table', 'shortname' => 'VoIP/telco CDR rating (standard)', @@ -37,20 +43,33 @@ tie my %rating_method, 'Tie::IxHash', 'recur_fee' => { 'name' => 'Base recurring fee for this package', 'default' => 0, }, + + #false laziness w/flat.pm + 'recur_temporality' => { 'name' => 'Charge recurring fee for period', + 'type' => 'select', + 'select_options' => \%temporalities, + }, + 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'. ' of service at cancellation', 'type' => 'checkbox', }, + + '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', @@ -72,6 +91,10 @@ tie my %rating_method, 'Tie::IxHash', 'default' => '011', }, + 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing', + 'type' => 'checkbox', + }, + 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").', 'type' => 'checkbox', }, @@ -80,11 +103,52 @@ tie my %rating_method, 'Tie::IxHash', 'type' => 'checkbox', }, - 'output_format' => { 'name' => 'Simple output format', + 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).', + 'type' => 'checkbox', + }, + + 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ', + }, + + '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 (also ignore any carrierid check): ', + }, + + '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', + }, + + 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section', + 'type' => 'checkbox', + }, + + 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.', + 'type' => 'checkbox', + }, + #XXX also have option for an external db # 'cdr_location' => { 'name' => 'CDR database location' # 'type' => 'select', @@ -110,12 +174,19 @@ tie my %rating_method, 'Tie::IxHash', }, 'fieldorder' => [qw( - setup_fee recur_fee unused_credit - rating_method ratenum + setup_fee recur_fee recur_temporality unused_credit + rating_method ratenum ignore_unrateable default_prefix disable_src domestic_prefix international_prefix - use_amaflags use_disposition output_format + disable_tollfree + use_amaflags use_disposition + use_disposition_taqua use_carrierid use_cdrtypenum + skip_dcontext skip_dstchannel_prefix + use_duration + 411_rewrite + output_format summarize_usage usage_section + bill_every_call ) ], 'weight' => 40, @@ -126,11 +197,16 @@ sub calc_setup { $self->option('setup_fee'); } -#false laziness w/voip_sqlradacct... resolve it if that one ever gets used again +#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 $last_bill = $cust_pkg->last_bill; + #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 eq '' || $last_bill == 0 ); my $ratenum = $cust_pkg->part_pkg->option('ratenum'); @@ -142,17 +218,42 @@ sub calc_recur { my $downstream_cdr = ''; - my $output_format = $self->option('output_format', 'Hush!') - || 'simple'; + 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 $@; + my $csv = new Text::CSV_XS; foreach my $cust_svc ( grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc ) { 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". @@ -163,32 +264,38 @@ sub calc_recur { my( $rate_region, $regionnum ); my $pretty_destnum; my $charge = ''; + my $classnum = ''; my @call_details = (); - if ( $self->option('rating_method') eq 'prefix' - || ! $self->option('rating_method') - ) - { + if ( $rating_method eq 'prefix' ) { - if ( $self->option('use_amaflags') && $cdr->amaflags != 2 ) { + my $da_rewrote = 0; + if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){ + $cdr->dst('411'); + $da_rewrote = 1; + } - warn "not charging for CDR (amaflags != 2)\n" if $DEBUG; - $charge = 0; + my $reason = $self->check_chargable( $cdr, + 'da_rewrote' => $da_rewrote, + 'option_cache' => \%opt_cache, + ); - } elsif ( $self->option('use_disposition') - && $cdr->disposition ne 'ANSWERED' ) { + if ( $reason ) { - warn "not charging for CDR (disposition != ANSWERED)\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) ### my( $to_or_from, $number ); - if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/ ) { #tollfree call + if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/ + && ! $disable_tollfree + ) + { #tollfree call $to_or_from = 'from'; $number = $cdr->src; } else { #regular call @@ -196,6 +303,8 @@ sub calc_recur { $number = $cdr->dst; } + warn "parsing call $to_or_from $number\n" if $DEBUG; + #remove non-phone# stuff and whitespace $number =~ s/\s//g; # my $proto = ''; @@ -203,8 +312,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+)$/ @@ -226,47 +333,45 @@ sub calc_recur { } } else { - $countrycode = $self->option('domestic_prefix') || '1'; + $countrycode = $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' => '', - }); + my $rate = qsearchs('rate', { 'ratenum' => $ratenum }) + or die "ratenum $ratenum not found!"; - # - die "Can't find rate for call $to_or_from +$countrycode $number\n" - unless $rate_prefix; + $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode, + 'phonenum' => $number, + }); - $regionnum = $rate_prefix->regionnum; - $rate_detail = qsearchs('rate_detail', { - 'ratenum' => $ratenum, - 'dest_regionnum' => $regionnum, - } ); + if ( $rate_detail ) { - $rate_region = $rate_prefix->rate_region; + $rate_region = $rate_detail->dest_region; + $regionnum = $rate_region->regionnum; + warn " found rate for regionnum $regionnum ". + "and rate detail $rate_detail\n" + if $DEBUG; - 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"; + } } - } elsif ( $self->option('rating_method') eq 'upstream' ) { + } 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 @@ -285,7 +390,7 @@ sub calc_recur { $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 @@ -297,17 +402,20 @@ sub calc_recur { } - } elsif ( $self->option('rating_method') eq 'upstream_simple' ) { + } elsif ( $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 )); + @call_details = ($cdr->downstream_csv( 'format' => $output_format, + 'charge' => $charge, + ) + ); + $classnum = $cdr->calltypenum; } else { - die "don't know how to rate CDRs using method: ". - $self->option('rating_method'). "\n"; + die "don't know how to rate CDRs using method: $rating_method\n"; } ### @@ -315,13 +423,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 && ! 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... @@ -332,7 +440,10 @@ sub calc_recur { unless exists $included_min{$regionnum}; my $granularity = $rate_detail->sec_granularity; - my $seconds = $cdr->billsec; # length($cdr->billsec) ? $cdr->billsec : $cdr->duration; + + # 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 @@ -355,25 +466,30 @@ sub calc_recur { 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 - $granularity ? $minutes.'m' : $minutes.' call', - '$'.$charge, - $pretty_destnum, - $rate_region->regionname, + $cdr->downstream_csv( 'format' => $output_format, + 'granularity' => $granularity, + 'minutes' => $minutes, + 'charge' => $charge, + 'pretty_dst' => $pretty_destnum, + 'dst_regionname' => $rate_region->regionname, + ) ); + $classnum = $rate_detail->classnum; + } if ( $charge > 0 ) { + #just use FS::cust_bill_pkg_detail objects? my $call_details; - if ( $self->option('rating_method') eq 'upstream_simple' ) { - $call_details = [ 'C', $call_details[0] ]; - }else{ - $call_details = join(' - ', @call_details ); + + #if ( $self->option('rating_method') eq 'upstream_simple' ) { + if ( scalar(@call_details) == 1 ) { + $call_details = [ 'C', $call_details[0], $charge, $classnum ]; + } else { #only used for $rating_method eq 'upstream' now + $csv->combine(@call_details); + $call_details = [ 'C', $csv->string, $charge, $classnum ]; } - warn " adding details on charge to invoice: $call_details" - if ( $DEBUG && !ref($call_details) ); warn " adding details on charge to invoice: [ ". join(', ', @{$call_details} ). " ]" if ( $DEBUG && ref($call_details) ); @@ -393,11 +509,11 @@ sub calc_recur { } # $cdr - unshift @$details, [ 'C', FS::cdr::invoice_header( $output_format) ] - if (@$details && $self->option('rating_method') eq 'upstream_simple' ); - } # $cust_svc + 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); @@ -425,8 +541,71 @@ sub calc_recur { } #if ( $spool_cdr && length($downstream_cdr) ) - $self->option('recur_fee') + $charges; + $charges += $self->option('recur_fee') + if $param->{'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); + } + 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 {