X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_pkg%2Fvoip_cdr.pm;h=073d7792a2eac4684fde8420bbb43a47c9ad1d74;hp=6d76f8bf727bdef422b3f2b4f603991571f0478d;hb=db5785cba180e2c210d3ab4d37064c7e61898614;hpb=23ef7c8565b6a83db88c9294c20f71ed5ac3bd10 diff --git a/FS/FS/part_pkg/voip_cdr.pm b/FS/FS/part_pkg/voip_cdr.pm index 6d76f8bf7..df972868c 100644 --- a/FS/FS/part_pkg/voip_cdr.pm +++ b/FS/FS/part_pkg/voip_cdr.pm @@ -1,24 +1,37 @@ package FS::part_pkg::voip_cdr; +use base qw( FS::part_pkg::recur_Common ); use strict; -use vars qw(@ISA $DEBUG %info); -use Date::Format; +use vars qw( $DEBUG %info ); use Tie::IxHash; +use Date::Format; +use Text::CSV_XS; 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::detail_format; -@ISA = qw(FS::part_pkg::flat); +$DEBUG = 0; -$DEBUG = 1; +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', '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 %rounding, 'Tie::IxHash', + '2' => 'Two decimal places (cent)', + '4' => 'Four decimal places (100th of a cent)', ; #tie my %cdr_location, 'Tie::IxHash', @@ -32,38 +45,94 @@ tie my %temporalities, 'Tie::IxHash', 'preceding' => "Preceding (past)", ; +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)', + 'inherit_fields' => [ 'prorate_Mixin', 'global_Mixin' ], 'fields' => { - 'setup_fee' => { 'name' => 'Setup fee for this package', - 'default' => 0, - }, - 'recur_fee' => { 'name' => 'Base recurring fee for this package', - 'default' => 0, - }, - + 'suspend_bill' => { 'name' => 'Continue recurring billing while suspended', + 'type' => 'checkbox', + }, #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', + 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '. + 'subscription', + 'default' => '1', }, - 'ratenum' => { 'name' => 'Rate plan', - 'type' => 'select', - 'select_table' => 'rate', - 'select_key' => 'ratenum', - 'select_label' => 'ratename', - }, - 'rating_method' => { 'name' => 'Region rating method', + 'recur_method' => { 'name' => 'Recurring fee method', + #'type' => 'radio', + #'options' => \%recur_method, + 'type' => 'select', + 'select_options' => \%FS::part_pkg::recur_Common::recur_method, + }, + + 'cdr_svc_method' => { 'name' => 'CDR service matching method', +# 'type' => 'radio', + 'type' => 'select', + 'select_options' => \%cdr_svc_method, + }, + + 'rating_method' => { 'name' => 'Rating method', 'type' => 'radio', 'options' => \%rating_method, }, + 'rounding' => { 'name' => 'Rounding for destination prefix rating', + 'type' => 'select', + 'select_options' => \%rounding, + }, + + 'ratenum' => { 'name' => 'Rate plan', + 'type' => 'select-rate', + }, + + 'intrastate_ratenum' => { 'name' => 'Optional alternate intrastate rate plan', + 'type' => 'select-rate', + 'disable_empty' => 0, + 'empty_label' => ' ', + }, + + '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', + }, + + 'sec_granularity' => { 'name' => 'Granularity when using "single price per minute" rating method', + 'type' => 'select', + 'select_options' => \%granularity, + }, + + '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', 'default' => '+1', }, @@ -80,44 +149,150 @@ tie my %temporalities, 'Tie::IxHash', # 'type' => 'checkbox', # }, - 'international_prefix' => { 'name' => 'Destination prefix(es) for international CDR records. Separate multiple options with commas.', + 'international_prefix' => { 'name' => 'Destination prefix for international CDR records (or "none" for no prefix)', 'default' => '011', }, - 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").', + 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing', + 'type' => 'checkbox', + }, + + 'use_amaflags' => { 'name' => 'Only charge for CDRs where the amaflags field is 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', + 'use_carrierid' => { 'name' => 'Only charge for CDRs where the Carrier ID is set to any of these (comma-separated) values: ', }, - 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).', - 'type' => 'checkbox', - }, + '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 this cdrtypenum: ', + }, - 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ', + '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' => 'Only charge for CDRs where the Disposition 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: ', + 'disposition_prefix' => { 'name' => 'Only charge for CDRs where the Disposition starts with: ', }, - '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes: ', + 'skip_dst_prefix' => { 'name' => 'Do not charge for CDRs where the destination number starts with 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:', + }, + + 'skip_src_length_more' => { 'name' => 'Do not charge for CDRs where the source is more than this many digits:', + }, + + 'noskip_src_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where source is equal or greater than the specified digits, when accountcode is toll free', + 'type' => 'checkbox', + }, + + 'accountcode_tollfree_ratenum' => { + 'name' => 'Optional alternate rate plan when accountcode is toll free: ', + 'type' => 'select', + 'select_table' => 'rate', + 'select_key' => 'ratenum', + 'select_label' => 'ratename', + 'disable_empty' => 0, + '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:', + }, + + 'noskip_dst_length_accountcode_tollfree' => { 'name' => 'Do charge for CDRs where dst is less than the specified digits, when accountcode is toll free', + 'type' => 'checkbox', + }, + + 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value: ', }, - 'output_format' => { 'name' => 'Simple output format', + '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', + }, + + '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 display format for invoices', 'type' => 'select', - 'select_options' => { FS::cdr::invoice_formats() }, + 'select_options' => \%detail_formats, + 'default' => 'default', #XXX test }, - 'usage_section' => { 'name' => 'Section in which to place separate usage charges', + '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): ', }, 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section', 'type' => 'checkbox', }, - #XXX also have option for an external db + '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', + }, + + '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', + }, + + #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, @@ -142,389 +317,401 @@ tie my %temporalities, 'Tie::IxHash', }, 'fieldorder' => [qw( - setup_fee recur_fee recur_temporality unused_credit - rating_method ratenum + recur_temporality + recur_method cutoff_day ), + FS::part_pkg::prorate_Mixin::fieldorder, + qw( + cdr_svc_method + rating_method rounding ratenum intrastate_ratenum + calls_included + min_charge min_included + sec_granularity + ignore_unrateable default_prefix disable_src domestic_prefix international_prefix - use_amaflags use_disposition - use_disposition_taqua use_carrierid use_cdrtypenum + disable_tollfree + use_amaflags + use_carrierid + use_cdrtypenum ignore_cdrtypenum + use_calltypenum ignore_calltypenum + ignore_disposition disposition_in disposition_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_field + skip_dst_length_less + noskip_dst_length_accountcode_tollfree + skip_lastapp + skip_max_callers + skip_same_customer + use_duration 411_rewrite - output_format summarize_usage usage_section + 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 + suspend_bill ) ], - 'weight' => 40, + 'weight' => 41, ); -sub calc_setup { - my($self, $cust_pkg ) = @_; - $self->option('setup_fee'); +sub price_info { + my $self = shift; + my $str = $self->SUPER::price_info(@_); + $str .= " plus usage" if $str; + $str; } -#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 + my $charges = 0; - return 0 - if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0; + $charges += $self->calc_usage(@_); + $charges += ($cust_pkg->quantity || 1) * $self->calc_recur_Common(@_); - my $ratenum = $cust_pkg->part_pkg->option('ratenum'); + $charges; - my $spool_cdr = $cust_pkg->cust_main->spool_cdr; +} - my %included_min = (); +# use the default +#sub calc_cancel { +# my $self = shift; +# my($cust_pkg, $sdate, $details, $param ) = @_; +# +# $self->calc_usage(@_); +#} - my $charges = 0; +#false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again - my $downstream_cdr = ''; +sub calc_usage { + my $self = shift; + my($cust_pkg, $sdate, $details, $param ) = @_; - my $output_format = $self->option('output_format', 'Hush!') - || 'simple'; + #my $last_bill = $cust_pkg->last_bill; + my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup - eval "use Text::CSV_XS;"; - die $@ if $@; - my $csv = new Text::CSV_XS; + return 0 + if $self->recur_temporality eq 'preceding' + && ( $last_bill eq '' || $last_bill == 0 ); - foreach my $cust_svc ( - grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc - ) { + my $charges = 0; - foreach my $cdr ( - $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". - join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr ); - } + my $included_min_total = ($self->option('min_included', 1) || 0) + * ($cust_pkg->quantity || 1); + #single price rating + #or region group + my $included_min_left = $included_min_total; + + 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 %detail_included_min = (); + + my $output_format = $self->option('output_format', 'Hush!') + || ( $rating_method eq 'upstream_simple' + ? 'simple' + : 'default' + ); + + my $usage_showzero = $self->option('usage_showzero', 1); + + my $formatter = FS::detail_format->new($output_format, + buffer => $details, + locale => $cust_pkg->cust_main->locale, + rounding => ($self->option_cacheable('rounding') || 2), + ); + + my $use_duration = $self->option('use_duration'); + + my($svc_table, $svc_field, $by_ip_addr) = split('\.', $cdr_svc_method); + + my @cust_svc; + if( $self->option('bill_inactive_svcs',1) ) { + #XXX in this mode do we need to restrict the set of CDRs by date also? + @cust_svc = $cust_pkg->h_cust_svc($$sdate, $last_bill); + } + else { + @cust_svc = $cust_pkg->cust_svc; + } + @cust_svc = grep { $_->part_svc->svcdb eq $svc_table } @cust_svc; + + foreach my $cust_svc (@cust_svc) { + + my $svc_x; + if( $self->option('bill_inactive_svcs',1) ) { + $svc_x = $cust_svc->h_svc_x($$sdate, $last_bill); + } + 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',1), + 'default_prefix' => $self->option('default_prefix',1), + 'cdrtypenum' => $self->option('use_cdrtypenum',1), + 'calltypenum' => $self->option('use_calltypenum',1), + 'status' => '', + 'for_update' => 1, + ); + 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; + } + + #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_left, + '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 $pretty_destnum; - my $charge = ''; - my $classnum = ''; - my @call_details = (); - if ( $self->option('rating_method') eq 'prefix' - || ! $self->option('rating_method') - ) - { - - #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' ) { - - warn "$notchg (disposition != ANSWERED)\n" if $DEBUG; - $charge = 0; - - } elsif ( $self->option('use_disposition_taqua') - && $cdr->disposition != 100 ) { - - 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; - $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/ ) { #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'; - my @intl = (); - if ( $intl =~ /,/ ) { - @intl = split(/\s*,\s*/, $intl); - } else { - @intl = ($intl); - } - - #determine the country code - my $countrycode; - if ( grep { $number =~ /^$_(((\d)(\d))(\d))(\d+)$/ } @intl - || $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' ) { - - 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, - ); - - } - - } 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 )); + } # $cdr - } else { - die "don't know how to rate CDRs using method: ". - $self->option('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 NULL, - # 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... - - 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; # 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 - $granularity ? $minutes.'m' : $minutes.' call', - '$'.$charge, - $pretty_destnum, - $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], $charge, $classnum ]; - }else{ - $csv->combine(@call_details); - $call_details = [ 'C', $csv->string, $charge, $classnum ]; - } - 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; - + 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 + $cdr_search->adjust(1) if $cdr->freesidestatus eq 'rated'; + } #$cdr + } + + $formatter->finish; #writes into $details + unshift @$details, $formatter->header if @$details; - unshift @$details, [ 'C', FS::cdr::invoice_header( $output_format) ] - if (@$details && $self->option('rating_method') eq 'upstream_simple' ); + if ( $included_min_total > 0 ) { - } # $cust_svc + my $min_detail = sprintf('%d / %d ', + $included_min_total - $included_min_left, + $included_min_total + ) . $cust_pkg->mt('included minutes used'); + unshift @$details, $min_detail; + } - if ( $spool_cdr && length($downstream_cdr) ) { + $charges; +} - 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 +#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 ) = @_; + + return 'amaflags != 2' + if $self->option_cacheable('use_amaflags') && $cdr->amaflags != 2; + + 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')); + + my $disposition_prefix = $self->option_cacheable('disposition_prefix'); + my $len_dis_prefix = length($disposition_prefix); + return "disposition does not start with $disposition_prefix" + if $len_dis_prefix + && substr($cdr->disposition, 0, $len_dis_prefix) ne $disposition_prefix; + + 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*/, $self->option_cacheable('skip_dst_prefix'))) { + return "dst starts with '$_'" + if length($_) && substr($cdr->dst,0,length($_)) eq $_; + } + + 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 '' + + # 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 "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')); + + 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($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 $self->option_cacheable('skip_dstchannel_prefix'); + + 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 + && ! ( $self->option_cacheable('noskip_dst_length_accountcode_tollfree') + && $cdr->is_tollfree('accountcode') + ); + + 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 = $self->option_cacheable('skip_src_length_more'); + if ( $src_length ) { + + if ( $self->option_cacheable('noskip_src_length_accountcode_tollfree') ) { + + if ( $cdr->is_tollfree('accountcode') ) { + return "source less than or equal to $src_length digits" + if length($cdr->src) <= $src_length; + } else { + return "source more than $src_length digits" + if length($cdr->src) > $src_length; + } - 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; - }; + } else { + return "source more than $src_length digits" + if length($cdr->src) > $src_length; + } - } #if ( $spool_cdr && length($downstream_cdr) ) + } - $self->option('recur_fee') + $charges; + 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 <= $self->option_cacheable('skip_max_callers'); + #all right then, rate it + ''; } sub is_free { 0; } -sub base_recur { - my($self, $cust_pkg) = @_; - $self->option('recur_fee'); +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_/; } -# 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); +# 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;