use vars qw(@ISA $DEBUG %info);
use Date::Format;
use Tie::IxHash;
+use Time::Local;
use FS::Conf;
use FS::Record qw(qsearchs qsearch);
use FS::part_pkg::flat;
use FS::cdr;
-#use FS::rate;
-#use FS::rate_prefix;
+use FS::rate;
+use FS::rate_prefix;
+use FS::rate_detail;
-@ISA = qw(FS::part_pkg::flat);
+@ISA = qw(FS::part_pkg::prorate);
-$DEBUG = 1;
+$DEBUG = 0;
tie my %rating_method, 'Tie::IxHash',
'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
;
+tie my %recur_method, 'Tie::IxHash',
+ 'anniversary' => 'Charge the recurring fee at the frequency specified above',
+ 'prorate' => 'Charge a prorated fee the first time (selectable billing date)',
+ 'subscription' => 'Charge the full fee for the first partial period (selectable billing date)',
+;
+
#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 '.
# 'Asterisk (or other?) CDR table',
#;
+tie my %temporalities, 'Tie::IxHash',
+ 'upcoming' => "Upcoming (future)",
+ 'preceding' => "Preceding (past)",
+;
+
%info = (
'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
'shortname' => 'VoIP/telco CDR rating (standard)',
'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',
+ },
+
+ 'recur_method' => { 'name' => 'Recurring fee method',
+ #'type' => 'radio',
+ #'options' => \%recur_method,
+ 'type' => 'select',
+ 'select_options' => \%recur_method,
+ },
+
+ 'rating_method' => { 'name' => 'Region rating method',
+ 'type' => 'radio',
+ 'options' => \%rating_method,
+ },
+
'ratenum' => { 'name' => 'Rate plan',
'type' => 'select',
'select_table' => 'rate',
'select_key' => 'ratenum',
'select_label' => 'ratename',
},
- 'rating_method' => { 'name' => 'Region rating method',
- 'type' => 'radio',
- 'options' => \%rating_method,
- },
+
+ 'ignore_unrateable' => { 'name' => 'Ignore calls without a rate in the rate tables. By default, the system will throw a fatal error upon encountering unrateable calls.',
+ 'type' => 'checkbox',
+ },
'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
'default' => '+1',
'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',
},
'type' => 'checkbox',
},
- 'output_format' => { 'name' => 'Simple output format',
+ 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
+ 'type' => 'checkbox',
+ },
+
+ 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
+ },
+
+ 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
+ },
+
+ 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
+ },
+
+ 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
+ },
+
+ 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
+ },
+
+ 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
+ },
+
+ 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
+ 'type' => 'checkbox',
+ },
+
+ '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
+ },
+
+ 'output_format' => { 'name' => 'CDR invoice display format',
'type' => 'select',
'select_options' => { FS::cdr::invoice_formats() },
+ 'default' => 'default', #XXX test
},
- 'separate_usage' => { 'name' => 'Separate usage charges from recurring charges',
+ 'usage_section' => { 'name' => 'Section in which to place separate usage charges',
+ },
+
+ 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
'type' => 'checkbox',
},
+ 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.',
+ 'type' => 'checkbox',
+ },
+
+ '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 unused_credit
- rating_method ratenum
+ setup_fee recur_fee recur_temporality unused_credit
+ recur_method cutoff_day
+ rating_method ratenum ignore_unrateable
default_prefix
disable_src
domestic_prefix international_prefix
- use_amaflags use_disposition output_format
- separate_usage
+ disable_tollfree
+ use_amaflags use_disposition
+ use_disposition_taqua use_carrierid use_cdrtypenum
+ skip_dcontext skip_dstchannel_prefix
+ skip_dst_length_less skip_lastapp
+ use_duration
+ 411_rewrite
+ output_format summarize_usage usage_section
+ bill_every_call
+ count_available_phones
)
],
'weight' => 40,
$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 = shift;
- my $charges = 0;
- $charges = $self->calc_usage(@_)
- unless $self->option('separate_usage', 'Hush!');
- $self->option('recur_fee') + $charges;
-}
+ my($cust_pkg, $sdate, $details, $param ) = @_;
-#false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
-sub calc_usage {
- my($self, $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 $last_bill = $cust_pkg->last_bill;
+ return 0
+ if $self->option('recur_temporality', 1) eq 'preceding'
+ && ( $last_bill eq '' || $last_bill == 0 );
my $ratenum = $cust_pkg->part_pkg->option('ratenum');
my $downstream_cdr = '';
- my $output_format = $self->option('output_format', 'Hush!')
- || 'simple';
+ my $rating_method = $self->option('rating_method') || 'prefix';
+ my $intl = $self->option('international_prefix') || '011';
+ my $domestic_prefix = $self->option('domestic_prefix');
+ my $disable_tollfree = $self->option('disable_tollfree');
+ my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
+ my $use_duration = $self->option('use_duration');
+
+ my $output_format = $self->option('output_format', 'Hush!')
+ || ( $rating_method eq 'upstream_simple'
+ ? 'simple'
+ : 'default'
+ );
+
+ my @dirass = ();
+ if ( $self->option('411_rewrite') ) {
+ my $dirass = $self->option('411_rewrite');
+ $dirass =~ s/\s//g;
+ @dirass = split(',', $dirass);
+ }
+
+ #for check_chargable, so we don't keep looking up options inside the loop
+ my %opt_cache = ();
eval "use Text::CSV_XS;";
die $@ if $@;
) {
foreach my $cdr (
- $cust_svc->get_cdrs_for_update( 'disable_src' => $self->option('disable_src'),
- 'default_prefix' => $self->option('default_prefix'),
- ) # $last_bill, $$sdate )
+ $cust_svc->get_cdrs_for_update(
+ 'disable_src' => $self->option('disable_src'),
+ 'default_prefix' => $self->option('default_prefix'),
+ ) # $last_bill, $$sdate )
) {
if ( $DEBUG > 1 ) {
warn "rating CDR $cdr\n".
my( $rate_region, $regionnum );
my $pretty_destnum;
my $charge = '';
+ my $classnum = '';
my @call_details = ();
- if ( $self->option('rating_method') eq 'prefix'
- || ! $self->option('rating_method')
- )
- {
+ if ( $rating_method eq 'prefix' ) {
- if ( $self->option('use_amaflags') && $cdr->amaflags != 2 ) {
+ my $da_rewrote = 0;
+ if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
+ $cdr->dst('411');
+ $da_rewrote = 1;
+ }
- warn "not charging for CDR (amaflags != 2)\n" if $DEBUG;
- $charge = 0;
+ my $reason = $self->check_chargable( $cdr,
+ 'da_rewrote' => $da_rewrote,
+ 'option_cache' => \%opt_cache,
+ );
- } elsif ( $self->option('use_disposition')
- && $cdr->disposition ne 'ANSWERED' ) {
+ if ( $reason ) {
- warn "not charging for CDR (disposition != ANSWERED)\n" if $DEBUG;
+ warn "not charging for CDR ($reason)\n" if $DEBUG;
$charge = 0;
} else {
-
+
###
# look up rate details based on called station id
# (or calling station id for toll free calls)
###
my( $to_or_from, $number );
- if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/ ) { #tollfree call
+ if ( $cdr->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';
-
#determine the country code
my $countrycode;
if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
}
} else {
- $countrycode = $self->option('domestic_prefix') || '1';
+ $countrycode = $domestic_prefix || '1';
$number =~ s/^$countrycode//;# if length($number) > 10;
}
warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
$pretty_destnum = "+$countrycode $number";
- #find a rate prefix, first look at most specific (4 digits) then 3, etc.,
- # finally trying the country code only
- my $rate_prefix = '';
- for my $len ( reverse(1..6) ) {
- $rate_prefix = qsearchs('rate_prefix', {
- 'countrycode' => $countrycode,
- #'npa' => { op=> 'LIKE', value=> substr($number, 0, $len) }
- 'npa' => substr($number, 0, $len),
- } ) and last;
- }
- $rate_prefix ||= qsearchs('rate_prefix', {
- 'countrycode' => $countrycode,
- 'npa' => '',
- });
+ my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
+ or die "ratenum $ratenum not found!";
- #
- die "Can't find rate for call $to_or_from +$countrycode $number\n"
- unless $rate_prefix;
+ $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
+ 'phonenum' => $number,
+ });
- $regionnum = $rate_prefix->regionnum;
- $rate_detail = qsearchs('rate_detail', {
- 'ratenum' => $ratenum,
- 'dest_regionnum' => $regionnum,
- } );
+ if ( $rate_detail ) {
- $rate_region = $rate_prefix->rate_region;
+ $rate_region = $rate_detail->dest_region;
+ $regionnum = $rate_region->regionnum;
+ warn " found rate for regionnum $regionnum ".
+ "and rate detail $rate_detail\n"
+ if $DEBUG;
- warn " found rate for regionnum $regionnum ".
- "and rate detail $rate_detail\n"
- if $DEBUG;
+ } elsif ( $ignore_unrateable ) {
+
+ $rate_region = '';
+ $regionnum = '';
+ #code below will throw a warning & skip
+
+ } else {
+
+ die "FATAL: no rate_detail found in ".
+ $rate->ratenum. ":". $rate->ratename. " rate plan ".
+ "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
+ "add a rate or set ignore_unrateable flag on the package def\n";
+ }
}
- } elsif ( $self->option('rating_method') eq 'upstream' ) {
+ } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove?
if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
}
- } elsif ( $self->option('rating_method') eq 'upstream_simple' ) {
+ } elsif ( $rating_method eq 'upstream_simple' ) {
#XXX $charge = sprintf('%.2f', $cdr->upstream_price);
$charge = sprintf('%.3f', $cdr->upstream_price);
$charges += $charge;
- @call_details = ($cdr->downstream_csv( 'format' => $output_format ));
+ @call_details = ($cdr->downstream_csv( 'format' => $output_format,
+ 'charge' => $charge,
+ )
+ );
+ $classnum = $cdr->calltypenum;
} else {
- die "don't know how to rate CDRs using method: ".
- $self->option('rating_method'). "\n";
+ die "don't know how to rate CDRs using method: $rating_method\n";
}
###
###
# 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...
unless exists $included_min{$regionnum};
my $granularity = $rate_detail->sec_granularity;
- my $seconds = $cdr->billsec; # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
+
+ # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
+ my $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
+
$seconds += $granularity - ( $seconds % $granularity )
if $seconds # don't granular-ize 0 billsec calls (bills them)
&& $granularity; # 0 is per call
$included_min{$regionnum} -= $minutes;
if ( $included_min{$regionnum} < 0 ) {
- my $charge_min = 0 - $included_min{$regionnum};
+ my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve
+ #(display?) this
$included_min{$regionnum} = 0;
- $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
+ $charge = sprintf('%.2f', ( $rate_detail->min_charge * $charge_min )
+ + 0.00000001 ); #so 1.005 rounds to 1.01
$charges += $charge;
}
warn " (rate region $rate_region)\n" if $DEBUG;
@call_details = (
- #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
- time2str("%c", $cdr->calldate_unix), #XXX this should probably be a config option dropdown so they can select US vs- rest of world dates or whatnot
- $granularity ? $minutes.'m' : $minutes.' call',
- '$'.$charge,
- $pretty_destnum,
- $rate_region->regionname,
+ $cdr->downstream_csv( 'format' => $output_format,
+ 'granularity' => $granularity,
+ 'minutes' => $minutes,
+ 'charge' => $charge,
+ 'pretty_dst' => $pretty_destnum,
+ 'dst_regionname' => $rate_region->regionname,
+ )
);
+ $classnum = $rate_detail->classnum;
+
}
if ( $charge > 0 ) {
+ #just use FS::cust_bill_pkg_detail objects?
my $call_details;
- if ( $self->option('rating_method') eq 'upstream_simple' ) {
- $call_details = [ 'C', $call_details[0] ];
- }else{
+
+ #if ( $self->option('rating_method') eq 'upstream_simple' ) {
+ if ( scalar(@call_details) == 1 ) {
+ $call_details = [ 'C', $call_details[0], $charge, $classnum ];
+ } else { #only used for $rating_method eq 'upstream' now
$csv->combine(@call_details);
- $call_details = [ 'C', $csv->string ];
+ $call_details = [ 'C', $csv->string, $charge, $classnum ];
}
warn " adding details on charge to invoice: [ ".
join(', ', @{$call_details} ). " ]"
} # $cdr
- unshift @$details, [ 'C', FS::cdr::invoice_header( $output_format) ]
- if (@$details && $self->option('rating_method') eq 'upstream_simple' );
-
} # $cust_svc
+ unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
+ if @$details && $rating_method ne 'upstream';
+
if ( $spool_cdr && length($downstream_cdr) ) {
use FS::UID qw(datasrc);
} #if ( $spool_cdr && length($downstream_cdr) )
+ if ($param->{'increment_next_bill'}) {
+ my $recur_method = $self->option('recur_method', 1) || 'anniversary';
+
+ if ( $recur_method eq 'prorate' ) {
+
+ $charges += $self->SUPER::calc_recur(@_);
+
+ } else {
+
+ $charges += $self->option('recur_fee');
+
+ if ( $recur_method eq 'subscription' ) {
+
+ my $cutoff_day = $self->option('cutoff_day', 1) || 1;
+ my ($day, $mon, $year) = ( localtime($$sdate) )[ 3..5 ];
+
+ if ( $day < $cutoff_day ) {
+ if ( $mon == 0 ) { $mon=11; $year--; }
+ else { $mon--; }
+ }
+
+ $$sdate = timelocal(0, 0, 0, $cutoff_day, $mon, $year);
+
+ }#$recur_method eq 'subscription'
+ }#$recur_method eq 'prorate'
+ }#increment_next_bill
+
$charges;
+}
+#returns a reason why not to rate this CDR, or false if the CDR is chargeable
+sub check_chargable {
+ my( $self, $cdr, %flags ) = @_;
+
+ #should have some better way of checking these options from a hash
+ #or something
+
+ my @opt = qw(
+ use_amaflags
+ use_disposition
+ use_disposition_taqua
+ use_carrierid
+ use_cdrtypenum
+ skip_dcontext
+ skip_dstchannel_prefix
+ skip_dst_length_less
+ skip_lastapp
+ );
+ foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
+ $flags{option_cache}->{$opt} = $self->option($opt, 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 ''
+
+ return "dcontext IN ( $opt{'skip_dcontext'} )"
+ if $opt{'skip_dcontext'} =~ /\S/
+ && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
+
+ my $len_prefix = length($opt{'skip_dstchannel_prefix'});
+ return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
+ if $len_prefix
+ && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
+
+ my $dst_length = $opt{'skip_dst_length_less'};
+ return "destination less than $dst_length digits"
+ if $dst_length && length($cdr->dst) < $dst_length;
+
+ return "lastapp is $opt{'skip_lastapp'}"
+ if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
+
+ #all right then, rate it
+ '';
}
sub is_free {
# 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);
-}
-
-sub append_cust_bill_pkgs {
- my $self = shift;
- my($cust_pkg, $sdate, $details, $param ) = @_;
- return []
- unless $self->option('separate_usage', 'Hush!');
-
- my @details = ();
- my $charges = $self->calc_usage($cust_pkg, $sdate, \@details, $param);
-
- my $cust_bill_pkg = new FS::cust_bill_pkg {
- 'pkgnum' => $cust_pkg->pkgnum,
- 'setup' => 0,
- 'unitsetup' => 0,
- 'recur' => sprintf( "%.2f", $charges), # hmmm
- 'unitrecur' => 0,
- 'quantity' => $cust_pkg->quantity,
- 'sdate' => $$sdate,
- 'edate' => $cust_pkg->bill, # already fiddled
- 'itemdesc' => 'Usage charges', # configurable?
- 'details' => \@details,
- };
-
- return [ $cust_bill_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;
+ } else {
+ $count =
+ scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
+ }
+ $count;
}
1;
projects / freeside.git / blobdiff