X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fvoip_cdr.pm;h=7d9a7f5c991be3337eca087c8b1eaf1ed60fd98b;hp=292bab6540aaaa87ea8b0ccc418b775fe2a84679;hb=3cbdd85a96348a287623e3b97c937c7749e99392;hpb=9fa60cbce4bb13ef227749706c99c5bf584bbf3e diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm index 292bab654..7d9a7f5c9 100644 --- a/FS/FS/part_pkg/voip_cdr.pm +++ b/FS/FS/part_pkg/voip_cdr.pm @@ -1,19 +1,15 @@ package FS::part_pkg::voip_cdr; +use base qw( FS::part_pkg::recur_Common ); use strict; -use base qw( FS::part_pkg::recur_Common ); use vars qw( $DEBUG %info ); -use Date::Format; use Tie::IxHash; +use Date::Format; +use Text::CSV_XS; use FS::Conf; use FS::Record qw(qsearchs qsearch); use FS::cdr; -use FS::rate; -use FS::rate_prefix; -use FS::rate_detail; - -use List::Util qw(first min); - +use FS::detail_format; $DEBUG = 0; @@ -21,6 +17,9 @@ tie my %cdr_svc_method, 'Tie::IxHash', 'svc_phone.phonenum' => 'Phone numbers (svc_phone.phonenum)', 'svc_pbx.title' => 'PBX name (svc_pbx.title)', 'svc_pbx.svcnum' => 'Freeside service # (svc_pbx.svcnum)', + 'svc_pbx.ip.src' => 'PBX name to source IP address', + 'svc_pbx.ip.dst' => 'PBX name to destination IP address', + 'svc_acct.username' => 'Username (svc_acct.username)', ; tie my %rating_method, 'Tie::IxHash', @@ -30,6 +29,11 @@ tie my %rating_method, 'Tie::IxHash', 'single_price' => 'A single price per minute for all calls.', ; +tie my %rounding, 'Tie::IxHash', + '2' => 'Two decimal places (cent)', + '4' => 'Four decimal places (100th of a cent)', +; + #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 '. @@ -43,6 +47,23 @@ tie my %temporalities, 'Tie::IxHash', tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); +# previously "1" was "ignore" +tie my %unrateable_opts, 'Tie::IxHash', + '' => 'Exit with a fatal error', + 1 => 'Ignore and continue', + 2 => 'Flag for later review', +; + +tie my %detail_formats, 'Tie::IxHash', + '' => '', + FS::cdr::invoice_formats() +; + +tie my %accountcode_tollfree_field, 'Tie::IxHash', + 'dst' => 'Destination (dst)', + 'src' => 'Source (src)', +; + %info = ( 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table', 'shortname' => 'VoIP/telco CDR rating (standard)', @@ -69,8 +90,9 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); }, 'cdr_svc_method' => { 'name' => 'CDR service matching method', - 'type' => 'radio', - 'options' => \%cdr_svc_method, +# 'type' => 'radio', + 'type' => 'select', + 'select_options' => \%cdr_svc_method, }, 'rating_method' => { 'name' => 'Rating method', @@ -78,23 +100,24 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'options' => \%rating_method, }, + 'rounding' => { 'name' => 'Rounding for destination prefix rating', + 'type' => 'select', + 'select_options' => \%rounding, + }, + 'ratenum' => { 'name' => 'Rate plan', - 'type' => 'select', - 'select_table' => 'rate', - 'select_key' => 'ratenum', - 'select_label' => 'ratename', + 'type' => 'select-rate', }, 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan', - 'type' => 'select', - 'select_table' => 'rate', - 'select_key' => 'ratenum', - 'select_label' => 'ratename', + 'type' => 'select-rate', 'disable_empty' => 0, - 'empty_label' => '', + 'empty_label' => ' ', }, - 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" rating method or when using the "prefix" rating method ("region group" billing)', + 'calls_included' => { 'name' => 'Number of calls included at no usage charge', }, + + 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" or "prefix" rating method', }, 'min_charge' => { 'name' => 'Charge per minute when using "single price per minute" rating method', @@ -105,8 +128,9 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); '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', + 'ignore_unrateable' => { 'name' => 'Handling of calls without a rate in the rate table', + 'type' => 'select', + 'select_options' => \%unrateable_opts, }, 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records', @@ -125,7 +149,7 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); # 'type' => 'checkbox', # }, - 'international_prefix' => { 'name' => 'Destination prefix for international CDR records', + 'international_prefix' => { 'name' => 'Destination prefix for international CDR records (or "none" for no prefix)', 'default' => '011', }, @@ -133,29 +157,38 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'type' => 'checkbox', }, - 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").', + 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is set to "2" ("BILL"/"BILLING").', 'type' => 'checkbox', }, - 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ', + 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to any of these (comma-separated) values: ', }, - 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ', + 'use_cdrtypenum' => { 'name' => 'Only charge for CDRs where the CDR Type is set to this cdrtypenum: ', }, - 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ', + 'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to this cdrtypenum: ', + }, + + 'use_calltypenum' => { 'name' => 'Only charge for CDRs where the CDR Call Type is set to this calltypenum: ', + }, + + 'ignore_calltypenum' => { 'name' => 'Do not charge for CDRs where the CDR Call Type is set to this calltypenum: ', }, 'ignore_disposition' => { 'name' => 'Do not charge for CDRs where the Disposition is set to any of these (comma-separated) values: ', }, - 'disposition_in' => { 'name' => 'Do not charge for CDRs where the Disposition is not set to any of these (comma-separated) values: ', + 'disposition_in' => { 'name' => 'Only charge for CDRs where the Disposition is set to any of these (comma-separated) values: ', }, 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with any of these values: ', }, - 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values: ', + 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where dcontext is set to any of these (comma-separated) values: ', + }, + + 'skip_dcontext_suffix' => { 'name' => 'Do not charge for CDRs where dcontext ends with: ', }, 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:', @@ -178,6 +211,12 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'empty_label' => '', }, + 'accountcode_tollfree_field' => { + 'name' => 'When using an alternate rate plan for toll-free accountcodes, the CDR field to use in rating calculations', + 'type' => 'select', + 'select_options' => \%accountcode_tollfree_field, + }, + 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:', }, @@ -191,6 +230,11 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'skip_max_callers' => { 'name' => 'Do not charge for CDRs where max_callers is less than or equal to this value: ', }, + 'skip_same_customer' => { + 'name' => 'Do not charge for calls between numbers belonging to the same customer', + 'type' => 'checkbox', + }, + 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field', 'type' => 'checkbox', }, @@ -199,12 +243,25 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); }, #false laziness w/cdr_termination.pm - 'output_format' => { 'name' => 'CDR invoice display format', + 'output_format' => { 'name' => 'CDR display format for invoices', 'type' => 'select', - 'select_options' => { FS::cdr::invoice_formats() }, + 'select_options' => \%detail_formats, 'default' => 'default', #XXX test }, + 'selfservice_format' => + { 'name' => 'CDR display format for selfservice', + 'type' => 'select', + 'select_options' => \%detail_formats, + 'default' => 'default' + }, + 'selfservice_inbound_format' => + { 'name' => 'Inbound CDR display format for selfservice', + 'type' => 'select', + 'select_options' => \%detail_formats, + 'default' => '' + }, + 'usage_section' => { 'name' => 'Section in which to place usage charges (whether separated or not): ', }, @@ -212,11 +269,15 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'type' => 'checkbox', }, - 'usage_mandate' => { 'name' => 'Always put usage details in separate section', + 'usage_mandate' => { 'name' => 'Always put usage details in separate section. The section is defined in the next option.', 'type' => 'checkbox', }, #eofalse + 'usage_showzero' => { 'name' => 'Show details for included / no-charge calls.', + 'type' => 'checkbox', + }, + 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call (as well any setup fee, upon first payment). Useful for prepaid.', 'type' => 'checkbox', }, @@ -224,12 +285,15 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); 'bill_inactive_svcs' => { 'name' => 'Bill for all phone numbers that were active during the billing period', 'type' => 'checkbox', }, + 'bill_only_pkg_dates' => { 'name' => 'Only bill CDRs with a date during the package billing period', + '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 + #XXX also have option for an external db? these days we suck them into ours # 'cdr_location' => { 'name' => 'CDR database location' # 'type' => 'select', # 'select_options' => \%cdr_location, @@ -259,9 +323,9 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); FS::part_pkg::prorate_Mixin::fieldorder, qw( cdr_svc_method - rating_method ratenum intrastate_ratenum - min_charge min_included - sec_granularity + rating_method rounding ratenum intrastate_ratenum + calls_included + min_charge min_included sec_granularity ignore_unrateable default_prefix disable_src @@ -270,28 +334,33 @@ tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities(); use_amaflags use_carrierid use_cdrtypenum ignore_cdrtypenum + use_calltypenum ignore_calltypenum ignore_disposition disposition_in - skip_dcontext skip_dst_prefix + skip_dcontext skip_dcontext_suffix skip_dst_prefix skip_dstchannel_prefix skip_src_length_more noskip_src_length_accountcode_tollfree - accountcode_tollfree_ratenum + accountcode_tollfree_ratenum accountcode_tollfree_field skip_dst_length_less noskip_dst_length_accountcode_tollfree skip_lastapp skip_max_callers + skip_same_customer use_duration 411_rewrite - output_format usage_mandate summarize_usage usage_section - bill_every_call bill_inactive_svcs + output_format + selfservice_format selfservice_inbound_format + usage_mandate usage_section summarize_usage + usage_showzero bill_every_call bill_inactive_svcs + bill_only_pkg_dates count_available_phones suspend_bill ) ], - 'weight' => 40, + 'weight' => 41, ); sub price_info { my $self = shift; - my $str = $self->SUPER::price_info; + my $str = $self->SUPER::price_info(@_); $str .= " plus usage" if $str; $str; } @@ -303,18 +372,19 @@ sub calc_recur { my $charges = 0; $charges += $self->calc_usage(@_); - $charges += $self->calc_recur_Common(@_); + $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_); $charges; } -sub calc_cancel { - my $self = shift; - my($cust_pkg, $sdate, $details, $param ) = @_; - - $self->calc_usage(@_); -} +# use the default +#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 @@ -329,25 +399,19 @@ sub calc_usage { if $self->recur_temporality eq 'preceding' && ( $last_bill eq '' || $last_bill == 0 ); - my $ratenum = $cust_pkg->part_pkg->option('ratenum'); - - my $spool_cdr = $cust_pkg->cust_main->spool_cdr; - - my %included_min = (); - my $charges = 0; -# my $downstream_cdr = ''; + my $included_min = $self->option('min_included', 1) || 0; + #single price rating + #or region group + $included_min *= ($cust_pkg->quantity || 1); + + my $included_calls = $self->option('calls_included', 1) || 0; + $included_calls *= ($cust_pkg->quantity || 1); my $cdr_svc_method = $self->option('cdr_svc_method',1)||'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'); - my $disable_tollfree = $self->option('disable_tollfree'); - my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!'); - my $use_duration = $self->option('use_duration'); - my $region_group = ($rating_method eq 'prefix' && ($self->option('min_included',1) || 0) > 0); - my $region_group_included_min = $region_group ? $self->option('min_included') : 0; + my %detail_included_min = (); my $output_format = $self->option('output_format', 'Hush!') || ( $rating_method eq 'upstream_simple' @@ -355,23 +419,16 @@ sub calc_usage { : 'default' ); - my @dirass = (); - if ( $self->option('411_rewrite') ) { - my $dirass = $self->option('411_rewrite'); - $dirass =~ s/\s//g; - @dirass = split(',', $dirass); - } - - my %interval_cache = (); # for timed rates + my $usage_showzero = $self->option('usage_showzero', 1); - #for check_chargable, so we don't keep looking up options inside the loop - my %opt_cache = (); + my $formatter = FS::detail_format->new($output_format, + buffer => $details, + locale => $cust_pkg->cust_main->locale + ); - eval "use Text::CSV_XS;"; - die $@ if $@; - my $csv = new Text::CSV_XS; + my $use_duration = $self->option('use_duration'); - my($svc_table, $svc_field) = split('\.', $cdr_svc_method); + my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method); my @cust_svc; if( $self->option('bill_inactive_svcs',1) ) { @@ -392,554 +449,172 @@ sub calc_usage { else { $svc_x = $cust_svc->svc_x; } + + unless ( $svc_x ) { + my $h = $self->option('bill_inactive_svcs',1) ? 'h_' : ''; + warn "WARNING: no $h$svc_table for svcnum ". $cust_svc->svcnum. "\n"; + } + my %options = ( - 'disable_src' => $self->option('disable_src'), - 'default_prefix' => $self->option('default_prefix'), + 'disable_src' => $self->option('disable_src',1), + 'default_prefix' => $self->option('default_prefix',1), + 'cdrtypenum' => $self->option('use_cdrtypenum',1), + 'calltypenum' => $self->option('use_calltypenum',1), 'status' => '', 'for_update' => 1, - ); # $last_bill, $$sdate ) - $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum'; - - my @invoice_details_sort; + ); + if ( $self->option('bill_only_pkg_dates') ) { + $options{'begin'} = $last_bill; + $options{'end'} = $$sdate; + } + if ( $svc_field eq 'svcnum' ) { + $options{'by_svcnum'} = 1; + } elsif ($svc_table eq 'svc_pbx' and $svc_field eq 'ip') { + $options{'by_ip_addr'} = $by_ip_addr; + } - foreach my $cdr ( - $svc_x->get_cdrs( %options ) - ) { - if ( $DEBUG > 1 ) { - warn "rating CDR $cdr\n". - join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr ); - } + #my @invoice_details_sort; + + # for tagging invoice details + # (unfortunate; should be a svc_x class method or table_info item or + # something) + my $phonenum; + if ( $svc_table eq 'svc_phone' ) { + $phonenum = $svc_x->phonenum; + } elsif ( $svc_table eq 'svc_pbx' ) { + $phonenum = $svc_x->title; + } elsif ( $svc_table eq 'svc_acct' ) { + $phonenum = $svc_x->username; + } + $formatter->phonenum($phonenum); + + #first rate any outstanding CDRs not yet rated + # use FS::Cursor for this starting in 4.x + my $cdr_search = $svc_x->psearch_cdrs(%options); + $cdr_search->limit(1000); + $cdr_search->increment(0); # because we're changing their status as we go + while ( my $cdr = $cdr_search->fetch ) { + + my $error = $cdr->rate( + 'part_pkg' => $self, + 'cust_pkg' => $cust_pkg, + 'svcnum' => $svc_x->svcnum, + 'plan_included_min' => \$included_min, + 'detail_included_min_hashref' => \%detail_included_min, + ); + die $error if $error; #?? + + $cdr_search->adjust(1) if $cdr->freesidestatus eq ''; + # it was skipped without changing status, so increment the + # offset so that we don't re-fetch it on refill - 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' ) { - - 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, - 'da_rewrote' => $da_rewrote, - 'option_cache' => \%opt_cache, - ); - - if ( $reason ) { - - 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 ); - if ( $cdr->is_tollfree && ! $disable_tollfree ) - { #tollfree call - $to_or_from = 'from'; - $number = $cdr->src; - } else { #regular call - $to_or_from = 'to'; - $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 = ''; -# $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 - $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 = length($domestic_prefix) ? $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"; - #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') - : ''; - - my $intrastate_ratenum = $cust_pkg->part_pkg->option('accountcode_tollfree_ratenum'); - if ( $intrastate_ratenum && !$cdr->is_tollfree ) { - # this is relatively easy only because: - # -assume all numbers are valid NANP numbers NOT in a fully-qualified format - # -disregard toll-free - # -disregard private or unknown numbers - # -there is exactly one record in rate_prefix for a given NPANXX - # -default to interstate if we can't find one or both of the prefixes - my $dstprefix = $cdr->dst; - $dstprefix =~ /^(\d{6})/; - $dstprefix = qsearchs('rate_prefix', { 'countrycode' => '1', - 'npa' => $1, - }) || ''; - my $srcprefix = $cdr->src; - $srcprefix =~ /^(\d{6})/; - $srcprefix = qsearchs('rate_prefix', { 'countrycode' => '1', - 'npa' => $1, - }) || ''; - $eff_ratenum = $intrastate_ratenum if ($srcprefix && $dstprefix - && $srcprefix->state && $dstprefix->state - && $srcprefix->state eq $dstprefix->state); - } - - $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, - 'cdrtypenum' => $cdr->cdrtypenum, - }); - - 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 = ''; - $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 ( $rating_method eq 'upstream_simple' ) { - - #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, - ) - ); - $classnum = $cdr->calltypenum; - - } elsif ( $rating_method eq 'single_price' ) { - - # a little false laziness w/below - # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ? - - my $granularity = length($self->option('sec_granularity')) - ? $self->option('sec_granularity') - : 60; - - $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 - && $seconds % $granularity; - my $minutes = $granularity ? ($seconds / 60) : 1; - $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, - 'seconds' => ($use_duration ? - $cdr->duration : - $cdr->billsec), - 'granularity' => $granularity, - ) - ); + } # $cdr - } else { - die "don't know how to rate CDRs using method: $rating_method\n"; + #then add details to invoices & get a total + $options{'status'} = 'rated'; + + $cdr_search = $svc_x->psearch_cdrs(%options); + $cdr_search->limit(1000); + $cdr_search->increment(0); + while ( my $cdr = $cdr_search->fetch ) { + my $error; + # at this point we officially Do Not Care about the rating method + if ( $included_calls > 0 ) { + $included_calls--; + #$charges += 0, obviously + #but don't set the rated price to zero--there should be a record + $error = $cdr->set_status('no-charge'); } - - ### - # find the price and add detail to the invoice - ### - - # if $rate_detail is not found, skip this CDR... i.e. - # 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. - "; skipping\n" - - } else { # there *is* a rate_detail (or call_details), proceed... - # About this section: - # We don't round _anything_ (except granularizing) - # until the final $charge = sprintf("%.2f"...). - - unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) { - - 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 = $rate_detail->conn_charge; - - 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 $charge_sec = min($seconds_left, $etime - $weektime); - - $seconds_left -= $charge_sec; - - $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included - unless exists $included_min{$regionnum}{$ratetimenum}; - - my $granularity = $rate_detail->sec_granularity; - - my $minutes; - if ( $granularity ) { # charge per minute - # Round up to the nearest $granularity - if ( $charge_sec and $charge_sec % $granularity ) { - $charge_sec += $granularity - ($charge_sec % $granularity); - } - $minutes = $charge_sec / 60; #don't round this - } - else { # per call - $minutes = 1; - $seconds_left = 0; - } - - $seconds += $charge_sec; - - $region_group_included_min -= $minutes - if $region_group && $rate_detail->region_group; - - $included_min{$regionnum}{$ratetimenum} -= $minutes; - if ( ($region_group_included_min <= 0 || !$rate_detail->region_group) - && $included_min{$regionnum}{$ratetimenum} <= 0 ) { - my $charge_min = 0 - $included_min{$regionnum}{$ratetimenum}; #XXX should preserve - #(display?) this - $included_min{$regionnum}{$ratetimenum} = 0; - $charge += ($rate_detail->min_charge * $charge_min); #still not rounded - } - elsif( $region_group_included_min > 0 && $region_group - && $rate_detail->region_group ) { - $included_min{$regionnum}{$ratetimenum} = 0 - } - - # choose next rate_detail - $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode, - 'phonenum' => $number, - 'weektime' => $etime, - 'cdrtypenum' => $cdr->cdrtypenum }) - 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; - - $classnum = $rate_detail->classnum; - $charge = sprintf('%.2f', $charge + 0.000001); # NOW round it. - warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG; - $charges += $charge; - - @call_details = ( - $cdr->downstream_csv( 'format' => $output_format, - 'granularity' => $rate_detail->sec_granularity, - 'seconds' => ($use_duration ? - $cdr->duration : - $cdr->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? - my $call_details; - my $phonenum = $svc_x->phonenum; - - if ( scalar(@call_details) == 1 ) { - $call_details = - [ 'C', - $call_details[0], - $charge, - $classnum, - $phonenum, - $cdr->accountcode, - $cdr->startdate, - $seconds, - $regionname, - ]; - } else { #only used for $rating_method eq 'upstream' now - $csv->combine(@call_details); - $call_details = - [ 'C', - $csv->string, - $charge, - $classnum, - $phonenum, - $cdr->accountcode, - $cdr->startdate, - $seconds, - $regionname, - ]; - } - warn " adding details on charge to invoice: [ ". - join(', ', @{$call_details} ). " ]" - if ( $DEBUG && ref($call_details) ); - push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ]; - } - - # 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' => 'XXX format' ) - # if $spool_cdr; - - my $error = $cdr->set_status_and_rated_price( 'done', - $charge, - $cust_svc->svcnum, - ); - die $error if $error; - + else { + $charges += $cdr->rated_price; + $error = $cdr->set_status('done'); } + die $error if $error; + $formatter->append($cdr) + unless $cdr->rated_price == 0 and not $usage_showzero; - } # $cdr - - my @sorted_invoice_details = sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort; - foreach my $sorted_call_detail ( @sorted_invoice_details ) { - push @$details, @{$sorted_call_detail}[0]; - } - - } # $cust_svc + $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated'; + } #$cdr + } - 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) ) + $formatter->finish; #writes into $details + unshift @$details, $formatter->header if @$details; $charges; } #returns a reason why not to rate this CDR, or false if the CDR is chargeable +# lots of false laziness w/voip_inbound 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_carrierid - use_cdrtypenum - ignore_cdrtypenum - disposition_in - ignore_disposition - skip_dst_prefix - skip_dcontext - skip_dstchannel_prefix - skip_src_length_more noskip_src_length_accountcode_tollfree - skip_dst_length_less noskip_dst_length_accountcode_tollfree - skip_lastapp - skip_max_callers - ); - 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; + if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2; - return "disposition NOT IN ( $opt{'disposition_in'} )" - if $opt{'disposition_in'} =~ /\S/ - && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'disposition_in'}); + return "disposition NOT IN ( ". $self->option_cacheable('disposition_in')." )" + if $self->option_cacheable('disposition_in') =~ /\S/ + && !grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('disposition_in')); - return "disposition IN ( $opt{'ignore_disposition'} )" - if $opt{'ignore_disposition'} =~ /\S/ - && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'ignore_disposition'}); + return "disposition IN ( ". $self->option_cacheable('ignore_disposition')." )" + if $self->option_cacheable('ignore_disposition') =~ /\S/ + && grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $self->option_cacheable('ignore_disposition')); - foreach(split(/\s*,\s*/, $opt{'skip_dst_prefix'})) { + foreach(split(/\s*,\s*/, $self->option_cacheable('skip_dst_prefix'))) { return "dst starts with '$_'" if length($_) && substr($cdr->dst,0,length($_)) eq $_; } - return "carrierid != $opt{'use_carrierid'}" - if length($opt{'use_carrierid'}) - && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches '' - && ! $flags{'da_rewrote'}; + return "carrierid NOT IN ( ". $self->option_cacheable('use_carrierid'). " )" + if $self->option_cacheable('use_carrierid') =~ /\S/ + && ! $flags{'da_rewrote'} #why? + && !grep { $cdr->carrierid eq $_ } split(/\s*,\s*/, $self->option_cacheable('use_carrierid')); #eq otherwise 0 matches '' - return "cdrtypenum != $opt{'use_cdrtypenum'}" - if length($opt{'use_cdrtypenum'}) - && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches '' + # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs. + return "cdrtypenum != ". $self->option_cacheable('use_cdrtypenum') + if length($self->option_cacheable('use_cdrtypenum')) + && $cdr->cdrtypenum ne $self->option_cacheable('use_cdrtypenum'); #ne otherwise 0 matches '' + + return "cdrtypenum == ". $self->option_cacheable('ignore_cdrtypenum') + if length($self->option_cacheable('ignore_cdrtypenum')) + && $cdr->cdrtypenum eq $self->option_cacheable('ignore_cdrtypenum'); #eq otherwise 0 matches '' + + # unlike everything else, use_calltypenum is applied in FS::svc_x::get_cdrs. + return "calltypenum != ". $self->option_cacheable('use_calltypenum') + if length($self->option_cacheable('use_calltypenum')) + && $cdr->calltypenum ne $self->option_cacheable('use_calltypenum'); #ne otherwise 0 matches '' - return "cdrtypenum == $opt{'ignore_cdrtypenum'}" - if length($opt{'ignore_cdrtypenum'}) - && $cdr->cdrtypenum eq $opt{'ignore_cdrtypenum'}; #eq otherwise 0 matches '' + return "calltypenum == ". $self->option_cacheable('ignore_calltypenum') + if length($self->option_cacheable('ignore_calltypenum')) + && $cdr->calltypenum eq $self->option_cacheable('ignore_calltypenum'); #eq otherwise 0 matches '' + + return "dcontext IN ( ". $self->option_cacheable('skip_dcontext'). " )" + if $self->option_cacheable('skip_dcontext') =~ /\S/ + && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $self->option_cacheable('skip_dcontext')); - return "dcontext IN ( $opt{'skip_dcontext'} )" - if $opt{'skip_dcontext'} =~ /\S/ - && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'}); + my $len_suffix = length($self->option_cacheable('skip_dcontext_suffix')); + return "dcontext ends with ". $self->option_cacheable('skip_dcontext_suffix') + if $len_suffix + && substr($cdr->dcontext,-$len_suffix,$len_suffix) eq $self->option_cacheable('skip_dcontext_suffix'); - my $len_prefix = length($opt{'skip_dstchannel_prefix'}); - return "dstchannel starts with $opt{'skip_dstchannel_prefix'}" + my $len_prefix = length($self->option_cacheable('skip_dstchannel_prefix')); + return "dstchannel starts with ". $self->option_cacheable('skip_dstchannel_prefix') if $len_prefix - && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'}; + && substr($cdr->dstchannel,0,$len_prefix) eq $self->option_cacheable('skip_dstchannel_prefix'); - my $dst_length = $opt{'skip_dst_length_less'}; + my $dst_length = $self->option_cacheable('skip_dst_length_less'); return "destination less than $dst_length digits" if $dst_length && length($cdr->dst) < $dst_length - && ! ( $opt{'noskip_dst_length_accountcode_tollfree'} + && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree') && $cdr->is_tollfree('accountcode') ); - return "lastapp is $opt{'skip_lastapp'}" - if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'}; + return "lastapp is ". $self->option_cacheable('skip_lastapp') + if length($self->option_cacheable('skip_lastapp')) && $cdr->lastapp eq $self->option_cacheable('skip_lastapp'); - my $src_length = $opt{'skip_src_length_more'}; + my $src_length = $self->option_cacheable('skip_src_length_more'); if ( $src_length ) { - if ( $opt{'noskip_src_length_accountcode_tollfree'} ) { + if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) { if ( $cdr->is_tollfree('accountcode') ) { return "source less than or equal to $src_length digits" @@ -956,10 +631,10 @@ sub check_chargable { } - return "max_callers <= $opt{skip_max_callers}" - if length($opt{'skip_max_callers'}) + return "max_callers <= ". $self->option_cacheable('skip_max_callers') + if length($self->option_cacheable('skip_max_callers')) and length($cdr->max_callers) - and $cdr->max_callers <= $opt{'skip_max_callers'}; + and $cdr->max_callers <= $self->option_cacheable('skip_max_callers'); #all right then, rate it ''; @@ -975,9 +650,12 @@ sub calc_units { my($self, $cust_pkg ) = @_; 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; + foreach my $pkg_svc ($cust_pkg->part_pkg->pkg_svc) { + if ($pkg_svc->part_svc->svcdb eq 'svc_phone') { # svc_pbx? + $count += $pkg_svc->quantity || 0; + } + } + $count *= $cust_pkg->quantity; } else { $count = scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc); @@ -985,5 +663,57 @@ sub calc_units { $count; } +sub reset_usage { + my ($self, $cust_pkg, %opt) = @_; + my @part_pkg_usage = $self->part_pkg_usage or return ''; + warn " resetting usage minutes\n" if $opt{debug}; + my %cust_pkg_usage = map { $_->pkgusagepart, $_ } $cust_pkg->cust_pkg_usage; + foreach my $part_pkg_usage (@part_pkg_usage) { + my $part = $part_pkg_usage->pkgusagepart; + my $usage = $cust_pkg_usage{$part} || + FS::cust_pkg_usage->new({ + 'pkgnum' => $cust_pkg->pkgnum, + 'pkgusagepart' => $part, + 'minutes' => $part_pkg_usage->minutes * + ($cust_pkg->quantity || 1), + }); + foreach my $cdr_usage ( + qsearch('cdr_cust_pkg_usage', {'cdrusagenum' => $usage->cdrusagenum}) + ) { + my $error = $cdr_usage->delete; + warn " error resetting CDR usage: $error\n"; + } + + if ( $usage->pkgusagenum ) { + if ( $part_pkg_usage->rollover ) { + $usage->set('minutes', $part_pkg_usage->minutes + $usage->minutes); + } else { + $usage->set('minutes', $part_pkg_usage->minutes); + } + my $error = $usage->replace; + warn " error resetting usage minutes: $error\n" if $error; + } else { + my $error = $usage->insert; + warn " error resetting usage minutes: $error\n" if $error; + } + } #foreach $part_pkg_usage +} + +# tells whether cust_bill_pkg_detail should return a single line for +# each phonenum +# i think this is currently unused? +sub sum_usage { + my $self = shift; + $self->option('output_format') =~ /^sum_/; +} + +# and whether cust_bill should show a detail line for the service label +# (separate from usage details) +sub hide_svc_detail { + my $self = shift; + $self->option('output_format') =~ /^sum_/; +} + + 1;