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',
+;
+
%info = (
'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
'shortname' => 'VoIP/telco CDR rating (standard)',
'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',
'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: ',
},
- '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: ',
},
'ignore_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is set to: ',
'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: ',
my %options = (
'disable_src' => $self->option('disable_src'),
'default_prefix' => $self->option('default_prefix'),
+ 'cdrtypenum' => $self->option('use_cdrtypenum'),
'status' => '',
'for_update' => 1,
); # $last_bill, $$sdate )
if ( $rating_method eq 'prefix' ) {
my $da_rewrote = 0;
+ # this will result in those CDRs being marked as done... is that
+ # what we want?
if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
$cdr->dst('411');
$da_rewrote = 1;
warn "not charging for CDR ($reason)\n" if $DEBUG;
$charge = 0;
+ # this will result in those CDRs being marked as done... is that
+ # what we want?
} else {
#if ( ! $rate_detail && ! scalar(@call_details) ) {}
if ( ! $rate_detail && $charge eq '' ) {
- warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
- "; skipping\n"
+ if ( $ignore_unrateable == 2 ) {
+ # mark the CDR as unrateable
+ my $error = $cdr->set_status_and_rated_price(
+ 'failed',
+ '',
+ $cust_svc->svcnum
+ );
+ die $error if $error;
+ }
+ elsif ( $ignore_unrateable == 1 ) {
+ # warn and continue
+ warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
+ "; skipping\n"
+ } #if $ignore_unrateable
} else { # there *is* a rate_detail (or call_details), proceed...
# About this section:
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 ( !$self->sum_usage ) {
+ @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 ( $charge > 0 ) {
+ # generate a detail record for every call; filter out $charge = 0
+ # later.
+ my $call_details;
+ my $phonenum = $svc_x->phonenum;
+
+ if ( scalar(@call_details) == 1 ) {
+ $call_details =
+ { format => 'C',
+ detail => $call_details[0],
+ amount => $charge,
+ classnum => $classnum,
+ phonenum => $phonenum,
+ accountcode => $cdr->accountcode,
+ startdate => $cdr->startdate,
+ duration => $seconds,
+ regionname => $regionname,
+ };
+ } else { #only used for $rating_method eq 'upstream' now
+ # and for sum_ formats
+ $csv->combine(@call_details);
+ $call_details =
+ { format => 'C',
+ detail => $csv->string,
+ amount => $charge,
+ classnum => $classnum,
+ phonenum => $phonenum,
+ accountcode => $cdr->accountcode,
+ startdate => $cdr->startdate,
+ duration => $seconds,
+ regionname => $regionname,
+ };
}
+ push @invoice_details_sort, [ $call_details, $cdr->calldate_unix ];
+ #} $charge > 0
# if the customer flag is on, call "downstream_csv" or something
# like it to export the call downstream!
}
} # $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];
- }
+ if ( !$self->sum_usage ) {
+ #sort them
+ my @sorted_invoice_details =
+ sort { @{$a}[1] <=> @{$b}[1] } @invoice_details_sort;
+ foreach my $sorted_call_detail ( @sorted_invoice_details ) {
+ my $d = $sorted_call_detail->[0];
+ push @$details, $d if $d->{amount} > 0;
+ }
+ }
+ else { #$self->sum_usage
+ push @$details, $self->sum_detail($svc_x, \@invoice_details_sort);
+ }
} # $cust_svc
- unshift @$details, [ 'C',
- FS::cdr::invoice_header($output_format),
- '',
- '',
- '',
- '',
- '',
- ]
+ unshift @$details, { format => 'C',
+ detail => 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) )
-
$charges;
}
if $opt{'ignore_disposition'} =~ /\S/
&& grep { $cdr->disposition eq $_ } split(/\s*,\s*/, $opt{'ignore_disposition'});
+ foreach(split(/\s*,\s*/, $opt{'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'};
+ # unlike everything else, use_cdrtypenum is applied in FS::svc_x::get_cdrs.
return "cdrtypenum != $opt{'use_cdrtypenum'}"
if length($opt{'use_cdrtypenum'})
&& $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
if length($opt{'ignore_cdrtypenum'})
&& $cdr->cdrtypenum eq $opt{'ignore_cdrtypenum'}; #eq otherwise 0 matches ''
- foreach(split(',',$opt{'skip_dst_prefix'})) {
- return "dst starts with '$_'"
- if length($_) && substr($cdr->dst,0,length($_)) eq $_;
- }
-
return "dcontext IN ( $opt{'skip_dcontext'} )"
if $opt{'skip_dcontext'} =~ /\S/
&& grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
$count;
}
+# tells whether cust_bill_pkg_detail should return a single line for
+# each phonenum
+sub sum_usage {
+ my $self = shift;
+ $self->option('output_format') =~ /^sum_/;
+}
+
+sub sum_detail {
+ my $self = shift;
+ my $svc_x = shift;
+ my $invoice_details = shift || [];
+ my $count = scalar(@$invoice_details);
+ return () if !$count;
+ my $sum_detail = {
+ amount => 0,
+ format => 'C',
+ classnum => '', #XXX
+ duration => 0,
+ phonenum => $svc_x->phonenum,
+ accountcode => '', #XXX
+ startdate => '', #XXX
+ regionnam => '',
+ };
+ # combine the entire set of CDRs
+ foreach ( @$invoice_details ) {
+ $sum_detail->{amount} += $_->[0]{amount};
+ $sum_detail->{duration} += $_->[0]{duration};
+ }
+ my $total_cdr = FS::cdr->new({
+ 'billsec' => $sum_detail->{duration},
+ 'src' => $sum_detail->{phonenum},
+ });
+ $sum_detail->{detail} = $total_cdr->downstream_csv(
+ format => $self->option('output_format'),
+ seconds => $sum_detail->{duration},
+ charge => sprintf('%.2f',$sum_detail->{amount}),
+ phonenum => $sum_detail->{phonenum},
+ count => $count,
+ );
+ return $sum_detail;
+}
+
+# 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;