use Tie::IxHash;
use FS::Conf;
use FS::Record qw(qsearchs qsearch);
-use FS::part_pkg::flat;
+use FS::part_pkg::recur_Common;
use FS::cdr;
-#use FS::rate;
-#use FS::rate_prefix;
+use FS::rate;
+use FS::rate_prefix;
+use FS::rate_detail;
+use FS::part_pkg::recur_Common;
-@ISA = qw(FS::part_pkg::flat);
+use List::Util qw(first min);
-$DEBUG = 1;
+@ISA = qw(FS::part_pkg::recur_Common);
+
+$DEBUG = 0;
+
+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)',
+;
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 %cdr_location, 'Tie::IxHash',
'preceding' => "Preceding (past)",
;
+tie my %granularity, 'Tie::IxHash', FS::rate_detail::granularities();
+
%info = (
'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
'shortname' => 'VoIP/telco CDR rating (standard)',
+ 'inherit_fields' => [ 'global_Mixin' ],
'fields' => {
- 'setup_fee' => { 'name' => 'Setup fee for this package',
- 'default' => 0,
- },
- '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',
+ 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating or '.
+ 'subscription',
+ 'default' => '1',
+ },
+ 'add_full_period'=> { 'name' => 'When prorating first month, also bill '.
+ 'for one full period after that',
+ 'type' => 'checkbox',
+ },
+ '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',
+ 'options' => \%cdr_svc_method,
+ },
+
+ 'rating_method' => { 'name' => '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,
- },
+
+ 'min_included' => { 'name' => 'Minutes included when using the "single price per minute" rating method or when using the "prefix" rating method ("region group" billing)',
+ },
+
+ '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' => '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',
# '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',
'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',
},
'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
},
- '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 values: ',
+ },
+
+ '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_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' => '',
+ },
+
+ '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: ',
+ },
+
+ '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 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',
+ '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',
},
+ 'usage_mandate' => { 'name' => 'Always put usage details in separate section',
+ 'type' => 'checkbox',
+ },
+ #eofalse
+
+ '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',
+ },
+
+ '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
# 'cdr_location' => { 'name' => 'CDR database location'
# 'type' => 'select',
},
'fieldorder' => [qw(
- setup_fee recur_fee recur_temporality unused_credit
- rating_method ratenum
+ recur_temporality
+ recur_method cutoff_day
+ add_full_period
+ cdr_svc_method
+ rating_method ratenum min_charge min_included
+ sec_granularity
+ ignore_unrateable
default_prefix
disable_src
domestic_prefix international_prefix
+ disable_tollfree
use_amaflags use_disposition
use_disposition_taqua use_carrierid use_cdrtypenum
+ skip_dcontext skip_dst_prefix
+ skip_dstchannel_prefix skip_src_length_more
+ noskip_src_length_accountcode_tollfree
+ accountcode_tollfree_ratenum
+ skip_dst_length_less
+ noskip_dst_length_accountcode_tollfree
+ skip_lastapp
+ skip_max_callers
+ use_duration
411_rewrite
- output_format summarize_usage usage_section
+ output_format usage_mandate summarize_usage usage_section
+ bill_every_call bill_inactive_svcs
+ count_available_phones
)
],
'weight' => 40,
);
+sub price_info {
+ my $self = shift;
+ my $str = $self->SUPER::price_info;
+ $str .= " plus usage" if $str;
+ $str;
+}
+
sub calc_setup {
my($self, $cust_pkg ) = @_;
$self->option('setup_fee');
}
-#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 $charges = 0;
+
+ $charges += $self->calc_usage(@_);
+ $charges += $self->calc_recur_Common(@_);
+
+ $charges;
+
+}
+
+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
+
+sub calc_usage {
+ 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
return 0
- if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
+ if $self->option('recur_temporality', 1) eq 'preceding'
+ && ( $last_bill eq '' || $last_bill == 0 );
my $ratenum = $cust_pkg->part_pkg->option('ratenum');
my $charges = 0;
- my $downstream_cdr = '';
+# my $downstream_cdr = '';
+
+ 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') || 0) > 0);
+ my $region_group_included_min = $region_group ? $self->option('min_included') : 0;
- my $output_format = $self->option('output_format', 'Hush!')
- || 'simple';
+ 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);
+ }
+
+ my %interval_cache = (); # for timed rates
+
+ #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
- ) {
+ my($svc_table, $svc_field) = 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;
+ }
+ my %options = (
+ 'disable_src' => $self->option('disable_src'),
+ 'default_prefix' => $self->option('default_prefix'),
+ 'status' => '',
+ 'for_update' => 1,
+ ); # $last_bill, $$sdate )
+ $options{'by_svcnum'} = 1 if $svc_field eq 'svcnum';
+
+ my @invoice_details_sort;
foreach my $cdr (
- $cust_svc->get_cdrs_for_update( 'disable_src' => $self->option('disable_src'),
- 'default_prefix' => $self->option('default_prefix'),
- ) # $last_bill, $$sdate )
+ $svc_x->get_cdrs( %options )
) {
if ( $DEBUG > 1 ) {
warn "rating CDR $cdr\n".
my $rate_detail;
my( $rate_region, $regionnum );
+ my $rate;
my $pretty_destnum;
my $charge = '';
+ my $seconds = '';
+ my $weektime = '';
+ my $regionname = '';
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' ) {
+ my $countrycode;
+ my $number;
- 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;
+ my @call_details = ();
+ if ( $rating_method eq 'prefix' ) {
- } elsif ( $self->option('use_carrierid')
- && $cdr->carrierid != $self->option('use_carrierid') ) {
+ my $da_rewrote = 0;
+ if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
+ $cdr->dst('411');
+ $da_rewrote = 1;
+ }
- warn "$notchg (carrierid != ". $self->option('use_carrierid'). ")\n"
- if $DEBUG;
- $charge = 0;
+ my $reason = $self->check_chargable( $cdr,
+ 'da_rewrote' => $da_rewrote,
+ 'option_cache' => \%opt_cache,
+ );
- } elsif ( $self->option('use_cdrtypenum')
- && $cdr->cdrtypenum != $self->option('use_cdrtypenum') ) {
+ if ( $reason ) {
- warn "$notchg (cdrtypenum != ". $self->option('use_cdrtypenum'). ")\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)
###
- 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
+ my( $to_or_from );
+ if ( $cdr->is_tollfree && ! $disable_tollfree )
+ { #tollfree call
$to_or_from = 'from';
$number = $cdr->src;
} else { #regular call
$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 = '';
# 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
+ $countrycode = '';
+ if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
|| $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
)
{
}
} else {
- $countrycode = $self->option('domestic_prefix') || '1';
+ $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')
+ : '';
+ $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;
+ }
- #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;
+ } elsif ( $ignore_unrateable ) {
- $regionnum = $rate_prefix->regionnum;
- $rate_detail = qsearchs('rate_detail', {
- 'ratenum' => $ratenum,
- 'dest_regionnum' => $regionnum,
- } );
+ $rate_region = '';
+ $regionnum = '';
+ #code below will throw a warning & skip
- $rate_region = $rate_prefix->rate_region;
+ } else {
- warn " found rate for regionnum $regionnum ".
- "and rate detail $rate_detail\n"
- if $DEBUG;
+ 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_simple' ) {
- if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
+ #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;
- $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
+ @call_details = ($cdr->downstream_csv( 'format' => $output_format,
+ 'charge' => $charge,
+ )
+ );
+ $classnum = $cdr->calltypenum;
- $regionnum = $rate_detail->dest_regionnum;
- $rate_region = $rate_detail->dest_region;
+ } elsif ( $rating_method eq 'single_price' ) {
- $pretty_destnum = $cdr->dst;
+ # a little false laziness w/below
+ # $rate_detail = new FS::rate_detail({sec_granularity => ... }) ?
- warn " found rate for regionnum $regionnum and ".
- "rate detail $rate_detail\n"
- if $DEBUG;
+ my $granularity = length($self->option('sec_granularity'))
+ ? $self->option('sec_granularity')
+ : 60;
- } else { #pass upstream price through
+ $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
- $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,
- );
+ $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
- }
-
- } elsif ( $self->option('rating_method') eq 'upstream_simple' ) {
-
- #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
- $charge = sprintf('%.3f', $cdr->upstream_price);
+ warn "Incrementing \$charges by $charge. Now $charges\n" if $DEBUG;
$charges += $charge;
- @call_details = ($cdr->downstream_csv( 'format' => $output_format ));
+ @call_details = ($cdr->downstream_csv( 'format' => $output_format,
+ 'charge' => $charge,
+ 'seconds' => ($use_duration ?
+ $cdr->duration :
+ $cdr->billsec),
+ 'granularity' => $granularity,
+ )
+ );
} 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";
}
###
###
# 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...
+ # About this section:
+ # We don't round _anything_ (except granularizing)
+ # until the final $charge = sprintf("%.2f"...).
unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
- $included_min{$regionnum} = $rate_detail->min_included
- unless exists $included_min{$regionnum};
+ 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 $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;
+ my $charge_sec = min($seconds_left, $etime - $weektime);
- # per call rather than per minute
- $minutes = 1 unless $granularity;
+ $seconds_left -= $charge_sec;
- $included_min{$regionnum} -= $minutes;
+ $included_min{$regionnum}{$ratetimenum} = $rate_detail->min_included
+ unless exists $included_min{$regionnum}{$ratetimenum};
- 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;
- }
+ 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;
+
+ $included_min{$regionnum}{$ratetimenum} -= $minutes;
+ if ( $region_group_included_min <= 0
+ && $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
+ }
+
+ # 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;
- @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;
+ $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;
- if ( $self->option('rating_method') eq 'upstream_simple' ) {
- $call_details = [ 'C', $call_details[0], $charge, $classnum ];
- }else{
+ my $phonenum = $svc_x->phonenum;
+
+ if ( scalar(@call_details) == 1 ) {
+ $call_details =
+ [ 'C',
+ $call_details[0],
+ $charge,
+ $classnum,
+ $phonenum,
+ $seconds,
+ $regionname,
+ ];
+ } else { #only used for $rating_method eq 'upstream' now
$csv->combine(@call_details);
- $call_details = [ 'C', $csv->string, $charge, $classnum ];
+ $call_details =
+ [ 'C',
+ $csv->string,
+ $charge,
+ $classnum,
+ $phonenum,
+ $seconds,
+ $regionname,
+ ];
}
warn " adding details on charge to invoice: [ ".
join(', ', @{$call_details} ). " ]"
if ( $DEBUG && ref($call_details) );
- push @$details, $call_details; #\@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' => 'convergent' )
- if $spool_cdr;
+ #$downstream_cdr .= $cdr->downstream_csv( 'format' => 'XXX format' )
+ # if $spool_cdr;
- my $error = $cdr->set_status_and_rated_price('done', $charge);
+ my $error = $cdr->set_status_and_rated_price( 'done',
+ $charge,
+ $cust_svc->svcnum,
+ );
die $error if $error;
}
} # $cdr
-
- unshift @$details, [ 'C', FS::cdr::invoice_header( $output_format) ]
- if (@$details && $self->option('rating_method') eq 'upstream_simple' );
+
+ 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
- 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) )
-
- $self->option('recur_fee') + $charges;
+ 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) )
+
+ $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_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;
+
+ 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 ''
+
+ 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'});
+
+ 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
+ && ! ( $opt{'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'};
+
+ my $src_length = $opt{'skip_src_length_more'};
+ if ( $src_length ) {
+
+ if ( $opt{'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;
+ }
+
+ } else {
+ return "source more than $src_length digits"
+ if length($cdr->src) > $src_length;
+ }
+
+ }
+
+ return "max_callers <= $opt{skip_max_callers}"
+ if length($opt{'skip_max_callers'})
+ and length($cdr->max_callers)
+ and $cdr->max_callers <= $opt{'skip_max_callers'};
+
+ #all right then, rate it
+ '';
}
sub is_free {
0;
}
-sub base_recur {
- my($self, $cust_pkg) = @_;
- $self->option('recur_fee');
-}
-
# This equates svc_phone records; perhaps svc_phone should have a field
# to indicate it represents a line
sub calc_units {
my($self, $cust_pkg ) = @_;
- scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
+ 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;
+ } else {
+ $count =
+ scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
+ }
+ $count;
}
1;