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::flat);
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',
57 'ratenum' => { 'name' => 'Rate plan',
59 'select_table' => 'rate',
60 'select_key' => 'ratenum',
61 'select_label' => 'ratename',
63 'rating_method' => { 'name' => 'Region rating method',
65 'options' => \%rating_method,
68 'default_prefix' => { 'name' => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
72 'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
76 'domestic_prefix' => { 'name' => 'Destination prefix for domestic CDR records',
80 # 'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
81 # 'type' => 'checkbox',
84 'international_prefix' => { 'name' => 'Destination prefix for international CDR records',
88 'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
92 'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
96 'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
100 'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
101 'type' => 'checkbox',
104 'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
107 'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
110 'use_duration' => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
111 'type' => 'checkbox',
114 '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes: ',
117 'output_format' => { 'name' => 'Simple output format',
119 'select_options' => { FS::cdr::invoice_formats() },
120 'default' => 'default', #XXX test
123 'usage_section' => { 'name' => 'Section in which to place separate usage charges',
126 'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
127 'type' => 'checkbox',
130 'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call. Useful for prepaid.',
131 'type' => 'checkbox',
134 #XXX also have option for an external db
135 # 'cdr_location' => { 'name' => 'CDR database location'
136 # 'type' => 'select',
137 # 'select_options' => \%cdr_location,
138 # 'select_callback' => {
140 # 'enable' => [ 'datasrc', 'username', 'password' ],
143 # 'disable' => [ 'datasrc', 'username', 'password' ],
147 # 'datasrc' => { 'name' => 'DBI data source for external CDR table',
150 # 'username' => { 'name' => 'External database username',
153 # 'password' => { 'name' => 'External database password',
159 setup_fee recur_fee recur_temporality unused_credit
160 rating_method ratenum
163 domestic_prefix international_prefix
165 use_amaflags use_disposition
166 use_disposition_taqua use_carrierid use_cdrtypenum
169 output_format summarize_usage usage_section
177 my($self, $cust_pkg ) = @_;
178 $self->option('setup_fee');
181 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
183 my($self, $cust_pkg, $sdate, $details, $param ) = @_;
185 #my $last_bill = $cust_pkg->last_bill;
186 my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
189 if $self->option('recur_temporality', 1) eq 'preceding' && $last_bill == 0;
191 my $ratenum = $cust_pkg->part_pkg->option('ratenum');
193 my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
195 my %included_min = ();
199 my $downstream_cdr = '';
201 my $rating_method = $self->option('rating_method') || 'prefix';
204 $self->option('output_format', 'Hush!')
205 || ( $rating_method eq 'upstream_simple' ? 'simple' : 'default' );
207 eval "use Text::CSV_XS;";
209 my $csv = new Text::CSV_XS;
211 foreach my $cust_svc (
212 grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
216 $cust_svc->get_cdrs_for_update( 'disable_src' => $self->option('disable_src'),
217 'default_prefix' => $self->option('default_prefix'),
218 ) # $last_bill, $$sdate )
221 warn "rating CDR $cdr\n".
222 join('', map { " $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
226 my( $rate_region, $regionnum );
230 my @call_details = ();
231 if ( $rating_method eq 'prefix' ) {
233 #should have some better way of checking these options than a long
235 my $notchg = "not charging for CDR";
237 if ( $self->option('use_amaflags') && $cdr->amaflags != 2 ) {
239 warn "$notchg (amaflags != 2)\n" if $DEBUG;
242 } elsif ( $self->option('use_disposition')
243 && $cdr->disposition ne 'ANSWERED' ) {
245 warn "$notchg (disposition != ANSWERED)\n" if $DEBUG;
248 } elsif ( $self->option('use_disposition_taqua')
249 && $cdr->disposition != 100 ) {
251 warn "$notchg (disposition != 100)\n" if $DEBUG;
254 } elsif ( $self->option('use_carrierid')
255 && $cdr->carrierid != $self->option('use_carrierid') ) {
257 warn "$notchg (carrierid != ". $self->option('use_carrierid'). ")\n"
261 } elsif ( $self->option('use_cdrtypenum')
262 && $cdr->cdrtypenum != $self->option('use_cdrtypenum') ) {
264 warn "$notchg (cdrtypenum != ". $self->option('use_cdrtypenum'). ")\n"
271 # look up rate details based on called station id
272 # (or calling station id for toll free calls)
275 if ( $self->option('411_rewrite') ) {
276 my @dirass = split(/\s*,\s*/, $self->option('411_rewrite'));
277 $cdr->dst('411') if grep $cdr->dst eq $_, @dirass;
280 my( $to_or_from, $number );
281 if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
282 && ! $self->option('disable_tollfree')
285 $to_or_from = 'from';
287 } else { #regular call
292 warn "parsing call $to_or_from $number\n" if $DEBUG;
294 #remove non-phone# stuff and whitespace
297 # $dest =~ s/^(\w+):// and $proto = $1; #sip:
299 # $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
301 my $intl = $self->option('international_prefix') || '011';
303 #determine the country code
305 if ( $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
306 || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
310 my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
311 #first look for 1 digit country code
312 if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
314 $number = $u1.$u2.$rest;
315 } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
318 } else { #3 digit country code
319 $countrycode = $three;
324 $countrycode = $self->option('domestic_prefix') || '1';
325 $number =~ s/^$countrycode//;# if length($number) > 10;
328 warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
329 $pretty_destnum = "+$countrycode $number";
331 my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
332 or die "ratenum $ratenum not found!";
334 $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
335 'phonenum' => $number,
338 $rate_region = $rate_detail->dest_region;
339 $regionnum = $rate_region->regionnum;
341 warn " found rate for regionnum $regionnum ".
342 "and rate detail $rate_detail\n"
347 } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used. very much becoming the odd one out. remove?
349 if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
351 $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
353 $regionnum = $rate_detail->dest_regionnum;
354 $rate_region = $rate_detail->dest_region;
356 $pretty_destnum = $cdr->dst;
358 warn " found rate for regionnum $regionnum and ".
359 "rate detail $rate_detail\n"
362 } else { #pass upstream price through
364 $charge = sprintf('%.2f', $cdr->upstream_price);
368 #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
369 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
373 $cdr->description, #$rate_region->regionname,
378 } elsif ( $rating_method eq 'upstream_simple' ) {
380 #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
381 $charge = sprintf('%.3f', $cdr->upstream_price);
384 @call_details = ($cdr->downstream_csv( 'format' => $output_format ));
387 die "don't know how to rate CDRs using method: $rating_method\n";
391 # find the price and add detail to the invoice
394 # if $rate_detail is not found, skip this CDR... i.e.
395 # don't add it to invoice, don't set its status to NULL,
396 # don't call downstream_csv or something on it...
397 # but DO emit a warning...
398 #if ( ! $rate_detail && ! scalar(@call_details) ) {}
399 if ( ! $rate_detail && $charge eq '' ) {
401 warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
404 } else { # there *is* a rate_detail (or call_details), proceed...
406 unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
408 $included_min{$regionnum} = $rate_detail->min_included
409 unless exists $included_min{$regionnum};
411 my $granularity = $rate_detail->sec_granularity;
413 # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
414 my $seconds = $self->option('use_duration')
418 $seconds += $granularity - ( $seconds % $granularity )
419 if $seconds # don't granular-ize 0 billsec calls (bills them)
420 && $granularity; # 0 is per call
421 my $minutes = sprintf("%.1f", $seconds / 60);
422 $minutes =~ s/\.0$// if $granularity == 60;
424 # per call rather than per minute
425 $minutes = 1 unless $granularity;
427 $included_min{$regionnum} -= $minutes;
429 if ( $included_min{$regionnum} < 0 ) {
430 my $charge_min = 0 - $included_min{$regionnum};
431 $included_min{$regionnum} = 0;
432 $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
436 # this is why we need regionnum/rate_region....
437 warn " (rate region $rate_region)\n" if $DEBUG;
440 $cdr->downstream_csv( 'format' => $output_format,
441 'granularity' => $granularity,
442 'minutes' => $minutes,
444 'pretty_dst' => $pretty_destnum,
445 'dst_regionname' => $rate_region->regionname,
449 $classnum = $rate_detail->classnum;
454 #just use FS::cust_bill_pkg_detail objects?
457 #if ( $self->option('rating_method') eq 'upstream_simple' ) {
458 if ( scalar(@call_details) == 1 ) {
459 $call_details = [ 'C', $call_details[0], $charge, $classnum ];
460 } else { #only used for $rating_method eq 'upstream' now
461 $csv->combine(@call_details);
462 $call_details = [ 'C', $csv->string, $charge, $classnum ];
464 warn " adding details on charge to invoice: [ ".
465 join(', ', @{$call_details} ). " ]"
466 if ( $DEBUG && ref($call_details) );
467 push @$details, $call_details; #\@call_details,
470 # if the customer flag is on, call "downstream_csv" or something
471 # like it to export the call downstream!
472 # XXX price plan option to pick format, or something...
473 $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
476 my $error = $cdr->set_status_and_rated_price('done', $charge);
477 die $error if $error;
485 unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
486 if @$details && $rating_method ne 'upstream';
488 if ( $spool_cdr && length($downstream_cdr) ) {
490 use FS::UID qw(datasrc);
491 my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
492 mkdir $dir, 0700 unless -d $dir;
493 $dir .= '/'. $cust_pkg->custnum.
494 mkdir $dir, 0700 unless -d $dir;
495 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
497 push @{ $param->{'precommit_hooks'} },
499 #lock the downstream spool file and append the records
500 use Fcntl qw(:flock);
502 my $spool = new IO::File ">>$filename"
503 or die "can't open $filename: $!\n";
504 flock( $spool, LOCK_EX)
505 or die "can't lock $filename: $!\n";
507 or die "can't seek to end of $filename: $!\n";
508 print $spool $downstream_cdr;
509 flock( $spool, LOCK_UN );
513 } #if ( $spool_cdr && length($downstream_cdr) )
515 $charges += $self->option('recur_fee')
516 if $param->{'increment_next_bill'};
526 my($self, $cust_pkg) = @_;
527 $self->option('recur_fee');
530 # This equates svc_phone records; perhaps svc_phone should have a field
531 # to indicate it represents a line
533 my($self, $cust_pkg ) = @_;
534 scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);