1 package FS::part_pkg::voip_cdr;
4 use vars qw(@ISA $DEBUG %info);
8 use FS::Record qw(qsearchs qsearch);
9 use FS::part_pkg::flat;
15 @ISA = qw(FS::part_pkg::prorate);
19 tie my %rating_method, 'Tie::IxHash',
20 'prefix' => 'Rate calls by using destination prefix to look up a region and rate according to the internal prefix and rate tables',
21 '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.',
22 'upstream_simple' => 'Simply pass through and charge the "upstream_price" amount.',
25 #tie my %cdr_location, 'Tie::IxHash',
26 # 'internal' => 'Internal: CDR records imported into the internal CDR table',
27 # 'external' => 'External: CDR records queried directly from an external '.
28 # 'Asterisk (or other?) CDR table',
31 tie my %temporalities, 'Tie::IxHash',
32 'upcoming' => "Upcoming (future)",
33 'preceding' => "Preceding (past)",
37 'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
38 'shortname' => 'VoIP/telco CDR rating (standard)',
40 'setup_fee' => { 'name' => 'Setup fee for this package',
43 'recur_fee' => { 'name' => 'Base recurring fee for this package',
47 #false laziness w/flat.pm
48 'recur_temporality' => { 'name' => 'Charge recurring fee for period',
50 'select_options' => \%temporalities,
53 'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
54 ' of service at cancellation',
58 'enable_prorate' => { 'name' => 'Enable prorating of the first month',
62 'cutoff_day' => { 'name' => 'Billing Day (1 - 28) for prorating ',
66 'rating_method' => { 'name' => 'Region rating method',
68 'options' => \%rating_method,
71 'ratenum' => { 'name' => 'Rate plan',
73 'select_table' => 'rate',
74 'select_key' => 'ratenum',
75 'select_label' => 'ratename',
78 '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.',
82 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
86 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
90 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
94 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
95 # 'type' => 'checkbox',
98 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
102 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
103 'type' => 'checkbox',
106 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
107 'type' => 'checkbox',
110 'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
111 'type' => 'checkbox',
114 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
115 'type' => 'checkbox',
118 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
121 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
124 'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
127 'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
130 'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
133 'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
136 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
137 'type' => 'checkbox',
140 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
143 'output_format' => { 'name' => 'CDR invoice display format',
145 'select_options' => { FS::cdr::invoice_formats() },
146 'default' => 'default', #XXX test
149 'usage_section' => { 'name' => 'Section in which to place separate usage charges',
152 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
153 'type' => 'checkbox',
156 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.',
157 'type' => 'checkbox',
160 '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.',
161 'type' => 'checkbox',
164 #XXX also have option for an external db
165 # 'cdr_location' => { 'name' => 'CDR database location'
166 # 'type' => 'select',
167 # 'select_options' => \%cdr_location,
168 # 'select_callback' => {
170 # 'enable' => [ 'datasrc', 'username', 'password' ],
173 # 'disable' => [ 'datasrc', 'username', 'password' ],
177 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
180 # 'username' => { 'name' => 'External database username',
183 # 'password' => { 'name' => 'External database password',
189 setup_fee recur_fee recur_temporality unused_credit
190 enable_prorate cutoff_day
191 rating_method ratenum ignore_unrateable
194 domestic_prefix international_prefix
196 use_amaflags use_disposition
197 use_disposition_taqua use_carrierid use_cdrtypenum
198 skip_dcontext skip_dstchannel_prefix
199 skip_dst_length_less skip_lastapp
202 output_format summarize_usage usage_section
204 count_available_phones
211 my($self, $cust_pkg ) = @_;
212 $self->option('setup_fee');
215 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
218 my($cust_pkg, $sdate, $details, $param ) = @_;
220 #my $last_bill = $cust_pkg->last_bill;
221 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
224 if $self->option('recur_temporality', 1) eq 'preceding'
225 && ( $last_bill eq '' || $last_bill == 0 );
227 my $ratenum = $cust_pkg->part_pkg->option('ratenum');
229 my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
231 my %included_min = ();
235 my $downstream_cdr = '';
237 my $rating_method = $self->option('rating_method') || 'prefix';
238 my $intl = $self->option('international_prefix') || '011';
239 my $domestic_prefix = $self->option('domestic_prefix');
240 my $disable_tollfree = $self->option('disable_tollfree');
241 my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
242 my $use_duration = $self->option('use_duration');
244 my $output_format = $self->option('output_format', 'Hush!')
245 || ( $rating_method eq 'upstream_simple'
251 if ( $self->option('411_rewrite') ) {
252 my $dirass = $self->option('411_rewrite');
254 @dirass = split(',', $dirass);
257 #for check_chargable, so we don't keep looking up options inside the loop
260 eval "use Text::CSV_XS;";
262 my $csv = new Text::CSV_XS;
264 foreach my $cust_svc (
265 grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
269 $cust_svc->get_cdrs_for_update(
270 'disable_src' => $self->option('disable_src'),
271 'default_prefix' => $self->option('default_prefix'),
272 ) # $last_bill, $$sdate )
275 warn "rating CDR $cdr\n".
276 join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
280 my( $rate_region, $regionnum );
284 my @call_details = ();
285 if ( $rating_method eq 'prefix' ) {
288 if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
293 my $reason = $self->check_chargable( $cdr,
294 'da_rewrote' => $da_rewrote,
295 'option_cache' => \%opt_cache,
300 warn "not charging for CDR ($reason)\n" if $DEBUG;
306 # look up rate details based on called station id
307 # (or calling station id for toll free calls)
310 my( $to_or_from, $number );
311 if ( $cdr->dst =~ /^(\+?1)?8(8|[02-7]{2})/
312 && ! $disable_tollfree
315 $to_or_from = 'from';
317 } else { #regular call
322 warn "parsing call $to_or_from $number\n" if $DEBUG;
324 #remove non-phone# stuff and whitespace
327 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
329 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
331 #determine the country code
333 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
334 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
338 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
339 #first look for 1 digit country code
340 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
342 $number = $u1.$u2.$rest;
343 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
346 } else { #3 digit country code
347 $countrycode = $three;
352 $countrycode = $domestic_prefix || '1';
353 $number =~ s/^$countrycode//;# if length($number) > 10;
356 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
357 $pretty_destnum = "+$countrycode $number";
359 my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
360 or die "ratenum $ratenum not found!";
362 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
363 'phonenum' => $number,
366 if ( $rate_detail ) {
368 $rate_region = $rate_detail->dest_region;
369 $regionnum = $rate_region->regionnum;
370 warn " found rate for regionnum $regionnum ".
371 "and rate detail $rate_detail\n"
374 } elsif ( $ignore_unrateable ) {
378 #code below will throw a warning & skip
382 die "FATAL: no rate_detail found in ".
383 $rate->ratenum. ":". $rate->ratename. " rate plan ".
384 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
385 "add a rate or set ignore_unrateable flag on the package def\n";
390 } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove?
392 if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
394 $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
396 $regionnum = $rate_detail->dest_regionnum;
397 $rate_region = $rate_detail->dest_region;
399 $pretty_destnum = $cdr->dst;
401 warn " found rate for regionnum $regionnum and ".
402 "rate detail $rate_detail\n"
405 } else { #pass upstream price through
407 $charge = sprintf('%.2f', $cdr->upstream_price);
411 #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
412 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
416 $cdr->description, #$rate_region->regionname,
421 } elsif ( $rating_method eq 'upstream_simple' ) {
423 #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
424 $charge = sprintf('%.3f', $cdr->upstream_price);
427 @call_details = ($cdr->downstream_csv( 'format' => $output_format,
431 $classnum = $cdr->calltypenum;
434 die "don't know how to rate CDRs using method: $rating_method\n";
438 # find the price and add detail to the invoice
441 # if $rate_detail is not found, skip this CDR... i.e.
442 # don't add it to invoice, don't set its status to done,
443 # don't call downstream_csv or something on it...
444 # but DO emit a warning...
445 #if ( ! $rate_detail && ! scalar(@call_details) ) {}
446 if ( ! $rate_detail && $charge eq '' ) {
448 warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
451 } else { # there *is* a rate_detail (or call_details), proceed...
453 unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
455 $included_min{$regionnum} = $rate_detail->min_included
456 unless exists $included_min{$regionnum};
458 my $granularity = $rate_detail->sec_granularity;
460 # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
461 my $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
463 $seconds += $granularity - ( $seconds % $granularity )
464 if $seconds # don't granular-ize 0 billsec calls (bills them)
465 && $granularity; # 0 is per call
466 my $minutes = sprintf("%.1f", $seconds / 60);
467 $minutes =~ s/\.0$// if $granularity == 60;
469 # per call rather than per minute
470 $minutes = 1 unless $granularity;
472 $included_min{$regionnum} -= $minutes;
474 if ( $included_min{$regionnum} < 0 ) {
475 my $charge_min = 0 - $included_min{$regionnum}; #XXX should preserve
477 $included_min{$regionnum} = 0;
478 $charge = sprintf('%.2f', ( $rate_detail->min_charge * $charge_min )
479 + 0.00000001 ); #so 1.005 rounds to 1.01
483 # this is why we need regionnum/rate_region....
484 warn " (rate region $rate_region)\n" if $DEBUG;
487 $cdr->downstream_csv( 'format' => $output_format,
488 'granularity' => $granularity,
489 'minutes' => $minutes,
491 'pretty_dst' => $pretty_destnum,
492 'dst_regionname' => $rate_region->regionname,
496 $classnum = $rate_detail->classnum;
501 #just use FS::cust_bill_pkg_detail objects?
504 #if ( $self->option('rating_method') eq 'upstream_simple' ) {
505 if ( scalar(@call_details) == 1 ) {
506 $call_details = [ 'C', $call_details[0], $charge, $classnum ];
507 } else { #only used for $rating_method eq 'upstream' now
508 $csv->combine(@call_details);
509 $call_details = [ 'C', $csv->string, $charge, $classnum ];
511 warn " adding details on charge to invoice: [ ".
512 join(', ', @{$call_details} ). " ]"
513 if ( $DEBUG && ref($call_details) );
514 push @$details, $call_details; #\@call_details,
517 # if the customer flag is on, call "downstream_csv" or something
518 # like it to export the call downstream!
519 # XXX price plan option to pick format, or something...
520 $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
523 my $error = $cdr->set_status_and_rated_price('done', $charge);
524 die $error if $error;
532 unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
533 if @$details && $rating_method ne 'upstream';
535 if ( $spool_cdr && length($downstream_cdr) ) {
537 use FS::UID qw(datasrc);
538 my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
539 mkdir $dir, 0700 unless -d $dir;
540 $dir .= '/'. $cust_pkg->custnum.
541 mkdir $dir, 0700 unless -d $dir;
542 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
544 push @{ $param->{'precommit_hooks'} },
546 #lock the downstream spool file and append the records
547 use Fcntl qw(:flock);
549 my $spool = new IO::File ">>$filename"
550 or die "can't open $filename: $!\n";
551 flock( $spool, LOCK_EX)
552 or die "can't lock $filename: $!\n";
554 or die "can't seek to end of $filename: $!\n";
555 print $spool $downstream_cdr;
556 flock( $spool, LOCK_UN );
560 } #if ( $spool_cdr && length($downstream_cdr) )
562 if ($param->{'increment_next_bill'}) {
563 if ( $self->option('enable_prorate', 1) ) {
564 $charges += $self->SUPER::calc_recur(@_);
566 $charges += $self->option('recur_fee')
573 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
574 sub check_chargable {
575 my( $self, $cdr, %flags ) = @_;
577 #should have some better way of checking these options from a hash
583 use_disposition_taqua
587 skip_dstchannel_prefix
591 foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
592 $flags{option_cache}->{$opt} = $self->option($opt);
594 my %opt = %{ $flags{option_cache} };
596 return 'amaflags != 2'
597 if $opt{'use_amaflags'} && $cdr->amaflags != 2;
599 return 'disposition != ANSWERED'
600 if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
602 return "disposition != 100"
603 if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
605 return "carrierid != $opt{'use_carrierid'}"
606 if length($opt{'use_carrierid'})
607 && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
608 && ! $flags{'da_rewrote'};
610 return "cdrtypenum != $opt{'use_cdrtypenum'}"
611 if length($opt{'use_cdrtypenum'})
612 && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
614 return "dcontext IN ( $opt{'skip_dcontext'} )"
615 if $opt{'skip_dcontext'} =~ /\S/
616 && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
618 my $len_prefix = length($opt{'skip_dstchannel_prefix'});
619 return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
621 && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
623 my $dst_length = $opt{'skip_dst_length_less'};
624 return "destination less than $dst_length digits"
625 if $dst_length && length($cdr->dst) < $dst_length;
627 return "lastapp is $opt{'skip_lastapp'}"
628 if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
630 #all right then, rate it
639 my($self, $cust_pkg) = @_;
640 $self->option('recur_fee');
643 # This equates svc_phone records; perhaps svc_phone should have a field
644 # to indicate it represents a line
646 my($self, $cust_pkg ) = @_;
648 if ( $self->option('count_available_phones', 1)) {
649 map { $count += ( $_->quantity || 0 ) }
650 grep { $_->part_svc->svcdb eq 'svc_phone' }
651 $cust_pkg->part_pkg->pkg_svc;
654 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);