add options to skip CDRs under a defined length and with specific lastapp
[freeside.git] / FS / FS / part_pkg / voip_cdr.pm
1 package FS::part_pkg::voip_cdr;
2
3 use strict;
4 use vars qw(@ISA $DEBUG %info);
5 use Date::Format;
6 use Tie::IxHash;
7 use FS::Conf;
8 use FS::Record qw(qsearchs qsearch);
9 use FS::part_pkg::flat;
10 use FS::cdr;
11 use FS::rate;
12 use FS::rate_prefix;
13 use FS::rate_detail;
14
15 @ISA = qw(FS::part_pkg::flat);
16
17 $DEBUG = 0;
18
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.',
23 ;
24
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',
29 #;
30
31 tie my %temporalities, 'Tie::IxHash',
32   'upcoming'  => "Upcoming (future)",
33   'preceding' => "Preceding (past)",
34 ;
35
36 %info = (
37   'name' => 'VoIP rating by plan of CDR records in an internal (or external) SQL table',
38   'shortname' => 'VoIP/telco CDR rating (standard)',
39   'fields' => {
40     'setup_fee'     => { 'name' => 'Setup fee for this package',
41                          'default' => 0,
42                        },
43     'recur_fee'     => { 'name' => 'Base recurring fee for this package',
44                          'default' => 0,
45                        },
46
47     #false laziness w/flat.pm
48     'recur_temporality' => { 'name' => 'Charge recurring fee for period',
49                              'type' => 'select',
50                              'select_options' => \%temporalities,
51                            },
52
53     'unused_credit' => { 'name' => 'Credit the customer for the unused portion'.
54                                    ' of service at cancellation',
55                          'type' => 'checkbox',
56                        },
57
58     'rating_method' => { 'name' => 'Region rating method',
59                          'type' => 'radio',
60                          'options' => \%rating_method,
61                        },
62
63     'ratenum'   => { 'name' => 'Rate plan',
64                      'type' => 'select',
65                      'select_table' => 'rate',
66                      'select_key'   => 'ratenum',
67                      'select_label' => 'ratename',
68                    },
69
70     '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.',
71                              'type' => 'checkbox',
72                            },
73
74     'default_prefix' => { 'name'    => 'Default prefix optionally prepended to customer DID numbers when searching for CDR records',
75                           'default' => '+1',
76                         },
77
78     'disable_src' => { 'name' => 'Disable rating of CDR records based on the "src" field in addition to "charged_party"',
79                        'type' => 'checkbox'
80                      },
81
82     'domestic_prefix' => { 'name'    => 'Destination prefix for domestic CDR records',
83                            'default' => '1',
84                          },
85
86 #    'domestic_prefix_required' => { 'name' => 'Require explicit destination prefix for domestic CDR records',
87 #                                    'type' => 'checkbox',
88 #                                  },
89
90     'international_prefix' => { 'name'    => 'Destination prefix for international CDR records',
91                                 'default' => '011',
92                               },
93
94     'disable_tollfree' => { 'name' => 'Disable automatic toll-free processing',
95                             'type' => 'checkbox',
96                           },
97
98     'use_amaflags' => { 'name' => 'Do not charge for CDRs where the amaflags field is not set to "2" ("BILL"/"BILLING").',
99                         'type' => 'checkbox',
100                       },
101
102     'use_disposition' => { 'name' => 'Do not charge for CDRs where the disposition flag is not set to "ANSWERED".',
103                            'type' => 'checkbox',
104                          },
105
106     'use_disposition_taqua' => { 'name' => 'Do not charge for CDRs where the disposition is not set to "100" (Taqua).',
107                                  'type' => 'checkbox',
108                                },
109
110     'use_carrierid' => { 'name' => 'Do not charge for CDRs where the Carrier ID is not set to: ',
111                          },
112
113     'use_cdrtypenum' => { 'name' => 'Do not charge for CDRs where the CDR Type is not set to: ',
114                          },
115
116     'skip_dcontext' => { 'name' => 'Do not charge for CDRs where the dcontext is set to any of these (comma-separated) values:',
117                        },
118
119     'skip_dstchannel_prefix' => { 'name' => 'Do not charge for CDRs where the dstchannel starts with:',
120                                 },
121
122     'skip_dst_length_less' => { 'name' => 'Do not charge for CDRs where the destination is less than this many digits:',
123                               },
124
125     'skip_lastapp' => { 'name' => 'Do not charge for CDRs where the lastapp matches this value',
126                       },
127
128     'use_duration'   => { 'name' => 'Calculate usage based on the duration field instead of the billsec field',
129                           'type' => 'checkbox',
130                         },
131
132     '411_rewrite' => { 'name' => 'Rewrite these (comma-separated) destination numbers to 411 for rating purposes (also ignore any carrierid check): ',
133                       },
134
135     'output_format' => { 'name' => 'CDR invoice display format',
136                          'type' => 'select',
137                          'select_options' => { FS::cdr::invoice_formats() },
138                          'default'        => 'default', #XXX test
139                        },
140
141     'usage_section' => { 'name' => 'Section in which to place separate usage charges',
142                        },
143
144     'summarize_usage' => { 'name' => 'Include usage summary with recurring charges when usage is in separate section',
145                           'type' => 'checkbox',
146                         },
147
148     'bill_every_call' => { 'name' => 'Generate an invoice immediately for every call.  Useful for prepaid.',
149                            'type' => 'checkbox',
150                          },
151
152     #XXX also have option for an external db
153 #    'cdr_location' => { 'name' => 'CDR database location'
154 #                        'type' => 'select',
155 #                        'select_options' => \%cdr_location,
156 #                        'select_callback' => {
157 #                          'external' => {
158 #                            'enable' => [ 'datasrc', 'username', 'password' ],
159 #                          },
160 #                          'internal' => {
161 #                            'disable' => [ 'datasrc', 'username', 'password' ],
162 #                          }
163 #                        },
164 #                      },
165 #    'datasrc' => { 'name' => 'DBI data source for external CDR table',
166 #                   'disabled' => 'Y',
167 #                 },
168 #    'username' => { 'name' => 'External database username',
169 #                    'disabled' => 'Y',
170 #                  },
171 #    'password' => { 'name' => 'External database password',
172 #                    'disabled' => 'Y',
173 #                  },
174
175   },
176   'fieldorder' => [qw(
177                        setup_fee recur_fee recur_temporality unused_credit
178                        rating_method ratenum ignore_unrateable
179                        default_prefix
180                        disable_src
181                        domestic_prefix international_prefix
182                        disable_tollfree
183                        use_amaflags use_disposition
184                        use_disposition_taqua use_carrierid use_cdrtypenum
185                        skip_dcontext skip_dstchannel_prefix
186                        use_duration
187                        411_rewrite
188                        output_format summarize_usage usage_section
189                        bill_every_call
190                      )
191                   ],
192   'weight' => 40,
193 );
194
195 sub calc_setup {
196   my($self, $cust_pkg ) = @_;
197   $self->option('setup_fee');
198 }
199
200 #false laziness w/voip_sqlradacct calc_recur resolve it if that one ever gets used again
201 sub calc_recur {
202   my($self, $cust_pkg, $sdate, $details, $param ) = @_;
203
204   #my $last_bill = $cust_pkg->last_bill;
205   my $last_bill = $cust_pkg->get('last_bill'); #->last_bill falls back to setup
206
207   return 0
208     if $self->option('recur_temporality', 1) eq 'preceding'
209     && ( $last_bill eq '' || $last_bill == 0 );
210
211   my $ratenum = $cust_pkg->part_pkg->option('ratenum');
212
213   my $spool_cdr = $cust_pkg->cust_main->spool_cdr;
214
215   my %included_min = ();
216
217   my $charges = 0;
218
219   my $downstream_cdr = '';
220
221   my $rating_method     = $self->option('rating_method') || 'prefix';
222   my $intl              = $self->option('international_prefix') || '011';
223   my $domestic_prefix   = $self->option('domestic_prefix');
224   my $disable_tollfree  = $self->option('disable_tollfree');
225   my $ignore_unrateable = $self->option('ignore_unrateable', 'Hush!');
226   my $use_duration      = $self->option('use_duration');
227
228   my $output_format     = $self->option('output_format', 'Hush!')
229                           || ( $rating_method eq 'upstream_simple'
230                                  ? 'simple'
231                                  : 'default'
232                              );
233
234   my @dirass = ();
235   if ( $self->option('411_rewrite') ) {
236     my $dirass = $self->option('411_rewrite');
237     $dirass =~ s/\s//g;
238     @dirass = split(',', $dirass);
239   }
240
241   #for check_chargable, so we don't keep looking up options inside the loop
242   my %opt_cache = ();
243
244   eval "use Text::CSV_XS;";
245   die $@ if $@;
246   my $csv = new Text::CSV_XS;
247
248   foreach my $cust_svc (
249     grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc
250   ) {
251
252     foreach my $cdr (
253       $cust_svc->get_cdrs_for_update(
254         'disable_src'    => $self->option('disable_src'),
255         'default_prefix' => $self->option('default_prefix'),
256       )  # $last_bill, $$sdate )
257     ) {
258       if ( $DEBUG > 1 ) {
259         warn "rating CDR $cdr\n".
260              join('', map { "  $_ => ". $cdr->{$_}. "\n" } keys %$cdr );
261       }
262
263       my $rate_detail;
264       my( $rate_region, $regionnum );
265       my $pretty_destnum;
266       my $charge = '';
267       my $classnum = '';
268       my @call_details = ();
269       if ( $rating_method eq 'prefix' ) {
270
271         my $da_rewrote = 0;
272         if ( length($cdr->dst) && grep { $cdr->dst eq $_ } @dirass ){
273           $cdr->dst('411');
274           $da_rewrote = 1;
275         }
276
277         my $reason = $self->check_chargable( $cdr,
278                                              'da_rewrote'   => $da_rewrote,
279                                              'option_cache' => \%opt_cache,
280                                            );
281
282         if ( $reason ) {
283
284           warn "not charging for CDR ($reason)\n" if $DEBUG;
285           $charge = 0;
286
287         } else {
288           
289           ###
290           # look up rate details based on called station id
291           # (or calling station id for toll free calls)
292           ###
293
294           my( $to_or_from, $number );
295           if ( $cdr->dst =~ /^(\+?1)?8([02-8])\1/
296                && ! $disable_tollfree
297               )
298           { #tollfree call
299             $to_or_from = 'from';
300             $number = $cdr->src;
301           } else { #regular call
302             $to_or_from = 'to';
303             $number = $cdr->dst;
304           }
305
306           warn "parsing call $to_or_from $number\n" if $DEBUG;
307
308           #remove non-phone# stuff and whitespace
309           $number =~ s/\s//g;
310 #          my $proto = '';
311 #          $dest =~ s/^(\w+):// and $proto = $1; #sip:
312 #          my $siphost = '';
313 #          $dest =~ s/\@(.*)$// and $siphost = $1; # @10.54.32.1, @sip.example.com
314
315           #determine the country code
316           my $countrycode;
317           if (    $number =~ /^$intl(((\d)(\d))(\d))(\d+)$/
318                || $number =~ /^\+(((\d)(\d))(\d))(\d+)$/
319              )
320           {
321
322             my( $three, $two, $one, $u1, $u2, $rest ) = ( $1,$2,$3,$4,$5,$6 );
323             #first look for 1 digit country code
324             if ( qsearch('rate_prefix', { 'countrycode' => $one } ) ) {
325               $countrycode = $one;
326               $number = $u1.$u2.$rest;
327             } elsif ( qsearch('rate_prefix', { 'countrycode' => $two } ) ) { #or 2
328               $countrycode = $two;
329               $number = $u2.$rest;
330             } else { #3 digit country code
331               $countrycode = $three;
332               $number = $rest;
333             }
334
335           } else {
336             $countrycode = $domestic_prefix || '1';
337             $number =~ s/^$countrycode//;# if length($number) > 10;
338           }
339
340           warn "rating call $to_or_from +$countrycode $number\n" if $DEBUG;
341           $pretty_destnum = "+$countrycode $number";
342
343           my $rate = qsearchs('rate', { 'ratenum' => $ratenum })
344             or die "ratenum $ratenum not found!";
345
346           $rate_detail = $rate->dest_detail({ 'countrycode' => $countrycode,
347                                               'phonenum'    => $number,
348                                             });
349
350           if ( $rate_detail ) {
351
352             $rate_region = $rate_detail->dest_region;
353             $regionnum = $rate_region->regionnum;
354             warn "  found rate for regionnum $regionnum ".
355                  "and rate detail $rate_detail\n"
356               if $DEBUG;
357
358           } elsif ( $ignore_unrateable ) {
359
360             $rate_region = '';
361             $regionnum = '';
362             #code below will throw a warning & skip
363
364           } else {
365
366             die "FATAL: no rate_detail found in ".
367                 $rate->ratenum. ":". $rate->ratename. " rate plan ".
368                 "for +$countrycode $number (CDR acctid ". $cdr->acctid. "); ".
369                 "add a rate or set ignore_unrateable flag on the package def\n";
370           }
371
372         }
373
374       } elsif ( $rating_method eq 'upstream' ) { #XXX this was convergent, not currently used.  very much becoming the odd one out. remove?
375
376         if ( $cdr->cdrtypenum == 1 ) { #rate based on upstream rateid
377
378           $rate_detail = $cdr->cdr_upstream_rate->rate_detail;
379
380           $regionnum = $rate_detail->dest_regionnum;
381           $rate_region = $rate_detail->dest_region;
382
383           $pretty_destnum = $cdr->dst;
384
385           warn "  found rate for regionnum $regionnum and ".
386                "rate detail $rate_detail\n"
387             if $DEBUG;
388
389         } else { #pass upstream price through
390
391           $charge = sprintf('%.2f', $cdr->upstream_price);
392           $charges += $charge;
393  
394           @call_details = (
395             #time2str("%Y %b %d - %r", $cdr->calldate_unix ),
396             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
397             'N/A', #minutes...
398             '$'.$charge,
399             #$pretty_destnum,
400             $cdr->description, #$rate_region->regionname,
401           );
402
403         }
404
405       } elsif ( $rating_method eq 'upstream_simple' ) {
406
407         #XXX $charge = sprintf('%.2f', $cdr->upstream_price);
408         $charge = sprintf('%.3f', $cdr->upstream_price);
409         $charges += $charge;
410
411         @call_details = ($cdr->downstream_csv( 'format' => $output_format,
412                                                'charge' => $charge,
413                                              )
414                         );
415         $classnum = $cdr->calltypenum;
416
417       } else {
418         die "don't know how to rate CDRs using method: $rating_method\n";
419       }
420
421       ###
422       # find the price and add detail to the invoice
423       ###
424
425       # if $rate_detail is not found, skip this CDR... i.e. 
426       # don't add it to invoice, don't set its status to done,
427       # don't call downstream_csv or something on it...
428       # but DO emit a warning...
429       #if ( ! $rate_detail && ! scalar(@call_details) ) {}
430       if ( ! $rate_detail && $charge eq '' ) {
431
432         warn "no rate_detail found for CDR.acctid: ". $cdr->acctid.
433              "; skipping\n"
434
435       } else { # there *is* a rate_detail (or call_details), proceed...
436
437         unless ( @call_details || ( $charge ne '' && $charge == 0 ) ) {
438
439           $included_min{$regionnum} = $rate_detail->min_included
440             unless exists $included_min{$regionnum};
441
442           my $granularity = $rate_detail->sec_granularity;
443
444                       # length($cdr->billsec) ? $cdr->billsec : $cdr->duration;
445           my $seconds = $use_duration ? $cdr->duration : $cdr->billsec;
446
447           $seconds += $granularity - ( $seconds % $granularity )
448             if $seconds      # don't granular-ize 0 billsec calls (bills them)
449             && $granularity; # 0 is per call
450           my $minutes = sprintf("%.1f", $seconds / 60);
451           $minutes =~ s/\.0$// if $granularity == 60;
452
453           # per call rather than per minute
454           $minutes = 1 unless $granularity;
455
456           $included_min{$regionnum} -= $minutes;
457
458           if ( $included_min{$regionnum} < 0 ) {
459             my $charge_min = 0 - $included_min{$regionnum};
460             $included_min{$regionnum} = 0;
461             $charge = sprintf('%.2f', $rate_detail->min_charge * $charge_min );
462             $charges += $charge;
463           }
464
465           # this is why we need regionnum/rate_region....
466           warn "  (rate region $rate_region)\n" if $DEBUG;
467
468           @call_details = (
469            $cdr->downstream_csv( 'format'         => $output_format,
470                                  'granularity'    => $granularity,
471                                  'minutes'        => $minutes,
472                                  'charge'         => $charge,
473                                  'pretty_dst'     => $pretty_destnum,
474                                  'dst_regionname' => $rate_region->regionname,
475                                )
476           );
477
478           $classnum = $rate_detail->classnum;
479
480         }
481
482         if ( $charge > 0 ) {
483           #just use FS::cust_bill_pkg_detail objects?
484           my $call_details;
485
486           #if ( $self->option('rating_method') eq 'upstream_simple' ) {
487           if ( scalar(@call_details) == 1 ) {
488             $call_details = [ 'C', $call_details[0], $charge, $classnum ];
489           } else { #only used for $rating_method eq 'upstream' now
490             $csv->combine(@call_details);
491             $call_details = [ 'C', $csv->string, $charge, $classnum ];
492           }
493           warn "  adding details on charge to invoice: [ ".
494               join(', ', @{$call_details} ). " ]"
495             if ( $DEBUG && ref($call_details) );
496           push @$details, $call_details; #\@call_details,
497         }
498
499         # if the customer flag is on, call "downstream_csv" or something
500         # like it to export the call downstream!
501         # XXX price plan option to pick format, or something...
502         $downstream_cdr .= $cdr->downstream_csv( 'format' => 'convergent' )
503           if $spool_cdr;
504
505         my $error = $cdr->set_status_and_rated_price('done', $charge);
506         die $error if $error;
507
508       }
509
510     } # $cdr
511
512   } # $cust_svc
513
514   unshift @$details, [ 'C', FS::cdr::invoice_header($output_format) ]
515     if @$details && $rating_method ne 'upstream';
516
517   if ( $spool_cdr && length($downstream_cdr) ) {
518
519     use FS::UID qw(datasrc);
520     my $dir = '/usr/local/etc/freeside/export.'. datasrc. '/cdr';
521     mkdir $dir, 0700 unless -d $dir;
522     $dir .= '/'. $cust_pkg->custnum.
523     mkdir $dir, 0700 unless -d $dir;
524     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
525
526     push @{ $param->{'precommit_hooks'} },
527          sub {
528                #lock the downstream spool file and append the records 
529                use Fcntl qw(:flock);
530                use IO::File;
531                my $spool = new IO::File ">>$filename"
532                  or die "can't open $filename: $!\n";
533                flock( $spool, LOCK_EX)
534                  or die "can't lock $filename: $!\n";
535                seek($spool, 0, 2)
536                  or die "can't seek to end of $filename: $!\n";
537                print $spool $downstream_cdr;
538                flock( $spool, LOCK_UN );
539                close $spool;
540              };
541
542   } #if ( $spool_cdr && length($downstream_cdr) )
543
544   $charges += $self->option('recur_fee')
545     if $param->{'increment_next_bill'};
546
547   $charges;
548 }
549
550 #returns a reason why not to rate this CDR, or false if the CDR is chargeable
551 sub check_chargable {
552   my( $self, $cdr, %flags ) = @_;
553
554   #should have some better way of checking these options from a hash
555   #or something
556
557   my @opt = qw(
558     use_amaflags
559     use_disposition
560     use_disposition_taqua
561     use_carrierid
562     use_cdrtypenum
563     skip_dcontext
564     skip_dstchannel_prefix
565     skip_dst_length_less
566     skip_lastapp
567   );
568   foreach my $opt (grep !exists($flags{option_cache}->{$_}), @opt ) {
569     $flags{option_cache}->{$opt} = $self->option($opt);
570   }
571   my %opt = %{ $flags{option_cache} };
572
573   return 'amaflags != 2'
574     if $opt{'use_amaflags'} && $cdr->amaflags != 2;
575
576   return 'disposition != ANSWERED'
577     if $opt{'use_disposition'} && $cdr->disposition ne 'ANSWERED';
578
579   return "disposition != 100"
580     if $opt{'use_disposition_taqua'} && $cdr->disposition != 100;
581
582   return "carrierid != $opt{'use_carrierid'}"
583     if length($opt{'use_carrierid'})
584     && $cdr->carrierid ne $opt{'use_carrierid'} #ne otherwise 0 matches ''
585     && ! $flags{'da_rewrote'};
586
587   return "cdrtypenum != $opt{'use_cdrtypenum'}"
588     if length($opt{'use_cdrtypenum'})
589     && $cdr->cdrtypenum ne $opt{'use_cdrtypenum'}; #ne otherwise 0 matches ''
590
591   return "dcontext IN ( $opt{'skip_dcontext'} )"
592     if $opt{'skip_dcontext'} =~ /\S/
593     && grep { $cdr->dcontext eq $_ } split(/\s*,\s*/, $opt{'skip_dcontext'});
594
595   my $len_prefix = length($opt{'skip_dstchannel_prefix'});
596   return "dstchannel starts with $opt{'skip_dstchannel_prefix'}"
597     if $len_prefix
598     && substr($cdr->dstchannel,0,$len_prefix) eq $opt{'skip_dstchannel_prefix'};
599
600   my $dst_length = $opt{'skip_dst_length_less'};
601   return "destination less than $dst_length digits"
602     if $dst_length && length($cdr->dst) < $dst_length;
603
604   return "lastapp is $opt{'skip_lastapp'}"
605     if length($opt{'skip_lastapp'}) && $cdr->lastapp eq $opt{'skip_lastapp'};
606
607   #all right then, rate it
608   '';
609 }
610
611 sub is_free {
612   0;
613 }
614
615 sub base_recur {
616   my($self, $cust_pkg) = @_;
617   $self->option('recur_fee');
618 }
619
620 #  This equates svc_phone records; perhaps svc_phone should have a field
621 #  to indicate it represents a line
622 sub calc_units {    
623   my($self, $cust_pkg ) = @_;
624   scalar(grep { $_->part_svc->svcdb eq 'svc_phone' } $cust_pkg->cust_svc);
625 }
626
627 1;
628